1 // SPDX-License-Identifier: GPL-2.0-only 2 /* 3 * sleep.c - ACPI sleep support. 4 * 5 * Copyright (c) 2005 Alexey Starikovskiy <alexey.y.starikovskiy@intel.com> 6 * Copyright (c) 2004 David Shaohua Li <shaohua.li@intel.com> 7 * Copyright (c) 2000-2003 Patrick Mochel 8 * Copyright (c) 2003 Open Source Development Lab 9 */ 10 11 #define pr_fmt(fmt) "ACPI: PM: " fmt 12 13 #include <linux/delay.h> 14 #include <linux/irq.h> 15 #include <linux/dmi.h> 16 #include <linux/device.h> 17 #include <linux/interrupt.h> 18 #include <linux/suspend.h> 19 #include <linux/reboot.h> 20 #include <linux/acpi.h> 21 #include <linux/module.h> 22 #include <linux/syscore_ops.h> 23 #include <asm/io.h> 24 #include <trace/events/power.h> 25 26 #include "internal.h" 27 #include "sleep.h" 28 29 /* 30 * Some HW-full platforms do not have _S5, so they may need 31 * to leverage efi power off for a shutdown. 32 */ 33 bool acpi_no_s5; 34 static u8 sleep_states[ACPI_S_STATE_COUNT]; 35 36 static void acpi_sleep_tts_switch(u32 acpi_state) 37 { 38 acpi_status status; 39 40 status = acpi_execute_simple_method(NULL, "\\_TTS", acpi_state); 41 if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) { 42 /* 43 * OS can't evaluate the _TTS object correctly. Some warning 44 * message will be printed. But it won't break anything. 45 */ 46 pr_notice("Failure in evaluating _TTS object\n"); 47 } 48 } 49 50 static int tts_notify_reboot(struct notifier_block *this, 51 unsigned long code, void *x) 52 { 53 acpi_sleep_tts_switch(ACPI_STATE_S5); 54 return NOTIFY_DONE; 55 } 56 57 static struct notifier_block tts_notifier = { 58 .notifier_call = tts_notify_reboot, 59 .next = NULL, 60 .priority = 0, 61 }; 62 63 static int acpi_sleep_prepare(u32 acpi_state) 64 { 65 #ifdef CONFIG_ACPI_SLEEP 66 unsigned long acpi_wakeup_address; 67 68 /* do we have a wakeup address for S2 and S3? */ 69 if (acpi_state == ACPI_STATE_S3) { 70 acpi_wakeup_address = acpi_get_wakeup_address(); 71 if (!acpi_wakeup_address) 72 return -EFAULT; 73 acpi_set_waking_vector(acpi_wakeup_address); 74 75 } 76 #endif 77 pr_info("Preparing to enter system sleep state S%d\n", acpi_state); 78 acpi_enable_wakeup_devices(acpi_state); 79 acpi_enter_sleep_state_prep(acpi_state); 80 return 0; 81 } 82 83 bool acpi_sleep_state_supported(u8 sleep_state) 84 { 85 acpi_status status; 86 u8 type_a, type_b; 87 88 status = acpi_get_sleep_type_data(sleep_state, &type_a, &type_b); 89 return ACPI_SUCCESS(status) && (!acpi_gbl_reduced_hardware 90 || (acpi_gbl_FADT.sleep_control.address 91 && acpi_gbl_FADT.sleep_status.address)); 92 } 93 94 #ifdef CONFIG_ACPI_SLEEP 95 static u32 acpi_target_sleep_state = ACPI_STATE_S0; 96 97 u32 acpi_target_system_state(void) 98 { 99 return acpi_target_sleep_state; 100 } 101 EXPORT_SYMBOL_GPL(acpi_target_system_state); 102 103 static bool pwr_btn_event_pending; 104 105 /* 106 * The ACPI specification wants us to save NVS memory regions during hibernation 107 * and to restore them during the subsequent resume. Windows does that also for 108 * suspend to RAM. However, it is known that this mechanism does not work on 109 * all machines, so we allow the user to disable it with the help of the 110 * 'acpi_sleep=nonvs' kernel command line option. 111 */ 112 static bool nvs_nosave; 113 114 void __init acpi_nvs_nosave(void) 115 { 116 nvs_nosave = true; 117 } 118 119 /* 120 * The ACPI specification wants us to save NVS memory regions during hibernation 121 * but says nothing about saving NVS during S3. Not all versions of Windows 122 * save NVS on S3 suspend either, and it is clear that not all systems need 123 * NVS to be saved at S3 time. To improve suspend/resume time, allow the 124 * user to disable saving NVS on S3 if their system does not require it, but 125 * continue to save/restore NVS for S4 as specified. 126 */ 127 static bool nvs_nosave_s3; 128 129 void __init acpi_nvs_nosave_s3(void) 130 { 131 nvs_nosave_s3 = true; 132 } 133 134 static int __init init_nvs_save_s3(const struct dmi_system_id *d) 135 { 136 nvs_nosave_s3 = false; 137 return 0; 138 } 139 140 /* 141 * ACPI 1.0 wants us to execute _PTS before suspending devices, so we allow the 142 * user to request that behavior by using the 'acpi_old_suspend_ordering' 143 * kernel command line option that causes the following variable to be set. 144 */ 145 static bool old_suspend_ordering; 146 147 void __init acpi_old_suspend_ordering(void) 148 { 149 old_suspend_ordering = true; 150 } 151 152 static int __init init_old_suspend_ordering(const struct dmi_system_id *d) 153 { 154 acpi_old_suspend_ordering(); 155 return 0; 156 } 157 158 static int __init init_nvs_nosave(const struct dmi_system_id *d) 159 { 160 acpi_nvs_nosave(); 161 return 0; 162 } 163 164 bool acpi_sleep_default_s3; 165 166 static int __init init_default_s3(const struct dmi_system_id *d) 167 { 168 acpi_sleep_default_s3 = true; 169 return 0; 170 } 171 172 static const struct dmi_system_id acpisleep_dmi_table[] __initconst = { 173 { 174 .callback = init_old_suspend_ordering, 175 .ident = "Abit KN9 (nForce4 variant)", 176 .matches = { 177 DMI_MATCH(DMI_BOARD_VENDOR, "http://www.abit.com.tw/"), 178 DMI_MATCH(DMI_BOARD_NAME, "KN9 Series(NF-CK804)"), 179 }, 180 }, 181 { 182 .callback = init_old_suspend_ordering, 183 .ident = "HP xw4600 Workstation", 184 .matches = { 185 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"), 186 DMI_MATCH(DMI_PRODUCT_NAME, "HP xw4600 Workstation"), 187 }, 188 }, 189 { 190 .callback = init_old_suspend_ordering, 191 .ident = "Asus Pundit P1-AH2 (M2N8L motherboard)", 192 .matches = { 193 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTek Computer INC."), 194 DMI_MATCH(DMI_BOARD_NAME, "M2N8L"), 195 }, 196 }, 197 { 198 .callback = init_old_suspend_ordering, 199 .ident = "Panasonic CF51-2L", 200 .matches = { 201 DMI_MATCH(DMI_BOARD_VENDOR, 202 "Matsushita Electric Industrial Co.,Ltd."), 203 DMI_MATCH(DMI_BOARD_NAME, "CF51-2L"), 204 }, 205 }, 206 { 207 .callback = init_nvs_nosave, 208 .ident = "Sony Vaio VGN-FW41E_H", 209 .matches = { 210 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"), 211 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW41E_H"), 212 }, 213 }, 214 { 215 .callback = init_nvs_nosave, 216 .ident = "Sony Vaio VGN-FW21E", 217 .matches = { 218 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"), 219 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW21E"), 220 }, 221 }, 222 { 223 .callback = init_nvs_nosave, 224 .ident = "Sony Vaio VGN-FW21M", 225 .matches = { 226 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"), 227 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW21M"), 228 }, 229 }, 230 { 231 .callback = init_nvs_nosave, 232 .ident = "Sony Vaio VPCEB17FX", 233 .matches = { 234 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"), 235 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB17FX"), 236 }, 237 }, 238 { 239 .callback = init_nvs_nosave, 240 .ident = "Sony Vaio VGN-SR11M", 241 .matches = { 242 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"), 243 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR11M"), 244 }, 245 }, 246 { 247 .callback = init_nvs_nosave, 248 .ident = "Everex StepNote Series", 249 .matches = { 250 DMI_MATCH(DMI_SYS_VENDOR, "Everex Systems, Inc."), 251 DMI_MATCH(DMI_PRODUCT_NAME, "Everex StepNote Series"), 252 }, 253 }, 254 { 255 .callback = init_nvs_nosave, 256 .ident = "Sony Vaio VPCEB1Z1E", 257 .matches = { 258 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"), 259 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB1Z1E"), 260 }, 261 }, 262 { 263 .callback = init_nvs_nosave, 264 .ident = "Sony Vaio VGN-NW130D", 265 .matches = { 266 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"), 267 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-NW130D"), 268 }, 269 }, 270 { 271 .callback = init_nvs_nosave, 272 .ident = "Sony Vaio VPCCW29FX", 273 .matches = { 274 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"), 275 DMI_MATCH(DMI_PRODUCT_NAME, "VPCCW29FX"), 276 }, 277 }, 278 { 279 .callback = init_nvs_nosave, 280 .ident = "Averatec AV1020-ED2", 281 .matches = { 282 DMI_MATCH(DMI_SYS_VENDOR, "AVERATEC"), 283 DMI_MATCH(DMI_PRODUCT_NAME, "1000 Series"), 284 }, 285 }, 286 { 287 .callback = init_old_suspend_ordering, 288 .ident = "Asus A8N-SLI DELUXE", 289 .matches = { 290 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."), 291 DMI_MATCH(DMI_BOARD_NAME, "A8N-SLI DELUXE"), 292 }, 293 }, 294 { 295 .callback = init_old_suspend_ordering, 296 .ident = "Asus A8N-SLI Premium", 297 .matches = { 298 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."), 299 DMI_MATCH(DMI_BOARD_NAME, "A8N-SLI Premium"), 300 }, 301 }, 302 { 303 .callback = init_nvs_nosave, 304 .ident = "Sony Vaio VGN-SR26GN_P", 305 .matches = { 306 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"), 307 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR26GN_P"), 308 }, 309 }, 310 { 311 .callback = init_nvs_nosave, 312 .ident = "Sony Vaio VPCEB1S1E", 313 .matches = { 314 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"), 315 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB1S1E"), 316 }, 317 }, 318 { 319 .callback = init_nvs_nosave, 320 .ident = "Sony Vaio VGN-FW520F", 321 .matches = { 322 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"), 323 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW520F"), 324 }, 325 }, 326 { 327 .callback = init_nvs_nosave, 328 .ident = "Asus K54C", 329 .matches = { 330 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."), 331 DMI_MATCH(DMI_PRODUCT_NAME, "K54C"), 332 }, 333 }, 334 { 335 .callback = init_nvs_nosave, 336 .ident = "Asus K54HR", 337 .matches = { 338 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."), 339 DMI_MATCH(DMI_PRODUCT_NAME, "K54HR"), 340 }, 341 }, 342 { 343 .callback = init_nvs_save_s3, 344 .ident = "Asus 1025C", 345 .matches = { 346 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."), 347 DMI_MATCH(DMI_PRODUCT_NAME, "1025C"), 348 }, 349 }, 350 /* 351 * https://bugzilla.kernel.org/show_bug.cgi?id=189431 352 * Lenovo G50-45 is a platform later than 2012, but needs nvs memory 353 * saving during S3. 354 */ 355 { 356 .callback = init_nvs_save_s3, 357 .ident = "Lenovo G50-45", 358 .matches = { 359 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"), 360 DMI_MATCH(DMI_PRODUCT_NAME, "80E3"), 361 }, 362 }, 363 /* 364 * ThinkPad X1 Tablet(2016) cannot do suspend-to-idle using 365 * the Low Power S0 Idle firmware interface (see 366 * https://bugzilla.kernel.org/show_bug.cgi?id=199057). 367 */ 368 { 369 .callback = init_default_s3, 370 .ident = "ThinkPad X1 Tablet(2016)", 371 .matches = { 372 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"), 373 DMI_MATCH(DMI_PRODUCT_NAME, "20GGA00L00"), 374 }, 375 }, 376 {}, 377 }; 378 379 static bool ignore_blacklist; 380 381 void __init acpi_sleep_no_blacklist(void) 382 { 383 ignore_blacklist = true; 384 } 385 386 static void __init acpi_sleep_dmi_check(void) 387 { 388 if (ignore_blacklist) 389 return; 390 391 if (dmi_get_bios_year() >= 2012) 392 acpi_nvs_nosave_s3(); 393 394 dmi_check_system(acpisleep_dmi_table); 395 } 396 397 /** 398 * acpi_pm_freeze - Disable the GPEs and suspend EC transactions. 399 */ 400 static int acpi_pm_freeze(void) 401 { 402 acpi_disable_all_gpes(); 403 acpi_os_wait_events_complete(); 404 acpi_ec_block_transactions(); 405 return 0; 406 } 407 408 /** 409 * acpi_pm_pre_suspend - Enable wakeup devices, "freeze" EC and save NVS. 410 */ 411 static int acpi_pm_pre_suspend(void) 412 { 413 acpi_pm_freeze(); 414 return suspend_nvs_save(); 415 } 416 417 /** 418 * __acpi_pm_prepare - Prepare the platform to enter the target state. 419 * 420 * If necessary, set the firmware waking vector and do arch-specific 421 * nastiness to get the wakeup code to the waking vector. 422 */ 423 static int __acpi_pm_prepare(void) 424 { 425 int error = acpi_sleep_prepare(acpi_target_sleep_state); 426 if (error) 427 acpi_target_sleep_state = ACPI_STATE_S0; 428 429 return error; 430 } 431 432 /** 433 * acpi_pm_prepare - Prepare the platform to enter the target sleep 434 * state and disable the GPEs. 435 */ 436 static int acpi_pm_prepare(void) 437 { 438 int error = __acpi_pm_prepare(); 439 if (!error) 440 error = acpi_pm_pre_suspend(); 441 442 return error; 443 } 444 445 /** 446 * acpi_pm_finish - Instruct the platform to leave a sleep state. 447 * 448 * This is called after we wake back up (or if entering the sleep state 449 * failed). 450 */ 451 static void acpi_pm_finish(void) 452 { 453 struct acpi_device *pwr_btn_adev; 454 u32 acpi_state = acpi_target_sleep_state; 455 456 acpi_ec_unblock_transactions(); 457 suspend_nvs_free(); 458 459 if (acpi_state == ACPI_STATE_S0) 460 return; 461 462 pr_info("Waking up from system sleep state S%d\n", acpi_state); 463 acpi_disable_wakeup_devices(acpi_state); 464 acpi_leave_sleep_state(acpi_state); 465 466 /* reset firmware waking vector */ 467 acpi_set_waking_vector(0); 468 469 acpi_target_sleep_state = ACPI_STATE_S0; 470 471 acpi_resume_power_resources(); 472 473 /* If we were woken with the fixed power button, provide a small 474 * hint to userspace in the form of a wakeup event on the fixed power 475 * button device (if it can be found). 476 * 477 * We delay the event generation til now, as the PM layer requires 478 * timekeeping to be running before we generate events. */ 479 if (!pwr_btn_event_pending) 480 return; 481 482 pwr_btn_event_pending = false; 483 pwr_btn_adev = acpi_dev_get_first_match_dev(ACPI_BUTTON_HID_POWERF, 484 NULL, -1); 485 if (pwr_btn_adev) { 486 pm_wakeup_event(&pwr_btn_adev->dev, 0); 487 acpi_dev_put(pwr_btn_adev); 488 } 489 } 490 491 /** 492 * acpi_pm_start - Start system PM transition. 493 */ 494 static void acpi_pm_start(u32 acpi_state) 495 { 496 acpi_target_sleep_state = acpi_state; 497 acpi_sleep_tts_switch(acpi_target_sleep_state); 498 acpi_scan_lock_acquire(); 499 } 500 501 /** 502 * acpi_pm_end - Finish up system PM transition. 503 */ 504 static void acpi_pm_end(void) 505 { 506 acpi_turn_off_unused_power_resources(); 507 acpi_scan_lock_release(); 508 /* 509 * This is necessary in case acpi_pm_finish() is not called during a 510 * failing transition to a sleep state. 511 */ 512 acpi_target_sleep_state = ACPI_STATE_S0; 513 acpi_sleep_tts_switch(acpi_target_sleep_state); 514 } 515 #else /* !CONFIG_ACPI_SLEEP */ 516 #define sleep_no_lps0 (1) 517 #define acpi_target_sleep_state ACPI_STATE_S0 518 #define acpi_sleep_default_s3 (1) 519 static inline void acpi_sleep_dmi_check(void) {} 520 #endif /* CONFIG_ACPI_SLEEP */ 521 522 #ifdef CONFIG_SUSPEND 523 static u32 acpi_suspend_states[] = { 524 [PM_SUSPEND_ON] = ACPI_STATE_S0, 525 [PM_SUSPEND_STANDBY] = ACPI_STATE_S1, 526 [PM_SUSPEND_MEM] = ACPI_STATE_S3, 527 [PM_SUSPEND_MAX] = ACPI_STATE_S5 528 }; 529 530 /** 531 * acpi_suspend_begin - Set the target system sleep state to the state 532 * associated with given @pm_state, if supported. 533 */ 534 static int acpi_suspend_begin(suspend_state_t pm_state) 535 { 536 u32 acpi_state = acpi_suspend_states[pm_state]; 537 int error; 538 539 error = (nvs_nosave || nvs_nosave_s3) ? 0 : suspend_nvs_alloc(); 540 if (error) 541 return error; 542 543 if (!sleep_states[acpi_state]) { 544 pr_err("ACPI does not support sleep state S%u\n", acpi_state); 545 return -ENOSYS; 546 } 547 if (acpi_state > ACPI_STATE_S1) 548 pm_set_suspend_via_firmware(); 549 550 acpi_pm_start(acpi_state); 551 return 0; 552 } 553 554 /** 555 * acpi_suspend_enter - Actually enter a sleep state. 556 * @pm_state: ignored 557 * 558 * Flush caches and go to sleep. For STR we have to call arch-specific 559 * assembly, which in turn call acpi_enter_sleep_state(). 560 * It's unfortunate, but it works. Please fix if you're feeling frisky. 561 */ 562 static int acpi_suspend_enter(suspend_state_t pm_state) 563 { 564 acpi_status status = AE_OK; 565 u32 acpi_state = acpi_target_sleep_state; 566 int error; 567 568 trace_suspend_resume(TPS("acpi_suspend"), acpi_state, true); 569 switch (acpi_state) { 570 case ACPI_STATE_S1: 571 barrier(); 572 status = acpi_enter_sleep_state(acpi_state); 573 break; 574 575 case ACPI_STATE_S3: 576 if (!acpi_suspend_lowlevel) 577 return -ENOSYS; 578 error = acpi_suspend_lowlevel(); 579 if (error) 580 return error; 581 pr_info("Low-level resume complete\n"); 582 pm_set_resume_via_firmware(); 583 break; 584 } 585 trace_suspend_resume(TPS("acpi_suspend"), acpi_state, false); 586 587 /* This violates the spec but is required for bug compatibility. */ 588 acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE, 1); 589 590 /* Reprogram control registers */ 591 acpi_leave_sleep_state_prep(acpi_state); 592 593 /* ACPI 3.0 specs (P62) says that it's the responsibility 594 * of the OSPM to clear the status bit [ implying that the 595 * POWER_BUTTON event should not reach userspace ] 596 * 597 * However, we do generate a small hint for userspace in the form of 598 * a wakeup event. We flag this condition for now and generate the 599 * event later, as we're currently too early in resume to be able to 600 * generate wakeup events. 601 */ 602 if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3)) { 603 acpi_event_status pwr_btn_status = ACPI_EVENT_FLAG_DISABLED; 604 605 acpi_get_event_status(ACPI_EVENT_POWER_BUTTON, &pwr_btn_status); 606 607 if (pwr_btn_status & ACPI_EVENT_FLAG_STATUS_SET) { 608 acpi_clear_event(ACPI_EVENT_POWER_BUTTON); 609 /* Flag for later */ 610 pwr_btn_event_pending = true; 611 } 612 } 613 614 /* 615 * Disable and clear GPE status before interrupt is enabled. Some GPEs 616 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire. 617 * acpi_leave_sleep_state will reenable specific GPEs later 618 */ 619 acpi_disable_all_gpes(); 620 /* Allow EC transactions to happen. */ 621 acpi_ec_unblock_transactions(); 622 623 suspend_nvs_restore(); 624 625 return ACPI_SUCCESS(status) ? 0 : -EFAULT; 626 } 627 628 static int acpi_suspend_state_valid(suspend_state_t pm_state) 629 { 630 u32 acpi_state; 631 632 switch (pm_state) { 633 case PM_SUSPEND_ON: 634 case PM_SUSPEND_STANDBY: 635 case PM_SUSPEND_MEM: 636 acpi_state = acpi_suspend_states[pm_state]; 637 638 return sleep_states[acpi_state]; 639 default: 640 return 0; 641 } 642 } 643 644 static const struct platform_suspend_ops acpi_suspend_ops = { 645 .valid = acpi_suspend_state_valid, 646 .begin = acpi_suspend_begin, 647 .prepare_late = acpi_pm_prepare, 648 .enter = acpi_suspend_enter, 649 .wake = acpi_pm_finish, 650 .end = acpi_pm_end, 651 }; 652 653 /** 654 * acpi_suspend_begin_old - Set the target system sleep state to the 655 * state associated with given @pm_state, if supported, and 656 * execute the _PTS control method. This function is used if the 657 * pre-ACPI 2.0 suspend ordering has been requested. 658 */ 659 static int acpi_suspend_begin_old(suspend_state_t pm_state) 660 { 661 int error = acpi_suspend_begin(pm_state); 662 if (!error) 663 error = __acpi_pm_prepare(); 664 665 return error; 666 } 667 668 /* 669 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has 670 * been requested. 671 */ 672 static const struct platform_suspend_ops acpi_suspend_ops_old = { 673 .valid = acpi_suspend_state_valid, 674 .begin = acpi_suspend_begin_old, 675 .prepare_late = acpi_pm_pre_suspend, 676 .enter = acpi_suspend_enter, 677 .wake = acpi_pm_finish, 678 .end = acpi_pm_end, 679 .recover = acpi_pm_finish, 680 }; 681 682 static bool s2idle_wakeup; 683 684 int acpi_s2idle_begin(void) 685 { 686 acpi_scan_lock_acquire(); 687 return 0; 688 } 689 690 int acpi_s2idle_prepare(void) 691 { 692 if (acpi_sci_irq_valid()) { 693 enable_irq_wake(acpi_sci_irq); 694 acpi_ec_set_gpe_wake_mask(ACPI_GPE_ENABLE); 695 } 696 697 acpi_enable_wakeup_devices(ACPI_STATE_S0); 698 699 /* Change the configuration of GPEs to avoid spurious wakeup. */ 700 acpi_enable_all_wakeup_gpes(); 701 acpi_os_wait_events_complete(); 702 703 s2idle_wakeup = true; 704 return 0; 705 } 706 707 bool acpi_s2idle_wake(void) 708 { 709 if (!acpi_sci_irq_valid()) 710 return pm_wakeup_pending(); 711 712 while (pm_wakeup_pending()) { 713 /* 714 * If IRQD_WAKEUP_ARMED is set for the SCI at this point, the 715 * SCI has not triggered while suspended, so bail out (the 716 * wakeup is pending anyway and the SCI is not the source of 717 * it). 718 */ 719 if (irqd_is_wakeup_armed(irq_get_irq_data(acpi_sci_irq))) { 720 pm_pr_dbg("Wakeup unrelated to ACPI SCI\n"); 721 return true; 722 } 723 724 /* 725 * If the status bit of any enabled fixed event is set, the 726 * wakeup is regarded as valid. 727 */ 728 if (acpi_any_fixed_event_status_set()) { 729 pm_pr_dbg("ACPI fixed event wakeup\n"); 730 return true; 731 } 732 733 /* Check wakeups from drivers sharing the SCI. */ 734 if (acpi_check_wakeup_handlers()) { 735 pm_pr_dbg("ACPI custom handler wakeup\n"); 736 return true; 737 } 738 739 /* 740 * Check non-EC GPE wakeups and if there are none, cancel the 741 * SCI-related wakeup and dispatch the EC GPE. 742 */ 743 if (acpi_ec_dispatch_gpe()) { 744 pm_pr_dbg("ACPI non-EC GPE wakeup\n"); 745 return true; 746 } 747 748 acpi_os_wait_events_complete(); 749 750 /* 751 * The SCI is in the "suspended" state now and it cannot produce 752 * new wakeup events till the rearming below, so if any of them 753 * are pending here, they must be resulting from the processing 754 * of EC events above or coming from somewhere else. 755 */ 756 if (pm_wakeup_pending()) { 757 pm_pr_dbg("Wakeup after ACPI Notify sync\n"); 758 return true; 759 } 760 761 pm_pr_dbg("Rearming ACPI SCI for wakeup\n"); 762 763 pm_wakeup_clear(acpi_sci_irq); 764 rearm_wake_irq(acpi_sci_irq); 765 } 766 767 return false; 768 } 769 770 void acpi_s2idle_restore(void) 771 { 772 /* 773 * Drain pending events before restoring the working-state configuration 774 * of GPEs. 775 */ 776 acpi_os_wait_events_complete(); /* synchronize GPE processing */ 777 acpi_ec_flush_work(); /* flush the EC driver's workqueues */ 778 acpi_os_wait_events_complete(); /* synchronize Notify handling */ 779 780 s2idle_wakeup = false; 781 782 acpi_enable_all_runtime_gpes(); 783 784 acpi_disable_wakeup_devices(ACPI_STATE_S0); 785 786 if (acpi_sci_irq_valid()) { 787 acpi_ec_set_gpe_wake_mask(ACPI_GPE_DISABLE); 788 disable_irq_wake(acpi_sci_irq); 789 } 790 } 791 792 void acpi_s2idle_end(void) 793 { 794 acpi_scan_lock_release(); 795 } 796 797 static const struct platform_s2idle_ops acpi_s2idle_ops = { 798 .begin = acpi_s2idle_begin, 799 .prepare = acpi_s2idle_prepare, 800 .wake = acpi_s2idle_wake, 801 .restore = acpi_s2idle_restore, 802 .end = acpi_s2idle_end, 803 }; 804 805 void __weak acpi_s2idle_setup(void) 806 { 807 s2idle_set_ops(&acpi_s2idle_ops); 808 } 809 810 static void acpi_sleep_suspend_setup(void) 811 { 812 bool suspend_ops_needed = false; 813 int i; 814 815 for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++) 816 if (acpi_sleep_state_supported(i)) { 817 sleep_states[i] = 1; 818 suspend_ops_needed = true; 819 } 820 821 if (suspend_ops_needed) 822 suspend_set_ops(old_suspend_ordering ? 823 &acpi_suspend_ops_old : &acpi_suspend_ops); 824 825 acpi_s2idle_setup(); 826 } 827 828 #else /* !CONFIG_SUSPEND */ 829 #define s2idle_wakeup (false) 830 static inline void acpi_sleep_suspend_setup(void) {} 831 #endif /* !CONFIG_SUSPEND */ 832 833 bool acpi_s2idle_wakeup(void) 834 { 835 return s2idle_wakeup; 836 } 837 838 #ifdef CONFIG_PM_SLEEP 839 static u32 saved_bm_rld; 840 841 static int acpi_save_bm_rld(void) 842 { 843 acpi_read_bit_register(ACPI_BITREG_BUS_MASTER_RLD, &saved_bm_rld); 844 return 0; 845 } 846 847 static void acpi_restore_bm_rld(void) 848 { 849 u32 resumed_bm_rld = 0; 850 851 acpi_read_bit_register(ACPI_BITREG_BUS_MASTER_RLD, &resumed_bm_rld); 852 if (resumed_bm_rld == saved_bm_rld) 853 return; 854 855 acpi_write_bit_register(ACPI_BITREG_BUS_MASTER_RLD, saved_bm_rld); 856 } 857 858 static struct syscore_ops acpi_sleep_syscore_ops = { 859 .suspend = acpi_save_bm_rld, 860 .resume = acpi_restore_bm_rld, 861 }; 862 863 static void acpi_sleep_syscore_init(void) 864 { 865 register_syscore_ops(&acpi_sleep_syscore_ops); 866 } 867 #else 868 static inline void acpi_sleep_syscore_init(void) {} 869 #endif /* CONFIG_PM_SLEEP */ 870 871 #ifdef CONFIG_HIBERNATION 872 static unsigned long s4_hardware_signature; 873 static struct acpi_table_facs *facs; 874 int acpi_check_s4_hw_signature = -1; /* Default behaviour is just to warn */ 875 876 static int acpi_hibernation_begin(pm_message_t stage) 877 { 878 if (!nvs_nosave) { 879 int error = suspend_nvs_alloc(); 880 if (error) 881 return error; 882 } 883 884 if (stage.event == PM_EVENT_HIBERNATE) 885 pm_set_suspend_via_firmware(); 886 887 acpi_pm_start(ACPI_STATE_S4); 888 return 0; 889 } 890 891 static int acpi_hibernation_enter(void) 892 { 893 acpi_status status = AE_OK; 894 895 /* This shouldn't return. If it returns, we have a problem */ 896 status = acpi_enter_sleep_state(ACPI_STATE_S4); 897 /* Reprogram control registers */ 898 acpi_leave_sleep_state_prep(ACPI_STATE_S4); 899 900 return ACPI_SUCCESS(status) ? 0 : -EFAULT; 901 } 902 903 static void acpi_hibernation_leave(void) 904 { 905 pm_set_resume_via_firmware(); 906 /* 907 * If ACPI is not enabled by the BIOS and the boot kernel, we need to 908 * enable it here. 909 */ 910 acpi_enable(); 911 /* Reprogram control registers */ 912 acpi_leave_sleep_state_prep(ACPI_STATE_S4); 913 /* Check the hardware signature */ 914 if (facs && s4_hardware_signature != facs->hardware_signature) 915 pr_crit("Hardware changed while hibernated, success doubtful!\n"); 916 /* Restore the NVS memory area */ 917 suspend_nvs_restore(); 918 /* Allow EC transactions to happen. */ 919 acpi_ec_unblock_transactions(); 920 } 921 922 static void acpi_pm_thaw(void) 923 { 924 acpi_ec_unblock_transactions(); 925 acpi_enable_all_runtime_gpes(); 926 } 927 928 static const struct platform_hibernation_ops acpi_hibernation_ops = { 929 .begin = acpi_hibernation_begin, 930 .end = acpi_pm_end, 931 .pre_snapshot = acpi_pm_prepare, 932 .finish = acpi_pm_finish, 933 .prepare = acpi_pm_prepare, 934 .enter = acpi_hibernation_enter, 935 .leave = acpi_hibernation_leave, 936 .pre_restore = acpi_pm_freeze, 937 .restore_cleanup = acpi_pm_thaw, 938 }; 939 940 /** 941 * acpi_hibernation_begin_old - Set the target system sleep state to 942 * ACPI_STATE_S4 and execute the _PTS control method. This 943 * function is used if the pre-ACPI 2.0 suspend ordering has been 944 * requested. 945 */ 946 static int acpi_hibernation_begin_old(pm_message_t stage) 947 { 948 int error; 949 /* 950 * The _TTS object should always be evaluated before the _PTS object. 951 * When the old_suspended_ordering is true, the _PTS object is 952 * evaluated in the acpi_sleep_prepare. 953 */ 954 acpi_sleep_tts_switch(ACPI_STATE_S4); 955 956 error = acpi_sleep_prepare(ACPI_STATE_S4); 957 if (error) 958 return error; 959 960 if (!nvs_nosave) { 961 error = suspend_nvs_alloc(); 962 if (error) 963 return error; 964 } 965 966 if (stage.event == PM_EVENT_HIBERNATE) 967 pm_set_suspend_via_firmware(); 968 969 acpi_target_sleep_state = ACPI_STATE_S4; 970 acpi_scan_lock_acquire(); 971 return 0; 972 } 973 974 /* 975 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has 976 * been requested. 977 */ 978 static const struct platform_hibernation_ops acpi_hibernation_ops_old = { 979 .begin = acpi_hibernation_begin_old, 980 .end = acpi_pm_end, 981 .pre_snapshot = acpi_pm_pre_suspend, 982 .prepare = acpi_pm_freeze, 983 .finish = acpi_pm_finish, 984 .enter = acpi_hibernation_enter, 985 .leave = acpi_hibernation_leave, 986 .pre_restore = acpi_pm_freeze, 987 .restore_cleanup = acpi_pm_thaw, 988 .recover = acpi_pm_finish, 989 }; 990 991 static void acpi_sleep_hibernate_setup(void) 992 { 993 if (!acpi_sleep_state_supported(ACPI_STATE_S4)) 994 return; 995 996 hibernation_set_ops(old_suspend_ordering ? 997 &acpi_hibernation_ops_old : &acpi_hibernation_ops); 998 sleep_states[ACPI_STATE_S4] = 1; 999 if (!acpi_check_s4_hw_signature) 1000 return; 1001 1002 acpi_get_table(ACPI_SIG_FACS, 1, (struct acpi_table_header **)&facs); 1003 if (facs) { 1004 /* 1005 * s4_hardware_signature is the local variable which is just 1006 * used to warn about mismatch after we're attempting to 1007 * resume (in violation of the ACPI specification.) 1008 */ 1009 s4_hardware_signature = facs->hardware_signature; 1010 1011 if (acpi_check_s4_hw_signature > 0) { 1012 /* 1013 * If we're actually obeying the ACPI specification 1014 * then the signature is written out as part of the 1015 * swsusp header, in order to allow the boot kernel 1016 * to gracefully decline to resume. 1017 */ 1018 swsusp_hardware_signature = facs->hardware_signature; 1019 } 1020 } 1021 } 1022 #else /* !CONFIG_HIBERNATION */ 1023 static inline void acpi_sleep_hibernate_setup(void) {} 1024 #endif /* !CONFIG_HIBERNATION */ 1025 1026 static void acpi_power_off_prepare(void) 1027 { 1028 /* Prepare to power off the system */ 1029 acpi_sleep_prepare(ACPI_STATE_S5); 1030 acpi_disable_all_gpes(); 1031 acpi_os_wait_events_complete(); 1032 } 1033 1034 static void acpi_power_off(void) 1035 { 1036 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */ 1037 pr_debug("%s called\n", __func__); 1038 local_irq_disable(); 1039 acpi_enter_sleep_state(ACPI_STATE_S5); 1040 } 1041 1042 int __init acpi_sleep_init(void) 1043 { 1044 char supported[ACPI_S_STATE_COUNT * 3 + 1]; 1045 char *pos = supported; 1046 int i; 1047 1048 acpi_sleep_dmi_check(); 1049 1050 sleep_states[ACPI_STATE_S0] = 1; 1051 1052 acpi_sleep_syscore_init(); 1053 acpi_sleep_suspend_setup(); 1054 acpi_sleep_hibernate_setup(); 1055 1056 if (acpi_sleep_state_supported(ACPI_STATE_S5)) { 1057 sleep_states[ACPI_STATE_S5] = 1; 1058 pm_power_off_prepare = acpi_power_off_prepare; 1059 pm_power_off = acpi_power_off; 1060 } else { 1061 acpi_no_s5 = true; 1062 } 1063 1064 supported[0] = 0; 1065 for (i = 0; i < ACPI_S_STATE_COUNT; i++) { 1066 if (sleep_states[i]) 1067 pos += sprintf(pos, " S%d", i); 1068 } 1069 pr_info("(supports%s)\n", supported); 1070 1071 /* 1072 * Register the tts_notifier to reboot notifier list so that the _TTS 1073 * object can also be evaluated when the system enters S5. 1074 */ 1075 register_reboot_notifier(&tts_notifier); 1076 return 0; 1077 } 1078