drivers/acpi/components/executer/exoparg6.c

   1 /******************************************************************************
   2  *
   3  * Module Name: exoparg6 - AML execution - opcodes with 6 arguments
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2015, 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    ("exoparg6")
 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 /* Local prototypes */
 151
 152 static BOOLEAN
 153 AcpiExDoMatch (
 154     UINT32                  MatchOp,
 155     ACPI_OPERAND_OBJECT     *PackageObj,
 156     ACPI_OPERAND_OBJECT     *MatchObj);
 157
 158
 159 /*******************************************************************************
 160  *
 161  * FUNCTION:    AcpiExDoMatch
 162  *
 163  * PARAMETERS:  MatchOp         - The AML match operand
 164  *              PackageObj      - Object from the target package
 165  *              MatchObj        - Object to be matched
 166  *
 167  * RETURN:      TRUE if the match is successful, FALSE otherwise
 168  *
 169  * DESCRIPTION: Implements the low-level match for the ASL Match operator.
 170  *              Package elements will be implicitly converted to the type of
 171  *              the match object (Integer/Buffer/String).
 172  *
 173  ******************************************************************************/
 174
 175 static BOOLEAN
 176 AcpiExDoMatch (
 177     UINT32                  MatchOp,
 178     ACPI_OPERAND_OBJECT     *PackageObj,
 179     ACPI_OPERAND_OBJECT     *MatchObj)
 180 {
 181     BOOLEAN                 LogicalResult = TRUE;
 182     ACPI_STATUS             Status;
 183
 184
 185     /*
 186      * Note: Since the PackageObj/MatchObj ordering is opposite to that of
 187      * the standard logical operators, we have to reverse them when we call
 188      * DoLogicalOp in order to make the implicit conversion rules work
 189      * correctly. However, this means we have to flip the entire equation
 190      * also. A bit ugly perhaps, but overall, better than fussing the
 191      * parameters around at runtime, over and over again.
 192      *
 193      * Below, P[i] refers to the package element, M refers to the Match object.
 194      */
 195     switch (MatchOp)
 196     {
 197     case MATCH_MTR:
 198
 199         /* Always true */
 200
 201         break;
 202
 203     case MATCH_MEQ:
 204         /*
 205          * True if equal: (P[i] == M)
 206          * Change to:     (M == P[i])
 207          */
 208         Status = AcpiExDoLogicalOp (AML_LEQUAL_OP, MatchObj, PackageObj,
 209                     &LogicalResult);
 210         if (ACPI_FAILURE (Status))
 211         {
 212             return (FALSE);
 213         }
 214         break;
 215
 216     case MATCH_MLE:
 217         /*
 218          * True if less than or equal: (P[i] <= M) (P[i] NotGreater than M)
 219          * Change to:                  (M >= P[i]) (M NotLess than P[i])
 220          */
 221         Status = AcpiExDoLogicalOp (AML_LLESS_OP, MatchObj, PackageObj,
 222                     &LogicalResult);
 223         if (ACPI_FAILURE (Status))
 224         {
 225             return (FALSE);
 226         }
 227         LogicalResult = (BOOLEAN) !LogicalResult;
 228         break;
 229
 230     case MATCH_MLT:
 231         /*
 232          * True if less than: (P[i] < M)
 233          * Change to:         (M > P[i])
 234          */
 235         Status = AcpiExDoLogicalOp (AML_LGREATER_OP, MatchObj, PackageObj,
 236                     &LogicalResult);
 237         if (ACPI_FAILURE (Status))
 238         {
 239             return (FALSE);
 240         }
 241         break;
 242
 243     case MATCH_MGE:
 244         /*
 245          * True if greater than or equal: (P[i] >= M) (P[i] NotLess than M)
 246          * Change to:                     (M <= P[i]) (M NotGreater than P[i])
 247          */
 248         Status = AcpiExDoLogicalOp (AML_LGREATER_OP, MatchObj, PackageObj,
 249                     &LogicalResult);
 250         if (ACPI_FAILURE (Status))
 251         {
 252             return (FALSE);
 253         }
 254         LogicalResult = (BOOLEAN)!LogicalResult;
 255         break;
 256
 257     case MATCH_MGT:
 258         /*
 259          * True if greater than: (P[i] > M)
 260          * Change to:            (M < P[i])
 261          */
 262         Status = AcpiExDoLogicalOp (AML_LLESS_OP, MatchObj, PackageObj,
 263                     &LogicalResult);
 264         if (ACPI_FAILURE (Status))
 265         {
 266             return (FALSE);
 267         }
 268         break;
 269
 270     default:
 271
 272         /* Undefined */
 273
 274         return (FALSE);
 275     }
 276
 277     return (LogicalResult);
 278 }
 279
 280
 281 /*******************************************************************************
 282  *
 283  * FUNCTION:    AcpiExOpcode_6A_0T_1R
 284  *
 285  * PARAMETERS:  WalkState           - Current walk state
 286  *
 287  * RETURN:      Status
 288  *
 289  * DESCRIPTION: Execute opcode with 6 arguments, no target, and a return value
 290  *
 291  ******************************************************************************/
 292
 293 ACPI_STATUS
 294 AcpiExOpcode_6A_0T_1R (
 295     ACPI_WALK_STATE         *WalkState)
 296 {
 297     ACPI_OPERAND_OBJECT     **Operand = &WalkState->Operands[0];
 298     ACPI_OPERAND_OBJECT     *ReturnDesc = NULL;
 299     ACPI_STATUS             Status = AE_OK;
 300     UINT64                  Index;
 301     ACPI_OPERAND_OBJECT     *ThisElement;
 302
 303
 304     ACPI_FUNCTION_TRACE_STR (ExOpcode_6A_0T_1R,
 305         AcpiPsGetOpcodeName (WalkState->Opcode));
 306
 307
 308     switch (WalkState->Opcode)
 309     {
 310     case AML_MATCH_OP:
 311         /*
 312          * Match (SearchPkg[0], MatchOp1[1], MatchObj1[2],
 313          *                      MatchOp2[3], MatchObj2[4], StartIndex[5])
 314          */
 315
 316         /* Validate both Match Term Operators (MTR, MEQ, etc.) */
 317
 318         if ((Operand[1]->Integer.Value > MAX_MATCH_OPERATOR) ||
 319             (Operand[3]->Integer.Value > MAX_MATCH_OPERATOR))
 320         {
 321             ACPI_ERROR ((AE_INFO, "Match operator out of range"));
 322             Status = AE_AML_OPERAND_VALUE;
 323             goto Cleanup;
 324         }
 325
 326         /* Get the package StartIndex, validate against the package length */
 327
 328         Index = Operand[5]->Integer.Value;
 329         if (Index >= Operand[0]->Package.Count)
 330         {
 331             ACPI_ERROR ((AE_INFO,
 332                 "Index (0x%8.8X%8.8X) beyond package end (0x%X)",
 333                 ACPI_FORMAT_UINT64 (Index), Operand[0]->Package.Count));
 334             Status = AE_AML_PACKAGE_LIMIT;
 335             goto Cleanup;
 336         }
 337
 338         /* Create an integer for the return value */
 339         /* Default return value is ACPI_UINT64_MAX if no match found */
 340
 341         ReturnDesc = AcpiUtCreateIntegerObject (ACPI_UINT64_MAX);
 342         if (!ReturnDesc)
 343         {
 344             Status = AE_NO_MEMORY;
 345             goto Cleanup;
 346
 347         }
 348
 349         /*
 350          * Examine each element until a match is found. Both match conditions
 351          * must be satisfied for a match to occur. Within the loop,
 352          * "continue" signifies that the current element does not match
 353          * and the next should be examined.
 354          *
 355          * Upon finding a match, the loop will terminate via "break" at
 356          * the bottom. If it terminates "normally", MatchValue will be
 357          * ACPI_UINT64_MAX (Ones) (its initial value) indicating that no
 358          * match was found.
 359          */
 360         for ( ; Index < Operand[0]->Package.Count; Index++)
 361         {
 362             /* Get the current package element */
 363
 364             ThisElement = Operand[0]->Package.Elements[Index];
 365
 366             /* Treat any uninitialized (NULL) elements as non-matching */
 367
 368             if (!ThisElement)
 369             {
 370                 continue;
 371             }
 372
 373             /*
 374              * Both match conditions must be satisfied. Execution of a continue
 375              * (proceed to next iteration of enclosing for loop) signifies a
 376              * non-match.
 377              */
 378             if (!AcpiExDoMatch ((UINT32) Operand[1]->Integer.Value,
 379                                 ThisElement, Operand[2]))
 380             {
 381                 continue;
 382             }
 383
 384             if (!AcpiExDoMatch ((UINT32) Operand[3]->Integer.Value,
 385                                 ThisElement, Operand[4]))
 386             {
 387                 continue;
 388             }
 389
 390             /* Match found: Index is the return value */
 391
 392             ReturnDesc->Integer.Value = Index;
 393             break;
 394         }
 395         break;
 396
 397     case AML_LOAD_TABLE_OP:
 398
 399         Status = AcpiExLoadTableOp (WalkState, &ReturnDesc);
 400         break;
 401
 402     default:
 403
 404         ACPI_ERROR ((AE_INFO, "Unknown AML opcode 0x%X",
 405             WalkState->Opcode));
 406         Status = AE_AML_BAD_OPCODE;
 407         goto Cleanup;
 408     }
 409
 410
 411 Cleanup:
 412
 413     /* Delete return object on error */
 414
 415     if (ACPI_FAILURE (Status))
 416     {
 417         AcpiUtRemoveReference (ReturnDesc);
 418     }
 419
 420     /* Save return object on success */
 421
 422     else
 423     {
 424         WalkState->ResultObj = ReturnDesc;
 425     }
 426
 427     return_ACPI_STATUS (Status);
 428 }