2 /******************************************************************************
4 * Module Name: hwgpe - Low level GPE enable/disable/clear functions
7 *****************************************************************************/
9 /******************************************************************************
13 * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp.
14 * All rights reserved.
18 * 2.1. This is your license from Intel Corp. under its intellectual property
19 * rights. You may have additional license terms from the party that provided
20 * you this software, covering your right to use that party's intellectual
23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
24 * copy of the source code appearing in this file ("Covered Code") an
25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
26 * base code distributed originally by Intel ("Original Intel Code") to copy,
27 * make derivatives, distribute, use and display any portion of the Covered
28 * Code in any form, with the right to sublicense such rights; and
30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
31 * license (with the right to sublicense), under only those claims of Intel
32 * patents that are infringed by the Original Intel Code, to make, use, sell,
33 * offer to sell, and import the Covered Code and derivative works thereof
34 * solely to the minimum extent necessary to exercise the above copyright
35 * license, and in no event shall the patent license extend to any additions
36 * to or modifications of the Original Intel Code. No other license or right
37 * is granted directly or by implication, estoppel or otherwise;
39 * The above copyright and patent license is granted only if the following
44 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
45 * Redistribution of source code of any substantial portion of the Covered
46 * Code or modification with rights to further distribute source must include
47 * the above Copyright Notice, the above License, this list of Conditions,
48 * and the following Disclaimer and Export Compliance provision. In addition,
49 * Licensee must cause all Covered Code to which Licensee contributes to
50 * contain a file documenting the changes Licensee made to create that Covered
51 * Code and the date of any change. Licensee must include in that file the
52 * documentation of any changes made by any predecessor Licensee. Licensee
53 * must include a prominent statement that the modification is derived,
54 * directly or indirectly, from Original Intel Code.
56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
57 * Redistribution of source code of any substantial portion of the Covered
58 * Code or modification without rights to further distribute source must
59 * include the following Disclaimer and Export Compliance provision in the
60 * documentation and/or other materials provided with distribution. In
61 * addition, Licensee may not authorize further sublicense of source of any
62 * portion of the Covered Code, and must include terms to the effect that the
63 * license from Licensee to its licensee is limited to the intellectual
64 * property embodied in the software Licensee provides to its licensee, and
65 * not to intellectual property embodied in modifications its licensee may
68 * 3.3. Redistribution of Executable. Redistribution in executable form of any
69 * substantial portion of the Covered Code or modification must reproduce the
70 * above Copyright Notice, and the following Disclaimer and Export Compliance
71 * provision in the documentation and/or other materials provided with the
74 * 3.4. Intel retains all right, title, and interest in and to the Original
77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
78 * Intel shall be used in advertising or otherwise to promote the sale, use or
79 * other dealings in products derived from or relating to the Covered Code
80 * without prior written authorization from Intel.
82 * 4. Disclaimer and Export Compliance
84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
101 * 4.3. Licensee shall not export, either directly or indirectly, any of this
102 * software or system incorporating such software without first obtaining any
103 * required license or other approval from the U. S. Department of Commerce or
104 * any other agency or department of the United States Government. In the
105 * event Licensee exports any such software from the United States or
106 * re-exports any such software from a foreign destination, Licensee shall
107 * ensure that the distribution and export/re-export of the software is in
108 * compliance with all laws, regulations, orders, or other restrictions of the
109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
110 * any of its subsidiaries will export/re-export any technical data, process,
111 * software, or service, directly or indirectly, to any country for which the
112 * United States government or any agency thereof requires an export license,
113 * other governmental approval, or letter of assurance, without first obtaining
114 * such license, approval or letter.
116 *****************************************************************************/
119 #include "acevents.h"
121 #define _COMPONENT ACPI_HARDWARE
122 ACPI_MODULE_NAME ("hwgpe")
125 /******************************************************************************
127 * FUNCTION: AcpiHwEnableGpe
129 * PARAMETERS: GpeNumber - The GPE
133 * DESCRIPTION: Enable a single GPE.
135 ******************************************************************************/
139 ACPI_GPE_EVENT_INFO *GpeEventInfo)
145 ACPI_FUNCTION_ENTRY ();
149 * Read the current value of the register, set the appropriate bit
150 * to enable the GPE, and write out the new register.
152 Status = AcpiHwLowLevelRead (8, &InByte,
153 &GpeEventInfo->RegisterInfo->EnableAddress);
154 if (ACPI_FAILURE (Status))
159 /* Write with the new GPE bit enabled */
161 Status = AcpiHwLowLevelWrite (8, (InByte | GpeEventInfo->BitMask),
162 &GpeEventInfo->RegisterInfo->EnableAddress);
168 /******************************************************************************
170 * FUNCTION: AcpiHwEnableGpeForWakeup
172 * PARAMETERS: GpeNumber - The GPE
176 * DESCRIPTION: Keep track of which GPEs the OS has requested not be
177 * disabled when going to sleep.
179 ******************************************************************************/
182 AcpiHwEnableGpeForWakeup (
183 ACPI_GPE_EVENT_INFO *GpeEventInfo)
185 ACPI_GPE_REGISTER_INFO *GpeRegisterInfo;
188 ACPI_FUNCTION_ENTRY ();
191 /* Get the info block for the entire GPE register */
193 GpeRegisterInfo = GpeEventInfo->RegisterInfo;
194 if (!GpeRegisterInfo)
200 * Set the bit so we will not disable this when sleeping
202 GpeRegisterInfo->WakeEnable |= GpeEventInfo->BitMask;
206 /******************************************************************************
208 * FUNCTION: AcpiHwDisableGpe
210 * PARAMETERS: GpeNumber - The GPE
214 * DESCRIPTION: Disable a single GPE.
216 ******************************************************************************/
220 ACPI_GPE_EVENT_INFO *GpeEventInfo)
224 ACPI_GPE_REGISTER_INFO *GpeRegisterInfo;
227 ACPI_FUNCTION_ENTRY ();
230 /* Get the info block for the entire GPE register */
232 GpeRegisterInfo = GpeEventInfo->RegisterInfo;
233 if (!GpeRegisterInfo)
235 return (AE_BAD_PARAMETER);
239 * Read the current value of the register, clear the appropriate bit,
240 * and write out the new register value to disable the GPE.
242 Status = AcpiHwLowLevelRead (8, &InByte,
243 &GpeRegisterInfo->EnableAddress);
244 if (ACPI_FAILURE (Status))
249 /* Write the byte with this GPE bit cleared */
251 Status = AcpiHwLowLevelWrite (8, (InByte & ~(GpeEventInfo->BitMask)),
252 &GpeRegisterInfo->EnableAddress);
253 if (ACPI_FAILURE (Status))
258 AcpiHwDisableGpeForWakeup (GpeEventInfo);
263 /******************************************************************************
265 * FUNCTION: AcpiHwDisableGpeForWakeup
267 * PARAMETERS: GpeNumber - The GPE
271 * DESCRIPTION: Keep track of which GPEs the OS has requested not be
272 * disabled when going to sleep.
274 ******************************************************************************/
277 AcpiHwDisableGpeForWakeup (
278 ACPI_GPE_EVENT_INFO *GpeEventInfo)
280 ACPI_GPE_REGISTER_INFO *GpeRegisterInfo;
283 ACPI_FUNCTION_ENTRY ();
286 /* Get the info block for the entire GPE register */
288 GpeRegisterInfo = GpeEventInfo->RegisterInfo;
289 if (!GpeRegisterInfo)
295 * Clear the bit so we will disable this when sleeping
297 GpeRegisterInfo->WakeEnable &= ~(GpeEventInfo->BitMask);
301 /******************************************************************************
303 * FUNCTION: AcpiHwClearGpe
305 * PARAMETERS: GpeNumber - The GPE
309 * DESCRIPTION: Clear a single GPE.
311 ******************************************************************************/
315 ACPI_GPE_EVENT_INFO *GpeEventInfo)
320 ACPI_FUNCTION_ENTRY ();
324 * Write a one to the appropriate bit in the status register to
327 Status = AcpiHwLowLevelWrite (8, GpeEventInfo->BitMask,
328 &GpeEventInfo->RegisterInfo->StatusAddress);
334 /******************************************************************************
336 * FUNCTION: AcpiHwGetGpeStatus
338 * PARAMETERS: GpeNumber - The GPE
342 * DESCRIPTION: Return the status of a single GPE.
344 ******************************************************************************/
348 ACPI_GPE_EVENT_INFO *GpeEventInfo,
349 ACPI_EVENT_STATUS *EventStatus)
353 ACPI_GPE_REGISTER_INFO *GpeRegisterInfo;
355 ACPI_EVENT_STATUS LocalEventStatus = 0;
358 ACPI_FUNCTION_ENTRY ();
363 return (AE_BAD_PARAMETER);
366 /* Get the info block for the entire GPE register */
368 GpeRegisterInfo = GpeEventInfo->RegisterInfo;
370 /* Get the register bitmask for this GPE */
372 BitMask = GpeEventInfo->BitMask;
376 Status = AcpiHwLowLevelRead (8, &InByte, &GpeRegisterInfo->EnableAddress);
377 if (ACPI_FAILURE (Status))
382 if (BitMask & InByte)
384 LocalEventStatus |= ACPI_EVENT_FLAG_ENABLED;
387 /* GPE Enabled for wake? */
389 if (BitMask & GpeRegisterInfo->WakeEnable)
391 LocalEventStatus |= ACPI_EVENT_FLAG_WAKE_ENABLED;
394 /* GPE active (set)? */
396 Status = AcpiHwLowLevelRead (8, &InByte, &GpeRegisterInfo->StatusAddress);
397 if (ACPI_FAILURE (Status))
402 if (BitMask & InByte)
404 LocalEventStatus |= ACPI_EVENT_FLAG_SET;
407 /* Set return value */
409 (*EventStatus) = LocalEventStatus;
417 /******************************************************************************
419 * FUNCTION: AcpiHwDisableGpeBlock
421 * PARAMETERS: GpeXruptInfo - GPE Interrupt info
422 * GpeBlock - Gpe Block info
426 * DESCRIPTION: Disable all GPEs within a GPE block
428 ******************************************************************************/
431 AcpiHwDisableGpeBlock (
432 ACPI_GPE_XRUPT_INFO *GpeXruptInfo,
433 ACPI_GPE_BLOCK_INFO *GpeBlock)
436 ACPI_GPE_REGISTER_INFO *GpeRegisterInfo;
440 /* Get the register info for the entire GPE block */
442 GpeRegisterInfo = GpeBlock->RegisterInfo;
444 /* Examine each GPE Register within the block */
446 for (i = 0; i < GpeBlock->RegisterCount; i++)
448 Status = AcpiHwLowLevelWrite (8, 0x00,
449 &GpeBlock->RegisterInfo[i].EnableAddress);
450 if (ACPI_FAILURE (Status))
460 /******************************************************************************
462 * FUNCTION: AcpiHwClearGpeBlock
464 * PARAMETERS: GpeXruptInfo - GPE Interrupt info
465 * GpeBlock - Gpe Block info
469 * DESCRIPTION: Clear all GPEs within a GPE block
471 ******************************************************************************/
474 AcpiHwClearGpeBlock (
475 ACPI_GPE_XRUPT_INFO *GpeXruptInfo,
476 ACPI_GPE_BLOCK_INFO *GpeBlock)
479 ACPI_GPE_REGISTER_INFO *GpeRegisterInfo;
483 /* Get the register info for the entire GPE block */
485 GpeRegisterInfo = GpeBlock->RegisterInfo;
487 /* Examine each GPE Register within the block */
489 for (i = 0; i < GpeBlock->RegisterCount; i++)
491 Status = AcpiHwLowLevelWrite (8, 0xFF,
492 &GpeBlock->RegisterInfo[i].StatusAddress);
493 if (ACPI_FAILURE (Status))
503 /******************************************************************************
505 * FUNCTION: AcpiHwDisableNonWakeupGpeBlock
507 * PARAMETERS: GpeXruptInfo - GPE Interrupt info
508 * GpeBlock - Gpe Block info
512 * DESCRIPTION: Disable all GPEs except wakeup GPEs in a GPE block
514 ******************************************************************************/
517 AcpiHwDisableNonWakeupGpeBlock (
518 ACPI_GPE_XRUPT_INFO *GpeXruptInfo,
519 ACPI_GPE_BLOCK_INFO *GpeBlock)
522 ACPI_GPE_REGISTER_INFO *GpeRegisterInfo;
527 /* Get the register info for the entire GPE block */
529 GpeRegisterInfo = GpeBlock->RegisterInfo;
531 /* Examine each GPE Register within the block */
533 for (i = 0; i < GpeBlock->RegisterCount; i++)
536 * Read the enabled status of all GPEs. We
537 * will be using it to restore all the GPEs later.
539 Status = AcpiHwLowLevelRead (8, &InValue,
540 &GpeRegisterInfo->EnableAddress);
541 if (ACPI_FAILURE (Status))
546 GpeRegisterInfo->Enable = (UINT8) InValue;
549 * Disable all GPEs except wakeup GPEs.
551 Status = AcpiHwLowLevelWrite (8, GpeRegisterInfo->WakeEnable,
552 &GpeRegisterInfo->EnableAddress);
553 if (ACPI_FAILURE (Status))
565 /******************************************************************************
567 * FUNCTION: AcpiHwDisableNonWakeupGpes
573 * DESCRIPTION: Disable all non-wakeup GPEs
574 * Called with interrupts disabled. The interrupt handler also
575 * modifies GpeRegisterInfo->Enable, so it should not be
576 * given the chance to run until after non-wake GPEs are
579 ******************************************************************************/
582 AcpiHwDisableNonWakeupGpes (
588 ACPI_FUNCTION_ENTRY ();
591 Status = AcpiEvWalkGpeList (AcpiHwDisableNonWakeupGpeBlock);
597 /******************************************************************************
599 * FUNCTION: AcpiHwEnableNonWakeupGpeBlock
601 * PARAMETERS: GpeXruptInfo - GPE Interrupt info
602 * GpeBlock - Gpe Block info
606 * DESCRIPTION: Enable a single GPE.
608 ******************************************************************************/
611 AcpiHwEnableNonWakeupGpeBlock (
612 ACPI_GPE_XRUPT_INFO *GpeXruptInfo,
613 ACPI_GPE_BLOCK_INFO *GpeBlock)
616 ACPI_GPE_REGISTER_INFO *GpeRegisterInfo;
620 /* This callback processes one entire GPE block */
622 /* Get the register info for the entire GPE block */
624 GpeRegisterInfo = GpeBlock->RegisterInfo;
626 /* Examine each GPE register within the block */
628 for (i = 0; i < GpeBlock->RegisterCount; i++)
631 * We previously stored the enabled status of all GPEs.
632 * Blast them back in.
634 Status = AcpiHwLowLevelWrite (8, GpeRegisterInfo->Enable,
635 &GpeRegisterInfo->EnableAddress);
636 if (ACPI_FAILURE (Status))
649 /******************************************************************************
651 * FUNCTION: AcpiHwEnableNonWakeupGpes
657 * DESCRIPTION: Enable all non-wakeup GPEs we previously enabled.
659 ******************************************************************************/
662 AcpiHwEnableNonWakeupGpes (
668 ACPI_FUNCTION_ENTRY ();
671 Status = AcpiEvWalkGpeList (AcpiHwEnableNonWakeupGpeBlock);