staging: omap-thermal: add documentation for omap_bandgap_power

Document the helper function to turn a bandgap device on and off.

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 08:59:58 -04:00 committed by Greg Kroah-Hartman
parent 3d84e52962
commit 7a556e6a4a
1 changed files with 8 additions and 0 deletions

View File

@ -86,6 +86,14 @@ do { \
omap_bandgap_writel(bg_ptr, r, t->reg); \
} while (0)
/**
* omap_bandgap_power() - controls the power state of a bandgap device
* @bg_ptr: pointer to omap_bandgap structure
* @on: desired power state (1 - on, 0 - off)
*
* Used to power on/off a bandgap device instance. Only used on those
* that features tempsoff bit.
*/
static int omap_bandgap_power(struct omap_bandgap *bg_ptr, bool on)
{
int i;