drivers/acpi/sleep.c

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