* [PATCH 4/4] staging: iio: ad9832: add devicetree documentation
@ 2019-04-01 14:38 Marcelo Schmitt
2019-04-02 6:33 ` Alexandru Ardelean
0 siblings, 1 reply; 3+ messages in thread
From: Marcelo Schmitt @ 2019-04-01 14:38 UTC (permalink / raw)
To: lars, Michael.Hennerich, stefan.popa, jic23, knaack.h, pmeerw, gregkh
Cc: linux-iio, devel, linux-kernel, kernel-usp
Add a devicetree documentation for the ad9832 direct digital
synthesizer, waveform generator.
Signed-off-by: Marcelo Schmitt <marcelo.schmitt1@gmail.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"
+
+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
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH 4/4] staging: iio: ad9832: add devicetree documentation
2019-04-01 14:38 [PATCH 4/4] staging: iio: ad9832: add devicetree documentation Marcelo Schmitt
@ 2019-04-02 6:33 ` Alexandru Ardelean
2019-04-02 16:36 ` Marcelo Schmitt
0 siblings, 1 reply; 3+ messages in thread
From: Alexandru Ardelean @ 2019-04-02 6:33 UTC (permalink / raw)
To: Marcelo Schmitt
Cc: lars, Hennerich, Michael, stefan.popa, Jonathan Cameron,
knaack.h, Peter Meerwald-Stadler, gregkh, linux-iio, devel, LKML,
kernel-usp
On Mon, Apr 1, 2019 at 5:38 PM Marcelo Schmitt
<marcelo.schmitt1@gmail.com> wrote:
>
> Add a devicetree documentation for the ad9832 direct digital
> synthesizer, waveform generator.
>
> Signed-off-by: Marcelo Schmitt <marcelo.schmitt1@gmail.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
>
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH 4/4] staging: iio: ad9832: add devicetree documentation
2019-04-02 6:33 ` Alexandru Ardelean
@ 2019-04-02 16:36 ` Marcelo Schmitt
0 siblings, 0 replies; 3+ messages in thread
From: Marcelo Schmitt @ 2019-04-02 16:36 UTC (permalink / raw)
To: Alexandru Ardelean
Cc: lars, Hennerich, Michael, stefan.popa, Jonathan Cameron,
knaack.h, Peter Meerwald-Stadler, gregkh, linux-iio, devel, LKML,
kernel-usp
On 04/02, Alexandru Ardelean wrote:
> On Mon, Apr 1, 2019 at 5:38 PM Marcelo Schmitt
> <marcelo.schmitt1@gmail.com> wrote:
> >
> > Add a devicetree documentation for the ad9832 direct digital
> > synthesizer, waveform generator.
> >
> > Signed-off-by: Marcelo Schmitt <marcelo.schmitt1@gmail.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
> ```
Thanks for the advice. I'll have a look at them.
>
> > +
> > +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
> >
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2019-04-02 16:36 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-04-01 14:38 [PATCH 4/4] staging: iio: ad9832: add devicetree documentation Marcelo Schmitt
2019-04-02 6:33 ` Alexandru Ardelean
2019-04-02 16:36 ` Marcelo Schmitt
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).