1 /*******************************************************************************
3 * Module Name: nsxfeval - Public interfaces to the ACPI subsystem
4 * ACPI Object evaluation interfaces
6 ******************************************************************************/
9 * Copyright (C) 2000 - 2006, R. Byron Moore
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
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.
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.
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.
45 #include <acpi/acpi.h>
46 #include <acpi/acnamesp.h>
47 #include <acpi/acinterp.h>
49 #define _COMPONENT ACPI_NAMESPACE
50 ACPI_MODULE_NAME("nsxfeval")
52 #ifdef ACPI_FUTURE_USAGE
53 /*******************************************************************************
55 * FUNCTION: acpi_evaluate_object_typed
57 * PARAMETERS: Handle - Object handle (optional)
58 * Pathname - Object pathname (optional)
59 * external_params - List of parameters to pass to method,
60 * terminated by NULL. May be NULL
61 * if no parameters are being passed.
62 * return_buffer - Where to put method's return value (if
63 * any). If NULL, no value is returned.
64 * return_type - Expected type of return object
68 * DESCRIPTION: Find and evaluate the given object, passing the given
69 * parameters if necessary. One of "Handle" or "Pathname" must
72 ******************************************************************************/
74 acpi_evaluate_object_typed(acpi_handle handle
,
76 struct acpi_object_list
* external_params
,
77 struct acpi_buffer
* return_buffer
,
78 acpi_object_type return_type
)
83 ACPI_FUNCTION_TRACE(acpi_evaluate_object_typed
);
85 /* Return buffer must be valid */
88 return_ACPI_STATUS(AE_BAD_PARAMETER
);
91 if (return_buffer
->length
== ACPI_ALLOCATE_BUFFER
) {
95 /* Evaluate the object */
98 acpi_evaluate_object(handle
, pathname
, external_params
,
100 if (ACPI_FAILURE(status
)) {
101 return_ACPI_STATUS(status
);
104 /* Type ANY means "don't care" */
106 if (return_type
== ACPI_TYPE_ANY
) {
107 return_ACPI_STATUS(AE_OK
);
110 if (return_buffer
->length
== 0) {
112 /* Error because caller specifically asked for a return value */
114 ACPI_ERROR((AE_INFO
, "No return value"));
115 return_ACPI_STATUS(AE_NULL_OBJECT
);
118 /* Examine the object type returned from evaluate_object */
120 if (((union acpi_object
*)return_buffer
->pointer
)->type
== return_type
) {
121 return_ACPI_STATUS(AE_OK
);
124 /* Return object type does not match requested type */
127 "Incorrect return type [%s] requested [%s]",
128 acpi_ut_get_type_name(((union acpi_object
*)return_buffer
->
130 acpi_ut_get_type_name(return_type
)));
134 /* Caller used ACPI_ALLOCATE_BUFFER, free the return buffer */
136 ACPI_FREE(return_buffer
->pointer
);
137 return_buffer
->pointer
= NULL
;
140 return_buffer
->length
= 0;
141 return_ACPI_STATUS(AE_TYPE
);
144 ACPI_EXPORT_SYMBOL(acpi_evaluate_object_typed
)
145 #endif /* ACPI_FUTURE_USAGE */
147 /*******************************************************************************
149 * FUNCTION: acpi_evaluate_object
151 * PARAMETERS: Handle - Object handle (optional)
152 * Pathname - Object pathname (optional)
153 * external_params - List of parameters to pass to method,
154 * terminated by NULL. May be NULL
155 * if no parameters are being passed.
156 * return_buffer - Where to put method's return value (if
157 * any). If NULL, no value is returned.
161 * DESCRIPTION: Find and evaluate the given object, passing the given
162 * parameters if necessary. One of "Handle" or "Pathname" must
163 * be valid (non-null)
165 ******************************************************************************/
167 acpi_evaluate_object(acpi_handle handle
,
168 acpi_string pathname
,
169 struct acpi_object_list
*external_params
,
170 struct acpi_buffer
*return_buffer
)
174 struct acpi_evaluate_info
*info
;
175 acpi_size buffer_space_needed
;
178 ACPI_FUNCTION_TRACE(acpi_evaluate_object
);
180 /* Allocate and initialize the evaluation information block */
182 info
= ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info
));
184 return_ACPI_STATUS(AE_NO_MEMORY
);
187 info
->pathname
= pathname
;
188 info
->parameter_type
= ACPI_PARAM_ARGS
;
190 /* Convert and validate the device handle */
192 info
->prefix_node
= acpi_ns_map_handle_to_node(handle
);
193 if (!info
->prefix_node
) {
194 status
= AE_BAD_PARAMETER
;
199 * If there are parameters to be passed to a control method, the external
200 * objects must all be converted to internal objects
202 if (external_params
&& external_params
->count
) {
204 * Allocate a new parameter block for the internal objects
205 * Add 1 to count to allow for null terminated internal list
207 info
->parameters
= ACPI_ALLOCATE_ZEROED(((acpi_size
)
210 1) * sizeof(void *));
211 if (!info
->parameters
) {
212 status
= AE_NO_MEMORY
;
216 /* Convert each external object in the list to an internal object */
218 for (i
= 0; i
< external_params
->count
; i
++) {
220 acpi_ut_copy_eobject_to_iobject(&external_params
->
224 if (ACPI_FAILURE(status
)) {
228 info
->parameters
[external_params
->count
] = NULL
;
233 * 1) Fully qualified pathname
234 * 2) No handle, not fully qualified pathname (error)
237 if ((pathname
) && (acpi_ns_valid_root_prefix(pathname
[0]))) {
239 /* The path is fully qualified, just evaluate by name */
241 info
->prefix_node
= NULL
;
242 status
= acpi_ns_evaluate(info
);
243 } else if (!handle
) {
245 * A handle is optional iff a fully qualified pathname is specified.
246 * Since we've already handled fully qualified names above, this is
250 ACPI_DEBUG_PRINT((ACPI_DB_INFO
,
251 "Both Handle and Pathname are NULL"));
253 ACPI_DEBUG_PRINT((ACPI_DB_INFO
,
254 "Null Handle with relative pathname [%s]",
258 status
= AE_BAD_PARAMETER
;
260 /* We have a namespace a node and a possible relative path */
262 status
= acpi_ns_evaluate(info
);
266 * If we are expecting a return value, and all went well above,
267 * copy the return value to an external object.
270 if (!info
->return_object
) {
271 return_buffer
->length
= 0;
273 if (ACPI_GET_DESCRIPTOR_TYPE(info
->return_object
) ==
274 ACPI_DESC_TYPE_NAMED
) {
276 * If we received a NS Node as a return object, this means that
277 * the object we are evaluating has nothing interesting to
278 * return (such as a mutex, etc.) We return an error because
279 * these types are essentially unsupported by this interface.
280 * We don't check up front because this makes it easier to add
281 * support for various types at a later date if necessary.
284 info
->return_object
= NULL
; /* No need to delete a NS Node */
285 return_buffer
->length
= 0;
288 if (ACPI_SUCCESS(status
)) {
290 /* Get the size of the returned object */
293 acpi_ut_get_object_size(info
->return_object
,
294 &buffer_space_needed
);
295 if (ACPI_SUCCESS(status
)) {
297 /* Validate/Allocate/Clear caller buffer */
300 acpi_ut_initialize_buffer
302 buffer_space_needed
);
303 if (ACPI_FAILURE(status
)) {
305 * Caller's buffer is too small or a new one can't
308 ACPI_DEBUG_PRINT((ACPI_DB_INFO
,
309 "Needed buffer size %X, %s\n",
312 acpi_format_exception
315 /* We have enough space for the object, build it */
318 acpi_ut_copy_iobject_to_eobject
319 (info
->return_object
,
327 if (info
->return_object
) {
329 * Delete the internal return object. NOTE: Interpreter must be
330 * locked to avoid race condition.
332 status2
= acpi_ex_enter_interpreter();
333 if (ACPI_SUCCESS(status2
)) {
335 /* Remove one reference on the return object (should delete it) */
337 acpi_ut_remove_reference(info
->return_object
);
338 acpi_ex_exit_interpreter();
344 /* Free the input parameter list (if we created one) */
346 if (info
->parameters
) {
348 /* Free the allocated parameter block */
350 acpi_ut_delete_internal_object_list(info
->parameters
);
354 return_ACPI_STATUS(status
);
357 ACPI_EXPORT_SYMBOL(acpi_evaluate_object
)
359 /*******************************************************************************
361 * FUNCTION: acpi_walk_namespace
363 * PARAMETERS: Type - acpi_object_type to search for
364 * start_object - Handle in namespace where search begins
365 * max_depth - Depth to which search is to reach
366 * user_function - Called when an object of "Type" is found
367 * Context - Passed to user function
368 * return_value - Location where return value of
369 * user_function is put if terminated early
371 * RETURNS Return value from the user_function if terminated early.
372 * Otherwise, returns NULL.
374 * DESCRIPTION: Performs a modified depth-first walk of the namespace tree,
375 * starting (and ending) at the object specified by start_handle.
376 * The user_function is called whenever an object that matches
377 * the type parameter is found. If the user function returns
378 * a non-zero value, the search is terminated immediately and this
379 * value is returned to the caller.
381 * The point of this procedure is to provide a generic namespace
382 * walk routine that can be called from multiple places to
383 * provide multiple services; the User Function can be tailored
384 * to each task, whether it is a print function, a compare
387 ******************************************************************************/
389 acpi_walk_namespace(acpi_object_type type
,
390 acpi_handle start_object
,
392 acpi_walk_callback user_function
,
393 void *context
, void **return_value
)
397 ACPI_FUNCTION_TRACE(acpi_walk_namespace
);
399 /* Parameter validation */
401 if ((type
> ACPI_TYPE_LOCAL_MAX
) || (!max_depth
) || (!user_function
)) {
402 return_ACPI_STATUS(AE_BAD_PARAMETER
);
406 * Lock the namespace around the walk.
407 * The namespace will be unlocked/locked around each call
408 * to the user function - since this function
409 * must be allowed to make Acpi calls itself.
411 status
= acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE
);
412 if (ACPI_FAILURE(status
)) {
413 return_ACPI_STATUS(status
);
416 status
= acpi_ns_walk_namespace(type
, start_object
, max_depth
,
418 user_function
, context
, return_value
);
420 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE
);
421 return_ACPI_STATUS(status
);
424 ACPI_EXPORT_SYMBOL(acpi_walk_namespace
)
426 /*******************************************************************************
428 * FUNCTION: acpi_ns_get_device_callback
430 * PARAMETERS: Callback from acpi_get_device
434 * DESCRIPTION: Takes callbacks from walk_namespace and filters out all non-
435 * present devices, or if they specified a HID, it filters based
438 ******************************************************************************/
440 acpi_ns_get_device_callback(acpi_handle obj_handle
,
442 void *context
, void **return_value
)
444 struct acpi_get_devices_info
*info
= context
;
446 struct acpi_namespace_node
*node
;
448 struct acpi_device_id hid
;
449 struct acpi_compatible_id_list
*cid
;
452 status
= acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE
);
453 if (ACPI_FAILURE(status
)) {
457 node
= acpi_ns_map_handle_to_node(obj_handle
);
458 status
= acpi_ut_release_mutex(ACPI_MTX_NAMESPACE
);
459 if (ACPI_FAILURE(status
)) {
464 return (AE_BAD_PARAMETER
);
467 /* Run _STA to determine if device is present */
469 status
= acpi_ut_execute_STA(node
, &flags
);
470 if (ACPI_FAILURE(status
)) {
471 return (AE_CTRL_DEPTH
);
474 if (!(flags
& ACPI_STA_DEVICE_PRESENT
)) {
476 /* Don't examine children of the device if not present */
478 return (AE_CTRL_DEPTH
);
481 /* Filter based on device HID & CID */
483 if (info
->hid
!= NULL
) {
484 status
= acpi_ut_execute_HID(node
, &hid
);
485 if (status
== AE_NOT_FOUND
) {
487 } else if (ACPI_FAILURE(status
)) {
488 return (AE_CTRL_DEPTH
);
491 if (ACPI_STRNCMP(hid
.value
, info
->hid
, sizeof(hid
.value
)) != 0) {
493 /* Get the list of Compatible IDs */
495 status
= acpi_ut_execute_CID(node
, &cid
);
496 if (status
== AE_NOT_FOUND
) {
498 } else if (ACPI_FAILURE(status
)) {
499 return (AE_CTRL_DEPTH
);
502 /* Walk the CID list */
504 for (i
= 0; i
< cid
->count
; i
++) {
505 if (ACPI_STRNCMP(cid
->id
[i
].value
, info
->hid
,
507 acpi_compatible_id
)) !=
517 status
= info
->user_function(obj_handle
, nesting_level
, info
->context
,
522 /*******************************************************************************
524 * FUNCTION: acpi_get_devices
526 * PARAMETERS: HID - HID to search for. Can be NULL.
527 * user_function - Called when a matching object is found
528 * Context - Passed to user function
529 * return_value - Location where return value of
530 * user_function is put if terminated early
532 * RETURNS Return value from the user_function if terminated early.
533 * Otherwise, returns NULL.
535 * DESCRIPTION: Performs a modified depth-first walk of the namespace tree,
536 * starting (and ending) at the object specified by start_handle.
537 * The user_function is called whenever an object of type
538 * Device is found. If the user function returns
539 * a non-zero value, the search is terminated immediately and this
540 * value is returned to the caller.
542 * This is a wrapper for walk_namespace, but the callback performs
543 * additional filtering. Please see acpi_get_device_callback.
545 ******************************************************************************/
548 acpi_get_devices(char *HID
,
549 acpi_walk_callback user_function
,
550 void *context
, void **return_value
)
553 struct acpi_get_devices_info info
;
555 ACPI_FUNCTION_TRACE(acpi_get_devices
);
557 /* Parameter validation */
559 if (!user_function
) {
560 return_ACPI_STATUS(AE_BAD_PARAMETER
);
564 * We're going to call their callback from OUR callback, so we need
565 * to know what it is, and their context parameter.
568 info
.context
= context
;
569 info
.user_function
= user_function
;
572 * Lock the namespace around the walk.
573 * The namespace will be unlocked/locked around each call
574 * to the user function - since this function
575 * must be allowed to make Acpi calls itself.
577 status
= acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE
);
578 if (ACPI_FAILURE(status
)) {
579 return_ACPI_STATUS(status
);
582 status
= acpi_ns_walk_namespace(ACPI_TYPE_DEVICE
, ACPI_ROOT_OBJECT
,
583 ACPI_UINT32_MAX
, ACPI_NS_WALK_UNLOCK
,
584 acpi_ns_get_device_callback
, &info
,
587 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE
);
588 return_ACPI_STATUS(status
);
591 ACPI_EXPORT_SYMBOL(acpi_get_devices
)
593 /*******************************************************************************
595 * FUNCTION: acpi_attach_data
597 * PARAMETERS: obj_handle - Namespace node
598 * Handler - Handler for this attachment
599 * Data - Pointer to data to be attached
603 * DESCRIPTION: Attach arbitrary data and handler to a namespace node.
605 ******************************************************************************/
607 acpi_attach_data(acpi_handle obj_handle
,
608 acpi_object_handler handler
, void *data
)
610 struct acpi_namespace_node
*node
;
613 /* Parameter validation */
615 if (!obj_handle
|| !handler
|| !data
) {
616 return (AE_BAD_PARAMETER
);
619 status
= acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE
);
620 if (ACPI_FAILURE(status
)) {
624 /* Convert and validate the handle */
626 node
= acpi_ns_map_handle_to_node(obj_handle
);
628 status
= AE_BAD_PARAMETER
;
629 goto unlock_and_exit
;
632 status
= acpi_ns_attach_data(node
, handler
, data
);
635 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE
);
639 ACPI_EXPORT_SYMBOL(acpi_attach_data
)
641 /*******************************************************************************
643 * FUNCTION: acpi_detach_data
645 * PARAMETERS: obj_handle - Namespace node handle
646 * Handler - Handler used in call to acpi_attach_data
650 * DESCRIPTION: Remove data that was previously attached to a node.
652 ******************************************************************************/
654 acpi_detach_data(acpi_handle obj_handle
, acpi_object_handler handler
)
656 struct acpi_namespace_node
*node
;
659 /* Parameter validation */
661 if (!obj_handle
|| !handler
) {
662 return (AE_BAD_PARAMETER
);
665 status
= acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE
);
666 if (ACPI_FAILURE(status
)) {
670 /* Convert and validate the handle */
672 node
= acpi_ns_map_handle_to_node(obj_handle
);
674 status
= AE_BAD_PARAMETER
;
675 goto unlock_and_exit
;
678 status
= acpi_ns_detach_data(node
, handler
);
681 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE
);
685 ACPI_EXPORT_SYMBOL(acpi_detach_data
)
687 /*******************************************************************************
689 * FUNCTION: acpi_get_data
691 * PARAMETERS: obj_handle - Namespace node
692 * Handler - Handler used in call to attach_data
693 * Data - Where the data is returned
697 * DESCRIPTION: Retrieve data that was previously attached to a namespace node.
699 ******************************************************************************/
701 acpi_get_data(acpi_handle obj_handle
, acpi_object_handler handler
, void **data
)
703 struct acpi_namespace_node
*node
;
706 /* Parameter validation */
708 if (!obj_handle
|| !handler
|| !data
) {
709 return (AE_BAD_PARAMETER
);
712 status
= acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE
);
713 if (ACPI_FAILURE(status
)) {
717 /* Convert and validate the handle */
719 node
= acpi_ns_map_handle_to_node(obj_handle
);
721 status
= AE_BAD_PARAMETER
;
722 goto unlock_and_exit
;
725 status
= acpi_ns_get_attached_data(node
, handler
, data
);
728 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE
);
732 ACPI_EXPORT_SYMBOL(acpi_get_data
)