aboutsummaryrefslogtreecommitdiffstats
path: root/Documentation/power/userland-swsusp.txt
diff options
context:
space:
mode:
authorRafael J. Wysocki <rjw@sisk.pl>2007-10-25 18:59:31 -0400
committerLen Brown <len.brown@intel.com>2008-02-01 18:30:52 -0500
commitaf508b34d27e3341287d89e0eae6752fdb1b873f (patch)
treeb5d2a337d78dc25aadb02d481443d484e0dd368c /Documentation/power/userland-swsusp.txt
parentaa6299926950c8dfe2fea638276cad6def092bc9 (diff)
Hibernation: Introduce SNAPSHOT_GET_IMAGE_SIZE ioctl
Add a new ioctl, SNAPSHOT_GET_IMAGE_SIZE, returning the size of the (just created) hibernation image, to the hibernation userland interface. This ioctl is necessary so that the userland utilities using the interface need not access the hibernation image header, owned by the kernel, in order to obtain the size of the image. Signed-off-by: Rafael J. Wysocki <rjw@sisk.pl> Acked-by: Pavel Machek <pavel@ucw.cz> Signed-off-by: Len Brown <len.brown@intel.com>
Diffstat (limited to 'Documentation/power/userland-swsusp.txt')
-rw-r--r--Documentation/power/userland-swsusp.txt12
1 files changed, 5 insertions, 7 deletions
diff --git a/Documentation/power/userland-swsusp.txt b/Documentation/power/userland-swsusp.txt
index e00c6cf09e85..32f187479697 100644
--- a/Documentation/power/userland-swsusp.txt
+++ b/Documentation/power/userland-swsusp.txt
@@ -54,6 +54,8 @@ SNAPSHOT_SET_IMAGE_SIZE - set the preferred maximum size of the image
54 this number, but if it turns out to be impossible, the kernel will 54 this number, but if it turns out to be impossible, the kernel will
55 create the smallest image possible) 55 create the smallest image possible)
56 56
57SNAPSHOT_GET_IMAGE_SIZE - return the actual size of the hibernation image
58
57SNAPSHOT_AVAIL_SWAP - return the amount of available swap in bytes (the last 59SNAPSHOT_AVAIL_SWAP - return the amount of available swap in bytes (the last
58 argument should be a pointer to an unsigned int variable that will 60 argument should be a pointer to an unsigned int variable that will
59 contain the result if the call is successful). 61 contain the result if the call is successful).
@@ -136,13 +138,9 @@ required, as they can use, for example, a special (blank) suspend partition or
136a file on a partition that is unmounted before SNAPSHOT_ATOMIC_SNAPSHOT and 138a file on a partition that is unmounted before SNAPSHOT_ATOMIC_SNAPSHOT and
137mounted afterwards. 139mounted afterwards.
138 140
139These utilities SHOULD NOT make any assumptions regarding the ordering of 141These utilities MUST NOT make any assumptions regarding the ordering of
140data within the snapshot image, except for the image header that MAY be 142data within the snapshot image. The contents of the image are entirely owned
141assumed to start with an swsusp_info structure, as specified in 143by the kernel and its structure may be changed in future kernel releases.
142kernel/power/power.h. This structure MAY be used by the userland utilities
143to obtain some information about the snapshot image, such as the size
144of the snapshot image, including the metadata and the header itself,
145contained in the .size member of swsusp_info.
146 144
147The snapshot image MUST be written to the kernel unaltered (ie. all of the image 145The snapshot image MUST be written to the kernel unaltered (ie. all of the image
148data, metadata and header MUST be written in _exactly_ the same amount, form 146data, metadata and header MUST be written in _exactly_ the same amount, form