thermal: Fix comments
authorFabio Estevam <fabio.estevam@freescale.com>
Tue, 14 Jul 2015 01:01:52 +0000 (22:01 -0300)
committerStefano Babic <sbabic@denx.de>
Sun, 26 Jul 2015 10:11:33 +0000 (12:11 +0200)
It seems that many comments were copied from the I2C uclass, so adjust
the comments for the thermal class.

Reported-by: Simon Glass <sjg@chromium.org>
Signed-off-by: Fabio Estevam <fabio.estevam@freescale.com>
Acked-by: Otavio Salvador <otavio@ossystems.com.br>
Acked-by: Simon Glass <sjg@chromium.org>
include/thermal.h

index 5d6101bec6ee11c96292259cb3ab07c0130b2445..b197c0aaa77851b5e7e02ad2396347934d631309 100644 (file)
@@ -13,7 +13,7 @@
 int thermal_get_temp(struct udevice *dev, int *temp);
 
 /**
- * struct struct dm_thermal_ops - Driver model Thermal operations
+ * struct dm_thermal_ops - Driver model Thermal operations
  *
  * The uclass interface is implemented by all Thermal devices which use
  * driver model.
@@ -22,19 +22,11 @@ struct dm_thermal_ops {
        /**
         * Get the current temperature
         *
-        * The device provided is the slave device. It's parent controller
-        * will be used to provide the communication.
-        *
-        * This must be called before doing any transfers with a Thermal slave.
-        * It will enable and initialize any Thermal hardware as necessary,
-        * and make sure that the SCK line is in the correct idle state. It is
-        * not allowed to claim the same bus for several slaves without
-        * releasing the bus in between.
+        * This must be called before doing any transfers with a Thermal device.
+        * It will enable and initialize any Thermal hardware as necessary.
         *
         * @dev:        The Thermal device
-        *
-        * Returns: 0 if the bus was claimed successfully, or a negative value
-        * if it wasn't.
+        * @temp:       pointer that returns the measured temperature
         */
        int (*get_temp)(struct udevice *dev, int *temp);
 };