thermal: doc: Add details of devm_thermal_zone_of_sensor_{register,unregister}
authorLaxman Dewangan <ldewangan@nvidia.com>
Wed, 9 Mar 2016 13:10:08 +0000 (18:40 +0530)
committerEduardo Valentin <edubezval@gmail.com>
Wed, 9 Mar 2016 18:51:41 +0000 (10:51 -0800)
Add details of the interface devm_thermal_zone_of_sensor_register()
and devm_thermal_zone_of_sensor_unregister() in the
<thermal/sysfs-api.txt>.

Signed-off-by: Laxman Dewangan <ldewangan@nvidia.com>
Signed-off-by: Eduardo Valentin <edubezval@gmail.com>
Documentation/thermal/sysfs-api.txt

index 18a3a5e..ed419d6 100644 (file)
@@ -117,6 +117,29 @@ temperature) and throttle appropriate devices.
        interface. It will also silent the zone by remove the .get_temp() and
        get_trend() thermal zone device callbacks.
 
+1.1.5 struct thermal_zone_device *devm_thermal_zone_of_sensor_register(
+               struct device *dev, int sensor_id,
+               void *data, const struct thermal_zone_of_device_ops *ops)
+
+       This interface is resource managed version of
+       thermal_zone_of_sensor_register().
+       All details of thermal_zone_of_sensor_register() described in
+       section 1.1.3 is applicable here.
+       The benefit of using this interface to register sensor is that it
+       is not require to explicitly call thermal_zone_of_sensor_unregister()
+       in error path or during driver unbinding as this is done by driver
+       resource manager.
+
+1.1.6 void devm_thermal_zone_of_sensor_unregister(struct device *dev,
+               struct thermal_zone_device *tzd)
+
+       This interface is resource managed version of
+       thermal_zone_of_sensor_unregister().
+       All details of thermal_zone_of_sensor_unregister() described in
+       section 1.1.4 is applicable here.
+       Normally this function will not need to be called and the resource
+       management code will ensure that the resource is freed.
+
 1.2 thermal cooling device interface
 1.2.1 struct thermal_cooling_device *thermal_cooling_device_register(char *name,
                void *devdata, struct thermal_cooling_device_ops *)