Re: [PATCH v5 1/4] hwmon: ltc2978: device tree bindings documentation

Mark Rutland
2014-10-03T12:27:46Z

On Thu, Oct 02, 2014 at 07:37:48PM +0100, atull@opensource.altera.com wrote:
> From: Alan Tull <atull@opensource.altera.com>
>
> Add device tree bindings documentation for ltc2978.
>
> Signed-off-by: Alan Tull <atull@opensource.altera.com>
> ---
> v2: clean whitespace
> ---
> .../devicetree/bindings/hwmon/ltc2978.txt | 41 ++++++++++++++++++++
> 1 file changed, 41 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/hwmon/ltc2978.txt
>
> diff --git a/Documentation/devicetree/bindings/hwmon/ltc2978.txt b/Documentation/devicetree/bindings/hwmon/ltc2978.txt
> new file mode 100644
> index 0000000..b2d9c4d
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/hwmon/ltc2978.txt
> @@ -0,0 +1,41 @@
> +ltc2978
> +
> +Required properties:
> + - compatible: one of: ltc2974, ltc2977, ltc2978, ltc3880, ltc3883, ltm4676

Could we please format this like:

- compatible: should contain one of:
* "ltc2974"
* "ltc2977"
* "ltc2978"
* "ltc3880"
* "ltc3883"
* "ltm4676"

Given the file name, are these all variants of ltc2978?

> + - reg: I2C address
> +
> +Optional properties:
> + Name of the optional regulator subnode must be "regulators".
> + - #address-cells must be 1.

What's the single address cell used for?

> + - #size-cells must be 0.
> +
> + For each regulator:
> + - reg: regulator number

Which can be...?

What does this correspond to in the HW?

> + - regulator-compatible: must be vout_en<regulator number> such as vout_en3
> + valid range is:
> + ltc2977, ltc2978 : vout_en0 - vout_en7
> + ltc2974 : vout_en0 - vout_en3
> + ltc3880, ltm4676 : vout_en0 - vout_en1
> + ltc3883 : vout_en0 only

In other bindings I believe I've seen the node name used for this.

Mark, what's the preferred scheme for identifying regulators in a
container node?

> + - regulator-name: arbitrary name for regulator

Drop the 'aribtarary'. Either this should be the name of the regulator
on the board, or it shouldn't be necessary.

Mark.

> +
> +Example:
> +ltc2978@5e {
> + compatible = "ltc2978";
> + reg = <0x5e>;
> + regulators {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + vdacp0_reg: regulator@0 {
> + reg = <0>;
> + regulator-compatible = "vout_en0";
> + regulator-name = "FPGA-2.5V";
> + };
> + vdacp2_reg: regulator@2 {
> + reg = <2>;
> + regulator-compatible = "vout_en2";
> + regulator-name = "FPGA-1.5V";
> + };
> + };
> +};
> --
> 1.7.9.5
>
>