1 /*******************************************************************************
3 * Module Name: nsxfeval - Public interfaces to the ACPI subsystem
4 * ACPI Object evaluation interfaces
6 ******************************************************************************/
9 * Copyright (C) 2000 - 2008, Intel Corp.
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>
50 #define _COMPONENT ACPI_NAMESPACE
51 ACPI_MODULE_NAME("nsxfeval")
53 /* Local prototypes */
54 static void acpi_ns_resolve_references(struct acpi_evaluate_info
*info
);
56 #ifdef ACPI_FUTURE_USAGE
57 /*******************************************************************************
59 * FUNCTION: acpi_evaluate_object_typed
61 * PARAMETERS: Handle - Object handle (optional)
62 * Pathname - Object pathname (optional)
63 * external_params - List of parameters to pass to method,
64 * terminated by NULL. May be NULL
65 * if no parameters are being passed.
66 * return_buffer - Where to put method's return value (if
67 * any). If NULL, no value is returned.
68 * return_type - Expected type of return object
72 * DESCRIPTION: Find and evaluate the given object, passing the given
73 * parameters if necessary. One of "Handle" or "Pathname" must
76 ******************************************************************************/
79 acpi_evaluate_object_typed(acpi_handle handle
,
81 struct acpi_object_list
*external_params
,
82 struct acpi_buffer
*return_buffer
,
83 acpi_object_type return_type
)
88 ACPI_FUNCTION_TRACE(acpi_evaluate_object_typed
);
90 /* Return buffer must be valid */
93 return_ACPI_STATUS(AE_BAD_PARAMETER
);
96 if (return_buffer
->length
== ACPI_ALLOCATE_BUFFER
) {
100 /* Evaluate the object */
103 acpi_evaluate_object(handle
, pathname
, external_params
,
105 if (ACPI_FAILURE(status
)) {
106 return_ACPI_STATUS(status
);
109 /* Type ANY means "don't care" */
111 if (return_type
== ACPI_TYPE_ANY
) {
112 return_ACPI_STATUS(AE_OK
);
115 if (return_buffer
->length
== 0) {
117 /* Error because caller specifically asked for a return value */
119 ACPI_ERROR((AE_INFO
, "No return value"));
120 return_ACPI_STATUS(AE_NULL_OBJECT
);
123 /* Examine the object type returned from evaluate_object */
125 if (((union acpi_object
*)return_buffer
->pointer
)->type
== return_type
) {
126 return_ACPI_STATUS(AE_OK
);
129 /* Return object type does not match requested type */
132 "Incorrect return type [%s] requested [%s]",
133 acpi_ut_get_type_name(((union acpi_object
*)return_buffer
->
135 acpi_ut_get_type_name(return_type
)));
139 /* Caller used ACPI_ALLOCATE_BUFFER, free the return buffer */
141 ACPI_FREE(return_buffer
->pointer
);
142 return_buffer
->pointer
= NULL
;
145 return_buffer
->length
= 0;
146 return_ACPI_STATUS(AE_TYPE
);
149 ACPI_EXPORT_SYMBOL(acpi_evaluate_object_typed
)
150 #endif /* ACPI_FUTURE_USAGE */
151 /*******************************************************************************
153 * FUNCTION: acpi_evaluate_object
155 * PARAMETERS: Handle - Object handle (optional)
156 * Pathname - Object pathname (optional)
157 * external_params - List of parameters to pass to method,
158 * terminated by NULL. May be NULL
159 * if no parameters are being passed.
160 * return_buffer - Where to put method's return value (if
161 * any). If NULL, no value is returned.
165 * DESCRIPTION: Find and evaluate the given object, passing the given
166 * parameters if necessary. One of "Handle" or "Pathname" must
167 * be valid (non-null)
169 ******************************************************************************/
171 acpi_evaluate_object(acpi_handle handle
,
172 acpi_string pathname
,
173 struct acpi_object_list
*external_params
,
174 struct acpi_buffer
*return_buffer
)
177 struct acpi_evaluate_info
*info
;
178 acpi_size buffer_space_needed
;
181 ACPI_FUNCTION_TRACE(acpi_evaluate_object
);
183 /* Allocate and initialize the evaluation information block */
185 info
= ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info
));
187 return_ACPI_STATUS(AE_NO_MEMORY
);
190 info
->pathname
= pathname
;
192 /* Convert and validate the device handle */
194 info
->prefix_node
= acpi_ns_map_handle_to_node(handle
);
195 if (!info
->prefix_node
) {
196 status
= AE_BAD_PARAMETER
;
201 * If there are parameters to be passed to a control method, the external
202 * objects must all be converted to internal objects
204 if (external_params
&& external_params
->count
) {
206 * Allocate a new parameter block for the internal objects
207 * Add 1 to count to allow for null terminated internal list
209 info
->parameters
= ACPI_ALLOCATE_ZEROED(((acpi_size
)
212 1) * sizeof(void *));
213 if (!info
->parameters
) {
214 status
= AE_NO_MEMORY
;
218 /* Convert each external object in the list to an internal object */
220 for (i
= 0; i
< external_params
->count
; i
++) {
222 acpi_ut_copy_eobject_to_iobject(&external_params
->
226 if (ACPI_FAILURE(status
)) {
230 info
->parameters
[external_params
->count
] = NULL
;
235 * 1) Fully qualified pathname
236 * 2) No handle, not fully qualified pathname (error)
239 if ((pathname
) && (acpi_ns_valid_root_prefix(pathname
[0]))) {
241 /* The path is fully qualified, just evaluate by name */
243 info
->prefix_node
= NULL
;
244 status
= acpi_ns_evaluate(info
);
245 } else if (!handle
) {
247 * A handle is optional iff a fully qualified pathname is specified.
248 * Since we've already handled fully qualified names above, this is
252 ACPI_DEBUG_PRINT((ACPI_DB_INFO
,
253 "Both Handle and Pathname are NULL"));
255 ACPI_DEBUG_PRINT((ACPI_DB_INFO
,
256 "Null Handle with relative pathname [%s]",
260 status
= AE_BAD_PARAMETER
;
262 /* We have a namespace a node and a possible relative path */
264 status
= acpi_ns_evaluate(info
);
268 * If we are expecting a return value, and all went well above,
269 * copy the return value to an external object.
272 if (!info
->return_object
) {
273 return_buffer
->length
= 0;
275 if (ACPI_GET_DESCRIPTOR_TYPE(info
->return_object
) ==
276 ACPI_DESC_TYPE_NAMED
) {
278 * If we received a NS Node as a return object, this means that
279 * the object we are evaluating has nothing interesting to
280 * return (such as a mutex, etc.) We return an error because
281 * these types are essentially unsupported by this interface.
282 * We don't check up front because this makes it easier to add
283 * support for various types at a later date if necessary.
286 info
->return_object
= NULL
; /* No need to delete a NS Node */
287 return_buffer
->length
= 0;
290 if (ACPI_SUCCESS(status
)) {
292 /* Dereference Index and ref_of references */
294 acpi_ns_resolve_references(info
);
296 /* Get the size of the returned object */
299 acpi_ut_get_object_size(info
->return_object
,
300 &buffer_space_needed
);
301 if (ACPI_SUCCESS(status
)) {
303 /* Validate/Allocate/Clear caller buffer */
306 acpi_ut_initialize_buffer
308 buffer_space_needed
);
309 if (ACPI_FAILURE(status
)) {
311 * Caller's buffer is too small or a new one can't
314 ACPI_DEBUG_PRINT((ACPI_DB_INFO
,
315 "Needed buffer size %X, %s\n",
318 acpi_format_exception
321 /* We have enough space for the object, build it */
324 acpi_ut_copy_iobject_to_eobject
325 (info
->return_object
,
333 if (info
->return_object
) {
335 * Delete the internal return object. NOTE: Interpreter must be
336 * locked to avoid race condition.
338 acpi_ex_enter_interpreter();
340 /* Remove one reference on the return object (should delete it) */
342 acpi_ut_remove_reference(info
->return_object
);
343 acpi_ex_exit_interpreter();
348 /* Free the input parameter list (if we created one) */
350 if (info
->parameters
) {
352 /* Free the allocated parameter block */
354 acpi_ut_delete_internal_object_list(info
->parameters
);
358 return_ACPI_STATUS(status
);
361 ACPI_EXPORT_SYMBOL(acpi_evaluate_object
)
363 /*******************************************************************************
365 * FUNCTION: acpi_ns_resolve_references
367 * PARAMETERS: Info - Evaluation info block
369 * RETURN: Info->return_object is replaced with the dereferenced object
371 * DESCRIPTION: Dereference certain reference objects. Called before an
372 * internal return object is converted to an external union acpi_object.
374 * Performs an automatic dereference of Index and ref_of reference objects.
375 * These reference objects are not supported by the union acpi_object, so this is a
376 * last resort effort to return something useful. Also, provides compatibility
377 * with other ACPI implementations.
379 * NOTE: does not handle references within returned package objects or nested
380 * references, but this support could be added later if found to be necessary.
382 ******************************************************************************/
383 static void acpi_ns_resolve_references(struct acpi_evaluate_info
*info
)
385 union acpi_operand_object
*obj_desc
= NULL
;
386 struct acpi_namespace_node
*node
;
388 /* We are interested in reference objects only */
390 if (ACPI_GET_OBJECT_TYPE(info
->return_object
) !=
391 ACPI_TYPE_LOCAL_REFERENCE
) {
396 * Two types of references are supported - those created by Index and
397 * ref_of operators. A name reference (AML_NAMEPATH_OP) can be converted
398 * to an union acpi_object, so it is not dereferenced here. A ddb_handle
399 * (AML_LOAD_OP) cannot be dereferenced, nor can it be converted to
400 * an union acpi_object.
402 switch (info
->return_object
->reference
.class) {
403 case ACPI_REFCLASS_INDEX
:
405 obj_desc
= *(info
->return_object
->reference
.where
);
408 case ACPI_REFCLASS_REFOF
:
410 node
= info
->return_object
->reference
.object
;
412 obj_desc
= node
->object
;
420 /* Replace the existing reference object */
423 acpi_ut_add_reference(obj_desc
);
424 acpi_ut_remove_reference(info
->return_object
);
425 info
->return_object
= obj_desc
;
431 /*******************************************************************************
433 * FUNCTION: acpi_walk_namespace
435 * PARAMETERS: Type - acpi_object_type to search for
436 * start_object - Handle in namespace where search begins
437 * max_depth - Depth to which search is to reach
438 * user_function - Called when an object of "Type" is found
439 * Context - Passed to user function
440 * return_value - Location where return value of
441 * user_function is put if terminated early
443 * RETURNS Return value from the user_function if terminated early.
444 * Otherwise, returns NULL.
446 * DESCRIPTION: Performs a modified depth-first walk of the namespace tree,
447 * starting (and ending) at the object specified by start_handle.
448 * The user_function is called whenever an object that matches
449 * the type parameter is found. If the user function returns
450 * a non-zero value, the search is terminated immediately and this
451 * value is returned to the caller.
453 * The point of this procedure is to provide a generic namespace
454 * walk routine that can be called from multiple places to
455 * provide multiple services; the User Function can be tailored
456 * to each task, whether it is a print function, a compare
459 ******************************************************************************/
462 acpi_walk_namespace(acpi_object_type type
,
463 acpi_handle start_object
,
465 acpi_walk_callback user_function
,
466 void *context
, void **return_value
)
470 ACPI_FUNCTION_TRACE(acpi_walk_namespace
);
473 return_ACPI_STATUS(AE_NO_NAMESPACE
);
475 /* Parameter validation */
477 if ((type
> ACPI_TYPE_LOCAL_MAX
) || (!max_depth
) || (!user_function
)) {
478 return_ACPI_STATUS(AE_BAD_PARAMETER
);
482 * Lock the namespace around the walk.
483 * The namespace will be unlocked/locked around each call
484 * to the user function - since this function
485 * must be allowed to make Acpi calls itself.
487 status
= acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE
);
488 if (ACPI_FAILURE(status
)) {
489 return_ACPI_STATUS(status
);
492 status
= acpi_ns_walk_namespace(type
, start_object
, max_depth
,
494 user_function
, context
, return_value
);
496 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE
);
497 return_ACPI_STATUS(status
);
500 ACPI_EXPORT_SYMBOL(acpi_walk_namespace
)
502 /*******************************************************************************
504 * FUNCTION: acpi_ns_get_device_callback
506 * PARAMETERS: Callback from acpi_get_device
510 * DESCRIPTION: Takes callbacks from walk_namespace and filters out all non-
511 * present devices, or if they specified a HID, it filters based
514 ******************************************************************************/
516 acpi_ns_get_device_callback(acpi_handle obj_handle
,
518 void *context
, void **return_value
)
520 struct acpi_get_devices_info
*info
= context
;
522 struct acpi_namespace_node
*node
;
524 struct acpica_device_id hid
;
525 struct acpi_compatible_id_list
*cid
;
529 status
= acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE
);
530 if (ACPI_FAILURE(status
)) {
534 node
= acpi_ns_map_handle_to_node(obj_handle
);
535 status
= acpi_ut_release_mutex(ACPI_MTX_NAMESPACE
);
536 if (ACPI_FAILURE(status
)) {
541 return (AE_BAD_PARAMETER
);
544 /* Run _STA to determine if device is present */
546 status
= acpi_ut_execute_STA(node
, &flags
);
547 if (ACPI_FAILURE(status
)) {
548 return (AE_CTRL_DEPTH
);
551 if (!(flags
& ACPI_STA_DEVICE_PRESENT
) &&
552 !(flags
& ACPI_STA_DEVICE_FUNCTIONING
)) {
554 * Don't examine the children of the device only when the
555 * device is neither present nor functional. See ACPI spec,
556 * description of _STA for more information.
558 return (AE_CTRL_DEPTH
);
561 /* Filter based on device HID & CID */
563 if (info
->hid
!= NULL
) {
564 status
= acpi_ut_execute_HID(node
, &hid
);
565 if (status
== AE_NOT_FOUND
) {
567 } else if (ACPI_FAILURE(status
)) {
568 return (AE_CTRL_DEPTH
);
571 if (ACPI_STRNCMP(hid
.value
, info
->hid
, sizeof(hid
.value
)) != 0) {
573 /* Get the list of Compatible IDs */
575 status
= acpi_ut_execute_CID(node
, &cid
);
576 if (status
== AE_NOT_FOUND
) {
578 } else if (ACPI_FAILURE(status
)) {
579 return (AE_CTRL_DEPTH
);
582 /* Walk the CID list */
585 for (i
= 0; i
< cid
->count
; i
++) {
586 if (ACPI_STRNCMP(cid
->id
[i
].value
, info
->hid
,
588 acpi_compatible_id
)) ==
600 status
= info
->user_function(obj_handle
, nesting_level
, info
->context
,
605 /*******************************************************************************
607 * FUNCTION: acpi_get_devices
609 * PARAMETERS: HID - HID to search for. Can be NULL.
610 * user_function - Called when a matching object is found
611 * Context - Passed to user function
612 * return_value - Location where return value of
613 * user_function is put if terminated early
615 * RETURNS Return value from the user_function if terminated early.
616 * Otherwise, returns NULL.
618 * DESCRIPTION: Performs a modified depth-first walk of the namespace tree,
619 * starting (and ending) at the object specified by start_handle.
620 * The user_function is called whenever an object of type
621 * Device is found. If the user function returns
622 * a non-zero value, the search is terminated immediately and this
623 * value is returned to the caller.
625 * This is a wrapper for walk_namespace, but the callback performs
626 * additional filtering. Please see acpi_ns_get_device_callback.
628 ******************************************************************************/
631 acpi_get_devices(const char *HID
,
632 acpi_walk_callback user_function
,
633 void *context
, void **return_value
)
636 struct acpi_get_devices_info info
;
638 ACPI_FUNCTION_TRACE(acpi_get_devices
);
640 /* Parameter validation */
642 if (!user_function
) {
643 return_ACPI_STATUS(AE_BAD_PARAMETER
);
647 * We're going to call their callback from OUR callback, so we need
648 * to know what it is, and their context parameter.
651 info
.context
= context
;
652 info
.user_function
= user_function
;
655 * Lock the namespace around the walk.
656 * The namespace will be unlocked/locked around each call
657 * to the user function - since this function
658 * must be allowed to make Acpi calls itself.
660 status
= acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE
);
661 if (ACPI_FAILURE(status
)) {
662 return_ACPI_STATUS(status
);
665 status
= acpi_ns_walk_namespace(ACPI_TYPE_DEVICE
, ACPI_ROOT_OBJECT
,
666 ACPI_UINT32_MAX
, ACPI_NS_WALK_UNLOCK
,
667 acpi_ns_get_device_callback
, &info
,
670 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE
);
671 return_ACPI_STATUS(status
);
674 ACPI_EXPORT_SYMBOL(acpi_get_devices
)
676 /*******************************************************************************
678 * FUNCTION: acpi_attach_data
680 * PARAMETERS: obj_handle - Namespace node
681 * Handler - Handler for this attachment
682 * Data - Pointer to data to be attached
686 * DESCRIPTION: Attach arbitrary data and handler to a namespace node.
688 ******************************************************************************/
690 acpi_attach_data(acpi_handle obj_handle
,
691 acpi_object_handler handler
, void *data
)
693 struct acpi_namespace_node
*node
;
696 /* Parameter validation */
698 if (!obj_handle
|| !handler
|| !data
) {
699 return (AE_BAD_PARAMETER
);
702 status
= acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE
);
703 if (ACPI_FAILURE(status
)) {
707 /* Convert and validate the handle */
709 node
= acpi_ns_map_handle_to_node(obj_handle
);
711 status
= AE_BAD_PARAMETER
;
712 goto unlock_and_exit
;
715 status
= acpi_ns_attach_data(node
, handler
, data
);
718 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE
);
722 ACPI_EXPORT_SYMBOL(acpi_attach_data
)
724 /*******************************************************************************
726 * FUNCTION: acpi_detach_data
728 * PARAMETERS: obj_handle - Namespace node handle
729 * Handler - Handler used in call to acpi_attach_data
733 * DESCRIPTION: Remove data that was previously attached to a node.
735 ******************************************************************************/
737 acpi_detach_data(acpi_handle obj_handle
, acpi_object_handler handler
)
739 struct acpi_namespace_node
*node
;
742 /* Parameter validation */
744 if (!obj_handle
|| !handler
) {
745 return (AE_BAD_PARAMETER
);
748 status
= acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE
);
749 if (ACPI_FAILURE(status
)) {
753 /* Convert and validate the handle */
755 node
= acpi_ns_map_handle_to_node(obj_handle
);
757 status
= AE_BAD_PARAMETER
;
758 goto unlock_and_exit
;
761 status
= acpi_ns_detach_data(node
, handler
);
764 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE
);
768 ACPI_EXPORT_SYMBOL(acpi_detach_data
)
770 /*******************************************************************************
772 * FUNCTION: acpi_get_data
774 * PARAMETERS: obj_handle - Namespace node
775 * Handler - Handler used in call to attach_data
776 * Data - Where the data is returned
780 * DESCRIPTION: Retrieve data that was previously attached to a namespace node.
782 ******************************************************************************/
784 acpi_get_data(acpi_handle obj_handle
, acpi_object_handler handler
, void **data
)
786 struct acpi_namespace_node
*node
;
789 /* Parameter validation */
791 if (!obj_handle
|| !handler
|| !data
) {
792 return (AE_BAD_PARAMETER
);
795 status
= acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE
);
796 if (ACPI_FAILURE(status
)) {
800 /* Convert and validate the handle */
802 node
= acpi_ns_map_handle_to_node(obj_handle
);
804 status
= AE_BAD_PARAMETER
;
805 goto unlock_and_exit
;
808 status
= acpi_ns_get_attached_data(node
, handler
, data
);
811 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE
);
815 ACPI_EXPORT_SYMBOL(acpi_get_data
)