Struct devices::usb::backend::fido_backend::fido_passthrough::FidoPassthroughDevice

pub struct FidoPassthroughDevice {
    device: Arc<Mutex<FidoDevice>>,
    state: Arc<RwLock<DeviceState>>,
    control_transfer_state: Arc<RwLock<ControlTransferState>>,
    transfer_job_queue: Arc<AsyncJobQueue>,
    kill_evt: Event,
    worker_thread: Option<WorkerThread<()>>,
    pending_in_transfers: Arc<Mutex<VecDeque<(FidoTransferHandle, Arc<Mutex<Option<FidoTransfer>>>)>>>,
}

Host-level fido passthrough device that handles USB operations and relays them to the appropriate virtual fido device.

Fields

device: Arc<Mutex<FidoDevice>>

The virtual FIDO device implementation.

state: Arc<RwLock<DeviceState>>

The state of the device as seen by the backend provider.

control_transfer_state: Arc<RwLock<ControlTransferState>>

The state of the control transfer exchange with the xhci layer.

transfer_job_queue: Arc<AsyncJobQueue>

kill_evt: Event

worker_thread: Option<WorkerThread<()>>

pending_in_transfers: Arc<Mutex<VecDeque<(FidoTransferHandle, Arc<Mutex<Option<FidoTransfer>>>)>>>

Implementations

impl FidoPassthroughDevice

pub fn new( device: Arc<Mutex<FidoDevice>>, state: DeviceState, event_loop: Arc<EventLoop> ) -> Result<Self>

pub fn read_hidraw_file(&mut self) -> Result<()>

This function is called from the low-level event handler when the monitored fd is ready to transmit data from the host to the guest.

pub fn handle_control( transfer: &mut FidoTransfer, device: &Arc<Mutex<FidoDevice>> ) -> Result<()>

This function is called by a queued job to handle all communication related to USB control transfer packets between the guest and the virtual security key.

pub fn handle_interrupt_out( transfer: &mut FidoTransfer, device: &Arc<Mutex<FidoDevice>> ) -> Result<()>

This function is called by a queued job to handle all USB OUT requests from the guest down to the host by writing the given FidoTransfer data into the hidraw file.

Trait Implementations

impl AsRawDescriptor for FidoPassthroughDevice

fn as_raw_descriptor(&self) -> RawDescriptor

Returns the underlying raw descriptor.

impl BackendDevice for FidoPassthroughDevice

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

Submits a transfer to the specific backend implementation.

fn detach_event_handler( &self, _event_loop: &Arc<EventLoop> ) -> BackendResult<()>

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> ) -> BackendResult<BackendTransferType>

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

fn build_interrupt_transfer( &mut self, ep_addr: u8, transfer_buffer: TransferBuffer ) -> BackendResult<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 ) -> BackendResult<ConfigDescriptorTree>

Gets the device active config descriptor tree.

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

Gets a specific device config descriptor tree.

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

Gets a specific device config descriptor tree by index.

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

Gets the device descriptor tree.

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

Gets the device current active configuration.

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

Sets the device active configuration.

fn clear_feature( &mut self, _value: u16, _index: u16 ) -> BackendResult<TransferStatus>

Handles a clear feature endpoint request for the given device.

fn create_endpoints( &mut self, _config_descriptor: &ConfigDescriptorTree ) -> BackendResult<()>

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

impl Drop for FidoPassthroughDevice

fn drop(&mut self)

Executes the destructor for this type.

impl XhciBackendDevice for FidoPassthroughDevice

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) -> BackendResult<()>

Reset the backend device.

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

Get speed of this device.

fn alloc_streams(&self, _ep: u8, _num_streams: u16) -> BackendResult<()>

Allocate streams for the endpoint

fn free_streams(&self, _ep: u8) -> BackendResult<()>

Free streams for the endpoint

fn stop(&mut self)

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