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

#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_USR_BEGIN            16

#define OAD_IMG_TYPE_USR_END              31

#define OAD_IMG_TYPE_HOST_BEGIN           32

#define OAD_IMG_TYPE_HOST_END             63

#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_EASYLINK        0xFFBF

#ifdef DeviceFamily_CC26X2
  #define OAD_IMG_ID_VAL                    {'C', 'C', '2', '6', 'x', '2', 'R', '1'}
#elif defined (DeviceFamily_CC13X2)
  #define OAD_IMG_ID_VAL                    {'C', 'C', '1', '3', 'x', '2', 'R', '1'}
#elif defined (DeviceFamily_CC26X0R2)
  #define OAD_IMG_ID_VAL                    {'O', 'A', 'D', ' ', 'I', 'M', 'G', ' '}
#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 BOUNDARY_SEG_OFFSET          offsetof(imgHdr_t, fixedHdr.segTypeBd)


#define SEG_LEN_OFFSET               4

#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 BIM_VER                      0x3

#define META_VER                     0x1

#define DEFAULT_STATE                0xFF

#define CRC_VALID                    0xFE

#define CRC_INVALID                  0xFC

#define NEED_COPY                    0xFE

#define COPY_DONE                    0xFC

#define EFL_MATADATA_HDR_LEN         OAD_IMG_HDR_LEN + 8

#define INVALID_ADDR                 0xFFFFFFFF

#define INVALID_LEN                  INVALID_ADDR

#define DEFAULT_CRC                  0xFFFFFFFF

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

#if defined (__IAR_SYSTEMS_ICC__)
  #define TYPEDEF_STRUCT_PACKED        __packed typedef struct
#elif defined __TI_COMPILER_VERSION || defined __TI_COMPILER_VERSION__
  #define TYPEDEF_STRUCT_PACKED        typedef struct __attribute__((packed))
#elif defined (__GNUC__)
  #define TYPEDEF_STRUCT_PACKED        typedef struct __attribute__((__packed__))
#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;       
  uint8_t   softVer[4];     
  uint32_t  imgEndAddr;     
  uint16_t  hdrLen;         
  uint16_t  rfu;            
}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_PACKED
{
   imgFixedHdr_t         fixedHdr;    
#if (!defined(STACK_LIBRARY) && (defined(SPLIT_APP_STACK_IMAGE)))
   boundarySeg_t         boundarySeg; 
#endif
   imgPayloadSeg_t       imgPayload;  
} imgHdr_t;

#ifdef __cplusplus
}
#endif

#endif /* OAD_IMAGE_HEADER_H */