Staging/adf4030 support #2651

mhennerich · 2024-11-18T12:06:42Z

PR Description

New Linux IIO driver for Analog Devices ADF4030 10-Channel Precision Synchronizer IC.

The ADF4030 provides for 10 bidirectional synchronized clock (BSYNC) channels and
accepts a reference clock input (REFIN) signal as a frequency reference for
generating an output clock on any BSYNC channels that are configured as an output.
The hallmark feature of the ADF4030 is the ability to time align the clock edges
of any one or more BSYNC channels to <5 ps (at the device pins) with respect to
the BSYNC channel selected as the reference BSYNC channel.

https://www.analog.com/en/products/adf4030.html

PR Type

New feature (a change that adds new functionality)

PR Checklist

I have conducted a self-review of my own code changes
I have tested the changes on the relevant hardware
I have updated the documentation outside this repo accordingly (if there is the case)

nunojsa · 2024-11-29T12:59:17Z

Documentation/devicetree/bindings/iio/frequency/adi,adf4030.yaml

+
+      adi,extended-name:
+        description: Extended name for the channel.
+        $ref: /schemas/types.yaml#/definitions/string


This one is questionable..

Well it's handy, and avoids possible mix up.

nunojsa · 2024-11-29T12:59:41Z

Documentation/devicetree/bindings/iio/frequency/adi,adf4030.yaml

+    properties:
+      reg:
+        description: Channel number.
+        $ref: /schemas/types.yaml#/definitions/uint32


This needs some constrains. I guess some of the other properties also need it.

nunojsa · 2024-11-29T13:00:53Z

Documentation/devicetree/bindings/iio/frequency/adi,adf4030.yaml

+
+      adi,rcm:
+        description: RCM value for the channel.
+        $ref: /schemas/types.yaml#/definitions/uint32


A lot of these properties need a better description. Right now, the description is more or less the same what one can infer from the name.

You will always need the datasheet to properly set those and the naming follows the datasheet.
But I agree some more text doesn't harm. Will fix.

nunojsa · 2024-11-29T13:02:17Z

Documentation/devicetree/bindings/iio/frequency/adi,adf4030.yaml

+    description: Number of iterations for auto alignment.
+
+  adi,bsync-autoalign-threshold-fs:
+    description: Threshold for auto alignment in femtoseconds.


I dunno the three above properties pass the binding check. They have no standard suffix and we're not defining a type for them.

Not sure why it does not fail in the check

Documentation/devicetree/bindings/iio/frequency/adi,adf4030.yaml

drivers/iio/frequency/adf4030.c

nunojsa · 2024-11-29T13:16:47Z

drivers/iio/frequency/adf4030.c

+		.shared = true,
+		.private = BSYNC_ALIGN_ITER,
+	},
+	{},


The above four (at least) need an ABI doc. But I guess we can do it when upstreaming...

ABI documentation sysfs-bus-iio-frequency-adf4030

Yeah - the wiki page already has a link for it ...
https://wiki.analog.com/resources/tools-software/linux-drivers/iio-synchronizer/adf4030

drivers/iio/frequency/adf4030.c

nunojsa

Looks mostly good to me...

Is there any strong reason to merge this right now or can we wait till we upstream this driver?

drivers/iio/frequency/adf4030.c

nunojsa · 2024-12-17T12:26:45Z

drivers/iio/frequency/adf4030.c

+						st->clk_out_names,
+						ARRAY_SIZE(st->clk_out_names));
+	if (ret < 0)
+		return ret;


This is still treating it as mandatory because we error out in case the property is not there. I guess we could do it in the same way as here:

https://elixir.bootlin.com/linux/v6.13-rc3/source/drivers/iio/frequency/adf4350.c#L467

drivers/iio/frequency/adf4030.c

Initial support... Signed-off-by: Nuno Sa <nuno.sa@analog.com>

mhennerich · 2025-01-13T13:31:54Z

Pushed a new version which addresses the last review feedback

mhennerich · 2025-01-13T13:32:57Z

Looks mostly good to me...

Is there any strong reason to merge this right now or can we wait till we upstream this driver?

Would be good to merge this now...

nunojsa

Minor comments that can be addressed later

nunojsa · 2025-01-14T13:47:47Z

drivers/iio/frequency/adf4030.c

