[PATCH v4 2/2] hwmon: Add driver for Texas Instruments TMP512/513 sensor chips

[PATCH v4 2/2] hwmon: Add driver for Texas Instruments TMP512/513 sensor chips

[Tremblay, Eric]

dt-bindings: Add TMP512/513 documentation

Add documentation for TMP512/513 sensor chips

Signed-off-by: Eric Tremblay <etremblay@distech-controls.com>
---
 .../devicetree/bindings/hwmon/tmp513.txt      | 32 +++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/hwmon/tmp513.txt

diff --git a/Documentation/devicetree/bindings/hwmon/tmp513.txt b/Documentation/devicetree/bindings/hwmon/tmp513.txt
new file mode 100644
index 000000000000..dbfade74f6b1
--- /dev/null
+++ b/Documentation/devicetree/bindings/hwmon/tmp513.txt
@@ -0,0 +1,32 @@
+TMP513 system monitor sensor
+-------------------------
+
+Require node properties:
+- compatible: one of
+		"ti,tmp512"
+		"ti,tmp513"
+- reg : the I2C address of the device. This is 0x5c, 0x5d, 0x5e, or 0x5f.
+
+Optional properties:
+- shunt-resistor-uohm : The shunt resistor value in uOhm. If 0, the calibration process
+		will be skiped and the current and power measurement engine will not work.
+		Temperature and voltage measurement will continue to work. The shunt value also
+		need to respect : rshunt <= pga-gain * 40 * 1000 * 1000. If not, it's not possible
+		to compute a valid calibration value. Default to 1000 uOhm.
+- pga-gain: The gain value for the PGA function. This is 8, 4, 2 or 1. Default to 8.
+		The PGA gain affect the shunt voltage range.
+		The range will be equal to: pga-gain * 40mV.
+- bus-voltage-range: 32V or 16V, default to 32V.
+- nfactor: u8 array of three(TMP513) or two(TMP512) n-Factor value for each remote
+		temperature channel. Default to 0.
+		See datasheet Table 11 for n-Factor range list and value interpretation.
+
+Example:
+	tmp513@5c {
+		  compatible = "ti,tmp513";
+		  reg = <0x5C>;
+		  shunt-resistor-uohm = <330000>;
+		  bus-voltage-range = <32>;
+		  pga-gain = <8>;
+		  nfactor = [01 F3 00];
+	};
-- 
2.17.1

Re: [PATCH v4 2/2] hwmon: Add driver for Texas Instruments TMP512/513 sensor chips

[Guenter Roeck]

On Mon, Oct 07, 2019 at 08:47:03PM +0000, Tremblay, Eric wrote:
> dt-bindings: Add TMP512/513 documentation
> 
> Add documentation for TMP512/513 sensor chips
> 
Since this is the devicetree documentation, it will need to be approved by
a devicetree maintainer. Wondering why that didn't happen, I just realized
what you did not copy the devicetree mailing list. Please do that when you
resend.

Note that they may require devicetree documentation in yaml format nowadays.

Guenter

> Signed-off-by: Eric Tremblay <etremblay@distech-controls.com>
> ---
>  .../devicetree/bindings/hwmon/tmp513.txt      | 32 +++++++++++++++++++
>  1 file changed, 32 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/hwmon/tmp513.txt
> 
> diff --git a/Documentation/devicetree/bindings/hwmon/tmp513.txt b/Documentation/devicetree/bindings/hwmon/tmp513.txt
> new file mode 100644
> index 000000000000..dbfade74f6b1
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/hwmon/tmp513.txt
> @@ -0,0 +1,32 @@
> +TMP513 system monitor sensor
> +-------------------------
> +
> +Require node properties:
> +- compatible: one of
> +		"ti,tmp512"
> +		"ti,tmp513"
> +- reg : the I2C address of the device. This is 0x5c, 0x5d, 0x5e, or 0x5f.
> +
> +Optional properties:
> +- shunt-resistor-uohm : The shunt resistor value in uOhm. If 0, the calibration process
> +		will be skiped and the current and power measurement engine will not work.
> +		Temperature and voltage measurement will continue to work. The shunt value also
> +		need to respect : rshunt <= pga-gain * 40 * 1000 * 1000. If not, it's not possible
> +		to compute a valid calibration value. Default to 1000 uOhm.
> +- pga-gain: The gain value for the PGA function. This is 8, 4, 2 or 1. Default to 8.
> +		The PGA gain affect the shunt voltage range.
> +		The range will be equal to: pga-gain * 40mV.
> +- bus-voltage-range: 32V or 16V, default to 32V.
> +- nfactor: u8 array of three(TMP513) or two(TMP512) n-Factor value for each remote
> +		temperature channel. Default to 0.
> +		See datasheet Table 11 for n-Factor range list and value interpretation.
> +
> +Example:
> +	tmp513@5c {
> +		  compatible = "ti,tmp513";
> +		  reg = <0x5C>;
> +		  shunt-resistor-uohm = <330000>;
> +		  bus-voltage-range = <32>;
> +		  pga-gain = <8>;
> +		  nfactor = [01 F3 00];
> +	};