1 /****************************************************************************** 2 * 3 * Name: hwesleep.c - ACPI Hardware Sleep/Wake Support functions for the 4 * extended FADT-V5 sleep registers. 5 * 6 *****************************************************************************/ 7 8 /****************************************************************************** 9 * 10 * 1. Copyright Notice 11 * 12 * Some or all of this work - Copyright (c) 1999 - 2021, 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 ("hwesleep") 158 159 160 /******************************************************************************* 161 * 162 * FUNCTION: AcpiHwExecuteSleepMethod 163 * 164 * PARAMETERS: MethodPathname - Pathname of method to execute 165 * IntegerArgument - Argument to pass to the method 166 * 167 * RETURN: None 168 * 169 * DESCRIPTION: Execute a sleep/wake related method with one integer argument 170 * and no return value. 171 * 172 ******************************************************************************/ 173 174 void 175 AcpiHwExecuteSleepMethod ( 176 char *MethodPathname, 177 UINT32 IntegerArgument) 178 { 179 ACPI_OBJECT_LIST ArgList; 180 ACPI_OBJECT Arg; 181 ACPI_STATUS Status; 182 183 184 ACPI_FUNCTION_TRACE (HwExecuteSleepMethod); 185 186 187 /* One argument, IntegerArgument; No return value expected */ 188 189 ArgList.Count = 1; 190 ArgList.Pointer = &Arg; 191 Arg.Type = ACPI_TYPE_INTEGER; 192 Arg.Integer.Value = (UINT64) IntegerArgument; 193 194 Status = AcpiEvaluateObject (NULL, MethodPathname, &ArgList, NULL); 195 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND) 196 { 197 ACPI_EXCEPTION ((AE_INFO, Status, "While executing method %s", 198 MethodPathname)); 199 } 200 201 return_VOID; 202 } 203 204 205 /******************************************************************************* 206 * 207 * FUNCTION: AcpiHwExtendedSleep 208 * 209 * PARAMETERS: SleepState - Which sleep state to enter 210 * 211 * RETURN: Status 212 * 213 * DESCRIPTION: Enter a system sleep state via the extended FADT sleep 214 * registers (V5 FADT). 215 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED 216 * 217 ******************************************************************************/ 218 219 ACPI_STATUS 220 AcpiHwExtendedSleep ( 221 UINT8 SleepState) 222 { 223 ACPI_STATUS Status; 224 UINT8 SleepControl; 225 UINT64 SleepStatus; 226 227 228 ACPI_FUNCTION_TRACE (HwExtendedSleep); 229 230 231 /* Extended sleep registers must be valid */ 232 233 if (!AcpiGbl_FADT.SleepControl.Address || 234 !AcpiGbl_FADT.SleepStatus.Address) 235 { 236 return_ACPI_STATUS (AE_NOT_EXIST); 237 } 238 239 /* Clear wake status (WAK_STS) */ 240 241 Status = AcpiWrite ((UINT64) ACPI_X_WAKE_STATUS, 242 &AcpiGbl_FADT.SleepStatus); 243 if (ACPI_FAILURE (Status)) 244 { 245 return_ACPI_STATUS (Status); 246 } 247 248 AcpiGbl_SystemAwakeAndRunning = FALSE; 249 250 /* 251 * Set the SLP_TYP and SLP_EN bits. 252 * 253 * Note: We only use the first value returned by the \_Sx method 254 * (AcpiGbl_SleepTypeA) - As per ACPI specification. 255 */ 256 ACPI_DEBUG_PRINT ((ACPI_DB_INIT, 257 "Entering sleep state [S%u]\n", SleepState)); 258 259 SleepControl = ((AcpiGbl_SleepTypeA << ACPI_X_SLEEP_TYPE_POSITION) & 260 ACPI_X_SLEEP_TYPE_MASK) | ACPI_X_SLEEP_ENABLE; 261 262 /* Flush caches, as per ACPI specification */ 263 264 ACPI_FLUSH_CPU_CACHE (); 265 266 Status = AcpiOsEnterSleep (SleepState, SleepControl, 0); 267 if (Status == AE_CTRL_TERMINATE) 268 { 269 return_ACPI_STATUS (AE_OK); 270 } 271 if (ACPI_FAILURE (Status)) 272 { 273 return_ACPI_STATUS (Status); 274 } 275 276 Status = AcpiWrite ((UINT64) SleepControl, &AcpiGbl_FADT.SleepControl); 277 if (ACPI_FAILURE (Status)) 278 { 279 return_ACPI_STATUS (Status); 280 } 281 282 /* Wait for transition back to Working State */ 283 284 do 285 { 286 Status = AcpiRead (&SleepStatus, &AcpiGbl_FADT.SleepStatus); 287 if (ACPI_FAILURE (Status)) 288 { 289 return_ACPI_STATUS (Status); 290 } 291 292 } while (!(((UINT8) SleepStatus) & ACPI_X_WAKE_STATUS)); 293 294 return_ACPI_STATUS (AE_OK); 295 } 296 297 298 /******************************************************************************* 299 * 300 * FUNCTION: AcpiHwExtendedWakePrep 301 * 302 * PARAMETERS: SleepState - Which sleep state we just exited 303 * 304 * RETURN: Status 305 * 306 * DESCRIPTION: Perform first part of OS-independent ACPI cleanup after 307 * a sleep. Called with interrupts ENABLED. 308 * 309 ******************************************************************************/ 310 311 ACPI_STATUS 312 AcpiHwExtendedWakePrep ( 313 UINT8 SleepState) 314 { 315 ACPI_STATUS Status; 316 UINT8 SleepTypeValue; 317 318 319 ACPI_FUNCTION_TRACE (HwExtendedWakePrep); 320 321 322 Status = AcpiGetSleepTypeData (ACPI_STATE_S0, 323 &AcpiGbl_SleepTypeA, &AcpiGbl_SleepTypeB); 324 if (ACPI_SUCCESS (Status)) 325 { 326 SleepTypeValue = ((AcpiGbl_SleepTypeA << ACPI_X_SLEEP_TYPE_POSITION) & 327 ACPI_X_SLEEP_TYPE_MASK); 328 329 (void) AcpiWrite ((UINT64) (SleepTypeValue | ACPI_X_SLEEP_ENABLE), 330 &AcpiGbl_FADT.SleepControl); 331 } 332 333 return_ACPI_STATUS (AE_OK); 334 } 335 336 337 /******************************************************************************* 338 * 339 * FUNCTION: AcpiHwExtendedWake 340 * 341 * PARAMETERS: SleepState - Which sleep state we just exited 342 * 343 * RETURN: Status 344 * 345 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep 346 * Called with interrupts ENABLED. 347 * 348 ******************************************************************************/ 349 350 ACPI_STATUS 351 AcpiHwExtendedWake ( 352 UINT8 SleepState) 353 { 354 ACPI_FUNCTION_TRACE (HwExtendedWake); 355 356 357 /* Ensure EnterSleepStatePrep -> EnterSleepState ordering */ 358 359 AcpiGbl_SleepTypeA = ACPI_SLEEP_TYPE_INVALID; 360 361 /* Execute the wake methods */ 362 363 AcpiHwExecuteSleepMethod (METHOD_PATHNAME__SST, ACPI_SST_WAKING); 364 AcpiHwExecuteSleepMethod (METHOD_PATHNAME__WAK, SleepState); 365 366 /* 367 * Some BIOS code assumes that WAK_STS will be cleared on resume 368 * and use it to determine whether the system is rebooting or 369 * resuming. Clear WAK_STS for compatibility. 370 */ 371 (void) AcpiWrite ((UINT64) ACPI_X_WAKE_STATUS, &AcpiGbl_FADT.SleepStatus); 372 AcpiGbl_SystemAwakeAndRunning = TRUE; 373 374 AcpiHwExecuteSleepMethod (METHOD_PATHNAME__SST, ACPI_SST_WORKING); 375 return_ACPI_STATUS (AE_OK); 376 } 377