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 - 2016, 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 #define EXPORT_ACPI_INTERFACES 117 118 #include "acpi.h" 119 #include "accommon.h" 120 121 #define _COMPONENT ACPI_HARDWARE 122 ACPI_MODULE_NAME ("hwxfsleep") 123 124 /* Local prototypes */ 125 126 #if (!ACPI_REDUCED_HARDWARE) 127 static ACPI_STATUS 128 AcpiHwSetFirmwareWakingVector ( 129 ACPI_TABLE_FACS *Facs, 130 ACPI_PHYSICAL_ADDRESS PhysicalAddress, 131 ACPI_PHYSICAL_ADDRESS PhysicalAddress64); 132 #endif 133 134 static ACPI_STATUS 135 AcpiHwSleepDispatch ( 136 UINT8 SleepState, 137 UINT32 FunctionId); 138 139 /* 140 * Dispatch table used to efficiently branch to the various sleep 141 * functions. 142 */ 143 #define ACPI_SLEEP_FUNCTION_ID 0 144 #define ACPI_WAKE_PREP_FUNCTION_ID 1 145 #define ACPI_WAKE_FUNCTION_ID 2 146 147 /* Legacy functions are optional, based upon ACPI_REDUCED_HARDWARE */ 148 149 static ACPI_SLEEP_FUNCTIONS AcpiSleepDispatch[] = 150 { 151 {ACPI_HW_OPTIONAL_FUNCTION (AcpiHwLegacySleep), AcpiHwExtendedSleep}, 152 {ACPI_HW_OPTIONAL_FUNCTION (AcpiHwLegacyWakePrep), AcpiHwExtendedWakePrep}, 153 {ACPI_HW_OPTIONAL_FUNCTION (AcpiHwLegacyWake), AcpiHwExtendedWake} 154 }; 155 156 157 /* 158 * These functions are removed for the ACPI_REDUCED_HARDWARE case: 159 * AcpiSetFirmwareWakingVector 160 * AcpiEnterSleepStateS4bios 161 */ 162 163 #if (!ACPI_REDUCED_HARDWARE) 164 /******************************************************************************* 165 * 166 * FUNCTION: AcpiHwSetFirmwareWakingVector 167 * 168 * PARAMETERS: Facs - Pointer to FACS table 169 * PhysicalAddress - 32-bit physical address of ACPI real mode 170 * entry point 171 * PhysicalAddress64 - 64-bit physical address of ACPI protected 172 * mode entry point 173 * 174 * RETURN: Status 175 * 176 * DESCRIPTION: Sets the FirmwareWakingVector fields of the FACS 177 * 178 ******************************************************************************/ 179 180 static ACPI_STATUS 181 AcpiHwSetFirmwareWakingVector ( 182 ACPI_TABLE_FACS *Facs, 183 ACPI_PHYSICAL_ADDRESS PhysicalAddress, 184 ACPI_PHYSICAL_ADDRESS PhysicalAddress64) 185 { 186 ACPI_FUNCTION_TRACE (AcpiHwSetFirmwareWakingVector); 187 188 189 /* 190 * According to the ACPI specification 2.0c and later, the 64-bit 191 * waking vector should be cleared and the 32-bit waking vector should 192 * be used, unless we want the wake-up code to be called by the BIOS in 193 * Protected Mode. Some systems (for example HP dv5-1004nr) are known 194 * to fail to resume if the 64-bit vector is used. 195 */ 196 197 /* Set the 32-bit vector */ 198 199 Facs->FirmwareWakingVector = (UINT32) PhysicalAddress; 200 201 if (Facs->Length > 32) 202 { 203 if (Facs->Version >= 1) 204 { 205 /* Set the 64-bit vector */ 206 207 Facs->XFirmwareWakingVector = PhysicalAddress64; 208 } 209 else 210 { 211 /* Clear the 64-bit vector if it exists */ 212 213 Facs->XFirmwareWakingVector = 0; 214 } 215 } 216 217 return_ACPI_STATUS (AE_OK); 218 } 219 220 221 /******************************************************************************* 222 * 223 * FUNCTION: AcpiSetFirmwareWakingVector 224 * 225 * PARAMETERS: PhysicalAddress - 32-bit physical address of ACPI real mode 226 * entry point 227 * PhysicalAddress64 - 64-bit physical address of ACPI protected 228 * mode entry point 229 * 230 * RETURN: Status 231 * 232 * DESCRIPTION: Sets the FirmwareWakingVector fields of the FACS 233 * 234 ******************************************************************************/ 235 236 ACPI_STATUS 237 AcpiSetFirmwareWakingVector ( 238 ACPI_PHYSICAL_ADDRESS PhysicalAddress, 239 ACPI_PHYSICAL_ADDRESS PhysicalAddress64) 240 { 241 242 ACPI_FUNCTION_TRACE (AcpiSetFirmwareWakingVector); 243 244 if (AcpiGbl_FACS) 245 { 246 (void) AcpiHwSetFirmwareWakingVector (AcpiGbl_FACS, 247 PhysicalAddress, PhysicalAddress64); 248 } 249 250 return_ACPI_STATUS (AE_OK); 251 } 252 253 ACPI_EXPORT_SYMBOL (AcpiSetFirmwareWakingVector) 254 255 256 /******************************************************************************* 257 * 258 * FUNCTION: AcpiEnterSleepStateS4bios 259 * 260 * PARAMETERS: None 261 * 262 * RETURN: Status 263 * 264 * DESCRIPTION: Perform a S4 bios request. 265 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED 266 * 267 ******************************************************************************/ 268 269 ACPI_STATUS 270 AcpiEnterSleepStateS4bios ( 271 void) 272 { 273 UINT32 InValue; 274 ACPI_STATUS Status; 275 276 277 ACPI_FUNCTION_TRACE (AcpiEnterSleepStateS4bios); 278 279 280 /* Clear the wake status bit (PM1) */ 281 282 Status = AcpiWriteBitRegister (ACPI_BITREG_WAKE_STATUS, ACPI_CLEAR_STATUS); 283 if (ACPI_FAILURE (Status)) 284 { 285 return_ACPI_STATUS (Status); 286 } 287 288 Status = AcpiHwClearAcpiStatus (); 289 if (ACPI_FAILURE (Status)) 290 { 291 return_ACPI_STATUS (Status); 292 } 293 294 /* 295 * 1) Disable/Clear all GPEs 296 * 2) Enable all wakeup GPEs 297 */ 298 Status = AcpiHwDisableAllGpes (); 299 if (ACPI_FAILURE (Status)) 300 { 301 return_ACPI_STATUS (Status); 302 } 303 AcpiGbl_SystemAwakeAndRunning = FALSE; 304 305 Status = AcpiHwEnableAllWakeupGpes (); 306 if (ACPI_FAILURE (Status)) 307 { 308 return_ACPI_STATUS (Status); 309 } 310 311 ACPI_FLUSH_CPU_CACHE (); 312 313 Status = AcpiHwWritePort (AcpiGbl_FADT.SmiCommand, 314 (UINT32) AcpiGbl_FADT.S4BiosRequest, 8); 315 316 do { 317 AcpiOsStall (ACPI_USEC_PER_MSEC); 318 Status = AcpiReadBitRegister (ACPI_BITREG_WAKE_STATUS, &InValue); 319 if (ACPI_FAILURE (Status)) 320 { 321 return_ACPI_STATUS (Status); 322 } 323 324 } while (!InValue); 325 326 return_ACPI_STATUS (AE_OK); 327 } 328 329 ACPI_EXPORT_SYMBOL (AcpiEnterSleepStateS4bios) 330 331 #endif /* !ACPI_REDUCED_HARDWARE */ 332 333 334 /******************************************************************************* 335 * 336 * FUNCTION: AcpiHwSleepDispatch 337 * 338 * PARAMETERS: SleepState - Which sleep state to enter/exit 339 * FunctionId - Sleep, WakePrep, or Wake 340 * 341 * RETURN: Status from the invoked sleep handling function. 342 * 343 * DESCRIPTION: Dispatch a sleep/wake request to the appropriate handling 344 * function. 345 * 346 ******************************************************************************/ 347 348 static ACPI_STATUS 349 AcpiHwSleepDispatch ( 350 UINT8 SleepState, 351 UINT32 FunctionId) 352 { 353 ACPI_STATUS Status; 354 ACPI_SLEEP_FUNCTIONS *SleepFunctions = &AcpiSleepDispatch[FunctionId]; 355 356 357 #if (!ACPI_REDUCED_HARDWARE) 358 /* 359 * If the Hardware Reduced flag is set (from the FADT), we must 360 * use the extended sleep registers (FADT). Note: As per the ACPI 361 * specification, these extended registers are to be used for HW-reduced 362 * platforms only. They are not general-purpose replacements for the 363 * legacy PM register sleep support. 364 */ 365 if (AcpiGbl_ReducedHardware) 366 { 367 Status = SleepFunctions->ExtendedFunction (SleepState); 368 } 369 else 370 { 371 /* Legacy sleep */ 372 373 Status = SleepFunctions->LegacyFunction (SleepState); 374 } 375 376 return (Status); 377 378 #else 379 /* 380 * For the case where reduced-hardware-only code is being generated, 381 * we know that only the extended sleep registers are available 382 */ 383 Status = SleepFunctions->ExtendedFunction (SleepState); 384 return (Status); 385 386 #endif /* !ACPI_REDUCED_HARDWARE */ 387 } 388 389 390 /******************************************************************************* 391 * 392 * FUNCTION: AcpiEnterSleepStatePrep 393 * 394 * PARAMETERS: SleepState - Which sleep state to enter 395 * 396 * RETURN: Status 397 * 398 * DESCRIPTION: Prepare to enter a system sleep state. 399 * This function must execute with interrupts enabled. 400 * We break sleeping into 2 stages so that OSPM can handle 401 * various OS-specific tasks between the two steps. 402 * 403 ******************************************************************************/ 404 405 ACPI_STATUS 406 AcpiEnterSleepStatePrep ( 407 UINT8 SleepState) 408 { 409 ACPI_STATUS Status; 410 ACPI_OBJECT_LIST ArgList; 411 ACPI_OBJECT Arg; 412 UINT32 SstValue; 413 414 415 ACPI_FUNCTION_TRACE (AcpiEnterSleepStatePrep); 416 417 418 Status = AcpiGetSleepTypeData (SleepState, 419 &AcpiGbl_SleepTypeA, &AcpiGbl_SleepTypeB); 420 if (ACPI_FAILURE (Status)) 421 { 422 return_ACPI_STATUS (Status); 423 } 424 425 /* Execute the _PTS method (Prepare To Sleep) */ 426 427 ArgList.Count = 1; 428 ArgList.Pointer = &Arg; 429 Arg.Type = ACPI_TYPE_INTEGER; 430 Arg.Integer.Value = SleepState; 431 432 Status = AcpiEvaluateObject (NULL, METHOD_PATHNAME__PTS, &ArgList, NULL); 433 if (ACPI_FAILURE (Status) && Status != AE_NOT_FOUND) 434 { 435 return_ACPI_STATUS (Status); 436 } 437 438 /* Setup the argument to the _SST method (System STatus) */ 439 440 switch (SleepState) 441 { 442 case ACPI_STATE_S0: 443 444 SstValue = ACPI_SST_WORKING; 445 break; 446 447 case ACPI_STATE_S1: 448 case ACPI_STATE_S2: 449 case ACPI_STATE_S3: 450 451 SstValue = ACPI_SST_SLEEPING; 452 break; 453 454 case ACPI_STATE_S4: 455 456 SstValue = ACPI_SST_SLEEP_CONTEXT; 457 break; 458 459 default: 460 461 SstValue = ACPI_SST_INDICATOR_OFF; /* Default is off */ 462 break; 463 } 464 465 /* 466 * Set the system indicators to show the desired sleep state. 467 * _SST is an optional method (return no error if not found) 468 */ 469 AcpiHwExecuteSleepMethod (METHOD_PATHNAME__SST, SstValue); 470 return_ACPI_STATUS (AE_OK); 471 } 472 473 ACPI_EXPORT_SYMBOL (AcpiEnterSleepStatePrep) 474 475 476 /******************************************************************************* 477 * 478 * FUNCTION: AcpiEnterSleepState 479 * 480 * PARAMETERS: SleepState - Which sleep state to enter 481 * 482 * RETURN: Status 483 * 484 * DESCRIPTION: Enter a system sleep state 485 * THIS FUNCTION MUST BE CALLED WITH INTERRUPTS DISABLED 486 * 487 ******************************************************************************/ 488 489 ACPI_STATUS 490 AcpiEnterSleepState ( 491 UINT8 SleepState) 492 { 493 ACPI_STATUS Status; 494 495 496 ACPI_FUNCTION_TRACE (AcpiEnterSleepState); 497 498 499 if ((AcpiGbl_SleepTypeA > ACPI_SLEEP_TYPE_MAX) || 500 (AcpiGbl_SleepTypeB > ACPI_SLEEP_TYPE_MAX)) 501 { 502 ACPI_ERROR ((AE_INFO, "Sleep values out of range: A=0x%X B=0x%X", 503 AcpiGbl_SleepTypeA, AcpiGbl_SleepTypeB)); 504 return_ACPI_STATUS (AE_AML_OPERAND_VALUE); 505 } 506 507 Status = AcpiHwSleepDispatch (SleepState, ACPI_SLEEP_FUNCTION_ID); 508 return_ACPI_STATUS (Status); 509 } 510 511 ACPI_EXPORT_SYMBOL (AcpiEnterSleepState) 512 513 514 /******************************************************************************* 515 * 516 * FUNCTION: AcpiLeaveSleepStatePrep 517 * 518 * PARAMETERS: SleepState - Which sleep state we are exiting 519 * 520 * RETURN: Status 521 * 522 * DESCRIPTION: Perform the first state of OS-independent ACPI cleanup after a 523 * sleep. Called with interrupts DISABLED. 524 * We break wake/resume into 2 stages so that OSPM can handle 525 * various OS-specific tasks between the two steps. 526 * 527 ******************************************************************************/ 528 529 ACPI_STATUS 530 AcpiLeaveSleepStatePrep ( 531 UINT8 SleepState) 532 { 533 ACPI_STATUS Status; 534 535 536 ACPI_FUNCTION_TRACE (AcpiLeaveSleepStatePrep); 537 538 539 Status = AcpiHwSleepDispatch (SleepState, ACPI_WAKE_PREP_FUNCTION_ID); 540 return_ACPI_STATUS (Status); 541 } 542 543 ACPI_EXPORT_SYMBOL (AcpiLeaveSleepStatePrep) 544 545 546 /******************************************************************************* 547 * 548 * FUNCTION: AcpiLeaveSleepState 549 * 550 * PARAMETERS: SleepState - Which sleep state we are exiting 551 * 552 * RETURN: Status 553 * 554 * DESCRIPTION: Perform OS-independent ACPI cleanup after a sleep 555 * Called with interrupts ENABLED. 556 * 557 ******************************************************************************/ 558 559 ACPI_STATUS 560 AcpiLeaveSleepState ( 561 UINT8 SleepState) 562 { 563 ACPI_STATUS Status; 564 565 566 ACPI_FUNCTION_TRACE (AcpiLeaveSleepState); 567 568 569 Status = AcpiHwSleepDispatch (SleepState, ACPI_WAKE_FUNCTION_ID); 570 return_ACPI_STATUS (Status); 571 } 572 573 ACPI_EXPORT_SYMBOL (AcpiLeaveSleepState) 574