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