MCCI Trusted Bootloader
Simple trusted bootloader and tools for small embedded systems
mcci_bootloader_board_catena_abz.h File Reference

Go to the source code of this file.

Macros

#define _mcci_bootloader_board_catena_abz_h_   /* prevent multiple includes */
 
#define MCCI_BOOTLOADER_BOARD_CATENA_ABZ_STORAGE_FALLBACK_BASE    (UINT32_C(65536))
 we put the fallback image at 64k to 232k, in case anyone needs special things in page zero.
 
#define MCCI_BOOTLOADER_BOARD_CATENA_ABZ_STORAGE_IMAGE_SIZE    (UINT32_C(168) * 1024)
 the maximum image size is 168k bytes (192k - 20k for the bootloader and 4k for the mfg page).
 
#define MCCI_BOOTLOADER_BOARD_CATENA_ABZ_STORAGE_UPDATE_BASE    (UINT32_C(256) * 1024)
 base address of the update image
 

Functions

void McciBootloaderBoard_CatenaAbz_clearLed (void)
 
McciBootloaderBoard_CatenaAbz_Eeprom_t * McciBootloaderBoard_CatenaAbz_getEepromPointer (void)
 
void McciBootloaderBoard_CatenaAbz_handleSysTick (void)
 
void McciBootloaderBoard_CatenaAbz_setLed (void)
 

Variables

McciBootloaderPlatform_FailFn_t MCCI_BOOTLOADER_NORETURN_PFX McciBootloaderBoard_CatenaAbz_fail MCCI_BOOTLOADER_NORETURN_SFX
 
McciBootloaderPlatform_AnnunciatorIndicateStateFn_t McciBootloaderBoard_CatenaAbz_annunciatorIndicateState
 
McciBootloaderPlatform_AnnunciatorInitFn_t McciBootloaderBoard_CatenaAbz_annunciatorInit
 
McciBootloaderPlatform_DelayMsFn_t McciBootloaderBoard_CatenaAbz_delayMs
 
McciBootloaderPlatform_GetFallbackStorageAddressFn_t McciBootloaderBoard_CatenaAbz_getFallbackStorageAddress
 
McciBootloaderPlatform_GetPrimaryStorageAddressFn_t McciBootloaderBoard_CatenaAbz_getPrimaryStorageAddress
 
McciBootloaderPlatform_GetUpdateFlagFn_t McciBootloaderBoard_CatenaAbz_getUpdate
 
McciBootloaderPlatform_PrepareForLaunchFn_t McciBootloaderBoard_CatenaAbz_prepareForLaunch
 
McciBootloaderPlatform_SetUpdateFlagFn_t McciBootloaderBoard_CatenaAbz_setUpdate
 
McciBootloaderPlatform_SpiInitFn_t McciBootloaderBoard_CatenaAbz_spiInit
 
McciBootloaderPlatform_SpiTransferFn_t McciBootloaderBoard_CatenaAbz_spiTransfer
 
McciBootloaderPlatform_StorageReadFn_t McciBootloaderBoard_CatenaAbz_storageRead
 
McciBootloaderPlatform_SystemInitFn_t McciBootloaderBoard_CatenaAbz_systemInit
 

Macro Definition Documentation

◆ _mcci_bootloader_board_catena_abz_h_

#define _mcci_bootloader_board_catena_abz_h_   /* prevent multiple includes */

Definition at line 24 of file mcci_bootloader_board_catena_abz.h.

◆ MCCI_BOOTLOADER_BOARD_CATENA_ABZ_STORAGE_FALLBACK_BASE

#define MCCI_BOOTLOADER_BOARD_CATENA_ABZ_STORAGE_FALLBACK_BASE    (UINT32_C(65536))

we put the fallback image at 64k to 232k, in case anyone needs special things in page zero.

This also lets you set the WP bit, clear the TP bit, and set BP bits to 0x03; this will protect the first 256k against accidental change.

Definition at line 61 of file mcci_bootloader_board_catena_abz.h.

◆ MCCI_BOOTLOADER_BOARD_CATENA_ABZ_STORAGE_IMAGE_SIZE

#define MCCI_BOOTLOADER_BOARD_CATENA_ABZ_STORAGE_IMAGE_SIZE    (UINT32_C(168) * 1024)

the maximum image size is 168k bytes (192k - 20k for the bootloader and 4k for the mfg page).

Definition at line 54 of file mcci_bootloader_board_catena_abz.h.

◆ MCCI_BOOTLOADER_BOARD_CATENA_ABZ_STORAGE_UPDATE_BASE

