Merge branch 'fixes' of git://git.linaro.org/people/arnd/arm-soc
[deliverable/linux.git] / kernel / power / user.c
CommitLineData
6e1819d6
RW
1/*
2 * linux/kernel/power/user.c
3 *
4 * This file provides the user space interface for software suspend/resume.
5 *
6 * Copyright (C) 2006 Rafael J. Wysocki <rjw@sisk.pl>
7 *
8 * This file is released under the GPLv2.
9 *
10 */
11
12#include <linux/suspend.h>
13#include <linux/syscalls.h>
3592695c 14#include <linux/reboot.h>
6e1819d6
RW
15#include <linux/string.h>
16#include <linux/device.h>
17#include <linux/miscdevice.h>
18#include <linux/mm.h>
19#include <linux/swap.h>
20#include <linux/swapops.h>
21#include <linux/pm.h>
22#include <linux/fs.h>
97c7801c 23#include <linux/console.h>
e3920fb4 24#include <linux/cpu.h>
7dfb7103 25#include <linux/freezer.h>
c7510859 26#include <scsi/scsi_scan.h>
6e1819d6
RW
27
28#include <asm/uaccess.h>
29
30#include "power.h"
31
eb57c1cf 32/*
96f73749
RW
33 * NOTE: The SNAPSHOT_SET_SWAP_FILE and SNAPSHOT_PMOPS ioctls are obsolete and
34 * will be removed in the future. They are only preserved here for
35 * compatibility with existing userland utilities.
eb57c1cf 36 */
96f73749 37#define SNAPSHOT_SET_SWAP_FILE _IOW(SNAPSHOT_IOC_MAGIC, 10, unsigned int)
eb57c1cf
RW
38#define SNAPSHOT_PMOPS _IOW(SNAPSHOT_IOC_MAGIC, 12, unsigned int)
39
40#define PMOPS_PREPARE 1
41#define PMOPS_ENTER 2
42#define PMOPS_FINISH 3
43
cc5d207c
RW
44/*
45 * NOTE: The following ioctl definitions are wrong and have been replaced with
46 * correct ones. They are only preserved here for compatibility with existing
47 * userland utilities and will be removed in the future.
48 */
49#define SNAPSHOT_ATOMIC_SNAPSHOT _IOW(SNAPSHOT_IOC_MAGIC, 3, void *)
50#define SNAPSHOT_SET_IMAGE_SIZE _IOW(SNAPSHOT_IOC_MAGIC, 6, unsigned long)
51#define SNAPSHOT_AVAIL_SWAP _IOR(SNAPSHOT_IOC_MAGIC, 7, void *)
52#define SNAPSHOT_GET_SWAP_PAGE _IOR(SNAPSHOT_IOC_MAGIC, 8, void *)
53
eb57c1cf 54
6e1819d6
RW
55#define SNAPSHOT_MINOR 231
56
57static struct snapshot_data {
58 struct snapshot_handle handle;
59 int swap;
6e1819d6
RW
60 int mode;
61 char frozen;
62 char ready;
eb57c1cf 63 char platform_support;
6e1819d6
RW
64} snapshot_state;
65
0709db60 66atomic_t snapshot_device_available = ATOMIC_INIT(1);
6e1819d6
RW
67
68static int snapshot_open(struct inode *inode, struct file *filp)
69{
70 struct snapshot_data *data;
c3e94d89 71 int error;
6e1819d6 72
25f2f3da
RW
73 mutex_lock(&pm_mutex);
74
75 if (!atomic_add_unless(&snapshot_device_available, -1, 0)) {
76 error = -EBUSY;
77 goto Unlock;
78 }
6e1819d6 79
1525a2ad 80 if ((filp->f_flags & O_ACCMODE) == O_RDWR) {
0709db60 81 atomic_inc(&snapshot_device_available);
25f2f3da
RW
82 error = -ENOSYS;
83 goto Unlock;
1525a2ad
RW
84 }
85 if(create_basic_memory_bitmaps()) {
0709db60 86 atomic_inc(&snapshot_device_available);
25f2f3da
RW
87 error = -ENOMEM;
88 goto Unlock;
1525a2ad 89 }
6e1819d6
RW
90 nonseekable_open(inode, filp);
91 data = &snapshot_state;
92 filp->private_data = data;
93 memset(&data->handle, 0, sizeof(struct snapshot_handle));
94 if ((filp->f_flags & O_ACCMODE) == O_RDONLY) {
c7510859 95 /* Hibernating. The image device should be accessible. */
915bae9e 96 data->swap = swsusp_resume_device ?
7bf23687 97 swap_type_of(swsusp_resume_device, 0, NULL) : -1;
6e1819d6 98 data->mode = O_RDONLY;
ebae2604 99 error = pm_notifier_call_chain(PM_HIBERNATION_PREPARE);
c3e94d89 100 if (error)
ebae2604 101 pm_notifier_call_chain(PM_POST_HIBERNATION);
6e1819d6 102 } else {
c7510859
RW
103 /*
104 * Resuming. We may need to wait for the image device to
105 * appear.
106 */
107 wait_for_device_probe();
108 scsi_complete_async_scans();
109
6e1819d6
RW
110 data->swap = -1;
111 data->mode = O_WRONLY;
ebae2604 112 error = pm_notifier_call_chain(PM_RESTORE_PREPARE);
c3e94d89 113 if (error)
ebae2604 114 pm_notifier_call_chain(PM_POST_RESTORE);
c3e94d89 115 }
8440f4b1
MK
116 if (error) {
117 free_basic_memory_bitmaps();
c3e94d89 118 atomic_inc(&snapshot_device_available);
8440f4b1 119 }
6e1819d6
RW
120 data->frozen = 0;
121 data->ready = 0;
eb57c1cf 122 data->platform_support = 0;
6e1819d6 123
25f2f3da
RW
124 Unlock:
125 mutex_unlock(&pm_mutex);
126
127 return error;
6e1819d6
RW
128}
129
130static int snapshot_release(struct inode *inode, struct file *filp)
131{
132 struct snapshot_data *data;
133
25f2f3da
RW
134 mutex_lock(&pm_mutex);
135
6e1819d6 136 swsusp_free();
74dfd666 137 free_basic_memory_bitmaps();
6e1819d6 138 data = filp->private_data;
d1d241cc 139 free_all_swap_pages(data->swap);
9744997a
RW
140 if (data->frozen) {
141 pm_restore_gfp_mask();
6e1819d6 142 thaw_processes();
9744997a 143 }
1497dd1d 144 pm_notifier_call_chain(data->mode == O_RDONLY ?
c3e94d89 145 PM_POST_HIBERNATION : PM_POST_RESTORE);
0709db60 146 atomic_inc(&snapshot_device_available);
25f2f3da
RW
147
148 mutex_unlock(&pm_mutex);
149
6e1819d6
RW
150 return 0;
151}
152
153static ssize_t snapshot_read(struct file *filp, char __user *buf,
154 size_t count, loff_t *offp)
155{
156 struct snapshot_data *data;
157 ssize_t res;
d3c1b24c 158 loff_t pg_offp = *offp & ~PAGE_MASK;
6e1819d6 159
25f2f3da
RW
160 mutex_lock(&pm_mutex);
161
6e1819d6 162 data = filp->private_data;
25f2f3da
RW
163 if (!data->ready) {
164 res = -ENODATA;
165 goto Unlock;
166 }
d3c1b24c
JS
167 if (!pg_offp) { /* on page boundary? */
168 res = snapshot_read_next(&data->handle);
169 if (res <= 0)
170 goto Unlock;
171 } else {
172 res = PAGE_SIZE - pg_offp;
6e1819d6 173 }
25f2f3da 174
d3c1b24c
JS
175 res = simple_read_from_buffer(buf, count, &pg_offp,
176 data_of(data->handle), res);
177 if (res > 0)
178 *offp += res;
179
25f2f3da
RW
180 Unlock:
181 mutex_unlock(&pm_mutex);
182
6e1819d6
RW
183 return res;
184}
185
186static ssize_t snapshot_write(struct file *filp, const char __user *buf,
187 size_t count, loff_t *offp)
188{
189 struct snapshot_data *data;
190 ssize_t res;
d3c1b24c 191 loff_t pg_offp = *offp & ~PAGE_MASK;
6e1819d6 192
25f2f3da
RW
193 mutex_lock(&pm_mutex);
194
6e1819d6 195 data = filp->private_data;
d3c1b24c
JS
196
197 if (!pg_offp) {
198 res = snapshot_write_next(&data->handle);
199 if (res <= 0)
200 goto unlock;
201 } else {
202 res = PAGE_SIZE - pg_offp;
6e1819d6 203 }
25f2f3da 204
d3c1b24c
JS
205 res = simple_write_to_buffer(data_of(data->handle), res, &pg_offp,
206 buf, count);
207 if (res > 0)
208 *offp += res;
209unlock:
25f2f3da
RW
210 mutex_unlock(&pm_mutex);
211
6e1819d6
RW
212 return res;
213}
214
b694e52e
JS
215static void snapshot_deprecated_ioctl(unsigned int cmd)
216{
217 if (printk_ratelimit())
218 printk(KERN_NOTICE "%pf: ioctl '%.8x' is deprecated and will "
219 "be removed soon, update your suspend-to-disk "
220 "utilities\n",
221 __builtin_return_address(0), cmd);
222}
223
52d11025
AC
224static long snapshot_ioctl(struct file *filp, unsigned int cmd,
225 unsigned long arg)
6e1819d6
RW
226{
227 int error = 0;
228 struct snapshot_data *data;
af508b34 229 loff_t size;
3aef83e0 230 sector_t offset;
6e1819d6
RW
231
232 if (_IOC_TYPE(cmd) != SNAPSHOT_IOC_MAGIC)
233 return -ENOTTY;
234 if (_IOC_NR(cmd) > SNAPSHOT_IOC_MAXNR)
235 return -ENOTTY;
236 if (!capable(CAP_SYS_ADMIN))
237 return -EPERM;
238
25f2f3da
RW
239 if (!mutex_trylock(&pm_mutex))
240 return -EBUSY;
6e1819d6 241
25f2f3da 242 data = filp->private_data;
52d11025 243
6e1819d6
RW
244 switch (cmd) {
245
246 case SNAPSHOT_FREEZE:
247 if (data->frozen)
248 break;
1bfcf130 249
c3e94d89
AS
250 printk("Syncing filesystems ... ");
251 sys_sync();
252 printk("done.\n");
253
1bfcf130 254 error = usermodehelper_disable();
b10d9117 255 if (error)
1bfcf130
RW
256 break;
257
258 error = freeze_processes();
259 if (error) {
c3e94d89 260 thaw_processes();
1bfcf130
RW
261 usermodehelper_enable();
262 }
6e1819d6
RW
263 if (!error)
264 data->frozen = 1;
265 break;
266
267 case SNAPSHOT_UNFREEZE:
2f41dddb 268 if (!data->frozen || data->ready)
6e1819d6 269 break;
c9e664f1 270 pm_restore_gfp_mask();
6e1819d6 271 thaw_processes();
1bfcf130 272 usermodehelper_enable();
6e1819d6
RW
273 data->frozen = 0;
274 break;
275
276 case SNAPSHOT_ATOMIC_SNAPSHOT:
b694e52e
JS
277 snapshot_deprecated_ioctl(cmd);
278 case SNAPSHOT_CREATE_IMAGE:
6e1819d6
RW
279 if (data->mode != O_RDONLY || !data->frozen || data->ready) {
280 error = -EPERM;
281 break;
282 }
c9e664f1 283 pm_restore_gfp_mask();
eb57c1cf 284 error = hibernation_snapshot(data->platform_support);
6e1819d6 285 if (!error)
cc5d207c 286 error = put_user(in_suspend, (int __user *)arg);
6e1819d6
RW
287 if (!error)
288 data->ready = 1;
289 break;
290
291 case SNAPSHOT_ATOMIC_RESTORE:
8357376d 292 snapshot_write_finalize(&data->handle);
6e1819d6
RW
293 if (data->mode != O_WRONLY || !data->frozen ||
294 !snapshot_image_loaded(&data->handle)) {
295 error = -EPERM;
296 break;
297 }
eb57c1cf 298 error = hibernation_restore(data->platform_support);
6e1819d6
RW
299 break;
300
301 case SNAPSHOT_FREE:
302 swsusp_free();
303 memset(&data->handle, 0, sizeof(struct snapshot_handle));
304 data->ready = 0;
305 break;
306
307 case SNAPSHOT_SET_IMAGE_SIZE:
b694e52e
JS
308 snapshot_deprecated_ioctl(cmd);
309 case SNAPSHOT_PREF_IMAGE_SIZE:
6e1819d6
RW
310 image_size = arg;
311 break;
312
af508b34
RW
313 case SNAPSHOT_GET_IMAGE_SIZE:
314 if (!data->ready) {
315 error = -ENODATA;
316 break;
317 }
318 size = snapshot_get_image_size();
319 size <<= PAGE_SHIFT;
320 error = put_user(size, (loff_t __user *)arg);
321 break;
322
6e1819d6 323 case SNAPSHOT_AVAIL_SWAP:
b694e52e
JS
324 snapshot_deprecated_ioctl(cmd);
325 case SNAPSHOT_AVAIL_SWAP_SIZE:
af508b34
RW
326 size = count_swap_pages(data->swap, 1);
327 size <<= PAGE_SHIFT;
328 error = put_user(size, (loff_t __user *)arg);
6e1819d6
RW
329 break;
330
331 case SNAPSHOT_GET_SWAP_PAGE:
b694e52e
JS
332 snapshot_deprecated_ioctl(cmd);
333 case SNAPSHOT_ALLOC_SWAP_PAGE:
6e1819d6
RW
334 if (data->swap < 0 || data->swap >= MAX_SWAPFILES) {
335 error = -ENODEV;
336 break;
337 }
d1d241cc 338 offset = alloc_swapdev_block(data->swap);
6e1819d6
RW
339 if (offset) {
340 offset <<= PAGE_SHIFT;
cc5d207c 341 error = put_user(offset, (loff_t __user *)arg);
6e1819d6
RW
342 } else {
343 error = -ENOSPC;
344 }
345 break;
346
347 case SNAPSHOT_FREE_SWAP_PAGES:
348 if (data->swap < 0 || data->swap >= MAX_SWAPFILES) {
349 error = -ENODEV;
350 break;
351 }
d1d241cc 352 free_all_swap_pages(data->swap);
6e1819d6
RW
353 break;
354
96f73749 355 case SNAPSHOT_SET_SWAP_FILE: /* This ioctl is deprecated */
b694e52e 356 snapshot_deprecated_ioctl(cmd);
d1d241cc 357 if (!swsusp_swap_in_use()) {
6e1819d6
RW
358 /*
359 * User space encodes device types as two-byte values,
360 * so we need to recode them
361 */
362 if (old_decode_dev(arg)) {
7bf23687
RW
363 data->swap = swap_type_of(old_decode_dev(arg),
364 0, NULL);
6e1819d6
RW
365 if (data->swap < 0)
366 error = -ENODEV;
367 } else {
368 data->swap = -1;
369 error = -EINVAL;
370 }
371 } else {
372 error = -EPERM;
373 }
374 break;
375
9b238205
LT
376 case SNAPSHOT_S2RAM:
377 if (!data->frozen) {
378 error = -EPERM;
379 break;
380 }
6c961dfb
RW
381 /*
382 * Tasks are frozen and the notifiers have been called with
383 * PM_HIBERNATION_PREPARE
384 */
385 error = suspend_devices_and_enter(PM_SUSPEND_MEM);
36cb7035 386 data->ready = 0;
9b238205
LT
387 break;
388
eb57c1cf
RW
389 case SNAPSHOT_PLATFORM_SUPPORT:
390 data->platform_support = !!arg;
391 break;
392
393 case SNAPSHOT_POWER_OFF:
394 if (data->platform_support)
395 error = hibernation_platform_enter();
396 break;
397
398 case SNAPSHOT_PMOPS: /* This ioctl is deprecated */
b694e52e 399 snapshot_deprecated_ioctl(cmd);
2b5b09b3
RW
400 error = -EINVAL;
401
3592695c
SS
402 switch (arg) {
403
404 case PMOPS_PREPARE:
eb57c1cf 405 data->platform_support = 1;
7777fab9 406 error = 0;
3592695c
SS
407 break;
408
409 case PMOPS_ENTER:
eb57c1cf 410 if (data->platform_support)
7777fab9 411 error = hibernation_platform_enter();
3592695c
SS
412 break;
413
414 case PMOPS_FINISH:
eb57c1cf 415 if (data->platform_support)
2b5b09b3 416 error = 0;
3592695c
SS
417 break;
418
419 default:
420 printk(KERN_ERR "SNAPSHOT_PMOPS: invalid argument %ld\n", arg);
3592695c
SS
421
422 }
423 break;
424
37b2ba12 425 case SNAPSHOT_SET_SWAP_AREA:
d1d241cc 426 if (swsusp_swap_in_use()) {
37b2ba12
RW
427 error = -EPERM;
428 } else {
429 struct resume_swap_area swap_area;
430 dev_t swdev;
431
432 error = copy_from_user(&swap_area, (void __user *)arg,
433 sizeof(struct resume_swap_area));
434 if (error) {
435 error = -EFAULT;
436 break;
437 }
438
439 /*
440 * User space encodes device types as two-byte values,
441 * so we need to recode them
442 */
d88d4050 443 swdev = new_decode_dev(swap_area.dev);
37b2ba12
RW
444 if (swdev) {
445 offset = swap_area.offset;
7bf23687 446 data->swap = swap_type_of(swdev, offset, NULL);
37b2ba12
RW
447 if (data->swap < 0)
448 error = -ENODEV;
449 } else {
450 data->swap = -1;
451 error = -EINVAL;
452 }
453 }
454 break;
455
6e1819d6
RW
456 default:
457 error = -ENOTTY;
458
459 }
25f2f3da
RW
460
461 mutex_unlock(&pm_mutex);
462
6e1819d6
RW
463 return error;
464}
465
15ad7cdc 466static const struct file_operations snapshot_fops = {
6e1819d6
RW
467 .open = snapshot_open,
468 .release = snapshot_release,
469 .read = snapshot_read,
470 .write = snapshot_write,
471 .llseek = no_llseek,
52d11025 472 .unlocked_ioctl = snapshot_ioctl,
6e1819d6
RW
473};
474
475static struct miscdevice snapshot_device = {
476 .minor = SNAPSHOT_MINOR,
477 .name = "snapshot",
478 .fops = &snapshot_fops,
479};
480
481static int __init snapshot_device_init(void)
482{
483 return misc_register(&snapshot_device);
484};
485
486device_initcall(snapshot_device_init);
This page took 0.521629 seconds and 5 git commands to generate.