drivers/acpi/sleep.c

   1 /*
   2  * sleep.c - ACPI sleep support.
   3  *
   4  * Copyright (c) 2005 Alexey Starikovskiy <[email protected]>
   5  * Copyright (c) 2004 David Shaohua Li <[email protected]>
   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                 acpi_handle handle = lpi_constraints_table[i].handle;
 853                 struct acpi_device *adev;
 854
 855                 if (!handle || acpi_bus_get_device(handle, &adev))
 856                         continue;
 857
 858                 acpi_handle_debug(handle,
 859                         "LPI: required min power state:%s current power state:%s\n",
 860                         acpi_power_state_string(lpi_constraints_table[i].min_dstate),
 861                         acpi_power_state_string(adev->power.state));
 862
 863                 if (!adev->flags.power_manageable) {
 864                         acpi_handle_info(handle, "LPI: Device not power manageable\n");
 865                         lpi_constraints_table[i].handle = NULL;
 866                         continue;
 867                 }
 868
 869                 if (adev->power.state < lpi_constraints_table[i].min_dstate)
 870                         acpi_handle_info(handle,
 871                                 "LPI: Constraint not met; min power state:%s current power state:%s\n",
 872                                 acpi_power_state_string(lpi_constraints_table[i].min_dstate),
 873                                 acpi_power_state_string(adev->power.state));
 874         }
 875 }
 876
 877 static void acpi_sleep_run_lps0_dsm(unsigned int func)
 878 {
 879         union acpi_object *out_obj;
 880
 881         if (!(lps0_dsm_func_mask & (1 << func)))
 882                 return;
 883
 884         out_obj = acpi_evaluate_dsm(lps0_device_handle, &lps0_dsm_guid, 1, func, NULL);
 885         ACPI_FREE(out_obj);
 886
 887         acpi_handle_debug(lps0_device_handle, "_DSM function %u evaluation %s\n",
 888                           func, out_obj ? "successful" : "failed");
 889 }
 890
 891 static int lps0_device_attach(struct acpi_device *adev,
 892                               const struct acpi_device_id *not_used)
 893 {
 894         union acpi_object *out_obj;
 895
 896         if (lps0_device_handle)
 897                 return 0;
 898
 899         if (acpi_sleep_no_lps0) {
 900                 acpi_handle_info(adev->handle,
 901                                  "Low Power S0 Idle interface disabled\n");
 902                 return 0;
 903         }
 904
 905         if (!(acpi_gbl_FADT.flags & ACPI_FADT_LOW_POWER_S0))
 906                 return 0;
 907
 908         guid_parse(ACPI_LPS0_DSM_UUID, &lps0_dsm_guid);
 909         /* Check if the _DSM is present and as expected. */
 910         out_obj = acpi_evaluate_dsm(adev->handle, &lps0_dsm_guid, 1, 0, NULL);
 911         if (out_obj && out_obj->type == ACPI_TYPE_BUFFER) {
 912                 char bitmask = *(char *)out_obj->buffer.pointer;
 913
 914                 if ((bitmask & ACPI_LPS0_PLATFORM_MASK) == ACPI_LPS0_PLATFORM_MASK ||
 915                     (bitmask & ACPI_LPS0_SCREEN_MASK) == ACPI_LPS0_SCREEN_MASK) {
 916                         lps0_dsm_func_mask = bitmask;
 917                         lps0_device_handle = adev->handle;
 918                         /*
 919                          * Use suspend-to-idle by default if the default
 920                          * suspend mode was not set from the command line.
 921                          */
 922                         if (mem_sleep_default > PM_SUSPEND_MEM)
 923                                 mem_sleep_current = PM_SUSPEND_TO_IDLE;
 924                 }
 925
 926                 acpi_handle_debug(adev->handle, "_DSM function mask: 0x%x\n",
 927                                   bitmask);
 928         } else {
 929                 acpi_handle_debug(adev->handle,
 930                                   "_DSM function 0 evaluation failed\n");
 931         }
 932         ACPI_FREE(out_obj);
 933
 934         lpi_device_get_constraints();
 935
 936         return 0;
 937 }
 938
 939 static struct acpi_scan_handler lps0_handler = {
 940         .ids = lps0_device_ids,
 941         .attach = lps0_device_attach,
 942 };
 943
 944 static int acpi_s2idle_begin(void)
 945 {
 946         acpi_scan_lock_acquire();
 947         s2idle_in_progress = true;
 948         return 0;
 949 }
 950
 951 static int acpi_s2idle_prepare(void)
 952 {
 953         if (lps0_device_handle) {
 954                 acpi_sleep_run_lps0_dsm(ACPI_LPS0_SCREEN_OFF);
 955                 acpi_sleep_run_lps0_dsm(ACPI_LPS0_ENTRY);
 956         }
 957
 958         if (acpi_sci_irq_valid())
 959                 enable_irq_wake(acpi_sci_irq);
 960
 961         return 0;
 962 }
 963
 964 static void acpi_s2idle_wake(void)
 965 {
 966
 967         if (pm_debug_messages_on)
 968                 lpi_check_constraints();
 969
 970         /*
 971          * If IRQD_WAKEUP_ARMED is not set for the SCI at this point, it means
 972          * that the SCI has triggered while suspended, so cancel the wakeup in
 973          * case it has not been a wakeup event (the GPEs will be checked later).
 974          */
 975         if (acpi_sci_irq_valid() &&
 976             !irqd_is_wakeup_armed(irq_get_irq_data(acpi_sci_irq))) {
 977                 pm_system_cancel_wakeup();
 978                 s2idle_wakeup = true;
 979         }
 980 }
 981
 982 static void acpi_s2idle_sync(void)
 983 {
 984         /*
 985          * Process all pending events in case there are any wakeup ones.
 986          *
 987          * The EC driver uses the system workqueue and an additional special
 988          * one, so those need to be flushed too.
 989          */
 990         acpi_os_wait_events_complete(); /* synchronize SCI IRQ handling */
 991         acpi_ec_flush_work();
 992         acpi_os_wait_events_complete(); /* synchronize Notify handling */
 993         s2idle_wakeup = false;
 994 }
 995
 996 static void acpi_s2idle_restore(void)
 997 {
 998         if (acpi_sci_irq_valid())
 999                 disable_irq_wake(acpi_sci_irq);
1000
1001         if (lps0_device_handle) {
1002                 acpi_sleep_run_lps0_dsm(ACPI_LPS0_EXIT);
1003                 acpi_sleep_run_lps0_dsm(ACPI_LPS0_SCREEN_ON);
1004         }
1005 }
1006
1007 static void acpi_s2idle_end(void)
1008 {
1009         s2idle_in_progress = false;
1010         acpi_scan_lock_release();
1011 }
1012
1013 static const struct platform_s2idle_ops acpi_s2idle_ops = {
1014         .begin = acpi_s2idle_begin,
1015         .prepare = acpi_s2idle_prepare,
1016         .wake = acpi_s2idle_wake,
1017         .sync = acpi_s2idle_sync,
1018         .restore = acpi_s2idle_restore,
1019         .end = acpi_s2idle_end,
1020 };
1021
1022 static void acpi_sleep_suspend_setup(void)
1023 {
1024         int i;
1025
1026         for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++)
1027                 if (acpi_sleep_state_supported(i))
1028                         sleep_states[i] = 1;
1029
1030         suspend_set_ops(old_suspend_ordering ?
1031                 &acpi_suspend_ops_old : &acpi_suspend_ops);
1032
1033         acpi_scan_add_handler(&lps0_handler);
1034         s2idle_set_ops(&acpi_s2idle_ops);
1035 }
1036
1037 #else /* !CONFIG_SUSPEND */
1038 #define s2idle_in_progress      (false)
1039 #define s2idle_wakeup           (false)
1040 #define lps0_device_handle      (NULL)
1041 static inline void acpi_sleep_suspend_setup(void) {}
1042 #endif /* !CONFIG_SUSPEND */
1043
1044 bool acpi_s2idle_wakeup(void)
1045 {
1046         return s2idle_wakeup;
1047 }
1048
1049 bool acpi_sleep_no_ec_events(void)
1050 {
1051         return !s2idle_in_progress || !lps0_device_handle;
1052 }
1053
1054 #ifdef CONFIG_PM_SLEEP
1055 static u32 saved_bm_rld;
1056
1057 static int  acpi_save_bm_rld(void)
1058 {
1059         acpi_read_bit_register(ACPI_BITREG_BUS_MASTER_RLD, &saved_bm_rld);
1060         return 0;
1061 }
1062
1063 static void  acpi_restore_bm_rld(void)
1064 {
1065         u32 resumed_bm_rld = 0;
1066
1067         acpi_read_bit_register(ACPI_BITREG_BUS_MASTER_RLD, &resumed_bm_rld);
1068         if (resumed_bm_rld == saved_bm_rld)
1069                 return;
1070
1071         acpi_write_bit_register(ACPI_BITREG_BUS_MASTER_RLD, saved_bm_rld);
1072 }
1073
1074 static struct syscore_ops acpi_sleep_syscore_ops = {
1075         .suspend = acpi_save_bm_rld,
1076         .resume = acpi_restore_bm_rld,
1077 };
1078
1079 static void acpi_sleep_syscore_init(void)
1080 {
1081         register_syscore_ops(&acpi_sleep_syscore_ops);
1082 }
1083 #else
1084 static inline void acpi_sleep_syscore_init(void) {}
1085 #endif /* CONFIG_PM_SLEEP */
1086
1087 #ifdef CONFIG_HIBERNATION
1088 static unsigned long s4_hardware_signature;
1089 static struct acpi_table_facs *facs;
1090 static bool nosigcheck;
1091
1092 void __init acpi_no_s4_hw_signature(void)
1093 {
1094         nosigcheck = true;
1095 }
1096
1097 static int acpi_hibernation_begin(void)
1098 {
1099         int error;
1100
1101         error = nvs_nosave ? 0 : suspend_nvs_alloc();
1102         if (!error)
1103                 acpi_pm_start(ACPI_STATE_S4);
1104
1105         return error;
1106 }
1107
1108 static int acpi_hibernation_enter(void)
1109 {
1110         acpi_status status = AE_OK;
1111
1112         ACPI_FLUSH_CPU_CACHE();
1113
1114         /* This shouldn't return.  If it returns, we have a problem */
1115         status = acpi_enter_sleep_state(ACPI_STATE_S4);
1116         /* Reprogram control registers */
1117         acpi_leave_sleep_state_prep(ACPI_STATE_S4);
1118
1119         return ACPI_SUCCESS(status) ? 0 : -EFAULT;
1120 }
1121
1122 static void acpi_hibernation_leave(void)
1123 {
1124         pm_set_resume_via_firmware();
1125         /*
1126          * If ACPI is not enabled by the BIOS and the boot kernel, we need to
1127          * enable it here.
1128          */
1129         acpi_enable();
1130         /* Reprogram control registers */
1131         acpi_leave_sleep_state_prep(ACPI_STATE_S4);
1132         /* Check the hardware signature */
1133         if (facs && s4_hardware_signature != facs->hardware_signature)
1134                 pr_crit("ACPI: Hardware changed while hibernated, success doubtful!\n");
1135         /* Restore the NVS memory area */
1136         suspend_nvs_restore();
1137         /* Allow EC transactions to happen. */
1138         acpi_ec_unblock_transactions();
1139 }
1140
1141 static void acpi_pm_thaw(void)
1142 {
1143         acpi_ec_unblock_transactions();
1144         acpi_enable_all_runtime_gpes();
1145 }
1146
1147 static const struct platform_hibernation_ops acpi_hibernation_ops = {
1148         .begin = acpi_hibernation_begin,
1149         .end = acpi_pm_end,
1150         .pre_snapshot = acpi_pm_prepare,
1151         .finish = acpi_pm_finish,
1152         .prepare = acpi_pm_prepare,
1153         .enter = acpi_hibernation_enter,
1154         .leave = acpi_hibernation_leave,
1155         .pre_restore = acpi_pm_freeze,
1156         .restore_cleanup = acpi_pm_thaw,
1157 };
1158
1159 /**
1160  *      acpi_hibernation_begin_old - Set the target system sleep state to
1161  *              ACPI_STATE_S4 and execute the _PTS control method.  This
1162  *              function is used if the pre-ACPI 2.0 suspend ordering has been
1163  *              requested.
1164  */
1165 static int acpi_hibernation_begin_old(void)
1166 {
1167         int error;
1168         /*
1169          * The _TTS object should always be evaluated before the _PTS object.
1170          * When the old_suspended_ordering is true, the _PTS object is
1171          * evaluated in the acpi_sleep_prepare.
1172          */
1173         acpi_sleep_tts_switch(ACPI_STATE_S4);
1174
1175         error = acpi_sleep_prepare(ACPI_STATE_S4);
1176
1177         if (!error) {
1178                 if (!nvs_nosave)
1179                         error = suspend_nvs_alloc();
1180                 if (!error) {
1181                         acpi_target_sleep_state = ACPI_STATE_S4;
1182                         acpi_scan_lock_acquire();
1183                 }
1184         }
1185         return error;
1186 }
1187
1188 /*
1189  * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
1190  * been requested.
1191  */
1192 static const struct platform_hibernation_ops acpi_hibernation_ops_old = {
1193         .begin = acpi_hibernation_begin_old,
1194         .end = acpi_pm_end,
1195         .pre_snapshot = acpi_pm_pre_suspend,
1196         .prepare = acpi_pm_freeze,
1197         .finish = acpi_pm_finish,
1198         .enter = acpi_hibernation_enter,
1199         .leave = acpi_hibernation_leave,
1200         .pre_restore = acpi_pm_freeze,
1201         .restore_cleanup = acpi_pm_thaw,
1202         .recover = acpi_pm_finish,
1203 };
1204
1205 static void acpi_sleep_hibernate_setup(void)
1206 {
1207         if (!acpi_sleep_state_supported(ACPI_STATE_S4))
1208                 return;
1209
1210         hibernation_set_ops(old_suspend_ordering ?
1211                         &acpi_hibernation_ops_old : &acpi_hibernation_ops);
1212         sleep_states[ACPI_STATE_S4] = 1;
1213         if (nosigcheck)
1214                 return;
1215
1216         acpi_get_table(ACPI_SIG_FACS, 1, (struct acpi_table_header **)&facs);
1217         if (facs)
1218                 s4_hardware_signature = facs->hardware_signature;
1219 }
1220 #else /* !CONFIG_HIBERNATION */
1221 static inline void acpi_sleep_hibernate_setup(void) {}
1222 #endif /* !CONFIG_HIBERNATION */
1223
1224 static void acpi_power_off_prepare(void)
1225 {
1226         /* Prepare to power off the system */
1227         acpi_sleep_prepare(ACPI_STATE_S5);
1228         acpi_disable_all_gpes();
1229         acpi_os_wait_events_complete();
1230 }
1231
1232 static void acpi_power_off(void)
1233 {
1234         /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
1235         printk(KERN_DEBUG "%s called\n", __func__);
1236         local_irq_disable();
1237         acpi_enter_sleep_state(ACPI_STATE_S5);
1238 }
1239
1240 int __init acpi_sleep_init(void)
1241 {
1242         char supported[ACPI_S_STATE_COUNT * 3 + 1];
1243         char *pos = supported;
1244         int i;
1245
1246         acpi_sleep_dmi_check();
1247
1248         sleep_states[ACPI_STATE_S0] = 1;
1249
1250         acpi_sleep_syscore_init();
1251         acpi_sleep_suspend_setup();
1252         acpi_sleep_hibernate_setup();
1253
1254         if (acpi_sleep_state_supported(ACPI_STATE_S5)) {
1255                 sleep_states[ACPI_STATE_S5] = 1;
1256                 pm_power_off_prepare = acpi_power_off_prepare;
1257                 pm_power_off = acpi_power_off;
1258         } else {
1259                 acpi_no_s5 = true;
1260         }
1261
1262         supported[0] = 0;
1263         for (i = 0; i < ACPI_S_STATE_COUNT; i++) {
1264                 if (sleep_states[i])
1265                         pos += sprintf(pos, " S%d", i);
1266         }
1267         pr_info(PREFIX "(supports%s)\n", supported);
1268
1269         /*
1270          * Register the tts_notifier to reboot notifier list so that the _TTS
1271          * object can also be evaluated when the system enters S5.
1272          */
1273         register_reboot_notifier(&tts_notifier);
1274         return 0;
1275 }