hwsleep.c revision 123315
1 2/****************************************************************************** 3 * 4 * Name: hwsleep.c - ACPI Hardware Sleep/Wake Interface 5 * $Revision: 58 $ 6 * 7 *****************************************************************************/ 8 9/****************************************************************************** 10 * 11 * 1. Copyright Notice 12 * 13 * Some or all of this work - Copyright (c) 1999 - 2003, 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 120#define _COMPONENT ACPI_HARDWARE 121 ACPI_MODULE_NAME ("hwsleep") 122 123 124/****************************************************************************** 125 * 126 * FUNCTION: AcpiSetFirmwareWakingVector 127 * 128 * PARAMETERS: PhysicalAddress - Physical address of ACPI real mode 129 * entry point. 130 * 131 * RETURN: Status 132 * 133 * DESCRIPTION: Access function for dFirmwareWakingVector field in FACS 134 * 135 ******************************************************************************/ 136 137ACPI_STATUS 138AcpiSetFirmwareWakingVector ( 139 ACPI_PHYSICAL_ADDRESS PhysicalAddress) 140{ 141 142 ACPI_FUNCTION_TRACE ("AcpiSetFirmwareWakingVector"); 143 144 145 /* Set the vector */ 146 147 if (AcpiGbl_CommonFACS.VectorWidth == 32) 148 { 149 *(ACPI_CAST_PTR (UINT32, AcpiGbl_CommonFACS.FirmwareWakingVector)) 150 = (UINT32) PhysicalAddress; 151 } 152 else 153 { 154 *AcpiGbl_CommonFACS.FirmwareWakingVector 155 = 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 = (ACPI_PHYSICAL_ADDRESS) 194 *(ACPI_CAST_PTR (UINT32, AcpiGbl_CommonFACS.FirmwareWakingVector)); 195 } 196 else 197 { 198 *PhysicalAddress = 199 *AcpiGbl_CommonFACS.FirmwareWakingVector; 200 } 201 202 return_ACPI_STATUS (AE_OK); 203} 204 205 206/****************************************************************************** 207 * 208 * FUNCTION: AcpiEnterSleepStatePrep 209 * 210 * PARAMETERS: SleepState - Which sleep state to enter 211 * 212 * RETURN: Status 213 * 214 * DESCRIPTION: Prepare to enter a system sleep state (see ACPI 2.0 spec p 231) 215 * This function must execute with interrupts enabled. 216 * We break sleeping into 2 stages so that OSPM can handle 217 * various OS-specific tasks between the two steps. 218 * 219 ******************************************************************************/ 220 221ACPI_STATUS 222AcpiEnterSleepStatePrep ( 223 UINT8 SleepState) 224{ 225 ACPI_STATUS Status; 226 ACPI_OBJECT_LIST ArgList; 227 ACPI_OBJECT Arg; 228 229 230 ACPI_FUNCTION_TRACE ("AcpiEnterSleepStatePrep"); 231 232 233 /* 234 * _PSW methods could be run here to enable wake-on keyboard, LAN, etc. 235 */ 236 Status = AcpiGetSleepTypeData (SleepState, 237 &AcpiGbl_SleepTypeA, &AcpiGbl_SleepTypeB); 238 if (ACPI_FAILURE (Status)) 239 { 240 return_ACPI_STATUS (Status); 241 } 242 243 /* Setup parameter object */ 244 245 ArgList.Count = 1; 246 ArgList.Pointer = &Arg; 247 248 Arg.Type = ACPI_TYPE_INTEGER; 249 Arg.Integer.Value = SleepState; 250 251 /* Run the _PTS and _GTS methods */ 252 253 Status = AcpiEvaluateObject (NULL, "\\_PTS", &ArgList, NULL); 254 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND) 255 { 256 return_ACPI_STATUS (Status); 257 } 258 259 Status = AcpiEvaluateObject (NULL, "\\_GTS", &ArgList, NULL); 260 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND) 261 { 262 return_ACPI_STATUS (Status); 263 } 264 265 /* Set the system indicators to show the desired sleep state. */ 266 267 Status = AcpiEvaluateObject (NULL, "\\_SI._SST", &ArgList, NULL); 268 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND) 269 { 270 ACPI_REPORT_ERROR (("Method _SST failed, %s\n", AcpiFormatException (Status))); 271 } 272 273 return_ACPI_STATUS (AE_OK); 274} 275 276 277/****************************************************************************** 278 * 279 * FUNCTION: AcpiEnterSleepState 280 * 281 * PARAMETERS: SleepState - Which sleep state to enter 282 * 283 * RETURN: Status 284 * 285 * DESCRIPTION: Enter a system sleep state (see ACPI 2.0 spec p 231) 286 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED 287 * 288 ******************************************************************************/ 289 290ACPI_STATUS 291AcpiEnterSleepState ( 292 UINT8 SleepState) 293{ 294 UINT32 PM1AControl; 295 UINT32 PM1BControl; 296 ACPI_BIT_REGISTER_INFO *SleepTypeRegInfo; 297 ACPI_BIT_REGISTER_INFO *SleepEnableRegInfo; 298 UINT32 InValue; 299 ACPI_STATUS Status; 300 301 302 ACPI_FUNCTION_TRACE ("AcpiEnterSleepState"); 303 304 305 if ((AcpiGbl_SleepTypeA > ACPI_SLEEP_TYPE_MAX) || 306 (AcpiGbl_SleepTypeB > ACPI_SLEEP_TYPE_MAX)) 307 { 308 ACPI_REPORT_ERROR (("Sleep values out of range: A=%X B=%X\n", 309 AcpiGbl_SleepTypeA, AcpiGbl_SleepTypeB)); 310 return_ACPI_STATUS (AE_AML_OPERAND_VALUE); 311 } 312 313 SleepTypeRegInfo = AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_TYPE_A); 314 SleepEnableRegInfo = AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_ENABLE); 315 316 if (SleepState != ACPI_STATE_S5) 317 { 318 /* Clear wake status */ 319 320 Status = AcpiSetRegister (ACPI_BITREG_WAKE_STATUS, 1, ACPI_MTX_DO_NOT_LOCK); 321 if (ACPI_FAILURE (Status)) 322 { 323 return_ACPI_STATUS (Status); 324 } 325 326 Status = AcpiHwClearAcpiStatus (ACPI_MTX_DO_NOT_LOCK); 327 if (ACPI_FAILURE (Status)) 328 { 329 return_ACPI_STATUS (Status); 330 } 331 332 /* Disable BM arbitration */ 333 334 Status = AcpiSetRegister (ACPI_BITREG_ARB_DISABLE, 1, ACPI_MTX_DO_NOT_LOCK); 335 if (ACPI_FAILURE (Status)) 336 { 337 return_ACPI_STATUS (Status); 338 } 339 } 340 341 Status = AcpiHwDisableNonWakeupGpes(); 342 if (ACPI_FAILURE (Status)) 343 { 344 return_ACPI_STATUS (Status); 345 } 346 347 /* Get current value of PM1A control */ 348 349 Status = AcpiHwRegisterRead (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1_CONTROL, &PM1AControl); 350 if (ACPI_FAILURE (Status)) 351 { 352 return_ACPI_STATUS (Status); 353 } 354 ACPI_DEBUG_PRINT ((ACPI_DB_INIT, "Entering sleep state [S%d]\n", SleepState)); 355 356 /* Clear SLP_EN and SLP_TYP fields */ 357 358 PM1AControl &= ~(SleepTypeRegInfo->AccessBitMask | SleepEnableRegInfo->AccessBitMask); 359 PM1BControl = PM1AControl; 360 361 /* Insert SLP_TYP bits */ 362 363 PM1AControl |= (AcpiGbl_SleepTypeA << SleepTypeRegInfo->BitPosition); 364 PM1BControl |= (AcpiGbl_SleepTypeB << SleepTypeRegInfo->BitPosition); 365 366 /* Write #1: fill in SLP_TYP data */ 367 368 Status = AcpiHwRegisterWrite (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1A_CONTROL, PM1AControl); 369 if (ACPI_FAILURE (Status)) 370 { 371 return_ACPI_STATUS (Status); 372 } 373 374 Status = AcpiHwRegisterWrite (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1B_CONTROL, PM1BControl); 375 if (ACPI_FAILURE (Status)) 376 { 377 return_ACPI_STATUS (Status); 378 } 379 380 /* Insert SLP_ENABLE bit */ 381 382 PM1AControl |= SleepEnableRegInfo->AccessBitMask; 383 PM1BControl |= SleepEnableRegInfo->AccessBitMask; 384 385 /* Write #2: SLP_TYP + SLP_EN */ 386 387 ACPI_FLUSH_CPU_CACHE (); 388 389 Status = AcpiHwRegisterWrite (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1A_CONTROL, PM1AControl); 390 if (ACPI_FAILURE (Status)) 391 { 392 return_ACPI_STATUS (Status); 393 } 394 395 Status = AcpiHwRegisterWrite (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1B_CONTROL, PM1BControl); 396 if (ACPI_FAILURE (Status)) 397 { 398 return_ACPI_STATUS (Status); 399 } 400 401 if (SleepState > ACPI_STATE_S3) 402 { 403 /* 404 * We wanted to sleep > S3, but it didn't happen (by virtue of the fact that 405 * we are still executing!) 406 * 407 * Wait ten seconds, then try again. This is to get S4/S5 to work on all machines. 408 * 409 * We wait so long to allow chipsets that poll this reg very slowly to 410 * still read the right value. Ideally, this entire block would go 411 * away entirely. 412 */ 413 AcpiOsStall (10000000); 414 415 Status = AcpiHwRegisterWrite (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1_CONTROL, 416 SleepEnableRegInfo->AccessBitMask); 417 if (ACPI_FAILURE (Status)) 418 { 419 return_ACPI_STATUS (Status); 420 } 421 } 422 423 /* Wait until we enter sleep state */ 424 425 do 426 { 427 Status = AcpiGetRegister (ACPI_BITREG_WAKE_STATUS, &InValue, ACPI_MTX_DO_NOT_LOCK); 428 if (ACPI_FAILURE (Status)) 429 { 430 return_ACPI_STATUS (Status); 431 } 432 433 /* Spin until we wake */ 434 435 } while (!InValue); 436 437 return_ACPI_STATUS (AE_OK); 438} 439 440 441/****************************************************************************** 442 * 443 * FUNCTION: AcpiEnterSleepStateS4bios 444 * 445 * PARAMETERS: None 446 * 447 * RETURN: Status 448 * 449 * DESCRIPTION: Perform a S4 bios request. 450 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED 451 * 452 ******************************************************************************/ 453 454ACPI_STATUS 455AcpiEnterSleepStateS4bios ( 456 void) 457{ 458 UINT32 InValue; 459 ACPI_STATUS Status; 460 461 462 ACPI_FUNCTION_TRACE ("AcpiEnterSleepStateS4bios"); 463 464 465 AcpiSetRegister (ACPI_BITREG_WAKE_STATUS, 1, ACPI_MTX_DO_NOT_LOCK); 466 AcpiHwClearAcpiStatus(ACPI_MTX_DO_NOT_LOCK); 467 468 AcpiHwDisableNonWakeupGpes(); 469 470 ACPI_FLUSH_CPU_CACHE(); 471 472 Status = AcpiOsWritePort (AcpiGbl_FADT->SmiCmd, (UINT32) AcpiGbl_FADT->S4BiosReq, 8); 473 474 do { 475 AcpiOsStall(1000); 476 Status = AcpiGetRegister (ACPI_BITREG_WAKE_STATUS, &InValue, ACPI_MTX_DO_NOT_LOCK); 477 if (ACPI_FAILURE (Status)) 478 { 479 return_ACPI_STATUS (Status); 480 } 481 } while (!InValue); 482 483 return_ACPI_STATUS (AE_OK); 484} 485 486 487/****************************************************************************** 488 * 489 * FUNCTION: AcpiLeaveSleepState 490 * 491 * PARAMETERS: SleepState - Which sleep state we just exited 492 * 493 * RETURN: Status 494 * 495 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep 496 * 497 ******************************************************************************/ 498 499ACPI_STATUS 500AcpiLeaveSleepState ( 501 UINT8 SleepState) 502{ 503 ACPI_OBJECT_LIST ArgList; 504 ACPI_OBJECT Arg; 505 ACPI_STATUS Status; 506 ACPI_BIT_REGISTER_INFO *SleepTypeRegInfo; 507 ACPI_BIT_REGISTER_INFO *SleepEnableRegInfo; 508 UINT32 PM1xControl; 509 510 511 ACPI_FUNCTION_TRACE ("AcpiLeaveSleepState"); 512 513 /* Some machines require SLP_TYPE and SLP_EN to be cleared */ 514 515 SleepTypeRegInfo = AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_TYPE_A); 516 SleepEnableRegInfo = AcpiHwGetBitRegisterInfo (ACPI_BITREG_SLEEP_ENABLE); 517 518 /* Get current value of PM1A control */ 519 520 Status = AcpiHwRegisterRead (ACPI_MTX_DO_NOT_LOCK, 521 ACPI_REGISTER_PM1_CONTROL, &PM1xControl); 522 if (ACPI_SUCCESS (Status)) 523 { 524 /* Clear SLP_TYP and SLP_EN */ 525 526 PM1xControl &= ~(SleepTypeRegInfo->AccessBitMask | 527 SleepEnableRegInfo->AccessBitMask); 528 529 AcpiHwRegisterWrite (ACPI_MTX_DO_NOT_LOCK, 530 ACPI_REGISTER_PM1A_CONTROL, PM1xControl); 531 AcpiHwRegisterWrite (ACPI_MTX_DO_NOT_LOCK, 532 ACPI_REGISTER_PM1B_CONTROL, PM1xControl); 533 } 534 535 /* Ensure EnterSleepStatePrep -> EnterSleepState ordering */ 536 537 AcpiGbl_SleepTypeA = ACPI_SLEEP_TYPE_INVALID; 538 539 /* Setup parameter object */ 540 541 ArgList.Count = 1; 542 ArgList.Pointer = &Arg; 543 Arg.Type = ACPI_TYPE_INTEGER; 544 545 /* Ignore any errors from these methods */ 546 547 Arg.Integer.Value = 0; 548 Status = AcpiEvaluateObject (NULL, "\\_SI._SST", &ArgList, NULL); 549 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND) 550 { 551 ACPI_REPORT_ERROR (("Method _SST failed, %s\n", AcpiFormatException (Status))); 552 } 553 554 Arg.Integer.Value = SleepState; 555 Status = AcpiEvaluateObject (NULL, "\\_BFS", &ArgList, NULL); 556 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND) 557 { 558 ACPI_REPORT_ERROR (("Method _BFS failed, %s\n", AcpiFormatException (Status))); 559 } 560 561 Status = AcpiEvaluateObject (NULL, "\\_WAK", &ArgList, NULL); 562 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND) 563 { 564 ACPI_REPORT_ERROR (("Method _WAK failed, %s\n", AcpiFormatException (Status))); 565 } 566 567 /* _WAK returns stuff - do we want to look at it? */ 568 569 Status = AcpiHwEnableNonWakeupGpes(); 570 if (ACPI_FAILURE (Status)) 571 { 572 return_ACPI_STATUS (Status); 573 } 574 575 /* Enable BM arbitration */ 576 577 Status = AcpiSetRegister (ACPI_BITREG_ARB_DISABLE, 0, ACPI_MTX_LOCK); 578 return_ACPI_STATUS (Status); 579} 580