Browse Source

thermal: cpu_cooling: update documentation for cpufreq_set_cur_state

Update documentation for cpufreq_set_cur_state callback.

Signed-off-by: Eduardo Valentin <eduardo.valentin@ti.com>
Acked-by: Amit Daniel Kachhap <amit.daniel@samsung.com>
Signed-off-by: Zhang Rui <rui.zhang@intel.com>
Eduardo Valentin 12 years ago
parent
commit
56e05fdb6d
1 changed files with 5 additions and 0 deletions
  1. 5 0
      drivers/thermal/cpu_cooling.c

+ 5 - 0
drivers/thermal/cpu_cooling.c

@@ -384,6 +384,11 @@ static int cpufreq_get_cur_state(struct thermal_cooling_device *cdev,
  * cpufreq_set_cur_state - callback function to set the current cooling state.
  * @cdev: thermal cooling device pointer.
  * @state: set this variable to the current cooling state.
+ *
+ * Callback for the thermal cooling device to change the cpufreq
+ * current cooling state.
+ *
+ * Return: 0 on success, an error code otherwise.
  */
 static int cpufreq_set_cur_state(struct thermal_cooling_device *cdev,
 				 unsigned long state)