diff mbox series

[4/4] staging: iio: ad9832: add devicetree documentation

Message ID 20190401143807.xlz32drk367ogcxh@smtp.gmail.com (mailing list archive)
State New, archived
Headers show
Series staging: iio: ad9832: use clock framework | expand

Commit Message

Marcelo Schmitt April 1, 2019, 2:38 p.m. UTC
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

Comments

Alexandru Ardelean April 2, 2019, 6:33 a.m. UTC | #1
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
>
Marcelo Schmitt April 2, 2019, 4:36 p.m. UTC | #2
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
> >
diff mbox series

Patch

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>;
+	};