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 #include <scsi/scsi_scan.h>
  32
  33 #include "power.h"
  34
  35
  36 static int nocompress;
  37 static int noresume;
  38 static int resume_wait;
  39 static int resume_delay;
  40 static char resume_file[256] = CONFIG_PM_STD_PARTITION;
  41 dev_t swsusp_resume_device;
  42 sector_t swsusp_resume_block;
  43 int in_suspend __nosavedata;
  44
  45 enum {
  46         HIBERNATION_INVALID,
  47         HIBERNATION_PLATFORM,
  48         HIBERNATION_SHUTDOWN,
  49         HIBERNATION_REBOOT,
  50 #ifdef CONFIG_SUSPEND
  51         HIBERNATION_SUSPEND,
  52 #endif
  53         /* keep last */
  54         __HIBERNATION_AFTER_LAST
  55 };
  56 #define HIBERNATION_MAX (__HIBERNATION_AFTER_LAST-1)
  57 #define HIBERNATION_FIRST (HIBERNATION_INVALID + 1)
  58
  59 static int hibernation_mode = HIBERNATION_SHUTDOWN;
  60
  61 bool freezer_test_done;
  62
  63 static const struct platform_hibernation_ops *hibernation_ops;
  64
  65 /**
  66  * hibernation_set_ops - Set the global hibernate operations.
  67  * @ops: Hibernation operations to use in subsequent hibernation transitions.
  68  */
  69 void hibernation_set_ops(const struct platform_hibernation_ops *ops)
  70 {
  71         if (ops && !(ops->begin && ops->end &&  ops->pre_snapshot
  72             && ops->prepare && ops->finish && ops->enter && ops->pre_restore
  73             && ops->restore_cleanup && ops->leave)) {
  74                 WARN_ON(1);
  75                 return;
  76         }
  77         lock_system_sleep();
  78         hibernation_ops = ops;
  79         if (ops)
  80                 hibernation_mode = HIBERNATION_PLATFORM;
  81         else if (hibernation_mode == HIBERNATION_PLATFORM)
  82                 hibernation_mode = HIBERNATION_SHUTDOWN;
  83
  84         unlock_system_sleep();
  85 }
  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                 platform_leave(platform_mode);
 300         }
 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         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         resume_console();
 387         dpm_complete(msg);
 388
 389  Close:
 390         platform_end(platform_mode);
 391         return error;
 392
 393  Thaw:
 394         thaw_kernel_threads();
 395  Cleanup:
 396         swsusp_free();
 397         goto Close;
 398 }
 399
 400 /**
 401  * resume_target_kernel - Restore system state from a hibernation image.
 402  * @platform_mode: Whether or not to use the platform driver.
 403  *
 404  * Execute device drivers' "noirq" and "late" freeze callbacks, restore the
 405  * contents of highmem that have not been restored yet from the image and run
 406  * the low-level code that will restore the remaining contents of memory and
 407  * switch to the just restored target kernel.
 408  */
 409 static int resume_target_kernel(bool platform_mode)
 410 {
 411         int error;
 412
 413         error = dpm_suspend_end(PMSG_QUIESCE);
 414         if (error) {
 415                 printk(KERN_ERR "PM: Some devices failed to power down, "
 416                         "aborting resume\n");
 417                 return error;
 418         }
 419
 420         error = platform_pre_restore(platform_mode);
 421         if (error)
 422                 goto Cleanup;
 423
 424         error = disable_nonboot_cpus();
 425         if (error)
 426                 goto Enable_cpus;
 427
 428         local_irq_disable();
 429
 430         error = syscore_suspend();
 431         if (error)
 432                 goto Enable_irqs;
 433
 434         save_processor_state();
 435         error = restore_highmem();
 436         if (!error) {
 437                 error = swsusp_arch_resume();
 438                 /*
 439                  * The code below is only ever reached in case of a failure.
 440                  * Otherwise, execution continues at the place where
 441                  * swsusp_arch_suspend() was called.
 442                  */
 443                 BUG_ON(!error);
 444                 /*
 445                  * This call to restore_highmem() reverts the changes made by
 446                  * the previous one.
 447                  */
 448                 restore_highmem();
 449         }
 450         /*
 451          * The only reason why swsusp_arch_resume() can fail is memory being
 452          * very tight, so we have to free it as soon as we can to avoid
 453          * subsequent failures.
 454          */
 455         swsusp_free();
 456         restore_processor_state();
 457         touch_softlockup_watchdog();
 458
 459         syscore_resume();
 460
 461  Enable_irqs:
 462         local_irq_enable();
 463
 464  Enable_cpus:
 465         enable_nonboot_cpus();
 466
 467  Cleanup:
 468         platform_restore_cleanup(platform_mode);
 469
 470         dpm_resume_start(PMSG_RECOVER);
 471
 472         return error;
 473 }
 474
 475 /**
 476  * hibernation_restore - Quiesce devices and restore from a hibernation image.
 477  * @platform_mode: If set, use platform driver to prepare for the transition.
 478  *
 479  * This routine must be called with pm_mutex held.  If it is successful, control
 480  * reappears in the restored target kernel in hibernation_snapshot().
 481  */
 482 int hibernation_restore(int platform_mode)
 483 {
 484         int error;
 485
 486         pm_prepare_console();
 487         suspend_console();
 488         pm_restrict_gfp_mask();
 489         error = dpm_suspend_start(PMSG_QUIESCE);
 490         if (!error) {
 491                 error = resume_target_kernel(platform_mode);
 492                 dpm_resume_end(PMSG_RECOVER);
 493         }
 494         pm_restore_gfp_mask();
 495         resume_console();
 496         pm_restore_console();
 497         return error;
 498 }
 499
 500 /**
 501  * hibernation_platform_enter - Power off the system using the platform driver.
 502  */
 503 int hibernation_platform_enter(void)
 504 {
 505         int error;
 506
 507         if (!hibernation_ops)
 508                 return -ENOSYS;
 509
 510         /*
 511          * We have cancelled the power transition by running
 512          * hibernation_ops->finish() before saving the image, so we should let
 513          * the firmware know that we're going to enter the sleep state after all
 514          */
 515         error = hibernation_ops->begin();
 516         if (error)
 517                 goto Close;
 518
 519         entering_platform_hibernation = true;
 520         suspend_console();
 521         error = dpm_suspend_start(PMSG_HIBERNATE);
 522         if (error) {
 523                 if (hibernation_ops->recover)
 524                         hibernation_ops->recover();
 525                 goto Resume_devices;
 526         }
 527
 528         error = dpm_suspend_end(PMSG_HIBERNATE);
 529         if (error)
 530                 goto Resume_devices;
 531
 532         error = hibernation_ops->prepare();
 533         if (error)
 534                 goto Platform_finish;
 535
 536         error = disable_nonboot_cpus();
 537         if (error)
 538                 goto Platform_finish;
 539
 540         local_irq_disable();
 541         syscore_suspend();
 542         if (pm_wakeup_pending()) {
 543                 error = -EAGAIN;
 544                 goto Power_up;
 545         }
 546
 547         hibernation_ops->enter();
 548         /* We should never get here */
 549         while (1);
 550
 551  Power_up:
 552         syscore_resume();
 553         local_irq_enable();
 554         enable_nonboot_cpus();
 555
 556  Platform_finish:
 557         hibernation_ops->finish();
 558
 559         dpm_resume_start(PMSG_RESTORE);
 560
 561  Resume_devices:
 562         entering_platform_hibernation = false;
 563         dpm_resume_end(PMSG_RESTORE);
 564         resume_console();
 565
 566  Close:
 567         hibernation_ops->end();
 568
 569         return error;
 570 }
 571
 572 /**
 573  * power_down - Shut the machine down for hibernation.
 574  *
 575  * Use the platform driver, if configured, to put the system into the sleep
 576  * state corresponding to hibernation, or try to power it off or reboot,
 577  * depending on the value of hibernation_mode.
 578  */
 579 static void power_down(void)
 580 {
 581 #ifdef CONFIG_SUSPEND
 582         int error;
 583 #endif
 584
 585         switch (hibernation_mode) {
 586         case HIBERNATION_REBOOT:
 587                 kernel_restart(NULL);
 588                 break;
 589         case HIBERNATION_PLATFORM:
 590                 hibernation_platform_enter();
 591         case HIBERNATION_SHUTDOWN:
 592                 kernel_power_off();
 593                 break;
 594 #ifdef CONFIG_SUSPEND
 595         case HIBERNATION_SUSPEND:
 596                 error = suspend_devices_and_enter(PM_SUSPEND_MEM);
 597                 if (error) {
 598                         if (hibernation_ops)
 599                                 hibernation_mode = HIBERNATION_PLATFORM;
 600                         else
 601                                 hibernation_mode = HIBERNATION_SHUTDOWN;
 602                         power_down();
 603                 }
 604                 /*
 605                  * Restore swap signature.
 606                  */
 607                 error = swsusp_unmark();
 608                 if (error)
 609                         printk(KERN_ERR "PM: Swap will be unusable! "
 610                                         "Try swapon -a.\n");
 611                 return;
 612 #endif
 613         }
 614         kernel_halt();
 615         /*
 616          * Valid image is on the disk, if we continue we risk serious data
 617          * corruption after resume.
 618          */
 619         printk(KERN_CRIT "PM: Please power down manually\n");
 620         while(1);
 621 }
 622
 623 /**
 624  * hibernate - Carry out system hibernation, including saving the image.
 625  */
 626 int hibernate(void)
 627 {
 628         int error;
 629
 630         lock_system_sleep();
 631         /* The snapshot device should not be opened while we're running */
 632         if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
 633                 error = -EBUSY;
 634                 goto Unlock;
 635         }
 636
 637         pm_prepare_console();
 638         error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
 639         if (error)
 640                 goto Exit;
 641
 642         /* Allocate memory management structures */
 643         error = create_basic_memory_bitmaps();
 644         if (error)
 645                 goto Exit;
 646
 647         printk(KERN_INFO "PM: Syncing filesystems ... ");
 648         sys_sync();
 649         printk("done.\n");
 650
 651         error = freeze_processes();
 652         if (error)
 653                 goto Free_bitmaps;
 654
 655         error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
 656         if (error || freezer_test_done)
 657                 goto Thaw;
 658
 659         if (in_suspend) {
 660                 unsigned int flags = 0;
 661
 662                 if (hibernation_mode == HIBERNATION_PLATFORM)
 663                         flags |= SF_PLATFORM_MODE;
 664                 if (nocompress)
 665                         flags |= SF_NOCOMPRESS_MODE;
 666                 else
 667                         flags |= SF_CRC32_MODE;
 668
 669                 pr_debug("PM: writing image.\n");
 670                 error = swsusp_write(flags);
 671                 swsusp_free();
 672                 if (!error)
 673                         power_down();
 674                 in_suspend = 0;
 675                 pm_restore_gfp_mask();
 676         } else {
 677                 pr_debug("PM: Image restored successfully.\n");
 678         }
 679
 680  Thaw:
 681         thaw_processes();
 682
 683         /* Don't bother checking whether freezer_test_done is true */
 684         freezer_test_done = false;
 685
 686  Free_bitmaps:
 687         free_basic_memory_bitmaps();
 688  Exit:
 689         pm_notifier_call_chain(PM_POST_HIBERNATION);
 690         pm_restore_console();
 691         atomic_inc(&snapshot_device_available);
 692  Unlock:
 693         unlock_system_sleep();
 694         return error;
 695 }
 696
 697
 698 /**
 699  * software_resume - Resume from a saved hibernation image.
 700  *
 701  * This routine is called as a late initcall, when all devices have been
 702  * discovered and initialized already.
 703  *
 704  * The image reading code is called to see if there is a hibernation image
 705  * available for reading.  If that is the case, devices are quiesced and the
 706  * contents of memory is restored from the saved image.
 707  *
 708  * If this is successful, control reappears in the restored target kernel in
 709  * hibernation_snaphot() which returns to hibernate().  Otherwise, the routine
 710  * attempts to recover gracefully and make the kernel return to the normal mode
 711  * of operation.
 712  */
 713 static int software_resume(void)
 714 {
 715         int error;
 716         unsigned int flags;
 717
 718         /*
 719          * If the user said "noresume".. bail out early.
 720          */
 721         if (noresume)
 722                 return 0;
 723
 724         /*
 725          * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
 726          * is configured into the kernel. Since the regular hibernate
 727          * trigger path is via sysfs which takes a buffer mutex before
 728          * calling hibernate functions (which take pm_mutex) this can
 729          * cause lockdep to complain about a possible ABBA deadlock
 730          * which cannot happen since we're in the boot code here and
 731          * sysfs can't be invoked yet. Therefore, we use a subclass
 732          * here to avoid lockdep complaining.
 733          */
 734         mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING);
 735
 736         if (swsusp_resume_device)
 737                 goto Check_image;
 738
 739         if (!strlen(resume_file)) {
 740                 error = -ENOENT;
 741                 goto Unlock;
 742         }
 743
 744         pr_debug("PM: Checking hibernation image partition %s\n", resume_file);
 745
 746         if (resume_delay) {
 747                 printk(KERN_INFO "Waiting %dsec before reading resume device...\n",
 748                         resume_delay);
 749                 ssleep(resume_delay);
 750         }
 751
 752         /* Check if the device is there */
 753         swsusp_resume_device = name_to_dev_t(resume_file);
 754
 755         /*
 756          * name_to_dev_t is ineffective to verify parition if resume_file is in
 757          * integer format. (e.g. major:minor)
 758          */
 759         if (isdigit(resume_file[0]) && resume_wait) {
 760                 int partno;
 761                 while (!get_gendisk(swsusp_resume_device, &partno))
 762                         msleep(10);
 763         }
 764
 765         if (!swsusp_resume_device) {
 766                 /*
 767                  * Some device discovery might still be in progress; we need
 768                  * to wait for this to finish.
 769                  */
 770                 wait_for_device_probe();
 771
 772                 if (resume_wait) {
 773                         while ((swsusp_resume_device = name_to_dev_t(resume_file)) == 0)
 774                                 msleep(10);
 775                         async_synchronize_full();
 776                 }
 777
 778                 /*
 779                  * We can't depend on SCSI devices being available after loading
 780                  * one of their modules until scsi_complete_async_scans() is
 781                  * called and the resume device usually is a SCSI one.
 782                  */
 783                 scsi_complete_async_scans();
 784
 785                 swsusp_resume_device = name_to_dev_t(resume_file);
 786                 if (!swsusp_resume_device) {
 787                         error = -ENODEV;
 788                         goto Unlock;
 789                 }
 790         }
 791
 792  Check_image:
 793         pr_debug("PM: Hibernation image partition %d:%d present\n",
 794                 MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
 795
 796         pr_debug("PM: Looking for hibernation image.\n");
 797         error = swsusp_check();
 798         if (error)
 799                 goto Unlock;
 800
 801         /* The snapshot device should not be opened while we're running */
 802         if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
 803                 error = -EBUSY;
 804                 swsusp_close(FMODE_READ);
 805                 goto Unlock;
 806         }
 807
 808         pm_prepare_console();
 809         error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
 810         if (error)
 811                 goto close_finish;
 812
 813         error = create_basic_memory_bitmaps();
 814         if (error)
 815                 goto close_finish;
 816
 817         pr_debug("PM: Preparing processes for restore.\n");
 818         error = freeze_processes();
 819         if (error) {
 820                 swsusp_close(FMODE_READ);
 821                 goto Done;
 822         }
 823
 824         pr_debug("PM: Loading hibernation image.\n");
 825
 826         error = swsusp_read(&flags);
 827         swsusp_close(FMODE_READ);
 828         if (!error)
 829                 hibernation_restore(flags & SF_PLATFORM_MODE);
 830
 831         printk(KERN_ERR "PM: Failed to load hibernation image, recovering.\n");
 832         swsusp_free();
 833         thaw_processes();
 834  Done:
 835         free_basic_memory_bitmaps();
 836  Finish:
 837         pm_notifier_call_chain(PM_POST_RESTORE);
 838         pm_restore_console();
 839         atomic_inc(&snapshot_device_available);
 840         /* For success case, the suspend path will release the lock */
 841  Unlock:
 842         mutex_unlock(&pm_mutex);
 843         pr_debug("PM: Hibernation image not present or could not be loaded.\n");
 844         return error;
 845 close_finish:
 846         swsusp_close(FMODE_READ);
 847         goto Finish;
 848 }
 849
 850 late_initcall(software_resume);
 851
 852
 853 static const char * const hibernation_modes[] = {
 854         [HIBERNATION_PLATFORM]  = "platform",
 855         [HIBERNATION_SHUTDOWN]  = "shutdown",
 856         [HIBERNATION_REBOOT]    = "reboot",
 857 #ifdef CONFIG_SUSPEND
 858         [HIBERNATION_SUSPEND]   = "suspend",
 859 #endif
 860 };
 861
 862 /*
 863  * /sys/power/disk - Control hibernation mode.
 864  *
 865  * Hibernation can be handled in several ways.  There are a few different ways
 866  * to put the system into the sleep state: using the platform driver (e.g. ACPI
 867  * or other hibernation_ops), powering it off or rebooting it (for testing
 868  * mostly).
 869  *
 870  * The sysfs file /sys/power/disk provides an interface for selecting the
 871  * hibernation mode to use.  Reading from this file causes the available modes
 872  * to be printed.  There are 3 modes that can be supported:
 873  *
 874  *      'platform'
 875  *      'shutdown'
 876  *      'reboot'
 877  *
 878  * If a platform hibernation driver is in use, 'platform' will be supported
 879  * and will be used by default.  Otherwise, 'shutdown' will be used by default.
 880  * The selected option (i.e. the one corresponding to the current value of
 881  * hibernation_mode) is enclosed by a square bracket.
 882  *
 883  * To select a given hibernation mode it is necessary to write the mode's
 884  * string representation (as returned by reading from /sys/power/disk) back
 885  * into /sys/power/disk.
 886  */
 887
 888 static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
 889                          char *buf)
 890 {
 891         int i;
 892         char *start = buf;
 893
 894         for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
 895                 if (!hibernation_modes[i])
 896                         continue;
 897                 switch (i) {
 898                 case HIBERNATION_SHUTDOWN:
 899                 case HIBERNATION_REBOOT:
 900 #ifdef CONFIG_SUSPEND
 901                 case HIBERNATION_SUSPEND:
 902 #endif
 903                         break;
 904                 case HIBERNATION_PLATFORM:
 905                         if (hibernation_ops)
 906                                 break;
 907                         /* not a valid mode, continue with loop */
 908                         continue;
 909                 }
 910                 if (i == hibernation_mode)
 911                         buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
 912                 else
 913                         buf += sprintf(buf, "%s ", hibernation_modes[i]);
 914         }
 915         buf += sprintf(buf, "\n");
 916         return buf-start;
 917 }
 918
 919 static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
 920                           const char *buf, size_t n)
 921 {
 922         int error = 0;
 923         int i;
 924         int len;
 925         char *p;
 926         int mode = HIBERNATION_INVALID;
 927
 928         p = memchr(buf, '\n', n);
 929         len = p ? p - buf : n;
 930
 931         lock_system_sleep();
 932         for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
 933                 if (len == strlen(hibernation_modes[i])
 934                     && !strncmp(buf, hibernation_modes[i], len)) {
 935                         mode = i;
 936                         break;
 937                 }
 938         }
 939         if (mode != HIBERNATION_INVALID) {
 940                 switch (mode) {
 941                 case HIBERNATION_SHUTDOWN:
 942                 case HIBERNATION_REBOOT:
 943 #ifdef CONFIG_SUSPEND
 944                 case HIBERNATION_SUSPEND:
 945 #endif
 946                         hibernation_mode = mode;
 947                         break;
 948                 case HIBERNATION_PLATFORM:
 949                         if (hibernation_ops)
 950                                 hibernation_mode = mode;
 951                         else
 952                                 error = -EINVAL;
 953                 }
 954         } else
 955                 error = -EINVAL;
 956
 957         if (!error)
 958                 pr_debug("PM: Hibernation mode set to '%s'\n",
 959                          hibernation_modes[mode]);
 960         unlock_system_sleep();
 961         return error ? error : n;
 962 }
 963
 964 power_attr(disk);
 965
 966 static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
 967                            char *buf)
 968 {
 969         return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
 970                        MINOR(swsusp_resume_device));
 971 }
 972
 973 static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
 974                             const char *buf, size_t n)
 975 {
 976         unsigned int maj, min;
 977         dev_t res;
 978         int ret = -EINVAL;
 979
 980         if (sscanf(buf, "%u:%u", &maj, &min) != 2)
 981                 goto out;
 982
 983         res = MKDEV(maj,min);
 984         if (maj != MAJOR(res) || min != MINOR(res))
 985                 goto out;
 986
 987         lock_system_sleep();
 988         swsusp_resume_device = res;
 989         unlock_system_sleep();
 990         printk(KERN_INFO "PM: Starting manual resume from disk\n");
 991         noresume = 0;
 992         software_resume();
 993         ret = n;
 994  out:
 995         return ret;
 996 }
 997
 998 power_attr(resume);
 999
