reactos/drivers/bus/acpi/acpica/include/acglobal.h

   1 /******************************************************************************
   2  *
   3  * Name: acglobal.h - Declarations for global variables
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2016, Intel Corp.
   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  *
  50  * Globals related to the ACPI tables
  51  *
  52  ****************************************************************************/
  53
  54 /* Master list of all ACPI tables that were found in the RSDT/XSDT */
  55
  56 ACPI_GLOBAL (ACPI_TABLE_LIST,           AcpiGbl_RootTableList);
  57
  58 /* DSDT information. Used to check for DSDT corruption */
  59
  60 ACPI_GLOBAL (ACPI_TABLE_HEADER *,       AcpiGbl_DSDT);
  61 ACPI_GLOBAL (ACPI_TABLE_HEADER,         AcpiGbl_OriginalDsdtHeader);
  62 ACPI_INIT_GLOBAL (UINT32,               AcpiGbl_DsdtIndex, ACPI_INVALID_TABLE_INDEX);
  63 ACPI_INIT_GLOBAL (UINT32,               AcpiGbl_FacsIndex, ACPI_INVALID_TABLE_INDEX);
  64 ACPI_INIT_GLOBAL (UINT32,               AcpiGbl_XFacsIndex, ACPI_INVALID_TABLE_INDEX);
  65 ACPI_INIT_GLOBAL (UINT32,               AcpiGbl_FadtIndex, ACPI_INVALID_TABLE_INDEX);
  66
  67 #if (!ACPI_REDUCED_HARDWARE)
  68 ACPI_GLOBAL (ACPI_TABLE_FACS *,         AcpiGbl_FACS);
  69
  70 #endif /* !ACPI_REDUCED_HARDWARE */
  71
  72 /* These addresses are calculated from the FADT Event Block addresses */
  73
  74 ACPI_GLOBAL (ACPI_GENERIC_ADDRESS,      AcpiGbl_XPm1aStatus);
  75 ACPI_GLOBAL (ACPI_GENERIC_ADDRESS,      AcpiGbl_XPm1aEnable);
  76
  77 ACPI_GLOBAL (ACPI_GENERIC_ADDRESS,      AcpiGbl_XPm1bStatus);
  78 ACPI_GLOBAL (ACPI_GENERIC_ADDRESS,      AcpiGbl_XPm1bEnable);
  79
  80 /*
  81  * Handle both ACPI 1.0 and ACPI 2.0+ Integer widths. The integer width is
  82  * determined by the revision of the DSDT: If the DSDT revision is less than
  83  * 2, use only the lower 32 bits of the internal 64-bit Integer.
  84  */
  85 ACPI_GLOBAL (UINT8,                     AcpiGbl_IntegerBitWidth);
  86 ACPI_GLOBAL (UINT8,                     AcpiGbl_IntegerByteWidth);
  87 ACPI_GLOBAL (UINT8,                     AcpiGbl_IntegerNybbleWidth);
  88
  89
  90 /*****************************************************************************
  91  *
  92  * Mutual exclusion within ACPICA subsystem
  93  *
  94  ****************************************************************************/
  95
  96 /*
  97  * Predefined mutex objects. This array contains the
  98  * actual OS mutex handles, indexed by the local ACPI_MUTEX_HANDLEs.
  99  * (The table maps local handles to the real OS handles)
 100  */
 101 ACPI_GLOBAL (ACPI_MUTEX_INFO,           AcpiGbl_MutexInfo[ACPI_NUM_MUTEX]);
 102
 103 /*
 104  * Global lock mutex is an actual AML mutex object
 105  * Global lock semaphore works in conjunction with the actual global lock
 106  * Global lock spinlock is used for "pending" handshake
 107  */
 108 ACPI_GLOBAL (ACPI_OPERAND_OBJECT *,     AcpiGbl_GlobalLockMutex);
 109 ACPI_GLOBAL (ACPI_SEMAPHORE,            AcpiGbl_GlobalLockSemaphore);
 110 ACPI_GLOBAL (ACPI_SPINLOCK,             AcpiGbl_GlobalLockPendingLock);
 111 ACPI_GLOBAL (UINT16,                    AcpiGbl_GlobalLockHandle);
 112 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_GlobalLockAcquired);
 113 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_GlobalLockPresent);
 114 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_GlobalLockPending);
 115
 116 /*
 117  * Spinlocks are used for interfaces that can be possibly called at
 118  * interrupt level
 119  */
 120 ACPI_GLOBAL (ACPI_SPINLOCK,             AcpiGbl_GpeLock);       /* For GPE data structs and registers */
 121 ACPI_GLOBAL (ACPI_SPINLOCK,             AcpiGbl_HardwareLock);  /* For ACPI H/W except GPE registers */
 122 ACPI_GLOBAL (ACPI_SPINLOCK,             AcpiGbl_ReferenceCountLock);
 123
 124 /* Mutex for _OSI support */
 125
 126 ACPI_GLOBAL (ACPI_MUTEX,                AcpiGbl_OsiMutex);
 127
 128 /* Reader/Writer lock is used for namespace walk and dynamic table unload */
 129
 130 ACPI_GLOBAL (ACPI_RW_LOCK,              AcpiGbl_NamespaceRwLock);
 131
 132
 133 /*****************************************************************************
 134  *
 135  * Miscellaneous globals
 136  *
 137  ****************************************************************************/
 138
 139 /* Object caches */
 140
 141 ACPI_GLOBAL (ACPI_CACHE_T *,            AcpiGbl_NamespaceCache);
 142 ACPI_GLOBAL (ACPI_CACHE_T *,            AcpiGbl_StateCache);
 143 ACPI_GLOBAL (ACPI_CACHE_T *,            AcpiGbl_PsNodeCache);
 144 ACPI_GLOBAL (ACPI_CACHE_T *,            AcpiGbl_PsNodeExtCache);
 145 ACPI_GLOBAL (ACPI_CACHE_T *,            AcpiGbl_OperandCache);
 146
 147 /* System */
 148
 149 ACPI_INIT_GLOBAL (UINT32,               AcpiGbl_StartupFlags, 0);
 150 ACPI_INIT_GLOBAL (BOOLEAN,              AcpiGbl_Shutdown, TRUE);
 151 ACPI_INIT_GLOBAL (BOOLEAN,              AcpiGbl_EarlyInitialization, TRUE);
 152
 153 /* Global handlers */
 154
 155 ACPI_GLOBAL (ACPI_GLOBAL_NOTIFY_HANDLER,AcpiGbl_GlobalNotify[2]);
 156 ACPI_GLOBAL (ACPI_EXCEPTION_HANDLER,    AcpiGbl_ExceptionHandler);
 157 ACPI_GLOBAL (ACPI_INIT_HANDLER,         AcpiGbl_InitHandler);
 158 ACPI_GLOBAL (ACPI_TABLE_HANDLER,        AcpiGbl_TableHandler);
 159 ACPI_GLOBAL (void *,                    AcpiGbl_TableHandlerContext);
 160 ACPI_GLOBAL (ACPI_INTERFACE_HANDLER,    AcpiGbl_InterfaceHandler);
 161 ACPI_GLOBAL (ACPI_SCI_HANDLER_INFO *,   AcpiGbl_SciHandlerList);
 162
 163 /* Owner ID support */
 164
 165 ACPI_GLOBAL (UINT32,                    AcpiGbl_OwnerIdMask[ACPI_NUM_OWNERID_MASKS]);
 166 ACPI_GLOBAL (UINT8,                     AcpiGbl_LastOwnerIdIndex);
 167 ACPI_GLOBAL (UINT8,                     AcpiGbl_NextOwnerIdOffset);
 168
 169 /* Initialization sequencing */
 170
 171 ACPI_INIT_GLOBAL (BOOLEAN,              AcpiGbl_NamespaceInitialized, FALSE);
 172
 173 /* Misc */
 174
 175 ACPI_GLOBAL (UINT32,                    AcpiGbl_OriginalMode);
 176 ACPI_GLOBAL (UINT32,                    AcpiGbl_NsLookupCount);
 177 ACPI_GLOBAL (UINT32,                    AcpiGbl_PsFindCount);
 178 ACPI_GLOBAL (UINT16,                    AcpiGbl_Pm1EnableRegisterSave);
 179 ACPI_GLOBAL (UINT8,                     AcpiGbl_DebuggerConfiguration);
 180 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_StepToNextCall);
 181 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_AcpiHardwarePresent);
 182 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_EventsInitialized);
 183 ACPI_GLOBAL (ACPI_INTERFACE_INFO *,     AcpiGbl_SupportedInterfaces);
 184 ACPI_GLOBAL (ACPI_ADDRESS_RANGE *,      AcpiGbl_AddressRangeList[ACPI_ADDRESS_RANGE_MAX]);
 185
 186 /* Other miscellaneous, declared and initialized in utglobal */
 187
 188 extern const char                      *AcpiGbl_SleepStateNames[ACPI_S_STATE_COUNT];
 189 extern const char                      *AcpiGbl_LowestDstateNames[ACPI_NUM_SxW_METHODS];
 190 extern const char                      *AcpiGbl_HighestDstateNames[ACPI_NUM_SxD_METHODS];
 191 extern const char                      *AcpiGbl_RegionTypes[ACPI_NUM_PREDEFINED_REGIONS];
 192 extern const char                       AcpiGbl_LowerHexDigits[];
 193 extern const char                       AcpiGbl_UpperHexDigits[];
 194 extern const ACPI_OPCODE_INFO           AcpiGbl_AmlOpInfo[AML_NUM_OPCODES];
 195
 196
 197 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
 198
 199 /* Lists for tracking memory allocations (debug only) */
 200
 201 ACPI_GLOBAL (ACPI_MEMORY_LIST *,        AcpiGbl_GlobalList);
 202 ACPI_GLOBAL (ACPI_MEMORY_LIST *,        AcpiGbl_NsNodeList);
 203 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_DisplayFinalMemStats);
 204 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_DisableMemTracking);
 205 #endif
 206
 207
 208 /*****************************************************************************
 209  *
 210  * Namespace globals
 211  *
 212  ****************************************************************************/
 213
 214 #if !defined (ACPI_NO_METHOD_EXECUTION) || defined (ACPI_CONSTANT_EVAL_ONLY)
 215 #define NUM_PREDEFINED_NAMES            10
 216 #else
 217 #define NUM_PREDEFINED_NAMES            9
 218 #endif
 219
 220 ACPI_GLOBAL (ACPI_NAMESPACE_NODE,       AcpiGbl_RootNodeStruct);
 221 ACPI_GLOBAL (ACPI_NAMESPACE_NODE *,     AcpiGbl_RootNode);
 222 ACPI_GLOBAL (ACPI_NAMESPACE_NODE *,     AcpiGbl_FadtGpeDevice);
 223 ACPI_GLOBAL (ACPI_OPERAND_OBJECT *,     AcpiGbl_ModuleCodeList);
 224
 225
 226 extern const UINT8                      AcpiGbl_NsProperties [ACPI_NUM_NS_TYPES];
 227 extern const ACPI_PREDEFINED_NAMES      AcpiGbl_PreDefinedNames [NUM_PREDEFINED_NAMES];
 228
 229 #ifdef ACPI_DEBUG_OUTPUT
 230 ACPI_GLOBAL (UINT32,                    AcpiGbl_CurrentNodeCount);
 231 ACPI_GLOBAL (UINT32,                    AcpiGbl_CurrentNodeSize);
 232 ACPI_GLOBAL (UINT32,                    AcpiGbl_MaxConcurrentNodeCount);
 233 ACPI_GLOBAL (ACPI_SIZE *,               AcpiGbl_EntryStackPointer);
 234 ACPI_GLOBAL (ACPI_SIZE *,               AcpiGbl_LowestStackPointer);
 235 ACPI_GLOBAL (UINT32,                    AcpiGbl_DeepestNesting);
 236 ACPI_INIT_GLOBAL (UINT32,               AcpiGbl_NestingLevel, 0);
 237 #endif
 238
 239
 240 /*****************************************************************************
 241  *
 242  * Interpreter globals
 243  *
 244  ****************************************************************************/
 245
 246 ACPI_GLOBAL (ACPI_THREAD_STATE *,       AcpiGbl_CurrentWalkList);
 247
 248 /* Control method single step flag */
 249
 250 ACPI_GLOBAL (UINT8,                     AcpiGbl_CmSingleStep);
 251
 252
 253 /*****************************************************************************
 254  *
 255  * Hardware globals
 256  *
 257  ****************************************************************************/
 258
 259 extern ACPI_BIT_REGISTER_INFO           AcpiGbl_BitRegisterInfo[ACPI_NUM_BITREG];
 260
 261 ACPI_GLOBAL (UINT8,                     AcpiGbl_SleepTypeA);
 262 ACPI_GLOBAL (UINT8,                     AcpiGbl_SleepTypeB);
 263
 264
 265 /*****************************************************************************
 266  *
 267  * Event and GPE globals
 268  *
 269  ****************************************************************************/
 270
 271 #if (!ACPI_REDUCED_HARDWARE)
 272
 273 ACPI_GLOBAL (UINT8,                     AcpiGbl_AllGpesInitialized);
 274 ACPI_GLOBAL (ACPI_GPE_XRUPT_INFO *,     AcpiGbl_GpeXruptListHead);
 275 ACPI_GLOBAL (ACPI_GPE_BLOCK_INFO *,     AcpiGbl_GpeFadtBlocks[ACPI_MAX_GPE_BLOCKS]);
 276 ACPI_GLOBAL (ACPI_GBL_EVENT_HANDLER,    AcpiGbl_GlobalEventHandler);
 277 ACPI_GLOBAL (void *,                    AcpiGbl_GlobalEventHandlerContext);
 278 ACPI_GLOBAL (ACPI_FIXED_EVENT_HANDLER,  AcpiGbl_FixedEventHandlers[ACPI_NUM_FIXED_EVENTS]);
 279
 280 extern ACPI_FIXED_EVENT_INFO            AcpiGbl_FixedEventInfo[ACPI_NUM_FIXED_EVENTS];
 281
 282 #endif /* !ACPI_REDUCED_HARDWARE */
 283
 284 /*****************************************************************************
 285  *
 286  * Debug support
 287  *
 288  ****************************************************************************/
 289
 290 /* Event counters */
 291
 292 ACPI_GLOBAL (UINT32,                    AcpiMethodCount);
 293 ACPI_GLOBAL (UINT32,                    AcpiGpeCount);
 294 ACPI_GLOBAL (UINT32,                    AcpiSciCount);
 295 ACPI_GLOBAL (UINT32,                    AcpiFixedEventCount[ACPI_NUM_FIXED_EVENTS]);
 296
 297 /* Support for dynamic control method tracing mechanism */
 298
 299 ACPI_GLOBAL (UINT32,                    AcpiGbl_OriginalDbgLevel);
 300 ACPI_GLOBAL (UINT32,                    AcpiGbl_OriginalDbgLayer);
 301
 302
 303 /*****************************************************************************
 304  *
 305  * Debugger and Disassembler globals
 306  *
 307  ****************************************************************************/
 308
 309 ACPI_INIT_GLOBAL (UINT8,                AcpiGbl_DbOutputFlags, ACPI_DB_CONSOLE_OUTPUT);
 310
 311 #ifdef ACPI_DISASSEMBLER
 312
 313 /* Do not disassemble buffers to resource descriptors */
 314
 315 ACPI_INIT_GLOBAL (UINT8,                AcpiGbl_NoResourceDisassembly, FALSE);
 316 ACPI_INIT_GLOBAL (BOOLEAN,              AcpiGbl_IgnoreNoopOperator, FALSE);
 317 ACPI_INIT_GLOBAL (BOOLEAN,              AcpiGbl_CstyleDisassembly, TRUE);
 318 ACPI_INIT_GLOBAL (BOOLEAN,              AcpiGbl_ForceAmlDisassembly, FALSE);
 319 ACPI_INIT_GLOBAL (BOOLEAN,              AcpiGbl_DmOpt_Verbose, TRUE);
 320 ACPI_INIT_GLOBAL (BOOLEAN,              AcpiGbl_DmEmitExternalOpcodes, FALSE);
 321 ACPI_INIT_GLOBAL (BOOLEAN,              AcpiGbl_DoDisassemblerOptimizations, TRUE);
 322
 323 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_DmOpt_Disasm);
 324 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_DmOpt_Listing);
 325 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_NumExternalMethods);
 326 ACPI_GLOBAL (UINT32,                    AcpiGbl_ResolvedExternalMethods);
 327 ACPI_GLOBAL (ACPI_EXTERNAL_LIST *,      AcpiGbl_ExternalList);
 328 ACPI_GLOBAL (ACPI_EXTERNAL_FILE *,      AcpiGbl_ExternalFileList);
 329 #endif
 330
 331 #ifdef ACPI_DEBUGGER
 332
 333 ACPI_INIT_GLOBAL (BOOLEAN,              AcpiGbl_AbortMethod, FALSE);
 334 ACPI_INIT_GLOBAL (ACPI_THREAD_ID,       AcpiGbl_DbThreadId, ACPI_INVALID_THREAD_ID);
 335
 336 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_DbOpt_NoIniMethods);
 337 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_DbOpt_NoRegionSupport);
 338 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_DbOutputToFile);
 339 ACPI_GLOBAL (char *,                    AcpiGbl_DbBuffer);
 340 ACPI_GLOBAL (char *,                    AcpiGbl_DbFilename);
 341 ACPI_GLOBAL (UINT32,                    AcpiGbl_DbDebugLevel);
 342 ACPI_GLOBAL (UINT32,                    AcpiGbl_DbConsoleDebugLevel);
 343 ACPI_GLOBAL (ACPI_NAMESPACE_NODE *,     AcpiGbl_DbScopeNode);
 344 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_DbTerminateLoop);
 345 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_DbThreadsTerminated);
 346
 347 ACPI_GLOBAL (char *,                    AcpiGbl_DbArgs[ACPI_DEBUGGER_MAX_ARGS]);
 348 ACPI_GLOBAL (ACPI_OBJECT_TYPE,          AcpiGbl_DbArgTypes[ACPI_DEBUGGER_MAX_ARGS]);
 349
 350 /* These buffers should all be the same size */
 351
 352 ACPI_GLOBAL (char,                      AcpiGbl_DbParsedBuf[ACPI_DB_LINE_BUFFER_SIZE]);
 353 ACPI_GLOBAL (char,                      AcpiGbl_DbScopeBuf[ACPI_DB_LINE_BUFFER_SIZE]);
 354 ACPI_GLOBAL (char,                      AcpiGbl_DbDebugFilename[ACPI_DB_LINE_BUFFER_SIZE]);
 355
 356 /*
 357  * Statistic globals
 358  */
 359 ACPI_GLOBAL (UINT16,                    AcpiGbl_ObjTypeCount[ACPI_TOTAL_TYPES]);
 360 ACPI_GLOBAL (UINT16,                    AcpiGbl_NodeTypeCount[ACPI_TOTAL_TYPES]);
 361 ACPI_GLOBAL (UINT16,                    AcpiGbl_ObjTypeCountMisc);
 362 ACPI_GLOBAL (UINT16,                    AcpiGbl_NodeTypeCountMisc);
 363 ACPI_GLOBAL (UINT32,                    AcpiGbl_NumNodes);
 364 ACPI_GLOBAL (UINT32,                    AcpiGbl_NumObjects);
 365
 366 #endif /* ACPI_DEBUGGER */
 367
 368 #if defined (ACPI_DISASSEMBLER) || defined (ACPI_ASL_COMPILER)
 369
 370 ACPI_GLOBAL (const char,                *AcpiGbl_PldPanelList[]);
 371 ACPI_GLOBAL (const char,                *AcpiGbl_PldVerticalPositionList[]);
 372 ACPI_GLOBAL (const char,                *AcpiGbl_PldHorizontalPositionList[]);
 373 ACPI_GLOBAL (const char,                *AcpiGbl_PldShapeList[]);
 374
 375 #endif
 376
 377 /*****************************************************************************
 378  *
 379  * Application globals
 380  *
 381  ****************************************************************************/
 382
 383 #ifdef ACPI_APPLICATION
 384
 385 ACPI_INIT_GLOBAL (ACPI_FILE,            AcpiGbl_DebugFile, NULL);
 386 ACPI_INIT_GLOBAL (ACPI_FILE,            AcpiGbl_OutputFile, NULL);
 387 ACPI_INIT_GLOBAL (BOOLEAN,              AcpiGbl_DebugTimeout, FALSE);
 388
 389 /* Print buffer */
 390
 391 ACPI_GLOBAL (ACPI_SPINLOCK,             AcpiGbl_PrintLock);     /* For print buffer */
 392 ACPI_GLOBAL (char,                      AcpiGbl_PrintBuffer[1024]);
 393
 394 #endif /* ACPI_APPLICATION */
 395
 396
 397 /*****************************************************************************
 398  *
 399  * Info/help support
 400  *
 401  ****************************************************************************/
 402
 403 extern const AH_PREDEFINED_NAME         AslPredefinedInfo[];
 404 extern const AH_DEVICE_ID               AslDeviceIds[];
 405
 406
 407 #endif /* __ACGLOBAL_H__ */