From 31102a7202dec13296a7de8e72427966813da75e Mon Sep 17 00:00:00 2001
From: Eduardo Valentin <eduardo.valentin@ti.com>
Date: Fri, 15 Mar 2013 09:00:26 -0400
Subject: [PATCH] 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>
---
drivers/staging/omap-thermal/omap-bandgap.c | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/drivers/staging/omap-thermal/omap-bandgap.c b/drivers/staging/omap-thermal/omap-bandgap.c
index d893931295303..065f3716c540f 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)
{
--
2.30.2