1 /******************************************************************************
3 * Module Name: evgpe - General Purpose Event handling and dispatch
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 <acpi/acpi.h>
45 #include <acpi/acevents.h>
46 #include <acpi/acnamesp.h>
48 #define _COMPONENT ACPI_EVENTS
49 ACPI_MODULE_NAME ("evgpe")
52 /*******************************************************************************
54 * FUNCTION: acpi_ev_set_gpe_type
56 * PARAMETERS: gpe_event_info - GPE to set
61 * DESCRIPTION: Sets the new type for the GPE (wake, run, or wake/run)
63 ******************************************************************************/
66 acpi_ev_set_gpe_type (
67 struct acpi_gpe_event_info *gpe_event_info,
73 ACPI_FUNCTION_TRACE ("ev_set_gpe_type");
76 /* Validate type and update register enable masks */
79 case ACPI_GPE_TYPE_WAKE:
80 case ACPI_GPE_TYPE_RUNTIME:
81 case ACPI_GPE_TYPE_WAKE_RUN:
85 return_ACPI_STATUS (AE_BAD_PARAMETER);
88 /* Disable the GPE if currently enabled */
90 status = acpi_ev_disable_gpe (gpe_event_info);
92 /* Type was validated above */
94 gpe_event_info->flags &= ~ACPI_GPE_TYPE_MASK; /* Clear type bits */
95 gpe_event_info->flags |= type; /* Insert type */
96 return_ACPI_STATUS (status);
100 /*******************************************************************************
102 * FUNCTION: acpi_ev_update_gpe_enable_masks
104 * PARAMETERS: gpe_event_info - GPE to update
105 * Type - What to do: ACPI_GPE_DISABLE or
110 * DESCRIPTION: Updates GPE register enable masks based on the GPE type
112 ******************************************************************************/
115 acpi_ev_update_gpe_enable_masks (
116 struct acpi_gpe_event_info *gpe_event_info,
119 struct acpi_gpe_register_info *gpe_register_info;
123 ACPI_FUNCTION_TRACE ("ev_update_gpe_enable_masks");
126 gpe_register_info = gpe_event_info->register_info;
127 if (!gpe_register_info) {
128 return_ACPI_STATUS (AE_NOT_EXIST);
130 register_bit = gpe_event_info->register_bit;
132 /* 1) Disable case. Simply clear all enable bits */
134 if (type == ACPI_GPE_DISABLE) {
135 ACPI_CLEAR_BIT (gpe_register_info->enable_for_wake, register_bit);
136 ACPI_CLEAR_BIT (gpe_register_info->enable_for_run, register_bit);
137 return_ACPI_STATUS (AE_OK);
140 /* 2) Enable case. Set/Clear the appropriate enable bits */
142 switch (gpe_event_info->flags & ACPI_GPE_TYPE_MASK) {
143 case ACPI_GPE_TYPE_WAKE:
144 ACPI_SET_BIT (gpe_register_info->enable_for_wake, register_bit);
145 ACPI_CLEAR_BIT (gpe_register_info->enable_for_run, register_bit);
148 case ACPI_GPE_TYPE_RUNTIME:
149 ACPI_CLEAR_BIT (gpe_register_info->enable_for_wake, register_bit);
150 ACPI_SET_BIT (gpe_register_info->enable_for_run, register_bit);
153 case ACPI_GPE_TYPE_WAKE_RUN:
154 ACPI_SET_BIT (gpe_register_info->enable_for_wake, register_bit);
155 ACPI_SET_BIT (gpe_register_info->enable_for_run, register_bit);
159 return_ACPI_STATUS (AE_BAD_PARAMETER);
162 return_ACPI_STATUS (AE_OK);
166 /*******************************************************************************
168 * FUNCTION: acpi_ev_enable_gpe
170 * PARAMETERS: gpe_event_info - GPE to enable
171 * write_to_hardware - Enable now, or just mark data structs
172 * (WAKE GPEs should be deferred)
176 * DESCRIPTION: Enable a GPE based on the GPE type
178 ******************************************************************************/
182 struct acpi_gpe_event_info *gpe_event_info,
183 u8 write_to_hardware)
188 ACPI_FUNCTION_TRACE ("ev_enable_gpe");
191 /* Make sure HW enable masks are updated */
193 status = acpi_ev_update_gpe_enable_masks (gpe_event_info, ACPI_GPE_ENABLE);
194 if (ACPI_FAILURE (status)) {
195 return_ACPI_STATUS (status);
198 /* Mark wake-enabled or HW enable, or both */
200 switch (gpe_event_info->flags & ACPI_GPE_TYPE_MASK) {
201 case ACPI_GPE_TYPE_WAKE:
203 ACPI_SET_BIT (gpe_event_info->flags, ACPI_GPE_WAKE_ENABLED);
206 case ACPI_GPE_TYPE_WAKE_RUN:
208 ACPI_SET_BIT (gpe_event_info->flags, ACPI_GPE_WAKE_ENABLED);
210 /*lint -fallthrough */
212 case ACPI_GPE_TYPE_RUNTIME:
214 ACPI_SET_BIT (gpe_event_info->flags, ACPI_GPE_RUN_ENABLED);
216 if (write_to_hardware) {
217 /* Clear the GPE (of stale events), then enable it */
219 status = acpi_hw_clear_gpe (gpe_event_info);
220 if (ACPI_FAILURE (status)) {
221 return_ACPI_STATUS (status);
224 /* Enable the requested runtime GPE */
226 status = acpi_hw_write_gpe_enable_reg (gpe_event_info);
231 return_ACPI_STATUS (AE_BAD_PARAMETER);
234 return_ACPI_STATUS (AE_OK);
238 /*******************************************************************************
240 * FUNCTION: acpi_ev_disable_gpe
242 * PARAMETERS: gpe_event_info - GPE to disable
246 * DESCRIPTION: Disable a GPE based on the GPE type
248 ******************************************************************************/
251 acpi_ev_disable_gpe (
252 struct acpi_gpe_event_info *gpe_event_info)
257 ACPI_FUNCTION_TRACE ("ev_disable_gpe");
260 if (!(gpe_event_info->flags & ACPI_GPE_ENABLE_MASK)) {
261 return_ACPI_STATUS (AE_OK);
264 /* Make sure HW enable masks are updated */
266 status = acpi_ev_update_gpe_enable_masks (gpe_event_info, ACPI_GPE_DISABLE);
267 if (ACPI_FAILURE (status)) {
268 return_ACPI_STATUS (status);
271 /* Mark wake-disabled or HW disable, or both */
273 switch (gpe_event_info->flags & ACPI_GPE_TYPE_MASK) {
274 case ACPI_GPE_TYPE_WAKE:
275 ACPI_CLEAR_BIT (gpe_event_info->flags, ACPI_GPE_WAKE_ENABLED);
278 case ACPI_GPE_TYPE_WAKE_RUN:
279 ACPI_CLEAR_BIT (gpe_event_info->flags, ACPI_GPE_WAKE_ENABLED);
281 /*lint -fallthrough */
283 case ACPI_GPE_TYPE_RUNTIME:
285 /* Disable the requested runtime GPE */
287 ACPI_CLEAR_BIT (gpe_event_info->flags, ACPI_GPE_RUN_ENABLED);
288 status = acpi_hw_write_gpe_enable_reg (gpe_event_info);
292 return_ACPI_STATUS (AE_BAD_PARAMETER);
295 return_ACPI_STATUS (AE_OK);
299 /*******************************************************************************
301 * FUNCTION: acpi_ev_get_gpe_event_info
303 * PARAMETERS: gpe_device - Device node. NULL for GPE0/GPE1
304 * gpe_number - Raw GPE number
306 * RETURN: A GPE event_info struct. NULL if not a valid GPE
308 * DESCRIPTION: Returns the event_info struct associated with this GPE.
309 * Validates the gpe_block and the gpe_number
311 * Should be called only when the GPE lists are semaphore locked
312 * and not subject to change.
314 ******************************************************************************/
316 struct acpi_gpe_event_info *
317 acpi_ev_get_gpe_event_info (
318 acpi_handle gpe_device,
321 union acpi_operand_object *obj_desc;
322 struct acpi_gpe_block_info *gpe_block;
326 ACPI_FUNCTION_ENTRY ();
329 /* A NULL gpe_block means use the FADT-defined GPE block(s) */
332 /* Examine GPE Block 0 and 1 (These blocks are permanent) */
334 for (i = 0; i < ACPI_MAX_GPE_BLOCKS; i++) {
335 gpe_block = acpi_gbl_gpe_fadt_blocks[i];
337 if ((gpe_number >= gpe_block->block_base_number) &&
338 (gpe_number < gpe_block->block_base_number + (gpe_block->register_count * 8))) {
339 return (&gpe_block->event_info[gpe_number - gpe_block->block_base_number]);
344 /* The gpe_number was not in the range of either FADT GPE block */
349 /* A Non-NULL gpe_device means this is a GPE Block Device */
351 obj_desc = acpi_ns_get_attached_object ((struct acpi_namespace_node *) gpe_device);
353 !obj_desc->device.gpe_block) {
357 gpe_block = obj_desc->device.gpe_block;
359 if ((gpe_number >= gpe_block->block_base_number) &&
360 (gpe_number < gpe_block->block_base_number + (gpe_block->register_count * 8))) {
361 return (&gpe_block->event_info[gpe_number - gpe_block->block_base_number]);
368 /*******************************************************************************
370 * FUNCTION: acpi_ev_gpe_detect
372 * PARAMETERS: gpe_xrupt_list - Interrupt block for this interrupt.
373 * Can have multiple GPE blocks attached.
375 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
377 * DESCRIPTION: Detect if any GP events have occurred. This function is
378 * executed at interrupt level.
380 ******************************************************************************/
384 struct acpi_gpe_xrupt_info *gpe_xrupt_list)
386 u32 int_status = ACPI_INTERRUPT_NOT_HANDLED;
387 u8 enabled_status_byte;
388 struct acpi_gpe_register_info *gpe_register_info;
392 struct acpi_gpe_block_info *gpe_block;
397 ACPI_FUNCTION_NAME ("ev_gpe_detect");
399 /* Check for the case where there are no GPEs */
401 if (!gpe_xrupt_list) {
405 /* Examine all GPE blocks attached to this interrupt level */
407 acpi_os_acquire_lock (acpi_gbl_gpe_lock, ACPI_ISR);
408 gpe_block = gpe_xrupt_list->gpe_block_list_head;
411 * Read all of the 8-bit GPE status and enable registers
412 * in this GPE block, saving all of them.
413 * Find all currently active GP events.
415 for (i = 0; i < gpe_block->register_count; i++) {
416 /* Get the next status/enable pair */
418 gpe_register_info = &gpe_block->register_info[i];
420 /* Read the Status Register */
422 status = acpi_hw_low_level_read (ACPI_GPE_REGISTER_WIDTH, &status_reg,
423 &gpe_register_info->status_address);
424 if (ACPI_FAILURE (status)) {
425 goto unlock_and_exit;
428 /* Read the Enable Register */
430 status = acpi_hw_low_level_read (ACPI_GPE_REGISTER_WIDTH, &enable_reg,
431 &gpe_register_info->enable_address);
432 if (ACPI_FAILURE (status)) {
433 goto unlock_and_exit;
436 ACPI_DEBUG_PRINT ((ACPI_DB_INTERRUPTS,
437 "Read GPE Register at GPE%X: Status=%02X, Enable=%02X\n",
438 gpe_register_info->base_gpe_number, status_reg, enable_reg));
440 /* First check if there is anything active at all in this register */
442 enabled_status_byte = (u8) (status_reg & enable_reg);
443 if (!enabled_status_byte) {
444 /* No active GPEs in this register, move on */
449 /* Now look at the individual GPEs in this byte register */
451 for (j = 0; j < ACPI_GPE_REGISTER_WIDTH; j++) {
452 /* Examine one GPE bit */
454 if (enabled_status_byte & acpi_gbl_decode_to8bit[j]) {
456 * Found an active GPE. Dispatch the event to a handler
459 int_status |= acpi_ev_gpe_dispatch (
460 &gpe_block->event_info[(i * ACPI_GPE_REGISTER_WIDTH) + j],
461 (u32) j + gpe_register_info->base_gpe_number);
466 gpe_block = gpe_block->next;
471 acpi_os_release_lock (acpi_gbl_gpe_lock, ACPI_ISR);
476 /*******************************************************************************
478 * FUNCTION: acpi_ev_asynch_execute_gpe_method
480 * PARAMETERS: Context (gpe_event_info) - Info for this GPE
484 * DESCRIPTION: Perform the actual execution of a GPE control method. This
485 * function is called from an invocation of acpi_os_queue_for_execution
486 * (and therefore does NOT execute at interrupt level) so that
487 * the control method itself is not executed in the context of
488 * an interrupt handler.
490 ******************************************************************************/
492 static void ACPI_SYSTEM_XFACE
493 acpi_ev_asynch_execute_gpe_method (
496 struct acpi_gpe_event_info *gpe_event_info = (void *) context;
499 struct acpi_gpe_event_info local_gpe_event_info;
500 struct acpi_parameter_info info;
503 ACPI_FUNCTION_TRACE ("ev_asynch_execute_gpe_method");
506 status = acpi_ut_acquire_mutex (ACPI_MTX_EVENTS);
507 if (ACPI_FAILURE (status)) {
511 /* Must revalidate the gpe_number/gpe_block */
513 if (!acpi_ev_valid_gpe_event (gpe_event_info)) {
514 status = acpi_ut_release_mutex (ACPI_MTX_EVENTS);
518 /* Set the GPE flags for return to enabled state */
520 (void) acpi_ev_enable_gpe (gpe_event_info, FALSE);
523 * Take a snapshot of the GPE info for this level - we copy the
524 * info to prevent a race condition with remove_handler/remove_block.
526 ACPI_MEMCPY (&local_gpe_event_info, gpe_event_info, sizeof (struct acpi_gpe_event_info));
528 status = acpi_ut_release_mutex (ACPI_MTX_EVENTS);
529 if (ACPI_FAILURE (status)) {
534 * Must check for control method type dispatch one more
535 * time to avoid race with ev_gpe_install_handler
537 if ((local_gpe_event_info.flags & ACPI_GPE_DISPATCH_MASK) == ACPI_GPE_DISPATCH_METHOD) {
539 * Invoke the GPE Method (_Lxx, _Exx) i.e., evaluate the _Lxx/_Exx
540 * control method that corresponds to this GPE
542 info.node = local_gpe_event_info.dispatch.method_node;
543 info.parameters = ACPI_CAST_PTR (union acpi_operand_object *, gpe_event_info);
544 info.parameter_type = ACPI_PARAM_GPE;
546 status = acpi_ns_evaluate_by_handle (&info);
547 if (ACPI_FAILURE (status)) {
549 "%s while evaluating method [%4.4s] for GPE[%2X]\n",
550 acpi_format_exception (status),
551 acpi_ut_get_node_name (local_gpe_event_info.dispatch.method_node),
556 if ((local_gpe_event_info.flags & ACPI_GPE_XRUPT_TYPE_MASK) == ACPI_GPE_LEVEL_TRIGGERED) {
558 * GPE is level-triggered, we clear the GPE status bit after
559 * handling the event.
561 status = acpi_hw_clear_gpe (&local_gpe_event_info);
562 if (ACPI_FAILURE (status)) {
567 /* Enable this GPE */
569 (void) acpi_hw_write_gpe_enable_reg (&local_gpe_event_info);
574 /*******************************************************************************
576 * FUNCTION: acpi_ev_gpe_dispatch
578 * PARAMETERS: gpe_event_info - info for this GPE
579 * gpe_number - Number relative to the parent GPE block
581 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
583 * DESCRIPTION: Dispatch a General Purpose Event to either a function (e.g. EC)
584 * or method (e.g. _Lxx/_Exx) handler.
586 * This function executes at interrupt level.
588 ******************************************************************************/
591 acpi_ev_gpe_dispatch (
592 struct acpi_gpe_event_info *gpe_event_info,
598 ACPI_FUNCTION_TRACE ("ev_gpe_dispatch");
602 * If edge-triggered, clear the GPE status bit now. Note that
603 * level-triggered events are cleared after the GPE is serviced.
605 if ((gpe_event_info->flags & ACPI_GPE_XRUPT_TYPE_MASK) == ACPI_GPE_EDGE_TRIGGERED) {
606 status = acpi_hw_clear_gpe (gpe_event_info);
607 if (ACPI_FAILURE (status)) {
608 ACPI_REPORT_ERROR (("acpi_ev_gpe_dispatch: %s, Unable to clear GPE[%2X]\n",
609 acpi_format_exception (status), gpe_number));
610 return_VALUE (ACPI_INTERRUPT_NOT_HANDLED);
614 /* Save current system state */
616 if (acpi_gbl_system_awake_and_running) {
617 ACPI_SET_BIT (gpe_event_info->flags, ACPI_GPE_SYSTEM_RUNNING);
620 ACPI_CLEAR_BIT (gpe_event_info->flags, ACPI_GPE_SYSTEM_RUNNING);
624 * Dispatch the GPE to either an installed handler, or the control
625 * method associated with this GPE (_Lxx or _Exx).
626 * If a handler exists, we invoke it and do not attempt to run the method.
627 * If there is neither a handler nor a method, we disable the level to
628 * prevent further events from coming in here.
630 switch (gpe_event_info->flags & ACPI_GPE_DISPATCH_MASK) {
631 case ACPI_GPE_DISPATCH_HANDLER:
634 * Invoke the installed handler (at interrupt level)
635 * Ignore return status for now. TBD: leave GPE disabled on error?
637 (void) gpe_event_info->dispatch.handler->address (
638 gpe_event_info->dispatch.handler->context);
640 /* It is now safe to clear level-triggered events. */
642 if ((gpe_event_info->flags & ACPI_GPE_XRUPT_TYPE_MASK) == ACPI_GPE_LEVEL_TRIGGERED) {
643 status = acpi_hw_clear_gpe (gpe_event_info);
644 if (ACPI_FAILURE (status)) {
646 "acpi_ev_gpe_dispatch: %s, Unable to clear GPE[%2X]\n",
647 acpi_format_exception (status), gpe_number));
648 return_VALUE (ACPI_INTERRUPT_NOT_HANDLED);
653 case ACPI_GPE_DISPATCH_METHOD:
656 * Disable GPE, so it doesn't keep firing before the method has a
659 status = acpi_ev_disable_gpe (gpe_event_info);
660 if (ACPI_FAILURE (status)) {
662 "acpi_ev_gpe_dispatch: %s, Unable to disable GPE[%2X]\n",
663 acpi_format_exception (status), gpe_number));
664 return_VALUE (ACPI_INTERRUPT_NOT_HANDLED);
668 * Execute the method associated with the GPE
669 * NOTE: Level-triggered GPEs are cleared after the method completes.
671 status = acpi_os_queue_for_execution (OSD_PRIORITY_GPE,
672 acpi_ev_asynch_execute_gpe_method, gpe_event_info);
673 if (ACPI_FAILURE (status)) {
675 "acpi_ev_gpe_dispatch: %s, Unable to queue handler for GPE[%2X] - event disabled\n",
676 acpi_format_exception (status), gpe_number));
682 /* No handler or method to run! */
685 "acpi_ev_gpe_dispatch: No handler or method for GPE[%2X], disabling event\n",
689 * Disable the GPE. The GPE will remain disabled until the ACPI
690 * Core Subsystem is restarted, or a handler is installed.
692 status = acpi_ev_disable_gpe (gpe_event_info);
693 if (ACPI_FAILURE (status)) {
695 "acpi_ev_gpe_dispatch: %s, Unable to disable GPE[%2X]\n",
696 acpi_format_exception (status), gpe_number));
697 return_VALUE (ACPI_INTERRUPT_NOT_HANDLED);
702 return_VALUE (ACPI_INTERRUPT_HANDLED);
706 #ifdef ACPI_GPE_NOTIFY_CHECK
708 /*******************************************************************************
709 * TBD: NOT USED, PROTOTYPE ONLY AND WILL PROBABLY BE REMOVED
711 * FUNCTION: acpi_ev_check_for_wake_only_gpe
713 * PARAMETERS: gpe_event_info - info for this GPE
717 * DESCRIPTION: Determine if a a GPE is "wake-only".
719 * Called from Notify() code in interpreter when a "device_wake"
722 ******************************************************************************/
725 acpi_ev_check_for_wake_only_gpe (
726 struct acpi_gpe_event_info *gpe_event_info)
731 ACPI_FUNCTION_TRACE ("ev_check_for_wake_only_gpe");
734 if ((gpe_event_info) && /* Only >0 for _Lxx/_Exx */
735 ((gpe_event_info->flags & ACPI_GPE_SYSTEM_MASK) == ACPI_GPE_SYSTEM_RUNNING)) /* System state at GPE time */ {
736 /* This must be a wake-only GPE, disable it */
738 status = acpi_ev_disable_gpe (gpe_event_info);
740 /* Set GPE to wake-only. Do not change wake disabled/enabled status */
742 acpi_ev_set_gpe_type (gpe_event_info, ACPI_GPE_TYPE_WAKE);
744 ACPI_REPORT_INFO (("GPE %p was updated from wake/run to wake-only\n",
747 /* This was a wake-only GPE */
749 return_ACPI_STATUS (AE_WAKE_ONLY_GPE);
752 return_ACPI_STATUS (AE_OK);