Struct keyberon::hid::HidClass

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

Implementations

impl<B: UsbBus, D: HidDevice, '_> HidClass<'_, B, D>

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

pub fn device_mut(&mut self) -> &mut D

pub fn write(&mut self, data: &[u8]) -> Result<usize, ()>

Trait Implementations

impl<B: UsbBus, D: HidDevice, '_> UsbClass<B> for HidClass<'_, B, D>

fn poll(&mut self)

Called whenever the UsbDevice is polled.

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<(), 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 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.