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 #include <linux/pm.h>
  21 #include <linux/console.h>
  22 #include <linux/cpu.h>
  23 #include <linux/freezer.h>
  24
  25 #include "power.h"
  26
  27
  28 static int noresume = 0;
  29 char resume_file[256] = CONFIG_PM_STD_PARTITION;
  30 dev_t swsusp_resume_device;
  31 sector_t swsusp_resume_block;
  32
  33 enum {
  34         HIBERNATION_INVALID,
  35         HIBERNATION_PLATFORM,
  36         HIBERNATION_TEST,
  37         HIBERNATION_TESTPROC,
  38         HIBERNATION_SHUTDOWN,
  39         HIBERNATION_REBOOT,
  40         /* keep last */
  41         __HIBERNATION_AFTER_LAST
  42 };
  43 #define HIBERNATION_MAX (__HIBERNATION_AFTER_LAST-1)
  44 #define HIBERNATION_FIRST (HIBERNATION_INVALID + 1)
  45
  46 static int hibernation_mode = HIBERNATION_SHUTDOWN;
  47
  48 static struct platform_hibernation_ops *hibernation_ops;
  49
  50 /**
  51  * hibernation_set_ops - set the global hibernate operations
  52  * @ops: the hibernation operations to use in subsequent hibernation transitions
  53  */
  54
  55 void hibernation_set_ops(struct platform_hibernation_ops *ops)
  56 {
  57         if (ops && !(ops->start && ops->pre_snapshot && ops->finish
  58             && ops->prepare && ops->enter && ops->pre_restore
  59             && ops->restore_cleanup)) {
  60                 WARN_ON(1);
  61                 return;
  62         }
  63         mutex_lock(&pm_mutex);
  64         hibernation_ops = ops;
  65         if (ops)
  66                 hibernation_mode = HIBERNATION_PLATFORM;
  67         else if (hibernation_mode == HIBERNATION_PLATFORM)
  68                 hibernation_mode = HIBERNATION_SHUTDOWN;
  69
  70         mutex_unlock(&pm_mutex);
  71 }
  72
  73 /**
  74  *      platform_start - tell the platform driver that we're starting
  75  *      hibernation
  76  */
  77
  78 static int platform_start(int platform_mode)
  79 {
  80         return (platform_mode && hibernation_ops) ?
  81                 hibernation_ops->start() : 0;
  82 }
  83
  84 /**
  85  *      platform_pre_snapshot - prepare the machine for hibernation using the
  86  *      platform driver if so configured and return an error code if it fails
  87  */
  88
  89 static int platform_pre_snapshot(int platform_mode)
  90 {
  91         return (platform_mode && hibernation_ops) ?
  92                 hibernation_ops->pre_snapshot() : 0;
  93 }
  94
  95 /**
  96  *      platform_leave - prepare the machine for switching to the normal mode
  97  *      of operation using the platform driver (called with interrupts disabled)
  98  */
  99
 100 static void platform_leave(int platform_mode)
 101 {
 102         if (platform_mode && hibernation_ops)
 103                 hibernation_ops->leave();
 104 }
 105
 106 /**
 107  *      platform_finish - switch the machine to the normal mode of operation
 108  *      using the platform driver (must be called after platform_prepare())
 109  */
 110
 111 static void platform_finish(int platform_mode)
 112 {
 113         if (platform_mode && hibernation_ops)
 114                 hibernation_ops->finish();
 115 }
 116
 117 /**
 118  *      platform_pre_restore - prepare the platform for the restoration from a
 119  *      hibernation image.  If the restore fails after this function has been
 120  *      called, platform_restore_cleanup() must be called.
 121  */
 122
 123 static int platform_pre_restore(int platform_mode)
 124 {
 125         return (platform_mode && hibernation_ops) ?
 126                 hibernation_ops->pre_restore() : 0;
 127 }
 128
 129 /**
 130  *      platform_restore_cleanup - switch the platform to the normal mode of
 131  *      operation after a failing restore.  If platform_pre_restore() has been
 132  *      called before the failing restore, this function must be called too,
 133  *      regardless of the result of platform_pre_restore().
 134  */
 135
 136 static void platform_restore_cleanup(int platform_mode)
 137 {
 138         if (platform_mode && hibernation_ops)
 139                 hibernation_ops->restore_cleanup();
 140 }
 141
 142 /**
 143  *      create_image - freeze devices that need to be frozen with interrupts
 144  *      off, create the hibernation image and thaw those devices.  Control
 145  *      reappears in this routine after a restore.
 146  */
 147
 148 int create_image(int platform_mode)
 149 {
 150         int error;
 151
 152         error = arch_prepare_suspend();
 153         if (error)
 154                 return error;
 155
 156         local_irq_disable();
 157         /* At this point, device_suspend() has been called, but *not*
 158          * device_power_down(). We *must* call device_power_down() now.
 159          * Otherwise, drivers for some devices (e.g. interrupt controllers)
 160          * become desynchronized with the actual state of the hardware
 161          * at resume time, and evil weirdness ensues.
 162          */
 163         error = device_power_down(PMSG_FREEZE);
 164         if (error) {
 165                 printk(KERN_ERR "Some devices failed to power down, "
 166                         KERN_ERR "aborting suspend\n");
 167                 goto Enable_irqs;
 168         }
 169
 170         save_processor_state();
 171         error = swsusp_arch_suspend();
 172         if (error)
 173                 printk(KERN_ERR "Error %d while creating the image\n", error);
 174         /* Restore control flow magically appears here */
 175         restore_processor_state();
 176         if (!in_suspend)
 177                 platform_leave(platform_mode);
 178         /* NOTE:  device_power_up() is just a resume() for devices
 179          * that suspended with irqs off ... no overall powerup.
 180          */
 181         device_power_up();
 182  Enable_irqs:
 183         local_irq_enable();
 184         return error;
 185 }
 186
 187 /**
 188  *      hibernation_snapshot - quiesce devices and create the hibernation
 189  *      snapshot image.
 190  *      @platform_mode - if set, use the platform driver, if available, to
 191  *                       prepare the platform frimware for the power transition.
 192  *
 193  *      Must be called with pm_mutex held
 194  */
 195
 196 int hibernation_snapshot(int platform_mode)
 197 {
 198         int error;
 199
 200         /* Free memory before shutting down devices. */
 201         error = swsusp_shrink_memory();
 202         if (error)
 203                 return error;
 204
 205         error = platform_start(platform_mode);
 206         if (error)
 207                 return error;
 208
 209         suspend_console();
 210         error = device_suspend(PMSG_FREEZE);
 211         if (error)
 212                 goto Resume_console;
 213
 214         error = platform_pre_snapshot(platform_mode);
 215         if (error)
 216                 goto Resume_devices;
 217
 218         error = disable_nonboot_cpus();
 219         if (!error) {
 220                 if (hibernation_mode != HIBERNATION_TEST) {
 221                         in_suspend = 1;
 222                         error = create_image(platform_mode);
 223                         /* Control returns here after successful restore */
 224                 } else {
 225                         printk("swsusp debug: Waiting for 5 seconds.\n");
 226                         mdelay(5000);
 227                 }
 228         }
 229         enable_nonboot_cpus();
 230  Resume_devices:
 231         platform_finish(platform_mode);
 232         device_resume();
 233  Resume_console:
 234         resume_console();
 235         return error;
 236 }
 237
 238 /**
 239  *      hibernation_restore - quiesce devices and restore the hibernation
 240  *      snapshot image.  If successful, control returns in hibernation_snaphot()
 241  *      @platform_mode - if set, use the platform driver, if available, to
 242  *                       prepare the platform frimware for the transition.
 243  *
 244  *      Must be called with pm_mutex held
 245  */
 246
 247 int hibernation_restore(int platform_mode)
 248 {
 249         int error;
 250
 251         pm_prepare_console();
 252         suspend_console();
 253         error = device_suspend(PMSG_PRETHAW);
 254         if (error)
 255                 goto Finish;
 256
 257         error = platform_pre_restore(platform_mode);
 258         if (!error) {
 259                 error = disable_nonboot_cpus();
 260                 if (!error)
 261                         error = swsusp_resume();
 262                 enable_nonboot_cpus();
 263         }
 264         platform_restore_cleanup(platform_mode);
 265         device_resume();
 266  Finish:
 267         resume_console();
 268         pm_restore_console();
 269         return error;
 270 }
 271
 272 /**
 273  *      hibernation_platform_enter - enter the hibernation state using the
 274  *      platform driver (if available)
 275  */
 276
 277 int hibernation_platform_enter(void)
 278 {
 279         int error;
 280
 281         if (!hibernation_ops)
 282                 return -ENOSYS;
 283
 284         /*
 285          * We have cancelled the power transition by running
 286          * hibernation_ops->finish() before saving the image, so we should let
 287          * the firmware know that we're going to enter the sleep state after all
 288          */
 289         error = hibernation_ops->start();
 290         if (error)
 291                 return error;
 292
 293         suspend_console();
 294         error = device_suspend(PMSG_SUSPEND);
 295         if (error)
 296                 goto Resume_console;
 297
 298         error = hibernation_ops->prepare();
 299         if (error)
 300                 goto Resume_devices;
 301
 302         error = disable_nonboot_cpus();
 303         if (error)
 304                 goto Finish;
 305
 306         local_irq_disable();
 307         error = device_power_down(PMSG_SUSPEND);
 308         if (!error) {
 309                 hibernation_ops->enter();
 310                 /* We should never get here */
 311                 while (1);
 312         }
 313         local_irq_enable();
 314
 315         /*
 316          * We don't need to reenable the nonboot CPUs or resume consoles, since
 317          * the system is going to be halted anyway.
 318          */
 319  Finish:
 320         hibernation_ops->finish();
 321  Resume_devices:
 322         device_resume();
 323  Resume_console:
 324         resume_console();
 325         return error;
 326 }
 327
 328 /**
 329  *      power_down - Shut the machine down for hibernation.
 330  *
 331  *      Use the platform driver, if configured so; otherwise try
 332  *      to power off or reboot.
 333  */
 334
 335 static void power_down(void)
 336 {
 337         switch (hibernation_mode) {
 338         case HIBERNATION_TEST:
 339         case HIBERNATION_TESTPROC:
 340                 break;
 341         case HIBERNATION_REBOOT:
 342                 kernel_restart(NULL);
 343                 break;
 344         case HIBERNATION_PLATFORM:
 345                 hibernation_platform_enter();
 346         case HIBERNATION_SHUTDOWN:
 347                 kernel_power_off();
 348                 break;
 349         }
 350         kernel_halt();
 351         /*
 352          * Valid image is on the disk, if we continue we risk serious data
 353          * corruption after resume.
 354          */
 355         printk(KERN_CRIT "Please power me down manually\n");
 356         while(1);
 357 }
 358
 359 static void unprepare_processes(void)
 360 {
 361         thaw_processes();
 362         pm_restore_console();
 363 }
 364
 365 static int prepare_processes(void)
 366 {
 367         int error = 0;
 368
 369         pm_prepare_console();
 370         if (freeze_processes()) {
 371                 error = -EBUSY;
 372                 unprepare_processes();
 373         }
 374         return error;
 375 }
 376
 377 /**
 378  *      hibernate - The granpappy of the built-in hibernation management
 379  */
 380
 381 int hibernate(void)
 382 {
 383         int error;
 384
 385         mutex_lock(&pm_mutex);
 386         /* The snapshot device should not be opened while we're running */
 387         if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
 388                 error = -EBUSY;
 389                 goto Unlock;
 390         }
 391
 392         error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
 393         if (error)
 394                 goto Exit;
 395
 396         /* Allocate memory management structures */
 397         error = create_basic_memory_bitmaps();
 398         if (error)
 399                 goto Exit;
 400
 401         printk("Syncing filesystems ... ");
 402         sys_sync();
 403         printk("done.\n");
 404
 405         error = prepare_processes();
 406         if (error)
 407                 goto Finish;
 408
 409         if (hibernation_mode == HIBERNATION_TESTPROC) {
 410                 printk("swsusp debug: Waiting for 5 seconds.\n");
 411                 mdelay(5000);
 412                 goto Thaw;
 413         }
 414         error = hibernation_snapshot(hibernation_mode == HIBERNATION_PLATFORM);
 415         if (in_suspend && !error) {
 416                 unsigned int flags = 0;
 417
 418                 if (hibernation_mode == HIBERNATION_PLATFORM)
 419                         flags |= SF_PLATFORM_MODE;
 420                 pr_debug("PM: writing image.\n");
 421                 error = swsusp_write(flags);
 422                 swsusp_free();
 423                 if (!error)
 424                         power_down();
 425         } else {
 426                 pr_debug("PM: Image restored successfully.\n");
 427                 swsusp_free();
 428         }
 429  Thaw:
 430         unprepare_processes();
 431  Finish:
 432         free_basic_memory_bitmaps();
 433  Exit:
 434         pm_notifier_call_chain(PM_POST_HIBERNATION);
 435         atomic_inc(&snapshot_device_available);
 436  Unlock:
 437         mutex_unlock(&pm_mutex);
 438         return error;
 439 }
 440
 441
 442 /**
 443  *      software_resume - Resume from a saved image.
 444  *
 445  *      Called as a late_initcall (so all devices are discovered and
 446  *      initialized), we call swsusp to see if we have a saved image or not.
 447  *      If so, we quiesce devices, the restore the saved image. We will
 448  *      return above (in hibernate() ) if everything goes well.
 449  *      Otherwise, we fail gracefully and return to the normally
 450  *      scheduled program.
 451  *
 452  */
 453
 454 static int software_resume(void)
 455 {
 456         int error;
 457         unsigned int flags;
 458
 459         mutex_lock(&pm_mutex);
 460         if (!swsusp_resume_device) {
 461                 if (!strlen(resume_file)) {
 462                         mutex_unlock(&pm_mutex);
 463                         return -ENOENT;
 464                 }
 465                 swsusp_resume_device = name_to_dev_t(resume_file);
 466                 pr_debug("swsusp: Resume From Partition %s\n", resume_file);
 467         } else {
 468                 pr_debug("swsusp: Resume From Partition %d:%d\n",
 469                          MAJOR(swsusp_resume_device), MINOR(swsusp_resume_device));
 470         }
 471
 472         if (noresume) {
 473                 /**
 474                  * FIXME: If noresume is specified, we need to find the partition
 475                  * and reset it back to normal swap space.
 476                  */
 477                 mutex_unlock(&pm_mutex);
 478                 return 0;
 479         }
 480
 481         pr_debug("PM: Checking swsusp image.\n");
 482         error = swsusp_check();
 483         if (error)
 484                 goto Unlock;
 485
 486         /* The snapshot device should not be opened while we're running */
 487         if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
 488                 error = -EBUSY;
 489                 goto Unlock;
 490         }
 491
 492         error = create_basic_memory_bitmaps();
 493         if (error)
 494                 goto Finish;
 495
 496         pr_debug("PM: Preparing processes for restore.\n");
 497         error = prepare_processes();
 498         if (error) {
 499                 swsusp_close();
 500                 goto Done;
 501         }
 502
 503         pr_debug("PM: Reading swsusp image.\n");
 504
 505         error = swsusp_read(&flags);
 506         if (!error)
 507                 hibernation_restore(flags & SF_PLATFORM_MODE);
 508
 509         printk(KERN_ERR "PM: Restore failed, recovering.\n");
 510         swsusp_free();
 511         unprepare_processes();
 512  Done:
 513         free_basic_memory_bitmaps();
 514  Finish:
 515         atomic_inc(&snapshot_device_available);
 516         /* For success case, the suspend path will release the lock */
 517  Unlock:
 518         mutex_unlock(&pm_mutex);
 519         pr_debug("PM: Resume from disk failed.\n");
 520         return error;
 521 }
 522
 523 late_initcall(software_resume);
 524
 525
 526 static const char * const hibernation_modes[] = {
 527         [HIBERNATION_PLATFORM]  = "platform",
 528         [HIBERNATION_SHUTDOWN]  = "shutdown",
 529         [HIBERNATION_REBOOT]    = "reboot",
 530         [HIBERNATION_TEST]      = "test",
 531         [HIBERNATION_TESTPROC]  = "testproc",
 532 };
 533
 534 /**
 535  *      disk - Control hibernation mode
 536  *
 537  *      Suspend-to-disk can be handled in several ways. We have a few options
 538  *      for putting the system to sleep - using the platform driver (e.g. ACPI
 539  *      or other hibernation_ops), powering off the system or rebooting the
 540  *      system (for testing) as well as the two test modes.
 541  *
 542  *      The system can support 'platform', and that is known a priori (and
 543  *      encoded by the presence of hibernation_ops). However, the user may
 544  *      choose 'shutdown' or 'reboot' as alternatives, as well as one fo the
 545  *      test modes, 'test' or 'testproc'.
 546  *
 547  *      show() will display what the mode is currently set to.
 548  *      store() will accept one of
 549  *
 550  *      'platform'
 551  *      'shutdown'
 552  *      'reboot'
 553  *      'test'
 554  *      'testproc'
 555  *
 556  *      It will only change to 'platform' if the system
 557  *      supports it (as determined by having hibernation_ops).
 558  */
 559
 560 static ssize_t disk_show(struct kset *kset, char *buf)
 561 {
 562         int i;
 563         char *start = buf;
 564
 565         for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
 566                 if (!hibernation_modes[i])
 567                         continue;
 568                 switch (i) {
 569                 case HIBERNATION_SHUTDOWN:
 570                 case HIBERNATION_REBOOT:
 571                 case HIBERNATION_TEST:
 572                 case HIBERNATION_TESTPROC:
 573                         break;
 574                 case HIBERNATION_PLATFORM:
 575                         if (hibernation_ops)
 576                                 break;
 577                         /* not a valid mode, continue with loop */
 578                         continue;
 579                 }
 580                 if (i == hibernation_mode)
 581                         buf += sprintf(buf, "[%s] ", hibernation_modes[i]);
 582                 else
 583                         buf += sprintf(buf, "%s ", hibernation_modes[i]);
 584         }
 585         buf += sprintf(buf, "\n");
 586         return buf-start;
 587 }
 588
 589
 590 static ssize_t disk_store(struct kset *kset, const char *buf, size_t n)
 591 {
 592         int error = 0;
 593         int i;
 594         int len;
 595         char *p;
 596         int mode = HIBERNATION_INVALID;
 597
 598         p = memchr(buf, '\n', n);
 599         len = p ? p - buf : n;
 600
 601         mutex_lock(&pm_mutex);
 602         for (i = HIBERNATION_FIRST; i <= HIBERNATION_MAX; i++) {
 603                 if (len == strlen(hibernation_modes[i])
 604                     && !strncmp(buf, hibernation_modes[i], len)) {
 605                         mode = i;
 606                         break;
 607                 }
 608         }
 609         if (mode != HIBERNATION_INVALID) {
 610                 switch (mode) {
 611                 case HIBERNATION_SHUTDOWN:
 612                 case HIBERNATION_REBOOT:
 613                 case HIBERNATION_TEST:
 614                 case HIBERNATION_TESTPROC:
 615                         hibernation_mode = mode;
 616                         break;
 617                 case HIBERNATION_PLATFORM:
 618                         if (hibernation_ops)
 619                                 hibernation_mode = mode;
 620                         else
 621                                 error = -EINVAL;
 622                 }
 623         } else
 624                 error = -EINVAL;
 625
 626         if (!error)
 627                 pr_debug("PM: suspend-to-disk mode set to '%s'\n",
 628                          hibernation_modes[mode]);
 629         mutex_unlock(&pm_mutex);
 630         return error ? error : n;
 631 }
 632
 633 power_attr(disk);
 634
 635 static ssize_t resume_show(struct kset *kset, char *buf)
 636 {
 637         return sprintf(buf,"%d:%d\n", MAJOR(swsusp_resume_device),
 638                        MINOR(swsusp_resume_device));
 639 }
 640
 641 static ssize_t resume_store(struct kset *kset, const char *buf, size_t n)
 642 {
 643         unsigned int maj, min;
 644         dev_t res;
 645         int ret = -EINVAL;
 646
 647         if (sscanf(buf, "%u:%u", &maj, &min) != 2)
 648                 goto out;
 649
 650         res = MKDEV(maj,min);
 651         if (maj != MAJOR(res) || min != MINOR(res))
 652                 goto out;
 653
 654         mutex_lock(&pm_mutex);
 655         swsusp_resume_device = res;
 656         mutex_unlock(&pm_mutex);
 657         printk("Attempting manual resume\n");
 658         noresume = 0;
 659         software_resume();
 660         ret = n;
 661  out:
 662         return ret;
 663 }
 664
 665 power_attr(resume);
 666
 667 static ssize_t image_size_show(struct kset *kset, char *buf)
 668 {
 669         return sprintf(buf, "%lu\n", image_size);
 670 }
 671
 672 static ssize_t image_size_store(struct kset *kset, const char *buf, size_t n)
 673 {
 674         unsigned long size;
 675
 676         if (sscanf(buf, "%lu", &size) == 1) {
 677                 image_size = size;
 678                 return n;
 679         }
 680
 681         return -EINVAL;
 682 }
 683
 684 power_attr(image_size);
 685
 686 static struct attribute * g[] = {
 687         &disk_attr.attr,
 688         &resume_attr.attr,
 689         &image_size_attr.attr,
 690         NULL,
 691 };
 692
 693
 694 static struct attribute_group attr_group = {
 695         .attrs = g,
 696 };
 697
 698
 699 static int __init pm_disk_init(void)
 700 {
 701         return sysfs_create_group(&power_subsys.kobj, &attr_group);
 702 }
 703
 704 core_initcall(pm_disk_init);
 705
 706
 707 static int __init resume_setup(char *str)
 708 {
 709         if (noresume)
 710                 return 1;
 711
 712         strncpy( resume_file, str, 255 );
 713         return 1;
 714 }
 715
 716 static int __init resume_offset_setup(char *str)
 717 {
 718         unsigned long long offset;
 719
 720         if (noresume)
 721                 return 1;
 722
 723         if (sscanf(str, "%llu", &offset) == 1)
 724                 swsusp_resume_block = offset;
 725
 726         return 1;
 727 }
 728
 729 static int __init noresume_setup(char *str)
 730 {
 731         noresume = 1;
 732         return 1;
 733 }
 734
 735 __setup("noresume", noresume_setup);
 736 __setup("resume_offset=", resume_offset_setup);
 737 __setup("resume=", resume_setup);