include/acpi/acglobal.h

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