Struct esp32c3_hal::spi::dma::SpiDma

pub struct SpiDma<'d, T, TX, RX, P>where
    TX: Tx,
    RX: Rx,
    P: SpiPeripheral,{ /* private fields */ }

A DMA capable SPI instance.

Implementations

impl<'d, T, TX, RX, P> SpiDma<'d, T, TX, RX, P>where
    T: InstanceDma<TX, RX>,
    TX: Tx,
    RX: Rx,
    P: SpiPeripheral,

pub fn dma_write<TXBUF>(
    self,
    words: TXBUF
) -> Result<SpiDmaTransfer<'d, T, TX, RX, P, TXBUF>, 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, TX, RX, P, RXBUF>, 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, TX, RX, P, RXBUF, TXBUF>, 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.

Trait Implementations

impl<'d, T, TX, RX, P, BUFFER> DmaTransfer<BUFFER, SpiDma<'d, T, TX, RX, P>> for SpiDmaTransfer<'d, T, TX, RX, P, BUFFER>where
    T: InstanceDma<TX, RX>,
    TX: Tx,
    RX: Rx,
    P: SpiPeripheral,

fn wait(self) -> (BUFFER, SpiDma<'d, T, TX, RX, P>)

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

impl<'d, T, TX, RX, P, RXBUF, TXBUF> DmaTransferRxTx<RXBUF, TXBUF, SpiDma<'d, T, TX, RX, P>> for SpiDmaTransferRxTx<'d, T, TX, RX, P, RXBUF, TXBUF>where
    T: InstanceDma<TX, RX>,
    TX: Tx,
    RX: Rx,
    P: SpiPeripheral,

fn wait(self) -> (RXBUF, TXBUF, SpiDma<'d, T, TX, RX, P>)

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

impl<'d, T, TX, RX, P> Transfer<u8> for SpiDma<'d, T, TX, RX, P>where
    T: InstanceDma<TX, RX>,
    TX: Tx,
    RX: Rx,
    P: SpiPeripheral,

type Error = Error

Error type

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

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

impl<'d, T, TX, RX, P> Write<u8> for SpiDma<'d, T, TX, RX, P>where
    T: InstanceDma<TX, RX>,
    TX: Tx,
    RX: Rx,
    P: SpiPeripheral,

type Error = Error

Error type

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

Sends words to the slave, ignoring all the incoming words