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 - 2012, 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 #include "acpi.h" 118 #include "accommon.h" 119 120 #define _COMPONENT ACPI_HARDWARE 121 ACPI_MODULE_NAME ("hwesleep") 122 123 124 /******************************************************************************* 125 * 126 * FUNCTION: AcpiHwExecuteSleepMethod 127 * 128 * PARAMETERS: MethodPathname - Pathname of method to execute 129 * IntegerArgument - Argument to pass to the method 130 * 131 * RETURN: None 132 * 133 * DESCRIPTION: Execute a sleep/wake related method with one integer argument 134 * and no return value. 135 * 136 ******************************************************************************/ 137 138 void 139 AcpiHwExecuteSleepMethod ( 140 char *MethodPathname, 141 UINT32 IntegerArgument) 142 { 143 ACPI_OBJECT_LIST ArgList; 144 ACPI_OBJECT Arg; 145 ACPI_STATUS Status; 146 147 148 ACPI_FUNCTION_TRACE (HwExecuteSleepMethod); 149 150 151 /* One argument, IntegerArgument; No return value expected */ 152 153 ArgList.Count = 1; 154 ArgList.Pointer = &Arg; 155 Arg.Type = ACPI_TYPE_INTEGER; 156 Arg.Integer.Value = (UINT64) IntegerArgument; 157 158 Status = AcpiEvaluateObject (NULL, MethodPathname, &ArgList, NULL); 159 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND) 160 { 161 ACPI_EXCEPTION ((AE_INFO, Status, "While executing method %s", 162 MethodPathname)); 163 } 164 165 return_VOID; 166 } 167 168 169 /******************************************************************************* 170 * 171 * FUNCTION: AcpiHwExtendedSleep 172 * 173 * PARAMETERS: SleepState - Which sleep state to enter 174 * Flags - ACPI_EXECUTE_GTS to run optional method 175 * 176 * RETURN: Status 177 * 178 * DESCRIPTION: Enter a system sleep state via the extended FADT sleep 179 * registers (V5 FADT). 180 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED 181 * 182 ******************************************************************************/ 183 184 ACPI_STATUS 185 AcpiHwExtendedSleep ( 186 UINT8 SleepState, 187 UINT8 Flags) 188 { 189 ACPI_STATUS Status; 190 UINT8 SleepTypeValue; 191 UINT64 SleepStatus; 192 193 194 ACPI_FUNCTION_TRACE (HwExtendedSleep); 195 196 197 /* Extended sleep registers must be valid */ 198 199 if (!AcpiGbl_FADT.SleepControl.Address || 200 !AcpiGbl_FADT.SleepStatus.Address) 201 { 202 return_ACPI_STATUS (AE_NOT_EXIST); 203 } 204 205 /* Clear wake status (WAK_STS) */ 206 207 Status = AcpiWrite ((UINT64) ACPI_X_WAKE_STATUS, &AcpiGbl_FADT.SleepStatus); 208 if (ACPI_FAILURE (Status)) 209 { 210 return_ACPI_STATUS (Status); 211 } 212 213 AcpiGbl_SystemAwakeAndRunning = FALSE; 214 215 /* Optionally execute _GTS (Going To Sleep) */ 216 217 if (Flags & ACPI_EXECUTE_GTS) 218 { 219 AcpiHwExecuteSleepMethod (METHOD_PATHNAME__GTS, SleepState); 220 } 221 222 /* Flush caches, as per ACPI specification */ 223 224 ACPI_FLUSH_CPU_CACHE (); 225 226 /* 227 * Set the SLP_TYP and SLP_EN bits. 228 * 229 * Note: We only use the first value returned by the \_Sx method 230 * (AcpiGbl_SleepTypeA) - As per ACPI specification. 231 */ 232 ACPI_DEBUG_PRINT ((ACPI_DB_INIT, 233 "Entering sleep state [S%u]\n", SleepState)); 234 235 SleepTypeValue = ((AcpiGbl_SleepTypeA << ACPI_X_SLEEP_TYPE_POSITION) & 236 ACPI_X_SLEEP_TYPE_MASK); 237 238 Status = AcpiWrite ((UINT64) (SleepTypeValue | ACPI_X_SLEEP_ENABLE), 239 &AcpiGbl_FADT.SleepControl); 240 if (ACPI_FAILURE (Status)) 241 { 242 return_ACPI_STATUS (Status); 243 } 244 245 /* Wait for transition back to Working State */ 246 247 do 248 { 249 Status = AcpiRead (&SleepStatus, &AcpiGbl_FADT.SleepStatus); 250 if (ACPI_FAILURE (Status)) 251 { 252 return_ACPI_STATUS (Status); 253 } 254 255 } while (!(((UINT8) SleepStatus) & ACPI_X_WAKE_STATUS)); 256 257 return_ACPI_STATUS (AE_OK); 258 } 259 260 261 /******************************************************************************* 262 * 263 * FUNCTION: AcpiHwExtendedWakePrep 264 * 265 * PARAMETERS: SleepState - Which sleep state we just exited 266 * Flags - ACPI_EXECUTE_BFS to run optional method 267 * 268 * RETURN: Status 269 * 270 * DESCRIPTION: Perform first part of OS-independent ACPI cleanup after 271 * a sleep. Called with interrupts ENABLED. 272 * 273 ******************************************************************************/ 274 275 ACPI_STATUS 276 AcpiHwExtendedWakePrep ( 277 UINT8 SleepState, 278 UINT8 Flags) 279 { 280 ACPI_STATUS Status; 281 UINT8 SleepTypeValue; 282 283 284 ACPI_FUNCTION_TRACE (HwExtendedWakePrep); 285 286 287 Status = AcpiGetSleepTypeData (ACPI_STATE_S0, 288 &AcpiGbl_SleepTypeA, &AcpiGbl_SleepTypeB); 289 if (ACPI_SUCCESS (Status)) 290 { 291 SleepTypeValue = ((AcpiGbl_SleepTypeA << ACPI_X_SLEEP_TYPE_POSITION) & 292 ACPI_X_SLEEP_TYPE_MASK); 293 294 (void) AcpiWrite ((UINT64) (SleepTypeValue | ACPI_X_SLEEP_ENABLE), 295 &AcpiGbl_FADT.SleepControl); 296 } 297 298 /* Optionally execute _BFS (Back From Sleep) */ 299 300 if (Flags & ACPI_EXECUTE_BFS) 301 { 302 AcpiHwExecuteSleepMethod (METHOD_PATHNAME__BFS, SleepState); 303 } 304 return_ACPI_STATUS (AE_OK); 305 } 306 307 308 /******************************************************************************* 309 * 310 * FUNCTION: AcpiHwExtendedWake 311 * 312 * PARAMETERS: SleepState - Which sleep state we just exited 313 * Flags - Reserved, set to zero 314 * 315 * RETURN: Status 316 * 317 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep 318 * Called with interrupts ENABLED. 319 * 320 ******************************************************************************/ 321 322 ACPI_STATUS 323 AcpiHwExtendedWake ( 324 UINT8 SleepState, 325 UINT8 Flags) 326 { 327 ACPI_FUNCTION_TRACE (HwExtendedWake); 328 329 330 /* Ensure EnterSleepStatePrep -> EnterSleepState ordering */ 331 332 AcpiGbl_SleepTypeA = ACPI_SLEEP_TYPE_INVALID; 333 334 /* Execute the wake methods */ 335 336 AcpiHwExecuteSleepMethod (METHOD_PATHNAME__SST, ACPI_SST_WAKING); 337 AcpiHwExecuteSleepMethod (METHOD_PATHNAME__WAK, SleepState); 338 339 /* 340 * Some BIOS code assumes that WAK_STS will be cleared on resume 341 * and use it to determine whether the system is rebooting or 342 * resuming. Clear WAK_STS for compatibility. 343 */ 344 (void) AcpiWrite ((UINT64) ACPI_X_WAKE_STATUS, &AcpiGbl_FADT.SleepStatus); 345 AcpiGbl_SystemAwakeAndRunning = TRUE; 346 347 AcpiHwExecuteSleepMethod (METHOD_PATHNAME__SST, ACPI_SST_WORKING); 348 return_ACPI_STATUS (AE_OK); 349 } 350