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