Struct mlx_ethernet::send_queue::SendQueue

pub struct SendQueue { /* private fields */ }

A data structure that contains the SQ ring of descriptors and is used to interact with the SQ once initialized.

Implementations

impl SendQueue

pub fn create( entries_mp: MappedPages, num_entries: usize, doorbell_mp: MappedPages, uar_mp: MappedPages, sqn: Sqn, _tisn: Tisn, lkey: Lkey ) -> Result<SendQueue, &'static str>

Creates a SQ by mapping the buffer as a slice of WorkQueueEntrySends. Each WQE is set to an initial state.

Arguments

• entries_mp: memory that is to be transformed into a slice of WQEs. The starting physical address should have been passed to the HCA when creating the SQ.
• num_entries: number of entries in the SQ
• doorbell_mp: memory that is to be transformed into a doorbell record. The starting physical address should have been passed to the HCA when creating the SQ.
• uar_mp: The UAR page that is associate with this SQ.
• sqn: SQ number returned by the HCA
• tisn: number of the TIS context associated with this SQ
• lkey: the lkey used by the SQ

pub fn send(&mut self, packet_address: PhysicalAddress, packet: &[u8]) -> u16

Perform all the steps to send a packet: initialize the WQE, update the doorbell record and the uar doorbell register. Returns the current value of the WQE counter.

pub fn nop(&mut self) -> u16

Perform all the steps to complete a NOP: initialize the WQE, update the doorbell record and the uar doorbell register. Returns the current value of the WQE counter.

pub fn dump(&self)

Prints out all entries in the SQ