Merge branch 'feat/add_usbh_modem_deinit' into 'master'

lijunru-hub · lijunru-hub · commit 654e690103de · 2025-04-28T14:44:49.000+08:00
feat(usb_modem): add usbh modem deinit

Closes AEGHB-89

See merge request ae_group/esp-iot-solution!1263
diff --git a/.gitlab/ci/build.yml b/.gitlab/ci/build.yml
@@ -1609,6 +1609,17 @@ build_components_usb_iot_usbh_cdc_test_apps:
   variables:
     EXAMPLE_DIR: components/usb/iot_usbh_cdc/test_apps
 
+build_components_usb_iot_usbh_modem_test_apps:
+  extends:
+    - .build_examples_template
+    - .rules:build:components_usb_iot_usbh_modem_test
+  parallel:
+    matrix:
+      - IMAGE: espressif/idf:release-v4.4
+      - IMAGE: espressif/idf:release-v5.3
+  variables:
+    EXAMPLE_DIR: components/usb/iot_usbh_modem/test_apps
+
 build_components_usb_usb_device_uac:
   extends:
     - .build_examples_template
diff --git a/.gitlab/ci/rules.yml b/.gitlab/ci/rules.yml
@@ -2457,6 +2457,21 @@
     - <<: *if-dev-push
       changes: *patterns-components_usb_iot_usbh_cdc
 
+.rules:build:components_usb_iot_usbh_modem_test:
+  rules:
+    - <<: *if-protected
+    - <<: *if-label-build
+    - <<: *if-label-target_test
+    - <<: *if-trigger-job
+    - <<: *if-dev-push
+      changes: *patterns-build_system
+    - <<: *if-dev-push
+      changes: *patterns-components_usb_iot_usbh
+    - <<: *if-dev-push
+      changes: *patterns-components_usb_iot_usbh_cdc
+    - <<: *if-dev-push
+      changes: *patterns-components_usb_iot_usbh_modem
+
 .rules:build:components_usb_usb_stream_test:
   rules:
     - <<: *if-protected
diff --git a/components/.build-rules.yml b/components/.build-rules.yml
@@ -39,7 +39,11 @@ components/usb/iot_usbh/test_apps:
 
 components/usb/iot_usbh_cdc/test_apps:
   enable:
-    - if: IDF_TARGET in ["esp32s2","esp32s3"]
+    - if: IDF_TARGET in ["esp32s2","esp32s3","esp32p4"]
+
+components/usb/iot_usbh_modem/test_apps:
+  enable:
+    - if: IDF_TARGET in ["esp32s2","esp32s3","esp32p4"]
 
 components/i2c_bus/test_apps:
   enable:
diff --git a/components/usb/iot_usbh_cdc/CHANGELOG.md b/components/usb/iot_usbh_cdc/CHANGELOG.md
@@ -1,5 +1,11 @@
 # ChangeLog
 
+## v1.0.4 - 2025-4-1
+
+### Bug Fixes:
+
+* Fix USB host interface release when URB is not cleared.
+
 ## v1.0.3 - 2025-3-27
 
 ### Bug Fixes:
diff --git a/components/usb/iot_usbh_cdc/idf_component.yml b/components/usb/iot_usbh_cdc/idf_component.yml
@@ -1,4 +1,4 @@
-version: "1.0.3"
+version: "1.0.4"
 targets:
   - esp32s2
   - esp32s3
