1 /******************************************************************************
3 * Name: acglobal.h - Declarations for global variables
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp.
12 * All rights reserved.
16 * 2.1. This is your license from Intel Corp. under its intellectual property
17 * rights. You may have additional license terms from the party that provided
18 * you this software, covering your right to use that party's intellectual
21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22 * copy of the source code appearing in this file ("Covered Code") an
23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24 * base code distributed originally by Intel ("Original Intel Code") to copy,
25 * make derivatives, distribute, use and display any portion of the Covered
26 * Code in any form, with the right to sublicense such rights; and
28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29 * license (with the right to sublicense), under only those claims of Intel
30 * patents that are infringed by the Original Intel Code, to make, use, sell,
31 * offer to sell, and import the Covered Code and derivative works thereof
32 * solely to the minimum extent necessary to exercise the above copyright
33 * license, and in no event shall the patent license extend to any additions
34 * to or modifications of the Original Intel Code. No other license or right
35 * is granted directly or by implication, estoppel or otherwise;
37 * The above copyright and patent license is granted only if the following
42 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43 * Redistribution of source code of any substantial portion of the Covered
44 * Code or modification with rights to further distribute source must include
45 * the above Copyright Notice, the above License, this list of Conditions,
46 * and the following Disclaimer and Export Compliance provision. In addition,
47 * Licensee must cause all Covered Code to which Licensee contributes to
48 * contain a file documenting the changes Licensee made to create that Covered
49 * Code and the date of any change. Licensee must include in that file the
50 * documentation of any changes made by any predecessor Licensee. Licensee
51 * must include a prominent statement that the modification is derived,
52 * directly or indirectly, from Original Intel Code.
54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55 * Redistribution of source code of any substantial portion of the Covered
56 * Code or modification without rights to further distribute source must
57 * include the following Disclaimer and Export Compliance provision in the
58 * documentation and/or other materials provided with distribution. In
59 * addition, Licensee may not authorize further sublicense of source of any
60 * portion of the Covered Code, and must include terms to the effect that the
61 * license from Licensee to its licensee is limited to the intellectual
62 * property embodied in the software Licensee provides to its licensee, and
63 * not to intellectual property embodied in modifications its licensee may
66 * 3.3. Redistribution of Executable. Redistribution in executable form of any
67 * substantial portion of the Covered Code or modification must reproduce the
68 * above Copyright Notice, and the following Disclaimer and Export Compliance
69 * provision in the documentation and/or other materials provided with the
72 * 3.4. Intel retains all right, title, and interest in and to the Original
75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76 * Intel shall be used in advertising or otherwise to promote the sale, use or
77 * other dealings in products derived from or relating to the Covered Code
78 * without prior written authorization from Intel.
80 * 4. Disclaimer and Export Compliance
82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
114 *****************************************************************************/
116 #ifndef __ACGLOBAL_H__
117 #define __ACGLOBAL_H__
121 * Ensure that the globals are actually defined and initialized only once.
123 * The use of these macros allows a single list of globals (here) in order
124 * to simplify maintenance of the code.
126 #ifdef DEFINE_ACPI_GLOBALS
128 #define ACPI_INIT_GLOBAL(a,b) a=b
130 #define ACPI_EXTERN extern
131 #define ACPI_INIT_GLOBAL(a,b) a
135 #ifdef DEFINE_ACPI_GLOBALS
137 /* Public globals, available from outside ACPICA subsystem */
139 /*****************************************************************************
141 * Runtime configuration (static defaults that can be overriden at runtime)
143 ****************************************************************************/
146 * Enable "slack" in the AML interpreter? Default is FALSE, and the
147 * interpreter strictly follows the ACPI specification. Setting to TRUE
148 * allows the interpreter to ignore certain errors and/or bad AML constructs.
150 * Currently, these features are enabled by this flag:
152 * 1) Allow "implicit return" of last value in a control method
153 * 2) Allow access beyond the end of an operation region
154 * 3) Allow access to uninitialized locals/args (auto-init to integer 0)
155 * 4) Allow ANY object type to be a source operand for the Store() operator
156 * 5) Allow unresolved references (invalid target name) in package objects
157 * 6) Enable warning messages for behavior that is not ACPI spec compliant
159 UINT8 ACPI_INIT_GLOBAL (AcpiGbl_EnableInterpreterSlack, FALSE);
162 * Automatically serialize ALL control methods? Default is FALSE, meaning
163 * to use the Serialized/NotSerialized method flags on a per method basis.
164 * Only change this if the ASL code is poorly written and cannot handle
165 * reentrancy even though methods are marked "NotSerialized".
167 UINT8 ACPI_INIT_GLOBAL (AcpiGbl_AllMethodsSerialized, FALSE);
170 * Create the predefined _OSI method in the namespace? Default is TRUE
171 * because ACPI CA is fully compatible with other ACPI implementations.
172 * Changing this will revert ACPI CA (and machine ASL) to pre-OSI behavior.
174 UINT8 ACPI_INIT_GLOBAL (AcpiGbl_CreateOsiMethod, TRUE);
177 * Disable wakeup GPEs during runtime? Default is TRUE because WAKE and
178 * RUNTIME GPEs should never be shared, and WAKE GPEs should typically only
179 * be enabled just before going to sleep.
181 UINT8 ACPI_INIT_GLOBAL (AcpiGbl_LeaveWakeGpesDisabled, TRUE);
184 * Optionally use default values for the ACPI register widths. Set this to
185 * TRUE to use the defaults, if an FADT contains incorrect widths/lengths.
187 UINT8 ACPI_INIT_GLOBAL (AcpiGbl_UseDefaultRegisterWidths, TRUE);
190 * Optionally enable output from the AML Debug Object.
192 UINT8 ACPI_INIT_GLOBAL (AcpiGbl_EnableAmlDebugObject, FALSE);
195 * Optionally copy the entire DSDT to local memory (instead of simply
196 * mapping it.) There are some BIOSs that corrupt or replace the original
197 * DSDT, creating the need for this option. Default is FALSE, do not copy
200 UINT8 ACPI_INIT_GLOBAL (AcpiGbl_CopyDsdtLocally, FALSE);
203 * Optionally truncate I/O addresses to 16 bits. Provides compatibility
204 * with other ACPI implementations. NOTE: During ACPICA initialization,
205 * this value is set to TRUE if any Windows OSI strings have been
206 * requested by the BIOS.
208 UINT8 ACPI_INIT_GLOBAL (AcpiGbl_TruncateIoAddresses, FALSE);
211 /* AcpiGbl_FADT is a local copy of the FADT, converted to a common format. */
213 ACPI_TABLE_FADT AcpiGbl_FADT;
214 UINT32 AcpiCurrentGpeCount;
215 UINT32 AcpiGbl_TraceFlags;
216 ACPI_NAME AcpiGbl_TraceMethodName;
217 BOOLEAN AcpiGbl_SystemAwakeAndRunning;
221 /*****************************************************************************
225 ****************************************************************************/
228 * AcpiGbl_RootTableList is the master list of ACPI tables that were
229 * found in the RSDT/XSDT.
231 ACPI_EXTERN ACPI_TABLE_LIST AcpiGbl_RootTableList;
232 ACPI_EXTERN ACPI_TABLE_FACS *AcpiGbl_FACS;
234 /* These addresses are calculated from the FADT Event Block addresses */
236 ACPI_EXTERN ACPI_GENERIC_ADDRESS AcpiGbl_XPm1aStatus;
237 ACPI_EXTERN ACPI_GENERIC_ADDRESS AcpiGbl_XPm1aEnable;
239 ACPI_EXTERN ACPI_GENERIC_ADDRESS AcpiGbl_XPm1bStatus;
240 ACPI_EXTERN ACPI_GENERIC_ADDRESS AcpiGbl_XPm1bEnable;
242 /* DSDT information. Used to check for DSDT corruption */
244 ACPI_EXTERN ACPI_TABLE_HEADER *AcpiGbl_DSDT;
245 ACPI_EXTERN ACPI_TABLE_HEADER AcpiGbl_OriginalDsdtHeader;
248 * Handle both ACPI 1.0 and ACPI 2.0 Integer widths. The integer width is
249 * determined by the revision of the DSDT: If the DSDT revision is less than
250 * 2, use only the lower 32 bits of the internal 64-bit Integer.
252 ACPI_EXTERN UINT8 AcpiGbl_IntegerBitWidth;
253 ACPI_EXTERN UINT8 AcpiGbl_IntegerByteWidth;
254 ACPI_EXTERN UINT8 AcpiGbl_IntegerNybbleWidth;
257 /*****************************************************************************
259 * Mutual exlusion within ACPICA subsystem
261 ****************************************************************************/
264 * Predefined mutex objects. This array contains the
265 * actual OS mutex handles, indexed by the local ACPI_MUTEX_HANDLEs.
266 * (The table maps local handles to the real OS handles)
268 ACPI_EXTERN ACPI_MUTEX_INFO AcpiGbl_MutexInfo[ACPI_NUM_MUTEX];
271 * Global lock mutex is an actual AML mutex object
272 * Global lock semaphore works in conjunction with the HW global lock
274 ACPI_EXTERN ACPI_OPERAND_OBJECT *AcpiGbl_GlobalLockMutex;
275 ACPI_EXTERN ACPI_SEMAPHORE AcpiGbl_GlobalLockSemaphore;
276 ACPI_EXTERN UINT16 AcpiGbl_GlobalLockHandle;
277 ACPI_EXTERN BOOLEAN AcpiGbl_GlobalLockAcquired;
278 ACPI_EXTERN BOOLEAN AcpiGbl_GlobalLockPresent;
281 * Spinlocks are used for interfaces that can be possibly called at
284 ACPI_EXTERN ACPI_SPINLOCK AcpiGbl_GpeLock; /* For GPE data structs and registers */
285 ACPI_EXTERN ACPI_SPINLOCK AcpiGbl_HardwareLock; /* For ACPI H/W except GPE registers */
287 /* Mutex for _OSI support */
289 ACPI_EXTERN ACPI_MUTEX AcpiGbl_OsiMutex;
291 /* Reader/Writer lock is used for namespace walk and dynamic table unload */
293 ACPI_EXTERN ACPI_RW_LOCK AcpiGbl_NamespaceRwLock;
296 /*****************************************************************************
298 * Miscellaneous globals
300 ****************************************************************************/
304 ACPI_EXTERN ACPI_CACHE_T *AcpiGbl_NamespaceCache;
305 ACPI_EXTERN ACPI_CACHE_T *AcpiGbl_StateCache;
306 ACPI_EXTERN ACPI_CACHE_T *AcpiGbl_PsNodeCache;
307 ACPI_EXTERN ACPI_CACHE_T *AcpiGbl_PsNodeExtCache;
308 ACPI_EXTERN ACPI_CACHE_T *AcpiGbl_OperandCache;
310 /* Global handlers */
312 ACPI_EXTERN ACPI_OBJECT_NOTIFY_HANDLER AcpiGbl_DeviceNotify;
313 ACPI_EXTERN ACPI_OBJECT_NOTIFY_HANDLER AcpiGbl_SystemNotify;
314 ACPI_EXTERN ACPI_EXCEPTION_HANDLER AcpiGbl_ExceptionHandler;
315 ACPI_EXTERN ACPI_INIT_HANDLER AcpiGbl_InitHandler;
316 ACPI_EXTERN ACPI_TABLE_HANDLER AcpiGbl_TableHandler;
317 ACPI_EXTERN void *AcpiGbl_TableHandlerContext;
318 ACPI_EXTERN ACPI_WALK_STATE *AcpiGbl_BreakpointWalk;
319 ACPI_EXTERN ACPI_INTERFACE_HANDLER AcpiGbl_InterfaceHandler;
321 /* Owner ID support */
323 ACPI_EXTERN UINT32 AcpiGbl_OwnerIdMask[ACPI_NUM_OWNERID_MASKS];
324 ACPI_EXTERN UINT8 AcpiGbl_LastOwnerIdIndex;
325 ACPI_EXTERN UINT8 AcpiGbl_NextOwnerIdOffset;
329 ACPI_EXTERN UINT32 AcpiGbl_OriginalMode;
330 ACPI_EXTERN UINT32 AcpiGbl_RsdpOriginalLocation;
331 ACPI_EXTERN UINT32 AcpiGbl_NsLookupCount;
332 ACPI_EXTERN UINT32 AcpiGbl_PsFindCount;
333 ACPI_EXTERN UINT16 AcpiGbl_Pm1EnableRegisterSave;
334 ACPI_EXTERN UINT8 AcpiGbl_DebuggerConfiguration;
335 ACPI_EXTERN BOOLEAN AcpiGbl_StepToNextCall;
336 ACPI_EXTERN BOOLEAN AcpiGbl_AcpiHardwarePresent;
337 ACPI_EXTERN BOOLEAN AcpiGbl_EventsInitialized;
338 ACPI_EXTERN UINT8 AcpiGbl_OsiData;
339 ACPI_EXTERN ACPI_INTERFACE_INFO *AcpiGbl_SupportedInterfaces;
342 #ifndef DEFINE_ACPI_GLOBALS
344 /* Exception codes */
346 extern char const *AcpiGbl_ExceptionNames_Env[];
347 extern char const *AcpiGbl_ExceptionNames_Pgm[];
348 extern char const *AcpiGbl_ExceptionNames_Tbl[];
349 extern char const *AcpiGbl_ExceptionNames_Aml[];
350 extern char const *AcpiGbl_ExceptionNames_Ctrl[];
352 /* Other miscellaneous */
354 extern BOOLEAN AcpiGbl_Shutdown;
355 extern UINT32 AcpiGbl_StartupFlags;
356 extern const char *AcpiGbl_SleepStateNames[ACPI_S_STATE_COUNT];
357 extern const char *AcpiGbl_LowestDstateNames[ACPI_NUM_SxW_METHODS];
358 extern const char *AcpiGbl_HighestDstateNames[ACPI_NUM_SxD_METHODS];
359 extern const ACPI_OPCODE_INFO AcpiGbl_AmlOpInfo[AML_NUM_OPCODES];
360 extern const char *AcpiGbl_RegionTypes[ACPI_NUM_PREDEFINED_REGIONS];
364 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
366 /* Lists for tracking memory allocations */
368 ACPI_EXTERN ACPI_MEMORY_LIST *AcpiGbl_GlobalList;
369 ACPI_EXTERN ACPI_MEMORY_LIST *AcpiGbl_NsNodeList;
370 ACPI_EXTERN BOOLEAN AcpiGbl_DisplayFinalMemStats;
371 ACPI_EXTERN BOOLEAN AcpiGbl_DisableMemTracking;
375 /*****************************************************************************
379 ****************************************************************************/
381 #if !defined (ACPI_NO_METHOD_EXECUTION) || defined (ACPI_CONSTANT_EVAL_ONLY)
382 #define NUM_PREDEFINED_NAMES 10
384 #define NUM_PREDEFINED_NAMES 9
387 ACPI_EXTERN ACPI_NAMESPACE_NODE AcpiGbl_RootNodeStruct;
388 ACPI_EXTERN ACPI_NAMESPACE_NODE *AcpiGbl_RootNode;
389 ACPI_EXTERN ACPI_NAMESPACE_NODE *AcpiGbl_FadtGpeDevice;
390 ACPI_EXTERN ACPI_OPERAND_OBJECT *AcpiGbl_ModuleCodeList;
393 extern const UINT8 AcpiGbl_NsProperties [ACPI_NUM_NS_TYPES];
394 extern const ACPI_PREDEFINED_NAMES AcpiGbl_PreDefinedNames [NUM_PREDEFINED_NAMES];
396 #ifdef ACPI_DEBUG_OUTPUT
397 ACPI_EXTERN UINT32 AcpiGbl_CurrentNodeCount;
398 ACPI_EXTERN UINT32 AcpiGbl_CurrentNodeSize;
399 ACPI_EXTERN UINT32 AcpiGbl_MaxConcurrentNodeCount;
400 ACPI_EXTERN ACPI_SIZE *AcpiGbl_EntryStackPointer;
401 ACPI_EXTERN ACPI_SIZE *AcpiGbl_LowestStackPointer;
402 ACPI_EXTERN UINT32 AcpiGbl_DeepestNesting;
406 /*****************************************************************************
408 * Interpreter globals
410 ****************************************************************************/
413 ACPI_EXTERN ACPI_THREAD_STATE *AcpiGbl_CurrentWalkList;
415 /* Control method single step flag */
417 ACPI_EXTERN UINT8 AcpiGbl_CmSingleStep;
420 /*****************************************************************************
424 ****************************************************************************/
426 extern ACPI_BIT_REGISTER_INFO AcpiGbl_BitRegisterInfo[ACPI_NUM_BITREG];
427 ACPI_EXTERN UINT8 AcpiGbl_SleepTypeA;
428 ACPI_EXTERN UINT8 AcpiGbl_SleepTypeB;
431 /*****************************************************************************
433 * Event and GPE globals
435 ****************************************************************************/
437 extern ACPI_FIXED_EVENT_INFO AcpiGbl_FixedEventInfo[ACPI_NUM_FIXED_EVENTS];
438 ACPI_EXTERN ACPI_FIXED_EVENT_HANDLER AcpiGbl_FixedEventHandlers[ACPI_NUM_FIXED_EVENTS];
439 ACPI_EXTERN ACPI_GPE_XRUPT_INFO *AcpiGbl_GpeXruptListHead;
440 ACPI_EXTERN ACPI_GPE_BLOCK_INFO *AcpiGbl_GpeFadtBlocks[ACPI_MAX_GPE_BLOCKS];
443 /*****************************************************************************
447 ****************************************************************************/
449 /* Procedure nesting level for debug output */
451 extern UINT32 AcpiGbl_NestingLevel;
455 ACPI_EXTERN UINT32 AcpiMethodCount;
456 ACPI_EXTERN UINT32 AcpiGpeCount;
457 ACPI_EXTERN UINT32 AcpiSciCount;
458 ACPI_EXTERN UINT32 AcpiFixedEventCount[ACPI_NUM_FIXED_EVENTS];
460 /* Support for dynamic control method tracing mechanism */
462 ACPI_EXTERN UINT32 AcpiGbl_OriginalDbgLevel;
463 ACPI_EXTERN UINT32 AcpiGbl_OriginalDbgLayer;
464 ACPI_EXTERN UINT32 AcpiGbl_TraceDbgLevel;
465 ACPI_EXTERN UINT32 AcpiGbl_TraceDbgLayer;
468 /*****************************************************************************
472 ****************************************************************************/
474 ACPI_EXTERN UINT8 AcpiGbl_DbOutputFlags;
476 #ifdef ACPI_DISASSEMBLER
478 ACPI_EXTERN BOOLEAN AcpiGbl_DbOpt_disasm;
479 ACPI_EXTERN BOOLEAN AcpiGbl_DbOpt_verbose;
480 ACPI_EXTERN ACPI_EXTERNAL_LIST *AcpiGbl_ExternalList;
481 ACPI_EXTERN ACPI_EXTERNAL_FILE *AcpiGbl_ExternalFileList;
487 extern BOOLEAN AcpiGbl_MethodExecuting;
488 extern BOOLEAN AcpiGbl_AbortMethod;
489 extern BOOLEAN AcpiGbl_DbTerminateThreads;
491 ACPI_EXTERN BOOLEAN AcpiGbl_DbOpt_tables;
492 ACPI_EXTERN BOOLEAN AcpiGbl_DbOpt_stats;
493 ACPI_EXTERN BOOLEAN AcpiGbl_DbOpt_ini_methods;
494 ACPI_EXTERN BOOLEAN AcpiGbl_DbOpt_NoRegionSupport;
496 ACPI_EXTERN char *AcpiGbl_DbArgs[ACPI_DEBUGGER_MAX_ARGS];
497 ACPI_EXTERN char AcpiGbl_DbLineBuf[80];
498 ACPI_EXTERN char AcpiGbl_DbParsedBuf[80];
499 ACPI_EXTERN char AcpiGbl_DbScopeBuf[40];
500 ACPI_EXTERN char AcpiGbl_DbDebugFilename[40];
501 ACPI_EXTERN BOOLEAN AcpiGbl_DbOutputToFile;
502 ACPI_EXTERN char *AcpiGbl_DbBuffer;
503 ACPI_EXTERN char *AcpiGbl_DbFilename;
504 ACPI_EXTERN UINT32 AcpiGbl_DbDebugLevel;
505 ACPI_EXTERN UINT32 AcpiGbl_DbConsoleDebugLevel;
506 ACPI_EXTERN ACPI_NAMESPACE_NODE *AcpiGbl_DbScopeNode;
511 ACPI_EXTERN UINT16 AcpiGbl_ObjTypeCount[ACPI_TYPE_NS_NODE_MAX+1];
512 ACPI_EXTERN UINT16 AcpiGbl_NodeTypeCount[ACPI_TYPE_NS_NODE_MAX+1];
513 ACPI_EXTERN UINT16 AcpiGbl_ObjTypeCountMisc;
514 ACPI_EXTERN UINT16 AcpiGbl_NodeTypeCountMisc;
515 ACPI_EXTERN UINT32 AcpiGbl_NumNodes;
516 ACPI_EXTERN UINT32 AcpiGbl_NumObjects;
519 ACPI_EXTERN UINT32 AcpiGbl_SizeOfParseTree;
520 ACPI_EXTERN UINT32 AcpiGbl_SizeOfMethodTrees;
521 ACPI_EXTERN UINT32 AcpiGbl_SizeOfNodeEntries;
522 ACPI_EXTERN UINT32 AcpiGbl_SizeOfAcpiObjects;
524 #endif /* ACPI_DEBUGGER */
526 #endif /* __ACGLOBAL_H__ */