drivers/acpi/acpica/acglobal.h

   1 /******************************************************************************
   2  *
   3  * Name: acglobal.h - Declarations for global variables
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2011, 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  * 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 #ifdef DEFINE_ACPI_GLOBALS
  62
  63 /* Public globals, available from outside ACPICA subsystem */
  64
  65 /*****************************************************************************
  66  *
  67  * Runtime configuration (static defaults that can be overriden at runtime)
  68  *
  69  ****************************************************************************/
  70
  71 /*
  72  * Enable "slack" in the AML interpreter?  Default is FALSE, and the
  73  * interpreter strictly follows the ACPI specification.  Setting to TRUE
  74  * allows the interpreter to ignore certain errors and/or bad AML constructs.
  75  *
  76  * Currently, these features are enabled by this flag:
  77  *
  78  * 1) Allow "implicit return" of last value in a control method
  79  * 2) Allow access beyond the end of an operation region
  80  * 3) Allow access to uninitialized locals/args (auto-init to integer 0)
  81  * 4) Allow ANY object type to be a source operand for the Store() operator
  82  * 5) Allow unresolved references (invalid target name) in package objects
  83  * 6) Enable warning messages for behavior that is not ACPI spec compliant
  84  */
  85 u8 ACPI_INIT_GLOBAL(acpi_gbl_enable_interpreter_slack, FALSE);
  86
  87 /*
  88  * Automatically serialize ALL control methods? Default is FALSE, meaning
  89  * to use the Serialized/not_serialized method flags on a per method basis.
  90  * Only change this if the ASL code is poorly written and cannot handle
  91  * reentrancy even though methods are marked "NotSerialized".
  92  */
  93 u8 ACPI_INIT_GLOBAL(acpi_gbl_all_methods_serialized, FALSE);
  94
  95 /*
  96  * Create the predefined _OSI method in the namespace? Default is TRUE
  97  * because ACPI CA is fully compatible with other ACPI implementations.
  98  * Changing this will revert ACPI CA (and machine ASL) to pre-OSI behavior.
  99  */
 100 u8 ACPI_INIT_GLOBAL(acpi_gbl_create_osi_method, TRUE);
 101
 102 /*
 103  * Optionally use default values for the ACPI register widths. Set this to
 104  * TRUE to use the defaults, if an FADT contains incorrect widths/lengths.
 105  */
 106 u8 ACPI_INIT_GLOBAL(acpi_gbl_use_default_register_widths, TRUE);
 107
 108 /*
 109  * Optionally enable output from the AML Debug Object.
 110  */
 111 u32 ACPI_INIT_GLOBAL(acpi_gbl_enable_aml_debug_object, FALSE);
 112
 113 /*
 114  * Optionally copy the entire DSDT to local memory (instead of simply
 115  * mapping it.) There are some BIOSs that corrupt or replace the original
 116  * DSDT, creating the need for this option. Default is FALSE, do not copy
 117  * the DSDT.
 118  */
 119 u8 ACPI_INIT_GLOBAL(acpi_gbl_copy_dsdt_locally, FALSE);
 120
 121 /*
 122  * Optionally truncate I/O addresses to 16 bits. Provides compatibility
 123  * with other ACPI implementations. NOTE: During ACPICA initialization,
 124  * this value is set to TRUE if any Windows OSI strings have been
 125  * requested by the BIOS.
 126  */
 127 u8 ACPI_INIT_GLOBAL(acpi_gbl_truncate_io_addresses, FALSE);
 128
 129 /* acpi_gbl_FADT is a local copy of the FADT, converted to a common format. */
 130
 131 struct acpi_table_fadt acpi_gbl_FADT;
 132 u32 acpi_current_gpe_count;
 133 u32 acpi_gbl_trace_flags;
 134 acpi_name acpi_gbl_trace_method_name;
 135 u8 acpi_gbl_system_awake_and_running;
 136
 137 #endif
 138
 139 /*****************************************************************************
 140  *
 141  * Debug support
 142  *
 143  ****************************************************************************/
 144
 145 /* Procedure nesting level for debug output */
 146
 147 extern u32 acpi_gbl_nesting_level;
 148
 149 ACPI_EXTERN u32 acpi_gpe_count;
 150 ACPI_EXTERN u32 acpi_fixed_event_count[ACPI_NUM_FIXED_EVENTS];
 151
 152 /* Support for dynamic control method tracing mechanism */
 153
 154 ACPI_EXTERN u32 acpi_gbl_original_dbg_level;
 155 ACPI_EXTERN u32 acpi_gbl_original_dbg_layer;
 156 ACPI_EXTERN u32 acpi_gbl_trace_dbg_level;
 157 ACPI_EXTERN u32 acpi_gbl_trace_dbg_layer;
 158
 159 /*****************************************************************************
 160  *
 161  * ACPI Table globals
 162  *
 163  ****************************************************************************/
 164
 165 /*
 166  * acpi_gbl_root_table_list is the master list of ACPI tables that were
 167  * found in the RSDT/XSDT.
 168  */
 169 ACPI_EXTERN struct acpi_table_list acpi_gbl_root_table_list;
 170 ACPI_EXTERN struct acpi_table_facs *acpi_gbl_FACS;
 171
 172 /* These addresses are calculated from the FADT Event Block addresses */
 173
 174 ACPI_EXTERN struct acpi_generic_address acpi_gbl_xpm1a_status;
 175 ACPI_EXTERN struct acpi_generic_address acpi_gbl_xpm1a_enable;
 176
 177 ACPI_EXTERN struct acpi_generic_address acpi_gbl_xpm1b_status;
 178 ACPI_EXTERN struct acpi_generic_address acpi_gbl_xpm1b_enable;
 179
 180 /* DSDT information. Used to check for DSDT corruption */
 181
 182 ACPI_EXTERN struct acpi_table_header *acpi_gbl_DSDT;
 183 ACPI_EXTERN struct acpi_table_header acpi_gbl_original_dsdt_header;
 184
 185 /*
 186  * Handle both ACPI 1.0 and ACPI 2.0 Integer widths. The integer width is
 187  * determined by the revision of the DSDT: If the DSDT revision is less than
 188  * 2, use only the lower 32 bits of the internal 64-bit Integer.
 189  */
 190 ACPI_EXTERN u8 acpi_gbl_integer_bit_width;
 191 ACPI_EXTERN u8 acpi_gbl_integer_byte_width;
 192 ACPI_EXTERN u8 acpi_gbl_integer_nybble_width;
 193
 194 /* Mutex for _OSI support */
 195
 196 ACPI_EXTERN acpi_mutex acpi_gbl_osi_mutex;
 197
 198 /* Reader/Writer lock is used for namespace walk and dynamic table unload */
 199
 200 ACPI_EXTERN struct acpi_rw_lock acpi_gbl_namespace_rw_lock;
 201
 202 /*****************************************************************************
 203  *
 204  * Mutual exlusion within ACPICA subsystem
 205  *
 206  ****************************************************************************/
 207
 208 /*
 209  * Predefined mutex objects. This array contains the
 210  * actual OS mutex handles, indexed by the local ACPI_MUTEX_HANDLEs.
 211  * (The table maps local handles to the real OS handles)
 212  */
 213 ACPI_EXTERN struct acpi_mutex_info acpi_gbl_mutex_info[ACPI_NUM_MUTEX];
 214
 215 /*
 216  * Global lock mutex is an actual AML mutex object
 217  * Global lock semaphore works in conjunction with the HW global lock
 218  */
 219 ACPI_EXTERN union acpi_operand_object *acpi_gbl_global_lock_mutex;
 220 ACPI_EXTERN acpi_semaphore acpi_gbl_global_lock_semaphore;
 221 ACPI_EXTERN u16 acpi_gbl_global_lock_handle;
 222 ACPI_EXTERN u8 acpi_gbl_global_lock_acquired;
 223 ACPI_EXTERN u8 acpi_gbl_global_lock_present;
 224
 225 /*
 226  * Spinlocks are used for interfaces that can be possibly called at
 227  * interrupt level
 228  */
 229 ACPI_EXTERN spinlock_t _acpi_gbl_gpe_lock;      /* For GPE data structs and registers */
 230 ACPI_EXTERN spinlock_t _acpi_gbl_hardware_lock; /* For ACPI H/W except GPE registers */
 231 ACPI_EXTERN spinlock_t _acpi_ev_global_lock_pending_lock; /* For global lock */
 232 #define acpi_gbl_gpe_lock       &_acpi_gbl_gpe_lock
 233 #define acpi_gbl_hardware_lock  &_acpi_gbl_hardware_lock
 234 #define acpi_ev_global_lock_pending_lock &_acpi_ev_global_lock_pending_lock
 235
 236 /*****************************************************************************
 237  *
 238  * Miscellaneous globals
 239  *
 240  ****************************************************************************/
 241
 242 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
 243
 244 /* Lists for tracking memory allocations */
 245
 246 ACPI_EXTERN struct acpi_memory_list *acpi_gbl_global_list;
 247 ACPI_EXTERN struct acpi_memory_list *acpi_gbl_ns_node_list;
 248 ACPI_EXTERN u8 acpi_gbl_display_final_mem_stats;
 249 #endif
 250
 251 /* Object caches */
 252
 253 ACPI_EXTERN acpi_cache_t *acpi_gbl_namespace_cache;
 254 ACPI_EXTERN acpi_cache_t *acpi_gbl_state_cache;
 255 ACPI_EXTERN acpi_cache_t *acpi_gbl_ps_node_cache;
 256 ACPI_EXTERN acpi_cache_t *acpi_gbl_ps_node_ext_cache;
 257 ACPI_EXTERN acpi_cache_t *acpi_gbl_operand_cache;
 258
 259 /* Global handlers */
 260
 261 ACPI_EXTERN struct acpi_object_notify_handler acpi_gbl_device_notify;
 262 ACPI_EXTERN struct acpi_object_notify_handler acpi_gbl_system_notify;
 263 ACPI_EXTERN acpi_exception_handler acpi_gbl_exception_handler;
 264 ACPI_EXTERN acpi_init_handler acpi_gbl_init_handler;
 265 ACPI_EXTERN acpi_tbl_handler acpi_gbl_table_handler;
 266 ACPI_EXTERN void *acpi_gbl_table_handler_context;
 267 ACPI_EXTERN struct acpi_walk_state *acpi_gbl_breakpoint_walk;
 268 ACPI_EXTERN acpi_interface_handler acpi_gbl_interface_handler;
 269
 270 /* Owner ID support */
 271
 272 ACPI_EXTERN u32 acpi_gbl_owner_id_mask[ACPI_NUM_OWNERID_MASKS];
 273 ACPI_EXTERN u8 acpi_gbl_last_owner_id_index;
 274 ACPI_EXTERN u8 acpi_gbl_next_owner_id_offset;
 275
 276 /* Misc */
 277
 278 ACPI_EXTERN u32 acpi_gbl_original_mode;
 279 ACPI_EXTERN u32 acpi_gbl_rsdp_original_location;
 280 ACPI_EXTERN u32 acpi_gbl_ns_lookup_count;
 281 ACPI_EXTERN u32 acpi_gbl_ps_find_count;
 282 ACPI_EXTERN u16 acpi_gbl_pm1_enable_register_save;
 283 ACPI_EXTERN u8 acpi_gbl_debugger_configuration;
 284 ACPI_EXTERN u8 acpi_gbl_step_to_next_call;
 285 ACPI_EXTERN u8 acpi_gbl_acpi_hardware_present;
 286 ACPI_EXTERN u8 acpi_gbl_events_initialized;
 287 ACPI_EXTERN u8 acpi_gbl_osi_data;
 288 ACPI_EXTERN struct acpi_interface_info *acpi_gbl_supported_interfaces;
 289
 290 #ifndef DEFINE_ACPI_GLOBALS
 291
 292 /* Other miscellaneous */
 293
 294 extern u8 acpi_gbl_shutdown;
 295 extern u32 acpi_gbl_startup_flags;
 296 extern const char *acpi_gbl_sleep_state_names[ACPI_S_STATE_COUNT];
 297 extern const char *acpi_gbl_lowest_dstate_names[ACPI_NUM_sx_w_METHODS];
 298 extern const char *acpi_gbl_highest_dstate_names[ACPI_NUM_sx_d_METHODS];
 299 extern const struct acpi_opcode_info acpi_gbl_aml_op_info[AML_NUM_OPCODES];
 300 extern const char *acpi_gbl_region_types[ACPI_NUM_PREDEFINED_REGIONS];
 301
 302 #endif
 303
 304 /* Exception codes */
 305
 306 extern char const *acpi_gbl_exception_names_env[];
 307 extern char const *acpi_gbl_exception_names_pgm[];
 308 extern char const *acpi_gbl_exception_names_tbl[];
 309 extern char const *acpi_gbl_exception_names_aml[];
 310 extern char const *acpi_gbl_exception_names_ctrl[];
 311
 312 /*****************************************************************************
 313  *
 314  * Namespace globals
 315  *
 316  ****************************************************************************/
 317
 318 #if !defined (ACPI_NO_METHOD_EXECUTION) || defined (ACPI_CONSTANT_EVAL_ONLY)
 319 #define NUM_PREDEFINED_NAMES            10
 320 #else
 321 #define NUM_PREDEFINED_NAMES            9
 322 #endif
 323
 324 ACPI_EXTERN struct acpi_namespace_node acpi_gbl_root_node_struct;
 325 ACPI_EXTERN struct acpi_namespace_node *acpi_gbl_root_node;
 326 ACPI_EXTERN struct acpi_namespace_node *acpi_gbl_fadt_gpe_device;
 327 ACPI_EXTERN union acpi_operand_object *acpi_gbl_module_code_list;
 328
 329 extern const u8 acpi_gbl_ns_properties[ACPI_NUM_NS_TYPES];
 330 extern const struct acpi_predefined_names
 331     acpi_gbl_pre_defined_names[NUM_PREDEFINED_NAMES];
 332
 333 #ifdef ACPI_DEBUG_OUTPUT
 334 ACPI_EXTERN u32 acpi_gbl_current_node_count;
 335 ACPI_EXTERN u32 acpi_gbl_current_node_size;
 336 ACPI_EXTERN u32 acpi_gbl_max_concurrent_node_count;
 337 ACPI_EXTERN acpi_size *acpi_gbl_entry_stack_pointer;
 338 ACPI_EXTERN acpi_size *acpi_gbl_lowest_stack_pointer;
 339 ACPI_EXTERN u32 acpi_gbl_deepest_nesting;
 340 #endif
 341
 342 /*****************************************************************************
 343  *
 344  * Interpreter globals
 345  *
 346  ****************************************************************************/
 347
 348 ACPI_EXTERN struct acpi_thread_state *acpi_gbl_current_walk_list;
 349
 350 /* Control method single step flag */
 351
 352 ACPI_EXTERN u8 acpi_gbl_cm_single_step;
 353
 354 /*****************************************************************************
 355  *
 356  * Hardware globals
 357  *
 358  ****************************************************************************/
 359
 360 extern struct acpi_bit_register_info
 361     acpi_gbl_bit_register_info[ACPI_NUM_BITREG];
 362 ACPI_EXTERN u8 acpi_gbl_sleep_type_a;
 363 ACPI_EXTERN u8 acpi_gbl_sleep_type_b;
 364
 365 /*****************************************************************************
 366  *
 367  * Event and GPE globals
 368  *
 369  ****************************************************************************/
 370
 371 extern struct acpi_fixed_event_info
 372     acpi_gbl_fixed_event_info[ACPI_NUM_FIXED_EVENTS];
 373 ACPI_EXTERN struct acpi_fixed_event_handler
 374     acpi_gbl_fixed_event_handlers[ACPI_NUM_FIXED_EVENTS];
 375 ACPI_EXTERN struct acpi_gpe_xrupt_info *acpi_gbl_gpe_xrupt_list_head;
 376 ACPI_EXTERN struct acpi_gpe_block_info
 377 *acpi_gbl_gpe_fadt_blocks[ACPI_MAX_GPE_BLOCKS];
 378 ACPI_EXTERN u8 acpi_gbl_all_gpes_initialized;
 379 ACPI_EXTERN ACPI_GBL_EVENT_HANDLER acpi_gbl_global_event_handler;
 380 ACPI_EXTERN void *acpi_gbl_global_event_handler_context;
 381
 382 /*****************************************************************************
 383  *
 384  * Debugger globals
 385  *
 386  ****************************************************************************/
 387
 388 ACPI_EXTERN u8 acpi_gbl_db_output_flags;
 389
 390 #ifdef ACPI_DISASSEMBLER
 391
 392 ACPI_EXTERN u8 acpi_gbl_db_opt_disasm;
 393 ACPI_EXTERN u8 acpi_gbl_db_opt_verbose;
 394 #endif
 395
 396 #ifdef ACPI_DEBUGGER
 397
 398 extern u8 acpi_gbl_method_executing;
 399 extern u8 acpi_gbl_abort_method;
 400 extern u8 acpi_gbl_db_terminate_threads;
 401
 402 ACPI_EXTERN u8 acpi_gbl_db_opt_tables;
 403 ACPI_EXTERN u8 acpi_gbl_db_opt_stats;
 404 ACPI_EXTERN u8 acpi_gbl_db_opt_ini_methods;
 405
 406 ACPI_EXTERN char *acpi_gbl_db_args[ACPI_DEBUGGER_MAX_ARGS];
 407 ACPI_EXTERN char acpi_gbl_db_line_buf[80];
 408 ACPI_EXTERN char acpi_gbl_db_parsed_buf[80];
 409 ACPI_EXTERN char acpi_gbl_db_scope_buf[40];
 410 ACPI_EXTERN char acpi_gbl_db_debug_filename[40];
 411 ACPI_EXTERN u8 acpi_gbl_db_output_to_file;
 412 ACPI_EXTERN char *acpi_gbl_db_buffer;
 413 ACPI_EXTERN char *acpi_gbl_db_filename;
 414 ACPI_EXTERN u32 acpi_gbl_db_debug_level;
 415 ACPI_EXTERN u32 acpi_gbl_db_console_debug_level;
 416 ACPI_EXTERN struct acpi_namespace_node *acpi_gbl_db_scope_node;
 417
 418 /*
 419  * Statistic globals
 420  */
 421 ACPI_EXTERN u16 acpi_gbl_obj_type_count[ACPI_TYPE_NS_NODE_MAX + 1];
 422 ACPI_EXTERN u16 acpi_gbl_node_type_count[ACPI_TYPE_NS_NODE_MAX + 1];
 423 ACPI_EXTERN u16 acpi_gbl_obj_type_count_misc;
 424 ACPI_EXTERN u16 acpi_gbl_node_type_count_misc;
 425 ACPI_EXTERN u32 acpi_gbl_num_nodes;
 426 ACPI_EXTERN u32 acpi_gbl_num_objects;
 427
 428 ACPI_EXTERN u32 acpi_gbl_size_of_parse_tree;
 429 ACPI_EXTERN u32 acpi_gbl_size_of_method_trees;
 430 ACPI_EXTERN u32 acpi_gbl_size_of_node_entries;
 431 ACPI_EXTERN u32 acpi_gbl_size_of_acpi_objects;
 432
 433 #endif                          /* ACPI_DEBUGGER */
 434
 435 #endif                          /* __ACGLOBAL_H__ */