linux-iio.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Ardelean, Alexandru" <alexandru.Ardelean@analog.com>
To: "marcus.folkesson@gmail.com" <marcus.folkesson@gmail.com>,
	"kent@minoris.se" <kent@minoris.se>,
	"davem@davemloft.net" <davem@davemloft.net>,
	"gregkh@linuxfoundation.org" <gregkh@linuxfoundation.org>,
	"mark.rutland@arm.com" <mark.rutland@arm.com>,
	"paulmck@linux.ibm.com" <paulmck@linux.ibm.com>,
	"lars@metafoo.de" <lars@metafoo.de>,
	"jic23@kernel.org" <jic23@kernel.org>,
	"knaack.h@gmx.de" <knaack.h@gmx.de>,
	"pmeerw@pmeerw.net" <pmeerw@pmeerw.net>,
	"robh+dt@kernel.org" <robh+dt@kernel.org>,
	"mchehab+samsung@kernel.org" <mchehab+samsung@kernel.org>
Cc: "devicetree@vger.kernel.org" <devicetree@vger.kernel.org>,
	"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
	"linux-iio@vger.kernel.org" <linux-iio@vger.kernel.org>
Subject: Re: [PATCH] dt-bindings: iio: dac: Migrate LTC1660 documentation to yaml
Date: Tue, 5 Nov 2019 06:42:06 +0000	[thread overview]
Message-ID: <00785b238251ad5b2eb3268693bae357a0a94c1b.camel@analog.com> (raw)
In-Reply-To: <20191104174036.3535-1-marcus.folkesson@gmail.com>

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

  reply	other threads:[~2019-11-05  6:42 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-11-04 17:40 [PATCH] dt-bindings: iio: dac: Migrate LTC1660 documentation to yaml Marcus Folkesson
2019-11-05  6:42 ` Ardelean, Alexandru [this message]
2019-11-05  8:14   ` Marcus Folkesson

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=00785b238251ad5b2eb3268693bae357a0a94c1b.camel@analog.com \
    --to=alexandru.ardelean@analog.com \
    --cc=davem@davemloft.net \
    --cc=devicetree@vger.kernel.org \
    --cc=gregkh@linuxfoundation.org \
    --cc=jic23@kernel.org \
    --cc=kent@minoris.se \
    --cc=knaack.h@gmx.de \
    --cc=lars@metafoo.de \
    --cc=linux-iio@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=marcus.folkesson@gmail.com \
    --cc=mark.rutland@arm.com \
    --cc=mchehab+samsung@kernel.org \
    --cc=paulmck@linux.ibm.com \
    --cc=pmeerw@pmeerw.net \
    --cc=robh+dt@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).