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