Back to home page

LXR

 
 

    


File indexing completed on 2025-05-11 08:24:02

0001 /******************************************************************************
0002  *
0003  * Module Name: exoparg3 - AML execution - opcodes with 3 arguments
0004  *
0005  *****************************************************************************/
0006 
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights. You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code. No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision. In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change. Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee. Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution. In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
0086 
0087  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
0088  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0089  * PARTICULAR PURPOSE.
0090  *
0091  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0092  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0093  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0094  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0095  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0096  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
0097  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0098  * LIMITED REMEDY.
0099  *
0100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0101  * software or system incorporating such software without first obtaining any
0102  * required license or other approval from the U. S. Department of Commerce or
0103  * any other agency or department of the United States Government. In the
0104  * event Licensee exports any such software from the United States or
0105  * re-exports any such software from a foreign destination, Licensee shall
0106  * ensure that the distribution and export/re-export of the software is in
0107  * compliance with all laws, regulations, orders, or other restrictions of the
0108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0109  * any of its subsidiaries will export/re-export any technical data, process,
0110  * software, or service, directly or indirectly, to any country for which the
0111  * United States government or any agency thereof requires an export license,
0112  * other governmental approval, or letter of assurance, without first obtaining
0113  * such license, approval or letter.
0114  *
0115  *****************************************************************************
0116  *
0117  * Alternatively, you may choose to be licensed under the terms of the
0118  * following license:
0119  *
0120  * Redistribution and use in source and binary forms, with or without
0121  * modification, are permitted provided that the following conditions
0122  * are met:
0123  * 1. Redistributions of source code must retain the above copyright
0124  *    notice, this list of conditions, and the following disclaimer,
0125  *    without modification.
0126  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0127  *    substantially similar to the "NO WARRANTY" disclaimer below
0128  *    ("Disclaimer") and any redistribution must be conditioned upon
0129  *    including a substantially similar Disclaimer requirement for further
0130  *    binary redistribution.
0131  * 3. Neither the names of the above-listed copyright holders nor the names
0132  *    of any contributors may be used to endorse or promote products derived
0133  *    from this software without specific prior written permission.
0134  *
0135  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0136  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0137  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0138  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0139  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0140  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0141  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0142  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0143  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0144  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0145  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0146  *
0147  * Alternatively, you may choose to be licensed under the terms of the
0148  * GNU General Public License ("GPL") version 2 as published by the Free
0149  * Software Foundation.
0150  *
0151  *****************************************************************************/
0152 
0153 #include "acpi.h"
0154 #include "accommon.h"
0155 #include "acinterp.h"
0156 #include "acparser.h"
0157 #include "amlcode.h"
0158 
0159 
0160 #define _COMPONENT          ACPI_EXECUTER
0161         ACPI_MODULE_NAME    ("exoparg3")
0162 
0163 
0164 /*!
0165  * Naming convention for AML interpreter execution routines.
0166  *
0167  * The routines that begin execution of AML opcodes are named with a common
0168  * convention based upon the number of arguments, the number of target operands,
0169  * and whether or not a value is returned:
0170  *
0171  *      AcpiExOpcode_xA_yT_zR
0172  *
0173  * Where:
0174  *
0175  * xA - ARGUMENTS:    The number of arguments (input operands) that are
0176  *                    required for this opcode type (1 through 6 args).
0177  * yT - TARGETS:      The number of targets (output operands) that are required
0178  *                    for this opcode type (0, 1, or 2 targets).
0179  * zR - RETURN VALUE: Indicates whether this opcode type returns a value
0180  *                    as the function return (0 or 1).
0181  *
0182  * The AcpiExOpcode* functions are called via the Dispatcher component with
0183  * fully resolved operands.
0184 !*/
0185 
0186 
0187 /*******************************************************************************
0188  *
0189  * FUNCTION:    AcpiExOpcode_3A_0T_0R
0190  *
0191  * PARAMETERS:  WalkState           - Current walk state
0192  *
0193  * RETURN:      Status
0194  *
0195  * DESCRIPTION: Execute Triadic operator (3 operands)
0196  *
0197  ******************************************************************************/
0198 
0199 ACPI_STATUS
0200 AcpiExOpcode_3A_0T_0R (
0201     ACPI_WALK_STATE         *WalkState)
0202 {
0203     ACPI_OPERAND_OBJECT     **Operand = &WalkState->Operands[0];
0204     ACPI_SIGNAL_FATAL_INFO  *Fatal;
0205     ACPI_STATUS             Status = AE_OK;
0206 
0207 
0208     ACPI_FUNCTION_TRACE_STR (ExOpcode_3A_0T_0R,
0209         AcpiPsGetOpcodeName (WalkState->Opcode));
0210 
0211 
0212     switch (WalkState->Opcode)
0213     {
0214     case AML_FATAL_OP:          /* Fatal (FatalType  FatalCode  FatalArg) */
0215 
0216         ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
0217             "FatalOp: Type %X Code %X Arg %X "
0218             "<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<\n",
0219             (UINT32) Operand[0]->Integer.Value,
0220             (UINT32) Operand[1]->Integer.Value,
0221             (UINT32) Operand[2]->Integer.Value));
0222 
0223         Fatal = ACPI_ALLOCATE (sizeof (ACPI_SIGNAL_FATAL_INFO));
0224         if (Fatal)
0225         {
0226             Fatal->Type = (UINT32) Operand[0]->Integer.Value;
0227             Fatal->Code = (UINT32) Operand[1]->Integer.Value;
0228             Fatal->Argument = (UINT32) Operand[2]->Integer.Value;
0229         }
0230 
0231         /* Always signal the OS! */
0232 
0233         Status = AcpiOsSignal (ACPI_SIGNAL_FATAL, Fatal);
0234 
0235         /* Might return while OS is shutting down, just continue */
0236 
0237         ACPI_FREE (Fatal);
0238         goto Cleanup;
0239 
0240     case AML_EXTERNAL_OP:
0241         /*
0242          * If the interpreter sees this opcode, just ignore it. The External
0243          * op is intended for use by disassemblers in order to properly
0244          * disassemble control method invocations. The opcode or group of
0245          * opcodes should be surrounded by an "if (0)" clause to ensure that
0246          * AML interpreters never see the opcode. Thus, something is
0247          * wrong if an external opcode ever gets here.
0248          */
0249         ACPI_ERROR ((AE_INFO, "Executed External Op"));
0250         Status = AE_OK;
0251         goto Cleanup;
0252 
0253     default:
0254 
0255         ACPI_ERROR ((AE_INFO, "Unknown AML opcode 0x%X",
0256             WalkState->Opcode));
0257 
0258         Status = AE_AML_BAD_OPCODE;
0259         goto Cleanup;
0260     }
0261 
0262 
0263 Cleanup:
0264 
0265     return_ACPI_STATUS (Status);
0266 }
0267 
0268 
0269 /*******************************************************************************
0270  *
0271  * FUNCTION:    AcpiExOpcode_3A_1T_1R
0272  *
0273  * PARAMETERS:  WalkState           - Current walk state
0274  *
0275  * RETURN:      Status
0276  *
0277  * DESCRIPTION: Execute Triadic operator (3 operands)
0278  *
0279  ******************************************************************************/
0280 
0281 ACPI_STATUS
0282 AcpiExOpcode_3A_1T_1R (
0283     ACPI_WALK_STATE         *WalkState)
0284 {
0285     ACPI_OPERAND_OBJECT     **Operand = &WalkState->Operands[0];
0286     ACPI_OPERAND_OBJECT     *ReturnDesc = NULL;
0287     char                    *Buffer = NULL;
0288     ACPI_STATUS             Status = AE_OK;
0289     UINT64                  Index;
0290     ACPI_SIZE               Length;
0291 
0292 
0293     ACPI_FUNCTION_TRACE_STR (ExOpcode_3A_1T_1R,
0294         AcpiPsGetOpcodeName (WalkState->Opcode));
0295 
0296 
0297     switch (WalkState->Opcode)
0298     {
0299     case AML_MID_OP:    /* Mid (Source[0], Index[1], Length[2], Result[3]) */
0300         /*
0301          * Create the return object. The Source operand is guaranteed to be
0302          * either a String or a Buffer, so just use its type.
0303          */
0304         ReturnDesc = AcpiUtCreateInternalObject (
0305             (Operand[0])->Common.Type);
0306         if (!ReturnDesc)
0307         {
0308             Status = AE_NO_MEMORY;
0309             goto Cleanup;
0310         }
0311 
0312         /* Get the Integer values from the objects */
0313 
0314         Index = Operand[1]->Integer.Value;
0315         Length = (ACPI_SIZE) Operand[2]->Integer.Value;
0316 
0317         /*
0318          * If the index is beyond the length of the String/Buffer, or if the
0319          * requested length is zero, return a zero-length String/Buffer
0320          */
0321         if (Index >= Operand[0]->String.Length)
0322         {
0323             Length = 0;
0324         }
0325 
0326         /* Truncate request if larger than the actual String/Buffer */
0327 
0328         else if ((Index + Length) > Operand[0]->String.Length)
0329         {
0330             Length =
0331                 (ACPI_SIZE) Operand[0]->String.Length - (ACPI_SIZE) Index;
0332         }
0333 
0334         /* Strings always have a sub-pointer, not so for buffers */
0335 
0336         switch ((Operand[0])->Common.Type)
0337         {
0338         case ACPI_TYPE_STRING:
0339 
0340             /* Always allocate a new buffer for the String */
0341 
0342             Buffer = ACPI_ALLOCATE_ZEROED ((ACPI_SIZE) Length + 1);
0343             if (!Buffer)
0344             {
0345                 Status = AE_NO_MEMORY;
0346                 goto Cleanup;
0347             }
0348             break;
0349 
0350         case ACPI_TYPE_BUFFER:
0351 
0352             /* If the requested length is zero, don't allocate a buffer */
0353 
0354             if (Length > 0)
0355             {
0356                 /* Allocate a new buffer for the Buffer */
0357 
0358                 Buffer = ACPI_ALLOCATE_ZEROED (Length);
0359                 if (!Buffer)
0360                 {
0361                     Status = AE_NO_MEMORY;
0362                     goto Cleanup;
0363                 }
0364             }
0365             break;
0366 
0367         default:                        /* Should not happen */
0368 
0369             Status = AE_AML_OPERAND_TYPE;
0370             goto Cleanup;
0371         }
0372 
0373         if (Buffer)
0374         {
0375             /* We have a buffer, copy the portion requested */
0376 
0377             memcpy (Buffer,
0378                 Operand[0]->String.Pointer + Index, Length);
0379         }
0380 
0381         /* Set the length of the new String/Buffer */
0382 
0383         ReturnDesc->String.Pointer = Buffer;
0384         ReturnDesc->String.Length = (UINT32) Length;
0385 
0386         /* Mark buffer initialized */
0387 
0388         ReturnDesc->Buffer.Flags |= AOPOBJ_DATA_VALID;
0389         break;
0390 
0391     default:
0392 
0393         ACPI_ERROR ((AE_INFO, "Unknown AML opcode 0x%X",
0394             WalkState->Opcode));
0395 
0396         Status = AE_AML_BAD_OPCODE;
0397         goto Cleanup;
0398     }
0399 
0400     /* Store the result in the target */
0401 
0402     Status = AcpiExStore (ReturnDesc, Operand[3], WalkState);
0403 
0404 Cleanup:
0405 
0406     /* Delete return object on error */
0407 
0408     if (ACPI_FAILURE (Status) || WalkState->ResultObj)
0409     {
0410         AcpiUtRemoveReference (ReturnDesc);
0411         WalkState->ResultObj = NULL;
0412     }
0413     else
0414     {
0415         /* Set the return object and exit */
0416 
0417         WalkState->ResultObj = ReturnDesc;
0418     }
0419 
0420     return_ACPI_STATUS (Status);
0421 }