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