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

/******************************************************************************
 *
 * Name: acoutput.h -- debug output
 *
 *****************************************************************************/

/*
 * Copyright (C) 2000 - 2015, Intel Corp.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions, and the following disclaimer,
 *    without modification.
 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 *    substantially similar to the "NO WARRANTY" disclaimer below
 *    ("Disclaimer") and any redistribution must be conditioned upon
 *    including a substantially similar Disclaimer requirement for further
 *    binary redistribution.
 * 3. Neither the names of the above-listed copyright holders nor the names
 *    of any contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * NO WARRANTY
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGES.
 */

#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_ALL_EXCEPTIONS      0x0000000F

/* 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_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)

#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 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, 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_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)

#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

/* 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_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
1da177e4 LT	1	/******************************************************************************
	2	*
	3	* Name: acoutput.h -- debug output
	4	*
	5	*****************************************************************************/
	6
	7	/*
82a80941	8	* Copyright (C) 2000 - 2015, Intel Corp.
1da177e4 LT	9	* 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	/*
50df4d8b BM	48	* 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.
1da177e4 LT	51	*/
1da177e4 LT	52
b229cf92	53	/* Component IDs are used in the global "DebugLayer" */
1da177e4 LT	54
	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
50df4d8b BM	72	#define ACPI_EXAMPLE 0x00004000
50df4d8b BM	73	#define ACPI_DRIVER 0x00008000
ddcc6a03	74	#define DT_COMPILER 0x00010000
56324c10	75	#define ASL_PREPROCESSOR 0x00020000
1da177e4	76
ddcc6a03	77	#define ACPI_ALL_COMPONENTS 0x0001FFFF
1da177e4 LT	78	#define ACPI_COMPONENT_DEFAULT (ACPI_ALL_COMPONENTS)
1da177e4 LT	79
1da177e4 LT	80	/* Component IDs reserved for ACPI drivers */
	81
	82	#define ACPI_ALL_DRIVERS 0xFFFF0000
	83
1da177e4	84	/*
50df4d8b	85	* Raw debug output levels, do not use these in the ACPI_DEBUG_PRINT macros
1da177e4	86	*/
23d3e055 BM	87	#define ACPI_LV_INIT 0x00000001
	88	#define ACPI_LV_DEBUG_OBJECT 0x00000002
	89	#define ACPI_LV_INFO 0x00000004
3a58176e BM	90	#define ACPI_LV_REPAIR 0x00000008
3a58176e BM	91	#define ACPI_LV_ALL_EXCEPTIONS 0x0000000F
1da177e4 LT	92
	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
b229cf92	127	/* Exceptionally verbose output -- also used in the global "DebugLevel" */
1da177e4 LT	128
	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
1da177e4 LT	133	#define ACPI_LV_VERBOSE 0xF0000000
1da177e4 LT	134
1da177e4 LT	135	/*
	136	* Debug level macros that are used in the DEBUG_PRINT macros
	137	*/
f9f4601f	138	#define ACPI_DEBUG_LEVEL(dl) (u32) dl,ACPI_DEBUG_PARAMETERS
1da177e4	139
23d3e055 BM	140	/*
	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	*/
1da177e4 LT	146	#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)
3a58176e	149	#define ACPI_DB_REPAIR ACPI_DEBUG_LEVEL (ACPI_LV_REPAIR)
1da177e4 LT	150	#define ACPI_DB_ALL_EXCEPTIONS ACPI_DEBUG_LEVEL (ACPI_LV_ALL_EXCEPTIONS)
1da177e4 LT	151
b229cf92	152	/* Trace level -- also used in the global "DebugLevel" */
1da177e4 LT	153
	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)
23d3e055	175	#define ACPI_DB_EVENTS ACPI_DEBUG_LEVEL (ACPI_LV_EVENTS)
1da177e4 LT	176
	177	#define ACPI_DB_ALL ACPI_DEBUG_LEVEL (ACPI_LV_ALL)
	178
1da177e4 LT	179	/* Defaults for debug_level, debug and normal */
1da177e4 LT	180
3a58176e BM	181	#define ACPI_DEBUG_DEFAULT (ACPI_LV_INFO \| ACPI_LV_REPAIR)
3a58176e BM	182	#define ACPI_NORMAL_DEFAULT (ACPI_LV_INIT \| ACPI_LV_DEBUG_OBJECT \| ACPI_LV_REPAIR)
1da177e4 LT	183	#define ACPI_DEBUG_ALL (ACPI_LV_AML_DISASSEMBLE \| ACPI_LV_ALL_EXCEPTIONS \| ACPI_LV_ALL)
1da177e4 LT	184
50df4d8b BM	185	#if defined (ACPI_DEBUG_OUTPUT) \|\| !defined (ACPI_NO_ERROR_MESSAGES)
50df4d8b BM	186	/*
d59a3c6b BM	187	* 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.
50df4d8b BM	191	*/
	192	#define ACPI_MODULE_NAME(name) static const char ACPI_UNUSED_VAR _acpi_module_name[] = name;
	193	#else
d59a3c6b BM	194	/*
	195	* For the no-debug and no-error-msg cases, we must at least define
	196	* a null module name.
	197	*/
50df4d8b	198	#define ACPI_MODULE_NAME(name)
d59a3c6b	199	#define _acpi_module_name ""
50df4d8b BM	200	#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
62cdd141 BM	217	#define ACPI_BIOS_WARNING(plist) acpi_bios_warning plist
62cdd141 BM	218	#define ACPI_BIOS_ERROR(plist) acpi_bios_error plist
4cdf1a56	219	#define ACPI_DEBUG_OBJECT(obj,l,i) acpi_ex_do_debug_object(obj,l,i)
50df4d8b BM	220
	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)
62cdd141 BM	229	#define ACPI_BIOS_WARNING(plist)
62cdd141 BM	230	#define ACPI_BIOS_ERROR(plist)
4cdf1a56	231	#define ACPI_DEBUG_OBJECT(obj,l,i)
50df4d8b BM	232
	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
02f1f217	243	* a __func__ macro or equivalent.
50df4d8b BM	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
02f1f217	252	* and macros such as __func__.
50df4d8b BM	253	*/
	254	#define ACPI_FUNCTION_NAME(name) static const char _acpi_function_name[] = #name;
	255
	256	#else
02f1f217	257	/* Compiler supports __func__ (or equivalent) -- Ignore this macro */
50df4d8b BM	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	*/
ad5a06f2 BM	266	#define ACPI_DEBUG_PARAMETERS \
ad5a06f2 BM	267	__LINE__, ACPI_GET_FUNCTION_NAME, _acpi_module_name, _COMPONENT
50df4d8b	268
e81a52b8 BM	269	/* 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
50df4d8b BM	274	/*
	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
ad5a06f2 BM	279	*
	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.
6e1888fd BM	284	*
	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.
50df4d8b	288	*/
6e1888fd BM	289	#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
ad5a06f2 BM	294
	295	/* DEBUG_PRINT functions */
	296
7b09d8fd LZ	297	#ifndef COMPILER_VA_MACRO
	298
	299	#define ACPI_DEBUG_PRINT(plist) acpi_debug_print plist
	300	#define ACPI_DEBUG_PRINT_RAW(plist) acpi_debug_print_raw plist
	301
	302	#else
ad5a06f2 BM	303
	304	/* Helper macros for DEBUG_PRINT */
	305
6e1888fd BM	306	#define ACPI_DO_DEBUG_PRINT(function, level, line, filename, modulename, component, ...) \
	307	ACPI_DO_WHILE0 ({ \
	308	if (ACPI_IS_DEBUG_ENABLED (level, component)) \
	309	{ \
	310	function (level, line, filename, modulename, component, __VA_ARGS__); \
	311	} \
	312	})
ad5a06f2 BM	313
ad5a06f2 BM	314	#define ACPI_ACTUAL_DEBUG(level, line, filename, modulename, component, ...) \
6e1888fd BM	315	ACPI_DO_DEBUG_PRINT (acpi_debug_print, level, line, \
6e1888fd BM	316	filename, modulename, component, __VA_ARGS__)
ad5a06f2 BM	317
ad5a06f2 BM	318	#define ACPI_ACTUAL_DEBUG_RAW(level, line, filename, modulename, component, ...) \
6e1888fd BM	319	ACPI_DO_DEBUG_PRINT (acpi_debug_print_raw, level, line, \
6e1888fd BM	320	filename, modulename, component, __VA_ARGS__)
50df4d8b	321
7b09d8fd LZ	322	#define ACPI_DEBUG_PRINT(plist) ACPI_ACTUAL_DEBUG plist
	323	#define ACPI_DEBUG_PRINT_RAW(plist) ACPI_ACTUAL_DEBUG_RAW plist
	324
	325	#endif
	326
0377b5ac BM	327	/*
	328	* Function entry tracing
	329	*
	330	* The name of the function is emitted as a local variable that is
	331	* intended to be used by both the entry trace and the exit trace.
	332	*/
	333
	334	/* Helper macro */
	335
fd1af712	336	#define ACPI_TRACE_ENTRY(name, function, type, param) \
0377b5ac	337	ACPI_FUNCTION_NAME (name) \
fd1af712	338	function (ACPI_DEBUG_PARAMETERS, (type) (param))
0377b5ac BM	339
	340	/* The actual entry trace macros */
	341
	342	#define ACPI_FUNCTION_TRACE(name) \
	343	ACPI_FUNCTION_NAME(name) \
	344	acpi_ut_trace (ACPI_DEBUG_PARAMETERS)
	345
	346	#define ACPI_FUNCTION_TRACE_PTR(name, pointer) \
fd1af712	347	ACPI_TRACE_ENTRY (name, acpi_ut_trace_ptr, void *, pointer)
0377b5ac BM	348
0377b5ac BM	349	#define ACPI_FUNCTION_TRACE_U32(name, value) \
fd1af712	350	ACPI_TRACE_ENTRY (name, acpi_ut_trace_u32, u32, value)
0377b5ac BM	351
0377b5ac BM	352	#define ACPI_FUNCTION_TRACE_STR(name, string) \
fd1af712	353	ACPI_TRACE_ENTRY (name, acpi_ut_trace_str, char *, string)
0377b5ac BM	354
	355	#define ACPI_FUNCTION_ENTRY() \
	356	acpi_ut_track_stack_ptr()
	357
	358	/*
	359	* Function exit tracing
	360	*
	361	* These macros include a return statement. This is usually considered
	362	* bad form, but having a separate exit macro before the actual return
	363	* is very ugly and difficult to maintain.
	364	*
	365	* One of the FUNCTION_TRACE macros above must be used in conjunction
	366	* with these macros so that "_AcpiFunctionName" is defined.
fd1af712 BM	367	*
	368	* There are two versions of most of the return macros. The default version is
	369	* safer, since it avoids side-effects by guaranteeing that the argument will
	370	* not be evaluated twice.
	371	*
	372	* A less-safe version of the macros is provided for optional use if the
	373	* compiler uses excessive CPU stack (for example, this may happen in the
	374	* debug case if code optimzation is disabled.)
0377b5ac	375	*/
0377b5ac BM	376
	377	/* Exit trace helper macro */
	378
fd1af712 BM	379	#ifndef ACPI_SIMPLE_RETURN_MACROS
	380
	381	#define ACPI_TRACE_EXIT(function, type, param) \
	382	ACPI_DO_WHILE0 ({ \
	383	register type _param = (type) (param); \
	384	function (ACPI_DEBUG_PARAMETERS, _param); \
	385	return (_param); \
	386	})
	387
	388	#else /* Use original less-safe macros */
	389
	390	#define ACPI_TRACE_EXIT(function, type, param) \
0377b5ac	391	ACPI_DO_WHILE0 ({ \
fd1af712 BM	392	function (ACPI_DEBUG_PARAMETERS, (type) (param)); \
fd1af712 BM	393	return (param); \
0377b5ac BM	394	})
0377b5ac BM	395
fd1af712 BM	396	#endif /* ACPI_SIMPLE_RETURN_MACROS */
fd1af712 BM	397
0377b5ac BM	398	/* The actual exit macros */
	399
	400	#define return_VOID \
	401	ACPI_DO_WHILE0 ({ \
	402	acpi_ut_exit (ACPI_DEBUG_PARAMETERS); \
	403	return; \
	404	})
	405
	406	#define return_ACPI_STATUS(status) \
fd1af712	407	ACPI_TRACE_EXIT (acpi_ut_status_exit, acpi_status, status)
0377b5ac BM	408
0377b5ac BM	409	#define return_PTR(pointer) \
fd1af712	410	ACPI_TRACE_EXIT (acpi_ut_ptr_exit, void *, pointer)
0377b5ac BM	411
0377b5ac BM	412	#define return_VALUE(value) \
fd1af712 BM	413	ACPI_TRACE_EXIT (acpi_ut_value_exit, u64, value)
	414
	415	#define return_UINT32(value) \
	416	ACPI_TRACE_EXIT (acpi_ut_value_exit, u32, value)
	417
	418	#define return_UINT8(value) \
	419	ACPI_TRACE_EXIT (acpi_ut_value_exit, u8, value)
0377b5ac BM	420
	421	/* Conditional execution */
	422
	423	#define ACPI_DEBUG_EXEC(a) a
	424	#define ACPI_DEBUG_ONLY_MEMBERS(a) a;
	425	#define _VERBOSE_STRUCTURES
	426
	427	/* Various object display routines for debug */
	428
	429	#define ACPI_DUMP_STACK_ENTRY(a) acpi_ex_dump_operand((a), 0)
	430	#define ACPI_DUMP_OPERANDS(a, b ,c) acpi_ex_dump_operands(a, b, c)
	431	#define ACPI_DUMP_ENTRY(a, b) acpi_ns_dump_entry (a, b)
	432	#define ACPI_DUMP_PATHNAME(a, b, c, d) acpi_ns_dump_pathname(a, b, c, d)
	433	#define ACPI_DUMP_BUFFER(a, b) acpi_ut_debug_dump_buffer((u8 *) a, b, DB_BYTE_DISPLAY, _COMPONENT)
	434
	435	#else /* ACPI_DEBUG_OUTPUT */
50df4d8b BM	436	/*
	437	* This is the non-debug case -- make everything go away,
	438	* leaving no executable debug code!
	439	*/
50df4d8b BM	440	#define ACPI_DEBUG_PRINT(pl)
50df4d8b BM	441	#define ACPI_DEBUG_PRINT_RAW(pl)
0377b5ac BM	442	#define ACPI_DEBUG_EXEC(a)
0377b5ac BM	443	#define ACPI_DEBUG_ONLY_MEMBERS(a)
d835e7f4	444	#define ACPI_FUNCTION_NAME(a)
0377b5ac BM	445	#define ACPI_FUNCTION_TRACE(a)
	446	#define ACPI_FUNCTION_TRACE_PTR(a, b)
	447	#define ACPI_FUNCTION_TRACE_U32(a, b)
	448	#define ACPI_FUNCTION_TRACE_STR(a, b)
0377b5ac BM	449	#define ACPI_FUNCTION_ENTRY()
	450	#define ACPI_DUMP_STACK_ENTRY(a)
	451	#define ACPI_DUMP_OPERANDS(a, b, c)
	452	#define ACPI_DUMP_ENTRY(a, b)
0377b5ac BM	453	#define ACPI_DUMP_PATHNAME(a, b, c, d)
0377b5ac BM	454	#define ACPI_DUMP_BUFFER(a, b)
e81a52b8	455	#define ACPI_IS_DEBUG_ENABLED(level, component) 0
0377b5ac BM	456
	457	/* Return macros must have a return statement at the minimum */
	458
	459	#define return_VOID return
	460	#define return_ACPI_STATUS(s) return(s)
0377b5ac	461	#define return_PTR(s) return(s)
fd1af712 BM	462	#define return_VALUE(s) return(s)
	463	#define return_UINT8(s) return(s)
	464	#define return_UINT32(s) return(s)
50df4d8b BM	465
	466	#endif /* ACPI_DEBUG_OUTPUT */
	467
4be44fcd	468	#endif /* __ACOUTPUT_H__ */