LinuxLists.cc - [PATCH v8 1/2] dt-bindings: iio: frequency: add admfm2000

2024-01-23 08:11:59

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

2024-01-23 08:12:51

Subject: [PATCH v8 2/2] iio: frequency: admfm2000: New driver

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 <[email protected]>
---
V7 -> V8: No changes.
V6 -> V7: Removed unnecessary include. Used fwnode_property_present for
checking mixer mode property. Reduced code duplicate in channel
config function. Misc changes(extra spaces, year, etc.)
V5 -> V6: Used devm_fwnode_gpiod_get_index for getting array of gpios.
V4 -> V5: Added missing return -ENODEV in setup function. Reordered variable
declarations in probe function.
V1 -> V4: No changes.

MAINTAINERS | 1 +
drivers/iio/frequency/Kconfig | 10 ++
drivers/iio/frequency/Makefile | 1 +
drivers/iio/frequency/admfm2000.c | 282 ++++++++++++++++++++++++++++++
4 files changed, 294 insertions(+)
create mode 100644 drivers/iio/frequency/admfm2000.c

diff --git a/MAINTAINERS b/MAINTAINERS
index 1f7cd2e848de..e2bd41485107 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1273,6 +1273,7 @@ L: [email protected]
S: Supported
W: https://ez.analog.com/linux-software-drivers
F: Documentation/devicetree/bindings/iio/frequency/adi,admfm2000.yaml
+F: drivers/iio/frequency/admfm2000.c

ANALOG DEVICES INC ADMV1013 DRIVER
M: Antoniu Miclaus <[email protected]>
diff --git a/drivers/iio/frequency/Kconfig b/drivers/iio/frequency/Kconfig
index 9e85dfa58508..c455be7d4a1c 100644
--- a/drivers/iio/frequency/Kconfig
+++ b/drivers/iio/frequency/Kconfig
@@ -60,6 +60,16 @@ config ADF4377
To compile this driver as a module, choose M here: the
module will be called adf4377.

