drivers/acpi/executer/exoparg2.c

   1 /******************************************************************************
   2  *
   3  * Module Name: exoparg2 - AML execution - opcodes with 2 arguments
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2005, R. Byron Moore
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions, and the following disclaimer,
  16  *    without modification.
  17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  18  *    substantially similar to the "NO WARRANTY" disclaimer below
  19  *    ("Disclaimer") and any redistribution must be conditioned upon
  20  *    including a substantially similar Disclaimer requirement for further
  21  *    binary redistribution.
  22  * 3. Neither the names of the above-listed copyright holders nor the names
  23  *    of any contributors may be used to endorse or promote products derived
  24  *    from this software without specific prior written permission.
  25  *
  26  * Alternatively, this software may be distributed under the terms of the
  27  * GNU General Public License ("GPL") version 2 as published by the Free
  28  * Software Foundation.
  29  *
  30  * NO WARRANTY
  31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  41  * POSSIBILITY OF SUCH DAMAGES.
  42  */
  43
  44 #include <acpi/acpi.h>
  45 #include <acpi/acparser.h>
  46 #include <acpi/acinterp.h>
  47 #include <acpi/acevents.h>
  48 #include <acpi/amlcode.h>
  49
  50 #define _COMPONENT          ACPI_EXECUTER
  51 ACPI_MODULE_NAME("exoparg2")
  52
  53 /*!
  54  * Naming convention for AML interpreter execution routines.
  55  *
  56  * The routines that begin execution of AML opcodes are named with a common
  57  * convention based upon the number of arguments, the number of target operands,
  58  * and whether or not a value is returned:
  59  *
  60  *      AcpiExOpcode_xA_yT_zR
  61  *
  62  * Where:
  63  *
  64  * xA - ARGUMENTS:    The number of arguments (input operands) that are
  65  *                    required for this opcode type (1 through 6 args).
  66  * yT - TARGETS:      The number of targets (output operands) that are required
  67  *                    for this opcode type (0, 1, or 2 targets).
  68  * zR - RETURN VALUE: Indicates whether this opcode type returns a value
  69  *                    as the function return (0 or 1).
  70  *
  71  * The AcpiExOpcode* functions are called via the Dispatcher component with
  72  * fully resolved operands.
  73 !*/
  74 /*******************************************************************************
  75  *
  76  * FUNCTION:    acpi_ex_opcode_2A_0T_0R
  77  *
  78  * PARAMETERS:  walk_state          - Current walk state
  79  *
  80  * RETURN:      Status
  81  *
  82  * DESCRIPTION: Execute opcode with two arguments, no target, and no return
  83  *              value.
  84  *
  85  * ALLOCATION:  Deletes both operands
  86  *
  87  ******************************************************************************/
  88 acpi_status acpi_ex_opcode_2A_0T_0R(struct acpi_walk_state *walk_state)
  89 {
  90         union acpi_operand_object **operand = &walk_state->operands[0];
  91         struct acpi_namespace_node *node;
  92         u32 value;
  93         acpi_status status = AE_OK;
  94
  95         ACPI_FUNCTION_TRACE_STR("ex_opcode_2A_0T_0R",
  96                                 acpi_ps_get_opcode_name(walk_state->opcode));
  97
  98         /* Examine the opcode */
  99
 100         switch (walk_state->opcode) {
 101         case AML_NOTIFY_OP:     /* Notify (notify_object, notify_value) */
 102
 103                 /* The first operand is a namespace node */
 104
 105                 node = (struct acpi_namespace_node *)operand[0];
 106
 107                 /* Second value is the notify value */
 108
 109                 value = (u32) operand[1]->integer.value;
 110
 111                 /* Are notifies allowed on this object? */
 112
 113                 if (!acpi_ev_is_notify_object(node)) {
 114                         ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
 115                                           "Unexpected notify object type [%s]\n",
 116                                           acpi_ut_get_type_name(node->type)));
 117
 118                         status = AE_AML_OPERAND_TYPE;
 119                         break;
 120                 }
 121 #ifdef ACPI_GPE_NOTIFY_CHECK
 122                 /*
 123                  * GPE method wake/notify check.  Here, we want to ensure that we
 124                  * don't receive any "device_wake" Notifies from a GPE _Lxx or _Exx
 125                  * GPE method during system runtime.  If we do, the GPE is marked
 126                  * as "wake-only" and disabled.
 127                  *
 128                  * 1) Is the Notify() value == device_wake?
 129                  * 2) Is this a GPE deferred method?  (An _Lxx or _Exx method)
 130                  * 3) Did the original GPE happen at system runtime?
 131                  *    (versus during wake)
 132                  *
 133                  * If all three cases are true, this is a wake-only GPE that should
 134                  * be disabled at runtime.
 135                  */
 136                 if (value == 2) {       /* device_wake */
 137                         status =
 138                             acpi_ev_check_for_wake_only_gpe(walk_state->
 139                                                             gpe_event_info);
 140                         if (ACPI_FAILURE(status)) {
 141                                 /* AE_WAKE_ONLY_GPE only error, means ignore this notify */
 142
 143                                 return_ACPI_STATUS(AE_OK)
 144                         }
 145                 }
 146 #endif
 147
 148                 /*
 149                  * Dispatch the notify to the appropriate handler
 150                  * NOTE: the request is queued for execution after this method
 151                  * completes.  The notify handlers are NOT invoked synchronously
 152                  * from this thread -- because handlers may in turn run other
 153                  * control methods.
 154                  */
 155                 status = acpi_ev_queue_notify_request(node, value);
 156                 break;
 157
 158         default:
 159
 160                 ACPI_REPORT_ERROR(("acpi_ex_opcode_2A_0T_0R: Unknown opcode %X\n", walk_state->opcode));
 161                 status = AE_AML_BAD_OPCODE;
 162         }
 163
 164         return_ACPI_STATUS(status);
 165 }
 166
 167 /*******************************************************************************
 168  *
 169  * FUNCTION:    acpi_ex_opcode_2A_2T_1R
 170  *
 171  * PARAMETERS:  walk_state          - Current walk state
 172  *
 173  * RETURN:      Status
 174  *
 175  * DESCRIPTION: Execute a dyadic operator (2 operands) with 2 output targets
 176  *              and one implicit return value.
 177  *
 178  ******************************************************************************/
 179
 180 acpi_status acpi_ex_opcode_2A_2T_1R(struct acpi_walk_state *walk_state)
 181 {
 182         union acpi_operand_object **operand = &walk_state->operands[0];
 183         union acpi_operand_object *return_desc1 = NULL;
 184         union acpi_operand_object *return_desc2 = NULL;
 185         acpi_status status;
 186
 187         ACPI_FUNCTION_TRACE_STR("ex_opcode_2A_2T_1R",
 188                                 acpi_ps_get_opcode_name(walk_state->opcode));
 189
 190         /* Execute the opcode */
 191
 192         switch (walk_state->opcode) {
 193         case AML_DIVIDE_OP:
 194
 195                 /* Divide (Dividend, Divisor, remainder_result quotient_result) */
 196
 197                 return_desc1 =
 198                     acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
 199                 if (!return_desc1) {
 200                         status = AE_NO_MEMORY;
 201                         goto cleanup;
 202                 }
 203
 204                 return_desc2 =
 205                     acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
 206                 if (!return_desc2) {
 207                         status = AE_NO_MEMORY;
 208                         goto cleanup;
 209                 }
 210
 211                 /* Quotient to return_desc1, remainder to return_desc2 */
 212
 213                 status = acpi_ut_divide(operand[0]->integer.value,
 214                                         operand[1]->integer.value,
 215                                         &return_desc1->integer.value,
 216                                         &return_desc2->integer.value);
 217                 if (ACPI_FAILURE(status)) {
 218                         goto cleanup;
 219                 }
 220                 break;
 221
 222         default:
 223
 224                 ACPI_REPORT_ERROR(("acpi_ex_opcode_2A_2T_1R: Unknown opcode %X\n", walk_state->opcode));
 225                 status = AE_AML_BAD_OPCODE;
 226                 goto cleanup;
 227         }
 228
 229         /* Store the results to the target reference operands */
 230
 231         status = acpi_ex_store(return_desc2, operand[2], walk_state);
 232         if (ACPI_FAILURE(status)) {
 233                 goto cleanup;
 234         }
 235
 236         status = acpi_ex_store(return_desc1, operand[3], walk_state);
 237         if (ACPI_FAILURE(status)) {
 238                 goto cleanup;
 239         }
 240
 241         /* Return the remainder */
 242
 243         walk_state->result_obj = return_desc1;
 244
 245       cleanup:
 246         /*
 247          * Since the remainder is not returned indirectly, remove a reference to
 248          * it. Only the quotient is returned indirectly.
 249          */
 250         acpi_ut_remove_reference(return_desc2);
 251
 252         if (ACPI_FAILURE(status)) {
 253                 /* Delete the return object */
 254
 255                 acpi_ut_remove_reference(return_desc1);
 256         }
 257
 258         return_ACPI_STATUS(status);
 259 }
 260
 261 /*******************************************************************************
 262  *
 263  * FUNCTION:    acpi_ex_opcode_2A_1T_1R
 264  *
 265  * PARAMETERS:  walk_state          - Current walk state
 266  *
 267  * RETURN:      Status
 268  *
 269  * DESCRIPTION: Execute opcode with two arguments, one target, and a return
 270  *              value.
 271  *
 272  ******************************************************************************/
 273
 274 acpi_status acpi_ex_opcode_2A_1T_1R(struct acpi_walk_state *walk_state)
 275 {
 276         union acpi_operand_object **operand = &walk_state->operands[0];
 277         union acpi_operand_object *return_desc = NULL;
 278         acpi_integer index;
 279         acpi_status status = AE_OK;
 280         acpi_size length;
 281
 282         ACPI_FUNCTION_TRACE_STR("ex_opcode_2A_1T_1R",
 283                                 acpi_ps_get_opcode_name(walk_state->opcode));
 284
 285         /* Execute the opcode */
 286
 287         if (walk_state->op_info->flags & AML_MATH) {
 288                 /* All simple math opcodes (add, etc.) */
 289
 290                 return_desc = acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
 291                 if (!return_desc) {
 292                         status = AE_NO_MEMORY;
 293                         goto cleanup;
 294                 }
 295
 296                 return_desc->integer.value =
 297                     acpi_ex_do_math_op(walk_state->opcode,
 298                                        operand[0]->integer.value,
 299                                        operand[1]->integer.value);
 300                 goto store_result_to_target;
 301         }
 302
 303         switch (walk_state->opcode) {
 304         case AML_MOD_OP:        /* Mod (Dividend, Divisor, remainder_result (ACPI 2.0) */
 305
 306                 return_desc = acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
 307                 if (!return_desc) {
 308                         status = AE_NO_MEMORY;
 309                         goto cleanup;
 310                 }
 311
 312                 /* return_desc will contain the remainder */
 313
 314                 status = acpi_ut_divide(operand[0]->integer.value,
 315                                         operand[1]->integer.value,
 316                                         NULL, &return_desc->integer.value);
 317                 break;
 318
 319         case AML_CONCAT_OP:     /* Concatenate (Data1, Data2, Result) */
 320
 321                 status = acpi_ex_do_concatenate(operand[0], operand[1],
 322                                                 &return_desc, walk_state);
 323                 break;
 324
 325         case AML_TO_STRING_OP:  /* to_string (Buffer, Length, Result) (ACPI 2.0) */
 326
 327                 /*
 328                  * Input object is guaranteed to be a buffer at this point (it may have
 329                  * been converted.)  Copy the raw buffer data to a new object of
 330                  * type String.
 331                  */
 332
 333                 /*
 334                  * Get the length of the new string. It is the smallest of:
 335                  * 1) Length of the input buffer
 336                  * 2) Max length as specified in the to_string operator
 337                  * 3) Length of input buffer up to a zero byte (null terminator)
 338                  *
 339                  * NOTE: A length of zero is ok, and will create a zero-length, null
 340                  *       terminated string.
 341                  */
 342                 length = 0;
 343                 while ((length < operand[0]->buffer.length) &&
 344                        (length < operand[1]->integer.value) &&
 345                        (operand[0]->buffer.pointer[length])) {
 346                         length++;
 347                         if (length > ACPI_MAX_STRING_CONVERSION) {
 348                                 status = AE_AML_STRING_LIMIT;
 349                                 goto cleanup;
 350                         }
 351                 }
 352
 353                 /* Allocate a new string object */
 354
 355                 return_desc = acpi_ut_create_string_object(length);
 356                 if (!return_desc) {
 357                         status = AE_NO_MEMORY;
 358                         goto cleanup;
 359                 }
 360
 361                 /* Copy the raw buffer data with no transform. NULL terminated already */
 362
 363                 ACPI_MEMCPY(return_desc->string.pointer,
 364                             operand[0]->buffer.pointer, length);
 365                 break;
 366
 367         case AML_CONCAT_RES_OP:
 368
 369                 /* concatenate_res_template (Buffer, Buffer, Result) (ACPI 2.0) */
 370
 371                 status = acpi_ex_concat_template(operand[0], operand[1],
 372                                                  &return_desc, walk_state);
 373                 break;
 374
 375         case AML_INDEX_OP:      /* Index (Source Index Result) */
 376
 377                 /* Create the internal return object */
 378
 379                 return_desc =
 380                     acpi_ut_create_internal_object(ACPI_TYPE_LOCAL_REFERENCE);
 381                 if (!return_desc) {
 382                         status = AE_NO_MEMORY;
 383                         goto cleanup;
 384                 }
 385
 386                 index = operand[1]->integer.value;
 387
 388                 /* At this point, the Source operand is a Package, Buffer, or String */
 389
 390                 if (ACPI_GET_OBJECT_TYPE(operand[0]) == ACPI_TYPE_PACKAGE) {
 391                         /* Object to be indexed is a Package */
 392
 393                         if (index >= operand[0]->package.count) {
 394                                 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
 395                                                   "Index value (%X%8.8X) beyond package end (%X)\n",
 396                                                   ACPI_FORMAT_UINT64(index),
 397                                                   operand[0]->package.count));
 398                                 status = AE_AML_PACKAGE_LIMIT;
 399                                 goto cleanup;
 400                         }
 401
 402                         return_desc->reference.target_type = ACPI_TYPE_PACKAGE;
 403                         return_desc->reference.object = operand[0];
 404                         return_desc->reference.where =
 405                             &operand[0]->package.elements[index];
 406                 } else {
 407                         /* Object to be indexed is a Buffer/String */
 408
 409                         if (index >= operand[0]->buffer.length) {
 410                                 ACPI_DEBUG_PRINT((ACPI_DB_ERROR,
 411                                                   "Index value (%X%8.8X) beyond end of buffer (%X)\n",
 412                                                   ACPI_FORMAT_UINT64(index),
 413                                                   operand[0]->buffer.length));
 414                                 status = AE_AML_BUFFER_LIMIT;
 415                                 goto cleanup;
 416                         }
 417
 418                         return_desc->reference.target_type =
 419                             ACPI_TYPE_BUFFER_FIELD;
 420                         return_desc->reference.object = operand[0];
 421                 }
 422
 423                 /*
 424                  * Add a reference to the target package/buffer/string for the life
 425                  * of the index.
 426                  */
 427                 acpi_ut_add_reference(operand[0]);
 428
 429                 /* Complete the Index reference object */
 430
 431                 return_desc->reference.opcode = AML_INDEX_OP;
 432                 return_desc->reference.offset = (u32) index;
 433
 434                 /* Store the reference to the Target */
 435
 436                 status = acpi_ex_store(return_desc, operand[2], walk_state);
 437
 438                 /* Return the reference */
 439
 440                 walk_state->result_obj = return_desc;
 441                 goto cleanup;
 442
 443         default:
 444
 445                 ACPI_REPORT_ERROR(("acpi_ex_opcode_2A_1T_1R: Unknown opcode %X\n", walk_state->opcode));
 446                 status = AE_AML_BAD_OPCODE;
 447                 break;
 448         }
 449
 450       store_result_to_target:
 451
 452         if (ACPI_SUCCESS(status)) {
 453                 /*
 454                  * Store the result of the operation (which is now in return_desc) into
 455                  * the Target descriptor.
 456                  */
 457                 status = acpi_ex_store(return_desc, operand[2], walk_state);
 458                 if (ACPI_FAILURE(status)) {
 459                         goto cleanup;
 460                 }
 461
 462                 if (!walk_state->result_obj) {
 463                         walk_state->result_obj = return_desc;
 464                 }
 465         }
 466
 467       cleanup:
 468
 469         /* Delete return object on error */
 470
 471         if (ACPI_FAILURE(status)) {
 472                 acpi_ut_remove_reference(return_desc);
 473         }
 474
 475         return_ACPI_STATUS(status);
 476 }
 477
 478 /*******************************************************************************
 479  *
 480  * FUNCTION:    acpi_ex_opcode_2A_0T_1R
 481  *
 482  * PARAMETERS:  walk_state          - Current walk state
 483  *
 484  * RETURN:      Status
 485  *
 486  * DESCRIPTION: Execute opcode with 2 arguments, no target, and a return value
 487  *
 488  ******************************************************************************/
 489
 490 acpi_status acpi_ex_opcode_2A_0T_1R(struct acpi_walk_state *walk_state)
 491 {
 492         union acpi_operand_object **operand = &walk_state->operands[0];
 493         union acpi_operand_object *return_desc = NULL;
 494         acpi_status status = AE_OK;
 495         u8 logical_result = FALSE;
 496
 497         ACPI_FUNCTION_TRACE_STR("ex_opcode_2A_0T_1R",
 498                                 acpi_ps_get_opcode_name(walk_state->opcode));
 499
 500         /* Create the internal return object */
 501
 502         return_desc = acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
 503         if (!return_desc) {
 504                 status = AE_NO_MEMORY;
 505                 goto cleanup;
 506         }
 507
 508         /* Execute the Opcode */
 509
 510         if (walk_state->op_info->flags & AML_LOGICAL_NUMERIC) {
 511                 /* logical_op (Operand0, Operand1) */
 512
 513                 status = acpi_ex_do_logical_numeric_op(walk_state->opcode,
 514                                                        operand[0]->integer.
 515                                                        value,
 516                                                        operand[1]->integer.
 517                                                        value, &logical_result);
 518                 goto store_logical_result;
 519         } else if (walk_state->op_info->flags & AML_LOGICAL) {
 520                 /* logical_op (Operand0, Operand1) */
 521
 522                 status = acpi_ex_do_logical_op(walk_state->opcode, operand[0],
 523                                                operand[1], &logical_result);
 524                 goto store_logical_result;
 525         }
 526
 527         switch (walk_state->opcode) {
 528         case AML_ACQUIRE_OP:    /* Acquire (mutex_object, Timeout) */
 529
 530                 status =
 531                     acpi_ex_acquire_mutex(operand[1], operand[0], walk_state);
 532                 if (status == AE_TIME) {
 533                         logical_result = TRUE;  /* TRUE = Acquire timed out */
 534                         status = AE_OK;
 535                 }
 536                 break;
 537
 538         case AML_WAIT_OP:       /* Wait (event_object, Timeout) */
 539
 540                 status = acpi_ex_system_wait_event(operand[1], operand[0]);
 541                 if (status == AE_TIME) {
 542                         logical_result = TRUE;  /* TRUE, Wait timed out */
 543                         status = AE_OK;
 544                 }
 545                 break;
 546
 547         default:
 548
 549                 ACPI_REPORT_ERROR(("acpi_ex_opcode_2A_0T_1R: Unknown opcode %X\n", walk_state->opcode));
 550                 status = AE_AML_BAD_OPCODE;
 551                 goto cleanup;
 552         }
 553
 554       store_logical_result:
 555         /*
 556          * Set return value to according to logical_result. logical TRUE (all ones)
 557          * Default is FALSE (zero)
 558          */
 559         if (logical_result) {
 560                 return_desc->integer.value = ACPI_INTEGER_MAX;
 561         }
 562
 563         walk_state->result_obj = return_desc;
 564
 565       cleanup:
 566
 567         /* Delete return object on error */
 568
 569         if (ACPI_FAILURE(status)) {
 570                 acpi_ut_remove_reference(return_desc);
 571         }
 572
 573         return_ACPI_STATUS(status);
 574 }