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