sys/contrib/dev/acpica-unix-20050309/interpreter/executer/exresolv.c

   1
   2 /******************************************************************************
   3  *
   4  * Module Name: exresolv - AML Interpreter object resolution
   5  *              $Revision: 127 $
   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 __EXRESOLV_C__
 119
 120 #include "acpi.h"
 121 #include "amlcode.h"
 122 #include "acdispat.h"
 123 #include "acinterp.h"
 124 #include "acnamesp.h"
 125 #include "acparser.h"
 126
 127
 128 #define _COMPONENT          ACPI_EXECUTER
 129         ACPI_MODULE_NAME    ("exresolv")
 130
 131
 132 /*******************************************************************************
 133  *
 134  * FUNCTION:    AcpiExResolveToValue
 135  *
 136  * PARAMETERS:  **StackPtr          - Points to entry on ObjStack, which can
 137  *                                    be either an (ACPI_OPERAND_OBJECT *)
 138  *                                    or an ACPI_HANDLE.
 139  *              WalkState           - Current method state
 140  *
 141  * RETURN:      Status
 142  *
 143  * DESCRIPTION: Convert Reference objects to values
 144  *
 145  ******************************************************************************/
 146
 147 ACPI_STATUS
 148 AcpiExResolveToValue (
 149     ACPI_OPERAND_OBJECT     **StackPtr,
 150     ACPI_WALK_STATE         *WalkState)
 151 {
 152     ACPI_STATUS             Status;
 153
 154
 155     ACPI_FUNCTION_TRACE_PTR ("ExResolveToValue", StackPtr);
 156
 157
 158     if (!StackPtr || !*StackPtr)
 159     {
 160         ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Internal - null pointer\n"));
 161         return_ACPI_STATUS (AE_AML_NO_OPERAND);
 162     }
 163
 164     /*
 165      * The entity pointed to by the StackPtr can be either
 166      * 1) A valid ACPI_OPERAND_OBJECT, or
 167      * 2) A ACPI_NAMESPACE_NODE (NamedObj)
 168      */
 169     if (ACPI_GET_DESCRIPTOR_TYPE (*StackPtr) == ACPI_DESC_TYPE_OPERAND)
 170     {
 171         Status = AcpiExResolveObjectToValue (StackPtr, WalkState);
 172         if (ACPI_FAILURE (Status))
 173         {
 174             return_ACPI_STATUS (Status);
 175         }
 176     }
 177
 178     /*
 179      * Object on the stack may have changed if AcpiExResolveObjectToValue()
 180      * was called (i.e., we can't use an _else_ here.)
 181      */
 182     if (ACPI_GET_DESCRIPTOR_TYPE (*StackPtr) == ACPI_DESC_TYPE_NAMED)
 183     {
 184         Status = AcpiExResolveNodeToValue (
 185                         ACPI_CAST_INDIRECT_PTR (ACPI_NAMESPACE_NODE, StackPtr),
 186                         WalkState);
 187         if (ACPI_FAILURE (Status))
 188         {
 189             return_ACPI_STATUS (Status);
 190         }
 191     }
 192
 193     ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Resolved object %p\n", *StackPtr));
 194     return_ACPI_STATUS (AE_OK);
 195 }
 196
 197
 198 /*******************************************************************************
 199  *
 200  * FUNCTION:    AcpiExResolveObjectToValue
 201  *
 202  * PARAMETERS:  StackPtr        - Pointer to a stack location that contains a
 203  *                                ptr to an internal object.
 204  *              WalkState       - Current method state
 205  *
 206  * RETURN:      Status
 207  *
 208  * DESCRIPTION: Retrieve the value from an internal object.  The Reference type
 209  *              uses the associated AML opcode to determine the value.
 210  *
 211  ******************************************************************************/
 212
 213 ACPI_STATUS
 214 AcpiExResolveObjectToValue (
 215     ACPI_OPERAND_OBJECT     **StackPtr,
 216     ACPI_WALK_STATE         *WalkState)
 217 {
 218     ACPI_STATUS             Status = AE_OK;
 219     ACPI_OPERAND_OBJECT     *StackDesc;
 220     void                    *TempNode;
 221     ACPI_OPERAND_OBJECT     *ObjDesc;
 222     UINT16                  Opcode;
 223
 224
 225     ACPI_FUNCTION_TRACE ("ExResolveObjectToValue");
 226
 227
 228     StackDesc = *StackPtr;
 229
 230     /* This is an ACPI_OPERAND_OBJECT  */
 231
 232     switch (ACPI_GET_OBJECT_TYPE (StackDesc))
 233     {
 234     case ACPI_TYPE_LOCAL_REFERENCE:
 235
 236         Opcode = StackDesc->Reference.Opcode;
 237
 238         switch (Opcode)
 239         {
 240         case AML_NAME_OP:
 241
 242             /*
 243              * Convert indirect name ptr to a direct name ptr.
 244              * Then, AcpiExResolveNodeToValue can be used to get the value
 245              */
 246             TempNode = StackDesc->Reference.Object;
 247
 248             /* Delete the Reference Object */
 249
 250             AcpiUtRemoveReference (StackDesc);
 251
 252             /* Put direct name pointer onto stack and exit */
 253
 254             (*StackPtr) = TempNode;
 255             break;
 256
 257
 258         case AML_LOCAL_OP:
 259         case AML_ARG_OP:
 260
 261             /*
 262              * Get the local from the method's state info
 263              * Note: this increments the local's object reference count
 264              */
 265             Status = AcpiDsMethodDataGetValue (Opcode,
 266                             StackDesc->Reference.Offset, WalkState, &ObjDesc);
 267             if (ACPI_FAILURE (Status))
 268             {
 269                 return_ACPI_STATUS (Status);
 270             }
 271
 272             ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[Arg/Local %X] ValueObj is %p\n",
 273                 StackDesc->Reference.Offset, ObjDesc));
 274
 275             /*
 276              * Now we can delete the original Reference Object and
 277              * replace it with the resolved value
 278              */
 279             AcpiUtRemoveReference (StackDesc);
 280             *StackPtr = ObjDesc;
 281             break;
 282
 283
 284         case AML_INDEX_OP:
 285
 286             switch (StackDesc->Reference.TargetType)
 287             {
 288             case ACPI_TYPE_BUFFER_FIELD:
 289
 290                 /* Just return - leave the Reference on the stack */
 291                 break;
 292
 293
 294             case ACPI_TYPE_PACKAGE:
 295
 296                 ObjDesc = *StackDesc->Reference.Where;
 297                 if (ObjDesc)
 298                 {
 299                     /*
 300                      * Valid obj descriptor, copy pointer to return value
 301                      * (i.e., dereference the package index)
 302                      * Delete the ref object, increment the returned object
 303                      */
 304                     AcpiUtRemoveReference (StackDesc);
 305                     AcpiUtAddReference (ObjDesc);
 306                     *StackPtr = ObjDesc;
 307                 }
 308                 else
 309                 {
 310                     /*
 311                      * A NULL object descriptor means an unitialized element of
 312                      * the package, can't dereference it
 313                      */
 314                     ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
 315                         "Attempt to deref an Index to NULL pkg element Idx=%p\n",
 316                         StackDesc));
 317                     Status = AE_AML_UNINITIALIZED_ELEMENT;
 318                 }
 319                 break;
 320
 321
 322             default:
 323
 324                 /* Invalid reference object */
 325
 326                 ACPI_REPORT_ERROR ((
 327                     "During resolve, Unknown TargetType %X in Index/Reference obj %p\n",
 328                     StackDesc->Reference.TargetType, StackDesc));
 329                 Status = AE_AML_INTERNAL;
 330                 break;
 331             }
 332             break;
 333
 334
 335         case AML_REF_OF_OP:
 336         case AML_DEBUG_OP:
 337         case AML_LOAD_OP:
 338
 339             /* Just leave the object as-is */
 340
 341             break;
 342
 343
 344         default:
 345
 346             ACPI_REPORT_ERROR (("During resolve, Unknown Reference opcode %X (%s) in %p\n",
 347                 Opcode, AcpiPsGetOpcodeName (Opcode), StackDesc));
 348             Status = AE_AML_INTERNAL;
 349             break;
 350         }
 351         break;
 352
 353
 354     case ACPI_TYPE_BUFFER:
 355
 356         Status = AcpiDsGetBufferArguments (StackDesc);
 357         break;
 358
 359
 360     case ACPI_TYPE_PACKAGE:
 361
 362         Status = AcpiDsGetPackageArguments (StackDesc);
 363         break;
 364
 365
 366     /*
 367      * These cases may never happen here, but just in case..
 368      */
 369     case ACPI_TYPE_BUFFER_FIELD:
 370     case ACPI_TYPE_LOCAL_REGION_FIELD:
 371     case ACPI_TYPE_LOCAL_BANK_FIELD:
 372     case ACPI_TYPE_LOCAL_INDEX_FIELD:
 373
 374         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "FieldRead SourceDesc=%p Type=%X\n",
 375             StackDesc, ACPI_GET_OBJECT_TYPE (StackDesc)));
 376
 377         Status = AcpiExReadDataFromField (WalkState, StackDesc, &ObjDesc);
 378         *StackPtr = (void *) ObjDesc;
 379         break;
 380
 381     default:
 382         break;
 383     }
 384
 385     return_ACPI_STATUS (Status);
 386 }
 387
 388
 389 /*******************************************************************************
 390  *
 391  * FUNCTION:    AcpiExResolveMultiple
 392  *
 393  * PARAMETERS:  WalkState           - Current state (contains AML opcode)
 394  *              Operand             - Starting point for resolution
 395  *              ReturnType          - Where the object type is returned
 396  *              ReturnDesc          - Where the resolved object is returned
 397  *
 398  * RETURN:      Status
 399  *
 400  * DESCRIPTION: Return the base object and type.  Traverse a reference list if
 401  *              necessary to get to the base object.
 402  *
 403  ******************************************************************************/
 404
 405 ACPI_STATUS
 406 AcpiExResolveMultiple (
 407     ACPI_WALK_STATE         *WalkState,
 408     ACPI_OPERAND_OBJECT     *Operand,
 409     ACPI_OBJECT_TYPE        *ReturnType,
 410     ACPI_OPERAND_OBJECT     **ReturnDesc)
 411 {
 412     ACPI_OPERAND_OBJECT     *ObjDesc = (void *) Operand;
 413     ACPI_NAMESPACE_NODE     *Node;
 414     ACPI_OBJECT_TYPE        Type;
 415     ACPI_STATUS             Status;
 416
 417
 418     ACPI_FUNCTION_TRACE ("AcpiExResolveMultiple");
 419
 420
 421     /*
 422      * Operand can be either a namespace node or an operand descriptor
 423      */
 424     switch (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc))
 425     {
 426     case ACPI_DESC_TYPE_OPERAND:
 427         Type = ObjDesc->Common.Type;
 428         break;
 429
 430     case ACPI_DESC_TYPE_NAMED:
 431         Type = ((ACPI_NAMESPACE_NODE *) ObjDesc)->Type;
 432         ObjDesc = AcpiNsGetAttachedObject ((ACPI_NAMESPACE_NODE *) ObjDesc);
 433
 434         /* If we had an Alias node, use the attached object for type info */
 435
 436         if (Type == ACPI_TYPE_LOCAL_ALIAS)
 437         {
 438             Type = ((ACPI_NAMESPACE_NODE *) ObjDesc)->Type;
 439             ObjDesc = AcpiNsGetAttachedObject ((ACPI_NAMESPACE_NODE *) ObjDesc);
 440         }
 441         break;
 442
 443     default:
 444         return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
 445     }
 446
 447
 448     /*
 449      * If type is anything other than a reference, we are done
 450      */
 451     if (Type != ACPI_TYPE_LOCAL_REFERENCE)
 452     {
 453         goto Exit;
 454     }
 455
 456     /*
 457      * For reference objects created via the RefOf or Index operators,
 458      * we need to get to the base object (as per the ACPI specification
 459      * of the ObjectType and SizeOf operators).  This means traversing
 460      * the list of possibly many nested references.
 461      */
 462     while (ACPI_GET_OBJECT_TYPE (ObjDesc) == ACPI_TYPE_LOCAL_REFERENCE)
 463     {
 464         switch (ObjDesc->Reference.Opcode)
 465         {
 466         case AML_REF_OF_OP:
 467
 468             /* Dereference the reference pointer */
 469
 470             Node = ObjDesc->Reference.Object;
 471
 472             /* All "References" point to a NS node */
 473
 474             if (ACPI_GET_DESCRIPTOR_TYPE (Node) != ACPI_DESC_TYPE_NAMED)
 475             {
 476                 ACPI_REPORT_ERROR (("AcpiExResolveMultiple: Not a NS node %p [%s]\n",
 477                         Node, AcpiUtGetDescriptorName (Node)));
 478                 return_ACPI_STATUS (AE_AML_INTERNAL);
 479             }
 480
 481             /* Get the attached object */
 482
 483             ObjDesc = AcpiNsGetAttachedObject (Node);
 484             if (!ObjDesc)
 485             {
 486                 /* No object, use the NS node type */
 487
 488                 Type = AcpiNsGetType (Node);
 489                 goto Exit;
 490             }
 491
 492             /* Check for circular references */
 493
 494             if (ObjDesc == Operand)
 495             {
 496                 return_ACPI_STATUS (AE_AML_CIRCULAR_REFERENCE);
 497             }
 498             break;
 499
 500
 501         case AML_INDEX_OP:
 502
 503             /* Get the type of this reference (index into another object) */
 504
 505             Type = ObjDesc->Reference.TargetType;
 506             if (Type != ACPI_TYPE_PACKAGE)
 507             {
 508                 goto Exit;
 509             }
 510
 511             /*
 512              * The main object is a package, we want to get the type
 513              * of the individual package element that is referenced by
 514              * the index.
 515              *
 516              * This could of course in turn be another reference object.
 517              */
 518             ObjDesc = *(ObjDesc->Reference.Where);
 519             if (!ObjDesc)
 520             {
 521                 /* NULL package elements are allowed */
 522
 523                 Type = 0; /* Uninitialized */
 524                 goto Exit;
 525             }
 526             break;
 527
 528
 529         case AML_INT_NAMEPATH_OP:
 530
 531             /* Dereference the reference pointer */
 532
 533             Node = ObjDesc->Reference.Node;
 534
 535             /* All "References" point to a NS node */
 536
 537             if (ACPI_GET_DESCRIPTOR_TYPE (Node) != ACPI_DESC_TYPE_NAMED)
 538             {
 539                 ACPI_REPORT_ERROR (("AcpiExResolveMultiple: Not a NS node %p [%s]\n",
 540                         Node, AcpiUtGetDescriptorName (Node)));
 541                return_ACPI_STATUS (AE_AML_INTERNAL);
 542             }
 543
 544             /* Get the attached object */
 545
 546             ObjDesc = AcpiNsGetAttachedObject (Node);
 547             if (!ObjDesc)
 548             {
 549                 /* No object, use the NS node type */
 550
 551                 Type = AcpiNsGetType (Node);
 552                 goto Exit;
 553             }
 554
 555             /* Check for circular references */
 556
 557             if (ObjDesc == Operand)
 558             {
 559                 return_ACPI_STATUS (AE_AML_CIRCULAR_REFERENCE);
 560             }
 561             break;
 562
 563
 564         case AML_LOCAL_OP:
 565         case AML_ARG_OP:
 566
 567             if (ReturnDesc)
 568             {
 569                 Status = AcpiDsMethodDataGetValue (ObjDesc->Reference.Opcode,
 570                                 ObjDesc->Reference.Offset, WalkState, &ObjDesc);
 571                 if (ACPI_FAILURE (Status))
 572                 {
 573                     return_ACPI_STATUS (Status);
 574                 }
 575                 AcpiUtRemoveReference (ObjDesc);
 576             }
 577             else
 578             {
 579                 Status = AcpiDsMethodDataGetNode (ObjDesc->Reference.Opcode,
 580                             ObjDesc->Reference.Offset, WalkState, &Node);
 581                 if (ACPI_FAILURE (Status))
 582                 {
 583                     return_ACPI_STATUS (Status);
 584                 }
 585
 586                 ObjDesc = AcpiNsGetAttachedObject (Node);
 587                 if (!ObjDesc)
 588                 {
 589                     Type = ACPI_TYPE_ANY;
 590                     goto Exit;
 591                 }
 592             }
 593             break;
 594
 595
 596         case AML_DEBUG_OP:
 597
 598             /* The Debug Object is of type "DebugObject" */
 599
 600             Type = ACPI_TYPE_DEBUG_OBJECT;
 601             goto Exit;
 602
 603
 604         default:
 605
 606             ACPI_REPORT_ERROR (("AcpiExResolveMultiple: Unknown Reference subtype %X\n",
 607                 ObjDesc->Reference.Opcode));
 608             return_ACPI_STATUS (AE_AML_INTERNAL);
 609         }
 610     }
 611
 612     /*
 613      * Now we are guaranteed to have an object that has not been created
 614      * via the RefOf or Index operators.
 615      */
 616     Type = ACPI_GET_OBJECT_TYPE (ObjDesc);
 617
 618
 619 Exit:
 620     /* Convert internal types to external types */
 621
 622     switch (Type)
 623     {
 624     case ACPI_TYPE_LOCAL_REGION_FIELD:
 625     case ACPI_TYPE_LOCAL_BANK_FIELD:
 626     case ACPI_TYPE_LOCAL_INDEX_FIELD:
 627
 628         Type = ACPI_TYPE_FIELD_UNIT;
 629         break;
 630
 631     case ACPI_TYPE_LOCAL_SCOPE:
 632
 633         /* Per ACPI Specification, Scope is untyped */
 634
 635         Type = ACPI_TYPE_ANY;
 636         break;
 637
 638     default:
 639         /* No change to Type required */
 640         break;
 641     }
 642
 643     *ReturnType = Type;
 644     if (ReturnDesc)
 645     {
 646         *ReturnDesc = ObjDesc;
 647     }
 648     return_ACPI_STATUS (AE_OK);
 649 }
 650
 651