1 /******************************************************************************
3 * Module Name: evxfgpe - External Interfaces for General Purpose Events (GPEs)
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2012, 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.
47 #include <contrib/dev/acpica/include/acpi.h>
48 #include <contrib/dev/acpica/include/accommon.h>
49 #include <contrib/dev/acpica/include/acevents.h>
50 #include <contrib/dev/acpica/include/acnamesp.h>
52 #define _COMPONENT ACPI_EVENTS
53 ACPI_MODULE_NAME ("evxfgpe")
56 #if (!ACPI_REDUCED_HARDWARE) /* Entire module */
57 /*******************************************************************************
59 * FUNCTION: AcpiUpdateAllGpes
65 * DESCRIPTION: Complete GPE initialization and enable all GPEs that have
66 * associated _Lxx or _Exx methods and are not pointed to by any
67 * device _PRW methods (this indicates that these GPEs are
68 * generally intended for system or device wakeup. Such GPEs
69 * have to be enabled directly when the devices whose _PRW
70 * methods point to them are set up for wakeup signaling.)
72 * NOTE: Should be called after any GPEs are added to the system. Primarily,
73 * after the system _PRW methods have been run, but also after a GPE Block
74 * Device has been added or if any new GPE methods have been added via a
77 ******************************************************************************/
86 ACPI_FUNCTION_TRACE (AcpiUpdateGpes);
89 Status = AcpiUtAcquireMutex (ACPI_MTX_EVENTS);
90 if (ACPI_FAILURE (Status))
92 return_ACPI_STATUS (Status);
95 if (AcpiGbl_AllGpesInitialized)
100 Status = AcpiEvWalkGpeList (AcpiEvInitializeGpeBlock, NULL);
101 if (ACPI_SUCCESS (Status))
103 AcpiGbl_AllGpesInitialized = TRUE;
107 (void) AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
108 return_ACPI_STATUS (Status);
111 ACPI_EXPORT_SYMBOL (AcpiUpdateAllGpes)
114 /*******************************************************************************
116 * FUNCTION: AcpiEnableGpe
118 * PARAMETERS: GpeDevice - Parent GPE Device. NULL for GPE0/GPE1
119 * GpeNumber - GPE level within the GPE block
123 * DESCRIPTION: Add a reference to a GPE. On the first reference, the GPE is
126 ******************************************************************************/
130 ACPI_HANDLE GpeDevice,
133 ACPI_STATUS Status = AE_BAD_PARAMETER;
134 ACPI_GPE_EVENT_INFO *GpeEventInfo;
135 ACPI_CPU_FLAGS Flags;
138 ACPI_FUNCTION_TRACE (AcpiEnableGpe);
141 Flags = AcpiOsAcquireLock (AcpiGbl_GpeLock);
143 /* Ensure that we have a valid GPE number */
145 GpeEventInfo = AcpiEvGetGpeEventInfo (GpeDevice, GpeNumber);
148 Status = AcpiEvAddGpeReference (GpeEventInfo);
151 AcpiOsReleaseLock (AcpiGbl_GpeLock, Flags);
152 return_ACPI_STATUS (Status);
155 ACPI_EXPORT_SYMBOL (AcpiEnableGpe)
158 /*******************************************************************************
160 * FUNCTION: AcpiDisableGpe
162 * PARAMETERS: GpeDevice - Parent GPE Device. NULL for GPE0/GPE1
163 * GpeNumber - GPE level within the GPE block
167 * DESCRIPTION: Remove a reference to a GPE. When the last reference is
168 * removed, only then is the GPE disabled (for runtime GPEs), or
169 * the GPE mask bit disabled (for wake GPEs)
171 ******************************************************************************/
175 ACPI_HANDLE GpeDevice,
178 ACPI_STATUS Status = AE_BAD_PARAMETER;
179 ACPI_GPE_EVENT_INFO *GpeEventInfo;
180 ACPI_CPU_FLAGS Flags;
183 ACPI_FUNCTION_TRACE (AcpiDisableGpe);
186 Flags = AcpiOsAcquireLock (AcpiGbl_GpeLock);
188 /* Ensure that we have a valid GPE number */
190 GpeEventInfo = AcpiEvGetGpeEventInfo (GpeDevice, GpeNumber);
193 Status = AcpiEvRemoveGpeReference (GpeEventInfo);
196 AcpiOsReleaseLock (AcpiGbl_GpeLock, Flags);
197 return_ACPI_STATUS (Status);
200 ACPI_EXPORT_SYMBOL (AcpiDisableGpe)
203 /*******************************************************************************
205 * FUNCTION: AcpiSetGpe
207 * PARAMETERS: GpeDevice - Parent GPE Device. NULL for GPE0/GPE1
208 * GpeNumber - GPE level within the GPE block
209 * Action - ACPI_GPE_ENABLE or ACPI_GPE_DISABLE
213 * DESCRIPTION: Enable or disable an individual GPE. This function bypasses
214 * the reference count mechanism used in the AcpiEnableGpe and
215 * AcpiDisableGpe interfaces -- and should be used with care.
217 * Note: Typically used to disable a runtime GPE for short period of time,
218 * then re-enable it, without disturbing the existing reference counts. This
219 * is useful, for example, in the Embedded Controller (EC) driver.
221 ******************************************************************************/
225 ACPI_HANDLE GpeDevice,
229 ACPI_GPE_EVENT_INFO *GpeEventInfo;
231 ACPI_CPU_FLAGS Flags;
234 ACPI_FUNCTION_TRACE (AcpiSetGpe);
237 Flags = AcpiOsAcquireLock (AcpiGbl_GpeLock);
239 /* Ensure that we have a valid GPE number */
241 GpeEventInfo = AcpiEvGetGpeEventInfo (GpeDevice, GpeNumber);
244 Status = AE_BAD_PARAMETER;
248 /* Perform the action */
252 case ACPI_GPE_ENABLE:
253 Status = AcpiEvEnableGpe (GpeEventInfo);
256 case ACPI_GPE_DISABLE:
257 Status = AcpiHwLowSetGpe (GpeEventInfo, ACPI_GPE_DISABLE);
261 Status = AE_BAD_PARAMETER;
266 AcpiOsReleaseLock (AcpiGbl_GpeLock, Flags);
267 return_ACPI_STATUS (Status);
270 ACPI_EXPORT_SYMBOL (AcpiSetGpe)
273 /*******************************************************************************
275 * FUNCTION: AcpiSetupGpeForWake
277 * PARAMETERS: WakeDevice - Device associated with the GPE (via _PRW)
278 * GpeDevice - Parent GPE Device. NULL for GPE0/GPE1
279 * GpeNumber - GPE level within the GPE block
283 * DESCRIPTION: Mark a GPE as having the ability to wake the system. This
284 * interface is intended to be used as the host executes the
285 * _PRW methods (Power Resources for Wake) in the system tables.
286 * Each _PRW appears under a Device Object (The WakeDevice), and
287 * contains the info for the wake GPE associated with the
290 ******************************************************************************/
293 AcpiSetupGpeForWake (
294 ACPI_HANDLE WakeDevice,
295 ACPI_HANDLE GpeDevice,
298 ACPI_STATUS Status = AE_BAD_PARAMETER;
299 ACPI_GPE_EVENT_INFO *GpeEventInfo;
300 ACPI_NAMESPACE_NODE *DeviceNode;
301 ACPI_CPU_FLAGS Flags;
304 ACPI_FUNCTION_TRACE (AcpiSetupGpeForWake);
307 /* Parameter Validation */
312 * By forcing WakeDevice to be valid, we automatically enable the
313 * implicit notify feature on all hosts.
315 return_ACPI_STATUS (AE_BAD_PARAMETER);
318 /* Handle root object case */
320 if (WakeDevice == ACPI_ROOT_OBJECT)
322 DeviceNode = AcpiGbl_RootNode;
326 DeviceNode = ACPI_CAST_PTR (ACPI_NAMESPACE_NODE, WakeDevice);
329 /* Validate WakeDevice is of type Device */
331 if (DeviceNode->Type != ACPI_TYPE_DEVICE)
333 return_ACPI_STATUS (AE_BAD_PARAMETER);
336 Flags = AcpiOsAcquireLock (AcpiGbl_GpeLock);
338 /* Ensure that we have a valid GPE number */
340 GpeEventInfo = AcpiEvGetGpeEventInfo (GpeDevice, GpeNumber);
344 * If there is no method or handler for this GPE, then the
345 * WakeDevice will be notified whenever this GPE fires (aka
346 * "implicit notify") Note: The GPE is assumed to be
347 * level-triggered (for windows compatibility).
349 if ((GpeEventInfo->Flags & ACPI_GPE_DISPATCH_MASK) ==
350 ACPI_GPE_DISPATCH_NONE)
352 GpeEventInfo->Flags =
353 (ACPI_GPE_DISPATCH_NOTIFY | ACPI_GPE_LEVEL_TRIGGERED);
354 GpeEventInfo->Dispatch.DeviceNode = DeviceNode;
357 GpeEventInfo->Flags |= ACPI_GPE_CAN_WAKE;
361 AcpiOsReleaseLock (AcpiGbl_GpeLock, Flags);
362 return_ACPI_STATUS (Status);
365 ACPI_EXPORT_SYMBOL (AcpiSetupGpeForWake)
368 /*******************************************************************************
370 * FUNCTION: AcpiSetGpeWakeMask
372 * PARAMETERS: GpeDevice - Parent GPE Device. NULL for GPE0/GPE1
373 * GpeNumber - GPE level within the GPE block
374 * Action - Enable or Disable
378 * DESCRIPTION: Set or clear the GPE's wakeup enable mask bit. The GPE must
379 * already be marked as a WAKE GPE.
381 ******************************************************************************/
385 ACPI_HANDLE GpeDevice,
389 ACPI_STATUS Status = AE_OK;
390 ACPI_GPE_EVENT_INFO *GpeEventInfo;
391 ACPI_GPE_REGISTER_INFO *GpeRegisterInfo;
392 ACPI_CPU_FLAGS Flags;
396 ACPI_FUNCTION_TRACE (AcpiSetGpeWakeMask);
399 Flags = AcpiOsAcquireLock (AcpiGbl_GpeLock);
402 * Ensure that we have a valid GPE number and that this GPE is in
405 GpeEventInfo = AcpiEvGetGpeEventInfo (GpeDevice, GpeNumber);
408 Status = AE_BAD_PARAMETER;
412 if (!(GpeEventInfo->Flags & ACPI_GPE_CAN_WAKE))
418 GpeRegisterInfo = GpeEventInfo->RegisterInfo;
419 if (!GpeRegisterInfo)
421 Status = AE_NOT_EXIST;
425 RegisterBit = AcpiHwGetGpeRegisterBit (GpeEventInfo, GpeRegisterInfo);
427 /* Perform the action */
431 case ACPI_GPE_ENABLE:
432 ACPI_SET_BIT (GpeRegisterInfo->EnableForWake, (UINT8) RegisterBit);
435 case ACPI_GPE_DISABLE:
436 ACPI_CLEAR_BIT (GpeRegisterInfo->EnableForWake, (UINT8) RegisterBit);
440 ACPI_ERROR ((AE_INFO, "%u, Invalid action", Action));
441 Status = AE_BAD_PARAMETER;
446 AcpiOsReleaseLock (AcpiGbl_GpeLock, Flags);
447 return_ACPI_STATUS (Status);
450 ACPI_EXPORT_SYMBOL (AcpiSetGpeWakeMask)
453 /*******************************************************************************
455 * FUNCTION: AcpiClearGpe
457 * PARAMETERS: GpeDevice - Parent GPE Device. NULL for GPE0/GPE1
458 * GpeNumber - GPE level within the GPE block
462 * DESCRIPTION: Clear an ACPI event (general purpose)
464 ******************************************************************************/
468 ACPI_HANDLE GpeDevice,
471 ACPI_STATUS Status = AE_OK;
472 ACPI_GPE_EVENT_INFO *GpeEventInfo;
473 ACPI_CPU_FLAGS Flags;
476 ACPI_FUNCTION_TRACE (AcpiClearGpe);
479 Flags = AcpiOsAcquireLock (AcpiGbl_GpeLock);
481 /* Ensure that we have a valid GPE number */
483 GpeEventInfo = AcpiEvGetGpeEventInfo (GpeDevice, GpeNumber);
486 Status = AE_BAD_PARAMETER;
490 Status = AcpiHwClearGpe (GpeEventInfo);
493 AcpiOsReleaseLock (AcpiGbl_GpeLock, Flags);
494 return_ACPI_STATUS (Status);
497 ACPI_EXPORT_SYMBOL (AcpiClearGpe)
500 /*******************************************************************************
502 * FUNCTION: AcpiGetGpeStatus
504 * PARAMETERS: GpeDevice - Parent GPE Device. NULL for GPE0/GPE1
505 * GpeNumber - GPE level within the GPE block
506 * EventStatus - Where the current status of the event
511 * DESCRIPTION: Get the current status of a GPE (signalled/not_signalled)
513 ******************************************************************************/
517 ACPI_HANDLE GpeDevice,
519 ACPI_EVENT_STATUS *EventStatus)
521 ACPI_STATUS Status = AE_OK;
522 ACPI_GPE_EVENT_INFO *GpeEventInfo;
523 ACPI_CPU_FLAGS Flags;
526 ACPI_FUNCTION_TRACE (AcpiGetGpeStatus);
529 Flags = AcpiOsAcquireLock (AcpiGbl_GpeLock);
531 /* Ensure that we have a valid GPE number */
533 GpeEventInfo = AcpiEvGetGpeEventInfo (GpeDevice, GpeNumber);
536 Status = AE_BAD_PARAMETER;
540 /* Obtain status on the requested GPE number */
542 Status = AcpiHwGetGpeStatus (GpeEventInfo, EventStatus);
545 AcpiOsReleaseLock (AcpiGbl_GpeLock, Flags);
546 return_ACPI_STATUS (Status);
549 ACPI_EXPORT_SYMBOL (AcpiGetGpeStatus)
552 /*******************************************************************************
554 * FUNCTION: AcpiFinishGpe
556 * PARAMETERS: GpeDevice - Namespace node for the GPE Block
557 * (NULL for FADT defined GPEs)
558 * GpeNumber - GPE level within the GPE block
562 * DESCRIPTION: Clear and conditionally reenable a GPE. This completes the GPE
563 * processing. Intended for use by asynchronous host-installed
564 * GPE handlers. The GPE is only reenabled if the EnableForRun bit
565 * is set in the GPE info.
567 ******************************************************************************/
571 ACPI_HANDLE GpeDevice,
574 ACPI_GPE_EVENT_INFO *GpeEventInfo;
576 ACPI_CPU_FLAGS Flags;
579 ACPI_FUNCTION_TRACE (AcpiFinishGpe);
582 Flags = AcpiOsAcquireLock (AcpiGbl_GpeLock);
584 /* Ensure that we have a valid GPE number */
586 GpeEventInfo = AcpiEvGetGpeEventInfo (GpeDevice, GpeNumber);
589 Status = AE_BAD_PARAMETER;
593 Status = AcpiEvFinishGpe (GpeEventInfo);
596 AcpiOsReleaseLock (AcpiGbl_GpeLock, Flags);
597 return_ACPI_STATUS (Status);
600 ACPI_EXPORT_SYMBOL (AcpiFinishGpe)
603 /******************************************************************************
605 * FUNCTION: AcpiDisableAllGpes
611 * DESCRIPTION: Disable and clear all GPEs in all GPE blocks
613 ******************************************************************************/
622 ACPI_FUNCTION_TRACE (AcpiDisableAllGpes);
625 Status = AcpiUtAcquireMutex (ACPI_MTX_EVENTS);
626 if (ACPI_FAILURE (Status))
628 return_ACPI_STATUS (Status);
631 Status = AcpiHwDisableAllGpes ();
632 (void) AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
634 return_ACPI_STATUS (Status);
637 ACPI_EXPORT_SYMBOL (AcpiDisableAllGpes)
640 /******************************************************************************
642 * FUNCTION: AcpiEnableAllRuntimeGpes
648 * DESCRIPTION: Enable all "runtime" GPEs, in all GPE blocks
650 ******************************************************************************/
653 AcpiEnableAllRuntimeGpes (
659 ACPI_FUNCTION_TRACE (AcpiEnableAllRuntimeGpes);
662 Status = AcpiUtAcquireMutex (ACPI_MTX_EVENTS);
663 if (ACPI_FAILURE (Status))
665 return_ACPI_STATUS (Status);
668 Status = AcpiHwEnableAllRuntimeGpes ();
669 (void) AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
671 return_ACPI_STATUS (Status);
674 ACPI_EXPORT_SYMBOL (AcpiEnableAllRuntimeGpes)
677 /*******************************************************************************
679 * FUNCTION: AcpiInstallGpeBlock
681 * PARAMETERS: GpeDevice - Handle to the parent GPE Block Device
682 * GpeBlockAddress - Address and SpaceID
683 * RegisterCount - Number of GPE register pairs in the block
684 * InterruptNumber - H/W interrupt for the block
688 * DESCRIPTION: Create and Install a block of GPE registers. The GPEs are not
691 ******************************************************************************/
694 AcpiInstallGpeBlock (
695 ACPI_HANDLE GpeDevice,
696 ACPI_GENERIC_ADDRESS *GpeBlockAddress,
697 UINT32 RegisterCount,
698 UINT32 InterruptNumber)
701 ACPI_OPERAND_OBJECT *ObjDesc;
702 ACPI_NAMESPACE_NODE *Node;
703 ACPI_GPE_BLOCK_INFO *GpeBlock;
706 ACPI_FUNCTION_TRACE (AcpiInstallGpeBlock);
710 (!GpeBlockAddress) ||
713 return_ACPI_STATUS (AE_BAD_PARAMETER);
716 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
717 if (ACPI_FAILURE (Status))
722 Node = AcpiNsValidateHandle (GpeDevice);
725 Status = AE_BAD_PARAMETER;
730 * For user-installed GPE Block Devices, the GpeBlockBaseNumber
733 Status = AcpiEvCreateGpeBlock (Node, GpeBlockAddress, RegisterCount,
734 0, InterruptNumber, &GpeBlock);
735 if (ACPI_FAILURE (Status))
740 /* Install block in the DeviceObject attached to the node */
742 ObjDesc = AcpiNsGetAttachedObject (Node);
746 * No object, create a new one (Device nodes do not always have
747 * an attached object)
749 ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_DEVICE);
752 Status = AE_NO_MEMORY;
756 Status = AcpiNsAttachObject (Node, ObjDesc, ACPI_TYPE_DEVICE);
758 /* Remove local reference to the object */
760 AcpiUtRemoveReference (ObjDesc);
761 if (ACPI_FAILURE (Status))
767 /* Now install the GPE block in the DeviceObject */
769 ObjDesc->Device.GpeBlock = GpeBlock;
773 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
774 return_ACPI_STATUS (Status);
777 ACPI_EXPORT_SYMBOL (AcpiInstallGpeBlock)
780 /*******************************************************************************
782 * FUNCTION: AcpiRemoveGpeBlock
784 * PARAMETERS: GpeDevice - Handle to the parent GPE Block Device
788 * DESCRIPTION: Remove a previously installed block of GPE registers
790 ******************************************************************************/
794 ACPI_HANDLE GpeDevice)
796 ACPI_OPERAND_OBJECT *ObjDesc;
798 ACPI_NAMESPACE_NODE *Node;
801 ACPI_FUNCTION_TRACE (AcpiRemoveGpeBlock);
806 return_ACPI_STATUS (AE_BAD_PARAMETER);
809 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
810 if (ACPI_FAILURE (Status))
815 Node = AcpiNsValidateHandle (GpeDevice);
818 Status = AE_BAD_PARAMETER;
822 /* Get the DeviceObject attached to the node */
824 ObjDesc = AcpiNsGetAttachedObject (Node);
826 !ObjDesc->Device.GpeBlock)
828 return_ACPI_STATUS (AE_NULL_OBJECT);
831 /* Delete the GPE block (but not the DeviceObject) */
833 Status = AcpiEvDeleteGpeBlock (ObjDesc->Device.GpeBlock);
834 if (ACPI_SUCCESS (Status))
836 ObjDesc->Device.GpeBlock = NULL;
840 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
841 return_ACPI_STATUS (Status);
844 ACPI_EXPORT_SYMBOL (AcpiRemoveGpeBlock)
847 /*******************************************************************************
849 * FUNCTION: AcpiGetGpeDevice
851 * PARAMETERS: Index - System GPE index (0-CurrentGpeCount)
852 * GpeDevice - Where the parent GPE Device is returned
856 * DESCRIPTION: Obtain the GPE device associated with the input index. A NULL
857 * gpe device indicates that the gpe number is contained in one of
858 * the FADT-defined gpe blocks. Otherwise, the GPE block device.
860 ******************************************************************************/
865 ACPI_HANDLE *GpeDevice)
867 ACPI_GPE_DEVICE_INFO Info;
871 ACPI_FUNCTION_TRACE (AcpiGetGpeDevice);
876 return_ACPI_STATUS (AE_BAD_PARAMETER);
879 if (Index >= AcpiCurrentGpeCount)
881 return_ACPI_STATUS (AE_NOT_EXIST);
884 /* Setup and walk the GPE list */
887 Info.Status = AE_NOT_EXIST;
888 Info.GpeDevice = NULL;
889 Info.NextBlockBaseIndex = 0;
891 Status = AcpiEvWalkGpeList (AcpiEvGetGpeDevice, &Info);
892 if (ACPI_FAILURE (Status))
894 return_ACPI_STATUS (Status);
897 *GpeDevice = ACPI_CAST_PTR (ACPI_HANDLE, Info.GpeDevice);
898 return_ACPI_STATUS (Info.Status);
901 ACPI_EXPORT_SYMBOL (AcpiGetGpeDevice)
903 #endif /* !ACPI_REDUCED_HARDWARE */