Merge branch 'feat/add_openthread_start_stop_api' into 'master'

feat(openthread): add openthread start stop APIs

See merge request espressif/esp-idf!40349

Author: gytxxsy

components/openthread/Kconfig

@@ -6,6 +6,28 @@ menu "OpenThread"
         help
             Select this option to enable OpenThread and show the submenu with OpenThread configuration choices.
 
+    menu "Thread Task Parameters"
+        depends on OPENTHREAD_ENABLED
+
+        config OPENTHREAD_TASK_NAME
+            string "OpenThread task name"
+            default "ot_main"
+            help
+                The OpenThread task name.
+
+        config OPENTHREAD_TASK_SIZE
+            int "Size of OpenThread task"
+            default 8192
+            help
+                The size in bytes of OpenThread task.
+
+        config OPENTHREAD_TASK_PRIORITY
+            int "Priority of OpenThread task"
+            default 5
+            help
+                The priority of OpenThread task.
+    endmenu
+
     menu "Thread Version Message"
         depends on OPENTHREAD_ENABLED
 
@@ -23,10 +45,18 @@ menu "OpenThread"
     endmenu
 
     menu "Thread Console"
-        depends on OPENTHREAD_ENABLED
+        config OPENTHREAD_CONSOLE_ENABLE
+            bool "Enable OpenThread console"
+            depends on OPENTHREAD_ENABLED
+            default y
+            help
+                Enable the OpenThread-specific console provided by the SDK. This only controls whether
+                the SDK sets up a dedicated console for OpenThread. Even if disabled, the default
+                ESP-IDF console (if initialized elsewhere) can still be used independently.
 
         choice OPENTHREAD_CONSOLE_TYPE
             prompt "OpenThread console type"
+            depends on OPENTHREAD_CONSOLE_ENABLE
             default OPENTHREAD_CONSOLE_TYPE_UART
             help
                 Select OpenThread console type

components/openthread/include/esp_openthread.h

@@ -7,6 +7,7 @@
 #pragma once
 
 #include "esp_err.h"
+#include "esp_netif.h"
 #include "esp_openthread_types.h"
 #include "openthread/dataset.h"
 #include "openthread/error.h"
@@ -89,6 +90,29 @@ otInstance *esp_openthread_get_instance(void);
  */
 esp_err_t esp_openthread_mainloop_exit(void);
 
+/**
+ * @brief   Starts the full OpenThread stack and create a handle task.
+ *
+ * @note The OpenThread instance will also be initialized in this function.
+ *
+ * @param[in]  config      The OpenThread platform configuration.
+ *
+ * @return
+ *      - ESP_OK on success
+ *      - ESP_ERR_INVALID_STATE if already initialized
+ *
+ */
+esp_err_t esp_openthread_start(esp_openthread_platform_config_t *config);
+
+/**
+ * @brief This function performs OpenThread stack and platform driver deinitialization and delete the handle task.
+ * @return
+ *      - ESP_OK on success
+ *      - ESP_ERR_INVALID_STATE if Thread is already active
+ *
+ */
+esp_err_t esp_openthread_stop(void);
+
 #ifdef __cplusplus
 } // end of extern "C"
 #endif

components/openthread/private_include/esp_openthread_ncp.h

@@ -1,10 +1,11 @@
 /*
- * SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2024-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */
 
 #include <spinel.h>
+#include <esp_openthread.h>
 
 #if CONFIG_OPENTHREAD_NCP_VENDOR_HOOK
 
@@ -15,3 +16,13 @@
 #define SPINEL_PROP_VENDOR_ESP_COEX_EVENT (SPINEL_PROP_VENDOR_ESP__BEGIN + 3)
 
 #endif
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+void otAppNcpInit(otInstance *aInstance);
+
+#ifdef __cplusplus
+}
+#endif

components/openthread/private_include/esp_openthread_platform.h

@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2021-2024 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2021-2025 Espressif Systems (Shanghai) CO LTD
  *
  * SPDX-License-Identifier: Apache-2.0
  */

