PM / Runtime: Fix kerneldoc comment for rpm_suspend()
This patch fix kerneldoc comments for rpm_suspend(): - 'Cancel a pending idle notification' should be put before, also should be changed to 'Cancel a pending idle notification, autosuspend or suspend'. - idle notification for the device after succeeding suspend has been removed, so update the comment accordingly. [rjw: Modified the subject and changelog slightly.] Signed-off-by: Ming Lei <ming.lei@canonical.com> Signed-off-by: Rafael J. Wysocki <rjw@sisk.pl>
This commit is contained in:
parent
2fb242adca
commit
47d8f0bac0
1 changed files with 10 additions and 8 deletions
|
@ -286,14 +286,16 @@ static int rpm_callback(int (*cb)(struct device *), struct device *dev)
|
|||
* @dev: Device to suspend.
|
||||
* @rpmflags: Flag bits.
|
||||
*
|
||||
* Check if the device's runtime PM status allows it to be suspended. If
|
||||
* another suspend has been started earlier, either return immediately or wait
|
||||
* for it to finish, depending on the RPM_NOWAIT and RPM_ASYNC flags. Cancel a
|
||||
* pending idle notification. If the RPM_ASYNC flag is set then queue a
|
||||
* suspend request; otherwise run the ->runtime_suspend() callback directly.
|
||||
* If a deferred resume was requested while the callback was running then carry
|
||||
* it out; otherwise send an idle notification for the device (if the suspend
|
||||
* failed) or for its parent (if the suspend succeeded).
|
||||
* Check if the device's runtime PM status allows it to be suspended.
|
||||
* Cancel a pending idle notification, autosuspend or suspend. If
|
||||
* another suspend has been started earlier, either return immediately
|
||||
* or wait for it to finish, depending on the RPM_NOWAIT and RPM_ASYNC
|
||||
* flags. If the RPM_ASYNC flag is set then queue a suspend request;
|
||||
* otherwise run the ->runtime_suspend() callback directly. If a deferred
|
||||
* resume was requested while the callback was running then carry it out;
|
||||
* otherwise send an idle notification for its parent (if the suspend
|
||||
* succeeded and both ignore_children of parent->power and irq_safe of
|
||||
* dev->power are not set).
|
||||
*
|
||||
* This function must be called under dev->power.lock with interrupts disabled.
|
||||
*/
|
||||
|
|
Reference in a new issue