kernel/power/hibernate.c

   1 /*
   2  * kernel/power/hibernate.c - Hibernation (a.k.a suspend-to-disk) support.
   3  *
   4  * Copyright (c) 2003 Patrick Mochel
   5  * Copyright (c) 2003 Open Source Development Lab
   6  * Copyright (c) 2004 Pavel Machek <pavel@ucw.cz>
   7  * Copyright (c) 2009 Rafael J. Wysocki, Novell Inc.
   8  *
   9  * This file is released under the GPLv2.
  10  */
  11
  12 #include <linux/export.h>
  13 #include <linux/suspend.h>
  14 #include <linux/syscalls.h>
  15 #include <linux/reboot.h>
  16 #include <linux/string.h>
  17 #include <linux/device.h>
  18 #include <linux/async.h>
  19 #include <linux/kmod.h>
  20 #include <linux/delay.h>
  21 #include <linux/fs.h>
  22 #include <linux/mount.h>
  23 #include <linux/pm.h>
  24 #include <linux/console.h>
  25 #include <linux/cpu.h>
  26 #include <linux/freezer.h>
  27 #include <linux/gfp.h>
  28 #include <linux/syscore_ops.h>
  29 #include <scsi/scsi_scan.h>
  30
  31 #include "power.h"
  32
  33
  34 static int nocompress;
  35 static int noresume;
  36 static int resume_wait;
  37 static int resume_delay;
  38 static char resume_file[256] = CONFIG_PM_STD_PARTITION;
  39 dev_t swsusp_resume_device;
  40 sector_t swsusp_resume_block;
  41 int in_suspend __nosavedata;
  42
  43 enum {
  44         HIBERNATION_INVALID,
  45         HIBERNATION_PLATFORM,
  46         HIBERNATION_TEST,
  47         HIBERNATION_TESTPROC,
  48         HIBERNATION_SHUTDOWN,
  49         HIBERNATION_REBOOT,
  50         /* keep last */
  51         __HIBERNATION_AFTER_LAST
  52 };
  53 #define HIBERNATION_MAX (__HIBERNATION_AFTER_LAST-1)
  54 #define HIBERNATION_FIRST (HIBERNATION_INVALID + 1)
  55
  56 static int hibernation_mode = HIBERNATION_SHUTDOWN;
  57
  58 static const struct platform_hibernation_ops *hibernation_ops;
  59
  60 /**
  61  * hibernation_set_ops - Set the global hibernate operations.
  62  * @ops: Hibernation operations to use in subsequent hibernation transitions.
  63  */
  64 void hibernation_set_ops(const struct platform_hibernation_ops *ops)
  65 {
  66         if (ops && !(ops->begin && ops->end &&  ops->pre_snapshot
  67             && ops->prepare && ops->finish && ops->enter && ops->pre_restore
  68             && ops->restore_cleanup && ops->leave)) {
  69                 WARN_ON(1);
  70                 return;
  71         }
  72         mutex_lock(&pm_mutex);
  73         hibernation_ops = ops;
  74         if (ops)
  75                 hibernation_mode = HIBERNATION_PLATFORM;
  76         else if (hibernation_mode == HIBERNATION_PLATFORM)
  77                 hibernation_mode = HIBERNATION_SHUTDOWN;
  78
  79         mutex_unlock(&pm_mutex);
  80 }
  81
  82 static bool entering_platform_hibernation;
  83
  84 bool system_entering_hibernation(void)
  85 {
  86         return entering_platform_hibernation;
  87 }
  88 EXPORT_SYMBOL(system_entering_hibernation);
  89
  90 #ifdef CONFIG_PM_DEBUG
  91 static void hibernation_debug_sleep(void)
  92 {
  93         printk(KERN_INFO "hibernation debug: Waiting for 5 seconds.\n");
  94         mdelay(5000);
  95 }
  96
  97 static int hibernation_testmode(int mode)
  98 {
  99         if (hibernation_mode == mode) {
 100                 hibernation_debug_sleep();
 101                 return 1;
 102         }
 103         return 0;
 104 }
 105
 106 static int hibernation_test(int level)
 107 {
 108         if (pm_test_level == level) {
 109                 hibernation_debug_sleep();
 110                 return 1;
 111         }
 112         return 0;
 113 }
 114 #else /* !CONFIG_PM_DEBUG */
 115 static int hibernation_testmode(int mode) { return 0; }
 116 static int hibernation_test(int level) { return 0; }
 117 #endif /* !CONFIG_PM_DEBUG */
 118
 119 /**
 120  * platform_begin - Call platform to start hibernation.
 121  * @platform_mode: Whether or not to use the platform driver.
 122  */
 123 static int platform_begin(int platform_mode)
 124 {
 125         return (platform_mode && hibernation_ops) ?
 126                 hibernation_ops->begin() : 0;
 127 }
 128
 129 /**
 130  * platform_end - Call platform to finish transition to the working state.
 131  * @platform_mode: Whether or not to use the platform driver.
 132  */
 133 static void platform_end(int platform_mode)
 134 {
 135         if (platform_mode && hibernation_ops)
 136                 hibernation_ops->end();
 137 }
 138
 139 /**
 140  * platform_pre_snapshot - Call platform to prepare the machine for hibernation.
 141  * @platform_mode: Whether or not to use the platform driver.
 142  *
 143  * Use the platform driver to prepare the system for creating a hibernate image,
 144  * if so configured, and return an error code if that fails.
 145  */
 146
 147 static int platform_pre_snapshot(int platform_mode)
 148 {
 149         return (platform_mode && hibernation_ops) ?
 150                 hibernation_ops->pre_snapshot() : 0;
 151 }
 152
 153 /**
 154  * platform_leave - Call platform to prepare a transition to the working state.
 155  * @platform_mode: Whether or not to use the platform driver.
 156  *
 157  * Use the platform driver prepare to prepare the machine for switching to the
 158  * normal mode of operation.
 159  *
 160  * This routine is called on one CPU with interrupts disabled.
 161  */
 162 static void platform_leave(int platform_mode)
 163 {
 164         if (platform_mode && hibernation_ops)
 165                 hibernation_ops->leave();
 166 }
 167
 168 /**
 169  * platform_finish - Call platform to switch the system to the working state.
 170  * @platform_mode: Whether or not to use the platform driver.
 171  *
 172  * Use the platform driver to switch the machine to the normal mode of
 173  * operation.
 174  *
 175  * This routine must be called after platform_prepare().
 176  */
 177 static void platform_finish(int platform_mode)
 178 {
 179         if (platform_mode && hibernation_ops)
 180                 hibernation_ops->finish();
 181 }
 182
 183 /**
 184  * platform_pre_restore - Prepare for hibernate image restoration.
 185  * @platform_mode: Whether or not to use the platform driver.
 186  *
 187  * Use the platform driver to prepare the system for resume from a hibernation
 188  * image.
 189  *
 190  * If the restore fails after this function has been called,
 191  * platform_restore_cleanup() must be called.
 192  */
 193 static int platform_pre_restore(int platform_mode)
 194 {
 195         return (platform_mode && hibernation_ops) ?
 196                 hibernation_ops->pre_restore() : 0;
 197 }
 198
 199 /**
 200  * platform_restore_cleanup - Switch to the working state after failing restore.
 201  * @platform_mode: Whether or not to use the platform driver.
 202  *
 203  * Use the platform driver to switch the system to the normal mode of operation
 204  * after a failing restore.
 205  *
 206  * If platform_pre_restore() has been called before the failing restore, this
 207  * function must be called too, regardless of the result of
 208  * platform_pre_restore().
 209  */
 210 static void platform_restore_cleanup(int platform_mode)
 211 {
 212         if (platform_mode && hibernation_ops)
 213                 hibernation_ops->restore_cleanup();
 214 }
 215
 216 /**
 217  * platform_recover - Recover from a failure to suspend devices.
 218  * @platform_mode: Whether or not to use the platform driver.
 219  */
 220 static void platform_recover(int platform_mode)
 221 {
 222         if (platform_mode && hibernation_ops && hibernation_ops->recover)
 223                 hibernation_ops->recover();
 224 }
 225
 226 /**
 227  * swsusp_show_speed - Print time elapsed between two events during hibernation.
 228  * @start: Starting event.
 229  * @stop: Final event.
 230  * @nr_pages: Number of memory pages processed between @start and @stop.
 231  * @msg: Additional diagnostic message to print.
 232  */
 233 void swsusp_show_speed(struct timeval *start, struct timeval *stop,
 234                         unsigned nr_pages, char *msg)
 235 {
 236         s64 elapsed_centisecs64;
 237         int centisecs;
 238         int k;
 239         int kps;
 240
 241         elapsed_centisecs64 = timeval_to_ns(stop) - timeval_to_ns(start);
 242         do_div(elapsed_centisecs64, NSEC_PER_SEC / 100);
 243         centisecs = elapsed_centisecs64;
 244         if (centisecs == 0)
 245                 centisecs = 1;  /* avoid div-by-zero */
 246         k = nr_pages * (PAGE_SIZE / 1024);
 247         kps = (k * 100) / centisecs;
 248         printk(KERN_INFO "PM: %s %d kbytes in %d.%02d seconds (%d.%02d MB/s)\n",
 249                         msg, k,
 250                         centisecs / 100, centisecs % 100,
 251                         kps / 1000, (kps % 1000) / 10);
 252 }
 253
 254 /**
 255  * create_image - Create a hibernation image.
 256  * @platform_mode: Whether or not to use the platform driver.
 257  *
 258  * Execute device drivers' .freeze_noirq() callbacks, create a hibernation image
 259  * and execute the drivers' .thaw_noirq() callbacks.
 260  *
 261  * Control reappears in this routine after the subsequent restore.
 262  */
 263 static int create_image(int platform_mode)
 264 {
 265         int error;
 266
 267         error = dpm_suspend_noirq(PMSG_FREEZE);
 268         if (error) {
 269                 printk(KERN_ERR "PM: Some devices failed to power down, "
 270                         "aborting hibernation\n");
 271                 return error;
 272         }
 273
 274         error = platform_pre_snapshot(platform_mode);
 275         if (error || hibernation_test(TEST_PLATFORM))
 276                 goto Platform_finish;
 277
 278         error = disable_nonboot_cpus();
 279         if (error || hibernation_test(TEST_CPUS)
 280             || hibernation_testmode(HIBERNATION_TEST))
 281                 goto Enable_cpus;
 282
 283         local_irq_disable();
 284
 285         error = syscore_suspend();
 286         if (error) {
 287                 printk(KERN_ERR "PM: Some system devices failed to power down, "
 288                         "aborting hibernation\n");
 289                 goto Enable_irqs;
 290         }
 291
 292         if (hibernation_test(TEST_CORE) || pm_wakeup_pending())
 293                 goto Power_up;
 294
 295         in_suspend = 1;
 296         save_processor_state();
 297         error = swsusp_arch_suspend();
 298         if (error)
 299                 printk(KERN_ERR "PM: Error %d creating hibernation image\n",
 300                         error);
 301         /* Restore control flow magically appears here */
 302         restore_processor_state();
 303         if (!in_suspend) {
 304                 events_check_enabled = false;
 305                 platform_leave(platform_mode);
 306         }
 307
 308  Power_up:
 309         syscore_resume();
 310
 311  Enable_irqs:
 312         local_irq_enable();
 313
 314  Enable_cpus:
 315         enable_nonboot_cpus();
 316
 317  Platform_finish:
 318         platform_finish(platform_mode);
 319
 320         dpm_resume_noirq(in_suspend ?
 321                 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
 322
 323         return error;
 324 }
 325
 326 /**
 327  * hibernation_snapshot - Quiesce devices and create a hibernation image.
 328  * @platform_mode: If set, use platform driver to prepare for the transition.
 329  *
 330  * This routine must be called with pm_mutex held.
 331  */
 332 int hibernation_snapshot(int platform_mode)
 333 {
 334         pm_message_t msg = PMSG_RECOVER;
 335         int error;
 336
 337         error = platform_begin(platform_mode);
 338         if (error)
 339                 goto Close;
 340
 341         /* Preallocate image memory before shutting down devices. */
 342         error = hibernate_preallocate_memory();
 343         if (error)
 344                 goto Close;
 345
 346         error = freeze_kernel_threads();
 347         if (error)
 348                 goto Close;
 349
 350         error = dpm_prepare(PMSG_FREEZE);
 351         if (error)
 352                 goto Complete_devices;
 353
 354         suspend_console();
 355         pm_restrict_gfp_mask();
 356         error = dpm_suspend(PMSG_FREEZE);
 357         if (error)
 358                 goto Recover_platform;
 359
 360         if (hibernation_test(TEST_DEVICES))
 361                 goto Recover_platform;
 362
 363         error = create_image(platform_mode);
 364         /*
 365          * Control returns here (1) after the image has been created or the
 366          * image creation has failed and (2) after a successful restore.
 367          */
 368
 369  Resume_devices:
 370         /* We may need to release the preallocated image pages here. */
 371         if (error || !in_suspend)
 372                 swsusp_free();
 373
 374         msg = in_suspend ? (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE;
 375         dpm_resume(msg);
 376
 377         if (error || !in_suspend)
 378                 pm_restore_gfp_mask();
 379
 380         resume_console();
 381
 382  Complete_devices:
 383         dpm_complete(msg);
 384
 385  Close:
 386         platform_end(platform_mode);
 387         return error;
 388
 389  Recover_platform:
 390         platform_recover(platform_mode);
 391         goto Resume_devices;
 392 }
 393
 394 /**
 395  * resume_target_kernel - Restore system state from a hibernation image.
 396  * @platform_mode: Whether or not to use the platform driver.
 397  *
 398  * Execute device drivers' .freeze_noirq() callbacks, restore the contents of
 399  * highmem that have not been restored yet from the image and run the low-level
 400  * code that will restore the remaining contents of memory and switch to the
 401  * just restored target kernel.
 402  */
 403 static int resume_target_kernel(bool platform_mode)
 404 {
 405         int error;
 406
 407         error = dpm_suspend_noirq(PMSG_QUIESCE);
 408         if (error) {
 409                 printk(KERN_ERR "PM: Some devices failed to power down, "
 410                         "aborting resume\n");
 411                 return error;
 412         }
 413
 414         error = platform_pre_restore(platform_mode);
 415         if (error)
 416                 goto Cleanup;
 417
 418         error = disable_nonboot_cpus();
 419         if (error)
 420                 goto Enable_cpus;
 421
 422         local_irq_disable();
 423
 424         error = syscore_suspend();
 425         if (error)
 426                 goto Enable_irqs;
 427
 428         save_processor_state();
 429         error = restore_highmem();
 430         if (!error) {
 431                 error = swsusp_arch_resume();
 432                 /*
 433                  * The code below is only ever reached in case of a failure.
 434                  * Otherwise, execution continues at the place where
 435                  * swsusp_arch_suspend() was called.
 436                  */
 437                 BUG_ON(!error);
 438                 /*
 439                  * This call to restore_highmem() reverts the changes made by
 440                  * the previous one.
 441                  */
 442                 restore_highmem();
 443         }
 444         /*
 445          * The only reason why swsusp_arch_resume() can fail is memory being
 446          * very tight, so we have to free it as soon as we can to avoid
 447          * subsequent failures.
 448          */
 449         swsusp_free();
 450         restore_processor_state();
 451         touch_softlockup_watchdog();
 452
 453         syscore_resume();
 454
 455  Enable_irqs:
 456         local_irq_enable();
 457
 458  Enable_cpus:
 459         enable_nonboot_cpus();
 460
 461  Cleanup:
 462         platform_restore_cleanup(platform_mode);
 463
 464         dpm_resume_noirq(PMSG_RECOVER);
 465
 466         return error;
 467 }
 468
 469 /**
 470  * hibernation_restore - Quiesce devices and restore from a hibernation image.
 471  * @platform_mode: If set, use platform driver to prepare for the transition.
 472  *
 473  * This routine must be called with pm_mutex held.  If it is successful, control
 474  * reappears in the restored target kernel in hibernation_snapshot().
 475  */
 476 int hibernation_restore(int platform_mode)
 477 {
 478         int error;
 479
 480         pm_prepare_console();
 481         suspend_console();
 482         pm_restrict_gfp_mask();
 483         error = dpm_suspend_start(PMSG_QUIESCE);
 484         if (!error) {
 485                 error = resume_target_kernel(platform_mode);
 486                 dpm_resume_end(PMSG_RECOVER);
 487         }
 488         pm_restore_gfp_mask();
 489         resume_console();
 490         pm_restore_console();
 491         return error;
 492 }
 493
 494 /**
 495  * hibernation_platform_enter - Power off the system using the platform driver.
 496  */
 497 int hibernation_platform_enter(void)
 498 {
 499         int error;
 500
 501         if (!hibernation_ops)
 502                 return -ENOSYS;
 503
 504         /*
 505          * We have cancelled the power transition by running
 506          * hibernation_ops->finish() before saving the image, so we should let
 507          * the firmware know that we're going to enter the sleep state after all
 508          */
 509         error = hibernation_ops->begin();
 510         if (error)
 511                 goto Close;
 512
 513         entering_platform_hibernation = true;
 514         suspend_console();
 515         error = dpm_suspend_start(PMSG_HIBERNATE);
 516         if (error) {
 517                 if (hibernation_ops->recover)
 518                         hibernation_ops->recover();
 519                 goto Resume_devices;
 520         }
 521
 522         error = dpm_suspend_noirq(PMSG_HIBERNATE);
 523         if (error)
 524                 goto Resume_devices;
 525
 526         error = hibernation_ops->prepare();
 527         if (error)
 528                 goto Platform_finish;
 529
 530         error = disable_nonboot_cpus();
 531         if (error)
 532                 goto Platform_finish;
 533
 534         local_irq_disable();
 535         syscore_suspend();
 536         if (pm_wakeup_pending()) {
 537                 error = -EAGAIN;
 538                 goto Power_up;
 539         }
 540
 541         hibernation_ops->enter();
 542         /* We should never get here */
 543         while (1);
 544
 545  Power_up:
 546         syscore_resume();
 547         local_irq_enable();
 548         enable_nonboot_cpus();
 549
 550  Platform_finish:
 551         hibernation_ops->finish();
 552
 553         dpm_resume_noirq(PMSG_RESTORE);
 554
 555  Resume_devices:
 556         entering_platform_hibernation = false;
 557         dpm_resume_end(PMSG_RESTORE);
 558         resume_console();
 559
 560  Close:
 561         hibernation_ops->end();
 562
 563         return error;
 564 }
 565
 566 /**
 567  * power_down - Shut the machine down for hibernation.
 568  *
 569  * Use the platform driver, if configured, to put the system into the sleep
 570  * state corresponding to hibernation, or try to power it off or reboot,
 571  * depending on the value of hibernation_mode.
 572  */
 573 static void power_down(void)
 574 {
 575         switch (hibernation_mode) {
 576         case HIBERNATION_TEST:
 577         case HIBERNATION_TESTPROC:
 578                 break;
 579         case HIBERNATION_REBOOT:
 580                 kernel_restart(NULL);
 581                 break;
 582         case HIBERNATION_PLATFORM:
 583                 hibernation_platform_enter();
 584         case HIBERNATION_SHUTDOWN:
 585                 kernel_power_off();
 586                 break;
 587         }
 588         kernel_halt();
 589         /*
 590          * Valid image is on the disk, if we continue we risk serious data
 591          * corruption after resume.
 592          */
 593         printk(KERN_CRIT "PM: Please power down manually\n");
 594         while(1);
 595 }
 596
 597 static int prepare_processes(void)
 598 {
 599         int error = 0;
 600
 601         if (freeze_processes()) {
 602                 error = -EBUSY;
 603                 thaw_processes();
 604         }
 605         return error;
 606 }
 607
 608 /**
 609  * hibernate - Carry out system hibernation, including saving the image.
 610  */
 611 int hibernate(void)
 612 {
 613         int error;
 614
 615         mutex_lock(&pm_mutex);
 616         /* The snapshot device should not be opened while we're running */
 617         if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
 618                 error = -EBUSY;
 619                 goto Unlock;
 620         }
 621
 622         pm_prepare_console();
 623         error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
 624         if (error)
 625                 goto Exit;
 626
 627         error = usermodehelper_disable();
 628         if (error)
 629                 goto Exit;
 630
 631         /* Allocate memory management structures */
 632         error = create_basic_memory_bitmaps();
 633         if (error)
 634                 goto Exit;
 635
 636         printk(KERN_INFO "PM: Syncing filesystems ... ");
 637         sys_sync();
 638         printk("done.\n");
 639
 640         error = prepare_processes();
 641         if (error)
 642                 goto Finish;
 643
 644         if (hibernation_test(TEST_FREEZER))
 645                 goto Thaw;
 646
 647         if (hibernation_testmode(HIBERNATION_TESTPROC))
 648                 goto Thaw;
 649
 650         error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
 651         if (error)
 652                 goto Thaw;
 653
 654         if (in_suspend) {
 655                 unsigned int flags = 0;
 656
 657                 if (hibernation_mode == HIBERNATION_PLATFORM)
 658                         flags |= SF_PLATFORM_MODE;
 659                 if (nocompress)
 660                         flags |= SF_NOCOMPRESS_MODE;
 661                 else
 662                         flags |= SF_CRC32_MODE;
 663
 664                 pr_debug("PM: writing image.\n");
 665                 error = swsusp_write(flags);
 666                 swsusp_free();
 667                 if (!error)
 668                         power_down();
 669                 in_suspend = 0;
 670                 pm_restore_gfp_mask();
 671         } else {
 672                 pr_debug("PM: Image restored successfully.\n");
 673         }
 674
 675  Thaw:
 676         thaw_processes();
 677  Finish:
 678         free_basic_memory_bitmaps();
 679         usermodehelper_enable();
 680  Exit:
 681         pm_notifier_call_chain(PM_POST_HIBERNATION);
 682         pm_restore_console();
 683         atomic_inc(&snapshot_device_available);
 684  Unlock:
 685         mutex_unlock(&pm_mutex);
 686         return error;
 687 }
 688
 689
 690 /**
 691  * software_resume - Resume from a saved hibernation image.
 692  *
 693  * This routine is called as a late initcall, when all devices have been
 694  * discovered and initialized already.
 695  *
 696  * The image reading code is called to see if there is a hibernation image
 697  * available for reading.  If that is the case, devices are quiesced and the
 698  * contents of memory is restored from the saved image.
 699  *
 700  * If this is successful, control reappears in the restored target kernel in
 701  * hibernation_snaphot() which returns to hibernate().  Otherwise, the routine
 702  * attempts to recover gracefully and make the kernel return to the normal mode
 703  * of operation.
 704  */
 705 static int software_resume(void)
 706 {
 707         int error;
 708         unsigned int flags;
 709
 710         /*
 711          * If the user said "noresume".. bail out early.
 712          */
 713         if (noresume)
 714                 return 0;
 715
 716         /*
 717          * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
 718          * is configured into the kernel. Since the regular hibernate
 719          * trigger path is via sysfs which takes a buffer mutex before
 720          * calling hibernate functions (which take pm_mutex) this can
 721          * cause lockdep to complain about a possible ABBA deadlock
 722          * which cannot happen since we're in the boot code here and
 723          * sysfs can't be invoked yet. Therefore, we use a subclass
 724          * here to avoid lockdep complaining.
 725          */
 726         mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING);
 727
 728         if (swsusp_resume_device)
 729                 goto Check_image;
 730
 731         if (!strlen(resume_file)) {
 732                 error = -ENOENT;
 733                 goto Unlock;
 734         }
 735
 736         pr_debug("PM: Checking hibernation image partition %s\n", resume_file);
 737
 738         if (resume_delay) {
 739                 printk(KERN_INFO "Waiting %dsec before reading resume device...\n",
 740                         resume_delay);
 741                 ssleep(resume_delay);
 742         }
 743
 744         /* Check if the device is there */
 745         swsusp_resume_device = name_to_dev_t(resume_file);
 746         if (!swsusp_resume_device) {
 747                 /*
 748                  * Some device discovery might still be in progress; we need
 749                  * to wait for this to finish.
 750                  */
 751                 wait_for_device_probe();
 752
 753                 if (resume_wait) {
 754                         while ((swsusp_resume_device = name_to_dev_t(resume_file)) == 0)
 755                                 msleep(10);
 756                         async_synchronize_full();
 757                 }
 758
 759                 /*
 760                  * We can't depend on SCSI devices being available after loading
 761                  * one of their modules until scsi_complete_async_scans() is
 762                  * called and the resume device usually is a SCSI one.
 763                  */
 764                 scsi_complete_async_scans();
 765
 766                 swsusp_resume_device = name_to_dev_t(resume_file);
 767                 if (!swsusp_resume_device) {
 768                         error = -ENODEV;
 769                         goto Unlock;
 770                 }
 771         }
 772
 773  Check_image:
 774         pr_debug("PM: Hibernation image partition %d:%d present\n",
 775                 MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
 776
 777         pr_debug("PM: Looking for hibernation image.\n");
 778         error = swsusp_check();
 779         if (error)
 780                 goto Unlock;
 781
 782         /* The snapshot device should not be opened while we're running */
 783         if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
 784                 error = -EBUSY;
 785                 swsusp_close(FMODE_READ);
 786                 goto Unlock;
 787         }
 788
 789         pm_prepare_console();
 790         error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
 791         if (error)
 792                 goto close_finish;
 793
 794         error = usermodehelper_disable();
 795         if (error)
 796                 goto close_finish;
 797
 798         error = create_basic_memory_bitmaps();
 799         if (error)
 800                 goto close_finish;
 801
 802         pr_debug("PM: Preparing processes for restore.\n");
 803         error = prepare_processes();
 804         if (error) {
 805                 swsusp_close(FMODE_READ);
 806                 goto Done;
 807         }
 808
 809         pr_debug("PM: Loading hibernation image.\n");
 810
 811         error = swsusp_read(&flags);
 812         swsusp_close(FMODE_READ);
 813         if (!error)
 814                 hibernation_restore(flags & SF_PLATFORM_MODE);
 815
 816         printk(KERN_ERR "PM: Failed to load hibernation image, recovering.\n");
 817         swsusp_free();
 818         thaw_processes();
 819  Done:
 820         free_basic_memory_bitmaps();
 821         usermodehelper_enable();
 822  Finish:
 823         pm_notifier_call_chain(PM_POST_RESTORE);
 824         pm_restore_console();
 825         atomic_inc(&snapshot_device_available);
 826         /* For success case, the suspend path will release the lock */
 827  Unlock:
 828         mutex_unlock(&pm_mutex);
 829         pr_debug("PM: Hibernation image not present or could not be loaded.\n");
 830         return error;
 831 close_finish:
 832         swsusp_close(FMODE_READ);
 833         goto Finish;
 834 }
 835
 836 late_initcall(software_resume);
 837
 838
 839 static const char * const hibernation_modes[] = {
 840         [HIBERNATION_PLATFORM]  = "platform",
 841         [HIBERNATION_SHUTDOWN]  = "shutdown",
 842         [HIBERNATION_REBOOT]    = "reboot",
 843         [HIBERNATION_TEST]      = "test",
 844         [HIBERNATION_TESTPROC]  = "testproc",
 845 };
 846
 847 /*
 848  * /sys/power/disk - Control hibernation mode.
 849  *
 850  * Hibernation can be handled in several ways.  There are a few different ways
 851  * to put the system into the sleep state: using the platform driver (e.g. ACPI
 852  * or other hibernation_ops), powering it off or rebooting it (for testing
 853  * mostly), or using one of the two available test modes.
 854  *
 855  * The sysfs file /sys/power/disk provides an interface for selecting the
 856  * hibernation mode to use.  Reading from this file causes the available modes
 857  * to be printed.  There are 5 modes that can be supported:
 858  *
 859  *      'platform'
 860  *      'shutdown'
 861  *      'reboot'
 862  *      'test'
 863  *      'testproc'
 864  *
 865  * If a platform hibernation driver is in use, 'platform' will be supported
 866  * and will be used by default.  Otherwise, 'shutdown' will be used by default.
 867  * The selected option (i.e. the one corresponding to the current value of
 868  * hibernation_mode) is enclosed by a square bracket.
 869  *
 870  * To select a given hibernation mode it is necessary to write the mode's
 871  * string representation (as returned by reading from /sys/power/disk) back
 872  * into /sys/power/disk.
 873  */
 874
 875 static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
 876                          char *buf)
 877 {
 878         int i;
 879         char *start = buf;
 880
 881         for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
 882                 if (!hibernation_modes[i])
 883                         continue;
 884                 switch (i) {
 885                 case HIBERNATION_SHUTDOWN:
 886                 case HIBERNATION_REBOOT:
 887                 case HIBERNATION_TEST:
 888                 case HIBERNATION_TESTPROC:
 889                         break;
 890                 case HIBERNATION_PLATFORM:
 891                         if (hibernation_ops)
 892                                 break;
 893                         /* not a valid mode, continue with loop */
 894                         continue;
 895                 }
 896                 if (i == hibernation_mode)
 897                         buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
 898                 else
 899                         buf += sprintf(buf, "%s ", hibernation_modes[i]);
 900         }
 901         buf += sprintf(buf, "\n");
 902         return buf-start;
 903 }
 904
 905 static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
 906                           const char *buf, size_t n)
 907 {
 908         int error = 0;
 909         int i;
 910         int len;
 911         char *p;
 912         int mode = HIBERNATION_INVALID;
 913
 914         p = memchr(buf, '\n', n);
 915         len = p ? p - buf : n;
 916
 917         mutex_lock(&pm_mutex);
 918         for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
 919                 if (len == strlen(hibernation_modes[i])
 920                     && !strncmp(buf, hibernation_modes[i], len)) {
 921                         mode = i;
 922                         break;
 923                 }
 924         }
 925         if (mode != HIBERNATION_INVALID) {
 926                 switch (mode) {
 927                 case HIBERNATION_SHUTDOWN:
 928                 case HIBERNATION_REBOOT:
 929                 case HIBERNATION_TEST:
 930                 case HIBERNATION_TESTPROC:
 931                         hibernation_mode = mode;
 932                         break;
 933                 case HIBERNATION_PLATFORM:
 934                         if (hibernation_ops)
 935                                 hibernation_mode = mode;
 936                         else
 937                                 error = -EINVAL;
 938                 }
 939         } else
 940                 error = -EINVAL;
 941
 942         if (!error)
 943                 pr_debug("PM: Hibernation mode set to '%s'\n",
 944                          hibernation_modes[mode]);
 945         mutex_unlock(&pm_mutex);
 946         return error ? error : n;
 947 }
 948
 949 power_attr(disk);
 950
 951 static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
 952                            char *buf)
 953 {
 954         return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
 955                        MINOR(swsusp_resume_device));
 956 }
 957
 958 static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
 959                             const char *buf, size_t n)
 960 {
 961         unsigned int maj, min;
 962         dev_t res;
 963         int ret = -EINVAL;
 964
 965         if (sscanf(buf, "%u:%u", &maj, &min) != 2)
 966                 goto out;
 967
 968         res = MKDEV(maj,min);
 969         if (maj != MAJOR(res) || min != MINOR(res))
 970                 goto out;
 971
 972         mutex_lock(&pm_mutex);
 973         swsusp_resume_device = res;
 974         mutex_unlock(&pm_mutex);
 975         printk(KERN_INFO "PM: Starting manual resume from disk\n");
 976         noresume = 0;
 977         software_resume();
 978         ret = n;
 979  out:
 980         return ret;
 981 }
 982
 983 power_attr(resume);
 984
 985 static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
 986                                char *buf)
 987 {
 988         return sprintf(buf, "%lu\n", image_size);
 989 }
 990
 991 static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
 992                                 const char *buf, size_t n)
 993 {
 994         unsigned long size;
 995
 996         if (sscanf(buf, "%lu", &size) == 1) {
 997                 image_size = size;
 998                 return n;
 999         }
1000
1001         return -EINVAL;
1002 }
1003
1004 power_attr(image_size);
1005
1006 static ssize_t reserved_size_show(struct kobject *kobj,
1007                                   struct kobj_attribute *attr, char *buf)
1008 {
1009         return sprintf(buf, "%lu\n", reserved_size);
1010 }
1011
1012 static ssize_t reserved_size_store(struct kobject *kobj,
1013                                    struct kobj_attribute *attr,
1014                                    const char *buf, size_t n)
1015 {
1016         unsigned long size;
1017
1018         if (sscanf(buf, "%lu", &size) == 1) {
1019                 reserved_size = size;
1020                 return n;
1021         }
1022
1023         return -EINVAL;
1024 }
1025
1026 power_attr(reserved_size);
1027
1028 static struct attribute * g[] = {
1029         &disk_attr.attr,
1030         &resume_attr.attr,
1031         &image_size_attr.attr,
1032         &reserved_size_attr.attr,
1033         NULL,
1034 };
1035
1036
1037 static struct attribute_group attr_group = {
1038         .attrs = g,
1039 };
1040
1041
1042 static int __init pm_disk_init(void)
1043 {
1044         return sysfs_create_group(power_kobj, &attr_group);
1045 }
1046
1047 core_initcall(pm_disk_init);
1048
1049
1050 static int __init resume_setup(char *str)
1051 {
1052         if (noresume)
1053                 return 1;
1054
1055         strncpy( resume_file, str, 255 );
1056         return 1;
1057 }
1058
1059 static int __init resume_offset_setup(char *str)
1060 {
1061         unsigned long long offset;
1062
1063         if (noresume)
1064                 return 1;
1065
1066         if (sscanf(str, "%llu", &offset) == 1)
1067                 swsusp_resume_block = offset;
1068
1069         return 1;
1070 }
1071
1072 static int __init hibernate_setup(char *str)
1073 {
1074         if (!strncmp(str, "noresume", 8))
1075                 noresume = 1;
1076         else if (!strncmp(str, "nocompress", 10))
1077                 nocompress = 1;
1078         return 1;
1079 }
1080
1081 static int __init noresume_setup(char *str)
1082 {
1083         noresume = 1;
1084         return 1;
1085 }
1086
1087 static int __init resumewait_setup(char *str)
1088 {
1089         resume_wait = 1;
1090         return 1;
1091 }
1092
1093 static int __init resumedelay_setup(char *str)
1094 {
1095         resume_delay = simple_strtoul(str, NULL, 0);
1096         return 1;
1097 }
1098
1099 __setup("noresume", noresume_setup);
1100 __setup("resume_offset=", resume_offset_setup);
1101 __setup("resume=", resume_setup);
1102 __setup("hibernate=", hibernate_setup);
1103 __setup("resumewait", resumewait_setup);
1104 __setup("resumedelay=", resumedelay_setup);