diff options
| author | Mark Brown <broonie@opensource.wolfsonmicro.com> | 2011-09-08 19:38:59 +0200 |
|---|---|---|
| committer | Mark Brown <broonie@opensource.wolfsonmicro.com> | 2011-10-07 12:24:14 +0200 |
| commit | c3035a232e87f42b81d8ece1980abd0a2f26d792 (patch) | |
| tree | 9decb46e28290d8ba3044e56c985db90536dc667 /Documentation/power | |
| parent | regulator: Fix some bitrot in the machine driver documentation (diff) | |
| download | linux-c3035a232e87f42b81d8ece1980abd0a2f26d792.tar.xz linux-c3035a232e87f42b81d8ece1980abd0a2f26d792.zip | |
regulator: Clarify documentation for regulator-regulator supplies
The mechanism used for connecting regulators together when one regulator
supplies another wasn't clear as the names being used weren't really tied
together well.
Reported-by: Philip Rakity <prakity@marvell.com>
Signed-off-by: Mark Brown <broonie@opensource.wolfsonmicro.com>
Diffstat (limited to 'Documentation/power')
| -rw-r--r-- | Documentation/power/regulator/machine.txt | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/Documentation/power/regulator/machine.txt b/Documentation/power/regulator/machine.txt index 311c61f2feaa..ce63af0a8e35 100644 --- a/Documentation/power/regulator/machine.txt +++ b/Documentation/power/regulator/machine.txt @@ -43,6 +43,7 @@ to their supply regulator :- static struct regulator_init_data regulator1_data = { .constraints = { + .name = "Regulator-1", .min_uV = 3300000, .max_uV = 3300000, .valid_modes_mask = REGULATOR_MODE_NORMAL, @@ -51,13 +52,19 @@ static struct regulator_init_data regulator1_data = { .consumer_supplies = regulator1_consumers, }; +The name field should be set to something that is usefully descriptive +for the board for configuration of supplies for other regulators and +for use in logging and other diagnostic output. Normally the name +used for the supply rail in the schematic is a good choice. If no +name is provided then the subsystem will choose one. + Regulator-1 supplies power to Regulator-2. This relationship must be registered with the core so that Regulator-1 is also enabled when Consumer A enables its supply (Regulator-2). The supply regulator is set by the supply_regulator -field below:- +field below and co:- static struct regulator_init_data regulator2_data = { - .supply_regulator = "regulator_name", + .supply_regulator = "Regulator-1", .constraints = { .min_uV = 1800000, .max_uV = 2000000, |