Blame view

RIOT/core/include/panic.h 2.23 KB
a752c7ab   elopes   add first test an...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
  /*
   * Copyright (C) 2014, 2015 INRIA
   *
   * This file is subject to the terms and conditions of the GNU Lesser
   * General Public License v2.1. See the file LICENSE in the top level
   * directory for more details.
   */
  
  /**
   * @addtogroup  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>
   */
  
  #ifndef PANIC_H
  #define PANIC_H
  
  #include "kernel_defines.h"
  
  #ifdef __cplusplus
   extern "C" {
  #endif
  
  /**
   * @brief Definition of available panic modes
   */
  typedef enum {
      PANIC_GENERAL_ERROR,
      PANIC_SOFT_REBOOT,
      PANIC_HARD_REBOOT,
      PANIC_ASSERT_FAIL,
  #ifdef MODULE_CORTEXM_COMMON
      PANIC_NMI_HANDLER,       /**< non maskable interrupt */
      PANIC_HARD_FAULT,        /**< hard fault */
  #if defined(CPU_ARCH_CORTEX_M3) || defined(CPU_ARCH_CORTEX_M4) || \
      defined(CPU_ARCH_CORTEX_M4F) || defined(CPU_ARCH_CORTEX_M7)
      PANIC_MEM_MANAGE,        /**< memory controller interrupt */
      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_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
   *
   * @return                  this function never returns
   * */
  NORETURN void core_panic(core_panic_t crash_code, const char *message);
  
  #ifdef __cplusplus
  }
  #endif
  
  #endif /* PANIC_H */
  /** @} */