1 /****************************************************************************** 2 * 3 * Module Name: exresolv - AML Interpreter object resolution 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2016, Intel Corp. 12 * All rights reserved. 13 * 14 * 2. License 15 * 16 * 2.1. This is your license from Intel Corp. under its intellectual property 17 * rights. You may have additional license terms from the party that provided 18 * you this software, covering your right to use that party's intellectual 19 * property rights. 20 * 21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 22 * copy of the source code appearing in this file ("Covered Code") an 23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 24 * base code distributed originally by Intel ("Original Intel Code") to copy, 25 * make derivatives, distribute, use and display any portion of the Covered 26 * Code in any form, with the right to sublicense such rights; and 27 * 28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 29 * license (with the right to sublicense), under only those claims of Intel 30 * patents that are infringed by the Original Intel Code, to make, use, sell, 31 * offer to sell, and import the Covered Code and derivative works thereof 32 * solely to the minimum extent necessary to exercise the above copyright 33 * license, and in no event shall the patent license extend to any additions 34 * to or modifications of the Original Intel Code. No other license or right 35 * is granted directly or by implication, estoppel or otherwise; 36 * 37 * The above copyright and patent license is granted only if the following 38 * conditions are met: 39 * 40 * 3. Conditions 41 * 42 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 43 * Redistribution of source code of any substantial portion of the Covered 44 * Code or modification with rights to further distribute source must include 45 * the above Copyright Notice, the above License, this list of Conditions, 46 * and the following Disclaimer and Export Compliance provision. In addition, 47 * Licensee must cause all Covered Code to which Licensee contributes to 48 * contain a file documenting the changes Licensee made to create that Covered 49 * Code and the date of any change. Licensee must include in that file the 50 * documentation of any changes made by any predecessor Licensee. Licensee 51 * must include a prominent statement that the modification is derived, 52 * directly or indirectly, from Original Intel Code. 53 * 54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 55 * Redistribution of source code of any substantial portion of the Covered 56 * Code or modification without rights to further distribute source must 57 * include the following Disclaimer and Export Compliance provision in the 58 * documentation and/or other materials provided with distribution. In 59 * addition, Licensee may not authorize further sublicense of source of any 60 * portion of the Covered Code, and must include terms to the effect that the 61 * license from Licensee to its licensee is limited to the intellectual 62 * property embodied in the software Licensee provides to its licensee, and 63 * not to intellectual property embodied in modifications its licensee may 64 * make. 65 * 66 * 3.3. Redistribution of Executable. Redistribution in executable form of any 67 * substantial portion of the Covered Code or modification must reproduce the 68 * above Copyright Notice, and the following Disclaimer and Export Compliance 69 * provision in the documentation and/or other materials provided with the 70 * distribution. 71 * 72 * 3.4. Intel retains all right, title, and interest in and to the Original 73 * Intel Code. 74 * 75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 76 * Intel shall be used in advertising or otherwise to promote the sale, use or 77 * other dealings in products derived from or relating to the Covered Code 78 * without prior written authorization from Intel. 79 * 80 * 4. Disclaimer and Export Compliance 81 * 82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 88 * PARTICULAR PURPOSE. 89 * 90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 97 * LIMITED REMEDY. 98 * 99 * 4.3. Licensee shall not export, either directly or indirectly, any of this 100 * software or system incorporating such software without first obtaining any 101 * required license or other approval from the U. S. Department of Commerce or 102 * any other agency or department of the United States Government. In the 103 * event Licensee exports any such software from the United States or 104 * re-exports any such software from a foreign destination, Licensee shall 105 * ensure that the distribution and export/re-export of the software is in 106 * compliance with all laws, regulations, orders, or other restrictions of the 107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 108 * any of its subsidiaries will export/re-export any technical data, process, 109 * software, or service, directly or indirectly, to any country for which the 110 * United States government or any agency thereof requires an export license, 111 * other governmental approval, or letter of assurance, without first obtaining 112 * such license, approval or letter. 113 * 114 *****************************************************************************/ 115 116 #include "acpi.h" 117 #include "accommon.h" 118 #include "amlcode.h" 119 #include "acdispat.h" 120 #include "acinterp.h" 121 #include "acnamesp.h" 122 123 124 #define _COMPONENT ACPI_EXECUTER 125 ACPI_MODULE_NAME ("exresolv") 126 127 /* Local prototypes */ 128 129 static ACPI_STATUS 130 AcpiExResolveObjectToValue ( 131 ACPI_OPERAND_OBJECT **StackPtr, 132 ACPI_WALK_STATE *WalkState); 133 134 135 /******************************************************************************* 136 * 137 * FUNCTION: AcpiExResolveToValue 138 * 139 * PARAMETERS: **StackPtr - Points to entry on ObjStack, which can 140 * be either an (ACPI_OPERAND_OBJECT *) 141 * or an ACPI_HANDLE. 142 * WalkState - Current method state 143 * 144 * RETURN: Status 145 * 146 * DESCRIPTION: Convert Reference objects to values 147 * 148 ******************************************************************************/ 149 150 ACPI_STATUS 151 AcpiExResolveToValue ( 152 ACPI_OPERAND_OBJECT **StackPtr, 153 ACPI_WALK_STATE *WalkState) 154 { 155 ACPI_STATUS Status; 156 157 158 ACPI_FUNCTION_TRACE_PTR (ExResolveToValue, StackPtr); 159 160 161 if (!StackPtr || !*StackPtr) 162 { 163 ACPI_ERROR ((AE_INFO, "Internal - null pointer")); 164 return_ACPI_STATUS (AE_AML_NO_OPERAND); 165 } 166 167 /* 168 * The entity pointed to by the StackPtr can be either 169 * 1) A valid ACPI_OPERAND_OBJECT, or 170 * 2) A ACPI_NAMESPACE_NODE (NamedObj) 171 */ 172 if (ACPI_GET_DESCRIPTOR_TYPE (*StackPtr) == ACPI_DESC_TYPE_OPERAND) 173 { 174 Status = AcpiExResolveObjectToValue (StackPtr, WalkState); 175 if (ACPI_FAILURE (Status)) 176 { 177 return_ACPI_STATUS (Status); 178 } 179 180 if (!*StackPtr) 181 { 182 ACPI_ERROR ((AE_INFO, "Internal - null pointer")); 183 return_ACPI_STATUS (AE_AML_NO_OPERAND); 184 } 185 } 186 187 /* 188 * Object on the stack may have changed if AcpiExResolveObjectToValue() 189 * was called (i.e., we can't use an _else_ here.) 190 */ 191 if (ACPI_GET_DESCRIPTOR_TYPE (*StackPtr) == ACPI_DESC_TYPE_NAMED) 192 { 193 Status = AcpiExResolveNodeToValue ( 194 ACPI_CAST_INDIRECT_PTR (ACPI_NAMESPACE_NODE, StackPtr), 195 WalkState); 196 if (ACPI_FAILURE (Status)) 197 { 198 return_ACPI_STATUS (Status); 199 } 200 } 201 202 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Resolved object %p\n", *StackPtr)); 203 return_ACPI_STATUS (AE_OK); 204 } 205 206 207 /******************************************************************************* 208 * 209 * FUNCTION: AcpiExResolveObjectToValue 210 * 211 * PARAMETERS: StackPtr - Pointer to an internal object 212 * WalkState - Current method state 213 * 214 * RETURN: Status 215 * 216 * DESCRIPTION: Retrieve the value from an internal object. The Reference type 217 * uses the associated AML opcode to determine the value. 218 * 219 ******************************************************************************/ 220 221 static ACPI_STATUS 222 AcpiExResolveObjectToValue ( 223 ACPI_OPERAND_OBJECT **StackPtr, 224 ACPI_WALK_STATE *WalkState) 225 { 226 ACPI_STATUS Status = AE_OK; 227 ACPI_OPERAND_OBJECT *StackDesc; 228 ACPI_OPERAND_OBJECT *ObjDesc = NULL; 229 UINT8 RefType; 230 231 232 ACPI_FUNCTION_TRACE (ExResolveObjectToValue); 233 234 235 StackDesc = *StackPtr; 236 237 /* This is an object of type ACPI_OPERAND_OBJECT */ 238 239 switch (StackDesc->Common.Type) 240 { 241 case ACPI_TYPE_LOCAL_REFERENCE: 242 243 RefType = StackDesc->Reference.Class; 244 245 switch (RefType) 246 { 247 case ACPI_REFCLASS_LOCAL: 248 case ACPI_REFCLASS_ARG: 249 /* 250 * Get the local from the method's state info 251 * Note: this increments the local's object reference count 252 */ 253 Status = AcpiDsMethodDataGetValue (RefType, 254 StackDesc->Reference.Value, WalkState, &ObjDesc); 255 if (ACPI_FAILURE (Status)) 256 { 257 return_ACPI_STATUS (Status); 258 } 259 260 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[Arg/Local %X] ValueObj is %p\n", 261 StackDesc->Reference.Value, ObjDesc)); 262 263 /* 264 * Now we can delete the original Reference Object and 265 * replace it with the resolved value 266 */ 267 AcpiUtRemoveReference (StackDesc); 268 *StackPtr = ObjDesc; 269 break; 270 271 case ACPI_REFCLASS_INDEX: 272 273 switch (StackDesc->Reference.TargetType) 274 { 275 case ACPI_TYPE_BUFFER_FIELD: 276 277 /* Just return - do not dereference */ 278 break; 279 280 case ACPI_TYPE_PACKAGE: 281 282 /* If method call or CopyObject - do not dereference */ 283 284 if ((WalkState->Opcode == AML_INT_METHODCALL_OP) || 285 (WalkState->Opcode == AML_COPY_OP)) 286 { 287 break; 288 } 289 290 /* Otherwise, dereference the PackageIndex to a package element */ 291 292 ObjDesc = *StackDesc->Reference.Where; 293 if (ObjDesc) 294 { 295 /* 296 * Valid object descriptor, copy pointer to return value 297 * (i.e., dereference the package index) 298 * Delete the ref object, increment the returned object 299 */ 300 AcpiUtAddReference (ObjDesc); 301 *StackPtr = ObjDesc; 302 } 303 else 304 { 305 /* 306 * A NULL object descriptor means an uninitialized element of 307 * the package, can't dereference it 308 */ 309 ACPI_ERROR ((AE_INFO, 310 "Attempt to dereference an Index to " 311 "NULL package element Idx=%p", 312 StackDesc)); 313 Status = AE_AML_UNINITIALIZED_ELEMENT; 314 } 315 break; 316 317 default: 318 319 /* Invalid reference object */ 320 321 ACPI_ERROR ((AE_INFO, 322 "Unknown TargetType 0x%X in Index/Reference object %p", 323 StackDesc->Reference.TargetType, StackDesc)); 324 Status = AE_AML_INTERNAL; 325 break; 326 } 327 break; 328 329 case ACPI_REFCLASS_REFOF: 330 case ACPI_REFCLASS_DEBUG: 331 case ACPI_REFCLASS_TABLE: 332 333 /* Just leave the object as-is, do not dereference */ 334 335 break; 336 337 case ACPI_REFCLASS_NAME: /* Reference to a named object */ 338 339 /* Dereference the name */ 340 341 if ((StackDesc->Reference.Node->Type == ACPI_TYPE_DEVICE) || 342 (StackDesc->Reference.Node->Type == ACPI_TYPE_THERMAL)) 343 { 344 /* These node types do not have 'real' subobjects */ 345 346 *StackPtr = (void *) StackDesc->Reference.Node; 347 } 348 else 349 { 350 /* Get the object pointed to by the namespace node */ 351 352 *StackPtr = (StackDesc->Reference.Node)->Object; 353 AcpiUtAddReference (*StackPtr); 354 } 355 356 AcpiUtRemoveReference (StackDesc); 357 break; 358 359 default: 360 361 ACPI_ERROR ((AE_INFO, 362 "Unknown Reference type 0x%X in %p", 363 RefType, StackDesc)); 364 Status = AE_AML_INTERNAL; 365 break; 366 } 367 break; 368 369 case ACPI_TYPE_BUFFER: 370 371 Status = AcpiDsGetBufferArguments (StackDesc); 372 break; 373 374 case ACPI_TYPE_PACKAGE: 375 376 Status = AcpiDsGetPackageArguments (StackDesc); 377 break; 378 379 case ACPI_TYPE_BUFFER_FIELD: 380 case ACPI_TYPE_LOCAL_REGION_FIELD: 381 case ACPI_TYPE_LOCAL_BANK_FIELD: 382 case ACPI_TYPE_LOCAL_INDEX_FIELD: 383 384 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, 385 "FieldRead SourceDesc=%p Type=%X\n", 386 StackDesc, StackDesc->Common.Type)); 387 388 Status = AcpiExReadDataFromField (WalkState, StackDesc, &ObjDesc); 389 390 /* Remove a reference to the original operand, then override */ 391 392 AcpiUtRemoveReference (*StackPtr); 393 *StackPtr = (void *) ObjDesc; 394 break; 395 396 default: 397 398 break; 399 } 400 401 return_ACPI_STATUS (Status); 402 } 403 404 405 /******************************************************************************* 406 * 407 * FUNCTION: AcpiExResolveMultiple 408 * 409 * PARAMETERS: WalkState - Current state (contains AML opcode) 410 * Operand - Starting point for resolution 411 * ReturnType - Where the object type is returned 412 * ReturnDesc - Where the resolved object is returned 413 * 414 * RETURN: Status 415 * 416 * DESCRIPTION: Return the base object and type. Traverse a reference list if 417 * necessary to get to the base object. 418 * 419 ******************************************************************************/ 420 421 ACPI_STATUS 422 AcpiExResolveMultiple ( 423 ACPI_WALK_STATE *WalkState, 424 ACPI_OPERAND_OBJECT *Operand, 425 ACPI_OBJECT_TYPE *ReturnType, 426 ACPI_OPERAND_OBJECT **ReturnDesc) 427 { 428 ACPI_OPERAND_OBJECT *ObjDesc = ACPI_CAST_PTR (void, Operand); 429 ACPI_NAMESPACE_NODE *Node = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, Operand); 430 ACPI_OBJECT_TYPE Type; 431 ACPI_STATUS Status; 432 433 434 ACPI_FUNCTION_TRACE (AcpiExResolveMultiple); 435 436 437 /* Operand can be either a namespace node or an operand descriptor */ 438 439 switch (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc)) 440 { 441 case ACPI_DESC_TYPE_OPERAND: 442 443 Type = ObjDesc->Common.Type; 444 break; 445 446 case ACPI_DESC_TYPE_NAMED: 447 448 Type = ((ACPI_NAMESPACE_NODE *) ObjDesc)->Type; 449 ObjDesc = AcpiNsGetAttachedObject (Node); 450 451 /* If we had an Alias node, use the attached object for type info */ 452 453 if (Type == ACPI_TYPE_LOCAL_ALIAS) 454 { 455 Type = ((ACPI_NAMESPACE_NODE *) ObjDesc)->Type; 456 ObjDesc = AcpiNsGetAttachedObject ( 457 (ACPI_NAMESPACE_NODE *) ObjDesc); 458 } 459 460 if (!ObjDesc) 461 { 462 ACPI_ERROR ((AE_INFO, 463 "[%4.4s] Node is unresolved or uninitialized", 464 AcpiUtGetNodeName (Node))); 465 return_ACPI_STATUS (AE_AML_UNINITIALIZED_NODE); 466 } 467 break; 468 469 default: 470 return_ACPI_STATUS (AE_AML_OPERAND_TYPE); 471 } 472 473 /* If type is anything other than a reference, we are done */ 474 475 if (Type != ACPI_TYPE_LOCAL_REFERENCE) 476 { 477 goto Exit; 478 } 479 480 /* 481 * For reference objects created via the RefOf, Index, or Load/LoadTable 482 * operators, we need to get to the base object (as per the ACPI 483 * specification of the ObjectType and SizeOf operators). This means 484 * traversing the list of possibly many nested references. 485 */ 486 while (ObjDesc->Common.Type == ACPI_TYPE_LOCAL_REFERENCE) 487 { 488 switch (ObjDesc->Reference.Class) 489 { 490 case ACPI_REFCLASS_REFOF: 491 case ACPI_REFCLASS_NAME: 492 493 /* Dereference the reference pointer */ 494 495 if (ObjDesc->Reference.Class == ACPI_REFCLASS_REFOF) 496 { 497 Node = ObjDesc->Reference.Object; 498 } 499 else /* AML_INT_NAMEPATH_OP */ 500 { 501 Node = ObjDesc->Reference.Node; 502 } 503 504 /* All "References" point to a NS node */ 505 506 if (ACPI_GET_DESCRIPTOR_TYPE (Node) != ACPI_DESC_TYPE_NAMED) 507 { 508 ACPI_ERROR ((AE_INFO, 509 "Not a namespace node %p [%s]", 510 Node, AcpiUtGetDescriptorName (Node))); 511 return_ACPI_STATUS (AE_AML_INTERNAL); 512 } 513 514 /* Get the attached object */ 515 516 ObjDesc = AcpiNsGetAttachedObject (Node); 517 if (!ObjDesc) 518 { 519 /* No object, use the NS node type */ 520 521 Type = AcpiNsGetType (Node); 522 goto Exit; 523 } 524 525 /* Check for circular references */ 526 527 if (ObjDesc == Operand) 528 { 529 return_ACPI_STATUS (AE_AML_CIRCULAR_REFERENCE); 530 } 531 break; 532 533 case ACPI_REFCLASS_INDEX: 534 535 /* Get the type of this reference (index into another object) */ 536 537 Type = ObjDesc->Reference.TargetType; 538 if (Type != ACPI_TYPE_PACKAGE) 539 { 540 goto Exit; 541 } 542 543 /* 544 * The main object is a package, we want to get the type 545 * of the individual package element that is referenced by 546 * the index. 547 * 548 * This could of course in turn be another reference object. 549 */ 550 ObjDesc = *(ObjDesc->Reference.Where); 551 if (!ObjDesc) 552 { 553 /* NULL package elements are allowed */ 554 555 Type = 0; /* Uninitialized */ 556 goto Exit; 557 } 558 break; 559 560 case ACPI_REFCLASS_TABLE: 561 562 Type = ACPI_TYPE_DDB_HANDLE; 563 goto Exit; 564 565 case ACPI_REFCLASS_LOCAL: 566 case ACPI_REFCLASS_ARG: 567 568 if (ReturnDesc) 569 { 570 Status = AcpiDsMethodDataGetValue (ObjDesc->Reference.Class, 571 ObjDesc->Reference.Value, WalkState, &ObjDesc); 572 if (ACPI_FAILURE (Status)) 573 { 574 return_ACPI_STATUS (Status); 575 } 576 AcpiUtRemoveReference (ObjDesc); 577 } 578 else 579 { 580 Status = AcpiDsMethodDataGetNode (ObjDesc->Reference.Class, 581 ObjDesc->Reference.Value, WalkState, &Node); 582 if (ACPI_FAILURE (Status)) 583 { 584 return_ACPI_STATUS (Status); 585 } 586 587 ObjDesc = AcpiNsGetAttachedObject (Node); 588 if (!ObjDesc) 589 { 590 Type = ACPI_TYPE_ANY; 591 goto Exit; 592 } 593 } 594 break; 595 596 case ACPI_REFCLASS_DEBUG: 597 598 /* The Debug Object is of type "DebugObject" */ 599 600 Type = ACPI_TYPE_DEBUG_OBJECT; 601 goto Exit; 602 603 default: 604 605 ACPI_ERROR ((AE_INFO, 606 "Unknown Reference Class 0x%2.2X", 607 ObjDesc->Reference.Class)); 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 = ObjDesc->Common.Type; 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 640 /* No change to Type required */ 641 642 break; 643 } 644 645 *ReturnType = Type; 646 if (ReturnDesc) 647 { 648 *ReturnDesc = ObjDesc; 649 } 650 return_ACPI_STATUS (AE_OK); 651 } 652