[linux-2.6-block.git] / include / acpi / acoutput.h

/* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
/******************************************************************************
 *
 * Name: acoutput.h -- debug output
 *
 * Copyright (C) 2000 - 2018, Intel Corp.
 *
 *****************************************************************************/

#ifndef __ACOUTPUT_H__
#define __ACOUTPUT_H__

/*
 * Debug levels and component IDs. These are used to control the
 * granularity of the output of the ACPI_DEBUG_PRINT macro -- on a
 * per-component basis and a per-exception-type basis.
 */

/* Component IDs are used in the global "DebugLayer" */

#define ACPI_UTILITIES              0x00000001
#define ACPI_HARDWARE               0x00000002
#define ACPI_EVENTS                 0x00000004
#define ACPI_TABLES                 0x00000008
#define ACPI_NAMESPACE              0x00000010
#define ACPI_PARSER                 0x00000020
#define ACPI_DISPATCHER             0x00000040
#define ACPI_EXECUTER               0x00000080
#define ACPI_RESOURCES              0x00000100
#define ACPI_CA_DEBUGGER            0x00000200
#define ACPI_OS_SERVICES            0x00000400
#define ACPI_CA_DISASSEMBLER        0x00000800

/* Component IDs for ACPI tools and utilities */

#define ACPI_COMPILER               0x00001000
#define ACPI_TOOLS                  0x00002000
#define ACPI_EXAMPLE                0x00004000
#define ACPI_DRIVER                 0x00008000
#define DT_COMPILER                 0x00010000
#define ASL_PREPROCESSOR            0x00020000

#define ACPI_ALL_COMPONENTS         0x0001FFFF
#define ACPI_COMPONENT_DEFAULT      (ACPI_ALL_COMPONENTS)

/* Component IDs reserved for ACPI drivers */

#define ACPI_ALL_DRIVERS            0xFFFF0000

/*
 * Raw debug output levels, do not use these in the ACPI_DEBUG_PRINT macros
 */
#define ACPI_LV_INIT                0x00000001
#define ACPI_LV_DEBUG_OBJECT        0x00000002
#define ACPI_LV_INFO                0x00000004
#define ACPI_LV_REPAIR              0x00000008
#define ACPI_LV_TRACE_POINT         0x00000010
#define ACPI_LV_ALL_EXCEPTIONS      0x0000001F

/* Trace verbosity level 1 [Standard Trace Level] */

#define ACPI_LV_INIT_NAMES          0x00000020
#define ACPI_LV_PARSE               0x00000040
#define ACPI_LV_LOAD                0x00000080
#define ACPI_LV_DISPATCH            0x00000100
#define ACPI_LV_EXEC                0x00000200
#define ACPI_LV_NAMES               0x00000400
#define ACPI_LV_OPREGION            0x00000800
#define ACPI_LV_BFIELD              0x00001000
#define ACPI_LV_TABLES              0x00002000
#define ACPI_LV_VALUES              0x00004000
#define ACPI_LV_OBJECTS             0x00008000
#define ACPI_LV_RESOURCES           0x00010000
#define ACPI_LV_USER_REQUESTS       0x00020000
#define ACPI_LV_PACKAGE             0x00040000
#define ACPI_LV_VERBOSITY1          0x0007FF40 | ACPI_LV_ALL_EXCEPTIONS

/* Trace verbosity level 2 [Function tracing and memory allocation] */

#define ACPI_LV_ALLOCATIONS         0x00100000
#define ACPI_LV_FUNCTIONS           0x00200000
#define ACPI_LV_OPTIMIZATIONS       0x00400000
#define ACPI_LV_VERBOSITY2          0x00700000 | ACPI_LV_VERBOSITY1
#define ACPI_LV_ALL                 ACPI_LV_VERBOSITY2

/* Trace verbosity level 3 [Threading, I/O, and Interrupts] */

#define ACPI_LV_MUTEX               0x01000000
#define ACPI_LV_THREADS             0x02000000
#define ACPI_LV_IO                  0x04000000
#define ACPI_LV_INTERRUPTS          0x08000000
#define ACPI_LV_VERBOSITY3          0x0F000000 | ACPI_LV_VERBOSITY2

/* Exceptionally verbose output -- also used in the global "DebugLevel"  */

#define ACPI_LV_AML_DISASSEMBLE     0x10000000
#define ACPI_LV_VERBOSE_INFO        0x20000000
#define ACPI_LV_FULL_TABLES         0x40000000
#define ACPI_LV_EVENTS              0x80000000
#define ACPI_LV_VERBOSE             0xF0000000

/*
 * Debug level macros that are used in the DEBUG_PRINT macros
 */
#define ACPI_DEBUG_LEVEL(dl)        (u32) dl,ACPI_DEBUG_PARAMETERS

/*
 * Exception level -- used in the global "DebugLevel"
 *
 * Note: For errors, use the ACPI_ERROR or ACPI_EXCEPTION interfaces.
 * For warnings, use ACPI_WARNING.
 */
#define ACPI_DB_INIT                ACPI_DEBUG_LEVEL (ACPI_LV_INIT)
#define ACPI_DB_DEBUG_OBJECT        ACPI_DEBUG_LEVEL (ACPI_LV_DEBUG_OBJECT)
#define ACPI_DB_INFO                ACPI_DEBUG_LEVEL (ACPI_LV_INFO)
#define ACPI_DB_REPAIR              ACPI_DEBUG_LEVEL (ACPI_LV_REPAIR)
#define ACPI_DB_TRACE_POINT         ACPI_DEBUG_LEVEL (ACPI_LV_TRACE_POINT)
#define ACPI_DB_ALL_EXCEPTIONS      ACPI_DEBUG_LEVEL (ACPI_LV_ALL_EXCEPTIONS)

/* Trace level -- also used in the global "DebugLevel" */

