diff options
author | Eduardo Valentin <eduardo.valentin@ti.com> | 2013-03-15 09:00:17 -0400 |
---|---|---|
committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2013-03-15 09:02:22 -0700 |
commit | 8a1cefe857ae936d5a5f731eb301737139434580 (patch) | |
tree | ebfa392c74919ae79a4531578e3cb280c2626558 /drivers/staging | |
parent | 0f0ed7dee23ff06456c13ad4f30829ccb761834b (diff) |
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>
Diffstat (limited to 'drivers/staging')
-rw-r--r-- | drivers/staging/omap-thermal/omap-bandgap.c | 10 |
1 files changed, 10 insertions, 0 deletions
diff --git a/drivers/staging/omap-thermal/omap-bandgap.c b/drivers/staging/omap-thermal/omap-bandgap.c index 7b10d1851092..bff4b757c51a 100644 --- a/drivers/staging/omap-thermal/omap-bandgap.c +++ b/drivers/staging/omap-thermal/omap-bandgap.c @@ -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) |