acpica/namespace/nsparse.c

0001 /******************************************************************************
0002  *
0003  * Module Name: nsparse - namespace interface to AML parser
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 "acparser.h"
0156 #include "acdispat.h"
0157 #include "actables.h"
0158 #include "acinterp.h"
0159
0160
0161 #define _COMPONENT          ACPI_NAMESPACE
0162         ACPI_MODULE_NAME    ("nsparse")
0163
0164
0165 /*******************************************************************************
0166  *
0167  * FUNCTION:    NsExecuteTable
0168  *
0169  * PARAMETERS:  TableDesc       - An ACPI table descriptor for table to parse
0170  *              StartNode       - Where to enter the table into the namespace
0171  *
0172  * RETURN:      Status
0173  *
0174  * DESCRIPTION: Load ACPI/AML table by executing the entire table as a single
0175  *              large control method.
0176  *
0177  * NOTE: The point of this is to execute any module-level code in-place
0178  * as the table is parsed. Some AML code depends on this behavior.
0179  *
0180  * It is a run-time option at this time, but will eventually become
0181  * the default.
0182  *
0183  * Note: This causes the table to only have a single-pass parse.
0184  * However, this is compatible with other ACPI implementations.
0185  *
0186  ******************************************************************************/
0187
0188 ACPI_STATUS
0189 AcpiNsExecuteTable (
0190     UINT32                  TableIndex,
0191     ACPI_NAMESPACE_NODE     *StartNode)
0192 {
0193     ACPI_STATUS             Status;
0194     ACPI_TABLE_HEADER       *Table;
0195     ACPI_OWNER_ID           OwnerId;
0196     ACPI_EVALUATE_INFO      *Info = NULL;
0197     UINT32                  AmlLength;
0198     UINT8                   *AmlStart;
0199     ACPI_OPERAND_OBJECT     *MethodObj = NULL;
0200
0201
0202     ACPI_FUNCTION_TRACE (NsExecuteTable);
0203
0204
0205     Status = AcpiGetTableByIndex (TableIndex, &Table);
0206     if (ACPI_FAILURE (Status))
0207     {
0208         return_ACPI_STATUS (Status);
0209     }
0210
0211     /* Table must consist of at least a complete header */
0212
0213     if (Table->Length < sizeof (ACPI_TABLE_HEADER))
0214     {
0215         return_ACPI_STATUS (AE_BAD_HEADER);
0216     }
0217
0218     AmlStart = (UINT8 *) Table + sizeof (ACPI_TABLE_HEADER);
0219     AmlLength = Table->Length - sizeof (ACPI_TABLE_HEADER);
0220
0221     Status = AcpiTbGetOwnerId (TableIndex, &OwnerId);
0222     if (ACPI_FAILURE (Status))
0223     {
0224         return_ACPI_STATUS (Status);
0225     }
0226
0227     /* Create, initialize, and link a new temporary method object */
0228
0229     MethodObj = AcpiUtCreateInternalObject (ACPI_TYPE_METHOD);
0230     if (!MethodObj)
0231     {
0232         return_ACPI_STATUS (AE_NO_MEMORY);
0233     }
0234
0235     /* Allocate the evaluation information block */
0236
0237     Info = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_EVALUATE_INFO));
0238     if (!Info)
0239     {
0240         Status = AE_NO_MEMORY;
0241         goto Cleanup;
0242     }
0243
0244     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_PARSE,
0245         "%s: Create table pseudo-method for [%4.4s] @%p, method %p\n",
0246         ACPI_GET_FUNCTION_NAME, Table->Signature, Table, MethodObj));
0247
0248     MethodObj->Method.AmlStart = AmlStart;
0249     MethodObj->Method.AmlLength = AmlLength;
0250     MethodObj->Method.OwnerId = OwnerId;
0251     MethodObj->Method.InfoFlags |= ACPI_METHOD_MODULE_LEVEL;
0252
0253     Info->PassNumber = ACPI_IMODE_EXECUTE;
0254     Info->Node = StartNode;
0255     Info->ObjDesc = MethodObj;
0256     Info->NodeFlags = Info->Node->Flags;
0257     Info->FullPathname = AcpiNsGetNormalizedPathname (Info->Node, TRUE);
0258     if (!Info->FullPathname)
0259     {
0260         Status = AE_NO_MEMORY;
0261         goto Cleanup;
0262     }
0263
0264     /* Optional object evaluation log */
0265
0266     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EVALUATION,
0267         "%-26s:  (Definition Block level)\n", "Module-level evaluation"));
0268
0269     Status = AcpiPsExecuteTable (Info);
0270
0271     /* Optional object evaluation log */
0272
0273     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_EVALUATION,
0274         "%-26s:  (Definition Block level)\n", "Module-level complete"));
0275
0276 Cleanup:
0277     if (Info)
0278     {
0279         ACPI_FREE (Info->FullPathname);
0280         Info->FullPathname = NULL;
0281     }
0282     ACPI_FREE (Info);
0283     AcpiUtRemoveReference (MethodObj);
0284     return_ACPI_STATUS (Status);
0285 }
0286
0287
0288 /*******************************************************************************
0289  *
0290  * FUNCTION:    NsOneCompleteParse
0291  *
0292  * PARAMETERS:  PassNumber              - 1 or 2
0293  *              TableDesc               - The table to be parsed.
0294  *
0295  * RETURN:      Status
0296  *
0297  * DESCRIPTION: Perform one complete parse of an ACPI/AML table.
0298  *
0299  ******************************************************************************/
0300
0301 ACPI_STATUS
0302 AcpiNsOneCompleteParse (
0303     UINT32                  PassNumber,
0304     UINT32                  TableIndex,
0305     ACPI_NAMESPACE_NODE     *StartNode)
0306 {
0307     ACPI_PARSE_OBJECT       *ParseRoot;
0308     ACPI_STATUS             Status;
0309     UINT32                  AmlLength;
0310     UINT8                   *AmlStart;
0311     ACPI_WALK_STATE         *WalkState;
0312     ACPI_TABLE_HEADER       *Table;
0313     ACPI_OWNER_ID           OwnerId;
0314
0315
0316     ACPI_FUNCTION_TRACE (NsOneCompleteParse);
0317
0318
0319     Status = AcpiGetTableByIndex (TableIndex, &Table);
0320     if (ACPI_FAILURE (Status))
0321     {
0322         return_ACPI_STATUS (Status);
0323     }
0324
0325     /* Table must consist of at least a complete header */
0326
0327     if (Table->Length < sizeof (ACPI_TABLE_HEADER))
0328     {
0329         return_ACPI_STATUS (AE_BAD_HEADER);
0330     }
0331
0332     AmlStart = (UINT8 *) Table + sizeof (ACPI_TABLE_HEADER);
0333     AmlLength = Table->Length - sizeof (ACPI_TABLE_HEADER);
0334
0335     Status = AcpiTbGetOwnerId (TableIndex, &OwnerId);
0336     if (ACPI_FAILURE (Status))
0337     {
0338         return_ACPI_STATUS (Status);
0339     }
0340
0341     /* Create and init a Root Node */
0342
0343     ParseRoot = AcpiPsCreateScopeOp (AmlStart);
0344     if (!ParseRoot)
0345     {
0346         return_ACPI_STATUS (AE_NO_MEMORY);
0347     }
0348
0349     /* Create and initialize a new walk state */
0350
0351     WalkState = AcpiDsCreateWalkState (OwnerId, NULL, NULL, NULL);
0352     if (!WalkState)
0353     {
0354         AcpiPsFreeOp (ParseRoot);
0355         return_ACPI_STATUS (AE_NO_MEMORY);
0356     }
0357
0358     Status = AcpiDsInitAmlWalk (WalkState, ParseRoot, NULL,
0359         AmlStart, AmlLength, NULL, (UINT8) PassNumber);
0360     if (ACPI_FAILURE (Status))
0361     {
0362         AcpiDsDeleteWalkState (WalkState);
0363         goto Cleanup;
0364     }
0365
0366     /* Found OSDT table, enable the namespace override feature */
0367
0368     if (ACPI_COMPARE_NAMESEG (Table->Signature, ACPI_SIG_OSDT) &&
0369         PassNumber == ACPI_IMODE_LOAD_PASS1)
0370     {
0371         WalkState->NamespaceOverride = TRUE;
0372     }
0373
0374     /* StartNode is the default location to load the table  */
0375
0376     if (StartNode && StartNode != AcpiGbl_RootNode)
0377     {
0378         Status = AcpiDsScopeStackPush (
0379             StartNode, ACPI_TYPE_METHOD, WalkState);
0380         if (ACPI_FAILURE (Status))
0381         {
0382             AcpiDsDeleteWalkState (WalkState);
0383             goto Cleanup;
0384         }
0385     }
0386
0387     /* Parse the AML */
0388
0389     ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
0390         "*PARSE* pass %u parse\n", PassNumber));
0391     AcpiExEnterInterpreter ();
0392     Status = AcpiPsParseAml (WalkState);
0393     AcpiExExitInterpreter ();
0394
0395 Cleanup:
0396     AcpiPsDeleteParseTree (ParseRoot);
0397     return_ACPI_STATUS (Status);
0398 }
0399
0400
0401 /*******************************************************************************
0402  *
0403  * FUNCTION:    AcpiNsParseTable
0404  *
0405  * PARAMETERS:  TableDesc       - An ACPI table descriptor for table to parse
0406  *              StartNode       - Where to enter the table into the namespace
0407  *
0408  * RETURN:      Status
0409  *
0410  * DESCRIPTION: Parse AML within an ACPI table and return a tree of ops
0411  *
0412  ******************************************************************************/
0413
0414 ACPI_STATUS
0415 AcpiNsParseTable (
0416     UINT32                  TableIndex,
0417     ACPI_NAMESPACE_NODE     *StartNode)
0418 {
0419     ACPI_STATUS             Status;
0420
0421
0422     ACPI_FUNCTION_TRACE (NsParseTable);
0423
0424
0425     /*
0426      * Executes the AML table as one large control method.
0427      * The point of this is to execute any module-level code in-place
0428      * as the table is parsed. Some AML code depends on this behavior.
0429      *
0430      * Note: This causes the table to only have a single-pass parse.
0431      * However, this is compatible with other ACPI implementations.
0432      */
0433     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_PARSE,
0434         "%s: **** Start table execution pass\n", ACPI_GET_FUNCTION_NAME));
0435
0436     Status = AcpiNsExecuteTable (TableIndex, StartNode);
0437
0438     return_ACPI_STATUS (Status);
0439 }