sys/contrib/dev/acpica-unix-20050211/interpreter/executer/exresnte.c

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