1 /******************************************************************************
3 * Module Name: evgpe - General Purpose Event handling and dispatch
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 <acpi/acpi.h>
45 #include <acpi/acevents.h>
46 #include <acpi/acnamesp.h>
48 #define _COMPONENT ACPI_EVENTS
49 ACPI_MODULE_NAME("evgpe")
51 /* Local prototypes */
52 static void ACPI_SYSTEM_XFACE acpi_ev_asynch_execute_gpe_method(void *context);
54 /*******************************************************************************
56 * FUNCTION: acpi_ev_set_gpe_type
58 * PARAMETERS: gpe_event_info - GPE to set
63 * DESCRIPTION: Sets the new type for the GPE (wake, run, or wake/run)
65 ******************************************************************************/
68 acpi_ev_set_gpe_type(struct acpi_gpe_event_info *gpe_event_info, u8 type)
72 ACPI_FUNCTION_TRACE(ev_set_gpe_type);
74 /* Validate type and update register enable masks */
77 case ACPI_GPE_TYPE_WAKE:
78 case ACPI_GPE_TYPE_RUNTIME:
79 case ACPI_GPE_TYPE_WAKE_RUN:
83 return_ACPI_STATUS(AE_BAD_PARAMETER);
86 /* Disable the GPE if currently enabled */
88 status = acpi_ev_disable_gpe(gpe_event_info);
90 /* Type was validated above */
92 gpe_event_info->flags &= ~ACPI_GPE_TYPE_MASK; /* Clear type bits */
93 gpe_event_info->flags |= type; /* Insert type */
94 return_ACPI_STATUS(status);
97 /*******************************************************************************
99 * FUNCTION: acpi_ev_update_gpe_enable_masks
101 * PARAMETERS: gpe_event_info - GPE to update
102 * Type - What to do: ACPI_GPE_DISABLE or
107 * DESCRIPTION: Updates GPE register enable masks based on the GPE type
109 ******************************************************************************/
112 acpi_ev_update_gpe_enable_masks(struct acpi_gpe_event_info *gpe_event_info,
115 struct acpi_gpe_register_info *gpe_register_info;
118 ACPI_FUNCTION_TRACE(ev_update_gpe_enable_masks);
120 gpe_register_info = gpe_event_info->register_info;
121 if (!gpe_register_info) {
122 return_ACPI_STATUS(AE_NOT_EXIST);
124 register_bit = gpe_event_info->register_bit;
126 /* 1) Disable case. Simply clear all enable bits */
128 if (type == ACPI_GPE_DISABLE) {
129 ACPI_CLEAR_BIT(gpe_register_info->enable_for_wake,
131 ACPI_CLEAR_BIT(gpe_register_info->enable_for_run, register_bit);
132 return_ACPI_STATUS(AE_OK);
135 /* 2) Enable case. Set/Clear the appropriate enable bits */
137 switch (gpe_event_info->flags & ACPI_GPE_TYPE_MASK) {
138 case ACPI_GPE_TYPE_WAKE:
139 ACPI_SET_BIT(gpe_register_info->enable_for_wake, register_bit);
140 ACPI_CLEAR_BIT(gpe_register_info->enable_for_run, register_bit);
143 case ACPI_GPE_TYPE_RUNTIME:
144 ACPI_CLEAR_BIT(gpe_register_info->enable_for_wake,
146 ACPI_SET_BIT(gpe_register_info->enable_for_run, register_bit);
149 case ACPI_GPE_TYPE_WAKE_RUN:
150 ACPI_SET_BIT(gpe_register_info->enable_for_wake, register_bit);
151 ACPI_SET_BIT(gpe_register_info->enable_for_run, register_bit);
155 return_ACPI_STATUS(AE_BAD_PARAMETER);
158 return_ACPI_STATUS(AE_OK);
161 /*******************************************************************************
163 * FUNCTION: acpi_ev_enable_gpe
165 * PARAMETERS: gpe_event_info - GPE to enable
166 * write_to_hardware - Enable now, or just mark data structs
167 * (WAKE GPEs should be deferred)
171 * DESCRIPTION: Enable a GPE based on the GPE type
173 ******************************************************************************/
176 acpi_ev_enable_gpe(struct acpi_gpe_event_info *gpe_event_info,
177 u8 write_to_hardware)
181 ACPI_FUNCTION_TRACE(ev_enable_gpe);
183 /* Make sure HW enable masks are updated */
186 acpi_ev_update_gpe_enable_masks(gpe_event_info, ACPI_GPE_ENABLE);
187 if (ACPI_FAILURE(status)) {
188 return_ACPI_STATUS(status);
191 /* Mark wake-enabled or HW enable, or both */
193 switch (gpe_event_info->flags & ACPI_GPE_TYPE_MASK) {
194 case ACPI_GPE_TYPE_WAKE:
196 ACPI_SET_BIT(gpe_event_info->flags, ACPI_GPE_WAKE_ENABLED);
199 case ACPI_GPE_TYPE_WAKE_RUN:
201 ACPI_SET_BIT(gpe_event_info->flags, ACPI_GPE_WAKE_ENABLED);
203 /*lint -fallthrough */
205 case ACPI_GPE_TYPE_RUNTIME:
207 ACPI_SET_BIT(gpe_event_info->flags, ACPI_GPE_RUN_ENABLED);
209 if (write_to_hardware) {
211 /* Clear the GPE (of stale events), then enable it */
213 status = acpi_hw_clear_gpe(gpe_event_info);
214 if (ACPI_FAILURE(status)) {
215 return_ACPI_STATUS(status);
218 /* Enable the requested runtime GPE */
220 status = acpi_hw_write_gpe_enable_reg(gpe_event_info);
225 return_ACPI_STATUS(AE_BAD_PARAMETER);
228 return_ACPI_STATUS(AE_OK);
231 /*******************************************************************************
233 * FUNCTION: acpi_ev_disable_gpe
235 * PARAMETERS: gpe_event_info - GPE to disable
239 * DESCRIPTION: Disable a GPE based on the GPE type
241 ******************************************************************************/
243 acpi_status acpi_ev_disable_gpe(struct acpi_gpe_event_info *gpe_event_info)
247 ACPI_FUNCTION_TRACE(ev_disable_gpe);
249 if (!(gpe_event_info->flags & ACPI_GPE_ENABLE_MASK)) {
250 return_ACPI_STATUS(AE_OK);
253 /* Make sure HW enable masks are updated */
256 acpi_ev_update_gpe_enable_masks(gpe_event_info, ACPI_GPE_DISABLE);
257 if (ACPI_FAILURE(status)) {
258 return_ACPI_STATUS(status);
261 /* Mark wake-disabled or HW disable, or both */
263 switch (gpe_event_info->flags & ACPI_GPE_TYPE_MASK) {
264 case ACPI_GPE_TYPE_WAKE:
265 ACPI_CLEAR_BIT(gpe_event_info->flags, ACPI_GPE_WAKE_ENABLED);
268 case ACPI_GPE_TYPE_WAKE_RUN:
269 ACPI_CLEAR_BIT(gpe_event_info->flags, ACPI_GPE_WAKE_ENABLED);
271 /*lint -fallthrough */
273 case ACPI_GPE_TYPE_RUNTIME:
275 /* Disable the requested runtime GPE */
277 ACPI_CLEAR_BIT(gpe_event_info->flags, ACPI_GPE_RUN_ENABLED);
278 status = acpi_hw_write_gpe_enable_reg(gpe_event_info);
282 return_ACPI_STATUS(AE_BAD_PARAMETER);
285 return_ACPI_STATUS(AE_OK);
288 /*******************************************************************************
290 * FUNCTION: acpi_ev_get_gpe_event_info
292 * PARAMETERS: gpe_device - Device node. NULL for GPE0/GPE1
293 * gpe_number - Raw GPE number
295 * RETURN: A GPE event_info struct. NULL if not a valid GPE
297 * DESCRIPTION: Returns the event_info struct associated with this GPE.
298 * Validates the gpe_block and the gpe_number
300 * Should be called only when the GPE lists are semaphore locked
301 * and not subject to change.
303 ******************************************************************************/
305 struct acpi_gpe_event_info *acpi_ev_get_gpe_event_info(acpi_handle gpe_device,
308 union acpi_operand_object *obj_desc;
309 struct acpi_gpe_block_info *gpe_block;
312 ACPI_FUNCTION_ENTRY();
314 /* A NULL gpe_block means use the FADT-defined GPE block(s) */
318 /* Examine GPE Block 0 and 1 (These blocks are permanent) */
320 for (i = 0; i < ACPI_MAX_GPE_BLOCKS; i++) {
321 gpe_block = acpi_gbl_gpe_fadt_blocks[i];
323 if ((gpe_number >= gpe_block->block_base_number)
325 gpe_block->block_base_number +
326 (gpe_block->register_count * 8))) {
328 event_info[gpe_number -
335 /* The gpe_number was not in the range of either FADT GPE block */
340 /* A Non-NULL gpe_device means this is a GPE Block Device */
343 acpi_ns_get_attached_object((struct acpi_namespace_node *)
345 if (!obj_desc || !obj_desc->device.gpe_block) {
349 gpe_block = obj_desc->device.gpe_block;
351 if ((gpe_number >= gpe_block->block_base_number) &&
353 gpe_block->block_base_number + (gpe_block->register_count * 8))) {
355 event_info[gpe_number - gpe_block->block_base_number]);
361 /*******************************************************************************
363 * FUNCTION: acpi_ev_gpe_detect
365 * PARAMETERS: gpe_xrupt_list - Interrupt block for this interrupt.
366 * Can have multiple GPE blocks attached.
368 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
370 * DESCRIPTION: Detect if any GP events have occurred. This function is
371 * executed at interrupt level.
373 ******************************************************************************/
375 u32 acpi_ev_gpe_detect(struct acpi_gpe_xrupt_info * gpe_xrupt_list)
378 struct acpi_gpe_block_info *gpe_block;
379 struct acpi_gpe_register_info *gpe_register_info;
380 u32 int_status = ACPI_INTERRUPT_NOT_HANDLED;
381 u8 enabled_status_byte;
384 acpi_cpu_flags flags;
385 acpi_cpu_flags hw_flags;
389 ACPI_FUNCTION_NAME(ev_gpe_detect);
391 /* Check for the case where there are no GPEs */
393 if (!gpe_xrupt_list) {
397 /* We need to hold the GPE lock now, hardware lock in the loop */
399 flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
401 /* Examine all GPE blocks attached to this interrupt level */
403 gpe_block = gpe_xrupt_list->gpe_block_list_head;
406 * Read all of the 8-bit GPE status and enable registers
407 * in this GPE block, saving all of them.
408 * Find all currently active GP events.
410 for (i = 0; i < gpe_block->register_count; i++) {
412 /* Get the next status/enable pair */
414 gpe_register_info = &gpe_block->register_info[i];
416 hw_flags = acpi_os_acquire_lock(acpi_gbl_hardware_lock);
418 /* Read the Status Register */
421 acpi_hw_low_level_read(ACPI_GPE_REGISTER_WIDTH,
425 if (ACPI_FAILURE(status)) {
426 acpi_os_release_lock(acpi_gbl_hardware_lock,
428 goto unlock_and_exit;
431 /* Read the Enable Register */
434 acpi_hw_low_level_read(ACPI_GPE_REGISTER_WIDTH,
438 acpi_os_release_lock(acpi_gbl_hardware_lock, hw_flags);
440 if (ACPI_FAILURE(status)) {
441 goto unlock_and_exit;
444 ACPI_DEBUG_PRINT((ACPI_DB_INTERRUPTS,
445 "Read GPE Register at GPE%X: Status=%02X, Enable=%02X\n",
446 gpe_register_info->base_gpe_number,
447 status_reg, enable_reg));
449 /* Check if there is anything active at all in this register */
451 enabled_status_byte = (u8) (status_reg & enable_reg);
452 if (!enabled_status_byte) {
454 /* No active GPEs in this register, move on */
459 /* Now look at the individual GPEs in this byte register */
461 for (j = 0; j < ACPI_GPE_REGISTER_WIDTH; j++) {
463 /* Examine one GPE bit */
465 if (enabled_status_byte &
466 acpi_gbl_decode_to8bit[j]) {
468 * Found an active GPE. Dispatch the event to a handler
472 acpi_ev_gpe_dispatch(&gpe_block->
474 ACPI_GPE_REGISTER_WIDTH)
484 gpe_block = gpe_block->next;
489 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
493 /*******************************************************************************
495 * FUNCTION: acpi_ev_asynch_execute_gpe_method
497 * PARAMETERS: Context (gpe_event_info) - Info for this GPE
501 * DESCRIPTION: Perform the actual execution of a GPE control method. This
502 * function is called from an invocation of acpi_os_execute and
503 * therefore does NOT execute at interrupt level - so that
504 * the control method itself is not executed in the context of
505 * an interrupt handler.
507 ******************************************************************************/
509 static void ACPI_SYSTEM_XFACE acpi_ev_asynch_execute_gpe_method(void *context)
511 struct acpi_gpe_event_info *gpe_event_info = (void *)context;
513 struct acpi_gpe_event_info local_gpe_event_info;
514 struct acpi_evaluate_info *info;
516 ACPI_FUNCTION_TRACE(ev_asynch_execute_gpe_method);
518 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
519 if (ACPI_FAILURE(status)) {
523 /* Must revalidate the gpe_number/gpe_block */
525 if (!acpi_ev_valid_gpe_event(gpe_event_info)) {
526 status = acpi_ut_release_mutex(ACPI_MTX_EVENTS);
530 /* Set the GPE flags for return to enabled state */
532 (void)acpi_ev_enable_gpe(gpe_event_info, FALSE);
535 * Take a snapshot of the GPE info for this level - we copy the
536 * info to prevent a race condition with remove_handler/remove_block.
538 ACPI_MEMCPY(&local_gpe_event_info, gpe_event_info,
539 sizeof(struct acpi_gpe_event_info));
541 status = acpi_ut_release_mutex(ACPI_MTX_EVENTS);
542 if (ACPI_FAILURE(status)) {
547 * Must check for control method type dispatch one more
548 * time to avoid race with ev_gpe_install_handler
550 if ((local_gpe_event_info.flags & ACPI_GPE_DISPATCH_MASK) ==
551 ACPI_GPE_DISPATCH_METHOD) {
553 /* Allocate the evaluation information block */
555 info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
557 status = AE_NO_MEMORY;
560 * Invoke the GPE Method (_Lxx, _Exx) i.e., evaluate the _Lxx/_Exx
561 * control method that corresponds to this GPE
564 local_gpe_event_info.dispatch.method_node;
566 ACPI_CAST_PTR(union acpi_operand_object *,
568 info->parameter_type = ACPI_PARAM_GPE;
569 info->flags = ACPI_IGNORE_RETURN_VALUE;
571 status = acpi_ns_evaluate(info);
575 if (ACPI_FAILURE(status)) {
576 ACPI_EXCEPTION((AE_INFO, status,
577 "While evaluating GPE method [%4.4s]",
578 acpi_ut_get_node_name
579 (local_gpe_event_info.dispatch.
584 if ((local_gpe_event_info.flags & ACPI_GPE_XRUPT_TYPE_MASK) ==
585 ACPI_GPE_LEVEL_TRIGGERED) {
587 * GPE is level-triggered, we clear the GPE status bit after
588 * handling the event.
590 status = acpi_hw_clear_gpe(&local_gpe_event_info);
591 if (ACPI_FAILURE(status)) {
596 /* Enable this GPE */
598 (void)acpi_hw_write_gpe_enable_reg(&local_gpe_event_info);
602 /*******************************************************************************
604 * FUNCTION: acpi_ev_gpe_dispatch
606 * PARAMETERS: gpe_event_info - Info for this GPE
607 * gpe_number - Number relative to the parent GPE block
609 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
611 * DESCRIPTION: Dispatch a General Purpose Event to either a function (e.g. EC)
612 * or method (e.g. _Lxx/_Exx) handler.
614 * This function executes at interrupt level.
616 ******************************************************************************/
619 acpi_ev_gpe_dispatch(struct acpi_gpe_event_info *gpe_event_info, u32 gpe_number)
623 ACPI_FUNCTION_TRACE(ev_gpe_dispatch);
626 * If edge-triggered, clear the GPE status bit now. Note that
627 * level-triggered events are cleared after the GPE is serviced.
629 if ((gpe_event_info->flags & ACPI_GPE_XRUPT_TYPE_MASK) ==
630 ACPI_GPE_EDGE_TRIGGERED) {
631 status = acpi_hw_clear_gpe(gpe_event_info);
632 if (ACPI_FAILURE(status)) {
633 ACPI_EXCEPTION((AE_INFO, status,
634 "Unable to clear GPE[%2X]",
636 return_UINT32(ACPI_INTERRUPT_NOT_HANDLED);
640 /* Save current system state */
642 if (acpi_gbl_system_awake_and_running) {
643 ACPI_SET_BIT(gpe_event_info->flags, ACPI_GPE_SYSTEM_RUNNING);
645 ACPI_CLEAR_BIT(gpe_event_info->flags, ACPI_GPE_SYSTEM_RUNNING);
649 * Dispatch the GPE to either an installed handler, or the control
650 * method associated with this GPE (_Lxx or _Exx).
651 * If a handler exists, we invoke it and do not attempt to run the method.
652 * If there is neither a handler nor a method, we disable the level to
653 * prevent further events from coming in here.
655 switch (gpe_event_info->flags & ACPI_GPE_DISPATCH_MASK) {
656 case ACPI_GPE_DISPATCH_HANDLER:
659 * Invoke the installed handler (at interrupt level)
660 * Ignore return status for now. TBD: leave GPE disabled on error?
662 (void)gpe_event_info->dispatch.handler->address(gpe_event_info->
667 /* It is now safe to clear level-triggered events. */
669 if ((gpe_event_info->flags & ACPI_GPE_XRUPT_TYPE_MASK) ==
670 ACPI_GPE_LEVEL_TRIGGERED) {
671 status = acpi_hw_clear_gpe(gpe_event_info);
672 if (ACPI_FAILURE(status)) {
673 ACPI_EXCEPTION((AE_INFO, status,
674 "Unable to clear GPE[%2X]",
676 return_UINT32(ACPI_INTERRUPT_NOT_HANDLED);
681 case ACPI_GPE_DISPATCH_METHOD:
684 * Disable GPE, so it doesn't keep firing before the method has a
687 status = acpi_ev_disable_gpe(gpe_event_info);
688 if (ACPI_FAILURE(status)) {
689 ACPI_EXCEPTION((AE_INFO, status,
690 "Unable to disable GPE[%2X]",
692 return_UINT32(ACPI_INTERRUPT_NOT_HANDLED);
696 * Execute the method associated with the GPE
697 * NOTE: Level-triggered GPEs are cleared after the method completes.
699 status = acpi_os_execute(OSL_GPE_HANDLER,
700 acpi_ev_asynch_execute_gpe_method,
702 if (ACPI_FAILURE(status)) {
703 ACPI_EXCEPTION((AE_INFO, status,
704 "Unable to queue handler for GPE[%2X] - event disabled",
711 /* No handler or method to run! */
714 "No handler or method for GPE[%2X], disabling event",
718 * Disable the GPE. The GPE will remain disabled until the ACPI
719 * Core Subsystem is restarted, or a handler is installed.
721 status = acpi_ev_disable_gpe(gpe_event_info);
722 if (ACPI_FAILURE(status)) {
723 ACPI_EXCEPTION((AE_INFO, status,
724 "Unable to disable GPE[%2X]",
726 return_UINT32(ACPI_INTERRUPT_NOT_HANDLED);
731 return_UINT32(ACPI_INTERRUPT_HANDLED);
734 #ifdef ACPI_GPE_NOTIFY_CHECK
735 /*******************************************************************************
736 * TBD: NOT USED, PROTOTYPE ONLY AND WILL PROBABLY BE REMOVED
738 * FUNCTION: acpi_ev_check_for_wake_only_gpe
740 * PARAMETERS: gpe_event_info - info for this GPE
744 * DESCRIPTION: Determine if a a GPE is "wake-only".
746 * Called from Notify() code in interpreter when a "DeviceWake"
749 ******************************************************************************/
752 acpi_ev_check_for_wake_only_gpe(struct acpi_gpe_event_info *gpe_event_info)
756 ACPI_FUNCTION_TRACE(ev_check_for_wake_only_gpe);
758 if ((gpe_event_info) && /* Only >0 for _Lxx/_Exx */
759 ((gpe_event_info->flags & ACPI_GPE_SYSTEM_MASK) == ACPI_GPE_SYSTEM_RUNNING)) { /* System state at GPE time */
760 /* This must be a wake-only GPE, disable it */
762 status = acpi_ev_disable_gpe(gpe_event_info);
764 /* Set GPE to wake-only. Do not change wake disabled/enabled status */
766 acpi_ev_set_gpe_type(gpe_event_info, ACPI_GPE_TYPE_WAKE);
769 "GPE %p was updated from wake/run to wake-only",
772 /* This was a wake-only GPE */
774 return_ACPI_STATUS(AE_WAKE_ONLY_GPE);
777 return_ACPI_STATUS(AE_OK);