esp_hal::spi::slave::dma

Struct SpiDma

Source 
pub struct SpiDma<'d, Dm>
where
    Dm: DriverMode,
{ /* private fields */ }
Available on crate feature unstable only.
Expand description

A structure representing a DMA transfer for SPI.

§Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

Implementations§

Source§

impl<'d, Dm> SpiDma<'d, Dm>
where Dm: DriverMode,

Source

pub fn write<TX>( self, bytes_to_write: usize, buffer: TX, ) -> Result<SpiDmaTransfer<'d, Dm, TX>, (Error, Self, TX)>
where TX: DmaTxBuffer,

Register a buffer for a DMA write.

This will return a SpiDmaTransfer. 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.

§Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

Source

pub fn read<RX>( self, bytes_to_read: usize, buffer: RX, ) -> Result<SpiDmaTransfer<'d, Dm, RX>, (Error, Self, RX)>
where RX: DmaRxBuffer,

Register a buffer for a DMA read.

This will return a SpiDmaTransfer. 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.

§Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

Source

pub fn transfer<RX, TX>( self, bytes_to_read: usize, rx_buffer: RX, bytes_to_write: usize, tx_buffer: TX, ) -> Result<SpiDmaTransfer<'d, Dm, (RX, TX)>, (Error, Self, RX, TX)>
where RX: DmaRxBuffer, TX: DmaTxBuffer,

Register buffers for a DMA transfer.

This will return a SpiDmaTransfer. 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.

§Stability

This API is marked as unstable and is only available when the unstable crate feature is enabled. This comes with no stability guarantees, and could be changed or removed at any time.

Trait Implementations§

Source§

impl<Dm> Debug for SpiDma<'_, Dm>
where Dm: DriverMode,

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'d, Dm> Freeze for SpiDma<'d, Dm>

§

impl<'d, Dm> RefUnwindSafe for SpiDma<'d, Dm>
where Dm: RefUnwindSafe,

§

impl<'d, Dm> Send for SpiDma<'d, Dm>
where Dm: Send,

§

impl<'d, Dm> Sync for SpiDma<'d, Dm>
where Dm: Sync,

§

impl<'d, Dm> Unpin for SpiDma<'d, Dm>
where Dm: Unpin,

§

impl<'d, Dm> !UnwindSafe for SpiDma<'d, Dm>

Blanket Implementations§

§

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

§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

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

§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
§

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

§

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

Mutably borrows from an owned value. Read more
§

impl<T> From<T> for T

§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

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> Same for T

Source§

type Output = T

Should always be Self
§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
§

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

Performs the conversion.
§

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

§

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

The type returned in the event of a conversion error.
§

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

Performs the conversion.