Struct esp32_hal::spi::master::dma::SpiDma

pub struct SpiDma<'d, T, C, M>
where
    C: ChannelTypes,
    <C as ChannelTypes>::P: SpiPeripheral,
    M: DuplexMode,
{ /* private fields */ }

A DMA capable SPI instance.

Implementations

impl<'d, T, C, M> SpiDma<'d, T, C, M>

where T: InstanceDma<<C as ChannelTypes>::Tx<'d>, <C as ChannelTypes>::Rx<'d>>, C: ChannelTypes, <C as ChannelTypes>::P: SpiPeripheral, M: DuplexMode,

pub fn change_bus_frequency( &mut self, frequency: Rate<u32, 1, 1>, clocks: &Clocks<'_> )

impl<'d, T, C, M> SpiDma<'d, T, C, M>

where T: InstanceDma<<C as ChannelTypes>::Tx<'d>, <C as ChannelTypes>::Rx<'d>>, C: ChannelTypes, <C as ChannelTypes>::P: SpiPeripheral, M: IsFullDuplex,

pub fn dma_write<TXBUF>( self, words: TXBUF ) -> Result<SpiDmaTransfer<'d, T, C, TXBUF, M>, Error>

where TXBUF: ReadBuffer<Word = u8>,

Perform a DMA write.

This will return a SpiDmaTransfer owning the buffer(s) and the SPI instance. The maximum amount of data to be sent is 32736 bytes.

pub fn dma_read<RXBUF>( self, words: RXBUF ) -> Result<SpiDmaTransfer<'d, T, C, RXBUF, M>, Error>

where RXBUF: WriteBuffer<Word = u8>,

Perform a DMA read.

This will return a SpiDmaTransfer owning the buffer(s) and the SPI instance. The maximum amount of data to be received is 32736 bytes.

pub fn dma_transfer<TXBUF, RXBUF>( self, words: TXBUF, read_buffer: RXBUF ) -> Result<SpiDmaTransferRxTx<'d, T, C, RXBUF, TXBUF, M>, Error>

where TXBUF: ReadBuffer<Word = u8>, RXBUF: WriteBuffer<Word = u8>,

Perform a DMA transfer.

This will return a SpiDmaTransfer owning the buffer(s) and the SPI instance. The maximum amount of data to be sent/received is 32736 bytes.

impl<'d, T, C, M> SpiDma<'d, T, C, M>

where T: InstanceDma<<C as ChannelTypes>::Tx<'d>, <C as ChannelTypes>::Rx<'d>>, C: ChannelTypes, <C as ChannelTypes>::P: SpiPeripheral, M: IsHalfDuplex,

pub fn read<RXBUF>( self, data_mode: SpiDataMode, cmd: Command, address: Address, dummy: u8, buffer: RXBUF ) -> Result<SpiDmaTransfer<'d, T, C, RXBUF, M>, Error>

where RXBUF: WriteBuffer<Word = u8>,

pub fn write<TXBUF>( self, data_mode: SpiDataMode, cmd: Command, address: Address, dummy: u8, buffer: TXBUF ) -> Result<SpiDmaTransfer<'d, T, C, TXBUF, M>, Error>

where TXBUF: ReadBuffer<Word = u8>,

Trait Implementations

impl<'d, T, C, M> Debug for SpiDma<'d, T, C, M>

where C: ChannelTypes, <C as ChannelTypes>::P: SpiPeripheral, M: DuplexMode,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'d, T, C, BUFFER, M> DmaTransfer<BUFFER, SpiDma<'d, T, C, M>> for SpiDmaTransfer<'d, T, C, BUFFER, M>

where T: InstanceDma<<C as ChannelTypes>::Tx<'d>, <C as ChannelTypes>::Rx<'d>>, C: ChannelTypes, <C as ChannelTypes>::P: SpiPeripheral, M: DuplexMode,

fn wait( self ) -> Result<(BUFFER, SpiDma<'d, T, C, M>), (DmaError, BUFFER, SpiDma<'d, T, C, M>)>

Wait for the DMA transfer to complete and return the buffers and the SPI instance.

fn is_done(&self) -> bool

Check if the DMA transfer is complete

impl<'d, T, C, RXBUF, TXBUF, M> DmaTransferRxTx<RXBUF, TXBUF, SpiDma<'d, T, C, M>> for SpiDmaTransferRxTx<'d, T, C, RXBUF, TXBUF, M>

where T: InstanceDma<<C as ChannelTypes>::Tx<'d>, <C as ChannelTypes>::Rx<'d>>, C: ChannelTypes, <C as ChannelTypes>::P: SpiPeripheral, M: DuplexMode,

fn wait( self ) -> Result<(RXBUF, TXBUF, SpiDma<'d, T, C, M>), (DmaError, RXBUF, TXBUF, SpiDma<'d, T, C, M>)>

Wait for the DMA transfer to complete and return the buffers and the SPI instance.

fn is_done(&self) -> bool

Check if the DMA transfer is complete

impl<'d, T, C, M> Transfer<u8> for SpiDma<'d, T, C, M>

where T: InstanceDma<<C as ChannelTypes>::Tx<'d>, <C as ChannelTypes>::Rx<'d>>, C: ChannelTypes, <C as ChannelTypes>::P: SpiPeripheral, M: IsFullDuplex,

type Error = Error

Error type

fn transfer<'w>( &mut self, words: &'w mut [u8] ) -> Result<&'w [u8], <SpiDma<'d, T, C, M> as Transfer<u8>>::Error>

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

impl<'d, T, C, M> Write<u8> for SpiDma<'d, T, C, M>

where T: InstanceDma<<C as ChannelTypes>::Tx<'d>, <C as ChannelTypes>::Rx<'d>>, C: ChannelTypes, <C as ChannelTypes>::P: SpiPeripheral, M: IsFullDuplex,

type Error = Error

Error type

fn write( &mut self, words: &[u8] ) -> Result<(), <SpiDma<'d, T, C, M> as Write<u8>>::Error>

Sends words to the slave, ignoring all the incoming words