#define ACPI_DB_INIT_NAMES          ACPI_DEBUG_LEVEL (ACPI_LV_INIT_NAMES)
#define ACPI_DB_THREADS             ACPI_DEBUG_LEVEL (ACPI_LV_THREADS)
#define ACPI_DB_PARSE               ACPI_DEBUG_LEVEL (ACPI_LV_PARSE)
#define ACPI_DB_DISPATCH            ACPI_DEBUG_LEVEL (ACPI_LV_DISPATCH)
#define ACPI_DB_LOAD                ACPI_DEBUG_LEVEL (ACPI_LV_LOAD)
#define ACPI_DB_EXEC                ACPI_DEBUG_LEVEL (ACPI_LV_EXEC)
#define ACPI_DB_NAMES               ACPI_DEBUG_LEVEL (ACPI_LV_NAMES)
#define ACPI_DB_OPREGION            ACPI_DEBUG_LEVEL (ACPI_LV_OPREGION)
#define ACPI_DB_BFIELD              ACPI_DEBUG_LEVEL (ACPI_LV_BFIELD)
#define ACPI_DB_TABLES              ACPI_DEBUG_LEVEL (ACPI_LV_TABLES)
#define ACPI_DB_FUNCTIONS           ACPI_DEBUG_LEVEL (ACPI_LV_FUNCTIONS)
#define ACPI_DB_OPTIMIZATIONS       ACPI_DEBUG_LEVEL (ACPI_LV_OPTIMIZATIONS)
#define ACPI_DB_VALUES              ACPI_DEBUG_LEVEL (ACPI_LV_VALUES)
#define ACPI_DB_OBJECTS             ACPI_DEBUG_LEVEL (ACPI_LV_OBJECTS)
#define ACPI_DB_ALLOCATIONS         ACPI_DEBUG_LEVEL (ACPI_LV_ALLOCATIONS)
#define ACPI_DB_RESOURCES           ACPI_DEBUG_LEVEL (ACPI_LV_RESOURCES)
#define ACPI_DB_IO                  ACPI_DEBUG_LEVEL (ACPI_LV_IO)
#define ACPI_DB_INTERRUPTS          ACPI_DEBUG_LEVEL (ACPI_LV_INTERRUPTS)
#define ACPI_DB_USER_REQUESTS       ACPI_DEBUG_LEVEL (ACPI_LV_USER_REQUESTS)
#define ACPI_DB_PACKAGE             ACPI_DEBUG_LEVEL (ACPI_LV_PACKAGE)
#define ACPI_DB_MUTEX               ACPI_DEBUG_LEVEL (ACPI_LV_MUTEX)
#define ACPI_DB_EVENTS              ACPI_DEBUG_LEVEL (ACPI_LV_EVENTS)

#define ACPI_DB_ALL                 ACPI_DEBUG_LEVEL (ACPI_LV_ALL)

/* Defaults for debug_level, debug and normal */

#define ACPI_DEBUG_DEFAULT          (ACPI_LV_INFO | ACPI_LV_REPAIR)
#define ACPI_NORMAL_DEFAULT         (ACPI_LV_INIT | ACPI_LV_DEBUG_OBJECT | ACPI_LV_REPAIR)
#define ACPI_DEBUG_ALL              (ACPI_LV_AML_DISASSEMBLE | ACPI_LV_ALL_EXCEPTIONS | ACPI_LV_ALL)

/*
 * Global trace flags
 */
#define ACPI_TRACE_ENABLED          ((u32) 4)
#define ACPI_TRACE_ONESHOT          ((u32) 2)
#define ACPI_TRACE_OPCODE           ((u32) 1)

/* Defaults for trace debugging level/layer */

#define ACPI_TRACE_LEVEL_ALL        ACPI_LV_ALL
#define ACPI_TRACE_LAYER_ALL        0x000001FF
#define ACPI_TRACE_LEVEL_DEFAULT    ACPI_LV_TRACE_POINT
#define ACPI_TRACE_LAYER_DEFAULT    ACPI_EXECUTER

#if defined (ACPI_DEBUG_OUTPUT) || !defined (ACPI_NO_ERROR_MESSAGES)
/*
 * The module name is used primarily for error and debug messages.
 * The __FILE__ macro is not very useful for this, because it
 * usually includes the entire pathname to the module making the
 * debug output difficult to read.
 */
#define ACPI_MODULE_NAME(name)          static const char ACPI_UNUSED_VAR _acpi_module_name[] = name;
#else
/*
 * For the no-debug and no-error-msg cases, we must at least define
 * a null module name.
 */
#define ACPI_MODULE_NAME(name)
#define _acpi_module_name ""
#endif

/*
 * Ascii error messages can be configured out
 */
#ifndef ACPI_NO_ERROR_MESSAGES
#define AE_INFO                         _acpi_module_name, __LINE__

/*
 * Error reporting. Callers module and line number are inserted by AE_INFO,
 * the plist contains a set of parens to allow variable-length lists.
 * These macros are used for both the debug and non-debug versions of the code.
 */
#define ACPI_INFO(plist)                acpi_info plist
#define ACPI_WARNING(plist)             acpi_warning plist
#define ACPI_EXCEPTION(plist)           acpi_exception plist
#define ACPI_ERROR(plist)               acpi_error plist
#define ACPI_BIOS_WARNING(plist)        acpi_bios_warning plist
#define ACPI_BIOS_ERROR(plist)          acpi_bios_error plist
#define ACPI_DEBUG_OBJECT(obj,l,i)      acpi_ex_do_debug_object(obj,l,i)

#else

/* No error messages */

#define ACPI_INFO(plist)
#define ACPI_WARNING(plist)
#define ACPI_EXCEPTION(plist)
#define ACPI_ERROR(plist)
#define ACPI_BIOS_WARNING(plist)
#define ACPI_BIOS_ERROR(plist)
#define ACPI_DEBUG_OBJECT(obj,l,i)

#endif				/* ACPI_NO_ERROR_MESSAGES */

/*
 * Debug macros that are conditionally compiled
 */
#ifdef ACPI_DEBUG_OUTPUT

/*
 * If ACPI_GET_FUNCTION_NAME was not defined in the compiler-dependent header,
 * define it now. This is the case where there the compiler does not support
 * a __func__ macro or equivalent.
 */
#ifndef ACPI_GET_FUNCTION_NAME
#define ACPI_GET_FUNCTION_NAME          _acpi_function_name

