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

staging: omap-thermal: add documentation for omap_bandgap_adc_to_mcelsius

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:11 -04:00 committed by Greg Kroah-Hartman
parent 2047059921
commit 2577e937cb
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -233,6 +233,17 @@ static irqreturn_t omap_bandgap_tshut_irq_handler(int irq, void *data)
/*** Helper functions which manipulate conversion ADC <-> mi Celsius ***/
/**
* omap_bandgap_adc_to_mcelsius() - converts an ADC value to mCelsius scale
* @bg_ptr: struct omap_bandgap pointer
* @id: sensor id
* @adc_val: value in ADC representation
* @t: address where to write the resulting temperature in mCelsius
*
* Simple conversion from ADC representation to mCelsius. In case the ADC 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_adc_to_mcelsius(struct omap_bandgap *bg_ptr, int id,
int adc_val, int *t)