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