diff mbox series

[v4,1/2] dt:bindings:iio:frequency: Add ADMV4420 doc

Message ID 20220218095048.86826-1-cristian.pop@analog.com (mailing list archive)
State Superseded
Headers show
Series [v4,1/2] dt:bindings:iio:frequency: Add ADMV4420 doc | expand

Commit Message

Cristian Pop Feb. 18, 2022, 9:50 a.m. UTC
Add device tree bindings for the ADMV4420 K band downconverter.

Signed-off-by: Cristian Pop <cristian.pop@analog.com>
---
 .../bindings/iio/frequency/adi,admv4420.yaml  | 55 +++++++++++++++++++
 1 file changed, 55 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/iio/frequency/adi,admv4420.yaml

Comments

Krzysztof Kozlowski Feb. 18, 2022, 11:43 a.m. UTC | #1
On 18/02/2022 10:50, Cristian Pop wrote:
> Add device tree bindings for the ADMV4420 K band downconverter.

Subject needs fixes. You miss spaces there, incorrect prefix. Use git
log --oneline to get the examples subject style in given subsystem.

> 
> Signed-off-by: Cristian Pop <cristian.pop@analog.com>
> ---
>  .../bindings/iio/frequency/adi,admv4420.yaml  | 55 +++++++++++++++++++
>  1 file changed, 55 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/frequency/adi,admv4420.yaml
> 
> diff --git a/Documentation/devicetree/bindings/iio/frequency/adi,admv4420.yaml b/Documentation/devicetree/bindings/iio/frequency/adi,admv4420.yaml
> new file mode 100644
> index 000000000000..35a3fb3fd339
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/frequency/adi,admv4420.yaml
> @@ -0,0 +1,55 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/frequency/adi,admv4420.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: ADMV4420 K Band Downconverter
> +
> +maintainers:
> +  - Cristian Pop <cristian.pop@analog.com>
> +
> +description:
> +  The ADMV4420 is a highly integrated, double balanced, active
> +  mixer with an integrated fractional-N synthesizer, ideally suited
> +  for next generation K band satellite communications
> +
> +properties:
> +  compatible:
> +    enum:
> +      - adi,admv4420
> +
> +  reg:
> +    maxItems: 1
> +
> +  spi-max-frequency:
> +    maximum: 1000000
> +
> +  adi,lo-freq-khz:
> +    description: LO Frequency
> +    $ref: /schemas/types.yaml#/definitions/uint32

Rob's question from v3 remains unanswered...

> +
> +  adi,ref-ext-single-ended-en:
> +    description: External reference selected.
> +    type: boolean
> +
> +required:
> +  - compatible
> +  - reg
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    spi {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +      admv4420@0 {

Generic node name. It's a kind of plague there... everyone using
specific model as node name.

> +        compatible = "adi,admv4420";
> +        reg = <0>;
> +        spi-max-frequency = <1000000>;
> +        adi,lo-freq-khz = <16750000>;
> +        adi,ref-ext-single-ended-en;
> +      };
> +    };
> +...


Best regards,
Krzysztof
Jonathan Cameron Feb. 18, 2022, 12:03 p.m. UTC | #2
On Fri, 18 Feb 2022 11:50:47 +0200
Cristian Pop <cristian.pop@analog.com> wrote:

> Add device tree bindings for the ADMV4420 K band downconverter.
> 
> Signed-off-by: Cristian Pop <cristian.pop@analog.com>
> ---

Change log?  Also, looks like this crossed with a question from
Rob on v3.

Thanks,

Jonathan


