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