aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/regulator
diff options
context:
space:
mode:
authorMark Brown <broonie@opensource.wolfsonmicro.com>2009-02-11 10:32:06 -0500
committerLiam Girdwood <lrg@slimlogic.co.uk>2009-03-31 04:56:23 -0400
commitfe203ddfa5451a13589b1c7da9edab80b7fc06d1 (patch)
tree0aef8d612b7276f9b45f0281473407f5a037de94 /drivers/regulator
parent1dd68f01886a2d5cabbbe90b86e82f70917de89c (diff)
regulator: Suggest use of datasheet supply or pin names for consumers
Update the documentation to suggest the use of datasheet names for the supplies requested by regulator consumers. Doing this makes it easier to tie the design for a given platform up with the requirements of the driver for a consumer. Signed-off-by: Mark Brown <broonie@opensource.wolfsonmicro.com> Signed-off-by: Liam Girdwood <lrg@slimlogic.co.uk>
Diffstat (limited to 'drivers/regulator')
-rw-r--r--drivers/regulator/core.c9
1 files changed, 6 insertions, 3 deletions
diff --git a/drivers/regulator/core.c b/drivers/regulator/core.c
index b85e4a9dafcf..d55a25a6fab2 100644
--- a/drivers/regulator/core.c
+++ b/drivers/regulator/core.c
@@ -925,9 +925,12 @@ overflow_err:
925 * @id: Supply name or regulator ID. 925 * @id: Supply name or regulator ID.
926 * 926 *
927 * Returns a struct regulator corresponding to the regulator producer, 927 * Returns a struct regulator corresponding to the regulator producer,
928 * or IS_ERR() condition containing errno. Use of supply names 928 * or IS_ERR() condition containing errno.
929 * configured via regulator_set_device_supply() is strongly 929 *
930 * encouraged. 930 * Use of supply names configured via regulator_set_device_supply() is
931 * strongly encouraged. It is recommended that the supply name used
932 * should match the name used for the supply and/or the relevant
933 * device pins in the datasheet.
931 */ 934 */
932struct regulator *regulator_get(struct device *dev, const char *id) 935struct regulator *regulator_get(struct device *dev, const char *id)
933{ 936{