staging: comedi: comedi_test: remove nano_per_micro
[linux-2.6/btrfs-unstable.git] / kernel / power / hibernate.c
blob690f78f210f2cf4ec9436c9f37a3bbf5eb876397
1 /*
2 * kernel/power/hibernate.c - Hibernation (a.k.a suspend-to-disk) support.
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>
10 * This file is released under the GPLv2.
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 <linux/ktime.h>
32 #include <trace/events/power.h>
34 #include "power.h"
37 static int nocompress;
38 static int noresume;
39 static int nohibernate;
40 static int resume_wait;
41 static unsigned int resume_delay;
42 static char resume_file[256] = CONFIG_PM_STD_PARTITION;
43 dev_t swsusp_resume_device;
44 sector_t swsusp_resume_block;
45 __visible int in_suspend __nosavedata;
47 enum {
48 HIBERNATION_INVALID,
49 HIBERNATION_PLATFORM,
50 HIBERNATION_SHUTDOWN,
51 HIBERNATION_REBOOT,
52 #ifdef CONFIG_SUSPEND
53 HIBERNATION_SUSPEND,
54 #endif
55 /* keep last */
56 __HIBERNATION_AFTER_LAST
58 #define HIBERNATION_MAX (__HIBERNATION_AFTER_LAST-1)
59 #define HIBERNATION_FIRST (HIBERNATION_INVALID + 1)
61 static int hibernation_mode = HIBERNATION_SHUTDOWN;
63 bool freezer_test_done;
65 static const struct platform_hibernation_ops *hibernation_ops;
67 bool hibernation_available(void)
69 return (nohibernate == 0);
72 /**
73 * hibernation_set_ops - Set the global hibernate operations.
74 * @ops: Hibernation operations to use in subsequent hibernation transitions.
76 void hibernation_set_ops(const struct platform_hibernation_ops *ops)
78 if (ops && !(ops->begin && ops->end && ops->pre_snapshot
79 && ops->prepare && ops->finish && ops->enter && ops->pre_restore
80 && ops->restore_cleanup && ops->leave)) {
81 WARN_ON(1);
82 return;
84 lock_system_sleep();
85 hibernation_ops = ops;
86 if (ops)
87 hibernation_mode = HIBERNATION_PLATFORM;
88 else if (hibernation_mode == HIBERNATION_PLATFORM)
89 hibernation_mode = HIBERNATION_SHUTDOWN;
91 unlock_system_sleep();
93 EXPORT_SYMBOL_GPL(hibernation_set_ops);
95 static bool entering_platform_hibernation;
97 bool system_entering_hibernation(void)
99 return entering_platform_hibernation;
101 EXPORT_SYMBOL(system_entering_hibernation);
103 #ifdef CONFIG_PM_DEBUG
104 static void hibernation_debug_sleep(void)
106 printk(KERN_INFO "hibernation debug: Waiting for 5 seconds.\n");
107 mdelay(5000);
110 static int hibernation_test(int level)
112 if (pm_test_level == level) {
113 hibernation_debug_sleep();
114 return 1;
116 return 0;
118 #else /* !CONFIG_PM_DEBUG */
119 static int hibernation_test(int level) { return 0; }
120 #endif /* !CONFIG_PM_DEBUG */
123 * platform_begin - Call platform to start hibernation.
124 * @platform_mode: Whether or not to use the platform driver.
126 static int platform_begin(int platform_mode)
128 return (platform_mode && hibernation_ops) ?
129 hibernation_ops->begin() : 0;
133 * platform_end - Call platform to finish transition to the working state.
134 * @platform_mode: Whether or not to use the platform driver.
136 static void platform_end(int platform_mode)
138 if (platform_mode && hibernation_ops)
139 hibernation_ops->end();
143 * platform_pre_snapshot - Call platform to prepare the machine for hibernation.
144 * @platform_mode: Whether or not to use the platform driver.
146 * Use the platform driver to prepare the system for creating a hibernate image,
147 * if so configured, and return an error code if that fails.
150 static int platform_pre_snapshot(int platform_mode)
152 return (platform_mode && hibernation_ops) ?
153 hibernation_ops->pre_snapshot() : 0;
157 * platform_leave - Call platform to prepare a transition to the working state.
158 * @platform_mode: Whether or not to use the platform driver.
160 * Use the platform driver prepare to prepare the machine for switching to the
161 * normal mode of operation.
163 * This routine is called on one CPU with interrupts disabled.
165 static void platform_leave(int platform_mode)
167 if (platform_mode && hibernation_ops)
168 hibernation_ops->leave();
172 * platform_finish - Call platform to switch the system to the working state.
173 * @platform_mode: Whether or not to use the platform driver.
175 * Use the platform driver to switch the machine to the normal mode of
176 * operation.
178 * This routine must be called after platform_prepare().
180 static void platform_finish(int platform_mode)
182 if (platform_mode && hibernation_ops)
183 hibernation_ops->finish();
187 * platform_pre_restore - Prepare for hibernate image restoration.
188 * @platform_mode: Whether or not to use the platform driver.
190 * Use the platform driver to prepare the system for resume from a hibernation
191 * image.
193 * If the restore fails after this function has been called,
194 * platform_restore_cleanup() must be called.
196 static int platform_pre_restore(int platform_mode)
198 return (platform_mode && hibernation_ops) ?
199 hibernation_ops->pre_restore() : 0;
203 * platform_restore_cleanup - Switch to the working state after failing restore.
204 * @platform_mode: Whether or not to use the platform driver.
206 * Use the platform driver to switch the system to the normal mode of operation
207 * after a failing restore.
209 * If platform_pre_restore() has been called before the failing restore, this
210 * function must be called too, regardless of the result of
211 * platform_pre_restore().
213 static void platform_restore_cleanup(int platform_mode)
215 if (platform_mode && hibernation_ops)
216 hibernation_ops->restore_cleanup();
220 * platform_recover - Recover from a failure to suspend devices.
221 * @platform_mode: Whether or not to use the platform driver.
223 static void platform_recover(int platform_mode)
225 if (platform_mode && hibernation_ops && hibernation_ops->recover)
226 hibernation_ops->recover();
230 * swsusp_show_speed - Print time elapsed between two events during hibernation.
231 * @start: Starting event.
232 * @stop: Final event.
233 * @nr_pages: Number of memory pages processed between @start and @stop.
234 * @msg: Additional diagnostic message to print.
236 void swsusp_show_speed(ktime_t start, ktime_t stop,
237 unsigned nr_pages, char *msg)
239 ktime_t diff;
240 u64 elapsed_centisecs64;
241 unsigned int centisecs;
242 unsigned int k;
243 unsigned int kps;
245 diff = ktime_sub(stop, start);
246 elapsed_centisecs64 = ktime_divns(diff, 10*NSEC_PER_MSEC);
247 centisecs = elapsed_centisecs64;
248 if (centisecs == 0)
249 centisecs = 1; /* avoid div-by-zero */
250 k = nr_pages * (PAGE_SIZE / 1024);
251 kps = (k * 100) / centisecs;
252 printk(KERN_INFO "PM: %s %u kbytes in %u.%02u seconds (%u.%02u MB/s)\n",
253 msg, k,
254 centisecs / 100, centisecs % 100,
255 kps / 1000, (kps % 1000) / 10);
259 * create_image - Create a hibernation image.
260 * @platform_mode: Whether or not to use the platform driver.
262 * Execute device drivers' "late" and "noirq" freeze callbacks, create a
263 * hibernation image and run the drivers' "noirq" and "early" thaw callbacks.
265 * Control reappears in this routine after the subsequent restore.
267 static int create_image(int platform_mode)
269 int error;
271 error = dpm_suspend_end(PMSG_FREEZE);
272 if (error) {
273 printk(KERN_ERR "PM: Some devices failed to power down, "
274 "aborting hibernation\n");
275 return error;
278 error = platform_pre_snapshot(platform_mode);
279 if (error || hibernation_test(TEST_PLATFORM))
280 goto Platform_finish;
282 error = disable_nonboot_cpus();
283 if (error || hibernation_test(TEST_CPUS))
284 goto Enable_cpus;
286 local_irq_disable();
288 error = syscore_suspend();
289 if (error) {
290 printk(KERN_ERR "PM: Some system devices failed to power down, "
291 "aborting hibernation\n");
292 goto Enable_irqs;
295 if (hibernation_test(TEST_CORE) || pm_wakeup_pending())
296 goto Power_up;
298 in_suspend = 1;
299 save_processor_state();
300 trace_suspend_resume(TPS("machine_suspend"), PM_EVENT_HIBERNATE, true);
301 error = swsusp_arch_suspend();
302 trace_suspend_resume(TPS("machine_suspend"), PM_EVENT_HIBERNATE, false);
303 if (error)
304 printk(KERN_ERR "PM: Error %d creating hibernation image\n",
305 error);
306 /* Restore control flow magically appears here */
307 restore_processor_state();
308 if (!in_suspend)
309 events_check_enabled = false;
311 platform_leave(platform_mode);
313 Power_up:
314 syscore_resume();
316 Enable_irqs:
317 local_irq_enable();
319 Enable_cpus:
320 enable_nonboot_cpus();
322 Platform_finish:
323 platform_finish(platform_mode);
325 dpm_resume_start(in_suspend ?
326 (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE);
328 return error;
332 * hibernation_snapshot - Quiesce devices and create a hibernation image.
333 * @platform_mode: If set, use platform driver to prepare for the transition.
335 * This routine must be called with pm_mutex held.
337 int hibernation_snapshot(int platform_mode)
339 pm_message_t msg;
340 int error;
342 error = platform_begin(platform_mode);
343 if (error)
344 goto Close;
346 /* Preallocate image memory before shutting down devices. */
347 error = hibernate_preallocate_memory();
348 if (error)
349 goto Close;
351 error = freeze_kernel_threads();
352 if (error)
353 goto Cleanup;
355 if (hibernation_test(TEST_FREEZER)) {
358 * Indicate to the caller that we are returning due to a
359 * successful freezer test.
361 freezer_test_done = true;
362 goto Thaw;
365 error = dpm_prepare(PMSG_FREEZE);
366 if (error) {
367 dpm_complete(PMSG_RECOVER);
368 goto Thaw;
371 suspend_console();
372 pm_restrict_gfp_mask();
374 error = dpm_suspend(PMSG_FREEZE);
376 if (error || hibernation_test(TEST_DEVICES))
377 platform_recover(platform_mode);
378 else
379 error = create_image(platform_mode);
382 * In the case that we call create_image() above, the control
383 * returns here (1) after the image has been created or the
384 * image creation has failed and (2) after a successful restore.
387 /* We may need to release the preallocated image pages here. */
388 if (error || !in_suspend)
389 swsusp_free();
391 msg = in_suspend ? (error ? PMSG_RECOVER : PMSG_THAW) : PMSG_RESTORE;
392 dpm_resume(msg);
394 if (error || !in_suspend)
395 pm_restore_gfp_mask();
397 resume_console();
398 dpm_complete(msg);
400 Close:
401 platform_end(platform_mode);
402 return error;
404 Thaw:
405 thaw_kernel_threads();
406 Cleanup:
407 swsusp_free();
408 goto Close;
412 * resume_target_kernel - Restore system state from a hibernation image.
413 * @platform_mode: Whether or not to use the platform driver.
415 * Execute device drivers' "noirq" and "late" freeze callbacks, restore the
416 * contents of highmem that have not been restored yet from the image and run
417 * the low-level code that will restore the remaining contents of memory and
418 * switch to the just restored target kernel.
420 static int resume_target_kernel(bool platform_mode)
422 int error;
424 error = dpm_suspend_end(PMSG_QUIESCE);
425 if (error) {
426 printk(KERN_ERR "PM: Some devices failed to power down, "
427 "aborting resume\n");
428 return error;
431 error = platform_pre_restore(platform_mode);
432 if (error)
433 goto Cleanup;
435 error = disable_nonboot_cpus();
436 if (error)
437 goto Enable_cpus;
439 local_irq_disable();
441 error = syscore_suspend();
442 if (error)
443 goto Enable_irqs;
445 save_processor_state();
446 error = restore_highmem();
447 if (!error) {
448 error = swsusp_arch_resume();
450 * The code below is only ever reached in case of a failure.
451 * Otherwise, execution continues at the place where
452 * swsusp_arch_suspend() was called.
454 BUG_ON(!error);
456 * This call to restore_highmem() reverts the changes made by
457 * the previous one.
459 restore_highmem();
462 * The only reason why swsusp_arch_resume() can fail is memory being
463 * very tight, so we have to free it as soon as we can to avoid
464 * subsequent failures.
466 swsusp_free();
467 restore_processor_state();
468 touch_softlockup_watchdog();
470 syscore_resume();
472 Enable_irqs:
473 local_irq_enable();
475 Enable_cpus:
476 enable_nonboot_cpus();
478 Cleanup:
479 platform_restore_cleanup(platform_mode);
481 dpm_resume_start(PMSG_RECOVER);
483 return error;
487 * hibernation_restore - Quiesce devices and restore from a hibernation image.
488 * @platform_mode: If set, use platform driver to prepare for the transition.
490 * This routine must be called with pm_mutex held. If it is successful, control
491 * reappears in the restored target kernel in hibernation_snapshot().
493 int hibernation_restore(int platform_mode)
495 int error;
497 pm_prepare_console();
498 suspend_console();
499 pm_restrict_gfp_mask();
500 error = dpm_suspend_start(PMSG_QUIESCE);
501 if (!error) {
502 error = resume_target_kernel(platform_mode);
504 * The above should either succeed and jump to the new kernel,
505 * or return with an error. Otherwise things are just
506 * undefined, so let's be paranoid.
508 BUG_ON(!error);
510 dpm_resume_end(PMSG_RECOVER);
511 pm_restore_gfp_mask();
512 resume_console();
513 pm_restore_console();
514 return error;
518 * hibernation_platform_enter - Power off the system using the platform driver.
520 int hibernation_platform_enter(void)
522 int error;
524 if (!hibernation_ops)
525 return -ENOSYS;
528 * We have cancelled the power transition by running
529 * hibernation_ops->finish() before saving the image, so we should let
530 * the firmware know that we're going to enter the sleep state after all
532 error = hibernation_ops->begin();
533 if (error)
534 goto Close;
536 entering_platform_hibernation = true;
537 suspend_console();
538 error = dpm_suspend_start(PMSG_HIBERNATE);
539 if (error) {
540 if (hibernation_ops->recover)
541 hibernation_ops->recover();
542 goto Resume_devices;
545 error = dpm_suspend_end(PMSG_HIBERNATE);
546 if (error)
547 goto Resume_devices;
549 error = hibernation_ops->prepare();
550 if (error)
551 goto Platform_finish;
553 error = disable_nonboot_cpus();
554 if (error)
555 goto Enable_cpus;
557 local_irq_disable();
558 syscore_suspend();
559 if (pm_wakeup_pending()) {
560 error = -EAGAIN;
561 goto Power_up;
564 hibernation_ops->enter();
565 /* We should never get here */
566 while (1);
568 Power_up:
569 syscore_resume();
570 local_irq_enable();
572 Enable_cpus:
573 enable_nonboot_cpus();
575 Platform_finish:
576 hibernation_ops->finish();
578 dpm_resume_start(PMSG_RESTORE);
580 Resume_devices:
581 entering_platform_hibernation = false;
582 dpm_resume_end(PMSG_RESTORE);
583 resume_console();
585 Close:
586 hibernation_ops->end();
588 return error;
592 * power_down - Shut the machine down for hibernation.
594 * Use the platform driver, if configured, to put the system into the sleep
595 * state corresponding to hibernation, or try to power it off or reboot,
596 * depending on the value of hibernation_mode.
598 static void power_down(void)
600 #ifdef CONFIG_SUSPEND
601 int error;
602 #endif
604 switch (hibernation_mode) {
605 case HIBERNATION_REBOOT:
606 kernel_restart(NULL);
607 break;
608 case HIBERNATION_PLATFORM:
609 hibernation_platform_enter();
610 case HIBERNATION_SHUTDOWN:
611 if (pm_power_off)
612 kernel_power_off();
613 break;
614 #ifdef CONFIG_SUSPEND
615 case HIBERNATION_SUSPEND:
616 error = suspend_devices_and_enter(PM_SUSPEND_MEM);
617 if (error) {
618 if (hibernation_ops)
619 hibernation_mode = HIBERNATION_PLATFORM;
620 else
621 hibernation_mode = HIBERNATION_SHUTDOWN;
622 power_down();
625 * Restore swap signature.
627 error = swsusp_unmark();
628 if (error)
629 printk(KERN_ERR "PM: Swap will be unusable! "
630 "Try swapon -a.\n");
631 return;
632 #endif
634 kernel_halt();
636 * Valid image is on the disk, if we continue we risk serious data
637 * corruption after resume.
639 printk(KERN_CRIT "PM: Please power down manually\n");
640 while (1)
641 cpu_relax();
645 * hibernate - Carry out system hibernation, including saving the image.
647 int hibernate(void)
649 int error;
651 if (!hibernation_available()) {
652 pr_debug("PM: Hibernation not available.\n");
653 return -EPERM;
656 lock_system_sleep();
657 /* The snapshot device should not be opened while we're running */
658 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
659 error = -EBUSY;
660 goto Unlock;
663 pm_prepare_console();
664 error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
665 if (error)
666 goto Exit;
668 printk(KERN_INFO "PM: Syncing filesystems ... ");
669 sys_sync();
670 printk("done.\n");
672 error = freeze_processes();
673 if (error)
674 goto Exit;
676 lock_device_hotplug();
677 /* Allocate memory management structures */
678 error = create_basic_memory_bitmaps();
679 if (error)
680 goto Thaw;
682 error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
683 if (error || freezer_test_done)
684 goto Free_bitmaps;
686 if (in_suspend) {
687 unsigned int flags = 0;
689 if (hibernation_mode == HIBERNATION_PLATFORM)
690 flags |= SF_PLATFORM_MODE;
691 if (nocompress)
692 flags |= SF_NOCOMPRESS_MODE;
693 else
694 flags |= SF_CRC32_MODE;
696 pr_debug("PM: writing image.\n");
697 error = swsusp_write(flags);
698 swsusp_free();
699 if (!error)
700 power_down();
701 in_suspend = 0;
702 pm_restore_gfp_mask();
703 } else {
704 pr_debug("PM: Image restored successfully.\n");
707 Free_bitmaps:
708 free_basic_memory_bitmaps();
709 Thaw:
710 unlock_device_hotplug();
711 thaw_processes();
713 /* Don't bother checking whether freezer_test_done is true */
714 freezer_test_done = false;
715 Exit:
716 pm_notifier_call_chain(PM_POST_HIBERNATION);
717 pm_restore_console();
718 atomic_inc(&snapshot_device_available);
719 Unlock:
720 unlock_system_sleep();
721 return error;
726 * software_resume - Resume from a saved hibernation image.
728 * This routine is called as a late initcall, when all devices have been
729 * discovered and initialized already.
731 * The image reading code is called to see if there is a hibernation image
732 * available for reading. If that is the case, devices are quiesced and the
733 * contents of memory is restored from the saved image.
735 * If this is successful, control reappears in the restored target kernel in
736 * hibernation_snaphot() which returns to hibernate(). Otherwise, the routine
737 * attempts to recover gracefully and make the kernel return to the normal mode
738 * of operation.
740 static int software_resume(void)
742 int error;
743 unsigned int flags;
746 * If the user said "noresume".. bail out early.
748 if (noresume || !hibernation_available())
749 return 0;
752 * name_to_dev_t() below takes a sysfs buffer mutex when sysfs
753 * is configured into the kernel. Since the regular hibernate
754 * trigger path is via sysfs which takes a buffer mutex before
755 * calling hibernate functions (which take pm_mutex) this can
756 * cause lockdep to complain about a possible ABBA deadlock
757 * which cannot happen since we're in the boot code here and
758 * sysfs can't be invoked yet. Therefore, we use a subclass
759 * here to avoid lockdep complaining.
761 mutex_lock_nested(&pm_mutex, SINGLE_DEPTH_NESTING);
763 if (swsusp_resume_device)
764 goto Check_image;
766 if (!strlen(resume_file)) {
767 error = -ENOENT;
768 goto Unlock;
771 pr_debug("PM: Checking hibernation image partition %s\n", resume_file);
773 if (resume_delay) {
774 printk(KERN_INFO "Waiting %dsec before reading resume device...\n",
775 resume_delay);
776 ssleep(resume_delay);
779 /* Check if the device is there */
780 swsusp_resume_device = name_to_dev_t(resume_file);
783 * name_to_dev_t is ineffective to verify parition if resume_file is in
784 * integer format. (e.g. major:minor)
786 if (isdigit(resume_file[0]) && resume_wait) {
787 int partno;
788 while (!get_gendisk(swsusp_resume_device, &partno))
789 msleep(10);
792 if (!swsusp_resume_device) {
794 * Some device discovery might still be in progress; we need
795 * to wait for this to finish.
797 wait_for_device_probe();
799 if (resume_wait) {
800 while ((swsusp_resume_device = name_to_dev_t(resume_file)) == 0)
801 msleep(10);
802 async_synchronize_full();
805 swsusp_resume_device = name_to_dev_t(resume_file);
806 if (!swsusp_resume_device) {
807 error = -ENODEV;
808 goto Unlock;
812 Check_image:
813 pr_debug("PM: Hibernation image partition %d:%d present\n",
814 MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
816 pr_debug("PM: Looking for hibernation image.\n");
817 error = swsusp_check();
818 if (error)
819 goto Unlock;
821 /* The snapshot device should not be opened while we're running */
822 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
823 error = -EBUSY;
824 swsusp_close(FMODE_READ);
825 goto Unlock;
828 pm_prepare_console();
829 error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
830 if (error)
831 goto Close_Finish;
833 pr_debug("PM: Preparing processes for restore.\n");
834 error = freeze_processes();
835 if (error)
836 goto Close_Finish;
838 pr_debug("PM: Loading hibernation image.\n");
840 lock_device_hotplug();
841 error = create_basic_memory_bitmaps();
842 if (error)
843 goto Thaw;
845 error = swsusp_read(&flags);
846 swsusp_close(FMODE_READ);
847 if (!error)
848 hibernation_restore(flags & SF_PLATFORM_MODE);
850 printk(KERN_ERR "PM: Failed to load hibernation image, recovering.\n");
851 swsusp_free();
852 free_basic_memory_bitmaps();
853 Thaw:
854 unlock_device_hotplug();
855 thaw_processes();
856 Finish:
857 pm_notifier_call_chain(PM_POST_RESTORE);
858 pm_restore_console();
859 atomic_inc(&snapshot_device_available);
860 /* For success case, the suspend path will release the lock */
861 Unlock:
862 mutex_unlock(&pm_mutex);
863 pr_debug("PM: Hibernation image not present or could not be loaded.\n");
864 return error;
865 Close_Finish:
866 swsusp_close(FMODE_READ);
867 goto Finish;
870 late_initcall_sync(software_resume);
873 static const char * const hibernation_modes[] = {
874 [HIBERNATION_PLATFORM] = "platform",
875 [HIBERNATION_SHUTDOWN] = "shutdown",
876 [HIBERNATION_REBOOT] = "reboot",
877 #ifdef CONFIG_SUSPEND
878 [HIBERNATION_SUSPEND] = "suspend",
879 #endif
883 * /sys/power/disk - Control hibernation mode.
885 * Hibernation can be handled in several ways. There are a few different ways
886 * to put the system into the sleep state: using the platform driver (e.g. ACPI
887 * or other hibernation_ops), powering it off or rebooting it (for testing
888 * mostly).
890 * The sysfs file /sys/power/disk provides an interface for selecting the
891 * hibernation mode to use. Reading from this file causes the available modes
892 * to be printed. There are 3 modes that can be supported:
894 * 'platform'
895 * 'shutdown'
896 * 'reboot'
898 * If a platform hibernation driver is in use, 'platform' will be supported
899 * and will be used by default. Otherwise, 'shutdown' will be used by default.
900 * The selected option (i.e. the one corresponding to the current value of
901 * hibernation_mode) is enclosed by a square bracket.
903 * To select a given hibernation mode it is necessary to write the mode's
904 * string representation (as returned by reading from /sys/power/disk) back
905 * into /sys/power/disk.
908 static ssize_t disk_show(struct kobject *kobj, struct kobj_attribute *attr,
909 char *buf)
911 int i;
912 char *start = buf;
914 if (!hibernation_available())
915 return sprintf(buf, "[disabled]\n");
917 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
918 if (!hibernation_modes[i])
919 continue;
920 switch (i) {
921 case HIBERNATION_SHUTDOWN:
922 case HIBERNATION_REBOOT:
923 #ifdef CONFIG_SUSPEND
924 case HIBERNATION_SUSPEND:
925 #endif
926 break;
927 case HIBERNATION_PLATFORM:
928 if (hibernation_ops)
929 break;
930 /* not a valid mode, continue with loop */
931 continue;
933 if (i == hibernation_mode)
934 buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
935 else
936 buf += sprintf(buf, "%s ", hibernation_modes[i]);
938 buf += sprintf(buf, "\n");
939 return buf-start;
942 static ssize_t disk_store(struct kobject *kobj, struct kobj_attribute *attr,
943 const char *buf, size_t n)
945 int error = 0;
946 int i;
947 int len;
948 char *p;
949 int mode = HIBERNATION_INVALID;
951 if (!hibernation_available())
952 return -EPERM;
954 p = memchr(buf, '\n', n);
955 len = p ? p - buf : n;
957 lock_system_sleep();
958 for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
959 if (len == strlen(hibernation_modes[i])
960 && !strncmp(buf, hibernation_modes[i], len)) {
961 mode = i;
962 break;
965 if (mode != HIBERNATION_INVALID) {
966 switch (mode) {
967 case HIBERNATION_SHUTDOWN:
968 case HIBERNATION_REBOOT:
969 #ifdef CONFIG_SUSPEND
970 case HIBERNATION_SUSPEND:
971 #endif
972 hibernation_mode = mode;
973 break;
974 case HIBERNATION_PLATFORM:
975 if (hibernation_ops)
976 hibernation_mode = mode;
977 else
978 error = -EINVAL;
980 } else
981 error = -EINVAL;
983 if (!error)
984 pr_debug("PM: Hibernation mode set to '%s'\n",
985 hibernation_modes[mode]);
986 unlock_system_sleep();
987 return error ? error : n;
990 power_attr(disk);
992 static ssize_t resume_show(struct kobject *kobj, struct kobj_attribute *attr,
993 char *buf)
995 return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
996 MINOR(swsusp_resume_device));
999 static ssize_t resume_store(struct kobject *kobj, struct kobj_attribute *attr,
1000 const char *buf, size_t n)
1002 dev_t res;
1003 int len = n;
1004 char *name;
1006 if (len && buf[len-1] == '\n')
1007 len--;
1008 name = kstrndup(buf, len, GFP_KERNEL);
1009 if (!name)
1010 return -ENOMEM;
1012 res = name_to_dev_t(name);
1013 kfree(name);
1014 if (!res)
1015 return -EINVAL;
1017 lock_system_sleep();
1018 swsusp_resume_device = res;
1019 unlock_system_sleep();
1020 printk(KERN_INFO "PM: Starting manual resume from disk\n");
1021 noresume = 0;
1022 software_resume();
1023 return n;
1026 power_attr(resume);
1028 static ssize_t image_size_show(struct kobject *kobj, struct kobj_attribute *attr,
1029 char *buf)
1031 return sprintf(buf, "%lu\n", image_size);
1034 static ssize_t image_size_store(struct kobject *kobj, struct kobj_attribute *attr,
1035 const char *buf, size_t n)
1037 unsigned long size;
1039 if (sscanf(buf, "%lu", &size) == 1) {
1040 image_size = size;
1041 return n;
1044 return -EINVAL;
1047 power_attr(image_size);
1049 static ssize_t reserved_size_show(struct kobject *kobj,
1050 struct kobj_attribute *attr, char *buf)
1052 return sprintf(buf, "%lu\n", reserved_size);
1055 static ssize_t reserved_size_store(struct kobject *kobj,
1056 struct kobj_attribute *attr,
1057 const char *buf, size_t n)
1059 unsigned long size;
1061 if (sscanf(buf, "%lu", &size) == 1) {
1062 reserved_size = size;
1063 return n;
1066 return -EINVAL;
1069 power_attr(reserved_size);
1071 static struct attribute * g[] = {
1072 &disk_attr.attr,
1073 &resume_attr.attr,
1074 &image_size_attr.attr,
1075 &reserved_size_attr.attr,
1076 NULL,
1080 static struct attribute_group attr_group = {
1081 .attrs = g,
1085 static int __init pm_disk_init(void)
1087 return sysfs_create_group(power_kobj, &attr_group);
1090 core_initcall(pm_disk_init);
1093 static int __init resume_setup(char *str)
1095 if (noresume)
1096 return 1;
1098 strncpy( resume_file, str, 255 );
1099 return 1;
1102 static int __init resume_offset_setup(char *str)
1104 unsigned long long offset;
1106 if (noresume)
1107 return 1;
1109 if (sscanf(str, "%llu", &offset) == 1)
1110 swsusp_resume_block = offset;
1112 return 1;
1115 static int __init hibernate_setup(char *str)
1117 if (!strncmp(str, "noresume", 8))
1118 noresume = 1;
1119 else if (!strncmp(str, "nocompress", 10))
1120 nocompress = 1;
1121 else if (!strncmp(str, "no", 2)) {
1122 noresume = 1;
1123 nohibernate = 1;
1125 return 1;
1128 static int __init noresume_setup(char *str)
1130 noresume = 1;
1131 return 1;
1134 static int __init resumewait_setup(char *str)
1136 resume_wait = 1;
1137 return 1;
1140 static int __init resumedelay_setup(char *str)
1142 int rc = kstrtouint(str, 0, &resume_delay);
1144 if (rc)
1145 return rc;
1146 return 1;
1149 static int __init nohibernate_setup(char *str)
1151 noresume = 1;
1152 nohibernate = 1;
1153 return 1;
1156 static int __init kaslr_nohibernate_setup(char *str)
1158 return nohibernate_setup(str);
1161 __setup("noresume", noresume_setup);
1162 __setup("resume_offset=", resume_offset_setup);
1163 __setup("resume=", resume_setup);
1164 __setup("hibernate=", hibernate_setup);
1165 __setup("resumewait", resumewait_setup);
1166 __setup("resumedelay=", resumedelay_setup);
1167 __setup("nohibernate", nohibernate_setup);
1168 __setup("kaslr", kaslr_nohibernate_setup);