Struct embassy_nrf::spis::Spis

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

SPIS driver.

Implementations

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

pub fn new( spis: impl Peripheral<P = T> + 'd, _irq: impl Binding<T::Interrupt, InterruptHandler<T>> + 'd, cs: impl Peripheral<P = impl GpioPin> + 'd, sck: impl Peripheral<P = impl GpioPin> + 'd, miso: impl Peripheral<P = impl GpioPin> + 'd, mosi: impl Peripheral<P = impl GpioPin> + 'd, config: Config, ) -> Self

Create a new SPIS driver.

pub fn new_txonly( spis: impl Peripheral<P = T> + 'd, _irq: impl Binding<T::Interrupt, InterruptHandler<T>> + 'd, cs: impl Peripheral<P = impl GpioPin> + 'd, sck: impl Peripheral<P = impl GpioPin> + 'd, miso: impl Peripheral<P = impl GpioPin> + 'd, config: Config, ) -> Self

Create a new SPIS driver, capable of TX only (MISO only).

pub fn new_rxonly( spis: impl Peripheral<P = T> + 'd, _irq: impl Binding<T::Interrupt, InterruptHandler<T>> + 'd, cs: impl Peripheral<P = impl GpioPin> + 'd, sck: impl Peripheral<P = impl GpioPin> + 'd, mosi: impl Peripheral<P = impl GpioPin> + 'd, config: Config, ) -> Self

Create a new SPIS driver, capable of RX only (MOSI only).

pub fn new_txonly_nosck( spis: impl Peripheral<P = T> + 'd, _irq: impl Binding<T::Interrupt, InterruptHandler<T>> + 'd, cs: impl Peripheral<P = impl GpioPin> + 'd, miso: impl Peripheral<P = impl GpioPin> + 'd, config: Config, ) -> Self

Create a new SPIS driver, capable of TX only (MISO only) without SCK pin.

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

Reads data from the SPI bus without sending anything. Blocks until cs is deasserted. Returns number of bytes read.

pub fn blocking_transfer( &mut self, read: &mut [u8], write: &[u8], ) -> Result<(usize, usize), Error>

Simultaneously sends and receives data. Blocks until the transmission is completed. If necessary, the write buffer will be copied into RAM (see struct description for detail). Returns number of bytes transferred (n_rx, n_tx).

pub fn blocking_transfer_from_ram( &mut self, read: &mut [u8], write: &[u8], ) -> Result<(usize, usize), Error>

Same as blocking_transfer but will fail instead of copying data into RAM. Consult the module level documentation to learn more. Returns number of bytes transferred (n_rx, n_tx).

pub fn blocking_transfer_in_place( &mut self, data: &mut [u8], ) -> Result<usize, Error>

Simultaneously sends and receives data. Places the received data into the same buffer and blocks until the transmission is completed. Returns number of bytes transferred.

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

Sends data, discarding any received data. Blocks until the transmission is completed. If necessary, the write buffer will be copied into RAM (see struct description for detail). Returns number of bytes written.

pub fn blocking_write_from_ram(&mut self, data: &[u8]) -> Result<usize, Error>

Same as blocking_write but will fail instead of copying data into RAM. Consult the module level documentation to learn more. Returns number of bytes written.

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

Reads data from the SPI bus without sending anything. Returns number of bytes read.

pub async fn transfer( &mut self, read: &mut [u8], write: &[u8], ) -> Result<(usize, usize), Error>

Simultaneously sends and receives data. If necessary, the write buffer will be copied into RAM (see struct description for detail). Returns number of bytes transferred (n_rx, n_tx).

pub async fn transfer_from_ram( &mut self, read: &mut [u8], write: &[u8], ) -> Result<(usize, usize), Error>

Same as transfer but will fail instead of copying data into RAM. Consult the module level documentation to learn more. Returns number of bytes transferred (n_rx, n_tx).

pub async fn transfer_in_place( &mut self, data: &mut [u8], ) -> Result<usize, Error>

Simultaneously sends and receives data. Places the received data into the same buffer. Returns number of bytes transferred.

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

Sends data, discarding any received data. If necessary, the write buffer will be copied into RAM (see struct description for detail). Returns number of bytes written.

pub async fn write_from_ram(&mut self, data: &[u8]) -> Result<usize, Error>

Same as write but will fail instead of copying data into RAM. Consult the module level documentation to learn more. Returns number of bytes written.

pub fn is_overread(&mut self) -> bool

Checks if last transaction overread.

pub fn is_overflow(&mut self) -> bool

Checks if last transaction overflowed.

Trait Implementations

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

fn drop(&mut self)

Executes the destructor for this type.

impl<'d, T: Instance> SetConfig for Spis<'d, T>

type Config = Config

The configuration type used by this driver.

type ConfigError = ()

The error type that can occur if set_config fails.

fn set_config(&mut self, config: &Self::Config) -> Result<(), Self::ConfigError>

Set the configuration of the driver.