1 /******************************************************************************
3 * Module Name: dscontrol - Support for execution control opcodes -
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2015, 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 *****************************************************************************/
118 #include "accommon.h"
120 #include "acdispat.h"
121 #include "acinterp.h"
123 #define _COMPONENT ACPI_DISPATCHER
124 ACPI_MODULE_NAME ("dscontrol")
127 /*******************************************************************************
129 * FUNCTION: AcpiDsExecBeginControlOp
131 * PARAMETERS: WalkList - The list that owns the walk stack
132 * Op - The control Op
136 * DESCRIPTION: Handles all control ops encountered during control method
139 ******************************************************************************/
142 AcpiDsExecBeginControlOp (
143 ACPI_WALK_STATE
*WalkState
,
144 ACPI_PARSE_OBJECT
*Op
)
146 ACPI_STATUS Status
= AE_OK
;
147 ACPI_GENERIC_STATE
*ControlState
;
150 ACPI_FUNCTION_NAME (DsExecBeginControlOp
);
153 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH
, "Op=%p Opcode=%2.2X State=%p\n",
154 Op
, Op
->Common
.AmlOpcode
, WalkState
));
156 switch (Op
->Common
.AmlOpcode
)
160 * If this is an additional iteration of a while loop, continue.
161 * There is no need to allocate a new control state.
163 if (WalkState
->ControlState
)
165 if (WalkState
->ControlState
->Control
.AmlPredicateStart
==
166 (WalkState
->ParserState
.Aml
- 1))
168 /* Reset the state to start-of-loop */
170 WalkState
->ControlState
->Common
.State
=
171 ACPI_CONTROL_CONDITIONAL_EXECUTING
;
176 /*lint -fallthrough */
180 * IF/WHILE: Create a new control state to manage these
181 * constructs. We need to manage these as a stack, in order
184 ControlState
= AcpiUtCreateControlState ();
187 Status
= AE_NO_MEMORY
;
191 * Save a pointer to the predicate for multiple executions
194 ControlState
->Control
.AmlPredicateStart
= WalkState
->ParserState
.Aml
- 1;
195 ControlState
->Control
.PackageEnd
= WalkState
->ParserState
.PkgEnd
;
196 ControlState
->Control
.Opcode
= Op
->Common
.AmlOpcode
;
199 /* Push the control state on this walk's control stack */
201 AcpiUtPushGenericState (&WalkState
->ControlState
, ControlState
);
206 /* Predicate is in the state object */
207 /* If predicate is true, the IF was executed, ignore ELSE part */
209 if (WalkState
->LastPredicate
)
211 Status
= AE_CTRL_TRUE
;
229 /*******************************************************************************
231 * FUNCTION: AcpiDsExecEndControlOp
233 * PARAMETERS: WalkList - The list that owns the walk stack
234 * Op - The control Op
238 * DESCRIPTION: Handles all control ops encountered during control method
241 ******************************************************************************/
244 AcpiDsExecEndControlOp (
245 ACPI_WALK_STATE
*WalkState
,
246 ACPI_PARSE_OBJECT
*Op
)
248 ACPI_STATUS Status
= AE_OK
;
249 ACPI_GENERIC_STATE
*ControlState
;
252 ACPI_FUNCTION_NAME (DsExecEndControlOp
);
255 switch (Op
->Common
.AmlOpcode
)
259 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH
, "[IF_OP] Op=%p\n", Op
));
262 * Save the result of the predicate in case there is an
265 WalkState
->LastPredicate
=
266 (BOOLEAN
) WalkState
->ControlState
->Common
.Value
;
269 * Pop the control state that was created at the start
270 * of the IF and free it
272 ControlState
= AcpiUtPopGenericState (&WalkState
->ControlState
);
273 AcpiUtDeleteGenericState (ControlState
);
282 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH
, "[WHILE_OP] Op=%p\n", Op
));
284 ControlState
= WalkState
->ControlState
;
285 if (ControlState
->Common
.Value
)
287 /* Predicate was true, the body of the loop was just executed */
290 * This loop counter mechanism allows the interpreter to escape
291 * possibly infinite loops. This can occur in poorly written AML
292 * when the hardware does not respond within a while loop and the
293 * loop does not implement a timeout.
295 ControlState
->Control
.LoopCount
++;
296 if (ControlState
->Control
.LoopCount
> ACPI_MAX_LOOP_ITERATIONS
)
298 Status
= AE_AML_INFINITE_LOOP
;
303 * Go back and evaluate the predicate and maybe execute the loop
306 Status
= AE_CTRL_PENDING
;
307 WalkState
->AmlLastWhile
= ControlState
->Control
.AmlPredicateStart
;
311 /* Predicate was false, terminate this while loop */
313 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH
,
314 "[WHILE_OP] termination! Op=%p\n",Op
));
316 /* Pop this control state and free it */
318 ControlState
= AcpiUtPopGenericState (&WalkState
->ControlState
);
319 AcpiUtDeleteGenericState (ControlState
);
324 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH
,
325 "[RETURN_OP] Op=%p Arg=%p\n",Op
, Op
->Common
.Value
.Arg
));
328 * One optional operand -- the return value
329 * It can be either an immediate operand or a result that
330 * has been bubbled up the tree
332 if (Op
->Common
.Value
.Arg
)
334 /* Since we have a real Return(), delete any implicit return */
336 AcpiDsClearImplicitReturn (WalkState
);
338 /* Return statement has an immediate operand */
340 Status
= AcpiDsCreateOperands (WalkState
, Op
->Common
.Value
.Arg
);
341 if (ACPI_FAILURE (Status
))
347 * If value being returned is a Reference (such as
348 * an arg or local), resolve it now because it may
349 * cease to exist at the end of the method.
351 Status
= AcpiExResolveToValue (&WalkState
->Operands
[0], WalkState
);
352 if (ACPI_FAILURE (Status
))
358 * Get the return value and save as the last result
359 * value. This is the only place where WalkState->ReturnDesc
360 * is set to anything other than zero!
362 WalkState
->ReturnDesc
= WalkState
->Operands
[0];
364 else if (WalkState
->ResultCount
)
366 /* Since we have a real Return(), delete any implicit return */
368 AcpiDsClearImplicitReturn (WalkState
);
371 * The return value has come from a previous calculation.
373 * If value being returned is a Reference (such as
374 * an arg or local), resolve it now because it may
375 * cease to exist at the end of the method.
377 * Allow references created by the Index operator to return
380 if ((ACPI_GET_DESCRIPTOR_TYPE (WalkState
->Results
->Results
.ObjDesc
[0]) == ACPI_DESC_TYPE_OPERAND
) &&
381 ((WalkState
->Results
->Results
.ObjDesc
[0])->Common
.Type
== ACPI_TYPE_LOCAL_REFERENCE
) &&
382 ((WalkState
->Results
->Results
.ObjDesc
[0])->Reference
.Class
!= ACPI_REFCLASS_INDEX
))
384 Status
= AcpiExResolveToValue (&WalkState
->Results
->Results
.ObjDesc
[0], WalkState
);
385 if (ACPI_FAILURE (Status
))
391 WalkState
->ReturnDesc
= WalkState
->Results
->Results
.ObjDesc
[0];
395 /* No return operand */
397 if (WalkState
->NumOperands
)
399 AcpiUtRemoveReference (WalkState
->Operands
[0]);
402 WalkState
->Operands
[0] = NULL
;
403 WalkState
->NumOperands
= 0;
404 WalkState
->ReturnDesc
= NULL
;
408 ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH
,
409 "Completed RETURN_OP State=%p, RetVal=%p\n",
410 WalkState
, WalkState
->ReturnDesc
));
412 /* End the control method execution right now */
414 Status
= AE_CTRL_TERMINATE
;
419 /* Just do nothing! */
423 case AML_BREAK_POINT_OP
:
426 * Set the single-step flag. This will cause the debugger (if present)
427 * to break to the console within the AML debugger at the start of the
428 * next AML instruction.
431 AcpiGbl_CmSingleStep
= TRUE
);
433 AcpiOsPrintf ("**break** Executed AML BreakPoint opcode\n"));
435 /* Call to the OSL in case OS wants a piece of the action */
437 Status
= AcpiOsSignal (ACPI_SIGNAL_BREAKPOINT
,
438 "Executed AML Breakpoint opcode");
442 case AML_CONTINUE_OP
: /* ACPI 2.0 */
444 /* Pop and delete control states until we find a while */
446 while (WalkState
->ControlState
&&
447 (WalkState
->ControlState
->Control
.Opcode
!= AML_WHILE_OP
))
449 ControlState
= AcpiUtPopGenericState (&WalkState
->ControlState
);
450 AcpiUtDeleteGenericState (ControlState
);
453 /* No while found? */
455 if (!WalkState
->ControlState
)
457 return (AE_AML_NO_WHILE
);
460 /* Was: WalkState->AmlLastWhile = WalkState->ControlState->Control.AmlPredicateStart; */
462 WalkState
->AmlLastWhile
= WalkState
->ControlState
->Control
.PackageEnd
;
464 /* Return status depending on opcode */
466 if (Op
->Common
.AmlOpcode
== AML_BREAK_OP
)
468 Status
= AE_CTRL_BREAK
;
472 Status
= AE_CTRL_CONTINUE
;
478 ACPI_ERROR ((AE_INFO
, "Unknown control opcode=0x%X Op=%p",
479 Op
->Common
.AmlOpcode
, Op
));
481 Status
= AE_AML_BAD_OPCODE
;