+config ADMFM2000
+ tristate "Analog Devices ADMFM2000 Dual Microwave Down Converter"
+ depends on GPIOLIB
+ help
+ Say yes here to build support for Analog Devices ADMFM2000 Dual
+ Microwave Down Converter.
+
+ To compile this driver as a module, choose M here: the
+ module will be called admfm2000.
+
config ADMV1013
tristate "Analog Devices ADMV1013 Microwave Upconverter"
depends on SPI && COMMON_CLK
diff --git a/drivers/iio/frequency/Makefile b/drivers/iio/frequency/Makefile
index b616c29b4a08..70d0e0b70e80 100644
--- a/drivers/iio/frequency/Makefile
+++ b/drivers/iio/frequency/Makefile
@@ -8,6 +8,7 @@ obj-$(CONFIG_AD9523) += ad9523.o
obj-$(CONFIG_ADF4350) += adf4350.o
obj-$(CONFIG_ADF4371) += adf4371.o
obj-$(CONFIG_ADF4377) += adf4377.o
+obj-$(CONFIG_ADMFM2000) += admfm2000.o
obj-$(CONFIG_ADMV1013) += admv1013.o
obj-$(CONFIG_ADMV1014) += admv1014.o
obj-$(CONFIG_ADMV4420) += admv4420.o
diff --git a/drivers/iio/frequency/admfm2000.c b/drivers/iio/frequency/admfm2000.c
new file mode 100644
index 000000000000..c34d79e55a7c
--- /dev/null
+++ b/drivers/iio/frequency/admfm2000.c
@@ -0,0 +1,282 @@
+// SPDX-License-Identifier: GPL-2.0
+/*
+ * ADMFM2000 Dual Microwave Down Converter
+ *
+ * Copyright 2024 Analog Devices Inc.
+ */
+
+#include <linux/device.h>
+#include <linux/err.h>
+#include <linux/gpio/consumer.h>
+#include <linux/iio/iio.h>
+#include <linux/kernel.h>
+#include <linux/module.h>
+#include <linux/mod_devicetable.h>
+#include <linux/platform_device.h>
+#include <linux/property.h>
+
+#define ADMFM2000_MIXER_MODE 0
+#define ADMFM2000_DIRECT_IF_MODE 1
+#define ADMFM2000_DSA_GPIOS 5
+#define ADMFM2000_MODE_GPIOS 2
+#define ADMFM2000_MAX_GAIN 0
+#define ADMFM2000_MIN_GAIN -31000
+#define ADMFM2000_DEFAULT_GAIN -0x20
+
+struct admfm2000_state {
+ struct mutex lock; /* protect sensor state */
+ struct gpio_desc *sw1_ch[2];
+ struct gpio_desc *sw2_ch[2];
+ struct gpio_desc *dsa1_gpios[5];
+ struct gpio_desc *dsa2_gpios[5];
+ u32 gain[2];
+};
+
+static int admfm2000_mode(struct iio_dev *indio_dev, u32 chan, u32 mode)
+{
+ struct admfm2000_state *st = iio_priv(indio_dev);
+ int i;
+
+ switch (mode) {
+ case ADMFM2000_MIXER_MODE:
+ for (i = 0; i < ADMFM2000_MODE_GPIOS; i++) {
+ gpiod_set_value_cansleep(st->sw1_ch[i], (chan == 0) ? 1 : 0);
+ gpiod_set_value_cansleep(st->sw2_ch[i], (chan == 0) ? 0 : 1);
+ }
+ return 0;
+ case ADMFM2000_DIRECT_IF_MODE:
+ for (i = 0; i < ADMFM2000_MODE_GPIOS; i++) {
+ gpiod_set_value_cansleep(st->sw1_ch[i], (chan == 0) ? 0 : 1);
+ gpiod_set_value_cansleep(st->sw2_ch[i], (chan == 0) ? 1 : 0);
+ }
+ return 0;
+ default:
+ return -EINVAL;
+ }
+}
+
+static int admfm2000_attenuation(struct iio_dev *indio_dev, u32 chan, u32 value)
+{
+ struct admfm2000_state *st = iio_priv(indio_dev);
+ int i;
+
+ switch (chan) {
+ case 0:
+ for (i = 0; i < ADMFM2000_DSA_GPIOS; i++)
+ gpiod_set_value_cansleep(st->dsa1_gpios[i], value & (1 << i));
+ return 0;
+ case 1:
+ for (i = 0; i < ADMFM2000_DSA_GPIOS; i++)
+ gpiod_set_value_cansleep(st->dsa2_gpios[i], value & (1 << i));
+ return 0;
+ default:
+ return -EINVAL;
+ }
+}
+
+static int admfm2000_read_raw(struct iio_dev *indio_dev,
+ struct iio_chan_spec const *chan, int *val,
+ int *val2, long mask)
+{
+ struct admfm2000_state *st = iio_priv(indio_dev);
+ int gain;
+
+ switch (mask) {
+ case IIO_CHAN_INFO_HARDWAREGAIN:
+ mutex_lock(&st->lock);
+ gain = ~(st->gain[chan->channel]) * -1000;
+ *val = gain / 1000;
+ *val2 = (gain % 1000) * 1000;
+ mutex_unlock(&st->lock);
+
+ return IIO_VAL_INT_PLUS_MICRO_DB;
+ default:
+ return -EINVAL;
+ }
+}
+
+static int admfm2000_write_raw(struct iio_dev *indio_dev,
+ struct iio_chan_spec const *chan, int val,
+ int val2, long mask)
+{
+ struct admfm2000_state *st = iio_priv(indio_dev);
+ int gain, ret;
+
+ if (val < 0)
+ gain = (val * 1000) - (val2 / 1000);
+ else
+ gain = (val * 1000) + (val2 / 1000);
+
+ if (gain > ADMFM2000_MAX_GAIN || gain < ADMFM2000_MIN_GAIN)
+ return -EINVAL;
+
+ switch (mask) {
+ case IIO_CHAN_INFO_HARDWAREGAIN:
+ mutex_lock(&st->lock);
+ st->gain[chan->channel] = ~((abs(gain) / 1000) & 0x1F);
+
+ ret = admfm2000_attenuation(indio_dev, chan->channel,
+ st->gain[chan->channel]);
+ mutex_unlock(&st->lock);
+ return ret;
+ default:
+ return -EINVAL;
+ }
+}
+
+static int admfm2000_write_raw_get_fmt(struct iio_dev *indio_dev,
+ struct iio_chan_spec const *chan,
+ long mask)
+{
+ switch (mask) {
+ case IIO_CHAN_INFO_HARDWAREGAIN:
+ return IIO_VAL_INT_PLUS_MICRO_DB;
+ default:
+ return -EINVAL;
+ }
+}
+
+static const struct iio_info admfm2000_info = {
+ .read_raw = &admfm2000_read_raw,
+ .write_raw = &admfm2000_write_raw,
+ .write_raw_get_fmt = &admfm2000_write_raw_get_fmt,
+};
+
+#define ADMFM2000_CHAN(_channel) { \
+ .type = IIO_VOLTAGE, \
+ .output = 1, \
+ .indexed = 1, \
+ .channel = _channel, \
+ .info_mask_separate = BIT(IIO_CHAN_INFO_HARDWAREGAIN), \
+}
+
+static const struct iio_chan_spec admfm2000_channels[] = {
+ ADMFM2000_CHAN(0),
+ ADMFM2000_CHAN(1),
+};
+
+static int admfm2000_channel_config(struct admfm2000_state *st,
+ struct iio_dev *indio_dev)
+{
+ struct platform_device *pdev = to_platform_device(indio_dev->dev.parent);
+ struct device *dev = &pdev->dev;
+ struct fwnode_handle *child;
+ struct gpio_desc **dsa;
+ struct gpio_desc **sw;
+ int ret, i;
+ bool mode;
+ u32 reg;
+
+ device_for_each_child_node(dev, child) {
+ ret = fwnode_property_read_u32(child, "reg", &reg);
+ if (ret) {
+ fwnode_handle_put(child);
+ return dev_err_probe(dev, ret,
+ "Failed to get reg property\n");
+ }
+
+ if (reg >= indio_dev->num_channels) {
+ fwnode_handle_put(child);
+ return dev_err_probe(dev, -EINVAL, "reg bigger than: %d\n",
+ indio_dev->num_channels);
+ }
+
+ if (fwnode_property_present(child, "adi,mixer-mode"))
+ mode = ADMFM2000_MIXER_MODE;
+ else
+ mode = ADMFM2000_DIRECT_IF_MODE;
+
+ switch (reg) {
+ case 0:
+ sw = st->sw1_ch;
+ dsa = st->dsa1_gpios;
+ break;
+ case 1:
+ sw = st->sw2_ch;
+ dsa = st->dsa2_gpios;
+ break;
+ default:
+ fwnode_handle_put(child);
+ return -EINVAL;
+ }
+
+ for (i = 0; i < ADMFM2000_MODE_GPIOS; i++) {
+ sw[i] = devm_fwnode_gpiod_get_index(dev, child, "switch",
+ i, GPIOD_OUT_LOW, NULL);
+ if (IS_ERR(sw[i])) {
+ fwnode_handle_put(child);
+ return dev_err_probe(dev, PTR_ERR(sw[i]),
+ "Failed to get gpios\n");
+ }
+ }
+
+ for (i = 0; i < ADMFM2000_DSA_GPIOS; i++) {
+ dsa[i] = devm_fwnode_gpiod_get_index(dev, child,
+ "attenuation", i,
+ GPIOD_OUT_LOW, NULL);
+ if (IS_ERR(dsa[i])) {
+ fwnode_handle_put(child);
+ return dev_err_probe(dev, PTR_ERR(dsa[i]),
+ "Failed to get gpios\n");
+ }
+ }
+
+ ret = admfm2000_mode(indio_dev, reg, mode);
+ if (ret) {
+ fwnode_handle_put(child);
+ return ret;
+ }
+ }
+
+ return 0;
+}
+
+static int admfm2000_probe(struct platform_device *pdev)
+{
+ struct device *dev = &pdev->dev;
+ struct admfm2000_state *st;
+ struct iio_dev *indio_dev;
+ int ret;
+
+ indio_dev = devm_iio_device_alloc(dev, sizeof(*st));
+ if (!indio_dev)
+ return -ENOMEM;
+
+ st = iio_priv(indio_dev);
+
+ indio_dev->name = "admfm2000";
+ indio_dev->num_channels = ARRAY_SIZE(admfm2000_channels);
+ indio_dev->channels = admfm2000_channels;
+ indio_dev->info = &admfm2000_info;
+ indio_dev->modes = INDIO_DIRECT_MODE;
+
+ st->gain[0] = ADMFM2000_DEFAULT_GAIN;
+ st->gain[1] = ADMFM2000_DEFAULT_GAIN;
+
+ mutex_init(&st->lock);
+
+ ret = admfm2000_channel_config(st, indio_dev);
+ if (ret)
+ return ret;
+
+ return devm_iio_device_register(dev, indio_dev);
+}
+
+static const struct of_device_id admfm2000_of_match[] = {
+ { .compatible = "adi,admfm2000" },
+ { }
+};
+MODULE_DEVICE_TABLE(of, admfm2000_of_match);
+
+static struct platform_driver admfm2000_driver = {
+ .driver = {
+ .name = "admfm2000",
+ .of_match_table = admfm2000_of_match,
+ },
+ .probe = admfm2000_probe,
+};
+module_platform_driver(admfm2000_driver);
+
+MODULE_AUTHOR("Kim Seer Paller <[email protected]>");
+MODULE_DESCRIPTION("ADMFM2000 Dual Microwave Down Converter");
+MODULE_LICENSE("GPL");
--
2.34.1

