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