Struct embassy_boot::FirmwareState

pub struct FirmwareState<'d, STATE> { /* private fields */ }

Manages the state partition of the firmware update.

Can be used standalone for more fine grained control, or as part of the updater.

Implementations

impl<'d, STATE: NorFlash> FirmwareState<'d, STATE>

pub fn from_config<DFU: NorFlash>( config: FirmwareUpdaterConfig<DFU, STATE>, aligned: &'d mut [u8] ) -> Self

Create a firmware state instance from a FirmwareUpdaterConfig with a buffer for magic content and state partition.

Safety

The aligned buffer must have a size of STATE::WRITE_SIZE, and follow the alignment rules for the flash being read from and written to.

pub fn new(state: STATE, aligned: &'d mut [u8]) -> Self

Create a firmware state instance with a buffer for magic content and state partition.

Safety

The aligned buffer must have a size of maximum of STATE::WRITE_SIZE and STATE::READ_SIZE, and follow the alignment rules for the flash being read from and written to.

pub async fn get_state(&mut self) -> Result<State, FirmwareUpdaterError>

Obtain the current state.

This is useful to check if the bootloader has just done a swap, in order to do verifications and self-tests of the new image before calling mark_booted.

pub async fn mark_updated(&mut self) -> Result<(), FirmwareUpdaterError>

Mark to trigger firmware swap on next boot.

pub async fn mark_dfu(&mut self) -> Result<(), FirmwareUpdaterError>

Mark to trigger USB DFU on next boot.

pub async fn mark_booted(&mut self) -> Result<(), FirmwareUpdaterError>

Mark firmware boot successful and stop rollback on reset.