1 /******************************************************************************
3 * Module Name: evgpe - General Purpose Event handling and dispatch
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2008, Intel Corp.
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>
49 #define _COMPONENT ACPI_EVENTS
50 ACPI_MODULE_NAME("evgpe")
52 /* Local prototypes */
53 static void ACPI_SYSTEM_XFACE
acpi_ev_asynch_execute_gpe_method(void *context
);
55 /*******************************************************************************
57 * FUNCTION: acpi_ev_set_gpe_type
59 * PARAMETERS: gpe_event_info - GPE to set
64 * DESCRIPTION: Sets the new type for the GPE (wake, run, or wake/run)
66 ******************************************************************************/
69 acpi_ev_set_gpe_type(struct acpi_gpe_event_info
*gpe_event_info
, u8 type
)
73 ACPI_FUNCTION_TRACE(ev_set_gpe_type
);
75 /* Validate type and update register enable masks */
78 case ACPI_GPE_TYPE_WAKE
:
79 case ACPI_GPE_TYPE_RUNTIME
:
80 case ACPI_GPE_TYPE_WAKE_RUN
:
84 return_ACPI_STATUS(AE_BAD_PARAMETER
);
87 /* Disable the GPE if currently enabled */
89 status
= acpi_ev_disable_gpe(gpe_event_info
);
91 /* Clear the type bits and insert the new Type */
93 gpe_event_info
->flags
&= ~ACPI_GPE_TYPE_MASK
;
94 gpe_event_info
->flags
|= type
;
95 return_ACPI_STATUS(status
);
98 /*******************************************************************************
100 * FUNCTION: acpi_ev_update_gpe_enable_masks
102 * PARAMETERS: gpe_event_info - GPE to update
103 * Type - What to do: ACPI_GPE_DISABLE or
108 * DESCRIPTION: Updates GPE register enable masks based on the GPE type
110 ******************************************************************************/
113 acpi_ev_update_gpe_enable_masks(struct acpi_gpe_event_info
*gpe_event_info
,
116 struct acpi_gpe_register_info
*gpe_register_info
;
119 ACPI_FUNCTION_TRACE(ev_update_gpe_enable_masks
);
121 gpe_register_info
= gpe_event_info
->register_info
;
122 if (!gpe_register_info
) {
123 return_ACPI_STATUS(AE_NOT_EXIST
);
128 (gpe_event_info
->gpe_number
- gpe_register_info
->base_gpe_number
));
130 /* 1) Disable case. Simply clear all enable bits */
132 if (type
== ACPI_GPE_DISABLE
) {
133 ACPI_CLEAR_BIT(gpe_register_info
->enable_for_wake
,
135 ACPI_CLEAR_BIT(gpe_register_info
->enable_for_run
, register_bit
);
136 return_ACPI_STATUS(AE_OK
);
139 /* 2) Enable case. Set/Clear the appropriate enable bits */
141 switch (gpe_event_info
->flags
& ACPI_GPE_TYPE_MASK
) {
142 case ACPI_GPE_TYPE_WAKE
:
143 ACPI_SET_BIT(gpe_register_info
->enable_for_wake
, register_bit
);
144 ACPI_CLEAR_BIT(gpe_register_info
->enable_for_run
, register_bit
);
147 case ACPI_GPE_TYPE_RUNTIME
:
148 ACPI_CLEAR_BIT(gpe_register_info
->enable_for_wake
,
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
);
165 /*******************************************************************************
167 * FUNCTION: acpi_ev_enable_gpe
169 * PARAMETERS: gpe_event_info - GPE to enable
170 * write_to_hardware - Enable now, or just mark data structs
171 * (WAKE GPEs should be deferred)
175 * DESCRIPTION: Enable a GPE based on the GPE type
177 ******************************************************************************/
180 acpi_ev_enable_gpe(struct acpi_gpe_event_info
*gpe_event_info
,
181 u8 write_to_hardware
)
185 ACPI_FUNCTION_TRACE(ev_enable_gpe
);
187 /* Make sure HW enable masks are updated */
190 acpi_ev_update_gpe_enable_masks(gpe_event_info
, ACPI_GPE_ENABLE
);
191 if (ACPI_FAILURE(status
)) {
192 return_ACPI_STATUS(status
);
195 /* Mark wake-enabled or HW enable, or both */
197 switch (gpe_event_info
->flags
& ACPI_GPE_TYPE_MASK
) {
198 case ACPI_GPE_TYPE_WAKE
:
200 ACPI_SET_BIT(gpe_event_info
->flags
, ACPI_GPE_WAKE_ENABLED
);
203 case ACPI_GPE_TYPE_WAKE_RUN
:
205 ACPI_SET_BIT(gpe_event_info
->flags
, ACPI_GPE_WAKE_ENABLED
);
207 /*lint -fallthrough */
209 case ACPI_GPE_TYPE_RUNTIME
:
211 ACPI_SET_BIT(gpe_event_info
->flags
, ACPI_GPE_RUN_ENABLED
);
213 if (write_to_hardware
) {
215 /* Clear the GPE (of stale events), then enable it */
217 status
= acpi_hw_clear_gpe(gpe_event_info
);
218 if (ACPI_FAILURE(status
)) {
219 return_ACPI_STATUS(status
);
222 /* Enable the requested runtime GPE */
224 status
= acpi_hw_write_gpe_enable_reg(gpe_event_info
);
229 return_ACPI_STATUS(AE_BAD_PARAMETER
);
232 return_ACPI_STATUS(AE_OK
);
235 /*******************************************************************************
237 * FUNCTION: acpi_ev_disable_gpe
239 * PARAMETERS: gpe_event_info - GPE to disable
243 * DESCRIPTION: Disable a GPE based on the GPE type
245 ******************************************************************************/
247 acpi_status
acpi_ev_disable_gpe(struct acpi_gpe_event_info
*gpe_event_info
)
251 ACPI_FUNCTION_TRACE(ev_disable_gpe
);
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 /* Clear the appropriate enabled flags for this GPE */
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
);
273 case ACPI_GPE_TYPE_RUNTIME
:
275 /* Disable the requested runtime GPE */
277 ACPI_CLEAR_BIT(gpe_event_info
->flags
, ACPI_GPE_RUN_ENABLED
);
285 * Even if we don't know the GPE type, make sure that we always
286 * disable it. low_disable_gpe will just clear the enable bit for this
287 * GPE and write it. It will not write out the current GPE enable mask,
288 * since this may inadvertently enable GPEs too early, if a rogue GPE has
289 * come in during ACPICA initialization - possibly as a result of AML or
290 * other code that has enabled the GPE.
292 status
= acpi_hw_low_disable_gpe(gpe_event_info
);
293 return_ACPI_STATUS(status
);
296 /*******************************************************************************
298 * FUNCTION: acpi_ev_get_gpe_event_info
300 * PARAMETERS: gpe_device - Device node. NULL for GPE0/GPE1
301 * gpe_number - Raw GPE number
303 * RETURN: A GPE event_info struct. NULL if not a valid GPE
305 * DESCRIPTION: Returns the event_info struct associated with this GPE.
306 * Validates the gpe_block and the gpe_number
308 * Should be called only when the GPE lists are semaphore locked
309 * and not subject to change.
311 ******************************************************************************/
313 struct acpi_gpe_event_info
*acpi_ev_get_gpe_event_info(acpi_handle gpe_device
,
316 union acpi_operand_object
*obj_desc
;
317 struct acpi_gpe_block_info
*gpe_block
;
320 ACPI_FUNCTION_ENTRY();
322 /* A NULL gpe_block means use the FADT-defined GPE block(s) */
326 /* Examine GPE Block 0 and 1 (These blocks are permanent) */
328 for (i
= 0; i
< ACPI_MAX_GPE_BLOCKS
; i
++) {
329 gpe_block
= acpi_gbl_gpe_fadt_blocks
[i
];
331 if ((gpe_number
>= gpe_block
->block_base_number
)
333 gpe_block
->block_base_number
+
334 (gpe_block
->register_count
* 8))) {
336 event_info
[gpe_number
-
343 /* The gpe_number was not in the range of either FADT GPE block */
348 /* A Non-NULL gpe_device means this is a GPE Block Device */
350 obj_desc
= acpi_ns_get_attached_object((struct acpi_namespace_node
*)
352 if (!obj_desc
|| !obj_desc
->device
.gpe_block
) {
356 gpe_block
= obj_desc
->device
.gpe_block
;
358 if ((gpe_number
>= gpe_block
->block_base_number
) &&
360 gpe_block
->block_base_number
+ (gpe_block
->register_count
* 8))) {
362 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 ******************************************************************************/
382 u32
acpi_ev_gpe_detect(struct acpi_gpe_xrupt_info
* gpe_xrupt_list
)
385 struct acpi_gpe_block_info
*gpe_block
;
386 struct acpi_gpe_register_info
*gpe_register_info
;
387 u32 int_status
= ACPI_INTERRUPT_NOT_HANDLED
;
388 u8 enabled_status_byte
;
391 acpi_cpu_flags flags
;
395 ACPI_FUNCTION_NAME(ev_gpe_detect
);
397 /* Check for the case where there are no GPEs */
399 if (!gpe_xrupt_list
) {
404 * We need to obtain the GPE lock for both the data structs and registers
405 * Note: Not necessary to obtain the hardware lock, since the GPE
406 * registers are owned by the gpe_lock.
408 flags
= acpi_os_acquire_lock(acpi_gbl_gpe_lock
);
410 /* Examine all GPE blocks attached to this interrupt level */
412 gpe_block
= gpe_xrupt_list
->gpe_block_list_head
;
415 * Read all of the 8-bit GPE status and enable registers in this GPE
416 * block, saving all of them. Find all currently active GP events.
418 for (i
= 0; i
< gpe_block
->register_count
; i
++) {
420 /* Get the next status/enable pair */
422 gpe_register_info
= &gpe_block
->register_info
[i
];
424 /* Read the Status Register */
427 acpi_hw_read(&status_reg
,
428 &gpe_register_info
->status_address
);
429 if (ACPI_FAILURE(status
)) {
430 goto unlock_and_exit
;
433 /* Read the Enable Register */
436 acpi_hw_read(&enable_reg
,
437 &gpe_register_info
->enable_address
);
438 if (ACPI_FAILURE(status
)) {
439 goto unlock_and_exit
;
442 ACPI_DEBUG_PRINT((ACPI_DB_INTERRUPTS
,
443 "Read GPE Register at GPE%X: Status=%02X, Enable=%02X\n",
444 gpe_register_info
->base_gpe_number
,
445 status_reg
, enable_reg
));
447 /* Check if there is anything active at all in this register */
449 enabled_status_byte
= (u8
) (status_reg
& enable_reg
);
450 if (!enabled_status_byte
) {
452 /* No active GPEs in this register, move on */
457 /* Now look at the individual GPEs in this byte register */
459 for (j
= 0; j
< ACPI_GPE_REGISTER_WIDTH
; j
++) {
461 /* Examine one GPE bit */
463 if (enabled_status_byte
& (1 << j
)) {
465 * Found an active GPE. Dispatch the event to a handler
469 acpi_ev_gpe_dispatch(&gpe_block
->
470 event_info
[((acpi_size
) i
* ACPI_GPE_REGISTER_WIDTH
) + j
], j
+ gpe_register_info
->base_gpe_number
);
475 gpe_block
= gpe_block
->next
;
480 acpi_os_release_lock(acpi_gbl_gpe_lock
, flags
);
484 /*******************************************************************************
486 * FUNCTION: acpi_ev_asynch_execute_gpe_method
488 * PARAMETERS: Context (gpe_event_info) - Info for this GPE
492 * DESCRIPTION: Perform the actual execution of a GPE control method. This
493 * function is called from an invocation of acpi_os_execute and
494 * therefore does NOT execute at interrupt level - so that
495 * the control method itself is not executed in the context of
496 * an interrupt handler.
498 ******************************************************************************/
499 static void acpi_ev_asynch_enable_gpe(void *context
);
501 static void ACPI_SYSTEM_XFACE
acpi_ev_asynch_execute_gpe_method(void *context
)
503 struct acpi_gpe_event_info
*gpe_event_info
= (void *)context
;
505 struct acpi_gpe_event_info local_gpe_event_info
;
506 struct acpi_evaluate_info
*info
;
508 ACPI_FUNCTION_TRACE(ev_asynch_execute_gpe_method
);
510 status
= acpi_ut_acquire_mutex(ACPI_MTX_EVENTS
);
511 if (ACPI_FAILURE(status
)) {
515 /* Must revalidate the gpe_number/gpe_block */
517 if (!acpi_ev_valid_gpe_event(gpe_event_info
)) {
518 status
= acpi_ut_release_mutex(ACPI_MTX_EVENTS
);
522 /* Set the GPE flags for return to enabled state */
524 (void)acpi_ev_enable_gpe(gpe_event_info
, FALSE
);
527 * Take a snapshot of the GPE info for this level - we copy the info to
528 * prevent a race condition with remove_handler/remove_block.
530 ACPI_MEMCPY(&local_gpe_event_info
, gpe_event_info
,
531 sizeof(struct acpi_gpe_event_info
));
533 status
= acpi_ut_release_mutex(ACPI_MTX_EVENTS
);
534 if (ACPI_FAILURE(status
)) {
539 * Must check for control method type dispatch one more time to avoid a
540 * race with ev_gpe_install_handler
542 if ((local_gpe_event_info
.flags
& ACPI_GPE_DISPATCH_MASK
) ==
543 ACPI_GPE_DISPATCH_METHOD
) {
545 /* Allocate the evaluation information block */
547 info
= ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info
));
549 status
= AE_NO_MEMORY
;
552 * Invoke the GPE Method (_Lxx, _Exx) i.e., evaluate the _Lxx/_Exx
553 * control method that corresponds to this GPE
556 local_gpe_event_info
.dispatch
.method_node
;
557 info
->flags
= ACPI_IGNORE_RETURN_VALUE
;
559 status
= acpi_ns_evaluate(info
);
563 if (ACPI_FAILURE(status
)) {
564 ACPI_EXCEPTION((AE_INFO
, status
,
565 "while evaluating GPE method [%4.4s]",
566 acpi_ut_get_node_name
567 (local_gpe_event_info
.dispatch
.
571 /* Defer enabling of GPE until all notify handlers are done */
572 acpi_os_execute(OSL_NOTIFY_HANDLER
, acpi_ev_asynch_enable_gpe
,
577 static void acpi_ev_asynch_enable_gpe(void *context
)
579 struct acpi_gpe_event_info
*gpe_event_info
= context
;
581 if ((gpe_event_info
->flags
& ACPI_GPE_XRUPT_TYPE_MASK
) ==
582 ACPI_GPE_LEVEL_TRIGGERED
) {
584 * GPE is level-triggered, we clear the GPE status bit after handling
587 status
= acpi_hw_clear_gpe(gpe_event_info
);
588 if (ACPI_FAILURE(status
)) {
593 /* Enable this GPE */
594 (void)acpi_hw_write_gpe_enable_reg(gpe_event_info
);
598 /*******************************************************************************
600 * FUNCTION: acpi_ev_gpe_dispatch
602 * PARAMETERS: gpe_event_info - Info for this GPE
603 * gpe_number - Number relative to the parent GPE block
605 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
607 * DESCRIPTION: Dispatch a General Purpose Event to either a function (e.g. EC)
608 * or method (e.g. _Lxx/_Exx) handler.
610 * This function executes at interrupt level.
612 ******************************************************************************/
615 acpi_ev_gpe_dispatch(struct acpi_gpe_event_info
*gpe_event_info
, u32 gpe_number
)
619 ACPI_FUNCTION_TRACE(ev_gpe_dispatch
);
621 acpi_os_gpe_count(gpe_number
);
624 * If edge-triggered, clear the GPE status bit now. Note that
625 * level-triggered events are cleared after the GPE is serviced.
627 if ((gpe_event_info
->flags
& ACPI_GPE_XRUPT_TYPE_MASK
) ==
628 ACPI_GPE_EDGE_TRIGGERED
) {
629 status
= acpi_hw_clear_gpe(gpe_event_info
);
630 if (ACPI_FAILURE(status
)) {
631 ACPI_EXCEPTION((AE_INFO
, status
,
632 "Unable to clear GPE[%2X]",
634 return_UINT32(ACPI_INTERRUPT_NOT_HANDLED
);
639 * Dispatch the GPE to either an installed handler, or the control method
640 * associated with this GPE (_Lxx or _Exx). If a handler exists, we invoke
641 * it and do not attempt to run the method. If there is neither a handler
642 * nor a method, we disable this GPE to prevent further such pointless
643 * events from firing.
645 switch (gpe_event_info
->flags
& ACPI_GPE_DISPATCH_MASK
) {
646 case ACPI_GPE_DISPATCH_HANDLER
:
649 * Invoke the installed handler (at interrupt level)
650 * Ignore return status for now.
651 * TBD: leave GPE disabled on error?
653 (void)gpe_event_info
->dispatch
.handler
->address(gpe_event_info
->
658 /* It is now safe to clear level-triggered events. */
660 if ((gpe_event_info
->flags
& ACPI_GPE_XRUPT_TYPE_MASK
) ==
661 ACPI_GPE_LEVEL_TRIGGERED
) {
662 status
= acpi_hw_clear_gpe(gpe_event_info
);
663 if (ACPI_FAILURE(status
)) {
664 ACPI_EXCEPTION((AE_INFO
, status
,
665 "Unable to clear GPE[%2X]",
667 return_UINT32(ACPI_INTERRUPT_NOT_HANDLED
);
672 case ACPI_GPE_DISPATCH_METHOD
:
675 * Disable the GPE, so it doesn't keep firing before the method has a
676 * chance to run (it runs asynchronously with interrupts enabled).
678 status
= acpi_ev_disable_gpe(gpe_event_info
);
679 if (ACPI_FAILURE(status
)) {
680 ACPI_EXCEPTION((AE_INFO
, status
,
681 "Unable to disable GPE[%2X]",
683 return_UINT32(ACPI_INTERRUPT_NOT_HANDLED
);
687 * Execute the method associated with the GPE
688 * NOTE: Level-triggered GPEs are cleared after the method completes.
690 status
= acpi_os_execute(OSL_GPE_HANDLER
,
691 acpi_ev_asynch_execute_gpe_method
,
693 if (ACPI_FAILURE(status
)) {
694 ACPI_EXCEPTION((AE_INFO
, status
,
695 "Unable to queue handler for GPE[%2X] - event disabled",
702 /* No handler or method to run! */
705 "No handler or method for GPE[%2X], disabling event",
709 * Disable the GPE. The GPE will remain disabled until the ACPICA
710 * Core Subsystem is restarted, or a handler is installed.
712 status
= acpi_ev_disable_gpe(gpe_event_info
);
713 if (ACPI_FAILURE(status
)) {
714 ACPI_EXCEPTION((AE_INFO
, status
,
715 "Unable to disable GPE[%2X]",
717 return_UINT32(ACPI_INTERRUPT_NOT_HANDLED
);
722 return_UINT32(ACPI_INTERRUPT_HANDLED
);