sys/contrib/dev/acpica/exresolv.c

   1
   2 /******************************************************************************
   3  *
   4  * Module Name: exresolv - AML Interpreter object resolution
   5  *              $Revision: 119 $
   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/exresolv.c,v 1.1 2003/09/24 03:32:16 drhodus Exp $                                                               */
 118
 119 #define __EXRESOLV_C__
 120
 121 #include "acpi.h"
 122 #include "amlcode.h"
 123 #include "acdispat.h"
 124 #include "acinterp.h"
 125 #include "acnamesp.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             /*
 273              * Now we can delete the original Reference Object and
 274              * replace it with the resolve value
 275              */
 276             AcpiUtRemoveReference (StackDesc);
 277             *StackPtr = ObjDesc;
 278
 279             ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[Arg/Local %d] ValueObj is %p\n",
 280                 StackDesc->Reference.Offset, 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_DEBUG_PRINT ((ACPI_DB_ERROR,
 327                     "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
 338             /* Just leave the object as-is */
 339
 340             break;
 341
 342
 343         default:
 344
 345             ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Unknown Reference opcode %X in %p\n",
 346                 Opcode, StackDesc));
 347             Status = AE_AML_INTERNAL;
 348             break;
 349         }
 350         break;
 351
 352
 353     case ACPI_TYPE_BUFFER:
 354
 355         Status = AcpiDsGetBufferArguments (StackDesc);
 356         break;
 357
 358
 359     case ACPI_TYPE_PACKAGE:
 360
 361         Status = AcpiDsGetPackageArguments (StackDesc);
 362         break;
 363
 364
 365     /*
 366      * These cases may never happen here, but just in case..
 367      */
 368     case ACPI_TYPE_BUFFER_FIELD:
 369     case ACPI_TYPE_LOCAL_REGION_FIELD:
 370     case ACPI_TYPE_LOCAL_BANK_FIELD:
 371     case ACPI_TYPE_LOCAL_INDEX_FIELD:
 372
 373         ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "FieldRead SourceDesc=%p Type=%X\n",
 374             StackDesc, ACPI_GET_OBJECT_TYPE (StackDesc)));
 375
 376         Status = AcpiExReadDataFromField (WalkState, StackDesc, &ObjDesc);
 377         *StackPtr = (void *) ObjDesc;
 378         break;
 379
 380     default:
 381         break;
 382     }
 383
 384     return_ACPI_STATUS (Status);
 385 }
 386
 387
 388 /*******************************************************************************
 389  *
 390  * FUNCTION:    AcpiExResolveMultiple
 391  *
 392  * PARAMETERS:  WalkState           - Current state (contains AML opcode)
 393  *              Operand             - Starting point for resolution
 394  *              ReturnType          - Where the object type is returned
 395  *              ReturnDesc          - Where the resolved object is returned
 396  *
 397  * RETURN:      Status
 398  *
 399  * DESCRIPTION: Return the base object and type.  Traverse a reference list if
 400  *              necessary to get to the base object.
 401  *
 402  ******************************************************************************/
 403
 404 ACPI_STATUS
 405 AcpiExResolveMultiple (
 406     ACPI_WALK_STATE         *WalkState,
 407     ACPI_OPERAND_OBJECT     *Operand,
 408     ACPI_OBJECT_TYPE        *ReturnType,
 409     ACPI_OPERAND_OBJECT     **ReturnDesc)
 410 {
 411     ACPI_OPERAND_OBJECT     *ObjDesc = (void *) Operand;
 412     ACPI_NAMESPACE_NODE     *Node;
 413     ACPI_OBJECT_TYPE        Type;
 414
 415
 416     ACPI_FUNCTION_TRACE ("AcpiExResolveMultiple");
 417
 418
 419     /*
 420      * For reference objects created via the RefOf or Index operators,
 421      * we need to get to the base object (as per the ACPI specification
 422      * of the ObjectType and SizeOf operators).  This means traversing
 423      * the list of possibly many nested references.
 424      */
 425     while (ACPI_GET_OBJECT_TYPE (ObjDesc) == ACPI_TYPE_LOCAL_REFERENCE)
 426     {
 427         switch (ObjDesc->Reference.Opcode)
 428         {
 429         case AML_REF_OF_OP:
 430
 431             /* Dereference the reference pointer */
 432
 433             Node = ObjDesc->Reference.Object;
 434
 435             /* All "References" point to a NS node */
 436
 437             if (ACPI_GET_DESCRIPTOR_TYPE (Node) != ACPI_DESC_TYPE_NAMED)
 438             {
 439                 return_ACPI_STATUS (AE_AML_INTERNAL);
 440             }
 441
 442             /* Get the attached object */
 443
 444             ObjDesc = AcpiNsGetAttachedObject (Node);
 445             if (!ObjDesc)
 446             {
 447                 /* No object, use the NS node type */
 448
 449                 Type = AcpiNsGetType (Node);
 450                 goto Exit;
 451             }
 452
 453             /* Check for circular references */
 454
 455             if (ObjDesc == Operand)
 456             {
 457                 return_ACPI_STATUS (AE_AML_CIRCULAR_REFERENCE);
 458             }
 459             break;
 460
 461
 462         case AML_INDEX_OP:
 463
 464             /* Get the type of this reference (index into another object) */
 465
 466             Type = ObjDesc->Reference.TargetType;
 467             if (Type != ACPI_TYPE_PACKAGE)
 468             {
 469                 goto Exit;
 470             }
 471
 472             /*
 473              * The main object is a package, we want to get the type
 474              * of the individual package element that is referenced by
 475              * the index.
 476              *
 477              * This could of course in turn be another reference object.
 478              */
 479             ObjDesc = *(ObjDesc->Reference.Where);
 480             break;
 481
 482
 483         case AML_INT_NAMEPATH_OP:
 484
 485             /* Dereference the reference pointer */
 486
 487             Node = ObjDesc->Reference.Node;
 488
 489             /* All "References" point to a NS node */
 490
 491             if (ACPI_GET_DESCRIPTOR_TYPE (Node) != ACPI_DESC_TYPE_NAMED)
 492             {
 493                 return_ACPI_STATUS (AE_AML_INTERNAL);
 494             }
 495
 496             /* Get the attached object */
 497
 498             ObjDesc = AcpiNsGetAttachedObject (Node);
 499             if (!ObjDesc)
 500             {
 501                 /* No object, use the NS node type */
 502
 503                 Type = AcpiNsGetType (Node);
 504                 goto Exit;
 505             }
 506
 507             /* Check for circular references */
 508
 509             if (ObjDesc == Operand)
 510             {
 511                 return_ACPI_STATUS (AE_AML_CIRCULAR_REFERENCE);
 512             }
 513             break;
 514
 515
 516         case AML_DEBUG_OP:
 517
 518             /* The Debug Object is of type "DebugObject" */
 519
 520             Type = ACPI_TYPE_DEBUG_OBJECT;
 521             goto Exit;
 522
 523
 524         default:
 525
 526             ACPI_REPORT_ERROR (("AcpiExResolveMultiple: Unknown Reference subtype %X\n",
 527                 ObjDesc->Reference.Opcode));
 528             return_ACPI_STATUS (AE_AML_INTERNAL);
 529         }
 530     }
 531
 532     /*
 533      * Now we are guaranteed to have an object that has not been created
 534      * via the RefOf or Index operators.
 535      */
 536     Type = ACPI_GET_OBJECT_TYPE (ObjDesc);
 537
 538
 539 Exit:
 540     /* Convert internal types to external types */
 541
 542     switch (Type)
 543     {
 544     case ACPI_TYPE_LOCAL_REGION_FIELD:
 545     case ACPI_TYPE_LOCAL_BANK_FIELD:
 546     case ACPI_TYPE_LOCAL_INDEX_FIELD:
 547
 548         Type = ACPI_TYPE_FIELD_UNIT;
 549         break;
 550
 551     case ACPI_TYPE_LOCAL_SCOPE:
 552
 553         /* Per ACPI Specification, Scope is untyped */
 554
 555         Type = ACPI_TYPE_ANY;
 556         break;
 557
 558     default:
 559         /* No change to Type required */
 560         break;
 561     }
 562
 563     *ReturnType = Type;
 564     if (ReturnDesc)
 565     {
 566         *ReturnDesc = ObjDesc;
 567     }
 568     return_ACPI_STATUS (AE_OK);
 569 }
 570
 571