MCCI Trusted Bootloader
Simple trusted bootloader and tools for small embedded systems
Data Structures | Macros | Functions | Variables
mcci_bootloader_platform.h File Reference
#include "mcci_bootloader_platform_types.h"

Go to the source code of this file.

Data Structures

struct  McciBootloaderPlatform_AnnunciatorInterface_t
 annunciator interface structure More...
 
struct  McciBootloaderPlatform_Interface_t
 interface structure to platform functions More...
 
struct  McciBootloaderPlatform_SpiInterface_t
 SPI interface structure. More...
 
struct  McciBootloaderPlatform_StorageInterface_t
 interface for storage More...
 

Macros

#define _mcci_bootloader_platform_h_   /* prevent multiple includes */
 

Functions

static void McciBootloaderPlatform_annunciatorIndicateState (McciBootloaderState_t state)
 
static void McciBootloaderPlatform_annunciatorInit (void)
 
const McciBootloader_AppInfo_t * McciBootloaderPlatform_checkImageValid (const void *pHeader, size_t nHeader, uintptr_t targetAddress, size_t targetSize)
 
static void McciBootloaderPlatform_delayMs (uint32_t ms)
 
void McciBootloaderPlatform_entry (void)
 
void MCCI_BOOTLOADER_NORETURN_PFX McciBootloaderPlatform_fail (McciBootloaderError_t errorCode) MCCI_BOOTLOADER_NORETURN_SFX
 
const McciBootloader_AppInfo_t * McciBootloaderPlatform_getAppInfo (const void *pHeader, size_t nHeader)
 
static McciBootloaderStorageAddress_t McciBootloaderPlatform_getFallbackStorageAddress (void)
 
static McciBootloaderStorageAddress_t McciBootloaderPlatform_getPrimaryStorageAddress (void)
 
const McciBootloader_SignatureBlock_t * McciBootloaderPlatform_getSignatureBlock (const McciBootloader_AppInfo_t *)
 
static bool McciBootloaderPlatform_getUpdateFlag (void)
 
static void McciBootloaderPlatform_prepareForLaunch (void)
 
static void McciBootloaderPlatform_setUpdateFlag (bool fUpdate)
 
static void McciBootloaderPlatform_spiInit (void)
 
static void McciBootloaderPlatform_spiTransfer (uint8_t *pRx, const uint8_t *pTx, size_t nBytes, bool fContinue)
 
MCCI_BOOTLOADER_NORETURN_PFX void McciBootloaderPlatform_startApp (const void *pAppBase) MCCI_BOOTLOADER_NORETURN_SFX
 
static void McciBootloaderPlatform_storageInit (void)
 
static bool McciBootloaderPlatform_storageRead (McciBootloaderStorageAddress_t hAddress, uint8_t *pBuffer, size_t nBuffer)
 
static bool McciBootloaderPlatform_systemFlashErase (volatile const void *targetAddress, size_t targetSize)
 
static bool McciBootloaderPlatform_systemFlashWrite (volatile const void *pDestination, const void *pSource, size_t nBytes)
 
static void McciBootloaderPlatform_systemInit (void)
 

Variables

const McciBootloaderPlatform_Interface_t gk_McciBootloaderPlatformInterface
 

Macro Definition Documentation

◆ _mcci_bootloader_platform_h_

#define _mcci_bootloader_platform_h_   /* prevent multiple includes */

Definition at line 23 of file mcci_bootloader_platform.h.

Function Documentation

◆ McciBootloaderPlatform_annunciatorIndicateState()

static void McciBootloaderPlatform_annunciatorIndicateState ( McciBootloaderState_t  state)
inlinestatic

Definition at line 195 of file mcci_bootloader_platform.h.

References gk_McciBootloaderPlatformInterface.

Referenced by McciBootloader_main().

◆ McciBootloaderPlatform_annunciatorInit()

static void McciBootloaderPlatform_annunciatorInit ( void  )
inlinestatic

Definition at line 189 of file mcci_bootloader_platform.h.

References gk_McciBootloaderPlatformInterface.

Referenced by McciBootloader_main().

◆ McciBootloaderPlatform_checkImageValid()

const McciBootloader_AppInfo_t * McciBootloaderPlatform_checkImageValid ( const void *  pHeader,
size_t  nHeader,
uintptr_t  targetAddress,
size_t  targetSize 
)

Definition at line 85 of file mccibootloaderplatform_checkimagevalid.c.

