USB: implement usb_enable_autosuspend
[linux-2.6.git] / Documentation / usb / power-management.txt
1                         Power Management for USB
2
3                  Alan Stern <stern@rowland.harvard.edu>
4
5                             November 10, 2009
6
7
8
9         What is Power Management?
10         -------------------------
11
12 Power Management (PM) is the practice of saving energy by suspending
13 parts of a computer system when they aren't being used.  While a
14 component is "suspended" it is in a nonfunctional low-power state; it
15 might even be turned off completely.  A suspended component can be
16 "resumed" (returned to a functional full-power state) when the kernel
17 needs to use it.  (There also are forms of PM in which components are
18 placed in a less functional but still usable state instead of being
19 suspended; an example would be reducing the CPU's clock rate.  This
20 document will not discuss those other forms.)
21
22 When the parts being suspended include the CPU and most of the rest of
23 the system, we speak of it as a "system suspend".  When a particular
24 device is turned off while the system as a whole remains running, we
25 call it a "dynamic suspend" (also known as a "runtime suspend" or
26 "selective suspend").  This document concentrates mostly on how
27 dynamic PM is implemented in the USB subsystem, although system PM is
28 covered to some extent (see Documentation/power/*.txt for more
29 information about system PM).
30
31 Note: Dynamic PM support for USB is present only if the kernel was
32 built with CONFIG_USB_SUSPEND enabled.  System PM support is present
33 only if the kernel was built with CONFIG_SUSPEND or CONFIG_HIBERNATION
34 enabled.
35
36
37         What is Remote Wakeup?
38         ----------------------
39
40 When a device has been suspended, it generally doesn't resume until
41 the computer tells it to.  Likewise, if the entire computer has been
42 suspended, it generally doesn't resume until the user tells it to, say
43 by pressing a power button or opening the cover.
44
45 However some devices have the capability of resuming by themselves, or
46 asking the kernel to resume them, or even telling the entire computer
47 to resume.  This capability goes by several names such as "Wake On
48 LAN"; we will refer to it generically as "remote wakeup".  When a
49 device is enabled for remote wakeup and it is suspended, it may resume
50 itself (or send a request to be resumed) in response to some external
51 event.  Examples include a suspended keyboard resuming when a key is
52 pressed, or a suspended USB hub resuming when a device is plugged in.
53
54
55         When is a USB device idle?
56         --------------------------
57
58 A device is idle whenever the kernel thinks it's not busy doing
59 anything important and thus is a candidate for being suspended.  The
60 exact definition depends on the device's driver; drivers are allowed
61 to declare that a device isn't idle even when there's no actual
62 communication taking place.  (For example, a hub isn't considered idle
63 unless all the devices plugged into that hub are already suspended.)
64 In addition, a device isn't considered idle so long as a program keeps
65 its usbfs file open, whether or not any I/O is going on.
66
67 If a USB device has no driver, its usbfs file isn't open, and it isn't
68 being accessed through sysfs, then it definitely is idle.
69
70
71         Forms of dynamic PM
72         -------------------
73
74 Dynamic suspends occur when the kernel decides to suspend an idle
75 device.  This is called "autosuspend" for short.  In general, a device
76 won't be autosuspended unless it has been idle for some minimum period
77 of time, the so-called idle-delay time.
78
79 Of course, nothing the kernel does on its own initiative should
80 prevent the computer or its devices from working properly.  If a
81 device has been autosuspended and a program tries to use it, the
82 kernel will automatically resume the device (autoresume).  For the
83 same reason, an autosuspended device will usually have remote wakeup
84 enabled, if the device supports remote wakeup.
85
86 It is worth mentioning that many USB drivers don't support
87 autosuspend.  In fact, at the time of this writing (Linux 2.6.23) the
88 only drivers which do support it are the hub driver, kaweth, asix,
89 usblp, usblcd, and usb-skeleton (which doesn't count).  If a
90 non-supporting driver is bound to a device, the device won't be
91 autosuspended.  In effect, the kernel pretends the device is never
92 idle.
93
94 We can categorize power management events in two broad classes:
95 external and internal.  External events are those triggered by some
96 agent outside the USB stack: system suspend/resume (triggered by
97 userspace), manual dynamic resume (also triggered by userspace), and
98 remote wakeup (triggered by the device).  Internal events are those
99 triggered within the USB stack: autosuspend and autoresume.  Note that
100 all dynamic suspend events are internal; external agents are not
101 allowed to issue dynamic suspends.
102
103
104         The user interface for dynamic PM
105         ---------------------------------
106
107 The user interface for controlling dynamic PM is located in the power/
108 subdirectory of each USB device's sysfs directory, that is, in
109 /sys/bus/usb/devices/.../power/ where "..." is the device's ID.  The
110 relevant attribute files are: wakeup, level, and autosuspend.
111
112         power/wakeup
113
114                 This file is empty if the device does not support
115                 remote wakeup.  Otherwise the file contains either the
116                 word "enabled" or the word "disabled", and you can
117                 write those words to the file.  The setting determines
118                 whether or not remote wakeup will be enabled when the
119                 device is next suspended.  (If the setting is changed
120                 while the device is suspended, the change won't take
121                 effect until the following suspend.)
122
123         power/level
124
125                 This file contains one of two words: "on" or "auto".
126                 You can write those words to the file to change the
127                 device's setting.
128
129                 "on" means that the device should be resumed and
130                 autosuspend is not allowed.  (Of course, system
131                 suspends are still allowed.)
132
133                 "auto" is the normal state in which the kernel is
134                 allowed to autosuspend and autoresume the device.
135
136                 (In kernels up to 2.6.32, you could also specify
137                 "suspend", meaning that the device should remain
138                 suspended and autoresume was not allowed.  This
139                 setting is no longer supported.)
140
141         power/autosuspend
142
143                 This file contains an integer value, which is the
144                 number of seconds the device should remain idle before
145                 the kernel will autosuspend it (the idle-delay time).
146                 The default is 2.  0 means to autosuspend as soon as
147                 the device becomes idle, and negative values mean
148                 never to autosuspend.  You can write a number to the
149                 file to change the autosuspend idle-delay time.
150
151 Writing "-1" to power/autosuspend and writing "on" to power/level do
152 essentially the same thing -- they both prevent the device from being
153 autosuspended.  Yes, this is a redundancy in the API.
154
155 (In 2.6.21 writing "0" to power/autosuspend would prevent the device
156 from being autosuspended; the behavior was changed in 2.6.22.  The
157 power/autosuspend attribute did not exist prior to 2.6.21, and the
158 power/level attribute did not exist prior to 2.6.22.)
159
160
161         Changing the default idle-delay time
162         ------------------------------------
163
164 The default autosuspend idle-delay time is controlled by a module
165 parameter in usbcore.  You can specify the value when usbcore is
166 loaded.  For example, to set it to 5 seconds instead of 2 you would
167 do:
168
169         modprobe usbcore autosuspend=5
170
171 Equivalently, you could add to /etc/modprobe.conf a line saying:
172
173         options usbcore autosuspend=5
174
175 Some distributions load the usbcore module very early during the boot
176 process, by means of a program or script running from an initramfs
177 image.  To alter the parameter value you would have to rebuild that
178 image.
179
180 If usbcore is compiled into the kernel rather than built as a loadable
181 module, you can add
182
183         usbcore.autosuspend=5
184
185 to the kernel's boot command line.
186
187 Finally, the parameter value can be changed while the system is
188 running.  If you do:
189
190         echo 5 >/sys/module/usbcore/parameters/autosuspend
191
192 then each new USB device will have its autosuspend idle-delay
193 initialized to 5.  (The idle-delay values for already existing devices
194 will not be affected.)
195
196 Setting the initial default idle-delay to -1 will prevent any
197 autosuspend of any USB device.  This is a simple alternative to
198 disabling CONFIG_USB_SUSPEND and rebuilding the kernel, and it has the
199 added benefit of allowing you to enable autosuspend for selected
200 devices.
201
202
203         Warnings
204         --------
205
206 The USB specification states that all USB devices must support power
207 management.  Nevertheless, the sad fact is that many devices do not
208 support it very well.  You can suspend them all right, but when you
209 try to resume them they disconnect themselves from the USB bus or
210 they stop working entirely.  This seems to be especially prevalent
211 among printers and scanners, but plenty of other types of device have
212 the same deficiency.
213
214 For this reason, by default the kernel disables autosuspend (the
215 power/level attribute is initialized to "on") for all devices other
216 than hubs.  Hubs, at least, appear to be reasonably well-behaved in
217 this regard.
218
219 (In 2.6.21 and 2.6.22 this wasn't the case.  Autosuspend was enabled
220 by default for almost all USB devices.  A number of people experienced
221 problems as a result.)
222
223 This means that non-hub devices won't be autosuspended unless the user
224 or a program explicitly enables it.  As of this writing there aren't
225 any widespread programs which will do this; we hope that in the near
226 future device managers such as HAL will take on this added
227 responsibility.  In the meantime you can always carry out the
228 necessary operations by hand or add them to a udev script.  You can
229 also change the idle-delay time; 2 seconds is not the best choice for
230 every device.
231
232 If a driver knows that its device has proper suspend/resume support,
233 it can enable autosuspend all by itself.  For example, the video
234 driver for a laptop's webcam might do this, since these devices are
235 rarely used and so should normally be autosuspended.
236
237 Sometimes it turns out that even when a device does work okay with
238 autosuspend there are still problems.  For example, there are
239 experimental patches adding autosuspend support to the usbhid driver,
240 which manages keyboards and mice, among other things.  Tests with a
241 number of keyboards showed that typing on a suspended keyboard, while
242 causing the keyboard to do a remote wakeup all right, would
243 nonetheless frequently result in lost keystrokes.  Tests with mice
244 showed that some of them would issue a remote-wakeup request in
245 response to button presses but not to motion, and some in response to
246 neither.
247
248 The kernel will not prevent you from enabling autosuspend on devices
249 that can't handle it.  It is even possible in theory to damage a
250 device by suspending it at the wrong time -- for example, suspending a
251 USB hard disk might cause it to spin down without parking the heads.
252 (Highly unlikely, but possible.)  Take care.
253
254
255         The driver interface for Power Management
256         -----------------------------------------
257
258 The requirements for a USB driver to support external power management
259 are pretty modest; the driver need only define
260
261         .suspend
262         .resume
263         .reset_resume
264
265 methods in its usb_driver structure, and the reset_resume method is
266 optional.  The methods' jobs are quite simple:
267
268         The suspend method is called to warn the driver that the
269         device is going to be suspended.  If the driver returns a
270         negative error code, the suspend will be aborted.  Normally
271         the driver will return 0, in which case it must cancel all
272         outstanding URBs (usb_kill_urb()) and not submit any more.
273
274         The resume method is called to tell the driver that the
275         device has been resumed and the driver can return to normal
276         operation.  URBs may once more be submitted.
277
278         The reset_resume method is called to tell the driver that
279         the device has been resumed and it also has been reset.
280         The driver should redo any necessary device initialization,
281         since the device has probably lost most or all of its state
282         (although the interfaces will be in the same altsettings as
283         before the suspend).
284
285 If the device is disconnected or powered down while it is suspended,
286 the disconnect method will be called instead of the resume or
287 reset_resume method.  This is also quite likely to happen when
288 waking up from hibernation, as many systems do not maintain suspend
289 current to the USB host controllers during hibernation.  (It's
290 possible to work around the hibernation-forces-disconnect problem by
291 using the USB Persist facility.)
292
293 The reset_resume method is used by the USB Persist facility (see
294 Documentation/usb/persist.txt) and it can also be used under certain
295 circumstances when CONFIG_USB_PERSIST is not enabled.  Currently, if a
296 device is reset during a resume and the driver does not have a
297 reset_resume method, the driver won't receive any notification about
298 the resume.  Later kernels will call the driver's disconnect method;
299 2.6.23 doesn't do this.
300
301 USB drivers are bound to interfaces, so their suspend and resume
302 methods get called when the interfaces are suspended or resumed.  In
303 principle one might want to suspend some interfaces on a device (i.e.,
304 force the drivers for those interface to stop all activity) without
305 suspending the other interfaces.  The USB core doesn't allow this; all
306 interfaces are suspended when the device itself is suspended and all
307 interfaces are resumed when the device is resumed.  It isn't possible
308 to suspend or resume some but not all of a device's interfaces.  The
309 closest you can come is to unbind the interfaces' drivers.
310
311
312         The driver interface for autosuspend and autoresume
313         ---------------------------------------------------
314
315 To support autosuspend and autoresume, a driver should implement all
316 three of the methods listed above.  In addition, a driver indicates
317 that it supports autosuspend by setting the .supports_autosuspend flag
318 in its usb_driver structure.  It is then responsible for informing the
319 USB core whenever one of its interfaces becomes busy or idle.  The
320 driver does so by calling these six functions:
321
322         int  usb_autopm_get_interface(struct usb_interface *intf);
323         void usb_autopm_put_interface(struct usb_interface *intf);
324         int  usb_autopm_get_interface_async(struct usb_interface *intf);
325         void usb_autopm_put_interface_async(struct usb_interface *intf);
326         void usb_autopm_get_interface_no_resume(struct usb_interface *intf);
327         void usb_autopm_put_interface_no_suspend(struct usb_interface *intf);
328
329 The functions work by maintaining a counter in the usb_interface
330 structure.  When intf->pm_usage_count is > 0 then the interface is
331 deemed to be busy, and the kernel will not autosuspend the interface's
332 device.  When intf->pm_usage_count is <= 0 then the interface is
333 considered to be idle, and the kernel may autosuspend the device.
334
335 (There is a similar pm_usage_count field in struct usb_device,
336 associated with the device itself rather than any of its interfaces.
337 This field is used only by the USB core.)
338
339 Drivers must not modify intf->pm_usage_count directly; its value
340 should be changed only be using the functions listed above.  Drivers
341 are responsible for insuring that the overall change to pm_usage_count
342 during their lifetime balances out to 0 (it may be necessary for the
343 disconnect method to call usb_autopm_put_interface() one or more times
344 to fulfill this requirement).  The first two routines use the PM mutex
345 in struct usb_device for mutual exclusion; drivers using the async
346 routines are responsible for their own synchronization and mutual
347 exclusion.
348
349         usb_autopm_get_interface() increments pm_usage_count and
350         attempts an autoresume if the new value is > 0 and the
351         device is suspended.
352
353         usb_autopm_put_interface() decrements pm_usage_count and
354         attempts an autosuspend if the new value is <= 0 and the
355         device isn't suspended.
356
357         usb_autopm_get_interface_async() and
358         usb_autopm_put_interface_async() do almost the same things as
359         their non-async counterparts.  The differences are: they do
360         not acquire the PM mutex, and they use a workqueue to do their
361         jobs.  As a result they can be called in an atomic context,
362         such as an URB's completion handler, but when they return the
363         device will not generally not yet be in the desired state.
364
365         usb_autopm_get_interface_no_resume() and
366         usb_autopm_put_interface_no_suspend() merely increment or
367         decrement the pm_usage_count value; they do not attempt to
368         carry out an autoresume or an autosuspend.  Hence they can be
369         called in an atomic context.
370
371 The conventional usage pattern is that a driver calls
372 usb_autopm_get_interface() in its open routine and
373 usb_autopm_put_interface() in its close or release routine.  But
374 other patterns are possible.
375
376 The autosuspend attempts mentioned above will often fail for one
377 reason or another.  For example, the power/level attribute might be
378 set to "on", or another interface in the same device might not be
379 idle.  This is perfectly normal.  If the reason for failure was that
380 the device hasn't been idle for long enough, a delayed workqueue
381 routine is automatically set up to carry out the operation when the
382 autosuspend idle-delay has expired.
383
384 Autoresume attempts also can fail, although failure would mean that
385 the device is no longer present or operating properly.  Unlike
386 autosuspend, there's no delay for an autoresume.
387
388
389         Other parts of the driver interface
390         -----------------------------------
391
392 Drivers can enable autosuspend for their devices by calling
393
394         usb_enable_autosuspend(struct usb_device *udev);
395
396 in their probe() routine, if they know that the device is capable of
397 suspending and resuming correctly.  This is exactly equivalent to
398 writing "auto" to the device's power/level attribute.  Likewise,
399 drivers can disable autosuspend by calling
400
401         usb_disable_autosuspend(struct usb_device *udev);
402
403 This is exactly the same as writing "on" to the power/level attribute.
404
405 Sometimes a driver needs to make sure that remote wakeup is enabled
406 during autosuspend.  For example, there's not much point
407 autosuspending a keyboard if the user can't cause the keyboard to do a
408 remote wakeup by typing on it.  If the driver sets
409 intf->needs_remote_wakeup to 1, the kernel won't autosuspend the
410 device if remote wakeup isn't available or has been disabled through
411 the power/wakeup attribute.  (If the device is already autosuspended,
412 though, setting this flag won't cause the kernel to autoresume it.
413 Normally a driver would set this flag in its probe method, at which
414 time the device is guaranteed not to be autosuspended.)
415
416 The synchronous usb_autopm_* routines have to run in a sleepable
417 process context; they must not be called from an interrupt handler or
418 while holding a spinlock.  In fact, the entire autosuspend mechanism
419 is not well geared toward interrupt-driven operation.  However there
420 is one thing a driver can do in an interrupt handler:
421
422         usb_mark_last_busy(struct usb_device *udev);
423
424 This sets udev->last_busy to the current time.  udev->last_busy is the
425 field used for idle-delay calculations; updating it will cause any
426 pending autosuspend to be moved back.  The usb_autopm_* routines will
427 also set the last_busy field to the current time.
428
429 Calling urb_mark_last_busy() from within an URB completion handler is
430 subject to races: The kernel may have just finished deciding the
431 device has been idle for long enough but not yet gotten around to
432 calling the driver's suspend method.  The driver would have to be
433 responsible for synchronizing its suspend method with its URB
434 completion handler and causing the autosuspend to fail with -EBUSY if
435 an URB had completed too recently.
436
437 External suspend calls should never be allowed to fail in this way,
438 only autosuspend calls.  The driver can tell them apart by checking
439 the PM_EVENT_AUTO bit in the message.event argument to the suspend
440 method; this bit will be set for internal PM events (autosuspend) and
441 clear for external PM events.
442
443 Many of the ingredients in the autosuspend framework are oriented
444 towards interfaces: The usb_interface structure contains the
445 pm_usage_cnt field, and the usb_autopm_* routines take an interface
446 pointer as their argument.  But somewhat confusingly, a few of the
447 pieces (i.e., usb_mark_last_busy()) use the usb_device structure
448 instead.  Drivers need to keep this straight; they can call
449 interface_to_usbdev() to find the device structure for a given
450 interface.
451
452
453         Locking requirements
454         --------------------
455
456 All three suspend/resume methods are always called while holding the
457 usb_device's PM mutex.  For external events -- but not necessarily for
458 autosuspend or autoresume -- the device semaphore (udev->dev.sem) will
459 also be held.  This implies that external suspend/resume events are
460 mutually exclusive with calls to probe, disconnect, pre_reset, and
461 post_reset; the USB core guarantees that this is true of internal
462 suspend/resume events as well.
463
464 If a driver wants to block all suspend/resume calls during some
465 critical section, it can simply acquire udev->pm_mutex. Note that
466 calls to resume may be triggered indirectly. Block IO due to memory
467 allocations can make the vm subsystem resume a device. Thus while
468 holding this lock you must not allocate memory with GFP_KERNEL or
469 GFP_NOFS.
470
471 Alternatively, if the critical section might call some of the
472 usb_autopm_* routines, the driver can avoid deadlock by doing:
473
474         down(&udev->dev.sem);
475         rc = usb_autopm_get_interface(intf);
476
477 and at the end of the critical section:
478
479         if (!rc)
480                 usb_autopm_put_interface(intf);
481         up(&udev->dev.sem);
482
483 Holding the device semaphore will block all external PM calls, and the
484 usb_autopm_get_interface() will prevent any internal PM calls, even if
485 it fails.  (Exercise: Why?)
486
487 The rules for locking order are:
488
489         Never acquire any device semaphore while holding any PM mutex.
490
491         Never acquire udev->pm_mutex while holding the PM mutex for
492         a device that isn't a descendant of udev.
493
494 In other words, PM mutexes should only be acquired going up the device
495 tree, and they should be acquired only after locking all the device
496 semaphores you need to hold.  These rules don't matter to drivers very
497 much; they usually affect just the USB core.
498
499 Still, drivers do need to be careful.  For example, many drivers use a
500 private mutex to synchronize their normal I/O activities with their
501 disconnect method.  Now if the driver supports autosuspend then it
502 must call usb_autopm_put_interface() from somewhere -- maybe from its
503 close method.  It should make the call while holding the private mutex,
504 since a driver shouldn't call any of the usb_autopm_* functions for an
505 interface from which it has been unbound.
506
507 But the usb_autpm_* routines always acquire the device's PM mutex, and
508 consequently the locking order has to be: private mutex first, PM
509 mutex second.  Since the suspend method is always called with the PM
510 mutex held, it mustn't try to acquire the private mutex.  It has to
511 synchronize with the driver's I/O activities in some other way.
512
513
514         Interaction between dynamic PM and system PM
515         --------------------------------------------
516
517 Dynamic power management and system power management can interact in
518 a couple of ways.
519
520 Firstly, a device may already be manually suspended or autosuspended
521 when a system suspend occurs.  Since system suspends are supposed to
522 be as transparent as possible, the device should remain suspended
523 following the system resume.  The 2.6.23 kernel obeys this principle
524 for manually suspended devices but not for autosuspended devices; they
525 do get resumed when the system wakes up.  (Presumably they will be
526 autosuspended again after their idle-delay time expires.)  In later
527 kernels this behavior will be fixed.
528
529 (There is an exception.  If a device would undergo a reset-resume
530 instead of a normal resume, and the device is enabled for remote
531 wakeup, then the reset-resume takes place even if the device was
532 already suspended when the system suspend began.  The justification is
533 that a reset-resume is a kind of remote-wakeup event.  Or to put it
534 another way, a device which needs a reset won't be able to generate
535 normal remote-wakeup signals, so it ought to be resumed immediately.)
536
537 Secondly, a dynamic power-management event may occur as a system
538 suspend is underway.  The window for this is short, since system
539 suspends don't take long (a few seconds usually), but it can happen.
540 For example, a suspended device may send a remote-wakeup signal while
541 the system is suspending.  The remote wakeup may succeed, which would
542 cause the system suspend to abort.  If the remote wakeup doesn't
543 succeed, it may still remain active and thus cause the system to
544 resume as soon as the system suspend is complete.  Or the remote
545 wakeup may fail and get lost.  Which outcome occurs depends on timing
546 and on the hardware and firmware design.