1 /*******************************************************************************
3 * Module Name: nsxfeval - Public interfaces to the ACPI subsystem
4 * ACPI Object evaluation interfaces
6 ******************************************************************************/
9 * Copyright (C) 2000 - 2007, 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)
173 struct acpi_evaluate_info *info;
174 acpi_size buffer_space_needed;
177 ACPI_FUNCTION_TRACE(acpi_evaluate_object);
179 /* Allocate and initialize the evaluation information block */
181 info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
183 return_ACPI_STATUS(AE_NO_MEMORY);
186 info->pathname = pathname;
187 info->parameter_type = ACPI_PARAM_ARGS;
189 /* Convert and validate the device handle */
191 info->prefix_node = acpi_ns_map_handle_to_node(handle);
192 if (!info->prefix_node) {
193 status = AE_BAD_PARAMETER;
198 * If there are parameters to be passed to a control method, the external
199 * objects must all be converted to internal objects
201 if (external_params && external_params->count) {
203 * Allocate a new parameter block for the internal objects
204 * Add 1 to count to allow for null terminated internal list
206 info->parameters = ACPI_ALLOCATE_ZEROED(((acpi_size)
209 1) * sizeof(void *));
210 if (!info->parameters) {
211 status = AE_NO_MEMORY;
215 /* Convert each external object in the list to an internal object */
217 for (i = 0; i < external_params->count; i++) {
219 acpi_ut_copy_eobject_to_iobject(&external_params->
223 if (ACPI_FAILURE(status)) {
227 info->parameters[external_params->count] = NULL;
232 * 1) Fully qualified pathname
233 * 2) No handle, not fully qualified pathname (error)
236 if ((pathname) && (acpi_ns_valid_root_prefix(pathname[0]))) {
238 /* The path is fully qualified, just evaluate by name */
240 info->prefix_node = NULL;
241 status = acpi_ns_evaluate(info);
242 } else if (!handle) {
244 * A handle is optional iff a fully qualified pathname is specified.
245 * Since we've already handled fully qualified names above, this is
249 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
250 "Both Handle and Pathname are NULL"));
252 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
253 "Null Handle with relative pathname [%s]",
257 status = AE_BAD_PARAMETER;
259 /* We have a namespace a node and a possible relative path */
261 status = acpi_ns_evaluate(info);
265 * If we are expecting a return value, and all went well above,
266 * copy the return value to an external object.
269 if (!info->return_object) {
270 return_buffer->length = 0;
272 if (ACPI_GET_DESCRIPTOR_TYPE(info->return_object) ==
273 ACPI_DESC_TYPE_NAMED) {
275 * If we received a NS Node as a return object, this means that
276 * the object we are evaluating has nothing interesting to
277 * return (such as a mutex, etc.) We return an error because
278 * these types are essentially unsupported by this interface.
279 * We don't check up front because this makes it easier to add
280 * support for various types at a later date if necessary.
283 info->return_object = NULL; /* No need to delete a NS Node */
284 return_buffer->length = 0;
287 if (ACPI_SUCCESS(status)) {
289 /* Get the size of the returned object */
292 acpi_ut_get_object_size(info->return_object,
293 &buffer_space_needed);
294 if (ACPI_SUCCESS(status)) {
296 /* Validate/Allocate/Clear caller buffer */
299 acpi_ut_initialize_buffer
301 buffer_space_needed);
302 if (ACPI_FAILURE(status)) {
304 * Caller's buffer is too small or a new one can't
307 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
308 "Needed buffer size %X, %s\n",
311 acpi_format_exception
314 /* We have enough space for the object, build it */
317 acpi_ut_copy_iobject_to_eobject
318 (info->return_object,
326 if (info->return_object) {
328 * Delete the internal return object. NOTE: Interpreter must be
329 * locked to avoid race condition.
331 acpi_ex_enter_interpreter();
333 /* Remove one reference on the return object (should delete it) */
335 acpi_ut_remove_reference(info->return_object);
336 acpi_ex_exit_interpreter();
341 /* Free the input parameter list (if we created one) */
343 if (info->parameters) {
345 /* Free the allocated parameter block */
347 acpi_ut_delete_internal_object_list(info->parameters);
351 return_ACPI_STATUS(status);
354 ACPI_EXPORT_SYMBOL(acpi_evaluate_object)
356 /*******************************************************************************
358 * FUNCTION: acpi_walk_namespace
360 * PARAMETERS: Type - acpi_object_type to search for
361 * start_object - Handle in namespace where search begins
362 * max_depth - Depth to which search is to reach
363 * user_function - Called when an object of "Type" is found
364 * Context - Passed to user function
365 * return_value - Location where return value of
366 * user_function is put if terminated early
368 * RETURNS Return value from the user_function if terminated early.
369 * Otherwise, returns NULL.
371 * DESCRIPTION: Performs a modified depth-first walk of the namespace tree,
372 * starting (and ending) at the object specified by start_handle.
373 * The user_function is called whenever an object that matches
374 * the type parameter is found. If the user function returns
375 * a non-zero value, the search is terminated immediately and this
376 * value is returned to the caller.
378 * The point of this procedure is to provide a generic namespace
379 * walk routine that can be called from multiple places to
380 * provide multiple services; the User Function can be tailored
381 * to each task, whether it is a print function, a compare
384 ******************************************************************************/
386 acpi_walk_namespace(acpi_object_type type,
387 acpi_handle start_object,
389 acpi_walk_callback user_function,
390 void *context, void **return_value)
394 ACPI_FUNCTION_TRACE(acpi_walk_namespace);
396 /* Parameter validation */
398 if ((type > ACPI_TYPE_LOCAL_MAX) || (!max_depth) || (!user_function)) {
399 return_ACPI_STATUS(AE_BAD_PARAMETER);
403 * Lock the namespace around the walk.
404 * The namespace will be unlocked/locked around each call
405 * to the user function - since this function
406 * must be allowed to make Acpi calls itself.
408 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
409 if (ACPI_FAILURE(status)) {
410 return_ACPI_STATUS(status);
413 status = acpi_ns_walk_namespace(type, start_object, max_depth,
415 user_function, context, return_value);
417 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
418 return_ACPI_STATUS(status);
421 ACPI_EXPORT_SYMBOL(acpi_walk_namespace)
423 /*******************************************************************************
425 * FUNCTION: acpi_ns_get_device_callback
427 * PARAMETERS: Callback from acpi_get_device
431 * DESCRIPTION: Takes callbacks from walk_namespace and filters out all non-
432 * present devices, or if they specified a HID, it filters based
435 ******************************************************************************/
437 acpi_ns_get_device_callback(acpi_handle obj_handle,
439 void *context, void **return_value)
441 struct acpi_get_devices_info *info = context;
443 struct acpi_namespace_node *node;
445 struct acpi_device_id hid;
446 struct acpi_compatible_id_list *cid;
449 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
450 if (ACPI_FAILURE(status)) {
454 node = acpi_ns_map_handle_to_node(obj_handle);
455 status = acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
456 if (ACPI_FAILURE(status)) {
461 return (AE_BAD_PARAMETER);
464 /* Run _STA to determine if device is present */
466 status = acpi_ut_execute_STA(node, &flags);
467 if (ACPI_FAILURE(status)) {
468 return (AE_CTRL_DEPTH);
471 if (!(flags & ACPI_STA_DEVICE_PRESENT)) {
473 /* Don't examine children of the device if not present */
475 return (AE_CTRL_DEPTH);
478 /* Filter based on device HID & CID */
480 if (info->hid != NULL) {
481 status = acpi_ut_execute_HID(node, &hid);
482 if (status == AE_NOT_FOUND) {
484 } else if (ACPI_FAILURE(status)) {
485 return (AE_CTRL_DEPTH);
488 if (ACPI_STRNCMP(hid.value, info->hid, sizeof(hid.value)) != 0) {
490 /* Get the list of Compatible IDs */
492 status = acpi_ut_execute_CID(node, &cid);
493 if (status == AE_NOT_FOUND) {
495 } else if (ACPI_FAILURE(status)) {
496 return (AE_CTRL_DEPTH);
499 /* Walk the CID list */
501 for (i = 0; i < cid->count; i++) {
502 if (ACPI_STRNCMP(cid->id[i].value, info->hid,
504 acpi_compatible_id)) !=
514 status = info->user_function(obj_handle, nesting_level, info->context,
519 /*******************************************************************************
521 * FUNCTION: acpi_get_devices
523 * PARAMETERS: HID - HID to search for. Can be NULL.
524 * user_function - Called when a matching object is found
525 * Context - Passed to user function
526 * return_value - Location where return value of
527 * user_function is put if terminated early
529 * RETURNS Return value from the user_function if terminated early.
530 * Otherwise, returns NULL.
532 * DESCRIPTION: Performs a modified depth-first walk of the namespace tree,
533 * starting (and ending) at the object specified by start_handle.
534 * The user_function is called whenever an object of type
535 * Device is found. If the user function returns
536 * a non-zero value, the search is terminated immediately and this
537 * value is returned to the caller.
539 * This is a wrapper for walk_namespace, but the callback performs
540 * additional filtering. Please see acpi_get_device_callback.
542 ******************************************************************************/
545 acpi_get_devices(char *HID,
546 acpi_walk_callback user_function,
547 void *context, void **return_value)
550 struct acpi_get_devices_info info;
552 ACPI_FUNCTION_TRACE(acpi_get_devices);
554 /* Parameter validation */
556 if (!user_function) {
557 return_ACPI_STATUS(AE_BAD_PARAMETER);
561 * We're going to call their callback from OUR callback, so we need
562 * to know what it is, and their context parameter.
565 info.context = context;
566 info.user_function = user_function;
569 * Lock the namespace around the walk.
570 * The namespace will be unlocked/locked around each call
571 * to the user function - since this function
572 * must be allowed to make Acpi calls itself.
574 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
575 if (ACPI_FAILURE(status)) {
576 return_ACPI_STATUS(status);
579 status = acpi_ns_walk_namespace(ACPI_TYPE_DEVICE, ACPI_ROOT_OBJECT,
580 ACPI_UINT32_MAX, ACPI_NS_WALK_UNLOCK,
581 acpi_ns_get_device_callback, &info,
584 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
585 return_ACPI_STATUS(status);
588 ACPI_EXPORT_SYMBOL(acpi_get_devices)
590 /*******************************************************************************
592 * FUNCTION: acpi_attach_data
594 * PARAMETERS: obj_handle - Namespace node
595 * Handler - Handler for this attachment
596 * Data - Pointer to data to be attached
600 * DESCRIPTION: Attach arbitrary data and handler to a namespace node.
602 ******************************************************************************/
604 acpi_attach_data(acpi_handle obj_handle,
605 acpi_object_handler handler, void *data)
607 struct acpi_namespace_node *node;
610 /* Parameter validation */
612 if (!obj_handle || !handler || !data) {
613 return (AE_BAD_PARAMETER);
616 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
617 if (ACPI_FAILURE(status)) {
621 /* Convert and validate the handle */
623 node = acpi_ns_map_handle_to_node(obj_handle);
625 status = AE_BAD_PARAMETER;
626 goto unlock_and_exit;
629 status = acpi_ns_attach_data(node, handler, data);
632 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
636 ACPI_EXPORT_SYMBOL(acpi_attach_data)
638 /*******************************************************************************
640 * FUNCTION: acpi_detach_data
642 * PARAMETERS: obj_handle - Namespace node handle
643 * Handler - Handler used in call to acpi_attach_data
647 * DESCRIPTION: Remove data that was previously attached to a node.
649 ******************************************************************************/
651 acpi_detach_data(acpi_handle obj_handle, acpi_object_handler handler)
653 struct acpi_namespace_node *node;
656 /* Parameter validation */
658 if (!obj_handle || !handler) {
659 return (AE_BAD_PARAMETER);
662 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
663 if (ACPI_FAILURE(status)) {
667 /* Convert and validate the handle */
669 node = acpi_ns_map_handle_to_node(obj_handle);
671 status = AE_BAD_PARAMETER;
672 goto unlock_and_exit;
675 status = acpi_ns_detach_data(node, handler);
678 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
682 ACPI_EXPORT_SYMBOL(acpi_detach_data)
684 /*******************************************************************************
686 * FUNCTION: acpi_get_data
688 * PARAMETERS: obj_handle - Namespace node
689 * Handler - Handler used in call to attach_data
690 * Data - Where the data is returned
694 * DESCRIPTION: Retrieve data that was previously attached to a namespace node.
696 ******************************************************************************/
698 acpi_get_data(acpi_handle obj_handle, acpi_object_handler handler, void **data)
700 struct acpi_namespace_node *node;
703 /* Parameter validation */
705 if (!obj_handle || !handler || !data) {
706 return (AE_BAD_PARAMETER);
709 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
710 if (ACPI_FAILURE(status)) {
714 /* Convert and validate the handle */
716 node = acpi_ns_map_handle_to_node(obj_handle);
718 status = AE_BAD_PARAMETER;
719 goto unlock_and_exit;
722 status = acpi_ns_get_attached_data(node, handler, data);
725 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
729 ACPI_EXPORT_SYMBOL(acpi_get_data)