regulator: Suggest use of datasheet supply or pin names for consumers
PATCH 1/1 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 <[email protected]>
--- drivers/regulator/core.c | 9 ++++++--- 1 files changed, 6 insertions(+), 3 deletions(-)
drivers/regulator/core.c +6 -3
@@ -925,9 +925,12 @@ overflow_err:* @id: Supply name or regulator ID. * * Returns a struct regulator corresponding to the regulator producer, -* or IS_ERR() condition containing errno. Use of supply names -* configured via regulator_set_device_supply() is strongly -* encouraged. +* or IS_ERR() condition containing errno. +* +* 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) {
Signature · 1 line
1.5.6.5
Liam Girdwood
AppliedQuoted 10 lines · Mark Brown
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 <[email protected]>--- drivers/regulator/core.c | 9 ++++++--- 1 files changed, 6 insertions(+), 3 deletions(-)
Applied.
Thanks
Liam