ESP8266_RTOS_SDK/components/freertos/port/esp8266/panic.c

// Copyright 2018 Espressif Systems (Shanghai) PTE LTD
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#include "stdlib.h"
#include <string.h>
#include "esp_attr.h"
#include "esp_libc.h"
#include "esp_system.h"
#include "esp_task_wdt.h"
#include "internal/esp_system_internal.h"

#include "esp8266/rom_functions.h"
#include "esp8266/backtrace.h"
#include "rom/ets_sys.h"
#include "rom/uart.h"
#include "esp_err.h"

#include "FreeRTOS.h"
#include "task.h"
#include "freertos/xtensa_context.h"

#define PANIC(_fmt, ...)    ets_printf(_fmt, ##__VA_ARGS__)

#if defined(CONFIG_ESP_PANIC_SILENT_REBOOT) || defined(CONFIG_ESP_PANIC_PRINT_REBOOT)
#define ESP_PANIC_REBOOT
#else
#undef ESP_PANIC_REBOOT
#endif

#if defined(CONFIG_ESP_PANIC_SILENT_REBOOT)
#undef ESP_PANIC_PRINT
#else
#define ESP_PANIC_PRINT
#endif

#if defined(CONFIG_ESP_PANIC_GDBSTUB)
#define ESP_PANIC_GDBSTUB
#else
#undef ESP_PANIC_GDBSTUB
#endif

#ifdef ESP_PANIC_PRINT
static inline void panic_frame(XtExcFrame *frame)
{
    static const char *sdesc[] = {
        "PC",   "PS",   "A0",   "A1",
        "A2",   "A3",   "A4",   "A5",
        "A6",   "A7",   "A8",   "A9",
        "A10",  "A11",  "A12",  "A13",
        "A14",  "A15",  "SAR",  "EXCCAUSE"
    };
    static const char *edesc[] = {
        "IllegalInstruction", "Syscall", "InstructionFetchError", "LoadStoreError",
        "Level1Interrupt", "Alloca", "IntegerDivideByZero", "PCValue",
        "Privileged", "LoadStoreAlignment", "res", "res",
        "InstrPDAddrError", "LoadStorePIFDataError", "InstrPIFAddrError", "LoadStorePIFAddrError",
        "InstTLBMiss", "InstTLBMultiHit", "InstFetchPrivilege", "res",
        "InstrFetchProhibited", "res", "res", "res",
        "LoadStoreTLBMiss", "LoadStoreTLBMultihit", "LoadStorePrivilege", "res",
        "LoadProhibited", "StoreProhibited",
    };

    void *i_lr = (void *)frame->a0;
    void *i_pc = (void *)frame->pc;
    void *i_sp = (void *)frame->a1;

    void *o_pc;
    void *o_sp;

#ifdef CONFIG_FREERTOS_WATCHPOINT_END_OF_STACK
    if (frame->exccause == 1) {
        uint32_t reason = soc_debug_reason();

        if (reason & XCHAL_DEBUGCAUSE_DBREAK_MASK) {
            char name[configMAX_TASK_NAME_LEN];

            strncpy(name, pcTaskGetTaskName(NULL), configMAX_TASK_NAME_LEN);
            ets_printf("Stack canary watchpoint triggered (%s)\n", name);
        }
    } else
#endif
    {
        const char *reason = frame->exccause < 30 ? edesc[frame->exccause] : "unknown";
        const uint32_t *regs = (const uint32_t *)frame;

        PANIC("Guru Meditation Error: Core  0 panic'ed (%s). Exception was unhandled.\r\n", reason);
        PANIC("Core 0 register dump:\n");

        for (int i = 0; i < 20; i += 4) {
            for (int j = 0; j < 4; j++) {
                PANIC("%-8s: 0x%08x  ", sdesc[i + j], regs[i + j + 1]);
            }
            PANIC("\r\n");
        }
    }

    PANIC("\r\nBacktrace: %p:%p ", i_pc, i_sp);
    while(xt_retaddr_callee(i_pc, i_sp, i_lr, &o_pc, &o_sp)) {
        PANIC("%p:%p ", o_pc, o_sp);
        i_pc = o_pc;
        i_sp = o_sp;
    }
    PANIC("\r\n");
}
#endif /* ESP_PANIC_PRINT */

