mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2025-12-13 08:33:49 +01:00
100 lines
2.6 KiB
C
100 lines
2.6 KiB
C
/*
|
|
* SPDX-FileCopyrightText: 2014-2015 INRIA
|
|
* SPDX-License-Identifier: LGPL-2.1-only
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
/**
|
|
* @ingroup core_util
|
|
* @{
|
|
*
|
|
* @file
|
|
* @brief Crash handling header
|
|
*
|
|
* Define a ::core_panic function that allows to stop/reboot the system
|
|
* when an unrecoverable problem has occurred.
|
|
*
|
|
* @author Kévin Roussel <Kevin.Roussel@inria.fr>
|
|
*/
|
|
|
|
#include "kernel_defines.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief Automatically reboot the system on panic()
|
|
*
|
|
* By default this is on when @ref DEVELHELP is disabled.
|
|
*/
|
|
#ifndef CONFIG_CORE_REBOOT_ON_PANIC
|
|
#ifdef DEVELHELP
|
|
#define CONFIG_CORE_REBOOT_ON_PANIC (0)
|
|
#else
|
|
#define CONFIG_CORE_REBOOT_ON_PANIC (1)
|
|
#endif
|
|
#endif
|
|
|
|
/**
|
|
* @brief Definition of available panic modes
|
|
*/
|
|
typedef enum {
|
|
PANIC_GENERAL_ERROR,
|
|
PANIC_SOFT_REBOOT,
|
|
PANIC_HARD_REBOOT,
|
|
PANIC_ASSERT_FAIL,
|
|
PANIC_EXPECT_FAIL,
|
|
PANIC_MEM_MANAGE, /**< memory management fault */
|
|
#ifdef MODULE_CORTEXM_COMMON
|
|
PANIC_NMI_HANDLER, /**< non maskable interrupt */
|
|
PANIC_HARD_FAULT, /**< hard fault */
|
|
#if defined(CPU_CORE_CORTEX_M3) || defined(CPU_CORE_CORTEX_M33) || \
|
|
defined(CPU_CORE_CORTEX_M4) || defined(CPU_CORE_CORTEX_M4F) || \
|
|
defined(CPU_CORE_CORTEX_M7)
|
|
PANIC_BUS_FAULT, /**< bus fault */
|
|
PANIC_USAGE_FAULT, /**< undefined instruction or unaligned access */
|
|
PANIC_DEBUG_MON, /**< debug interrupt */
|
|
#endif
|
|
PANIC_DUMMY_HANDLER, /**< unhandled interrupt */
|
|
#endif
|
|
PANIC_SSP, /**< stack smashing protector failure */
|
|
PANIC_STACK_OVERFLOW, /**< stack overflow detected */
|
|
PANIC_UNDEFINED
|
|
} core_panic_t;
|
|
|
|
/**
|
|
* @brief Handle an unrecoverable error by halting or rebooting the system
|
|
*
|
|
* A numeric code indicating the failure reason can be given
|
|
* as the *crash_code* parameter.
|
|
*
|
|
* Detailing the failure is possible using the *message* parameter.
|
|
* This function should serve a similar purpose as the panic()
|
|
* function of Unix/Linux kernels.
|
|
*
|
|
* If the DEVELHELP macro is defined, the system will be halted;
|
|
* the system will be rebooted otherwise.
|
|
*
|
|
* @warning this function NEVER returns!
|
|
*
|
|
* @param[in] crash_code a unique code for identifying the crash reason
|
|
* @param[in] message a human readable reason for the crash
|
|
* */
|
|
NORETURN void core_panic(core_panic_t crash_code, const char *message);
|
|
|
|
/**
|
|
* @brief architecture dependent handling of a panic case
|
|
*
|
|
* This function gives the CPU the possibility to execute architecture
|
|
* dependent code in case of a severe error.
|
|
*/
|
|
void panic_arch(void);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
/** @} */
|