xref: /freebsd-src/sys/contrib/dev/acpica/components/dispatcher/dsutils.c (revision 9c48c75ed62587d422471fade1b0ceba2077bd20)
1a159c266SJung-uk Kim /*******************************************************************************
2a159c266SJung-uk Kim  *
3a159c266SJung-uk Kim  * Module Name: dsutils - Dispatcher utilities
4a159c266SJung-uk Kim  *
5a159c266SJung-uk Kim  ******************************************************************************/
6a159c266SJung-uk Kim 
7a159c266SJung-uk Kim /*
8efcc2a30SJung-uk Kim  * Copyright (C) 2000 - 2013, Intel Corp.
9a159c266SJung-uk Kim  * All rights reserved.
10a159c266SJung-uk Kim  *
11a159c266SJung-uk Kim  * Redistribution and use in source and binary forms, with or without
12a159c266SJung-uk Kim  * modification, are permitted provided that the following conditions
13a159c266SJung-uk Kim  * are met:
14a159c266SJung-uk Kim  * 1. Redistributions of source code must retain the above copyright
15a159c266SJung-uk Kim  *    notice, this list of conditions, and the following disclaimer,
16a159c266SJung-uk Kim  *    without modification.
17a159c266SJung-uk Kim  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18a159c266SJung-uk Kim  *    substantially similar to the "NO WARRANTY" disclaimer below
19a159c266SJung-uk Kim  *    ("Disclaimer") and any redistribution must be conditioned upon
20a159c266SJung-uk Kim  *    including a substantially similar Disclaimer requirement for further
21a159c266SJung-uk Kim  *    binary redistribution.
22a159c266SJung-uk Kim  * 3. Neither the names of the above-listed copyright holders nor the names
23a159c266SJung-uk Kim  *    of any contributors may be used to endorse or promote products derived
24a159c266SJung-uk Kim  *    from this software without specific prior written permission.
25a159c266SJung-uk Kim  *
26a159c266SJung-uk Kim  * Alternatively, this software may be distributed under the terms of the
27a159c266SJung-uk Kim  * GNU General Public License ("GPL") version 2 as published by the Free
28a159c266SJung-uk Kim  * Software Foundation.
29a159c266SJung-uk Kim  *
30a159c266SJung-uk Kim  * NO WARRANTY
31a159c266SJung-uk Kim  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32a159c266SJung-uk Kim  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33a159c266SJung-uk Kim  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34a159c266SJung-uk Kim  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35a159c266SJung-uk Kim  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36a159c266SJung-uk Kim  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37a159c266SJung-uk Kim  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38a159c266SJung-uk Kim  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39a159c266SJung-uk Kim  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40a159c266SJung-uk Kim  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41a159c266SJung-uk Kim  * POSSIBILITY OF SUCH DAMAGES.
42a159c266SJung-uk Kim  */
43a159c266SJung-uk Kim 
44a159c266SJung-uk Kim #define __DSUTILS_C__
45a159c266SJung-uk Kim 
46a159c266SJung-uk Kim #include <contrib/dev/acpica/include/acpi.h>
47a159c266SJung-uk Kim #include <contrib/dev/acpica/include/accommon.h>
48a159c266SJung-uk Kim #include <contrib/dev/acpica/include/acparser.h>
49a159c266SJung-uk Kim #include <contrib/dev/acpica/include/amlcode.h>
50a159c266SJung-uk Kim #include <contrib/dev/acpica/include/acdispat.h>
51a159c266SJung-uk Kim #include <contrib/dev/acpica/include/acinterp.h>
52a159c266SJung-uk Kim #include <contrib/dev/acpica/include/acnamesp.h>
53a159c266SJung-uk Kim #include <contrib/dev/acpica/include/acdebug.h>
54a159c266SJung-uk Kim 
55a159c266SJung-uk Kim #define _COMPONENT          ACPI_DISPATCHER
56a159c266SJung-uk Kim         ACPI_MODULE_NAME    ("dsutils")
57a159c266SJung-uk Kim 
58a159c266SJung-uk Kim 
59a159c266SJung-uk Kim /*******************************************************************************
60a159c266SJung-uk Kim  *
61a159c266SJung-uk Kim  * FUNCTION:    AcpiDsClearImplicitReturn
62a159c266SJung-uk Kim  *
63a159c266SJung-uk Kim  * PARAMETERS:  WalkState           - Current State
64a159c266SJung-uk Kim  *
65a159c266SJung-uk Kim  * RETURN:      None.
66a159c266SJung-uk Kim  *
67a159c266SJung-uk Kim  * DESCRIPTION: Clear and remove a reference on an implicit return value. Used
68a159c266SJung-uk Kim  *              to delete "stale" return values (if enabled, the return value
69a159c266SJung-uk Kim  *              from every operator is saved at least momentarily, in case the
70a159c266SJung-uk Kim  *              parent method exits.)
71a159c266SJung-uk Kim  *
72a159c266SJung-uk Kim  ******************************************************************************/
73a159c266SJung-uk Kim 
74a159c266SJung-uk Kim void
75a159c266SJung-uk Kim AcpiDsClearImplicitReturn (
76a159c266SJung-uk Kim     ACPI_WALK_STATE         *WalkState)
77a159c266SJung-uk Kim {
78a159c266SJung-uk Kim     ACPI_FUNCTION_NAME (DsClearImplicitReturn);
79a159c266SJung-uk Kim 
80a159c266SJung-uk Kim 
81a159c266SJung-uk Kim     /*
82a159c266SJung-uk Kim      * Slack must be enabled for this feature
83a159c266SJung-uk Kim      */
84a159c266SJung-uk Kim     if (!AcpiGbl_EnableInterpreterSlack)
85a159c266SJung-uk Kim     {
86a159c266SJung-uk Kim         return;
87a159c266SJung-uk Kim     }
88a159c266SJung-uk Kim 
89a159c266SJung-uk Kim     if (WalkState->ImplicitReturnObj)
90a159c266SJung-uk Kim     {
91a159c266SJung-uk Kim         /*
92a159c266SJung-uk Kim          * Delete any "stale" implicit return. However, in
93a159c266SJung-uk Kim          * complex statements, the implicit return value can be
94a159c266SJung-uk Kim          * bubbled up several levels.
95a159c266SJung-uk Kim          */
96a159c266SJung-uk Kim         ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
97a159c266SJung-uk Kim             "Removing reference on stale implicit return obj %p\n",
98a159c266SJung-uk Kim             WalkState->ImplicitReturnObj));
99a159c266SJung-uk Kim 
100a159c266SJung-uk Kim         AcpiUtRemoveReference (WalkState->ImplicitReturnObj);
101a159c266SJung-uk Kim         WalkState->ImplicitReturnObj = NULL;
102a159c266SJung-uk Kim     }
103a159c266SJung-uk Kim }
104a159c266SJung-uk Kim 
105a159c266SJung-uk Kim 
106a159c266SJung-uk Kim #ifndef ACPI_NO_METHOD_EXECUTION
107a159c266SJung-uk Kim /*******************************************************************************
108a159c266SJung-uk Kim  *
109a159c266SJung-uk Kim  * FUNCTION:    AcpiDsDoImplicitReturn
110a159c266SJung-uk Kim  *
111a159c266SJung-uk Kim  * PARAMETERS:  ReturnDesc          - The return value
112a159c266SJung-uk Kim  *              WalkState           - Current State
113a159c266SJung-uk Kim  *              AddReference        - True if a reference should be added to the
114a159c266SJung-uk Kim  *                                    return object
115a159c266SJung-uk Kim  *
116a159c266SJung-uk Kim  * RETURN:      TRUE if implicit return enabled, FALSE otherwise
117a159c266SJung-uk Kim  *
118a159c266SJung-uk Kim  * DESCRIPTION: Implements the optional "implicit return".  We save the result
119a159c266SJung-uk Kim  *              of every ASL operator and control method invocation in case the
120a159c266SJung-uk Kim  *              parent method exit. Before storing a new return value, we
121a159c266SJung-uk Kim  *              delete the previous return value.
122a159c266SJung-uk Kim  *
123a159c266SJung-uk Kim  ******************************************************************************/
124a159c266SJung-uk Kim 
125a159c266SJung-uk Kim BOOLEAN
126a159c266SJung-uk Kim AcpiDsDoImplicitReturn (
127a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     *ReturnDesc,
128a159c266SJung-uk Kim     ACPI_WALK_STATE         *WalkState,
129a159c266SJung-uk Kim     BOOLEAN                 AddReference)
130a159c266SJung-uk Kim {
131a159c266SJung-uk Kim     ACPI_FUNCTION_NAME (DsDoImplicitReturn);
132a159c266SJung-uk Kim 
133a159c266SJung-uk Kim 
134a159c266SJung-uk Kim     /*
135a159c266SJung-uk Kim      * Slack must be enabled for this feature, and we must
136a159c266SJung-uk Kim      * have a valid return object
137a159c266SJung-uk Kim      */
138a159c266SJung-uk Kim     if ((!AcpiGbl_EnableInterpreterSlack) ||
139a159c266SJung-uk Kim         (!ReturnDesc))
140a159c266SJung-uk Kim     {
141a159c266SJung-uk Kim         return (FALSE);
142a159c266SJung-uk Kim     }
143a159c266SJung-uk Kim 
144a159c266SJung-uk Kim     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
145a159c266SJung-uk Kim             "Result %p will be implicitly returned; Prev=%p\n",
146a159c266SJung-uk Kim             ReturnDesc,
147a159c266SJung-uk Kim             WalkState->ImplicitReturnObj));
148a159c266SJung-uk Kim 
149a159c266SJung-uk Kim     /*
150a159c266SJung-uk Kim      * Delete any "stale" implicit return value first. However, in
151a159c266SJung-uk Kim      * complex statements, the implicit return value can be
152a159c266SJung-uk Kim      * bubbled up several levels, so we don't clear the value if it
153a159c266SJung-uk Kim      * is the same as the ReturnDesc.
154a159c266SJung-uk Kim      */
155a159c266SJung-uk Kim     if (WalkState->ImplicitReturnObj)
156a159c266SJung-uk Kim     {
157a159c266SJung-uk Kim         if (WalkState->ImplicitReturnObj == ReturnDesc)
158a159c266SJung-uk Kim         {
159a159c266SJung-uk Kim             return (TRUE);
160a159c266SJung-uk Kim         }
161a159c266SJung-uk Kim         AcpiDsClearImplicitReturn (WalkState);
162a159c266SJung-uk Kim     }
163a159c266SJung-uk Kim 
164a159c266SJung-uk Kim     /* Save the implicit return value, add a reference if requested */
165a159c266SJung-uk Kim 
166a159c266SJung-uk Kim     WalkState->ImplicitReturnObj = ReturnDesc;
167a159c266SJung-uk Kim     if (AddReference)
168a159c266SJung-uk Kim     {
169a159c266SJung-uk Kim         AcpiUtAddReference (ReturnDesc);
170a159c266SJung-uk Kim     }
171a159c266SJung-uk Kim 
172a159c266SJung-uk Kim     return (TRUE);
173a159c266SJung-uk Kim }
174a159c266SJung-uk Kim 
175a159c266SJung-uk Kim 
176a159c266SJung-uk Kim /*******************************************************************************
177a159c266SJung-uk Kim  *
178a159c266SJung-uk Kim  * FUNCTION:    AcpiDsIsResultUsed
179a159c266SJung-uk Kim  *
180a159c266SJung-uk Kim  * PARAMETERS:  Op                  - Current Op
181a159c266SJung-uk Kim  *              WalkState           - Current State
182a159c266SJung-uk Kim  *
183a159c266SJung-uk Kim  * RETURN:      TRUE if result is used, FALSE otherwise
184a159c266SJung-uk Kim  *
185a159c266SJung-uk Kim  * DESCRIPTION: Check if a result object will be used by the parent
186a159c266SJung-uk Kim  *
187a159c266SJung-uk Kim  ******************************************************************************/
188a159c266SJung-uk Kim 
189a159c266SJung-uk Kim BOOLEAN
190a159c266SJung-uk Kim AcpiDsIsResultUsed (
191a159c266SJung-uk Kim     ACPI_PARSE_OBJECT       *Op,
192a159c266SJung-uk Kim     ACPI_WALK_STATE         *WalkState)
193a159c266SJung-uk Kim {
194a159c266SJung-uk Kim     const ACPI_OPCODE_INFO  *ParentInfo;
195a159c266SJung-uk Kim 
196a159c266SJung-uk Kim     ACPI_FUNCTION_TRACE_PTR (DsIsResultUsed, Op);
197a159c266SJung-uk Kim 
198a159c266SJung-uk Kim 
199a159c266SJung-uk Kim     /* Must have both an Op and a Result Object */
200a159c266SJung-uk Kim 
201a159c266SJung-uk Kim     if (!Op)
202a159c266SJung-uk Kim     {
203a159c266SJung-uk Kim         ACPI_ERROR ((AE_INFO, "Null Op"));
204*9c48c75eSJung-uk Kim         return_UINT8 (TRUE);
205a159c266SJung-uk Kim     }
206a159c266SJung-uk Kim 
207a159c266SJung-uk Kim     /*
208a159c266SJung-uk Kim      * We know that this operator is not a
209a159c266SJung-uk Kim      * Return() operator (would not come here.) The following code is the
210a159c266SJung-uk Kim      * optional support for a so-called "implicit return". Some AML code
211a159c266SJung-uk Kim      * assumes that the last value of the method is "implicitly" returned
212a159c266SJung-uk Kim      * to the caller. Just save the last result as the return value.
213a159c266SJung-uk Kim      * NOTE: this is optional because the ASL language does not actually
214a159c266SJung-uk Kim      * support this behavior.
215a159c266SJung-uk Kim      */
216a159c266SJung-uk Kim     (void) AcpiDsDoImplicitReturn (WalkState->ResultObj, WalkState, TRUE);
217a159c266SJung-uk Kim 
218a159c266SJung-uk Kim     /*
219a159c266SJung-uk Kim      * Now determine if the parent will use the result
220a159c266SJung-uk Kim      *
221a159c266SJung-uk Kim      * If there is no parent, or the parent is a ScopeOp, we are executing
222a159c266SJung-uk Kim      * at the method level. An executing method typically has no parent,
223a159c266SJung-uk Kim      * since each method is parsed separately. A method invoked externally
224a159c266SJung-uk Kim      * via ExecuteControlMethod has a ScopeOp as the parent.
225a159c266SJung-uk Kim      */
226a159c266SJung-uk Kim     if ((!Op->Common.Parent) ||
227a159c266SJung-uk Kim         (Op->Common.Parent->Common.AmlOpcode == AML_SCOPE_OP))
228a159c266SJung-uk Kim     {
229a159c266SJung-uk Kim         /* No parent, the return value cannot possibly be used */
230a159c266SJung-uk Kim 
231a159c266SJung-uk Kim         ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
232a159c266SJung-uk Kim             "At Method level, result of [%s] not used\n",
233a159c266SJung-uk Kim             AcpiPsGetOpcodeName (Op->Common.AmlOpcode)));
234*9c48c75eSJung-uk Kim         return_UINT8 (FALSE);
235a159c266SJung-uk Kim     }
236a159c266SJung-uk Kim 
237a159c266SJung-uk Kim     /* Get info on the parent. The RootOp is AML_SCOPE */
238a159c266SJung-uk Kim 
239a159c266SJung-uk Kim     ParentInfo = AcpiPsGetOpcodeInfo (Op->Common.Parent->Common.AmlOpcode);
240a159c266SJung-uk Kim     if (ParentInfo->Class == AML_CLASS_UNKNOWN)
241a159c266SJung-uk Kim     {
242a159c266SJung-uk Kim         ACPI_ERROR ((AE_INFO,
243a159c266SJung-uk Kim             "Unknown parent opcode Op=%p", Op));
244*9c48c75eSJung-uk Kim         return_UINT8 (FALSE);
245a159c266SJung-uk Kim     }
246a159c266SJung-uk Kim 
247a159c266SJung-uk Kim     /*
248a159c266SJung-uk Kim      * Decide what to do with the result based on the parent. If
249a159c266SJung-uk Kim      * the parent opcode will not use the result, delete the object.
250a159c266SJung-uk Kim      * Otherwise leave it as is, it will be deleted when it is used
251a159c266SJung-uk Kim      * as an operand later.
252a159c266SJung-uk Kim      */
253a159c266SJung-uk Kim     switch (ParentInfo->Class)
254a159c266SJung-uk Kim     {
255a159c266SJung-uk Kim     case AML_CLASS_CONTROL:
256a159c266SJung-uk Kim 
257a159c266SJung-uk Kim         switch (Op->Common.Parent->Common.AmlOpcode)
258a159c266SJung-uk Kim         {
259a159c266SJung-uk Kim         case AML_RETURN_OP:
260a159c266SJung-uk Kim 
261a159c266SJung-uk Kim             /* Never delete the return value associated with a return opcode */
262a159c266SJung-uk Kim 
263a159c266SJung-uk Kim             goto ResultUsed;
264a159c266SJung-uk Kim 
265a159c266SJung-uk Kim         case AML_IF_OP:
266a159c266SJung-uk Kim         case AML_WHILE_OP:
267a159c266SJung-uk Kim 
268a159c266SJung-uk Kim             /*
269a159c266SJung-uk Kim              * If we are executing the predicate AND this is the predicate op,
270a159c266SJung-uk Kim              * we will use the return value
271a159c266SJung-uk Kim              */
272a159c266SJung-uk Kim             if ((WalkState->ControlState->Common.State == ACPI_CONTROL_PREDICATE_EXECUTING) &&
273a159c266SJung-uk Kim                 (WalkState->ControlState->Control.PredicateOp == Op))
274a159c266SJung-uk Kim             {
275a159c266SJung-uk Kim                 goto ResultUsed;
276a159c266SJung-uk Kim             }
277a159c266SJung-uk Kim             break;
278a159c266SJung-uk Kim 
279a159c266SJung-uk Kim         default:
280a159c266SJung-uk Kim             /* Ignore other control opcodes */
281a159c266SJung-uk Kim             break;
282a159c266SJung-uk Kim         }
283a159c266SJung-uk Kim 
284a159c266SJung-uk Kim         /* The general control opcode returns no result */
285a159c266SJung-uk Kim 
286a159c266SJung-uk Kim         goto ResultNotUsed;
287a159c266SJung-uk Kim 
288a159c266SJung-uk Kim 
289a159c266SJung-uk Kim     case AML_CLASS_CREATE:
290a159c266SJung-uk Kim 
291a159c266SJung-uk Kim         /*
292a159c266SJung-uk Kim          * These opcodes allow TermArg(s) as operands and therefore
293a159c266SJung-uk Kim          * the operands can be method calls. The result is used.
294a159c266SJung-uk Kim          */
295a159c266SJung-uk Kim         goto ResultUsed;
296a159c266SJung-uk Kim 
297a159c266SJung-uk Kim 
298a159c266SJung-uk Kim     case AML_CLASS_NAMED_OBJECT:
299a159c266SJung-uk Kim 
300a159c266SJung-uk Kim         if ((Op->Common.Parent->Common.AmlOpcode == AML_REGION_OP)       ||
301a159c266SJung-uk Kim             (Op->Common.Parent->Common.AmlOpcode == AML_DATA_REGION_OP)  ||
302a159c266SJung-uk Kim             (Op->Common.Parent->Common.AmlOpcode == AML_PACKAGE_OP)      ||
303a159c266SJung-uk Kim             (Op->Common.Parent->Common.AmlOpcode == AML_VAR_PACKAGE_OP)  ||
304a159c266SJung-uk Kim             (Op->Common.Parent->Common.AmlOpcode == AML_BUFFER_OP)       ||
305a159c266SJung-uk Kim             (Op->Common.Parent->Common.AmlOpcode == AML_INT_EVAL_SUBTREE_OP) ||
306a159c266SJung-uk Kim             (Op->Common.Parent->Common.AmlOpcode == AML_BANK_FIELD_OP))
307a159c266SJung-uk Kim         {
308a159c266SJung-uk Kim             /*
309a159c266SJung-uk Kim              * These opcodes allow TermArg(s) as operands and therefore
310a159c266SJung-uk Kim              * the operands can be method calls. The result is used.
311a159c266SJung-uk Kim              */
312a159c266SJung-uk Kim             goto ResultUsed;
313a159c266SJung-uk Kim         }
314a159c266SJung-uk Kim 
315a159c266SJung-uk Kim         goto ResultNotUsed;
316a159c266SJung-uk Kim 
317a159c266SJung-uk Kim 
318a159c266SJung-uk Kim     default:
319a159c266SJung-uk Kim 
320a159c266SJung-uk Kim         /*
321a159c266SJung-uk Kim          * In all other cases. the parent will actually use the return
322a159c266SJung-uk Kim          * object, so keep it.
323a159c266SJung-uk Kim          */
324a159c266SJung-uk Kim         goto ResultUsed;
325a159c266SJung-uk Kim     }
326a159c266SJung-uk Kim 
327a159c266SJung-uk Kim 
328a159c266SJung-uk Kim ResultUsed:
329a159c266SJung-uk Kim     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
330a159c266SJung-uk Kim         "Result of [%s] used by Parent [%s] Op=%p\n",
331a159c266SJung-uk Kim         AcpiPsGetOpcodeName (Op->Common.AmlOpcode),
332a159c266SJung-uk Kim         AcpiPsGetOpcodeName (Op->Common.Parent->Common.AmlOpcode), Op));
333a159c266SJung-uk Kim 
334*9c48c75eSJung-uk Kim     return_UINT8 (TRUE);
335a159c266SJung-uk Kim 
336a159c266SJung-uk Kim 
337a159c266SJung-uk Kim ResultNotUsed:
338a159c266SJung-uk Kim     ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
339a159c266SJung-uk Kim         "Result of [%s] not used by Parent [%s] Op=%p\n",
340a159c266SJung-uk Kim         AcpiPsGetOpcodeName (Op->Common.AmlOpcode),
341a159c266SJung-uk Kim         AcpiPsGetOpcodeName (Op->Common.Parent->Common.AmlOpcode), Op));
342a159c266SJung-uk Kim 
343*9c48c75eSJung-uk Kim     return_UINT8 (FALSE);
344a159c266SJung-uk Kim }
345a159c266SJung-uk Kim 
346a159c266SJung-uk Kim 
347a159c266SJung-uk Kim /*******************************************************************************
348a159c266SJung-uk Kim  *
349a159c266SJung-uk Kim  * FUNCTION:    AcpiDsDeleteResultIfNotUsed
350a159c266SJung-uk Kim  *
351a159c266SJung-uk Kim  * PARAMETERS:  Op              - Current parse Op
352a159c266SJung-uk Kim  *              ResultObj       - Result of the operation
353a159c266SJung-uk Kim  *              WalkState       - Current state
354a159c266SJung-uk Kim  *
355a159c266SJung-uk Kim  * RETURN:      Status
356a159c266SJung-uk Kim  *
357a159c266SJung-uk Kim  * DESCRIPTION: Used after interpretation of an opcode. If there is an internal
358a159c266SJung-uk Kim  *              result descriptor, check if the parent opcode will actually use
359a159c266SJung-uk Kim  *              this result. If not, delete the result now so that it will
360a159c266SJung-uk Kim  *              not become orphaned.
361a159c266SJung-uk Kim  *
362a159c266SJung-uk Kim  ******************************************************************************/
363a159c266SJung-uk Kim 
364a159c266SJung-uk Kim void
365a159c266SJung-uk Kim AcpiDsDeleteResultIfNotUsed (
366a159c266SJung-uk Kim     ACPI_PARSE_OBJECT       *Op,
367a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     *ResultObj,
368a159c266SJung-uk Kim     ACPI_WALK_STATE         *WalkState)
369a159c266SJung-uk Kim {
370a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     *ObjDesc;
371a159c266SJung-uk Kim     ACPI_STATUS             Status;
372a159c266SJung-uk Kim 
373a159c266SJung-uk Kim 
374a159c266SJung-uk Kim     ACPI_FUNCTION_TRACE_PTR (DsDeleteResultIfNotUsed, ResultObj);
375a159c266SJung-uk Kim 
376a159c266SJung-uk Kim 
377a159c266SJung-uk Kim     if (!Op)
378a159c266SJung-uk Kim     {
379a159c266SJung-uk Kim         ACPI_ERROR ((AE_INFO, "Null Op"));
380a159c266SJung-uk Kim         return_VOID;
381a159c266SJung-uk Kim     }
382a159c266SJung-uk Kim 
383a159c266SJung-uk Kim     if (!ResultObj)
384a159c266SJung-uk Kim     {
385a159c266SJung-uk Kim         return_VOID;
386a159c266SJung-uk Kim     }
387a159c266SJung-uk Kim 
388a159c266SJung-uk Kim     if (!AcpiDsIsResultUsed (Op, WalkState))
389a159c266SJung-uk Kim     {
390a159c266SJung-uk Kim         /* Must pop the result stack (ObjDesc should be equal to ResultObj) */
391a159c266SJung-uk Kim 
392a159c266SJung-uk Kim         Status = AcpiDsResultPop (&ObjDesc, WalkState);
393a159c266SJung-uk Kim         if (ACPI_SUCCESS (Status))
394a159c266SJung-uk Kim         {
395a159c266SJung-uk Kim             AcpiUtRemoveReference (ResultObj);
396a159c266SJung-uk Kim         }
397a159c266SJung-uk Kim     }
398a159c266SJung-uk Kim 
399a159c266SJung-uk Kim     return_VOID;
400a159c266SJung-uk Kim }
401a159c266SJung-uk Kim 
402a159c266SJung-uk Kim 
403a159c266SJung-uk Kim /*******************************************************************************
404a159c266SJung-uk Kim  *
405a159c266SJung-uk Kim  * FUNCTION:    AcpiDsResolveOperands
406a159c266SJung-uk Kim  *
407a159c266SJung-uk Kim  * PARAMETERS:  WalkState           - Current walk state with operands on stack
408a159c266SJung-uk Kim  *
409a159c266SJung-uk Kim  * RETURN:      Status
410a159c266SJung-uk Kim  *
411a159c266SJung-uk Kim  * DESCRIPTION: Resolve all operands to their values. Used to prepare
412a159c266SJung-uk Kim  *              arguments to a control method invocation (a call from one
413a159c266SJung-uk Kim  *              method to another.)
414a159c266SJung-uk Kim  *
415a159c266SJung-uk Kim  ******************************************************************************/
416a159c266SJung-uk Kim 
417a159c266SJung-uk Kim ACPI_STATUS
418a159c266SJung-uk Kim AcpiDsResolveOperands (
419a159c266SJung-uk Kim     ACPI_WALK_STATE         *WalkState)
420a159c266SJung-uk Kim {
421a159c266SJung-uk Kim     UINT32                  i;
422a159c266SJung-uk Kim     ACPI_STATUS             Status = AE_OK;
423a159c266SJung-uk Kim 
424a159c266SJung-uk Kim 
425a159c266SJung-uk Kim     ACPI_FUNCTION_TRACE_PTR (DsResolveOperands, WalkState);
426a159c266SJung-uk Kim 
427a159c266SJung-uk Kim 
428a159c266SJung-uk Kim     /*
429a159c266SJung-uk Kim      * Attempt to resolve each of the valid operands
430a159c266SJung-uk Kim      * Method arguments are passed by reference, not by value. This means
431a159c266SJung-uk Kim      * that the actual objects are passed, not copies of the objects.
432a159c266SJung-uk Kim      */
433a159c266SJung-uk Kim     for (i = 0; i < WalkState->NumOperands; i++)
434a159c266SJung-uk Kim     {
435a159c266SJung-uk Kim         Status = AcpiExResolveToValue (&WalkState->Operands[i], WalkState);
436a159c266SJung-uk Kim         if (ACPI_FAILURE (Status))
437a159c266SJung-uk Kim         {
438a159c266SJung-uk Kim             break;
439a159c266SJung-uk Kim         }
440a159c266SJung-uk Kim     }
441a159c266SJung-uk Kim 
442a159c266SJung-uk Kim     return_ACPI_STATUS (Status);
443a159c266SJung-uk Kim }
444a159c266SJung-uk Kim 
445a159c266SJung-uk Kim 
446a159c266SJung-uk Kim /*******************************************************************************
447a159c266SJung-uk Kim  *
448a159c266SJung-uk Kim  * FUNCTION:    AcpiDsClearOperands
449a159c266SJung-uk Kim  *
450a159c266SJung-uk Kim  * PARAMETERS:  WalkState           - Current walk state with operands on stack
451a159c266SJung-uk Kim  *
452a159c266SJung-uk Kim  * RETURN:      None
453a159c266SJung-uk Kim  *
454a159c266SJung-uk Kim  * DESCRIPTION: Clear all operands on the current walk state operand stack.
455a159c266SJung-uk Kim  *
456a159c266SJung-uk Kim  ******************************************************************************/
457a159c266SJung-uk Kim 
458a159c266SJung-uk Kim void
459a159c266SJung-uk Kim AcpiDsClearOperands (
460a159c266SJung-uk Kim     ACPI_WALK_STATE         *WalkState)
461a159c266SJung-uk Kim {
462a159c266SJung-uk Kim     UINT32                  i;
463a159c266SJung-uk Kim 
464a159c266SJung-uk Kim 
465a159c266SJung-uk Kim     ACPI_FUNCTION_TRACE_PTR (DsClearOperands, WalkState);
466a159c266SJung-uk Kim 
467a159c266SJung-uk Kim 
468a159c266SJung-uk Kim     /* Remove a reference on each operand on the stack */
469a159c266SJung-uk Kim 
470a159c266SJung-uk Kim     for (i = 0; i < WalkState->NumOperands; i++)
471a159c266SJung-uk Kim     {
472a159c266SJung-uk Kim         /*
473a159c266SJung-uk Kim          * Remove a reference to all operands, including both
474a159c266SJung-uk Kim          * "Arguments" and "Targets".
475a159c266SJung-uk Kim          */
476a159c266SJung-uk Kim         AcpiUtRemoveReference (WalkState->Operands[i]);
477a159c266SJung-uk Kim         WalkState->Operands[i] = NULL;
478a159c266SJung-uk Kim     }
479a159c266SJung-uk Kim 
480a159c266SJung-uk Kim     WalkState->NumOperands = 0;
481a159c266SJung-uk Kim     return_VOID;
482a159c266SJung-uk Kim }
483a159c266SJung-uk Kim #endif
484a159c266SJung-uk Kim 
485a159c266SJung-uk Kim 
486a159c266SJung-uk Kim /*******************************************************************************
487a159c266SJung-uk Kim  *
488a159c266SJung-uk Kim  * FUNCTION:    AcpiDsCreateOperand
489a159c266SJung-uk Kim  *
490a159c266SJung-uk Kim  * PARAMETERS:  WalkState       - Current walk state
491a159c266SJung-uk Kim  *              Arg             - Parse object for the argument
492a159c266SJung-uk Kim  *              ArgIndex        - Which argument (zero based)
493a159c266SJung-uk Kim  *
494a159c266SJung-uk Kim  * RETURN:      Status
495a159c266SJung-uk Kim  *
496a159c266SJung-uk Kim  * DESCRIPTION: Translate a parse tree object that is an argument to an AML
497a159c266SJung-uk Kim  *              opcode to the equivalent interpreter object. This may include
498a159c266SJung-uk Kim  *              looking up a name or entering a new name into the internal
499a159c266SJung-uk Kim  *              namespace.
500a159c266SJung-uk Kim  *
501a159c266SJung-uk Kim  ******************************************************************************/
502a159c266SJung-uk Kim 
503a159c266SJung-uk Kim ACPI_STATUS
504a159c266SJung-uk Kim AcpiDsCreateOperand (
505a159c266SJung-uk Kim     ACPI_WALK_STATE         *WalkState,
506a159c266SJung-uk Kim     ACPI_PARSE_OBJECT       *Arg,
507a159c266SJung-uk Kim     UINT32                  ArgIndex)
508a159c266SJung-uk Kim {
509a159c266SJung-uk Kim     ACPI_STATUS             Status = AE_OK;
510a159c266SJung-uk Kim     char                    *NameString;
511a159c266SJung-uk Kim     UINT32                  NameLength;
512a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     *ObjDesc;
513a159c266SJung-uk Kim     ACPI_PARSE_OBJECT       *ParentOp;
514a159c266SJung-uk Kim     UINT16                  Opcode;
515a159c266SJung-uk Kim     ACPI_INTERPRETER_MODE   InterpreterMode;
516a159c266SJung-uk Kim     const ACPI_OPCODE_INFO  *OpInfo;
517a159c266SJung-uk Kim 
518a159c266SJung-uk Kim 
519a159c266SJung-uk Kim     ACPI_FUNCTION_TRACE_PTR (DsCreateOperand, Arg);
520a159c266SJung-uk Kim 
521a159c266SJung-uk Kim 
522a159c266SJung-uk Kim     /* A valid name must be looked up in the namespace */
523a159c266SJung-uk Kim 
524a159c266SJung-uk Kim     if ((Arg->Common.AmlOpcode == AML_INT_NAMEPATH_OP) &&
525a159c266SJung-uk Kim         (Arg->Common.Value.String) &&
526a159c266SJung-uk Kim         !(Arg->Common.Flags & ACPI_PARSEOP_IN_STACK))
527a159c266SJung-uk Kim     {
528a159c266SJung-uk Kim         ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH, "Getting a name: Arg=%p\n", Arg));
529a159c266SJung-uk Kim 
530a159c266SJung-uk Kim         /* Get the entire name string from the AML stream */
531a159c266SJung-uk Kim 
532a159c266SJung-uk Kim         Status = AcpiExGetNameString (ACPI_TYPE_ANY, Arg->Common.Value.Buffer,
533a159c266SJung-uk Kim                         &NameString, &NameLength);
534a159c266SJung-uk Kim 
535a159c266SJung-uk Kim         if (ACPI_FAILURE (Status))
536a159c266SJung-uk Kim         {
537a159c266SJung-uk Kim             return_ACPI_STATUS (Status);
538a159c266SJung-uk Kim         }
539a159c266SJung-uk Kim 
540a159c266SJung-uk Kim         /* All prefixes have been handled, and the name is in NameString */
541a159c266SJung-uk Kim 
542a159c266SJung-uk Kim         /*
543a159c266SJung-uk Kim          * Special handling for BufferField declarations. This is a deferred
544a159c266SJung-uk Kim          * opcode that unfortunately defines the field name as the last
545a159c266SJung-uk Kim          * parameter instead of the first. We get here when we are performing
546a159c266SJung-uk Kim          * the deferred execution, so the actual name of the field is already
547a159c266SJung-uk Kim          * in the namespace. We don't want to attempt to look it up again
548a159c266SJung-uk Kim          * because we may be executing in a different scope than where the
549a159c266SJung-uk Kim          * actual opcode exists.
550a159c266SJung-uk Kim          */
551a159c266SJung-uk Kim         if ((WalkState->DeferredNode) &&
552a159c266SJung-uk Kim             (WalkState->DeferredNode->Type == ACPI_TYPE_BUFFER_FIELD) &&
553a159c266SJung-uk Kim             (ArgIndex == (UINT32) ((WalkState->Opcode == AML_CREATE_FIELD_OP) ? 3 : 2)))
554a159c266SJung-uk Kim         {
555a159c266SJung-uk Kim             ObjDesc = ACPI_CAST_PTR (
556a159c266SJung-uk Kim                         ACPI_OPERAND_OBJECT, WalkState->DeferredNode);
557a159c266SJung-uk Kim             Status = AE_OK;
558a159c266SJung-uk Kim         }
559a159c266SJung-uk Kim         else    /* All other opcodes */
560a159c266SJung-uk Kim         {
561a159c266SJung-uk Kim             /*
562a159c266SJung-uk Kim              * Differentiate between a namespace "create" operation
563a159c266SJung-uk Kim              * versus a "lookup" operation (IMODE_LOAD_PASS2 vs.
564a159c266SJung-uk Kim              * IMODE_EXECUTE) in order to support the creation of
565a159c266SJung-uk Kim              * namespace objects during the execution of control methods.
566a159c266SJung-uk Kim              */
567a159c266SJung-uk Kim             ParentOp = Arg->Common.Parent;
568a159c266SJung-uk Kim             OpInfo = AcpiPsGetOpcodeInfo (ParentOp->Common.AmlOpcode);
569a159c266SJung-uk Kim             if ((OpInfo->Flags & AML_NSNODE) &&
570a159c266SJung-uk Kim                 (ParentOp->Common.AmlOpcode != AML_INT_METHODCALL_OP) &&
571a159c266SJung-uk Kim                 (ParentOp->Common.AmlOpcode != AML_REGION_OP) &&
572a159c266SJung-uk Kim                 (ParentOp->Common.AmlOpcode != AML_INT_NAMEPATH_OP))
573a159c266SJung-uk Kim             {
574a159c266SJung-uk Kim                 /* Enter name into namespace if not found */
575a159c266SJung-uk Kim 
576a159c266SJung-uk Kim                 InterpreterMode = ACPI_IMODE_LOAD_PASS2;
577a159c266SJung-uk Kim             }
578a159c266SJung-uk Kim             else
579a159c266SJung-uk Kim             {
580a159c266SJung-uk Kim                 /* Return a failure if name not found */
581a159c266SJung-uk Kim 
582a159c266SJung-uk Kim                 InterpreterMode = ACPI_IMODE_EXECUTE;
583a159c266SJung-uk Kim             }
584a159c266SJung-uk Kim 
585a159c266SJung-uk Kim             Status = AcpiNsLookup (WalkState->ScopeInfo, NameString,
586a159c266SJung-uk Kim                         ACPI_TYPE_ANY, InterpreterMode,
587a159c266SJung-uk Kim                         ACPI_NS_SEARCH_PARENT | ACPI_NS_DONT_OPEN_SCOPE,
588a159c266SJung-uk Kim                         WalkState,
589a159c266SJung-uk Kim                         ACPI_CAST_INDIRECT_PTR (ACPI_NAMESPACE_NODE, &ObjDesc));
590a159c266SJung-uk Kim             /*
591a159c266SJung-uk Kim              * The only case where we pass through (ignore) a NOT_FOUND
592a159c266SJung-uk Kim              * error is for the CondRefOf opcode.
593a159c266SJung-uk Kim              */
594a159c266SJung-uk Kim             if (Status == AE_NOT_FOUND)
595a159c266SJung-uk Kim             {
596a159c266SJung-uk Kim                 if (ParentOp->Common.AmlOpcode == AML_COND_REF_OF_OP)
597a159c266SJung-uk Kim                 {
598a159c266SJung-uk Kim                     /*
599a159c266SJung-uk Kim                      * For the Conditional Reference op, it's OK if
600a159c266SJung-uk Kim                      * the name is not found;  We just need a way to
601a159c266SJung-uk Kim                      * indicate this to the interpreter, set the
602a159c266SJung-uk Kim                      * object to the root
603a159c266SJung-uk Kim                      */
604a159c266SJung-uk Kim                     ObjDesc = ACPI_CAST_PTR (
605a159c266SJung-uk Kim                                 ACPI_OPERAND_OBJECT, AcpiGbl_RootNode);
606a159c266SJung-uk Kim                     Status = AE_OK;
607a159c266SJung-uk Kim                 }
608a159c266SJung-uk Kim                 else
609a159c266SJung-uk Kim                 {
610a159c266SJung-uk Kim                     /*
611a159c266SJung-uk Kim                      * We just plain didn't find it -- which is a
612a159c266SJung-uk Kim                      * very serious error at this point
613a159c266SJung-uk Kim                      */
614a159c266SJung-uk Kim                     Status = AE_AML_NAME_NOT_FOUND;
615a159c266SJung-uk Kim                 }
616a159c266SJung-uk Kim             }
617a159c266SJung-uk Kim 
618a159c266SJung-uk Kim             if (ACPI_FAILURE (Status))
619a159c266SJung-uk Kim             {
620a159c266SJung-uk Kim                 ACPI_ERROR_NAMESPACE (NameString, Status);
621a159c266SJung-uk Kim             }
622a159c266SJung-uk Kim         }
623a159c266SJung-uk Kim 
624a159c266SJung-uk Kim         /* Free the namestring created above */
625a159c266SJung-uk Kim 
626a159c266SJung-uk Kim         ACPI_FREE (NameString);
627a159c266SJung-uk Kim 
628a159c266SJung-uk Kim         /* Check status from the lookup */
629a159c266SJung-uk Kim 
630a159c266SJung-uk Kim         if (ACPI_FAILURE (Status))
631a159c266SJung-uk Kim         {
632a159c266SJung-uk Kim             return_ACPI_STATUS (Status);
633a159c266SJung-uk Kim         }
634a159c266SJung-uk Kim 
635a159c266SJung-uk Kim         /* Put the resulting object onto the current object stack */
636a159c266SJung-uk Kim 
637a159c266SJung-uk Kim         Status = AcpiDsObjStackPush (ObjDesc, WalkState);
638a159c266SJung-uk Kim         if (ACPI_FAILURE (Status))
639a159c266SJung-uk Kim         {
640a159c266SJung-uk Kim             return_ACPI_STATUS (Status);
641a159c266SJung-uk Kim         }
642a159c266SJung-uk Kim         ACPI_DEBUGGER_EXEC (AcpiDbDisplayArgumentObject (ObjDesc, WalkState));
643a159c266SJung-uk Kim     }
644a159c266SJung-uk Kim     else
645a159c266SJung-uk Kim     {
646a159c266SJung-uk Kim         /* Check for null name case */
647a159c266SJung-uk Kim 
648a159c266SJung-uk Kim         if ((Arg->Common.AmlOpcode == AML_INT_NAMEPATH_OP) &&
649a159c266SJung-uk Kim             !(Arg->Common.Flags & ACPI_PARSEOP_IN_STACK))
650a159c266SJung-uk Kim         {
651a159c266SJung-uk Kim             /*
652a159c266SJung-uk Kim              * If the name is null, this means that this is an
653a159c266SJung-uk Kim              * optional result parameter that was not specified
654a159c266SJung-uk Kim              * in the original ASL. Create a Zero Constant for a
655a159c266SJung-uk Kim              * placeholder. (Store to a constant is a Noop.)
656a159c266SJung-uk Kim              */
657a159c266SJung-uk Kim             Opcode = AML_ZERO_OP;       /* Has no arguments! */
658a159c266SJung-uk Kim 
659a159c266SJung-uk Kim             ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
660a159c266SJung-uk Kim                 "Null namepath: Arg=%p\n", Arg));
661a159c266SJung-uk Kim         }
662a159c266SJung-uk Kim         else
663a159c266SJung-uk Kim         {
664a159c266SJung-uk Kim             Opcode = Arg->Common.AmlOpcode;
665a159c266SJung-uk Kim         }
666a159c266SJung-uk Kim 
667a159c266SJung-uk Kim         /* Get the object type of the argument */
668a159c266SJung-uk Kim 
669a159c266SJung-uk Kim         OpInfo = AcpiPsGetOpcodeInfo (Opcode);
670a159c266SJung-uk Kim         if (OpInfo->ObjectType == ACPI_TYPE_INVALID)
671a159c266SJung-uk Kim         {
672a159c266SJung-uk Kim             return_ACPI_STATUS (AE_NOT_IMPLEMENTED);
673a159c266SJung-uk Kim         }
674a159c266SJung-uk Kim 
675a159c266SJung-uk Kim         if ((OpInfo->Flags & AML_HAS_RETVAL) || (Arg->Common.Flags & ACPI_PARSEOP_IN_STACK))
676a159c266SJung-uk Kim         {
677a159c266SJung-uk Kim             ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH,
678a159c266SJung-uk Kim                 "Argument previously created, already stacked\n"));
679a159c266SJung-uk Kim 
680a159c266SJung-uk Kim             ACPI_DEBUGGER_EXEC (AcpiDbDisplayArgumentObject (
681a159c266SJung-uk Kim                 WalkState->Operands [WalkState->NumOperands - 1], WalkState));
682a159c266SJung-uk Kim 
683a159c266SJung-uk Kim             /*
684a159c266SJung-uk Kim              * Use value that was already previously returned
685a159c266SJung-uk Kim              * by the evaluation of this argument
686a159c266SJung-uk Kim              */
687a159c266SJung-uk Kim             Status = AcpiDsResultPop (&ObjDesc, WalkState);
688a159c266SJung-uk Kim             if (ACPI_FAILURE (Status))
689a159c266SJung-uk Kim             {
690a159c266SJung-uk Kim                 /*
691a159c266SJung-uk Kim                  * Only error is underflow, and this indicates
692a159c266SJung-uk Kim                  * a missing or null operand!
693a159c266SJung-uk Kim                  */
694a159c266SJung-uk Kim                 ACPI_EXCEPTION ((AE_INFO, Status,
695a159c266SJung-uk Kim                     "Missing or null operand"));
696a159c266SJung-uk Kim                 return_ACPI_STATUS (Status);
697a159c266SJung-uk Kim             }
698a159c266SJung-uk Kim         }
699a159c266SJung-uk Kim         else
700a159c266SJung-uk Kim         {
701a159c266SJung-uk Kim             /* Create an ACPI_INTERNAL_OBJECT for the argument */
702a159c266SJung-uk Kim 
703a159c266SJung-uk Kim             ObjDesc = AcpiUtCreateInternalObject (OpInfo->ObjectType);
704a159c266SJung-uk Kim             if (!ObjDesc)
705a159c266SJung-uk Kim             {
706a159c266SJung-uk Kim                 return_ACPI_STATUS (AE_NO_MEMORY);
707a159c266SJung-uk Kim             }
708a159c266SJung-uk Kim 
709a159c266SJung-uk Kim             /* Initialize the new object */
710a159c266SJung-uk Kim 
711a159c266SJung-uk Kim             Status = AcpiDsInitObjectFromOp (
712a159c266SJung-uk Kim                         WalkState, Arg, Opcode, &ObjDesc);
713a159c266SJung-uk Kim             if (ACPI_FAILURE (Status))
714a159c266SJung-uk Kim             {
715a159c266SJung-uk Kim                 AcpiUtDeleteObjectDesc (ObjDesc);
716a159c266SJung-uk Kim                 return_ACPI_STATUS (Status);
717a159c266SJung-uk Kim             }
718a159c266SJung-uk Kim         }
719a159c266SJung-uk Kim 
720a159c266SJung-uk Kim         /* Put the operand object on the object stack */
721a159c266SJung-uk Kim 
722a159c266SJung-uk Kim         Status = AcpiDsObjStackPush (ObjDesc, WalkState);
723a159c266SJung-uk Kim         if (ACPI_FAILURE (Status))
724a159c266SJung-uk Kim         {
725a159c266SJung-uk Kim             return_ACPI_STATUS (Status);
726a159c266SJung-uk Kim         }
727a159c266SJung-uk Kim 
728a159c266SJung-uk Kim         ACPI_DEBUGGER_EXEC (AcpiDbDisplayArgumentObject (ObjDesc, WalkState));
729a159c266SJung-uk Kim     }
730a159c266SJung-uk Kim 
731a159c266SJung-uk Kim     return_ACPI_STATUS (AE_OK);
732a159c266SJung-uk Kim }
733a159c266SJung-uk Kim 
734a159c266SJung-uk Kim 
735a159c266SJung-uk Kim /*******************************************************************************
736a159c266SJung-uk Kim  *
737a159c266SJung-uk Kim  * FUNCTION:    AcpiDsCreateOperands
738a159c266SJung-uk Kim  *
739a159c266SJung-uk Kim  * PARAMETERS:  WalkState           - Current state
740a159c266SJung-uk Kim  *              FirstArg            - First argument of a parser argument tree
741a159c266SJung-uk Kim  *
742a159c266SJung-uk Kim  * RETURN:      Status
743a159c266SJung-uk Kim  *
744a159c266SJung-uk Kim  * DESCRIPTION: Convert an operator's arguments from a parse tree format to
745a159c266SJung-uk Kim  *              namespace objects and place those argument object on the object
746a159c266SJung-uk Kim  *              stack in preparation for evaluation by the interpreter.
747a159c266SJung-uk Kim  *
748a159c266SJung-uk Kim  ******************************************************************************/
749a159c266SJung-uk Kim 
750a159c266SJung-uk Kim ACPI_STATUS
751a159c266SJung-uk Kim AcpiDsCreateOperands (
752a159c266SJung-uk Kim     ACPI_WALK_STATE         *WalkState,
753a159c266SJung-uk Kim     ACPI_PARSE_OBJECT       *FirstArg)
754a159c266SJung-uk Kim {
755a159c266SJung-uk Kim     ACPI_STATUS             Status = AE_OK;
756a159c266SJung-uk Kim     ACPI_PARSE_OBJECT       *Arg;
757a159c266SJung-uk Kim     ACPI_PARSE_OBJECT       *Arguments[ACPI_OBJ_NUM_OPERANDS];
758a159c266SJung-uk Kim     UINT32                  ArgCount = 0;
759a159c266SJung-uk Kim     UINT32                  Index = WalkState->NumOperands;
760a159c266SJung-uk Kim     UINT32                  i;
761a159c266SJung-uk Kim 
762a159c266SJung-uk Kim 
763a159c266SJung-uk Kim     ACPI_FUNCTION_TRACE_PTR (DsCreateOperands, FirstArg);
764a159c266SJung-uk Kim 
765a159c266SJung-uk Kim 
766a159c266SJung-uk Kim     /* Get all arguments in the list */
767a159c266SJung-uk Kim 
768a159c266SJung-uk Kim     Arg = FirstArg;
769a159c266SJung-uk Kim     while (Arg)
770a159c266SJung-uk Kim     {
771a159c266SJung-uk Kim         if (Index >= ACPI_OBJ_NUM_OPERANDS)
772a159c266SJung-uk Kim         {
773a159c266SJung-uk Kim             return_ACPI_STATUS (AE_BAD_DATA);
774a159c266SJung-uk Kim         }
775a159c266SJung-uk Kim 
776a159c266SJung-uk Kim         Arguments[Index] = Arg;
777a159c266SJung-uk Kim         WalkState->Operands [Index] = NULL;
778a159c266SJung-uk Kim 
779a159c266SJung-uk Kim         /* Move on to next argument, if any */
780a159c266SJung-uk Kim 
781a159c266SJung-uk Kim         Arg = Arg->Common.Next;
782a159c266SJung-uk Kim         ArgCount++;
783a159c266SJung-uk Kim         Index++;
784a159c266SJung-uk Kim     }
785a159c266SJung-uk Kim 
786a159c266SJung-uk Kim     Index--;
787a159c266SJung-uk Kim 
788a159c266SJung-uk Kim     /* It is the appropriate order to get objects from the Result stack */
789a159c266SJung-uk Kim 
790a159c266SJung-uk Kim     for (i = 0; i < ArgCount; i++)
791a159c266SJung-uk Kim     {
792a159c266SJung-uk Kim         Arg = Arguments[Index];
793a159c266SJung-uk Kim 
794a159c266SJung-uk Kim         /* Force the filling of the operand stack in inverse order */
795a159c266SJung-uk Kim 
796a159c266SJung-uk Kim         WalkState->OperandIndex = (UINT8) Index;
797a159c266SJung-uk Kim 
798a159c266SJung-uk Kim         Status = AcpiDsCreateOperand (WalkState, Arg, Index);
799a159c266SJung-uk Kim         if (ACPI_FAILURE (Status))
800a159c266SJung-uk Kim         {
801a159c266SJung-uk Kim             goto Cleanup;
802a159c266SJung-uk Kim         }
803a159c266SJung-uk Kim 
804a159c266SJung-uk Kim         Index--;
805a159c266SJung-uk Kim 
806a159c266SJung-uk Kim         ACPI_DEBUG_PRINT ((ACPI_DB_DISPATCH, "Arg #%u (%p) done, Arg1=%p\n",
807a159c266SJung-uk Kim             Index, Arg, FirstArg));
808a159c266SJung-uk Kim     }
809a159c266SJung-uk Kim 
810a159c266SJung-uk Kim     return_ACPI_STATUS (Status);
811a159c266SJung-uk Kim 
812a159c266SJung-uk Kim 
813a159c266SJung-uk Kim Cleanup:
814a159c266SJung-uk Kim     /*
815a159c266SJung-uk Kim      * We must undo everything done above; meaning that we must
816a159c266SJung-uk Kim      * pop everything off of the operand stack and delete those
817a159c266SJung-uk Kim      * objects
818a159c266SJung-uk Kim      */
819a159c266SJung-uk Kim     AcpiDsObjStackPopAndDelete (ArgCount, WalkState);
820a159c266SJung-uk Kim 
821a159c266SJung-uk Kim     ACPI_EXCEPTION ((AE_INFO, Status, "While creating Arg %u", Index));
822a159c266SJung-uk Kim     return_ACPI_STATUS (Status);
823a159c266SJung-uk Kim }
824a159c266SJung-uk Kim 
825a159c266SJung-uk Kim 
826a159c266SJung-uk Kim /*****************************************************************************
827a159c266SJung-uk Kim  *
828a159c266SJung-uk Kim  * FUNCTION:    AcpiDsEvaluateNamePath
829a159c266SJung-uk Kim  *
830a159c266SJung-uk Kim  * PARAMETERS:  WalkState       - Current state of the parse tree walk,
831a159c266SJung-uk Kim  *                                the opcode of current operation should be
832a159c266SJung-uk Kim  *                                AML_INT_NAMEPATH_OP
833a159c266SJung-uk Kim  *
834a159c266SJung-uk Kim  * RETURN:      Status
835a159c266SJung-uk Kim  *
836a159c266SJung-uk Kim  * DESCRIPTION: Translate the -NamePath- parse tree object to the equivalent
837a159c266SJung-uk Kim  *              interpreter object, convert it to value, if needed, duplicate
838a159c266SJung-uk Kim  *              it, if needed, and push it onto the current result stack.
839a159c266SJung-uk Kim  *
840a159c266SJung-uk Kim  ****************************************************************************/
841a159c266SJung-uk Kim 
842a159c266SJung-uk Kim ACPI_STATUS
843a159c266SJung-uk Kim AcpiDsEvaluateNamePath (
844a159c266SJung-uk Kim     ACPI_WALK_STATE         *WalkState)
845a159c266SJung-uk Kim {
846a159c266SJung-uk Kim     ACPI_STATUS             Status = AE_OK;
847a159c266SJung-uk Kim     ACPI_PARSE_OBJECT       *Op = WalkState->Op;
848a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     **Operand = &WalkState->Operands[0];
849a159c266SJung-uk Kim     ACPI_OPERAND_OBJECT     *NewObjDesc;
850a159c266SJung-uk Kim     UINT8                   Type;
851a159c266SJung-uk Kim 
852a159c266SJung-uk Kim 
853a159c266SJung-uk Kim     ACPI_FUNCTION_TRACE_PTR (DsEvaluateNamePath, WalkState);
854a159c266SJung-uk Kim 
855a159c266SJung-uk Kim 
856a159c266SJung-uk Kim     if (!Op->Common.Parent)
857a159c266SJung-uk Kim     {
858a159c266SJung-uk Kim         /* This happens after certain exception processing */
859a159c266SJung-uk Kim 
860a159c266SJung-uk Kim         goto Exit;
861a159c266SJung-uk Kim     }
862a159c266SJung-uk Kim 
863a159c266SJung-uk Kim     if ((Op->Common.Parent->Common.AmlOpcode == AML_PACKAGE_OP) ||
864a159c266SJung-uk Kim         (Op->Common.Parent->Common.AmlOpcode == AML_VAR_PACKAGE_OP) ||
865a159c266SJung-uk Kim         (Op->Common.Parent->Common.AmlOpcode == AML_REF_OF_OP))
866a159c266SJung-uk Kim     {
867a159c266SJung-uk Kim         /* TBD: Should we specify this feature as a bit of OpInfo->Flags of these opcodes? */
868a159c266SJung-uk Kim 
869a159c266SJung-uk Kim         goto Exit;
870a159c266SJung-uk Kim     }
871a159c266SJung-uk Kim 
872a159c266SJung-uk Kim     Status = AcpiDsCreateOperand (WalkState, Op, 0);
873a159c266SJung-uk Kim     if (ACPI_FAILURE (Status))
874a159c266SJung-uk Kim     {
875a159c266SJung-uk Kim         goto Exit;
876a159c266SJung-uk Kim     }
877a159c266SJung-uk Kim 
878a159c266SJung-uk Kim     if (Op->Common.Flags & ACPI_PARSEOP_TARGET)
879a159c266SJung-uk Kim     {
880a159c266SJung-uk Kim         NewObjDesc = *Operand;
881a159c266SJung-uk Kim         goto PushResult;
882a159c266SJung-uk Kim     }
883a159c266SJung-uk Kim 
884a159c266SJung-uk Kim     Type = (*Operand)->Common.Type;
885a159c266SJung-uk Kim 
886a159c266SJung-uk Kim     Status = AcpiExResolveToValue (Operand, WalkState);
887a159c266SJung-uk Kim     if (ACPI_FAILURE (Status))
888a159c266SJung-uk Kim     {
889a159c266SJung-uk Kim         goto Exit;
890a159c266SJung-uk Kim     }
891a159c266SJung-uk Kim 
892a159c266SJung-uk Kim     if (Type == ACPI_TYPE_INTEGER)
893a159c266SJung-uk Kim     {
894a159c266SJung-uk Kim         /* It was incremented by AcpiExResolveToValue */
895a159c266SJung-uk Kim 
896a159c266SJung-uk Kim         AcpiUtRemoveReference (*Operand);
897a159c266SJung-uk Kim 
898a159c266SJung-uk Kim         Status = AcpiUtCopyIobjectToIobject (*Operand, &NewObjDesc, WalkState);
899a159c266SJung-uk Kim         if (ACPI_FAILURE (Status))
900a159c266SJung-uk Kim         {
901a159c266SJung-uk Kim             goto Exit;
902a159c266SJung-uk Kim         }
903a159c266SJung-uk Kim     }
904a159c266SJung-uk Kim     else
905a159c266SJung-uk Kim     {
906a159c266SJung-uk Kim         /*
907a159c266SJung-uk Kim          * The object either was anew created or is
908a159c266SJung-uk Kim          * a Namespace node - don't decrement it.
909a159c266SJung-uk Kim          */
910a159c266SJung-uk Kim         NewObjDesc = *Operand;
911a159c266SJung-uk Kim     }
912a159c266SJung-uk Kim 
913a159c266SJung-uk Kim     /* Cleanup for name-path operand */
914a159c266SJung-uk Kim 
915a159c266SJung-uk Kim     Status = AcpiDsObjStackPop (1, WalkState);
916a159c266SJung-uk Kim     if (ACPI_FAILURE (Status))
917a159c266SJung-uk Kim     {
918a159c266SJung-uk Kim         WalkState->ResultObj = NewObjDesc;
919a159c266SJung-uk Kim         goto Exit;
920a159c266SJung-uk Kim     }
921a159c266SJung-uk Kim 
922a159c266SJung-uk Kim PushResult:
923a159c266SJung-uk Kim 
924a159c266SJung-uk Kim     WalkState->ResultObj = NewObjDesc;
925a159c266SJung-uk Kim 
926a159c266SJung-uk Kim     Status = AcpiDsResultPush (WalkState->ResultObj, WalkState);
927a159c266SJung-uk Kim     if (ACPI_SUCCESS (Status))
928a159c266SJung-uk Kim     {
929a159c266SJung-uk Kim         /* Force to take it from stack */
930a159c266SJung-uk Kim 
931a159c266SJung-uk Kim         Op->Common.Flags |= ACPI_PARSEOP_IN_STACK;
932a159c266SJung-uk Kim     }
933a159c266SJung-uk Kim 
934a159c266SJung-uk Kim Exit:
935a159c266SJung-uk Kim 
936a159c266SJung-uk Kim     return_ACPI_STATUS (Status);
937a159c266SJung-uk Kim }
938