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 - 2018, 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  * Alternatively, you may choose to be licensed under the terms of the
118  * following license:
119  *
120  * Redistribution and use in source and binary forms, with or without
121  * modification, are permitted provided that the following conditions
122  * are met:
123  * 1. Redistributions of source code must retain the above copyright
124  *    notice, this list of conditions, and the following disclaimer,
125  *    without modification.
126  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
127  *    substantially similar to the "NO WARRANTY" disclaimer below
128  *    ("Disclaimer") and any redistribution must be conditioned upon
129  *    including a substantially similar Disclaimer requirement for further
130  *    binary redistribution.
131  * 3. Neither the names of the above-listed copyright holders nor the names
132  *    of any contributors may be used to endorse or promote products derived
133  *    from this software without specific prior written permission.
134  *
135  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
136  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
137  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
138  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
139  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
140  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
141  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
142  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
143  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
144  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
145  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
146  *
147  * Alternatively, you may choose to be licensed under the terms of the
148  * GNU General Public License ("GPL") version 2 as published by the Free
149  * Software Foundation.
150  *
151  *****************************************************************************/
152 
153 #include "acpi.h"
154 #include "accommon.h"
155 #include "acinterp.h"
156 #include "acparser.h"
157 #include "amlcode.h"
158 
159 
160 #define _COMPONENT          ACPI_EXECUTER
161         ACPI_MODULE_NAME    ("exoparg6")
162 
163 
164 /*!
165  * Naming convention for AML interpreter execution routines.
166  *
167  * The routines that begin execution of AML opcodes are named with a common
168  * convention based upon the number of arguments, the number of target operands,
169  * and whether or not a value is returned:
170  *
171  *      AcpiExOpcode_xA_yT_zR
172  *
173  * Where:
174  *
175  * xA - ARGUMENTS:    The number of arguments (input operands) that are
176  *                    required for this opcode type (1 through 6 args).
177  * yT - TARGETS:      The number of targets (output operands) that are required
178  *                    for this opcode type (0, 1, or 2 targets).
179  * zR - RETURN VALUE: Indicates whether this opcode type returns a value
180  *                    as the function return (0 or 1).
181  *
182  * The AcpiExOpcode* functions are called via the Dispatcher component with
183  * fully resolved operands.
184 !*/
185 
186 /* Local prototypes */
187 
188 static BOOLEAN
189 AcpiExDoMatch (
190     UINT32                  MatchOp,
191     ACPI_OPERAND_OBJECT     *PackageObj,
192     ACPI_OPERAND_OBJECT     *MatchObj);
193 
194 
195 /*******************************************************************************
196  *
197  * FUNCTION:    AcpiExDoMatch
198  *
199  * PARAMETERS:  MatchOp         - The AML match operand
200  *              PackageObj      - Object from the target package
201  *              MatchObj        - Object to be matched
202  *
203  * RETURN:      TRUE if the match is successful, FALSE otherwise
204  *
205  * DESCRIPTION: Implements the low-level match for the ASL Match operator.
206  *              Package elements will be implicitly converted to the type of
207  *              the match object (Integer/Buffer/String).
208  *
209  ******************************************************************************/
210 
211 static BOOLEAN
AcpiExDoMatch(UINT32 MatchOp,ACPI_OPERAND_OBJECT * PackageObj,ACPI_OPERAND_OBJECT * MatchObj)212 AcpiExDoMatch (
213     UINT32                  MatchOp,
214     ACPI_OPERAND_OBJECT     *PackageObj,
215     ACPI_OPERAND_OBJECT     *MatchObj)
216 {
217     BOOLEAN                 LogicalResult = TRUE;
218     ACPI_STATUS             Status;
219 
220 
221     /*
222      * Note: Since the PackageObj/MatchObj ordering is opposite to that of
223      * the standard logical operators, we have to reverse them when we call
224      * DoLogicalOp in order to make the implicit conversion rules work
225      * correctly. However, this means we have to flip the entire equation
226      * also. A bit ugly perhaps, but overall, better than fussing the
227      * parameters around at runtime, over and over again.
228      *
229      * Below, P[i] refers to the package element, M refers to the Match object.
230      */
231     switch (MatchOp)
232     {
233     case MATCH_MTR:
234 
235         /* Always true */
236 
237         break;
238 
239     case MATCH_MEQ:
240         /*
241          * True if equal: (P[i] == M)
242          * Change to:     (M == P[i])
243          */
244         Status = AcpiExDoLogicalOp (
245             AML_LOGICAL_EQUAL_OP, MatchObj, PackageObj, &LogicalResult);
246         if (ACPI_FAILURE (Status))
247         {
248             return (FALSE);
249         }
250         break;
251 
252     case MATCH_MLE:
253         /*
254          * True if less than or equal: (P[i] <= M) (P[i] NotGreater than M)
255          * Change to:                  (M >= P[i]) (M NotLess than P[i])
256          */
257         Status = AcpiExDoLogicalOp (
258             AML_LOGICAL_LESS_OP, MatchObj, PackageObj, &LogicalResult);
259         if (ACPI_FAILURE (Status))
260         {
261             return (FALSE);
262         }
263         LogicalResult = (BOOLEAN) !LogicalResult;
264         break;
265 
266     case MATCH_MLT:
267         /*
268          * True if less than: (P[i] < M)
269          * Change to:         (M > P[i])
270          */
271         Status = AcpiExDoLogicalOp (
272             AML_LOGICAL_GREATER_OP, MatchObj, PackageObj, &LogicalResult);
273         if (ACPI_FAILURE (Status))
274         {
275             return (FALSE);
276         }
277         break;
278 
279     case MATCH_MGE:
280         /*
281          * True if greater than or equal: (P[i] >= M) (P[i] NotLess than M)
282          * Change to:                     (M <= P[i]) (M NotGreater than P[i])
283          */
284         Status = AcpiExDoLogicalOp (
285             AML_LOGICAL_GREATER_OP, MatchObj, PackageObj, &LogicalResult);
286         if (ACPI_FAILURE (Status))
287         {
288             return (FALSE);
289         }
290         LogicalResult = (BOOLEAN)!LogicalResult;
291         break;
292 
293     case MATCH_MGT:
294         /*
295          * True if greater than: (P[i] > M)
296          * Change to:            (M < P[i])
297          */
298         Status = AcpiExDoLogicalOp (
299             AML_LOGICAL_LESS_OP, MatchObj, PackageObj, &LogicalResult);
300         if (ACPI_FAILURE (Status))
301         {
302             return (FALSE);
303         }
304         break;
305 
306     default:
307 
308         /* Undefined */
309 
310         return (FALSE);
311     }
312 
313     return (LogicalResult);
314 }
315 
316 
317 /*******************************************************************************
318  *
319  * FUNCTION:    AcpiExOpcode_6A_0T_1R
320  *
321  * PARAMETERS:  WalkState           - Current walk state
322  *
323  * RETURN:      Status
324  *
325  * DESCRIPTION: Execute opcode with 6 arguments, no target, and a return value
326  *
327  ******************************************************************************/
328 
329 ACPI_STATUS
AcpiExOpcode_6A_0T_1R(ACPI_WALK_STATE * WalkState)330 AcpiExOpcode_6A_0T_1R (
331     ACPI_WALK_STATE         *WalkState)
332 {
333     ACPI_OPERAND_OBJECT     **Operand = &WalkState->Operands[0];
334     ACPI_OPERAND_OBJECT     *ReturnDesc = NULL;
335     ACPI_STATUS             Status = AE_OK;
336     UINT64                  Index;
337     ACPI_OPERAND_OBJECT     *ThisElement;
338 
339 
340     ACPI_FUNCTION_TRACE_STR (ExOpcode_6A_0T_1R,
341         AcpiPsGetOpcodeName (WalkState->Opcode));
342 
343 
344     switch (WalkState->Opcode)
345     {
346     case AML_MATCH_OP:
347         /*
348          * Match (SearchPkg[0], MatchOp1[1], MatchObj1[2],
349          *                      MatchOp2[3], MatchObj2[4], StartIndex[5])
350          */
351 
352         /* Validate both Match Term Operators (MTR, MEQ, etc.) */
353 
354         if ((Operand[1]->Integer.Value > MAX_MATCH_OPERATOR) ||
355             (Operand[3]->Integer.Value > MAX_MATCH_OPERATOR))
356         {
357             ACPI_ERROR ((AE_INFO, "Match operator out of range"));
358             Status = AE_AML_OPERAND_VALUE;
359             goto Cleanup;
360         }
361 
362         /* Get the package StartIndex, validate against the package length */
363 
364         Index = Operand[5]->Integer.Value;
365         if (Index >= Operand[0]->Package.Count)
366         {
367             ACPI_ERROR ((AE_INFO,
368                 "Index (0x%8.8X%8.8X) beyond package end (0x%X)",
369                 ACPI_FORMAT_UINT64 (Index), Operand[0]->Package.Count));
370             Status = AE_AML_PACKAGE_LIMIT;
371             goto Cleanup;
372         }
373 
374         /* Create an integer for the return value */
375         /* Default return value is ACPI_UINT64_MAX if no match found */
376 
377         ReturnDesc = AcpiUtCreateIntegerObject (ACPI_UINT64_MAX);
378         if (!ReturnDesc)
379         {
380             Status = AE_NO_MEMORY;
381             goto Cleanup;
382 
383         }
384 
385         /*
386          * Examine each element until a match is found. Both match conditions
387          * must be satisfied for a match to occur. Within the loop,
388          * "continue" signifies that the current element does not match
389          * and the next should be examined.
390          *
391          * Upon finding a match, the loop will terminate via "break" at
392          * the bottom. If it terminates "normally", MatchValue will be
393          * ACPI_UINT64_MAX (Ones) (its initial value) indicating that no
394          * match was found.
395          */
396         for ( ; Index < Operand[0]->Package.Count; Index++)
397         {
398             /* Get the current package element */
399 
400             ThisElement = Operand[0]->Package.Elements[Index];
401 
402             /* Treat any uninitialized (NULL) elements as non-matching */
403 
404             if (!ThisElement)
405             {
406                 continue;
407             }
408 
409             /*
410              * Both match conditions must be satisfied. Execution of a continue
411              * (proceed to next iteration of enclosing for loop) signifies a
412              * non-match.
413              */
414             if (!AcpiExDoMatch ((UINT32) Operand[1]->Integer.Value,
415                     ThisElement, Operand[2]))
416             {
417                 continue;
418             }
419 
420             if (!AcpiExDoMatch ((UINT32) Operand[3]->Integer.Value,
421                     ThisElement, Operand[4]))
422             {
423                 continue;
424             }
425 
426             /* Match found: Index is the return value */
427 
428             ReturnDesc->Integer.Value = Index;
429             break;
430         }
431         break;
432 
433     case AML_LOAD_TABLE_OP:
434 
435         Status = AcpiExLoadTableOp (WalkState, &ReturnDesc);
436         break;
437 
438     default:
439 
440         ACPI_ERROR ((AE_INFO, "Unknown AML opcode 0x%X",
441             WalkState->Opcode));
442 
443         Status = AE_AML_BAD_OPCODE;
444         goto Cleanup;
445     }
446 
447 
448 Cleanup:
449 
450     /* Delete return object on error */
451 
452     if (ACPI_FAILURE (Status))
453     {
454         AcpiUtRemoveReference (ReturnDesc);
455     }
456 
457     /* Save return object on success */
458 
459     else
460     {
461         WalkState->ResultObj = ReturnDesc;
462     }
463 
464     return_ACPI_STATUS (Status);
465 }
466