Sync ACPICA with Intel's version 20150930.
[dragonfly.git] / sys / contrib / dev / acpica / source / include / acglobal.h
1 /******************************************************************************
2  *
3  * Name: acglobal.h - Declarations for global variables
4  *
5  *****************************************************************************/
6
7 /*
8  * Copyright (C) 2000 - 2015, 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  *
50  * Globals related to the ACPI tables
51  *
52  ****************************************************************************/
53
54 /* Master list of all ACPI tables that were found in the RSDT/XSDT */
55
56 ACPI_GLOBAL (ACPI_TABLE_LIST,           AcpiGbl_RootTableList);
57
58 /* DSDT information. Used to check for DSDT corruption */
59
60 ACPI_GLOBAL (ACPI_TABLE_HEADER *,       AcpiGbl_DSDT);
61 ACPI_GLOBAL (ACPI_TABLE_HEADER,         AcpiGbl_OriginalDsdtHeader);
62 ACPI_INIT_GLOBAL (UINT32,               AcpiGbl_DsdtIndex, ACPI_INVALID_TABLE_INDEX);
63 ACPI_INIT_GLOBAL (UINT32,               AcpiGbl_FacsIndex, ACPI_INVALID_TABLE_INDEX);
64 ACPI_INIT_GLOBAL (UINT32,               AcpiGbl_XFacsIndex, ACPI_INVALID_TABLE_INDEX);
65
66 #if (!ACPI_REDUCED_HARDWARE)
67 ACPI_GLOBAL (ACPI_TABLE_FACS *,         AcpiGbl_FACS);
68
69 #endif /* !ACPI_REDUCED_HARDWARE */
70
71 /* These addresses are calculated from the FADT Event Block addresses */
72
73 ACPI_GLOBAL (ACPI_GENERIC_ADDRESS,      AcpiGbl_XPm1aStatus);
74 ACPI_GLOBAL (ACPI_GENERIC_ADDRESS,      AcpiGbl_XPm1aEnable);
75
76 ACPI_GLOBAL (ACPI_GENERIC_ADDRESS,      AcpiGbl_XPm1bStatus);
77 ACPI_GLOBAL (ACPI_GENERIC_ADDRESS,      AcpiGbl_XPm1bEnable);
78
79 /*
80  * Handle both ACPI 1.0 and ACPI 2.0+ Integer widths. The integer width is
81  * determined by the revision of the DSDT: If the DSDT revision is less than
82  * 2, use only the lower 32 bits of the internal 64-bit Integer.
83  */
84 ACPI_GLOBAL (UINT8,                     AcpiGbl_IntegerBitWidth);
85 ACPI_GLOBAL (UINT8,                     AcpiGbl_IntegerByteWidth);
86 ACPI_GLOBAL (UINT8,                     AcpiGbl_IntegerNybbleWidth);
87
88
89 /*****************************************************************************
90  *
91  * Mutual exclusion within ACPICA subsystem
92  *
93  ****************************************************************************/
94
95 /*
96  * Predefined mutex objects. This array contains the
97  * actual OS mutex handles, indexed by the local ACPI_MUTEX_HANDLEs.
98  * (The table maps local handles to the real OS handles)
99  */
100 ACPI_GLOBAL (ACPI_MUTEX_INFO,           AcpiGbl_MutexInfo[ACPI_NUM_MUTEX]);
101
102 /*
103  * Global lock mutex is an actual AML mutex object
104  * Global lock semaphore works in conjunction with the actual global lock
105  * Global lock spinlock is used for "pending" handshake
106  */
107 ACPI_GLOBAL (ACPI_OPERAND_OBJECT *,     AcpiGbl_GlobalLockMutex);
108 ACPI_GLOBAL (ACPI_SEMAPHORE,            AcpiGbl_GlobalLockSemaphore);
109 ACPI_GLOBAL (ACPI_SPINLOCK,             AcpiGbl_GlobalLockPendingLock);
110 ACPI_GLOBAL (UINT16,                    AcpiGbl_GlobalLockHandle);
111 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_GlobalLockAcquired);
112 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_GlobalLockPresent);
113 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_GlobalLockPending);
114
115 /*
116  * Spinlocks are used for interfaces that can be possibly called at
117  * interrupt level
118  */
119 ACPI_GLOBAL (ACPI_SPINLOCK,             AcpiGbl_GpeLock);       /* For GPE data structs and registers */
120 ACPI_GLOBAL (ACPI_SPINLOCK,             AcpiGbl_HardwareLock);  /* For ACPI H/W except GPE registers */
121 ACPI_GLOBAL (ACPI_SPINLOCK,             AcpiGbl_ReferenceCountLock);
122
123 /* Mutex for _OSI support */
124
125 ACPI_GLOBAL (ACPI_MUTEX,                AcpiGbl_OsiMutex);
126
127 /* Reader/Writer lock is used for namespace walk and dynamic table unload */
128
129 ACPI_GLOBAL (ACPI_RW_LOCK,              AcpiGbl_NamespaceRwLock);
130
131
132 /*****************************************************************************
133  *
134  * Miscellaneous globals
135  *
136  ****************************************************************************/
137
138 /* Object caches */
139
140 ACPI_GLOBAL (ACPI_CACHE_T *,            AcpiGbl_NamespaceCache);
141 ACPI_GLOBAL (ACPI_CACHE_T *,            AcpiGbl_StateCache);
142 ACPI_GLOBAL (ACPI_CACHE_T *,            AcpiGbl_PsNodeCache);
143 ACPI_GLOBAL (ACPI_CACHE_T *,            AcpiGbl_PsNodeExtCache);
144 ACPI_GLOBAL (ACPI_CACHE_T *,            AcpiGbl_OperandCache);
145
146 /* System */
147
148 ACPI_INIT_GLOBAL (UINT32,               AcpiGbl_StartupFlags, 0);
149 ACPI_INIT_GLOBAL (BOOLEAN,              AcpiGbl_Shutdown, TRUE);
150
151 /* Global handlers */
152
153 ACPI_GLOBAL (ACPI_GLOBAL_NOTIFY_HANDLER,AcpiGbl_GlobalNotify[2]);
154 ACPI_GLOBAL (ACPI_EXCEPTION_HANDLER,    AcpiGbl_ExceptionHandler);
155 ACPI_GLOBAL (ACPI_INIT_HANDLER,         AcpiGbl_InitHandler);
156 ACPI_GLOBAL (ACPI_TABLE_HANDLER,        AcpiGbl_TableHandler);
157 ACPI_GLOBAL (void *,                    AcpiGbl_TableHandlerContext);
158 ACPI_GLOBAL (ACPI_INTERFACE_HANDLER,    AcpiGbl_InterfaceHandler);
159 ACPI_GLOBAL (ACPI_SCI_HANDLER_INFO *,   AcpiGbl_SciHandlerList);
160
161 /* Owner ID support */
162
163 ACPI_GLOBAL (UINT32,                    AcpiGbl_OwnerIdMask[ACPI_NUM_OWNERID_MASKS]);
164 ACPI_GLOBAL (UINT8,                     AcpiGbl_LastOwnerIdIndex);
165 ACPI_GLOBAL (UINT8,                     AcpiGbl_NextOwnerIdOffset);
166
167 /* Initialization sequencing */
168
169 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_RegMethodsExecuted);
170
171 /* Misc */
172
173 ACPI_GLOBAL (UINT32,                    AcpiGbl_OriginalMode);
174 ACPI_GLOBAL (UINT32,                    AcpiGbl_NsLookupCount);
175 ACPI_GLOBAL (UINT32,                    AcpiGbl_PsFindCount);
176 ACPI_GLOBAL (UINT16,                    AcpiGbl_Pm1EnableRegisterSave);
177 ACPI_GLOBAL (UINT8,                     AcpiGbl_DebuggerConfiguration);
178 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_StepToNextCall);
179 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_AcpiHardwarePresent);
180 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_EventsInitialized);
181 ACPI_GLOBAL (ACPI_INTERFACE_INFO *,     AcpiGbl_SupportedInterfaces);
182 ACPI_GLOBAL (ACPI_ADDRESS_RANGE *,      AcpiGbl_AddressRangeList[ACPI_ADDRESS_RANGE_MAX]);
183
184 /* Other miscellaneous, declared and initialized in utglobal */
185
186 extern const char                      *AcpiGbl_SleepStateNames[ACPI_S_STATE_COUNT];
187 extern const char                      *AcpiGbl_LowestDstateNames[ACPI_NUM_SxW_METHODS];
188 extern const char                      *AcpiGbl_HighestDstateNames[ACPI_NUM_SxD_METHODS];
189 extern const char                      *AcpiGbl_RegionTypes[ACPI_NUM_PREDEFINED_REGIONS];
190 extern const ACPI_OPCODE_INFO           AcpiGbl_AmlOpInfo[AML_NUM_OPCODES];
191
192
193 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
194
195 /* Lists for tracking memory allocations (debug only) */
196
197 ACPI_GLOBAL (ACPI_MEMORY_LIST *,        AcpiGbl_GlobalList);
198 ACPI_GLOBAL (ACPI_MEMORY_LIST *,        AcpiGbl_NsNodeList);
199 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_DisplayFinalMemStats);
200 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_DisableMemTracking);
201 #endif
202
203
204 /*****************************************************************************
205  *
206  * Namespace globals
207  *
208  ****************************************************************************/
209
210 #if !defined (ACPI_NO_METHOD_EXECUTION) || defined (ACPI_CONSTANT_EVAL_ONLY)
211 #define NUM_PREDEFINED_NAMES            10
212 #else
213 #define NUM_PREDEFINED_NAMES            9
214 #endif
215
216 ACPI_GLOBAL (ACPI_NAMESPACE_NODE,       AcpiGbl_RootNodeStruct);
217 ACPI_GLOBAL (ACPI_NAMESPACE_NODE *,     AcpiGbl_RootNode);
218 ACPI_GLOBAL (ACPI_NAMESPACE_NODE *,     AcpiGbl_FadtGpeDevice);
219 ACPI_GLOBAL (ACPI_OPERAND_OBJECT *,     AcpiGbl_ModuleCodeList);
220
221
222 extern const UINT8                      AcpiGbl_NsProperties [ACPI_NUM_NS_TYPES];
223 extern const ACPI_PREDEFINED_NAMES      AcpiGbl_PreDefinedNames [NUM_PREDEFINED_NAMES];
224
225 #ifdef ACPI_DEBUG_OUTPUT
226 ACPI_GLOBAL (UINT32,                    AcpiGbl_CurrentNodeCount);
227 ACPI_GLOBAL (UINT32,                    AcpiGbl_CurrentNodeSize);
228 ACPI_GLOBAL (UINT32,                    AcpiGbl_MaxConcurrentNodeCount);
229 ACPI_GLOBAL (ACPI_SIZE *,               AcpiGbl_EntryStackPointer);
230 ACPI_GLOBAL (ACPI_SIZE *,               AcpiGbl_LowestStackPointer);
231 ACPI_GLOBAL (UINT32,                    AcpiGbl_DeepestNesting);
232 ACPI_INIT_GLOBAL (UINT32,               AcpiGbl_NestingLevel, 0);
233 #endif
234
235
236 /*****************************************************************************
237  *
238  * Interpreter globals
239  *
240  ****************************************************************************/
241
242 ACPI_GLOBAL (ACPI_THREAD_STATE *,       AcpiGbl_CurrentWalkList);
243
244 /* Maximum number of While() loop iterations before forced abort */
245
246 ACPI_GLOBAL (UINT16,                    AcpiGbl_MaxLoopIterations);
247
248 /* Control method single step flag */
249
250 ACPI_GLOBAL (UINT8,                     AcpiGbl_CmSingleStep);
251
252
253 /*****************************************************************************
254  *
255  * Hardware globals
256  *
257  ****************************************************************************/
258
259 extern ACPI_BIT_REGISTER_INFO           AcpiGbl_BitRegisterInfo[ACPI_NUM_BITREG];
260
261 ACPI_GLOBAL (UINT8,                     AcpiGbl_SleepTypeA);
262 ACPI_GLOBAL (UINT8,                     AcpiGbl_SleepTypeB);
263
264
265 /*****************************************************************************
266  *
267  * Event and GPE globals
268  *
269  ****************************************************************************/
270
271 #if (!ACPI_REDUCED_HARDWARE)
272
273 ACPI_GLOBAL (UINT8,                     AcpiGbl_AllGpesInitialized);
274 ACPI_GLOBAL (ACPI_GPE_XRUPT_INFO *,     AcpiGbl_GpeXruptListHead);
275 ACPI_GLOBAL (ACPI_GPE_BLOCK_INFO *,     AcpiGbl_GpeFadtBlocks[ACPI_MAX_GPE_BLOCKS]);
276 ACPI_GLOBAL (ACPI_GBL_EVENT_HANDLER,    AcpiGbl_GlobalEventHandler);
277 ACPI_GLOBAL (void *,                    AcpiGbl_GlobalEventHandlerContext);
278 ACPI_GLOBAL (ACPI_FIXED_EVENT_HANDLER,  AcpiGbl_FixedEventHandlers[ACPI_NUM_FIXED_EVENTS]);
279
280 extern ACPI_FIXED_EVENT_INFO            AcpiGbl_FixedEventInfo[ACPI_NUM_FIXED_EVENTS];
281
282 #endif /* !ACPI_REDUCED_HARDWARE */
283
284 /*****************************************************************************
285  *
286  * Debug support
287  *
288  ****************************************************************************/
289
290 /* Event counters */
291
292 ACPI_GLOBAL (UINT32,                    AcpiMethodCount);
293 ACPI_GLOBAL (UINT32,                    AcpiGpeCount);
294 ACPI_GLOBAL (UINT32,                    AcpiSciCount);
295 ACPI_GLOBAL (UINT32,                    AcpiFixedEventCount[ACPI_NUM_FIXED_EVENTS]);
296
297 /* Support for dynamic control method tracing mechanism */
298
299 ACPI_GLOBAL (UINT32,                    AcpiGbl_OriginalDbgLevel);
300 ACPI_GLOBAL (UINT32,                    AcpiGbl_OriginalDbgLayer);
301
302
303 /*****************************************************************************
304  *
305  * Debugger and Disassembler globals
306  *
307  ****************************************************************************/
308
309 ACPI_INIT_GLOBAL (UINT8,                AcpiGbl_DbOutputFlags, ACPI_DB_CONSOLE_OUTPUT);
310
311 #ifdef ACPI_DISASSEMBLER
312
313 /* Do not disassemble buffers to resource descriptors */
314
315 ACPI_INIT_GLOBAL (UINT8,                AcpiGbl_NoResourceDisassembly, FALSE);
316 ACPI_INIT_GLOBAL (BOOLEAN,              AcpiGbl_IgnoreNoopOperator, FALSE);
317 ACPI_INIT_GLOBAL (BOOLEAN,              AcpiGbl_CstyleDisassembly, TRUE);
318 ACPI_INIT_GLOBAL (BOOLEAN,              AcpiGbl_ForceAmlDisassembly, FALSE);
319 ACPI_INIT_GLOBAL (BOOLEAN,              AcpiGbl_DmOpt_Verbose, TRUE);
320
321 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_DmOpt_Disasm);
322 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_DmOpt_Listing);
323 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_NumExternalMethods);
324 ACPI_GLOBAL (UINT32,                    AcpiGbl_ResolvedExternalMethods);
325 ACPI_GLOBAL (ACPI_EXTERNAL_LIST *,      AcpiGbl_ExternalList);
326 ACPI_GLOBAL (ACPI_EXTERNAL_FILE *,      AcpiGbl_ExternalFileList);
327 #endif
328
329 #ifdef ACPI_DEBUGGER
330
331 ACPI_INIT_GLOBAL (BOOLEAN,              AcpiGbl_DbTerminateThreads, FALSE);
332 ACPI_INIT_GLOBAL (BOOLEAN,              AcpiGbl_AbortMethod, FALSE);
333 ACPI_INIT_GLOBAL (BOOLEAN,              AcpiGbl_MethodExecuting, FALSE);
334
335 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_DbOpt_NoIniMethods);
336 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_DbOpt_NoRegionSupport);
337 ACPI_GLOBAL (BOOLEAN,                   AcpiGbl_DbOutputToFile);
338 ACPI_GLOBAL (char *,                    AcpiGbl_DbBuffer);
339 ACPI_GLOBAL (char *,                    AcpiGbl_DbFilename);
340 ACPI_GLOBAL (UINT32,                    AcpiGbl_DbDebugLevel);
341 ACPI_GLOBAL (UINT32,                    AcpiGbl_DbConsoleDebugLevel);
342 ACPI_GLOBAL (ACPI_NAMESPACE_NODE *,     AcpiGbl_DbScopeNode);
343
344 ACPI_GLOBAL (char *,                    AcpiGbl_DbArgs[ACPI_DEBUGGER_MAX_ARGS]);
345 ACPI_GLOBAL (ACPI_OBJECT_TYPE,          AcpiGbl_DbArgTypes[ACPI_DEBUGGER_MAX_ARGS]);
346
347 /* These buffers should all be the same size */
348
349 ACPI_GLOBAL (char,                      AcpiGbl_DbLineBuf[ACPI_DB_LINE_BUFFER_SIZE]);
350 ACPI_GLOBAL (char,                      AcpiGbl_DbParsedBuf[ACPI_DB_LINE_BUFFER_SIZE]);
351 ACPI_GLOBAL (char,                      AcpiGbl_DbScopeBuf[ACPI_DB_LINE_BUFFER_SIZE]);
352 ACPI_GLOBAL (char,                      AcpiGbl_DbDebugFilename[ACPI_DB_LINE_BUFFER_SIZE]);
353
354 /*
355  * Statistic globals
356  */
357 ACPI_GLOBAL (UINT16,                    AcpiGbl_ObjTypeCount[ACPI_TOTAL_TYPES]);
358 ACPI_GLOBAL (UINT16,                    AcpiGbl_NodeTypeCount[ACPI_TOTAL_TYPES]);
359 ACPI_GLOBAL (UINT16,                    AcpiGbl_ObjTypeCountMisc);
360 ACPI_GLOBAL (UINT16,                    AcpiGbl_NodeTypeCountMisc);
361 ACPI_GLOBAL (UINT32,                    AcpiGbl_NumNodes);
362 ACPI_GLOBAL (UINT32,                    AcpiGbl_NumObjects);
363
364 ACPI_GLOBAL (ACPI_MUTEX,                AcpiGbl_DbCommandReady);
365 ACPI_GLOBAL (ACPI_MUTEX,                AcpiGbl_DbCommandComplete);
366
367 #endif /* ACPI_DEBUGGER */
368
369
370 /*****************************************************************************
371  *
372  * Application globals
373  *
374  ****************************************************************************/
375
376 #ifdef ACPI_APPLICATION
377
378 ACPI_INIT_GLOBAL (ACPI_FILE,            AcpiGbl_DebugFile, NULL);
379 ACPI_INIT_GLOBAL (ACPI_FILE,            AcpiGbl_OutputFile, NULL);
380
381 /* Print buffer */
382
383 ACPI_GLOBAL (ACPI_SPINLOCK,             AcpiGbl_PrintLock);     /* For print buffer */
384 ACPI_GLOBAL (char,                      AcpiGbl_PrintBuffer[1024]);
385
386 #endif /* ACPI_APPLICATION */
387
388
389 /*****************************************************************************
390  *
391  * Info/help support
392  *
393  ****************************************************************************/
394
395 extern const AH_PREDEFINED_NAME         AslPredefinedInfo[];
396 extern const AH_DEVICE_ID               AslDeviceIds[];
397
398
399 #endif /* __ACGLOBAL_H__ */