diff mbox series

[08/13] dt-bindings: iio: adc: ti,adc12138 yaml conversion.

Message ID 20200809111753.156236-9-jic23@kernel.org
State Superseded
Headers show
Series dt-bindings: yaml conversions of some simple ADC bindings. | expand

Commit Message

Jonathan Cameron Aug. 9, 2020, 11:17 a.m. UTC
From: Jonathan Cameron <Jonathan.Cameron@huawei.com>


Simple binding conversion.  Only addition was #io-channel-cells to
allow for potential consumers of the channels on this device.

Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>

Cc: Akinobu Mita <akinobu.mita@gmail.com>
---
 .../bindings/iio/adc/ti,adc12138.yaml         | 85 +++++++++++++++++++
 .../bindings/iio/adc/ti-adc12138.txt          | 37 --------
 2 files changed, 85 insertions(+), 37 deletions(-)

-- 
2.28.0

Comments

Rob Herring (Arm) Aug. 12, 2020, 4:29 p.m. UTC | #1
On Sun, 09 Aug 2020 12:17:48 +0100, Jonathan Cameron wrote:
> From: Jonathan Cameron <Jonathan.Cameron@huawei.com>

> 

> Simple binding conversion.  Only addition was #io-channel-cells to

> allow for potential consumers of the channels on this device.

> 

> Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>

> Cc: Akinobu Mita <akinobu.mita@gmail.com>

> ---

>  .../bindings/iio/adc/ti,adc12138.yaml         | 85 +++++++++++++++++++

>  .../bindings/iio/adc/ti-adc12138.txt          | 37 --------

>  2 files changed, 85 insertions(+), 37 deletions(-)

> 



My bot found errors running 'make dt_binding_check' on your patch:

Error: Documentation/devicetree/bindings/iio/adc/ti,adc12138.example.dts:26.34-35 syntax error
FATAL ERROR: Unable to parse input tree
make[1]: *** [scripts/Makefile.lib:330: Documentation/devicetree/bindings/iio/adc/ti,adc12138.example.dt.yaml] Error 1
make[1]: *** Waiting for unfinished jobs....
make: *** [Makefile:1334: dt_binding_check] Error 2


See https://patchwork.ozlabs.org/patch/1342594

If you already ran 'make dt_binding_check' and didn't see the above
error(s), then make sure dt-schema is up to date:

pip3 install git+https://github.com/devicetree-org/dt-schema.git@master --upgrade

Please check and re-submit.
Jonathan Cameron Aug. 16, 2020, 9:06 a.m. UTC | #2
On Wed, 12 Aug 2020 10:29:07 -0600
Rob Herring <robh@kernel.org> wrote:

> On Sun, 09 Aug 2020 12:17:48 +0100, Jonathan Cameron wrote:

> > From: Jonathan Cameron <Jonathan.Cameron@huawei.com>

> > 

> > Simple binding conversion.  Only addition was #io-channel-cells to

> > allow for potential consumers of the channels on this device.

> > 

> > Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>

> > Cc: Akinobu Mita <akinobu.mita@gmail.com>

> > ---

> >  .../bindings/iio/adc/ti,adc12138.yaml         | 85 +++++++++++++++++++

> >  .../bindings/iio/adc/ti-adc12138.txt          | 37 --------

> >  2 files changed, 85 insertions(+), 37 deletions(-)

> >   

> 

> 

> My bot found errors running 'make dt_binding_check' on your patch:

> 

> Error: Documentation/devicetree/bindings/iio/adc/ti,adc12138.example.dts:26.34-35 syntax error

> FATAL ERROR: Unable to parse input tree

> make[1]: *** [scripts/Makefile.lib:330: Documentation/devicetree/bindings/iio/adc/ti,adc12138.example.dt.yaml] Error 1

> make[1]: *** Waiting for unfinished jobs....

> make: *** [Makefile:1334: dt_binding_check] Error 2

> 

> 

> See https://patchwork.ozlabs.org/patch/1342594

> 

> If you already ran 'make dt_binding_check' and didn't see the above

> error(s), then make sure dt-schema is up to date:

> 

> pip3 install git+https://github.com/devicetree-org/dt-schema.git@master --upgrade

> 

> Please check and re-submit.

> 

Not sure how I missed this one in testing. It is a missing include.
I don't propose to resend the series though until more comments are in.

Thanks,

Jonathan
Rob Herring Aug. 17, 2020, 2:17 p.m. UTC | #3
On Sun, Aug 9, 2020 at 5:20 AM Jonathan Cameron <jic23@kernel.org> wrote:
>

> From: Jonathan Cameron <Jonathan.Cameron@huawei.com>

>

> Simple binding conversion.  Only addition was #io-channel-cells to

> allow for potential consumers of the channels on this device.

>

> Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>

> Cc: Akinobu Mita <akinobu.mita@gmail.com>

> ---

>  .../bindings/iio/adc/ti,adc12138.yaml         | 85 +++++++++++++++++++

