Back to home page

LXR

 
 

    


File indexing completed on 2025-05-11 08:24:03

0001 /******************************************************************************
0002  *
0003  * Module Name: nsload - namespace loading/expanding/contracting procedures
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 "acdispat.h"
0156 #include "actables.h"
0157 #include "acinterp.h"
0158 
0159 
0160 #define _COMPONENT          ACPI_NAMESPACE
0161         ACPI_MODULE_NAME    ("nsload")
0162 
0163 /* Local prototypes */
0164 
0165 #ifdef ACPI_FUTURE_IMPLEMENTATION
0166 ACPI_STATUS
0167 AcpiNsUnloadNamespace (
0168     ACPI_HANDLE             Handle);
0169 
0170 static ACPI_STATUS
0171 AcpiNsDeleteSubtree (
0172     ACPI_HANDLE             StartHandle);
0173 #endif
0174 
0175 
0176 /*******************************************************************************
0177  *
0178  * FUNCTION:    AcpiNsLoadTable
0179  *
0180  * PARAMETERS:  TableIndex      - Index for table to be loaded
0181  *              Node            - Owning NS node
0182  *
0183  * RETURN:      Status
0184  *
0185  * DESCRIPTION: Load one ACPI table into the namespace
0186  *
0187  ******************************************************************************/
0188 
0189 ACPI_STATUS
0190 AcpiNsLoadTable (
0191     UINT32                  TableIndex,
0192     ACPI_NAMESPACE_NODE     *Node)
0193 {
0194     ACPI_STATUS             Status;
0195 
0196 
0197     ACPI_FUNCTION_TRACE (NsLoadTable);
0198 
0199 
0200     /* If table already loaded into namespace, just return */
0201 
0202     if (AcpiTbIsTableLoaded (TableIndex))
0203     {
0204         Status = AE_ALREADY_EXISTS;
0205         goto Unlock;
0206     }
0207 
0208     ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
0209         "**** Loading table into namespace ****\n"));
0210 
0211     Status = AcpiTbAllocateOwnerId (TableIndex);
0212     if (ACPI_FAILURE (Status))
0213     {
0214         goto Unlock;
0215     }
0216 
0217     /*
0218      * Parse the table and load the namespace with all named
0219      * objects found within. Control methods are NOT parsed
0220      * at this time. In fact, the control methods cannot be
0221      * parsed until the entire namespace is loaded, because
0222      * if a control method makes a forward reference (call)
0223      * to another control method, we can't continue parsing
0224      * because we don't know how many arguments to parse next!
0225      */
0226     Status = AcpiNsParseTable (TableIndex, Node);
0227     if (ACPI_SUCCESS (Status))
0228     {
0229         AcpiTbSetTableLoadedFlag (TableIndex, TRUE);
0230     }
0231     else
0232     {
0233         /*
0234          * On error, delete any namespace objects created by this table.
0235          * We cannot initialize these objects, so delete them. There are
0236          * a couple of especially bad cases:
0237          * AE_ALREADY_EXISTS - namespace collision.
0238          * AE_NOT_FOUND - the target of a Scope operator does not
0239          * exist. This target of Scope must already exist in the
0240          * namespace, as per the ACPI specification.
0241          */
0242         AcpiNsDeleteNamespaceByOwner (
0243             AcpiGbl_RootTableList.Tables[TableIndex].OwnerId);
0244 
0245         AcpiTbReleaseOwnerId (TableIndex);
0246         return_ACPI_STATUS (Status);
0247     }
0248 
0249 Unlock:
0250     if (ACPI_FAILURE (Status))
0251     {
0252         return_ACPI_STATUS (Status);
0253     }
0254 
0255     /*
0256      * Now we can parse the control methods. We always parse
0257      * them here for a sanity check, and if configured for
0258      * just-in-time parsing, we delete the control method
0259      * parse trees.
0260      */
0261     ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
0262         "**** Begin Table Object Initialization\n"));
0263 
0264     AcpiExEnterInterpreter ();
0265     Status = AcpiDsInitializeObjects (TableIndex, Node);
0266     AcpiExExitInterpreter ();
0267 
0268     ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
0269         "**** Completed Table Object Initialization\n"));
0270 
0271     return_ACPI_STATUS (Status);
0272 }
0273 
0274 
0275 #ifdef ACPI_OBSOLETE_FUNCTIONS
0276 /*******************************************************************************
0277  *
0278  * FUNCTION:    AcpiLoadNamespace
0279  *
0280  * PARAMETERS:  None
0281  *
0282  * RETURN:      Status
0283  *
0284  * DESCRIPTION: Load the name space from what ever is pointed to by DSDT.
0285  *              (DSDT points to either the BIOS or a buffer.)
0286  *
0287  ******************************************************************************/
0288 
0289 ACPI_STATUS
0290 AcpiNsLoadNamespace (
0291     void)
0292 {
0293     ACPI_STATUS             Status;
0294 
0295 
0296     ACPI_FUNCTION_TRACE (AcpiLoadNameSpace);
0297 
0298 
0299     /* There must be at least a DSDT installed */
0300 
0301     if (AcpiGbl_DSDT == NULL)
0302     {
0303         ACPI_ERROR ((AE_INFO, "DSDT is not in memory"));
0304         return_ACPI_STATUS (AE_NO_ACPI_TABLES);
0305     }
0306 
0307     /*
0308      * Load the namespace. The DSDT is required,
0309      * but the SSDT and PSDT tables are optional.
0310      */
0311     Status = AcpiNsLoadTableByType (ACPI_TABLE_ID_DSDT);
0312     if (ACPI_FAILURE (Status))
0313     {
0314         return_ACPI_STATUS (Status);
0315     }
0316 
0317     /* Ignore exceptions from these */
0318 
0319     (void) AcpiNsLoadTableByType (ACPI_TABLE_ID_SSDT);
0320     (void) AcpiNsLoadTableByType (ACPI_TABLE_ID_PSDT);
0321 
0322     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INIT,
0323         "ACPI Namespace successfully loaded at root %p\n",
0324         AcpiGbl_RootNode));
0325 
0326     return_ACPI_STATUS (Status);
0327 }
0328 #endif
0329 
0330 #ifdef ACPI_FUTURE_IMPLEMENTATION
0331 /*******************************************************************************
0332  *
0333  * FUNCTION:    AcpiNsDeleteSubtree
0334  *
0335  * PARAMETERS:  StartHandle         - Handle in namespace where search begins
0336  *
0337  * RETURNS      Status
0338  *
0339  * DESCRIPTION: Walks the namespace starting at the given handle and deletes
0340  *              all objects, entries, and scopes in the entire subtree.
0341  *
0342  *              Namespace/Interpreter should be locked or the subsystem should
0343  *              be in shutdown before this routine is called.
0344  *
0345  ******************************************************************************/
0346 
0347 static ACPI_STATUS
0348 AcpiNsDeleteSubtree (
0349     ACPI_HANDLE             StartHandle)
0350 {
0351     ACPI_STATUS             Status;
0352     ACPI_HANDLE             ChildHandle;
0353     ACPI_HANDLE             ParentHandle;
0354     ACPI_HANDLE             NextChildHandle;
0355     ACPI_HANDLE             Dummy;
0356     UINT32                  Level;
0357 
0358 
0359     ACPI_FUNCTION_TRACE (NsDeleteSubtree);
0360 
0361 
0362     ParentHandle = StartHandle;
0363     ChildHandle = NULL;
0364     Level = 1;
0365 
0366     /*
0367      * Traverse the tree of objects until we bubble back up
0368      * to where we started.
0369      */
0370     while (Level > 0)
0371     {
0372         /* Attempt to get the next object in this scope */
0373 
0374         Status = AcpiGetNextObject (ACPI_TYPE_ANY, ParentHandle,
0375             ChildHandle, &NextChildHandle);
0376 
0377         ChildHandle = NextChildHandle;
0378 
0379         /* Did we get a new object? */
0380 
0381         if (ACPI_SUCCESS (Status))
0382         {
0383             /* Check if this object has any children */
0384 
0385             if (ACPI_SUCCESS (AcpiGetNextObject (ACPI_TYPE_ANY, ChildHandle,
0386                 NULL, &Dummy)))
0387             {
0388                 /*
0389                  * There is at least one child of this object,
0390                  * visit the object
0391                  */
0392                 Level++;
0393                 ParentHandle = ChildHandle;
0394                 ChildHandle  = NULL;
0395             }
0396         }
0397         else
0398         {
0399             /*
0400              * No more children in this object, go back up to
0401              * the object's parent
0402              */
0403             Level--;
0404 
0405             /* Delete all children now */
0406 
0407             AcpiNsDeleteChildren (ChildHandle);
0408 
0409             ChildHandle = ParentHandle;
0410             Status = AcpiGetParent (ParentHandle, &ParentHandle);
0411             if (ACPI_FAILURE (Status))
0412             {
0413                 return_ACPI_STATUS (Status);
0414             }
0415         }
0416     }
0417 
0418     /* Now delete the starting object, and we are done */
0419 
0420     AcpiNsRemoveNode (ChildHandle);
0421     return_ACPI_STATUS (AE_OK);
0422 }
0423 
0424 
0425 /*******************************************************************************
0426  *
0427  *  FUNCTION:       AcpiNsUnloadNameSpace
0428  *
0429  *  PARAMETERS:     Handle          - Root of namespace subtree to be deleted
0430  *
0431  *  RETURN:         Status
0432  *
0433  *  DESCRIPTION:    Shrinks the namespace, typically in response to an undocking
0434  *                  event. Deletes an entire subtree starting from (and
0435  *                  including) the given handle.
0436  *
0437  ******************************************************************************/
0438 
0439 ACPI_STATUS
0440 AcpiNsUnloadNamespace (
0441     ACPI_HANDLE             Handle)
0442 {
0443     ACPI_STATUS             Status;
0444 
0445 
0446     ACPI_FUNCTION_TRACE (NsUnloadNameSpace);
0447 
0448 
0449     /* Parameter validation */
0450 
0451     if (!AcpiGbl_RootNode)
0452     {
0453         return_ACPI_STATUS (AE_NO_NAMESPACE);
0454     }
0455 
0456     if (!Handle)
0457     {
0458         return_ACPI_STATUS (AE_BAD_PARAMETER);
0459     }
0460 
0461     /* This function does the real work */
0462 
0463     Status = AcpiNsDeleteSubtree (Handle);
0464     return_ACPI_STATUS (Status);
0465 }
0466 #endif