>  .../bindings/iio/frequency/adi,admv4420.yaml  | 55 +++++++++++++++++++
>  1 file changed, 55 insertions(+)
>  create mode 100644 Documentation/devicetree/bindings/iio/frequency/adi,admv4420.yaml
> 
> diff --git a/Documentation/devicetree/bindings/iio/frequency/adi,admv4420.yaml b/Documentation/devicetree/bindings/iio/frequency/adi,admv4420.yaml
> new file mode 100644
> index 000000000000..35a3fb3fd339
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/frequency/adi,admv4420.yaml
> @@ -0,0 +1,55 @@
> +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/frequency/adi,admv4420.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: ADMV4420 K Band Downconverter
> +
> +maintainers:
> +  - Cristian Pop <cristian.pop@analog.com>
> +
> +description:
> +  The ADMV4420 is a highly integrated, double balanced, active
> +  mixer with an integrated fractional-N synthesizer, ideally suited
> +  for next generation K band satellite communications
> +
> +properties:
> +  compatible:
> +    enum:
> +      - adi,admv4420
> +
> +  reg:
> +    maxItems: 1
> +
> +  spi-max-frequency:
> +    maximum: 1000000
> +
> +  adi,lo-freq-khz:
> +    description: LO Frequency
> +    $ref: /schemas/types.yaml#/definitions/uint32
> +
> +  adi,ref-ext-single-ended-en:
> +    description: External reference selected.
> +    type: boolean
> +
> +required:
> +  - compatible
> +  - reg
> +
> +additionalProperties: false
> +
> +examples:
> +  - |
> +    spi {
> +      #address-cells = <1>;
> +      #size-cells = <0>;
> +      admv4420@0 {
> +        compatible = "adi,admv4420";
> +        reg = <0>;
> +        spi-max-frequency = <1000000>;
> +        adi,lo-freq-khz = <16750000>;
> +        adi,ref-ext-single-ended-en;
> +      };
> +    };
> +...
Cristian Pop Feb. 18, 2022, 2:48 p.m. UTC | #3
> -----Original Message-----
> From: Jonathan Cameron <jic23@kernel.org>
> Sent: Friday, February 18, 2022 2:04 PM
> To: Pop, Cristian <Cristian.Pop@analog.com>
> Cc: linux-iio@vger.kernel.org; linux-kernel@vger.kernel.org;
> devicetree@vger.kernel.org; robh+dt@kernel.org
> Subject: Re: [PATCH v4 1/2] dt:bindings:iio:frequency: Add ADMV4420 doc
> 
> [External]
> 
> On Fri, 18 Feb 2022 11:50:47 +0200
> Cristian Pop <cristian.pop@analog.com> wrote:
> 
> > Add device tree bindings for the ADMV4420 K band downconverter.
> >
> > Signed-off-by: Cristian Pop <cristian.pop@analog.com>
> > ---
> 
> Change log?  Also, looks like this crossed with a question from Rob on v3.
> 
In v3 there was a small change only, which I forgot to mention:
 - Add '$ref: /schemas/types.yaml#/definitions/uint32', for 'adi,lo-freq-khz'
Robs question on v3: '-khz is not a documented unit suffix. Does neither hz nor mhz not give enough resolution and range?'
The 32bit values in case we use ' -hz' property suffix, wont accommodate 17.5GHz for example.
For '-mhz' suffix, resolution is not good enough. 
I propose adding reference type '$ref: /schemas/types.yaml#/definitions/uint32' for '-khz' suffix.

