1 /******************************************************************************
3 * Module Name: dswexec - Dispatcher method execution callbacks;
4 * dispatch to interpreter.
7 *****************************************************************************/
9 /******************************************************************************
13 * Some or all of this work - Copyright (c) 1999 - 2007, Intel Corp.
14 * All rights reserved.
18 * 2.1. This is your license from Intel Corp. under its intellectual property
19 * rights. You may have additional license terms from the party that provided
20 * you this software, covering your right to use that party's intellectual
23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
24 * copy of the source code appearing in this file ("Covered Code") an
25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
26 * base code distributed originally by Intel ("Original Intel Code") to copy,
27 * make derivatives, distribute, use and display any portion of the Covered
28 * Code in any form, with the right to sublicense such rights; and
30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
31 * license (with the right to sublicense), under only those claims of Intel
32 * patents that are infringed by the Original Intel Code, to make, use, sell,
33 * offer to sell, and import the Covered Code and derivative works thereof
34 * solely to the minimum extent necessary to exercise the above copyright
35 * license, and in no event shall the patent license extend to any additions
36 * to or modifications of the Original Intel Code. No other license or right
37 * is granted directly or by implication, estoppel or otherwise;
39 * The above copyright and patent license is granted only if the following
44 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45 * Redistribution of source code of any substantial portion of the Covered
46 * Code or modification with rights to further distribute source must include
47 * the above Copyright Notice, the above License, this list of Conditions,
48 * and the following Disclaimer and Export Compliance provision. In addition,
49 * Licensee must cause all Covered Code to which Licensee contributes to
50 * contain a file documenting the changes Licensee made to create that Covered
51 * Code and the date of any change. Licensee must include in that file the
52 * documentation of any changes made by any predecessor Licensee. Licensee
53 * must include a prominent statement that the modification is derived,
54 * directly or indirectly, from Original Intel Code.
56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
57 * Redistribution of source code of any substantial portion of the Covered
58 * Code or modification without rights to further distribute source must
59 * include the following Disclaimer and Export Compliance provision in the
60 * documentation and/or other materials provided with distribution. In
61 * addition, Licensee may not authorize further sublicense of source of any
62 * portion of the Covered Code, and must include terms to the effect that the
63 * license from Licensee to its licensee is limited to the intellectual
64 * property embodied in the software Licensee provides to its licensee, and
65 * not to intellectual property embodied in modifications its licensee may
68 * 3.3. Redistribution of Executable. Redistribution in executable form of any
69 * substantial portion of the Covered Code or modification must reproduce the
70 * above Copyright Notice, and the following Disclaimer and Export Compliance
71 * provision in the documentation and/or other materials provided with the
74 * 3.4. Intel retains all right, title, and interest in and to the Original
77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78 * Intel shall be used in advertising or otherwise to promote the sale, use or
79 * other dealings in products derived from or relating to the Covered Code
80 * without prior written authorization from Intel.
82 * 4. Disclaimer and Export Compliance
84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
101 * 4.3. Licensee shall not export, either directly or indirectly, any of this
102 * software or system incorporating such software without first obtaining any
103 * required license or other approval from the U. S. Department of Commerce or
104 * any other agency or department of the United States Government. In the
105 * event Licensee exports any such software from the United States or
106 * re-exports any such software from a foreign destination, Licensee shall
107 * ensure that the distribution and export/re-export of the software is in
108 * compliance with all laws, regulations, orders, or other restrictions of the
109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110 * any of its subsidiaries will export/re-export any technical data, process,
111 * software, or service, directly or indirectly, to any country for which the
112 * United States government or any agency thereof requires an export license,
113 * other governmental approval, or letter of assurance, without first obtaining
114 * such license, approval or letter.
116 *****************************************************************************/
118 #define __DSWEXEC_C__
120 #include <contrib/dev/acpica/acpi.h>
121 #include <contrib/dev/acpica/acparser.h>
122 #include <contrib/dev/acpica/amlcode.h>
123 #include <contrib/dev/acpica/acdispat.h>
124 #include <contrib/dev/acpica/acinterp.h>
125 #include <contrib/dev/acpica/acnamesp.h>
126 #include <contrib/dev/acpica/acdebug.h>
129 #define _COMPONENT ACPI_DISPATCHER
130 ACPI_MODULE_NAME ("dswexec")
133 * Dispatch table for opcode classes
135 static ACPI_EXECUTE_OP AcpiGbl_OpTypeDispatch [] =
137 AcpiExOpcode_0A_0T_1R,
138 AcpiExOpcode_1A_0T_0R,
139 AcpiExOpcode_1A_0T_1R,
140 AcpiExOpcode_1A_1T_0R,
141 AcpiExOpcode_1A_1T_1R,
142 AcpiExOpcode_2A_0T_0R,
143 AcpiExOpcode_2A_0T_1R,
144 AcpiExOpcode_2A_1T_1R,
145 AcpiExOpcode_2A_2T_1R,
146 AcpiExOpcode_3A_0T_0R,
147 AcpiExOpcode_3A_1T_1R,
148 AcpiExOpcode_6A_0T_1R
152 /*****************************************************************************
154 * FUNCTION: AcpiDsGetPredicateValue
156 * PARAMETERS: WalkState - Current state of the parse tree walk
157 * ResultObj - if non-zero, pop result from result stack
161 * DESCRIPTION: Get the result of a predicate evaluation
163 ****************************************************************************/
166 AcpiDsGetPredicateValue (
167 ACPI_WALK_STATE *WalkState,
168 ACPI_OPERAND_OBJECT *ResultObj)
170 ACPI_STATUS Status = AE_OK;
171 ACPI_OPERAND_OBJECT *ObjDesc;
172 ACPI_OPERAND_OBJECT *LocalObjDesc = NULL;
175 ACPI_FUNCTION_TRACE_PTR (DsGetPredicateValue, WalkState);
178 WalkState->ControlState->Common.State = 0;
182 Status = AcpiDsResultPop (&ObjDesc, WalkState);
183 if (ACPI_FAILURE (Status))
185 ACPI_EXCEPTION ((AE_INFO, Status,
186 "Could not get result from predicate evaluation"));
188 return_ACPI_STATUS (Status);
193 Status = AcpiDsCreateOperand (WalkState, WalkState->Op, 0);
194 if (ACPI_FAILURE (Status))
196 return_ACPI_STATUS (Status);
199 Status = AcpiExResolveToValue (&WalkState->Operands [0], WalkState);
200 if (ACPI_FAILURE (Status))
202 return_ACPI_STATUS (Status);
205 ObjDesc = WalkState->Operands [0];
210 ACPI_ERROR ((AE_INFO,
211 "No predicate ObjDesc=%p State=%p",
212 ObjDesc, WalkState));
214 return_ACPI_STATUS (AE_AML_NO_OPERAND);
218 * Result of predicate evaluation must be an Integer
219 * object. Implicitly convert the argument if necessary.
221 Status = AcpiExConvertToInteger (ObjDesc, &LocalObjDesc, 16);
222 if (ACPI_FAILURE (Status))
227 if (ACPI_GET_OBJECT_TYPE (LocalObjDesc) != ACPI_TYPE_INTEGER)
229 ACPI_ERROR ((AE_INFO,
230 "Bad predicate (not an integer) ObjDesc=%p State=%p Type=%X",
231 ObjDesc, WalkState, ACPI_GET_OBJECT_TYPE (ObjDesc)));
233 Status = AE_AML_OPERAND_TYPE;
237 /* Truncate the predicate to 32-bits if necessary */
239 AcpiExTruncateFor32bitTable (LocalObjDesc);
242 * Save the result of the predicate evaluation on
245 if (LocalObjDesc->Integer.Value)
247 WalkState->ControlState->Common.Value = TRUE;
252 * Predicate is FALSE, we will just toss the
253 * rest of the package
255 WalkState->ControlState->Common.Value = FALSE;
256 Status = AE_CTRL_FALSE;
262 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Completed a predicate eval=%X Op=%p\n",
263 WalkState->ControlState->Common.Value, WalkState->Op));
265 /* Break to debugger to display result */
267 ACPI_DEBUGGER_EXEC (AcpiDbDisplayResultObject (LocalObjDesc, WalkState));
270 * Delete the predicate result object (we know that
271 * we don't need it anymore)
273 if (LocalObjDesc != ObjDesc)
275 AcpiUtRemoveReference (LocalObjDesc);
277 AcpiUtRemoveReference (ObjDesc);
279 WalkState->ControlState->Common.State = ACPI_CONTROL_NORMAL;
280 return_ACPI_STATUS (Status);
284 /*****************************************************************************
286 * FUNCTION: AcpiDsExecBeginOp
288 * PARAMETERS: WalkState - Current state of the parse tree walk
289 * OutOp - Where to return op if a new one is created
293 * DESCRIPTION: Descending callback used during the execution of control
294 * methods. This is where most operators and operands are
295 * dispatched to the interpreter.
297 ****************************************************************************/
301 ACPI_WALK_STATE *WalkState,
302 ACPI_PARSE_OBJECT **OutOp)
304 ACPI_PARSE_OBJECT *Op;
305 ACPI_STATUS Status = AE_OK;
309 ACPI_FUNCTION_TRACE_PTR (DsExecBeginOp, WalkState);
315 Status = AcpiDsLoad2BeginOp (WalkState, OutOp);
316 if (ACPI_FAILURE (Status))
323 WalkState->Opcode = Op->Common.AmlOpcode;
324 WalkState->OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
326 if (AcpiNsOpensScope (WalkState->OpInfo->ObjectType))
328 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
329 "(%s) Popping scope for Op %p\n",
330 AcpiUtGetTypeName (WalkState->OpInfo->ObjectType), Op));
332 Status = AcpiDsScopeStackPop (WalkState);
333 if (ACPI_FAILURE (Status))
340 if (Op == WalkState->Origin)
347 return_ACPI_STATUS (AE_OK);
351 * If the previous opcode was a conditional, this opcode
352 * must be the beginning of the associated predicate.
353 * Save this knowledge in the current scope descriptor
355 if ((WalkState->ControlState) &&
356 (WalkState->ControlState->Common.State ==
357 ACPI_CONTROL_CONDITIONAL_EXECUTING))
359 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Exec predicate Op=%p State=%p\n",
362 WalkState->ControlState->Common.State = ACPI_CONTROL_PREDICATE_EXECUTING;
364 /* Save start of predicate */
366 WalkState->ControlState->Control.PredicateOp = Op;
370 OpcodeClass = WalkState->OpInfo->Class;
372 /* We want to send namepaths to the load code */
374 if (Op->Common.AmlOpcode == AML_INT_NAMEPATH_OP)
376 OpcodeClass = AML_CLASS_NAMED_OBJECT;
380 * Handle the opcode based upon the opcode type
384 case AML_CLASS_CONTROL:
386 Status = AcpiDsExecBeginControlOp (WalkState, Op);
390 case AML_CLASS_NAMED_OBJECT:
392 if (WalkState->WalkType & ACPI_WALK_METHOD)
395 * Found a named object declaration during method execution;
396 * we must enter this object into the namespace. The created
397 * object is temporary and will be deleted upon completion of
398 * the execution of this method.
400 Status = AcpiDsLoad2BeginOp (WalkState, NULL);
406 case AML_CLASS_EXECUTE:
407 case AML_CLASS_CREATE:
416 /* Nothing to do here during method execution */
418 return_ACPI_STATUS (Status);
422 Status = AcpiDsMethodError (Status, WalkState);
423 return_ACPI_STATUS (Status);
427 /*****************************************************************************
429 * FUNCTION: AcpiDsExecEndOp
431 * PARAMETERS: WalkState - Current state of the parse tree walk
435 * DESCRIPTION: Ascending callback used during the execution of control
436 * methods. The only thing we really need to do here is to
437 * notice the beginning of IF, ELSE, and WHILE blocks.
439 ****************************************************************************/
443 ACPI_WALK_STATE *WalkState)
445 ACPI_PARSE_OBJECT *Op;
446 ACPI_STATUS Status = AE_OK;
449 ACPI_PARSE_OBJECT *NextOp;
450 ACPI_PARSE_OBJECT *FirstArg;
453 ACPI_FUNCTION_TRACE_PTR (DsExecEndOp, WalkState);
457 OpType = WalkState->OpInfo->Type;
458 OpClass = WalkState->OpInfo->Class;
460 if (OpClass == AML_CLASS_UNKNOWN)
462 ACPI_ERROR ((AE_INFO, "Unknown opcode %X", Op->Common.AmlOpcode));
463 return_ACPI_STATUS (AE_NOT_IMPLEMENTED);
466 FirstArg = Op->Common.Value.Arg;
468 /* Init the walk state */
470 WalkState->NumOperands = 0;
471 WalkState->OperandIndex = 0;
472 WalkState->ReturnDesc = NULL;
473 WalkState->ResultObj = NULL;
475 /* Call debugger for single step support (DEBUG build only) */
477 ACPI_DEBUGGER_EXEC (Status = AcpiDbSingleStep (WalkState, Op, OpClass));
478 ACPI_DEBUGGER_EXEC (if (ACPI_FAILURE (Status)) {return_ACPI_STATUS (Status);});
480 /* Decode the Opcode Class */
484 case AML_CLASS_ARGUMENT: /* Constants, literals, etc. */
486 if (WalkState->Opcode == AML_INT_NAMEPATH_OP)
488 Status = AcpiDsEvaluateNamePath (WalkState);
489 if (ACPI_FAILURE (Status))
497 case AML_CLASS_EXECUTE: /* Most operators with arguments */
499 /* Build resolved operand stack */
501 Status = AcpiDsCreateOperands (WalkState, FirstArg);
502 if (ACPI_FAILURE (Status))
508 * All opcodes require operand resolution, with the only exceptions
509 * being the ObjectType and SizeOf operators.
511 if (!(WalkState->OpInfo->Flags & AML_NO_OPERAND_RESOLVE))
513 /* Resolve all operands */
515 Status = AcpiExResolveOperands (WalkState->Opcode,
516 &(WalkState->Operands [WalkState->NumOperands -1]),
518 if (ACPI_SUCCESS (Status))
520 ACPI_DUMP_OPERANDS (ACPI_WALK_OPERANDS, ACPI_IMODE_EXECUTE,
521 AcpiPsGetOpcodeName (WalkState->Opcode),
522 WalkState->NumOperands, "after ExResolveOperands");
526 if (ACPI_SUCCESS (Status))
529 * Dispatch the request to the appropriate interpreter handler
530 * routine. There is one routine per opcode "type" based upon the
531 * number of opcode arguments and return type.
533 Status = AcpiGbl_OpTypeDispatch[OpType] (WalkState);
538 * Treat constructs of the form "Store(LocalX,LocalX)" as noops when the
539 * Local is uninitialized.
541 if ((Status == AE_AML_UNINITIALIZED_LOCAL) &&
542 (WalkState->Opcode == AML_STORE_OP) &&
543 (WalkState->Operands[0]->Common.Type == ACPI_TYPE_LOCAL_REFERENCE) &&
544 (WalkState->Operands[1]->Common.Type == ACPI_TYPE_LOCAL_REFERENCE) &&
545 (WalkState->Operands[0]->Reference.Opcode ==
546 WalkState->Operands[1]->Reference.Opcode) &&
547 (WalkState->Operands[0]->Reference.Offset ==
548 WalkState->Operands[1]->Reference.Offset))
554 ACPI_EXCEPTION ((AE_INFO, Status,
555 "While resolving operands for [%s]",
556 AcpiPsGetOpcodeName (WalkState->Opcode)));
560 /* Always delete the argument objects and clear the operand stack */
562 AcpiDsClearOperands (WalkState);
565 * If a result object was returned from above, push it on the
566 * current result stack
568 if (ACPI_SUCCESS (Status) &&
569 WalkState->ResultObj)
571 Status = AcpiDsResultPush (WalkState->ResultObj, WalkState);
580 case AML_TYPE_CONTROL: /* Type 1 opcode, IF/ELSE/WHILE/NOOP */
582 /* 1 Operand, 0 ExternalResult, 0 InternalResult */
584 Status = AcpiDsExecEndControlOp (WalkState, Op);
589 case AML_TYPE_METHOD_CALL:
592 * If the method is referenced from within a package
593 * declaration, it is not a invocation of the method, just
596 if ((Op->Asl.Parent) &&
597 ((Op->Asl.Parent->Asl.AmlOpcode == AML_PACKAGE_OP) ||
598 (Op->Asl.Parent->Asl.AmlOpcode == AML_VAR_PACKAGE_OP)))
600 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
601 "Method Reference in a Package, Op=%p\n", Op));
603 Op->Common.Node = (ACPI_NAMESPACE_NODE *) Op->Asl.Value.Arg->Asl.Node->Object;
604 AcpiUtAddReference (Op->Asl.Value.Arg->Asl.Node->Object);
605 return_ACPI_STATUS (AE_OK);
608 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH, "Method invocation, Op=%p\n", Op));
611 * (AML_METHODCALL) Op->Asl.Value.Arg->Asl.Node contains
612 * the method Node pointer
614 /* NextOp points to the op that holds the method name */
618 /* NextOp points to first argument op */
620 NextOp = NextOp->Common.Next;
623 * Get the method's arguments and put them on the operand stack
625 Status = AcpiDsCreateOperands (WalkState, NextOp);
626 if (ACPI_FAILURE (Status))
632 * Since the operands will be passed to another control method,
633 * we must resolve all local references here (Local variables,
634 * arguments to *this* method, etc.)
636 Status = AcpiDsResolveOperands (WalkState);
637 if (ACPI_FAILURE (Status))
639 /* On error, clear all resolved operands */
641 AcpiDsClearOperands (WalkState);
646 * Tell the walk loop to preempt this running method and
647 * execute the new method
649 Status = AE_CTRL_TRANSFER;
652 * Return now; we don't want to disturb anything,
653 * especially the operand count!
655 return_ACPI_STATUS (Status);
658 case AML_TYPE_CREATE_FIELD:
660 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
661 "Executing CreateField Buffer/Index Op=%p\n", Op));
663 Status = AcpiDsLoad2EndOp (WalkState);
664 if (ACPI_FAILURE (Status))
669 Status = AcpiDsEvalBufferFieldOperands (WalkState, Op);
673 case AML_TYPE_CREATE_OBJECT:
675 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
676 "Executing CreateObject (Buffer/Package) Op=%p\n", Op));
678 switch (Op->Common.Parent->Common.AmlOpcode)
683 * Put the Node on the object stack (Contains the ACPI Name
686 WalkState->Operands[0] = (void *) Op->Common.Parent->Common.Node;
687 WalkState->NumOperands = 1;
689 Status = AcpiDsCreateNode (WalkState,
690 Op->Common.Parent->Common.Node,
692 if (ACPI_FAILURE (Status))
698 /*lint -fallthrough */
700 case AML_INT_EVAL_SUBTREE_OP:
702 Status = AcpiDsEvalDataObjectOperands (WalkState, Op,
703 AcpiNsGetAttachedObject (Op->Common.Parent->Common.Node));
708 Status = AcpiDsEvalDataObjectOperands (WalkState, Op, NULL);
713 * If a result object was returned from above, push it on the
714 * current result stack
716 if (WalkState->ResultObj)
718 Status = AcpiDsResultPush (WalkState->ResultObj, WalkState);
723 case AML_TYPE_NAMED_FIELD:
724 case AML_TYPE_NAMED_COMPLEX:
725 case AML_TYPE_NAMED_SIMPLE:
726 case AML_TYPE_NAMED_NO_OBJ:
728 Status = AcpiDsLoad2EndOp (WalkState);
729 if (ACPI_FAILURE (Status))
734 if (Op->Common.AmlOpcode == AML_REGION_OP)
736 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
737 "Executing OpRegion Address/Length Op=%p\n", Op));
739 Status = AcpiDsEvalRegionOperands (WalkState, Op);
740 if (ACPI_FAILURE (Status))
748 case AML_TYPE_UNDEFINED:
750 ACPI_ERROR ((AE_INFO,
751 "Undefined opcode type Op=%p", Op));
752 return_ACPI_STATUS (AE_NOT_IMPLEMENTED);
757 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
758 "Internal opcode=%X type Op=%p\n",
759 WalkState->Opcode, Op));
765 ACPI_ERROR ((AE_INFO,
766 "Unimplemented opcode, class=%X type=%X Opcode=%X Op=%p",
767 OpClass, OpType, Op->Common.AmlOpcode, Op));
769 Status = AE_NOT_IMPLEMENTED;
775 * ACPI 2.0 support for 64-bit integers: Truncate numeric
776 * result value if we are executing from a 32-bit ACPI table
778 AcpiExTruncateFor32bitTable (WalkState->ResultObj);
781 * Check if we just completed the evaluation of a
782 * conditional predicate
784 if ((ACPI_SUCCESS (Status)) &&
785 (WalkState->ControlState) &&
786 (WalkState->ControlState->Common.State ==
787 ACPI_CONTROL_PREDICATE_EXECUTING) &&
788 (WalkState->ControlState->Control.PredicateOp == Op))
790 Status = AcpiDsGetPredicateValue (WalkState, WalkState->ResultObj);
791 WalkState->ResultObj = NULL;
797 if (WalkState->ResultObj)
799 /* Break to debugger to display result */
801 ACPI_DEBUGGER_EXEC (AcpiDbDisplayResultObject (WalkState->ResultObj,
805 * Delete the result op if and only if:
806 * Parent will not use the result -- such as any
807 * non-nested type2 op in a method (parent will be method)
809 AcpiDsDeleteResultIfNotUsed (Op, WalkState->ResultObj, WalkState);
812 #ifdef _UNDER_DEVELOPMENT
814 if (WalkState->ParserState.Aml == WalkState->ParserState.AmlEnd)
816 AcpiDbMethodEnd (WalkState);
820 /* Invoke exception handler on error */
822 if (ACPI_FAILURE (Status))
824 Status = AcpiDsMethodError (Status, WalkState);
827 /* Always clear the object stack */
829 WalkState->NumOperands = 0;
830 return_ACPI_STATUS (Status);