1 /******************************************************************************
3 * Module Name: evxface - External interfaces for ACPI events
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2005, R. Byron Moore
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 #include <linux/module.h>
46 #include <acpi/acpi.h>
47 #include <acpi/acnamesp.h>
48 #include <acpi/acevents.h>
49 #include <acpi/acinterp.h>
51 #define _COMPONENT ACPI_EVENTS
52 ACPI_MODULE_NAME("evxface")
54 /*******************************************************************************
56 * FUNCTION: acpi_install_exception_handler
58 * PARAMETERS: Handler - Pointer to the handler function for the
63 * DESCRIPTION: Saves the pointer to the handler function
65 ******************************************************************************/
66 #ifdef ACPI_FUTURE_USAGE
67 acpi_status acpi_install_exception_handler(acpi_exception_handler handler)
71 ACPI_FUNCTION_TRACE("acpi_install_exception_handler");
73 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
74 if (ACPI_FAILURE(status)) {
75 return_ACPI_STATUS(status);
78 /* Don't allow two handlers. */
80 if (acpi_gbl_exception_handler) {
81 status = AE_ALREADY_EXISTS;
85 /* Install the handler */
87 acpi_gbl_exception_handler = handler;
90 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
91 return_ACPI_STATUS(status);
93 #endif /* ACPI_FUTURE_USAGE */
95 /*******************************************************************************
97 * FUNCTION: acpi_install_fixed_event_handler
99 * PARAMETERS: Event - Event type to enable.
100 * Handler - Pointer to the handler function for the
102 * Context - Value passed to the handler on each GPE
106 * DESCRIPTION: Saves the pointer to the handler function and then enables the
109 ******************************************************************************/
112 acpi_install_fixed_event_handler(u32 event,
113 acpi_event_handler handler, void *context)
117 ACPI_FUNCTION_TRACE("acpi_install_fixed_event_handler");
119 /* Parameter validation */
121 if (event > ACPI_EVENT_MAX) {
122 return_ACPI_STATUS(AE_BAD_PARAMETER);
125 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
126 if (ACPI_FAILURE(status)) {
127 return_ACPI_STATUS(status);
130 /* Don't allow two handlers. */
132 if (NULL != acpi_gbl_fixed_event_handlers[event].handler) {
133 status = AE_ALREADY_EXISTS;
137 /* Install the handler before enabling the event */
139 acpi_gbl_fixed_event_handlers[event].handler = handler;
140 acpi_gbl_fixed_event_handlers[event].context = context;
142 status = acpi_clear_event(event);
143 if (ACPI_SUCCESS(status))
144 status = acpi_enable_event(event, 0);
145 if (ACPI_FAILURE(status)) {
146 ACPI_DEBUG_PRINT((ACPI_DB_WARN,
147 "Could not enable fixed event.\n"));
149 /* Remove the handler */
151 acpi_gbl_fixed_event_handlers[event].handler = NULL;
152 acpi_gbl_fixed_event_handlers[event].context = NULL;
154 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
155 "Enabled fixed event %X, Handler=%p\n", event,
160 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
161 return_ACPI_STATUS(status);
164 EXPORT_SYMBOL(acpi_install_fixed_event_handler);
166 /*******************************************************************************
168 * FUNCTION: acpi_remove_fixed_event_handler
170 * PARAMETERS: Event - Event type to disable.
171 * Handler - Address of the handler
175 * DESCRIPTION: Disables the event and unregisters the event handler.
177 ******************************************************************************/
180 acpi_remove_fixed_event_handler(u32 event, acpi_event_handler handler)
182 acpi_status status = AE_OK;
184 ACPI_FUNCTION_TRACE("acpi_remove_fixed_event_handler");
186 /* Parameter validation */
188 if (event > ACPI_EVENT_MAX) {
189 return_ACPI_STATUS(AE_BAD_PARAMETER);
192 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
193 if (ACPI_FAILURE(status)) {
194 return_ACPI_STATUS(status);
197 /* Disable the event before removing the handler */
199 status = acpi_disable_event(event, 0);
201 /* Always Remove the handler */
203 acpi_gbl_fixed_event_handlers[event].handler = NULL;
204 acpi_gbl_fixed_event_handlers[event].context = NULL;
206 if (ACPI_FAILURE(status)) {
207 ACPI_DEBUG_PRINT((ACPI_DB_WARN,
208 "Could not write to fixed event enable register.\n"));
210 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Disabled fixed event %X.\n",
214 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
215 return_ACPI_STATUS(status);
218 EXPORT_SYMBOL(acpi_remove_fixed_event_handler);
220 /*******************************************************************************
222 * FUNCTION: acpi_install_notify_handler
224 * PARAMETERS: Device - The device for which notifies will be handled
225 * handler_type - The type of handler:
226 * ACPI_SYSTEM_NOTIFY: system_handler (00-7f)
227 * ACPI_DEVICE_NOTIFY: driver_handler (80-ff)
228 * ACPI_ALL_NOTIFY: both system and device
229 * Handler - Address of the handler
230 * Context - Value passed to the handler on each GPE
234 * DESCRIPTION: Install a handler for notifies on an ACPI device
236 ******************************************************************************/
239 acpi_install_notify_handler(acpi_handle device,
241 acpi_notify_handler handler, void *context)
243 union acpi_operand_object *obj_desc;
244 union acpi_operand_object *notify_obj;
245 struct acpi_namespace_node *node;
248 ACPI_FUNCTION_TRACE("acpi_install_notify_handler");
250 /* Parameter validation */
253 (!handler) || (handler_type > ACPI_MAX_NOTIFY_HANDLER_TYPE)) {
254 return_ACPI_STATUS(AE_BAD_PARAMETER);
257 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
258 if (ACPI_FAILURE(status)) {
259 return_ACPI_STATUS(status);
262 /* Convert and validate the device handle */
264 node = acpi_ns_map_handle_to_node(device);
266 status = AE_BAD_PARAMETER;
267 goto unlock_and_exit;
272 * Registering a notify handler on the root object indicates that the
273 * caller wishes to receive notifications for all objects. Note that
274 * only one <external> global handler can be regsitered (per notify type).
276 if (device == ACPI_ROOT_OBJECT) {
277 /* Make sure the handler is not already installed */
279 if (((handler_type & ACPI_SYSTEM_NOTIFY) &&
280 acpi_gbl_system_notify.handler) ||
281 ((handler_type & ACPI_DEVICE_NOTIFY) &&
282 acpi_gbl_device_notify.handler)) {
283 status = AE_ALREADY_EXISTS;
284 goto unlock_and_exit;
287 if (handler_type & ACPI_SYSTEM_NOTIFY) {
288 acpi_gbl_system_notify.node = node;
289 acpi_gbl_system_notify.handler = handler;
290 acpi_gbl_system_notify.context = context;
293 if (handler_type & ACPI_DEVICE_NOTIFY) {
294 acpi_gbl_device_notify.node = node;
295 acpi_gbl_device_notify.handler = handler;
296 acpi_gbl_device_notify.context = context;
299 /* Global notify handler installed */
304 * Caller will only receive notifications specific to the target object.
305 * Note that only certain object types can receive notifications.
308 /* Notifies allowed on this object? */
310 if (!acpi_ev_is_notify_object(node)) {
312 goto unlock_and_exit;
315 /* Check for an existing internal object */
317 obj_desc = acpi_ns_get_attached_object(node);
319 /* Object exists - make sure there's no handler */
321 if (((handler_type & ACPI_SYSTEM_NOTIFY) &&
322 obj_desc->common_notify.system_notify) ||
323 ((handler_type & ACPI_DEVICE_NOTIFY) &&
324 obj_desc->common_notify.device_notify)) {
325 status = AE_ALREADY_EXISTS;
326 goto unlock_and_exit;
329 /* Create a new object */
331 obj_desc = acpi_ut_create_internal_object(node->type);
333 status = AE_NO_MEMORY;
334 goto unlock_and_exit;
337 /* Attach new object to the Node */
340 acpi_ns_attach_object(device, obj_desc, node->type);
342 /* Remove local reference to the object */
344 acpi_ut_remove_reference(obj_desc);
345 if (ACPI_FAILURE(status)) {
346 goto unlock_and_exit;
350 /* Install the handler */
353 acpi_ut_create_internal_object(ACPI_TYPE_LOCAL_NOTIFY);
355 status = AE_NO_MEMORY;
356 goto unlock_and_exit;
359 notify_obj->notify.node = node;
360 notify_obj->notify.handler = handler;
361 notify_obj->notify.context = context;
363 if (handler_type & ACPI_SYSTEM_NOTIFY) {
364 obj_desc->common_notify.system_notify = notify_obj;
367 if (handler_type & ACPI_DEVICE_NOTIFY) {
368 obj_desc->common_notify.device_notify = notify_obj;
371 if (handler_type == ACPI_ALL_NOTIFY) {
372 /* Extra ref if installed in both */
374 acpi_ut_add_reference(notify_obj);
379 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
380 return_ACPI_STATUS(status);
383 EXPORT_SYMBOL(acpi_install_notify_handler);
385 /*******************************************************************************
387 * FUNCTION: acpi_remove_notify_handler
389 * PARAMETERS: Device - The device for which notifies will be handled
390 * handler_type - The type of handler:
391 * ACPI_SYSTEM_NOTIFY: system_handler (00-7f)
392 * ACPI_DEVICE_NOTIFY: driver_handler (80-ff)
393 * ACPI_ALL_NOTIFY: both system and device
394 * Handler - Address of the handler
398 * DESCRIPTION: Remove a handler for notifies on an ACPI device
400 ******************************************************************************/
403 acpi_remove_notify_handler(acpi_handle device,
404 u32 handler_type, acpi_notify_handler handler)
406 union acpi_operand_object *notify_obj;
407 union acpi_operand_object *obj_desc;
408 struct acpi_namespace_node *node;
411 ACPI_FUNCTION_TRACE("acpi_remove_notify_handler");
413 /* Parameter validation */
416 (!handler) || (handler_type > ACPI_MAX_NOTIFY_HANDLER_TYPE)) {
417 return_ACPI_STATUS(AE_BAD_PARAMETER);
420 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
421 if (ACPI_FAILURE(status)) {
422 return_ACPI_STATUS(status);
425 /* Convert and validate the device handle */
427 node = acpi_ns_map_handle_to_node(device);
429 status = AE_BAD_PARAMETER;
430 goto unlock_and_exit;
435 if (device == ACPI_ROOT_OBJECT) {
436 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
437 "Removing notify handler for ROOT object.\n"));
439 if (((handler_type & ACPI_SYSTEM_NOTIFY) &&
440 !acpi_gbl_system_notify.handler) ||
441 ((handler_type & ACPI_DEVICE_NOTIFY) &&
442 !acpi_gbl_device_notify.handler)) {
443 status = AE_NOT_EXIST;
444 goto unlock_and_exit;
447 /* Make sure all deferred tasks are completed */
449 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
450 acpi_os_wait_events_complete(NULL);
451 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
452 if (ACPI_FAILURE(status)) {
453 return_ACPI_STATUS(status);
456 if (handler_type & ACPI_SYSTEM_NOTIFY) {
457 acpi_gbl_system_notify.node = NULL;
458 acpi_gbl_system_notify.handler = NULL;
459 acpi_gbl_system_notify.context = NULL;
462 if (handler_type & ACPI_DEVICE_NOTIFY) {
463 acpi_gbl_device_notify.node = NULL;
464 acpi_gbl_device_notify.handler = NULL;
465 acpi_gbl_device_notify.context = NULL;
469 /* All Other Objects */
472 /* Notifies allowed on this object? */
474 if (!acpi_ev_is_notify_object(node)) {
476 goto unlock_and_exit;
479 /* Check for an existing internal object */
481 obj_desc = acpi_ns_get_attached_object(node);
483 status = AE_NOT_EXIST;
484 goto unlock_and_exit;
487 /* Object exists - make sure there's an existing handler */
489 if (handler_type & ACPI_SYSTEM_NOTIFY) {
490 notify_obj = obj_desc->common_notify.system_notify;
492 (notify_obj->notify.handler != handler)) {
493 status = AE_BAD_PARAMETER;
494 goto unlock_and_exit;
496 /* Make sure all deferred tasks are completed */
498 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
499 acpi_os_wait_events_complete(NULL);
500 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
501 if (ACPI_FAILURE(status)) {
502 return_ACPI_STATUS(status);
505 /* Remove the handler */
506 obj_desc->common_notify.system_notify = NULL;
507 acpi_ut_remove_reference(notify_obj);
510 if (handler_type & ACPI_DEVICE_NOTIFY) {
511 notify_obj = obj_desc->common_notify.device_notify;
513 (notify_obj->notify.handler != handler)) {
514 status = AE_BAD_PARAMETER;
515 goto unlock_and_exit;
517 /* Make sure all deferred tasks are completed */
519 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
520 acpi_os_wait_events_complete(NULL);
521 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
522 if (ACPI_FAILURE(status)) {
523 return_ACPI_STATUS(status);
526 /* Remove the handler */
527 obj_desc->common_notify.device_notify = NULL;
528 acpi_ut_remove_reference(notify_obj);
533 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
534 return_ACPI_STATUS(status);
537 EXPORT_SYMBOL(acpi_remove_notify_handler);
539 /*******************************************************************************
541 * FUNCTION: acpi_install_gpe_handler
543 * PARAMETERS: gpe_device - Namespace node for the GPE (NULL for FADT
545 * gpe_number - The GPE number within the GPE block
546 * Type - Whether this GPE should be treated as an
547 * edge- or level-triggered interrupt.
548 * Address - Address of the handler
549 * Context - Value passed to the handler on each GPE
553 * DESCRIPTION: Install a handler for a General Purpose Event.
555 ******************************************************************************/
558 acpi_install_gpe_handler(acpi_handle gpe_device,
560 u32 type, acpi_event_handler address, void *context)
562 struct acpi_gpe_event_info *gpe_event_info;
563 struct acpi_handler_info *handler;
567 ACPI_FUNCTION_TRACE("acpi_install_gpe_handler");
569 /* Parameter validation */
571 if ((!address) || (type > ACPI_GPE_XRUPT_TYPE_MASK)) {
572 return_ACPI_STATUS(AE_BAD_PARAMETER);
575 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
576 if (ACPI_FAILURE(status)) {
577 return_ACPI_STATUS(status);
580 /* Ensure that we have a valid GPE number */
582 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
583 if (!gpe_event_info) {
584 status = AE_BAD_PARAMETER;
585 goto unlock_and_exit;
588 /* Make sure that there isn't a handler there already */
590 if ((gpe_event_info->flags & ACPI_GPE_DISPATCH_MASK) ==
591 ACPI_GPE_DISPATCH_HANDLER) {
592 status = AE_ALREADY_EXISTS;
593 goto unlock_and_exit;
596 /* Allocate and init handler object */
598 handler = ACPI_MEM_CALLOCATE(sizeof(struct acpi_handler_info));
600 status = AE_NO_MEMORY;
601 goto unlock_and_exit;
604 handler->address = address;
605 handler->context = context;
606 handler->method_node = gpe_event_info->dispatch.method_node;
608 /* Disable the GPE before installing the handler */
610 status = acpi_ev_disable_gpe(gpe_event_info);
611 if (ACPI_FAILURE(status)) {
612 goto unlock_and_exit;
615 /* Install the handler */
617 flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
618 gpe_event_info->dispatch.handler = handler;
620 /* Setup up dispatch flags to indicate handler (vs. method) */
622 gpe_event_info->flags &= ~(ACPI_GPE_XRUPT_TYPE_MASK | ACPI_GPE_DISPATCH_MASK); /* Clear bits */
623 gpe_event_info->flags |= (u8) (type | ACPI_GPE_DISPATCH_HANDLER);
625 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
628 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
629 return_ACPI_STATUS(status);
632 EXPORT_SYMBOL(acpi_install_gpe_handler);
634 /*******************************************************************************
636 * FUNCTION: acpi_remove_gpe_handler
638 * PARAMETERS: gpe_device - Namespace node for the GPE (NULL for FADT
640 * gpe_number - The event to remove a handler
641 * Address - Address of the handler
645 * DESCRIPTION: Remove a handler for a General Purpose acpi_event.
647 ******************************************************************************/
650 acpi_remove_gpe_handler(acpi_handle gpe_device,
651 u32 gpe_number, acpi_event_handler address)
653 struct acpi_gpe_event_info *gpe_event_info;
654 struct acpi_handler_info *handler;
658 ACPI_FUNCTION_TRACE("acpi_remove_gpe_handler");
660 /* Parameter validation */
663 return_ACPI_STATUS(AE_BAD_PARAMETER);
666 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
667 if (ACPI_FAILURE(status)) {
668 return_ACPI_STATUS(status);
671 /* Ensure that we have a valid GPE number */
673 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
674 if (!gpe_event_info) {
675 status = AE_BAD_PARAMETER;
676 goto unlock_and_exit;
679 /* Make sure that a handler is indeed installed */
681 if ((gpe_event_info->flags & ACPI_GPE_DISPATCH_MASK) !=
682 ACPI_GPE_DISPATCH_HANDLER) {
683 status = AE_NOT_EXIST;
684 goto unlock_and_exit;
687 /* Make sure that the installed handler is the same */
689 if (gpe_event_info->dispatch.handler->address != address) {
690 status = AE_BAD_PARAMETER;
691 goto unlock_and_exit;
694 /* Disable the GPE before removing the handler */
696 status = acpi_ev_disable_gpe(gpe_event_info);
697 if (ACPI_FAILURE(status)) {
698 goto unlock_and_exit;
701 /* Make sure all deferred tasks are completed */
703 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
704 acpi_os_wait_events_complete(NULL);
705 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
706 if (ACPI_FAILURE(status)) {
707 return_ACPI_STATUS(status);
710 /* Remove the handler */
712 flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
713 handler = gpe_event_info->dispatch.handler;
715 /* Restore Method node (if any), set dispatch flags */
717 gpe_event_info->dispatch.method_node = handler->method_node;
718 gpe_event_info->flags &= ~ACPI_GPE_DISPATCH_MASK; /* Clear bits */
719 if (handler->method_node) {
720 gpe_event_info->flags |= ACPI_GPE_DISPATCH_METHOD;
722 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
724 /* Now we can free the handler object */
726 ACPI_MEM_FREE(handler);
729 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
730 return_ACPI_STATUS(status);
733 EXPORT_SYMBOL(acpi_remove_gpe_handler);
735 /*******************************************************************************
737 * FUNCTION: acpi_acquire_global_lock
739 * PARAMETERS: Timeout - How long the caller is willing to wait
740 * Handle - Where the handle to the lock is returned
745 * DESCRIPTION: Acquire the ACPI Global Lock
747 ******************************************************************************/
749 acpi_status acpi_acquire_global_lock(u16 timeout, u32 * handle)
754 return (AE_BAD_PARAMETER);
757 status = acpi_ex_enter_interpreter();
758 if (ACPI_FAILURE(status)) {
762 status = acpi_ev_acquire_global_lock(timeout);
763 acpi_ex_exit_interpreter();
765 if (ACPI_SUCCESS(status)) {
766 acpi_gbl_global_lock_handle++;
767 *handle = acpi_gbl_global_lock_handle;
773 EXPORT_SYMBOL(acpi_acquire_global_lock);
775 /*******************************************************************************
777 * FUNCTION: acpi_release_global_lock
779 * PARAMETERS: Handle - Returned from acpi_acquire_global_lock
783 * DESCRIPTION: Release the ACPI Global Lock. The handle must be valid.
785 ******************************************************************************/
787 acpi_status acpi_release_global_lock(u32 handle)
791 if (handle != acpi_gbl_global_lock_handle) {
792 return (AE_NOT_ACQUIRED);
795 status = acpi_ev_release_global_lock();
799 EXPORT_SYMBOL(acpi_release_global_lock);