Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 0e7414b7 authored by Rafael J. Wysocki's avatar Rafael J. Wysocki
Browse files

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: default avatarRafael J. Wysocki <rafael.j.wysocki@intel.com>
parent 8f6040ce
Loading
Loading
Loading
Loading
+7 −1
Original line number Diff line number Diff line
@@ -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;