power management: remove firmware disk mode
[linux-2.6.git] / Documentation / power / swsusp.txt
1 Some warnings, first.
2
3  * BIG FAT WARNING *********************************************************
4  *
5  * If you touch anything on disk between suspend and resume...
6  *                              ...kiss your data goodbye.
7  *
8  * If you do resume from initrd after your filesystems are mounted...
9  *                              ...bye bye root partition.
10  *                      [this is actually same case as above]
11  *
12  * If you have unsupported (*) devices using DMA, you may have some
13  * problems. If your disk driver does not support suspend... (IDE does),
14  * it may cause some problems, too. If you change kernel command line
15  * between suspend and resume, it may do something wrong. If you change
16  * your hardware while system is suspended... well, it was not good idea;
17  * but it will probably only crash.
18  *
19  * (*) suspend/resume support is needed to make it safe.
20  *
21  * If you have any filesystems on USB devices mounted before software suspend,
22  * they won't be accessible after resume and you may lose data, as though
23  * you have unplugged the USB devices with mounted filesystems on them;
24  * see the FAQ below for details.  (This is not true for more traditional
25  * power states like "standby", which normally don't turn USB off.)
26
27 You need to append resume=/dev/your_swap_partition to kernel command
28 line. Then you suspend by
29
30 echo shutdown > /sys/power/disk; echo disk > /sys/power/state
31
32 . If you feel ACPI works pretty well on your system, you might try
33
34 echo platform > /sys/power/disk; echo disk > /sys/power/state
35
36 . If you have SATA disks, you'll need recent kernels with SATA suspend
37 support. For suspend and resume to work, make sure your disk drivers
38 are built into kernel -- not modules. [There's way to make
39 suspend/resume with modular disk drivers, see FAQ, but you probably
40 should not do that.]
41
42 If you want to limit the suspend image size to N bytes, do
43
44 echo N > /sys/power/image_size
45
46 before suspend (it is limited to 500 MB by default).
47
48
49 Article about goals and implementation of Software Suspend for Linux
50 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
51 Author: G‚ábor Kuti
52 Last revised: 2003-10-20 by Pavel Machek
53
54 Idea and goals to achieve
55
56 Nowadays it is common in several laptops that they have a suspend button. It
57 saves the state of the machine to a filesystem or to a partition and switches
58 to standby mode. Later resuming the machine the saved state is loaded back to
59 ram and the machine can continue its work. It has two real benefits. First we
60 save ourselves the time machine goes down and later boots up, energy costs
61 are real high when running from batteries. The other gain is that we don't have to
62 interrupt our programs so processes that are calculating something for a long
63 time shouldn't need to be written interruptible.
64
65 swsusp saves the state of the machine into active swaps and then reboots or
66 powerdowns.  You must explicitly specify the swap partition to resume from with
67 ``resume='' kernel option. If signature is found it loads and restores saved
68 state. If the option ``noresume'' is specified as a boot parameter, it skips
69 the resuming.
70
71 In the meantime while the system is suspended you should not add/remove any
72 of the hardware, write to the filesystems, etc.
73
74 Sleep states summary
75 ====================
76
77 There are three different interfaces you can use, /proc/acpi should
78 work like this:
79
80 In a really perfect world:
81 echo 1 > /proc/acpi/sleep       # for standby
82 echo 2 > /proc/acpi/sleep       # for suspend to ram
83 echo 3 > /proc/acpi/sleep       # for suspend to ram, but with more power conservative
84 echo 4 > /proc/acpi/sleep       # for suspend to disk
85 echo 5 > /proc/acpi/sleep       # for shutdown unfriendly the system
86
87 and perhaps
88 echo 4b > /proc/acpi/sleep      # for suspend to disk via s4bios
89
90 Frequently Asked Questions
91 ==========================
92
93 Q: well, suspending a server is IMHO a really stupid thing,
94 but... (Diego Zuccato):
95
96 A: You bought new UPS for your server. How do you install it without
97 bringing machine down? Suspend to disk, rearrange power cables,
98 resume.
99
100 You have your server on UPS. Power died, and UPS is indicating 30
101 seconds to failure. What do you do? Suspend to disk.
102
103
104 Q: Maybe I'm missing something, but why don't the regular I/O paths work?
105
106 A: We do use the regular I/O paths. However we cannot restore the data
107 to its original location as we load it. That would create an
108 inconsistent kernel state which would certainly result in an oops.
109 Instead, we load the image into unused memory and then atomically copy
110 it back to it original location. This implies, of course, a maximum
111 image size of half the amount of memory.
112
113 There are two solutions to this:
114
115 * require half of memory to be free during suspend. That way you can
116 read "new" data onto free spots, then cli and copy
117
118 * assume we had special "polling" ide driver that only uses memory
119 between 0-640KB. That way, I'd have to make sure that 0-640KB is free
120 during suspending, but otherwise it would work...
121
122 suspend2 shares this fundamental limitation, but does not include user
123 data and disk caches into "used memory" by saving them in
124 advance. That means that the limitation goes away in practice.
125
126 Q: Does linux support ACPI S4?
127
128 A: Yes. That's what echo platform > /sys/power/disk does.
129
130 Q: What is 'suspend2'?
131
132 A: suspend2 is 'Software Suspend 2', a forked implementation of
133 suspend-to-disk which is available as separate patches for 2.4 and 2.6
134 kernels from swsusp.sourceforge.net. It includes support for SMP, 4GB
135 highmem and preemption. It also has a extensible architecture that
136 allows for arbitrary transformations on the image (compression,
137 encryption) and arbitrary backends for writing the image (eg to swap
138 or an NFS share[Work In Progress]). Questions regarding suspend2
139 should be sent to the mailing list available through the suspend2
140 website, and not to the Linux Kernel Mailing List. We are working
141 toward merging suspend2 into the mainline kernel.
142
143 Q: A kernel thread must voluntarily freeze itself (call 'refrigerator').
144 I found some kernel threads that don't do it, and they don't freeze
145 so the system can't sleep. Is this a known behavior?
146
147 A: All such kernel threads need to be fixed, one by one. Select the
148 place where the thread is safe to be frozen (no kernel semaphores
149 should be held at that point and it must be safe to sleep there), and
150 add:
151
152        try_to_freeze();
153
154 If the thread is needed for writing the image to storage, you should
155 instead set the PF_NOFREEZE process flag when creating the thread (and
156 be very careful).
157
158
159 Q: What is the difference between "platform" and "shutdown"?
160
161 A:
162
163 shutdown: save state in linux, then tell bios to powerdown
164
165 platform: save state in linux, then tell bios to powerdown and blink
166           "suspended led"
167
168 "platform" is actually right thing to do where supported, but
169 "shutdown" is most reliable (except on ACPI systems).
170
171 Q: I do not understand why you have such strong objections to idea of
172 selective suspend.
173
174 A: Do selective suspend during runtime power management, that's okay. But
175 it's useless for suspend-to-disk. (And I do not see how you could use
176 it for suspend-to-ram, I hope you do not want that).
177
178 Lets see, so you suggest to
179
180 * SUSPEND all but swap device and parents
181 * Snapshot
182 * Write image to disk
183 * SUSPEND swap device and parents
184 * Powerdown
185
186 Oh no, that does not work, if swap device or its parents uses DMA,
187 you've corrupted data. You'd have to do
188
189 * SUSPEND all but swap device and parents
190 * FREEZE swap device and parents
191 * Snapshot
192 * UNFREEZE swap device and parents
193 * Write
194 * SUSPEND swap device and parents
195
196 Which means that you still need that FREEZE state, and you get more
197 complicated code. (And I have not yet introduce details like system
198 devices).
199
200 Q: There don't seem to be any generally useful behavioral
201 distinctions between SUSPEND and FREEZE.
202
203 A: Doing SUSPEND when you are asked to do FREEZE is always correct,
204 but it may be unneccessarily slow. If you want your driver to stay simple,
205 slowness may not matter to you. It can always be fixed later.
206
207 For devices like disk it does matter, you do not want to spindown for
208 FREEZE.
209
210 Q: After resuming, system is paging heavily, leading to very bad interactivity.
211
212 A: Try running
213
214 cat `cat /proc/[0-9]*/maps | grep / | sed 's:.* /:/:' | sort -u` > /dev/null
215
216 after resume. swapoff -a; swapon -a may also be useful.
217
218 Q: What happens to devices during swsusp? They seem to be resumed
219 during system suspend?
220
221 A: That's correct. We need to resume them if we want to write image to
222 disk. Whole sequence goes like
223
224       Suspend part
225       ~~~~~~~~~~~~
226       running system, user asks for suspend-to-disk
227
228       user processes are stopped
229
230       suspend(PMSG_FREEZE): devices are frozen so that they don't interfere
231                       with state snapshot
232
233       state snapshot: copy of whole used memory is taken with interrupts disabled
234
235       resume(): devices are woken up so that we can write image to swap
236
237       write image to swap
238
239       suspend(PMSG_SUSPEND): suspend devices so that we can power off
240
241       turn the power off
242
243       Resume part
244       ~~~~~~~~~~~
245       (is actually pretty similar)
246
247       running system, user asks for suspend-to-disk
248
249       user processes are stopped (in common case there are none, but with resume-from-initrd, noone knows)
250
251       read image from disk
252
253       suspend(PMSG_FREEZE): devices are frozen so that they don't interfere
254                       with image restoration
255
256       image restoration: rewrite memory with image
257
258       resume(): devices are woken up so that system can continue
259
260       thaw all user processes
261
262 Q: What is this 'Encrypt suspend image' for?
263
264 A: First of all: it is not a replacement for dm-crypt encrypted swap.
265 It cannot protect your computer while it is suspended. Instead it does
266 protect from leaking sensitive data after resume from suspend.
267
268 Think of the following: you suspend while an application is running
269 that keeps sensitive data in memory. The application itself prevents
270 the data from being swapped out. Suspend, however, must write these
271 data to swap to be able to resume later on. Without suspend encryption
272 your sensitive data are then stored in plaintext on disk.  This means
273 that after resume your sensitive data are accessible to all
274 applications having direct access to the swap device which was used
275 for suspend. If you don't need swap after resume these data can remain
276 on disk virtually forever. Thus it can happen that your system gets
277 broken in weeks later and sensitive data which you thought were
278 encrypted and protected are retrieved and stolen from the swap device.
279 To prevent this situation you should use 'Encrypt suspend image'.
280
281 During suspend a temporary key is created and this key is used to
282 encrypt the data written to disk. When, during resume, the data was
283 read back into memory the temporary key is destroyed which simply
284 means that all data written to disk during suspend are then
285 inaccessible so they can't be stolen later on.  The only thing that
286 you must then take care of is that you call 'mkswap' for the swap
287 partition used for suspend as early as possible during regular
288 boot. This asserts that any temporary key from an oopsed suspend or
289 from a failed or aborted resume is erased from the swap device.
290
291 As a rule of thumb use encrypted swap to protect your data while your
292 system is shut down or suspended. Additionally use the encrypted
293 suspend image to prevent sensitive data from being stolen after
294 resume.
295
296 Q: Can I suspend to a swap file?
297
298 A: Generally, yes, you can.  However, it requires you to use the "resume=" and
299 "resume_offset=" kernel command line parameters, so the resume from a swap file
300 cannot be initiated from an initrd or initramfs image.  See
301 swsusp-and-swap-files.txt for details.
302
303 Q: Is there a maximum system RAM size that is supported by swsusp?
304
305 A: It should work okay with highmem.
306
307 Q: Does swsusp (to disk) use only one swap partition or can it use
308 multiple swap partitions (aggregate them into one logical space)?
309
310 A: Only one swap partition, sorry.
311
312 Q: If my application(s) causes lots of memory & swap space to be used
313 (over half of the total system RAM), is it correct that it is likely
314 to be useless to try to suspend to disk while that app is running?
315
316 A: No, it should work okay, as long as your app does not mlock()
317 it. Just prepare big enough swap partition.
318
319 Q: What information is useful for debugging suspend-to-disk problems?
320
321 A: Well, last messages on the screen are always useful. If something
322 is broken, it is usually some kernel driver, therefore trying with as
323 little as possible modules loaded helps a lot. I also prefer people to
324 suspend from console, preferably without X running. Booting with
325 init=/bin/bash, then swapon and starting suspend sequence manually
326 usually does the trick. Then it is good idea to try with latest
327 vanilla kernel.
328
329 Q: How can distributions ship a swsusp-supporting kernel with modular
330 disk drivers (especially SATA)?
331
332 A: Well, it can be done, load the drivers, then do echo into
333 /sys/power/disk/resume file from initrd. Be sure not to mount
334 anything, not even read-only mount, or you are going to lose your
335 data.
336
337 Q: How do I make suspend more verbose?
338
339 A: If you want to see any non-error kernel messages on the virtual
340 terminal the kernel switches to during suspend, you have to set the
341 kernel console loglevel to at least 4 (KERN_WARNING), for example by
342 doing
343
344         # save the old loglevel
345         read LOGLEVEL DUMMY < /proc/sys/kernel/printk
346         # set the loglevel so we see the progress bar.
347         # if the level is higher than needed, we leave it alone.
348         if [ $LOGLEVEL -lt 5 ]; then
349                 echo 5 > /proc/sys/kernel/printk
350                 fi
351
352         IMG_SZ=0
353         read IMG_SZ < /sys/power/image_size
354         echo -n disk > /sys/power/state
355         RET=$?
356         #
357         # the logic here is:
358         # if image_size > 0 (without kernel support, IMG_SZ will be zero),
359         # then try again with image_size set to zero.
360         if [ $RET -ne 0 -a $IMG_SZ -ne 0 ]; then # try again with minimal image size
361                 echo 0 > /sys/power/image_size
362                 echo -n disk > /sys/power/state
363                 RET=$?
364         fi
365
366         # restore previous loglevel
367         echo $LOGLEVEL > /proc/sys/kernel/printk
368         exit $RET
369
370 Q: Is this true that if I have a mounted filesystem on a USB device and
371 I suspend to disk, I can lose data unless the filesystem has been mounted
372 with "sync"?
373
374 A: That's right ... if you disconnect that device, you may lose data.
375 In fact, even with "-o sync" you can lose data if your programs have
376 information in buffers they haven't written out to a disk you disconnect,
377 or if you disconnect before the device finished saving data you wrote.
378
379 Software suspend normally powers down USB controllers, which is equivalent
380 to disconnecting all USB devices attached to your system.
381
382 Your system might well support low-power modes for its USB controllers
383 while the system is asleep, maintaining the connection, using true sleep
384 modes like "suspend-to-RAM" or "standby".  (Don't write "disk" to the
385 /sys/power/state file; write "standby" or "mem".)  We've not seen any
386 hardware that can use these modes through software suspend, although in
387 theory some systems might support "platform" modes that won't break the
388 USB connections.
389
390 Remember that it's always a bad idea to unplug a disk drive containing a
391 mounted filesystem.  That's true even when your system is asleep!  The
392 safest thing is to unmount all filesystems on removable media (such USB,
393 Firewire, CompactFlash, MMC, external SATA, or even IDE hotplug bays)
394 before suspending; then remount them after resuming.
395
396 Q: I upgraded the kernel from 2.6.15 to 2.6.16. Both kernels were
397 compiled with the similar configuration files. Anyway I found that
398 suspend to disk (and resume) is much slower on 2.6.16 compared to
399 2.6.15. Any idea for why that might happen or how can I speed it up?
400
401 A: This is because the size of the suspend image is now greater than
402 for 2.6.15 (by saving more data we can get more responsive system
403 after resume).
404
405 There's the /sys/power/image_size knob that controls the size of the
406 image.  If you set it to 0 (eg. by echo 0 > /sys/power/image_size as
407 root), the 2.6.15 behavior should be restored.  If it is still too
408 slow, take a look at suspend.sf.net -- userland suspend is faster and
409 supports LZF compression to speed it up further.