Struct Flash

pub struct Flash<'d, MODE = Async> { /* private fields */ }

Internal flash memory driver.

Implementations

impl<'d> Flash<'d, Blocking>

pub fn new_blocking(p: Peri<'d, FLASH>) -> Self

Create a new flash driver, usable in blocking mode.

impl<'d, MODE> Flash<'d, MODE>

pub fn into_blocking_regions(self) -> FlashLayout<'d, Blocking>

Split this flash driver into one instance per flash memory region.

See module-level documentation for details on how memory regions work.

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

Blocking read.

NOTE: offset is an offset from the flash start, NOT an absolute address. For example, to read address 0x0800_1234 you have to use offset 0x1234.

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

Blocking write.

NOTE: offset is an offset from the flash start, NOT an absolute address. For example, to write address 0x0800_1234 you have to use offset 0x1234.

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

Blocking erase.

NOTE: from and to are offsets from the flash start, NOT an absolute address. For example, to erase address 0x0801_0000 you have to use offset 0x1_0000.

impl<'d> Flash<'d, Blocking>

pub fn eeprom_write_u8(&mut self, offset: u32, value: u8) -> Result<(), Error>

Writes a single byte to EEPROM at the given offset.

pub fn eeprom_write_u16(&mut self, offset: u32, value: u16) -> Result<(), Error>

Writes a single 16-bit value to EEPROM at the given offset.

Returns an error if the offset is not 2-byte aligned.

pub fn eeprom_write_u32(&mut self, offset: u32, value: u32) -> Result<(), Error>

Writes a single 32-bit value to EEPROM at the given offset.

Returns an error if the offset is not 4-byte aligned.

pub fn eeprom_write_u8_slice( &mut self, offset: u32, data: &[u8], ) -> Result<(), Error>

Writes a slice of bytes to EEPROM at the given offset.

pub fn eeprom_write_u16_slice( &mut self, offset: u32, data: &[u16], ) -> Result<(), Error>

Writes a slice of 16-bit values to EEPROM at the given offset.

Returns an error if the offset is not 2-byte aligned.

pub fn eeprom_write_u32_slice( &mut self, offset: u32, data: &[u32], ) -> Result<(), Error>

Writes a slice of 32-bit values to EEPROM at the given offset.

Returns an error if the offset is not 4-byte aligned.

pub fn eeprom_write_slice( &mut self, offset: u32, data: &[u8], ) -> Result<(), Error>

Writes a byte slice to EEPROM at the given offset, handling alignment.

This method will write unaligned prefix and suffix as bytes, and aligned middle as u32.

pub fn eeprom_read_u8(&self, offset: u32) -> Result<u8, Error>

Reads a single byte from EEPROM at the given offset.

pub fn eeprom_read_u16(&self, offset: u32) -> Result<u16, Error>

Reads a single 16-bit value from EEPROM at the given offset.

Returns an error if the offset is not 2-byte aligned.

pub fn eeprom_read_u32(&self, offset: u32) -> Result<u32, Error>

Reads a single 32-bit value from EEPROM at the given offset.

Returns an error if the offset is not 4-byte aligned.

pub fn eeprom_read_slice( &self, offset: u32, buf: &mut [u8], ) -> Result<(), Error>

Reads a slice of bytes from EEPROM at the given offset into the provided buffer.

Trait Implementations

impl<MODE> ErrorType for Flash<'_, MODE>

type Error = Error

Errors returned by this NOR flash.

impl<MODE> NorFlash for Flash<'_, MODE>

const WRITE_SIZE: usize = 4usize

The minumum number of bytes the storage peripheral can write

const ERASE_SIZE: usize = 256usize

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<MODE> ReadNorFlash for Flash<'_, MODE>

const READ_SIZE: usize = 1usize

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.