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 - 2023, 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 * Alternatively, you may choose to be licensed under the terms of the 118 * following license: 119 * 120 * Redistribution and use in source and binary forms, with or without 121 * modification, are permitted provided that the following conditions 122 * are met: 123 * 1. Redistributions of source code must retain the above copyright 124 * notice, this list of conditions, and the following disclaimer, 125 * without modification. 126 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 127 * substantially similar to the "NO WARRANTY" disclaimer below 128 * ("Disclaimer") and any redistribution must be conditioned upon 129 * including a substantially similar Disclaimer requirement for further 130 * binary redistribution. 131 * 3. Neither the names of the above-listed copyright holders nor the names 132 * of any contributors may be used to endorse or promote products derived 133 * from this software without specific prior written permission. 134 * 135 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 136 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 137 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 138 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 139 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 140 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 141 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 142 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 143 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 144 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 145 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 146 * 147 * Alternatively, you may choose to be licensed under the terms of the 148 * GNU General Public License ("GPL") version 2 as published by the Free 149 * Software Foundation. 150 * 151 *****************************************************************************/ 152 153 #include <contrib/dev/acpica/include/acpi.h> 154 #include <contrib/dev/acpica/include/accommon.h> 155 #include <contrib/dev/acpica/include/acinterp.h> 156 #include <contrib/dev/acpica/include/acparser.h> 157 #include <contrib/dev/acpica/include/amlcode.h> 158 159 160 #define _COMPONENT ACPI_EXECUTER 161 ACPI_MODULE_NAME ("exoparg3") 162 163 164 /*! 165 * Naming convention for AML interpreter execution routines. 166 * 167 * The routines that begin execution of AML opcodes are named with a common 168 * convention based upon the number of arguments, the number of target operands, 169 * and whether or not a value is returned: 170 * 171 * AcpiExOpcode_xA_yT_zR 172 * 173 * Where: 174 * 175 * xA - ARGUMENTS: The number of arguments (input operands) that are 176 * required for this opcode type (1 through 6 args). 177 * yT - TARGETS: The number of targets (output operands) that are required 178 * for this opcode type (0, 1, or 2 targets). 179 * zR - RETURN VALUE: Indicates whether this opcode type returns a value 180 * as the function return (0 or 1). 181 * 182 * The AcpiExOpcode* functions are called via the Dispatcher component with 183 * fully resolved operands. 184 !*/ 185 186 187 /******************************************************************************* 188 * 189 * FUNCTION: AcpiExOpcode_3A_0T_0R 190 * 191 * PARAMETERS: WalkState - Current walk state 192 * 193 * RETURN: Status 194 * 195 * DESCRIPTION: Execute Triadic operator (3 operands) 196 * 197 ******************************************************************************/ 198 199 ACPI_STATUS 200 AcpiExOpcode_3A_0T_0R ( 201 ACPI_WALK_STATE *WalkState) 202 { 203 ACPI_OPERAND_OBJECT **Operand = &WalkState->Operands[0]; 204 ACPI_SIGNAL_FATAL_INFO *Fatal; 205 ACPI_STATUS Status = AE_OK; 206 207 208 ACPI_FUNCTION_TRACE_STR (ExOpcode_3A_0T_0R, 209 AcpiPsGetOpcodeName (WalkState->Opcode)); 210 211 212 switch (WalkState->Opcode) 213 { 214 case AML_FATAL_OP: /* Fatal (FatalType FatalCode FatalArg) */ 215 216 ACPI_DEBUG_PRINT ((ACPI_DB_INFO, 217 "FatalOp: Type %X Code %X Arg %X " 218 "<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<\n", 219 (UINT32) Operand[0]->Integer.Value, 220 (UINT32) Operand[1]->Integer.Value, 221 (UINT32) Operand[2]->Integer.Value)); 222 223 Fatal = ACPI_ALLOCATE (sizeof (ACPI_SIGNAL_FATAL_INFO)); 224 if (Fatal) 225 { 226 Fatal->Type = (UINT32) Operand[0]->Integer.Value; 227 Fatal->Code = (UINT32) Operand[1]->Integer.Value; 228 Fatal->Argument = (UINT32) Operand[2]->Integer.Value; 229 } 230 231 /* Always signal the OS! */ 232 233 Status = AcpiOsSignal (ACPI_SIGNAL_FATAL, Fatal); 234 235 /* Might return while OS is shutting down, just continue */ 236 237 ACPI_FREE (Fatal); 238 goto Cleanup; 239 240 case AML_EXTERNAL_OP: 241 /* 242 * If the interpreter sees this opcode, just ignore it. The External 243 * op is intended for use by disassemblers in order to properly 244 * disassemble control method invocations. The opcode or group of 245 * opcodes should be surrounded by an "if (0)" clause to ensure that 246 * AML interpreters never see the opcode. Thus, something is 247 * wrong if an external opcode ever gets here. 248 */ 249 ACPI_ERROR ((AE_INFO, "Executed External Op")); 250 Status = AE_OK; 251 goto Cleanup; 252 253 default: 254 255 ACPI_ERROR ((AE_INFO, "Unknown AML opcode 0x%X", 256 WalkState->Opcode)); 257 258 Status = AE_AML_BAD_OPCODE; 259 goto Cleanup; 260 } 261 262 263 Cleanup: 264 265 return_ACPI_STATUS (Status); 266 } 267 268 269 /******************************************************************************* 270 * 271 * FUNCTION: AcpiExOpcode_3A_1T_1R 272 * 273 * PARAMETERS: WalkState - Current walk state 274 * 275 * RETURN: Status 276 * 277 * DESCRIPTION: Execute Triadic operator (3 operands) 278 * 279 ******************************************************************************/ 280 281 ACPI_STATUS 282 AcpiExOpcode_3A_1T_1R ( 283 ACPI_WALK_STATE *WalkState) 284 { 285 ACPI_OPERAND_OBJECT **Operand = &WalkState->Operands[0]; 286 ACPI_OPERAND_OBJECT *ReturnDesc = NULL; 287 char *Buffer = NULL; 288 ACPI_STATUS Status = AE_OK; 289 UINT64 Index; 290 ACPI_SIZE Length; 291 292 293 ACPI_FUNCTION_TRACE_STR (ExOpcode_3A_1T_1R, 294 AcpiPsGetOpcodeName (WalkState->Opcode)); 295 296 297 switch (WalkState->Opcode) 298 { 299 case AML_MID_OP: /* Mid (Source[0], Index[1], Length[2], Result[3]) */ 300 /* 301 * Create the return object. The Source operand is guaranteed to be 302 * either a String or a Buffer, so just use its type. 303 */ 304 ReturnDesc = AcpiUtCreateInternalObject ( 305 (Operand[0])->Common.Type); 306 if (!ReturnDesc) 307 { 308 Status = AE_NO_MEMORY; 309 goto Cleanup; 310 } 311 312 /* Get the Integer values from the objects */ 313 314 Index = Operand[1]->Integer.Value; 315 Length = (ACPI_SIZE) Operand[2]->Integer.Value; 316 317 /* 318 * If the index is beyond the length of the String/Buffer, or if the 319 * requested length is zero, return a zero-length String/Buffer 320 */ 321 if (Index >= Operand[0]->String.Length) 322 { 323 Length = 0; 324 } 325 326 /* Truncate request if larger than the actual String/Buffer */ 327 328 else if ((Index + Length) > Operand[0]->String.Length) 329 { 330 Length = 331 (ACPI_SIZE) Operand[0]->String.Length - (ACPI_SIZE) Index; 332 } 333 334 /* Strings always have a sub-pointer, not so for buffers */ 335 336 switch ((Operand[0])->Common.Type) 337 { 338 case ACPI_TYPE_STRING: 339 340 /* Always allocate a new buffer for the String */ 341 342 Buffer = ACPI_ALLOCATE_ZEROED ((ACPI_SIZE) Length + 1); 343 if (!Buffer) 344 { 345 Status = AE_NO_MEMORY; 346 goto Cleanup; 347 } 348 break; 349 350 case ACPI_TYPE_BUFFER: 351 352 /* If the requested length is zero, don't allocate a buffer */ 353 354 if (Length > 0) 355 { 356 /* Allocate a new buffer for the Buffer */ 357 358 Buffer = ACPI_ALLOCATE_ZEROED (Length); 359 if (!Buffer) 360 { 361 Status = AE_NO_MEMORY; 362 goto Cleanup; 363 } 364 } 365 break; 366 367 default: /* Should not happen */ 368 369 Status = AE_AML_OPERAND_TYPE; 370 goto Cleanup; 371 } 372 373 if (Buffer) 374 { 375 /* We have a buffer, copy the portion requested */ 376 377 memcpy (Buffer, 378 Operand[0]->String.Pointer + Index, Length); 379 } 380 381 /* Set the length of the new String/Buffer */ 382 383 ReturnDesc->String.Pointer = Buffer; 384 ReturnDesc->String.Length = (UINT32) Length; 385 386 /* Mark buffer initialized */ 387 388 ReturnDesc->Buffer.Flags |= AOPOBJ_DATA_VALID; 389 break; 390 391 default: 392 393 ACPI_ERROR ((AE_INFO, "Unknown AML opcode 0x%X", 394 WalkState->Opcode)); 395 396 Status = AE_AML_BAD_OPCODE; 397 goto Cleanup; 398 } 399 400 /* Store the result in the target */ 401 402 Status = AcpiExStore (ReturnDesc, Operand[3], WalkState); 403 404 Cleanup: 405 406 /* Delete return object on error */ 407 408 if (ACPI_FAILURE (Status) || WalkState->ResultObj) 409 { 410 AcpiUtRemoveReference (ReturnDesc); 411 WalkState->ResultObj = NULL; 412 } 413 else 414 { 415 /* Set the return object and exit */ 416 417 WalkState->ResultObj = ReturnDesc; 418 } 419 420 return_ACPI_STATUS (Status); 421 } 422