diff options
| author | Eduardo Valentin <eduardo.valentin@ti.com> | 2013-03-15 14:00:30 +0100 |
|---|---|---|
| committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2013-03-15 17:02:24 +0100 |
| commit | d3790b3ddcccd2c62cb83aae33a36d3cb028506d (patch) | |
| tree | 7a309a865bbcf08b842f6fe04df209e0cb06db74 | |
| parent | staging: omap-thermal: document _omap_bandgap_read_threshold function (diff) | |
| download | linux-d3790b3ddcccd2c62cb83aae33a36d3cb028506d.tar.xz linux-d3790b3ddcccd2c62cb83aae33a36d3cb028506d.zip | |
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>
| -rw-r--r-- | drivers/staging/omap-thermal/omap-bandgap.c | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/drivers/staging/omap-thermal/omap-bandgap.c b/drivers/staging/omap-thermal/omap-bandgap.c index aa90539f20ca..f2ebbcf4facd 100644 --- a/drivers/staging/omap-thermal/omap-bandgap.c +++ b/drivers/staging/omap-thermal/omap-bandgap.c @@ -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) { |