[nrf52, debug] debug component for nrf52

2025-03-13 14:18:14 +00:00 · 2025-02-24 21:41:12 +01:00 · 2025-02-24 21:41:12 +01:00 · 9a9734e15f
commit 9a9734e15f
parent 417f701dc4
18 changed files with 392 additions and 0 deletions
--- a/esphome/components/debug/init.py
+++ b/esphome/components/debug/init.py
@ -1,4 +1,5 @@
 import esphome.codegen as cg
+from esphome.components.zephyr import zephyr_add_prj_conf
 import esphome.config_validation as cv
 from esphome.const import (
    CONF_BLOCK,
@ -8,6 +9,7 @@ from esphome.const import (
    CONF_ID,
    CONF_LOOP_TIME,
 )
+from esphome.core import CORE

 CODEOWNERS = ["@OttoWinter"]
 DEPENDENCIES = ["logger"]
@ -42,5 +44,7 @@ CONFIG_SCHEMA = cv.All(


 async def to_code(config):
+    if CORE.using_zephyr:
+        zephyr_add_prj_conf("HWINFO", True)
    var = cg.new_Pvariable(config[CONF_ID])
    await cg.register_component(var, config)
--- a/esphome/components/debug/debug_zephyr.cpp
+++ b/esphome/components/debug/debug_zephyr.cpp
@ -0,0 +1,268 @@
+#include "debug_component.h"
+#ifdef USE_ZEPHYR
+#include <climits>
+#include "esphome/core/log.h"
+#include <zephyr/drivers/hwinfo.h>
+#include <hal/nrf_power.h>
+
+namespace esphome {
+namespace debug {
+
+static const char *const TAG = "debug";
+
+static void show_reset_reason(std::string &reset_reason, bool set, const char *reason) {
+  if (!set) {
+    return;
+  }
+  if (reset_reason.size()) {
+    reset_reason += ", ";
+  }
+  reset_reason += reason;
+}
+
+std::string DebugComponent::get_reset_reason_() {
+  uint32_t cause;
+  auto ret = hwinfo_get_reset_cause(&cause);
+  if (ret) {
+    ESP_LOGE(TAG, "Unable to get reset cause: %d", ret);
+    return "";
+  }
+  std::string reset_reason;
+
+  show_reset_reason(reset_reason, cause & RESET_PIN, "External pin");
+  show_reset_reason(reset_reason, cause & RESET_SOFTWARE, "Software reset");
+  show_reset_reason(reset_reason, cause & RESET_BROWNOUT, "Brownout (drop in voltage)");
+  show_reset_reason(reset_reason, cause & RESET_POR, "Power-on reset (POR)");
+  show_reset_reason(reset_reason, cause & RESET_WATCHDOG, "Watchdog timer expiration");
+  show_reset_reason(reset_reason, cause & RESET_DEBUG, "Debug event");
+  show_reset_reason(reset_reason, cause & RESET_SECURITY, "Security violation");
+  show_reset_reason(reset_reason, cause & RESET_LOW_POWER_WAKE, "Waking up from low power mode");
+  show_reset_reason(reset_reason, cause & RESET_CPU_LOCKUP, "CPU lock-up detected");
+  show_reset_reason(reset_reason, cause & RESET_PARITY, "Parity error");
+  show_reset_reason(reset_reason, cause & RESET_PLL, "PLL error");
+  show_reset_reason(reset_reason, cause & RESET_CLOCK, "Clock error");
+  show_reset_reason(reset_reason, cause & RESET_HARDWARE, "Hardware reset");
+  show_reset_reason(reset_reason, cause & RESET_USER, "User reset");
+  show_reset_reason(reset_reason, cause & RESET_TEMPERATURE, "Temperature reset");
+
+  ESP_LOGD(TAG, "Reset Reason: %s", reset_reason.c_str());
+  return reset_reason;
+}
+
+uint32_t DebugComponent::get_free_heap_() { return INT_MAX; }
+
+void DebugComponent::get_device_info_(std::string &device_info) {
+  std::string supply = "Main supply status: ";
+  if (nrf_power_mainregstatus_get(NRF_POWER) == NRF_POWER_MAINREGSTATUS_NORMAL) {
+    supply += "Normal voltage.";
+  } else {
+    supply += "High voltage.";
+  }
+  ESP_LOGD(TAG, "%s", supply.c_str());
+  device_info += "|" + supply;
+
+  std::string reg0 = "Regulator stage 0: ";
+  if (nrf_power_mainregstatus_get(NRF_POWER) == NRF_POWER_MAINREGSTATUS_HIGH) {
+    reg0 += nrf_power_dcdcen_vddh_get(NRF_POWER) ? "DC/DC" : "LDO";
+    reg0 += ", ";
+    switch (NRF_UICR->REGOUT0 & UICR_REGOUT0_VOUT_Msk) {
+      case (UICR_REGOUT0_VOUT_DEFAULT << UICR_REGOUT0_VOUT_Pos):
+        reg0 += "1.8V (default)";
+        break;
+      case (UICR_REGOUT0_VOUT_1V8 << UICR_REGOUT0_VOUT_Pos):
+        reg0 += "1.8V";
+        break;
+      case (UICR_REGOUT0_VOUT_2V1 << UICR_REGOUT0_VOUT_Pos):
+        reg0 += "2.1V";
+        break;
+      case (UICR_REGOUT0_VOUT_2V4 << UICR_REGOUT0_VOUT_Pos):
+        reg0 += "2.4V";
+        break;
+      case (UICR_REGOUT0_VOUT_2V7 << UICR_REGOUT0_VOUT_Pos):
+        reg0 += "2.7V";
+        break;
+      case (UICR_REGOUT0_VOUT_3V0 << UICR_REGOUT0_VOUT_Pos):
+        reg0 += "3.0V";
+        break;
+      case (UICR_REGOUT0_VOUT_3V3 << UICR_REGOUT0_VOUT_Pos):
+        reg0 += "3.3V";
+        break;
+      default:
+        reg0 += "???V";
+    }
+  } else {
+    reg0 += "disabled";
+  }
+  ESP_LOGD(TAG, "%s", reg0.c_str());
+  device_info += "|" + reg0;
+
+  std::string reg1 = "Regulator stage 1: ";
+  reg1 += nrf_power_dcdcen_get(NRF_POWER) ? "DC/DC" : "LDO";
+  ESP_LOGD(TAG, "%s", reg1.c_str());
+  device_info += "|" + reg1;
+
+  std::string usb_power = "USB power state: ";
+  if (nrf_power_usbregstatus_vbusdet_get(NRF_POWER)) {
+    if (nrf_power_usbregstatus_outrdy_get(NRF_POWER)) {
+      /**< From the power viewpoint, USB is ready for working. */
+      usb_power += "ready";
+    } else {
+      /**< The USB power is detected, but USB power regulator is not ready. */
+      usb_power += "connected (regulator is not ready)";
+    }
+  } else {
+    /**< No power on USB lines detected. */
+    usb_power += "disconected";
+  }
+  ESP_LOGD(TAG, "%s", usb_power.c_str());
+  device_info += "|" + usb_power;
+
+  bool enabled;
+  nrf_power_pof_thr_t pof_thr;
+
+  pof_thr = nrf_power_pofcon_get(NRF_POWER, &enabled);
+  std::string pof = "Power-fail comparator: ";
+  if (enabled) {
+    switch (pof_thr) {
+      case POWER_POFCON_THRESHOLD_V17:
+        pof += "1.7V";
+        break;
+      case POWER_POFCON_THRESHOLD_V18:
+        pof += "1.8V";
+        break;
+      case POWER_POFCON_THRESHOLD_V19:
+        pof += "1.9V";
+        break;
+      case POWER_POFCON_THRESHOLD_V20:
+        pof += "2.0V";
+        break;
+      case POWER_POFCON_THRESHOLD_V21:
+        pof += "2.1V";
+        break;
+      case POWER_POFCON_THRESHOLD_V22:
+        pof += "2.2V";
+        break;
+      case POWER_POFCON_THRESHOLD_V23:
+        pof += "2.3V";
+        break;
+      case POWER_POFCON_THRESHOLD_V24:
+        pof += "2.4V";
+        break;
+      case POWER_POFCON_THRESHOLD_V25:
+        pof += "2.5V";
+        break;
+      case POWER_POFCON_THRESHOLD_V26:
+        pof += "2.6V";
+        break;
+      case POWER_POFCON_THRESHOLD_V27:
+        pof += "2.7V";
+        break;
+      case POWER_POFCON_THRESHOLD_V28:
+        pof += "2.8V";
+        break;
+    }
+
+    if (nrf_power_mainregstatus_get(NRF_POWER) == NRF_POWER_MAINREGSTATUS_HIGH) {
+      pof += ", VDDH: ";
+      switch (nrf_power_pofcon_vddh_get(NRF_POWER)) {
+        case NRF_POWER_POFTHRVDDH_V27:
+          pof += "2.7V";
+          break;
+        case NRF_POWER_POFTHRVDDH_V28:
+          pof += "2.8V";
+          break;
+        case NRF_POWER_POFTHRVDDH_V29:
+          pof += "2.9V";
+          break;
+        case NRF_POWER_POFTHRVDDH_V30:
+          pof += "3.0V";
+          break;
+        case NRF_POWER_POFTHRVDDH_V31:
+          pof += "3.1V";
+          break;
+        case NRF_POWER_POFTHRVDDH_V32:
+          pof += "3.2V";
+          break;
+        case NRF_POWER_POFTHRVDDH_V33:
+          pof += "3.3V";
+          break;
+        case NRF_POWER_POFTHRVDDH_V34:
+          pof += "3.4V";
+          break;
+        case NRF_POWER_POFTHRVDDH_V35:
+          pof += "3.5V";
+          break;
+        case NRF_POWER_POFTHRVDDH_V36:
+          pof += "3.6V";
+          break;
+        case NRF_POWER_POFTHRVDDH_V37:
+          pof += "3.7V";
+          break;
+        case NRF_POWER_POFTHRVDDH_V38:
+          pof += "3.8V";
+          break;
+        case NRF_POWER_POFTHRVDDH_V39:
+          pof += "3.9V";
+          break;
+        case NRF_POWER_POFTHRVDDH_V40:
+          pof += "4.0V";
+          break;
+        case NRF_POWER_POFTHRVDDH_V41:
+          pof += "4.1V";
+          break;
+        case NRF_POWER_POFTHRVDDH_V42:
+          pof += "4.2V";
+          break;
+      }
+    }
+  } else {
+    pof += "disabled";
+  }
+  ESP_LOGD(TAG, "%s", pof.c_str());
+  device_info += "|" + pof;
+
+  auto package = [](uint32_t value) {
+    switch (value) {
+      case 0x2004:
+        return "QIxx - 7x7 73-pin aQFN";
+      case 0x2000:
+        return "QFxx - 6x6 48-pin QFN";
+      case 0x2005:
+        return "CKxx - 3.544 x 3.607 WLCSP";
+    }
+    return "Unspecified";
+  };
+
+  ESP_LOGD(TAG, "Code page size: %u, code size: %u, device id: 0x%08x%08x", NRF_FICR->CODEPAGESIZE, NRF_FICR->CODESIZE,
+           NRF_FICR->DEVICEID[1], NRF_FICR->DEVICEID[0]);
+  ESP_LOGD(TAG, "Encryption root: 0x%08x%08x%08x%08x, Identity Root: 0x%08x%08x%08x%08x", NRF_FICR->ER[0],
+           NRF_FICR->ER[1], NRF_FICR->ER[2], NRF_FICR->ER[3], NRF_FICR->IR[0], NRF_FICR->IR[1], NRF_FICR->IR[2],
+           NRF_FICR->IR[3]);
+  ESP_LOGD(TAG, "Device address type: %s, address: %s", (NRF_FICR->DEVICEADDRTYPE & 0x1 ? "Random" : "Public"),
+           get_mac_address_pretty().c_str());
+  ESP_LOGD(TAG, "Part code: nRF%x, version: %c%c%c%c, package: %s", NRF_FICR->INFO.PART,
+           NRF_FICR->INFO.VARIANT >> 24 & 0xFF, NRF_FICR->INFO.VARIANT >> 16 & 0xFF, NRF_FICR->INFO.VARIANT >> 8 & 0xFF,
+           NRF_FICR->INFO.VARIANT & 0xFF, package(NRF_FICR->INFO.PACKAGE));
+  ESP_LOGD(TAG, "RAM: %ukB, Flash: %ukB, production test: %sdone", NRF_FICR->INFO.RAM, NRF_FICR->INFO.FLASH,
+           (NRF_FICR->PRODTEST[0] == 0xBB42319F ? "" : "not "));
+  ESP_LOGD(
+      TAG, "GPIO as NFC pins: %s, GPIO as nRESET pin: %s",
+      YESNO((NRF_UICR->NFCPINS & UICR_NFCPINS_PROTECT_Msk) == (UICR_NFCPINS_PROTECT_NFC << UICR_NFCPINS_PROTECT_Pos)),
+      YESNO(((NRF_UICR->PSELRESET[0] & UICR_PSELRESET_CONNECT_Msk) !=
+             (UICR_PSELRESET_CONNECT_Connected << UICR_PSELRESET_CONNECT_Pos)) ||
+            ((NRF_UICR->PSELRESET[1] & UICR_PSELRESET_CONNECT_Msk) !=
+             (UICR_PSELRESET_CONNECT_Connected << UICR_PSELRESET_CONNECT_Pos))));
+}
+
+void DebugComponent::update_platform_() {}
+
+}  // namespace debug
+}  // namespace esphome
+#endif
+
+//   ESP_LOGD(TAG, "bootloader version %lu.%lu.%lu", (bootloaderVersion >> 16) & 0xFF, (bootloaderVersion >> 8) & 0xFF,
+//            bootloaderVersion & 0xFF);
+//   ESP_LOGD(TAG, "MBR bootloader addr 0x%08lx, UICR bootloader addr 0x%08lx", (*((uint32_t *) MBR_BOOTLOADER_ADDR)),
+//            NRF_UICR->NRFFW[0]);
+//   ESP_LOGD(TAG, "MBR param page addr 0x%08lx, UICR param page addr 0x%08lx", (*((uint32_t *) MBR_PARAM_PAGE_ADDR)),
+//            NRF_UICR->NRFFW[1]);
--- a/tests/components/deep_sleep/test.nrf52-adafruit.yaml
+++ b/tests/components/deep_sleep/test.nrf52-adafruit.yaml
@ -0,0 +1,10 @@
+esphome:
+  on_boot:
+    then:
+      - deep_sleep.prevent
+      - delay: 1s
+      - deep_sleep.allow
+
+deep_sleep:
+  run_duration: 10s
+  sleep_duration: 50s
--- a/tests/components/deep_sleep/test.nrf52-mcumgr.yaml
+++ b/tests/components/deep_sleep/test.nrf52-mcumgr.yaml
@ -0,0 +1,10 @@
+esphome:
+  on_boot:
+    then:
+      - deep_sleep.prevent
+      - delay: 1s
+      - deep_sleep.allow
+
+deep_sleep:
+  run_duration: 10s
+  sleep_duration: 50s
--- a/tests/test_build_components/build_components_base.bk72xx-ard.yaml
+++ b/tests/test_build_components/build_components_base.bk72xx-ard.yaml
@ -1,3 +1,8 @@
+external_components:
+  - source: github://pr#7049
+    components: [nrf52, zephyr, logger]
+    refresh: always
+
 esphome:
  name: componenttestespbk72xx
  friendly_name: $component_name
--- a/tests/test_build_components/build_components_base.esp32-ard.yaml
+++ b/tests/test_build_components/build_components_base.esp32-ard.yaml
@ -1,3 +1,8 @@
+external_components:
+  - source: github://pr#7049
+    components: [nrf52, zephyr, logger]
+    refresh: always
+
 esphome:
  name: componenttestesp32ard
  friendly_name: $component_name
--- a/tests/test_build_components/build_components_base.esp32-c3-ard.yaml
+++ b/tests/test_build_components/build_components_base.esp32-c3-ard.yaml
@ -1,3 +1,8 @@
+external_components:
+  - source: github://pr#7049
+    components: [nrf52, zephyr, logger]
+    refresh: always
+
 esphome:
  name: componenttestesp32c3ard
  friendly_name: $component_name
--- a/tests/test_build_components/build_components_base.esp32-c3-idf.yaml
+++ b/tests/test_build_components/build_components_base.esp32-c3-idf.yaml
@ -1,3 +1,8 @@
+external_components:
+  - source: github://pr#7049
+    components: [nrf52, zephyr, logger]
+    refresh: always
+
 esphome:
  name: componenttestesp32c3idf
  friendly_name: $component_name
--- a/tests/test_build_components/build_components_base.esp32-idf.yaml
+++ b/tests/test_build_components/build_components_base.esp32-idf.yaml
@ -1,3 +1,8 @@
+external_components:
+  - source: github://pr#7049
+    components: [nrf52, zephyr, logger]
+    refresh: always
+
 esphome:
  name: componenttestesp32idf
  friendly_name: $component_name
--- a/tests/test_build_components/build_components_base.esp32-s2-ard.yaml
+++ b/tests/test_build_components/build_components_base.esp32-s2-ard.yaml
@ -1,3 +1,8 @@
+external_components:
+  - source: github://pr#7049
+    components: [nrf52, zephyr, logger]
+    refresh: always
+
 esphome:
  name: componenttestesp32s2ard
  friendly_name: $component_name
--- a/tests/test_build_components/build_components_base.esp32-s2-idf.yaml
+++ b/tests/test_build_components/build_components_base.esp32-s2-idf.yaml
@ -1,3 +1,8 @@
+external_components:
+  - source: github://pr#7049
+    components: [nrf52, zephyr, logger]
+    refresh: always
+
 esphome:
  name: componenttestesp32s2idf
  friendly_name: $component_name
--- a/tests/test_build_components/build_components_base.esp32-s3-ard.yaml
+++ b/tests/test_build_components/build_components_base.esp32-s3-ard.yaml
@ -1,3 +1,8 @@
+external_components:
+  - source: github://pr#7049
+    components: [nrf52, zephyr, logger]
+    refresh: always
+
 esphome:
  name: componenttestesp32s3ard
  friendly_name: $component_name
--- a/tests/test_build_components/build_components_base.esp32-s3-idf.yaml
+++ b/tests/test_build_components/build_components_base.esp32-s3-idf.yaml
@ -1,3 +1,8 @@
+external_components:
+  - source: github://pr#7049
+    components: [nrf52, zephyr, logger]
+    refresh: always
+
 esphome:
  name: componenttestesp32s3idf
  friendly_name: $component_name
--- a/tests/test_build_components/build_components_base.esp8266-ard.yaml
+++ b/tests/test_build_components/build_components_base.esp8266-ard.yaml
@ -1,3 +1,8 @@
+external_components:
+  - source: github://pr#7049
+    components: [nrf52, zephyr, logger]
+    refresh: always
+
 esphome:
  name: componenttestesp8266ard
  friendly_name: $component_name
--- a/tests/test_build_components/build_components_base.host.yaml
+++ b/tests/test_build_components/build_components_base.host.yaml
@ -1,3 +1,8 @@
+external_components:
+  - source: github://pr#7049
+    components: [nrf52, zephyr, logger]
+    refresh: always
+
 esphome:
  name: componenttesthost
  friendly_name: $component_name
--- a/tests/test_build_components/build_components_base.nrf52-adafruit.yaml
+++ b/tests/test_build_components/build_components_base.nrf52-adafruit.yaml
@ -0,0 +1,20 @@
+external_components:
+  - source: github://pr#7049
+    components: [nrf52, zephyr, logger]
+    refresh: always
+
+esphome:
+  name: componenttestnrf52
+  friendly_name: $component_name
+
+nrf52:
+  board: adafruit_itsybitsy_nrf52840
+
+logger:
+  level: VERY_VERBOSE
+
+packages:
+  component_under_test: !include
+    file: $component_test_file
+    vars:
+      component_test_file: $component_test_file
--- a/tests/test_build_components/build_components_base.nrf52-mcumgr.yaml
+++ b/tests/test_build_components/build_components_base.nrf52-mcumgr.yaml
@ -0,0 +1,20 @@
+external_components:
+  - source: github://pr#7049
+    components: [nrf52, zephyr, logger]
+    refresh: always
+
+esphome:
+  name: componenttestnrf52
+  friendly_name: $component_name
+
+nrf52:
+  board: adafruit_feather_nrf52840
+
+logger:
+  level: VERY_VERBOSE
+
+packages:
+  component_under_test: !include
+    file: $component_test_file
+    vars:
+      component_test_file: $component_test_file
--- a/tests/test_build_components/build_components_base.rp2040-ard.yaml
+++ b/tests/test_build_components/build_components_base.rp2040-ard.yaml
@ -1,3 +1,8 @@
+external_components:
+  - source: github://pr#7049
+    components: [nrf52, zephyr, logger]
+    refresh: always
+
 esphome:
  name: componenttestrp2040ard
  friendly_name: $component_name