/*
 * The Name parameter should be the procedure name as a non-quoted string.
 * The function name is also used by the function exit macros below.
 * Note: (const char) is used to be compatible with the debug interfaces
 * and macros such as __func__.
 */
#define ACPI_FUNCTION_NAME(name)        static const char _acpi_function_name[] = #name;

#else
/* Compiler supports __func__ (or equivalent) -- Ignore this macro */

#define ACPI_FUNCTION_NAME(name)
#endif				/* ACPI_GET_FUNCTION_NAME */

/*
 * Common parameters used for debug output functions:
 * line number, function name, module(file) name, component ID
 */
#define ACPI_DEBUG_PARAMETERS \
	__LINE__, ACPI_GET_FUNCTION_NAME, _acpi_module_name, _COMPONENT

/* Check if debug output is currently dynamically enabled */

#define ACPI_IS_DEBUG_ENABLED(level, component) \
	((level & acpi_dbg_level) && (component & acpi_dbg_layer))

/*
 * Master debug print macros
 * Print message if and only if:
 *    1) Debug print for the current component is enabled
 *    2) Debug error level or trace level for the print statement is enabled
 *
 * November 2012: Moved the runtime check for whether to actually emit the
 * debug message outside of the print function itself. This improves overall
 * performance at a relatively small code cost. Implementation involves the
 * use of variadic macros supported by C99.
 *
 * Note: the ACPI_DO_WHILE0 macro is used to prevent some compilers from
 * complaining about these constructs. On other compilers the do...while
 * adds some extra code, so this feature is optional.
 */
#ifdef ACPI_USE_DO_WHILE_0
#define ACPI_DO_WHILE0(a)               do a while(0)
#else
#define ACPI_DO_WHILE0(a)               a
#endif

/* DEBUG_PRINT functions */

#ifndef COMPILER_VA_MACRO

#define ACPI_DEBUG_PRINT(plist)         acpi_debug_print plist
#define ACPI_DEBUG_PRINT_RAW(plist)     acpi_debug_print_raw plist

#else

/* Helper macros for DEBUG_PRINT */

#define ACPI_DO_DEBUG_PRINT(function, level, line, filename, modulename, component, ...) \
	ACPI_DO_WHILE0 ({ \
		if (ACPI_IS_DEBUG_ENABLED (level, component)) \
		{ \
			function (level, line, filename, modulename, component, __VA_ARGS__); \
		} \
	})

#define ACPI_ACTUAL_DEBUG(level, line, filename, modulename, component, ...) \
	ACPI_DO_DEBUG_PRINT (acpi_debug_print, level, line, \
		filename, modulename, component, __VA_ARGS__)

#define ACPI_ACTUAL_DEBUG_RAW(level, line, filename, modulename, component, ...) \
	ACPI_DO_DEBUG_PRINT (acpi_debug_print_raw, level, line, \
		filename, modulename, component, __VA_ARGS__)

#define ACPI_DEBUG_PRINT(plist)         ACPI_ACTUAL_DEBUG plist
#define ACPI_DEBUG_PRINT_RAW(plist)     ACPI_ACTUAL_DEBUG_RAW plist

#endif

/*
 * Function entry tracing
 *
 * The name of the function is emitted as a local variable that is
 * intended to be used by both the entry trace and the exit trace.
 */

/* Helper macro */

#define ACPI_TRACE_ENTRY(name, function, type, param) \
	ACPI_FUNCTION_NAME (name) \
	function (ACPI_DEBUG_PARAMETERS, (type) (param))

/* The actual entry trace macros */

#define ACPI_FUNCTION_TRACE(name) \
	ACPI_FUNCTION_NAME(name) \
	acpi_ut_trace (ACPI_DEBUG_PARAMETERS)

#define ACPI_FUNCTION_TRACE_PTR(name, pointer) \
	ACPI_TRACE_ENTRY (name, acpi_ut_trace_ptr, void *, pointer)

#define ACPI_FUNCTION_TRACE_U32(name, value) \
	ACPI_TRACE_ENTRY (name, acpi_ut_trace_u32, u32, value)

#define ACPI_FUNCTION_TRACE_STR(name, string) \
	ACPI_TRACE_ENTRY (name, acpi_ut_trace_str, const char *, string)

#define ACPI_FUNCTION_ENTRY() \
	acpi_ut_track_stack_ptr()

/*
 * Function exit tracing
 *
 * These macros include a return statement. This is usually considered
 * bad form, but having a separate exit macro before the actual return
 * is very ugly and difficult to maintain.
 *
 * One of the FUNCTION_TRACE macros above must be used in conjunction
 * with these macros so that "_AcpiFunctionName" is defined.
 *
 * There are two versions of most of the return macros. The default version is
 * safer, since it avoids side-effects by guaranteeing that the argument will
 * not be evaluated twice.
 *
 * A less-safe version of the macros is provided for optional use if the
 * compiler uses excessive CPU stack (for example, this may happen in the
 * debug case if code optimzation is disabled.)
 */

/* Exit trace helper macro */

#ifndef ACPI_SIMPLE_RETURN_MACROS

#define ACPI_TRACE_EXIT(function, type, param) \
	ACPI_DO_WHILE0 ({ \
		register type _param = (type) (param); \
		function (ACPI_DEBUG_PARAMETERS, _param); \
		return (_param); \
	})

#else				/* Use original less-safe macros */

#define ACPI_TRACE_EXIT(function, type, param) \
	ACPI_DO_WHILE0 ({ \
		function (ACPI_DEBUG_PARAMETERS, (type) (param)); \
		return (param); \
	})

#endif				/* ACPI_SIMPLE_RETURN_MACROS */

/* The actual exit macros */

#define return_VOID \
	ACPI_DO_WHILE0 ({ \
		acpi_ut_exit (ACPI_DEBUG_PARAMETERS); \
		return; \
	})

#define return_ACPI_STATUS(status) \
	ACPI_TRACE_EXIT (acpi_ut_status_exit, acpi_status, status)

