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