Struct usbd_scsi::Scsi

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

Scsi Transparent Command Set implementation

Built on top of BulkOnlyTransport

Glossary

Methods

impl<'_, B: UsbBus, BD: BlockDevice> Scsi<'_, B, BD>

pub fn new<V: AsRef<[u8]>, P: AsRef<[u8]>, R: AsRef<[u8]>>(
    alloc: &UsbBusAllocator<B>,
    max_packet_size: u16,
    block_device: BD,
    vendor_identification: V,
    product_identification: P,
    product_revision_level: R
) -> Scsi<B, BD>

Creates a new Scsi block device

block_device provides reading and writing of blocks to the underlying filesystem vendor_identification is an ASCII string that forms part of the SCSI inquiry response. Should come from t10. Any semi-unique non-blank string should work fine for local development. Panics if > 8 characters are supplied. product_identification is an ASCII string that forms part of the SCSI inquiry response. Vendor (probably you...) defined so pick whatever you want. Panics if > 16 characters are supplied. product_revision_level is an ASCII string that forms part of the SCSI inquiry response. Vendor (probably you...) defined so pick whatever you want. Typically a version number. Panics if > 4 characters are supplied.

Trait Implementations

impl<'_, B: UsbBus, BD: BlockDevice> UsbClass<B> for Scsi<'_, B, BD>

fn get_configuration_descriptors(
    &self,
    writer: &mut DescriptorWriter
) -> UsbResult<()>

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

Gets a class-specific string descriptor.

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