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 }; 369 370 static bool ignore_blacklist; 371 372 void __init acpi_sleep_no_blacklist(void) 373 { 374 ignore_blacklist = true; 375 } 376 377 static void __init acpi_sleep_dmi_check(void) 378 { 379 if (ignore_blacklist) 380 return; 381 382 if (dmi_get_bios_year() >= 2012) 383 acpi_nvs_nosave_s3(); 384 385 dmi_check_system(acpisleep_dmi_table); 386 } 387 388 /** 389 * acpi_pm_freeze - Disable the GPEs and suspend EC transactions. 390 */ 391 static int acpi_pm_freeze(void) 392 { 393 acpi_disable_all_gpes(); 394 acpi_os_wait_events_complete(); 395 acpi_ec_block_transactions(); 396 return 0; 397 } 398 399 /** 400 * acpi_pre_suspend - Enable wakeup devices, "freeze" EC and save NVS. 401 */ 402 static int acpi_pm_pre_suspend(void) 403 { 404 acpi_pm_freeze(); 405 return suspend_nvs_save(); 406 } 407 408 /** 409 * __acpi_pm_prepare - Prepare the platform to enter the target state. 410 * 411 * If necessary, set the firmware waking vector and do arch-specific 412 * nastiness to get the wakeup code to the waking vector. 413 */ 414 static int __acpi_pm_prepare(void) 415 { 416 int error = acpi_sleep_prepare(acpi_target_sleep_state); 417 if (error) 418 acpi_target_sleep_state = ACPI_STATE_S0; 419 420 return error; 421 } 422 423 /** 424 * acpi_pm_prepare - Prepare the platform to enter the target sleep 425 * state and disable the GPEs. 426 */ 427 static int acpi_pm_prepare(void) 428 { 429 int error = __acpi_pm_prepare(); 430 if (!error) 431 error = acpi_pm_pre_suspend(); 432 433 return error; 434 } 435 436 static int find_powerf_dev(struct device *dev, void *data) 437 { 438 struct acpi_device *device = to_acpi_device(dev); 439 const char *hid = acpi_device_hid(device); 440 441 return !strcmp(hid, ACPI_BUTTON_HID_POWERF); 442 } 443 444 /** 445 * acpi_pm_finish - Instruct the platform to leave a sleep state. 446 * 447 * This is called after we wake back up (or if entering the sleep state 448 * failed). 449 */ 450 static void acpi_pm_finish(void) 451 { 452 struct device *pwr_btn_dev; 453 u32 acpi_state = acpi_target_sleep_state; 454 455 acpi_ec_unblock_transactions(); 456 suspend_nvs_free(); 457 458 if (acpi_state == ACPI_STATE_S0) 459 return; 460 461 printk(KERN_INFO PREFIX "Waking up from system sleep state S%d\n", 462 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_dev = bus_find_device(&acpi_bus_type, NULL, NULL, 484 find_powerf_dev); 485 if (pwr_btn_dev) { 486 pm_wakeup_event(pwr_btn_dev, 0); 487 put_device(pwr_btn_dev); 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 acpi_target_sleep_state ACPI_STATE_S0 517 #define acpi_sleep_no_lps0 (false) 518 static inline void acpi_sleep_dmi_check(void) {} 519 #endif /* CONFIG_ACPI_SLEEP */ 520 521 #ifdef CONFIG_SUSPEND 522 static u32 acpi_suspend_states[] = { 523 [PM_SUSPEND_ON] = ACPI_STATE_S0, 524 [PM_SUSPEND_STANDBY] = ACPI_STATE_S1, 525 [PM_SUSPEND_MEM] = ACPI_STATE_S3, 526 [PM_SUSPEND_MAX] = ACPI_STATE_S5 527 }; 528 529 /** 530 * acpi_suspend_begin - Set the target system sleep state to the state 531 * associated with given @pm_state, if supported. 532 */ 533 static int acpi_suspend_begin(suspend_state_t pm_state) 534 { 535 u32 acpi_state = acpi_suspend_states[pm_state]; 536 int error; 537 538 error = (nvs_nosave || nvs_nosave_s3) ? 0 : suspend_nvs_alloc(); 539 if (error) 540 return error; 541 542 if (!sleep_states[acpi_state]) { 543 pr_err("ACPI does not support sleep state S%u\n", acpi_state); 544 return -ENOSYS; 545 } 546 if (acpi_state > ACPI_STATE_S1) 547 pm_set_suspend_via_firmware(); 548 549 acpi_pm_start(acpi_state); 550 return 0; 551 } 552 553 /** 554 * acpi_suspend_enter - Actually enter a sleep state. 555 * @pm_state: ignored 556 * 557 * Flush caches and go to sleep. For STR we have to call arch-specific 558 * assembly, which in turn call acpi_enter_sleep_state(). 559 * It's unfortunate, but it works. Please fix if you're feeling frisky. 560 */ 561 static int acpi_suspend_enter(suspend_state_t pm_state) 562 { 563 acpi_status status = AE_OK; 564 u32 acpi_state = acpi_target_sleep_state; 565 int error; 566 567 ACPI_FLUSH_CPU_CACHE(); 568 569 trace_suspend_resume(TPS("acpi_suspend"), acpi_state, true); 570 switch (acpi_state) { 571 case ACPI_STATE_S1: 572 barrier(); 573 status = acpi_enter_sleep_state(acpi_state); 574 break; 575 576 case ACPI_STATE_S3: 577 if (!acpi_suspend_lowlevel) 578 return -ENOSYS; 579 error = acpi_suspend_lowlevel(); 580 if (error) 581 return error; 582 pr_info(PREFIX "Low-level resume complete\n"); 583 pm_set_resume_via_firmware(); 584 break; 585 } 586 trace_suspend_resume(TPS("acpi_suspend"), acpi_state, false); 587 588 /* This violates the spec but is required for bug compatibility. */ 589 acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE, 1); 590 591 /* Reprogram control registers */ 592 acpi_leave_sleep_state_prep(acpi_state); 593 594 /* ACPI 3.0 specs (P62) says that it's the responsibility 595 * of the OSPM to clear the status bit [ implying that the 596 * POWER_BUTTON event should not reach userspace ] 597 * 598 * However, we do generate a small hint for userspace in the form of 599 * a wakeup event. We flag this condition for now and generate the 600 * event later, as we're currently too early in resume to be able to 601 * generate wakeup events. 602 */ 603 if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3)) { 604 acpi_event_status pwr_btn_status = ACPI_EVENT_FLAG_DISABLED; 605 606 acpi_get_event_status(ACPI_EVENT_POWER_BUTTON, &pwr_btn_status); 607 608 if (pwr_btn_status & ACPI_EVENT_FLAG_STATUS_SET) { 609 acpi_clear_event(ACPI_EVENT_POWER_BUTTON); 610 /* Flag for later */ 611 pwr_btn_event_pending = true; 612 } 613 } 614 615 /* 616 * Disable and clear GPE status before interrupt is enabled. Some GPEs 617 * (like wakeup GPE) haven't handler, this can avoid such GPE misfire. 618 * acpi_leave_sleep_state will reenable specific GPEs later 619 */ 620 acpi_disable_all_gpes(); 621 /* Allow EC transactions to happen. */ 622 acpi_ec_unblock_transactions(); 623 624 suspend_nvs_restore(); 625 626 return ACPI_SUCCESS(status) ? 0 : -EFAULT; 627 } 628 629 static int acpi_suspend_state_valid(suspend_state_t pm_state) 630 { 631 u32 acpi_state; 632 633 switch (pm_state) { 634 case PM_SUSPEND_ON: 635 case PM_SUSPEND_STANDBY: 636 case PM_SUSPEND_MEM: 637 acpi_state = acpi_suspend_states[pm_state]; 638 639 return sleep_states[acpi_state]; 640 default: 641 return 0; 642 } 643 } 644 645 static const struct platform_suspend_ops acpi_suspend_ops = { 646 .valid = acpi_suspend_state_valid, 647 .begin = acpi_suspend_begin, 648 .prepare_late = acpi_pm_prepare, 649 .enter = acpi_suspend_enter, 650 .wake = acpi_pm_finish, 651 .end = acpi_pm_end, 652 }; 653 654 /** 655 * acpi_suspend_begin_old - Set the target system sleep state to the 656 * state associated with given @pm_state, if supported, and 657 * execute the _PTS control method. This function is used if the 658 * pre-ACPI 2.0 suspend ordering has been requested. 659 */ 660 static int acpi_suspend_begin_old(suspend_state_t pm_state) 661 { 662 int error = acpi_suspend_begin(pm_state); 663 if (!error) 664 error = __acpi_pm_prepare(); 665 666 return error; 667 } 668 669 /* 670 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has 671 * been requested. 672 */ 673 static const struct platform_suspend_ops acpi_suspend_ops_old = { 674 .valid = acpi_suspend_state_valid, 675 .begin = acpi_suspend_begin_old, 676 .prepare_late = acpi_pm_pre_suspend, 677 .enter = acpi_suspend_enter, 678 .wake = acpi_pm_finish, 679 .end = acpi_pm_end, 680 .recover = acpi_pm_finish, 681 }; 682 683 static bool s2idle_in_progress; 684 static bool s2idle_wakeup; 685 686 /* 687 * On platforms supporting the Low Power S0 Idle interface there is an ACPI 688 * device object with the PNP0D80 compatible device ID (System Power Management 689 * Controller) and a specific _DSM method under it. That method, if present, 690 * can be used to indicate to the platform that the OS is transitioning into a 691 * low-power state in which certain types of activity are not desirable or that 692 * it is leaving such a state, which allows the platform to adjust its operation 693 * mode accordingly. 694 */ 695 static const struct acpi_device_id lps0_device_ids[] = { 696 {"PNP0D80", }, 697 {"", }, 698 }; 699 700 #define ACPI_LPS0_DSM_UUID "c4eb40a0-6cd2-11e2-bcfd-0800200c9a66" 701 702 #define ACPI_LPS0_GET_DEVICE_CONSTRAINTS 1 703 #define ACPI_LPS0_SCREEN_OFF 3 704 #define ACPI_LPS0_SCREEN_ON 4 705 #define ACPI_LPS0_ENTRY 5 706 #define ACPI_LPS0_EXIT 6 707 708 #define ACPI_LPS0_SCREEN_MASK ((1 << ACPI_LPS0_SCREEN_OFF) | (1 << ACPI_LPS0_SCREEN_ON)) 709 #define ACPI_LPS0_PLATFORM_MASK ((1 << ACPI_LPS0_ENTRY) | (1 << ACPI_LPS0_EXIT)) 710 711 static acpi_handle lps0_device_handle; 712 static guid_t lps0_dsm_guid; 713 static char lps0_dsm_func_mask; 714 715 /* Device constraint entry structure */ 716 struct lpi_device_info { 717 char *name; 718 int enabled; 719 union acpi_object *package; 720 }; 721 722 /* Constraint package structure */ 723 struct lpi_device_constraint { 724 int uid; 725 int min_dstate; 726 int function_states; 727 }; 728 729 struct lpi_constraints { 730 acpi_handle handle; 731 int min_dstate; 732 }; 733 734 static struct lpi_constraints *lpi_constraints_table; 735 static int lpi_constraints_table_size; 736 737 static void lpi_device_get_constraints(void) 738 { 739 union acpi_object *out_obj; 740 int i; 741 742 out_obj = acpi_evaluate_dsm_typed(lps0_device_handle, &lps0_dsm_guid, 743 1, ACPI_LPS0_GET_DEVICE_CONSTRAINTS, 744 NULL, ACPI_TYPE_PACKAGE); 745 746 acpi_handle_debug(lps0_device_handle, "_DSM function 1 eval %s\n", 747 out_obj ? "successful" : "failed"); 748 749 if (!out_obj) 750 return; 751 752 lpi_constraints_table = kcalloc(out_obj->package.count, 753 sizeof(*lpi_constraints_table), 754 GFP_KERNEL); 755 if (!lpi_constraints_table) 756 goto free_acpi_buffer; 757 758 acpi_handle_debug(lps0_device_handle, "LPI: constraints list begin:\n"); 759 760 for (i = 0; i < out_obj->package.count; i++) { 761 struct lpi_constraints *constraint; 762 acpi_status status; 763 union acpi_object *package = &out_obj->package.elements[i]; 764 struct lpi_device_info info = { }; 765 int package_count = 0, j; 766 767 if (!package) 768 continue; 769 770 for (j = 0; j < package->package.count; ++j) { 771 union acpi_object *element = 772 &(package->package.elements[j]); 773 774 switch (element->type) { 775 case ACPI_TYPE_INTEGER: 776 info.enabled = element->integer.value; 777 break; 778 case ACPI_TYPE_STRING: 779 info.name = element->string.pointer; 780 break; 781 case ACPI_TYPE_PACKAGE: 782 package_count = element->package.count; 783 info.package = element->package.elements; 784 break; 785 } 786 } 787 788 if (!info.enabled || !info.package || !info.name) 789 continue; 790 791 constraint = &lpi_constraints_table[lpi_constraints_table_size]; 792 793 status = acpi_get_handle(NULL, info.name, &constraint->handle); 794 if (ACPI_FAILURE(status)) 795 continue; 796 797 acpi_handle_debug(lps0_device_handle, 798 "index:%d Name:%s\n", i, info.name); 799 800 constraint->min_dstate = -1; 801 802 for (j = 0; j < package_count; ++j) { 803 union acpi_object *info_obj = &info.package[j]; 804 union acpi_object *cnstr_pkg; 805 union acpi_object *obj; 806 struct lpi_device_constraint dev_info; 807 808 switch (info_obj->type) { 809 case ACPI_TYPE_INTEGER: 810 /* version */ 811 break; 812 case ACPI_TYPE_PACKAGE: 813 if (info_obj->package.count < 2) 814 break; 815 816 cnstr_pkg = info_obj->package.elements; 817 obj = &cnstr_pkg[0]; 818 dev_info.uid = obj->integer.value; 819 obj = &cnstr_pkg[1]; 820 dev_info.min_dstate = obj->integer.value; 821 822 acpi_handle_debug(lps0_device_handle, 823 "uid:%d min_dstate:%s\n", 824 dev_info.uid, 825 acpi_power_state_string(dev_info.min_dstate)); 826 827 constraint->min_dstate = dev_info.min_dstate; 828 break; 829 } 830 } 831 832 if (constraint->min_dstate < 0) { 833 acpi_handle_debug(lps0_device_handle, 834 "Incomplete constraint defined\n"); 835 continue; 836 } 837 838 lpi_constraints_table_size++; 839 } 840 841 acpi_handle_debug(lps0_device_handle, "LPI: constraints list end\n"); 842 843 free_acpi_buffer: 844 ACPI_FREE(out_obj); 845 } 846 847 static void lpi_check_constraints(void) 848 { 849 int i; 850 851 for (i = 0; i < lpi_constraints_table_size; ++i) { 852 struct acpi_device *adev; 853 854 if (acpi_bus_get_device(lpi_constraints_table[i].handle, &adev)) 855 continue; 856 857 acpi_handle_debug(adev->handle, 858 "LPI: required min power state:%s current power state:%s\n", 859 acpi_power_state_string(lpi_constraints_table[i].min_dstate), 860 acpi_power_state_string(adev->power.state)); 861 862 if (!adev->flags.power_manageable) { 863 acpi_handle_info(adev->handle, "LPI: Device not power manageble\n"); 864 continue; 865 } 866 867 if (adev->power.state < lpi_constraints_table[i].min_dstate) 868 acpi_handle_info(adev->handle, 869 "LPI: Constraint not met; min power state:%s current power state:%s\n", 870 acpi_power_state_string(lpi_constraints_table[i].min_dstate), 871 acpi_power_state_string(adev->power.state)); 872 } 873 } 874 875 static void acpi_sleep_run_lps0_dsm(unsigned int func) 876 { 877 union acpi_object *out_obj; 878 879 if (!(lps0_dsm_func_mask & (1 << func))) 880 return; 881 882 out_obj = acpi_evaluate_dsm(lps0_device_handle, &lps0_dsm_guid, 1, func, NULL); 883 ACPI_FREE(out_obj); 884 885 acpi_handle_debug(lps0_device_handle, "_DSM function %u evaluation %s\n", 886 func, out_obj ? "successful" : "failed"); 887 } 888 889 static int lps0_device_attach(struct acpi_device *adev, 890 const struct acpi_device_id *not_used) 891 { 892 union acpi_object *out_obj; 893 894 if (lps0_device_handle) 895 return 0; 896 897 if (acpi_sleep_no_lps0) { 898 acpi_handle_info(adev->handle, 899 "Low Power S0 Idle interface disabled\n"); 900 return 0; 901 } 902 903 if (!(acpi_gbl_FADT.flags & ACPI_FADT_LOW_POWER_S0)) 904 return 0; 905 906 guid_parse(ACPI_LPS0_DSM_UUID, &lps0_dsm_guid); 907 /* Check if the _DSM is present and as expected. */ 908 out_obj = acpi_evaluate_dsm(adev->handle, &lps0_dsm_guid, 1, 0, NULL); 909 if (out_obj && out_obj->type == ACPI_TYPE_BUFFER) { 910 char bitmask = *(char *)out_obj->buffer.pointer; 911 912 if ((bitmask & ACPI_LPS0_PLATFORM_MASK) == ACPI_LPS0_PLATFORM_MASK || 913 (bitmask & ACPI_LPS0_SCREEN_MASK) == ACPI_LPS0_SCREEN_MASK) { 914 lps0_dsm_func_mask = bitmask; 915 lps0_device_handle = adev->handle; 916 /* 917 * Use suspend-to-idle by default if the default 918 * suspend mode was not set from the command line. 919 */ 920 if (mem_sleep_default > PM_SUSPEND_MEM) 921 mem_sleep_current = PM_SUSPEND_TO_IDLE; 922 } 923 924 acpi_handle_debug(adev->handle, "_DSM function mask: 0x%x\n", 925 bitmask); 926 } else { 927 acpi_handle_debug(adev->handle, 928 "_DSM function 0 evaluation failed\n"); 929 } 930 ACPI_FREE(out_obj); 931 932 lpi_device_get_constraints(); 933 934 return 0; 935 } 936 937 static struct acpi_scan_handler lps0_handler = { 938 .ids = lps0_device_ids, 939 .attach = lps0_device_attach, 940 }; 941 942 static int acpi_s2idle_begin(void) 943 { 944 acpi_scan_lock_acquire(); 945 s2idle_in_progress = true; 946 return 0; 947 } 948 949 static int acpi_s2idle_prepare(void) 950 { 951 if (lps0_device_handle) { 952 acpi_sleep_run_lps0_dsm(ACPI_LPS0_SCREEN_OFF); 953 acpi_sleep_run_lps0_dsm(ACPI_LPS0_ENTRY); 954 } else { 955 /* 956 * The configuration of GPEs is changed here to avoid spurious 957 * wakeups, but that should not be necessary if this is a 958 * "low-power S0" platform and the low-power S0 _DSM is present. 959 */ 960 acpi_enable_all_wakeup_gpes(); 961 acpi_os_wait_events_complete(); 962 } 963 if (acpi_sci_irq_valid()) 964 enable_irq_wake(acpi_sci_irq); 965 966 return 0; 967 } 968 969 static void acpi_s2idle_wake(void) 970 { 971 972 if (pm_debug_messages_on) 973 lpi_check_constraints(); 974 975 /* 976 * If IRQD_WAKEUP_ARMED is not set for the SCI at this point, it means 977 * that the SCI has triggered while suspended, so cancel the wakeup in 978 * case it has not been a wakeup event (the GPEs will be checked later). 979 */ 980 if (acpi_sci_irq_valid() && 981 !irqd_is_wakeup_armed(irq_get_irq_data(acpi_sci_irq))) { 982 pm_system_cancel_wakeup(); 983 s2idle_wakeup = true; 984 } 985 } 986 987 static void acpi_s2idle_sync(void) 988 { 989 /* 990 * Process all pending events in case there are any wakeup ones. 991 * 992 * The EC driver uses the system workqueue and an additional special 993 * one, so those need to be flushed too. 994 */ 995 acpi_ec_flush_work(); 996 acpi_os_wait_events_complete(); 997 s2idle_wakeup = false; 998 } 999 1000 static void acpi_s2idle_restore(void) 1001 { 1002 if (acpi_sci_irq_valid()) 1003 disable_irq_wake(acpi_sci_irq); 1004 1005 if (lps0_device_handle) { 1006 acpi_sleep_run_lps0_dsm(ACPI_LPS0_EXIT); 1007 acpi_sleep_run_lps0_dsm(ACPI_LPS0_SCREEN_ON); 1008 } else { 1009 acpi_enable_all_runtime_gpes(); 1010 } 1011 } 1012 1013 static void acpi_s2idle_end(void) 1014 { 1015 s2idle_in_progress = false; 1016 acpi_scan_lock_release(); 1017 } 1018 1019 static const struct platform_s2idle_ops acpi_s2idle_ops = { 1020 .begin = acpi_s2idle_begin, 1021 .prepare = acpi_s2idle_prepare, 1022 .wake = acpi_s2idle_wake, 1023 .sync = acpi_s2idle_sync, 1024 .restore = acpi_s2idle_restore, 1025 .end = acpi_s2idle_end, 1026 }; 1027 1028 static void acpi_sleep_suspend_setup(void) 1029 { 1030 int i; 1031 1032 for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++) 1033 if (acpi_sleep_state_supported(i)) 1034 sleep_states[i] = 1; 1035 1036 suspend_set_ops(old_suspend_ordering ? 1037 &acpi_suspend_ops_old : &acpi_suspend_ops); 1038 1039 acpi_scan_add_handler(&lps0_handler); 1040 s2idle_set_ops(&acpi_s2idle_ops); 1041 } 1042 1043 #else /* !CONFIG_SUSPEND */ 1044 #define s2idle_in_progress (false) 1045 #define s2idle_wakeup (false) 1046 #define lps0_device_handle (NULL) 1047 static inline void acpi_sleep_suspend_setup(void) {} 1048 #endif /* !CONFIG_SUSPEND */ 1049 1050 bool acpi_s2idle_wakeup(void) 1051 { 1052 return s2idle_wakeup; 1053 } 1054 1055 bool acpi_sleep_no_ec_events(void) 1056 { 1057 return !s2idle_in_progress || !lps0_device_handle; 1058 } 1059 1060 #ifdef CONFIG_PM_SLEEP 1061 static u32 saved_bm_rld; 1062 1063 static int acpi_save_bm_rld(void) 1064 { 1065 acpi_read_bit_register(ACPI_BITREG_BUS_MASTER_RLD, &saved_bm_rld); 1066 return 0; 1067 } 1068 1069 static void acpi_restore_bm_rld(void) 1070 { 1071 u32 resumed_bm_rld = 0; 1072 1073 acpi_read_bit_register(ACPI_BITREG_BUS_MASTER_RLD, &resumed_bm_rld); 1074 if (resumed_bm_rld == saved_bm_rld) 1075 return; 1076 1077 acpi_write_bit_register(ACPI_BITREG_BUS_MASTER_RLD, saved_bm_rld); 1078 } 1079 1080 static struct syscore_ops acpi_sleep_syscore_ops = { 1081 .suspend = acpi_save_bm_rld, 1082 .resume = acpi_restore_bm_rld, 1083 }; 1084 1085 static void acpi_sleep_syscore_init(void) 1086 { 1087 register_syscore_ops(&acpi_sleep_syscore_ops); 1088 } 1089 #else 1090 static inline void acpi_sleep_syscore_init(void) {} 1091 #endif /* CONFIG_PM_SLEEP */ 1092 1093 #ifdef CONFIG_HIBERNATION 1094 static unsigned long s4_hardware_signature; 1095 static struct acpi_table_facs *facs; 1096 static bool nosigcheck; 1097 1098 void __init acpi_no_s4_hw_signature(void) 1099 { 1100 nosigcheck = true; 1101 } 1102 1103 static int acpi_hibernation_begin(void) 1104 { 1105 int error; 1106 1107 error = nvs_nosave ? 0 : suspend_nvs_alloc(); 1108 if (!error) 1109 acpi_pm_start(ACPI_STATE_S4); 1110 1111 return error; 1112 } 1113 1114 static int acpi_hibernation_enter(void) 1115 { 1116 acpi_status status = AE_OK; 1117 1118 ACPI_FLUSH_CPU_CACHE(); 1119 1120 /* This shouldn't return. If it returns, we have a problem */ 1121 status = acpi_enter_sleep_state(ACPI_STATE_S4); 1122 /* Reprogram control registers */ 1123 acpi_leave_sleep_state_prep(ACPI_STATE_S4); 1124 1125 return ACPI_SUCCESS(status) ? 0 : -EFAULT; 1126 } 1127 1128 static void acpi_hibernation_leave(void) 1129 { 1130 pm_set_resume_via_firmware(); 1131 /* 1132 * If ACPI is not enabled by the BIOS and the boot kernel, we need to 1133 * enable it here. 1134 */ 1135 acpi_enable(); 1136 /* Reprogram control registers */ 1137 acpi_leave_sleep_state_prep(ACPI_STATE_S4); 1138 /* Check the hardware signature */ 1139 if (facs && s4_hardware_signature != facs->hardware_signature) 1140 pr_crit("ACPI: Hardware changed while hibernated, success doubtful!\n"); 1141 /* Restore the NVS memory area */ 1142 suspend_nvs_restore(); 1143 /* Allow EC transactions to happen. */ 1144 acpi_ec_unblock_transactions(); 1145 } 1146 1147 static void acpi_pm_thaw(void) 1148 { 1149 acpi_ec_unblock_transactions(); 1150 acpi_enable_all_runtime_gpes(); 1151 } 1152 1153 static const struct platform_hibernation_ops acpi_hibernation_ops = { 1154 .begin = acpi_hibernation_begin, 1155 .end = acpi_pm_end, 1156 .pre_snapshot = acpi_pm_prepare, 1157 .finish = acpi_pm_finish, 1158 .prepare = acpi_pm_prepare, 1159 .enter = acpi_hibernation_enter, 1160 .leave = acpi_hibernation_leave, 1161 .pre_restore = acpi_pm_freeze, 1162 .restore_cleanup = acpi_pm_thaw, 1163 }; 1164 1165 /** 1166 * acpi_hibernation_begin_old - Set the target system sleep state to 1167 * ACPI_STATE_S4 and execute the _PTS control method. This 1168 * function is used if the pre-ACPI 2.0 suspend ordering has been 1169 * requested. 1170 */ 1171 static int acpi_hibernation_begin_old(void) 1172 { 1173 int error; 1174 /* 1175 * The _TTS object should always be evaluated before the _PTS object. 1176 * When the old_suspended_ordering is true, the _PTS object is 1177 * evaluated in the acpi_sleep_prepare. 1178 */ 1179 acpi_sleep_tts_switch(ACPI_STATE_S4); 1180 1181 error = acpi_sleep_prepare(ACPI_STATE_S4); 1182 1183 if (!error) { 1184 if (!nvs_nosave) 1185 error = suspend_nvs_alloc(); 1186 if (!error) { 1187 acpi_target_sleep_state = ACPI_STATE_S4; 1188 acpi_scan_lock_acquire(); 1189 } 1190 } 1191 return error; 1192 } 1193 1194 /* 1195 * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has 1196 * been requested. 1197 */ 1198 static const struct platform_hibernation_ops acpi_hibernation_ops_old = { 1199 .begin = acpi_hibernation_begin_old, 1200 .end = acpi_pm_end, 1201 .pre_snapshot = acpi_pm_pre_suspend, 1202 .prepare = acpi_pm_freeze, 1203 .finish = acpi_pm_finish, 1204 .enter = acpi_hibernation_enter, 1205 .leave = acpi_hibernation_leave, 1206 .pre_restore = acpi_pm_freeze, 1207 .restore_cleanup = acpi_pm_thaw, 1208 .recover = acpi_pm_finish, 1209 }; 1210 1211 static void acpi_sleep_hibernate_setup(void) 1212 { 1213 if (!acpi_sleep_state_supported(ACPI_STATE_S4)) 1214 return; 1215 1216 hibernation_set_ops(old_suspend_ordering ? 1217 &acpi_hibernation_ops_old : &acpi_hibernation_ops); 1218 sleep_states[ACPI_STATE_S4] = 1; 1219 if (nosigcheck) 1220 return; 1221 1222 acpi_get_table(ACPI_SIG_FACS, 1, (struct acpi_table_header **)&facs); 1223 if (facs) 1224 s4_hardware_signature = facs->hardware_signature; 1225 } 1226 #else /* !CONFIG_HIBERNATION */ 1227 static inline void acpi_sleep_hibernate_setup(void) {} 1228 #endif /* !CONFIG_HIBERNATION */ 1229 1230 static void acpi_power_off_prepare(void) 1231 { 1232 /* Prepare to power off the system */ 1233 acpi_sleep_prepare(ACPI_STATE_S5); 1234 acpi_disable_all_gpes(); 1235 acpi_os_wait_events_complete(); 1236 } 1237 1238 static void acpi_power_off(void) 1239 { 1240 /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */ 1241 printk(KERN_DEBUG "%s called\n", __func__); 1242 local_irq_disable(); 1243 acpi_enter_sleep_state(ACPI_STATE_S5); 1244 } 1245 1246 int __init acpi_sleep_init(void) 1247 { 1248 char supported[ACPI_S_STATE_COUNT * 3 + 1]; 1249 char *pos = supported; 1250 int i; 1251 1252 acpi_sleep_dmi_check(); 1253 1254 sleep_states[ACPI_STATE_S0] = 1; 1255 1256 acpi_sleep_syscore_init(); 1257 acpi_sleep_suspend_setup(); 1258 acpi_sleep_hibernate_setup(); 1259 1260 if (acpi_sleep_state_supported(ACPI_STATE_S5)) { 1261 sleep_states[ACPI_STATE_S5] = 1; 1262 pm_power_off_prepare = acpi_power_off_prepare; 1263 pm_power_off = acpi_power_off; 1264 } else { 1265 acpi_no_s5 = true; 1266 } 1267 1268 supported[0] = 0; 1269 for (i = 0; i < ACPI_S_STATE_COUNT; i++) { 1270 if (sleep_states[i]) 1271 pos += sprintf(pos, " S%d", i); 1272 } 1273 pr_info(PREFIX "(supports%s)\n", supported); 1274 1275 /* 1276 * Register the tts_notifier to reboot notifier list so that the _TTS 1277 * object can also be evaluated when the system enters S5. 1278 */ 1279 register_reboot_notifier(&tts_notifier); 1280 return 0; 1281 } 1282