xref: /freebsd/sys/contrib/dev/acpica/components/utilities/utinit.c (revision cab6a39d7b343596a5823e65c0f7b426551ec22d)
1 /******************************************************************************
2  *
3  * Module Name: utinit - Common ACPI subsystem initialization
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2021, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
16  * 2.1. This is your license from Intel Corp. under its intellectual property
17  * rights. You may have additional license terms from the party that provided
18  * you this software, covering your right to use that party's intellectual
19  * property rights.
20  *
21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22  * copy of the source code appearing in this file ("Covered Code") an
23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24  * base code distributed originally by Intel ("Original Intel Code") to copy,
25  * make derivatives, distribute, use and display any portion of the Covered
26  * Code in any form, with the right to sublicense such rights; and
27  *
28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29  * license (with the right to sublicense), under only those claims of Intel
30  * patents that are infringed by the Original Intel Code, to make, use, sell,
31  * offer to sell, and import the Covered Code and derivative works thereof
32  * solely to the minimum extent necessary to exercise the above copyright
33  * license, and in no event shall the patent license extend to any additions
34  * to or modifications of the Original Intel Code. No other license or right
35  * is granted directly or by implication, estoppel or otherwise;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43  * Redistribution of source code of any substantial portion of the Covered
44  * Code or modification with rights to further distribute source must include
45  * the above Copyright Notice, the above License, this list of Conditions,
46  * and the following Disclaimer and Export Compliance provision. In addition,
47  * Licensee must cause all Covered Code to which Licensee contributes to
48  * contain a file documenting the changes Licensee made to create that Covered
49  * Code and the date of any change. Licensee must include in that file the
50  * documentation of any changes made by any predecessor Licensee. Licensee
51  * must include a prominent statement that the modification is derived,
52  * directly or indirectly, from Original Intel Code.
53  *
54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55  * Redistribution of source code of any substantial portion of the Covered
56  * Code or modification without rights to further distribute source must
57  * include the following Disclaimer and Export Compliance provision in the
58  * documentation and/or other materials provided with distribution. In
59  * addition, Licensee may not authorize further sublicense of source of any
60  * portion of the Covered Code, and must include terms to the effect that the
61  * license from Licensee to its licensee is limited to the intellectual
62  * property embodied in the software Licensee provides to its licensee, and
63  * not to intellectual property embodied in modifications its licensee may
64  * make.
65  *
66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67  * substantial portion of the Covered Code or modification must reproduce the
68  * above Copyright Notice, and the following Disclaimer and Export Compliance
69  * provision in the documentation and/or other materials provided with the
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76  * Intel shall be used in advertising or otherwise to promote the sale, use or
77  * other dealings in products derived from or relating to the Covered Code
78  * without prior written authorization from Intel.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88  * PARTICULAR PURPOSE.
89  *
90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97  * LIMITED REMEDY.
98  *
99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100  * software or system incorporating such software without first obtaining any
101  * required license or other approval from the U. S. Department of Commerce or
102  * any other agency or department of the United States Government. In the
103  * event Licensee exports any such software from the United States or
104  * re-exports any such software from a foreign destination, Licensee shall
105  * ensure that the distribution and export/re-export of the software is in
106  * compliance with all laws, regulations, orders, or other restrictions of the
107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108  * any of its subsidiaries will export/re-export any technical data, process,
109  * software, or service, directly or indirectly, to any country for which the
110  * United States government or any agency thereof requires an export license,
111  * other governmental approval, or letter of assurance, without first obtaining
112  * such license, approval or letter.
113  *
114  *****************************************************************************
115  *
116  * Alternatively, you may choose to be licensed under the terms of the
117  * following license:
118  *
119  * Redistribution and use in source and binary forms, with or without
120  * modification, are permitted provided that the following conditions
121  * are met:
122  * 1. Redistributions of source code must retain the above copyright
123  *    notice, this list of conditions, and the following disclaimer,
124  *    without modification.
125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126  *    substantially similar to the "NO WARRANTY" disclaimer below
127  *    ("Disclaimer") and any redistribution must be conditioned upon
128  *    including a substantially similar Disclaimer requirement for further
129  *    binary redistribution.
130  * 3. Neither the names of the above-listed copyright holders nor the names
131  *    of any contributors may be used to endorse or promote products derived
132  *    from this software without specific prior written permission.
133  *
134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145  *
146  * Alternatively, you may choose to be licensed under the terms of the
147  * GNU General Public License ("GPL") version 2 as published by the Free
148  * Software Foundation.
149  *
150  *****************************************************************************/
151 
152 #include <contrib/dev/acpica/include/acpi.h>
153 #include <contrib/dev/acpica/include/accommon.h>
154 #include <contrib/dev/acpica/include/acnamesp.h>
155 #include <contrib/dev/acpica/include/acevents.h>
156 #include <contrib/dev/acpica/include/actables.h>
157 
158 #define _COMPONENT          ACPI_UTILITIES
159         ACPI_MODULE_NAME    ("utinit")
160 
161 /* Local prototypes */
162 
163 static void AcpiUtTerminate (
164     void);
165 
166 #if (!ACPI_REDUCED_HARDWARE)
167 
168 static void
169 AcpiUtFreeGpeLists (
170     void);
171 
172 #else
173 
174 #define AcpiUtFreeGpeLists()
175 #endif /* !ACPI_REDUCED_HARDWARE */
176 
177 
178 #if (!ACPI_REDUCED_HARDWARE)
179 /******************************************************************************
180  *
181  * FUNCTION:    AcpiUtFreeGpeLists
182  *
183  * PARAMETERS:  none
184  *
185  * RETURN:      none
186  *
187  * DESCRIPTION: Free global GPE lists
188  *
189  ******************************************************************************/
190 
191 static void
192 AcpiUtFreeGpeLists (
193     void)
194 {
195     ACPI_GPE_BLOCK_INFO     *GpeBlock;
196     ACPI_GPE_BLOCK_INFO     *NextGpeBlock;
197     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo;
198     ACPI_GPE_XRUPT_INFO     *NextGpeXruptInfo;
199 
200 
201     /* Free global GPE blocks and related info structures */
202 
203     GpeXruptInfo = AcpiGbl_GpeXruptListHead;
204     while (GpeXruptInfo)
205     {
206         GpeBlock = GpeXruptInfo->GpeBlockListHead;
207         while (GpeBlock)
208         {
209             NextGpeBlock = GpeBlock->Next;
210             ACPI_FREE (GpeBlock->EventInfo);
211             ACPI_FREE (GpeBlock->RegisterInfo);
212             ACPI_FREE (GpeBlock);
213 
214             GpeBlock = NextGpeBlock;
215         }
216         NextGpeXruptInfo = GpeXruptInfo->Next;
217         ACPI_FREE (GpeXruptInfo);
218         GpeXruptInfo = NextGpeXruptInfo;
219     }
220 }
221 #endif /* !ACPI_REDUCED_HARDWARE */
222 
223 
224 /*******************************************************************************
225  *
226  * FUNCTION:    AcpiUtInitGlobals
227  *
228  * PARAMETERS:  None
229  *
230  * RETURN:      Status
231  *
232  * DESCRIPTION: Initialize ACPICA globals. All globals that require specific
233  *              initialization should be initialized here. This allows for
234  *              a warm restart.
235  *
236  ******************************************************************************/
237 
238 ACPI_STATUS
239 AcpiUtInitGlobals (
240     void)
241 {
242     ACPI_STATUS             Status;
243     UINT32                  i;
244 
245 
246     ACPI_FUNCTION_TRACE (UtInitGlobals);
247 
248 
249     /* Create all memory caches */
250 
251     Status = AcpiUtCreateCaches ();
252     if (ACPI_FAILURE (Status))
253     {
254         return_ACPI_STATUS (Status);
255     }
256 
257     /* Address Range lists */
258 
259     for (i = 0; i < ACPI_ADDRESS_RANGE_MAX; i++)
260     {
261         AcpiGbl_AddressRangeList[i] = NULL;
262     }
263 
264     /* Mutex locked flags */
265 
266     for (i = 0; i < ACPI_NUM_MUTEX; i++)
267     {
268         AcpiGbl_MutexInfo[i].Mutex          = NULL;
269         AcpiGbl_MutexInfo[i].ThreadId       = ACPI_MUTEX_NOT_ACQUIRED;
270         AcpiGbl_MutexInfo[i].UseCount       = 0;
271     }
272 
273     for (i = 0; i < ACPI_NUM_OWNERID_MASKS; i++)
274     {
275         AcpiGbl_OwnerIdMask[i]              = 0;
276     }
277 
278     /* Last OwnerID is never valid */
279 
280     AcpiGbl_OwnerIdMask[ACPI_NUM_OWNERID_MASKS - 1] = 0x80000000;
281 
282     /* Event counters */
283 
284     AcpiMethodCount                     = 0;
285     AcpiSciCount                        = 0;
286     AcpiGpeCount                        = 0;
287 
288     for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++)
289     {
290         AcpiFixedEventCount[i]              = 0;
291     }
292 
293 #if (!ACPI_REDUCED_HARDWARE)
294 
295     /* GPE/SCI support */
296 
297     AcpiGbl_AllGpesInitialized          = FALSE;
298     AcpiGbl_GpeXruptListHead            = NULL;
299     AcpiGbl_GpeFadtBlocks[0]            = NULL;
300     AcpiGbl_GpeFadtBlocks[1]            = NULL;
301     AcpiCurrentGpeCount                 = 0;
302 
303     AcpiGbl_GlobalEventHandler          = NULL;
304     AcpiGbl_SciHandlerList              = NULL;
305 
306 #endif /* !ACPI_REDUCED_HARDWARE */
307 
308     /* Global handlers */
309 
310     AcpiGbl_GlobalNotify[0].Handler     = NULL;
311     AcpiGbl_GlobalNotify[1].Handler     = NULL;
312     AcpiGbl_ExceptionHandler            = NULL;
313     AcpiGbl_InitHandler                 = NULL;
314     AcpiGbl_TableHandler                = NULL;
315     AcpiGbl_InterfaceHandler            = NULL;
316 
317     /* Global Lock support */
318 
319     AcpiGbl_GlobalLockSemaphore         = NULL;
320     AcpiGbl_GlobalLockMutex             = NULL;
321     AcpiGbl_GlobalLockAcquired          = FALSE;
322     AcpiGbl_GlobalLockHandle            = 0;
323     AcpiGbl_GlobalLockPresent           = FALSE;
324 
325     /* Miscellaneous variables */
326 
327     AcpiGbl_DSDT                        = NULL;
328     AcpiGbl_CmSingleStep                = FALSE;
329     AcpiGbl_Shutdown                    = FALSE;
330     AcpiGbl_NsLookupCount               = 0;
331     AcpiGbl_PsFindCount                 = 0;
332     AcpiGbl_AcpiHardwarePresent         = TRUE;
333     AcpiGbl_LastOwnerIdIndex            = 0;
334     AcpiGbl_NextOwnerIdOffset           = 0;
335     AcpiGbl_DebuggerConfiguration       = DEBUGGER_THREADING;
336     AcpiGbl_OsiMutex                    = NULL;
337 
338     /* Hardware oriented */
339 
340     AcpiGbl_EventsInitialized           = FALSE;
341     AcpiGbl_SystemAwakeAndRunning       = TRUE;
342 
343     /* Namespace */
344 
345     AcpiGbl_RootNode                    = NULL;
346     AcpiGbl_RootNodeStruct.Name.Integer = ACPI_ROOT_NAME;
347     AcpiGbl_RootNodeStruct.DescriptorType = ACPI_DESC_TYPE_NAMED;
348     AcpiGbl_RootNodeStruct.Type         = ACPI_TYPE_DEVICE;
349     AcpiGbl_RootNodeStruct.Parent       = NULL;
350     AcpiGbl_RootNodeStruct.Child        = NULL;
351     AcpiGbl_RootNodeStruct.Peer         = NULL;
352     AcpiGbl_RootNodeStruct.Object       = NULL;
353 
354 
355 #ifdef ACPI_DISASSEMBLER
356     AcpiGbl_ExternalList                = NULL;
357     AcpiGbl_NumExternalMethods          = 0;
358     AcpiGbl_ResolvedExternalMethods     = 0;
359 #endif
360 
361 #ifdef ACPI_DEBUG_OUTPUT
362     AcpiGbl_LowestStackPointer          = ACPI_CAST_PTR (ACPI_SIZE, ACPI_SIZE_MAX);
363 #endif
364 
365 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
366     AcpiGbl_DisplayFinalMemStats        = FALSE;
367     AcpiGbl_DisableMemTracking          = FALSE;
368 #endif
369 
370     return_ACPI_STATUS (AE_OK);
371 }
372 
373 
374 /******************************************************************************
375  *
376  * FUNCTION:    AcpiUtTerminate
377  *
378  * PARAMETERS:  none
379  *
380  * RETURN:      none
381  *
382  * DESCRIPTION: Free global memory
383  *
384  ******************************************************************************/
385 
386 static void
387 AcpiUtTerminate (
388     void)
389 {
390     ACPI_FUNCTION_TRACE (UtTerminate);
391 
392     AcpiUtFreeGpeLists ();
393     AcpiUtDeleteAddressLists ();
394     return_VOID;
395 }
396 
397 
398 /*******************************************************************************
399  *
400  * FUNCTION:    AcpiUtSubsystemShutdown
401  *
402  * PARAMETERS:  None
403  *
404  * RETURN:      None
405  *
406  * DESCRIPTION: Shutdown the various components. Do not delete the mutex
407  *              objects here, because the AML debugger may be still running.
408  *
409  ******************************************************************************/
410 
411 void
412 AcpiUtSubsystemShutdown (
413     void)
414 {
415     ACPI_FUNCTION_TRACE (UtSubsystemShutdown);
416 
417 
418     /* Just exit if subsystem is already shutdown */
419 
420     if (AcpiGbl_Shutdown)
421     {
422         ACPI_ERROR ((AE_INFO, "ACPI Subsystem is already terminated"));
423         return_VOID;
424     }
425 
426     /* Subsystem appears active, go ahead and shut it down */
427 
428     AcpiGbl_Shutdown = TRUE;
429     AcpiGbl_StartupFlags = 0;
430     ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Shutting down ACPI Subsystem\n"));
431 
432 #ifndef ACPI_ASL_COMPILER
433 
434     /* Close the AcpiEvent Handling */
435 
436     AcpiEvTerminate ();
437 
438     /* Delete any dynamic _OSI interfaces */
439 
440     AcpiUtInterfaceTerminate ();
441 #endif
442 
443     /* Close the Namespace */
444 
445     AcpiNsTerminate ();
446 
447     /* Delete the ACPI tables */
448 
449     AcpiTbTerminate ();
450 
451     /* Close the globals */
452 
453     AcpiUtTerminate ();
454 
455     /* Purge the local caches */
456 
457     (void) AcpiUtDeleteCaches ();
458     return_VOID;
459 }
460