sys/contrib/dev/acpica/acglobal.h

   1 /******************************************************************************
   2  *
   3  * Name: acglobal.h - Declarations for global variables
   4  *       $Revision: 137 $
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2003, 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 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/acglobal.h,v 1.1 2003/09/24 03:32:15 drhodus Exp $                                                               */
 117
 118 #ifndef __ACGLOBAL_H__
 119 #define __ACGLOBAL_H__
 120
 121
 122 /*
 123  * Ensure that the globals are actually defined only once.
 124  *
 125  * The use of these defines allows a single list of globals (here) in order
 126  * to simplify maintenance of the code.
 127  */
 128 #ifdef DEFINE_ACPI_GLOBALS
 129 #define ACPI_EXTERN
 130 #else
 131 #define ACPI_EXTERN extern
 132 #endif
 133
 134
 135 /*****************************************************************************
 136  *
 137  * Debug support
 138  *
 139  ****************************************************************************/
 140
 141 /* Runtime configuration of debug print levels */
 142
 143 extern      UINT32                      AcpiDbgLevel;
 144 extern      UINT32                      AcpiDbgLayer;
 145
 146 /* Procedure nesting level for debug output */
 147
 148 extern      UINT32                      AcpiGbl_NestingLevel;
 149
 150
 151 /*****************************************************************************
 152  *
 153  * ACPI Table globals
 154  *
 155  ****************************************************************************/
 156
 157 /*
 158  * Table pointers.
 159  * Although these pointers are somewhat redundant with the global AcpiTable,
 160  * they are convenient because they are typed pointers.
 161  *
 162  * These tables are single-table only; meaning that there can be at most one
 163  * of each in the system.  Each global points to the actual table.
 164  *
 165  */
 166 ACPI_EXTERN UINT32                      AcpiGbl_TableFlags;
 167 ACPI_EXTERN UINT32                      AcpiGbl_RsdtTableCount;
 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 FACS_DESCRIPTOR            *AcpiGbl_FACS;
 173 ACPI_EXTERN ACPI_COMMON_FACS            AcpiGbl_CommonFACS;
 174
 175 /*
 176  * Handle both ACPI 1.0 and ACPI 2.0 Integer widths
 177  * If we are running a method that exists in a 32-bit ACPI table.
 178  * Use only 32 bits of the Integer for conversion.
 179  */
 180 ACPI_EXTERN UINT8                       AcpiGbl_IntegerBitWidth;
 181 ACPI_EXTERN UINT8                       AcpiGbl_IntegerByteWidth;
 182
 183 /*
 184  * Since there may be multiple SSDTs and PSDTS, a single pointer is not
 185  * sufficient; Therefore, there isn't one!
 186  */
 187
 188
 189 /*
 190  * ACPI Table info arrays
 191  */
 192 extern      ACPI_TABLE_DESC             AcpiGbl_AcpiTables[NUM_ACPI_TABLES];
 193 extern      ACPI_TABLE_SUPPORT          AcpiGbl_AcpiTableData[NUM_ACPI_TABLES];
 194
 195 /*
 196  * Predefined mutex objects.  This array contains the
 197  * actual OS mutex handles, indexed by the local ACPI_MUTEX_HANDLEs.
 198  * (The table maps local handles to the real OS handles)
 199  */
 200 ACPI_EXTERN ACPI_MUTEX_INFO             AcpiGbl_AcpiMutexInfo [NUM_MTX];
 201
 202
 203 /*****************************************************************************
 204  *
 205  * Miscellaneous globals
 206  *
 207  ****************************************************************************/
 208
 209
 210 ACPI_EXTERN ACPI_MEMORY_LIST            AcpiGbl_MemoryLists[ACPI_NUM_MEM_LISTS];
 211 ACPI_EXTERN ACPI_OBJECT_NOTIFY_HANDLER  AcpiGbl_DrvNotify;
 212 ACPI_EXTERN ACPI_OBJECT_NOTIFY_HANDLER  AcpiGbl_SysNotify;
 213 ACPI_EXTERN ACPI_INIT_HANDLER           AcpiGbl_InitHandler;
 214 ACPI_EXTERN ACPI_WALK_STATE            *AcpiGbl_BreakpointWalk;
 215 ACPI_EXTERN ACPI_HANDLE                 AcpiGbl_GlobalLockSemaphore;
 216
 217 ACPI_EXTERN UINT32                      AcpiGbl_GlobalLockThreadCount;
 218 ACPI_EXTERN UINT32                      AcpiGbl_OriginalMode;
 219 ACPI_EXTERN UINT32                      AcpiGbl_RsdpOriginalLocation;
 220 ACPI_EXTERN UINT32                      AcpiGbl_NsLookupCount;
 221 ACPI_EXTERN UINT32                      AcpiGbl_PsFindCount;
 222 ACPI_EXTERN UINT16                      AcpiGbl_Pm1EnableRegisterSave;
 223 ACPI_EXTERN UINT16                      AcpiGbl_NextTableOwnerId;
 224 ACPI_EXTERN UINT16                      AcpiGbl_NextMethodOwnerId;
 225 ACPI_EXTERN UINT16                      AcpiGbl_GlobalLockHandle;
 226 ACPI_EXTERN UINT8                       AcpiGbl_DebuggerConfiguration;
 227 ACPI_EXTERN BOOLEAN                     AcpiGbl_GlobalLockAcquired;
 228 ACPI_EXTERN BOOLEAN                     AcpiGbl_StepToNextCall;
 229 ACPI_EXTERN BOOLEAN                     AcpiGbl_AcpiHardwarePresent;
 230 ACPI_EXTERN BOOLEAN                     AcpiGbl_GlobalLockPresent;
 231 ACPI_EXTERN BOOLEAN                     AcpiGbl_EventsInitialized;
 232
 233 extern BOOLEAN                          AcpiGbl_Shutdown;
 234 extern UINT32                           AcpiGbl_StartupFlags;
 235 extern const UINT8                      AcpiGbl_DecodeTo8bit[8];
 236 extern const char                      *AcpiGbl_DbSleepStates[ACPI_S_STATE_COUNT];
 237 extern const ACPI_OPCODE_INFO           AcpiGbl_AmlOpInfo[AML_NUM_OPCODES];
 238 extern const char                      *AcpiGbl_RegionTypes[ACPI_NUM_PREDEFINED_REGIONS];
 239
 240
 241 /*****************************************************************************
 242  *
 243  * Namespace globals
 244  *
 245  ****************************************************************************/
 246
 247 #define NUM_NS_TYPES                    ACPI_TYPE_INVALID+1
 248
 249 #if defined (ACPI_NO_METHOD_EXECUTION) || defined (ACPI_CONSTANT_EVAL_ONLY)
 250 #define NUM_PREDEFINED_NAMES            10
 251 #else
 252 #define NUM_PREDEFINED_NAMES            9
 253 #endif
 254
 255 ACPI_EXTERN ACPI_NAMESPACE_NODE         AcpiGbl_RootNodeStruct;
 256 ACPI_EXTERN ACPI_NAMESPACE_NODE        *AcpiGbl_RootNode;
 257
 258 extern const UINT8                      AcpiGbl_NsProperties[NUM_NS_TYPES];
 259 extern const ACPI_PREDEFINED_NAMES      AcpiGbl_PreDefinedNames [NUM_PREDEFINED_NAMES];
 260
 261 #ifdef ACPI_DEBUG_OUTPUT
 262 ACPI_EXTERN UINT32                      AcpiGbl_CurrentNodeCount;
 263 ACPI_EXTERN UINT32                      AcpiGbl_CurrentNodeSize;
 264 ACPI_EXTERN UINT32                      AcpiGbl_MaxConcurrentNodeCount;
 265 ACPI_EXTERN ACPI_SIZE                   AcpiGbl_EntryStackPointer;
 266 ACPI_EXTERN ACPI_SIZE                   AcpiGbl_LowestStackPointer;
 267 ACPI_EXTERN UINT32                      AcpiGbl_DeepestNesting;
 268 #endif
 269
 270 /*****************************************************************************
 271  *
 272  * Interpreter globals
 273  *
 274  ****************************************************************************/
 275
 276
 277 ACPI_EXTERN ACPI_THREAD_STATE           *AcpiGbl_CurrentWalkList;
 278
 279 /* Control method single step flag */
 280
 281 ACPI_EXTERN UINT8                       AcpiGbl_CmSingleStep;
 282
 283
 284 /*****************************************************************************
 285  *
 286  * Parser globals
 287  *
 288  ****************************************************************************/
 289
 290 ACPI_EXTERN ACPI_PARSE_OBJECT           *AcpiGbl_ParsedNamespaceRoot;
 291
 292 /*****************************************************************************
 293  *
 294  * Hardware globals
 295  *
 296  ****************************************************************************/
 297
 298 extern      ACPI_BIT_REGISTER_INFO      AcpiGbl_BitRegisterInfo[ACPI_NUM_BITREG];
 299 ACPI_EXTERN UINT8                       AcpiGbl_SleepTypeA;
 300 ACPI_EXTERN UINT8                       AcpiGbl_SleepTypeB;
 301
 302
 303 /*****************************************************************************
 304  *
 305  * Event and GPE globals
 306  *
 307  ****************************************************************************/
 308
 309 extern      ACPI_FIXED_EVENT_INFO       AcpiGbl_FixedEventInfo[ACPI_NUM_FIXED_EVENTS];
 310 ACPI_EXTERN ACPI_FIXED_EVENT_HANDLER    AcpiGbl_FixedEventHandlers[ACPI_NUM_FIXED_EVENTS];
 311 ACPI_EXTERN ACPI_GPE_BLOCK_INFO         *AcpiGbl_GpeBlockListHead;
 312
 313
 314 /*****************************************************************************
 315  *
 316  * Debugger globals
 317  *
 318  ****************************************************************************/
 319
 320
 321 ACPI_EXTERN UINT8                       AcpiGbl_DbOutputFlags;
 322
 323 #ifdef ACPI_DISASSEMBLER
 324
 325 ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_disasm;
 326 ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_verbose;
 327 #endif
 328
 329
 330 #ifdef ACPI_DEBUGGER
 331
 332 extern      BOOLEAN                     AcpiGbl_MethodExecuting;
 333 extern      BOOLEAN                     AcpiGbl_AbortMethod;
 334 extern      BOOLEAN                     AcpiGbl_DbTerminateThreads;
 335
 336 ACPI_EXTERN int                         optind;
 337 ACPI_EXTERN char                       *optarg;
 338
 339 ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_tables;
 340 ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_stats;
 341 ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_ini_methods;
 342
 343
 344 ACPI_EXTERN char                       *AcpiGbl_DbArgs[ACPI_DEBUGGER_MAX_ARGS];
 345 ACPI_EXTERN char                        AcpiGbl_DbLineBuf[80];
 346 ACPI_EXTERN char                        AcpiGbl_DbParsedBuf[80];
 347 ACPI_EXTERN char                        AcpiGbl_DbScopeBuf[40];
 348 ACPI_EXTERN char                        AcpiGbl_DbDebugFilename[40];
 349 ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOutputToFile;
 350 ACPI_EXTERN char                       *AcpiGbl_DbBuffer;
 351 ACPI_EXTERN char                       *AcpiGbl_DbFilename;
 352 ACPI_EXTERN UINT32                      AcpiGbl_DbDebugLevel;
 353 ACPI_EXTERN UINT32                      AcpiGbl_DbConsoleDebugLevel;
 354 ACPI_EXTERN ACPI_TABLE_HEADER          *AcpiGbl_DbTablePtr;
 355 ACPI_EXTERN ACPI_NAMESPACE_NODE        *AcpiGbl_DbScopeNode;
 356
 357 /*
 358  * Statistic globals
 359  */
 360 ACPI_EXTERN UINT16                      AcpiGbl_ObjTypeCount[ACPI_TYPE_NS_NODE_MAX+1];
 361 ACPI_EXTERN UINT16                      AcpiGbl_NodeTypeCount[ACPI_TYPE_NS_NODE_MAX+1];
 362 ACPI_EXTERN UINT16                      AcpiGbl_ObjTypeCountMisc;
 363 ACPI_EXTERN UINT16                      AcpiGbl_NodeTypeCountMisc;
 364 ACPI_EXTERN UINT32                      AcpiGbl_NumNodes;
 365 ACPI_EXTERN UINT32                      AcpiGbl_NumObjects;
 366
 367
 368 ACPI_EXTERN UINT32                      AcpiGbl_SizeOfParseTree;
 369 ACPI_EXTERN UINT32                      AcpiGbl_SizeOfMethodTrees;
 370 ACPI_EXTERN UINT32                      AcpiGbl_SizeOfNodeEntries;
 371 ACPI_EXTERN UINT32                      AcpiGbl_SizeOfAcpiObjects;
 372
 373 #endif /* ACPI_DEBUGGER */
 374
 375
 376 #endif /* __ACGLOBAL_H__ */