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/suspend.h>
  18 #include <linux/reboot.h>
  19 #include <linux/acpi.h>
  20
  21 #include <asm/io.h>
  22
  23 #include <acpi/acpi_bus.h>
  24 #include <acpi/acpi_drivers.h>
  25
  26 #include "internal.h"
  27 #include "sleep.h"
  28
  29 static u8 sleep_states[ACPI_S_STATE_COUNT];
  30
  31 static void acpi_sleep_tts_switch(u32 acpi_state)
  32 {
  33         union acpi_object in_arg = { ACPI_TYPE_INTEGER };
  34         struct acpi_object_list arg_list = { 1, &in_arg };
  35         acpi_status status = AE_OK;
  36
  37         in_arg.integer.value = acpi_state;
  38         status = acpi_evaluate_object(NULL, "\\_TTS", &arg_list, NULL);
  39         if (ACPI_FAILURE(status) && status != AE_NOT_FOUND) {
  40                 /*
  41                  * OS can't evaluate the _TTS object correctly. Some warning
  42                  * message will be printed. But it won't break anything.
  43                  */
  44                 printk(KERN_NOTICE "Failure in evaluating _TTS object\n");
  45         }
  46 }
  47
  48 static int tts_notify_reboot(struct notifier_block *this,
  49                         unsigned long code, void *x)
  50 {
  51         acpi_sleep_tts_switch(ACPI_STATE_S5);
  52         return NOTIFY_DONE;
  53 }
  54
  55 static struct notifier_block tts_notifier = {
  56         .notifier_call  = tts_notify_reboot,
  57         .next           = NULL,
  58         .priority       = 0,
  59 };
  60
  61 static int acpi_sleep_prepare(u32 acpi_state)
  62 {
  63 #ifdef CONFIG_ACPI_SLEEP
  64 #ifndef CONFIG_ACPI_PV_SLEEP
  65         /* do we have a wakeup address for S2 and S3? */
  66         if (acpi_state == ACPI_STATE_S3) {
  67                 if (!acpi_wakeup_address) {
  68                         return -EFAULT;
  69                 }
  70                 acpi_set_firmware_waking_vector(
  71                                 (acpi_physical_address)acpi_wakeup_address);
  72
  73         }
  74 #endif
  75         ACPI_FLUSH_CPU_CACHE();
  76 #endif
  77         printk(KERN_INFO PREFIX "Preparing to enter system sleep state S%d\n",
  78                 acpi_state);
  79         acpi_enable_wakeup_devices(acpi_state);
  80         acpi_enter_sleep_state_prep(acpi_state);
  81         return 0;
  82 }
  83
  84 #ifdef CONFIG_ACPI_SLEEP
  85 static u32 acpi_target_sleep_state = ACPI_STATE_S0;
  86
  87 /*
  88  * The ACPI specification wants us to save NVS memory regions during hibernation
  89  * and to restore them during the subsequent resume.  Windows does that also for
  90  * suspend to RAM.  However, it is known that this mechanism does not work on
  91  * all machines, so we allow the user to disable it with the help of the
  92  * 'acpi_sleep=nonvs' kernel command line option.
  93  */
  94 static bool nvs_nosave;
  95
  96 void __init acpi_nvs_nosave(void)
  97 {
  98         nvs_nosave = true;
  99 }
 100
 101 /*
 102  * ACPI 1.0 wants us to execute _PTS before suspending devices, so we allow the
 103  * user to request that behavior by using the 'acpi_old_suspend_ordering'
 104  * kernel command line option that causes the following variable to be set.
 105  */
 106 static bool old_suspend_ordering;
 107
 108 void __init acpi_old_suspend_ordering(void)
 109 {
 110         old_suspend_ordering = true;
 111 }
 112
 113 /**
 114  * acpi_pm_freeze - Disable the GPEs and suspend EC transactions.
 115  */
 116 static int acpi_pm_freeze(void)
 117 {
 118         acpi_disable_all_gpes();
 119         acpi_os_wait_events_complete(NULL);
 120         acpi_ec_block_transactions();
 121         return 0;
 122 }
 123
 124 /**
 125  * acpi_pre_suspend - Enable wakeup devices, "freeze" EC and save NVS.
 126  */
 127 static int acpi_pm_pre_suspend(void)
 128 {
 129         acpi_pm_freeze();
 130         return suspend_nvs_save();
 131 }
 132
 133 /**
 134  *      __acpi_pm_prepare - Prepare the platform to enter the target state.
 135  *
 136  *      If necessary, set the firmware waking vector and do arch-specific
 137  *      nastiness to get the wakeup code to the waking vector.
 138  */
 139 static int __acpi_pm_prepare(void)
 140 {
 141         int error = acpi_sleep_prepare(acpi_target_sleep_state);
 142         if (error)
 143                 acpi_target_sleep_state = ACPI_STATE_S0;
 144
 145         return error;
 146 }
 147
 148 /**
 149  *      acpi_pm_prepare - Prepare the platform to enter the target sleep
 150  *              state and disable the GPEs.
 151  */
 152 static int acpi_pm_prepare(void)
 153 {
 154         int error = __acpi_pm_prepare();
 155         if (!error)
 156                 error = acpi_pm_pre_suspend();
 157
 158         return error;
 159 }
 160
 161 /**
 162  *      acpi_pm_finish - Instruct the platform to leave a sleep state.
 163  *
 164  *      This is called after we wake back up (or if entering the sleep state
 165  *      failed).
 166  */
 167 static void acpi_pm_finish(void)
 168 {
 169         u32 acpi_state = acpi_target_sleep_state;
 170
 171         acpi_ec_unblock_transactions();
 172         suspend_nvs_free();
 173
 174         if (acpi_state == ACPI_STATE_S0)
 175                 return;
 176
 177         printk(KERN_INFO PREFIX "Waking up from system sleep state S%d\n",
 178                 acpi_state);
 179         acpi_disable_wakeup_devices(acpi_state);
 180         acpi_leave_sleep_state(acpi_state);
 181
 182         /* reset firmware waking vector */
 183         acpi_set_firmware_waking_vector((acpi_physical_address) 0);
 184
 185         acpi_target_sleep_state = ACPI_STATE_S0;
 186 }
 187
 188 /**
 189  *      acpi_pm_end - Finish up suspend sequence.
 190  */
 191 static void acpi_pm_end(void)
 192 {
 193         /*
 194          * This is necessary in case acpi_pm_finish() is not called during a
 195          * failing transition to a sleep state.
 196          */
 197         acpi_target_sleep_state = ACPI_STATE_S0;
 198         acpi_sleep_tts_switch(acpi_target_sleep_state);
 199 }
 200 #else /* !CONFIG_ACPI_SLEEP */
 201 #define acpi_target_sleep_state ACPI_STATE_S0
 202 #endif /* CONFIG_ACPI_SLEEP */
 203
 204 #ifdef CONFIG_SUSPEND
 205 static u32 acpi_suspend_states[] = {
 206         [PM_SUSPEND_ON] = ACPI_STATE_S0,
 207         [PM_SUSPEND_STANDBY] = ACPI_STATE_S1,
 208         [PM_SUSPEND_MEM] = ACPI_STATE_S3,
 209         [PM_SUSPEND_MAX] = ACPI_STATE_S5
 210 };
 211
 212 /**
 213  *      acpi_suspend_begin - Set the target system sleep state to the state
 214  *              associated with given @pm_state, if supported.
 215  */
 216 static int acpi_suspend_begin(suspend_state_t pm_state)
 217 {
 218         u32 acpi_state = acpi_suspend_states[pm_state];
 219         int error = 0;
 220
 221         error = nvs_nosave ? 0 : suspend_nvs_alloc();
 222         if (error)
 223                 return error;
 224
 225         if (sleep_states[acpi_state]) {
 226                 acpi_target_sleep_state = acpi_state;
 227                 acpi_sleep_tts_switch(acpi_target_sleep_state);
 228         } else {
 229                 printk(KERN_ERR "ACPI does not support this state: %d\n",
 230                         pm_state);
 231                 error = -ENOSYS;
 232         }
 233         return error;
 234 }
 235
 236 /**
 237  *      acpi_suspend_enter - Actually enter a sleep state.
 238  *      @pm_state: ignored
 239  *
 240  *      Flush caches and go to sleep. For STR we have to call arch-specific
 241  *      assembly, which in turn call acpi_enter_sleep_state().
 242  *      It's unfortunate, but it works. Please fix if you're feeling frisky.
 243  */
 244 static int acpi_suspend_enter(suspend_state_t pm_state)
 245 {
 246         acpi_status status = AE_OK;
 247         u32 acpi_state = acpi_target_sleep_state;
 248         int error;
 249
 250         ACPI_FLUSH_CPU_CACHE();
 251
 252         switch (acpi_state) {
 253         case ACPI_STATE_S1:
 254                 barrier();
 255                 status = acpi_enter_sleep_state(acpi_state);
 256                 break;
 257
 258         case ACPI_STATE_S3:
 259                 error = acpi_suspend_lowlevel();
 260                 if (error)
 261                         return error;
 262                 pr_info(PREFIX "Low-level resume complete\n");
 263                 break;
 264         }
 265
 266         /* This violates the spec but is required for bug compatibility. */
 267         acpi_write_bit_register(ACPI_BITREG_SCI_ENABLE, 1);
 268
 269         /* Reprogram control registers and execute _BFS */
 270         acpi_leave_sleep_state_prep(acpi_state);
 271
 272         /* ACPI 3.0 specs (P62) says that it's the responsibility
 273          * of the OSPM to clear the status bit [ implying that the
 274          * POWER_BUTTON event should not reach userspace ]
 275          */
 276         if (ACPI_SUCCESS(status) && (acpi_state == ACPI_STATE_S3))
 277                 acpi_clear_event(ACPI_EVENT_POWER_BUTTON);
 278
 279         /*
 280          * Disable and clear GPE status before interrupt is enabled. Some GPEs
 281          * (like wakeup GPE) haven't handler, this can avoid such GPE misfire.
 282          * acpi_leave_sleep_state will reenable specific GPEs later
 283          */
 284         acpi_disable_all_gpes();
 285         /* Allow EC transactions to happen. */
 286         acpi_ec_unblock_transactions_early();
 287
 288         suspend_nvs_restore();
 289
 290         return ACPI_SUCCESS(status) ? 0 : -EFAULT;
 291 }
 292
 293 static int acpi_suspend_state_valid(suspend_state_t pm_state)
 294 {
 295         u32 acpi_state;
 296
 297         switch (pm_state) {
 298         case PM_SUSPEND_ON:
 299         case PM_SUSPEND_STANDBY:
 300         case PM_SUSPEND_MEM:
 301                 acpi_state = acpi_suspend_states[pm_state];
 302
 303                 return sleep_states[acpi_state];
 304         default:
 305                 return 0;
 306         }
 307 }
 308
 309 static const struct platform_suspend_ops acpi_suspend_ops = {
 310         .valid = acpi_suspend_state_valid,
 311         .begin = acpi_suspend_begin,
 312         .prepare_late = acpi_pm_prepare,
 313         .enter = acpi_suspend_enter,
 314         .wake = acpi_pm_finish,
 315         .end = acpi_pm_end,
 316 };
 317
 318 /**
 319  *      acpi_suspend_begin_old - Set the target system sleep state to the
 320  *              state associated with given @pm_state, if supported, and
 321  *              execute the _PTS control method.  This function is used if the
 322  *              pre-ACPI 2.0 suspend ordering has been requested.
 323  */
 324 static int acpi_suspend_begin_old(suspend_state_t pm_state)
 325 {
 326         int error = acpi_suspend_begin(pm_state);
 327         if (!error)
 328                 error = __acpi_pm_prepare();
 329
 330         return error;
 331 }
 332
 333 /*
 334  * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
 335  * been requested.
 336  */
 337 static const struct platform_suspend_ops acpi_suspend_ops_old = {
 338         .valid = acpi_suspend_state_valid,
 339         .begin = acpi_suspend_begin_old,
 340         .prepare_late = acpi_pm_pre_suspend,
 341         .enter = acpi_suspend_enter,
 342         .wake = acpi_pm_finish,
 343         .end = acpi_pm_end,
 344         .recover = acpi_pm_finish,
 345 };
 346
 347 static int __init init_old_suspend_ordering(const struct dmi_system_id *d)
 348 {
 349         old_suspend_ordering = true;
 350         return 0;
 351 }
 352
 353 static int __init init_nvs_nosave(const struct dmi_system_id *d)
 354 {
 355         acpi_nvs_nosave();
 356         return 0;
 357 }
 358
 359 static struct dmi_system_id __initdata acpisleep_dmi_table[] = {
 360         {
 361         .callback = init_old_suspend_ordering,
 362         .ident = "Abit KN9 (nForce4 variant)",
 363         .matches = {
 364                 DMI_MATCH(DMI_BOARD_VENDOR, "http://www.abit.com.tw/"),
 365                 DMI_MATCH(DMI_BOARD_NAME, "KN9 Series(NF-CK804)"),
 366                 },
 367         },
 368         {
 369         .callback = init_old_suspend_ordering,
 370         .ident = "HP xw4600 Workstation",
 371         .matches = {
 372                 DMI_MATCH(DMI_SYS_VENDOR, "Hewlett-Packard"),
 373                 DMI_MATCH(DMI_PRODUCT_NAME, "HP xw4600 Workstation"),
 374                 },
 375         },
 376         {
 377         .callback = init_old_suspend_ordering,
 378         .ident = "Asus Pundit P1-AH2 (M2N8L motherboard)",
 379         .matches = {
 380                 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTek Computer INC."),
 381                 DMI_MATCH(DMI_BOARD_NAME, "M2N8L"),
 382                 },
 383         },
 384         {
 385         .callback = init_old_suspend_ordering,
 386         .ident = "Panasonic CF51-2L",
 387         .matches = {
 388                 DMI_MATCH(DMI_BOARD_VENDOR,
 389                                 "Matsushita Electric Industrial Co.,Ltd."),
 390                 DMI_MATCH(DMI_BOARD_NAME, "CF51-2L"),
 391                 },
 392         },
 393         {
 394         .callback = init_nvs_nosave,
 395         .ident = "Sony Vaio VGN-FW21E",
 396         .matches = {
 397                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
 398                 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW21E"),
 399                 },
 400         },
 401         {
 402         .callback = init_nvs_nosave,
 403         .ident = "Sony Vaio VPCEB17FX",
 404         .matches = {
 405                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
 406                 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB17FX"),
 407                 },
 408         },
 409         {
 410         .callback = init_nvs_nosave,
 411         .ident = "Sony Vaio VGN-SR11M",
 412         .matches = {
 413                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
 414                 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR11M"),
 415                 },
 416         },
 417         {
 418         .callback = init_nvs_nosave,
 419         .ident = "Everex StepNote Series",
 420         .matches = {
 421                 DMI_MATCH(DMI_SYS_VENDOR, "Everex Systems, Inc."),
 422                 DMI_MATCH(DMI_PRODUCT_NAME, "Everex StepNote Series"),
 423                 },
 424         },
 425         {
 426         .callback = init_nvs_nosave,
 427         .ident = "Sony Vaio VPCEB1Z1E",
 428         .matches = {
 429                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
 430                 DMI_MATCH(DMI_PRODUCT_NAME, "VPCEB1Z1E"),
 431                 },
 432         },
 433         {
 434         .callback = init_nvs_nosave,
 435         .ident = "Sony Vaio VGN-NW130D",
 436         .matches = {
 437                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
 438                 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-NW130D"),
 439                 },
 440         },
 441         {
 442         .callback = init_nvs_nosave,
 443         .ident = "Sony Vaio VPCCW29FX",
 444         .matches = {
 445                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
 446                 DMI_MATCH(DMI_PRODUCT_NAME, "VPCCW29FX"),
 447                 },
 448         },
 449         {
 450         .callback = init_nvs_nosave,
 451         .ident = "Averatec AV1020-ED2",
 452         .matches = {
 453                 DMI_MATCH(DMI_SYS_VENDOR, "AVERATEC"),
 454                 DMI_MATCH(DMI_PRODUCT_NAME, "1000 Series"),
 455                 },
 456         },
 457         {
 458         .callback = init_old_suspend_ordering,
 459         .ident = "Asus A8N-SLI DELUXE",
 460         .matches = {
 461                 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
 462                 DMI_MATCH(DMI_BOARD_NAME, "A8N-SLI DELUXE"),
 463                 },
 464         },
 465         {
 466         .callback = init_old_suspend_ordering,
 467         .ident = "Asus A8N-SLI Premium",
 468         .matches = {
 469                 DMI_MATCH(DMI_BOARD_VENDOR, "ASUSTeK Computer INC."),
 470                 DMI_MATCH(DMI_BOARD_NAME, "A8N-SLI Premium"),
 471                 },
 472         },
 473         {
 474         .callback = init_nvs_nosave,
 475         .ident = "Sony Vaio VGN-SR26GN_P",
 476         .matches = {
 477                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
 478                 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-SR26GN_P"),
 479                 },
 480         },
 481         {
 482         .callback = init_nvs_nosave,
 483         .ident = "Sony Vaio VGN-FW520F",
 484         .matches = {
 485                 DMI_MATCH(DMI_SYS_VENDOR, "Sony Corporation"),
 486                 DMI_MATCH(DMI_PRODUCT_NAME, "VGN-FW520F"),
 487                 },
 488         },
 489         {
 490         .callback = init_nvs_nosave,
 491         .ident = "Asus K54C",
 492         .matches = {
 493                 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
 494                 DMI_MATCH(DMI_PRODUCT_NAME, "K54C"),
 495                 },
 496         },
 497         {
 498         .callback = init_nvs_nosave,
 499         .ident = "Asus K54HR",
 500         .matches = {
 501                 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
 502                 DMI_MATCH(DMI_PRODUCT_NAME, "K54HR"),
 503                 },
 504         },
 505         {},
 506 };
 507 #endif /* CONFIG_SUSPEND */
 508
 509 #ifdef CONFIG_HIBERNATION
 510 static unsigned long s4_hardware_signature;
 511 static struct acpi_table_facs *facs;
 512 static bool nosigcheck;
 513
 514 void __init acpi_no_s4_hw_signature(void)
 515 {
 516         nosigcheck = true;
 517 }
 518
 519 static int acpi_hibernation_begin(void)
 520 {
 521         int error;
 522
 523         error = nvs_nosave ? 0 : suspend_nvs_alloc();
 524         if (!error) {
 525                 acpi_target_sleep_state = ACPI_STATE_S4;
 526                 acpi_sleep_tts_switch(acpi_target_sleep_state);
 527         }
 528
 529         return error;
 530 }
 531
 532 static int acpi_hibernation_enter(void)
 533 {
 534         acpi_status status = AE_OK;
 535
 536         ACPI_FLUSH_CPU_CACHE();
 537
 538         /* This shouldn't return.  If it returns, we have a problem */
 539         status = acpi_enter_sleep_state(ACPI_STATE_S4);
 540         /* Reprogram control registers and execute _BFS */
 541         acpi_leave_sleep_state_prep(ACPI_STATE_S4);
 542
 543         return ACPI_SUCCESS(status) ? 0 : -EFAULT;
 544 }
 545
 546 static void acpi_hibernation_leave(void)
 547 {
 548         /*
 549          * If ACPI is not enabled by the BIOS and the boot kernel, we need to
 550          * enable it here.
 551          */
 552         acpi_enable();
 553         /* Reprogram control registers and execute _BFS */
 554         acpi_leave_sleep_state_prep(ACPI_STATE_S4);
 555         /* Check the hardware signature */
 556         if (facs && s4_hardware_signature != facs->hardware_signature) {
 557                 printk(KERN_EMERG "ACPI: Hardware changed while hibernated, "
 558                         "cannot resume!\n");
 559                 panic("ACPI S4 hardware signature mismatch");
 560         }
 561         /* Restore the NVS memory area */
 562         suspend_nvs_restore();
 563         /* Allow EC transactions to happen. */
 564         acpi_ec_unblock_transactions_early();
 565 }
 566
 567 static void acpi_pm_thaw(void)
 568 {
 569         acpi_ec_unblock_transactions();
 570         acpi_enable_all_runtime_gpes();
 571 }
 572
 573 static const struct platform_hibernation_ops acpi_hibernation_ops = {
 574         .begin = acpi_hibernation_begin,
 575         .end = acpi_pm_end,
 576         .pre_snapshot = acpi_pm_prepare,
 577         .finish = acpi_pm_finish,
 578         .prepare = acpi_pm_prepare,
 579         .enter = acpi_hibernation_enter,
 580         .leave = acpi_hibernation_leave,
 581         .pre_restore = acpi_pm_freeze,
 582         .restore_cleanup = acpi_pm_thaw,
 583 };
 584
 585 /**
 586  *      acpi_hibernation_begin_old - Set the target system sleep state to
 587  *              ACPI_STATE_S4 and execute the _PTS control method.  This
 588  *              function is used if the pre-ACPI 2.0 suspend ordering has been
 589  *              requested.
 590  */
 591 static int acpi_hibernation_begin_old(void)
 592 {
 593         int error;
 594         /*
 595          * The _TTS object should always be evaluated before the _PTS object.
 596          * When the old_suspended_ordering is true, the _PTS object is
 597          * evaluated in the acpi_sleep_prepare.
 598          */
 599         acpi_sleep_tts_switch(ACPI_STATE_S4);
 600
 601         error = acpi_sleep_prepare(ACPI_STATE_S4);
 602
 603         if (!error) {
 604                 if (!nvs_nosave)
 605                         error = suspend_nvs_alloc();
 606                 if (!error)
 607                         acpi_target_sleep_state = ACPI_STATE_S4;
 608         }
 609         return error;
 610 }
 611
 612 /*
 613  * The following callbacks are used if the pre-ACPI 2.0 suspend ordering has
 614  * been requested.
 615  */
 616 static const struct platform_hibernation_ops acpi_hibernation_ops_old = {
 617         .begin = acpi_hibernation_begin_old,
 618         .end = acpi_pm_end,
 619         .pre_snapshot = acpi_pm_pre_suspend,
 620         .prepare = acpi_pm_freeze,
 621         .finish = acpi_pm_finish,
 622         .enter = acpi_hibernation_enter,
 623         .leave = acpi_hibernation_leave,
 624         .pre_restore = acpi_pm_freeze,
 625         .restore_cleanup = acpi_pm_thaw,
 626         .recover = acpi_pm_finish,
 627 };
 628 #endif /* CONFIG_HIBERNATION */
 629
 630 int acpi_suspend(u32 acpi_state)
 631 {
 632         suspend_state_t states[] = {
 633                 [1] = PM_SUSPEND_STANDBY,
 634                 [3] = PM_SUSPEND_MEM,
 635                 [5] = PM_SUSPEND_MAX
 636         };
 637
 638         if (acpi_state < 6 && states[acpi_state])
 639                 return pm_suspend(states[acpi_state]);
 640         if (acpi_state == 4)
 641                 return hibernate();
 642         return -EINVAL;
 643 }
 644
 645 #ifdef CONFIG_PM
 646 /**
 647  *      acpi_pm_device_sleep_state - return preferred power state of ACPI device
 648  *              in the system sleep state given by %acpi_target_sleep_state
 649  *      @dev: device to examine; its driver model wakeup flags control
 650  *              whether it should be able to wake up the system
 651  *      @d_min_p: used to store the upper limit of allowed states range
 652  *      Return value: preferred power state of the device on success, -ENODEV on
 653  *              failure (ie. if there's no 'struct acpi_device' for @dev)
 654  *
 655  *      Find the lowest power (highest number) ACPI device power state that
 656  *      device @dev can be in while the system is in the sleep state represented
 657  *      by %acpi_target_sleep_state.  If @wake is nonzero, the device should be
 658  *      able to wake up the system from this sleep state.  If @d_min_p is set,
 659  *      the highest power (lowest number) device power state of @dev allowed
 660  *      in this system sleep state is stored at the location pointed to by it.
 661  *
 662  *      The caller must ensure that @dev is valid before using this function.
 663  *      The caller is also responsible for figuring out if the device is
 664  *      supposed to be able to wake up the system and passing this information
 665  *      via @wake.
 666  */
 667
 668 int acpi_pm_device_sleep_state(struct device *dev, int *d_min_p)
 669 {
 670         acpi_handle handle = DEVICE_ACPI_HANDLE(dev);
 671         struct acpi_device *adev;
 672         char acpi_method[] = "_SxD";
 673         unsigned long long d_min, d_max;
 674
 675         if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
 676                 printk(KERN_DEBUG "ACPI handle has no context!\n");
 677                 return -ENODEV;
 678         }
 679
 680         acpi_method[2] = '0' + acpi_target_sleep_state;
 681         /*
 682          * If the sleep state is S0, we will return D3, but if the device has
 683          * _S0W, we will use the value from _S0W
 684          */
 685         d_min = ACPI_STATE_D0;
 686         d_max = ACPI_STATE_D3;
 687
 688         /*
 689          * If present, _SxD methods return the minimum D-state (highest power
 690          * state) we can use for the corresponding S-states.  Otherwise, the
 691          * minimum D-state is D0 (ACPI 3.x).
 692          *
 693          * NOTE: We rely on acpi_evaluate_integer() not clobbering the integer
 694          * provided -- that's our fault recovery, we ignore retval.
 695          */
 696         if (acpi_target_sleep_state > ACPI_STATE_S0)
 697                 acpi_evaluate_integer(handle, acpi_method, NULL, &d_min);
 698
 699         /*
 700          * If _PRW says we can wake up the system from the target sleep state,
 701          * the D-state returned by _SxD is sufficient for that (we assume a
 702          * wakeup-aware driver if wake is set).  Still, if _SxW exists
 703          * (ACPI 3.x), it should return the maximum (lowest power) D-state that
 704          * can wake the system.  _S0W may be valid, too.
 705          */
 706         if (acpi_target_sleep_state == ACPI_STATE_S0 ||
 707             (device_may_wakeup(dev) &&
 708              adev->wakeup.sleep_state <= acpi_target_sleep_state)) {
 709                 acpi_status status;
 710
 711                 acpi_method[3] = 'W';
 712                 status = acpi_evaluate_integer(handle, acpi_method, NULL,
 713                                                 &d_max);
 714                 if (ACPI_FAILURE(status)) {
 715                         if (acpi_target_sleep_state != ACPI_STATE_S0 ||
 716                             status != AE_NOT_FOUND)
 717                                 d_max = d_min;
 718                 } else if (d_max < d_min) {
 719                         /* Warn the user of the broken DSDT */
 720                         printk(KERN_WARNING "ACPI: Wrong value from %s\n",
 721                                 acpi_method);
 722                         /* Sanitize it */
 723                         d_min = d_max;
 724                 }
 725         }
 726
 727         if (d_min_p)
 728                 *d_min_p = d_min;
 729         return d_max;
 730 }
 731 #endif /* CONFIG_PM */
 732
 733 #ifdef CONFIG_PM_SLEEP
 734 /**
 735  *      acpi_pm_device_sleep_wake - enable or disable the system wake-up
 736  *                                  capability of given device
 737  *      @dev: device to handle
 738  *      @enable: 'true' - enable, 'false' - disable the wake-up capability
 739  */
 740 int acpi_pm_device_sleep_wake(struct device *dev, bool enable)
 741 {
 742         acpi_handle handle;
 743         struct acpi_device *adev;
 744         int error;
 745
 746         if (!device_can_wakeup(dev))
 747                 return -EINVAL;
 748
 749         handle = DEVICE_ACPI_HANDLE(dev);
 750         if (!handle || ACPI_FAILURE(acpi_bus_get_device(handle, &adev))) {
 751                 dev_dbg(dev, "ACPI handle has no context in %s!\n", __func__);
 752                 return -ENODEV;
 753         }
 754
 755         error = enable ?
 756                 acpi_enable_wakeup_device_power(adev, acpi_target_sleep_state) :
 757                 acpi_disable_wakeup_device_power(adev);
 758         if (!error)
 759                 dev_info(dev, "wake-up capability %s by ACPI\n",
 760                                 enable ? "enabled" : "disabled");
 761
 762         return error;
 763 }
 764 #endif  /* CONFIG_PM_SLEEP */
 765
 766 static void acpi_power_off_prepare(void)
 767 {
 768         /* Prepare to power off the system */
 769         acpi_sleep_prepare(ACPI_STATE_S5);
 770         acpi_disable_all_gpes();
 771 }
 772
 773 static void acpi_power_off(void)
 774 {
 775         /* acpi_sleep_prepare(ACPI_STATE_S5) should have already been called */
 776         printk(KERN_DEBUG "%s called\n", __func__);
 777         local_irq_disable();
 778         acpi_enter_sleep_state(ACPI_STATE_S5);
 779 }
 780
 781 /*
 782  * ACPI 2.0 created the optional _GTS and _BFS,
 783  * but industry adoption has been neither rapid nor broad.
 784  *
 785  * Linux gets into trouble when it executes poorly validated
 786  * paths through the BIOS, so disable _GTS and _BFS by default,
 787  * but do speak up and offer the option to enable them.
 788  */
 789 static void __init acpi_gts_bfs_check(void)
 790 {
 791         acpi_handle dummy;
 792
 793         if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT, METHOD_NAME__GTS, &dummy)))
 794         {
 795                 printk(KERN_NOTICE PREFIX "BIOS offers _GTS\n");
 796                 printk(KERN_NOTICE PREFIX "If \"acpi.gts=1\" improves suspend, "
 797                         "please notify linux-acpi@vger.kernel.org\n");
 798         }
 799         if (ACPI_SUCCESS(acpi_get_handle(ACPI_ROOT_OBJECT, METHOD_NAME__BFS, &dummy)))
 800         {
 801                 printk(KERN_NOTICE PREFIX "BIOS offers _BFS\n");
 802                 printk(KERN_NOTICE PREFIX "If \"acpi.bfs=1\" improves resume, "
 803                         "please notify linux-acpi@vger.kernel.org\n");
 804         }
 805 }
 806
 807 int __init acpi_sleep_init(void)
 808 {
 809         acpi_status status;
 810         u8 type_a, type_b;
 811 #ifdef CONFIG_SUSPEND
 812         int i = 0;
 813
 814         dmi_check_system(acpisleep_dmi_table);
 815 #endif
 816
 817         if (acpi_disabled)
 818                 return 0;
 819
 820         sleep_states[ACPI_STATE_S0] = 1;
 821         printk(KERN_INFO PREFIX "(supports S0");
 822
 823 #ifdef CONFIG_SUSPEND
 824         for (i = ACPI_STATE_S1; i < ACPI_STATE_S4; i++) {
 825                 status = acpi_get_sleep_type_data(i, &type_a, &type_b);
 826                 if (ACPI_SUCCESS(status)) {
 827                         sleep_states[i] = 1;
 828                         printk(" S%d", i);
 829                 }
 830         }
 831
 832         suspend_set_ops(old_suspend_ordering ?
 833                 &acpi_suspend_ops_old : &acpi_suspend_ops);
 834 #endif
 835
 836 #ifdef CONFIG_HIBERNATION
 837         status = acpi_get_sleep_type_data(ACPI_STATE_S4, &type_a, &type_b);
 838         if (ACPI_SUCCESS(status)) {
 839                 hibernation_set_ops(old_suspend_ordering ?
 840                         &acpi_hibernation_ops_old : &acpi_hibernation_ops);
 841                 sleep_states[ACPI_STATE_S4] = 1;
 842                 printk(" S4");
 843                 if (!nosigcheck) {
 844                         acpi_get_table(ACPI_SIG_FACS, 1,
 845                                 (struct acpi_table_header **)&facs);
 846                         if (facs)
 847                                 s4_hardware_signature =
 848                                         facs->hardware_signature;
 849                 }
 850         }
 851 #endif
 852         status = acpi_get_sleep_type_data(ACPI_STATE_S5, &type_a, &type_b);
 853         if (ACPI_SUCCESS(status)) {
 854                 sleep_states[ACPI_STATE_S5] = 1;
 855                 printk(" S5");
 856                 pm_power_off_prepare = acpi_power_off_prepare;
 857                 pm_power_off = acpi_power_off;
 858         }
 859         printk(")\n");
 860         /*
 861          * Register the tts_notifier to reboot notifier list so that the _TTS
 862          * object can also be evaluated when the system enters S5.
 863          */
 864         register_reboot_notifier(&tts_notifier);
 865         acpi_gts_bfs_check();
 866         return 0;
 867 }