mailbox.h

Go to the documentation of this file.

 
#ifndef _MAILBOX_H
#define _MAILBOX_H
 
// Dependencies
#include <stddef.h>
#include "boot_config.h"
#include "core/cboot_error.h"
#include "image/image_format.h"
#include "debug.h"
#include "os_port.h"
 
// Bootloader mailbox version
#define BOOT_MBX_VERSION (uint32_t) 0x00010001
 
// Bootloader mailbox signture
#define BOOT_MBX_SIGNATURE 0x1b241671
 
// Bootloader mailbox flags
enum
{
   UPDATE_REQUESTED = 1 << 0,
   UPDATE_PERFORMED = 1 << 1,
   UPDATE_CONFIRMED = 1 << 2,
   FALLBACK_REQUESTED = 1 << 3,
   FALLBACK_PERFORMED = 1 << 4,
   FALLBACK_AVAILABLE = 1 << 5,
   REPAIR_PERFORMED = 1 << 6
};
 
// Bootloader mailbox NVM flags
#define BOOT_MBX_NVM_MAGIC                      0xBEEF
#define BOOT_MBX_NVM_FLAG_UPDATE_REQUESTED      0xF00D
#define BOOT_MBX_NVM_FLAG_UPDATE_PERFORMED      0xC0DE
#define BOOT_MBX_NVM_FLAG_UPDATE_CONFIRMED      0xFEED
#define BOOT_MBX_NVM_FLAG_FALLBACK_REQUESTED    0xB105
#define BOOT_MBX_NVM_FLAG_FALLBACK_PERFORMED    0xDEAD
#define BOOT_MBX_NVM_FLAG_FALLBACK_AVAILABLE    0x0BAC
#define BOOT_MBX_NVM_FLAG_REPAIR_PERFORMED      0xB007
 
// Bootloader mailbox maximum PSK size
#define BOOT_MBX_PSK_MAX_SIZE 32
 
// Portable packed-struct attributes (GCC/Clang/ARM-style attribute vs MSVC pragma).
#if defined(_MSC_VER)
   #define BOOT_MBX_PACK_BEGIN __pragma(pack(push, 1))
   #define BOOT_MBX_PACK_END   __pragma(pack(pop))
   #define BOOT_MBX_PACK_ATTR
#elif defined(__GNUC__) || defined(__clang__) || defined(__ARMCC_VERSION) ||                        \
   defined(__CC_ARM) || defined(__IAR_SYSTEMS_ICC__) || defined(__TASKING__)
   #define BOOT_MBX_PACK_BEGIN
   #define BOOT_MBX_PACK_END
   #define BOOT_MBX_PACK_ATTR __attribute__((packed))
#else
   #define BOOT_MBX_PACK_BEGIN
   #define BOOT_MBX_PACK_END
   #define BOOT_MBX_PACK_ATTR
#endif
 
BOOT_MBX_PACK_BEGIN
typedef struct
{
   uint32_t version;                    
   uint32_t signature;                  
   uint32_t pskSize;                    
   uint8_t psk[BOOT_MBX_PSK_MAX_SIZE];  
   uint32_t flags;                      
   uint32_t boot_counter;               
   ImageVersion fsbVersion;             
   ImageVersion ssbVersion;             
   uint8_t reserved[64];                
} BOOT_MBX_PACK_ATTR BootMailBox;
BOOT_MBX_PACK_END
 
// Portable compile-time assert (C11 _Static_assert / C++11 static_assert / a
// negative-array-size fallback for older or non-GCC C compilers).
#if defined(__cplusplus) && (__cplusplus >= 201103L)
   #define BOOT_MBX_STATIC_ASSERT(cond, msg) static_assert(cond, msg)
#elif defined(__STDC_VERSION__) && (__STDC_VERSION__ >= 201112L)
   #define BOOT_MBX_STATIC_ASSERT(cond, msg) _Static_assert(cond, msg)
#else
   #define BOOT_MBX_STATIC_ASSERT_CAT_(a, b) a ## b
   #define BOOT_MBX_STATIC_ASSERT_CAT(a, b) BOOT_MBX_STATIC_ASSERT_CAT_(a, b)
   #define BOOT_MBX_STATIC_ASSERT(cond, msg)                                                        \
           typedef char BOOT_MBX_STATIC_ASSERT_CAT(boot_mbx_static_assert_, __LINE__)[(cond) ? 1 : -1]
