xref: /openbmc/linux/drivers/acpi/acpica/acglobal.h (revision 4f3db074)
1 /******************************************************************************
2  *
3  * Name: acglobal.h - Declarations for global variables
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2015, 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  *
49  * Globals related to the ACPI tables
50  *
51  ****************************************************************************/
52 
53 /* Master list of all ACPI tables that were found in the RSDT/XSDT */
54 
55 ACPI_GLOBAL(struct acpi_table_list, acpi_gbl_root_table_list);
56 
57 /* DSDT information. Used to check for DSDT corruption */
58 
59 ACPI_GLOBAL(struct acpi_table_header *, acpi_gbl_DSDT);
60 ACPI_GLOBAL(struct acpi_table_header, acpi_gbl_original_dsdt_header);
61 
62 #if (!ACPI_REDUCED_HARDWARE)
63 ACPI_GLOBAL(struct acpi_table_facs *, acpi_gbl_FACS);
64 
65 #endif				/* !ACPI_REDUCED_HARDWARE */
66 
67 /* These addresses are calculated from the FADT Event Block addresses */
68 
69 ACPI_GLOBAL(struct acpi_generic_address, acpi_gbl_xpm1a_status);
70 ACPI_GLOBAL(struct acpi_generic_address, acpi_gbl_xpm1a_enable);
71 
72 ACPI_GLOBAL(struct acpi_generic_address, acpi_gbl_xpm1b_status);
73 ACPI_GLOBAL(struct acpi_generic_address, acpi_gbl_xpm1b_enable);
74 
75 /*
76  * Handle both ACPI 1.0 and ACPI 2.0+ Integer widths. The integer width is
77  * determined by the revision of the DSDT: If the DSDT revision is less than
78  * 2, use only the lower 32 bits of the internal 64-bit Integer.
79  */
80 ACPI_GLOBAL(u8, acpi_gbl_integer_bit_width);
81 ACPI_GLOBAL(u8, acpi_gbl_integer_byte_width);
82 ACPI_GLOBAL(u8, acpi_gbl_integer_nybble_width);
83 
84 /*****************************************************************************
85  *
86  * Mutual exclusion within ACPICA subsystem
87  *
88  ****************************************************************************/
89 
90 /*
91  * Predefined mutex objects. This array contains the
92  * actual OS mutex handles, indexed by the local ACPI_MUTEX_HANDLEs.
93  * (The table maps local handles to the real OS handles)
94  */
95 ACPI_GLOBAL(struct acpi_mutex_info, acpi_gbl_mutex_info[ACPI_NUM_MUTEX]);
96 
97 /*
98  * Global lock mutex is an actual AML mutex object
99  * Global lock semaphore works in conjunction with the actual global lock
100  * Global lock spinlock is used for "pending" handshake
101  */
102 ACPI_GLOBAL(union acpi_operand_object *, acpi_gbl_global_lock_mutex);
103 ACPI_GLOBAL(acpi_semaphore, acpi_gbl_global_lock_semaphore);
104 ACPI_GLOBAL(acpi_spinlock, acpi_gbl_global_lock_pending_lock);
105 ACPI_GLOBAL(u16, acpi_gbl_global_lock_handle);
106 ACPI_GLOBAL(u8, acpi_gbl_global_lock_acquired);
107 ACPI_GLOBAL(u8, acpi_gbl_global_lock_present);
108 ACPI_GLOBAL(u8, acpi_gbl_global_lock_pending);
109 
110 /*
111  * Spinlocks are used for interfaces that can be possibly called at
112  * interrupt level
113  */
114 ACPI_GLOBAL(acpi_spinlock, acpi_gbl_gpe_lock);	/* For GPE data structs and registers */
115 ACPI_GLOBAL(acpi_spinlock, acpi_gbl_hardware_lock);	/* For ACPI H/W except GPE registers */
116 ACPI_GLOBAL(acpi_spinlock, acpi_gbl_reference_count_lock);
117 
118 /* Mutex for _OSI support */
119 
120 ACPI_GLOBAL(acpi_mutex, acpi_gbl_osi_mutex);
121 
122 /* Reader/Writer lock is used for namespace walk and dynamic table unload */
123 
124 ACPI_GLOBAL(struct acpi_rw_lock, acpi_gbl_namespace_rw_lock);
125 
126 /*****************************************************************************
127  *
128  * Miscellaneous globals
129  *
130  ****************************************************************************/
131 
132 /* Object caches */
133 
134 ACPI_GLOBAL(acpi_cache_t *, acpi_gbl_namespace_cache);
135 ACPI_GLOBAL(acpi_cache_t *, acpi_gbl_state_cache);
136 ACPI_GLOBAL(acpi_cache_t *, acpi_gbl_ps_node_cache);
137 ACPI_GLOBAL(acpi_cache_t *, acpi_gbl_ps_node_ext_cache);
138 ACPI_GLOBAL(acpi_cache_t *, acpi_gbl_operand_cache);
139 
140 /* System */
141 
142 ACPI_INIT_GLOBAL(u32, acpi_gbl_startup_flags, 0);
143 ACPI_INIT_GLOBAL(u8, acpi_gbl_shutdown, TRUE);
144 
145 /* Global handlers */
146 
147 ACPI_GLOBAL(struct acpi_global_notify_handler, acpi_gbl_global_notify[2]);
148 ACPI_GLOBAL(acpi_exception_handler, acpi_gbl_exception_handler);
149 ACPI_GLOBAL(acpi_init_handler, acpi_gbl_init_handler);
150 ACPI_GLOBAL(acpi_table_handler, acpi_gbl_table_handler);
151 ACPI_GLOBAL(void *, acpi_gbl_table_handler_context);
152 ACPI_GLOBAL(acpi_interface_handler, acpi_gbl_interface_handler);
153 ACPI_GLOBAL(struct acpi_sci_handler_info *, acpi_gbl_sci_handler_list);
154 
155 /* Owner ID support */
156 
157 ACPI_GLOBAL(u32, acpi_gbl_owner_id_mask[ACPI_NUM_OWNERID_MASKS]);
158 ACPI_GLOBAL(u8, acpi_gbl_last_owner_id_index);
159 ACPI_GLOBAL(u8, acpi_gbl_next_owner_id_offset);
160 
161 /* Initialization sequencing */
162 
163 ACPI_GLOBAL(u8, acpi_gbl_reg_methods_executed);
164 
165 /* Misc */
166 
167 ACPI_GLOBAL(u32, acpi_gbl_original_mode);
168 ACPI_GLOBAL(u32, acpi_gbl_ns_lookup_count);
169 ACPI_GLOBAL(u32, acpi_gbl_ps_find_count);
170 ACPI_GLOBAL(u16, acpi_gbl_pm1_enable_register_save);
171 ACPI_GLOBAL(u8, acpi_gbl_debugger_configuration);
172 ACPI_GLOBAL(u8, acpi_gbl_step_to_next_call);
173 ACPI_GLOBAL(u8, acpi_gbl_acpi_hardware_present);
174 ACPI_GLOBAL(u8, acpi_gbl_events_initialized);
175 ACPI_GLOBAL(struct acpi_interface_info *, acpi_gbl_supported_interfaces);
176 ACPI_GLOBAL(struct acpi_address_range *,
177 	    acpi_gbl_address_range_list[ACPI_ADDRESS_RANGE_MAX]);
178 
179 /* Other miscellaneous, declared and initialized in utglobal */
180 
181 extern const char *acpi_gbl_sleep_state_names[ACPI_S_STATE_COUNT];
182 extern const char *acpi_gbl_lowest_dstate_names[ACPI_NUM_sx_w_METHODS];
183 extern const char *acpi_gbl_highest_dstate_names[ACPI_NUM_sx_d_METHODS];
184 extern const char *acpi_gbl_region_types[ACPI_NUM_PREDEFINED_REGIONS];
185 extern const struct acpi_opcode_info acpi_gbl_aml_op_info[AML_NUM_OPCODES];
186 
187 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
188 
189 /* Lists for tracking memory allocations (debug only) */
190 
191 ACPI_GLOBAL(struct acpi_memory_list *, acpi_gbl_global_list);
192 ACPI_GLOBAL(struct acpi_memory_list *, acpi_gbl_ns_node_list);
193 ACPI_GLOBAL(u8, acpi_gbl_display_final_mem_stats);
194 ACPI_GLOBAL(u8, acpi_gbl_disable_mem_tracking);
195 #endif
196 
197 /*****************************************************************************
198  *
199  * Namespace globals
200  *
201  ****************************************************************************/
202 
203 #if !defined (ACPI_NO_METHOD_EXECUTION) || defined (ACPI_CONSTANT_EVAL_ONLY)
204 #define NUM_PREDEFINED_NAMES            10
205 #else
206 #define NUM_PREDEFINED_NAMES            9
207 #endif
208 
209 ACPI_GLOBAL(struct acpi_namespace_node, acpi_gbl_root_node_struct);
210 ACPI_GLOBAL(struct acpi_namespace_node *, acpi_gbl_root_node);
211 ACPI_GLOBAL(struct acpi_namespace_node *, acpi_gbl_fadt_gpe_device);
212 ACPI_GLOBAL(union acpi_operand_object *, acpi_gbl_module_code_list);
213 
214 extern const u8 acpi_gbl_ns_properties[ACPI_NUM_NS_TYPES];
215 extern const struct acpi_predefined_names
216     acpi_gbl_pre_defined_names[NUM_PREDEFINED_NAMES];
217 
218 #ifdef ACPI_DEBUG_OUTPUT
219 ACPI_GLOBAL(u32, acpi_gbl_current_node_count);
220 ACPI_GLOBAL(u32, acpi_gbl_current_node_size);
221 ACPI_GLOBAL(u32, acpi_gbl_max_concurrent_node_count);
222 ACPI_GLOBAL(acpi_size *, acpi_gbl_entry_stack_pointer);
223 ACPI_GLOBAL(acpi_size *, acpi_gbl_lowest_stack_pointer);
224 ACPI_GLOBAL(u32, acpi_gbl_deepest_nesting);
225 ACPI_INIT_GLOBAL(u32, acpi_gbl_nesting_level, 0);
226 #endif
227 
228 /*****************************************************************************
229  *
230  * Interpreter globals
231  *
232  ****************************************************************************/
233 
234 ACPI_GLOBAL(struct acpi_thread_state *, acpi_gbl_current_walk_list);
235 
236 /* Control method single step flag */
237 
238 ACPI_GLOBAL(u8, acpi_gbl_cm_single_step);
239 
240 /*****************************************************************************
241  *
242  * Hardware globals
243  *
244  ****************************************************************************/
245 
246 extern struct acpi_bit_register_info
247     acpi_gbl_bit_register_info[ACPI_NUM_BITREG];
248 
249 ACPI_GLOBAL(u8, acpi_gbl_sleep_type_a);
250 ACPI_GLOBAL(u8, acpi_gbl_sleep_type_b);
251 
252 /*****************************************************************************
253  *
254  * Event and GPE globals
255  *
256  ****************************************************************************/
257 
258 #if (!ACPI_REDUCED_HARDWARE)
259 
260 ACPI_GLOBAL(u8, acpi_gbl_all_gpes_initialized);
261 ACPI_GLOBAL(struct acpi_gpe_xrupt_info *, acpi_gbl_gpe_xrupt_list_head);
262 ACPI_GLOBAL(struct acpi_gpe_block_info *,
263 	    acpi_gbl_gpe_fadt_blocks[ACPI_MAX_GPE_BLOCKS]);
264 ACPI_GLOBAL(acpi_gbl_event_handler, acpi_gbl_global_event_handler);
265 ACPI_GLOBAL(void *, acpi_gbl_global_event_handler_context);
266 ACPI_GLOBAL(struct acpi_fixed_event_handler,
267 	    acpi_gbl_fixed_event_handlers[ACPI_NUM_FIXED_EVENTS]);
268 
269 extern struct acpi_fixed_event_info
270     acpi_gbl_fixed_event_info[ACPI_NUM_FIXED_EVENTS];
271 
272 #endif				/* !ACPI_REDUCED_HARDWARE */
273 
274 /*****************************************************************************
275  *
276  * Debug support
277  *
278  ****************************************************************************/
279 
280 /* Event counters */
281 
282 ACPI_GLOBAL(u32, acpi_method_count);
283 ACPI_GLOBAL(u32, acpi_gpe_count);
284 ACPI_GLOBAL(u32, acpi_sci_count);
285 ACPI_GLOBAL(u32, acpi_fixed_event_count[ACPI_NUM_FIXED_EVENTS]);
286 
287 /* Support for dynamic control method tracing mechanism */
288 
289 ACPI_GLOBAL(u32, acpi_gbl_original_dbg_level);
290 ACPI_GLOBAL(u32, acpi_gbl_original_dbg_layer);
291 ACPI_GLOBAL(u32, acpi_gbl_trace_dbg_level);
292 ACPI_GLOBAL(u32, acpi_gbl_trace_dbg_layer);
293 
294 /*****************************************************************************
295  *
296  * Debugger and Disassembler globals
297  *
298  ****************************************************************************/
299 
300 ACPI_INIT_GLOBAL(u8, acpi_gbl_db_output_flags, ACPI_DB_CONSOLE_OUTPUT);
301 
302 #ifdef ACPI_DISASSEMBLER
303 
304 /* Do not disassemble buffers to resource descriptors */
305 
306 ACPI_INIT_GLOBAL(u8, acpi_gbl_no_resource_disassembly, FALSE);
307 ACPI_INIT_GLOBAL(u8, acpi_gbl_ignore_noop_operator, FALSE);
308 ACPI_INIT_GLOBAL(u8, acpi_gbl_cstyle_disassembly, TRUE);
309 ACPI_INIT_GLOBAL(u8, acpi_gbl_force_aml_disassembly, FALSE);
310 
311 ACPI_GLOBAL(u8, acpi_gbl_db_opt_disasm);
312 ACPI_GLOBAL(u8, acpi_gbl_db_opt_verbose);
313 ACPI_GLOBAL(u8, acpi_gbl_num_external_methods);
314 ACPI_GLOBAL(u32, acpi_gbl_resolved_external_methods);
315 ACPI_GLOBAL(struct acpi_external_list *, acpi_gbl_external_list);
316 ACPI_GLOBAL(struct acpi_external_file *, acpi_gbl_external_file_list);
317 #endif
318 
319 #ifdef ACPI_DEBUGGER
320 
321 ACPI_INIT_GLOBAL(u8, acpi_gbl_db_terminate_threads, FALSE);
322 ACPI_INIT_GLOBAL(u8, acpi_gbl_abort_method, FALSE);
323 ACPI_INIT_GLOBAL(u8, acpi_gbl_method_executing, FALSE);
324 
325 ACPI_GLOBAL(u8, acpi_gbl_db_opt_no_ini_methods);
326 ACPI_GLOBAL(u8, acpi_gbl_db_opt_no_region_support);
327 ACPI_GLOBAL(u8, acpi_gbl_db_output_to_file);
328 ACPI_GLOBAL(char *, acpi_gbl_db_buffer);
329 ACPI_GLOBAL(char *, acpi_gbl_db_filename);
330 ACPI_GLOBAL(u32, acpi_gbl_db_debug_level);
331 ACPI_GLOBAL(u32, acpi_gbl_db_console_debug_level);
332 ACPI_GLOBAL(struct acpi_namespace_node *, acpi_gbl_db_scope_node);
333 
334 ACPI_GLOBAL(char *, acpi_gbl_db_args[ACPI_DEBUGGER_MAX_ARGS]);
335 ACPI_GLOBAL(acpi_object_type, acpi_gbl_db_arg_types[ACPI_DEBUGGER_MAX_ARGS]);
336 
337 /* These buffers should all be the same size */
338 
339 ACPI_GLOBAL(char, acpi_gbl_db_line_buf[ACPI_DB_LINE_BUFFER_SIZE]);
340 ACPI_GLOBAL(char, acpi_gbl_db_parsed_buf[ACPI_DB_LINE_BUFFER_SIZE]);
341 ACPI_GLOBAL(char, acpi_gbl_db_scope_buf[ACPI_DB_LINE_BUFFER_SIZE]);
342 ACPI_GLOBAL(char, acpi_gbl_db_debug_filename[ACPI_DB_LINE_BUFFER_SIZE]);
343 
344 /*
345  * Statistic globals
346  */
347 ACPI_GLOBAL(u16, acpi_gbl_obj_type_count[ACPI_TYPE_NS_NODE_MAX + 1]);
348 ACPI_GLOBAL(u16, acpi_gbl_node_type_count[ACPI_TYPE_NS_NODE_MAX + 1]);
349 ACPI_GLOBAL(u16, acpi_gbl_obj_type_count_misc);
350 ACPI_GLOBAL(u16, acpi_gbl_node_type_count_misc);
351 ACPI_GLOBAL(u32, acpi_gbl_num_nodes);
352 ACPI_GLOBAL(u32, acpi_gbl_num_objects);
353 
354 #endif				/* ACPI_DEBUGGER */
355 
356 /*****************************************************************************
357  *
358  * Application globals
359  *
360  ****************************************************************************/
361 
362 #ifdef ACPI_APPLICATION
363 
364 ACPI_INIT_GLOBAL(ACPI_FILE, acpi_gbl_debug_file, NULL);
365 ACPI_INIT_GLOBAL(ACPI_FILE, acpi_gbl_output_file, NULL);
366 
367 /* Print buffer */
368 
369 ACPI_GLOBAL(acpi_spinlock, acpi_gbl_print_lock);	/* For print buffer */
370 ACPI_GLOBAL(char, acpi_gbl_print_buffer[1024]);
371 
372 #endif				/* ACPI_APPLICATION */
373 
374 /*****************************************************************************
375  *
376  * Info/help support
377  *
378  ****************************************************************************/
379 
380 extern const struct ah_predefined_name asl_predefined_info[];
381 extern const struct ah_device_id asl_device_ids[];
382 
383 #endif				/* __ACGLOBAL_H__ */
384