Browse Source

PM / runtime: Document steps for device removal

Put a reminder that during device removal drivers should revert all PM
runtime changes from the probe.

Signed-off-by: Krzysztof Kozlowski <krzk@kernel.org>
Acked-by: Alan Stern <stern@rowland.harvard.edu>
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Krzysztof Kozlowski 9 years ago
parent
commit
8fd2910e31
1 changed files with 4 additions and 0 deletions
  1. 4 0
      Documentation/power/runtime_pm.txt

+ 4 - 0
Documentation/power/runtime_pm.txt

@@ -586,6 +586,10 @@ drivers to make their ->remove() callbacks avoid races with runtime PM directly,
 but also it allows of more flexibility in the handling of devices during the
 but also it allows of more flexibility in the handling of devices during the
 removal of their drivers.
 removal of their drivers.
 
 
+Drivers in ->remove() callback should undo the runtime PM changes done
+in ->probe(). Usually this means calling pm_runtime_disable(),
+pm_runtime_dont_use_autosuspend() etc.
+
 The user space can effectively disallow the driver of the device to power manage
 The user space can effectively disallow the driver of the device to power manage
 it at run time by changing the value of its /sys/devices/.../power/control
 it at run time by changing the value of its /sys/devices/.../power/control
 attribute to "on", which causes pm_runtime_forbid() to be called.  In principle,
 attribute to "on", which causes pm_runtime_forbid() to be called.  In principle,