openapi_transfer.h

Go to the documentation of this file.

/*********************************************************************
*
* Copyright 2016-2024 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_transfer.h
*
* @purpose   Transfer Download
*
* @component OpEN
*
* @create    2/18/2016
*
* @end
*
**********************************************************************/
#ifndef OPENAPI_TRANSFER_H_INCLUDED
#define OPENAPI_TRANSFER_H_INCLUDED

#include "openapi_common.h"

typedef enum
{
  OPEN_TRANSFER_NONE      = 0,     
  OPEN_TRANSFER_TFTP      = 1,     
  OPEN_TRANSFER_SFTP      = 2,     
  OPEN_TRANSFER_SCP       = 3,     
  OPEN_TRANSFER_HTTP      = 4,     
  OPEN_TRANSFER_HTTPS     = 5,     
  OPEN_TRANSFER_FTP       = 6,     
  OPEN_TRANSFER_XMODEM    = 7,     
  OPEN_TRANSFER_YMODEM    = 8,     
  OPEN_TRANSFER_ZMODEM    = 9,     
  OPEN_TRANSFER_USB       =10,     
  OPEN_TRANSFER_LAST               
} OPEN_TRANSFER_MODES_t;

typedef enum
{
  OPEN_FILE_TYPE_NONE                     = 0, 
  OPEN_FILE_TYPE_CODE                     = 1, 
  OPEN_FILE_TYPE_CONFIG                   = 2, 
  OPEN_FILE_TYPE_BACKUP_CONFIG            = 3, 
  OPEN_FILE_TYPE_LICENSE                  = 4, 
  OPEN_FILE_TYPE_TXTCFG                   = 5, 
  OPEN_FILE_TYPE_ERRORLOG                 = 6, 
  OPEN_FILE_TYPE_VALGLOG                  = 7, 
  OPEN_FILE_TYPE_SYSTEM_MSGLOG            = 8, 
  OPEN_FILE_TYPE_TRAP_LOG                 = 9, 
  OPEN_FILE_TYPE_SSHKEY_RSA2              =10, 
  OPEN_FILE_TYPE_SSHKEY_DSA               =11, 
  OPEN_FILE_TYPE_SSHKEY_ECDSA             =12, 
  OPEN_FILE_TYPE_SSLPEM_ROOT              =13, 
  OPEN_FILE_TYPE_SSLPEM_SERVER            =14, 
  OPEN_FILE_TYPE_SSLPEM_DHSTRONG          =15, 
  OPEN_FILE_TYPE_SSLPEM_DHVSTRONG         =16, 
  OPEN_FILE_TYPE_CONFIG_SCRIPT            =17, 
  OPEN_FILE_TYPE_CORE_DUMP                =18, 
  OPEN_FILE_TYPE_CLI_BANNER               =19, 
  OPEN_FILE_TYPE_KERNEL                   =20, 
  OPEN_FILE_TYPE_STARTUP_LOG              =21, 
  OPEN_FILE_TYPE_OPERATIONAL_LOG          =22, 
  OPEN_FILE_TYPE_TR069_ACS_SSLPEM_ROOT    =23, 
  OPEN_FILE_TYPE_TR069_CLIENT_SSLPRIV_KEY =24, 
  OPEN_FILE_TYPE_TR069_CLIENT_SSL_CERT    =25, 
  OPEN_FILE_TYPE_IAS_USERS                =26, 
  OPEN_FILE_TYPE_TECHSUPPORT              =27, 
  OPEN_FILE_TYPE_OPENFLOW_SSL_CA_CERT     =28, 
  OPEN_FILE_TYPE_OPENFLOW_SSL_PRIV_KEY    =29, 
  OPEN_FILE_TYPE_OPENFLOW_SSL_CERT        =30, 
  OPEN_FILE_TYPE_SSL_CA_CERT              =31, 
  OPEN_FILE_TYPE_SSL_CLIENT_KEY           =32, 
  OPEN_FILE_TYPE_CLIENT_SSL_CERT          =33, 
  OPEN_FILE_TYPE_ROOT_CA_CERTIFICATES     =34, 
  OPEN_FILE_TYPE_CAPTURED_CPU_PKTS        =35, 
  OPEN_FILE_TYPE_STARTUP_CONFIG           =36, 
  OPEN_FILE_TYPE_FACTORY_DEFAULT_CONFIG   =37, 
  OPEN_FILE_TYPE_CRASH_LOG                =38, 
  OPEN_FILE_TYPE_APPLICATION              =39, 
  OPEN_FILE_TYPE_PUBLICKEY_IMAGE          =40, 
  OPEN_FILE_TYPE_PUBLICKEY_CONFIG         =41, 
  OPEN_FILE_TYPE_ALL_PERSISTENT_LOG       =42, 
  OPEN_FILE_TYPE_TECHSUPPORT_CMDS         =43, 
  OPEN_FILE_TYPE_PACKET_TRACE_PCAP        =44, 
  OPEN_FILE_TYPE_DHCP_CLIENT_CONFIG_FILES =45, 
  OPEN_FILE_TYPE_SSHKEY_USER_PUBLIC_KEY   =46, 
  OPEN_FILE_TYPE_REFERENCE_CONFIG         =47, 
  OPEN_FILE_TYPE_LAST                        , 
} OPEN_FILE_TYPES_t;

