embassy-boot

Crates

git

Versions

default

Flavors

embassy_boot

Struct FirmwareState

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

Manages the state partition of the firmware update.

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

Implementations§

source§

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

source

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.

source

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.

source

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.

source

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

Mark to trigger firmware swap on next boot.

source

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

Mark to trigger USB DFU on next boot.

source

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

Mark firmware boot successful and stop rollback on reset.

Auto Trait Implementations§

§

impl<'d, STATE> Freeze for FirmwareState<'d, STATE>
where STATE: Freeze,

§

impl<'d, STATE> RefUnwindSafe for FirmwareState<'d, STATE>
where STATE: RefUnwindSafe,

§

impl<'d, STATE> Send for FirmwareState<'d, STATE>
where STATE: Send,

§

impl<'d, STATE> Sync for FirmwareState<'d, STATE>
where STATE: Sync,

§

impl<'d, STATE> Unpin for FirmwareState<'d, STATE>
where STATE: Unpin,

§

impl<'d, STATE> !UnwindSafe for FirmwareState<'d, STATE>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

source§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.