blob: 908d4f9c348ccb9e04ad81e0398a66c687b00917 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/******************************************************************************
2 *
3 * Name: acoutput.h -- debug output
4 *
5 *****************************************************************************/
6
7/*
David E. Box82a80942015-02-05 15:20:45 +08008 * Copyright (C) 2000 - 2015, Intel Corp.
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
25 *
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
29 *
30 * NO WARRANTY
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
42 */
43
44#ifndef __ACOUTPUT_H__
45#define __ACOUTPUT_H__
46
47/*
Bob Moore50df4d82008-12-31 03:01:23 +080048 * Debug levels and component IDs. These are used to control the
49 * granularity of the output of the ACPI_DEBUG_PRINT macro -- on a
50 * per-component basis and a per-exception-type basis.
Linus Torvalds1da177e2005-04-16 15:20:36 -070051 */
52
Bob Mooreb229cf92006-04-21 17:15:00 -040053/* Component IDs are used in the global "DebugLayer" */
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
55#define ACPI_UTILITIES 0x00000001
56#define ACPI_HARDWARE 0x00000002
57#define ACPI_EVENTS 0x00000004
58#define ACPI_TABLES 0x00000008
59#define ACPI_NAMESPACE 0x00000010
60#define ACPI_PARSER 0x00000020
61#define ACPI_DISPATCHER 0x00000040
62#define ACPI_EXECUTER 0x00000080
63#define ACPI_RESOURCES 0x00000100
64#define ACPI_CA_DEBUGGER 0x00000200
65#define ACPI_OS_SERVICES 0x00000400
66#define ACPI_CA_DISASSEMBLER 0x00000800
67
68/* Component IDs for ACPI tools and utilities */
69
70#define ACPI_COMPILER 0x00001000
71#define ACPI_TOOLS 0x00002000
Bob Moore50df4d82008-12-31 03:01:23 +080072#define ACPI_EXAMPLE 0x00004000
73#define ACPI_DRIVER 0x00008000
Bob Mooreddcc6a02010-07-06 10:02:16 +080074#define DT_COMPILER 0x00010000
Lv Zheng56324c12012-12-19 05:37:03 +000075#define ASL_PREPROCESSOR 0x00020000
Linus Torvalds1da177e2005-04-16 15:20:36 -070076
Bob Mooreddcc6a02010-07-06 10:02:16 +080077#define ACPI_ALL_COMPONENTS 0x0001FFFF
Linus Torvalds1da177e2005-04-16 15:20:36 -070078#define ACPI_COMPONENT_DEFAULT (ACPI_ALL_COMPONENTS)
79
Linus Torvalds1da177e2005-04-16 15:20:36 -070080/* Component IDs reserved for ACPI drivers */
81
82#define ACPI_ALL_DRIVERS 0xFFFF0000
83
Linus Torvalds1da177e2005-04-16 15:20:36 -070084/*
Bob Moore50df4d82008-12-31 03:01:23 +080085 * Raw debug output levels, do not use these in the ACPI_DEBUG_PRINT macros
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 */
Bob Moore23d3e052008-09-28 15:00:47 +080087#define ACPI_LV_INIT 0x00000001
88#define ACPI_LV_DEBUG_OBJECT 0x00000002
89#define ACPI_LV_INFO 0x00000004
Bob Moore3a581762009-12-11 15:23:22 +080090#define ACPI_LV_REPAIR 0x00000008
Lv Zhenga616dc22015-07-23 12:52:53 +080091#define ACPI_LV_TRACE_POINT 0x00000010
92#define ACPI_LV_ALL_EXCEPTIONS 0x0000001F
Linus Torvalds1da177e2005-04-16 15:20:36 -070093
94/* Trace verbosity level 1 [Standard Trace Level] */
95
96#define ACPI_LV_INIT_NAMES 0x00000020
97#define ACPI_LV_PARSE 0x00000040
98#define ACPI_LV_LOAD 0x00000080
99#define ACPI_LV_DISPATCH 0x00000100
100#define ACPI_LV_EXEC 0x00000200
101#define ACPI_LV_NAMES 0x00000400
102#define ACPI_LV_OPREGION 0x00000800
103#define ACPI_LV_BFIELD 0x00001000
104#define ACPI_LV_TABLES 0x00002000
105#define ACPI_LV_VALUES 0x00004000
106#define ACPI_LV_OBJECTS 0x00008000
107#define ACPI_LV_RESOURCES 0x00010000
108#define ACPI_LV_USER_REQUESTS 0x00020000
109#define ACPI_LV_PACKAGE 0x00040000
110#define ACPI_LV_VERBOSITY1 0x0007FF40 | ACPI_LV_ALL_EXCEPTIONS
111
112/* Trace verbosity level 2 [Function tracing and memory allocation] */
113
114#define ACPI_LV_ALLOCATIONS 0x00100000
115#define ACPI_LV_FUNCTIONS 0x00200000
116#define ACPI_LV_OPTIMIZATIONS 0x00400000
117#define ACPI_LV_VERBOSITY2 0x00700000 | ACPI_LV_VERBOSITY1
118#define ACPI_LV_ALL ACPI_LV_VERBOSITY2
119
120/* Trace verbosity level 3 [Threading, I/O, and Interrupts] */
121
122#define ACPI_LV_MUTEX 0x01000000
123#define ACPI_LV_THREADS 0x02000000
124#define ACPI_LV_IO 0x04000000
125#define ACPI_LV_INTERRUPTS 0x08000000
126#define ACPI_LV_VERBOSITY3 0x0F000000 | ACPI_LV_VERBOSITY2
127
Bob Mooreb229cf92006-04-21 17:15:00 -0400128/* Exceptionally verbose output -- also used in the global "DebugLevel" */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129
130#define ACPI_LV_AML_DISASSEMBLE 0x10000000
131#define ACPI_LV_VERBOSE_INFO 0x20000000
132#define ACPI_LV_FULL_TABLES 0x40000000
133#define ACPI_LV_EVENTS 0x80000000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134#define ACPI_LV_VERBOSE 0xF0000000
135
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136/*
137 * Debug level macros that are used in the DEBUG_PRINT macros
138 */
Robert Mooref9f46012005-07-08 00:00:00 -0400139#define ACPI_DEBUG_LEVEL(dl) (u32) dl,ACPI_DEBUG_PARAMETERS
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140
Bob Moore23d3e052008-09-28 15:00:47 +0800141/*
142 * Exception level -- used in the global "DebugLevel"
143 *
144 * Note: For errors, use the ACPI_ERROR or ACPI_EXCEPTION interfaces.
145 * For warnings, use ACPI_WARNING.
146 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147#define ACPI_DB_INIT ACPI_DEBUG_LEVEL (ACPI_LV_INIT)
148#define ACPI_DB_DEBUG_OBJECT ACPI_DEBUG_LEVEL (ACPI_LV_DEBUG_OBJECT)
149#define ACPI_DB_INFO ACPI_DEBUG_LEVEL (ACPI_LV_INFO)
Bob Moore3a581762009-12-11 15:23:22 +0800150#define ACPI_DB_REPAIR ACPI_DEBUG_LEVEL (ACPI_LV_REPAIR)
Lv Zhenga616dc22015-07-23 12:52:53 +0800151#define ACPI_DB_TRACE_POINT ACPI_DEBUG_LEVEL (ACPI_LV_TRACE_POINT)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152#define ACPI_DB_ALL_EXCEPTIONS ACPI_DEBUG_LEVEL (ACPI_LV_ALL_EXCEPTIONS)
153
Bob Mooreb229cf92006-04-21 17:15:00 -0400154/* Trace level -- also used in the global "DebugLevel" */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155
156#define ACPI_DB_INIT_NAMES ACPI_DEBUG_LEVEL (ACPI_LV_INIT_NAMES)
157#define ACPI_DB_THREADS ACPI_DEBUG_LEVEL (ACPI_LV_THREADS)
158#define ACPI_DB_PARSE ACPI_DEBUG_LEVEL (ACPI_LV_PARSE)
159#define ACPI_DB_DISPATCH ACPI_DEBUG_LEVEL (ACPI_LV_DISPATCH)
160#define ACPI_DB_LOAD ACPI_DEBUG_LEVEL (ACPI_LV_LOAD)
161#define ACPI_DB_EXEC ACPI_DEBUG_LEVEL (ACPI_LV_EXEC)
162#define ACPI_DB_NAMES ACPI_DEBUG_LEVEL (ACPI_LV_NAMES)
163#define ACPI_DB_OPREGION ACPI_DEBUG_LEVEL (ACPI_LV_OPREGION)
164#define ACPI_DB_BFIELD ACPI_DEBUG_LEVEL (ACPI_LV_BFIELD)
165#define ACPI_DB_TABLES ACPI_DEBUG_LEVEL (ACPI_LV_TABLES)
166#define ACPI_DB_FUNCTIONS ACPI_DEBUG_LEVEL (ACPI_LV_FUNCTIONS)
167#define ACPI_DB_OPTIMIZATIONS ACPI_DEBUG_LEVEL (ACPI_LV_OPTIMIZATIONS)
168#define ACPI_DB_VALUES ACPI_DEBUG_LEVEL (ACPI_LV_VALUES)
169#define ACPI_DB_OBJECTS ACPI_DEBUG_LEVEL (ACPI_LV_OBJECTS)
170#define ACPI_DB_ALLOCATIONS ACPI_DEBUG_LEVEL (ACPI_LV_ALLOCATIONS)
171#define ACPI_DB_RESOURCES ACPI_DEBUG_LEVEL (ACPI_LV_RESOURCES)
172#define ACPI_DB_IO ACPI_DEBUG_LEVEL (ACPI_LV_IO)
173#define ACPI_DB_INTERRUPTS ACPI_DEBUG_LEVEL (ACPI_LV_INTERRUPTS)
174#define ACPI_DB_USER_REQUESTS ACPI_DEBUG_LEVEL (ACPI_LV_USER_REQUESTS)
175#define ACPI_DB_PACKAGE ACPI_DEBUG_LEVEL (ACPI_LV_PACKAGE)
176#define ACPI_DB_MUTEX ACPI_DEBUG_LEVEL (ACPI_LV_MUTEX)
Bob Moore23d3e052008-09-28 15:00:47 +0800177#define ACPI_DB_EVENTS ACPI_DEBUG_LEVEL (ACPI_LV_EVENTS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178
179#define ACPI_DB_ALL ACPI_DEBUG_LEVEL (ACPI_LV_ALL)
180
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181/* Defaults for debug_level, debug and normal */
182
Bob Moore3a581762009-12-11 15:23:22 +0800183#define ACPI_DEBUG_DEFAULT (ACPI_LV_INFO | ACPI_LV_REPAIR)
184#define ACPI_NORMAL_DEFAULT (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT | ACPI_LV_REPAIR)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185#define ACPI_DEBUG_ALL (ACPI_LV_AML_DISASSEMBLE | ACPI_LV_ALL_EXCEPTIONS | ACPI_LV_ALL)
186
Lv Zhengab6c5732015-07-23 12:52:59 +0800187/*
188 * Global trace flags
189 */
Lv Zhengfb18e8f2015-07-23 12:53:15 +0800190#define ACPI_TRACE_ENABLED ((u32) 4)
191#define ACPI_TRACE_ONESHOT ((u32) 2)
192#define ACPI_TRACE_OPCODE ((u32) 1)
Lv Zhengab6c5732015-07-23 12:52:59 +0800193
194/* Defaults for trace debugging level/layer */
195
196#define ACPI_TRACE_LEVEL_ALL ACPI_LV_ALL
197#define ACPI_TRACE_LAYER_ALL 0x000001FF
198#define ACPI_TRACE_LEVEL_DEFAULT ACPI_LV_TRACE_POINT
199#define ACPI_TRACE_LAYER_DEFAULT ACPI_EXECUTER
200
Bob Moore50df4d82008-12-31 03:01:23 +0800201#if defined (ACPI_DEBUG_OUTPUT) || !defined (ACPI_NO_ERROR_MESSAGES)
202/*
Bob Moored59a3c62011-02-14 16:02:36 +0800203 * The module name is used primarily for error and debug messages.
204 * The __FILE__ macro is not very useful for this, because it
205 * usually includes the entire pathname to the module making the
206 * debug output difficult to read.
Bob Moore50df4d82008-12-31 03:01:23 +0800207 */
208#define ACPI_MODULE_NAME(name) static const char ACPI_UNUSED_VAR _acpi_module_name[] = name;
209#else
Bob Moored59a3c62011-02-14 16:02:36 +0800210/*
211 * For the no-debug and no-error-msg cases, we must at least define
212 * a null module name.
213 */
Bob Moore50df4d82008-12-31 03:01:23 +0800214#define ACPI_MODULE_NAME(name)
Bob Moored59a3c62011-02-14 16:02:36 +0800215#define _acpi_module_name ""
Bob Moore50df4d82008-12-31 03:01:23 +0800216#endif
217
218/*
219 * Ascii error messages can be configured out
220 */
221#ifndef ACPI_NO_ERROR_MESSAGES
222#define AE_INFO _acpi_module_name, __LINE__
223
224/*
225 * Error reporting. Callers module and line number are inserted by AE_INFO,
226 * the plist contains a set of parens to allow variable-length lists.
227 * These macros are used for both the debug and non-debug versions of the code.
228 */
229#define ACPI_INFO(plist) acpi_info plist
230#define ACPI_WARNING(plist) acpi_warning plist
231#define ACPI_EXCEPTION(plist) acpi_exception plist
232#define ACPI_ERROR(plist) acpi_error plist
Bob Moore62cdd142012-07-16 09:25:27 +0800233#define ACPI_BIOS_WARNING(plist) acpi_bios_warning plist
234#define ACPI_BIOS_ERROR(plist) acpi_bios_error plist
Lin Ming4cdf1a52010-03-03 16:28:28 +0800235#define ACPI_DEBUG_OBJECT(obj,l,i) acpi_ex_do_debug_object(obj,l,i)
Bob Moore50df4d82008-12-31 03:01:23 +0800236
237#else
238
239/* No error messages */
240
241#define ACPI_INFO(plist)
242#define ACPI_WARNING(plist)
243#define ACPI_EXCEPTION(plist)
244#define ACPI_ERROR(plist)
Bob Moore62cdd142012-07-16 09:25:27 +0800245#define ACPI_BIOS_WARNING(plist)
246#define ACPI_BIOS_ERROR(plist)
Lin Ming4cdf1a52010-03-03 16:28:28 +0800247#define ACPI_DEBUG_OBJECT(obj,l,i)
Bob Moore50df4d82008-12-31 03:01:23 +0800248
249#endif /* ACPI_NO_ERROR_MESSAGES */
250
251/*
252 * Debug macros that are conditionally compiled
253 */
254#ifdef ACPI_DEBUG_OUTPUT
255
256/*
257 * If ACPI_GET_FUNCTION_NAME was not defined in the compiler-dependent header,
258 * define it now. This is the case where there the compiler does not support
Rasmus Villemoes02f1f212015-02-12 15:01:31 -0800259 * a __func__ macro or equivalent.
Bob Moore50df4d82008-12-31 03:01:23 +0800260 */
261#ifndef ACPI_GET_FUNCTION_NAME
262#define ACPI_GET_FUNCTION_NAME _acpi_function_name
263
264/*
265 * The Name parameter should be the procedure name as a quoted string.
266 * The function name is also used by the function exit macros below.
267 * Note: (const char) is used to be compatible with the debug interfaces
Rasmus Villemoes02f1f212015-02-12 15:01:31 -0800268 * and macros such as __func__.
Bob Moore50df4d82008-12-31 03:01:23 +0800269 */
270#define ACPI_FUNCTION_NAME(name) static const char _acpi_function_name[] = #name;
271
272#else
Rasmus Villemoes02f1f212015-02-12 15:01:31 -0800273/* Compiler supports __func__ (or equivalent) -- Ignore this macro */
Bob Moore50df4d82008-12-31 03:01:23 +0800274
275#define ACPI_FUNCTION_NAME(name)
276#endif /* ACPI_GET_FUNCTION_NAME */
277
278/*
279 * Common parameters used for debug output functions:
280 * line number, function name, module(file) name, component ID
281 */
Bob Mooread5a06f2012-12-31 00:06:04 +0000282#define ACPI_DEBUG_PARAMETERS \
283 __LINE__, ACPI_GET_FUNCTION_NAME, _acpi_module_name, _COMPONENT
Bob Moore50df4d82008-12-31 03:01:23 +0800284
Bob Mooree81a52b2012-12-31 00:06:50 +0000285/* Check if debug output is currently dynamically enabled */
286
287#define ACPI_IS_DEBUG_ENABLED(level, component) \
288 ((level & acpi_dbg_level) && (component & acpi_dbg_layer))
289
Bob Moore50df4d82008-12-31 03:01:23 +0800290/*
291 * Master debug print macros
292 * Print message if and only if:
293 * 1) Debug print for the current component is enabled
294 * 2) Debug error level or trace level for the print statement is enabled
Bob Mooread5a06f2012-12-31 00:06:04 +0000295 *
296 * November 2012: Moved the runtime check for whether to actually emit the
297 * debug message outside of the print function itself. This improves overall
298 * performance at a relatively small code cost. Implementation involves the
299 * use of variadic macros supported by C99.
Bob Moore6e1888f2013-01-08 23:46:04 +0100300 *
301 * Note: the ACPI_DO_WHILE0 macro is used to prevent some compilers from
302 * complaining about these constructs. On other compilers the do...while
303 * adds some extra code, so this feature is optional.
Bob Moore50df4d82008-12-31 03:01:23 +0800304 */
Bob Moore6e1888f2013-01-08 23:46:04 +0100305#ifdef ACPI_USE_DO_WHILE_0
306#define ACPI_DO_WHILE0(a) do a while(0)
307#else
308#define ACPI_DO_WHILE0(a) a
309#endif
Bob Mooread5a06f2012-12-31 00:06:04 +0000310
311/* DEBUG_PRINT functions */
312
Lv Zheng7b09d8f2015-07-01 14:43:43 +0800313#ifndef COMPILER_VA_MACRO
314
315#define ACPI_DEBUG_PRINT(plist) acpi_debug_print plist
316#define ACPI_DEBUG_PRINT_RAW(plist) acpi_debug_print_raw plist
317
318#else
Bob Mooread5a06f2012-12-31 00:06:04 +0000319
320/* Helper macros for DEBUG_PRINT */
321
Bob Moore6e1888f2013-01-08 23:46:04 +0100322#define ACPI_DO_DEBUG_PRINT(function, level, line, filename, modulename, component, ...) \
323 ACPI_DO_WHILE0 ({ \
324 if (ACPI_IS_DEBUG_ENABLED (level, component)) \
325 { \
326 function (level, line, filename, modulename, component, __VA_ARGS__); \
327 } \
328 })
Bob Mooread5a06f2012-12-31 00:06:04 +0000329
330#define ACPI_ACTUAL_DEBUG(level, line, filename, modulename, component, ...) \
Bob Moore6e1888f2013-01-08 23:46:04 +0100331 ACPI_DO_DEBUG_PRINT (acpi_debug_print, level, line, \
332 filename, modulename, component, __VA_ARGS__)
Bob Mooread5a06f2012-12-31 00:06:04 +0000333
334#define ACPI_ACTUAL_DEBUG_RAW(level, line, filename, modulename, component, ...) \
Bob Moore6e1888f2013-01-08 23:46:04 +0100335 ACPI_DO_DEBUG_PRINT (acpi_debug_print_raw, level, line, \
336 filename, modulename, component, __VA_ARGS__)
Bob Moore50df4d82008-12-31 03:01:23 +0800337
Lv Zheng7b09d8f2015-07-01 14:43:43 +0800338#define ACPI_DEBUG_PRINT(plist) ACPI_ACTUAL_DEBUG plist
339#define ACPI_DEBUG_PRINT_RAW(plist) ACPI_ACTUAL_DEBUG_RAW plist
340
341#endif
342
Bob Moore0377b5a2012-12-31 00:06:33 +0000343/*
344 * Function entry tracing
345 *
346 * The name of the function is emitted as a local variable that is
347 * intended to be used by both the entry trace and the exit trace.
348 */
349
350/* Helper macro */
351
Bob Moorefd1af712013-03-08 09:22:23 +0000352#define ACPI_TRACE_ENTRY(name, function, type, param) \
Bob Moore0377b5a2012-12-31 00:06:33 +0000353 ACPI_FUNCTION_NAME (name) \
Bob Moorefd1af712013-03-08 09:22:23 +0000354 function (ACPI_DEBUG_PARAMETERS, (type) (param))
Bob Moore0377b5a2012-12-31 00:06:33 +0000355
356/* The actual entry trace macros */
357
358#define ACPI_FUNCTION_TRACE(name) \
359 ACPI_FUNCTION_NAME(name) \
360 acpi_ut_trace (ACPI_DEBUG_PARAMETERS)
361
362#define ACPI_FUNCTION_TRACE_PTR(name, pointer) \
Bob Moorefd1af712013-03-08 09:22:23 +0000363 ACPI_TRACE_ENTRY (name, acpi_ut_trace_ptr, void *, pointer)
Bob Moore0377b5a2012-12-31 00:06:33 +0000364
365#define ACPI_FUNCTION_TRACE_U32(name, value) \
Bob Moorefd1af712013-03-08 09:22:23 +0000366 ACPI_TRACE_ENTRY (name, acpi_ut_trace_u32, u32, value)
Bob Moore0377b5a2012-12-31 00:06:33 +0000367
368#define ACPI_FUNCTION_TRACE_STR(name, string) \
Bob Moorefd1af712013-03-08 09:22:23 +0000369 ACPI_TRACE_ENTRY (name, acpi_ut_trace_str, char *, string)
Bob Moore0377b5a2012-12-31 00:06:33 +0000370
371#define ACPI_FUNCTION_ENTRY() \
372 acpi_ut_track_stack_ptr()
373
374/*
375 * Function exit tracing
376 *
377 * These macros include a return statement. This is usually considered
378 * bad form, but having a separate exit macro before the actual return
379 * is very ugly and difficult to maintain.
380 *
381 * One of the FUNCTION_TRACE macros above must be used in conjunction
382 * with these macros so that "_AcpiFunctionName" is defined.
Bob Moorefd1af712013-03-08 09:22:23 +0000383 *
384 * There are two versions of most of the return macros. The default version is
385 * safer, since it avoids side-effects by guaranteeing that the argument will
386 * not be evaluated twice.
387 *
388 * A less-safe version of the macros is provided for optional use if the
389 * compiler uses excessive CPU stack (for example, this may happen in the
390 * debug case if code optimzation is disabled.)
Bob Moore0377b5a2012-12-31 00:06:33 +0000391 */
Bob Moore0377b5a2012-12-31 00:06:33 +0000392
393/* Exit trace helper macro */
394
Bob Moorefd1af712013-03-08 09:22:23 +0000395#ifndef ACPI_SIMPLE_RETURN_MACROS
396
397#define ACPI_TRACE_EXIT(function, type, param) \
Bob Moore0377b5a2012-12-31 00:06:33 +0000398 ACPI_DO_WHILE0 ({ \
Bob Moorefd1af712013-03-08 09:22:23 +0000399 register type _param = (type) (param); \
400 function (ACPI_DEBUG_PARAMETERS, _param); \
401 return (_param); \
Bob Moore0377b5a2012-12-31 00:06:33 +0000402 })
403
Bob Moorefd1af712013-03-08 09:22:23 +0000404#else /* Use original less-safe macros */
405
406#define ACPI_TRACE_EXIT(function, type, param) \
407 ACPI_DO_WHILE0 ({ \
408 function (ACPI_DEBUG_PARAMETERS, (type) (param)); \
409 return (param); \
410 })
411
412#endif /* ACPI_SIMPLE_RETURN_MACROS */
413
Bob Moore0377b5a2012-12-31 00:06:33 +0000414/* The actual exit macros */
415
416#define return_VOID \
417 ACPI_DO_WHILE0 ({ \
418 acpi_ut_exit (ACPI_DEBUG_PARAMETERS); \
419 return; \
420 })
421
422#define return_ACPI_STATUS(status) \
Bob Moorefd1af712013-03-08 09:22:23 +0000423 ACPI_TRACE_EXIT (acpi_ut_status_exit, acpi_status, status)
Bob Moore0377b5a2012-12-31 00:06:33 +0000424
425#define return_PTR(pointer) \
Bob Moorefd1af712013-03-08 09:22:23 +0000426 ACPI_TRACE_EXIT (acpi_ut_ptr_exit, void *, pointer)
Bob Moore0377b5a2012-12-31 00:06:33 +0000427
428#define return_VALUE(value) \
Bob Moorefd1af712013-03-08 09:22:23 +0000429 ACPI_TRACE_EXIT (acpi_ut_value_exit, u64, value)
430
431#define return_UINT32(value) \
432 ACPI_TRACE_EXIT (acpi_ut_value_exit, u32, value)
433
434#define return_UINT8(value) \
435 ACPI_TRACE_EXIT (acpi_ut_value_exit, u8, value)
Bob Moore0377b5a2012-12-31 00:06:33 +0000436
437/* Conditional execution */
438
439#define ACPI_DEBUG_EXEC(a) a
440#define ACPI_DEBUG_ONLY_MEMBERS(a) a;
441#define _VERBOSE_STRUCTURES
442
443/* Various object display routines for debug */
444
445#define ACPI_DUMP_STACK_ENTRY(a) acpi_ex_dump_operand((a), 0)
446#define ACPI_DUMP_OPERANDS(a, b ,c) acpi_ex_dump_operands(a, b, c)
447#define ACPI_DUMP_ENTRY(a, b) acpi_ns_dump_entry (a, b)
448#define ACPI_DUMP_PATHNAME(a, b, c, d) acpi_ns_dump_pathname(a, b, c, d)
449#define ACPI_DUMP_BUFFER(a, b) acpi_ut_debug_dump_buffer((u8 *) a, b, DB_BYTE_DISPLAY, _COMPONENT)
450
Lv Zhengbab04822015-07-23 12:53:07 +0800451#define ACPI_TRACE_POINT(a, b, c, d) acpi_trace_point (a, b, c, d)
452
Bob Moore0377b5a2012-12-31 00:06:33 +0000453#else /* ACPI_DEBUG_OUTPUT */
Bob Moore50df4d82008-12-31 03:01:23 +0800454/*
455 * This is the non-debug case -- make everything go away,
456 * leaving no executable debug code!
457 */
Bob Moore50df4d82008-12-31 03:01:23 +0800458#define ACPI_DEBUG_PRINT(pl)
459#define ACPI_DEBUG_PRINT_RAW(pl)
Bob Moore0377b5a2012-12-31 00:06:33 +0000460#define ACPI_DEBUG_EXEC(a)
461#define ACPI_DEBUG_ONLY_MEMBERS(a)
Lv Zhengd835e7f2013-05-30 10:01:05 +0800462#define ACPI_FUNCTION_NAME(a)
Bob Moore0377b5a2012-12-31 00:06:33 +0000463#define ACPI_FUNCTION_TRACE(a)
464#define ACPI_FUNCTION_TRACE_PTR(a, b)
465#define ACPI_FUNCTION_TRACE_U32(a, b)
466#define ACPI_FUNCTION_TRACE_STR(a, b)
Bob Moore0377b5a2012-12-31 00:06:33 +0000467#define ACPI_FUNCTION_ENTRY()
468#define ACPI_DUMP_STACK_ENTRY(a)
469#define ACPI_DUMP_OPERANDS(a, b, c)
470#define ACPI_DUMP_ENTRY(a, b)
Bob Moore0377b5a2012-12-31 00:06:33 +0000471#define ACPI_DUMP_PATHNAME(a, b, c, d)
472#define ACPI_DUMP_BUFFER(a, b)
Bob Mooree81a52b2012-12-31 00:06:50 +0000473#define ACPI_IS_DEBUG_ENABLED(level, component) 0
Lv Zhengbab04822015-07-23 12:53:07 +0800474#define ACPI_TRACE_POINT(a, b, c, d)
Bob Moore0377b5a2012-12-31 00:06:33 +0000475
476/* Return macros must have a return statement at the minimum */
477
478#define return_VOID return
479#define return_ACPI_STATUS(s) return(s)
Bob Moore0377b5a2012-12-31 00:06:33 +0000480#define return_PTR(s) return(s)
Bob Moorefd1af712013-03-08 09:22:23 +0000481#define return_VALUE(s) return(s)
482#define return_UINT8(s) return(s)
483#define return_UINT32(s) return(s)
Bob Moore50df4d82008-12-31 03:01:23 +0800484
485#endif /* ACPI_DEBUG_OUTPUT */
486
Len Brown4be44fc2005-08-05 00:44:28 -0400487#endif /* __ACOUTPUT_H__ */