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 /* Event counters */
  84
  85 ACPI_EXTERN u32 acpi_gpe_count;
  86
  87 /* Support for dynamic control method tracing mechanism */
  88
  89 ACPI_EXTERN u32 acpi_gbl_original_dbg_level;
  90 ACPI_EXTERN u32 acpi_gbl_original_dbg_layer;
  91 ACPI_EXTERN acpi_name acpi_gbl_trace_method_name;
  92 ACPI_EXTERN u32 acpi_gbl_trace_dbg_level;
  93 ACPI_EXTERN u32 acpi_gbl_trace_dbg_layer;
  94 ACPI_EXTERN u32 acpi_gbl_trace_flags;
  95
  96 /*****************************************************************************
  97  *
  98  * Runtime configuration (static defaults that can be overriden at runtime)
  99  *
 100  ****************************************************************************/
 101
 102 /*
 103  * Enable "slack" in the AML interpreter?  Default is FALSE, and the
 104  * interpreter strictly follows the ACPI specification.  Setting to TRUE
 105  * allows the interpreter to ignore certain errors and/or bad AML constructs.
 106  *
 107  * Currently, these features are enabled by this flag:
 108  *
 109  * 1) Allow "implicit return" of last value in a control method
 110  * 2) Allow access beyond the end of an operation region
 111  * 3) Allow access to uninitialized locals/args (auto-init to integer 0)
 112  * 4) Allow ANY object type to be a source operand for the Store() operator
 113  * 5) Allow unresolved references (invalid target name) in package objects
 114  * 6) Enable warning messages for behavior that is not ACPI spec compliant
 115  */
 116 ACPI_EXTERN u8 ACPI_INIT_GLOBAL(acpi_gbl_enable_interpreter_slack, FALSE);
 117
 118 /*
 119  * Automatically serialize ALL control methods? Default is FALSE, meaning
 120  * to use the Serialized/not_serialized method flags on a per method basis.
 121  * Only change this if the ASL code is poorly written and cannot handle
 122  * reentrancy even though methods are marked "NotSerialized".
 123  */
 124 ACPI_EXTERN u8 ACPI_INIT_GLOBAL(acpi_gbl_all_methods_serialized, FALSE);
 125
 126 /*
 127  * Create the predefined _OSI method in the namespace? Default is TRUE
 128  * because ACPI CA is fully compatible with other ACPI implementations.
 129  * Changing this will revert ACPI CA (and machine ASL) to pre-OSI behavior.
 130  */
 131 ACPI_EXTERN u8 ACPI_INIT_GLOBAL(acpi_gbl_create_osi_method, TRUE);
 132
 133 /*
 134  * Disable wakeup GPEs during runtime? Default is TRUE because WAKE and
 135  * RUNTIME GPEs should never be shared, and WAKE GPEs should typically only
 136  * be enabled just before going to sleep.
 137  */
 138 ACPI_EXTERN u8 ACPI_INIT_GLOBAL(acpi_gbl_leave_wake_gpes_disabled, TRUE);
 139
 140 /*****************************************************************************
 141  *
 142  * ACPI Table globals
 143  *
 144  ****************************************************************************/
 145
 146 /*
 147  * acpi_gbl_root_table_list is the master list of ACPI tables found in the
 148  * RSDT/XSDT.
 149  *
 150  * acpi_gbl_FADT is a local copy of the FADT, converted to a common format.
 151  */
 152 ACPI_EXTERN struct acpi_internal_rsdt acpi_gbl_root_table_list;
 153 ACPI_EXTERN struct acpi_table_fadt acpi_gbl_FADT;
 154 #define acpi_fadt acpi_gbl_FADT
 155 extern acpi_native_uint acpi_gbl_permanent_mmap;
 156
 157 /*
 158  * Handle both ACPI 1.0 and ACPI 2.0 Integer widths. The integer width is
 159  * determined by the revision of the DSDT: If the DSDT revision is less than
 160  * 2, use only the lower 32 bits of the internal 64-bit Integer.
 161  */
 162 ACPI_EXTERN u8 acpi_gbl_integer_bit_width;
 163 ACPI_EXTERN u8 acpi_gbl_integer_byte_width;
 164 ACPI_EXTERN u8 acpi_gbl_integer_nybble_width;
 165
 166 /*****************************************************************************
 167  *
 168  * Mutual exlusion within ACPICA subsystem
 169  *
 170  ****************************************************************************/
 171
 172 /*
 173  * Predefined mutex objects. This array contains the
 174  * actual OS mutex handles, indexed by the local ACPI_MUTEX_HANDLEs.
 175  * (The table maps local handles to the real OS handles)
 176  */
 177 ACPI_EXTERN struct acpi_mutex_info acpi_gbl_mutex_info[ACPI_NUM_MUTEX];
 178
 179 /*
 180  * Global lock semaphore works in conjunction with the actual HW global lock
 181  */
 182 ACPI_EXTERN acpi_mutex acpi_gbl_global_lock_mutex;
 183 ACPI_EXTERN acpi_semaphore acpi_gbl_global_lock_semaphore;
 184
 185 /*
 186  * Spinlocks are used for interfaces that can be possibly called at
 187  * interrupt level
 188  */
 189 ACPI_EXTERN spinlock_t _acpi_gbl_gpe_lock;      /* For GPE data structs and registers */
 190 ACPI_EXTERN spinlock_t _acpi_gbl_hardware_lock; /* For ACPI H/W except GPE registers */
 191 #define acpi_gbl_gpe_lock       &_acpi_gbl_gpe_lock
 192 #define acpi_gbl_hardware_lock  &_acpi_gbl_hardware_lock
 193
 194 /*****************************************************************************
 195  *
 196  * Miscellaneous globals
 197  *
 198  ****************************************************************************/
 199
 200 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
 201
 202 /* Lists for tracking memory allocations */
 203
 204 ACPI_EXTERN struct acpi_memory_list *acpi_gbl_global_list;
 205 ACPI_EXTERN struct acpi_memory_list *acpi_gbl_ns_node_list;
 206 #endif
 207
 208 /* Object caches */
 209
 210 ACPI_EXTERN acpi_cache_t *acpi_gbl_namespace_cache;
 211 ACPI_EXTERN acpi_cache_t *acpi_gbl_state_cache;
 212 ACPI_EXTERN acpi_cache_t *acpi_gbl_ps_node_cache;
 213 ACPI_EXTERN acpi_cache_t *acpi_gbl_ps_node_ext_cache;
 214 ACPI_EXTERN acpi_cache_t *acpi_gbl_operand_cache;
 215
 216 /* Global handlers */
 217
 218 ACPI_EXTERN struct acpi_object_notify_handler acpi_gbl_device_notify;
 219 ACPI_EXTERN struct acpi_object_notify_handler acpi_gbl_system_notify;
 220 ACPI_EXTERN acpi_exception_handler acpi_gbl_exception_handler;
 221 ACPI_EXTERN acpi_init_handler acpi_gbl_init_handler;
 222 ACPI_EXTERN struct acpi_walk_state *acpi_gbl_breakpoint_walk;
 223
 224 /* Misc */
 225
 226 ACPI_EXTERN u32 acpi_gbl_original_mode;
 227 ACPI_EXTERN u32 acpi_gbl_rsdp_original_location;
 228 ACPI_EXTERN u32 acpi_gbl_ns_lookup_count;
 229 ACPI_EXTERN u32 acpi_gbl_ps_find_count;
 230 ACPI_EXTERN u32 acpi_gbl_owner_id_mask[ACPI_NUM_OWNERID_MASKS];
 231 ACPI_EXTERN u16 acpi_gbl_pm1_enable_register_save;
 232 ACPI_EXTERN u16 acpi_gbl_global_lock_handle;
 233 ACPI_EXTERN u8 acpi_gbl_last_owner_id_index;
 234 ACPI_EXTERN u8 acpi_gbl_next_owner_id_offset;
 235 ACPI_EXTERN u8 acpi_gbl_debugger_configuration;
 236 ACPI_EXTERN u8 acpi_gbl_global_lock_acquired;
 237 ACPI_EXTERN u8 acpi_gbl_step_to_next_call;
 238 ACPI_EXTERN u8 acpi_gbl_acpi_hardware_present;
 239 ACPI_EXTERN u8 acpi_gbl_global_lock_present;
 240 ACPI_EXTERN u8 acpi_gbl_events_initialized;
 241 ACPI_EXTERN u8 acpi_gbl_system_awake_and_running;
 242
 243 extern u8 acpi_gbl_shutdown;
 244 extern u32 acpi_gbl_startup_flags;
 245 extern const u8 acpi_gbl_decode_to8bit[8];
 246 extern const char *acpi_gbl_sleep_state_names[ACPI_S_STATE_COUNT];
 247 extern const char *acpi_gbl_highest_dstate_names[4];
 248 extern const struct acpi_opcode_info acpi_gbl_aml_op_info[AML_NUM_OPCODES];
 249 extern const char *acpi_gbl_region_types[ACPI_NUM_PREDEFINED_REGIONS];
 250
 251 /*****************************************************************************
 252  *
 253  * Namespace globals
 254  *
 255  ****************************************************************************/
 256
 257 #define NUM_NS_TYPES                    ACPI_TYPE_INVALID+1
 258
 259 #if !defined (ACPI_NO_METHOD_EXECUTION) || defined (ACPI_CONSTANT_EVAL_ONLY)
 260 #define NUM_PREDEFINED_NAMES            10
 261 #else
 262 #define NUM_PREDEFINED_NAMES            9
 263 #endif
 264
 265 ACPI_EXTERN struct acpi_namespace_node acpi_gbl_root_node_struct;
 266 ACPI_EXTERN struct acpi_namespace_node *acpi_gbl_root_node;
 267 ACPI_EXTERN struct acpi_namespace_node *acpi_gbl_fadt_gpe_device;
 268
 269 extern const u8 acpi_gbl_ns_properties[NUM_NS_TYPES];
 270 extern const struct acpi_predefined_names
 271     acpi_gbl_pre_defined_names[NUM_PREDEFINED_NAMES];
 272
 273 #ifdef ACPI_DEBUG_OUTPUT
 274 ACPI_EXTERN u32 acpi_gbl_current_node_count;
 275 ACPI_EXTERN u32 acpi_gbl_current_node_size;
 276 ACPI_EXTERN u32 acpi_gbl_max_concurrent_node_count;
 277 ACPI_EXTERN acpi_size acpi_gbl_entry_stack_pointer;
 278 ACPI_EXTERN acpi_size acpi_gbl_lowest_stack_pointer;
 279 ACPI_EXTERN u32 acpi_gbl_deepest_nesting;
 280 #endif
 281
 282 /*****************************************************************************
 283  *
 284  * Interpreter globals
 285  *
 286  ****************************************************************************/
 287
 288 ACPI_EXTERN struct acpi_thread_state *acpi_gbl_current_walk_list;
 289
 290 /* Control method single step flag */
 291
 292 ACPI_EXTERN u8 acpi_gbl_cm_single_step;
 293
 294 /*****************************************************************************
 295  *
 296  * Hardware globals
 297  *
 298  ****************************************************************************/
 299
 300 extern struct acpi_bit_register_info
 301     acpi_gbl_bit_register_info[ACPI_NUM_BITREG];
 302 ACPI_EXTERN u8 acpi_gbl_sleep_type_a;
 303 ACPI_EXTERN u8 acpi_gbl_sleep_type_b;
 304
 305 /*****************************************************************************
 306  *
 307  * Event and GPE globals
 308  *
 309  ****************************************************************************/
 310
 311 extern struct acpi_fixed_event_info
 312     acpi_gbl_fixed_event_info[ACPI_NUM_FIXED_EVENTS];
 313 ACPI_EXTERN struct acpi_fixed_event_handler
 314     acpi_gbl_fixed_event_handlers[ACPI_NUM_FIXED_EVENTS];
 315 ACPI_EXTERN struct acpi_gpe_xrupt_info *acpi_gbl_gpe_xrupt_list_head;
 316 ACPI_EXTERN struct acpi_gpe_block_info
 317     *acpi_gbl_gpe_fadt_blocks[ACPI_MAX_GPE_BLOCKS];
 318
 319 /*****************************************************************************
 320  *
 321  * Debugger globals
 322  *
 323  ****************************************************************************/
 324
 325 ACPI_EXTERN u8 acpi_gbl_db_output_flags;
 326
 327 #ifdef ACPI_DISASSEMBLER
 328
 329 ACPI_EXTERN u8 acpi_gbl_db_opt_disasm;
 330 ACPI_EXTERN u8 acpi_gbl_db_opt_verbose;
 331 #endif
 332
 333 #ifdef ACPI_DEBUGGER
 334
 335 extern u8 acpi_gbl_method_executing;
 336 extern u8 acpi_gbl_abort_method;
 337 extern u8 acpi_gbl_db_terminate_threads;
 338
 339 ACPI_EXTERN int optind;
 340 ACPI_EXTERN char *optarg;
 341
 342 ACPI_EXTERN u8 acpi_gbl_db_opt_tables;
 343 ACPI_EXTERN u8 acpi_gbl_db_opt_stats;
 344 ACPI_EXTERN u8 acpi_gbl_db_opt_ini_methods;
 345
 346 ACPI_EXTERN char *acpi_gbl_db_args[ACPI_DEBUGGER_MAX_ARGS];
 347 ACPI_EXTERN char acpi_gbl_db_line_buf[80];
 348 ACPI_EXTERN char acpi_gbl_db_parsed_buf[80];
 349 ACPI_EXTERN char acpi_gbl_db_scope_buf[40];
 350 ACPI_EXTERN char acpi_gbl_db_debug_filename[40];
 351 ACPI_EXTERN u8 acpi_gbl_db_output_to_file;
 352 ACPI_EXTERN char *acpi_gbl_db_buffer;
 353 ACPI_EXTERN char *acpi_gbl_db_filename;
 354 ACPI_EXTERN u32 acpi_gbl_db_debug_level;
 355 ACPI_EXTERN u32 acpi_gbl_db_console_debug_level;
 356 ACPI_EXTERN struct acpi_table_header *acpi_gbl_db_table_ptr;
 357 ACPI_EXTERN struct acpi_namespace_node *acpi_gbl_db_scope_node;
 358
 359 /*
 360  * Statistic globals
 361  */
 362 ACPI_EXTERN u16 acpi_gbl_obj_type_count[ACPI_TYPE_NS_NODE_MAX + 1];
 363 ACPI_EXTERN u16 acpi_gbl_node_type_count[ACPI_TYPE_NS_NODE_MAX + 1];
 364 ACPI_EXTERN u16 acpi_gbl_obj_type_count_misc;
 365 ACPI_EXTERN u16 acpi_gbl_node_type_count_misc;
 366 ACPI_EXTERN u32 acpi_gbl_num_nodes;
 367 ACPI_EXTERN u32 acpi_gbl_num_objects;
 368
 369 ACPI_EXTERN u32 acpi_gbl_size_of_parse_tree;
 370 ACPI_EXTERN u32 acpi_gbl_size_of_method_trees;
 371 ACPI_EXTERN u32 acpi_gbl_size_of_node_entries;
 372 ACPI_EXTERN u32 acpi_gbl_size_of_acpi_objects;
 373
 374 #endif                          /* ACPI_DEBUGGER */
 375
 376 #endif                          /* __ACGLOBAL_H__ */