blob: d7f53fb2979ab9a602f11af4a9a1478e60f59c3d [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 Moorefd1af712013-03-08 09:22:23 +0000181 return_UINT8(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 Moorefd1af712013-03-08 09:22:23 +0000213 return_UINT8(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 Moorefd1af712013-03-08 09:22:23 +0000222 return_UINT8(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:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243 /*
244 * If we are executing the predicate AND this is the predicate op,
245 * we will use the return value
246 */
Len Brown4be44fc2005-08-05 00:44:28 -0400247 if ((walk_state->control_state->common.state ==
248 ACPI_CONTROL_PREDICATE_EXECUTING)
249 && (walk_state->control_state->control.
250 predicate_op == op)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251 goto result_used;
252 }
253 break;
254
255 default:
Chao Guan1d1ea1b2013-06-08 00:58:14 +0000256
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 /* Ignore other control opcodes */
Chao Guan1d1ea1b2013-06-08 00:58:14 +0000258
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259 break;
260 }
261
262 /* The general control opcode returns no result */
263
264 goto result_not_used;
265
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 case AML_CLASS_CREATE:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 /*
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:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 /*
296 * In all other cases. the parent will actually use the return
297 * object, so keep it.
298 */
299 goto result_used;
300 }
301
Lv Zheng10622bf2013-10-29 09:30:02 +0800302result_used:
Len Brown4be44fc2005-08-05 00:44:28 -0400303 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
304 "Result of [%s] used by Parent [%s] Op=%p\n",
305 acpi_ps_get_opcode_name(op->common.aml_opcode),
306 acpi_ps_get_opcode_name(op->common.parent->common.
307 aml_opcode), op));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308
Bob Moorefd1af712013-03-08 09:22:23 +0000309 return_UINT8(TRUE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310
Lv Zheng10622bf2013-10-29 09:30:02 +0800311result_not_used:
Len Brown4be44fc2005-08-05 00:44:28 -0400312 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
313 "Result of [%s] not used by Parent [%s] Op=%p\n",
314 acpi_ps_get_opcode_name(op->common.aml_opcode),
315 acpi_ps_get_opcode_name(op->common.parent->common.
316 aml_opcode), op));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700317
Bob Moorefd1af712013-03-08 09:22:23 +0000318 return_UINT8(FALSE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319}
320
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321/*******************************************************************************
322 *
323 * FUNCTION: acpi_ds_delete_result_if_not_used
324 *
Bob Mooreba494be2012-07-12 09:40:10 +0800325 * PARAMETERS: op - Current parse Op
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 * result_obj - Result of the operation
327 * walk_state - Current state
328 *
329 * RETURN: Status
330 *
Bob Moore73a30902012-10-31 02:26:55 +0000331 * DESCRIPTION: Used after interpretation of an opcode. If there is an internal
Linus Torvalds1da177e2005-04-16 15:20:36 -0700332 * result descriptor, check if the parent opcode will actually use
Bob Moore73a30902012-10-31 02:26:55 +0000333 * this result. If not, delete the result now so that it will
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 * not become orphaned.
335 *
336 ******************************************************************************/
337
338void
Len Brown4be44fc2005-08-05 00:44:28 -0400339acpi_ds_delete_result_if_not_used(union acpi_parse_object *op,
340 union acpi_operand_object *result_obj,
341 struct acpi_walk_state *walk_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342{
Len Brown4be44fc2005-08-05 00:44:28 -0400343 union acpi_operand_object *obj_desc;
344 acpi_status status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345
Bob Mooreb229cf92006-04-21 17:15:00 -0400346 ACPI_FUNCTION_TRACE_PTR(ds_delete_result_if_not_used, result_obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347
348 if (!op) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500349 ACPI_ERROR((AE_INFO, "Null Op"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 return_VOID;
351 }
352
353 if (!result_obj) {
354 return_VOID;
355 }
356
Len Brown4be44fc2005-08-05 00:44:28 -0400357 if (!acpi_ds_is_result_used(op, walk_state)) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400358
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 /* Must pop the result stack (obj_desc should be equal to result_obj) */
360
Len Brown4be44fc2005-08-05 00:44:28 -0400361 status = acpi_ds_result_pop(&obj_desc, walk_state);
362 if (ACPI_SUCCESS(status)) {
363 acpi_ut_remove_reference(result_obj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 }
365 }
366
367 return_VOID;
368}
369
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370/*******************************************************************************
371 *
372 * FUNCTION: acpi_ds_resolve_operands
373 *
374 * PARAMETERS: walk_state - Current walk state with operands on stack
375 *
376 * RETURN: Status
377 *
Bob Moore73a30902012-10-31 02:26:55 +0000378 * DESCRIPTION: Resolve all operands to their values. Used to prepare
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379 * arguments to a control method invocation (a call from one
380 * method to another.)
381 *
382 ******************************************************************************/
383
Len Brown4be44fc2005-08-05 00:44:28 -0400384acpi_status acpi_ds_resolve_operands(struct acpi_walk_state *walk_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385{
Len Brown4be44fc2005-08-05 00:44:28 -0400386 u32 i;
387 acpi_status status = AE_OK;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388
Bob Mooreb229cf92006-04-21 17:15:00 -0400389 ACPI_FUNCTION_TRACE_PTR(ds_resolve_operands, walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390
391 /*
392 * Attempt to resolve each of the valid operands
Bob Moore73a30902012-10-31 02:26:55 +0000393 * Method arguments are passed by reference, not by value. This means
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 * that the actual objects are passed, not copies of the objects.
395 */
396 for (i = 0; i < walk_state->num_operands; i++) {
Len Brown4be44fc2005-08-05 00:44:28 -0400397 status =
398 acpi_ex_resolve_to_value(&walk_state->operands[i],
399 walk_state);
400 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 break;
402 }
403 }
404
Len Brown4be44fc2005-08-05 00:44:28 -0400405 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406}
407
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408/*******************************************************************************
409 *
410 * FUNCTION: acpi_ds_clear_operands
411 *
412 * PARAMETERS: walk_state - Current walk state with operands on stack
413 *
414 * RETURN: None
415 *
416 * DESCRIPTION: Clear all operands on the current walk state operand stack.
417 *
418 ******************************************************************************/
419
Len Brown4be44fc2005-08-05 00:44:28 -0400420void acpi_ds_clear_operands(struct acpi_walk_state *walk_state)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421{
Len Brown4be44fc2005-08-05 00:44:28 -0400422 u32 i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423
Bob Mooreb229cf92006-04-21 17:15:00 -0400424 ACPI_FUNCTION_TRACE_PTR(ds_clear_operands, walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425
426 /* Remove a reference on each operand on the stack */
427
428 for (i = 0; i < walk_state->num_operands; i++) {
429 /*
430 * Remove a reference to all operands, including both
431 * "Arguments" and "Targets".
432 */
Len Brown4be44fc2005-08-05 00:44:28 -0400433 acpi_ut_remove_reference(walk_state->operands[i]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 walk_state->operands[i] = NULL;
435 }
436
437 walk_state->num_operands = 0;
438 return_VOID;
439}
440#endif
441
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442/*******************************************************************************
443 *
444 * FUNCTION: acpi_ds_create_operand
445 *
446 * PARAMETERS: walk_state - Current walk state
Bob Mooreba494be2012-07-12 09:40:10 +0800447 * arg - Parse object for the argument
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 * arg_index - Which argument (zero based)
449 *
450 * RETURN: Status
451 *
452 * DESCRIPTION: Translate a parse tree object that is an argument to an AML
Bob Moore73a30902012-10-31 02:26:55 +0000453 * opcode to the equivalent interpreter object. This may include
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 * looking up a name or entering a new name into the internal
455 * namespace.
456 *
457 ******************************************************************************/
458
459acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400460acpi_ds_create_operand(struct acpi_walk_state *walk_state,
461 union acpi_parse_object *arg, u32 arg_index)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462{
Len Brown4be44fc2005-08-05 00:44:28 -0400463 acpi_status status = AE_OK;
464 char *name_string;
465 u32 name_length;
466 union acpi_operand_object *obj_desc;
467 union acpi_parse_object *parent_op;
468 u16 opcode;
469 acpi_interpreter_mode interpreter_mode;
470 const struct acpi_opcode_info *op_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471
Bob Mooreb229cf92006-04-21 17:15:00 -0400472 ACPI_FUNCTION_TRACE_PTR(ds_create_operand, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473
474 /* A valid name must be looked up in the namespace */
475
476 if ((arg->common.aml_opcode == AML_INT_NAMEPATH_OP) &&
Bob Moore4e3156b2008-04-10 19:06:37 +0400477 (arg->common.value.string) &&
478 !(arg->common.flags & ACPI_PARSEOP_IN_STACK)) {
Len Brown4be44fc2005-08-05 00:44:28 -0400479 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH, "Getting a name: Arg=%p\n",
480 arg));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481
482 /* Get the entire name string from the AML stream */
483
Len Brown4be44fc2005-08-05 00:44:28 -0400484 status =
485 acpi_ex_get_name_string(ACPI_TYPE_ANY,
486 arg->common.value.buffer,
487 &name_string, &name_length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488
Len Brown4be44fc2005-08-05 00:44:28 -0400489 if (ACPI_FAILURE(status)) {
490 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 }
492
493 /* All prefixes have been handled, and the name is in name_string */
494
495 /*
496 * Special handling for buffer_field declarations. This is a deferred
497 * opcode that unfortunately defines the field name as the last
Bob Moore73a30902012-10-31 02:26:55 +0000498 * parameter instead of the first. We get here when we are performing
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 * the deferred execution, so the actual name of the field is already
Bob Moore73a30902012-10-31 02:26:55 +0000500 * in the namespace. We don't want to attempt to look it up again
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501 * because we may be executing in a different scope than where the
502 * actual opcode exists.
503 */
504 if ((walk_state->deferred_node) &&
Len Brown4be44fc2005-08-05 00:44:28 -0400505 (walk_state->deferred_node->type == ACPI_TYPE_BUFFER_FIELD)
Bob Moore52fc0b02006-10-02 00:00:00 -0400506 && (arg_index ==
507 (u32) ((walk_state->opcode ==
508 AML_CREATE_FIELD_OP) ? 3 : 2))) {
Len Brown4be44fc2005-08-05 00:44:28 -0400509 obj_desc =
510 ACPI_CAST_PTR(union acpi_operand_object,
511 walk_state->deferred_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 status = AE_OK;
Len Brown4be44fc2005-08-05 00:44:28 -0400513 } else { /* All other opcodes */
514
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515 /*
516 * Differentiate between a namespace "create" operation
517 * versus a "lookup" operation (IMODE_LOAD_PASS2 vs.
518 * IMODE_EXECUTE) in order to support the creation of
519 * namespace objects during the execution of control methods.
520 */
521 parent_op = arg->common.parent;
Len Brown4be44fc2005-08-05 00:44:28 -0400522 op_info =
523 acpi_ps_get_opcode_info(parent_op->common.
524 aml_opcode);
525 if ((op_info->flags & AML_NSNODE)
526 && (parent_op->common.aml_opcode !=
527 AML_INT_METHODCALL_OP)
528 && (parent_op->common.aml_opcode != AML_REGION_OP)
529 && (parent_op->common.aml_opcode !=
530 AML_INT_NAMEPATH_OP)) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400531
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 /* Enter name into namespace if not found */
533
534 interpreter_mode = ACPI_IMODE_LOAD_PASS2;
Len Brown4be44fc2005-08-05 00:44:28 -0400535 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 /* Return a failure if name not found */
537
538 interpreter_mode = ACPI_IMODE_EXECUTE;
539 }
540
Len Brown4be44fc2005-08-05 00:44:28 -0400541 status =
542 acpi_ns_lookup(walk_state->scope_info, name_string,
543 ACPI_TYPE_ANY, interpreter_mode,
544 ACPI_NS_SEARCH_PARENT |
545 ACPI_NS_DONT_OPEN_SCOPE, walk_state,
546 ACPI_CAST_INDIRECT_PTR(struct
547 acpi_namespace_node,
548 &obj_desc));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549 /*
550 * The only case where we pass through (ignore) a NOT_FOUND
551 * error is for the cond_ref_of opcode.
552 */
553 if (status == AE_NOT_FOUND) {
Len Brown4be44fc2005-08-05 00:44:28 -0400554 if (parent_op->common.aml_opcode ==
555 AML_COND_REF_OF_OP) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556 /*
557 * For the Conditional Reference op, it's OK if
558 * the name is not found; We just need a way to
559 * indicate this to the interpreter, set the
560 * object to the root
561 */
Lv Zheng1f86e8c2012-10-31 02:25:45 +0000562 obj_desc =
563 ACPI_CAST_PTR(union
Len Brownfd350942007-05-09 23:34:35 -0400564 acpi_operand_object,
565 acpi_gbl_root_node);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 status = AE_OK;
Len Brown4be44fc2005-08-05 00:44:28 -0400567 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 /*
569 * We just plain didn't find it -- which is a
570 * very serious error at this point
571 */
572 status = AE_AML_NAME_NOT_FOUND;
573 }
574 }
575
Len Brown4be44fc2005-08-05 00:44:28 -0400576 if (ACPI_FAILURE(status)) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500577 ACPI_ERROR_NAMESPACE(name_string, status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578 }
579 }
580
581 /* Free the namestring created above */
582
Bob Moore83135242006-10-03 00:00:00 -0400583 ACPI_FREE(name_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584
585 /* Check status from the lookup */
586
Len Brown4be44fc2005-08-05 00:44:28 -0400587 if (ACPI_FAILURE(status)) {
588 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 }
590
591 /* Put the resulting object onto the current object stack */
592
Len Brown4be44fc2005-08-05 00:44:28 -0400593 status = acpi_ds_obj_stack_push(obj_desc, walk_state);
594 if (ACPI_FAILURE(status)) {
595 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 }
Len Brown4be44fc2005-08-05 00:44:28 -0400597 ACPI_DEBUGGER_EXEC(acpi_db_display_argument_object
598 (obj_desc, walk_state));
599 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 /* Check for null name case */
601
Bob Moore4e3156b2008-04-10 19:06:37 +0400602 if ((arg->common.aml_opcode == AML_INT_NAMEPATH_OP) &&
603 !(arg->common.flags & ACPI_PARSEOP_IN_STACK)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 /*
605 * If the name is null, this means that this is an
606 * optional result parameter that was not specified
Bob Moore73a30902012-10-31 02:26:55 +0000607 * in the original ASL. Create a Zero Constant for a
608 * placeholder. (Store to a constant is a Noop.)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 */
Len Brown4be44fc2005-08-05 00:44:28 -0400610 opcode = AML_ZERO_OP; /* Has no arguments! */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611
Len Brown4be44fc2005-08-05 00:44:28 -0400612 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
613 "Null namepath: Arg=%p\n", arg));
614 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 opcode = arg->common.aml_opcode;
616 }
617
618 /* Get the object type of the argument */
619
Len Brown4be44fc2005-08-05 00:44:28 -0400620 op_info = acpi_ps_get_opcode_info(opcode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 if (op_info->object_type == ACPI_TYPE_INVALID) {
Len Brown4be44fc2005-08-05 00:44:28 -0400622 return_ACPI_STATUS(AE_NOT_IMPLEMENTED);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623 }
624
Bob Moore4e3156b2008-04-10 19:06:37 +0400625 if ((op_info->flags & AML_HAS_RETVAL)
626 || (arg->common.flags & ACPI_PARSEOP_IN_STACK)) {
Len Brown4be44fc2005-08-05 00:44:28 -0400627 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
Bob Moore50eca3e2005-09-30 19:03:00 -0400628 "Argument previously created, already stacked\n"));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629
Len Brown4be44fc2005-08-05 00:44:28 -0400630 ACPI_DEBUGGER_EXEC(acpi_db_display_argument_object
631 (walk_state->
632 operands[walk_state->num_operands -
633 1], walk_state));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634
635 /*
636 * Use value that was already previously returned
637 * by the evaluation of this argument
638 */
Bob Moore773069d2008-04-10 19:06:36 +0400639 status = acpi_ds_result_pop(&obj_desc, walk_state);
Len Brown4be44fc2005-08-05 00:44:28 -0400640 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 /*
642 * Only error is underflow, and this indicates
643 * a missing or null operand!
644 */
Bob Mooreb8e4d892006-01-27 16:43:00 -0500645 ACPI_EXCEPTION((AE_INFO, status,
646 "Missing or null operand"));
Len Brown4be44fc2005-08-05 00:44:28 -0400647 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 }
Len Brown4be44fc2005-08-05 00:44:28 -0400649 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 /* Create an ACPI_INTERNAL_OBJECT for the argument */
651
Len Brown4be44fc2005-08-05 00:44:28 -0400652 obj_desc =
653 acpi_ut_create_internal_object(op_info->
654 object_type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 if (!obj_desc) {
Len Brown4be44fc2005-08-05 00:44:28 -0400656 return_ACPI_STATUS(AE_NO_MEMORY);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 }
658
659 /* Initialize the new object */
660
Len Brown4be44fc2005-08-05 00:44:28 -0400661 status =
662 acpi_ds_init_object_from_op(walk_state, arg, opcode,
663 &obj_desc);
664 if (ACPI_FAILURE(status)) {
665 acpi_ut_delete_object_desc(obj_desc);
666 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 }
668 }
669
670 /* Put the operand object on the object stack */
671
Len Brown4be44fc2005-08-05 00:44:28 -0400672 status = acpi_ds_obj_stack_push(obj_desc, walk_state);
673 if (ACPI_FAILURE(status)) {
674 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 }
676
Len Brown4be44fc2005-08-05 00:44:28 -0400677 ACPI_DEBUGGER_EXEC(acpi_db_display_argument_object
678 (obj_desc, walk_state));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679 }
680
Len Brown4be44fc2005-08-05 00:44:28 -0400681 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682}
683
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684/*******************************************************************************
685 *
686 * FUNCTION: acpi_ds_create_operands
687 *
688 * PARAMETERS: walk_state - Current state
689 * first_arg - First argument of a parser argument tree
690 *
691 * RETURN: Status
692 *
693 * DESCRIPTION: Convert an operator's arguments from a parse tree format to
694 * namespace objects and place those argument object on the object
695 * stack in preparation for evaluation by the interpreter.
696 *
697 ******************************************************************************/
698
699acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400700acpi_ds_create_operands(struct acpi_walk_state *walk_state,
701 union acpi_parse_object *first_arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702{
Len Brown4be44fc2005-08-05 00:44:28 -0400703 acpi_status status = AE_OK;
704 union acpi_parse_object *arg;
Bob Moore773069d2008-04-10 19:06:36 +0400705 union acpi_parse_object *arguments[ACPI_OBJ_NUM_OPERANDS];
Bob Mooreb7f9f042008-04-10 19:06:40 +0400706 u32 arg_count = 0;
707 u32 index = walk_state->num_operands;
708 u32 i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709
Bob Mooreb229cf92006-04-21 17:15:00 -0400710 ACPI_FUNCTION_TRACE_PTR(ds_create_operands, first_arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711
Bob Moore773069d2008-04-10 19:06:36 +0400712 /* Get all arguments in the list */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713
714 arg = first_arg;
715 while (arg) {
Bob Moore773069d2008-04-10 19:06:36 +0400716 if (index >= ACPI_OBJ_NUM_OPERANDS) {
717 return_ACPI_STATUS(AE_BAD_DATA);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 }
719
Bob Moore773069d2008-04-10 19:06:36 +0400720 arguments[index] = arg;
721 walk_state->operands[index] = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722
723 /* Move on to next argument, if any */
724
725 arg = arg->common.next;
726 arg_count++;
Bob Moore773069d2008-04-10 19:06:36 +0400727 index++;
728 }
729
Bob Moore87beb7e2014-01-08 13:44:15 +0800730 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
731 "NumOperands %d, ArgCount %d, Index %d\n",
732 walk_state->num_operands, arg_count, index));
733
734 /* Create the interpreter arguments, in reverse order */
735
Bob Moore773069d2008-04-10 19:06:36 +0400736 index--;
Bob Moore773069d2008-04-10 19:06:36 +0400737 for (i = 0; i < arg_count; i++) {
738 arg = arguments[index];
Bob Moore87beb7e2014-01-08 13:44:15 +0800739 walk_state->operand_index = (u8)index;
Bob Moore773069d2008-04-10 19:06:36 +0400740
741 status = acpi_ds_create_operand(walk_state, arg, index);
742 if (ACPI_FAILURE(status)) {
743 goto cleanup;
744 }
745
Bob Moore773069d2008-04-10 19:06:36 +0400746 ACPI_DEBUG_PRINT((ACPI_DB_DISPATCH,
Bob Moore87beb7e2014-01-08 13:44:15 +0800747 "Created Arg #%u (%p) %u args total\n",
748 index, arg, arg_count));
749 index--;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 }
751
Len Brown4be44fc2005-08-05 00:44:28 -0400752 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753
Lv Zheng10622bf2013-10-29 09:30:02 +0800754cleanup:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 /*
756 * We must undo everything done above; meaning that we must
757 * pop everything off of the operand stack and delete those
758 * objects
759 */
Bob Moore773069d2008-04-10 19:06:36 +0400760 acpi_ds_obj_stack_pop_and_delete(arg_count, walk_state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761
Bob Mooreb27d6592010-05-26 11:47:13 +0800762 ACPI_EXCEPTION((AE_INFO, status, "While creating Arg %u", index));
Len Brown4be44fc2005-08-05 00:44:28 -0400763 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764}
Bob Moore4e3156b2008-04-10 19:06:37 +0400765
766/*****************************************************************************
767 *
768 * FUNCTION: acpi_ds_evaluate_name_path
769 *
770 * PARAMETERS: walk_state - Current state of the parse tree walk,
771 * the opcode of current operation should be
772 * AML_INT_NAMEPATH_OP
773 *
774 * RETURN: Status
775 *
776 * DESCRIPTION: Translate the -name_path- parse tree object to the equivalent
777 * interpreter object, convert it to value, if needed, duplicate
778 * it, if needed, and push it onto the current result stack.
779 *
780 ****************************************************************************/
781
782acpi_status acpi_ds_evaluate_name_path(struct acpi_walk_state *walk_state)
783{
784 acpi_status status = AE_OK;
785 union acpi_parse_object *op = walk_state->op;
786 union acpi_operand_object **operand = &walk_state->operands[0];
787 union acpi_operand_object *new_obj_desc;
788 u8 type;
789
790 ACPI_FUNCTION_TRACE_PTR(ds_evaluate_name_path, walk_state);
791
792 if (!op->common.parent) {
793
794 /* This happens after certain exception processing */
795
796 goto exit;
797 }
798
799 if ((op->common.parent->common.aml_opcode == AML_PACKAGE_OP) ||
800 (op->common.parent->common.aml_opcode == AML_VAR_PACKAGE_OP) ||
801 (op->common.parent->common.aml_opcode == AML_REF_OF_OP)) {
802
803 /* TBD: Should we specify this feature as a bit of op_info->Flags of these opcodes? */
804
805 goto exit;
806 }
807
808 status = acpi_ds_create_operand(walk_state, op, 0);
809 if (ACPI_FAILURE(status)) {
810 goto exit;
811 }
812
813 if (op->common.flags & ACPI_PARSEOP_TARGET) {
814 new_obj_desc = *operand;
815 goto push_result;
816 }
817
Bob Moore3371c192009-02-18 14:44:03 +0800818 type = (*operand)->common.type;
Bob Moore4e3156b2008-04-10 19:06:37 +0400819
820 status = acpi_ex_resolve_to_value(operand, walk_state);
821 if (ACPI_FAILURE(status)) {
822 goto exit;
823 }
824
825 if (type == ACPI_TYPE_INTEGER) {
826
827 /* It was incremented by acpi_ex_resolve_to_value */
828
829 acpi_ut_remove_reference(*operand);
830
831 status =
832 acpi_ut_copy_iobject_to_iobject(*operand, &new_obj_desc,
833 walk_state);
834 if (ACPI_FAILURE(status)) {
835 goto exit;
836 }
837 } else {
838 /*
839 * The object either was anew created or is
840 * a Namespace node - don't decrement it.
841 */
842 new_obj_desc = *operand;
843 }
844
845 /* Cleanup for name-path operand */
846
847 status = acpi_ds_obj_stack_pop(1, walk_state);
848 if (ACPI_FAILURE(status)) {
849 walk_state->result_obj = new_obj_desc;
850 goto exit;
851 }
852
Lv Zheng10622bf2013-10-29 09:30:02 +0800853push_result:
Bob Moore4e3156b2008-04-10 19:06:37 +0400854
855 walk_state->result_obj = new_obj_desc;
856
857 status = acpi_ds_result_push(walk_state->result_obj, walk_state);
858 if (ACPI_SUCCESS(status)) {
859
860 /* Force to take it from stack */
861
862 op->common.flags |= ACPI_PARSEOP_IN_STACK;
863 }
864
Lv Zheng10622bf2013-10-29 09:30:02 +0800865exit:
Bob Moore4e3156b2008-04-10 19:06:37 +0400866
867 return_ACPI_STATUS(status);
868}