acpica/utilities/uteval.c

0001 /******************************************************************************
0002  *
0003  * Module Name: uteval - Object evaluation
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
0156
0157 #define _COMPONENT          ACPI_UTILITIES
0158         ACPI_MODULE_NAME    ("uteval")
0159
0160
0161 /*******************************************************************************
0162  *
0163  * FUNCTION:    AcpiUtEvaluateObject
0164  *
0165  * PARAMETERS:  PrefixNode          - Starting node
0166  *              Path                - Path to object from starting node
0167  *              ExpectedReturnTypes - Bitmap of allowed return types
0168  *              ReturnDesc          - Where a return value is stored
0169  *
0170  * RETURN:      Status
0171  *
0172  * DESCRIPTION: Evaluates a namespace object and verifies the type of the
0173  *              return object. Common code that simplifies accessing objects
0174  *              that have required return objects of fixed types.
0175  *
0176  *              NOTE: Internal function, no parameter validation
0177  *
0178  ******************************************************************************/
0179
0180 ACPI_STATUS
0181 AcpiUtEvaluateObject (
0182     ACPI_NAMESPACE_NODE     *PrefixNode,
0183     const char              *Path,
0184     UINT32                  ExpectedReturnBtypes,
0185     ACPI_OPERAND_OBJECT     **ReturnDesc)
0186 {
0187     ACPI_EVALUATE_INFO      *Info;
0188     ACPI_STATUS             Status;
0189     UINT32                  ReturnBtype;
0190
0191
0192     ACPI_FUNCTION_TRACE (UtEvaluateObject);
0193
0194
0195     /* Allocate the evaluation information block */
0196
0197     Info = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_EVALUATE_INFO));
0198     if (!Info)
0199     {
0200         return_ACPI_STATUS (AE_NO_MEMORY);
0201     }
0202
0203     Info->PrefixNode = PrefixNode;
0204     Info->RelativePathname = Path;
0205
0206     /* Evaluate the object/method */
0207
0208     Status = AcpiNsEvaluate (Info);
0209     if (ACPI_FAILURE (Status))
0210     {
0211         if (Status == AE_NOT_FOUND)
0212         {
0213             ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[%4.4s.%s] was not found\n",
0214                 AcpiUtGetNodeName (PrefixNode), Path));
0215         }
0216         else
0217         {
0218             ACPI_ERROR_METHOD ("Method execution failed",
0219                 PrefixNode, Path, Status);
0220         }
0221
0222         goto Cleanup;
0223     }
0224
0225     /* Did we get a return object? */
0226
0227     if (!Info->ReturnObject)
0228     {
0229         if (ExpectedReturnBtypes)
0230         {
0231             ACPI_ERROR_METHOD ("No object was returned from",
0232                 PrefixNode, Path, AE_NOT_EXIST);
0233
0234             Status = AE_NOT_EXIST;
0235         }
0236
0237         goto Cleanup;
0238     }
0239
0240     /* Map the return object type to the bitmapped type */
0241
0242     switch ((Info->ReturnObject)->Common.Type)
0243     {
0244     case ACPI_TYPE_INTEGER:
0245
0246         ReturnBtype = ACPI_BTYPE_INTEGER;
0247         break;
0248
0249     case ACPI_TYPE_BUFFER:
0250
0251         ReturnBtype = ACPI_BTYPE_BUFFER;
0252         break;
0253
0254     case ACPI_TYPE_STRING:
0255
0256         ReturnBtype = ACPI_BTYPE_STRING;
0257         break;
0258
0259     case ACPI_TYPE_PACKAGE:
0260
0261         ReturnBtype = ACPI_BTYPE_PACKAGE;
0262         break;
0263
0264     default:
0265
0266         ReturnBtype = 0;
0267         break;
0268     }
0269
0270     if ((AcpiGbl_EnableInterpreterSlack) &&
0271         (!ExpectedReturnBtypes))
0272     {
0273         /*
0274          * We received a return object, but one was not expected. This can
0275          * happen frequently if the "implicit return" feature is enabled.
0276          * Just delete the return object and return AE_OK.
0277          */
0278         AcpiUtRemoveReference (Info->ReturnObject);
0279         goto Cleanup;
0280     }
0281
0282     /* Is the return object one of the expected types? */
0283
0284     if (!(ExpectedReturnBtypes & ReturnBtype))
0285     {
0286         ACPI_ERROR_METHOD ("Return object type is incorrect",
0287             PrefixNode, Path, AE_TYPE);
0288
0289         ACPI_ERROR ((AE_INFO,
0290             "Type returned from %s was incorrect: %s, expected Btypes: 0x%X",
0291             Path, AcpiUtGetObjectTypeName (Info->ReturnObject),
0292             ExpectedReturnBtypes));
0293
0294         /* On error exit, we must delete the return object */
0295
0296         AcpiUtRemoveReference (Info->ReturnObject);
0297         Status = AE_TYPE;
0298         goto Cleanup;
0299     }
0300
0301     /* Object type is OK, return it */
0302
0303     *ReturnDesc = Info->ReturnObject;
0304
0305 Cleanup:
0306     ACPI_FREE (Info);
0307     return_ACPI_STATUS (Status);
0308 }
0309
0310
0311 /*******************************************************************************
0312  *
0313  * FUNCTION:    AcpiUtEvaluateNumericObject
0314  *
0315  * PARAMETERS:  ObjectName          - Object name to be evaluated
0316  *              DeviceNode          - Node for the device
0317  *              Value               - Where the value is returned
0318  *
0319  * RETURN:      Status
0320  *
0321  * DESCRIPTION: Evaluates a numeric namespace object for a selected device
0322  *              and stores result in *Value.
0323  *
0324  *              NOTE: Internal function, no parameter validation
0325  *
0326  ******************************************************************************/
0327
0328 ACPI_STATUS
0329 AcpiUtEvaluateNumericObject (
0330     const char              *ObjectName,
0331     ACPI_NAMESPACE_NODE     *DeviceNode,
0332     UINT64                  *Value)
0333 {
0334     ACPI_OPERAND_OBJECT     *ObjDesc;
0335     ACPI_STATUS             Status;
0336
0337
0338     ACPI_FUNCTION_TRACE (UtEvaluateNumericObject);
0339
0340
0341     Status = AcpiUtEvaluateObject (DeviceNode, ObjectName,
0342         ACPI_BTYPE_INTEGER, &ObjDesc);
0343     if (ACPI_FAILURE (Status))
0344     {
0345         return_ACPI_STATUS (Status);
0346     }
0347
0348     /* Get the returned Integer */
0349
0350     *Value = ObjDesc->Integer.Value;
0351
0352     /* On exit, we must delete the return object */
0353
0354     AcpiUtRemoveReference (ObjDesc);
0355     return_ACPI_STATUS (Status);
0356 }
0357
0358
0359 /*******************************************************************************
0360  *
0361  * FUNCTION:    AcpiUtExecute_STA
0362  *
0363  * PARAMETERS:  DeviceNode          - Node for the device
0364  *              Flags               - Where the status flags are returned
0365  *
0366  * RETURN:      Status
0367  *
0368  * DESCRIPTION: Executes _STA for selected device and stores results in
0369  *              *Flags. If _STA does not exist, then the device is assumed
0370  *              to be present/functional/enabled (as per the ACPI spec).
0371  *
0372  *              NOTE: Internal function, no parameter validation
0373  *
0374  ******************************************************************************/
0375
0376 ACPI_STATUS
0377 AcpiUtExecute_STA (
0378     ACPI_NAMESPACE_NODE     *DeviceNode,
0379     UINT32                  *Flags)
0380 {
0381     ACPI_OPERAND_OBJECT     *ObjDesc;
0382     ACPI_STATUS             Status;
0383
0384
0385     ACPI_FUNCTION_TRACE (UtExecute_STA);
0386
0387
0388     Status = AcpiUtEvaluateObject (DeviceNode, METHOD_NAME__STA,
0389         ACPI_BTYPE_INTEGER, &ObjDesc);
0390     if (ACPI_FAILURE (Status))
0391     {
0392         if (AE_NOT_FOUND == Status)
0393         {
0394             /*
0395              * if _STA does not exist, then (as per the ACPI specification),
0396              * the returned flags will indicate that the device is present,
0397              * functional, and enabled.
0398              */
0399             ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
0400                 "_STA on %4.4s was not found, assuming device is present\n",
0401                 AcpiUtGetNodeName (DeviceNode)));
0402
0403             *Flags = ACPI_UINT32_MAX;
0404             Status = AE_OK;
0405         }
0406
0407         return_ACPI_STATUS (Status);
0408     }
0409
0410     /* Extract the status flags */
0411
0412     *Flags = (UINT32) ObjDesc->Integer.Value;
0413
0414     /* On exit, we must delete the return object */
0415
0416     AcpiUtRemoveReference (ObjDesc);
0417     return_ACPI_STATUS (Status);
0418 }
0419
0420
0421 /*******************************************************************************
0422  *
0423  * FUNCTION:    AcpiUtExecutePowerMethods
0424  *
0425  * PARAMETERS:  DeviceNode          - Node for the device
0426  *              MethodNames         - Array of power method names
0427  *              MethodCount         - Number of methods to execute
0428  *              OutValues           - Where the power method values are returned
0429  *
0430  * RETURN:      Status, OutValues
0431  *
0432  * DESCRIPTION: Executes the specified power methods for the device and returns
0433  *              the result(s).
0434  *
0435  *              NOTE: Internal function, no parameter validation
0436  *
0437  ******************************************************************************/
0438
0439 ACPI_STATUS
0440 AcpiUtExecutePowerMethods (
0441     ACPI_NAMESPACE_NODE     *DeviceNode,
0442     const char              **MethodNames,
0443     UINT8                   MethodCount,
0444     UINT8                   *OutValues)
0445 {
0446     ACPI_OPERAND_OBJECT     *ObjDesc;
0447     ACPI_STATUS             Status;
0448     ACPI_STATUS             FinalStatus = AE_NOT_FOUND;
0449     UINT32                  i;
0450
0451
0452     ACPI_FUNCTION_TRACE (UtExecutePowerMethods);
0453
0454
0455     for (i = 0; i < MethodCount; i++)
0456     {
0457         /*
0458          * Execute the power method (_SxD or _SxW). The only allowable
0459          * return type is an Integer.
0460          */
0461         Status = AcpiUtEvaluateObject (DeviceNode,
0462             ACPI_CAST_PTR (char, MethodNames[i]),
0463             ACPI_BTYPE_INTEGER, &ObjDesc);
0464         if (ACPI_SUCCESS (Status))
0465         {
0466             OutValues[i] = (UINT8) ObjDesc->Integer.Value;
0467
0468             /* Delete the return object */
0469
0470             AcpiUtRemoveReference (ObjDesc);
0471             FinalStatus = AE_OK;            /* At least one value is valid */
0472             continue;
0473         }
0474
0475         OutValues[i] = ACPI_UINT8_MAX;
0476         if (Status == AE_NOT_FOUND)
0477         {
0478             continue; /* Ignore if not found */
0479         }
0480
0481         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Failed %s on Device %4.4s, %s\n",
0482             ACPI_CAST_PTR (char, MethodNames[i]),
0483             AcpiUtGetNodeName (DeviceNode), AcpiFormatException (Status)));
0484     }
0485
0486     return_ACPI_STATUS (FinalStatus);
0487 }