exresolv.c revision 77424
1 2/****************************************************************************** 3 * 4 * Module Name: exresolv - AML Interpreter object resolution 5 * $Revision: 95 $ 6 * 7 *****************************************************************************/ 8 9/****************************************************************************** 10 * 11 * 1. Copyright Notice 12 * 13 * Some or all of this work - Copyright (c) 1999, 2000, 2001, 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 "acparser.h" 123#include "acdispat.h" 124#include "acinterp.h" 125#include "acnamesp.h" 126#include "actables.h" 127#include "acevents.h" 128 129 130#define _COMPONENT ACPI_EXECUTER 131 MODULE_NAME ("exresolv") 132 133 134/******************************************************************************* 135 * 136 * FUNCTION: AcpiExGetBufferFieldValue 137 * 138 * PARAMETERS: *ObjDesc - Pointer to a BufferField 139 * *ResultDesc - Pointer to an empty descriptor which will 140 * become an Integer with the field's value 141 * 142 * RETURN: Status 143 * 144 * DESCRIPTION: Retrieve the value from a BufferField 145 * 146 ******************************************************************************/ 147 148ACPI_STATUS 149AcpiExGetBufferFieldValue ( 150 ACPI_OPERAND_OBJECT *ObjDesc, 151 ACPI_OPERAND_OBJECT *ResultDesc) 152{ 153 ACPI_STATUS Status; 154 UINT32 Mask; 155 UINT8 *Location; 156 157 158 FUNCTION_TRACE ("ExGetBufferFieldValue"); 159 160 161 /* 162 * Parameter validation 163 */ 164 if (!ObjDesc) 165 { 166 DEBUG_PRINTP (ACPI_ERROR, ("Internal - null field pointer\n")); 167 return_ACPI_STATUS (AE_AML_NO_OPERAND); 168 } 169 170 if (!(ObjDesc->Common.Flags & AOPOBJ_DATA_VALID)) 171 { 172 Status = AcpiDsGetBufferFieldArguments (ObjDesc); 173 if (ACPI_FAILURE (Status)) 174 { 175 return_ACPI_STATUS (Status); 176 } 177 } 178 179 if (!ObjDesc->BufferField.BufferObj) 180 { 181 DEBUG_PRINTP (ACPI_ERROR, ("Internal - null container pointer\n")); 182 return_ACPI_STATUS (AE_AML_INTERNAL); 183 } 184 185 if (ACPI_TYPE_BUFFER != ObjDesc->BufferField.BufferObj->Common.Type) 186 { 187 DEBUG_PRINTP (ACPI_ERROR, ("Internal - container is not a Buffer\n")); 188 return_ACPI_STATUS (AE_AML_OPERAND_TYPE); 189 } 190 191 if (!ResultDesc) 192 { 193 DEBUG_PRINTP (ACPI_ERROR, ("Internal - null result pointer\n")); 194 return_ACPI_STATUS (AE_AML_INTERNAL); 195 } 196 197 198 /* Field location is (base of buffer) + (byte offset) */ 199 200 Location = ObjDesc->BufferField.BufferObj->Buffer.Pointer 201 + ObjDesc->BufferField.BaseByteOffset; 202 203 /* 204 * Construct Mask with as many 1 bits as the field width 205 * 206 * NOTE: Only the bottom 5 bits are valid for a shift operation, so 207 * special care must be taken for any shift greater than 31 bits. 208 * 209 * TBD: [Unhandled] Fields greater than 32 bits will not work. 210 */ 211 if (ObjDesc->BufferField.BitLength < 32) 212 { 213 Mask = ((UINT32) 1 << ObjDesc->BufferField.BitLength) - (UINT32) 1; 214 } 215 else 216 { 217 Mask = ACPI_UINT32_MAX; 218 } 219 220 ResultDesc->Integer.Type = (UINT8) ACPI_TYPE_INTEGER; 221 222 /* Get the 32 bit value at the location */ 223 224 MOVE_UNALIGNED32_TO_32 (&ResultDesc->Integer.Value, Location); 225 226 /* 227 * Shift the 32-bit word containing the field, and mask off the 228 * resulting value 229 */ 230 ResultDesc->Integer.Value = 231 (ResultDesc->Integer.Value >> ObjDesc->BufferField.StartFieldBitOffset) & Mask; 232 233 DEBUG_PRINT (ACPI_INFO, 234 ("** Read from buffer %p byte %ld bit %d width %d addr %p mask %08lx val %08lx\n", 235 ObjDesc->BufferField.BufferObj->Buffer.Pointer, 236 ObjDesc->BufferField.BaseByteOffset, 237 ObjDesc->BufferField.StartFieldBitOffset, 238 ObjDesc->BufferField.BitLength, 239 Location, Mask, ResultDesc->Integer.Value)); 240 241 return_ACPI_STATUS (AE_OK); 242} 243 244 245/******************************************************************************* 246 * 247 * FUNCTION: AcpiExResolveToValue 248 * 249 * PARAMETERS: **StackPtr - Points to entry on ObjStack, which can 250 * be either an (ACPI_OPERAND_OBJECT *) 251 * or an ACPI_HANDLE. 252 * WalkState - Current method state 253 * 254 * RETURN: Status 255 * 256 * DESCRIPTION: Convert Reference objects to values 257 * 258 ******************************************************************************/ 259 260ACPI_STATUS 261AcpiExResolveToValue ( 262 ACPI_OPERAND_OBJECT **StackPtr, 263 ACPI_WALK_STATE *WalkState) 264{ 265 ACPI_STATUS Status; 266 267 268 FUNCTION_TRACE_PTR ("ExResolveToValue", StackPtr); 269 270 271 if (!StackPtr || !*StackPtr) 272 { 273 DEBUG_PRINTP (ACPI_ERROR, ("Internal - null pointer\n")); 274 return_ACPI_STATUS (AE_AML_NO_OPERAND); 275 } 276 277 278 /* 279 * The entity pointed to by the StackPtr can be either 280 * 1) A valid ACPI_OPERAND_OBJECT, or 281 * 2) A ACPI_NAMESPACE_NODE (NamedObj) 282 */ 283 if (VALID_DESCRIPTOR_TYPE (*StackPtr, ACPI_DESC_TYPE_INTERNAL)) 284 { 285 Status = AcpiExResolveObjectToValue (StackPtr, WalkState); 286 if (ACPI_FAILURE (Status)) 287 { 288 return_ACPI_STATUS (Status); 289 } 290 } 291 292 /* 293 * Object on the stack may have changed if AcpiExResolveObjectToValue() 294 * was called (i.e., we can't use an _else_ here.) 295 */ 296 if (VALID_DESCRIPTOR_TYPE (*StackPtr, ACPI_DESC_TYPE_NAMED)) 297 { 298 Status = AcpiExResolveNodeToValue ((ACPI_NAMESPACE_NODE **) StackPtr, 299 WalkState); 300 if (ACPI_FAILURE (Status)) 301 { 302 return_ACPI_STATUS (Status); 303 } 304 } 305 306 307 DEBUG_PRINTP (ACPI_INFO, ("Resolved object %p\n", *StackPtr)); 308 return_ACPI_STATUS (AE_OK); 309} 310 311 312/******************************************************************************* 313 * 314 * FUNCTION: AcpiExResolveObjectToValue 315 * 316 * PARAMETERS: StackPtr - Pointer to a stack location that contains a 317 * ptr to an internal object. 318 * WalkState - Current method state 319 * 320 * RETURN: Status 321 * 322 * DESCRIPTION: Retrieve the value from an internal object. The Reference type 323 * uses the associated AML opcode to determine the value. 324 * 325 ******************************************************************************/ 326 327ACPI_STATUS 328AcpiExResolveObjectToValue ( 329 ACPI_OPERAND_OBJECT **StackPtr, 330 ACPI_WALK_STATE *WalkState) 331{ 332 ACPI_STATUS Status = AE_OK; 333 ACPI_OPERAND_OBJECT *StackDesc; 334 void *TempNode; 335 ACPI_OPERAND_OBJECT *ObjDesc; 336 UINT16 Opcode; 337 338 339 FUNCTION_TRACE ("ExResolveObjectToValue"); 340 341 342 StackDesc = *StackPtr; 343 344 /* This is an ACPI_OPERAND_OBJECT */ 345 346 switch (StackDesc->Common.Type) 347 { 348 349 case INTERNAL_TYPE_REFERENCE: 350 351 Opcode = StackDesc->Reference.Opcode; 352 353 switch (Opcode) 354 { 355 356 case AML_NAME_OP: 357 358 /* 359 * Convert indirect name ptr to a direct name ptr. 360 * Then, AcpiExResolveNodeToValue can be used to get the value 361 */ 362 TempNode = StackDesc->Reference.Object; 363 364 /* Delete the Reference Object */ 365 366 AcpiUtRemoveReference (StackDesc); 367 368 /* Put direct name pointer onto stack and exit */ 369 370 (*StackPtr) = TempNode; 371 break; 372 373 374 case AML_LOCAL_OP: 375 case AML_ARG_OP: 376 377 /* 378 * Get the local from the method's state info 379 * Note: this increments the local's object reference count 380 */ 381 Status = AcpiDsMethodDataGetValue (Opcode, 382 StackDesc->Reference.Offset, WalkState, &ObjDesc); 383 if (ACPI_FAILURE (Status)) 384 { 385 return_ACPI_STATUS (Status); 386 } 387 388 /* 389 * Now we can delete the original Reference Object and 390 * replace it with the resolve value 391 */ 392 AcpiUtRemoveReference (StackDesc); 393 *StackPtr = ObjDesc; 394 395 DEBUG_PRINTP (ACPI_INFO, ("[Arg/Local %d] ValueObj is %p\n", 396 StackDesc->Reference.Offset, ObjDesc)); 397 break; 398 399 400 /* 401 * TBD: [Restructure] These next three opcodes change the type of 402 * the object, which is actually a no-no. 403 */ 404 case AML_ZERO_OP: 405 406 StackDesc->Common.Type = (UINT8) ACPI_TYPE_INTEGER; 407 StackDesc->Integer.Value = 0; 408 break; 409 410 411 case AML_ONE_OP: 412 413 StackDesc->Common.Type = (UINT8) ACPI_TYPE_INTEGER; 414 StackDesc->Integer.Value = 1; 415 break; 416 417 418 case AML_ONES_OP: 419 420 StackDesc->Common.Type = (UINT8) ACPI_TYPE_INTEGER; 421 StackDesc->Integer.Value = ACPI_INTEGER_MAX; 422 423 /* Truncate value if we are executing from a 32-bit ACPI table */ 424 425 AcpiExTruncateFor32bitTable (StackDesc, WalkState); 426 break; 427 428 429 case AML_INDEX_OP: 430 431 switch (StackDesc->Reference.TargetType) 432 { 433 case ACPI_TYPE_BUFFER_FIELD: 434 435 /* Just return - leave the Reference on the stack */ 436 break; 437 438 439 case ACPI_TYPE_PACKAGE: 440 ObjDesc = *StackDesc->Reference.Where; 441 if (ObjDesc) 442 { 443 /* 444 * Valid obj descriptor, copy pointer to return value 445 * (i.e., dereference the package index) 446 * Delete the ref object, increment the returned object 447 */ 448 AcpiUtRemoveReference (StackDesc); 449 AcpiUtAddReference (ObjDesc); 450 *StackPtr = ObjDesc; 451 } 452 453 else 454 { 455 /* 456 * A NULL object descriptor means an unitialized element of 457 * the package, can't dereference it 458 */ 459 DEBUG_PRINTP (ACPI_ERROR, 460 ("Attempt to deref an Index to NULL pkg element Idx=%p\n", 461 StackDesc)); 462 Status = AE_AML_UNINITIALIZED_ELEMENT; 463 } 464 break; 465 466 default: 467 /* Invalid reference object */ 468 469 DEBUG_PRINTP (ACPI_ERROR, 470 ("Unknown TargetType %X in Index/Reference obj %p\n", 471 StackDesc->Reference.TargetType, StackDesc)); 472 Status = AE_AML_INTERNAL; 473 break; 474 } 475 476 break; 477 478 479 case AML_DEBUG_OP: 480 481 /* Just leave the object as-is */ 482 break; 483 484 485 default: 486 487 DEBUG_PRINTP (ACPI_ERROR, ("Unknown Reference object subtype %02X in %p\n", 488 Opcode, StackDesc)); 489 Status = AE_AML_INTERNAL; 490 break; 491 492 } /* switch (Opcode) */ 493 494 break; /* case INTERNAL_TYPE_REFERENCE */ 495 496 497 case ACPI_TYPE_BUFFER_FIELD: 498 499 ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_ANY); 500 if (!ObjDesc) 501 { 502 return_ACPI_STATUS (AE_NO_MEMORY); 503 } 504 505 Status = AcpiExGetBufferFieldValue (StackDesc, ObjDesc); 506 if (ACPI_FAILURE (Status)) 507 { 508 AcpiUtRemoveReference (ObjDesc); 509 ObjDesc = NULL; 510 } 511 512 *StackPtr = (void *) ObjDesc; 513 break; 514 515 516 case INTERNAL_TYPE_BANK_FIELD: 517 518 ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_ANY); 519 if (!ObjDesc) 520 { 521 return_ACPI_STATUS (AE_NO_MEMORY); 522 } 523 524 /* TBD: WRONG! */ 525 526 Status = AcpiExGetBufferFieldValue (StackDesc, ObjDesc); 527 if (ACPI_FAILURE (Status)) 528 { 529 AcpiUtRemoveReference (ObjDesc); 530 ObjDesc = NULL; 531 } 532 533 *StackPtr = (void *) ObjDesc; 534 break; 535 536 537 /* TBD: [Future] - may need to handle IndexField, and DefField someday */ 538 539 default: 540 541 break; 542 543 } /* switch (StackDesc->Common.Type) */ 544 545 546 return_ACPI_STATUS (Status); 547} 548 549 550