msphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget3/translations/zh_CN/driver-api/usb/power-managementmodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget3/translations/zh_TW/driver-api/usb/power-managementmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget3/translations/it_IT/driver-api/usb/power-managementmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget3/translations/ja_JP/driver-api/usb/power-managementmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget3/translations/ko_KR/driver-api/usb/power-managementmodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget3/translations/sp_SP/driver-api/usb/power-managementmodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhtarget)}(h.. _usb-power-management:h]h}(h]h ]h"]h$]h&]refidusb-power-managementuh1hhKhhhhhM/var/lib/git/docbuild/linux/Documentation/driver-api/usb/power-management.rstubhsection)}(hhh](htitle)}(hPower Management for USBh]hPower Management for USB}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubh field_list)}(hhh](hfield)}(hhh](h field_name)}(hAuthorh]hAuthor}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhKubh field_body)}(h&Alan Stern h]h paragraph)}(hhh](h Alan Stern <}(hhhhhNhNubh reference)}(hstern@rowland.harvard.eduh]hstern@rowland.harvard.edu}(hhhhhNhNubah}(h]h ]h"]h$]h&]refuri mailto:stern@rowland.harvard.eduuh1hhhubh>}(hhhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhhubah}(h]h ]h"]h$]h&]uh1hhhubeh}(h]h ]h"]h$]h&]uh1hhhhKhhhhubh)}(hhh](h)}(hDateh]hDate}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhKubh)}(hLast-updated: February 2014 h]h)}(hLast-updated: February 2014h]hLast-updated: February 2014}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj'ubah}(h]h ]h"]h$]h&]uh1hhjubeh}(h]h ]h"]h$]h&]uh1hhhhKhhhhubeh}(h]h ]h"]h$]h&]uh1hhhhhhhhKubhcomment)}(hXContents: --------- * What is Power Management? * What is Remote Wakeup? * When is a USB device idle? * Forms of dynamic PM * The user interface for dynamic PM * Changing the default idle-delay time * Warnings * The driver interface for Power Management * The driver interface for autosuspend and autoresume * Other parts of the driver interface * Mutual exclusion * Interaction between dynamic PM and system PM * xHCI hardware link PM * USB Port Power Control * User Interface for Port Power Control * Suggested Userspace Port Power Policyh]hXContents: --------- * What is Power Management? * What is Remote Wakeup? * When is a USB device idle? * Forms of dynamic PM * The user interface for dynamic PM * Changing the default idle-delay time * Warnings * The driver interface for Power Management * The driver interface for autosuspend and autoresume * Other parts of the driver interface * Mutual exclusion * Interaction between dynamic PM and system PM * xHCI hardware link PM * USB Port Power Control * User Interface for Port Power Control * Suggested Userspace Port Power Policy}hjMsbah}(h]h ]h"]h$]h&] xml:spacepreserveuh1jKhhhhhhhKubh)}(hhh](h)}(hWhat is Power Management?h]hWhat is Power Management?}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj]hhhhhKubh)}(hXTPower Management (PM) is the practice of saving energy by suspending parts of a computer system when they aren't being used. While a component is ``suspended`` it is in a nonfunctional low-power state; it might even be turned off completely. A suspended component can be ``resumed`` (returned to a functional full-power state) when the kernel needs to use it. (There also are forms of PM in which components are placed in a less functional but still usable state instead of being suspended; an example would be reducing the CPU's clock rate. This document will not discuss those other forms.)h](hPower Management (PM) is the practice of saving energy by suspending parts of a computer system when they aren’t being used. While a component is }(hjnhhhNhNubhliteral)}(h ``suspended``h]h suspended}(hjxhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjnubhq it is in a nonfunctional low-power state; it might even be turned off completely. A suspended component can be }(hjnhhhNhNubjw)}(h ``resumed``h]hresumed}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjnubhX: (returned to a functional full-power state) when the kernel needs to use it. (There also are forms of PM in which components are placed in a less functional but still usable state instead of being suspended; an example would be reducing the CPU’s clock rate. This document will not discuss those other forms.)}(hjnhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK!hj]hhubh)}(hXWhen the parts being suspended include the CPU and most of the rest of the system, we speak of it as a "system suspend". When a particular device is turned off while the system as a whole remains running, we call it a "dynamic suspend" (also known as a "runtime suspend" or "selective suspend"). This document concentrates mostly on how dynamic PM is implemented in the USB subsystem, although system PM is covered to some extent (see ``Documentation/power/*.rst`` for more information about system PM).h](hXWhen the parts being suspended include the CPU and most of the rest of the system, we speak of it as a “system suspend”. When a particular device is turned off while the system as a whole remains running, we call it a “dynamic suspend” (also known as a “runtime suspend” or “selective suspend”). This document concentrates mostly on how dynamic PM is implemented in the USB subsystem, although system PM is covered to some extent (see }(hjhhhNhNubjw)}(h``Documentation/power/*.rst``h]hDocumentation/power/*.rst}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh' for more information about system PM).}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK+hj]hhubh)}(hSystem PM support is present only if the kernel was built with ``CONFIG_SUSPEND`` or ``CONFIG_HIBERNATION`` enabled. Dynamic PM supporth](h?System PM support is present only if the kernel was built with }(hjhhhNhNubjw)}(h``CONFIG_SUSPEND``h]hCONFIG_SUSPEND}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh or }(hjhhhNhNubjw)}(h``CONFIG_HIBERNATION``h]hCONFIG_HIBERNATION}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh enabled. Dynamic PM support}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK4hj]hhubh)}(hLfor USB is present whenever the kernel was built with ``CONFIG_PM`` enabled.h](h6for USB is present whenever the kernel was built with }(hjhhhNhNubjw)}(h ``CONFIG_PM``h]h CONFIG_PM}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh enabled.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK7hj]hhubh)}(hXp[Historically, dynamic PM support for USB was present only if the kernel had been built with ``CONFIG_USB_SUSPEND`` enabled (which depended on ``CONFIG_PM_RUNTIME``). Starting with the 3.10 kernel release, dynamic PM support for USB was present whenever the kernel was built with ``CONFIG_PM_RUNTIME`` enabled. The ``CONFIG_USB_SUSPEND`` option had been eliminated.]h](h][Historically, dynamic PM support for USB was present only if the kernel had been built with }(hjhhhNhNubjw)}(h``CONFIG_USB_SUSPEND``h]hCONFIG_USB_SUSPEND}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh enabled (which depended on }(hjhhhNhNubjw)}(h``CONFIG_PM_RUNTIME``h]hCONFIG_PM_RUNTIME}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubhu). Starting with the 3.10 kernel release, dynamic PM support for USB was present whenever the kernel was built with }(hjhhhNhNubjw)}(h``CONFIG_PM_RUNTIME``h]hCONFIG_PM_RUNTIME}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh enabled. The }(hjhhhNhNubjw)}(h``CONFIG_USB_SUSPEND``h]hCONFIG_USB_SUSPEND}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh option had been eliminated.]}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK:hj]hhubeh}(h]what-is-power-managementah ]h"]what is power management?ah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hWhat is Remote Wakeup?h]hWhat is Remote Wakeup?}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjrhhhhhKCubh)}(hXWhen a device has been suspended, it generally doesn't resume until the computer tells it to. Likewise, if the entire computer has been suspended, it generally doesn't resume until the user tells it to, say by pressing a power button or opening the cover.h]hXWhen a device has been suspended, it generally doesn’t resume until the computer tells it to. Likewise, if the entire computer has been suspended, it generally doesn’t resume until the user tells it to, say by pressing a power button or opening the cover.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKEhjrhhubh)}(hX)However some devices have the capability of resuming by themselves, or asking the kernel to resume them, or even telling the entire computer to resume. This capability goes by several names such as "Wake On LAN"; we will refer to it generically as "remote wakeup". When a device is enabled for remote wakeup and it is suspended, it may resume itself (or send a request to be resumed) in response to some external event. Examples include a suspended keyboard resuming when a key is pressed, or a suspended USB hub resuming when a device is plugged in.h]hX1However some devices have the capability of resuming by themselves, or asking the kernel to resume them, or even telling the entire computer to resume. This capability goes by several names such as “Wake On LAN”; we will refer to it generically as “remote wakeup”. When a device is enabled for remote wakeup and it is suspended, it may resume itself (or send a request to be resumed) in response to some external event. Examples include a suspended keyboard resuming when a key is pressed, or a suspended USB hub resuming when a device is plugged in.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKJhjrhhubeh}(h]what-is-remote-wakeupah ]h"]what is remote wakeup?ah$]h&]uh1hhhhhhhhKCubh)}(hhh](h)}(hWhen is a USB device idle?h]hWhen is a USB device idle?}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKUubh)}(hXA device is idle whenever the kernel thinks it's not busy doing anything important and thus is a candidate for being suspended. The exact definition depends on the device's driver; drivers are allowed to declare that a device isn't idle even when there's no actual communication taking place. (For example, a hub isn't considered idle unless all the devices plugged into that hub are already suspended.) In addition, a device isn't considered idle so long as a program keeps its usbfs file open, whether or not any I/O is going on.h]hX!A device is idle whenever the kernel thinks it’s not busy doing anything important and thus is a candidate for being suspended. The exact definition depends on the device’s driver; drivers are allowed to declare that a device isn’t idle even when there’s no actual communication taking place. (For example, a hub isn’t considered idle unless all the devices plugged into that hub are already suspended.) In addition, a device isn’t considered idle so long as a program keeps its usbfs file open, whether or not any I/O is going on.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKWhjhhubh)}(hIf a USB device has no driver, its usbfs file isn't open, and it isn't being accessed through sysfs, then it definitely is idle.h]hIf a USB device has no driver, its usbfs file isn’t open, and it isn’t being accessed through sysfs, then it definitely is idle.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK`hjhhubeh}(h]when-is-a-usb-device-idleah ]h"]when is a usb device idle?ah$]h&]uh1hhhhhhhhKUubh)}(hhh](h)}(hForms of dynamic PMh]hForms of dynamic PM}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKeubh)}(hDynamic suspends occur when the kernel decides to suspend an idle device. This is called ``autosuspend`` for short. In general, a device won't be autosuspended unless it has been idle for some minimum period of time, the so-called idle-delay time.h](hZDynamic suspends occur when the kernel decides to suspend an idle device. This is called }(hjhhhNhNubjw)}(h``autosuspend``h]h autosuspend}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh for short. In general, a device won’t be autosuspended unless it has been idle for some minimum period of time, the so-called idle-delay time.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKghjhhubh)}(hXxOf course, nothing the kernel does on its own initiative should prevent the computer or its devices from working properly. If a device has been autosuspended and a program tries to use it, the kernel will automatically resume the device (autoresume). For the same reason, an autosuspended device will usually have remote wakeup enabled, if the device supports remote wakeup.h]hXxOf course, nothing the kernel does on its own initiative should prevent the computer or its devices from working properly. If a device has been autosuspended and a program tries to use it, the kernel will automatically resume the device (autoresume). For the same reason, an autosuspended device will usually have remote wakeup enabled, if the device supports remote wakeup.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKlhjhhubh)}(hXIt is worth mentioning that many USB drivers don't support autosuspend. In fact, at the time of this writing (Linux 2.6.23) the only drivers which do support it are the hub driver, kaweth, asix, usblp, usblcd, and usb-skeleton (which doesn't count). If a non-supporting driver is bound to a device, the device won't be autosuspended. In effect, the kernel pretends the device is never idle.h]hXIt is worth mentioning that many USB drivers don’t support autosuspend. In fact, at the time of this writing (Linux 2.6.23) the only drivers which do support it are the hub driver, kaweth, asix, usblp, usblcd, and usb-skeleton (which doesn’t count). If a non-supporting driver is bound to a device, the device won’t be autosuspended. In effect, the kernel pretends the device is never idle.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKshjhhubh)}(hXWe can categorize power management events in two broad classes: external and internal. External events are those triggered by some agent outside the USB stack: system suspend/resume (triggered by userspace), manual dynamic resume (also triggered by userspace), and remote wakeup (triggered by the device). Internal events are those triggered within the USB stack: autosuspend and autoresume. Note that all dynamic suspend events are internal; external agents are not allowed to issue dynamic suspends.h]hXWe can categorize power management events in two broad classes: external and internal. External events are those triggered by some agent outside the USB stack: system suspend/resume (triggered by userspace), manual dynamic resume (also triggered by userspace), and remote wakeup (triggered by the device). Internal events are those triggered within the USB stack: autosuspend and autoresume. Note that all dynamic suspend events are internal; external agents are not allowed to issue dynamic suspends.}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK{hjhhubeh}(h]forms-of-dynamic-pmah ]h"]forms of dynamic pmah$]h&]uh1hhhhhhhhKeubh)}(hhh](h)}(h!The user interface for dynamic PMh]h!The user interface for dynamic PM}(hjBhhhNhNubah}(h]h ]h"]h$]h&]uh1hhj?hhhhhKubh)}(hXThe user interface for controlling dynamic PM is located in the ``power/`` subdirectory of each USB device's sysfs directory, that is, in ``/sys/bus/usb/devices/.../power/`` where "..." is the device's ID. The relevant attribute files are: wakeup, control, and ``autosuspend_delay_ms``. (There may also be a file named ``level``; this file was deprecated as of the 2.6.35 kernel and replaced by the ``control`` file. In 2.6.38 the ``autosuspend`` file will be deprecated and replaced by the ``autosuspend_delay_ms`` file. The only difference is that the newer file expresses the delay in milliseconds whereas the older file uses seconds. Confusingly, both files are present in 2.6.37 but only ``autosuspend`` works.)h](h@The user interface for controlling dynamic PM is located in the }(hjPhhhNhNubjw)}(h ``power/``h]hpower/}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjPubhB subdirectory of each USB device’s sysfs directory, that is, in }(hjPhhhNhNubjw)}(h#``/sys/bus/usb/devices/.../power/``h]h/sys/bus/usb/devices/.../power/}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjPubh_ where “...” is the device’s ID. The relevant attribute files are: wakeup, control, and }(hjPhhhNhNubjw)}(h``autosuspend_delay_ms``h]hautosuspend_delay_ms}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjPubh#. (There may also be a file named }(hjPhhhNhNubjw)}(h ``level``h]hlevel}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjPubhG; this file was deprecated as of the 2.6.35 kernel and replaced by the }(hjPhhhNhNubjw)}(h ``control``h]hcontrol}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjPubh file. In 2.6.38 the }(hjPhhhNhNubjw)}(h``autosuspend``h]h autosuspend}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjPubh- file will be deprecated and replaced by the }(hjPhhhNhNubjw)}(h``autosuspend_delay_ms``h]hautosuspend_delay_ms}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjPubh file. The only difference is that the newer file expresses the delay in milliseconds whereas the older file uses seconds. Confusingly, both files are present in 2.6.37 but only }(hjPhhhNhNubjw)}(h``autosuspend``h]h autosuspend}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjPubh works.)}(hjPhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj?hhubh block_quote)}(hX_``power/wakeup`` This file is empty if the device does not support remote wakeup. Otherwise the file contains either the word ``enabled`` or the word ``disabled``, and you can write those words to the file. The setting determines whether or not remote wakeup will be enabled when the device is next suspended. (If the setting is changed while the device is suspended, the change won't take effect until the following suspend.) ``power/control`` This file contains one of two words: ``on`` or ``auto``. You can write those words to the file to change the device's setting. - ``on`` means that the device should be resumed and autosuspend is not allowed. (Of course, system suspends are still allowed.) - ``auto`` is the normal state in which the kernel is allowed to autosuspend and autoresume the device. (In kernels up to 2.6.32, you could also specify ``suspend``, meaning that the device should remain suspended and autoresume was not allowed. This setting is no longer supported.) ``power/autosuspend_delay_ms`` This file contains an integer value, which is the number of milliseconds the device should remain idle before the kernel will autosuspend it (the idle-delay time). The default is 2000. 0 means to autosuspend as soon as the device becomes idle, and negative values mean never to autosuspend. You can write a number to the file to change the autosuspend idle-delay time. h](h)}(h``power/wakeup``h]jw)}(hjh]h power/wakeup}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubah}(h]h ]h"]h$]h&]uh1hhhhKhjubj)}(hXThis file is empty if the device does not support remote wakeup. Otherwise the file contains either the word ``enabled`` or the word ``disabled``, and you can write those words to the file. The setting determines whether or not remote wakeup will be enabled when the device is next suspended. (If the setting is changed while the device is suspended, the change won't take effect until the following suspend.) h]h)}(hXThis file is empty if the device does not support remote wakeup. Otherwise the file contains either the word ``enabled`` or the word ``disabled``, and you can write those words to the file. The setting determines whether or not remote wakeup will be enabled when the device is next suspended. (If the setting is changed while the device is suspended, the change won't take effect until the following suspend.)h](hnThis file is empty if the device does not support remote wakeup. Otherwise the file contains either the word }(hjhhhNhNubjw)}(h ``enabled``h]henabled}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh or the word }(hjhhhNhNubjw)}(h ``disabled``h]hdisabled}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubhX , and you can write those words to the file. The setting determines whether or not remote wakeup will be enabled when the device is next suspended. (If the setting is changed while the device is suspended, the change won’t take effect until the following suspend.)}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj ubah}(h]h ]h"]h$]h&]uh1jhhhKhjubh)}(h``power/control``h]jw)}(hjIh]h power/control}(hjKhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjGubah}(h]h ]h"]h$]h&]uh1hhhhKhjubj)}(hX'This file contains one of two words: ``on`` or ``auto``. You can write those words to the file to change the device's setting. - ``on`` means that the device should be resumed and autosuspend is not allowed. (Of course, system suspends are still allowed.) - ``auto`` is the normal state in which the kernel is allowed to autosuspend and autoresume the device. (In kernels up to 2.6.32, you could also specify ``suspend``, meaning that the device should remain suspended and autoresume was not allowed. This setting is no longer supported.) h](h)}(h~This file contains one of two words: ``on`` or ``auto``. You can write those words to the file to change the device's setting.h](h%This file contains one of two words: }(hjbhhhNhNubjw)}(h``on``h]hon}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjbubh or }(hjbhhhNhNubjw)}(h``auto``h]hauto}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjbubhI. You can write those words to the file to change the device’s setting.}(hjbhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj^ubh bullet_list)}(hhh](h list_item)}(h``on`` means that the device should be resumed and autosuspend is not allowed. (Of course, system suspends are still allowed.) h]h)}(h``on`` means that the device should be resumed and autosuspend is not allowed. (Of course, system suspends are still allowed.)h](jw)}(h``on``h]hon}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubhy means that the device should be resumed and autosuspend is not allowed. (Of course, system suspends are still allowed.)}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hf``auto`` is the normal state in which the kernel is allowed to autosuspend and autoresume the device. h]h)}(he``auto`` is the normal state in which the kernel is allowed to autosuspend and autoresume the device.h](jw)}(h``auto``h]hauto}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh] is the normal state in which the kernel is allowed to autosuspend and autoresume the device.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]bullet-uh1jhhhKhj^ubh)}(h(In kernels up to 2.6.32, you could also specify ``suspend``, meaning that the device should remain suspended and autoresume was not allowed. This setting is no longer supported.)h](h1(In kernels up to 2.6.32, you could also specify }(hjhhhNhNubjw)}(h ``suspend``h]hsuspend}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubhx, meaning that the device should remain suspended and autoresume was not allowed. This setting is no longer supported.)}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj^ubeh}(h]h ]h"]h$]h&]uh1jhhhKhjubh)}(h``power/autosuspend_delay_ms``h]jw)}(hjh]hpower/autosuspend_delay_ms}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubah}(h]h ]h"]h$]h&]uh1hhhhKhjubj)}(hXtThis file contains an integer value, which is the number of milliseconds the device should remain idle before the kernel will autosuspend it (the idle-delay time). The default is 2000. 0 means to autosuspend as soon as the device becomes idle, and negative values mean never to autosuspend. You can write a number to the file to change the autosuspend idle-delay time. h]h)}(hXsThis file contains an integer value, which is the number of milliseconds the device should remain idle before the kernel will autosuspend it (the idle-delay time). The default is 2000. 0 means to autosuspend as soon as the device becomes idle, and negative values mean never to autosuspend. You can write a number to the file to change the autosuspend idle-delay time.h]hXsThis file contains an integer value, which is the number of milliseconds the device should remain idle before the kernel will autosuspend it (the idle-delay time). The default is 2000. 0 means to autosuspend as soon as the device becomes idle, and negative values mean never to autosuspend. You can write a number to the file to change the autosuspend idle-delay time.}(hj0hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj,ubah}(h]h ]h"]h$]h&]uh1jhhhKhjubeh}(h]h ]h"]h$]h&]uh1jhhhKhj?hhubh)}(hWriting ``-1`` to ``power/autosuspend_delay_ms`` and writing ``on`` to ``power/control`` do essentially the same thing -- they both prevent the device from being autosuspended. Yes, this is a redundancy in the API.h](hWriting }(hjJhhhNhNubjw)}(h``-1``h]h-1}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjJubh to }(hjJhhhNhNubjw)}(h``power/autosuspend_delay_ms``h]hpower/autosuspend_delay_ms}(hjdhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjJubh and writing }(hjJhhhNhNubjw)}(h``on``h]hon}(hjvhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjJubh to }(hjJhhhNhNubjw)}(h``power/control``h]h power/control}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjJubh do essentially the same thing -- they both prevent the device from being autosuspended. Yes, this is a redundancy in the API.}(hjJhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj?hhubh)}(hX(In 2.6.21 writing ``0`` to ``power/autosuspend`` would prevent the device from being autosuspended; the behavior was changed in 2.6.22. The ``power/autosuspend`` attribute did not exist prior to 2.6.21, and the ``power/level`` attribute did not exist prior to 2.6.22. ``power/control`` was added in 2.6.34, and ``power/autosuspend_delay_ms`` was added in 2.6.37 but did not become functional until 2.6.38.)h](h(In 2.6.21 writing }(hjhhhNhNubjw)}(h``0``h]h0}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh to }(hjhhhNhNubjw)}(h``power/autosuspend``h]hpower/autosuspend}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh] would prevent the device from being autosuspended; the behavior was changed in 2.6.22. The }(hjhhhNhNubjw)}(h``power/autosuspend``h]hpower/autosuspend}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh2 attribute did not exist prior to 2.6.21, and the }(hjhhhNhNubjw)}(h``power/level``h]h power/level}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh+ attribute did not exist prior to 2.6.22. }(hjhhhNhNubjw)}(h``power/control``h]h power/control}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh was added in 2.6.34, and }(hjhhhNhNubjw)}(h``power/autosuspend_delay_ms``h]hpower/autosuspend_delay_ms}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubhA was added in 2.6.37 but did not become functional until 2.6.38.)}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj?hhubeh}(h]!the-user-interface-for-dynamic-pmah ]h"]!the user interface for dynamic pmah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h$Changing the default idle-delay timeh]h$Changing the default idle-delay time}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj"hhhhhKubh)}(hThe default autosuspend idle-delay time (in seconds) is controlled by a module parameter in usbcore. You can specify the value when usbcore is loaded. For example, to set it to 5 seconds instead of 2 you would do::h]hThe default autosuspend idle-delay time (in seconds) is controlled by a module parameter in usbcore. You can specify the value when usbcore is loaded. For example, to set it to 5 seconds instead of 2 you would do:}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj"hhubh literal_block)}(hmodprobe usbcore autosuspend=5h]hmodprobe usbcore autosuspend=5}hjCsbah}(h]h ]h"]h$]h&]j[j\uh1jAhhhKhj"hhubh)}(hVEquivalently, you could add to a configuration file in /etc/modprobe.d a line saying::h]hUEquivalently, you could add to a configuration file in /etc/modprobe.d a line saying:}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj"hhubjB)}(hoptions usbcore autosuspend=5h]hoptions usbcore autosuspend=5}hj_sbah}(h]h ]h"]h$]h&]j[j\uh1jAhhhKhj"hhubh)}(hSome distributions load the usbcore module very early during the boot process, by means of a program or script running from an initramfs image. To alter the parameter value you would have to rebuild that image.h]hSome distributions load the usbcore module very early during the boot process, by means of a program or script running from an initramfs image. To alter the parameter value you would have to rebuild that image.}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj"hhubh)}(h\If usbcore is compiled into the kernel rather than built as a loadable module, you can add::h]h[If usbcore is compiled into the kernel rather than built as a loadable module, you can add:}(hj{hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj"hhubjB)}(husbcore.autosuspend=5h]husbcore.autosuspend=5}hjsbah}(h]h ]h"]h$]h&]j[j\uh1jAhhhKhj"hhubh)}(h"to the kernel's boot command line.h]h$to the kernel’s boot command line.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj"hhubh)}(hUFinally, the parameter value can be changed while the system is running. If you do::h]hTFinally, the parameter value can be changed while the system is running. If you do:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj"hhubjB)}(h2echo 5 >/sys/module/usbcore/parameters/autosuspendh]h2echo 5 >/sys/module/usbcore/parameters/autosuspend}hjsbah}(h]h ]h"]h$]h&]j[j\uh1jAhhhKhj"hhubh)}(hthen each new USB device will have its autosuspend idle-delay initialized to 5. (The idle-delay values for already existing devices will not be affected.)h]hthen each new USB device will have its autosuspend idle-delay initialized to 5. (The idle-delay values for already existing devices will not be affected.)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj"hhubh)}(hSetting the initial default idle-delay to -1 will prevent any autosuspend of any USB device. This has the benefit of allowing you then to enable autosuspend for selected devices.h]hSetting the initial default idle-delay to -1 will prevent any autosuspend of any USB device. This has the benefit of allowing you then to enable autosuspend for selected devices.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj"hhubeh}(h]$changing-the-default-idle-delay-timeah ]h"]$changing the default idle-delay timeah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(hWarningsh]hWarnings}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubh)}(hXThe USB specification states that all USB devices must support power management. Nevertheless, the sad fact is that many devices do not support it very well. You can suspend them all right, but when you try to resume them they disconnect themselves from the USB bus or they stop working entirely. This seems to be especially prevalent among printers and scanners, but plenty of other types of device have the same deficiency.h]hXThe USB specification states that all USB devices must support power management. Nevertheless, the sad fact is that many devices do not support it very well. You can suspend them all right, but when you try to resume them they disconnect themselves from the USB bus or they stop working entirely. This seems to be especially prevalent among printers and scanners, but plenty of other types of device have the same deficiency.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(hFor this reason, by default the kernel disables autosuspend (the ``power/control`` attribute is initialized to ``on``) for all devices other than hubs. Hubs, at least, appear to be reasonably well-behaved in this regard.h](hAFor this reason, by default the kernel disables autosuspend (the }(hjhhhNhNubjw)}(h``power/control``h]h power/control}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh attribute is initialized to }(hjhhhNhNubjw)}(h``on``h]hon}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubhh) for all devices other than hubs. Hubs, at least, appear to be reasonably well-behaved in this regard.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh)}(h(In 2.6.21 and 2.6.22 this wasn't the case. Autosuspend was enabled by default for almost all USB devices. A number of people experienced problems as a result.)h]h(In 2.6.21 and 2.6.22 this wasn’t the case. Autosuspend was enabled by default for almost all USB devices. A number of people experienced problems as a result.)}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hXThis means that non-hub devices won't be autosuspended unless the user or a program explicitly enables it. As of this writing there aren't any widespread programs which will do this; we hope that in the near future device managers such as HAL will take on this added responsibility. In the meantime you can always carry out the necessary operations by hand or add them to a udev script. You can also change the idle-delay time; 2 seconds is not the best choice for every device.h]hXThis means that non-hub devices won’t be autosuspended unless the user or a program explicitly enables it. As of this writing there aren’t any widespread programs which will do this; we hope that in the near future device managers such as HAL will take on this added responsibility. In the meantime you can always carry out the necessary operations by hand or add them to a udev script. You can also change the idle-delay time; 2 seconds is not the best choice for every device.}(hjDhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hXIf a driver knows that its device has proper suspend/resume support, it can enable autosuspend all by itself. For example, the video driver for a laptop's webcam might do this (in recent kernels they do), since these devices are rarely used and so should normally be autosuspended.h]hXIf a driver knows that its device has proper suspend/resume support, it can enable autosuspend all by itself. For example, the video driver for a laptop’s webcam might do this (in recent kernels they do), since these devices are rarely used and so should normally be autosuspended.}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hX Sometimes it turns out that even when a device does work okay with autosuspend there are still problems. For example, the usbhid driver, which manages keyboards and mice, has autosuspend support. Tests with a number of keyboards show that typing on a suspended keyboard, while causing the keyboard to do a remote wakeup all right, will nonetheless frequently result in lost keystrokes. Tests with mice show that some of them will issue a remote-wakeup request in response to button presses but not to motion, and some in response to neither.h]hX Sometimes it turns out that even when a device does work okay with autosuspend there are still problems. For example, the usbhid driver, which manages keyboards and mice, has autosuspend support. Tests with a number of keyboards show that typing on a suspended keyboard, while causing the keyboard to do a remote wakeup all right, will nonetheless frequently result in lost keystrokes. Tests with mice show that some of them will issue a remote-wakeup request in response to button presses but not to motion, and some in response to neither.}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hThe kernel will not prevent you from enabling autosuspend on devices that can't handle it. It is even possible in theory to damage a device by suspending it at the wrong time. (Highly unlikely, but possible.) Take care.h]hThe kernel will not prevent you from enabling autosuspend on devices that can’t handle it. It is even possible in theory to damage a device by suspending it at the wrong time. (Highly unlikely, but possible.) Take care.}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubeh}(h]warningsah ]h"]warningsah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h)The driver interface for Power Managementh]h)The driver interface for Power Management}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhM%ubh)}(hwThe requirements for a USB driver to support external power management are pretty modest; the driver need only define::h]hvThe requirements for a USB driver to support external power management are pretty modest; the driver need only define:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM'hjhhubjB)}(h.suspend .resume .reset_resumeh]h.suspend .resume .reset_resume}hjsbah}(h]h ]h"]h$]h&]j[j\uh1jAhhhM*hjhhubh)}(hmethods in its :c:type:`usb_driver` structure, and the ``reset_resume`` method is optional. The methods' jobs are quite simple:h](hmethods in its }(hjhhhNhNubh)}(h:c:type:`usb_driver`h]jw)}(hjh]h usb_driver}(hjhhhNhNubah}(h]h ](xrefcc-typeeh"]h$]h&]uh1jvhjubah}(h]h ]h"]h$]h&]refdocdriver-api/usb/power-management refdomainjreftypetype refexplicitrefwarn reftarget usb_driveruh1hhhhM.hjubh structure, and the }(hjhhhNhNubjw)}(h``reset_resume``h]h reset_resume}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh; method is optional. The methods’ jobs are quite simple:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM.hjhhubj)}(hX3- The ``suspend`` method is called to warn the driver that the device is going to be suspended. If the driver returns a negative error code, the suspend will be aborted. Normally the driver will return 0, in which case it must cancel all outstanding URBs (:c:func:`usb_kill_urb`) and not submit any more. - The ``resume`` method is called to tell the driver that the device has been resumed and the driver can return to normal operation. URBs may once more be submitted. - The ``reset_resume`` method is called to tell the driver that the device has been resumed and it also has been reset. The driver should redo any necessary device initialization, since the device has probably lost most or all of its state (although the interfaces will be in the same altsettings as before the suspend). h]j)}(hhh](j)}(hX1The ``suspend`` method is called to warn the driver that the device is going to be suspended. If the driver returns a negative error code, the suspend will be aborted. Normally the driver will return 0, in which case it must cancel all outstanding URBs (:c:func:`usb_kill_urb`) and not submit any more. h]h)}(hX0The ``suspend`` method is called to warn the driver that the device is going to be suspended. If the driver returns a negative error code, the suspend will be aborted. Normally the driver will return 0, in which case it must cancel all outstanding URBs (:c:func:`usb_kill_urb`) and not submit any more.h](hThe }(hjhhhNhNubjw)}(h ``suspend``h]hsuspend}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh method is called to warn the driver that the device is going to be suspended. If the driver returns a negative error code, the suspend will be aborted. Normally the driver will return 0, in which case it must cancel all outstanding URBs (}(hjhhhNhNubh)}(h:c:func:`usb_kill_urb`h]jw)}(hjh]husb_kill_urb()}(hj!hhhNhNubah}(h]h ](jjc-funceh"]h$]h&]uh1jvhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypefunc refexplicitrefwarnj usb_kill_urbuh1hhhhM1hjubh) and not submit any more.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM1hjubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hThe ``resume`` method is called to tell the driver that the device has been resumed and the driver can return to normal operation. URBs may once more be submitted. h]h)}(hThe ``resume`` method is called to tell the driver that the device has been resumed and the driver can return to normal operation. URBs may once more be submitted.h](hThe }(hjPhhhNhNubjw)}(h ``resume``h]hresume}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjPubh method is called to tell the driver that the device has been resumed and the driver can return to normal operation. URBs may once more be submitted.}(hjPhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM7hjLubah}(h]h ]h"]h$]h&]uh1jhjubj)}(hX?The ``reset_resume`` method is called to tell the driver that the device has been resumed and it also has been reset. The driver should redo any necessary device initialization, since the device has probably lost most or all of its state (although the interfaces will be in the same altsettings as before the suspend). h]h)}(hX>The ``reset_resume`` method is called to tell the driver that the device has been resumed and it also has been reset. The driver should redo any necessary device initialization, since the device has probably lost most or all of its state (although the interfaces will be in the same altsettings as before the suspend).h](hThe }(hjzhhhNhNubjw)}(h``reset_resume``h]h reset_resume}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjzubhX* method is called to tell the driver that the device has been resumed and it also has been reset. The driver should redo any necessary device initialization, since the device has probably lost most or all of its state (although the interfaces will be in the same altsettings as before the suspend).}(hjzhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM;hjvubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]jjuh1jhhhM1hjubah}(h]h ]h"]h$]h&]uh1jhhhM1hjhhubh)}(hXIf the device is disconnected or powered down while it is suspended, the ``disconnect`` method will be called instead of the ``resume`` or ``reset_resume`` method. This is also quite likely to happen when waking up from hibernation, as many systems do not maintain suspend current to the USB host controllers during hibernation. (It's possible to work around the hibernation-forces-disconnect problem by using the USB Persist facility.)h](hIIf the device is disconnected or powered down while it is suspended, the }(hjhhhNhNubjw)}(h``disconnect``h]h disconnect}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh& method will be called instead of the }(hjhhhNhNubjw)}(h ``resume``h]hresume}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh or }(hjhhhNhNubjw)}(h``reset_resume``h]h reset_resume}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubhX method. This is also quite likely to happen when waking up from hibernation, as many systems do not maintain suspend current to the USB host controllers during hibernation. (It’s possible to work around the hibernation-forces-disconnect problem by using the USB Persist facility.)}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMBhjhhubh)}(hXThe ``reset_resume`` method is used by the USB Persist facility (see :ref:`usb-persist`) and it can also be used under certain circumstances when ``CONFIG_USB_PERSIST`` is not enabled. Currently, if a device is reset during a resume and the driver does not have a ``reset_resume`` method, the driver won't receive any notification about the resume. Later kernels will call the driver's ``disconnect`` method; 2.6.23 doesn't do this.h](hThe }(hjhhhNhNubjw)}(h``reset_resume``h]h reset_resume}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh1 method is used by the USB Persist facility (see }(hjhhhNhNubh)}(h:ref:`usb-persist`h]hinline)}(hj h]h usb-persist}(hj hhhNhNubah}(h]h ](jstdstd-refeh"]h$]h&]uh1j hj ubah}(h]h ]h"]h$]h&]refdocj refdomainj reftyperef refexplicitrefwarnj usb-persistuh1hhhhMJhjubh;) and it can also be used under certain circumstances when }(hjhhhNhNubjw)}(h``CONFIG_USB_PERSIST``h]hCONFIG_USB_PERSIST}(hj0 hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubha is not enabled. Currently, if a device is reset during a resume and the driver does not have a }(hjhhhNhNubjw)}(h``reset_resume``h]h reset_resume}(hjB hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubho method, the driver won’t receive any notification about the resume. Later kernels will call the driver’s }(hjhhhNhNubjw)}(h``disconnect``h]h disconnect}(hjT hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh" method; 2.6.23 doesn’t do this.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMJhjhhubh)}(hXjUSB drivers are bound to interfaces, so their ``suspend`` and ``resume`` methods get called when the interfaces are suspended or resumed. In principle one might want to suspend some interfaces on a device (i.e., force the drivers for those interface to stop all activity) without suspending the other interfaces. The USB core doesn't allow this; all interfaces are suspended when the device itself is suspended and all interfaces are resumed when the device is resumed. It isn't possible to suspend or resume some but not all of a device's interfaces. The closest you can come is to unbind the interfaces' drivers.h](h.USB drivers are bound to interfaces, so their }(hjl hhhNhNubjw)}(h ``suspend``h]hsuspend}(hjt hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjl ubh and }(hjl hhhNhNubjw)}(h ``resume``h]hresume}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjl ubhX* methods get called when the interfaces are suspended or resumed. In principle one might want to suspend some interfaces on a device (i.e., force the drivers for those interface to stop all activity) without suspending the other interfaces. The USB core doesn’t allow this; all interfaces are suspended when the device itself is suspended and all interfaces are resumed when the device is resumed. It isn’t possible to suspend or resume some but not all of a device’s interfaces. The closest you can come is to unbind the interfaces’ drivers.}(hjl hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMRhjhhubeh}(h])the-driver-interface-for-power-managementah ]h"])the driver interface for power managementah$]h&]uh1hhhhhhhhM%ubh)}(hhh](h)}(h3The driver interface for autosuspend and autoresumeh]h3The driver interface for autosuspend and autoresume}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhM^ubh)}(hXTo support autosuspend and autoresume, a driver should implement all three of the methods listed above. In addition, a driver indicates that it supports autosuspend by setting the ``.supports_autosuspend`` flag in its usb_driver structure. It is then responsible for informing the USB core whenever one of its interfaces becomes busy or idle. The driver does so by calling these six functions::h](hTo support autosuspend and autoresume, a driver should implement all three of the methods listed above. In addition, a driver indicates that it supports autosuspend by setting the }(hj hhhNhNubjw)}(h``.supports_autosuspend``h]h.supports_autosuspend}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhj ubh flag in its usb_driver structure. It is then responsible for informing the USB core whenever one of its interfaces becomes busy or idle. The driver does so by calling these six functions:}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM`hj hhubjB)}(hXint usb_autopm_get_interface(struct usb_interface *intf); void usb_autopm_put_interface(struct usb_interface *intf); int usb_autopm_get_interface_async(struct usb_interface *intf); void usb_autopm_put_interface_async(struct usb_interface *intf); void usb_autopm_get_interface_no_resume(struct usb_interface *intf); void usb_autopm_put_interface_no_suspend(struct usb_interface *intf);h]hXint usb_autopm_get_interface(struct usb_interface *intf); void usb_autopm_put_interface(struct usb_interface *intf); int usb_autopm_get_interface_async(struct usb_interface *intf); void usb_autopm_put_interface_async(struct usb_interface *intf); void usb_autopm_get_interface_no_resume(struct usb_interface *intf); void usb_autopm_put_interface_no_suspend(struct usb_interface *intf);}hj sbah}(h]h ]h"]h$]h&]j[j\uh1jAhhhMghj hhubh)}(hXXThe functions work by maintaining a usage counter in the usb_interface's embedded device structure. When the counter is > 0 then the interface is deemed to be busy, and the kernel will not autosuspend the interface's device. When the usage counter is = 0 then the interface is considered to be idle, and the kernel may autosuspend the device.h]hX\The functions work by maintaining a usage counter in the usb_interface’s embedded device structure. When the counter is > 0 then the interface is deemed to be busy, and the kernel will not autosuspend the interface’s device. When the usage counter is = 0 then the interface is considered to be idle, and the kernel may autosuspend the device.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMnhj hhubh)}(hX<Drivers must be careful to balance their overall changes to the usage counter. Unbalanced "get"s will remain in effect when a driver is unbound from its interface, preventing the device from going into runtime suspend should the interface be bound to a driver again. On the other hand, drivers are allowed to achieve this balance by calling the ``usb_autopm_*`` functions even after their ``disconnect`` routine has returned -- say from within a work-queue routine -- provided they retain an active reference to the interface (via ``usb_get_intf`` and ``usb_put_intf``).h](hX_Drivers must be careful to balance their overall changes to the usage counter. Unbalanced “get”s will remain in effect when a driver is unbound from its interface, preventing the device from going into runtime suspend should the interface be bound to a driver again. On the other hand, drivers are allowed to achieve this balance by calling the }(hj hhhNhNubjw)}(h``usb_autopm_*``h]h usb_autopm_*}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhj ubh functions even after their }(hj hhhNhNubjw)}(h``disconnect``h]h disconnect}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhj ubh routine has returned -- say from within a work-queue routine -- provided they retain an active reference to the interface (via }(hj hhhNhNubjw)}(h``usb_get_intf``h]h usb_get_intf}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhj ubh and }(hj hhhNhNubjw)}(h``usb_put_intf``h]h usb_put_intf}(hj1 hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhj ubh).}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMuhj hhubh)}(hdDrivers using the async routines are responsible for their own synchronization and mutual exclusion.h]hdDrivers using the async routines are responsible for their own synchronization and mutual exclusion.}(hjI hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj hhubj)}(hX:c:func:`usb_autopm_get_interface` increments the usage counter and does an autoresume if the device is suspended. If the autoresume fails, the counter is decremented back. :c:func:`usb_autopm_put_interface` decrements the usage counter and attempts an autosuspend if the new value is = 0. :c:func:`usb_autopm_get_interface_async` and :c:func:`usb_autopm_put_interface_async` do almost the same things as their non-async counterparts. The big difference is that they use a workqueue to do the resume or suspend part of their jobs. As a result they can be called in an atomic context, such as an URB's completion handler, but when they return the device will generally not yet be in the desired state. :c:func:`usb_autopm_get_interface_no_resume` and :c:func:`usb_autopm_put_interface_no_suspend` merely increment or decrement the usage counter; they do not attempt to carry out an autoresume or an autosuspend. Hence they can be called in an atomic context. h](h)}(h:c:func:`usb_autopm_get_interface` increments the usage counter and does an autoresume if the device is suspended. If the autoresume fails, the counter is decremented back.h](h)}(h":c:func:`usb_autopm_get_interface`h]jw)}(hja h]husb_autopm_get_interface()}(hjc hhhNhNubah}(h]h ](jjc-funceh"]h$]h&]uh1jvhj_ ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypefunc refexplicitrefwarnjusb_autopm_get_interfaceuh1hhhhMhj[ ubh increments the usage counter and does an autoresume if the device is suspended. If the autoresume fails, the counter is decremented back.}(hj[ hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjW ubh)}(ht:c:func:`usb_autopm_put_interface` decrements the usage counter and attempts an autosuspend if the new value is = 0.h](h)}(h":c:func:`usb_autopm_put_interface`h]jw)}(hj h]husb_autopm_put_interface()}(hj hhhNhNubah}(h]h ](jjc-funceh"]h$]h&]uh1jvhj ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypefunc refexplicitrefwarnjusb_autopm_put_interfaceuh1hhhhMhj ubhR decrements the usage counter and attempts an autosuspend if the new value is = 0.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjW ubh)}(hX:c:func:`usb_autopm_get_interface_async` and :c:func:`usb_autopm_put_interface_async` do almost the same things as their non-async counterparts. The big difference is that they use a workqueue to do the resume or suspend part of their jobs. As a result they can be called in an atomic context, such as an URB's completion handler, but when they return the device will generally not yet be in the desired state.h](h)}(h(:c:func:`usb_autopm_get_interface_async`h]jw)}(hj h]h usb_autopm_get_interface_async()}(hj hhhNhNubah}(h]h ](jjc-funceh"]h$]h&]uh1jvhj ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypefunc refexplicitrefwarnjusb_autopm_get_interface_asyncuh1hhhhMhj ubh and }(hj hhhNhNubh)}(h(:c:func:`usb_autopm_put_interface_async`h]jw)}(hj h]h usb_autopm_put_interface_async()}(hj hhhNhNubah}(h]h ](jjc-funceh"]h$]h&]uh1jvhj ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypefunc refexplicitrefwarnjusb_autopm_put_interface_asyncuh1hhhhMhj ubhXI do almost the same things as their non-async counterparts. The big difference is that they use a workqueue to do the resume or suspend part of their jobs. As a result they can be called in an atomic context, such as an URB’s completion handler, but when they return the device will generally not yet be in the desired state.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjW ubh)}(hX:c:func:`usb_autopm_get_interface_no_resume` and :c:func:`usb_autopm_put_interface_no_suspend` merely increment or decrement the usage counter; they do not attempt to carry out an autoresume or an autosuspend. Hence they can be called in an atomic context.h](h)}(h,:c:func:`usb_autopm_get_interface_no_resume`h]jw)}(hj h]h$usb_autopm_get_interface_no_resume()}(hj hhhNhNubah}(h]h ](jjc-funceh"]h$]h&]uh1jvhj ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypefunc refexplicitrefwarnj"usb_autopm_get_interface_no_resumeuh1hhhhMhj ubh and }(hj hhhNhNubh)}(h-:c:func:`usb_autopm_put_interface_no_suspend`h]jw)}(hj. h]h%usb_autopm_put_interface_no_suspend()}(hj0 hhhNhNubah}(h]h ](jjc-funceh"]h$]h&]uh1jvhj, ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypefunc refexplicitrefwarnj#usb_autopm_put_interface_no_suspenduh1hhhhMhj ubh merely increment or decrement the usage counter; they do not attempt to carry out an autoresume or an autosuspend. Hence they can be called in an atomic context.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjW ubeh}(h]h ]h"]h$]h&]uh1jhhhMhj hhubh)}(hThe simplest usage pattern is that a driver calls :c:func:`usb_autopm_get_interface` in its open routine and :c:func:`usb_autopm_put_interface` in its close or release routine. But other patterns are possible.h](h2The simplest usage pattern is that a driver calls }(hj[ hhhNhNubh)}(h":c:func:`usb_autopm_get_interface`h]jw)}(hje h]husb_autopm_get_interface()}(hjg hhhNhNubah}(h]h ](jjc-funceh"]h$]h&]uh1jvhjc ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypefunc refexplicitrefwarnjusb_autopm_get_interfaceuh1hhhhMhj[ ubh in its open routine and }(hj[ hhhNhNubh)}(h":c:func:`usb_autopm_put_interface`h]jw)}(hj h]husb_autopm_put_interface()}(hj hhhNhNubah}(h]h ](jjc-funceh"]h$]h&]uh1jvhj ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypefunc refexplicitrefwarnjusb_autopm_put_interfaceuh1hhhhMhj[ ubhC in its close or release routine. But other patterns are possible.}(hj[ hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj hhubh)}(hXThe autosuspend attempts mentioned above will often fail for one reason or another. For example, the ``power/control`` attribute might be set to ``on``, or another interface in the same device might not be idle. This is perfectly normal. If the reason for failure was that the device hasn't been idle for long enough, a timer is scheduled to carry out the operation automatically when the autosuspend idle-delay has expired.h](hfThe autosuspend attempts mentioned above will often fail for one reason or another. For example, the }(hj hhhNhNubjw)}(h``power/control``h]h power/control}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhj ubh attribute might be set to }(hj hhhNhNubjw)}(h``on``h]hon}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhj ubhX, or another interface in the same device might not be idle. This is perfectly normal. If the reason for failure was that the device hasn’t been idle for long enough, a timer is scheduled to carry out the operation automatically when the autosuspend idle-delay has expired.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj hhubh)}(hAutoresume attempts also can fail, although failure would mean that the device is no longer present or operating properly. Unlike autosuspend, there's no idle-delay for an autoresume.h]hAutoresume attempts also can fail, although failure would mean that the device is no longer present or operating properly. Unlike autosuspend, there’s no idle-delay for an autoresume.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj hhubeh}(h]3the-driver-interface-for-autosuspend-and-autoresumeah ]h"]3the driver interface for autosuspend and autoresumeah$]h&]uh1hhhhhhhhM^ubh)}(hhh](h)}(h#Other parts of the driver interfaceh]h#Other parts of the driver interface}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhMubh)}(h=Drivers can enable autosuspend for their devices by calling::h]hneeds_remote_wakeup`` to 1, the kernel won't autosuspend the device if remote wakeup isn't available. (If the device is already autosuspended, though, setting this flag won't cause the kernel to autoresume it. Normally a driver would set this flag in its ``probe`` method, at which time the device is guaranteed not to be autosuspended.)h](hSometimes a driver needs to make sure that remote wakeup is enabled during autosuspend. For example, there’s not much point autosuspending a keyboard if the user can’t cause the keyboard to do a remote wakeup by typing on it. If the driver sets }(hj hhhNhNubjw)}(h``intf->needs_remote_wakeup``h]hintf->needs_remote_wakeup}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhj ubh to 1, the kernel won’t autosuspend the device if remote wakeup isn’t available. (If the device is already autosuspended, though, setting this flag won’t cause the kernel to autoresume it. Normally a driver would set this flag in its }(hj hhhNhNubjw)}(h ``probe``h]hprobe}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhj ubhI method, at which time the device is guaranteed not to be autosuspended.)}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj hhubh)}(hX If a driver does its I/O asynchronously in interrupt context, it should call :c:func:`usb_autopm_get_interface_async` before starting output and :c:func:`usb_autopm_put_interface_async` when the output queue drains. When it receives an input event, it should call::h](hMIf a driver does its I/O asynchronously in interrupt context, it should call }(hj hhhNhNubh)}(h(:c:func:`usb_autopm_get_interface_async`h]jw)}(hj h]h usb_autopm_get_interface_async()}(hj hhhNhNubah}(h]h ](jjc-funceh"]h$]h&]uh1jvhj ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypefunc refexplicitrefwarnjusb_autopm_get_interface_asyncuh1hhhhMhj ubh before starting output and }(hj hhhNhNubh)}(h(:c:func:`usb_autopm_put_interface_async`h]jw)}(hj h]h usb_autopm_put_interface_async()}(hj hhhNhNubah}(h]h ](jjc-funceh"]h$]h&]uh1jvhj ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypefunc refexplicitrefwarnjusb_autopm_put_interface_asyncuh1hhhhMhj ubhP when the output queue drains. When it receives an input event, it should call:}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj hhubjB)}(h,usb_mark_last_busy(struct usb_device *udev);h]h,usb_mark_last_busy(struct usb_device *udev);}hj? sbah}(h]h ]h"]h$]h&]j[j\uh1jAhhhMhj hhubh)}(hXin the event handler. This tells the PM core that the device was just busy and therefore the next autosuspend idle-delay expiration should be pushed back. Many of the usb_autopm_* routines also make this call, so drivers need to worry only when interrupt-driven input arrives.h]hXin the event handler. This tells the PM core that the device was just busy and therefore the next autosuspend idle-delay expiration should be pushed back. Many of the usb_autopm_* routines also make this call, so drivers need to worry only when interrupt-driven input arrives.}(hjM hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj hhubh)}(hXAsynchronous operation is always subject to races. For example, a driver may call the :c:func:`usb_autopm_get_interface_async` routine at a time when the core has just finished deciding the device has been idle for long enough but not yet gotten around to calling the driver's ``suspend`` method. The ``suspend`` method must be responsible for synchronizing with the I/O request routine and the URB completion handler; it should cause autosuspends to fail with -EBUSY if the driver needs to use the device.h](hWAsynchronous operation is always subject to races. For example, a driver may call the }(hj[ hhhNhNubh)}(h(:c:func:`usb_autopm_get_interface_async`h]jw)}(hje h]h usb_autopm_get_interface_async()}(hjg hhhNhNubah}(h]h ](jjc-funceh"]h$]h&]uh1jvhjc ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypefunc refexplicitrefwarnjusb_autopm_get_interface_asyncuh1hhhhMhj[ ubh routine at a time when the core has just finished deciding the device has been idle for long enough but not yet gotten around to calling the driver’s }(hj[ hhhNhNubjw)}(h ``suspend``h]hsuspend}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhj[ ubh method. The }(hj[ hhhNhNubjw)}(h ``suspend``h]hsuspend}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhj[ ubh method must be responsible for synchronizing with the I/O request routine and the URB completion handler; it should cause autosuspends to fail with -EBUSY if the driver needs to use the device.}(hj[ hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj hhubh)}(hX6External suspend calls should never be allowed to fail in this way, only autosuspend calls. The driver can tell them apart by applying the :c:func:`PMSG_IS_AUTO` macro to the message argument to the ``suspend`` method; it will return True for internal PM events (autosuspend) and False for external PM events.h](hExternal suspend calls should never be allowed to fail in this way, only autosuspend calls. The driver can tell them apart by applying the }(hj hhhNhNubh)}(h:c:func:`PMSG_IS_AUTO`h]jw)}(hj h]hPMSG_IS_AUTO()}(hj hhhNhNubah}(h]h ](jjc-funceh"]h$]h&]uh1jvhj ubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypefunc refexplicitrefwarnj PMSG_IS_AUTOuh1hhhhMhj ubh& macro to the message argument to the }(hj hhhNhNubjw)}(h ``suspend``h]hsuspend}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhj ubhc method; it will return True for internal PM events (autosuspend) and False for external PM events.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj hhubeh}(h]#other-parts-of-the-driver-interfaceah ]h"]#other parts of the driver interfaceah$]h&]uh1hhhhhhhhMubh)}(hhh](h)}(hMutual exclusionh]hMutual exclusion}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhMubh)}(hXFor external events -- but not necessarily for autosuspend or autoresume -- the device semaphore (udev->dev.sem) will be held when a ``suspend`` or ``resume`` method is called. This implies that external suspend/resume events are mutually exclusive with calls to ``probe``, ``disconnect``, ``pre_reset``, and ``post_reset``; the USB core guarantees that this is true of autosuspend/autoresume events as well.h](hFor external events -- but not necessarily for autosuspend or autoresume -- the device semaphore (udev->dev.sem) will be held when a }(hj hhhNhNubjw)}(h ``suspend``h]hsuspend}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhj ubh or }(hj hhhNhNubjw)}(h ``resume``h]hresume}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhj ubhj method is called. This implies that external suspend/resume events are mutually exclusive with calls to }(hj hhhNhNubjw)}(h ``probe``h]hprobe}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhj ubh, }(hj hhhNhNubjw)}(h``disconnect``h]h disconnect}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhj ubh, }(hj hhhNhNubjw)}(h ``pre_reset``h]h pre_reset}(hj\hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhj ubh, and }(hj hhhNhNubjw)}(h``post_reset``h]h post_reset}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhj ubhU; the USB core guarantees that this is true of autosuspend/autoresume events as well.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj hhubh)}(hXIf a driver wants to block all suspend/resume calls during some critical section, the best way is to lock the device and call :c:func:`usb_autopm_get_interface` (and do the reverse at the end of the critical section). Holding the device semaphore will block all external PM calls, and the :c:func:`usb_autopm_get_interface` will prevent any internal PM calls, even if it fails. (Exercise: Why?)h](h~If a driver wants to block all suspend/resume calls during some critical section, the best way is to lock the device and call }(hjhhhNhNubh)}(h":c:func:`usb_autopm_get_interface`h]jw)}(hjh]husb_autopm_get_interface()}(hjhhhNhNubah}(h]h ](jjc-funceh"]h$]h&]uh1jvhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypefunc refexplicitrefwarnjusb_autopm_get_interfaceuh1hhhhMhjubh (and do the reverse at the end of the critical section). Holding the device semaphore will block all external PM calls, and the }(hjhhhNhNubh)}(h":c:func:`usb_autopm_get_interface`h]jw)}(hjh]husb_autopm_get_interface()}(hjhhhNhNubah}(h]h ](jjc-funceh"]h$]h&]uh1jvhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypefunc refexplicitrefwarnjusb_autopm_get_interfaceuh1hhhhMhjubhH will prevent any internal PM calls, even if it fails. (Exercise: Why?)}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj hhubeh}(h]mutual-exclusionah ]h"]mutual exclusionah$]h&]uh1hhhhhhhhMubh)}(hhh](h)}(h,Interaction between dynamic PM and system PMh]h,Interaction between dynamic PM and system PM}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubh)}(hVDynamic power management and system power management can interact in a couple of ways.h]hVDynamic power management and system power management can interact in a couple of ways.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hXFirstly, a device may already be autosuspended when a system suspend occurs. Since system suspends are supposed to be as transparent as possible, the device should remain suspended following the system resume. But this theory may not work out well in practice; over time the kernel's behavior in this regard has changed. As of 2.6.37 the policy is to resume all devices during a system resume and let them handle their own runtime suspends afterward.h]hXFirstly, a device may already be autosuspended when a system suspend occurs. Since system suspends are supposed to be as transparent as possible, the device should remain suspended following the system resume. But this theory may not work out well in practice; over time the kernel’s behavior in this regard has changed. As of 2.6.37 the policy is to resume all devices during a system resume and let them handle their own runtime suspends afterward.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hXSecondly, a dynamic power-management event may occur as a system suspend is underway. The window for this is short, since system suspends don't take long (a few seconds usually), but it can happen. For example, a suspended device may send a remote-wakeup signal while the system is suspending. The remote wakeup may succeed, which would cause the system suspend to abort. If the remote wakeup doesn't succeed, it may still remain active and thus cause the system to resume as soon as the system suspend is complete. Or the remote wakeup may fail and get lost. Which outcome occurs depends on timing and on the hardware and firmware design.h]hXSecondly, a dynamic power-management event may occur as a system suspend is underway. The window for this is short, since system suspends don’t take long (a few seconds usually), but it can happen. For example, a suspended device may send a remote-wakeup signal while the system is suspending. The remote wakeup may succeed, which would cause the system suspend to abort. If the remote wakeup doesn’t succeed, it may still remain active and thus cause the system to resume as soon as the system suspend is complete. Or the remote wakeup may fail and get lost. Which outcome occurs depends on timing and on the hardware and firmware design.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubeh}(h],interaction-between-dynamic-pm-and-system-pmah ]h"],interaction between dynamic pm and system pmah$]h&]uh1hhhhhhhhMubh)}(hhh](h)}(hxHCI hardware link PMh]hxHCI hardware link PM}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%hhhhhM ubh)}(hXIxHCI host controller provides hardware link power management to usb2.0 (xHCI 1.0 feature) and usb3.0 devices which support link PM. By enabling hardware LPM, the host can automatically put the device into lower power state(L1 for usb2.0 devices, or U1/U2 for usb3.0 devices), which state device can enter and resume very quickly.h]hXIxHCI host controller provides hardware link power management to usb2.0 (xHCI 1.0 feature) and usb3.0 devices which support link PM. By enabling hardware LPM, the host can automatically put the device into lower power state(L1 for usb2.0 devices, or U1/U2 for usb3.0 devices), which state device can enter and resume very quickly.}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj%hhubh)}(hX!The user interface for controlling hardware LPM is located in the ``power/`` subdirectory of each USB device's sysfs directory, that is, in ``/sys/bus/usb/devices/.../power/`` where "..." is the device's ID. The relevant attribute files are ``usb2_hardware_lpm`` and ``usb3_hardware_lpm``.h](hBThe user interface for controlling hardware LPM is located in the }(hjDhhhNhNubjw)}(h ``power/``h]hpower/}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjDubhB subdirectory of each USB device’s sysfs directory, that is, in }(hjDhhhNhNubjw)}(h#``/sys/bus/usb/devices/.../power/``h]h/sys/bus/usb/devices/.../power/}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjDubhH where “...” is the device’s ID. The relevant attribute files are }(hjDhhhNhNubjw)}(h``usb2_hardware_lpm``h]husb2_hardware_lpm}(hjphhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjDubh and }(hjDhhhNhNubjw)}(h``usb3_hardware_lpm``h]husb3_hardware_lpm}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjDubh.}(hjDhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj%hhubj)}(hXS``power/usb2_hardware_lpm`` When a USB2 device which support LPM is plugged to a xHCI host root hub which support software LPM, the host will run a software LPM test for it; if the device enters L1 state and resume successfully and the host supports USB2 hardware LPM, this file will show up and driver will enable hardware LPM for the device. You can write y/Y/1 or n/N/0 to the file to enable/disable USB2 hardware LPM manually. This is for test purpose mainly. ``power/usb3_hardware_lpm_u1`` ``power/usb3_hardware_lpm_u2`` When a USB 3.0 lpm-capable device is plugged in to a xHCI host which supports link PM, it will check if U1 and U2 exit latencies have been set in the BOS descriptor; if the check is passed and the host supports USB3 hardware LPM, USB3 hardware LPM will be enabled for the device and these files will be created. The files hold a string value (enable or disable) indicating whether or not USB3 hardware LPM U1 or U2 is enabled for the device. h](h)}(h``power/usb2_hardware_lpm``h]jw)}(hjh]hpower/usb2_hardware_lpm}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubah}(h]h ]h"]h$]h&]uh1hhhhMhjubj)}(hXWhen a USB2 device which support LPM is plugged to a xHCI host root hub which support software LPM, the host will run a software LPM test for it; if the device enters L1 state and resume successfully and the host supports USB2 hardware LPM, this file will show up and driver will enable hardware LPM for the device. You can write y/Y/1 or n/N/0 to the file to enable/disable USB2 hardware LPM manually. This is for test purpose mainly. h]h)}(hXWhen a USB2 device which support LPM is plugged to a xHCI host root hub which support software LPM, the host will run a software LPM test for it; if the device enters L1 state and resume successfully and the host supports USB2 hardware LPM, this file will show up and driver will enable hardware LPM for the device. You can write y/Y/1 or n/N/0 to the file to enable/disable USB2 hardware LPM manually. This is for test purpose mainly.h]hXWhen a USB2 device which support LPM is plugged to a xHCI host root hub which support software LPM, the host will run a software LPM test for it; if the device enters L1 state and resume successfully and the host supports USB2 hardware LPM, this file will show up and driver will enable hardware LPM for the device. You can write y/Y/1 or n/N/0 to the file to enable/disable USB2 hardware LPM manually. This is for test purpose mainly.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhhhMhjubh)}(h=``power/usb3_hardware_lpm_u1`` ``power/usb3_hardware_lpm_u2``h](jw)}(h``power/usb3_hardware_lpm_u1``h]hpower/usb3_hardware_lpm_u1}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh }(hjhhhNhNubjw)}(h``power/usb3_hardware_lpm_u2``h]hpower/usb3_hardware_lpm_u2}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubeh}(h]h ]h"]h$]h&]uh1hhhhM%hjubj)}(hXWhen a USB 3.0 lpm-capable device is plugged in to a xHCI host which supports link PM, it will check if U1 and U2 exit latencies have been set in the BOS descriptor; if the check is passed and the host supports USB3 hardware LPM, USB3 hardware LPM will be enabled for the device and these files will be created. The files hold a string value (enable or disable) indicating whether or not USB3 hardware LPM U1 or U2 is enabled for the device. h]h)}(hXWhen a USB 3.0 lpm-capable device is plugged in to a xHCI host which supports link PM, it will check if U1 and U2 exit latencies have been set in the BOS descriptor; if the check is passed and the host supports USB3 hardware LPM, USB3 hardware LPM will be enabled for the device and these files will be created. The files hold a string value (enable or disable) indicating whether or not USB3 hardware LPM U1 or U2 is enabled for the device.h]hXWhen a USB 3.0 lpm-capable device is plugged in to a xHCI host which supports link PM, it will check if U1 and U2 exit latencies have been set in the BOS descriptor; if the check is passed and the host supports USB3 hardware LPM, USB3 hardware LPM will be enabled for the device and these files will be created. The files hold a string value (enable or disable) indicating whether or not USB3 hardware LPM U1 or U2 is enabled for the device.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM(hjubah}(h]h ]h"]h$]h&]uh1jhhhM(hjubeh}(h]h ]h"]h$]h&]uh1jhhhMhj%hhubeh}(h]xhci-hardware-link-pmah ]h"]xhci hardware link pmah$]h&]uh1hhhhhhhhM ubh)}(hhh](h)}(hUSB Port Power Controlh]hUSB Port Power Control}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhM3ubh)}(hX"In addition to suspending endpoint devices and enabling hardware controlled link power management, the USB subsystem also has the capability to disable power to ports under some conditions. Power is controlled through ``Set/ClearPortFeature(PORT_POWER)`` requests to a hub. In the case of a root or platform-internal hub the host controller driver translates ``PORT_POWER`` requests into platform firmware (ACPI) method calls to set the port power state. For more background see the Linux Plumbers Conference 2012 slides [#f1]_ and video [#f2]_:h](hIn addition to suspending endpoint devices and enabling hardware controlled link power management, the USB subsystem also has the capability to disable power to ports under some conditions. Power is controlled through }(hj.hhhNhNubjw)}(h$``Set/ClearPortFeature(PORT_POWER)``h]h Set/ClearPortFeature(PORT_POWER)}(hj6hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhj.ubhi requests to a hub. In the case of a root or platform-internal hub the host controller driver translates }(hj.hhhNhNubjw)}(h``PORT_POWER``h]h PORT_POWER}(hjHhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhj.ubh requests into platform firmware (ACPI) method calls to set the port power state. For more background see the Linux Plumbers Conference 2012 slides }(hj.hhhNhNubhfootnote_reference)}(h[#f1]_h]h1}(hj\hhhNhNubah}(h]id1ah ]h"]h$]h&]autoKhf1docnamejuh1jZhj.resolvedKubh and video }(hj.hhhNhNubj[)}(h[#f2]_h]h2}(hjshhhNhNubah}(h]id2ah ]h"]h$]h&]jkKhf2jmjuh1jZhj.jnKubh:}(hj.hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM5hjhhubh)}(hXUpon receiving a ``ClearPortFeature(PORT_POWER)`` request a USB port is logically off, and may trigger the actual loss of VBUS to the port [#f3]_. VBUS may be maintained in the case where a hub gangs multiple ports into a shared power well causing power to remain until all ports in the gang are turned off. VBUS may also be maintained by hub ports configured for a charging application. In any event a logically off port will lose connection with its device, not respond to hotplug events, and not respond to remote wakeup events.h](hUpon receiving a }(hjhhhNhNubjw)}(h ``ClearPortFeature(PORT_POWER)``h]hClearPortFeature(PORT_POWER)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubhZ request a USB port is logically off, and may trigger the actual loss of VBUS to the port }(hjhhhNhNubj[)}(h[#f3]_h]h3}(hjhhhNhNubah}(h]id3ah ]h"]h$]h&]jkKhf3jmjuh1jZhjjnKubhX. VBUS may be maintained in the case where a hub gangs multiple ports into a shared power well causing power to remain until all ports in the gang are turned off. VBUS may also be maintained by hub ports configured for a charging application. In any event a logically off port will lose connection with its device, not respond to hotplug events, and not respond to remote wakeup events.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM>hjhhubhwarning)}(hturning off a port may result in the inability to hot add a device. Please see "User Interface for Port Power Control" for details.h]h)}(hturning off a port may result in the inability to hot add a device. Please see "User Interface for Port Power Control" for details.h]hturning off a port may result in the inability to hot add a device. Please see “User Interface for Port Power Control” for details.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMIhjubah}(h]h ]h"]h$]h&]uh1jhjhhhhhNubh)}(hXAs far as the effect on the device itself it is similar to what a device goes through during system suspend, i.e. the power session is lost. Any USB device or driver that misbehaves with system suspend will be similarly affected by a port power cycle event. For this reason the implementation shares the same device recovery path (and honors the same quirks) as the system resume path for the hub.h]hXAs far as the effect on the device itself it is similar to what a device goes through during system suspend, i.e. the power session is lost. Any USB device or driver that misbehaves with system suspend will be similarly affected by a port power cycle event. For this reason the implementation shares the same device recovery path (and honors the same quirks) as the system resume path for the hub.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMLhjhhubhfootnote)}(hJhttp://dl.dropbox.com/u/96820575/sarah-sharp-lpt-port-power-off2-mini.pdf h](hlabel)}(hhh]h1}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjhhhNhNubh)}(hIhttp://dl.dropbox.com/u/96820575/sarah-sharp-lpt-port-power-off2-mini.pdfh]h)}(hjh]hIhttp://dl.dropbox.com/u/96820575/sarah-sharp-lpt-port-power-off2-mini.pdf}(hjhhhNhNubah}(h]h ]h"]h$]h&]refurijuh1hhjubah}(h]h ]h"]h$]h&]uh1hhhhMUhjubeh}(h]jlah ]h"]f1ah$]h&]jfajkKjmjuh1jhhhMShjhhubj)}(hOhttp://linuxplumbers.ubicast.tv/videos/usb-port-power-off-kerneluserspace-api/ h](j)}(hhh]h2}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1jhjhhhNhNubh)}(hNhttp://linuxplumbers.ubicast.tv/videos/usb-port-power-off-kerneluserspace-api/h]h)}(hj0h]hNhttp://linuxplumbers.ubicast.tv/videos/usb-port-power-off-kerneluserspace-api/}(hj2hhhNhNubah}(h]h ]h"]h$]h&]refurij0uh1hhj.ubah}(h]h ]h"]h$]h&]uh1hhhhMYhjubeh}(h]jah ]h"]f2ah$]h&]j}ajkKjmjuh1jhhhMWhjhhubj)}(hUSB 3.1 Section 10.12 wakeup note: if a device is configured to send wakeup events the port power control implementation will block poweroff attempts on that port. h](j)}(hhh]h3}(hjQhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjMhhhNhNubh)}(hUSB 3.1 Section 10.12h]hUSB 3.1 Section 10.12}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM]hjMubh)}(hwakeup note: if a device is configured to send wakeup events the port power control implementation will block poweroff attempts on that port.h]hwakeup note: if a device is configured to send wakeup events the port power control implementation will block poweroff attempts on that port.}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM_hjMubeh}(h]jah ]h"]f3ah$]h&]jajkKjmjuh1jhhhM[hjhhubeh}(h]usb-port-power-controlah ]h"]usb port power controlah$]h&]uh1hhhhhhhhM3ubh)}(hhh](h)}(h%User Interface for Port Power Controlh]h%User Interface for Port Power Control}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMeubh)}(hX!The port power control mechanism uses the PM runtime system. Poweroff is requested by clearing the ``power/pm_qos_no_power_off`` flag of the port device (defaults to 1). If the port is disconnected it will immediately receive a ``ClearPortFeature(PORT_POWER)`` request. Otherwise, it will honor the pm runtime rules and require the attached child device and all descendants to be suspended. This mechanism is dependent on the hub advertising port power switching in its hub descriptor (wHubCharacteristics logical power switching mode field).h](hdThe port power control mechanism uses the PM runtime system. Poweroff is requested by clearing the }(hjhhhNhNubjw)}(h``power/pm_qos_no_power_off``h]hpower/pm_qos_no_power_off}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubhe flag of the port device (defaults to 1). If the port is disconnected it will immediately receive a }(hjhhhNhNubjw)}(h ``ClearPortFeature(PORT_POWER)``h]hClearPortFeature(PORT_POWER)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubhX request. Otherwise, it will honor the pm runtime rules and require the attached child device and all descendants to be suspended. This mechanism is dependent on the hub advertising port power switching in its hub descriptor (wHubCharacteristics logical power switching mode field).}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMghjhhubh)}(hXNote, some interface devices/drivers do not support autosuspend. Userspace may need to unbind the interface drivers before the :c:type:`usb_device` will suspend. An unbound interface device is suspended by default. When unbinding, be careful to unbind interface drivers, not the driver of the parent usb device. Also, leave hub interface drivers bound. If the driver for the usb device (not interface) is unbound the kernel is no longer able to resume the device. If a hub interface driver is unbound, control of its child ports is lost and all attached child-devices will disconnect. A good rule of thumb is that if the 'driver/module' link for a device points to ``/sys/module/usbcore`` then unbinding it will interfere with port power control.h](hNote, some interface devices/drivers do not support autosuspend. Userspace may need to unbind the interface drivers before the }(hjhhhNhNubh)}(h:c:type:`usb_device`h]jw)}(hjh]h usb_device}(hjhhhNhNubah}(h]h ](jjc-typeeh"]h$]h&]uh1jvhjubah}(h]h ]h"]h$]h&]refdocj refdomainjreftypetype refexplicitrefwarnj usb_deviceuh1hhhhMphjubhX will suspend. An unbound interface device is suspended by default. When unbinding, be careful to unbind interface drivers, not the driver of the parent usb device. Also, leave hub interface drivers bound. If the driver for the usb device (not interface) is unbound the kernel is no longer able to resume the device. If a hub interface driver is unbound, control of its child ports is lost and all attached child-devices will disconnect. A good rule of thumb is that if the ‘driver/module’ link for a device points to }(hjhhhNhNubjw)}(h``/sys/module/usbcore``h]h/sys/module/usbcore}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh: then unbinding it will interfere with port power control.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMphjhhubh)}(hExample of the relevant files for port power control. Note, in this example these files are relative to a usb hub device (prefix)::h]hExample of the relevant files for port power control. Note, in this example these files are relative to a usb hub device (prefix):}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM|hjhhubjB)}(hX&prefix=/sys/devices/pci0000:00/0000:00:14.0/usb3/3-1 attached child device + hub port device + | hub interface device + | | v v v $prefix/3-1:1.0/3-1-port1/device $prefix/3-1:1.0/3-1-port1/power/pm_qos_no_power_off $prefix/3-1:1.0/3-1-port1/device/power/control $prefix/3-1:1.0/3-1-port1/device/3-1.1:/driver/unbind $prefix/3-1:1.0/3-1-port1/device/3-1.1:/driver/unbind ... $prefix/3-1:1.0/3-1-port1/device/3-1.1:/driver/unbindh]hX&prefix=/sys/devices/pci0000:00/0000:00:14.0/usb3/3-1 attached child device + hub port device + | hub interface device + | | v v v $prefix/3-1:1.0/3-1-port1/device $prefix/3-1:1.0/3-1-port1/power/pm_qos_no_power_off $prefix/3-1:1.0/3-1-port1/device/power/control $prefix/3-1:1.0/3-1-port1/device/3-1.1:/driver/unbind $prefix/3-1:1.0/3-1-port1/device/3-1.1:/driver/unbind ... $prefix/3-1:1.0/3-1-port1/device/3-1.1:/driver/unbind}hjsbah}(h]h ]h"]h$]h&]j[j\uh1jAhhhMhjhhubh)}(hIn addition to these files some ports may have a 'peer' link to a port on another hub. The expectation is that all superspeed ports have a hi-speed peer::h]hIn addition to these files some ports may have a ‘peer’ link to a port on another hub. The expectation is that all superspeed ports have a hi-speed peer:}(hj+hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubjB)}(h$prefix/3-1:1.0/3-1-port1/peer -> ../../../../usb2/2-1/2-1:1.0/2-1-port1 ../../../../usb2/2-1/2-1:1.0/2-1-port1/peer -> ../../../../usb3/3-1/3-1:1.0/3-1-port1h]h$prefix/3-1:1.0/3-1-port1/peer -> ../../../../usb2/2-1/2-1:1.0/2-1-port1 ../../../../usb2/2-1/2-1:1.0/2-1-port1/peer -> ../../../../usb3/3-1/3-1:1.0/3-1-port1}hj9sbah}(h]h ]h"]h$]h&]j[j\uh1jAhhhMhjhhubh)}(hDistinct from 'companion ports', or 'ehci/xhci shared switchover ports' peer ports are simply the hi-speed and superspeed interface pins that are combined into a single usb3 connector. Peer ports share the same ancestor XHCI device.h]hDistinct from ‘companion ports’, or ‘ehci/xhci shared switchover ports’ peer ports are simply the hi-speed and superspeed interface pins that are combined into a single usb3 connector. Peer ports share the same ancestor XHCI device.}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hWhile a superspeed port is powered off a device may downgrade its connection and attempt to connect to the hi-speed pins. The implementation takes steps to prevent this:h]hWhile a superspeed port is powered off a device may downgrade its connection and attempt to connect to the hi-speed pins. The implementation takes steps to prevent this:}(hjUhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubhenumerated_list)}(hhh](j)}(hXPort suspend is sequenced to guarantee that hi-speed ports are powered-off before their superspeed peer is permitted to power-off. The implication is that the setting ``pm_qos_no_power_off`` to zero on a superspeed port may not cause the port to power-off until its highspeed peer has gone to its runtime suspend state. Userspace must take care to order the suspensions if it wants to guarantee that a superspeed port will power-off. h]h)}(hXPort suspend is sequenced to guarantee that hi-speed ports are powered-off before their superspeed peer is permitted to power-off. The implication is that the setting ``pm_qos_no_power_off`` to zero on a superspeed port may not cause the port to power-off until its highspeed peer has gone to its runtime suspend state. Userspace must take care to order the suspensions if it wants to guarantee that a superspeed port will power-off.h](hPort suspend is sequenced to guarantee that hi-speed ports are powered-off before their superspeed peer is permitted to power-off. The implication is that the setting }(hjlhhhNhNubjw)}(h``pm_qos_no_power_off``h]hpm_qos_no_power_off}(hjthhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjlubh to zero on a superspeed port may not cause the port to power-off until its highspeed peer has gone to its runtime suspend state. Userspace must take care to order the suspensions if it wants to guarantee that a superspeed port will power-off.}(hjlhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhubah}(h]h ]h"]h$]h&]uh1jhjehhhhhNubj)}(h]Port resume is sequenced to force a superspeed port to power-on prior to its highspeed peer. h]h)}(h\Port resume is sequenced to force a superspeed port to power-on prior to its highspeed peer.h]h\Port resume is sequenced to force a superspeed port to power-on prior to its highspeed peer.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjehhhhhNubj)}(hXuPort resume always triggers an attached child device to resume. After a power session is lost the device may have been removed, or need reset. Resuming the child device when the parent port regains power resolves those states and clamps the maximum port power cycle frequency at the rate the child device can suspend (autosuspend-delay) and resume (reset-resume latency). h]h)}(hXtPort resume always triggers an attached child device to resume. After a power session is lost the device may have been removed, or need reset. Resuming the child device when the parent port regains power resolves those states and clamps the maximum port power cycle frequency at the rate the child device can suspend (autosuspend-delay) and resume (reset-resume latency).h]hXtPort resume always triggers an attached child device to resume. After a power session is lost the device may have been removed, or need reset. Resuming the child device when the parent port regains power resolves those states and clamps the maximum port power cycle frequency at the rate the child device can suspend (autosuspend-delay) and resume (reset-resume latency).}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjehhhhhNubeh}(h]h ]h"]h$]h&]enumtypearabicprefixhsuffix.uh1jchjhhhhhMubh)}(h,Sysfs files relevant for port power control:h]h,Sysfs files relevant for port power control:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubj)}(hX ``/power/pm_qos_no_power_off``: This writable flag controls the state of an idle port. Once all children and descendants have suspended the port may suspend/poweroff provided that pm_qos_no_power_off is '0'. If pm_qos_no_power_off is '1' the port will remain active/powered regardless of the stats of descendants. Defaults to 1. ``/power/runtime_status``: This file reflects whether the port is 'active' (power is on) or 'suspended' (logically off). There is no indication to userspace whether VBUS is still supplied. ``/connect_type``: An advisory read-only flag to userspace indicating the location and connection type of the port. It returns one of four values 'hotplug', 'hardwired', 'not used', and 'unknown'. All values, besides unknown, are set by platform firmware. ``hotplug`` indicates an externally connectable/visible port on the platform. Typically userspace would choose to keep such a port powered to handle new device connection events. ``hardwired`` refers to a port that is not visible but connectable. Examples are internal ports for USB bluetooth that can be disconnected via an external switch or a port with a hardwired USB camera. It is expected to be safe to allow these ports to suspend provided pm_qos_no_power_off is coordinated with any switch that gates connections. Userspace must arrange for the device to be connected prior to the port powering off, or to activate the port prior to enabling connection via a switch. ``not used`` refers to an internal port that is expected to never have a device connected to it. These may be empty internal ports, or ports that are not physically exposed on a platform. Considered safe to be powered-off at all times. ``unknown`` means platform firmware does not provide information for this port. Most commonly refers to external hub ports which should be considered 'hotplug' for policy decisions. .. note:: - since we are relying on the BIOS to get this ACPI information correct, the USB port descriptions may be missing or wrong. - Take care in clearing ``pm_qos_no_power_off``. Once power is off this port will not respond to new connect events. Once a child device is attached additional constraints are applied before the port is allowed to poweroff. ``/power/control``: Must be ``auto``, and the port will not power down until ``/power/runtime_status`` reflects the 'suspended' state. Default value is controlled by child device driver. ``/power/persist``: This defaults to ``1`` for most devices and indicates if kernel can persist the device's configuration across a power session loss (suspend / port-power event). When this value is ``0`` (quirky devices), port poweroff is disabled. ``/driver/unbind``: Wakeup capable devices will block port poweroff. At this time the only mechanism to clear the usb-internal wakeup-capability for an interface device is to unbind its driver. h](hdefinition_list)}(hhh](hdefinition_list_item)}(hXY``/power/pm_qos_no_power_off``: This writable flag controls the state of an idle port. Once all children and descendants have suspended the port may suspend/poweroff provided that pm_qos_no_power_off is '0'. If pm_qos_no_power_off is '1' the port will remain active/powered regardless of the stats of descendants. Defaults to 1. h](hterm)}(h-``/power/pm_qos_no_power_off``:h](jw)}(h,``/power/pm_qos_no_power_off``h]h(/power/pm_qos_no_power_off}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1jhhhMhjubh definition)}(hhh]h)}(hX*This writable flag controls the state of an idle port. Once all children and descendants have suspended the port may suspend/poweroff provided that pm_qos_no_power_off is '0'. If pm_qos_no_power_off is '1' the port will remain active/powered regardless of the stats of descendants. Defaults to 1.h]hX2This writable flag controls the state of an idle port. Once all children and descendants have suspended the port may suspend/poweroff provided that pm_qos_no_power_off is ‘0’. If pm_qos_no_power_off is ‘1’ the port will remain active/powered regardless of the stats of descendants. Defaults to 1.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhMhjubj)}(h``/power/runtime_status``: This file reflects whether the port is 'active' (power is on) or 'suspended' (logically off). There is no indication to userspace whether VBUS is still supplied. h](j)}(h(``/power/runtime_status``:h](jw)}(h'``/power/runtime_status``h]h#/power/runtime_status}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhj+ubh:}(hj+hhhNhNubeh}(h]h ]h"]h$]h&]uh1jhhhMhj'ubj )}(hhh]h)}(hThis file reflects whether the port is 'active' (power is on) or 'suspended' (logically off). There is no indication to userspace whether VBUS is still supplied.h]hThis file reflects whether the port is ‘active’ (power is on) or ‘suspended’ (logically off). There is no indication to userspace whether VBUS is still supplied.}(hjJhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjGubah}(h]h ]h"]h$]h&]uh1jhj'ubeh}(h]h ]h"]h$]h&]uh1jhhhMhjubj)}(hX``/connect_type``: An advisory read-only flag to userspace indicating the location and connection type of the port. It returns one of four values 'hotplug', 'hardwired', 'not used', and 'unknown'. All values, besides unknown, are set by platform firmware. ``hotplug`` indicates an externally connectable/visible port on the platform. Typically userspace would choose to keep such a port powered to handle new device connection events. ``hardwired`` refers to a port that is not visible but connectable. Examples are internal ports for USB bluetooth that can be disconnected via an external switch or a port with a hardwired USB camera. It is expected to be safe to allow these ports to suspend provided pm_qos_no_power_off is coordinated with any switch that gates connections. Userspace must arrange for the device to be connected prior to the port powering off, or to activate the port prior to enabling connection via a switch. ``not used`` refers to an internal port that is expected to never have a device connected to it. These may be empty internal ports, or ports that are not physically exposed on a platform. Considered safe to be powered-off at all times. ``unknown`` means platform firmware does not provide information for this port. Most commonly refers to external hub ports which should be considered 'hotplug' for policy decisions. .. note:: - since we are relying on the BIOS to get this ACPI information correct, the USB port descriptions may be missing or wrong. - Take care in clearing ``pm_qos_no_power_off``. Once power is off this port will not respond to new connect events. h](j)}(h ``/connect_type``:h](jw)}(h``/connect_type``h]h/connect_type}(hjlhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjhubh:}(hjhhhhNhNubeh}(h]h ]h"]h$]h&]uh1jhhhMhjdubj )}(hhh](h)}(hAn advisory read-only flag to userspace indicating the location and connection type of the port. It returns one of four values 'hotplug', 'hardwired', 'not used', and 'unknown'. All values, besides unknown, are set by platform firmware.h]hAn advisory read-only flag to userspace indicating the location and connection type of the port. It returns one of four values ‘hotplug’, ‘hardwired’, ‘not used’, and ‘unknown’. All values, besides unknown, are set by platform firmware.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubh)}(h``hotplug`` indicates an externally connectable/visible port on the platform. Typically userspace would choose to keep such a port powered to handle new device connection events.h](jw)}(h ``hotplug``h]hhotplug}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh indicates an externally connectable/visible port on the platform. Typically userspace would choose to keep such a port powered to handle new device connection events.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubh)}(hX``hardwired`` refers to a port that is not visible but connectable. Examples are internal ports for USB bluetooth that can be disconnected via an external switch or a port with a hardwired USB camera. It is expected to be safe to allow these ports to suspend provided pm_qos_no_power_off is coordinated with any switch that gates connections. Userspace must arrange for the device to be connected prior to the port powering off, or to activate the port prior to enabling connection via a switch.h](jw)}(h ``hardwired``h]h hardwired}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubhX refers to a port that is not visible but connectable. Examples are internal ports for USB bluetooth that can be disconnected via an external switch or a port with a hardwired USB camera. It is expected to be safe to allow these ports to suspend provided pm_qos_no_power_off is coordinated with any switch that gates connections. Userspace must arrange for the device to be connected prior to the port powering off, or to activate the port prior to enabling connection via a switch.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubh)}(h``not used`` refers to an internal port that is expected to never have a device connected to it. These may be empty internal ports, or ports that are not physically exposed on a platform. Considered safe to be powered-off at all times.h](jw)}(h ``not used``h]hnot used}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh refers to an internal port that is expected to never have a device connected to it. These may be empty internal ports, or ports that are not physically exposed on a platform. Considered safe to be powered-off at all times.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubh)}(h``unknown`` means platform firmware does not provide information for this port. Most commonly refers to external hub ports which should be considered 'hotplug' for policy decisions.h](jw)}(h ``unknown``h]hunknown}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh means platform firmware does not provide information for this port. Most commonly refers to external hub ports which should be considered ‘hotplug’ for policy decisions.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubhnote)}(h- since we are relying on the BIOS to get this ACPI information correct, the USB port descriptions may be missing or wrong. - Take care in clearing ``pm_qos_no_power_off``. Once power is off this port will not respond to new connect events.h]j)}(hhh](j)}(hzsince we are relying on the BIOS to get this ACPI information correct, the USB port descriptions may be missing or wrong. h]h)}(hysince we are relying on the BIOS to get this ACPI information correct, the USB port descriptions may be missing or wrong.h]hysince we are relying on the BIOS to get this ACPI information correct, the USB port descriptions may be missing or wrong.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhj ubj)}(hrTake care in clearing ``pm_qos_no_power_off``. Once power is off this port will not respond to new connect events.h]h)}(hrTake care in clearing ``pm_qos_no_power_off``. Once power is off this port will not respond to new connect events.h](hTake care in clearing }(hj*hhhNhNubjw)}(h``pm_qos_no_power_off``h]hpm_qos_no_power_off}(hj2hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhj*ubhE. Once power is off this port will not respond to new connect events.}(hj*hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj&ubah}(h]h ]h"]h$]h&]uh1jhj ubeh}(h]h ]h"]h$]h&]jjuh1jhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhjdubeh}(h]h ]h"]h$]h&]uh1jhhhMhjubeh}(h]h ]h"]h$]h&]uh1jhjubh)}(hjOnce a child device is attached additional constraints are applied before the port is allowed to poweroff.h]hjOnce a child device is attached additional constraints are applied before the port is allowed to poweroff.}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubj)}(hhh](j)}(h``/power/control``: Must be ``auto``, and the port will not power down until ``/power/runtime_status`` reflects the 'suspended' state. Default value is controlled by child device driver. h](j)}(h``/power/control``:h](jw)}(h``/power/control``h]h/power/control}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1jhhhMhjubj )}(hhh]h)}(hMust be ``auto``, and the port will not power down until ``/power/runtime_status`` reflects the 'suspended' state. Default value is controlled by child device driver.h](hMust be }(hjhhhNhNubjw)}(h``auto``h]hauto}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh), and the port will not power down until }(hjhhhNhNubjw)}(h ``/power/runtime_status``h]h/power/runtime_status}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubhY reflects the ‘suspended’ state. Default value is controlled by child device driver.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhMhj|ubj)}(hX``/power/persist``: This defaults to ``1`` for most devices and indicates if kernel can persist the device's configuration across a power session loss (suspend / port-power event). When this value is ``0`` (quirky devices), port poweroff is disabled. h](j)}(h``/power/persist``:h](jw)}(h``/power/persist``h]h/power/persist}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1jhhhMhjubj )}(hhh]h)}(hThis defaults to ``1`` for most devices and indicates if kernel can persist the device's configuration across a power session loss (suspend / port-power event). When this value is ``0`` (quirky devices), port poweroff is disabled.h](hThis defaults to }(hjhhhNhNubjw)}(h``1``h]h1}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh for most devices and indicates if kernel can persist the device’s configuration across a power session loss (suspend / port-power event). When this value is }(hjhhhNhNubjw)}(h``0``h]h0}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh- (quirky devices), port poweroff is disabled.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhMhj|ubj)}(h``/driver/unbind``: Wakeup capable devices will block port poweroff. At this time the only mechanism to clear the usb-internal wakeup-capability for an interface device is to unbind its driver. h](j)}(h``/driver/unbind``:h](jw)}(h``/driver/unbind``h]h/driver/unbind}(hjIhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjEubh:}(hjEhhhNhNubeh}(h]h ]h"]h$]h&]uh1jhhhMhjAubj )}(hhh]h)}(hWakeup capable devices will block port poweroff. At this time the only mechanism to clear the usb-internal wakeup-capability for an interface device is to unbind its driver.h]hWakeup capable devices will block port poweroff. At this time the only mechanism to clear the usb-internal wakeup-capability for an interface device is to unbind its driver.}(hjdhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjaubah}(h]h ]h"]h$]h&]uh1jhjAubeh}(h]h ]h"]h$]h&]uh1jhhhMhj|ubeh}(h]h ]h"]h$]h&]uh1jhjubeh}(h]h ]h"]h$]h&]uh1jhhhMhjhhubh)}(hFSummary of poweroff pre-requisite settings relative to a port device::h]hESummary of poweroff pre-requisite settings relative to a port device:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubjB)}(hecho 0 > power/pm_qos_no_power_off echo 0 > peer/power/pm_qos_no_power_off # if it exists echo auto > power/control # this is the default value echo auto > /power/control echo 1 > /power/persist # this is the default valueh]hecho 0 > power/pm_qos_no_power_off echo 0 > peer/power/pm_qos_no_power_off # if it exists echo auto > power/control # this is the default value echo auto > /power/control echo 1 > /power/persist # this is the default value}hjsbah}(h]h ]h"]h$]h&]j[j\uh1jAhhhMhjhhubeh}(h]%user-interface-for-port-power-controlah ]h"]%user interface for port power controlah$]h&]uh1hhhhhhhhMeubh)}(hhh](h)}(h%Suggested Userspace Port Power Policyh]h%Suggested Userspace Port Power Policy}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhM ubh)}(hfAs noted above userspace needs to be careful and deliberate about what ports are enabled for poweroff.h]hfAs noted above userspace needs to be careful and deliberate about what ports are enabled for poweroff.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjhhubh)}(hThe default configuration is that all ports start with ``power/pm_qos_no_power_off`` set to ``1`` causing ports to always remain active.h](h7The default configuration is that all ports start with }(hjhhhNhNubjw)}(h``power/pm_qos_no_power_off``h]hpower/pm_qos_no_power_off}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh set to }(hjhhhNhNubjw)}(h``1``h]h1}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhjubh' causing ports to always remain active.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hX3Given confidence in the platform firmware's description of the ports (ACPI _PLD record for a port populates 'connect_type') userspace can clear pm_qos_no_power_off for all 'not used' ports. The same can be done for 'hardwired' ports provided poweroff is coordinated with any connection switch for the port.h]hXAGiven confidence in the platform firmware’s description of the ports (ACPI _PLD record for a port populates ‘connect_type’) userspace can clear pm_qos_no_power_off for all ‘not used’ ports. The same can be done for ‘hardwired’ ports provided poweroff is coordinated with any connection switch for the port.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hXA more aggressive userspace policy is to enable USB port power off for all ports (set ``/power/pm_qos_no_power_off`` to ``0``) when some external factor indicates the user has stopped interacting with the system. For example, a distro may want to enable power off all USB ports when the screen blanks, and re-power them when the screen becomes active. Smart phones and tablets may want to power off USB ports when the user pushes the power button.h](hVA more aggressive userspace policy is to enable USB port power off for all ports (set }(hj hhhNhNubjw)}(h,``/power/pm_qos_no_power_off``h]h(/power/pm_qos_no_power_off}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jvhj ubh to }(hj hhhNhNubjw)}(h``0``h]h0}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1jvhj ubhXD) when some external factor indicates the user has stopped interacting with the system. For example, a distro may want to enable power off all USB ports when the screen blanks, and re-power them when the screen becomes active. Smart phones and tablets may want to power off USB ports when the user pushes the power button.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubeh}(h]%suggested-userspace-port-power-policyah ]h"]%suggested userspace port power policyah$]h&]uh1hhhhhhhhM ubeh}(h](power-management-for-usbheh ]h"](power management for usbusb-power-managementeh$]h&]uh1hhhhhhhhKexpect_referenced_by_name}jMhsexpect_referenced_by_id}hhsubeh}(h]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN source_urlN toc_backlinksentryfootnote_backlinksK sectnum_xformKstrip_commentsNstrip_elements_with_classesN strip_classesN report_levelK halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-siginput_encoding_error_handlerstrictoutput_encodingutf-8output_encoding_error_handlerjwerror_encodingutf-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourceh _destinationN _config_files]7/var/lib/git/docbuild/linux/Documentation/docutils.confafile_insertion_enabled raw_enabledKline_length_limitM'pep_referencesN pep_base_urlhttps://peps.python.org/pep_file_url_templatepep-%04drfc_referencesN rfc_base_url&https://datatracker.ietf.org/doc/html/ tab_widthKtrim_footnote_reference_spacesyntax_highlightlong smart_quotessmartquotes_locales]character_level_inline_markupdoctitle_xformA docinfo_xformKsectsubtitle_xform image_loadinglinkembed_stylesheetcloak_email_addressessection_self_linkenvNubreporterNindirect_targets]substitution_defs}substitution_names}refnames}(f1]j\af2]jsaf3]jaurefids}(h]hajl]j\aj]jsaj]jaunameids}(jMhjLjIjojljjjjj<j9jjjjjj~j j j j j j jjj"jjjjjjjljJjj~jjjjDjAu nametypes}(jMjLjojjj<jjjj j j jj"jjjjJj~jjDuh}(hhjIhjlj]jjrjjj9jjj?jj"j~jj jj j j j jj jjjj%jjjfj\j}jsjjjljjjjjMjjjAju footnote_refs}(j]j\aj]jsaj]jau citation_refs} autofootnotes](jjjMeautofootnote_refs](j\jsjesymbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK id_counter collectionsCounter}jKsRparse_messages]transform_messages]hsystem_message)}(hhh]h)}(hhh]h:Hyperlink target "usb-power-management" is not referenced.}hjsbah}(h]h ]h"]h$]h&]uh1hhjubah}(h]h ]h"]h$]h&]levelKtypeINFOsourcehlineKuh1juba transformerN include_log] decorationNhhub.