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