diff mbox series

[1/2] dt-bindings: hwmon: ltc2991: add bindings

Message ID 20230926140544.80934-1-antoniu.miclaus@analog.com (mailing list archive)
State Superseded
Headers show
Series [1/2] dt-bindings: hwmon: ltc2991: add bindings | expand

Commit Message

Antoniu Miclaus Sept. 26, 2023, 2:05 p.m. UTC 
Add dt-bindings for ltc2991 octal i2c voltage, current and temperature
monitor.

Signed-off-by: Antoniu Miclaus <antoniu.miclaus@analog.com>
---
 .../bindings/hwmon/adi,ltc2991.yaml           | 114 ++++++++++++++++++
 1 file changed, 114 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/hwmon/adi,ltc2991.yaml

Comments

Conor Dooley Sept. 27, 2023, 3:19 p.m. UTC | #1 
Hi,

On Tue, Sep 26, 2023 at 05:05:29PM +0300, Antoniu Miclaus wrote:
> Add dt-bindings for ltc2991 octal i2c voltage, current and temperature
> monitor.
> 
> Signed-off-by: Antoniu Miclaus <antoniu.miclaus@analog.com>
> ---
>  .../bindings/hwmon/adi,ltc2991.yaml           | 114 ++++++++++++++++++
>  1 file changed, 114 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/hwmon/adi,ltc2991.yaml
> 
> diff --git a/Documentation/devicetree/bindings/hwmon/adi,ltc2991.yaml b/Documentation/devicetree/bindings/hwmon/adi,ltc2991.yaml
> new file mode 100644
> index 000000000000..6174e0113ef8
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/hwmon/adi,ltc2991.yaml
> @@ -0,0 +1,114 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +
> +$id: http://devicetree.org/schemas/hwmon/adi,ltc2991.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Analog Devices LTC2991 Octal I2C Voltage, Current and Temperature Monitor
> +
> +maintainers:
> +  - Antoniu Miclaus <antoniu.miclaus@analog.com>
> +
> +description: |
> +  The LTC2991 is used to monitor system temperatures, voltages and currents.
> +  Through the I2C serial interface, the eight monitors can individually measure
> +  supply voltages and can be paired for differential measurements of current
> +  sense resistors or temperature sensing transistors.
> +
> +  Datasheet:
> +    https://www.analog.com/en/products/ltc2991.html
> +
> +properties:
> +  compatible:
> +    enum:
> +      - adi,ltc2991

if you aren't expecting to add other devices that can share the binding,
make this const: rather than enum:.

> +
> +  reg:
> +    maxItems: 1
> +
> +  '#address-cells':
> +    const: 1
> +
> +  '#size-cells':
> +    const: 0
> +
> +  vcc-supply: true
> +
> +patternProperties:
> +  "^channel@[0-3]$":
> +    type: object
> +    description: |

The |s are only needed when you have formatting to preserve.

> +      Represents the differential/temperature channels.
> +
> +    properties:
> +      reg:
> +        description: |
> +          The channel number. LTC2992 can monitor 4 currents/temperatures.
> +        items:
> +          minimum: 0
> +          maximum: 3
> +
> +      shunt-resistor-mili-ohms:

The standard properties here are ohms and micro-ohms. Also, "milli" has
2 ls.

> +        description:
> +          The value of curent sense resistor in miliohms. Enables differential
> +          input pair.
> +
> +      temperature-enable:

This seems like a vendor property that should have a vendor prefix?

> +        description:
> +          Enables temperature readings for a input pair.

TBH, this seems like it is used just to control software behaviour.
Why would you want to actually disable this in DT?

Cheers,
Conor.

> +
> +required:
> +  - compatible
> +  - reg
> +  - vcc-supply
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    i2c {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        hwmon@48 {
> +            compatible = "adi,ltc2991";
> +            reg = <0x48>;
> +            vcc-supply = <&vcc>;
> +        };
> +    };
> +  - |
> +    i2c {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        hwmon@48 {
> +            #address-cells = <1>;
> +            #size-cells = <0>;
> +
> +            compatible = "adi,ltc2991";
> +            reg = <0x48>;
> +            vcc-supply = <&vcc>;
> +
> +            channel@0 {
> +                    reg = <0x0>;
> +                    shunt-resistor-mili-ohms = <100>;
> +            };
> +
> +            channel@1 {
> +                    reg = <0x1>;
> +                    shunt-resistor-mili-ohms = <100>;
> +            };
> +
> +            channel@2 {
> +                    reg = <0x2>;
> +                    temperature-enable;
> +            };
> +
> +            channel@3 {
> +                    reg = <0x3>;
> +                    temperature-enable;
> +            };
> +        };
> +    };
> +...
> -- 
> 2.42.0
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/hwmon/adi,ltc2991.yaml b/Documentation/devicetree/bindings/hwmon/adi,ltc2991.yaml
new file mode 100644
index 000000000000..6174e0113ef8
--- /dev/null
+++ b/Documentation/devicetree/bindings/hwmon/adi,ltc2991.yaml
@@ -0,0 +1,114 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+
+$id: http://devicetree.org/schemas/hwmon/adi,ltc2991.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Analog Devices LTC2991 Octal I2C Voltage, Current and Temperature Monitor
+
+maintainers:
+  - Antoniu Miclaus <antoniu.miclaus@analog.com>
+
+description: |
+  The LTC2991 is used to monitor system temperatures, voltages and currents.
+  Through the I2C serial interface, the eight monitors can individually measure
+  supply voltages and can be paired for differential measurements of current
+  sense resistors or temperature sensing transistors.
+
+  Datasheet:
+    https://www.analog.com/en/products/ltc2991.html
+
+properties:
+  compatible:
+    enum:
+      - adi,ltc2991
+
+  reg:
+    maxItems: 1
+
+  '#address-cells':
+    const: 1
+
+  '#size-cells':
+    const: 0
+
+  vcc-supply: true
+
+patternProperties:
+  "^channel@[0-3]$":
+    type: object
+    description: |
+      Represents the differential/temperature channels.
+
+    properties:
+      reg:
+        description: |
+          The channel number. LTC2992 can monitor 4 currents/temperatures.
+        items:
+          minimum: 0
+          maximum: 3
+
+      shunt-resistor-mili-ohms:
+        description:
+          The value of curent sense resistor in miliohms. Enables differential
+          input pair.
+
+      temperature-enable:
+        description:
+          Enables temperature readings for a input pair.
+
+required:
+  - compatible
+  - reg
+  - vcc-supply
+
+additionalProperties: false
+
+examples:
+  - |
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        hwmon@48 {
+            compatible = "adi,ltc2991";
+            reg = <0x48>;
+            vcc-supply = <&vcc>;
+        };
+    };
+  - |
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        hwmon@48 {
+            #address-cells = <1>;
+            #size-cells = <0>;
+
+            compatible = "adi,ltc2991";
+            reg = <0x48>;
+            vcc-supply = <&vcc>;
+
+            channel@0 {
+                    reg = <0x0>;
+                    shunt-resistor-mili-ohms = <100>;
+            };
+
+            channel@1 {
+                    reg = <0x1>;
+                    shunt-resistor-mili-ohms = <100>;
+            };
+
+            channel@2 {
+                    reg = <0x2>;
+                    temperature-enable;
+            };
+
+            channel@3 {
+                    reg = <0x3>;
+                    temperature-enable;
+            };
+        };
+    };
+...