]>
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 | /* | |
7735ca0e | 9 | * Copyright (C) 2000 - 2017, 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 | ||
839e928f LZ |
45 | #define EXPORT_ACPI_INTERFACES |
46 | ||
1da177e4 | 47 | #include <acpi/acpi.h> |
e2f7a777 LB |
48 | #include "accommon.h" |
49 | #include "acnamesp.h" | |
50 | #include "acinterp.h" | |
1da177e4 | 51 | |
1da177e4 | 52 | #define _COMPONENT ACPI_NAMESPACE |
4be44fcd | 53 | ACPI_MODULE_NAME("nsxfeval") |
bbc24134 LM |
54 | |
55 | /* Local prototypes */ | |
56 | static void acpi_ns_resolve_references(struct acpi_evaluate_info *info); | |
57 | ||
1da177e4 LT |
58 | /******************************************************************************* |
59 | * | |
60 | * FUNCTION: acpi_evaluate_object_typed | |
61 | * | |
ba494bee BM |
62 | * PARAMETERS: handle - Object handle (optional) |
63 | * pathname - Object pathname (optional) | |
44f6c012 | 64 | * external_params - List of parameters to pass to method, |
73a3090a | 65 | * terminated by NULL. May be NULL |
1da177e4 | 66 | * if no parameters are being passed. |
44f6c012 | 67 | * return_buffer - Where to put method's return value (if |
73a3090a | 68 | * any). If NULL, no value is returned. |
1da177e4 LT |
69 | * return_type - Expected type of return object |
70 | * | |
71 | * RETURN: Status | |
72 | * | |
73 | * DESCRIPTION: Find and evaluate the given object, passing the given | |
73a3090a | 74 | * parameters if necessary. One of "Handle" or "Pathname" must |
1da177e4 LT |
75 | * be valid (non-null) |
76 | * | |
77 | ******************************************************************************/ | |
bbc24134 | 78 | |
1da177e4 | 79 | acpi_status |
4be44fcd LB |
80 | acpi_evaluate_object_typed(acpi_handle handle, |
81 | acpi_string pathname, | |
fd350943 LB |
82 | struct acpi_object_list *external_params, |
83 | struct acpi_buffer *return_buffer, | |
4be44fcd | 84 | acpi_object_type return_type) |
1da177e4 | 85 | { |
4be44fcd | 86 | acpi_status status; |
bb3fec14 | 87 | u8 free_buffer_on_error = FALSE; |
2d2a9543 BM |
88 | acpi_handle target_handle; |
89 | char *full_pathname; | |
1da177e4 | 90 | |
b229cf92 | 91 | ACPI_FUNCTION_TRACE(acpi_evaluate_object_typed); |
1da177e4 LT |
92 | |
93 | /* Return buffer must be valid */ | |
94 | ||
95 | if (!return_buffer) { | |
4be44fcd | 96 | return_ACPI_STATUS(AE_BAD_PARAMETER); |
1da177e4 LT |
97 | } |
98 | ||
99 | if (return_buffer->length == ACPI_ALLOCATE_BUFFER) { | |
bb3fec14 | 100 | free_buffer_on_error = TRUE; |
1da177e4 LT |
101 | } |
102 | ||
9b40eebc RW |
103 | if (pathname) { |
104 | status = acpi_get_handle(handle, pathname, &target_handle); | |
105 | if (ACPI_FAILURE(status)) { | |
106 | return_ACPI_STATUS(status); | |
107 | } | |
108 | } else { | |
109 | target_handle = handle; | |
2d2a9543 BM |
110 | } |
111 | ||
112 | full_pathname = acpi_ns_get_external_pathname(target_handle); | |
113 | if (!full_pathname) { | |
114 | return_ACPI_STATUS(AE_NO_MEMORY); | |
115 | } | |
116 | ||
1da177e4 LT |
117 | /* Evaluate the object */ |
118 | ||
2d2a9543 BM |
119 | status = acpi_evaluate_object(target_handle, NULL, external_params, |
120 | return_buffer); | |
4be44fcd | 121 | if (ACPI_FAILURE(status)) { |
2d2a9543 | 122 | goto exit; |
1da177e4 LT |
123 | } |
124 | ||
2d2a9543 | 125 | /* Type ANY means "don't care about return value type" */ |
1da177e4 LT |
126 | |
127 | if (return_type == ACPI_TYPE_ANY) { | |
2d2a9543 | 128 | goto exit; |
1da177e4 LT |
129 | } |
130 | ||
131 | if (return_buffer->length == 0) { | |
52fc0b02 | 132 | |
1da177e4 LT |
133 | /* Error because caller specifically asked for a return value */ |
134 | ||
2d2a9543 BM |
135 | ACPI_ERROR((AE_INFO, "%s did not return any object", |
136 | full_pathname)); | |
137 | status = AE_NULL_OBJECT; | |
138 | goto exit; | |
1da177e4 LT |
139 | } |
140 | ||
141 | /* Examine the object type returned from evaluate_object */ | |
142 | ||
4be44fcd | 143 | if (((union acpi_object *)return_buffer->pointer)->type == return_type) { |
2d2a9543 | 144 | goto exit; |
1da177e4 LT |
145 | } |
146 | ||
147 | /* Return object type does not match requested type */ | |
148 | ||
b8e4d893 | 149 | ACPI_ERROR((AE_INFO, |
2d2a9543 BM |
150 | "Incorrect return type from %s - received [%s], requested [%s]", |
151 | full_pathname, | |
b8e4d893 BM |
152 | acpi_ut_get_type_name(((union acpi_object *)return_buffer-> |
153 | pointer)->type), | |
154 | acpi_ut_get_type_name(return_type))); | |
1da177e4 | 155 | |
bb3fec14 LZ |
156 | if (free_buffer_on_error) { |
157 | /* | |
158 | * Free a buffer created via ACPI_ALLOCATE_BUFFER. | |
159 | * Note: We use acpi_os_free here because acpi_os_allocate was used | |
160 | * to allocate the buffer. This purposefully bypasses the | |
161 | * (optionally enabled) allocation tracking mechanism since we | |
162 | * only want to track internal allocations. | |
163 | */ | |
164 | acpi_os_free(return_buffer->pointer); | |
1da177e4 LT |
165 | return_buffer->pointer = NULL; |
166 | } | |
167 | ||
168 | return_buffer->length = 0; | |
2d2a9543 BM |
169 | status = AE_TYPE; |
170 | ||
171 | exit: | |
172 | ACPI_FREE(full_pathname); | |
173 | return_ACPI_STATUS(status); | |
1da177e4 | 174 | } |
8313524a BM |
175 | |
176 | ACPI_EXPORT_SYMBOL(acpi_evaluate_object_typed) | |
2c03d07a | 177 | |
1da177e4 LT |
178 | /******************************************************************************* |
179 | * | |
180 | * FUNCTION: acpi_evaluate_object | |
181 | * | |
ba494bee BM |
182 | * PARAMETERS: handle - Object handle (optional) |
183 | * pathname - Object pathname (optional) | |
1da177e4 | 184 | * external_params - List of parameters to pass to method, |
73a3090a | 185 | * terminated by NULL. May be NULL |
1da177e4 LT |
186 | * if no parameters are being passed. |
187 | * return_buffer - Where to put method's return value (if | |
73a3090a | 188 | * any). If NULL, no value is returned. |
1da177e4 LT |
189 | * |
190 | * RETURN: Status | |
191 | * | |
192 | * DESCRIPTION: Find and evaluate the given object, passing the given | |
73a3090a | 193 | * parameters if necessary. One of "Handle" or "Pathname" must |
1da177e4 LT |
194 | * be valid (non-null) |
195 | * | |
196 | ******************************************************************************/ | |
1da177e4 | 197 | acpi_status |
4be44fcd LB |
198 | acpi_evaluate_object(acpi_handle handle, |
199 | acpi_string pathname, | |
200 | struct acpi_object_list *external_params, | |
201 | struct acpi_buffer *return_buffer) | |
1da177e4 | 202 | { |
4be44fcd | 203 | acpi_status status; |
4119532c | 204 | struct acpi_evaluate_info *info; |
4be44fcd LB |
205 | acpi_size buffer_space_needed; |
206 | u32 i; | |
1da177e4 | 207 | |
b229cf92 | 208 | ACPI_FUNCTION_TRACE(acpi_evaluate_object); |
1da177e4 | 209 | |
4119532c BM |
210 | /* Allocate and initialize the evaluation information block */ |
211 | ||
212 | info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info)); | |
213 | if (!info) { | |
214 | return_ACPI_STATUS(AE_NO_MEMORY); | |
215 | } | |
216 | ||
4119532c BM |
217 | /* Convert and validate the device handle */ |
218 | ||
f24b664d | 219 | info->prefix_node = acpi_ns_validate_handle(handle); |
4119532c BM |
220 | if (!info->prefix_node) { |
221 | status = AE_BAD_PARAMETER; | |
222 | goto cleanup; | |
223 | } | |
1da177e4 LT |
224 | |
225 | /* | |
29a241cc BM |
226 | * Get the actual namespace node for the target object. |
227 | * Handles these cases: | |
228 | * | |
229 | * 1) Null node, valid pathname from root (absolute path) | |
230 | * 2) Node and valid pathname (path relative to Node) | |
231 | * 3) Node, Null pathname | |
232 | */ | |
233 | if ((pathname) && (ACPI_IS_ROOT_PREFIX(pathname[0]))) { | |
234 | ||
235 | /* The path is fully qualified, just evaluate by name */ | |
236 | ||
237 | info->prefix_node = NULL; | |
238 | } else if (!handle) { | |
239 | /* | |
240 | * A handle is optional iff a fully qualified pathname is specified. | |
241 | * Since we've already handled fully qualified names above, this is | |
242 | * an error. | |
243 | */ | |
244 | if (!pathname) { | |
245 | ACPI_DEBUG_PRINT((ACPI_DB_INFO, | |
246 | "Both Handle and Pathname are NULL")); | |
247 | } else { | |
248 | ACPI_DEBUG_PRINT((ACPI_DB_INFO, | |
249 | "Null Handle with relative pathname [%s]", | |
250 | pathname)); | |
251 | } | |
252 | ||
253 | status = AE_BAD_PARAMETER; | |
254 | goto cleanup; | |
255 | } | |
256 | ||
257 | info->relative_pathname = pathname; | |
258 | ||
259 | /* | |
260 | * Convert all external objects passed as arguments to the | |
261 | * internal version(s). | |
1da177e4 LT |
262 | */ |
263 | if (external_params && external_params->count) { | |
29a241cc BM |
264 | info->param_count = (u16)external_params->count; |
265 | ||
266 | /* Warn on impossible argument count */ | |
267 | ||
268 | if (info->param_count > ACPI_METHOD_NUM_ARGS) { | |
269 | ACPI_WARN_PREDEFINED((AE_INFO, pathname, | |
270 | ACPI_WARN_ALWAYS, | |
271 | "Excess arguments (%u) - using only %u", | |
272 | info->param_count, | |
273 | ACPI_METHOD_NUM_ARGS)); | |
274 | ||
275 | info->param_count = ACPI_METHOD_NUM_ARGS; | |
276 | } | |
277 | ||
1da177e4 LT |
278 | /* |
279 | * Allocate a new parameter block for the internal objects | |
280 | * Add 1 to count to allow for null terminated internal list | |
281 | */ | |
f5c1e1c5 | 282 | info->parameters = ACPI_ALLOCATE_ZEROED(((acpi_size)info-> |
29a241cc | 283 | param_count + |
4119532c BM |
284 | 1) * sizeof(void *)); |
285 | if (!info->parameters) { | |
286 | status = AE_NO_MEMORY; | |
287 | goto cleanup; | |
1da177e4 LT |
288 | } |
289 | ||
4119532c BM |
290 | /* Convert each external object in the list to an internal object */ |
291 | ||
29a241cc | 292 | for (i = 0; i < info->param_count; i++) { |
4be44fcd LB |
293 | status = |
294 | acpi_ut_copy_eobject_to_iobject(&external_params-> | |
295 | pointer[i], | |
4119532c | 296 | &info-> |
4be44fcd LB |
297 | parameters[i]); |
298 | if (ACPI_FAILURE(status)) { | |
4119532c | 299 | goto cleanup; |
1da177e4 LT |
300 | } |
301 | } | |
29a241cc BM |
302 | |
303 | info->parameters[info->param_count] = NULL; | |
1da177e4 LT |
304 | } |
305 | ||
7dbec553 | 306 | #ifdef _FUTURE_FEATURE |
29a241cc | 307 | |
1da177e4 | 308 | /* |
29a241cc BM |
309 | * Begin incoming argument count analysis. Check for too few args |
310 | * and too many args. | |
1da177e4 | 311 | */ |
29a241cc BM |
312 | switch (acpi_ns_get_type(info->node)) { |
313 | case ACPI_TYPE_METHOD: | |
314 | ||
315 | /* Check incoming argument count against the method definition */ | |
316 | ||
317 | if (info->obj_desc->method.param_count > info->param_count) { | |
318 | ACPI_ERROR((AE_INFO, | |
319 | "Insufficient arguments (%u) - %u are required", | |
320 | info->param_count, | |
321 | info->obj_desc->method.param_count)); | |
322 | ||
323 | status = AE_MISSING_ARGUMENTS; | |
324 | goto cleanup; | |
325 | } | |
326 | ||
327 | else if (info->obj_desc->method.param_count < info->param_count) { | |
328 | ACPI_WARNING((AE_INFO, | |
329 | "Excess arguments (%u) - only %u are required", | |
330 | info->param_count, | |
331 | info->obj_desc->method.param_count)); | |
332 | ||
333 | /* Just pass the required number of arguments */ | |
334 | ||
335 | info->param_count = info->obj_desc->method.param_count; | |
336 | } | |
52fc0b02 | 337 | |
1da177e4 | 338 | /* |
29a241cc BM |
339 | * Any incoming external objects to be passed as arguments to the |
340 | * method must be converted to internal objects | |
1da177e4 | 341 | */ |
29a241cc BM |
342 | if (info->param_count) { |
343 | /* | |
344 | * Allocate a new parameter block for the internal objects | |
345 | * Add 1 to count to allow for null terminated internal list | |
346 | */ | |
347 | info->parameters = ACPI_ALLOCATE_ZEROED(((acpi_size) | |
348 | info-> | |
349 | param_count + | |
350 | 1) * | |
351 | sizeof(void *)); | |
352 | if (!info->parameters) { | |
353 | status = AE_NO_MEMORY; | |
354 | goto cleanup; | |
355 | } | |
356 | ||
357 | /* Convert each external object in the list to an internal object */ | |
358 | ||
359 | for (i = 0; i < info->param_count; i++) { | |
360 | status = | |
361 | acpi_ut_copy_eobject_to_iobject | |
362 | (&external_params->pointer[i], | |
363 | &info->parameters[i]); | |
364 | if (ACPI_FAILURE(status)) { | |
365 | goto cleanup; | |
366 | } | |
367 | } | |
368 | ||
369 | info->parameters[info->param_count] = NULL; | |
1da177e4 | 370 | } |
29a241cc | 371 | break; |
1da177e4 | 372 | |
29a241cc BM |
373 | default: |
374 | ||
375 | /* Warn if arguments passed to an object that is not a method */ | |
52fc0b02 | 376 | |
29a241cc BM |
377 | if (info->param_count) { |
378 | ACPI_WARNING((AE_INFO, | |
379 | "%u arguments were passed to a non-method ACPI object", | |
380 | info->param_count)); | |
381 | } | |
382 | break; | |
1da177e4 LT |
383 | } |
384 | ||
29a241cc BM |
385 | #endif |
386 | ||
387 | /* Now we can evaluate the object */ | |
388 | ||
389 | status = acpi_ns_evaluate(info); | |
390 | ||
1da177e4 LT |
391 | /* |
392 | * If we are expecting a return value, and all went well above, | |
393 | * copy the return value to an external object. | |
394 | */ | |
7dbec553 BM |
395 | if (!return_buffer) { |
396 | goto cleanup_return_object; | |
397 | } | |
1da177e4 | 398 | |
7dbec553 BM |
399 | if (!info->return_object) { |
400 | return_buffer->length = 0; | |
401 | goto cleanup; | |
402 | } | |
4119532c | 403 | |
7dbec553 BM |
404 | if (ACPI_GET_DESCRIPTOR_TYPE(info->return_object) == |
405 | ACPI_DESC_TYPE_NAMED) { | |
406 | /* | |
407 | * If we received a NS Node as a return object, this means that | |
408 | * the object we are evaluating has nothing interesting to | |
409 | * return (such as a mutex, etc.) We return an error because | |
410 | * these types are essentially unsupported by this interface. | |
411 | * We don't check up front because this makes it easier to add | |
412 | * support for various types at a later date if necessary. | |
413 | */ | |
414 | status = AE_TYPE; | |
415 | info->return_object = NULL; /* No need to delete a NS Node */ | |
416 | return_buffer->length = 0; | |
417 | } | |
bbc24134 | 418 | |
7dbec553 BM |
419 | if (ACPI_FAILURE(status)) { |
420 | goto cleanup_return_object; | |
421 | } | |
bbc24134 | 422 | |
7dbec553 | 423 | /* Dereference Index and ref_of references */ |
4119532c | 424 | |
7dbec553 BM |
425 | acpi_ns_resolve_references(info); |
426 | ||
427 | /* Get the size of the returned object */ | |
428 | ||
429 | status = acpi_ut_get_object_size(info->return_object, | |
430 | &buffer_space_needed); | |
431 | if (ACPI_SUCCESS(status)) { | |
432 | ||
433 | /* Validate/Allocate/Clear caller buffer */ | |
434 | ||
435 | status = acpi_ut_initialize_buffer(return_buffer, | |
436 | buffer_space_needed); | |
437 | if (ACPI_FAILURE(status)) { | |
438 | /* | |
439 | * Caller's buffer is too small or a new one can't | |
440 | * be allocated | |
441 | */ | |
442 | ACPI_DEBUG_PRINT((ACPI_DB_INFO, | |
443 | "Needed buffer size %X, %s\n", | |
444 | (u32)buffer_space_needed, | |
445 | acpi_format_exception(status))); | |
446 | } else { | |
447 | /* We have enough space for the object, build it */ | |
448 | ||
449 | status = | |
450 | acpi_ut_copy_iobject_to_eobject(info->return_object, | |
451 | return_buffer); | |
1da177e4 LT |
452 | } |
453 | } | |
454 | ||
7dbec553 BM |
455 | cleanup_return_object: |
456 | ||
4119532c | 457 | if (info->return_object) { |
1da177e4 | 458 | /* |
4119532c BM |
459 | * Delete the internal return object. NOTE: Interpreter must be |
460 | * locked to avoid race condition. | |
1da177e4 | 461 | */ |
4d2acd9e | 462 | acpi_ex_enter_interpreter(); |
4119532c | 463 | |
4d2acd9e | 464 | /* Remove one reference on the return object (should delete it) */ |
4119532c | 465 | |
4d2acd9e LB |
466 | acpi_ut_remove_reference(info->return_object); |
467 | acpi_ex_exit_interpreter(); | |
1da177e4 LT |
468 | } |
469 | ||
10622bf8 | 470 | cleanup: |
4119532c | 471 | |
52fc0b02 BM |
472 | /* Free the input parameter list (if we created one) */ |
473 | ||
4119532c | 474 | if (info->parameters) { |
52fc0b02 | 475 | |
1da177e4 LT |
476 | /* Free the allocated parameter block */ |
477 | ||
4119532c | 478 | acpi_ut_delete_internal_object_list(info->parameters); |
1da177e4 LT |
479 | } |
480 | ||
4119532c | 481 | ACPI_FREE(info); |
4be44fcd | 482 | return_ACPI_STATUS(status); |
1da177e4 | 483 | } |
1da177e4 | 484 | |
8313524a | 485 | ACPI_EXPORT_SYMBOL(acpi_evaluate_object) |
1da177e4 | 486 | |
bbc24134 LM |
487 | /******************************************************************************* |
488 | * | |
489 | * FUNCTION: acpi_ns_resolve_references | |
490 | * | |
ba494bee | 491 | * PARAMETERS: info - Evaluation info block |
bbc24134 LM |
492 | * |
493 | * RETURN: Info->return_object is replaced with the dereferenced object | |
494 | * | |
495 | * DESCRIPTION: Dereference certain reference objects. Called before an | |
496 | * internal return object is converted to an external union acpi_object. | |
497 | * | |
498 | * Performs an automatic dereference of Index and ref_of reference objects. | |
499 | * These reference objects are not supported by the union acpi_object, so this is a | |
500 | * last resort effort to return something useful. Also, provides compatibility | |
501 | * with other ACPI implementations. | |
502 | * | |
503 | * NOTE: does not handle references within returned package objects or nested | |
504 | * references, but this support could be added later if found to be necessary. | |
505 | * | |
506 | ******************************************************************************/ | |
507 | static void acpi_ns_resolve_references(struct acpi_evaluate_info *info) | |
508 | { | |
509 | union acpi_operand_object *obj_desc = NULL; | |
510 | struct acpi_namespace_node *node; | |
511 | ||
512 | /* We are interested in reference objects only */ | |
513 | ||
3371c19c | 514 | if ((info->return_object)->common.type != ACPI_TYPE_LOCAL_REFERENCE) { |
bbc24134 LM |
515 | return; |
516 | } | |
517 | ||
518 | /* | |
519 | * Two types of references are supported - those created by Index and | |
520 | * ref_of operators. A name reference (AML_NAMEPATH_OP) can be converted | |
03440c4e | 521 | * to a union acpi_object, so it is not dereferenced here. A ddb_handle |
bbc24134 | 522 | * (AML_LOAD_OP) cannot be dereferenced, nor can it be converted to |
03440c4e | 523 | * a union acpi_object. |
bbc24134 | 524 | */ |
1044f1f6 BM |
525 | switch (info->return_object->reference.class) { |
526 | case ACPI_REFCLASS_INDEX: | |
bbc24134 LM |
527 | |
528 | obj_desc = *(info->return_object->reference.where); | |
529 | break; | |
530 | ||
1044f1f6 | 531 | case ACPI_REFCLASS_REFOF: |
bbc24134 LM |
532 | |
533 | node = info->return_object->reference.object; | |
534 | if (node) { | |
535 | obj_desc = node->object; | |
536 | } | |
537 | break; | |
538 | ||
539 | default: | |
1d1ea1b7 | 540 | |
bbc24134 LM |
541 | return; |
542 | } | |
543 | ||
544 | /* Replace the existing reference object */ | |
545 | ||
546 | if (obj_desc) { | |
547 | acpi_ut_add_reference(obj_desc); | |
548 | acpi_ut_remove_reference(info->return_object); | |
549 | info->return_object = obj_desc; | |
550 | } | |
551 | ||
552 | return; | |
553 | } | |
554 | ||
1da177e4 LT |
555 | /******************************************************************************* |
556 | * | |
557 | * FUNCTION: acpi_walk_namespace | |
558 | * | |
ba494bee | 559 | * PARAMETERS: type - acpi_object_type to search for |
1da177e4 LT |
560 | * start_object - Handle in namespace where search begins |
561 | * max_depth - Depth to which search is to reach | |
4ef17507 | 562 | * descending_callback - Called during tree descent |
2263576c | 563 | * when an object of "Type" is found |
4ef17507 | 564 | * ascending_callback - Called during tree ascent |
2263576c | 565 | * when an object of "Type" is found |
ba494bee | 566 | * context - Passed to user function(s) above |
1da177e4 LT |
567 | * return_value - Location where return value of |
568 | * user_function is put if terminated early | |
569 | * | |
570 | * RETURNS Return value from the user_function if terminated early. | |
571 | * Otherwise, returns NULL. | |
572 | * | |
573 | * DESCRIPTION: Performs a modified depth-first walk of the namespace tree, | |
574 | * starting (and ending) at the object specified by start_handle. | |
2263576c LM |
575 | * The callback function is called whenever an object that matches |
576 | * the type parameter is found. If the callback function returns | |
1da177e4 LT |
577 | * a non-zero value, the search is terminated immediately and this |
578 | * value is returned to the caller. | |
579 | * | |
580 | * The point of this procedure is to provide a generic namespace | |
581 | * walk routine that can be called from multiple places to | |
2263576c LM |
582 | * provide multiple services; the callback function(s) can be |
583 | * tailored to each task, whether it is a print function, | |
584 | * a compare function, etc. | |
1da177e4 LT |
585 | * |
586 | ******************************************************************************/ | |
bbc24134 | 587 | |
1da177e4 | 588 | acpi_status |
4be44fcd LB |
589 | acpi_walk_namespace(acpi_object_type type, |
590 | acpi_handle start_object, | |
591 | u32 max_depth, | |
4ef17507 BM |
592 | acpi_walk_callback descending_callback, |
593 | acpi_walk_callback ascending_callback, | |
4be44fcd | 594 | void *context, void **return_value) |
1da177e4 | 595 | { |
4be44fcd | 596 | acpi_status status; |
1da177e4 | 597 | |
b229cf92 | 598 | ACPI_FUNCTION_TRACE(acpi_walk_namespace); |
1da177e4 LT |
599 | |
600 | /* Parameter validation */ | |
601 | ||
2263576c | 602 | if ((type > ACPI_TYPE_LOCAL_MAX) || |
4ef17507 | 603 | (!max_depth) || (!descending_callback && !ascending_callback)) { |
4be44fcd | 604 | return_ACPI_STATUS(AE_BAD_PARAMETER); |
1da177e4 LT |
605 | } |
606 | ||
607 | /* | |
8a335a23 BM |
608 | * Need to acquire the namespace reader lock to prevent interference |
609 | * with any concurrent table unloads (which causes the deletion of | |
610 | * namespace objects). We cannot allow the deletion of a namespace node | |
611 | * while the user function is using it. The exception to this are the | |
612 | * nodes created and deleted during control method execution -- these | |
613 | * nodes are marked as temporary nodes and are ignored by the namespace | |
614 | * walk. Thus, control methods can be executed while holding the | |
615 | * namespace deletion lock (and the user function can execute control | |
616 | * methods.) | |
617 | */ | |
618 | status = acpi_ut_acquire_read_lock(&acpi_gbl_namespace_rw_lock); | |
619 | if (ACPI_FAILURE(status)) { | |
7b6afb67 | 620 | return_ACPI_STATUS(status); |
8a335a23 BM |
621 | } |
622 | ||
623 | /* | |
624 | * Lock the namespace around the walk. The namespace will be | |
625 | * unlocked/locked around each call to the user function - since the user | |
626 | * function must be allowed to make ACPICA calls itself (for example, it | |
627 | * will typically execute control methods during device enumeration.) | |
1da177e4 | 628 | */ |
4be44fcd LB |
629 | status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE); |
630 | if (ACPI_FAILURE(status)) { | |
8a335a23 | 631 | goto unlock_and_exit; |
1da177e4 LT |
632 | } |
633 | ||
d53d8207 BM |
634 | /* Now we can validate the starting node */ |
635 | ||
636 | if (!acpi_ns_validate_handle(start_object)) { | |
637 | status = AE_BAD_PARAMETER; | |
638 | goto unlock_and_exit2; | |
639 | } | |
640 | ||
4be44fcd | 641 | status = acpi_ns_walk_namespace(type, start_object, max_depth, |
4ef17507 BM |
642 | ACPI_NS_WALK_UNLOCK, |
643 | descending_callback, ascending_callback, | |
644 | context, return_value); | |
1da177e4 | 645 | |
10622bf8 | 646 | unlock_and_exit2: |
4be44fcd | 647 | (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE); |
8a335a23 | 648 | |
10622bf8 | 649 | unlock_and_exit: |
8a335a23 | 650 | (void)acpi_ut_release_read_lock(&acpi_gbl_namespace_rw_lock); |
4be44fcd | 651 | return_ACPI_STATUS(status); |
1da177e4 | 652 | } |
1da177e4 | 653 | |
8313524a | 654 | ACPI_EXPORT_SYMBOL(acpi_walk_namespace) |
1da177e4 LT |
655 | |
656 | /******************************************************************************* | |
657 | * | |
658 | * FUNCTION: acpi_ns_get_device_callback | |
659 | * | |
660 | * PARAMETERS: Callback from acpi_get_device | |
661 | * | |
662 | * RETURN: Status | |
663 | * | |
664 | * DESCRIPTION: Takes callbacks from walk_namespace and filters out all non- | |
665 | * present devices, or if they specified a HID, it filters based | |
666 | * on that. | |
667 | * | |
668 | ******************************************************************************/ | |
1da177e4 | 669 | static acpi_status |
4be44fcd LB |
670 | acpi_ns_get_device_callback(acpi_handle obj_handle, |
671 | u32 nesting_level, | |
672 | void *context, void **return_value) | |
1da177e4 | 673 | { |
4be44fcd LB |
674 | struct acpi_get_devices_info *info = context; |
675 | acpi_status status; | |
676 | struct acpi_namespace_node *node; | |
677 | u32 flags; | |
78e25fef LZ |
678 | struct acpi_pnp_device_id *hid; |
679 | struct acpi_pnp_device_id_list *cid; | |
67a119f9 | 680 | u32 i; |
15b8dd53 BM |
681 | u8 found; |
682 | int no_match; | |
1da177e4 | 683 | |
4be44fcd LB |
684 | status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE); |
685 | if (ACPI_FAILURE(status)) { | |
7b6afb67 | 686 | return (status); |
1da177e4 LT |
687 | } |
688 | ||
f24b664d | 689 | node = acpi_ns_validate_handle(obj_handle); |
4be44fcd LB |
690 | status = acpi_ut_release_mutex(ACPI_MTX_NAMESPACE); |
691 | if (ACPI_FAILURE(status)) { | |
1da177e4 LT |
692 | return (status); |
693 | } | |
694 | ||
695 | if (!node) { | |
696 | return (AE_BAD_PARAMETER); | |
697 | } | |
698 | ||
5f8902ac LM |
699 | /* |
700 | * First, filter based on the device HID and CID. | |
701 | * | |
702 | * 01/2010: For this case where a specific HID is requested, we don't | |
703 | * want to run _STA until we have an actual HID match. Thus, we will | |
704 | * not unnecessarily execute _STA on devices for which the caller | |
705 | * doesn't care about. Previously, _STA was executed unconditionally | |
706 | * on all devices found here. | |
707 | * | |
708 | * A side-effect of this change is that now we will continue to search | |
709 | * for a matching HID even under device trees where the parent device | |
710 | * would have returned a _STA that indicates it is not present or | |
711 | * not functioning (thus aborting the search on that branch). | |
712 | */ | |
1da177e4 | 713 | if (info->hid != NULL) { |
4be44fcd | 714 | status = acpi_ut_execute_HID(node, &hid); |
1da177e4 LT |
715 | if (status == AE_NOT_FOUND) { |
716 | return (AE_OK); | |
4be44fcd | 717 | } else if (ACPI_FAILURE(status)) { |
1da177e4 LT |
718 | return (AE_CTRL_DEPTH); |
719 | } | |
720 | ||
4fa4616e | 721 | no_match = strcmp(hid->string, info->hid); |
15b8dd53 | 722 | ACPI_FREE(hid); |
1da177e4 | 723 | |
15b8dd53 BM |
724 | if (no_match) { |
725 | /* | |
726 | * HID does not match, attempt match within the | |
727 | * list of Compatible IDs (CIDs) | |
728 | */ | |
4be44fcd | 729 | status = acpi_ut_execute_CID(node, &cid); |
1da177e4 LT |
730 | if (status == AE_NOT_FOUND) { |
731 | return (AE_OK); | |
4be44fcd | 732 | } else if (ACPI_FAILURE(status)) { |
1da177e4 LT |
733 | return (AE_CTRL_DEPTH); |
734 | } | |
735 | ||
736 | /* Walk the CID list */ | |
737 | ||
739dcbb9 | 738 | found = FALSE; |
1da177e4 | 739 | for (i = 0; i < cid->count; i++) { |
4fa4616e | 740 | if (strcmp(cid->ids[i].string, info->hid) == 0) { |
3e8214e5 | 741 | |
75c8044f | 742 | /* Found a matching CID */ |
3e8214e5 | 743 | |
739dcbb9 | 744 | found = TRUE; |
02f8a858 | 745 | break; |
1da177e4 LT |
746 | } |
747 | } | |
739dcbb9 | 748 | |
8313524a | 749 | ACPI_FREE(cid); |
739dcbb9 | 750 | if (!found) { |
02f8a858 | 751 | return (AE_OK); |
739dcbb9 | 752 | } |
1da177e4 LT |
753 | } |
754 | } | |
755 | ||
5f8902ac LM |
756 | /* Run _STA to determine if device is present */ |
757 | ||
758 | status = acpi_ut_execute_STA(node, &flags); | |
759 | if (ACPI_FAILURE(status)) { | |
760 | return (AE_CTRL_DEPTH); | |
761 | } | |
762 | ||
763 | if (!(flags & ACPI_STA_DEVICE_PRESENT) && | |
764 | !(flags & ACPI_STA_DEVICE_FUNCTIONING)) { | |
765 | /* | |
766 | * Don't examine the children of the device only when the | |
767 | * device is neither present nor functional. See ACPI spec, | |
768 | * description of _STA for more information. | |
769 | */ | |
770 | return (AE_CTRL_DEPTH); | |
771 | } | |
772 | ||
773 | /* We have a valid device, invoke the user function */ | |
774 | ||
1fad8738 BM |
775 | status = info->user_function(obj_handle, nesting_level, |
776 | info->context, return_value); | |
1da177e4 LT |
777 | return (status); |
778 | } | |
779 | ||
1da177e4 LT |
780 | /******************************************************************************* |
781 | * | |
782 | * FUNCTION: acpi_get_devices | |
783 | * | |
784 | * PARAMETERS: HID - HID to search for. Can be NULL. | |
785 | * user_function - Called when a matching object is found | |
ba494bee | 786 | * context - Passed to user function |
1da177e4 LT |
787 | * return_value - Location where return value of |
788 | * user_function is put if terminated early | |
789 | * | |
790 | * RETURNS Return value from the user_function if terminated early. | |
791 | * Otherwise, returns NULL. | |
792 | * | |
793 | * DESCRIPTION: Performs a modified depth-first walk of the namespace tree, | |
794 | * starting (and ending) at the object specified by start_handle. | |
795 | * The user_function is called whenever an object of type | |
73a3090a | 796 | * Device is found. If the user function returns |
1da177e4 LT |
797 | * a non-zero value, the search is terminated immediately and this |
798 | * value is returned to the caller. | |
799 | * | |
800 | * This is a wrapper for walk_namespace, but the callback performs | |
549f4604 | 801 | * additional filtering. Please see acpi_ns_get_device_callback. |
1da177e4 LT |
802 | * |
803 | ******************************************************************************/ | |
804 | ||
805 | acpi_status | |
70b30fb1 | 806 | acpi_get_devices(const char *HID, |
4be44fcd LB |
807 | acpi_walk_callback user_function, |
808 | void *context, void **return_value) | |
1da177e4 | 809 | { |
4be44fcd LB |
810 | acpi_status status; |
811 | struct acpi_get_devices_info info; | |
1da177e4 | 812 | |
b229cf92 | 813 | ACPI_FUNCTION_TRACE(acpi_get_devices); |
1da177e4 LT |
814 | |
815 | /* Parameter validation */ | |
816 | ||
817 | if (!user_function) { | |
4be44fcd | 818 | return_ACPI_STATUS(AE_BAD_PARAMETER); |
1da177e4 LT |
819 | } |
820 | ||
821 | /* | |
822 | * We're going to call their callback from OUR callback, so we need | |
823 | * to know what it is, and their context parameter. | |
824 | */ | |
52fc0b02 | 825 | info.hid = HID; |
4be44fcd | 826 | info.context = context; |
1da177e4 | 827 | info.user_function = user_function; |
1da177e4 LT |
828 | |
829 | /* | |
830 | * Lock the namespace around the walk. | |
831 | * The namespace will be unlocked/locked around each call | |
832 | * to the user function - since this function | |
833 | * must be allowed to make Acpi calls itself. | |
834 | */ | |
4be44fcd LB |
835 | status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE); |
836 | if (ACPI_FAILURE(status)) { | |
837 | return_ACPI_STATUS(status); | |
1da177e4 LT |
838 | } |
839 | ||
52fc0b02 BM |
840 | status = acpi_ns_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT, |
841 | ACPI_UINT32_MAX, ACPI_NS_WALK_UNLOCK, | |
2263576c LM |
842 | acpi_ns_get_device_callback, NULL, |
843 | &info, return_value); | |
1da177e4 | 844 | |
4be44fcd LB |
845 | (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE); |
846 | return_ACPI_STATUS(status); | |
1da177e4 | 847 | } |
1da177e4 | 848 | |
8313524a | 849 | ACPI_EXPORT_SYMBOL(acpi_get_devices) |
1da177e4 LT |
850 | |
851 | /******************************************************************************* | |
852 | * | |
853 | * FUNCTION: acpi_attach_data | |
854 | * | |
855 | * PARAMETERS: obj_handle - Namespace node | |
ba494bee BM |
856 | * handler - Handler for this attachment |
857 | * data - Pointer to data to be attached | |
1da177e4 LT |
858 | * |
859 | * RETURN: Status | |
860 | * | |
861 | * DESCRIPTION: Attach arbitrary data and handler to a namespace node. | |
862 | * | |
863 | ******************************************************************************/ | |
1da177e4 | 864 | acpi_status |
4be44fcd LB |
865 | acpi_attach_data(acpi_handle obj_handle, |
866 | acpi_object_handler handler, void *data) | |
1da177e4 | 867 | { |
4be44fcd LB |
868 | struct acpi_namespace_node *node; |
869 | acpi_status status; | |
1da177e4 LT |
870 | |
871 | /* Parameter validation */ | |
872 | ||
4be44fcd | 873 | if (!obj_handle || !handler || !data) { |
1da177e4 LT |
874 | return (AE_BAD_PARAMETER); |
875 | } | |
876 | ||
4be44fcd LB |
877 | status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE); |
878 | if (ACPI_FAILURE(status)) { | |
1da177e4 LT |
879 | return (status); |
880 | } | |
881 | ||
882 | /* Convert and validate the handle */ | |
883 | ||
f24b664d | 884 | node = acpi_ns_validate_handle(obj_handle); |
1da177e4 LT |
885 | if (!node) { |
886 | status = AE_BAD_PARAMETER; | |
887 | goto unlock_and_exit; | |
888 | } | |
889 | ||
4be44fcd | 890 | status = acpi_ns_attach_data(node, handler, data); |
1da177e4 | 891 | |
10622bf8 | 892 | unlock_and_exit: |
4be44fcd | 893 | (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE); |
1da177e4 LT |
894 | return (status); |
895 | } | |
896 | ||
8313524a BM |
897 | ACPI_EXPORT_SYMBOL(acpi_attach_data) |
898 | ||
1da177e4 LT |
899 | /******************************************************************************* |
900 | * | |
901 | * FUNCTION: acpi_detach_data | |
902 | * | |
903 | * PARAMETERS: obj_handle - Namespace node handle | |
ba494bee | 904 | * handler - Handler used in call to acpi_attach_data |
1da177e4 LT |
905 | * |
906 | * RETURN: Status | |
907 | * | |
908 | * DESCRIPTION: Remove data that was previously attached to a node. | |
909 | * | |
910 | ******************************************************************************/ | |
1da177e4 | 911 | acpi_status |
4be44fcd | 912 | acpi_detach_data(acpi_handle obj_handle, acpi_object_handler handler) |
1da177e4 | 913 | { |
4be44fcd LB |
914 | struct acpi_namespace_node *node; |
915 | acpi_status status; | |
1da177e4 LT |
916 | |
917 | /* Parameter validation */ | |
918 | ||
4be44fcd | 919 | if (!obj_handle || !handler) { |
1da177e4 LT |
920 | return (AE_BAD_PARAMETER); |
921 | } | |
922 | ||
4be44fcd LB |
923 | status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE); |
924 | if (ACPI_FAILURE(status)) { | |
1da177e4 LT |
925 | return (status); |
926 | } | |
927 | ||
928 | /* Convert and validate the handle */ | |
929 | ||
f24b664d | 930 | node = acpi_ns_validate_handle(obj_handle); |
1da177e4 LT |
931 | if (!node) { |
932 | status = AE_BAD_PARAMETER; | |
933 | goto unlock_and_exit; | |
934 | } | |
935 | ||
4be44fcd | 936 | status = acpi_ns_detach_data(node, handler); |
1da177e4 | 937 | |
10622bf8 | 938 | unlock_and_exit: |
4be44fcd | 939 | (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE); |
1da177e4 LT |
940 | return (status); |
941 | } | |
942 | ||
8313524a BM |
943 | ACPI_EXPORT_SYMBOL(acpi_detach_data) |
944 | ||
1da177e4 LT |
945 | /******************************************************************************* |
946 | * | |
7c2e1771 | 947 | * FUNCTION: acpi_get_data_full |
1da177e4 LT |
948 | * |
949 | * PARAMETERS: obj_handle - Namespace node | |
ba494bee BM |
950 | * handler - Handler used in call to attach_data |
951 | * data - Where the data is returned | |
7c2e1771 | 952 | * callback - function to execute before returning |
1da177e4 LT |
953 | * |
954 | * RETURN: Status | |
955 | * | |
7c2e1771 RW |
956 | * DESCRIPTION: Retrieve data that was previously attached to a namespace node |
957 | * and execute a callback before returning. | |
1da177e4 LT |
958 | * |
959 | ******************************************************************************/ | |
1da177e4 | 960 | acpi_status |
7c2e1771 RW |
961 | acpi_get_data_full(acpi_handle obj_handle, acpi_object_handler handler, |
962 | void **data, void (*callback)(void *)) | |
1da177e4 | 963 | { |
4be44fcd LB |
964 | struct acpi_namespace_node *node; |
965 | acpi_status status; | |
1da177e4 LT |
966 | |
967 | /* Parameter validation */ | |
968 | ||
4be44fcd | 969 | if (!obj_handle || !handler || !data) { |
1da177e4 LT |
970 | return (AE_BAD_PARAMETER); |
971 | } | |
972 | ||
4be44fcd LB |
973 | status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE); |
974 | if (ACPI_FAILURE(status)) { | |
1da177e4 LT |
975 | return (status); |
976 | } | |
977 | ||
978 | /* Convert and validate the handle */ | |
979 | ||
f24b664d | 980 | node = acpi_ns_validate_handle(obj_handle); |
1da177e4 LT |
981 | if (!node) { |
982 | status = AE_BAD_PARAMETER; | |
983 | goto unlock_and_exit; | |
984 | } | |
985 | ||
4be44fcd | 986 | status = acpi_ns_get_attached_data(node, handler, data); |
7c2e1771 RW |
987 | if (ACPI_SUCCESS(status) && callback) { |
988 | callback(*data); | |
989 | } | |
1da177e4 | 990 | |
10622bf8 | 991 | unlock_and_exit: |
4be44fcd | 992 | (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE); |
1da177e4 LT |
993 | return (status); |
994 | } | |
8313524a | 995 | |
7c2e1771 RW |
996 | ACPI_EXPORT_SYMBOL(acpi_get_data_full) |
997 | ||
998 | /******************************************************************************* | |
999 | * | |
1000 | * FUNCTION: acpi_get_data | |
1001 | * | |
1002 | * PARAMETERS: obj_handle - Namespace node | |
1003 | * handler - Handler used in call to attach_data | |
1004 | * data - Where the data is returned | |
1005 | * | |
1006 | * RETURN: Status | |
1007 | * | |
1008 | * DESCRIPTION: Retrieve data that was previously attached to a namespace node. | |
1009 | * | |
1010 | ******************************************************************************/ | |
1011 | acpi_status | |
1012 | acpi_get_data(acpi_handle obj_handle, acpi_object_handler handler, void **data) | |
1013 | { | |
1014 | return acpi_get_data_full(obj_handle, handler, data, NULL); | |
1015 | } | |
1016 | ||
8313524a | 1017 | ACPI_EXPORT_SYMBOL(acpi_get_data) |