Struct CommandQueueTDLEntry 

pub struct CommandQueueTDLEntry { /* private fields */ }

An entry in the CQHCI Task Descriptor List (JESD84-B51A, B.2).

Note that this assumes 16-byte descriptors.

Implementations

impl CommandQueueTDLEntry

pub fn single_buffer( direction: Direction, block_offset: u64, block_count: NonZeroU16, phys_address: u64, ) -> Result<Self, ()>

Creates a new CommandQueueTDLEntry which points to a single memory region at phys_address.

The caller must ensure that block_count does not exceed the maximum transfer size of TransferBytes::MAX_BLOCKS, otherwise an error is returned.

pub fn scatter_gather_buffers( direction: Direction, block_offset: u64, block_count: NonZeroU16, descriptors_phys_address: u64, ) -> Self

Creates a new CommandQueueTDLEntry which points to a list of CommandQueueTransferDescriptors at descriptors_phys_address. The caller must ensure that one or more descriptors, ending with one that has END set, is initialized at this address before submitting the task.

Trait Implementations

impl Clone for CommandQueueTDLEntry

fn clone(&self) -> CommandQueueTDLEntry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandQueueTDLEntry

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

Formats the value using the given formatter.

impl FromBytes for CommandQueueTDLEntry

where CommandQueueTaskDescriptor: FromBytes, CommandQueueTransferDescriptor: FromBytes,

fn read_from_bytes(source: &[u8]) -> Result<Self, SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the given source.

fn read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the prefix of the given source.

fn read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), SizeError<&[u8], Self>>

where Self: Sized,

Reads a copy of Self from the suffix of the given source.

impl FromZeros for CommandQueueTDLEntry

where CommandQueueTaskDescriptor: FromZeros, CommandQueueTransferDescriptor: FromZeros,

fn zero(&mut self)

Overwrites self with zeros.

fn new_zeroed() -> Self

where Self: Sized,

Creates an instance of Self from zeroed bytes.

fn new_box_zeroed() -> Result<Box<Self>, AllocError>

where Self: Sized,

Creates a Box<Self> from zeroed bytes.

fn new_vec_zeroed(len: usize) -> Result<Vec<Self>, AllocError>

where Self: Sized,

Creates a Vec<Self> from zeroed bytes.

fn extend_vec_zeroed( v: &mut Vec<Self>, additional: usize, ) -> Result<(), AllocError>

where Self: Sized,

Extends a Vec<Self> by pushing additional new items onto the end of the vector. The new items are initialized with zeros.

fn insert_vec_zeroed( v: &mut Vec<Self>, position: usize, additional: usize, ) -> Result<(), AllocError>

where Self: Sized,

Inserts additional new items into Vec<Self> at position. The new items are initialized with zeros.

impl IntoBytes for CommandQueueTDLEntry

where CommandQueueTaskDescriptor: IntoBytes, CommandQueueTransferDescriptor: IntoBytes, (): PaddingFree<Self, { _ }>,

fn as_bytes(&self) -> &[u8]

where Self: Immutable,

Gets the bytes of this value.

fn as_mut_bytes(&mut self) -> &mut [u8]

where Self: FromBytes,

Gets the bytes of this value mutably.

fn write_to(&self, dst: &mut [u8]) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to dst.

fn write_to_prefix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the prefix of dst.

fn write_to_suffix( &self, dst: &mut [u8], ) -> Result<(), SizeError<&Self, &mut [u8]>>

where Self: Immutable,

Writes a copy of self to the suffix of dst.

impl PartialEq for CommandQueueTDLEntry

fn eq(&self, other: &CommandQueueTDLEntry) -> 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 TryFromBytes for CommandQueueTDLEntry

where CommandQueueTaskDescriptor: TryFromBytes, CommandQueueTransferDescriptor: TryFromBytes,

fn try_read_from_bytes( source: &[u8], ) -> Result<Self, ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read the given source as a Self.

fn try_read_from_prefix( source: &[u8], ) -> Result<(Self, &[u8]), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the prefix of the given source.

fn try_read_from_suffix( source: &[u8], ) -> Result<(&[u8], Self), ConvertError<Infallible, SizeError<&[u8], Self>, ValidityError<&[u8], Self>>>

where Self: Sized,

Attempts to read a Self from the suffix of the given source.

impl Copy for CommandQueueTDLEntry

impl Eq for CommandQueueTDLEntry

impl Immutable for CommandQueueTDLEntry

where CommandQueueTaskDescriptor: Immutable, CommandQueueTransferDescriptor: Immutable,

impl StructuralPartialEq for CommandQueueTDLEntry