Bring in acpica-20040527 from intel. See: http://developer.intel.com/technology...
[dragonfly.git] / sys / contrib / dev / acpica-unix-20040527 / include / acglobal.h
1 /******************************************************************************
2  *
3  * Name: acglobal.h - Declarations for global variables
4  *       $Revision: 154 $
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  */
139 ACPI_EXTERN ACPI_GENERIC_ADDRESS        AcpiGbl_XPm1aEnable;
140 ACPI_EXTERN ACPI_GENERIC_ADDRESS        AcpiGbl_XPm1bEnable;
141
142
143 /*****************************************************************************
144  *
145  * Debug support
146  *
147  ****************************************************************************/
148
149 /* Runtime configuration of debug print levels */
150
151 extern      UINT32                      AcpiDbgLevel;
152 extern      UINT32                      AcpiDbgLayer;
153
154 /* Procedure nesting level for debug output */
155
156 extern      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  */
170 ACPI_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  */
178 ACPI_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  */
185 ACPI_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  */
202 ACPI_EXTERN UINT32                      AcpiGbl_TableFlags;
203 ACPI_EXTERN UINT32                      AcpiGbl_RsdtTableCount;
204 ACPI_EXTERN RSDP_DESCRIPTOR            *AcpiGbl_RSDP;
205 ACPI_EXTERN XSDT_DESCRIPTOR            *AcpiGbl_XSDT;
206 ACPI_EXTERN FADT_DESCRIPTOR            *AcpiGbl_FADT;
207 ACPI_EXTERN ACPI_TABLE_HEADER          *AcpiGbl_DSDT;
208 ACPI_EXTERN FACS_DESCRIPTOR            *AcpiGbl_FACS;
209 ACPI_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  */
221 ACPI_EXTERN UINT8                       AcpiGbl_IntegerBitWidth;
222 ACPI_EXTERN UINT8                       AcpiGbl_IntegerByteWidth;
223 ACPI_EXTERN UINT8                       AcpiGbl_IntegerNybbleWidth;
224
225 /*
226  * ACPI Table info arrays
227  */
228 extern      ACPI_TABLE_LIST             AcpiGbl_TableLists[NUM_ACPI_TABLE_TYPES];
229 extern      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  */
236 ACPI_EXTERN ACPI_MUTEX_INFO             AcpiGbl_MutexInfo[NUM_MUTEX];
237
238
239 /*****************************************************************************
240  *
241  * Miscellaneous globals
242  *
243  ****************************************************************************/
244
245
246 ACPI_EXTERN ACPI_MEMORY_LIST            AcpiGbl_MemoryLists[ACPI_NUM_MEM_LISTS];
247 ACPI_EXTERN ACPI_OBJECT_NOTIFY_HANDLER  AcpiGbl_DeviceNotify;
248 ACPI_EXTERN ACPI_OBJECT_NOTIFY_HANDLER  AcpiGbl_SystemNotify;
249 ACPI_EXTERN ACPI_INIT_HANDLER           AcpiGbl_InitHandler;
250 ACPI_EXTERN ACPI_WALK_STATE            *AcpiGbl_BreakpointWalk;
251 ACPI_EXTERN ACPI_HANDLE                 AcpiGbl_GlobalLockSemaphore;
252
253 ACPI_EXTERN UINT32                      AcpiGbl_GlobalLockThreadCount;
254 ACPI_EXTERN UINT32                      AcpiGbl_OriginalMode;
255 ACPI_EXTERN UINT32                      AcpiGbl_RsdpOriginalLocation;
256 ACPI_EXTERN UINT32                      AcpiGbl_NsLookupCount;
257 ACPI_EXTERN UINT32                      AcpiGbl_PsFindCount;
258 ACPI_EXTERN UINT16                      AcpiGbl_Pm1EnableRegisterSave;
259 ACPI_EXTERN UINT16                      AcpiGbl_NextTableOwnerId;
260 ACPI_EXTERN UINT16                      AcpiGbl_NextMethodOwnerId;
261 ACPI_EXTERN UINT16                      AcpiGbl_GlobalLockHandle;
262 ACPI_EXTERN UINT8                       AcpiGbl_DebuggerConfiguration;
263 ACPI_EXTERN BOOLEAN                     AcpiGbl_GlobalLockAcquired;
264 ACPI_EXTERN BOOLEAN                     AcpiGbl_StepToNextCall;
265 ACPI_EXTERN BOOLEAN                     AcpiGbl_AcpiHardwarePresent;
266 ACPI_EXTERN BOOLEAN                     AcpiGbl_GlobalLockPresent;
267 ACPI_EXTERN BOOLEAN                     AcpiGbl_EventsInitialized;
268 ACPI_EXTERN BOOLEAN                     AcpiGbl_SystemAwakeAndRunning;
269
270 extern BOOLEAN                          AcpiGbl_Shutdown;
271 extern UINT32                           AcpiGbl_StartupFlags;
272 extern const UINT8                      AcpiGbl_DecodeTo8bit[8];
273 extern const char                      *AcpiGbl_SleepStateNames[ACPI_S_STATE_COUNT];
274 extern const char                      *AcpiGbl_HighestDstateNames[4];
275 extern const ACPI_OPCODE_INFO           AcpiGbl_AmlOpInfo[AML_NUM_OPCODES];
276 extern const char                      *AcpiGbl_RegionTypes[ACPI_NUM_PREDEFINED_REGIONS];
277 extern const char                      *AcpiGbl_ValidOsiStrings[ACPI_NUM_OSI_STRINGS];
278
279
280 /*****************************************************************************
281  *
282  * Namespace globals
283  *
284  ****************************************************************************/
285
286 #define NUM_NS_TYPES                    ACPI_TYPE_INVALID+1
287
288 #if !defined (ACPI_NO_METHOD_EXECUTION) || defined (ACPI_CONSTANT_EVAL_ONLY)
289 #define NUM_PREDEFINED_NAMES            10
290 #else
291 #define NUM_PREDEFINED_NAMES            9
292 #endif
293
294 ACPI_EXTERN ACPI_NAMESPACE_NODE         AcpiGbl_RootNodeStruct;
295 ACPI_EXTERN ACPI_NAMESPACE_NODE        *AcpiGbl_RootNode;
296 ACPI_EXTERN ACPI_NAMESPACE_NODE        *AcpiGbl_FadtGpeDevice;
297
298 extern const UINT8                      AcpiGbl_NsProperties[NUM_NS_TYPES];
299 extern const ACPI_PREDEFINED_NAMES      AcpiGbl_PreDefinedNames [NUM_PREDEFINED_NAMES];
300
301 #ifdef ACPI_DEBUG_OUTPUT
302 ACPI_EXTERN UINT32                      AcpiGbl_CurrentNodeCount;
303 ACPI_EXTERN UINT32                      AcpiGbl_CurrentNodeSize;
304 ACPI_EXTERN UINT32                      AcpiGbl_MaxConcurrentNodeCount;
305 ACPI_EXTERN ACPI_SIZE                   AcpiGbl_EntryStackPointer;
306 ACPI_EXTERN ACPI_SIZE                   AcpiGbl_LowestStackPointer;
307 ACPI_EXTERN UINT32                      AcpiGbl_DeepestNesting;
308 #endif
309
310 /*****************************************************************************
311  *
312  * Interpreter globals
313  *
314  ****************************************************************************/
315
316
317 ACPI_EXTERN ACPI_THREAD_STATE          *AcpiGbl_CurrentWalkList;
318
319 /* Control method single step flag */
320
321 ACPI_EXTERN UINT8                       AcpiGbl_CmSingleStep;
322
323
324 /*****************************************************************************
325  *
326  * Parser globals
327  *
328  ****************************************************************************/
329
330 ACPI_EXTERN ACPI_PARSE_OBJECT          *AcpiGbl_ParsedNamespaceRoot;
331
332 /*****************************************************************************
333  *
334  * Hardware globals
335  *
336  ****************************************************************************/
337
338 extern      ACPI_BIT_REGISTER_INFO      AcpiGbl_BitRegisterInfo[ACPI_NUM_BITREG];
339 ACPI_EXTERN UINT8                       AcpiGbl_SleepTypeA;
340 ACPI_EXTERN UINT8                       AcpiGbl_SleepTypeB;
341
342
343 /*****************************************************************************
344  *
345  * Event and GPE globals
346  *
347  ****************************************************************************/
348
349 extern      ACPI_FIXED_EVENT_INFO       AcpiGbl_FixedEventInfo[ACPI_NUM_FIXED_EVENTS];
350 ACPI_EXTERN ACPI_FIXED_EVENT_HANDLER    AcpiGbl_FixedEventHandlers[ACPI_NUM_FIXED_EVENTS];
351 ACPI_EXTERN ACPI_GPE_XRUPT_INFO        *AcpiGbl_GpeXruptListHead;
352 ACPI_EXTERN ACPI_GPE_BLOCK_INFO        *AcpiGbl_GpeFadtBlocks[ACPI_MAX_GPE_BLOCKS];
353 ACPI_EXTERN ACPI_HANDLE                 AcpiGbl_GpeLock;
354
355
356 /*****************************************************************************
357  *
358  * Debugger globals
359  *
360  ****************************************************************************/
361
362
363 ACPI_EXTERN UINT8                       AcpiGbl_DbOutputFlags;
364
365 #ifdef ACPI_DISASSEMBLER
366
367 ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_disasm;
368 ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_verbose;
369 #endif
370
371
372 #ifdef ACPI_DEBUGGER
373
374 extern      BOOLEAN                     AcpiGbl_MethodExecuting;
375 extern      BOOLEAN                     AcpiGbl_AbortMethod;
376 extern      BOOLEAN                     AcpiGbl_DbTerminateThreads;
377
378 ACPI_EXTERN int                         optind;
379 ACPI_EXTERN char                       *optarg;
380
381 ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_tables;
382 ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_stats;
383 ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOpt_ini_methods;
384
385
386 ACPI_EXTERN char                       *AcpiGbl_DbArgs[ACPI_DEBUGGER_MAX_ARGS];
387 ACPI_EXTERN char                        AcpiGbl_DbLineBuf[80];
388 ACPI_EXTERN char                        AcpiGbl_DbParsedBuf[80];
389 ACPI_EXTERN char                        AcpiGbl_DbScopeBuf[40];
390 ACPI_EXTERN char                        AcpiGbl_DbDebugFilename[40];
391 ACPI_EXTERN BOOLEAN                     AcpiGbl_DbOutputToFile;
392 ACPI_EXTERN char                       *AcpiGbl_DbBuffer;
393 ACPI_EXTERN char                       *AcpiGbl_DbFilename;
394 ACPI_EXTERN UINT32                      AcpiGbl_DbDebugLevel;
395 ACPI_EXTERN UINT32                      AcpiGbl_DbConsoleDebugLevel;
396 ACPI_EXTERN ACPI_TABLE_HEADER          *AcpiGbl_DbTablePtr;
397 ACPI_EXTERN ACPI_NAMESPACE_NODE        *AcpiGbl_DbScopeNode;
398
399 /*
400  * Statistic globals
401  */
402 ACPI_EXTERN UINT16                      AcpiGbl_ObjTypeCount[ACPI_TYPE_NS_NODE_MAX+1];
403 ACPI_EXTERN UINT16                      AcpiGbl_NodeTypeCount[ACPI_TYPE_NS_NODE_MAX+1];
404 ACPI_EXTERN UINT16                      AcpiGbl_ObjTypeCountMisc;
405 ACPI_EXTERN UINT16                      AcpiGbl_NodeTypeCountMisc;
406 ACPI_EXTERN UINT32                      AcpiGbl_NumNodes;
407 ACPI_EXTERN UINT32                      AcpiGbl_NumObjects;
408
409
410 ACPI_EXTERN UINT32                      AcpiGbl_SizeOfParseTree;
411 ACPI_EXTERN UINT32                      AcpiGbl_SizeOfMethodTrees;
412 ACPI_EXTERN UINT32                      AcpiGbl_SizeOfNodeEntries;
413 ACPI_EXTERN UINT32                      AcpiGbl_SizeOfAcpiObjects;
414
415 #endif /* ACPI_DEBUGGER */
416
417
418 #endif /* __ACGLOBAL_H__ */