1 /****************************************************************************** 2 * 3 * Name: hwsleep.c - ACPI Hardware Sleep/Wake Support functions for the 4 * original/legacy sleep/PM registers. 5 * 6 *****************************************************************************/ 7 8 /****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2018, Intel Corp. 13 * All rights reserved. 14 * 15 * 2. License 16 * 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 20 * property rights. 21 * 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 28 * 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; 37 * 38 * The above copyright and patent license is granted only if the following 39 * conditions are met: 40 * 41 * 3. Conditions 42 * 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. 54 * 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 65 * make. 66 * 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 71 * distribution. 72 * 73 * 3.4. Intel retains all right, title, and interest in and to the Original 74 * Intel Code. 75 * 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. 80 * 81 * 4. Disclaimer and Export Compliance 82 * 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 89 * PARTICULAR PURPOSE. 90 * 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 98 * LIMITED REMEDY. 99 * 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. 114 * 115 ***************************************************************************** 116 * 117 * Alternatively, you may choose to be licensed under the terms of the 118 * following license: 119 * 120 * Redistribution and use in source and binary forms, with or without 121 * modification, are permitted provided that the following conditions 122 * are met: 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. 134 * 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. 146 * 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. 150 * 151 *****************************************************************************/ 152 153 #include "acpi.h" 154 #include "accommon.h" 155 156 #define _COMPONENT ACPI_HARDWARE 157 ACPI_MODULE_NAME ("hwsleep") 158 159 160 #if (!ACPI_REDUCED_HARDWARE) /* Entire module */ 161 /******************************************************************************* 162 * 163 * FUNCTION: AcpiHwLegacySleep 164 * 165 * PARAMETERS: SleepState - Which sleep state to enter 166 * 167 * RETURN: Status 168 * 169 * DESCRIPTION: Enter a system sleep state via the legacy FADT PM registers 170 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED 171 * 172 ******************************************************************************/ 173 174 ACPI_STATUS 175 AcpiHwLegacySleep ( 176 UINT8 SleepState) 177 { 178 ACPI_BIT_REGISTER_INFO *SleepTypeRegInfo; 179 ACPI_BIT_REGISTER_INFO *SleepEnableRegInfo; 180 UINT32 Pm1aControl; 181 UINT32 Pm1bControl; 182 UINT32 InValue; 183 ACPI_STATUS Status; 184 185 186 ACPI_FUNCTION_TRACE (HwLegacySleep); 187 188 189 SleepTypeRegInfo = AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_TYPE); 190 SleepEnableRegInfo = AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_ENABLE); 191 192 /* Clear wake status */ 193 194 Status = AcpiWriteBitRegister (ACPI_BITREG_WAKE_STATUS, 195 ACPI_CLEAR_STATUS); 196 if (ACPI_FAILURE (Status)) 197 { 198 return_ACPI_STATUS (Status); 199 } 200 201 /* 202 * 1) Disable all GPEs 203 * 2) Enable all wakeup GPEs 204 */ 205 Status = AcpiHwDisableAllGpes (); 206 if (ACPI_FAILURE (Status)) 207 { 208 return_ACPI_STATUS (Status); 209 } 210 AcpiGbl_SystemAwakeAndRunning = FALSE; 211 212 Status = AcpiHwEnableAllWakeupGpes (); 213 if (ACPI_FAILURE (Status)) 214 { 215 return_ACPI_STATUS (Status); 216 } 217 218 /* Get current value of PM1A control */ 219 220 Status = AcpiHwRegisterRead (ACPI_REGISTER_PM1_CONTROL, 221 &Pm1aControl); 222 if (ACPI_FAILURE (Status)) 223 { 224 return_ACPI_STATUS (Status); 225 } 226 ACPI_DEBUG_PRINT ((ACPI_DB_INIT, 227 "Entering sleep state [S%u]\n", SleepState)); 228 229 /* Clear the SLP_EN and SLP_TYP fields */ 230 231 Pm1aControl &= ~(SleepTypeRegInfo->AccessBitMask | 232 SleepEnableRegInfo->AccessBitMask); 233 Pm1bControl = Pm1aControl; 234 235 /* Insert the SLP_TYP bits */ 236 237 Pm1aControl |= (AcpiGbl_SleepTypeA << SleepTypeRegInfo->BitPosition); 238 Pm1bControl |= (AcpiGbl_SleepTypeB << SleepTypeRegInfo->BitPosition); 239 240 /* 241 * We split the writes of SLP_TYP and SLP_EN to workaround 242 * poorly implemented hardware. 243 */ 244 245 /* Write #1: write the SLP_TYP data to the PM1 Control registers */ 246 247 Status = AcpiHwWritePm1Control (Pm1aControl, Pm1bControl); 248 if (ACPI_FAILURE (Status)) 249 { 250 return_ACPI_STATUS (Status); 251 } 252 253 /* Insert the sleep enable (SLP_EN) bit */ 254 255 Pm1aControl |= SleepEnableRegInfo->AccessBitMask; 256 Pm1bControl |= SleepEnableRegInfo->AccessBitMask; 257 258 /* Flush caches, as per ACPI specification */ 259 260 ACPI_FLUSH_CPU_CACHE (); 261 262 Status = AcpiOsEnterSleep (SleepState, Pm1aControl, Pm1bControl); 263 if (Status == AE_CTRL_TERMINATE) 264 { 265 return_ACPI_STATUS (AE_OK); 266 } 267 if (ACPI_FAILURE (Status)) 268 { 269 return_ACPI_STATUS (Status); 270 } 271 272 /* Write #2: Write both SLP_TYP + SLP_EN */ 273 274 Status = AcpiHwWritePm1Control (Pm1aControl, Pm1bControl); 275 if (ACPI_FAILURE (Status)) 276 { 277 return_ACPI_STATUS (Status); 278 } 279 280 if (SleepState > ACPI_STATE_S3) 281 { 282 /* 283 * We wanted to sleep > S3, but it didn't happen (by virtue of the 284 * fact that we are still executing!) 285 * 286 * Wait ten seconds, then try again. This is to get S4/S5 to work on 287 * all machines. 288 * 289 * We wait so long to allow chipsets that poll this reg very slowly 290 * to still read the right value. Ideally, this block would go 291 * away entirely. 292 */ 293 AcpiOsStall (10 * ACPI_USEC_PER_SEC); 294 295 Status = AcpiHwRegisterWrite (ACPI_REGISTER_PM1_CONTROL, 296 SleepEnableRegInfo->AccessBitMask); 297 if (ACPI_FAILURE (Status)) 298 { 299 return_ACPI_STATUS (Status); 300 } 301 } 302 303 /* Wait for transition back to Working State */ 304 305 do 306 { 307 Status = AcpiReadBitRegister (ACPI_BITREG_WAKE_STATUS, &InValue); 308 if (ACPI_FAILURE (Status)) 309 { 310 return_ACPI_STATUS (Status); 311 } 312 313 } while (!InValue); 314 315 return_ACPI_STATUS (AE_OK); 316 } 317 318 319 /******************************************************************************* 320 * 321 * FUNCTION: AcpiHwLegacyWakePrep 322 * 323 * PARAMETERS: SleepState - Which sleep state we just exited 324 * 325 * RETURN: Status 326 * 327 * DESCRIPTION: Perform the first state of OS-independent ACPI cleanup after a 328 * sleep. 329 * Called with interrupts ENABLED. 330 * 331 ******************************************************************************/ 332 333 ACPI_STATUS 334 AcpiHwLegacyWakePrep ( 335 UINT8 SleepState) 336 { 337 ACPI_STATUS Status; 338 ACPI_BIT_REGISTER_INFO *SleepTypeRegInfo; 339 ACPI_BIT_REGISTER_INFO *SleepEnableRegInfo; 340 UINT32 Pm1aControl; 341 UINT32 Pm1bControl; 342 343 344 ACPI_FUNCTION_TRACE (HwLegacyWakePrep); 345 346 /* 347 * Set SLP_TYPE and SLP_EN to state S0. 348 * This is unclear from the ACPI Spec, but it is required 349 * by some machines. 350 */ 351 Status = AcpiGetSleepTypeData (ACPI_STATE_S0, 352 &AcpiGbl_SleepTypeA, &AcpiGbl_SleepTypeB); 353 if (ACPI_SUCCESS (Status)) 354 { 355 SleepTypeRegInfo = 356 AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_TYPE); 357 SleepEnableRegInfo = 358 AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_ENABLE); 359 360 /* Get current value of PM1A control */ 361 362 Status = AcpiHwRegisterRead (ACPI_REGISTER_PM1_CONTROL, 363 &Pm1aControl); 364 if (ACPI_SUCCESS (Status)) 365 { 366 /* Clear the SLP_EN and SLP_TYP fields */ 367 368 Pm1aControl &= ~(SleepTypeRegInfo->AccessBitMask | 369 SleepEnableRegInfo->AccessBitMask); 370 Pm1bControl = Pm1aControl; 371 372 /* Insert the SLP_TYP bits */ 373 374 Pm1aControl |= (AcpiGbl_SleepTypeA << 375 SleepTypeRegInfo->BitPosition); 376 Pm1bControl |= (AcpiGbl_SleepTypeB << 377 SleepTypeRegInfo->BitPosition); 378 379 /* Write the control registers and ignore any errors */ 380 381 (void) AcpiHwWritePm1Control (Pm1aControl, Pm1bControl); 382 } 383 } 384 385 return_ACPI_STATUS (Status); 386 } 387 388 389 /******************************************************************************* 390 * 391 * FUNCTION: AcpiHwLegacyWake 392 * 393 * PARAMETERS: SleepState - Which sleep state we just exited 394 * 395 * RETURN: Status 396 * 397 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep 398 * Called with interrupts ENABLED. 399 * 400 ******************************************************************************/ 401 402 ACPI_STATUS 403 AcpiHwLegacyWake ( 404 UINT8 SleepState) 405 { 406 ACPI_STATUS Status; 407 408 409 ACPI_FUNCTION_TRACE (HwLegacyWake); 410 411 412 /* Ensure EnterSleepStatePrep -> EnterSleepState ordering */ 413 414 AcpiGbl_SleepTypeA = ACPI_SLEEP_TYPE_INVALID; 415 AcpiHwExecuteSleepMethod (METHOD_PATHNAME__SST, ACPI_SST_WAKING); 416 417 /* 418 * GPEs must be enabled before _WAK is called as GPEs 419 * might get fired there 420 * 421 * Restore the GPEs: 422 * 1) Disable all GPEs 423 * 2) Enable all runtime GPEs 424 */ 425 Status = AcpiHwDisableAllGpes (); 426 if (ACPI_FAILURE (Status)) 427 { 428 return_ACPI_STATUS (Status); 429 } 430 431 Status = AcpiHwEnableAllRuntimeGpes (); 432 if (ACPI_FAILURE (Status)) 433 { 434 return_ACPI_STATUS (Status); 435 } 436 437 /* 438 * Now we can execute _WAK, etc. Some machines require that the GPEs 439 * are enabled before the wake methods are executed. 440 */ 441 AcpiHwExecuteSleepMethod (METHOD_PATHNAME__WAK, SleepState); 442 443 /* 444 * Some BIOS code assumes that WAK_STS will be cleared on resume 445 * and use it to determine whether the system is rebooting or 446 * resuming. Clear WAK_STS for compatibility. 447 */ 448 (void) AcpiWriteBitRegister (ACPI_BITREG_WAKE_STATUS, 449 ACPI_CLEAR_STATUS); 450 AcpiGbl_SystemAwakeAndRunning = TRUE; 451 452 /* Enable power button */ 453 454 (void) AcpiWriteBitRegister( 455 AcpiGbl_FixedEventInfo[ACPI_EVENT_POWER_BUTTON].EnableRegisterId, 456 ACPI_ENABLE_EVENT); 457 458 (void) AcpiWriteBitRegister( 459 AcpiGbl_FixedEventInfo[ACPI_EVENT_POWER_BUTTON].StatusRegisterId, 460 ACPI_CLEAR_STATUS); 461 462 AcpiHwExecuteSleepMethod (METHOD_PATHNAME__SST, ACPI_SST_WORKING); 463 return_ACPI_STATUS (Status); 464 } 465 466 #endif /* !ACPI_REDUCED_HARDWARE */ 467