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

Commit fe203ddf authored by Mark Brown's avatar Mark Brown Committed by Liam Girdwood
Browse files

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: default avatarMark Brown <broonie@opensource.wolfsonmicro.com>
Signed-off-by: default avatarLiam Girdwood <lrg@slimlogic.co.uk>
parent 1dd68f01

drivers/regulator/core.c

+6 −3
Original line number Original line Diff line number Diff line
@@ -925,9 +925,12 @@ static struct regulator *create_regulator(struct regulator_dev *rdev, 
 * @id: Supply name or regulator ID.

 * @id: Supply name or regulator ID.

 *

 *

 * Returns a struct regulator corresponding to the regulator producer,

 * Returns a struct regulator corresponding to the regulator producer,

 * or IS_ERR() condition containing errno.  Use of supply names

 * or IS_ERR() condition containing errno.

 * configured via regulator_set_device_supply() is strongly

 *

 * encouraged.

 * Use of supply names configured via regulator_set_device_supply() is

 * strongly encouraged.  It is recommended that the supply name used

 * should match the name used for the supply and/or the relevant

 * device pins in the datasheet.

 */

 */

struct regulator *regulator_get(struct device *dev, const char *id)

struct regulator *regulator_get(struct device *dev, const char *id)

{

{