#endif
 
// Use the same rules as image_format.h, to add backward compatible fields to the structure
BOOT_MBX_STATIC_ASSERT(sizeof(BootMailBox) == 132, "BootMailBox RAM layout changed (must stay 132 bytes)");
BOOT_MBX_STATIC_ASSERT(offsetof(BootMailBox, version) == 0, "BootMailBox.version offset changed");
BOOT_MBX_STATIC_ASSERT(offsetof(BootMailBox, signature) == 4, "BootMailBox.signature offset changed");
BOOT_MBX_STATIC_ASSERT(offsetof(BootMailBox, pskSize) == 8, "BootMailBox.pskSize offset changed");
BOOT_MBX_STATIC_ASSERT(offsetof(BootMailBox, psk) == 12, "BootMailBox.psk offset changed");
BOOT_MBX_STATIC_ASSERT(offsetof(BootMailBox, flags) == 44, "BootMailBox.flags offset changed");
BOOT_MBX_STATIC_ASSERT(offsetof(BootMailBox, boot_counter) == 48, "BootMailBox.boot_counter offset changed");
BOOT_MBX_STATIC_ASSERT(offsetof(BootMailBox, fsbVersion) == 52, "BootMailBox.fsbVersion offset changed");
BOOT_MBX_STATIC_ASSERT(offsetof(BootMailBox, ssbVersion) == 60, "BootMailBox.ssbVersion offset changed");
BOOT_MBX_STATIC_ASSERT(offsetof(BootMailBox, reserved) == 68, "BootMailBox.reserved offset changed");
 
// C++ guard
#ifdef __cplusplus
extern "C"
{
#endif
 
// CycloneBOOT IAP Mailbox functions
cboot_error_t mailBoxInit(void);
 
bool_t mailBoxIsUpdateRequested(void);
void mailBoxSetUpdateRequested(bool_t state);
 
bool_t mailBoxIsUpdatePerformed(void);
void mailBoxSetUpdatePerformed(bool_t state);
 
bool_t mailBoxIsUpdateConfirmed(void);
void mailBoxSetUpdateConfirmed(bool_t state);
 
bool_t mailBoxIsFallbackRequested(void);
bool_t mailBoxIsFallbackPerformed(void);
void mailBoxSetFallbackRequested(bool_t state);
void mailBoxSetFallbackPerformed(bool_t state);
 
bool_t mailBoxIsFallbackAvailable(void);
void mailBoxSetFallbackAvailable(bool_t state);
 
bool_t mailBoxIsRepairPerformed(void);
void mailBoxSetRepairPerformed(bool_t state);
 
void mailBoxSetFirstStageVersion(const ImageVersion *version);
const ImageVersion *mailBoxGetFirstStageVersion(void);
void mailBoxSetSecondStageVersion(const ImageVersion *version);
const ImageVersion *mailBoxGetSecondStageVersion(void);
 
void mailBoxIncrementBootCounter(void);
uint32_t mailBoxGetBootCounter(void);
void mailBoxClearBootCounter(void);
 
void mailBoxSetPsk(const uint8_t *psk, size_t pskSize);
void mailBoxGetPsk(uint8_t *psk, size_t *pskSize);
void mailBoxClearPsk(void);
 
// Define weakly defined function to place boot flags in NVM
#if ((defined(__ARMCC_VERSION) && (__ARMCC_VERSION >= 6010050)) || defined(__GNUC__) ||            \
   defined(__CC_ARM) || defined(__IAR_SYSTEMS_ICC__) || defined(__TASKING__) ||                  \
   defined(__CWCC__) || defined(__TI_ARM__))
cboot_error_t mbx_init_nvm(void);
cboot_error_t mbx_set_nvm_flag(uint32_t flag, bool_t value);
bool_t mbx_get_nvm_flag(uint32_t flag);
#elif ((defined(_MSC_VER) || defined(_WIN32) || defined(WIN32) || defined(WIN64) ||                \
   defined(__unix__)))
extern cboot_error_t mbx_init_nvm(void);
extern cboot_error_t mbx_set_nvm_flag(uint32_t flag, bool_t value);
extern bool_t mbx_get_nvm_flag(uint32_t flag);
#endif
 
// C++ guard
#ifdef __cplusplus
}
#endif
#endif