m2mb_fwup.h

Go to the documentation of this file.

/*===============================================================================================*/
/*         >>> Copyright (C) Telit Communications S.p.A. Italy All Rights Reserved. <<<          */
/* GLOBAL DECLARATIONS ==========================================================================*/
#ifndef  M2MB_FWUP_API_H
#define  M2MB_FWUP_API_H

#ifdef __cplusplus
extern "C" {
#endif

/*-----------------------------------------------------------------------------------------------*/

/*-----------------------------------------------------------------------------------------------*/

/*===============================================================================================*/

/* Global typedefs ==============================================================================*/

typedef enum M2MB_FWUP_FWD_BOOT_TYPE
{
    M2MB_FWUP_FWD_BOOT_TYPE_GOLDEN  = 1,   
    M2MB_FWUP_FWD_BOOT_TYPE_CURRENT = 2,   
    M2MB_FWUP_FWD_BOOT_TYPE_TRIAL   = 4,   
} M2MB_FWUP_FWD_BOOT_TYPE_T;

typedef enum M2MB_FWUP_DATA_FLAG
{
    M2MB_FWUP_DATA_FRAGMENT         = 1,   
    M2MB_FWUP_DATA_FRAGMENT_LAST    = 2,   
    M2MB_FWUP_DATA_FRAGMENT_ERROR   = 0,   
} M2MB_FWUP_DATA_FLAG_T;

typedef enum M2MB_FWUP_STATUS_CODE
{     
    M2MB_FWUP_OK_E = 0,                            
    M2MB_FWUP_ERROR_E = 1,                         
    M2MB_FWUP_ERR_INCOMPLETE_E = 1000,             
    M2MB_FWUP_ERR_SESSION_IN_PROGRESS_E,           
    M2MB_FWUP_ERR_SESSION_NOT_START_E,             
    M2MB_FWUP_ERR_SESSION_NOT_READY_FOR_SUSPEND_E, 
    M2MB_FWUP_ERR_SESSION_NOT_SUSPEND_E,           
    M2MB_FWUP_ERR_SESSION_RESUME_NOT_SUPPORT_E,    
    M2MB_FWUP_ERR_SESSION_CANCELLED_E,             
    M2MB_FWUP_ERR_SESSION_SUSPEND_E,               
    M2MB_FWUP_ERR_INTERFACE_NAME_TOO_LONG_E,       
    M2MB_FWUP_ERR_URL_TOO_LONG_E,                  
    M2MB_FWUP_ERR_FLASH_NOT_SUPPORT_FW_UPGRADE_E,  
    M2MB_FWUP_ERR_FLASH_INIT_TIMEOUT_E,            
    M2MB_FWUP_ERR_FLASH_READ_FAIL_E,               
    M2MB_FWUP_ERR_FLASH_WRITE_FAIL_E,              
    M2MB_FWUP_ERR_FLASH_ERASE_FAIL_E,              
    M2MB_FWUP_ERR_FLASH_NOT_ENOUGH_SPACE_E,        
    M2MB_FWUP_ERR_FLASH_CREATE_PARTITION_E,        
    M2MB_FWUP_ERR_FLASH_IMAGE_NOT_FOUND_E,         
    M2MB_FWUP_ERR_FLASH_ERASE_PARTITION_E,         
    M2MB_FWUP_ERR_FLASH_WRITE_PARTITION_E,         
    M2MB_FWUP_ERR_IMAGE_NOT_FOUND_E,               
    M2MB_FWUP_ERR_IMAGE_DOWNLOAD_FAIL_E,           
    M2MB_FWUP_ERR_INCORRECT_IMAGE_CHECKSUM_E,      
    M2MB_FWUP_ERR_SERVER_RSP_TIMEOUT_E,            
    M2MB_FWUP_ERR_INVALID_FILENAME_E,              
    M2MB_FWUP_ERR_INCORRECT_IMAGE_HDR_E,           
    M2MB_FWUP_ERR_INSUFFICIENT_MEMORY_E,           
    M2MB_FWUP_ERR_INCORRECT_SIGNATURE_E,           
    M2MB_FWUP_ERR_INCORRCT_VERSION_E,              
    M2MB_FWUP_ERR_INCORRECT_NUM_IMAGES_E,          
    M2MB_FWUP_ERR_INCORRECT_IMAGE_LENGTH_E,        
    M2MB_FWUP_ERR_INCORRECT_HASH_TYPE_E,           
    M2MB_FWUP_ERR_INCORRECT_IMAGE_ID_E,            
    M2MB_FWUP_ERR_BATTERY_LEVEL_TOO_LOW_E,         
    M2MB_FWUP_ERR_CRYPTO_FAIL_E,                   
    M2MB_FWUP_ERR_PLUGIN_ENTRY_EMPTY_E,            
    M2MB_FWUP_ERR_TRIAL_IS_RUNNING_E,              
    M2MB_FWUP_ERR_FILE_NOT_FOUND_E,                
    M2MB_FWUP_ERR_FILE_OPEN_ERROR_E,               
    M2MB_FWUP_ERR_FILE_NAME_TOO_LONG_E,            
    M2MB_FWUP_ERR_FILE_WRITE_ERROR_E,              
    M2MB_FWUP_ERR_MOUNT_FILE_SYSTEM_ERROR_E,       
    M2MB_FWUP_ERR_PRESERVE_LAST_FAILED_E,          
} M2MB_FWUP_STATUS_CODE_T; 
typedef VOID (*M2MB_FWUP_USER_CB_T)(M2MB_FWUP_STATUS_CODE_T resp_code);

/* External variables ===========================================================================*/

/* External functions ===========================================================================*/

/* Global functions =============================================================================*/

/*-----------------------------------------------------------------------------------------------*/

/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_fwup_init( UINT32 flags );

/*-----------------------------------------------------------------------------------------------*/

/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_fwup_start( M2MB_FWUP_USER_CB_T user_cb  );

/*-----------------------------------------------------------------------------------------------*/

/*-----------------------------------------------------------------------------------------------*/
M2MB_STATUS_T m2mb_fwup_process_recv_data( UINT32 data_len, UINT8 *data_ptr, 
    M2MB_FWUP_DATA_FLAG_T flag );

/*-----------------------------------------------------------------------------------------------*/

/*-----------------------------------------------------------------------------------------------*/
UINT8 m2mb_fwup_get_active_fwd(UINT32 *fwd_boot_type, UINT32 *valid_fwd);

/*-----------------------------------------------------------------------------------------------*/

/*-----------------------------------------------------------------------------------------------*/
M2MB_FWUP_STATUS_CODE_T m2mb_fwup_done(UINT32 accept, UINT32 reboot);

/*-----------------------------------------------------------------------------------------------*/

/*-----------------------------------------------------------------------------------------------*/

#endif