Struct Spi

pub struct Spi<'d, M: PeriMode> { /* private fields */ }

SPI driver.

Implementations

impl<'d, M: PeriMode> Spi<'d, M>

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

Reconfigures it with the supplied config.

pub fn get_current_config(&self) -> Config

Get current SPI configuration.

pub fn blocking_write<W: Word>(&mut self, words: &[W]) -> Result<(), Error>

Blocking write.

pub fn blocking_read<W: Word>(&mut self, words: &mut [W]) -> Result<(), Error>

Blocking read.

pub fn blocking_transfer_in_place<W: Word>( &mut self, words: &mut [W], ) -> Result<(), Error>

Blocking in-place bidirectional transfer.

This writes the contents of data on MOSI, and puts the received data on MISO in data, at the same time.

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

Blocking bidirectional transfer.

This transfers both buffers at the same time, so it is NOT equivalent to write followed by read.

The transfer runs for max(read.len(), write.len()) bytes. If read is shorter extra bytes are ignored. If write is shorter it is padded with zero bytes.

impl<'d> Spi<'d, Blocking>

pub fn new_blocking<T: Instance>( peri: impl Peripheral<P = T> + 'd, sck: impl Peripheral<P = impl SckPin<T>> + 'd, mosi: impl Peripheral<P = impl MosiPin<T>> + 'd, miso: impl Peripheral<P = impl MisoPin<T>> + 'd, config: Config, ) -> Self

Create a new blocking SPI driver.

pub fn new_blocking_rxonly<T: Instance>( peri: impl Peripheral<P = T> + 'd, sck: impl Peripheral<P = impl SckPin<T>> + 'd, miso: impl Peripheral<P = impl MisoPin<T>> + 'd, config: Config, ) -> Self

Create a new blocking SPI driver, in RX-only mode (only MISO pin, no MOSI).

pub fn new_blocking_txonly<T: Instance>( peri: impl Peripheral<P = T> + 'd, sck: impl Peripheral<P = impl SckPin<T>> + 'd, mosi: impl Peripheral<P = impl MosiPin<T>> + 'd, config: Config, ) -> Self

Create a new blocking SPI driver, in TX-only mode (only MOSI pin, no MISO).

pub fn new_blocking_txonly_nosck<T: Instance>( peri: impl Peripheral<P = T> + 'd, mosi: impl Peripheral<P = impl MosiPin<T>> + 'd, config: Config, ) -> Self

Create a new SPI driver, in TX-only mode, without SCK pin.

This can be useful for bit-banging non-SPI protocols.

impl<'d> Spi<'d, Async>

pub fn new<T: Instance>( peri: impl Peripheral<P = T> + 'd, sck: impl Peripheral<P = impl SckPin<T>> + 'd, mosi: impl Peripheral<P = impl MosiPin<T>> + 'd, miso: impl Peripheral<P = impl MisoPin<T>> + 'd, tx_dma: impl Peripheral<P = impl TxDma<T>> + 'd, rx_dma: impl Peripheral<P = impl RxDma<T>> + 'd, config: Config, ) -> Self

Create a new SPI driver.

pub fn new_rxonly<T: Instance>( peri: impl Peripheral<P = T> + 'd, sck: impl Peripheral<P = impl SckPin<T>> + 'd, miso: impl Peripheral<P = impl MisoPin<T>> + 'd, rx_dma: impl Peripheral<P = impl RxDma<T>> + 'd, config: Config, ) -> Self

Create a new SPI driver, in RX-only mode (only MISO pin, no MOSI).

pub fn new_txonly<T: Instance>( peri: impl Peripheral<P = T> + 'd, sck: impl Peripheral<P = impl SckPin<T>> + 'd, mosi: impl Peripheral<P = impl MosiPin<T>> + 'd, tx_dma: impl Peripheral<P = impl TxDma<T>> + 'd, config: Config, ) -> Self

Create a new SPI driver, in TX-only mode (only MOSI pin, no MISO).

pub fn new_txonly_nosck<T: Instance>( peri: impl Peripheral<P = T> + 'd, mosi: impl Peripheral<P = impl MosiPin<T>> + 'd, tx_dma: impl Peripheral<P = impl TxDma<T>> + 'd, config: Config, ) -> Self

Create a new SPI driver, in TX-only mode, without SCK pin.

This can be useful for bit-banging non-SPI protocols.

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

SPI write, using DMA.

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

SPI read, using DMA.

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

Bidirectional transfer, using DMA.

This transfers both buffers at the same time, so it is NOT equivalent to write followed by read.

The transfer runs for max(read.len(), write.len()) bytes. If read is shorter extra bytes are ignored. If write is shorter it is padded with zero bytes.

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

In-place bidirectional transfer, using DMA.

This writes the contents of data on MOSI, and puts the received data on MISO in data, at the same time.

Trait Implementations

impl<'d, M: PeriMode> Drop for Spi<'d, M>

fn drop(&mut self)

Executes the destructor for this type.

impl<'d, M: PeriMode> ErrorType for Spi<'d, M>

type Error = Error

Error type.

impl<'d, M: PeriMode> SetConfig for Spi<'d, M>

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<(), ()>

Set the configuration of the driver.

impl<'d, W: Word> SpiBus<W> for Spi<'d, Async>

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

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

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

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

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

Read words from the slave.

async fn transfer( &mut self, read: &mut [W], write: &[W], ) -> Result<(), Self::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 [W], ) -> 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, W: Word, M: PeriMode> SpiBus<W> for Spi<'d, M>

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

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

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

Read words from the slave.

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

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

fn transfer(&mut self, read: &mut [W], write: &[W]) -> 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 [W]) -> 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, M: PeriMode> Transfer<u16> for Spi<'d, M>

type Error = Error

Error type

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

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

impl<'d, M: PeriMode> Transfer<u8> for Spi<'d, M>

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, M: PeriMode> Write<u16> for Spi<'d, M>

type Error = Error

Error type

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

Sends words to the slave, ignoring all the incoming words

impl<'d, M: PeriMode> Write<u8> for Spi<'d, M>

type Error = Error

Error type

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

Sends words to the slave, ignoring all the incoming words