#ifdef ESP_PANIC_REBOOT
static void hardware_restart(void)
{
    CLEAR_WDT_REG_MASK(WDT_CTL_ADDRESS, BIT0);
    WDT_REG_WRITE(WDT_OP_ADDRESS, 1);
    WDT_REG_WRITE(WDT_OP_ND_ADDRESS, 1);
    SET_PERI_REG_BITS(PERIPHS_WDT_BASEADDR + WDT_CTL_ADDRESS,
                      WDT_CTL_RSTLEN_MASK,
                      7 << WDT_CTL_RSTLEN_LSB,
                      0);
    SET_PERI_REG_BITS(PERIPHS_WDT_BASEADDR + WDT_CTL_ADDRESS,
                      WDT_CTL_RSPMOD_MASK,
                      0 << WDT_CTL_RSPMOD_LSB,
                      0);
    SET_PERI_REG_BITS(PERIPHS_WDT_BASEADDR + WDT_CTL_ADDRESS,
                      WDT_CTL_EN_MASK,
                      1 << WDT_CTL_EN_LSB,
                      0);
}

static void esp_panic_reset(void)
{
    uart_tx_wait_idle(0);
    uart_tx_wait_idle(1);

    esp_reset_reason_set_hint(ESP_RST_PANIC);

    hardware_restart();

    while (1);
}
#endif

void panicHandler(void *frame, int wdt)
{
    extern int _chip_nmi_cnt;

    _chip_nmi_cnt = 0;

    /* NMI can interrupt exception. */
    vPortEnterCritical();
    do {
        REG_WRITE(INT_ENA_WDEV, 0);
    } while (REG_READ(INT_ENA_WDEV) != 0);

#ifdef ESP_PANIC_PRINT
    if (wdt) {
        PANIC("Task watchdog got triggered.\r\n\r\n");
    }

    panic_frame(frame);
#endif

#ifdef ESP_PANIC_REBOOT
    esp_panic_reset();
#elif defined(ESP_PANIC_GDBSTUB)
    extern void esp_gdbstub_panic_handler(void *frame);

    PANIC("Entering gdb stub now.\r\n");
    esp_gdbstub_panic_handler(frame);
#else
    while (1) {
        esp_task_wdt_reset();
    }
#endif
}

static void esp_error_check_failed_print(const char *msg, esp_err_t rc, const char *file, int line, const char *function, const char *expression)
{
    PANIC("%s failed: esp_err_t 0x%x", msg, rc);
#ifdef CONFIG_ESP_ERR_TO_NAME_LOOKUP
    PANIC(" (%s)", esp_err_to_name(rc));
#endif //CONFIG_ESP_ERR_TO_NAME_LOOKUP
    PANIC(" at 0x%08x\n", (intptr_t)__builtin_return_address(0) - 3);

    // ESP8266 put main FreeRTOS code at flash
    //if (spi_flash_cache_enabled()) { // strings may be in flash cache
    PANIC("file: \"%s\" line %d\nfunc: %s\nexpression: %s\n", file, line, function, expression);
    //}
}

void _esp_error_check_failed_without_abort(esp_err_t rc, const char *file, int line, const char *function, const char *expression)
{
    esp_error_check_failed_print("ESP_ERROR_CHECK_WITHOUT_ABORT", rc, file, line, function, expression);
}

void _esp_error_check_failed(esp_err_t rc, const char *file, int line, const char *function, const char *expression)
{
    esp_error_check_failed_print("ESP_ERROR_CHECK", rc, file, line, function, expression);
    abort();
}