1 /******************************************************************************
3 * Module Name: dswexec - Dispatcher method execution callbacks;
4 * dispatch to interpreter.
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2013, Intel Corp.
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions, and the following disclaimer,
17 * without modification.
18 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
19 * substantially similar to the "NO WARRANTY" disclaimer below
20 * ("Disclaimer") and any redistribution must be conditioned upon
21 * including a substantially similar Disclaimer requirement for further
22 * binary redistribution.
23 * 3. Neither the names of the above-listed copyright holders nor the names
24 * of any contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
27 * Alternatively, this software may be distributed under the terms of the
28 * GNU General Public License ("GPL") version 2 as published by the Free
29 * Software Foundation.
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
35 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42 * POSSIBILITY OF SUCH DAMAGES.
47 #include <contrib/dev/acpica/include/acpi.h>
48 #include <contrib/dev/acpica/include/accommon.h>
49 #include <contrib/dev/acpica/include/acparser.h>
50 #include <contrib/dev/acpica/include/amlcode.h>
51 #include <contrib/dev/acpica/include/acdispat.h>
52 #include <contrib/dev/acpica/include/acinterp.h>
53 #include <contrib/dev/acpica/include/acnamesp.h>
54 #include <contrib/dev/acpica/include/acdebug.h>
57 #define _COMPONENT ACPI_DISPATCHER
58 ACPI_MODULE_NAME ("dswexec")
61 * Dispatch table for opcode classes
63 static ACPI_EXECUTE_OP AcpiGbl_OpTypeDispatch [] =
65 AcpiExOpcode_0A_0T_1R,
66 AcpiExOpcode_1A_0T_0R,
67 AcpiExOpcode_1A_0T_1R,
68 AcpiExOpcode_1A_1T_0R,
69 AcpiExOpcode_1A_1T_1R,
70 AcpiExOpcode_2A_0T_0R,
71 AcpiExOpcode_2A_0T_1R,
72 AcpiExOpcode_2A_1T_1R,
73 AcpiExOpcode_2A_2T_1R,
74 AcpiExOpcode_3A_0T_0R,
75 AcpiExOpcode_3A_1T_1R,
80 /*****************************************************************************
82 * FUNCTION: AcpiDsGetPredicateValue
84 * PARAMETERS: WalkState - Current state of the parse tree walk
85 * ResultObj - if non-zero, pop result from result stack
89 * DESCRIPTION: Get the result of a predicate evaluation
91 ****************************************************************************/
94 AcpiDsGetPredicateValue (
95 ACPI_WALK_STATE *WalkState,
96 ACPI_OPERAND_OBJECT *ResultObj)
98 ACPI_STATUS Status = AE_OK;
99 ACPI_OPERAND_OBJECT *ObjDesc;
100 ACPI_OPERAND_OBJECT *LocalObjDesc = NULL;
103 ACPI_FUNCTION_TRACE_PTR (DsGetPredicateValue, WalkState);
106 WalkState->ControlState->Common.State = 0;
110 Status = AcpiDsResultPop (&ObjDesc, WalkState);
111 if (ACPI_FAILURE (Status))
113 ACPI_EXCEPTION ((AE_INFO, Status,
114 "Could not get result from predicate evaluation"));
116 return_ACPI_STATUS (Status);
121 Status = AcpiDsCreateOperand (WalkState, WalkState->Op, 0);
122 if (ACPI_FAILURE (Status))
124 return_ACPI_STATUS (Status);
127 Status = AcpiExResolveToValue (&WalkState->Operands [0], WalkState);
128 if (ACPI_FAILURE (Status))
130 return_ACPI_STATUS (Status);
133 ObjDesc = WalkState->Operands [0];
138 ACPI_ERROR ((AE_INFO,
139 "No predicate ObjDesc=%p State=%p",
140 ObjDesc, WalkState));
142 return_ACPI_STATUS (AE_AML_NO_OPERAND);
146 * Result of predicate evaluation must be an Integer
147 * object. Implicitly convert the argument if necessary.
149 Status = AcpiExConvertToInteger (ObjDesc, &LocalObjDesc, 16);
150 if (ACPI_FAILURE (Status))
155 if (LocalObjDesc->Common.Type != ACPI_TYPE_INTEGER)
157 ACPI_ERROR ((AE_INFO,
158 "Bad predicate (not an integer) ObjDesc=%p State=%p Type=0x%X",
159 ObjDesc, WalkState, ObjDesc->Common.Type));
161 Status = AE_AML_OPERAND_TYPE;
165 /* Truncate the predicate to 32-bits if necessary */
167 (void) AcpiExTruncateFor32bitTable (LocalObjDesc);
170 * Save the result of the predicate evaluation on
173 if (LocalObjDesc->Integer.Value)
175 WalkState->ControlState->Common.Value = TRUE;
180 * Predicate is FALSE, we will just toss the
181 * rest of the package
183 WalkState->ControlState->Common.Value = FALSE;
184 Status = AE_CTRL_FALSE;
187 /* Predicate can be used for an implicit return value */
189 (void) AcpiDsDoImplicitReturn (LocalObjDesc, WalkState, TRUE);
194 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Completed a predicate eval=%X Op=%p\n",
195 WalkState->ControlState->Common.Value, WalkState->Op));
197 /* Break to debugger to display result */
199 ACPI_DEBUGGER_EXEC (AcpiDbDisplayResultObject (LocalObjDesc, WalkState));
202 * Delete the predicate result object (we know that
203 * we don't need it anymore)
205 if (LocalObjDesc != ObjDesc)
207 AcpiUtRemoveReference (LocalObjDesc);
209 AcpiUtRemoveReference (ObjDesc);
211 WalkState->ControlState->Common.State = ACPI_CONTROL_NORMAL;
212 return_ACPI_STATUS (Status);
216 /*****************************************************************************
218 * FUNCTION: AcpiDsExecBeginOp
220 * PARAMETERS: WalkState - Current state of the parse tree walk
221 * OutOp - Where to return op if a new one is created
225 * DESCRIPTION: Descending callback used during the execution of control
226 * methods. This is where most operators and operands are
227 * dispatched to the interpreter.
229 ****************************************************************************/
233 ACPI_WALK_STATE *WalkState,
234 ACPI_PARSE_OBJECT **OutOp)
236 ACPI_PARSE_OBJECT *Op;
237 ACPI_STATUS Status = AE_OK;
241 ACPI_FUNCTION_TRACE_PTR (DsExecBeginOp, WalkState);
247 Status = AcpiDsLoad2BeginOp (WalkState, OutOp);
248 if (ACPI_FAILURE (Status))
255 WalkState->Opcode = Op->Common.AmlOpcode;
256 WalkState->OpInfo = AcpiPsGetOpcodeInfo (Op->Common.AmlOpcode);
258 if (AcpiNsOpensScope (WalkState->OpInfo->ObjectType))
260 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
261 "(%s) Popping scope for Op %p\n",
262 AcpiUtGetTypeName (WalkState->OpInfo->ObjectType), Op));
264 Status = AcpiDsScopeStackPop (WalkState);
265 if (ACPI_FAILURE (Status))
272 if (Op == WalkState->Origin)
279 return_ACPI_STATUS (AE_OK);
283 * If the previous opcode was a conditional, this opcode
284 * must be the beginning of the associated predicate.
285 * Save this knowledge in the current scope descriptor
287 if ((WalkState->ControlState) &&
288 (WalkState->ControlState->Common.State ==
289 ACPI_CONTROL_CONDITIONAL_EXECUTING))
291 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Exec predicate Op=%p State=%p\n",
294 WalkState->ControlState->Common.State = ACPI_CONTROL_PREDICATE_EXECUTING;
296 /* Save start of predicate */
298 WalkState->ControlState->Control.PredicateOp = Op;
302 OpcodeClass = WalkState->OpInfo->Class;
304 /* We want to send namepaths to the load code */
306 if (Op->Common.AmlOpcode == AML_INT_NAMEPATH_OP)
308 OpcodeClass = AML_CLASS_NAMED_OBJECT;
312 * Handle the opcode based upon the opcode type
316 case AML_CLASS_CONTROL:
318 Status = AcpiDsExecBeginControlOp (WalkState, Op);
321 case AML_CLASS_NAMED_OBJECT:
323 if (WalkState->WalkType & ACPI_WALK_METHOD)
326 * Found a named object declaration during method execution;
327 * we must enter this object into the namespace. The created
328 * object is temporary and will be deleted upon completion of
329 * the execution of this method.
331 * Note 10/2010: Except for the Scope() op. This opcode does
332 * not actually create a new object, it refers to an existing
333 * object. However, for Scope(), we want to indeed open a
336 if (Op->Common.AmlOpcode != AML_SCOPE_OP)
338 Status = AcpiDsLoad2BeginOp (WalkState, NULL);
342 Status = AcpiDsScopeStackPush (Op->Named.Node,
343 Op->Named.Node->Type, WalkState);
344 if (ACPI_FAILURE (Status))
346 return_ACPI_STATUS (Status);
352 case AML_CLASS_EXECUTE:
353 case AML_CLASS_CREATE:
362 /* Nothing to do here during method execution */
364 return_ACPI_STATUS (Status);
368 Status = AcpiDsMethodError (Status, WalkState);
369 return_ACPI_STATUS (Status);
373 /*****************************************************************************
375 * FUNCTION: AcpiDsExecEndOp
377 * PARAMETERS: WalkState - Current state of the parse tree walk
381 * DESCRIPTION: Ascending callback used during the execution of control
382 * methods. The only thing we really need to do here is to
383 * notice the beginning of IF, ELSE, and WHILE blocks.
385 ****************************************************************************/
389 ACPI_WALK_STATE *WalkState)
391 ACPI_PARSE_OBJECT *Op;
392 ACPI_STATUS Status = AE_OK;
395 ACPI_PARSE_OBJECT *NextOp;
396 ACPI_PARSE_OBJECT *FirstArg;
399 ACPI_FUNCTION_TRACE_PTR (DsExecEndOp, WalkState);
403 OpType = WalkState->OpInfo->Type;
404 OpClass = WalkState->OpInfo->Class;
406 if (OpClass == AML_CLASS_UNKNOWN)
408 ACPI_ERROR ((AE_INFO, "Unknown opcode 0x%X", Op->Common.AmlOpcode));
409 return_ACPI_STATUS (AE_NOT_IMPLEMENTED);
412 FirstArg = Op->Common.Value.Arg;
414 /* Init the walk state */
416 WalkState->NumOperands = 0;
417 WalkState->OperandIndex = 0;
418 WalkState->ReturnDesc = NULL;
419 WalkState->ResultObj = NULL;
421 /* Call debugger for single step support (DEBUG build only) */
423 ACPI_DEBUGGER_EXEC (Status = AcpiDbSingleStep (WalkState, Op, OpClass));
424 ACPI_DEBUGGER_EXEC (if (ACPI_FAILURE (Status)) {return_ACPI_STATUS (Status);});
426 /* Decode the Opcode Class */
430 case AML_CLASS_ARGUMENT: /* Constants, literals, etc. */
432 if (WalkState->Opcode == AML_INT_NAMEPATH_OP)
434 Status = AcpiDsEvaluateNamePath (WalkState);
435 if (ACPI_FAILURE (Status))
442 case AML_CLASS_EXECUTE: /* Most operators with arguments */
444 /* Build resolved operand stack */
446 Status = AcpiDsCreateOperands (WalkState, FirstArg);
447 if (ACPI_FAILURE (Status))
453 * All opcodes require operand resolution, with the only exceptions
454 * being the ObjectType and SizeOf operators.
456 if (!(WalkState->OpInfo->Flags & AML_NO_OPERAND_RESOLVE))
458 /* Resolve all operands */
460 Status = AcpiExResolveOperands (WalkState->Opcode,
461 &(WalkState->Operands [WalkState->NumOperands -1]),
465 if (ACPI_SUCCESS (Status))
468 * Dispatch the request to the appropriate interpreter handler
469 * routine. There is one routine per opcode "type" based upon the
470 * number of opcode arguments and return type.
472 Status = AcpiGbl_OpTypeDispatch[OpType] (WalkState);
477 * Treat constructs of the form "Store(LocalX,LocalX)" as noops when the
478 * Local is uninitialized.
480 if ((Status == AE_AML_UNINITIALIZED_LOCAL) &&
481 (WalkState->Opcode == AML_STORE_OP) &&
482 (WalkState->Operands[0]->Common.Type == ACPI_TYPE_LOCAL_REFERENCE) &&
483 (WalkState->Operands[1]->Common.Type == ACPI_TYPE_LOCAL_REFERENCE) &&
484 (WalkState->Operands[0]->Reference.Class ==
485 WalkState->Operands[1]->Reference.Class) &&
486 (WalkState->Operands[0]->Reference.Value ==
487 WalkState->Operands[1]->Reference.Value))
493 ACPI_EXCEPTION ((AE_INFO, Status,
494 "While resolving operands for [%s]",
495 AcpiPsGetOpcodeName (WalkState->Opcode)));
499 /* Always delete the argument objects and clear the operand stack */
501 AcpiDsClearOperands (WalkState);
504 * If a result object was returned from above, push it on the
505 * current result stack
507 if (ACPI_SUCCESS (Status) &&
508 WalkState->ResultObj)
510 Status = AcpiDsResultPush (WalkState->ResultObj, WalkState);
518 case AML_TYPE_CONTROL: /* Type 1 opcode, IF/ELSE/WHILE/NOOP */
520 /* 1 Operand, 0 ExternalResult, 0 InternalResult */
522 Status = AcpiDsExecEndControlOp (WalkState, Op);
526 case AML_TYPE_METHOD_CALL:
528 * If the method is referenced from within a package
529 * declaration, it is not a invocation of the method, just
532 if ((Op->Asl.Parent) &&
533 ((Op->Asl.Parent->Asl.AmlOpcode == AML_PACKAGE_OP) ||
534 (Op->Asl.Parent->Asl.AmlOpcode == AML_VAR_PACKAGE_OP)))
536 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
537 "Method Reference in a Package, Op=%p\n", Op));
539 Op->Common.Node = (ACPI_NAMESPACE_NODE *) Op->Asl.Value.Arg->Asl.Node;
540 AcpiUtAddReference (Op->Asl.Value.Arg->Asl.Node->Object);
541 return_ACPI_STATUS (AE_OK);
544 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH, "Method invocation, Op=%p\n", Op));
547 * (AML_METHODCALL) Op->Asl.Value.Arg->Asl.Node contains
548 * the method Node pointer
550 /* NextOp points to the op that holds the method name */
554 /* NextOp points to first argument op */
556 NextOp = NextOp->Common.Next;
559 * Get the method's arguments and put them on the operand stack
561 Status = AcpiDsCreateOperands (WalkState, NextOp);
562 if (ACPI_FAILURE (Status))
568 * Since the operands will be passed to another control method,
569 * we must resolve all local references here (Local variables,
570 * arguments to *this* method, etc.)
572 Status = AcpiDsResolveOperands (WalkState);
573 if (ACPI_FAILURE (Status))
575 /* On error, clear all resolved operands */
577 AcpiDsClearOperands (WalkState);
582 * Tell the walk loop to preempt this running method and
583 * execute the new method
585 Status = AE_CTRL_TRANSFER;
588 * Return now; we don't want to disturb anything,
589 * especially the operand count!
591 return_ACPI_STATUS (Status);
593 case AML_TYPE_CREATE_FIELD:
595 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
596 "Executing CreateField Buffer/Index Op=%p\n", Op));
598 Status = AcpiDsLoad2EndOp (WalkState);
599 if (ACPI_FAILURE (Status))
604 Status = AcpiDsEvalBufferFieldOperands (WalkState, Op);
608 case AML_TYPE_CREATE_OBJECT:
610 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
611 "Executing CreateObject (Buffer/Package) Op=%p\n", Op));
613 switch (Op->Common.Parent->Common.AmlOpcode)
617 * Put the Node on the object stack (Contains the ACPI Name
620 WalkState->Operands[0] = (void *) Op->Common.Parent->Common.Node;
621 WalkState->NumOperands = 1;
623 Status = AcpiDsCreateNode (WalkState,
624 Op->Common.Parent->Common.Node,
626 if (ACPI_FAILURE (Status))
632 /*lint -fallthrough */
634 case AML_INT_EVAL_SUBTREE_OP:
636 Status = AcpiDsEvalDataObjectOperands (WalkState, Op,
637 AcpiNsGetAttachedObject (Op->Common.Parent->Common.Node));
642 Status = AcpiDsEvalDataObjectOperands (WalkState, Op, NULL);
647 * If a result object was returned from above, push it on the
648 * current result stack
650 if (WalkState->ResultObj)
652 Status = AcpiDsResultPush (WalkState->ResultObj, WalkState);
656 case AML_TYPE_NAMED_FIELD:
657 case AML_TYPE_NAMED_COMPLEX:
658 case AML_TYPE_NAMED_SIMPLE:
659 case AML_TYPE_NAMED_NO_OBJ:
661 Status = AcpiDsLoad2EndOp (WalkState);
662 if (ACPI_FAILURE (Status))
667 if (Op->Common.AmlOpcode == AML_REGION_OP)
669 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
670 "Executing OpRegion Address/Length Op=%p\n", Op));
672 Status = AcpiDsEvalRegionOperands (WalkState, Op);
673 if (ACPI_FAILURE (Status))
678 else if (Op->Common.AmlOpcode == AML_DATA_REGION_OP)
680 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
681 "Executing DataTableRegion Strings Op=%p\n", Op));
683 Status = AcpiDsEvalTableRegionOperands (WalkState, Op);
684 if (ACPI_FAILURE (Status))
689 else if (Op->Common.AmlOpcode == AML_BANK_FIELD_OP)
691 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
692 "Executing BankField Op=%p\n", Op));
694 Status = AcpiDsEvalBankFieldOperands (WalkState, Op);
695 if (ACPI_FAILURE (Status))
702 case AML_TYPE_UNDEFINED:
704 ACPI_ERROR ((AE_INFO,
705 "Undefined opcode type Op=%p", Op));
706 return_ACPI_STATUS (AE_NOT_IMPLEMENTED);
710 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
711 "Internal opcode=%X type Op=%p\n",
712 WalkState->Opcode, Op));
717 ACPI_ERROR ((AE_INFO,
718 "Unimplemented opcode, class=0x%X type=0x%X Opcode=0x%X Op=%p",
719 OpClass, OpType, Op->Common.AmlOpcode, Op));
721 Status = AE_NOT_IMPLEMENTED;
727 * ACPI 2.0 support for 64-bit integers: Truncate numeric
728 * result value if we are executing from a 32-bit ACPI table
730 (void) AcpiExTruncateFor32bitTable (WalkState->ResultObj);
733 * Check if we just completed the evaluation of a
734 * conditional predicate
736 if ((ACPI_SUCCESS (Status)) &&
737 (WalkState->ControlState) &&
738 (WalkState->ControlState->Common.State ==
739 ACPI_CONTROL_PREDICATE_EXECUTING) &&
740 (WalkState->ControlState->Control.PredicateOp == Op))
742 Status = AcpiDsGetPredicateValue (WalkState, WalkState->ResultObj);
743 WalkState->ResultObj = NULL;
749 if (WalkState->ResultObj)
751 /* Break to debugger to display result */
753 ACPI_DEBUGGER_EXEC (AcpiDbDisplayResultObject (WalkState->ResultObj,
757 * Delete the result op if and only if:
758 * Parent will not use the result -- such as any
759 * non-nested type2 op in a method (parent will be method)
761 AcpiDsDeleteResultIfNotUsed (Op, WalkState->ResultObj, WalkState);
764 #ifdef _UNDER_DEVELOPMENT
766 if (WalkState->ParserState.Aml == WalkState->ParserState.AmlEnd)
768 AcpiDbMethodEnd (WalkState);
772 /* Invoke exception handler on error */
774 if (ACPI_FAILURE (Status))
776 Status = AcpiDsMethodError (Status, WalkState);
779 /* Always clear the object stack */
781 WalkState->NumOperands = 0;
782 return_ACPI_STATUS (Status);