Struct esp32c2_hal::spi::dma::SpiDma

source ·

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

Expand description

A DMA capable SPI instance.

Implementations

source

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

source

pub fn free(self) -> T

Return the raw interface to the underlying peripheral instance

source

pub fn dma_write<TXBUF>(
 self,
 words: TXBUF
) -> Result<SpiDmaTransfer<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.

source

pub fn dma_read<RXBUF>(
 self,
 words: RXBUF
) -> Result<SpiDmaTransfer<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.

source

pub fn dma_transfer<TXBUF, RXBUF>(
 self,
 words: TXBUF,
 read_buffer: RXBUF
) -> Result<SpiDmaTransferRxTx<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

source

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

source

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

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

source

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

source

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

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

source

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

type Error = Error

Error type

source

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

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

source

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

type Error = Error

Error type

source

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

Sends words to the slave, ignoring all the incoming words

Auto Trait Implementations

impl<T, TX, RX, P> RefUnwindSafe for SpiDma<T, TX, RX, P>where
 P: RefUnwindSafe,
 RX: RefUnwindSafe,
 T: RefUnwindSafe,
 TX: RefUnwindSafe,

impl<T, TX, RX, P> Send for SpiDma<T, TX, RX, P>where
 P: Send,
 RX: Send,
 T: Send,
 TX: Send,

impl<T, TX, RX, P> Sync for SpiDma<T, TX, RX, P>where
 P: Sync,
 RX: Sync,
 T: Sync,
 TX: Sync,

impl<T, TX, RX, P> Unpin for SpiDma<T, TX, RX, P>where
 P: Unpin,
 RX: Unpin,
 T: Unpin,
 TX: Unpin,

impl<T, TX, RX, P> UnwindSafe for SpiDma<T, TX, RX, P>where
 P: UnwindSafe,
 RX: UnwindSafe,
 T: UnwindSafe,
 TX: UnwindSafe,

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct esp32c2_hal::spi::dma::SpiDma

Implementations

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

pub fn free(self) -> T

pub fn dma_write<TXBUF>( self, words: TXBUF) -> Result<SpiDmaTransfer<T, TX, RX, P, TXBUF>, Error>where TXBUF: ReadBuffer<Word = u8>,

pub fn dma_read<RXBUF>( self, words: RXBUF) -> Result<SpiDmaTransfer<T, TX, RX, P, RXBUF>, Error>where RXBUF: WriteBuffer<Word = u8>,

pub fn dma_transfer<TXBUF, RXBUF>( self, words: TXBUF, read_buffer: RXBUF) -> Result<SpiDmaTransferRxTx<T, TX, RX, P, RXBUF, TXBUF>, Error>where TXBUF: ReadBuffer<Word = u8>, RXBUF: WriteBuffer<Word = u8>,

Trait Implementations

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

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

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

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

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

type Error = Error

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

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

type Error = Error

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

Auto Trait Implementations

impl<T, TX, RX, P> RefUnwindSafe for SpiDma<T, TX, RX, P>where P: RefUnwindSafe, RX: RefUnwindSafe, T: RefUnwindSafe, TX: RefUnwindSafe,

impl<T, TX, RX, P> Send for SpiDma<T, TX, RX, P>where P: Send, RX: Send, T: Send, TX: Send,

impl<T, TX, RX, P> Sync for SpiDma<T, TX, RX, P>where P: Sync, RX: Sync, T: Sync, TX: Sync,

impl<T, TX, RX, P> Unpin for SpiDma<T, TX, RX, P>where P: Unpin, RX: Unpin, T: Unpin, TX: Unpin,

impl<T, TX, RX, P> UnwindSafe for SpiDma<T, TX, RX, P>where P: UnwindSafe, RX: UnwindSafe, T: UnwindSafe, TX: UnwindSafe,

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T, TX, RX, P> SpiDma<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<T, TX, RX, P, TXBUF>, Error>where
TXBUF: ReadBuffer<Word = u8>,

pub fn dma_read<RXBUF>(
self,
words: RXBUF
) -> Result<SpiDmaTransfer<T, TX, RX, P, RXBUF>, Error>where
RXBUF: WriteBuffer<Word = u8>,

pub fn dma_transfer<TXBUF, RXBUF>(
self,
words: TXBUF,
read_buffer: RXBUF
) -> Result<SpiDmaTransferRxTx<T, TX, RX, P, RXBUF, TXBUF>, Error>where
TXBUF: ReadBuffer<Word = u8>,
RXBUF: WriteBuffer<Word = u8>,

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

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

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

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

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

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

impl<T, TX, RX, P> RefUnwindSafe for SpiDma<T, TX, RX, P>where
P: RefUnwindSafe,
RX: RefUnwindSafe,
T: RefUnwindSafe,
TX: RefUnwindSafe,

impl<T, TX, RX, P> Send for SpiDma<T, TX, RX, P>where
P: Send,
RX: Send,
T: Send,
TX: Send,

impl<T, TX, RX, P> Sync for SpiDma<T, TX, RX, P>where
P: Sync,
RX: Sync,
T: Sync,
TX: Sync,

impl<T, TX, RX, P> Unpin for SpiDma<T, TX, RX, P>where
P: Unpin,
RX: Unpin,
T: Unpin,
TX: Unpin,

impl<T, TX, RX, P> UnwindSafe for SpiDma<T, TX, RX, P>where
P: UnwindSafe,
RX: UnwindSafe,
T: UnwindSafe,
TX: UnwindSafe,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,