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