1 /******************************************************************************
3 * Module Name: evxfevnt - External Interfaces, ACPI event disable/enable
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp.
13 * All rights reserved.
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights. You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code. No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
38 * The above copyright and patent license is granted only if the following
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial prton of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision. In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change. Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee. Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution. In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
73 * 3.4. Intel retains all right, title, and interest in and to the Original
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
81 * 4. Disclaimer and Export Compliance
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
115 *****************************************************************************/
118 #define __EVXFEVNT_C__
121 #include "acevents.h"
122 #include "acnamesp.h"
124 #define _COMPONENT ACPI_EVENTS
125 ACPI_MODULE_NAME ("evxfevnt")
128 /*******************************************************************************
130 * FUNCTION: AcpiEnable
136 * DESCRIPTION: Transfers the system into ACPI mode.
138 ******************************************************************************/
143 ACPI_STATUS Status = AE_OK;
146 ACPI_FUNCTION_TRACE ("AcpiEnable");
149 /* Make sure we have the FADT*/
153 ACPI_DEBUG_PRINT ((ACPI_DB_WARN, "No FADT information present!\n"));
154 return_ACPI_STATUS (AE_NO_ACPI_TABLES);
157 if (AcpiHwGetMode() == ACPI_SYS_MODE_ACPI)
159 ACPI_DEBUG_PRINT ((ACPI_DB_INIT, "System is already in ACPI mode\n"));
163 /* Transition to ACPI mode */
165 Status = AcpiHwSetMode (ACPI_SYS_MODE_ACPI);
166 if (ACPI_FAILURE (Status))
168 ACPI_REPORT_ERROR (("Could not transition to ACPI mode.\n"));
169 return_ACPI_STATUS (Status);
172 ACPI_DEBUG_PRINT ((ACPI_DB_INIT, "Transition to ACPI mode successful\n"));
175 return_ACPI_STATUS (Status);
179 /*******************************************************************************
181 * FUNCTION: AcpiDisable
187 * DESCRIPTION: Transfers the system into LEGACY mode.
189 ******************************************************************************/
194 ACPI_STATUS Status = AE_OK;
197 ACPI_FUNCTION_TRACE ("AcpiDisable");
202 ACPI_DEBUG_PRINT ((ACPI_DB_WARN, "No FADT information present!\n"));
203 return_ACPI_STATUS (AE_NO_ACPI_TABLES);
206 if (AcpiHwGetMode() == ACPI_SYS_MODE_LEGACY)
208 ACPI_DEBUG_PRINT ((ACPI_DB_INIT, "System is already in legacy (non-ACPI) mode\n"));
212 /* Transition to LEGACY mode */
214 Status = AcpiHwSetMode (ACPI_SYS_MODE_LEGACY);
216 if (ACPI_FAILURE (Status))
218 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "Could not exit ACPI mode to legacy mode"));
219 return_ACPI_STATUS (Status);
222 ACPI_DEBUG_PRINT ((ACPI_DB_INIT, "ACPI mode disabled\n"));
225 return_ACPI_STATUS (Status);
229 /*******************************************************************************
231 * FUNCTION: AcpiEnableEvent
233 * PARAMETERS: Event - The fixed eventto be enabled
238 * DESCRIPTION: Enable an ACPI event (fixed)
240 ******************************************************************************/
247 ACPI_STATUS Status = AE_OK;
251 ACPI_FUNCTION_TRACE ("AcpiEnableEvent");
254 /* Decode the Fixed Event */
256 if (Event > ACPI_EVENT_MAX)
258 return_ACPI_STATUS (AE_BAD_PARAMETER);
262 * Enable the requested fixed event (by writing a one to the
263 * enable register bit)
265 Status = AcpiSetRegister (AcpiGbl_FixedEventInfo[Event].EnableRegisterId,
267 if (ACPI_FAILURE (Status))
269 return_ACPI_STATUS (Status);
272 /* Make sure that the hardware responded */
274 Status = AcpiGetRegister (AcpiGbl_FixedEventInfo[Event].EnableRegisterId,
275 &Value, ACPI_MTX_LOCK);
276 if (ACPI_FAILURE (Status))
278 return_ACPI_STATUS (Status);
283 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
284 "Could not enable %s event\n", AcpiUtGetEventName (Event)));
285 return_ACPI_STATUS (AE_NO_HARDWARE_RESPONSE);
288 return_ACPI_STATUS (Status);
292 /*******************************************************************************
294 * FUNCTION: AcpiEnableGpe
296 * PARAMETERS: GpeDevice - Parent GPE Device
297 * GpeNumber - GPE level within the GPE block
298 * Flags - Just enable, or also wake enable?
299 * Called from ISR or not
303 * DESCRIPTION: Enable an ACPI event (general purpose)
305 ******************************************************************************/
309 ACPI_HANDLE GpeDevice,
313 ACPI_STATUS Status = AE_OK;
314 ACPI_GPE_EVENT_INFO *GpeEventInfo;
317 ACPI_FUNCTION_TRACE ("AcpiEnableGpe");
320 /* Use semaphore lock if not executing at interrupt level */
322 if (Flags & ACPI_NOT_ISR)
324 Status = AcpiUtAcquireMutex (ACPI_MTX_EVENTS);
325 if (ACPI_FAILURE (Status))
327 return_ACPI_STATUS (Status);
331 /* Ensure that we have a valid GPE number */
333 GpeEventInfo = AcpiEvGetGpeEventInfo (GpeDevice, GpeNumber);
336 Status = AE_BAD_PARAMETER;
340 /* Enable the requested GPE number */
342 Status = AcpiHwEnableGpe (GpeEventInfo);
343 if (ACPI_FAILURE (Status))
348 if (Flags & ACPI_EVENT_WAKE_ENABLE)
350 AcpiHwEnableGpeForWakeup (GpeEventInfo);
354 if (Flags & ACPI_NOT_ISR)
356 (void) AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
358 return_ACPI_STATUS (Status);
362 /*******************************************************************************
364 * FUNCTION: AcpiDisableEvent
366 * PARAMETERS: Event - The fixed eventto be enabled
371 * DESCRIPTION: Disable an ACPI event (fixed)
373 ******************************************************************************/
380 ACPI_STATUS Status = AE_OK;
384 ACPI_FUNCTION_TRACE ("AcpiDisableEvent");
387 /* Decode the Fixed Event */
389 if (Event > ACPI_EVENT_MAX)
391 return_ACPI_STATUS (AE_BAD_PARAMETER);
395 * Disable the requested fixed event (by writing a zero to the
396 * enable register bit)
398 Status = AcpiSetRegister (AcpiGbl_FixedEventInfo[Event].EnableRegisterId,
400 if (ACPI_FAILURE (Status))
402 return_ACPI_STATUS (Status);
405 Status = AcpiGetRegister (AcpiGbl_FixedEventInfo[Event].EnableRegisterId,
406 &Value, ACPI_MTX_LOCK);
407 if (ACPI_FAILURE (Status))
409 return_ACPI_STATUS (Status);
414 ACPI_DEBUG_PRINT ((ACPI_DB_ERROR,
415 "Could not disable %s events\n", AcpiUtGetEventName (Event)));
416 return_ACPI_STATUS (AE_NO_HARDWARE_RESPONSE);
419 return_ACPI_STATUS (Status);
423 /*******************************************************************************
425 * FUNCTION: AcpiDisableGpe
427 * PARAMETERS: GpeDevice - Parent GPE Device
428 * GpeNumber - GPE level within the GPE block
429 * Flags - Just enable, or also wake enable?
430 * Called from ISR or not
434 * DESCRIPTION: Disable an ACPI event (general purpose)
436 ******************************************************************************/
440 ACPI_HANDLE GpeDevice,
444 ACPI_STATUS Status = AE_OK;
445 ACPI_GPE_EVENT_INFO *GpeEventInfo;
448 ACPI_FUNCTION_TRACE ("AcpiDisableGpe");
451 /* Use semaphore lock if not executing at interrupt level */
453 if (Flags & ACPI_NOT_ISR)
455 Status = AcpiUtAcquireMutex (ACPI_MTX_EVENTS);
456 if (ACPI_FAILURE (Status))
458 return_ACPI_STATUS (Status);
462 /* Ensure that we have a valid GPE number */
464 GpeEventInfo = AcpiEvGetGpeEventInfo (GpeDevice, GpeNumber);
467 Status = AE_BAD_PARAMETER;
472 * Only disable the requested GPE number for wake if specified.
473 * Otherwise, turn it totally off
475 if (Flags & ACPI_EVENT_WAKE_DISABLE)
477 AcpiHwDisableGpeForWakeup (GpeEventInfo);
481 Status = AcpiHwDisableGpe (GpeEventInfo);
485 if (Flags & ACPI_NOT_ISR)
487 (void) AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
489 return_ACPI_STATUS (Status);
493 /*******************************************************************************
495 * FUNCTION: AcpiClearEvent
497 * PARAMETERS: Event - The fixed event to be cleared
501 * DESCRIPTION: Clear an ACPI event (fixed)
503 ******************************************************************************/
509 ACPI_STATUS Status = AE_OK;
512 ACPI_FUNCTION_TRACE ("AcpiClearEvent");
515 /* Decode the Fixed Event */
517 if (Event > ACPI_EVENT_MAX)
519 return_ACPI_STATUS (AE_BAD_PARAMETER);
523 * Clear the requested fixed event (By writing a one to the
524 * status register bit)
526 Status = AcpiSetRegister (AcpiGbl_FixedEventInfo[Event].StatusRegisterId,
529 return_ACPI_STATUS (Status);
533 /*******************************************************************************
535 * FUNCTION: AcpiClearGpe
537 * PARAMETERS: GpeDevice - Parent GPE Device
538 * GpeNumber - GPE level within the GPE block
539 * Flags - Called from an ISR or not
543 * DESCRIPTION: Clear an ACPI event (general purpose)
545 ******************************************************************************/
549 ACPI_HANDLE GpeDevice,
553 ACPI_STATUS Status = AE_OK;
554 ACPI_GPE_EVENT_INFO *GpeEventInfo;
557 ACPI_FUNCTION_TRACE ("AcpiClearGpe");
560 /* Use semaphore lock if not executing at interrupt level */
562 if (Flags & ACPI_NOT_ISR)
564 Status = AcpiUtAcquireMutex (ACPI_MTX_EVENTS);
565 if (ACPI_FAILURE (Status))
567 return_ACPI_STATUS (Status);
571 /* Ensure that we have a valid GPE number */
573 GpeEventInfo = AcpiEvGetGpeEventInfo (GpeDevice, GpeNumber);
576 Status = AE_BAD_PARAMETER;
580 Status = AcpiHwClearGpe (GpeEventInfo);
583 if (Flags & ACPI_NOT_ISR)
585 (void) AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
587 return_ACPI_STATUS (Status);
591 /*******************************************************************************
593 * FUNCTION: AcpiGetEventStatus
595 * PARAMETERS: Event - The fixed event
596 * Event Status - Where the current status of the event will
601 * DESCRIPTION: Obtains and returns the current status of the event
603 ******************************************************************************/
608 ACPI_EVENT_STATUS *EventStatus)
610 ACPI_STATUS Status = AE_OK;
613 ACPI_FUNCTION_TRACE ("AcpiGetEventStatus");
618 return_ACPI_STATUS (AE_BAD_PARAMETER);
621 /* Decode the Fixed Event */
623 if (Event > ACPI_EVENT_MAX)
625 return_ACPI_STATUS (AE_BAD_PARAMETER);
628 /* Get the status of the requested fixed event */
630 Status = AcpiGetRegister (AcpiGbl_FixedEventInfo[Event].StatusRegisterId,
631 EventStatus, ACPI_MTX_LOCK);
633 return_ACPI_STATUS (Status);
637 /*******************************************************************************
639 * FUNCTION: AcpiGetGpeStatus
641 * PARAMETERS: GpeDevice - Parent GPE Device
642 * GpeNumber - GPE level within the GPE block
643 * Flags - Called from an ISR or not
644 * Event Status - Where the current status of the event will
649 * DESCRIPTION: Get status of an event (general purpose)
651 ******************************************************************************/
655 ACPI_HANDLE GpeDevice,
658 ACPI_EVENT_STATUS *EventStatus)
660 ACPI_STATUS Status = AE_OK;
661 ACPI_GPE_EVENT_INFO *GpeEventInfo;
664 ACPI_FUNCTION_TRACE ("AcpiGetGpeStatus");
667 /* Use semaphore lock if not executing at interrupt level */
669 if (Flags & ACPI_NOT_ISR)
671 Status = AcpiUtAcquireMutex (ACPI_MTX_EVENTS);
672 if (ACPI_FAILURE (Status))
674 return_ACPI_STATUS (Status);
678 /* Ensure that we have a valid GPE number */
680 GpeEventInfo = AcpiEvGetGpeEventInfo (GpeDevice, GpeNumber);
683 Status = AE_BAD_PARAMETER;
687 /* Obtain status on the requested GPE number */
689 Status = AcpiHwGetGpeStatus (GpeEventInfo, EventStatus);
692 if (Flags & ACPI_NOT_ISR)
694 (void) AcpiUtReleaseMutex (ACPI_MTX_EVENTS);
696 return_ACPI_STATUS (Status);
700 /*******************************************************************************
702 * FUNCTION: AcpiInstallGpeBlock
704 * PARAMETERS: GpeDevice - Handle to the parent GPE Block Device
705 * GpeBlockAddress - Address and SpaceID
706 * RegisterCount - Number of GPE register pairs in the block
707 * InterruptLevel - H/W interrupt for the block
711 * DESCRIPTION: Create and Install a block of GPE registers
713 ******************************************************************************/
716 AcpiInstallGpeBlock (
717 ACPI_HANDLE GpeDevice,
718 ACPI_GENERIC_ADDRESS *GpeBlockAddress,
719 UINT32 RegisterCount,
720 UINT32 InterruptLevel)
723 ACPI_OPERAND_OBJECT *ObjDesc;
724 ACPI_NAMESPACE_NODE *Node;
725 ACPI_GPE_BLOCK_INFO *GpeBlock;
728 ACPI_FUNCTION_TRACE ("AcpiInstallGpeBlock");
732 (!GpeBlockAddress) ||
735 return_ACPI_STATUS (AE_BAD_PARAMETER);
738 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
739 if (ACPI_FAILURE (Status))
744 Node = AcpiNsMapHandleToNode (GpeDevice);
747 Status = AE_BAD_PARAMETER;
752 * For user-installed GPE Block Devices, the GpeBlockBaseNumber
755 Status = AcpiEvCreateGpeBlock (Node, GpeBlockAddress, RegisterCount,
756 0, InterruptLevel, &GpeBlock);
757 if (ACPI_FAILURE (Status))
762 /* Get the DeviceObject attached to the node */
764 ObjDesc = AcpiNsGetAttachedObject (Node);
767 /* No object, create a new one */
769 ObjDesc = AcpiUtCreateInternalObject (ACPI_TYPE_DEVICE);
772 Status = AE_NO_MEMORY;
776 Status = AcpiNsAttachObject (Node, ObjDesc, ACPI_TYPE_DEVICE);
778 /* Remove local reference to the object */
780 AcpiUtRemoveReference (ObjDesc);
782 if (ACPI_FAILURE (Status))
788 /* Install the GPE block in the DeviceObject */
790 ObjDesc->Device.GpeBlock = GpeBlock;
794 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
795 return_ACPI_STATUS (Status);
799 /*******************************************************************************
801 * FUNCTION: AcpiRemoveGpeBlock
803 * PARAMETERS: GpeDevice - Handle to the parent GPE Block Device
807 * DESCRIPTION: Remove a previously installed block of GPE registers
809 ******************************************************************************/
813 ACPI_HANDLE GpeDevice)
815 ACPI_OPERAND_OBJECT *ObjDesc;
817 ACPI_NAMESPACE_NODE *Node;
820 ACPI_FUNCTION_TRACE ("AcpiRemoveGpeBlock");
825 return_ACPI_STATUS (AE_BAD_PARAMETER);
828 Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
829 if (ACPI_FAILURE (Status))
834 Node = AcpiNsMapHandleToNode (GpeDevice);
837 Status = AE_BAD_PARAMETER;
841 /* Get the DeviceObject attached to the node */
843 ObjDesc = AcpiNsGetAttachedObject (Node);
845 !ObjDesc->Device.GpeBlock)
847 return_ACPI_STATUS (AE_NULL_OBJECT);
850 /* Delete the GPE block (but not the DeviceObject) */
852 Status = AcpiEvDeleteGpeBlock (ObjDesc->Device.GpeBlock);
853 if (ACPI_SUCCESS (Status))
855 ObjDesc->Device.GpeBlock = NULL;
859 (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
860 return_ACPI_STATUS (Status);