1 /******************************************************************************
3 * Name: hwsleep.c - ACPI Hardware Sleep/Wake Support functions for the
4 * original/legacy sleep/PM registers.
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2013, Intel Corp.
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions, and the following disclaimer,
17 * without modification.
18 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
19 * substantially similar to the "NO WARRANTY" disclaimer below
20 * ("Disclaimer") and any redistribution must be conditioned upon
21 * including a substantially similar Disclaimer requirement for further
22 * binary redistribution.
23 * 3. Neither the names of the above-listed copyright holders nor the names
24 * of any contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
27 * Alternatively, this software may be distributed under the terms of the
28 * GNU General Public License ("GPL") version 2 as published by the Free
29 * Software Foundation.
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
35 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42 * POSSIBILITY OF SUCH DAMAGES.
45 #include <contrib/dev/acpica/include/acpi.h>
46 #include <contrib/dev/acpica/include/accommon.h>
48 #define _COMPONENT ACPI_HARDWARE
49 ACPI_MODULE_NAME ("hwsleep")
52 #if (!ACPI_REDUCED_HARDWARE) /* Entire module */
53 /*******************************************************************************
55 * FUNCTION: AcpiHwLegacySleep
57 * PARAMETERS: SleepState - Which sleep state to enter
61 * DESCRIPTION: Enter a system sleep state via the legacy FADT PM registers
62 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
64 ******************************************************************************/
70 ACPI_BIT_REGISTER_INFO *SleepTypeRegInfo;
71 ACPI_BIT_REGISTER_INFO *SleepEnableRegInfo;
79 ACPI_FUNCTION_TRACE (HwLegacySleep);
82 SleepTypeRegInfo = AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_TYPE);
83 SleepEnableRegInfo = AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_ENABLE);
85 /* Clear wake status */
87 Status = AcpiWriteBitRegister (ACPI_BITREG_WAKE_STATUS, ACPI_CLEAR_STATUS);
88 if (ACPI_FAILURE (Status))
90 return_ACPI_STATUS (Status);
93 /* Clear all fixed and general purpose status bits */
95 Status = AcpiHwClearAcpiStatus ();
96 if (ACPI_FAILURE (Status))
98 return_ACPI_STATUS (Status);
102 * 1) Disable/Clear all GPEs
103 * 2) Enable all wakeup GPEs
105 Status = AcpiHwDisableAllGpes ();
106 if (ACPI_FAILURE (Status))
108 return_ACPI_STATUS (Status);
110 AcpiGbl_SystemAwakeAndRunning = FALSE;
112 Status = AcpiHwEnableAllWakeupGpes ();
113 if (ACPI_FAILURE (Status))
115 return_ACPI_STATUS (Status);
118 /* Get current value of PM1A control */
120 Status = AcpiHwRegisterRead (ACPI_REGISTER_PM1_CONTROL,
122 if (ACPI_FAILURE (Status))
124 return_ACPI_STATUS (Status);
126 ACPI_DEBUG_PRINT ((ACPI_DB_INIT,
127 "Entering sleep state [S%u]\n", SleepState));
129 /* Clear the SLP_EN and SLP_TYP fields */
131 Pm1aControl &= ~(SleepTypeRegInfo->AccessBitMask |
132 SleepEnableRegInfo->AccessBitMask);
133 Pm1bControl = Pm1aControl;
135 /* Insert the SLP_TYP bits */
137 Pm1aControl |= (AcpiGbl_SleepTypeA << SleepTypeRegInfo->BitPosition);
138 Pm1bControl |= (AcpiGbl_SleepTypeB << SleepTypeRegInfo->BitPosition);
141 * We split the writes of SLP_TYP and SLP_EN to workaround
142 * poorly implemented hardware.
145 /* Write #1: write the SLP_TYP data to the PM1 Control registers */
147 Status = AcpiHwWritePm1Control (Pm1aControl, Pm1bControl);
148 if (ACPI_FAILURE (Status))
150 return_ACPI_STATUS (Status);
153 /* Insert the sleep enable (SLP_EN) bit */
155 Pm1aControl |= SleepEnableRegInfo->AccessBitMask;
156 Pm1bControl |= SleepEnableRegInfo->AccessBitMask;
158 /* Flush caches, as per ACPI specification */
160 ACPI_FLUSH_CPU_CACHE ();
162 /* Write #2: Write both SLP_TYP + SLP_EN */
164 Status = AcpiHwWritePm1Control (Pm1aControl, Pm1bControl);
165 if (ACPI_FAILURE (Status))
167 return_ACPI_STATUS (Status);
170 if (SleepState > ACPI_STATE_S3)
173 * We wanted to sleep > S3, but it didn't happen (by virtue of the
174 * fact that we are still executing!)
176 * Wait ten seconds, then try again. This is to get S4/S5 to work on
179 * We wait so long to allow chipsets that poll this reg very slowly
180 * to still read the right value. Ideally, this block would go
183 AcpiOsStall (10 * ACPI_USEC_PER_SEC);
185 Status = AcpiHwRegisterWrite (ACPI_REGISTER_PM1_CONTROL,
186 SleepEnableRegInfo->AccessBitMask);
187 if (ACPI_FAILURE (Status))
189 return_ACPI_STATUS (Status);
193 /* Wait for transition back to Working State */
198 Status = AcpiReadBitRegister (ACPI_BITREG_WAKE_STATUS, &InValue);
199 if (ACPI_FAILURE (Status))
201 return_ACPI_STATUS (Status);
204 if (AcpiGbl_EnableInterpreterSlack)
207 * Some BIOSs don't set WAK_STS at all. Give up waiting after
208 * 1000 retries if it still isn't set.
218 return_ACPI_STATUS (AE_OK);
222 /*******************************************************************************
224 * FUNCTION: AcpiHwLegacyWakePrep
226 * PARAMETERS: SleepState - Which sleep state we just exited
230 * DESCRIPTION: Perform the first state of OS-independent ACPI cleanup after a
232 * Called with interrupts ENABLED.
234 ******************************************************************************/
237 AcpiHwLegacyWakePrep (
241 ACPI_BIT_REGISTER_INFO *SleepTypeRegInfo;
242 ACPI_BIT_REGISTER_INFO *SleepEnableRegInfo;
247 ACPI_FUNCTION_TRACE (HwLegacyWakePrep);
250 * Set SLP_TYPE and SLP_EN to state S0.
251 * This is unclear from the ACPI Spec, but it is required
254 Status = AcpiGetSleepTypeData (ACPI_STATE_S0,
255 &AcpiGbl_SleepTypeA, &AcpiGbl_SleepTypeB);
256 if (ACPI_SUCCESS (Status))
259 AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_TYPE);
261 AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_ENABLE);
263 /* Get current value of PM1A control */
265 Status = AcpiHwRegisterRead (ACPI_REGISTER_PM1_CONTROL,
267 if (ACPI_SUCCESS (Status))
269 /* Clear the SLP_EN and SLP_TYP fields */
271 Pm1aControl &= ~(SleepTypeRegInfo->AccessBitMask |
272 SleepEnableRegInfo->AccessBitMask);
273 Pm1bControl = Pm1aControl;
275 /* Insert the SLP_TYP bits */
277 Pm1aControl |= (AcpiGbl_SleepTypeA <<
278 SleepTypeRegInfo->BitPosition);
279 Pm1bControl |= (AcpiGbl_SleepTypeB <<
280 SleepTypeRegInfo->BitPosition);
282 /* Write the control registers and ignore any errors */
284 (void) AcpiHwWritePm1Control (Pm1aControl, Pm1bControl);
288 return_ACPI_STATUS (Status);
292 /*******************************************************************************
294 * FUNCTION: AcpiHwLegacyWake
296 * PARAMETERS: SleepState - Which sleep state we just exited
300 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
301 * Called with interrupts ENABLED.
303 ******************************************************************************/
312 ACPI_FUNCTION_TRACE (HwLegacyWake);
315 /* Ensure EnterSleepStatePrep -> EnterSleepState ordering */
317 AcpiGbl_SleepTypeA = ACPI_SLEEP_TYPE_INVALID;
318 AcpiHwExecuteSleepMethod (METHOD_PATHNAME__SST, ACPI_SST_WAKING);
321 * GPEs must be enabled before _WAK is called as GPEs
322 * might get fired there
325 * 1) Disable/Clear all GPEs
326 * 2) Enable all runtime GPEs
328 Status = AcpiHwDisableAllGpes ();
329 if (ACPI_FAILURE (Status))
331 return_ACPI_STATUS (Status);
334 Status = AcpiHwEnableAllRuntimeGpes ();
335 if (ACPI_FAILURE (Status))
337 return_ACPI_STATUS (Status);
341 * Now we can execute _WAK, etc. Some machines require that the GPEs
342 * are enabled before the wake methods are executed.
344 AcpiHwExecuteSleepMethod (METHOD_PATHNAME__WAK, SleepState);
347 * Some BIOS code assumes that WAK_STS will be cleared on resume
348 * and use it to determine whether the system is rebooting or
349 * resuming. Clear WAK_STS for compatibility.
351 (void) AcpiWriteBitRegister (ACPI_BITREG_WAKE_STATUS, ACPI_CLEAR_STATUS);
352 AcpiGbl_SystemAwakeAndRunning = TRUE;
354 /* Enable power button */
356 (void) AcpiWriteBitRegister(
357 AcpiGbl_FixedEventInfo[ACPI_EVENT_POWER_BUTTON].EnableRegisterId,
360 (void) AcpiWriteBitRegister(
361 AcpiGbl_FixedEventInfo[ACPI_EVENT_POWER_BUTTON].StatusRegisterId,
364 AcpiHwExecuteSleepMethod (METHOD_PATHNAME__SST, ACPI_SST_WORKING);
365 return_ACPI_STATUS (Status);
368 #endif /* !ACPI_REDUCED_HARDWARE */