oad.h

Go to the documentation of this file.

/******************************************************************************

 @file  oad.h

 @brief This file contains OAD Profile header file.

 Group: WCS, BTS
 $Target Device: DEVICES $

 ******************************************************************************
 $License: BSD3 2017 $
 ******************************************************************************
 $Release Name: PACKAGE NAME $
 $Release Date: PACKAGE RELEASE DATE $
 *****************************************************************************/
#ifndef OAD_H
#define OAD_H

#ifdef __cplusplus
extern "C"
{
#endif

/*********************************************************************
 * INCLUDES
 */

#include "oad_image_header.h"

/*********************************************************************
 * CONSTANTS
 */

#ifdef OAD_BLE_SECURITY
    #define OAD_WRITE_PERMIT     GATT_PERMIT_AUTHEN_WRITE
#else
    #define OAD_WRITE_PERMIT     GATT_PERMIT_WRITE
#endif //OAD_SECURITY

#define OAD_IMG_ID_RETRIES                  3

// Events the OAD process will post to the app

#define OAD_QUEUE_EVT                       Event_Id_01

#define OAD_DL_COMPLETE_EVT                 Event_Id_02
  
#define OAD_OUT_OF_MEM_EVT                  Event_Id_03
  
#define OAD_RESET_DEV_EVT                   Event_Id_04

#define OAD_SERVICE_UUID                    0xFFC0

#define OAD_IMG_IDENTIFY_UUID               0xFFC1

#define OAD_IMG_BLOCK_UUID                  0xFFC2

#define OAD_IMG_COUNT_UUID                  0xFFC3

#define OAD_IMG_STATUS_UUID                 0xFFC4

#define OAD_EXT_CTRL_UUID                   0xFFC5

#define OAD_IDX_IMG_IDENTIFY                0

#define OAD_IDX_IMG_BLOCK                   1

#define OAD_IDX_EXT_CTRL                    2

#define OAD_ATT_OVERHEAD                    3

#define OAD_BLK_NUM_HDR_SZ                  4

#define OAD_DEFAULT_BLOCK_SIZE              20

#define OAD_MAX_BLOCK_SIZE                  244

#define OAD_IMAGE_ID_RSP_LEN                0x01

#define OAD_EXT_CTRL_GET_BLK_SZ             0x01

#define OAD_EXT_CTRL_IMG_CNT                0x02

#define OAD_EXT_CTRL_START_OAD              0x03

#define OAD_EXT_CTRL_ENABLE_IMG             0x04

#define OAD_EXT_CTRL_CANCEL_OAD             0x05

#define OAD_EXT_CTRL_DISABLE_BLK_NOTIF      0x06

#define OAD_EXT_CTRL_GET_SW_VER             0x07

#define OAD_EXT_CTRL_GET_IMG_STAT           0x08

#define OAD_EXT_CTRL_GET_PROF_VER           0x09

#define OAD_EXT_CTRL_GET_DEV_TYPE           0x10

#define OAD_EXT_CTRL_GET_IMG_INFO           0x11

#define OAD_EXT_CTRL_BLK_RSP_NOTIF          0x12

#define OAD_EXT_CTRL_ERASE_BONDS            0x13

#define OAD_EXT_CTRL_CMD_NOT_SUPPORTED      0xFF

#define OAD_IMG_INFO_ONCHIP                 0x01

#define OAD_DEFAULT_INACTIVITY_TIME         10000

#define OAD_MIN_INACTIVITY_TIME             4000

#define OAD_CHAR_CNT                        3

#define OAD_CCCD_CNT                        OAD_CHAR_CNT


#define OAD_SUCCESS                         0   
#define OAD_CRC_ERR                         1   
#define OAD_FLASH_ERR                       2   
#define OAD_BUFFER_OFL                      3   
#define OAD_ALREADY_STARTED                 4   
#define OAD_NOT_STARTED                     5   
#define OAD_DL_NOT_COMPLETE                 6   
#define OAD_NO_RESOURCES                    7   
#define OAD_IMAGE_TOO_BIG                   8   
#define OAD_INCOMPATIBLE_IMAGE              9   
#define OAD_INVALID_FILE                    10  
#define OAD_INCOMPATIBLE_FILE               11  
#define OAD_AUTH_FAIL                       12  
#define OAD_EXT_NOT_SUPPORTED               13  
#define OAD_DL_COMPLETE                     14  
#define OAD_CCCD_NOT_ENABLED                15  
#define OAD_IMG_ID_TIMEOUT                  16  


#define BIM_START                           0x1F000

#define OAD_IMG_PG_INVALID                  0xFF

#define OAD_SEC_ECDSA_P256                  0x01
#define OAD_SEC_AES_128_CBC                 0x02

#define OAD_EFL_MAX_META                    4

/*********************************************************************
 * MACROS
 */

#define EXT_CTRL_OP_CODE(pData)(pData[0])

/*********************************************************************
 * TYPEDEFS
 */

PACKED_TYPEDEF_STRUCT
{
    uint8_t   imgID[8];         
    uint8_t   bimVer;           
    uint8_t   metaVer;          
    uint8_t   imgCpStat;        
    uint8_t   crcStat;          
    uint8_t   imgType;          
    uint8_t   imgNo;            
    uint32_t  len;              
    uint8_t   softVer[4];       
} imgIdentifyPld_t;

PACKED_TYPEDEF_STRUCT
{
    uint8_t   cmdID;            
    uint8_t   prevBlkStat;      
    uint32_t  requestedBlk;     
}blockReqPld_t;

PACKED_TYPEDEF_STRUCT
{
    uint8_t   imgCpStat;        
    uint8_t   crcStat;          
    uint8_t   imgType;          
    uint8_t   imgNo;            
} imageInfo_t;

PACKED_TYPEDEF_STRUCT
{
    uint8_t     signerInfo[8];
    uint8_t     signature[64];
}signPld_ECDSA_P256_t;

PACKED_TYPEDEF_STRUCT
{
    uint8_t       securityVersion;
    uint32_t      timeStamp;
}securityHdr_t;

typedef enum
{
    OAD_WRITE_IDENTIFY_REQ,     
    OAD_WRITE_BLOCK_REQ,        
    OAD_IMAGE_COMPLETE,         
    OAD_EXT_CTRL_WRITE_CMD,     
    OAD_TIMEOUT                 
}oadEvent_e;


typedef enum
{
    OAD_IDLE,                   
    OAD_VALIDATE_IMG,           
    OAD_CONFIG,                 
    OAD_DOWNLOAD,               
    OAD_CHECK_DL,               
    OAD_COMPLETE                
}oadState_e;


/*********************************************************************
 * Ext Control Command Payloads
 */

PACKED_TYPEDEF_STRUCT
{
    uint8_t   cmdID;            
    uint8_t   status;           
} genericExtCtrlRsp_t;

PACKED_TYPEDEF_STRUCT
{
    uint8_t   cmdID;            
    uint8_t   profVer;          
} profileVerRsp_t;

PACKED_TYPEDEF_STRUCT
{
    uint8_t     cmdID;          
    uint16_t    oadBlkSz;       
} blockSizeRspPld_t;

PACKED_TYPEDEF_STRUCT
{
    uint8_t       cmdID;                    
    uint8_t       swVer[OAD_SW_VER_LEN];    
} swVersionPld_t;

PACKED_TYPEDEF_STRUCT
{
    uint8_t   cmdID;            
    uint8_t   chipType;         
    uint8_t   chipFamily;       
    uint8_t   hardwareRev;      
    uint8_t   rsvd;             
} deviceTypeRspPld_t;

PACKED_TYPEDEF_STRUCT
{
    uint8_t   cmdID;            
    uint8_t   numImages;        
    uint8_t   imgCpStat;        
    uint8_t   crcStat;          
    uint8_t   imgType;          
    uint8_t   imgNo;            
} imageInfoRspPld_t;

PACKED_TYPEDEF_STRUCT
{
    uint8_t     cmdID;          
    uint8_t     imgType;        
    uint8_t     imgNo;          
    uint16_t    techType;       
}extImgEnableReq_t;

/*********************************************************************
 * EXTERNAL VARIABLES
 */

/*********************************************************************
 * Profile Callbacks
 */

typedef void (*oadWriteCB_t)(uint8_t event, uint16_t arg);

typedef struct
{
    oadWriteCB_t       pfnOadWrite; 
} oadTargetCBs_t;

/*********************************************************************
 * FUNCTIONS
 */

extern uint8_t OAD_open(uint32_t oadTimeout);

extern void OAD_cancel(void);


extern void OAD_close(void);

extern bool OAD_isUsrAppValid(void);

extern void OAD_register(oadTargetCBs_t *pfnOadCBs);

extern bool OAD_getSWVersion(uint8_t *swVer, uint8_t len);

extern uint16_t OAD_getBlockSize(void);

extern uint8_t OAD_setBlockSize(uint16_t mtuSize);

extern uint8_t OAD_processQueue(void);

extern uint16_t OAD_getactiveCxnHandle();

extern uint8_t oadCreateFactoryImageBackup(void);

/*********************************************************************
*********************************************************************/

#ifdef __cplusplus
}
#endif

#endif /* OAD_H */