1 /******************************************************************************
3 * Name: hwsleep.c - ACPI Hardware Sleep/Wake Support functions for the
4 * original/legacy sleep/PM registers.
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2020, 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 portion 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 *****************************************************************************
117 * Alternatively, you may choose to be licensed under the terms of the
120 * Redistribution and use in source and binary forms, with or without
121 * modification, are permitted provided that the following conditions
123 * 1. Redistributions of source code must retain the above copyright
124 * notice, this list of conditions, and the following disclaimer,
125 * without modification.
126 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
127 * substantially similar to the "NO WARRANTY" disclaimer below
128 * ("Disclaimer") and any redistribution must be conditioned upon
129 * including a substantially similar Disclaimer requirement for further
130 * binary redistribution.
131 * 3. Neither the names of the above-listed copyright holders nor the names
132 * of any contributors may be used to endorse or promote products derived
133 * from this software without specific prior written permission.
135 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
136 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
137 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
138 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
139 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
140 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
141 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
142 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
143 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
144 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
145 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
147 * Alternatively, you may choose to be licensed under the terms of the
148 * GNU General Public License ("GPL") version 2 as published by the Free
149 * Software Foundation.
151 *****************************************************************************/
153 #include <contrib/dev/acpica/include/acpi.h>
154 #include <contrib/dev/acpica/include/accommon.h>
156 #define _COMPONENT ACPI_HARDWARE
157 ACPI_MODULE_NAME ("hwsleep")
160 #if (!ACPI_REDUCED_HARDWARE) /* Entire module */
161 /*******************************************************************************
163 * FUNCTION: AcpiHwLegacySleep
165 * PARAMETERS: SleepState - Which sleep state to enter
169 * DESCRIPTION: Enter a system sleep state via the legacy FADT PM registers
170 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED
172 ******************************************************************************/
178 ACPI_BIT_REGISTER_INFO *SleepTypeRegInfo;
179 ACPI_BIT_REGISTER_INFO *SleepEnableRegInfo;
186 ACPI_FUNCTION_TRACE (HwLegacySleep);
189 SleepTypeRegInfo = AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_TYPE);
190 SleepEnableRegInfo = AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_ENABLE);
192 /* Clear wake status */
194 Status = AcpiWriteBitRegister (ACPI_BITREG_WAKE_STATUS,
196 if (ACPI_FAILURE (Status))
198 return_ACPI_STATUS (Status);
201 /* Disable all GPEs */
203 Status = AcpiHwDisableAllGpes ();
204 if (ACPI_FAILURE (Status))
206 return_ACPI_STATUS (Status);
208 Status = AcpiHwClearAcpiStatus();
209 if (ACPI_FAILURE(Status))
211 return_ACPI_STATUS(Status);
213 AcpiGbl_SystemAwakeAndRunning = FALSE;
215 /* Enable all wakeup GPEs */
217 Status = AcpiHwEnableAllWakeupGpes ();
218 if (ACPI_FAILURE (Status))
220 return_ACPI_STATUS (Status);
223 /* Get current value of PM1A control */
225 Status = AcpiHwRegisterRead (ACPI_REGISTER_PM1_CONTROL,
227 if (ACPI_FAILURE (Status))
229 return_ACPI_STATUS (Status);
231 ACPI_DEBUG_PRINT ((ACPI_DB_INIT,
232 "Entering sleep state [S%u]\n", SleepState));
234 /* Clear the SLP_EN and SLP_TYP fields */
236 Pm1aControl &= ~(SleepTypeRegInfo->AccessBitMask |
237 SleepEnableRegInfo->AccessBitMask);
238 Pm1bControl = Pm1aControl;
240 /* Insert the SLP_TYP bits */
242 Pm1aControl |= (AcpiGbl_SleepTypeA << SleepTypeRegInfo->BitPosition);
243 Pm1bControl |= (AcpiGbl_SleepTypeB << SleepTypeRegInfo->BitPosition);
246 * We split the writes of SLP_TYP and SLP_EN to workaround
247 * poorly implemented hardware.
250 /* Write #1: write the SLP_TYP data to the PM1 Control registers */
252 Status = AcpiHwWritePm1Control (Pm1aControl, Pm1bControl);
253 if (ACPI_FAILURE (Status))
255 return_ACPI_STATUS (Status);
258 /* Insert the sleep enable (SLP_EN) bit */
260 Pm1aControl |= SleepEnableRegInfo->AccessBitMask;
261 Pm1bControl |= SleepEnableRegInfo->AccessBitMask;
263 /* Flush caches, as per ACPI specification */
265 ACPI_FLUSH_CPU_CACHE ();
267 Status = AcpiOsEnterSleep (SleepState, Pm1aControl, Pm1bControl);
268 if (Status == AE_CTRL_TERMINATE)
270 return_ACPI_STATUS (AE_OK);
272 if (ACPI_FAILURE (Status))
274 return_ACPI_STATUS (Status);
277 /* Write #2: Write both SLP_TYP + SLP_EN */
279 Status = AcpiHwWritePm1Control (Pm1aControl, Pm1bControl);
280 if (ACPI_FAILURE (Status))
282 return_ACPI_STATUS (Status);
285 if (SleepState > ACPI_STATE_S3)
288 * We wanted to sleep > S3, but it didn't happen (by virtue of the
289 * fact that we are still executing!)
291 * Wait ten seconds, then try again. This is to get S4/S5 to work on
294 * We wait so long to allow chipsets that poll this reg very slowly
295 * to still read the right value. Ideally, this block would go
298 AcpiOsStall (10 * ACPI_USEC_PER_SEC);
300 Status = AcpiHwRegisterWrite (ACPI_REGISTER_PM1_CONTROL,
301 SleepEnableRegInfo->AccessBitMask);
302 if (ACPI_FAILURE (Status))
304 return_ACPI_STATUS (Status);
308 /* Wait for transition back to Working State */
312 Status = AcpiReadBitRegister (ACPI_BITREG_WAKE_STATUS, &InValue);
313 if (ACPI_FAILURE (Status))
315 return_ACPI_STATUS (Status);
320 return_ACPI_STATUS (AE_OK);
324 /*******************************************************************************
326 * FUNCTION: AcpiHwLegacyWakePrep
328 * PARAMETERS: SleepState - Which sleep state we just exited
332 * DESCRIPTION: Perform the first state of OS-independent ACPI cleanup after a
334 * Called with interrupts ENABLED.
336 ******************************************************************************/
339 AcpiHwLegacyWakePrep (
343 ACPI_BIT_REGISTER_INFO *SleepTypeRegInfo;
344 ACPI_BIT_REGISTER_INFO *SleepEnableRegInfo;
349 ACPI_FUNCTION_TRACE (HwLegacyWakePrep);
352 * Set SLP_TYPE and SLP_EN to state S0.
353 * This is unclear from the ACPI Spec, but it is required
356 Status = AcpiGetSleepTypeData (ACPI_STATE_S0,
357 &AcpiGbl_SleepTypeA, &AcpiGbl_SleepTypeB);
358 if (ACPI_SUCCESS (Status))
361 AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_TYPE);
363 AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_ENABLE);
365 /* Get current value of PM1A control */
367 Status = AcpiHwRegisterRead (ACPI_REGISTER_PM1_CONTROL,
369 if (ACPI_SUCCESS (Status))
371 /* Clear the SLP_EN and SLP_TYP fields */
373 Pm1aControl &= ~(SleepTypeRegInfo->AccessBitMask |
374 SleepEnableRegInfo->AccessBitMask);
375 Pm1bControl = Pm1aControl;
377 /* Insert the SLP_TYP bits */
379 Pm1aControl |= (AcpiGbl_SleepTypeA <<
380 SleepTypeRegInfo->BitPosition);
381 Pm1bControl |= (AcpiGbl_SleepTypeB <<
382 SleepTypeRegInfo->BitPosition);
384 /* Write the control registers and ignore any errors */
386 (void) AcpiHwWritePm1Control (Pm1aControl, Pm1bControl);
390 return_ACPI_STATUS (Status);
394 /*******************************************************************************
396 * FUNCTION: AcpiHwLegacyWake
398 * PARAMETERS: SleepState - Which sleep state we just exited
402 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep
403 * Called with interrupts ENABLED.
405 ******************************************************************************/
414 ACPI_FUNCTION_TRACE (HwLegacyWake);
417 /* Ensure EnterSleepStatePrep -> EnterSleepState ordering */
419 AcpiGbl_SleepTypeA = ACPI_SLEEP_TYPE_INVALID;
420 AcpiHwExecuteSleepMethod (METHOD_PATHNAME__SST, ACPI_SST_WAKING);
423 * GPEs must be enabled before _WAK is called as GPEs
424 * might get fired there
427 * 1) Disable all GPEs
428 * 2) Enable all runtime GPEs
430 Status = AcpiHwDisableAllGpes ();
431 if (ACPI_FAILURE (Status))
433 return_ACPI_STATUS (Status);
436 Status = AcpiHwEnableAllRuntimeGpes ();
437 if (ACPI_FAILURE (Status))
439 return_ACPI_STATUS (Status);
443 * Now we can execute _WAK, etc. Some machines require that the GPEs
444 * are enabled before the wake methods are executed.
446 AcpiHwExecuteSleepMethod (METHOD_PATHNAME__WAK, SleepState);
449 * Some BIOS code assumes that WAK_STS will be cleared on resume
450 * and use it to determine whether the system is rebooting or
451 * resuming. Clear WAK_STS for compatibility.
453 (void) AcpiWriteBitRegister (ACPI_BITREG_WAKE_STATUS,
455 AcpiGbl_SystemAwakeAndRunning = TRUE;
457 /* Enable power button */
459 (void) AcpiWriteBitRegister(
460 AcpiGbl_FixedEventInfo[ACPI_EVENT_POWER_BUTTON].EnableRegisterId,
463 (void) AcpiWriteBitRegister(
464 AcpiGbl_FixedEventInfo[ACPI_EVENT_POWER_BUTTON].StatusRegisterId,
467 /* Enable sleep button */
469 (void) AcpiWriteBitRegister (
470 AcpiGbl_FixedEventInfo[ACPI_EVENT_SLEEP_BUTTON].EnableRegisterId,
473 (void) AcpiWriteBitRegister (
474 AcpiGbl_FixedEventInfo[ACPI_EVENT_SLEEP_BUTTON].StatusRegisterId,
477 AcpiHwExecuteSleepMethod (METHOD_PATHNAME__SST, ACPI_SST_WORKING);
478 return_ACPI_STATUS (Status);
481 #endif /* !ACPI_REDUCED_HARDWARE */