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 dpm_resume_end(PMSG_RECOVER); 496 } 497 pm_restore_gfp_mask(); 498 ftrace_start(); 499 resume_console(); 500 pm_restore_console(); 501 return error; 502 } 503 504 /** 505 * hibernation_platform_enter - Power off the system using the platform driver. 506 */ 507 int hibernation_platform_enter(void) 508 { 509 int error; 510 511 if (!hibernation_ops) 512 return -ENOSYS; 513 514 /* 515 * We have cancelled the power transition by running 516 * hibernation_ops->finish() before saving the image, so we should let 517 * the firmware know that we're going to enter the sleep state after all 518 */ 519 error = hibernation_ops->begin(); 520 if (error) 521 goto Close; 522 523 entering_platform_hibernation = true; 524 suspend_console(); 525 ftrace_stop(); 526 error = dpm_suspend_start(PMSG_HIBERNATE); 527 if (error) { 528 if (hibernation_ops->recover) 529 hibernation_ops->recover(); 530 goto Resume_devices; 531 } 532 533 error = dpm_suspend_end(PMSG_HIBERNATE); 534 if (error) 535 goto Resume_devices; 536 537 error = hibernation_ops->prepare(); 538 if (error) 539 goto Platform_finish; 540 541 error = disable_nonboot_cpus(); 542 if (error) 543 goto Platform_finish; 544 545 local_irq_disable(); 546 syscore_suspend(); 547 if (pm_wakeup_pending()) { 548 error = -EAGAIN; 549 goto Power_up; 550 } 551 552 hibernation_ops->enter(); 553 /* We should never get here */ 554 while (1); 555 556 Power_up: 557 syscore_resume(); 558 local_irq_enable(); 559 enable_nonboot_cpus(); 560 561 Platform_finish: 562 hibernation_ops->finish(); 563 564 dpm_resume_start(PMSG_RESTORE); 565 566 Resume_devices: 567 entering_platform_hibernation = false; 568 dpm_resume_end(PMSG_RESTORE); 569 ftrace_start(); 570 resume_console(); 571 572 Close: 573 hibernation_ops->end(); 574 575 return error; 576 } 577 578 /** 579 * power_down - Shut the machine down for hibernation. 580 * 581 * Use the platform driver, if configured, to put the system into the sleep 582 * state corresponding to hibernation, or try to power it off or reboot, 583 * depending on the value of hibernation_mode. 584 */ 585 static void power_down(void) 586 { 587 #ifdef CONFIG_SUSPEND 588 int error; 589 #endif 590 591 switch (hibernation_mode) { 592 case HIBERNATION_REBOOT: 593 kernel_restart(NULL); 594 break; 595 case HIBERNATION_PLATFORM: 596 hibernation_platform_enter(); 597 case HIBERNATION_SHUTDOWN: 598 kernel_power_off(); 599 break; 600 #ifdef CONFIG_SUSPEND 601 case HIBERNATION_SUSPEND: 602 error = suspend_devices_and_enter(PM_SUSPEND_MEM); 603 if (error) { 604 if (hibernation_ops) 605 hibernation_mode = HIBERNATION_PLATFORM; 606 else 607 hibernation_mode = HIBERNATION_SHUTDOWN; 608 power_down(); 609 } 610 /* 611 * Restore swap signature. 612 */ 613 error = swsusp_unmark(); 614 if (error) 615 printk(KERN_ERR "PM: Swap will be unusable! " 616 "Try swapon -a.\n"); 617 return; 618 #endif 619 } 620 kernel_halt(); 621 /* 622 * Valid image is on the disk, if we continue we risk serious data 623 * corruption after resume. 624 */ 625 printk(KERN_CRIT "PM: Please power down manually\n"); 626 while(1); 627 } 628 629 /** 630 * hibernate - Carry out system hibernation, including saving the image. 631 */ 632 int hibernate(void) 633 { 634 int error; 635 636 lock_system_sleep(); 637 /* The snapshot device should not be opened while we're running */ 638 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) { 639 error = -EBUSY; 640 goto Unlock; 641 } 642 643 pm_prepare_console(); 644 error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE); 645 if (error) 646 goto Exit; 647 648 printk(KERN_INFO "PM: Syncing filesystems ... "); 649 sys_sync(); 650 printk("done.\n"); 651 652 error = freeze_processes(); 653 if (error) 654 goto Exit; 655 656 lock_device_hotplug(); 657 /* Allocate memory management structures */ 658 error = create_basic_memory_bitmaps(); 659 if (error) 660 goto Thaw; 661 662 error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM); 663 if (error || freezer_test_done) 664 goto Free_bitmaps; 665 666 if (in_suspend) { 667 unsigned int flags = 0; 668 669 if (hibernation_mode == HIBERNATION_PLATFORM) 670 flags |= SF_PLATFORM_MODE; 671 if (nocompress) 672 flags |= SF_NOCOMPRESS_MODE; 673 else 674 flags |= SF_CRC32_MODE; 675 676 pr_debug("PM: writing image.\n"); 677 error = swsusp_write(flags); 678 swsusp_free(); 679 if (!error) 680 power_down(); 681 in_suspend = 0; 682 pm_restore_gfp_mask(); 683 } else { 684 pr_debug("PM: Image restored successfully.\n"); 685 } 686 687 Free_bitmaps: 688 free_basic_memory_bitmaps(); 689 Thaw: 690 unlock_device_hotplug(); 691 thaw_processes(); 692 693 /* Don't bother checking whether freezer_test_done is true */ 694 freezer_test_done = false; 695 Exit: 696 pm_notifier_call_chain(PM_POST_HIBERNATION); 697 pm_restore_console(); 698 atomic_inc(&snapshot_device_available); 699 Unlock: 700 unlock_system_sleep(); 701 return error; 702 } 703 704 705 /** 706 * software_resume - Resume from a saved hibernation image. 707 * 708 * This routine is called as a late initcall, when all devices have been 709 * discovered and initialized already. 710 * 711 * The image reading code is called to see if there is a hibernation image 712 * available for reading. If that is the case, devices are quiesced and the 713 * contents of memory is restored from the saved image. 714 * 715 * If this is successful, control reappears in the restored target kernel in 716 * hibernation_snaphot() which returns to hibernate(). Otherwise, the routine 717 * attempts to recover gracefully and make the kernel return to the normal mode 718 * of operation. 719 */ 720 static int software_resume(void) 721 { 722 int error; 723 unsigned int flags; 724 725 /* 726 * If the user said "noresume".. bail out early. 727 */ 728 if (noresume) 729 return 0; 730 731 /* 732 * name_to_dev_t() below takes a sysfs buffer mutex when sysfs 733 * is configured into the kernel. Since the regular hibernate 734 * trigger path is via sysfs which takes a buffer mutex before 735 * calling hibernate functions (which take pm_mutex) this can 736 * cause lockdep to complain about a possible ABBA deadlock 737 * which cannot happen since we're in the boot code here and 738 * sysfs can't be invoked yet. Therefore, we use a subclass 739 * here to avoid lockdep complaining. 740 */ 741 mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING); 742 743 if (swsusp_resume_device) 744 goto Check_image; 745 746 if (!strlen(resume_file)) { 747 error = -ENOENT; 748 goto Unlock; 749 } 750 751 pr_debug("PM: Checking hibernation image partition %s\n", resume_file); 752 753 if (resume_delay) { 754 printk(KERN_INFO "Waiting %dsec before reading resume device...\n", 755 resume_delay); 756 ssleep(resume_delay); 757 } 758 759 /* Check if the device is there */ 760 swsusp_resume_device = name_to_dev_t(resume_file); 761 762 /* 763 * name_to_dev_t is ineffective to verify parition if resume_file is in 764 * integer format. (e.g. major:minor) 765 */ 766 if (isdigit(resume_file[0]) && resume_wait) { 767 int partno; 768 while (!get_gendisk(swsusp_resume_device, &partno)) 769 msleep(10); 770 } 771 772 if (!swsusp_resume_device) { 773 /* 774 * Some device discovery might still be in progress; we need 775 * to wait for this to finish. 776 */ 777 wait_for_device_probe(); 778 779 if (resume_wait) { 780 while ((swsusp_resume_device = name_to_dev_t(resume_file)) == 0) 781 msleep(10); 782 async_synchronize_full(); 783 } 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 pr_debug("PM: Preparing processes for restore.\n"); 814 error = freeze_processes(); 815 if (error) 816 goto Close_Finish; 817 818 pr_debug("PM: Loading hibernation image.\n"); 819 820 lock_device_hotplug(); 821 error = create_basic_memory_bitmaps(); 822 if (error) 823 goto Thaw; 824 825 error = swsusp_read(&flags); 826 swsusp_close(FMODE_READ); 827 if (!error) 828 hibernation_restore(flags & SF_PLATFORM_MODE); 829 830 printk(KERN_ERR "PM: Failed to load hibernation image, recovering.\n"); 831 swsusp_free(); 832 free_basic_memory_bitmaps(); 833 Thaw: 834 unlock_device_hotplug(); 835 thaw_processes(); 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_sync(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); 1120