Struct usbd_mass_storage::MscClass

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

USB Mass Storage Class Device

So far only tested with the Bulk Only protocol and the SCSI transparent command set - see Scsi and Bulk Only Transport

Methods

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

pub fn new(
    alloc: &UsbBusAllocator<B>,
    max_packet_size: u16,
    subclass: InterfaceSubclass,
    protocol: InterfaceProtocol
) -> MscClass<B>

pub fn max_packet_size(&self) -> u16

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

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

pub fn correct_interface_number(&self, interface_number: u16) -> bool

Trait Implementations

impl<'_, B: UsbBus> UsbClass<B> for MscClass<'_, 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 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).