diff options
| author | Rafael J. Wysocki <rafael.j.wysocki@intel.com> | 2016-12-01 23:31:32 +0100 |
|---|---|---|
| committer | Rafael J. Wysocki <rafael.j.wysocki@intel.com> | 2016-12-06 02:25:03 +0100 |
| commit | 0e7414b7aa8b294fddefbad020798f7c8ebe1622 (patch) | |
| tree | 766abc73c95d2148bda62f20b265eed5b429721a | |
| parent | cpuidle: fix improper return value on error (diff) | |
| download | linux-0e7414b7aa8b294fddefbad020798f7c8ebe1622.tar.xz linux-0e7414b7aa8b294fddefbad020798f7c8ebe1622.zip | |
cpuidle: Add a kerneldoc comment to cpuidle_use_deepest_state()
Since cpuidle_use_deepest_state() is not static, add a proper
kerneldoc comment to it to document its purpose.
Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com>
| -rw-r--r-- | drivers/cpuidle/cpuidle.c | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/drivers/cpuidle/cpuidle.c b/drivers/cpuidle/cpuidle.c index afc005b917fe..62810ff3b00f 100644 --- a/drivers/cpuidle/cpuidle.c +++ b/drivers/cpuidle/cpuidle.c @@ -97,7 +97,13 @@ static int find_deepest_state(struct cpuidle_driver *drv, return ret; } -/* Set the current cpu to use the deepest idle state, override governors */ +/** + * cpuidle_use_deepest_state - Set/clear governor override flag. + * @enable: New value of the flag. + * + * Set/unset the current CPU to use the deepest idle state (override governors + * going forward if set). + */ void cpuidle_use_deepest_state(bool enable) { struct cpuidle_device *dev; |