#define return_PTR(pointer) \
	ACPI_TRACE_EXIT (acpi_ut_ptr_exit, void *, pointer)

#define return_STR(string) \
	ACPI_TRACE_EXIT (acpi_ut_str_exit, const char *, string)

#define return_VALUE(value) \
	ACPI_TRACE_EXIT (acpi_ut_value_exit, u64, value)

#define return_UINT32(value) \
	ACPI_TRACE_EXIT (acpi_ut_value_exit, u32, value)

#define return_UINT8(value) \
	ACPI_TRACE_EXIT (acpi_ut_value_exit, u8, value)

/* Conditional execution */

#define ACPI_DEBUG_EXEC(a)              a
#define ACPI_DEBUG_ONLY_MEMBERS(a)      a;
#define _VERBOSE_STRUCTURES

/* Various object display routines for debug */

#define ACPI_DUMP_STACK_ENTRY(a)        acpi_ex_dump_operand((a), 0)
#define ACPI_DUMP_OPERANDS(a, b ,c)     acpi_ex_dump_operands(a, b, c)
#define ACPI_DUMP_ENTRY(a, b)           acpi_ns_dump_entry (a, b)
#define ACPI_DUMP_PATHNAME(a, b, c, d)  acpi_ns_dump_pathname(a, b, c, d)
#define ACPI_DUMP_BUFFER(a, b)          acpi_ut_debug_dump_buffer((u8 *) a, b, DB_BYTE_DISPLAY, _COMPONENT)

#define ACPI_TRACE_POINT(a, b, c, d)    acpi_trace_point (a, b, c, d)

#else				/* ACPI_DEBUG_OUTPUT */
/*
 * This is the non-debug case -- make everything go away,
 * leaving no executable debug code!
 */
#define ACPI_DEBUG_PRINT(pl)
#define ACPI_DEBUG_PRINT_RAW(pl)
#define ACPI_DEBUG_EXEC(a)
#define ACPI_DEBUG_ONLY_MEMBERS(a)
#define ACPI_FUNCTION_NAME(a)
#define ACPI_FUNCTION_TRACE(a)
#define ACPI_FUNCTION_TRACE_PTR(a, b)
#define ACPI_FUNCTION_TRACE_U32(a, b)
#define ACPI_FUNCTION_TRACE_STR(a, b)
#define ACPI_FUNCTION_ENTRY()
#define ACPI_DUMP_STACK_ENTRY(a)
#define ACPI_DUMP_OPERANDS(a, b, c)
#define ACPI_DUMP_ENTRY(a, b)
#define ACPI_DUMP_PATHNAME(a, b, c, d)
#define ACPI_DUMP_BUFFER(a, b)
#define ACPI_IS_DEBUG_ENABLED(level, component) 0
#define ACPI_TRACE_POINT(a, b, c, d)

/* Return macros must have a return statement at the minimum */

#define return_VOID                     return
#define return_ACPI_STATUS(s)           return(s)
#define return_PTR(s)                   return(s)
#define return_STR(s)                   return(s)
#define return_VALUE(s)                 return(s)
#define return_UINT8(s)                 return(s)
#define return_UINT32(s)                return(s)

#endif				/* ACPI_DEBUG_OUTPUT */

#endif				/* __ACOUTPUT_H__ */
Commit	Line	Data
95857638	1	/* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
1da177e4 LT	2	/******************************************************************************
	3	*
	4	* Name: acoutput.h -- debug output
	5	*
da6f8320	6	* Copyright (C) 2000 - 2018, Intel Corp.
1da177e4	7	*
95857638	8	*****************************************************************************/
1da177e4 LT	9
	10	#ifndef __ACOUTPUT_H__
	11	#define __ACOUTPUT_H__
	12
	13	/*
50df4d8b BM	14	* Debug levels and component IDs. These are used to control the
	15	* granularity of the output of the ACPI_DEBUG_PRINT macro -- on a
	16	* per-component basis and a per-exception-type basis.
1da177e4 LT	17	*/
1da177e4 LT	18
b229cf92	19	/* Component IDs are used in the global "DebugLayer" */
1da177e4 LT	20
	21	#define ACPI_UTILITIES 0x00000001
	22	#define ACPI_HARDWARE 0x00000002
	23	#define ACPI_EVENTS 0x00000004
	24	#define ACPI_TABLES 0x00000008
	25	#define ACPI_NAMESPACE 0x00000010
	26	#define ACPI_PARSER 0x00000020
	27	#define ACPI_DISPATCHER 0x00000040
	28	#define ACPI_EXECUTER 0x00000080
	29	#define ACPI_RESOURCES 0x00000100
	30	#define ACPI_CA_DEBUGGER 0x00000200
	31	#define ACPI_OS_SERVICES 0x00000400
	32	#define ACPI_CA_DISASSEMBLER 0x00000800
	33
	34	/* Component IDs for ACPI tools and utilities */
	35
	36	#define ACPI_COMPILER 0x00001000
	37	#define ACPI_TOOLS 0x00002000
50df4d8b BM	38	#define ACPI_EXAMPLE 0x00004000
50df4d8b BM	39	#define ACPI_DRIVER 0x00008000
ddcc6a03	40	#define DT_COMPILER 0x00010000
56324c10	41	#define ASL_PREPROCESSOR 0x00020000
1da177e4	42
ddcc6a03	43	#define ACPI_ALL_COMPONENTS 0x0001FFFF
1da177e4 LT	44	#define ACPI_COMPONENT_DEFAULT (ACPI_ALL_COMPONENTS)
1da177e4 LT	45
1da177e4 LT	46	/* Component IDs reserved for ACPI drivers */
	47
	48	#define ACPI_ALL_DRIVERS 0xFFFF0000
	49
1da177e4	50	/*
50df4d8b	51	* Raw debug output levels, do not use these in the ACPI_DEBUG_PRINT macros
1da177e4	52	*/
23d3e055 BM	53	#define ACPI_LV_INIT 0x00000001
	54	#define ACPI_LV_DEBUG_OBJECT 0x00000002
	55	#define ACPI_LV_INFO 0x00000004
