USB Device MSC API#

sl_usbd_msc_init#

sl_status_t sl_usbd_msc_init (void )

FUNCTION PROTOTYPES.

CONFIGURATION OVERRIDE FUNCTIONS MSC FUNCTIONS

Initialize internal structures and variables used by the Mass Storage Class Bulk Only Transport.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

sl_usbd_msc_create_instance#

sl_status_t sl_usbd_msc_create_instance (uint8_t subclass, uint32_t msc_task_stack_size, osPriority_t msc_task_priority, sl_usbd_msc_subclass_driver_t * p_subclass_drv, void * p_subclass_arg, uint8_t * p_class_nbr)

Add a new instance of the Mass Storage Class.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

sl_usbd_msc_add_to_configuration#

sl_status_t sl_usbd_msc_add_to_configuration (uint8_t class_nbr, uint8_t config_nbr)

Add an existing MSC instance to the specified configuration.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

Note

• (1) sl_usbd_msc_add_to_configuration() adds an Interface descriptor and its associated Endpoint descriptor(s) to the Configuration descriptor. One call to sl_usbd_msc_add_to_configuration() builds the Configuration descriptor corresponding to an MSC device with the following format:

  *               Configuration Descriptor
  *               |-- Interface Descriptor (MSC)
  *               |-- Endpoint Descriptor (Bulk OUT)
  *               |-- Endpoint Descriptor (Bulk IN)
  *               

  If sl_usbd_msc_add_to_configuration() is called several times from the application, it creates multiple instances and configurations. For example, the following architecture could be created for a high-speed device:

  *               High-speed
  *               |-- Configuration 0
  *               |-- Interface 0 (MSC 0)
  *               |-- Configuration 1
  *               |-- Interface 0 (MSC 0)
  *               |-- Interface 1 (MSC 1)
  *               

  In this example, there are two instances of MSC: 'MSC 0' and 'MSC 1', and two possible configurations for the device: 'Configuration 0' and 'Configuration 1'. 'Configuration 1' is composed of two interfaces.
  Each class instance has an association with one of the interfaces. If 'Configuration 1' is activated by the host, it allows the host to access two different functionalities offered by the device.

sl_usbd_msc_lun_add#

sl_status_t sl_usbd_msc_lun_add (uint8_t class_nbr, void * p_lu_data, uint8_t * p_lu_nbr)

Add an MSC logical unit to the MSC interface.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

sl_usbd_msc_is_enabled#

sl_status_t sl_usbd_msc_is_enabled (uint8_t class_nbr, bool * p_enabled)

Get the MSC enable state of the device.

Returns

• Returns SL_STATUS_OK on success or another SL_STATUS code on failure.

SL_USBD_MSC_LU_NBR_INVALID#

#define SL_USBD_MSC_LU_NBR_INVALID

255u

MODULE.

INCLUDE FILES MACROS

SL_USBD_MSC_SUBCLASS_CODE_RBC#

#define SL_USBD_MSC_SUBCLASS_CODE_RBC

0x01

SUBCLASS CODES.

Note(s) : (1) See 'USB Mass Storage Class Specification Overview', Revision 1.2, Section 2

SL_USBD_MSC_SUBCLASS_CODE_SFF_8020i#

#define SL_USBD_MSC_SUBCLASS_CODE_SFF_8020i

0x02

SL_USBD_MSC_SUBCLASS_CODE_MMC_2#

#define SL_USBD_MSC_SUBCLASS_CODE_MMC_2

0x02

SL_USBD_MSC_SUBCLASS_CODE_QIC_157#

#define SL_USBD_MSC_SUBCLASS_CODE_QIC_157

0x03

SL_USBD_MSC_SUBCLASS_CODE_UFI#

#define SL_USBD_MSC_SUBCLASS_CODE_UFI

0x04

SL_USBD_MSC_SUBCLASS_CODE_SFF_8070i#

#define SL_USBD_MSC_SUBCLASS_CODE_SFF_8070i

0x05

SL_USBD_MSC_SUBCLASS_CODE_SCSI#

#define SL_USBD_MSC_SUBCLASS_CODE_SCSI

0x06

SL_USBD_MSC_PROTOCOL_CODE_CTRL_BULK_INTR_CMD_INTR#

#define SL_USBD_MSC_PROTOCOL_CODE_CTRL_BULK_INTR_CMD_INTR

0x00

PROTOCOL CODES.

Note(s) : (1) See 'USB Mass Storage Class Specification Overview', Revision 1.2, Section 3

SL_USBD_MSC_PROTOCOL_CODE_CTRL_BULK_INTR#

#define SL_USBD_MSC_PROTOCOL_CODE_CTRL_BULK_INTR

0x01

SL_USBD_MSC_PROTOCOL_CODE_BULK_ONLY#

#define SL_USBD_MSC_PROTOCOL_CODE_BULK_ONLY

0x50