Struct Flash

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

Internal flash memory driver.

Implementations

impl<'d> Flash<'d, Async>

pub fn new( p: impl Peripheral<P = FLASH> + 'd, _irq: impl Binding<FLASH, InterruptHandler> + 'd, ) -> Self

Create a new flash driver with async capabilities.

pub fn into_regions(self) -> FlashLayout<'d, Async>

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

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

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

Async 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 async fn erase(&mut self, from: u32, to: u32) -> Result<(), Error>

Async 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 new_blocking(p: impl Peripheral<P = FLASH> + 'd) -> 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>

pub fn into_alt_regions(self) -> AltFlashLayout<'d, Async>

pub fn into_alt_blocking_regions(self) -> AltFlashLayout<'d, Blocking>

Trait Implementations

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

type Error = Error

Errors returned by this NOR flash.

impl NorFlash for Flash<'_, Async>

const WRITE_SIZE: usize = 4usize

The minumum number of bytes the storage peripheral can write

const ERASE_SIZE: usize = 131_072usize

The minumum number of bytes the storage peripheral can erase

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.

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.

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 = 131_072usize

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 Flash<'_, Async>

const READ_SIZE: usize = 1usize

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