Struct usbd_hid::hid_class::HIDClass

pub struct HIDClass<'a, B: UsbBus> { /* fields omitted */ }

Controller for HID communications on a pair of endpoints.

TODO details.

Methods

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

pub fn new<'a>(
    alloc: &'a UsbBusAllocator<B>,
    desc: &'static [u8]
) -> HIDClass<'a, B>

Creates a new HIDClass with the provided UsbBus.

Trait Implementations

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

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 reset(&mut self)

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

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 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 get_string(&self, index: StringIndex, lang_id: u16) -> Option<&str>

Gets a class-specific string descriptor.

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.