blob: daf4ad37896d1f13c627229070fb6893fc9e8474 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*******************************************************************************
2 *
3 * Module Name: nsxfeval - Public interfaces to the ACPI subsystem
4 * ACPI Object evaluation interfaces
5 *
6 ******************************************************************************/
7
8/*
Len Brown75a44ce2008-04-23 23:00:13 -04009 * Copyright (C) 2000 - 2008, Intel Corp.
Linus Torvalds1da177e2005-04-16 15:20:36 -070010 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions, and the following disclaimer,
17 * without modification.
18 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
19 * substantially similar to the "NO WARRANTY" disclaimer below
20 * ("Disclaimer") and any redistribution must be conditioned upon
21 * including a substantially similar Disclaimer requirement for further
22 * binary redistribution.
23 * 3. Neither the names of the above-listed copyright holders nor the names
24 * of any contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
26 *
27 * Alternatively, this software may be distributed under the terms of the
28 * GNU General Public License ("GPL") version 2 as published by the Free
29 * Software Foundation.
30 *
31 * NO WARRANTY
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
35 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42 * POSSIBILITY OF SUCH DAMAGES.
43 */
44
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#include <acpi/acpi.h>
Len Browne2f7a772009-01-09 00:30:03 -050046#include "accommon.h"
47#include "acnamesp.h"
48#include "acinterp.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
Linus Torvalds1da177e2005-04-16 15:20:36 -070050#define _COMPONENT ACPI_NAMESPACE
Len Brown4be44fc2005-08-05 00:44:28 -040051ACPI_MODULE_NAME("nsxfeval")
Lin Mingbbc24132008-08-04 13:22:10 +080052
53/* Local prototypes */
54static void acpi_ns_resolve_references(struct acpi_evaluate_info *info);
55
Linus Torvalds1da177e2005-04-16 15:20:36 -070056/*******************************************************************************
57 *
58 * FUNCTION: acpi_evaluate_object_typed
59 *
60 * PARAMETERS: Handle - Object handle (optional)
Robert Moore44f6c012005-04-18 22:49:35 -040061 * Pathname - Object pathname (optional)
62 * external_params - List of parameters to pass to method,
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 * terminated by NULL. May be NULL
64 * if no parameters are being passed.
Robert Moore44f6c012005-04-18 22:49:35 -040065 * return_buffer - Where to put method's return value (if
Linus Torvalds1da177e2005-04-16 15:20:36 -070066 * any). If NULL, no value is returned.
67 * return_type - Expected type of return object
68 *
69 * RETURN: Status
70 *
71 * DESCRIPTION: Find and evaluate the given object, passing the given
72 * parameters if necessary. One of "Handle" or "Pathname" must
73 * be valid (non-null)
74 *
75 ******************************************************************************/
Lin Mingbbc24132008-08-04 13:22:10 +080076
Linus Torvalds1da177e2005-04-16 15:20:36 -070077acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040078acpi_evaluate_object_typed(acpi_handle handle,
79 acpi_string pathname,
Len Brownfd350942007-05-09 23:34:35 -040080 struct acpi_object_list *external_params,
81 struct acpi_buffer *return_buffer,
Len Brown4be44fc2005-08-05 00:44:28 -040082 acpi_object_type return_type)
Linus Torvalds1da177e2005-04-16 15:20:36 -070083{
Len Brown4be44fc2005-08-05 00:44:28 -040084 acpi_status status;
85 u8 must_free = FALSE;
Linus Torvalds1da177e2005-04-16 15:20:36 -070086
Bob Mooreb229cf92006-04-21 17:15:00 -040087 ACPI_FUNCTION_TRACE(acpi_evaluate_object_typed);
Linus Torvalds1da177e2005-04-16 15:20:36 -070088
89 /* Return buffer must be valid */
90
91 if (!return_buffer) {
Len Brown4be44fc2005-08-05 00:44:28 -040092 return_ACPI_STATUS(AE_BAD_PARAMETER);
Linus Torvalds1da177e2005-04-16 15:20:36 -070093 }
94
95 if (return_buffer->length == ACPI_ALLOCATE_BUFFER) {
96 must_free = TRUE;
97 }
98
99 /* Evaluate the object */
100
Len Brown4be44fc2005-08-05 00:44:28 -0400101 status =
102 acpi_evaluate_object(handle, pathname, external_params,
103 return_buffer);
104 if (ACPI_FAILURE(status)) {
105 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 }
107
108 /* Type ANY means "don't care" */
109
110 if (return_type == ACPI_TYPE_ANY) {
Len Brown4be44fc2005-08-05 00:44:28 -0400111 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 }
113
114 if (return_buffer->length == 0) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400115
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116 /* Error because caller specifically asked for a return value */
117
Bob Mooreb8e4d892006-01-27 16:43:00 -0500118 ACPI_ERROR((AE_INFO, "No return value"));
Len Brown4be44fc2005-08-05 00:44:28 -0400119 return_ACPI_STATUS(AE_NULL_OBJECT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 }
121
122 /* Examine the object type returned from evaluate_object */
123
Len Brown4be44fc2005-08-05 00:44:28 -0400124 if (((union acpi_object *)return_buffer->pointer)->type == return_type) {
125 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 }
127
128 /* Return object type does not match requested type */
129
Bob Mooreb8e4d892006-01-27 16:43:00 -0500130 ACPI_ERROR((AE_INFO,
131 "Incorrect return type [%s] requested [%s]",
132 acpi_ut_get_type_name(((union acpi_object *)return_buffer->
133 pointer)->type),
134 acpi_ut_get_type_name(return_type)));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135
136 if (must_free) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400137
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 /* Caller used ACPI_ALLOCATE_BUFFER, free the return buffer */
139
Len Brown02438d82006-06-30 03:19:10 -0400140 ACPI_FREE(return_buffer->pointer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141 return_buffer->pointer = NULL;
142 }
143
144 return_buffer->length = 0;
Len Brown4be44fc2005-08-05 00:44:28 -0400145 return_ACPI_STATUS(AE_TYPE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146}
Bob Moore83135242006-10-03 00:00:00 -0400147
148ACPI_EXPORT_SYMBOL(acpi_evaluate_object_typed)
Luca Tettamanti2c03d072009-04-07 15:32:59 +0200149
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150/*******************************************************************************
151 *
152 * FUNCTION: acpi_evaluate_object
153 *
154 * PARAMETERS: Handle - Object handle (optional)
155 * Pathname - Object pathname (optional)
156 * external_params - List of parameters to pass to method,
157 * terminated by NULL. May be NULL
158 * if no parameters are being passed.
159 * return_buffer - Where to put method's return value (if
160 * any). If NULL, no value is returned.
161 *
162 * RETURN: Status
163 *
164 * DESCRIPTION: Find and evaluate the given object, passing the given
165 * parameters if necessary. One of "Handle" or "Pathname" must
166 * be valid (non-null)
167 *
168 ******************************************************************************/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400170acpi_evaluate_object(acpi_handle handle,
171 acpi_string pathname,
172 struct acpi_object_list *external_params,
173 struct acpi_buffer *return_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174{
Len Brown4be44fc2005-08-05 00:44:28 -0400175 acpi_status status;
Bob Moore41195322006-05-26 16:36:00 -0400176 struct acpi_evaluate_info *info;
Len Brown4be44fc2005-08-05 00:44:28 -0400177 acpi_size buffer_space_needed;
178 u32 i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179
Bob Mooreb229cf92006-04-21 17:15:00 -0400180 ACPI_FUNCTION_TRACE(acpi_evaluate_object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181
Bob Moore41195322006-05-26 16:36:00 -0400182 /* Allocate and initialize the evaluation information block */
183
184 info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
185 if (!info) {
186 return_ACPI_STATUS(AE_NO_MEMORY);
187 }
188
189 info->pathname = pathname;
Bob Moore41195322006-05-26 16:36:00 -0400190
191 /* Convert and validate the device handle */
192
193 info->prefix_node = acpi_ns_map_handle_to_node(handle);
194 if (!info->prefix_node) {
195 status = AE_BAD_PARAMETER;
196 goto cleanup;
197 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198
199 /*
Bob Moore41195322006-05-26 16:36:00 -0400200 * If there are parameters to be passed to a control method, the external
201 * objects must all be converted to internal objects
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 */
203 if (external_params && external_params->count) {
204 /*
205 * Allocate a new parameter block for the internal objects
206 * Add 1 to count to allow for null terminated internal list
207 */
Bob Moore41195322006-05-26 16:36:00 -0400208 info->parameters = ACPI_ALLOCATE_ZEROED(((acpi_size)
209 external_params->
210 count +
211 1) * sizeof(void *));
212 if (!info->parameters) {
213 status = AE_NO_MEMORY;
214 goto cleanup;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215 }
216
Bob Moore41195322006-05-26 16:36:00 -0400217 /* Convert each external object in the list to an internal object */
218
Linus Torvalds1da177e2005-04-16 15:20:36 -0700219 for (i = 0; i < external_params->count; i++) {
Len Brown4be44fc2005-08-05 00:44:28 -0400220 status =
221 acpi_ut_copy_eobject_to_iobject(&external_params->
222 pointer[i],
Bob Moore41195322006-05-26 16:36:00 -0400223 &info->
Len Brown4be44fc2005-08-05 00:44:28 -0400224 parameters[i]);
225 if (ACPI_FAILURE(status)) {
Bob Moore41195322006-05-26 16:36:00 -0400226 goto cleanup;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 }
228 }
Bob Moore41195322006-05-26 16:36:00 -0400229 info->parameters[external_params->count] = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 }
231
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 /*
233 * Three major cases:
234 * 1) Fully qualified pathname
235 * 2) No handle, not fully qualified pathname (error)
236 * 3) Valid handle
237 */
Len Brown4be44fc2005-08-05 00:44:28 -0400238 if ((pathname) && (acpi_ns_valid_root_prefix(pathname[0]))) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400239
240 /* The path is fully qualified, just evaluate by name */
241
Bob Moore41195322006-05-26 16:36:00 -0400242 info->prefix_node = NULL;
243 status = acpi_ns_evaluate(info);
Len Brown4be44fc2005-08-05 00:44:28 -0400244 } else if (!handle) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 /*
Bob Moore41195322006-05-26 16:36:00 -0400246 * A handle is optional iff a fully qualified pathname is specified.
247 * Since we've already handled fully qualified names above, this is
248 * an error
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 */
250 if (!pathname) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400251 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
252 "Both Handle and Pathname are NULL"));
Len Brown4be44fc2005-08-05 00:44:28 -0400253 } else {
Bob Moore52fc0b02006-10-02 00:00:00 -0400254 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
255 "Null Handle with relative pathname [%s]",
256 pathname));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 }
258
259 status = AE_BAD_PARAMETER;
Len Brown4be44fc2005-08-05 00:44:28 -0400260 } else {
Bob Moore41195322006-05-26 16:36:00 -0400261 /* We have a namespace a node and a possible relative path */
Bob Moore52fc0b02006-10-02 00:00:00 -0400262
Bob Moore41195322006-05-26 16:36:00 -0400263 status = acpi_ns_evaluate(info);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 }
265
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 /*
267 * If we are expecting a return value, and all went well above,
268 * copy the return value to an external object.
269 */
270 if (return_buffer) {
Bob Moore41195322006-05-26 16:36:00 -0400271 if (!info->return_object) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 return_buffer->length = 0;
Len Brown4be44fc2005-08-05 00:44:28 -0400273 } else {
Bob Moore41195322006-05-26 16:36:00 -0400274 if (ACPI_GET_DESCRIPTOR_TYPE(info->return_object) ==
Len Brown4be44fc2005-08-05 00:44:28 -0400275 ACPI_DESC_TYPE_NAMED) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 /*
277 * If we received a NS Node as a return object, this means that
278 * the object we are evaluating has nothing interesting to
279 * return (such as a mutex, etc.) We return an error because
280 * these types are essentially unsupported by this interface.
281 * We don't check up front because this makes it easier to add
282 * support for various types at a later date if necessary.
283 */
284 status = AE_TYPE;
Bob Moore41195322006-05-26 16:36:00 -0400285 info->return_object = NULL; /* No need to delete a NS Node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 return_buffer->length = 0;
287 }
288
Len Brown4be44fc2005-08-05 00:44:28 -0400289 if (ACPI_SUCCESS(status)) {
Bob Moore41195322006-05-26 16:36:00 -0400290
Lin Mingbbc24132008-08-04 13:22:10 +0800291 /* Dereference Index and ref_of references */
292
293 acpi_ns_resolve_references(info);
294
Bob Moore41195322006-05-26 16:36:00 -0400295 /* Get the size of the returned object */
296
Len Brown4be44fc2005-08-05 00:44:28 -0400297 status =
Bob Moore41195322006-05-26 16:36:00 -0400298 acpi_ut_get_object_size(info->return_object,
Len Brown4be44fc2005-08-05 00:44:28 -0400299 &buffer_space_needed);
300 if (ACPI_SUCCESS(status)) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400301
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 /* Validate/Allocate/Clear caller buffer */
303
Len Brown4be44fc2005-08-05 00:44:28 -0400304 status =
305 acpi_ut_initialize_buffer
306 (return_buffer,
307 buffer_space_needed);
308 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309 /*
Bob Moore52fc0b02006-10-02 00:00:00 -0400310 * Caller's buffer is too small or a new one can't
311 * be allocated
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312 */
Len Brown4be44fc2005-08-05 00:44:28 -0400313 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
314 "Needed buffer size %X, %s\n",
315 (u32)
316 buffer_space_needed,
317 acpi_format_exception
318 (status)));
319 } else {
Bob Moore52fc0b02006-10-02 00:00:00 -0400320 /* We have enough space for the object, build it */
321
Len Brown4be44fc2005-08-05 00:44:28 -0400322 status =
323 acpi_ut_copy_iobject_to_eobject
Bob Moore41195322006-05-26 16:36:00 -0400324 (info->return_object,
Len Brown4be44fc2005-08-05 00:44:28 -0400325 return_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 }
327 }
328 }
329 }
330 }
331
Bob Moore41195322006-05-26 16:36:00 -0400332 if (info->return_object) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 /*
Bob Moore41195322006-05-26 16:36:00 -0400334 * Delete the internal return object. NOTE: Interpreter must be
335 * locked to avoid race condition.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 */
Len Brown4d2acd92007-05-09 22:56:38 -0400337 acpi_ex_enter_interpreter();
Bob Moore41195322006-05-26 16:36:00 -0400338
Len Brown4d2acd92007-05-09 22:56:38 -0400339 /* Remove one reference on the return object (should delete it) */
Bob Moore41195322006-05-26 16:36:00 -0400340
Len Brown4d2acd92007-05-09 22:56:38 -0400341 acpi_ut_remove_reference(info->return_object);
342 acpi_ex_exit_interpreter();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343 }
344
Bob Moore41195322006-05-26 16:36:00 -0400345 cleanup:
346
Bob Moore52fc0b02006-10-02 00:00:00 -0400347 /* Free the input parameter list (if we created one) */
348
Bob Moore41195322006-05-26 16:36:00 -0400349 if (info->parameters) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400350
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351 /* Free the allocated parameter block */
352
Bob Moore41195322006-05-26 16:36:00 -0400353 acpi_ut_delete_internal_object_list(info->parameters);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 }
355
Bob Moore41195322006-05-26 16:36:00 -0400356 ACPI_FREE(info);
Len Brown4be44fc2005-08-05 00:44:28 -0400357 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359
Bob Moore83135242006-10-03 00:00:00 -0400360ACPI_EXPORT_SYMBOL(acpi_evaluate_object)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361
362/*******************************************************************************
363 *
Lin Mingbbc24132008-08-04 13:22:10 +0800364 * FUNCTION: acpi_ns_resolve_references
365 *
366 * PARAMETERS: Info - Evaluation info block
367 *
368 * RETURN: Info->return_object is replaced with the dereferenced object
369 *
370 * DESCRIPTION: Dereference certain reference objects. Called before an
371 * internal return object is converted to an external union acpi_object.
372 *
373 * Performs an automatic dereference of Index and ref_of reference objects.
374 * These reference objects are not supported by the union acpi_object, so this is a
375 * last resort effort to return something useful. Also, provides compatibility
376 * with other ACPI implementations.
377 *
378 * NOTE: does not handle references within returned package objects or nested
379 * references, but this support could be added later if found to be necessary.
380 *
381 ******************************************************************************/
382static void acpi_ns_resolve_references(struct acpi_evaluate_info *info)
383{
384 union acpi_operand_object *obj_desc = NULL;
385 struct acpi_namespace_node *node;
386
387 /* We are interested in reference objects only */
388
Bob Moore3371c192009-02-18 14:44:03 +0800389 if ((info->return_object)->common.type != ACPI_TYPE_LOCAL_REFERENCE) {
Lin Mingbbc24132008-08-04 13:22:10 +0800390 return;
391 }
392
393 /*
394 * Two types of references are supported - those created by Index and
395 * ref_of operators. A name reference (AML_NAMEPATH_OP) can be converted
396 * to an union acpi_object, so it is not dereferenced here. A ddb_handle
397 * (AML_LOAD_OP) cannot be dereferenced, nor can it be converted to
398 * an union acpi_object.
399 */
Bob Moore1044f1f2008-09-27 11:08:41 +0800400 switch (info->return_object->reference.class) {
401 case ACPI_REFCLASS_INDEX:
Lin Mingbbc24132008-08-04 13:22:10 +0800402
403 obj_desc = *(info->return_object->reference.where);
404 break;
405
Bob Moore1044f1f2008-09-27 11:08:41 +0800406 case ACPI_REFCLASS_REFOF:
Lin Mingbbc24132008-08-04 13:22:10 +0800407
408 node = info->return_object->reference.object;
409 if (node) {
410 obj_desc = node->object;
411 }
412 break;
413
414 default:
415 return;
416 }
417
418 /* Replace the existing reference object */
419
420 if (obj_desc) {
421 acpi_ut_add_reference(obj_desc);
422 acpi_ut_remove_reference(info->return_object);
423 info->return_object = obj_desc;
424 }
425
426 return;
427}
428
429/*******************************************************************************
430 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 * FUNCTION: acpi_walk_namespace
432 *
433 * PARAMETERS: Type - acpi_object_type to search for
434 * start_object - Handle in namespace where search begins
435 * max_depth - Depth to which search is to reach
436 * user_function - Called when an object of "Type" is found
437 * Context - Passed to user function
438 * return_value - Location where return value of
439 * user_function is put if terminated early
440 *
441 * RETURNS Return value from the user_function if terminated early.
442 * Otherwise, returns NULL.
443 *
444 * DESCRIPTION: Performs a modified depth-first walk of the namespace tree,
445 * starting (and ending) at the object specified by start_handle.
446 * The user_function is called whenever an object that matches
447 * the type parameter is found. If the user function returns
448 * a non-zero value, the search is terminated immediately and this
449 * value is returned to the caller.
450 *
451 * The point of this procedure is to provide a generic namespace
452 * walk routine that can be called from multiple places to
453 * provide multiple services; the User Function can be tailored
454 * to each task, whether it is a print function, a compare
455 * function, etc.
456 *
457 ******************************************************************************/
Lin Mingbbc24132008-08-04 13:22:10 +0800458
Linus Torvalds1da177e2005-04-16 15:20:36 -0700459acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400460acpi_walk_namespace(acpi_object_type type,
461 acpi_handle start_object,
462 u32 max_depth,
463 acpi_walk_callback user_function,
464 void *context, void **return_value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465{
Len Brown4be44fc2005-08-05 00:44:28 -0400466 acpi_status status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467
Bob Mooreb229cf92006-04-21 17:15:00 -0400468 ACPI_FUNCTION_TRACE(acpi_walk_namespace);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469
470 /* Parameter validation */
471
Bob Moore96db2552005-11-02 00:00:00 -0500472 if ((type > ACPI_TYPE_LOCAL_MAX) || (!max_depth) || (!user_function)) {
Len Brown4be44fc2005-08-05 00:44:28 -0400473 return_ACPI_STATUS(AE_BAD_PARAMETER);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 }
475
476 /*
Bob Moore8a335a22009-03-09 16:31:04 +0800477 * Need to acquire the namespace reader lock to prevent interference
478 * with any concurrent table unloads (which causes the deletion of
479 * namespace objects). We cannot allow the deletion of a namespace node
480 * while the user function is using it. The exception to this are the
481 * nodes created and deleted during control method execution -- these
482 * nodes are marked as temporary nodes and are ignored by the namespace
483 * walk. Thus, control methods can be executed while holding the
484 * namespace deletion lock (and the user function can execute control
485 * methods.)
486 */
487 status = acpi_ut_acquire_read_lock(&acpi_gbl_namespace_rw_lock);
488 if (ACPI_FAILURE(status)) {
489 return status;
490 }
491
492 /*
493 * Lock the namespace around the walk. The namespace will be
494 * unlocked/locked around each call to the user function - since the user
495 * function must be allowed to make ACPICA calls itself (for example, it
496 * will typically execute control methods during device enumeration.)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497 */
Len Brown4be44fc2005-08-05 00:44:28 -0400498 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
499 if (ACPI_FAILURE(status)) {
Bob Moore8a335a22009-03-09 16:31:04 +0800500 goto unlock_and_exit;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501 }
502
Len Brown4be44fc2005-08-05 00:44:28 -0400503 status = acpi_ns_walk_namespace(type, start_object, max_depth,
Bob Moore8a335a22009-03-09 16:31:04 +0800504 ACPI_NS_WALK_UNLOCK, user_function,
505 context, return_value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506
Len Brown4be44fc2005-08-05 00:44:28 -0400507 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
Bob Moore8a335a22009-03-09 16:31:04 +0800508
509 unlock_and_exit:
510 (void)acpi_ut_release_read_lock(&acpi_gbl_namespace_rw_lock);
Len Brown4be44fc2005-08-05 00:44:28 -0400511 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513
Bob Moore83135242006-10-03 00:00:00 -0400514ACPI_EXPORT_SYMBOL(acpi_walk_namespace)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515
516/*******************************************************************************
517 *
518 * FUNCTION: acpi_ns_get_device_callback
519 *
520 * PARAMETERS: Callback from acpi_get_device
521 *
522 * RETURN: Status
523 *
524 * DESCRIPTION: Takes callbacks from walk_namespace and filters out all non-
525 * present devices, or if they specified a HID, it filters based
526 * on that.
527 *
528 ******************************************************************************/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529static acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400530acpi_ns_get_device_callback(acpi_handle obj_handle,
531 u32 nesting_level,
532 void *context, void **return_value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533{
Len Brown4be44fc2005-08-05 00:44:28 -0400534 struct acpi_get_devices_info *info = context;
535 acpi_status status;
536 struct acpi_namespace_node *node;
537 u32 flags;
Thomas Renninger8c8eb782007-07-23 14:43:32 +0200538 struct acpica_device_id hid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 struct acpi_compatible_id_list *cid;
Bob Moore67a119f2008-06-10 13:42:13 +0800540 u32 i;
Andrew Patterson02f8a852008-01-22 17:18:22 -0700541 int found;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542
Len Brown4be44fc2005-08-05 00:44:28 -0400543 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
544 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 return (status);
546 }
547
Len Brown4be44fc2005-08-05 00:44:28 -0400548 node = acpi_ns_map_handle_to_node(obj_handle);
549 status = acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
550 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 return (status);
552 }
553
554 if (!node) {
555 return (AE_BAD_PARAMETER);
556 }
557
558 /* Run _STA to determine if device is present */
559
Len Brown4be44fc2005-08-05 00:44:28 -0400560 status = acpi_ut_execute_STA(node, &flags);
561 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 return (AE_CTRL_DEPTH);
563 }
564
Bob Moore549f4602008-04-10 19:06:41 +0400565 if (!(flags & ACPI_STA_DEVICE_PRESENT) &&
566 !(flags & ACPI_STA_DEVICE_FUNCTIONING)) {
567 /*
568 * Don't examine the children of the device only when the
569 * device is neither present nor functional. See ACPI spec,
570 * description of _STA for more information.
571 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572 return (AE_CTRL_DEPTH);
573 }
574
575 /* Filter based on device HID & CID */
576
577 if (info->hid != NULL) {
Len Brown4be44fc2005-08-05 00:44:28 -0400578 status = acpi_ut_execute_HID(node, &hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579 if (status == AE_NOT_FOUND) {
580 return (AE_OK);
Len Brown4be44fc2005-08-05 00:44:28 -0400581 } else if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 return (AE_CTRL_DEPTH);
583 }
584
Len Brown4be44fc2005-08-05 00:44:28 -0400585 if (ACPI_STRNCMP(hid.value, info->hid, sizeof(hid.value)) != 0) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400586
Linus Torvalds1da177e2005-04-16 15:20:36 -0700587 /* Get the list of Compatible IDs */
588
Len Brown4be44fc2005-08-05 00:44:28 -0400589 status = acpi_ut_execute_CID(node, &cid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 if (status == AE_NOT_FOUND) {
591 return (AE_OK);
Len Brown4be44fc2005-08-05 00:44:28 -0400592 } else if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593 return (AE_CTRL_DEPTH);
594 }
595
596 /* Walk the CID list */
597
Andrew Patterson02f8a852008-01-22 17:18:22 -0700598 found = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 for (i = 0; i < cid->count; i++) {
Len Brown4be44fc2005-08-05 00:44:28 -0400600 if (ACPI_STRNCMP(cid->id[i].value, info->hid,
601 sizeof(struct
Andrew Patterson02f8a852008-01-22 17:18:22 -0700602 acpi_compatible_id)) ==
Len Brown4be44fc2005-08-05 00:44:28 -0400603 0) {
Andrew Patterson02f8a852008-01-22 17:18:22 -0700604 found = 1;
605 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 }
607 }
Bob Moore83135242006-10-03 00:00:00 -0400608 ACPI_FREE(cid);
Andrew Patterson02f8a852008-01-22 17:18:22 -0700609 if (!found)
610 return (AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 }
612 }
613
Len Brown4be44fc2005-08-05 00:44:28 -0400614 status = info->user_function(obj_handle, nesting_level, info->context,
615 return_value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 return (status);
617}
618
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619/*******************************************************************************
620 *
621 * FUNCTION: acpi_get_devices
622 *
623 * PARAMETERS: HID - HID to search for. Can be NULL.
624 * user_function - Called when a matching object is found
625 * Context - Passed to user function
626 * return_value - Location where return value of
627 * user_function is put if terminated early
628 *
629 * RETURNS Return value from the user_function if terminated early.
630 * Otherwise, returns NULL.
631 *
632 * DESCRIPTION: Performs a modified depth-first walk of the namespace tree,
633 * starting (and ending) at the object specified by start_handle.
634 * The user_function is called whenever an object of type
635 * Device is found. If the user function returns
636 * a non-zero value, the search is terminated immediately and this
637 * value is returned to the caller.
638 *
639 * This is a wrapper for walk_namespace, but the callback performs
Bob Moore549f4602008-04-10 19:06:41 +0400640 * additional filtering. Please see acpi_ns_get_device_callback.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 *
642 ******************************************************************************/
643
644acpi_status
Al Viro70b30fb2007-08-21 16:18:20 +0100645acpi_get_devices(const char *HID,
Len Brown4be44fc2005-08-05 00:44:28 -0400646 acpi_walk_callback user_function,
647 void *context, void **return_value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648{
Len Brown4be44fc2005-08-05 00:44:28 -0400649 acpi_status status;
650 struct acpi_get_devices_info info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651
Bob Mooreb229cf92006-04-21 17:15:00 -0400652 ACPI_FUNCTION_TRACE(acpi_get_devices);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653
654 /* Parameter validation */
655
656 if (!user_function) {
Len Brown4be44fc2005-08-05 00:44:28 -0400657 return_ACPI_STATUS(AE_BAD_PARAMETER);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 }
659
660 /*
661 * We're going to call their callback from OUR callback, so we need
662 * to know what it is, and their context parameter.
663 */
Bob Moore52fc0b02006-10-02 00:00:00 -0400664 info.hid = HID;
Len Brown4be44fc2005-08-05 00:44:28 -0400665 info.context = context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 info.user_function = user_function;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667
668 /*
669 * Lock the namespace around the walk.
670 * The namespace will be unlocked/locked around each call
671 * to the user function - since this function
672 * must be allowed to make Acpi calls itself.
673 */
Len Brown4be44fc2005-08-05 00:44:28 -0400674 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
675 if (ACPI_FAILURE(status)) {
676 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 }
678
Bob Moore52fc0b02006-10-02 00:00:00 -0400679 status = acpi_ns_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
680 ACPI_UINT32_MAX, ACPI_NS_WALK_UNLOCK,
Len Brown4be44fc2005-08-05 00:44:28 -0400681 acpi_ns_get_device_callback, &info,
682 return_value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683
Len Brown4be44fc2005-08-05 00:44:28 -0400684 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
685 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687
Bob Moore83135242006-10-03 00:00:00 -0400688ACPI_EXPORT_SYMBOL(acpi_get_devices)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689
690/*******************************************************************************
691 *
692 * FUNCTION: acpi_attach_data
693 *
694 * PARAMETERS: obj_handle - Namespace node
695 * Handler - Handler for this attachment
696 * Data - Pointer to data to be attached
697 *
698 * RETURN: Status
699 *
700 * DESCRIPTION: Attach arbitrary data and handler to a namespace node.
701 *
702 ******************************************************************************/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400704acpi_attach_data(acpi_handle obj_handle,
705 acpi_object_handler handler, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706{
Len Brown4be44fc2005-08-05 00:44:28 -0400707 struct acpi_namespace_node *node;
708 acpi_status status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709
710 /* Parameter validation */
711
Len Brown4be44fc2005-08-05 00:44:28 -0400712 if (!obj_handle || !handler || !data) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713 return (AE_BAD_PARAMETER);
714 }
715
Len Brown4be44fc2005-08-05 00:44:28 -0400716 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
717 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 return (status);
719 }
720
721 /* Convert and validate the handle */
722
Len Brown4be44fc2005-08-05 00:44:28 -0400723 node = acpi_ns_map_handle_to_node(obj_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 if (!node) {
725 status = AE_BAD_PARAMETER;
726 goto unlock_and_exit;
727 }
728
Len Brown4be44fc2005-08-05 00:44:28 -0400729 status = acpi_ns_attach_data(node, handler, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730
Len Brown4be44fc2005-08-05 00:44:28 -0400731 unlock_and_exit:
732 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 return (status);
734}
735
Bob Moore83135242006-10-03 00:00:00 -0400736ACPI_EXPORT_SYMBOL(acpi_attach_data)
737
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738/*******************************************************************************
739 *
740 * FUNCTION: acpi_detach_data
741 *
742 * PARAMETERS: obj_handle - Namespace node handle
743 * Handler - Handler used in call to acpi_attach_data
744 *
745 * RETURN: Status
746 *
747 * DESCRIPTION: Remove data that was previously attached to a node.
748 *
749 ******************************************************************************/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400751acpi_detach_data(acpi_handle obj_handle, acpi_object_handler handler)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752{
Len Brown4be44fc2005-08-05 00:44:28 -0400753 struct acpi_namespace_node *node;
754 acpi_status status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755
756 /* Parameter validation */
757
Len Brown4be44fc2005-08-05 00:44:28 -0400758 if (!obj_handle || !handler) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759 return (AE_BAD_PARAMETER);
760 }
761
Len Brown4be44fc2005-08-05 00:44:28 -0400762 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
763 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764 return (status);
765 }
766
767 /* Convert and validate the handle */
768
Len Brown4be44fc2005-08-05 00:44:28 -0400769 node = acpi_ns_map_handle_to_node(obj_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700770 if (!node) {
771 status = AE_BAD_PARAMETER;
772 goto unlock_and_exit;
773 }
774
Len Brown4be44fc2005-08-05 00:44:28 -0400775 status = acpi_ns_detach_data(node, handler);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776
Len Brown4be44fc2005-08-05 00:44:28 -0400777 unlock_and_exit:
778 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 return (status);
780}
781
Bob Moore83135242006-10-03 00:00:00 -0400782ACPI_EXPORT_SYMBOL(acpi_detach_data)
783
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784/*******************************************************************************
785 *
786 * FUNCTION: acpi_get_data
787 *
788 * PARAMETERS: obj_handle - Namespace node
789 * Handler - Handler used in call to attach_data
790 * Data - Where the data is returned
791 *
792 * RETURN: Status
793 *
794 * DESCRIPTION: Retrieve data that was previously attached to a namespace node.
795 *
796 ******************************************************************************/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400798acpi_get_data(acpi_handle obj_handle, acpi_object_handler handler, void **data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799{
Len Brown4be44fc2005-08-05 00:44:28 -0400800 struct acpi_namespace_node *node;
801 acpi_status status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802
803 /* Parameter validation */
804
Len Brown4be44fc2005-08-05 00:44:28 -0400805 if (!obj_handle || !handler || !data) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 return (AE_BAD_PARAMETER);
807 }
808
Len Brown4be44fc2005-08-05 00:44:28 -0400809 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
810 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 return (status);
812 }
813
814 /* Convert and validate the handle */
815
Len Brown4be44fc2005-08-05 00:44:28 -0400816 node = acpi_ns_map_handle_to_node(obj_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 if (!node) {
818 status = AE_BAD_PARAMETER;
819 goto unlock_and_exit;
820 }
821
Len Brown4be44fc2005-08-05 00:44:28 -0400822 status = acpi_ns_get_attached_data(node, handler, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823
Len Brown4be44fc2005-08-05 00:44:28 -0400824 unlock_and_exit:
825 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 return (status);
827}
Bob Moore83135242006-10-03 00:00:00 -0400828
829ACPI_EXPORT_SYMBOL(acpi_get_data)