Struct usbd_dfu_rt::class::DfuRuntimeClass

pub struct DfuRuntimeClass<T: DfuRuntimeOps> { /* private fields */ }

Implementation of DFU runtime class.

This class provides thin framework for implementing DFU runtime functionality. When DFU_DETACH request is received, it will be accepted and DfuRuntimeOps::detach will be called (unless DfuRuntimeOps::allow returned false which rejects the request).

Implementations

impl<T: DfuRuntimeOps> DfuRuntimeClass<T>

pub fn new<B: UsbBus>(alloc: &UsbBusAllocator<B>, ops: T) -> Self

Crate new DFU run-time class with the given device-specific implementations.

pub fn tick(&mut self, elapsed_time_ms: u16)

Advance time

Should be called regularly, passing the time in milliseconds that has elapsed since the previous call to this function.

pub fn ops(&self) -> &T

Get reference to DfuRuntimeOps

pub fn ops_mut(&mut self) -> &mut T

Get mutable reference to DfuRuntimeOps

pub fn interface(&self) -> InterfaceNumber

Get class interface number

Trait Implementations

impl<T: DfuRuntimeOps, B: UsbBus> UsbClass<B> for DfuRuntimeClass<T>

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

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

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 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.

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