boot.h

Go to the documentation of this file.

 
#ifndef _STANDALONE_BOOT_H
#define _STANDALONE_BOOT_H
 
// Dependencies
#include "boot_config.h"
#include "core/cboot_error.h"
#include "core/verify.h"
#include "modules/memory/memory.h"
#include "os_port.h"
#include "update/update_transport.h"
#include "standalone/boot_recovery.h"
#include "standalone/boot_trigger.h"
#include "update/update.h"
 
// Runtime signature check before boot
#ifndef BOOT_RUNTIME_SIGNATURE_CHECK_SUPPORT
#define BOOT_RUNTIME_SIGNATURE_CHECK_SUPPORT DISABLED
#elif ((BOOT_RUNTIME_SIGNATURE_CHECK_SUPPORT != ENABLED) &&                                          \
   (BOOT_RUNTIME_SIGNATURE_CHECK_SUPPORT != DISABLED))
#error BOOT_RUNTIME_SIGNATURE_CHECK_SUPPORT parameter is not valid
#endif
 
#if (BOOT_RUNTIME_SIGNATURE_CHECK_SUPPORT == ENABLED)
#if (BOOT_RUNTIME_SIGNATURE_ECDSA != ENABLED) && (BOOT_RUNTIME_SIGNATURE_RSA != ENABLED)
#error BOOT_RUNTIME_SIGNATURE_CHECK_SUPPORT is ENABLED but no signature algorithm is selected
#endif
#endif
 
// Runtime integrity check before boot
#ifndef BOOT_RUNTIME_INTEGRITY_CHECK_SUPPORT
#define BOOT_RUNTIME_INTEGRITY_CHECK_SUPPORT DISABLED
#elif ((BOOT_RUNTIME_INTEGRITY_CHECK_SUPPORT != ENABLED) &&                                          \
   (BOOT_RUNTIME_INTEGRITY_CHECK_SUPPORT != DISABLED))
#error BOOT_RUNTIME_INTEGRITY_CHECK_SUPPORT parameter is not valid
#endif
 
#if (BOOT_RUNTIME_INTEGRITY_CHECK_SUPPORT == ENABLED) &&                                            \
   (BOOT_RUNTIME_SIGNATURE_CHECK_SUPPORT == ENABLED)
#error Enable at most one of BOOT_RUNTIME_INTEGRITY_CHECK_SUPPORT and BOOT_RUNTIME_SIGNATURE_CHECK_SUPPORT
#endif
 
// Update entry triggers
#ifndef BOOT_TRIGGER_MAILBOX
#define BOOT_TRIGGER_MAILBOX DISABLED
#endif
#ifndef BOOT_TRIGGER_WINDOW
#define BOOT_TRIGGER_WINDOW DISABLED
#endif
#ifndef BOOT_TRIGGER_GPIO
#define BOOT_TRIGGER_GPIO ENABLED
#endif
#ifndef BOOT_TRIGGER_NO_APP
#define BOOT_TRIGGER_NO_APP DISABLED
#endif
#ifndef BOOT_TRIGGER_RESET_CAUSE
#define BOOT_TRIGGER_RESET_CAUSE DISABLED
#endif
 
#if (BOOT_TRIGGER_MAILBOX == DISABLED) && (BOOT_TRIGGER_WINDOW == DISABLED) &&         \
   (BOOT_TRIGGER_GPIO == DISABLED) && (BOOT_TRIGGER_NO_APP == DISABLED) &&             \
   (BOOT_TRIGGER_RESET_CAUSE == DISABLED)
#error at least one BOOT_TRIGGER_XXX must be ENABLED
#endif
 
#ifndef BOOT_TRIGGER_WINDOW_MS
#define BOOT_TRIGGER_WINDOW_MS 10000
#elif (BOOT_TRIGGER_WINDOW_MS <= 0)
#error BOOT_TRIGGER_WINDOW_MS must be greater than 0
#endif
 
// Transport receive buffer size
#ifndef BOOT_RECV_BUFFER_SIZE
#define BOOT_RECV_BUFFER_SIZE 512
#elif (BOOT_RECV_BUFFER_SIZE < 64)
#error BOOT_RECV_BUFFER_SIZE must be at least 64
#endif
 
// Enable recovery support
#ifndef BOOT_RECOVERY_SUPPORT
#define BOOT_RECOVERY_SUPPORT DISABLED
#elif ((BOOT_RECOVERY_SUPPORT != ENABLED) && (BOOT_RECOVERY_SUPPORT != DISABLED))
#error BOOT_RECOVERY_SUPPORT parameter is not valid
#endif
 
#ifndef BOOT_RECOVERY_AUTO_MODE
#define BOOT_RECOVERY_AUTO_MODE DISABLED
#elif ((BOOT_RECOVERY_AUTO_MODE != ENABLED) && (BOOT_RECOVERY_AUTO_MODE != DISABLED))
#error BOOT_RECOVERY_AUTO_MODE parameter is not valid
#endif
 
#ifndef BOOT_RECOVERY_MANUAL_MODE
#define BOOT_RECOVERY_MANUAL_MODE DISABLED
#elif ((BOOT_RECOVERY_MANUAL_MODE != ENABLED) && (BOOT_RECOVERY_MANUAL_MODE != DISABLED))
#error BOOT_RECOVERY_MANUAL_MODE parameter is not valid
#endif
 
