diff mbox series

[v3,3/3] dt-binding: hwmon: Add documentation for ltc2992

Message ID 20201203071155.68859-4-alexandru.tachici@analog.com
State Accepted
Commit fe8c573c89ebfd8ff1fd099704ad4ced1a9dfba9
Headers show
Series None | expand

Commit Message

Alexandru Tachici Dec. 3, 2020, 7:11 a.m. UTC
From: Alexandru Tachici <alexandru.tachici@analog.com>

Add documentation for ltc2992.

Signed-off-by: Alexandru Tachici <alexandru.tachici@analog.com>
---
 .../bindings/hwmon/adi,ltc2992.yaml           | 80 +++++++++++++++++++
 1 file changed, 80 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/hwmon/adi,ltc2992.yaml

Comments

Guenter Roeck Dec. 4, 2020, 3:22 p.m. UTC | #1
On Thu, Dec 03, 2020 at 09:11:55AM +0200, alexandru.tachici@analog.com wrote:
> From: Alexandru Tachici <alexandru.tachici@analog.com>

> 

> Add documentation for ltc2992.

> 

> Signed-off-by: Alexandru Tachici <alexandru.tachici@analog.com>


Side note: You are supposed to keep previous Reviewed-by: tags unless
there was a change.

Applied, with Rob's Reviewed-by: tag added back.

Guenter

> ---

>  .../bindings/hwmon/adi,ltc2992.yaml           | 80 +++++++++++++++++++

>  1 file changed, 80 insertions(+)

>  create mode 100644 Documentation/devicetree/bindings/hwmon/adi,ltc2992.yaml

> 

> diff --git a/Documentation/devicetree/bindings/hwmon/adi,ltc2992.yaml b/Documentation/devicetree/bindings/hwmon/adi,ltc2992.yaml

> new file mode 100644

> index 000000000000..64a8fcb7bc46

> --- /dev/null

> +++ b/Documentation/devicetree/bindings/hwmon/adi,ltc2992.yaml

> @@ -0,0 +1,80 @@

> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)

> +%YAML 1.2

> +---

> +$id: http://devicetree.org/schemas/hwmon/adi,ltc2992.yaml#

> +$schema: http://devicetree.org/meta-schemas/core.yaml#

> +

> +title: Linear Technology 2992 Power Monitor

> +

> +maintainers:

> +  - Alexandru Tachici <alexandru.tachici@analog.com>

> +

> +description: |

> +  Linear Technology 2992 Dual Wide Range Power Monitor

> +  https://www.analog.com/media/en/technical-documentation/data-sheets/ltc2992.pdf

> +

> +properties:

> +  compatible:

> +    enum:

> +      - adi,ltc2992

> +

> +  reg:

> +    maxItems: 1

> +

> +  '#address-cells':

> +    const: 1

> +

> +  '#size-cells':

> +    const: 0

> +

> +  avcc-supply: true

> +

> +patternProperties:

> +  "^channel@([0-1])$":

> +    type: object

> +    description: |

> +      Represents the two supplies to be monitored.

> +

> +    properties:

> +      reg:

> +        description: |

> +          The channel number. LTC2992 can monitor two supplies.

> +        items:

> +          minimum: 0

> +          maximum: 1

> +

> +      shunt-resistor-micro-ohms:

> +        description:

> +          The value of curent sense resistor in microohms.

> +

> +required:

> +  - compatible

> +  - reg

> +

> +additionalProperties: false

> +

> +examples:

> +  - |

> +    i2c1 {

> +        #address-cells = <1>;

> +        #size-cells = <0>;

> +

> +        ltc2992@6F {

> +                #address-cells = <1>;

> +                #size-cells = <0>;

> +

> +                compatible = "adi,ltc2992";

> +                reg = <0x6F>;

> +

> +                channel@0 {

> +                        reg = <0x0>;

> +                        shunt-resistor-micro-ohms = <10000>;

> +                };

> +

> +                channel@1 {

> +                        reg = <0x1>;

> +                        shunt-resistor-micro-ohms = <10000>;

> +                };

> +        };

> +    };

> +...

> -- 

> 2.20.1

>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/hwmon/adi,ltc2992.yaml b/Documentation/devicetree/bindings/hwmon/adi,ltc2992.yaml
new file mode 100644
index 000000000000..64a8fcb7bc46
--- /dev/null
+++ b/Documentation/devicetree/bindings/hwmon/adi,ltc2992.yaml
@@ -0,0 +1,80 @@ 
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/hwmon/adi,ltc2992.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Linear Technology 2992 Power Monitor
+
+maintainers:
+  - Alexandru Tachici <alexandru.tachici@analog.com>
+
+description: |
+  Linear Technology 2992 Dual Wide Range Power Monitor
+  https://www.analog.com/media/en/technical-documentation/data-sheets/ltc2992.pdf
+
+properties:
+  compatible:
+    enum:
+      - adi,ltc2992
+
+  reg:
+    maxItems: 1
+
+  '#address-cells':
+    const: 1
+
+  '#size-cells':
+    const: 0
+
+  avcc-supply: true
+
+patternProperties:
+  "^channel@([0-1])$":
+    type: object
+    description: |
+      Represents the two supplies to be monitored.
+
+    properties:
+      reg:
+        description: |
+          The channel number. LTC2992 can monitor two supplies.
+        items:
+          minimum: 0
+          maximum: 1
+
+      shunt-resistor-micro-ohms:
+        description:
+          The value of curent sense resistor in microohms.
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    i2c1 {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        ltc2992@6F {
+                #address-cells = <1>;
+                #size-cells = <0>;
+
+                compatible = "adi,ltc2992";
+                reg = <0x6F>;
+
+                channel@0 {
+                        reg = <0x0>;
+                        shunt-resistor-micro-ohms = <10000>;
+                };
+
+                channel@1 {
+                        reg = <0x1>;
+                        shunt-resistor-micro-ohms = <10000>;
+                };
+        };
+    };
+...