Merge branch 'fix/fix_usb_stream_fifo_bias' into 'master'

fix(usb_stream): fix compilation issue caused by fifo_bias

See merge request ae_group/esp-iot-solution!1317

Author: YanKE01

.gitlab/ci/build.yml

@@ -1670,10 +1670,7 @@ build_components_usb_usb_stream_test_apps:
   extends:
     - .build_examples_template
     - .rules:build:components_usb_usb_stream_test
-  parallel:
-    matrix:
-      - IMAGE: espressif/idf:release-v5.0
-      - IMAGE: espressif/idf:release-v5.4
+    - .build_idf_active_release_version
   variables:
     EXAMPLE_DIR: components/usb/usb_stream/test_apps
 

components/usb/usb_stream/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ChangeLog
 
+## v1.5.1 - 2025-7-15
+
+### Bug Fixes:
+
+* Fix compilation errors on esp-idf release v5.3 and above.
+
 ## v1.5.0 - 2024-12-10
 
 ### Improvements:

components/usb/usb_stream/README.md

@@ -11,6 +11,8 @@ Features:
 3. Support volume, mute and other features control through the UAC Control interface
 4. Support stream separately suspend and resume
 
+> Note: For ESP-IDF V5.3.3 and above, if you enable UVC, please also enable `Bias IN` in `Component config → USB-OTG → Hardware FIFO size biasing`.
+
 ### USB Stream User Guide
 
 Please refer: https://docs.espressif.com/projects/esp-iot-solution/en/latest/usb/usb_host/usb_stream.html

components/usb/usb_stream/README_CN.md

@@ -11,6 +11,8 @@
 3. 支持通过 UAC Control 接口控制麦克风音量、静音等特性
 4. 支持对数据流暂停和恢复
 
+> Note: 对于 ESP-IDF V5.3.3 及以上的版本，若使能 UVC，请在 `Component config → USB-OTG → Hardware FIFO size biasing` 中使能 `Bias IN`
+
 ### USB Stream 用户指南
 
 请参考：https://docs.espressif.com/projects/esp-iot-solution/zh_CN/latest/usb/usb_host/usb_stream.html

components/usb/usb_stream/idf_component.yml

@@ -1,4 +1,4 @@
-version: "1.5.0"
+version: "1.5.1"
 targets:
   - esp32s2
   - esp32s3

components/usb/usb_stream/test_apps/sdkconfig.ci.quick

@@ -7,3 +7,4 @@ CONFIG_ESP32S3_DEFAULT_CPU_FREQ_240=y
 
 # Enable Quick start mode
 CONFIG_USB_STREAM_QUICK_START=y
+CONFIG_USB_HOST_HW_BUFFER_BIAS_IN=y

components/usb/usb_stream/usb_host_helpers.c

@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2022-2023 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -14,6 +14,7 @@
 #include "esp_private/usb_phy.h"
 #include "usb_host_helpers.h"
 #include "esp_intr_alloc.h"
+#include "esp_bit_defs.h"
 
 #define USB_PORT_NUM 1  //Default port number
 static const char *TAG = "USB_STREAM";
@@ -195,16 +196,31 @@ hcd_port_handle_t _usb_port_init(hcd_port_callback_t callback, void *callback_ar
     UVC_CHECK(ESP_OK == ret, "USB PHY init failed", NULL);
     hcd_config_t hcd_config = {
         .intr_flags = ESP_INTR_FLAG_LEVEL2,
+#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 4, 1)
+        .peripheral_map = BIT0,
+        .fifo_config = NULL,
+#endif
     };
     ret = hcd_install(&hcd_config);
     UVC_CHECK_GOTO(ESP_OK == ret, "HCD Install failed", hcd_init_err);
     hcd_port_config_t port_cfg = {
+#if ESP_IDF_VERSION < ESP_IDF_VERSION_VAL(5, 3, 3)
         .fifo_bias = HCD_PORT_FIFO_BIAS_BALANCED,
+#endif
         .callback = callback,
         .callback_arg = callback_arg,
         .context = phy_handle,
     };
+
+#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 4, 1)
+    int root_port_index = 0;
+    if (hcd_config.peripheral_map & BIT1) {
+        root_port_index = 1;
+    }
+    ret = hcd_port_init(root_port_index, &port_cfg, &port_hdl);
+#else
     ret = hcd_port_init(USB_PORT_NUM, &port_cfg, &port_hdl);
+#endif
     UVC_CHECK_GOTO(ESP_OK == ret, "HCD Port init failed", port_init_err);
     ret = hcd_port_command(port_hdl, HCD_PORT_CMD_POWER_ON);
     UVC_CHECK_GOTO(ESP_OK == ret, "HCD Port Power on failed", port_power_err);

components/usb/usb_stream/usb_stream.c

@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2022-2024 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -512,7 +512,9 @@ typedef struct {
     // const values after usb stream start
     bool enabled[STREAM_MAX];
     hcd_port_handle_t port_hdl;
+#if ESP_IDF_VERSION < ESP_IDF_VERSION_VAL(5, 3, 3)
     hcd_port_fifo_bias_t fifo_bias;
+#endif
     const fifo_mps_limits_t *mps_limits;
     uint16_t configuration;
     uint8_t dev_addr;
@@ -3353,8 +3355,10 @@ static void _usb_processing_task(void *arg)
                 continue;
             }
             reset_retry = 3;
+#if ESP_IDF_VERSION < ESP_IDF_VERSION_VAL(5, 3, 3)
             ESP_LOGI(TAG, "Setting Port FIFO, %d", usb_dev->fifo_bias);
             ESP_ERROR_CHECK(hcd_port_set_fifo_bias(usb_dev->port_hdl, usb_dev->fifo_bias));
+#endif
             action_bits &= ~ACTION_DEVICE_CONNECT;
             action_bits |= ACTION_DEVICE_ENUM;
             usb_dev->enum_stage = ENUM_STAGE_NONE;
@@ -3706,7 +3710,9 @@ esp_err_t usb_streaming_start()
     s_usb_dev.dev_speed = USB_SPEED_FULL;
     s_usb_dev.dev_addr = USB_DEVICE_ADDR;
     s_usb_dev.configuration = USB_CONFIG_NUM;
+#if ESP_IDF_VERSION < ESP_IDF_VERSION_VAL(5, 3, 3)
     s_usb_dev.fifo_bias = HCD_PORT_FIFO_BIAS_BALANCED;
+#endif
     s_usb_dev.mps_limits = &s_mps_limits_default;
 
     if (s_usb_dev.uac_cfg.spk_samples_frequence && s_usb_dev.uac_cfg.spk_bit_resolution) {
@@ -3760,7 +3766,9 @@ esp_err_t usb_streaming_start()
         ESP_LOGD(TAG, "Camera instance created");
         s_usb_dev.enabled[STREAM_UVC] = true;
         //if enable uvc, we should set fifo bias to RX
+#if ESP_IDF_VERSION < ESP_IDF_VERSION_VAL(5, 3, 3)
         s_usb_dev.fifo_bias = HCD_PORT_FIFO_BIAS_RX;
+#endif
         s_usb_dev.mps_limits = &s_mps_limits_bias_rx;
     }
     UVC_CHECK_GOTO(s_usb_dev.enabled[STREAM_UAC_MIC] == true || s_usb_dev.enabled[STREAM_UAC_SPK] == true || s_usb_dev.enabled[STREAM_UVC] == true, "uac/uvc streaming not configured", free_resource_);