Struct samd_dma::TransferDescriptor

#[repr(C)]pub struct TransferDescriptor { /* fields omitted */ }

The raw descriptor memory structure used by the DMA system to configure a block transfer.

Methods

impl TransferDescriptor

pub fn new() -> TransferDescriptor

Create a new empty descriptor.

pub fn get_src_addr(&self) -> *const ()

Get the type-erased source address.

pub fn get_dst_addr(&self) -> *const ()

Get the type-erased destination address.

pub fn get_next_desc_addr(&self) -> *mut TransferDescriptor

Get address for the next linked descriptor.

pub fn set_src_addr(&mut self, addr: *const ())

Set the source address of the descriptor. This is a type erased pointer.

pub fn set_dst_addr(&mut self, addr: *const ())

Set the destination address of the descriptor. This is a type erased pointer.

pub fn set_valid(&mut self)

Mark the descriptor as valid.

pub fn set_invalid(&mut self)

Mark the descriptor as invalid.

pub fn is_valid(&self) -> bool

Return the value of the valid bit.

pub fn set_block_count(&mut self, block_count: u16)

Set the block count for the descriptor.

pub fn get_block_transfer_count(&self) -> u16

Get the configured block transfer count.

pub fn get_step_size(&self) -> StepSize

Get the step size of the descriptor.

pub fn set_step_size(&mut self, step_size: StepSize)

Set the step size for the descriptor.

pub fn get_step_selection(&self) -> bool

Get which address is incremented with the descriptor's step size, if enabled.

Returns true if the source address is incremented, false if the destination address is incremented.

pub fn set_step_selection(&mut self, step_sel: bool)

Set which address is incremented with the descriptor's step size, if enabled.

true will increment the source address by the step size, false will increment the destination address by the step size.

pub fn get_dest_addr_increment(&self) -> bool

Get whether the destination address is incremented after each beat transfer.

If get_step_selection() is true, the address will be incremented by 1. Otherwise, the address will be incremented by the step size.

pub fn set_dest_addr_increment(&mut self, increment: bool)

Set whether the destination address is incremented after each beat transfer.

pub fn get_src_addr_increment(&self) -> bool

Get whether the source address is incremented after each beat transfer.

If get_step_selection() is false, the address will be incremented by 1. Otherwise, the address will be incremented by the step size.

pub fn set_src_addr_increment(&mut self, increment: bool)

Set whether the source address is incremented after each beat transfer.

pub fn get_block_action(&self) -> BlockAction

Get the action taken after this block transfer completes.

pub fn set_block_action(&mut self, block_action: BlockAction)

Set the action taken after this block transfer completes.

pub fn get_event_output(&self) -> EventOutput

Get the trigger that causes the transfer to output an event.

pub fn set_event_output(&mut self, event_output: EventOutput)

Set the trigger that causes the transfer to output an event.

pub fn link_descriptor(&mut self, next: *mut TransferDescriptor)

Link a transfer descriptor to execute AFTER this descriptor.

pub fn unlink_descriptor(&mut self) -> *mut TransferDescriptor

Unlink the next transfer descriptor, returning its address (which maybe null).

Trait Implementations

impl Debug for TransferDescriptor

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

Formats the value using the given formatter.

impl Default for TransferDescriptor

fn default() -> Self

Returns the "default value" for a type.