Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.9.0.2
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_UBOOT_VERSION_LENGTH 17 /* UBOOT_VERSION_LENGTH + 1 */
44 
45 #define OPEN_IMAGE_NAME_NONE "none"
46 
47 /*****************************************************************/
64 open_error_t openapiBootCodeUpdate(openapiClientHandle_t *client_handle,
65  uint32_t unit);
66 
67 /*****************************************************************/
89 open_error_t openapiImageActivate(openapiClientHandle_t *client_handle,
90  uint32_t unit,
91  open_buffdesc *imageLabel,
92  OPEN_BOOL_t updateBootCode);
93 
94 /*****************************************************************/
118 open_error_t openapiImageDelete(openapiClientHandle_t *client_handle,
119  uint32_t unit,
120  open_buffdesc *imageLabel);
121 
122 /*****************************************************************/
139 open_error_t openapiImageDescrGet(openapiClientHandle_t *client_handle,
140  open_buffdesc *imageLabel,
141  open_buffdesc *imageDescr);
142 
143 /*****************************************************************/
163 open_error_t openapiImageDescrSet(openapiClientHandle_t *client_handle,
164  open_buffdesc *imageLabel,
165  open_buffdesc *imageDescr);
166 
167 /*****************************************************************/
202 open_error_t openapiImageLabelIsValid(openapiClientHandle_t *client_handle,
203  open_buffdesc *imageLabel,
204  OPEN_BOOL_t *isValid);
205 
206 /*****************************************************************/
226 open_error_t openapiImageLabelsGet(openapiClientHandle_t *client_handle,
227  open_buffdesc *activeLabel,
228  open_buffdesc *backupLabel);
229 
230 /*****************************************************************/
254 open_error_t openapiImageNamesGet(openapiClientHandle_t *client_handle,
255  uint32_t unit,
256  open_buffdesc *activeImage,
257  open_buffdesc *backupImage,
258  open_buffdesc *activatedImage);
259 
260 /*****************************************************************/
288 open_error_t openapiImageUpgrade(openapiClientHandle_t *client_handle,
289  open_buffdesc *imagePath,
290  open_buffdesc *imageLabel);
291 
292 /*****************************************************************/
305 open_error_t openapiBootCodeVersion(openapiClientHandle_t *client_handle,
306  open_buffdesc *version);
307 
308 #endif /* OPENAPI_IMAGE_H_INCLUDED */
309