exresolv.c revision 123315
117359Swosch 217359Swosch/****************************************************************************** 317359Swosch * 417359Swosch * Module Name: exresolv - AML Interpreter object resolution 517359Swosch * $Revision: 121 $ 617359Swosch * 717359Swosch *****************************************************************************/ 817359Swosch 917359Swosch/****************************************************************************** 1017359Swosch * 1117359Swosch * 1. Copyright Notice 1217359Swosch * 1317359Swosch * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp. 1417359Swosch * All rights reserved. 1517359Swosch * 1617359Swosch * 2. License 1717359Swosch * 1817359Swosch * 2.1. This is your license from Intel Corp. under its intellectual property 1917359Swosch * rights. You may have additional license terms from the party that provided 2017359Swosch * you this software, covering your right to use that party's intellectual 2117359Swosch * property rights. 2217359Swosch * 2317359Swosch * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 2417359Swosch * copy of the source code appearing in this file ("Covered Code") an 2517359Swosch * irrevocable, perpetual, worldwide license under Intel's copyrights in the 2617359Swosch * base code distributed originally by Intel ("Original Intel Code") to copy, 2717359Swosch * make derivatives, distribute, use and display any portion of the Covered 2817359Swosch * Code in any form, with the right to sublicense such rights; and 2917359Swosch * 3017359Swosch * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 3117359Swosch * license (with the right to sublicense), under only those claims of Intel 3217359Swosch * patents that are infringed by the Original Intel Code, to make, use, sell, 3317359Swosch * offer to sell, and import the Covered Code and derivative works thereof 3417359Swosch * solely to the minimum extent necessary to exercise the above copyright 3517359Swosch * license, and in no event shall the patent license extend to any additions 3617359Swosch * to or modifications of the Original Intel Code. No other license or right 3717359Swosch * is granted directly or by implication, estoppel or otherwise; 3817359Swosch * 3917359Swosch * The above copyright and patent license is granted only if the following 4017359Swosch * conditions are met: 4117359Swosch * 4217359Swosch * 3. Conditions 4317359Swosch * 4417359Swosch * 3.1. Redistribution of Source with Rights to Further Distribute Source. 4517359Swosch * Redistribution of source code of any substantial portion of the Covered 4617359Swosch * Code or modification with rights to further distribute source must include 4717359Swosch * the above Copyright Notice, the above License, this list of Conditions, 4817359Swosch * and the following Disclaimer and Export Compliance provision. In addition, 4917359Swosch * Licensee must cause all Covered Code to which Licensee contributes to 5017359Swosch * contain a file documenting the changes Licensee made to create that Covered 5117359Swosch * Code and the date of any change. Licensee must include in that file the 5217359Swosch * documentation of any changes made by any predecessor Licensee. Licensee 5317359Swosch * must include a prominent statement that the modification is derived, 5417359Swosch * directly or indirectly, from Original Intel Code. 5517359Swosch * 5617359Swosch * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 5717359Swosch * Redistribution of source code of any substantial portion of the Covered 5817359Swosch * Code or modification without rights to further distribute source must 5917359Swosch * include the following Disclaimer and Export Compliance provision in the 6017359Swosch * documentation and/or other materials provided with distribution. In 6117359Swosch * addition, Licensee may not authorize further sublicense of source of any 6217359Swosch * portion of the Covered Code, and must include terms to the effect that the 6317359Swosch * license from Licensee to its licensee is limited to the intellectual 6417359Swosch * property embodied in the software Licensee provides to its licensee, and 6517359Swosch * not to intellectual property embodied in modifications its licensee may 6617359Swosch * make. 6717359Swosch * 6817359Swosch * 3.3. Redistribution of Executable. Redistribution in executable form of any 6917359Swosch * substantial portion of the Covered Code or modification must reproduce the 7017359Swosch * above Copyright Notice, and the following Disclaimer and Export Compliance 7117359Swosch * provision in the documentation and/or other materials provided with the 7217359Swosch * distribution. 7317359Swosch * 7417359Swosch * 3.4. Intel retains all right, title, and interest in and to the Original 7517359Swosch * Intel Code. 7617359Swosch * 7717359Swosch * 3.5. Neither the name Intel nor any other trademark owned or controlled by 7817359Swosch * Intel shall be used in advertising or otherwise to promote the sale, use or 7917359Swosch * other dealings in products derived from or relating to the Covered Code 8017359Swosch * without prior written authorization from Intel. 8117359Swosch * 8217359Swosch * 4. Disclaimer and Export Compliance 8317359Swosch * 8417359Swosch * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 8517359Swosch * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 8617359Swosch * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 8717359Swosch * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 8817359Swosch * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 8917359Swosch * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 9017359Swosch * PARTICULAR PURPOSE. 9117359Swosch * 9217359Swosch * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 9317359Swosch * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 9418194Ssos * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 9517359Swosch * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 9617359Swosch * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 9717359Swosch * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 9817359Swosch * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 9917359Swosch * LIMITED REMEDY. 10017359Swosch * 10117359Swosch * 4.3. Licensee shall not export, either directly or indirectly, any of this 10217359Swosch * software or system incorporating such software without first obtaining any 10317359Swosch * required license or other approval from the U. S. Department of Commerce or 10417359Swosch * any other agency or department of the United States Government. In the 10517359Swosch * event Licensee exports any such software from the United States or 10617359Swosch * re-exports any such software from a foreign destination, Licensee shall 10717359Swosch * ensure that the distribution and export/re-export of the software is in 10817359Swosch * compliance with all laws, regulations, orders, or other restrictions of the 10917359Swosch * U.S. Export Administration Regulations. Licensee agrees that neither it nor 11017359Swosch * any of its subsidiaries will export/re-export any technical data, process, 11117359Swosch * software, or service, directly or indirectly, to any country for which the 11217359Swosch * United States government or any agency thereof requires an export license, 11317359Swosch * other governmental approval, or letter of assurance, without first obtaining 11417359Swosch * such license, approval or letter. 11517359Swosch * 11617359Swosch *****************************************************************************/ 11717359Swosch 11817359Swosch#define __EXRESOLV_C__ 11917359Swosch 12017359Swosch#include "acpi.h" 12117359Swosch#include "amlcode.h" 12217359Swosch#include "acdispat.h" 12318739Ssos#include "acinterp.h" 12418739Ssos#include "acnamesp.h" 12518739Ssos#include "acparser.h" 12618739Ssos 12718739Ssos 12818739Ssos#define _COMPONENT ACPI_EXECUTER 12918739Ssos ACPI_MODULE_NAME ("exresolv") 13018739Ssos 13118739Ssos 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 147ACPI_STATUS 148AcpiExResolveToValue ( 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 213ACPI_STATUS 214AcpiExResolveObjectToValue ( 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 case AML_LOAD_OP: 338 339 /* Just leave the object as-is */ 340 341 break; 342 343 344 default: 345 346 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "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 405ACPI_STATUS 406AcpiExResolveMultiple ( 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 416 417 ACPI_FUNCTION_TRACE ("AcpiExResolveMultiple"); 418 419 420 /* 421 * For reference objects created via the RefOf or Index operators, 422 * we need to get to the base object (as per the ACPI specification 423 * of the ObjectType and SizeOf operators). This means traversing 424 * the list of possibly many nested references. 425 */ 426 while (ACPI_GET_OBJECT_TYPE (ObjDesc) == ACPI_TYPE_LOCAL_REFERENCE) 427 { 428 switch (ObjDesc->Reference.Opcode) 429 { 430 case AML_REF_OF_OP: 431 432 /* Dereference the reference pointer */ 433 434 Node = ObjDesc->Reference.Object; 435 436 /* All "References" point to a NS node */ 437 438 if (ACPI_GET_DESCRIPTOR_TYPE (Node) != ACPI_DESC_TYPE_NAMED) 439 { 440 ACPI_REPORT_ERROR (("AcpiExResolveMultiple: Not a NS node %p [%s]\n", 441 Node, AcpiUtGetDescriptorName (Node))); 442 return_ACPI_STATUS (AE_AML_INTERNAL); 443 } 444 445 /* Get the attached object */ 446 447 ObjDesc = AcpiNsGetAttachedObject (Node); 448 if (!ObjDesc) 449 { 450 /* No object, use the NS node type */ 451 452 Type = AcpiNsGetType (Node); 453 goto Exit; 454 } 455 456 /* Check for circular references */ 457 458 if (ObjDesc == Operand) 459 { 460 return_ACPI_STATUS (AE_AML_CIRCULAR_REFERENCE); 461 } 462 break; 463 464 465 case AML_INDEX_OP: 466 467 /* Get the type of this reference (index into another object) */ 468 469 Type = ObjDesc->Reference.TargetType; 470 if (Type != ACPI_TYPE_PACKAGE) 471 { 472 goto Exit; 473 } 474 475 /* 476 * The main object is a package, we want to get the type 477 * of the individual package element that is referenced by 478 * the index. 479 * 480 * This could of course in turn be another reference object. 481 */ 482 ObjDesc = *(ObjDesc->Reference.Where); 483 break; 484 485 486 case AML_INT_NAMEPATH_OP: 487 488 /* Dereference the reference pointer */ 489 490 Node = ObjDesc->Reference.Node; 491 492 /* All "References" point to a NS node */ 493 494 if (ACPI_GET_DESCRIPTOR_TYPE (Node) != ACPI_DESC_TYPE_NAMED) 495 { 496 ACPI_REPORT_ERROR (("AcpiExResolveMultiple: Not a NS node %p [%s]\n", 497 Node, AcpiUtGetDescriptorName (Node))); 498 return_ACPI_STATUS (AE_AML_INTERNAL); 499 } 500 501 /* Get the attached object */ 502 503 ObjDesc = AcpiNsGetAttachedObject (Node); 504 if (!ObjDesc) 505 { 506 /* No object, use the NS node type */ 507 508 Type = AcpiNsGetType (Node); 509 goto Exit; 510 } 511 512 /* Check for circular references */ 513 514 if (ObjDesc == Operand) 515 { 516 return_ACPI_STATUS (AE_AML_CIRCULAR_REFERENCE); 517 } 518 break; 519 520 521 case AML_DEBUG_OP: 522 523 /* The Debug Object is of type "DebugObject" */ 524 525 Type = ACPI_TYPE_DEBUG_OBJECT; 526 goto Exit; 527 528 529 default: 530 531 ACPI_REPORT_ERROR (("AcpiExResolveMultiple: Unknown Reference subtype %X\n", 532 ObjDesc->Reference.Opcode)); 533 return_ACPI_STATUS (AE_AML_INTERNAL); 534 } 535 } 536 537 /* 538 * Now we are guaranteed to have an object that has not been created 539 * via the RefOf or Index operators. 540 */ 541 Type = ACPI_GET_OBJECT_TYPE (ObjDesc); 542 543 544Exit: 545 /* Convert internal types to external types */ 546 547 switch (Type) 548 { 549 case ACPI_TYPE_LOCAL_REGION_FIELD: 550 case ACPI_TYPE_LOCAL_BANK_FIELD: 551 case ACPI_TYPE_LOCAL_INDEX_FIELD: 552 553 Type = ACPI_TYPE_FIELD_UNIT; 554 break; 555 556 case ACPI_TYPE_LOCAL_SCOPE: 557 558 /* Per ACPI Specification, Scope is untyped */ 559 560 Type = ACPI_TYPE_ANY; 561 break; 562 563 default: 564 /* No change to Type required */ 565 break; 566 } 567 568 *ReturnType = Type; 569 if (ReturnDesc) 570 { 571 *ReturnDesc = ObjDesc; 572 } 573 return_ACPI_STATUS (AE_OK); 574} 575 576 577