aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEduardo Valentin <eduardo.valentin@ti.com>2013-03-15 09:00:31 -0400
committerGreg Kroah-Hartman <gregkh@linuxfoundation.org>2013-03-15 09:02:24 -0700
commit094b8aca16afcd380b60d11ba23d74ee5836d781 (patch)
tree2c0d5fd5a0bf9c13dd9a4bc39ca0ed5246e71ecc
parentstaging: omap-thermal: document omap_bandgap_tshut_init function (diff)
downloadlinux-dev-094b8aca16afcd380b60d11ba23d74ee5836d781.tar.xz
linux-dev-094b8aca16afcd380b60d11ba23d74ee5836d781.zip
staging: omap-thermal: document omap_bandgap_alert_init function
Document function that sets talert handling up. 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.c12
1 files changed, 11 insertions, 1 deletions
diff --git a/drivers/staging/omap-thermal/omap-bandgap.c b/drivers/staging/omap-thermal/omap-bandgap.c
index f2ebbcf4facd..3150ec25dc6a 100644
--- a/drivers/staging/omap-thermal/omap-bandgap.c
+++ b/drivers/staging/omap-thermal/omap-bandgap.c
@@ -842,7 +842,17 @@ static int omap_bandgap_tshut_init(struct omap_bandgap *bg_ptr,
return 0;
}
-/* Initialization of Talert. Call it only if HAS(TALERT) is set */
+/**
+ * omap_bandgap_alert_init() - setup and initialize talert 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(TALERT).
+ * In this case, the driver needs to handle the TALERT signals as an IRQs.
+ * TALERT is a normal IRQ and it is fired any time thresholds (hot or cold)
+ * are violated. In these situation, the driver must reprogram the thresholds,
+ * accordingly to specified policy.
+ */
static int omap_bandgap_talert_init(struct omap_bandgap *bg_ptr,
struct platform_device *pdev)
{