blob: 4f52ea795c7ac2e5e39ff97703ad71ebe705351f [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/******************************************************************************
2 *
3 * Name: acoutput.h -- debug output
4 *
5 *****************************************************************************/
6
7/*
Bob Moore25f044e2013-01-25 05:38:56 +00008 * Copyright (C) 2000 - 2013, 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
91#define ACPI_LV_ALL_EXCEPTIONS 0x0000000F
Linus Torvalds1da177e2005-04-16 15:20:36 -070092
93/* Trace verbosity level 1 [Standard Trace Level] */
94
95#define ACPI_LV_INIT_NAMES 0x00000020
96#define ACPI_LV_PARSE 0x00000040
97#define ACPI_LV_LOAD 0x00000080
98#define ACPI_LV_DISPATCH 0x00000100
99#define ACPI_LV_EXEC 0x00000200
100#define ACPI_LV_NAMES 0x00000400
101#define ACPI_LV_OPREGION 0x00000800
102#define ACPI_LV_BFIELD 0x00001000
103#define ACPI_LV_TABLES 0x00002000
104#define ACPI_LV_VALUES 0x00004000
105#define ACPI_LV_OBJECTS 0x00008000
106#define ACPI_LV_RESOURCES 0x00010000
107#define ACPI_LV_USER_REQUESTS 0x00020000
108#define ACPI_LV_PACKAGE 0x00040000
109#define ACPI_LV_VERBOSITY1 0x0007FF40 | ACPI_LV_ALL_EXCEPTIONS
110
111/* Trace verbosity level 2 [Function tracing and memory allocation] */
112
113#define ACPI_LV_ALLOCATIONS 0x00100000
114#define ACPI_LV_FUNCTIONS 0x00200000
115#define ACPI_LV_OPTIMIZATIONS 0x00400000
116#define ACPI_LV_VERBOSITY2 0x00700000 | ACPI_LV_VERBOSITY1
117#define ACPI_LV_ALL ACPI_LV_VERBOSITY2
118
119/* Trace verbosity level 3 [Threading, I/O, and Interrupts] */
120
121#define ACPI_LV_MUTEX 0x01000000
122#define ACPI_LV_THREADS 0x02000000
123#define ACPI_LV_IO 0x04000000
124#define ACPI_LV_INTERRUPTS 0x08000000
125#define ACPI_LV_VERBOSITY3 0x0F000000 | ACPI_LV_VERBOSITY2
126
Bob Mooreb229cf92006-04-21 17:15:00 -0400127/* Exceptionally verbose output -- also used in the global "DebugLevel" */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
129#define ACPI_LV_AML_DISASSEMBLE 0x10000000
130#define ACPI_LV_VERBOSE_INFO 0x20000000
131#define ACPI_LV_FULL_TABLES 0x40000000
132#define ACPI_LV_EVENTS 0x80000000
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133#define ACPI_LV_VERBOSE 0xF0000000
134
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135/*
136 * Debug level macros that are used in the DEBUG_PRINT macros
137 */
Robert Mooref9f46012005-07-08 00:00:00 -0400138#define ACPI_DEBUG_LEVEL(dl) (u32) dl,ACPI_DEBUG_PARAMETERS
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139
Bob Moore23d3e052008-09-28 15:00:47 +0800140/*
141 * Exception level -- used in the global "DebugLevel"
142 *
143 * Note: For errors, use the ACPI_ERROR or ACPI_EXCEPTION interfaces.
144 * For warnings, use ACPI_WARNING.
145 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146#define ACPI_DB_INIT ACPI_DEBUG_LEVEL (ACPI_LV_INIT)
147#define ACPI_DB_DEBUG_OBJECT ACPI_DEBUG_LEVEL (ACPI_LV_DEBUG_OBJECT)
148#define ACPI_DB_INFO ACPI_DEBUG_LEVEL (ACPI_LV_INFO)
Bob Moore3a581762009-12-11 15:23:22 +0800149#define ACPI_DB_REPAIR ACPI_DEBUG_LEVEL (ACPI_LV_REPAIR)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150#define ACPI_DB_ALL_EXCEPTIONS ACPI_DEBUG_LEVEL (ACPI_LV_ALL_EXCEPTIONS)
151
Bob Mooreb229cf92006-04-21 17:15:00 -0400152/* Trace level -- also used in the global "DebugLevel" */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153
154#define ACPI_DB_INIT_NAMES ACPI_DEBUG_LEVEL (ACPI_LV_INIT_NAMES)
155#define ACPI_DB_THREADS ACPI_DEBUG_LEVEL (ACPI_LV_THREADS)
156#define ACPI_DB_PARSE ACPI_DEBUG_LEVEL (ACPI_LV_PARSE)
157#define ACPI_DB_DISPATCH ACPI_DEBUG_LEVEL (ACPI_LV_DISPATCH)
158#define ACPI_DB_LOAD ACPI_DEBUG_LEVEL (ACPI_LV_LOAD)
159#define ACPI_DB_EXEC ACPI_DEBUG_LEVEL (ACPI_LV_EXEC)
160#define ACPI_DB_NAMES ACPI_DEBUG_LEVEL (ACPI_LV_NAMES)
161#define ACPI_DB_OPREGION ACPI_DEBUG_LEVEL (ACPI_LV_OPREGION)
162#define ACPI_DB_BFIELD ACPI_DEBUG_LEVEL (ACPI_LV_BFIELD)
163#define ACPI_DB_TABLES ACPI_DEBUG_LEVEL (ACPI_LV_TABLES)
164#define ACPI_DB_FUNCTIONS ACPI_DEBUG_LEVEL (ACPI_LV_FUNCTIONS)
165#define ACPI_DB_OPTIMIZATIONS ACPI_DEBUG_LEVEL (ACPI_LV_OPTIMIZATIONS)
166#define ACPI_DB_VALUES ACPI_DEBUG_LEVEL (ACPI_LV_VALUES)
167#define ACPI_DB_OBJECTS ACPI_DEBUG_LEVEL (ACPI_LV_OBJECTS)
168#define ACPI_DB_ALLOCATIONS ACPI_DEBUG_LEVEL (ACPI_LV_ALLOCATIONS)
169#define ACPI_DB_RESOURCES ACPI_DEBUG_LEVEL (ACPI_LV_RESOURCES)
170#define ACPI_DB_IO ACPI_DEBUG_LEVEL (ACPI_LV_IO)
171#define ACPI_DB_INTERRUPTS ACPI_DEBUG_LEVEL (ACPI_LV_INTERRUPTS)
172#define ACPI_DB_USER_REQUESTS ACPI_DEBUG_LEVEL (ACPI_LV_USER_REQUESTS)
173#define ACPI_DB_PACKAGE ACPI_DEBUG_LEVEL (ACPI_LV_PACKAGE)
174#define ACPI_DB_MUTEX ACPI_DEBUG_LEVEL (ACPI_LV_MUTEX)
Bob Moore23d3e052008-09-28 15:00:47 +0800175#define ACPI_DB_EVENTS ACPI_DEBUG_LEVEL (ACPI_LV_EVENTS)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
177#define ACPI_DB_ALL ACPI_DEBUG_LEVEL (ACPI_LV_ALL)
178
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179/* Defaults for debug_level, debug and normal */
180
Bob Moore3a581762009-12-11 15:23:22 +0800181#define ACPI_DEBUG_DEFAULT (ACPI_LV_INFO | ACPI_LV_REPAIR)
182#define ACPI_NORMAL_DEFAULT (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT | ACPI_LV_REPAIR)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183#define ACPI_DEBUG_ALL (ACPI_LV_AML_DISASSEMBLE | ACPI_LV_ALL_EXCEPTIONS | ACPI_LV_ALL)
184
Bob Moore50df4d82008-12-31 03:01:23 +0800185#if defined (ACPI_DEBUG_OUTPUT) || !defined (ACPI_NO_ERROR_MESSAGES)
186/*
Bob Moored59a3c62011-02-14 16:02:36 +0800187 * The module name is used primarily for error and debug messages.
188 * The __FILE__ macro is not very useful for this, because it
189 * usually includes the entire pathname to the module making the
190 * debug output difficult to read.
Bob Moore50df4d82008-12-31 03:01:23 +0800191 */
192#define ACPI_MODULE_NAME(name) static const char ACPI_UNUSED_VAR _acpi_module_name[] = name;
193#else
Bob Moored59a3c62011-02-14 16:02:36 +0800194/*
195 * For the no-debug and no-error-msg cases, we must at least define
196 * a null module name.
197 */
Bob Moore50df4d82008-12-31 03:01:23 +0800198#define ACPI_MODULE_NAME(name)
Bob Moored59a3c62011-02-14 16:02:36 +0800199#define _acpi_module_name ""
Bob Moore50df4d82008-12-31 03:01:23 +0800200#endif
201
202/*
203 * Ascii error messages can be configured out
204 */
205#ifndef ACPI_NO_ERROR_MESSAGES
206#define AE_INFO _acpi_module_name, __LINE__
207
208/*
209 * Error reporting. Callers module and line number are inserted by AE_INFO,
210 * the plist contains a set of parens to allow variable-length lists.
211 * These macros are used for both the debug and non-debug versions of the code.
212 */
213#define ACPI_INFO(plist) acpi_info plist
214#define ACPI_WARNING(plist) acpi_warning plist
215#define ACPI_EXCEPTION(plist) acpi_exception plist
216#define ACPI_ERROR(plist) acpi_error plist
Bob Moore62cdd142012-07-16 09:25:27 +0800217#define ACPI_BIOS_WARNING(plist) acpi_bios_warning plist
218#define ACPI_BIOS_ERROR(plist) acpi_bios_error plist
Lin Ming4cdf1a52010-03-03 16:28:28 +0800219#define ACPI_DEBUG_OBJECT(obj,l,i) acpi_ex_do_debug_object(obj,l,i)
Bob Moore50df4d82008-12-31 03:01:23 +0800220
221#else
222
223/* No error messages */
224
225#define ACPI_INFO(plist)
226#define ACPI_WARNING(plist)
227#define ACPI_EXCEPTION(plist)
228#define ACPI_ERROR(plist)
Bob Moore62cdd142012-07-16 09:25:27 +0800229#define ACPI_BIOS_WARNING(plist)
230#define ACPI_BIOS_ERROR(plist)
Lin Ming4cdf1a52010-03-03 16:28:28 +0800231#define ACPI_DEBUG_OBJECT(obj,l,i)
Bob Moore50df4d82008-12-31 03:01:23 +0800232
233#endif /* ACPI_NO_ERROR_MESSAGES */
234
235/*
236 * Debug macros that are conditionally compiled
237 */
238#ifdef ACPI_DEBUG_OUTPUT
239
240/*
241 * If ACPI_GET_FUNCTION_NAME was not defined in the compiler-dependent header,
242 * define it now. This is the case where there the compiler does not support
243 * a __FUNCTION__ macro or equivalent.
244 */
245#ifndef ACPI_GET_FUNCTION_NAME
246#define ACPI_GET_FUNCTION_NAME _acpi_function_name
247
248/*
249 * The Name parameter should be the procedure name as a quoted string.
250 * The function name is also used by the function exit macros below.
251 * Note: (const char) is used to be compatible with the debug interfaces
252 * and macros such as __FUNCTION__.
253 */
254#define ACPI_FUNCTION_NAME(name) static const char _acpi_function_name[] = #name;
255
256#else
257/* Compiler supports __FUNCTION__ (or equivalent) -- Ignore this macro */
258
259#define ACPI_FUNCTION_NAME(name)
260#endif /* ACPI_GET_FUNCTION_NAME */
261
262/*
263 * Common parameters used for debug output functions:
264 * line number, function name, module(file) name, component ID
265 */
Bob Mooread5a06f2012-12-31 00:06:04 +0000266#define ACPI_DEBUG_PARAMETERS \
267 __LINE__, ACPI_GET_FUNCTION_NAME, _acpi_module_name, _COMPONENT
Bob Moore50df4d82008-12-31 03:01:23 +0800268
Bob Mooree81a52b2012-12-31 00:06:50 +0000269/* Check if debug output is currently dynamically enabled */
270
271#define ACPI_IS_DEBUG_ENABLED(level, component) \
272 ((level & acpi_dbg_level) && (component & acpi_dbg_layer))
273
Bob Moore50df4d82008-12-31 03:01:23 +0800274/*
275 * Master debug print macros
276 * Print message if and only if:
277 * 1) Debug print for the current component is enabled
278 * 2) Debug error level or trace level for the print statement is enabled
Bob Mooread5a06f2012-12-31 00:06:04 +0000279 *
280 * November 2012: Moved the runtime check for whether to actually emit the
281 * debug message outside of the print function itself. This improves overall
282 * performance at a relatively small code cost. Implementation involves the
283 * use of variadic macros supported by C99.
Bob Moore6e1888f2013-01-08 23:46:04 +0100284 *
285 * Note: the ACPI_DO_WHILE0 macro is used to prevent some compilers from
286 * complaining about these constructs. On other compilers the do...while
287 * adds some extra code, so this feature is optional.
Bob Moore50df4d82008-12-31 03:01:23 +0800288 */
Bob Moore6e1888f2013-01-08 23:46:04 +0100289#ifdef ACPI_USE_DO_WHILE_0
290#define ACPI_DO_WHILE0(a) do a while(0)
291#else
292#define ACPI_DO_WHILE0(a) a
293#endif
Bob Mooread5a06f2012-12-31 00:06:04 +0000294
295/* DEBUG_PRINT functions */
296
297#define ACPI_DEBUG_PRINT(plist) ACPI_ACTUAL_DEBUG plist
298#define ACPI_DEBUG_PRINT_RAW(plist) ACPI_ACTUAL_DEBUG_RAW plist
299
300/* Helper macros for DEBUG_PRINT */
301
Bob Moore6e1888f2013-01-08 23:46:04 +0100302#define ACPI_DO_DEBUG_PRINT(function, level, line, filename, modulename, component, ...) \
303 ACPI_DO_WHILE0 ({ \
304 if (ACPI_IS_DEBUG_ENABLED (level, component)) \
305 { \
306 function (level, line, filename, modulename, component, __VA_ARGS__); \
307 } \
308 })
Bob Mooread5a06f2012-12-31 00:06:04 +0000309
310#define ACPI_ACTUAL_DEBUG(level, line, filename, modulename, component, ...) \
Bob Moore6e1888f2013-01-08 23:46:04 +0100311 ACPI_DO_DEBUG_PRINT (acpi_debug_print, level, line, \
312 filename, modulename, component, __VA_ARGS__)
Bob Mooread5a06f2012-12-31 00:06:04 +0000313
314#define ACPI_ACTUAL_DEBUG_RAW(level, line, filename, modulename, component, ...) \
Bob Moore6e1888f2013-01-08 23:46:04 +0100315 ACPI_DO_DEBUG_PRINT (acpi_debug_print_raw, level, line, \
316 filename, modulename, component, __VA_ARGS__)
Bob Moore50df4d82008-12-31 03:01:23 +0800317
Bob Moore0377b5a2012-12-31 00:06:33 +0000318/*
319 * Function entry tracing
320 *
321 * The name of the function is emitted as a local variable that is
322 * intended to be used by both the entry trace and the exit trace.
323 */
324
325/* Helper macro */
326
Bob Moorefd1af712013-03-08 09:22:23 +0000327#define ACPI_TRACE_ENTRY(name, function, type, param) \
Bob Moore0377b5a2012-12-31 00:06:33 +0000328 ACPI_FUNCTION_NAME (name) \
Bob Moorefd1af712013-03-08 09:22:23 +0000329 function (ACPI_DEBUG_PARAMETERS, (type) (param))
Bob Moore0377b5a2012-12-31 00:06:33 +0000330
331/* The actual entry trace macros */
332
333#define ACPI_FUNCTION_TRACE(name) \
334 ACPI_FUNCTION_NAME(name) \
335 acpi_ut_trace (ACPI_DEBUG_PARAMETERS)
336
337#define ACPI_FUNCTION_TRACE_PTR(name, pointer) \
Bob Moorefd1af712013-03-08 09:22:23 +0000338 ACPI_TRACE_ENTRY (name, acpi_ut_trace_ptr, void *, pointer)
Bob Moore0377b5a2012-12-31 00:06:33 +0000339
340#define ACPI_FUNCTION_TRACE_U32(name, value) \
Bob Moorefd1af712013-03-08 09:22:23 +0000341 ACPI_TRACE_ENTRY (name, acpi_ut_trace_u32, u32, value)
Bob Moore0377b5a2012-12-31 00:06:33 +0000342
343#define ACPI_FUNCTION_TRACE_STR(name, string) \
Bob Moorefd1af712013-03-08 09:22:23 +0000344 ACPI_TRACE_ENTRY (name, acpi_ut_trace_str, char *, string)
Bob Moore0377b5a2012-12-31 00:06:33 +0000345
346#define ACPI_FUNCTION_ENTRY() \
347 acpi_ut_track_stack_ptr()
348
349/*
350 * Function exit tracing
351 *
352 * These macros include a return statement. This is usually considered
353 * bad form, but having a separate exit macro before the actual return
354 * is very ugly and difficult to maintain.
355 *
356 * One of the FUNCTION_TRACE macros above must be used in conjunction
357 * with these macros so that "_AcpiFunctionName" is defined.
Bob Moorefd1af712013-03-08 09:22:23 +0000358 *
359 * There are two versions of most of the return macros. The default version is
360 * safer, since it avoids side-effects by guaranteeing that the argument will
361 * not be evaluated twice.
362 *
363 * A less-safe version of the macros is provided for optional use if the
364 * compiler uses excessive CPU stack (for example, this may happen in the
365 * debug case if code optimzation is disabled.)
Bob Moore0377b5a2012-12-31 00:06:33 +0000366 */
Bob Moore0377b5a2012-12-31 00:06:33 +0000367
368/* Exit trace helper macro */
369
Bob Moorefd1af712013-03-08 09:22:23 +0000370#ifndef ACPI_SIMPLE_RETURN_MACROS
371
372#define ACPI_TRACE_EXIT(function, type, param) \
Bob Moore0377b5a2012-12-31 00:06:33 +0000373 ACPI_DO_WHILE0 ({ \
Bob Moorefd1af712013-03-08 09:22:23 +0000374 register type _param = (type) (param); \
375 function (ACPI_DEBUG_PARAMETERS, _param); \
376 return (_param); \
Bob Moore0377b5a2012-12-31 00:06:33 +0000377 })
378
Bob Moorefd1af712013-03-08 09:22:23 +0000379#else /* Use original less-safe macros */
380
381#define ACPI_TRACE_EXIT(function, type, param) \
382 ACPI_DO_WHILE0 ({ \
383 function (ACPI_DEBUG_PARAMETERS, (type) (param)); \
384 return (param); \
385 })
386
387#endif /* ACPI_SIMPLE_RETURN_MACROS */
388
Bob Moore0377b5a2012-12-31 00:06:33 +0000389/* The actual exit macros */
390
391#define return_VOID \
392 ACPI_DO_WHILE0 ({ \
393 acpi_ut_exit (ACPI_DEBUG_PARAMETERS); \
394 return; \
395 })
396
397#define return_ACPI_STATUS(status) \
Bob Moorefd1af712013-03-08 09:22:23 +0000398 ACPI_TRACE_EXIT (acpi_ut_status_exit, acpi_status, status)
Bob Moore0377b5a2012-12-31 00:06:33 +0000399
400#define return_PTR(pointer) \
Bob Moorefd1af712013-03-08 09:22:23 +0000401 ACPI_TRACE_EXIT (acpi_ut_ptr_exit, void *, pointer)
Bob Moore0377b5a2012-12-31 00:06:33 +0000402
403#define return_VALUE(value) \
Bob Moorefd1af712013-03-08 09:22:23 +0000404 ACPI_TRACE_EXIT (acpi_ut_value_exit, u64, value)
405
406#define return_UINT32(value) \
407 ACPI_TRACE_EXIT (acpi_ut_value_exit, u32, value)
408
409#define return_UINT8(value) \
410 ACPI_TRACE_EXIT (acpi_ut_value_exit, u8, value)
Bob Moore0377b5a2012-12-31 00:06:33 +0000411
412/* Conditional execution */
413
414#define ACPI_DEBUG_EXEC(a) a
415#define ACPI_DEBUG_ONLY_MEMBERS(a) a;
416#define _VERBOSE_STRUCTURES
417
418/* Various object display routines for debug */
419
420#define ACPI_DUMP_STACK_ENTRY(a) acpi_ex_dump_operand((a), 0)
421#define ACPI_DUMP_OPERANDS(a, b ,c) acpi_ex_dump_operands(a, b, c)
422#define ACPI_DUMP_ENTRY(a, b) acpi_ns_dump_entry (a, b)
423#define ACPI_DUMP_PATHNAME(a, b, c, d) acpi_ns_dump_pathname(a, b, c, d)
424#define ACPI_DUMP_BUFFER(a, b) acpi_ut_debug_dump_buffer((u8 *) a, b, DB_BYTE_DISPLAY, _COMPONENT)
425
426#else /* ACPI_DEBUG_OUTPUT */
Bob Moore50df4d82008-12-31 03:01:23 +0800427/*
428 * This is the non-debug case -- make everything go away,
429 * leaving no executable debug code!
430 */
431#define ACPI_FUNCTION_NAME(a)
432#define ACPI_DEBUG_PRINT(pl)
433#define ACPI_DEBUG_PRINT_RAW(pl)
Bob Moore0377b5a2012-12-31 00:06:33 +0000434#define ACPI_DEBUG_EXEC(a)
435#define ACPI_DEBUG_ONLY_MEMBERS(a)
436#define ACPI_FUNCTION_TRACE(a)
437#define ACPI_FUNCTION_TRACE_PTR(a, b)
438#define ACPI_FUNCTION_TRACE_U32(a, b)
439#define ACPI_FUNCTION_TRACE_STR(a, b)
440#define ACPI_FUNCTION_EXIT
441#define ACPI_FUNCTION_STATUS_EXIT(s)
442#define ACPI_FUNCTION_VALUE_EXIT(s)
443#define ACPI_FUNCTION_ENTRY()
444#define ACPI_DUMP_STACK_ENTRY(a)
445#define ACPI_DUMP_OPERANDS(a, b, c)
446#define ACPI_DUMP_ENTRY(a, b)
447#define ACPI_DUMP_TABLES(a, b)
448#define ACPI_DUMP_PATHNAME(a, b, c, d)
449#define ACPI_DUMP_BUFFER(a, b)
450#define ACPI_DEBUG_PRINT(pl)
451#define ACPI_DEBUG_PRINT_RAW(pl)
Bob Mooree81a52b2012-12-31 00:06:50 +0000452#define ACPI_IS_DEBUG_ENABLED(level, component) 0
Bob Moore0377b5a2012-12-31 00:06:33 +0000453
454/* Return macros must have a return statement at the minimum */
455
456#define return_VOID return
457#define return_ACPI_STATUS(s) return(s)
Bob Moore0377b5a2012-12-31 00:06:33 +0000458#define return_PTR(s) return(s)
Bob Moorefd1af712013-03-08 09:22:23 +0000459#define return_VALUE(s) return(s)
460#define return_UINT8(s) return(s)
461#define return_UINT32(s) return(s)
Bob Moore50df4d82008-12-31 03:01:23 +0800462
463#endif /* ACPI_DEBUG_OUTPUT */
464
Len Brown4be44fc2005-08-05 00:44:28 -0400465#endif /* __ACOUTPUT_H__ */