staging: omap-thermal: document omap_bandgap_add_hyst function

Document function to handle hysteresis.

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:17 -04:00 committed by Greg Kroah-Hartman
parent 0f0ed7dee2
commit 8a1cefe857

View File

@ -303,6 +303,16 @@ exit:
return ret;
}
/**
* omap_bandgap_add_hyst() - add hysteresis (in mCelsius) to an ADC value
* @bg_ptr: struct omap_bandgap pointer
* @adc_val: temperature value in ADC representation
* @hyst_val: hysteresis value in mCelsius
* @sum: address where to write the resulting temperature (in ADC scale)
*
* Adds an hysteresis value (in mCelsius) to a ADC temperature value.
* Returns 0 on success, -ERANGE otherwise.
*/
static
int omap_bandgap_add_hyst(struct omap_bandgap *bg_ptr, int adc_val,
int hyst_val, u32 *sum)