feat(usb_device_uac): support integration into other tinyusb projects

lijunru-hub · lijunru-hub · commit 8aecb33a7f40 · 2025-04-25T14:24:38.000+08:00
diff --git a/components/usb/usb_device_uac/CHANGELOG.md b/components/usb/usb_device_uac/CHANGELOG.md
@@ -1,5 +1,9 @@
 # ChangeLog
 
+## v1.2.0 (2025-3-31)
+
+* Supports integration into other TinyUSB projects.
+
 ## v1.1.0 (2025-1-15)
 
 * Use espressif/tinyusb: 0.17.2
diff --git a/components/usb/usb_device_uac/CMakeLists.txt b/components/usb/usb_device_uac/CMakeLists.txt
@@ -2,18 +2,19 @@ idf_component_register(SRCS usb_device_uac.c
                     INCLUDE_DIRS "include"
                     PRIV_REQUIRES usb esp_timer)
 
+if(NOT CONFIG_USB_DEVICE_UAC_AS_PART)
+        # Determine whether tinyusb is fetched from component registry or from local path
+    idf_build_get_property(build_components BUILD_COMPONENTS)
+    if(tinyusb IN_LIST build_components)
+        set(tinyusb_name tinyusb) # Local component
+    else()
+        set(tinyusb_name espressif__tinyusb) # Managed component
+    endif()
 
-# Determine whether tinyusb is fetched from component registry or from local path
-idf_build_get_property(build_components BUILD_COMPONENTS)
-if(tinyusb IN_LIST build_components)
-    set(tinyusb_name tinyusb) # Local component
-else()
-    set(tinyusb_name espressif__tinyusb) # Managed component
+    idf_component_get_property(tusb_lib ${tinyusb_name} COMPONENT_LIB)
+    target_include_directories(${tusb_lib} PUBLIC "${COMPONENT_DIR}/tusb" "${COMPONENT_DIR}/tusb_uac")
+    target_sources(${tusb_lib} PUBLIC "${COMPONENT_DIR}/tusb/usb_descriptors.c")
 endif()
 
-idf_component_get_property(tusb_lib ${tinyusb_name} COMPONENT_LIB)
-target_include_directories(${tusb_lib} PUBLIC "${COMPONENT_DIR}/tusb")
-target_sources(${tusb_lib} PUBLIC "${COMPONENT_DIR}/tusb/usb_descriptors.c")
-
 include(package_manager)
 cu_pkg_define_version(${CMAKE_CURRENT_LIST_DIR})
diff --git a/components/usb/usb_device_uac/Kconfig b/components/usb/usb_device_uac/Kconfig
@@ -1,39 +1,41 @@
 menu "USB Device UAC Configuration"
 
-    config TUSB_VID
-        hex "USB Device VID"
-        default 0x303A
-
-    config TUSB_PID
-        hex "USB Device PID"
-        default 0x8000
-
-    config TUSB_MANUFACTURER
-        string "USB Device Manufacture"
-        default "Espressif"
-
-    config TUSB_PRODUCT
-        string "Product Name"
-        default "ESP UAC Device"
-
-    config TUSB_SERIAL_NUM
-        string "Product ID"
-        default "12345678"
-
-    choice TINYUSB_RHPORT
-        prompt "TinyUSB Root Port"
-        default TINYUSB_RHPORT_HS if IDF_TARGET_ESP32P4
-        default TINYUSB_RHPORT_FS
-        help
-            Allows set the USB PHY Controller for TinyUSB: HS (USB OTG2.0 PHY for HighSpeed)
-
-        config TINYUSB_RHPORT_HS
-            depends on IDF_TARGET_ESP32P4
-            bool "High Speed"
-
-        config TINYUSB_RHPORT_FS
-            bool "Full Speed"
-    endchoice
+    if !USB_DEVICE_UAC_AS_PART
+        config UAC_TUSB_VID
+            hex "USB Device VID"
+            default 0x303A
+
+        config UAC_TUSB_PID
+            hex "USB Device PID"
+            default 0x8000
+
+        config UAC_TUSB_MANUFACTURER
+            string "USB Device Manufacture"
+            default "Espressif"
+
+        config UAC_TUSB_PRODUCT
+            string "Product Name"
+            default "ESP UAC Device"
+
+        config UAC_TUSB_SERIAL_NUM
+            string "Product ID"
+            default "12345678"
+
+        choice TINYUSB_RHPORT
+            prompt "TinyUSB Root Port"
+            default TINYUSB_RHPORT_HS if IDF_TARGET_ESP32P4
+            default TINYUSB_RHPORT_FS
+            help
+                Allows set the USB PHY Controller for TinyUSB: HS (USB OTG2.0 PHY for HighSpeed)
+
+            config TINYUSB_RHPORT_HS
+                depends on IDF_TARGET_ESP32P4
+                bool "High Speed"
+
+            config TINYUSB_RHPORT_FS
+                bool "Full Speed"
+        endchoice
+    endif
 
     # Insert UAC config
     orsource "./Kconfig.uac"
diff --git a/components/usb/usb_device_uac/Kconfig.uac b/components/usb/usb_device_uac/Kconfig.uac
@@ -1,5 +1,11 @@
 menu "USB Device UAC"
 
+    config USB_DEVICE_UAC_AS_PART
+        bool "Using customer tinyusb configs and descriptors"
+        default n
+        help
+            If enable this feature, will need to write the `tusb_config.h` and `usb_descriptors.c` files in the project.
+
     config UAC_SPEAKER_CHANNEL_NUM
         int "UAC Speaker channel number"
         range 0 8
diff --git a/components/usb/usb_device_uac/idf_component.yml b/components/usb/usb_device_uac/idf_component.yml
@@ -1,4 +1,4 @@
-version: "1.1.0"
+version: "1.2.0"
 targets:
   - esp32s2
   - esp32s3
diff --git a/components/usb/usb_device_uac/include/usb_device_uac.h b/components/usb/usb_device_uac/include/usb_device_uac.h
@@ -30,6 +30,10 @@ typedef struct  {
     uac_set_mute_cb_t set_mute_cb;               /*!< callback function for set mute, if NULL, the set mute request will be ignored */
     uac_set_volume_cb_t set_volume_cb;           /*!< callback function for set volume, if NULL, the set volume request will be ignored */
     void *cb_ctx;                                /*!< callback context, for user specific usage */
+#if CONFIG_USB_DEVICE_UAC_AS_PART
+    int spk_itf_num;                             /*!< If CONFIG_USB_DEVICE_UAC_AS_PART is enabled, you need to provide the speaker interface number */
+    int mic_itf_num;                             /*!< If CONFIG_USB_DEVICE_UAC_AS_PART is enabled, you need to provide the mic interface number */
+#endif
 } uac_device_config_t;
 
 /**
diff --git a/components/usb/usb_device_uac/tusb/usb_descriptors.c b/components/usb/usb_device_uac/tusb/usb_descriptors.c
@@ -42,8 +42,8 @@ tusb_desc_device_t const desc_device = {
     .bDeviceProtocol    = MISC_PROTOCOL_IAD,
     .bMaxPacketSize0    = CFG_TUD_ENDPOINT0_SIZE,
 
-    .idVendor           = CONFIG_TUSB_VID,
-    .idProduct          = CONFIG_TUSB_PID,
+    .idVendor           = CONFIG_UAC_TUSB_VID,
+    .idProduct          = CONFIG_UAC_TUSB_PID,
     .bcdDevice          = 0x0100,
 
     .iManufacturer      = 0x01,
@@ -91,9 +91,9 @@ uint8_t const *tud_descriptor_configuration_cb(uint8_t index)
 // array of pointer to string descriptors
 char const *string_desc_arr [] = {
     (const char[]) { 0x09, 0x04 },  // 0: is supported language is English (0x0409)
-    CONFIG_TUSB_MANUFACTURER,       // 1: Manufacturer
-    CONFIG_TUSB_PRODUCT,            // 2: Product
-    CONFIG_TUSB_SERIAL_NUM,         // 3: Serials, should use chip ID
+    CONFIG_UAC_TUSB_MANUFACTURER,       // 1: Manufacturer
+    CONFIG_UAC_TUSB_PRODUCT,            // 2: Product
+    CONFIG_UAC_TUSB_SERIAL_NUM,         // 3: Serials, should use chip ID
     "usb uac",                      // 4: UAC control Interface
 #if SPEAK_CHANNEL_NUM
     "speaker",                     // 5: Speak Interface
diff --git a/components/usb/usb_device_uac/tusb_uac/tusb_config_uac.h b/components/usb/usb_device_uac/tusb_uac/tusb_config_uac.h
diff --git a/components/usb/usb_device_uac/tusb_uac/uac_config.h b/components/usb/usb_device_uac/tusb_uac/uac_config.h
diff --git a/components/usb/usb_device_uac/tusb_uac/uac_descriptors.h b/components/usb/usb_device_uac/tusb_uac/uac_descriptors.h
@@ -30,7 +30,9 @@ extern "C" {
 #endif
 
 #include "uac_config.h"
+#include "sdkconfig.h"
 
+#if !CONFIG_USB_DEVICE_UAC_AS_PART
 enum {
     ITF_NUM_AUDIO_CONTROL = 0,
 #if SPEAK_CHANNEL_NUM
@@ -41,6 +43,7 @@ enum {
 #endif // MIC_CHANNEL_NUM
     ITF_NUM_TOTAL
 };
+#endif
 
 // Unit numbers are arbitrary selected
 #define UAC2_ENTITY_CLOCK                0x04
diff --git a/components/usb/usb_device_uac/usb_device_uac.c b/components/usb/usb_device_uac/usb_device_uac.c
@@ -54,6 +54,8 @@ typedef struct {
     int16_t *mic_buf_read;                                       // Pointer to the buffer to read from
     int spk_data_size;                                           // Speaker data size received in the last frame
     int mic_data_size;
+    int spk_itf_num;
+    int mic_itf_num;
     uint8_t spk_resolution;
     uint8_t mic_resolution;
     uint32_t current_sample_rate;                                // Current resolution, update on format change
@@ -91,6 +93,7 @@ static void tusb_device_task(void *arg)
     }
 }
 
+#if !CONFIG_USB_DEVICE_UAC_AS_PART
 // Invoked when device is mounted
 void tud_mount_cb(void)
 {
@@ -106,7 +109,7 @@ void tud_umount_cb(void)
 }
 
 // Invoked when usb bus is suspended
-// remote_wakeup_en : if host allow us  to perform remote wakeup
+// remote_wakeup_en : if host allow us to perform remote wakeup
 // Within 7ms, device must draw an average of current less than 2.5 mA from bus
 void tud_suspend_cb(bool remote_wakeup_en)
 {
@@ -121,6 +124,7 @@ void tud_resume_cb(void)
 {
     ESP_LOGI(TAG, "USB resumed");
 }
+#endif
 
 // Helper for clock get requests
 static bool tud_audio_clock_get_request(uint8_t rhport, audio_control_request_t const *request)
@@ -309,15 +313,15 @@ bool tud_audio_set_itf_close_EP_cb(uint8_t rhport, tusb_control_request_t const
     uint8_t const alt = tu_u16_low(tu_le16toh(p_request->wValue));
 
 #if CFG_TUD_AUDIO_FUNC_1_N_CHANNELS_TX
-    if (ITF_NUM_AUDIO_STREAMING_SPK == itf && alt == 0) {
+    if (s_uac_device->spk_itf_num == itf && alt == 0) {
         TU_LOG2("Speaker interface closed");
         s_uac_device->spk_data_size = 0;
         s_uac_device->spk_active = false;
     }
 #endif
 
 #if CFG_TUD_AUDIO_FUNC_1_N_CHANNELS_RX
-    if (ITF_NUM_AUDIO_STREAMING_MIC == itf && alt == 0) {
+    if (s_uac_device->mic_itf_num == itf && alt == 0) {
         TU_LOG2("Microphone interface closed");
         s_uac_device->mic_data_size = 0;
         s_uac_device->mic_active = false;
@@ -336,24 +340,26 @@ bool tud_audio_set_itf_cb(uint8_t rhport, tusb_control_request_t const *p_reques
     TU_LOG2("Set interface %d alt %d\r\n", itf, alt);
 
 #if CFG_TUD_AUDIO_FUNC_1_N_CHANNELS_TX
-    if (ITF_NUM_AUDIO_STREAMING_SPK == itf && alt != 0) {
+    if (s_uac_device->spk_itf_num == itf && alt != 0) {
         s_uac_device->spk_data_size = 0;
         s_uac_device->spk_resolution = spk_resolutions_per_format[alt - 1];
         s_uac_device->spk_active = true;
         s_uac_device->spk_bytes_per_ms = s_uac_device->current_sample_rate / 1000 * SPEAK_CHANNEL_NUM * s_uac_device->spk_resolution / 8;
         xTaskNotifyGive(s_uac_device->spk_task_handle);
         TU_LOG1("Speaker interface %d-%d opened", itf, alt);
+        printf("Speaker interface %d-%d opened\n", itf, alt);
     }
 #endif
 
 #if CFG_TUD_AUDIO_FUNC_1_N_CHANNELS_RX
-    if (ITF_NUM_AUDIO_STREAMING_MIC == itf && alt != 0) {
+    if (s_uac_device->mic_itf_num == itf && alt != 0) {
         s_uac_device->mic_data_size = 0;
         s_uac_device->mic_resolution = mic_resolutions_per_format[alt - 1];
         s_uac_device->mic_active = true;
         s_uac_device->mic_bytes_per_ms = s_uac_device->current_sample_rate / 1000 * MIC_CHANNEL_NUM * s_uac_device->mic_resolution / 8;
         xTaskNotifyGive(s_uac_device->mic_task_handle);
         TU_LOG1("Microphone interface %d-%d opened", itf, alt);
+        printf("Microphone interface %d-%d opened\n", itf, alt);
     }
 #endif
 
@@ -495,6 +501,14 @@ esp_err_t uac_device_init(uac_device_config_t *config)
     s_uac_device->mic_buf_write = s_uac_device->mic_buf1;
     s_uac_device->mic_buf_read = s_uac_device->mic_buf2;
 
+#if CONFIG_USB_DEVICE_UAC_AS_PART
+    s_uac_device->spk_itf_num = config->spk_itf_num;
+    s_uac_device->mic_itf_num = config->mic_itf_num;
+#else
+    s_uac_device->spk_itf_num = ITF_NUM_AUDIO_STREAMING_SPK;
+    s_uac_device->mic_itf_num = ITF_NUM_AUDIO_STREAMING_MIC;
+#endif
+
     BaseType_t ret_val;
     if (!config->skip_tinyusb_init) {
         usb_phy_init();
diff --git a/docs/en/usb/usb_overview/tinyusb_development_guide.rst b/docs/en/usb/usb_overview/tinyusb_development_guide.rst
@@ -114,7 +114,7 @@ This file is mainly used to place custom USB descriptors. Tinyusb provides many
 
 Refer to the following file examples:
 
-- :example_file:`../components/usb/usb_device_uac/tusb/uac_descriptors.h`
+- :example_file:`../components/usb/usb_device_uac/tusb_uac/uac_descriptors.h`
 - :example_file:`../components/usb/usb_device_uvc/tusb/usb_descriptors.h`
 - :example_file:`/usb/device/usb_hid_device/hid_device/usb_descriptors.h`
 
diff --git a/docs/zh_CN/usb/usb_overview/tinyusb_development_guide.rst b/docs/zh_CN/usb/usb_overview/tinyusb_development_guide.rst
@@ -113,7 +113,7 @@ usb_descriptors.h 文件（可选）
 
 可以参考以下文件示例：
 
-- :example_file:`../components/usb/usb_device_uac/tusb/uac_descriptors.h`
+- :example_file:`../components/usb/usb_device_uac/tusb_uac/uac_descriptors.h`
 - :example_file:`../components/usb/usb_device_uvc/tusb/usb_descriptors.h`
 - :example_file:`/usb/device/usb_hid_device/hid_device/usb_descriptors.h`
 
diff --git a/examples/usb/device/usb_extend_screen/sdkconfig.defaults.esp32s3 b/examples/usb/device/usb_extend_screen/sdkconfig.defaults.esp32s3
@@ -69,7 +69,8 @@ CONFIG_SPIRAM_SPEED_120M=y
 #
 CONFIG_ESP32S3_DATA_CACHE_LINE_64B=y
 
-CONFIG_BSP_LCD_SUB_BOARD_800_480=y
+CONFIG_CODEC_I2C_BACKWARD_COMPATIBLE=n
+
 CONFIG_BSP_LCD_RGB_BUFFER_NUMS=3
 CONFIG_BSP_LCD_SUB_BOARD_TYPE=2
 CONFIG_BSP_LCD_RGB_BOUNCE_BUFFER_MODE=y
diff --git a/tools/ci/check_copyright_config.yaml b/tools/ci/check_copyright_config.yaml
@@ -56,6 +56,7 @@ ignore:  # You can also select ignoring files here
     - 'components/usb/esp_tinyuf2/**/*'
     - 'components/usb/usb_device_uvc/tusb/**/*'
     - 'components/usb/usb_device_uac/tusb/**/*'
+    - 'components/usb/usb_device_uac/tusb_uac/**/*'
     - 'components/usb/usb_stream/include/libuvc_def.h'
     - 'components/usb/usb_stream/test_apps/main/wave_1ch_16bits.c'
     - 'components/utilities/xz/**/*'

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-version: "1.1.0"`
	`1`	`+version: "1.2.0"`
`2`	`2`	`targets:`
`3`	`3`	`- esp32s2`
`4`	`4`	`- esp32s3`