blob: ee4d873f9f0aee6f8e8437261695c4e13343b9cc [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/*
Bob Moore77848132012-01-12 13:27:23 +08009 * Copyright (C) 2000 - 2012, 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
Paul Gortmaker214f2c92011-10-26 16:22:14 -040045#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070046#include <acpi/acpi.h>
Len Browne2f7a772009-01-09 00:30:03 -050047#include "accommon.h"
48#include "acnamesp.h"
49#include "acinterp.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070050
Linus Torvalds1da177e2005-04-16 15:20:36 -070051#define _COMPONENT ACPI_NAMESPACE
Len Brown4be44fc2005-08-05 00:44:28 -040052ACPI_MODULE_NAME("nsxfeval")
Lin Mingbbc24132008-08-04 13:22:10 +080053
54/* Local prototypes */
55static void acpi_ns_resolve_references(struct acpi_evaluate_info *info);
56
Linus Torvalds1da177e2005-04-16 15:20:36 -070057/*******************************************************************************
58 *
59 * FUNCTION: acpi_evaluate_object_typed
60 *
Bob Mooreba494be2012-07-12 09:40:10 +080061 * PARAMETERS: handle - Object handle (optional)
62 * pathname - Object pathname (optional)
Robert Moore44f6c012005-04-18 22:49:35 -040063 * external_params - List of parameters to pass to method,
Linus Torvalds1da177e2005-04-16 15:20:36 -070064 * terminated by NULL. May be NULL
65 * if no parameters are being passed.
Robert Moore44f6c012005-04-18 22:49:35 -040066 * return_buffer - Where to put method's return value (if
Linus Torvalds1da177e2005-04-16 15:20:36 -070067 * any). If NULL, no value is returned.
68 * return_type - Expected type of return object
69 *
70 * RETURN: Status
71 *
72 * DESCRIPTION: Find and evaluate the given object, passing the given
73 * parameters if necessary. One of "Handle" or "Pathname" must
74 * be valid (non-null)
75 *
76 ******************************************************************************/
Lin Mingbbc24132008-08-04 13:22:10 +080077
Linus Torvalds1da177e2005-04-16 15:20:36 -070078acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040079acpi_evaluate_object_typed(acpi_handle handle,
80 acpi_string pathname,
Len Brownfd350942007-05-09 23:34:35 -040081 struct acpi_object_list *external_params,
82 struct acpi_buffer *return_buffer,
Len Brown4be44fc2005-08-05 00:44:28 -040083 acpi_object_type return_type)
Linus Torvalds1da177e2005-04-16 15:20:36 -070084{
Len Brown4be44fc2005-08-05 00:44:28 -040085 acpi_status status;
86 u8 must_free = FALSE;
Linus Torvalds1da177e2005-04-16 15:20:36 -070087
Bob Mooreb229cf92006-04-21 17:15:00 -040088 ACPI_FUNCTION_TRACE(acpi_evaluate_object_typed);
Linus Torvalds1da177e2005-04-16 15:20:36 -070089
90 /* Return buffer must be valid */
91
92 if (!return_buffer) {
Len Brown4be44fc2005-08-05 00:44:28 -040093 return_ACPI_STATUS(AE_BAD_PARAMETER);
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 }
95
96 if (return_buffer->length == ACPI_ALLOCATE_BUFFER) {
97 must_free = TRUE;
98 }
99
100 /* Evaluate the object */
101
Len Brown4be44fc2005-08-05 00:44:28 -0400102 status =
103 acpi_evaluate_object(handle, pathname, external_params,
104 return_buffer);
105 if (ACPI_FAILURE(status)) {
106 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 }
108
109 /* Type ANY means "don't care" */
110
111 if (return_type == ACPI_TYPE_ANY) {
Len Brown4be44fc2005-08-05 00:44:28 -0400112 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 }
114
115 if (return_buffer->length == 0) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400116
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117 /* Error because caller specifically asked for a return value */
118
Bob Mooreb8e4d892006-01-27 16:43:00 -0500119 ACPI_ERROR((AE_INFO, "No return value"));
Len Brown4be44fc2005-08-05 00:44:28 -0400120 return_ACPI_STATUS(AE_NULL_OBJECT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121 }
122
123 /* Examine the object type returned from evaluate_object */
124
Len Brown4be44fc2005-08-05 00:44:28 -0400125 if (((union acpi_object *)return_buffer->pointer)->type == return_type) {
126 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127 }
128
129 /* Return object type does not match requested type */
130
Bob Mooreb8e4d892006-01-27 16:43:00 -0500131 ACPI_ERROR((AE_INFO,
132 "Incorrect return type [%s] requested [%s]",
133 acpi_ut_get_type_name(((union acpi_object *)return_buffer->
134 pointer)->type),
135 acpi_ut_get_type_name(return_type)));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136
137 if (must_free) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400138
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 /* Caller used ACPI_ALLOCATE_BUFFER, free the return buffer */
140
Len Brown02438d82006-06-30 03:19:10 -0400141 ACPI_FREE(return_buffer->pointer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 return_buffer->pointer = NULL;
143 }
144
145 return_buffer->length = 0;
Len Brown4be44fc2005-08-05 00:44:28 -0400146 return_ACPI_STATUS(AE_TYPE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147}
Bob Moore83135242006-10-03 00:00:00 -0400148
149ACPI_EXPORT_SYMBOL(acpi_evaluate_object_typed)
Luca Tettamanti2c03d072009-04-07 15:32:59 +0200150
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151/*******************************************************************************
152 *
153 * FUNCTION: acpi_evaluate_object
154 *
Bob Mooreba494be2012-07-12 09:40:10 +0800155 * PARAMETERS: handle - Object handle (optional)
156 * pathname - Object pathname (optional)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 * external_params - List of parameters to pass to method,
158 * terminated by NULL. May be NULL
159 * if no parameters are being passed.
160 * return_buffer - Where to put method's return value (if
161 * any). If NULL, no value is returned.
162 *
163 * RETURN: Status
164 *
165 * DESCRIPTION: Find and evaluate the given object, passing the given
166 * parameters if necessary. One of "Handle" or "Pathname" must
167 * be valid (non-null)
168 *
169 ******************************************************************************/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400171acpi_evaluate_object(acpi_handle handle,
172 acpi_string pathname,
173 struct acpi_object_list *external_params,
174 struct acpi_buffer *return_buffer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175{
Len Brown4be44fc2005-08-05 00:44:28 -0400176 acpi_status status;
Bob Moore41195322006-05-26 16:36:00 -0400177 struct acpi_evaluate_info *info;
Len Brown4be44fc2005-08-05 00:44:28 -0400178 acpi_size buffer_space_needed;
179 u32 i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180
Bob Mooreb229cf92006-04-21 17:15:00 -0400181 ACPI_FUNCTION_TRACE(acpi_evaluate_object);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182
Bob Moore41195322006-05-26 16:36:00 -0400183 /* Allocate and initialize the evaluation information block */
184
185 info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
186 if (!info) {
187 return_ACPI_STATUS(AE_NO_MEMORY);
188 }
189
190 info->pathname = pathname;
Bob Moore41195322006-05-26 16:36:00 -0400191
192 /* Convert and validate the device handle */
193
Bob Mooref24b6642009-12-11 14:57:00 +0800194 info->prefix_node = acpi_ns_validate_handle(handle);
Bob Moore41195322006-05-26 16:36:00 -0400195 if (!info->prefix_node) {
196 status = AE_BAD_PARAMETER;
197 goto cleanup;
198 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
200 /*
Bob Moore41195322006-05-26 16:36:00 -0400201 * If there are parameters to be passed to a control method, the external
202 * objects must all be converted to internal objects
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203 */
204 if (external_params && external_params->count) {
205 /*
206 * Allocate a new parameter block for the internal objects
207 * Add 1 to count to allow for null terminated internal list
208 */
Bob Moore41195322006-05-26 16:36:00 -0400209 info->parameters = ACPI_ALLOCATE_ZEROED(((acpi_size)
210 external_params->
211 count +
212 1) * sizeof(void *));
213 if (!info->parameters) {
214 status = AE_NO_MEMORY;
215 goto cleanup;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 }
217
Bob Moore41195322006-05-26 16:36:00 -0400218 /* Convert each external object in the list to an internal object */
219
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220 for (i = 0; i < external_params->count; i++) {
Len Brown4be44fc2005-08-05 00:44:28 -0400221 status =
222 acpi_ut_copy_eobject_to_iobject(&external_params->
223 pointer[i],
Bob Moore41195322006-05-26 16:36:00 -0400224 &info->
Len Brown4be44fc2005-08-05 00:44:28 -0400225 parameters[i]);
226 if (ACPI_FAILURE(status)) {
Bob Moore41195322006-05-26 16:36:00 -0400227 goto cleanup;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228 }
229 }
Bob Moore41195322006-05-26 16:36:00 -0400230 info->parameters[external_params->count] = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 }
232
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 /*
234 * Three major cases:
235 * 1) Fully qualified pathname
236 * 2) No handle, not fully qualified pathname (error)
237 * 3) Valid handle
238 */
Len Brown4be44fc2005-08-05 00:44:28 -0400239 if ((pathname) && (acpi_ns_valid_root_prefix(pathname[0]))) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400240
241 /* The path is fully qualified, just evaluate by name */
242
Bob Moore41195322006-05-26 16:36:00 -0400243 info->prefix_node = NULL;
244 status = acpi_ns_evaluate(info);
Len Brown4be44fc2005-08-05 00:44:28 -0400245 } else if (!handle) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 /*
Bob Moore41195322006-05-26 16:36:00 -0400247 * A handle is optional iff a fully qualified pathname is specified.
248 * Since we've already handled fully qualified names above, this is
249 * an error
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 */
251 if (!pathname) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400252 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
253 "Both Handle and Pathname are NULL"));
Len Brown4be44fc2005-08-05 00:44:28 -0400254 } else {
Bob Moore52fc0b02006-10-02 00:00:00 -0400255 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
256 "Null Handle with relative pathname [%s]",
257 pathname));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 }
259
260 status = AE_BAD_PARAMETER;
Len Brown4be44fc2005-08-05 00:44:28 -0400261 } else {
Bob Moore41195322006-05-26 16:36:00 -0400262 /* We have a namespace a node and a possible relative path */
Bob Moore52fc0b02006-10-02 00:00:00 -0400263
Bob Moore41195322006-05-26 16:36:00 -0400264 status = acpi_ns_evaluate(info);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 }
266
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 /*
268 * If we are expecting a return value, and all went well above,
269 * copy the return value to an external object.
270 */
271 if (return_buffer) {
Bob Moore41195322006-05-26 16:36:00 -0400272 if (!info->return_object) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 return_buffer->length = 0;
Len Brown4be44fc2005-08-05 00:44:28 -0400274 } else {
Bob Moore41195322006-05-26 16:36:00 -0400275 if (ACPI_GET_DESCRIPTOR_TYPE(info->return_object) ==
Len Brown4be44fc2005-08-05 00:44:28 -0400276 ACPI_DESC_TYPE_NAMED) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 /*
278 * If we received a NS Node as a return object, this means that
279 * the object we are evaluating has nothing interesting to
280 * return (such as a mutex, etc.) We return an error because
281 * these types are essentially unsupported by this interface.
282 * We don't check up front because this makes it easier to add
283 * support for various types at a later date if necessary.
284 */
285 status = AE_TYPE;
Bob Moore41195322006-05-26 16:36:00 -0400286 info->return_object = NULL; /* No need to delete a NS Node */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 return_buffer->length = 0;
288 }
289
Len Brown4be44fc2005-08-05 00:44:28 -0400290 if (ACPI_SUCCESS(status)) {
Bob Moore41195322006-05-26 16:36:00 -0400291
Lin Mingbbc24132008-08-04 13:22:10 +0800292 /* Dereference Index and ref_of references */
293
294 acpi_ns_resolve_references(info);
295
Bob Moore41195322006-05-26 16:36:00 -0400296 /* Get the size of the returned object */
297
Len Brown4be44fc2005-08-05 00:44:28 -0400298 status =
Bob Moore41195322006-05-26 16:36:00 -0400299 acpi_ut_get_object_size(info->return_object,
Len Brown4be44fc2005-08-05 00:44:28 -0400300 &buffer_space_needed);
301 if (ACPI_SUCCESS(status)) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400302
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 /* Validate/Allocate/Clear caller buffer */
304
Len Brown4be44fc2005-08-05 00:44:28 -0400305 status =
306 acpi_ut_initialize_buffer
307 (return_buffer,
308 buffer_space_needed);
309 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310 /*
Bob Moore52fc0b02006-10-02 00:00:00 -0400311 * Caller's buffer is too small or a new one can't
312 * be allocated
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313 */
Len Brown4be44fc2005-08-05 00:44:28 -0400314 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
315 "Needed buffer size %X, %s\n",
316 (u32)
317 buffer_space_needed,
318 acpi_format_exception
319 (status)));
320 } else {
Bob Moore52fc0b02006-10-02 00:00:00 -0400321 /* We have enough space for the object, build it */
322
Len Brown4be44fc2005-08-05 00:44:28 -0400323 status =
324 acpi_ut_copy_iobject_to_eobject
Bob Moore41195322006-05-26 16:36:00 -0400325 (info->return_object,
Len Brown4be44fc2005-08-05 00:44:28 -0400326 return_buffer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 }
328 }
329 }
330 }
331 }
332
Bob Moore41195322006-05-26 16:36:00 -0400333 if (info->return_object) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334 /*
Bob Moore41195322006-05-26 16:36:00 -0400335 * Delete the internal return object. NOTE: Interpreter must be
336 * locked to avoid race condition.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 */
Len Brown4d2acd92007-05-09 22:56:38 -0400338 acpi_ex_enter_interpreter();
Bob Moore41195322006-05-26 16:36:00 -0400339
Len Brown4d2acd92007-05-09 22:56:38 -0400340 /* Remove one reference on the return object (should delete it) */
Bob Moore41195322006-05-26 16:36:00 -0400341
Len Brown4d2acd92007-05-09 22:56:38 -0400342 acpi_ut_remove_reference(info->return_object);
343 acpi_ex_exit_interpreter();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344 }
345
Bob Moore41195322006-05-26 16:36:00 -0400346 cleanup:
347
Bob Moore52fc0b02006-10-02 00:00:00 -0400348 /* Free the input parameter list (if we created one) */
349
Bob Moore41195322006-05-26 16:36:00 -0400350 if (info->parameters) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400351
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 /* Free the allocated parameter block */
353
Bob Moore41195322006-05-26 16:36:00 -0400354 acpi_ut_delete_internal_object_list(info->parameters);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 }
356
Bob Moore41195322006-05-26 16:36:00 -0400357 ACPI_FREE(info);
Len Brown4be44fc2005-08-05 00:44:28 -0400358 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360
Bob Moore83135242006-10-03 00:00:00 -0400361ACPI_EXPORT_SYMBOL(acpi_evaluate_object)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362
363/*******************************************************************************
364 *
Lin Mingbbc24132008-08-04 13:22:10 +0800365 * FUNCTION: acpi_ns_resolve_references
366 *
Bob Mooreba494be2012-07-12 09:40:10 +0800367 * PARAMETERS: info - Evaluation info block
Lin Mingbbc24132008-08-04 13:22:10 +0800368 *
369 * RETURN: Info->return_object is replaced with the dereferenced object
370 *
371 * DESCRIPTION: Dereference certain reference objects. Called before an
372 * internal return object is converted to an external union acpi_object.
373 *
374 * Performs an automatic dereference of Index and ref_of reference objects.
375 * These reference objects are not supported by the union acpi_object, so this is a
376 * last resort effort to return something useful. Also, provides compatibility
377 * with other ACPI implementations.
378 *
379 * NOTE: does not handle references within returned package objects or nested
380 * references, but this support could be added later if found to be necessary.
381 *
382 ******************************************************************************/
383static void acpi_ns_resolve_references(struct acpi_evaluate_info *info)
384{
385 union acpi_operand_object *obj_desc = NULL;
386 struct acpi_namespace_node *node;
387
388 /* We are interested in reference objects only */
389
Bob Moore3371c192009-02-18 14:44:03 +0800390 if ((info->return_object)->common.type != ACPI_TYPE_LOCAL_REFERENCE) {
Lin Mingbbc24132008-08-04 13:22:10 +0800391 return;
392 }
393
394 /*
395 * Two types of references are supported - those created by Index and
396 * ref_of operators. A name reference (AML_NAMEPATH_OP) can be converted
397 * to an union acpi_object, so it is not dereferenced here. A ddb_handle
398 * (AML_LOAD_OP) cannot be dereferenced, nor can it be converted to
399 * an union acpi_object.
400 */
Bob Moore1044f1f2008-09-27 11:08:41 +0800401 switch (info->return_object->reference.class) {
402 case ACPI_REFCLASS_INDEX:
Lin Mingbbc24132008-08-04 13:22:10 +0800403
404 obj_desc = *(info->return_object->reference.where);
405 break;
406
Bob Moore1044f1f2008-09-27 11:08:41 +0800407 case ACPI_REFCLASS_REFOF:
Lin Mingbbc24132008-08-04 13:22:10 +0800408
409 node = info->return_object->reference.object;
410 if (node) {
411 obj_desc = node->object;
412 }
413 break;
414
415 default:
416 return;
417 }
418
419 /* Replace the existing reference object */
420
421 if (obj_desc) {
422 acpi_ut_add_reference(obj_desc);
423 acpi_ut_remove_reference(info->return_object);
424 info->return_object = obj_desc;
425 }
426
427 return;
428}
429
430/*******************************************************************************
431 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 * FUNCTION: acpi_walk_namespace
433 *
Bob Mooreba494be2012-07-12 09:40:10 +0800434 * PARAMETERS: type - acpi_object_type to search for
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 * start_object - Handle in namespace where search begins
436 * max_depth - Depth to which search is to reach
Lin Ming22635762009-11-13 10:06:08 +0800437 * pre_order_visit - Called during tree pre-order visit
438 * when an object of "Type" is found
439 * post_order_visit - Called during tree post-order visit
440 * when an object of "Type" is found
Bob Mooreba494be2012-07-12 09:40:10 +0800441 * context - Passed to user function(s) above
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 * return_value - Location where return value of
443 * user_function is put if terminated early
444 *
445 * RETURNS Return value from the user_function if terminated early.
446 * Otherwise, returns NULL.
447 *
448 * DESCRIPTION: Performs a modified depth-first walk of the namespace tree,
449 * starting (and ending) at the object specified by start_handle.
Lin Ming22635762009-11-13 10:06:08 +0800450 * The callback function is called whenever an object that matches
451 * the type parameter is found. If the callback function returns
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 * a non-zero value, the search is terminated immediately and this
453 * value is returned to the caller.
454 *
455 * The point of this procedure is to provide a generic namespace
456 * walk routine that can be called from multiple places to
Lin Ming22635762009-11-13 10:06:08 +0800457 * provide multiple services; the callback function(s) can be
458 * tailored to each task, whether it is a print function,
459 * a compare function, etc.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460 *
461 ******************************************************************************/
Lin Mingbbc24132008-08-04 13:22:10 +0800462
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400464acpi_walk_namespace(acpi_object_type type,
465 acpi_handle start_object,
466 u32 max_depth,
Lin Ming22635762009-11-13 10:06:08 +0800467 acpi_walk_callback pre_order_visit,
468 acpi_walk_callback post_order_visit,
Len Brown4be44fc2005-08-05 00:44:28 -0400469 void *context, void **return_value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470{
Len Brown4be44fc2005-08-05 00:44:28 -0400471 acpi_status status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472
Bob Mooreb229cf92006-04-21 17:15:00 -0400473 ACPI_FUNCTION_TRACE(acpi_walk_namespace);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474
475 /* Parameter validation */
476
Lin Ming22635762009-11-13 10:06:08 +0800477 if ((type > ACPI_TYPE_LOCAL_MAX) ||
478 (!max_depth) || (!pre_order_visit && !post_order_visit)) {
Len Brown4be44fc2005-08-05 00:44:28 -0400479 return_ACPI_STATUS(AE_BAD_PARAMETER);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480 }
481
482 /*
Bob Moore8a335a232009-03-09 16:31:04 +0800483 * Need to acquire the namespace reader lock to prevent interference
484 * with any concurrent table unloads (which causes the deletion of
485 * namespace objects). We cannot allow the deletion of a namespace node
486 * while the user function is using it. The exception to this are the
487 * nodes created and deleted during control method execution -- these
488 * nodes are marked as temporary nodes and are ignored by the namespace
489 * walk. Thus, control methods can be executed while holding the
490 * namespace deletion lock (and the user function can execute control
491 * methods.)
492 */
493 status = acpi_ut_acquire_read_lock(&acpi_gbl_namespace_rw_lock);
494 if (ACPI_FAILURE(status)) {
495 return status;
496 }
497
498 /*
499 * Lock the namespace around the walk. The namespace will be
500 * unlocked/locked around each call to the user function - since the user
501 * function must be allowed to make ACPICA calls itself (for example, it
502 * will typically execute control methods during device enumeration.)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 */
Len Brown4be44fc2005-08-05 00:44:28 -0400504 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
505 if (ACPI_FAILURE(status)) {
Bob Moore8a335a232009-03-09 16:31:04 +0800506 goto unlock_and_exit;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507 }
508
Len Brown4be44fc2005-08-05 00:44:28 -0400509 status = acpi_ns_walk_namespace(type, start_object, max_depth,
Lin Ming22635762009-11-13 10:06:08 +0800510 ACPI_NS_WALK_UNLOCK, pre_order_visit,
511 post_order_visit, context,
512 return_value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513
Len Brown4be44fc2005-08-05 00:44:28 -0400514 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
Bob Moore8a335a232009-03-09 16:31:04 +0800515
516 unlock_and_exit:
517 (void)acpi_ut_release_read_lock(&acpi_gbl_namespace_rw_lock);
Len Brown4be44fc2005-08-05 00:44:28 -0400518 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520
Bob Moore83135242006-10-03 00:00:00 -0400521ACPI_EXPORT_SYMBOL(acpi_walk_namespace)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522
523/*******************************************************************************
524 *
525 * FUNCTION: acpi_ns_get_device_callback
526 *
527 * PARAMETERS: Callback from acpi_get_device
528 *
529 * RETURN: Status
530 *
531 * DESCRIPTION: Takes callbacks from walk_namespace and filters out all non-
532 * present devices, or if they specified a HID, it filters based
533 * on that.
534 *
535 ******************************************************************************/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536static acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400537acpi_ns_get_device_callback(acpi_handle obj_handle,
538 u32 nesting_level,
539 void *context, void **return_value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540{
Len Brown4be44fc2005-08-05 00:44:28 -0400541 struct acpi_get_devices_info *info = context;
542 acpi_status status;
543 struct acpi_namespace_node *node;
544 u32 flags;
Lv Zheng78e25fe2012-10-31 02:25:24 +0000545 struct acpi_pnp_device_id *hid;
546 struct acpi_pnp_device_id_list *cid;
Bob Moore67a119f2008-06-10 13:42:13 +0800547 u32 i;
Bob Moore15b8dd52009-06-29 13:39:29 +0800548 u8 found;
549 int no_match;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550
Len Brown4be44fc2005-08-05 00:44:28 -0400551 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
552 if (ACPI_FAILURE(status)) {
Bob Moore68aafc32012-10-31 02:26:01 +0000553 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 }
555
Bob Mooref24b6642009-12-11 14:57:00 +0800556 node = acpi_ns_validate_handle(obj_handle);
Len Brown4be44fc2005-08-05 00:44:28 -0400557 status = acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
558 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 return (status);
560 }
561
562 if (!node) {
563 return (AE_BAD_PARAMETER);
564 }
565
Lin Ming5f8902ac2010-01-21 09:15:20 +0800566 /*
567 * First, filter based on the device HID and CID.
568 *
569 * 01/2010: For this case where a specific HID is requested, we don't
570 * want to run _STA until we have an actual HID match. Thus, we will
571 * not unnecessarily execute _STA on devices for which the caller
572 * doesn't care about. Previously, _STA was executed unconditionally
573 * on all devices found here.
574 *
575 * A side-effect of this change is that now we will continue to search
576 * for a matching HID even under device trees where the parent device
577 * would have returned a _STA that indicates it is not present or
578 * not functioning (thus aborting the search on that branch).
579 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 if (info->hid != NULL) {
Len Brown4be44fc2005-08-05 00:44:28 -0400581 status = acpi_ut_execute_HID(node, &hid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582 if (status == AE_NOT_FOUND) {
583 return (AE_OK);
Len Brown4be44fc2005-08-05 00:44:28 -0400584 } else if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 return (AE_CTRL_DEPTH);
586 }
587
Bob Moore15b8dd52009-06-29 13:39:29 +0800588 no_match = ACPI_STRCMP(hid->string, info->hid);
589 ACPI_FREE(hid);
Bob Moore52fc0b02006-10-02 00:00:00 -0400590
Bob Moore15b8dd52009-06-29 13:39:29 +0800591 if (no_match) {
592 /*
593 * HID does not match, attempt match within the
594 * list of Compatible IDs (CIDs)
595 */
Len Brown4be44fc2005-08-05 00:44:28 -0400596 status = acpi_ut_execute_CID(node, &cid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 if (status == AE_NOT_FOUND) {
598 return (AE_OK);
Len Brown4be44fc2005-08-05 00:44:28 -0400599 } else if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 return (AE_CTRL_DEPTH);
601 }
602
603 /* Walk the CID list */
604
Andrew Patterson02f8a852008-01-22 17:18:22 -0700605 found = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 for (i = 0; i < cid->count; i++) {
Bob Moore15b8dd52009-06-29 13:39:29 +0800607 if (ACPI_STRCMP(cid->ids[i].string, info->hid)
608 == 0) {
Andrew Patterson02f8a852008-01-22 17:18:22 -0700609 found = 1;
610 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 }
612 }
Bob Moore83135242006-10-03 00:00:00 -0400613 ACPI_FREE(cid);
Andrew Patterson02f8a852008-01-22 17:18:22 -0700614 if (!found)
615 return (AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616 }
617 }
618
Lin Ming5f8902ac2010-01-21 09:15:20 +0800619 /* Run _STA to determine if device is present */
620
621 status = acpi_ut_execute_STA(node, &flags);
622 if (ACPI_FAILURE(status)) {
623 return (AE_CTRL_DEPTH);
624 }
625
626 if (!(flags & ACPI_STA_DEVICE_PRESENT) &&
627 !(flags & ACPI_STA_DEVICE_FUNCTIONING)) {
628 /*
629 * Don't examine the children of the device only when the
630 * device is neither present nor functional. See ACPI spec,
631 * description of _STA for more information.
632 */
633 return (AE_CTRL_DEPTH);
634 }
635
636 /* We have a valid device, invoke the user function */
637
Len Brown4be44fc2005-08-05 00:44:28 -0400638 status = info->user_function(obj_handle, nesting_level, info->context,
639 return_value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 return (status);
641}
642
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643/*******************************************************************************
644 *
645 * FUNCTION: acpi_get_devices
646 *
647 * PARAMETERS: HID - HID to search for. Can be NULL.
648 * user_function - Called when a matching object is found
Bob Mooreba494be2012-07-12 09:40:10 +0800649 * context - Passed to user function
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 * return_value - Location where return value of
651 * user_function is put if terminated early
652 *
653 * RETURNS Return value from the user_function if terminated early.
654 * Otherwise, returns NULL.
655 *
656 * DESCRIPTION: Performs a modified depth-first walk of the namespace tree,
657 * starting (and ending) at the object specified by start_handle.
658 * The user_function is called whenever an object of type
659 * Device is found. If the user function returns
660 * a non-zero value, the search is terminated immediately and this
661 * value is returned to the caller.
662 *
663 * This is a wrapper for walk_namespace, but the callback performs
Bob Moore549f4602008-04-10 19:06:41 +0400664 * additional filtering. Please see acpi_ns_get_device_callback.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665 *
666 ******************************************************************************/
667
668acpi_status
Al Viro70b30fb2007-08-21 16:18:20 +0100669acpi_get_devices(const char *HID,
Len Brown4be44fc2005-08-05 00:44:28 -0400670 acpi_walk_callback user_function,
671 void *context, void **return_value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672{
Len Brown4be44fc2005-08-05 00:44:28 -0400673 acpi_status status;
674 struct acpi_get_devices_info info;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675
Bob Mooreb229cf92006-04-21 17:15:00 -0400676 ACPI_FUNCTION_TRACE(acpi_get_devices);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677
678 /* Parameter validation */
679
680 if (!user_function) {
Len Brown4be44fc2005-08-05 00:44:28 -0400681 return_ACPI_STATUS(AE_BAD_PARAMETER);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 }
683
684 /*
685 * We're going to call their callback from OUR callback, so we need
686 * to know what it is, and their context parameter.
687 */
Bob Moore52fc0b02006-10-02 00:00:00 -0400688 info.hid = HID;
Len Brown4be44fc2005-08-05 00:44:28 -0400689 info.context = context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690 info.user_function = user_function;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691
692 /*
693 * Lock the namespace around the walk.
694 * The namespace will be unlocked/locked around each call
695 * to the user function - since this function
696 * must be allowed to make Acpi calls itself.
697 */
Len Brown4be44fc2005-08-05 00:44:28 -0400698 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
699 if (ACPI_FAILURE(status)) {
700 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701 }
702
Bob Moore52fc0b02006-10-02 00:00:00 -0400703 status = acpi_ns_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
704 ACPI_UINT32_MAX, ACPI_NS_WALK_UNLOCK,
Lin Ming22635762009-11-13 10:06:08 +0800705 acpi_ns_get_device_callback, NULL,
706 &info, return_value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707
Len Brown4be44fc2005-08-05 00:44:28 -0400708 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
709 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711
Bob Moore83135242006-10-03 00:00:00 -0400712ACPI_EXPORT_SYMBOL(acpi_get_devices)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713
714/*******************************************************************************
715 *
716 * FUNCTION: acpi_attach_data
717 *
718 * PARAMETERS: obj_handle - Namespace node
Bob Mooreba494be2012-07-12 09:40:10 +0800719 * handler - Handler for this attachment
720 * data - Pointer to data to be attached
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721 *
722 * RETURN: Status
723 *
724 * DESCRIPTION: Attach arbitrary data and handler to a namespace node.
725 *
726 ******************************************************************************/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400728acpi_attach_data(acpi_handle obj_handle,
729 acpi_object_handler handler, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730{
Len Brown4be44fc2005-08-05 00:44:28 -0400731 struct acpi_namespace_node *node;
732 acpi_status status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733
734 /* Parameter validation */
735
Len Brown4be44fc2005-08-05 00:44:28 -0400736 if (!obj_handle || !handler || !data) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 return (AE_BAD_PARAMETER);
738 }
739
Len Brown4be44fc2005-08-05 00:44:28 -0400740 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
741 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 return (status);
743 }
744
745 /* Convert and validate the handle */
746
Bob Mooref24b6642009-12-11 14:57:00 +0800747 node = acpi_ns_validate_handle(obj_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 if (!node) {
749 status = AE_BAD_PARAMETER;
750 goto unlock_and_exit;
751 }
752
Len Brown4be44fc2005-08-05 00:44:28 -0400753 status = acpi_ns_attach_data(node, handler, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754
Len Brown4be44fc2005-08-05 00:44:28 -0400755 unlock_and_exit:
756 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757 return (status);
758}
759
Bob Moore83135242006-10-03 00:00:00 -0400760ACPI_EXPORT_SYMBOL(acpi_attach_data)
761
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762/*******************************************************************************
763 *
764 * FUNCTION: acpi_detach_data
765 *
766 * PARAMETERS: obj_handle - Namespace node handle
Bob Mooreba494be2012-07-12 09:40:10 +0800767 * handler - Handler used in call to acpi_attach_data
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768 *
769 * RETURN: Status
770 *
771 * DESCRIPTION: Remove data that was previously attached to a node.
772 *
773 ******************************************************************************/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400775acpi_detach_data(acpi_handle obj_handle, acpi_object_handler handler)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776{
Len Brown4be44fc2005-08-05 00:44:28 -0400777 struct acpi_namespace_node *node;
778 acpi_status status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779
780 /* Parameter validation */
781
Len Brown4be44fc2005-08-05 00:44:28 -0400782 if (!obj_handle || !handler) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 return (AE_BAD_PARAMETER);
784 }
785
Len Brown4be44fc2005-08-05 00:44:28 -0400786 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
787 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 return (status);
789 }
790
791 /* Convert and validate the handle */
792
Bob Mooref24b6642009-12-11 14:57:00 +0800793 node = acpi_ns_validate_handle(obj_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 if (!node) {
795 status = AE_BAD_PARAMETER;
796 goto unlock_and_exit;
797 }
798
Len Brown4be44fc2005-08-05 00:44:28 -0400799 status = acpi_ns_detach_data(node, handler);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800
Len Brown4be44fc2005-08-05 00:44:28 -0400801 unlock_and_exit:
802 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803 return (status);
804}
805
Bob Moore83135242006-10-03 00:00:00 -0400806ACPI_EXPORT_SYMBOL(acpi_detach_data)
807
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808/*******************************************************************************
809 *
810 * FUNCTION: acpi_get_data
811 *
812 * PARAMETERS: obj_handle - Namespace node
Bob Mooreba494be2012-07-12 09:40:10 +0800813 * handler - Handler used in call to attach_data
814 * data - Where the data is returned
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 *
816 * RETURN: Status
817 *
818 * DESCRIPTION: Retrieve data that was previously attached to a namespace node.
819 *
820 ******************************************************************************/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400822acpi_get_data(acpi_handle obj_handle, acpi_object_handler handler, void **data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823{
Len Brown4be44fc2005-08-05 00:44:28 -0400824 struct acpi_namespace_node *node;
825 acpi_status status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826
827 /* Parameter validation */
828
Len Brown4be44fc2005-08-05 00:44:28 -0400829 if (!obj_handle || !handler || !data) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830 return (AE_BAD_PARAMETER);
831 }
832
Len Brown4be44fc2005-08-05 00:44:28 -0400833 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
834 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 return (status);
836 }
837
838 /* Convert and validate the handle */
839
Bob Mooref24b6642009-12-11 14:57:00 +0800840 node = acpi_ns_validate_handle(obj_handle);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 if (!node) {
842 status = AE_BAD_PARAMETER;
843 goto unlock_and_exit;
844 }
845
Len Brown4be44fc2005-08-05 00:44:28 -0400846 status = acpi_ns_get_attached_data(node, handler, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847
Len Brown4be44fc2005-08-05 00:44:28 -0400848 unlock_and_exit:
849 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 return (status);
851}
Bob Moore83135242006-10-03 00:00:00 -0400852
853ACPI_EXPORT_SYMBOL(acpi_get_data)