kernel/power/disk.c

   1 /*
   2  * kernel/power/disk.c - 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@suse.cz>
   7  *
   8  * This file is released under the GPLv2.
   9  *
  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/delay.h>
  18 #include <linux/fs.h>
  19 #include <linux/device.h>
  20 #include "power.h"
  21
  22
  23 extern suspend_disk_method_t pm_disk_mode;
  24 extern struct pm_ops * pm_ops;
  25
  26 extern int swsusp_suspend(void);
  27 extern int swsusp_write(void);
  28 extern int swsusp_read(void);
  29 extern int swsusp_resume(void);
  30 extern int swsusp_free(void);
  31
  32
  33 static int noresume = 0;
  34 char resume_file[256] = CONFIG_PM_STD_PARTITION;
  35
  36 /**
  37  *      power_down - Shut machine down for hibernate.
  38  *      @mode:          Suspend-to-disk mode
  39  *
  40  *      Use the platform driver, if configured so, and return gracefully if it
  41  *      fails.
  42  *      Otherwise, try to power off and reboot. If they fail, halt the machine,
  43  *      there ain't no turning back.
  44  */
  45
  46 static void power_down(suspend_disk_method_t mode)
  47 {
  48         unsigned long flags;
  49         int error = 0;
  50
  51         local_irq_save(flags);
  52         switch(mode) {
  53         case PM_DISK_PLATFORM:
  54                 device_power_down(PM_SUSPEND_DISK);
  55                 error = pm_ops->enter(PM_SUSPEND_DISK);
  56                 break;
  57         case PM_DISK_SHUTDOWN:
  58                 printk("Powering off system\n");
  59                 device_shutdown();
  60                 machine_power_off();
  61                 break;
  62         case PM_DISK_REBOOT:
  63                 device_shutdown();
  64                 machine_restart(NULL);
  65                 break;
  66         }
  67         machine_halt();
  68         /* Valid image is on the disk, if we continue we risk serious data corruption
  69            after resume. */
  70         printk(KERN_CRIT "Please power me down manually\n");
  71         while(1);
  72 }
  73
  74
  75 static int in_suspend __nosavedata = 0;
  76
  77
  78 /**
  79  *      free_some_memory -  Try to free as much memory as possible
  80  *
  81  *      ... but do not OOM-kill anyone
  82  *
  83  *      Notice: all userland should be stopped at this point, or
  84  *      livelock is possible.
  85  */
  86
  87 static void free_some_memory(void)
  88 {
  89         unsigned int i = 0;
  90         unsigned int tmp;
  91         unsigned long pages = 0;
  92         char *p = "-\\|/";
  93
  94         printk("Freeing memory...  ");
  95         while ((tmp = shrink_all_memory(10000))) {
  96                 pages += tmp;
  97                 printk("\b%c", p[i]);
  98                 i++;
  99                 if (i > 3)
 100                         i = 0;
 101         }
 102         printk("\bdone (%li pages freed)\n", pages);
 103 }
 104
 105
 106 static inline void platform_finish(void)
 107 {
 108         if (pm_disk_mode == PM_DISK_PLATFORM) {
 109                 if (pm_ops && pm_ops->finish)
 110                         pm_ops->finish(PM_SUSPEND_DISK);
 111         }
 112 }
 113
 114 static void finish(void)
 115 {
 116         device_resume();
 117         platform_finish();
 118         enable_nonboot_cpus();
 119         thaw_processes();
 120         pm_restore_console();
 121 }
 122
 123
 124 static int prepare(void)
 125 {
 126         int error;
 127
 128         pm_prepare_console();
 129
 130         sys_sync();
 131         if (freeze_processes()) {
 132                 error = -EBUSY;
 133                 goto Thaw;
 134         }
 135
 136         if (pm_disk_mode == PM_DISK_PLATFORM) {
 137                 if (pm_ops && pm_ops->prepare) {
 138                         if ((error = pm_ops->prepare(PM_SUSPEND_DISK)))
 139                                 goto Thaw;
 140                 }
 141         }
 142
 143         /* Free memory before shutting down devices. */
 144         free_some_memory();
 145
 146         disable_nonboot_cpus();
 147         if ((error = device_suspend(PM_SUSPEND_DISK)))
 148                 goto Finish;
 149
 150         return 0;
 151  Finish:
 152         platform_finish();
 153  Thaw:
 154         enable_nonboot_cpus();
 155         thaw_processes();
 156         pm_restore_console();
 157         return error;
 158 }
 159
 160
 161 /**
 162  *      pm_suspend_disk - The granpappy of power management.
 163  *
 164  *      If we're going through the firmware, then get it over with quickly.
 165  *
 166  *      If not, then call swsusp to do it's thing, then figure out how
 167  *      to power down the system.
 168  */
 169
 170 int pm_suspend_disk(void)
 171 {
 172         int error;
 173
 174         if ((error = prepare()))
 175                 return error;
 176
 177         pr_debug("PM: Attempting to suspend to disk.\n");
 178         if (pm_disk_mode == PM_DISK_FIRMWARE)
 179                 return pm_ops->enter(PM_SUSPEND_DISK);
 180
 181         pr_debug("PM: snapshotting memory.\n");
 182         in_suspend = 1;
 183         if ((error = swsusp_suspend()))
 184                 goto Done;
 185
 186         if (in_suspend) {
 187                 pr_debug("PM: writing image.\n");
 188                 error = swsusp_write();
 189                 if (!error)
 190                         power_down(pm_disk_mode);
 191         } else
 192                 pr_debug("PM: Image restored successfully.\n");
 193         swsusp_free();
 194  Done:
 195         finish();
 196         return error;
 197 }
 198
 199
 200 /**
 201  *      software_resume - Resume from a saved image.
 202  *
 203  *      Called as a late_initcall (so all devices are discovered and
 204  *      initialized), we call pmdisk to see if we have a saved image or not.
 205  *      If so, we quiesce devices, the restore the saved image. We will
 206  *      return above (in pm_suspend_disk() ) if everything goes well.
 207  *      Otherwise, we fail gracefully and return to the normally
 208  *      scheduled program.
 209  *
 210  */
 211
 212 static int software_resume(void)
 213 {
 214         int error;
 215
 216         if (noresume) {
 217                 /**
 218                  * FIXME: If noresume is specified, we need to find the partition
 219                  * and reset it back to normal swap space.
 220                  */
 221                 return 0;
 222         }
 223
 224         pr_debug("PM: Reading pmdisk image.\n");
 225
 226         if ((error = swsusp_read()))
 227                 goto Done;
 228
 229         pr_debug("PM: Preparing system for restore.\n");
 230
 231         if ((error = prepare()))
 232                 goto Free;
 233
 234         barrier();
 235         mb();
 236
 237         pr_debug("PM: Restoring saved image.\n");
 238         swsusp_resume();
 239         pr_debug("PM: Restore failed, recovering.n");
 240         finish();
 241  Free:
 242         swsusp_free();
 243  Done:
 244         pr_debug("PM: Resume from disk failed.\n");
 245         return 0;
 246 }
 247
 248 late_initcall(software_resume);
 249
 250
 251 static char * pm_disk_modes[] = {
 252         [PM_DISK_FIRMWARE]      = "firmware",
 253         [PM_DISK_PLATFORM]      = "platform",
 254         [PM_DISK_SHUTDOWN]      = "shutdown",
 255         [PM_DISK_REBOOT]        = "reboot",
 256 };
 257
 258 /**
 259  *      disk - Control suspend-to-disk mode
 260  *
 261  *      Suspend-to-disk can be handled in several ways. The greatest
 262  *      distinction is who writes memory to disk - the firmware or the OS.
 263  *      If the firmware does it, we assume that it also handles suspending
 264  *      the system.
 265  *      If the OS does it, then we have three options for putting the system
 266  *      to sleep - using the platform driver (e.g. ACPI or other PM registers),
 267  *      powering off the system or rebooting the system (for testing).
 268  *
 269  *      The system will support either 'firmware' or 'platform', and that is
 270  *      known a priori (and encoded in pm_ops). But, the user may choose
 271  *      'shutdown' or 'reboot' as alternatives.
 272  *
 273  *      show() will display what the mode is currently set to.
 274  *      store() will accept one of
 275  *
 276  *      'firmware'
 277  *      'platform'
 278  *      'shutdown'
 279  *      'reboot'
 280  *
 281  *      It will only change to 'firmware' or 'platform' if the system
 282  *      supports it (as determined from pm_ops->pm_disk_mode).
 283  */
 284
 285 static ssize_t disk_show(struct subsystem * subsys, char * buf)
 286 {
 287         return sprintf(buf,"%s\n",pm_disk_modes[pm_disk_mode]);
 288 }
 289
 290
 291 static ssize_t disk_store(struct subsystem * s, const char * buf, size_t n)
 292 {
 293         int error = 0;
 294         int i;
 295         int len;
 296         char *p;
 297         suspend_disk_method_t mode = 0;
 298
 299         p = memchr(buf, '\n', n);
 300         len = p ? p - buf : n;
 301
 302         down(&pm_sem);
 303         for (i = PM_DISK_FIRMWARE; i < PM_DISK_MAX; i++) {
 304                 if (!strncmp(buf, pm_disk_modes[i], len)) {
 305                         mode = i;
 306                         break;
 307                 }
 308         }
 309         if (mode) {
 310                 if (mode == PM_DISK_SHUTDOWN || mode == PM_DISK_REBOOT)
 311                         pm_disk_mode = mode;
 312                 else {
 313                         if (pm_ops && pm_ops->enter &&
 314                             (mode == pm_ops->pm_disk_mode))
 315                                 pm_disk_mode = mode;
 316                         else
 317                                 error = -EINVAL;
 318                 }
 319         } else
 320                 error = -EINVAL;
 321
 322         pr_debug("PM: suspend-to-disk mode set to '%s'\n",
 323                  pm_disk_modes[mode]);
 324         up(&pm_sem);
 325         return error ? error : n;
 326 }
 327
 328 power_attr(disk);
 329
 330 static struct attribute * g[] = {
 331         &disk_attr.attr,
 332         NULL,
 333 };
 334
 335
 336 static struct attribute_group attr_group = {
 337         .attrs = g,
 338 };
 339
 340
 341 static int __init pm_disk_init(void)
 342 {
 343         return sysfs_create_group(&power_subsys.kset.kobj,&attr_group);
 344 }
 345
 346 core_initcall(pm_disk_init);
 347
 348
 349 static int __init resume_setup(char *str)
 350 {
 351         if (noresume)
 352                 return 1;
 353
 354         strncpy( resume_file, str, 255 );
 355         return 1;
 356 }
 357
 358 static int __init noresume_setup(char *str)
 359 {
 360         noresume = 1;
 361         return 1;
 362 }
 363
 364 __setup("noresume", noresume_setup);
 365 __setup("resume=", resume_setup);