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

From: [email-masked] (Lee Jones)
Date: Tue, 28 Jun 2016 07:59:50 +0100

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 <[email-masked]>
> Signed-off-by: Keerthy <[email-masked]>
> ---
>  .../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 at 24 {

Is this label used?

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

[...]

-- 
Lee Jones
Linaro STMicroelectronics Landing Team Lead
Linaro.org ? Open source software for ARM SoCs
Follow Linaro: Facebook | Twitter | Blog