Merge branch 'feat/enable_port_c_for_m5stack' into 'main'

feat: add support for Unit Gateway H2 in the M5Stack example

See merge request espressif/esp-thread-br!173

Author: zwx1995esp

examples/common/thread_border_router_m5stack/Kconfig.projbuild

@@ -1,15 +1,38 @@
 menu "ESP Thread Border Router M5Stack Example"
 
-    config OPENTHREAD_EPHEMERALKEY_LIFE_TIME
-        int "The life time (seconds) of openthread ephemeral key"
-        default 100
+    choice RADIO_CO_PROCESSOR_MODE
+        prompt "IEEE 802.15.4 Radio Co-Processor Mode"
+        default RADIO_CO_PROCESSOR_MODULE_H2
         help
-            Set the lifetime of the OpenThread ephemeral key in seconds.
+            Select the target hardware configuration for the IEEE 802.15.4 Radio Co-Processor.
 
-    config OPENTHREAD_EPHEMERALKEY_PORT
-        int "The UDP port to use with the ephemeral key"
-        default 49180
-        help
-            Set the UDP port to use with the ephemeral key.
+        config RADIO_CO_PROCESSOR_MODULE_H2
+            bool "Module Gateway H2"
+            help
+                Select this if you are using a Module Gateway H2.
+
+        config RADIO_CO_PROCESSOR_UNIT_H2
+            bool "Unit Gateway H2"
+            help
+                Select this if you are using a Unit Gateway H2, the following must be ensured:
+                    1. Connect the CoreS3 and Module Gateway H2 via PORT C.
+                    2. Disable the AUTO_UPDATE_RCP feature.
+                    3. Set PIN_TO_RCP_TX to 18 and PIN_TO_RCP_RX to 17.
+    endchoice # RADIO_CO_PROCESSOR_MODE
+
+    menu "Thread Ephemeral Key Configurations"
+        config OPENTHREAD_EPHEMERALKEY_LIFE_TIME
+            int "The life time (seconds) of openthread ephemeral key"
+            default 100
+            help
+                Set the lifetime of the OpenThread ephemeral key in seconds.
+
+        config OPENTHREAD_EPHEMERALKEY_PORT
+            int "The UDP port to use with the ephemeral key"
+            default 49180
+            help
+                Set the UDP port to use with the ephemeral key.
+
+    endmenu
 
 endmenu

examples/common/thread_border_router_m5stack/private_include/br_m5stack_power.h

@@ -0,0 +1,24 @@
+/*
+ * SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: CC0-1.0
+ *
+ */
+
+#pragma once
+
+#include "esp_err.h"
+
+#define BSP_AW9523_ADDR 0x58
+#define CORE_S3_BUS_OUT_EN BIT(1)
+#define CORE_S3_BOOST_EN BIT(7)
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+esp_err_t br_m5stack_enable_port_c_power(void);
+
+#ifdef __cplusplus
+} /* extern "C" */
+#endif

examples/common/thread_border_router_m5stack/src/border_router_m5stack.c

@@ -9,13 +9,17 @@
 
 #include "br_m5stack_animation.h"
 #include "br_m5stack_layout.h"
