Merge branch 'refactor/usb_host_examples_ext_hub_support' into 'master'

refactor(usb_host/examples): Enabled external Hub support feature Closes IDF-2635 See merge request espressif/esp-idf!30393
espressif · Oct 7, 2024 · a7cdabf · a7cdabf
2 parents d4c16ef + 3d07895
commit a7cdabf
Show file tree

Hide file tree

Showing 9 changed files with 258 additions and 152 deletions.
diff --git a/components/usb/test_apps/hcd/sdkconfig.defaults b/components/usb/test_apps/hcd/sdkconfig.defaults
@@ -6,3 +6,4 @@ CONFIG_HEAP_POISONING_COMPREHENSIVE=y
 # CONFIG_UNITY_ENABLE_FLOAT is not set
 # CONFIG_UNITY_ENABLE_DOUBLE is not set
 CONFIG_UNITY_ENABLE_BACKTRACE_ON_FAIL=y
+CONFIG_USB_HOST_HUBS_SUPPORTED=y
diff --git a/components/usb/test_apps/usb_host/sdkconfig.defaults b/components/usb/test_apps/usb_host/sdkconfig.defaults
@@ -6,3 +6,4 @@ CONFIG_HEAP_POISONING_COMPREHENSIVE=y
 # CONFIG_UNITY_ENABLE_FLOAT is not set
 # CONFIG_UNITY_ENABLE_DOUBLE is not set
 CONFIG_UNITY_ENABLE_BACKTRACE_ON_FAIL=y
+CONFIG_USB_HOST_HUBS_SUPPORTED=y
diff --git a/examples/peripherals/usb/host/cdc/cdc_acm_vcp/sdkconfig.defaults b/examples/peripherals/usb/host/cdc/cdc_acm_vcp/sdkconfig.defaults
@@ -2,3 +2,4 @@
 # Espressif IoT Development Framework (ESP-IDF) Project Minimal Configuration
 #
 CONFIG_COMPILER_CXX_EXCEPTIONS=y
+CONFIG_USB_HOST_HUBS_SUPPORTED=y
diff --git a/examples/peripherals/usb/host/hid/sdkconfig.defaults b/examples/peripherals/usb/host/hid/sdkconfig.defaults
@@ -0,0 +1,4 @@
+# This file was generated using idf.py save-defconfig. It can be edited manually.
+# Espressif IoT Development Framework (ESP-IDF) Project Minimal Configuration
+#
+CONFIG_USB_HOST_HUBS_SUPPORTED=y
diff --git a/examples/peripherals/usb/host/msc/main/msc_example_main.c b/examples/peripherals/usb/host/msc/main/msc_example_main.c
@@ -29,6 +29,11 @@ static const char *TAG = "example";
 #define APP_QUIT_PIN     GPIO_NUM_0 // BOOT button on most boards
 #define BUFFER_SIZE      4096       // The read/write performance can be improved with larger buffer for the cost of RAM, 4kB is enough for most usecases
 
+// IMPORTANT NOTE
+// MSC Class Driver is not fully support connecting devices through external Hub.
+// TODO: Remove this line after MSC Class Driver will support it
+static bool dev_present = false;
+
 /**
  * @brief Application Queue and its messages ID
  */
