[PATCH 27/50] staging: omap-thermal: add documentation for omap_bandgap_mcelsius_to_adc
Eduardo Valentin
eduardo.valentin at ti.com
Fri Mar 15 13:00:15 UTC 2013
Document the conversion function.
Signed-off-by: Eduardo Valentin <eduardo.valentin at ti.com>
---
drivers/staging/omap-thermal/omap-bandgap.c | 10 ++++++++++
1 files changed, 10 insertions(+), 0 deletions(-)
diff --git a/drivers/staging/omap-thermal/omap-bandgap.c b/drivers/staging/omap-thermal/omap-bandgap.c
index 963fcaf..39bfe8d 100644
--- a/drivers/staging/omap-thermal/omap-bandgap.c
+++ b/drivers/staging/omap-thermal/omap-bandgap.c
@@ -262,6 +262,16 @@ exit:
return ret;
}
+/**
+ * omap_bandgap_mcelsius_to_adc() - converts a mCelsius value to ADC scale
+ * @bg_ptr: struct omap_bandgap pointer
+ * @temp: value in mCelsius
+ * @adc: address where to write the resulting temperature in ADC representation
+ *
+ * Simple conversion from mCelsius to ADC values. In case the temp 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_mcelsius_to_adc(struct omap_bandgap *bg_ptr, long temp,
int *adc)
--
1.7.7.1.488.ge8e1c
More information about the devel
mailing list