Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /******************************************************************************* |
2 | * | |
3 | * Module Name: nsxfeval - Public interfaces to the ACPI subsystem | |
4 | * ACPI Object evaluation interfaces | |
5 | * | |
6 | ******************************************************************************/ | |
7 | ||
8 | /* | |
77848130 | 9 | * Copyright (C) 2000 - 2012, Intel Corp. |
1da177e4 LT |
10 | * 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 | ||
214f2c90 | 45 | #include <linux/export.h> |
1da177e4 | 46 | #include <acpi/acpi.h> |
e2f7a777 LB |
47 | #include "accommon.h" |
48 | #include "acnamesp.h" | |
49 | #include "acinterp.h" | |
1da177e4 | 50 | |
1da177e4 | 51 | #define _COMPONENT ACPI_NAMESPACE |
4be44fcd | 52 | ACPI_MODULE_NAME("nsxfeval") |
bbc24134 LM |
53 | |
54 | /* Local prototypes */ | |
55 | static void acpi_ns_resolve_references(struct acpi_evaluate_info *info); | |
56 | ||
1da177e4 LT |
57 | /******************************************************************************* |
58 | * | |
59 | * FUNCTION: acpi_evaluate_object_typed | |
60 | * | |
ba494bee BM |
61 | * PARAMETERS: handle - Object handle (optional) |
62 | * pathname - Object pathname (optional) | |
44f6c012 | 63 | * external_params - List of parameters to pass to method, |
73a3090a | 64 | * terminated by NULL. May be NULL |
1da177e4 | 65 | * if no parameters are being passed. |
44f6c012 | 66 | * return_buffer - Where to put method's return value (if |
73a3090a | 67 | * any). If NULL, no value is returned. |
1da177e4 LT |
68 | * return_type - Expected type of return object |
69 | * | |
70 | * RETURN: Status | |
71 | * | |
72 | * DESCRIPTION: Find and evaluate the given object, passing the given | |
73a3090a | 73 | * parameters if necessary. One of "Handle" or "Pathname" must |
1da177e4 LT |
74 | * be valid (non-null) |
75 | * | |
76 | ******************************************************************************/ | |
bbc24134 | 77 | |
1da177e4 | 78 | acpi_status |
4be44fcd LB |
79 | acpi_evaluate_object_typed(acpi_handle handle, |
80 | acpi_string pathname, | |
fd350943 LB |
81 | struct acpi_object_list *external_params, |
82 | struct acpi_buffer *return_buffer, | |
4be44fcd | 83 | acpi_object_type return_type) |
1da177e4 | 84 | { |
4be44fcd LB |
85 | acpi_status status; |
86 | u8 must_free = FALSE; | |
1da177e4 | 87 | |
b229cf92 | 88 | ACPI_FUNCTION_TRACE(acpi_evaluate_object_typed); |
1da177e4 LT |
89 | |
90 | /* Return buffer must be valid */ | |
91 | ||
92 | if (!return_buffer) { | |
4be44fcd | 93 | return_ACPI_STATUS(AE_BAD_PARAMETER); |
1da177e4 LT |
94 | } |
95 | ||
96 | if (return_buffer->length == ACPI_ALLOCATE_BUFFER) { | |
97 | must_free = TRUE; | |
98 | } | |
99 | ||
100 | /* Evaluate the object */ | |
101 | ||
4be44fcd LB |
102 | status = |
103 | acpi_evaluate_object(handle, pathname, external_params, | |
104 | return_buffer); | |
105 | if (ACPI_FAILURE(status)) { | |
106 | return_ACPI_STATUS(status); | |
1da177e4 LT |
107 | } |
108 | ||
109 | /* Type ANY means "don't care" */ | |
110 | ||
111 | if (return_type == ACPI_TYPE_ANY) { | |
4be44fcd | 112 | return_ACPI_STATUS(AE_OK); |
1da177e4 LT |
113 | } |
114 | ||
115 | if (return_buffer->length == 0) { | |
52fc0b02 | 116 | |
1da177e4 LT |
117 | /* Error because caller specifically asked for a return value */ |
118 | ||
b8e4d893 | 119 | ACPI_ERROR((AE_INFO, "No return value")); |
4be44fcd | 120 | return_ACPI_STATUS(AE_NULL_OBJECT); |
1da177e4 LT |
121 | } |
122 | ||
123 | /* Examine the object type returned from evaluate_object */ | |
124 | ||
4be44fcd LB |
125 | if (((union acpi_object *)return_buffer->pointer)->type == return_type) { |
126 | return_ACPI_STATUS(AE_OK); | |
1da177e4 LT |
127 | } |
128 | ||
129 | /* Return object type does not match requested type */ | |
130 | ||
b8e4d893 BM |
131 | 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))); | |
1da177e4 LT |
136 | |
137 | if (must_free) { | |
52fc0b02 | 138 | |
1da177e4 LT |
139 | /* Caller used ACPI_ALLOCATE_BUFFER, free the return buffer */ |
140 | ||
02438d87 | 141 | ACPI_FREE(return_buffer->pointer); |
1da177e4 LT |
142 | return_buffer->pointer = NULL; |
143 | } | |
144 | ||
145 | return_buffer->length = 0; | |
4be44fcd | 146 | return_ACPI_STATUS(AE_TYPE); |
1da177e4 | 147 | } |
8313524a BM |
148 | |
149 | ACPI_EXPORT_SYMBOL(acpi_evaluate_object_typed) | |
2c03d07a | 150 | |
1da177e4 LT |
151 | /******************************************************************************* |
152 | * | |
153 | * FUNCTION: acpi_evaluate_object | |
154 | * | |
ba494bee BM |
155 | * PARAMETERS: handle - Object handle (optional) |
156 | * pathname - Object pathname (optional) | |
1da177e4 | 157 | * external_params - List of parameters to pass to method, |
73a3090a | 158 | * terminated by NULL. May be NULL |
1da177e4 LT |
159 | * if no parameters are being passed. |
160 | * return_buffer - Where to put method's return value (if | |
73a3090a | 161 | * any). If NULL, no value is returned. |
1da177e4 LT |
162 | * |
163 | * RETURN: Status | |
164 | * | |
165 | * DESCRIPTION: Find and evaluate the given object, passing the given | |
73a3090a | 166 | * parameters if necessary. One of "Handle" or "Pathname" must |
1da177e4 LT |
167 | * be valid (non-null) |
168 | * | |
169 | ******************************************************************************/ | |
1da177e4 | 170 | acpi_status |
4be44fcd LB |
171 | acpi_evaluate_object(acpi_handle handle, |
172 | acpi_string pathname, | |
173 | struct acpi_object_list *external_params, | |
174 | struct acpi_buffer *return_buffer) | |
1da177e4 | 175 | { |
4be44fcd | 176 | acpi_status status; |
4119532c | 177 | struct acpi_evaluate_info *info; |
4be44fcd LB |
178 | acpi_size buffer_space_needed; |
179 | u32 i; | |
1da177e4 | 180 | |
b229cf92 | 181 | ACPI_FUNCTION_TRACE(acpi_evaluate_object); |
1da177e4 | 182 | |
4119532c BM |
183 | /* 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; | |
4119532c BM |
191 | |
192 | /* Convert and validate the device handle */ | |
193 | ||
f24b664d | 194 | info->prefix_node = acpi_ns_validate_handle(handle); |
4119532c BM |
195 | if (!info->prefix_node) { |
196 | status = AE_BAD_PARAMETER; | |
197 | goto cleanup; | |
198 | } | |
1da177e4 LT |
199 | |
200 | /* | |
4119532c BM |
201 | * If there are parameters to be passed to a control method, the external |
202 | * objects must all be converted to internal objects | |
1da177e4 LT |
203 | */ |
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 | */ | |
4119532c BM |
209 | 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; | |
1da177e4 LT |
216 | } |
217 | ||
4119532c BM |
218 | /* Convert each external object in the list to an internal object */ |
219 | ||
1da177e4 | 220 | for (i = 0; i < external_params->count; i++) { |
4be44fcd LB |
221 | status = |
222 | acpi_ut_copy_eobject_to_iobject(&external_params-> | |
223 | pointer[i], | |
4119532c | 224 | &info-> |
4be44fcd LB |
225 | parameters[i]); |
226 | if (ACPI_FAILURE(status)) { | |
4119532c | 227 | goto cleanup; |
1da177e4 LT |
228 | } |
229 | } | |
4119532c | 230 | info->parameters[external_params->count] = NULL; |
1da177e4 LT |
231 | } |
232 | ||
1da177e4 LT |
233 | /* |
234 | * Three major cases: | |
235 | * 1) Fully qualified pathname | |
236 | * 2) No handle, not fully qualified pathname (error) | |
237 | * 3) Valid handle | |
238 | */ | |
4be44fcd | 239 | if ((pathname) && (acpi_ns_valid_root_prefix(pathname[0]))) { |
52fc0b02 BM |
240 | |
241 | /* The path is fully qualified, just evaluate by name */ | |
242 | ||
4119532c BM |
243 | info->prefix_node = NULL; |
244 | status = acpi_ns_evaluate(info); | |
4be44fcd | 245 | } else if (!handle) { |
1da177e4 | 246 | /* |
4119532c BM |
247 | * 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 | |
1da177e4 LT |
250 | */ |
251 | if (!pathname) { | |
52fc0b02 BM |
252 | ACPI_DEBUG_PRINT((ACPI_DB_INFO, |
253 | "Both Handle and Pathname are NULL")); | |
4be44fcd | 254 | } else { |
52fc0b02 BM |
255 | ACPI_DEBUG_PRINT((ACPI_DB_INFO, |
256 | "Null Handle with relative pathname [%s]", | |
257 | pathname)); | |
1da177e4 LT |
258 | } |
259 | ||
260 | status = AE_BAD_PARAMETER; | |
4be44fcd | 261 | } else { |
4119532c | 262 | /* We have a namespace a node and a possible relative path */ |
52fc0b02 | 263 | |
4119532c | 264 | status = acpi_ns_evaluate(info); |
1da177e4 LT |
265 | } |
266 | ||
1da177e4 LT |
267 | /* |
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) { | |
4119532c | 272 | if (!info->return_object) { |
1da177e4 | 273 | return_buffer->length = 0; |
4be44fcd | 274 | } else { |
4119532c | 275 | if (ACPI_GET_DESCRIPTOR_TYPE(info->return_object) == |
4be44fcd | 276 | ACPI_DESC_TYPE_NAMED) { |
1da177e4 LT |
277 | /* |
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; | |
4119532c | 286 | info->return_object = NULL; /* No need to delete a NS Node */ |
1da177e4 LT |
287 | return_buffer->length = 0; |
288 | } | |
289 | ||
4be44fcd | 290 | if (ACPI_SUCCESS(status)) { |
4119532c | 291 | |
bbc24134 LM |
292 | /* Dereference Index and ref_of references */ |
293 | ||
294 | acpi_ns_resolve_references(info); | |
295 | ||
4119532c BM |
296 | /* Get the size of the returned object */ |
297 | ||
4be44fcd | 298 | status = |
4119532c | 299 | acpi_ut_get_object_size(info->return_object, |
4be44fcd LB |
300 | &buffer_space_needed); |
301 | if (ACPI_SUCCESS(status)) { | |
52fc0b02 | 302 | |
1da177e4 LT |
303 | /* Validate/Allocate/Clear caller buffer */ |
304 | ||
4be44fcd LB |
305 | status = |
306 | acpi_ut_initialize_buffer | |
307 | (return_buffer, | |
308 | buffer_space_needed); | |
309 | if (ACPI_FAILURE(status)) { | |
1da177e4 | 310 | /* |
52fc0b02 BM |
311 | * Caller's buffer is too small or a new one can't |
312 | * be allocated | |
1da177e4 | 313 | */ |
4be44fcd LB |
314 | 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 { | |
52fc0b02 BM |
321 | /* We have enough space for the object, build it */ |
322 | ||
4be44fcd LB |
323 | status = |
324 | acpi_ut_copy_iobject_to_eobject | |
4119532c | 325 | (info->return_object, |
4be44fcd | 326 | return_buffer); |
1da177e4 LT |
327 | } |
328 | } | |
329 | } | |
330 | } | |
331 | } | |
332 | ||
4119532c | 333 | if (info->return_object) { |
1da177e4 | 334 | /* |
4119532c BM |
335 | * Delete the internal return object. NOTE: Interpreter must be |
336 | * locked to avoid race condition. | |
1da177e4 | 337 | */ |
4d2acd9e | 338 | acpi_ex_enter_interpreter(); |
4119532c | 339 | |
4d2acd9e | 340 | /* Remove one reference on the return object (should delete it) */ |
4119532c | 341 | |
4d2acd9e LB |
342 | acpi_ut_remove_reference(info->return_object); |
343 | acpi_ex_exit_interpreter(); | |
1da177e4 LT |
344 | } |
345 | ||
4119532c BM |
346 | cleanup: |
347 | ||
52fc0b02 BM |
348 | /* Free the input parameter list (if we created one) */ |
349 | ||
4119532c | 350 | if (info->parameters) { |
52fc0b02 | 351 | |
1da177e4 LT |
352 | /* Free the allocated parameter block */ |
353 | ||
4119532c | 354 | acpi_ut_delete_internal_object_list(info->parameters); |
1da177e4 LT |
355 | } |
356 | ||
4119532c | 357 | ACPI_FREE(info); |
4be44fcd | 358 | return_ACPI_STATUS(status); |
1da177e4 | 359 | } |
1da177e4 | 360 | |
8313524a | 361 | ACPI_EXPORT_SYMBOL(acpi_evaluate_object) |
1da177e4 | 362 | |
bbc24134 LM |
363 | /******************************************************************************* |
364 | * | |
365 | * FUNCTION: acpi_ns_resolve_references | |
366 | * | |
ba494bee | 367 | * PARAMETERS: info - Evaluation info block |
bbc24134 LM |
368 | * |
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 | ******************************************************************************/ | |
383 | static 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 | ||
3371c19c | 390 | if ((info->return_object)->common.type != ACPI_TYPE_LOCAL_REFERENCE) { |
bbc24134 LM |
391 | 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 | */ | |
1044f1f6 BM |
401 | switch (info->return_object->reference.class) { |
402 | case ACPI_REFCLASS_INDEX: | |
bbc24134 LM |
403 | |
404 | obj_desc = *(info->return_object->reference.where); | |
405 | break; | |
406 | ||
1044f1f6 | 407 | case ACPI_REFCLASS_REFOF: |
bbc24134 LM |
408 | |
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 | ||
1da177e4 LT |
430 | /******************************************************************************* |
431 | * | |
432 | * FUNCTION: acpi_walk_namespace | |
433 | * | |
ba494bee | 434 | * PARAMETERS: type - acpi_object_type to search for |
1da177e4 LT |
435 | * start_object - Handle in namespace where search begins |
436 | * max_depth - Depth to which search is to reach | |
2263576c LM |
437 | * 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 | |
ba494bee | 441 | * context - Passed to user function(s) above |
1da177e4 LT |
442 | * 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. | |
2263576c LM |
450 | * The callback function is called whenever an object that matches |
451 | * the type parameter is found. If the callback function returns | |
1da177e4 LT |
452 | * 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 | |
2263576c LM |
457 | * 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. | |
1da177e4 LT |
460 | * |
461 | ******************************************************************************/ | |
bbc24134 | 462 | |
1da177e4 | 463 | acpi_status |
4be44fcd LB |
464 | acpi_walk_namespace(acpi_object_type type, |
465 | acpi_handle start_object, | |
466 | u32 max_depth, | |
2263576c LM |
467 | acpi_walk_callback pre_order_visit, |
468 | acpi_walk_callback post_order_visit, | |
4be44fcd | 469 | void *context, void **return_value) |
1da177e4 | 470 | { |
4be44fcd | 471 | acpi_status status; |
1da177e4 | 472 | |
b229cf92 | 473 | ACPI_FUNCTION_TRACE(acpi_walk_namespace); |
1da177e4 LT |
474 | |
475 | /* Parameter validation */ | |
476 | ||
2263576c LM |
477 | if ((type > ACPI_TYPE_LOCAL_MAX) || |
478 | (!max_depth) || (!pre_order_visit && !post_order_visit)) { | |
4be44fcd | 479 | return_ACPI_STATUS(AE_BAD_PARAMETER); |
1da177e4 LT |
480 | } |
481 | ||
482 | /* | |
8a335a23 BM |
483 | * 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.) | |
1da177e4 | 503 | */ |
4be44fcd LB |
504 | status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE); |
505 | if (ACPI_FAILURE(status)) { | |
8a335a23 | 506 | goto unlock_and_exit; |
1da177e4 LT |
507 | } |
508 | ||
4be44fcd | 509 | status = acpi_ns_walk_namespace(type, start_object, max_depth, |
2263576c LM |
510 | ACPI_NS_WALK_UNLOCK, pre_order_visit, |
511 | post_order_visit, context, | |
512 | return_value); | |
1da177e4 | 513 | |
4be44fcd | 514 | (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE); |
8a335a23 BM |
515 | |
516 | unlock_and_exit: | |
517 | (void)acpi_ut_release_read_lock(&acpi_gbl_namespace_rw_lock); | |
4be44fcd | 518 | return_ACPI_STATUS(status); |
1da177e4 | 519 | } |
1da177e4 | 520 | |
8313524a | 521 | ACPI_EXPORT_SYMBOL(acpi_walk_namespace) |
1da177e4 LT |
522 | |
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 | ******************************************************************************/ | |
1da177e4 | 536 | static acpi_status |
4be44fcd LB |
537 | acpi_ns_get_device_callback(acpi_handle obj_handle, |
538 | u32 nesting_level, | |
539 | void *context, void **return_value) | |
1da177e4 | 540 | { |
4be44fcd LB |
541 | struct acpi_get_devices_info *info = context; |
542 | acpi_status status; | |
543 | struct acpi_namespace_node *node; | |
544 | u32 flags; | |
78e25fef LZ |
545 | struct acpi_pnp_device_id *hid; |
546 | struct acpi_pnp_device_id_list *cid; | |
67a119f9 | 547 | u32 i; |
15b8dd53 BM |
548 | u8 found; |
549 | int no_match; | |
1da177e4 | 550 | |
4be44fcd LB |
551 | status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE); |
552 | if (ACPI_FAILURE(status)) { | |
68aafc35 | 553 | return_ACPI_STATUS(status); |
1da177e4 LT |
554 | } |
555 | ||
f24b664d | 556 | node = acpi_ns_validate_handle(obj_handle); |
4be44fcd LB |
557 | status = acpi_ut_release_mutex(ACPI_MTX_NAMESPACE); |
558 | if (ACPI_FAILURE(status)) { | |
1da177e4 LT |
559 | return (status); |
560 | } | |
561 | ||
562 | if (!node) { | |
563 | return (AE_BAD_PARAMETER); | |
564 | } | |
565 | ||
5f8902ac LM |
566 | /* |
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 | */ | |
1da177e4 | 580 | if (info->hid != NULL) { |
4be44fcd | 581 | status = acpi_ut_execute_HID(node, &hid); |
1da177e4 LT |
582 | if (status == AE_NOT_FOUND) { |
583 | return (AE_OK); | |
4be44fcd | 584 | } else if (ACPI_FAILURE(status)) { |
1da177e4 LT |
585 | return (AE_CTRL_DEPTH); |
586 | } | |
587 | ||
15b8dd53 BM |
588 | no_match = ACPI_STRCMP(hid->string, info->hid); |
589 | ACPI_FREE(hid); | |
1da177e4 | 590 | |
15b8dd53 BM |
591 | if (no_match) { |
592 | /* | |
593 | * HID does not match, attempt match within the | |
594 | * list of Compatible IDs (CIDs) | |
595 | */ | |
4be44fcd | 596 | status = acpi_ut_execute_CID(node, &cid); |
1da177e4 LT |
597 | if (status == AE_NOT_FOUND) { |
598 | return (AE_OK); | |
4be44fcd | 599 | } else if (ACPI_FAILURE(status)) { |
1da177e4 LT |
600 | return (AE_CTRL_DEPTH); |
601 | } | |
602 | ||
603 | /* Walk the CID list */ | |
604 | ||
02f8a858 | 605 | found = 0; |
1da177e4 | 606 | for (i = 0; i < cid->count; i++) { |
15b8dd53 BM |
607 | if (ACPI_STRCMP(cid->ids[i].string, info->hid) |
608 | == 0) { | |
02f8a858 AP |
609 | found = 1; |
610 | break; | |
1da177e4 LT |
611 | } |
612 | } | |
8313524a | 613 | ACPI_FREE(cid); |
02f8a858 AP |
614 | if (!found) |
615 | return (AE_OK); | |
1da177e4 LT |
616 | } |
617 | } | |
618 | ||
5f8902ac LM |
619 | /* 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 | ||
4be44fcd LB |
638 | status = info->user_function(obj_handle, nesting_level, info->context, |
639 | return_value); | |
1da177e4 LT |
640 | return (status); |
641 | } | |
642 | ||
1da177e4 LT |
643 | /******************************************************************************* |
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 | |
ba494bee | 649 | * context - Passed to user function |
1da177e4 LT |
650 | * 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 | |
73a3090a | 659 | * Device is found. If the user function returns |
1da177e4 LT |
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 | |
549f4604 | 664 | * additional filtering. Please see acpi_ns_get_device_callback. |
1da177e4 LT |
665 | * |
666 | ******************************************************************************/ | |
667 | ||
668 | acpi_status | |
70b30fb1 | 669 | acpi_get_devices(const char *HID, |
4be44fcd LB |
670 | acpi_walk_callback user_function, |
671 | void *context, void **return_value) | |
1da177e4 | 672 | { |
4be44fcd LB |
673 | acpi_status status; |
674 | struct acpi_get_devices_info info; | |
1da177e4 | 675 | |
b229cf92 | 676 | ACPI_FUNCTION_TRACE(acpi_get_devices); |
1da177e4 LT |
677 | |
678 | /* Parameter validation */ | |
679 | ||
680 | if (!user_function) { | |
4be44fcd | 681 | return_ACPI_STATUS(AE_BAD_PARAMETER); |
1da177e4 LT |
682 | } |
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 | */ | |
52fc0b02 | 688 | info.hid = HID; |
4be44fcd | 689 | info.context = context; |
1da177e4 | 690 | info.user_function = user_function; |
1da177e4 LT |
691 | |
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 | */ | |
4be44fcd LB |
698 | status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE); |
699 | if (ACPI_FAILURE(status)) { | |
700 | return_ACPI_STATUS(status); | |
1da177e4 LT |
701 | } |
702 | ||
52fc0b02 BM |
703 | status = acpi_ns_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT, |
704 | ACPI_UINT32_MAX, ACPI_NS_WALK_UNLOCK, | |
2263576c LM |
705 | acpi_ns_get_device_callback, NULL, |
706 | &info, return_value); | |
1da177e4 | 707 | |
4be44fcd LB |
708 | (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE); |
709 | return_ACPI_STATUS(status); | |
1da177e4 | 710 | } |
1da177e4 | 711 | |
8313524a | 712 | ACPI_EXPORT_SYMBOL(acpi_get_devices) |
1da177e4 LT |
713 | |
714 | /******************************************************************************* | |
715 | * | |
716 | * FUNCTION: acpi_attach_data | |
717 | * | |
718 | * PARAMETERS: obj_handle - Namespace node | |
ba494bee BM |
719 | * handler - Handler for this attachment |
720 | * data - Pointer to data to be attached | |
1da177e4 LT |
721 | * |
722 | * RETURN: Status | |
723 | * | |
724 | * DESCRIPTION: Attach arbitrary data and handler to a namespace node. | |
725 | * | |
726 | ******************************************************************************/ | |
1da177e4 | 727 | acpi_status |
4be44fcd LB |
728 | acpi_attach_data(acpi_handle obj_handle, |
729 | acpi_object_handler handler, void *data) | |
1da177e4 | 730 | { |
4be44fcd LB |
731 | struct acpi_namespace_node *node; |
732 | acpi_status status; | |
1da177e4 LT |
733 | |
734 | /* Parameter validation */ | |
735 | ||
4be44fcd | 736 | if (!obj_handle || !handler || !data) { |
1da177e4 LT |
737 | return (AE_BAD_PARAMETER); |
738 | } | |
739 | ||
4be44fcd LB |
740 | status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE); |
741 | if (ACPI_FAILURE(status)) { | |
1da177e4 LT |
742 | return (status); |
743 | } | |
744 | ||
745 | /* Convert and validate the handle */ | |
746 | ||
f24b664d | 747 | node = acpi_ns_validate_handle(obj_handle); |
1da177e4 LT |
748 | if (!node) { |
749 | status = AE_BAD_PARAMETER; | |
750 | goto unlock_and_exit; | |
751 | } | |
752 | ||
4be44fcd | 753 | status = acpi_ns_attach_data(node, handler, data); |
1da177e4 | 754 | |
4be44fcd LB |
755 | unlock_and_exit: |
756 | (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE); | |
1da177e4 LT |
757 | return (status); |
758 | } | |
759 | ||
8313524a BM |
760 | ACPI_EXPORT_SYMBOL(acpi_attach_data) |
761 | ||
1da177e4 LT |
762 | /******************************************************************************* |
763 | * | |
764 | * FUNCTION: acpi_detach_data | |
765 | * | |
766 | * PARAMETERS: obj_handle - Namespace node handle | |
ba494bee | 767 | * handler - Handler used in call to acpi_attach_data |
1da177e4 LT |
768 | * |
769 | * RETURN: Status | |
770 | * | |
771 | * DESCRIPTION: Remove data that was previously attached to a node. | |
772 | * | |
773 | ******************************************************************************/ | |
1da177e4 | 774 | acpi_status |
4be44fcd | 775 | acpi_detach_data(acpi_handle obj_handle, acpi_object_handler handler) |
1da177e4 | 776 | { |
4be44fcd LB |
777 | struct acpi_namespace_node *node; |
778 | acpi_status status; | |
1da177e4 LT |
779 | |
780 | /* Parameter validation */ | |
781 | ||
4be44fcd | 782 | if (!obj_handle || !handler) { |
1da177e4 LT |
783 | return (AE_BAD_PARAMETER); |
784 | } | |
785 | ||
4be44fcd LB |
786 | status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE); |
787 | if (ACPI_FAILURE(status)) { | |
1da177e4 LT |
788 | return (status); |
789 | } | |
790 | ||
791 | /* Convert and validate the handle */ | |
792 | ||
f24b664d | 793 | node = acpi_ns_validate_handle(obj_handle); |
1da177e4 LT |
794 | if (!node) { |
795 | status = AE_BAD_PARAMETER; | |
796 | goto unlock_and_exit; | |
797 | } | |
798 | ||
4be44fcd | 799 | status = acpi_ns_detach_data(node, handler); |
1da177e4 | 800 | |
4be44fcd LB |
801 | unlock_and_exit: |
802 | (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE); | |
1da177e4 LT |
803 | return (status); |
804 | } | |
805 | ||
8313524a BM |
806 | ACPI_EXPORT_SYMBOL(acpi_detach_data) |
807 | ||
1da177e4 LT |
808 | /******************************************************************************* |
809 | * | |
810 | * FUNCTION: acpi_get_data | |
811 | * | |
812 | * PARAMETERS: obj_handle - Namespace node | |
ba494bee BM |
813 | * handler - Handler used in call to attach_data |
814 | * data - Where the data is returned | |
1da177e4 LT |
815 | * |
816 | * RETURN: Status | |
817 | * | |
818 | * DESCRIPTION: Retrieve data that was previously attached to a namespace node. | |
819 | * | |
820 | ******************************************************************************/ | |
1da177e4 | 821 | acpi_status |
4be44fcd | 822 | acpi_get_data(acpi_handle obj_handle, acpi_object_handler handler, void **data) |
1da177e4 | 823 | { |
4be44fcd LB |
824 | struct acpi_namespace_node *node; |
825 | acpi_status status; | |
1da177e4 LT |
826 | |
827 | /* Parameter validation */ | |
828 | ||
4be44fcd | 829 | if (!obj_handle || !handler || !data) { |
1da177e4 LT |
830 | return (AE_BAD_PARAMETER); |
831 | } | |
832 | ||
4be44fcd LB |
833 | status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE); |
834 | if (ACPI_FAILURE(status)) { | |
1da177e4 LT |
835 | return (status); |
836 | } | |
837 | ||
838 | /* Convert and validate the handle */ | |
839 | ||
f24b664d | 840 | node = acpi_ns_validate_handle(obj_handle); |
1da177e4 LT |
841 | if (!node) { |
842 | status = AE_BAD_PARAMETER; | |
843 | goto unlock_and_exit; | |
844 | } | |
845 | ||
4be44fcd | 846 | status = acpi_ns_get_attached_data(node, handler, data); |
1da177e4 | 847 | |
4be44fcd LB |
848 | unlock_and_exit: |
849 | (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE); | |
1da177e4 LT |
850 | return (status); |
851 | } | |
8313524a BM |
852 | |
853 | ACPI_EXPORT_SYMBOL(acpi_get_data) |