Struct BootFlash

pub struct BootFlash<F, const BLOCK_SIZE: usize, const ERASE_VALUE: u8 = u8::MAX>
where
    F: NorFlash + ReadNorFlash,
{ /* private fields */ }

A flash wrapper implementing the Flash and embedded_storage traits.

Implementations

impl<F, const BLOCK_SIZE: usize, const ERASE_VALUE: u8> BootFlash<F, BLOCK_SIZE, ERASE_VALUE>

where F: NorFlash + ReadNorFlash,

pub fn new(flash: F) -> Self

Create a new instance of a bootable flash

Trait Implementations

impl<F, const BLOCK_SIZE: usize, const ERASE_VALUE: u8> ErrorType for BootFlash<F, BLOCK_SIZE, ERASE_VALUE>

where F: ReadNorFlash + NorFlash,

type Error = <F as ErrorType>::Error

Errors returned by this NOR flash.

impl<F, const BLOCK_SIZE: usize, const ERASE_VALUE: u8> Flash for BootFlash<F, BLOCK_SIZE, ERASE_VALUE>

where F: NorFlash + ReadNorFlash,

const BLOCK_SIZE: usize = BLOCK_SIZE

The block size that should be used when writing to flash. For most builtin flashes, this is the same as the erase size of the flash, but for external QSPI flash modules, this can be lower.

const ERASE_VALUE: u8 = ERASE_VALUE

The erase value of the flash. Typically the default of 0xFF is used, but some flashes use a different value.

impl<F, const BLOCK_SIZE: usize, const ERASE_VALUE: u8> NorFlash for BootFlash<F, BLOCK_SIZE, ERASE_VALUE>

where F: ReadNorFlash + NorFlash,

const WRITE_SIZE: usize = F::WRITE_SIZE

The minumum number of bytes the storage peripheral can write

const ERASE_SIZE: usize = F::ERASE_SIZE

The minumum number of bytes the storage peripheral can erase

fn erase(&mut self, from: u32, to: u32) -> Result<(), Self::Error>

Erase the given storage range, clearing all data within [from..to]. The given range will contain all 1s afterwards.

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

If power is lost during write, the contents of the written words are undefined, but the rest of the page is guaranteed to be unchanged. It is not allowed to write to the same word twice.

impl<F, const BLOCK_SIZE: usize, const ERASE_VALUE: u8> ReadNorFlash for BootFlash<F, BLOCK_SIZE, ERASE_VALUE>

where F: ReadNorFlash + NorFlash,

const READ_SIZE: usize = F::READ_SIZE

The minumum number of bytes the storage peripheral can read

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 peripheral in bytes.