1 /******************************************************************************
3 * Module Name: exoparg2 - AML execution - opcodes with 2 arguments
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp.
13 * All rights reserved.
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
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
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;
38 * The above copyright and patent license is granted only if the following
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.
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
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
73 * 3.4. Intel retains all right, title, and interest in and to the Original
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.
81 * 4. Disclaimer and Export Compliance
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 * 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 *****************************************************************************/
116 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/exoparg2.c,v 1.1 2003/09/24 03:32:16 drhodus Exp $ */
119 #define __EXOPARG2_C__
122 #include "acparser.h"
123 #include "acinterp.h"
124 #include "acevents.h"
128 #define _COMPONENT ACPI_EXECUTER
129 ACPI_MODULE_NAME ("exoparg2")
133 * Naming convention for AML interpreter execution routines.
135 * The routines that begin execution of AML opcodes are named with a common
136 * convention based upon the number of arguments, the number of target operands,
137 * and whether or not a value is returned:
139 * AcpiExOpcode_xA_yT_zR
143 * xA - ARGUMENTS: The number of arguments (input operands) that are
144 * required for this opcode type (1 through 6 args).
145 * yT - TARGETS: The number of targets (output operands) that are required
146 * for this opcode type (0, 1, or 2 targets).
147 * zR - RETURN VALUE: Indicates whether this opcode type returns a value
148 * as the function return (0 or 1).
150 * The AcpiExOpcode* functions are called via the Dispatcher component with
151 * fully resolved operands.
155 /*******************************************************************************
157 * FUNCTION: AcpiExOpcode_2A_0T_0R
159 * PARAMETERS: WalkState - Current walk state
163 * DESCRIPTION: Execute opcode with two arguments, no target, and no return
166 * ALLOCATION: Deletes both operands
168 ******************************************************************************/
171 AcpiExOpcode_2A_0T_0R (
172 ACPI_WALK_STATE *WalkState)
174 ACPI_OPERAND_OBJECT **Operand = &WalkState->Operands[0];
175 ACPI_NAMESPACE_NODE *Node;
176 ACPI_STATUS Status = AE_OK;
179 ACPI_FUNCTION_TRACE_STR ("ExOpcode_2A_0T_0R",
180 AcpiPsGetOpcodeName (WalkState->Opcode));
183 /* Examine the opcode */
185 switch (WalkState->Opcode)
187 case AML_NOTIFY_OP: /* Notify (NotifyObject, NotifyValue) */
189 /* The first operand is a namespace node */
191 Node = (ACPI_NAMESPACE_NODE *) Operand[0];
193 /* Notifies allowed on this object? */
195 if (!AcpiEvIsNotifyObject (Node))
197 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Unexpected notify object type [%s]\n",
198 AcpiUtGetTypeName (Node->Type)));
200 Status = AE_AML_OPERAND_TYPE;
205 * Dispatch the notify to the appropriate handler
206 * NOTE: the request is queued for execution after this method
207 * completes. The notify handlers are NOT invoked synchronously
208 * from this thread -- because handlers may in turn run other
211 Status = AcpiEvQueueNotifyRequest (Node,
212 (UINT32) Operand[1]->Integer.Value);
218 ACPI_REPORT_ERROR (("AcpiExOpcode_2A_0T_0R: Unknown opcode %X\n",
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", AcpiPsGetOpcodeName (WalkState->Opcode));
256 switch (WalkState->Opcode)
258 case AML_DIVIDE_OP: /* Divide (Dividend, Divisor, RemainderResult QuotientResult) */
260 ReturnDesc1 = AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER);
263 Status = AE_NO_MEMORY;
267 ReturnDesc2 = AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER);
270 Status = AE_NO_MEMORY;
274 /* Quotient to ReturnDesc1, remainder to ReturnDesc2 */
276 Status = AcpiUtDivide (&Operand[0]->Integer.Value, &Operand[1]->Integer.Value,
277 &ReturnDesc1->Integer.Value, &ReturnDesc2->Integer.Value);
278 if (ACPI_FAILURE (Status))
287 ACPI_REPORT_ERROR (("AcpiExOpcode_2A_2T_1R: Unknown opcode %X\n",
289 Status = AE_AML_BAD_OPCODE;
294 /* Store the results to the target reference operands */
296 Status = AcpiExStore (ReturnDesc2, Operand[2], WalkState);
297 if (ACPI_FAILURE (Status))
302 Status = AcpiExStore (ReturnDesc1, Operand[3], WalkState);
303 if (ACPI_FAILURE (Status))
308 /* Return the remainder */
310 WalkState->ResultObj = ReturnDesc1;
315 * Since the remainder is not returned indirectly, remove a reference to
316 * it. Only the quotient is returned indirectly.
318 AcpiUtRemoveReference (ReturnDesc2);
320 if (ACPI_FAILURE (Status))
322 /* Delete the return object */
324 AcpiUtRemoveReference (ReturnDesc1);
327 return_ACPI_STATUS (Status);
331 /*******************************************************************************
333 * FUNCTION: AcpiExOpcode_2A_1T_1R
335 * PARAMETERS: WalkState - Current walk state
339 * DESCRIPTION: Execute opcode with two arguments, one target, and a return
342 ******************************************************************************/
345 AcpiExOpcode_2A_1T_1R (
346 ACPI_WALK_STATE *WalkState)
348 ACPI_OPERAND_OBJECT **Operand = &WalkState->Operands[0];
349 ACPI_OPERAND_OBJECT *ReturnDesc = NULL;
350 ACPI_OPERAND_OBJECT *TempDesc = NULL;
352 ACPI_STATUS Status = AE_OK;
356 ACPI_FUNCTION_TRACE_STR ("ExOpcode_2A_1T_1R", AcpiPsGetOpcodeName (WalkState->Opcode));
362 if (WalkState->OpInfo->Flags & AML_MATH)
364 /* All simple math opcodes (add, etc.) */
366 ReturnDesc = AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER);
369 Status = AE_NO_MEMORY;
373 ReturnDesc->Integer.Value = AcpiExDoMathOp (WalkState->Opcode,
374 Operand[0]->Integer.Value,
375 Operand[1]->Integer.Value);
376 goto StoreResultToTarget;
380 switch (WalkState->Opcode)
382 case AML_MOD_OP: /* Mod (Dividend, Divisor, RemainderResult (ACPI 2.0) */
384 ReturnDesc = AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER);
387 Status = AE_NO_MEMORY;
391 /* ReturnDesc will contain the remainder */
393 Status = AcpiUtDivide (&Operand[0]->Integer.Value, &Operand[1]->Integer.Value,
394 NULL, &ReturnDesc->Integer.Value);
398 case AML_CONCAT_OP: /* Concatenate (Data1, Data2, Result) */
401 * Convert the second operand if necessary. The first operand
402 * determines the type of the second operand, (See the Data Types
403 * section of the ACPI specification.) Both object types are
404 * guaranteed to be either Integer/String/Buffer by the operand
405 * resolution mechanism above.
407 switch (ACPI_GET_OBJECT_TYPE (Operand[0]))
409 case ACPI_TYPE_INTEGER:
410 Status = AcpiExConvertToInteger (Operand[1], &TempDesc, WalkState);
413 case ACPI_TYPE_STRING:
414 Status = AcpiExConvertToString (Operand[1], &TempDesc, 16, ACPI_UINT32_MAX, WalkState);
417 case ACPI_TYPE_BUFFER:
418 Status = AcpiExConvertToBuffer (Operand[1], &TempDesc, WalkState);
422 Status = AE_AML_INTERNAL;
425 if (ACPI_FAILURE (Status))
431 * Both operands are now known to be the same object type
432 * (Both are Integer, String, or Buffer), and we can now perform the
435 Status = AcpiExDoConcatenate (Operand[0], TempDesc, &ReturnDesc, WalkState);
436 if (TempDesc != Operand[1])
438 AcpiUtRemoveReference (TempDesc);
443 case AML_TO_STRING_OP: /* ToString (Buffer, Length, Result) (ACPI 2.0) */
446 * Input object is guaranteed to be a buffer at this point (it may have
447 * been converted.) Copy the raw buffer data to a new object of type String.
450 /* Get the length of the new string */
453 if (Operand[1]->Integer.Value == 0)
455 /* Handle optional length value */
457 Operand[1]->Integer.Value = ACPI_INTEGER_MAX;
460 while ((Length < Operand[0]->Buffer.Length) &&
461 (Length < Operand[1]->Integer.Value) &&
462 (Operand[0]->Buffer.Pointer[Length]))
467 if (Length > ACPI_MAX_STRING_CONVERSION)
469 Status = AE_AML_STRING_LIMIT;
473 /* Create the internal return object */
475 ReturnDesc = AcpiUtCreateInternalObject (ACPI_TYPE_STRING);
478 Status = AE_NO_MEMORY;
482 /* Allocate a new string buffer (Length + 1 for null terminator) */
484 ReturnDesc->String.Pointer = ACPI_MEM_CALLOCATE (Length + 1);
485 if (!ReturnDesc->String.Pointer)
487 Status = AE_NO_MEMORY;
491 /* Copy the raw buffer data with no transform */
493 ACPI_MEMCPY (ReturnDesc->String.Pointer, Operand[0]->Buffer.Pointer, Length);
495 /* Set the string length */
497 ReturnDesc->String.Length = (UINT32) Length;
501 case AML_CONCAT_RES_OP: /* ConcatenateResTemplate (Buffer, Buffer, Result) (ACPI 2.0) */
503 Status = AcpiExConcatTemplate (Operand[0], Operand[1], &ReturnDesc, WalkState);
507 case AML_INDEX_OP: /* Index (Source Index Result) */
509 /* Create the internal return object */
511 ReturnDesc = AcpiUtCreateInternalObject (ACPI_TYPE_LOCAL_REFERENCE);
514 Status = AE_NO_MEMORY;
518 Index = (UINT32) Operand[1]->Integer.Value;
521 * At this point, the Source operand is either a Package or a Buffer
523 if (ACPI_GET_OBJECT_TYPE (Operand[0]) == ACPI_TYPE_PACKAGE)
525 /* Object to be indexed is a Package */
527 if (Index >= Operand[0]->Package.Count)
529 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Index value (%X) beyond package end (%X)\n",
530 Index, Operand[0]->Package.Count));
531 Status = AE_AML_PACKAGE_LIMIT;
535 ReturnDesc->Reference.TargetType = ACPI_TYPE_PACKAGE;
536 ReturnDesc->Reference.Object = Operand[0]->Package.Elements [Index];
537 ReturnDesc->Reference.Where = &Operand[0]->Package.Elements [Index];
541 /* Object to be indexed is a Buffer */
543 if (Index >= Operand[0]->Buffer.Length)
545 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Index value (%X) beyond end of buffer (%X)\n",
546 Index, Operand[0]->Buffer.Length));
547 Status = AE_AML_BUFFER_LIMIT;
551 ReturnDesc->Reference.TargetType = ACPI_TYPE_BUFFER_FIELD;
552 ReturnDesc->Reference.Object = Operand[0];
555 /* Complete the Index reference object */
557 ReturnDesc->Reference.Opcode = AML_INDEX_OP;
558 ReturnDesc->Reference.Offset = Index;
560 /* Store the reference to the Target */
562 Status = AcpiExStore (ReturnDesc, Operand[2], WalkState);
564 /* Return the reference */
566 WalkState->ResultObj = ReturnDesc;
572 ACPI_REPORT_ERROR (("AcpiExOpcode_2A_1T_1R: Unknown opcode %X\n",
574 Status = AE_AML_BAD_OPCODE;
581 if (ACPI_SUCCESS (Status))
584 * Store the result of the operation (which is now in ReturnDesc) into
585 * the Target descriptor.
587 Status = AcpiExStore (ReturnDesc, Operand[2], WalkState);
588 if (ACPI_FAILURE (Status))
593 if (!WalkState->ResultObj)
595 WalkState->ResultObj = ReturnDesc;
602 /* Delete return object on error */
604 if (ACPI_FAILURE (Status))
606 AcpiUtRemoveReference (ReturnDesc);
609 return_ACPI_STATUS (Status);
613 /*******************************************************************************
615 * FUNCTION: AcpiExOpcode_2A_0T_1R
617 * PARAMETERS: WalkState - Current walk state
621 * DESCRIPTION: Execute opcode with 2 arguments, no target, and a return value
623 ******************************************************************************/
626 AcpiExOpcode_2A_0T_1R (
627 ACPI_WALK_STATE *WalkState)
629 ACPI_OPERAND_OBJECT **Operand = &WalkState->Operands[0];
630 ACPI_OPERAND_OBJECT *ReturnDesc = NULL;
631 ACPI_STATUS Status = AE_OK;
632 BOOLEAN LogicalResult = FALSE;
635 ACPI_FUNCTION_TRACE_STR ("ExOpcode_2A_0T_1R", AcpiPsGetOpcodeName (WalkState->Opcode));
638 /* Create the internal return object */
640 ReturnDesc = AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER);
643 Status = AE_NO_MEMORY;
650 if (WalkState->OpInfo->Flags & AML_LOGICAL) /* LogicalOp (Operand0, Operand1) */
652 LogicalResult = AcpiExDoLogicalOp (WalkState->Opcode,
653 Operand[0]->Integer.Value,
654 Operand[1]->Integer.Value);
655 goto StoreLogicalResult;
659 switch (WalkState->Opcode)
661 case AML_ACQUIRE_OP: /* Acquire (MutexObject, Timeout) */
663 Status = AcpiExAcquireMutex (Operand[1], Operand[0], WalkState);
664 if (Status == AE_TIME)
666 LogicalResult = TRUE; /* TRUE = Acquire timed out */
672 case AML_WAIT_OP: /* Wait (EventObject, Timeout) */
674 Status = AcpiExSystemWaitEvent (Operand[1], Operand[0]);
675 if (Status == AE_TIME)
677 LogicalResult = TRUE; /* TRUE, Wait timed out */
685 ACPI_REPORT_ERROR (("AcpiExOpcode_2A_0T_1R: Unknown opcode %X\n",
687 Status = AE_AML_BAD_OPCODE;
694 * Set return value to according to LogicalResult. logical TRUE (all ones)
695 * Default is FALSE (zero)
699 ReturnDesc->Integer.Value = ACPI_INTEGER_MAX;
702 WalkState->ResultObj = ReturnDesc;
707 /* Delete return object on error */
709 if (ACPI_FAILURE (Status))
711 AcpiUtRemoveReference (ReturnDesc);
714 return_ACPI_STATUS (Status);