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