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