Struct imxrt_hal::dma::Transfer

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

The core DMA transfer future

Transfer is a future that drives the DMA transfer. Transfer will initiate a DMA transfer when it is first polled. You may then poll it to understand when the transfer completes.

To cancel a transfer, drop the Transfer.

If you’ve enabled DMA interrupts, consider using on_interrupt to wake an executor when the DMA transfer completes, The interrupt interface assumes that you’ve

• configured your channel to generate interrupts
• registered a DMA ISR with your embedded runtime
• unmasked the DMA interrupt in the NVIC

Transfer calls the unsafe enable method to enable a DMA transfer. To properly use Transfer, make sure that you’ve configured your DMA channel for a valid transfer.

Transfer is the core DMA future used in imxrt_dma. For safe DMA transfers, consider using

• Memcpy for buffer-to-buffer DMA transfers
• Read for peripheral-to-memory DMA transfers
• Write for memory-to-peripheral DMA transfers

Transfer is designed to the DMA Channel public interface. If you need to implement your own transfer future, you may do so.

use imxrt_dma::{channel::Channel, Transfer};

let my_channel: Channel = // Acquire your channel...
// Properly prepare your transfer...
// Safety: transfer properly prepared
unsafe { Transfer::new(&my_channel) }.await?;

Implementations

impl<'a> Transfer<'a>

pub unsafe fn new(channel: &'a Channel) -> Transfer<'a>

Create a new Transfer that performs the DMA transfer described by channel

Safety

Assumes that the transfer is correctly defined in the DMA channel memory. The transfer enables after the first call to poll().

Trait Implementations

impl Drop for Transfer<'_>

fn drop(&mut self)

Executes the destructor for this type.

impl Future for Transfer<'_>

type Output = Result<(), Error>

The type of value produced on completion.

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

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