> Thanks,
> 
> Jonathan
> 
> 
> >  .../bindings/iio/frequency/adi,admv4420.yaml  | 55
> > +++++++++++++++++++
> >  1 file changed, 55 insertions(+)
> >  create mode 100644
> > Documentation/devicetree/bindings/iio/frequency/adi,admv4420.yaml
> >
> > diff --git
> > a/Documentation/devicetree/bindings/iio/frequency/adi,admv4420.yaml
> > b/Documentation/devicetree/bindings/iio/frequency/adi,admv4420.yaml
> > new file mode 100644
> > index 000000000000..35a3fb3fd339
> > --- /dev/null
> > +++
> b/Documentation/devicetree/bindings/iio/frequency/adi,admv4420.yam
> > +++ l
> > @@ -0,0 +1,55 @@
> > +# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause) %YAML 1.2
> > +---
> > +$id:
> >
> +https://urldefense.com/v3/__http://devicetree.org/schemas/iio/frequen
> > +cy/adi,admv4420.yaml*__;Iw!!A3Ni8CS0y2Y!p1wBxz-
> QqJYCDNk3gYSMGaJoHbPGC
> > +RWOE04vh6kN2kHC84mPrBdIq_Pf1CgD3Z8knw$
> > +$schema:
> > +https://urldefense.com/v3/__http://devicetree.org/meta-
> schemas/core.y
> > +aml*__;Iw!!A3Ni8CS0y2Y!p1wBxz-
> QqJYCDNk3gYSMGaJoHbPGCRWOE04vh6kN2kHC84
> > +mPrBdIq_Pf1CiGygmUGw$
> > +
> > +title: ADMV4420 K Band Downconverter
> > +
> > +maintainers:
> > +  - Cristian Pop <cristian.pop@analog.com>
> > +
> > +description:
> > +  The ADMV4420 is a highly integrated, double balanced, active
> > +  mixer with an integrated fractional-N synthesizer, ideally suited
> > +  for next generation K band satellite communications
> > +
> > +properties:
> > +  compatible:
> > +    enum:
> > +      - adi,admv4420
> > +
> > +  reg:
> > +    maxItems: 1
> > +
> > +  spi-max-frequency:
> > +    maximum: 1000000
> > +
> > +  adi,lo-freq-khz:
> > +    description: LO Frequency
> > +    $ref: /schemas/types.yaml#/definitions/uint32
> > +
> > +  adi,ref-ext-single-ended-en:
> > +    description: External reference selected.
> > +    type: boolean
> > +
> > +required:
> > +  - compatible
> > +  - reg
> > +
> > +additionalProperties: false
> > +
> > +examples:
> > +  - |
> > +    spi {
> > +      #address-cells = <1>;
> > +      #size-cells = <0>;
> > +      admv4420@0 {
> > +        compatible = "adi,admv4420";
> > +        reg = <0>;
> > +        spi-max-frequency = <1000000>;
> > +        adi,lo-freq-khz = <16750000>;
> > +        adi,ref-ext-single-ended-en;
> > +      };
> > +    };
> > +...
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iio/frequency/adi,admv4420.yaml b/Documentation/devicetree/bindings/iio/frequency/adi,admv4420.yaml
new file mode 100644
index 000000000000..35a3fb3fd339
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/frequency/adi,admv4420.yaml
@@ -0,0 +1,55 @@ 
+# SPDX-License-Identifier: (GPL-2.0 OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/frequency/adi,admv4420.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: ADMV4420 K Band Downconverter
+
+maintainers:
+  - Cristian Pop <cristian.pop@analog.com>
+
+description:
+  The ADMV4420 is a highly integrated, double balanced, active
+  mixer with an integrated fractional-N synthesizer, ideally suited
+  for next generation K band satellite communications
+
+properties:
+  compatible:
+    enum:
+      - adi,admv4420
+
+  reg:
+    maxItems: 1
+
+  spi-max-frequency:
+    maximum: 1000000
+
+  adi,lo-freq-khz:
+    description: LO Frequency
+    $ref: /schemas/types.yaml#/definitions/uint32
+
+  adi,ref-ext-single-ended-en:
+    description: External reference selected.
+    type: boolean
+
+required:
+  - compatible
+  - reg
+
+additionalProperties: false
+
+examples:
+  - |
+    spi {
+      #address-cells = <1>;
+      #size-cells = <0>;
+      admv4420@0 {
+        compatible = "adi,admv4420";
+        reg = <0>;
+        spi-max-frequency = <1000000>;
+        adi,lo-freq-khz = <16750000>;
+        adi,ref-ext-single-ended-en;
+      };
+    };
+...