[PATCH v2] Documentation: dtb: lm87: Add hwmon binding documentation.

[PATCH v2] Documentation: dtb: lm87: Add hwmon binding documentation.

[Mahoda Ratnayaka]

This patch adds lm87 hwmon device tree node documentation.

Signed-off-by: Mahoda Ratnayaka <mahoda.ratnayaka@alliedtelesis.co.nz>
---

Notes:
    Changes since v1:
     As suggested include all the changes are moved in
     to the same patch and the all the optional properties
     are now defined instead of using a single variable to
     indicate those properties.

 Documentation/devicetree/bindings/hwmon/lm87.txt | 29 ++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/hwmon/lm87.txt

diff --git a/Documentation/devicetree/bindings/hwmon/lm87.txt b/Documentation/devicetree/bindings/hwmon/lm87.txt
new file mode 100644
index 0000000..ac578fff
--- /dev/null
+++ b/Documentation/devicetree/bindings/hwmon/lm87.txt
@@ -0,0 +1,29 @@
+*LM87 hwmon sensor.
+
+Required properties:
+- compatible: Should be
+	"ti,lm87"
+
+- reg: I2C address
+
+optional properties:
+- has-temp3: This configures pins 18 and 19 to be used as a second
+             remote temperature sensing channel. By default the pins
+             are configured as voltage input pins in0 and in5.
+
+- has-in6: When set, pin 5 is configured to be used as voltage input
+           in6. Otherwise the pin is set as FAN1 input.
+
+- has-in7: When set, pin 6 is configured to be used as voltage input
+           in6. Otherwise the pin is set as FAN2 input.
+
+- has-vcc-5v: sets the nominal voltage for internal VCC measurement to 5V.
+              Default is 3.3V.
+
+Example:
+
+lm87@2e {
+	compatible = "ti,lm87";
+	reg = <0x2e>;
+	has-temp3;
+};
-- 
2.10.0

Re: [PATCH v2] Documentation: dtb: lm87: Add hwmon binding documentation.

[Rob Herring]

On Tue, Oct 04, 2016 at 01:51:23PM +1300, Mahoda Ratnayaka wrote:
> This patch adds lm87 hwmon device tree node documentation.
> 
> Signed-off-by: Mahoda Ratnayaka <mahoda.ratnayaka-6g8wRflRTwXFdCa3tKVlE6U/zSkkHjvu@public.gmane.org>
> ---
> 
> Notes:
>     Changes since v1:
>      As suggested include all the changes are moved in
>      to the same patch and the all the optional properties
>      are now defined instead of using a single variable to
>      indicate those properties.
> 
>  Documentation/devicetree/bindings/hwmon/lm87.txt | 29 ++++++++++++++++++++++++
>  1 file changed, 29 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/hwmon/lm87.txt
> 
> diff --git a/Documentation/devicetree/bindings/hwmon/lm87.txt b/Documentation/devicetree/bindings/hwmon/lm87.txt
> new file mode 100644
> index 0000000..ac578fff
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/hwmon/lm87.txt
> @@ -0,0 +1,29 @@
> +*LM87 hwmon sensor.
> +
> +Required properties:
> +- compatible: Should be
> +	"ti,lm87"
> +
> +- reg: I2C address
> +
> +optional properties:
> +- has-temp3: This configures pins 18 and 19 to be used as a second
> +             remote temperature sensing channel. By default the pins
> +             are configured as voltage input pins in0 and in5.
> +
> +- has-in6: When set, pin 5 is configured to be used as voltage input
> +           in6. Otherwise the pin is set as FAN1 input.
> +
> +- has-in7: When set, pin 6 is configured to be used as voltage input
> +           in6. Otherwise the pin is set as FAN2 input.

Should be in7 ^^^?

These need vendor prefixes. Or would they apply for multiple vendors of 
LM87?

> +
> +- has-vcc-5v: sets the nominal voltage for internal VCC measurement to 5V.
> +              Default is 3.3V.

This is set to what the supply voltage is? If so, use the regulator 
binding.

> +
> +Example:
> +
> +lm87@2e {
> +	compatible = "ti,lm87";
> +	reg = <0x2e>;
> +	has-temp3;
> +};
> -- 
> 2.10.0
> 
--
To unsubscribe from this list: send the line "unsubscribe devicetree" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

Re: [PATCH v2] Documentation: dtb: lm87: Add hwmon binding documentation.

[Mahoda Ratnayaka]

Hi Rob,

Thank you for the comments, I'll address them and send back another patch shortly.

As, for your question about " These need vendor prefixes. Or would they apply for multiple vendors of LM87?"

The driver is shared between the ADM1024 H/W monitoring sensor and LM87 sensor, and both of them have the
same pin configuration for setting the channel mode register.  So, I don't think vendor prefixes are applicable for
this case.

Thanks,
Mahoda
________________________________________
From: Rob Herring <robh@kernel.org>
Sent: Sunday, 9 October 2016 2:29 p.m.
To: Mahoda Ratnayaka
Cc: devicetree@vger.kernel.org; Mark Rutland; linux-hwmon@vger.kernel.org; Chris Packham
Subject: Re: [PATCH v2] Documentation: dtb: lm87: Add hwmon binding documentation.

On Tue, Oct 04, 2016 at 01:51:23PM +1300, Mahoda Ratnayaka wrote:
> This patch adds lm87 hwmon device tree node documentation.
>
> Signed-off-by: Mahoda Ratnayaka <mahoda.ratnayaka@alliedtelesis.co.nz>
> ---
>
> Notes:
>     Changes since v1:
>      As suggested include all the changes are moved in
>      to the same patch and the all the optional properties
>      are now defined instead of using a single variable to
>      indicate those properties.
>
>  Documentation/devicetree/bindings/hwmon/lm87.txt | 29 ++++++++++++++++++++++++
>  1 file changed, 29 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/hwmon/lm87.txt
>
> diff --git a/Documentation/devicetree/bindings/hwmon/lm87.txt b/Documentation/devicetree/bindings/hwmon/lm87.txt
> new file mode 100644
> index 0000000..ac578fff
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/hwmon/lm87.txt
> @@ -0,0 +1,29 @@
> +*LM87 hwmon sensor.
> +
> +Required properties:
> +- compatible: Should be
> +     "ti,lm87"
> +
> +- reg: I2C address
> +
> +optional properties:
> +- has-temp3: This configures pins 18 and 19 to be used as a second
> +             remote temperature sensing channel. By default the pins
> +             are configured as voltage input pins in0 and in5.
> +
> +- has-in6: When set, pin 5 is configured to be used as voltage input
> +           in6. Otherwise the pin is set as FAN1 input.
> +
> +- has-in7: When set, pin 6 is configured to be used as voltage input
> +           in6. Otherwise the pin is set as FAN2 input.

Should be in7 ^^^?

These need vendor prefixes. Or would they apply for multiple vendors of
LM87?

> +
> +- has-vcc-5v: sets the nominal voltage for internal VCC measurement to 5V.
> +              Default is 3.3V.

This is set to what the supply voltage is? If so, use the regulator
binding.

> +
> +Example:
> +
> +lm87@2e {
> +     compatible = "ti,lm87";
> +     reg = <0x2e>;
> +     has-temp3;
> +};
> --
> 2.10.0
>