Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit e7f60b53 authored by Eduardo Valentin's avatar Eduardo Valentin Committed by Greg Kroah-Hartman
Browse files

staging: omap-thermal: add documentation for omap_bandgap_mcelsius_to_adc 



Document the conversion function.

Signed-off-by: default avatarEduardo Valentin <eduardo.valentin@ti.com>
Signed-off-by: default avatarGreg Kroah-Hartman <gregkh@linuxfoundation.org>
parent 26a70ed9

drivers/staging/omap-thermal/omap-bandgap.c

+10 −0
Original line number Diff line number Diff line
@@ -262,6 +262,16 @@ int omap_bandgap_adc_to_mcelsius(struct omap_bandgap *bg_ptr, 
	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)