dt-bindings: iio: dac: Migrate LTC1660 documentation to yaml
diff mbox series

Message ID 20191104174036.3535-1-marcus.folkesson@gmail.com
State Superseded
Headers show
Series
  • dt-bindings: iio: dac: Migrate LTC1660 documentation to yaml
Related show

Checks

Context Check Description
robh/dt-meta-schema success
robh/checkpatch warning "total: 1 errors, 1 warnings, 62 lines checked"

Commit Message

Marcus Folkesson Nov. 4, 2019, 5:40 p.m. UTC
Rewrite bindings to use json-schema vocabulary.

Signed-off-by: Marcus Folkesson <marcus.folkesson@gmail.com>
---
 .../bindings/iio/dac/lltc,ltc1660.yaml        | 54 +++++++++++++++++++
 .../devicetree/bindings/iio/dac/ltc1660.txt   | 21 --------
 MAINTAINERS                                   |  2 +-
 3 files changed, 55 insertions(+), 22 deletions(-)
 create mode 100644 Documentation/devicetree/bindings/iio/dac/lltc,ltc1660.yaml
 delete mode 100644 Documentation/devicetree/bindings/iio/dac/ltc1660.txt

Comments

Ardelean, Alexandru Nov. 5, 2019, 6:42 a.m. UTC | #1
On Mon, 2019-11-04 at 18:40 +0100, Marcus Folkesson wrote:
> [External]
> 
> Rewrite bindings to use json-schema vocabulary.

Hey,

Overall looks good.

A few comments inline.
Rob may add more.

> 
> Signed-off-by: Marcus Folkesson <marcus.folkesson@gmail.com>
> ---
>  .../bindings/iio/dac/lltc,ltc1660.yaml        | 54 +++++++++++++++++++
>  .../devicetree/bindings/iio/dac/ltc1660.txt   | 21 --------
>  MAINTAINERS                                   |  2 +-
>  3 files changed, 55 insertions(+), 22 deletions(-)
>  create mode 100644
> Documentation/devicetree/bindings/iio/dac/lltc,ltc1660.yaml
>  delete mode 100644 Documentation/devicetree/bindings/iio/dac/ltc1660.txt
> 
> diff --git a/Documentation/devicetree/bindings/iio/dac/lltc,ltc1660.yaml
> b/Documentation/devicetree/bindings/iio/dac/lltc,ltc1660.yaml
> new file mode 100644
> index 000000000000..1f3136bfffcd
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/dac/lltc,ltc1660.yaml
> @@ -0,0 +1,54 @@
> +# SPDX-License-Identifier: GPL-2.0
> +# Copyright 2019 Marcus Folkesson <marcus.folkesson@gmail.com>
> +%YAML 1.2
> +---
> +$id: "http://devicetree.org/schemas/bindings/iio/dac/lltc,ltc1660.yaml#"
> +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
> +
> +title: Linear Technology Micropower octal 8-Bit and 10-Bit DACs
> +
> +maintainers:
> +  - Marcus Folkesson <marcus.folkesson@gmail.com>
> +
> +description: |
> +  Bindings for the Linear Technology Micropower octal 8-Bit and 10-Bit
> DAC.
> +  Datasheet can be found here: 
> https://www.analog.com/media/en/technical-documentation/data-sheets/166560fa.pdf
> +
> +properties:
> +  compatible:
> +    enum:
> +      - lltc,ltc1660
> +      - lltc,ltc1665
> +
> +  reg:
> +    description: SPI chip select number for the device

You can remove description.
It's a standard property.

> +    maxItems: 1
> +
> +  spi-max-frequency:
> +    description: |
> +      Definition as per Documentation/devicetree/bindings/spi/spi-
> bus.txt.
> +    maximum: 5000000
> +    maxItems: 1

I think you can probably remove `spi-max-frequency` from here.
It's documented in the base SPI schema.

