Struct Flash

pub struct Flash<'d, T: Instance, M: Mode, const FLASH_SIZE: usize> { /* private fields */ }

Flash driver.

Implementations

impl<'d, T: Instance, M: Mode, const FLASH_SIZE: usize> Flash<'d, T, M, FLASH_SIZE>

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

Blocking read.

The offset and buffer must be aligned.

NOTE: offset is an offset from the flash start, NOT an absolute address.

pub fn capacity(&self) -> usize

Flash capacity.

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

Blocking erase.

NOTE: offset is an offset from the flash start, NOT an absolute address.

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

Blocking write.

The offset and buffer must be aligned.

NOTE: offset is an offset from the flash start, NOT an absolute address.

pub fn blocking_unique_id(&mut self, uid: &mut [u8]) -> Result<(), Error>

Read SPI flash unique ID

pub fn blocking_jedec_id(&mut self) -> Result<u32, Error>

Read SPI flash JEDEC ID

impl<'d, T: Instance, const FLASH_SIZE: usize> Flash<'d, T, Blocking, FLASH_SIZE>

pub fn new_blocking(_flash: impl Peripheral<P = T> + 'd) -> Self

Create a new flash driver in blocking mode.

impl<'d, T: Instance, const FLASH_SIZE: usize> Flash<'d, T, Async, FLASH_SIZE>

pub fn new( _flash: impl Peripheral<P = T> + 'd, dma: impl Peripheral<P = impl Channel> + 'd, ) -> Self

Create a new flash driver in async mode.

pub fn background_read<'a>( &'a mut self, offset: u32, data: &'a mut [u32], ) -> Result<BackgroundRead<'a, 'd, T, FLASH_SIZE>, Error>

Start a background read operation.

The offset and buffer must be aligned.

NOTE: offset is an offset from the flash start, NOT an absolute address.

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

Async read.

The offset and buffer must be aligned.

NOTE: offset is an offset from the flash start, NOT an absolute address.

Trait Implementations

impl<'d, T: Instance, M: Mode, const FLASH_SIZE: usize> ErrorType for Flash<'d, T, M, FLASH_SIZE>

type Error = Error

Errors returned by this NOR flash.

impl<'d, T: Instance, const FLASH_SIZE: usize> NorFlash for Flash<'d, T, Async, FLASH_SIZE>

const WRITE_SIZE: usize = 1usize

The minumum number of bytes the storage peripheral can write

const ERASE_SIZE: usize = 4_096usize

The minumum number of bytes the storage peripheral can erase

async 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.

async 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<'d, T: Instance, M: Mode, const FLASH_SIZE: usize> NorFlash for Flash<'d, T, M, FLASH_SIZE>

const WRITE_SIZE: usize = 1usize

The minumum number of bytes the storage peripheral can write

const ERASE_SIZE: usize = 4_096usize

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<'d, T: Instance, const FLASH_SIZE: usize> ReadNorFlash for Flash<'d, T, Async, FLASH_SIZE>

const READ_SIZE: usize = 4usize

The minumum number of bytes the storage peripheral can read

async 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<'d, T: Instance, M: Mode, const FLASH_SIZE: usize> ReadNorFlash for Flash<'d, T, M, FLASH_SIZE>

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.

impl<'d, T: Instance, const FLASH_SIZE: usize> MultiwriteNorFlash for Flash<'d, T, Async, FLASH_SIZE>

impl<'d, T: Instance, M: Mode, const FLASH_SIZE: usize> MultiwriteNorFlash for Flash<'d, T, M, FLASH_SIZE>