openapi_image.h

Go to the documentation of this file.

/*********************************************************************
*
*  Copyright 2016-2023 Broadcom
*
*  Licensed under the Apache License, Version 2.0 (the "License");
*  you may not use this file except in compliance with the License.
*  You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
*  Unless required by applicable law or agreed to in writing, software
*  distributed under the License is distributed on an "AS IS" BASIS,
*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*  See the License for the specific language governing permissions and
*  limitations under the License.
*
**********************************************************************
*
* @filename  openapi_image.h
*
* @purpose   Image Management and Configuration
*
* @component OpEN
*
* @create    11/13/2015
*
* @end
*                                    
**********************************************************************/
#ifndef OPENAPI_IMAGE_H_INCLUDED
#define OPENAPI_IMAGE_H_INCLUDED

#include "openapi_common.h"

#define OPEN_UBOOT_VERSION_LENGTH  17 /* UBOOT_VERSION_LENGTH + 1 */ 

#define OPEN_IMAGE_NAME_NONE "none"

/*****************************************************************/
open_error_t openapiBootCodeUpdate(openapiClientHandle_t *client_handle,
                                   uint32_t              unit);

/*****************************************************************/
open_error_t openapiImageActivate(openapiClientHandle_t *client_handle,
                                  uint32_t              unit,
                                  open_buffdesc         *imageLabel,
                                  OPEN_BOOL_t           updateBootCode);

/*****************************************************************/
open_error_t openapiImageDelete(openapiClientHandle_t *client_handle,
                                uint32_t              unit,
                                open_buffdesc         *imageLabel);

/*****************************************************************/
open_error_t openapiImageDescrGet(openapiClientHandle_t *client_handle,
                                  open_buffdesc         *imageLabel,
                                  open_buffdesc         *imageDescr); 

/*****************************************************************/
open_error_t openapiImageDescrSet(openapiClientHandle_t *client_handle,
                                  open_buffdesc         *imageLabel,
                                  open_buffdesc         *imageDescr); 

/*****************************************************************/
open_error_t openapiImageLabelIsValid(openapiClientHandle_t *client_handle,
                                      open_buffdesc         *imageLabel,
                                      OPEN_BOOL_t           *isValid);

/*****************************************************************/
open_error_t openapiImageLabelsGet(openapiClientHandle_t *client_handle,
                                   open_buffdesc         *activeLabel,
                                   open_buffdesc         *backupLabel);

/*****************************************************************/
open_error_t openapiImageNamesGet(openapiClientHandle_t *client_handle,
                                  uint32_t              unit,
                                  open_buffdesc         *activeImage,
                                  open_buffdesc         *backupImage,
                                  open_buffdesc         *activatedImage);

/*****************************************************************/
open_error_t openapiImageUpgrade(openapiClientHandle_t *client_handle,
                                 open_buffdesc   *imagePath,
                                 open_buffdesc   *imageLabel);

/*****************************************************************/
open_error_t openapiBootCodeVersion(openapiClientHandle_t *client_handle, 
                                    open_buffdesc *version); 

/*****************************************************************/
open_error_t openapiImageVersionAndNameGet(openapiClientHandle_t *client_handle,
                                           uint32_t              unit,
                                           open_buffdesc         *activeImageVersion,
                                           open_buffdesc         *backupImageVersion,
                                           open_buffdesc         *currentActiveImage,
                                           open_buffdesc         *nextActiveImage);
#endif /* OPENAPI_IMAGE_H_INCLUDED */