Commit 0d76d6e1 authored by Willy WOLFF's avatar Willy WOLFF Committed by Zhang Rui

thermal: fix source code documentation for parameters

Some parameters are not documented, or not present at all, in thermal
governors code.
Signed-off-by: default avatarWilly Wolff <willy.mh.wolff@gmail.com>
Signed-off-by: default avatarZhang Rui <rui.zhang@intel.com>
parent c0bc126f
...@@ -71,6 +71,7 @@ static long get_target_state(struct thermal_zone_device *tz, ...@@ -71,6 +71,7 @@ static long get_target_state(struct thermal_zone_device *tz,
/** /**
* fair_share_throttle - throttles devices associated with the given zone * fair_share_throttle - throttles devices associated with the given zone
* @tz - thermal_zone_device * @tz - thermal_zone_device
* @trip - trip point index
* *
* Throttling Logic: This uses three parameters to calculate the new * Throttling Logic: This uses three parameters to calculate the new
* throttle state of the cooling devices associated with the given zone. * throttle state of the cooling devices associated with the given zone.
......
...@@ -186,8 +186,7 @@ static void thermal_zone_trip_update(struct thermal_zone_device *tz, int trip) ...@@ -186,8 +186,7 @@ static void thermal_zone_trip_update(struct thermal_zone_device *tz, int trip)
/** /**
* step_wise_throttle - throttles devices associated with the given zone * step_wise_throttle - throttles devices associated with the given zone
* @tz - thermal_zone_device * @tz - thermal_zone_device
* @trip - the trip point * @trip - trip point index
* @trip_type - type of the trip point
* *
* Throttling Logic: This uses the trend of the thermal zone to throttle. * Throttling Logic: This uses the trend of the thermal zone to throttle.
* If the thermal zone is 'heating up' this throttles all the cooling * If the thermal zone is 'heating up' this throttles all the cooling
......
...@@ -24,12 +24,13 @@ ...@@ -24,12 +24,13 @@
#include <linux/thermal.h> #include <linux/thermal.h>
#include <linux/slab.h> #include <linux/slab.h>
#include "thermal_core.h" #include "thermal_core.h"
/** /**
* notify_user_space - Notifies user space about thermal events * notify_user_space - Notifies user space about thermal events
* @tz - thermal_zone_device * @tz - thermal_zone_device
* @trip - Trip point index * @trip - trip point index
* *
* This function notifies the user space through UEvents. * This function notifies the user space through UEvents.
*/ */
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment