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