>  .../bindings/iio/adc/ti-adc12138.txt          | 37 --------

>  2 files changed, 85 insertions(+), 37 deletions(-)

>

> diff --git a/Documentation/devicetree/bindings/iio/adc/ti,adc12138.yaml b/Documentation/devicetree/bindings/iio/adc/ti,adc12138.yaml

> new file mode 100644

> index 000000000000..3e8c43aa8ef3

> --- /dev/null

> +++ b/Documentation/devicetree/bindings/iio/adc/ti,adc12138.yaml

> @@ -0,0 +1,85 @@

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

> +%YAML 1.2

> +---

> +$id: http://devicetree.org/schemas/iio/adc/ti,adc12138.yaml#

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

> +

> +title: Texas Instruments ADC12138 and similar self-calibrating ADCs

> +

> +maintainers:

> +  - Akinobu Mita <akinobu.mita@gmail.com>

> +

> +description: |

> +  13 bit ADCs with 1, 2 or 8 inputs and self calibrating circuitry to

> +  correct for linearity, zero and full scale errors.

> +

> +properties:

> +  compatible:

> +    enum:

> +      - ti,adc12130

> +      - ti,adc12132

> +      - ti,adc12138

> +

> +  reg:

> +    maxItems: 1

> +

> +  interrupts:

> +    maxItems: 1

> +    description: End of Conversion (EOC) interrupt

> +

> +  clocks:

> +    maxItems: 1

> +    description: Conversion clock input.

> +

> +  spi-max-frequency: true

> +

> +  vref-p-supply:

> +    description: The regulator supply for positive analog voltage reference

> +

> +  vref-n-suppy:


typo

> +    description: |

> +      The regulator supply for negative analog voltage reference

> +      (Note that this must not go below GND or exceed vref-p)

> +      If not specified, this is assumed to be analog ground.

> +

> +  ti,acquisition-time:

> +    $ref: /schemas/types.yaml#/definitions/uint32

> +    enum: [ 6, 10, 18, 34]


Inconsistent spacing for brackets. 0 or 1 space is fine.

> +    description: |

> +      The number of conversion clock periods for the S/H's acquisition time.

> +      For high source impedances, this value can be increased to 18 or 34.

> +      For less ADC accuracy and/or slower CCLK frequencies this value may be

> +      decreased to 6.  See section 6.0 INPUT SOURCE RESISTANCE in the

> +      datasheet for details.

> +

> +  "#io-channel-cells":

> +    const: 1

> +

> +required:

> +  - compatible

> +  - reg

> +  - interrupts

> +  - clocks

> +  - vref-p-supply

> +

> +additionalProperties: false

> +

> +examples:

> +  - |

> +    spi {

> +        #address-cells = <1>;

> +        #size-cells = <0>;

> +

> +        adc@0 {

> +            compatible = "ti,adc12138";

> +            reg = <0>;

> +            interrupts = <28 IRQ_TYPE_EDGE_RISING>;

> +            interrupt-parent = <&gpio1>;

> +            clocks = <&cclk>;

> +            vref-p-supply = <&ldo4_reg>;

> +            spi-max-frequency = <5000000>;

> +            ti,acquisition-time = <6>;

> +            #io-channel-cells = <1>;

> +        };

> +    };

> +...

> diff --git a/Documentation/devicetree/bindings/iio/adc/ti-adc12138.txt b/Documentation/devicetree/bindings/iio/adc/ti-adc12138.txt

> deleted file mode 100644

> index 049a1d36f013..000000000000

> --- a/Documentation/devicetree/bindings/iio/adc/ti-adc12138.txt

> +++ /dev/null

> @@ -1,37 +0,0 @@

> -* Texas Instruments' ADC12130/ADC12132/ADC12138

> -

> -Required properties:

> - - compatible: Should be one of

> -       * "ti,adc12130"

> -       * "ti,adc12132"

> -       * "ti,adc12138"

> - - reg: SPI chip select number for the device

> - - interrupts: Should contain interrupt for EOC (end of conversion)

> - - clocks: phandle to conversion clock input

> - - spi-max-frequency: Definision as per

> -       Documentation/devicetree/bindings/spi/spi-bus.txt

> - - vref-p-supply: The regulator supply for positive analog voltage reference

> -

> -Optional properties:

> - - vref-n-supply: The regulator supply for negative analog voltage reference

> -       (Note that this must not go below GND or exceed vref-p)

> -       If not specified, this is assumed to be analog ground.

> - - ti,acquisition-time: The number of conversion clock periods for the S/H's

> -       acquisition time.  Should be one of 6, 10, 18, 34.  If not specified,

> -       default value of 10 is used.

> -       For high source impedances, this value can be increased to 18 or 34.

> -       For less ADC accuracy and/or slower CCLK frequencies this value may be

> -       decreased to 6.  See section 6.0 INPUT SOURCE RESISTANCE in the

> -       datasheet for details.

> -

> -Example:

