acglobal.h revision 91116
1/******************************************************************************
2 *
3 * Name: acglobal.h - Declarations for global variables
4 *       $Revision: 120 $
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999 - 2002, 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 only once.
123 *
124 * The use of these defines 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#else
130#define ACPI_EXTERN extern
131#endif
132
133
134/*****************************************************************************
135 *
136 * Debug support
137 *
138 ****************************************************************************/
139
140/* Runtime configuration of debug print levels */
141
142extern      UINT32                      AcpiDbgLevel;
143extern      UINT32                      AcpiDbgLayer;
144
145/* Procedure nesting level for debug output */
146
147extern      UINT32                      AcpiGbl_NestingLevel;
148
149
150/*****************************************************************************
151 *
152 * ACPI Table globals
153 *
154 ****************************************************************************/
155
156/*
157 * Table pointers.
158 * Although these pointers are somewhat redundant with the global AcpiTable,
159 * they are convenient because they are typed pointers.
160 *
161 * These tables are single-table only; meaning that there can be at most one
162 * of each in the system.  Each global points to the actual table.
163 *
164 */
165ACPI_EXTERN RSDP_DESCRIPTOR            *AcpiGbl_RSDP;
166ACPI_EXTERN XSDT_DESCRIPTOR            *AcpiGbl_XSDT;
167ACPI_EXTERN FADT_DESCRIPTOR            *AcpiGbl_FADT;
168ACPI_EXTERN ACPI_TABLE_HEADER          *AcpiGbl_DSDT;
169ACPI_EXTERN FACS_DESCRIPTOR            *AcpiGbl_FACS;
170ACPI_EXTERN ACPI_COMMON_FACS            AcpiGbl_CommonFACS;
171
172/*
173 * Since there may be multiple SSDTs and PSDTS, a single pointer is not
174 * sufficient; Therefore, there isn't one!
175 */
176
177
178/*
179 * ACPI Table info arrays
180 */
181extern      ACPI_TABLE_DESC             AcpiGbl_AcpiTables[NUM_ACPI_TABLES];
182extern      ACPI_TABLE_SUPPORT          AcpiGbl_AcpiTableData[NUM_ACPI_TABLES];
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_AcpiMutexInfo [NUM_MTX];
190
191
192/*****************************************************************************
193 *
194 * Miscellaneous globals
195 *
196 ****************************************************************************/
197
198
199ACPI_EXTERN ACPI_MEMORY_LIST            AcpiGbl_MemoryLists[ACPI_NUM_MEM_LISTS];
200ACPI_EXTERN ACPI_OBJECT_NOTIFY_HANDLER  AcpiGbl_DrvNotify;
201ACPI_EXTERN ACPI_OBJECT_NOTIFY_HANDLER  AcpiGbl_SysNotify;
202ACPI_EXTERN ACPI_WALK_STATE            *AcpiGbl_BreakpointWalk;
203ACPI_EXTERN ACPI_HANDLE                 AcpiGbl_GlobalLockSemaphore;
204
205ACPI_EXTERN UINT32                      AcpiGbl_GlobalLockThreadCount;
206ACPI_EXTERN UINT32                      AcpiGbl_OriginalMode;
207ACPI_EXTERN UINT32                      AcpiGbl_RsdpOriginalLocation;
208ACPI_EXTERN UINT32                      AcpiGbl_NsLookupCount;
209ACPI_EXTERN UINT32                      AcpiGbl_PsFindCount;
210ACPI_EXTERN UINT16                      AcpiGbl_Pm1EnableRegisterSave;
211ACPI_EXTERN UINT16                      AcpiGbl_NextTableOwnerId;
212ACPI_EXTERN UINT16                      AcpiGbl_NextMethodOwnerId;
213ACPI_EXTERN UINT16                      AcpiGbl_GlobalLockHandle;
214ACPI_EXTERN UINT8                       AcpiGbl_DebuggerConfiguration;
215ACPI_EXTERN BOOLEAN                     AcpiGbl_GlobalLockAcquired;
216ACPI_EXTERN BOOLEAN                     AcpiGbl_StepToNextCall;
217ACPI_EXTERN BOOLEAN                     AcpiGbl_AcpiHardwarePresent;
218ACPI_EXTERN BOOLEAN                     AcpiGbl_GlobalLockPresent;
219
220extern BOOLEAN                          AcpiGbl_Shutdown;
221extern UINT32                           AcpiGbl_StartupFlags;
222extern const UINT8                      AcpiGbl_DecodeTo8bit[8];
223extern const NATIVE_CHAR                *AcpiGbl_DbSleepStates[ACPI_NUM_SLEEP_STATES];
224
225
226/*****************************************************************************
227 *
228 * Namespace globals
229 *
230 ****************************************************************************/
231
232#define NUM_NS_TYPES                    INTERNAL_TYPE_INVALID+1
233#define NUM_PREDEFINED_NAMES            9
234
235
236ACPI_EXTERN ACPI_NAMESPACE_NODE         AcpiGbl_RootNodeStruct;
237ACPI_EXTERN ACPI_NAMESPACE_NODE        *AcpiGbl_RootNode;
238
239extern const UINT8                      AcpiGbl_NsProperties[NUM_NS_TYPES];
240extern const ACPI_PREDEFINED_NAMES      AcpiGbl_PreDefinedNames [NUM_PREDEFINED_NAMES];
241
242#ifdef ACPI_DEBUG
243ACPI_EXTERN UINT32                      AcpiGbl_CurrentNodeCount;
244ACPI_EXTERN UINT32                      AcpiGbl_CurrentNodeSize;
245ACPI_EXTERN UINT32                      AcpiGbl_MaxConcurrentNodeCount;
246ACPI_EXTERN ACPI_SIZE                   AcpiGbl_EntryStackPointer;
247ACPI_EXTERN ACPI_SIZE                   AcpiGbl_LowestStackPointer;
248ACPI_EXTERN UINT32                      AcpiGbl_DeepestNesting;
249#endif
250
251/*****************************************************************************
252 *
253 * Interpreter globals
254 *
255 ****************************************************************************/
256
257
258ACPI_EXTERN ACPI_THREAD_STATE           *AcpiGbl_CurrentWalkList;
259
260/* Control method single step flag */
261
262ACPI_EXTERN UINT8                       AcpiGbl_CmSingleStep;
263
264
265/*****************************************************************************
266 *
267 * Parser globals
268 *
269 ****************************************************************************/
270
271ACPI_EXTERN ACPI_PARSE_OBJECT           *AcpiGbl_ParsedNamespaceRoot;
272
273/*****************************************************************************
274 *
275 * Hardware globals
276 *
277 ****************************************************************************/
278
279ACPI_EXTERN ACPI_BIT_REGISTER_INFO      AcpiGbl_BitRegisterInfo[ACPI_NUM_BITREG];
280ACPI_EXTERN UINT8                       AcpiGbl_SleepTypeA;
281ACPI_EXTERN UINT8                       AcpiGbl_SleepTypeB;
282
283
284/*****************************************************************************
285 *
286 * Event and GPE globals
287 *
288 ****************************************************************************/
289
290extern      ACPI_FIXED_EVENT_INFO       AcpiGbl_FixedEventInfo[ACPI_NUM_FIXED_EVENTS];
291ACPI_EXTERN ACPI_FIXED_EVENT_HANDLER    AcpiGbl_FixedEventHandlers[ACPI_NUM_FIXED_EVENTS];
292
293ACPI_EXTERN ACPI_HANDLE                 AcpiGbl_GpeObjHandle;
294ACPI_EXTERN UINT32                      AcpiGbl_GpeRegisterCount;
295ACPI_EXTERN UINT32                      AcpiGbl_GpeNumberMax;
296ACPI_EXTERN ACPI_GPE_REGISTER_INFO     *AcpiGbl_GpeRegisterInfo;
297ACPI_EXTERN ACPI_GPE_NUMBER_INFO       *AcpiGbl_GpeNumberInfo;
298ACPI_EXTERN ACPI_GPE_BLOCK_INFO         AcpiGbl_GpeBlockInfo[ACPI_MAX_GPE_BLOCKS];
299
300/*
301 * GPE translation table
302 * Indexed by the GPE number, returns a valid index into the global GPE tables.
303 *
304 * This table is needed because the GPE numbers supported by block 1 do not
305 * have to be contiguous with the GPE numbers supported by block 0.
306 */
307ACPI_EXTERN ACPI_GPE_INDEX_INFO        *AcpiGbl_GpeNumberToIndex;
308
309
310/*****************************************************************************
311 *
312 * Debugger globals
313 *
314 ****************************************************************************/
315
316
317ACPI_EXTERN UINT8                       AcpiGbl_DbOutputFlags;
318
319
320#ifdef ENABLE_DEBUGGER
321
322ACPI_EXTERN BOOLEAN                     AcpiGbl_MethodExecuting;
323ACPI_EXTERN BOOLEAN                     AcpiGbl_DbTerminateThreads;
324
325ACPI_EXTERN int                         optind;
326ACPI_EXTERN NATIVE_CHAR                *optarg;
327ACPI_EXTERN UINT8                      *AmlStart;
328ACPI_EXTERN UINT32                      AmlLength;
329
330ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_tables;
331ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_disasm;
332ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_stats;
333ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_verbose;
334ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_ini_methods;
335
336
337ACPI_EXTERN NATIVE_CHAR                *AcpiGbl_DbArgs[ACPI_DEBUGGER_MAX_ARGS];
338ACPI_EXTERN NATIVE_CHAR                 AcpiGbl_DbLineBuf[80];
339ACPI_EXTERN NATIVE_CHAR                 AcpiGbl_DbParsedBuf[80];
340ACPI_EXTERN NATIVE_CHAR                 AcpiGbl_DbScopeBuf[40];
341ACPI_EXTERN NATIVE_CHAR                 AcpiGbl_DbDebugFilename[40];
342ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOutputToFile;
343ACPI_EXTERN NATIVE_CHAR                *AcpiGbl_DbBuffer;
344ACPI_EXTERN NATIVE_CHAR                *AcpiGbl_DbFilename;
345ACPI_EXTERN NATIVE_CHAR                *AcpiGbl_DbDisasmIndent;
346ACPI_EXTERN UINT32                      AcpiGbl_DbDebugLevel;
347ACPI_EXTERN UINT32                      AcpiGbl_DbConsoleDebugLevel;
348ACPI_EXTERN ACPI_TABLE_HEADER          *AcpiGbl_DbTablePtr;
349ACPI_EXTERN ACPI_NAMESPACE_NODE        *AcpiGbl_DbScopeNode;
350
351/*
352 * Statistic globals
353 */
354ACPI_EXTERN UINT16                      AcpiGbl_ObjTypeCount[INTERNAL_TYPE_NODE_MAX+1];
355ACPI_EXTERN UINT16                      AcpiGbl_NodeTypeCount[INTERNAL_TYPE_NODE_MAX+1];
356ACPI_EXTERN UINT16                      AcpiGbl_ObjTypeCountMisc;
357ACPI_EXTERN UINT16                      AcpiGbl_NodeTypeCountMisc;
358ACPI_EXTERN UINT32                      AcpiGbl_NumNodes;
359ACPI_EXTERN UINT32                      AcpiGbl_NumObjects;
360
361
362ACPI_EXTERN UINT32                      AcpiGbl_SizeOfParseTree;
363ACPI_EXTERN UINT32                      AcpiGbl_SizeOfMethodTrees;
364ACPI_EXTERN UINT32                      AcpiGbl_SizeOfNodeEntries;
365ACPI_EXTERN UINT32                      AcpiGbl_SizeOfAcpiObjects;
366
367#endif /* ENABLE_DEBUGGER */
368
369
370#endif /* __ACGLOBAL_H__ */
371