image_format.h

Go to the documentation of this file.

 
#ifndef _IMAGE_FORMAT_H
#define _IMAGE_FORMAT_H
 
#include <stdint.h>
#include <stddef.h>
 
// Packed structure attributes
#if defined(_MSC_VER)
   #define IMAGE_PACK_BEGIN __pragma(pack(push, 1))
   #define IMAGE_PACK_END   __pragma(pack(pop))
   #define IMAGE_PACK_ATTR
#elif defined(__GNUC__) || defined(__clang__) || defined(__ARMCC_VERSION) ||                        \
   defined(__CC_ARM) || defined(__IAR_SYSTEMS_ICC__) || defined(__TASKING__)
   #define IMAGE_PACK_BEGIN
   #define IMAGE_PACK_END
   #define IMAGE_PACK_ATTR __attribute__((packed))
#else
   #define IMAGE_PACK_BEGIN
   #define IMAGE_PACK_END
   #define IMAGE_PACK_ATTR
#endif
 
// Compile-time assertion
#if defined(__cplusplus) && (__cplusplus >= 201103L)
   #define IMAGE_FORMAT_STATIC_ASSERT(cond, msg) static_assert(cond, msg)
#elif defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201112L)
   #define IMAGE_FORMAT_STATIC_ASSERT(cond, msg) _Static_assert(cond, msg)
#else
   #define IMAGE_FORMAT_STATIC_ASSERT_CAT_(a, b) a ## b
   #define IMAGE_FORMAT_STATIC_ASSERT_CAT(a, b) IMAGE_FORMAT_STATIC_ASSERT_CAT_(a, b)
   #define IMAGE_FORMAT_STATIC_ASSERT(cond, msg)                                                    \
           typedef char IMAGE_FORMAT_STATIC_ASSERT_CAT(image_format_static_assert_, __LINE__)[(cond) ? 1 : -1]
#endif
 
typedef enum
{
   IMAGE_TYPE_APP = 0,
   IMAGE_TYPE_BOOT,
   IMAGE_TYPE_NONE
} ImageType;
 
IMAGE_PACK_BEGIN
typedef struct
{
   uint8_t major;
   uint8_t minor;
   uint16_t revision;
   uint32_t buildNum;
} IMAGE_PACK_ATTR ImageVersion;
IMAGE_PACK_END
 
   IMAGE_PACK_BEGIN
typedef struct
{
   uint32_t headVers;          
   uint32_t imgIndex;          
   uint8_t imgType;            
   uint32_t dataPadding;       
   uint32_t dataSize;          
   uint32_t binarySize;        
   ImageVersion dataVers;      
   uint64_t imgTime;           
   uint8_t reserved[23];       
   uint8_t headCrc[4];         
} IMAGE_PACK_ATTR ImageHeader;
IMAGE_PACK_END
 
   IMAGE_FORMAT_STATIC_ASSERT(sizeof(ImageVersion) == 8, "ImageVersion on-flash layout changed");
IMAGE_FORMAT_STATIC_ASSERT(offsetof(ImageVersion, major) == 0, "ImageVersion.major offset changed");
IMAGE_FORMAT_STATIC_ASSERT(offsetof(ImageVersion, minor) == 1, "ImageVersion.minor offset changed");
IMAGE_FORMAT_STATIC_ASSERT(offsetof(ImageVersion, revision) == 2, "ImageVersion.revision offset changed");
IMAGE_FORMAT_STATIC_ASSERT(offsetof(ImageVersion, buildNum) == 4, "ImageVersion.buildNum offset changed");
 
IMAGE_FORMAT_STATIC_ASSERT(sizeof(ImageHeader) == 64, "ImageHeader on-flash layout changed (must stay 64 bytes)");
IMAGE_FORMAT_STATIC_ASSERT(offsetof(ImageHeader, headVers) == 0, "ImageHeader.headVers offset changed");
IMAGE_FORMAT_STATIC_ASSERT(offsetof(ImageHeader, imgIndex) == 4, "ImageHeader.imgIndex offset changed");
IMAGE_FORMAT_STATIC_ASSERT(offsetof(ImageHeader, imgType) == 8, "ImageHeader.imgType offset changed");
IMAGE_FORMAT_STATIC_ASSERT(offsetof(ImageHeader, dataPadding) == 9, "ImageHeader.dataPadding offset changed");
IMAGE_FORMAT_STATIC_ASSERT(offsetof(ImageHeader, dataSize) == 13, "ImageHeader.dataSize offset changed");
IMAGE_FORMAT_STATIC_ASSERT(offsetof(ImageHeader, binarySize) == 17, "ImageHeader.binarySize offset changed");
IMAGE_FORMAT_STATIC_ASSERT(offsetof(ImageHeader, dataVers) == 21, "ImageHeader.dataVers offset changed");
IMAGE_FORMAT_STATIC_ASSERT(offsetof(ImageHeader, imgTime) == 29, "ImageHeader.imgTime offset changed");
IMAGE_FORMAT_STATIC_ASSERT(offsetof(ImageHeader, reserved) == 37, "ImageHeader.reserved offset changed");
IMAGE_FORMAT_STATIC_ASSERT(offsetof(ImageHeader, headCrc) == 60, "ImageHeader.headCrc offset changed");
 
#endif // _IMAGE_FORMAT_H