@@ -78,7 +83,7 @@ static void gpio_cb(void *arg)
 static void msc_event_cb(const msc_host_event_t *event, void *arg)
 {
     if (event->event == MSC_DEVICE_CONNECTED) {
-        ESP_LOGI(TAG, "MSC device connected");
+        ESP_LOGI(TAG, "MSC device connected (usb_addr=%d)", event->device.address);
         app_message_t message = {
             .id = APP_DEVICE_CONNECTED,
             .data.new_dev_address = event->device.address,
@@ -274,47 +279,56 @@ void app_main(void)
         xQueueReceive(app_queue, &msg, portMAX_DELAY);
 
         if (msg.id == APP_DEVICE_CONNECTED) {
-            // 1. MSC flash drive connected. Open it and map it to Virtual File System
-            ESP_ERROR_CHECK(msc_host_install_device(msg.data.new_dev_address, &msc_device));
-            const esp_vfs_fat_mount_config_t mount_config = {
-                .format_if_mount_failed = false,
-                .max_files = 3,
-                .allocation_unit_size = 8192,
-            };
-            ESP_ERROR_CHECK(msc_host_vfs_register(msc_device, MNT_PATH, &mount_config, &vfs_handle));
-
-            // 2. Print information about the connected disk
-            msc_host_device_info_t info;
-            ESP_ERROR_CHECK(msc_host_get_device_info(msc_device, &info));
-            msc_host_print_descriptors(msc_device);
-            print_device_info(&info);
-
-            // 3. List all the files in root directory
-            ESP_LOGI(TAG, "ls command output:");
-            struct dirent *d;
-            DIR *dh = opendir(MNT_PATH);
-            assert(dh);
-            while ((d = readdir(dh)) != NULL) {
-                printf("%s\n", d->d_name);
+            if (dev_present) {
+                ESP_LOGW(TAG, "MSC Example handles only one device at a time");
+            } else {
+                // 0. Change flag
+                dev_present = true;
+                // 1. MSC flash drive connected. Open it and map it to Virtual File System
+                ESP_ERROR_CHECK(msc_host_install_device(msg.data.new_dev_address, &msc_device));
+                const esp_vfs_fat_mount_config_t mount_config = {
+                    .format_if_mount_failed = false,
+                    .max_files = 3,
+                    .allocation_unit_size = 8192,
+                };
+                ESP_ERROR_CHECK(msc_host_vfs_register(msc_device, MNT_PATH, &mount_config, &vfs_handle));
+
+                // 2. Print information about the connected disk
+                msc_host_device_info_t info;
+                ESP_ERROR_CHECK(msc_host_get_device_info(msc_device, &info));
+                msc_host_print_descriptors(msc_device);
+                print_device_info(&info);
+
+                // 3. List all the files in root directory
+                ESP_LOGI(TAG, "ls command output:");
+                struct dirent *d;
+                DIR *dh = opendir(MNT_PATH);
+                assert(dh);
+                while ((d = readdir(dh)) != NULL) {
+                    printf("%s\n", d->d_name);
+                }
+                closedir(dh);
+
+                // 4. The disk is mounted to Virtual File System, perform some basic demo file operation
+                file_operations();
+
+                // 5. Perform speed test
+                speed_test();
+
+                ESP_LOGI(TAG, "Example finished, you can disconnect the USB flash drive");
             }
-            closedir(dh);
-
-            // 4. The disk is mounted to Virtual File System, perform some basic demo file operation
-            file_operations();
-
-            // 5. Perform speed test
-            speed_test();
-
-            ESP_LOGI(TAG, "Example finished, you can disconnect the USB flash drive");
         }
         if ((msg.id == APP_DEVICE_DISCONNECTED) || (msg.id == APP_QUIT)) {
-            if (vfs_handle) {
-                ESP_ERROR_CHECK(msc_host_vfs_unregister(vfs_handle));
-                vfs_handle = NULL;
-            }
-            if (msc_device) {
-                ESP_ERROR_CHECK(msc_host_uninstall_device(msc_device));
-                msc_device = NULL;
+            if (dev_present) {
+                dev_present = false;
+                if (vfs_handle) {
+                    ESP_ERROR_CHECK(msc_host_vfs_unregister(vfs_handle));
+                    vfs_handle = NULL;
+                }
+                if (msc_device) {
+                    ESP_ERROR_CHECK(msc_host_uninstall_device(msc_device));
+                    msc_device = NULL;
+                }
             }
             if (msg.id == APP_QUIT) {
                 // This will cause the usb_task to exit

diff --git a/examples/peripherals/usb/host/msc/sdkconfig.defaults b/examples/peripherals/usb/host/msc/sdkconfig.defaults
@@ -0,0 +1,4 @@
+# This file was generated using idf.py save-defconfig. It can be edited manually.
+# Espressif IoT Development Framework (ESP-IDF) Project Minimal Configuration
+#
+CONFIG_USB_HOST_HUBS_SUPPORTED=y