PM / runtime: Fix autosuspend documentation
authorJohan Hovold <johan@kernel.org>
Mon, 10 Apr 2017 11:38:24 +0000 (13:38 +0200)
committerRafael J. Wysocki <rafael.j.wysocki@intel.com>
Wed, 19 Apr 2017 21:29:17 +0000 (23:29 +0200)
commit72ec2e17f9f7f7f6082ec57183080726eb3523e3
treec1975c248e1473bf1b7d82295eb2697adb2d2e62
parent4f7d029b9bf009fbee76bb10c0c4351a1870d2f3
PM / runtime: Fix autosuspend documentation

Update the autosuspend documentation which claimed that the autosuspend
delay is not taken into account when using the non-autosuspend helper
functions, something which is no longer true since commit d66e6db28df3
("PM / Runtime: Respect autosuspend when idle triggers suspend").

This specifically means that drivers must now disable autosuspend before
disabling runtime pm in probe error paths and remove callbacks if
pm_runtime_put_sync was being used to suspend the device before
returning. (If an idle callback can prevent suspend,
pm_runtime_put_sync_suspend must be used instead of pm_runtime_put_sync
as before.)

Also remove the claim that the autosuspend helpers behave "just like
the non-autosuspend counterparts", something which have never really
been true as some of the latter use idle notifications.

Signed-off-by: Johan Hovold <johan@kernel.org>
Acked-by: Tony Lindgren <tony@atomide.com>
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
Documentation/power/runtime_pm.txt