Skip to content

Commit 0873ad9

Browse files
committed
Merge branch 'pm-core'
* pm-core: PM: runtime: Improve kerneldoc of pm_runtime_get_if_active() PM: runtime: Add kerneldoc comments to multiple helpers
2 parents 9ac1fb1 + 0abf803 commit 0873ad9

File tree

2 files changed

+260
-12
lines changed

2 files changed

+260
-12
lines changed

drivers/base/power/runtime.c

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1085,24 +1085,26 @@ int __pm_runtime_resume(struct device *dev, int rpmflags)
10851085
EXPORT_SYMBOL_GPL(__pm_runtime_resume);
10861086

10871087
/**
1088-
* pm_runtime_get_if_active - Conditionally bump up the device's usage counter.
1088+
* pm_runtime_get_if_active - Conditionally bump up device usage counter.
10891089
* @dev: Device to handle.
1090+
* @ign_usage_count: Whether or not to look at the current usage counter value.
10901091
*
1091-
* Return -EINVAL if runtime PM is disabled for the device.
1092+
* Return -EINVAL if runtime PM is disabled for @dev.
10921093
*
1093-
* Otherwise, if the device's runtime PM status is RPM_ACTIVE and either
1094-
* ign_usage_count is true or the device's usage_count is non-zero, increment
1095-
* the counter and return 1. Otherwise return 0 without changing the counter.
1094+
* Otherwise, if the runtime PM status of @dev is %RPM_ACTIVE and either
1095+
* @ign_usage_count is %true or the runtime PM usage counter of @dev is not
1096+
* zero, increment the usage counter of @dev and return 1. Otherwise, return 0
1097+
* without changing the usage counter.
10961098
*
1097-
* If ign_usage_count is true, the function can be used to prevent suspending
1098-
* the device when its runtime PM status is RPM_ACTIVE.
1099+
* If @ign_usage_count is %true, this function can be used to prevent suspending
1100+
* the device when its runtime PM status is %RPM_ACTIVE.
10991101
*
1100-
* If ign_usage_count is false, the function can be used to prevent suspending
1101-
* the device when both its runtime PM status is RPM_ACTIVE and its usage_count
1102-
* is non-zero.
1102+
* If @ign_usage_count is %false, this function can be used to prevent
1103+
* suspending the device when both its runtime PM status is %RPM_ACTIVE and its
1104+
* runtime PM usage counter is not zero.
11031105
*
1104-
* The caller is resposible for putting the device's usage count when ther
1105-
* return value is greater than zero.
1106+
* The caller is resposible for decrementing the runtime PM usage counter of
1107+
* @dev after this function has returned a positive value for it.
11061108
*/
11071109
int pm_runtime_get_if_active(struct device *dev, bool ign_usage_count)
11081110
{

0 commit comments

Comments
 (0)