Commit e1b1903e authored by Rafael J. Wysocki's avatar Rafael J. Wysocki

PM / Runtime: Make documentation of runtime_idle() agree with the code

Currently the ->runtime_idle() callback is documented as having no
return value, but in fact it returns int.  Although its return value
is ignored at the PM core level, it may be used by bus type routines
executing the drivers' ->runtime_idle() callbacks.
Signed-off-by: default avatarRafael J. Wysocki <rjw@sisk.pl>
Reported-by: default avatarAlan Stern <stern@rowland.harvard.edu>
parent 0ddf0ed1
...@@ -38,7 +38,7 @@ struct dev_pm_ops { ...@@ -38,7 +38,7 @@ struct dev_pm_ops {
... ...
int (*runtime_suspend)(struct device *dev); int (*runtime_suspend)(struct device *dev);
int (*runtime_resume)(struct device *dev); int (*runtime_resume)(struct device *dev);
void (*runtime_idle)(struct device *dev); int (*runtime_idle)(struct device *dev);
... ...
}; };
...@@ -114,7 +114,8 @@ The action performed by a bus type's ->runtime_idle() callback is totally ...@@ -114,7 +114,8 @@ The action performed by a bus type's ->runtime_idle() callback is totally
dependent on the bus type in question, but the expected and recommended action dependent on the bus type in question, but the expected and recommended action
is to check if the device can be suspended (i.e. if all of the conditions is to check if the device can be suspended (i.e. if all of the conditions
necessary for suspending the device are satisfied) and to queue up a suspend necessary for suspending the device are satisfied) and to queue up a suspend
request for the device in that case. request for the device in that case. The value returned by this callback is
ignored by the PM core.
The helper functions provided by the PM core, described in Section 4, guarantee The helper functions provided by the PM core, described in Section 4, guarantee
that the following constraints are met with respect to the bus type's run-time that the following constraints are met with respect to the bus type's run-time
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment