]> err.no Git - linux-2.6/blob - include/acpi/acglobal.h
ACPICA: Update comments for individual table fields
[linux-2.6] / include / acpi / acglobal.h
1 /******************************************************************************
2  *
3  * Name: acglobal.h - Declarations for global variables
4  *
5  *****************************************************************************/
6
7 /*
8  * Copyright (C) 2000 - 2006, R. Byron Moore
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 __ACGLOBAL_H__
45 #define __ACGLOBAL_H__
46
47 /*
48  * Ensure that the globals are actually defined and initialized only once.
49  *
50  * The use of these macros allows a single list of globals (here) in order
51  * to simplify maintenance of the code.
52  */
53 #ifdef DEFINE_ACPI_GLOBALS
54 #define ACPI_EXTERN
55 #define ACPI_INIT_GLOBAL(a,b) a=b
56 #else
57 #define ACPI_EXTERN extern
58 #define ACPI_INIT_GLOBAL(a,b) a
59 #endif
60
61 /*
62  * Keep local copies of these FADT-based registers.  NOTE: These globals
63  * are first in this file for alignment reasons on 64-bit systems.
64  */
65 ACPI_EXTERN struct acpi_generic_address acpi_gbl_xpm1a_enable;
66 ACPI_EXTERN struct acpi_generic_address acpi_gbl_xpm1b_enable;
67
68 /*****************************************************************************
69  *
70  * Debug support
71  *
72  ****************************************************************************/
73
74 /* Runtime configuration of debug print levels */
75
76 extern u32 acpi_dbg_level;
77 extern u32 acpi_dbg_layer;
78
79 /* Procedure nesting level for debug output */
80
81 extern u32 acpi_gbl_nesting_level;
82
83 /* Support for dynamic control method tracing mechanism */
84
85 ACPI_EXTERN u32 acpi_gbl_original_dbg_level;
86 ACPI_EXTERN u32 acpi_gbl_original_dbg_layer;
87 ACPI_EXTERN acpi_name acpi_gbl_trace_method_name;
88 ACPI_EXTERN u32 acpi_gbl_trace_dbg_level;
89 ACPI_EXTERN u32 acpi_gbl_trace_dbg_layer;
90 ACPI_EXTERN u32 acpi_gbl_trace_flags;
91
92 /*****************************************************************************
93  *
94  * Runtime configuration (static defaults that can be overriden at runtime)
95  *
96  ****************************************************************************/
97
98 /*
99  * Enable "slack" in the AML interpreter?  Default is FALSE, and the
100  * interpreter strictly follows the ACPI specification.  Setting to TRUE
101  * allows the interpreter to ignore certain errors and/or bad AML constructs.
102  *
103  * Currently, these features are enabled by this flag:
104  *
105  * 1) Allow "implicit return" of last value in a control method
106  * 2) Allow access beyond the end of an operation region
107  * 3) Allow access to uninitialized locals/args (auto-init to integer 0)
108  * 4) Allow ANY object type to be a source operand for the Store() operator
109  * 5) Allow unresolved references (invalid target name) in package objects
110  * 6) Enable warning messages for behavior that is not ACPI spec compliant
111  */
112 ACPI_EXTERN u8 ACPI_INIT_GLOBAL(acpi_gbl_enable_interpreter_slack, FALSE);
113
114 /*
115  * Automatically serialize ALL control methods? Default is FALSE, meaning
116  * to use the Serialized/not_serialized method flags on a per method basis.
117  * Only change this if the ASL code is poorly written and cannot handle
118  * reentrancy even though methods are marked "NotSerialized".
119  */
120 ACPI_EXTERN u8 ACPI_INIT_GLOBAL(acpi_gbl_all_methods_serialized, FALSE);
121
122 /*
123  * Create the predefined _OSI method in the namespace? Default is TRUE
124  * because ACPI CA is fully compatible with other ACPI implementations.
125  * Changing this will revert ACPI CA (and machine ASL) to pre-OSI behavior.
126  */
127 ACPI_EXTERN u8 ACPI_INIT_GLOBAL(acpi_gbl_create_osi_method, TRUE);
128
129 /*
130  * Disable wakeup GPEs during runtime? Default is TRUE because WAKE and
131  * RUNTIME GPEs should never be shared, and WAKE GPEs should typically only
132  * be enabled just before going to sleep.
133  */
134 ACPI_EXTERN u8 ACPI_INIT_GLOBAL(acpi_gbl_leave_wake_gpes_disabled, TRUE);
135
136 /*****************************************************************************
137  *
138  * ACPI Table globals
139  *
140  ****************************************************************************/
141
142 /*
143  * acpi_gbl_root_table_list is the master list of ACPI tables found in the
144  * RSDT/XSDT.
145  *
146  * acpi_gbl_FADT is a local copy of the FADT, converted to a common format.
147  */
148 ACPI_EXTERN struct acpi_internal_rsdt acpi_gbl_root_table_list;
149 ACPI_EXTERN struct acpi_table_fadt acpi_gbl_FADT;
150
151 /*
152  * Handle both ACPI 1.0 and ACPI 2.0 Integer widths. The integer width is
153  * determined by the revision of the DSDT: If the DSDT revision is less than
154  * 2, use only the lower 32 bits of the internal 64-bit Integer.
155  */
156 ACPI_EXTERN u8 acpi_gbl_integer_bit_width;
157 ACPI_EXTERN u8 acpi_gbl_integer_byte_width;
158 ACPI_EXTERN u8 acpi_gbl_integer_nybble_width;
159
160 /*****************************************************************************
161  *
162  * Mutual exlusion within ACPICA subsystem
163  *
164  ****************************************************************************/
165
166 /*
167  * Predefined mutex objects. This array contains the
168  * actual OS mutex handles, indexed by the local ACPI_MUTEX_HANDLEs.
169  * (The table maps local handles to the real OS handles)
170  */
171 ACPI_EXTERN struct acpi_mutex_info acpi_gbl_mutex_info[ACPI_NUM_MUTEX];
172
173 /*
174  * Global lock semaphore works in conjunction with the actual HW global lock
175  */
176 ACPI_EXTERN acpi_mutex acpi_gbl_global_lock_mutex;
177 ACPI_EXTERN acpi_semaphore acpi_gbl_global_lock_semaphore;
178
179 /*
180  * Spinlocks are used for interfaces that can be possibly called at
181  * interrupt level
182  */
183 ACPI_EXTERN spinlock_t _acpi_gbl_gpe_lock;      /* For GPE data structs and registers */
184 ACPI_EXTERN spinlock_t _acpi_gbl_hardware_lock; /* For ACPI H/W except GPE registers */
185 #define acpi_gbl_gpe_lock       &_acpi_gbl_gpe_lock
186 #define acpi_gbl_hardware_lock  &_acpi_gbl_hardware_lock
187
188 /*****************************************************************************
189  *
190  * Miscellaneous globals
191  *
192  ****************************************************************************/
193
194 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
195
196 /* Lists for tracking memory allocations */
197
198 ACPI_EXTERN struct acpi_memory_list *acpi_gbl_global_list;
199 ACPI_EXTERN struct acpi_memory_list *acpi_gbl_ns_node_list;
200 #endif
201
202 /* Object caches */
203
204 ACPI_EXTERN acpi_cache_t *acpi_gbl_namespace_cache;
205 ACPI_EXTERN acpi_cache_t *acpi_gbl_state_cache;
206 ACPI_EXTERN acpi_cache_t *acpi_gbl_ps_node_cache;
207 ACPI_EXTERN acpi_cache_t *acpi_gbl_ps_node_ext_cache;
208 ACPI_EXTERN acpi_cache_t *acpi_gbl_operand_cache;
209
210 /* Global handlers */
211
212 ACPI_EXTERN struct acpi_object_notify_handler acpi_gbl_device_notify;
213 ACPI_EXTERN struct acpi_object_notify_handler acpi_gbl_system_notify;
214 ACPI_EXTERN acpi_exception_handler acpi_gbl_exception_handler;
215 ACPI_EXTERN acpi_init_handler acpi_gbl_init_handler;
216 ACPI_EXTERN struct acpi_walk_state *acpi_gbl_breakpoint_walk;
217
218 /* Misc */
219
220 ACPI_EXTERN u32 acpi_gbl_original_mode;
221 ACPI_EXTERN u32 acpi_gbl_rsdp_original_location;
222 ACPI_EXTERN u32 acpi_gbl_ns_lookup_count;
223 ACPI_EXTERN u32 acpi_gbl_ps_find_count;
224 ACPI_EXTERN u32 acpi_gbl_owner_id_mask[ACPI_NUM_OWNERID_MASKS];
225 ACPI_EXTERN u16 acpi_gbl_pm1_enable_register_save;
226 ACPI_EXTERN u16 acpi_gbl_global_lock_handle;
227 ACPI_EXTERN u8 acpi_gbl_last_owner_id_index;
228 ACPI_EXTERN u8 acpi_gbl_next_owner_id_offset;
229 ACPI_EXTERN u8 acpi_gbl_debugger_configuration;
230 ACPI_EXTERN u8 acpi_gbl_global_lock_acquired;
231 ACPI_EXTERN u8 acpi_gbl_step_to_next_call;
232 ACPI_EXTERN u8 acpi_gbl_acpi_hardware_present;
233 ACPI_EXTERN u8 acpi_gbl_global_lock_present;
234 ACPI_EXTERN u8 acpi_gbl_events_initialized;
235 ACPI_EXTERN u8 acpi_gbl_system_awake_and_running;
236
237 extern u8 acpi_gbl_shutdown;
238 extern u32 acpi_gbl_startup_flags;
239 extern const u8 acpi_gbl_decode_to8bit[8];
240 extern const char *acpi_gbl_sleep_state_names[ACPI_S_STATE_COUNT];
241 extern const char *acpi_gbl_highest_dstate_names[4];
242 extern const struct acpi_opcode_info acpi_gbl_aml_op_info[AML_NUM_OPCODES];
243 extern const char *acpi_gbl_region_types[ACPI_NUM_PREDEFINED_REGIONS];
244
245 /*****************************************************************************
246  *
247  * Namespace globals
248  *
249  ****************************************************************************/
250
251 #define NUM_NS_TYPES                    ACPI_TYPE_INVALID+1
252
253 #if !defined (ACPI_NO_METHOD_EXECUTION) || defined (ACPI_CONSTANT_EVAL_ONLY)
254 #define NUM_PREDEFINED_NAMES            10
255 #else
256 #define NUM_PREDEFINED_NAMES            9
257 #endif
258
259 ACPI_EXTERN struct acpi_namespace_node acpi_gbl_root_node_struct;
260 ACPI_EXTERN struct acpi_namespace_node *acpi_gbl_root_node;
261 ACPI_EXTERN struct acpi_namespace_node *acpi_gbl_fadt_gpe_device;
262
263 extern const u8 acpi_gbl_ns_properties[NUM_NS_TYPES];
264 extern const struct acpi_predefined_names
265     acpi_gbl_pre_defined_names[NUM_PREDEFINED_NAMES];
266
267 #ifdef ACPI_DEBUG_OUTPUT
268 ACPI_EXTERN u32 acpi_gbl_current_node_count;
269 ACPI_EXTERN u32 acpi_gbl_current_node_size;
270 ACPI_EXTERN u32 acpi_gbl_max_concurrent_node_count;
271 ACPI_EXTERN acpi_size acpi_gbl_entry_stack_pointer;
272 ACPI_EXTERN acpi_size acpi_gbl_lowest_stack_pointer;
273 ACPI_EXTERN u32 acpi_gbl_deepest_nesting;
274 #endif
275
276 /*****************************************************************************
277  *
278  * Interpreter globals
279  *
280  ****************************************************************************/
281
282 ACPI_EXTERN struct acpi_thread_state *acpi_gbl_current_walk_list;
283
284 /* Control method single step flag */
285
286 ACPI_EXTERN u8 acpi_gbl_cm_single_step;
287
288 /*****************************************************************************
289  *
290  * Hardware globals
291  *
292  ****************************************************************************/
293
294 extern struct acpi_bit_register_info
295     acpi_gbl_bit_register_info[ACPI_NUM_BITREG];
296 ACPI_EXTERN u8 acpi_gbl_sleep_type_a;
297 ACPI_EXTERN u8 acpi_gbl_sleep_type_b;
298
299 /*****************************************************************************
300  *
301  * Event and GPE globals
302  *
303  ****************************************************************************/
304
305 extern struct acpi_fixed_event_info
306     acpi_gbl_fixed_event_info[ACPI_NUM_FIXED_EVENTS];
307 ACPI_EXTERN struct acpi_fixed_event_handler
308     acpi_gbl_fixed_event_handlers[ACPI_NUM_FIXED_EVENTS];
309 ACPI_EXTERN struct acpi_gpe_xrupt_info *acpi_gbl_gpe_xrupt_list_head;
310 ACPI_EXTERN struct acpi_gpe_block_info
311     *acpi_gbl_gpe_fadt_blocks[ACPI_MAX_GPE_BLOCKS];
312
313 /*****************************************************************************
314  *
315  * Debugger globals
316  *
317  ****************************************************************************/
318
319 ACPI_EXTERN u8 acpi_gbl_db_output_flags;
320
321 #ifdef ACPI_DISASSEMBLER
322
323 ACPI_EXTERN u8 acpi_gbl_db_opt_disasm;
324 ACPI_EXTERN u8 acpi_gbl_db_opt_verbose;
325 #endif
326
327 #ifdef ACPI_DEBUGGER
328
329 extern u8 acpi_gbl_method_executing;
330 extern u8 acpi_gbl_abort_method;
331 extern u8 acpi_gbl_db_terminate_threads;
332
333 ACPI_EXTERN int optind;
334 ACPI_EXTERN char *optarg;
335
336 ACPI_EXTERN u8 acpi_gbl_db_opt_tables;
337 ACPI_EXTERN u8 acpi_gbl_db_opt_stats;
338 ACPI_EXTERN u8 acpi_gbl_db_opt_ini_methods;
339
340 ACPI_EXTERN char *acpi_gbl_db_args[ACPI_DEBUGGER_MAX_ARGS];
341 ACPI_EXTERN char acpi_gbl_db_line_buf[80];
342 ACPI_EXTERN char acpi_gbl_db_parsed_buf[80];
343 ACPI_EXTERN char acpi_gbl_db_scope_buf[40];
344 ACPI_EXTERN char acpi_gbl_db_debug_filename[40];
345 ACPI_EXTERN u8 acpi_gbl_db_output_to_file;
346 ACPI_EXTERN char *acpi_gbl_db_buffer;
347 ACPI_EXTERN char *acpi_gbl_db_filename;
348 ACPI_EXTERN u32 acpi_gbl_db_debug_level;
349 ACPI_EXTERN u32 acpi_gbl_db_console_debug_level;
350 ACPI_EXTERN struct acpi_table_header *acpi_gbl_db_table_ptr;
351 ACPI_EXTERN struct acpi_namespace_node *acpi_gbl_db_scope_node;
352
353 /*
354  * Statistic globals
355  */
356 ACPI_EXTERN u16 acpi_gbl_obj_type_count[ACPI_TYPE_NS_NODE_MAX + 1];
357 ACPI_EXTERN u16 acpi_gbl_node_type_count[ACPI_TYPE_NS_NODE_MAX + 1];
358 ACPI_EXTERN u16 acpi_gbl_obj_type_count_misc;
359 ACPI_EXTERN u16 acpi_gbl_node_type_count_misc;
360 ACPI_EXTERN u32 acpi_gbl_num_nodes;
361 ACPI_EXTERN u32 acpi_gbl_num_objects;
362
363 ACPI_EXTERN u32 acpi_gbl_size_of_parse_tree;
364 ACPI_EXTERN u32 acpi_gbl_size_of_method_trees;
365 ACPI_EXTERN u32 acpi_gbl_size_of_node_entries;
366 ACPI_EXTERN u32 acpi_gbl_size_of_acpi_objects;
367
368 #endif                          /* ACPI_DEBUGGER */
369
370 #endif                          /* __ACGLOBAL_H__ */