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