Struct devices::usb::xhci::ring_buffer::RingBuffer

pub struct RingBuffer {
    name: String,
    mem: GuestMemory,
    dequeue_pointer: GuestAddress,
    consumer_cycle_state: bool,
}

Ring Buffer is segmented circular buffer in guest memory containing work items called transfer descriptors, each of which consists of one or more TRBs. Ring buffer logic is shared between transfer ring and command ring. Transfer Ring management is defined in xHCI spec 4.9.2.

Fields

name: String

mem: GuestMemory

dequeue_pointer: GuestAddress

consumer_cycle_state: bool

Implementations

impl RingBuffer

pub fn new(name: String, mem: GuestMemory) -> Self

Create a new RingBuffer.

pub fn dequeue_transfer_descriptor( &mut self ) -> Result<Option<Vec<AddressedTrb>>, Error>

Dequeue next transfer descriptor from the transfer ring.

pub fn get_dequeue_pointer(&self) -> GuestAddress

Get dequeue pointer of the ring buffer.

pub fn set_dequeue_pointer(&mut self, addr: GuestAddress)

Set dequeue pointer of the ring buffer.

pub fn get_consumer_cycle_state(&self) -> bool

Get consumer cycle state of the ring buffer.

pub fn set_consumer_cycle_state(&mut self, state: bool)

Set consumer cycle state of the ring buffer.

fn get_current_trb(&self) -> Result<Option<AddressedTrb>, Error>

Trait Implementations

impl Display for RingBuffer

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

Formats the value using the given formatter.