Re: [PATCH v3] dt-bindings: iio: frequency: add adrf6780 doc

[Rob Herring <robh@kernel.org>]

On Thu, Jul 01, 2021 at 05:16:48PM +0300, Antoniu Miclaus wrote:
> Add device tree bindings for the ADRF6780 Upconverter.
> 
> Signed-off-by: Antoniu Miclaus <antoniu.miclaus@analog.com>
> ---
> v3: remove `adi,parity-en` from example after latest changes in v2 
>  .../bindings/iio/frequency/adi,adrf6780.yaml  | 122 ++++++++++++++++++
>  1 file changed, 122 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/frequency/adi,adrf6780.yaml
> 
> diff --git a/Documentation/devicetree/bindings/iio/frequency/adi,adrf6780.yaml b/Documentation/devicetree/bindings/iio/frequency/adi,adrf6780.yaml
> new file mode 100644
> index 000000000000..b191d98bf778
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/frequency/adi,adrf6780.yaml
> @@ -0,0 +1,122 @@
> +# SPDX-License-Identifier: GPL-2.0

Dual license new bindings: (GPL-2.0-only OR BSD-2-Clause)

> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/frequency/adi,adrf6780.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: ADRF6780 Microwave Upconverter
> +
> +maintainers:
> +- Antoniu Miclaus <antoniu.miclaus@analog.com>
> +
> +description: |
> +   wideband, microwave upconverter optimized for point to point microwave

Wideband

> +   radio designs operating in the 5.9 GHz to 23.6 GHz frequency range.

blank line

> +   https://www.analog.com/en/products/adrf6780.html
> +
> +properties:
> +  compatible:
> +    enum:
> +      - adi,adrf6780
> +
> +  reg:
> +    maxItems: 1
> +
> +  spi-max-frequency:
> +    maximum: 1000000
> +
> +  clocks:
> +    description:
> +      Definition of the external clock (see clock/clock-bindings.txt)

Drop the reference.

> +    minItems: 1
> +
> +  clock-names:
> +    description:
> +      Must be "lo_in"

Looks like a constraint...

clock-names:
  items:
    - const: lo_in

> +    maxItems: 1
> +
> +  clock-output-names:
> +    maxItems: 1
> +
> +  adi,vga-buff-en:
> +    description:
> +      VGA Buffer Enable.
> +    type: boolean
> +
> +  adi,lo-buff-en:
> +    description:
> +      LO Buffer Enable.
> +    type: boolean
> +
> +  adi,if-mode-en:
> +    description:
> +      IF Mode Enable.
> +    type: boolean
> +
> +  adi,iq-mode-en:
> +    description:
> +      IQ Mode Enable.
> +    type: boolean
> +
> +  adi,lo-x2-en:
> +    description:
> +      LO x2 Enable.
> +    type: boolean
> +
> +  adi,lo-ppf-en:
> +    description:
> +      LO x1 Enable.
> +    type: boolean
> +
> +  adi,lo-en:
> +    description:
> +      LO Enable.
> +    type: boolean

Do the other adi,lo-* properties depend on this one? If so, add 
'dependencies' schema.

Any other property dependencies or mutual exclusion?

> +
> +  adi,uc-bias-en:
> +    description:
> +      UC Bias Enable.
> +    type: boolean
> +
> +  adi,lo-sideband:
> +    description:
> +      Switch to the Other LO Sideband.
> +    type: boolean
> +
> +  adi,vdet-out-en:
> +    description:
> +      VDET Output Select Enable.
> +    type: boolean
> +

> +  '#address-cells':
> +    const: 1
> +
> +  '#size-cells':
> +    const: 0

No child nodes, what are these for?

> +
> +  '#clock-cells':
> +    const: 0
> +
> +required:
> +- compatible
> +- reg
> +- clocks
> +- clock-names
> +
> +additionalProperties: false
> +
> +examples:
> +- |
> +    spi {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +      adrf6780@0{

space              ^

> +        compatible = "adi,adrf6780";
> +        reg = <0>;
> +        spi-max-frequency = <1000000>;
> +        clocks = <&adrf6780_lo>;
> +        clock-names = "lo_in";
> +      };
> +    };
> +...
> +
> -- 
> 2.32.0
> 
>