linux/wimax/debug.h

4  * Collection of tools to manage debug operations.
14  * debug action (like printing a message) if the current debug level
22  * A call to d_test(L) (L being the target debug level) returns true
23  * if the action should be taken because the current debug levels
30  * DEBUG LEVELS
34  * Convention sets 0 as "no debug" (so an action marked as debug level 0
35  * will always be taken). The increasing debug levels are used for
48  *  - a debug-levels.h header file that declares the list of
52  *  - some (optional) .c code to manipulate the runtime debug levels
55  * The debug-levels.h file would look like:
63  *     #include <linux/wimax/debug.h>
74  * D_MASTER is the maximum compile-time debug level; any debug actions
78  * be done before #including debug.h
80  * We declare N different submodules whose debug level can be
110  * On each submodule (for example, .c files), the debug infrastructure
113  *     #define D_SUBMODULE submodule_x     // matches one in debug-levels.h
114  *     #include "debug-levels.h"
121  * If their debug level is greater than D_MASTER, they will be
124  * If their debug level is lower or equal than D_MASTER but greater
125  * than the current debug level of their submodule, they'll be
141  * Debug backend: generate a message header from a 'struct device'
164  * Debug backend: log some message if debugging is enabled
166  * @l: intended debug level
196  * Store a submodule's runtime debug level and name
205  * List of available submodules and their debug levels
225  * Stuff you need to declare prior to using the actual "debug" actions
230 #error D_MODULENAME is not defined in your debug-levels.h file
234  * #define in your module's debug-levels.h, making sure it is
242 #warning D_MASTER not defined, but debug.h included! [see docs]
244  * D_MASTER - Compile time maximum debug level
246  * #define in your debug-levels.h file to the maximum debug level the
252  * Defaults to zero (no debug code compiled in).
254  * Maximum one definition per module (at the debug-levels.h file).
260 #error D_SUBMODULE not defined, but debug.h included! [see docs]
264  * #define in your submodule .c file before #including debug-levels.h
267  * debug-levels.h) and D_SUBMODULE_DEFINE().
269  * This is used to provide runtime-control over the debug levels.
279  * D_SUBMODULE_DECLARE - Declare a submodule for runtime debug level control
284  * Declare in the module's debug-levels.h header file as:
299  * D_SUBMODULE_DEFINE - Define a submodule for runtime debug level control
315  * debug-levels.h header file.
325 /* The actual "debug" operations */
331  * @l: intended debug level (unsigned)
333  * If the master debug switch is enabled and the current settings are
357  * @l: intended debug level
367  * @l: intended debug level
377  * @l: intended debug level
387  * @l: intended debug level
403  * Export a submodule's debug level over debugfs as PREFIXSUBMODULE
443  * d_parse_params - Parse a string with debug parameters from the
450  *     separated list of NAME:VALUE, where value is the debug level