Received-SPF: pass (google.com: domain of linux-kernel+bounces-30892-linux.lists.archive=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99;
Message-ID: <0f32caa9a11305333f1f18b97c97d775f4a5bb9a.camel@gmail.com>
Subject: Re: [PATCH v6 1/2] dt-bindings: iio: frequency: add admfm2000
From: Nuno =?ISO-8859-1?Q?S=E1?= <noname.nuno@gmail.com>
To: "Paller, Kim Seer" <KimSeer.Paller@analog.com>, Conor Dooley
	 <conor@kernel.org>
Cc: "linux-iio@vger.kernel.org" <linux-iio@vger.kernel.org>, 
 "devicetree@vger.kernel.org" <devicetree@vger.kernel.org>,
 "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>, Jonathan
 Cameron <jic23@kernel.org>,  Lars-Peter Clausen <lars@metafoo.de>,
 "Hennerich, Michael" <Michael.Hennerich@analog.com>, Rob Herring
 <robh+dt@kernel.org>, Krzysztof Kozlowski
 <krzysztof.kozlowski+dt@linaro.org>, Conor Dooley <conor+dt@kernel.org>,
 Crt Mori <cmo@melexis.com>, Linus Walleij <linus.walleij@linaro.org>, 
 Bartosz Golaszewski <brgl@bgdev.pl>
Date: Fri, 19 Jan 2024 09:20:01 +0100
In-Reply-To: <PH0PR03MB71410860593D3C7253B200FCF9702@PH0PR03MB7141.namprd03.prod.outlook.com>
References: <20240118085856.70758-1-kimseer.paller@analog.com>
	 <20240118085856.70758-2-kimseer.paller@analog.com>
	 <20240118-steadily-coauthor-de8275118901@spud>
	 <PH0PR03MB71410860593D3C7253B200FCF9702@PH0PR03MB7141.namprd03.prod.outlook.com>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
User-Agent: Evolution 3.50.3 (3.50.3-1.fc39) 
Precedence: bulk
MIME-Version: 1.0

Hi Kim,

On Fri, 2024-01-19 at 00:30 +0000, Paller, Kim Seer wrote:
> > -----Original Message-----
> > From: Conor Dooley <conor@kernel.org>
> > Sent: Friday, January 19, 2024 12:10 AM
> > To: Paller, Kim Seer <KimSeer.Paller@analog.com>
> > Cc: linux-iio@vger.kernel.org; devicetree@vger.kernel.org; linux-
> > kernel@vger.kernel.org; Jonathan Cameron <jic23@kernel.org>; Lars-Peter
> > Clausen <lars@metafoo.de>; Hennerich, Michael
> > <Michael.Hennerich@analog.com>; Rob Herring <robh+dt@kernel.org>;
> > Krzysztof Kozlowski <krzysztof.kozlowski+dt@linaro.org>; Conor Dooley
> > <conor+dt@kernel.org>; Crt Mori <cmo@melexis.com>; Linus Walleij
> > <linus.walleij@linaro.org>; Bartosz Golaszewski <brgl@bgdev.pl>
> > Subject: Re: [PATCH v6 1/2] dt-bindings: iio: frequency: add admfm2000
> >=20
> > [External]
> >=20
> > Hey,
> >=20
> > On Thu, Jan 18, 2024 at 04:58:55PM +0800, 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 t=
o
> > > 8 GHz. It consists of a LNA, mixer, IF filter, DSA, and IF amplifier
> > > for each down conversion path.
> > >=20
> > > Signed-off-by: Kim Seer Paller <kimseer.paller@analog.com>
> > > ---
> > > V5 -> V6: Moved array of switch and attenuation GPIOs to the channel =
node.
> > > =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 Changed pin co=
ords with friendly names. Removed Reviewed-by tag.
> > > V4 -> V5: Added Reviewed-by tag.
> > > V3 -> V4: Updated the description of the properties with multiple ent=
ries and
> > > =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 defined the or=
der.
> > > V2 -> V3: Adjusted indentation to resolve wrong indentation warning.
> > > =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 Changed node n=
ame to converter. Updated the descriptions to clarify
> > > =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 the properties=
.
> > > V1 -> V2: Removed '|' after description. Specified the pins connected=
 to
> > > =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 the GPIOs. Add=
ed additionalProperties: false. Changed node name to
> > gpio.
> > > =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 Aligned < synt=
ax with the previous syntax in the examples.
> > >=20
> > > =C2=A0.../bindings/iio/frequency/adi,admfm2000.yaml | 129 +++++++++++=
+++++++
> > > =C2=A0MAINTAINERS=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=
=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=
=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=
=A0 |=C2=A0=C2=A0 7 +
> > > =C2=A02 files changed, 136 insertions(+)
> > > =C2=A0create mode 100644
> > Documentation/devicetree/bindings/iio/frequency/adi,admfm2000.yaml
> > >=20
> > > diff --git
> > a/Documentation/devicetree/bindings/iio/frequency/adi,admfm2000.yaml
> > b/Documentation/devicetree/bindings/iio/frequency/adi,admfm2000.yaml
> > > new file mode 100644
> > > index 000000000000..6f2c91c38666
> > > --- /dev/null
> > > +++
> > b/Documentation/devicetree/bindings/iio/frequency/adi,admfm2000.yaml
> > > @@ -0,0 +1,129 @@
> > > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> > > +# Copyright 2023 Analog Devices Inc.
> > > +%YAML 1.2
> > > +---
> > > +$id: http://devicetree.org/schemas/iio/frequency/adi,admfm2000.yaml#
> > > +$schema: http://devicetree.org/meta-schemas/core.yaml#
> > > +
> > > +title: ADMFM2000 Dual Microwave Down Converter
> > > +
> > > +maintainers:
> > > +=C2=A0 - Kim Seer Paller <kimseer.paller@analog.com>
> > > +
> > > +description:
> > > +=C2=A0 Dual microwave down converter module with input RF and LO fre=
quency
> > ranges
> > > +=C2=A0 from 0.5 to 32 GHz and an output IF frequency range from 0.1 =
to 8 GHz.
> > > +=C2=A0 It consists of a LNA, mixer, IF filter, DSA, and IF amplifier=
 for each down
> > > +=C2=A0 conversion path.
> > > +
> > > +properties:
> > > +=C2=A0 compatible:
> > > +=C2=A0=C2=A0=C2=A0 enum:
> > > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 - adi,admfm2000
> > > +
> > > +=C2=A0 '#address-cells':
> > > +=C2=A0=C2=A0=C2=A0 const: 1
> > > +
> > > +=C2=A0 '#size-cells':
> > > +=C2=A0=C2=A0=C2=A0 const: 0
> > > +
> > > +patternProperties:
> > > +=C2=A0 "^channel@[0-1]$":
> > > +=C2=A0=C2=A0=C2=A0 type: object
> > > +=C2=A0=C2=A0=C2=A0 description: Represents a channel of the device.
> > > +
> > > +=C2=A0=C2=A0=C2=A0 additionalProperties: false
> > > +
> > > +=C2=A0=C2=A0=C2=A0 properties:
> > > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 reg:
> > > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 description:
> > > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 The channel n=
umber.
> > > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 minimum: 0
> > > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 maximum: 1
> > > +
> > > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 adi,mode:
> > > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 description:
> > > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 RF path selec=
ted for the channel.
> > > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 0=
 - Direct IF mode
> > > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 1=
 - Mixer mode
> > > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 $ref: /schemas/types.yaml=
#/definitions/uint32
> > > +=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0 enum: [0, 1]
> >=20
> > How come this is an enum, rather than a boolean property such as
> > "adi,mixer-mode"?
>=20
> I used an enum, perhaps because it was easier to implement. However, this
> could be changed if a boolean property might be more suitable in this cas=
e.
> Is that the preferred option?
>=20

Hmmm, How is the enum easier than a boolean property :)? I guess the device=
 has a
default mode. So, if it is Direct IF mode you have 'adi,mixer-mode' to enab=
le that
mode and that's it. So the code is pretty much just:

if (device_property_read_bool()) {
	/* enable mixer mode */
}

Also remember that from a bindings point of view being easier to implement =
or not in
the driver does not matter much. Take for an example, properties with well =
know units
like 'microamp'. It would be much easier to just have an enum with the devi=
ce
register values but that's not how we should do it since it wouldn't be int=
uitive at
all for people reading devicetrees.

- Nuno S=C3=A1