1 /******************************************************************************
3 * Module Name: evgpe - General Purpose Event handling and dispatch
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2013, 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 <contrib/dev/acpica/include/acpi.h>
45 #include <contrib/dev/acpica/include/accommon.h>
46 #include <contrib/dev/acpica/include/acevents.h>
47 #include <contrib/dev/acpica/include/acnamesp.h>
49 #define _COMPONENT ACPI_EVENTS
50 ACPI_MODULE_NAME ("evgpe")
52 #if (!ACPI_REDUCED_HARDWARE) /* Entire module */
54 /* Local prototypes */
56 static void ACPI_SYSTEM_XFACE
57 AcpiEvAsynchExecuteGpeMethod (
60 static void ACPI_SYSTEM_XFACE
61 AcpiEvAsynchEnableGpe (
65 /*******************************************************************************
67 * FUNCTION: AcpiEvUpdateGpeEnableMask
69 * PARAMETERS: GpeEventInfo - GPE to update
73 * DESCRIPTION: Updates GPE register enable mask based upon whether there are
74 * runtime references to this GPE
76 ******************************************************************************/
79 AcpiEvUpdateGpeEnableMask (
80 ACPI_GPE_EVENT_INFO *GpeEventInfo)
82 ACPI_GPE_REGISTER_INFO *GpeRegisterInfo;
86 ACPI_FUNCTION_TRACE (EvUpdateGpeEnableMask);
89 GpeRegisterInfo = GpeEventInfo->RegisterInfo;
92 return_ACPI_STATUS (AE_NOT_EXIST);
95 RegisterBit = AcpiHwGetGpeRegisterBit (GpeEventInfo);
97 /* Clear the run bit up front */
99 ACPI_CLEAR_BIT (GpeRegisterInfo->EnableForRun, RegisterBit);
101 /* Set the mask bit only if there are references to this GPE */
103 if (GpeEventInfo->RuntimeCount)
105 ACPI_SET_BIT (GpeRegisterInfo->EnableForRun, (UINT8) RegisterBit);
108 return_ACPI_STATUS (AE_OK);
112 /*******************************************************************************
114 * FUNCTION: AcpiEvEnableGpe
116 * PARAMETERS: GpeEventInfo - GPE to enable
120 * DESCRIPTION: Clear a GPE of stale events and enable it.
122 ******************************************************************************/
126 ACPI_GPE_EVENT_INFO *GpeEventInfo)
131 ACPI_FUNCTION_TRACE (EvEnableGpe);
135 * We will only allow a GPE to be enabled if it has either an associated
136 * method (_Lxx/_Exx) or a handler, or is using the implicit notify
137 * feature. Otherwise, the GPE will be immediately disabled by
138 * AcpiEvGpeDispatch the first time it fires.
140 if ((GpeEventInfo->Flags & ACPI_GPE_DISPATCH_MASK) ==
141 ACPI_GPE_DISPATCH_NONE)
143 return_ACPI_STATUS (AE_NO_HANDLER);
146 /* Clear the GPE (of stale events) */
148 Status = AcpiHwClearGpe (GpeEventInfo);
149 if (ACPI_FAILURE (Status))
151 return_ACPI_STATUS (Status);
154 /* Enable the requested GPE */
156 Status = AcpiHwLowSetGpe (GpeEventInfo, ACPI_GPE_ENABLE);
157 return_ACPI_STATUS (Status);
161 /*******************************************************************************
163 * FUNCTION: AcpiEvAddGpeReference
165 * PARAMETERS: GpeEventInfo - Add a reference to this GPE
169 * DESCRIPTION: Add a reference to a GPE. On the first reference, the GPE is
172 ******************************************************************************/
175 AcpiEvAddGpeReference (
176 ACPI_GPE_EVENT_INFO *GpeEventInfo)
178 ACPI_STATUS Status = AE_OK;
181 ACPI_FUNCTION_TRACE (EvAddGpeReference);
184 if (GpeEventInfo->RuntimeCount == ACPI_UINT8_MAX)
186 return_ACPI_STATUS (AE_LIMIT);
189 GpeEventInfo->RuntimeCount++;
190 if (GpeEventInfo->RuntimeCount == 1)
192 /* Enable on first reference */
194 Status = AcpiEvUpdateGpeEnableMask (GpeEventInfo);
195 if (ACPI_SUCCESS (Status))
197 Status = AcpiEvEnableGpe (GpeEventInfo);
200 if (ACPI_FAILURE (Status))
202 GpeEventInfo->RuntimeCount--;
206 return_ACPI_STATUS (Status);
210 /*******************************************************************************
212 * FUNCTION: AcpiEvRemoveGpeReference
214 * PARAMETERS: GpeEventInfo - Remove a reference to this GPE
218 * DESCRIPTION: Remove a reference to a GPE. When the last reference is
219 * removed, the GPE is hardware-disabled.
221 ******************************************************************************/
224 AcpiEvRemoveGpeReference (
225 ACPI_GPE_EVENT_INFO *GpeEventInfo)
227 ACPI_STATUS Status = AE_OK;
230 ACPI_FUNCTION_TRACE (EvRemoveGpeReference);
233 if (!GpeEventInfo->RuntimeCount)
235 return_ACPI_STATUS (AE_LIMIT);
238 GpeEventInfo->RuntimeCount--;
239 if (!GpeEventInfo->RuntimeCount)
241 /* Disable on last reference */
243 Status = AcpiEvUpdateGpeEnableMask (GpeEventInfo);
244 if (ACPI_SUCCESS (Status))
246 Status = AcpiHwLowSetGpe (GpeEventInfo, ACPI_GPE_DISABLE);
249 if (ACPI_FAILURE (Status))
251 GpeEventInfo->RuntimeCount++;
255 return_ACPI_STATUS (Status);
259 /*******************************************************************************
261 * FUNCTION: AcpiEvLowGetGpeInfo
263 * PARAMETERS: GpeNumber - Raw GPE number
264 * GpeBlock - A GPE info block
266 * RETURN: A GPE EventInfo struct. NULL if not a valid GPE (The GpeNumber
267 * is not within the specified GPE block)
269 * DESCRIPTION: Returns the EventInfo struct associated with this GPE. This is
270 * the low-level implementation of EvGetGpeEventInfo.
272 ******************************************************************************/
274 ACPI_GPE_EVENT_INFO *
275 AcpiEvLowGetGpeInfo (
277 ACPI_GPE_BLOCK_INFO *GpeBlock)
283 * Validate that the GpeNumber is within the specified GpeBlock.
287 (GpeNumber < GpeBlock->BlockBaseNumber))
292 GpeIndex = GpeNumber - GpeBlock->BlockBaseNumber;
293 if (GpeIndex >= GpeBlock->GpeCount)
298 return (&GpeBlock->EventInfo[GpeIndex]);
302 /*******************************************************************************
304 * FUNCTION: AcpiEvGetGpeEventInfo
306 * PARAMETERS: GpeDevice - Device node. NULL for GPE0/GPE1
307 * GpeNumber - Raw GPE number
309 * RETURN: A GPE EventInfo struct. NULL if not a valid GPE
311 * DESCRIPTION: Returns the EventInfo struct associated with this GPE.
312 * Validates the GpeBlock and the GpeNumber
314 * Should be called only when the GPE lists are semaphore locked
315 * and not subject to change.
317 ******************************************************************************/
319 ACPI_GPE_EVENT_INFO *
320 AcpiEvGetGpeEventInfo (
321 ACPI_HANDLE GpeDevice,
324 ACPI_OPERAND_OBJECT *ObjDesc;
325 ACPI_GPE_EVENT_INFO *GpeInfo;
329 ACPI_FUNCTION_ENTRY ();
332 /* A NULL GpeDevice means use the FADT-defined GPE block(s) */
336 /* Examine GPE Block 0 and 1 (These blocks are permanent) */
338 for (i = 0; i < ACPI_MAX_GPE_BLOCKS; i++)
340 GpeInfo = AcpiEvLowGetGpeInfo (GpeNumber,
341 AcpiGbl_GpeFadtBlocks[i]);
348 /* The GpeNumber was not in the range of either FADT GPE block */
353 /* A Non-NULL GpeDevice means this is a GPE Block Device */
355 ObjDesc = AcpiNsGetAttachedObject ((ACPI_NAMESPACE_NODE *) GpeDevice);
357 !ObjDesc->Device.GpeBlock)
362 return (AcpiEvLowGetGpeInfo (GpeNumber, ObjDesc->Device.GpeBlock));
366 /*******************************************************************************
368 * FUNCTION: AcpiEvGpeDetect
370 * PARAMETERS: GpeXruptList - Interrupt block for this interrupt.
371 * Can have multiple GPE blocks attached.
373 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
375 * DESCRIPTION: Detect if any GP events have occurred. This function is
376 * executed at interrupt level.
378 ******************************************************************************/
382 ACPI_GPE_XRUPT_INFO *GpeXruptList)
385 ACPI_GPE_BLOCK_INFO *GpeBlock;
386 ACPI_GPE_REGISTER_INFO *GpeRegisterInfo;
387 UINT32 IntStatus = ACPI_INTERRUPT_NOT_HANDLED;
388 UINT8 EnabledStatusByte;
391 ACPI_CPU_FLAGS Flags;
396 ACPI_FUNCTION_NAME (EvGpeDetect);
398 /* Check for the case where there are no GPEs */
406 * We need to obtain the GPE lock for both the data structs and registers
407 * Note: Not necessary to obtain the hardware lock, since the GPE
408 * registers are owned by the GpeLock.
410 Flags = AcpiOsAcquireLock (AcpiGbl_GpeLock);
412 /* Examine all GPE blocks attached to this interrupt level */
414 GpeBlock = GpeXruptList->GpeBlockListHead;
418 * Read all of the 8-bit GPE status and enable registers in this GPE
419 * block, saving all of them. Find all currently active GP events.
421 for (i = 0; i < GpeBlock->RegisterCount; i++)
423 /* Get the next status/enable pair */
425 GpeRegisterInfo = &GpeBlock->RegisterInfo[i];
428 * Optimization: If there are no GPEs enabled within this
429 * register, we can safely ignore the entire register.
431 if (!(GpeRegisterInfo->EnableForRun |
432 GpeRegisterInfo->EnableForWake))
434 ACPI_DEBUG_PRINT ((ACPI_DB_INTERRUPTS,
435 "Ignore disabled registers for GPE%02X-GPE%02X: "
436 "RunEnable=%02X, WakeEnable=%02X\n",
437 GpeRegisterInfo->BaseGpeNumber,
438 GpeRegisterInfo->BaseGpeNumber + (ACPI_GPE_REGISTER_WIDTH - 1),
439 GpeRegisterInfo->EnableForRun,
440 GpeRegisterInfo->EnableForWake));
444 /* Read the Status Register */
446 Status = AcpiHwRead (&StatusReg, &GpeRegisterInfo->StatusAddress);
447 if (ACPI_FAILURE (Status))
452 /* Read the Enable Register */
454 Status = AcpiHwRead (&EnableReg, &GpeRegisterInfo->EnableAddress);
455 if (ACPI_FAILURE (Status))
460 ACPI_DEBUG_PRINT ((ACPI_DB_INTERRUPTS,
461 "Read registers for GPE%02X-GPE%02X: Status=%02X, Enable=%02X, "
462 "RunEnable=%02X, WakeEnable=%02X\n",
463 GpeRegisterInfo->BaseGpeNumber,
464 GpeRegisterInfo->BaseGpeNumber + (ACPI_GPE_REGISTER_WIDTH - 1),
465 StatusReg, EnableReg,
466 GpeRegisterInfo->EnableForRun,
467 GpeRegisterInfo->EnableForWake));
469 /* Check if there is anything active at all in this register */
471 EnabledStatusByte = (UINT8) (StatusReg & EnableReg);
472 if (!EnabledStatusByte)
474 /* No active GPEs in this register, move on */
479 /* Now look at the individual GPEs in this byte register */
481 for (j = 0; j < ACPI_GPE_REGISTER_WIDTH; j++)
483 /* Examine one GPE bit */
485 if (EnabledStatusByte & (1 << j))
488 * Found an active GPE. Dispatch the event to a handler
491 IntStatus |= AcpiEvGpeDispatch (GpeBlock->Node,
492 &GpeBlock->EventInfo[((ACPI_SIZE) i *
493 ACPI_GPE_REGISTER_WIDTH) + j],
494 j + GpeRegisterInfo->BaseGpeNumber);
499 GpeBlock = GpeBlock->Next;
504 AcpiOsReleaseLock (AcpiGbl_GpeLock, Flags);
509 /*******************************************************************************
511 * FUNCTION: AcpiEvAsynchExecuteGpeMethod
513 * PARAMETERS: Context (GpeEventInfo) - Info for this GPE
517 * DESCRIPTION: Perform the actual execution of a GPE control method. This
518 * function is called from an invocation of AcpiOsExecute and
519 * therefore does NOT execute at interrupt level - so that
520 * the control method itself is not executed in the context of
521 * an interrupt handler.
523 ******************************************************************************/
525 static void ACPI_SYSTEM_XFACE
526 AcpiEvAsynchExecuteGpeMethod (
529 ACPI_GPE_EVENT_INFO *GpeEventInfo = Context;
531 ACPI_GPE_EVENT_INFO *LocalGpeEventInfo;
532 ACPI_EVALUATE_INFO *Info;
533 ACPI_GPE_NOTIFY_INFO *Notify;
536 ACPI_FUNCTION_TRACE (EvAsynchExecuteGpeMethod);
539 /* Allocate a local GPE block */
541 LocalGpeEventInfo = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_GPE_EVENT_INFO));
542 if (!LocalGpeEventInfo)
544 ACPI_EXCEPTION ((AE_INFO, AE_NO_MEMORY,
545 "while handling a GPE"));
549 Status = AcpiUtAcquireMutex (ACPI_MTX_EVENTS);
550 if (ACPI_FAILURE (Status))
555 /* Must revalidate the GpeNumber/GpeBlock */
557 if (!AcpiEvValidGpeEvent (GpeEventInfo))
559 Status = AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
564 * Take a snapshot of the GPE info for this level - we copy the info to
565 * prevent a race condition with RemoveHandler/RemoveBlock.
567 ACPI_MEMCPY (LocalGpeEventInfo, GpeEventInfo,
568 sizeof (ACPI_GPE_EVENT_INFO));
570 Status = AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
571 if (ACPI_FAILURE (Status))
576 /* Do the correct dispatch - normal method or implicit notify */
578 switch (LocalGpeEventInfo->Flags & ACPI_GPE_DISPATCH_MASK)
580 case ACPI_GPE_DISPATCH_NOTIFY:
584 * Dispatch a DEVICE_WAKE notify to the appropriate handler.
585 * NOTE: the request is queued for execution after this method
586 * completes. The notify handlers are NOT invoked synchronously
587 * from this thread -- because handlers may in turn run other
590 * June 2012: Expand implicit notify mechanism to support
591 * notifies on multiple device objects.
593 Notify = LocalGpeEventInfo->Dispatch.NotifyList;
594 while (ACPI_SUCCESS (Status) && Notify)
596 Status = AcpiEvQueueNotifyRequest (Notify->DeviceNode,
597 ACPI_NOTIFY_DEVICE_WAKE);
599 Notify = Notify->Next;
603 case ACPI_GPE_DISPATCH_METHOD:
605 /* Allocate the evaluation information block */
607 Info = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_EVALUATE_INFO));
610 Status = AE_NO_MEMORY;
615 * Invoke the GPE Method (_Lxx, _Exx) i.e., evaluate the
616 * _Lxx/_Exx control method that corresponds to this GPE
618 Info->PrefixNode = LocalGpeEventInfo->Dispatch.MethodNode;
619 Info->Flags = ACPI_IGNORE_RETURN_VALUE;
621 Status = AcpiNsEvaluate (Info);
625 if (ACPI_FAILURE (Status))
627 ACPI_EXCEPTION ((AE_INFO, Status,
628 "while evaluating GPE method [%4.4s]",
629 AcpiUtGetNodeName (LocalGpeEventInfo->Dispatch.MethodNode)));
635 return_VOID; /* Should never happen */
638 /* Defer enabling of GPE until all notify handlers are done */
640 Status = AcpiOsExecute (OSL_NOTIFY_HANDLER,
641 AcpiEvAsynchEnableGpe, LocalGpeEventInfo);
642 if (ACPI_FAILURE (Status))
644 ACPI_FREE (LocalGpeEventInfo);
650 /*******************************************************************************
652 * FUNCTION: AcpiEvAsynchEnableGpe
654 * PARAMETERS: Context (GpeEventInfo) - Info for this GPE
655 * Callback from AcpiOsExecute
659 * DESCRIPTION: Asynchronous clear/enable for GPE. This allows the GPE to
660 * complete (i.e., finish execution of Notify)
662 ******************************************************************************/
664 static void ACPI_SYSTEM_XFACE
665 AcpiEvAsynchEnableGpe (
668 ACPI_GPE_EVENT_INFO *GpeEventInfo = Context;
671 (void) AcpiEvFinishGpe (GpeEventInfo);
673 ACPI_FREE (GpeEventInfo);
678 /*******************************************************************************
680 * FUNCTION: AcpiEvFinishGpe
682 * PARAMETERS: GpeEventInfo - Info for this GPE
686 * DESCRIPTION: Clear/Enable a GPE. Common code that is used after execution
687 * of a GPE method or a synchronous or asynchronous GPE handler.
689 ******************************************************************************/
693 ACPI_GPE_EVENT_INFO *GpeEventInfo)
698 if ((GpeEventInfo->Flags & ACPI_GPE_XRUPT_TYPE_MASK) ==
699 ACPI_GPE_LEVEL_TRIGGERED)
702 * GPE is level-triggered, we clear the GPE status bit after
703 * handling the event.
705 Status = AcpiHwClearGpe (GpeEventInfo);
706 if (ACPI_FAILURE (Status))
713 * Enable this GPE, conditionally. This means that the GPE will
714 * only be physically enabled if the EnableForRun bit is set
717 (void) AcpiHwLowSetGpe (GpeEventInfo, ACPI_GPE_CONDITIONAL_ENABLE);
722 /*******************************************************************************
724 * FUNCTION: AcpiEvGpeDispatch
726 * PARAMETERS: GpeDevice - Device node. NULL for GPE0/GPE1
727 * GpeEventInfo - Info for this GPE
728 * GpeNumber - Number relative to the parent GPE block
730 * RETURN: INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
732 * DESCRIPTION: Dispatch a General Purpose Event to either a function (e.g. EC)
733 * or method (e.g. _Lxx/_Exx) handler.
735 * This function executes at interrupt level.
737 ******************************************************************************/
741 ACPI_NAMESPACE_NODE *GpeDevice,
742 ACPI_GPE_EVENT_INFO *GpeEventInfo,
749 ACPI_FUNCTION_TRACE (EvGpeDispatch);
752 /* Invoke global event handler if present */
755 if (AcpiGbl_GlobalEventHandler)
757 AcpiGbl_GlobalEventHandler (ACPI_EVENT_TYPE_GPE, GpeDevice,
758 GpeNumber, AcpiGbl_GlobalEventHandlerContext);
762 * If edge-triggered, clear the GPE status bit now. Note that
763 * level-triggered events are cleared after the GPE is serviced.
765 if ((GpeEventInfo->Flags & ACPI_GPE_XRUPT_TYPE_MASK) ==
766 ACPI_GPE_EDGE_TRIGGERED)
768 Status = AcpiHwClearGpe (GpeEventInfo);
769 if (ACPI_FAILURE (Status))
771 ACPI_EXCEPTION ((AE_INFO, Status,
772 "Unable to clear GPE%02X", GpeNumber));
773 return_VALUE (ACPI_INTERRUPT_NOT_HANDLED);
778 * Always disable the GPE so that it does not keep firing before
779 * any asynchronous activity completes (either from the execution
780 * of a GPE method or an asynchronous GPE handler.)
782 * If there is no handler or method to run, just disable the
783 * GPE and leave it disabled permanently to prevent further such
784 * pointless events from firing.
786 Status = AcpiHwLowSetGpe (GpeEventInfo, ACPI_GPE_DISABLE);
787 if (ACPI_FAILURE (Status))
789 ACPI_EXCEPTION ((AE_INFO, Status,
790 "Unable to disable GPE%02X", GpeNumber));
791 return_VALUE (ACPI_INTERRUPT_NOT_HANDLED);
795 * Dispatch the GPE to either an installed handler or the control
796 * method associated with this GPE (_Lxx or _Exx). If a handler
797 * exists, we invoke it and do not attempt to run the method.
798 * If there is neither a handler nor a method, leave the GPE
801 switch (GpeEventInfo->Flags & ACPI_GPE_DISPATCH_MASK)
803 case ACPI_GPE_DISPATCH_HANDLER:
805 /* Invoke the installed handler (at interrupt level) */
807 ReturnValue = GpeEventInfo->Dispatch.Handler->Address (
808 GpeDevice, GpeNumber,
809 GpeEventInfo->Dispatch.Handler->Context);
811 /* If requested, clear (if level-triggered) and reenable the GPE */
813 if (ReturnValue & ACPI_REENABLE_GPE)
815 (void) AcpiEvFinishGpe (GpeEventInfo);
819 case ACPI_GPE_DISPATCH_METHOD:
820 case ACPI_GPE_DISPATCH_NOTIFY:
823 * Execute the method associated with the GPE
824 * NOTE: Level-triggered GPEs are cleared after the method completes.
826 Status = AcpiOsExecute (OSL_GPE_HANDLER,
827 AcpiEvAsynchExecuteGpeMethod, GpeEventInfo);
828 if (ACPI_FAILURE (Status))
830 ACPI_EXCEPTION ((AE_INFO, Status,
831 "Unable to queue handler for GPE%02X - event disabled",
839 * No handler or method to run!
840 * 03/2010: This case should no longer be possible. We will not allow
841 * a GPE to be enabled if it has no handler or method.
843 ACPI_ERROR ((AE_INFO,
844 "No handler or method for GPE%02X, disabling event",
849 return_VALUE (ACPI_INTERRUPT_HANDLED);
852 #endif /* !ACPI_REDUCED_HARDWARE */