xref: /netbsd-src/sys/external/bsd/acpica/dist/utilities/utglobal.c (revision a5847cc334d9a7029f6352b847e9e8d71a0f9e0c)
1 /******************************************************************************
2  *
3  * Module Name: utglobal - Global variables for the ACPI subsystem
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 #define __UTGLOBAL_C__
45 #define DEFINE_ACPI_GLOBALS
46 
47 #include "acpi.h"
48 #include "accommon.h"
49 
50 #define _COMPONENT          ACPI_UTILITIES
51         ACPI_MODULE_NAME    ("utglobal")
52 
53 
54 /*******************************************************************************
55  *
56  * Static global variable initialization.
57  *
58  ******************************************************************************/
59 
60 /*
61  * We want the debug switches statically initialized so they
62  * are already set when the debugger is entered.
63  */
64 
65 /* Debug switch - level and trace mask */
66 
67 #ifdef ACPI_DEBUG_OUTPUT
68 UINT32                      AcpiDbgLevel = ACPI_DEBUG_DEFAULT;
69 #else
70 UINT32                      AcpiDbgLevel = ACPI_NORMAL_DEFAULT;
71 #endif
72 
73 /* Debug switch - layer (component) mask */
74 
75 UINT32                      AcpiDbgLayer = ACPI_COMPONENT_DEFAULT;
76 UINT32                      AcpiGbl_NestingLevel = 0;
77 
78 /* Debugger globals */
79 
80 BOOLEAN                     AcpiGbl_DbTerminateThreads = FALSE;
81 BOOLEAN                     AcpiGbl_AbortMethod = FALSE;
82 BOOLEAN                     AcpiGbl_MethodExecuting = FALSE;
83 
84 /* System flags */
85 
86 UINT32                      AcpiGbl_StartupFlags = 0;
87 
88 /* System starts uninitialized */
89 
90 BOOLEAN                     AcpiGbl_Shutdown = TRUE;
91 
92 const char                  *AcpiGbl_SleepStateNames[ACPI_S_STATE_COUNT] =
93 {
94     "\\_S0_",
95     "\\_S1_",
96     "\\_S2_",
97     "\\_S3_",
98     "\\_S4_",
99     "\\_S5_"
100 };
101 
102 const char                  *AcpiGbl_LowestDstateNames[ACPI_NUM_SxW_METHODS] =
103 {
104     "_S0W",
105     "_S1W",
106     "_S2W",
107     "_S3W",
108     "_S4W"
109 };
110 
111 const char                  *AcpiGbl_HighestDstateNames[ACPI_NUM_SxD_METHODS] =
112 {
113     "_S1D",
114     "_S2D",
115     "_S3D",
116     "_S4D"
117 };
118 
119 
120 /*******************************************************************************
121  *
122  * Namespace globals
123  *
124  ******************************************************************************/
125 
126 /*
127  * Predefined ACPI Names (Built-in to the Interpreter)
128  *
129  * NOTES:
130  * 1) _SB_ is defined to be a device to allow \_SB_._INI to be run
131  *    during the initialization sequence.
132  * 2) _TZ_ is defined to be a thermal zone in order to allow ASL code to
133  *    perform a Notify() operation on it. 09/2010: Changed to type Device.
134  *    This still allows notifies, but does not confuse host code that
135  *    searches for valid ThermalZone objects.
136  */
137 const ACPI_PREDEFINED_NAMES     AcpiGbl_PreDefinedNames[] =
138 {
139     {"_GPE",    ACPI_TYPE_LOCAL_SCOPE,      NULL},
140     {"_PR_",    ACPI_TYPE_LOCAL_SCOPE,      NULL},
141     {"_SB_",    ACPI_TYPE_DEVICE,           NULL},
142     {"_SI_",    ACPI_TYPE_LOCAL_SCOPE,      NULL},
143     {"_TZ_",    ACPI_TYPE_DEVICE,           NULL},
144     {"_REV",    ACPI_TYPE_INTEGER,          (char *) ACPI_CA_SUPPORT_LEVEL},
145     {"_OS_",    ACPI_TYPE_STRING,           ACPI_OS_NAME},
146     {"_GL_",    ACPI_TYPE_MUTEX,            (char *) 1},
147 
148 #if !defined (ACPI_NO_METHOD_EXECUTION) || defined (ACPI_CONSTANT_EVAL_ONLY)
149     {"_OSI",    ACPI_TYPE_METHOD,           (char *) 1},
150 #endif
151 
152     /* Table terminator */
153 
154     {NULL,      ACPI_TYPE_ANY,              NULL}
155 };
156 
157 
158 /******************************************************************************
159  *
160  * Event and Hardware globals
161  *
162  ******************************************************************************/
163 
164 ACPI_BIT_REGISTER_INFO      AcpiGbl_BitRegisterInfo[ACPI_NUM_BITREG] =
165 {
166     /* Name                                     Parent Register             Register Bit Position                   Register Bit Mask       */
167 
168     /* ACPI_BITREG_TIMER_STATUS         */   {ACPI_REGISTER_PM1_STATUS,   ACPI_BITPOSITION_TIMER_STATUS,          ACPI_BITMASK_TIMER_STATUS},
169     /* ACPI_BITREG_BUS_MASTER_STATUS    */   {ACPI_REGISTER_PM1_STATUS,   ACPI_BITPOSITION_BUS_MASTER_STATUS,     ACPI_BITMASK_BUS_MASTER_STATUS},
170     /* ACPI_BITREG_GLOBAL_LOCK_STATUS   */   {ACPI_REGISTER_PM1_STATUS,   ACPI_BITPOSITION_GLOBAL_LOCK_STATUS,    ACPI_BITMASK_GLOBAL_LOCK_STATUS},
171     /* ACPI_BITREG_POWER_BUTTON_STATUS  */   {ACPI_REGISTER_PM1_STATUS,   ACPI_BITPOSITION_POWER_BUTTON_STATUS,   ACPI_BITMASK_POWER_BUTTON_STATUS},
172     /* ACPI_BITREG_SLEEP_BUTTON_STATUS  */   {ACPI_REGISTER_PM1_STATUS,   ACPI_BITPOSITION_SLEEP_BUTTON_STATUS,   ACPI_BITMASK_SLEEP_BUTTON_STATUS},
173     /* ACPI_BITREG_RT_CLOCK_STATUS      */   {ACPI_REGISTER_PM1_STATUS,   ACPI_BITPOSITION_RT_CLOCK_STATUS,       ACPI_BITMASK_RT_CLOCK_STATUS},
174     /* ACPI_BITREG_WAKE_STATUS          */   {ACPI_REGISTER_PM1_STATUS,   ACPI_BITPOSITION_WAKE_STATUS,           ACPI_BITMASK_WAKE_STATUS},
175     /* ACPI_BITREG_PCIEXP_WAKE_STATUS   */   {ACPI_REGISTER_PM1_STATUS,   ACPI_BITPOSITION_PCIEXP_WAKE_STATUS,    ACPI_BITMASK_PCIEXP_WAKE_STATUS},
176 
177     /* ACPI_BITREG_TIMER_ENABLE         */   {ACPI_REGISTER_PM1_ENABLE,   ACPI_BITPOSITION_TIMER_ENABLE,          ACPI_BITMASK_TIMER_ENABLE},
178     /* ACPI_BITREG_GLOBAL_LOCK_ENABLE   */   {ACPI_REGISTER_PM1_ENABLE,   ACPI_BITPOSITION_GLOBAL_LOCK_ENABLE,    ACPI_BITMASK_GLOBAL_LOCK_ENABLE},
179     /* ACPI_BITREG_POWER_BUTTON_ENABLE  */   {ACPI_REGISTER_PM1_ENABLE,   ACPI_BITPOSITION_POWER_BUTTON_ENABLE,   ACPI_BITMASK_POWER_BUTTON_ENABLE},
180     /* ACPI_BITREG_SLEEP_BUTTON_ENABLE  */   {ACPI_REGISTER_PM1_ENABLE,   ACPI_BITPOSITION_SLEEP_BUTTON_ENABLE,   ACPI_BITMASK_SLEEP_BUTTON_ENABLE},
181     /* ACPI_BITREG_RT_CLOCK_ENABLE      */   {ACPI_REGISTER_PM1_ENABLE,   ACPI_BITPOSITION_RT_CLOCK_ENABLE,       ACPI_BITMASK_RT_CLOCK_ENABLE},
182     /* ACPI_BITREG_PCIEXP_WAKE_DISABLE  */   {ACPI_REGISTER_PM1_ENABLE,   ACPI_BITPOSITION_PCIEXP_WAKE_DISABLE,   ACPI_BITMASK_PCIEXP_WAKE_DISABLE},
183 
184     /* ACPI_BITREG_SCI_ENABLE           */   {ACPI_REGISTER_PM1_CONTROL,  ACPI_BITPOSITION_SCI_ENABLE,            ACPI_BITMASK_SCI_ENABLE},
185     /* ACPI_BITREG_BUS_MASTER_RLD       */   {ACPI_REGISTER_PM1_CONTROL,  ACPI_BITPOSITION_BUS_MASTER_RLD,        ACPI_BITMASK_BUS_MASTER_RLD},
186     /* ACPI_BITREG_GLOBAL_LOCK_RELEASE  */   {ACPI_REGISTER_PM1_CONTROL,  ACPI_BITPOSITION_GLOBAL_LOCK_RELEASE,   ACPI_BITMASK_GLOBAL_LOCK_RELEASE},
187     /* ACPI_BITREG_SLEEP_TYPE           */   {ACPI_REGISTER_PM1_CONTROL,  ACPI_BITPOSITION_SLEEP_TYPE,            ACPI_BITMASK_SLEEP_TYPE},
188     /* ACPI_BITREG_SLEEP_ENABLE         */   {ACPI_REGISTER_PM1_CONTROL,  ACPI_BITPOSITION_SLEEP_ENABLE,          ACPI_BITMASK_SLEEP_ENABLE},
189 
190     /* ACPI_BITREG_ARB_DIS              */   {ACPI_REGISTER_PM2_CONTROL,  ACPI_BITPOSITION_ARB_DISABLE,           ACPI_BITMASK_ARB_DISABLE}
191 };
192 
193 
194 ACPI_FIXED_EVENT_INFO       AcpiGbl_FixedEventInfo[ACPI_NUM_FIXED_EVENTS] =
195 {
196     /* ACPI_EVENT_PMTIMER       */  {ACPI_BITREG_TIMER_STATUS,          ACPI_BITREG_TIMER_ENABLE,        ACPI_BITMASK_TIMER_STATUS,          ACPI_BITMASK_TIMER_ENABLE},
197     /* ACPI_EVENT_GLOBAL        */  {ACPI_BITREG_GLOBAL_LOCK_STATUS,    ACPI_BITREG_GLOBAL_LOCK_ENABLE,  ACPI_BITMASK_GLOBAL_LOCK_STATUS,    ACPI_BITMASK_GLOBAL_LOCK_ENABLE},
198     /* ACPI_EVENT_POWER_BUTTON  */  {ACPI_BITREG_POWER_BUTTON_STATUS,   ACPI_BITREG_POWER_BUTTON_ENABLE, ACPI_BITMASK_POWER_BUTTON_STATUS,   ACPI_BITMASK_POWER_BUTTON_ENABLE},
199     /* ACPI_EVENT_SLEEP_BUTTON  */  {ACPI_BITREG_SLEEP_BUTTON_STATUS,   ACPI_BITREG_SLEEP_BUTTON_ENABLE, ACPI_BITMASK_SLEEP_BUTTON_STATUS,   ACPI_BITMASK_SLEEP_BUTTON_ENABLE},
200     /* ACPI_EVENT_RTC           */  {ACPI_BITREG_RT_CLOCK_STATUS,       ACPI_BITREG_RT_CLOCK_ENABLE,     ACPI_BITMASK_RT_CLOCK_STATUS,       ACPI_BITMASK_RT_CLOCK_ENABLE},
201 };
202 
203 /*******************************************************************************
204  *
205  * FUNCTION:    AcpiUtInitGlobals
206  *
207  * PARAMETERS:  None
208  *
209  * RETURN:      Status
210  *
211  * DESCRIPTION: Init ACPICA globals.  All globals that require specific
212  *              initialization should be initialized here!
213  *
214  ******************************************************************************/
215 
216 ACPI_STATUS
217 AcpiUtInitGlobals (
218     void)
219 {
220     ACPI_STATUS             Status;
221     UINT32                  i;
222 
223 
224     ACPI_FUNCTION_TRACE (UtInitGlobals);
225 
226 
227     /* Create all memory caches */
228 
229     Status = AcpiUtCreateCaches ();
230     if (ACPI_FAILURE (Status))
231     {
232         return_ACPI_STATUS (Status);
233     }
234 
235     /* Mutex locked flags */
236 
237     for (i = 0; i < ACPI_NUM_MUTEX; i++)
238     {
239         AcpiGbl_MutexInfo[i].Mutex          = NULL;
240         AcpiGbl_MutexInfo[i].ThreadId       = ACPI_MUTEX_NOT_ACQUIRED;
241         AcpiGbl_MutexInfo[i].UseCount       = 0;
242     }
243 
244     for (i = 0; i < ACPI_NUM_OWNERID_MASKS; i++)
245     {
246         AcpiGbl_OwnerIdMask[i]              = 0;
247     }
248 
249     /* Last OwnerID is never valid */
250 
251     AcpiGbl_OwnerIdMask[ACPI_NUM_OWNERID_MASKS - 1] = 0x80000000;
252 
253     /* Event counters */
254 
255     AcpiMethodCount                     = 0;
256     AcpiSciCount                        = 0;
257     AcpiGpeCount                        = 0;
258 
259     for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++)
260     {
261         AcpiFixedEventCount[i]              = 0;
262     }
263 
264     /* GPE support */
265 
266     AcpiGbl_AllGpesInitialized          = FALSE;
267     AcpiGbl_GpeXruptListHead            = NULL;
268     AcpiGbl_GpeFadtBlocks[0]            = NULL;
269     AcpiGbl_GpeFadtBlocks[1]            = NULL;
270     AcpiCurrentGpeCount                 = 0;
271 
272     /* Global handlers */
273 
274     AcpiGbl_SystemNotify.Handler        = NULL;
275     AcpiGbl_DeviceNotify.Handler        = NULL;
276     AcpiGbl_ExceptionHandler            = NULL;
277     AcpiGbl_InitHandler                 = NULL;
278     AcpiGbl_TableHandler                = NULL;
279     AcpiGbl_InterfaceHandler            = NULL;
280     AcpiGbl_GlobalEventHandler          = NULL;
281 
282     /* Global Lock support */
283 
284     AcpiGbl_GlobalLockSemaphore         = NULL;
285     AcpiGbl_GlobalLockMutex             = NULL;
286     AcpiGbl_GlobalLockAcquired          = FALSE;
287     AcpiGbl_GlobalLockHandle            = 0;
288     AcpiGbl_GlobalLockPresent           = FALSE;
289 
290     /* Miscellaneous variables */
291 
292     AcpiGbl_DSDT                        = NULL;
293     AcpiGbl_CmSingleStep                = FALSE;
294     AcpiGbl_DbTerminateThreads          = FALSE;
295     AcpiGbl_Shutdown                    = FALSE;
296     AcpiGbl_NsLookupCount               = 0;
297     AcpiGbl_PsFindCount                 = 0;
298     AcpiGbl_AcpiHardwarePresent         = TRUE;
299     AcpiGbl_LastOwnerIdIndex            = 0;
300     AcpiGbl_NextOwnerIdOffset           = 0;
301     AcpiGbl_TraceMethodName             = 0;
302     AcpiGbl_TraceDbgLevel               = 0;
303     AcpiGbl_TraceDbgLayer               = 0;
304     AcpiGbl_DebuggerConfiguration       = DEBUGGER_THREADING;
305     AcpiGbl_DbOutputFlags               = ACPI_DB_CONSOLE_OUTPUT;
306     AcpiGbl_OsiData                     = 0;
307     AcpiGbl_OsiMutex                    = NULL;
308     AcpiGbl_RegMethodsExecuted          = FALSE;
309 
310     /* Hardware oriented */
311 
312     AcpiGbl_EventsInitialized           = FALSE;
313     AcpiGbl_SystemAwakeAndRunning       = TRUE;
314 
315     /* Namespace */
316 
317     AcpiGbl_ModuleCodeList              = NULL;
318     AcpiGbl_RootNode                    = NULL;
319     AcpiGbl_RootNodeStruct.Name.Integer = ACPI_ROOT_NAME;
320     AcpiGbl_RootNodeStruct.DescriptorType = ACPI_DESC_TYPE_NAMED;
321     AcpiGbl_RootNodeStruct.Type         = ACPI_TYPE_DEVICE;
322     AcpiGbl_RootNodeStruct.Parent       = NULL;
323     AcpiGbl_RootNodeStruct.Child        = NULL;
324     AcpiGbl_RootNodeStruct.Peer         = NULL;
325     AcpiGbl_RootNodeStruct.Object       = NULL;
326 
327 
328 #ifdef ACPI_DISASSEMBLER
329     AcpiGbl_ExternalList                = NULL;
330 #endif
331 
332 #ifdef ACPI_DEBUG_OUTPUT
333     AcpiGbl_LowestStackPointer          = ACPI_CAST_PTR (ACPI_SIZE, ACPI_SIZE_MAX);
334 #endif
335 
336 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
337     AcpiGbl_DisplayFinalMemStats        = FALSE;
338     AcpiGbl_DisableMemTracking          = FALSE;
339 #endif
340 
341     return_ACPI_STATUS (AE_OK);
342 }
343 
344 /* Public globals */
345 
346 ACPI_EXPORT_SYMBOL (AcpiGbl_FADT)
347 ACPI_EXPORT_SYMBOL (AcpiDbgLevel)
348 ACPI_EXPORT_SYMBOL (AcpiDbgLayer)
349 ACPI_EXPORT_SYMBOL (AcpiGpeCount)
350 ACPI_EXPORT_SYMBOL (AcpiCurrentGpeCount)
351