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