Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 69c3f723 authored by Stephen Boyd's avatar Stephen Boyd Committed by Mark Brown
Browse files

regulator: Fix regulator_get_{optional,exclusive}() documentation 



regulator_get_optional() doesn't hold an exclusive reference to
the regulator. Fix the documentation and reword the exclusive
documentation to fix the grammatical error "this reference is
held".

Signed-off-by: default avatarStephen Boyd <sboyd@codeaurora.org>
Signed-off-by: default avatarMark Brown <broonie@linaro.org>
parent 36698627

drivers/regulator/core.c

+4 −7
Original line number Diff line number Diff line
@@ -1430,9 +1430,9 @@ EXPORT_SYMBOL_GPL(regulator_get); 
 *

 * Returns a struct regulator corresponding to the regulator producer,

 * or IS_ERR() condition containing errno.  Other consumers will be

 * unable to obtain this reference is held and the use count for the

 * regulator will be initialised to reflect the current state of the

 * regulator.

 * unable to obtain this regulator while this reference is held and the

 * use count for the regulator will be initialised to reflect the current

 * state of the regulator.

 *

 * This is intended for use by consumers which cannot tolerate shared

 * use of the regulator such as those which need to force the
@@ -1456,10 +1456,7 @@ EXPORT_SYMBOL_GPL(regulator_get_exclusive); 
 * @id: Supply name or regulator ID.

 *

 * Returns a struct regulator corresponding to the regulator producer,

 * or IS_ERR() condition containing errno.  Other consumers will be

 * unable to obtain this reference is held and the use count for the

 * regulator will be initialised to reflect the current state of the

 * regulator.

 * or IS_ERR() condition containing errno.

 *

 * This is intended for use by consumers for devices which can have

 * some supplies unconnected in normal use, such as some MMC devices.