staging: omap-thermal: update omap_bandgap_unmask_interrupts documentation

Proper document the function to configure the IRQ event masks.

Signed-off-by: Eduardo Valentin <eduardo.valentin@ti.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>

diff --git a/drivers/staging/omap-thermal/omap-bandgap.c b/drivers/staging/omap-thermal/omap-bandgap.c
index 26d36f3..d001323 100644 (file)
--- a/drivers/staging/omap-thermal/omap-bandgap.c
+++ b/drivers/staging/omap-thermal/omap-bandgap.c
@@ -337,7 +337,15 @@ exit:
 
 /***   Helper functions handling device Alert/Shutdown signals   ***/
 
-/* Talert masks. Call it only if HAS(TALERT) is set */
+/**
+ * omap_bandgap_unmask_interrupts() - unmasks the events of thot & tcold
+ * @bg_ptr: struct omap_bandgap pointer
+ * @t_hot: hot temperature value to trigger alert signal
+ * @t_cold: cold temperature value to trigger alert signal
+ *
+ * Checks the requested t_hot and t_cold values and configures the IRQ event
+ * masks accordingly. Call this function only if bandgap features HAS(TALERT).
+ */
 static void omap_bandgap_unmask_interrupts(struct omap_bandgap *bg_ptr, int id,
                                           u32 t_hot, u32 t_cold)
 {