drivers/acpi/sleep.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * sleep.c - ACPI sleep support.
   4  *
   5  * Copyright (c) 2005 Alexey Starikovskiy <alexey.y.starikovskiy@intel.com>
   6  * Copyright (c) 2004 David Shaohua Li <shaohua.li@intel.com>
   7  * Copyright (c) 2000-2003 Patrick Mochel
   8  * Copyright (c) 2003 Open Source Development Lab
   9  */
  10
  11 #define pr_fmt(fmt) "ACPI: PM: " fmt
  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                 pr_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 #ifndef acpi_skip_set_wakeup_address
  64 #define acpi_skip_set_wakeup_address() false
  65 #endif
  66
  67 static int acpi_sleep_prepare(u32 acpi_state)
  68 {
  69 #ifdef CONFIG_ACPI_SLEEP
  70         unsigned long acpi_wakeup_address;
  71
  72         /* do we have a wakeup address for S2 and S3? */
  73         if (acpi_state == ACPI_STATE_S3 && !acpi_skip_set_wakeup_address()) {
  74                 acpi_wakeup_address = acpi_get_wakeup_address();
  75                 if (!acpi_wakeup_address)
  76                         return -EFAULT;
  77                 acpi_set_waking_vector(acpi_wakeup_address);
  78
  79         }
  80 #endif
  81         pr_info("Preparing to enter system sleep state S%d\n", acpi_state);
  82         acpi_enable_wakeup_devices(acpi_state);
  83         acpi_enter_sleep_state_prep(acpi_state);
  84         return 0;
  85 }
  86
  87 bool acpi_sleep_state_supported(u8 sleep_state)
  88 {
  89         acpi_status status;
  90         u8 type_a, type_b;
  91
  92         status = acpi_get_sleep_type_data(sleep_state, &type_a, &type_b);
  93         return ACPI_SUCCESS(status) && (!acpi_gbl_reduced_hardware
  94                 || (acpi_gbl_FADT.sleep_control.address
  95                         && acpi_gbl_FADT.sleep_status.address));
  96 }
  97
  98 #ifdef CONFIG_ACPI_SLEEP
  99 static u32 acpi_target_sleep_state = ACPI_STATE_S0;
 100
 101 u32 acpi_target_system_state(void)
 102 {
 103         return acpi_target_sleep_state;
 104 }
 105 EXPORT_SYMBOL_GPL(acpi_target_system_state);
 106
 107 static bool pwr_btn_event_pending;
 108
 109 /*
 110  * The ACPI specification wants us to save NVS memory regions during hibernation
 111  * and to restore them during the subsequent resume.  Windows does that also for
 112  * suspend to RAM.  However, it is known that this mechanism does not work on
 113  * all machines, so we allow the user to disable it with the help of the
 114  * 'acpi_sleep=nonvs' kernel command line option.
 115  */
 116 static bool nvs_nosave;
 117
 118 void __init acpi_nvs_nosave(void)
 119 {
 120         nvs_nosave = true;
 121 }
 122
 123 /*
 124  * The ACPI specification wants us to save NVS memory regions during hibernation
 125  * but says nothing about saving NVS during S3.  Not all versions of Windows
 126  * save NVS on S3 suspend either, and it is clear that not all systems need
 127  * NVS to be saved at S3 time.  To improve suspend/resume time, allow the
 128  * user to disable saving NVS on S3 if their system does not require it, but
 129  * continue to save/restore NVS for S4 as specified.
 130  */
 131 static bool nvs_nosave_s3;
 132
 133 void __init acpi_nvs_nosave_s3(void)
 134 {
 135         nvs_nosave_s3 = true;
 136 }
 137
 138 static int __init init_nvs_save_s3(const struct dmi_system_id *d)
 139 {
 140         nvs_nosave_s3 = false;
 141         return 0;
 142 }
 143
 144 /*
 145  * ACPI 1.0 wants us to execute _PTS before suspending devices, so we allow the
 146  * user to request that behavior by using the 'acpi_old_suspend_ordering'
 147  * kernel command line option that causes the following variable to be set.
 148  */
 149 static bool old_suspend_ordering;
 150
 151 void __init acpi_old_suspend_ordering(void)
 152 {
 153         old_suspend_ordering = true;
 154 }
 155
 156 static int __init init_old_suspend_ordering(const struct dmi_system_id *d)
 157 {
 158         acpi_old_suspend_ordering();
 159         return 0;
 160 }
 161
 162 static int __init init_nvs_nosave(const struct dmi_system_id *d)
 163 {
 164         acpi_nvs_nosave();
 165         return 0;
 166 }
 167
 168 bool acpi_sleep_default_s3;
 169
 170 static int __init init_default_s3(const struct dmi_system_id *d)
 171 {
 172         acpi_sleep_default_s3 = true;
 173         return 0;
 174 }
 175
 176 static const struct dmi_system_id acpisleep_dmi_table[] __initconst = {
 177         {
 178         .callback = init_old_suspend_ordering,
 179         .ident = "Abit KN9 (nForce4 variant)",
 180         .matches = {
 181                 DMI_MATCH(DMI_BOARD_VENDOR, "http://www.abit.com.tw/"),
 182                 DMI_MATCH(DMI_BOARD_NAME, "KN9 Series(NF-CK804)"),
 183                 },
 184         },
 185         {
 186         .callback = init_old_suspend_ordering,
 187         .ident = "HP xw4600 Workstation",
 188         .matches = {
 189                 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
 190                 DMI_MATCH(DMI_PRODUCT_NAME, "HP xw4600 Workstation"),
 191                 },
 192         },
 193         {
 194         .callback = init_old_suspend_ordering,
 195         .ident = "Asus Pundit P1-AH2 (M2N8L motherboard)",
 196         .matches = {
 197                 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTek Computer INC."),
 198                 DMI_MATCH(DMI_BOARD_NAME, "M2N8L"),
 199                 },
 200         },
 201         {
 202         .callback = init_old_suspend_ordering,
 203         .ident = "Panasonic CF51-2L",
 204         .matches = {
 205                 DMI_MATCH(DMI_BOARD_VENDOR,
 206                                 "Matsushita Electric Industrial Co.,Ltd."),
 207                 DMI_MATCH(DMI_BOARD_NAME, "CF51-2L"),
 208                 },
 209         },
 210         {
 211         .callback = init_nvs_nosave,
 212         .ident = "Sony Vaio VGN-FW41E_H",
 213         .matches = {
 214                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
 215                 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW41E_H"),
 216                 },
 217         },
 218         {
 219         .callback = init_nvs_nosave,
 220         .ident = "Sony Vaio VGN-FW21E",
 221         .matches = {
 222                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
 223                 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW21E"),
 224                 },
 225         },
 226         {
 227         .callback = init_nvs_nosave,
 228         .ident = "Sony Vaio VGN-FW21M",
 229         .matches = {
 230                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
 231                 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW21M"),
 232                 },
 233         },
 234         {
 235         .callback = init_nvs_nosave,
 236         .ident = "Sony Vaio VPCEB17FX",
 237         .matches = {
 238                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
 239                 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB17FX"),
 240                 },
 241         },
 242         {
 243         .callback = init_nvs_nosave,
 244         .ident = "Sony Vaio VGN-SR11M",
 245         .matches = {
 246                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
 247                 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR11M"),
 248                 },
 249         },
 250         {
 251         .callback = init_nvs_nosave,
 252         .ident = "Everex StepNote Series",
 253         .matches = {
 254                 DMI_MATCH(DMI_SYS_VENDOR, "Everex Systems, Inc."),
 255                 DMI_MATCH(DMI_PRODUCT_NAME, "Everex StepNote Series"),
 256                 },
 257         },
 258         {
 259         .callback = init_nvs_nosave,
 260         .ident = "Sony Vaio VPCEB1Z1E",
 261         .matches = {
 262                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
 263                 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB1Z1E"),
 264                 },
 265         },
 266         {
 267         .callback = init_nvs_nosave,
 268         .ident = "Sony Vaio VGN-NW130D",
 269         .matches = {
 270                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
 271                 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-NW130D"),
 272                 },
 273         },
 274         {
 275         .callback = init_nvs_nosave,
 276         .ident = "Sony Vaio VPCCW29FX",
 277         .matches = {
 278                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
 279                 DMI_MATCH(DMI_PRODUCT_NAME, "VPCCW29FX"),
 280                 },
 281         },
 282         {
 283         .callback = init_nvs_nosave,
 284         .ident = "Averatec AV1020-ED2",
 285         .matches = {
 286                 DMI_MATCH(DMI_SYS_VENDOR, "AVERATEC"),
 287                 DMI_MATCH(DMI_PRODUCT_NAME, "1000 Series"),
 288                 },
 289         },
 290         {
 291         .callback = init_old_suspend_ordering,
 292         .ident = "Asus A8N-SLI DELUXE",
 293         .matches = {
 294                 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
 295                 DMI_MATCH(DMI_BOARD_NAME, "A8N-SLI DELUXE"),
 296                 },
 297         },
 298         {
 299         .callback = init_old_suspend_ordering,
 300         .ident = "Asus A8N-SLI Premium",
 301         .matches = {
 302                 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
 303                 DMI_MATCH(DMI_BOARD_NAME, "A8N-SLI Premium"),
 304                 },
 305         },
 306         {
 307         .callback = init_nvs_nosave,
 308         .ident = "Sony Vaio VGN-SR26GN_P",
 309         .matches = {
 310                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
 311                 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR26GN_P"),
 312                 },
 313         },
 314         {
 315         .callback = init_nvs_nosave,
 316         .ident = "Sony Vaio VPCEB1S1E",
 317         .matches = {
 318                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
 319                 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB1S1E"),
 320                 },
 321         },
 322         {
 323         .callback = init_nvs_nosave,
 324         .ident = "Sony Vaio VGN-FW520F",
 325         .matches = {
 326                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
 327                 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW520F"),
 328                 },
 329         },
 330         {
 331         .callback = init_nvs_nosave,
 332         .ident = "Asus K54C",
 333         .matches = {
 334                 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
 335                 DMI_MATCH(DMI_PRODUCT_NAME, "K54C"),
 336                 },
 337         },
 338         {
 339         .callback = init_nvs_nosave,
 340         .ident = "Asus K54HR",
 341         .matches = {
 342                 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
 343                 DMI_MATCH(DMI_PRODUCT_NAME, "K54HR"),
 344                 },
 345         },
 346         {
 347         .callback = init_nvs_save_s3,
 348         .ident = "Asus 1025C",
 349         .matches = {
 350                 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
 351                 DMI_MATCH(DMI_PRODUCT_NAME, "1025C"),
 352                 },
 353         },
 354         /*
 355          * https://bugzilla.kernel.org/show_bug.cgi?id=189431
 356          * Lenovo G50-45 is a platform later than 2012, but needs nvs memory
 357          * saving during S3.
 358          */
 359         {
 360         .callback = init_nvs_save_s3,
 361         .ident = "Lenovo G50-45",
 362         .matches = {
 363                 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
 364                 DMI_MATCH(DMI_PRODUCT_NAME, "80E3"),
 365                 },
 366         },
 367         {
 368         .callback = init_nvs_save_s3,
 369         .ident = "Lenovo G40-45",
 370         .matches = {
 371                 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
 372                 DMI_MATCH(DMI_PRODUCT_NAME, "80E1"),
 373                 },
 374         },
 375         /*
 376          * ThinkPad X1 Tablet(2016) cannot do suspend-to-idle using
 377          * the Low Power S0 Idle firmware interface (see
 378          * https://bugzilla.kernel.org/show_bug.cgi?id=199057).
 379          */
 380         {
 381         .callback = init_default_s3,
 382         .ident = "ThinkPad X1 Tablet(2016)",
 383         .matches = {
 384                 DMI_MATCH(DMI_SYS_VENDOR, "LENOVO"),
 385                 DMI_MATCH(DMI_PRODUCT_NAME, "20GGA00L00"),
 386                 },
 387         },
 388         /*
 389          * ASUS B1400CEAE hangs on resume from suspend (see
 390          * https://bugzilla.kernel.org/show_bug.cgi?id=215742).
 391          */
 392         {
 393         .callback = init_default_s3,
 394         .ident = "ASUS B1400CEAE",
 395         .matches = {
 396                 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
 397                 DMI_MATCH(DMI_PRODUCT_NAME, "ASUS EXPERTBOOK B1400CEAE"),
 398                 },
 399         },
 400         {},
 401 };
 402
 403 static bool ignore_blacklist;
 404
 405 void __init acpi_sleep_no_blacklist(void)
 406 {
 407         ignore_blacklist = true;
 408 }
 409
 410 static void __init acpi_sleep_dmi_check(void)
 411 {
 412         if (ignore_blacklist)
 413                 return;
 414
 415         if (dmi_get_bios_year() >= 2012)
 416                 acpi_nvs_nosave_s3();
 417
 418         dmi_check_system(acpisleep_dmi_table);
 419 }
 420
 421 /**
 422  * acpi_pm_freeze - Disable the GPEs and suspend EC transactions.
 423  */
 424 static int acpi_pm_freeze(void)
 425 {
 426         acpi_disable_all_gpes();
 427         acpi_os_wait_events_complete();
 428         acpi_ec_block_transactions();
 429         return 0;
 430 }
 431
 432 /**
 433  * acpi_pm_pre_suspend - Enable wakeup devices, "freeze" EC and save NVS.
 434  */
 435 static int acpi_pm_pre_suspend(void)
 436 {
 437         acpi_pm_freeze();
 438         return suspend_nvs_save();
 439 }
 440
 441 /**
 442  *      __acpi_pm_prepare - Prepare the platform to enter the target state.
 443  *
 444  *      If necessary, set the firmware waking vector and do arch-specific
 445  *      nastiness to get the wakeup code to the waking vector.
 446  */
 447 static int __acpi_pm_prepare(void)
 448 {
 449         int error = acpi_sleep_prepare(acpi_target_sleep_state);
 450         if (error)
 451                 acpi_target_sleep_state = ACPI_STATE_S0;
 452
 453         return error;
 454 }
 455
 456 /**
 457  *      acpi_pm_prepare - Prepare the platform to enter the target sleep
 458  *              state and disable the GPEs.
 459  */
 460 static int acpi_pm_prepare(void)
 461 {
 462         int error = __acpi_pm_prepare();
 463         if (!error)
 464                 error = acpi_pm_pre_suspend();
 465
 466         return error;
 467 }
 468
 469 /**
 470  *      acpi_pm_finish - Instruct the platform to leave a sleep state.
 471  *
 472  *      This is called after we wake back up (or if entering the sleep state
 473  *      failed).
 474  */
 475 static void acpi_pm_finish(void)
 476 {
 477         struct acpi_device *pwr_btn_adev;
 478         u32 acpi_state = acpi_target_sleep_state;
 479
 480         acpi_ec_unblock_transactions();
 481         suspend_nvs_free();
 482
 483         if (acpi_state == ACPI_STATE_S0)
 484                 return;
 485
 486         pr_info("Waking up from system sleep state S%d\n", acpi_state);
 487         acpi_disable_wakeup_devices(acpi_state);
 488         acpi_leave_sleep_state(acpi_state);
 489
 490         /* reset firmware waking vector */
 491         acpi_set_waking_vector(0);
 492
 493         acpi_target_sleep_state = ACPI_STATE_S0;
 494
 495         acpi_resume_power_resources();
 496
 497         /* If we were woken with the fixed power button, provide a small
 498          * hint to userspace in the form of a wakeup event on the fixed power
 499          * button device (if it can be found).
 500          *
 501          * We delay the event generation til now, as the PM layer requires
 502          * timekeeping to be running before we generate events. */
 503         if (!pwr_btn_event_pending)
 504                 return;
 505
 506         pwr_btn_event_pending = false;
 507         pwr_btn_adev = acpi_dev_get_first_match_dev(ACPI_BUTTON_HID_POWERF,
 508                                                     NULL, -1);
 509         if (pwr_btn_adev) {
 510                 pm_wakeup_event(&pwr_btn_adev->dev, 0);
 511                 acpi_dev_put(pwr_btn_adev);
 512         }
 513 }
 514
 515 /**
 516  * acpi_pm_start - Start system PM transition.
 517  * @acpi_state: The target ACPI power state to transition to.
 518  */
 519 static void acpi_pm_start(u32 acpi_state)
 520 {
 521         acpi_target_sleep_state = acpi_state;
 522         acpi_sleep_tts_switch(acpi_target_sleep_state);
 523         acpi_scan_lock_acquire();
 524 }
 525
 526 /**
 527  * acpi_pm_end - Finish up system PM transition.
 528  */
 529 static void acpi_pm_end(void)
 530 {
 531         acpi_turn_off_unused_power_resources();
 532         acpi_scan_lock_release();
 533         /*
 534          * This is necessary in case acpi_pm_finish() is not called during a
 535          * failing transition to a sleep state.
 536          */
 537         acpi_target_sleep_state = ACPI_STATE_S0;
 538         acpi_sleep_tts_switch(acpi_target_sleep_state);
 539 }
 540 #else /* !CONFIG_ACPI_SLEEP */
 541 #define sleep_no_lps0   (1)
 542 #define acpi_target_sleep_state ACPI_STATE_S0
 543 #define acpi_sleep_default_s3   (1)
 544 static inline void acpi_sleep_dmi_check(void) {}
 545 #endif /* CONFIG_ACPI_SLEEP */
 546
 547 #ifdef CONFIG_SUSPEND
 548 static u32 acpi_suspend_states[] = {
 549         [PM_SUSPEND_ON] = ACPI_STATE_S0,
 550         [PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
 551         [PM_SUSPEND_MEM] = ACPI_STATE_S3,
 552         [PM_SUSPEND_MAX] = ACPI_STATE_S5
 553 };
 554
 555 /**
 556  * acpi_suspend_begin - Set the target system sleep state to the state
 557  *      associated with given @pm_state, if supported.
 558  * @pm_state: The target system power management state.
 559  */
 560 static int acpi_suspend_begin(suspend_state_t pm_state)
 561 {
 562         u32 acpi_state = acpi_suspend_states[pm_state];
 563         int error;
 564
 565         error = (nvs_nosave || nvs_nosave_s3) ? 0 : suspend_nvs_alloc();
 566         if (error)
 567                 return error;
 568
 569         if (!sleep_states[acpi_state]) {
 570                 pr_err("ACPI does not support sleep state S%u\n", acpi_state);
 571                 return -ENOSYS;
 572         }
 573         if (acpi_state > ACPI_STATE_S1)
 574                 pm_set_suspend_via_firmware();
 575
 576         acpi_pm_start(acpi_state);
 577         return 0;
 578 }
 579
 580 /**
 581  *      acpi_suspend_enter - Actually enter a sleep state.
 582  *      @pm_state: ignored
 583  *
 584  *      Flush caches and go to sleep. For STR we have to call arch-specific
 585  *      assembly, which in turn call acpi_enter_sleep_state().
 586  *      It's unfortunate, but it works. Please fix if you're feeling frisky.
 587  */
 588 static int acpi_suspend_enter(suspend_state_t pm_state)
 589 {
 590         acpi_status status = AE_OK;
 591         u32 acpi_state = acpi_target_sleep_state;
 592         int error;
 593
 594         trace_suspend_resume(TPS("acpi_suspend"), acpi_state, true);
 595         switch (acpi_state) {
 596         case ACPI_STATE_S1:
 597                 barrier();
 598                 status = acpi_enter_sleep_state(acpi_state);
 599                 break;
 600
 601         case ACPI_STATE_S3:
 602                 if (!acpi_suspend_lowlevel)
 603                         return -ENOSYS;
 604                 error = acpi_suspend_lowlevel();
 605                 if (error)
 606                         return error;
 607                 pr_info("Low-level resume complete\n");
 608                 pm_set_resume_via_firmware();
 609                 break;
 610         }
 611         trace_suspend_resume(TPS("acpi_suspend"), acpi_state, false);
 612
 613         /* This violates the spec but is required for bug compatibility. */
 614         acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE, 1);
 615
 616         /* Reprogram control registers */
 617         acpi_leave_sleep_state_prep(acpi_state);
 618
 619         /* ACPI 3.0 specs (P62) says that it's the responsibility
 620          * of the OSPM to clear the status bit [ implying that the
 621          * POWER_BUTTON event should not reach userspace ]
 622          *
 623          * However, we do generate a small hint for userspace in the form of
 624          * a wakeup event. We flag this condition for now and generate the
 625          * event later, as we're currently too early in resume to be able to
 626          * generate wakeup events.
 627          */
 628         if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3)) {
 629                 acpi_event_status pwr_btn_status = ACPI_EVENT_FLAG_DISABLED;
 630
 631                 acpi_get_event_status(ACPI_EVENT_POWER_BUTTON, &pwr_btn_status);
 632
 633                 if (pwr_btn_status & ACPI_EVENT_FLAG_STATUS_SET) {
 634                         acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
 635                         /* Flag for later */
 636                         pwr_btn_event_pending = true;
 637                 }
 638         }
 639
 640         /*
 641          * Disable all GPE and clear their status bits before interrupts are
 642          * enabled. Some GPEs (like wakeup GPEs) have no handlers and this can
 643          * prevent them from producing spurious interrups.
 644          *
 645          * acpi_leave_sleep_state() will reenable specific GPEs later.
 646          *
 647          * Because this code runs on one CPU with disabled interrupts (all of
 648          * the other CPUs are offline at this time), it need not acquire any
 649          * sleeping locks which may trigger an implicit preemption point even
 650          * if there is no contention, so avoid doing that by using a low-level
 651          * library routine here.
 652          */
 653         acpi_hw_disable_all_gpes();
 654         /* Allow EC transactions to happen. */
 655         acpi_ec_unblock_transactions();
 656
 657         suspend_nvs_restore();
 658
 659         return ACPI_SUCCESS(status) ? 0 : -EFAULT;
 660 }
 661
 662 static int acpi_suspend_state_valid(suspend_state_t pm_state)
 663 {
 664         u32 acpi_state;
 665
 666         switch (pm_state) {
 667         case PM_SUSPEND_ON:
 668         case PM_SUSPEND_STANDBY:
 669         case PM_SUSPEND_MEM:
 670                 acpi_state = acpi_suspend_states[pm_state];
 671
 672                 return sleep_states[acpi_state];
 673         default:
 674                 return 0;
 675         }
 676 }
 677
 678 static const struct platform_suspend_ops acpi_suspend_ops = {
 679         .valid = acpi_suspend_state_valid,
 680         .begin = acpi_suspend_begin,
 681         .prepare_late = acpi_pm_prepare,
 682         .enter = acpi_suspend_enter,
 683         .wake = acpi_pm_finish,
 684         .end = acpi_pm_end,
 685 };
 686
 687 /**
 688  * acpi_suspend_begin_old - Set the target system sleep state to the
 689  *      state associated with given @pm_state, if supported, and
 690  *      execute the _PTS control method.  This function is used if the
 691  *      pre-ACPI 2.0 suspend ordering has been requested.
 692  * @pm_state: The target suspend state for the system.
 693  */
 694 static int acpi_suspend_begin_old(suspend_state_t pm_state)
 695 {
 696         int error = acpi_suspend_begin(pm_state);
 697         if (!error)
 698                 error = __acpi_pm_prepare();
 699
 700         return error;
 701 }
 702
 703 /*
 704  * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
 705  * been requested.
 706  */
 707 static const struct platform_suspend_ops acpi_suspend_ops_old = {
 708         .valid = acpi_suspend_state_valid,
 709         .begin = acpi_suspend_begin_old,
 710         .prepare_late = acpi_pm_pre_suspend,
 711         .enter = acpi_suspend_enter,
 712         .wake = acpi_pm_finish,
 713         .end = acpi_pm_end,
 714         .recover = acpi_pm_finish,
 715 };
 716
 717 static bool s2idle_wakeup;
 718
 719 int acpi_s2idle_begin(void)
 720 {
 721         acpi_scan_lock_acquire();
 722         return 0;
 723 }
 724
 725 int acpi_s2idle_prepare(void)
 726 {
 727         if (acpi_sci_irq_valid()) {
 728                 int error;
 729
 730                 error = enable_irq_wake(acpi_sci_irq);
 731                 if (error)
 732                         pr_warn("Warning: Failed to enable wakeup from IRQ %d: %d\n",
 733                                 acpi_sci_irq, error);
 734
 735                 acpi_ec_set_gpe_wake_mask(ACPI_GPE_ENABLE);
 736         }
 737
 738         acpi_enable_wakeup_devices(ACPI_STATE_S0);
 739
 740         /* Change the configuration of GPEs to avoid spurious wakeup. */
 741         acpi_enable_all_wakeup_gpes();
 742         acpi_os_wait_events_complete();
 743
 744         s2idle_wakeup = true;
 745         return 0;
 746 }
 747
 748 bool acpi_s2idle_wake(void)
 749 {
 750         if (!acpi_sci_irq_valid())
 751                 return pm_wakeup_pending();
 752
 753         while (pm_wakeup_pending()) {
 754                 /*
 755                  * If IRQD_WAKEUP_ARMED is set for the SCI at this point, the
 756                  * SCI has not triggered while suspended, so bail out (the
 757                  * wakeup is pending anyway and the SCI is not the source of
 758                  * it).
 759                  */
 760                 if (irqd_is_wakeup_armed(irq_get_irq_data(acpi_sci_irq))) {
 761                         pm_pr_dbg("Wakeup unrelated to ACPI SCI\n");
 762                         return true;
 763                 }
 764
 765                 /*
 766                  * If the status bit of any enabled fixed event is set, the
 767                  * wakeup is regarded as valid.
 768                  */
 769                 if (acpi_any_fixed_event_status_set()) {
 770                         pm_pr_dbg("ACPI fixed event wakeup\n");
 771                         return true;
 772                 }
 773
 774                 /* Check wakeups from drivers sharing the SCI. */
 775                 if (acpi_check_wakeup_handlers()) {
 776                         pm_pr_dbg("ACPI custom handler wakeup\n");
 777                         return true;
 778                 }
 779
 780                 /*
 781                  * Check non-EC GPE wakeups and if there are none, cancel the
 782                  * SCI-related wakeup and dispatch the EC GPE.
 783                  */
 784                 if (acpi_ec_dispatch_gpe()) {
 785                         pm_pr_dbg("ACPI non-EC GPE wakeup\n");
 786                         return true;
 787                 }
 788
 789                 acpi_os_wait_events_complete();
 790
 791                 /*
 792                  * The SCI is in the "suspended" state now and it cannot produce
 793                  * new wakeup events till the rearming below, so if any of them
 794                  * are pending here, they must be resulting from the processing
 795                  * of EC events above or coming from somewhere else.
 796                  */
 797                 if (pm_wakeup_pending()) {
 798                         pm_pr_dbg("Wakeup after ACPI Notify sync\n");
 799                         return true;
 800                 }
 801
 802                 pm_pr_dbg("Rearming ACPI SCI for wakeup\n");
 803
 804                 pm_wakeup_clear(acpi_sci_irq);
 805                 rearm_wake_irq(acpi_sci_irq);
 806         }
 807
 808         return false;
 809 }
 810
 811 void acpi_s2idle_restore(void)
 812 {
 813         /*
 814          * Drain pending events before restoring the working-state configuration
 815          * of GPEs.
 816          */
 817         acpi_os_wait_events_complete(); /* synchronize GPE processing */
 818         acpi_ec_flush_work(); /* flush the EC driver's workqueues */
 819         acpi_os_wait_events_complete(); /* synchronize Notify handling */
 820
 821         s2idle_wakeup = false;
 822
 823         acpi_enable_all_runtime_gpes();
 824
 825         acpi_disable_wakeup_devices(ACPI_STATE_S0);
 826
 827         if (acpi_sci_irq_valid()) {
 828                 acpi_ec_set_gpe_wake_mask(ACPI_GPE_DISABLE);
 829                 disable_irq_wake(acpi_sci_irq);
 830         }
 831 }
 832
 833 void acpi_s2idle_end(void)
 834 {
 835         acpi_scan_lock_release();
 836 }
 837
 838 static const struct platform_s2idle_ops acpi_s2idle_ops = {
 839         .begin = acpi_s2idle_begin,
 840         .prepare = acpi_s2idle_prepare,
 841         .wake = acpi_s2idle_wake,
 842         .restore = acpi_s2idle_restore,
 843         .end = acpi_s2idle_end,
 844 };
 845
 846 void __weak acpi_s2idle_setup(void)
 847 {
 848         if (acpi_gbl_FADT.flags & ACPI_FADT_LOW_POWER_S0)
 849                 pr_info("Efficient low-power S0 idle declared\n");
 850
 851         s2idle_set_ops(&acpi_s2idle_ops);
 852 }
 853
 854 static void __init acpi_sleep_suspend_setup(void)
 855 {
 856         bool suspend_ops_needed = false;
 857         int i;
 858
 859         for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++)
 860                 if (acpi_sleep_state_supported(i)) {
 861                         sleep_states[i] = 1;
 862                         suspend_ops_needed = true;
 863                 }
 864
 865         if (suspend_ops_needed)
 866                 suspend_set_ops(old_suspend_ordering ?
 867                                 &acpi_suspend_ops_old : &acpi_suspend_ops);
 868
 869         acpi_s2idle_setup();
 870 }
 871
 872 #else /* !CONFIG_SUSPEND */
 873 #define s2idle_wakeup           (false)
 874 static inline void acpi_sleep_suspend_setup(void) {}
 875 #endif /* !CONFIG_SUSPEND */
 876
 877 bool acpi_s2idle_wakeup(void)
 878 {
 879         return s2idle_wakeup;
 880 }
 881
 882 #ifdef CONFIG_PM_SLEEP
 883 static u32 saved_bm_rld;
 884
 885 static int  acpi_save_bm_rld(void)
 886 {
 887         acpi_read_bit_register(ACPI_BITREG_BUS_MASTER_RLD, &saved_bm_rld);
 888         return 0;
 889 }
 890
 891 static void  acpi_restore_bm_rld(void)
 892 {
 893         u32 resumed_bm_rld = 0;
 894
 895         acpi_read_bit_register(ACPI_BITREG_BUS_MASTER_RLD, &resumed_bm_rld);
 896         if (resumed_bm_rld == saved_bm_rld)
 897                 return;
 898
 899         acpi_write_bit_register(ACPI_BITREG_BUS_MASTER_RLD, saved_bm_rld);
 900 }
 901
 902 static struct syscore_ops acpi_sleep_syscore_ops = {
 903         .suspend = acpi_save_bm_rld,
 904         .resume = acpi_restore_bm_rld,
 905 };
 906
 907 static void acpi_sleep_syscore_init(void)
 908 {
 909         register_syscore_ops(&acpi_sleep_syscore_ops);
 910 }
 911 #else
 912 static inline void acpi_sleep_syscore_init(void) {}
 913 #endif /* CONFIG_PM_SLEEP */
 914
 915 #ifdef CONFIG_HIBERNATION
 916 static unsigned long s4_hardware_signature;
 917 static struct acpi_table_facs *facs;
 918 int acpi_check_s4_hw_signature = -1; /* Default behaviour is just to warn */
 919
 920 static int acpi_hibernation_begin(pm_message_t stage)
 921 {
 922         if (!nvs_nosave) {
 923                 int error = suspend_nvs_alloc();
 924                 if (error)
 925                         return error;
 926         }
 927
 928         if (stage.event == PM_EVENT_HIBERNATE)
 929                 pm_set_suspend_via_firmware();
 930
 931         acpi_pm_start(ACPI_STATE_S4);
 932         return 0;
 933 }
 934
 935 static int acpi_hibernation_enter(void)
 936 {
 937         acpi_status status = AE_OK;
 938
 939         /* This shouldn't return.  If it returns, we have a problem */
 940         status = acpi_enter_sleep_state(ACPI_STATE_S4);
 941         /* Reprogram control registers */
 942         acpi_leave_sleep_state_prep(ACPI_STATE_S4);
 943
 944         return ACPI_SUCCESS(status) ? 0 : -EFAULT;
 945 }
 946
 947 static void acpi_hibernation_leave(void)
 948 {
 949         pm_set_resume_via_firmware();
 950         /*
 951          * If ACPI is not enabled by the BIOS and the boot kernel, we need to
 952          * enable it here.
 953          */
 954         acpi_enable();
 955         /* Reprogram control registers */
 956         acpi_leave_sleep_state_prep(ACPI_STATE_S4);
 957         /* Check the hardware signature */
 958         if (facs && s4_hardware_signature != facs->hardware_signature)
 959                 pr_crit("Hardware changed while hibernated, success doubtful!\n");
 960         /* Restore the NVS memory area */
 961         suspend_nvs_restore();
 962         /* Allow EC transactions to happen. */
 963         acpi_ec_unblock_transactions();
 964 }
 965
 966 static void acpi_pm_thaw(void)
 967 {
 968         acpi_ec_unblock_transactions();
 969         acpi_enable_all_runtime_gpes();
 970 }
 971
 972 static const struct platform_hibernation_ops acpi_hibernation_ops = {
 973         .begin = acpi_hibernation_begin,
 974         .end = acpi_pm_end,
 975         .pre_snapshot = acpi_pm_prepare,
 976         .finish = acpi_pm_finish,
 977         .prepare = acpi_pm_prepare,
 978         .enter = acpi_hibernation_enter,
 979         .leave = acpi_hibernation_leave,
 980         .pre_restore = acpi_pm_freeze,
 981         .restore_cleanup = acpi_pm_thaw,
 982 };
 983
 984 /**
 985  * acpi_hibernation_begin_old - Set the target system sleep state to
 986  *      ACPI_STATE_S4 and execute the _PTS control method.  This
 987  *      function is used if the pre-ACPI 2.0 suspend ordering has been
 988  *      requested.
 989  * @stage: The power management event message.
 990  */
 991 static int acpi_hibernation_begin_old(pm_message_t stage)
 992 {
 993         int error;
 994         /*
 995          * The _TTS object should always be evaluated before the _PTS object.
 996          * When the old_suspended_ordering is true, the _PTS object is
 997          * evaluated in the acpi_sleep_prepare.
 998          */
 999         acpi_sleep_tts_switch(ACPI_STATE_S4);
1000
1001         error = acpi_sleep_prepare(ACPI_STATE_S4);
1002         if (error)
1003                 return error;
1004
1005         if (!nvs_nosave) {
1006                 error = suspend_nvs_alloc();
1007                 if (error)
1008                         return error;
1009         }
1010
1011         if (stage.event == PM_EVENT_HIBERNATE)
1012                 pm_set_suspend_via_firmware();
1013
1014         acpi_target_sleep_state = ACPI_STATE_S4;
1015         acpi_scan_lock_acquire();
1016         return 0;
1017 }
1018
1019 /*
1020  * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
1021  * been requested.
1022  */
1023 static const struct platform_hibernation_ops acpi_hibernation_ops_old = {
1024         .begin = acpi_hibernation_begin_old,
1025         .end = acpi_pm_end,
1026         .pre_snapshot = acpi_pm_pre_suspend,
1027         .prepare = acpi_pm_freeze,
1028         .finish = acpi_pm_finish,
1029         .enter = acpi_hibernation_enter,
1030         .leave = acpi_hibernation_leave,
1031         .pre_restore = acpi_pm_freeze,
1032         .restore_cleanup = acpi_pm_thaw,
1033         .recover = acpi_pm_finish,
1034 };
1035
1036 static void acpi_sleep_hibernate_setup(void)
1037 {
1038         if (!acpi_sleep_state_supported(ACPI_STATE_S4))
1039                 return;
1040
1041         hibernation_set_ops(old_suspend_ordering ?
1042                         &acpi_hibernation_ops_old : &acpi_hibernation_ops);
1043         sleep_states[ACPI_STATE_S4] = 1;
1044         if (!acpi_check_s4_hw_signature)
1045                 return;
1046
1047         acpi_get_table(ACPI_SIG_FACS, 1, (struct acpi_table_header **)&facs);
1048         if (facs) {
1049                 /*
1050                  * s4_hardware_signature is the local variable which is just
1051                  * used to warn about mismatch after we're attempting to
1052                  * resume (in violation of the ACPI specification.)
1053                  */
1054                 s4_hardware_signature = facs->hardware_signature;
1055
1056                 if (acpi_check_s4_hw_signature > 0) {
1057                         /*
1058                          * If we're actually obeying the ACPI specification
1059                          * then the signature is written out as part of the
1060                          * swsusp header, in order to allow the boot kernel
1061                          * to gracefully decline to resume.
1062                          */
1063                         swsusp_hardware_signature = facs->hardware_signature;
1064                 }
1065         }
1066 }
1067 #else /* !CONFIG_HIBERNATION */
1068 static inline void acpi_sleep_hibernate_setup(void) {}
1069 #endif /* !CONFIG_HIBERNATION */
1070
1071 static int acpi_power_off_prepare(struct sys_off_data *data)
1072 {
1073         /* Prepare to power off the system */
1074         acpi_sleep_prepare(ACPI_STATE_S5);
1075         acpi_disable_all_gpes();
1076         acpi_os_wait_events_complete();
1077         return NOTIFY_DONE;
1078 }
1079
1080 static int acpi_power_off(struct sys_off_data *data)
1081 {
1082         /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
1083         pr_debug("%s called\n", __func__);
1084         local_irq_disable();
1085         acpi_enter_sleep_state(ACPI_STATE_S5);
1086         return NOTIFY_DONE;
1087 }
1088
1089 int __init acpi_sleep_init(void)
1090 {
1091         char supported[ACPI_S_STATE_COUNT * 3 + 1];
1092         char *pos = supported;
1093         int i;
1094
1095         acpi_sleep_dmi_check();
1096
1097         sleep_states[ACPI_STATE_S0] = 1;
1098
1099         acpi_sleep_syscore_init();
1100         acpi_sleep_suspend_setup();
1101         acpi_sleep_hibernate_setup();
1102
1103         if (acpi_sleep_state_supported(ACPI_STATE_S5)) {
1104                 sleep_states[ACPI_STATE_S5] = 1;
1105
1106                 register_sys_off_handler(SYS_OFF_MODE_POWER_OFF_PREPARE,
1107                                          SYS_OFF_PRIO_FIRMWARE,
1108                                          acpi_power_off_prepare, NULL);
1109
1110                 register_sys_off_handler(SYS_OFF_MODE_POWER_OFF,
1111                                          SYS_OFF_PRIO_FIRMWARE,
1112                                          acpi_power_off, NULL);
1113
1114                 /*
1115                  * Windows uses S5 for reboot, so some BIOSes depend on it to
1116                  * perform proper reboot.
1117                  */
1118                 register_sys_off_handler(SYS_OFF_MODE_RESTART_PREPARE,
1119                                          SYS_OFF_PRIO_FIRMWARE,
1120                                          acpi_power_off_prepare, NULL);
1121         } else {
1122                 acpi_no_s5 = true;
1123         }
1124
1125         supported[0] = 0;
1126         for (i = 0; i < ACPI_S_STATE_COUNT; i++) {
1127                 if (sleep_states[i])
1128                         pos += sprintf(pos, " S%d", i);
1129         }
1130         pr_info("(supports%s)\n", supported);
1131
1132         /*
1133          * Register the tts_notifier to reboot notifier list so that the _TTS
1134          * object can also be evaluated when the system enters S5.
1135          */
1136         register_reboot_notifier(&tts_notifier);
1137         return 0;
1138 }