diff --git a/components/usb/iot_usbh_cdc/iot_usbh_cdc.c b/components/usb/iot_usbh_cdc/iot_usbh_cdc.c
@@ -524,7 +524,6 @@ static esp_err_t _cdc_reset_transfer_endpoint(usb_device_handle_t dev_hdl, usb_t
 {
     assert(dev_hdl);
     assert(transfer);
-
     ESP_RETURN_ON_ERROR(usb_host_endpoint_halt(dev_hdl, transfer->bEndpointAddress), TAG,);
     ESP_RETURN_ON_ERROR(usb_host_endpoint_flush(dev_hdl, transfer->bEndpointAddress), TAG,);
     usb_host_endpoint_clear(dev_hdl, transfer->bEndpointAddress);
@@ -652,17 +651,24 @@ static esp_err_t _cdc_close(usbh_cdc_t *cdc)
         return ESP_ERR_INVALID_STATE;
     }
 
+    cdc->state = USBH_CDC_CLOSE;
+
     // Cancel polling of BULK IN
     if (cdc->data.in_xfer) {
         ESP_ERROR_CHECK(_cdc_reset_transfer_endpoint(cdc->dev_hdl, cdc->data.in_xfer));
     }
 
+    if (cdc->data.out_xfer) {
+        ESP_ERROR_CHECK(_cdc_reset_transfer_endpoint(cdc->dev_hdl, cdc->data.out_xfer));
+    }
+
+    // wait for transfers to complete
+    vTaskDelay(10 / portTICK_PERIOD_MS);
     // Release all interfaces
-    ESP_ERROR_CHECK(usb_host_interface_release(p_usbh_cdc_obj->cdc_client_hdl, cdc->dev_hdl, cdc->data.intf_desc->bInterfaceNumber));
+    ESP_ERROR_CHECK(usb_host_interface_release(p_usbh_cdc_obj->cdc_client_hdl, cdc->dev_hdl, cdc->intf_idx));
 
     _cdc_transfers_free(cdc);
     usb_host_device_close(p_usbh_cdc_obj->cdc_client_hdl, cdc->dev_hdl);
-    cdc->state = USBH_CDC_CLOSE;
 
     _ring_buffer_flush(cdc->in_ringbuf_handle);
     _ring_buffer_flush(cdc->out_ringbuf_handle);
@@ -802,7 +808,7 @@ esp_err_t usbh_cdc_read_bytes(usbh_cdc_handle_t cdc_handle, const uint8_t *buf,
 
     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");
+        ESP_LOGE(TAG, "cdc read failed");
         *length = 0;
         return ret;
     }
diff --git a/components/usb/iot_usbh_modem/CHANGELOG.md b/components/usb/iot_usbh_modem/CHANGELOG.md
@@ -1,5 +1,9 @@
 # ChangeLog
 
+## v1.1.5 - 2024-4-1
+
+* Support `modem_board_deinit()`.
+
 ## v1.1.4 - 2024-3-20
 
 * Support 4g module `YM310_X09`
diff --git a/components/usb/iot_usbh_modem/idf_component.yml b/components/usb/iot_usbh_modem/idf_component.yml
@@ -1,4 +1,4 @@
-version: "1.1.4"
+version: "1.1.5"
 targets:
   - esp32s2
   - esp32s3
diff --git a/components/usb/iot_usbh_modem/include/usbh_modem_board.h b/components/usb/iot_usbh_modem/include/usbh_modem_board.h
@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2023-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -61,6 +61,15 @@ typedef struct {
  */
 esp_err_t modem_board_init(modem_config_t *config);
 
+/**
+ * @brief Deinit all about the modem object
+ *
+ * @return
+ *      - ESP_ERR_INVALID_STATE
+ *      - ESP_OK
+ */
+esp_err_t modem_board_deinit(void);
+
 /**
  * @brief Get the DNS information of modem ppp interface
  *
diff --git a/components/usb/iot_usbh_modem/private_include/esp_modem.h b/components/usb/iot_usbh_modem/private_include/esp_modem.h
@@ -224,11 +224,12 @@ esp_err_t esp_modem_set_event_handler(esp_modem_dte_t *dte, esp_event_handler_t
  *
  * @param dte modem_dte_t type object
  * @param handler event handler to unregister
+ * @param event_id event id to unregister
  * @return esp_err_t
  *      - ESP_OK on success
  *      - ESP_ERR_INVALID_ARG on invalid combination of event base and event id
  */
-esp_err_t esp_modem_remove_event_handler(esp_modem_dte_t *dte, esp_event_handler_t handler);
+esp_err_t esp_modem_remove_event_handler(esp_modem_dte_t *dte, esp_event_handler_t handler, int32_t event_id);
 
 esp_err_t esp_modem_post_event(esp_modem_dte_t *dte, int32_t event_id, void* event_data, size_t event_data_size, TickType_t ticks_to_wait);
 
diff --git a/components/usb/iot_usbh_modem/src/esp_modem.c b/components/usb/iot_usbh_modem/src/esp_modem.c
@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2023-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
@@ -24,10 +24,10 @@ esp_err_t esp_modem_set_event_handler(esp_modem_dte_t *dte, esp_event_handler_t
     return esp_event_handler_register_with(esp_dte->event_loop_hdl, ESP_MODEM_EVENT, event_id, handler, handler_args);
 }
 
-esp_err_t esp_modem_remove_event_handler(esp_modem_dte_t *dte, esp_event_handler_t handler)
+esp_err_t esp_modem_remove_event_handler(esp_modem_dte_t *dte, esp_event_handler_t handler, int32_t event_id)
 {
     esp_modem_dte_internal_t *esp_dte = __containerof(dte, esp_modem_dte_internal_t, parent);
-    return esp_event_handler_unregister_with(esp_dte->event_loop_hdl, ESP_MODEM_EVENT, ESP_EVENT_ANY_ID, handler);
+    return esp_event_handler_unregister_with(esp_dte->event_loop_hdl, ESP_MODEM_EVENT, event_id, handler);
 }
 
 esp_err_t esp_modem_post_event(esp_modem_dte_t *dte, int32_t event_id, void* event_data, size_t event_data_size, TickType_t ticks_to_wait)
@@ -102,7 +102,7 @@ esp_err_t esp_modem_default_destroy(esp_modem_dte_t *dte)
     esp_modem_dce_t *dce = dte->dce;
     ESP_MODEM_ERR_CHECK(dce && netif_adapter, "Cannot destroy dce or netif_adapter", err_params);
     ESP_MODEM_ERR_CHECK(esp_modem_netif_clear_default_handlers(netif_adapter) == ESP_OK,
-                        "modem_netif failed to clread handlers", err);
+                        "modem_netif failed to clear handlers", err);
     esp_modem_netif_destroy(netif_adapter);
     dte->netif_adapter = NULL;
     ESP_MODEM_ERR_CHECK(dce->deinit(dce) == ESP_OK, "failed to deinit dce", err);
@@ -139,6 +139,7 @@ esp_err_t esp_modem_default_attach(esp_modem_dte_t *dte, esp_modem_dce_t *dce, e
                         "modem_netif failed to set handlers", err);
     ESP_MODEM_ERR_CHECK(esp_netif_attach(ppp_netif, modem_netif_adapter) == ESP_OK,
                         "attach netif to modem adapter failed", err);
+    dte->netif_adapter = modem_netif_adapter;
     ESP_MODEM_ERR_CHECK(esp_modem_notify_initialized(dte) == ESP_OK, "DTE init notification failed", err);
     return ESP_OK;
 err:
diff --git a/components/usb/iot_usbh_modem/src/esp_modem_netif.c b/components/usb/iot_usbh_modem/src/esp_modem_netif.c
@@ -190,11 +190,11 @@ esp_err_t esp_modem_netif_clear_default_handlers(esp_modem_netif_driver_t *h)
 {
     esp_modem_netif_driver_t *driver = h;
     esp_err_t ret;
-    ret = esp_modem_remove_event_handler(driver->dte, esp_netif_action_start);
+    ret = esp_modem_remove_event_handler(driver->dte, esp_netif_action_start, ESP_MODEM_EVENT_PPP_START);
     if (ret != ESP_OK) {
         goto clear_event_failed;
     }
-    ret = esp_modem_remove_event_handler(driver->dte, esp_netif_action_stop);
+    ret = esp_modem_remove_event_handler(driver->dte, esp_netif_action_stop, ESP_MODEM_EVENT_PPP_STOP);
     if (ret != ESP_OK) {
         goto clear_event_failed;
     }
diff --git a/components/usb/iot_usbh_modem/src/usbh_modem_board.c b/components/usb/iot_usbh_modem/src/usbh_modem_board.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
  */
@@ -52,17 +52,18 @@ ESP_EVENT_DEFINE_BASE(MODEM_BOARD_EVENT);
 
 /* user event */
 static const int MODEM_DESTROY_BIT                = BIT0;    /* destroy modem daemon task, trigger by user, clear by daemon task */
-static const int PPP_NET_MODE_ON_BIT              = BIT1;    /* dte usb reconnect event, trigger by user, clear by daemon task */
-static const int PPP_NET_MODE_OFF_BIT             = BIT2;    /* dte usb disconnect event, trigger by user, clear by hardware */
-static const int PPP_NET_AUTO_SUSPEND_USER_BIT    = BIT3;    /* suspend ppp net auto reconnect, trigger by user, clear by user */
+static const int MODEM_DESTROY_DONE_BIT           = BIT1;    /* modem daemon task destroy done, trigger by daemon task, clear by user */
+static const int PPP_NET_MODE_ON_BIT              = BIT2;    /* dte usb reconnect event, trigger by user, clear by daemon task */
+static const int PPP_NET_MODE_OFF_BIT             = BIT3;    /* dte usb disconnect event, trigger by user, clear by hardware */
+static const int PPP_NET_AUTO_SUSPEND_USER_BIT    = BIT4;    /* suspend ppp net auto reconnect, trigger by user, clear by user */
 /* net event */
-static const int PPP_NET_CONNECT_BIT              = BIT4;    /* ppp net got ip, trigger by lwip, clear by lwip or daemon task */
-static const int PPP_NET_DISCONNECT_BIT           = BIT5;    /* ppp net loss ip, trigger by lwip, clear by lwip */
+static const int PPP_NET_CONNECT_BIT              = BIT5;    /* ppp net got ip, trigger by lwip, clear by lwip or daemon task */
+static const int PPP_NET_DISCONNECT_BIT           = BIT6;    /* ppp net loss ip, trigger by lwip, clear by lwip */
 /* usb event */
-static const int DTE_USB_DISCONNECT_BIT           = BIT6;    /* dte usb disconnect event, trigger by hardware, clear by daemon task */
-static const int DTE_USB_RECONNECT_BIT            = BIT7;    /* dte usb reconnect event, trigger by hardware or user, clear by daemon task */
+static const int DTE_USB_DISCONNECT_BIT           = BIT7;    /* dte usb disconnect event, trigger by hardware, clear by daemon task */
+static const int DTE_USB_RECONNECT_BIT            = BIT8;    /* dte usb reconnect event, trigger by hardware or user, clear by daemon task */
 /* daemon task internal event bit */
-static const int PPP_NET_RECONNECTING_BIT         = BIT8;    /* ppp net reconnecting, trigger by daemon task, clear by daemon task */
+static const int PPP_NET_RECONNECTING_BIT         = BIT9;    /* ppp net reconnecting, trigger by daemon task, clear by daemon task */
 
 static esp_modem_dce_t *s_dce = NULL;
 static EventGroupHandle_t s_modem_evt_hdl = NULL;
@@ -230,7 +231,7 @@ static esp_err_t modem_board_start_up(esp_modem_dce_t *dce)
 
 }
 
-static esp_err_t modem_board_deinit(esp_modem_dce_t *dce)
+static esp_err_t modem_board_dce_deinit(esp_modem_dce_t *dce)
 {
     modem_board_t *board = __containerof(dce, modem_board_t, parent);
     if (board->power_pin) {
@@ -263,7 +264,7 @@ static esp_modem_dce_t *modem_board_create(esp_modem_dce_config_t *config)
     board->power_down = modem_board_power_down;
     board->re_sync = esp_modem_recov_resend_new(&board->parent, board->parent.sync, my_recov, 5, 5);
     //overwrite default function
-    board->parent.deinit = modem_board_deinit;
+    board->parent.deinit = modem_board_dce_deinit;
     board->parent.start_up = modem_board_start_up;
 
     return &board->parent;
@@ -643,8 +644,18 @@ static void _modem_daemon_task(void *param)
             break;
         }
     }
+
+    if (config->handler) {
+        esp_event_handler_unregister(MODEM_BOARD_EVENT, ESP_EVENT_ANY_ID, config->handler);
+    }
+    ESP_ERROR_CHECK(esp_event_handler_unregister(IP_EVENT, ESP_EVENT_ANY_ID, on_modem_event));
+    // destroy dte & dce
+    ESP_ERROR_CHECK(esp_modem_default_destroy(dte));
+    modem_board_t *board = __containerof(s_dce, modem_board_t, parent);
+    free(board);
     xEventGroupClearBits(s_modem_evt_hdl, (PPP_NET_MODE_ON_BIT | PPP_NET_MODE_OFF_BIT | MODEM_DESTROY_BIT | DTE_USB_RECONNECT_BIT | PPP_NET_RECONNECTING_BIT));
     ESP_LOGI(TAG, "Modem Daemon Task Deleted!");
+    xEventGroupSetBits(s_modem_evt_hdl, MODEM_DESTROY_DONE_BIT);
     vTaskDelete(NULL);
 }
 
