acglobal.h revision 245748 
1/******************************************************************************
2 *
3 * Name: acglobal.h - Declarations for global variables
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2013, 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#endif /* DEFINE_ACPI_GLOBALS */
154
155/* Do not disassemble buffers to resource descriptors */
156
157ACPI_EXTERN UINT8       ACPI_INIT_GLOBAL (AcpiGbl_NoResourceDisassembly, FALSE);
158
159/*****************************************************************************
160 *
161 * ACPI Table globals
162 *
163 ****************************************************************************/
164
165/*
166 * AcpiGbl_RootTableList is the master list of ACPI tables that were
167 * found in the RSDT/XSDT.
168 */
169ACPI_EXTERN ACPI_TABLE_LIST             AcpiGbl_RootTableList;
170
171#if (!ACPI_REDUCED_HARDWARE)
172ACPI_EXTERN ACPI_TABLE_FACS            *AcpiGbl_FACS;
173
174#endif /* !ACPI_REDUCED_HARDWARE */
175
176/* These addresses are calculated from the FADT Event Block addresses */
177
178ACPI_EXTERN ACPI_GENERIC_ADDRESS        AcpiGbl_XPm1aStatus;
179ACPI_EXTERN ACPI_GENERIC_ADDRESS        AcpiGbl_XPm1aEnable;
180
181ACPI_EXTERN ACPI_GENERIC_ADDRESS        AcpiGbl_XPm1bStatus;
182ACPI_EXTERN ACPI_GENERIC_ADDRESS        AcpiGbl_XPm1bEnable;
183
184/* DSDT information. Used to check for DSDT corruption */
185
186ACPI_EXTERN ACPI_TABLE_HEADER          *AcpiGbl_DSDT;
187ACPI_EXTERN ACPI_TABLE_HEADER           AcpiGbl_OriginalDsdtHeader;
188
189/*
190 * Handle both ACPI 1.0 and ACPI 2.0 Integer widths. The integer width is
191 * determined by the revision of the DSDT: If the DSDT revision is less than
192 * 2, use only the lower 32 bits of the internal 64-bit Integer.
193 */
194ACPI_EXTERN UINT8                       AcpiGbl_IntegerBitWidth;
195ACPI_EXTERN UINT8                       AcpiGbl_IntegerByteWidth;
196ACPI_EXTERN UINT8                       AcpiGbl_IntegerNybbleWidth;
197
198
199/*****************************************************************************
200 *
201 * Mutual exclusion within ACPICA subsystem
202 *
203 ****************************************************************************/
204
205/*
206 * Predefined mutex objects. This array contains the
207 * actual OS mutex handles, indexed by the local ACPI_MUTEX_HANDLEs.
208 * (The table maps local handles to the real OS handles)
209 */
210ACPI_EXTERN ACPI_MUTEX_INFO             AcpiGbl_MutexInfo[ACPI_NUM_MUTEX];
211
212/*
213 * Global lock mutex is an actual AML mutex object
214 * Global lock semaphore works in conjunction with the actual global lock
215 * Global lock spinlock is used for "pending" handshake
216 */
217ACPI_EXTERN ACPI_OPERAND_OBJECT        *AcpiGbl_GlobalLockMutex;
218ACPI_EXTERN ACPI_SEMAPHORE              AcpiGbl_GlobalLockSemaphore;
219ACPI_EXTERN ACPI_SPINLOCK               AcpiGbl_GlobalLockPendingLock;
220ACPI_EXTERN UINT16                      AcpiGbl_GlobalLockHandle;
221ACPI_EXTERN BOOLEAN                     AcpiGbl_GlobalLockAcquired;
222ACPI_EXTERN BOOLEAN                     AcpiGbl_GlobalLockPresent;
223ACPI_EXTERN BOOLEAN                     AcpiGbl_GlobalLockPending;
224
225/*
226 * Spinlocks are used for interfaces that can be possibly called at
227 * interrupt level
228 */
229ACPI_EXTERN ACPI_SPINLOCK               AcpiGbl_GpeLock;      /* For GPE data structs and registers */
230ACPI_EXTERN ACPI_SPINLOCK               AcpiGbl_HardwareLock; /* For ACPI H/W except GPE registers */
231
232/* Mutex for _OSI support */
233
234ACPI_EXTERN ACPI_MUTEX                  AcpiGbl_OsiMutex;
235
236/* Reader/Writer lock is used for namespace walk and dynamic table unload */
237
238ACPI_EXTERN ACPI_RW_LOCK                AcpiGbl_NamespaceRwLock;
239
240
241/*****************************************************************************
242 *
243 * Miscellaneous globals
244 *
245 ****************************************************************************/
246
247/* Object caches */
248
249ACPI_EXTERN ACPI_CACHE_T               *AcpiGbl_NamespaceCache;
250ACPI_EXTERN ACPI_CACHE_T               *AcpiGbl_StateCache;
251ACPI_EXTERN ACPI_CACHE_T               *AcpiGbl_PsNodeCache;
252ACPI_EXTERN ACPI_CACHE_T               *AcpiGbl_PsNodeExtCache;
253ACPI_EXTERN ACPI_CACHE_T               *AcpiGbl_OperandCache;
254
255/* Global handlers */
256
257ACPI_EXTERN ACPI_GLOBAL_NOTIFY_HANDLER  AcpiGbl_GlobalNotify[2];
258ACPI_EXTERN ACPI_EXCEPTION_HANDLER      AcpiGbl_ExceptionHandler;
259ACPI_EXTERN ACPI_INIT_HANDLER           AcpiGbl_InitHandler;
260ACPI_EXTERN ACPI_TABLE_HANDLER          AcpiGbl_TableHandler;
261ACPI_EXTERN void                       *AcpiGbl_TableHandlerContext;
262ACPI_EXTERN ACPI_WALK_STATE            *AcpiGbl_BreakpointWalk;
263ACPI_EXTERN ACPI_INTERFACE_HANDLER      AcpiGbl_InterfaceHandler;
264
265/* Owner ID support */
266
267ACPI_EXTERN UINT32                      AcpiGbl_OwnerIdMask[ACPI_NUM_OWNERID_MASKS];
268ACPI_EXTERN UINT8                       AcpiGbl_LastOwnerIdIndex;
269ACPI_EXTERN UINT8                       AcpiGbl_NextOwnerIdOffset;
270
271/* Initialization sequencing */
272
273ACPI_EXTERN BOOLEAN                     AcpiGbl_RegMethodsExecuted;
274
275/* Misc */
276
277ACPI_EXTERN UINT32                      AcpiGbl_OriginalMode;
278ACPI_EXTERN UINT32                      AcpiGbl_RsdpOriginalLocation;
279ACPI_EXTERN UINT32                      AcpiGbl_NsLookupCount;
280ACPI_EXTERN UINT32                      AcpiGbl_PsFindCount;
281ACPI_EXTERN UINT16                      AcpiGbl_Pm1EnableRegisterSave;
282ACPI_EXTERN UINT8                       AcpiGbl_DebuggerConfiguration;
283ACPI_EXTERN BOOLEAN                     AcpiGbl_StepToNextCall;
284ACPI_EXTERN BOOLEAN                     AcpiGbl_AcpiHardwarePresent;
285ACPI_EXTERN BOOLEAN                     AcpiGbl_EventsInitialized;
286ACPI_EXTERN UINT8                       AcpiGbl_OsiData;
287ACPI_EXTERN ACPI_INTERFACE_INFO        *AcpiGbl_SupportedInterfaces;
288ACPI_EXTERN ACPI_ADDRESS_RANGE         *AcpiGbl_AddressRangeList[ACPI_ADDRESS_RANGE_MAX];
289
290#ifndef DEFINE_ACPI_GLOBALS
291
292/* Other miscellaneous */
293
294extern BOOLEAN                          AcpiGbl_Shutdown;
295extern UINT32                           AcpiGbl_StartupFlags;
296extern const char                      *AcpiGbl_SleepStateNames[ACPI_S_STATE_COUNT];
297extern const char                      *AcpiGbl_LowestDstateNames[ACPI_NUM_SxW_METHODS];
298extern const char                      *AcpiGbl_HighestDstateNames[ACPI_NUM_SxD_METHODS];
299extern const ACPI_OPCODE_INFO           AcpiGbl_AmlOpInfo[AML_NUM_OPCODES];
300extern const char                      *AcpiGbl_RegionTypes[ACPI_NUM_PREDEFINED_REGIONS];
301#endif
302
303
304#ifdef ACPI_DBG_TRACK_ALLOCATIONS
305
306/* Lists for tracking memory allocations */
307
308ACPI_EXTERN ACPI_MEMORY_LIST           *AcpiGbl_GlobalList;
309ACPI_EXTERN ACPI_MEMORY_LIST           *AcpiGbl_NsNodeList;
310ACPI_EXTERN BOOLEAN                     AcpiGbl_DisplayFinalMemStats;
311ACPI_EXTERN BOOLEAN                     AcpiGbl_DisableMemTracking;
312#endif
313
314
315/*****************************************************************************
316 *
317 * Namespace globals
318 *
319 ****************************************************************************/
320
321#if !defined (ACPI_NO_METHOD_EXECUTION) || defined (ACPI_CONSTANT_EVAL_ONLY)
322#define NUM_PREDEFINED_NAMES            10
323#else
324#define NUM_PREDEFINED_NAMES            9
325#endif
326
327ACPI_EXTERN ACPI_NAMESPACE_NODE         AcpiGbl_RootNodeStruct;
328ACPI_EXTERN ACPI_NAMESPACE_NODE        *AcpiGbl_RootNode;
329ACPI_EXTERN ACPI_NAMESPACE_NODE        *AcpiGbl_FadtGpeDevice;
330ACPI_EXTERN ACPI_OPERAND_OBJECT        *AcpiGbl_ModuleCodeList;
331
332
333extern const UINT8                      AcpiGbl_NsProperties [ACPI_NUM_NS_TYPES];
334extern const ACPI_PREDEFINED_NAMES      AcpiGbl_PreDefinedNames [NUM_PREDEFINED_NAMES];
335
336#ifdef ACPI_DEBUG_OUTPUT
337ACPI_EXTERN UINT32                      AcpiGbl_CurrentNodeCount;
338ACPI_EXTERN UINT32                      AcpiGbl_CurrentNodeSize;
339ACPI_EXTERN UINT32                      AcpiGbl_MaxConcurrentNodeCount;
340ACPI_EXTERN ACPI_SIZE                  *AcpiGbl_EntryStackPointer;
341ACPI_EXTERN ACPI_SIZE                  *AcpiGbl_LowestStackPointer;
342ACPI_EXTERN UINT32                      AcpiGbl_DeepestNesting;
343#endif
344
345
346/*****************************************************************************
347 *
348 * Interpreter globals
349 *
350 ****************************************************************************/
351
352ACPI_EXTERN ACPI_THREAD_STATE          *AcpiGbl_CurrentWalkList;
353
354/* Control method single step flag */
355
356ACPI_EXTERN UINT8                       AcpiGbl_CmSingleStep;
357
358
359/*****************************************************************************
360 *
361 * Hardware globals
362 *
363 ****************************************************************************/
364
365extern      ACPI_BIT_REGISTER_INFO      AcpiGbl_BitRegisterInfo[ACPI_NUM_BITREG];
366ACPI_EXTERN UINT8                       AcpiGbl_SleepTypeA;
367ACPI_EXTERN UINT8                       AcpiGbl_SleepTypeB;
368
369
370/*****************************************************************************
371 *
372 * Event and GPE globals
373 *
374 ****************************************************************************/
375
376#if (!ACPI_REDUCED_HARDWARE)
377
378ACPI_EXTERN UINT8                       AcpiGbl_AllGpesInitialized;
379ACPI_EXTERN ACPI_GPE_XRUPT_INFO        *AcpiGbl_GpeXruptListHead;
380ACPI_EXTERN ACPI_GPE_BLOCK_INFO        *AcpiGbl_GpeFadtBlocks[ACPI_MAX_GPE_BLOCKS];
381ACPI_EXTERN ACPI_GBL_EVENT_HANDLER      AcpiGbl_GlobalEventHandler;
382ACPI_EXTERN void                       *AcpiGbl_GlobalEventHandlerContext;
383ACPI_EXTERN ACPI_FIXED_EVENT_HANDLER    AcpiGbl_FixedEventHandlers[ACPI_NUM_FIXED_EVENTS];
384extern      ACPI_FIXED_EVENT_INFO       AcpiGbl_FixedEventInfo[ACPI_NUM_FIXED_EVENTS];
385
386#endif /* !ACPI_REDUCED_HARDWARE */
387
388/*****************************************************************************
389 *
390 * Debug support
391 *
392 ****************************************************************************/
393
394/* Procedure nesting level for debug output */
395
396extern      UINT32                      AcpiGbl_NestingLevel;
397
398/* Event counters */
399
400ACPI_EXTERN UINT32                      AcpiMethodCount;
401ACPI_EXTERN UINT32                      AcpiGpeCount;
402ACPI_EXTERN UINT32                      AcpiSciCount;
403ACPI_EXTERN UINT32                      AcpiFixedEventCount[ACPI_NUM_FIXED_EVENTS];
404
405/* Support for dynamic control method tracing mechanism */
406
407ACPI_EXTERN UINT32                      AcpiGbl_OriginalDbgLevel;
408ACPI_EXTERN UINT32                      AcpiGbl_OriginalDbgLayer;
409ACPI_EXTERN UINT32                      AcpiGbl_TraceDbgLevel;
410ACPI_EXTERN UINT32                      AcpiGbl_TraceDbgLayer;
411
412
413/*****************************************************************************
414 *
415 * Debugger and Disassembler globals
416 *
417 ****************************************************************************/
418
419ACPI_EXTERN UINT8                       AcpiGbl_DbOutputFlags;
420
421#ifdef ACPI_DISASSEMBLER
422
423ACPI_EXTERN BOOLEAN     ACPI_INIT_GLOBAL (AcpiGbl_IgnoreNoopOperator, FALSE);
424
425ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_disasm;
426ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_verbose;
427ACPI_EXTERN ACPI_EXTERNAL_LIST         *AcpiGbl_ExternalList;
428ACPI_EXTERN ACPI_EXTERNAL_FILE         *AcpiGbl_ExternalFileList;
429#endif
430
431
432#ifdef ACPI_DEBUGGER
433
434extern      BOOLEAN                     AcpiGbl_MethodExecuting;
435extern      BOOLEAN                     AcpiGbl_AbortMethod;
436extern      BOOLEAN                     AcpiGbl_DbTerminateThreads;
437
438ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_tables;
439ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_stats;
440ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_ini_methods;
441ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_NoRegionSupport;
442
443ACPI_EXTERN char                       *AcpiGbl_DbArgs[ACPI_DEBUGGER_MAX_ARGS];
444ACPI_EXTERN ACPI_OBJECT_TYPE            AcpiGbl_DbArgTypes[ACPI_DEBUGGER_MAX_ARGS];
445ACPI_EXTERN char                        AcpiGbl_DbLineBuf[ACPI_DB_LINE_BUFFER_SIZE];
446ACPI_EXTERN char                        AcpiGbl_DbParsedBuf[ACPI_DB_LINE_BUFFER_SIZE];
447ACPI_EXTERN char                        AcpiGbl_DbScopeBuf[80];
448ACPI_EXTERN char                        AcpiGbl_DbDebugFilename[80];
449ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOutputToFile;
450ACPI_EXTERN char                       *AcpiGbl_DbBuffer;
451ACPI_EXTERN char                       *AcpiGbl_DbFilename;
452ACPI_EXTERN UINT32                      AcpiGbl_DbDebugLevel;
453ACPI_EXTERN UINT32                      AcpiGbl_DbConsoleDebugLevel;
454ACPI_EXTERN ACPI_NAMESPACE_NODE        *AcpiGbl_DbScopeNode;
455
456/*
457 * Statistic globals
458 */
459ACPI_EXTERN UINT16                      AcpiGbl_ObjTypeCount[ACPI_TYPE_NS_NODE_MAX+1];
460ACPI_EXTERN UINT16                      AcpiGbl_NodeTypeCount[ACPI_TYPE_NS_NODE_MAX+1];
461ACPI_EXTERN UINT16                      AcpiGbl_ObjTypeCountMisc;
462ACPI_EXTERN UINT16                      AcpiGbl_NodeTypeCountMisc;
463ACPI_EXTERN UINT32                      AcpiGbl_NumNodes;
464ACPI_EXTERN UINT32                      AcpiGbl_NumObjects;
465
466
467ACPI_EXTERN UINT32                      AcpiGbl_SizeOfParseTree;
468ACPI_EXTERN UINT32                      AcpiGbl_SizeOfMethodTrees;
469ACPI_EXTERN UINT32                      AcpiGbl_SizeOfNodeEntries;
470ACPI_EXTERN UINT32                      AcpiGbl_SizeOfAcpiObjects;
471
472#endif /* ACPI_DEBUGGER */
473
474
475/*****************************************************************************
476 *
477 * Info/help support
478 *
479 ****************************************************************************/
480
481extern const AH_PREDEFINED_NAME     AslPredefinedInfo[];
482
483
484#endif /* __ACGLOBAL_H__ */
485