diff options
author | Eduardo Valentin <eduardo.valentin@ti.com> | 2013-03-15 12:59:58 (GMT) |
---|---|---|
committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2013-03-15 16:02:09 (GMT) |
commit | 7a556e6a4a8333ea0ddf9cffc9ef42c9a912925d (patch) | |
tree | 4c600daa70d774ffe975e486fd27952338f9809c /drivers/staging/omap-thermal | |
parent | 3d84e52962f1ec1720bf0d7e84d9e3e4b1e35d16 (diff) | |
download | linux-fsl-qoriq-7a556e6a4a8333ea0ddf9cffc9ef42c9a912925d.tar.xz |
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>
Diffstat (limited to 'drivers/staging/omap-thermal')
-rw-r--r-- | drivers/staging/omap-thermal/omap-bandgap.c | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/drivers/staging/omap-thermal/omap-bandgap.c b/drivers/staging/omap-thermal/omap-bandgap.c index ec79ec1..62a5fb9 100644 --- a/drivers/staging/omap-thermal/omap-bandgap.c +++ b/drivers/staging/omap-thermal/omap-bandgap.c @@ -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; |