USB interface descriptors

The following structures provide predefined USB interface descriptors.

Common APIs used by high level application to use this USB class.

It must be used to define the final USB descriptors.

These routines are used by memory to transfer its data to/from USB MSC endpoints.

See Quick start guide for USB device Mass Storage module (UDI MSC).

Modules
	Related Project(s)
	In this section you can find all the projects related to the USB interface descriptors.
	Quick Start Guide(s)
	In this section you can find a list of all Quick Start guides related to the USB interface descriptors.
	Interface with USB Device Core (UDC)
	Structures and functions required by UDC.
	Implementation of UDI MSC
	Class internal implementation.

Data Structures
struct	udi_msc_desc_t
	Interface descriptor structure for MSC. More...

Macros
#define	UDI_MSC_DESC
	Content of MSC interface descriptor for all speeds. More...
#define	UDI_MSC_DESC_FS
	Content of MSC interface descriptor for full speed only. More...
#define	UDI_MSC_DESC_HS
	Content of MSC interface descriptor for high speed only. More...
#define	UDI_MSC_EPS_SIZE_FS   64
	MSC endpoints size for full speed. More...
#define	UDI_MSC_EPS_SIZE_HS   512
	MSC endpoints size for high speed. More...
#define	UDI_MSC_STRING_ID   0
	By default no string associated to this interface. More...

Functions
bool	udi_msc_process_trans (void)
	Process the background read/write commands. More...
bool	udi_msc_trans_block (bool b_read, uint8_t *block, iram_size_t block_size, void(*callback)(udd_ep_status_t status, iram_size_t n, udd_ep_id_t ep))
	Transfers data to/from USB MSC endpoints. More...

#define UDI_MSC_DESC

Value:

.iface.bLength             = sizeof(usb_iface_desc_t),\
   .iface.bDescriptorType     = USB_DT_INTERFACE,\
   .iface.bInterfaceNumber    = UDI_MSC_IFACE_NUMBER,\
   .iface.bAlternateSetting   = 0,\
   .iface.bNumEndpoints       = 2,\
   .iface.bInterfaceClass     = MSC_CLASS,\
   .iface.bInterfaceSubClass  = MSC_SUBCLASS_TRANSPARENT,\
   .iface.bInterfaceProtocol  = MSC_PROTOCOL_BULK,\
   .iface.iInterface          = UDI_MSC_STRING_ID,\
   .ep_in.bLength             = sizeof(usb_ep_desc_t),\
   .ep_in.bDescriptorType     = USB_DT_ENDPOINT,\
   .ep_in.bEndpointAddress    = UDI_MSC_EP_IN,\
   .ep_in.bmAttributes        = USB_EP_TYPE_BULK,\
   .ep_in.bInterval           = 0,\
   .ep_out.bLength            = sizeof(usb_ep_desc_t),\
   .ep_out.bDescriptorType    = USB_DT_ENDPOINT,\
   .ep_out.bEndpointAddress   = UDI_MSC_EP_OUT,\
   .ep_out.bmAttributes       = USB_EP_TYPE_BULK,\
   .ep_out.bInterval          = 0,

Content of MSC interface descriptor for all speeds.

#define UDI_MSC_DESC_FS

Value:

{\
   UDI_MSC_DESC \
   .ep_in.wMaxPacketSize      = LE16(UDI_MSC_EPS_SIZE_FS),\
   .ep_out.wMaxPacketSize     = LE16(UDI_MSC_EPS_SIZE_FS),\
   }

Content of MSC interface descriptor for full speed only.

#define UDI_MSC_DESC_HS

Value:

{\
   UDI_MSC_DESC \
   .ep_in.wMaxPacketSize      = LE16(UDI_MSC_EPS_SIZE_HS),\
   .ep_out.wMaxPacketSize     = LE16(UDI_MSC_EPS_SIZE_HS),\
   }

Content of MSC interface descriptor for high speed only.

#define UDI_MSC_EPS_SIZE_FS   64

MSC endpoints size for full speed.

#define UDI_MSC_EPS_SIZE_HS   512

MSC endpoints size for high speed.

#define UDI_MSC_STRING_ID   0

By default no string associated to this interface.

Referenced by main_extra_string().

bool udi_msc_process_trans

(

void

)

Process the background read/write commands.

Routine called by the main loop

References CTRL_BUSY, CTRL_FAIL, CTRL_GOOD, CTRL_NO_PRESENT, memory_2_usb(), udi_msc_csw_process(), udi_msc_sense_fail_busy_or_change(), udi_msc_sense_fail_hardware(), udi_msc_sense_fail_not_present(), udi_msc_sense_pass(), and usb_2_memory().

Referenced by main(), and run_usb_msc_test().

bool udi_msc_trans_block	(	bool	b_read,
		uint8_t *	block,
		iram_size_t	block_size,
		void(*)(udd_ep_status_t status, iram_size_t n, udd_ep_id_t ep)	callback
	)

Transfers data to/from USB MSC endpoints.

Parameters

b_read	Memory to USB, if true
block	Buffer on Internal RAM to send or fill
block_size	Buffer size to send or fill
callback	Function to call at the end of transfer. If NULL then the routine exit when transfer is finish.

Returns

1 if function was successfully done, otherwise 0.

References callback, NULL, udd_ep_run(), UDI_MSC_EP_IN, UDI_MSC_EP_OUT, and udi_msc_trans_ack().

Referenced by sd_mmc_usb_read_10(), sd_mmc_usb_write_10(), and virtual_usb_trans().