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 struct dmi_system_id acpisleep_dmi_table[] __initdata = {
 164         {
 165         .callback = init_old_suspend_ordering,
 166         .ident = "Abit KN9 (nForce4 variant)",
 167         .matches = {
 168                 DMI_MATCH(DMI_BOARD_VENDOR, "http://www.abit.com.tw/"),
 169                 DMI_MATCH(DMI_BOARD_NAME, "KN9 Series(NF-CK804)"),
 170                 },
 171         },
 172         {
 173         .callback = init_old_suspend_ordering,
 174         .ident = "HP xw4600 Workstation",
 175         .matches = {
 176                 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
 177                 DMI_MATCH(DMI_PRODUCT_NAME, "HP xw4600 Workstation"),
 178                 },
 179         },
 180         {
 181         .callback = init_old_suspend_ordering,
 182         .ident = "Asus Pundit P1-AH2 (M2N8L motherboard)",
 183         .matches = {
 184                 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTek Computer INC."),
 185                 DMI_MATCH(DMI_BOARD_NAME, "M2N8L"),
 186                 },
 187         },
 188         {
 189         .callback = init_old_suspend_ordering,
 190         .ident = "Panasonic CF51-2L",
 191         .matches = {
 192                 DMI_MATCH(DMI_BOARD_VENDOR,
 193                                 "Matsushita Electric Industrial Co.,Ltd."),
 194                 DMI_MATCH(DMI_BOARD_NAME, "CF51-2L"),
 195                 },
 196         },
 197         {
 198         .callback = init_nvs_nosave,
 199         .ident = "Sony Vaio VGN-FW41E_H",
 200         .matches = {
 201                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
 202                 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW41E_H"),
 203                 },
 204         },
 205         {
 206         .callback = init_nvs_nosave,
 207         .ident = "Sony Vaio VGN-FW21E",
 208         .matches = {
 209                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
 210                 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW21E"),
 211                 },
 212         },
 213         {
 214         .callback = init_nvs_nosave,
 215         .ident = "Sony Vaio VGN-FW21M",
 216         .matches = {
 217                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
 218                 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW21M"),
 219                 },
 220         },
 221         {
 222         .callback = init_nvs_nosave,
 223         .ident = "Sony Vaio VPCEB17FX",
 224         .matches = {
 225                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
 226                 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB17FX"),
 227                 },
 228         },
 229         {
 230         .callback = init_nvs_nosave,
 231         .ident = "Sony Vaio VGN-SR11M",
 232         .matches = {
 233                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
 234                 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR11M"),
 235                 },
 236         },
 237         {
 238         .callback = init_nvs_nosave,
 239         .ident = "Everex StepNote Series",
 240         .matches = {
 241                 DMI_MATCH(DMI_SYS_VENDOR, "Everex Systems, Inc."),
 242                 DMI_MATCH(DMI_PRODUCT_NAME, "Everex StepNote Series"),
 243                 },
 244         },
 245         {
 246         .callback = init_nvs_nosave,
 247         .ident = "Sony Vaio VPCEB1Z1E",
 248         .matches = {
 249                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
 250                 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB1Z1E"),
 251                 },
 252         },
 253         {
 254         .callback = init_nvs_nosave,
 255         .ident = "Sony Vaio VGN-NW130D",
 256         .matches = {
 257                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
 258                 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-NW130D"),
 259                 },
 260         },
 261         {
 262         .callback = init_nvs_nosave,
 263         .ident = "Sony Vaio VPCCW29FX",
 264         .matches = {
 265                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
 266                 DMI_MATCH(DMI_PRODUCT_NAME, "VPCCW29FX"),
 267                 },
 268         },
 269         {
 270         .callback = init_nvs_nosave,
 271         .ident = "Averatec AV1020-ED2",
 272         .matches = {
 273                 DMI_MATCH(DMI_SYS_VENDOR, "AVERATEC"),
 274                 DMI_MATCH(DMI_PRODUCT_NAME, "1000 Series"),
 275                 },
 276         },
 277         {
 278         .callback = init_old_suspend_ordering,
 279         .ident = "Asus A8N-SLI DELUXE",
 280         .matches = {
 281                 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
 282                 DMI_MATCH(DMI_BOARD_NAME, "A8N-SLI DELUXE"),
 283                 },
 284         },
 285         {
 286         .callback = init_old_suspend_ordering,
 287         .ident = "Asus A8N-SLI Premium",
 288         .matches = {
 289                 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
 290                 DMI_MATCH(DMI_BOARD_NAME, "A8N-SLI Premium"),
 291                 },
 292         },
 293         {
 294         .callback = init_nvs_nosave,
 295         .ident = "Sony Vaio VGN-SR26GN_P",
 296         .matches = {
 297                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
 298                 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR26GN_P"),
 299                 },
 300         },
 301         {
 302         .callback = init_nvs_nosave,
 303         .ident = "Sony Vaio VPCEB1S1E",
 304         .matches = {
 305                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
 306                 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB1S1E"),
 307                 },
 308         },
 309         {
 310         .callback = init_nvs_nosave,
 311         .ident = "Sony Vaio VGN-FW520F",
 312         .matches = {
 313                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
 314                 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW520F"),
 315                 },
 316         },
 317         {
 318         .callback = init_nvs_nosave,
 319         .ident = "Asus K54C",
 320         .matches = {
 321                 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
 322                 DMI_MATCH(DMI_PRODUCT_NAME, "K54C"),
 323                 },
 324         },
 325         {
 326         .callback = init_nvs_nosave,
 327         .ident = "Asus K54HR",
 328         .matches = {
 329                 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
 330                 DMI_MATCH(DMI_PRODUCT_NAME, "K54HR"),
 331                 },
 332         },
 333         {
 334         .callback = init_nvs_save_s3,
 335         .ident = "Asus 1025C",
 336         .matches = {
 337                 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
 338                 DMI_MATCH(DMI_PRODUCT_NAME, "1025C"),
 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 };
 356
 357 static void __init acpi_sleep_dmi_check(void)
 358 {
 359         int year;
 360
 361         if (dmi_get_date(DMI_BIOS_DATE, &year, NULL, NULL) && year >= 2012)
 362                 acpi_nvs_nosave_s3();
 363
 364         dmi_check_system(acpisleep_dmi_table);
 365 }
 366
 367 /**
 368  * acpi_pm_freeze - Disable the GPEs and suspend EC transactions.
 369  */
 370 static int acpi_pm_freeze(void)
 371 {
 372         acpi_disable_all_gpes();
 373         acpi_os_wait_events_complete();
 374         acpi_ec_block_transactions();
 375         return 0;
 376 }
 377
 378 /**
 379  * acpi_pre_suspend - Enable wakeup devices, "freeze" EC and save NVS.
 380  */
 381 static int acpi_pm_pre_suspend(void)
 382 {
 383         acpi_pm_freeze();
 384         return suspend_nvs_save();
 385 }
 386
 387 /**
 388  *      __acpi_pm_prepare - Prepare the platform to enter the target state.
 389  *
 390  *      If necessary, set the firmware waking vector and do arch-specific
 391  *      nastiness to get the wakeup code to the waking vector.
 392  */
 393 static int __acpi_pm_prepare(void)
 394 {
 395         int error = acpi_sleep_prepare(acpi_target_sleep_state);
 396         if (error)
 397                 acpi_target_sleep_state = ACPI_STATE_S0;
 398
 399         return error;
 400 }
 401
 402 /**
 403  *      acpi_pm_prepare - Prepare the platform to enter the target sleep
 404  *              state and disable the GPEs.
 405  */
 406 static int acpi_pm_prepare(void)
 407 {
 408         int error = __acpi_pm_prepare();
 409         if (!error)
 410                 error = acpi_pm_pre_suspend();
 411
 412         return error;
 413 }
 414
 415 static int find_powerf_dev(struct device *dev, void *data)
 416 {
 417         struct acpi_device *device = to_acpi_device(dev);
 418         const char *hid = acpi_device_hid(device);
 419
 420         return !strcmp(hid, ACPI_BUTTON_HID_POWERF);
 421 }
 422
 423 /**
 424  *      acpi_pm_finish - Instruct the platform to leave a sleep state.
 425  *
 426  *      This is called after we wake back up (or if entering the sleep state
 427  *      failed).
 428  */
 429 static void acpi_pm_finish(void)
 430 {
 431         struct device *pwr_btn_dev;
 432         u32 acpi_state = acpi_target_sleep_state;
 433
 434         acpi_ec_unblock_transactions();
 435         suspend_nvs_free();
 436
 437         if (acpi_state == ACPI_STATE_S0)
 438                 return;
 439
 440         printk(KERN_INFO PREFIX "Waking up from system sleep state S%d\n",
 441                 acpi_state);
 442         acpi_disable_wakeup_devices(acpi_state);
 443         acpi_leave_sleep_state(acpi_state);
 444
 445         /* reset firmware waking vector */
 446         acpi_set_waking_vector(0);
 447
 448         acpi_target_sleep_state = ACPI_STATE_S0;
 449
 450         acpi_resume_power_resources();
 451
 452         /* If we were woken with the fixed power button, provide a small
 453          * hint to userspace in the form of a wakeup event on the fixed power
 454          * button device (if it can be found).
 455          *
 456          * We delay the event generation til now, as the PM layer requires
 457          * timekeeping to be running before we generate events. */
 458         if (!pwr_btn_event_pending)
 459                 return;
 460
 461         pwr_btn_event_pending = false;
 462         pwr_btn_dev = bus_find_device(&acpi_bus_type, NULL, NULL,
 463                                       find_powerf_dev);
 464         if (pwr_btn_dev) {
 465                 pm_wakeup_event(pwr_btn_dev, 0);
 466                 put_device(pwr_btn_dev);
 467         }
 468 }
 469
 470 /**
 471  * acpi_pm_start - Start system PM transition.
 472  */
 473 static void acpi_pm_start(u32 acpi_state)
 474 {
 475         acpi_target_sleep_state = acpi_state;
 476         acpi_sleep_tts_switch(acpi_target_sleep_state);
 477         acpi_scan_lock_acquire();
 478 }
 479
 480 /**
 481  * acpi_pm_end - Finish up system PM transition.
 482  */
 483 static void acpi_pm_end(void)
 484 {
 485         acpi_turn_off_unused_power_resources();
 486         acpi_scan_lock_release();
 487         /*
 488          * This is necessary in case acpi_pm_finish() is not called during a
 489          * failing transition to a sleep state.
 490          */
 491         acpi_target_sleep_state = ACPI_STATE_S0;
 492         acpi_sleep_tts_switch(acpi_target_sleep_state);
 493 }
 494 #else /* !CONFIG_ACPI_SLEEP */
 495 #define acpi_target_sleep_state ACPI_STATE_S0
 496 static inline void acpi_sleep_dmi_check(void) {}
 497 #endif /* CONFIG_ACPI_SLEEP */
 498
 499 #ifdef CONFIG_SUSPEND
 500 static u32 acpi_suspend_states[] = {
 501         [PM_SUSPEND_ON] = ACPI_STATE_S0,
 502         [PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
 503         [PM_SUSPEND_MEM] = ACPI_STATE_S3,
 504         [PM_SUSPEND_MAX] = ACPI_STATE_S5
 505 };
 506
 507 /**
 508  *      acpi_suspend_begin - Set the target system sleep state to the state
 509  *              associated with given @pm_state, if supported.
 510  */
 511 static int acpi_suspend_begin(suspend_state_t pm_state)
 512 {
 513         u32 acpi_state = acpi_suspend_states[pm_state];
 514         int error;
 515
 516         error = (nvs_nosave || nvs_nosave_s3) ? 0 : suspend_nvs_alloc();
 517         if (error)
 518                 return error;
 519
 520         if (!sleep_states[acpi_state]) {
 521                 pr_err("ACPI does not support sleep state S%u\n", acpi_state);
 522                 return -ENOSYS;
 523         }
 524         if (acpi_state > ACPI_STATE_S1)
 525                 pm_set_suspend_via_firmware();
 526
 527         acpi_pm_start(acpi_state);
 528         return 0;
 529 }
 530
 531 /**
 532  *      acpi_suspend_enter - Actually enter a sleep state.
 533  *      @pm_state: ignored
 534  *
 535  *      Flush caches and go to sleep. For STR we have to call arch-specific
 536  *      assembly, which in turn call acpi_enter_sleep_state().
 537  *      It's unfortunate, but it works. Please fix if you're feeling frisky.
 538  */
 539 static int acpi_suspend_enter(suspend_state_t pm_state)
 540 {
 541         acpi_status status = AE_OK;
 542         u32 acpi_state = acpi_target_sleep_state;
 543         int error;
 544
 545         ACPI_FLUSH_CPU_CACHE();
 546
 547         trace_suspend_resume(TPS("acpi_suspend"), acpi_state, true);
 548         switch (acpi_state) {
 549         case ACPI_STATE_S1:
 550                 barrier();
 551                 status = acpi_enter_sleep_state(acpi_state);
 552                 break;
 553
 554         case ACPI_STATE_S3:
 555                 if (!acpi_suspend_lowlevel)
 556                         return -ENOSYS;
 557                 error = acpi_suspend_lowlevel();
 558                 if (error)
 559                         return error;
 560                 pr_info(PREFIX "Low-level resume complete\n");
 561                 pm_set_resume_via_firmware();
 562                 break;
 563         }
 564         trace_suspend_resume(TPS("acpi_suspend"), acpi_state, false);
 565
 566         /* This violates the spec but is required for bug compatibility. */
 567         acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE, 1);
 568
 569         /* Reprogram control registers */
 570         acpi_leave_sleep_state_prep(acpi_state);
 571
 572         /* ACPI 3.0 specs (P62) says that it's the responsibility
 573          * of the OSPM to clear the status bit [ implying that the
 574          * POWER_BUTTON event should not reach userspace ]
 575          *
 576          * However, we do generate a small hint for userspace in the form of
 577          * a wakeup event. We flag this condition for now and generate the
 578          * event later, as we're currently too early in resume to be able to
 579          * generate wakeup events.
 580          */
 581         if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3)) {
 582                 acpi_event_status pwr_btn_status = ACPI_EVENT_FLAG_DISABLED;
 583
 584                 acpi_get_event_status(ACPI_EVENT_POWER_BUTTON, &pwr_btn_status);
 585
 586                 if (pwr_btn_status & ACPI_EVENT_FLAG_STATUS_SET) {
 587                         acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
 588                         /* Flag for later */
 589                         pwr_btn_event_pending = true;
 590                 }
 591         }
 592
 593         /*
 594          * Disable and clear GPE status before interrupt is enabled. Some GPEs
 595          * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
 596          * acpi_leave_sleep_state will reenable specific GPEs later
 597          */
 598         acpi_disable_all_gpes();
 599         /* Allow EC transactions to happen. */
 600         acpi_ec_unblock_transactions();
 601
 602         suspend_nvs_restore();
 603
 604         return ACPI_SUCCESS(status) ? 0 : -EFAULT;
 605 }
 606
 607 static int acpi_suspend_state_valid(suspend_state_t pm_state)
 608 {
 609         u32 acpi_state;
 610
 611         switch (pm_state) {
 612         case PM_SUSPEND_ON:
 613         case PM_SUSPEND_STANDBY:
 614         case PM_SUSPEND_MEM:
 615                 acpi_state = acpi_suspend_states[pm_state];
 616
 617                 return sleep_states[acpi_state];
 618         default:
 619                 return 0;
 620         }
 621 }
 622
 623 static const struct platform_suspend_ops acpi_suspend_ops = {
 624         .valid = acpi_suspend_state_valid,
 625         .begin = acpi_suspend_begin,
 626         .prepare_late = acpi_pm_prepare,
 627         .enter = acpi_suspend_enter,
 628         .wake = acpi_pm_finish,
 629         .end = acpi_pm_end,
 630 };
 631
 632 /**
 633  *      acpi_suspend_begin_old - Set the target system sleep state to the
 634  *              state associated with given @pm_state, if supported, and
 635  *              execute the _PTS control method.  This function is used if the
 636  *              pre-ACPI 2.0 suspend ordering has been requested.
 637  */
 638 static int acpi_suspend_begin_old(suspend_state_t pm_state)
 639 {
 640         int error = acpi_suspend_begin(pm_state);
 641         if (!error)
 642                 error = __acpi_pm_prepare();
 643
 644         return error;
 645 }
 646
 647 /*
 648  * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
 649  * been requested.
 650  */
 651 static const struct platform_suspend_ops acpi_suspend_ops_old = {
 652         .valid = acpi_suspend_state_valid,
 653         .begin = acpi_suspend_begin_old,
 654         .prepare_late = acpi_pm_pre_suspend,
 655         .enter = acpi_suspend_enter,
 656         .wake = acpi_pm_finish,
 657         .end = acpi_pm_end,
 658         .recover = acpi_pm_finish,
 659 };
 660
 661 static int acpi_freeze_begin(void)
 662 {
 663         acpi_scan_lock_acquire();
 664         return 0;
 665 }
 666
 667 static int acpi_freeze_prepare(void)
 668 {
 669         acpi_enable_wakeup_devices(ACPI_STATE_S0);
 670         acpi_enable_all_wakeup_gpes();
 671         acpi_os_wait_events_complete();
 672         if (acpi_sci_irq_valid())
 673                 enable_irq_wake(acpi_sci_irq);
 674         return 0;
 675 }
 676
 677 static void acpi_freeze_restore(void)
 678 {
 679         acpi_disable_wakeup_devices(ACPI_STATE_S0);
 680         if (acpi_sci_irq_valid())
 681                 disable_irq_wake(acpi_sci_irq);
 682         acpi_enable_all_runtime_gpes();
 683 }
 684
 685 static void acpi_freeze_end(void)
 686 {
 687         acpi_scan_lock_release();
 688 }
 689
 690 static const struct platform_freeze_ops acpi_freeze_ops = {
 691         .begin = acpi_freeze_begin,
 692         .prepare = acpi_freeze_prepare,
 693         .restore = acpi_freeze_restore,
 694         .end = acpi_freeze_end,
 695 };
 696
 697 static void acpi_sleep_suspend_setup(void)
 698 {
 699         int i;
 700
 701         for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++)
 702                 if (acpi_sleep_state_supported(i))
 703                         sleep_states[i] = 1;
 704
 705         suspend_set_ops(old_suspend_ordering ?
 706                 &acpi_suspend_ops_old : &acpi_suspend_ops);
 707         freeze_set_ops(&acpi_freeze_ops);
 708 }
 709
 710 #else /* !CONFIG_SUSPEND */
 711 static inline void acpi_sleep_suspend_setup(void) {}
 712 #endif /* !CONFIG_SUSPEND */
 713
 714 #ifdef CONFIG_PM_SLEEP
 715 static u32 saved_bm_rld;
 716
 717 static int  acpi_save_bm_rld(void)
 718 {
 719         acpi_read_bit_register(ACPI_BITREG_BUS_MASTER_RLD, &saved_bm_rld);
 720         return 0;
 721 }
 722
 723 static void  acpi_restore_bm_rld(void)
 724 {
 725         u32 resumed_bm_rld = 0;
 726
 727         acpi_read_bit_register(ACPI_BITREG_BUS_MASTER_RLD, &resumed_bm_rld);
 728         if (resumed_bm_rld == saved_bm_rld)
 729                 return;
 730
 731         acpi_write_bit_register(ACPI_BITREG_BUS_MASTER_RLD, saved_bm_rld);
 732 }
 733
 734 static struct syscore_ops acpi_sleep_syscore_ops = {
 735         .suspend = acpi_save_bm_rld,
 736         .resume = acpi_restore_bm_rld,
 737 };
 738
 739 void acpi_sleep_syscore_init(void)
 740 {
 741         register_syscore_ops(&acpi_sleep_syscore_ops);
 742 }
 743 #else
 744 static inline void acpi_sleep_syscore_init(void) {}
 745 #endif /* CONFIG_PM_SLEEP */
 746
 747 #ifdef CONFIG_HIBERNATION
 748 static unsigned long s4_hardware_signature;
 749 static struct acpi_table_facs *facs;
 750 static bool nosigcheck;
 751
 752 void __init acpi_no_s4_hw_signature(void)
 753 {
 754         nosigcheck = true;
 755 }
 756
 757 static int acpi_hibernation_begin(void)
 758 {
 759         int error;
 760
 761         error = nvs_nosave ? 0 : suspend_nvs_alloc();
 762         if (!error)
 763                 acpi_pm_start(ACPI_STATE_S4);
 764
 765         return error;
 766 }
 767
 768 static int acpi_hibernation_enter(void)
 769 {
 770         acpi_status status = AE_OK;
 771
 772         ACPI_FLUSH_CPU_CACHE();
 773
 774         /* This shouldn't return.  If it returns, we have a problem */
 775         status = acpi_enter_sleep_state(ACPI_STATE_S4);
 776         /* Reprogram control registers */
 777         acpi_leave_sleep_state_prep(ACPI_STATE_S4);
 778
 779         return ACPI_SUCCESS(status) ? 0 : -EFAULT;
 780 }
 781
 782 static void acpi_hibernation_leave(void)
 783 {
 784         pm_set_resume_via_firmware();
 785         /*
 786          * If ACPI is not enabled by the BIOS and the boot kernel, we need to
 787          * enable it here.
 788          */
 789         acpi_enable();
 790         /* Reprogram control registers */
 791         acpi_leave_sleep_state_prep(ACPI_STATE_S4);
 792         /* Check the hardware signature */
 793         if (facs && s4_hardware_signature != facs->hardware_signature)
 794                 pr_crit("ACPI: Hardware changed while hibernated, success doubtful!\n");
 795         /* Restore the NVS memory area */
 796         suspend_nvs_restore();
 797         /* Allow EC transactions to happen. */
 798         acpi_ec_unblock_transactions();
 799 }
 800
 801 static void acpi_pm_thaw(void)
 802 {
 803         acpi_ec_unblock_transactions();
 804         acpi_enable_all_runtime_gpes();
 805 }
 806
 807 static const struct platform_hibernation_ops acpi_hibernation_ops = {
 808         .begin = acpi_hibernation_begin,
 809         .end = acpi_pm_end,
 810         .pre_snapshot = acpi_pm_prepare,
 811         .finish = acpi_pm_finish,
 812         .prepare = acpi_pm_prepare,
 813         .enter = acpi_hibernation_enter,
 814         .leave = acpi_hibernation_leave,
 815         .pre_restore = acpi_pm_freeze,
 816         .restore_cleanup = acpi_pm_thaw,
 817 };
 818
 819 /**
 820  *      acpi_hibernation_begin_old - Set the target system sleep state to
 821  *              ACPI_STATE_S4 and execute the _PTS control method.  This
 822  *              function is used if the pre-ACPI 2.0 suspend ordering has been
 823  *              requested.
 824  */
 825 static int acpi_hibernation_begin_old(void)
 826 {
 827         int error;
 828         /*
 829          * The _TTS object should always be evaluated before the _PTS object.
 830          * When the old_suspended_ordering is true, the _PTS object is
 831          * evaluated in the acpi_sleep_prepare.
 832          */
 833         acpi_sleep_tts_switch(ACPI_STATE_S4);
 834
 835         error = acpi_sleep_prepare(ACPI_STATE_S4);
 836
 837         if (!error) {
 838                 if (!nvs_nosave)
 839                         error = suspend_nvs_alloc();
 840                 if (!error) {
 841                         acpi_target_sleep_state = ACPI_STATE_S4;
 842                         acpi_scan_lock_acquire();
 843                 }
 844         }
 845         return error;
 846 }
 847
 848 /*
 849  * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
 850  * been requested.
 851  */
 852 static const struct platform_hibernation_ops acpi_hibernation_ops_old = {
 853         .begin = acpi_hibernation_begin_old,
 854         .end = acpi_pm_end,
 855         .pre_snapshot = acpi_pm_pre_suspend,
 856         .prepare = acpi_pm_freeze,
 857         .finish = acpi_pm_finish,
 858         .enter = acpi_hibernation_enter,
 859         .leave = acpi_hibernation_leave,
 860         .pre_restore = acpi_pm_freeze,
 861         .restore_cleanup = acpi_pm_thaw,
 862         .recover = acpi_pm_finish,
 863 };
 864
 865 static void acpi_sleep_hibernate_setup(void)
 866 {
 867         if (!acpi_sleep_state_supported(ACPI_STATE_S4))
 868                 return;
 869
 870         hibernation_set_ops(old_suspend_ordering ?
 871                         &acpi_hibernation_ops_old : &acpi_hibernation_ops);
 872         sleep_states[ACPI_STATE_S4] = 1;
 873         if (nosigcheck)
 874                 return;
 875
 876         acpi_get_table(ACPI_SIG_FACS, 1, (struct acpi_table_header **)&facs);
 877         if (facs)
 878                 s4_hardware_signature = facs->hardware_signature;
 879 }
 880 #else /* !CONFIG_HIBERNATION */
 881 static inline void acpi_sleep_hibernate_setup(void) {}
 882 #endif /* !CONFIG_HIBERNATION */
 883
 884 static void acpi_power_off_prepare(void)
 885 {
 886         /* Prepare to power off the system */
 887         acpi_sleep_prepare(ACPI_STATE_S5);
 888         acpi_disable_all_gpes();
 889         acpi_os_wait_events_complete();
 890 }
 891
 892 static void acpi_power_off(void)
 893 {
 894         /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
 895         printk(KERN_DEBUG "%s called\n", __func__);
 896         local_irq_disable();
 897         acpi_enter_sleep_state(ACPI_STATE_S5);
 898 }
 899
 900 int __init acpi_sleep_init(void)
 901 {
 902         char supported[ACPI_S_STATE_COUNT * 3 + 1];
 903         char *pos = supported;
 904         int i;
 905
 906         acpi_sleep_dmi_check();
 907
 908         sleep_states[ACPI_STATE_S0] = 1;
 909
 910         acpi_sleep_syscore_init();
 911         acpi_sleep_suspend_setup();
 912         acpi_sleep_hibernate_setup();
 913
 914         if (acpi_sleep_state_supported(ACPI_STATE_S5)) {
 915                 sleep_states[ACPI_STATE_S5] = 1;
 916                 pm_power_off_prepare = acpi_power_off_prepare;
 917                 pm_power_off = acpi_power_off;
 918         } else {
 919                 acpi_no_s5 = true;
 920         }
 921
 922         supported[0] = 0;
 923         for (i = 0; i < ACPI_S_STATE_COUNT; i++) {
 924                 if (sleep_states[i])
 925                         pos += sprintf(pos, " S%d", i);
 926         }
 927         pr_info(PREFIX "(supports%s)\n", supported);
 928
 929         /*
 930          * Register the tts_notifier to reboot notifier list so that the _TTS
 931          * object can also be evaluated when the system enters S5.
 932          */
 933         register_reboot_notifier(&tts_notifier);
 934         return 0;
 935 }