blob: 4d8c992a51d83e4bcd04c6a2556afaa25f7400c8 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*******************************************************************************
2 *
3 * Module Name: dsutils - Dispatcher utilities
4 *
5 ******************************************************************************/
6
7/*
Bob Moore25f044e2013-01-25 05:38:56 +00008 * Copyright (C) 2000 - 2013, Intel Corp.
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
25 *
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
29 *
30 * NO WARRANTY
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
42 */
43
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#include <acpi/acpi.h>
Len Browne2f7a772009-01-09 00:30:03 -050045#include "accommon.h"
46#include "acparser.h"
47#include "amlcode.h"
48#include "acdispat.h"
49#include "acinterp.h"
50#include "acnamesp.h"
51#include "acdebug.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070052
53#define _COMPONENT ACPI_DISPATCHER
Len Brown4be44fc2005-08-05 00:44:28 -040054ACPI_MODULE_NAME("dsutils")
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
56/*******************************************************************************
57 *
58 * FUNCTION: acpi_ds_clear_implicit_return
59 *
60 * PARAMETERS: walk_state - Current State
61 *
62 * RETURN: None.
63 *
Bob Moore73a30902012-10-31 02:26:55 +000064 * DESCRIPTION: Clear and remove a reference on an implicit return value. Used
Linus Torvalds1da177e2005-04-16 15:20:36 -070065 * to delete "stale" return values (if enabled, the return value
66 * from every operator is saved at least momentarily, in case the
67 * parent method exits.)
68 *
69 ******************************************************************************/
Len Brown4be44fc2005-08-05 00:44:28 -040070void acpi_ds_clear_implicit_return(struct acpi_walk_state *walk_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -070071{
Bob Mooreb229cf92006-04-21 17:15:00 -040072 ACPI_FUNCTION_NAME(ds_clear_implicit_return);
Linus Torvalds1da177e2005-04-16 15:20:36 -070073
74 /*
75 * Slack must be enabled for this feature
76 */
77 if (!acpi_gbl_enable_interpreter_slack) {
78 return;
79 }
80
81 if (walk_state->implicit_return_obj) {
82 /*
83 * Delete any "stale" implicit return. However, in
84 * complex statements, the implicit return value can be
85 * bubbled up several levels.
86 */
Len Brown4be44fc2005-08-05 00:44:28 -040087 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
88 "Removing reference on stale implicit return obj %p\n",
89 walk_state->implicit_return_obj));
Linus Torvalds1da177e2005-04-16 15:20:36 -070090
Len Brown4be44fc2005-08-05 00:44:28 -040091 acpi_ut_remove_reference(walk_state->implicit_return_obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 walk_state->implicit_return_obj = NULL;
93 }
94}
95
Linus Torvalds1da177e2005-04-16 15:20:36 -070096#ifndef ACPI_NO_METHOD_EXECUTION
Linus Torvalds1da177e2005-04-16 15:20:36 -070097/*******************************************************************************
98 *
99 * FUNCTION: acpi_ds_do_implicit_return
100 *
101 * PARAMETERS: return_desc - The return value
102 * walk_state - Current State
103 * add_reference - True if a reference should be added to the
104 * return object
105 *
106 * RETURN: TRUE if implicit return enabled, FALSE otherwise
107 *
108 * DESCRIPTION: Implements the optional "implicit return". We save the result
109 * of every ASL operator and control method invocation in case the
Bob Moore73a30902012-10-31 02:26:55 +0000110 * parent method exit. Before storing a new return value, we
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 * delete the previous return value.
112 *
113 ******************************************************************************/
114
115u8
Len Brown4be44fc2005-08-05 00:44:28 -0400116acpi_ds_do_implicit_return(union acpi_operand_object *return_desc,
117 struct acpi_walk_state *walk_state, u8 add_reference)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118{
Bob Mooreb229cf92006-04-21 17:15:00 -0400119 ACPI_FUNCTION_NAME(ds_do_implicit_return);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
121 /*
122 * Slack must be enabled for this feature, and we must
123 * have a valid return object
124 */
Len Brown4be44fc2005-08-05 00:44:28 -0400125 if ((!acpi_gbl_enable_interpreter_slack) || (!return_desc)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 return (FALSE);
127 }
128
Len Brown4be44fc2005-08-05 00:44:28 -0400129 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
130 "Result %p will be implicitly returned; Prev=%p\n",
131 return_desc, walk_state->implicit_return_obj));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
133 /*
134 * Delete any "stale" implicit return value first. However, in
135 * complex statements, the implicit return value can be
136 * bubbled up several levels, so we don't clear the value if it
137 * is the same as the return_desc.
138 */
139 if (walk_state->implicit_return_obj) {
140 if (walk_state->implicit_return_obj == return_desc) {
141 return (TRUE);
142 }
Len Brown4be44fc2005-08-05 00:44:28 -0400143 acpi_ds_clear_implicit_return(walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 }
145
146 /* Save the implicit return value, add a reference if requested */
147
148 walk_state->implicit_return_obj = return_desc;
149 if (add_reference) {
Len Brown4be44fc2005-08-05 00:44:28 -0400150 acpi_ut_add_reference(return_desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 }
152
153 return (TRUE);
154}
155
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156/*******************************************************************************
157 *
158 * FUNCTION: acpi_ds_is_result_used
159 *
Bob Mooreba494be2012-07-12 09:40:10 +0800160 * PARAMETERS: op - Current Op
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 * walk_state - Current State
162 *
163 * RETURN: TRUE if result is used, FALSE otherwise
164 *
165 * DESCRIPTION: Check if a result object will be used by the parent
166 *
167 ******************************************************************************/
168
169u8
Len Brown4be44fc2005-08-05 00:44:28 -0400170acpi_ds_is_result_used(union acpi_parse_object * op,
171 struct acpi_walk_state * walk_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172{
Len Brown4be44fc2005-08-05 00:44:28 -0400173 const struct acpi_opcode_info *parent_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
Bob Mooreb229cf92006-04-21 17:15:00 -0400175 ACPI_FUNCTION_TRACE_PTR(ds_is_result_used, op);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
177 /* Must have both an Op and a Result Object */
178
179 if (!op) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500180 ACPI_ERROR((AE_INFO, "Null Op"));
Bob Moore7b891692012-12-31 00:06:16 +0000181 return_VALUE(TRUE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 }
183
184 /*
185 * We know that this operator is not a
186 * Return() operator (would not come here.) The following code is the
187 * optional support for a so-called "implicit return". Some AML code
188 * assumes that the last value of the method is "implicitly" returned
189 * to the caller. Just save the last result as the return value.
190 * NOTE: this is optional because the ASL language does not actually
191 * support this behavior.
192 */
Len Brown4be44fc2005-08-05 00:44:28 -0400193 (void)acpi_ds_do_implicit_return(walk_state->result_obj, walk_state,
194 TRUE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195
196 /*
197 * Now determine if the parent will use the result
198 *
199 * If there is no parent, or the parent is a scope_op, we are executing
200 * at the method level. An executing method typically has no parent,
Bob Moore73a30902012-10-31 02:26:55 +0000201 * since each method is parsed separately. A method invoked externally
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 * via execute_control_method has a scope_op as the parent.
203 */
204 if ((!op->common.parent) ||
Len Brown4be44fc2005-08-05 00:44:28 -0400205 (op->common.parent->common.aml_opcode == AML_SCOPE_OP)) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400206
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 /* No parent, the return value cannot possibly be used */
208
Len Brown4be44fc2005-08-05 00:44:28 -0400209 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
210 "At Method level, result of [%s] not used\n",
211 acpi_ps_get_opcode_name(op->common.
212 aml_opcode)));
Bob Moore7b891692012-12-31 00:06:16 +0000213 return_VALUE(FALSE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 }
215
216 /* Get info on the parent. The root_op is AML_SCOPE */
217
Len Brown4be44fc2005-08-05 00:44:28 -0400218 parent_info =
219 acpi_ps_get_opcode_info(op->common.parent->common.aml_opcode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 if (parent_info->class == AML_CLASS_UNKNOWN) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500221 ACPI_ERROR((AE_INFO, "Unknown parent opcode Op=%p", op));
Bob Moore7b891692012-12-31 00:06:16 +0000222 return_VALUE(FALSE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 }
224
225 /*
Bob Moore73a30902012-10-31 02:26:55 +0000226 * Decide what to do with the result based on the parent. If
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 * the parent opcode will not use the result, delete the object.
228 * Otherwise leave it as is, it will be deleted when it is used
229 * as an operand later.
230 */
231 switch (parent_info->class) {
232 case AML_CLASS_CONTROL:
233
234 switch (op->common.parent->common.aml_opcode) {
235 case AML_RETURN_OP:
236
237 /* Never delete the return value associated with a return opcode */
238
239 goto result_used;
240
241 case AML_IF_OP:
242 case AML_WHILE_OP:
243
244 /*
245 * If we are executing the predicate AND this is the predicate op,
246 * we will use the return value
247 */
Len Brown4be44fc2005-08-05 00:44:28 -0400248 if ((walk_state->control_state->common.state ==
249 ACPI_CONTROL_PREDICATE_EXECUTING)
250 && (walk_state->control_state->control.
251 predicate_op == op)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 goto result_used;
253 }
254 break;
255
256 default:
257 /* Ignore other control opcodes */
258 break;
259 }
260
261 /* The general control opcode returns no result */
262
263 goto result_not_used;
264
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 case AML_CLASS_CREATE:
266
267 /*
268 * These opcodes allow term_arg(s) as operands and therefore
Bob Moore73a30902012-10-31 02:26:55 +0000269 * the operands can be method calls. The result is used.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270 */
271 goto result_used;
272
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 case AML_CLASS_NAMED_OBJECT:
274
Len Brown4be44fc2005-08-05 00:44:28 -0400275 if ((op->common.parent->common.aml_opcode == AML_REGION_OP) ||
276 (op->common.parent->common.aml_opcode == AML_DATA_REGION_OP)
277 || (op->common.parent->common.aml_opcode == AML_PACKAGE_OP)
278 || (op->common.parent->common.aml_opcode ==
279 AML_VAR_PACKAGE_OP)
280 || (op->common.parent->common.aml_opcode == AML_BUFFER_OP)
281 || (op->common.parent->common.aml_opcode ==
Lin Mingef805d92008-04-10 19:06:41 +0400282 AML_INT_EVAL_SUBTREE_OP)
283 || (op->common.parent->common.aml_opcode ==
284 AML_BANK_FIELD_OP)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285 /*
286 * These opcodes allow term_arg(s) as operands and therefore
Bob Moore73a30902012-10-31 02:26:55 +0000287 * the operands can be method calls. The result is used.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 */
289 goto result_used;
290 }
291
292 goto result_not_used;
293
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 default:
295
296 /*
297 * In all other cases. the parent will actually use the return
298 * object, so keep it.
299 */
300 goto result_used;
301 }
302
Len Brown4be44fc2005-08-05 00:44:28 -0400303 result_used:
304 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
305 "Result of [%s] used by Parent [%s] Op=%p\n",
306 acpi_ps_get_opcode_name(op->common.aml_opcode),
307 acpi_ps_get_opcode_name(op->common.parent->common.
308 aml_opcode), op));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309
Bob Moore7b891692012-12-31 00:06:16 +0000310 return_VALUE(TRUE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311
Len Brown4be44fc2005-08-05 00:44:28 -0400312 result_not_used:
313 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
314 "Result of [%s] not used by Parent [%s] Op=%p\n",
315 acpi_ps_get_opcode_name(op->common.aml_opcode),
316 acpi_ps_get_opcode_name(op->common.parent->common.
317 aml_opcode), op));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318
Bob Moore7b891692012-12-31 00:06:16 +0000319 return_VALUE(FALSE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320}
321
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322/*******************************************************************************
323 *
324 * FUNCTION: acpi_ds_delete_result_if_not_used
325 *
Bob Mooreba494be2012-07-12 09:40:10 +0800326 * PARAMETERS: op - Current parse Op
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 * result_obj - Result of the operation
328 * walk_state - Current state
329 *
330 * RETURN: Status
331 *
Bob Moore73a30902012-10-31 02:26:55 +0000332 * DESCRIPTION: Used after interpretation of an opcode. If there is an internal
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 * result descriptor, check if the parent opcode will actually use
Bob Moore73a30902012-10-31 02:26:55 +0000334 * this result. If not, delete the result now so that it will
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 * not become orphaned.
336 *
337 ******************************************************************************/
338
339void
Len Brown4be44fc2005-08-05 00:44:28 -0400340acpi_ds_delete_result_if_not_used(union acpi_parse_object *op,
341 union acpi_operand_object *result_obj,
342 struct acpi_walk_state *walk_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343{
Len Brown4be44fc2005-08-05 00:44:28 -0400344 union acpi_operand_object *obj_desc;
345 acpi_status status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346
Bob Mooreb229cf92006-04-21 17:15:00 -0400347 ACPI_FUNCTION_TRACE_PTR(ds_delete_result_if_not_used, result_obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348
349 if (!op) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500350 ACPI_ERROR((AE_INFO, "Null Op"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 return_VOID;
352 }
353
354 if (!result_obj) {
355 return_VOID;
356 }
357
Len Brown4be44fc2005-08-05 00:44:28 -0400358 if (!acpi_ds_is_result_used(op, walk_state)) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400359
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360 /* Must pop the result stack (obj_desc should be equal to result_obj) */
361
Len Brown4be44fc2005-08-05 00:44:28 -0400362 status = acpi_ds_result_pop(&obj_desc, walk_state);
363 if (ACPI_SUCCESS(status)) {
364 acpi_ut_remove_reference(result_obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700365 }
366 }
367
368 return_VOID;
369}
370
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371/*******************************************************************************
372 *
373 * FUNCTION: acpi_ds_resolve_operands
374 *
375 * PARAMETERS: walk_state - Current walk state with operands on stack
376 *
377 * RETURN: Status
378 *
Bob Moore73a30902012-10-31 02:26:55 +0000379 * DESCRIPTION: Resolve all operands to their values. Used to prepare
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380 * arguments to a control method invocation (a call from one
381 * method to another.)
382 *
383 ******************************************************************************/
384
Len Brown4be44fc2005-08-05 00:44:28 -0400385acpi_status acpi_ds_resolve_operands(struct acpi_walk_state *walk_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386{
Len Brown4be44fc2005-08-05 00:44:28 -0400387 u32 i;
388 acpi_status status = AE_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389
Bob Mooreb229cf92006-04-21 17:15:00 -0400390 ACPI_FUNCTION_TRACE_PTR(ds_resolve_operands, walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391
392 /*
393 * Attempt to resolve each of the valid operands
Bob Moore73a30902012-10-31 02:26:55 +0000394 * Method arguments are passed by reference, not by value. This means
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395 * that the actual objects are passed, not copies of the objects.
396 */
397 for (i = 0; i < walk_state->num_operands; i++) {
Len Brown4be44fc2005-08-05 00:44:28 -0400398 status =
399 acpi_ex_resolve_to_value(&walk_state->operands[i],
400 walk_state);
401 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 break;
403 }
404 }
405
Len Brown4be44fc2005-08-05 00:44:28 -0400406 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407}
408
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409/*******************************************************************************
410 *
411 * FUNCTION: acpi_ds_clear_operands
412 *
413 * PARAMETERS: walk_state - Current walk state with operands on stack
414 *
415 * RETURN: None
416 *
417 * DESCRIPTION: Clear all operands on the current walk state operand stack.
418 *
419 ******************************************************************************/
420
Len Brown4be44fc2005-08-05 00:44:28 -0400421void acpi_ds_clear_operands(struct acpi_walk_state *walk_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422{
Len Brown4be44fc2005-08-05 00:44:28 -0400423 u32 i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424
Bob Mooreb229cf92006-04-21 17:15:00 -0400425 ACPI_FUNCTION_TRACE_PTR(ds_clear_operands, walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426
427 /* Remove a reference on each operand on the stack */
428
429 for (i = 0; i < walk_state->num_operands; i++) {
430 /*
431 * Remove a reference to all operands, including both
432 * "Arguments" and "Targets".
433 */
Len Brown4be44fc2005-08-05 00:44:28 -0400434 acpi_ut_remove_reference(walk_state->operands[i]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 walk_state->operands[i] = NULL;
436 }
437
438 walk_state->num_operands = 0;
439 return_VOID;
440}
441#endif
442
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443/*******************************************************************************
444 *
445 * FUNCTION: acpi_ds_create_operand
446 *
447 * PARAMETERS: walk_state - Current walk state
Bob Mooreba494be2012-07-12 09:40:10 +0800448 * arg - Parse object for the argument
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449 * arg_index - Which argument (zero based)
450 *
451 * RETURN: Status
452 *
453 * DESCRIPTION: Translate a parse tree object that is an argument to an AML
Bob Moore73a30902012-10-31 02:26:55 +0000454 * opcode to the equivalent interpreter object. This may include
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 * looking up a name or entering a new name into the internal
456 * namespace.
457 *
458 ******************************************************************************/
459
460acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400461acpi_ds_create_operand(struct acpi_walk_state *walk_state,
462 union acpi_parse_object *arg, u32 arg_index)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463{
Len Brown4be44fc2005-08-05 00:44:28 -0400464 acpi_status status = AE_OK;
465 char *name_string;
466 u32 name_length;
467 union acpi_operand_object *obj_desc;
468 union acpi_parse_object *parent_op;
469 u16 opcode;
470 acpi_interpreter_mode interpreter_mode;
471 const struct acpi_opcode_info *op_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472
Bob Mooreb229cf92006-04-21 17:15:00 -0400473 ACPI_FUNCTION_TRACE_PTR(ds_create_operand, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474
475 /* A valid name must be looked up in the namespace */
476
477 if ((arg->common.aml_opcode == AML_INT_NAMEPATH_OP) &&
Bob Moore4e3156b2008-04-10 19:06:37 +0400478 (arg->common.value.string) &&
479 !(arg->common.flags & ACPI_PARSEOP_IN_STACK)) {
Len Brown4be44fc2005-08-05 00:44:28 -0400480 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, "Getting a name: Arg=%p\n",
481 arg));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482
483 /* Get the entire name string from the AML stream */
484
Len Brown4be44fc2005-08-05 00:44:28 -0400485 status =
486 acpi_ex_get_name_string(ACPI_TYPE_ANY,
487 arg->common.value.buffer,
488 &name_string, &name_length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489
Len Brown4be44fc2005-08-05 00:44:28 -0400490 if (ACPI_FAILURE(status)) {
491 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 }
493
494 /* All prefixes have been handled, and the name is in name_string */
495
496 /*
497 * Special handling for buffer_field declarations. This is a deferred
498 * opcode that unfortunately defines the field name as the last
Bob Moore73a30902012-10-31 02:26:55 +0000499 * parameter instead of the first. We get here when we are performing
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 * the deferred execution, so the actual name of the field is already
Bob Moore73a30902012-10-31 02:26:55 +0000501 * in the namespace. We don't want to attempt to look it up again
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 * because we may be executing in a different scope than where the
503 * actual opcode exists.
504 */
505 if ((walk_state->deferred_node) &&
Len Brown4be44fc2005-08-05 00:44:28 -0400506 (walk_state->deferred_node->type == ACPI_TYPE_BUFFER_FIELD)
Bob Moore52fc0b02006-10-02 00:00:00 -0400507 && (arg_index ==
508 (u32) ((walk_state->opcode ==
509 AML_CREATE_FIELD_OP) ? 3 : 2))) {
Len Brown4be44fc2005-08-05 00:44:28 -0400510 obj_desc =
511 ACPI_CAST_PTR(union acpi_operand_object,
512 walk_state->deferred_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 status = AE_OK;
Len Brown4be44fc2005-08-05 00:44:28 -0400514 } else { /* All other opcodes */
515
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516 /*
517 * Differentiate between a namespace "create" operation
518 * versus a "lookup" operation (IMODE_LOAD_PASS2 vs.
519 * IMODE_EXECUTE) in order to support the creation of
520 * namespace objects during the execution of control methods.
521 */
522 parent_op = arg->common.parent;
Len Brown4be44fc2005-08-05 00:44:28 -0400523 op_info =
524 acpi_ps_get_opcode_info(parent_op->common.
525 aml_opcode);
526 if ((op_info->flags & AML_NSNODE)
527 && (parent_op->common.aml_opcode !=
528 AML_INT_METHODCALL_OP)
529 && (parent_op->common.aml_opcode != AML_REGION_OP)
530 && (parent_op->common.aml_opcode !=
531 AML_INT_NAMEPATH_OP)) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400532
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 /* Enter name into namespace if not found */
534
535 interpreter_mode = ACPI_IMODE_LOAD_PASS2;
Len Brown4be44fc2005-08-05 00:44:28 -0400536 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 /* Return a failure if name not found */
538
539 interpreter_mode = ACPI_IMODE_EXECUTE;
540 }
541
Len Brown4be44fc2005-08-05 00:44:28 -0400542 status =
543 acpi_ns_lookup(walk_state->scope_info, name_string,
544 ACPI_TYPE_ANY, interpreter_mode,
545 ACPI_NS_SEARCH_PARENT |
546 ACPI_NS_DONT_OPEN_SCOPE, walk_state,
547 ACPI_CAST_INDIRECT_PTR(struct
548 acpi_namespace_node,
549 &obj_desc));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 /*
551 * The only case where we pass through (ignore) a NOT_FOUND
552 * error is for the cond_ref_of opcode.
553 */
554 if (status == AE_NOT_FOUND) {
Len Brown4be44fc2005-08-05 00:44:28 -0400555 if (parent_op->common.aml_opcode ==
556 AML_COND_REF_OF_OP) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 /*
558 * For the Conditional Reference op, it's OK if
559 * the name is not found; We just need a way to
560 * indicate this to the interpreter, set the
561 * object to the root
562 */
Lv Zheng1f86e8c2012-10-31 02:25:45 +0000563 obj_desc =
564 ACPI_CAST_PTR(union
Len Brownfd350942007-05-09 23:34:35 -0400565 acpi_operand_object,
566 acpi_gbl_root_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 status = AE_OK;
Len Brown4be44fc2005-08-05 00:44:28 -0400568 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 /*
570 * We just plain didn't find it -- which is a
571 * very serious error at this point
572 */
573 status = AE_AML_NAME_NOT_FOUND;
574 }
575 }
576
Len Brown4be44fc2005-08-05 00:44:28 -0400577 if (ACPI_FAILURE(status)) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500578 ACPI_ERROR_NAMESPACE(name_string, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 }
580 }
581
582 /* Free the namestring created above */
583
Bob Moore83135242006-10-03 00:00:00 -0400584 ACPI_FREE(name_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585
586 /* Check status from the lookup */
587
Len Brown4be44fc2005-08-05 00:44:28 -0400588 if (ACPI_FAILURE(status)) {
589 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 }
591
592 /* Put the resulting object onto the current object stack */
593
Len Brown4be44fc2005-08-05 00:44:28 -0400594 status = acpi_ds_obj_stack_push(obj_desc, walk_state);
595 if (ACPI_FAILURE(status)) {
596 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 }
Len Brown4be44fc2005-08-05 00:44:28 -0400598 ACPI_DEBUGGER_EXEC(acpi_db_display_argument_object
599 (obj_desc, walk_state));
600 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 /* Check for null name case */
602
Bob Moore4e3156b2008-04-10 19:06:37 +0400603 if ((arg->common.aml_opcode == AML_INT_NAMEPATH_OP) &&
604 !(arg->common.flags & ACPI_PARSEOP_IN_STACK)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 /*
606 * If the name is null, this means that this is an
607 * optional result parameter that was not specified
Bob Moore73a30902012-10-31 02:26:55 +0000608 * in the original ASL. Create a Zero Constant for a
609 * placeholder. (Store to a constant is a Noop.)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610 */
Len Brown4be44fc2005-08-05 00:44:28 -0400611 opcode = AML_ZERO_OP; /* Has no arguments! */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612
Len Brown4be44fc2005-08-05 00:44:28 -0400613 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
614 "Null namepath: Arg=%p\n", arg));
615 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 opcode = arg->common.aml_opcode;
617 }
618
619 /* Get the object type of the argument */
620
Len Brown4be44fc2005-08-05 00:44:28 -0400621 op_info = acpi_ps_get_opcode_info(opcode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 if (op_info->object_type == ACPI_TYPE_INVALID) {
Len Brown4be44fc2005-08-05 00:44:28 -0400623 return_ACPI_STATUS(AE_NOT_IMPLEMENTED);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 }
625
Bob Moore4e3156b2008-04-10 19:06:37 +0400626 if ((op_info->flags & AML_HAS_RETVAL)
627 || (arg->common.flags & ACPI_PARSEOP_IN_STACK)) {
Len Brown4be44fc2005-08-05 00:44:28 -0400628 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
Bob Moore50eca3e2005-09-30 19:03:00 -0400629 "Argument previously created, already stacked\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630
Len Brown4be44fc2005-08-05 00:44:28 -0400631 ACPI_DEBUGGER_EXEC(acpi_db_display_argument_object
632 (walk_state->
633 operands[walk_state->num_operands -
634 1], walk_state));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635
636 /*
637 * Use value that was already previously returned
638 * by the evaluation of this argument
639 */
Bob Moore773069d2008-04-10 19:06:36 +0400640 status = acpi_ds_result_pop(&obj_desc, walk_state);
Len Brown4be44fc2005-08-05 00:44:28 -0400641 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 /*
643 * Only error is underflow, and this indicates
644 * a missing or null operand!
645 */
Bob Mooreb8e4d892006-01-27 16:43:00 -0500646 ACPI_EXCEPTION((AE_INFO, status,
647 "Missing or null operand"));
Len Brown4be44fc2005-08-05 00:44:28 -0400648 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700649 }
Len Brown4be44fc2005-08-05 00:44:28 -0400650 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651 /* Create an ACPI_INTERNAL_OBJECT for the argument */
652
Len Brown4be44fc2005-08-05 00:44:28 -0400653 obj_desc =
654 acpi_ut_create_internal_object(op_info->
655 object_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 if (!obj_desc) {
Len Brown4be44fc2005-08-05 00:44:28 -0400657 return_ACPI_STATUS(AE_NO_MEMORY);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 }
659
660 /* Initialize the new object */
661
Len Brown4be44fc2005-08-05 00:44:28 -0400662 status =
663 acpi_ds_init_object_from_op(walk_state, arg, opcode,
664 &obj_desc);
665 if (ACPI_FAILURE(status)) {
666 acpi_ut_delete_object_desc(obj_desc);
667 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 }
669 }
670
671 /* Put the operand object on the object stack */
672
Len Brown4be44fc2005-08-05 00:44:28 -0400673 status = acpi_ds_obj_stack_push(obj_desc, walk_state);
674 if (ACPI_FAILURE(status)) {
675 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 }
677
Len Brown4be44fc2005-08-05 00:44:28 -0400678 ACPI_DEBUGGER_EXEC(acpi_db_display_argument_object
679 (obj_desc, walk_state));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680 }
681
Len Brown4be44fc2005-08-05 00:44:28 -0400682 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683}
684
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685/*******************************************************************************
686 *
687 * FUNCTION: acpi_ds_create_operands
688 *
689 * PARAMETERS: walk_state - Current state
690 * first_arg - First argument of a parser argument tree
691 *
692 * RETURN: Status
693 *
694 * DESCRIPTION: Convert an operator's arguments from a parse tree format to
695 * namespace objects and place those argument object on the object
696 * stack in preparation for evaluation by the interpreter.
697 *
698 ******************************************************************************/
699
700acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400701acpi_ds_create_operands(struct acpi_walk_state *walk_state,
702 union acpi_parse_object *first_arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703{
Len Brown4be44fc2005-08-05 00:44:28 -0400704 acpi_status status = AE_OK;
705 union acpi_parse_object *arg;
Bob Moore773069d2008-04-10 19:06:36 +0400706 union acpi_parse_object *arguments[ACPI_OBJ_NUM_OPERANDS];
Bob Mooreb7f9f042008-04-10 19:06:40 +0400707 u32 arg_count = 0;
708 u32 index = walk_state->num_operands;
709 u32 i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710
Bob Mooreb229cf92006-04-21 17:15:00 -0400711 ACPI_FUNCTION_TRACE_PTR(ds_create_operands, first_arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712
Bob Moore773069d2008-04-10 19:06:36 +0400713 /* Get all arguments in the list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714
715 arg = first_arg;
716 while (arg) {
Bob Moore773069d2008-04-10 19:06:36 +0400717 if (index >= ACPI_OBJ_NUM_OPERANDS) {
718 return_ACPI_STATUS(AE_BAD_DATA);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719 }
720
Bob Moore773069d2008-04-10 19:06:36 +0400721 arguments[index] = arg;
722 walk_state->operands[index] = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723
724 /* Move on to next argument, if any */
725
726 arg = arg->common.next;
727 arg_count++;
Bob Moore773069d2008-04-10 19:06:36 +0400728 index++;
729 }
730
731 index--;
732
733 /* It is the appropriate order to get objects from the Result stack */
734
735 for (i = 0; i < arg_count; i++) {
736 arg = arguments[index];
737
738 /* Force the filling of the operand stack in inverse order */
739
Bob Mooreb7f9f042008-04-10 19:06:40 +0400740 walk_state->operand_index = (u8) index;
Bob Moore773069d2008-04-10 19:06:36 +0400741
742 status = acpi_ds_create_operand(walk_state, arg, index);
743 if (ACPI_FAILURE(status)) {
744 goto cleanup;
745 }
746
Bob Moore773069d2008-04-10 19:06:36 +0400747 index--;
748
749 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
Bob Mooreb27d6592010-05-26 11:47:13 +0800750 "Arg #%u (%p) done, Arg1=%p\n", index, arg,
Bob Moore773069d2008-04-10 19:06:36 +0400751 first_arg));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 }
753
Len Brown4be44fc2005-08-05 00:44:28 -0400754 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755
Len Brown4be44fc2005-08-05 00:44:28 -0400756 cleanup:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757 /*
758 * We must undo everything done above; meaning that we must
759 * pop everything off of the operand stack and delete those
760 * objects
761 */
Bob Moore773069d2008-04-10 19:06:36 +0400762 acpi_ds_obj_stack_pop_and_delete(arg_count, walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763
Bob Mooreb27d6592010-05-26 11:47:13 +0800764 ACPI_EXCEPTION((AE_INFO, status, "While creating Arg %u", index));
Len Brown4be44fc2005-08-05 00:44:28 -0400765 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766}
Bob Moore4e3156b2008-04-10 19:06:37 +0400767
768/*****************************************************************************
769 *
770 * FUNCTION: acpi_ds_evaluate_name_path
771 *
772 * PARAMETERS: walk_state - Current state of the parse tree walk,
773 * the opcode of current operation should be
774 * AML_INT_NAMEPATH_OP
775 *
776 * RETURN: Status
777 *
778 * DESCRIPTION: Translate the -name_path- parse tree object to the equivalent
779 * interpreter object, convert it to value, if needed, duplicate
780 * it, if needed, and push it onto the current result stack.
781 *
782 ****************************************************************************/
783
784acpi_status acpi_ds_evaluate_name_path(struct acpi_walk_state *walk_state)
785{
786 acpi_status status = AE_OK;
787 union acpi_parse_object *op = walk_state->op;
788 union acpi_operand_object **operand = &walk_state->operands[0];
789 union acpi_operand_object *new_obj_desc;
790 u8 type;
791
792 ACPI_FUNCTION_TRACE_PTR(ds_evaluate_name_path, walk_state);
793
794 if (!op->common.parent) {
795
796 /* This happens after certain exception processing */
797
798 goto exit;
799 }
800
801 if ((op->common.parent->common.aml_opcode == AML_PACKAGE_OP) ||
802 (op->common.parent->common.aml_opcode == AML_VAR_PACKAGE_OP) ||
803 (op->common.parent->common.aml_opcode == AML_REF_OF_OP)) {
804
805 /* TBD: Should we specify this feature as a bit of op_info->Flags of these opcodes? */
806
807 goto exit;
808 }
809
810 status = acpi_ds_create_operand(walk_state, op, 0);
811 if (ACPI_FAILURE(status)) {
812 goto exit;
813 }
814
815 if (op->common.flags & ACPI_PARSEOP_TARGET) {
816 new_obj_desc = *operand;
817 goto push_result;
818 }
819
Bob Moore3371c192009-02-18 14:44:03 +0800820 type = (*operand)->common.type;
Bob Moore4e3156b2008-04-10 19:06:37 +0400821
822 status = acpi_ex_resolve_to_value(operand, walk_state);
823 if (ACPI_FAILURE(status)) {
824 goto exit;
825 }
826
827 if (type == ACPI_TYPE_INTEGER) {
828
829 /* It was incremented by acpi_ex_resolve_to_value */
830
831 acpi_ut_remove_reference(*operand);
832
833 status =
834 acpi_ut_copy_iobject_to_iobject(*operand, &new_obj_desc,
835 walk_state);
836 if (ACPI_FAILURE(status)) {
837 goto exit;
838 }
839 } else {
840 /*
841 * The object either was anew created or is
842 * a Namespace node - don't decrement it.
843 */
844 new_obj_desc = *operand;
845 }
846
847 /* Cleanup for name-path operand */
848
849 status = acpi_ds_obj_stack_pop(1, walk_state);
850 if (ACPI_FAILURE(status)) {
851 walk_state->result_obj = new_obj_desc;
852 goto exit;
853 }
854
855 push_result:
856
857 walk_state->result_obj = new_obj_desc;
858
859 status = acpi_ds_result_push(walk_state->result_obj, walk_state);
860 if (ACPI_SUCCESS(status)) {
861
862 /* Force to take it from stack */
863
864 op->common.flags |= ACPI_PARSEOP_IN_STACK;
865 }
866
867 exit:
868
869 return_ACPI_STATUS(status);
870}