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>
46 #include <acpi/acnamesp.h>
47 #include <acpi/acinterp.h>
49 #define _COMPONENT ACPI_NAMESPACE
50 ACPI_MODULE_NAME("nsxfeval")
52 /* Local prototypes */
53 static void acpi_ns_resolve_references(struct acpi_evaluate_info *info);
55 #ifdef ACPI_FUTURE_USAGE
56 /*******************************************************************************
58 * FUNCTION: acpi_evaluate_object_typed
60 * PARAMETERS: Handle - Object handle (optional)
61 * Pathname - Object pathname (optional)
62 * external_params - List of parameters to pass to method,
63 * terminated by NULL. May be NULL
64 * if no parameters are being passed.
65 * return_buffer - Where to put method's return value (if
66 * any). If NULL, no value is returned.
67 * return_type - Expected type of return object
71 * DESCRIPTION: Find and evaluate the given object, passing the given
72 * parameters if necessary. One of "Handle" or "Pathname" must
75 ******************************************************************************/
78 acpi_evaluate_object_typed(acpi_handle handle,
80 struct acpi_object_list *external_params,
81 struct acpi_buffer *return_buffer,
82 acpi_object_type return_type)
87 ACPI_FUNCTION_TRACE(acpi_evaluate_object_typed);
89 /* Return buffer must be valid */
92 return_ACPI_STATUS(AE_BAD_PARAMETER);
95 if (return_buffer->length == ACPI_ALLOCATE_BUFFER) {
99 /* Evaluate the object */
102 acpi_evaluate_object(handle, pathname, external_params,
104 if (ACPI_FAILURE(status)) {
105 return_ACPI_STATUS(status);
108 /* Type ANY means "don't care" */
110 if (return_type == ACPI_TYPE_ANY) {
111 return_ACPI_STATUS(AE_OK);
114 if (return_buffer->length == 0) {
116 /* Error because caller specifically asked for a return value */
118 ACPI_ERROR((AE_INFO, "No return value"));
119 return_ACPI_STATUS(AE_NULL_OBJECT);
122 /* Examine the object type returned from evaluate_object */
124 if (((union acpi_object *)return_buffer->pointer)->type == return_type) {
125 return_ACPI_STATUS(AE_OK);
128 /* Return object type does not match requested type */
131 "Incorrect return type [%s] requested [%s]",
132 acpi_ut_get_type_name(((union acpi_object *)return_buffer->
134 acpi_ut_get_type_name(return_type)));
138 /* Caller used ACPI_ALLOCATE_BUFFER, free the return buffer */
140 ACPI_FREE(return_buffer->pointer);
141 return_buffer->pointer = NULL;
144 return_buffer->length = 0;
145 return_ACPI_STATUS(AE_TYPE);
148 ACPI_EXPORT_SYMBOL(acpi_evaluate_object_typed)
149 #endif /* ACPI_FUTURE_USAGE */
150 /*******************************************************************************
152 * FUNCTION: acpi_evaluate_object
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.
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)
168 ******************************************************************************/
170 acpi_evaluate_object(acpi_handle handle,
171 acpi_string pathname,
172 struct acpi_object_list *external_params,
173 struct acpi_buffer *return_buffer)
176 struct acpi_evaluate_info *info;
177 acpi_size buffer_space_needed;
180 ACPI_FUNCTION_TRACE(acpi_evaluate_object);
182 /* Allocate and initialize the evaluation information block */
184 info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
186 return_ACPI_STATUS(AE_NO_MEMORY);
189 info->pathname = pathname;
191 /* Convert and validate the device handle */
193 info->prefix_node = acpi_ns_map_handle_to_node(handle);
194 if (!info->prefix_node) {
195 status = AE_BAD_PARAMETER;
200 * If there are parameters to be passed to a control method, the external
201 * objects must all be converted to internal objects
203 if (external_params && external_params->count) {
205 * Allocate a new parameter block for the internal objects
206 * Add 1 to count to allow for null terminated internal list
208 info->parameters = ACPI_ALLOCATE_ZEROED(((acpi_size)
211 1) * sizeof(void *));
212 if (!info->parameters) {
213 status = AE_NO_MEMORY;
217 /* Convert each external object in the list to an internal object */
219 for (i = 0; i < external_params->count; i++) {
221 acpi_ut_copy_eobject_to_iobject(&external_params->
225 if (ACPI_FAILURE(status)) {
229 info->parameters[external_params->count] = NULL;
234 * 1) Fully qualified pathname
235 * 2) No handle, not fully qualified pathname (error)
238 if ((pathname) && (acpi_ns_valid_root_prefix(pathname[0]))) {
240 /* The path is fully qualified, just evaluate by name */
242 info->prefix_node = NULL;
243 status = acpi_ns_evaluate(info);
244 } else if (!handle) {
246 * A handle is optional iff a fully qualified pathname is specified.
247 * Since we've already handled fully qualified names above, this is
251 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
252 "Both Handle and Pathname are NULL"));
254 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
255 "Null Handle with relative pathname [%s]",
259 status = AE_BAD_PARAMETER;
261 /* We have a namespace a node and a possible relative path */
263 status = acpi_ns_evaluate(info);
267 * If we are expecting a return value, and all went well above,
268 * copy the return value to an external object.
271 if (!info->return_object) {
272 return_buffer->length = 0;
274 if (ACPI_GET_DESCRIPTOR_TYPE(info->return_object) ==
275 ACPI_DESC_TYPE_NAMED) {
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.
285 info->return_object = NULL; /* No need to delete a NS Node */
286 return_buffer->length = 0;
289 if (ACPI_SUCCESS(status)) {
291 /* Dereference Index and ref_of references */
293 acpi_ns_resolve_references(info);
295 /* Get the size of the returned object */
298 acpi_ut_get_object_size(info->return_object,
299 &buffer_space_needed);
300 if (ACPI_SUCCESS(status)) {
302 /* Validate/Allocate/Clear caller buffer */
305 acpi_ut_initialize_buffer
307 buffer_space_needed);
308 if (ACPI_FAILURE(status)) {
310 * Caller's buffer is too small or a new one can't
313 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
314 "Needed buffer size %X, %s\n",
317 acpi_format_exception
320 /* We have enough space for the object, build it */
323 acpi_ut_copy_iobject_to_eobject
324 (info->return_object,
332 if (info->return_object) {
334 * Delete the internal return object. NOTE: Interpreter must be
335 * locked to avoid race condition.
337 acpi_ex_enter_interpreter();
339 /* Remove one reference on the return object (should delete it) */
341 acpi_ut_remove_reference(info->return_object);
342 acpi_ex_exit_interpreter();
347 /* Free the input parameter list (if we created one) */
349 if (info->parameters) {
351 /* Free the allocated parameter block */
353 acpi_ut_delete_internal_object_list(info->parameters);
357 return_ACPI_STATUS(status);
360 ACPI_EXPORT_SYMBOL(acpi_evaluate_object)
362 /*******************************************************************************
364 * FUNCTION: acpi_ns_resolve_references
366 * PARAMETERS: Info - Evaluation info block
368 * RETURN: Info->return_object is replaced with the dereferenced object
370 * DESCRIPTION: Dereference certain reference objects. Called before an
371 * internal return object is converted to an external union acpi_object.
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.
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.
381 ******************************************************************************/
382 static void acpi_ns_resolve_references(struct acpi_evaluate_info *info)
384 union acpi_operand_object *obj_desc = NULL;
385 struct acpi_namespace_node *node;
387 /* We are interested in reference objects only */
389 if (ACPI_GET_OBJECT_TYPE(info->return_object) !=
390 ACPI_TYPE_LOCAL_REFERENCE) {
395 * Two types of references are supported - those created by Index and
396 * ref_of operators. A name reference (AML_NAMEPATH_OP) can be converted
397 * to an union acpi_object, so it is not dereferenced here. A ddb_handle
398 * (AML_LOAD_OP) cannot be dereferenced, nor can it be converted to
399 * an union acpi_object.
401 switch (info->return_object->reference.class) {
402 case ACPI_REFCLASS_INDEX:
404 obj_desc = *(info->return_object->reference.where);
407 case ACPI_REFCLASS_REFOF:
409 node = info->return_object->reference.object;
411 obj_desc = node->object;
419 /* Replace the existing reference object */
422 acpi_ut_add_reference(obj_desc);
423 acpi_ut_remove_reference(info->return_object);
424 info->return_object = obj_desc;
430 /*******************************************************************************
432 * FUNCTION: acpi_walk_namespace
434 * PARAMETERS: Type - acpi_object_type to search for
435 * start_object - Handle in namespace where search begins
436 * max_depth - Depth to which search is to reach
437 * user_function - Called when an object of "Type" is found
438 * Context - Passed to user function
439 * return_value - Location where return value of
440 * user_function is put if terminated early
442 * RETURNS Return value from the user_function if terminated early.
443 * Otherwise, returns NULL.
445 * DESCRIPTION: Performs a modified depth-first walk of the namespace tree,
446 * starting (and ending) at the object specified by start_handle.
447 * The user_function is called whenever an object that matches
448 * the type parameter is found. If the user function returns
449 * a non-zero value, the search is terminated immediately and this
450 * value is returned to the caller.
452 * The point of this procedure is to provide a generic namespace
453 * walk routine that can be called from multiple places to
454 * provide multiple services; the User Function can be tailored
455 * to each task, whether it is a print function, a compare
458 ******************************************************************************/
461 acpi_walk_namespace(acpi_object_type type,
462 acpi_handle start_object,
464 acpi_walk_callback user_function,
465 void *context, void **return_value)
469 ACPI_FUNCTION_TRACE(acpi_walk_namespace);
471 /* Parameter validation */
473 if ((type > ACPI_TYPE_LOCAL_MAX) || (!max_depth) || (!user_function)) {
474 return_ACPI_STATUS(AE_BAD_PARAMETER);
478 * Lock the namespace around the walk.
479 * The namespace will be unlocked/locked around each call
480 * to the user function - since this function
481 * must be allowed to make Acpi calls itself.
483 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
484 if (ACPI_FAILURE(status)) {
485 return_ACPI_STATUS(status);
488 status = acpi_ns_walk_namespace(type, start_object, max_depth,
490 user_function, context, return_value);
492 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
493 return_ACPI_STATUS(status);
496 ACPI_EXPORT_SYMBOL(acpi_walk_namespace)
498 /*******************************************************************************
500 * FUNCTION: acpi_ns_get_device_callback
502 * PARAMETERS: Callback from acpi_get_device
506 * DESCRIPTION: Takes callbacks from walk_namespace and filters out all non-
507 * present devices, or if they specified a HID, it filters based
510 ******************************************************************************/
512 acpi_ns_get_device_callback(acpi_handle obj_handle,
514 void *context, void **return_value)
516 struct acpi_get_devices_info *info = context;
518 struct acpi_namespace_node *node;
520 struct acpica_device_id hid;
521 struct acpi_compatible_id_list *cid;
525 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
526 if (ACPI_FAILURE(status)) {
530 node = acpi_ns_map_handle_to_node(obj_handle);
531 status = acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
532 if (ACPI_FAILURE(status)) {
537 return (AE_BAD_PARAMETER);
540 /* Run _STA to determine if device is present */
542 status = acpi_ut_execute_STA(node, &flags);
543 if (ACPI_FAILURE(status)) {
544 return (AE_CTRL_DEPTH);
547 if (!(flags & ACPI_STA_DEVICE_PRESENT) &&
548 !(flags & ACPI_STA_DEVICE_FUNCTIONING)) {
550 * Don't examine the children of the device only when the
551 * device is neither present nor functional. See ACPI spec,
552 * description of _STA for more information.
554 return (AE_CTRL_DEPTH);
557 /* Filter based on device HID & CID */
559 if (info->hid != NULL) {
560 status = acpi_ut_execute_HID(node, &hid);
561 if (status == AE_NOT_FOUND) {
563 } else if (ACPI_FAILURE(status)) {
564 return (AE_CTRL_DEPTH);
567 if (ACPI_STRNCMP(hid.value, info->hid, sizeof(hid.value)) != 0) {
569 /* Get the list of Compatible IDs */
571 status = acpi_ut_execute_CID(node, &cid);
572 if (status == AE_NOT_FOUND) {
574 } else if (ACPI_FAILURE(status)) {
575 return (AE_CTRL_DEPTH);
578 /* Walk the CID list */
581 for (i = 0; i < cid->count; i++) {
582 if (ACPI_STRNCMP(cid->id[i].value, info->hid,
584 acpi_compatible_id)) ==
596 status = info->user_function(obj_handle, nesting_level, info->context,
601 /*******************************************************************************
603 * FUNCTION: acpi_get_devices
605 * PARAMETERS: HID - HID to search for. Can be NULL.
606 * user_function - Called when a matching object is found
607 * Context - Passed to user function
608 * return_value - Location where return value of
609 * user_function is put if terminated early
611 * RETURNS Return value from the user_function if terminated early.
612 * Otherwise, returns NULL.
614 * DESCRIPTION: Performs a modified depth-first walk of the namespace tree,
615 * starting (and ending) at the object specified by start_handle.
616 * The user_function is called whenever an object of type
617 * Device is found. If the user function returns
618 * a non-zero value, the search is terminated immediately and this
619 * value is returned to the caller.
621 * This is a wrapper for walk_namespace, but the callback performs
622 * additional filtering. Please see acpi_ns_get_device_callback.
624 ******************************************************************************/
627 acpi_get_devices(const char *HID,
628 acpi_walk_callback user_function,
629 void *context, void **return_value)
632 struct acpi_get_devices_info info;
634 ACPI_FUNCTION_TRACE(acpi_get_devices);
636 /* Parameter validation */
638 if (!user_function) {
639 return_ACPI_STATUS(AE_BAD_PARAMETER);
643 * We're going to call their callback from OUR callback, so we need
644 * to know what it is, and their context parameter.
647 info.context = context;
648 info.user_function = user_function;
651 * Lock the namespace around the walk.
652 * The namespace will be unlocked/locked around each call
653 * to the user function - since this function
654 * must be allowed to make Acpi calls itself.
656 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
657 if (ACPI_FAILURE(status)) {
658 return_ACPI_STATUS(status);
661 status = acpi_ns_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
662 ACPI_UINT32_MAX, ACPI_NS_WALK_UNLOCK,
663 acpi_ns_get_device_callback, &info,
666 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
667 return_ACPI_STATUS(status);
670 ACPI_EXPORT_SYMBOL(acpi_get_devices)
672 /*******************************************************************************
674 * FUNCTION: acpi_attach_data
676 * PARAMETERS: obj_handle - Namespace node
677 * Handler - Handler for this attachment
678 * Data - Pointer to data to be attached
682 * DESCRIPTION: Attach arbitrary data and handler to a namespace node.
684 ******************************************************************************/
686 acpi_attach_data(acpi_handle obj_handle,
687 acpi_object_handler handler, void *data)
689 struct acpi_namespace_node *node;
692 /* Parameter validation */
694 if (!obj_handle || !handler || !data) {
695 return (AE_BAD_PARAMETER);
698 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
699 if (ACPI_FAILURE(status)) {
703 /* Convert and validate the handle */
705 node = acpi_ns_map_handle_to_node(obj_handle);
707 status = AE_BAD_PARAMETER;
708 goto unlock_and_exit;
711 status = acpi_ns_attach_data(node, handler, data);
714 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
718 ACPI_EXPORT_SYMBOL(acpi_attach_data)
720 /*******************************************************************************
722 * FUNCTION: acpi_detach_data
724 * PARAMETERS: obj_handle - Namespace node handle
725 * Handler - Handler used in call to acpi_attach_data
729 * DESCRIPTION: Remove data that was previously attached to a node.
731 ******************************************************************************/
733 acpi_detach_data(acpi_handle obj_handle, acpi_object_handler handler)
735 struct acpi_namespace_node *node;
738 /* Parameter validation */
740 if (!obj_handle || !handler) {
741 return (AE_BAD_PARAMETER);
744 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
745 if (ACPI_FAILURE(status)) {
749 /* Convert and validate the handle */
751 node = acpi_ns_map_handle_to_node(obj_handle);
753 status = AE_BAD_PARAMETER;
754 goto unlock_and_exit;
757 status = acpi_ns_detach_data(node, handler);
760 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
764 ACPI_EXPORT_SYMBOL(acpi_detach_data)
766 /*******************************************************************************
768 * FUNCTION: acpi_get_data
770 * PARAMETERS: obj_handle - Namespace node
771 * Handler - Handler used in call to attach_data
772 * Data - Where the data is returned
776 * DESCRIPTION: Retrieve data that was previously attached to a namespace node.
778 ******************************************************************************/
780 acpi_get_data(acpi_handle obj_handle, acpi_object_handler handler, void **data)
782 struct acpi_namespace_node *node;
785 /* Parameter validation */
787 if (!obj_handle || !handler || !data) {
788 return (AE_BAD_PARAMETER);
791 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
792 if (ACPI_FAILURE(status)) {
796 /* Convert and validate the handle */
798 node = acpi_ns_map_handle_to_node(obj_handle);
800 status = AE_BAD_PARAMETER;
801 goto unlock_and_exit;
804 status = acpi_ns_get_attached_data(node, handler, data);
807 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
811 ACPI_EXPORT_SYMBOL(acpi_get_data)