1 /******************************************************************************
3 * Module Name: exoparg2 - AML execution - opcodes with 2 arguments
5 *****************************************************************************/
7 /******************************************************************************
11 * Some or all of this work - Copyright (c) 1999 - 2015, 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
86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
99 * 4.3. Licensee shall not export, either directly or indirectly, any of this
100 * software or system incorporating such software without first obtaining any
101 * required license or other approval from the U. S. Department of Commerce or
102 * any other agency or department of the United States Government. In the
103 * event Licensee exports any such software from the United States or
104 * re-exports any such software from a foreign destination, Licensee shall
105 * ensure that the distribution and export/re-export of the software is in
106 * compliance with all laws, regulations, orders, or other restrictions of the
107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108 * any of its subsidiaries will export/re-export any technical data, process,
109 * software, or service, directly or indirectly, to any country for which the
110 * United States government or any agency thereof requires an export license,
111 * other governmental approval, or letter of assurance, without first obtaining
112 * such license, approval or letter.
114 *****************************************************************************/
117 #include "accommon.h"
118 #include "acparser.h"
119 #include "acinterp.h"
120 #include "acevents.h"
124 #define _COMPONENT ACPI_EXECUTER
125 ACPI_MODULE_NAME ("exoparg2")
129 * Naming convention for AML interpreter execution routines.
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:
135 * AcpiExOpcode_xA_yT_zR
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).
146 * The AcpiExOpcode* functions are called via the Dispatcher component with
147 * fully resolved operands.
151 /*******************************************************************************
153 * FUNCTION: AcpiExOpcode_2A_0T_0R
155 * PARAMETERS: WalkState - Current walk state
159 * DESCRIPTION: Execute opcode with two arguments, no target, and no return
162 * ALLOCATION: Deletes both operands
164 ******************************************************************************/
167 AcpiExOpcode_2A_0T_0R (
168 ACPI_WALK_STATE
*WalkState
)
170 ACPI_OPERAND_OBJECT
**Operand
= &WalkState
->Operands
[0];
171 ACPI_NAMESPACE_NODE
*Node
;
173 ACPI_STATUS Status
= AE_OK
;
176 ACPI_FUNCTION_TRACE_STR (ExOpcode_2A_0T_0R
,
177 AcpiPsGetOpcodeName (WalkState
->Opcode
));
180 /* Examine the opcode */
182 switch (WalkState
->Opcode
)
184 case AML_NOTIFY_OP
: /* Notify (NotifyObject, NotifyValue) */
186 /* The first operand is a namespace node */
188 Node
= (ACPI_NAMESPACE_NODE
*) Operand
[0];
190 /* Second value is the notify value */
192 Value
= (UINT32
) Operand
[1]->Integer
.Value
;
194 /* Are notifies allowed on this object? */
196 if (!AcpiEvIsNotifyObject (Node
))
198 ACPI_ERROR ((AE_INFO
,
199 "Unexpected notify object type [%s]",
200 AcpiUtGetTypeName (Node
->Type
)));
202 Status
= AE_AML_OPERAND_TYPE
;
207 * Dispatch the notify to the appropriate handler
208 * NOTE: the request is queued for execution after this method
209 * completes. The notify handlers are NOT invoked synchronously
210 * from this thread -- because handlers may in turn run other
213 Status
= AcpiEvQueueNotifyRequest (Node
, Value
);
218 ACPI_ERROR ((AE_INFO
, "Unknown AML opcode 0x%X",
220 Status
= AE_AML_BAD_OPCODE
;
223 return_ACPI_STATUS (Status
);
227 /*******************************************************************************
229 * FUNCTION: AcpiExOpcode_2A_2T_1R
231 * PARAMETERS: WalkState - Current walk state
235 * DESCRIPTION: Execute a dyadic operator (2 operands) with 2 output targets
236 * and one implicit return value.
238 ******************************************************************************/
241 AcpiExOpcode_2A_2T_1R (
242 ACPI_WALK_STATE
*WalkState
)
244 ACPI_OPERAND_OBJECT
**Operand
= &WalkState
->Operands
[0];
245 ACPI_OPERAND_OBJECT
*ReturnDesc1
= NULL
;
246 ACPI_OPERAND_OBJECT
*ReturnDesc2
= NULL
;
250 ACPI_FUNCTION_TRACE_STR (ExOpcode_2A_2T_1R
,
251 AcpiPsGetOpcodeName (WalkState
->Opcode
));
254 /* Execute the opcode */
256 switch (WalkState
->Opcode
)
260 /* Divide (Dividend, Divisor, RemainderResult QuotientResult) */
262 ReturnDesc1
= AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER
);
265 Status
= AE_NO_MEMORY
;
269 ReturnDesc2
= AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER
);
272 Status
= AE_NO_MEMORY
;
276 /* Quotient to ReturnDesc1, remainder to ReturnDesc2 */
278 Status
= AcpiUtDivide (
279 Operand
[0]->Integer
.Value
,
280 Operand
[1]->Integer
.Value
,
281 &ReturnDesc1
->Integer
.Value
,
282 &ReturnDesc2
->Integer
.Value
);
283 if (ACPI_FAILURE (Status
))
291 ACPI_ERROR ((AE_INFO
, "Unknown AML opcode 0x%X",
294 Status
= AE_AML_BAD_OPCODE
;
298 /* Store the results to the target reference operands */
300 Status
= AcpiExStore (ReturnDesc2
, Operand
[2], WalkState
);
301 if (ACPI_FAILURE (Status
))
306 Status
= AcpiExStore (ReturnDesc1
, Operand
[3], WalkState
);
307 if (ACPI_FAILURE (Status
))
314 * Since the remainder is not returned indirectly, remove a reference to
315 * it. Only the quotient is returned indirectly.
317 AcpiUtRemoveReference (ReturnDesc2
);
319 if (ACPI_FAILURE (Status
))
321 /* Delete the return object */
323 AcpiUtRemoveReference (ReturnDesc1
);
326 /* Save return object (the remainder) on success */
330 WalkState
->ResultObj
= ReturnDesc1
;
333 return_ACPI_STATUS (Status
);
337 /*******************************************************************************
339 * FUNCTION: AcpiExOpcode_2A_1T_1R
341 * PARAMETERS: WalkState - Current walk state
345 * DESCRIPTION: Execute opcode with two arguments, one target, and a return
348 ******************************************************************************/
351 AcpiExOpcode_2A_1T_1R (
352 ACPI_WALK_STATE
*WalkState
)
354 ACPI_OPERAND_OBJECT
**Operand
= &WalkState
->Operands
[0];
355 ACPI_OPERAND_OBJECT
*ReturnDesc
= NULL
;
357 ACPI_STATUS Status
= AE_OK
;
358 ACPI_SIZE Length
= 0;
361 ACPI_FUNCTION_TRACE_STR (ExOpcode_2A_1T_1R
,
362 AcpiPsGetOpcodeName (WalkState
->Opcode
));
365 /* Execute the opcode */
367 if (WalkState
->OpInfo
->Flags
& AML_MATH
)
369 /* All simple math opcodes (add, etc.) */
371 ReturnDesc
= AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER
);
374 Status
= AE_NO_MEMORY
;
378 ReturnDesc
->Integer
.Value
= AcpiExDoMathOp (
380 Operand
[0]->Integer
.Value
,
381 Operand
[1]->Integer
.Value
);
382 goto StoreResultToTarget
;
385 switch (WalkState
->Opcode
)
387 case AML_MOD_OP
: /* Mod (Dividend, Divisor, RemainderResult (ACPI 2.0) */
389 ReturnDesc
= AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER
);
392 Status
= AE_NO_MEMORY
;
396 /* ReturnDesc will contain the remainder */
398 Status
= AcpiUtDivide (
399 Operand
[0]->Integer
.Value
,
400 Operand
[1]->Integer
.Value
,
402 &ReturnDesc
->Integer
.Value
);
405 case AML_CONCAT_OP
: /* Concatenate (Data1, Data2, Result) */
407 Status
= AcpiExDoConcatenate (
408 Operand
[0], Operand
[1], &ReturnDesc
, WalkState
);
411 case AML_TO_STRING_OP
: /* ToString (Buffer, Length, Result) (ACPI 2.0) */
413 * Input object is guaranteed to be a buffer at this point (it may have
414 * been converted.) Copy the raw buffer data to a new object of
419 * Get the length of the new string. It is the smallest of:
420 * 1) Length of the input buffer
421 * 2) Max length as specified in the ToString operator
422 * 3) Length of input buffer up to a zero byte (null terminator)
424 * NOTE: A length of zero is ok, and will create a zero-length, null
427 while ((Length
< Operand
[0]->Buffer
.Length
) &&
428 (Length
< Operand
[1]->Integer
.Value
) &&
429 (Operand
[0]->Buffer
.Pointer
[Length
]))
434 /* Allocate a new string object */
436 ReturnDesc
= AcpiUtCreateStringObject (Length
);
439 Status
= AE_NO_MEMORY
;
444 * Copy the raw buffer data with no transform.
445 * (NULL terminated already)
447 memcpy (ReturnDesc
->String
.Pointer
,
448 Operand
[0]->Buffer
.Pointer
, Length
);
451 case AML_CONCAT_RES_OP
:
453 /* ConcatenateResTemplate (Buffer, Buffer, Result) (ACPI 2.0) */
455 Status
= AcpiExConcatTemplate (
456 Operand
[0], Operand
[1], &ReturnDesc
, WalkState
);
459 case AML_INDEX_OP
: /* Index (Source Index Result) */
461 /* Create the internal return object */
463 ReturnDesc
= AcpiUtCreateInternalObject (ACPI_TYPE_LOCAL_REFERENCE
);
466 Status
= AE_NO_MEMORY
;
470 /* Initialize the Index reference object */
472 Index
= Operand
[1]->Integer
.Value
;
473 ReturnDesc
->Reference
.Value
= (UINT32
) Index
;
474 ReturnDesc
->Reference
.Class
= ACPI_REFCLASS_INDEX
;
477 * At this point, the Source operand is a String, Buffer, or Package.
478 * Verify that the index is within range.
480 switch ((Operand
[0])->Common
.Type
)
482 case ACPI_TYPE_STRING
:
484 if (Index
>= Operand
[0]->String
.Length
)
486 Length
= Operand
[0]->String
.Length
;
487 Status
= AE_AML_STRING_LIMIT
;
490 ReturnDesc
->Reference
.TargetType
= ACPI_TYPE_BUFFER_FIELD
;
491 ReturnDesc
->Reference
.IndexPointer
=
492 &(Operand
[0]->Buffer
.Pointer
[Index
]);
495 case ACPI_TYPE_BUFFER
:
497 if (Index
>= Operand
[0]->Buffer
.Length
)
499 Length
= Operand
[0]->Buffer
.Length
;
500 Status
= AE_AML_BUFFER_LIMIT
;
503 ReturnDesc
->Reference
.TargetType
= ACPI_TYPE_BUFFER_FIELD
;
504 ReturnDesc
->Reference
.IndexPointer
=
505 &(Operand
[0]->Buffer
.Pointer
[Index
]);
508 case ACPI_TYPE_PACKAGE
:
510 if (Index
>= Operand
[0]->Package
.Count
)
512 Length
= Operand
[0]->Package
.Count
;
513 Status
= AE_AML_PACKAGE_LIMIT
;
516 ReturnDesc
->Reference
.TargetType
= ACPI_TYPE_PACKAGE
;
517 ReturnDesc
->Reference
.Where
=
518 &Operand
[0]->Package
.Elements
[Index
];
523 Status
= AE_AML_INTERNAL
;
527 /* Failure means that the Index was beyond the end of the object */
529 if (ACPI_FAILURE (Status
))
531 ACPI_EXCEPTION ((AE_INFO
, Status
,
532 "Index (0x%X%8.8X) is beyond end of object (length 0x%X)",
533 ACPI_FORMAT_UINT64 (Index
), (UINT32
) Length
));
538 * Save the target object and add a reference to it for the life
541 ReturnDesc
->Reference
.Object
= Operand
[0];
542 AcpiUtAddReference (Operand
[0]);
544 /* Store the reference to the Target */
546 Status
= AcpiExStore (ReturnDesc
, Operand
[2], WalkState
);
548 /* Return the reference */
550 WalkState
->ResultObj
= ReturnDesc
;
555 ACPI_ERROR ((AE_INFO
, "Unknown AML opcode 0x%X",
557 Status
= AE_AML_BAD_OPCODE
;
564 if (ACPI_SUCCESS (Status
))
567 * Store the result of the operation (which is now in ReturnDesc) into
568 * the Target descriptor.
570 Status
= AcpiExStore (ReturnDesc
, Operand
[2], WalkState
);
571 if (ACPI_FAILURE (Status
))
576 if (!WalkState
->ResultObj
)
578 WalkState
->ResultObj
= ReturnDesc
;
585 /* Delete return object on error */
587 if (ACPI_FAILURE (Status
))
589 AcpiUtRemoveReference (ReturnDesc
);
590 WalkState
->ResultObj
= NULL
;
593 return_ACPI_STATUS (Status
);
597 /*******************************************************************************
599 * FUNCTION: AcpiExOpcode_2A_0T_1R
601 * PARAMETERS: WalkState - Current walk state
605 * DESCRIPTION: Execute opcode with 2 arguments, no target, and a return value
607 ******************************************************************************/
610 AcpiExOpcode_2A_0T_1R (
611 ACPI_WALK_STATE
*WalkState
)
613 ACPI_OPERAND_OBJECT
**Operand
= &WalkState
->Operands
[0];
614 ACPI_OPERAND_OBJECT
*ReturnDesc
= NULL
;
615 ACPI_STATUS Status
= AE_OK
;
616 BOOLEAN LogicalResult
= FALSE
;
619 ACPI_FUNCTION_TRACE_STR (ExOpcode_2A_0T_1R
,
620 AcpiPsGetOpcodeName (WalkState
->Opcode
));
623 /* Create the internal return object */
625 ReturnDesc
= AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER
);
628 Status
= AE_NO_MEMORY
;
632 /* Execute the Opcode */
634 if (WalkState
->OpInfo
->Flags
& AML_LOGICAL_NUMERIC
)
636 /* LogicalOp (Operand0, Operand1) */
638 Status
= AcpiExDoLogicalNumericOp (WalkState
->Opcode
,
639 Operand
[0]->Integer
.Value
, Operand
[1]->Integer
.Value
,
641 goto StoreLogicalResult
;
643 else if (WalkState
->OpInfo
->Flags
& AML_LOGICAL
)
645 /* LogicalOp (Operand0, Operand1) */
647 Status
= AcpiExDoLogicalOp (WalkState
->Opcode
, Operand
[0],
648 Operand
[1], &LogicalResult
);
649 goto StoreLogicalResult
;
652 switch (WalkState
->Opcode
)
654 case AML_ACQUIRE_OP
: /* Acquire (MutexObject, Timeout) */
656 Status
= AcpiExAcquireMutex (Operand
[1], Operand
[0], WalkState
);
657 if (Status
== AE_TIME
)
659 LogicalResult
= TRUE
; /* TRUE = Acquire timed out */
665 case AML_WAIT_OP
: /* Wait (EventObject, Timeout) */
667 Status
= AcpiExSystemWaitEvent (Operand
[1], Operand
[0]);
668 if (Status
== AE_TIME
)
670 LogicalResult
= TRUE
; /* TRUE, Wait timed out */
677 ACPI_ERROR ((AE_INFO
, "Unknown AML opcode 0x%X",
680 Status
= AE_AML_BAD_OPCODE
;
687 * Set return value to according to LogicalResult. logical TRUE (all ones)
688 * Default is FALSE (zero)
692 ReturnDesc
->Integer
.Value
= ACPI_UINT64_MAX
;
697 /* Delete return object on error */
699 if (ACPI_FAILURE (Status
))
701 AcpiUtRemoveReference (ReturnDesc
);
704 /* Save return object on success */
708 WalkState
->ResultObj
= ReturnDesc
;
711 return_ACPI_STATUS (Status
);