1 /* 2 * sleep.c - ACPI sleep support. 3 * 4 * Copyright (c) 2005 Alexey Starikovskiy <alexey.y.starikovskiy@intel.com> 5 * Copyright (c) 2004 David Shaohua Li <shaohua.li@intel.com> 6 * Copyright (c) 2000-2003 Patrick Mochel 7 * Copyright (c) 2003 Open Source Development Lab 8 * 9 * This file is released under the GPLv2. 10 * 11 */ 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 printk(KERN_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 /* do we have a wakeup address for S2 and S3? */ 67 if (acpi_state == ACPI_STATE_S3) { 68 if (!acpi_wakeup_address) 69 return -EFAULT; 70 acpi_set_waking_vector(acpi_wakeup_address); 71 72 } 73 ACPI_FLUSH_CPU_CACHE(); 74 #endif 75 printk(KERN_INFO PREFIX "Preparing to enter system sleep state S%d\n", 76 acpi_state); 77 acpi_enable_wakeup_devices(acpi_state); 78 acpi_enter_sleep_state_prep(acpi_state); 79 return 0; 80 } 81 82 static bool acpi_sleep_state_supported(u8 sleep_state) 83 { 84 acpi_status status; 85 u8 type_a, type_b; 86 87 status = acpi_get_sleep_type_data(sleep_state, &type_a, &type_b); 88 return ACPI_SUCCESS(status) && (!acpi_gbl_reduced_hardware 89 || (acpi_gbl_FADT.sleep_control.address 90 && acpi_gbl_FADT.sleep_status.address)); 91 } 92 93 #ifdef CONFIG_ACPI_SLEEP 94 static u32 acpi_target_sleep_state = ACPI_STATE_S0; 95 96 u32 acpi_target_system_state(void) 97 { 98 return acpi_target_sleep_state; 99 } 100 EXPORT_SYMBOL_GPL(acpi_target_system_state); 101 102 static bool pwr_btn_event_pending; 103 104 /* 105 * The ACPI specification wants us to save NVS memory regions during hibernation 106 * and to restore them during the subsequent resume. Windows does that also for 107 * suspend to RAM. However, it is known that this mechanism does not work on 108 * all machines, so we allow the user to disable it with the help of the 109 * 'acpi_sleep=nonvs' kernel command line option. 110 */ 111 static bool nvs_nosave; 112 113 void __init acpi_nvs_nosave(void) 114 { 115 nvs_nosave = true; 116 } 117 118 /* 119 * The ACPI specification wants us to save NVS memory regions during hibernation 120 * but says nothing about saving NVS during S3. Not all versions of Windows 121 * save NVS on S3 suspend either, and it is clear that not all systems need 122 * NVS to be saved at S3 time. To improve suspend/resume time, allow the 123 * user to disable saving NVS on S3 if their system does not require it, but 124 * continue to save/restore NVS for S4 as specified. 125 */ 126 static bool nvs_nosave_s3; 127 128 void __init acpi_nvs_nosave_s3(void) 129 { 130 nvs_nosave_s3 = true; 131 } 132 133 static int __init init_nvs_save_s3(const struct dmi_system_id *d) 134 { 135 nvs_nosave_s3 = false; 136 return 0; 137 } 138 139 /* 140 * ACPI 1.0 wants us to execute _PTS before suspending devices, so we allow the 141 * user to request that behavior by using the 'acpi_old_suspend_ordering' 142 * kernel command line option that causes the following variable to be set. 143 */ 144 static bool old_suspend_ordering; 145 146 void __init acpi_old_suspend_ordering(void) 147 { 148 old_suspend_ordering = true; 149 } 150 151 static int __init init_old_suspend_ordering(const struct dmi_system_id *d) 152 { 153 acpi_old_suspend_ordering(); 154 return 0; 155 } 156 157 static int __init init_nvs_nosave(const struct dmi_system_id *d) 158 { 159 acpi_nvs_nosave(); 160 return 0; 161 } 162 163 static bool acpi_sleep_no_lps0; 164 165 static int __init init_no_lps0(const struct dmi_system_id *d) 166 { 167 acpi_sleep_no_lps0 = true; 168 return 0; 169 } 170 171 static const struct dmi_system_id acpisleep_dmi_table[] __initconst = { 172 { 173 .callback = init_old_suspend_ordering, 174 .ident = "Abit KN9 (nForce4 variant)", 175 .matches = { 176 DMI_MATCH(DMI_BOARD_VENDOR, "http://www.abit.com.tw/"), 177 DMI_MATCH(DMI_BOARD_NAME, "KN9 Series(NF-CK804)"), 178 }, 179 }, 180 { 181 .callback = init_old_suspend_ordering, 182 .ident = "HP xw4600 Workstation", 183 .matches = { 184 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"), 185 DMI_MATCH(DMI_PRODUCT_NAME, "HP xw4600 Workstation"), 186 }, 187 }, 188 { 189 .callback = init_old_suspend_ordering, 190 .ident = "Asus Pundit P1-AH2 (M2N8L motherboard)", 191 .matches = { 192 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTek Computer INC."), 193 DMI_MATCH(DMI_BOARD_NAME, "M2N8L"), 194 }, 195 }, 196 { 197 .callback = init_old_suspend_ordering, 198 .ident = "Panasonic CF51-2L", 199 .matches = { 200 DMI_MATCH(DMI_BOARD_VENDOR, 201 "Matsushita Electric Industrial Co.,Ltd."), 202 DMI_MATCH(DMI_BOARD_NAME, "CF51-2L"), 203 }, 204 }, 205 { 206 .callback = init_nvs_nosave, 207 .ident = "Sony Vaio VGN-FW41E_H", 208 .matches = { 209 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"), 210 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW41E_H"), 211 }, 212 }, 213 { 214 .callback = init_nvs_nosave, 215 .ident = "Sony Vaio VGN-FW21E", 216 .matches = { 217 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"), 218 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW21E"), 219 }, 220 }, 221 { 222 .callback = init_nvs_nosave, 223 .ident = "Sony Vaio VGN-FW21M", 224 .matches = { 225 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"), 226 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW21M"), 227 }, 228 }, 229 { 230 .callback = init_nvs_nosave, 231 .ident = "Sony Vaio VPCEB17FX", 232 .matches = { 233 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"), 234 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB17FX"), 235 }, 236 }, 237 { 238 .callback = init_nvs_nosave, 239 .ident = "Sony Vaio VGN-SR11M", 240 .matches = { 241 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"), 242 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR11M"), 243 }, 244 }, 245 { 246 .callback = init_nvs_nosave, 247 .ident = "Everex StepNote Series", 248 .matches = { 249 DMI_MATCH(DMI_SYS_VENDOR, "Everex Systems, Inc."), 250 DMI_MATCH(DMI_PRODUCT_NAME, "Everex StepNote Series"), 251 }, 252 }, 253 { 254 .callback = init_nvs_nosave, 255 .ident = "Sony Vaio VPCEB1Z1E", 256 .matches = { 257 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"), 258 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB1Z1E"), 259 }, 260 }, 261 { 262 .callback = init_nvs_nosave, 263 .ident = "Sony Vaio VGN-NW130D", 264 .matches = { 265 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"), 266 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-NW130D"), 267 }, 268 }, 269 { 270 .callback = init_nvs_nosave, 271 .ident = "Sony Vaio VPCCW29FX", 272 .matches = { 273 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"), 274 DMI_MATCH(DMI_PRODUCT_NAME, "VPCCW29FX"), 275 }, 276 }, 277 { 278 .callback = init_nvs_nosave, 279 .ident = "Averatec AV1020-ED2", 280 .matches = { 281 DMI_MATCH(DMI_SYS_VENDOR, "AVERATEC"), 282 DMI_MATCH(DMI_PRODUCT_NAME, "1000 Series"), 283 }, 284 }, 285 { 286 .callback = init_old_suspend_ordering, 287 .ident = "Asus A8N-SLI DELUXE", 288 .matches = { 289 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."), 290 DMI_MATCH(DMI_BOARD_NAME, "A8N-SLI DELUXE"), 291 }, 292 }, 293 { 294 .callback = init_old_suspend_ordering, 295 .ident = "Asus A8N-SLI Premium", 296 .matches = { 297 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."), 298 DMI_MATCH(DMI_BOARD_NAME, "A8N-SLI Premium"), 299 }, 300 }, 301 { 302 .callback = init_nvs_nosave, 303 .ident = "Sony Vaio VGN-SR26GN_P", 304 .matches = { 305 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"), 306 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR26GN_P"), 307 }, 308 }, 309 { 310 .callback = init_nvs_nosave, 311 .ident = "Sony Vaio VPCEB1S1E", 312 .matches = { 313 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"), 314 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB1S1E"), 315 }, 316 }, 317 { 318 .callback = init_nvs_nosave, 319 .ident = "Sony Vaio VGN-FW520F", 320 .matches = { 321 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"), 322 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW520F"), 323 }, 324 }, 325 { 326 .callback = init_nvs_nosave, 327 .ident = "Asus K54C", 328 .matches = { 329 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."), 330 DMI_MATCH(DMI_PRODUCT_NAME, "K54C"), 331 }, 332 }, 333 { 334 .callback = init_nvs_nosave, 335 .ident = "Asus K54HR", 336 .matches = { 337 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."), 338 DMI_MATCH(DMI_PRODUCT_NAME, "K54HR"), 339 }, 340 }, 341 /* 342 * https://bugzilla.kernel.org/show_bug.cgi?id=189431 343 * Lenovo G50-45 is a platform later than 2012, but needs nvs memory 344 * saving during S3. 345 */ 346 { 347 .callback = init_nvs_save_s3, 348 .ident = "Lenovo G50-45", 349 .matches = { 350 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"), 351 DMI_MATCH(DMI_PRODUCT_NAME, "80E3"), 352 }, 353 }, 354 /* 355 * https://bugzilla.kernel.org/show_bug.cgi?id=196907 356 * Some Dell XPS13 9360 cannot do suspend-to-idle using the Low Power 357 * S0 Idle firmware interface. 358 */ 359 { 360 .callback = init_no_lps0, 361 .ident = "Dell XPS13 9360", 362 .matches = { 363 DMI_MATCH(DMI_SYS_VENDOR, "Dell Inc."), 364 DMI_MATCH(DMI_PRODUCT_NAME, "XPS 13 9360"), 365 }, 366 }, 367 /* 368 * ThinkPad X1 Tablet(2016) cannot do suspend-to-idle using 369 * the Low Power S0 Idle firmware interface (see 370 * https://bugzilla.kernel.org/show_bug.cgi?id=199057). 371 */ 372 { 373 .callback = init_no_lps0, 374 .ident = "ThinkPad X1 Tablet(2016)", 375 .matches = { 376 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"), 377 DMI_MATCH(DMI_PRODUCT_NAME, "20GGA00L00"), 378 }, 379 }, 380 {}, 381 }; 382 383 static bool ignore_blacklist; 384 385 void __init acpi_sleep_no_blacklist(void) 386 { 387 ignore_blacklist = true; 388 } 389 390 static void __init acpi_sleep_dmi_check(void) 391 { 392 if (ignore_blacklist) 393 return; 394 395 if (dmi_get_bios_year() >= 2012) 396 acpi_nvs_nosave_s3(); 397 398 dmi_check_system(acpisleep_dmi_table); 399 } 400 401 /** 402 * acpi_pm_freeze - Disable the GPEs and suspend EC transactions. 403 */ 404 static int acpi_pm_freeze(void) 405 { 406 acpi_disable_all_gpes(); 407 acpi_os_wait_events_complete(); 408 acpi_ec_block_transactions(); 409 return 0; 410 } 411 412 /** 413 * acpi_pre_suspend - Enable wakeup devices, "freeze" EC and save NVS. 414 */ 415 static int acpi_pm_pre_suspend(void) 416 { 417 acpi_pm_freeze(); 418 return suspend_nvs_save(); 419 } 420 421 /** 422 * __acpi_pm_prepare - Prepare the platform to enter the target state. 423 * 424 * If necessary, set the firmware waking vector and do arch-specific 425 * nastiness to get the wakeup code to the waking vector. 426 */ 427 static int __acpi_pm_prepare(void) 428 { 429 int error = acpi_sleep_prepare(acpi_target_sleep_state); 430 if (error) 431 acpi_target_sleep_state = ACPI_STATE_S0; 432 433 return error; 434 } 435 436 /** 437 * acpi_pm_prepare - Prepare the platform to enter the target sleep 438 * state and disable the GPEs. 439 */ 440 static int acpi_pm_prepare(void) 441 { 442 int error = __acpi_pm_prepare(); 443 if (!error) 444 error = acpi_pm_pre_suspend(); 445 446 return error; 447 } 448 449 static int find_powerf_dev(struct device *dev, void *data) 450 { 451 struct acpi_device *device = to_acpi_device(dev); 452 const char *hid = acpi_device_hid(device); 453 454 return !strcmp(hid, ACPI_BUTTON_HID_POWERF); 455 } 456 457 /** 458 * acpi_pm_finish - Instruct the platform to leave a sleep state. 459 * 460 * This is called after we wake back up (or if entering the sleep state 461 * failed). 462 */ 463 static void acpi_pm_finish(void) 464 { 465 struct device *pwr_btn_dev; 466 u32 acpi_state = acpi_target_sleep_state; 467 468 acpi_ec_unblock_transactions(); 469 suspend_nvs_free(); 470 471 if (acpi_state == ACPI_STATE_S0) 472 return; 473 474 printk(KERN_INFO PREFIX "Waking up from system sleep state S%d\n", 475 acpi_state); 476 acpi_disable_wakeup_devices(acpi_state); 477 acpi_leave_sleep_state(acpi_state); 478 479 /* reset firmware waking vector */ 480 acpi_set_waking_vector(0); 481 482 acpi_target_sleep_state = ACPI_STATE_S0; 483 484 acpi_resume_power_resources(); 485 486 /* If we were woken with the fixed power button, provide a small 487 * hint to userspace in the form of a wakeup event on the fixed power 488 * button device (if it can be found). 489 * 490 * We delay the event generation til now, as the PM layer requires 491 * timekeeping to be running before we generate events. */ 492 if (!pwr_btn_event_pending) 493 return; 494 495 pwr_btn_event_pending = false; 496 pwr_btn_dev = bus_find_device(&acpi_bus_type, NULL, NULL, 497 find_powerf_dev); 498 if (pwr_btn_dev) { 499 pm_wakeup_event(pwr_btn_dev, 0); 500 put_device(pwr_btn_dev); 501 } 502 } 503 504 /** 505 * acpi_pm_start - Start system PM transition. 506 */ 507 static void acpi_pm_start(u32 acpi_state) 508 { 509 acpi_target_sleep_state = acpi_state; 510 acpi_sleep_tts_switch(acpi_target_sleep_state); 511 acpi_scan_lock_acquire(); 512 } 513 514 /** 515 * acpi_pm_end - Finish up system PM transition. 516 */ 517 static void acpi_pm_end(void) 518 { 519 acpi_turn_off_unused_power_resources(); 520 acpi_scan_lock_release(); 521 /* 522 * This is necessary in case acpi_pm_finish() is not called during a 523 * failing transition to a sleep state. 524 */ 525 acpi_target_sleep_state = ACPI_STATE_S0; 526 acpi_sleep_tts_switch(acpi_target_sleep_state); 527 } 528 #else /* !CONFIG_ACPI_SLEEP */ 529 #define acpi_target_sleep_state ACPI_STATE_S0 530 #define acpi_sleep_no_lps0 (false) 531 static inline void acpi_sleep_dmi_check(void) {} 532 #endif /* CONFIG_ACPI_SLEEP */ 533 534 #ifdef CONFIG_SUSPEND 535 static u32 acpi_suspend_states[] = { 536 [PM_SUSPEND_ON] = ACPI_STATE_S0, 537 [PM_SUSPEND_STANDBY] = ACPI_STATE_S1, 538 [PM_SUSPEND_MEM] = ACPI_STATE_S3, 539 [PM_SUSPEND_MAX] = ACPI_STATE_S5 540 }; 541 542 /** 543 * acpi_suspend_begin - Set the target system sleep state to the state 544 * associated with given @pm_state, if supported. 545 */ 546 static int acpi_suspend_begin(suspend_state_t pm_state) 547 { 548 u32 acpi_state = acpi_suspend_states[pm_state]; 549 int error; 550 551 error = (nvs_nosave || nvs_nosave_s3) ? 0 : suspend_nvs_alloc(); 552 if (error) 553 return error; 554 555 if (!sleep_states[acpi_state]) { 556 pr_err("ACPI does not support sleep state S%u\n", acpi_state); 557 return -ENOSYS; 558 } 559 if (acpi_state > ACPI_STATE_S1) 560 pm_set_suspend_via_firmware(); 561 562 acpi_pm_start(acpi_state); 563 return 0; 564 } 565 566 /** 567 * acpi_suspend_enter - Actually enter a sleep state. 568 * @pm_state: ignored 569 * 570 * Flush caches and go to sleep. For STR we have to call arch-specific 571 * assembly, which in turn call acpi_enter_sleep_state(). 572 * It's unfortunate, but it works. Please fix if you're feeling frisky. 573 */ 574 static int acpi_suspend_enter(suspend_state_t pm_state) 575 { 576 acpi_status status = AE_OK; 577 u32 acpi_state = acpi_target_sleep_state; 578 int error; 579 580 ACPI_FLUSH_CPU_CACHE(); 581 582 trace_suspend_resume(TPS("acpi_suspend"), acpi_state, true); 583 switch (acpi_state) { 584 case ACPI_STATE_S1: 585 barrier(); 586 status = acpi_enter_sleep_state(acpi_state); 587 break; 588 589 case ACPI_STATE_S3: 590 if (!acpi_suspend_lowlevel) 591 return -ENOSYS; 592 error = acpi_suspend_lowlevel(); 593 if (error) 594 return error; 595 pr_info(PREFIX "Low-level resume complete\n"); 596 pm_set_resume_via_firmware(); 597 break; 598 } 599 trace_suspend_resume(TPS("acpi_suspend"), acpi_state, false); 600 601 /* This violates the spec but is required for bug compatibility. */ 602 acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE, 1); 603 604 /* Reprogram control registers */ 605 acpi_leave_sleep_state_prep(acpi_state); 606 607 /* ACPI 3.0 specs (P62) says that it's the responsibility 608 * of the OSPM to clear the status bit [ implying that the 609 * POWER_BUTTON event should not reach userspace ] 610 * 611 * However, we do generate a small hint for userspace in the form of 612 * a wakeup event. We flag this condition for now and generate the 613 * event later, as we're currently too early in resume to be able to 614 * generate wakeup events. 615 */ 616 if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3)) { 617 acpi_event_status pwr_btn_status = ACPI_EVENT_FLAG_DISABLED; 618 619 acpi_get_event_status(ACPI_EVENT_POWER_BUTTON, &pwr_btn_status); 620 621 if (pwr_btn_status & ACPI_EVENT_FLAG_STATUS_SET) { 622 acpi_clear_event(ACPI_EVENT_POWER_BUTTON); 623 /* Flag for later */ 624 pwr_btn_event_pending = true; 625 } 626 } 627 628 /* 629 * Disable and clear GPE status before interrupt is enabled. Some GPEs 630 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire. 631 * acpi_leave_sleep_state will reenable specific GPEs later 632 */ 633 acpi_disable_all_gpes(); 634 /* Allow EC transactions to happen. */ 635 acpi_ec_unblock_transactions(); 636 637 suspend_nvs_restore(); 638 639 return ACPI_SUCCESS(status) ? 0 : -EFAULT; 640 } 641 642 static int acpi_suspend_state_valid(suspend_state_t pm_state) 643 { 644 u32 acpi_state; 645 646 switch (pm_state) { 647 case PM_SUSPEND_ON: 648 case PM_SUSPEND_STANDBY: 649 case PM_SUSPEND_MEM: 650 acpi_state = acpi_suspend_states[pm_state]; 651 652 return sleep_states[acpi_state]; 653 default: 654 return 0; 655 } 656 } 657 658 static const struct platform_suspend_ops acpi_suspend_ops = { 659 .valid = acpi_suspend_state_valid, 660 .begin = acpi_suspend_begin, 661 .prepare_late = acpi_pm_prepare, 662 .enter = acpi_suspend_enter, 663 .wake = acpi_pm_finish, 664 .end = acpi_pm_end, 665 }; 666 667 /** 668 * acpi_suspend_begin_old - Set the target system sleep state to the 669 * state associated with given @pm_state, if supported, and 670 * execute the _PTS control method. This function is used if the 671 * pre-ACPI 2.0 suspend ordering has been requested. 672 */ 673 static int acpi_suspend_begin_old(suspend_state_t pm_state) 674 { 675 int error = acpi_suspend_begin(pm_state); 676 if (!error) 677 error = __acpi_pm_prepare(); 678 679 return error; 680 } 681 682 /* 683 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has 684 * been requested. 685 */ 686 static const struct platform_suspend_ops acpi_suspend_ops_old = { 687 .valid = acpi_suspend_state_valid, 688 .begin = acpi_suspend_begin_old, 689 .prepare_late = acpi_pm_pre_suspend, 690 .enter = acpi_suspend_enter, 691 .wake = acpi_pm_finish, 692 .end = acpi_pm_end, 693 .recover = acpi_pm_finish, 694 }; 695 696 static bool s2idle_in_progress; 697 static bool s2idle_wakeup; 698 699 /* 700 * On platforms supporting the Low Power S0 Idle interface there is an ACPI 701 * device object with the PNP0D80 compatible device ID (System Power Management 702 * Controller) and a specific _DSM method under it. That method, if present, 703 * can be used to indicate to the platform that the OS is transitioning into a 704 * low-power state in which certain types of activity are not desirable or that 705 * it is leaving such a state, which allows the platform to adjust its operation 706 * mode accordingly. 707 */ 708 static const struct acpi_device_id lps0_device_ids[] = { 709 {"PNP0D80", }, 710 {"", }, 711 }; 712 713 #define ACPI_LPS0_DSM_UUID "c4eb40a0-6cd2-11e2-bcfd-0800200c9a66" 714 715 #define ACPI_LPS0_GET_DEVICE_CONSTRAINTS 1 716 #define ACPI_LPS0_SCREEN_OFF 3 717 #define ACPI_LPS0_SCREEN_ON 4 718 #define ACPI_LPS0_ENTRY 5 719 #define ACPI_LPS0_EXIT 6 720 721 #define ACPI_LPS0_SCREEN_MASK ((1 << ACPI_LPS0_SCREEN_OFF) | (1 << ACPI_LPS0_SCREEN_ON)) 722 #define ACPI_LPS0_PLATFORM_MASK ((1 << ACPI_LPS0_ENTRY) | (1 << ACPI_LPS0_EXIT)) 723 724 static acpi_handle lps0_device_handle; 725 static guid_t lps0_dsm_guid; 726 static char lps0_dsm_func_mask; 727 728 /* Device constraint entry structure */ 729 struct lpi_device_info { 730 char *name; 731 int enabled; 732 union acpi_object *package; 733 }; 734 735 /* Constraint package structure */ 736 struct lpi_device_constraint { 737 int uid; 738 int min_dstate; 739 int function_states; 740 }; 741 742 struct lpi_constraints { 743 acpi_handle handle; 744 int min_dstate; 745 }; 746 747 static struct lpi_constraints *lpi_constraints_table; 748 static int lpi_constraints_table_size; 749 750 static void lpi_device_get_constraints(void) 751 { 752 union acpi_object *out_obj; 753 int i; 754 755 out_obj = acpi_evaluate_dsm_typed(lps0_device_handle, &lps0_dsm_guid, 756 1, ACPI_LPS0_GET_DEVICE_CONSTRAINTS, 757 NULL, ACPI_TYPE_PACKAGE); 758 759 acpi_handle_debug(lps0_device_handle, "_DSM function 1 eval %s\n", 760 out_obj ? "successful" : "failed"); 761 762 if (!out_obj) 763 return; 764 765 lpi_constraints_table = kcalloc(out_obj->package.count, 766 sizeof(*lpi_constraints_table), 767 GFP_KERNEL); 768 if (!lpi_constraints_table) 769 goto free_acpi_buffer; 770 771 acpi_handle_debug(lps0_device_handle, "LPI: constraints list begin:\n"); 772 773 for (i = 0; i < out_obj->package.count; i++) { 774 struct lpi_constraints *constraint; 775 acpi_status status; 776 union acpi_object *package = &out_obj->package.elements[i]; 777 struct lpi_device_info info = { }; 778 int package_count = 0, j; 779 780 if (!package) 781 continue; 782 783 for (j = 0; j < package->package.count; ++j) { 784 union acpi_object *element = 785 &(package->package.elements[j]); 786 787 switch (element->type) { 788 case ACPI_TYPE_INTEGER: 789 info.enabled = element->integer.value; 790 break; 791 case ACPI_TYPE_STRING: 792 info.name = element->string.pointer; 793 break; 794 case ACPI_TYPE_PACKAGE: 795 package_count = element->package.count; 796 info.package = element->package.elements; 797 break; 798 } 799 } 800 801 if (!info.enabled || !info.package || !info.name) 802 continue; 803 804 constraint = &lpi_constraints_table[lpi_constraints_table_size]; 805 806 status = acpi_get_handle(NULL, info.name, &constraint->handle); 807 if (ACPI_FAILURE(status)) 808 continue; 809 810 acpi_handle_debug(lps0_device_handle, 811 "index:%d Name:%s\n", i, info.name); 812 813 constraint->min_dstate = -1; 814 815 for (j = 0; j < package_count; ++j) { 816 union acpi_object *info_obj = &info.package[j]; 817 union acpi_object *cnstr_pkg; 818 union acpi_object *obj; 819 struct lpi_device_constraint dev_info; 820 821 switch (info_obj->type) { 822 case ACPI_TYPE_INTEGER: 823 /* version */ 824 break; 825 case ACPI_TYPE_PACKAGE: 826 if (info_obj->package.count < 2) 827 break; 828 829 cnstr_pkg = info_obj->package.elements; 830 obj = &cnstr_pkg[0]; 831 dev_info.uid = obj->integer.value; 832 obj = &cnstr_pkg[1]; 833 dev_info.min_dstate = obj->integer.value; 834 835 acpi_handle_debug(lps0_device_handle, 836 "uid:%d min_dstate:%s\n", 837 dev_info.uid, 838 acpi_power_state_string(dev_info.min_dstate)); 839 840 constraint->min_dstate = dev_info.min_dstate; 841 break; 842 } 843 } 844 845 if (constraint->min_dstate < 0) { 846 acpi_handle_debug(lps0_device_handle, 847 "Incomplete constraint defined\n"); 848 continue; 849 } 850 851 lpi_constraints_table_size++; 852 } 853 854 acpi_handle_debug(lps0_device_handle, "LPI: constraints list end\n"); 855 856 free_acpi_buffer: 857 ACPI_FREE(out_obj); 858 } 859 860 static void lpi_check_constraints(void) 861 { 862 int i; 863 864 for (i = 0; i < lpi_constraints_table_size; ++i) { 865 acpi_handle handle = lpi_constraints_table[i].handle; 866 struct acpi_device *adev; 867 868 if (!handle || acpi_bus_get_device(handle, &adev)) 869 continue; 870 871 acpi_handle_debug(handle, 872 "LPI: required min power state:%s current power state:%s\n", 873 acpi_power_state_string(lpi_constraints_table[i].min_dstate), 874 acpi_power_state_string(adev->power.state)); 875 876 if (!adev->flags.power_manageable) { 877 acpi_handle_info(handle, "LPI: Device not power manageable\n"); 878 lpi_constraints_table[i].handle = NULL; 879 continue; 880 } 881 882 if (adev->power.state < lpi_constraints_table[i].min_dstate) 883 acpi_handle_info(handle, 884 "LPI: Constraint not met; min power state:%s current power state:%s\n", 885 acpi_power_state_string(lpi_constraints_table[i].min_dstate), 886 acpi_power_state_string(adev->power.state)); 887 } 888 } 889 890 static void acpi_sleep_run_lps0_dsm(unsigned int func) 891 { 892 union acpi_object *out_obj; 893 894 if (!(lps0_dsm_func_mask & (1 << func))) 895 return; 896 897 out_obj = acpi_evaluate_dsm(lps0_device_handle, &lps0_dsm_guid, 1, func, NULL); 898 ACPI_FREE(out_obj); 899 900 acpi_handle_debug(lps0_device_handle, "_DSM function %u evaluation %s\n", 901 func, out_obj ? "successful" : "failed"); 902 } 903 904 static int lps0_device_attach(struct acpi_device *adev, 905 const struct acpi_device_id *not_used) 906 { 907 union acpi_object *out_obj; 908 909 if (lps0_device_handle) 910 return 0; 911 912 if (acpi_sleep_no_lps0) { 913 acpi_handle_info(adev->handle, 914 "Low Power S0 Idle interface disabled\n"); 915 return 0; 916 } 917 918 if (!(acpi_gbl_FADT.flags & ACPI_FADT_LOW_POWER_S0)) 919 return 0; 920 921 guid_parse(ACPI_LPS0_DSM_UUID, &lps0_dsm_guid); 922 /* Check if the _DSM is present and as expected. */ 923 out_obj = acpi_evaluate_dsm(adev->handle, &lps0_dsm_guid, 1, 0, NULL); 924 if (out_obj && out_obj->type == ACPI_TYPE_BUFFER) { 925 char bitmask = *(char *)out_obj->buffer.pointer; 926 927 if ((bitmask & ACPI_LPS0_PLATFORM_MASK) == ACPI_LPS0_PLATFORM_MASK || 928 (bitmask & ACPI_LPS0_SCREEN_MASK) == ACPI_LPS0_SCREEN_MASK) { 929 lps0_dsm_func_mask = bitmask; 930 lps0_device_handle = adev->handle; 931 /* 932 * Use suspend-to-idle by default if the default 933 * suspend mode was not set from the command line. 934 */ 935 if (mem_sleep_default > PM_SUSPEND_MEM) 936 mem_sleep_current = PM_SUSPEND_TO_IDLE; 937 } 938 939 acpi_handle_debug(adev->handle, "_DSM function mask: 0x%x\n", 940 bitmask); 941 } else { 942 acpi_handle_debug(adev->handle, 943 "_DSM function 0 evaluation failed\n"); 944 } 945 ACPI_FREE(out_obj); 946 947 lpi_device_get_constraints(); 948 949 return 0; 950 } 951 952 static struct acpi_scan_handler lps0_handler = { 953 .ids = lps0_device_ids, 954 .attach = lps0_device_attach, 955 }; 956 957 static int acpi_s2idle_begin(void) 958 { 959 acpi_scan_lock_acquire(); 960 s2idle_in_progress = true; 961 return 0; 962 } 963 964 static int acpi_s2idle_prepare(void) 965 { 966 if (lps0_device_handle) { 967 acpi_sleep_run_lps0_dsm(ACPI_LPS0_SCREEN_OFF); 968 acpi_sleep_run_lps0_dsm(ACPI_LPS0_ENTRY); 969 } 970 971 if (acpi_sci_irq_valid()) 972 enable_irq_wake(acpi_sci_irq); 973 974 return 0; 975 } 976 977 static void acpi_s2idle_wake(void) 978 { 979 980 if (pm_debug_messages_on) 981 lpi_check_constraints(); 982 983 /* 984 * If IRQD_WAKEUP_ARMED is not set for the SCI at this point, it means 985 * that the SCI has triggered while suspended, so cancel the wakeup in 986 * case it has not been a wakeup event (the GPEs will be checked later). 987 */ 988 if (acpi_sci_irq_valid() && 989 !irqd_is_wakeup_armed(irq_get_irq_data(acpi_sci_irq))) { 990 pm_system_cancel_wakeup(); 991 s2idle_wakeup = true; 992 /* 993 * On some platforms with the LPS0 _DSM device noirq resume 994 * takes too much time for EC wakeup events to survive, so look 995 * for them now. 996 */ 997 if (lps0_device_handle) 998 acpi_ec_dispatch_gpe(); 999 } 1000 } 1001 1002 static void acpi_s2idle_sync(void) 1003 { 1004 /* 1005 * Process all pending events in case there are any wakeup ones. 1006 * 1007 * The EC driver uses the system workqueue and an additional special 1008 * one, so those need to be flushed too. 1009 */ 1010 acpi_os_wait_events_complete(); /* synchronize SCI IRQ handling */ 1011 acpi_ec_flush_work(); 1012 acpi_os_wait_events_complete(); /* synchronize Notify handling */ 1013 s2idle_wakeup = false; 1014 } 1015 1016 static void acpi_s2idle_restore(void) 1017 { 1018 if (acpi_sci_irq_valid()) 1019 disable_irq_wake(acpi_sci_irq); 1020 1021 if (lps0_device_handle) { 1022 acpi_sleep_run_lps0_dsm(ACPI_LPS0_EXIT); 1023 acpi_sleep_run_lps0_dsm(ACPI_LPS0_SCREEN_ON); 1024 } 1025 } 1026 1027 static void acpi_s2idle_end(void) 1028 { 1029 s2idle_in_progress = false; 1030 acpi_scan_lock_release(); 1031 } 1032 1033 static const struct platform_s2idle_ops acpi_s2idle_ops = { 1034 .begin = acpi_s2idle_begin, 1035 .prepare = acpi_s2idle_prepare, 1036 .wake = acpi_s2idle_wake, 1037 .sync = acpi_s2idle_sync, 1038 .restore = acpi_s2idle_restore, 1039 .end = acpi_s2idle_end, 1040 }; 1041 1042 static void acpi_sleep_suspend_setup(void) 1043 { 1044 int i; 1045 1046 for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++) 1047 if (acpi_sleep_state_supported(i)) 1048 sleep_states[i] = 1; 1049 1050 suspend_set_ops(old_suspend_ordering ? 1051 &acpi_suspend_ops_old : &acpi_suspend_ops); 1052 1053 acpi_scan_add_handler(&lps0_handler); 1054 s2idle_set_ops(&acpi_s2idle_ops); 1055 } 1056 1057 #else /* !CONFIG_SUSPEND */ 1058 #define s2idle_in_progress (false) 1059 #define s2idle_wakeup (false) 1060 #define lps0_device_handle (NULL) 1061 static inline void acpi_sleep_suspend_setup(void) {} 1062 #endif /* !CONFIG_SUSPEND */ 1063 1064 bool acpi_s2idle_wakeup(void) 1065 { 1066 return s2idle_wakeup; 1067 } 1068 1069 bool acpi_sleep_no_ec_events(void) 1070 { 1071 return !s2idle_in_progress || !lps0_device_handle; 1072 } 1073 1074 #ifdef CONFIG_PM_SLEEP 1075 static u32 saved_bm_rld; 1076 1077 static int acpi_save_bm_rld(void) 1078 { 1079 acpi_read_bit_register(ACPI_BITREG_BUS_MASTER_RLD, &saved_bm_rld); 1080 return 0; 1081 } 1082 1083 static void acpi_restore_bm_rld(void) 1084 { 1085 u32 resumed_bm_rld = 0; 1086 1087 acpi_read_bit_register(ACPI_BITREG_BUS_MASTER_RLD, &resumed_bm_rld); 1088 if (resumed_bm_rld == saved_bm_rld) 1089 return; 1090 1091 acpi_write_bit_register(ACPI_BITREG_BUS_MASTER_RLD, saved_bm_rld); 1092 } 1093 1094 static struct syscore_ops acpi_sleep_syscore_ops = { 1095 .suspend = acpi_save_bm_rld, 1096 .resume = acpi_restore_bm_rld, 1097 }; 1098 1099 static void acpi_sleep_syscore_init(void) 1100 { 1101 register_syscore_ops(&acpi_sleep_syscore_ops); 1102 } 1103 #else 1104 static inline void acpi_sleep_syscore_init(void) {} 1105 #endif /* CONFIG_PM_SLEEP */ 1106 1107 #ifdef CONFIG_HIBERNATION 1108 static unsigned long s4_hardware_signature; 1109 static struct acpi_table_facs *facs; 1110 static bool nosigcheck; 1111 1112 void __init acpi_no_s4_hw_signature(void) 1113 { 1114 nosigcheck = true; 1115 } 1116 1117 static int acpi_hibernation_begin(void) 1118 { 1119 int error; 1120 1121 error = nvs_nosave ? 0 : suspend_nvs_alloc(); 1122 if (!error) 1123 acpi_pm_start(ACPI_STATE_S4); 1124 1125 return error; 1126 } 1127 1128 static int acpi_hibernation_enter(void) 1129 { 1130 acpi_status status = AE_OK; 1131 1132 ACPI_FLUSH_CPU_CACHE(); 1133 1134 /* This shouldn't return. If it returns, we have a problem */ 1135 status = acpi_enter_sleep_state(ACPI_STATE_S4); 1136 /* Reprogram control registers */ 1137 acpi_leave_sleep_state_prep(ACPI_STATE_S4); 1138 1139 return ACPI_SUCCESS(status) ? 0 : -EFAULT; 1140 } 1141 1142 static void acpi_hibernation_leave(void) 1143 { 1144 pm_set_resume_via_firmware(); 1145 /* 1146 * If ACPI is not enabled by the BIOS and the boot kernel, we need to 1147 * enable it here. 1148 */ 1149 acpi_enable(); 1150 /* Reprogram control registers */ 1151 acpi_leave_sleep_state_prep(ACPI_STATE_S4); 1152 /* Check the hardware signature */ 1153 if (facs && s4_hardware_signature != facs->hardware_signature) 1154 pr_crit("ACPI: Hardware changed while hibernated, success doubtful!\n"); 1155 /* Restore the NVS memory area */ 1156 suspend_nvs_restore(); 1157 /* Allow EC transactions to happen. */ 1158 acpi_ec_unblock_transactions(); 1159 } 1160 1161 static void acpi_pm_thaw(void) 1162 { 1163 acpi_ec_unblock_transactions(); 1164 acpi_enable_all_runtime_gpes(); 1165 } 1166 1167 static const struct platform_hibernation_ops acpi_hibernation_ops = { 1168 .begin = acpi_hibernation_begin, 1169 .end = acpi_pm_end, 1170 .pre_snapshot = acpi_pm_prepare, 1171 .finish = acpi_pm_finish, 1172 .prepare = acpi_pm_prepare, 1173 .enter = acpi_hibernation_enter, 1174 .leave = acpi_hibernation_leave, 1175 .pre_restore = acpi_pm_freeze, 1176 .restore_cleanup = acpi_pm_thaw, 1177 }; 1178 1179 /** 1180 * acpi_hibernation_begin_old - Set the target system sleep state to 1181 * ACPI_STATE_S4 and execute the _PTS control method. This 1182 * function is used if the pre-ACPI 2.0 suspend ordering has been 1183 * requested. 1184 */ 1185 static int acpi_hibernation_begin_old(void) 1186 { 1187 int error; 1188 /* 1189 * The _TTS object should always be evaluated before the _PTS object. 1190 * When the old_suspended_ordering is true, the _PTS object is 1191 * evaluated in the acpi_sleep_prepare. 1192 */ 1193 acpi_sleep_tts_switch(ACPI_STATE_S4); 1194 1195 error = acpi_sleep_prepare(ACPI_STATE_S4); 1196 1197 if (!error) { 1198 if (!nvs_nosave) 1199 error = suspend_nvs_alloc(); 1200 if (!error) { 1201 acpi_target_sleep_state = ACPI_STATE_S4; 1202 acpi_scan_lock_acquire(); 1203 } 1204 } 1205 return error; 1206 } 1207 1208 /* 1209 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has 1210 * been requested. 1211 */ 1212 static const struct platform_hibernation_ops acpi_hibernation_ops_old = { 1213 .begin = acpi_hibernation_begin_old, 1214 .end = acpi_pm_end, 1215 .pre_snapshot = acpi_pm_pre_suspend, 1216 .prepare = acpi_pm_freeze, 1217 .finish = acpi_pm_finish, 1218 .enter = acpi_hibernation_enter, 1219 .leave = acpi_hibernation_leave, 1220 .pre_restore = acpi_pm_freeze, 1221 .restore_cleanup = acpi_pm_thaw, 1222 .recover = acpi_pm_finish, 1223 }; 1224 1225 static void acpi_sleep_hibernate_setup(void) 1226 { 1227 if (!acpi_sleep_state_supported(ACPI_STATE_S4)) 1228 return; 1229 1230 hibernation_set_ops(old_suspend_ordering ? 1231 &acpi_hibernation_ops_old : &acpi_hibernation_ops); 1232 sleep_states[ACPI_STATE_S4] = 1; 1233 if (nosigcheck) 1234 return; 1235 1236 acpi_get_table(ACPI_SIG_FACS, 1, (struct acpi_table_header **)&facs); 1237 if (facs) 1238 s4_hardware_signature = facs->hardware_signature; 1239 } 1240 #else /* !CONFIG_HIBERNATION */ 1241 static inline void acpi_sleep_hibernate_setup(void) {} 1242 #endif /* !CONFIG_HIBERNATION */ 1243 1244 static void acpi_power_off_prepare(void) 1245 { 1246 /* Prepare to power off the system */ 1247 acpi_sleep_prepare(ACPI_STATE_S5); 1248 acpi_disable_all_gpes(); 1249 acpi_os_wait_events_complete(); 1250 } 1251 1252 static void acpi_power_off(void) 1253 { 1254 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */ 1255 printk(KERN_DEBUG "%s called\n", __func__); 1256 local_irq_disable(); 1257 acpi_enter_sleep_state(ACPI_STATE_S5); 1258 } 1259 1260 int __init acpi_sleep_init(void) 1261 { 1262 char supported[ACPI_S_STATE_COUNT * 3 + 1]; 1263 char *pos = supported; 1264 int i; 1265 1266 acpi_sleep_dmi_check(); 1267 1268 sleep_states[ACPI_STATE_S0] = 1; 1269 1270 acpi_sleep_syscore_init(); 1271 acpi_sleep_suspend_setup(); 1272 acpi_sleep_hibernate_setup(); 1273 1274 if (acpi_sleep_state_supported(ACPI_STATE_S5)) { 1275 sleep_states[ACPI_STATE_S5] = 1; 1276 pm_power_off_prepare = acpi_power_off_prepare; 1277 pm_power_off = acpi_power_off; 1278 } else { 1279 acpi_no_s5 = true; 1280 } 1281 1282 supported[0] = 0; 1283 for (i = 0; i < ACPI_S_STATE_COUNT; i++) { 1284 if (sleep_states[i]) 1285 pos += sprintf(pos, " S%d", i); 1286 } 1287 pr_info(PREFIX "(supports%s)\n", supported); 1288 1289 /* 1290 * Register the tts_notifier to reboot notifier list so that the _TTS 1291 * object can also be evaluated when the system enters S5. 1292 */ 1293 register_reboot_notifier(&tts_notifier); 1294 return 0; 1295 } 1296