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