diff mbox series

[10/10] dt-bindings:iio:potentiostat:ti,lmp91000: txt to yaml conversion.

Message ID 20201031181242.742301-11-jic23@kernel.org (mailing list archive)
State New
Headers show
Series dt-bindings: iio: conversion of consumer drivers | expand

Commit Message

Jonathan Cameron Oct. 31, 2020, 6:12 p.m. UTC
From: Jonathan Cameron <Jonathan.Cameron@huawei.com>

There were a few parts of the example that did not conform to the
binding description and would not have worked with the Linux driver
as a result.  Fixed them whilst doing this conversion.

Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Cc: Matt Ranostay <matt.ranostay@konsulko.com>
---
 .../bindings/iio/potentiostat/lmp91000.txt    | 33 ---------
 .../iio/potentiostat/ti,lmp91000.yaml         | 68 +++++++++++++++++++
 2 files changed, 68 insertions(+), 33 deletions(-)

Comments

Matt Ranostay Oct. 31, 2020, 9:41 p.m. UTC | #1
On Sat, Oct 31, 2020 at 11:15 AM Jonathan Cameron <jic23@kernel.org> wrote:
>
> From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
>
> There were a few parts of the example that did not conform to the
> binding description and would not have worked with the Linux driver
> as a result.  Fixed them whilst doing this conversion.
>
> Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> Cc: Matt Ranostay <matt.ranostay@konsulko.com>

Acked-by: Matt Ranostay <matt.ranostay@konsulko.com>

> ---
>  .../bindings/iio/potentiostat/lmp91000.txt    | 33 ---------
>  .../iio/potentiostat/ti,lmp91000.yaml         | 68 +++++++++++++++++++
>  2 files changed, 68 insertions(+), 33 deletions(-)
>
> diff --git a/Documentation/devicetree/bindings/iio/potentiostat/lmp91000.txt b/Documentation/devicetree/bindings/iio/potentiostat/lmp91000.txt
> deleted file mode 100644
> index f3ab02b0dd41..000000000000
> --- a/Documentation/devicetree/bindings/iio/potentiostat/lmp91000.txt
> +++ /dev/null
> @@ -1,33 +0,0 @@
> -* Texas Instruments LMP91000 series of potentiostats
> -
> -LMP91000: https://www.ti.com/lit/ds/symlink/lmp91000.pdf
> -LMP91002: https://www.ti.com/lit/ds/symlink/lmp91002.pdf
> -
> -Required properties:
> -
> -  - compatible: should be one of the following:
> -                 "ti,lmp91000"
> -                 "ti,lmp91002"
> -  - reg: the I2C address of the device
> -  - io-channels: the phandle of the iio provider
> -
> -  - ti,external-tia-resistor: if the property ti,tia-gain-ohm is not defined this
> -    needs to be set to signal that an external resistor value is being used.
> -
> -Optional properties:
> -
> -  - ti,tia-gain-ohm: ohm value of the internal resistor for the transimpedance
> -    amplifier. Must be 2750, 3500, 7000, 14000, 35000, 120000, or 350000 ohms.
> -
> -  - ti,rload-ohm: ohm value of the internal resistor load applied to the gas
> -    sensor. Must be 10, 33, 50, or 100 (default) ohms.
> -
> -Example:
> -
> -lmp91000@48 {
> -       compatible = "ti,lmp91000";
> -       reg = <0x48>;
> -       ti,tia-gain-ohm = <7500>;
> -       ti,rload = <100>;
> -       io-channels = <&adc>;
> -};
> diff --git a/Documentation/devicetree/bindings/iio/potentiostat/ti,lmp91000.yaml b/Documentation/devicetree/bindings/iio/potentiostat/ti,lmp91000.yaml
> new file mode 100644
> index 000000000000..e4b5d890e8d5
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/potentiostat/ti,lmp91000.yaml
> @@ -0,0 +1,68 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/potentiostat/ti,lmp91000.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Texas Instruments LMP91000 series of potentiostats with I2C control
> +
> +maintainers:
> +  - Matt Ranostay <matt.ranostay@konsulko.com>
> +
> +description: |
> +  Typically used as a signal conditioner for chemical sensors.
> +  LMP91000: https://www.ti.com/lit/ds/symlink/lmp91000.pdf
> +  LMP91002: https://www.ti.com/lit/ds/symlink/lmp91002.pdf
> +
> +properties:
> +  compatible:
> +    enum:
> +      - ti,lmp91000
> +      - ti,lmp91002
> +
> +  reg:
> +    maxItems: 1
> +
> +  io-channels:
> +    maxItems: 1
> +
> +  ti,external-tia-resistor:
> +    $ref: /schemas/types.yaml#/definitions/flag
> +    description:
> +      If the property ti,tia-gain-ohm is not defined this needs to be set to
> +      signal that an external resistor value is being used.
> +
> +  ti,tia-gain-ohm:
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    enum: [2750, 3500, 7000, 14000, 35000, 120000, 350000]
> +    description:
> +      Internal resistor for the transimpedance amplifier.
> +
> +  ti,rload-ohm:
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +    enum: [10, 33, 50, 100]
> +    description:
> +      Internal resistor load applied to the gas sensor.
> +      Default 100 Ohms.
> +
> +required:
> +  - compatible
> +  - reg
> +  - io-channels
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    i2c {
> +        #address-cells = <1>;
> +        #size-cells = <0>;
> +        lmp91000@48 {
> +            compatible = "ti,lmp91000";
> +            reg = <0x48>;
> +            ti,tia-gain-ohm = <7000>;
> +            ti,rload-ohm = <100>;
> +            io-channels = <&adc>;
> +        };
> +    };
> +...
> --
> 2.28.0
>
Jonathan Cameron Nov. 28, 2020, 5:56 p.m. UTC | #2
On Sat, 31 Oct 2020 14:41:10 -0700
Matt Ranostay <matt.ranostay@konsulko.com> wrote:

