staging: omap-thermal: update documentation for talert irq handler

Document the Talert IRQ handler.

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:01 -04:00 committed by Greg Kroah-Hartman
parent f230427c47
commit ee07d55abb
1 changed files with 11 additions and 1 deletions

View File

@ -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;