kpriv/linux-hardened
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

regulator: Fix some kerneldoc rendering issues

Browse source 
There are some minor textual changes in here as well, mostly to enable()
and disable() but the primary goal of these changes is to fix
misrenderings of the kerneldoc documentation for the regulator API.

Signed-off-by: Mark Brown <broonie@opensource.wolfsonmicro.com>
Signed-off-by: Liam Girdwood <lrg@slimlogic.co.uk>
This commit is contained in:
Mark Brown 2008-12-31 12:52:43 +00:00 committed by Liam Girdwood
parent c8e7e4640f
commit cf7bbcdf4d
1 changed files with 11 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
drivers/regulator/core.c
View file

@ -1012,10 +1012,12 @@ static int _regulator_enable(struct regulator_dev *rdev)
* regulator_enable - enable regulator output * regulator_enable - enable regulator output
* @regulator: regulator source * @regulator: regulator source
* *
* Enable the regulator output at the predefined voltage or current value. * Request that the regulator be enabled with the regulator output at
* the predefined voltage or current value. Calls to regulator_enable()
* must be balanced with calls to regulator_disable().
*
* NOTE: the output value can be set by other drivers, boot loader or may be * NOTE: the output value can be set by other drivers, boot loader or may be
* hardwired in the regulator. Calls to regulator_enable() must be balanced * hardwired in the regulator.
* with calls to regulator_disable().
*/ */
int regulator_enable(struct regulator *regulator) int regulator_enable(struct regulator *regulator)
{ {
@ -1073,11 +1075,13 @@ static int _regulator_disable(struct regulator_dev *rdev)
* regulator_disable - disable regulator output * regulator_disable - disable regulator output
* @regulator: regulator source * @regulator: regulator source
* *
* Disable the regulator output voltage or current. * Disable the regulator output voltage or current. Calls to
* regulator_enable() must be balanced with calls to
* regulator_disable().
* *
* NOTE: this will only disable the regulator output if no other consumer * NOTE: this will only disable the regulator output if no other consumer
* devices have it enabled. Calls to regulator_enable() must be balanced with * devices have it enabled, the regulator device supports disabling and
* calls to regulator_disable(). * machine constraints permit this operation.
*/ */
int regulator_disable(struct regulator *regulator) int regulator_disable(struct regulator *regulator)
{ {
@ -1936,7 +1940,7 @@ void regulator_unregister(struct regulator_dev *rdev)
EXPORT_SYMBOL_GPL(regulator_unregister); EXPORT_SYMBOL_GPL(regulator_unregister);
/** /**
* regulator_suspend_prepare: prepare regulators for system wide suspend * regulator_suspend_prepare - prepare regulators for system wide suspend
* @state: system suspend state * @state: system suspend state
* *
* Configure each regulator with it's suspend operating parameters for state. * Configure each regulator with it's suspend operating parameters for state.