> -adc@0 {

> -       compatible = "ti,adc12138";

> -       reg = <0>;

> -       interrupts = <28 IRQ_TYPE_EDGE_RISING>;

> -       interrupt-parent = <&gpio1>;

> -       clocks = <&cclk>;

> -       vref-p-supply = <&ldo4_reg>;

> -       spi-max-frequency = <5000000>;

> -       ti,acquisition-time = <6>;

> -};

> --

> 2.28.0

>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iio/adc/ti,adc12138.yaml b/Documentation/devicetree/bindings/iio/adc/ti,adc12138.yaml
new file mode 100644
index 000000000000..3e8c43aa8ef3
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/adc/ti,adc12138.yaml
@@ -0,0 +1,85 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/adc/ti,adc12138.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Texas Instruments ADC12138 and similar self-calibrating ADCs
+
+maintainers:
+  - Akinobu Mita <akinobu.mita@gmail.com>
+
+description: |
+  13 bit ADCs with 1, 2 or 8 inputs and self calibrating circuitry to
+  correct for linearity, zero and full scale errors.
+
+properties:
+  compatible:
+    enum:
+      - ti,adc12130
+      - ti,adc12132
+      - ti,adc12138
+
+  reg:
+    maxItems: 1
+
+  interrupts:
+    maxItems: 1
+    description: End of Conversion (EOC) interrupt
+
+  clocks:
+    maxItems: 1
+    description: Conversion clock input.
+
+  spi-max-frequency: true
+
+  vref-p-supply:
+    description: The regulator supply for positive analog voltage reference
+
+  vref-n-suppy:
+    description: |
+      The regulator supply for negative analog voltage reference
+      (Note that this must not go below GND or exceed vref-p)
+      If not specified, this is assumed to be analog ground.
+
+  ti,acquisition-time:
+    $ref: /schemas/types.yaml#/definitions/uint32
+    enum: [ 6, 10, 18, 34]
+    description: |
+      The number of conversion clock periods for the S/H's acquisition time.
+      For high source impedances, this value can be increased to 18 or 34.
+      For less ADC accuracy and/or slower CCLK frequencies this value may be
+      decreased to 6.  See section 6.0 INPUT SOURCE RESISTANCE in the
+      datasheet for details.
+
+  "#io-channel-cells":
+    const: 1
+
+required:
+  - compatible
+  - reg
+  - interrupts
+  - clocks
+  - vref-p-supply
+
+additionalProperties: false
+
+examples:
+  - |
+    spi {
+        #address-cells = <1>;
+        #size-cells = <0>;
+
+        adc@0 {
+            compatible = "ti,adc12138";
+            reg = <0>;
+            interrupts = <28 IRQ_TYPE_EDGE_RISING>;
+            interrupt-parent = <&gpio1>;
+            clocks = <&cclk>;
+            vref-p-supply = <&ldo4_reg>;
+            spi-max-frequency = <5000000>;
+            ti,acquisition-time = <6>;
+            #io-channel-cells = <1>;
+        };
+    };
+...
diff --git a/Documentation/devicetree/bindings/iio/adc/ti-adc12138.txt b/Documentation/devicetree/bindings/iio/adc/ti-adc12138.txt
deleted file mode 100644
index 049a1d36f013..000000000000
--- a/Documentation/devicetree/bindings/iio/adc/ti-adc12138.txt
+++ /dev/null
@@ -1,37 +0,0 @@ 
-* Texas Instruments' ADC12130/ADC12132/ADC12138
-
-Required properties:
- - compatible: Should be one of
-	* "ti,adc12130"
-	* "ti,adc12132"
-	* "ti,adc12138"
- - reg: SPI chip select number for the device
- - interrupts: Should contain interrupt for EOC (end of conversion)
- - clocks: phandle to conversion clock input
- - spi-max-frequency: Definision as per
-	Documentation/devicetree/bindings/spi/spi-bus.txt
- - vref-p-supply: The regulator supply for positive analog voltage reference
-
-Optional properties:
- - vref-n-supply: The regulator supply for negative analog voltage reference
-	(Note that this must not go below GND or exceed vref-p)
-	If not specified, this is assumed to be analog ground.
- - ti,acquisition-time: The number of conversion clock periods for the S/H's
-	acquisition time.  Should be one of 6, 10, 18, 34.  If not specified,
-	default value of 10 is used.
-	For high source impedances, this value can be increased to 18 or 34.
-	For less ADC accuracy and/or slower CCLK frequencies this value may be
-	decreased to 6.  See section 6.0 INPUT SOURCE RESISTANCE in the
-	datasheet for details.
-
-Example:
-adc@0 {
-	compatible = "ti,adc12138";
-	reg = <0>;
-	interrupts = <28 IRQ_TYPE_EDGE_RISING>;
-	interrupt-parent = <&gpio1>;
-	clocks = <&cclk>;
-	vref-p-supply = <&ldo4_reg>;
-	spi-max-frequency = <5000000>;
-	ti,acquisition-time = <6>;
-};