Struct Transfer

pub struct Transfer<'a> { /* private fields */ }

DMA transfer.

Implementations

impl<'a> Transfer<'a>

pub unsafe fn new_read<W: Word>( channel: impl Peripheral<P = impl Channel> + 'a, request: Request, peri_addr: *mut W, buf: &'a mut [W], options: TransferOptions, ) -> Self

Create a new read DMA transfer (peripheral to memory).

pub unsafe fn new_read_raw<W: Word>( channel: impl Peripheral<P = impl Channel> + 'a, request: Request, peri_addr: *mut W, buf: *mut [W], options: TransferOptions, ) -> Self

Create a new read DMA transfer (peripheral to memory), using raw pointers.

pub unsafe fn new_write<W: Word>( channel: impl Peripheral<P = impl Channel> + 'a, request: Request, buf: &'a [W], peri_addr: *mut W, options: TransferOptions, ) -> Self

Create a new write DMA transfer (memory to peripheral).

pub unsafe fn new_write_raw<W: Word>( channel: impl Peripheral<P = impl Channel> + 'a, request: Request, buf: *const [W], peri_addr: *mut W, options: TransferOptions, ) -> Self

Create a new write DMA transfer (memory to peripheral), using raw pointers.

pub unsafe fn new_write_repeated<W: Word>( channel: impl Peripheral<P = impl Channel> + 'a, request: Request, repeated: &'a W, count: usize, peri_addr: *mut W, options: TransferOptions, ) -> Self

Create a new write DMA transfer (memory to peripheral), writing the same value repeatedly.

pub fn request_stop(&mut self)

Request the transfer to stop. The configuration for this channel will not be preserved. If you need to restart the transfer at a later point with the same configuration, see request_pause instead.

This doesn’t immediately stop the transfer, you have to wait until is_running returns false.

pub fn request_pause(&mut self)

Request the transfer to pause, keeping the existing configuration for this channel. To restart the transfer, call start again.

This doesn’t immediately stop the transfer, you have to wait until is_running returns false.

pub fn is_running(&mut self) -> bool

Return whether this transfer is still running.

If this returns false, it can be because either the transfer finished, or it was requested to stop early with request_stop.

pub fn get_remaining_transfers(&self) -> u16

Gets the total remaining transfers for the channel Note: this will be zero for transfers that completed without cancellation.

pub fn blocking_wait(self)

Blocking wait until the transfer finishes.

Trait Implementations

impl<'a> Drop for Transfer<'a>

fn drop(&mut self)

Executes the destructor for this type.

impl<'a> Future for Transfer<'a>

type Output = ()

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.

impl<'a> Unpin for Transfer<'a>