3a58176e	56	#define ACPI_LV_REPAIR 0x00000008
a616dc2f LZ	57	#define ACPI_LV_TRACE_POINT 0x00000010
a616dc2f LZ	58	#define ACPI_LV_ALL_EXCEPTIONS 0x0000001F
1da177e4 LT	59
	60	/* Trace verbosity level 1 [Standard Trace Level] */
	61
	62	#define ACPI_LV_INIT_NAMES 0x00000020
	63	#define ACPI_LV_PARSE 0x00000040
	64	#define ACPI_LV_LOAD 0x00000080
	65	#define ACPI_LV_DISPATCH 0x00000100
	66	#define ACPI_LV_EXEC 0x00000200
	67	#define ACPI_LV_NAMES 0x00000400
	68	#define ACPI_LV_OPREGION 0x00000800
	69	#define ACPI_LV_BFIELD 0x00001000
	70	#define ACPI_LV_TABLES 0x00002000
	71	#define ACPI_LV_VALUES 0x00004000
	72	#define ACPI_LV_OBJECTS 0x00008000
	73	#define ACPI_LV_RESOURCES 0x00010000
	74	#define ACPI_LV_USER_REQUESTS 0x00020000
	75	#define ACPI_LV_PACKAGE 0x00040000
	76	#define ACPI_LV_VERBOSITY1 0x0007FF40 \| ACPI_LV_ALL_EXCEPTIONS
	77
	78	/* Trace verbosity level 2 [Function tracing and memory allocation] */
	79
	80	#define ACPI_LV_ALLOCATIONS 0x00100000
	81	#define ACPI_LV_FUNCTIONS 0x00200000
	82	#define ACPI_LV_OPTIMIZATIONS 0x00400000
	83	#define ACPI_LV_VERBOSITY2 0x00700000 \| ACPI_LV_VERBOSITY1
	84	#define ACPI_LV_ALL ACPI_LV_VERBOSITY2
	85
	86	/* Trace verbosity level 3 [Threading, I/O, and Interrupts] */
	87
	88	#define ACPI_LV_MUTEX 0x01000000
	89	#define ACPI_LV_THREADS 0x02000000
	90	#define ACPI_LV_IO 0x04000000
	91	#define ACPI_LV_INTERRUPTS 0x08000000
	92	#define ACPI_LV_VERBOSITY3 0x0F000000 \| ACPI_LV_VERBOSITY2
	93
b229cf92	94	/* Exceptionally verbose output -- also used in the global "DebugLevel" */
1da177e4 LT	95
	96	#define ACPI_LV_AML_DISASSEMBLE 0x10000000
	97	#define ACPI_LV_VERBOSE_INFO 0x20000000
	98	#define ACPI_LV_FULL_TABLES 0x40000000
	99	#define ACPI_LV_EVENTS 0x80000000
1da177e4 LT	100	#define ACPI_LV_VERBOSE 0xF0000000
1da177e4 LT	101
1da177e4 LT	102	/*
	103	* Debug level macros that are used in the DEBUG_PRINT macros
	104	*/
f9f4601f	105	#define ACPI_DEBUG_LEVEL(dl) (u32) dl,ACPI_DEBUG_PARAMETERS
1da177e4	106
23d3e055 BM	107	/*
	108	* Exception level -- used in the global "DebugLevel"
	109	*
	110	* Note: For errors, use the ACPI_ERROR or ACPI_EXCEPTION interfaces.
	111	* For warnings, use ACPI_WARNING.
	112	*/
1da177e4 LT	113	#define ACPI_DB_INIT ACPI_DEBUG_LEVEL (ACPI_LV_INIT)
	114	#define ACPI_DB_DEBUG_OBJECT ACPI_DEBUG_LEVEL (ACPI_LV_DEBUG_OBJECT)
	115	#define ACPI_DB_INFO ACPI_DEBUG_LEVEL (ACPI_LV_INFO)
3a58176e	116	#define ACPI_DB_REPAIR ACPI_DEBUG_LEVEL (ACPI_LV_REPAIR)
a616dc2f	117	#define ACPI_DB_TRACE_POINT ACPI_DEBUG_LEVEL (ACPI_LV_TRACE_POINT)
1da177e4 LT	118	#define ACPI_DB_ALL_EXCEPTIONS ACPI_DEBUG_LEVEL (ACPI_LV_ALL_EXCEPTIONS)
1da177e4 LT	119
b229cf92	120	/* Trace level -- also used in the global "DebugLevel" */
1da177e4 LT	121
	122	#define ACPI_DB_INIT_NAMES ACPI_DEBUG_LEVEL (ACPI_LV_INIT_NAMES)
	123	#define ACPI_DB_THREADS ACPI_DEBUG_LEVEL (ACPI_LV_THREADS)
	124	#define ACPI_DB_PARSE ACPI_DEBUG_LEVEL (ACPI_LV_PARSE)
	125	#define ACPI_DB_DISPATCH ACPI_DEBUG_LEVEL (ACPI_LV_DISPATCH)
	126	#define ACPI_DB_LOAD ACPI_DEBUG_LEVEL (ACPI_LV_LOAD)
	127	#define ACPI_DB_EXEC ACPI_DEBUG_LEVEL (ACPI_LV_EXEC)
	128	#define ACPI_DB_NAMES ACPI_DEBUG_LEVEL (ACPI_LV_NAMES)
	129	#define ACPI_DB_OPREGION ACPI_DEBUG_LEVEL (ACPI_LV_OPREGION)
	130	#define ACPI_DB_BFIELD ACPI_DEBUG_LEVEL (ACPI_LV_BFIELD)
	131	#define ACPI_DB_TABLES ACPI_DEBUG_LEVEL (ACPI_LV_TABLES)
	132	#define ACPI_DB_FUNCTIONS ACPI_DEBUG_LEVEL (ACPI_LV_FUNCTIONS)
	133	#define ACPI_DB_OPTIMIZATIONS ACPI_DEBUG_LEVEL (ACPI_LV_OPTIMIZATIONS)
	134	#define ACPI_DB_VALUES ACPI_DEBUG_LEVEL (ACPI_LV_VALUES)
	135	#define ACPI_DB_OBJECTS ACPI_DEBUG_LEVEL (ACPI_LV_OBJECTS)
	136	#define ACPI_DB_ALLOCATIONS ACPI_DEBUG_LEVEL (ACPI_LV_ALLOCATIONS)
	137	#define ACPI_DB_RESOURCES ACPI_DEBUG_LEVEL (ACPI_LV_RESOURCES)
	138	#define ACPI_DB_IO ACPI_DEBUG_LEVEL (ACPI_LV_IO)
	139	#define ACPI_DB_INTERRUPTS ACPI_DEBUG_LEVEL (ACPI_LV_INTERRUPTS)
	140	#define ACPI_DB_USER_REQUESTS ACPI_DEBUG_LEVEL (ACPI_LV_USER_REQUESTS)
	141	#define ACPI_DB_PACKAGE ACPI_DEBUG_LEVEL (ACPI_LV_PACKAGE)
	142	#define ACPI_DB_MUTEX ACPI_DEBUG_LEVEL (ACPI_LV_MUTEX)
