acglobal.h revision 229989 
1/******************************************************************************
2 *
3 * Name: acglobal.h - Declarations for global variables
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2012, 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 * Ensure that the globals are actually defined and initialized only once.
50 *
51 * The use of these macros allows a single list of globals (here) in order
52 * to simplify maintenance of the code.
53 */
54#ifdef DEFINE_ACPI_GLOBALS
55#define ACPI_EXTERN
56#define ACPI_INIT_GLOBAL(a,b) a=b
57#else
58#define ACPI_EXTERN extern
59#define ACPI_INIT_GLOBAL(a,b) a
60#endif
61
62
63#ifdef DEFINE_ACPI_GLOBALS
64
65/* Public globals, available from outside ACPICA subsystem */
66
67/*****************************************************************************
68 *
69 * Runtime configuration (static defaults that can be overriden at runtime)
70 *
71 ****************************************************************************/
72
73/*
74 * Enable "slack" in the AML interpreter?  Default is FALSE, and the
75 * interpreter strictly follows the ACPI specification.  Setting to TRUE
76 * allows the interpreter to ignore certain errors and/or bad AML constructs.
77 *
78 * Currently, these features are enabled by this flag:
79 *
80 * 1) Allow "implicit return" of last value in a control method
81 * 2) Allow access beyond the end of an operation region
82 * 3) Allow access to uninitialized locals/args (auto-init to integer 0)
83 * 4) Allow ANY object type to be a source operand for the Store() operator
84 * 5) Allow unresolved references (invalid target name) in package objects
85 * 6) Enable warning messages for behavior that is not ACPI spec compliant
86 */
87UINT8       ACPI_INIT_GLOBAL (AcpiGbl_EnableInterpreterSlack, FALSE);
88
89/*
90 * Automatically serialize ALL control methods? Default is FALSE, meaning
91 * to use the Serialized/NotSerialized method flags on a per method basis.
92 * Only change this if the ASL code is poorly written and cannot handle
93 * reentrancy even though methods are marked "NotSerialized".
94 */
95UINT8       ACPI_INIT_GLOBAL (AcpiGbl_AllMethodsSerialized, FALSE);
96
97/*
98 * Create the predefined _OSI method in the namespace? Default is TRUE
99 * because ACPI CA is fully compatible with other ACPI implementations.
100 * Changing this will revert ACPI CA (and machine ASL) to pre-OSI behavior.
101 */
102UINT8       ACPI_INIT_GLOBAL (AcpiGbl_CreateOsiMethod, TRUE);
103
104/*
105 * Optionally use default values for the ACPI register widths. Set this to
106 * TRUE to use the defaults, if an FADT contains incorrect widths/lengths.
107 */
108UINT8       ACPI_INIT_GLOBAL (AcpiGbl_UseDefaultRegisterWidths, TRUE);
109
110/*
111 * Optionally enable output from the AML Debug Object.
112 */
113UINT8       ACPI_INIT_GLOBAL (AcpiGbl_EnableAmlDebugObject, FALSE);
114
115/*
116 * Optionally copy the entire DSDT to local memory (instead of simply
117 * mapping it.) There are some BIOSs that corrupt or replace the original
118 * DSDT, creating the need for this option. Default is FALSE, do not copy
119 * the DSDT.
120 */
121UINT8       ACPI_INIT_GLOBAL (AcpiGbl_CopyDsdtLocally, FALSE);
122
123/*
124 * Optionally truncate I/O addresses to 16 bits. Provides compatibility
125 * with other ACPI implementations. NOTE: During ACPICA initialization,
126 * this value is set to TRUE if any Windows OSI strings have been
127 * requested by the BIOS.
128 */
129UINT8       ACPI_INIT_GLOBAL (AcpiGbl_TruncateIoAddresses, FALSE);
130
131/*
132 * Disable runtime checking and repair of values returned by control methods.
133 * Use only if the repair is causing a problem on a particular machine.
134 */
135UINT8       ACPI_INIT_GLOBAL (AcpiGbl_DisableAutoRepair, FALSE);
136
137
138/* AcpiGbl_FADT is a local copy of the FADT, converted to a common format. */
139
140ACPI_TABLE_FADT             AcpiGbl_FADT;
141UINT32                      AcpiCurrentGpeCount;
142UINT32                      AcpiGbl_TraceFlags;
143ACPI_NAME                   AcpiGbl_TraceMethodName;
144BOOLEAN                     AcpiGbl_SystemAwakeAndRunning;
145
146/*
147 * ACPI 5.0 introduces the concept of a "reduced hardware platform", meaning
148 * that the ACPI hardware is no longer required. A flag in the FADT indicates
149 * a reduced HW machine, and that flag is duplicated here for convenience.
150 */
151BOOLEAN                     AcpiGbl_ReducedHardware;
152
153
154#endif
155
156/* Do not disassemble buffers to resource descriptors */
157
158ACPI_EXTERN UINT8       ACPI_INIT_GLOBAL (AcpiGbl_NoResourceDisassembly, FALSE);
159
160/*****************************************************************************
161 *
162 * ACPI Table globals
163 *
164 ****************************************************************************/
165
166/*
167 * AcpiGbl_RootTableList is the master list of ACPI tables that were
168 * found in the RSDT/XSDT.
169 */
170ACPI_EXTERN ACPI_TABLE_LIST             AcpiGbl_RootTableList;
171ACPI_EXTERN ACPI_TABLE_FACS            *AcpiGbl_FACS;
172
173/* These addresses are calculated from the FADT Event Block addresses */
174
175ACPI_EXTERN ACPI_GENERIC_ADDRESS        AcpiGbl_XPm1aStatus;
176ACPI_EXTERN ACPI_GENERIC_ADDRESS        AcpiGbl_XPm1aEnable;
177
178ACPI_EXTERN ACPI_GENERIC_ADDRESS        AcpiGbl_XPm1bStatus;
179ACPI_EXTERN ACPI_GENERIC_ADDRESS        AcpiGbl_XPm1bEnable;
180
181/* DSDT information. Used to check for DSDT corruption */
182
183ACPI_EXTERN ACPI_TABLE_HEADER          *AcpiGbl_DSDT;
184ACPI_EXTERN ACPI_TABLE_HEADER           AcpiGbl_OriginalDsdtHeader;
185
186/*
187 * Handle both ACPI 1.0 and ACPI 2.0 Integer widths. The integer width is
188 * determined by the revision of the DSDT: If the DSDT revision is less than
189 * 2, use only the lower 32 bits of the internal 64-bit Integer.
190 */
191ACPI_EXTERN UINT8                       AcpiGbl_IntegerBitWidth;
192ACPI_EXTERN UINT8                       AcpiGbl_IntegerByteWidth;
193ACPI_EXTERN UINT8                       AcpiGbl_IntegerNybbleWidth;
194
195
196/*****************************************************************************
197 *
198 * Mutual exclusion within ACPICA subsystem
199 *
200 ****************************************************************************/
201
202/*
203 * Predefined mutex objects. This array contains the
204 * actual OS mutex handles, indexed by the local ACPI_MUTEX_HANDLEs.
205 * (The table maps local handles to the real OS handles)
206 */
207ACPI_EXTERN ACPI_MUTEX_INFO             AcpiGbl_MutexInfo[ACPI_NUM_MUTEX];
208
209/*
210 * Global lock mutex is an actual AML mutex object
211 * Global lock semaphore works in conjunction with the actual global lock
212 * Global lock spinlock is used for "pending" handshake
213 */
214ACPI_EXTERN ACPI_OPERAND_OBJECT        *AcpiGbl_GlobalLockMutex;
215ACPI_EXTERN ACPI_SEMAPHORE              AcpiGbl_GlobalLockSemaphore;
216ACPI_EXTERN ACPI_SPINLOCK               AcpiGbl_GlobalLockPendingLock;
217ACPI_EXTERN UINT16                      AcpiGbl_GlobalLockHandle;
218ACPI_EXTERN BOOLEAN                     AcpiGbl_GlobalLockAcquired;
219ACPI_EXTERN BOOLEAN                     AcpiGbl_GlobalLockPresent;
220ACPI_EXTERN BOOLEAN                     AcpiGbl_GlobalLockPending;
221
222/*
223 * Spinlocks are used for interfaces that can be possibly called at
224 * interrupt level
225 */
226ACPI_EXTERN ACPI_SPINLOCK               AcpiGbl_GpeLock;      /* For GPE data structs and registers */
227ACPI_EXTERN ACPI_SPINLOCK               AcpiGbl_HardwareLock; /* For ACPI H/W except GPE registers */
228
229/* Mutex for _OSI support */
230
231ACPI_EXTERN ACPI_MUTEX                  AcpiGbl_OsiMutex;
232
233/* Reader/Writer lock is used for namespace walk and dynamic table unload */
234
235ACPI_EXTERN ACPI_RW_LOCK                AcpiGbl_NamespaceRwLock;
236
237
238/*****************************************************************************
239 *
240 * Miscellaneous globals
241 *
242 ****************************************************************************/
243
244/* Object caches */
245
246ACPI_EXTERN ACPI_CACHE_T               *AcpiGbl_NamespaceCache;
247ACPI_EXTERN ACPI_CACHE_T               *AcpiGbl_StateCache;
248ACPI_EXTERN ACPI_CACHE_T               *AcpiGbl_PsNodeCache;
249ACPI_EXTERN ACPI_CACHE_T               *AcpiGbl_PsNodeExtCache;
250ACPI_EXTERN ACPI_CACHE_T               *AcpiGbl_OperandCache;
251
252/* Global handlers */
253
254ACPI_EXTERN ACPI_OBJECT_NOTIFY_HANDLER  AcpiGbl_DeviceNotify;
255ACPI_EXTERN ACPI_OBJECT_NOTIFY_HANDLER  AcpiGbl_SystemNotify;
256ACPI_EXTERN ACPI_EXCEPTION_HANDLER      AcpiGbl_ExceptionHandler;
257ACPI_EXTERN ACPI_INIT_HANDLER           AcpiGbl_InitHandler;
258ACPI_EXTERN ACPI_TABLE_HANDLER          AcpiGbl_TableHandler;
259ACPI_EXTERN void                       *AcpiGbl_TableHandlerContext;
260ACPI_EXTERN ACPI_WALK_STATE            *AcpiGbl_BreakpointWalk;
261ACPI_EXTERN ACPI_INTERFACE_HANDLER      AcpiGbl_InterfaceHandler;
262
263/* Owner ID support */
264
265ACPI_EXTERN UINT32                      AcpiGbl_OwnerIdMask[ACPI_NUM_OWNERID_MASKS];
266ACPI_EXTERN UINT8                       AcpiGbl_LastOwnerIdIndex;
267ACPI_EXTERN UINT8                       AcpiGbl_NextOwnerIdOffset;
268
269/* Initialization sequencing */
270
271ACPI_EXTERN BOOLEAN                     AcpiGbl_RegMethodsExecuted;
272
273/* Misc */
274
275ACPI_EXTERN UINT32                      AcpiGbl_OriginalMode;
276ACPI_EXTERN UINT32                      AcpiGbl_RsdpOriginalLocation;
277ACPI_EXTERN UINT32                      AcpiGbl_NsLookupCount;
278ACPI_EXTERN UINT32                      AcpiGbl_PsFindCount;
279ACPI_EXTERN UINT16                      AcpiGbl_Pm1EnableRegisterSave;
280ACPI_EXTERN UINT8                       AcpiGbl_DebuggerConfiguration;
281ACPI_EXTERN BOOLEAN                     AcpiGbl_StepToNextCall;
282ACPI_EXTERN BOOLEAN                     AcpiGbl_AcpiHardwarePresent;
283ACPI_EXTERN BOOLEAN                     AcpiGbl_EventsInitialized;
284ACPI_EXTERN UINT8                       AcpiGbl_OsiData;
285ACPI_EXTERN ACPI_INTERFACE_INFO        *AcpiGbl_SupportedInterfaces;
286ACPI_EXTERN ACPI_ADDRESS_RANGE         *AcpiGbl_AddressRangeList[ACPI_ADDRESS_RANGE_MAX];
287
288
289#ifndef DEFINE_ACPI_GLOBALS
290
291/* Exception codes */
292
293extern char const                       *AcpiGbl_ExceptionNames_Env[];
294extern char const                       *AcpiGbl_ExceptionNames_Pgm[];
295extern char const                       *AcpiGbl_ExceptionNames_Tbl[];
296extern char const                       *AcpiGbl_ExceptionNames_Aml[];
297extern char const                       *AcpiGbl_ExceptionNames_Ctrl[];
298
299/* Other miscellaneous */
300
301extern BOOLEAN                          AcpiGbl_Shutdown;
302extern UINT32                           AcpiGbl_StartupFlags;
303extern const char                      *AcpiGbl_SleepStateNames[ACPI_S_STATE_COUNT];
304extern const char                      *AcpiGbl_LowestDstateNames[ACPI_NUM_SxW_METHODS];
305extern const char                      *AcpiGbl_HighestDstateNames[ACPI_NUM_SxD_METHODS];
306extern const ACPI_OPCODE_INFO           AcpiGbl_AmlOpInfo[AML_NUM_OPCODES];
307extern const char                      *AcpiGbl_RegionTypes[ACPI_NUM_PREDEFINED_REGIONS];
308#endif
309
310
311#ifdef ACPI_DBG_TRACK_ALLOCATIONS
312
313/* Lists for tracking memory allocations */
314
315ACPI_EXTERN ACPI_MEMORY_LIST           *AcpiGbl_GlobalList;
316ACPI_EXTERN ACPI_MEMORY_LIST           *AcpiGbl_NsNodeList;
317ACPI_EXTERN BOOLEAN                     AcpiGbl_DisplayFinalMemStats;
318ACPI_EXTERN BOOLEAN                     AcpiGbl_DisableMemTracking;
319#endif
320
321
322/*****************************************************************************
323 *
324 * Namespace globals
325 *
326 ****************************************************************************/
327
328#if !defined (ACPI_NO_METHOD_EXECUTION) || defined (ACPI_CONSTANT_EVAL_ONLY)
329#define NUM_PREDEFINED_NAMES            10
330#else
331#define NUM_PREDEFINED_NAMES            9
332#endif
333
334ACPI_EXTERN ACPI_NAMESPACE_NODE         AcpiGbl_RootNodeStruct;
335ACPI_EXTERN ACPI_NAMESPACE_NODE        *AcpiGbl_RootNode;
336ACPI_EXTERN ACPI_NAMESPACE_NODE        *AcpiGbl_FadtGpeDevice;
337ACPI_EXTERN ACPI_OPERAND_OBJECT        *AcpiGbl_ModuleCodeList;
338
339
340extern const UINT8                      AcpiGbl_NsProperties [ACPI_NUM_NS_TYPES];
341extern const ACPI_PREDEFINED_NAMES      AcpiGbl_PreDefinedNames [NUM_PREDEFINED_NAMES];
342
343#ifdef ACPI_DEBUG_OUTPUT
344ACPI_EXTERN UINT32                      AcpiGbl_CurrentNodeCount;
345ACPI_EXTERN UINT32                      AcpiGbl_CurrentNodeSize;
346ACPI_EXTERN UINT32                      AcpiGbl_MaxConcurrentNodeCount;
347ACPI_EXTERN ACPI_SIZE                  *AcpiGbl_EntryStackPointer;
348ACPI_EXTERN ACPI_SIZE                  *AcpiGbl_LowestStackPointer;
349ACPI_EXTERN UINT32                      AcpiGbl_DeepestNesting;
350#endif
351
352
353/*****************************************************************************
354 *
355 * Interpreter globals
356 *
357 ****************************************************************************/
358
359
360ACPI_EXTERN ACPI_THREAD_STATE          *AcpiGbl_CurrentWalkList;
361
362/* Control method single step flag */
363
364ACPI_EXTERN UINT8                       AcpiGbl_CmSingleStep;
365
366
367/*****************************************************************************
368 *
369 * Hardware globals
370 *
371 ****************************************************************************/
372
373extern      ACPI_BIT_REGISTER_INFO      AcpiGbl_BitRegisterInfo[ACPI_NUM_BITREG];
374ACPI_EXTERN UINT8                       AcpiGbl_SleepTypeA;
375ACPI_EXTERN UINT8                       AcpiGbl_SleepTypeB;
376
377
378/*****************************************************************************
379 *
380 * Event and GPE globals
381 *
382 ****************************************************************************/
383
384ACPI_EXTERN UINT8                       AcpiGbl_AllGpesInitialized;
385ACPI_EXTERN ACPI_GPE_XRUPT_INFO        *AcpiGbl_GpeXruptListHead;
386ACPI_EXTERN ACPI_GPE_BLOCK_INFO        *AcpiGbl_GpeFadtBlocks[ACPI_MAX_GPE_BLOCKS];
387ACPI_EXTERN ACPI_GBL_EVENT_HANDLER      AcpiGbl_GlobalEventHandler;
388ACPI_EXTERN void                       *AcpiGbl_GlobalEventHandlerContext;
389ACPI_EXTERN ACPI_FIXED_EVENT_HANDLER    AcpiGbl_FixedEventHandlers[ACPI_NUM_FIXED_EVENTS];
390extern      ACPI_FIXED_EVENT_INFO       AcpiGbl_FixedEventInfo[ACPI_NUM_FIXED_EVENTS];
391
392
393/*****************************************************************************
394 *
395 * Debug support
396 *
397 ****************************************************************************/
398
399/* Procedure nesting level for debug output */
400
401extern      UINT32                      AcpiGbl_NestingLevel;
402
403/* Event counters */
404
405ACPI_EXTERN UINT32                      AcpiMethodCount;
406ACPI_EXTERN UINT32                      AcpiGpeCount;
407ACPI_EXTERN UINT32                      AcpiSciCount;
408ACPI_EXTERN UINT32                      AcpiFixedEventCount[ACPI_NUM_FIXED_EVENTS];
409
410/* Support for dynamic control method tracing mechanism */
411
412ACPI_EXTERN UINT32                      AcpiGbl_OriginalDbgLevel;
413ACPI_EXTERN UINT32                      AcpiGbl_OriginalDbgLayer;
414ACPI_EXTERN UINT32                      AcpiGbl_TraceDbgLevel;
415ACPI_EXTERN UINT32                      AcpiGbl_TraceDbgLayer;
416
417
418/*****************************************************************************
419 *
420 * Debugger globals
421 *
422 ****************************************************************************/
423
424ACPI_EXTERN UINT8                       AcpiGbl_DbOutputFlags;
425
426#ifdef ACPI_DISASSEMBLER
427
428ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_disasm;
429ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_verbose;
430ACPI_EXTERN ACPI_EXTERNAL_LIST         *AcpiGbl_ExternalList;
431ACPI_EXTERN ACPI_EXTERNAL_FILE         *AcpiGbl_ExternalFileList;
432#endif
433
434
435#ifdef ACPI_DEBUGGER
436
437extern      BOOLEAN                     AcpiGbl_MethodExecuting;
438extern      BOOLEAN                     AcpiGbl_AbortMethod;
439extern      BOOLEAN                     AcpiGbl_DbTerminateThreads;
440
441ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_tables;
442ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_stats;
443ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_ini_methods;
444ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_NoRegionSupport;
445
446ACPI_EXTERN char                       *AcpiGbl_DbArgs[ACPI_DEBUGGER_MAX_ARGS];
447ACPI_EXTERN ACPI_OBJECT_TYPE            AcpiGbl_DbArgTypes[ACPI_DEBUGGER_MAX_ARGS];
448ACPI_EXTERN char                        AcpiGbl_DbLineBuf[ACPI_DB_LINE_BUFFER_SIZE];
449ACPI_EXTERN char                        AcpiGbl_DbParsedBuf[ACPI_DB_LINE_BUFFER_SIZE];
450ACPI_EXTERN char                        AcpiGbl_DbScopeBuf[80];
451ACPI_EXTERN char                        AcpiGbl_DbDebugFilename[80];
452ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOutputToFile;
453ACPI_EXTERN char                       *AcpiGbl_DbBuffer;
454ACPI_EXTERN char                       *AcpiGbl_DbFilename;
455ACPI_EXTERN UINT32                      AcpiGbl_DbDebugLevel;
456ACPI_EXTERN UINT32                      AcpiGbl_DbConsoleDebugLevel;
457ACPI_EXTERN ACPI_NAMESPACE_NODE        *AcpiGbl_DbScopeNode;
458
459/*
460 * Statistic globals
461 */
462ACPI_EXTERN UINT16                      AcpiGbl_ObjTypeCount[ACPI_TYPE_NS_NODE_MAX+1];
463ACPI_EXTERN UINT16                      AcpiGbl_NodeTypeCount[ACPI_TYPE_NS_NODE_MAX+1];
464ACPI_EXTERN UINT16                      AcpiGbl_ObjTypeCountMisc;
465ACPI_EXTERN UINT16                      AcpiGbl_NodeTypeCountMisc;
466ACPI_EXTERN UINT32                      AcpiGbl_NumNodes;
467ACPI_EXTERN UINT32                      AcpiGbl_NumObjects;
468
469
470ACPI_EXTERN UINT32                      AcpiGbl_SizeOfParseTree;
471ACPI_EXTERN UINT32                      AcpiGbl_SizeOfMethodTrees;
472ACPI_EXTERN UINT32                      AcpiGbl_SizeOfNodeEntries;
473ACPI_EXTERN UINT32                      AcpiGbl_SizeOfAcpiObjects;
474
475#endif /* ACPI_DEBUGGER */
476
477#endif /* __ACGLOBAL_H__ */
478