Re: [PATCH 2/3] dt-bindings:iio:frequency: add admv1014 doc

From: Jonathan Cameron
Date: Sun Jan 09 2022 - 12:40:45 EST


On Mon, 3 Jan 2022 11:22:00 +0200
Antoniu Miclaus <antoniu.miclaus@xxxxxxxxxx> wrote:

binding rather than doc. Yaml is code a well as documentation afterall.

> Add device tree bindings for the ADMV1014 Upconverter.
>
> Signed-off-by: Antoniu Miclaus <antoniu.miclaus@xxxxxxxxxx>
> ---
> .../bindings/iio/frequency/adi,admv1014.yaml | 97 +++++++++++++++++++
> 1 file changed, 97 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/iio/frequency/adi,admv1014.yaml
>
> diff --git a/Documentation/devicetree/bindings/iio/frequency/adi,admv1014.yaml b/Documentation/devicetree/bindings/iio/frequency/adi,admv1014.yaml
> new file mode 100644
> index 000000000000..a3e5e61c8ade
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/frequency/adi,admv1014.yaml
> @@ -0,0 +1,97 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/frequency/adi,admv1014.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: ADMV1014 Microwave Downconverter
> +
> +maintainers:
> + - Antoniu Miclaus <antoniu.miclaus@xxxxxxxxxx>
> +
> +description: |
> + Wideband, microwave downconverter optimized for point to point microwave
> + radio designs operating in the 24 GHz to 44 GHz frequency range.
> +
> + https://www.analog.com/en/products/admv1014.html
> +
> +properties:
> + compatible:
> + enum:
> + - adi,admv1014
> +
> + reg:
> + maxItems: 1
> +
> + spi-max-frequency:
> + maximum: 1000000
> +
> + clocks:
> + description:
> + Definition of the external clock.

Not a particularly helpful way of describing it.
This is the local oscillator input. I'd put the description
in clock-names rather than here as then it's obvious what lo_in
means.

> + minItems: 1
> +
> + clock-names:
> + items:
> + - const: lo_in
> +
> + vcm-supply:
> + description:
> + Analog voltage regulator.

There seem to be a whole load of other VCC_X supplies from the datasheet.
They should all be here.

> +
> + adi,input-mode:
> + description:
> + Select the input mode.
> + iq - in-phase quadrature (I/Q) input
> + if - complex intermediate frequency (IF) input
> + enum: [iq, if]
> +
> + adi,detector-enable:
> + description:
> + Digital Rx Detector Enable. The Square Law Detector output is
> + available at output pin VDET.
> + type: boolean
> +
> + adi,p1db-comp-enable:
> + description:
> + Turn on bits to optimize P1dB.

Expand comp to compensation perhaps as not a totally clear abbreviation.

> + type: boolean
> +
> + adi,quad-se-mode:
> + description:
> + Switch the LO path from differential to single-ended operation.
> + se-neg - Single-Ended Mode, Negative Side Disabled.
> + se-pos - Single-Ended Mode, Positive Side Disabled.
> + diff - Differential Mode.
> + enum: [se-neg, se-pos, diff]
> +
> + '#clock-cells':
> + const: 0
> +
> +required:
> + - compatible
> + - reg
> + - clocks
> + - clock-names
> + - vcm-supply
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + spi {
> + #address-cells = <1>;
> + #size-cells = <0>;
> + admv1014@0{
> + compatible = "adi,admv1014";
> + reg = <0>;
> + spi-max-frequency = <1000000>;
> + clocks = <&admv1014_lo>;
> + clock-names = "lo_in";
> + vcm-supply = <&vcm>;
> + adi,quad-se-mode = "diff";
> + adi,detector-enable;
> + adi,p1db-comp-enable;
> + };
> + };
> +...