feat(openthread): support vendor hook for rcp spi

2025-09-09 14:51:01 +02:00 · 2024-09-24 10:35:54 +08:00
parent b59b0e0926
commit 9c4d817726
17 changed files with 60 additions and 41 deletions
--- a/components/openthread/CMakeLists.txt
+++ b/components/openthread/CMakeLists.txt
@@ -168,6 +168,13 @@ if(CONFIG_OPENTHREAD_ENABLED)
    if(CONFIG_OPENTHREAD_NCP_VENDOR_HOOK)
        list(APPEND src_dirs
            "src/ncp")
+        if(CONFIG_OPENTHREAD_RCP_UART)
+            list(APPEND exclude_srcs
+                "src/ncp/esp_openthread_ncp_spi.cpp")
+        elseif(CONFIG_OPENTHREAD_RCP_SPI)
+            list(APPEND exclude_srcs
+                "src/ncp/esp_openthread_ncp_hdlc.cpp")
+        endif()
    endif()

    if(NOT CONFIG_OPENTHREAD_DNS64_CLIENT)
--- a/components/openthread/src/ncp/esp_openthread_ncp.cpp
+++ b/components/openthread/src/ncp/esp_openthread_ncp.cpp
@@ -4,12 +4,11 @@
 * SPDX-License-Identifier: Apache-2.0
 */

+#include "sdkconfig.h"
 #include "esp_ieee802154.h"
 #include "esp_openthread_ncp.h"
 #include "ncp_base.hpp"

-#if OPENTHREAD_ENABLE_NCP_VENDOR_HOOK
-
 #if CONFIG_OPENTHREAD_RCP_UART
 #include "utils/uart.h"
 #endif
@@ -107,5 +106,3 @@ otError NcpBase::VendorSetPropertyHandler(spinel_prop_key_t aPropKey)

 } // namespace Ncp
 } // namespace ot
-
-#endif // #if OPENTHREAD_ENABLE_NCP_VENDOR_HOOK
--- a/components/openthread/src/ncp/esp_openthread_ncp_hdlc.cpp
+++ b/components/openthread/src/ncp/esp_openthread_ncp_hdlc.cpp
@@ -1,5 +1,5 @@
 /*
- * SPDX-FileCopyrightText: 2023 Espressif Systems (Shanghai) CO LTD
+ * SPDX-FileCopyrightText: 2023-2024 Espressif Systems (Shanghai) CO LTD
 *
 * SPDX-License-Identifier: Apache-2.0
 */
@@ -7,8 +7,6 @@
 #include "common/new.hpp"
 #include "ncp_hdlc.hpp"