1000 static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
1001                                char *buf)
1002 {
1003         return sprintf(buf, "%lu\n", image_size);
1004 }
1005
1006 static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
1007                                 const char *buf, size_t n)
1008 {
1009         unsigned long size;
1010
1011         if (sscanf(buf, "%lu", &size) == 1) {
1012                 image_size = size;
1013                 return n;
1014         }
1015
1016         return -EINVAL;
1017 }
1018
1019 power_attr(image_size);
1020
1021 static ssize_t reserved_size_show(struct kobject *kobj,
1022                                   struct kobj_attribute *attr, char *buf)
1023 {
1024         return sprintf(buf, "%lu\n", reserved_size);
1025 }
1026
1027 static ssize_t reserved_size_store(struct kobject *kobj,
1028                                    struct kobj_attribute *attr,
1029                                    const char *buf, size_t n)
1030 {
1031         unsigned long size;
1032
1033         if (sscanf(buf, "%lu", &size) == 1) {
1034                 reserved_size = size;
1035                 return n;
1036         }
1037
1038         return -EINVAL;
1039 }
1040
1041 power_attr(reserved_size);
1042
1043 static struct attribute * g[] = {
1044         &disk_attr.attr,
1045         &resume_attr.attr,
1046         &image_size_attr.attr,
1047         &reserved_size_attr.attr,
1048         NULL,
1049 };
1050
1051
1052 static struct attribute_group attr_group = {
1053         .attrs = g,
1054 };
1055
1056
1057 static int __init pm_disk_init(void)
1058 {
1059         return sysfs_create_group(power_kobj, &attr_group);
1060 }
1061
1062 core_initcall(pm_disk_init);
1063
1064
1065 static int __init resume_setup(char *str)
1066 {
1067         if (noresume)
1068                 return 1;
1069
1070         strncpy( resume_file, str, 255 );
1071         return 1;
1072 }
1073
1074 static int __init resume_offset_setup(char *str)
1075 {
1076         unsigned long long offset;
1077
1078         if (noresume)
1079                 return 1;
1080
1081         if (sscanf(str, "%llu", &offset) == 1)
1082                 swsusp_resume_block = offset;
1083
1084         return 1;
1085 }
1086
1087 static int __init hibernate_setup(char *str)
1088 {
1089         if (!strncmp(str, "noresume", 8))
1090                 noresume = 1;
1091         else if (!strncmp(str, "nocompress", 10))
1092                 nocompress = 1;
1093         return 1;
1094 }
1095
1096 static int __init noresume_setup(char *str)
1097 {
1098         noresume = 1;
1099         return 1;
1100 }
1101
1102 static int __init resumewait_setup(char *str)
1103 {
1104         resume_wait = 1;
1105         return 1;
1106 }
1107
1108 static int __init resumedelay_setup(char *str)
1109 {
1110         resume_delay = simple_strtoul(str, NULL, 0);
1111         return 1;
1112 }
1113
1114 __setup("noresume", noresume_setup);
1115 __setup("resume_offset=", resume_offset_setup);
1116 __setup("resume=", resume_setup);
1117 __setup("hibernate=", hibernate_setup);
1118 __setup("resumewait", resumewait_setup);
1119 __setup("resumedelay=", resumedelay_setup);