From: Eduardo Valentin Date: Fri, 15 Mar 2013 12:59:58 +0000 (-0400) Subject: staging: omap-thermal: add documentation for omap_bandgap_power X-Git-Tag: firefly_0821_release~3680^2~674^2~635 X-Git-Url: http://demsky.eecs.uci.edu/git/?a=commitdiff_plain;h=7a556e6a4a8333ea0ddf9cffc9ef42c9a912925d;p=firefly-linux-kernel-4.4.55.git 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 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 ec79ec1cfacc..62a5fb9623b2 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;