Struct Spim

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

SPIM driver.

Implementations

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

pub fn new( spim: Peri<'d, T>, _irq: impl Binding<T::Interrupt, InterruptHandler<T>> + 'd, sck: Peri<'d, impl GpioPin>, miso: Peri<'d, impl GpioPin>, mosi: Peri<'d, impl GpioPin>, config: Config, ) -> Self

Create a new SPIM driver.

pub fn new_txonly( spim: Peri<'d, T>, _irq: impl Binding<T::Interrupt, InterruptHandler<T>> + 'd, sck: Peri<'d, impl GpioPin>, mosi: Peri<'d, impl GpioPin>, config: Config, ) -> Self

Create a new SPIM driver, capable of TX only (MOSI only).

pub fn new_rxonly( spim: Peri<'d, T>, _irq: impl Binding<T::Interrupt, InterruptHandler<T>> + 'd, sck: Peri<'d, impl GpioPin>, miso: Peri<'d, impl GpioPin>, config: Config, ) -> Self

Create a new SPIM driver, capable of RX only (MISO only).

pub fn new_txonly_nosck( spim: Peri<'d, T>, _irq: impl Binding<T::Interrupt, InterruptHandler<T>> + 'd, mosi: Peri<'d, impl GpioPin>, config: Config, ) -> Self

Create a new SPIM driver, capable of TX only (MOSI only), without SCK pin.

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

Reads data from the SPI bus without sending anything. Blocks until the buffer has been filled.

pub fn blocking_transfer( &mut self, read: &mut [u8], write: &[u8], ) -> Result<(), 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).

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

Same as blocking_transfer but will fail instead of copying data into RAM. Consult the module level documentation to learn more.

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

Simultaneously sends and receives data. Places the received data into the same buffer and blocks until the transmission is completed.

pub fn blocking_write(&mut self, data: &[u8]) -> Result<(), 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).

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

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

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

Reads data from the SPI bus without sending anything.

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

Simultaneously sends and receives data. If necessary, the write buffer will be copied into RAM (see struct description for detail).

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

Same as transfer but will fail instead of copying data into RAM. Consult the module level documentation to learn more.

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

Simultaneously sends and receives data. Places the received data into the same buffer.

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

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

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

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

Trait Implementations

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

fn drop(&mut self)

Executes the destructor for this type.

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

type Error = Error

Error type.

impl<'d, T: Instance> SetConfig for Spim<'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.

impl<'d, T: Instance> SpiBus for Spim<'d, T>

fn flush(&mut self) -> Result<(), Self::Error>

Wait until all operations have completed and the bus is idle.

fn read(&mut self, words: &mut [u8]) -> Result<(), Self::Error>

Read words from the slave.

fn write(&mut self, words: &[u8]) -> Result<(), Self::Error>

Write words to the slave, ignoring all the incoming words.

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

Write and read simultaneously. write is written to the slave on MOSI and words received on MISO are stored in read.

fn transfer_in_place(&mut self, words: &mut [u8]) -> Result<(), Self::Error>

Write and read simultaneously. The contents of words are written to the slave, and the received words are stored into the same words buffer, overwriting it.

impl<'d, T: Instance> SpiBus for Spim<'d, T>

async fn flush(&mut self) -> Result<(), Error>

Wait until all operations have completed and the bus is idle.

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

Read words from the slave.

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

Write words to the slave, ignoring all the incoming words.

async fn transfer(&mut self, rx: &mut [u8], tx: &[u8]) -> Result<(), Error>

Write and read simultaneously. write is written to the slave on MOSI and words received on MISO are stored in read.

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

Write and read simultaneously. The contents of words are written to the slave, and the received words are stored into the same words buffer, overwriting it.

impl<'d, T: Instance> Transfer<u8> for Spim<'d, T>

type Error = Error

Error type

fn transfer<'w>(&mut self, words: &'w mut [u8]) -> Result<&'w [u8], Self::Error>

Sends words to the slave. Returns the words received from the slave

impl<'d, T: Instance> Write<u8> for Spim<'d, T>

type Error = Error

Error type

fn write(&mut self, words: &[u8]) -> Result<(), Self::Error>

Sends words to the slave, ignoring all the incoming words