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