swsusp: introduce restore platform operations
[safe/jmp/linux-2.6] / kernel / power / disk.c
index f2b3b0e..fa3b43b 100644 (file)
 #include <linux/fs.h>
 #include <linux/mount.h>
 #include <linux/pm.h>
+#include <linux/console.h>
+#include <linux/cpu.h>
+#include <linux/freezer.h>
 
 #include "power.h"
 
 
-extern suspend_disk_method_t pm_disk_mode;
-
-extern int swsusp_shrink_memory(void);
-extern int swsusp_suspend(void);
-extern int swsusp_write(struct pbe *pblist, unsigned int nr_pages);
-extern int swsusp_check(void);
-extern int swsusp_read(struct pbe **pblist_ptr);
-extern void swsusp_close(void);
-extern int swsusp_resume(void);
-
-
 static int noresume = 0;
 char resume_file[256] = CONFIG_PM_STD_PARTITION;
 dev_t swsusp_resume_device;
+sector_t swsusp_resume_block;
+
+enum {
+       HIBERNATION_INVALID,
+       HIBERNATION_PLATFORM,
+       HIBERNATION_TEST,
+       HIBERNATION_TESTPROC,
+       HIBERNATION_SHUTDOWN,
+       HIBERNATION_REBOOT,
+       /* keep last */
+       __HIBERNATION_AFTER_LAST
+};
+#define HIBERNATION_MAX (__HIBERNATION_AFTER_LAST-1)
+#define HIBERNATION_FIRST (HIBERNATION_INVALID + 1)
+
+static int hibernation_mode = HIBERNATION_SHUTDOWN;
+
+static struct hibernation_ops *hibernation_ops;
 
 /**
- *     power_down - Shut machine down for hibernate.
- *     @mode:          Suspend-to-disk mode
- *
- *     Use the platform driver, if configured so, and return gracefully if it
- *     fails.
- *     Otherwise, try to power off and reboot. If they fail, halt the machine,
- *     there ain't no turning back.
+ * hibernation_set_ops - set the global hibernate operations
+ * @ops: the hibernation operations to use in subsequent hibernation transitions
  */
 
