acpica/utilities/utinit.c

0001 /******************************************************************************
0002  *
0003  * Module Name: utinit - Common ACPI subsystem initialization
0004  *
0005  *****************************************************************************/
0006
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights. You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code. No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision. In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change. Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee. Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution. In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government. In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************
0115  *
0116  * Alternatively, you may choose to be licensed under the terms of the
0117  * following license:
0118  *
0119  * Redistribution and use in source and binary forms, with or without
0120  * modification, are permitted provided that the following conditions
0121  * are met:
0122  * 1. Redistributions of source code must retain the above copyright
0123  *    notice, this list of conditions, and the following disclaimer,
0124  *    without modification.
0125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0126  *    substantially similar to the "NO WARRANTY" disclaimer below
0127  *    ("Disclaimer") and any redistribution must be conditioned upon
0128  *    including a substantially similar Disclaimer requirement for further
0129  *    binary redistribution.
0130  * 3. Neither the names of the above-listed copyright holders nor the names
0131  *    of any contributors may be used to endorse or promote products derived
0132  *    from this software without specific prior written permission.
0133  *
0134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0145  *
0146  * Alternatively, you may choose to be licensed under the terms of the
0147  * GNU General Public License ("GPL") version 2 as published by the Free
0148  * Software Foundation.
0149  *
0150  *****************************************************************************/
0151
0152 #include "acpi.h"
0153 #include "accommon.h"
0154 #include "acnamesp.h"
0155 #include "acevents.h"
0156 #include "actables.h"
0157
0158 #define _COMPONENT          ACPI_UTILITIES
0159         ACPI_MODULE_NAME    ("utinit")
0160
0161 /* Local prototypes */
0162
0163 static void AcpiUtTerminate (
0164     void);
0165
0166 #if (!ACPI_REDUCED_HARDWARE)
0167
0168 static void
0169 AcpiUtFreeGpeLists (
0170     void);
0171
0172 #else
0173
0174 #define AcpiUtFreeGpeLists()
0175 #endif /* !ACPI_REDUCED_HARDWARE */
0176
0177
0178 #if (!ACPI_REDUCED_HARDWARE)
0179 /******************************************************************************
0180  *
0181  * FUNCTION:    AcpiUtFreeGpeLists
0182  *
0183  * PARAMETERS:  none
0184  *
0185  * RETURN:      none
0186  *
0187  * DESCRIPTION: Free global GPE lists
0188  *
0189  ******************************************************************************/
0190
0191 static void
0192 AcpiUtFreeGpeLists (
0193     void)
0194 {
0195     ACPI_GPE_BLOCK_INFO     *GpeBlock;
0196     ACPI_GPE_BLOCK_INFO     *NextGpeBlock;
0197     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo;
0198     ACPI_GPE_XRUPT_INFO     *NextGpeXruptInfo;
0199
0200
0201     /* Free global GPE blocks and related info structures */
0202
0203     GpeXruptInfo = AcpiGbl_GpeXruptListHead;
0204     while (GpeXruptInfo)
0205     {
0206         GpeBlock = GpeXruptInfo->GpeBlockListHead;
0207         while (GpeBlock)
0208         {
0209             NextGpeBlock = GpeBlock->Next;
0210             ACPI_FREE (GpeBlock->EventInfo);
0211             ACPI_FREE (GpeBlock->RegisterInfo);
0212             ACPI_FREE (GpeBlock);
0213
0214             GpeBlock = NextGpeBlock;
0215         }
0216         NextGpeXruptInfo = GpeXruptInfo->Next;
0217         ACPI_FREE (GpeXruptInfo);
0218         GpeXruptInfo = NextGpeXruptInfo;
0219     }
0220 }
0221 #endif /* !ACPI_REDUCED_HARDWARE */
0222
0223
0224 /*******************************************************************************
0225  *
0226  * FUNCTION:    AcpiUtInitGlobals
0227  *
0228  * PARAMETERS:  None
0229  *
0230  * RETURN:      Status
0231  *
0232  * DESCRIPTION: Initialize ACPICA globals. All globals that require specific
0233  *              initialization should be initialized here. This allows for
0234  *              a warm restart.
0235  *
0236  ******************************************************************************/
0237
0238 ACPI_STATUS
0239 AcpiUtInitGlobals (
0240     void)
0241 {
0242     ACPI_STATUS             Status;
0243     UINT32                  i;
0244
0245
0246     ACPI_FUNCTION_TRACE (UtInitGlobals);
0247
0248
0249     /* Create all memory caches */
0250
0251     Status = AcpiUtCreateCaches ();
0252     if (ACPI_FAILURE (Status))
0253     {
0254         return_ACPI_STATUS (Status);
0255     }
0256
0257     /* Address Range lists */
0258
0259     for (i = 0; i < ACPI_ADDRESS_RANGE_MAX; i++)
0260     {
0261         AcpiGbl_AddressRangeList[i] = NULL;
0262     }
0263
0264     /* Mutex locked flags */
0265
0266     for (i = 0; i < ACPI_NUM_MUTEX; i++)
0267     {
0268         AcpiGbl_MutexInfo[i].Mutex          = NULL;
0269         AcpiGbl_MutexInfo[i].ThreadId       = ACPI_MUTEX_NOT_ACQUIRED;
0270         AcpiGbl_MutexInfo[i].UseCount       = 0;
0271     }
0272
0273     for (i = 0; i < ACPI_NUM_OWNERID_MASKS; i++)
0274     {
0275         AcpiGbl_OwnerIdMask[i]              = 0;
0276     }
0277
0278     /* Last OwnerID is never valid */
0279
0280     AcpiGbl_OwnerIdMask[ACPI_NUM_OWNERID_MASKS - 1] = 0x80000000;
0281
0282     /* Event counters */
0283
0284     AcpiMethodCount                     = 0;
0285     AcpiSciCount                        = 0;
0286     AcpiGpeCount                        = 0;
0287
0288     for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++)
0289     {
0290         AcpiFixedEventCount[i]              = 0;
0291     }
0292
0293 #if (!ACPI_REDUCED_HARDWARE)
0294
0295     /* GPE/SCI support */
0296
0297     AcpiGbl_AllGpesInitialized          = FALSE;
0298     AcpiGbl_GpeXruptListHead            = NULL;
0299     AcpiGbl_GpeFadtBlocks[0]            = NULL;
0300     AcpiGbl_GpeFadtBlocks[1]            = NULL;
0301     AcpiCurrentGpeCount                 = 0;
0302
0303     AcpiGbl_GlobalEventHandler          = NULL;
0304     AcpiGbl_SciHandlerList              = NULL;
0305
0306 #endif /* !ACPI_REDUCED_HARDWARE */
0307
0308     /* Global handlers */
0309
0310     AcpiGbl_GlobalNotify[0].Handler     = NULL;
0311     AcpiGbl_GlobalNotify[1].Handler     = NULL;
0312     AcpiGbl_ExceptionHandler            = NULL;
0313     AcpiGbl_InitHandler                 = NULL;
0314     AcpiGbl_TableHandler                = NULL;
0315     AcpiGbl_InterfaceHandler            = NULL;
0316
0317     /* Global Lock support */
0318
0319     AcpiGbl_GlobalLockSemaphore         = ACPI_SEMAPHORE_NULL;
0320     AcpiGbl_GlobalLockMutex             = NULL;
0321     AcpiGbl_GlobalLockAcquired          = FALSE;
0322     AcpiGbl_GlobalLockHandle            = 0;
0323     AcpiGbl_GlobalLockPresent           = FALSE;
0324
0325     /* Miscellaneous variables */
0326
0327     AcpiGbl_DSDT                        = NULL;
0328     AcpiGbl_CmSingleStep                = FALSE;
0329     AcpiGbl_Shutdown                    = FALSE;
0330     AcpiGbl_NsLookupCount               = 0;
0331     AcpiGbl_PsFindCount                 = 0;
0332     AcpiGbl_AcpiHardwarePresent         = TRUE;
0333     AcpiGbl_LastOwnerIdIndex            = 0;
0334     AcpiGbl_NextOwnerIdOffset           = 0;
0335     AcpiGbl_DebuggerConfiguration       = DEBUGGER_THREADING;
0336     AcpiGbl_OsiMutex                    = NULL;
0337
0338     /* Hardware oriented */
0339
0340     AcpiGbl_EventsInitialized           = FALSE;
0341     AcpiGbl_SystemAwakeAndRunning       = TRUE;
0342
0343     /* Namespace */
0344
0345     AcpiGbl_RootNode                    = NULL;
0346     AcpiGbl_RootNodeStruct.Name.Integer = ACPI_ROOT_NAME;
0347     AcpiGbl_RootNodeStruct.DescriptorType = ACPI_DESC_TYPE_NAMED;
0348     AcpiGbl_RootNodeStruct.Type         = ACPI_TYPE_DEVICE;
0349     AcpiGbl_RootNodeStruct.Parent       = NULL;
0350     AcpiGbl_RootNodeStruct.Child        = NULL;
0351     AcpiGbl_RootNodeStruct.Peer         = NULL;
0352     AcpiGbl_RootNodeStruct.Object       = NULL;
0353
0354
0355 #ifdef ACPI_DISASSEMBLER
0356     AcpiGbl_ExternalList                = NULL;
0357     AcpiGbl_NumExternalMethods          = 0;
0358     AcpiGbl_ResolvedExternalMethods     = 0;
0359 #endif
0360
0361 #ifdef ACPI_DEBUG_OUTPUT
0362     AcpiGbl_LowestStackPointer          = ACPI_CAST_PTR (ACPI_SIZE, ACPI_SIZE_MAX);
0363 #endif
0364
0365 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
0366     AcpiGbl_DisplayFinalMemStats        = FALSE;
0367     AcpiGbl_DisableMemTracking          = FALSE;
0368 #endif
0369
0370     return_ACPI_STATUS (AE_OK);
0371 }
0372
0373
0374 /******************************************************************************
0375  *
0376  * FUNCTION:    AcpiUtTerminate
0377  *
0378  * PARAMETERS:  none
0379  *
0380  * RETURN:      none
0381  *
0382  * DESCRIPTION: Free global memory
0383  *
0384  ******************************************************************************/
0385
0386 static void
0387 AcpiUtTerminate (
0388     void)
0389 {
0390     ACPI_FUNCTION_TRACE (UtTerminate);
0391
0392     AcpiUtFreeGpeLists ();
0393     AcpiUtDeleteAddressLists ();
0394     return_VOID;
0395 }
0396
0397
0398 /*******************************************************************************
0399  *
0400  * FUNCTION:    AcpiUtSubsystemShutdown
0401  *
0402  * PARAMETERS:  None
0403  *
0404  * RETURN:      None
0405  *
0406  * DESCRIPTION: Shutdown the various components. Do not delete the mutex
0407  *              objects here, because the AML debugger may be still running.
0408  *
0409  ******************************************************************************/
0410
0411 void
0412 AcpiUtSubsystemShutdown (
0413     void)
0414 {
0415     ACPI_FUNCTION_TRACE (UtSubsystemShutdown);
0416
0417
0418     /* Just exit if subsystem is already shutdown */
0419
0420     if (AcpiGbl_Shutdown)
0421     {
0422         ACPI_ERROR ((AE_INFO, "ACPI Subsystem is already terminated"));
0423         return_VOID;
0424     }
0425
0426     /* Subsystem appears active, go ahead and shut it down */
0427
0428     AcpiGbl_Shutdown = TRUE;
0429     AcpiGbl_StartupFlags = 0;
0430     ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Shutting down ACPI Subsystem\n"));
0431
0432 #ifndef ACPI_ASL_COMPILER
0433
0434     /* Close the AcpiEvent Handling */
0435
0436     AcpiEvTerminate ();
0437
0438     /* Delete any dynamic _OSI interfaces */
0439
0440     AcpiUtInterfaceTerminate ();
0441 #endif
0442
0443     /* Close the Namespace */
0444
0445     AcpiNsTerminate ();
0446
0447     /* Delete the ACPI tables */
0448
0449     AcpiTbTerminate ();
0450
0451     /* Close the globals */
0452
0453     AcpiUtTerminate ();
0454
0455     /* Purge the local caches */
0456
0457     (void) AcpiUtDeleteCaches ();
0458     return_VOID;
0459 }