| 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.h" |
| 45 | #include "accommon.h" |
| 46 | #include "acinterp.h" |
| 47 | #include "acparser.h" |
| 48 | #include "amlcode.h" |
| 49 | |
| 50 | |
| 51 | #define _COMPONENT ACPI_EXECUTER |
| 52 | ACPI_MODULE_NAME ("exoparg3" ) |
| 53 | |
| 54 | |
| 55 | /*! |
| 56 | * Naming convention for AML interpreter execution routines. |
| 57 | * |
| 58 | * The routines that begin execution of AML opcodes are named with a common |
| 59 | * convention based upon the number of arguments, the number of target operands, |
| 60 | * and whether or not a value is returned: |
| 61 | * |
| 62 | * AcpiExOpcode_xA_yT_zR |
| 63 | * |
| 64 | * Where: |
| 65 | * |
| 66 | * xA - ARGUMENTS: The number of arguments (input operands) that are |
| 67 | * required for this opcode type (1 through 6 args). |
| 68 | * yT - TARGETS: The number of targets (output operands) that are required |
| 69 | * for this opcode type (0, 1, or 2 targets). |
| 70 | * zR - RETURN VALUE: Indicates whether this opcode type returns a value |
| 71 | * as the function return (0 or 1). |
| 72 | * |
| 73 | * The AcpiExOpcode* functions are called via the Dispatcher component with |
| 74 | * fully resolved operands. |
| 75 | !*/ |
| 76 | |
| 77 | |
| 78 | /******************************************************************************* |
| 79 | * |
| 80 | * FUNCTION: AcpiExOpcode_3A_0T_0R |
| 81 | * |
| 82 | * PARAMETERS: WalkState - Current walk state |
| 83 | * |
| 84 | * RETURN: Status |
| 85 | * |
| 86 | * DESCRIPTION: Execute Triadic operator (3 operands) |
| 87 | * |
| 88 | ******************************************************************************/ |
| 89 | |
| 90 | ACPI_STATUS |
| 91 | AcpiExOpcode_3A_0T_0R ( |
| 92 | ACPI_WALK_STATE *WalkState) |
| 93 | { |
| 94 | ACPI_OPERAND_OBJECT **Operand = &WalkState->Operands[0]; |
| 95 | ACPI_SIGNAL_FATAL_INFO *Fatal; |
| 96 | ACPI_STATUS Status = AE_OK; |
| 97 | |
| 98 | |
| 99 | ACPI_FUNCTION_TRACE_STR (ExOpcode_3A_0T_0R, |
| 100 | AcpiPsGetOpcodeName (WalkState->Opcode)); |
| 101 | |
| 102 | |
| 103 | switch (WalkState->Opcode) |
| 104 | { |
| 105 | case AML_FATAL_OP: /* Fatal (FatalType FatalCode FatalArg) */ |
| 106 | |
| 107 | ACPI_DEBUG_PRINT ((ACPI_DB_INFO, |
| 108 | "FatalOp: Type %X Code %X Arg %X " |
| 109 | "<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<\n" , |
| 110 | (UINT32) Operand[0]->Integer.Value, |
| 111 | (UINT32) Operand[1]->Integer.Value, |
| 112 | (UINT32) Operand[2]->Integer.Value)); |
| 113 | |
| 114 | Fatal = ACPI_ALLOCATE (sizeof (ACPI_SIGNAL_FATAL_INFO)); |
| 115 | if (Fatal) |
| 116 | { |
| 117 | Fatal->Type = (UINT32) Operand[0]->Integer.Value; |
| 118 | Fatal->Code = (UINT32) Operand[1]->Integer.Value; |
| 119 | Fatal->Argument = (UINT32) Operand[2]->Integer.Value; |
| 120 | } |
| 121 | |
| 122 | /* Always signal the OS! */ |
| 123 | |
| 124 | Status = AcpiOsSignal (ACPI_SIGNAL_FATAL, Fatal); |
| 125 | |
| 126 | /* Might return while OS is shutting down, just continue */ |
| 127 | |
| 128 | ACPI_FREE (Fatal); |
| 129 | goto Cleanup; |
| 130 | |
| 131 | case AML_EXTERNAL_OP: |
| 132 | /* |
| 133 | * If the interpreter sees this opcode, just ignore it. The External |
| 134 | * op is intended for use by disassemblers in order to properly |
| 135 | * disassemble control method invocations. The opcode or group of |
| 136 | * opcodes should be surrounded by an "if (0)" clause to ensure that |
| 137 | * AML interpreters never see the opcode. Thus, something is |
| 138 | * wrong if an external opcode ever gets here. |
| 139 | */ |
| 140 | ACPI_ERROR ((AE_INFO, "Executed External Op" )); |
| 141 | Status = AE_OK; |
| 142 | goto Cleanup; |
| 143 | |
| 144 | default: |
| 145 | |
| 146 | ACPI_ERROR ((AE_INFO, "Unknown AML opcode 0x%X" , |
| 147 | WalkState->Opcode)); |
| 148 | |
| 149 | Status = AE_AML_BAD_OPCODE; |
| 150 | goto Cleanup; |
| 151 | } |
| 152 | |
| 153 | |
| 154 | Cleanup: |
| 155 | |
| 156 | return_ACPI_STATUS (Status); |
| 157 | } |
| 158 | |
| 159 | |
| 160 | /******************************************************************************* |
| 161 | * |
| 162 | * FUNCTION: AcpiExOpcode_3A_1T_1R |
| 163 | * |
| 164 | * PARAMETERS: WalkState - Current walk state |
| 165 | * |
| 166 | * RETURN: Status |
| 167 | * |
| 168 | * DESCRIPTION: Execute Triadic operator (3 operands) |
| 169 | * |
| 170 | ******************************************************************************/ |
| 171 | |
| 172 | ACPI_STATUS |
| 173 | AcpiExOpcode_3A_1T_1R ( |
| 174 | ACPI_WALK_STATE *WalkState) |
| 175 | { |
| 176 | ACPI_OPERAND_OBJECT **Operand = &WalkState->Operands[0]; |
| 177 | ACPI_OPERAND_OBJECT *ReturnDesc = NULL; |
| 178 | char *Buffer = NULL; |
| 179 | ACPI_STATUS Status = AE_OK; |
| 180 | UINT64 Index; |
| 181 | ACPI_SIZE Length; |
| 182 | |
| 183 | |
| 184 | ACPI_FUNCTION_TRACE_STR (ExOpcode_3A_1T_1R, |
| 185 | AcpiPsGetOpcodeName (WalkState->Opcode)); |
| 186 | |
| 187 | |
| 188 | switch (WalkState->Opcode) |
| 189 | { |
| 190 | case AML_MID_OP: /* Mid (Source[0], Index[1], Length[2], Result[3]) */ |
| 191 | /* |
| 192 | * Create the return object. The Source operand is guaranteed to be |
| 193 | * either a String or a Buffer, so just use its type. |
| 194 | */ |
| 195 | ReturnDesc = AcpiUtCreateInternalObject ( |
| 196 | (Operand[0])->Common.Type); |
| 197 | if (!ReturnDesc) |
| 198 | { |
| 199 | Status = AE_NO_MEMORY; |
| 200 | goto Cleanup; |
| 201 | } |
| 202 | |
| 203 | /* Get the Integer values from the objects */ |
| 204 | |
| 205 | Index = Operand[1]->Integer.Value; |
| 206 | Length = (ACPI_SIZE) Operand[2]->Integer.Value; |
| 207 | |
| 208 | /* |
| 209 | * If the index is beyond the length of the String/Buffer, or if the |
| 210 | * requested length is zero, return a zero-length String/Buffer |
| 211 | */ |
| 212 | if (Index >= Operand[0]->String.Length) |
| 213 | { |
| 214 | Length = 0; |
| 215 | } |
| 216 | |
| 217 | /* Truncate request if larger than the actual String/Buffer */ |
| 218 | |
| 219 | else if ((Index + Length) > Operand[0]->String.Length) |
| 220 | { |
| 221 | Length = |
| 222 | (ACPI_SIZE) Operand[0]->String.Length - (ACPI_SIZE) Index; |
| 223 | } |
| 224 | |
| 225 | /* Strings always have a sub-pointer, not so for buffers */ |
| 226 | |
| 227 | switch ((Operand[0])->Common.Type) |
| 228 | { |
| 229 | case ACPI_TYPE_STRING: |
| 230 | |
| 231 | /* Always allocate a new buffer for the String */ |
| 232 | |
| 233 | Buffer = ACPI_ALLOCATE_ZEROED ((ACPI_SIZE) Length + 1); |
| 234 | if (!Buffer) |
| 235 | { |
| 236 | Status = AE_NO_MEMORY; |
| 237 | goto Cleanup; |
| 238 | } |
| 239 | break; |
| 240 | |
| 241 | case ACPI_TYPE_BUFFER: |
| 242 | |
| 243 | /* If the requested length is zero, don't allocate a buffer */ |
| 244 | |
| 245 | if (Length > 0) |
| 246 | { |
| 247 | /* Allocate a new buffer for the Buffer */ |
| 248 | |
| 249 | Buffer = ACPI_ALLOCATE_ZEROED (Length); |
| 250 | if (!Buffer) |
| 251 | { |
| 252 | Status = AE_NO_MEMORY; |
| 253 | goto Cleanup; |
| 254 | } |
| 255 | } |
| 256 | break; |
| 257 | |
| 258 | default: /* Should not happen */ |
| 259 | |
| 260 | Status = AE_AML_OPERAND_TYPE; |
| 261 | goto Cleanup; |
| 262 | } |
| 263 | |
| 264 | if (Buffer) |
| 265 | { |
| 266 | /* We have a buffer, copy the portion requested */ |
| 267 | |
| 268 | memcpy (Buffer, |
| 269 | Operand[0]->String.Pointer + Index, Length); |
| 270 | } |
| 271 | |
| 272 | /* Set the length of the new String/Buffer */ |
| 273 | |
| 274 | ReturnDesc->String.Pointer = Buffer; |
| 275 | ReturnDesc->String.Length = (UINT32) Length; |
| 276 | |
| 277 | /* Mark buffer initialized */ |
| 278 | |
| 279 | ReturnDesc->Buffer.Flags |= AOPOBJ_DATA_VALID; |
| 280 | break; |
| 281 | |
| 282 | default: |
| 283 | |
| 284 | ACPI_ERROR ((AE_INFO, "Unknown AML opcode 0x%X" , |
| 285 | WalkState->Opcode)); |
| 286 | |
| 287 | Status = AE_AML_BAD_OPCODE; |
| 288 | goto Cleanup; |
| 289 | } |
| 290 | |
| 291 | /* Store the result in the target */ |
| 292 | |
| 293 | Status = AcpiExStore (ReturnDesc, Operand[3], WalkState); |
| 294 | |
| 295 | Cleanup: |
| 296 | |
| 297 | /* Delete return object on error */ |
| 298 | |
| 299 | if (ACPI_FAILURE (Status) || WalkState->ResultObj) |
| 300 | { |
| 301 | AcpiUtRemoveReference (ReturnDesc); |
| 302 | WalkState->ResultObj = NULL; |
| 303 | } |
| 304 | else |
| 305 | { |
| 306 | /* Set the return object and exit */ |
| 307 | |
| 308 | WalkState->ResultObj = ReturnDesc; |
| 309 | } |
| 310 | |
| 311 | return_ACPI_STATUS (Status); |
| 312 | } |
| 313 | |