acpica/executer/exresnte.c

0001 /******************************************************************************
0002  *
0003  * Module Name: exresnte - AML Interpreter object resolution
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 "acdispat.h"
0155 #include "acinterp.h"
0156 #include "acnamesp.h"
0157
0158
0159 #define _COMPONENT          ACPI_EXECUTER
0160         ACPI_MODULE_NAME    ("exresnte")
0161
0162
0163 /*******************************************************************************
0164  *
0165  * FUNCTION:    AcpiExResolveNodeToValue
0166  *
0167  * PARAMETERS:  ObjectPtr       - Pointer to a location that contains
0168  *                                a pointer to a NS node, and will receive a
0169  *                                pointer to the resolved object.
0170  *              WalkState       - Current state. Valid only if executing AML
0171  *                                code. NULL if simply resolving an object
0172  *
0173  * RETURN:      Status
0174  *
0175  * DESCRIPTION: Resolve a Namespace node to a valued object
0176  *
0177  * Note: for some of the data types, the pointer attached to the Node
0178  * can be either a pointer to an actual internal object or a pointer into the
0179  * AML stream itself. These types are currently:
0180  *
0181  *      ACPI_TYPE_INTEGER
0182  *      ACPI_TYPE_STRING
0183  *      ACPI_TYPE_BUFFER
0184  *      ACPI_TYPE_MUTEX
0185  *      ACPI_TYPE_PACKAGE
0186  *
0187  ******************************************************************************/
0188
0189 ACPI_STATUS
0190 AcpiExResolveNodeToValue (
0191     ACPI_NAMESPACE_NODE     **ObjectPtr,
0192     ACPI_WALK_STATE         *WalkState)
0193
0194 {
0195     ACPI_STATUS             Status = AE_OK;
0196     ACPI_OPERAND_OBJECT     *SourceDesc;
0197     ACPI_OPERAND_OBJECT     *ObjDesc = NULL;
0198     ACPI_NAMESPACE_NODE     *Node;
0199     ACPI_OBJECT_TYPE        EntryType;
0200
0201
0202     ACPI_FUNCTION_TRACE (ExResolveNodeToValue);
0203
0204
0205     /*
0206      * The stack pointer points to a ACPI_NAMESPACE_NODE (Node). Get the
0207      * object that is attached to the Node.
0208      */
0209     Node = *ObjectPtr;
0210     SourceDesc = AcpiNsGetAttachedObject (Node);
0211     EntryType = AcpiNsGetType ((ACPI_HANDLE) Node);
0212
0213     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Entry=%p SourceDesc=%p [%s]\n",
0214          Node, SourceDesc, AcpiUtGetTypeName (EntryType)));
0215
0216     if ((EntryType == ACPI_TYPE_LOCAL_ALIAS) ||
0217         (EntryType == ACPI_TYPE_LOCAL_METHOD_ALIAS))
0218     {
0219         /* There is always exactly one level of indirection */
0220
0221         Node = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, Node->Object);
0222         SourceDesc = AcpiNsGetAttachedObject (Node);
0223         EntryType = AcpiNsGetType ((ACPI_HANDLE) Node);
0224         *ObjectPtr = Node;
0225     }
0226
0227     /*
0228      * Several object types require no further processing:
0229      * 1) Device/Thermal objects don't have a "real" subobject, return Node
0230      * 2) Method locals and arguments have a pseudo-Node
0231      * 3) 10/2007: Added method type to assist with Package construction.
0232      */
0233     if ((EntryType == ACPI_TYPE_DEVICE)  ||
0234         (EntryType == ACPI_TYPE_THERMAL) ||
0235         (EntryType == ACPI_TYPE_METHOD)  ||
0236         (Node->Flags & (ANOBJ_METHOD_ARG | ANOBJ_METHOD_LOCAL)))
0237     {
0238         return_ACPI_STATUS (AE_OK);
0239     }
0240
0241     if (!SourceDesc)
0242     {
0243         ACPI_ERROR ((AE_INFO, "No object attached to node [%4.4s] %p",
0244             Node->Name.Ascii, Node));
0245         return_ACPI_STATUS (AE_AML_UNINITIALIZED_NODE);
0246     }
0247
0248     /*
0249      * Action is based on the type of the Node, which indicates the type
0250      * of the attached object or pointer
0251      */
0252     switch (EntryType)
0253     {
0254     case ACPI_TYPE_PACKAGE:
0255
0256         if (SourceDesc->Common.Type != ACPI_TYPE_PACKAGE)
0257         {
0258             ACPI_ERROR ((AE_INFO, "Object not a Package, type %s",
0259                 AcpiUtGetObjectTypeName (SourceDesc)));
0260             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
0261         }
0262
0263         Status = AcpiDsGetPackageArguments (SourceDesc);
0264         if (ACPI_SUCCESS (Status))
0265         {
0266             /* Return an additional reference to the object */
0267
0268             ObjDesc = SourceDesc;
0269             AcpiUtAddReference (ObjDesc);
0270         }
0271         break;
0272
0273     case ACPI_TYPE_BUFFER:
0274
0275         if (SourceDesc->Common.Type != ACPI_TYPE_BUFFER)
0276         {
0277             ACPI_ERROR ((AE_INFO, "Object not a Buffer, type %s",
0278                 AcpiUtGetObjectTypeName (SourceDesc)));
0279             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
0280         }
0281
0282         Status = AcpiDsGetBufferArguments (SourceDesc);
0283         if (ACPI_SUCCESS (Status))
0284         {
0285             /* Return an additional reference to the object */
0286
0287             ObjDesc = SourceDesc;
0288             AcpiUtAddReference (ObjDesc);
0289         }
0290         break;
0291
0292     case ACPI_TYPE_STRING:
0293
0294         if (SourceDesc->Common.Type != ACPI_TYPE_STRING)
0295         {
0296             ACPI_ERROR ((AE_INFO, "Object not a String, type %s",
0297                 AcpiUtGetObjectTypeName (SourceDesc)));
0298             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
0299         }
0300
0301         /* Return an additional reference to the object */
0302
0303         ObjDesc = SourceDesc;
0304         AcpiUtAddReference (ObjDesc);
0305         break;
0306
0307     case ACPI_TYPE_INTEGER:
0308
0309         if (SourceDesc->Common.Type != ACPI_TYPE_INTEGER)
0310         {
0311             ACPI_ERROR ((AE_INFO, "Object not a Integer, type %s",
0312                 AcpiUtGetObjectTypeName (SourceDesc)));
0313             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
0314         }
0315
0316         /* Return an additional reference to the object */
0317
0318         ObjDesc = SourceDesc;
0319         AcpiUtAddReference (ObjDesc);
0320         break;
0321
0322     case ACPI_TYPE_BUFFER_FIELD:
0323     case ACPI_TYPE_LOCAL_REGION_FIELD:
0324     case ACPI_TYPE_LOCAL_BANK_FIELD:
0325     case ACPI_TYPE_LOCAL_INDEX_FIELD:
0326
0327         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
0328             "FieldRead Node=%p SourceDesc=%p Type=%X\n",
0329             Node, SourceDesc, EntryType));
0330
0331         Status = AcpiExReadDataFromField (WalkState, SourceDesc, &ObjDesc);
0332         break;
0333
0334     /* For these objects, just return the object attached to the Node */
0335
0336     case ACPI_TYPE_MUTEX:
0337     case ACPI_TYPE_POWER:
0338     case ACPI_TYPE_PROCESSOR:
0339     case ACPI_TYPE_EVENT:
0340     case ACPI_TYPE_REGION:
0341
0342         /* Return an additional reference to the object */
0343
0344         ObjDesc = SourceDesc;
0345         AcpiUtAddReference (ObjDesc);
0346         break;
0347
0348     /* TYPE_ANY is untyped, and thus there is no object associated with it */
0349
0350     case ACPI_TYPE_ANY:
0351
0352         ACPI_ERROR ((AE_INFO,
0353             "Untyped entry %p, no attached object!", Node));
0354
0355         return_ACPI_STATUS (AE_AML_OPERAND_TYPE);  /* Cannot be AE_TYPE */
0356
0357     case ACPI_TYPE_LOCAL_REFERENCE:
0358
0359         switch (SourceDesc->Reference.Class)
0360         {
0361         case ACPI_REFCLASS_TABLE:   /* This is a DdbHandle */
0362         case ACPI_REFCLASS_REFOF:
0363         case ACPI_REFCLASS_INDEX:
0364
0365             /* Return an additional reference to the object */
0366
0367             ObjDesc = SourceDesc;
0368             AcpiUtAddReference (ObjDesc);
0369             break;
0370
0371         default:
0372
0373             /* No named references are allowed here */
0374
0375             ACPI_ERROR ((AE_INFO,
0376                 "Unsupported Reference type 0x%X",
0377                 SourceDesc->Reference.Class));
0378
0379             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
0380         }
0381         break;
0382
0383     default:
0384
0385         /* Default case is for unknown types */
0386
0387         ACPI_ERROR ((AE_INFO,
0388             "Node %p - Unknown object type 0x%X",
0389             Node, EntryType));
0390
0391         return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
0392
0393     } /* switch (EntryType) */
0394
0395
0396     /* Return the object descriptor */
0397
0398     *ObjectPtr = (void *) ObjDesc;
0399     return_ACPI_STATUS (Status);
0400 }