sys/contrib/dev/acpica/acglobal.h

   1 /******************************************************************************
   2  *
   3  * Name: acglobal.h - Declarations for global variables
   4  *       $Revision: 101 $
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999, 2000, 2001, 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 only once.
 123  *
 124  * The use of these defines 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 #else
 130 #define ACPI_EXTERN extern
 131 #endif
 132
 133
 134 extern      NATIVE_CHAR                 *MsgAcpiErrorBreak;
 135
 136 /*****************************************************************************
 137  *
 138  * Debug support
 139  *
 140  ****************************************************************************/
 141
 142 /* Runtime configuration of debug print levels */
 143
 144 extern      UINT32                      AcpiDbgLevel;
 145 extern      UINT32                      AcpiDbgLayer;
 146
 147
 148 /* Procedure nesting level for debug output */
 149
 150 extern      UINT32                      AcpiGbl_NestingLevel;
 151
 152
 153 /*****************************************************************************
 154  *
 155  * ACPI Table globals
 156  *
 157  ****************************************************************************/
 158
 159 /*
 160  * Table pointers.
 161  * Although these pointers are somewhat redundant with the global AcpiTable,
 162  * they are convenient because they are typed pointers.
 163  *
 164  * These tables are single-table only; meaning that there can be at most one
 165  * of each in the system.  Each global points to the actual table.
 166  *
 167  */
 168 ACPI_EXTERN RSDP_DESCRIPTOR             *AcpiGbl_RSDP;
 169 ACPI_EXTERN XSDT_DESCRIPTOR             *AcpiGbl_XSDT;
 170 ACPI_EXTERN FADT_DESCRIPTOR             *AcpiGbl_FADT;
 171 ACPI_EXTERN ACPI_TABLE_HEADER           *AcpiGbl_DSDT;
 172 ACPI_EXTERN ACPI_COMMON_FACS            *AcpiGbl_FACS;
 173
 174 /*
 175  * Since there may be multiple SSDTs and PSDTS, a single pointer is not
 176  * sufficient; Therefore, there isn't one!
 177  */
 178
 179
 180 /*
 181  * ACPI Table info arrays
 182  */
 183 extern      ACPI_TABLE_DESC             AcpiGbl_AcpiTables[NUM_ACPI_TABLES];
 184 extern      ACPI_TABLE_SUPPORT          AcpiGbl_AcpiTableData[NUM_ACPI_TABLES];
 185
 186 /*
 187  * Predefined mutex objects.  This array contains the
 188  * actual OS mutex handles, indexed by the local ACPI_MUTEX_HANDLEs.
 189  * (The table maps local handles to the real OS handles)
 190  */
 191 ACPI_EXTERN ACPI_MUTEX_INFO             AcpiGbl_AcpiMutexInfo [NUM_MTX];
 192
 193
 194 /*****************************************************************************
 195  *
 196  * Miscellaneous globals
 197  *
 198  ****************************************************************************/
 199
 200
 201 ACPI_EXTERN UINT8                      *AcpiGbl_Gpe0EnableRegisterSave;
 202 ACPI_EXTERN UINT8                      *AcpiGbl_Gpe1EnableRegisterSave;
 203 ACPI_EXTERN ACPI_WALK_STATE            *AcpiGbl_BreakpointWalk;
 204 ACPI_EXTERN ACPI_GENERIC_STATE         *AcpiGbl_GenericStateCache;
 205 ACPI_EXTERN ACPI_PARSE_OBJECT          *AcpiGbl_ParseCache;
 206 ACPI_EXTERN ACPI_PARSE2_OBJECT         *AcpiGbl_ExtParseCache;
 207 ACPI_EXTERN ACPI_OPERAND_OBJECT        *AcpiGbl_ObjectCache;
 208 ACPI_EXTERN ACPI_WALK_STATE            *AcpiGbl_WalkStateCache;
 209 ACPI_EXTERN ACPI_HANDLE                 AcpiGbl_GlobalLockSemaphore;
 210
 211
 212 ACPI_EXTERN UINT32                      AcpiGbl_GlobalLockThreadCount;
 213 ACPI_EXTERN UINT32                      AcpiGbl_RestoreAcpiChipset;
 214 ACPI_EXTERN UINT32                      AcpiGbl_OriginalMode;
 215 ACPI_EXTERN UINT32                      AcpiGbl_EdgeLevelSave;
 216 ACPI_EXTERN UINT32                      AcpiGbl_IrqEnableSave;
 217 ACPI_EXTERN UINT32                      AcpiGbl_RsdpOriginalLocation;
 218
 219 ACPI_EXTERN UINT32                      AcpiGbl_StateCacheRequests;
 220 ACPI_EXTERN UINT32                      AcpiGbl_StateCacheHits;
 221 ACPI_EXTERN UINT32                      AcpiGbl_ParseCacheRequests;
 222 ACPI_EXTERN UINT32                      AcpiGbl_ParseCacheHits;
 223 ACPI_EXTERN UINT32                      AcpiGbl_ExtParseCacheRequests;
 224 ACPI_EXTERN UINT32                      AcpiGbl_ExtParseCacheHits;
 225 ACPI_EXTERN UINT32                      AcpiGbl_ObjectCacheRequests;
 226 ACPI_EXTERN UINT32                      AcpiGbl_ObjectCacheHits;
 227 ACPI_EXTERN UINT32                      AcpiGbl_WalkStateCacheRequests;
 228 ACPI_EXTERN UINT32                      AcpiGbl_WalkStateCacheHits;
 229 ACPI_EXTERN UINT32                      AcpiGbl_NsLookupCount;
 230 ACPI_EXTERN UINT32                      AcpiGbl_PsFindCount;
 231
 232
 233 ACPI_EXTERN UINT16                      AcpiGbl_GenericStateCacheDepth;
 234 ACPI_EXTERN UINT16                      AcpiGbl_ParseCacheDepth;
 235 ACPI_EXTERN UINT16                      AcpiGbl_ExtParseCacheDepth;
 236 ACPI_EXTERN UINT16                      AcpiGbl_ObjectCacheDepth;
 237 ACPI_EXTERN UINT16                      AcpiGbl_WalkStateCacheDepth;
 238 ACPI_EXTERN UINT16                      AcpiGbl_Pm1EnableRegisterSave;
 239 ACPI_EXTERN UINT16                      AcpiGbl_NextTableOwnerId;
 240 ACPI_EXTERN UINT16                      AcpiGbl_NextMethodOwnerId;
 241
 242 ACPI_EXTERN UINT8                       AcpiGbl_DebuggerConfiguration;
 243 ACPI_EXTERN BOOLEAN                     AcpiGbl_GlobalLockAcquired;
 244 ACPI_EXTERN BOOLEAN                     AcpiGbl_StepToNextCall;
 245 ACPI_EXTERN BOOLEAN                     AcpiGbl_AcpiHardwarePresent;
 246 ACPI_EXTERN BOOLEAN                     AcpiGbl_GlobalLockPresent;
 247
 248 ACPI_EXTERN ACPI_OBJECT_NOTIFY_HANDLER  AcpiGbl_DrvNotify;
 249 ACPI_EXTERN ACPI_OBJECT_NOTIFY_HANDLER  AcpiGbl_SysNotify;
 250
 251
 252 extern BOOLEAN                          AcpiGbl_Shutdown;
 253 extern UINT32                           AcpiGbl_SystemFlags;
 254 extern UINT32                           AcpiGbl_StartupFlags;
 255 extern UINT8                            AcpiGbl_DecodeTo8bit[8];
 256 extern NATIVE_CHAR                      AcpiGbl_HexToAscii[16];
 257
 258
 259 /*****************************************************************************
 260  *
 261  * Namespace globals
 262  *
 263  ****************************************************************************/
 264
 265 #define NUM_NS_TYPES                    INTERNAL_TYPE_INVALID+1
 266 #define NUM_PREDEFINED_NAMES            9
 267
 268
 269 ACPI_EXTERN ACPI_NAMESPACE_NODE         AcpiGbl_RootNodeStruct;
 270 ACPI_EXTERN ACPI_NAMESPACE_NODE        *AcpiGbl_RootNode;
 271
 272 extern UINT8                            AcpiGbl_NsProperties[NUM_NS_TYPES];
 273 extern PREDEFINED_NAMES                 AcpiGbl_PreDefinedNames [NUM_PREDEFINED_NAMES];
 274
 275
 276 /* Used to detect memory leaks (DEBUG ONLY) */
 277
 278 #ifdef ACPI_DEBUG
 279 ACPI_EXTERN ACPI_ALLOCATION_INFO        *AcpiGbl_HeadAllocPtr;
 280 ACPI_EXTERN ACPI_ALLOCATION_INFO        *AcpiGbl_TailAllocPtr;
 281 #endif
 282
 283
 284 /*****************************************************************************
 285  *
 286  * Interpreter globals
 287  *
 288  ****************************************************************************/
 289
 290
 291 ACPI_EXTERN ACPI_WALK_LIST             *AcpiGbl_CurrentWalkList;
 292
 293 /*
 294  * Table of Address Space handlers
 295  */
 296 ACPI_EXTERN ACPI_ADR_SPACE_INFO         AcpiGbl_AddressSpaces[ACPI_NUM_ADDRESS_SPACES];
 297
 298
 299 /* Control method single step flag */
 300
 301 ACPI_EXTERN UINT8                       AcpiGbl_CmSingleStep;
 302
 303
 304 /*****************************************************************************
 305  *
 306  * Parser globals
 307  *
 308  ****************************************************************************/
 309
 310 ACPI_EXTERN ACPI_PARSE_OBJECT           *AcpiGbl_ParsedNamespaceRoot;
 311
 312 /*****************************************************************************
 313  *
 314  * Hardware globals
 315  *
 316  ****************************************************************************/
 317
 318 extern ACPI_C_STATE_HANDLER             AcpiHwCxHandlers[MAX_CX_STATES];
 319 extern UINT32                           AcpiHwActiveCxState;
 320
 321
 322 /*****************************************************************************
 323  *
 324  * Event globals
 325  *
 326  ****************************************************************************/
 327
 328 ACPI_EXTERN ACPI_FIXED_EVENT_INFO       AcpiGbl_FixedEventHandlers[ACPI_NUM_FIXED_EVENTS];
 329
 330 ACPI_EXTERN ACPI_HANDLE                 AcpiGbl_GpeObjHandle;
 331 ACPI_EXTERN UINT32                      AcpiGbl_GpeRegisterCount;
 332 ACPI_EXTERN ACPI_GPE_REGISTERS          *AcpiGbl_GpeRegisters;
 333 ACPI_EXTERN ACPI_GPE_LEVEL_INFO         *AcpiGbl_GpeInfo;
 334
 335 /*
 336  * Gpe validation and translation table
 337  * Indexed by the GPE number, returns GPE_INVALID if the GPE is not supported.
 338  * Otherwise, returns a valid index into the global GPE table.
 339  *
 340  * This table is needed because the GPE numbers supported by block 1 do not
 341  * have to be contiguous with the GPE numbers supported by block 0.
 342  */
 343 ACPI_EXTERN UINT8                       AcpiGbl_GpeValid [ACPI_NUM_GPE];
 344
 345 /* AcpiEvent counter for debug only */
 346
 347 #ifdef ACPI_DEBUG
 348 ACPI_EXTERN UINT32                      AcpiGbl_EventCount[ACPI_NUM_FIXED_EVENTS];
 349 #endif
 350
 351
 352 /*****************************************************************************
 353  *
 354  * Debugger globals
 355  *
 356  ****************************************************************************/
 357
 358 #ifdef ENABLE_DEBUGGER
 359 ACPI_EXTERN BOOLEAN                     AcpiGbl_MethodExecuting;
 360 ACPI_EXTERN BOOLEAN                     AcpiGbl_DbTerminateThreads;
 361 #endif
 362
 363 /* Memory allocation metrics - Debug Only! */
 364
 365 #ifdef ACPI_DEBUG
 366
 367 ACPI_EXTERN UINT32                      AcpiGbl_CurrentAllocSize;
 368 ACPI_EXTERN UINT32                      AcpiGbl_CurrentAllocCount;
 369 ACPI_EXTERN UINT32                      AcpiGbl_RunningAllocSize;
 370 ACPI_EXTERN UINT32                      AcpiGbl_RunningAllocCount;
 371 ACPI_EXTERN UINT32                      AcpiGbl_MaxConcurrentAllocSize;
 372 ACPI_EXTERN UINT32                      AcpiGbl_MaxConcurrentAllocCount;
 373 ACPI_EXTERN UINT32                      AcpiGbl_CurrentObjectCount;
 374 ACPI_EXTERN UINT32                      AcpiGbl_CurrentObjectSize;
 375 ACPI_EXTERN UINT32                      AcpiGbl_MaxConcurrentObjectCount;
 376 ACPI_EXTERN UINT32                      AcpiGbl_MaxConcurrentObjectSize;
 377 ACPI_EXTERN UINT32                      AcpiGbl_RunningObjectCount;
 378 ACPI_EXTERN UINT32                      AcpiGbl_RunningObjectSize;
 379 ACPI_EXTERN UINT32                      AcpiGbl_CurrentNodeCount;
 380 ACPI_EXTERN UINT32                      AcpiGbl_CurrentNodeSize;
 381 ACPI_EXTERN UINT32                      AcpiGbl_MaxConcurrentNodeCount;
 382
 383 #endif
 384
 385
 386 #endif /* __ACGLOBAL_H__ */