1 /******************************************************************************
3 * Module Name: exoparg2 - AML execution - opcodes with 2 arguments
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2015, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
52 #define _COMPONENT ACPI_EXECUTER
53 ACPI_MODULE_NAME ("exoparg2")
57 * Naming convention for AML interpreter execution routines.
59 * The routines that begin execution of AML opcodes are named with a common
60 * convention based upon the number of arguments, the number of target operands,
61 * and whether or not a value is returned:
63 * AcpiExOpcode_xA_yT_zR
67 * xA - ARGUMENTS: The number of arguments (input operands) that are
68 * required for this opcode type (1 through 6 args).
69 * yT - TARGETS: The number of targets (output operands) that are required
70 * for this opcode type (0, 1, or 2 targets).
71 * zR - RETURN VALUE: Indicates whether this opcode type returns a value
72 * as the function return (0 or 1).
74 * The AcpiExOpcode* functions are called via the Dispatcher component with
75 * fully resolved operands.
79 /*******************************************************************************
81 * FUNCTION: AcpiExOpcode_2A_0T_0R
83 * PARAMETERS: WalkState - Current walk state
87 * DESCRIPTION: Execute opcode with two arguments, no target, and no return
90 * ALLOCATION: Deletes both operands
92 ******************************************************************************/
95 AcpiExOpcode_2A_0T_0R (
96 ACPI_WALK_STATE *WalkState)
98 ACPI_OPERAND_OBJECT **Operand = &WalkState->Operands[0];
99 ACPI_NAMESPACE_NODE *Node;
101 ACPI_STATUS Status = AE_OK;
104 ACPI_FUNCTION_TRACE_STR (ExOpcode_2A_0T_0R,
105 AcpiPsGetOpcodeName (WalkState->Opcode));
108 /* Examine the opcode */
110 switch (WalkState->Opcode)
112 case AML_NOTIFY_OP: /* Notify (NotifyObject, NotifyValue) */
114 /* The first operand is a namespace node */
116 Node = (ACPI_NAMESPACE_NODE *) Operand[0];
118 /* Second value is the notify value */
120 Value = (UINT32) Operand[1]->Integer.Value;
122 /* Are notifies allowed on this object? */
124 if (!AcpiEvIsNotifyObject (Node))
126 ACPI_ERROR ((AE_INFO,
127 "Unexpected notify object type [%s]",
128 AcpiUtGetTypeName (Node->Type)));
130 Status = AE_AML_OPERAND_TYPE;
135 * Dispatch the notify to the appropriate handler
136 * NOTE: the request is queued for execution after this method
137 * completes. The notify handlers are NOT invoked synchronously
138 * from this thread -- because handlers may in turn run other
141 Status = AcpiEvQueueNotifyRequest (Node, Value);
146 ACPI_ERROR ((AE_INFO, "Unknown AML opcode 0x%X",
148 Status = AE_AML_BAD_OPCODE;
151 return_ACPI_STATUS (Status);
155 /*******************************************************************************
157 * FUNCTION: AcpiExOpcode_2A_2T_1R
159 * PARAMETERS: WalkState - Current walk state
163 * DESCRIPTION: Execute a dyadic operator (2 operands) with 2 output targets
164 * and one implicit return value.
166 ******************************************************************************/
169 AcpiExOpcode_2A_2T_1R (
170 ACPI_WALK_STATE *WalkState)
172 ACPI_OPERAND_OBJECT **Operand = &WalkState->Operands[0];
173 ACPI_OPERAND_OBJECT *ReturnDesc1 = NULL;
174 ACPI_OPERAND_OBJECT *ReturnDesc2 = NULL;
178 ACPI_FUNCTION_TRACE_STR (ExOpcode_2A_2T_1R,
179 AcpiPsGetOpcodeName (WalkState->Opcode));
182 /* Execute the opcode */
184 switch (WalkState->Opcode)
188 /* Divide (Dividend, Divisor, RemainderResult QuotientResult) */
190 ReturnDesc1 = AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER);
193 Status = AE_NO_MEMORY;
197 ReturnDesc2 = AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER);
200 Status = AE_NO_MEMORY;
204 /* Quotient to ReturnDesc1, remainder to ReturnDesc2 */
206 Status = AcpiUtDivide (Operand[0]->Integer.Value,
207 Operand[1]->Integer.Value,
208 &ReturnDesc1->Integer.Value,
209 &ReturnDesc2->Integer.Value);
210 if (ACPI_FAILURE (Status))
218 ACPI_ERROR ((AE_INFO, "Unknown AML opcode 0x%X",
220 Status = AE_AML_BAD_OPCODE;
224 /* Store the results to the target reference operands */
226 Status = AcpiExStore (ReturnDesc2, Operand[2], WalkState);
227 if (ACPI_FAILURE (Status))
232 Status = AcpiExStore (ReturnDesc1, Operand[3], WalkState);
233 if (ACPI_FAILURE (Status))
240 * Since the remainder is not returned indirectly, remove a reference to
241 * it. Only the quotient is returned indirectly.
243 AcpiUtRemoveReference (ReturnDesc2);
245 if (ACPI_FAILURE (Status))
247 /* Delete the return object */
249 AcpiUtRemoveReference (ReturnDesc1);
252 /* Save return object (the remainder) on success */
256 WalkState->ResultObj = ReturnDesc1;
259 return_ACPI_STATUS (Status);
263 /*******************************************************************************
265 * FUNCTION: AcpiExOpcode_2A_1T_1R
267 * PARAMETERS: WalkState - Current walk state
271 * DESCRIPTION: Execute opcode with two arguments, one target, and a return
274 ******************************************************************************/
277 AcpiExOpcode_2A_1T_1R (
278 ACPI_WALK_STATE *WalkState)
280 ACPI_OPERAND_OBJECT **Operand = &WalkState->Operands[0];
281 ACPI_OPERAND_OBJECT *ReturnDesc = NULL;
283 ACPI_STATUS Status = AE_OK;
284 ACPI_SIZE Length = 0;
287 ACPI_FUNCTION_TRACE_STR (ExOpcode_2A_1T_1R,
288 AcpiPsGetOpcodeName (WalkState->Opcode));
291 /* Execute the opcode */
293 if (WalkState->OpInfo->Flags & AML_MATH)
295 /* All simple math opcodes (add, etc.) */
297 ReturnDesc = AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER);
300 Status = AE_NO_MEMORY;
304 ReturnDesc->Integer.Value = AcpiExDoMathOp (WalkState->Opcode,
305 Operand[0]->Integer.Value,
306 Operand[1]->Integer.Value);
307 goto StoreResultToTarget;
310 switch (WalkState->Opcode)
312 case AML_MOD_OP: /* Mod (Dividend, Divisor, RemainderResult (ACPI 2.0) */
314 ReturnDesc = AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER);
317 Status = AE_NO_MEMORY;
321 /* ReturnDesc will contain the remainder */
323 Status = AcpiUtDivide (Operand[0]->Integer.Value,
324 Operand[1]->Integer.Value,
326 &ReturnDesc->Integer.Value);
329 case AML_CONCAT_OP: /* Concatenate (Data1, Data2, Result) */
331 Status = AcpiExDoConcatenate (Operand[0], Operand[1],
332 &ReturnDesc, WalkState);
335 case AML_TO_STRING_OP: /* ToString (Buffer, Length, Result) (ACPI 2.0) */
337 * Input object is guaranteed to be a buffer at this point (it may have
338 * been converted.) Copy the raw buffer data to a new object of
343 * Get the length of the new string. It is the smallest of:
344 * 1) Length of the input buffer
345 * 2) Max length as specified in the ToString operator
346 * 3) Length of input buffer up to a zero byte (null terminator)
348 * NOTE: A length of zero is ok, and will create a zero-length, null
351 while ((Length < Operand[0]->Buffer.Length) &&
352 (Length < Operand[1]->Integer.Value) &&
353 (Operand[0]->Buffer.Pointer[Length]))
358 /* Allocate a new string object */
360 ReturnDesc = AcpiUtCreateStringObject (Length);
363 Status = AE_NO_MEMORY;
368 * Copy the raw buffer data with no transform.
369 * (NULL terminated already)
371 ACPI_MEMCPY (ReturnDesc->String.Pointer,
372 Operand[0]->Buffer.Pointer, Length);
375 case AML_CONCAT_RES_OP:
377 /* ConcatenateResTemplate (Buffer, Buffer, Result) (ACPI 2.0) */
379 Status = AcpiExConcatTemplate (Operand[0], Operand[1],
380 &ReturnDesc, WalkState);
383 case AML_INDEX_OP: /* Index (Source Index Result) */
385 /* Create the internal return object */
387 ReturnDesc = AcpiUtCreateInternalObject (ACPI_TYPE_LOCAL_REFERENCE);
390 Status = AE_NO_MEMORY;
394 /* Initialize the Index reference object */
396 Index = Operand[1]->Integer.Value;
397 ReturnDesc->Reference.Value = (UINT32) Index;
398 ReturnDesc->Reference.Class = ACPI_REFCLASS_INDEX;
401 * At this point, the Source operand is a String, Buffer, or Package.
402 * Verify that the index is within range.
404 switch ((Operand[0])->Common.Type)
406 case ACPI_TYPE_STRING:
408 if (Index >= Operand[0]->String.Length)
410 Length = Operand[0]->String.Length;
411 Status = AE_AML_STRING_LIMIT;
414 ReturnDesc->Reference.TargetType = ACPI_TYPE_BUFFER_FIELD;
417 case ACPI_TYPE_BUFFER:
419 if (Index >= Operand[0]->Buffer.Length)
421 Length = Operand[0]->Buffer.Length;
422 Status = AE_AML_BUFFER_LIMIT;
425 ReturnDesc->Reference.TargetType = ACPI_TYPE_BUFFER_FIELD;
428 case ACPI_TYPE_PACKAGE:
430 if (Index >= Operand[0]->Package.Count)
432 Length = Operand[0]->Package.Count;
433 Status = AE_AML_PACKAGE_LIMIT;
436 ReturnDesc->Reference.TargetType = ACPI_TYPE_PACKAGE;
437 ReturnDesc->Reference.Where = &Operand[0]->Package.Elements [Index];
442 Status = AE_AML_INTERNAL;
446 /* Failure means that the Index was beyond the end of the object */
448 if (ACPI_FAILURE (Status))
450 ACPI_EXCEPTION ((AE_INFO, Status,
451 "Index (0x%X%8.8X) is beyond end of object (length 0x%X)",
452 ACPI_FORMAT_UINT64 (Index), (UINT32) Length));
457 * Save the target object and add a reference to it for the life
460 ReturnDesc->Reference.Object = Operand[0];
461 AcpiUtAddReference (Operand[0]);
463 /* Store the reference to the Target */
465 Status = AcpiExStore (ReturnDesc, Operand[2], WalkState);
467 /* Return the reference */
469 WalkState->ResultObj = ReturnDesc;
474 ACPI_ERROR ((AE_INFO, "Unknown AML opcode 0x%X",
476 Status = AE_AML_BAD_OPCODE;
483 if (ACPI_SUCCESS (Status))
486 * Store the result of the operation (which is now in ReturnDesc) into
487 * the Target descriptor.
489 Status = AcpiExStore (ReturnDesc, Operand[2], WalkState);
490 if (ACPI_FAILURE (Status))
495 if (!WalkState->ResultObj)
497 WalkState->ResultObj = ReturnDesc;
504 /* Delete return object on error */
506 if (ACPI_FAILURE (Status))
508 AcpiUtRemoveReference (ReturnDesc);
509 WalkState->ResultObj = NULL;
512 return_ACPI_STATUS (Status);
516 /*******************************************************************************
518 * FUNCTION: AcpiExOpcode_2A_0T_1R
520 * PARAMETERS: WalkState - Current walk state
524 * DESCRIPTION: Execute opcode with 2 arguments, no target, and a return value
526 ******************************************************************************/
529 AcpiExOpcode_2A_0T_1R (
530 ACPI_WALK_STATE *WalkState)
532 ACPI_OPERAND_OBJECT **Operand = &WalkState->Operands[0];
533 ACPI_OPERAND_OBJECT *ReturnDesc = NULL;
534 ACPI_STATUS Status = AE_OK;
535 BOOLEAN LogicalResult = FALSE;
538 ACPI_FUNCTION_TRACE_STR (ExOpcode_2A_0T_1R,
539 AcpiPsGetOpcodeName (WalkState->Opcode));
542 /* Create the internal return object */
544 ReturnDesc = AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER);
547 Status = AE_NO_MEMORY;
551 /* Execute the Opcode */
553 if (WalkState->OpInfo->Flags & AML_LOGICAL_NUMERIC)
555 /* LogicalOp (Operand0, Operand1) */
557 Status = AcpiExDoLogicalNumericOp (WalkState->Opcode,
558 Operand[0]->Integer.Value, Operand[1]->Integer.Value,
560 goto StoreLogicalResult;
562 else if (WalkState->OpInfo->Flags & AML_LOGICAL)
564 /* LogicalOp (Operand0, Operand1) */
566 Status = AcpiExDoLogicalOp (WalkState->Opcode, Operand[0],
567 Operand[1], &LogicalResult);
568 goto StoreLogicalResult;
571 switch (WalkState->Opcode)
573 case AML_ACQUIRE_OP: /* Acquire (MutexObject, Timeout) */
575 Status = AcpiExAcquireMutex (Operand[1], Operand[0], WalkState);
576 if (Status == AE_TIME)
578 LogicalResult = TRUE; /* TRUE = Acquire timed out */
584 case AML_WAIT_OP: /* Wait (EventObject, Timeout) */
586 Status = AcpiExSystemWaitEvent (Operand[1], Operand[0]);
587 if (Status == AE_TIME)
589 LogicalResult = TRUE; /* TRUE, Wait timed out */
596 ACPI_ERROR ((AE_INFO, "Unknown AML opcode 0x%X",
598 Status = AE_AML_BAD_OPCODE;
605 * Set return value to according to LogicalResult. logical TRUE (all ones)
606 * Default is FALSE (zero)
610 ReturnDesc->Integer.Value = ACPI_UINT64_MAX;
615 /* Delete return object on error */
617 if (ACPI_FAILURE (Status))
619 AcpiUtRemoveReference (ReturnDesc);
622 /* Save return object on success */
626 WalkState->ResultObj = ReturnDesc;
629 return_ACPI_STATUS (Status);