From e7f60b5360ff093a220b0022e62648d9090eae4e Mon Sep 17 00:00:00 2001 From: Eduardo Valentin <eduardo.valentin@ti.com> Date: Fri, 15 Mar 2013 09:00:15 -0400 Subject: [PATCH] staging: omap-thermal: add documentation for omap_bandgap_mcelsius_to_adc Document the conversion function. 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 | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/drivers/staging/omap-thermal/omap-bandgap.c b/drivers/staging/omap-thermal/omap-bandgap.c index 963fcafc76e1..39bfe8d48eff 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) -- 2.34.1