]> Pileus Git - ~andy/linux/blob - drivers/acpi/acpica/acglobal.h
Merge git://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux
[~andy/linux] / drivers / acpi / acpica / acglobal.h
1 /******************************************************************************
2  *
3  * Name: acglobal.h - Declarations for global variables
4  *
5  *****************************************************************************/
6
7 /*
8  * Copyright (C) 2000 - 2013, 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  * Optionally use default values for the ACPI register widths. Set this to
104  * TRUE to use the defaults, if an FADT contains incorrect widths/lengths.
105  */
106 u8 ACPI_INIT_GLOBAL(acpi_gbl_use_default_register_widths, TRUE);
107
108 /*
109  * Optionally enable output from the AML Debug Object.
110  */
111 bool ACPI_INIT_GLOBAL(acpi_gbl_enable_aml_debug_object, FALSE);
112
113 /*
114  * Optionally copy the entire DSDT to local memory (instead of simply
115  * mapping it.) There are some BIOSs that corrupt or replace the original
116  * DSDT, creating the need for this option. Default is FALSE, do not copy
117  * the DSDT.
118  */
119 u8 ACPI_INIT_GLOBAL(acpi_gbl_copy_dsdt_locally, FALSE);
120
121 /*
122  * Optionally truncate I/O addresses to 16 bits. Provides compatibility
123  * with other ACPI implementations. NOTE: During ACPICA initialization,
124  * this value is set to TRUE if any Windows OSI strings have been
125  * requested by the BIOS.
126  */
127 u8 ACPI_INIT_GLOBAL(acpi_gbl_truncate_io_addresses, FALSE);
128
129 /*
130  * Disable runtime checking and repair of values returned by control methods.
131  * Use only if the repair is causing a problem on a particular machine.
132  */
133 u8 ACPI_INIT_GLOBAL(acpi_gbl_disable_auto_repair, FALSE);
134
135 /*
136  * Optionally do not load any SSDTs from the RSDT/XSDT during initialization.
137  * This can be useful for debugging ACPI problems on some machines.
138  */
139 u8 ACPI_INIT_GLOBAL(acpi_gbl_disable_ssdt_table_load, FALSE);
140
141 /* acpi_gbl_FADT is a local copy of the FADT, converted to a common format. */
142
143 struct acpi_table_fadt acpi_gbl_FADT;
144 u32 acpi_current_gpe_count;
145 u32 acpi_gbl_trace_flags;
146 acpi_name acpi_gbl_trace_method_name;
147 u8 acpi_gbl_system_awake_and_running;
148
149 /*
150  * ACPI 5.0 introduces the concept of a "reduced hardware platform", meaning
151  * that the ACPI hardware is no longer required. A flag in the FADT indicates
152  * a reduced HW machine, and that flag is duplicated here for convenience.
153  */
154 u8 acpi_gbl_reduced_hardware;
155
156 #endif                          /* DEFINE_ACPI_GLOBALS */
157
158 /* Do not disassemble buffers to resource descriptors */
159
160 ACPI_EXTERN u8 ACPI_INIT_GLOBAL(acpi_gbl_no_resource_disassembly, FALSE);
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
174 #if (!ACPI_REDUCED_HARDWARE)
175 ACPI_EXTERN struct acpi_table_facs *acpi_gbl_FACS;
176
177 #endif                          /* !ACPI_REDUCED_HARDWARE */
178
179 /* These addresses are calculated from the FADT Event Block addresses */
180
181 ACPI_EXTERN struct acpi_generic_address acpi_gbl_xpm1a_status;
182 ACPI_EXTERN struct acpi_generic_address acpi_gbl_xpm1a_enable;
183
184 ACPI_EXTERN struct acpi_generic_address acpi_gbl_xpm1b_status;
185 ACPI_EXTERN struct acpi_generic_address acpi_gbl_xpm1b_enable;
186
187 /* DSDT information. Used to check for DSDT corruption */
188
189 ACPI_EXTERN struct acpi_table_header *acpi_gbl_DSDT;
190 ACPI_EXTERN struct acpi_table_header acpi_gbl_original_dsdt_header;
191
192 /*
193  * Handle both ACPI 1.0 and ACPI 2.0 Integer widths. The integer width is
194  * determined by the revision of the DSDT: If the DSDT revision is less than
195  * 2, use only the lower 32 bits of the internal 64-bit Integer.
196  */
197 ACPI_EXTERN u8 acpi_gbl_integer_bit_width;
198 ACPI_EXTERN u8 acpi_gbl_integer_byte_width;
199 ACPI_EXTERN u8 acpi_gbl_integer_nybble_width;
200
201 /*****************************************************************************
202  *
203  * Mutual exclusion 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 actual global lock
217  * Global lock spinlock is used for "pending" handshake
218  */
219 ACPI_EXTERN union acpi_operand_object *acpi_gbl_global_lock_mutex;
220 ACPI_EXTERN acpi_semaphore acpi_gbl_global_lock_semaphore;
221 ACPI_EXTERN acpi_spinlock acpi_gbl_global_lock_pending_lock;
222 ACPI_EXTERN u16 acpi_gbl_global_lock_handle;
223 ACPI_EXTERN u8 acpi_gbl_global_lock_acquired;
224 ACPI_EXTERN u8 acpi_gbl_global_lock_present;
225 ACPI_EXTERN u8 acpi_gbl_global_lock_pending;
226
227 /*
228  * Spinlocks are used for interfaces that can be possibly called at
229  * interrupt level
230  */
231 ACPI_EXTERN acpi_spinlock acpi_gbl_gpe_lock;    /* For GPE data structs and registers */
232 ACPI_EXTERN acpi_spinlock acpi_gbl_hardware_lock;       /* For ACPI H/W except GPE registers */
233 ACPI_EXTERN acpi_spinlock acpi_gbl_reference_count_lock;
234
235 /* Mutex for _OSI support */
236
237 ACPI_EXTERN acpi_mutex acpi_gbl_osi_mutex;
238
239 /* Reader/Writer lock is used for namespace walk and dynamic table unload */
240
241 ACPI_EXTERN struct acpi_rw_lock acpi_gbl_namespace_rw_lock;
242
243 /*****************************************************************************
244  *
245  * Miscellaneous globals
246  *
247  ****************************************************************************/
248
249 /* Object caches */
250
251 ACPI_EXTERN acpi_cache_t *acpi_gbl_namespace_cache;
252 ACPI_EXTERN acpi_cache_t *acpi_gbl_state_cache;
253 ACPI_EXTERN acpi_cache_t *acpi_gbl_ps_node_cache;
254 ACPI_EXTERN acpi_cache_t *acpi_gbl_ps_node_ext_cache;
255 ACPI_EXTERN acpi_cache_t *acpi_gbl_operand_cache;
256
257 /* Global handlers */
258
259 ACPI_EXTERN struct acpi_global_notify_handler acpi_gbl_global_notify[2];
260 ACPI_EXTERN acpi_exception_handler acpi_gbl_exception_handler;
261 ACPI_EXTERN acpi_init_handler acpi_gbl_init_handler;
262 ACPI_EXTERN acpi_table_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 ACPI_EXTERN acpi_interface_handler acpi_gbl_interface_handler;
266
267 /* Owner ID support */
268
269 ACPI_EXTERN u32 acpi_gbl_owner_id_mask[ACPI_NUM_OWNERID_MASKS];
270 ACPI_EXTERN u8 acpi_gbl_last_owner_id_index;
271 ACPI_EXTERN u8 acpi_gbl_next_owner_id_offset;
272
273 /* Initialization sequencing */
274
275 ACPI_EXTERN u8 acpi_gbl_reg_methods_executed;
276
277 /* Misc */
278
279 ACPI_EXTERN u32 acpi_gbl_original_mode;
280 ACPI_EXTERN u32 acpi_gbl_rsdp_original_location;
281 ACPI_EXTERN u32 acpi_gbl_ns_lookup_count;
282 ACPI_EXTERN u32 acpi_gbl_ps_find_count;
283 ACPI_EXTERN u16 acpi_gbl_pm1_enable_register_save;
284 ACPI_EXTERN u8 acpi_gbl_debugger_configuration;
285 ACPI_EXTERN u8 acpi_gbl_step_to_next_call;
286 ACPI_EXTERN u8 acpi_gbl_acpi_hardware_present;
287 ACPI_EXTERN u8 acpi_gbl_events_initialized;
288 ACPI_EXTERN u8 acpi_gbl_osi_data;
289 ACPI_EXTERN struct acpi_interface_info *acpi_gbl_supported_interfaces;
290 ACPI_EXTERN struct acpi_address_range
291     *acpi_gbl_address_range_list[ACPI_ADDRESS_RANGE_MAX];
292
293 #ifndef DEFINE_ACPI_GLOBALS
294
295 /* Other miscellaneous */
296
297 extern u8 acpi_gbl_shutdown;
298 extern u32 acpi_gbl_startup_flags;
299 extern const char *acpi_gbl_sleep_state_names[ACPI_S_STATE_COUNT];
300 extern const char *acpi_gbl_lowest_dstate_names[ACPI_NUM_sx_w_METHODS];
301 extern const char *acpi_gbl_highest_dstate_names[ACPI_NUM_sx_d_METHODS];
302 extern const struct acpi_opcode_info acpi_gbl_aml_op_info[AML_NUM_OPCODES];
303 extern const char *acpi_gbl_region_types[ACPI_NUM_PREDEFINED_REGIONS];
304
305 #endif
306
307 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
308
309 /* Lists for tracking memory allocations */
310
311 ACPI_EXTERN struct acpi_memory_list *acpi_gbl_global_list;
312 ACPI_EXTERN struct acpi_memory_list *acpi_gbl_ns_node_list;
313 ACPI_EXTERN u8 acpi_gbl_display_final_mem_stats;
314 ACPI_EXTERN u8 acpi_gbl_disable_mem_tracking;
315 #endif
316
317 /*****************************************************************************
318  *
319  * Namespace globals
320  *
321  ****************************************************************************/
322
323 #if !defined (ACPI_NO_METHOD_EXECUTION) || defined (ACPI_CONSTANT_EVAL_ONLY)
324 #define NUM_PREDEFINED_NAMES            10
325 #else
326 #define NUM_PREDEFINED_NAMES            9
327 #endif
328
329 ACPI_EXTERN struct acpi_namespace_node acpi_gbl_root_node_struct;
330 ACPI_EXTERN struct acpi_namespace_node *acpi_gbl_root_node;
331 ACPI_EXTERN struct acpi_namespace_node *acpi_gbl_fadt_gpe_device;
332 ACPI_EXTERN union acpi_operand_object *acpi_gbl_module_code_list;
333
334 extern const u8 acpi_gbl_ns_properties[ACPI_NUM_NS_TYPES];
335 extern const struct acpi_predefined_names
336     acpi_gbl_pre_defined_names[NUM_PREDEFINED_NAMES];
337
338 #ifdef ACPI_DEBUG_OUTPUT
339 ACPI_EXTERN u32 acpi_gbl_current_node_count;
340 ACPI_EXTERN u32 acpi_gbl_current_node_size;
341 ACPI_EXTERN u32 acpi_gbl_max_concurrent_node_count;
342 ACPI_EXTERN acpi_size *acpi_gbl_entry_stack_pointer;
343 ACPI_EXTERN acpi_size *acpi_gbl_lowest_stack_pointer;
344 ACPI_EXTERN u32 acpi_gbl_deepest_nesting;
345 #endif
346
347 /*****************************************************************************
348  *
349  * Interpreter globals
350  *
351  ****************************************************************************/
352
353 ACPI_EXTERN struct acpi_thread_state *acpi_gbl_current_walk_list;
354
355 /* Control method single step flag */
356
357 ACPI_EXTERN u8 acpi_gbl_cm_single_step;
358
359 /*****************************************************************************
360  *
361  * Hardware globals
362  *
363  ****************************************************************************/
364
365 extern struct acpi_bit_register_info
366     acpi_gbl_bit_register_info[ACPI_NUM_BITREG];
367 ACPI_EXTERN u8 acpi_gbl_sleep_type_a;
368 ACPI_EXTERN u8 acpi_gbl_sleep_type_b;
369
370 /*****************************************************************************
371  *
372  * Event and GPE globals
373  *
374  ****************************************************************************/
375
376 #if (!ACPI_REDUCED_HARDWARE)
377
378 ACPI_EXTERN u8 acpi_gbl_all_gpes_initialized;
379 ACPI_EXTERN struct acpi_gpe_xrupt_info *acpi_gbl_gpe_xrupt_list_head;
380 ACPI_EXTERN struct acpi_gpe_block_info
381     *acpi_gbl_gpe_fadt_blocks[ACPI_MAX_GPE_BLOCKS];
382 ACPI_EXTERN acpi_gbl_event_handler acpi_gbl_global_event_handler;
383 ACPI_EXTERN void *acpi_gbl_global_event_handler_context;
384 ACPI_EXTERN struct acpi_fixed_event_handler
385     acpi_gbl_fixed_event_handlers[ACPI_NUM_FIXED_EVENTS];
386 extern struct acpi_fixed_event_info
387     acpi_gbl_fixed_event_info[ACPI_NUM_FIXED_EVENTS];
388
389 #endif                          /* !ACPI_REDUCED_HARDWARE */
390
391 /*****************************************************************************
392  *
393  * Debug support
394  *
395  ****************************************************************************/
396
397 /* Procedure nesting level for debug output */
398
399 extern u32 acpi_gbl_nesting_level;
400
401 /* Event counters */
402
403 ACPI_EXTERN u32 acpi_gpe_count;
404 ACPI_EXTERN u32 acpi_fixed_event_count[ACPI_NUM_FIXED_EVENTS];
405
406 /* Support for dynamic control method tracing mechanism */
407
408 ACPI_EXTERN u32 acpi_gbl_original_dbg_level;
409 ACPI_EXTERN u32 acpi_gbl_original_dbg_layer;
410 ACPI_EXTERN u32 acpi_gbl_trace_dbg_level;
411 ACPI_EXTERN u32 acpi_gbl_trace_dbg_layer;
412
413 /*****************************************************************************
414  *
415  * Debugger and Disassembler globals
416  *
417  ****************************************************************************/
418
419 ACPI_EXTERN u8 acpi_gbl_db_output_flags;
420
421 #ifdef ACPI_DISASSEMBLER
422
423 ACPI_EXTERN u8 ACPI_INIT_GLOBAL(acpi_gbl_ignore_noop_operator, FALSE);
424
425 ACPI_EXTERN u8 acpi_gbl_db_opt_disasm;
426 ACPI_EXTERN u8 acpi_gbl_db_opt_verbose;
427 ACPI_EXTERN u8 acpi_gbl_num_external_methods;
428 ACPI_EXTERN u32 acpi_gbl_resolved_external_methods;
429 ACPI_EXTERN struct acpi_external_list *acpi_gbl_external_list;
430 ACPI_EXTERN struct acpi_external_file *acpi_gbl_external_file_list;
431 #endif
432
433 #ifdef ACPI_DEBUGGER
434
435 extern u8 acpi_gbl_method_executing;
436 extern u8 acpi_gbl_abort_method;
437 extern u8 acpi_gbl_db_terminate_threads;
438
439 ACPI_EXTERN u8 acpi_gbl_db_opt_tables;
440 ACPI_EXTERN u8 acpi_gbl_db_opt_stats;
441 ACPI_EXTERN u8 acpi_gbl_db_opt_ini_methods;
442 ACPI_EXTERN u8 acpi_gbl_db_opt_no_region_support;
443
444 ACPI_EXTERN char *acpi_gbl_db_args[ACPI_DEBUGGER_MAX_ARGS];
445 ACPI_EXTERN acpi_object_type acpi_gbl_db_arg_types[ACPI_DEBUGGER_MAX_ARGS];
446 ACPI_EXTERN char acpi_gbl_db_line_buf[ACPI_DB_LINE_BUFFER_SIZE];
447 ACPI_EXTERN char acpi_gbl_db_parsed_buf[ACPI_DB_LINE_BUFFER_SIZE];
448 ACPI_EXTERN char acpi_gbl_db_scope_buf[80];
449 ACPI_EXTERN char acpi_gbl_db_debug_filename[80];
450 ACPI_EXTERN u8 acpi_gbl_db_output_to_file;
451 ACPI_EXTERN char *acpi_gbl_db_buffer;
452 ACPI_EXTERN char *acpi_gbl_db_filename;
453 ACPI_EXTERN u32 acpi_gbl_db_debug_level;
454 ACPI_EXTERN u32 acpi_gbl_db_console_debug_level;
455 ACPI_EXTERN struct acpi_namespace_node *acpi_gbl_db_scope_node;
456
457 /*
458  * Statistic globals
459  */
460 ACPI_EXTERN u16 acpi_gbl_obj_type_count[ACPI_TYPE_NS_NODE_MAX + 1];
461 ACPI_EXTERN u16 acpi_gbl_node_type_count[ACPI_TYPE_NS_NODE_MAX + 1];
462 ACPI_EXTERN u16 acpi_gbl_obj_type_count_misc;
463 ACPI_EXTERN u16 acpi_gbl_node_type_count_misc;
464 ACPI_EXTERN u32 acpi_gbl_num_nodes;
465 ACPI_EXTERN u32 acpi_gbl_num_objects;
466
467 ACPI_EXTERN u32 acpi_gbl_size_of_parse_tree;
468 ACPI_EXTERN u32 acpi_gbl_size_of_method_trees;
469 ACPI_EXTERN u32 acpi_gbl_size_of_node_entries;
470 ACPI_EXTERN u32 acpi_gbl_size_of_acpi_objects;
471
472 #endif                          /* ACPI_DEBUGGER */
473
474 /*****************************************************************************
475  *
476  * Info/help support
477  *
478  ****************************************************************************/
479
480 extern const struct ah_predefined_name asl_predefined_info[];
481
482 #endif                          /* __ACGLOBAL_H__ */