staging: omap-thermal: document omap_bandgap_tshut_init function

Add documentation for the function to setup TSHUT handling

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:30 -04:00 committed by Greg Kroah-Hartman
parent 7a681a50ed
commit d3790b3ddc

View File

@ -798,6 +798,18 @@ static int omap_bandgap_set_continuous_mode(struct omap_bandgap *bg_ptr)
return 0;
}
/**
* omap_bandgap_tshut_init() - setup and initialize tshut handling
* @bg_ptr: pointer to struct omap_bandgap
* @pdev: pointer to device struct platform_device
*
* Call this function only in case the bandgap features HAS(TSHUT).
* In this case, the driver needs to handle the TSHUT signal as an IRQ.
* The IRQ is wired as a GPIO, and for this purpose, it is required
* to specify which GPIO line is used. TSHUT IRQ is fired anytime
* one of the bandgap sensors violates the TSHUT high/hot threshold.
* And in that case, the system must go off.
*/
static int omap_bandgap_tshut_init(struct omap_bandgap *bg_ptr,
struct platform_device *pdev)
{