2024-01-23 16:21:26

by Conor Dooley

[permalink] [raw]

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

On Tue, Jan 23, 2024 at 04:10:58PM +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 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 <[email protected]>

Reviewed-by: Conor Dooley <[email protected]>

Thanks for the updates. One comment below that I missed previvously, but
is not worth a resend.

> ---
> V7 -> V8: Added adequate description for mixer mode property. Modified description
> for switch gpio property.
> V6 -> V7: Changed RF path mode property to boolean.
> V5 -> V6: Moved array of switch and attenuation GPIOs to the channel node.
> Changed pin coords with friendly names. Removed Reviewed-by tag.
> V4 -> V5: Added Reviewed-by tag.
> V3 -> V4: Updated the description of the properties with multiple entries and
> defined the order.
> V2 -> V3: Adjusted indentation to resolve wrong indentation warning.
> Changed node name to converter. Updated the descriptions to clarify
> the properties.
> V1 -> V2: Removed '|' after description. Specified the pins connected to
> the GPIOs. Added additionalProperties: false. Changed node name to gpio.
> Aligned < syntax with the previous syntax in the examples.
>
> .../bindings/iio/frequency/adi,admfm2000.yaml | 127 ++++++++++++++++++
> MAINTAINERS | 7 +
> 2 files changed, 134 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/iio/frequency/adi,admfm2000.yaml
>
> 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..2bcf4bbc12e4
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/frequency/adi,admfm2000.yaml
> @@ -0,0 +1,127 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +# Copyright 2024 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:
> + - Kim Seer Paller <[email protected]>
> +
> +description:
> + 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

