Struct usbd_human_interface_device::usb_class::UsbHidClass

pub struct UsbHidClass<'a, B, Devices> { /* private fields */ }

USB Human Interface Device class

Implementations

impl<'a, B, Devices: DeviceHList<'a>> UsbHidClass<'a, B, Devices>

pub fn device<T, Index>(&mut self) -> &mut T

where Devices: Selector<T, Index>,

Borrow a single device selected by T

pub fn devices(&'a mut self) -> <Devices as ToMut<'_>>::Output

Borrow an HList of all devices

pub fn tick(&mut self) -> Result<(), UsbHidError>

Provide a clock tick to allow the tracking of time. Call this every 1ms / at 1KHz

Trait Implementations

impl<'a, B, Devices> UsbClass<B> for UsbHidClass<'a, B, Devices>

where B: UsbBus + 'a, Devices: DeviceHList<'a>,

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: LangID) -> Option<&str>

Gets a class-specific string descriptor.

fn reset(&mut self)

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

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

Called when a control request is received with direction HostToDevice.

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

Called when a control request is received with direction DeviceToHost.

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

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.

fn endpoint_out(&mut self, addr: EndpointAddress)

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

fn endpoint_in_complete(&mut self, addr: EndpointAddress)

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

fn get_alt_setting(&mut self, interface: InterfaceNumber) -> Option<u8>

Called when the interfaces alternate setting state is requested.

fn set_alt_setting( &mut self, interface: InterfaceNumber, alternative: u8 ) -> bool

Called when the interfaces alternate setting state is altered.