Struct esp32s3_hal::spi::slave::dma::SpiDma

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

A DMA capable SPI instance.

Implementations

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

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

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

where TXBUF: ReadBuffer<Word = u8>,

Register a buffer for a DMA write.

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

The write is driven by the SPI master’s sclk signal and cs line.

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

where RXBUF: WriteBuffer<Word = u8>,

Register a buffer for a DMA read.

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

The read is driven by the SPI master’s sclk signal and cs line.

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

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

Register buffers for a DMA transfer.

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

The data transfer is driven by the SPI master’s sclk signal and cs line.

Trait Implementations

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

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

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

Formats the value using the given formatter.

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

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

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

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, BUFFER> DmaTransfer<BUFFER, SpiDma<'d, T, C>> for SpiDmaTransferTx<'d, T, C, BUFFER>

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

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

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> DmaTransferRxTx<RXBUF, TXBUF, SpiDma<'d, T, C>> for SpiDmaTransferRxTx<'d, T, C, RXBUF, TXBUF>

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

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

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