typedef enum
{
  OPEN_NO_STATUS_CHANGE                   = 1,
  OPEN_STATUS_CHANGED                     = 2,
  OPEN_TRANSFER_FAILED                    = 3,
  OPEN_TRANSFER_BAD_CRC                   = 4,
  OPEN_FLASH_FAILED                       = 5,
  OPEN_OPR_FILE_TYPE_FAILED               = 6,
  OPEN_OTHER_FILE_TYPE_FAILED             = 7,
  OPEN_NEXT_DATA_BLOCK_RECEIVED           = 8,
  OPEN_TRANSFER_FILE_NOT_FOUND            = 9,
  OPEN_TRANSFER_SUCCESS                   = 10,
  OPEN_TFTP_FAILED                        = 11,
  OPEN_OPR_FILE_VERSION_FAILED            = 12,  
  OPEN_DIGITAL_SIGNATURE_VERIFY_FAILED    = 13,  
  OPEN_DIGITAL_SIGNATURE_TRUNCATE_FAILED  = 14,
  OPEN_TRANSFER_STATUS_LAST               = 15
} OPEN_TRANSFER_STATUS_t;

typedef enum
{
  OPEN_TRANSFER_CODE_NONE                     = 0,
  OPEN_TRANSFER_CODE_STARTING                 = 1,
  OPEN_TRANSFER_CODE_ERROR_STARTING           = 2,
  OPEN_TRANSFER_CODE_WRONG_FILE_TYPE          = 3,
  OPEN_TRANSFER_CODE_UPDATE_CONFIG            = 4,
  OPEN_TRANSFER_CODE_INVALID_CONFIG           = 5,
  OPEN_TRANSFER_CODE_WRITING_FLASH            = 6,
  OPEN_TRANSFER_CODE_FLASH_FAILED             = 7,
  OPEN_TRANSFER_CODE_CHECKING_CRC             = 8,
  OPEN_TRANSFER_CODE_CRC_FAILURE              = 9,
  OPEN_TRANSFER_CODE_UNKNOWN_DIRECTION        = 10,
  OPEN_TRANSFER_CODE_SUCCESS                  = 11,
  OPEN_TRANSFER_CODE_FAILURE                  = 12,
  OPEN_TRANSFER_CODE_WRONG_DEVICE             = 13,
  OPEN_TRANSFER_CODE_INSUFFICIENT_MEMORY      = 14, 
  OPEN_TRANSFER_CODE_FLASH_FILE_OPEN_FAIL     = 15,
  OPEN_TRANSFER_CODE_ERROR_READING_FROM_FLASH = 16,
  OPEN_TRANSFER_CODE_FILE_DOES_NOT_EXISTS     = 17,
  OPEN_TRANSFER_CODE_FILE_TOO_BIG             = 18,
  OPEN_TRANSFER_CODE_ERROR_WRITING_TO_FLASH   = 19,
  OPEN_TRANSFER_CODE_OVERWRITE_DENIED         = 20,
  OPEN_TRANSFER_CODE_LAST                     = 21
} OPEN_TRANSFER_CODE_t;

