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 - 2022, 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 <contrib/dev/acpica/include/acpi.h> 154 #include <contrib/dev/acpica/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 /* Disable all GPEs */ 202 203 Status = AcpiHwDisableAllGpes (); 204 if (ACPI_FAILURE (Status)) 205 { 206 return_ACPI_STATUS (Status); 207 } 208 Status = AcpiHwClearAcpiStatus(); 209 if (ACPI_FAILURE(Status)) 210 { 211 return_ACPI_STATUS(Status); 212 } 213 AcpiGbl_SystemAwakeAndRunning = FALSE; 214 215 /* Enable all wakeup GPEs */ 216 217 Status = AcpiHwEnableAllWakeupGpes (); 218 if (ACPI_FAILURE (Status)) 219 { 220 return_ACPI_STATUS (Status); 221 } 222 223 /* Get current value of PM1A control */ 224 225 Status = AcpiHwRegisterRead (ACPI_REGISTER_PM1_CONTROL, 226 &Pm1aControl); 227 if (ACPI_FAILURE (Status)) 228 { 229 return_ACPI_STATUS (Status); 230 } 231 ACPI_DEBUG_PRINT ((ACPI_DB_INIT, 232 "Entering sleep state [S%u]\n", SleepState)); 233 234 /* Clear the SLP_EN and SLP_TYP fields */ 235 236 Pm1aControl &= ~(SleepTypeRegInfo->AccessBitMask | 237 SleepEnableRegInfo->AccessBitMask); 238 Pm1bControl = Pm1aControl; 239 240 /* Insert the SLP_TYP bits */ 241 242 Pm1aControl |= (AcpiGbl_SleepTypeA << SleepTypeRegInfo->BitPosition); 243 Pm1bControl |= (AcpiGbl_SleepTypeB << SleepTypeRegInfo->BitPosition); 244 245 /* 246 * We split the writes of SLP_TYP and SLP_EN to workaround 247 * poorly implemented hardware. 248 */ 249 250 /* Write #1: write the SLP_TYP data to the PM1 Control registers */ 251 252 Status = AcpiHwWritePm1Control (Pm1aControl, Pm1bControl); 253 if (ACPI_FAILURE (Status)) 254 { 255 return_ACPI_STATUS (Status); 256 } 257 258 /* Insert the sleep enable (SLP_EN) bit */ 259 260 Pm1aControl |= SleepEnableRegInfo->AccessBitMask; 261 Pm1bControl |= SleepEnableRegInfo->AccessBitMask; 262 263 /* Flush caches, as per ACPI specification */ 264 265 if (SleepState < ACPI_STATE_S4) 266 { 267 ACPI_FLUSH_CPU_CACHE (); 268 } 269 270 Status = AcpiOsEnterSleep (SleepState, Pm1aControl, Pm1bControl); 271 if (Status == AE_CTRL_TERMINATE) 272 { 273 return_ACPI_STATUS (AE_OK); 274 } 275 if (ACPI_FAILURE (Status)) 276 { 277 return_ACPI_STATUS (Status); 278 } 279 280 /* Write #2: Write both SLP_TYP + SLP_EN */ 281 282 Status = AcpiHwWritePm1Control (Pm1aControl, Pm1bControl); 283 if (ACPI_FAILURE (Status)) 284 { 285 return_ACPI_STATUS (Status); 286 } 287 288 if (SleepState > ACPI_STATE_S3) 289 { 290 /* 291 * We wanted to sleep > S3, but it didn't happen (by virtue of the 292 * fact that we are still executing!) 293 * 294 * Wait ten seconds, then try again. This is to get S4/S5 to work on 295 * all machines. 296 * 297 * We wait so long to allow chipsets that poll this reg very slowly 298 * to still read the right value. Ideally, this block would go 299 * away entirely. 300 */ 301 AcpiOsStall (10 * ACPI_USEC_PER_SEC); 302 303 Status = AcpiHwRegisterWrite (ACPI_REGISTER_PM1_CONTROL, 304 SleepEnableRegInfo->AccessBitMask); 305 if (ACPI_FAILURE (Status)) 306 { 307 return_ACPI_STATUS (Status); 308 } 309 } 310 311 /* Wait for transition back to Working State */ 312 313 do 314 { 315 Status = AcpiReadBitRegister (ACPI_BITREG_WAKE_STATUS, &InValue); 316 if (ACPI_FAILURE (Status)) 317 { 318 return_ACPI_STATUS (Status); 319 } 320 321 } while (!InValue); 322 323 return_ACPI_STATUS (AE_OK); 324 } 325 326 327 /******************************************************************************* 328 * 329 * FUNCTION: AcpiHwLegacyWakePrep 330 * 331 * PARAMETERS: SleepState - Which sleep state we just exited 332 * 333 * RETURN: Status 334 * 335 * DESCRIPTION: Perform the first state of OS-independent ACPI cleanup after a 336 * sleep. 337 * Called with interrupts ENABLED. 338 * 339 ******************************************************************************/ 340 341 ACPI_STATUS 342 AcpiHwLegacyWakePrep ( 343 UINT8 SleepState) 344 { 345 ACPI_STATUS Status = AE_OK; 346 ACPI_BIT_REGISTER_INFO *SleepTypeRegInfo; 347 ACPI_BIT_REGISTER_INFO *SleepEnableRegInfo; 348 UINT32 Pm1aControl; 349 UINT32 Pm1bControl; 350 351 352 ACPI_FUNCTION_TRACE (HwLegacyWakePrep); 353 354 /* 355 * Set SLP_TYPE and SLP_EN to state S0. 356 * This is unclear from the ACPI Spec, but it is required 357 * by some machines. 358 */ 359 if (AcpiGbl_SleepTypeAS0 != ACPI_SLEEP_TYPE_INVALID) 360 { 361 SleepTypeRegInfo = 362 AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_TYPE); 363 SleepEnableRegInfo = 364 AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_ENABLE); 365 366 /* Get current value of PM1A control */ 367 368 Status = AcpiHwRegisterRead (ACPI_REGISTER_PM1_CONTROL, 369 &Pm1aControl); 370 if (ACPI_SUCCESS (Status)) 371 { 372 /* Clear the SLP_EN and SLP_TYP fields */ 373 374 Pm1aControl &= ~(SleepTypeRegInfo->AccessBitMask | 375 SleepEnableRegInfo->AccessBitMask); 376 Pm1bControl = Pm1aControl; 377 378 /* Insert the SLP_TYP bits */ 379 380 Pm1aControl |= (AcpiGbl_SleepTypeAS0 << 381 SleepTypeRegInfo->BitPosition); 382 Pm1bControl |= (AcpiGbl_SleepTypeBS0 << 383 SleepTypeRegInfo->BitPosition); 384 385 /* Write the control registers and ignore any errors */ 386 387 (void) AcpiHwWritePm1Control (Pm1aControl, Pm1bControl); 388 } 389 } 390 391 return_ACPI_STATUS (Status); 392 } 393 394 395 /******************************************************************************* 396 * 397 * FUNCTION: AcpiHwLegacyWake 398 * 399 * PARAMETERS: SleepState - Which sleep state we just exited 400 * 401 * RETURN: Status 402 * 403 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep 404 * Called with interrupts ENABLED. 405 * 406 ******************************************************************************/ 407 408 ACPI_STATUS 409 AcpiHwLegacyWake ( 410 UINT8 SleepState) 411 { 412 ACPI_STATUS Status; 413 414 415 ACPI_FUNCTION_TRACE (HwLegacyWake); 416 417 418 /* Ensure EnterSleepStatePrep -> EnterSleepState ordering */ 419 420 AcpiGbl_SleepTypeA = ACPI_SLEEP_TYPE_INVALID; 421 AcpiHwExecuteSleepMethod (METHOD_PATHNAME__SST, ACPI_SST_WAKING); 422 423 /* 424 * GPEs must be enabled before _WAK is called as GPEs 425 * might get fired there 426 * 427 * Restore the GPEs: 428 * 1) Disable all GPEs 429 * 2) Enable all runtime GPEs 430 */ 431 Status = AcpiHwDisableAllGpes (); 432 if (ACPI_FAILURE (Status)) 433 { 434 return_ACPI_STATUS (Status); 435 } 436 437 Status = AcpiHwEnableAllRuntimeGpes (); 438 if (ACPI_FAILURE (Status)) 439 { 440 return_ACPI_STATUS (Status); 441 } 442 443 /* 444 * Now we can execute _WAK, etc. Some machines require that the GPEs 445 * are enabled before the wake methods are executed. 446 */ 447 AcpiHwExecuteSleepMethod (METHOD_PATHNAME__WAK, SleepState); 448 449 /* 450 * Some BIOS code assumes that WAK_STS will be cleared on resume 451 * and use it to determine whether the system is rebooting or 452 * resuming. Clear WAK_STS for compatibility. 453 */ 454 (void) AcpiWriteBitRegister (ACPI_BITREG_WAKE_STATUS, 455 ACPI_CLEAR_STATUS); 456 AcpiGbl_SystemAwakeAndRunning = TRUE; 457 458 /* Enable power button */ 459 460 (void) AcpiWriteBitRegister( 461 AcpiGbl_FixedEventInfo[ACPI_EVENT_POWER_BUTTON].EnableRegisterId, 462 ACPI_ENABLE_EVENT); 463 464 (void) AcpiWriteBitRegister( 465 AcpiGbl_FixedEventInfo[ACPI_EVENT_POWER_BUTTON].StatusRegisterId, 466 ACPI_CLEAR_STATUS); 467 468 /* Enable sleep button */ 469 470 (void) AcpiWriteBitRegister ( 471 AcpiGbl_FixedEventInfo[ACPI_EVENT_SLEEP_BUTTON].EnableRegisterId, 472 ACPI_ENABLE_EVENT); 473 474 (void) AcpiWriteBitRegister ( 475 AcpiGbl_FixedEventInfo[ACPI_EVENT_SLEEP_BUTTON].StatusRegisterId, 476 ACPI_CLEAR_STATUS); 477 478 AcpiHwExecuteSleepMethod (METHOD_PATHNAME__SST, ACPI_SST_WORKING); 479 return_ACPI_STATUS (Status); 480 } 481 482 #endif /* !ACPI_REDUCED_HARDWARE */ 483