> +
> +  vref-supply:
> +    description: Phandle to the external reference voltage supply.
> +    maxItems: 1
> +
> +required:
> +  - compatible
> +  - reg
> +  - vref-supply
> +
> +examples:
> +  - |
> +    spi {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +  
> +      dac@0 {
> +        compatible = "lltc,ltc1660";
> +        reg = <0>;
> +        spi-max-frequency = <5000000>;
> +        vref-supply = <&vref_reg>;
> +      };
> +    };
> diff --git a/Documentation/devicetree/bindings/iio/dac/ltc1660.txt
> b/Documentation/devicetree/bindings/iio/dac/ltc1660.txt
> deleted file mode 100644
> index c5b5f22d6c64..000000000000
> --- a/Documentation/devicetree/bindings/iio/dac/ltc1660.txt
> +++ /dev/null
> @@ -1,21 +0,0 @@
> -* Linear Technology Micropower octal 8-Bit and 10-Bit DACs
> -
> -Required properties:
> - - compatible: Must be one of the following:
> -		"lltc,ltc1660"
> -		"lltc,ltc1665"
> - - reg: SPI chip select number for the device
> - - vref-supply: Phandle to the voltage reference supply
> -
> -Recommended properties:
> - - spi-max-frequency: Definition as per
> -	 Documentation/devicetree/bindings/spi/spi-bus.txt.
> -	 Max frequency for this chip is 5 MHz.
> -
> -Example:
> -dac@0 {
> -	compatible = "lltc,ltc1660";
> -	reg = <0>;
> -	spi-max-frequency = <5000000>;
> -	vref-supply = <&vref_reg>;
> -};
> diff --git a/MAINTAINERS b/MAINTAINERS
> index fbccc9d450ff..23497d713298 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -9619,7 +9619,7 @@ LTC1660 DAC DRIVER
>  M:	Marcus Folkesson <marcus.folkesson@gmail.com>
>  L:	linux-iio@vger.kernel.org
>  S:	Maintained
> -F:	Documentation/devicetree/bindings/iio/dac/ltc1660.txt
> +F:	Documentation/devicetree/bindings/iio/dac/lltc,ltc1660.yaml
>  F:	drivers/iio/dac/ltc1660.c
>  
>  LTC4261 HARDWARE MONITOR DRIVER
Marcus Folkesson Nov. 5, 2019, 8:14 a.m. UTC | #2
Hi Alexandru,

See comments below.

On Tue, Nov 05, 2019 at 06:42:06AM +0000, Ardelean, Alexandru wrote:
> On Mon, 2019-11-04 at 18:40 +0100, Marcus Folkesson wrote:
> > [External]
> > 
> > Rewrite bindings to use json-schema vocabulary.
> 
> Hey,
> 
> Overall looks good.
> 
> A few comments inline.
> Rob may add more.

Thank you for looking into this!
> 
> > 
> > Signed-off-by: Marcus Folkesson <marcus.folkesson@gmail.com>
> > ---
> >  .../bindings/iio/dac/lltc,ltc1660.yaml        | 54 +++++++++++++++++++
> >  .../devicetree/bindings/iio/dac/ltc1660.txt   | 21 --------
> >  MAINTAINERS                                   |  2 +-
> >  3 files changed, 55 insertions(+), 22 deletions(-)
> >  create mode 100644
> > Documentation/devicetree/bindings/iio/dac/lltc,ltc1660.yaml
> >  delete mode 100644 Documentation/devicetree/bindings/iio/dac/ltc1660.txt
> > 
> > diff --git a/Documentation/devicetree/bindings/iio/dac/lltc,ltc1660.yaml
> > b/Documentation/devicetree/bindings/iio/dac/lltc,ltc1660.yaml
> > new file mode 100644
> > index 000000000000..1f3136bfffcd
> > --- /dev/null
> > +++ b/Documentation/devicetree/bindings/iio/dac/lltc,ltc1660.yaml
> > @@ -0,0 +1,54 @@
> > +# SPDX-License-Identifier: GPL-2.0
> > +# Copyright 2019 Marcus Folkesson <marcus.folkesson@gmail.com>
> > +%YAML 1.2
> > +---
> > +$id: "http://devicetree.org/schemas/bindings/iio/dac/lltc,ltc1660.yaml#"
> > +$schema: "http://devicetree.org/meta-schemas/core.yaml#"
> > +
> > +title: Linear Technology Micropower octal 8-Bit and 10-Bit DACs
> > +
> > +maintainers:
> > +  - Marcus Folkesson <marcus.folkesson@gmail.com>
> > +
> > +description: |
> > +  Bindings for the Linear Technology Micropower octal 8-Bit and 10-Bit
> > DAC.
> > +  Datasheet can be found here: 
> > https://www.analog.com/media/en/technical-documentation/data-sheets/166560fa.pdf
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - lltc,ltc1660
> > +      - lltc,ltc1665
> > +
> > +  reg:
> > +    description: SPI chip select number for the device
> 
> You can remove description.
> It's a standard property.
> 

