From: Eduardo Valentin Date: Fri, 15 Mar 2013 13:00:15 +0000 (-0400) Subject: staging: omap-thermal: add documentation for omap_bandgap_mcelsius_to_adc X-Git-Tag: next-20130320~21^2~80 X-Git-Url: https://git.karo-electronics.de/?a=commitdiff_plain;h=e7f60b5360ff093a220b0022e62648d9090eae4e;p=karo-tx-linux.git staging: omap-thermal: add documentation for omap_bandgap_mcelsius_to_adc Document the conversion function. Signed-off-by: Eduardo Valentin Signed-off-by: Greg Kroah-Hartman --- 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)