Struct embassy_nrf::qspi::Qspi

pub struct Qspi<'d, T: Instance> { /* private fields */ }

QSPI flash driver.

Implementations

impl<'d, T: Instance> Qspi<'d, T>

pub fn new( qspi: impl Peripheral<P = T> + 'd, _irq: impl Binding<T::Interrupt, InterruptHandler<T>> + 'd, sck: impl Peripheral<P = impl GpioPin> + 'd, csn: impl Peripheral<P = impl GpioPin> + 'd, io0: impl Peripheral<P = impl GpioPin> + 'd, io1: impl Peripheral<P = impl GpioPin> + 'd, io2: impl Peripheral<P = impl GpioPin> + 'd, io3: impl Peripheral<P = impl GpioPin> + 'd, config: Config ) -> Self

Create a new QSPI driver.

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

Do a custom QSPI instruction.

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

Do a custom QSPI instruction, blocking version.

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

Raw QSPI read.

The difference with read is that this does not do bounds checks against the flash capacity. It is intended for use when QSPI is used as a raw bus, not with flash memory.

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

Raw QSPI write.

The difference with write is that this does not do bounds checks against the flash capacity. It is intended for use when QSPI is used as a raw bus, not with flash memory.

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

Raw QSPI read, blocking version.

The difference with blocking_read is that this does not do bounds checks against the flash capacity. It is intended for use when QSPI is used as a raw bus, not with flash memory.

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

Raw QSPI write, blocking version.

The difference with blocking_write is that this does not do bounds checks against the flash capacity. It is intended for use when QSPI is used as a raw bus, not with flash memory.

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

Read data from the flash memory.

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

Write data to the flash memory.

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

Erase a sector on the flash memory.

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

Read data from the flash memory, blocking version.

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

Write data to the flash memory, blocking version.

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

Erase a sector on the flash memory, blocking version.

Trait Implementations

impl<'d, T: Instance> Drop for Qspi<'d, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<'d, T: Instance> ErrorType for Qspi<'d, T>

type Error = Error

Errors returned by this NOR flash.

impl<'d, T: Instance> NorFlash for Qspi<'d, T>

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, T: Instance> NorFlash for Qspi<'d, T>

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, T: Instance> ReadNorFlash for Qspi<'d, T>

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.

impl<'d, T: Instance> ReadNorFlash for Qspi<'d, T>

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.