[23/50] staging: omap-thermal: add documentation for omap_bandgap_adc_to_mcelsius

Commit Message

Eduardo Valentin March 15, 2013, 1 p.m. UTC

Document the conversion function.

Signed-off-by: Eduardo Valentin <[e-mail]>
---
 drivers/staging/omap-thermal/omap-bandgap.c |   11 +++++++++++
 1 files changed, 11 insertions(+), 0 deletions(-)

Patch

diff --git a/drivers/staging/omap-thermal/omap-bandgap.c b/drivers/staging/omap-thermal/omap-bandgap.c
index 0068c66..8279cca 100644
--- a/drivers/staging/omap-thermal/omap-bandgap.c
+++ b/drivers/staging/omap-thermal/omap-bandgap.c
@@ -233,6 +233,17 @@  static irqreturn_t omap_bandgap_tshut_irq_handler(int irq, void *data)
 
 /***   Helper functions which manipulate conversion ADC <-> mi Celsius   ***/
 
+/**
+ * omap_bandgap_adc_to_mcelsius() - converts an ADC value to mCelsius scale
+ * @bg_ptr: struct omap_bandgap pointer
+ * @id: sensor id
+ * @adc_val: value in ADC representation
+ * @t: address where to write the resulting temperature in mCelsius
+ *
+ * Simple conversion from ADC representation to mCelsius. In case the ADC value
+ * is out of the ADC conv table range, it returns -ERANGE, 0 on success.
+ * The conversion table is indexed by the ADC values.
+ */
 static
 int omap_bandgap_adc_to_mcelsius(struct omap_bandgap *bg_ptr, int id,
 				 int adc_val, int *t)