sys/contrib/dev/acpica-unix-20061109/include/acglobal.h

   1 /******************************************************************************
   2  *
   3  * Name: acglobal.h - Declarations for global variables
   4  *       $Revision: 1.190 $
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2006, 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 /*****************************************************************************
 137  *
 138  * Runtime configuration (static defaults that can be overriden at runtime)
 139  *
 140  ****************************************************************************/
 141
 142 /*
 143  * Enable "slack" in the AML interpreter?  Default is FALSE, and the
 144  * interpreter strictly follows the ACPI specification.  Setting to TRUE
 145  * allows the interpreter to ignore certain errors and/or bad AML constructs.
 146  *
 147  * Currently, these features are enabled by this flag:
 148  *
 149  * 1) Allow "implicit return" of last value in a control method
 150  * 2) Allow access beyond the end of an operation region
 151  * 3) Allow access to uninitialized locals/args (auto-init to integer 0)
 152  * 4) Allow ANY object type to be a source operand for the Store() operator
 153  * 5) Allow unresolved references (invalid target name) in package objects
 154  * 6) Enable warning messages for behavior that is not ACPI spec compliant
 155  */
 156 ACPI_EXTERN UINT8       ACPI_INIT_GLOBAL (AcpiGbl_EnableInterpreterSlack, FALSE);
 157
 158 /*
 159  * Automatically serialize ALL control methods? Default is FALSE, meaning
 160  * to use the Serialized/NotSerialized method flags on a per method basis.
 161  * Only change this if the ASL code is poorly written and cannot handle
 162  * reentrancy even though methods are marked "NotSerialized".
 163  */
 164 ACPI_EXTERN UINT8       ACPI_INIT_GLOBAL (AcpiGbl_AllMethodsSerialized, FALSE);
 165
 166 /*
 167  * Create the predefined _OSI method in the namespace? Default is TRUE
 168  * because ACPI CA is fully compatible with other ACPI implementations.
 169  * Changing this will revert ACPI CA (and machine ASL) to pre-OSI behavior.
 170  */
 171 ACPI_EXTERN UINT8       ACPI_INIT_GLOBAL (AcpiGbl_CreateOsiMethod, TRUE);
 172
 173 /*
 174  * Disable wakeup GPEs during runtime? Default is TRUE because WAKE and
 175  * RUNTIME GPEs should never be shared, and WAKE GPEs should typically only
 176  * be enabled just before going to sleep.
 177  */
 178 ACPI_EXTERN UINT8       ACPI_INIT_GLOBAL (AcpiGbl_LeaveWakeGpesDisabled, TRUE);
 179
 180
 181 /*****************************************************************************
 182  *
 183  * Debug support
 184  *
 185  ****************************************************************************/
 186
 187 /* Runtime configuration of debug print levels */
 188
 189 extern      UINT32                      AcpiDbgLevel;
 190 extern      UINT32                      AcpiDbgLayer;
 191
 192 /* Procedure nesting level for debug output */
 193
 194 extern      UINT32                      AcpiGbl_NestingLevel;
 195
 196 /* Event counters */
 197
 198 ACPI_EXTERN UINT32                      AcpiGpeCount;
 199
 200 /* Support for dynamic control method tracing mechanism */
 201
 202 ACPI_EXTERN UINT32                      AcpiGbl_OriginalDbgLevel;
 203 ACPI_EXTERN UINT32                      AcpiGbl_OriginalDbgLayer;
 204 ACPI_EXTERN ACPI_NAME                   AcpiGbl_TraceMethodName;
 205 ACPI_EXTERN UINT32                      AcpiGbl_TraceDbgLevel;
 206 ACPI_EXTERN UINT32                      AcpiGbl_TraceDbgLayer;
 207 ACPI_EXTERN UINT32                      AcpiGbl_TraceFlags;
 208
 209
 210 /*****************************************************************************
 211  *
 212  * ACPI Table globals
 213  *
 214  ****************************************************************************/
 215
 216 /*
 217  * AcpiGbl_RootTableList is the master list of ACPI tables found in the
 218  * RSDT/XSDT.
 219  *
 220  * AcpiGbl_FADT is a local copy of the FADT, converted to a common format.
 221  */
 222 ACPI_EXTERN ACPI_INTERNAL_RSDT          AcpiGbl_RootTableList;
 223 ACPI_EXTERN ACPI_TABLE_FADT             AcpiGbl_FADT;
 224
 225 /* These addresses are calculated from FADT address values */
 226
 227 ACPI_EXTERN ACPI_GENERIC_ADDRESS        AcpiGbl_XPm1aEnable;
 228 ACPI_EXTERN ACPI_GENERIC_ADDRESS        AcpiGbl_XPm1bEnable;
 229
 230 /*
 231  * Handle both ACPI 1.0 and ACPI 2.0 Integer widths. The integer width is
 232  * determined by the revision of the DSDT: If the DSDT revision is less than
 233  * 2, use only the lower 32 bits of the internal 64-bit Integer.
 234  */
 235 ACPI_EXTERN UINT8                       AcpiGbl_IntegerBitWidth;
 236 ACPI_EXTERN UINT8                       AcpiGbl_IntegerByteWidth;
 237 ACPI_EXTERN UINT8                       AcpiGbl_IntegerNybbleWidth;
 238
 239
 240 /*****************************************************************************
 241  *
 242  * Mutual exlusion within ACPICA subsystem
 243  *
 244  ****************************************************************************/
 245
 246 /*
 247  * Predefined mutex objects. This array contains the
 248  * actual OS mutex handles, indexed by the local ACPI_MUTEX_HANDLEs.
 249  * (The table maps local handles to the real OS handles)
 250  */
 251 ACPI_EXTERN ACPI_MUTEX_INFO             AcpiGbl_MutexInfo[ACPI_NUM_MUTEX];
 252
 253 /*
 254  * Global lock semaphore works in conjunction with the actual HW global lock
 255  */
 256 ACPI_EXTERN ACPI_MUTEX                  AcpiGbl_GlobalLockMutex;
 257 ACPI_EXTERN ACPI_SEMAPHORE              AcpiGbl_GlobalLockSemaphore;
 258
 259 /*
 260  * Spinlocks are used for interfaces that can be possibly called at
 261  * interrupt level
 262  */
 263 ACPI_EXTERN ACPI_SPINLOCK               AcpiGbl_GpeLock;      /* For GPE data structs and registers */
 264 ACPI_EXTERN ACPI_SPINLOCK               AcpiGbl_HardwareLock; /* For ACPI H/W except GPE registers */
 265
 266
 267 /*****************************************************************************
 268  *
 269  * Miscellaneous globals
 270  *
 271  ****************************************************************************/
 272
 273 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
 274
 275 /* Lists for tracking memory allocations */
 276
 277 ACPI_EXTERN ACPI_MEMORY_LIST           *AcpiGbl_GlobalList;
 278 ACPI_EXTERN ACPI_MEMORY_LIST           *AcpiGbl_NsNodeList;
 279 #endif
 280
 281 /* Object caches */
 282
 283 ACPI_EXTERN ACPI_CACHE_T               *AcpiGbl_NamespaceCache;
 284 ACPI_EXTERN ACPI_CACHE_T               *AcpiGbl_StateCache;
 285 ACPI_EXTERN ACPI_CACHE_T               *AcpiGbl_PsNodeCache;
 286 ACPI_EXTERN ACPI_CACHE_T               *AcpiGbl_PsNodeExtCache;
 287 ACPI_EXTERN ACPI_CACHE_T               *AcpiGbl_OperandCache;
 288
 289 /* Global handlers */
 290
 291 ACPI_EXTERN ACPI_OBJECT_NOTIFY_HANDLER  AcpiGbl_DeviceNotify;
 292 ACPI_EXTERN ACPI_OBJECT_NOTIFY_HANDLER  AcpiGbl_SystemNotify;
 293 ACPI_EXTERN ACPI_EXCEPTION_HANDLER      AcpiGbl_ExceptionHandler;
 294 ACPI_EXTERN ACPI_INIT_HANDLER           AcpiGbl_InitHandler;
 295 ACPI_EXTERN ACPI_WALK_STATE            *AcpiGbl_BreakpointWalk;
 296
 297 /* Misc */
 298
 299 ACPI_EXTERN UINT32                      AcpiGbl_OriginalMode;
 300 ACPI_EXTERN UINT32                      AcpiGbl_RsdpOriginalLocation;
 301 ACPI_EXTERN UINT32                      AcpiGbl_NsLookupCount;
 302 ACPI_EXTERN UINT32                      AcpiGbl_PsFindCount;
 303 ACPI_EXTERN UINT32                      AcpiGbl_OwnerIdMask[ACPI_NUM_OWNERID_MASKS];
 304 ACPI_EXTERN UINT16                      AcpiGbl_Pm1EnableRegisterSave;
 305 ACPI_EXTERN UINT16                      AcpiGbl_GlobalLockHandle;
 306 ACPI_EXTERN UINT8                       AcpiGbl_LastOwnerIdIndex;
 307 ACPI_EXTERN UINT8                       AcpiGbl_NextOwnerIdOffset;
 308 ACPI_EXTERN UINT8                       AcpiGbl_DebuggerConfiguration;
 309 ACPI_EXTERN BOOLEAN                     AcpiGbl_GlobalLockAcquired;
 310 ACPI_EXTERN BOOLEAN                     AcpiGbl_StepToNextCall;
 311 ACPI_EXTERN BOOLEAN                     AcpiGbl_AcpiHardwarePresent;
 312 ACPI_EXTERN BOOLEAN                     AcpiGbl_GlobalLockPresent;
 313 ACPI_EXTERN BOOLEAN                     AcpiGbl_EventsInitialized;
 314 ACPI_EXTERN BOOLEAN                     AcpiGbl_SystemAwakeAndRunning;
 315
 316 extern BOOLEAN                          AcpiGbl_Shutdown;
 317 extern UINT32                           AcpiGbl_StartupFlags;
 318 extern const char                      *AcpiGbl_SleepStateNames[ACPI_S_STATE_COUNT];
 319 extern const char                      *AcpiGbl_HighestDstateNames[4];
 320 extern const ACPI_OPCODE_INFO           AcpiGbl_AmlOpInfo[AML_NUM_OPCODES];
 321 extern const char                      *AcpiGbl_RegionTypes[ACPI_NUM_PREDEFINED_REGIONS];
 322
 323 /* Exception codes */
 324
 325 extern      char const                 *AcpiGbl_ExceptionNames_Env[];
 326 extern      char const                 *AcpiGbl_ExceptionNames_Pgm[];
 327 extern      char const                 *AcpiGbl_ExceptionNames_Tbl[];
 328 extern      char const                 *AcpiGbl_ExceptionNames_Aml[];
 329 extern      char const                 *AcpiGbl_ExceptionNames_Ctrl[];
 330
 331
 332 /*****************************************************************************
 333  *
 334  * Namespace globals
 335  *
 336  ****************************************************************************/
 337
 338 #define NUM_NS_TYPES                    ACPI_TYPE_INVALID+1
 339
 340 #if !defined (ACPI_NO_METHOD_EXECUTION) || defined (ACPI_CONSTANT_EVAL_ONLY)
 341 #define NUM_PREDEFINED_NAMES            10
 342 #else
 343 #define NUM_PREDEFINED_NAMES            9
 344 #endif
 345
 346 ACPI_EXTERN ACPI_NAMESPACE_NODE         AcpiGbl_RootNodeStruct;
 347 ACPI_EXTERN ACPI_NAMESPACE_NODE        *AcpiGbl_RootNode;
 348 ACPI_EXTERN ACPI_NAMESPACE_NODE        *AcpiGbl_FadtGpeDevice;
 349
 350 extern const UINT8                      AcpiGbl_NsProperties[NUM_NS_TYPES];
 351 extern const ACPI_PREDEFINED_NAMES      AcpiGbl_PreDefinedNames [NUM_PREDEFINED_NAMES];
 352
 353 #ifdef ACPI_DEBUG_OUTPUT
 354 ACPI_EXTERN UINT32                      AcpiGbl_CurrentNodeCount;
 355 ACPI_EXTERN UINT32                      AcpiGbl_CurrentNodeSize;
 356 ACPI_EXTERN UINT32                      AcpiGbl_MaxConcurrentNodeCount;
 357 ACPI_EXTERN ACPI_SIZE                   AcpiGbl_EntryStackPointer;
 358 ACPI_EXTERN ACPI_SIZE                   AcpiGbl_LowestStackPointer;
 359 ACPI_EXTERN UINT32                      AcpiGbl_DeepestNesting;
 360 #endif
 361
 362
 363 /*****************************************************************************
 364  *
 365  * Interpreter globals
 366  *
 367  ****************************************************************************/
 368
 369
 370 ACPI_EXTERN ACPI_THREAD_STATE          *AcpiGbl_CurrentWalkList;
 371
 372 /* Control method single step flag */
 373
 374 ACPI_EXTERN UINT8                       AcpiGbl_CmSingleStep;
 375
 376
 377 /*****************************************************************************
 378  *
 379  * Hardware globals
 380  *
 381  ****************************************************************************/
 382
 383 extern      ACPI_BIT_REGISTER_INFO      AcpiGbl_BitRegisterInfo[ACPI_NUM_BITREG];
 384 ACPI_EXTERN UINT8                       AcpiGbl_SleepTypeA;
 385 ACPI_EXTERN UINT8                       AcpiGbl_SleepTypeB;
 386
 387
 388 /*****************************************************************************
 389  *
 390  * Event and GPE globals
 391  *
 392  ****************************************************************************/
 393
 394 extern      ACPI_FIXED_EVENT_INFO       AcpiGbl_FixedEventInfo[ACPI_NUM_FIXED_EVENTS];
 395 ACPI_EXTERN ACPI_FIXED_EVENT_HANDLER    AcpiGbl_FixedEventHandlers[ACPI_NUM_FIXED_EVENTS];
 396 ACPI_EXTERN ACPI_GPE_XRUPT_INFO        *AcpiGbl_GpeXruptListHead;
 397 ACPI_EXTERN ACPI_GPE_BLOCK_INFO        *AcpiGbl_GpeFadtBlocks[ACPI_MAX_GPE_BLOCKS];
 398
 399
 400 /*****************************************************************************
 401  *
 402  * Debugger globals
 403  *
 404  ****************************************************************************/
 405
 406 ACPI_EXTERN UINT8                       AcpiGbl_DbOutputFlags;
 407
 408 #ifdef ACPI_DISASSEMBLER
 409
 410 ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_disasm;
 411 ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_verbose;
 412 #endif
 413
 414
 415 #ifdef ACPI_DEBUGGER
 416
 417 extern      BOOLEAN                     AcpiGbl_MethodExecuting;
 418 extern      BOOLEAN                     AcpiGbl_AbortMethod;
 419 extern      BOOLEAN                     AcpiGbl_DbTerminateThreads;
 420
 421 ACPI_EXTERN int                         optind;
 422 ACPI_EXTERN char                       *optarg;
 423
 424 ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_tables;
 425 ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_stats;
 426 ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_ini_methods;
 427
 428
 429 ACPI_EXTERN char                       *AcpiGbl_DbArgs[ACPI_DEBUGGER_MAX_ARGS];
 430 ACPI_EXTERN char                        AcpiGbl_DbLineBuf[80];
 431 ACPI_EXTERN char                        AcpiGbl_DbParsedBuf[80];
 432 ACPI_EXTERN char                        AcpiGbl_DbScopeBuf[40];
 433 ACPI_EXTERN char                        AcpiGbl_DbDebugFilename[40];
 434 ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOutputToFile;
 435 ACPI_EXTERN char                       *AcpiGbl_DbBuffer;
 436 ACPI_EXTERN char                       *AcpiGbl_DbFilename;
 437 ACPI_EXTERN UINT32                      AcpiGbl_DbDebugLevel;
 438 ACPI_EXTERN UINT32                      AcpiGbl_DbConsoleDebugLevel;
 439 ACPI_EXTERN ACPI_TABLE_HEADER          *AcpiGbl_DbTablePtr;
 440 ACPI_EXTERN ACPI_NAMESPACE_NODE        *AcpiGbl_DbScopeNode;
 441
 442 /*
 443  * Statistic globals
 444  */
 445 ACPI_EXTERN UINT16                      AcpiGbl_ObjTypeCount[ACPI_TYPE_NS_NODE_MAX+1];
 446 ACPI_EXTERN UINT16                      AcpiGbl_NodeTypeCount[ACPI_TYPE_NS_NODE_MAX+1];
 447 ACPI_EXTERN UINT16                      AcpiGbl_ObjTypeCountMisc;
 448 ACPI_EXTERN UINT16                      AcpiGbl_NodeTypeCountMisc;
 449 ACPI_EXTERN UINT32                      AcpiGbl_NumNodes;
 450 ACPI_EXTERN UINT32                      AcpiGbl_NumObjects;
 451
 452
 453 ACPI_EXTERN UINT32                      AcpiGbl_SizeOfParseTree;
 454 ACPI_EXTERN UINT32                      AcpiGbl_SizeOfMethodTrees;
 455 ACPI_EXTERN UINT32                      AcpiGbl_SizeOfNodeEntries;
 456 ACPI_EXTERN UINT32                      AcpiGbl_SizeOfAcpiObjects;
 457
 458 #endif /* ACPI_DEBUGGER */
 459
 460 #endif /* __ACGLOBAL_H__ */