Re: [PATCH v5 2/2] dt-bindings: iio: frequency: Add docs for ADF4371 PLL

From: Rob Herring
Date: Tue Jun 11 2019 - 18:04:09 EST


On Tue, Jun 04, 2019 at 04:08:17PM +0300, Stefan Popa wrote:
> Document support for Analog Devices ADF4371 SPI Wideband Synthesizer.
>
> Signed-off-by: Stefan Popa <stefan.popa@xxxxxxxxxx>
> ---
> Changes in v2:
> - Nothing changed.
> Changes in v3:
> - Nothing changed.
> Changes in v4:
> - Nothing changed.
> Changes in v5:
> - Nothing changed.

Please add acks/reviewed-bys when posting new versions.

But something else I noticed:

>
> .../devicetree/bindings/iio/frequency/adf4371.yaml | 54 ++++++++++++++++++++++
> 1 file changed, 54 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/iio/frequency/adf4371.yaml
>
> diff --git a/Documentation/devicetree/bindings/iio/frequency/adf4371.yaml b/Documentation/devicetree/bindings/iio/frequency/adf4371.yaml
> new file mode 100644
> index 0000000..d7adf074
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/frequency/adf4371.yaml
> @@ -0,0 +1,54 @@
> +# SPDX-License-Identifier: GPL-2.0
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/frequency/adf4371.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: Analog Devices ADF4371 Wideband Synthesizer
> +
> +maintainers:
> + - Popa Stefan <stefan.popa@xxxxxxxxxx>
> +
> +description: |
> + Analog Devices ADF4371 SPI Wideband Synthesizer
> + https://www.analog.com/media/en/technical-documentation/data-sheets/adf4371.pdf
> +
> +properties:
> + compatible:
> + enum:
> + - adi,adf4371
> +
> + reg:
> + maxItems: 1
> +
> + clocks:
> + description:
> + Definition of the external clock (see clock/clock-bindings.txt)
> + maxItems: 1
> +
> + clock-names:
> + description:
> + Must be "clkin"

This can be a schema:

clock-names:
items:
- clkin

> + maxItems: 1
> +
> +required:
> + - compatible
> + - reg
> + - clocks
> + - clock-names
> +
> +examples:
> + - |
> + spi0 {
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + frequency@0 {
> + compatible = "adi,adf4371";
> + reg = <0>;
> + spi-max-frequency = <1000000>;
> + clocks = <&adf4371_clkin>;
> + clock-names = "clkin";
> + };
> + };
> +...
> --
> 2.7.4
>