• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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 /* acpi_gbl_FADT is a local copy of the FADT, converted to a common format. */
136 
137 struct acpi_table_fadt acpi_gbl_FADT;
138 u32 acpi_current_gpe_count;
139 u32 acpi_gbl_trace_flags;
140 acpi_name acpi_gbl_trace_method_name;
141 u8 acpi_gbl_system_awake_and_running;
142 
143 /*
144  * ACPI 5.0 introduces the concept of a "reduced hardware platform", meaning
145  * that the ACPI hardware is no longer required. A flag in the FADT indicates
146  * a reduced HW machine, and that flag is duplicated here for convenience.
147  */
148 u8 acpi_gbl_reduced_hardware;
149 
150 #endif				/* DEFINE_ACPI_GLOBALS */
151 
152 /* Do not disassemble buffers to resource descriptors */
153 
154 ACPI_EXTERN u8 ACPI_INIT_GLOBAL(acpi_gbl_no_resource_disassembly, FALSE);
155 
156 /*****************************************************************************
157  *
158  * ACPI Table globals
159  *
160  ****************************************************************************/
161 
162 /*
163  * acpi_gbl_root_table_list is the master list of ACPI tables that were
164  * found in the RSDT/XSDT.
165  */
166 ACPI_EXTERN struct acpi_table_list acpi_gbl_root_table_list;
167 
168 #if (!ACPI_REDUCED_HARDWARE)
169 ACPI_EXTERN struct acpi_table_facs *acpi_gbl_FACS;
170 
171 #endif				/* !ACPI_REDUCED_HARDWARE */
172 
173 /* These addresses are calculated from the FADT Event Block addresses */
174 
175 ACPI_EXTERN struct acpi_generic_address acpi_gbl_xpm1a_status;
176 ACPI_EXTERN struct acpi_generic_address acpi_gbl_xpm1a_enable;
177 
178 ACPI_EXTERN struct acpi_generic_address acpi_gbl_xpm1b_status;
179 ACPI_EXTERN struct acpi_generic_address acpi_gbl_xpm1b_enable;
180 
181 /* DSDT information. Used to check for DSDT corruption */
182 
183 ACPI_EXTERN struct acpi_table_header *acpi_gbl_DSDT;
184 ACPI_EXTERN struct acpi_table_header acpi_gbl_original_dsdt_header;
185 
186 /*
187  * Handle both ACPI 1.0 and ACPI 2.0 Integer widths. The integer width is
188  * determined by the revision of the DSDT: If the DSDT revision is less than
189  * 2, use only the lower 32 bits of the internal 64-bit Integer.
190  */
191 ACPI_EXTERN u8 acpi_gbl_integer_bit_width;
192 ACPI_EXTERN u8 acpi_gbl_integer_byte_width;
193 ACPI_EXTERN u8 acpi_gbl_integer_nybble_width;
194 
195 /*****************************************************************************
196  *
197  * Mutual exclusion within ACPICA subsystem
198  *
199  ****************************************************************************/
200 
201 /*
202  * Predefined mutex objects. This array contains the
203  * actual OS mutex handles, indexed by the local ACPI_MUTEX_HANDLEs.
204  * (The table maps local handles to the real OS handles)
205  */
206 ACPI_EXTERN struct acpi_mutex_info acpi_gbl_mutex_info[ACPI_NUM_MUTEX];
207 
208 /*
209  * Global lock mutex is an actual AML mutex object
210  * Global lock semaphore works in conjunction with the actual global lock
211  * Global lock spinlock is used for "pending" handshake
212  */
213 ACPI_EXTERN union acpi_operand_object *acpi_gbl_global_lock_mutex;
214 ACPI_EXTERN acpi_semaphore acpi_gbl_global_lock_semaphore;
215 ACPI_EXTERN acpi_spinlock acpi_gbl_global_lock_pending_lock;
216 ACPI_EXTERN u16 acpi_gbl_global_lock_handle;
217 ACPI_EXTERN u8 acpi_gbl_global_lock_acquired;
218 ACPI_EXTERN u8 acpi_gbl_global_lock_present;
219 ACPI_EXTERN u8 acpi_gbl_global_lock_pending;
220 
221 /*
222  * Spinlocks are used for interfaces that can be possibly called at
223  * interrupt level
224  */
225 ACPI_EXTERN acpi_spinlock acpi_gbl_gpe_lock;	/* For GPE data structs and registers */
226 ACPI_EXTERN acpi_spinlock acpi_gbl_hardware_lock;	/* For ACPI H/W except GPE registers */
227 ACPI_EXTERN acpi_spinlock acpi_gbl_reference_count_lock;
228 
229 /* Mutex for _OSI support */
230 
231 ACPI_EXTERN acpi_mutex acpi_gbl_osi_mutex;
232 
233 /* Reader/Writer lock is used for namespace walk and dynamic table unload */
234 
235 ACPI_EXTERN struct acpi_rw_lock acpi_gbl_namespace_rw_lock;
236 
237 /*****************************************************************************
238  *
239  * Miscellaneous globals
240  *
241  ****************************************************************************/
242 
243 /* Object caches */
244 
245 ACPI_EXTERN acpi_cache_t *acpi_gbl_namespace_cache;
246 ACPI_EXTERN acpi_cache_t *acpi_gbl_state_cache;
247 ACPI_EXTERN acpi_cache_t *acpi_gbl_ps_node_cache;
248 ACPI_EXTERN acpi_cache_t *acpi_gbl_ps_node_ext_cache;
249 ACPI_EXTERN acpi_cache_t *acpi_gbl_operand_cache;
250 
251 /* Global handlers */
252 
253 ACPI_EXTERN struct acpi_global_notify_handler acpi_gbl_global_notify[2];
254 ACPI_EXTERN acpi_exception_handler acpi_gbl_exception_handler;
255 ACPI_EXTERN acpi_init_handler acpi_gbl_init_handler;
256 ACPI_EXTERN acpi_table_handler acpi_gbl_table_handler;
257 ACPI_EXTERN void *acpi_gbl_table_handler_context;
258 ACPI_EXTERN struct acpi_walk_state *acpi_gbl_breakpoint_walk;
259 ACPI_EXTERN acpi_interface_handler acpi_gbl_interface_handler;
260 
261 /* Owner ID support */
262 
263 ACPI_EXTERN u32 acpi_gbl_owner_id_mask[ACPI_NUM_OWNERID_MASKS];
264 ACPI_EXTERN u8 acpi_gbl_last_owner_id_index;
265 ACPI_EXTERN u8 acpi_gbl_next_owner_id_offset;
266 
267 /* Initialization sequencing */
268 
269 ACPI_EXTERN u8 acpi_gbl_reg_methods_executed;
270 
271 /* Misc */
272 
273 ACPI_EXTERN u32 acpi_gbl_original_mode;
274 ACPI_EXTERN u32 acpi_gbl_rsdp_original_location;
275 ACPI_EXTERN u32 acpi_gbl_ns_lookup_count;
276 ACPI_EXTERN u32 acpi_gbl_ps_find_count;
277 ACPI_EXTERN u16 acpi_gbl_pm1_enable_register_save;
278 ACPI_EXTERN u8 acpi_gbl_debugger_configuration;
279 ACPI_EXTERN u8 acpi_gbl_step_to_next_call;
280 ACPI_EXTERN u8 acpi_gbl_acpi_hardware_present;
281 ACPI_EXTERN u8 acpi_gbl_events_initialized;
282 ACPI_EXTERN u8 acpi_gbl_osi_data;
283 ACPI_EXTERN struct acpi_interface_info *acpi_gbl_supported_interfaces;
284 ACPI_EXTERN struct acpi_address_range
285     *acpi_gbl_address_range_list[ACPI_ADDRESS_RANGE_MAX];
286 
287 #ifndef DEFINE_ACPI_GLOBALS
288 
289 /* Other miscellaneous */
290 
291 extern u8 acpi_gbl_shutdown;
292 extern u32 acpi_gbl_startup_flags;
293 extern const char *acpi_gbl_sleep_state_names[ACPI_S_STATE_COUNT];
294 extern const char *acpi_gbl_lowest_dstate_names[ACPI_NUM_sx_w_METHODS];
295 extern const char *acpi_gbl_highest_dstate_names[ACPI_NUM_sx_d_METHODS];
296 extern const struct acpi_opcode_info acpi_gbl_aml_op_info[AML_NUM_OPCODES];
297 extern const char *acpi_gbl_region_types[ACPI_NUM_PREDEFINED_REGIONS];
298 
299 #endif
300 
301 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
302 
303 /* Lists for tracking memory allocations */
304 
305 ACPI_EXTERN struct acpi_memory_list *acpi_gbl_global_list;
306 ACPI_EXTERN struct acpi_memory_list *acpi_gbl_ns_node_list;
307 ACPI_EXTERN u8 acpi_gbl_display_final_mem_stats;
308 ACPI_EXTERN u8 acpi_gbl_disable_mem_tracking;
309 #endif
310 
311 /*****************************************************************************
312  *
313  * Namespace globals
314  *
315  ****************************************************************************/
316 
317 #if !defined (ACPI_NO_METHOD_EXECUTION) || defined (ACPI_CONSTANT_EVAL_ONLY)
318 #define NUM_PREDEFINED_NAMES            10
319 #else
320 #define NUM_PREDEFINED_NAMES            9
321 #endif
322 
323 ACPI_EXTERN struct acpi_namespace_node acpi_gbl_root_node_struct;
324 ACPI_EXTERN struct acpi_namespace_node *acpi_gbl_root_node;
325 ACPI_EXTERN struct acpi_namespace_node *acpi_gbl_fadt_gpe_device;
326 ACPI_EXTERN union acpi_operand_object *acpi_gbl_module_code_list;
327 
328 extern const u8 acpi_gbl_ns_properties[ACPI_NUM_NS_TYPES];
329 extern const struct acpi_predefined_names
330     acpi_gbl_pre_defined_names[NUM_PREDEFINED_NAMES];
331 
332 #ifdef ACPI_DEBUG_OUTPUT
333 ACPI_EXTERN u32 acpi_gbl_current_node_count;
334 ACPI_EXTERN u32 acpi_gbl_current_node_size;
335 ACPI_EXTERN u32 acpi_gbl_max_concurrent_node_count;
336 ACPI_EXTERN acpi_size *acpi_gbl_entry_stack_pointer;
337 ACPI_EXTERN acpi_size *acpi_gbl_lowest_stack_pointer;
338 ACPI_EXTERN u32 acpi_gbl_deepest_nesting;
339 #endif
340 
341 /*****************************************************************************
342  *
343  * Interpreter globals
344  *
345  ****************************************************************************/
346 
347 ACPI_EXTERN struct acpi_thread_state *acpi_gbl_current_walk_list;
348 
349 /* Control method single step flag */
350 
351 ACPI_EXTERN u8 acpi_gbl_cm_single_step;
352 
353 /*****************************************************************************
354  *
355  * Hardware globals
356  *
357  ****************************************************************************/
358 
359 extern struct acpi_bit_register_info
360     acpi_gbl_bit_register_info[ACPI_NUM_BITREG];
361 ACPI_EXTERN u8 acpi_gbl_sleep_type_a;
362 ACPI_EXTERN u8 acpi_gbl_sleep_type_b;
363 
364 /*****************************************************************************
365  *
366  * Event and GPE globals
367  *
368  ****************************************************************************/
369 
370 #if (!ACPI_REDUCED_HARDWARE)
371 
372 ACPI_EXTERN u8 acpi_gbl_all_gpes_initialized;
373 ACPI_EXTERN struct acpi_gpe_xrupt_info *acpi_gbl_gpe_xrupt_list_head;
374 ACPI_EXTERN struct acpi_gpe_block_info
375     *acpi_gbl_gpe_fadt_blocks[ACPI_MAX_GPE_BLOCKS];
376 ACPI_EXTERN acpi_gbl_event_handler acpi_gbl_global_event_handler;
377 ACPI_EXTERN void *acpi_gbl_global_event_handler_context;
378 ACPI_EXTERN struct acpi_fixed_event_handler
379     acpi_gbl_fixed_event_handlers[ACPI_NUM_FIXED_EVENTS];
380 extern struct acpi_fixed_event_info
381     acpi_gbl_fixed_event_info[ACPI_NUM_FIXED_EVENTS];
382 
383 #endif				/* !ACPI_REDUCED_HARDWARE */
384 
385 /*****************************************************************************
386  *
387  * Debug support
388  *
389  ****************************************************************************/
390 
391 /* Procedure nesting level for debug output */
392 
393 extern u32 acpi_gbl_nesting_level;
394 
395 /* Event counters */
396 
397 ACPI_EXTERN u32 acpi_gpe_count;
398 ACPI_EXTERN u32 acpi_fixed_event_count[ACPI_NUM_FIXED_EVENTS];
399 
400 /* Support for dynamic control method tracing mechanism */
401 
402 ACPI_EXTERN u32 acpi_gbl_original_dbg_level;
403 ACPI_EXTERN u32 acpi_gbl_original_dbg_layer;
404 ACPI_EXTERN u32 acpi_gbl_trace_dbg_level;
405 ACPI_EXTERN u32 acpi_gbl_trace_dbg_layer;
406 
407 /*****************************************************************************
408  *
409  * Debugger and Disassembler globals
410  *
411  ****************************************************************************/
412 
413 ACPI_EXTERN u8 acpi_gbl_db_output_flags;
414 
415 #ifdef ACPI_DISASSEMBLER
416 
417 ACPI_EXTERN u8 ACPI_INIT_GLOBAL(acpi_gbl_ignore_noop_operator, FALSE);
418 
419 ACPI_EXTERN u8 acpi_gbl_db_opt_disasm;
420 ACPI_EXTERN u8 acpi_gbl_db_opt_verbose;
421 ACPI_EXTERN u8 acpi_gbl_num_external_methods;
422 ACPI_EXTERN u32 acpi_gbl_resolved_external_methods;
423 ACPI_EXTERN struct acpi_external_list *acpi_gbl_external_list;
424 ACPI_EXTERN struct acpi_external_file *acpi_gbl_external_file_list;
425 #endif
426 
427 #ifdef ACPI_DEBUGGER
428 
429 extern u8 acpi_gbl_method_executing;
430 extern u8 acpi_gbl_abort_method;
431 extern u8 acpi_gbl_db_terminate_threads;
432 
433 ACPI_EXTERN u8 acpi_gbl_db_opt_tables;
434 ACPI_EXTERN u8 acpi_gbl_db_opt_stats;
435 ACPI_EXTERN u8 acpi_gbl_db_opt_ini_methods;
436 ACPI_EXTERN u8 acpi_gbl_db_opt_no_region_support;
437 
438 ACPI_EXTERN char *acpi_gbl_db_args[ACPI_DEBUGGER_MAX_ARGS];
439 ACPI_EXTERN acpi_object_type acpi_gbl_db_arg_types[ACPI_DEBUGGER_MAX_ARGS];
440 ACPI_EXTERN char acpi_gbl_db_line_buf[ACPI_DB_LINE_BUFFER_SIZE];
441 ACPI_EXTERN char acpi_gbl_db_parsed_buf[ACPI_DB_LINE_BUFFER_SIZE];
442 ACPI_EXTERN char acpi_gbl_db_scope_buf[80];
443 ACPI_EXTERN char acpi_gbl_db_debug_filename[80];
444 ACPI_EXTERN u8 acpi_gbl_db_output_to_file;
445 ACPI_EXTERN char *acpi_gbl_db_buffer;
446 ACPI_EXTERN char *acpi_gbl_db_filename;
447 ACPI_EXTERN u32 acpi_gbl_db_debug_level;
448 ACPI_EXTERN u32 acpi_gbl_db_console_debug_level;
449 ACPI_EXTERN struct acpi_namespace_node *acpi_gbl_db_scope_node;
450 
451 /*
452  * Statistic globals
453  */
454 ACPI_EXTERN u16 acpi_gbl_obj_type_count[ACPI_TYPE_NS_NODE_MAX + 1];
455 ACPI_EXTERN u16 acpi_gbl_node_type_count[ACPI_TYPE_NS_NODE_MAX + 1];
456 ACPI_EXTERN u16 acpi_gbl_obj_type_count_misc;
457 ACPI_EXTERN u16 acpi_gbl_node_type_count_misc;
458 ACPI_EXTERN u32 acpi_gbl_num_nodes;
459 ACPI_EXTERN u32 acpi_gbl_num_objects;
460 
461 ACPI_EXTERN u32 acpi_gbl_size_of_parse_tree;
462 ACPI_EXTERN u32 acpi_gbl_size_of_method_trees;
463 ACPI_EXTERN u32 acpi_gbl_size_of_node_entries;
464 ACPI_EXTERN u32 acpi_gbl_size_of_acpi_objects;
465 
466 #endif				/* ACPI_DEBUGGER */
467 
468 /*****************************************************************************
469  *
470  * Info/help support
471  *
472  ****************************************************************************/
473 
474 extern const struct ah_predefined_name asl_predefined_info[];
475 
476 #endif				/* __ACGLOBAL_H__ */
477