1
2/******************************************************************************
3 *
4 * Module Name: exoparg6 - AML execution - opcodes with 6 arguments
5 *
6 *****************************************************************************/
7
8/******************************************************************************
9 *
10 * 1. Copyright Notice
11 *
12 * Some or all of this work - Copyright (c) 1999 - 2009, Intel Corp.
13 * All rights reserved.
14 *
15 * 2. License
16 *
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights.  You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
20 * property rights.
21 *
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
28 *
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code.  No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
37 *
38 * The above copyright and patent license is granted only if the following
39 * conditions are met:
40 *
41 * 3. Conditions
42 *
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision.  In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change.  Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee.  Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
54 *
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution.  In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
65 * make.
66 *
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
71 * distribution.
72 *
73 * 3.4. Intel retains all right, title, and interest in and to the Original
74 * Intel Code.
75 *
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
80 *
81 * 4. Disclaimer and Export Compliance
82 *
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
87
88 * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * PARTICULAR PURPOSE.
91 *
92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * LIMITED REMEDY.
100 *
101 * 4.3. Licensee shall not export, either directly or indirectly, any of this
102 * software or system incorporating such software without first obtaining any
103 * required license or other approval from the U. S. Department of Commerce or
104 * any other agency or department of the United States Government.  In the
105 * event Licensee exports any such software from the United States or
106 * re-exports any such software from a foreign destination, Licensee shall
107 * ensure that the distribution and export/re-export of the software is in
108 * compliance with all laws, regulations, orders, or other restrictions of the
109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110 * any of its subsidiaries will export/re-export any technical data, process,
111 * software, or service, directly or indirectly, to any country for which the
112 * United States government or any agency thereof requires an export license,
113 * other governmental approval, or letter of assurance, without first obtaining
114 * such license, approval or letter.
115 *
116 *****************************************************************************/
117
118#define __EXOPARG6_C__
119
120#include "acpi.h"
121#include "accommon.h"
122#include "acinterp.h"
123#include "acparser.h"
124#include "amlcode.h"
125
126
127#define _COMPONENT          ACPI_EXECUTER
128        ACPI_MODULE_NAME    ("exoparg6")
129
130
131/*!
132 * Naming convention for AML interpreter execution routines.
133 *
134 * The routines that begin execution of AML opcodes are named with a common
135 * convention based upon the number of arguments, the number of target operands,
136 * and whether or not a value is returned:
137 *
138 *      AcpiExOpcode_xA_yT_zR
139 *
140 * Where:
141 *
142 * xA - ARGUMENTS:    The number of arguments (input operands) that are
143 *                    required for this opcode type (1 through 6 args).
144 * yT - TARGETS:      The number of targets (output operands) that are required
145 *                    for this opcode type (0, 1, or 2 targets).
146 * zR - RETURN VALUE: Indicates whether this opcode type returns a value
147 *                    as the function return (0 or 1).
148 *
149 * The AcpiExOpcode* functions are called via the Dispatcher component with
150 * fully resolved operands.
151!*/
152
153/* Local prototypes */
154
155static BOOLEAN
156AcpiExDoMatch (
157    UINT32                  MatchOp,
158    ACPI_OPERAND_OBJECT     *PackageObj,
159    ACPI_OPERAND_OBJECT     *MatchObj);
160
161
162/*******************************************************************************
163 *
164 * FUNCTION:    AcpiExDoMatch
165 *
166 * PARAMETERS:  MatchOp         - The AML match operand
167 *              PackageObj      - Object from the target package
168 *              MatchObj        - Object to be matched
169 *
170 * RETURN:      TRUE if the match is successful, FALSE otherwise
171 *
172 * DESCRIPTION: Implements the low-level match for the ASL Match operator.
173 *              Package elements will be implicitly converted to the type of
174 *              the match object (Integer/Buffer/String).
175 *
176 ******************************************************************************/
177
178static BOOLEAN
179AcpiExDoMatch (
180    UINT32                  MatchOp,
181    ACPI_OPERAND_OBJECT     *PackageObj,
182    ACPI_OPERAND_OBJECT     *MatchObj)
183{
184    BOOLEAN                 LogicalResult = TRUE;
185    ACPI_STATUS             Status;
186
187
188    /*
189     * Note: Since the PackageObj/MatchObj ordering is opposite to that of
190     * the standard logical operators, we have to reverse them when we call
191     * DoLogicalOp in order to make the implicit conversion rules work
192     * correctly. However, this means we have to flip the entire equation
193     * also. A bit ugly perhaps, but overall, better than fussing the
194     * parameters around at runtime, over and over again.
195     *
196     * Below, P[i] refers to the package element, M refers to the Match object.
197     */
198    switch (MatchOp)
199    {
200    case MATCH_MTR:
201
202        /* Always true */
203
204        break;
205
206    case MATCH_MEQ:
207
208        /*
209         * True if equal: (P[i] == M)
210         * Change to:     (M == P[i])
211         */
212        Status = AcpiExDoLogicalOp (AML_LEQUAL_OP, MatchObj, PackageObj,
213                    &LogicalResult);
214        if (ACPI_FAILURE (Status))
215        {
216            return (FALSE);
217        }
218        break;
219
220    case MATCH_MLE:
221
222        /*
223         * True if less than or equal: (P[i] <= M) (P[i] NotGreater than M)
224         * Change to:                  (M >= P[i]) (M NotLess than P[i])
225         */
226        Status = AcpiExDoLogicalOp (AML_LLESS_OP, MatchObj, PackageObj,
227                    &LogicalResult);
228        if (ACPI_FAILURE (Status))
229        {
230            return (FALSE);
231        }
232        LogicalResult = (BOOLEAN) !LogicalResult;
233        break;
234
235    case MATCH_MLT:
236
237        /*
238         * True if less than: (P[i] < M)
239         * Change to:         (M > P[i])
240         */
241        Status = AcpiExDoLogicalOp (AML_LGREATER_OP, MatchObj, PackageObj,
242                    &LogicalResult);
243        if (ACPI_FAILURE (Status))
244        {
245            return (FALSE);
246        }
247        break;
248
249    case MATCH_MGE:
250
251        /*
252         * True if greater than or equal: (P[i] >= M) (P[i] NotLess than M)
253         * Change to:                     (M <= P[i]) (M NotGreater than P[i])
254         */
255        Status = AcpiExDoLogicalOp (AML_LGREATER_OP, MatchObj, PackageObj,
256                    &LogicalResult);
257        if (ACPI_FAILURE (Status))
258        {
259            return (FALSE);
260        }
261        LogicalResult = (BOOLEAN)!LogicalResult;
262        break;
263
264    case MATCH_MGT:
265
266        /*
267         * True if greater than: (P[i] > M)
268         * Change to:            (M < P[i])
269         */
270        Status = AcpiExDoLogicalOp (AML_LLESS_OP, MatchObj, PackageObj,
271                    &LogicalResult);
272        if (ACPI_FAILURE (Status))
273        {
274            return (FALSE);
275        }
276        break;
277
278    default:
279
280        /* Undefined */
281
282        return (FALSE);
283    }
284
285    return LogicalResult;
286}
287
288
289/*******************************************************************************
290 *
291 * FUNCTION:    AcpiExOpcode_6A_0T_1R
292 *
293 * PARAMETERS:  WalkState           - Current walk state
294 *
295 * RETURN:      Status
296 *
297 * DESCRIPTION: Execute opcode with 6 arguments, no target, and a return value
298 *
299 ******************************************************************************/
300
301ACPI_STATUS
302AcpiExOpcode_6A_0T_1R (
303    ACPI_WALK_STATE         *WalkState)
304{
305    ACPI_OPERAND_OBJECT     **Operand = &WalkState->Operands[0];
306    ACPI_OPERAND_OBJECT     *ReturnDesc = NULL;
307    ACPI_STATUS             Status = AE_OK;
308    ACPI_INTEGER            Index;
309    ACPI_OPERAND_OBJECT     *ThisElement;
310
311
312    ACPI_FUNCTION_TRACE_STR (ExOpcode_6A_0T_1R,
313        AcpiPsGetOpcodeName (WalkState->Opcode));
314
315
316    switch (WalkState->Opcode)
317    {
318    case AML_MATCH_OP:
319        /*
320         * Match (SearchPkg[0], MatchOp1[1], MatchObj1[2],
321         *                      MatchOp2[3], MatchObj2[4], StartIndex[5])
322         */
323
324        /* Validate both Match Term Operators (MTR, MEQ, etc.) */
325
326        if ((Operand[1]->Integer.Value > MAX_MATCH_OPERATOR) ||
327            (Operand[3]->Integer.Value > MAX_MATCH_OPERATOR))
328        {
329            ACPI_ERROR ((AE_INFO, "Match operator out of range"));
330            Status = AE_AML_OPERAND_VALUE;
331            goto Cleanup;
332        }
333
334        /* Get the package StartIndex, validate against the package length */
335
336        Index = Operand[5]->Integer.Value;
337        if (Index >= Operand[0]->Package.Count)
338        {
339            ACPI_ERROR ((AE_INFO,
340                "Index (%X%8.8X) beyond package end (%X)",
341                ACPI_FORMAT_UINT64 (Index), Operand[0]->Package.Count));
342            Status = AE_AML_PACKAGE_LIMIT;
343            goto Cleanup;
344        }
345
346        /* Create an integer for the return value */
347        /* Default return value is ACPI_INTEGER_MAX if no match found */
348
349        ReturnDesc = AcpiUtCreateIntegerObject (ACPI_INTEGER_MAX);
350        if (!ReturnDesc)
351        {
352            Status = AE_NO_MEMORY;
353            goto Cleanup;
354
355        }
356
357        /*
358         * Examine each element until a match is found. Both match conditions
359         * must be satisfied for a match to occur. Within the loop,
360         * "continue" signifies that the current element does not match
361         * and the next should be examined.
362         *
363         * Upon finding a match, the loop will terminate via "break" at
364         * the bottom.  If it terminates "normally", MatchValue will be
365         * ACPI_INTEGER_MAX (Ones) (its initial value) indicating that no
366         * match was found.
367         */
368        for ( ; Index < Operand[0]->Package.Count; Index++)
369        {
370            /* Get the current package element */
371
372            ThisElement = Operand[0]->Package.Elements[Index];
373
374            /* Treat any uninitialized (NULL) elements as non-matching */
375
376            if (!ThisElement)
377            {
378                continue;
379            }
380
381            /*
382             * Both match conditions must be satisfied. Execution of a continue
383             * (proceed to next iteration of enclosing for loop) signifies a
384             * non-match.
385             */
386            if (!AcpiExDoMatch ((UINT32) Operand[1]->Integer.Value,
387                                ThisElement, Operand[2]))
388            {
389                continue;
390            }
391
392            if (!AcpiExDoMatch ((UINT32) Operand[3]->Integer.Value,
393                                ThisElement, Operand[4]))
394            {
395                continue;
396            }
397
398            /* Match found: Index is the return value */
399
400            ReturnDesc->Integer.Value = Index;
401            break;
402        }
403        break;
404
405
406    case AML_LOAD_TABLE_OP:
407
408        Status = AcpiExLoadTableOp (WalkState, &ReturnDesc);
409        break;
410
411
412    default:
413
414        ACPI_ERROR ((AE_INFO, "Unknown AML opcode %X",
415            WalkState->Opcode));
416        Status = AE_AML_BAD_OPCODE;
417        goto Cleanup;
418    }
419
420
421Cleanup:
422
423    /* Delete return object on error */
424
425    if (ACPI_FAILURE (Status))
426    {
427        AcpiUtRemoveReference (ReturnDesc);
428    }
429
430    /* Save return object on success */
431
432    else
433    {
434        WalkState->ResultObj = ReturnDesc;
435    }
436
437    return_ACPI_STATUS (Status);
438}
439