linux-kernel - Re: [PATCH 4/4] staging: iio: ad9832: add devicetree documentation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <CA+U=Dsq2hAo4DrQOnyVxgqov=UZ8Ch1WmzSrwkMj0zOMLNVFog@mail.gmail.com>
Date:   Tue, 2 Apr 2019 09:33:34 +0300
From:   Alexandru Ardelean <ardeleanalex@...il.com>
To:     Marcelo Schmitt <marcelo.schmitt1@...il.com>
Cc:     lars@...afoo.de,
        "Hennerich, Michael" <Michael.Hennerich@...log.com>,
        stefan.popa@...log.com, Jonathan Cameron <jic23@...nel.org>,
        knaack.h@....de, Peter Meerwald-Stadler <pmeerw@...erw.net>,
        gregkh@...uxfoundation.org, linux-iio@...r.kernel.org,
        devel@...verdev.osuosl.org, LKML <linux-kernel@...r.kernel.org>,
        kernel-usp@...glegroups.com
Subject: Re: [PATCH 4/4] staging: iio: ad9832: add devicetree documentation

On Mon, Apr 1, 2019 at 5:38 PM Marcelo Schmitt
<marcelo.schmitt1@...il.com> wrote:
>
> Add a devicetree documentation for the ad9832 direct digital
> synthesizer, waveform generator.
>
> Signed-off-by: Marcelo Schmitt <marcelo.schmitt1@...il.com>
> ---
>  .../bindings/iio/frequency/ad9832.txt         | 26 +++++++++++++++++++
>  1 file changed, 26 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/frequency/ad9832.txt
>
> diff --git a/Documentation/devicetree/bindings/iio/frequency/ad9832.txt b/Documentation/devicetree/bindings/iio/frequency/ad9832.txt
> new file mode 100644
> index 000000000000..6a35fdff5a48
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/frequency/ad9832.txt
> @@ -0,0 +1,26 @@
> +Analog Devices AD9832 Direct Digital Synthesizer, Waveform Generator
> +
> +Data sheet:
> +https://www.analog.com/media/en/technical-documentation/data-sheets/AD9832.pdf
> +
> +Required properties:
> +       - compatible : Must be "adi,ad9832"
> +       - reg : SPI chip select number for the device
> +       - spi-max-frequency = Max SPI frequency to use (< 25000000)
> +       - clocks : The clock reference for the DDS output
> +       - clock-names : Must be "mclk"

It's always a good idea to reference other base dt docs.
For SPI you could:

```
For more information on SPI properties, please consult
     Documentation/devicetree/bindings/spi/spi-bus.txt
```

For clock:
```
For more information on clock bindings properties, please consult
     Documentation/devicetree/bindings/clock/clock-bindings.txt
```

For regulator:
```
For more information on regulator bindings properties, please consult
     Documentation/devicetree/bindings/regulator/regulator.txt
```

> +
> +Optional properties:
> +       - avdd-supply:  Definition of the regulator used as analog supply
> +       - dvdd-supply : Definition of the regulator used as digital supply
> +
> +Example:
> +       adi9832-dds@0 {
> +               compatible = "adi,ad9832";
> +               reg = <0>;
> +               spi-max-frequency = <25000000>;
> +               clocks = <&ad9832_mclk>;
> +               clock-names = "mclk";
> +               avdd-suppy = <&avdd>;
> +               dvdd-suppy = <&dvdd>;
> +       };
> --
> 2.20.1
>