Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.4.4.5
openapi_image.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-2018 Broadcom
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 **********************************************************************
26 *
27 * @filename openapi_image.h
28 *
29 * @purpose Image Management and Configuration
30 *
31 * @component OpEN
32 *
33 * @create 11/13/2015
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_IMAGE_H_INCLUDED
39 #define OPENAPI_IMAGE_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
43 #define OPEN_IMAGE_NAME_NONE "none"
44 
45 /*****************************************************************/
62 open_error_t openapiBootCodeUpdate(openapiClientHandle_t *client_handle,
63  uint32_t unit);
64 
65 /*****************************************************************/
87 open_error_t openapiImageActivate(openapiClientHandle_t *client_handle,
88  uint32_t unit,
89  open_buffdesc *imageLabel,
90  OPEN_BOOL_t updateBootCode);
91 
92 /*****************************************************************/
116 open_error_t openapiImageDelete(openapiClientHandle_t *client_handle,
117  uint32_t unit,
118  open_buffdesc *imageLabel);
119 
120 /*****************************************************************/
137 open_error_t openapiImageDescrGet(openapiClientHandle_t *client_handle,
138  open_buffdesc *imageLabel,
139  open_buffdesc *imageDescr);
140 
141 /*****************************************************************/
161 open_error_t openapiImageDescrSet(openapiClientHandle_t *client_handle,
162  open_buffdesc *imageLabel,
163  open_buffdesc *imageDescr);
164 
165 /*****************************************************************/
200 open_error_t openapiImageLabelIsValid(openapiClientHandle_t *client_handle,
201  open_buffdesc *imageLabel,
202  OPEN_BOOL_t *isValid);
203 
204 /*****************************************************************/
224 open_error_t openapiImageLabelsGet(openapiClientHandle_t *client_handle,
225  open_buffdesc *activeLabel,
226  open_buffdesc *backupLabel);
227 
228 /*****************************************************************/
252 open_error_t openapiImageNamesGet(openapiClientHandle_t *client_handle,
253  uint32_t unit,
254  open_buffdesc *activeImage,
255  open_buffdesc *backupImage,
256  open_buffdesc *activatedImage);
257 
258 /*****************************************************************/
286 open_error_t openapiImageUpgrade(openapiClientHandle_t *client_handle,
287  open_buffdesc *imagePath,
288  open_buffdesc *imageLabel);
289 
290 
291 #endif /* OPENAPI_IMAGE_H_INCLUDED */
292