1 2 /****************************************************************************** 3 * 4 * Module Name: exresop - AML Interpreter operand/object resolution 5 * 6 *****************************************************************************/ 7 8 /* 9 * Copyright (C) 2000 - 2008, Intel Corp. 10 * All rights reserved. 11 * 12 * Redistribution and use in source and binary forms, with or without 13 * modification, are permitted provided that the following conditions 14 * are met: 15 * 1. Redistributions of source code must retain the above copyright 16 * notice, this list of conditions, and the following disclaimer, 17 * without modification. 18 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 19 * substantially similar to the "NO WARRANTY" disclaimer below 20 * ("Disclaimer") and any redistribution must be conditioned upon 21 * including a substantially similar Disclaimer requirement for further 22 * binary redistribution. 23 * 3. Neither the names of the above-listed copyright holders nor the names 24 * of any contributors may be used to endorse or promote products derived 25 * from this software without specific prior written permission. 26 * 27 * Alternatively, this software may be distributed under the terms of the 28 * GNU General Public License ("GPL") version 2 as published by the Free 29 * Software Foundation. 30 * 31 * NO WARRANTY 32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 33 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 34 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR 35 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 36 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 37 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 38 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 39 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, 40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 41 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 42 * POSSIBILITY OF SUCH DAMAGES. 43 */ 44 45 #include <acpi/acpi.h> 46 #include "accommon.h" 47 #include "amlcode.h" 48 #include "acparser.h" 49 #include "acinterp.h" 50 #include "acnamesp.h" 51 52 #define _COMPONENT ACPI_EXECUTER 53 ACPI_MODULE_NAME("exresop") 54 55 /* Local prototypes */ 56 static acpi_status 57 acpi_ex_check_object_type(acpi_object_type type_needed, 58 acpi_object_type this_type, void *object); 59 60 /******************************************************************************* 61 * 62 * FUNCTION: acpi_ex_check_object_type 63 * 64 * PARAMETERS: type_needed Object type needed 65 * this_type Actual object type 66 * Object Object pointer 67 * 68 * RETURN: Status 69 * 70 * DESCRIPTION: Check required type against actual type 71 * 72 ******************************************************************************/ 73 74 static acpi_status 75 acpi_ex_check_object_type(acpi_object_type type_needed, 76 acpi_object_type this_type, void *object) 77 { 78 ACPI_FUNCTION_ENTRY(); 79 80 if (type_needed == ACPI_TYPE_ANY) { 81 82 /* All types OK, so we don't perform any typechecks */ 83 84 return (AE_OK); 85 } 86 87 if (type_needed == ACPI_TYPE_LOCAL_REFERENCE) { 88 /* 89 * Allow the AML "Constant" opcodes (Zero, One, etc.) to be reference 90 * objects and thus allow them to be targets. (As per the ACPI 91 * specification, a store to a constant is a noop.) 92 */ 93 if ((this_type == ACPI_TYPE_INTEGER) && 94 (((union acpi_operand_object *)object)->common. 95 flags & AOPOBJ_AML_CONSTANT)) { 96 return (AE_OK); 97 } 98 } 99 100 if (type_needed != this_type) { 101 ACPI_ERROR((AE_INFO, 102 "Needed type [%s], found [%s] %p", 103 acpi_ut_get_type_name(type_needed), 104 acpi_ut_get_type_name(this_type), object)); 105 106 return (AE_AML_OPERAND_TYPE); 107 } 108 109 return (AE_OK); 110 } 111 112 /******************************************************************************* 113 * 114 * FUNCTION: acpi_ex_resolve_operands 115 * 116 * PARAMETERS: Opcode - Opcode being interpreted 117 * stack_ptr - Pointer to the operand stack to be 118 * resolved 119 * walk_state - Current state 120 * 121 * RETURN: Status 122 * 123 * DESCRIPTION: Convert multiple input operands to the types required by the 124 * target operator. 125 * 126 * Each 5-bit group in arg_types represents one required 127 * operand and indicates the required Type. The corresponding operand 128 * will be converted to the required type if possible, otherwise we 129 * abort with an exception. 130 * 131 ******************************************************************************/ 132 133 acpi_status 134 acpi_ex_resolve_operands(u16 opcode, 135 union acpi_operand_object ** stack_ptr, 136 struct acpi_walk_state * walk_state) 137 { 138 union acpi_operand_object *obj_desc; 139 acpi_status status = AE_OK; 140 u8 object_type; 141 u32 arg_types; 142 const struct acpi_opcode_info *op_info; 143 u32 this_arg_type; 144 acpi_object_type type_needed; 145 u16 target_op = 0; 146 147 ACPI_FUNCTION_TRACE_U32(ex_resolve_operands, opcode); 148 149 op_info = acpi_ps_get_opcode_info(opcode); 150 if (op_info->class == AML_CLASS_UNKNOWN) { 151 return_ACPI_STATUS(AE_AML_BAD_OPCODE); 152 } 153 154 arg_types = op_info->runtime_args; 155 if (arg_types == ARGI_INVALID_OPCODE) { 156 ACPI_ERROR((AE_INFO, "Unknown AML opcode %X", opcode)); 157 158 return_ACPI_STATUS(AE_AML_INTERNAL); 159 } 160 161 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, 162 "Opcode %X [%s] RequiredOperandTypes=%8.8X\n", 163 opcode, op_info->name, arg_types)); 164 165 /* 166 * Normal exit is with (arg_types == 0) at end of argument list. 167 * Function will return an exception from within the loop upon 168 * finding an entry which is not (or cannot be converted 169 * to) the required type; if stack underflows; or upon 170 * finding a NULL stack entry (which should not happen). 171 */ 172 while (GET_CURRENT_ARG_TYPE(arg_types)) { 173 if (!stack_ptr || !*stack_ptr) { 174 ACPI_ERROR((AE_INFO, "Null stack entry at %p", 175 stack_ptr)); 176 177 return_ACPI_STATUS(AE_AML_INTERNAL); 178 } 179 180 /* Extract useful items */ 181 182 obj_desc = *stack_ptr; 183 184 /* Decode the descriptor type */ 185 186 switch (ACPI_GET_DESCRIPTOR_TYPE(obj_desc)) { 187 case ACPI_DESC_TYPE_NAMED: 188 189 /* Namespace Node */ 190 191 object_type = 192 ((struct acpi_namespace_node *)obj_desc)->type; 193 194 /* 195 * Resolve an alias object. The construction of these objects 196 * guarantees that there is only one level of alias indirection; 197 * thus, the attached object is always the aliased namespace node 198 */ 199 if (object_type == ACPI_TYPE_LOCAL_ALIAS) { 200 obj_desc = 201 acpi_ns_get_attached_object((struct 202 acpi_namespace_node 203 *)obj_desc); 204 *stack_ptr = obj_desc; 205 object_type = 206 ((struct acpi_namespace_node *)obj_desc)-> 207 type; 208 } 209 break; 210 211 case ACPI_DESC_TYPE_OPERAND: 212 213 /* ACPI internal object */ 214 215 object_type = ACPI_GET_OBJECT_TYPE(obj_desc); 216 217 /* Check for bad acpi_object_type */ 218 219 if (!acpi_ut_valid_object_type(object_type)) { 220 ACPI_ERROR((AE_INFO, 221 "Bad operand object type [%X]", 222 object_type)); 223 224 return_ACPI_STATUS(AE_AML_OPERAND_TYPE); 225 } 226 227 if (object_type == (u8) ACPI_TYPE_LOCAL_REFERENCE) { 228 229 /* Validate the Reference */ 230 231 switch (obj_desc->reference.class) { 232 case ACPI_REFCLASS_DEBUG: 233 234 target_op = AML_DEBUG_OP; 235 236 /*lint -fallthrough */ 237 238 case ACPI_REFCLASS_ARG: 239 case ACPI_REFCLASS_LOCAL: 240 case ACPI_REFCLASS_INDEX: 241 case ACPI_REFCLASS_REFOF: 242 case ACPI_REFCLASS_TABLE: /* ddb_handle from LOAD_OP or LOAD_TABLE_OP */ 243 case ACPI_REFCLASS_NAME: /* Reference to a named object */ 244 245 ACPI_DEBUG_PRINT((ACPI_DB_EXEC, 246 "Operand is a Reference, Class [%s] %2.2X\n", 247 acpi_ut_get_reference_name 248 (obj_desc), 249 obj_desc->reference. 250 class)); 251 break; 252 253 default: 254 255 ACPI_ERROR((AE_INFO, 256 "Unknown Reference Class %2.2X in %p", 257 obj_desc->reference.class, 258 obj_desc)); 259 260 return_ACPI_STATUS(AE_AML_OPERAND_TYPE); 261 } 262 } 263 break; 264 265 default: 266 267 /* Invalid descriptor */ 268 269 ACPI_ERROR((AE_INFO, "Invalid descriptor %p [%s]", 270 obj_desc, 271 acpi_ut_get_descriptor_name(obj_desc))); 272 273 return_ACPI_STATUS(AE_AML_OPERAND_TYPE); 274 } 275 276 /* Get one argument type, point to the next */ 277 278 this_arg_type = GET_CURRENT_ARG_TYPE(arg_types); 279 INCREMENT_ARG_LIST(arg_types); 280 281 /* 282 * Handle cases where the object does not need to be 283 * resolved to a value 284 */ 285 switch (this_arg_type) { 286 case ARGI_REF_OR_STRING: /* Can be a String or Reference */ 287 288 if ((ACPI_GET_DESCRIPTOR_TYPE(obj_desc) == 289 ACPI_DESC_TYPE_OPERAND) 290 && (ACPI_GET_OBJECT_TYPE(obj_desc) == 291 ACPI_TYPE_STRING)) { 292 /* 293 * String found - the string references a named object and 294 * must be resolved to a node 295 */ 296 goto next_operand; 297 } 298 299 /* 300 * Else not a string - fall through to the normal Reference 301 * case below 302 */ 303 /*lint -fallthrough */ 304 305 case ARGI_REFERENCE: /* References: */ 306 case ARGI_INTEGER_REF: 307 case ARGI_OBJECT_REF: 308 case ARGI_DEVICE_REF: 309 case ARGI_TARGETREF: /* Allows implicit conversion rules before store */ 310 case ARGI_FIXED_TARGET: /* No implicit conversion before store to target */ 311 case ARGI_SIMPLE_TARGET: /* Name, Local, or Arg - no implicit conversion */ 312 313 /* 314 * Need an operand of type ACPI_TYPE_LOCAL_REFERENCE 315 * A Namespace Node is OK as-is 316 */ 317 if (ACPI_GET_DESCRIPTOR_TYPE(obj_desc) == 318 ACPI_DESC_TYPE_NAMED) { 319 goto next_operand; 320 } 321 322 status = 323 acpi_ex_check_object_type(ACPI_TYPE_LOCAL_REFERENCE, 324 object_type, obj_desc); 325 if (ACPI_FAILURE(status)) { 326 return_ACPI_STATUS(status); 327 } 328 goto next_operand; 329 330 case ARGI_DATAREFOBJ: /* Store operator only */ 331 332 /* 333 * We don't want to resolve index_op reference objects during 334 * a store because this would be an implicit de_ref_of operation. 335 * Instead, we just want to store the reference object. 336 * -- All others must be resolved below. 337 */ 338 if ((opcode == AML_STORE_OP) && 339 (ACPI_GET_OBJECT_TYPE(*stack_ptr) == 340 ACPI_TYPE_LOCAL_REFERENCE) 341 && ((*stack_ptr)->reference.class == ACPI_REFCLASS_INDEX)) { 342 goto next_operand; 343 } 344 break; 345 346 default: 347 /* All cases covered above */ 348 break; 349 } 350 351 /* 352 * Resolve this object to a value 353 */ 354 status = acpi_ex_resolve_to_value(stack_ptr, walk_state); 355 if (ACPI_FAILURE(status)) { 356 return_ACPI_STATUS(status); 357 } 358 359 /* Get the resolved object */ 360 361 obj_desc = *stack_ptr; 362 363 /* 364 * Check the resulting object (value) type 365 */ 366 switch (this_arg_type) { 367 /* 368 * For the simple cases, only one type of resolved object 369 * is allowed 370 */ 371 case ARGI_MUTEX: 372 373 /* Need an operand of type ACPI_TYPE_MUTEX */ 374 375 type_needed = ACPI_TYPE_MUTEX; 376 break; 377 378 case ARGI_EVENT: 379 380 /* Need an operand of type ACPI_TYPE_EVENT */ 381 382 type_needed = ACPI_TYPE_EVENT; 383 break; 384 385 case ARGI_PACKAGE: /* Package */ 386 387 /* Need an operand of type ACPI_TYPE_PACKAGE */ 388 389 type_needed = ACPI_TYPE_PACKAGE; 390 break; 391 392 case ARGI_ANYTYPE: 393 394 /* Any operand type will do */ 395 396 type_needed = ACPI_TYPE_ANY; 397 break; 398 399 case ARGI_DDBHANDLE: 400 401 /* Need an operand of type ACPI_TYPE_DDB_HANDLE */ 402 403 type_needed = ACPI_TYPE_LOCAL_REFERENCE; 404 break; 405 406 /* 407 * The more complex cases allow multiple resolved object types 408 */ 409 case ARGI_INTEGER: 410 411 /* 412 * Need an operand of type ACPI_TYPE_INTEGER, 413 * But we can implicitly convert from a STRING or BUFFER 414 * Aka - "Implicit Source Operand Conversion" 415 */ 416 status = 417 acpi_ex_convert_to_integer(obj_desc, stack_ptr, 16); 418 if (ACPI_FAILURE(status)) { 419 if (status == AE_TYPE) { 420 ACPI_ERROR((AE_INFO, 421 "Needed [Integer/String/Buffer], found [%s] %p", 422 acpi_ut_get_object_type_name 423 (obj_desc), obj_desc)); 424 425 return_ACPI_STATUS(AE_AML_OPERAND_TYPE); 426 } 427 428 return_ACPI_STATUS(status); 429 } 430 431 if (obj_desc != *stack_ptr) { 432 acpi_ut_remove_reference(obj_desc); 433 } 434 goto next_operand; 435 436 case ARGI_BUFFER: 437 438 /* 439 * Need an operand of type ACPI_TYPE_BUFFER, 440 * But we can implicitly convert from a STRING or INTEGER 441 * Aka - "Implicit Source Operand Conversion" 442 */ 443 status = acpi_ex_convert_to_buffer(obj_desc, stack_ptr); 444 if (ACPI_FAILURE(status)) { 445 if (status == AE_TYPE) { 446 ACPI_ERROR((AE_INFO, 447 "Needed [Integer/String/Buffer], found [%s] %p", 448 acpi_ut_get_object_type_name 449 (obj_desc), obj_desc)); 450 451 return_ACPI_STATUS(AE_AML_OPERAND_TYPE); 452 } 453 454 return_ACPI_STATUS(status); 455 } 456 457 if (obj_desc != *stack_ptr) { 458 acpi_ut_remove_reference(obj_desc); 459 } 460 goto next_operand; 461 462 case ARGI_STRING: 463 464 /* 465 * Need an operand of type ACPI_TYPE_STRING, 466 * But we can implicitly convert from a BUFFER or INTEGER 467 * Aka - "Implicit Source Operand Conversion" 468 */ 469 status = acpi_ex_convert_to_string(obj_desc, stack_ptr, 470 ACPI_IMPLICIT_CONVERT_HEX); 471 if (ACPI_FAILURE(status)) { 472 if (status == AE_TYPE) { 473 ACPI_ERROR((AE_INFO, 474 "Needed [Integer/String/Buffer], found [%s] %p", 475 acpi_ut_get_object_type_name 476 (obj_desc), obj_desc)); 477 478 return_ACPI_STATUS(AE_AML_OPERAND_TYPE); 479 } 480 481 return_ACPI_STATUS(status); 482 } 483 484 if (obj_desc != *stack_ptr) { 485 acpi_ut_remove_reference(obj_desc); 486 } 487 goto next_operand; 488 489 case ARGI_COMPUTEDATA: 490 491 /* Need an operand of type INTEGER, STRING or BUFFER */ 492 493 switch (ACPI_GET_OBJECT_TYPE(obj_desc)) { 494 case ACPI_TYPE_INTEGER: 495 case ACPI_TYPE_STRING: 496 case ACPI_TYPE_BUFFER: 497 498 /* Valid operand */ 499 break; 500 501 default: 502 ACPI_ERROR((AE_INFO, 503 "Needed [Integer/String/Buffer], found [%s] %p", 504 acpi_ut_get_object_type_name 505 (obj_desc), obj_desc)); 506 507 return_ACPI_STATUS(AE_AML_OPERAND_TYPE); 508 } 509 goto next_operand; 510 511 case ARGI_BUFFER_OR_STRING: 512 513 /* Need an operand of type STRING or BUFFER */ 514 515 switch (ACPI_GET_OBJECT_TYPE(obj_desc)) { 516 case ACPI_TYPE_STRING: 517 case ACPI_TYPE_BUFFER: 518 519 /* Valid operand */ 520 break; 521 522 case ACPI_TYPE_INTEGER: 523 524 /* Highest priority conversion is to type Buffer */ 525 526 status = 527 acpi_ex_convert_to_buffer(obj_desc, 528 stack_ptr); 529 if (ACPI_FAILURE(status)) { 530 return_ACPI_STATUS(status); 531 } 532 533 if (obj_desc != *stack_ptr) { 534 acpi_ut_remove_reference(obj_desc); 535 } 536 break; 537 538 default: 539 ACPI_ERROR((AE_INFO, 540 "Needed [Integer/String/Buffer], found [%s] %p", 541 acpi_ut_get_object_type_name 542 (obj_desc), obj_desc)); 543 544 return_ACPI_STATUS(AE_AML_OPERAND_TYPE); 545 } 546 goto next_operand; 547 548 case ARGI_DATAOBJECT: 549 /* 550 * ARGI_DATAOBJECT is only used by the size_of operator. 551 * Need a buffer, string, package, or ref_of reference. 552 * 553 * The only reference allowed here is a direct reference to 554 * a namespace node. 555 */ 556 switch (ACPI_GET_OBJECT_TYPE(obj_desc)) { 557 case ACPI_TYPE_PACKAGE: 558 case ACPI_TYPE_STRING: 559 case ACPI_TYPE_BUFFER: 560 case ACPI_TYPE_LOCAL_REFERENCE: 561 562 /* Valid operand */ 563 break; 564 565 default: 566 ACPI_ERROR((AE_INFO, 567 "Needed [Buffer/String/Package/Reference], found [%s] %p", 568 acpi_ut_get_object_type_name 569 (obj_desc), obj_desc)); 570 571 return_ACPI_STATUS(AE_AML_OPERAND_TYPE); 572 } 573 goto next_operand; 574 575 case ARGI_COMPLEXOBJ: 576 577 /* Need a buffer or package or (ACPI 2.0) String */ 578 579 switch (ACPI_GET_OBJECT_TYPE(obj_desc)) { 580 case ACPI_TYPE_PACKAGE: 581 case ACPI_TYPE_STRING: 582 case ACPI_TYPE_BUFFER: 583 584 /* Valid operand */ 585 break; 586 587 default: 588 ACPI_ERROR((AE_INFO, 589 "Needed [Buffer/String/Package], found [%s] %p", 590 acpi_ut_get_object_type_name 591 (obj_desc), obj_desc)); 592 593 return_ACPI_STATUS(AE_AML_OPERAND_TYPE); 594 } 595 goto next_operand; 596 597 case ARGI_REGION_OR_BUFFER: /* Used by Load() only */ 598 599 /* Need an operand of type REGION or a BUFFER (which could be a resolved region field) */ 600 601 switch (ACPI_GET_OBJECT_TYPE(obj_desc)) { 602 case ACPI_TYPE_BUFFER: 603 case ACPI_TYPE_REGION: 604 605 /* Valid operand */ 606 break; 607 608 default: 609 ACPI_ERROR((AE_INFO, 610 "Needed [Region/Buffer], found [%s] %p", 611 acpi_ut_get_object_type_name 612 (obj_desc), obj_desc)); 613 614 return_ACPI_STATUS(AE_AML_OPERAND_TYPE); 615 } 616 goto next_operand; 617 618 case ARGI_DATAREFOBJ: 619 620 /* Used by the Store() operator only */ 621 622 switch (ACPI_GET_OBJECT_TYPE(obj_desc)) { 623 case ACPI_TYPE_INTEGER: 624 case ACPI_TYPE_PACKAGE: 625 case ACPI_TYPE_STRING: 626 case ACPI_TYPE_BUFFER: 627 case ACPI_TYPE_BUFFER_FIELD: 628 case ACPI_TYPE_LOCAL_REFERENCE: 629 case ACPI_TYPE_LOCAL_REGION_FIELD: 630 case ACPI_TYPE_LOCAL_BANK_FIELD: 631 case ACPI_TYPE_LOCAL_INDEX_FIELD: 632 case ACPI_TYPE_DDB_HANDLE: 633 634 /* Valid operand */ 635 break; 636 637 default: 638 639 if (acpi_gbl_enable_interpreter_slack) { 640 /* 641 * Enable original behavior of Store(), allowing any and all 642 * objects as the source operand. The ACPI spec does not 643 * allow this, however. 644 */ 645 break; 646 } 647 648 if (target_op == AML_DEBUG_OP) { 649 650 /* Allow store of any object to the Debug object */ 651 652 break; 653 } 654 655 ACPI_ERROR((AE_INFO, 656 "Needed Integer/Buffer/String/Package/Ref/Ddb], found [%s] %p", 657 acpi_ut_get_object_type_name 658 (obj_desc), obj_desc)); 659 660 return_ACPI_STATUS(AE_AML_OPERAND_TYPE); 661 } 662 goto next_operand; 663 664 default: 665 666 /* Unknown type */ 667 668 ACPI_ERROR((AE_INFO, 669 "Internal - Unknown ARGI (required operand) type %X", 670 this_arg_type)); 671 672 return_ACPI_STATUS(AE_BAD_PARAMETER); 673 } 674 675 /* 676 * Make sure that the original object was resolved to the 677 * required object type (Simple cases only). 678 */ 679 status = acpi_ex_check_object_type(type_needed, 680 ACPI_GET_OBJECT_TYPE 681 (*stack_ptr), *stack_ptr); 682 if (ACPI_FAILURE(status)) { 683 return_ACPI_STATUS(status); 684 } 685 686 next_operand: 687 /* 688 * If more operands needed, decrement stack_ptr to point 689 * to next operand on stack 690 */ 691 if (GET_CURRENT_ARG_TYPE(arg_types)) { 692 stack_ptr--; 693 } 694 } 695 696 ACPI_DUMP_OPERANDS(walk_state->operands, 697 acpi_ps_get_opcode_name(opcode), 698 walk_state->num_operands); 699 700 return_ACPI_STATUS(status); 701 } 702