sys/contrib/dev/acpica/executer/exresnte.c

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