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>
This commit is contained in:
Rafael J. Wysocki 2016-12-01 23:31:32 +01:00
parent 8f6040cebd
commit 0e7414b7aa

View File

@ -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;