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