1 | /** |
---|
2 | * @file rtems/debug.h |
---|
3 | * |
---|
4 | * @brief Information Related to the Debug Support Within RTEMS |
---|
5 | * |
---|
6 | * This include file contains the information pertaining to the debug |
---|
7 | * support within RTEMS. It is currently cast in the form of a |
---|
8 | * Manager since it is externally accessible. |
---|
9 | */ |
---|
10 | |
---|
11 | /* |
---|
12 | * COPYRIGHT (c) 1989-2009. |
---|
13 | * On-Line Applications Research Corporation (OAR). |
---|
14 | * |
---|
15 | * The license and distribution terms for this file may be |
---|
16 | * found in the file LICENSE in this distribution or at |
---|
17 | * http://www.rtems.org/license/LICENSE. |
---|
18 | */ |
---|
19 | |
---|
20 | #ifndef _RTEMS_DEBUG_H |
---|
21 | #define _RTEMS_DEBUG_H |
---|
22 | |
---|
23 | #include <rtems/score/basedefs.h> |
---|
24 | |
---|
25 | /** |
---|
26 | * @defgroup ScoreDebug Debug Information |
---|
27 | * |
---|
28 | * @ingroup Score |
---|
29 | */ |
---|
30 | /**@{*/ |
---|
31 | |
---|
32 | #ifdef __cplusplus |
---|
33 | extern "C" { |
---|
34 | #endif |
---|
35 | |
---|
36 | /** |
---|
37 | * The following type is used to manage the debug mask. |
---|
38 | */ |
---|
39 | typedef uint32_t rtems_debug_control; |
---|
40 | |
---|
41 | /* |
---|
42 | * These constants represent various classes of debugging. |
---|
43 | */ |
---|
44 | |
---|
45 | /** Macro which indicates that all debugging modes are enabled */ |
---|
46 | #define RTEMS_DEBUG_ALL_MASK 0xffffffff |
---|
47 | |
---|
48 | /** Macro which indicates that debugging for heaps/regions is enabled */ |
---|
49 | #define RTEMS_DEBUG_REGION 0x00000001 |
---|
50 | |
---|
51 | /** |
---|
52 | * This variable contains the current debug level. |
---|
53 | */ |
---|
54 | SCORE_EXTERN rtems_debug_control _Debug_Level; |
---|
55 | |
---|
56 | /** |
---|
57 | * @brief Initialize debug manager. |
---|
58 | */ |
---|
59 | void _Debug_Manager_initialization( void ); |
---|
60 | |
---|
61 | /** |
---|
62 | * @brief Enable debugging. |
---|
63 | */ |
---|
64 | void rtems_debug_enable( |
---|
65 | rtems_debug_control to_be_enabled |
---|
66 | ); |
---|
67 | |
---|
68 | /** |
---|
69 | * @brief Disable debugging. |
---|
70 | */ |
---|
71 | void rtems_debug_disable( |
---|
72 | rtems_debug_control to_be_disabled |
---|
73 | ); |
---|
74 | |
---|
75 | /** |
---|
76 | * @brief Check if debug is enabled. |
---|
77 | * |
---|
78 | * This routine returns TRUE if the requested debug level is |
---|
79 | * enabled, and FALSE otherwise. |
---|
80 | */ |
---|
81 | bool rtems_debug_is_enabled( |
---|
82 | rtems_debug_control level |
---|
83 | ); |
---|
84 | |
---|
85 | #ifdef __cplusplus |
---|
86 | } |
---|
87 | #endif |
---|
88 | |
---|
89 | /**@}*/ |
---|
90 | #endif |
---|
91 | /* end of include file */ |
---|