acpi/acpica/acglobal.h

0001 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
0002 /******************************************************************************
0003  *
0004  * Name: acglobal.h - Declarations for global variables
0005  *
0006  * Copyright (C) 2000 - 2022, Intel Corp.
0007  *
0008  *****************************************************************************/
0009
0010 #ifndef __ACGLOBAL_H__
0011 #define __ACGLOBAL_H__
0012
0013 /*****************************************************************************
0014  *
0015  * Globals related to the incoming ACPI tables
0016  *
0017  ****************************************************************************/
0018
0019 /* Master list of all ACPI tables that were found in the RSDT/XSDT */
0020
0021 ACPI_GLOBAL(struct acpi_table_list, acpi_gbl_root_table_list);
0022
0023 /* DSDT information. Used to check for DSDT corruption */
0024
0025 ACPI_GLOBAL(struct acpi_table_header *, acpi_gbl_DSDT);
0026 ACPI_GLOBAL(struct acpi_table_header, acpi_gbl_original_dsdt_header);
0027 ACPI_INIT_GLOBAL(u32, acpi_gbl_dsdt_index, ACPI_INVALID_TABLE_INDEX);
0028 ACPI_INIT_GLOBAL(u32, acpi_gbl_facs_index, ACPI_INVALID_TABLE_INDEX);
0029 ACPI_INIT_GLOBAL(u32, acpi_gbl_xfacs_index, ACPI_INVALID_TABLE_INDEX);
0030 ACPI_INIT_GLOBAL(u32, acpi_gbl_fadt_index, ACPI_INVALID_TABLE_INDEX);
0031
0032 #if (!ACPI_REDUCED_HARDWARE)
0033 ACPI_GLOBAL(struct acpi_table_facs *, acpi_gbl_FACS);
0034
0035 #endif              /* !ACPI_REDUCED_HARDWARE */
0036
0037 /* These addresses are calculated from the FADT Event Block addresses */
0038
0039 ACPI_GLOBAL(struct acpi_generic_address, acpi_gbl_xpm1a_status);
0040 ACPI_GLOBAL(struct acpi_generic_address, acpi_gbl_xpm1a_enable);
0041
0042 ACPI_GLOBAL(struct acpi_generic_address, acpi_gbl_xpm1b_status);
0043 ACPI_GLOBAL(struct acpi_generic_address, acpi_gbl_xpm1b_enable);
0044
0045 #ifdef ACPI_GPE_USE_LOGICAL_ADDRESSES
0046 ACPI_GLOBAL(unsigned long, acpi_gbl_xgpe0_block_logical_address);
0047 ACPI_GLOBAL(unsigned long, acpi_gbl_xgpe1_block_logical_address);
0048
0049 #endif              /* ACPI_GPE_USE_LOGICAL_ADDRESSES */
0050
0051 /*
0052  * Handle both ACPI 1.0 and ACPI 2.0+ Integer widths. The integer width is
0053  * determined by the revision of the DSDT: If the DSDT revision is less than
0054  * 2, use only the lower 32 bits of the internal 64-bit Integer.
0055  */
0056 ACPI_GLOBAL(u8, acpi_gbl_integer_bit_width);
0057 ACPI_GLOBAL(u8, acpi_gbl_integer_byte_width);
0058 ACPI_GLOBAL(u8, acpi_gbl_integer_nybble_width);
0059
0060 /*****************************************************************************
0061  *
0062  * Mutual exclusion within the ACPICA subsystem
0063  *
0064  ****************************************************************************/
0065
0066 /*
0067  * Predefined mutex objects. This array contains the
0068  * actual OS mutex handles, indexed by the local ACPI_MUTEX_HANDLEs.
0069  * (The table maps local handles to the real OS handles)
0070  */
0071 ACPI_GLOBAL(struct acpi_mutex_info, acpi_gbl_mutex_info[ACPI_NUM_MUTEX]);
0072
0073 /*
0074  * Global lock mutex is an actual AML mutex object
0075  * Global lock semaphore works in conjunction with the actual global lock
0076  * Global lock spinlock is used for "pending" handshake
0077  */
0078 ACPI_GLOBAL(union acpi_operand_object *, acpi_gbl_global_lock_mutex);
0079 ACPI_GLOBAL(acpi_semaphore, acpi_gbl_global_lock_semaphore);
0080 ACPI_GLOBAL(acpi_spinlock, acpi_gbl_global_lock_pending_lock);
0081 ACPI_GLOBAL(u16, acpi_gbl_global_lock_handle);
0082 ACPI_GLOBAL(u8, acpi_gbl_global_lock_acquired);
0083 ACPI_GLOBAL(u8, acpi_gbl_global_lock_present);
0084 ACPI_GLOBAL(u8, acpi_gbl_global_lock_pending);
0085
0086 /*
0087  * Spinlocks are used for interfaces that can be possibly called at
0088  * interrupt level
0089  */
0090 ACPI_GLOBAL(acpi_spinlock, acpi_gbl_gpe_lock);  /* For GPE data structs and registers */
0091 ACPI_GLOBAL(acpi_raw_spinlock, acpi_gbl_hardware_lock); /* For ACPI H/W except GPE registers */
0092 ACPI_GLOBAL(acpi_spinlock, acpi_gbl_reference_count_lock);
0093
0094 /* Mutex for _OSI support */
0095
0096 ACPI_GLOBAL(acpi_mutex, acpi_gbl_osi_mutex);
0097
0098 /* Reader/Writer lock is used for namespace walk and dynamic table unload */
0099
0100 ACPI_GLOBAL(struct acpi_rw_lock, acpi_gbl_namespace_rw_lock);
0101
0102 /*****************************************************************************
0103  *
0104  * Miscellaneous globals
0105  *
0106  ****************************************************************************/
0107
0108 /* Object caches */
0109
0110 ACPI_GLOBAL(acpi_cache_t *, acpi_gbl_namespace_cache);
0111 ACPI_GLOBAL(acpi_cache_t *, acpi_gbl_state_cache);
0112 ACPI_GLOBAL(acpi_cache_t *, acpi_gbl_ps_node_cache);
0113 ACPI_GLOBAL(acpi_cache_t *, acpi_gbl_ps_node_ext_cache);
0114 ACPI_GLOBAL(acpi_cache_t *, acpi_gbl_operand_cache);
0115
0116 /* System */
0117
0118 ACPI_INIT_GLOBAL(u32, acpi_gbl_startup_flags, 0);
0119 ACPI_INIT_GLOBAL(u8, acpi_gbl_shutdown, TRUE);
0120 ACPI_INIT_GLOBAL(u8, acpi_gbl_early_initialization, TRUE);
0121
0122 /* Global handlers */
0123
0124 ACPI_GLOBAL(struct acpi_global_notify_handler, acpi_gbl_global_notify[2]);
0125 ACPI_GLOBAL(acpi_exception_handler, acpi_gbl_exception_handler);
0126 ACPI_GLOBAL(acpi_init_handler, acpi_gbl_init_handler);
0127 ACPI_GLOBAL(acpi_table_handler, acpi_gbl_table_handler);
0128 ACPI_GLOBAL(void *, acpi_gbl_table_handler_context);
0129 ACPI_GLOBAL(acpi_interface_handler, acpi_gbl_interface_handler);
0130 ACPI_GLOBAL(struct acpi_sci_handler_info *, acpi_gbl_sci_handler_list);
0131
0132 /* Owner ID support */
0133
0134 ACPI_GLOBAL(u32, acpi_gbl_owner_id_mask[ACPI_NUM_OWNERID_MASKS]);
0135 ACPI_GLOBAL(u8, acpi_gbl_last_owner_id_index);
0136 ACPI_GLOBAL(u8, acpi_gbl_next_owner_id_offset);
0137
0138 /* Initialization sequencing */
0139
0140 ACPI_INIT_GLOBAL(u8, acpi_gbl_namespace_initialized, FALSE);
0141
0142 /* Miscellaneous */
0143
0144 ACPI_GLOBAL(u32, acpi_gbl_original_mode);
0145 ACPI_GLOBAL(u32, acpi_gbl_ns_lookup_count);
0146 ACPI_GLOBAL(u32, acpi_gbl_ps_find_count);
0147 ACPI_GLOBAL(u16, acpi_gbl_pm1_enable_register_save);
0148 ACPI_GLOBAL(u8, acpi_gbl_debugger_configuration);
0149 ACPI_GLOBAL(u8, acpi_gbl_step_to_next_call);
0150 ACPI_GLOBAL(u8, acpi_gbl_acpi_hardware_present);
0151 ACPI_GLOBAL(u8, acpi_gbl_events_initialized);
0152 ACPI_GLOBAL(struct acpi_interface_info *, acpi_gbl_supported_interfaces);
0153 ACPI_GLOBAL(struct acpi_address_range *,
0154         acpi_gbl_address_range_list[ACPI_ADDRESS_RANGE_MAX]);
0155
0156 /* Other miscellaneous, declared and initialized in utglobal */
0157
0158 extern const char *acpi_gbl_sleep_state_names[ACPI_S_STATE_COUNT];
0159 extern const char *acpi_gbl_lowest_dstate_names[ACPI_NUM_sx_w_METHODS];
0160 extern const char *acpi_gbl_highest_dstate_names[ACPI_NUM_sx_d_METHODS];
0161 extern const char *acpi_gbl_region_types[ACPI_NUM_PREDEFINED_REGIONS];
0162 extern const char acpi_gbl_lower_hex_digits[];
0163 extern const char acpi_gbl_upper_hex_digits[];
0164 extern const struct acpi_opcode_info acpi_gbl_aml_op_info[AML_NUM_OPCODES];
0165
0166 /* Lists for tracking memory allocations (debug only) */
0167
0168 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
0169 ACPI_GLOBAL(struct acpi_memory_list *, acpi_gbl_global_list);
0170 ACPI_GLOBAL(struct acpi_memory_list *, acpi_gbl_ns_node_list);
0171 ACPI_GLOBAL(u8, acpi_gbl_display_final_mem_stats);
0172 ACPI_GLOBAL(u8, acpi_gbl_disable_mem_tracking);
0173 ACPI_GLOBAL(u8, acpi_gbl_verbose_leak_dump);
0174 #endif
0175
0176 /*****************************************************************************
0177  *
0178  * ACPI Namespace
0179  *
0180  ****************************************************************************/
0181
0182 #define NUM_PREDEFINED_NAMES            10
0183
0184 ACPI_GLOBAL(struct acpi_namespace_node, acpi_gbl_root_node_struct);
0185 ACPI_GLOBAL(struct acpi_namespace_node *, acpi_gbl_root_node);
0186 ACPI_GLOBAL(struct acpi_namespace_node *, acpi_gbl_fadt_gpe_device);
0187
0188 extern const u8 acpi_gbl_ns_properties[ACPI_NUM_NS_TYPES];
0189 extern const struct acpi_predefined_names
0190     acpi_gbl_pre_defined_names[NUM_PREDEFINED_NAMES];
0191
0192 #ifdef ACPI_DEBUG_OUTPUT
0193 ACPI_GLOBAL(u32, acpi_gbl_current_node_count);
0194 ACPI_GLOBAL(u32, acpi_gbl_current_node_size);
0195 ACPI_GLOBAL(u32, acpi_gbl_max_concurrent_node_count);
0196 ACPI_GLOBAL(acpi_size *, acpi_gbl_entry_stack_pointer);
0197 ACPI_GLOBAL(acpi_size *, acpi_gbl_lowest_stack_pointer);
0198 ACPI_GLOBAL(u32, acpi_gbl_deepest_nesting);
0199 ACPI_INIT_GLOBAL(u32, acpi_gbl_nesting_level, 0);
0200 #endif
0201
0202 /*****************************************************************************
0203  *
0204  * Interpreter/Parser globals
0205  *
0206  ****************************************************************************/
0207
0208 /* Control method single step flag */
0209
0210 ACPI_GLOBAL(u8, acpi_gbl_cm_single_step);
0211 ACPI_GLOBAL(struct acpi_thread_state *, acpi_gbl_current_walk_list);
0212 ACPI_INIT_GLOBAL(union acpi_parse_object, *acpi_gbl_current_scope, NULL);
0213
0214 /* ASL/ASL+ converter */
0215
0216 ACPI_INIT_GLOBAL(u8, acpi_gbl_capture_comments, FALSE);
0217 ACPI_INIT_GLOBAL(struct acpi_comment_node, *acpi_gbl_last_list_head, NULL);
0218
0219 /*****************************************************************************
0220  *
0221  * Hardware globals
0222  *
0223  ****************************************************************************/
0224
0225 extern struct acpi_bit_register_info
0226     acpi_gbl_bit_register_info[ACPI_NUM_BITREG];
0227 ACPI_GLOBAL(u8, acpi_gbl_sleep_type_a);
0228 ACPI_GLOBAL(u8, acpi_gbl_sleep_type_b);
0229 ACPI_GLOBAL(u8, acpi_gbl_sleep_type_a_s0);
0230 ACPI_GLOBAL(u8, acpi_gbl_sleep_type_b_s0);
0231
0232 /*****************************************************************************
0233  *
0234  * Event and GPE globals
0235  *
0236  ****************************************************************************/
0237
0238 #if (!ACPI_REDUCED_HARDWARE)
0239 ACPI_GLOBAL(u8, acpi_gbl_all_gpes_initialized);
0240 ACPI_GLOBAL(struct acpi_gpe_xrupt_info *, acpi_gbl_gpe_xrupt_list_head);
0241 ACPI_GLOBAL(struct acpi_gpe_block_info *,
0242         acpi_gbl_gpe_fadt_blocks[ACPI_MAX_GPE_BLOCKS]);
0243 ACPI_GLOBAL(acpi_gbl_event_handler, acpi_gbl_global_event_handler);
0244 ACPI_GLOBAL(void *, acpi_gbl_global_event_handler_context);
0245 ACPI_GLOBAL(struct acpi_fixed_event_handler,
0246         acpi_gbl_fixed_event_handlers[ACPI_NUM_FIXED_EVENTS]);
0247 extern struct acpi_fixed_event_info
0248     acpi_gbl_fixed_event_info[ACPI_NUM_FIXED_EVENTS];
0249 #endif              /* !ACPI_REDUCED_HARDWARE */
0250
0251 /*****************************************************************************
0252  *
0253  * Debug support
0254  *
0255  ****************************************************************************/
0256
0257 /* Event counters */
0258
0259 ACPI_GLOBAL(u32, acpi_method_count);
0260 ACPI_GLOBAL(u32, acpi_gpe_count);
0261 ACPI_GLOBAL(u32, acpi_sci_count);
0262 ACPI_GLOBAL(u32, acpi_fixed_event_count[ACPI_NUM_FIXED_EVENTS]);
0263
0264 /* Dynamic control method tracing mechanism */
0265
0266 ACPI_GLOBAL(u32, acpi_gbl_original_dbg_level);
0267 ACPI_GLOBAL(u32, acpi_gbl_original_dbg_layer);
0268
0269 /*****************************************************************************
0270  *
0271  * Debugger and Disassembler
0272  *
0273  ****************************************************************************/
0274
0275 ACPI_INIT_GLOBAL(u8, acpi_gbl_db_output_flags, ACPI_DB_CONSOLE_OUTPUT);
0276
0277 #ifdef ACPI_DISASSEMBLER
0278
0279 /* Do not disassemble buffers to resource descriptors */
0280
0281 ACPI_INIT_GLOBAL(u8, acpi_gbl_no_resource_disassembly, FALSE);
0282 ACPI_INIT_GLOBAL(u8, acpi_gbl_ignore_noop_operator, FALSE);
0283 ACPI_INIT_GLOBAL(u8, acpi_gbl_cstyle_disassembly, TRUE);
0284 ACPI_INIT_GLOBAL(u8, acpi_gbl_force_aml_disassembly, FALSE);
0285 ACPI_INIT_GLOBAL(u8, acpi_gbl_dm_opt_verbose, TRUE);
0286 ACPI_INIT_GLOBAL(u8, acpi_gbl_dm_emit_external_opcodes, FALSE);
0287 ACPI_INIT_GLOBAL(u8, acpi_gbl_do_disassembler_optimizations, TRUE);
0288 ACPI_INIT_GLOBAL(ACPI_PARSE_OBJECT_LIST, *acpi_gbl_temp_list_head, NULL);
0289
0290 ACPI_GLOBAL(u8, acpi_gbl_dm_opt_disasm);
0291 ACPI_GLOBAL(u8, acpi_gbl_dm_opt_listing);
0292 ACPI_GLOBAL(u8, acpi_gbl_num_external_methods);
0293 ACPI_GLOBAL(u32, acpi_gbl_resolved_external_methods);
0294 ACPI_GLOBAL(struct acpi_external_list *, acpi_gbl_external_list);
0295 ACPI_GLOBAL(struct acpi_external_file *, acpi_gbl_external_file_list);
0296 #endif
0297
0298 #ifdef ACPI_DEBUGGER
0299 ACPI_INIT_GLOBAL(u8, acpi_gbl_abort_method, FALSE);
0300 ACPI_INIT_GLOBAL(acpi_thread_id, acpi_gbl_db_thread_id, ACPI_INVALID_THREAD_ID);
0301 ACPI_INIT_GLOBAL(u32, acpi_gbl_next_cmd_num, 1);
0302
0303 ACPI_GLOBAL(u8, acpi_gbl_db_opt_no_ini_methods);
0304 ACPI_GLOBAL(u8, acpi_gbl_db_opt_no_region_support);
0305 ACPI_GLOBAL(u8, acpi_gbl_db_output_to_file);
0306 ACPI_GLOBAL(char *, acpi_gbl_db_buffer);
0307 ACPI_GLOBAL(char *, acpi_gbl_db_filename);
0308 ACPI_GLOBAL(u32, acpi_gbl_db_debug_level);
0309 ACPI_GLOBAL(u32, acpi_gbl_db_console_debug_level);
0310 ACPI_GLOBAL(struct acpi_namespace_node *, acpi_gbl_db_scope_node);
0311 ACPI_GLOBAL(u8, acpi_gbl_db_terminate_loop);
0312 ACPI_GLOBAL(u8, acpi_gbl_db_threads_terminated);
0313 ACPI_GLOBAL(char *, acpi_gbl_db_args[ACPI_DEBUGGER_MAX_ARGS]);
0314 ACPI_GLOBAL(acpi_object_type, acpi_gbl_db_arg_types[ACPI_DEBUGGER_MAX_ARGS]);
0315
0316 /* These buffers should all be the same size */
0317
0318 ACPI_GLOBAL(char, acpi_gbl_db_parsed_buf[ACPI_DB_LINE_BUFFER_SIZE]);
0319 ACPI_GLOBAL(char, acpi_gbl_db_scope_buf[ACPI_DB_LINE_BUFFER_SIZE]);
0320 ACPI_GLOBAL(char, acpi_gbl_db_debug_filename[ACPI_DB_LINE_BUFFER_SIZE]);
0321
0322 /* Statistics globals */
0323
0324 ACPI_GLOBAL(u16, acpi_gbl_obj_type_count[ACPI_TOTAL_TYPES]);
0325 ACPI_GLOBAL(u16, acpi_gbl_node_type_count[ACPI_TOTAL_TYPES]);
0326 ACPI_GLOBAL(u16, acpi_gbl_obj_type_count_misc);
0327 ACPI_GLOBAL(u16, acpi_gbl_node_type_count_misc);
0328 ACPI_GLOBAL(u32, acpi_gbl_num_nodes);
0329 ACPI_GLOBAL(u32, acpi_gbl_num_objects);
0330 #endif              /* ACPI_DEBUGGER */
0331
0332 #if defined (ACPI_DISASSEMBLER) || defined (ACPI_ASL_COMPILER)
0333 ACPI_GLOBAL(const char, *acpi_gbl_pld_panel_list[]);
0334 ACPI_GLOBAL(const char, *acpi_gbl_pld_vertical_position_list[]);
0335 ACPI_GLOBAL(const char, *acpi_gbl_pld_horizontal_position_list[]);
0336 ACPI_GLOBAL(const char, *acpi_gbl_pld_shape_list[]);
0337 ACPI_INIT_GLOBAL(u8, acpi_gbl_disasm_flag, FALSE);
0338 #endif
0339
0340 /*****************************************************************************
0341  *
0342  * ACPICA application-specific globals
0343  *
0344  ****************************************************************************/
0345
0346 /* ASL-to-ASL+ conversion utility (implemented within the iASL compiler) */
0347
0348 #ifdef ACPI_ASL_COMPILER
0349 ACPI_INIT_GLOBAL(char *, acpi_gbl_current_inline_comment, NULL);
0350 ACPI_INIT_GLOBAL(char *, acpi_gbl_current_end_node_comment, NULL);
0351 ACPI_INIT_GLOBAL(char *, acpi_gbl_current_open_brace_comment, NULL);
0352 ACPI_INIT_GLOBAL(char *, acpi_gbl_current_close_brace_comment, NULL);
0353
0354 ACPI_INIT_GLOBAL(char *, acpi_gbl_root_filename, NULL);
0355 ACPI_INIT_GLOBAL(char *, acpi_gbl_current_filename, NULL);
0356 ACPI_INIT_GLOBAL(char *, acpi_gbl_current_parent_filename, NULL);
0357 ACPI_INIT_GLOBAL(char *, acpi_gbl_current_include_filename, NULL);
0358
0359 ACPI_INIT_GLOBAL(struct acpi_comment_node, *acpi_gbl_def_blk_comment_list_head,
0360          NULL);
0361 ACPI_INIT_GLOBAL(struct acpi_comment_node, *acpi_gbl_def_blk_comment_list_tail,
0362          NULL);
0363 ACPI_INIT_GLOBAL(struct acpi_comment_node, *acpi_gbl_reg_comment_list_head,
0364          NULL);
0365 ACPI_INIT_GLOBAL(struct acpi_comment_node, *acpi_gbl_reg_comment_list_tail,
0366          NULL);
0367 ACPI_INIT_GLOBAL(struct acpi_comment_node, *acpi_gbl_inc_comment_list_head,
0368          NULL);
0369 ACPI_INIT_GLOBAL(struct acpi_comment_node, *acpi_gbl_inc_comment_list_tail,
0370          NULL);
0371 ACPI_INIT_GLOBAL(struct acpi_comment_node, *acpi_gbl_end_blk_comment_list_head,
0372          NULL);
0373 ACPI_INIT_GLOBAL(struct acpi_comment_node, *acpi_gbl_end_blk_comment_list_tail,
0374          NULL);
0375
0376 ACPI_INIT_GLOBAL(struct acpi_comment_addr_node,
0377          *acpi_gbl_comment_addr_list_head, NULL);
0378 ACPI_INIT_GLOBAL(struct acpi_file_node, *acpi_gbl_file_tree_root, NULL);
0379
0380 ACPI_GLOBAL(acpi_cache_t *, acpi_gbl_reg_comment_cache);
0381 ACPI_GLOBAL(acpi_cache_t *, acpi_gbl_comment_addr_cache);
0382 ACPI_GLOBAL(acpi_cache_t *, acpi_gbl_file_cache);
0383
0384 ACPI_INIT_GLOBAL(u8, acpi_gbl_debug_asl_conversion, FALSE);
0385 ACPI_INIT_GLOBAL(ACPI_FILE, acpi_gbl_conv_debug_file, NULL);
0386 ACPI_GLOBAL(char, acpi_gbl_table_sig[4]);
0387 #endif
0388
0389 #ifdef ACPI_APPLICATION
0390 ACPI_INIT_GLOBAL(ACPI_FILE, acpi_gbl_debug_file, NULL);
0391 ACPI_INIT_GLOBAL(ACPI_FILE, acpi_gbl_output_file, NULL);
0392 ACPI_INIT_GLOBAL(u8, acpi_gbl_debug_timeout, FALSE);
0393
0394 /* Print buffer */
0395
0396 ACPI_GLOBAL(acpi_spinlock, acpi_gbl_print_lock);    /* For print buffer */
0397 ACPI_GLOBAL(char, acpi_gbl_print_buffer[1024]);
0398 #endif              /* ACPI_APPLICATION */
0399
0400 #endif              /* __ACGLOBAL_H__ */