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