esp-idf/examples/peripherals/usb/host/msc
Darian Leung 1aad12468a usb: Hub Driver Update and Refactor
Hub Driver is refactored as follows:

This commit update and refactors the Hub Driver as follows:

- Refactored enumeration state machine and stage functions
    - Enumeration stage is now incremented
    - Combined transfer stages of enumeration into common functions
- Comments updated
- Fixed usbh_hal_disable_debounce_lock() that would cause root_port_handle_events()
    to fail the HCD_PORT_CMD_RESET call because the previous port connection interrupt
    was not cleared.

The following features were added to the Hub Driver

- Enumeration config descriptor is now fetched in two separate stages
    - Header is fetched first to determine the wTotalLength of the descriptor
    - Fetching the full descriptor will request exactly wTotalLength bytes
    - This works around some non-compliant devices that will babble/return zero
        when requesting a length > wTotalLength
    - Closes https://github.com/espressif/esp-idf/issues/7799
- Enumeration now stores string descriptors
    - The Manufacturer, Product, and Serial Number string descriptors are
        now read and stored during enumeration
    - String descriptors are now part of usb_device_info_t
- Added unit test to test enumeration
2022-01-06 15:11:13 +08:00
..
components/msc usb: Hub Driver Update and Refactor 2022-01-06 15:11:13 +08:00
main usb: USB Host stack uses USB PHY driver 2022-01-06 15:09:39 +08:00
CMakeLists.txt USB: added MSC Host Driver with VFS support 2021-12-20 12:39:45 +01:00
README.md USB: added MSC Host Driver with VFS support 2021-12-20 12:39:45 +01:00

Supported Targets ESP32-S2 ESP32-S3

USB Mass Storage Class example

Overview

This example demonstrates usage of Mass Storage Class to get access to storage on USB memory stick. Example caries out read and write file operations, as USB storage is mounted to Virtual filesystem.

Hardware Required

  • Development board with USB capable ESP SoC (ESP32-S2/ESP32-S3)
  • A USB cable for Power supply and programming
  • A USB memory stick

Common Pin Assignments

If your board doesn't have a USB A connector connected to the dedicated GPIOs, you may have to DIY a cable and connect D+ and D- to the pins listed below.

ESP BOARD    USB CONNECTOR (type A)
                   --
                  | || VCC
[GPIO19]  ------> | || D-
[GPIO20]  ------> | || D+
                  | || GND
                   --

Build and Flash

Build the project and flash it to the board, then run monitor tool to view serial output:

idf.py -p PORT flash monitor

(To exit the serial monitor, type Ctrl-].)

See the Getting Started Guide for full steps to configure and use ESP-IDF to build projects.

Example Output

...
I (274) cpu_start: Starting scheduler on PRO CPU.
I (339) APP: Waiting for USB stick to be connected
Device info:
         PID: 0x5678 
         VID: 0xFFFF 
         iProduct: Disk 2.0 
         iManufacturer: USB 
         iSerialNumber: 92072836B2589224378 
I (719) APP: Writing file
I (749) APP: Reading file
I (749) APP: Read from file: 'Hello World!'
I (759) APP: Done