1 /****************************************************************************** 2 * 3 * Name: hwxfsleep.c - ACPI Hardware Sleep/Wake External Interfaces 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2012, Intel Corp. 12 * All rights reserved. 13 * 14 * 2. License 15 * 16 * 2.1. This is your license from Intel Corp. under its intellectual property 17 * rights. You may have additional license terms from the party that provided 18 * you this software, covering your right to use that party's intellectual 19 * property rights. 20 * 21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 22 * copy of the source code appearing in this file ("Covered Code") an 23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 24 * base code distributed originally by Intel ("Original Intel Code") to copy, 25 * make derivatives, distribute, use and display any portion of the Covered 26 * Code in any form, with the right to sublicense such rights; and 27 * 28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 29 * license (with the right to sublicense), under only those claims of Intel 30 * patents that are infringed by the Original Intel Code, to make, use, sell, 31 * offer to sell, and import the Covered Code and derivative works thereof 32 * solely to the minimum extent necessary to exercise the above copyright 33 * license, and in no event shall the patent license extend to any additions 34 * to or modifications of the Original Intel Code. No other license or right 35 * is granted directly or by implication, estoppel or otherwise; 36 * 37 * The above copyright and patent license is granted only if the following 38 * conditions are met: 39 * 40 * 3. Conditions 41 * 42 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 43 * Redistribution of source code of any substantial portion of the Covered 44 * Code or modification with rights to further distribute source must include 45 * the above Copyright Notice, the above License, this list of Conditions, 46 * and the following Disclaimer and Export Compliance provision. In addition, 47 * Licensee must cause all Covered Code to which Licensee contributes to 48 * contain a file documenting the changes Licensee made to create that Covered 49 * Code and the date of any change. Licensee must include in that file the 50 * documentation of any changes made by any predecessor Licensee. Licensee 51 * must include a prominent statement that the modification is derived, 52 * directly or indirectly, from Original Intel Code. 53 * 54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 55 * Redistribution of source code of any substantial portion of the Covered 56 * Code or modification without rights to further distribute source must 57 * include the following Disclaimer and Export Compliance provision in the 58 * documentation and/or other materials provided with distribution. In 59 * addition, Licensee may not authorize further sublicense of source of any 60 * portion of the Covered Code, and must include terms to the effect that the 61 * license from Licensee to its licensee is limited to the intellectual 62 * property embodied in the software Licensee provides to its licensee, and 63 * not to intellectual property embodied in modifications its licensee may 64 * make. 65 * 66 * 3.3. Redistribution of Executable. Redistribution in executable form of any 67 * substantial portion of the Covered Code or modification must reproduce the 68 * above Copyright Notice, and the following Disclaimer and Export Compliance 69 * provision in the documentation and/or other materials provided with the 70 * distribution. 71 * 72 * 3.4. Intel retains all right, title, and interest in and to the Original 73 * Intel Code. 74 * 75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 76 * Intel shall be used in advertising or otherwise to promote the sale, use or 77 * other dealings in products derived from or relating to the Covered Code 78 * without prior written authorization from Intel. 79 * 80 * 4. Disclaimer and Export Compliance 81 * 82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 88 * PARTICULAR PURPOSE. 89 * 90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 97 * LIMITED REMEDY. 98 * 99 * 4.3. Licensee shall not export, either directly or indirectly, any of this 100 * software or system incorporating such software without first obtaining any 101 * required license or other approval from the U. S. Department of Commerce or 102 * any other agency or department of the United States Government. In the 103 * event Licensee exports any such software from the United States or 104 * re-exports any such software from a foreign destination, Licensee shall 105 * ensure that the distribution and export/re-export of the software is in 106 * compliance with all laws, regulations, orders, or other restrictions of the 107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 108 * any of its subsidiaries will export/re-export any technical data, process, 109 * software, or service, directly or indirectly, to any country for which the 110 * United States government or any agency thereof requires an export license, 111 * other governmental approval, or letter of assurance, without first obtaining 112 * such license, approval or letter. 113 * 114 *****************************************************************************/ 115 116 #include "acpi.h" 117 #include "accommon.h" 118 119 #define _COMPONENT ACPI_HARDWARE 120 ACPI_MODULE_NAME ("hwxfsleep") 121 122 /* Local prototypes */ 123 124 static ACPI_STATUS 125 AcpiHwSleepDispatch ( 126 UINT8 SleepState, 127 UINT8 Flags, 128 UINT32 FunctionId); 129 130 /* 131 * Dispatch table used to efficiently branch to the various sleep 132 * functions. 133 */ 134 #define ACPI_SLEEP_FUNCTION_ID 0 135 #define ACPI_WAKE_PREP_FUNCTION_ID 1 136 #define ACPI_WAKE_FUNCTION_ID 2 137 138 /* Legacy functions are optional, based upon ACPI_REDUCED_HARDWARE */ 139 140 static ACPI_SLEEP_FUNCTIONS AcpiSleepDispatch[] = 141 { 142 {ACPI_HW_OPTIONAL_FUNCTION (AcpiHwLegacySleep), AcpiHwExtendedSleep}, 143 {ACPI_HW_OPTIONAL_FUNCTION (AcpiHwLegacyWakePrep), AcpiHwExtendedWakePrep}, 144 {ACPI_HW_OPTIONAL_FUNCTION (AcpiHwLegacyWake), AcpiHwExtendedWake} 145 }; 146 147 148 /* 149 * These functions are removed for the ACPI_REDUCED_HARDWARE case: 150 * AcpiSetFirmwareWakingVector 151 * AcpiSetFirmwareWakingVector64 152 * AcpiEnterSleepStateS4bios 153 */ 154 155 #if (!ACPI_REDUCED_HARDWARE) 156 /******************************************************************************* 157 * 158 * FUNCTION: AcpiSetFirmwareWakingVector 159 * 160 * PARAMETERS: PhysicalAddress - 32-bit physical address of ACPI real mode 161 * entry point. 162 * 163 * RETURN: Status 164 * 165 * DESCRIPTION: Sets the 32-bit FirmwareWakingVector field of the FACS 166 * 167 ******************************************************************************/ 168 169 ACPI_STATUS 170 AcpiSetFirmwareWakingVector ( 171 UINT32 PhysicalAddress) 172 { 173 ACPI_FUNCTION_TRACE (AcpiSetFirmwareWakingVector); 174 175 176 /* 177 * According to the ACPI specification 2.0c and later, the 64-bit 178 * waking vector should be cleared and the 32-bit waking vector should 179 * be used, unless we want the wake-up code to be called by the BIOS in 180 * Protected Mode. Some systems (for example HP dv5-1004nr) are known 181 * to fail to resume if the 64-bit vector is used. 182 */ 183 184 /* Set the 32-bit vector */ 185 186 AcpiGbl_FACS->FirmwareWakingVector = PhysicalAddress; 187 188 /* Clear the 64-bit vector if it exists */ 189 190 if ((AcpiGbl_FACS->Length > 32) && (AcpiGbl_FACS->Version >= 1)) 191 { 192 AcpiGbl_FACS->XFirmwareWakingVector = 0; 193 } 194 195 return_ACPI_STATUS (AE_OK); 196 } 197 198 ACPI_EXPORT_SYMBOL (AcpiSetFirmwareWakingVector) 199 200 201 #if ACPI_MACHINE_WIDTH == 64 202 /******************************************************************************* 203 * 204 * FUNCTION: AcpiSetFirmwareWakingVector64 205 * 206 * PARAMETERS: PhysicalAddress - 64-bit physical address of ACPI protected 207 * mode entry point. 208 * 209 * RETURN: Status 210 * 211 * DESCRIPTION: Sets the 64-bit X_FirmwareWakingVector field of the FACS, if 212 * it exists in the table. This function is intended for use with 213 * 64-bit host operating systems. 214 * 215 ******************************************************************************/ 216 217 ACPI_STATUS 218 AcpiSetFirmwareWakingVector64 ( 219 UINT64 PhysicalAddress) 220 { 221 ACPI_FUNCTION_TRACE (AcpiSetFirmwareWakingVector64); 222 223 224 /* Determine if the 64-bit vector actually exists */ 225 226 if ((AcpiGbl_FACS->Length <= 32) || (AcpiGbl_FACS->Version < 1)) 227 { 228 return_ACPI_STATUS (AE_NOT_EXIST); 229 } 230 231 /* Clear 32-bit vector, set the 64-bit X_ vector */ 232 233 AcpiGbl_FACS->FirmwareWakingVector = 0; 234 AcpiGbl_FACS->XFirmwareWakingVector = PhysicalAddress; 235 return_ACPI_STATUS (AE_OK); 236 } 237 238 ACPI_EXPORT_SYMBOL (AcpiSetFirmwareWakingVector64) 239 #endif 240 241 242 /******************************************************************************* 243 * 244 * FUNCTION: AcpiEnterSleepStateS4bios 245 * 246 * PARAMETERS: None 247 * 248 * RETURN: Status 249 * 250 * DESCRIPTION: Perform a S4 bios request. 251 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED 252 * 253 ******************************************************************************/ 254 255 ACPI_STATUS 256 AcpiEnterSleepStateS4bios ( 257 void) 258 { 259 UINT32 InValue; 260 ACPI_STATUS Status; 261 262 263 ACPI_FUNCTION_TRACE (AcpiEnterSleepStateS4bios); 264 265 266 /* Clear the wake status bit (PM1) */ 267 268 Status = AcpiWriteBitRegister (ACPI_BITREG_WAKE_STATUS, ACPI_CLEAR_STATUS); 269 if (ACPI_FAILURE (Status)) 270 { 271 return_ACPI_STATUS (Status); 272 } 273 274 Status = AcpiHwClearAcpiStatus (); 275 if (ACPI_FAILURE (Status)) 276 { 277 return_ACPI_STATUS (Status); 278 } 279 280 /* 281 * 1) Disable/Clear all GPEs 282 * 2) Enable all wakeup GPEs 283 */ 284 Status = AcpiHwDisableAllGpes (); 285 if (ACPI_FAILURE (Status)) 286 { 287 return_ACPI_STATUS (Status); 288 } 289 AcpiGbl_SystemAwakeAndRunning = FALSE; 290 291 Status = AcpiHwEnableAllWakeupGpes (); 292 if (ACPI_FAILURE (Status)) 293 { 294 return_ACPI_STATUS (Status); 295 } 296 297 ACPI_FLUSH_CPU_CACHE (); 298 299 Status = AcpiHwWritePort (AcpiGbl_FADT.SmiCommand, 300 (UINT32) AcpiGbl_FADT.S4BiosRequest, 8); 301 302 do { 303 AcpiOsStall(1000); 304 Status = AcpiReadBitRegister (ACPI_BITREG_WAKE_STATUS, &InValue); 305 if (ACPI_FAILURE (Status)) 306 { 307 return_ACPI_STATUS (Status); 308 } 309 } while (!InValue); 310 311 return_ACPI_STATUS (AE_OK); 312 } 313 314 ACPI_EXPORT_SYMBOL (AcpiEnterSleepStateS4bios) 315 316 #endif /* !ACPI_REDUCED_HARDWARE */ 317 318 319 /******************************************************************************* 320 * 321 * FUNCTION: AcpiHwSleepDispatch 322 * 323 * PARAMETERS: SleepState - Which sleep state to enter/exit 324 * FunctionId - Sleep, WakePrep, or Wake 325 * 326 * RETURN: Status from the invoked sleep handling function. 327 * 328 * DESCRIPTION: Dispatch a sleep/wake request to the appropriate handling 329 * function. 330 * 331 ******************************************************************************/ 332 333 static ACPI_STATUS 334 AcpiHwSleepDispatch ( 335 UINT8 SleepState, 336 UINT8 Flags, 337 UINT32 FunctionId) 338 { 339 ACPI_STATUS Status; 340 ACPI_SLEEP_FUNCTIONS *SleepFunctions = &AcpiSleepDispatch[FunctionId]; 341 342 343 #if (!ACPI_REDUCED_HARDWARE) 344 345 /* 346 * If the Hardware Reduced flag is set (from the FADT), we must 347 * use the extended sleep registers 348 */ 349 if (AcpiGbl_ReducedHardware || 350 AcpiGbl_FADT.SleepControl.Address) 351 { 352 Status = SleepFunctions->ExtendedFunction (SleepState, Flags); 353 } 354 else 355 { 356 /* Legacy sleep */ 357 358 Status = SleepFunctions->LegacyFunction (SleepState, Flags); 359 } 360 361 return (Status); 362 363 #else 364 /* 365 * For the case where reduced-hardware-only code is being generated, 366 * we know that only the extended sleep registers are available 367 */ 368 Status = SleepFunctions->ExtendedFunction (SleepState, Flags); 369 return (Status); 370 371 #endif /* !ACPI_REDUCED_HARDWARE */ 372 } 373 374 375 /******************************************************************************* 376 * 377 * FUNCTION: AcpiEnterSleepStatePrep 378 * 379 * PARAMETERS: SleepState - Which sleep state to enter 380 * 381 * RETURN: Status 382 * 383 * DESCRIPTION: Prepare to enter a system sleep state. 384 * This function must execute with interrupts enabled. 385 * We break sleeping into 2 stages so that OSPM can handle 386 * various OS-specific tasks between the two steps. 387 * 388 ******************************************************************************/ 389 390 ACPI_STATUS 391 AcpiEnterSleepStatePrep ( 392 UINT8 SleepState) 393 { 394 ACPI_STATUS Status; 395 ACPI_OBJECT_LIST ArgList; 396 ACPI_OBJECT Arg; 397 UINT32 SstValue; 398 399 400 ACPI_FUNCTION_TRACE (AcpiEnterSleepStatePrep); 401 402 403 Status = AcpiGetSleepTypeData (SleepState, 404 &AcpiGbl_SleepTypeA, &AcpiGbl_SleepTypeB); 405 if (ACPI_FAILURE (Status)) 406 { 407 return_ACPI_STATUS (Status); 408 } 409 410 /* Execute the _PTS method (Prepare To Sleep) */ 411 412 ArgList.Count = 1; 413 ArgList.Pointer = &Arg; 414 Arg.Type = ACPI_TYPE_INTEGER; 415 Arg.Integer.Value = SleepState; 416 417 Status = AcpiEvaluateObject (NULL, METHOD_PATHNAME__PTS, &ArgList, NULL); 418 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND) 419 { 420 return_ACPI_STATUS (Status); 421 } 422 423 /* Setup the argument to the _SST method (System STatus) */ 424 425 switch (SleepState) 426 { 427 case ACPI_STATE_S0: 428 SstValue = ACPI_SST_WORKING; 429 break; 430 431 case ACPI_STATE_S1: 432 case ACPI_STATE_S2: 433 case ACPI_STATE_S3: 434 SstValue = ACPI_SST_SLEEPING; 435 break; 436 437 case ACPI_STATE_S4: 438 SstValue = ACPI_SST_SLEEP_CONTEXT; 439 break; 440 441 default: 442 SstValue = ACPI_SST_INDICATOR_OFF; /* Default is off */ 443 break; 444 } 445 446 /* 447 * Set the system indicators to show the desired sleep state. 448 * _SST is an optional method (return no error if not found) 449 */ 450 AcpiHwExecuteSleepMethod (METHOD_PATHNAME__SST, SstValue); 451 return_ACPI_STATUS (AE_OK); 452 } 453 454 ACPI_EXPORT_SYMBOL (AcpiEnterSleepStatePrep) 455 456 457 /******************************************************************************* 458 * 459 * FUNCTION: AcpiEnterSleepState 460 * 461 * PARAMETERS: SleepState - Which sleep state to enter 462 * Flags - ACPI_EXECUTE_GTS to run optional method 463 * 464 * RETURN: Status 465 * 466 * DESCRIPTION: Enter a system sleep state 467 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED 468 * 469 ******************************************************************************/ 470 471 ACPI_STATUS 472 AcpiEnterSleepState ( 473 UINT8 SleepState, 474 UINT8 Flags) 475 { 476 ACPI_STATUS Status; 477 478 479 ACPI_FUNCTION_TRACE (AcpiEnterSleepState); 480 481 482 if ((AcpiGbl_SleepTypeA > ACPI_SLEEP_TYPE_MAX) || 483 (AcpiGbl_SleepTypeB > ACPI_SLEEP_TYPE_MAX)) 484 { 485 ACPI_ERROR ((AE_INFO, "Sleep values out of range: A=0x%X B=0x%X", 486 AcpiGbl_SleepTypeA, AcpiGbl_SleepTypeB)); 487 return_ACPI_STATUS (AE_AML_OPERAND_VALUE); 488 } 489 490 Status = AcpiHwSleepDispatch (SleepState, Flags, ACPI_SLEEP_FUNCTION_ID); 491 return_ACPI_STATUS (Status); 492 } 493 494 ACPI_EXPORT_SYMBOL (AcpiEnterSleepState) 495 496 497 /******************************************************************************* 498 * 499 * FUNCTION: AcpiLeaveSleepStatePrep 500 * 501 * PARAMETERS: SleepState - Which sleep state we are exiting 502 * Flags - ACPI_EXECUTE_BFS to run optional method 503 * 504 * RETURN: Status 505 * 506 * DESCRIPTION: Perform the first state of OS-independent ACPI cleanup after a 507 * sleep. Called with interrupts DISABLED. 508 * We break wake/resume into 2 stages so that OSPM can handle 509 * various OS-specific tasks between the two steps. 510 * 511 ******************************************************************************/ 512 513 ACPI_STATUS 514 AcpiLeaveSleepStatePrep ( 515 UINT8 SleepState, 516 UINT8 Flags) 517 { 518 ACPI_STATUS Status; 519 520 521 ACPI_FUNCTION_TRACE (AcpiLeaveSleepStatePrep); 522 523 524 Status = AcpiHwSleepDispatch (SleepState, Flags, ACPI_WAKE_PREP_FUNCTION_ID); 525 return_ACPI_STATUS (Status); 526 } 527 528 ACPI_EXPORT_SYMBOL (AcpiLeaveSleepStatePrep) 529 530 531 /******************************************************************************* 532 * 533 * FUNCTION: AcpiLeaveSleepState 534 * 535 * PARAMETERS: SleepState - Which sleep state we are exiting 536 * 537 * RETURN: Status 538 * 539 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep 540 * Called with interrupts ENABLED. 541 * 542 ******************************************************************************/ 543 544 ACPI_STATUS 545 AcpiLeaveSleepState ( 546 UINT8 SleepState) 547 { 548 ACPI_STATUS Status; 549 550 551 ACPI_FUNCTION_TRACE (AcpiLeaveSleepState); 552 553 554 Status = AcpiHwSleepDispatch (SleepState, 0, ACPI_WAKE_FUNCTION_ID); 555 return_ACPI_STATUS (Status); 556 } 557 558 ACPI_EXPORT_SYMBOL (AcpiLeaveSleepState) 559