1 /*******************************************************************************
3 * Module Name: nsxfeval - Public interfaces to the ACPI subsystem
4 * ACPI Object evaluation interfaces
6 ******************************************************************************/
9 * Copyright (C) 2000 - 2017, 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 #define EXPORT_ACPI_INTERFACES
47 #include <acpi/acpi.h>
52 #define _COMPONENT ACPI_NAMESPACE
53 ACPI_MODULE_NAME("nsxfeval")
55 /* Local prototypes */
56 static void acpi_ns_resolve_references(struct acpi_evaluate_info
*info
);
58 /*******************************************************************************
60 * FUNCTION: acpi_evaluate_object_typed
62 * PARAMETERS: handle - Object handle (optional)
63 * pathname - Object pathname (optional)
64 * external_params - List of parameters to pass to method,
65 * terminated by NULL. May be NULL
66 * if no parameters are being passed.
67 * return_buffer - Where to put method's return value (if
68 * any). If NULL, no value is returned.
69 * return_type - Expected type of return object
73 * DESCRIPTION: Find and evaluate the given object, passing the given
74 * parameters if necessary. One of "Handle" or "Pathname" must
77 ******************************************************************************/
80 acpi_evaluate_object_typed(acpi_handle handle
,
82 struct acpi_object_list
*external_params
,
83 struct acpi_buffer
*return_buffer
,
84 acpi_object_type return_type
)
87 u8 free_buffer_on_error
= FALSE
;
88 acpi_handle target_handle
;
91 ACPI_FUNCTION_TRACE(acpi_evaluate_object_typed
);
93 /* Return buffer must be valid */
96 return_ACPI_STATUS(AE_BAD_PARAMETER
);
99 if (return_buffer
->length
== ACPI_ALLOCATE_BUFFER
) {
100 free_buffer_on_error
= TRUE
;
103 status
= acpi_get_handle(handle
, pathname
, &target_handle
);
104 if (ACPI_FAILURE(status
)) {
105 return_ACPI_STATUS(status
);
108 full_pathname
= acpi_ns_get_external_pathname(target_handle
);
109 if (!full_pathname
) {
110 return_ACPI_STATUS(AE_NO_MEMORY
);
113 /* Evaluate the object */
115 status
= acpi_evaluate_object(target_handle
, NULL
, external_params
,
117 if (ACPI_FAILURE(status
)) {
121 /* Type ANY means "don't care about return value type" */
123 if (return_type
== ACPI_TYPE_ANY
) {
127 if (return_buffer
->length
== 0) {
129 /* Error because caller specifically asked for a return value */
131 ACPI_ERROR((AE_INFO
, "%s did not return any object",
133 status
= AE_NULL_OBJECT
;
137 /* Examine the object type returned from evaluate_object */
139 if (((union acpi_object
*)return_buffer
->pointer
)->type
== return_type
) {
143 /* Return object type does not match requested type */
146 "Incorrect return type from %s - received [%s], requested [%s]",
148 acpi_ut_get_type_name(((union acpi_object
*)return_buffer
->
150 acpi_ut_get_type_name(return_type
)));
152 if (free_buffer_on_error
) {
154 * Free a buffer created via ACPI_ALLOCATE_BUFFER.
155 * Note: We use acpi_os_free here because acpi_os_allocate was used
156 * to allocate the buffer. This purposefully bypasses the
157 * (optionally enabled) allocation tracking mechanism since we
158 * only want to track internal allocations.
160 acpi_os_free(return_buffer
->pointer
);
161 return_buffer
->pointer
= NULL
;
164 return_buffer
->length
= 0;
168 ACPI_FREE(full_pathname
);
169 return_ACPI_STATUS(status
);
172 ACPI_EXPORT_SYMBOL(acpi_evaluate_object_typed
)
174 /*******************************************************************************
176 * FUNCTION: acpi_evaluate_object
178 * PARAMETERS: handle - Object handle (optional)
179 * pathname - Object pathname (optional)
180 * external_params - List of parameters to pass to method,
181 * terminated by NULL. May be NULL
182 * if no parameters are being passed.
183 * return_buffer - Where to put method's return value (if
184 * any). If NULL, no value is returned.
188 * DESCRIPTION: Find and evaluate the given object, passing the given
189 * parameters if necessary. One of "Handle" or "Pathname" must
190 * be valid (non-null)
192 ******************************************************************************/
194 acpi_evaluate_object(acpi_handle handle
,
195 acpi_string pathname
,
196 struct acpi_object_list
*external_params
,
197 struct acpi_buffer
*return_buffer
)
200 struct acpi_evaluate_info
*info
;
201 acpi_size buffer_space_needed
;
204 ACPI_FUNCTION_TRACE(acpi_evaluate_object
);
206 /* Allocate and initialize the evaluation information block */
208 info
= ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info
));
210 return_ACPI_STATUS(AE_NO_MEMORY
);
213 /* Convert and validate the device handle */
215 info
->prefix_node
= acpi_ns_validate_handle(handle
);
216 if (!info
->prefix_node
) {
217 status
= AE_BAD_PARAMETER
;
222 * Get the actual namespace node for the target object.
223 * Handles these cases:
225 * 1) Null node, valid pathname from root (absolute path)
226 * 2) Node and valid pathname (path relative to Node)
227 * 3) Node, Null pathname
229 if ((pathname
) && (ACPI_IS_ROOT_PREFIX(pathname
[0]))) {
231 /* The path is fully qualified, just evaluate by name */
233 info
->prefix_node
= NULL
;
234 } else if (!handle
) {
236 * A handle is optional iff a fully qualified pathname is specified.
237 * Since we've already handled fully qualified names above, this is
241 ACPI_DEBUG_PRINT((ACPI_DB_INFO
,
242 "Both Handle and Pathname are NULL"));
244 ACPI_DEBUG_PRINT((ACPI_DB_INFO
,
245 "Null Handle with relative pathname [%s]",
249 status
= AE_BAD_PARAMETER
;
253 info
->relative_pathname
= pathname
;
256 * Convert all external objects passed as arguments to the
257 * internal version(s).
259 if (external_params
&& external_params
->count
) {
260 info
->param_count
= (u16
)external_params
->count
;
262 /* Warn on impossible argument count */
264 if (info
->param_count
> ACPI_METHOD_NUM_ARGS
) {
265 ACPI_WARN_PREDEFINED((AE_INFO
, pathname
,
267 "Excess arguments (%u) - using only %u",
269 ACPI_METHOD_NUM_ARGS
));
271 info
->param_count
= ACPI_METHOD_NUM_ARGS
;
275 * Allocate a new parameter block for the internal objects
276 * Add 1 to count to allow for null terminated internal list
278 info
->parameters
= ACPI_ALLOCATE_ZEROED(((acpi_size
)info
->
280 1) * sizeof(void *));
281 if (!info
->parameters
) {
282 status
= AE_NO_MEMORY
;
286 /* Convert each external object in the list to an internal object */
288 for (i
= 0; i
< info
->param_count
; i
++) {
290 acpi_ut_copy_eobject_to_iobject(&external_params
->
294 if (ACPI_FAILURE(status
)) {
299 info
->parameters
[info
->param_count
] = NULL
;
302 #ifdef _FUTURE_FEATURE
305 * Begin incoming argument count analysis. Check for too few args
308 switch (acpi_ns_get_type(info
->node
)) {
309 case ACPI_TYPE_METHOD
:
311 /* Check incoming argument count against the method definition */
313 if (info
->obj_desc
->method
.param_count
> info
->param_count
) {
315 "Insufficient arguments (%u) - %u are required",
317 info
->obj_desc
->method
.param_count
));
319 status
= AE_MISSING_ARGUMENTS
;
323 else if (info
->obj_desc
->method
.param_count
< info
->param_count
) {
324 ACPI_WARNING((AE_INFO
,
325 "Excess arguments (%u) - only %u are required",
327 info
->obj_desc
->method
.param_count
));
329 /* Just pass the required number of arguments */
331 info
->param_count
= info
->obj_desc
->method
.param_count
;
335 * Any incoming external objects to be passed as arguments to the
336 * method must be converted to internal objects
338 if (info
->param_count
) {
340 * Allocate a new parameter block for the internal objects
341 * Add 1 to count to allow for null terminated internal list
343 info
->parameters
= ACPI_ALLOCATE_ZEROED(((acpi_size
)
348 if (!info
->parameters
) {
349 status
= AE_NO_MEMORY
;
353 /* Convert each external object in the list to an internal object */
355 for (i
= 0; i
< info
->param_count
; i
++) {
357 acpi_ut_copy_eobject_to_iobject
358 (&external_params
->pointer
[i
],
359 &info
->parameters
[i
]);
360 if (ACPI_FAILURE(status
)) {
365 info
->parameters
[info
->param_count
] = NULL
;
371 /* Warn if arguments passed to an object that is not a method */
373 if (info
->param_count
) {
374 ACPI_WARNING((AE_INFO
,
375 "%u arguments were passed to a non-method ACPI object",
383 /* Now we can evaluate the object */
385 status
= acpi_ns_evaluate(info
);
388 * If we are expecting a return value, and all went well above,
389 * copy the return value to an external object.
391 if (!return_buffer
) {
392 goto cleanup_return_object
;
395 if (!info
->return_object
) {
396 return_buffer
->length
= 0;
400 if (ACPI_GET_DESCRIPTOR_TYPE(info
->return_object
) ==
401 ACPI_DESC_TYPE_NAMED
) {
403 * If we received a NS Node as a return object, this means that
404 * the object we are evaluating has nothing interesting to
405 * return (such as a mutex, etc.) We return an error because
406 * these types are essentially unsupported by this interface.
407 * We don't check up front because this makes it easier to add
408 * support for various types at a later date if necessary.
411 info
->return_object
= NULL
; /* No need to delete a NS Node */
412 return_buffer
->length
= 0;
415 if (ACPI_FAILURE(status
)) {
416 goto cleanup_return_object
;
419 /* Dereference Index and ref_of references */
421 acpi_ns_resolve_references(info
);
423 /* Get the size of the returned object */
425 status
= acpi_ut_get_object_size(info
->return_object
,
426 &buffer_space_needed
);
427 if (ACPI_SUCCESS(status
)) {
429 /* Validate/Allocate/Clear caller buffer */
431 status
= acpi_ut_initialize_buffer(return_buffer
,
432 buffer_space_needed
);
433 if (ACPI_FAILURE(status
)) {
435 * Caller's buffer is too small or a new one can't
438 ACPI_DEBUG_PRINT((ACPI_DB_INFO
,
439 "Needed buffer size %X, %s\n",
440 (u32
)buffer_space_needed
,
441 acpi_format_exception(status
)));
443 /* We have enough space for the object, build it */
446 acpi_ut_copy_iobject_to_eobject(info
->return_object
,
451 cleanup_return_object
:
453 if (info
->return_object
) {
455 * Delete the internal return object. NOTE: Interpreter must be
456 * locked to avoid race condition.
458 acpi_ex_enter_interpreter();
460 /* Remove one reference on the return object (should delete it) */
462 acpi_ut_remove_reference(info
->return_object
);
463 acpi_ex_exit_interpreter();
468 /* Free the input parameter list (if we created one) */
470 if (info
->parameters
) {
472 /* Free the allocated parameter block */
474 acpi_ut_delete_internal_object_list(info
->parameters
);
478 return_ACPI_STATUS(status
);
481 ACPI_EXPORT_SYMBOL(acpi_evaluate_object
)
483 /*******************************************************************************
485 * FUNCTION: acpi_ns_resolve_references
487 * PARAMETERS: info - Evaluation info block
489 * RETURN: Info->return_object is replaced with the dereferenced object
491 * DESCRIPTION: Dereference certain reference objects. Called before an
492 * internal return object is converted to an external union acpi_object.
494 * Performs an automatic dereference of Index and ref_of reference objects.
495 * These reference objects are not supported by the union acpi_object, so this is a
496 * last resort effort to return something useful. Also, provides compatibility
497 * with other ACPI implementations.
499 * NOTE: does not handle references within returned package objects or nested
500 * references, but this support could be added later if found to be necessary.
502 ******************************************************************************/
503 static void acpi_ns_resolve_references(struct acpi_evaluate_info
*info
)
505 union acpi_operand_object
*obj_desc
= NULL
;
506 struct acpi_namespace_node
*node
;
508 /* We are interested in reference objects only */
510 if ((info
->return_object
)->common
.type
!= ACPI_TYPE_LOCAL_REFERENCE
) {
515 * Two types of references are supported - those created by Index and
516 * ref_of operators. A name reference (AML_NAMEPATH_OP) can be converted
517 * to a union acpi_object, so it is not dereferenced here. A ddb_handle
518 * (AML_LOAD_OP) cannot be dereferenced, nor can it be converted to
519 * a union acpi_object.
521 switch (info
->return_object
->reference
.class) {
522 case ACPI_REFCLASS_INDEX
:
524 obj_desc
= *(info
->return_object
->reference
.where
);
527 case ACPI_REFCLASS_REFOF
:
529 node
= info
->return_object
->reference
.object
;
531 obj_desc
= node
->object
;
540 /* Replace the existing reference object */
543 acpi_ut_add_reference(obj_desc
);
544 acpi_ut_remove_reference(info
->return_object
);
545 info
->return_object
= obj_desc
;
551 /*******************************************************************************
553 * FUNCTION: acpi_walk_namespace
555 * PARAMETERS: type - acpi_object_type to search for
556 * start_object - Handle in namespace where search begins
557 * max_depth - Depth to which search is to reach
558 * descending_callback - Called during tree descent
559 * when an object of "Type" is found
560 * ascending_callback - Called during tree ascent
561 * when an object of "Type" is found
562 * context - Passed to user function(s) above
563 * return_value - Location where return value of
564 * user_function is put if terminated early
566 * RETURNS Return value from the user_function if terminated early.
567 * Otherwise, returns NULL.
569 * DESCRIPTION: Performs a modified depth-first walk of the namespace tree,
570 * starting (and ending) at the object specified by start_handle.
571 * The callback function is called whenever an object that matches
572 * the type parameter is found. If the callback function returns
573 * a non-zero value, the search is terminated immediately and this
574 * value is returned to the caller.
576 * The point of this procedure is to provide a generic namespace
577 * walk routine that can be called from multiple places to
578 * provide multiple services; the callback function(s) can be
579 * tailored to each task, whether it is a print function,
580 * a compare function, etc.
582 ******************************************************************************/
585 acpi_walk_namespace(acpi_object_type type
,
586 acpi_handle start_object
,
588 acpi_walk_callback descending_callback
,
589 acpi_walk_callback ascending_callback
,
590 void *context
, void **return_value
)
594 ACPI_FUNCTION_TRACE(acpi_walk_namespace
);
596 /* Parameter validation */
598 if ((type
> ACPI_TYPE_LOCAL_MAX
) ||
599 (!max_depth
) || (!descending_callback
&& !ascending_callback
)) {
600 return_ACPI_STATUS(AE_BAD_PARAMETER
);
604 * Need to acquire the namespace reader lock to prevent interference
605 * with any concurrent table unloads (which causes the deletion of
606 * namespace objects). We cannot allow the deletion of a namespace node
607 * while the user function is using it. The exception to this are the
608 * nodes created and deleted during control method execution -- these
609 * nodes are marked as temporary nodes and are ignored by the namespace
610 * walk. Thus, control methods can be executed while holding the
611 * namespace deletion lock (and the user function can execute control
614 status
= acpi_ut_acquire_read_lock(&acpi_gbl_namespace_rw_lock
);
615 if (ACPI_FAILURE(status
)) {
616 return_ACPI_STATUS(status
);
620 * Lock the namespace around the walk. The namespace will be
621 * unlocked/locked around each call to the user function - since the user
622 * function must be allowed to make ACPICA calls itself (for example, it
623 * will typically execute control methods during device enumeration.)
625 status
= acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE
);
626 if (ACPI_FAILURE(status
)) {
627 goto unlock_and_exit
;
630 /* Now we can validate the starting node */
632 if (!acpi_ns_validate_handle(start_object
)) {
633 status
= AE_BAD_PARAMETER
;
634 goto unlock_and_exit2
;
637 status
= acpi_ns_walk_namespace(type
, start_object
, max_depth
,
639 descending_callback
, ascending_callback
,
640 context
, return_value
);
643 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE
);
646 (void)acpi_ut_release_read_lock(&acpi_gbl_namespace_rw_lock
);
647 return_ACPI_STATUS(status
);
650 ACPI_EXPORT_SYMBOL(acpi_walk_namespace
)
652 /*******************************************************************************
654 * FUNCTION: acpi_ns_get_device_callback
656 * PARAMETERS: Callback from acpi_get_device
660 * DESCRIPTION: Takes callbacks from walk_namespace and filters out all non-
661 * present devices, or if they specified a HID, it filters based
664 ******************************************************************************/
666 acpi_ns_get_device_callback(acpi_handle obj_handle
,
668 void *context
, void **return_value
)
670 struct acpi_get_devices_info
*info
= context
;
672 struct acpi_namespace_node
*node
;
674 struct acpi_pnp_device_id
*hid
;
675 struct acpi_pnp_device_id_list
*cid
;
680 status
= acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE
);
681 if (ACPI_FAILURE(status
)) {
685 node
= acpi_ns_validate_handle(obj_handle
);
686 status
= acpi_ut_release_mutex(ACPI_MTX_NAMESPACE
);
687 if (ACPI_FAILURE(status
)) {
692 return (AE_BAD_PARAMETER
);
696 * First, filter based on the device HID and CID.
698 * 01/2010: For this case where a specific HID is requested, we don't
699 * want to run _STA until we have an actual HID match. Thus, we will
700 * not unnecessarily execute _STA on devices for which the caller
701 * doesn't care about. Previously, _STA was executed unconditionally
702 * on all devices found here.
704 * A side-effect of this change is that now we will continue to search
705 * for a matching HID even under device trees where the parent device
706 * would have returned a _STA that indicates it is not present or
707 * not functioning (thus aborting the search on that branch).
709 if (info
->hid
!= NULL
) {
710 status
= acpi_ut_execute_HID(node
, &hid
);
711 if (status
== AE_NOT_FOUND
) {
713 } else if (ACPI_FAILURE(status
)) {
714 return (AE_CTRL_DEPTH
);
717 no_match
= strcmp(hid
->string
, info
->hid
);
722 * HID does not match, attempt match within the
723 * list of Compatible IDs (CIDs)
725 status
= acpi_ut_execute_CID(node
, &cid
);
726 if (status
== AE_NOT_FOUND
) {
728 } else if (ACPI_FAILURE(status
)) {
729 return (AE_CTRL_DEPTH
);
732 /* Walk the CID list */
735 for (i
= 0; i
< cid
->count
; i
++) {
736 if (strcmp(cid
->ids
[i
].string
, info
->hid
) == 0) {
738 /* Found a matching CID */
752 /* Run _STA to determine if device is present */
754 status
= acpi_ut_execute_STA(node
, &flags
);
755 if (ACPI_FAILURE(status
)) {
756 return (AE_CTRL_DEPTH
);
759 if (!(flags
& ACPI_STA_DEVICE_PRESENT
) &&
760 !(flags
& ACPI_STA_DEVICE_FUNCTIONING
)) {
762 * Don't examine the children of the device only when the
763 * device is neither present nor functional. See ACPI spec,
764 * description of _STA for more information.
766 return (AE_CTRL_DEPTH
);
769 /* We have a valid device, invoke the user function */
771 status
= info
->user_function(obj_handle
, nesting_level
,
772 info
->context
, return_value
);
776 /*******************************************************************************
778 * FUNCTION: acpi_get_devices
780 * PARAMETERS: HID - HID to search for. Can be NULL.
781 * user_function - Called when a matching object is found
782 * context - Passed to user function
783 * return_value - Location where return value of
784 * user_function is put if terminated early
786 * RETURNS Return value from the user_function if terminated early.
787 * Otherwise, returns NULL.
789 * DESCRIPTION: Performs a modified depth-first walk of the namespace tree,
790 * starting (and ending) at the object specified by start_handle.
791 * The user_function is called whenever an object of type
792 * Device is found. If the user function returns
793 * a non-zero value, the search is terminated immediately and this
794 * value is returned to the caller.
796 * This is a wrapper for walk_namespace, but the callback performs
797 * additional filtering. Please see acpi_ns_get_device_callback.
799 ******************************************************************************/
802 acpi_get_devices(const char *HID
,
803 acpi_walk_callback user_function
,
804 void *context
, void **return_value
)
807 struct acpi_get_devices_info info
;
809 ACPI_FUNCTION_TRACE(acpi_get_devices
);
811 /* Parameter validation */
813 if (!user_function
) {
814 return_ACPI_STATUS(AE_BAD_PARAMETER
);
818 * We're going to call their callback from OUR callback, so we need
819 * to know what it is, and their context parameter.
822 info
.context
= context
;
823 info
.user_function
= user_function
;
826 * Lock the namespace around the walk.
827 * The namespace will be unlocked/locked around each call
828 * to the user function - since this function
829 * must be allowed to make Acpi calls itself.
831 status
= acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE
);
832 if (ACPI_FAILURE(status
)) {
833 return_ACPI_STATUS(status
);
836 status
= acpi_ns_walk_namespace(ACPI_TYPE_DEVICE
, ACPI_ROOT_OBJECT
,
837 ACPI_UINT32_MAX
, ACPI_NS_WALK_UNLOCK
,
838 acpi_ns_get_device_callback
, NULL
,
839 &info
, return_value
);
841 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE
);
842 return_ACPI_STATUS(status
);
845 ACPI_EXPORT_SYMBOL(acpi_get_devices
)
847 /*******************************************************************************
849 * FUNCTION: acpi_attach_data
851 * PARAMETERS: obj_handle - Namespace node
852 * handler - Handler for this attachment
853 * data - Pointer to data to be attached
857 * DESCRIPTION: Attach arbitrary data and handler to a namespace node.
859 ******************************************************************************/
861 acpi_attach_data(acpi_handle obj_handle
,
862 acpi_object_handler handler
, void *data
)
864 struct acpi_namespace_node
*node
;
867 /* Parameter validation */
869 if (!obj_handle
|| !handler
|| !data
) {
870 return (AE_BAD_PARAMETER
);
873 status
= acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE
);
874 if (ACPI_FAILURE(status
)) {
878 /* Convert and validate the handle */
880 node
= acpi_ns_validate_handle(obj_handle
);
882 status
= AE_BAD_PARAMETER
;
883 goto unlock_and_exit
;
886 status
= acpi_ns_attach_data(node
, handler
, data
);
889 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE
);
893 ACPI_EXPORT_SYMBOL(acpi_attach_data
)
895 /*******************************************************************************
897 * FUNCTION: acpi_detach_data
899 * PARAMETERS: obj_handle - Namespace node handle
900 * handler - Handler used in call to acpi_attach_data
904 * DESCRIPTION: Remove data that was previously attached to a node.
906 ******************************************************************************/
908 acpi_detach_data(acpi_handle obj_handle
, acpi_object_handler handler
)
910 struct acpi_namespace_node
*node
;
913 /* Parameter validation */
915 if (!obj_handle
|| !handler
) {
916 return (AE_BAD_PARAMETER
);
919 status
= acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE
);
920 if (ACPI_FAILURE(status
)) {
924 /* Convert and validate the handle */
926 node
= acpi_ns_validate_handle(obj_handle
);
928 status
= AE_BAD_PARAMETER
;
929 goto unlock_and_exit
;
932 status
= acpi_ns_detach_data(node
, handler
);
935 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE
);
939 ACPI_EXPORT_SYMBOL(acpi_detach_data
)
941 /*******************************************************************************
943 * FUNCTION: acpi_get_data_full
945 * PARAMETERS: obj_handle - Namespace node
946 * handler - Handler used in call to attach_data
947 * data - Where the data is returned
948 * callback - function to execute before returning
952 * DESCRIPTION: Retrieve data that was previously attached to a namespace node
953 * and execute a callback before returning.
955 ******************************************************************************/
957 acpi_get_data_full(acpi_handle obj_handle
, acpi_object_handler handler
,
958 void **data
, void (*callback
)(void *))
960 struct acpi_namespace_node
*node
;
963 /* Parameter validation */
965 if (!obj_handle
|| !handler
|| !data
) {
966 return (AE_BAD_PARAMETER
);
969 status
= acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE
);
970 if (ACPI_FAILURE(status
)) {
974 /* Convert and validate the handle */
976 node
= acpi_ns_validate_handle(obj_handle
);
978 status
= AE_BAD_PARAMETER
;
979 goto unlock_and_exit
;
982 status
= acpi_ns_get_attached_data(node
, handler
, data
);
983 if (ACPI_SUCCESS(status
) && callback
) {
988 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE
);
992 ACPI_EXPORT_SYMBOL(acpi_get_data_full
)
994 /*******************************************************************************
996 * FUNCTION: acpi_get_data
998 * PARAMETERS: obj_handle - Namespace node
999 * handler - Handler used in call to attach_data
1000 * data - Where the data is returned
1004 * DESCRIPTION: Retrieve data that was previously attached to a namespace node.
1006 ******************************************************************************/
1008 acpi_get_data(acpi_handle obj_handle
, acpi_object_handler handler
, void **data
)
1010 return acpi_get_data_full(obj_handle
, handler
, data
, NULL
);
1013 ACPI_EXPORT_SYMBOL(acpi_get_data
)