reactos/drivers/bus/acpi/acpica/executer/exresnte.c

   1 /******************************************************************************
   2  *
   3  * Module Name: exresnte - AML Interpreter object resolution
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2015, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  16  * 2.1. This is your license from Intel Corp. under its intellectual property
  17  * rights. You may have additional license terms from the party that provided
  18  * you this software, covering your right to use that party's intellectual
  19  * property rights.
  20  *
  21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  22  * copy of the source code appearing in this file ("Covered Code") an
  23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  24  * base code distributed originally by Intel ("Original Intel Code") to copy,
  25  * make derivatives, distribute, use and display any portion of the Covered
  26  * Code in any form, with the right to sublicense such rights; and
  27  *
  28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  29  * license (with the right to sublicense), under only those claims of Intel
  30  * patents that are infringed by the Original Intel Code, to make, use, sell,
  31  * offer to sell, and import the Covered Code and derivative works thereof
  32  * solely to the minimum extent necessary to exercise the above copyright
  33  * license, and in no event shall the patent license extend to any additions
  34  * to or modifications of the Original Intel Code. No other license or right
  35  * is granted directly or by implication, estoppel or otherwise;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  43  * Redistribution of source code of any substantial portion of the Covered
  44  * Code or modification with rights to further distribute source must include
  45  * the above Copyright Notice, the above License, this list of Conditions,
  46  * and the following Disclaimer and Export Compliance provision. In addition,
  47  * Licensee must cause all Covered Code to which Licensee contributes to
  48  * contain a file documenting the changes Licensee made to create that Covered
  49  * Code and the date of any change. Licensee must include in that file the
  50  * documentation of any changes made by any predecessor Licensee. Licensee
  51  * must include a prominent statement that the modification is derived,
  52  * directly or indirectly, from Original Intel Code.
  53  *
  54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  55  * Redistribution of source code of any substantial portion of the Covered
  56  * Code or modification without rights to further distribute source must
  57  * include the following Disclaimer and Export Compliance provision in the
  58  * documentation and/or other materials provided with distribution. In
  59  * addition, Licensee may not authorize further sublicense of source of any
  60  * portion of the Covered Code, and must include terms to the effect that the
  61  * license from Licensee to its licensee is limited to the intellectual
  62  * property embodied in the software Licensee provides to its licensee, and
  63  * not to intellectual property embodied in modifications its licensee may
  64  * make.
  65  *
  66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  67  * substantial portion of the Covered Code or modification must reproduce the
  68  * above Copyright Notice, and the following Disclaimer and Export Compliance
  69  * provision in the documentation and/or other materials provided with the
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  76  * Intel shall be used in advertising or otherwise to promote the sale, use or
  77  * other dealings in products derived from or relating to the Covered Code
  78  * without prior written authorization from Intel.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
  85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
  86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
  87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  88  * PARTICULAR PURPOSE.
  89  *
  90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
  96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  97  * LIMITED REMEDY.
  98  *
  99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 100  * software or system incorporating such software without first obtaining any
 101  * required license or other approval from the U. S. Department of Commerce or
 102  * any other agency or department of the United States Government. In the
 103  * event Licensee exports any such software from the United States or
 104  * re-exports any such software from a foreign destination, Licensee shall
 105  * ensure that the distribution and export/re-export of the software is in
 106  * compliance with all laws, regulations, orders, or other restrictions of the
 107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 108  * any of its subsidiaries will export/re-export any technical data, process,
 109  * software, or service, directly or indirectly, to any country for which the
 110  * United States government or any agency thereof requires an export license,
 111  * other governmental approval, or letter of assurance, without first obtaining
 112  * such license, approval or letter.
 113  *
 114  *****************************************************************************/
 115
 116 #include "acpi.h"
 117 #include "accommon.h"
 118 #include "acdispat.h"
 119 #include "acinterp.h"
 120 #include "acnamesp.h"
 121
 122
 123 #define _COMPONENT          ACPI_EXECUTER
 124         ACPI_MODULE_NAME    ("exresnte")
 125
 126
 127 /*******************************************************************************
 128  *
 129  * FUNCTION:    AcpiExResolveNodeToValue
 130  *
 131  * PARAMETERS:  ObjectPtr       - Pointer to a location that contains
 132  *                                a pointer to a NS node, and will receive a
 133  *                                pointer to the resolved object.
 134  *              WalkState       - Current state. Valid only if executing AML
 135  *                                code. NULL if simply resolving an object
 136  *
 137  * RETURN:      Status
 138  *
 139  * DESCRIPTION: Resolve a Namespace node to a valued object
 140  *
 141  * Note: for some of the data types, the pointer attached to the Node
 142  * can be either a pointer to an actual internal object or a pointer into the
 143  * AML stream itself. These types are currently:
 144  *
 145  *      ACPI_TYPE_INTEGER
 146  *      ACPI_TYPE_STRING
 147  *      ACPI_TYPE_BUFFER
 148  *      ACPI_TYPE_MUTEX
 149  *      ACPI_TYPE_PACKAGE
 150  *
 151  ******************************************************************************/
 152
 153 ACPI_STATUS
 154 AcpiExResolveNodeToValue (
 155     ACPI_NAMESPACE_NODE     **ObjectPtr,
 156     ACPI_WALK_STATE         *WalkState)
 157
 158 {
 159     ACPI_STATUS             Status = AE_OK;
 160     ACPI_OPERAND_OBJECT     *SourceDesc;
 161     ACPI_OPERAND_OBJECT     *ObjDesc = NULL;
 162     ACPI_NAMESPACE_NODE     *Node;
 163     ACPI_OBJECT_TYPE        EntryType;
 164
 165
 166     ACPI_FUNCTION_TRACE (ExResolveNodeToValue);
 167
 168
 169     /*
 170      * The stack pointer points to a ACPI_NAMESPACE_NODE (Node). Get the
 171      * object that is attached to the Node.
 172      */
 173     Node       = *ObjectPtr;
 174     SourceDesc = AcpiNsGetAttachedObject (Node);
 175     EntryType  = AcpiNsGetType ((ACPI_HANDLE) Node);
 176
 177     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Entry=%p SourceDesc=%p [%s]\n",
 178          Node, SourceDesc, AcpiUtGetTypeName (EntryType)));
 179
 180     if ((EntryType == ACPI_TYPE_LOCAL_ALIAS) ||
 181         (EntryType == ACPI_TYPE_LOCAL_METHOD_ALIAS))
 182     {
 183         /* There is always exactly one level of indirection */
 184
 185         Node       = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, Node->Object);
 186         SourceDesc = AcpiNsGetAttachedObject (Node);
 187         EntryType  = AcpiNsGetType ((ACPI_HANDLE) Node);
 188         *ObjectPtr = Node;
 189     }
 190
 191     /*
 192      * Several object types require no further processing:
 193      * 1) Device/Thermal objects don't have a "real" subobject, return the Node
 194      * 2) Method locals and arguments have a pseudo-Node
 195      * 3) 10/2007: Added method type to assist with Package construction.
 196      */
 197     if ((EntryType == ACPI_TYPE_DEVICE)  ||
 198         (EntryType == ACPI_TYPE_THERMAL) ||
 199         (EntryType == ACPI_TYPE_METHOD)  ||
 200         (Node->Flags & (ANOBJ_METHOD_ARG | ANOBJ_METHOD_LOCAL)))
 201     {
 202         return_ACPI_STATUS (AE_OK);
 203     }
 204
 205     if (!SourceDesc)
 206     {
 207         ACPI_ERROR ((AE_INFO, "No object attached to node [%4.4s] %p",
 208             Node->Name.Ascii, Node));
 209         return_ACPI_STATUS (AE_AML_NO_OPERAND);
 210     }
 211
 212     /*
 213      * Action is based on the type of the Node, which indicates the type
 214      * of the attached object or pointer
 215      */
 216     switch (EntryType)
 217     {
 218     case ACPI_TYPE_PACKAGE:
 219
 220         if (SourceDesc->Common.Type != ACPI_TYPE_PACKAGE)
 221         {
 222             ACPI_ERROR ((AE_INFO, "Object not a Package, type %s",
 223                 AcpiUtGetObjectTypeName (SourceDesc)));
 224             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
 225         }
 226
 227         Status = AcpiDsGetPackageArguments (SourceDesc);
 228         if (ACPI_SUCCESS (Status))
 229         {
 230             /* Return an additional reference to the object */
 231
 232             ObjDesc = SourceDesc;
 233             AcpiUtAddReference (ObjDesc);
 234         }
 235         break;
 236
 237     case ACPI_TYPE_BUFFER:
 238
 239         if (SourceDesc->Common.Type != ACPI_TYPE_BUFFER)
 240         {
 241             ACPI_ERROR ((AE_INFO, "Object not a Buffer, type %s",
 242                 AcpiUtGetObjectTypeName (SourceDesc)));
 243             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
 244         }
 245
 246         Status = AcpiDsGetBufferArguments (SourceDesc);
 247         if (ACPI_SUCCESS (Status))
 248         {
 249             /* Return an additional reference to the object */
 250
 251             ObjDesc = SourceDesc;
 252             AcpiUtAddReference (ObjDesc);
 253         }
 254         break;
 255
 256     case ACPI_TYPE_STRING:
 257
 258         if (SourceDesc->Common.Type != ACPI_TYPE_STRING)
 259         {
 260             ACPI_ERROR ((AE_INFO, "Object not a String, type %s",
 261                 AcpiUtGetObjectTypeName (SourceDesc)));
 262             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
 263         }
 264
 265         /* Return an additional reference to the object */
 266
 267         ObjDesc = SourceDesc;
 268         AcpiUtAddReference (ObjDesc);
 269         break;
 270
 271     case ACPI_TYPE_INTEGER:
 272
 273         if (SourceDesc->Common.Type != ACPI_TYPE_INTEGER)
 274         {
 275             ACPI_ERROR ((AE_INFO, "Object not a Integer, type %s",
 276                 AcpiUtGetObjectTypeName (SourceDesc)));
 277             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
 278         }
 279
 280         /* Return an additional reference to the object */
 281
 282         ObjDesc = SourceDesc;
 283         AcpiUtAddReference (ObjDesc);
 284         break;
 285
 286     case ACPI_TYPE_BUFFER_FIELD:
 287     case ACPI_TYPE_LOCAL_REGION_FIELD:
 288     case ACPI_TYPE_LOCAL_BANK_FIELD:
 289     case ACPI_TYPE_LOCAL_INDEX_FIELD:
 290
 291         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
 292             "FieldRead Node=%p SourceDesc=%p Type=%X\n",
 293             Node, SourceDesc, EntryType));
 294
 295         Status = AcpiExReadDataFromField (WalkState, SourceDesc, &ObjDesc);
 296         break;
 297
 298     /* For these objects, just return the object attached to the Node */
 299
 300     case ACPI_TYPE_MUTEX:
 301     case ACPI_TYPE_POWER:
 302     case ACPI_TYPE_PROCESSOR:
 303     case ACPI_TYPE_EVENT:
 304     case ACPI_TYPE_REGION:
 305
 306         /* Return an additional reference to the object */
 307
 308         ObjDesc = SourceDesc;
 309         AcpiUtAddReference (ObjDesc);
 310         break;
 311
 312     /* TYPE_ANY is untyped, and thus there is no object associated with it */
 313
 314     case ACPI_TYPE_ANY:
 315
 316         ACPI_ERROR ((AE_INFO,
 317             "Untyped entry %p, no attached object!", Node));
 318
 319         return_ACPI_STATUS (AE_AML_OPERAND_TYPE);  /* Cannot be AE_TYPE */
 320
 321     case ACPI_TYPE_LOCAL_REFERENCE:
 322
 323         switch (SourceDesc->Reference.Class)
 324         {
 325         case ACPI_REFCLASS_TABLE:   /* This is a DdbHandle */
 326         case ACPI_REFCLASS_REFOF:
 327         case ACPI_REFCLASS_INDEX:
 328
 329             /* Return an additional reference to the object */
 330
 331             ObjDesc = SourceDesc;
 332             AcpiUtAddReference (ObjDesc);
 333             break;
 334
 335         default:
 336
 337             /* No named references are allowed here */
 338
 339             ACPI_ERROR ((AE_INFO,
 340                 "Unsupported Reference type 0x%X",
 341                 SourceDesc->Reference.Class));
 342
 343             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
 344         }
 345         break;
 346
 347     default:
 348
 349         /* Default case is for unknown types */
 350
 351         ACPI_ERROR ((AE_INFO,
 352             "Node %p - Unknown object type 0x%X",
 353             Node, EntryType));
 354
 355         return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
 356
 357     } /* switch (EntryType) */
 358
 359
 360     /* Return the object descriptor */
 361
 362     *ObjectPtr = (void *) ObjDesc;
 363     return_ACPI_STATUS (Status);
 364 }