@@ -673,6 +684,17 @@ esp_err_t modem_board_init(modem_config_t *config)
     return ESP_OK;
 }
 
+esp_err_t modem_board_deinit(void)
+{
+    MODEM_CHECK(s_modem_evt_hdl, "Modem not init", ESP_ERR_INVALID_STATE);
+    xEventGroupSetBits(s_modem_evt_hdl, MODEM_DESTROY_BIT);
+    xEventGroupWaitBits(s_modem_evt_hdl, MODEM_DESTROY_DONE_BIT, pdFALSE, pdFALSE, portMAX_DELAY);
+    vEventGroupDelete(s_modem_evt_hdl);
+    s_modem_evt_hdl = NULL;
+    ESP_LOGI(TAG, "iot_usbh_modem Deinit Success!");
+    return ESP_OK;
+}
+
 esp_err_t modem_board_get_dns_info(esp_netif_dns_type_t type, esp_netif_dns_info_t *dns)
 {
     MODEM_CHECK(dns != NULL && type <= ESP_NETIF_DNS_BACKUP, "Invalid DNS info", ESP_ERR_INVALID_ARG);
diff --git a/components/usb/iot_usbh_modem/test_apps/CMakeLists.txt b/components/usb/iot_usbh_modem/test_apps/CMakeLists.txt
@@ -0,0 +1,9 @@
+# The following lines of boilerplate have to be in your project's CMakeLists
+# in this exact order for cmake to work correctly
+cmake_minimum_required(VERSION 3.16)
+
+set(EXTRA_COMPONENT_DIRS "$ENV{IDF_PATH}/tools/unit-test-app/components"
+                        "../../iot_usbh_modem"
+                        "../../iot_usbh_cdc")
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+project(iot_usbh_cdc_test)
diff --git a/components/usb/iot_usbh_modem/test_apps/main/CMakeLists.txt b/components/usb/iot_usbh_modem/test_apps/main/CMakeLists.txt
@@ -0,0 +1,3 @@
+idf_component_register(SRC_DIRS "."
+                        INCLUDE_DIRS "."
+                        PRIV_REQUIRES unity test_utils iot_usbh_modem iot_usbh_cdc usb)
diff --git a/components/usb/iot_usbh_modem/test_apps/main/test_usbh_modem.c b/components/usb/iot_usbh_modem/test_apps/main/test_usbh_modem.c
@@ -0,0 +1,64 @@
+/*
+ * SPDX-FileCopyrightText: 2023-2025 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <string.h>
+#include "freertos/FreeRTOS.h"
+#include "freertos/task.h"
+#include "freertos/event_groups.h"
+#include "unity.h"
+#include "iot_usbh_cdc.h"
+#include "usbh_modem_board.h"
+#include "esp_log.h"
+
+#define TEST_MEMORY_LEAK_THRESHOLD (-20000)
+
+TEST_CASE("usbh modem memory leak", "[iot_usbh_modem][read-write][auto]")
+{
+    /* Initialize default TCP/IP stack */
+    ESP_ERROR_CHECK(esp_netif_init());
+    ESP_ERROR_CHECK(esp_event_loop_create_default());
+    modem_config_t modem_config = MODEM_DEFAULT_CONFIG();
+    /* if Not enter ppp, modem will enter command mode after init */
+    modem_config.flags |= MODEM_FLAGS_INIT_NOT_ENTER_PPP;
+    /* if Not waiting for modem ready, just return after modem init */
+    modem_config.flags |= MODEM_FLAGS_INIT_NOT_BLOCK;
+    modem_board_init(&modem_config);
+    vTaskDelay(1000 / portTICK_PERIOD_MS);
+    modem_board_deinit();
+    esp_netif_deinit();
+    esp_event_loop_delete_default();
+    vTaskDelay(1000 / portTICK_PERIOD_MS);
+}
+
+static size_t before_free_8bit;
+static size_t before_free_32bit;
+
+static void check_leak(size_t before_free, size_t after_free, const char *type)
+{
+    ssize_t delta = after_free - before_free;
+    printf("MALLOC_CAP_%s: Before %u bytes free, After %u bytes free (delta %d)\n", type, before_free, after_free, delta);
+    TEST_ASSERT_MESSAGE(delta >= TEST_MEMORY_LEAK_THRESHOLD, "memory leak");
+}
+
+void setUp(void)
+{
+    before_free_8bit = heap_caps_get_free_size(MALLOC_CAP_8BIT);
+    before_free_32bit = heap_caps_get_free_size(MALLOC_CAP_32BIT);
+}
+
+void tearDown(void)
+{
+    size_t after_free_8bit = heap_caps_get_free_size(MALLOC_CAP_8BIT);
+    size_t after_free_32bit = heap_caps_get_free_size(MALLOC_CAP_32BIT);
+    check_leak(before_free_8bit, after_free_8bit, "8BIT");
+    check_leak(before_free_32bit, after_free_32bit, "32BIT");
+}
+
+void app_main(void)
+{
+    printf("IOT USBH MODEM TEST \n");
+    unity_run_menu();
+}
diff --git a/components/usb/iot_usbh_modem/test_apps/sdkconfig.defaults b/components/usb/iot_usbh_modem/test_apps/sdkconfig.defaults
diff --git a/examples/usb/host/usb_cdc_4g_module/main/app_main.c b/examples/usb/host/usb_cdc_4g_module/main/app_main.c
diff --git a/examples/usb/host/usb_cdc_basic/main/usb_cdc_basic_main.c b/examples/usb/host/usb_cdc_basic/main/usb_cdc_basic_main.c

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-version: "1.0.3"`
	`1`	`+version: "1.0.4"`
`2`	`2`	`targets:`
`3`	`3`	`- esp32s2`
`4`	`4`	`- esp32s3`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-version: "1.1.4"`
	`1`	`+version: "1.1.5"`
`2`	`2`	`targets:`
`3`	`3`	`- esp32s2`
`4`	`4`	`- esp32s3`