components/openthread/src/esp_openthread.cpp

@@ -4,12 +4,17 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+#include "sdkconfig.h"
 #include "esp_openthread.h"
 #include "esp_check.h"
+#include "esp_heap_caps.h"
 #include "esp_openthread_border_router.h"
 #include "esp_openthread_common_macro.h"
+#include "esp_openthread_cli.h"
 #include "esp_openthread_dns64.h"
 #include "esp_openthread_lock.h"
+#include "esp_openthread_ncp.h"
+#include "esp_openthread_netif_glue.h"
 #include "esp_openthread_platform.h"
 #include "esp_openthread_sleep.h"
 #include "esp_openthread_state.h"
@@ -18,15 +23,19 @@
 #include "freertos/FreeRTOS.h"
 #include "lwip/dns.h"
 #include "openthread/instance.h"
+#include "openthread/logging.h"
 #include "openthread/netdata.h"
 #include "openthread/tasklet.h"
 #include "openthread/thread.h"
+#include <cstddef>
 
 #if CONFIG_OPENTHREAD_FTD
 #include "openthread/dataset_ftd.h"
 #endif
 
 static bool s_ot_mainloop_running = false;
+static SemaphoreHandle_t s_ot_syn_semaphore = NULL;
+static TaskHandle_t s_ot_task_handle = NULL;
 
 static int hex_digit_to_int(char hex)
 {
@@ -223,3 +232,81 @@ esp_err_t esp_openthread_deinit(void)
     otInstanceFinalize(esp_openthread_get_instance());
     return esp_openthread_platform_deinit();
 }
+
+static void ot_task_worker(void *aContext)
+{
+    esp_openthread_platform_config_t* config = (esp_openthread_platform_config_t *)aContext;
+    // Initialize the OpenThread stack
+    ESP_ERROR_CHECK(esp_openthread_init(config));
+
+#if CONFIG_OPENTHREAD_FTD || CONFIG_OPENTHREAD_MTD
+    esp_netif_config_t cfg = ESP_NETIF_DEFAULT_OPENTHREAD();
+    esp_netif_t *openthread_netif = esp_netif_new(&cfg);
+    assert(openthread_netif != NULL);
+    ESP_ERROR_CHECK(esp_netif_attach(openthread_netif, esp_openthread_netif_glue_init(config)));
+#endif
+
+#if CONFIG_OPENTHREAD_LOG_LEVEL_DYNAMIC
+    // The OpenThread log level directly matches ESP log level
+    (void)otLoggingSetLevel(CONFIG_LOG_DEFAULT_LEVEL);
+#endif // CONFIG_OPENTHREAD_LOG_LEVEL_DYNAMIC
+
+#if CONFIG_OPENTHREAD_CLI
+    esp_openthread_cli_init();
+    esp_openthread_cli_console_command_register();
+#endif // CONFIG_OPENTHREAD_CLI
+
+    xSemaphoreGive(s_ot_syn_semaphore);
+#if CONFIG_OPENTHREAD_RADIO
+    otAppNcpInit(esp_openthread_get_instance());
+#endif
+
+    // Run the main loop
+    esp_openthread_launch_mainloop();
+
+#if CONFIG_OPENTHREAD_RADIO
+    ESP_LOGE(OT_PLAT_LOG_TAG, "RCP deinitialization is not supported for now");
+    assert(false);
+#endif
+#if CONFIG_OPENTHREAD_CLI
+    esp_openthread_cli_console_command_unregister();
+#endif // CONFIG_OPENTHREAD_CLI
+
+#if CONFIG_OPENTHREAD_FTD || CONFIG_OPENTHREAD_MTD
+    // Clean up
+    esp_openthread_netif_glue_deinit();
+    esp_netif_destroy(openthread_netif);
+#endif
+
+    ESP_ERROR_CHECK(esp_openthread_deinit());
+
+    xSemaphoreGive(s_ot_syn_semaphore);
+    vTaskDelay(portMAX_DELAY);
+}
+
+esp_err_t esp_openthread_start(esp_openthread_platform_config_t *config)
+{
+    ESP_RETURN_ON_FALSE(s_ot_syn_semaphore == NULL, ESP_ERR_INVALID_STATE, OT_PLAT_LOG_TAG, "OpenThread has been initialized");
+    s_ot_syn_semaphore = xSemaphoreCreateBinary();
+    ESP_RETURN_ON_FALSE(s_ot_syn_semaphore != NULL, ESP_ERR_INVALID_STATE, OT_PLAT_LOG_TAG, "Failed to create s_ot_syn_semaphore");
+    assert(xTaskCreate(ot_task_worker, CONFIG_OPENTHREAD_TASK_NAME, CONFIG_OPENTHREAD_TASK_SIZE, config, CONFIG_OPENTHREAD_TASK_PRIORITY, &s_ot_task_handle) == pdPASS);
+    xSemaphoreTake(s_ot_syn_semaphore, portMAX_DELAY);
+    return ESP_OK;
+}
+
+esp_err_t esp_openthread_stop(void)
+{
+    ESP_RETURN_ON_FALSE(s_ot_syn_semaphore != NULL, ESP_ERR_INVALID_STATE, OT_PLAT_LOG_TAG, "OpenThread is not initialized");
+    esp_openthread_lock_acquire(portMAX_DELAY);
+    otInstance *instance = esp_openthread_get_instance();
+    bool is_thread_not_active = (otThreadGetDeviceRole(instance) == OT_DEVICE_ROLE_DISABLED && otIp6IsEnabled(instance) == false);
+    esp_openthread_lock_release();
+    ESP_RETURN_ON_FALSE(is_thread_not_active, ESP_ERR_INVALID_STATE, OT_PLAT_LOG_TAG, "Thread interface is still active");
+    esp_openthread_mainloop_exit();
+    xSemaphoreTake(s_ot_syn_semaphore, portMAX_DELAY);
+    vTaskDelete(s_ot_task_handle);
+    vSemaphoreDelete(s_ot_syn_semaphore);
+    s_ot_task_handle = NULL;
+    s_ot_syn_semaphore = NULL;
+    return ESP_OK;
+}

