1 /****************************************************************************** 2 * 3 * Module Name: exoparg3 - AML execution - opcodes with 3 arguments 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2016, Intel Corp. 12 * All rights reserved. 13 * 14 * 2. License 15 * 16 * 2.1. This is your license from Intel Corp. under its intellectual property 17 * rights. You may have additional license terms from the party that provided 18 * you this software, covering your right to use that party's intellectual 19 * property rights. 20 * 21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 22 * copy of the source code appearing in this file ("Covered Code") an 23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 24 * base code distributed originally by Intel ("Original Intel Code") to copy, 25 * make derivatives, distribute, use and display any portion of the Covered 26 * Code in any form, with the right to sublicense such rights; and 27 * 28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 29 * license (with the right to sublicense), under only those claims of Intel 30 * patents that are infringed by the Original Intel Code, to make, use, sell, 31 * offer to sell, and import the Covered Code and derivative works thereof 32 * solely to the minimum extent necessary to exercise the above copyright 33 * license, and in no event shall the patent license extend to any additions 34 * to or modifications of the Original Intel Code. No other license or right 35 * is granted directly or by implication, estoppel or otherwise; 36 * 37 * The above copyright and patent license is granted only if the following 38 * conditions are met: 39 * 40 * 3. Conditions 41 * 42 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 43 * Redistribution of source code of any substantial portion of the Covered 44 * Code or modification with rights to further distribute source must include 45 * the above Copyright Notice, the above License, this list of Conditions, 46 * and the following Disclaimer and Export Compliance provision. In addition, 47 * Licensee must cause all Covered Code to which Licensee contributes to 48 * contain a file documenting the changes Licensee made to create that Covered 49 * Code and the date of any change. Licensee must include in that file the 50 * documentation of any changes made by any predecessor Licensee. Licensee 51 * must include a prominent statement that the modification is derived, 52 * directly or indirectly, from Original Intel Code. 53 * 54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 55 * Redistribution of source code of any substantial portion of the Covered 56 * Code or modification without rights to further distribute source must 57 * include the following Disclaimer and Export Compliance provision in the 58 * documentation and/or other materials provided with distribution. In 59 * addition, Licensee may not authorize further sublicense of source of any 60 * portion of the Covered Code, and must include terms to the effect that the 61 * license from Licensee to its licensee is limited to the intellectual 62 * property embodied in the software Licensee provides to its licensee, and 63 * not to intellectual property embodied in modifications its licensee may 64 * make. 65 * 66 * 3.3. Redistribution of Executable. Redistribution in executable form of any 67 * substantial portion of the Covered Code or modification must reproduce the 68 * above Copyright Notice, and the following Disclaimer and Export Compliance 69 * provision in the documentation and/or other materials provided with the 70 * distribution. 71 * 72 * 3.4. Intel retains all right, title, and interest in and to the Original 73 * Intel Code. 74 * 75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 76 * Intel shall be used in advertising or otherwise to promote the sale, use or 77 * other dealings in products derived from or relating to the Covered Code 78 * without prior written authorization from Intel. 79 * 80 * 4. Disclaimer and Export Compliance 81 * 82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 86 87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 89 * PARTICULAR PURPOSE. 90 * 91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 98 * LIMITED REMEDY. 99 * 100 * 4.3. Licensee shall not export, either directly or indirectly, any of this 101 * software or system incorporating such software without first obtaining any 102 * required license or other approval from the U. S. Department of Commerce or 103 * any other agency or department of the United States Government. In the 104 * event Licensee exports any such software from the United States or 105 * re-exports any such software from a foreign destination, Licensee shall 106 * ensure that the distribution and export/re-export of the software is in 107 * compliance with all laws, regulations, orders, or other restrictions of the 108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 109 * any of its subsidiaries will export/re-export any technical data, process, 110 * software, or service, directly or indirectly, to any country for which the 111 * United States government or any agency thereof requires an export license, 112 * other governmental approval, or letter of assurance, without first obtaining 113 * such license, approval or letter. 114 * 115 *****************************************************************************/ 116 117 #include "acpi.h" 118 #include "accommon.h" 119 #include "acinterp.h" 120 #include "acparser.h" 121 #include "amlcode.h" 122 123 124 #define _COMPONENT ACPI_EXECUTER 125 ACPI_MODULE_NAME ("exoparg3") 126 127 128 /*! 129 * Naming convention for AML interpreter execution routines. 130 * 131 * The routines that begin execution of AML opcodes are named with a common 132 * convention based upon the number of arguments, the number of target operands, 133 * and whether or not a value is returned: 134 * 135 * AcpiExOpcode_xA_yT_zR 136 * 137 * Where: 138 * 139 * xA - ARGUMENTS: The number of arguments (input operands) that are 140 * required for this opcode type (1 through 6 args). 141 * yT - TARGETS: The number of targets (output operands) that are required 142 * for this opcode type (0, 1, or 2 targets). 143 * zR - RETURN VALUE: Indicates whether this opcode type returns a value 144 * as the function return (0 or 1). 145 * 146 * The AcpiExOpcode* functions are called via the Dispatcher component with 147 * fully resolved operands. 148 !*/ 149 150 151 /******************************************************************************* 152 * 153 * FUNCTION: AcpiExOpcode_3A_0T_0R 154 * 155 * PARAMETERS: WalkState - Current walk state 156 * 157 * RETURN: Status 158 * 159 * DESCRIPTION: Execute Triadic operator (3 operands) 160 * 161 ******************************************************************************/ 162 163 ACPI_STATUS 164 AcpiExOpcode_3A_0T_0R ( 165 ACPI_WALK_STATE *WalkState) 166 { 167 ACPI_OPERAND_OBJECT **Operand = &WalkState->Operands[0]; 168 ACPI_SIGNAL_FATAL_INFO *Fatal; 169 ACPI_STATUS Status = AE_OK; 170 171 172 ACPI_FUNCTION_TRACE_STR (ExOpcode_3A_0T_0R, 173 AcpiPsGetOpcodeName (WalkState->Opcode)); 174 175 176 switch (WalkState->Opcode) 177 { 178 case AML_FATAL_OP: /* Fatal (FatalType FatalCode FatalArg) */ 179 180 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, 181 "FatalOp: Type %X Code %X Arg %X " 182 "<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<\n", 183 (UINT32) Operand[0]->Integer.Value, 184 (UINT32) Operand[1]->Integer.Value, 185 (UINT32) Operand[2]->Integer.Value)); 186 187 Fatal = ACPI_ALLOCATE (sizeof (ACPI_SIGNAL_FATAL_INFO)); 188 if (Fatal) 189 { 190 Fatal->Type = (UINT32) Operand[0]->Integer.Value; 191 Fatal->Code = (UINT32) Operand[1]->Integer.Value; 192 Fatal->Argument = (UINT32) Operand[2]->Integer.Value; 193 } 194 195 /* Always signal the OS! */ 196 197 Status = AcpiOsSignal (ACPI_SIGNAL_FATAL, Fatal); 198 199 /* Might return while OS is shutting down, just continue */ 200 201 ACPI_FREE (Fatal); 202 goto Cleanup; 203 204 case AML_EXTERNAL_OP: 205 /* 206 * If the interpreter sees this opcode, just ignore it. The External 207 * op is intended for use by disassemblers in order to properly 208 * disassemble control method invocations. The opcode or group of 209 * opcodes should be surrounded by an "if (0)" clause to ensure that 210 * AML interpreters never see the opcode. Thus, something is 211 * wrong if an external opcode ever gets here. 212 */ 213 ACPI_ERROR ((AE_INFO, "Executed External Op")); 214 Status = AE_OK; 215 goto Cleanup; 216 217 default: 218 219 ACPI_ERROR ((AE_INFO, "Unknown AML opcode 0x%X", 220 WalkState->Opcode)); 221 222 Status = AE_AML_BAD_OPCODE; 223 goto Cleanup; 224 } 225 226 227 Cleanup: 228 229 return_ACPI_STATUS (Status); 230 } 231 232 233 /******************************************************************************* 234 * 235 * FUNCTION: AcpiExOpcode_3A_1T_1R 236 * 237 * PARAMETERS: WalkState - Current walk state 238 * 239 * RETURN: Status 240 * 241 * DESCRIPTION: Execute Triadic operator (3 operands) 242 * 243 ******************************************************************************/ 244 245 ACPI_STATUS 246 AcpiExOpcode_3A_1T_1R ( 247 ACPI_WALK_STATE *WalkState) 248 { 249 ACPI_OPERAND_OBJECT **Operand = &WalkState->Operands[0]; 250 ACPI_OPERAND_OBJECT *ReturnDesc = NULL; 251 char *Buffer = NULL; 252 ACPI_STATUS Status = AE_OK; 253 UINT64 Index; 254 ACPI_SIZE Length; 255 256 257 ACPI_FUNCTION_TRACE_STR (ExOpcode_3A_1T_1R, 258 AcpiPsGetOpcodeName (WalkState->Opcode)); 259 260 261 switch (WalkState->Opcode) 262 { 263 case AML_MID_OP: /* Mid (Source[0], Index[1], Length[2], Result[3]) */ 264 /* 265 * Create the return object. The Source operand is guaranteed to be 266 * either a String or a Buffer, so just use its type. 267 */ 268 ReturnDesc = AcpiUtCreateInternalObject ( 269 (Operand[0])->Common.Type); 270 if (!ReturnDesc) 271 { 272 Status = AE_NO_MEMORY; 273 goto Cleanup; 274 } 275 276 /* Get the Integer values from the objects */ 277 278 Index = Operand[1]->Integer.Value; 279 Length = (ACPI_SIZE) Operand[2]->Integer.Value; 280 281 /* 282 * If the index is beyond the length of the String/Buffer, or if the 283 * requested length is zero, return a zero-length String/Buffer 284 */ 285 if (Index >= Operand[0]->String.Length) 286 { 287 Length = 0; 288 } 289 290 /* Truncate request if larger than the actual String/Buffer */ 291 292 else if ((Index + Length) > Operand[0]->String.Length) 293 { 294 Length = 295 (ACPI_SIZE) Operand[0]->String.Length - (ACPI_SIZE) Index; 296 } 297 298 /* Strings always have a sub-pointer, not so for buffers */ 299 300 switch ((Operand[0])->Common.Type) 301 { 302 case ACPI_TYPE_STRING: 303 304 /* Always allocate a new buffer for the String */ 305 306 Buffer = ACPI_ALLOCATE_ZEROED ((ACPI_SIZE) Length + 1); 307 if (!Buffer) 308 { 309 Status = AE_NO_MEMORY; 310 goto Cleanup; 311 } 312 break; 313 314 case ACPI_TYPE_BUFFER: 315 316 /* If the requested length is zero, don't allocate a buffer */ 317 318 if (Length > 0) 319 { 320 /* Allocate a new buffer for the Buffer */ 321 322 Buffer = ACPI_ALLOCATE_ZEROED (Length); 323 if (!Buffer) 324 { 325 Status = AE_NO_MEMORY; 326 goto Cleanup; 327 } 328 } 329 break; 330 331 default: /* Should not happen */ 332 333 Status = AE_AML_OPERAND_TYPE; 334 goto Cleanup; 335 } 336 337 if (Buffer) 338 { 339 /* We have a buffer, copy the portion requested */ 340 341 memcpy (Buffer, 342 Operand[0]->String.Pointer + Index, Length); 343 } 344 345 /* Set the length of the new String/Buffer */ 346 347 ReturnDesc->String.Pointer = Buffer; 348 ReturnDesc->String.Length = (UINT32) Length; 349 350 /* Mark buffer initialized */ 351 352 ReturnDesc->Buffer.Flags |= AOPOBJ_DATA_VALID; 353 break; 354 355 default: 356 357 ACPI_ERROR ((AE_INFO, "Unknown AML opcode 0x%X", 358 WalkState->Opcode)); 359 360 Status = AE_AML_BAD_OPCODE; 361 goto Cleanup; 362 } 363 364 /* Store the result in the target */ 365 366 Status = AcpiExStore (ReturnDesc, Operand[3], WalkState); 367 368 Cleanup: 369 370 /* Delete return object on error */ 371 372 if (ACPI_FAILURE (Status) || WalkState->ResultObj) 373 { 374 AcpiUtRemoveReference (ReturnDesc); 375 WalkState->ResultObj = NULL; 376 } 377 else 378 { 379 /* Set the return object and exit */ 380 381 WalkState->ResultObj = ReturnDesc; 382 } 383 384 return_ACPI_STATUS (Status); 385 } 386