References McciBootloader_CortexPageZero_t::CortexAppEntry, Mcci_CortexAppEntryContents_t::entry, g_McciBootloader_SocRamBase, g_McciBootloader_SocRamTop, McciBootloaderPlatform_getAppInfo(), and Mcci_CortexAppEntryContents_t::stack.

Referenced by McciBootloader_checkCodeValid(), and McciBootloader_checkStorageImage().

◆ McciBootloaderPlatform_delayMs()

static void McciBootloaderPlatform_delayMs ( uint32_t  ms)
inlinestatic

Definition at line 130 of file mcci_bootloader_platform.h.

References gk_McciBootloaderPlatformInterface.

Referenced by McciBootloaderFlash_Mx25v8035f_storageInit(), and storagePowerOn().

◆ McciBootloaderPlatform_entry()

void McciBootloaderPlatform_entry ( void  )

Definition at line 78 of file mccibootloaderplatform_entry.c.

References g_McciBootloader_BssBase, g_McciBootloader_BssTop, g_McciBootloader_DataBase, g_McciBootloader_DataTop, gk_McciBootloader_DataImageBase, McciBootloader_codeSize(), and McciBootloaderPlatform_systemInit().

Referenced by McciBootloader_main().

◆ McciBootloaderPlatform_fail()

void MCCI_BOOTLOADER_NORETURN_PFX McciBootloaderPlatform_fail ( McciBootloaderError_t  errorCode)

Definition at line 77 of file mccibootloaderplatform_fail.c.

References g_McciBootloader_failureCode, gk_McciBootloaderPlatformInterface, and MCCI_BOOTLOADER_NOT_REACHED.

Referenced by McciBootloader_main(), McciBootloader_Stm32L0_systemInit(), and McciBootloaderFlash_Mx25v8035f_storageInit().

◆ McciBootloaderPlatform_getAppInfo()

const McciBootloader_AppInfo_t * McciBootloaderPlatform_getAppInfo ( const void *  pHeader,
size_t  nHeader 
)

Definition at line 78 of file mccibootloaderplatform_getappinfo.c.

References McciBootloader_CortexPageZeroContents_t::AppInfo, MCCI_BOOTLOADER_APP_INFO_MAGIC, and McciBootloader_CortexPageZero_t::PageZero.

Referenced by McciBootloader_checkStorageImage(), McciBootloader_main(), and McciBootloaderPlatform_checkImageValid().

◆ McciBootloaderPlatform_getFallbackStorageAddress()

static McciBootloaderStorageAddress_t McciBootloaderPlatform_getFallbackStorageAddress ( void  )
inlinestatic

Definition at line 164 of file mcci_bootloader_platform.h.

References gk_McciBootloaderPlatformInterface.

Referenced by McciBootloader_main().

◆ McciBootloaderPlatform_getPrimaryStorageAddress()

static McciBootloaderStorageAddress_t McciBootloaderPlatform_getPrimaryStorageAddress ( void  )
inlinestatic

Definition at line 158 of file mcci_bootloader_platform.h.

References gk_McciBootloaderPlatformInterface.

Referenced by McciBootloader_main().

◆ McciBootloaderPlatform_getSignatureBlock()

const McciBootloader_SignatureBlock_t * McciBootloaderPlatform_getSignatureBlock ( const McciBootloader_AppInfo_t *  pAppInfo)

Definition at line 78 of file mccibootloaderplatform_getsignatureblock.c.

Referenced by McciBootloader_main().

◆ McciBootloaderPlatform_getUpdateFlag()

static bool McciBootloaderPlatform_getUpdateFlag ( void  )
inlinestatic

Definition at line 86 of file mcci_bootloader_platform.h.

References gk_McciBootloaderPlatformInterface.

Referenced by McciBootloader_main().

◆ McciBootloaderPlatform_prepareForLaunch()

static void McciBootloaderPlatform_prepareForLaunch ( void  )
inlinestatic

Definition at line 80 of file mcci_bootloader_platform.h.

References gk_McciBootloaderPlatformInterface.

Referenced by McciBootloaderPlatform_startApp().

◆ McciBootloaderPlatform_setUpdateFlag()

static void McciBootloaderPlatform_setUpdateFlag ( bool  fUpdate)
inlinestatic

Definition at line 92 of file mcci_bootloader_platform.h.

References gk_McciBootloaderPlatformInterface.

Referenced by McciBootloader_main().

◆ McciBootloaderPlatform_spiInit()

static void McciBootloaderPlatform_spiInit ( void  )
inlinestatic

Definition at line 170 of file mcci_bootloader_platform.h.

References gk_McciBootloaderPlatformInterface.

Referenced by McciBootloaderBoard_Catena46xx_storageInit(), and McciBootloaderBoard_Catena4801_storageInit().

◆ McciBootloaderPlatform_spiTransfer()

static void McciBootloaderPlatform_spiTransfer ( uint8_t *  pRx,
const uint8_t *  pTx,
size_t  nBytes,
bool  fContinue 
)
inlinestatic

Definition at line 176 of file mcci_bootloader_platform.h.

References gk_McciBootloaderPlatformInterface.

Referenced by McciBootloaderFlash_Mx25v8035f_storageInit(), and McciBootloaderFlash_Mx25v8035f_storageRead().

◆ McciBootloaderPlatform_startApp()

MCCI_BOOTLOADER_NORETURN_PFX void McciBootloaderPlatform_startApp ( const void *  pAppBase)

Definition at line 88 of file mccibootloaderplatform_startapp.c.

References Mcci_CortexAppEntryContents_t::entry, MCCI_CM0PLUS_SCB_VTOR, MCCI_CM0PLUS_SCB_VTOR_TBLOFF, McciArm_putReg(), McciBootloaderPlatform_prepareForLaunch(), and Mcci_CortexAppEntryContents_t::stack.

Referenced by McciBootloader_main().

◆ McciBootloaderPlatform_storageInit()

static void McciBootloaderPlatform_storageInit ( void  )
inlinestatic

Definition at line 138 of file mcci_bootloader_platform.h.

References gk_McciBootloaderPlatformInterface.

Referenced by McciBootloader_main().

◆ McciBootloaderPlatform_storageRead()

static bool McciBootloaderPlatform_storageRead ( McciBootloaderStorageAddress_t  hAddress,
uint8_t *  pBuffer,
size_t  nBuffer 
)
inlinestatic

Definition at line 144 of file mcci_bootloader_platform.h.

References gk_McciBootloaderPlatformInterface.

Referenced by McciBootloader_checkStorageImage(), and McciBootloader_programAndCheckFlash().

◆ McciBootloaderPlatform_systemFlashErase()

static bool McciBootloaderPlatform_systemFlashErase ( volatile const void *  targetAddress,
size_t  targetSize 
)
inlinestatic

Definition at line 98 of file mcci_bootloader_platform.h.

References gk_McciBootloaderPlatformInterface.

Referenced by McciBootloader_programAndCheckFlash().

◆ McciBootloaderPlatform_systemFlashWrite()

static bool McciBootloaderPlatform_systemFlashWrite ( volatile const void *  pDestination,
const void *  pSource,
size_t  nBytes 
)
inlinestatic

Definition at line 110 of file mcci_bootloader_platform.h.

References gk_McciBootloaderPlatformInterface.

Referenced by McciBootloader_programAndCheckFlash().

◆ McciBootloaderPlatform_systemInit()

static void McciBootloaderPlatform_systemInit ( void  )
inlinestatic

Definition at line 74 of file mcci_bootloader_platform.h.

References gk_McciBootloaderPlatformInterface.

Referenced by McciBootloaderPlatform_entry().

Variable Documentation

◆ gk_McciBootloaderPlatformInterface

const McciBootloaderPlatform_Interface_t gk_McciBootloaderPlatformInterface
extern

Definition at line 41 of file mccibootloaderboard_catena46xx_platforminterface.c.

Referenced by McciBootloaderPlatform_annunciatorIndicateState(), McciBootloaderPlatform_annunciatorInit(), McciBootloaderPlatform_delayMs(), McciBootloaderPlatform_fail(), McciBootloaderPlatform_getFallbackStorageAddress(), McciBootloaderPlatform_getPrimaryStorageAddress(), McciBootloaderPlatform_getUpdateFlag(), McciBootloaderPlatform_prepareForLaunch(), McciBootloaderPlatform_setUpdateFlag(), McciBootloaderPlatform_spiInit(), McciBootloaderPlatform_spiTransfer(), McciBootloaderPlatform_storageInit(), McciBootloaderPlatform_storageRead(), McciBootloaderPlatform_systemFlashErase(), McciBootloaderPlatform_systemFlashWrite(), and McciBootloaderPlatform_systemInit().