TI BLE5-Stack API Documentation  1.01.14.00
Macros | Variables
oad_image_header.h File Reference

Detailed Description

Structure definition for image header and segments, these are prepended to the over the air images.

Go to the source code of this file.

Macros

#define BIM_VER   0x3
 
#define BIM_VER_OFFSET   offsetof(imgHdr_t, fixedHdr.bimVer)
 
#define BOUNDARY_SEG_OFFSET   offsetof(imgHdr_t, fixedHdr.segTypeBd)
 
#define COPY_DONE   0xFC
 
#define CRC_INVALID   0xFC
 
#define CRC_OFFSET   offsetof(imgHdr_t, fixedHdr.crc32)
 
#define CRC_STAT_OFFSET   offsetof(imgHdr_t, fixedHdr.crcStat)
 
#define CRC_VALID   0xFE
 
#define DEFAULT_CRC   0xFFFFFFFF
 
#define DEFAULT_STATE   0xFF
 
#define EFL_MATADATA_HDR_LEN   OAD_IMG_HDR_LEN + 8
 
#define IMG_BOUNDARY_SEG_ID   0x00
 
#define IMG_COPY_STAT_OFFSET   IMG_INFO_OFFSET
 
#define IMG_DATA_OFFSET   BIM_VER_OFFSET
 
#define IMG_INFO_OFFSET   offsetof(imgHdr_t, fixedHdr.imgCpStat)
 
#define IMG_NONCOUNT_SEG_ID   0x02
 
#define IMG_PAYLOAD_SEG_ID   0x01
 
#define IMG_SECURITY_SEG_ID   0x03
 
#define IMG_TYPE_OFFSET   offsetof(imgHdr_t, fixedHdr.imgType)
 
#define INVALID_ADDR   0xFFFFFFFF
 
#define INVALID_LEN   INVALID_ADDR
 
#define META_VER   0x1
 
#define NEED_COPY   0xFE
 
#define OAD_EXTFL_ID_VAL   {'O', 'A', 'D', ' ', 'N', 'V', 'M', '1'}
 
#define OAD_IMG_HDR_LEN   sizeof(imgFixedHdr_t)
 
#define OAD_IMG_ID_LEN   8
 
#define OAD_IMG_TYPE_APP   1
 
#define OAD_IMG_TYPE_APP_STACK   3
 
#define OAD_IMG_TYPE_APPSTACKLIB   7
 
#define OAD_IMG_TYPE_BIM   6
 
#define OAD_IMG_TYPE_FACTORY   5
 
#define OAD_IMG_TYPE_HOST_BEGIN   32
 
#define OAD_IMG_TYPE_HOST_END   63
 
#define OAD_IMG_TYPE_NP   4
 
#define OAD_IMG_TYPE_PERSISTENT_APP   0
 
#define OAD_IMG_TYPE_RSVD_BEGIN   64
 
#define OAD_IMG_TYPE_RSVD_END   255
 
#define OAD_IMG_TYPE_STACK   2
 
#define OAD_IMG_TYPE_USR_BEGIN   16
 
#define OAD_IMG_TYPE_USR_END   31
 
#define OAD_SW_VER_LEN   4
 
#define OAD_WIRELESS_TECH_BLE   0xFFFE
 
#define OAD_WIRELESS_TECH_EASYLINK   0xFFBF
 
#define OAD_WIRELESS_TECH_RF4CE   0xFFEF
 
#define OAD_WIRELESS_TECH_THREAD   0xFFDF
 
#define OAD_WIRELESS_TECH_TIMAC_2_4G   0xFFFB
 
#define OAD_WIRELESS_TECH_TIMAC_SUBG   0xFFFD
 
#define OAD_WIRELESS_TECH_ZIGBEE   0xFFF7
 
#define SEG_HDR_LEN   12
 
#define SEG_LEN_OFFSET   4
 

Variables

uint8_t bimVer
 BIM version.
 
 boundarySeg_t
 
uint32_t boundarySegLen
 Boundary segment length.
 
uint32_t crc32
 Image's 32-bit CRC value.
 
uint8_t crcStat
 CRC status.
 
uint16_t hdrLen
 Total length of the image header.
 
uint8_t imgCpStat
 Image copy status.
 
uint32_t imgEndAddr
 Address of the last byte of a contiguous image.
 
 imgFixedHdr_t
 
 imgHdr_t
 
uint8_t imgNo
 Image number of 'image type'.
 
imgPayloadSeg_t imgPayload
 Required contiguous image segment.
 
 imgPayloadSeg_t
 
uint32_t imgSegLen
 Payload segment length.
 
uint8_t imgType
 Image Type.
 
uint32_t imgVld
 This field is RFU.
 
uint32_t len
 Image length in bytes.
 
uint8_t metaVer
 Metadata version.
 
uint32_t prgEntry
 Program entry address.
 
uint32_t ram0EndAddr
 RAM entry end address.
 
uint32_t ram0StartAddr
 RAM entry start address.
 
uint16_t rfu
 Reserved bytes. More...
 
uint8_t softVer [4]
 Software version of the image.
 
uint32_t stackEntryAddr
 Stack start address.
 
uint32_t stackStartAddr
 Start address of stack image on internal flash.
 
uint32_t startAddr
 Start address of image on internal flash.
 
uint16_t techType
 Wireless protocol type BLE/TI-MAC/ZIGBEE etc.
 
 TYPEDEF_STRUCT_PACKED
 User-defined Image Identification bytes. More...
 
uint16_t wirelessTech
 Wireless technology type.
 
© Copyright 1995-2021, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale