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