typedef enum
{
  OPEN_DIGITAL_SIGNATURE_VERIFY_NONE               = 0, 
  OPEN_DIGITAL_SIGNATURE_VERIFY_IMAGE_ONLY         = 1, 
  OPEN_DIGITAL_SIGNATURE_VERIFY_CONFIG_SCRIPT_ONLY = 2, 
  OPEN_DIGITAL_SIGNATURE_VERIFY_ALL                = 3, 
  OPEN_DIGITAL_SIGNATURE_VERIFY_LAST               = 4  
} OPEN_DIGITAL_SIGNATURE_OPTION_t;

typedef enum
{
  OPEN_COPY_CONFIG_DIRECTIVE_RTOF = 1, 
  OPEN_COPY_CONFIG_DIRECTIVE_RTOS = 2, 
  OPEN_COPY_CONFIG_DIRECTIVE_STOB = 3, 
  OPEN_COPY_CONFIG_DIRECTIVE_BTOS = 4  
} OPEN_COPY_CONFIG_DIRECTIVE_t;

/*****************************************************************/
open_error_t openapiImageHeaderSizeGet(openapiClientHandle_t *client_handle, 
                                       uint32_t *headerSize);

/*****************************************************************/
open_error_t openapiImageHeaderCheck(openapiClientHandle_t *client_handle, 
                                     open_buffdesc *headerData,
                                     OPEN_BOOL_t *isValid);

/*****************************************************************/
open_error_t openapiTransferModeGet(openapiClientHandle_t *client_handle, 
                                    OPEN_TRANSFER_MODES_t *xfrMode);

/*****************************************************************/
open_error_t openapiTransferModeSet(openapiClientHandle_t *client_handle, 
                                    OPEN_TRANSFER_MODES_t xfrMode);

/*****************************************************************/
open_error_t openapiTransferFileTypeGet(openapiClientHandle_t *client_handle, 
                                        OPEN_FILE_TYPES_t *fileType);

/*****************************************************************/
open_error_t openapiTransferFileTypeSet(openapiClientHandle_t *client_handle, 
                                        OPEN_FILE_TYPES_t fileType);

/*****************************************************************/
open_error_t openapiTransferServerPortSet(openapiClientHandle_t *client_handle,
                                          uint32_t serverPort);

/*****************************************************************/
open_error_t openapiTransferServerPortGet(openapiClientHandle_t *client_handle,
                                          uint32_t *serverPort);

/*****************************************************************/
open_error_t openapiTransferDownloadFileTypeGet(openapiClientHandle_t *client_handle, 
                                                OPEN_FILE_TYPES_t *pFileType);

/*****************************************************************/
open_error_t openapiTransferDownloadFileTypeSet(openapiClientHandle_t *client_handle, 
                                                OPEN_FILE_TYPES_t fileType);

/*****************************************************************/
open_error_t openapiTransferUploadFileTypeGet(openapiClientHandle_t *client_handle, 
                                                OPEN_FILE_TYPES_t *pFileType);

/*****************************************************************/
open_error_t openapiTransferUploadFileTypeSet(openapiClientHandle_t *client_handle, 
                                                OPEN_FILE_TYPES_t fileType);

/*****************************************************************/
open_error_t openapiTransferServerAddressGet(openapiClientHandle_t *client_handle,
                                             open_inet_addr_t *inetAddr);

