acglobal.h revision 138287
1/****************************************************************************** 2 * 3 * Name: acglobal.h - Declarations for global variables 4 * $Revision: 159 $ 5 * 6 *****************************************************************************/ 7 8/****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2004, Intel Corp. 13 * All rights reserved. 14 * 15 * 2. License 16 * 17 * 2.1. This is your license from Intel Corp. under its intellectual property 18 * rights. You may have additional license terms from the party that provided 19 * you this software, covering your right to use that party's intellectual 20 * property rights. 21 * 22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 23 * copy of the source code appearing in this file ("Covered Code") an 24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 25 * base code distributed originally by Intel ("Original Intel Code") to copy, 26 * make derivatives, distribute, use and display any portion of the Covered 27 * Code in any form, with the right to sublicense such rights; and 28 * 29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 30 * license (with the right to sublicense), under only those claims of Intel 31 * patents that are infringed by the Original Intel Code, to make, use, sell, 32 * offer to sell, and import the Covered Code and derivative works thereof 33 * solely to the minimum extent necessary to exercise the above copyright 34 * license, and in no event shall the patent license extend to any additions 35 * to or modifications of the Original Intel Code. No other license or right 36 * is granted directly or by implication, estoppel or otherwise; 37 * 38 * The above copyright and patent license is granted only if the following 39 * conditions are met: 40 * 41 * 3. Conditions 42 * 43 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 44 * Redistribution of source code of any substantial portion of the Covered 45 * Code or modification with rights to further distribute source must include 46 * the above Copyright Notice, the above License, this list of Conditions, 47 * and the following Disclaimer and Export Compliance provision. In addition, 48 * Licensee must cause all Covered Code to which Licensee contributes to 49 * contain a file documenting the changes Licensee made to create that Covered 50 * Code and the date of any change. Licensee must include in that file the 51 * documentation of any changes made by any predecessor Licensee. Licensee 52 * must include a prominent statement that the modification is derived, 53 * directly or indirectly, from Original Intel Code. 54 * 55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 56 * Redistribution of source code of any substantial portion of the Covered 57 * Code or modification without rights to further distribute source must 58 * include the following Disclaimer and Export Compliance provision in the 59 * documentation and/or other materials provided with distribution. In 60 * addition, Licensee may not authorize further sublicense of source of any 61 * portion of the Covered Code, and must include terms to the effect that the 62 * license from Licensee to its licensee is limited to the intellectual 63 * property embodied in the software Licensee provides to its licensee, and 64 * not to intellectual property embodied in modifications its licensee may 65 * make. 66 * 67 * 3.3. Redistribution of Executable. Redistribution in executable form of any 68 * substantial portion of the Covered Code or modification must reproduce the 69 * above Copyright Notice, and the following Disclaimer and Export Compliance 70 * provision in the documentation and/or other materials provided with the 71 * distribution. 72 * 73 * 3.4. Intel retains all right, title, and interest in and to the Original 74 * Intel Code. 75 * 76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 77 * Intel shall be used in advertising or otherwise to promote the sale, use or 78 * other dealings in products derived from or relating to the Covered Code 79 * without prior written authorization from Intel. 80 * 81 * 4. Disclaimer and Export Compliance 82 * 83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 89 * PARTICULAR PURPOSE. 90 * 91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 98 * LIMITED REMEDY. 99 * 100 * 4.3. Licensee shall not export, either directly or indirectly, any of this 101 * software or system incorporating such software without first obtaining any 102 * required license or other approval from the U. S. Department of Commerce or 103 * any other agency or department of the United States Government. In the 104 * event Licensee exports any such software from the United States or 105 * re-exports any such software from a foreign destination, Licensee shall 106 * ensure that the distribution and export/re-export of the software is in 107 * compliance with all laws, regulations, orders, or other restrictions of the 108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 109 * any of its subsidiaries will export/re-export any technical data, process, 110 * software, or service, directly or indirectly, to any country for which the 111 * United States government or any agency thereof requires an export license, 112 * other governmental approval, or letter of assurance, without first obtaining 113 * such license, approval or letter. 114 * 115 *****************************************************************************/ 116 117#ifndef __ACGLOBAL_H__ 118#define __ACGLOBAL_H__ 119 120 121/* 122 * Ensure that the globals are actually defined and initialized only once. 123 * 124 * The use of these macros allows a single list of globals (here) in order 125 * to simplify maintenance of the code. 126 */ 127#ifdef DEFINE_ACPI_GLOBALS 128#define ACPI_EXTERN 129#define ACPI_INIT_GLOBAL(a,b) a=b 130#else 131#define ACPI_EXTERN extern 132#define ACPI_INIT_GLOBAL(a,b) a 133#endif 134 135/* 136 * Keep local copies of these FADT-based registers. NOTE: These globals 137 * are first in this file for alignment reasons on 64-bit systems. 138 */ 139ACPI_EXTERN ACPI_GENERIC_ADDRESS AcpiGbl_XPm1aEnable; 140ACPI_EXTERN ACPI_GENERIC_ADDRESS AcpiGbl_XPm1bEnable; 141 142 143/***************************************************************************** 144 * 145 * Debug support 146 * 147 ****************************************************************************/ 148 149/* Runtime configuration of debug print levels */ 150 151extern UINT32 AcpiDbgLevel; 152extern UINT32 AcpiDbgLayer; 153 154/* Procedure nesting level for debug output */ 155 156extern UINT32 AcpiGbl_NestingLevel; 157 158 159/***************************************************************************** 160 * 161 * Runtime configuration (static defaults that can be overriden at runtime) 162 * 163 ****************************************************************************/ 164 165/* 166 * Enable "slack" in the AML interpreter? Default is FALSE, and the 167 * interpreter strictly follows the ACPI specification. Setting to TRUE 168 * allows the interpreter to forgive certain bad AML constructs. Currently: 169 * 1) Allow "implicit return" of last value in a control method 170 * 2) Allow access beyond end of operation region 171 * 3) Allow access to uninitialized locals/args (auto-init to integer 0) 172 */ 173ACPI_EXTERN UINT8 ACPI_INIT_GLOBAL (AcpiGbl_EnableInterpreterSlack, FALSE); 174 175/* 176 * Automatically serialize ALL control methods? Default is FALSE, meaning 177 * to use the Serialized/NotSerialized method flags on a per method basis. 178 * Only change this if the ASL code is poorly written and cannot handle 179 * reentrancy even though methods are marked "NotSerialized". 180 */ 181ACPI_EXTERN UINT8 ACPI_INIT_GLOBAL (AcpiGbl_AllMethodsSerialized, FALSE); 182 183/* 184 * Create the predefined _OSI method in the namespace? Default is TRUE 185 * because ACPI CA is fully compatible with other ACPI implementations. 186 * Changing this will revert ACPI CA (and machine ASL) to pre-OSI behavior. 187 */ 188ACPI_EXTERN UINT8 ACPI_INIT_GLOBAL (AcpiGbl_CreateOsiMethod, TRUE); 189 190/* 191 * Disable wakeup GPEs during runtime? Default is TRUE because WAKE and 192 * RUNTIME GPEs should never be shared, and WAKE GPEs should typically only 193 * be enabled just before going to sleep. 194 */ 195ACPI_EXTERN UINT8 ACPI_INIT_GLOBAL (AcpiGbl_LeaveWakeGpesDisabled, TRUE); 196 197 198/***************************************************************************** 199 * 200 * ACPI Table globals 201 * 202 ****************************************************************************/ 203 204/* 205 * Table pointers. 206 * Although these pointers are somewhat redundant with the global AcpiTable, 207 * they are convenient because they are typed pointers. 208 * 209 * These tables are single-table only; meaning that there can be at most one 210 * of each in the system. Each global points to the actual table. 211 */ 212ACPI_EXTERN UINT32 AcpiGbl_TableFlags; 213ACPI_EXTERN UINT32 AcpiGbl_RsdtTableCount; 214ACPI_EXTERN RSDP_DESCRIPTOR *AcpiGbl_RSDP; 215ACPI_EXTERN XSDT_DESCRIPTOR *AcpiGbl_XSDT; 216ACPI_EXTERN FADT_DESCRIPTOR *AcpiGbl_FADT; 217ACPI_EXTERN ACPI_TABLE_HEADER *AcpiGbl_DSDT; 218ACPI_EXTERN FACS_DESCRIPTOR *AcpiGbl_FACS; 219ACPI_EXTERN ACPI_COMMON_FACS AcpiGbl_CommonFACS; 220/* 221 * Since there may be multiple SSDTs and PSDTS, a single pointer is not 222 * sufficient; Therefore, there isn't one! 223 */ 224 225 226/* 227 * Handle both ACPI 1.0 and ACPI 2.0 Integer widths 228 * If we are running a method that exists in a 32-bit ACPI table. 229 * Use only 32 bits of the Integer for conversion. 230 */ 231ACPI_EXTERN UINT8 AcpiGbl_IntegerBitWidth; 232ACPI_EXTERN UINT8 AcpiGbl_IntegerByteWidth; 233ACPI_EXTERN UINT8 AcpiGbl_IntegerNybbleWidth; 234 235/* 236 * ACPI Table info arrays 237 */ 238extern ACPI_TABLE_LIST AcpiGbl_TableLists[NUM_ACPI_TABLE_TYPES]; 239extern ACPI_TABLE_SUPPORT AcpiGbl_TableData[NUM_ACPI_TABLE_TYPES]; 240 241/* 242 * Predefined mutex objects. This array contains the 243 * actual OS mutex handles, indexed by the local ACPI_MUTEX_HANDLEs. 244 * (The table maps local handles to the real OS handles) 245 */ 246ACPI_EXTERN ACPI_MUTEX_INFO AcpiGbl_MutexInfo[NUM_MUTEX]; 247 248 249/***************************************************************************** 250 * 251 * Miscellaneous globals 252 * 253 ****************************************************************************/ 254 255 256ACPI_EXTERN ACPI_MEMORY_LIST AcpiGbl_MemoryLists[ACPI_NUM_MEM_LISTS]; 257ACPI_EXTERN ACPI_OBJECT_NOTIFY_HANDLER AcpiGbl_DeviceNotify; 258ACPI_EXTERN ACPI_OBJECT_NOTIFY_HANDLER AcpiGbl_SystemNotify; 259ACPI_EXTERN ACPI_EXCEPTION_HANDLER AcpiGbl_ExceptionHandler; 260ACPI_EXTERN ACPI_INIT_HANDLER AcpiGbl_InitHandler; 261ACPI_EXTERN ACPI_WALK_STATE *AcpiGbl_BreakpointWalk; 262ACPI_EXTERN ACPI_HANDLE AcpiGbl_GlobalLockSemaphore; 263 264ACPI_EXTERN UINT32 AcpiGbl_GlobalLockThreadCount; 265ACPI_EXTERN UINT32 AcpiGbl_OriginalMode; 266ACPI_EXTERN UINT32 AcpiGbl_RsdpOriginalLocation; 267ACPI_EXTERN UINT32 AcpiGbl_NsLookupCount; 268ACPI_EXTERN UINT32 AcpiGbl_PsFindCount; 269ACPI_EXTERN UINT16 AcpiGbl_Pm1EnableRegisterSave; 270ACPI_EXTERN UINT16 AcpiGbl_NextTableOwnerId; 271ACPI_EXTERN UINT16 AcpiGbl_NextMethodOwnerId; 272ACPI_EXTERN UINT16 AcpiGbl_GlobalLockHandle; 273ACPI_EXTERN UINT8 AcpiGbl_DebuggerConfiguration; 274ACPI_EXTERN BOOLEAN AcpiGbl_GlobalLockAcquired; 275ACPI_EXTERN BOOLEAN AcpiGbl_StepToNextCall; 276ACPI_EXTERN BOOLEAN AcpiGbl_AcpiHardwarePresent; 277ACPI_EXTERN BOOLEAN AcpiGbl_GlobalLockPresent; 278ACPI_EXTERN BOOLEAN AcpiGbl_EventsInitialized; 279ACPI_EXTERN BOOLEAN AcpiGbl_SystemAwakeAndRunning; 280 281extern BOOLEAN AcpiGbl_Shutdown; 282extern UINT32 AcpiGbl_StartupFlags; 283extern const UINT8 AcpiGbl_DecodeTo8bit[8]; 284extern const char *AcpiGbl_SleepStateNames[ACPI_S_STATE_COUNT]; 285extern const char *AcpiGbl_HighestDstateNames[4]; 286extern const ACPI_OPCODE_INFO AcpiGbl_AmlOpInfo[AML_NUM_OPCODES]; 287extern const char *AcpiGbl_RegionTypes[ACPI_NUM_PREDEFINED_REGIONS]; 288extern const char *AcpiGbl_ValidOsiStrings[ACPI_NUM_OSI_STRINGS]; 289 290 291/***************************************************************************** 292 * 293 * Namespace globals 294 * 295 ****************************************************************************/ 296 297#define NUM_NS_TYPES ACPI_TYPE_INVALID+1 298 299#if !defined (ACPI_NO_METHOD_EXECUTION) || defined (ACPI_CONSTANT_EVAL_ONLY) 300#define NUM_PREDEFINED_NAMES 10 301#else 302#define NUM_PREDEFINED_NAMES 9 303#endif 304 305ACPI_EXTERN ACPI_NAMESPACE_NODE AcpiGbl_RootNodeStruct; 306ACPI_EXTERN ACPI_NAMESPACE_NODE *AcpiGbl_RootNode; 307ACPI_EXTERN ACPI_NAMESPACE_NODE *AcpiGbl_FadtGpeDevice; 308 309extern const UINT8 AcpiGbl_NsProperties[NUM_NS_TYPES]; 310extern const ACPI_PREDEFINED_NAMES AcpiGbl_PreDefinedNames [NUM_PREDEFINED_NAMES]; 311 312#ifdef ACPI_DEBUG_OUTPUT 313ACPI_EXTERN UINT32 AcpiGbl_CurrentNodeCount; 314ACPI_EXTERN UINT32 AcpiGbl_CurrentNodeSize; 315ACPI_EXTERN UINT32 AcpiGbl_MaxConcurrentNodeCount; 316ACPI_EXTERN ACPI_SIZE AcpiGbl_EntryStackPointer; 317ACPI_EXTERN ACPI_SIZE AcpiGbl_LowestStackPointer; 318ACPI_EXTERN UINT32 AcpiGbl_DeepestNesting; 319#endif 320 321/***************************************************************************** 322 * 323 * Interpreter globals 324 * 325 ****************************************************************************/ 326 327 328ACPI_EXTERN ACPI_THREAD_STATE *AcpiGbl_CurrentWalkList; 329 330/* Control method single step flag */ 331 332ACPI_EXTERN UINT8 AcpiGbl_CmSingleStep; 333 334 335/***************************************************************************** 336 * 337 * Parser globals 338 * 339 ****************************************************************************/ 340 341ACPI_EXTERN ACPI_PARSE_OBJECT *AcpiGbl_ParsedNamespaceRoot; 342 343/***************************************************************************** 344 * 345 * Hardware globals 346 * 347 ****************************************************************************/ 348 349extern ACPI_BIT_REGISTER_INFO AcpiGbl_BitRegisterInfo[ACPI_NUM_BITREG]; 350ACPI_EXTERN UINT8 AcpiGbl_SleepTypeA; 351ACPI_EXTERN UINT8 AcpiGbl_SleepTypeB; 352 353 354/***************************************************************************** 355 * 356 * Event and GPE globals 357 * 358 ****************************************************************************/ 359 360extern ACPI_FIXED_EVENT_INFO AcpiGbl_FixedEventInfo[ACPI_NUM_FIXED_EVENTS]; 361ACPI_EXTERN ACPI_FIXED_EVENT_HANDLER AcpiGbl_FixedEventHandlers[ACPI_NUM_FIXED_EVENTS]; 362ACPI_EXTERN ACPI_GPE_XRUPT_INFO *AcpiGbl_GpeXruptListHead; 363ACPI_EXTERN ACPI_GPE_BLOCK_INFO *AcpiGbl_GpeFadtBlocks[ACPI_MAX_GPE_BLOCKS]; 364ACPI_EXTERN ACPI_HANDLE AcpiGbl_GpeLock; 365 366 367/***************************************************************************** 368 * 369 * Debugger globals 370 * 371 ****************************************************************************/ 372 373 374ACPI_EXTERN UINT8 AcpiGbl_DbOutputFlags; 375 376#ifdef ACPI_DISASSEMBLER 377 378ACPI_EXTERN BOOLEAN AcpiGbl_DbOpt_disasm; 379ACPI_EXTERN BOOLEAN AcpiGbl_DbOpt_verbose; 380#endif 381 382 383#ifdef ACPI_DEBUGGER 384 385extern BOOLEAN AcpiGbl_MethodExecuting; 386extern BOOLEAN AcpiGbl_AbortMethod; 387extern BOOLEAN AcpiGbl_DbTerminateThreads; 388 389ACPI_EXTERN int optind; 390ACPI_EXTERN char *optarg; 391 392ACPI_EXTERN BOOLEAN AcpiGbl_DbOpt_tables; 393ACPI_EXTERN BOOLEAN AcpiGbl_DbOpt_stats; 394ACPI_EXTERN BOOLEAN AcpiGbl_DbOpt_ini_methods; 395 396 397ACPI_EXTERN char *AcpiGbl_DbArgs[ACPI_DEBUGGER_MAX_ARGS]; 398ACPI_EXTERN char AcpiGbl_DbLineBuf[80]; 399ACPI_EXTERN char AcpiGbl_DbParsedBuf[80]; 400ACPI_EXTERN char AcpiGbl_DbScopeBuf[40]; 401ACPI_EXTERN char AcpiGbl_DbDebugFilename[40]; 402ACPI_EXTERN BOOLEAN AcpiGbl_DbOutputToFile; 403ACPI_EXTERN char *AcpiGbl_DbBuffer; 404ACPI_EXTERN char *AcpiGbl_DbFilename; 405ACPI_EXTERN UINT32 AcpiGbl_DbDebugLevel; 406ACPI_EXTERN UINT32 AcpiGbl_DbConsoleDebugLevel; 407ACPI_EXTERN ACPI_TABLE_HEADER *AcpiGbl_DbTablePtr; 408ACPI_EXTERN ACPI_NAMESPACE_NODE *AcpiGbl_DbScopeNode; 409 410/* 411 * Statistic globals 412 */ 413ACPI_EXTERN UINT16 AcpiGbl_ObjTypeCount[ACPI_TYPE_NS_NODE_MAX+1]; 414ACPI_EXTERN UINT16 AcpiGbl_NodeTypeCount[ACPI_TYPE_NS_NODE_MAX+1]; 415ACPI_EXTERN UINT16 AcpiGbl_ObjTypeCountMisc; 416ACPI_EXTERN UINT16 AcpiGbl_NodeTypeCountMisc; 417ACPI_EXTERN UINT32 AcpiGbl_NumNodes; 418ACPI_EXTERN UINT32 AcpiGbl_NumObjects; 419 420 421ACPI_EXTERN UINT32 AcpiGbl_SizeOfParseTree; 422ACPI_EXTERN UINT32 AcpiGbl_SizeOfMethodTrees; 423ACPI_EXTERN UINT32 AcpiGbl_SizeOfNodeEntries; 424ACPI_EXTERN UINT32 AcpiGbl_SizeOfAcpiObjects; 425 426#endif /* ACPI_DEBUGGER */ 427 428 429#endif /* __ACGLOBAL_H__ */ 430