23d3e055	143	#define ACPI_DB_EVENTS ACPI_DEBUG_LEVEL (ACPI_LV_EVENTS)
1da177e4 LT	144
	145	#define ACPI_DB_ALL ACPI_DEBUG_LEVEL (ACPI_LV_ALL)
	146
1da177e4 LT	147	/* Defaults for debug_level, debug and normal */
1da177e4 LT	148
3a58176e BM	149	#define ACPI_DEBUG_DEFAULT (ACPI_LV_INFO \| ACPI_LV_REPAIR)
3a58176e BM	150	#define ACPI_NORMAL_DEFAULT (ACPI_LV_INIT \| ACPI_LV_DEBUG_OBJECT \| ACPI_LV_REPAIR)
1da177e4 LT	151	#define ACPI_DEBUG_ALL (ACPI_LV_AML_DISASSEMBLE \| ACPI_LV_ALL_EXCEPTIONS \| ACPI_LV_ALL)
1da177e4 LT	152
ab6c5733 LZ	153	/*
	154	* Global trace flags
	155	*/
fb18e8fd LZ	156	#define ACPI_TRACE_ENABLED ((u32) 4)
	157	#define ACPI_TRACE_ONESHOT ((u32) 2)
	158	#define ACPI_TRACE_OPCODE ((u32) 1)
ab6c5733 LZ	159
	160	/* Defaults for trace debugging level/layer */
	161
	162	#define ACPI_TRACE_LEVEL_ALL ACPI_LV_ALL
	163	#define ACPI_TRACE_LAYER_ALL 0x000001FF
	164	#define ACPI_TRACE_LEVEL_DEFAULT ACPI_LV_TRACE_POINT
	165	#define ACPI_TRACE_LAYER_DEFAULT ACPI_EXECUTER
	166
50df4d8b BM	167	#if defined (ACPI_DEBUG_OUTPUT) \|\| !defined (ACPI_NO_ERROR_MESSAGES)
50df4d8b BM	168	/*
d59a3c6b BM	169	* The module name is used primarily for error and debug messages.
	170	* The __FILE__ macro is not very useful for this, because it
	171	* usually includes the entire pathname to the module making the
	172	* debug output difficult to read.
50df4d8b BM	173	*/
	174	#define ACPI_MODULE_NAME(name) static const char ACPI_UNUSED_VAR _acpi_module_name[] = name;
	175	#else
d59a3c6b BM	176	/*
	177	* For the no-debug and no-error-msg cases, we must at least define
	178	* a null module name.
	179	*/
50df4d8b	180	#define ACPI_MODULE_NAME(name)
d59a3c6b	181	#define _acpi_module_name ""
50df4d8b BM	182	#endif
	183
	184	/*
	185	* Ascii error messages can be configured out
	186	*/
	187	#ifndef ACPI_NO_ERROR_MESSAGES
	188	#define AE_INFO _acpi_module_name, __LINE__
	189
	190	/*
	191	* Error reporting. Callers module and line number are inserted by AE_INFO,
	192	* the plist contains a set of parens to allow variable-length lists.
	193	* These macros are used for both the debug and non-debug versions of the code.
	194	*/
	195	#define ACPI_INFO(plist) acpi_info plist
	196	#define ACPI_WARNING(plist) acpi_warning plist
	197	#define ACPI_EXCEPTION(plist) acpi_exception plist
	198	#define ACPI_ERROR(plist) acpi_error plist
62cdd141 BM	199	#define ACPI_BIOS_WARNING(plist) acpi_bios_warning plist
62cdd141 BM	200	#define ACPI_BIOS_ERROR(plist) acpi_bios_error plist
4cdf1a56	201	#define ACPI_DEBUG_OBJECT(obj,l,i) acpi_ex_do_debug_object(obj,l,i)
50df4d8b BM	202
	203	#else
	204
	205	/* No error messages */
	206
	207	#define ACPI_INFO(plist)
	208	#define ACPI_WARNING(plist)
	209	#define ACPI_EXCEPTION(plist)
	210	#define ACPI_ERROR(plist)
62cdd141 BM	211	#define ACPI_BIOS_WARNING(plist)
62cdd141 BM	212	#define ACPI_BIOS_ERROR(plist)
4cdf1a56	213	#define ACPI_DEBUG_OBJECT(obj,l,i)
50df4d8b BM	214
	215	#endif /* ACPI_NO_ERROR_MESSAGES */
	216
	217	/*
	218	* Debug macros that are conditionally compiled
	219	*/
	220	#ifdef ACPI_DEBUG_OUTPUT
	221
	222	/*
	223	* If ACPI_GET_FUNCTION_NAME was not defined in the compiler-dependent header,
	224	* define it now. This is the case where there the compiler does not support
02f1f217	225	* a __func__ macro or equivalent.
50df4d8b BM	226	*/
	227	#ifndef ACPI_GET_FUNCTION_NAME
	228	#define ACPI_GET_FUNCTION_NAME _acpi_function_name
	229
	230	/*
1e059e20	231	* The Name parameter should be the procedure name as a non-quoted string.
50df4d8b BM	232	* The function name is also used by the function exit macros below.
50df4d8b BM	233	* Note: (const char) is used to be compatible with the debug interfaces
02f1f217	234	* and macros such as __func__.
50df4d8b BM	235	*/
	236	#define ACPI_FUNCTION_NAME(name) static const char _acpi_function_name[] = #name;
	237
	238	#else
