1 /******************************************************************************
3 * Module Name: exmisc - ACPI AML (p-code) execution - specific opcodes
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2017, Intel Corp.
12 * All rights reserved.
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
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
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;
37 * The above copyright and patent license is granted only if the following
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.
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
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
72 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
80 * 4. Disclaimer and Export Compliance
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
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
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
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.
115 *****************************************************************************
117 * Alternatively, you may choose to be licensed under the terms of the
120 * Redistribution and use in source and binary forms, with or without
121 * modification, are permitted provided that the following conditions
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.
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.
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.
151 *****************************************************************************/
153 #include <contrib/dev/acpica/include/acpi.h>
154 #include <contrib/dev/acpica/include/accommon.h>
155 #include <contrib/dev/acpica/include/acinterp.h>
156 #include <contrib/dev/acpica/include/amlcode.h>
159 #define _COMPONENT ACPI_EXECUTER
160 ACPI_MODULE_NAME ("exmisc")
163 /*******************************************************************************
165 * FUNCTION: AcpiExGetObjectReference
167 * PARAMETERS: ObjDesc - Create a reference to this object
168 * ReturnDesc - Where to store the reference
169 * WalkState - Current state
173 * DESCRIPTION: Obtain and return a "reference" to the target object
174 * Common code for the RefOfOp and the CondRefOfOp.
176 ******************************************************************************/
179 AcpiExGetObjectReference (
180 ACPI_OPERAND_OBJECT *ObjDesc,
181 ACPI_OPERAND_OBJECT **ReturnDesc,
182 ACPI_WALK_STATE *WalkState)
184 ACPI_OPERAND_OBJECT *ReferenceObj;
185 ACPI_OPERAND_OBJECT *ReferencedObj;
188 ACPI_FUNCTION_TRACE_PTR (ExGetObjectReference, ObjDesc);
193 switch (ACPI_GET_DESCRIPTOR_TYPE (ObjDesc))
195 case ACPI_DESC_TYPE_OPERAND:
197 if (ObjDesc->Common.Type != ACPI_TYPE_LOCAL_REFERENCE)
199 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
203 * Must be a reference to a Local or Arg
205 switch (ObjDesc->Reference.Class)
207 case ACPI_REFCLASS_LOCAL:
208 case ACPI_REFCLASS_ARG:
209 case ACPI_REFCLASS_DEBUG:
211 /* The referenced object is the pseudo-node for the local/arg */
213 ReferencedObj = ObjDesc->Reference.Object;
218 ACPI_ERROR ((AE_INFO, "Invalid Reference Class 0x%2.2X",
219 ObjDesc->Reference.Class));
220 return_ACPI_STATUS (AE_AML_OPERAND_TYPE);
224 case ACPI_DESC_TYPE_NAMED:
226 * A named reference that has already been resolved to a Node
228 ReferencedObj = ObjDesc;
233 ACPI_ERROR ((AE_INFO, "Invalid descriptor type 0x%X",
234 ACPI_GET_DESCRIPTOR_TYPE (ObjDesc)));
235 return_ACPI_STATUS (AE_TYPE);
239 /* Create a new reference object */
241 ReferenceObj = AcpiUtCreateInternalObject (ACPI_TYPE_LOCAL_REFERENCE);
244 return_ACPI_STATUS (AE_NO_MEMORY);
247 ReferenceObj->Reference.Class = ACPI_REFCLASS_REFOF;
248 ReferenceObj->Reference.Object = ReferencedObj;
249 *ReturnDesc = ReferenceObj;
251 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
252 "Object %p Type [%s], returning Reference %p\n",
253 ObjDesc, AcpiUtGetObjectTypeName (ObjDesc), *ReturnDesc));
255 return_ACPI_STATUS (AE_OK);
259 /*******************************************************************************
261 * FUNCTION: AcpiExDoMathOp
263 * PARAMETERS: Opcode - AML opcode
264 * Integer0 - Integer operand #0
265 * Integer1 - Integer operand #1
267 * RETURN: Integer result of the operation
269 * DESCRIPTION: Execute a math AML opcode. The purpose of having all of the
270 * math functions here is to prevent a lot of pointer dereferencing
271 * to obtain the operands.
273 ******************************************************************************/
282 ACPI_FUNCTION_ENTRY ();
287 case AML_ADD_OP: /* Add (Integer0, Integer1, Result) */
289 return (Integer0 + Integer1);
291 case AML_BIT_AND_OP: /* And (Integer0, Integer1, Result) */
293 return (Integer0 & Integer1);
295 case AML_BIT_NAND_OP: /* NAnd (Integer0, Integer1, Result) */
297 return (~(Integer0 & Integer1));
299 case AML_BIT_OR_OP: /* Or (Integer0, Integer1, Result) */
301 return (Integer0 | Integer1);
303 case AML_BIT_NOR_OP: /* NOr (Integer0, Integer1, Result) */
305 return (~(Integer0 | Integer1));
307 case AML_BIT_XOR_OP: /* XOr (Integer0, Integer1, Result) */
309 return (Integer0 ^ Integer1);
311 case AML_MULTIPLY_OP: /* Multiply (Integer0, Integer1, Result) */
313 return (Integer0 * Integer1);
315 case AML_SHIFT_LEFT_OP: /* ShiftLeft (Operand, ShiftCount, Result)*/
318 * We need to check if the shiftcount is larger than the integer bit
319 * width since the behavior of this is not well-defined in the C language.
321 if (Integer1 >= AcpiGbl_IntegerBitWidth)
325 return (Integer0 << Integer1);
327 case AML_SHIFT_RIGHT_OP: /* ShiftRight (Operand, ShiftCount, Result) */
330 * We need to check if the shiftcount is larger than the integer bit
331 * width since the behavior of this is not well-defined in the C language.
333 if (Integer1 >= AcpiGbl_IntegerBitWidth)
337 return (Integer0 >> Integer1);
339 case AML_SUBTRACT_OP: /* Subtract (Integer0, Integer1, Result) */
341 return (Integer0 - Integer1);
350 /*******************************************************************************
352 * FUNCTION: AcpiExDoLogicalNumericOp
354 * PARAMETERS: Opcode - AML opcode
355 * Integer0 - Integer operand #0
356 * Integer1 - Integer operand #1
357 * LogicalResult - TRUE/FALSE result of the operation
361 * DESCRIPTION: Execute a logical "Numeric" AML opcode. For these Numeric
362 * operators (LAnd and LOr), both operands must be integers.
364 * Note: cleanest machine code seems to be produced by the code
365 * below, rather than using statements of the form:
366 * Result = (Integer0 && Integer1);
368 ******************************************************************************/
371 AcpiExDoLogicalNumericOp (
375 BOOLEAN *LogicalResult)
377 ACPI_STATUS Status = AE_OK;
378 BOOLEAN LocalResult = FALSE;
381 ACPI_FUNCTION_TRACE (ExDoLogicalNumericOp);
386 case AML_LOGICAL_AND_OP: /* LAnd (Integer0, Integer1) */
388 if (Integer0 && Integer1)
394 case AML_LOGICAL_OR_OP: /* LOr (Integer0, Integer1) */
396 if (Integer0 || Integer1)
404 Status = AE_AML_INTERNAL;
408 /* Return the logical result and status */
410 *LogicalResult = LocalResult;
411 return_ACPI_STATUS (Status);
415 /*******************************************************************************
417 * FUNCTION: AcpiExDoLogicalOp
419 * PARAMETERS: Opcode - AML opcode
420 * Operand0 - operand #0
421 * Operand1 - operand #1
422 * LogicalResult - TRUE/FALSE result of the operation
426 * DESCRIPTION: Execute a logical AML opcode. The purpose of having all of the
427 * functions here is to prevent a lot of pointer dereferencing
428 * to obtain the operands and to simplify the generation of the
429 * logical value. For the Numeric operators (LAnd and LOr), both
430 * operands must be integers. For the other logical operators,
431 * operands can be any combination of Integer/String/Buffer. The
432 * first operand determines the type to which the second operand
435 * Note: cleanest machine code seems to be produced by the code
436 * below, rather than using statements of the form:
437 * Result = (Operand0 == Operand1);
439 ******************************************************************************/
444 ACPI_OPERAND_OBJECT *Operand0,
445 ACPI_OPERAND_OBJECT *Operand1,
446 BOOLEAN *LogicalResult)
448 ACPI_OPERAND_OBJECT *LocalOperand1 = Operand1;
453 ACPI_STATUS Status = AE_OK;
454 BOOLEAN LocalResult = FALSE;
458 ACPI_FUNCTION_TRACE (ExDoLogicalOp);
462 * Convert the second operand if necessary. The first operand
463 * determines the type of the second operand, (See the Data Types
464 * section of the ACPI 3.0+ specification.) Both object types are
465 * guaranteed to be either Integer/String/Buffer by the operand
466 * resolution mechanism.
468 switch (Operand0->Common.Type)
470 case ACPI_TYPE_INTEGER:
472 Status = AcpiExConvertToInteger (Operand1, &LocalOperand1,
473 ACPI_STRTOUL_BASE16);
476 case ACPI_TYPE_STRING:
478 Status = AcpiExConvertToString (
479 Operand1, &LocalOperand1, ACPI_IMPLICIT_CONVERT_HEX);
482 case ACPI_TYPE_BUFFER:
484 Status = AcpiExConvertToBuffer (Operand1, &LocalOperand1);
489 Status = AE_AML_INTERNAL;
493 if (ACPI_FAILURE (Status))
499 * Two cases: 1) Both Integers, 2) Both Strings or Buffers
501 if (Operand0->Common.Type == ACPI_TYPE_INTEGER)
504 * 1) Both operands are of type integer
505 * Note: LocalOperand1 may have changed above
507 Integer0 = Operand0->Integer.Value;
508 Integer1 = LocalOperand1->Integer.Value;
512 case AML_LOGICAL_EQUAL_OP: /* LEqual (Operand0, Operand1) */
514 if (Integer0 == Integer1)
520 case AML_LOGICAL_GREATER_OP: /* LGreater (Operand0, Operand1) */
522 if (Integer0 > Integer1)
528 case AML_LOGICAL_LESS_OP: /* LLess (Operand0, Operand1) */
530 if (Integer0 < Integer1)
538 Status = AE_AML_INTERNAL;
545 * 2) Both operands are Strings or both are Buffers
546 * Note: Code below takes advantage of common Buffer/String
547 * object fields. LocalOperand1 may have changed above. Use
548 * memcmp to handle nulls in buffers.
550 Length0 = Operand0->Buffer.Length;
551 Length1 = LocalOperand1->Buffer.Length;
553 /* Lexicographic compare: compare the data bytes */
555 Compare = memcmp (Operand0->Buffer.Pointer,
556 LocalOperand1->Buffer.Pointer,
557 (Length0 > Length1) ? Length1 : Length0);
561 case AML_LOGICAL_EQUAL_OP: /* LEqual (Operand0, Operand1) */
563 /* Length and all bytes must be equal */
565 if ((Length0 == Length1) &&
568 /* Length and all bytes match ==> TRUE */
574 case AML_LOGICAL_GREATER_OP: /* LGreater (Operand0, Operand1) */
579 goto Cleanup; /* TRUE */
583 goto Cleanup; /* FALSE */
586 /* Bytes match (to shortest length), compare lengths */
588 if (Length0 > Length1)
594 case AML_LOGICAL_LESS_OP: /* LLess (Operand0, Operand1) */
598 goto Cleanup; /* FALSE */
603 goto Cleanup; /* TRUE */
606 /* Bytes match (to shortest length), compare lengths */
608 if (Length0 < Length1)
616 Status = AE_AML_INTERNAL;
623 /* New object was created if implicit conversion performed - delete */
625 if (LocalOperand1 != Operand1)
627 AcpiUtRemoveReference (LocalOperand1);
630 /* Return the logical result and status */
632 *LogicalResult = LocalResult;
633 return_ACPI_STATUS (Status);