Loading...
Searching...
No Matches
panic.h File Reference

Crash handling header. More...

Detailed Description

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.nosp@m..Rou.nosp@m.ssel@.nosp@m.inri.nosp@m.a.fr

Definition in file panic.h.

#include "kernel_defines.h"
+ Include dependency graph for panic.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

#define CONFIG_CORE_REBOOT_ON_PANIC   (0)
 Automatically reboot the system on panic()
 
enum  core_panic_t {
  PANIC_GENERAL_ERROR , PANIC_SOFT_REBOOT , PANIC_HARD_REBOOT , PANIC_ASSERT_FAIL ,
  PANIC_EXPECT_FAIL , PANIC_MEM_MANAGE , PANIC_SSP , PANIC_STACK_OVERFLOW ,
  PANIC_UNDEFINED
}
 Definition of available panic modes. More...
 
NORETURN void core_panic (core_panic_t crash_code, const char *message)
 Handle an unrecoverable error by halting or rebooting the system.
 
void panic_arch (void)
 architecture dependent handling of a panic case
 

Macro Definition Documentation

◆ CONFIG_CORE_REBOOT_ON_PANIC

#define CONFIG_CORE_REBOOT_ON_PANIC   (0)

Automatically reboot the system on panic()

By default this is on when DEVELHELP is disabled.

Definition at line 38 of file panic.h.

Enumeration Type Documentation

◆ core_panic_t

Definition of available panic modes.

Enumerator
PANIC_MEM_MANAGE 

memory management fault

PANIC_SSP 

stack smashing protector failure

PANIC_STACK_OVERFLOW 

stack overflow detected

Definition at line 47 of file panic.h.

Function Documentation

◆ core_panic()

NORETURN void core_panic ( core_panic_t  crash_code,
const char *  message 
)

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!
Parameters
[in]crash_codea unique code for identifying the crash reason
[in]messagea human readable reason for the crash
Returns
this function never returns

◆ panic_arch()

void panic_arch ( void  )

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.