Struct devices::usb::xhci::ring_buffer_controller::RingBufferController

pub struct RingBufferController<T: 'static + TransferDescriptorHandler> {
    name: String,
    state: Mutex<RingBufferState>,
    stop_callback: Mutex<Vec<RingBufferStopCallback>>,
    ring_buffer: Mutex<RingBuffer>,
    handler: Mutex<T>,
    event_loop: Arc<EventLoop>,
    event: Event,
}

RingBufferController owns a ring buffer. It lives on a event_loop. It will pop out transfer descriptor and let TransferDescriptorHandler handle it.

Fields

name: String

state: Mutex<RingBufferState>

stop_callback: Mutex<Vec<RingBufferStopCallback>>

ring_buffer: Mutex<RingBuffer>

handler: Mutex<T>

event_loop: Arc<EventLoop>

event: Event

Implementations

impl RingBufferController<CommandRingTrbHandler>

pub fn new( mem: GuestMemory, event_loop: Arc<EventLoop>, slots: DeviceSlots, interrupter: Arc<Mutex<Interrupter>> ) -> Result<Arc<RingBufferController<CommandRingTrbHandler>>, RingBufferControllerError>

impl<T> RingBufferController<T>

where T: 'static + TransferDescriptorHandler + Send,

pub fn new_with_handler( name: String, mem: GuestMemory, event_loop: Arc<EventLoop>, handler: T ) -> Result<Arc<RingBufferController<T>>, Error>

Create a ring buffer controller and add it to event loop.

fn lock_ring_buffer(&self) -> MutexGuard<'_, RingBuffer>

pub fn get_dequeue_pointer(&self) -> GuestAddress

Get dequeue pointer of the internal ring buffer.

pub fn set_dequeue_pointer(&self, ptr: GuestAddress)

Set dequeue pointer of the internal ring buffer.

pub fn get_consumer_cycle_state(&self) -> bool

Get consumer cycle state.

pub fn set_consumer_cycle_state(&self, state: bool)

Set consumer cycle state.

pub fn start(&self)

Start the ring buffer.

pub fn stop(&self, callback: RingBufferStopCallback)

Stop the ring buffer asynchronously.

impl RingBufferController<TransferRingTrbHandler>

pub fn new( mem: GuestMemory, port: Arc<UsbPort>, event_loop: Arc<EventLoop>, interrupter: Arc<Mutex<Interrupter>>, slot_id: u8, endpoint_id: u8, device_slot: Weak<DeviceSlot>, stream_id: Option<u16> ) -> Result<Arc<RingBufferController<TransferRingTrbHandler>>, Error>

Trait Implementations

impl<T: 'static + TransferDescriptorHandler> Display for RingBufferController<T>

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

Formats the value using the given formatter.

impl<T> Drop for RingBufferController<T>

where T: 'static + TransferDescriptorHandler,

fn drop(&mut self)

Executes the destructor for this type.

impl<T> EventHandler for RingBufferController<T>

where T: 'static + TransferDescriptorHandler + Send,

fn on_event(&self) -> Result<()>