Commit 2577e937 authored by Eduardo Valentin's avatar Eduardo Valentin Committed by Greg Kroah-Hartman

staging: omap-thermal: add documentation for omap_bandgap_adc_to_mcelsius

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 20470599
...@@ -233,6 +233,17 @@ static irqreturn_t omap_bandgap_tshut_irq_handler(int irq, void *data) ...@@ -233,6 +233,17 @@ static irqreturn_t omap_bandgap_tshut_irq_handler(int irq, void *data)
/*** Helper functions which manipulate conversion ADC <-> mi Celsius ***/ /*** 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 static
int omap_bandgap_adc_to_mcelsius(struct omap_bandgap *bg_ptr, int id, int omap_bandgap_adc_to_mcelsius(struct omap_bandgap *bg_ptr, int id,
int adc_val, int *t) int adc_val, int *t)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment