include/acpi/acglobal.h

   1 /******************************************************************************
   2  *
   3  * Name: acglobal.h - Declarations for global variables
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2005, 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 forgive certain bad AML constructs.  Currently:
 102  * 1) Allow "implicit return" of last value in a control method
 103  * 2) Allow access beyond end of operation region
 104  * 3) Allow access to uninitialized locals/args (auto-init to integer 0)
 105  * 4) Allow ANY object type to be a source operand for the Store() operator
 106  */
 107 ACPI_EXTERN u8 ACPI_INIT_GLOBAL(acpi_gbl_enable_interpreter_slack, FALSE);
 108
 109 /*
 110  * Automatically serialize ALL control methods? Default is FALSE, meaning
 111  * to use the Serialized/not_serialized method flags on a per method basis.
 112  * Only change this if the ASL code is poorly written and cannot handle
 113  * reentrancy even though methods are marked "not_serialized".
 114  */
 115 ACPI_EXTERN u8 ACPI_INIT_GLOBAL(acpi_gbl_all_methods_serialized, FALSE);
 116
 117 /*
 118  * Create the predefined _OSI method in the namespace? Default is TRUE
 119  * because ACPI CA is fully compatible with other ACPI implementations.
 120  * Changing this will revert ACPI CA (and machine ASL) to pre-OSI behavior.
 121  */
 122 ACPI_EXTERN u8 ACPI_INIT_GLOBAL(acpi_gbl_create_osi_method, TRUE);
 123
 124 /*
 125  * Disable wakeup GPEs during runtime? Default is TRUE because WAKE and
 126  * RUNTIME GPEs should never be shared, and WAKE GPEs should typically only
 127  * be enabled just before going to sleep.
 128  */
 129 ACPI_EXTERN u8 ACPI_INIT_GLOBAL(acpi_gbl_leave_wake_gpes_disabled, TRUE);
 130
 131 /*****************************************************************************
 132  *
 133  * ACPI Table globals
 134  *
 135  ****************************************************************************/
 136
 137 /*
 138  * Table pointers.
 139  * Although these pointers are somewhat redundant with the global acpi_table,
 140  * they are convenient because they are typed pointers.
 141  *
 142  * These tables are single-table only; meaning that there can be at most one
 143  * of each in the system.  Each global points to the actual table.
 144  */
 145 ACPI_EXTERN u32 acpi_gbl_table_flags;
 146 ACPI_EXTERN u32 acpi_gbl_rsdt_table_count;
 147 ACPI_EXTERN struct rsdp_descriptor *acpi_gbl_RSDP;
 148 ACPI_EXTERN XSDT_DESCRIPTOR *acpi_gbl_XSDT;
 149 ACPI_EXTERN FADT_DESCRIPTOR *acpi_gbl_FADT;
 150 ACPI_EXTERN struct acpi_table_header *acpi_gbl_DSDT;
 151 ACPI_EXTERN FACS_DESCRIPTOR *acpi_gbl_FACS;
 152 ACPI_EXTERN struct acpi_common_facs acpi_gbl_common_fACS;
 153 /*
 154  * Since there may be multiple SSDTs and PSDTs, a single pointer is not
 155  * sufficient; Therefore, there isn't one!
 156  */
 157
 158 /* The root table can be either an RSDT or an XSDT */
 159
 160 ACPI_EXTERN u8 acpi_gbl_root_table_type;
 161 #define     ACPI_TABLE_TYPE_RSDT        'R'
 162 #define     ACPI_TABLE_TYPE_XSDT        'X'
 163
 164 /*
 165  * Handle both ACPI 1.0 and ACPI 2.0 Integer widths:
 166  * If we are executing a method that exists in a 32-bit ACPI table,
 167  * use only the lower 32 bits of the (internal) 64-bit Integer.
 168  */
 169 ACPI_EXTERN u8 acpi_gbl_integer_bit_width;
 170 ACPI_EXTERN u8 acpi_gbl_integer_byte_width;
 171 ACPI_EXTERN u8 acpi_gbl_integer_nybble_width;
 172
 173 /*
 174  * ACPI Table info arrays
 175  */
 176 extern struct acpi_table_list acpi_gbl_table_lists[NUM_ACPI_TABLE_TYPES];
 177 extern struct acpi_table_support acpi_gbl_table_data[NUM_ACPI_TABLE_TYPES];
 178
 179 /*
 180  * Predefined mutex objects.  This array contains the
 181  * actual OS mutex handles, indexed by the local ACPI_MUTEX_HANDLEs.
 182  * (The table maps local handles to the real OS handles)
 183  */
 184 ACPI_EXTERN struct acpi_mutex_info acpi_gbl_mutex_info[NUM_MUTEX];
 185
 186 /*****************************************************************************
 187  *
 188  * Miscellaneous globals
 189  *
 190  ****************************************************************************/
 191
 192 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
 193
 194 /* Lists for tracking memory allocations */
 195
 196 ACPI_EXTERN struct acpi_memory_list *acpi_gbl_global_list;
 197 ACPI_EXTERN struct acpi_memory_list *acpi_gbl_ns_node_list;
 198 #endif
 199
 200 /* Object caches */
 201
 202 ACPI_EXTERN acpi_cache_t *acpi_gbl_state_cache;
 203 ACPI_EXTERN acpi_cache_t *acpi_gbl_ps_node_cache;
 204 ACPI_EXTERN acpi_cache_t *acpi_gbl_ps_node_ext_cache;
 205 ACPI_EXTERN acpi_cache_t *acpi_gbl_operand_cache;
 206
 207 /* Global handlers */
 208
 209 ACPI_EXTERN struct acpi_object_notify_handler acpi_gbl_device_notify;
 210 ACPI_EXTERN struct acpi_object_notify_handler acpi_gbl_system_notify;
 211 ACPI_EXTERN acpi_exception_handler acpi_gbl_exception_handler;
 212 ACPI_EXTERN acpi_init_handler acpi_gbl_init_handler;
 213 ACPI_EXTERN struct acpi_walk_state *acpi_gbl_breakpoint_walk;
 214 ACPI_EXTERN acpi_handle acpi_gbl_global_lock_semaphore;
 215
 216 /* Misc */
 217
 218 ACPI_EXTERN u32 acpi_gbl_global_lock_thread_count;
 219 ACPI_EXTERN u32 acpi_gbl_original_mode;
 220 ACPI_EXTERN u32 acpi_gbl_rsdp_original_location;
 221 ACPI_EXTERN u32 acpi_gbl_ns_lookup_count;
 222 ACPI_EXTERN u32 acpi_gbl_ps_find_count;
 223 ACPI_EXTERN u32 acpi_gbl_owner_id_mask;
 224 ACPI_EXTERN u16 acpi_gbl_pm1_enable_register_save;
 225 ACPI_EXTERN u16 acpi_gbl_global_lock_handle;
 226 ACPI_EXTERN u8 acpi_gbl_debugger_configuration;
 227 ACPI_EXTERN u8 acpi_gbl_global_lock_acquired;
 228 ACPI_EXTERN u8 acpi_gbl_step_to_next_call;
 229 ACPI_EXTERN u8 acpi_gbl_acpi_hardware_present;
 230 ACPI_EXTERN u8 acpi_gbl_global_lock_present;
 231 ACPI_EXTERN u8 acpi_gbl_events_initialized;
 232 ACPI_EXTERN u8 acpi_gbl_system_awake_and_running;
 233
 234 extern u8 acpi_gbl_shutdown;
 235 extern u32 acpi_gbl_startup_flags;
 236 extern const u8 acpi_gbl_decode_to8bit[8];
 237 extern const char *acpi_gbl_sleep_state_names[ACPI_S_STATE_COUNT];
 238 extern const char *acpi_gbl_highest_dstate_names[4];
 239 extern const struct acpi_opcode_info acpi_gbl_aml_op_info[AML_NUM_OPCODES];
 240 extern const char *acpi_gbl_region_types[ACPI_NUM_PREDEFINED_REGIONS];
 241 extern const char *acpi_gbl_valid_osi_strings[ACPI_NUM_OSI_STRINGS];
 242
 243 /*****************************************************************************
 244  *
 245  * Namespace globals
 246  *
 247  ****************************************************************************/
 248
 249 #define NUM_NS_TYPES                    ACPI_TYPE_INVALID+1
 250
 251 #if !defined (ACPI_NO_METHOD_EXECUTION) || defined (ACPI_CONSTANT_EVAL_ONLY)
 252 #define NUM_PREDEFINED_NAMES            10
 253 #else
 254 #define NUM_PREDEFINED_NAMES            9
 255 #endif
 256
 257 ACPI_EXTERN struct acpi_namespace_node acpi_gbl_root_node_struct;
 258 ACPI_EXTERN struct acpi_namespace_node *acpi_gbl_root_node;
 259 ACPI_EXTERN struct acpi_namespace_node *acpi_gbl_fadt_gpe_device;
 260
 261 extern const u8 acpi_gbl_ns_properties[NUM_NS_TYPES];
 262 extern const struct acpi_predefined_names
 263     acpi_gbl_pre_defined_names[NUM_PREDEFINED_NAMES];
 264
 265 #ifdef ACPI_DEBUG_OUTPUT
 266 ACPI_EXTERN u32 acpi_gbl_current_node_count;
 267 ACPI_EXTERN u32 acpi_gbl_current_node_size;
 268 ACPI_EXTERN u32 acpi_gbl_max_concurrent_node_count;
 269 ACPI_EXTERN acpi_size acpi_gbl_entry_stack_pointer;
 270 ACPI_EXTERN acpi_size acpi_gbl_lowest_stack_pointer;
 271 ACPI_EXTERN u32 acpi_gbl_deepest_nesting;
 272 #endif
 273
 274 /*****************************************************************************
 275  *
 276  * Interpreter globals
 277  *
 278  ****************************************************************************/
 279
 280 ACPI_EXTERN struct acpi_thread_state *acpi_gbl_current_walk_list;
 281
 282 /* Control method single step flag */
 283
 284 ACPI_EXTERN u8 acpi_gbl_cm_single_step;
 285
 286 /*****************************************************************************
 287  *
 288  * Parser globals
 289  *
 290  ****************************************************************************/
 291
 292 ACPI_EXTERN union acpi_parse_object *acpi_gbl_parsed_namespace_root;
 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 ACPI_EXTERN acpi_handle acpi_gbl_gpe_lock;
 319
 320 /*****************************************************************************
 321  *
 322  * Debugger globals
 323  *
 324  ****************************************************************************/
 325
 326 ACPI_EXTERN u8 acpi_gbl_db_output_flags;
 327
 328 #ifdef ACPI_DISASSEMBLER
 329
 330 ACPI_EXTERN u8 acpi_gbl_db_opt_disasm;
 331 ACPI_EXTERN u8 acpi_gbl_db_opt_verbose;
 332 #endif
 333
 334 #ifdef ACPI_DEBUGGER
 335
 336 extern u8 acpi_gbl_method_executing;
 337 extern u8 acpi_gbl_abort_method;
 338 extern u8 acpi_gbl_db_terminate_threads;
 339
 340 ACPI_EXTERN int optind;
 341 ACPI_EXTERN char *optarg;
 342
 343 ACPI_EXTERN u8 acpi_gbl_db_opt_tables;
 344 ACPI_EXTERN u8 acpi_gbl_db_opt_stats;
 345 ACPI_EXTERN u8 acpi_gbl_db_opt_ini_methods;
 346
 347 ACPI_EXTERN char *acpi_gbl_db_args[ACPI_DEBUGGER_MAX_ARGS];
 348 ACPI_EXTERN char acpi_gbl_db_line_buf[80];
 349 ACPI_EXTERN char acpi_gbl_db_parsed_buf[80];
 350 ACPI_EXTERN char acpi_gbl_db_scope_buf[40];
 351 ACPI_EXTERN char acpi_gbl_db_debug_filename[40];
 352 ACPI_EXTERN u8 acpi_gbl_db_output_to_file;
 353 ACPI_EXTERN char *acpi_gbl_db_buffer;
 354 ACPI_EXTERN char *acpi_gbl_db_filename;
 355 ACPI_EXTERN u32 acpi_gbl_db_debug_level;
 356 ACPI_EXTERN u32 acpi_gbl_db_console_debug_level;
 357 ACPI_EXTERN struct acpi_table_header *acpi_gbl_db_table_ptr;
 358 ACPI_EXTERN struct acpi_namespace_node *acpi_gbl_db_scope_node;
 359
 360 /*
 361  * Statistic globals
 362  */
 363 ACPI_EXTERN u16 acpi_gbl_obj_type_count[ACPI_TYPE_NS_NODE_MAX + 1];
 364 ACPI_EXTERN u16 acpi_gbl_node_type_count[ACPI_TYPE_NS_NODE_MAX + 1];
 365 ACPI_EXTERN u16 acpi_gbl_obj_type_count_misc;
 366 ACPI_EXTERN u16 acpi_gbl_node_type_count_misc;
 367 ACPI_EXTERN u32 acpi_gbl_num_nodes;
 368 ACPI_EXTERN u32 acpi_gbl_num_objects;
 369
 370 ACPI_EXTERN u32 acpi_gbl_size_of_parse_tree;
 371 ACPI_EXTERN u32 acpi_gbl_size_of_method_trees;
 372 ACPI_EXTERN u32 acpi_gbl_size_of_node_entries;
 373 ACPI_EXTERN u32 acpi_gbl_size_of_acpi_objects;
 374
 375 #endif                          /* ACPI_DEBUGGER */
 376
 377 #endif                          /* __ACGLOBAL_H__ */