Struct mlx_ethernet::command_queue::CommandQueueEntry
source · #[repr(C)]pub struct CommandQueueEntry { /* private fields */ }
Expand description
Layout of a command passed to the NIC. The fields include control information for the command as well as actual command input and output. The first 16 bytes of the actual command input are part of the entry. The remaining data is written in mailboxes. Similarly, the first 16 bytes of the command output are part of the entry and remaining data is written in mailboxes.
Implementations§
source§impl CommandQueueEntry
impl CommandQueueEntry
sourcepub fn get_delivery_status(
&self
) -> Result<CommandDeliveryStatus, CommandQueueError>
pub fn get_delivery_status( &self ) -> Result<CommandDeliveryStatus, CommandQueueError>
Returns the status of command delivery. This only informs us if the command was delivered to the NIC successfully, not if it was completed successfully.
sourcepub fn owned_by_hw(&self) -> bool
pub fn owned_by_hw(&self) -> bool
Returns true if the command is currently under the ownership of HW (SW should not touch the fields).
sourcepub fn get_return_status(
&self
) -> Result<CommandReturnStatus, CommandQueueError>
pub fn get_return_status( &self ) -> Result<CommandReturnStatus, CommandQueueError>
Returns the status of command execution.
A None
returned value indicates that there was no valid value in the bitfield.
Trait Implementations§
source§impl Debug for CommandQueueEntry
impl Debug for CommandQueueEntry
source§impl Default for CommandQueueEntry
impl Default for CommandQueueEntry
source§fn default() -> CommandQueueEntry
fn default() -> CommandQueueEntry
Returns the “default value” for a type. Read more
impl FromBytes for CommandQueueEntry
Auto Trait Implementations§
impl RefUnwindSafe for CommandQueueEntry
impl Send for CommandQueueEntry
impl Sync for CommandQueueEntry
impl Unpin for CommandQueueEntry
impl UnwindSafe for CommandQueueEntry
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more