Struct Spi 

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

Spi driver.

Implementations

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

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

Read data from Spi blocking execution until done.

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

Write data to Spi blocking execution until done.

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

Transfer data to SPI blocking execution until done.

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

Transfer data in place to SPI blocking execution until done.

pub fn blocking_flush(&mut self) -> Result<(), IoError>

Block execution until Spi is done.

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

pub fn new_blocking<T: Instance>( _peri: Peri<'d, T>, sck: Peri<'d, impl SckPin<T> + 'd>, mosi: Peri<'d, impl MosiPin<T> + 'd>, miso: Peri<'d, impl MisoPin<T> + 'd>, config: Config, ) -> Result<Self, SetupError>

Create a SPI driver in blocking mode.

pub fn new_blocking_txonly<T: Instance>( _peri: Peri<'d, T>, sck: Peri<'d, impl SckPin<T> + 'd>, mosi: Peri<'d, impl MosiPin<T> + 'd>, config: Config, ) -> Result<Self, SetupError>

Create a TX-only SPI driver in blocking mode.

pub fn new_blocking_rxonly<T: Instance>( _peri: Peri<'d, T>, sck: Peri<'d, impl SckPin<T> + 'd>, miso: Peri<'d, impl MisoPin<T> + 'd>, config: Config, ) -> Result<Self, SetupError>

Create an RX-only SPI driver in blocking mode.

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

pub fn new_async<T: Instance>( _peri: Peri<'d, T>, sck: Peri<'d, impl SckPin<T> + 'd>, mosi: Peri<'d, impl MosiPin<T> + 'd>, miso: Peri<'d, impl MisoPin<T> + 'd>, _irq: impl Binding<T::Interrupt, InterruptHandler<T>> + 'd, config: Config, ) -> Result<Self, SetupError>

Create a SPI driver in async mode.

pub fn new_async_txonly<T: Instance>( _peri: Peri<'d, T>, sck: Peri<'d, impl SckPin<T> + 'd>, mosi: Peri<'d, impl MosiPin<T> + 'd>, _irq: impl Binding<T::Interrupt, InterruptHandler<T>> + 'd, config: Config, ) -> Result<Self, SetupError>

Create a TX-only SPI driver in async mode.

pub fn new_async_rxonly<T: Instance>( _peri: Peri<'d, T>, sck: Peri<'d, impl SckPin<T> + 'd>, miso: Peri<'d, impl MisoPin<T> + 'd>, _irq: impl Binding<T::Interrupt, InterruptHandler<T>> + 'd, config: Config, ) -> Result<Self, SetupError>

Create an RX-only SPI driver in async mode.

impl<'d> Spi<'d, Dma<'d>>

pub fn new_async_with_dma<T: Instance>( _peri: Peri<'d, T>, sck: Peri<'d, impl SckPin<T> + 'd>, mosi: Peri<'d, impl MosiPin<T> + 'd>, miso: Peri<'d, impl MisoPin<T> + 'd>, tx_dma: Peri<'d, impl TxDma<T>>, rx_dma: Peri<'d, impl RxDma<T>>, _irq: impl Binding<T::Interrupt, InterruptHandler<T>> + 'd, config: Config, ) -> Result<Self, SetupError>

Create a SPI driver in async mode.

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

where Self: AsyncEngine,

pub fn async_read( &mut self, data: &mut [u8], ) -> impl Future<Output = Result<(), IoError>>

Read data from Spi async execution until done.

pub fn async_write( &mut self, data: &[u8], ) -> impl Future<Output = Result<(), IoError>>

Write data to Spi async execution until done.

pub fn async_transfer( &mut self, read: &mut [u8], write: &[u8], ) -> impl Future<Output = Result<(), IoError>>

Transfer data to SPI async execution until done.

pub fn async_transfer_in_place( &mut self, data: &mut [u8], ) -> impl Future<Output = Result<(), IoError>>

Transfer data in place to SPI async execution until done.

pub async fn async_flush(&mut self) -> Result<(), IoError>

Async flush.

Trait Implementations

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

type Error = IoError

Error type.

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

type Config = Config

The configuration type used by this driver.

type ConfigError = SetupError

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, M: IoMode> SpiBus 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 [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, M: AsyncMode> SpiBus for Spi<'d, M>

where Spi<'d, M>: AsyncEngine,

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: &[u8]) -> Result<(), Self::Error>

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

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

Read words from the slave.

async 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.

async 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, M: IoMode> Transfer<u8> for Spi<'d, M>

type Error = IoError

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

type Error = IoError

Error type

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

Sends words to the slave, ignoring all the incoming words