sys/contrib/dev/acpica/exresnte.c

   1
   2 /******************************************************************************
   3  *
   4  * Module Name: exresnte - AML Interpreter object resolution
   5  *              $Revision: 62 $
   6  *
   7  *****************************************************************************/
   8
   9 /******************************************************************************
  10  *
  11  * 1. Copyright Notice
  12  *
  13  * Some or all of this work - Copyright (c) 1999 - 2003, 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 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/exresnte.c,v 1.1 2003/09/24 03:32:16 drhodus Exp $                                                               */
 118
 119 #define __EXRESNTE_C__
 120
 121 #include "acpi.h"
 122 #include "acdispat.h"
 123 #include "acinterp.h"
 124 #include "acnamesp.h"
 125
 126
 127 #define _COMPONENT          ACPI_EXECUTER
 128         ACPI_MODULE_NAME    ("exresnte")
 129
 130
 131 /*******************************************************************************
 132  *
 133  * FUNCTION:    AcpiExResolveNodeToValue
 134  *
 135  * PARAMETERS:  ObjectPtr       - Pointer to a location that contains
 136  *                                a pointer to a NS node, and will receive a
 137  *                                pointer to the resolved object.
 138  *              WalkState       - Current state.  Valid only if executing AML
 139  *                                code.  NULL if simply resolving an object
 140  *
 141  * RETURN:      Status
 142  *
 143  * DESCRIPTION: Resolve a Namespace node to a valued object
 144  *
 145  * Note: for some of the data types, the pointer attached to the Node
 146  * can be either a pointer to an actual internal object or a pointer into the
 147  * AML stream itself.  These types are currently:
 148  *
 149  *      ACPI_TYPE_INTEGER
 150  *      ACPI_TYPE_STRING
 151  *      ACPI_TYPE_BUFFER
 152  *      ACPI_TYPE_MUTEX
 153  *      ACPI_TYPE_PACKAGE
 154  *
 155  ******************************************************************************/
 156
 157 ACPI_STATUS
 158 AcpiExResolveNodeToValue (
 159     ACPI_NAMESPACE_NODE     **ObjectPtr,
 160     ACPI_WALK_STATE         *WalkState)
 161
 162 {
 163     ACPI_STATUS             Status = AE_OK;
 164     ACPI_OPERAND_OBJECT     *SourceDesc;
 165     ACPI_OPERAND_OBJECT     *ObjDesc = NULL;
 166     ACPI_NAMESPACE_NODE     *Node;
 167     ACPI_OBJECT_TYPE        EntryType;
 168
 169
 170     ACPI_FUNCTION_TRACE ("ExResolveNodeToValue");
 171
 172
 173     /*
 174      * The stack pointer points to a ACPI_NAMESPACE_NODE (Node).  Get the
 175      * object that is attached to the Node.
 176      */
 177     Node       = *ObjectPtr;
 178     SourceDesc = AcpiNsGetAttachedObject (Node);
 179     EntryType  = AcpiNsGetType ((ACPI_HANDLE) Node);
 180
 181     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Entry=%p SourceDesc=%p [%s]\n",
 182          Node, SourceDesc, AcpiUtGetTypeName (EntryType)));
 183
 184     if (EntryType == ACPI_TYPE_LOCAL_ALIAS)
 185     {
 186         /* There is always exactly one level of indirection */
 187
 188         Node       = (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) Devices rarely have an attached object, return the Node
 197      * 2) Method locals and arguments have a pseudo-Node
 198      */
 199     if (EntryType == ACPI_TYPE_DEVICE ||
 200         (Node->Flags & (ANOBJ_METHOD_ARG | ANOBJ_METHOD_LOCAL)))
 201     {
 202         return_ACPI_STATUS (AE_OK);
 203     }
 204
 205     if (!SourceDesc)
 206     {
 207         ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "No object attached to node %p\n",
 208             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 (ACPI_GET_OBJECT_TYPE (SourceDesc) != ACPI_TYPE_PACKAGE)
 221         {
 222             ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Object not a Package, type %s\n",
 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
 238     case ACPI_TYPE_BUFFER:
 239
 240         if (ACPI_GET_OBJECT_TYPE (SourceDesc) != ACPI_TYPE_BUFFER)
 241         {
 242             ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Object not a Buffer, type %s\n",
 243                 AcpiUtGetObjectTypeName (SourceDesc)));
 244             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
 245         }
 246
 247         Status = AcpiDsGetBufferArguments (SourceDesc);
 248         if (ACPI_SUCCESS (Status))
 249         {
 250             /* Return an additional reference to the object */
 251
 252             ObjDesc = SourceDesc;
 253             AcpiUtAddReference (ObjDesc);
 254         }
 255         break;
 256
 257
 258     case ACPI_TYPE_STRING:
 259
 260         if (ACPI_GET_OBJECT_TYPE (SourceDesc) != ACPI_TYPE_STRING)
 261         {
 262             ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Object not a String, type %s\n",
 263                 AcpiUtGetObjectTypeName (SourceDesc)));
 264             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
 265         }
 266
 267         /* Return an additional reference to the object */
 268
 269         ObjDesc = SourceDesc;
 270         AcpiUtAddReference (ObjDesc);
 271         break;
 272
 273
 274     case ACPI_TYPE_INTEGER:
 275
 276         if (ACPI_GET_OBJECT_TYPE (SourceDesc) != ACPI_TYPE_INTEGER)
 277         {
 278             ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Object not a Integer, type %s\n",
 279                 AcpiUtGetObjectTypeName (SourceDesc)));
 280             return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
 281         }
 282
 283         /* Return an additional reference to the object */
 284
 285         ObjDesc = SourceDesc;
 286         AcpiUtAddReference (ObjDesc);
 287         break;
 288
 289
 290     case ACPI_TYPE_BUFFER_FIELD:
 291     case ACPI_TYPE_LOCAL_REGION_FIELD:
 292     case ACPI_TYPE_LOCAL_BANK_FIELD:
 293     case ACPI_TYPE_LOCAL_INDEX_FIELD:
 294
 295         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "FieldRead Node=%p SourceDesc=%p Type=%X\n",
 296             Node, SourceDesc, EntryType));
 297
 298         Status = AcpiExReadDataFromField (WalkState, SourceDesc, &ObjDesc);
 299         break;
 300
 301     /*
 302      * For these objects, just return the object attached to the Node
 303      */
 304     case ACPI_TYPE_MUTEX:
 305     case ACPI_TYPE_METHOD:
 306     case ACPI_TYPE_POWER:
 307     case ACPI_TYPE_PROCESSOR:
 308     case ACPI_TYPE_THERMAL:
 309     case ACPI_TYPE_EVENT:
 310     case ACPI_TYPE_REGION:
 311
 312         /* Return an additional reference to the object */
 313
 314         ObjDesc = SourceDesc;
 315         AcpiUtAddReference (ObjDesc);
 316         break;
 317
 318
 319     /* TYPE_ANY is untyped, and thus there is no object associated with it */
 320
 321     case ACPI_TYPE_ANY:
 322
 323         ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Untyped entry %p, no attached object!\n",
 324             Node));
 325
 326         return_ACPI_STATUS (AE_AML_OPERAND_TYPE);  /* Cannot be AE_TYPE */
 327
 328
 329     case ACPI_TYPE_LOCAL_REFERENCE:
 330
 331         /* No named references are allowed here */
 332
 333         ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Unsupported Reference opcode %X\n",
 334             SourceDesc->Reference.Opcode));
 335
 336         return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
 337
 338
 339     /* Default case is for unknown types */
 340
 341     default:
 342
 343         ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Node %p - Unknown object type %X\n",
 344             Node, EntryType));
 345
 346         return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
 347
 348     } /* switch (EntryType) */
 349
 350
 351     /* Put the object descriptor on the stack */
 352
 353     *ObjectPtr = (void *) ObjDesc;
 354     return_ACPI_STATUS (Status);
 355 }
 356
 357