blob: d369164e00b0bc16d594e8617e93be3ada99d95f [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*******************************************************************************
2 *
Bob Moore41195322006-05-26 16:36:00 -04003 * Module Name: nseval - Object evaluation, includes control method execution
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
5 ******************************************************************************/
6
7/*
Len Brown75a44ce2008-04-23 23:00:13 -04008 * Copyright (C) 2000 - 2008, 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>
45#include <acpi/acparser.h>
46#include <acpi/acinterp.h>
47#include <acpi/acnamesp.h>
48
Linus Torvalds1da177e2005-04-16 15:20:36 -070049#define _COMPONENT ACPI_NAMESPACE
Len Brown4be44fc2005-08-05 00:44:28 -040050ACPI_MODULE_NAME("nseval")
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
Linus Torvalds1da177e2005-04-16 15:20:36 -070052/*******************************************************************************
53 *
Bob Moore41195322006-05-26 16:36:00 -040054 * FUNCTION: acpi_ns_evaluate
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 *
Bob Moore41195322006-05-26 16:36:00 -040056 * PARAMETERS: Info - Evaluation info block, contains:
57 * prefix_node - Prefix or Method/Object Node to execute
58 * Pathname - Name of method to execute, If NULL, the
59 * Node is the object to execute
Robert Moore44f6c012005-04-18 22:49:35 -040060 * Parameters - List of parameters to pass to the method,
61 * terminated by NULL. Params itself may be
Linus Torvalds1da177e2005-04-16 15:20:36 -070062 * NULL if no parameters are being passed.
Robert Moore44f6c012005-04-18 22:49:35 -040063 * return_object - Where to put method's return value (if
64 * any). If NULL, no value is returned.
65 * parameter_type - Type of Parameter list
66 * return_object - Where to put method's return value (if
67 * any). If NULL, no value is returned.
Bob Moore41195322006-05-26 16:36:00 -040068 * Flags - ACPI_IGNORE_RETURN_VALUE to delete return
Linus Torvalds1da177e2005-04-16 15:20:36 -070069 *
70 * RETURN: Status
71 *
Bob Moore41195322006-05-26 16:36:00 -040072 * DESCRIPTION: Execute a control method or return the current value of an
73 * ACPI namespace object.
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 *
Bob Moore41195322006-05-26 16:36:00 -040075 * MUTEX: Locks interpreter
Linus Torvalds1da177e2005-04-16 15:20:36 -070076 *
77 ******************************************************************************/
Len Brownfd350942007-05-09 23:34:35 -040078acpi_status acpi_ns_evaluate(struct acpi_evaluate_info * info)
Linus Torvalds1da177e2005-04-16 15:20:36 -070079{
Len Brown4be44fc2005-08-05 00:44:28 -040080 acpi_status status;
Linus Torvalds1da177e2005-04-16 15:20:36 -070081
Bob Moore41195322006-05-26 16:36:00 -040082 ACPI_FUNCTION_TRACE(ns_evaluate);
Linus Torvalds1da177e2005-04-16 15:20:36 -070083
84 if (!info) {
Len Brown4be44fc2005-08-05 00:44:28 -040085 return_ACPI_STATUS(AE_BAD_PARAMETER);
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 }
87
88 /* Initialize the return value to an invalid object */
89
90 info->return_object = NULL;
91
Bob Moore41195322006-05-26 16:36:00 -040092 /*
93 * Get the actual namespace node for the target object. Handles these cases:
94 *
95 * 1) Null node, Pathname (absolute path)
96 * 2) Node, Pathname (path relative to Node)
97 * 3) Node, Null Pathname
98 */
99 status = acpi_ns_get_node(info->prefix_node, info->pathname,
100 ACPI_NS_NO_UPSEARCH, &info->resolved_node);
Len Brown4be44fc2005-08-05 00:44:28 -0400101 if (ACPI_FAILURE(status)) {
102 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103 }
104
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 /*
106 * For a method alias, we must grab the actual method node so that proper
107 * scoping context will be established before execution.
108 */
Bob Moore41195322006-05-26 16:36:00 -0400109 if (acpi_ns_get_type(info->resolved_node) ==
110 ACPI_TYPE_LOCAL_METHOD_ALIAS) {
111 info->resolved_node =
Len Brown4be44fc2005-08-05 00:44:28 -0400112 ACPI_CAST_PTR(struct acpi_namespace_node,
Bob Moore41195322006-05-26 16:36:00 -0400113 info->resolved_node->object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114 }
115
Bob Moore41195322006-05-26 16:36:00 -0400116 ACPI_DEBUG_PRINT((ACPI_DB_NAMES, "%s [%p] Value %p\n", info->pathname,
117 info->resolved_node,
118 acpi_ns_get_attached_object(info->resolved_node)));
119
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 /*
121 * Two major cases here:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700122 *
Bob Moore41195322006-05-26 16:36:00 -0400123 * 1) The object is a control method -- execute it
124 * 2) The object is not a method -- just return it's current value
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 */
Bob Moore41195322006-05-26 16:36:00 -0400126 if (acpi_ns_get_type(info->resolved_node) == ACPI_TYPE_METHOD) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 /*
Bob Moore41195322006-05-26 16:36:00 -0400128 * 1) Object is a control method - execute it
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129 */
Bob Moore41195322006-05-26 16:36:00 -0400130
131 /* Verify that there is a method object associated with this node */
132
133 info->obj_desc =
134 acpi_ns_get_attached_object(info->resolved_node);
135 if (!info->obj_desc) {
136 ACPI_ERROR((AE_INFO,
137 "Control method has no attached sub-object"));
138 return_ACPI_STATUS(AE_NULL_OBJECT);
139 }
140
Bob Mooref3454ae2008-06-10 12:25:42 +0800141 /*
142 * Calculate the number of arguments being passed to the method
143 */
144
145 info->param_count = 0;
146 if (info->parameters) {
147 while (info->parameters[info->param_count])
148 info->param_count++;
149 }
150
151 /* Error if too few arguments were passed in */
152
153 if (info->param_count < info->obj_desc->method.param_count) {
154 ACPI_ERROR((AE_INFO,
155 "Insufficient arguments - "
156 "method [%4.4s] needs %d, found %d",
157 acpi_ut_get_node_name(info->resolved_node),
158 info->obj_desc->method.param_count,
159 info->param_count));
160 return_ACPI_STATUS(AE_MISSING_ARGUMENTS);
161 }
162
163 /* Just a warning if too many arguments */
164
165 else if (info->param_count >
166 info->obj_desc->method.param_count) {
167 ACPI_WARNING((AE_INFO,
168 "Excess arguments - "
169 "method [%4.4s] needs %d, found %d",
170 acpi_ut_get_node_name(info->
171 resolved_node),
172 info->obj_desc->method.param_count,
173 info->param_count));
174 }
175
Bob Moore41195322006-05-26 16:36:00 -0400176 ACPI_DUMP_PATHNAME(info->resolved_node, "Execute Method:",
177 ACPI_LV_INFO, _COMPONENT);
178
179 ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
180 "Method at AML address %p Length %X\n",
181 info->obj_desc->method.aml_start + 1,
182 info->obj_desc->method.aml_length - 1));
183
184 /*
185 * Any namespace deletion must acquire both the namespace and
186 * interpreter locks to ensure that no thread is using the portion of
187 * the namespace that is being deleted.
188 *
189 * Execute the method via the interpreter. The interpreter is locked
190 * here before calling into the AML parser
191 */
Len Brown4d2acd92007-05-09 22:56:38 -0400192 acpi_ex_enter_interpreter();
Bob Moore41195322006-05-26 16:36:00 -0400193 status = acpi_ps_execute_method(info);
194 acpi_ex_exit_interpreter();
Len Brown4be44fc2005-08-05 00:44:28 -0400195 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 /*
Bob Moore41195322006-05-26 16:36:00 -0400197 * 2) Object is not a method, return its current value
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
Bob Moore41195322006-05-26 16:36:00 -0400200 /*
201 * Objects require additional resolution steps (e.g., the Node may be
202 * a field that must be read, etc.) -- we can't just grab the object
203 * out of the node.
204 *
205 * Use resolve_node_to_value() to get the associated value.
206 *
207 * NOTE: we can get away with passing in NULL for a walk state because
208 * resolved_node is guaranteed to not be a reference to either a method
209 * local or a method argument (because this interface is never called
210 * from a running method.)
211 *
212 * Even though we do not directly invoke the interpreter for object
213 * resolution, we must lock it because we could access an opregion.
214 * The opregion access code assumes that the interpreter is locked.
215 */
Len Brown4d2acd92007-05-09 22:56:38 -0400216 acpi_ex_enter_interpreter();
Bob Moore52fc0b02006-10-02 00:00:00 -0400217
Bob Moore41195322006-05-26 16:36:00 -0400218 /* Function has a strange interface */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219
Bob Moore41195322006-05-26 16:36:00 -0400220 status =
221 acpi_ex_resolve_node_to_value(&info->resolved_node, NULL);
222 acpi_ex_exit_interpreter();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 /*
225 * If acpi_ex_resolve_node_to_value() succeeded, the return value was placed
226 * in resolved_node.
227 */
Len Brown4be44fc2005-08-05 00:44:28 -0400228 if (ACPI_SUCCESS(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 status = AE_CTRL_RETURN_VALUE;
Bob Moore41195322006-05-26 16:36:00 -0400230 info->return_object =
231 ACPI_CAST_PTR(union acpi_operand_object,
232 info->resolved_node);
233
Len Brown4be44fc2005-08-05 00:44:28 -0400234 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
235 "Returning object %p [%s]\n",
236 info->return_object,
237 acpi_ut_get_object_type_name(info->
238 return_object)));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 }
240 }
241
Bob Moore41195322006-05-26 16:36:00 -0400242 /*
243 * Check if there is a return value that must be dealt with
244 */
245 if (status == AE_CTRL_RETURN_VALUE) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246
Bob Moore41195322006-05-26 16:36:00 -0400247 /* If caller does not want the return value, delete it */
248
249 if (info->flags & ACPI_IGNORE_RETURN_VALUE) {
250 acpi_ut_remove_reference(info->return_object);
251 info->return_object = NULL;
252 }
253
254 /* Map AE_CTRL_RETURN_VALUE to AE_OK, we are done with it */
255
256 status = AE_OK;
257 }
258
259 ACPI_DEBUG_PRINT((ACPI_DB_NAMES,
260 "*** Completed evaluation of object %s ***\n",
261 info->pathname));
262
263 /*
264 * Namespace was unlocked by the handling acpi_ns* function, so we
265 * just return
266 */
Len Brown4be44fc2005-08-05 00:44:28 -0400267 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268}