02f1f217	239	/* Compiler supports __func__ (or equivalent) -- Ignore this macro */
50df4d8b BM	240
	241	#define ACPI_FUNCTION_NAME(name)
	242	#endif /* ACPI_GET_FUNCTION_NAME */
	243
	244	/*
	245	* Common parameters used for debug output functions:
	246	* line number, function name, module(file) name, component ID
	247	*/
ad5a06f2 BM	248	#define ACPI_DEBUG_PARAMETERS \
ad5a06f2 BM	249	__LINE__, ACPI_GET_FUNCTION_NAME, _acpi_module_name, _COMPONENT
50df4d8b	250
e81a52b8 BM	251	/* Check if debug output is currently dynamically enabled */
	252
	253	#define ACPI_IS_DEBUG_ENABLED(level, component) \
	254	((level & acpi_dbg_level) && (component & acpi_dbg_layer))
	255
50df4d8b BM	256	/*
	257	* Master debug print macros
	258	* Print message if and only if:
	259	* 1) Debug print for the current component is enabled
	260	* 2) Debug error level or trace level for the print statement is enabled
ad5a06f2 BM	261	*
	262	* November 2012: Moved the runtime check for whether to actually emit the
	263	* debug message outside of the print function itself. This improves overall
	264	* performance at a relatively small code cost. Implementation involves the
	265	* use of variadic macros supported by C99.
6e1888fd BM	266	*
	267	* Note: the ACPI_DO_WHILE0 macro is used to prevent some compilers from
	268	* complaining about these constructs. On other compilers the do...while
	269	* adds some extra code, so this feature is optional.
50df4d8b	270	*/
6e1888fd BM	271	#ifdef ACPI_USE_DO_WHILE_0
	272	#define ACPI_DO_WHILE0(a) do a while(0)
	273	#else
	274	#define ACPI_DO_WHILE0(a) a
	275	#endif
ad5a06f2 BM	276
	277	/* DEBUG_PRINT functions */
	278
7b09d8fd LZ	279	#ifndef COMPILER_VA_MACRO
	280
	281	#define ACPI_DEBUG_PRINT(plist) acpi_debug_print plist
	282	#define ACPI_DEBUG_PRINT_RAW(plist) acpi_debug_print_raw plist
	283
	284	#else
ad5a06f2 BM	285
	286	/* Helper macros for DEBUG_PRINT */
	287
6e1888fd BM	288	#define ACPI_DO_DEBUG_PRINT(function, level, line, filename, modulename, component, ...) \
	289	ACPI_DO_WHILE0 ({ \
	290	if (ACPI_IS_DEBUG_ENABLED (level, component)) \
	291	{ \
	292	function (level, line, filename, modulename, component, __VA_ARGS__); \
	293	} \
	294	})
ad5a06f2 BM	295
ad5a06f2 BM	296	#define ACPI_ACTUAL_DEBUG(level, line, filename, modulename, component, ...) \
6e1888fd BM	297	ACPI_DO_DEBUG_PRINT (acpi_debug_print, level, line, \
6e1888fd BM	298	filename, modulename, component, __VA_ARGS__)
ad5a06f2 BM	299
ad5a06f2 BM	300	#define ACPI_ACTUAL_DEBUG_RAW(level, line, filename, modulename, component, ...) \
6e1888fd BM	301	ACPI_DO_DEBUG_PRINT (acpi_debug_print_raw, level, line, \
6e1888fd BM	302	filename, modulename, component, __VA_ARGS__)
50df4d8b	303
7b09d8fd LZ	304	#define ACPI_DEBUG_PRINT(plist) ACPI_ACTUAL_DEBUG plist
	305	#define ACPI_DEBUG_PRINT_RAW(plist) ACPI_ACTUAL_DEBUG_RAW plist
	306
	307	#endif
	308
0377b5ac BM	309	/*
	310	* Function entry tracing
	311	*
	312	* The name of the function is emitted as a local variable that is
	313	* intended to be used by both the entry trace and the exit trace.
	314	*/
	315
	316	/* Helper macro */
	317
fd1af712	318	#define ACPI_TRACE_ENTRY(name, function, type, param) \
0377b5ac	319	ACPI_FUNCTION_NAME (name) \
fd1af712	320	function (ACPI_DEBUG_PARAMETERS, (type) (param))
0377b5ac BM	321
	322	/* The actual entry trace macros */
	323
	324	#define ACPI_FUNCTION_TRACE(name) \
	325	ACPI_FUNCTION_NAME(name) \
	326	acpi_ut_trace (ACPI_DEBUG_PARAMETERS)
	327
	328	#define ACPI_FUNCTION_TRACE_PTR(name, pointer) \
fd1af712	329	ACPI_TRACE_ENTRY (name, acpi_ut_trace_ptr, void *, pointer)
0377b5ac BM	330
0377b5ac BM	331	#define ACPI_FUNCTION_TRACE_U32(name, value) \
fd1af712	332	ACPI_TRACE_ENTRY (name, acpi_ut_trace_u32, u32, value)
0377b5ac BM	333
0377b5ac BM	334	#define ACPI_FUNCTION_TRACE_STR(name, string) \
4857a94d	335	ACPI_TRACE_ENTRY (name, acpi_ut_trace_str, const char *, string)
0377b5ac BM	336
	337	#define ACPI_FUNCTION_ENTRY() \
	338	acpi_ut_track_stack_ptr()
	339
	340	/*
	341	* Function exit tracing
	342	*
	343	* These macros include a return statement. This is usually considered
	344	* bad form, but having a separate exit macro before the actual return
	345	* is very ugly and difficult to maintain.
	346	*
	347	* One of the FUNCTION_TRACE macros above must be used in conjunction
	348	* with these macros so that "_AcpiFunctionName" is defined.
fd1af712 BM	349	*
	350	* There are two versions of most of the return macros. The default version is
	351	* safer, since it avoids side-effects by guaranteeing that the argument will
	352	* not be evaluated twice.
	353	*
	354	* A less-safe version of the macros is provided for optional use if the
	355	* compiler uses excessive CPU stack (for example, this may happen in the
	356	* debug case if code optimzation is disabled.)
0377b5ac	357	*/
0377b5ac BM	358
	359	/* Exit trace helper macro */
	360
