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 - 2006, 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_REPORT_ERROR(("Unexpected notify object type [%s]\n", acpi_ut_get_type_name(node->type)));
 115
 116                         status = AE_AML_OPERAND_TYPE;
 117                         break;
 118                 }
 119 #ifdef ACPI_GPE_NOTIFY_CHECK
 120                 /*
 121                  * GPE method wake/notify check.  Here, we want to ensure that we
 122                  * don't receive any "device_wake" Notifies from a GPE _Lxx or _Exx
 123                  * GPE method during system runtime.  If we do, the GPE is marked
 124                  * as "wake-only" and disabled.
 125                  *
 126                  * 1) Is the Notify() value == device_wake?
 127                  * 2) Is this a GPE deferred method?  (An _Lxx or _Exx method)
 128                  * 3) Did the original GPE happen at system runtime?
 129                  *    (versus during wake)
 130                  *
 131                  * If all three cases are true, this is a wake-only GPE that should
 132                  * be disabled at runtime.
 133                  */
 134                 if (value == 2) {       /* device_wake */
 135                         status =
 136                             acpi_ev_check_for_wake_only_gpe(walk_state->
 137                                                             gpe_event_info);
 138                         if (ACPI_FAILURE(status)) {
 139                                 /* AE_WAKE_ONLY_GPE only error, means ignore this notify */
 140
 141                                 return_ACPI_STATUS(AE_OK)
 142                         }
 143                 }
 144 #endif
 145
 146                 /*
 147                  * Dispatch the notify to the appropriate handler
 148                  * NOTE: the request is queued for execution after this method
 149                  * completes.  The notify handlers are NOT invoked synchronously
 150                  * from this thread -- because handlers may in turn run other
 151                  * control methods.
 152                  */
 153                 status = acpi_ev_queue_notify_request(node, value);
 154                 break;
 155
 156         default:
 157
 158                 ACPI_REPORT_ERROR(("Unknown AML opcode %X\n",
 159                                    walk_state->opcode));
 160                 status = AE_AML_BAD_OPCODE;
 161         }
 162
 163         return_ACPI_STATUS(status);
 164 }
 165
 166 /*******************************************************************************
 167  *
 168  * FUNCTION:    acpi_ex_opcode_2A_2T_1R
 169  *
 170  * PARAMETERS:  walk_state          - Current walk state
 171  *
 172  * RETURN:      Status
 173  *
 174  * DESCRIPTION: Execute a dyadic operator (2 operands) with 2 output targets
 175  *              and one implicit return value.
 176  *
 177  ******************************************************************************/
 178
 179 acpi_status acpi_ex_opcode_2A_2T_1R(struct acpi_walk_state *walk_state)
 180 {
 181         union acpi_operand_object **operand = &walk_state->operands[0];
 182         union acpi_operand_object *return_desc1 = NULL;
 183         union acpi_operand_object *return_desc2 = NULL;
 184         acpi_status status;
 185
 186         ACPI_FUNCTION_TRACE_STR("ex_opcode_2A_2T_1R",
 187                                 acpi_ps_get_opcode_name(walk_state->opcode));
 188
 189         /* Execute the opcode */
 190
 191         switch (walk_state->opcode) {
 192         case AML_DIVIDE_OP:
 193
 194                 /* Divide (Dividend, Divisor, remainder_result quotient_result) */
 195
 196                 return_desc1 =
 197                     acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
 198                 if (!return_desc1) {
 199                         status = AE_NO_MEMORY;
 200                         goto cleanup;
 201                 }
 202
 203                 return_desc2 =
 204                     acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
 205                 if (!return_desc2) {
 206                         status = AE_NO_MEMORY;
 207                         goto cleanup;
 208                 }
 209
 210                 /* Quotient to return_desc1, remainder to return_desc2 */
 211
 212                 status = acpi_ut_divide(operand[0]->integer.value,
 213                                         operand[1]->integer.value,
 214                                         &return_desc1->integer.value,
 215                                         &return_desc2->integer.value);
 216                 if (ACPI_FAILURE(status)) {
 217                         goto cleanup;
 218                 }
 219                 break;
 220
 221         default:
 222
 223                 ACPI_REPORT_ERROR(("Unknown AML opcode %X\n",
 224                                    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                 }
 348
 349                 /* Allocate a new string object */
 350
 351                 return_desc = acpi_ut_create_string_object(length);
 352                 if (!return_desc) {
 353                         status = AE_NO_MEMORY;
 354                         goto cleanup;
 355                 }
 356
 357                 /*
 358                  * Copy the raw buffer data with no transform.
 359                  * (NULL terminated already)
 360                  */
 361                 ACPI_MEMCPY(return_desc->string.pointer,
 362                             operand[0]->buffer.pointer, length);
 363                 break;
 364
 365         case AML_CONCAT_RES_OP:
 366
 367                 /* concatenate_res_template (Buffer, Buffer, Result) (ACPI 2.0) */
 368
 369                 status = acpi_ex_concat_template(operand[0], operand[1],
 370                                                  &return_desc, walk_state);
 371                 break;
 372
 373         case AML_INDEX_OP:      /* Index (Source Index Result) */
 374
 375                 /* Create the internal return object */
 376
 377                 return_desc =
 378                     acpi_ut_create_internal_object(ACPI_TYPE_LOCAL_REFERENCE);
 379                 if (!return_desc) {
 380                         status = AE_NO_MEMORY;
 381                         goto cleanup;
 382                 }
 383
 384                 index = operand[1]->integer.value;
 385
 386                 /* At this point, the Source operand is a Package, Buffer, or String */
 387
 388                 if (ACPI_GET_OBJECT_TYPE(operand[0]) == ACPI_TYPE_PACKAGE) {
 389                         /* Object to be indexed is a Package */
 390
 391                         if (index >= operand[0]->package.count) {
 392                                 ACPI_REPORT_ERROR(("Index value (%X%8.8X) beyond package end (%X)\n", ACPI_FORMAT_UINT64(index), operand[0]->package.count));
 393                                 status = AE_AML_PACKAGE_LIMIT;
 394                                 goto cleanup;
 395                         }
 396
 397                         return_desc->reference.target_type = ACPI_TYPE_PACKAGE;
 398                         return_desc->reference.object = operand[0];
 399                         return_desc->reference.where =
 400                             &operand[0]->package.elements[index];
 401                 } else {
 402                         /* Object to be indexed is a Buffer/String */
 403
 404                         if (index >= operand[0]->buffer.length) {
 405                                 ACPI_REPORT_ERROR(("Index value (%X%8.8X) beyond end of buffer (%X)\n", ACPI_FORMAT_UINT64(index), operand[0]->buffer.length));
 406                                 status = AE_AML_BUFFER_LIMIT;
 407                                 goto cleanup;
 408                         }
 409
 410                         return_desc->reference.target_type =
 411                             ACPI_TYPE_BUFFER_FIELD;
 412                         return_desc->reference.object = operand[0];
 413                 }
 414
 415                 /*
 416                  * Add a reference to the target package/buffer/string for the life
 417                  * of the index.
 418                  */
 419                 acpi_ut_add_reference(operand[0]);
 420
 421                 /* Complete the Index reference object */
 422
 423                 return_desc->reference.opcode = AML_INDEX_OP;
 424                 return_desc->reference.offset = (u32) index;
 425
 426                 /* Store the reference to the Target */
 427
 428                 status = acpi_ex_store(return_desc, operand[2], walk_state);
 429
 430                 /* Return the reference */
 431
 432                 walk_state->result_obj = return_desc;
 433                 goto cleanup;
 434
 435         default:
 436
 437                 ACPI_REPORT_ERROR(("Unknown AML opcode %X\n",
 438                                    walk_state->opcode));
 439                 status = AE_AML_BAD_OPCODE;
 440                 break;
 441         }
 442
 443       store_result_to_target:
 444
 445         if (ACPI_SUCCESS(status)) {
 446                 /*
 447                  * Store the result of the operation (which is now in return_desc) into
 448                  * the Target descriptor.
 449                  */
 450                 status = acpi_ex_store(return_desc, operand[2], walk_state);
 451                 if (ACPI_FAILURE(status)) {
 452                         goto cleanup;
 453                 }
 454
 455                 if (!walk_state->result_obj) {
 456                         walk_state->result_obj = return_desc;
 457                 }
 458         }
 459
 460       cleanup:
 461
 462         /* Delete return object on error */
 463
 464         if (ACPI_FAILURE(status)) {
 465                 acpi_ut_remove_reference(return_desc);
 466         }
 467
 468         return_ACPI_STATUS(status);
 469 }
 470
 471 /*******************************************************************************
 472  *
 473  * FUNCTION:    acpi_ex_opcode_2A_0T_1R
 474  *
 475  * PARAMETERS:  walk_state          - Current walk state
 476  *
 477  * RETURN:      Status
 478  *
 479  * DESCRIPTION: Execute opcode with 2 arguments, no target, and a return value
 480  *
 481  ******************************************************************************/
 482
 483 acpi_status acpi_ex_opcode_2A_0T_1R(struct acpi_walk_state *walk_state)
 484 {
 485         union acpi_operand_object **operand = &walk_state->operands[0];
 486         union acpi_operand_object *return_desc = NULL;
 487         acpi_status status = AE_OK;
 488         u8 logical_result = FALSE;
 489
 490         ACPI_FUNCTION_TRACE_STR("ex_opcode_2A_0T_1R",
 491                                 acpi_ps_get_opcode_name(walk_state->opcode));
 492
 493         /* Create the internal return object */
 494
 495         return_desc = acpi_ut_create_internal_object(ACPI_TYPE_INTEGER);
 496         if (!return_desc) {
 497                 status = AE_NO_MEMORY;
 498                 goto cleanup;
 499         }
 500
 501         /* Execute the Opcode */
 502
 503         if (walk_state->op_info->flags & AML_LOGICAL_NUMERIC) {
 504                 /* logical_op (Operand0, Operand1) */
 505
 506                 status = acpi_ex_do_logical_numeric_op(walk_state->opcode,
 507                                                        operand[0]->integer.
 508                                                        value,
 509                                                        operand[1]->integer.
 510                                                        value, &logical_result);
 511                 goto store_logical_result;
 512         } else if (walk_state->op_info->flags & AML_LOGICAL) {
 513                 /* logical_op (Operand0, Operand1) */
 514
 515                 status = acpi_ex_do_logical_op(walk_state->opcode, operand[0],
 516                                                operand[1], &logical_result);
 517                 goto store_logical_result;
 518         }
 519
 520         switch (walk_state->opcode) {
 521         case AML_ACQUIRE_OP:    /* Acquire (mutex_object, Timeout) */
 522
 523                 status =
 524                     acpi_ex_acquire_mutex(operand[1], operand[0], walk_state);
 525                 if (status == AE_TIME) {
 526                         logical_result = TRUE;  /* TRUE = Acquire timed out */
 527                         status = AE_OK;
 528                 }
 529                 break;
 530
 531         case AML_WAIT_OP:       /* Wait (event_object, Timeout) */
 532
 533                 status = acpi_ex_system_wait_event(operand[1], operand[0]);
 534                 if (status == AE_TIME) {
 535                         logical_result = TRUE;  /* TRUE, Wait timed out */
 536                         status = AE_OK;
 537                 }
 538                 break;
 539
 540         default:
 541
 542                 ACPI_REPORT_ERROR(("Unknown AML opcode %X\n",
 543                                    walk_state->opcode));
 544                 status = AE_AML_BAD_OPCODE;
 545                 goto cleanup;
 546         }
 547
 548       store_logical_result:
 549         /*
 550          * Set return value to according to logical_result. logical TRUE (all ones)
 551          * Default is FALSE (zero)
 552          */
 553         if (logical_result) {
 554                 return_desc->integer.value = ACPI_INTEGER_MAX;
 555         }
 556
 557         walk_state->result_obj = return_desc;
 558
 559       cleanup:
 560
 561         /* Delete return object on error */
 562
 563         if (ACPI_FAILURE(status)) {
 564                 acpi_ut_remove_reference(return_desc);
 565         }
 566
 567         return_ACPI_STATUS(status);
 568 }