Enum devices::usb::backend::device::BackendDeviceType

pub enum BackendDeviceType {
    HostDevice(HostDevice),
    FidoDevice(FidoPassthroughDevice),
}

This enum defines different USB backend implementations that we support. Each implementation needs to implement the BackendDevice trait as we dispatch on the enum based on the type. Each concrete implementation can take care of setting up the device-specific configurations.

Variants

HostDevice(HostDevice)

FidoDevice(FidoPassthroughDevice)

Implementations

impl BackendDeviceType

fn intercepted_control_transfer( &mut self, xhci_transfer: &XhciTransfer, buffer: &Option<ScatterGatherBuffer>, control_request_setup: &UsbRequestSetup ) -> Result<bool>

fn execute_control_transfer( &mut self, xhci_transfer: Arc<XhciTransfer>, buffer: Option<ScatterGatherBuffer>, control_request_setup: &UsbRequestSetup ) -> Result<()>

fn handle_control_transfer(&mut self, transfer: XhciTransfer) -> Result<()>

fn set_config(&mut self, config: u8) -> Result<TransferStatus>

pub fn submit_transfer( &mut self, fail_handle: Arc<dyn FailHandle>, job_queue: &Arc<AsyncJobQueue>, xhci_transfer: Arc<XhciTransfer>, usb_transfer: BackendTransferType ) -> Result<()>

pub fn submit_xhci_transfer(&mut self, transfer: XhciTransfer) -> Result<()>

Trait Implementations

impl AsRawDescriptor for BackendDeviceType

fn as_raw_descriptor(&self) -> RawDescriptor

Returns the underlying raw descriptor.

impl BackendDevice for BackendDeviceType

fn submit_backend_transfer( &mut self, transfer: BackendTransferType ) -> Result<BackendTransferHandle>

Submits a transfer to the specific backend implementation.

fn detach_event_handler(&self, event_loop: &Arc<EventLoop>) -> Result<()>

This is called by a generic backend provider when a USB detach message is received from the vm control socket. It detaches the backend device from the backend provider event loop.

fn request_transfer_buffer(&mut self, size: usize) -> TransferBuffer

Gets a buffer used for data transfer between the host and this device. The buffer returned by this function must be consumed by submit_backend_transfer().

fn build_bulk_transfer( &mut self, ep_addr: u8, transfer_buffer: TransferBuffer, stream_id: Option<u16> ) -> Result<BackendTransferType>

Requests the backend to build a backend-specific bulk transfer request

fn build_interrupt_transfer( &mut self, ep_addr: u8, transfer_buffer: TransferBuffer ) -> Result<BackendTransferType>

Requests the backend to build a backend-specific interrupt transfer request

fn get_control_transfer_state(&mut self) -> Arc<RwLock<ControlTransferState>>

Returns the ControlTransferState for the given backend device.

fn get_device_state(&mut self) -> Arc<RwLock<DeviceState>>

Returns the DeviceState for the given backend device. This state contains all the backend-agnostic state for all generic USB backends.

fn get_active_config_descriptor(&mut self) -> Result<ConfigDescriptorTree>

Gets the device active config descriptor tree.

fn get_config_descriptor(&mut self, config: u8) -> Result<ConfigDescriptorTree>

Gets a specific device config descriptor tree.

fn get_config_descriptor_by_index( &mut self, config_index: u8 ) -> Result<ConfigDescriptorTree>

Gets a specific device config descriptor tree by index.

fn get_device_descriptor_tree(&mut self) -> Result<DeviceDescriptorTree>

Gets the device descriptor tree.

fn get_active_configuration(&mut self) -> Result<u8>

Gets the device current active configuration.

fn set_active_configuration(&mut self, config: u8) -> Result<()>

Sets the device active configuration.

fn clear_feature(&mut self, value: u16, index: u16) -> Result<TransferStatus>

Handles a clear feature endpoint request for the given device.

fn create_endpoints( &mut self, config_descriptor: &ConfigDescriptorTree ) -> Result<()>

Creates endpoints for the device with the given config descriptor tree.

impl XhciBackendDevice for BackendDeviceType

fn get_backend_type(&self) -> BackendType

Returns the type of USB device provided by this device.

fn get_vid(&self) -> u16

Get vendor id of this device.

fn get_pid(&self) -> u16

Get product id of this device.

fn set_address(&mut self, address: UsbDeviceAddress)

Set address of this backend.

fn reset(&mut self) -> Result<()>

Reset the backend device.

fn get_speed(&self) -> Option<DeviceSpeed>

Get speed of this device.

fn alloc_streams(&self, ep: u8, num_streams: u16) -> Result<()>

Allocate streams for the endpoint

fn free_streams(&self, ep: u8) -> Result<()>

Free streams for the endpoint

fn stop(&mut self)

Stop the backend device, allowing it to execute cleanup routines.