fd1af712 BM	361	#ifndef ACPI_SIMPLE_RETURN_MACROS
	362
	363	#define ACPI_TRACE_EXIT(function, type, param) \
	364	ACPI_DO_WHILE0 ({ \
	365	register type _param = (type) (param); \
	366	function (ACPI_DEBUG_PARAMETERS, _param); \
	367	return (_param); \
	368	})
	369
	370	#else /* Use original less-safe macros */
	371
	372	#define ACPI_TRACE_EXIT(function, type, param) \
0377b5ac	373	ACPI_DO_WHILE0 ({ \
fd1af712 BM	374	function (ACPI_DEBUG_PARAMETERS, (type) (param)); \
fd1af712 BM	375	return (param); \
0377b5ac BM	376	})
0377b5ac BM	377
fd1af712 BM	378	#endif /* ACPI_SIMPLE_RETURN_MACROS */
fd1af712 BM	379
0377b5ac BM	380	/* The actual exit macros */
	381
	382	#define return_VOID \
	383	ACPI_DO_WHILE0 ({ \
	384	acpi_ut_exit (ACPI_DEBUG_PARAMETERS); \
	385	return; \
	386	})
	387
	388	#define return_ACPI_STATUS(status) \
fd1af712	389	ACPI_TRACE_EXIT (acpi_ut_status_exit, acpi_status, status)
0377b5ac BM	390
0377b5ac BM	391	#define return_PTR(pointer) \
fd1af712	392	ACPI_TRACE_EXIT (acpi_ut_ptr_exit, void *, pointer)
0377b5ac	393
4857a94d JK	394	#define return_STR(string) \
	395	ACPI_TRACE_EXIT (acpi_ut_str_exit, const char *, string)
	396
0377b5ac	397	#define return_VALUE(value) \
fd1af712 BM	398	ACPI_TRACE_EXIT (acpi_ut_value_exit, u64, value)
	399
	400	#define return_UINT32(value) \
	401	ACPI_TRACE_EXIT (acpi_ut_value_exit, u32, value)
	402
	403	#define return_UINT8(value) \
	404	ACPI_TRACE_EXIT (acpi_ut_value_exit, u8, value)
0377b5ac BM	405
	406	/* Conditional execution */
	407
	408	#define ACPI_DEBUG_EXEC(a) a
	409	#define ACPI_DEBUG_ONLY_MEMBERS(a) a;
	410	#define _VERBOSE_STRUCTURES
	411
	412	/* Various object display routines for debug */
	413
	414	#define ACPI_DUMP_STACK_ENTRY(a) acpi_ex_dump_operand((a), 0)
	415	#define ACPI_DUMP_OPERANDS(a, b ,c) acpi_ex_dump_operands(a, b, c)
	416	#define ACPI_DUMP_ENTRY(a, b) acpi_ns_dump_entry (a, b)
	417	#define ACPI_DUMP_PATHNAME(a, b, c, d) acpi_ns_dump_pathname(a, b, c, d)
	418	#define ACPI_DUMP_BUFFER(a, b) acpi_ut_debug_dump_buffer((u8 *) a, b, DB_BYTE_DISPLAY, _COMPONENT)
	419
bab04824 LZ	420	#define ACPI_TRACE_POINT(a, b, c, d) acpi_trace_point (a, b, c, d)
bab04824 LZ	421
0377b5ac	422	#else /* ACPI_DEBUG_OUTPUT */
50df4d8b BM	423	/*
	424	* This is the non-debug case -- make everything go away,
	425	* leaving no executable debug code!
	426	*/
50df4d8b BM	427	#define ACPI_DEBUG_PRINT(pl)
50df4d8b BM	428	#define ACPI_DEBUG_PRINT_RAW(pl)
0377b5ac BM	429	#define ACPI_DEBUG_EXEC(a)
0377b5ac BM	430	#define ACPI_DEBUG_ONLY_MEMBERS(a)
d835e7f4	431	#define ACPI_FUNCTION_NAME(a)
0377b5ac BM	432	#define ACPI_FUNCTION_TRACE(a)
	433	#define ACPI_FUNCTION_TRACE_PTR(a, b)
	434	#define ACPI_FUNCTION_TRACE_U32(a, b)
	435	#define ACPI_FUNCTION_TRACE_STR(a, b)
0377b5ac BM	436	#define ACPI_FUNCTION_ENTRY()
	437	#define ACPI_DUMP_STACK_ENTRY(a)
	438	#define ACPI_DUMP_OPERANDS(a, b, c)
	439	#define ACPI_DUMP_ENTRY(a, b)
0377b5ac BM	440	#define ACPI_DUMP_PATHNAME(a, b, c, d)
0377b5ac BM	441	#define ACPI_DUMP_BUFFER(a, b)
e81a52b8	442	#define ACPI_IS_DEBUG_ENABLED(level, component) 0
bab04824	443	#define ACPI_TRACE_POINT(a, b, c, d)
0377b5ac BM	444
	445	/* Return macros must have a return statement at the minimum */
	446
	447	#define return_VOID return
	448	#define return_ACPI_STATUS(s) return(s)
0377b5ac	449	#define return_PTR(s) return(s)
4857a94d	450	#define return_STR(s) return(s)
fd1af712 BM	451	#define return_VALUE(s) return(s)
	452	#define return_UINT8(s) return(s)
	453	#define return_UINT32(s) return(s)
50df4d8b BM	454
	455	#endif /* ACPI_DEBUG_OUTPUT */
	456
4be44fcd	457	#endif /* __ACOUTPUT_H__ */