From: Eduardo Valentin Date: Fri, 15 Mar 2013 13:00:01 +0000 (-0400) Subject: staging: omap-thermal: update documentation for talert irq handler X-Git-Tag: firefly_0821_release~3680^2~674^2~632 X-Git-Url: http://demsky.eecs.uci.edu/git/?a=commitdiff_plain;h=ee07d55abb660726dd93aec4b7f1de36c6e777f0;p=firefly-linux-kernel-4.4.55.git staging: omap-thermal: update documentation for talert irq handler Document the Talert IRQ handler. Signed-off-by: Eduardo Valentin Signed-off-by: Greg Kroah-Hartman --- diff --git a/drivers/staging/omap-thermal/omap-bandgap.c b/drivers/staging/omap-thermal/omap-bandgap.c index 1906ef19a47c..aa60b7b920dc 100644 --- a/drivers/staging/omap-thermal/omap-bandgap.c +++ b/drivers/staging/omap-thermal/omap-bandgap.c @@ -146,7 +146,17 @@ static u32 omap_bandgap_read_temp(struct omap_bandgap *bg_ptr, int id) return temp; } -/* This is the Talert handler. Call it only if HAS(TALERT) is set */ +/** + * omap_bandgap_talert_irq_handler() - handles Temperature alert IRQs + * @irq: IRQ number + * @data: private data (struct omap_bandgap *) + * + * This is the Talert handler. Use it only if bandgap device features + * HAS(TALERT). This handler goes over all sensors and checks their + * conditions and acts accordingly. In case there are events pending, + * it will reset the event mask to wait for the opposite event (next event). + * Every time there is a new event, it will be reported to thermal layer. + */ static irqreturn_t omap_bandgap_talert_irq_handler(int irq, void *data) { struct omap_bandgap *bg_ptr = data;