diff mbox series

[3/3] dt-bindings: iio: adc: maxim,max9611 yaml conversions

Message ID 20200722171224.989138-4-jic23@kernel.org (mailing list archive)
State New, archived
Headers show
Series dt-bindings: iio: adc: Maxim ADC yaml conversions | expand

Commit Message

Jonathan Cameron July 22, 2020, 5:12 p.m. UTC
From: Jonathan Cameron <Jonathan.Cameron@huawei.com>

Straight forward conversion of this binding for this
current sense amplifier and ADC.

Cc: Jacopo Mondi <jacopo@jmondi.org>
Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
---
 .../devicetree/bindings/iio/adc/max9611.txt   | 27 ----------
 .../bindings/iio/adc/maxim,max9611.yaml       | 49 +++++++++++++++++++
 2 files changed, 49 insertions(+), 27 deletions(-)

Comments

Jacopo Mondi July 23, 2020, 9:30 a.m. UTC | #1
On Wed, Jul 22, 2020 at 06:12:24PM +0100, Jonathan Cameron wrote:
> From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
>
> Straight forward conversion of this binding for this
> current sense amplifier and ADC.
>
> Cc: Jacopo Mondi <jacopo@jmondi.org>
> Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> ---
>  .../devicetree/bindings/iio/adc/max9611.txt   | 27 ----------
>  .../bindings/iio/adc/maxim,max9611.yaml       | 49 +++++++++++++++++++
>  2 files changed, 49 insertions(+), 27 deletions(-)
>
> diff --git a/Documentation/devicetree/bindings/iio/adc/max9611.txt b/Documentation/devicetree/bindings/iio/adc/max9611.txt
> deleted file mode 100644
> index ab4f43145ae5..000000000000
> --- a/Documentation/devicetree/bindings/iio/adc/max9611.txt
> +++ /dev/null
> @@ -1,27 +0,0 @@
> -* Maxim max9611/max9612 current sense amplifier with 12-bits ADC interface
> -
> -Maxim max9611/max9612 is an high-side current sense amplifier with integrated
> -12-bits ADC communicating over I2c bus.
> -The device node for this driver shall be a child of a I2c controller.
> -
> -Required properties
> -  - compatible: Should be "maxim,max9611" or "maxim,max9612"
> -  - reg: The 7-bits long I2c address of the device
> -  - shunt-resistor-micro-ohms: Value, in micro Ohms, of the current sense shunt
> -			        resistor
> -
> -Example:
> -
> -&i2c4 {
> -	csa: adc@7c {
> -		compatible = "maxim,max9611";
> -		reg = <0x7c>;
> -
> -		shunt-resistor-micro-ohms = <5000>;
> -	};
> -};
> -
> -This device node describes a current sense amplifier sitting on I2c4 bus
> -with address 0x7c (read address is 0xf9, write address is 0xf8).
> -A sense resistor of 0,005 Ohm is installed between RS+ and RS- current-sensing
> -inputs.
> diff --git a/Documentation/devicetree/bindings/iio/adc/maxim,max9611.yaml b/Documentation/devicetree/bindings/iio/adc/maxim,max9611.yaml
> new file mode 100644
> index 000000000000..a9fc05e6b62c
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/adc/maxim,max9611.yaml
> @@ -0,0 +1,49 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/adc/maxim,max9611.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Maxim MAX9611 and similar current sense amplifiers with integrated ADCs
> +
> +maintainers:
> +  - Jacopo Mondi <jacopo@jmondi.org>
> +
> +description: |
> +   These devices combine a high-side current sense amplifier with a 12 bit ADC.
> +   They have an i2c interface.
> +
> +properties:
> +  compatible:
> +    enum:
> +      - maxim,max9611
> +      - maxim,max9612
> +
> +  reg:
> +    maxItems: 1
> +
> +  shunt-resistor-micro-ohms:
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    description: |
> +      Value in micro Ohms of the shunt resistor connected between the RS+ and
> +      RS- inputs, across which the current is measured.  Value needed to compute
                                                          ^ Double space
> +      the scaling of the measured current.
> +

With additionalProperties added
Reviewed-by: Jacopo Mondi <jacopo@jmondi.org>

Thanks
  j
