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) {
210 /* Clear the GPE (of stale events), then enable it */
212 status = acpi_hw_clear_gpe(gpe_event_info);
213 if (ACPI_FAILURE(status)) {
214 return_ACPI_STATUS(status);
217 /* Enable the requested runtime GPE */
219 status = acpi_hw_write_gpe_enable_reg(gpe_event_info);
224 return_ACPI_STATUS(AE_BAD_PARAMETER);
227 return_ACPI_STATUS(AE_OK);
230 /*******************************************************************************
232 * FUNCTION: acpi_ev_disable_gpe
234 * PARAMETERS: gpe_event_info - GPE to disable
238 * DESCRIPTION: Disable a GPE based on the GPE type
240 ******************************************************************************/
242 acpi_status acpi_ev_disable_gpe(struct acpi_gpe_event_info *gpe_event_info)
246 ACPI_FUNCTION_TRACE("ev_disable_gpe");
248 if (!(gpe_event_info->flags & ACPI_GPE_ENABLE_MASK)) {
249 return_ACPI_STATUS(AE_OK);
252 /* Make sure HW enable masks are updated */
255 acpi_ev_update_gpe_enable_masks(gpe_event_info, ACPI_GPE_DISABLE);
256 if (ACPI_FAILURE(status)) {
257 return_ACPI_STATUS(status);
260 /* Mark wake-disabled or HW disable, or both */
262 switch (gpe_event_info->flags & ACPI_GPE_TYPE_MASK) {
263 case ACPI_GPE_TYPE_WAKE:
264 ACPI_CLEAR_BIT(gpe_event_info->flags, ACPI_GPE_WAKE_ENABLED);
267 case ACPI_GPE_TYPE_WAKE_RUN:
268 ACPI_CLEAR_BIT(gpe_event_info->flags, ACPI_GPE_WAKE_ENABLED);
270 /*lint -fallthrough */
272 case ACPI_GPE_TYPE_RUNTIME:
274 /* Disable the requested runtime GPE */
276 ACPI_CLEAR_BIT(gpe_event_info->flags, ACPI_GPE_RUN_ENABLED);
277 status = acpi_hw_write_gpe_enable_reg(gpe_event_info);
281 return_ACPI_STATUS(AE_BAD_PARAMETER);
284 return_ACPI_STATUS(AE_OK);
287 /*******************************************************************************
289 * FUNCTION: acpi_ev_get_gpe_event_info
291 * PARAMETERS: gpe_device - Device node. NULL for GPE0/GPE1
292 * gpe_number - Raw GPE number
294 * RETURN: A GPE event_info struct. NULL if not a valid GPE
296 * DESCRIPTION: Returns the event_info struct associated with this GPE.
297 * Validates the gpe_block and the gpe_number
299 * Should be called only when the GPE lists are semaphore locked
300 * and not subject to change.
302 ******************************************************************************/
304 struct acpi_gpe_event_info *acpi_ev_get_gpe_event_info(acpi_handle gpe_device,
307 union acpi_operand_object *obj_desc;
308 struct acpi_gpe_block_info *gpe_block;
311 ACPI_FUNCTION_ENTRY();
313 /* A NULL gpe_block means use the FADT-defined GPE block(s) */
316 /* Examine GPE Block 0 and 1 (These blocks are permanent) */
318 for (i = 0; i < ACPI_MAX_GPE_BLOCKS; i++) {
319 gpe_block = acpi_gbl_gpe_fadt_blocks[i];
321 if ((gpe_number >= gpe_block->block_base_number)
323 gpe_block->block_base_number +
324 (gpe_block->register_count * 8))) {
326 event_info[gpe_number -
333 /* The gpe_number was not in the range of either FADT GPE block */
338 /* A Non-NULL gpe_device means this is a GPE Block Device */
341 acpi_ns_get_attached_object((struct acpi_namespace_node *)
343 if (!obj_desc || !obj_desc->device.gpe_block) {
347 gpe_block = obj_desc->device.gpe_block;
349 if ((gpe_number >= gpe_block->block_base_number) &&
351 gpe_block->block_base_number + (gpe_block->register_count * 8))) {
353 event_info[gpe_number - gpe_block->block_base_number]);
359 /*******************************************************************************
361 * FUNCTION: acpi_ev_gpe_detect
363 * PARAMETERS: gpe_xrupt_list - Interrupt block for this interrupt.
364 * Can have multiple GPE blocks attached.
366 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
368 * DESCRIPTION: Detect if any GP events have occurred. This function is
369 * executed at interrupt level.
371 ******************************************************************************/
373 u32 acpi_ev_gpe_detect(struct acpi_gpe_xrupt_info * gpe_xrupt_list)
376 struct acpi_gpe_block_info *gpe_block;
377 struct acpi_gpe_register_info *gpe_register_info;
378 u32 int_status = ACPI_INTERRUPT_NOT_HANDLED;
379 u8 enabled_status_byte;
382 acpi_cpu_flags flags;
386 ACPI_FUNCTION_NAME("ev_gpe_detect");
388 /* Check for the case where there are no GPEs */
390 if (!gpe_xrupt_list) {
394 /* Examine all GPE blocks attached to this interrupt level */
396 flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
397 gpe_block = gpe_xrupt_list->gpe_block_list_head;
400 * Read all of the 8-bit GPE status and enable registers
401 * in this GPE block, saving all of them.
402 * Find all currently active GP events.
404 for (i = 0; i < gpe_block->register_count; i++) {
405 /* Get the next status/enable pair */
407 gpe_register_info = &gpe_block->register_info[i];
409 /* Read the Status Register */
412 acpi_hw_low_level_read(ACPI_GPE_REGISTER_WIDTH,
416 if (ACPI_FAILURE(status)) {
417 goto unlock_and_exit;
420 /* Read the Enable Register */
423 acpi_hw_low_level_read(ACPI_GPE_REGISTER_WIDTH,
427 if (ACPI_FAILURE(status)) {
428 goto unlock_and_exit;
431 ACPI_DEBUG_PRINT((ACPI_DB_INTERRUPTS,
432 "Read GPE Register at GPE%X: Status=%02X, Enable=%02X\n",
433 gpe_register_info->base_gpe_number,
434 status_reg, enable_reg));
436 /* Check if there is anything active at all in this register */
438 enabled_status_byte = (u8) (status_reg & enable_reg);
439 if (!enabled_status_byte) {
440 /* No active GPEs in this register, move on */
445 /* Now look at the individual GPEs in this byte register */
447 for (j = 0; j < ACPI_GPE_REGISTER_WIDTH; j++) {
448 /* Examine one GPE bit */
450 if (enabled_status_byte &
451 acpi_gbl_decode_to8bit[j]) {
453 * Found an active GPE. Dispatch the event to a handler
457 acpi_ev_gpe_dispatch(&gpe_block->
459 ACPI_GPE_REGISTER_WIDTH)
469 gpe_block = gpe_block->next;
474 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
478 /*******************************************************************************
480 * FUNCTION: acpi_ev_asynch_execute_gpe_method
482 * PARAMETERS: Context (gpe_event_info) - Info for this GPE
486 * DESCRIPTION: Perform the actual execution of a GPE control method. This
487 * function is called from an invocation of acpi_os_queue_for_execution
488 * (and therefore does NOT execute at interrupt level) so that
489 * the control method itself is not executed in the context of
490 * an interrupt handler.
492 ******************************************************************************/
494 static void ACPI_SYSTEM_XFACE acpi_ev_asynch_execute_gpe_method(void *context)
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;
502 ACPI_FUNCTION_TRACE("ev_asynch_execute_gpe_method");
504 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
505 if (ACPI_FAILURE(status)) {
509 /* Must revalidate the gpe_number/gpe_block */
511 if (!acpi_ev_valid_gpe_event(gpe_event_info)) {
512 status = acpi_ut_release_mutex(ACPI_MTX_EVENTS);
516 /* Set the GPE flags for return to enabled state */
518 (void)acpi_ev_enable_gpe(gpe_event_info, FALSE);
521 * Take a snapshot of the GPE info for this level - we copy the
522 * info to prevent a race condition with remove_handler/remove_block.
524 ACPI_MEMCPY(&local_gpe_event_info, gpe_event_info,
525 sizeof(struct acpi_gpe_event_info));
527 status = acpi_ut_release_mutex(ACPI_MTX_EVENTS);
528 if (ACPI_FAILURE(status)) {
533 * Must check for control method type dispatch one more
534 * time to avoid race with ev_gpe_install_handler
536 if ((local_gpe_event_info.flags & ACPI_GPE_DISPATCH_MASK) ==
537 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;
544 ACPI_CAST_PTR(union acpi_operand_object *, gpe_event_info);
545 info.parameter_type = ACPI_PARAM_GPE;
547 status = acpi_ns_evaluate_by_handle(&info);
548 if (ACPI_FAILURE(status)) {
549 ACPI_EXCEPTION((AE_INFO, status,
550 "While evaluating method [%4.4s] for GPE[%2X]",
551 acpi_ut_get_node_name
552 (local_gpe_event_info.dispatch.
553 method_node), gpe_number));
557 if ((local_gpe_event_info.flags & ACPI_GPE_XRUPT_TYPE_MASK) ==
558 ACPI_GPE_LEVEL_TRIGGERED) {
560 * GPE is level-triggered, we clear the GPE status bit after
561 * handling the event.
563 status = acpi_hw_clear_gpe(&local_gpe_event_info);
564 if (ACPI_FAILURE(status)) {
569 /* Enable this GPE */
571 (void)acpi_hw_write_gpe_enable_reg(&local_gpe_event_info);
575 /*******************************************************************************
577 * FUNCTION: acpi_ev_gpe_dispatch
579 * PARAMETERS: gpe_event_info - Info for this GPE
580 * gpe_number - Number relative to the parent GPE block
582 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
584 * DESCRIPTION: Dispatch a General Purpose Event to either a function (e.g. EC)
585 * or method (e.g. _Lxx/_Exx) handler.
587 * This function executes at interrupt level.
589 ******************************************************************************/
592 acpi_ev_gpe_dispatch(struct acpi_gpe_event_info *gpe_event_info, u32 gpe_number)
596 ACPI_FUNCTION_TRACE("ev_gpe_dispatch");
599 * If edge-triggered, clear the GPE status bit now. Note that
600 * level-triggered events are cleared after the GPE is serviced.
602 if ((gpe_event_info->flags & ACPI_GPE_XRUPT_TYPE_MASK) ==
603 ACPI_GPE_EDGE_TRIGGERED) {
604 status = acpi_hw_clear_gpe(gpe_event_info);
605 if (ACPI_FAILURE(status)) {
606 ACPI_EXCEPTION((AE_INFO, status,
607 "Unable to clear GPE[%2X]",
609 return_UINT32(ACPI_INTERRUPT_NOT_HANDLED);
613 /* Save current system state */
615 if (acpi_gbl_system_awake_and_running) {
616 ACPI_SET_BIT(gpe_event_info->flags, ACPI_GPE_SYSTEM_RUNNING);
618 ACPI_CLEAR_BIT(gpe_event_info->flags, ACPI_GPE_SYSTEM_RUNNING);
622 * Dispatch the GPE to either an installed handler, or the control
623 * method associated with this GPE (_Lxx or _Exx).
624 * If a handler exists, we invoke it and do not attempt to run the method.
625 * If there is neither a handler nor a method, we disable the level to
626 * prevent further events from coming in here.
628 switch (gpe_event_info->flags & ACPI_GPE_DISPATCH_MASK) {
629 case ACPI_GPE_DISPATCH_HANDLER:
632 * Invoke the installed handler (at interrupt level)
633 * Ignore return status for now. TBD: leave GPE disabled on error?
635 (void)gpe_event_info->dispatch.handler->address(gpe_event_info->
640 /* It is now safe to clear level-triggered events. */
642 if ((gpe_event_info->flags & ACPI_GPE_XRUPT_TYPE_MASK) ==
643 ACPI_GPE_LEVEL_TRIGGERED) {
644 status = acpi_hw_clear_gpe(gpe_event_info);
645 if (ACPI_FAILURE(status)) {
646 ACPI_EXCEPTION((AE_INFO, status,
647 "Unable to clear GPE[%2X]",
649 return_UINT32(ACPI_INTERRUPT_NOT_HANDLED);
654 case ACPI_GPE_DISPATCH_METHOD:
657 * Disable GPE, so it doesn't keep firing before the method has a
660 status = acpi_ev_disable_gpe(gpe_event_info);
661 if (ACPI_FAILURE(status)) {
662 ACPI_EXCEPTION((AE_INFO, status,
663 "Unable to disable GPE[%2X]",
665 return_UINT32(ACPI_INTERRUPT_NOT_HANDLED);
669 * Execute the method associated with the GPE
670 * NOTE: Level-triggered GPEs are cleared after the method completes.
672 status = acpi_os_queue_for_execution(OSD_PRIORITY_GPE,
673 acpi_ev_asynch_execute_gpe_method,
675 if (ACPI_FAILURE(status)) {
676 ACPI_EXCEPTION((AE_INFO, status,
677 "Unable to queue handler for GPE[%2X] - event disabled",
684 /* No handler or method to run! */
687 "No handler or method for GPE[%2X], disabling event",
691 * Disable the GPE. The GPE will remain disabled until the ACPI
692 * Core Subsystem is restarted, or a handler is installed.
694 status = acpi_ev_disable_gpe(gpe_event_info);
695 if (ACPI_FAILURE(status)) {
696 ACPI_EXCEPTION((AE_INFO, status,
697 "Unable to disable GPE[%2X]",
699 return_UINT32(ACPI_INTERRUPT_NOT_HANDLED);
704 return_UINT32(ACPI_INTERRUPT_HANDLED);
707 #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(struct acpi_gpe_event_info *gpe_event_info)
729 ACPI_FUNCTION_TRACE("ev_check_for_wake_only_gpe");
731 if ((gpe_event_info) && /* Only >0 for _Lxx/_Exx */
732 ((gpe_event_info->flags & ACPI_GPE_SYSTEM_MASK) == ACPI_GPE_SYSTEM_RUNNING)) { /* System state at GPE time */
733 /* This must be a wake-only GPE, disable it */
735 status = acpi_ev_disable_gpe(gpe_event_info);
737 /* Set GPE to wake-only. Do not change wake disabled/enabled status */
739 acpi_ev_set_gpe_type(gpe_event_info, ACPI_GPE_TYPE_WAKE);
742 "GPE %p was updated from wake/run to wake-only",
745 /* This was a wake-only GPE */
747 return_ACPI_STATUS(AE_WAKE_ONLY_GPE);
750 return_ACPI_STATUS(AE_OK);