#if ((BOOT_RECOVERY_SUPPORT == DISABLED) &&                                                 \
   (BOOT_RECOVERY_AUTO_MODE == ENABLED || BOOT_RECOVERY_MANUAL_MODE == ENABLED))
#error BOOT_RECOVERY_SUPPORT is DISABLED while BOOT_RECOVERY_XXX_MODE is ENABLED
#endif
 
#ifndef BOOT_COUNTER_SUPPORT
#define BOOT_COUNTER_SUPPORT DISABLED
#elif ((BOOT_COUNTER_SUPPORT != ENABLED) && (BOOT_COUNTER_SUPPORT != DISABLED))
#error BOOT_COUNTER_SUPPORT parameter is not valid
#endif
 
#ifndef BOOT_COUNTER_MAX_ATTEMPTS
#define BOOT_COUNTER_MAX_ATTEMPTS 3
#elif (BOOT_COUNTER_MAX_ATTEMPTS <= 0)
#error BOOT_COUNTER_MAX_ATTEMPTS must be greater than 0
#endif
 
#ifndef BOOT_FLAG_SUPPORT
#define BOOT_FLAG_SUPPORT DISABLED
#elif ((BOOT_FLAG_SUPPORT != ENABLED) && (BOOT_FLAG_SUPPORT != DISABLED))
#error BOOT_FLAG_SUPPORT parameter is not valid
#endif
 
#if (BOOT_RECOVERY_AUTO_MODE == ENABLED)
#if (BOOT_FLAG_SUPPORT == DISABLED && BOOT_COUNTER_SUPPORT == DISABLED)
#error when BOOT_RECOVERY_AUTO_MODE is ENABLED, also ENABLE BOOT_FLAG_SUPPORT and/or BOOT_COUNTER_SUPPORT
#endif
#if (BOOT_COUNTER_SUPPORT == ENABLED && BOOT_COUNTER_MAX_ATTEMPTS <= 0)
#error invalid counter value (should be > 0)
#endif
#endif
 
#if (BOOT_RECOVERY_AUTO_MODE == DISABLED)
#if (BOOT_COUNTER_SUPPORT == ENABLED || BOOT_FLAG_SUPPORT == ENABLED)
#error BOOT_RECOVERY_AUTO_MODE is DISABLED while BOOT_XXX_SUPPORT is ENABLED
#endif
#endif
 
#if (BOOT_RECOVERY_SUPPORT == ENABLED)
#if (BOOT_RECOVERY_AUTO_MODE == DISABLED && BOOT_RECOVERY_MANUAL_MODE == DISABLED)
#error BOOT_RECOVERY_SUPPORT is ENABLED while BOOT_RECOVERY_XXX_MODE is DISABLED
#endif
#endif
 
#ifndef BOOT_FACTORY_SLOT_SUPPORT
#define BOOT_FACTORY_SLOT_SUPPORT DISABLED
#elif ((BOOT_FACTORY_SLOT_SUPPORT != ENABLED) &&                                             \
   (BOOT_FACTORY_SLOT_SUPPORT != DISABLED))
#error BOOT_FACTORY_SLOT_SUPPORT parameter is not valid
#endif
 
// C++ guard
#ifdef __cplusplus
extern "C"
{
#endif
 
typedef enum
{
   BOOT_STATE_INIT = 0,
   BOOT_STATE_TRIGGER,
   BOOT_STATE_CHECK_RESIDENT,
   BOOT_STATE_LISTEN,
   BOOT_STATE_RECV,
   BOOT_STATE_INSTALL,
   BOOT_STATE_RECOVER,
   BOOT_STATE_BOOT,
   BOOT_STATE_RESET,
   BOOT_STATE_ERROR
} BootState;
 
typedef struct
{
   const UpdateTransport *transport;   
#if (BOOT_RUNTIME_SIGNATURE_CHECK_SUPPORT == ENABLED)
   VerifySettings verifySettings;          
#endif
   UpdateSettings update;                  
} BootSettings;
 
typedef struct
{
   BootState state;         
   BootSettings settings;   
   bool_t busy;
   UpdateContext updateContext;   
   Slot *appSlot;                 
#if (BOOT_FACTORY_SLOT_SUPPORT == ENABLED)
   Slot *factorySlot;             
#endif
   UpdateEntryRequest entry;      
   systime_t windowStart;         
   RecoveryReason recoveryReason; 
} BootContext;
 
// Bootloader related functions
void bootGetDefaultSettings(BootSettings *settings);
cboot_error_t bootInit(BootContext *context, BootSettings *settings);
cboot_error_t bootFsm(BootContext *context);
 
cboot_error_t bootCheckResidentImage(const Slot *slot);
 
#if ((defined(__ARMCC_VERSION) && (__ARMCC_VERSION >= 6010050)) || defined(__GNUC__) ||            \
   defined(__CC_ARM) || defined(__IAR_SYSTEMS_ICC__) || defined(__TASKING__) ||                  \
   defined(__CWCC__) || defined(__TI_ARM__))
void bootApplicationUpdatedHook(void);
void bootJumpingToApplicationHook(void);
#elif ((defined(_MSC_VER) || defined(_WIN32) || defined(WIN32) || defined(WIN64) ||                \
   defined(__unix__)))
extern void bootApplicationUpdatedHook(void);
extern void bootJumpingToApplicationHook(void);
#endif
 
// C++ guard
#ifdef __cplusplus
}
#endif
#endif //_STANDALONE_BOOT_H