Struct Sqspi 

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

sQSPI flash driver.

Implementations

impl<'d> Sqspi<'d>

pub fn new<T: Instance>( peri: Peri<'d, T>, _irq: impl Binding<T::Interrupt, InterruptHandler<T>> + 'd, firmware: &[u8], ram: &'d mut [MaybeUninit<u8>], sck: Peri<'d, impl GpioPin>, csn: Peri<'d, impl GpioPin>, io0: Peri<'d, impl GpioPin>, io1: Peri<'d, impl GpioPin>, io2: Peri<'d, impl GpioPin>, io3: Peri<'d, impl GpioPin>, config: Config, ) -> Result<Self, Error>

Create a new sQSPI driver.

Loads firmware into ram, boots the FLPR, routes the pins to it, and configures the SPI core per config. See the module docs for the firmware / ram requirements.

pub async fn custom_instruction( &mut self, opcode: u8, req: &[u8], resp: &mut [u8], ) -> Result<(), Error>

Do a custom SPI instruction (single line).

Like the hardware qspi driver this issues WREN before the opcode and waits for WIP to clear afterwards, so state-changing commands (WRSR, …) work without extra orchestration. If resp is non-empty the command reads into it; otherwise req is transmitted.

pub fn blocking_custom_instruction( &mut self, opcode: u8, req: &[u8], resp: &mut [u8], ) -> Result<(), Error>

Do a custom SPI instruction, blocking version.

pub fn blocking_custom_opcode(&mut self, opcode: u8) -> Result<(), Error>

Send a single bare opcode (no address, no data) on a single line, without issuing WREN first or polling WIP afterwards.

Unlike custom_instruction this does not touch the status register, which is what makes it usable for power-state commands such as deep power-down (0xB9): once the flash is in DPD it stops answering RDSR, so the usual trailing WIP poll would hang forever.

pub async fn read_raw( &mut self, address: u32, data: &mut [u8], ) -> Result<(), Error>

Raw read: no bounds check against the configured capacity.

pub async fn write_raw( &mut self, address: u32, data: &[u8], ) -> Result<(), Error>

Raw write: no bounds check against the configured capacity.

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

Raw read, blocking version.

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

Raw write, blocking version.

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

Read from flash, bounds-checked against the configured capacity.

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

Write to flash, bounds-checked against the configured capacity.

pub async fn erase(&mut self, address: u32) -> Result<(), Error>

Erase a 4 KiB sector (opcode 0x20).

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

Read from flash, blocking + bounds-checked.

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

Write to flash, blocking + bounds-checked.

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

Erase a 4 KiB sector, blocking version.

Trait Implementations

impl<'d> Drop for Sqspi<'d>

fn drop(&mut self)

Executes the destructor for this type.

impl<'d> ErrorType for Sqspi<'d>

type Error = Error

Errors returned by this NOR flash.

impl<'d> NorFlash for Sqspi<'d>

const WRITE_SIZE: usize = 4usize

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> NorFlash for Sqspi<'d>

const WRITE_SIZE: usize = 4usize

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 write(&mut self, offset: u32, data: &[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<'d> ReadNorFlash for Sqspi<'d>

const READ_SIZE: usize = 4usize

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> ReadNorFlash for Sqspi<'d>

const READ_SIZE: usize = 4usize

The minumum number of bytes the storage peripheral can read

async fn read( &mut self, address: u32, data: &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.