staging: omap-thermal: document _omap_bandgap_write_threshold function

Document function to update alert thresholds.

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:28 -04:00 committed by Greg Kroah-Hartman
parent 38d99e807b
commit 9efa93b0e6

View File

@ -455,6 +455,19 @@ exit:
return ret;
}
/**
* _omap_bandgap_write_threshold() - helper to update TALERT t_cold or t_hot
* @bg_ptr: struct omap_bandgap pointer
* @id: bandgap sensor id
* @val: value (mCelsius) of a new threshold
* @hot: desired threshold to be updated. true if threshold hot, false if
* threshold cold
*
* It will update 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.
* Validates the mCelsius range and update the requested threshold.
* Call this function only if bandgap features HAS(TALERT).
*/
int _omap_bandgap_write_threshold(struct omap_bandgap *bg_ptr, int id, int val,
bool hot)
{