diff options
| author | Eduardo Valentin <eduardo.valentin@ti.com> | 2013-03-15 09:00:27 -0400 |
|---|---|---|
| committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2013-03-15 09:02:23 -0700 |
| commit | 38d99e807b0c555e768c60c3ff11fe7e3b2e9418 (patch) | |
| tree | 968af446b8d210a4b8b01aa02013fa74ab1c623f | |
| parent | 31102a7202dec13296a7de8e72427966813da75e (diff) | |
staging: omap-thermal: document omap_bandgap_update_alert_threshold function
Document function to program alert thresholds
Signed-off-by: Eduardo Valentin <eduardo.valentin@ti.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
| -rw-r--r-- | drivers/staging/omap-thermal/omap-bandgap.c | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/drivers/staging/omap-thermal/omap-bandgap.c b/drivers/staging/omap-thermal/omap-bandgap.c index 065f3716c540..0eb21b330415 100644 --- a/drivers/staging/omap-thermal/omap-bandgap.c +++ b/drivers/staging/omap-thermal/omap-bandgap.c @@ -370,6 +370,20 @@ static void omap_bandgap_unmask_interrupts(struct omap_bandgap *bg_ptr, int id, omap_bandgap_writel(bg_ptr, reg_val, tsr->bgap_mask_ctrl); } +/** + * omap_bandgap_update_alert_threshold() - sequence to update thresholds + * @bg_ptr: struct omap_bandgap pointer + * @id: bandgap sensor id + * @val: value (ADC) of a new threshold + * @hot: desired threshold to be updated. true if threshold hot, false if + * threshold cold + * + * It will program the required thresholds (hot and cold) for TALERT signal. + * This function can be used to update t_hot or t_cold, depending on @hot value. + * It checks the resulting t_hot and t_cold values, based on the new passed @val + * and configures the thresholds so that t_hot is always greater than t_cold. + * Call this function only if bandgap features HAS(TALERT). + */ static int omap_bandgap_update_alert_threshold(struct omap_bandgap *bg_ptr, int id, int val, bool hot) |