summaryrefslogtreecommitdiff
path: root/include/thermal.h
diff options
context:
space:
mode:
authorFabio Estevam <fabio.estevam@freescale.com>2015-07-13 22:01:52 -0300
committerStefano Babic <sbabic@denx.de>2015-07-26 12:11:33 +0200
commit6918f974cf48b31c63f3e975302e8178575aa832 (patch)
tree031334e183e8018baa0858c9c5b2b6886f60c749 /include/thermal.h
parent0b7f7c339c13256a2d6f39c0323b0224cb6d46d4 (diff)
downloadu-boot-imx-6918f974cf48b31c63f3e975302e8178575aa832.zip
u-boot-imx-6918f974cf48b31c63f3e975302e8178575aa832.tar.gz
u-boot-imx-6918f974cf48b31c63f3e975302e8178575aa832.tar.bz2
thermal: Fix comments
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>
Diffstat (limited to 'include/thermal.h')
-rw-r--r--include/thermal.h16
1 files changed, 4 insertions, 12 deletions
diff --git a/include/thermal.h b/include/thermal.h
index 5d6101b..b197c0a 100644
--- a/include/thermal.h
+++ b/include/thermal.h
@@ -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);
};