fix(modem_4g): fix iot_usbh_cdc memory overrun issue

Author: lijunru-hub

components/usb/iot_usbh_cdc/CHANGELOG.md

@@ -1,5 +1,12 @@
 # ChangeLog
 
+## v1.0.3 - 2025-3-27
+
+### Bug Fixes:
+
+* Fixed an incorrect `ring_buffer pop` request value of 0.
+* Fixed uninitialized structure issue.
+
 ## v1.0.2 - 2025-3-13
 
 ### Bug Fixes:

components/usb/iot_usbh_cdc/idf_component.yml

@@ -1,4 +1,4 @@
-version: "1.0.2"
+version: "1.0.3"
 targets:
   - esp32s2
   - esp32s3

components/usb/iot_usbh_cdc/iot_usbh_cdc.c

@@ -110,9 +110,8 @@ static esp_err_t _ringbuf_pop(RingbufHandle_t ringbuf_hdl, uint8_t *buf, size_t
 static esp_err_t _ringbuf_push(RingbufHandle_t ringbuf_hdl, const uint8_t *buf, size_t write_bytes, TickType_t ticks_to_wait)
 {
     int res = xRingbufferSend(ringbuf_hdl, buf, write_bytes, ticks_to_wait);
-
     if (res != pdTRUE) {
-        ESP_LOGW(TAG, "The in buffer is too small, the data has been lost");
+        ESP_LOGW(TAG, "The ringbuffer is full, the data has been lost");
         return ESP_FAIL;
     }
     return ESP_OK;
@@ -392,8 +391,9 @@ static void in_xfer_cb(usb_transfer_t *in_xfer)
         if (data_len + in_xfer->actual_num_bytes >= cdc->in_ringbuf_size) {
             // TODO: add notify cb for user
             // if ringbuffer overflow, drop the data
-            ESP_LOGD(TAG, "in ringbuf full");
+            ESP_LOGW(TAG, "CDC in ringbuf is full!");
         } else {
+            ESP_LOG_BUFFER_HEXDUMP(TAG, in_xfer->data_buffer, in_xfer->actual_num_bytes, ESP_LOG_DEBUG);
             if (_ringbuf_push(cdc->in_ringbuf_handle, in_xfer->data_buffer, in_xfer->actual_num_bytes, pdMS_TO_TICKS(TIMEOUT_USB_RINGBUF_MS)) != ESP_OK) {
                 ESP_LOGE(TAG, "in ringbuf push failed");
             }
@@ -619,7 +619,7 @@ static esp_err_t _cdc_open(usbh_cdc_t *cdc)
     ESP_ERROR_CHECK(usb_host_get_active_config_descriptor(cdc->dev_hdl, &config_desc));
     ESP_ERROR_CHECK(usb_host_get_device_descriptor(cdc->dev_hdl, &device_desc));
 
-    cdc_parsed_info_t cdc_info;
+    cdc_parsed_info_t cdc_info = {0};
     ret = cdc_parse_interface_descriptor(device_desc, config_desc, cdc->intf_idx, &cdc->data.intf_desc, &cdc_info);
     if (ret != ESP_OK) {
         goto err;
@@ -795,12 +795,12 @@ esp_err_t usbh_cdc_read_bytes(usbh_cdc_handle_t cdc_handle, const uint8_t *buf,
     usbh_cdc_t *cdc = (usbh_cdc_t *) cdc_handle;
     ESP_GOTO_ON_FALSE(cdc->state == USBH_CDC_OPEN, ESP_ERR_INVALID_STATE, fail, TAG, "Device is not connected");
 
-    size_t data_len = _get_ringbuf_len(cdc->in_ringbuf_handle);
-    if (data_len > *length) {
-        data_len = *length;
+    size_t data_len = *length;
+    if (data_len > CONFIG_IN_RINGBUFFER_SIZE) {
+        data_len = CONFIG_IN_RINGBUFFER_SIZE;
     }
 
-    ret = _ringbuf_pop(cdc->in_ringbuf_handle, (uint8_t *)buf, data_len, length, pdMS_TO_TICKS(TIMEOUT_USB_RINGBUF_MS));
+    ret = _ringbuf_pop(cdc->in_ringbuf_handle, (uint8_t *)buf, data_len, length, ticks_to_wait);
     if (ret != ESP_OK) {
         ESP_LOGD(TAG, "cdc read failed");
         *length = 0;

components/usb/iot_usbh_modem/CHANGELOG.md

@@ -1,5 +1,10 @@
 # ChangeLog
 
+## v1.1.4 - 2024-3-20
+
+* Support 4g module `YM310_X09`
+* Add a debug print
+
 ## v1.1.3 - 2024-3-20
 
 * Support 4g module `EG25_GL` and `AIR780E`

components/usb/iot_usbh_modem/Kconfig

@@ -26,13 +26,22 @@ menu "IoT USB Host Modem"
             depends on n
         config MODEM_TARGET_BG96_MA
             bool "BG96MA"
-            depends on n
         config MODEM_TARGET_MC610_EU
             bool "MC610_EU"
         config MODEM_TARGET_EC20_CE
             bool "EC20_CE"
         config MODEM_TARGET_EG25_GL
             bool "EC25_GL"
+        config MODEM_TARGET_YM310_X09
+            bool "YM310_X09"
+        config MODEM_TARGET_SIM7600E
+            bool "SIM7600E"
+        config MODEM_TARGET_A7670E
+            bool "A7670E"
+        config MODEM_TARGET_SIM7070G
+            bool "SIM7070G"
+        config MODEM_TARGET_SIM7080
+            bool "SIM7080"
     endchoice
 
     config MODEM_TARGET_NAME
@@ -45,13 +54,19 @@ menu "IoT USB Host Modem"
         default "MC610_EU" if MODEM_TARGET_MC610_EU
         default "EC20_CE" if MODEM_TARGET_EC20_CE
         default "EG25_GL" if MODEM_TARGET_EG25_GL
+        default "YM310_X09" if MODEM_TARGET_YM310_X09
+        default "SIM7600E" if MODEM_TARGET_SIM7600E
+        default "A7670E" if MODEM_TARGET_A7670E
+        default "SIM7070G" if MODEM_TARGET_SIM7070G
+        default "SIM7080G" if MODEM_TARGET_SIM7080G
         default "User Defined" if MODEM_TARGET_USER
 
     config MODEM_SUPPORT_SECONDARY_AT_PORT
         bool "Enable Dual CDC Mode"
-        depends on (MODEM_TARGET_MC610_EU || MODEM_TARGET_USER || MODEM_TARGET_EG25_GL)
+        depends on (MODEM_TARGET_MC610_EU || MODEM_TARGET_USER || MODEM_TARGET_EG25_GL || MODEM_TARGET_A7670E)
         default y if MODEM_TARGET_MC610_EU
         default y if MODEM_TARGET_EG25_GL
+        default y if MODEM_TARGET_A7670E
         default n if MODEM_TARGET_USER
 
     menu "USB CDC interface config"
@@ -66,6 +81,12 @@ menu "IoT USB Host Modem"
             default 0x02 if MODEM_TARGET_EC20_CE
             default 0x03 if MODEM_TARGET_AIR780_E
             default 0x03 if MODEM_TARGET_EG25_GL
+            default 0x03 if MODEM_TARGET_YM310_X09
+            default 0x02 if MODEM_TARGET_BG96_MA
+            default 0x03 if MODEM_TARGET_SIM7600E
+            default 0x04 if MODEM_TARGET_A7670E
+            default 0x02 if MODEM_TARGET_SIM7070G
+            default 0x02 if MODEM_TARGET_SIM7080G
             default 0x00 if MODEM_TARGET_USER
             help
                 USB CDC interface (eg.0x00) used for send AT/data to device
@@ -76,6 +97,7 @@ menu "IoT USB Host Modem"
             default 0x01 if MODEM_TARGET_USER
             default 0x05 if MODEM_TARGET_MC610_EU
             default 0x02 if MODEM_TARGET_EG25_GL
+            default 0x05 if MODEM_TARGET_A7670E
             help
                 USB CDC interface 2 (eg.0x01) used for send AT/data to device
     endmenu

components/usb/iot_usbh_modem/idf_component.yml

@@ -1,4 +1,4 @@
-version: "1.1.3"
+version: "1.1.4"
 targets:
   - esp32s2
   - esp32s3

components/usb/iot_usbh_modem/src/esp_modem_dce.c

@@ -101,6 +101,7 @@ esp_err_t esp_modem_dce_default_destroy(esp_modem_dce_t *dce)
 esp_err_t esp_modem_dce_handle_response_default(esp_modem_dce_t *dce, const char *line)
 {
     esp_err_t err = ESP_FAIL;
+    ESP_LOGD(TAG, "Received line:%s\n", line);
     if (strstr(line, MODEM_RESULT_CODE_SUCCESS)) {
         err = esp_modem_process_command_done(dce, ESP_MODEM_STATE_SUCCESS);
     } else if (strstr(line, MODEM_RESULT_CODE_ERROR)) {

examples/usb/host/usb_cdc_basic/main/usb_cdc_basic_main.c

@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2023-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -92,9 +92,9 @@ void app_main(void)
     usbh_cdc_create(&dev_config, &handle[0]);
 
 #if (EXAMPLE_BULK_ITF_NUM > 1)
-    config.itf_num = 1;
-    config.cbs = {0};
-    ESP_LOGI(TAG, "Open interface num: %d with first USB CDC Device", config.itf_num);
+    dev_config.itf_num = 3;
+    memset(&dev_config.cbs, 0, sizeof(dev_config.cbs));
+    ESP_LOGI(TAG, "Open interface num: %d with first USB CDC Device", dev_config.itf_num);
     usbh_cdc_create(&dev_config, &handle[1]);
 #endif
     /*!< Wait for the USB device to be connected */