1 /******************************************************************************
3 * Module Name: evxface - External interfaces for ACPI events
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2006, 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_WARNING((AE_INFO, "Could not enable fixed event %X",
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_WARNING((AE_INFO,
208 "Could not write to fixed event enable register %X",
211 ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Disabled fixed event %X\n",
215 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
216 return_ACPI_STATUS(status);
219 EXPORT_SYMBOL(acpi_remove_fixed_event_handler);
221 /*******************************************************************************
223 * FUNCTION: acpi_install_notify_handler
225 * PARAMETERS: Device - The device for which notifies will be handled
226 * handler_type - The type of handler:
227 * ACPI_SYSTEM_NOTIFY: system_handler (00-7f)
228 * ACPI_DEVICE_NOTIFY: driver_handler (80-ff)
229 * ACPI_ALL_NOTIFY: both system and device
230 * Handler - Address of the handler
231 * Context - Value passed to the handler on each GPE
235 * DESCRIPTION: Install a handler for notifies on an ACPI device
237 ******************************************************************************/
240 acpi_install_notify_handler(acpi_handle device,
242 acpi_notify_handler handler, void *context)
244 union acpi_operand_object *obj_desc;
245 union acpi_operand_object *notify_obj;
246 struct acpi_namespace_node *node;
249 ACPI_FUNCTION_TRACE("acpi_install_notify_handler");
251 /* Parameter validation */
254 (!handler) || (handler_type > ACPI_MAX_NOTIFY_HANDLER_TYPE)) {
255 return_ACPI_STATUS(AE_BAD_PARAMETER);
258 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
259 if (ACPI_FAILURE(status)) {
260 return_ACPI_STATUS(status);
263 /* Convert and validate the device handle */
265 node = acpi_ns_map_handle_to_node(device);
267 status = AE_BAD_PARAMETER;
268 goto unlock_and_exit;
273 * Registering a notify handler on the root object indicates that the
274 * caller wishes to receive notifications for all objects. Note that
275 * only one <external> global handler can be regsitered (per notify type).
277 if (device == ACPI_ROOT_OBJECT) {
278 /* Make sure the handler is not already installed */
280 if (((handler_type & ACPI_SYSTEM_NOTIFY) &&
281 acpi_gbl_system_notify.handler) ||
282 ((handler_type & ACPI_DEVICE_NOTIFY) &&
283 acpi_gbl_device_notify.handler)) {
284 status = AE_ALREADY_EXISTS;
285 goto unlock_and_exit;
288 if (handler_type & ACPI_SYSTEM_NOTIFY) {
289 acpi_gbl_system_notify.node = node;
290 acpi_gbl_system_notify.handler = handler;
291 acpi_gbl_system_notify.context = context;
294 if (handler_type & ACPI_DEVICE_NOTIFY) {
295 acpi_gbl_device_notify.node = node;
296 acpi_gbl_device_notify.handler = handler;
297 acpi_gbl_device_notify.context = context;
300 /* Global notify handler installed */
305 * Caller will only receive notifications specific to the target object.
306 * Note that only certain object types can receive notifications.
309 /* Notifies allowed on this object? */
311 if (!acpi_ev_is_notify_object(node)) {
313 goto unlock_and_exit;
316 /* Check for an existing internal object */
318 obj_desc = acpi_ns_get_attached_object(node);
320 /* Object exists - make sure there's no handler */
322 if (((handler_type & ACPI_SYSTEM_NOTIFY) &&
323 obj_desc->common_notify.system_notify) ||
324 ((handler_type & ACPI_DEVICE_NOTIFY) &&
325 obj_desc->common_notify.device_notify)) {
326 status = AE_ALREADY_EXISTS;
327 goto unlock_and_exit;
330 /* Create a new object */
332 obj_desc = acpi_ut_create_internal_object(node->type);
334 status = AE_NO_MEMORY;
335 goto unlock_and_exit;
338 /* Attach new object to the Node */
341 acpi_ns_attach_object(device, obj_desc, node->type);
343 /* Remove local reference to the object */
345 acpi_ut_remove_reference(obj_desc);
346 if (ACPI_FAILURE(status)) {
347 goto unlock_and_exit;
351 /* Install the handler */
354 acpi_ut_create_internal_object(ACPI_TYPE_LOCAL_NOTIFY);
356 status = AE_NO_MEMORY;
357 goto unlock_and_exit;
360 notify_obj->notify.node = node;
361 notify_obj->notify.handler = handler;
362 notify_obj->notify.context = context;
364 if (handler_type & ACPI_SYSTEM_NOTIFY) {
365 obj_desc->common_notify.system_notify = notify_obj;
368 if (handler_type & ACPI_DEVICE_NOTIFY) {
369 obj_desc->common_notify.device_notify = notify_obj;
372 if (handler_type == ACPI_ALL_NOTIFY) {
373 /* Extra ref if installed in both */
375 acpi_ut_add_reference(notify_obj);
380 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
381 return_ACPI_STATUS(status);
384 EXPORT_SYMBOL(acpi_install_notify_handler);
386 /*******************************************************************************
388 * FUNCTION: acpi_remove_notify_handler
390 * PARAMETERS: Device - The device for which notifies will be handled
391 * handler_type - The type of handler:
392 * ACPI_SYSTEM_NOTIFY: system_handler (00-7f)
393 * ACPI_DEVICE_NOTIFY: driver_handler (80-ff)
394 * ACPI_ALL_NOTIFY: both system and device
395 * Handler - Address of the handler
399 * DESCRIPTION: Remove a handler for notifies on an ACPI device
401 ******************************************************************************/
404 acpi_remove_notify_handler(acpi_handle device,
405 u32 handler_type, acpi_notify_handler handler)
407 union acpi_operand_object *notify_obj;
408 union acpi_operand_object *obj_desc;
409 struct acpi_namespace_node *node;
412 ACPI_FUNCTION_TRACE("acpi_remove_notify_handler");
414 /* Parameter validation */
417 (!handler) || (handler_type > ACPI_MAX_NOTIFY_HANDLER_TYPE)) {
418 return_ACPI_STATUS(AE_BAD_PARAMETER);
421 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
422 if (ACPI_FAILURE(status)) {
423 return_ACPI_STATUS(status);
426 /* Convert and validate the device handle */
428 node = acpi_ns_map_handle_to_node(device);
430 status = AE_BAD_PARAMETER;
431 goto unlock_and_exit;
436 if (device == ACPI_ROOT_OBJECT) {
437 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
438 "Removing notify handler for namespace root object\n"));
440 if (((handler_type & ACPI_SYSTEM_NOTIFY) &&
441 !acpi_gbl_system_notify.handler) ||
442 ((handler_type & ACPI_DEVICE_NOTIFY) &&
443 !acpi_gbl_device_notify.handler)) {
444 status = AE_NOT_EXIST;
445 goto unlock_and_exit;
448 /* Make sure all deferred tasks are completed */
450 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
451 acpi_os_wait_events_complete(NULL);
452 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
453 if (ACPI_FAILURE(status)) {
454 return_ACPI_STATUS(status);
457 if (handler_type & ACPI_SYSTEM_NOTIFY) {
458 acpi_gbl_system_notify.node = NULL;
459 acpi_gbl_system_notify.handler = NULL;
460 acpi_gbl_system_notify.context = NULL;
463 if (handler_type & ACPI_DEVICE_NOTIFY) {
464 acpi_gbl_device_notify.node = NULL;
465 acpi_gbl_device_notify.handler = NULL;
466 acpi_gbl_device_notify.context = NULL;
470 /* All Other Objects */
473 /* Notifies allowed on this object? */
475 if (!acpi_ev_is_notify_object(node)) {
477 goto unlock_and_exit;
480 /* Check for an existing internal object */
482 obj_desc = acpi_ns_get_attached_object(node);
484 status = AE_NOT_EXIST;
485 goto unlock_and_exit;
488 /* Object exists - make sure there's an existing handler */
490 if (handler_type & ACPI_SYSTEM_NOTIFY) {
491 notify_obj = obj_desc->common_notify.system_notify;
493 (notify_obj->notify.handler != handler)) {
494 status = AE_BAD_PARAMETER;
495 goto unlock_and_exit;
497 /* Make sure all deferred tasks are completed */
499 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
500 acpi_os_wait_events_complete(NULL);
501 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
502 if (ACPI_FAILURE(status)) {
503 return_ACPI_STATUS(status);
506 /* Remove the handler */
507 obj_desc->common_notify.system_notify = NULL;
508 acpi_ut_remove_reference(notify_obj);
511 if (handler_type & ACPI_DEVICE_NOTIFY) {
512 notify_obj = obj_desc->common_notify.device_notify;
514 (notify_obj->notify.handler != handler)) {
515 status = AE_BAD_PARAMETER;
516 goto unlock_and_exit;
518 /* Make sure all deferred tasks are completed */
520 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
521 acpi_os_wait_events_complete(NULL);
522 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
523 if (ACPI_FAILURE(status)) {
524 return_ACPI_STATUS(status);
527 /* Remove the handler */
528 obj_desc->common_notify.device_notify = NULL;
529 acpi_ut_remove_reference(notify_obj);
534 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
535 return_ACPI_STATUS(status);
538 EXPORT_SYMBOL(acpi_remove_notify_handler);
540 /*******************************************************************************
542 * FUNCTION: acpi_install_gpe_handler
544 * PARAMETERS: gpe_device - Namespace node for the GPE (NULL for FADT
546 * gpe_number - The GPE number within the GPE block
547 * Type - Whether this GPE should be treated as an
548 * edge- or level-triggered interrupt.
549 * Address - Address of the handler
550 * Context - Value passed to the handler on each GPE
554 * DESCRIPTION: Install a handler for a General Purpose Event.
556 ******************************************************************************/
559 acpi_install_gpe_handler(acpi_handle gpe_device,
561 u32 type, acpi_event_handler address, void *context)
563 struct acpi_gpe_event_info *gpe_event_info;
564 struct acpi_handler_info *handler;
566 acpi_cpu_flags flags;
568 ACPI_FUNCTION_TRACE("acpi_install_gpe_handler");
570 /* Parameter validation */
572 if ((!address) || (type > ACPI_GPE_XRUPT_TYPE_MASK)) {
573 return_ACPI_STATUS(AE_BAD_PARAMETER);
576 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
577 if (ACPI_FAILURE(status)) {
578 return_ACPI_STATUS(status);
581 /* Ensure that we have a valid GPE number */
583 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
584 if (!gpe_event_info) {
585 status = AE_BAD_PARAMETER;
586 goto unlock_and_exit;
589 /* Make sure that there isn't a handler there already */
591 if ((gpe_event_info->flags & ACPI_GPE_DISPATCH_MASK) ==
592 ACPI_GPE_DISPATCH_HANDLER) {
593 status = AE_ALREADY_EXISTS;
594 goto unlock_and_exit;
597 /* Allocate and init handler object */
599 handler = ACPI_MEM_CALLOCATE(sizeof(struct acpi_handler_info));
601 status = AE_NO_MEMORY;
602 goto unlock_and_exit;
605 handler->address = address;
606 handler->context = context;
607 handler->method_node = gpe_event_info->dispatch.method_node;
609 /* Disable the GPE before installing the handler */
611 status = acpi_ev_disable_gpe(gpe_event_info);
612 if (ACPI_FAILURE(status)) {
613 goto unlock_and_exit;
616 /* Install the handler */
618 flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
619 gpe_event_info->dispatch.handler = handler;
621 /* Setup up dispatch flags to indicate handler (vs. method) */
623 gpe_event_info->flags &= ~(ACPI_GPE_XRUPT_TYPE_MASK | ACPI_GPE_DISPATCH_MASK); /* Clear bits */
624 gpe_event_info->flags |= (u8) (type | ACPI_GPE_DISPATCH_HANDLER);
626 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
629 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
630 return_ACPI_STATUS(status);
633 EXPORT_SYMBOL(acpi_install_gpe_handler);
635 /*******************************************************************************
637 * FUNCTION: acpi_remove_gpe_handler
639 * PARAMETERS: gpe_device - Namespace node for the GPE (NULL for FADT
641 * gpe_number - The event to remove a handler
642 * Address - Address of the handler
646 * DESCRIPTION: Remove a handler for a General Purpose acpi_event.
648 ******************************************************************************/
651 acpi_remove_gpe_handler(acpi_handle gpe_device,
652 u32 gpe_number, acpi_event_handler address)
654 struct acpi_gpe_event_info *gpe_event_info;
655 struct acpi_handler_info *handler;
657 acpi_cpu_flags flags;
659 ACPI_FUNCTION_TRACE("acpi_remove_gpe_handler");
661 /* Parameter validation */
664 return_ACPI_STATUS(AE_BAD_PARAMETER);
667 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
668 if (ACPI_FAILURE(status)) {
669 return_ACPI_STATUS(status);
672 /* Ensure that we have a valid GPE number */
674 gpe_event_info = acpi_ev_get_gpe_event_info(gpe_device, gpe_number);
675 if (!gpe_event_info) {
676 status = AE_BAD_PARAMETER;
677 goto unlock_and_exit;
680 /* Make sure that a handler is indeed installed */
682 if ((gpe_event_info->flags & ACPI_GPE_DISPATCH_MASK) !=
683 ACPI_GPE_DISPATCH_HANDLER) {
684 status = AE_NOT_EXIST;
685 goto unlock_and_exit;
688 /* Make sure that the installed handler is the same */
690 if (gpe_event_info->dispatch.handler->address != address) {
691 status = AE_BAD_PARAMETER;
692 goto unlock_and_exit;
695 /* Disable the GPE before removing the handler */
697 status = acpi_ev_disable_gpe(gpe_event_info);
698 if (ACPI_FAILURE(status)) {
699 goto unlock_and_exit;
702 /* Make sure all deferred tasks are completed */
704 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
705 acpi_os_wait_events_complete(NULL);
706 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
707 if (ACPI_FAILURE(status)) {
708 return_ACPI_STATUS(status);
711 /* Remove the handler */
713 flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
714 handler = gpe_event_info->dispatch.handler;
716 /* Restore Method node (if any), set dispatch flags */
718 gpe_event_info->dispatch.method_node = handler->method_node;
719 gpe_event_info->flags &= ~ACPI_GPE_DISPATCH_MASK; /* Clear bits */
720 if (handler->method_node) {
721 gpe_event_info->flags |= ACPI_GPE_DISPATCH_METHOD;
723 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
725 /* Now we can free the handler object */
727 ACPI_MEM_FREE(handler);
730 (void)acpi_ut_release_mutex(ACPI_MTX_EVENTS);
731 return_ACPI_STATUS(status);
734 EXPORT_SYMBOL(acpi_remove_gpe_handler);
736 /*******************************************************************************
738 * FUNCTION: acpi_acquire_global_lock
740 * PARAMETERS: Timeout - How long the caller is willing to wait
741 * Handle - Where the handle to the lock is returned
746 * DESCRIPTION: Acquire the ACPI Global Lock
748 ******************************************************************************/
750 acpi_status acpi_acquire_global_lock(u16 timeout, u32 * handle)
755 return (AE_BAD_PARAMETER);
758 status = acpi_ex_enter_interpreter();
759 if (ACPI_FAILURE(status)) {
763 status = acpi_ev_acquire_global_lock(timeout);
764 acpi_ex_exit_interpreter();
766 if (ACPI_SUCCESS(status)) {
767 acpi_gbl_global_lock_handle++;
768 *handle = acpi_gbl_global_lock_handle;
774 EXPORT_SYMBOL(acpi_acquire_global_lock);
776 /*******************************************************************************
778 * FUNCTION: acpi_release_global_lock
780 * PARAMETERS: Handle - Returned from acpi_acquire_global_lock
784 * DESCRIPTION: Release the ACPI Global Lock. The handle must be valid.
786 ******************************************************************************/
788 acpi_status acpi_release_global_lock(u32 handle)
792 if (handle != acpi_gbl_global_lock_handle) {
793 return (AE_NOT_ACQUIRED);
796 status = acpi_ev_release_global_lock();
800 EXPORT_SYMBOL(acpi_release_global_lock);