/*****************************************************************/
open_error_t openapiTransferServerAddressSet(openapiClientHandle_t *client_handle,
                                             open_inet_addr_t inetAddr);

/*****************************************************************/
open_error_t openapiTransferFileRemoteGet(openapiClientHandle_t *client_handle,
                                          open_buffdesc *filePath, 
                                          open_buffdesc *fileName);

/*****************************************************************/
open_error_t openapiTransferFileRemoteSet(openapiClientHandle_t *client_handle,
                                          open_buffdesc *filePath, 
                                          open_buffdesc *fileName);

/*****************************************************************/
open_error_t openapiTransferFileLocalGet(openapiClientHandle_t *client_handle, 
                                         open_buffdesc *imageLabel);

/*****************************************************************/
open_error_t openapiTransferFileLocalSet(openapiClientHandle_t *client_handle, 
                                         open_buffdesc *imageLabel);

/*****************************************************************/
open_error_t openapiTransferRemoteUserCredentialsGet(openapiClientHandle_t *client_handle, 
                                                     open_buffdesc *username, 
                                                     open_buffdesc *password);

/*****************************************************************/
open_error_t openapiTransferRemoteUserCredentialsSet(openapiClientHandle_t *client_handle, 
                                                     open_buffdesc *username, 
                                                     open_buffdesc *password);

/*****************************************************************/
open_error_t openapiHttpTransferDownStartSet(openapiClientHandle_t *client_handle,
                                             open_buffdesc *filePathBuf, 
                                             open_buffdesc *fileNameBuf);

/*****************************************************************/
open_error_t openapiTransferDownStartSet(openapiClientHandle_t *client_handle);

/*****************************************************************/
open_error_t openapiTransferInProgressGet(openapiClientHandle_t *client_handle, 
                                          OPEN_BOOL_t *isInProgress);

/*****************************************************************/
open_error_t openapiTransferResultGet(openapiClientHandle_t *client_handle, 
                                      OPEN_TRANSFER_STATUS_t *resultCode,
                                      open_buffdesc *resultStatus);

/*****************************************************************/
open_error_t openapiTransferUpStartSet(openapiClientHandle_t *client_handle);

/*****************************************************************/
open_error_t openapiTransferDownloadResultCodeGet(openapiClientHandle_t *client_handle, 
                                                  OPEN_TRANSFER_CODE_t *resultCode);

/*****************************************************************/
open_error_t openapiDigitalSignatureVerifyConfigGet(openapiClientHandle_t *client_handle,
                                                    OPEN_DIGITAL_SIGNATURE_OPTION_t *dsvConfigOption); 

/*****************************************************************/
open_error_t openapiDigitalSignatureVerifyConfigSet(openapiClientHandle_t *client_handle,
                                                    OPEN_DIGITAL_SIGNATURE_OPTION_t dsvConfigOption); 

/*****************************************************************/
open_error_t openapiCopyConfigFile(openapiClientHandle_t *client_handle,
                                   OPEN_COPY_CONFIG_DIRECTIVE_t directive);

/*********************************************************************************/
open_error_t openapiTransferLicenseIndexSet(openapiClientHandle_t *client_handle,
                                            uint32_t  licenseIndex);

/*****************************************************************/
open_error_t openapiFileCopy(openapiClientHandle_t *client_handle,
                             uint32_t unit,
                             open_buffdesc *srcFileName,
                             open_buffdesc *dstFileName);

/*********************************************************************************/
open_error_t openapiTransferUsbDeviceNumberSet(openapiClientHandle_t *client_handle,
                                               uint32_t  usbNumber);

/*********************************************************************************/
open_error_t openapiTransferUsbDeviceNumberGet(openapiClientHandle_t *client_handle,
                                               uint32_t  *usbNumber);

#endif /* OPENAPI_TRANSFER_H_INCLUDED */