> On Sat, Oct 31, 2020 at 11:15 AM Jonathan Cameron <jic23@kernel.org> wrote:
> >
> > From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> >
> > There were a few parts of the example that did not conform to the
> > binding description and would not have worked with the Linux driver
> > as a result.  Fixed them whilst doing this conversion.
> >
> > Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> > Cc: Matt Ranostay <matt.ranostay@konsulko.com>  
> 
> Acked-by: Matt Ranostay <matt.ranostay@konsulko.com>

Note I couldn't drop the type markings for the resistance properties here
because the dt-schema uses ohms and these are ohm.

An unfortunate bit of legacy we'll need to maintain I guess.

Jonathan

> 
> > ---
> >  .../bindings/iio/potentiostat/lmp91000.txt    | 33 ---------
> >  .../iio/potentiostat/ti,lmp91000.yaml         | 68 +++++++++++++++++++
> >  2 files changed, 68 insertions(+), 33 deletions(-)
> >
> > diff --git a/Documentation/devicetree/bindings/iio/potentiostat/lmp91000.txt b/Documentation/devicetree/bindings/iio/potentiostat/lmp91000.txt
> > deleted file mode 100644
> > index f3ab02b0dd41..000000000000
> > --- a/Documentation/devicetree/bindings/iio/potentiostat/lmp91000.txt
> > +++ /dev/null
> > @@ -1,33 +0,0 @@
> > -* Texas Instruments LMP91000 series of potentiostats
> > -
> > -LMP91000: https://www.ti.com/lit/ds/symlink/lmp91000.pdf
> > -LMP91002: https://www.ti.com/lit/ds/symlink/lmp91002.pdf
> > -
> > -Required properties:
> > -
> > -  - compatible: should be one of the following:
> > -                 "ti,lmp91000"
> > -                 "ti,lmp91002"
> > -  - reg: the I2C address of the device
> > -  - io-channels: the phandle of the iio provider
> > -
> > -  - ti,external-tia-resistor: if the property ti,tia-gain-ohm is not defined this
> > -    needs to be set to signal that an external resistor value is being used.
> > -
> > -Optional properties:
> > -
> > -  - ti,tia-gain-ohm: ohm value of the internal resistor for the transimpedance
> > -    amplifier. Must be 2750, 3500, 7000, 14000, 35000, 120000, or 350000 ohms.
> > -
> > -  - ti,rload-ohm: ohm value of the internal resistor load applied to the gas
> > -    sensor. Must be 10, 33, 50, or 100 (default) ohms.
> > -
> > -Example:
> > -
> > -lmp91000@48 {
> > -       compatible = "ti,lmp91000";
> > -       reg = <0x48>;
> > -       ti,tia-gain-ohm = <7500>;
> > -       ti,rload = <100>;
> > -       io-channels = <&adc>;
> > -};
> > diff --git a/Documentation/devicetree/bindings/iio/potentiostat/ti,lmp91000.yaml b/Documentation/devicetree/bindings/iio/potentiostat/ti,lmp91000.yaml
> > new file mode 100644
> > index 000000000000..e4b5d890e8d5
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/iio/potentiostat/ti,lmp91000.yaml
> > @@ -0,0 +1,68 @@
> > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> > +%YAML 1.2
> > +---
> > +$id: http://devicetree.org/schemas/iio/potentiostat/ti,lmp91000.yaml#
> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > +
> > +title: Texas Instruments LMP91000 series of potentiostats with I2C control
> > +
> > +maintainers:
> > +  - Matt Ranostay <matt.ranostay@konsulko.com>
> > +
> > +description: |
> > +  Typically used as a signal conditioner for chemical sensors.
> > +  LMP91000: https://www.ti.com/lit/ds/symlink/lmp91000.pdf
> > +  LMP91002: https://www.ti.com/lit/ds/symlink/lmp91002.pdf
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - ti,lmp91000
> > +      - ti,lmp91002
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  io-channels:
> > +    maxItems: 1
> > +
> > +  ti,external-tia-resistor:
> > +    $ref: /schemas/types.yaml#/definitions/flag
> > +    description:
> > +      If the property ti,tia-gain-ohm is not defined this needs to be set to
> > +      signal that an external resistor value is being used.
> > +
> > +  ti,tia-gain-ohm:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> > +    enum: [2750, 3500, 7000, 14000, 35000, 120000, 350000]
> > +    description:
> > +      Internal resistor for the transimpedance amplifier.
> > +
> > +  ti,rload-ohm:
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> > +    enum: [10, 33, 50, 100]
> > +    description:
> > +      Internal resistor load applied to the gas sensor.
> > +      Default 100 Ohms.
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +  - io-channels
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > +  - |
> > +    i2c {
> > +        #address-cells = <1>;
> > +        #size-cells = <0>;
> > +        lmp91000@48 {
> > +            compatible = "ti,lmp91000";
> > +            reg = <0x48>;
> > +            ti,tia-gain-ohm = <7000>;
> > +            ti,rload-ohm = <100>;
> > +            io-channels = <&adc>;
> > +        };
> > +    };
> > +...
> > --
> > 2.28.0
> >
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iio/potentiostat/lmp91000.txt b/Documentation/devicetree/bindings/iio/potentiostat/lmp91000.txt
deleted file mode 100644
index f3ab02b0dd41..000000000000
--- a/Documentation/devicetree/bindings/iio/potentiostat/lmp91000.txt
+++ /dev/null
@@ -1,33 +0,0 @@ 
-* Texas Instruments LMP91000 series of potentiostats
-
-LMP91000: https://www.ti.com/lit/ds/symlink/lmp91000.pdf
-LMP91002: https://www.ti.com/lit/ds/symlink/lmp91002.pdf
-
-Required properties:
-
-  - compatible: should be one of the following:
-                 "ti,lmp91000"
-                 "ti,lmp91002"
-  - reg: the I2C address of the device
-  - io-channels: the phandle of the iio provider
-
-  - ti,external-tia-resistor: if the property ti,tia-gain-ohm is not defined this
-    needs to be set to signal that an external resistor value is being used.
-
-Optional properties:
-
-  - ti,tia-gain-ohm: ohm value of the internal resistor for the transimpedance
-    amplifier. Must be 2750, 3500, 7000, 14000, 35000, 120000, or 350000 ohms.
-
-  - ti,rload-ohm: ohm value of the internal resistor load applied to the gas
-    sensor. Must be 10, 33, 50, or 100 (default) ohms.
-
-Example:
-
-lmp91000@48 {
-	compatible = "ti,lmp91000";
-	reg = <0x48>;
-	ti,tia-gain-ohm = <7500>;
-	ti,rload = <100>;
-	io-channels = <&adc>;
-};
diff --git a/Documentation/devicetree/bindings/iio/potentiostat/ti,lmp91000.yaml b/Documentation/devicetree/bindings/iio/potentiostat/ti,lmp91000.yaml
new file mode 100644
index 000000000000..e4b5d890e8d5
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/potentiostat/ti,lmp91000.yaml
@@ -0,0 +1,68 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/potentiostat/ti,lmp91000.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Texas Instruments LMP91000 series of potentiostats with I2C control
+
+maintainers:
+  - Matt Ranostay <matt.ranostay@konsulko.com>
+
+description: |
+  Typically used as a signal conditioner for chemical sensors.
+  LMP91000: https://www.ti.com/lit/ds/symlink/lmp91000.pdf
+  LMP91002: https://www.ti.com/lit/ds/symlink/lmp91002.pdf
+
+properties:
+  compatible:
+    enum:
+      - ti,lmp91000
+      - ti,lmp91002
+
+  reg:
+    maxItems: 1
+
+  io-channels:
+    maxItems: 1
+
+  ti,external-tia-resistor:
+    $ref: /schemas/types.yaml#/definitions/flag
+    description:
+      If the property ti,tia-gain-ohm is not defined this needs to be set to
+      signal that an external resistor value is being used.
+
+  ti,tia-gain-ohm:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    enum: [2750, 3500, 7000, 14000, 35000, 120000, 350000]
+    description:
+      Internal resistor for the transimpedance amplifier.
+
+  ti,rload-ohm:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    enum: [10, 33, 50, 100]
+    description:
+      Internal resistor load applied to the gas sensor.
+      Default 100 Ohms.
+
+required:
+  - compatible
+  - reg
+  - io-channels
+
+additionalProperties: false
+
+examples:
+  - |
+    i2c {
+        #address-cells = <1>;
+        #size-cells = <0>;
+        lmp91000@48 {
+            compatible = "ti,lmp91000";
+            reg = <0x48>;
+            ti,tia-gain-ohm = <7000>;
+            ti,rload-ohm = <100>;
+            io-channels = <&adc>;
+        };
+    };
+...