If you do not have other devices to add to this binding, the enum: can be
become a const:

Cheers,
Conor.

> +
> + '#address-cells':
> + const: 1
> +
> + '#size-cells':
> + const: 0
> +
> +patternProperties:
> + "^channel@[0-1]$":
> + type: object
> + description: Represents a channel of the device.
> +
> + additionalProperties: false
> +
> + properties:
> + reg:
> + description:
> + The channel number.
> + minimum: 0
> + maximum: 1
> +
> + adi,mixer-mode:
> + description:
> + Enable mixer mode for the channel. It downconverts RF between 5 GHz
> + and 32 GHz to IF between 0.5 GHz and 8 GHz. If not present, the channel
> + is in direct IF mode which bypasses the mixer and downconverts RF
> + between 2 GHz and 8 GHz to IF between 0.5 GHz and 8 GHz.
> + type: boolean
> +
> + switch-gpios:
> + description: |
> + GPIOs to select the RF path for the channel. The same state of CTRL-A
> + and CTRL-B GPIOs is not permitted.
> + CTRL-A CTRL-B CH1 Status CH2 Status
> + 1 0 Direct IF mode Mixer mode
> + 0 1 Mixer mode Direct IF mode
> +
> + items:
> + - description: CTRL-A GPIO
> + - description: CTRL-B GPIO
> +
> + attenuation-gpios:
> + description: |
> + Choice of attenuation:
> + DSA-V4 DSA-V3 DSA-V2 DSA-V1 DSA-V0
> + 1 1 1 1 1 0 dB
> + 1 1 1 1 0 -1 dB
> + 1 1 1 0 1 -2 dB
> + 1 1 0 1 1 -4 dB
> + 1 0 1 1 1 -8 dB
> + 0 1 1 1 1 -16 dB
> + 0 0 0 0 0 -31 dB
> +
> + items:
> + - description: DSA-V0 GPIO
> + - description: DSA-V1 GPIO
> + - description: DSA-V2 GPIO
> + - description: DSA-V3 GPIO
> + - description: DSA-V4 GPIO
> +
> + required:
> + - reg
> + - switch-gpios
> + - attenuation-gpios
> +
> +required:
> + - compatible
> +
> +additionalProperties: false
> +
> +examples:
> + - |
> + #include <dt-bindings/gpio/gpio.h>
> + converter {
> + compatible = "adi,admfm2000";
> +
> + #address-cells = <1>;
> + #size-cells = <0>;
> +
> + channel@0 {
> + reg = <0>;
> + switch-gpios = <&gpio 1 GPIO_ACTIVE_LOW>,
> + <&gpio 2 GPIO_ACTIVE_HIGH>;
> +
> + attenuation-gpios = <&gpio 17 GPIO_ACTIVE_LOW>,
> + <&gpio 22 GPIO_ACTIVE_LOW>,
> + <&gpio 23 GPIO_ACTIVE_LOW>,
> + <&gpio 24 GPIO_ACTIVE_LOW>,
> + <&gpio 25 GPIO_ACTIVE_LOW>;
> + };
> +
> + channel@1 {
> + reg = <1>;
> + adi,mixer-mode;
> + switch-gpios = <&gpio 3 GPIO_ACTIVE_LOW>,
> + <&gpio 4 GPIO_ACTIVE_HIGH>;
> +
> + attenuation-gpios = <&gpio 0 GPIO_ACTIVE_LOW>,
> + <&gpio 5 GPIO_ACTIVE_LOW>,
> + <&gpio 6 GPIO_ACTIVE_LOW>,
> + <&gpio 16 GPIO_ACTIVE_LOW>,
> + <&gpio 26 GPIO_ACTIVE_LOW>;
> + };
> + };
> +...
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 8d1052fa6a69..1f7cd2e848de 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -1267,6 +1267,13 @@ W: https://ez.analog.com/linux-software-drivers
> F: Documentation/devicetree/bindings/hwmon/adi,adm1177.yaml
> F: drivers/hwmon/adm1177.c
>
> +ANALOG DEVICES INC ADMFM2000 DRIVER
> +M: Kim Seer Paller <[email protected]>
> +L: [email protected]
> +S: Supported
> +W: https://ez.analog.com/linux-software-drivers
> +F: Documentation/devicetree/bindings/iio/frequency/adi,admfm2000.yaml
> +
> ANALOG DEVICES INC ADMV1013 DRIVER
> M: Antoniu Miclaus <[email protected]>
> L: [email protected]
>
> base-commit: 7ed2632ec7d72e926b9e8bcc9ad1bb0cd37274bf
> --
> 2.34.1
>

Attachments:

(No filename) (6.99 kB)
signature.asc (235.00 B)
Download all attachments

2024-01-27 16:12:59

by Jonathan Cameron

[permalink] [raw]

Subject: Re: [PATCH v8 2/2] iio: frequency: admfm2000: New driver

On Tue, 23 Jan 2024 16:10:59 +0800
Kim Seer Paller <[email protected]> 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 <[email protected]>
Series applied.

For future reference please always use a cover letter
--cover-letter for git format-patch, most because it gives a place for general
comments (like applied!) and because it gives a nice pretty name in patchwork!

Thanks,

Jonathan

2024-01-27 16:14:38

by Jonathan Cameron

[permalink] [raw]

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

On Tue, 23 Jan 2024 16:16:49 +0000
Conor Dooley <[email protected]> wrote:

> On Tue, Jan 23, 2024 at 04:10:58PM +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 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 <[email protected]>
>
> Reviewed-by: Conor Dooley <[email protected]>
>
> Thanks for the updates. One comment below that I missed previvously, but
> is not worth a resend.

Given there is an admfm2001 part that at least from the title of the
webpage sounds plausibly somewhat compatible, I'll give this the
benefit of the doubt and leave it as an enum whilst applying.

Jonathan