oad_image_header.h

Go to the documentation of this file.

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

 @file  oad_image_header.h

 @brief This file contains the image header definition and structures.

 Group: WCS, BTS
 $Target Device: DEVICES $

 ******************************************************************************
 $License: BSD3 2017 $
 ******************************************************************************
 $Release Name: PACKAGE NAME $
 $Release Date: PACKAGE RELEASE DATE $
 ******************************************************************************/

#ifndef OAD_IMAGE_HEADER_H
#define OAD_IMAGE_HEADER_H

#ifdef __cplusplus
extern "C"
{
#endif

/*******************************************************************************
 * INCLUDES
 ******************************************************************************/
#include <stddef.h>
#include <stdint.h>

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


#ifdef OAD_ONCHIP

  #define BIM_VAR_ADDR  0x20000400

  extern uint32_t _bim_var;
#endif // OAD_ONCHIP

#if defined(BIM_DUAL_ONCHIP_IMAGE) && !defined(SECURITY)
    // DUAL Image BIM is considered a strictly production ready variant. DEBUG_BIM cannot be used as
    // it would skip key security steps.
    #error "Error: DUAL ON CHIP BIM needs the macro SECURITY to be enabled"
#endif

#if defined (DeviceFamily_CC23X0R2)
    #define SIGN_FN_PTR 0x37fc       
#else
    #define SIGN_FN_PTR 0x57fa0      
#endif
extern uint32_t _sign_fnPtr;     

#define OAD_IMG_TYPE_PERSISTENT_APP       0

#define OAD_IMG_TYPE_APP                  1

#define OAD_IMG_TYPE_STACK                2

#define OAD_IMG_TYPE_APP_STACK            3

#define OAD_IMG_TYPE_NP                   4

#define OAD_IMG_TYPE_FACTORY              5

#define OAD_IMG_TYPE_BIM                  6

#define OAD_IMG_TYPE_APPSTACKLIB          7

#define OAD_IMG_TYPE_RSVD_BEGIN           64

#define OAD_IMG_TYPE_RSVD_END             255

#define OAD_WIRELESS_TECH_BLE             0xFFFE

#define OAD_WIRELESS_TECH_TIMAC_SUBG      0xFFFD

#define OAD_WIRELESS_TECH_TIMAC_2_4G      0xFFFB

#define OAD_WIRELESS_TECH_ZIGBEE          0xFFF7

#define OAD_WIRELESS_TECH_RF4CE           0xFFEF

#define OAD_WIRELESS_TECH_THREAD          0xFFDF

#define OAD_WIRELESS_TECH_PROPRF          0xFFBF

#define OAD_WIRELESS_TECH_MIOTY           0xFF7F

#define OAD_WIRELESS_TECH_WBMS_WD         0xFEFF

#define OAD_WIRELESS_TECH_WBMS_WM         0xFDFF


#if defined(DeviceFamily_CC26X2) || defined (DeviceFamily_CC26X2_V2) || \
    defined(DeviceFamily_CC26X2X7) || defined(DeviceFamily_CC26X1)
  #define OAD_IMG_ID_VAL                    {'C', 'C', '2', '6', 'x', '2', 'R', '1'}
#elif defined (DeviceFamily_CC13X2) ||                                        \
      defined (DeviceFamily_CC13X2X7) ||                                      \
      defined (DeviceFamily_CC13X1) ||                                        \
      defined (DeviceFamily_CC13X2_V1) ||                                     \
      defined (DeviceFamily_CC13X2_V2)
  #define OAD_IMG_ID_VAL                    {'C', 'C', '1', '3', 'x', '2', 'R', '1'}
#elif defined (DeviceFamily_CC13X4)
  #define OAD_IMG_ID_VAL                    {'C', 'C', '1', '3', 'x', '4', ' ', ' '}
#elif defined (DeviceFamily_CC26X3)
  #define OAD_IMG_ID_VAL                    {'C', 'C', '2', '6', 'x', '3', ' ', ' '}
#elif defined (DeviceFamily_CC26X4)
  #define OAD_IMG_ID_VAL                    {'C', 'C', '2', '6', 'x', '4', ' ', ' '}
#elif defined (DeviceFamily_CC26X0R2)
  #define OAD_IMG_ID_VAL                    {'O', 'A', 'D', ' ', 'I', 'M', 'G', ' '}
#elif defined (DeviceFamily_CC23X0R2)
  #define OAD_IMG_ID_VAL                    {'C', 'C', '2', '3', 'x', '0', 'R', '2'}
#elif defined (DOXYGEN)

  #define OAD_IMG_ID_VAL
#else
  #error "Unknown Device Family"
#endif //DeviceFamily_CC26X2

#define OAD_EXTFL_ID_VAL                  {'O', 'A', 'D', ' ', 'N', 'V', 'M', '1'}


#define CRC_OFFSET                   offsetof(imgHdr_t, fixedHdr.crc32)

#define BIM_VER_OFFSET               offsetof(imgHdr_t, fixedHdr.bimVer)

#define IMG_DATA_OFFSET              BIM_VER_OFFSET

#define IMG_INFO_OFFSET              offsetof(imgHdr_t, fixedHdr.imgCpStat)

#define IMG_COPY_STAT_OFFSET         IMG_INFO_OFFSET

#define CRC_STAT_OFFSET              offsetof(imgHdr_t, fixedHdr.crcStat)

#define IMG_TYPE_OFFSET              offsetof(imgHdr_t, fixedHdr.imgType)

#define IMG_VALIDATION_OFFSET        offsetof(imgHdr_t, fixedHdr.imgVld)

#define IMG_COMMIT_FLAG_OFFSET        offsetof(imgHdr_t, fixedHdr.commitFlag)

#define BOUNDARY_SEG_OFFSET          offsetof(imgHdr_t, fixedHdr.segTypeBd)

#define SEG_LEN_OFFSET               4

#define SEG_SIGERINFO_OFFSET         offsetof(imgHdr_t, secInfoSeg.secSignerInfo)

#define SEG_SIGNR_OFFSET             offsetof(imgHdr_t, secInfoSeg.eccSign.sign_r)

#define SEG_SIGNS_OFFSET             offsetof(imgHdr_t, secInfoSeg.eccSign.sign_s)

#define SEC_VERIF_STAT_OFFSET        offsetof(imgHdr_t, secInfoSeg.verifStat)

#define HDR_LEN_WITH_SECURITY_INFO   offsetof(imgHdr_t, secInfoSeg.segTypeSecure) + sizeof(securityInfoSeg_t)

#define IMG_START_ADDR_OFFSET        offsetof(imgHdr_t, imgPayload.startAddr)

#define SEG_HDR_LEN                  12

#define OAD_IMG_ID_LEN               8

#define OAD_SW_VER_LEN               4

#define OAD_IMG_HDR_LEN              sizeof(imgFixedHdr_t)

#define IMG_BOUNDARY_SEG_ID          0x00

#define IMG_PAYLOAD_SEG_ID           0x01


#define IMG_NONCOUNT_SEG_ID          0x02

#define IMG_SECURITY_SEG_ID          0x03

#define OAD_IMG_FULL_HDR_LEN         sizeof(imgHdr_t)                     
#define OAD_IMG_ID_LEN               8                                    
#define OAD_SW_VER_LEN               4                                    

#ifndef STACK_LIBRARY
  #define BOUNDARY_SEG_LEN           0x18 
#endif
#define SECURITY_SEG_LEN             0x55 

#define IMG_COPY_STAT_OFFSET         IMG_INFO_OFFSET                      /* Image copy status */

#define SEG_LEN_OFFSET               4                                    /* Offset from seg header to seg len */
#define SIG_OFFSET                   offsetof(securityInfoSeg_t, eccSign.sign_r)      

#define ECDSA_KEY_LEN                32    

#define ECDSA_SHA_TEMPWORKZONE_LEN   ECDSA_KEY_LEN*6  


#define BIM_VER                      0x3

#define META_VER                     0x1

#define SECURITY_VER                 0x1

#define DEFAULT_STATE                0xFF

#define CRC_VALID                    0xFE

#define CRC_INVALID                  0xFC

#define NEED_COPY                    0xFE

#define COPY_DONE                    0xFC

#ifdef BIM_DUAL_ONCHIP_IMAGE

#define VERIFY_PASS_CURRENT          0xFE

#define VERIFY_PASS_NOT_CURRENT      0xFC

#define VERIFY_FAIL                  0xF8

#else

#define VERIFY_FAIL                  0xFC

#endif // BIM_DUAL_ONCHIP_IMAGE

#define VERIFY_PASS                  0xFE

#ifdef BIM_RESTRICTED_ROLLBACK_VERIFY_COMMIT_IMAGE

#define COMMIT_PENDING               0XFF

#define COMMIT_ACCEPTED              0XFE

#define COMMIT_REJECTED              0XEF

#endif

#define EFL_MATADATA_HDR_LEN         OAD_IMG_HDR_LEN + 8

#define INVALID_ADDR                 0xFFFFFFFF

#define INVALID_LEN                  INVALID_ADDR

#define DEFAULT_CRC                  0xFFFFFFFF

#if (defined(SECURITY))

    #define SIGNER_INFO_SIZE                  8

    #define SIGNATURE_SIZE                    64
#endif

/*******************************************************************************
 * Typedefs
 */

#if defined (__IAR_SYSTEMS_ICC__)
  #define TYPEDEF_STRUCT_PACKED        __packed typedef struct
#elif defined __TI_COMPILER_VERSION || defined __TI_COMPILER_VERSION__ || __clang__
  #define TYPEDEF_STRUCT_PACKED        typedef struct __attribute__((packed))
#elif defined (__GNUC__)
  #define TYPEDEF_STRUCT_PACKED        typedef struct __attribute__((__packed__))
#endif

#if (defined(SECURITY))

    TYPEDEF_STRUCT_PACKED
    {
        uint8_t     signerInfo[SIGNER_INFO_SIZE];
        uint8_t     signature[SIGNATURE_SIZE];
    }signPld_ECDSA_P256_t;
#endif

TYPEDEF_STRUCT_PACKED
{
  uint8_t   imgID[8];       
  uint32_t  crc32;          
  uint8_t   bimVer;         
  uint8_t   metaVer;        
  uint16_t  techType;       
  uint8_t   imgCpStat;      
  uint8_t   crcStat;        
  uint8_t   imgType;        
  uint8_t   imgNo;          
  uint32_t  imgVld;         
  uint32_t  len;            
  uint32_t  prgEntry;       
#ifdef BIM_VERIFY_VERSION_IMAGE
  uint32_t  softVer;        
#else
  uint8_t   softVer[4];     
#endif
  uint32_t  imgEndAddr;     
  uint16_t  hdrLen;         
#ifdef BIM_RESTRICTED_ROLLBACK_VERIFY_COMMIT_IMAGE
  uint8_t   commitFlag;     
  uint8_t   rfu;            
#else
  uint16_t  rfu;            
#endif
}imgFixedHdr_t;

TYPEDEF_STRUCT_PACKED
{
  uint8_t   segTypeImg;     
  uint16_t  wirelessTech;   
  uint8_t   rfu;            
  uint32_t  imgSegLen;      
  uint32_t  startAddr;      
}imgPayloadSeg_t;

TYPEDEF_STRUCT_PACKED
{
  uint8_t   segTypeBd;      
  uint16_t  wirelessTech;   
  uint8_t   rfu;            
  uint32_t  boundarySegLen; 
  uint32_t  stackStartAddr; 
  uint32_t  stackEntryAddr; 
  uint32_t  ram0StartAddr;  
  uint32_t  ram0EndAddr;    
}boundarySeg_t;


typedef struct {
  uint8_t  sign_r[32];     
  uint8_t  sign_s[32];     
} eccSignature_t;

TYPEDEF_STRUCT_PACKED
{
  uint8_t   segTypeSecure;     
  uint16_t  wirelessTech;      
  uint8_t   verifStat;         
  uint32_t  secSegLen;         
  uint8_t   secVer;            
  uint32_t  secTimestamp;      
  uint8_t   secSignerInfo[8];  
  eccSignature_t  eccSign;     
}securityInfoSeg_t;

TYPEDEF_STRUCT_PACKED
{
   imgFixedHdr_t         fixedHdr;    
#if (defined(SECURITY))
   securityInfoSeg_t     secInfoSeg;  
#endif
#if (!defined(STACK_LIBRARY) && (defined(SPLIT_APP_STACK_IMAGE)))
   boundarySeg_t         boundarySeg; 
#endif
   imgPayloadSeg_t       imgPayload;  
} imgHdr_t;

TYPEDEF_STRUCT_PACKED
{
   uint32_t *eccWorkzone;    
   uint8_t *SHAWorkzone;  
   uint8_t *tempWorkzone;         
   uint8_t *SHADataBuf;           
   uint8_t  SHADataBufLen;                
} ecdsaSigVerifyBuf_t;

/*******************************************************************************
 * Typedefs
 */

typedef uint8_t (*bimSignFnPtr_t)(uint8_t, uint32_t, uint32_t, uint8_t *,
                                  uint8_t *, ecdsaSigVerifyBuf_t *);

#ifdef __cplusplus
}
#endif

#endif /* OAD_IMAGE_HEADER_H */