[PATCH 1/2] regulator: Fix some bitrot in the machine driver documentation

[PATCH 1/2] regulator: Fix some bitrot in the machine driver documentation

[Mark Brown]

The documentation for the machine driver was rather badly bitrotted,
using pointers to struct device rather than dev_name() to hook up the
consumers. Update to use dev_name().

Reported-by: Philip Rakity <prakity@marvell.com>
Signed-off-by: Mark Brown <broonie@opensource.wolfsonmicro.com>
---
 Documentation/power/regulator/machine.txt |    8 ++++----
 1 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/power/regulator/machine.txt b/Documentation/power/regulator/machine.txt
index b42419b..311c61f 100644
--- a/Documentation/power/regulator/machine.txt
+++ b/Documentation/power/regulator/machine.txt
@@ -16,7 +16,7 @@ initialisation code by creating a struct regulator_consumer_supply for
 each regulator.
 
 struct regulator_consumer_supply {
-	struct device *dev;	/* consumer */
+	const char *dev_name;	/* consumer dev_name() */
 	const char *supply;	/* consumer supply - e.g. "vcc" */
 };
 
@@ -24,13 +24,13 @@ e.g. for the machine above
 
 static struct regulator_consumer_supply regulator1_consumers[] = {
 {
-	.dev	= &platform_consumerB_device.dev,
-	.supply	= "Vcc",
+	.dev_name	= "dev_name(consumer B)",
+	.supply		= "Vcc",
 },};
 
 static struct regulator_consumer_supply regulator2_consumers[] = {
 {
-	.dev	= &platform_consumerA_device.dev,
+	.dev	= "dev_name(consumer A"),
 	.supply	= "Vcc",
 },};
 
-- 
1.7.5.4

[PATCH 2/2] regulator: Clarify documentation for regulator-regulator supplies

[Mark Brown]

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>
---
 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

Re: [PATCH 1/2] regulator: Fix some bitrot in the machine driver documentation

[Philip Rakity]

Resend

Did not make it yet into linux next.


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

> The documentation for the machine driver was rather badly bitrotted,
> using pointers to struct device rather than dev_name() to hook up the
> consumers. Update to use dev_name().
> 
> Reported-by: Philip Rakity <prakity@marvell.com>
> Signed-off-by: Mark Brown <broonie@opensource.wolfsonmicro.com>
> ---
> Documentation/power/regulator/machine.txt |    8 ++++----
> 1 files changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/Documentation/power/regulator/machine.txt b/Documentation/power/regulator/machine.txt
> index b42419b..311c61f 100644
> --- a/Documentation/power/regulator/machine.txt
> +++ b/Documentation/power/regulator/machine.txt
> @@ -16,7 +16,7 @@ initialisation code by creating a struct regulator_consumer_supply for
> each regulator.
> 
> struct regulator_consumer_supply {
> -	struct device *dev;	/* consumer */
> +	const char *dev_name;	/* consumer dev_name() */
> 	const char *supply;	/* consumer supply - e.g. "vcc" */
> };
> 
> @@ -24,13 +24,13 @@ e.g. for the machine above
> 
> static struct regulator_consumer_supply regulator1_consumers[] = {
> {
> -	.dev	= &platform_consumerB_device.dev,
> -	.supply	= "Vcc",
> +	.dev_name	= "dev_name(consumer B)",
> +	.supply		= "Vcc",
> },};
> 
> static struct regulator_consumer_supply regulator2_consumers[] = {
> {
> -	.dev	= &platform_consumerA_device.dev,
> +	.dev	= "dev_name(consumer A"),
> 	.supply	= "Vcc",
> },};
> 
> -- 
> 1.7.5.4
> 

Re: [PATCH 2/2] regulator: Clarify documentation for regulator-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@marvell.com>
> Signed-off-by: Mark Brown <broonie@opensource.wolfsonmicro.com>
> ---
> 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
> 

Re: [PATCH 1/2] regulator: Fix some bitrot in the machine driver documentation

[Mark Brown]

On Wed, Oct 05, 2011 at 06:39:56PM -0700, Philip Rakity wrote:
> 
> Resend
> 
> Did not make it yet into linux next.

Liam has been away for most of the past month unfortunately.