acpica/executer/exoparg6.c

0001 /******************************************************************************
0002  *
0003  * Module Name: exoparg6 - AML execution - opcodes with 6 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    ("exoparg6")
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 /* Local prototypes */
0187
0188 static BOOLEAN
0189 AcpiExDoMatch (
0190     UINT32                  MatchOp,
0191     ACPI_OPERAND_OBJECT     *PackageObj,
0192     ACPI_OPERAND_OBJECT     *MatchObj);
0193
0194
0195 /*******************************************************************************
0196  *
0197  * FUNCTION:    AcpiExDoMatch
0198  *
0199  * PARAMETERS:  MatchOp         - The AML match operand
0200  *              PackageObj      - Object from the target package
0201  *              MatchObj        - Object to be matched
0202  *
0203  * RETURN:      TRUE if the match is successful, FALSE otherwise
0204  *
0205  * DESCRIPTION: Implements the low-level match for the ASL Match operator.
0206  *              Package elements will be implicitly converted to the type of
0207  *              the match object (Integer/Buffer/String).
0208  *
0209  ******************************************************************************/
0210
0211 static BOOLEAN
0212 AcpiExDoMatch (
0213     UINT32                  MatchOp,
0214     ACPI_OPERAND_OBJECT     *PackageObj,
0215     ACPI_OPERAND_OBJECT     *MatchObj)
0216 {
0217     BOOLEAN                 LogicalResult = TRUE;
0218     ACPI_STATUS             Status;
0219
0220
0221     /*
0222      * Note: Since the PackageObj/MatchObj ordering is opposite to that of
0223      * the standard logical operators, we have to reverse them when we call
0224      * DoLogicalOp in order to make the implicit conversion rules work
0225      * correctly. However, this means we have to flip the entire equation
0226      * also. A bit ugly perhaps, but overall, better than fussing the
0227      * parameters around at runtime, over and over again.
0228      *
0229      * Below, P[i] refers to the package element, M refers to the Match object.
0230      */
0231     switch (MatchOp)
0232     {
0233     case MATCH_MTR:
0234
0235         /* Always true */
0236
0237         break;
0238
0239     case MATCH_MEQ:
0240         /*
0241          * True if equal: (P[i] == M)
0242          * Change to:     (M == P[i])
0243          */
0244         Status = AcpiExDoLogicalOp (
0245             AML_LOGICAL_EQUAL_OP, MatchObj, PackageObj, &LogicalResult);
0246         if (ACPI_FAILURE (Status))
0247         {
0248             return (FALSE);
0249         }
0250         break;
0251
0252     case MATCH_MLE:
0253         /*
0254          * True if less than or equal: (P[i] <= M) (P[i] NotGreater than M)
0255          * Change to:                  (M >= P[i]) (M NotLess than P[i])
0256          */
0257         Status = AcpiExDoLogicalOp (
0258             AML_LOGICAL_LESS_OP, MatchObj, PackageObj, &LogicalResult);
0259         if (ACPI_FAILURE (Status))
0260         {
0261             return (FALSE);
0262         }
0263         LogicalResult = (BOOLEAN) !LogicalResult;
0264         break;
0265
0266     case MATCH_MLT:
0267         /*
0268          * True if less than: (P[i] < M)
0269          * Change to:         (M > P[i])
0270          */
0271         Status = AcpiExDoLogicalOp (
0272             AML_LOGICAL_GREATER_OP, MatchObj, PackageObj, &LogicalResult);
0273         if (ACPI_FAILURE (Status))
0274         {
0275             return (FALSE);
0276         }
0277         break;
0278
0279     case MATCH_MGE:
0280         /*
0281          * True if greater than or equal: (P[i] >= M) (P[i] NotLess than M)
0282          * Change to:                     (M <= P[i]) (M NotGreater than P[i])
0283          */
0284         Status = AcpiExDoLogicalOp (
0285             AML_LOGICAL_GREATER_OP, MatchObj, PackageObj, &LogicalResult);
0286         if (ACPI_FAILURE (Status))
0287         {
0288             return (FALSE);
0289         }
0290         LogicalResult = (BOOLEAN)!LogicalResult;
0291         break;
0292
0293     case MATCH_MGT:
0294         /*
0295          * True if greater than: (P[i] > M)
0296          * Change to:            (M < P[i])
0297          */
0298         Status = AcpiExDoLogicalOp (
0299             AML_LOGICAL_LESS_OP, MatchObj, PackageObj, &LogicalResult);
0300         if (ACPI_FAILURE (Status))
0301         {
0302             return (FALSE);
0303         }
0304         break;
0305
0306     default:
0307
0308         /* Undefined */
0309
0310         return (FALSE);
0311     }
0312
0313     return (LogicalResult);
0314 }
0315
0316
0317 /*******************************************************************************
0318  *
0319  * FUNCTION:    AcpiExOpcode_6A_0T_1R
0320  *
0321  * PARAMETERS:  WalkState           - Current walk state
0322  *
0323  * RETURN:      Status
0324  *
0325  * DESCRIPTION: Execute opcode with 6 arguments, no target, and a return value
0326  *
0327  ******************************************************************************/
0328
0329 ACPI_STATUS
0330 AcpiExOpcode_6A_0T_1R (
0331     ACPI_WALK_STATE         *WalkState)
0332 {
0333     ACPI_OPERAND_OBJECT     **Operand = &WalkState->Operands[0];
0334     ACPI_OPERAND_OBJECT     *ReturnDesc = NULL;
0335     ACPI_STATUS             Status = AE_OK;
0336     UINT64                  Index;
0337     ACPI_OPERAND_OBJECT     *ThisElement;
0338
0339
0340     ACPI_FUNCTION_TRACE_STR (ExOpcode_6A_0T_1R,
0341         AcpiPsGetOpcodeName (WalkState->Opcode));
0342
0343
0344     switch (WalkState->Opcode)
0345     {
0346     case AML_MATCH_OP:
0347         /*
0348          * Match (SearchPkg[0], MatchOp1[1], MatchObj1[2],
0349          *                      MatchOp2[3], MatchObj2[4], StartIndex[5])
0350          */
0351
0352         /* Validate both Match Term Operators (MTR, MEQ, etc.) */
0353
0354         if ((Operand[1]->Integer.Value > MAX_MATCH_OPERATOR) ||
0355             (Operand[3]->Integer.Value > MAX_MATCH_OPERATOR))
0356         {
0357             ACPI_ERROR ((AE_INFO, "Match operator out of range"));
0358             Status = AE_AML_OPERAND_VALUE;
0359             goto Cleanup;
0360         }
0361
0362         /* Get the package StartIndex, validate against the package length */
0363
0364         Index = Operand[5]->Integer.Value;
0365         if (Index >= Operand[0]->Package.Count)
0366         {
0367             ACPI_ERROR ((AE_INFO,
0368                 "Index (0x%8.8X%8.8X) beyond package end (0x%X)",
0369                 ACPI_FORMAT_UINT64 (Index), Operand[0]->Package.Count));
0370             Status = AE_AML_PACKAGE_LIMIT;
0371             goto Cleanup;
0372         }
0373
0374         /* Create an integer for the return value */
0375         /* Default return value is ACPI_UINT64_MAX if no match found */
0376
0377         ReturnDesc = AcpiUtCreateIntegerObject (ACPI_UINT64_MAX);
0378         if (!ReturnDesc)
0379         {
0380             Status = AE_NO_MEMORY;
0381             goto Cleanup;
0382
0383         }
0384
0385         /*
0386          * Examine each element until a match is found. Both match conditions
0387          * must be satisfied for a match to occur. Within the loop,
0388          * "continue" signifies that the current element does not match
0389          * and the next should be examined.
0390          *
0391          * Upon finding a match, the loop will terminate via "break" at
0392          * the bottom. If it terminates "normally", MatchValue will be
0393          * ACPI_UINT64_MAX (Ones) (its initial value) indicating that no
0394          * match was found.
0395          */
0396         for ( ; Index < Operand[0]->Package.Count; Index++)
0397         {
0398             /* Get the current package element */
0399
0400             ThisElement = Operand[0]->Package.Elements[Index];
0401
0402             /* Treat any uninitialized (NULL) elements as non-matching */
0403
0404             if (!ThisElement)
0405             {
0406                 continue;
0407             }
0408
0409             /*
0410              * Both match conditions must be satisfied. Execution of a continue
0411              * (proceed to next iteration of enclosing for loop) signifies a
0412              * non-match.
0413              */
0414             if (!AcpiExDoMatch ((UINT32) Operand[1]->Integer.Value,
0415                     ThisElement, Operand[2]))
0416             {
0417                 continue;
0418             }
0419
0420             if (!AcpiExDoMatch ((UINT32) Operand[3]->Integer.Value,
0421                     ThisElement, Operand[4]))
0422             {
0423                 continue;
0424             }
0425
0426             /* Match found: Index is the return value */
0427
0428             ReturnDesc->Integer.Value = Index;
0429             break;
0430         }
0431         break;
0432
0433     case AML_LOAD_TABLE_OP:
0434
0435         Status = AcpiExLoadTableOp (WalkState, &ReturnDesc);
0436         break;
0437
0438     default:
0439
0440         ACPI_ERROR ((AE_INFO, "Unknown AML opcode 0x%X",
0441             WalkState->Opcode));
0442
0443         Status = AE_AML_BAD_OPCODE;
0444         goto Cleanup;
0445     }
0446
0447
0448 Cleanup:
0449
0450     /* Delete return object on error */
0451
0452     if (ACPI_FAILURE (Status))
0453     {
0454         AcpiUtRemoveReference (ReturnDesc);
0455     }
0456
0457     /* Save return object on success */
0458
0459     else
0460     {
0461         WalkState->ResultObj = ReturnDesc;
0462     }
0463
0464     return_ACPI_STATUS (Status);
0465 }