]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - drivers/acpi/acpica/nsxfeval.c
ACPICA: Change package length error message to an info message
[mirror_ubuntu-artful-kernel.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/*
75a44ce0 9 * Copyright (C) 2000 - 2008, 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
1da177e4 45#include <acpi/acpi.h>
e2f7a777
LB
46#include "accommon.h"
47#include "acnamesp.h"
48#include "acinterp.h"
1da177e4 49
1da177e4 50#define _COMPONENT ACPI_NAMESPACE
4be44fcd 51ACPI_MODULE_NAME("nsxfeval")
bbc24134
LM
52
53/* Local prototypes */
54static void acpi_ns_resolve_references(struct acpi_evaluate_info *info);
55
1da177e4
LT
56/*******************************************************************************
57 *
58 * FUNCTION: acpi_evaluate_object_typed
59 *
60 * PARAMETERS: Handle - Object handle (optional)
44f6c012
RM
61 * Pathname - Object pathname (optional)
62 * external_params - List of parameters to pass to method,
1da177e4
LT
63 * terminated by NULL. May be NULL
64 * if no parameters are being passed.
44f6c012 65 * return_buffer - Where to put method's return value (if
1da177e4
LT
66 * any). If NULL, no value is returned.
67 * return_type - Expected type of return object
68 *
69 * RETURN: Status
70 *
71 * DESCRIPTION: Find and evaluate the given object, passing the given
72 * parameters if necessary. One of "Handle" or "Pathname" must
73 * be valid (non-null)
74 *
75 ******************************************************************************/
bbc24134 76
1da177e4 77acpi_status
4be44fcd
LB
78acpi_evaluate_object_typed(acpi_handle handle,
79 acpi_string pathname,
fd350943
LB
80 struct acpi_object_list *external_params,
81 struct acpi_buffer *return_buffer,
4be44fcd 82 acpi_object_type return_type)
1da177e4 83{
4be44fcd
LB
84 acpi_status status;
85 u8 must_free = FALSE;
1da177e4 86
b229cf92 87 ACPI_FUNCTION_TRACE(acpi_evaluate_object_typed);
1da177e4
LT
88
89 /* Return buffer must be valid */
90
91 if (!return_buffer) {
4be44fcd 92 return_ACPI_STATUS(AE_BAD_PARAMETER);
1da177e4
LT
93 }
94
95 if (return_buffer->length == ACPI_ALLOCATE_BUFFER) {
96 must_free = TRUE;
97 }
98
99 /* Evaluate the object */
100
4be44fcd
LB
101 status =
102 acpi_evaluate_object(handle, pathname, external_params,
103 return_buffer);
104 if (ACPI_FAILURE(status)) {
105 return_ACPI_STATUS(status);
1da177e4
LT
106 }
107
108 /* Type ANY means "don't care" */
109
110 if (return_type == ACPI_TYPE_ANY) {
4be44fcd 111 return_ACPI_STATUS(AE_OK);
1da177e4
LT
112 }
113
114 if (return_buffer->length == 0) {
52fc0b02 115
1da177e4
LT
116 /* Error because caller specifically asked for a return value */
117
b8e4d893 118 ACPI_ERROR((AE_INFO, "No return value"));
4be44fcd 119 return_ACPI_STATUS(AE_NULL_OBJECT);
1da177e4
LT
120 }
121
122 /* Examine the object type returned from evaluate_object */
123
4be44fcd
LB
124 if (((union acpi_object *)return_buffer->pointer)->type == return_type) {
125 return_ACPI_STATUS(AE_OK);
1da177e4
LT
126 }
127
128 /* Return object type does not match requested type */
129
b8e4d893
BM
130 ACPI_ERROR((AE_INFO,
131 "Incorrect return type [%s] requested [%s]",
132 acpi_ut_get_type_name(((union acpi_object *)return_buffer->
133 pointer)->type),
134 acpi_ut_get_type_name(return_type)));
1da177e4
LT
135
136 if (must_free) {
52fc0b02 137
1da177e4
LT
138 /* Caller used ACPI_ALLOCATE_BUFFER, free the return buffer */
139
02438d87 140 ACPI_FREE(return_buffer->pointer);
1da177e4
LT
141 return_buffer->pointer = NULL;
142 }
143
144 return_buffer->length = 0;
4be44fcd 145 return_ACPI_STATUS(AE_TYPE);
1da177e4 146}
8313524a
BM
147
148ACPI_EXPORT_SYMBOL(acpi_evaluate_object_typed)
2c03d07a 149
1da177e4
LT
150/*******************************************************************************
151 *
152 * FUNCTION: acpi_evaluate_object
153 *
154 * PARAMETERS: Handle - Object handle (optional)
155 * Pathname - Object pathname (optional)
156 * external_params - List of parameters to pass to method,
157 * terminated by NULL. May be NULL
158 * if no parameters are being passed.
159 * return_buffer - Where to put method's return value (if
160 * any). If NULL, no value is returned.
161 *
162 * RETURN: Status
163 *
164 * DESCRIPTION: Find and evaluate the given object, passing the given
165 * parameters if necessary. One of "Handle" or "Pathname" must
166 * be valid (non-null)
167 *
168 ******************************************************************************/
1da177e4 169acpi_status
4be44fcd
LB
170acpi_evaluate_object(acpi_handle handle,
171 acpi_string pathname,
172 struct acpi_object_list *external_params,
173 struct acpi_buffer *return_buffer)
1da177e4 174{
4be44fcd 175 acpi_status status;
4119532c 176 struct acpi_evaluate_info *info;
4be44fcd
LB
177 acpi_size buffer_space_needed;
178 u32 i;
1da177e4 179
b229cf92 180 ACPI_FUNCTION_TRACE(acpi_evaluate_object);
1da177e4 181
4119532c
BM
182 /* Allocate and initialize the evaluation information block */
183
184 info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
185 if (!info) {
186 return_ACPI_STATUS(AE_NO_MEMORY);
187 }
188
189 info->pathname = pathname;
4119532c
BM
190
191 /* Convert and validate the device handle */
192
193 info->prefix_node = acpi_ns_map_handle_to_node(handle);
194 if (!info->prefix_node) {
195 status = AE_BAD_PARAMETER;
196 goto cleanup;
197 }
1da177e4
LT
198
199 /*
4119532c
BM
200 * If there are parameters to be passed to a control method, the external
201 * objects must all be converted to internal objects
1da177e4
LT
202 */
203 if (external_params && external_params->count) {
204 /*
205 * Allocate a new parameter block for the internal objects
206 * Add 1 to count to allow for null terminated internal list
207 */
4119532c
BM
208 info->parameters = ACPI_ALLOCATE_ZEROED(((acpi_size)
209 external_params->
210 count +
211 1) * sizeof(void *));
212 if (!info->parameters) {
213 status = AE_NO_MEMORY;
214 goto cleanup;
1da177e4
LT
215 }
216
4119532c
BM
217 /* Convert each external object in the list to an internal object */
218
1da177e4 219 for (i = 0; i < external_params->count; i++) {
4be44fcd
LB
220 status =
221 acpi_ut_copy_eobject_to_iobject(&external_params->
222 pointer[i],
4119532c 223 &info->
4be44fcd
LB
224 parameters[i]);
225 if (ACPI_FAILURE(status)) {
4119532c 226 goto cleanup;
1da177e4
LT
227 }
228 }
4119532c 229 info->parameters[external_params->count] = NULL;
1da177e4
LT
230 }
231
1da177e4
LT
232 /*
233 * Three major cases:
234 * 1) Fully qualified pathname
235 * 2) No handle, not fully qualified pathname (error)
236 * 3) Valid handle
237 */
4be44fcd 238 if ((pathname) && (acpi_ns_valid_root_prefix(pathname[0]))) {
52fc0b02
BM
239
240 /* The path is fully qualified, just evaluate by name */
241
4119532c
BM
242 info->prefix_node = NULL;
243 status = acpi_ns_evaluate(info);
4be44fcd 244 } else if (!handle) {
1da177e4 245 /*
4119532c
BM
246 * A handle is optional iff a fully qualified pathname is specified.
247 * Since we've already handled fully qualified names above, this is
248 * an error
1da177e4
LT
249 */
250 if (!pathname) {
52fc0b02
BM
251 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
252 "Both Handle and Pathname are NULL"));
4be44fcd 253 } else {
52fc0b02
BM
254 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
255 "Null Handle with relative pathname [%s]",
256 pathname));
1da177e4
LT
257 }
258
259 status = AE_BAD_PARAMETER;
4be44fcd 260 } else {
4119532c 261 /* We have a namespace a node and a possible relative path */
52fc0b02 262
4119532c 263 status = acpi_ns_evaluate(info);
1da177e4
LT
264 }
265
1da177e4
LT
266 /*
267 * If we are expecting a return value, and all went well above,
268 * copy the return value to an external object.
269 */
270 if (return_buffer) {
4119532c 271 if (!info->return_object) {
1da177e4 272 return_buffer->length = 0;
4be44fcd 273 } else {
4119532c 274 if (ACPI_GET_DESCRIPTOR_TYPE(info->return_object) ==
4be44fcd 275 ACPI_DESC_TYPE_NAMED) {
1da177e4
LT
276 /*
277 * If we received a NS Node as a return object, this means that
278 * the object we are evaluating has nothing interesting to
279 * return (such as a mutex, etc.) We return an error because
280 * these types are essentially unsupported by this interface.
281 * We don't check up front because this makes it easier to add
282 * support for various types at a later date if necessary.
283 */
284 status = AE_TYPE;
4119532c 285 info->return_object = NULL; /* No need to delete a NS Node */
1da177e4
LT
286 return_buffer->length = 0;
287 }
288
4be44fcd 289 if (ACPI_SUCCESS(status)) {
4119532c 290
bbc24134
LM
291 /* Dereference Index and ref_of references */
292
293 acpi_ns_resolve_references(info);
294
4119532c
BM
295 /* Get the size of the returned object */
296
4be44fcd 297 status =
4119532c 298 acpi_ut_get_object_size(info->return_object,
4be44fcd
LB
299 &buffer_space_needed);
300 if (ACPI_SUCCESS(status)) {
52fc0b02 301
1da177e4
LT
302 /* Validate/Allocate/Clear caller buffer */
303
4be44fcd
LB
304 status =
305 acpi_ut_initialize_buffer
306 (return_buffer,
307 buffer_space_needed);
308 if (ACPI_FAILURE(status)) {
1da177e4 309 /*
52fc0b02
BM
310 * Caller's buffer is too small or a new one can't
311 * be allocated
1da177e4 312 */
4be44fcd
LB
313 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
314 "Needed buffer size %X, %s\n",
315 (u32)
316 buffer_space_needed,
317 acpi_format_exception
318 (status)));
319 } else {
52fc0b02
BM
320 /* We have enough space for the object, build it */
321
4be44fcd
LB
322 status =
323 acpi_ut_copy_iobject_to_eobject
4119532c 324 (info->return_object,
4be44fcd 325 return_buffer);
1da177e4
LT
326 }
327 }
328 }
329 }
330 }
331
4119532c 332 if (info->return_object) {
1da177e4 333 /*
4119532c
BM
334 * Delete the internal return object. NOTE: Interpreter must be
335 * locked to avoid race condition.
1da177e4 336 */
4d2acd9e 337 acpi_ex_enter_interpreter();
4119532c 338
4d2acd9e 339 /* Remove one reference on the return object (should delete it) */
4119532c 340
4d2acd9e
LB
341 acpi_ut_remove_reference(info->return_object);
342 acpi_ex_exit_interpreter();
1da177e4
LT
343 }
344
4119532c
BM
345 cleanup:
346
52fc0b02
BM
347 /* Free the input parameter list (if we created one) */
348
4119532c 349 if (info->parameters) {
52fc0b02 350
1da177e4
LT
351 /* Free the allocated parameter block */
352
4119532c 353 acpi_ut_delete_internal_object_list(info->parameters);
1da177e4
LT
354 }
355
4119532c 356 ACPI_FREE(info);
4be44fcd 357 return_ACPI_STATUS(status);
1da177e4 358}
1da177e4 359
8313524a 360ACPI_EXPORT_SYMBOL(acpi_evaluate_object)
1da177e4 361
bbc24134
LM
362/*******************************************************************************
363 *
364 * FUNCTION: acpi_ns_resolve_references
365 *
366 * PARAMETERS: Info - Evaluation info block
367 *
368 * RETURN: Info->return_object is replaced with the dereferenced object
369 *
370 * DESCRIPTION: Dereference certain reference objects. Called before an
371 * internal return object is converted to an external union acpi_object.
372 *
373 * Performs an automatic dereference of Index and ref_of reference objects.
374 * These reference objects are not supported by the union acpi_object, so this is a
375 * last resort effort to return something useful. Also, provides compatibility
376 * with other ACPI implementations.
377 *
378 * NOTE: does not handle references within returned package objects or nested
379 * references, but this support could be added later if found to be necessary.
380 *
381 ******************************************************************************/
382static void acpi_ns_resolve_references(struct acpi_evaluate_info *info)
383{
384 union acpi_operand_object *obj_desc = NULL;
385 struct acpi_namespace_node *node;
386
387 /* We are interested in reference objects only */
388
3371c19c 389 if ((info->return_object)->common.type != ACPI_TYPE_LOCAL_REFERENCE) {
bbc24134
LM
390 return;
391 }
392
393 /*
394 * Two types of references are supported - those created by Index and
395 * ref_of operators. A name reference (AML_NAMEPATH_OP) can be converted
396 * to an union acpi_object, so it is not dereferenced here. A ddb_handle
397 * (AML_LOAD_OP) cannot be dereferenced, nor can it be converted to
398 * an union acpi_object.
399 */
1044f1f6
BM
400 switch (info->return_object->reference.class) {
401 case ACPI_REFCLASS_INDEX:
bbc24134
LM
402
403 obj_desc = *(info->return_object->reference.where);
404 break;
405
1044f1f6 406 case ACPI_REFCLASS_REFOF:
bbc24134
LM
407
408 node = info->return_object->reference.object;
409 if (node) {
410 obj_desc = node->object;
411 }
412 break;
413
414 default:
415 return;
416 }
417
418 /* Replace the existing reference object */
419
420 if (obj_desc) {
421 acpi_ut_add_reference(obj_desc);
422 acpi_ut_remove_reference(info->return_object);
423 info->return_object = obj_desc;
424 }
425
426 return;
427}
428
1da177e4
LT
429/*******************************************************************************
430 *
431 * FUNCTION: acpi_walk_namespace
432 *
433 * PARAMETERS: Type - acpi_object_type to search for
434 * start_object - Handle in namespace where search begins
435 * max_depth - Depth to which search is to reach
436 * user_function - Called when an object of "Type" is found
437 * Context - Passed to user function
438 * return_value - Location where return value of
439 * user_function is put if terminated early
440 *
441 * RETURNS Return value from the user_function if terminated early.
442 * Otherwise, returns NULL.
443 *
444 * DESCRIPTION: Performs a modified depth-first walk of the namespace tree,
445 * starting (and ending) at the object specified by start_handle.
446 * The user_function is called whenever an object that matches
447 * the type parameter is found. If the user function returns
448 * a non-zero value, the search is terminated immediately and this
449 * value is returned to the caller.
450 *
451 * The point of this procedure is to provide a generic namespace
452 * walk routine that can be called from multiple places to
453 * provide multiple services; the User Function can be tailored
454 * to each task, whether it is a print function, a compare
455 * function, etc.
456 *
457 ******************************************************************************/
bbc24134 458
1da177e4 459acpi_status
4be44fcd
LB
460acpi_walk_namespace(acpi_object_type type,
461 acpi_handle start_object,
462 u32 max_depth,
463 acpi_walk_callback user_function,
464 void *context, void **return_value)
1da177e4 465{
4be44fcd 466 acpi_status status;
1da177e4 467
b229cf92 468 ACPI_FUNCTION_TRACE(acpi_walk_namespace);
1da177e4
LT
469
470 /* Parameter validation */
471
96db255c 472 if ((type > ACPI_TYPE_LOCAL_MAX) || (!max_depth) || (!user_function)) {
4be44fcd 473 return_ACPI_STATUS(AE_BAD_PARAMETER);
1da177e4
LT
474 }
475
476 /*
8a335a23
BM
477 * Need to acquire the namespace reader lock to prevent interference
478 * with any concurrent table unloads (which causes the deletion of
479 * namespace objects). We cannot allow the deletion of a namespace node
480 * while the user function is using it. The exception to this are the
481 * nodes created and deleted during control method execution -- these
482 * nodes are marked as temporary nodes and are ignored by the namespace
483 * walk. Thus, control methods can be executed while holding the
484 * namespace deletion lock (and the user function can execute control
485 * methods.)
486 */
487 status = acpi_ut_acquire_read_lock(&acpi_gbl_namespace_rw_lock);
488 if (ACPI_FAILURE(status)) {
489 return status;
490 }
491
492 /*
493 * Lock the namespace around the walk. The namespace will be
494 * unlocked/locked around each call to the user function - since the user
495 * function must be allowed to make ACPICA calls itself (for example, it
496 * will typically execute control methods during device enumeration.)
1da177e4 497 */
4be44fcd
LB
498 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
499 if (ACPI_FAILURE(status)) {
8a335a23 500 goto unlock_and_exit;
1da177e4
LT
501 }
502
4be44fcd 503 status = acpi_ns_walk_namespace(type, start_object, max_depth,
8a335a23
BM
504 ACPI_NS_WALK_UNLOCK, user_function,
505 context, return_value);
1da177e4 506
4be44fcd 507 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
8a335a23
BM
508
509 unlock_and_exit:
510 (void)acpi_ut_release_read_lock(&acpi_gbl_namespace_rw_lock);
4be44fcd 511 return_ACPI_STATUS(status);
1da177e4 512}
1da177e4 513
8313524a 514ACPI_EXPORT_SYMBOL(acpi_walk_namespace)
1da177e4
LT
515
516/*******************************************************************************
517 *
518 * FUNCTION: acpi_ns_get_device_callback
519 *
520 * PARAMETERS: Callback from acpi_get_device
521 *
522 * RETURN: Status
523 *
524 * DESCRIPTION: Takes callbacks from walk_namespace and filters out all non-
525 * present devices, or if they specified a HID, it filters based
526 * on that.
527 *
528 ******************************************************************************/
1da177e4 529static acpi_status
4be44fcd
LB
530acpi_ns_get_device_callback(acpi_handle obj_handle,
531 u32 nesting_level,
532 void *context, void **return_value)
1da177e4 533{
4be44fcd
LB
534 struct acpi_get_devices_info *info = context;
535 acpi_status status;
536 struct acpi_namespace_node *node;
537 u32 flags;
15b8dd53
BM
538 struct acpica_device_id *hid;
539 struct acpica_device_id_list *cid;
67a119f9 540 u32 i;
15b8dd53
BM
541 u8 found;
542 int no_match;
1da177e4 543
4be44fcd
LB
544 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
545 if (ACPI_FAILURE(status)) {
1da177e4
LT
546 return (status);
547 }
548
4be44fcd
LB
549 node = acpi_ns_map_handle_to_node(obj_handle);
550 status = acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
551 if (ACPI_FAILURE(status)) {
1da177e4
LT
552 return (status);
553 }
554
555 if (!node) {
556 return (AE_BAD_PARAMETER);
557 }
558
559 /* Run _STA to determine if device is present */
560
4be44fcd
LB
561 status = acpi_ut_execute_STA(node, &flags);
562 if (ACPI_FAILURE(status)) {
1da177e4
LT
563 return (AE_CTRL_DEPTH);
564 }
565
549f4604
BM
566 if (!(flags & ACPI_STA_DEVICE_PRESENT) &&
567 !(flags & ACPI_STA_DEVICE_FUNCTIONING)) {
568 /*
569 * Don't examine the children of the device only when the
570 * device is neither present nor functional. See ACPI spec,
571 * description of _STA for more information.
572 */
1da177e4
LT
573 return (AE_CTRL_DEPTH);
574 }
575
576 /* Filter based on device HID & CID */
577
578 if (info->hid != NULL) {
4be44fcd 579 status = acpi_ut_execute_HID(node, &hid);
1da177e4
LT
580 if (status == AE_NOT_FOUND) {
581 return (AE_OK);
4be44fcd 582 } else if (ACPI_FAILURE(status)) {
1da177e4
LT
583 return (AE_CTRL_DEPTH);
584 }
585
15b8dd53
BM
586 no_match = ACPI_STRCMP(hid->string, info->hid);
587 ACPI_FREE(hid);
1da177e4 588
15b8dd53
BM
589 if (no_match) {
590 /*
591 * HID does not match, attempt match within the
592 * list of Compatible IDs (CIDs)
593 */
4be44fcd 594 status = acpi_ut_execute_CID(node, &cid);
1da177e4
LT
595 if (status == AE_NOT_FOUND) {
596 return (AE_OK);
4be44fcd 597 } else if (ACPI_FAILURE(status)) {
1da177e4
LT
598 return (AE_CTRL_DEPTH);
599 }
600
601 /* Walk the CID list */
602
02f8a858 603 found = 0;
1da177e4 604 for (i = 0; i < cid->count; i++) {
15b8dd53
BM
605 if (ACPI_STRCMP(cid->ids[i].string, info->hid)
606 == 0) {
02f8a858
AP
607 found = 1;
608 break;
1da177e4
LT
609 }
610 }
8313524a 611 ACPI_FREE(cid);
02f8a858
AP
612 if (!found)
613 return (AE_OK);
1da177e4
LT
614 }
615 }
616
4be44fcd
LB
617 status = info->user_function(obj_handle, nesting_level, info->context,
618 return_value);
1da177e4
LT
619 return (status);
620}
621
1da177e4
LT
622/*******************************************************************************
623 *
624 * FUNCTION: acpi_get_devices
625 *
626 * PARAMETERS: HID - HID to search for. Can be NULL.
627 * user_function - Called when a matching object is found
628 * Context - Passed to user function
629 * return_value - Location where return value of
630 * user_function is put if terminated early
631 *
632 * RETURNS Return value from the user_function if terminated early.
633 * Otherwise, returns NULL.
634 *
635 * DESCRIPTION: Performs a modified depth-first walk of the namespace tree,
636 * starting (and ending) at the object specified by start_handle.
637 * The user_function is called whenever an object of type
638 * Device is found. If the user function returns
639 * a non-zero value, the search is terminated immediately and this
640 * value is returned to the caller.
641 *
642 * This is a wrapper for walk_namespace, but the callback performs
549f4604 643 * additional filtering. Please see acpi_ns_get_device_callback.
1da177e4
LT
644 *
645 ******************************************************************************/
646
647acpi_status
70b30fb1 648acpi_get_devices(const char *HID,
4be44fcd
LB
649 acpi_walk_callback user_function,
650 void *context, void **return_value)
1da177e4 651{
4be44fcd
LB
652 acpi_status status;
653 struct acpi_get_devices_info info;
1da177e4 654
b229cf92 655 ACPI_FUNCTION_TRACE(acpi_get_devices);
1da177e4
LT
656
657 /* Parameter validation */
658
659 if (!user_function) {
4be44fcd 660 return_ACPI_STATUS(AE_BAD_PARAMETER);
1da177e4
LT
661 }
662
663 /*
664 * We're going to call their callback from OUR callback, so we need
665 * to know what it is, and their context parameter.
666 */
52fc0b02 667 info.hid = HID;
4be44fcd 668 info.context = context;
1da177e4 669 info.user_function = user_function;
1da177e4
LT
670
671 /*
672 * Lock the namespace around the walk.
673 * The namespace will be unlocked/locked around each call
674 * to the user function - since this function
675 * must be allowed to make Acpi calls itself.
676 */
4be44fcd
LB
677 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
678 if (ACPI_FAILURE(status)) {
679 return_ACPI_STATUS(status);
1da177e4
LT
680 }
681
52fc0b02
BM
682 status = acpi_ns_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
683 ACPI_UINT32_MAX, ACPI_NS_WALK_UNLOCK,
4be44fcd
LB
684 acpi_ns_get_device_callback, &info,
685 return_value);
1da177e4 686
4be44fcd
LB
687 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
688 return_ACPI_STATUS(status);
1da177e4 689}
1da177e4 690
8313524a 691ACPI_EXPORT_SYMBOL(acpi_get_devices)
1da177e4
LT
692
693/*******************************************************************************
694 *
695 * FUNCTION: acpi_attach_data
696 *
697 * PARAMETERS: obj_handle - Namespace node
698 * Handler - Handler for this attachment
699 * Data - Pointer to data to be attached
700 *
701 * RETURN: Status
702 *
703 * DESCRIPTION: Attach arbitrary data and handler to a namespace node.
704 *
705 ******************************************************************************/
1da177e4 706acpi_status
4be44fcd
LB
707acpi_attach_data(acpi_handle obj_handle,
708 acpi_object_handler handler, void *data)
1da177e4 709{
4be44fcd
LB
710 struct acpi_namespace_node *node;
711 acpi_status status;
1da177e4
LT
712
713 /* Parameter validation */
714
4be44fcd 715 if (!obj_handle || !handler || !data) {
1da177e4
LT
716 return (AE_BAD_PARAMETER);
717 }
718
4be44fcd
LB
719 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
720 if (ACPI_FAILURE(status)) {
1da177e4
LT
721 return (status);
722 }
723
724 /* Convert and validate the handle */
725
4be44fcd 726 node = acpi_ns_map_handle_to_node(obj_handle);
1da177e4
LT
727 if (!node) {
728 status = AE_BAD_PARAMETER;
729 goto unlock_and_exit;
730 }
731
4be44fcd 732 status = acpi_ns_attach_data(node, handler, data);
1da177e4 733
4be44fcd
LB
734 unlock_and_exit:
735 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
1da177e4
LT
736 return (status);
737}
738
8313524a
BM
739ACPI_EXPORT_SYMBOL(acpi_attach_data)
740
1da177e4
LT
741/*******************************************************************************
742 *
743 * FUNCTION: acpi_detach_data
744 *
745 * PARAMETERS: obj_handle - Namespace node handle
746 * Handler - Handler used in call to acpi_attach_data
747 *
748 * RETURN: Status
749 *
750 * DESCRIPTION: Remove data that was previously attached to a node.
751 *
752 ******************************************************************************/
1da177e4 753acpi_status
4be44fcd 754acpi_detach_data(acpi_handle obj_handle, acpi_object_handler handler)
1da177e4 755{
4be44fcd
LB
756 struct acpi_namespace_node *node;
757 acpi_status status;
1da177e4
LT
758
759 /* Parameter validation */
760
4be44fcd 761 if (!obj_handle || !handler) {
1da177e4
LT
762 return (AE_BAD_PARAMETER);
763 }
764
4be44fcd
LB
765 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
766 if (ACPI_FAILURE(status)) {
1da177e4
LT
767 return (status);
768 }
769
770 /* Convert and validate the handle */
771
4be44fcd 772 node = acpi_ns_map_handle_to_node(obj_handle);
1da177e4
LT
773 if (!node) {
774 status = AE_BAD_PARAMETER;
775 goto unlock_and_exit;
776 }
777
4be44fcd 778 status = acpi_ns_detach_data(node, handler);
1da177e4 779
4be44fcd
LB
780 unlock_and_exit:
781 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
1da177e4
LT
782 return (status);
783}
784
8313524a
BM
785ACPI_EXPORT_SYMBOL(acpi_detach_data)
786
1da177e4
LT
787/*******************************************************************************
788 *
789 * FUNCTION: acpi_get_data
790 *
791 * PARAMETERS: obj_handle - Namespace node
792 * Handler - Handler used in call to attach_data
793 * Data - Where the data is returned
794 *
795 * RETURN: Status
796 *
797 * DESCRIPTION: Retrieve data that was previously attached to a namespace node.
798 *
799 ******************************************************************************/
1da177e4 800acpi_status
4be44fcd 801acpi_get_data(acpi_handle obj_handle, acpi_object_handler handler, void **data)
1da177e4 802{
4be44fcd
LB
803 struct acpi_namespace_node *node;
804 acpi_status status;
1da177e4
LT
805
806 /* Parameter validation */
807
4be44fcd 808 if (!obj_handle || !handler || !data) {
1da177e4
LT
809 return (AE_BAD_PARAMETER);
810 }
811
4be44fcd
LB
812 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
813 if (ACPI_FAILURE(status)) {
1da177e4
LT
814 return (status);
815 }
816
817 /* Convert and validate the handle */
818
4be44fcd 819 node = acpi_ns_map_handle_to_node(obj_handle);
1da177e4
LT
820 if (!node) {
821 status = AE_BAD_PARAMETER;
822 goto unlock_and_exit;
823 }
824
4be44fcd 825 status = acpi_ns_get_attached_data(node, handler, data);
1da177e4 826
4be44fcd
LB
827 unlock_and_exit:
828 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
1da177e4
LT
829 return (status);
830}
8313524a
BM
831
832ACPI_EXPORT_SYMBOL(acpi_get_data)