#define MCCI_BOOTLOADER_BOARD_CATENA_ABZ_STORAGE_UPDATE_BASE    (UINT32_C(256) * 1024)

base address of the update image

The update block begins at a multiple of 64k to allow use of 64k erase if desired. We put it at 256k so we can easily write-protect the fallback image if needed.

Definition at line 71 of file mcci_bootloader_board_catena_abz.h.

Function Documentation

◆ McciBootloaderBoard_CatenaAbz_clearLed()

void McciBootloaderBoard_CatenaAbz_clearLed ( void  )

◆ McciBootloaderBoard_CatenaAbz_getEepromPointer()

McciBootloaderBoard_CatenaAbz_Eeprom_t * McciBootloaderBoard_CatenaAbz_getEepromPointer ( void  )

◆ McciBootloaderBoard_CatenaAbz_handleSysTick()

void McciBootloaderBoard_CatenaAbz_handleSysTick ( void  )

◆ McciBootloaderBoard_CatenaAbz_setLed()

void McciBootloaderBoard_CatenaAbz_setLed ( void  )

Variable Documentation

◆ MCCI_BOOTLOADER_NORETURN_SFX

◆ McciBootloaderBoard_CatenaAbz_annunciatorIndicateState

McciBootloaderPlatform_AnnunciatorIndicateStateFn_t McciBootloaderBoard_CatenaAbz_annunciatorIndicateState

◆ McciBootloaderBoard_CatenaAbz_annunciatorInit

McciBootloaderPlatform_AnnunciatorInitFn_t McciBootloaderBoard_CatenaAbz_annunciatorInit ( void  )

Definition at line 115 of file mcci_bootloader_board_catena_abz.h.

◆ McciBootloaderBoard_CatenaAbz_delayMs

McciBootloaderPlatform_DelayMsFn_t McciBootloaderBoard_CatenaAbz_delayMs

Definition at line 91 of file mcci_bootloader_board_catena_abz.h.

◆ McciBootloaderBoard_CatenaAbz_getFallbackStorageAddress

McciBootloaderPlatform_GetFallbackStorageAddressFn_t McciBootloaderBoard_CatenaAbz_getFallbackStorageAddress ( void  )

Definition at line 106 of file mcci_bootloader_board_catena_abz.h.

◆ McciBootloaderBoard_CatenaAbz_getPrimaryStorageAddress

McciBootloaderPlatform_GetPrimaryStorageAddressFn_t McciBootloaderBoard_CatenaAbz_getPrimaryStorageAddress ( void  )

Definition at line 103 of file mcci_bootloader_board_catena_abz.h.

◆ McciBootloaderBoard_CatenaAbz_getUpdate

McciBootloaderPlatform_GetUpdateFlagFn_t McciBootloaderBoard_CatenaAbz_getUpdate ( void  )

Definition at line 94 of file mcci_bootloader_board_catena_abz.h.

◆ McciBootloaderBoard_CatenaAbz_prepareForLaunch

McciBootloaderPlatform_PrepareForLaunchFn_t McciBootloaderBoard_CatenaAbz_prepareForLaunch ( void  )

Definition at line 84 of file mcci_bootloader_board_catena_abz.h.

◆ McciBootloaderBoard_CatenaAbz_setUpdate

McciBootloaderPlatform_SetUpdateFlagFn_t McciBootloaderBoard_CatenaAbz_setUpdate

Definition at line 97 of file mcci_bootloader_board_catena_abz.h.

◆ McciBootloaderBoard_CatenaAbz_spiInit

McciBootloaderPlatform_SpiInitFn_t McciBootloaderBoard_CatenaAbz_spiInit ( void  )

Definition at line 109 of file mcci_bootloader_board_catena_abz.h.

◆ McciBootloaderBoard_CatenaAbz_spiTransfer

McciBootloaderPlatform_SpiTransferFn_t McciBootloaderBoard_CatenaAbz_spiTransfer

Definition at line 112 of file mcci_bootloader_board_catena_abz.h.

◆ McciBootloaderBoard_CatenaAbz_storageRead

McciBootloaderPlatform_StorageReadFn_t McciBootloaderBoard_CatenaAbz_storageRead

Definition at line 100 of file mcci_bootloader_board_catena_abz.h.

◆ McciBootloaderBoard_CatenaAbz_systemInit

McciBootloaderPlatform_SystemInitFn_t McciBootloaderBoard_CatenaAbz_systemInit

Definition at line 81 of file mcci_bootloader_board_catena_abz.h.