summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEduardo Valentin <eduardo.valentin@ti.com>2013-03-15 14:00:26 +0100
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>2013-03-15 17:02:23 +0100
commit31102a7202dec13296a7de8e72427966813da75e (patch)
treeb5044b9efcc8ed3ca1c3c4ef1abf020d06cbad53
parentstaging: omap-thermal: update omap_bandgap_set_continous_mode documentation (diff)
downloadlinux-31102a7202dec13296a7de8e72427966813da75e.tar.xz
linux-31102a7202dec13296a7de8e72427966813da75e.zip
staging: omap-thermal: document omap_bandgap_force_single_read
Document function to initialize the conversion state machine. Signed-off-by: Eduardo Valentin <eduardo.valentin@ti.com> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
-rw-r--r--drivers/staging/omap-thermal/omap-bandgap.c8
1 files changed, 8 insertions, 0 deletions
diff --git a/drivers/staging/omap-thermal/omap-bandgap.c b/drivers/staging/omap-thermal/omap-bandgap.c
index d89393129530..065f3716c540 100644
--- a/drivers/staging/omap-thermal/omap-bandgap.c
+++ b/drivers/staging/omap-thermal/omap-bandgap.c
@@ -705,6 +705,14 @@ void *omap_bandgap_get_sensor_data(struct omap_bandgap *bg_ptr, int id)
/*** Helper functions used during device initialization ***/
+/**
+ * omap_bandgap_force_single_read() - executes 1 single ADC conversion
+ * @bg_ptr: pointer to struct omap_bandgap
+ * @id: sensor id which it is desired to read 1 temperature
+ *
+ * Used to initialize the conversion state machine and set it to a valid
+ * state. Called during device initialization and context restore events.
+ */
static int
omap_bandgap_force_single_read(struct omap_bandgap *bg_ptr, int id)
{