Struct DmaDescriptorFlags

pub struct DmaDescriptorFlags(pub u32);

Available on crate feature unstable only.

DMA descriptor flags.

Tuple Fields

0: u32

Implementations

impl DmaDescriptorFlags

pub fn size(&self) -> u16

Specifies the size of the buffer that this descriptor points to.

pub fn length(&self) -> u16

Specifies the number of valid bytes in the buffer that this descriptor points to.

This field in a transmit descriptor is written by software and indicates how many bytes can be read from the buffer.

This field in a receive descriptor is written by hardware automatically and indicates how many valid bytes have been stored into the buffer.

pub fn suc_eof(&self) -> bool

For receive descriptors, software needs to clear this bit to 0, and hardware will set it to 1 after receiving data containing the EOF flag. For transmit descriptors, software needs to set this bit to 1 as needed. If software configures this bit to 1 in a descriptor, the DMA will include the EOF flag in the data sent to the corresponding peripheral, indicating to the peripheral that this data segment marks the end of one transfer phase.

pub fn owner(&self) -> bool

Specifies who is allowed to access the buffer that this descriptor points to.

• 0: CPU can access the buffer;
• 1: The GDMA controller can access the buffer.

pub fn set_size(&mut self, value: u16)

Specifies the size of the buffer that this descriptor points to.

pub fn set_length(&mut self, value: u16)

Specifies the number of valid bytes in the buffer that this descriptor points to.

This field in a transmit descriptor is written by software and indicates how many bytes can be read from the buffer.

This field in a receive descriptor is written by hardware automatically and indicates how many valid bytes have been stored into the buffer.

pub fn set_suc_eof(&mut self, value: bool)

For receive descriptors, software needs to clear this bit to 0, and hardware will set it to 1 after receiving data containing the EOF flag. For transmit descriptors, software needs to set this bit to 1 as needed. If software configures this bit to 1 in a descriptor, the DMA will include the EOF flag in the data sent to the corresponding peripheral, indicating to the peripheral that this data segment marks the end of one transfer phase.

pub fn set_owner(&mut self, value: bool)

Specifies who is allowed to access the buffer that this descriptor points to.

• 0: CPU can access the buffer;
• 1: The GDMA controller can access the buffer.

Trait Implementations

impl<T> BitRange<T> for DmaDescriptorFlags

where u32: BitRange<T>,

fn bit_range(&self, msb: usize, lsb: usize) -> T

Get a range of bits.

impl<T> BitRangeMut<T> for DmaDescriptorFlags

where u32: BitRangeMut<T>,

fn set_bit_range(&mut self, msb: usize, lsb: usize, value: T)

Set a range of bits.

impl Clone for DmaDescriptorFlags

fn clone(&self) -> DmaDescriptorFlags

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DmaDescriptorFlags

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

Formats the value using the given formatter.

impl Format for DmaDescriptorFlags

fn format(&self, fmt: Formatter<'_>)

Writes the defmt representation of self to fmt.

impl PartialEq for DmaDescriptorFlags

fn eq(&self, other: &DmaDescriptorFlags) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for DmaDescriptorFlags

impl Eq for DmaDescriptorFlags

impl StructuralPartialEq for DmaDescriptorFlags