acpica/parser/psxface.c

0001 /******************************************************************************
0002  *
0003  * Module Name: psxface - Parser external interfaces
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 "acparser.h"
0155 #include "acdispat.h"
0156 #include "acinterp.h"
0157 #include "actables.h"
0158 #include "acnamesp.h"
0159
0160
0161 #define _COMPONENT          ACPI_PARSER
0162         ACPI_MODULE_NAME    ("psxface")
0163
0164 /* Local Prototypes */
0165
0166 static void
0167 AcpiPsUpdateParameterList (
0168     ACPI_EVALUATE_INFO      *Info,
0169     UINT16                  Action);
0170
0171
0172 /*******************************************************************************
0173  *
0174  * FUNCTION:    AcpiDebugTrace
0175  *
0176  * PARAMETERS:  MethodName      - Valid ACPI name string
0177  *              DebugLevel      - Optional level mask. 0 to use default
0178  *              DebugLayer      - Optional layer mask. 0 to use default
0179  *              Flags           - bit 1: one shot(1) or persistent(0)
0180  *
0181  * RETURN:      Status
0182  *
0183  * DESCRIPTION: External interface to enable debug tracing during control
0184  *              method execution
0185  *
0186  ******************************************************************************/
0187
0188 ACPI_STATUS
0189 AcpiDebugTrace (
0190     const char              *Name,
0191     UINT32                  DebugLevel,
0192     UINT32                  DebugLayer,
0193     UINT32                  Flags)
0194 {
0195     ACPI_STATUS             Status;
0196
0197
0198     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
0199     if (ACPI_FAILURE (Status))
0200     {
0201         return (Status);
0202     }
0203
0204     AcpiGbl_TraceMethodName = Name;
0205     AcpiGbl_TraceFlags = Flags;
0206     AcpiGbl_TraceDbgLevel = DebugLevel;
0207     AcpiGbl_TraceDbgLayer = DebugLayer;
0208     Status = AE_OK;
0209
0210     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
0211     return (Status);
0212 }
0213
0214
0215 /*******************************************************************************
0216  *
0217  * FUNCTION:    AcpiPsExecuteMethod
0218  *
0219  * PARAMETERS:  Info            - Method info block, contains:
0220  *                  Node            - Method Node to execute
0221  *                  ObjDesc         - Method object
0222  *                  Parameters      - List of parameters to pass to the method,
0223  *                                    terminated by NULL. Params itself may be
0224  *                                    NULL if no parameters are being passed.
0225  *                  ReturnObject    - Where to put method's return value (if
0226  *                                    any). If NULL, no value is returned.
0227  *                  ParameterType   - Type of Parameter list
0228  *                  ReturnObject    - Where to put method's return value (if
0229  *                                    any). If NULL, no value is returned.
0230  *                  PassNumber      - Parse or execute pass
0231  *
0232  * RETURN:      Status
0233  *
0234  * DESCRIPTION: Execute a control method
0235  *
0236  ******************************************************************************/
0237
0238 ACPI_STATUS
0239 AcpiPsExecuteMethod (
0240     ACPI_EVALUATE_INFO      *Info)
0241 {
0242     ACPI_STATUS             Status;
0243     ACPI_PARSE_OBJECT       *Op;
0244     ACPI_WALK_STATE         *WalkState;
0245
0246
0247     ACPI_FUNCTION_TRACE (PsExecuteMethod);
0248
0249
0250     /* Quick validation of DSDT header */
0251
0252     AcpiTbCheckDsdtHeader ();
0253
0254     /* Validate the Info and method Node */
0255
0256     if (!Info || !Info->Node)
0257     {
0258         return_ACPI_STATUS (AE_NULL_ENTRY);
0259     }
0260
0261     /* Init for new method, wait on concurrency semaphore */
0262
0263     Status = AcpiDsBeginMethodExecution (Info->Node, Info->ObjDesc, NULL);
0264     if (ACPI_FAILURE (Status))
0265     {
0266         return_ACPI_STATUS (Status);
0267     }
0268
0269     /*
0270      * The caller "owns" the parameters, so give each one an extra reference
0271      */
0272     AcpiPsUpdateParameterList (Info, REF_INCREMENT);
0273
0274     /*
0275      * Execute the method. Performs parse simultaneously
0276      */
0277     ACPI_DEBUG_PRINT ((ACPI_DB_PARSE,
0278         "**** Begin Method Parse/Execute [%4.4s] **** Node=%p Obj=%p\n",
0279         Info->Node->Name.Ascii, Info->Node, Info->ObjDesc));
0280
0281     /* Create and init a Root Node */
0282
0283     Op = AcpiPsCreateScopeOp (Info->ObjDesc->Method.AmlStart);
0284     if (!Op)
0285     {
0286         Status = AE_NO_MEMORY;
0287         goto Cleanup;
0288     }
0289
0290     /* Create and initialize a new walk state */
0291
0292     Info->PassNumber = ACPI_IMODE_EXECUTE;
0293     WalkState = AcpiDsCreateWalkState (
0294         Info->ObjDesc->Method.OwnerId, NULL, NULL, NULL);
0295     if (!WalkState)
0296     {
0297         Status = AE_NO_MEMORY;
0298         goto Cleanup;
0299     }
0300
0301     Status = AcpiDsInitAmlWalk (WalkState, Op, Info->Node,
0302         Info->ObjDesc->Method.AmlStart,
0303         Info->ObjDesc->Method.AmlLength, Info, Info->PassNumber);
0304     if (ACPI_FAILURE (Status))
0305     {
0306         AcpiDsDeleteWalkState (WalkState);
0307         goto Cleanup;
0308     }
0309
0310     WalkState->MethodPathname = Info->FullPathname;
0311     WalkState->MethodIsNested = FALSE;
0312
0313     if (Info->ObjDesc->Method.InfoFlags & ACPI_METHOD_MODULE_LEVEL)
0314     {
0315         WalkState->ParseFlags |= ACPI_PARSE_MODULE_LEVEL;
0316     }
0317
0318     /* Invoke an internal method if necessary */
0319
0320     if (Info->ObjDesc->Method.InfoFlags & ACPI_METHOD_INTERNAL_ONLY)
0321     {
0322         Status = Info->ObjDesc->Method.Dispatch.Implementation (WalkState);
0323         Info->ReturnObject = WalkState->ReturnDesc;
0324
0325         /* Cleanup states */
0326
0327         AcpiDsScopeStackClear (WalkState);
0328         AcpiPsCleanupScope (&WalkState->ParserState);
0329         AcpiDsTerminateControlMethod (WalkState->MethodDesc, WalkState);
0330         AcpiDsDeleteWalkState (WalkState);
0331         goto Cleanup;
0332     }
0333
0334     /*
0335      * Start method evaluation with an implicit return of zero.
0336      * This is done for Windows compatibility.
0337      */
0338     if (AcpiGbl_EnableInterpreterSlack)
0339     {
0340         WalkState->ImplicitReturnObj =
0341             AcpiUtCreateIntegerObject ((UINT64) 0);
0342         if (!WalkState->ImplicitReturnObj)
0343         {
0344             Status = AE_NO_MEMORY;
0345             AcpiDsDeleteWalkState (WalkState);
0346             goto Cleanup;
0347         }
0348     }
0349
0350     /* Parse the AML */
0351
0352     Status = AcpiPsParseAml (WalkState);
0353
0354     /* WalkState was deleted by ParseAml */
0355
0356 Cleanup:
0357     AcpiPsDeleteParseTree (Op);
0358
0359     /* Take away the extra reference that we gave the parameters above */
0360
0361     AcpiPsUpdateParameterList (Info, REF_DECREMENT);
0362
0363     /* Exit now if error above */
0364
0365     if (ACPI_FAILURE (Status))
0366     {
0367         return_ACPI_STATUS (Status);
0368     }
0369
0370     /*
0371      * If the method has returned an object, signal this to the caller with
0372      * a control exception code
0373      */
0374     if (Info->ReturnObject)
0375     {
0376         ACPI_DEBUG_PRINT ((ACPI_DB_PARSE, "Method returned ObjDesc=%p\n",
0377             Info->ReturnObject));
0378         ACPI_DUMP_STACK_ENTRY (Info->ReturnObject);
0379
0380         Status = AE_CTRL_RETURN_VALUE;
0381     }
0382
0383     return_ACPI_STATUS (Status);
0384 }
0385
0386
0387 /*******************************************************************************
0388  *
0389  * FUNCTION:    AcpiPsExecuteTable
0390  *
0391  * PARAMETERS:  Info            - Method info block, contains:
0392  *              Node            - Node to where the is entered into the
0393  *                                namespace
0394  *              ObjDesc         - Pseudo method object describing the AML
0395  *                                code of the entire table
0396  *              PassNumber      - Parse or execute pass
0397  *
0398  * RETURN:      Status
0399  *
0400  * DESCRIPTION: Execute a table
0401  *
0402  ******************************************************************************/
0403
0404 ACPI_STATUS
0405 AcpiPsExecuteTable (
0406     ACPI_EVALUATE_INFO      *Info)
0407 {
0408     ACPI_STATUS             Status;
0409     ACPI_PARSE_OBJECT       *Op = NULL;
0410     ACPI_WALK_STATE         *WalkState = NULL;
0411
0412
0413     ACPI_FUNCTION_TRACE (PsExecuteTable);
0414
0415
0416     /* Create and init a Root Node */
0417
0418     Op = AcpiPsCreateScopeOp (Info->ObjDesc->Method.AmlStart);
0419     if (!Op)
0420     {
0421         Status = AE_NO_MEMORY;
0422         goto Cleanup;
0423     }
0424
0425     /* Create and initialize a new walk state */
0426
0427     WalkState = AcpiDsCreateWalkState (
0428         Info->ObjDesc->Method.OwnerId, NULL, NULL, NULL);
0429     if (!WalkState)
0430     {
0431         Status = AE_NO_MEMORY;
0432         goto Cleanup;
0433     }
0434
0435     Status = AcpiDsInitAmlWalk (WalkState, Op, Info->Node,
0436         Info->ObjDesc->Method.AmlStart,
0437         Info->ObjDesc->Method.AmlLength, Info, Info->PassNumber);
0438     if (ACPI_FAILURE (Status))
0439     {
0440         goto Cleanup;
0441     }
0442
0443     WalkState->MethodPathname = Info->FullPathname;
0444     WalkState->MethodIsNested = FALSE;
0445
0446     if (Info->ObjDesc->Method.InfoFlags & ACPI_METHOD_MODULE_LEVEL)
0447     {
0448         WalkState->ParseFlags |= ACPI_PARSE_MODULE_LEVEL;
0449     }
0450
0451     /* Info->Node is the default location to load the table  */
0452
0453     if (Info->Node && Info->Node != AcpiGbl_RootNode)
0454     {
0455         Status = AcpiDsScopeStackPush (
0456             Info->Node, ACPI_TYPE_METHOD, WalkState);
0457         if (ACPI_FAILURE (Status))
0458         {
0459             goto Cleanup;
0460         }
0461     }
0462
0463     /*
0464      * Parse the AML, WalkState will be deleted by ParseAml
0465      */
0466     AcpiExEnterInterpreter ();
0467     Status = AcpiPsParseAml (WalkState);
0468     AcpiExExitInterpreter ();
0469     WalkState = NULL;
0470
0471 Cleanup:
0472     if (WalkState)
0473     {
0474         AcpiDsDeleteWalkState (WalkState);
0475     }
0476     if (Op)
0477     {
0478         AcpiPsDeleteParseTree (Op);
0479     }
0480     return_ACPI_STATUS (Status);
0481 }
0482
0483
0484 /*******************************************************************************
0485  *
0486  * FUNCTION:    AcpiPsUpdateParameterList
0487  *
0488  * PARAMETERS:  Info            - See ACPI_EVALUATE_INFO
0489  *                                (Used: ParameterType and Parameters)
0490  *              Action          - Add or Remove reference
0491  *
0492  * RETURN:      Status
0493  *
0494  * DESCRIPTION: Update reference count on all method parameter objects
0495  *
0496  ******************************************************************************/
0497
0498 static void
0499 AcpiPsUpdateParameterList (
0500     ACPI_EVALUATE_INFO      *Info,
0501     UINT16                  Action)
0502 {
0503     UINT32                  i;
0504
0505
0506     if (Info->Parameters)
0507     {
0508         /* Update reference count for each parameter */
0509
0510         for (i = 0; Info->Parameters[i]; i++)
0511         {
0512             /* Ignore errors, just do them all */
0513
0514             (void) AcpiUtUpdateObjectReference (
0515                 Info->Parameters[i], Action);
0516         }
0517     }
0518 }