examples/openthread/ot_br/README.md

@@ -56,11 +56,11 @@ In order to run the example on single SoC which supports both Wi-Fi and Thread,
 Two ways are provided to setup the Thread Border Router in this example:
 
 - Auto Start
-Enable `OPENTHREAD_BR_AUTO_START`, configure the `CONFIG_EXAMPLE_WIFI_SSID` and `CONFIG_EXAMPLE_WIFI_PASSWORD` with your access point's ssid and psk.
+Enable `OPENTHREAD_NETWORK_AUTO_START`, configure the `CONFIG_EXAMPLE_WIFI_SSID` and `CONFIG_EXAMPLE_WIFI_PASSWORD` with your access point's ssid and psk.
 The device will connect to Wi-Fi and form a Thread network automatically after boot up.
 
 - Manual mode
-Disable `OPENTHREAD_BR_AUTO_START` and enable `OPENTHREAD_CLI_ESP_EXTENSION`. `wifi` command will be added for connecting the device to the Wi-Fi network.
+Disable `OPENTHREAD_NETWORK_AUTO_START` and enable `OPENTHREAD_CLI_ESP_EXTENSION`. `wifi` command will be added for connecting the device to the Wi-Fi network.
 
 If the `CONFIG_EXAMPLE_CONNECT_ETHERNET` option is enabled, the device will connect to `Ethernet`, form a Thread network and act as a Ethernet based Thread Border Router.
 
@@ -71,14 +71,14 @@ Build the project and flash it to the board, then run monitor tool to view seria
 ```
 idf.py -p PORT build flash monitor
 ```
