1 /******************************************************************************
2  *
3  * Name: acglobal.h - Declarations for global variables
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2004, 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 /*
49  * Ensure that the globals are actually defined and initialized only once.
50  *
51  * The use of these macros allows a single list of globals (here) in order
52  * to simplify maintenance of the code.
53  */
54 #ifdef DEFINE_ACPI_GLOBALS
55 #define ACPI_EXTERN
56 #define ACPI_INIT_GLOBAL(a,b) a=b
57 #else
58 #define ACPI_EXTERN extern
59 #define ACPI_INIT_GLOBAL(a,b) a
60 #endif
61 
62 /*
63  * Keep local copies of these FADT-based registers.  NOTE: These globals
64  * are first in this file for alignment reasons on 64-bit systems.
65  */
66 ACPI_EXTERN struct acpi_generic_address         acpi_gbl_xpm1a_enable;
67 ACPI_EXTERN struct acpi_generic_address         acpi_gbl_xpm1b_enable;
68 
69 
70 /*****************************************************************************
71  *
72  * Debug support
73  *
74  ****************************************************************************/
75 
76 /* Runtime configuration of debug print levels */
77 
78 extern      u32                                 acpi_dbg_level;
79 extern      u32                                 acpi_dbg_layer;
80 
81 /* Procedure nesting level for debug output */
82 
83 extern      u32                                 acpi_gbl_nesting_level;
84 
85 
86 /*****************************************************************************
87  *
88  * Runtime configuration (static defaults that can be overriden at runtime)
89  *
90  ****************************************************************************/
91 
92 /*
93  * Automatically serialize ALL control methods? Default is FALSE, meaning
94  * to use the Serialized/not_serialized method flags on a per method basis.
95  * Only change this if the ASL code is poorly written and cannot handle
96  * reentrancy even though methods are marked "not_serialized".
97  */
98 ACPI_EXTERN u8       ACPI_INIT_GLOBAL (acpi_gbl_all_methods_serialized, FALSE);
99 
100 /*
101  * Create the predefined _OSI method in the namespace? Default is TRUE
102  * because ACPI CA is fully compatible with other ACPI implementations.
103  * Changing this will revert ACPI CA (and machine ASL) to pre-OSI behavior.
104  */
105 ACPI_EXTERN u8       ACPI_INIT_GLOBAL (acpi_gbl_create_osi_method, TRUE);
106 
107 /*
108  * Disable wakeup GPEs during runtime? Default is TRUE because WAKE and
109  * RUNTIME GPEs should never be shared, and WAKE GPEs should typically only
110  * be enabled just before going to sleep.
111  */
112 /* Set to FALSE in 2.4 because TRUE requires big ACPICA GPE fixes from 2.6. */
113 ACPI_EXTERN u8       ACPI_INIT_GLOBAL (acpi_gbl_leave_wake_gpes_disabled, FALSE);
114 
115 
116 /*****************************************************************************
117  *
118  * ACPI Table globals
119  *
120  ****************************************************************************/
121 
122 /*
123  * Table pointers.
124  * Although these pointers are somewhat redundant with the global acpi_table,
125  * they are convenient because they are typed pointers.
126  *
127  * These tables are single-table only; meaning that there can be at most one
128  * of each in the system.  Each global points to the actual table.
129  */
130 ACPI_EXTERN u32                                 acpi_gbl_table_flags;
131 ACPI_EXTERN u32                                 acpi_gbl_rsdt_table_count;
132 ACPI_EXTERN struct rsdp_descriptor             *acpi_gbl_RSDP;
133 ACPI_EXTERN XSDT_DESCRIPTOR            *acpi_gbl_XSDT;
134 ACPI_EXTERN FADT_DESCRIPTOR            *acpi_gbl_FADT;
135 ACPI_EXTERN struct acpi_table_header           *acpi_gbl_DSDT;
136 ACPI_EXTERN FACS_DESCRIPTOR            *acpi_gbl_FACS;
137 ACPI_EXTERN struct acpi_common_facs             acpi_gbl_common_fACS;
138 /*
139  * Since there may be multiple SSDTs and PSDTS, a single pointer is not
140  * sufficient; Therefore, there isn't one!
141  */
142 
143 
144 /*
145  * Handle both ACPI 1.0 and ACPI 2.0 Integer widths
146  * If we are running a method that exists in a 32-bit ACPI table.
147  * Use only 32 bits of the Integer for conversion.
148  */
149 ACPI_EXTERN u8                                  acpi_gbl_integer_bit_width;
150 ACPI_EXTERN u8                                  acpi_gbl_integer_byte_width;
151 ACPI_EXTERN u8                                  acpi_gbl_integer_nybble_width;
152 
153 /*
154  * ACPI Table info arrays
155  */
156 extern      struct acpi_table_list              acpi_gbl_table_lists[NUM_ACPI_TABLE_TYPES];
157 extern      struct acpi_table_support           acpi_gbl_table_data[NUM_ACPI_TABLE_TYPES];
158 
159 /*
160  * Predefined mutex objects.  This array contains the
161  * actual OS mutex handles, indexed by the local ACPI_MUTEX_HANDLEs.
162  * (The table maps local handles to the real OS handles)
163  */
164 ACPI_EXTERN struct acpi_mutex_info              acpi_gbl_mutex_info[NUM_MUTEX];
165 
166 
167 /*****************************************************************************
168  *
169  * Miscellaneous globals
170  *
171  ****************************************************************************/
172 
173 
174 ACPI_EXTERN struct acpi_memory_list             acpi_gbl_memory_lists[ACPI_NUM_MEM_LISTS];
175 ACPI_EXTERN struct acpi_object_notify_handler   acpi_gbl_device_notify;
176 ACPI_EXTERN struct acpi_object_notify_handler   acpi_gbl_system_notify;
177 ACPI_EXTERN acpi_init_handler                   acpi_gbl_init_handler;
178 ACPI_EXTERN struct acpi_walk_state             *acpi_gbl_breakpoint_walk;
179 ACPI_EXTERN acpi_handle                         acpi_gbl_global_lock_semaphore;
180 
181 ACPI_EXTERN u32                                 acpi_gbl_global_lock_thread_count;
182 ACPI_EXTERN u32                                 acpi_gbl_original_mode;
183 ACPI_EXTERN u32                                 acpi_gbl_rsdp_original_location;
184 ACPI_EXTERN u32                                 acpi_gbl_ns_lookup_count;
185 ACPI_EXTERN u32                                 acpi_gbl_ps_find_count;
186 ACPI_EXTERN u16                                 acpi_gbl_pm1_enable_register_save;
187 ACPI_EXTERN u16                                 acpi_gbl_next_table_owner_id;
188 ACPI_EXTERN u16                                 acpi_gbl_next_method_owner_id;
189 ACPI_EXTERN u16                                 acpi_gbl_global_lock_handle;
190 ACPI_EXTERN u8                                  acpi_gbl_debugger_configuration;
191 ACPI_EXTERN u8                                  acpi_gbl_global_lock_acquired;
192 ACPI_EXTERN u8                                  acpi_gbl_step_to_next_call;
193 ACPI_EXTERN u8                                  acpi_gbl_acpi_hardware_present;
194 ACPI_EXTERN u8                                  acpi_gbl_global_lock_present;
195 ACPI_EXTERN u8                                  acpi_gbl_events_initialized;
196 
197 extern u8                                       acpi_gbl_shutdown;
198 extern u32                                      acpi_gbl_startup_flags;
199 extern const u8                                 acpi_gbl_decode_to8bit[8];
200 extern const char                              *acpi_gbl_sleep_state_names[ACPI_S_STATE_COUNT];
201 extern const char                              *acpi_gbl_highest_dstate_names[4];
202 extern const struct acpi_opcode_info            acpi_gbl_aml_op_info[AML_NUM_OPCODES];
203 extern const char                              *acpi_gbl_region_types[ACPI_NUM_PREDEFINED_REGIONS];
204 extern const char                              *acpi_gbl_valid_osi_strings[ACPI_NUM_OSI_STRINGS];
205 
206 
207 /*****************************************************************************
208  *
209  * Namespace globals
210  *
211  ****************************************************************************/
212 
213 #define NUM_NS_TYPES                    ACPI_TYPE_INVALID+1
214 
215 #if !defined (ACPI_NO_METHOD_EXECUTION) || defined (ACPI_CONSTANT_EVAL_ONLY)
216 #define NUM_PREDEFINED_NAMES            10
217 #else
218 #define NUM_PREDEFINED_NAMES            9
219 #endif
220 
221 ACPI_EXTERN struct acpi_namespace_node          acpi_gbl_root_node_struct;
222 ACPI_EXTERN struct acpi_namespace_node         *acpi_gbl_root_node;
223 ACPI_EXTERN struct acpi_namespace_node         *acpi_gbl_fadt_gpe_device;
224 
225 extern const u8                                 acpi_gbl_ns_properties[NUM_NS_TYPES];
226 extern const struct acpi_predefined_names       acpi_gbl_pre_defined_names [NUM_PREDEFINED_NAMES];
227 
228 #ifdef ACPI_DEBUG_OUTPUT
229 ACPI_EXTERN u32                                 acpi_gbl_current_node_count;
230 ACPI_EXTERN u32                                 acpi_gbl_current_node_size;
231 ACPI_EXTERN u32                                 acpi_gbl_max_concurrent_node_count;
232 ACPI_EXTERN acpi_size                           acpi_gbl_entry_stack_pointer;
233 ACPI_EXTERN acpi_size                           acpi_gbl_lowest_stack_pointer;
234 ACPI_EXTERN u32                                 acpi_gbl_deepest_nesting;
235 #endif
236 
237 /*****************************************************************************
238  *
239  * Interpreter globals
240  *
241  ****************************************************************************/
242 
243 
244 ACPI_EXTERN struct acpi_thread_state           *acpi_gbl_current_walk_list;
245 
246 /* Control method single step flag */
247 
248 ACPI_EXTERN u8                                  acpi_gbl_cm_single_step;
249 
250 
251 /*****************************************************************************
252  *
253  * Parser globals
254  *
255  ****************************************************************************/
256 
257 ACPI_EXTERN union acpi_parse_object            *acpi_gbl_parsed_namespace_root;
258 
259 /*****************************************************************************
260  *
261  * Hardware globals
262  *
263  ****************************************************************************/
264 
265 extern      struct acpi_bit_register_info       acpi_gbl_bit_register_info[ACPI_NUM_BITREG];
266 ACPI_EXTERN u8                                  acpi_gbl_sleep_type_a;
267 ACPI_EXTERN u8                                  acpi_gbl_sleep_type_b;
268 
269 
270 /*****************************************************************************
271  *
272  * Event and GPE globals
273  *
274  ****************************************************************************/
275 
276 extern      struct acpi_fixed_event_info        acpi_gbl_fixed_event_info[ACPI_NUM_FIXED_EVENTS];
277 ACPI_EXTERN struct acpi_fixed_event_handler     acpi_gbl_fixed_event_handlers[ACPI_NUM_FIXED_EVENTS];
278 ACPI_EXTERN struct acpi_gpe_xrupt_info         *acpi_gbl_gpe_xrupt_list_head;
279 ACPI_EXTERN struct acpi_gpe_block_info         *acpi_gbl_gpe_fadt_blocks[ACPI_MAX_GPE_BLOCKS];
280 ACPI_EXTERN acpi_handle                         acpi_gbl_gpe_lock;
281 
282 
283 /*****************************************************************************
284  *
285  * Debugger globals
286  *
287  ****************************************************************************/
288 
289 
290 ACPI_EXTERN u8                                  acpi_gbl_db_output_flags;
291 
292 #ifdef ACPI_DISASSEMBLER
293 
294 ACPI_EXTERN u8                                  acpi_gbl_db_opt_disasm;
295 ACPI_EXTERN u8                                  acpi_gbl_db_opt_verbose;
296 #endif
297 
298 
299 #ifdef ACPI_DEBUGGER
300 
301 extern      u8                                  acpi_gbl_method_executing;
302 extern      u8                                  acpi_gbl_abort_method;
303 extern      u8                                  acpi_gbl_db_terminate_threads;
304 
305 ACPI_EXTERN int                                 optind;
306 ACPI_EXTERN char                               *optarg;
307 
308 ACPI_EXTERN u8                                  acpi_gbl_db_opt_tables;
309 ACPI_EXTERN u8                                  acpi_gbl_db_opt_stats;
310 ACPI_EXTERN u8                                  acpi_gbl_db_opt_ini_methods;
311 
312 
313 ACPI_EXTERN char                               *acpi_gbl_db_args[ACPI_DEBUGGER_MAX_ARGS];
314 ACPI_EXTERN char                                acpi_gbl_db_line_buf[80];
315 ACPI_EXTERN char                                acpi_gbl_db_parsed_buf[80];
316 ACPI_EXTERN char                                acpi_gbl_db_scope_buf[40];
317 ACPI_EXTERN char                                acpi_gbl_db_debug_filename[40];
318 ACPI_EXTERN u8                                  acpi_gbl_db_output_to_file;
319 ACPI_EXTERN char                               *acpi_gbl_db_buffer;
320 ACPI_EXTERN char                               *acpi_gbl_db_filename;
321 ACPI_EXTERN u32                                 acpi_gbl_db_debug_level;
322 ACPI_EXTERN u32                                 acpi_gbl_db_console_debug_level;
323 ACPI_EXTERN struct acpi_table_header           *acpi_gbl_db_table_ptr;
324 ACPI_EXTERN struct acpi_namespace_node         *acpi_gbl_db_scope_node;
325 
326 /*
327  * Statistic globals
328  */
329 ACPI_EXTERN u16                                 acpi_gbl_obj_type_count[ACPI_TYPE_NS_NODE_MAX+1];
330 ACPI_EXTERN u16                                 acpi_gbl_node_type_count[ACPI_TYPE_NS_NODE_MAX+1];
331 ACPI_EXTERN u16                                 acpi_gbl_obj_type_count_misc;
332 ACPI_EXTERN u16                                 acpi_gbl_node_type_count_misc;
333 ACPI_EXTERN u32                                 acpi_gbl_num_nodes;
334 ACPI_EXTERN u32                                 acpi_gbl_num_objects;
335 
336 
337 ACPI_EXTERN u32                                 acpi_gbl_size_of_parse_tree;
338 ACPI_EXTERN u32                                 acpi_gbl_size_of_method_trees;
339 ACPI_EXTERN u32                                 acpi_gbl_size_of_node_entries;
340 ACPI_EXTERN u32                                 acpi_gbl_size_of_acpi_objects;
341 
342 #endif /* ACPI_DEBUGGER */
343 
344 
345 #endif /* __ACGLOBAL_H__ */
346