Ok, I will remove it.

> > +    maxItems: 1
> > +
> > +  spi-max-frequency:
> > +    description: |
> > +      Definition as per Documentation/devicetree/bindings/spi/spi-
> > bus.txt.
> > +    maximum: 5000000
> > +    maxItems: 1
> 
> I think you can probably remove `spi-max-frequency` from here.
> It's documented in the base SPI schema.
> 

Yes it is, and I was not really sure if I should include that property, but
I wanted to somehow document the maximum frequency that the chip can handle as it could be useful information.

> > +
> > +  vref-supply:
> > +    description: Phandle to the external reference voltage supply.
> > +    maxItems: 1
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +  - vref-supply
> > +
> > +examples:
> > +  - |
> > +    spi {
> > +      #address-cells = <1>;
> > +      #size-cells = <0>;
> > +  
> > +      dac@0 {
> > +        compatible = "lltc,ltc1660";
> > +        reg = <0>;
> > +        spi-max-frequency = <5000000>;
> > +        vref-supply = <&vref_reg>;
> > +      };
> > +    };
> > diff --git a/Documentation/devicetree/bindings/iio/dac/ltc1660.txt
> > b/Documentation/devicetree/bindings/iio/dac/ltc1660.txt
> > deleted file mode 100644
> > index c5b5f22d6c64..000000000000
> > --- a/Documentation/devicetree/bindings/iio/dac/ltc1660.txt
> > +++ /dev/null
> > @@ -1,21 +0,0 @@
> > -* Linear Technology Micropower octal 8-Bit and 10-Bit DACs
> > -
> > -Required properties:
> > - - compatible: Must be one of the following:
> > -		"lltc,ltc1660"
> > -		"lltc,ltc1665"
> > - - reg: SPI chip select number for the device
> > - - vref-supply: Phandle to the voltage reference supply
> > -
> > -Recommended properties:
> > - - spi-max-frequency: Definition as per
> > -	 Documentation/devicetree/bindings/spi/spi-bus.txt.
> > -	 Max frequency for this chip is 5 MHz.
> > -
> > -Example:
> > -dac@0 {
> > -	compatible = "lltc,ltc1660";
> > -	reg = <0>;
> > -	spi-max-frequency = <5000000>;
> > -	vref-supply = <&vref_reg>;
> > -};
> > diff --git a/MAINTAINERS b/MAINTAINERS
> > index fbccc9d450ff..23497d713298 100644
> > --- a/MAINTAINERS
> > +++ b/MAINTAINERS
> > @@ -9619,7 +9619,7 @@ LTC1660 DAC DRIVER
> >  M:	Marcus Folkesson <marcus.folkesson@gmail.com>
> >  L:	linux-iio@vger.kernel.org
> >  S:	Maintained
> > -F:	Documentation/devicetree/bindings/iio/dac/ltc1660.txt
> > +F:	Documentation/devicetree/bindings/iio/dac/lltc,ltc1660.yaml
> >  F:	drivers/iio/dac/ltc1660.c
> >  
> >  LTC4261 HARDWARE MONITOR DRIVER

