4#ifdef USE_LIBRETINY_CRASH_HANDLER
8#if !defined(USE_BK72XX) && !defined(USE_LIBRETINY_CRASH_HANDLER_VECTOR_PATCH)
9#error "The LibreTiny crash handler has no fault capture for this chip family"
24#include <arm_mcu_pub.h>
32static_assert(
sizeof(arm_registers) == 18 *
sizeof(
uint32_t),
"SDK exception frame changed size");
33static_assert(offsetof(arm_registers, pc) == 15 * 4 && offsetof(arm_registers, spsr) == 16 * 4,
34 "SDK exception frame layout changed");
35static_assert(LT_HW_WATCHDOG,
"the crash reboot relies on the hardware watchdog");
51#ifdef USE_LIBRETINY_VARIANT_RTL8720C
63#ifdef USE_LIBRETINY_VARIANT_RTL8710B
92static constexpr uint32_t CRASH_MAGIC_V2 = 0xDEAD0002;
95static constexpr uint32_t CRASH_REASON_UNDEFINED = 1;
96static constexpr uint32_t CRASH_REASON_PREFETCH_ABORT = 2;
97static constexpr uint32_t CRASH_REASON_DATA_ABORT = 3;
99static constexpr uint32_t CRASH_REASON_CORTEX_M_OFFSET = 1;
101static constexpr uint32_t CRASH_REASON_ABORT = 9;
103 "Hard fault",
"MemManage fault",
"Bus fault",
"Usage fault",
"Secure fault",
"Abort");
105static constexpr size_t MAX_BACKTRACE = 8;
107static constexpr size_t STACK_SCAN_WORDS = 64;
122#define CRASH_RECORD_SECTION ".noinit"
123#elif defined(USE_LN882X)
125#define CRASH_RECORD_SECTION ".noinit"
126#elif defined(USE_LIBRETINY_VARIANT_RTL8710B)
129#define CRASH_RECORD_SECTION ".bfsram.data.esphome_crash"
132#define CRASH_RECORD_SECTION ".ram.bss.noinit.esphome_crash"
137static bool s_record_read =
false;
138static bool s_record_valid =
false;
141 if (!s_record_read) {
142 s_record_read =
true;
143 s_record_valid = s_record.magic == CRASH_MAGIC_V2;
147 return s_record_valid;
155 ESP_LOGE(TAG,
"*** CRASH DETECTED ON PREVIOUS BOOT ***");
156 ESP_LOGE(TAG,
" Reason: %s", LOG_STR_ARG(CrashReasonStrings::get_log_str(s_record.reason, 0)));
157 if (s_record.fault_status != 0) {
158 ESP_LOGE(TAG,
" CFSR: 0x%08" PRIX32
" Address: 0x%08" PRIX32, s_record.fault_status, s_record.fault_address);
160 ESP_LOGE(TAG,
" PC: 0x%08" PRIX32
" (fault location)", s_record.pc);
162 if (s_record.lr != 0) {
163 ESP_LOGE(TAG,
" LR: 0x%08" PRIX32
" (return address)", s_record.lr);
165 ESP_LOGE(TAG,
" SP: 0x%08" PRIX32, s_record.sp);
167 for (;
count < MAX_BACKTRACE && s_record.backtrace[
count] != 0;
count++) {
168 ESP_LOGE(TAG,
" BT%d: 0x%08" PRIX32
" (stack backtrace)",
count, s_record.backtrace[
count]);
172 int pos = snprintf(hint,
sizeof(hint),
"Use: addr2line -pfiaC -e raw_firmware.elf 0x%08" PRIX32, s_record.pc);
173 if (s_record.lr != 0)
174 pos += snprintf(hint +
pos,
sizeof(hint) -
pos,
" 0x%08" PRIX32, s_record.lr);
175 for (uint8_t i = 0; i <
count &&
pos < (int)
sizeof(hint) - 12; i++) {
176 pos += snprintf(hint +
pos,
sizeof(hint) -
pos,
" 0x%08" PRIX32, s_record.backtrace[i]);
178 ESP_LOGE(TAG,
"%s", hint);
188#elif defined(USE_LIBRETINY_VARIANT_RTL8710B)
191#elif defined(USE_LN882X)
202 s_record.reason = reason;
206 s_record.fault_status = fault_status;
207 s_record.fault_address = fault_address;
213 if (
sp >= sram_start &&
sp < sram_end && (
sp & 3) == 0) {
216 for (
size_t i = 0; i < STACK_SCAN_WORDS && scan <
end &&
count < MAX_BACKTRACE; i++, scan++) {
218 if (is_code_addr(
val) &&
val != s_record.lr && (
val & ~1u) != s_record.pc)
222 if (
count < MAX_BACKTRACE)
223 s_record.backtrace[
count] = 0;
224 s_record.magic = CRASH_MAGIC_V2;
232static constexpr uint32_t CRASH_REBOOT_WDT_MS = 500;
235static constexpr uint32_t SRAM_START = 0x00400000;
236#ifdef USE_LIBRETINY_VARIANT_BK7231N
237static constexpr uint32_t SRAM_END = 0x00430000;
239static constexpr uint32_t SRAM_END = 0x00440000;
242static constexpr uint32_t CPSR_MODE_MASK = 0x1F;
243static constexpr uint32_t CPSR_MODE_USR = 0x10;
244static constexpr uint32_t CPSR_MODE_FIQ = 0x11;
245static constexpr uint32_t CPSR_MODE_IRQ = 0x12;
246static constexpr uint32_t CPSR_MODE_SVC = 0x13;
247static constexpr uint32_t CPSR_MODE_ABT = 0x17;
248static constexpr uint32_t CPSR_MODE_UND = 0x1B;
249static constexpr uint32_t CPSR_MODE_SYS = 0x1F;
250static constexpr uint32_t CPSR_THUMB = 1u << 5;
258static constexpr SavedBank SAVED_BANKS[] = {
259 {CPSR_MODE_SYS, MCU_REG_BACKUP_SP_SYS}, {CPSR_MODE_IRQ, MCU_REG_BACKUP_SP_IRQ},
260 {CPSR_MODE_FIQ, MCU_REG_BACKUP_SP_FIQ}, {CPSR_MODE_ABT, MCU_REG_BACKUP_SP_ABT},
261 {CPSR_MODE_UND, MCU_REG_BACKUP_SP_UND}, {CPSR_MODE_SVC, MCU_REG_BACKUP_SP_SVC},
266 for (
const auto &bank : SAVED_BANKS) {
267 if (bank.mode !=
mode)
269 const auto *regs = (
const volatile uint32_t *) bank.sp_addr;
276static void record_crash(arm_registers *regs,
uint32_t reason,
uint32_t pc_offset) {
278 if (
mode == CPSR_MODE_USR)
279 mode = CPSR_MODE_SYS;
284 fill_record(reason, regs->pc - pc_offset,
lr,
sp, 0, 0);
285 finish_record(
sp, SRAM_START, SRAM_END);
293 record_crash(regs, CRASH_REASON_UNDEFINED, (regs->spsr & CPSR_THUMB) ? 2 : 4);
298 record_crash(regs, CRASH_REASON_PREFETCH_ABORT, 4);
303 record_crash(regs, CRASH_REASON_DATA_ABORT, 8);
310#ifdef USE_LIBRETINY_CRASH_HANDLER_VECTOR_PATCH
316static_assert(LT_HW_WATCHDOG,
"the crash reboot relies on the hardware watchdog");
319static constexpr uint32_t CRASH_REBOOT_WDT_MS = 1000;
320static constexpr uint32_t FIRST_FAULT_VECTOR = 3;
321#ifdef USE_LIBRETINY_VARIANT_RTL8720C
322static constexpr uint32_t FAULT_VECTOR_COUNT = 5;
324static constexpr uint32_t SRAM_START = 0x10000000;
325static constexpr uint32_t SRAM_END = 0x1003FA00;
326#elif defined(USE_LIBRETINY_VARIANT_RTL8710B)
327static constexpr uint32_t FAULT_VECTOR_COUNT = 4;
329static constexpr uint32_t SRAM_START = 0x10000000;
330static constexpr uint32_t SRAM_END = 0x10040000;
332static constexpr uint32_t FAULT_VECTOR_COUNT = 4;
334static constexpr uint32_t SRAM_START = 0x20000000;
335static constexpr uint32_t SRAM_END = 0x20049C00;
339static constexpr uintptr_t SCB_VTOR = 0xE000ED08;
340static constexpr uintptr_t SCB_CFSR = 0xE000ED28;
341static constexpr uintptr_t SCB_MMFAR = 0xE000ED34;
342static constexpr uintptr_t SCB_BFAR = 0xE000ED38;
343static constexpr uint32_t CFSR_MMARVALID = 1u << 7;
344static constexpr uint32_t CFSR_BFARVALID = 1u << 15;
347static constexpr uint32_t FRAME_LR = 5;
348static constexpr uint32_t FRAME_PC = 6;
349static constexpr uint32_t FRAME_XPSR = 7;
350static constexpr uint32_t FRAME_WORDS = 8;
351static constexpr uint32_t EXTENDED_FRAME_WORDS = 26;
352static constexpr uint32_t EXC_RETURN_STANDARD_FRAME = 1u << 4;
353static constexpr uint32_t XPSR_STACK_ALIGNED = 1u << 9;
356static uint32_t s_sdk_fault_vectors[FAULT_VECTOR_COUNT];
357static bool s_fault_recorded =
false;
359static inline uint32_t read_reg(uintptr_t addr) {
360 return *(
const volatile uint32_t *) addr;
368 if (s_fault_recorded) {
372 s_fault_recorded =
true;
378 }
else if (
cfsr & CFSR_MMARVALID) {
387 pc = frame[FRAME_PC];
388 lr = frame[FRAME_LR];
392 finish_record(
sp, SRAM_START, SRAM_END);
393 return s_sdk_fault_vectors[
vector - FIRST_FAULT_VECTOR];
400 __asm
volatile(
"push {r0-r3, r4, lr} \n"
406 "addeq r0, r0, #24 \n"
408 "ubfx r1, r1, #0, #9 \n"
410 "bl esphome_record_fault \n"
412 "pop {r0-r3, r4, lr} \n"
417 auto *vectors = (
uint32_t *) read_reg(SCB_VTOR);
418 for (
uint32_t i = 0; i < FAULT_VECTOR_COUNT; i++) {
419 s_sdk_fault_vectors[i] = vectors[FIRST_FAULT_VECTOR + i];
420 vectors[FIRST_FAULT_VECTOR + i] = (
uint32_t) &esphome_fault_entry;
430 portDISABLE_INTERRUPTS();
433 __asm
volatile(
"mov %0, sp" :
"=r"(
sp));
436 fill_record(CRASH_REASON_ABORT, ((
uint32_t) __builtin_return_address(0) & ~1u) - 2, 0,
sp, 0, 0);
439 for (
auto &addr : s_record.backtrace)
441 s_record.magic = CRASH_MAGIC_V2;
443 __asm
volatile(
"" :::
"memory");
444#ifdef USE_LIBRETINY_CRASH_HANDLER_VECTOR_PATCH
446 s_fault_recorded =
true;
448 finish_record(
sp, SRAM_START, SRAM_END);
BedjetMode mode
BedJet operating mode.
struct @66::@67 __attribute__
Wake the main loop task from an ISR. ISR-safe.
char __ram_entry_text_start__[]
void __real_bk_trap_udef(arm_registers *regs)
void __real_bk_trap_dabt(arm_registers *regs)
char __xip_code_text_end__[]
char _itcmcode_ram_begin[]
void __real_bk_trap_pabt(arm_registers *regs)
char __flash_text_start__[]
char __ram_code_text_end__[]
char __esphome_sram_text_start[]
char __esphome_sram_text_end[]
char __xip_code_text_start__[]
char __flash_text_end__[]
PROGMEM_STRING_TABLE(CrashReasonStrings, "Unknown", "Undefined instruction", "Prefetch abort", "Data abort", "Hard fault", "MemManage fault", "Bus fault", "Usage fault", "Secure fault", "Abort")
void __wrap_bk_trap_udef(arm_registers *regs)
lt_wdt_enable(CRASH_REBOOT_WDT_MS)
void crash_handler_install()
Put the crash recorder in front of the SDK's fault handlers.
void __wrap_bk_trap_dabt(arm_registers *regs)
void __wrap_bk_trap_pabt(arm_registers *regs)
void crash_handler_log()
Log crash data if a crash was detected on previous boot.
ESPHOME_LOG_TAG(TAG, "libretiny.crash")
bool crash_handler_has_data()
Returns true if crash data was found this boot, reading it first if needed.
uint32_t uint32_t exc_return