hwsleep.c revision 99146
1 2/****************************************************************************** 3 * 4 * Name: hwsleep.c - ACPI Hardware Sleep/Wake Interface 5 * $Revision: 37 $ 6 * 7 *****************************************************************************/ 8 9/****************************************************************************** 10 * 11 * 1. Copyright Notice 12 * 13 * Some or all of this work - Copyright (c) 1999 - 2002, Intel Corp. 14 * All rights reserved. 15 * 16 * 2. License 17 * 18 * 2.1. This is your license from Intel Corp. under its intellectual property 19 * rights. You may have additional license terms from the party that provided 20 * you this software, covering your right to use that party's intellectual 21 * property rights. 22 * 23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 24 * copy of the source code appearing in this file ("Covered Code") an 25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 26 * base code distributed originally by Intel ("Original Intel Code") to copy, 27 * make derivatives, distribute, use and display any portion of the Covered 28 * Code in any form, with the right to sublicense such rights; and 29 * 30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 31 * license (with the right to sublicense), under only those claims of Intel 32 * patents that are infringed by the Original Intel Code, to make, use, sell, 33 * offer to sell, and import the Covered Code and derivative works thereof 34 * solely to the minimum extent necessary to exercise the above copyright 35 * license, and in no event shall the patent license extend to any additions 36 * to or modifications of the Original Intel Code. No other license or right 37 * is granted directly or by implication, estoppel or otherwise; 38 * 39 * The above copyright and patent license is granted only if the following 40 * conditions are met: 41 * 42 * 3. Conditions 43 * 44 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 45 * Redistribution of source code of any substantial portion of the Covered 46 * Code or modification with rights to further distribute source must include 47 * the above Copyright Notice, the above License, this list of Conditions, 48 * and the following Disclaimer and Export Compliance provision. In addition, 49 * Licensee must cause all Covered Code to which Licensee contributes to 50 * contain a file documenting the changes Licensee made to create that Covered 51 * Code and the date of any change. Licensee must include in that file the 52 * documentation of any changes made by any predecessor Licensee. Licensee 53 * must include a prominent statement that the modification is derived, 54 * directly or indirectly, from Original Intel Code. 55 * 56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 57 * Redistribution of source code of any substantial portion of the Covered 58 * Code or modification without rights to further distribute source must 59 * include the following Disclaimer and Export Compliance provision in the 60 * documentation and/or other materials provided with distribution. In 61 * addition, Licensee may not authorize further sublicense of source of any 62 * portion of the Covered Code, and must include terms to the effect that the 63 * license from Licensee to its licensee is limited to the intellectual 64 * property embodied in the software Licensee provides to its licensee, and 65 * not to intellectual property embodied in modifications its licensee may 66 * make. 67 * 68 * 3.3. Redistribution of Executable. Redistribution in executable form of any 69 * substantial portion of the Covered Code or modification must reproduce the 70 * above Copyright Notice, and the following Disclaimer and Export Compliance 71 * provision in the documentation and/or other materials provided with the 72 * distribution. 73 * 74 * 3.4. Intel retains all right, title, and interest in and to the Original 75 * Intel Code. 76 * 77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 78 * Intel shall be used in advertising or otherwise to promote the sale, use or 79 * other dealings in products derived from or relating to the Covered Code 80 * without prior written authorization from Intel. 81 * 82 * 4. Disclaimer and Export Compliance 83 * 84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 90 * PARTICULAR PURPOSE. 91 * 92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 99 * LIMITED REMEDY. 100 * 101 * 4.3. Licensee shall not export, either directly or indirectly, any of this 102 * software or system incorporating such software without first obtaining any 103 * required license or other approval from the U. S. Department of Commerce or 104 * any other agency or department of the United States Government. In the 105 * event Licensee exports any such software from the United States or 106 * re-exports any such software from a foreign destination, Licensee shall 107 * ensure that the distribution and export/re-export of the software is in 108 * compliance with all laws, regulations, orders, or other restrictions of the 109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 110 * any of its subsidiaries will export/re-export any technical data, process, 111 * software, or service, directly or indirectly, to any country for which the 112 * United States government or any agency thereof requires an export license, 113 * other governmental approval, or letter of assurance, without first obtaining 114 * such license, approval or letter. 115 * 116 *****************************************************************************/ 117 118#include "acpi.h" 119#include "acnamesp.h" 120#include "achware.h" 121 122#define _COMPONENT ACPI_HARDWARE 123 ACPI_MODULE_NAME ("hwsleep") 124 125 126/****************************************************************************** 127 * 128 * FUNCTION: AcpiSetFirmwareWakingVector 129 * 130 * PARAMETERS: PhysicalAddress - Physical address of ACPI real mode 131 * entry point. 132 * 133 * RETURN: Status 134 * 135 * DESCRIPTION: Access function for dFirmwareWakingVector field in FACS 136 * 137 ******************************************************************************/ 138 139ACPI_STATUS 140AcpiSetFirmwareWakingVector ( 141 ACPI_PHYSICAL_ADDRESS PhysicalAddress) 142{ 143 144 ACPI_FUNCTION_TRACE ("AcpiSetFirmwareWakingVector"); 145 146 147 /* Set the vector */ 148 149 if (AcpiGbl_CommonFACS.VectorWidth == 32) 150 { 151 *(UINT32 *) AcpiGbl_CommonFACS.FirmwareWakingVector = (UINT32) PhysicalAddress; 152 } 153 else 154 { 155 *AcpiGbl_CommonFACS.FirmwareWakingVector = PhysicalAddress; 156 } 157 158 return_ACPI_STATUS (AE_OK); 159} 160 161 162/****************************************************************************** 163 * 164 * FUNCTION: AcpiGetFirmwareWakingVector 165 * 166 * PARAMETERS: *PhysicalAddress - Output buffer where contents of 167 * the FirmwareWakingVector field of 168 * the FACS will be stored. 169 * 170 * RETURN: Status 171 * 172 * DESCRIPTION: Access function for FirmwareWakingVector field in FACS 173 * 174 ******************************************************************************/ 175 176ACPI_STATUS 177AcpiGetFirmwareWakingVector ( 178 ACPI_PHYSICAL_ADDRESS *PhysicalAddress) 179{ 180 181 ACPI_FUNCTION_TRACE ("AcpiGetFirmwareWakingVector"); 182 183 184 if (!PhysicalAddress) 185 { 186 return_ACPI_STATUS (AE_BAD_PARAMETER); 187 } 188 189 /* Get the vector */ 190 191 if (AcpiGbl_CommonFACS.VectorWidth == 32) 192 { 193 *PhysicalAddress = *(UINT32 *) AcpiGbl_CommonFACS.FirmwareWakingVector; 194 } 195 else 196 { 197 *PhysicalAddress = *AcpiGbl_CommonFACS.FirmwareWakingVector; 198 } 199 200 return_ACPI_STATUS (AE_OK); 201} 202 203 204/****************************************************************************** 205 * 206 * FUNCTION: AcpiEnterSleepStatePrep 207 * 208 * PARAMETERS: SleepState - Which sleep state to enter 209 * 210 * RETURN: Status 211 * 212 * DESCRIPTION: Prepare to enter a system sleep state (see ACPI 2.0 spec p 231) 213 * This function must execute with interrupts enabled. 214 * We break sleeping into 2 stages so that OSPM can handle 215 * various OS-specific tasks between the two steps. 216 * 217 ******************************************************************************/ 218 219ACPI_STATUS 220AcpiEnterSleepStatePrep ( 221 UINT8 SleepState) 222{ 223 ACPI_STATUS Status; 224 ACPI_OBJECT_LIST ArgList; 225 ACPI_OBJECT Arg; 226 227 228 ACPI_FUNCTION_TRACE ("AcpiEnterSleepStatePrep"); 229 230 231 /* 232 * _PSW methods could be run here to enable wake-on keyboard, LAN, etc. 233 */ 234 Status = AcpiHwGetSleepTypeData (SleepState, 235 &AcpiGbl_SleepTypeA, &AcpiGbl_SleepTypeB); 236 if (ACPI_FAILURE (Status)) 237 { 238 return_ACPI_STATUS (Status); 239 } 240 241 /* Setup parameter object */ 242 243 ArgList.Count = 1; 244 ArgList.Pointer = &Arg; 245 246 Arg.Type = ACPI_TYPE_INTEGER; 247 Arg.Integer.Value = SleepState; 248 249 /* Run the _PTS and _GTS methods */ 250 251 Status = AcpiEvaluateObject (NULL, "\\_PTS", &ArgList, NULL); 252 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND) 253 { 254 return_ACPI_STATUS (Status); 255 } 256 257 Status = AcpiEvaluateObject (NULL, "\\_GTS", &ArgList, NULL); 258 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND) 259 { 260 return_ACPI_STATUS (Status); 261 } 262 263 return_ACPI_STATUS (AE_OK); 264} 265 266 267/****************************************************************************** 268 * 269 * FUNCTION: AcpiEnterSleepState 270 * 271 * PARAMETERS: SleepState - Which sleep state to enter 272 * 273 * RETURN: Status 274 * 275 * DESCRIPTION: Enter a system sleep state (see ACPI 2.0 spec p 231) 276 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED 277 * 278 ******************************************************************************/ 279 280ACPI_STATUS 281AcpiEnterSleepState ( 282 UINT8 SleepState) 283{ 284 UINT16 PM1AControl; 285 UINT16 PM1BControl; 286 ACPI_BIT_REGISTER_INFO *SleepTypeRegInfo; 287 ACPI_BIT_REGISTER_INFO *SleepEnableRegInfo; 288 289 290 ACPI_FUNCTION_TRACE ("AcpiEnterSleepState"); 291 292 293 if ((AcpiGbl_SleepTypeA > ACPI_SLEEP_TYPE_MAX) || 294 (AcpiGbl_SleepTypeB > ACPI_SLEEP_TYPE_MAX)) 295 { 296 ACPI_REPORT_ERROR (("Sleep values out of range: A=%x B=%x\n", 297 AcpiGbl_SleepTypeA, AcpiGbl_SleepTypeB)); 298 return_ACPI_STATUS (AE_AML_OPERAND_VALUE); 299 } 300 301 302 SleepTypeRegInfo = AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_TYPE_A); 303 SleepEnableRegInfo = AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_ENABLE); 304 305 /* Clear wake status */ 306 307 AcpiHwBitRegisterWrite (ACPI_BITREG_WAKE_STATUS, 1, ACPI_MTX_LOCK); 308 AcpiHwClearAcpiStatus(); 309 310 /* TBD: Disable arbitration here? */ 311 312 AcpiHwDisableNonWakeupGpes(); 313 314 /* Get current value of PM1A control */ 315 316 PM1AControl = (UINT16) AcpiHwRegisterRead (ACPI_MTX_LOCK, ACPI_REGISTER_PM1_CONTROL); 317 ACPI_DEBUG_PRINT ((ACPI_DB_OK, "Entering S%d\n", SleepState)); 318 319 /* Clear SLP_EN and SLP_TYP fields */ 320 321 PM1AControl &= ~(SleepTypeRegInfo->AccessBitMask | SleepEnableRegInfo->AccessBitMask); 322 PM1BControl = PM1AControl; 323 324 /* Insert SLP_TYP bits */ 325 326 PM1AControl |= (AcpiGbl_SleepTypeA << SleepTypeRegInfo->BitPosition); 327 PM1BControl |= (AcpiGbl_SleepTypeB << SleepTypeRegInfo->BitPosition); 328 329 /* Write #1: fill in SLP_TYP data */ 330 331 AcpiHwRegisterWrite (ACPI_MTX_LOCK, ACPI_REGISTER_PM1A_CONTROL, PM1AControl); 332 AcpiHwRegisterWrite (ACPI_MTX_LOCK, ACPI_REGISTER_PM1B_CONTROL, PM1BControl); 333 334 /* Insert SLP_ENABLE bit */ 335 336 PM1AControl |= SleepEnableRegInfo->AccessBitMask; 337 PM1BControl |= SleepEnableRegInfo->AccessBitMask; 338 339 /* Write #2: SLP_TYP + SLP_EN */ 340 ACPI_FLUSH_CPU_CACHE(); 341 342 AcpiHwRegisterWrite (ACPI_MTX_LOCK, ACPI_REGISTER_PM1A_CONTROL, PM1AControl); 343 AcpiHwRegisterWrite (ACPI_MTX_LOCK, ACPI_REGISTER_PM1B_CONTROL, PM1BControl); 344 345 /* 346 * Wait a second, then try again. This is to get S4/5 to work on all machines. 347 */ 348 if (SleepState > ACPI_STATE_S3) 349 { 350 AcpiOsStall (1000000); 351 352 AcpiHwRegisterWrite (ACPI_MTX_LOCK, ACPI_REGISTER_PM1_CONTROL, 353 SleepEnableRegInfo->AccessBitMask); 354 } 355 356 /* Wait until we enter sleep state */ 357 358 while (!AcpiHwBitRegisterRead (ACPI_BITREG_WAKE_STATUS, ACPI_MTX_LOCK)) 359 { 360 /* Spin until we wake */ 361 } 362 363 return_ACPI_STATUS (AE_OK); 364} 365 366/****************************************************************************** 367 * 368 * FUNCTION: AcpiLeaveSleepState 369 * 370 * PARAMETERS: SleepState - Which sleep state we just exited 371 * 372 * RETURN: Status 373 * 374 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep 375 * 376 ******************************************************************************/ 377 378ACPI_STATUS 379AcpiLeaveSleepState ( 380 UINT8 SleepState) 381{ 382 ACPI_OBJECT_LIST ArgList; 383 ACPI_OBJECT Arg; 384 ACPI_STATUS Status; 385 386 387 ACPI_FUNCTION_TRACE ("AcpiLeaveSleepState"); 388 389 390 /* Ensure EnterSleepStatePrep -> EnterSleepState ordering */ 391 392 AcpiGbl_SleepTypeA = ACPI_SLEEP_TYPE_INVALID; 393 394 /* Setup parameter object */ 395 396 ArgList.Count = 1; 397 ArgList.Pointer = &Arg; 398 399 Arg.Type = ACPI_TYPE_INTEGER; 400 Arg.Integer.Value = SleepState; 401 402 /* Ignore any errors from these methods */ 403 404 Status = AcpiEvaluateObject (NULL, "\\_BFS", &ArgList, NULL); 405 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND) 406 { 407 ACPI_REPORT_ERROR (("Method _BFS failed, %s\n", AcpiFormatException (Status))); 408 } 409 410 Status = AcpiEvaluateObject (NULL, "\\_WAK", &ArgList, NULL); 411 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND) 412 { 413 ACPI_REPORT_ERROR (("Method _WAK failed, %s\n", AcpiFormatException (Status))); 414 } 415 416 /* _WAK returns stuff - do we want to look at it? */ 417 418 AcpiHwEnableNonWakeupGpes(); 419 420 return_ACPI_STATUS (AE_OK); 421} 422