I guess I wait for Robs review until I post a v2.

Thanks,
Marcus Folkesson

Patch
diff mbox series

diff --git a/Documentation/devicetree/bindings/iio/dac/lltc,ltc1660.yaml b/Documentation/devicetree/bindings/iio/dac/lltc,ltc1660.yaml
new file mode 100644
index 000000000000..1f3136bfffcd
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/dac/lltc,ltc1660.yaml
@@ -0,0 +1,54 @@ 
+# SPDX-License-Identifier: GPL-2.0
+# Copyright 2019 Marcus Folkesson <marcus.folkesson@gmail.com>
+%YAML 1.2
+---
+$id: "http://devicetree.org/schemas/bindings/iio/dac/lltc,ltc1660.yaml#"
+$schema: "http://devicetree.org/meta-schemas/core.yaml#"
+
+title: Linear Technology Micropower octal 8-Bit and 10-Bit DACs
+
+maintainers:
+  - Marcus Folkesson <marcus.folkesson@gmail.com>
+
+description: |
+  Bindings for the Linear Technology Micropower octal 8-Bit and 10-Bit DAC.
+  Datasheet can be found here: https://www.analog.com/media/en/technical-documentation/data-sheets/166560fa.pdf
+
+properties:
+  compatible:
+    enum:
+      - lltc,ltc1660
+      - lltc,ltc1665
+
+  reg:
+    description: SPI chip select number for the device
+    maxItems: 1
+
+  spi-max-frequency:
+    description: |
+      Definition as per Documentation/devicetree/bindings/spi/spi-bus.txt.
+    maximum: 5000000
+    maxItems: 1
+
+  vref-supply:
+    description: Phandle to the external reference voltage supply.
+    maxItems: 1
+
+required:
+  - compatible
+  - reg
+  - vref-supply
+
+examples:
+  - |
+    spi {
+      #address-cells = <1>;
+      #size-cells = <0>;
+  
+      dac@0 {
+        compatible = "lltc,ltc1660";
+        reg = <0>;
+        spi-max-frequency = <5000000>;
+        vref-supply = <&vref_reg>;
+      };
+    };
diff --git a/Documentation/devicetree/bindings/iio/dac/ltc1660.txt b/Documentation/devicetree/bindings/iio/dac/ltc1660.txt
deleted file mode 100644
index c5b5f22d6c64..000000000000
--- a/Documentation/devicetree/bindings/iio/dac/ltc1660.txt
+++ /dev/null
@@ -1,21 +0,0 @@ 
-* Linear Technology Micropower octal 8-Bit and 10-Bit DACs
-
-Required properties:
- - compatible: Must be one of the following:
-		"lltc,ltc1660"
-		"lltc,ltc1665"
- - reg: SPI chip select number for the device
- - vref-supply: Phandle to the voltage reference supply
-
-Recommended properties:
- - spi-max-frequency: Definition as per
-	 Documentation/devicetree/bindings/spi/spi-bus.txt.
-	 Max frequency for this chip is 5 MHz.
-
-Example:
-dac@0 {
-	compatible = "lltc,ltc1660";
-	reg = <0>;
-	spi-max-frequency = <5000000>;
-	vref-supply = <&vref_reg>;
-};
diff --git a/MAINTAINERS b/MAINTAINERS
index fbccc9d450ff..23497d713298 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -9619,7 +9619,7 @@  LTC1660 DAC DRIVER
 M:	Marcus Folkesson <marcus.folkesson@gmail.com>
 L:	linux-iio@vger.kernel.org
 S:	Maintained
-F:	Documentation/devicetree/bindings/iio/dac/ltc1660.txt
+F:	Documentation/devicetree/bindings/iio/dac/lltc,ltc1660.yaml
 F:	drivers/iio/dac/ltc1660.c
 
 LTC4261 HARDWARE MONITOR DRIVER