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