> +required:
> +  - compatible
> +  - reg
> +  - shunt-resistor-micro-ohms
> +
> +examples:
> +  - |
> +    i2c {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +
> +        adc@7c {
> +            compatible = "maxim,max9611";
> +            reg = <0x7c>;
> +            shunt-resistor-micro-ohms = <5000>;
> +        };
> +    };
> +...
> --
> 2.27.0
>
Rob Herring July 23, 2020, 9:22 p.m. UTC | #2
On Wed, 22 Jul 2020 18:12:24 +0100, Jonathan Cameron wrote:
> From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> 
> Straight forward conversion of this binding for this
> current sense amplifier and ADC.
> 
> Cc: Jacopo Mondi <jacopo@jmondi.org>
> Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> ---
>  .../devicetree/bindings/iio/adc/max9611.txt   | 27 ----------
>  .../bindings/iio/adc/maxim,max9611.yaml       | 49 +++++++++++++++++++
>  2 files changed, 49 insertions(+), 27 deletions(-)
> 

Reviewed-by: Rob Herring <robh@kernel.org>
Jonathan Cameron Aug. 1, 2020, 4:42 p.m. UTC | #3
On Thu, 23 Jul 2020 15:22:31 -0600
Rob Herring <robh@kernel.org> wrote:

> On Wed, 22 Jul 2020 18:12:24 +0100, Jonathan Cameron wrote:
> > From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> > 
> > Straight forward conversion of this binding for this
> > current sense amplifier and ADC.
> > 
> > Cc: Jacopo Mondi <jacopo@jmondi.org>
> > Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> > ---
> >  .../devicetree/bindings/iio/adc/max9611.txt   | 27 ----------
> >  .../bindings/iio/adc/maxim,max9611.yaml       | 49 +++++++++++++++++++
> >  2 files changed, 49 insertions(+), 27 deletions(-)
> >   
> 
> Reviewed-by: Rob Herring <robh@kernel.org>
Thanks

Applied with additionalProperties line added.

Jonathan
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iio/adc/max9611.txt b/Documentation/devicetree/bindings/iio/adc/max9611.txt
deleted file mode 100644
index ab4f43145ae5..000000000000
--- a/Documentation/devicetree/bindings/iio/adc/max9611.txt
+++ /dev/null
@@ -1,27 +0,0 @@ 
-* Maxim max9611/max9612 current sense amplifier with 12-bits ADC interface
-
-Maxim max9611/max9612 is an high-side current sense amplifier with integrated
-12-bits ADC communicating over I2c bus.
-The device node for this driver shall be a child of a I2c controller.
-
-Required properties
-  - compatible: Should be "maxim,max9611" or "maxim,max9612"
-  - reg: The 7-bits long I2c address of the device
-  - shunt-resistor-micro-ohms: Value, in micro Ohms, of the current sense shunt
-			        resistor
-
-Example:
-
-&i2c4 {
-	csa: adc@7c {
-		compatible = "maxim,max9611";
-		reg = <0x7c>;
-
-		shunt-resistor-micro-ohms = <5000>;
-	};
-};
-
-This device node describes a current sense amplifier sitting on I2c4 bus
-with address 0x7c (read address is 0xf9, write address is 0xf8).
-A sense resistor of 0,005 Ohm is installed between RS+ and RS- current-sensing
-inputs.
diff --git a/Documentation/devicetree/bindings/iio/adc/maxim,max9611.yaml b/Documentation/devicetree/bindings/iio/adc/maxim,max9611.yaml
new file mode 100644
index 000000000000..a9fc05e6b62c
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/adc/maxim,max9611.yaml
@@ -0,0 +1,49 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/adc/maxim,max9611.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Maxim MAX9611 and similar current sense amplifiers with integrated ADCs
+
+maintainers:
+  - Jacopo Mondi <jacopo@jmondi.org>
+
+description: |
+   These devices combine a high-side current sense amplifier with a 12 bit ADC.
+   They have an i2c interface.
+
+properties:
+  compatible:
+    enum:
+      - maxim,max9611
+      - maxim,max9612
+
+  reg:
+    maxItems: 1
+
+  shunt-resistor-micro-ohms:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    description: |
+      Value in micro Ohms of the shunt resistor connected between the RS+ and
+      RS- inputs, across which the current is measured.  Value needed to compute
+      the scaling of the measured current.
+
+required:
+  - compatible
+  - reg
+  - shunt-resistor-micro-ohms
+
+examples:
+  - |
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        adc@7c {
+            compatible = "maxim,max9611";
+            reg = <0x7c>;
+            shunt-resistor-micro-ohms = <5000>;
+        };
+    };
+...