-static void power_down(suspend_disk_method_t mode)
+void hibernation_set_ops(struct hibernation_ops *ops)
 {
-       int error = 0;
-
-       switch(mode) {
-       case PM_DISK_PLATFORM:
-               kernel_power_off_prepare();
-               error = pm_ops->enter(PM_SUSPEND_DISK);
-               break;
-       case PM_DISK_SHUTDOWN:
-               kernel_power_off();
-               break;
-       case PM_DISK_REBOOT:
-               kernel_restart(NULL);
-               break;
+       if (ops && !(ops->prepare && ops->enter && ops->finish
+           && ops->pre_restore && ops->restore_cleanup)) {
+               WARN_ON(1);
+               return;
        }
-       kernel_halt();
-       /* Valid image is on the disk, if we continue we risk serious data corruption
-          after resume. */
-       printk(KERN_CRIT "Please power me down manually\n");
-       while(1);
+       mutex_lock(&pm_mutex);
+       hibernation_ops = ops;
+       if (ops)
+               hibernation_mode = HIBERNATION_PLATFORM;
+       else if (hibernation_mode == HIBERNATION_PLATFORM)
+               hibernation_mode = HIBERNATION_SHUTDOWN;
+
+       mutex_unlock(&pm_mutex);
+}
+
+
+/**
+ *     platform_prepare - prepare the machine for hibernation using the
+ *     platform driver if so configured and return an error code if it fails
+ */
+
+static int platform_prepare(int platform_mode)
+{
+       return (platform_mode && hibernation_ops) ?
+               hibernation_ops->prepare() : 0;
 }
 
+/**
+ *     platform_finish - switch the machine to the normal mode of operation
+ *     using the platform driver (must be called after platform_prepare())
+ */
 
-static int in_suspend __nosavedata = 0;
+static void platform_finish(int platform_mode)
+{
+       if (platform_mode && hibernation_ops)
+               hibernation_ops->finish();
+}
 
+/**
+ *     platform_pre_restore - prepare the platform for the restoration from a
+ *     hibernation image.  If the restore fails after this function has been
+ *     called, platform_restore_cleanup() must be called.
+ */
 
-static inline void platform_finish(void)
+static int platform_pre_restore(int platform_mode)
 {
-       if (pm_disk_mode == PM_DISK_PLATFORM) {
-               if (pm_ops && pm_ops->finish)
-                       pm_ops->finish(PM_SUSPEND_DISK);
-       }
+       return (platform_mode && hibernation_ops) ?
+               hibernation_ops->pre_restore() : 0;
 }
 
-static int prepare_processes(void)
+/**
+ *     platform_restore_cleanup - switch the platform to the normal mode of
+ *     operation after a failing restore.  If platform_pre_restore() has been
+ *     called before the failing restore, this function must be called too,
+ *     regardless of the result of platform_pre_restore().
+ */
+
+static void platform_restore_cleanup(int platform_mode)
+{
+       if (platform_mode && hibernation_ops)
+               hibernation_ops->restore_cleanup();
+}
+
+/**
+ *     hibernation_snapshot - quiesce devices and create the hibernation
+ *     snapshot image.
+ *     @platform_mode - if set, use the platform driver, if available, to
+ *                      prepare the platform frimware for the power transition.
+ *
+ *     Must be called with pm_mutex held
+ */
+
+int hibernation_snapshot(int platform_mode)
 {
        int error;
 
-       pm_prepare_console();
-       sys_sync();
-       disable_nonboot_cpus();
+       /* Free memory before shutting down devices. */
+       error = swsusp_shrink_memory();
+       if (error)
+               goto Finish;
 
-       if (freeze_processes()) {
-               error = -EBUSY;
-               goto thaw;
-       }
+       error = platform_prepare(platform_mode);
+       if (error)
+               goto Finish;
 
-       if (pm_disk_mode == PM_DISK_PLATFORM) {
-               if (pm_ops && pm_ops->prepare) {
-                       if ((error = pm_ops->prepare(PM_SUSPEND_DISK)))
-                               goto thaw;
+       suspend_console();
+       error = device_suspend(PMSG_FREEZE);
+       if (error)
+               goto Resume_devices;
+
+       error = disable_nonboot_cpus();
+       if (!error) {
+               if (hibernation_mode != HIBERNATION_TEST) {
+                       in_suspend = 1;
+                       error = swsusp_suspend();
+                       /* Control returns here after successful restore */
+               } else {
+                       printk("swsusp debug: Waiting for 5 seconds.\n");
+                       mdelay(5000);
                }
        }
-
-       /* Free memory before shutting down devices. */
-       if (!(error = swsusp_shrink_memory()))
-               return 0;
-thaw:
-       thaw_processes();
        enable_nonboot_cpus();
+ Resume_devices:
+       platform_finish(platform_mode);
+       device_resume();
+       resume_console();
+ Finish:
+       return error;
+}
+
+/**
+ *     hibernation_restore - quiesce devices and restore the hibernation
+ *     snapshot image.  If successful, control returns in hibernation_snaphot()
+ *     @platform_mode - if set, use the platform driver, if available, to
+ *                      prepare the platform frimware for the transition.
+ *
+ *     Must be called with pm_mutex held
+ */
+
+int hibernation_restore(int platform_mode)
+{
+       int error;
+
+       pm_prepare_console();
+       suspend_console();
+       error = device_suspend(PMSG_PRETHAW);
+       if (error)
+               goto Finish;
+
+       error = platform_pre_restore(platform_mode);
+       if (!error) {
+               error = disable_nonboot_cpus();
+               if (!error)
+                       error = swsusp_resume();
+               enable_nonboot_cpus();
+       }
+       platform_restore_cleanup(platform_mode);
+ Finish:
+       device_resume();
+       resume_console();
        pm_restore_console();
        return error;
 }
 
+/**
+ *     hibernation_platform_enter - enter the hibernation state using the
+ *     platform driver (if available)
+ */
+
+int hibernation_platform_enter(void)
+{
+       if (hibernation_ops) {
+               kernel_shutdown_prepare(SYSTEM_SUSPEND_DISK);
+               return hibernation_ops->enter();
+       } else {
+               return -ENOSYS;
+       }
+}
+
+/**
+ *     power_down - Shut the machine down for hibernation.
+ *
+ *     Use the platform driver, if configured so; otherwise try
+ *     to power off or reboot.
+ */
+
+static void power_down(void)
+{
+       switch (hibernation_mode) {
+       case HIBERNATION_TEST:
+       case HIBERNATION_TESTPROC:
+               break;
+       case HIBERNATION_SHUTDOWN:
+               kernel_power_off();
+               break;
+       case HIBERNATION_REBOOT:
+               kernel_restart(NULL);
+               break;
+       case HIBERNATION_PLATFORM:
+               hibernation_platform_enter();
+       }
+       kernel_halt();
+       /*
+        * Valid image is on the disk, if we continue we risk serious data
+        * corruption after resume.
+        */
+       printk(KERN_CRIT "Please power me down manually\n");
+       while(1);
+}
+
 static void unprepare_processes(void)
 {
-       platform_finish();
        thaw_processes();
-       enable_nonboot_cpus();
        pm_restore_console();
 }
 
+static int prepare_processes(void)
+{
+       int error = 0;
+
+       pm_prepare_console();
+       if (freeze_processes()) {
+               error = -EBUSY;
+               unprepare_processes();
+       }
+       return error;
+}
+
 /**
- *     pm_suspend_disk - The granpappy of power management.
- *
- *     If we're going through the firmware, then get it over with quickly.
- *
- *     If not, then call swsusp to do its thing, then figure out how
- *     to power down the system.
+ *     hibernate - The granpappy of the built-in hibernation management
  */
 
-int pm_suspend_disk(void)
+int hibernate(void)
 {
        int error;
 
+       /* The snapshot device should not be opened while we're running */
+       if (!atomic_add_unless(&snapshot_device_available, -1, 0))
+               return -EBUSY;
+
+       /* Allocate memory management structures */
+       error = create_basic_memory_bitmaps();
+       if (error)
+               goto Exit;
+
        error = prepare_processes();
        if (error)
-               return error;
+               goto Finish;
 
-       error = device_suspend(PMSG_FREEZE);
-       if (error) {
-               printk("Some devices failed to suspend\n");
-               unprepare_processes();
-               return error;
+       mutex_lock(&pm_mutex);
+       if (hibernation_mode == HIBERNATION_TESTPROC) {
+               printk("swsusp debug: Waiting for 5 seconds.\n");
+               mdelay(5000);
+               goto Thaw;
        }
+       error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
+       if (in_suspend && !error) {
+               unsigned int flags = 0;
 
-       pr_debug("PM: snapshotting memory.\n");
-       in_suspend = 1;
-       if ((error = swsusp_suspend()))
-               goto Done;
-
-       if (in_suspend) {
-               device_resume();
+               if (hibernation_mode == HIBERNATION_PLATFORM)
+                       flags |= SF_PLATFORM_MODE;
                pr_debug("PM: writing image.\n");
-               error = swsusp_write(pagedir_nosave, nr_copy_pages);
+               error = swsusp_write(flags);
+               swsusp_free();
                if (!error)
-                       power_down(pm_disk_mode);
-               else {
-                       swsusp_free();
-                       unprepare_processes();
-                       return error;
-               }
-       } else
+                       power_down();
+       } else {
                pr_debug("PM: Image restored successfully.\n");
-
-       swsusp_free();
Done:
-       device_resume();
+               swsusp_free();
+       }
Thaw:
+       mutex_unlock(&pm_mutex);
        unprepare_processes();
+ Finish:
+       free_basic_memory_bitmaps();
+ Exit:
+       atomic_inc(&snapshot_device_available);
        return error;
 }
 
@@ -177,7 +321,7 @@ int pm_suspend_disk(void)
  *     Called as a late_initcall (so all devices are discovered and
  *     initialized), we call swsusp to see if we have a saved image or not.
  *     If so, we quiesce devices, the restore the saved image. We will
- *     return above (in pm_suspend_disk() ) if everything goes well.
+ *     return above (in hibernate() ) if everything goes well.
  *     Otherwise, we fail gracefully and return to the normally
  *     scheduled program.
  *
@@ -186,11 +330,12 @@ int pm_suspend_disk(void)
 static int software_resume(void)
 {
        int error;
+       unsigned int flags;
 
-       down(&pm_sem);
+       mutex_lock(&pm_mutex);
        if (!swsusp_resume_device) {
                if (!strlen(resume_file)) {
-                       up(&pm_sem);
+                       mutex_unlock(&pm_mutex);
                        return -ENOENT;
                }
                swsusp_resume_device = name_to_dev_t(resume_file);
@@ -205,141 +350,171 @@ static int software_resume(void)
                 * FIXME: If noresume is specified, we need to find the partition
                 * and reset it back to normal swap space.
                 */
-               up(&pm_sem);
+               mutex_unlock(&pm_mutex);
                return 0;
        }
 
        pr_debug("PM: Checking swsusp image.\n");
+       error = swsusp_check();
+       if (error)
+               goto Unlock;
 
-       if ((error = swsusp_check()))
-               goto Done;
+       /* The snapshot device should not be opened while we're running */
+       if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
+               error = -EBUSY;
+               goto Unlock;
+       }
 
-       pr_debug("PM: Preparing processes for restore.\n");
+       error = create_basic_memory_bitmaps();
+       if (error)
+               goto Finish;
 
-       if ((error = prepare_processes())) {
+       pr_debug("PM: Preparing processes for restore.\n");
+       error = prepare_processes();
+       if (error) {
                swsusp_close();
                goto Done;
        }
 
        pr_debug("PM: Reading swsusp image.\n");
 
-       if ((error = swsusp_read(&pagedir_nosave))) {
-               swsusp_free();
-               goto Thaw;
-       }
-
-       pr_debug("PM: Preparing devices for restore.\n");
+       error = swsusp_read(&flags);
+       if (!error)
+               hibernation_restore(flags & SF_PLATFORM_MODE);
 
-       if ((error = device_suspend(PMSG_FREEZE))) {
-               printk("Some devices failed to suspend\n");
-               swsusp_free();
-               goto Thaw;
-       }
-
-       mb();
-
-       pr_debug("PM: Restoring saved image.\n");
-       swsusp_resume();
-       pr_debug("PM: Restore failed, recovering.n");
-       device_resume();
- Thaw:
+       printk(KERN_ERR "PM: Restore failed, recovering.\n");
+       swsusp_free();
        unprepare_processes();
  Done:
+       free_basic_memory_bitmaps();
+ Finish:
+       atomic_inc(&snapshot_device_available);
        /* For success case, the suspend path will release the lock */
-       up(&pm_sem);
+ Unlock:
+       mutex_unlock(&pm_mutex);
        pr_debug("PM: Resume from disk failed.\n");
-       return 0;
+       return error;
 }
 
 late_initcall(software_resume);
 
 
-static char * pm_disk_modes[] = {
-       [PM_DISK_FIRMWARE]      = "firmware",
-       [PM_DISK_PLATFORM]      = "platform",
-       [PM_DISK_SHUTDOWN]      = "shutdown",
-       [PM_DISK_REBOOT]        = "reboot",
+static const char * const hibernation_modes[] = {
+       [HIBERNATION_PLATFORM]  = "platform",
+       [HIBERNATION_SHUTDOWN]  = "shutdown",
+       [HIBERNATION_REBOOT]    = "reboot",
+       [HIBERNATION_TEST]      = "test",
+       [HIBERNATION_TESTPROC]  = "testproc",
 };
 
 /**
- *     disk - Control suspend-to-disk mode
+ *     disk - Control hibernation mode
  *
- *     Suspend-to-disk can be handled in several ways. The greatest
- *     distinction is who writes memory to disk - the firmware or the OS.
- *     If the firmware does it, we assume that it also handles suspending
- *     the system.
- *     If the OS does it, then we have three options for putting the system
- *     to sleep - using the platform driver (e.g. ACPI or other PM registers),
- *     powering off the system or rebooting the system (for testing).
+ *     Suspend-to-disk can be handled in several ways. We have a few options
+ *     for putting the system to sleep - using the platform driver (e.g. ACPI
+ *     or other hibernation_ops), powering off the system or rebooting the
+ *     system (for testing) as well as the two test modes.
  *
- *     The system will support either 'firmware' or 'platform', and that is
- *     known a priori (and encoded in pm_ops). But, the user may choose
- *     'shutdown' or 'reboot' as alternatives.
+ *     The system can support 'platform', and that is known a priori (and
+ *     encoded by the presence of hibernation_ops). However, the user may
+ *     choose 'shutdown' or 'reboot' as alternatives, as well as one fo the
+ *     test modes, 'test' or 'testproc'.
  *
  *     show() will display what the mode is currently set to.
  *     store() will accept one of
  *
- *     'firmware'
  *     'platform'
  *     'shutdown'
  *     'reboot'
+ *     'test'
+ *     'testproc'
  *
- *     It will only change to 'firmware' or 'platform' if the system
- *     supports it (as determined from pm_ops->pm_disk_mode).
+ *     It will only change to 'platform' if the system
+ *     supports it (as determined by having hibernation_ops).
  */
 
-static ssize_t disk_show(struct subsystem * subsys, char * buf)
+static ssize_t disk_show(struct kset *kset, char *buf)
 {
-       return sprintf(buf, "%s\n", pm_disk_modes[pm_disk_mode]);
+       int i;
+       char *start = buf;
+
+       for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
+               if (!hibernation_modes[i])
+                       continue;
+               switch (i) {
+               case HIBERNATION_SHUTDOWN:
+               case HIBERNATION_REBOOT:
+               case HIBERNATION_TEST:
+               case HIBERNATION_TESTPROC:
+                       break;
+               case HIBERNATION_PLATFORM:
+                       if (hibernation_ops)
+                               break;
+                       /* not a valid mode, continue with loop */
+                       continue;
+               }
+               if (i == hibernation_mode)
+                       buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
+               else
+                       buf += sprintf(buf, "%s ", hibernation_modes[i]);
+       }
+       buf += sprintf(buf, "\n");
+       return buf-start;
 }
 
 
-static ssize_t disk_store(struct subsystem * s, const char * buf, size_t n)
+static ssize_t disk_store(struct kset *kset, const char *buf, size_t n)
 {
        int error = 0;
        int i;
        int len;
        char *p;
-       suspend_disk_method_t mode = 0;
+       int mode = HIBERNATION_INVALID;
 
        p = memchr(buf, '\n', n);
        len = p ? p - buf : n;
 
-       down(&pm_sem);
-       for (i = PM_DISK_FIRMWARE; i < PM_DISK_MAX; i++) {
-               if (!strncmp(buf, pm_disk_modes[i], len)) {
+       mutex_lock(&pm_mutex);
+       for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
+               if (len == strlen(hibernation_modes[i])
+                   && !strncmp(buf, hibernation_modes[i], len)) {
                        mode = i;
                        break;
                }
        }
-       if (mode) {
-               if (mode == PM_DISK_SHUTDOWN || mode == PM_DISK_REBOOT)
-                       pm_disk_mode = mode;
-               else {
-                       if (pm_ops && pm_ops->enter &&
-                           (mode == pm_ops->pm_disk_mode))
-                               pm_disk_mode = mode;
+       if (mode != HIBERNATION_INVALID) {
+               switch (mode) {
+               case HIBERNATION_SHUTDOWN:
+               case HIBERNATION_REBOOT:
+               case HIBERNATION_TEST:
+               case HIBERNATION_TESTPROC:
+                       hibernation_mode = mode;
+                       break;
+               case HIBERNATION_PLATFORM:
+                       if (hibernation_ops)
+                               hibernation_mode = mode;
                        else
                                error = -EINVAL;
                }
        } else
                error = -EINVAL;
 
-       pr_debug("PM: suspend-to-disk mode set to '%s'\n",
-                pm_disk_modes[mode]);
-       up(&pm_sem);
+       if (!error)
+               pr_debug("PM: suspend-to-disk mode set to '%s'\n",
+                        hibernation_modes[mode]);
+       mutex_unlock(&pm_mutex);
        return error ? error : n;
 }
 
 power_attr(disk);
 
-static ssize_t resume_show(struct subsystem * subsys, char *buf)
+static ssize_t resume_show(struct kset *kset, char *buf)
 {
        return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
                       MINOR(swsusp_resume_device));
 }
 
-static ssize_t resume_store(struct subsystem *subsys, const char *buf, size_t n)
+static ssize_t resume_store(struct kset *kset, const char *buf, size_t n)
 {
        unsigned int maj, min;
        dev_t res;
@@ -352,25 +527,25 @@ static ssize_t resume_store(struct subsystem *subsys, const char *buf, size_t n)
        if (maj != MAJOR(res) || min != MINOR(res))
                goto out;
 
-       down(&pm_sem);
+       mutex_lock(&pm_mutex);
        swsusp_resume_device = res;
-       up(&pm_sem);
+       mutex_unlock(&pm_mutex);
        printk("Attempting manual resume\n");
        noresume = 0;
        software_resume();
        ret = n;
-out:
+ out:
        return ret;
 }
 
 power_attr(resume);
 
-static ssize_t image_size_show(struct subsystem * subsys, char *buf)
+static ssize_t image_size_show(struct kset *kset, char *buf)
 {
        return sprintf(buf, "%lu\n", image_size);
 }
 
-static ssize_t image_size_store(struct subsystem * subsys, const char * buf, size_t n)
+static ssize_t image_size_store(struct kset *kset, const char *buf, size_t n)
 {
        unsigned long size;
 
@@ -399,7 +574,7 @@ static struct attribute_group attr_group = {
 
 static int __init pm_disk_init(void)
 {
-       return sysfs_create_group(&power_subsys.kset.kobj,&attr_group);
+       return sysfs_create_group(&power_subsys.kobj, &attr_group);
 }
 
 core_initcall(pm_disk_init);
@@ -414,6 +589,19 @@ static int __init resume_setup(char *str)
        return 1;
 }
 
+static int __init resume_offset_setup(char *str)
+{
+       unsigned long long offset;
+
+       if (noresume)
+               return 1;
+
+       if (sscanf(str, "%llu", &offset) == 1)
+               swsusp_resume_block = offset;
+
+       return 1;
+}
+
 static int __init noresume_setup(char *str)
 {
        noresume = 1;
@@ -421,4 +609,5 @@ static int __init noresume_setup(char *str)
 }
 
 __setup("noresume", noresume_setup);
+__setup("resume_offset=", resume_offset_setup);
 __setup("resume=", resume_setup);