-#if OPENTHREAD_ENABLE_NCP_VENDOR_HOOK
-
 namespace ot {
 namespace Ncp {

@@ -29,5 +27,3 @@ extern "C" void otNcpHdlcInit(otInstance *aInstance, otNcpHdlcSendCallback aSend

 } // namespace Ncp
 } // namespace ot
-
-#endif // #if OPENTHREAD_ENABLE_NCP_VENDOR_HOOK
--- a/components/openthread/src/ncp/esp_openthread_ncp_spi.cpp
+++ b/components/openthread/src/ncp/esp_openthread_ncp_spi.cpp
@@ -0,0 +1,29 @@
+/*
+ * SPDX-FileCopyrightText: 2024 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include "common/new.hpp"
+#include "ncp_spi.hpp"
+
+namespace ot {
+namespace Ncp {
+
+static OT_DEFINE_ALIGNED_VAR(sNcpRaw, sizeof(NcpSpi), uint64_t);
+
+extern "C" void otNcpSpiInit(otInstance *aInstance)
+{
+    NcpSpi   *ncpSpi   = nullptr;
+    Instance *instance = static_cast<Instance *>(aInstance);
+
+    ncpSpi = new (&sNcpRaw) NcpSpi(instance);
+
+    if (ncpSpi == nullptr || ncpSpi != NcpBase::GetNcpInstance())
+    {
+        OT_ASSERT(false);
+    }
+}
+
+} // namespace Ncp
+} // namespace ot
--- a/examples/openthread/.build-test-rules.yml
+++ b/examples/openthread/.build-test-rules.yml
@@ -18,9 +18,9 @@ examples/openthread/ot_rcp:
  enable:
    - if: SOC_IEEE802154_SUPPORTED == 1
  disable_test:
-    - if: IDF_TARGET == "esp32h2"
+    - if: IDF_TARGET not in ["esp32h2", "esp32c6"]
      temporary: true
-      reason: only test on esp32c6
+      reason: only test on esp32h2 and esp32c6

 examples/openthread/ot_sleepy_device/deep_sleep:
  enable:
--- a/examples/openthread/ot_br/sdkconfig.ci.br_spi
+++ b/examples/openthread/ot_br/sdkconfig.ci.br_spi
@@ -0,0 +1 @@
+CONFIG_OPENTHREAD_RADIO_SPINEL_SPI=y
--- a/examples/openthread/ot_cli/sdkconfig.ci.cli
+++ b/examples/openthread/ot_cli/sdkconfig.ci.cli
--- a/examples/openthread/ot_cli/sdkconfig.ci.cli_c6
+++ b/examples/openthread/ot_cli/sdkconfig.ci.cli_c6
@@ -1,2 +0,0 @@
-CONFIG_IDF_TARGET="esp32c6"
-CONFIG_IDF_TARGET_ESP32C6=y
--- a/examples/openthread/ot_cli/sdkconfig.ci.cli_h2
+++ b/examples/openthread/ot_cli/sdkconfig.ci.cli_h2
@@ -1,2 +0,0 @@
-CONFIG_IDF_TARGET="esp32h2"
-CONFIG_IDF_TARGET_ESP32H2=y
--- a/examples/openthread/ot_cli/sdkconfig.ci.disable_cli
+++ b/examples/openthread/ot_cli/sdkconfig.ci.disable_cli
@@ -1,4 +1,2 @@
-CONFIG_IDF_TARGET="esp32h2"
-CONFIG_IDF_TARGET_ESP32H2=y
 CONFIG_OPENTHREAD_CLI=n
 CONFIG_OPENTHREAD_CLI_ESP_EXTENSION=n
--- a/examples/openthread/ot_rcp/sdkconfig.ci.rcp_spi
+++ b/examples/openthread/ot_rcp/sdkconfig.ci.rcp_spi
@@ -0,0 +1 @@
+CONFIG_OPENTHREAD_RCP_SPI=y
--- a/examples/openthread/ot_rcp/sdkconfig.ci.rcp_uart
+++ b/examples/openthread/ot_rcp/sdkconfig.ci.rcp_uart
--- a/examples/openthread/ot_sleepy_device/light_sleep/sdkconfig.ci.sleepy_c6
+++ b/examples/openthread/ot_sleepy_device/light_sleep/sdkconfig.ci.sleepy_c6
@@ -1,5 +1,3 @@
-CONFIG_IDF_TARGET="esp32c6"
-CONFIG_IDF_TARGET_ESP32C6=y
 CONFIG_OPENTHREAD_NETWORK_CHANNEL=12
 CONFIG_OPENTHREAD_NETWORK_MASTERKEY="aabbccddeeff00112233445566778899"
 CONFIG_ESP_SLEEP_DEBUG=y
--- a/examples/openthread/ot_sleepy_device/light_sleep/sdkconfig.ci.sleepy_h2
+++ b/examples/openthread/ot_sleepy_device/light_sleep/sdkconfig.ci.sleepy_h2
@@ -1,6 +0,0 @@
-CONFIG_IDF_TARGET="esp32h2"
-CONFIG_IDF_TARGET_ESP32H2=y
-CONFIG_OPENTHREAD_NETWORK_CHANNEL=12
-CONFIG_OPENTHREAD_NETWORK_MASTERKEY="aabbccddeeff00112233445566778899"
-CONFIG_ESP_SLEEP_DEBUG=y
-CONFIG_LOG_MAXIMUM_LEVEL_DEBUG=y
--- a/examples/openthread/ot_sleepy_device/light_sleep/sdkconfig.defaults.esp32c6
+++ b/examples/openthread/ot_sleepy_device/light_sleep/sdkconfig.defaults.esp32c6
@@ -1,5 +1,3 @@
-CONFIG_IDF_TARGET="esp32c6"
-
 #
 # Sleep Config
 #
--- a/examples/openthread/ot_sleepy_device/light_sleep/sdkconfig.defaults.esp32h2
+++ b/examples/openthread/ot_sleepy_device/light_sleep/sdkconfig.defaults.esp32h2
@@ -1 +0,0 @@
-CONFIG_IDF_TARGET="esp32h2"
--- a/examples/openthread/pytest_otbr.py
+++ b/examples/openthread/pytest_otbr.py
@@ -94,11 +94,16 @@ default_cli_ot_para = ocf.thread_parameter('router', '', '', '', False)
@pytest.mark.flaky(reruns=1, reruns_delay=1)
@pytest.mark.parametrize(
    'config, count, app_path, target', [
-        ('rcp|cli_h2|br', 3,
+        ('rcp_uart|cli|br', 3,
         f'{os.path.join(os.path.dirname(__file__), "ot_rcp")}'
         f'|{os.path.join(os.path.dirname(__file__), "ot_cli")}'
         f'|{os.path.join(os.path.dirname(__file__), "ot_br")}',
         'esp32c6|esp32h2|esp32s3'),
+        ('rcp_spi|cli|br_spi', 3,
+         f'{os.path.join(os.path.dirname(__file__), "ot_rcp")}'
+         f'|{os.path.join(os.path.dirname(__file__), "ot_cli")}'
+         f'|{os.path.join(os.path.dirname(__file__), "ot_br")}',
+         'esp32h2|esp32c6|esp32s3'),
    ],
    indirect=True,
 )
@@ -162,7 +167,7 @@ def formBasicWiFiThreadNetwork(br:IdfDut, cli:IdfDut) -> None:
@pytest.mark.flaky(reruns=0, reruns_delay=1)
@pytest.mark.parametrize(
    'config, count, app_path, target', [
-        ('rcp|cli_h2|br', 3,
+        ('rcp_uart|cli|br', 3,
         f'{os.path.join(os.path.dirname(__file__), "ot_rcp")}'
         f'|{os.path.join(os.path.dirname(__file__), "ot_cli")}'
         f'|{os.path.join(os.path.dirname(__file__), "ot_br")}',
@@ -211,7 +216,7 @@ def test_Bidirectional_IPv6_connectivity(Init_interface:bool, dut: Tuple[IdfDut,
@pytest.mark.flaky(reruns=1, reruns_delay=1)
@pytest.mark.parametrize(
    'config, count, app_path, target', [
-        ('rcp|cli_h2|br', 3,
+        ('rcp_uart|cli|br', 3,
         f'{os.path.join(os.path.dirname(__file__), "ot_rcp")}'
         f'|{os.path.join(os.path.dirname(__file__), "ot_cli")}'
         f'|{os.path.join(os.path.dirname(__file__), "ot_br")}',
@@ -251,7 +256,7 @@ def test_multicast_forwarding_A(Init_interface:bool, dut: Tuple[IdfDut, IdfDut,
@pytest.mark.flaky(reruns=1, reruns_delay=1)
@pytest.mark.parametrize(
    'config, count, app_path, target', [
-        ('rcp|cli_h2|br', 3,
+        ('rcp_uart|cli|br', 3,
         f'{os.path.join(os.path.dirname(__file__), "ot_rcp")}'
         f'|{os.path.join(os.path.dirname(__file__), "ot_cli")}'
         f'|{os.path.join(os.path.dirname(__file__), "ot_br")}',
@@ -302,7 +307,7 @@ def test_multicast_forwarding_B(Init_interface:bool, dut: Tuple[IdfDut, IdfDut,
@pytest.mark.flaky(reruns=1, reruns_delay=1)
@pytest.mark.parametrize(
    'config, count, app_path, target', [
-        ('rcp|cli_h2|br', 3,
+        ('rcp_uart|cli|br', 3,
         f'{os.path.join(os.path.dirname(__file__), "ot_rcp")}'
         f'|{os.path.join(os.path.dirname(__file__), "ot_cli")}'
         f'|{os.path.join(os.path.dirname(__file__), "ot_br")}',
@@ -358,7 +363,7 @@ def test_service_discovery_of_Thread_device(Init_interface:bool, Init_avahi:bool
@pytest.mark.flaky(reruns=1, reruns_delay=1)
@pytest.mark.parametrize(
    'config, count, app_path, target', [
-        ('rcp|cli_h2|br', 3,
+        ('rcp_uart|cli|br', 3,
         f'{os.path.join(os.path.dirname(__file__), "ot_rcp")}'
         f'|{os.path.join(os.path.dirname(__file__), "ot_cli")}'
         f'|{os.path.join(os.path.dirname(__file__), "ot_br")}',
@@ -421,7 +426,7 @@ def test_service_discovery_of_WiFi_device(Init_interface:bool, Init_avahi:bool,
@pytest.mark.flaky(reruns=1, reruns_delay=1)
@pytest.mark.parametrize(
    'config, count, app_path, target', [
-        ('rcp|cli_h2|br', 3,
+        ('rcp_uart|cli|br', 3,
         f'{os.path.join(os.path.dirname(__file__), "ot_rcp")}'
         f'|{os.path.join(os.path.dirname(__file__), "ot_cli")}'
         f'|{os.path.join(os.path.dirname(__file__), "ot_br")}',
@@ -456,7 +461,7 @@ def test_ICMP_NAT64(Init_interface:bool, dut: Tuple[IdfDut, IdfDut, IdfDut]) ->
@pytest.mark.flaky(reruns=1, reruns_delay=1)
@pytest.mark.parametrize(
    'config, count, app_path, target', [
-        ('rcp|cli_h2|br', 3,
+        ('rcp_uart|cli|br', 3,
         f'{os.path.join(os.path.dirname(__file__), "ot_rcp")}'
         f'|{os.path.join(os.path.dirname(__file__), "ot_cli")}'
         f'|{os.path.join(os.path.dirname(__file__), "ot_br")}',
@@ -509,7 +514,7 @@ def test_UDP_NAT64(Init_interface:bool, dut: Tuple[IdfDut, IdfDut, IdfDut]) -> N
@pytest.mark.flaky(reruns=1, reruns_delay=1)
@pytest.mark.parametrize(
    'config, count, app_path, target', [
-        ('rcp|cli_h2|br', 3,
+        ('rcp_uart|cli|br', 3,
         f'{os.path.join(os.path.dirname(__file__), "ot_rcp")}'
         f'|{os.path.join(os.path.dirname(__file__), "ot_cli")}'
         f'|{os.path.join(os.path.dirname(__file__), "ot_br")}',
@@ -566,11 +571,11 @@ def test_TCP_NAT64(Init_interface:bool, dut: Tuple[IdfDut, IdfDut, IdfDut]) -> N
@pytest.mark.openthread_sleep
@pytest.mark.parametrize(
    'config, count, app_path, target', [
-        ('cli_h2|sleepy_c6', 2,
+        ('cli|sleepy', 2,
         f'{os.path.join(os.path.dirname(__file__), "ot_cli")}'
         f'|{os.path.join(os.path.dirname(__file__), "ot_sleepy_device/light_sleep")}',
         'esp32h2|esp32c6'),
-        ('cli_c6|sleepy_h2', 2,
+        ('cli|sleepy', 2,
         f'{os.path.join(os.path.dirname(__file__), "ot_cli")}'
         f'|{os.path.join(os.path.dirname(__file__), "ot_sleepy_device/light_sleep")}',
         'esp32c6|esp32h2'),
@@ -618,7 +623,7 @@ def test_ot_sleepy_device(dut: Tuple[IdfDut, IdfDut]) -> None:
@pytest.mark.flaky(reruns=1, reruns_delay=1)
@pytest.mark.parametrize(
    'config, count, app_path, target', [
-        ('rcp|br', 2,
+        ('rcp_uart|br', 2,
         f'{os.path.join(os.path.dirname(__file__), "ot_rcp")}'
         f'|{os.path.join(os.path.dirname(__file__), "ot_br")}',
         'esp32c6|esp32s3'),
@@ -660,7 +665,7 @@ def test_basic_startup(dut: Tuple[IdfDut, IdfDut]) -> None:
@pytest.mark.flaky(reruns=1, reruns_delay=1)
@pytest.mark.parametrize(
    'config, count, app_path, target', [
-        ('rcp|br', 2,
+        ('rcp_uart|br', 2,
         f'{os.path.join(os.path.dirname(__file__), "ot_rcp")}'
         f'|{os.path.join(os.path.dirname(__file__), "ot_br")}',
         'esp32c6|esp32s3'),