leandrof/linux
1
0
Fork 0
forked from Minki/linux
Code Issues Pull Requests Packages Projects Releases Wiki Activity

staging: omap-thermal: add documentation for omap_bandgap_mcelsius_to_adc

Browse Source 
Document the conversion function.

Signed-off-by: Eduardo Valentin <eduardo.valentin@ti.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:
Eduardo Valentin 2013-03-15 09:00:15 -04:00 committed by Greg Kroah-Hartman
parent 26a70ed987
commit e7f60b5360
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
drivers/staging/omap-thermal/omap-bandgap.c
View File

@ -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)