Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 3010f8ca authored by Rafael J. Wysocki's avatar Rafael J. Wysocki Committed by Len Brown
Browse files

Hibernation: Introduce exportable suspend ioctls header (rev. 2) 



Move the definitions of hibernation ioctls to a separate header file in
include/linux, which can be exported to the user space.

Signed-off-by: default avatarRafael J. Wysocki <rjw@sisk.pl>
Acked-by: default avatarPavel Machek <pavel@ucw.cz>
Signed-off-by: default avatarLen Brown <len.brown@intel.com>
parent cc5d207c

Documentation/power/userland-swsusp.txt

+5 −5
Original line number Diff line number Diff line
@@ -14,7 +14,7 @@ are going to develop your own suspend/resume utilities. 


The interface consists of a character device providing the open(),

release(), read(), and write() operations as well as several ioctl()

commands defined in kernel/power/power.h.  The major and minor

commands defined in include/linux/suspend_ioctls.h .  The major and minor

numbers of the device are, respectively, 10 and 231, and they can

be read from /sys/class/misc/snapshot/dev.
@@ -70,10 +70,10 @@ SNAPSHOT_FREE_SWAP_PAGES - free all swap pages allocated by 
SNAPSHOT_SET_SWAP_AREA - set the resume partition and the offset (in <PAGE_SIZE>

	units) from the beginning of the partition at which the swap header is

	located (the last ioctl() argument should point to a struct

	resume_swap_area, as defined in kernel/power/power.h, containing the

	resume device specification and the offset); for swap partitions the

	offset is always 0, but it is different from zero for swap files (see

	Documentation/swsusp-and-swap-files.txt for details).

	resume_swap_area, as defined in kernel/power/suspend_ioctls.h,

	containing the resume device specification and the offset); for swap

	partitions the offset is always 0, but it is different from zero for

	swap files (see Documentation/swsusp-and-swap-files.txt for details).



SNAPSHOT_PLATFORM_SUPPORT - enable/disable the hibernation platform support,

	depending on the argument value (enable, if the argument is nonzero)

include/linux/Kbuild

+1 −0
Original line number Diff line number Diff line
@@ -143,6 +143,7 @@ header-y += snmp.h 
header-y += sockios.h

header-y += som.h

header-y += sound.h

header-y += suspend_ioctls.h

header-y += taskstats.h

header-y += telephony.h

header-y += termios.h

include/linux/suspend_ioctls.h

0 → 100644
+32 −0
Original line number Diff line number Diff line 
#ifndef _LINUX_SUSPEND_IOCTLS_H

#define _LINUX_SUSPEND_IOCTLS_H



/*

 * This structure is used to pass the values needed for the identification

 * of the resume swap area from a user space to the kernel via the

 * SNAPSHOT_SET_SWAP_AREA ioctl

 */

struct resume_swap_area {

	loff_t offset;

	u_int32_t dev;

} __attribute__((packed));



#define SNAPSHOT_IOC_MAGIC	'3'

#define SNAPSHOT_FREEZE			_IO(SNAPSHOT_IOC_MAGIC, 1)

#define SNAPSHOT_UNFREEZE		_IO(SNAPSHOT_IOC_MAGIC, 2)

#define SNAPSHOT_ATOMIC_RESTORE		_IO(SNAPSHOT_IOC_MAGIC, 4)

#define SNAPSHOT_FREE			_IO(SNAPSHOT_IOC_MAGIC, 5)

#define SNAPSHOT_FREE_SWAP_PAGES	_IO(SNAPSHOT_IOC_MAGIC, 9)

#define SNAPSHOT_S2RAM			_IO(SNAPSHOT_IOC_MAGIC, 11)

#define SNAPSHOT_SET_SWAP_AREA		_IOW(SNAPSHOT_IOC_MAGIC, 13, \

							struct resume_swap_area)

#define SNAPSHOT_GET_IMAGE_SIZE		_IOR(SNAPSHOT_IOC_MAGIC, 14, loff_t)

#define SNAPSHOT_PLATFORM_SUPPORT	_IO(SNAPSHOT_IOC_MAGIC, 15)

#define SNAPSHOT_POWER_OFF		_IO(SNAPSHOT_IOC_MAGIC, 16)

#define SNAPSHOT_CREATE_IMAGE		_IOW(SNAPSHOT_IOC_MAGIC, 17, int)

#define SNAPSHOT_PREF_IMAGE_SIZE	_IO(SNAPSHOT_IOC_MAGIC, 18)

#define SNAPSHOT_AVAIL_SWAP_SIZE	_IOR(SNAPSHOT_IOC_MAGIC, 19, loff_t)

#define SNAPSHOT_ALLOC_SWAP_PAGE	_IOR(SNAPSHOT_IOC_MAGIC, 20, loff_t)

#define SNAPSHOT_IOC_MAXNR	20



#endif /* _LINUX_SUSPEND_IOCTLS_H */

kernel/power/power.h

+1 −28
Original line number Diff line number Diff line 
#include <linux/suspend.h>

#include <linux/suspend_ioctls.h>

#include <linux/utsname.h>



struct swsusp_info {
@@ -134,34 +135,6 @@ extern int snapshot_write_next(struct snapshot_handle *handle, size_t count); 
extern void snapshot_write_finalize(struct snapshot_handle *handle);

extern int snapshot_image_loaded(struct snapshot_handle *handle);



/*

 * This structure is used to pass the values needed for the identification

 * of the resume swap area from a user space to the kernel via the

 * SNAPSHOT_SET_SWAP_AREA ioctl

 */

struct resume_swap_area {

	loff_t offset;

	u_int32_t dev;

} __attribute__((packed));



#define SNAPSHOT_IOC_MAGIC	'3'

#define SNAPSHOT_FREEZE			_IO(SNAPSHOT_IOC_MAGIC, 1)

#define SNAPSHOT_UNFREEZE		_IO(SNAPSHOT_IOC_MAGIC, 2)

#define SNAPSHOT_ATOMIC_RESTORE		_IO(SNAPSHOT_IOC_MAGIC, 4)

#define SNAPSHOT_FREE			_IO(SNAPSHOT_IOC_MAGIC, 5)

#define SNAPSHOT_FREE_SWAP_PAGES	_IO(SNAPSHOT_IOC_MAGIC, 9)

#define SNAPSHOT_S2RAM			_IO(SNAPSHOT_IOC_MAGIC, 11)

#define SNAPSHOT_SET_SWAP_AREA		_IOW(SNAPSHOT_IOC_MAGIC, 13, \

							struct resume_swap_area)

#define SNAPSHOT_GET_IMAGE_SIZE		_IOR(SNAPSHOT_IOC_MAGIC, 14, loff_t)

#define SNAPSHOT_PLATFORM_SUPPORT	_IO(SNAPSHOT_IOC_MAGIC, 15)

#define SNAPSHOT_POWER_OFF		_IO(SNAPSHOT_IOC_MAGIC, 16)

#define SNAPSHOT_CREATE_IMAGE		_IOW(SNAPSHOT_IOC_MAGIC, 17, int)

#define SNAPSHOT_PREF_IMAGE_SIZE	_IO(SNAPSHOT_IOC_MAGIC, 18)

#define SNAPSHOT_AVAIL_SWAP_SIZE	_IOR(SNAPSHOT_IOC_MAGIC, 19, loff_t)

#define SNAPSHOT_ALLOC_SWAP_PAGE	_IOR(SNAPSHOT_IOC_MAGIC, 20, loff_t)

#define SNAPSHOT_IOC_MAXNR	20



/* If unset, the snapshot device cannot be open. */

extern atomic_t snapshot_device_available;