diff mbox

[v3,02/10] Documentation: regulator: tps65218: Update examples

Message ID 1467093980-11458-3-git-send-email-j-keerthy@ti.com
State New
Headers show

Commit Message

J, KEERTHY June 28, 2016, 6:06 a.m. UTC
This updates the device tree according to the preferred way of parsing
the nodes using the regulator framework.

Acked-by: Rob Herring <robh@kernel.org>
Signed-off-by: Keerthy <j-keerthy@ti.com>
---
 .../devicetree/bindings/regulator/tps65218.txt     | 87 ++++++++++++++++++----
 1 file changed, 71 insertions(+), 16 deletions(-)

Comments

Lee Jones June 28, 2016, 6:59 a.m. UTC | #1
This is a more common format for DT bindings:

  dt-bindings: regulator: 

On Tue, 28 Jun 2016, Keerthy wrote:
> This updates the device tree according to the preferred way of parsing

Nit: Device Tree

> the nodes using the regulator framework.
> 
> Acked-by: Rob Herring <robh@kernel.org>
> Signed-off-by: Keerthy <j-keerthy@ti.com>
> ---
>  .../devicetree/bindings/regulator/tps65218.txt     | 87 ++++++++++++++++++----
>  1 file changed, 71 insertions(+), 16 deletions(-)
> 
> diff --git a/Documentation/devicetree/bindings/regulator/tps65218.txt b/Documentation/devicetree/bindings/regulator/tps65218.txt
> index fccc1d2..5e1888f 100644
> --- a/Documentation/devicetree/bindings/regulator/tps65218.txt
> +++ b/Documentation/devicetree/bindings/regulator/tps65218.txt
> @@ -1,23 +1,78 @@
>  TPS65218 family of regulators
>  
>  Required properties:
> -For tps65218 regulators/LDOs
> -- compatible:
> -  - "ti,tps65218-dcdc1" for DCDC1
> -  - "ti,tps65218-dcdc2" for DCDC2
> -  - "ti,tps65218-dcdc3" for DCDC3
> -  - "ti,tps65218-dcdc4" for DCDC4
> -  - "ti,tps65218-dcdc5" for DCDC5
> -  - "ti,tps65218-dcdc6" for DCDC6
> -  - "ti,tps65218-ldo1" for LDO1
> -
> -Optional properties:
> -- Any optional property defined in bindings/regulator/regulator.txt
> +- compatible: "ti,tps65218"
> +- reg: I2C slave address

'\n' here for clarity.

> +- list of regulators provided by this controller, must be named

Sentences start with an uppercase char.

> +  after their hardware counterparts: dcdc[1-6] and ldo1
> +- This is the list of child nodes that specify the regulator
> +  initialization data for defined regulators. Not all regulators for the given
> +  device need to be present. The definition for each of these nodes is defined
> +  using the standard binding for regulators found at
> +  Documentation/devicetree/bindings/regulator/regulator.txt.

Use relative path names for brevity.

./regulator.txt

