1 /******************************************************************************
3 * Module Name: evgpe - General Purpose Event handling and dispatch
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2010, 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_update_gpe_enable_masks
59 * PARAMETERS: gpe_event_info - GPE to update
63 * DESCRIPTION: Updates GPE register enable masks based upon whether there are
64 * references (either wake or run) to this GPE
66 ******************************************************************************/
69 acpi_ev_update_gpe_enable_masks(struct acpi_gpe_event_info *gpe_event_info)
71 struct acpi_gpe_register_info *gpe_register_info;
74 ACPI_FUNCTION_TRACE(ev_update_gpe_enable_masks);
76 gpe_register_info = gpe_event_info->register_info;
77 if (!gpe_register_info) {
78 return_ACPI_STATUS(AE_NOT_EXIST);
83 (gpe_event_info->gpe_number - gpe_register_info->base_gpe_number));
85 /* Clear the wake/run bits up front */
87 ACPI_CLEAR_BIT(gpe_register_info->enable_for_wake, register_bit);
88 ACPI_CLEAR_BIT(gpe_register_info->enable_for_run, register_bit);
90 /* Set the mask bits only if there are references to this GPE */
92 if (gpe_event_info->runtime_count) {
93 ACPI_SET_BIT(gpe_register_info->enable_for_run, register_bit);
96 if (gpe_event_info->wakeup_count) {
97 ACPI_SET_BIT(gpe_register_info->enable_for_wake, register_bit);
100 return_ACPI_STATUS(AE_OK);
103 /*******************************************************************************
105 * FUNCTION: acpi_ev_enable_gpe
107 * PARAMETERS: gpe_event_info - GPE to enable
111 * DESCRIPTION: Hardware-enable a GPE. Always enables the GPE, regardless
112 * of type or number of references.
114 * Note: The GPE lock should be already acquired when this function is called.
116 ******************************************************************************/
118 acpi_status acpi_ev_enable_gpe(struct acpi_gpe_event_info *gpe_event_info)
123 ACPI_FUNCTION_TRACE(ev_enable_gpe);
127 * We will only allow a GPE to be enabled if it has either an
128 * associated method (_Lxx/_Exx) or a handler. Otherwise, the
129 * GPE will be immediately disabled by acpi_ev_gpe_dispatch the
130 * first time it fires.
132 if (!(gpe_event_info->flags & ACPI_GPE_DISPATCH_MASK)) {
133 return_ACPI_STATUS(AE_NO_HANDLER);
136 /* Ensure the HW enable masks are current */
138 status = acpi_ev_update_gpe_enable_masks(gpe_event_info);
139 if (ACPI_FAILURE(status)) {
140 return_ACPI_STATUS(status);
143 /* Clear the GPE (of stale events) */
145 status = acpi_hw_clear_gpe(gpe_event_info);
146 if (ACPI_FAILURE(status)) {
147 return_ACPI_STATUS(status);
150 /* Enable the requested GPE */
152 status = acpi_hw_write_gpe_enable_reg(gpe_event_info);
153 return_ACPI_STATUS(status);
156 /*******************************************************************************
158 * FUNCTION: acpi_ev_disable_gpe
160 * PARAMETERS: gpe_event_info - GPE to disable
164 * DESCRIPTION: Hardware-disable a GPE. Always disables the requested GPE,
165 * regardless of the type or number of references.
167 * Note: The GPE lock should be already acquired when this function is called.
169 ******************************************************************************/
171 acpi_status acpi_ev_disable_gpe(struct acpi_gpe_event_info *gpe_event_info)
175 ACPI_FUNCTION_TRACE(ev_disable_gpe);
179 * Note: Always disable the GPE, even if we think that that it is already
180 * disabled. It is possible that the AML or some other code has enabled
181 * the GPE behind our back.
184 /* Ensure the HW enable masks are current */
186 status = acpi_ev_update_gpe_enable_masks(gpe_event_info);
187 if (ACPI_FAILURE(status)) {
188 return_ACPI_STATUS(status);
192 * Always H/W disable this GPE, even if we don't know the GPE type.
193 * Simply clear the enable bit for this particular GPE, but do not
194 * write out the current GPE enable mask since this may inadvertently
195 * enable GPEs too early. An example is a rogue GPE that has arrived
196 * during ACPICA initialization - possibly because AML or other code
197 * has enabled the GPE.
199 status = acpi_hw_low_disable_gpe(gpe_event_info);
200 return_ACPI_STATUS(status);
204 /*******************************************************************************
206 * FUNCTION: acpi_ev_low_get_gpe_info
208 * PARAMETERS: gpe_number - Raw GPE number
209 * gpe_block - A GPE info block
211 * RETURN: A GPE event_info struct. NULL if not a valid GPE (The gpe_number
212 * is not within the specified GPE block)
214 * DESCRIPTION: Returns the event_info struct associated with this GPE. This is
215 * the low-level implementation of ev_get_gpe_event_info.
217 ******************************************************************************/
219 struct acpi_gpe_event_info *acpi_ev_low_get_gpe_info(u32 gpe_number,
220 struct acpi_gpe_block_info
226 * Validate that the gpe_number is within the specified gpe_block.
229 if (!gpe_block || (gpe_number < gpe_block->block_base_number)) {
233 gpe_index = gpe_number - gpe_block->block_base_number;
234 if (gpe_index >= gpe_block->gpe_count) {
238 return (&gpe_block->event_info[gpe_index]);
242 /*******************************************************************************
244 * FUNCTION: acpi_ev_get_gpe_event_info
246 * PARAMETERS: gpe_device - Device node. NULL for GPE0/GPE1
247 * gpe_number - Raw GPE number
249 * RETURN: A GPE event_info struct. NULL if not a valid GPE
251 * DESCRIPTION: Returns the event_info struct associated with this GPE.
252 * Validates the gpe_block and the gpe_number
254 * Should be called only when the GPE lists are semaphore locked
255 * and not subject to change.
257 ******************************************************************************/
259 struct acpi_gpe_event_info *acpi_ev_get_gpe_event_info(acpi_handle gpe_device,
262 union acpi_operand_object *obj_desc;
263 struct acpi_gpe_event_info *gpe_info;
266 ACPI_FUNCTION_ENTRY();
268 /* A NULL gpe_device means use the FADT-defined GPE block(s) */
272 /* Examine GPE Block 0 and 1 (These blocks are permanent) */
274 for (i = 0; i < ACPI_MAX_GPE_BLOCKS; i++) {
275 gpe_info = acpi_ev_low_get_gpe_info(gpe_number,
276 acpi_gbl_gpe_fadt_blocks
283 /* The gpe_number was not in the range of either FADT GPE block */
288 /* A Non-NULL gpe_device means this is a GPE Block Device */
290 obj_desc = acpi_ns_get_attached_object((struct acpi_namespace_node *)
292 if (!obj_desc || !obj_desc->device.gpe_block) {
296 return (acpi_ev_low_get_gpe_info
297 (gpe_number, obj_desc->device.gpe_block));
300 /*******************************************************************************
302 * FUNCTION: acpi_ev_gpe_detect
304 * PARAMETERS: gpe_xrupt_list - Interrupt block for this interrupt.
305 * Can have multiple GPE blocks attached.
307 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
309 * DESCRIPTION: Detect if any GP events have occurred. This function is
310 * executed at interrupt level.
312 ******************************************************************************/
314 u32 acpi_ev_gpe_detect(struct acpi_gpe_xrupt_info * gpe_xrupt_list)
317 struct acpi_gpe_block_info *gpe_block;
318 struct acpi_gpe_register_info *gpe_register_info;
319 u32 int_status = ACPI_INTERRUPT_NOT_HANDLED;
320 u8 enabled_status_byte;
323 acpi_cpu_flags flags;
327 ACPI_FUNCTION_NAME(ev_gpe_detect);
329 /* Check for the case where there are no GPEs */
331 if (!gpe_xrupt_list) {
336 * We need to obtain the GPE lock for both the data structs and registers
337 * Note: Not necessary to obtain the hardware lock, since the GPE
338 * registers are owned by the gpe_lock.
340 flags = acpi_os_acquire_lock(acpi_gbl_gpe_lock);
342 /* Examine all GPE blocks attached to this interrupt level */
344 gpe_block = gpe_xrupt_list->gpe_block_list_head;
347 * Read all of the 8-bit GPE status and enable registers in this GPE
348 * block, saving all of them. Find all currently active GP events.
350 for (i = 0; i < gpe_block->register_count; i++) {
352 /* Get the next status/enable pair */
354 gpe_register_info = &gpe_block->register_info[i];
356 /* Read the Status Register */
359 acpi_hw_read(&status_reg,
360 &gpe_register_info->status_address);
361 if (ACPI_FAILURE(status)) {
362 goto unlock_and_exit;
365 /* Read the Enable Register */
368 acpi_hw_read(&enable_reg,
369 &gpe_register_info->enable_address);
370 if (ACPI_FAILURE(status)) {
371 goto unlock_and_exit;
374 ACPI_DEBUG_PRINT((ACPI_DB_INTERRUPTS,
375 "Read GPE Register at GPE%X: Status=%02X, Enable=%02X\n",
376 gpe_register_info->base_gpe_number,
377 status_reg, enable_reg));
379 /* Check if there is anything active at all in this register */
381 enabled_status_byte = (u8) (status_reg & enable_reg);
382 if (!enabled_status_byte) {
384 /* No active GPEs in this register, move on */
389 /* Now look at the individual GPEs in this byte register */
391 for (j = 0; j < ACPI_GPE_REGISTER_WIDTH; j++) {
393 /* Examine one GPE bit */
395 if (enabled_status_byte & (1 << j)) {
397 * Found an active GPE. Dispatch the event to a handler
401 acpi_ev_gpe_dispatch(&gpe_block->
402 event_info[((acpi_size) i * ACPI_GPE_REGISTER_WIDTH) + j], j + gpe_register_info->base_gpe_number);
407 gpe_block = gpe_block->next;
412 acpi_os_release_lock(acpi_gbl_gpe_lock, flags);
416 /*******************************************************************************
418 * FUNCTION: acpi_ev_asynch_execute_gpe_method
420 * PARAMETERS: Context (gpe_event_info) - Info for this GPE
424 * DESCRIPTION: Perform the actual execution of a GPE control method. This
425 * function is called from an invocation of acpi_os_execute and
426 * therefore does NOT execute at interrupt level - so that
427 * the control method itself is not executed in the context of
428 * an interrupt handler.
430 ******************************************************************************/
431 static void acpi_ev_asynch_enable_gpe(void *context);
433 static void ACPI_SYSTEM_XFACE acpi_ev_asynch_execute_gpe_method(void *context)
435 struct acpi_gpe_event_info *gpe_event_info = (void *)context;
437 struct acpi_gpe_event_info local_gpe_event_info;
438 struct acpi_evaluate_info *info;
440 ACPI_FUNCTION_TRACE(ev_asynch_execute_gpe_method);
442 status = acpi_ut_acquire_mutex(ACPI_MTX_EVENTS);
443 if (ACPI_FAILURE(status)) {
447 /* Must revalidate the gpe_number/gpe_block */
449 if (!acpi_ev_valid_gpe_event(gpe_event_info)) {
450 status = acpi_ut_release_mutex(ACPI_MTX_EVENTS);
454 /* Update the GPE register masks for return to enabled state */
456 (void)acpi_ev_update_gpe_enable_masks(gpe_event_info);
459 * Take a snapshot of the GPE info for this level - we copy the info to
460 * prevent a race condition with remove_handler/remove_block.
462 ACPI_MEMCPY(&local_gpe_event_info, gpe_event_info,
463 sizeof(struct acpi_gpe_event_info));
465 status = acpi_ut_release_mutex(ACPI_MTX_EVENTS);
466 if (ACPI_FAILURE(status)) {
471 * Must check for control method type dispatch one more time to avoid a
472 * race with ev_gpe_install_handler
474 if ((local_gpe_event_info.flags & ACPI_GPE_DISPATCH_MASK) ==
475 ACPI_GPE_DISPATCH_METHOD) {
477 /* Allocate the evaluation information block */
479 info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info));
481 status = AE_NO_MEMORY;
484 * Invoke the GPE Method (_Lxx, _Exx) i.e., evaluate the _Lxx/_Exx
485 * control method that corresponds to this GPE
488 local_gpe_event_info.dispatch.method_node;
489 info->flags = ACPI_IGNORE_RETURN_VALUE;
491 status = acpi_ns_evaluate(info);
495 if (ACPI_FAILURE(status)) {
496 ACPI_EXCEPTION((AE_INFO, status,
497 "while evaluating GPE method [%4.4s]",
498 acpi_ut_get_node_name
499 (local_gpe_event_info.dispatch.
503 /* Defer enabling of GPE until all notify handlers are done */
504 acpi_os_execute(OSL_NOTIFY_HANDLER, acpi_ev_asynch_enable_gpe,
509 static void acpi_ev_asynch_enable_gpe(void *context)
511 struct acpi_gpe_event_info *gpe_event_info = context;
513 if ((gpe_event_info->flags & ACPI_GPE_XRUPT_TYPE_MASK) ==
514 ACPI_GPE_LEVEL_TRIGGERED) {
516 * GPE is level-triggered, we clear the GPE status bit after handling
519 status = acpi_hw_clear_gpe(gpe_event_info);
520 if (ACPI_FAILURE(status)) {
525 /* Enable this GPE */
526 (void)acpi_hw_write_gpe_enable_reg(gpe_event_info);
530 /*******************************************************************************
532 * FUNCTION: acpi_ev_gpe_dispatch
534 * PARAMETERS: gpe_event_info - Info for this GPE
535 * gpe_number - Number relative to the parent GPE block
537 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
539 * DESCRIPTION: Dispatch a General Purpose Event to either a function (e.g. EC)
540 * or method (e.g. _Lxx/_Exx) handler.
542 * This function executes at interrupt level.
544 ******************************************************************************/
547 acpi_ev_gpe_dispatch(struct acpi_gpe_event_info *gpe_event_info, u32 gpe_number)
551 ACPI_FUNCTION_TRACE(ev_gpe_dispatch);
553 acpi_os_gpe_count(gpe_number);
556 * If edge-triggered, clear the GPE status bit now. Note that
557 * level-triggered events are cleared after the GPE is serviced.
559 if ((gpe_event_info->flags & ACPI_GPE_XRUPT_TYPE_MASK) ==
560 ACPI_GPE_EDGE_TRIGGERED) {
561 status = acpi_hw_clear_gpe(gpe_event_info);
562 if (ACPI_FAILURE(status)) {
563 ACPI_EXCEPTION((AE_INFO, status,
564 "Unable to clear GPE[0x%2X]",
566 return_UINT32(ACPI_INTERRUPT_NOT_HANDLED);
571 * Dispatch the GPE to either an installed handler, or the control method
572 * associated with this GPE (_Lxx or _Exx). If a handler exists, we invoke
573 * it and do not attempt to run the method. If there is neither a handler
574 * nor a method, we disable this GPE to prevent further such pointless
575 * events from firing.
577 switch (gpe_event_info->flags & ACPI_GPE_DISPATCH_MASK) {
578 case ACPI_GPE_DISPATCH_HANDLER:
581 * Invoke the installed handler (at interrupt level)
582 * Ignore return status for now.
583 * TBD: leave GPE disabled on error?
585 (void)gpe_event_info->dispatch.handler->address(gpe_event_info->
590 /* It is now safe to clear level-triggered events. */
592 if ((gpe_event_info->flags & ACPI_GPE_XRUPT_TYPE_MASK) ==
593 ACPI_GPE_LEVEL_TRIGGERED) {
594 status = acpi_hw_clear_gpe(gpe_event_info);
595 if (ACPI_FAILURE(status)) {
596 ACPI_EXCEPTION((AE_INFO, status,
597 "Unable to clear GPE[0x%2X]",
599 return_UINT32(ACPI_INTERRUPT_NOT_HANDLED);
604 case ACPI_GPE_DISPATCH_METHOD:
607 * Disable the GPE, so it doesn't keep firing before the method has a
608 * chance to run (it runs asynchronously with interrupts enabled).
610 status = acpi_ev_disable_gpe(gpe_event_info);
611 if (ACPI_FAILURE(status)) {
612 ACPI_EXCEPTION((AE_INFO, status,
613 "Unable to disable GPE[0x%2X]",
615 return_UINT32(ACPI_INTERRUPT_NOT_HANDLED);
619 * Execute the method associated with the GPE
620 * NOTE: Level-triggered GPEs are cleared after the method completes.
622 status = acpi_os_execute(OSL_GPE_HANDLER,
623 acpi_ev_asynch_execute_gpe_method,
625 if (ACPI_FAILURE(status)) {
626 ACPI_EXCEPTION((AE_INFO, status,
627 "Unable to queue handler for GPE[0x%2X] - event disabled",
635 * No handler or method to run!
636 * 03/2010: This case should no longer be possible. We will not allow
637 * a GPE to be enabled if it has no handler or method.
640 "No handler or method for GPE[0x%2X], disabling event",
644 * Disable the GPE. The GPE will remain disabled a handler
645 * is installed or ACPICA is restarted.
647 status = acpi_ev_disable_gpe(gpe_event_info);
648 if (ACPI_FAILURE(status)) {
649 ACPI_EXCEPTION((AE_INFO, status,
650 "Unable to disable GPE[0x%2X]",
652 return_UINT32(ACPI_INTERRUPT_NOT_HANDLED);
657 return_UINT32(ACPI_INTERRUPT_HANDLED);