drivers/acpi/acpica/exoparg3.c

   1 /******************************************************************************
   2  *
   3  * Module Name: exoparg3 - AML execution - opcodes with 3 arguments
   4  *
   5  *****************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2016, Intel Corp.
   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 "accommon.h"
  46 #include "acinterp.h"
  47 #include "acparser.h"
  48 #include "amlcode.h"
  49
  50 #define _COMPONENT          ACPI_EXECUTER
  51 ACPI_MODULE_NAME("exoparg3")
  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_3A_0T_0R
  77  *
  78  * PARAMETERS:  walk_state          - Current walk state
  79  *
  80  * RETURN:      Status
  81  *
  82  * DESCRIPTION: Execute Triadic operator (3 operands)
  83  *
  84  ******************************************************************************/
  85 acpi_status acpi_ex_opcode_3A_0T_0R(struct acpi_walk_state *walk_state)
  86 {
  87         union acpi_operand_object **operand = &walk_state->operands[0];
  88         struct acpi_signal_fatal_info *fatal;
  89         acpi_status status = AE_OK;
  90
  91         ACPI_FUNCTION_TRACE_STR(ex_opcode_3A_0T_0R,
  92                                 acpi_ps_get_opcode_name(walk_state->opcode));
  93
  94         switch (walk_state->opcode) {
  95         case AML_FATAL_OP:      /* Fatal (fatal_type fatal_code fatal_arg) */
  96
  97                 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
  98                                   "FatalOp: Type %X Code %X Arg %X "
  99                                   "<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<\n",
 100                                   (u32)operand[0]->integer.value,
 101                                   (u32)operand[1]->integer.value,
 102                                   (u32)operand[2]->integer.value));
 103
 104                 fatal = ACPI_ALLOCATE(sizeof(struct acpi_signal_fatal_info));
 105                 if (fatal) {
 106                         fatal->type = (u32) operand[0]->integer.value;
 107                         fatal->code = (u32) operand[1]->integer.value;
 108                         fatal->argument = (u32) operand[2]->integer.value;
 109                 }
 110
 111                 /* Always signal the OS! */
 112
 113                 status = acpi_os_signal(ACPI_SIGNAL_FATAL, fatal);
 114
 115                 /* Might return while OS is shutting down, just continue */
 116
 117                 ACPI_FREE(fatal);
 118                 goto cleanup;
 119
 120         case AML_EXTERNAL_OP:
 121                 /*
 122                  * If the interpreter sees this opcode, just ignore it. The External
 123                  * op is intended for use by disassemblers in order to properly
 124                  * disassemble control method invocations. The opcode or group of
 125                  * opcodes should be surrounded by an "if (0)" clause to ensure that
 126                  * AML interpreters never see the opcode.
 127                  */
 128                 status = AE_OK;
 129                 goto cleanup;
 130
 131         default:
 132
 133                 ACPI_ERROR((AE_INFO, "Unknown AML opcode 0x%X",
 134                             walk_state->opcode));
 135
 136                 status = AE_AML_BAD_OPCODE;
 137                 goto cleanup;
 138         }
 139
 140 cleanup:
 141
 142         return_ACPI_STATUS(status);
 143 }
 144
 145 /*******************************************************************************
 146  *
 147  * FUNCTION:    acpi_ex_opcode_3A_1T_1R
 148  *
 149  * PARAMETERS:  walk_state          - Current walk state
 150  *
 151  * RETURN:      Status
 152  *
 153  * DESCRIPTION: Execute Triadic operator (3 operands)
 154  *
 155  ******************************************************************************/
 156
 157 acpi_status acpi_ex_opcode_3A_1T_1R(struct acpi_walk_state *walk_state)
 158 {
 159         union acpi_operand_object **operand = &walk_state->operands[0];
 160         union acpi_operand_object *return_desc = NULL;
 161         char *buffer = NULL;
 162         acpi_status status = AE_OK;
 163         u64 index;
 164         acpi_size length;
 165
 166         ACPI_FUNCTION_TRACE_STR(ex_opcode_3A_1T_1R,
 167                                 acpi_ps_get_opcode_name(walk_state->opcode));
 168
 169         switch (walk_state->opcode) {
 170         case AML_MID_OP:        /* Mid (Source[0], Index[1], Length[2], Result[3]) */
 171                 /*
 172                  * Create the return object. The Source operand is guaranteed to be
 173                  * either a String or a Buffer, so just use its type.
 174                  */
 175                 return_desc = acpi_ut_create_internal_object((operand[0])->
 176                                                              common.type);
 177                 if (!return_desc) {
 178                         status = AE_NO_MEMORY;
 179                         goto cleanup;
 180                 }
 181
 182                 /* Get the Integer values from the objects */
 183
 184                 index = operand[1]->integer.value;
 185                 length = (acpi_size) operand[2]->integer.value;
 186
 187                 /*
 188                  * If the index is beyond the length of the String/Buffer, or if the
 189                  * requested length is zero, return a zero-length String/Buffer
 190                  */
 191                 if (index >= operand[0]->string.length) {
 192                         length = 0;
 193                 }
 194
 195                 /* Truncate request if larger than the actual String/Buffer */
 196
 197                 else if ((index + length) > operand[0]->string.length) {
 198                         length =
 199                             (acpi_size) operand[0]->string.length -
 200                             (acpi_size) index;
 201                 }
 202
 203                 /* Strings always have a sub-pointer, not so for buffers */
 204
 205                 switch ((operand[0])->common.type) {
 206                 case ACPI_TYPE_STRING:
 207
 208                         /* Always allocate a new buffer for the String */
 209
 210                         buffer = ACPI_ALLOCATE_ZEROED((acpi_size) length + 1);
 211                         if (!buffer) {
 212                                 status = AE_NO_MEMORY;
 213                                 goto cleanup;
 214                         }
 215                         break;
 216
 217                 case ACPI_TYPE_BUFFER:
 218
 219                         /* If the requested length is zero, don't allocate a buffer */
 220
 221                         if (length > 0) {
 222
 223                                 /* Allocate a new buffer for the Buffer */
 224
 225                                 buffer = ACPI_ALLOCATE_ZEROED(length);
 226                                 if (!buffer) {
 227                                         status = AE_NO_MEMORY;
 228                                         goto cleanup;
 229                                 }
 230                         }
 231                         break;
 232
 233                 default:        /* Should not happen */
 234
 235                         status = AE_AML_OPERAND_TYPE;
 236                         goto cleanup;
 237                 }
 238
 239                 if (buffer) {
 240
 241                         /* We have a buffer, copy the portion requested */
 242
 243                         memcpy(buffer,
 244                                operand[0]->string.pointer + index, length);
 245                 }
 246
 247                 /* Set the length of the new String/Buffer */
 248
 249                 return_desc->string.pointer = buffer;
 250                 return_desc->string.length = (u32) length;
 251
 252                 /* Mark buffer initialized */
 253
 254                 return_desc->buffer.flags |= AOPOBJ_DATA_VALID;
 255                 break;
 256
 257         default:
 258
 259                 ACPI_ERROR((AE_INFO, "Unknown AML opcode 0x%X",
 260                             walk_state->opcode));
 261
 262                 status = AE_AML_BAD_OPCODE;
 263                 goto cleanup;
 264         }
 265
 266         /* Store the result in the target */
 267
 268         status = acpi_ex_store(return_desc, operand[3], walk_state);
 269
 270 cleanup:
 271
 272         /* Delete return object on error */
 273
 274         if (ACPI_FAILURE(status) || walk_state->result_obj) {
 275                 acpi_ut_remove_reference(return_desc);
 276                 walk_state->result_obj = NULL;
 277         } else {
 278                 /* Set the return object and exit */
 279
 280                 walk_state->result_obj = return_desc;
 281         }
 282
 283         return_ACPI_STATUS(status);
 284 }