-If the `OPENTHREAD_BR_AUTO_START` option is enabled, The device will be connected to the configured Wi-Fi and Thread network automatically then act as the border router.
+If the `OPENTHREAD_NETWORK_AUTO_START` option is enabled, The device will be connected to the configured Wi-Fi and Thread network automatically then act as the border router.
 
 Otherwise, you need to manually configure the networks with CLI commands.
 
 `wifi` command can be used to configure the Wi-Fi network.
 
 ```bash
-> wifi
+esp32s3> ot wifi
 --wifi parameter---
 connect
 -s                   :     wifi ssid
@@ -96,7 +96,7 @@ Done
 To join a Wi-Fi network, please use the `wifi connect` command:
 
 ```bash
-> wifi connect -s threadcertAP -p threadcertAP
+esp32s3> ot wifi connect -s threadcertAP -p threadcertAP
 ssid: threadcertAP
 psk: threadcertAP
 I (11331) wifi:wifi driver task: 3ffd06e4, prio:23, stack:6656, core=0
@@ -117,7 +117,7 @@ Done
 To get the state of the Wi-Fi network:
 
 ```bash
-> wifi state
+esp32s3> ot wifi state
 connected
 Done
 ```
@@ -165,7 +165,7 @@ For mobile devices, the route table rules will be automatically configured after
 Now in the Thread end device, check the IP addresses:
 
 ```
-> ipaddr
+esp32h2> ot ipaddr
 fde6:75ff:def4:3bc3:9e9e:3ef:4245:28b5
 fdde:ad00:beef:0:0:ff:fe00:c402
 fdde:ad00:beef:0:ad4a:9a9a:3cd6:e423
@@ -192,13 +192,13 @@ The newly introduced service registration protocol([SRP](https://datatracker.iet
 Now we'll publish the service `my-service._test._udp` with hostname `test0` and port 12345
 
 ```
-> srp client host name test0
+esp32h2> ot srp client host name test0
 Done
-> srp client host address fde6:75ff:def4:3bc3:9e9e:3ef:4245:28b5
+esp32h2> ot srp client host address fde6:75ff:def4:3bc3:9e9e:3ef:4245:28b5
 Done
-> srp client service add my-service _test._udp 12345
+esp32h2> ot srp client service add my-service _test._udp 12345
 Done
-> srp client autostart enable
+esp32h2> ot srp client autostart enable
 Done
 ```
 
@@ -233,7 +233,7 @@ Then get the border router's OMR prefix global unicast address(or ML-EID), and c
 
 On the border router:
 ```
-> ipaddr
+esp32s3> ot ipaddr
 fdde:ad00:beef:0:0:ff:fe00:fc10
 fd9b:347f:93f7:1:1003:8f00:bcc1:3038
 fdde:ad00:beef:0:0:ff:fe00:fc00
@@ -245,19 +245,19 @@ Done
 
 On the Thread end device:
 ```
-> dns config fd9b:347f:93f7:1:1003:8f00:bcc1:3038
+esp32h2> ot dns config fd9b:347f:93f7:1:1003:8f00:bcc1:3038
 (or
-> dns config fdde:ad00:beef:0:f891:287:866:776)
+esp32h2> ot dns config fdde:ad00:beef:0:f891:287:866:776)
 Done
 ```
 
 Now the service published on the Host can be discovered on the Thread end device.
 ```
-> dns resolve FA001208.default.service.arpa.
+esp32h2> ot dns resolve FA001208.default.service.arpa.
 DNS response for FA001208.default.service.arpa. - fdde:ad00:beef:cafe:b939:26be:7516:b87e TTL:120
 Done
 
-> dns browse _test._udp.default.service.arpa.
+esp32h2> ot dns browse _test._udp.default.service.arpa.
 DNS browse response for _test._udp.default.service.arpa.
 testhost
     Port:5683, Priority:0, Weight:0, TTL:120
@@ -266,7 +266,7 @@ testhost
     TXT:[test=31, dn=616162626262] TTL:120
 Done
 
-> dns service testhost _test._udp.default.service.arpa.
+esp32h2> ot dns service testhost _test._udp.default.service.arpa.
 DNS service resolution response for testhost for service _test._udp.default.service.arpa.
 Port:5683, Priority:0, Weight:0, TTL:120
 Host:FA001208.default.service.arpa.