Struct usb_device::test_class::TestClass

pub struct TestClass<'a, B: UsbBus> { /* private fields */ }

Test USB class for testing USB driver implementations. Supports various endpoint types and requests for testing USB peripheral drivers on actual hardware.

Implementations

impl<B: UsbBus> TestClass<'_, B>

pub fn new(alloc: &UsbBusAllocator<B>) -> TestClass<'_, B>

Creates a new TestClass.

pub fn make_device<'a, 'b>(
    &'a self,
    usb_bus: &'b UsbBusAllocator<B>
) -> UsbDevice<'b, B>

Convenience method to create a UsbDevice that is configured correctly for TestClass.

pub fn make_device_builder<'a, 'b>(
    &'a self,
    usb_bus: &'b UsbBusAllocator<B>
) -> UsbDeviceBuilder<'b, B>

Convenience method to create a UsbDeviceBuilder that is configured correctly for TestClass.

The methods sets

• manufacturer
• product
• serial number
• max_packet_size_0

on the returned builder. If you change the manufacturer, product, or serial number fields, the test host may misbehave.

pub fn poll(&mut self)

Must be called after polling the UsbDevice.

Trait Implementations

impl<B: UsbBus> UsbClass<B> for TestClass<'_, B>

fn reset(&mut self)

Called after a USB reset after the bus reset sequence is complete.

fn get_configuration_descriptors(
    &self,
    writer: &mut DescriptorWriter<'_>
) -> Result<()>

Called when a GET_DESCRIPTOR request is received for a configuration descriptor. When called, the implementation should write its interface, endpoint and any extra class descriptors into writer. The configuration descriptor itself will be written by UsbDevice and shouldn’t be written by classes.

fn get_string(&self, index: StringIndex, lang_id: u16) -> Option<&str>

Gets a class-specific string descriptor.

fn endpoint_in_complete(&mut self, addr: EndpointAddress)

Called when endpoint with address addr has completed transmitting data (IN packet).

fn endpoint_out(&mut self, addr: EndpointAddress)

Called when endpoint with address addr has received data (OUT packet).

fn control_in(&mut self, xfer: ControlIn<'_, '_, '_, B>)

Called when a control request is received with direction DeviceToHost.

fn control_out(&mut self, xfer: ControlOut<'_, '_, '_, B>)

Called when a control request is received with direction HostToDevice.

fn get_bos_descriptors(&self, writer: &mut BosWriter<'_, '_>) -> Result<()>

Called when a GET_DESCRIPTOR request is received for a BOS descriptor. When called, the implementation should write its blobs such as capability descriptors into writer. The BOS descriptor itself will be written by UsbDevice and shouldn’t be written by classes.

fn poll(&mut self)

Called whenever the UsbDevice is polled.

fn endpoint_setup(&mut self, addr: EndpointAddress)

Called when endpoint with address addr has received a SETUP packet. Implementing this shouldn’t be necessary in most cases, but is provided for completeness’ sake.