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