Re: [PATCH 1/2] dt-bindings: iio: frequency: add admfm2000

From: Krzysztof Kozlowski
Date: Thu Nov 16 2023 - 07:08:24 EST


On 16/11/2023 01:56, Kim Seer Paller wrote:
> Dual microwave down converter module with input RF and LO frequency
> ranges from 0.5 to 32 GHz and an output IF frequency range from 0.1 to
> 8 GHz. It consists of a LNA, mixer, IF filter, DSA, and IF amplifier
> for each down conversion path.
>
> Signed-off-by: Kim Seer Paller <kimseer.paller@xxxxxxxxxx>
> ---

...

> +
> +title: ADMFM2000 Dual Microwave Down Converter
> +
> +maintainers:
> + - Kim Seer Paller <kimseer.paller@xxxxxxxxxx>
> +
> +description: |

Do not need '|' unless you need to preserve formatting.

> + Dual microwave down converter module with input RF and LO frequency ranges
> + from 0.5 to 32 GHz and an output IF frequency range from 0.1 to 8 GHz.
> + It consists of a LNA, mixer, IF filter, DSA, and IF amplifier for each down
> + conversion path.
> +
> +properties:
> + compatible:
> + enum:
> + - adi,admfm2000
> +
> + switch1-gpios:
> + description:
> + Must contain an array of 2 GPIO specifiers, referring to the GPIO pins

That's obvious. Instead say which pins are this.

> + connected to the channel 1 switch controls.
> + minItems: 2
> + maxItems: 2
> +
> + switch2-gpios:
> + description:
> + Must contain an array of 2 GPIO specifiers, referring to the GPIO pins
> + connected to the channel 2 switch controls.
> + minItems: 2
> + maxItems: 2
> +
> + attenuation1-gpios:
> + description:
> + Must contain an array of 5 GPIO specifiers, referring to the GPIO pins
> + connected to the channel 1 DSA attenuation controls.
> + minItems: 5
> + maxItems: 5
> +
> + attenuation2-gpios:
> + description:
> + Must contain an array of 5 GPIO specifiers, referring to the GPIO pins
> + connected to the channel 2 DSA attenuation controls.
> + minItems: 5
> + maxItems: 5
> +
> + '#address-cells':
> + const: 1
> +
> + '#size-cells':
> + const: 0
> +
> +patternProperties:
> + "^channel@[0-1]$":
> + type: object
> + description: Represents a channel of the device.

Missing additionalProperties: false. Look at other bindings.

> +
> + properties:
> + reg:
> + description:
> + The channel number.
> + minimum: 0
> + maximum: 1
> +
> + adi,mode:
> + description:
> + RF path selected for the channel.
> + 0 - Direct IF mode
> + 1 - Mixer mode
> + $ref: /schemas/types.yaml#/definitions/uint32
> + enum: [0, 1]
> +
> + required:
> + - reg
> + - adi,mode
> +
> +required:
> + - compatible
> + - switch1-gpios
> + - switch2-gpios
> + - attenuation1-gpios
> + - attenuation2-gpios
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/gpio/gpio.h>
> + admfm2000 {

Node names should be generic. See also an explanation and list of
examples (not exhaustive) in DT specification:
https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#generic-names-recommendation


> + compatible = "adi,admfm2000";
> +
> + switch1-gpios = <&gpio 1 GPIO_ACTIVE_LOW>,
> + <&gpio 2 GPIO_ACTIVE_HIGH>;

Align this with previous <

> +
> + switch2-gpios = <&gpio 3 GPIO_ACTIVE_LOW>,
> + <&gpio 4 GPIO_ACTIVE_HIGH>;
> +
Best regards,
Krzysztof