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