> +  The valid names for regulators are:
> +  tps65217: regulator-dcdc1, regulator-dcdc2, regulator-dcdc3, regulator-dcdc4,
> +  regulator-dcdc5, regulator-dcdc6, regulator-ldo1, regulator-ls3
> +  Each regulator is defined using the standard binding for regulators.
>  
>  Example:
> +tps65218: tps65218@24 {

Is this label used?

> +	reg = <0x24>;
> +	compatible = "ti,tps65218";
> +	interrupts = <GIC_SPI 7 IRQ_TYPE_NONE>; /* NMIn */
> +	interrupt-controller;
> +	#interrupt-cells = <2>;

[...]
Keerthy June 28, 2016, 7:45 a.m. UTC | #2
On Tuesday 28 June 2016 12:29 PM, Lee Jones wrote:
> This is a more common format for DT bindings:
>
>    dt-bindings: regulator:
>
> On Tue, 28 Jun 2016, Keerthy wrote:
>> This updates the device tree according to the preferred way of parsing
>
> Nit: Device Tree

Okay.

>
>> the nodes using the regulator framework.
>>
>> Acked-by: Rob Herring <robh@kernel.org>
>> Signed-off-by: Keerthy <j-keerthy@ti.com>
>> ---
>>   .../devicetree/bindings/regulator/tps65218.txt     | 87 ++++++++++++++++++----
>>   1 file changed, 71 insertions(+), 16 deletions(-)
>>
>> diff --git a/Documentation/devicetree/bindings/regulator/tps65218.txt b/Documentation/devicetree/bindings/regulator/tps65218.txt
>> index fccc1d2..5e1888f 100644
>> --- a/Documentation/devicetree/bindings/regulator/tps65218.txt
>> +++ b/Documentation/devicetree/bindings/regulator/tps65218.txt
>> @@ -1,23 +1,78 @@
>>   TPS65218 family of regulators
>>
>>   Required properties:
>> -For tps65218 regulators/LDOs
>> -- compatible:
>> -  - "ti,tps65218-dcdc1" for DCDC1
>> -  - "ti,tps65218-dcdc2" for DCDC2
>> -  - "ti,tps65218-dcdc3" for DCDC3
>> -  - "ti,tps65218-dcdc4" for DCDC4
>> -  - "ti,tps65218-dcdc5" for DCDC5
>> -  - "ti,tps65218-dcdc6" for DCDC6
>> -  - "ti,tps65218-ldo1" for LDO1
>> -
>> -Optional properties:
>> -- Any optional property defined in bindings/regulator/regulator.txt
>> +- compatible: "ti,tps65218"
>> +- reg: I2C slave address
>
> '\n' here for clarity.

Okay.

>
>> +- list of regulators provided by this controller, must be named
>
> Sentences start with an uppercase char.

Okay.

>
>> +  after their hardware counterparts: dcdc[1-6] and ldo1
>> +- This is the list of child nodes that specify the regulator
>> +  initialization data for defined regulators. Not all regulators for the given
>> +  device need to be present. The definition for each of these nodes is defined
>> +  using the standard binding for regulators found at
>> +  Documentation/devicetree/bindings/regulator/regulator.txt.
>
> Use relative path names for brevity.

Okay.

>
> ./regulator.txt
>
>> +  The valid names for regulators are:
>> +  tps65217: regulator-dcdc1, regulator-dcdc2, regulator-dcdc3, regulator-dcdc4,
>> +  regulator-dcdc5, regulator-dcdc6, regulator-ldo1, regulator-ls3
>> +  Each regulator is defined using the standard binding for regulators.
>>
>>   Example:
>> +tps65218: tps65218@24 {
>
> Is this label used?

Yes. This can be used in the dts files.

>
>> +	reg = <0x24>;
>> +	compatible = "ti,tps65218";
>> +	interrupts = <GIC_SPI 7 IRQ_TYPE_NONE>; /* NMIn */
>> +	interrupt-controller;
>> +	#interrupt-cells = <2>;
>
> [...]
>
--
To unsubscribe from this list: send the line "unsubscribe linux-gpio" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
diff mbox

Patch

diff --git a/Documentation/devicetree/bindings/regulator/tps65218.txt b/Documentation/devicetree/bindings/regulator/tps65218.txt
index fccc1d2..5e1888f 100644
--- a/Documentation/devicetree/bindings/regulator/tps65218.txt
+++ b/Documentation/devicetree/bindings/regulator/tps65218.txt
@@ -1,23 +1,78 @@ 
 TPS65218 family of regulators
 
 Required properties:
-For tps65218 regulators/LDOs
-- compatible:
-  - "ti,tps65218-dcdc1" for DCDC1
-  - "ti,tps65218-dcdc2" for DCDC2
-  - "ti,tps65218-dcdc3" for DCDC3
-  - "ti,tps65218-dcdc4" for DCDC4
-  - "ti,tps65218-dcdc5" for DCDC5
-  - "ti,tps65218-dcdc6" for DCDC6
-  - "ti,tps65218-ldo1" for LDO1
-
-Optional properties:
-- Any optional property defined in bindings/regulator/regulator.txt
+- compatible: "ti,tps65218"
+- reg: I2C slave address
+- list of regulators provided by this controller, must be named
+  after their hardware counterparts: dcdc[1-6] and ldo1
+- This is the list of child nodes that specify the regulator
+  initialization data for defined regulators. Not all regulators for the given
+  device need to be present. The definition for each of these nodes is defined
+  using the standard binding for regulators found at
+  Documentation/devicetree/bindings/regulator/regulator.txt.
+
+  The valid names for regulators are:
+  tps65217: regulator-dcdc1, regulator-dcdc2, regulator-dcdc3, regulator-dcdc4,
+  regulator-dcdc5, regulator-dcdc6, regulator-ldo1, regulator-ls3
+  Each regulator is defined using the standard binding for regulators.
 
 Example:
+tps65218: tps65218@24 {
+	reg = <0x24>;
+	compatible = "ti,tps65218";
+	interrupts = <GIC_SPI 7 IRQ_TYPE_NONE>; /* NMIn */
+	interrupt-controller;
+	#interrupt-cells = <2>;
+
+	dcdc1: regulator-dcdc1 {
+		regulator-name = "vdd_core";
+		regulator-min-microvolt = <912000>;
+		regulator-max-microvolt = <1144000>;
+		regulator-boot-on;
+		regulator-always-on;
+	};
+
+	dcdc2: regulator-dcdc2 {
+		regulator-name = "vdd_mpu";
+		regulator-min-microvolt = <912000>;
+		regulator-max-microvolt = <1378000>;
+		regulator-boot-on;
+		regulator-always-on;
+	};
+
+	dcdc3: regulator-dcdc3 {
+		regulator-name = "vdcdc3";
+		regulator-min-microvolt = <1500000>;
+		regulator-max-microvolt = <1500000>;
+		regulator-boot-on;
+		regulator-always-on;
+	};
+
+	dcdc5: regulator-dcdc5 {
+		regulator-name = "v1_0bat";
+		regulator-min-microvolt = <1000000>;
+		regulator-max-microvolt = <1000000>;
+		regulator-boot-on;
+		regulator-always-on;
+	};
+
+	dcdc6: regulator-dcdc6 {
+		regulator-name = "v1_8bat";
+		regulator-min-microvolt = <1800000>;
+		regulator-max-microvolt = <1800000>;
+		regulator-boot-on;
+		regulator-always-on;
+	};
+
+	ldo1: regulator-ldo1 {
+		regulator-min-microvolt = <1800000>;
+		regulator-max-microvolt = <1800000>;
+		regulator-boot-on;
+		regulator-always-on;
+	};
 
-	xyz: regulator@0 {
-		compatible = "ti,tps65218-dcdc1";
-		regulator-min-microvolt  = <1000000>;
-		regulator-max-microvolt  = <3000000>;
+	ls3: regulator-ls3 {
+		regulator-min-microvolt = <100000>;
+		regulator-max-microvolt = <1000000>;
 	};
+};