SwiApiCmUpgrade.h

Go to the documentation of this file.

#ifndef __SWI_API_CM_UPGRADE_H__
#define __SWI_API_CM_UPGRADE_H__

#ifdef __cplusplus
extern "C" {
#endif

/* include files */
#include "SwiDataTypes.h"
#include "SwiRcodes.h"

/* defines */

enum SWI_TYPE_NvOperation
{
    SWI_NVOPER_BackupAll,   
    SWI_NVOPER_RestoreAll,  
    SWI_NVOPER_Backup,      
    SWI_NVOPER_Restore      
};

enum SWI_TYPE_NvCategory
{
    SWI_NVCAT_Factory,  
    SWI_NVCAT_Oem,      
    SWI_NVCAT_User      
};

struct SWI_STRUCT_NvStore
{
    swi_uint32 sizeStruct;
    
    swi_bool bSuccess;
    
    enum SWI_TYPE_NvOperation eOperation;   
    
    enum SWI_TYPE_NvCategory    eCategory;
    
    swi_uint32 nStored;
    
    swi_uint32 nSkipped;
    
    swi_uint32 nZeroLength;         
};
enum SWI_TYPE_FW_IMAGE
{
    FW_DWN_APPL,    
    FW_DWN_BOOT,    
    FW_DWN_QCOM,    
    FW_DWN_USBD,    
    FW_DWN_EXEC,    
    FW_DWN_SWOC     
};

enum SWI_NOTIF_FW_TYPE
{       
    FW_INIT,
        
    FW_INIT_ERR,
    
    FW_SOFT_RESET,
    
    FW_SOFT_RESET_ERR,

    FW_START_REQ,
    
    FW_START_REQ_ERR,
    
    FW_FILE_ERR,
    
    FW_DWN,
    
    FW_DWN_ERR,
    
    FW_CHKSUM,
    
    FW_CHKSUM_ERR,
    
    FW_FLASH,
    
    FW_FLASH_ERR,
    
    FW_LAUNCH_FRAG,
    
    FW_LAUNCH_FRAG_ERR,
            
    FW_RESET,
    
    FW_RESET_ERR,
            
    FW_DONE
} ;

struct SWI_STRUCT_FwDownload
{
    swi_uint32 sizeStruct;
        
    enum SWI_NOTIF_FW_TYPE State;                        
};

/* prototypes */
extern SWI_API SWI_RCODE SwiNvStore(
    struct  SWI_STRUCT_NvStore sNvStore, 
    swi_uint32 timeout);

extern SWI_API SWI_RCODE SwiFirmwareDownload(
    swi_charp szFileName,
    enum SWI_TYPE_FW_IMAGE eFwDwnType,
    swi_bool bMpDownload,
    swi_uint32 nHIPPayloadSize,
    swi_uint32 timeout);

#ifdef __cplusplus
} /* extern "C" { */
#endif

#endif /*__SWI_API_CM_UPGRADE_H__*/

/* 
 * $Log: SwiApiCmUpgrade.h,v $
 */