acglobal.h revision 128212 
1/******************************************************************************
2 *
3 * Name: acglobal.h - Declarations for global variables
4 *       $Revision: 152 $
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999 - 2004, Intel Corp.
13 * All rights reserved.
14 *
15 * 2. License
16 *
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights.  You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
20 * property rights.
21 *
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
28 *
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code.  No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
37 *
38 * The above copyright and patent license is granted only if the following
39 * conditions are met:
40 *
41 * 3. Conditions
42 *
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision.  In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change.  Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee.  Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
54 *
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution.  In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
65 * make.
66 *
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
71 * distribution.
72 *
73 * 3.4. Intel retains all right, title, and interest in and to the Original
74 * Intel Code.
75 *
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
80 *
81 * 4. Disclaimer and Export Compliance
82 *
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
89 * PARTICULAR PURPOSE.
90 *
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
98 * LIMITED REMEDY.
99 *
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government.  In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
114 *
115 *****************************************************************************/
116
117#ifndef __ACGLOBAL_H__
118#define __ACGLOBAL_H__
119
120
121/*
122 * Ensure that the globals are actually defined and initialized only once.
123 *
124 * The use of these macros allows a single list of globals (here) in order
125 * to simplify maintenance of the code.
126 */
127#ifdef DEFINE_ACPI_GLOBALS
128#define ACPI_EXTERN
129#define ACPI_INIT_GLOBAL(a,b) a=b
130#else
131#define ACPI_EXTERN extern
132#define ACPI_INIT_GLOBAL(a,b) a
133#endif
134
135/*
136 * Keep local copies of these FADT-based registers.  NOTE: These globals
137 * are first in this file for alignment reasons on 64-bit systems.
138 */
139ACPI_EXTERN ACPI_GENERIC_ADDRESS        AcpiGbl_XPm1aEnable;
140ACPI_EXTERN ACPI_GENERIC_ADDRESS        AcpiGbl_XPm1bEnable;
141
142
143/*****************************************************************************
144 *
145 * Debug support
146 *
147 ****************************************************************************/
148
149/* Runtime configuration of debug print levels */
150
151extern      UINT32                      AcpiDbgLevel;
152extern      UINT32                      AcpiDbgLayer;
153
154/* Procedure nesting level for debug output */
155
156extern      UINT32                      AcpiGbl_NestingLevel;
157
158
159/*****************************************************************************
160 *
161 * Runtime configuration (static defaults that can be overriden at runtime)
162 *
163 ****************************************************************************/
164
165/*
166 * Create the predefined _OSI method in the namespace? Default is TRUE
167 * because ACPI CA is fully compatible with other ACPI implementations.
168 * Changing this will revert ACPI CA (and machine ASL) to pre-OSI behavior.
169 */
170ACPI_EXTERN UINT8       ACPI_INIT_GLOBAL (AcpiGbl_CreateOsiMethod, TRUE);
171
172/*
173 * Automatically serialize ALL control methods? Default is FALSE, meaning
174 * to use the Serialized/NotSerialized method flags on a per method basis.
175 * Only change this if the ASL code is poorly written and cannot handle
176 * reentrancy even though methods are marked "NotSerialized".
177 */
178ACPI_EXTERN UINT8       ACPI_INIT_GLOBAL (AcpiGbl_AllMethodsSerialized, FALSE);
179
180/*
181 * Disable wakeup GPEs during runtime? Default is TRUE because WAKE and
182 * RUNTIME GPEs should never be shared, and WAKE GPEs should typically only
183 * be enabled just before going to sleep.
184 */
185ACPI_EXTERN UINT8       ACPI_INIT_GLOBAL (AcpiGbl_LeaveWakeGpesDisabled, TRUE);
186
187
188/*****************************************************************************
189 *
190 * ACPI Table globals
191 *
192 ****************************************************************************/
193
194/*
195 * Table pointers.
196 * Although these pointers are somewhat redundant with the global AcpiTable,
197 * they are convenient because they are typed pointers.
198 *
199 * These tables are single-table only; meaning that there can be at most one
200 * of each in the system.  Each global points to the actual table.
201 */
202ACPI_EXTERN UINT32                      AcpiGbl_TableFlags;
203ACPI_EXTERN UINT32                      AcpiGbl_RsdtTableCount;
204ACPI_EXTERN RSDP_DESCRIPTOR            *AcpiGbl_RSDP;
205ACPI_EXTERN XSDT_DESCRIPTOR            *AcpiGbl_XSDT;
206ACPI_EXTERN FADT_DESCRIPTOR            *AcpiGbl_FADT;
207ACPI_EXTERN ACPI_TABLE_HEADER          *AcpiGbl_DSDT;
208ACPI_EXTERN FACS_DESCRIPTOR            *AcpiGbl_FACS;
209ACPI_EXTERN ACPI_COMMON_FACS            AcpiGbl_CommonFACS;
210/*
211 * Since there may be multiple SSDTs and PSDTS, a single pointer is not
212 * sufficient; Therefore, there isn't one!
213 */
214
215
216/*
217 * Handle both ACPI 1.0 and ACPI 2.0 Integer widths
218 * If we are running a method that exists in a 32-bit ACPI table.
219 * Use only 32 bits of the Integer for conversion.
220 */
221ACPI_EXTERN UINT8                       AcpiGbl_IntegerBitWidth;
222ACPI_EXTERN UINT8                       AcpiGbl_IntegerByteWidth;
223ACPI_EXTERN UINT8                       AcpiGbl_IntegerNybbleWidth;
224
225/*
226 * ACPI Table info arrays
227 */
228extern      ACPI_TABLE_LIST             AcpiGbl_TableLists[NUM_ACPI_TABLE_TYPES];
229extern      ACPI_TABLE_SUPPORT          AcpiGbl_TableData[NUM_ACPI_TABLE_TYPES];
230
231/*
232 * Predefined mutex objects.  This array contains the
233 * actual OS mutex handles, indexed by the local ACPI_MUTEX_HANDLEs.
234 * (The table maps local handles to the real OS handles)
235 */
236ACPI_EXTERN ACPI_MUTEX_INFO             AcpiGbl_MutexInfo[NUM_MUTEX];
237
238
239/*****************************************************************************
240 *
241 * Miscellaneous globals
242 *
243 ****************************************************************************/
244
245
246ACPI_EXTERN ACPI_MEMORY_LIST            AcpiGbl_MemoryLists[ACPI_NUM_MEM_LISTS];
247ACPI_EXTERN ACPI_OBJECT_NOTIFY_HANDLER  AcpiGbl_DeviceNotify;
248ACPI_EXTERN ACPI_OBJECT_NOTIFY_HANDLER  AcpiGbl_SystemNotify;
249ACPI_EXTERN ACPI_INIT_HANDLER           AcpiGbl_InitHandler;
250ACPI_EXTERN ACPI_WALK_STATE            *AcpiGbl_BreakpointWalk;
251ACPI_EXTERN ACPI_HANDLE                 AcpiGbl_GlobalLockSemaphore;
252
253ACPI_EXTERN UINT32                      AcpiGbl_GlobalLockThreadCount;
254ACPI_EXTERN UINT32                      AcpiGbl_OriginalMode;
255ACPI_EXTERN UINT32                      AcpiGbl_RsdpOriginalLocation;
256ACPI_EXTERN UINT32                      AcpiGbl_NsLookupCount;
257ACPI_EXTERN UINT32                      AcpiGbl_PsFindCount;
258ACPI_EXTERN UINT16                      AcpiGbl_Pm1EnableRegisterSave;
259ACPI_EXTERN UINT16                      AcpiGbl_NextTableOwnerId;
260ACPI_EXTERN UINT16                      AcpiGbl_NextMethodOwnerId;
261ACPI_EXTERN UINT16                      AcpiGbl_GlobalLockHandle;
262ACPI_EXTERN UINT8                       AcpiGbl_DebuggerConfiguration;
263ACPI_EXTERN BOOLEAN                     AcpiGbl_GlobalLockAcquired;
264ACPI_EXTERN BOOLEAN                     AcpiGbl_StepToNextCall;
265ACPI_EXTERN BOOLEAN                     AcpiGbl_AcpiHardwarePresent;
266ACPI_EXTERN BOOLEAN                     AcpiGbl_GlobalLockPresent;
267ACPI_EXTERN BOOLEAN                     AcpiGbl_EventsInitialized;
268
269extern BOOLEAN                          AcpiGbl_Shutdown;
270extern UINT32                           AcpiGbl_StartupFlags;
271extern const UINT8                      AcpiGbl_DecodeTo8bit[8];
272extern const char                      *AcpiGbl_SleepStateNames[ACPI_S_STATE_COUNT];
273extern const char                      *AcpiGbl_HighestDstateNames[4];
274extern const ACPI_OPCODE_INFO           AcpiGbl_AmlOpInfo[AML_NUM_OPCODES];
275extern const char                      *AcpiGbl_RegionTypes[ACPI_NUM_PREDEFINED_REGIONS];
276extern const char                      *AcpiGbl_ValidOsiStrings[ACPI_NUM_OSI_STRINGS];
277
278
279/*****************************************************************************
280 *
281 * Namespace globals
282 *
283 ****************************************************************************/
284
285#define NUM_NS_TYPES                    ACPI_TYPE_INVALID+1
286
287#if !defined (ACPI_NO_METHOD_EXECUTION) || defined (ACPI_CONSTANT_EVAL_ONLY)
288#define NUM_PREDEFINED_NAMES            10
289#else
290#define NUM_PREDEFINED_NAMES            9
291#endif
292
293ACPI_EXTERN ACPI_NAMESPACE_NODE         AcpiGbl_RootNodeStruct;
294ACPI_EXTERN ACPI_NAMESPACE_NODE        *AcpiGbl_RootNode;
295ACPI_EXTERN ACPI_NAMESPACE_NODE        *AcpiGbl_FadtGpeDevice;
296
297extern const UINT8                      AcpiGbl_NsProperties[NUM_NS_TYPES];
298extern const ACPI_PREDEFINED_NAMES      AcpiGbl_PreDefinedNames [NUM_PREDEFINED_NAMES];
299
300#ifdef ACPI_DEBUG_OUTPUT
301ACPI_EXTERN UINT32                      AcpiGbl_CurrentNodeCount;
302ACPI_EXTERN UINT32                      AcpiGbl_CurrentNodeSize;
303ACPI_EXTERN UINT32                      AcpiGbl_MaxConcurrentNodeCount;
304ACPI_EXTERN ACPI_SIZE                   AcpiGbl_EntryStackPointer;
305ACPI_EXTERN ACPI_SIZE                   AcpiGbl_LowestStackPointer;
306ACPI_EXTERN UINT32                      AcpiGbl_DeepestNesting;
307#endif
308
309/*****************************************************************************
310 *
311 * Interpreter globals
312 *
313 ****************************************************************************/
314
315
316ACPI_EXTERN ACPI_THREAD_STATE          *AcpiGbl_CurrentWalkList;
317
318/* Control method single step flag */
319
320ACPI_EXTERN UINT8                       AcpiGbl_CmSingleStep;
321
322
323/*****************************************************************************
324 *
325 * Parser globals
326 *
327 ****************************************************************************/
328
329ACPI_EXTERN ACPI_PARSE_OBJECT          *AcpiGbl_ParsedNamespaceRoot;
330
331/*****************************************************************************
332 *
333 * Hardware globals
334 *
335 ****************************************************************************/
336
337extern      ACPI_BIT_REGISTER_INFO      AcpiGbl_BitRegisterInfo[ACPI_NUM_BITREG];
338ACPI_EXTERN UINT8                       AcpiGbl_SleepTypeA;
339ACPI_EXTERN UINT8                       AcpiGbl_SleepTypeB;
340
341
342/*****************************************************************************
343 *
344 * Event and GPE globals
345 *
346 ****************************************************************************/
347
348extern      ACPI_FIXED_EVENT_INFO       AcpiGbl_FixedEventInfo[ACPI_NUM_FIXED_EVENTS];
349ACPI_EXTERN ACPI_FIXED_EVENT_HANDLER    AcpiGbl_FixedEventHandlers[ACPI_NUM_FIXED_EVENTS];
350ACPI_EXTERN ACPI_GPE_XRUPT_INFO        *AcpiGbl_GpeXruptListHead;
351ACPI_EXTERN ACPI_GPE_BLOCK_INFO        *AcpiGbl_GpeFadtBlocks[ACPI_MAX_GPE_BLOCKS];
352ACPI_EXTERN ACPI_HANDLE                 AcpiGbl_GpeLock;
353
354
355/*****************************************************************************
356 *
357 * Debugger globals
358 *
359 ****************************************************************************/
360
361
362ACPI_EXTERN UINT8                       AcpiGbl_DbOutputFlags;
363
364#ifdef ACPI_DISASSEMBLER
365
366ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_disasm;
367ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_verbose;
368#endif
369
370
371#ifdef ACPI_DEBUGGER
372
373extern      BOOLEAN                     AcpiGbl_MethodExecuting;
374extern      BOOLEAN                     AcpiGbl_AbortMethod;
375extern      BOOLEAN                     AcpiGbl_DbTerminateThreads;
376
377ACPI_EXTERN int                         optind;
378ACPI_EXTERN char                       *optarg;
379
380ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_tables;
381ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_stats;
382ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_ini_methods;
383
384
385ACPI_EXTERN char                       *AcpiGbl_DbArgs[ACPI_DEBUGGER_MAX_ARGS];
386ACPI_EXTERN char                        AcpiGbl_DbLineBuf[80];
387ACPI_EXTERN char                        AcpiGbl_DbParsedBuf[80];
388ACPI_EXTERN char                        AcpiGbl_DbScopeBuf[40];
389ACPI_EXTERN char                        AcpiGbl_DbDebugFilename[40];
390ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOutputToFile;
391ACPI_EXTERN char                       *AcpiGbl_DbBuffer;
392ACPI_EXTERN char                       *AcpiGbl_DbFilename;
393ACPI_EXTERN UINT32                      AcpiGbl_DbDebugLevel;
394ACPI_EXTERN UINT32                      AcpiGbl_DbConsoleDebugLevel;
395ACPI_EXTERN ACPI_TABLE_HEADER          *AcpiGbl_DbTablePtr;
396ACPI_EXTERN ACPI_NAMESPACE_NODE        *AcpiGbl_DbScopeNode;
397
398/*
399 * Statistic globals
400 */
401ACPI_EXTERN UINT16                      AcpiGbl_ObjTypeCount[ACPI_TYPE_NS_NODE_MAX+1];
402ACPI_EXTERN UINT16                      AcpiGbl_NodeTypeCount[ACPI_TYPE_NS_NODE_MAX+1];
403ACPI_EXTERN UINT16                      AcpiGbl_ObjTypeCountMisc;
404ACPI_EXTERN UINT16                      AcpiGbl_NodeTypeCountMisc;
405ACPI_EXTERN UINT32                      AcpiGbl_NumNodes;
406ACPI_EXTERN UINT32                      AcpiGbl_NumObjects;
407
408
409ACPI_EXTERN UINT32                      AcpiGbl_SizeOfParseTree;
410ACPI_EXTERN UINT32                      AcpiGbl_SizeOfMethodTrees;
411ACPI_EXTERN UINT32                      AcpiGbl_SizeOfNodeEntries;
412ACPI_EXTERN UINT32                      AcpiGbl_SizeOfAcpiObjects;
413
414#endif /* ACPI_DEBUGGER */
415
416
417#endif /* __ACGLOBAL_H__ */
418