8#include <zephyr/drivers/hwinfo.h>
9#include <hal/nrf_power.h>
11#include <zephyr/storage/flash_map.h>
13#define BOOTLOADER_VERSION_REGISTER NRF_TIMER2->CC[0]
21static inline uint32_t read_mem_u32(uintptr_t addr) {
23 return *
reinterpret_cast<volatile uint32_t *
>(addr);
26static inline uint8_t read_mem_u8(uintptr_t addr) {
28 return *
reinterpret_cast<volatile uint8_t *
>(addr);
38static inline bool is_sd_present() {
47static inline uint32_t sd_version_get() {
56 ESP_LOGD(TAG,
"Reset Reason: %s", buf);
67static void fa_cb(
const struct flash_area *fa,
void *user_data) {
68#if CONFIG_FLASH_MAP_LABELS
69 const char *fa_label = flash_area_label(fa);
71 if (fa_label ==
nullptr) {
74 ESP_LOGCONFIG(TAG,
"%2d 0x%0*" PRIxPTR
" %-26s %-24.24s 0x%-10x 0x%-12x", (
int) fa->fa_id,
75 sizeof(uintptr_t) * 2, (uintptr_t) fa->fa_dev, fa->fa_dev->name, fa_label, (
uint32_t) fa->fa_off,
78 ESP_LOGCONFIG(TAG,
"%2d 0x%0*" PRIxPTR
" %-26s 0x%-10x 0x%-12x", (
int) fa->fa_id,
sizeof(uintptr_t) * 2,
79 (uintptr_t) fa->fa_dev, fa->fa_dev->name, (
uint32_t) fa->fa_off, fa->fa_size);
84#if CONFIG_FLASH_MAP_LABELS
85 ESP_LOGCONFIG(TAG,
"ID | Device | Device Name "
86 "| Label | Offset | Size");
87 ESP_LOGCONFIG(TAG,
"--------------------------------------------"
88 "-----------------------------------------------");
90 ESP_LOGCONFIG(TAG,
"ID | Device | Device Name "
92 ESP_LOGCONFIG(TAG,
"-----------------------------------------"
93 "------------------------------");
95 flash_area_foreach(fa_cb,
nullptr);
98#ifdef ESPHOME_LOG_HAS_VERBOSE
102#define NRF_PERIPH_ENABLED(periph, reg) \
103 YESNO(((reg)->ENABLE & periph##_ENABLE_ENABLE_Msk) == (periph##_ENABLE_ENABLE_Enabled << periph##_ENABLE_ENABLE_Pos))
106static void log_peripherals_info() {
108 ESP_LOGV(TAG,
"Peripherals status:");
109 ESP_LOGV(TAG,
" USBD: %-3s| UARTE0: %-3s| UARTE1: %-3s| UART0: %-3s",
110 NRF_PERIPH_ENABLED(USBD, NRF_USBD), NRF_PERIPH_ENABLED(UARTE, NRF_UARTE0),
111 NRF_PERIPH_ENABLED(UARTE, NRF_UARTE1), NRF_PERIPH_ENABLED(UART, NRF_UART0));
112 ESP_LOGV(TAG,
" TWIS0: %-3s| TWIS1: %-3s| TWIM0: %-3s| TWIM1: %-3s",
113 NRF_PERIPH_ENABLED(TWIS, NRF_TWIS0), NRF_PERIPH_ENABLED(TWIS, NRF_TWIS1),
114 NRF_PERIPH_ENABLED(TWIM, NRF_TWIM0), NRF_PERIPH_ENABLED(TWIM, NRF_TWIM1));
115 ESP_LOGV(TAG,
" TWI0: %-3s| TWI1: %-3s| COMP: %-3s| CCM: %-3s",
116 NRF_PERIPH_ENABLED(TWI, NRF_TWI0), NRF_PERIPH_ENABLED(TWI, NRF_TWI1), NRF_PERIPH_ENABLED(COMP, NRF_COMP),
117 NRF_PERIPH_ENABLED(CCM, NRF_CCM));
118 ESP_LOGV(TAG,
" PDM: %-3s| SPIS0: %-3s| SPIS1: %-3s| SPIS2: %-3s",
119 NRF_PERIPH_ENABLED(PDM, NRF_PDM), NRF_PERIPH_ENABLED(SPIS, NRF_SPIS0), NRF_PERIPH_ENABLED(SPIS, NRF_SPIS1),
120 NRF_PERIPH_ENABLED(SPIS, NRF_SPIS2));
121 ESP_LOGV(TAG,
" SPIM0: %-3s| SPIM1: %-3s| SPIM2: %-3s| SPIM3: %-3s",
122 NRF_PERIPH_ENABLED(SPIM, NRF_SPIM0), NRF_PERIPH_ENABLED(SPIM, NRF_SPIM1),
123 NRF_PERIPH_ENABLED(SPIM, NRF_SPIM2), NRF_PERIPH_ENABLED(SPIM, NRF_SPIM3));
124 ESP_LOGV(TAG,
" SPI0: %-3s| SPI1: %-3s| SPI2: %-3s| SAADC: %-3s",
125 NRF_PERIPH_ENABLED(SPI, NRF_SPI0), NRF_PERIPH_ENABLED(SPI, NRF_SPI1), NRF_PERIPH_ENABLED(SPI, NRF_SPI2),
126 NRF_PERIPH_ENABLED(SAADC, NRF_SAADC));
127 ESP_LOGV(TAG,
" QSPI: %-3s| QDEC: %-3s| LPCOMP: %-3s| I2S: %-3s",
128 NRF_PERIPH_ENABLED(QSPI, NRF_QSPI), NRF_PERIPH_ENABLED(QDEC, NRF_QDEC),
129 NRF_PERIPH_ENABLED(LPCOMP, NRF_LPCOMP), NRF_PERIPH_ENABLED(I2S, NRF_I2S));
130 ESP_LOGV(TAG,
" PWM0: %-3s| PWM1: %-3s| PWM2: %-3s| PWM3: %-3s",
131 NRF_PERIPH_ENABLED(PWM, NRF_PWM0), NRF_PERIPH_ENABLED(PWM, NRF_PWM1), NRF_PERIPH_ENABLED(PWM, NRF_PWM2),
132 NRF_PERIPH_ENABLED(PWM, NRF_PWM3));
133 ESP_LOGV(TAG,
" AAR: %-3s| QSPI deep power-down:%-3s| CRYPTOCELL: %-3s", NRF_PERIPH_ENABLED(AAR, NRF_AAR),
134 YESNO((NRF_QSPI->IFCONFIG0 & QSPI_IFCONFIG0_DPMENABLE_Msk) ==
135 (QSPI_IFCONFIG0_DPMENABLE_Enable << QSPI_IFCONFIG0_DPMENABLE_Pos)),
136 YESNO((NRF_CRYPTOCELL->ENABLE & CRYPTOCELL_ENABLE_ENABLE_Msk) ==
137 (CRYPTOCELL_ENABLE_ENABLE_Enabled << CRYPTOCELL_ENABLE_ENABLE_Pos)));
140#undef NRF_PERIPH_ENABLED
143static const char *regout0_to_str(
uint32_t value) {
145 case (UICR_REGOUT0_VOUT_DEFAULT):
146 return "1.8V (default)";
147 case (UICR_REGOUT0_VOUT_1V8):
149 case (UICR_REGOUT0_VOUT_2V1):
151 case (UICR_REGOUT0_VOUT_2V4):
153 case (UICR_REGOUT0_VOUT_2V7):
155 case (UICR_REGOUT0_VOUT_3V0):
157 case (UICR_REGOUT0_VOUT_3V3):
166 constexpr size_t size = DEVICE_INFO_BUFFER_SIZE;
167 char *buf =
buffer.data();
171 auto regstatus = nrf_power_mainregstatus_get(NRF_POWER);
172 const char *supply_status = (regstatus == NRF_POWER_MAINREGSTATUS_NORMAL) ?
"Normal voltage." :
"High voltage.";
173 ESP_LOGD(TAG,
"Main supply status: %s", supply_status);
178 if (nrf_power_mainregstatus_get(NRF_POWER) == NRF_POWER_MAINREGSTATUS_HIGH) {
179 const char *reg0_type = nrf_power_dcdcen_vddh_get(NRF_POWER) ?
"DC/DC" :
"LDO";
180 const char *reg0_voltage = regout0_to_str((NRF_UICR->REGOUT0 & UICR_REGOUT0_VOUT_Msk) >> UICR_REGOUT0_VOUT_Pos);
181 ESP_LOGD(TAG,
"Regulator stage 0: %s, %s", reg0_type, reg0_voltage);
186#ifdef USE_NRF52_REG0_VOUT
187 if ((NRF_UICR->REGOUT0 & UICR_REGOUT0_VOUT_Msk) >> UICR_REGOUT0_VOUT_Pos != USE_NRF52_REG0_VOUT) {
188 ESP_LOGE(TAG,
"Regulator stage 0: expected %s", regout0_to_str(USE_NRF52_REG0_VOUT));
192 ESP_LOGD(TAG,
"Regulator stage 0: disabled");
197 const char *reg1_type = nrf_power_dcdcen_get(NRF_POWER) ?
"DC/DC" :
"LDO";
198 ESP_LOGD(TAG,
"Regulator stage 1: %s", reg1_type);
203 const char *usb_state;
204 if (nrf_power_usbregstatus_vbusdet_get(NRF_POWER)) {
205 if (nrf_power_usbregstatus_outrdy_get(NRF_POWER)) {
208 usb_state =
"connected (regulator is not ready)";
211 usb_state =
"disconnected";
213 ESP_LOGD(TAG,
"USB power state: %s", usb_state);
219 nrf_power_pof_thr_t pof_thr = nrf_power_pofcon_get(NRF_POWER, &enabled);
221 const char *pof_voltage;
223 case POWER_POFCON_THRESHOLD_V17:
224 pof_voltage =
"1.7V";
226 case POWER_POFCON_THRESHOLD_V18:
227 pof_voltage =
"1.8V";
229 case POWER_POFCON_THRESHOLD_V19:
230 pof_voltage =
"1.9V";
232 case POWER_POFCON_THRESHOLD_V20:
233 pof_voltage =
"2.0V";
235 case POWER_POFCON_THRESHOLD_V21:
236 pof_voltage =
"2.1V";
238 case POWER_POFCON_THRESHOLD_V22:
239 pof_voltage =
"2.2V";
241 case POWER_POFCON_THRESHOLD_V23:
242 pof_voltage =
"2.3V";
244 case POWER_POFCON_THRESHOLD_V24:
245 pof_voltage =
"2.4V";
247 case POWER_POFCON_THRESHOLD_V25:
248 pof_voltage =
"2.5V";
250 case POWER_POFCON_THRESHOLD_V26:
251 pof_voltage =
"2.6V";
253 case POWER_POFCON_THRESHOLD_V27:
254 pof_voltage =
"2.7V";
256 case POWER_POFCON_THRESHOLD_V28:
257 pof_voltage =
"2.8V";
260 pof_voltage =
"???V";
264 if (nrf_power_mainregstatus_get(NRF_POWER) == NRF_POWER_MAINREGSTATUS_HIGH) {
265 const char *vddh_voltage;
266 switch (nrf_power_pofcon_vddh_get(NRF_POWER)) {
267 case NRF_POWER_POFTHRVDDH_V27:
268 vddh_voltage =
"2.7V";
270 case NRF_POWER_POFTHRVDDH_V28:
271 vddh_voltage =
"2.8V";
273 case NRF_POWER_POFTHRVDDH_V29:
274 vddh_voltage =
"2.9V";
276 case NRF_POWER_POFTHRVDDH_V30:
277 vddh_voltage =
"3.0V";
279 case NRF_POWER_POFTHRVDDH_V31:
280 vddh_voltage =
"3.1V";
282 case NRF_POWER_POFTHRVDDH_V32:
283 vddh_voltage =
"3.2V";
285 case NRF_POWER_POFTHRVDDH_V33:
286 vddh_voltage =
"3.3V";
288 case NRF_POWER_POFTHRVDDH_V34:
289 vddh_voltage =
"3.4V";
291 case NRF_POWER_POFTHRVDDH_V35:
292 vddh_voltage =
"3.5V";
294 case NRF_POWER_POFTHRVDDH_V36:
295 vddh_voltage =
"3.6V";
297 case NRF_POWER_POFTHRVDDH_V37:
298 vddh_voltage =
"3.7V";
300 case NRF_POWER_POFTHRVDDH_V38:
301 vddh_voltage =
"3.8V";
303 case NRF_POWER_POFTHRVDDH_V39:
304 vddh_voltage =
"3.9V";
306 case NRF_POWER_POFTHRVDDH_V40:
307 vddh_voltage =
"4.0V";
309 case NRF_POWER_POFTHRVDDH_V41:
310 vddh_voltage =
"4.1V";
312 case NRF_POWER_POFTHRVDDH_V42:
313 vddh_voltage =
"4.2V";
316 vddh_voltage =
"???V";
319 ESP_LOGD(TAG,
"Power-fail comparator: %s, VDDH: %s", pof_voltage, vddh_voltage);
325 ESP_LOGD(TAG,
"Power-fail comparator: %s", pof_voltage);
330 ESP_LOGD(TAG,
"Power-fail comparator: disabled");
334 auto package = [](uint32_t value) {
337 return "QIxx - 7x7 73-pin aQFN";
339 return "QFxx - 6x6 48-pin QFN";
341 return "CKxx - 3.544 x 3.607 WLCSP";
345 return "Unspecified";
348 char mac_pretty[MAC_ADDRESS_PRETTY_BUFFER_SIZE];
352 " Code page size: %u, code size: %u, device id: 0x%08x%08x\n"
353 " Encryption root: 0x%08x%08x%08x%08x, Identity Root: 0x%08x%08x%08x%08x\n"
354 " Device address type: %s, address: %s\n"
355 " Part code: nRF%x, version: %c%c%c%c, package: %s\n"
356 " RAM: %ukB, Flash: %ukB, production test: %sdone",
357 NRF_FICR->CODEPAGESIZE, NRF_FICR->CODESIZE, NRF_FICR->DEVICEID[1], NRF_FICR->DEVICEID[0], NRF_FICR->ER[0],
358 NRF_FICR->ER[1], NRF_FICR->ER[2], NRF_FICR->ER[3], NRF_FICR->IR[0], NRF_FICR->IR[1], NRF_FICR->IR[2],
359 NRF_FICR->IR[3], (NRF_FICR->DEVICEADDRTYPE & 0x1 ?
"Random" :
"Public"), mac_pretty, NRF_FICR->INFO.PART,
360 NRF_FICR->INFO.VARIANT >> 24 & 0xFF, NRF_FICR->INFO.VARIANT >> 16 & 0xFF, NRF_FICR->INFO.VARIANT >> 8 & 0xFF,
361 NRF_FICR->INFO.VARIANT & 0xFF, package(NRF_FICR->INFO.PACKAGE), NRF_FICR->INFO.RAM, NRF_FICR->INFO.FLASH,
362 (NRF_FICR->PRODTEST[0] == 0xBB42319F ?
"" :
"not "));
363 bool n_reset_enabled = NRF_UICR->PSELRESET[0] == NRF_UICR->PSELRESET[1] &&
364 (NRF_UICR->PSELRESET[0] & UICR_PSELRESET_CONNECT_Msk) == UICR_PSELRESET_CONNECT_Connected
365 << UICR_PSELRESET_CONNECT_Pos;
367 TAG,
" GPIO as NFC pins: %s, GPIO as nRESET pin: %s",
368 YESNO((NRF_UICR->NFCPINS & UICR_NFCPINS_PROTECT_Msk) == (UICR_NFCPINS_PROTECT_NFC << UICR_NFCPINS_PROTECT_Pos)),
369 YESNO(n_reset_enabled));
370 if (n_reset_enabled) {
371 uint8_t port = (NRF_UICR->PSELRESET[0] & UICR_PSELRESET_PORT_Msk) >> UICR_PSELRESET_PORT_Pos;
372 uint8_t pin = (NRF_UICR->PSELRESET[0] & UICR_PSELRESET_PIN_Msk) >> UICR_PSELRESET_PIN_Pos;
373 ESP_LOGD(TAG,
" nRESET port P%u.%02u", port, pin);
375#ifdef USE_BOOTLOADER_MCUBOOT
376 ESP_LOGD(TAG,
" Bootloader: mcuboot");
378 ESP_LOGD(TAG,
" Bootloader: Adafruit, version %u.%u.%u", (BOOTLOADER_VERSION_REGISTER >> 16) & 0xFF,
379 (BOOTLOADER_VERSION_REGISTER >> 8) & 0xFF, BOOTLOADER_VERSION_REGISTER & 0xFF);
380 ESP_LOGD(TAG,
" MBR bootloader addr 0x%08x, UICR bootloader addr 0x%08x", read_mem_u32(
MBR_BOOTLOADER_ADDR),
382 ESP_LOGD(TAG,
" MBR param page addr 0x%08x, UICR param page addr 0x%08x", read_mem_u32(
MBR_PARAM_PAGE_ADDR),
384 if (is_sd_present()) {
386 uint32_t const sd_version = sd_version_get();
389 ver[0] = sd_version / 1000000;
390 ver[1] = (sd_version - ver[0] * 1000000) / 1000;
391 ver[2] = (sd_version - ver[0] * 1000000 - ver[1] * 1000);
393 ESP_LOGD(TAG,
" SoftDevice: S%u %u.%u.%u", sd_id, ver[0], ver[1], ver[2]);
394#ifdef USE_SOFTDEVICE_ID
395#ifdef USE_SOFTDEVICE_VERSION
396 if (USE_SOFTDEVICE_ID != sd_id || USE_SOFTDEVICE_VERSION != ver[0]) {
397 ESP_LOGE(TAG,
"Built for SoftDevice S%u %u.x.y. It may crash due to mismatch of bootloader version.",
398 USE_SOFTDEVICE_ID, USE_SOFTDEVICE_VERSION);
401 if (USE_SOFTDEVICE_ID != sd_id) {
402 ESP_LOGE(TAG,
"Built for SoftDevice S%u. It may crash due to mismatch of bootloader version.", USE_SOFTDEVICE_ID);
409 char uicr_buf[13 * 9];
412 for (
size_t i = 0; i <
size; i++) {
413 len = buf_append_printf(uicr_buf,
sizeof(uicr_buf),
len, i > 0 ?
" %08" PRIX32 :
"%08" PRIX32, data[i]);
417 ESP_LOGD(TAG,
" NRFFW %s", uicr(NRF_UICR->NRFFW, 13));
418 ESP_LOGD(TAG,
" NRFHW %s", uicr(NRF_UICR->NRFHW, 12));
419#ifdef ESPHOME_LOG_HAS_VERBOSE
420 log_peripherals_info();
425void DebugComponent::update_platform_() {}
Heap-allocating helper functions.
const char * get_wakeup_cause_(std::span< char, WAKEUP_CAUSE_BUFFER_SIZE > buffer)
void log_partition_info_()
Logs information about the device's partition table.
size_t get_device_info_(std::span< char, DEVICE_INFO_BUFFER_SIZE > buffer, size_t pos)
uint32_t get_free_heap_()
const char * get_reset_reason_(std::span< char, RESET_REASON_BUFFER_SIZE > buffer)
constexpr std::uintptr_t MBR_PARAM_PAGE_ADDR
constexpr uintptr_t SD_ID_OFFSET
ESPHOME_LOG_TAG(TAG, "debug")
constexpr std::uintptr_t MBR_BOOTLOADER_ADDR
constexpr uintptr_t MBR_SIZE
constexpr uintptr_t SOFTDEVICE_INFO_STRUCT_OFFSET
constexpr uintptr_t SD_VERSION_OFFSET
constexpr uint32_t SD_MAGIC_NUMBER
std::span< const uint8_t > data
const char * get_reset_reason(std::span< char, RESET_REASON_BUFFER_SIZE > buffer)
size_t buf_append_str(char *buf, size_t size, size_t pos, const char *str)
Safely append a string to buffer, returning new position (capped at size).
const char * get_mac_address_pretty_into_buffer(std::span< char, MAC_ADDRESS_PRETTY_BUFFER_SIZE > buf)
Get the device MAC address into the given buffer, in colon-separated uppercase hex notation.