Struct FlashStorage 

pub struct FlashStorage<'d> { /* private fields */ }

Flash storage abstraction.

This only implements traits from embedded_storage. If you need to use this struct where traits from embedded_storage_async are needed, you can use embassy_embedded_hal::adapter::BlockingAsync or embassy_embedded_hal::adapter::YieldingAsync wrappers.

Implementations

impl<'d> FlashStorage<'d>

pub const WORD_SIZE: u32 = 4

Flash word size in bytes.

pub const SECTOR_SIZE: u32 = 4096

Flash sector size in bytes.

pub const BLOCK_SIZE: u32 = 65536

Flash block size in bytes.

pub fn new(flash: Flash<'d>) -> Self

Create a new flash storage instance.

Panics

Panics if called more than once.

impl<'d> FlashStorage<'d>

pub fn multicore_auto_park(self) -> FlashStorage<'d>

Enable auto parking of the second core before writing to flash. The other core will be automatically un-parked when the write is complete.

pub unsafe fn multicore_ignore(self) -> FlashStorage<'d>

Do not check if the second core is active before writing to flash.

Safety

Only enable this if you are sure that the second core is not fetching instructions from the flash during the write.

Trait Implementations

impl<'d> Debug for FlashStorage<'d>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl ErrorType for FlashStorage<'_>

type Error = FlashStorageError

Errors returned by this NOR flash.

impl NorFlash for FlashStorage<'_>

const WRITE_SIZE: usize

The minumum number of bytes the storage peripheral can write

const ERASE_SIZE: usize

The minumum number of bytes the storage peripheral can erase

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.

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.

impl ReadNorFlash for FlashStorage<'_>

const READ_SIZE: usize

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.

impl ReadStorage for FlashStorage<'_>

fn capacity(&self) -> usize

The SPI flash size is configured by writing a field in the software bootloader image header. This is done during flashing in espflash / esptool.

type Error = FlashStorageError

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.

impl Storage for FlashStorage<'_>

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()).

impl MultiwriteNorFlash for FlashStorage<'_>