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