Struct moonboot::MoonbootManager

pub struct MoonbootManager<InternalMemory: Storage, HardwareState: State, CPU: Processor, const INTERNAL_PAGE_SIZE: usize> { /* private fields */ }

Instantiate this in your application to enable mutation of the State specified in this and jump to the bootloader to apply any updates.

Implementations

impl<InternalMemory: Storage, HardwareState: State, CPU: Processor, const INTERNAL_PAGE_SIZE: usize> MoonbootManager<InternalMemory, HardwareState, CPU, INTERNAL_PAGE_SIZE>

pub fn new(
    config: Config,
    internal_memory: InternalMemory,
    state: HardwareState,
    processor: CPU
) -> MoonbootManager<InternalMemory, HardwareState, CPU, INTERNAL_PAGE_SIZE>

pub fn destroy(self) -> (InternalMemory, HardwareState, CPU)

Destroy this instance of the boot manager and return access to the hardware peripheral

pub fn mark_boot_successful(&mut self) -> Result<(), ()>

Run this immediately after booting your new image successfully to mark the boot as succesful. If you do not do this, any reset will cause the bootloader to restore to the previous firmware image.

pub fn update(&mut self) -> Result<Void, ()>

Trait Implementations

impl<InternalMemory: Storage, HardwareState: State, CPU: Processor, const INTERNAL_PAGE_SIZE: usize> AsRef<[u8]> for MoonbootManager<InternalMemory, HardwareState, CPU, INTERNAL_PAGE_SIZE>

Easily get read access to the update bank

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<InternalMemory: Storage, HardwareState: State, CPU: Processor, const INTERNAL_PAGE_SIZE: usize> ReadStorage for MoonbootManager<InternalMemory, HardwareState, CPU, INTERNAL_PAGE_SIZE>

Read Access to the current update target slot

type Error = ()

An enumeration of storage errors

fn read(&mut self, offset: u32, bytes: &mut [u8]) -> Result<(), Self::Error>

Read a slice of data from the storage peripheral, starting the read operation at the given address offset, and reading bytes.len() bytes.

fn capacity(&self) -> usize

The capacity of the storage peripheral in bytes.

impl<InternalMemory: Storage, HardwareState: State, CPU: Processor, const INTERNAL_PAGE_SIZE: usize> Storage for MoonbootManager<InternalMemory, HardwareState, CPU, INTERNAL_PAGE_SIZE>

Write Access to the current update target slot

fn write(&mut self, offset: u32, bytes: &[u8]) -> Result<(), Self::Error>

Write a slice of data to the storage peripheral, starting the write operation at the given address offset (between 0 and self.capacity()).