Re: [PATCH 2/2] regulator: Clarify documentation forregulator-regulator supplies

[Philip Rakity]

Resend.

Did not yet make it into linux next.

On Sep 8, 2011, at 10:41 AM, Mark Brown wrote:

> 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@xxxxxxxxxxx>
> Signed-off-by: Mark Brown <broonie@xxxxxxxxxxxxxxxxxxxxxxxxxxx>
> ---
> 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 311c61f..ce63af0 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,
> -- 
> 1.7.5.4
> 

--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/