Struct usbd_dfu::class::DFUClass

pub struct DFUClass<B: UsbBus, M: DFUMemIO> { /* fields omitted */ }

DFU protocol USB class implementation for usb-device library.

Implementations

impl<B: UsbBus, M: DFUMemIO> DFUClass<B, M>

pub fn new(alloc: &UsbBusAllocator<B>, mem: M) -> Self

Creates a new DFUClass with the provided UsbBus and DFUMemIO

pub fn set_unexpected_reset_state(&mut self)

This function may be called just after DFUClass::new() to set DFU error state to “Device detected unexpected power on reset” instead of the usual dfuIdle.

pub fn set_firmware_corrupted_state(&mut self)

This function may be called just after DFUClass::new() to set DFU error state to “Device’s firmware is corrupt. It cannot return to run-time (non-DFU) operations” instead of the usual dfuIdle.

pub fn get_address_pointer(&self) -> u32

Return current Address Pointer value.

Trait Implementations

impl<B: UsbBus, M: DFUMemIO> UsbClass<B> for DFUClass<B, M>

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

Called whenever the UsbDevice is polled.

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.

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