+#include "br_m5stack_power.h"
 
 #include "esp_err.h"
 #include "bsp/esp-bsp.h"
 
 static void ot_br_m5stack_worker(void *ctx)
 {
     br_m5stack_bsp_init();
+#if CONFIG_RADIO_CO_PROCESSOR_UNIT_H2
+    ESP_ERROR_CHECK(br_m5stack_enable_port_c_power());
+#endif
     br_m5stack_display_init();
     boot_animation_start(br_m5stack_create_ui);
 

examples/common/thread_border_router_m5stack/src/br_m5stack_power.c

@@ -0,0 +1,44 @@
+/*
+ * SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: CC0-1.0
+ *
+ */
+
+#include "br_m5stack_power.h"
+#include "br_m5stack_common.h"
+
+#include "esp_check.h"
+#include "esp_err.h"
+#include "bsp/esp-bsp.h"
+
+esp_err_t br_m5stack_enable_port_c_power(void)
+{
+    esp_err_t ret = ESP_OK;
+    uint8_t data[2];
+    uint8_t val = 0;
+
+    data[0] = 0x02;
+    ESP_GOTO_ON_ERROR(i2c_master_write_read_device(BSP_I2C_NUM, BSP_AW9523_ADDR, data, 1, &val, 1, pdMS_TO_TICKS(1000)),
+                      exit, "", "");
+    data[1] = val | CORE_S3_BUS_OUT_EN;
+    ESP_GOTO_ON_ERROR(i2c_master_write_to_device(BSP_I2C_NUM, BSP_AW9523_ADDR, data, sizeof(data), pdMS_TO_TICKS(1000)),
+                      exit, "", "");
+
+    data[0] = 0x03;
+    ESP_GOTO_ON_ERROR(i2c_master_write_read_device(BSP_I2C_NUM, BSP_AW9523_ADDR, data, 1, &val, 1, pdMS_TO_TICKS(1000)),
+                      exit, "", "");
+    data[1] = val | CORE_S3_BOOST_EN;
+    ESP_GOTO_ON_ERROR(i2c_master_write_to_device(BSP_I2C_NUM, BSP_AW9523_ADDR, data, sizeof(data), pdMS_TO_TICKS(1000)),
+                      exit, "", "");
+
+    data[0] = 0x11;
+    data[1] = 0x10;
+    ret = i2c_master_write_to_device(BSP_I2C_NUM, BSP_AW9523_ADDR, data, sizeof(data), pdMS_TO_TICKS(1000));
+
+exit:
+    if (ret != ESP_OK) {
+        ESP_LOGE(BR_M5STACK_TAG, "Failed to enable PORT.C for M5Stack.");
+    }
+    return ret;
+}

examples/m5stack_thread_border_router/README.md

@@ -13,7 +13,19 @@ It connects to a pre-configured Wi-Fi network and automatically forms a Thread n
 This example requires the M5Stack CoreS3 along with the ESP32-H2 Thread/Zigbee Gateway Module. Please refer to:
 
 - [M5Stack CoreS3](https://shop.m5stack.com/products/m5stack-cores3-esp32s3-lotdevelopment-kit)
+<p align="center">
+  <img src="images/M5Stack-CoreS3.png" alt="M5Stack CoreS3" width="400"/>
+</p>
+
 - [ESP32-H2 Thread/Zigbee Gateway Module](https://shop.m5stack.com/products/esp32-h2-thread-zigbee-gateway-module)
+<p align="center">
+  <img src="images/ESP32-H2-Thread-Zigbee-Gateway-Module.png" alt="ESP32-H2 Thread/Zigbee Gateway Module" width="400"/>
+</p>
+
+- [ESP32-H2 Thread/Zigbee Gateway Unit](https://shop.m5stack.com/products/esp32-h2-thread-zigbee-gateway-unit)
+<p align="center">
+  <img src="images/ESP32-H2-Thread-Zigbee-Gateway-Unit.png" alt="ESP32-H2 Thread/Zigbee Gateway Unit" width="400"/>
+</p>
 
 ### IDF Version Required
 
@@ -56,3 +68,14 @@ Upon startup, the device will connect to the pre-configured Wi-Fi network and jo
 4. `Thread`: This button is used to view and configure basic Thread parameters.
 
 This example can be used in conjunction with an external Commissioner such as `ot-commissioner`. The ephemeral key allows the Commissioner to connect to the Thread Border Router over Wi-Fi. Once connected, the Commissioner can retrieve or configure parameters for the Border Router and its child nodes via the same network.
+
+### Adapting to Unit Gateway H2
+The above configuration process is intended for use with the [Module Gateway H2](https://docs.m5stack.com/en/module/Module%20Gateway%20H2). If you are using the [Unit Gateway H2](https://docs.m5stack.com/en/unit/Unit%20Gateway%20H2), please follow the steps below:
+
+1. Hardware Setup: Prepare a Unit Gateway H2 flashed with `ot_rcp` and connect it to the M5Stack via `PORT.C`.
+2. Build Configuration:
+   * Enable the `RADIO_CO_PROCESSOR_UNIT_H2` feature via menuconfig.
+   * Disable the `AUTO_UPDATE_RCP` feature via menuconfig.
+   * Set `PIN_TO_RCP_TX` to `18` and `PIN_TO_RCP_RX` to `17` via menuconfig.
+
+After that, build and flash as usual. The example will then operate using the Unit Gateway H2.

examples/m5stack_thread_border_router/images/ESP32-H2-Thread-Zigbee-Gateway-Module.png

@@ -121,6 +121,6 @@ void app_main(void)
     esp_br_web_start("/spiffs");
 #endif
 
-    launch_openthread_border_router(&platform_config, &rcp_update_config);
     ESP_ERROR_CHECK(border_router_m5stack_init());
+    launch_openthread_border_router(&platform_config, &rcp_update_config);
 }