+/*
+ * Driver for ADF4030 10-Channel Precision Synchronizer IC.
+ *
+ * Copyright 2024 Analog Devices Inc.


nit: 2025 by now :)

nunojsa · 2025-01-14T13:49:03Z

drivers/iio/frequency/adf4030.c

+}
+
+static const struct spi_device_id adf4030_id[] = {
+	{"adf4030", 4030},


4030? It seems we should drop that

nunojsa · 2025-01-14T13:55:54Z

drivers/iio/frequency/adf4030.c

+		st->iio_channels[i].indexed = 1;
+		st->iio_channels[i].channel = chan->num;
+		st->iio_channels[i].address = i;
+		st->iio_channels[i].extend_name = chan->extended_name;


extend_name should not be used in new devices. IIO will still make use of labels but that's only for backward compatibility. Can be fixed when upstreaming (though I still think that the devicetree property is questionable).

nunojsa · 2025-01-14T14:17:48Z

drivers/iio/frequency/adf4030.c

+					 &st->channels[cnt].delay);
+
+		fwnode_property_read_string(child, "adi,extended-name",
+					    &st->channels[cnt].extended_name);


adc have a 'label' property to accomplish the same as the above. It should also be acceptable to have the same for 'frequency' devices. I can take care of this afterwards...

Add dt-bindings for the Analog Devices ADF4030 Precision Synchronizer IC. Signed-off-by: Michael Hennerich <michael.hennerich@analog.com>

Automatically imply ADF4030. Signed-off-by: Nuno Sa <nuno.sa@analog.com>

nunojsa · 2025-01-15T12:45:50Z

Last push (not sure which version we're in this 😅) should fix the bindings validation job

mhennerich requested review from nunojsa, dbogdan, btogorean, chegbeli, buha, amiclaus, rbolboac, danmois, CiprianRegus and machschmitt as code owners November 18, 2024 12:06

mhennerich force-pushed the staging/adf4030-support branch 5 times, most recently from 0d2c2cd to dbed104 Compare November 19, 2024 14:21

nunojsa reviewed Nov 29, 2024

View reviewed changes

mhennerich force-pushed the staging/adf4030-support branch 2 times, most recently from 6e2a7c7 to ea7284a Compare December 5, 2024 11:51

nunojsa reviewed Dec 17, 2024

View reviewed changes

mhennerich force-pushed the staging/adf4030-support branch 2 times, most recently from fe0fb1f to 9b23d38 Compare January 13, 2025 12:51

iio: frequency: support the adf4030 Synchronizer

47046d7

Initial support... Signed-off-by: Nuno Sa <nuno.sa@analog.com>

mhennerich force-pushed the staging/adf4030-support branch from 9b23d38 to b0db36f Compare January 13, 2025 13:10

nunojsa approved these changes Jan 14, 2025

View reviewed changes

mhennerich and others added 2 commits January 15, 2025 12:42

devicetree: bindings: iio: adi,adf4030.yaml: Add dt-bindings doc

92678df

Add dt-bindings for the Analog Devices ADF4030 Precision Synchronizer IC. Signed-off-by: Michael Hennerich <michael.hennerich@analog.com>

iio: Kconfig.adi: imply ADF4030

55273ec

Automatically imply ADF4030. Signed-off-by: Nuno Sa <nuno.sa@analog.com>

nunojsa force-pushed the staging/adf4030-support branch from b0db36f to 55273ec Compare January 15, 2025 12:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Staging/adf4030 support #2651

Staging/adf4030 support #2651

mhennerich commented Nov 18, 2024

nunojsa Nov 29, 2024

mhennerich Nov 29, 2024

nunojsa Nov 29, 2024

mhennerich Nov 29, 2024

nunojsa Nov 29, 2024

mhennerich Nov 29, 2024

nunojsa Nov 29, 2024

nunojsa Nov 29, 2024

mhennerich Nov 29, 2024

nunojsa left a comment

nunojsa Dec 17, 2024

mhennerich commented Jan 13, 2025

mhennerich commented Jan 13, 2025

nunojsa left a comment

nunojsa Jan 14, 2025

nunojsa Jan 14, 2025

nunojsa Jan 14, 2025

nunojsa Jan 14, 2025

nunojsa commented Jan 15, 2025

Staging/adf4030 support #2651

Are you sure you want to change the base?

Staging/adf4030 support #2651

Conversation

mhennerich commented Nov 18, 2024

PR Description

PR Type

PR Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nunojsa left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mhennerich commented Jan 13, 2025

mhennerich commented Jan 13, 2025

nunojsa left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nunojsa commented Jan 15, 2025