The ADF4377 is a high performance, ultralow jitter, dual output integer-N
phased locked loop (PLL) with integrated voltage controlled oscillator
(VCO) ideally suited for data converter and mixed signal front end (MxFE)
clock applications.
Antoniu Miclaus (3):
dt-bindings: iio: frequency: add adf4377 doc
iio: frequency: adf4377: add support for ADF4377
Documentation: ABI: testing: adf4377: add ABI docs
.../testing/sysfs-bus-iio-frequency-adf4377 | 32 +
.../bindings/iio/frequency/adi,adf4377.yaml | 78 ++
drivers/iio/frequency/Kconfig | 10 +
drivers/iio/frequency/Makefile | 1 +
drivers/iio/frequency/adf4377.c | 1155 +++++++++++++++++
5 files changed, 1276 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4377
create mode 100644 Documentation/devicetree/bindings/iio/frequency/adi,adf4377.yaml
create mode 100644 drivers/iio/frequency/adf4377.c
--
2.38.1
Add documentation for the use of the output frequency and muxout select.
Signed-off-by: Antoniu Miclaus <[email protected]>
---
.../testing/sysfs-bus-iio-frequency-adf4377 | 32 +++++++++++++++++++
1 file changed, 32 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4377
diff --git a/Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4377 b/Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4377
new file mode 100644
index 000000000000..0324de5c9328
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4377
@@ -0,0 +1,32 @@
+What: /sys/bus/iio/devices/iio:deviceX/frequency
+KernelVersion:
+Contact: [email protected]
+Description:
+ Stores the PLL frequency in Hz for output channels.
+ Reading returns the frequency in Hz.
+
+What: /sys/bus/iio/devices/iio:deviceX/muxout_select
+KernelVersion:
+Contact: [email protected]
+Description:
+ The mux output allows the user to access various internal points on
+ the chip. Valid values that can be written are:
+ * high_z -> high impedance output
+ * lock_detect -> digital lock detector output
+ * muxout_low -> low output
+ * f_div_rclk_2 -> fdiv_rclk/2
+ * f_div_nclk_2 -> fdiv_nclk/2
+ * muxout_high -> high output
+
+What: /sys/bus/iio/devices/iio:deviceX/muxout_select_available
+KernelVersion:
+Contact: [email protected]
+Description:
+ Reading this returns the valid values that can be written to the
+ muxout_mode attribute:
+ * high_z
+ * lock_detect
+ * muxout_low
+ * f_div_rclk_2
+ * f_div_nclk_2
+ * muxout_high
--
2.38.1
Add device tree bindings for the ADF4377 driver.
Signed-off-by: Antoniu Miclaus <[email protected]>
---
.../bindings/iio/frequency/adi,adf4377.yaml | 78 +++++++++++++++++++
1 file changed, 78 insertions(+)
create mode 100644 Documentation/devicetree/bindings/iio/frequency/adi,adf4377.yaml
diff --git a/Documentation/devicetree/bindings/iio/frequency/adi,adf4377.yaml b/Documentation/devicetree/bindings/iio/frequency/adi,adf4377.yaml
new file mode 100644
index 000000000000..3f5c83e03bb9
--- /dev/null
+++ b/Documentation/devicetree/bindings/iio/frequency/adi,adf4377.yaml
@@ -0,0 +1,78 @@
+# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/iio/frequency/adi,adf4377.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: ADF4377 Microwave Wideband Synthesizer with Integrated VCO
+
+maintainers:
+ - Antoniu Miclaus <[email protected]>
+ - Dragos Bogdan <[email protected]>
+
+description: |
+ The ADF4377 is a high performance, ultralow jitter, dual output integer-N
+ phased locked loop (PLL) with integrated voltage controlled oscillator (VCO)
+ ideally suited for data converter and mixed signal front end (MxFE) clock
+ applications.
+
+ https://www.analog.com/en/products/adf4377.html
+
+properties:
+ compatible:
+ enum:
+ - adi,adf4377
+ - adi,adf4378
+
+ reg:
+ maxItems: 1
+
+ spi-max-frequency:
+ maximum: 10000000
+
+ clocks:
+ maxItems: 1
+
+ clock-names:
+ description:
+ External clock that provides reference input frequency.
+ items:
+ - const: ref_in
+
+ ce-en-gpios:
+ description:
+ Gpio that controls the Chip Enable Pin.
+ maxItems: 1
+
+ enclk1-gpios:
+ description:
+ Gpio that controls the Enable Clock 1 Output Buffer Pin.
+ maxItems: 1
+
+ enclk2-gpios:
+ description:
+ Gpio that controls the Enable Clock 2 Output Buffer Pin.
+ maxItems: 1
+
+required:
+ - compatible
+ - reg
+ - clocks
+ - clock-names
+
+additionalProperties: false
+
+examples:
+ - |
+ spi {
+ #address-cells = <1>;
+ #size-cells = <0>;
+ frequency@0 {
+ compatible = "adi,adf4377";
+ reg = <0>;
+ spi-max-frequency = <10000000>;
+ clocks = <&adf4377_ref_in>;
+ clock-names = "ref_in";
+ };
+ };
+...
--
2.38.1
Add myself as maintainer for the ADF4377 driver.
Signed-off-by: Antoniu Miclaus <[email protected]>
---
MAINTAINERS | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/MAINTAINERS b/MAINTAINERS
index e1bc31a6624b..19a2f689e43e 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -1189,6 +1189,14 @@ W: https://ez.analog.com/linux-software-drivers
F: Documentation/devicetree/bindings/iio/amplifiers/adi,ada4250.yaml
F: drivers/iio/amplifiers/ada4250.c
+ANALOG DEVICES INC ADF4377 DRIVER
+M: Antoniu Miclaus <[email protected]>
+L: [email protected]
+S: Supported
+W: https://ez.analog.com/linux-software-drivers
+F: Documentation/devicetree/bindings/iio/frequency/adi,adf4377.yaml
+F: drivers/iio/frequency/adf4377.c
+
ANALOG DEVICES INC ADGS1408 DRIVER
M: Mircea Caprioru <[email protected]>
S: Supported
--
2.38.1
The ADF4377 is a high performance, ultralow jitter, dual output integer-N
phased locked loop (PLL) with integrated voltage controlled oscillator
(VCO) ideally suited for data converter and mixed signal front end (MxFE)
clock applications.
Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/adf4377.pdf
Signed-off-by: Antoniu Miclaus <[email protected]>
---
drivers/iio/frequency/Kconfig | 10 +
drivers/iio/frequency/Makefile | 1 +
drivers/iio/frequency/adf4377.c | 1154 +++++++++++++++++++++++++++++++
3 files changed, 1165 insertions(+)
create mode 100644 drivers/iio/frequency/adf4377.c
diff --git a/drivers/iio/frequency/Kconfig b/drivers/iio/frequency/Kconfig
index f3702f36436c..9e85dfa58508 100644
--- a/drivers/iio/frequency/Kconfig
+++ b/drivers/iio/frequency/Kconfig
@@ -50,6 +50,16 @@ config ADF4371
To compile this driver as a module, choose M here: the
module will be called adf4371.
+config ADF4377
+ tristate "Analog Devices ADF4377 Microwave Wideband Synthesizer"
+ depends on SPI && COMMON_CLK
+ help
+ Say yes here to build support for Analog Devices ADF4377 Microwave
+ Wideband Synthesizer.
+
+ To compile this driver as a module, choose M here: the
+ module will be called adf4377.
+
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 48add732f1d3..b616c29b4a08 100644
--- a/drivers/iio/frequency/Makefile
+++ b/drivers/iio/frequency/Makefile
@@ -7,6 +7,7 @@
obj-$(CONFIG_AD9523) += ad9523.o
obj-$(CONFIG_ADF4350) += adf4350.o
obj-$(CONFIG_ADF4371) += adf4371.o
+obj-$(CONFIG_ADF4377) += adf4377.o
obj-$(CONFIG_ADMV1013) += admv1013.o
obj-$(CONFIG_ADMV1014) += admv1014.o
obj-$(CONFIG_ADMV4420) += admv4420.o
diff --git a/drivers/iio/frequency/adf4377.c b/drivers/iio/frequency/adf4377.c
new file mode 100644
index 000000000000..1901dde1003e
--- /dev/null
+++ b/drivers/iio/frequency/adf4377.c
@@ -0,0 +1,1154 @@
+// SPDX-License-Identifier: GPL-2.0-only
+/*
+ * ADF4377 driver
+ *
+ * Copyright 2022 Analog Devices Inc.
+ */
+
+#include <linux/bitfield.h>
+#include <linux/bits.h>
+#include <linux/clk.h>
+#include <linux/clkdev.h>
+#include <linux/delay.h>
+#include <linux/device.h>
+#include <linux/module.h>
+#include <linux/notifier.h>
+#include <linux/property.h>
+#include <linux/spi/spi.h>
+#include <linux/iio/iio.h>
+#include <linux/regmap.h>
+#include <linux/units.h>
+
+#include <linux/gpio/consumer.h>
+
+/* ADF4377 REG0000 Map */
+#define ADF4377_SOFT_RESET_R_MSK BIT(7)
+#define ADF4377_LSB_FIRST_R_MSK BIT(6)
+#define ADF4377_ADDRESS_ASC_R_MSK BIT(5)
+#define ADF4377_SDO_ACTIVE_R_MSK BIT(4)
+#define ADF4377_SDO_ACTIVE_MSK BIT(3)
+#define ADF4377_ADDRESS_ASC_MSK BIT(2)
+#define ADF4377_LSB_FIRST_MSK BIT(1)
+#define ADF4377_SOFT_RESET_MSK BIT(0)
+
+/* ADF4377 REG0000 Bit Definition */
+#define ADF4377_SDO_ACTIVE_SPI_3W 0x0
+#define ADF4377_SDO_ACTIVE_SPI_4W 0x1
+
+#define ADF4377_ADDR_ASC_AUTO_DECR 0x0
+#define ADF4377_ADDR_ASC_AUTO_INCR 0x1
+
+#define ADF4377_LSB_FIRST_MSB 0x0
+#define ADF4377_LSB_FIRST_LSB 0x1
+
+#define ADF4377_SOFT_RESET_N_OP 0x0
+#define ADF4377_SOFT_RESET_EN 0x1
+
+/* ADF4377 REG0001 Map */
+#define ADF4377_SINGLE_INSTR_MSK BIT(7)
+#define ADF4377_MASTER_RB_CTRL_MSK BIT(5)
+
+/* ADF4377 REG0001 Bit Definition */
+#define ADF4377_SPI_STREAM_EN 0x0
+#define ADF4377_SPI_STREAM_DIS 0x1
+
+#define ADF4377_RB_SLAVE_REG 0x0
+#define ADF4377_RB_MASTER_REG 0x1
+
+/* ADF4377 REG0003 Bit Definition */
+#define ADF4377_CHIP_TYPE 0x06
+
+/* ADF4377 REG0004 Bit Definition */
+#define ADF4377_PRODUCT_ID_LSB 0x0005
+
+/* ADF4377 REG0005 Bit Definition */
+#define ADF4377_PRODUCT_ID_MSB 0x0005
+
+/* ADF4377 REG000A Map */
+#define ADF4377_SCRATCHPAD_MSK GENMASK(7, 0)
+
+/* ADF4377 REG000C Bit Definition */
+#define ADF4377_VENDOR_ID_LSB 0x56
+
+/* ADF4377 REG000D Bit Definition */
+#define ADF4377_VENDOR_ID_MSB 0x04
+
+/* ADF4377 REG000F Bit Definition */
+#define ADF4377_R00F_RSV1_MSK GENMASK(7, 0)
+
+/* ADF4377 REG0010 Map*/
+#define ADF4377_N_INT_LSB_MSK GENMASK(7, 0)
+
+/* ADF4377 REG0011 Map*/
+#define ADF4377_EN_AUTOCAL_MSK BIT(7)
+#define ADF4377_EN_RDBLR_MSK BIT(6)
+#define ADF4377_DCLK_DIV2_MSK GENMASK(5, 4)
+#define ADF4377_N_INT_MSB_MSK GENMASK(3, 0)
+
+/* ADF4377 REG0011 Bit Definition */
+#define ADF4377_VCO_CALIB_DIS 0x0
+#define ADF4377_VCO_CALIB_EN 0x1
+
+#define ADF4377_REF_DBLR_DIS 0x0
+#define ADF4377_REF_DBLR_EN 0x1
+
+#define ADF4377_DCLK_DIV2_1 0x0
+#define ADF4377_DCLK_DIV2_2 0x1
+#define ADF4377_DCLK_DIV2_4 0x2
+#define ADF4377_DCLK_DIV2_8 0x3
+
+/* ADF4377 REG0012 Map*/
+#define ADF4377_CLKOUT_DIV_MSK GENMASK(7, 6)
+#define ADF4377_R_DIV_MSK GENMASK(5, 0)
+
+/* ADF4377 REG0012 Bit Definition */
+#define ADF4377_CLKOUT_DIV_1 0x0
+#define ADF4377_CLKOUT_DIV_2 0x1
+#define ADF4377_CLKOUT_DIV_4 0x2
+#define ADF4377_CLKOUT_DIV_8 0x3
+
+/* ADF4377 REG0013 Map */
+#define ADF4377_M_VCO_CORE_MSK GENMASK(5, 4)
+#define ADF4377_M_VCO_BIAS_MSK GENMASK(3, 0)
+
+/* ADF4377 REG0013 Bit Definition */
+#define ADF4377_M_VCO_0 0x0
+#define ADF4377_M_VCO_1 0x1
+#define ADF4377_M_VCO_2 0x2
+#define ADF4377_M_VCO_3 0x3
+
+/* ADF4377 REG0014 Map */
+#define ADF4377_M_VCO_BAND_MSK GENMASK(7, 0)
+
+/* ADF4377 REG0015 Map */
+#define ADF4377_BLEED_I_LSB_MSK GENMASK(7, 6)
+#define ADF4377_BLEED_POL_MSK BIT(5)
+#define ADF4377_EN_BLEED_MSK BIT(4)
+#define ADF4377_CP_I_MSK GENMASK(3, 0)
+
+/* ADF4377 REG0015 Bit Definition */
+#define ADF4377_CURRENT_SINK 0x0
+#define ADF4377_CURRENT_SOURCE 0x1
+
+#define ADF4377_BLEED_CURR_DIS 0x0
+#define ADF4377_BLEED_CURR_EN 0x1
+
+#define ADF4377_CP_0MA7 0x0
+#define ADF4377_CP_0MA9 0x1
+#define ADF4377_CP_1MA1 0x2
+#define ADF4377_CP_1MA3 0x3
+#define ADF4377_CP_1MA4 0x4
+#define ADF4377_CP_1MA8 0x5
+#define ADF4377_CP_2MA2 0x6
+#define ADF4377_CP_2MA5 0x7
+#define ADF4377_CP_2MA9 0x8
+#define ADF4377_CP_3MA6 0x9
+#define ADF4377_CP_4MA3 0xA
+#define ADF4377_CP_5MA0 0xB
+#define ADF4377_CP_5MA7 0xC
+#define ADF4377_CP_7MA2 0xD
+#define ADF4377_CP_8MA6 0xE
+#define ADF4377_CP_10MA1 0xF
+
+/* ADF4377 REG0016 Map */
+#define ADF4377_BLEED_I_MSB_MSK GENMASK(7, 0)
+
+/* ADF4377 REG0017 Map */
+#define ADF4377_INV_CLKOUT_MSK BIT(7)
+#define ADF4377_N_DEL_MSK GENMASK(6, 0)
+
+/* ADF4377 REG0017 Bit Definition */
+#define ADF4377_CLKOUT_INV_DIS 0x0
+#define ADF4377_CLKOUT_INV_EN 0x1
+
+/* ADF4377 REG0018 Map */
+#define ADF4377_CMOS_OV_MSK BIT(7)
+#define ADF4377_R_DEL_MSK GENMASK(6, 0)
+
+/* ADF4377 REG0018 Bit Definition */
+#define ADF4377_1V8_LOGIC 0x0
+#define ADF4377_3V3_LOGIC 0x1
+
+/* ADF4377 REG0019 Map */
+#define ADF4377_CLKOUT2_OP_MSK GENMASK(7, 6)
+#define ADF4377_CLKOUT1_OP_MSK GENMASK(5, 4)
+#define ADF4377_PD_CLK_MSK BIT(3)
+#define ADF4377_PD_RDET_MSK BIT(2)
+#define ADF4377_PD_ADC_MSK BIT(1)
+#define ADF4377_PD_CALADC_MSK BIT(0)
+
+/* ADF4377 REG0019 Bit Definition */
+#define ADF4377_CLKOUT_320MV 0x0
+#define ADF4377_CLKOUT_420MV 0x1
+#define ADF4377_CLKOUT_530MV 0x2
+#define ADF4377_CLKOUT_640MV 0x3
+
+#define ADF4377_PD_CLK_N_OP 0x0
+#define ADF4377_PD_CLK_PD 0x1
+
+#define ADF4377_PD_RDET_N_OP 0x0
+#define ADF4377_PD_RDET_PD 0x1
+
+#define ADF4377_PD_ADC_N_OP 0x0
+#define ADF4377_PD_ADC_PD 0x1
+
+#define ADF4377_PD_CALADC_N_OP 0x0
+#define ADF4377_PD_CALADC_PD 0x1
+
+/* ADF4377 REG001A Map */
+#define ADF4377_PD_ALL_MSK BIT(7)
+#define ADF4377_PD_RDIV_MSK BIT(6)
+#define ADF4377_PD_NDIV_MSK BIT(5)
+#define ADF4377_PD_VCO_MSK BIT(4)
+#define ADF4377_PD_LD_MSK BIT(3)
+#define ADF4377_PD_PFDCP_MSK BIT(2)
+#define ADF4377_PD_CLKOUT1_MSK BIT(1)
+#define ADF4377_PD_CLKOUT2_MSK BIT(0)
+
+/* ADF4377 REG001A Bit Definition */
+#define ADF4377_PD_ALL_N_OP 0x0
+#define ADF4377_PD_ALL_PD 0x1
+
+#define ADF4377_PD_RDIV_N_OP 0x0
+#define ADF4377_PD_RDIV_PD 0x1
+
+#define ADF4377_PD_NDIV_N_OP 0x0
+#define ADF4377_PD_NDIV_PD 0x1
+
+#define ADF4377_PD_VCO_N_OP 0x0
+#define ADF4377_PD_VCO_PD 0x1
+
+#define ADF4377_PD_LD_N_OP 0x0
+#define ADF4377_PD_LD_PD 0x1
+
+#define ADF4377_PD_PFDCP_N_OP 0x0
+#define ADF4377_PD_PFDCP_PD 0x1
+
+#define ADF4377_PD_CLKOUT1_N_OP 0x0
+#define ADF4377_PD_CLKOUT1_PD 0x1
+
+#define ADF4377_PD_CLKOUT2_N_OP 0x0
+#define ADF4377_PD_CLKOUT2_PD 0x1
+
+/* ADF4377 REG001B Map */
+#define ADF4377_EN_LOL_MSK BIT(7)
+#define ADF4377_LDWIN_PW_MSK BIT(6)
+#define ADF4377_EN_LDWIN_MSK BIT(5)
+#define ADF4377_LD_COUNT_MSK GENMASK(4, 0)
+
+/* ADF4377 REG001B Bit Definition */
+#define ADF4377_EN_LOL_DIS 0x0
+#define ADF4377_EN_LOL_EN 0x1
+
+#define ADF4377_LDWIN_PW_NARROW 0x0
+#define ADF4377_LDWIN_PW_WIDE 0x1
+
+#define ADF4377_EN_LDWIN_DIS 0x0
+#define ADF4377_EN_LDWIN_EN 0x1
+
+/* ADF4377 REG001C Map */
+#define ADF4377_EN_DNCLK_MSK BIT(7)
+#define ADF4377_EN_DRCLK_MSK BIT(6)
+#define ADF4377_RST_LD_MSK BIT(2)
+#define ADF4377_R01C_RSV1_MSK BIT(0)
+
+/* ADF4377 REG001C Bit Definition */
+#define ADF4377_EN_DNCLK_OFF 0x0
+#define ADF4377_EN_DNCLK_ON 0x1
+
+#define ADF4377_EN_DRCLK_OFF 0x0
+#define ADF4377_EN_DRCLK_ON 0x1
+
+#define ADF4377_RST_LD_INACTIVE 0x0
+#define ADF4377_RST_LD_ACTIVE 0x1
+
+/* ADF4377 REG001D Map */
+#define ADF4377_MUXOUT_MSK GENMASK(7, 4)
+#define ADF4377_EN_CPTEST_MSK BIT(2)
+#define ADF4377_CP_DOWN_MSK BIT(1)
+#define ADF4377_CP_UP_MSK BIT(0)
+
+#define ADF4377_EN_CPTEST_OFF 0x0
+#define ADF4377_EN_CPTEST_ON 0x1
+
+#define ADF4377_CP_DOWN_OFF 0x0
+#define ADF4377_CP_DOWN_ON 0x1
+
+#define ADF4377_CP_UP_OFF 0x0
+#define ADF4377_CP_UP_ON 0x1
+
+/* ADF4377 REG001F Map */
+#define ADF4377_BST_REF_MSK BIT(7)
+#define ADF4377_FILT_REF_MSK BIT(6)
+#define ADF4377_REF_SEL_MSK BIT(5)
+#define ADF4377_R01F_RSV1_MSK GENMASK(4, 0)
+
+/* ADF4377 REG001F Bit Definition */
+#define ADF4377_BST_LARGE_REF_IN 0x0
+#define ADF4377_BST_SMALL_REF_IN 0x1
+
+#define ADF4377_FILT_REF_OFF 0x0
+#define ADF4377_FILT_REF_ON 0x1
+
+#define ADF4377_REF_SEL_DMA 0x0
+#define ADF4377_REF_SEL_LNA 0x1
+
+/* ADF4377 REG0020 Map */
+#define ADF4377_RST_SYS_MSK BIT(4)
+#define ADF4377_EN_ADC_CLK_MSK BIT(3)
+#define ADF4377_R020_RSV1_MSK BIT(0)
+
+/* ADF4377 REG0020 Bit Definition */
+#define ADF4377_RST_SYS_INACTIVE 0x0
+#define ADF4377_RST_SYS_ACTIVE 0x1
+
+#define ADF4377_EN_ADC_CLK_DIS 0x0
+#define ADF4377_EN_ADC_CLK_EN 0x1
+
+/* ADF4377 REG0021 Bit Definition */
+#define ADF4377_R021_RSV1 0xD3
+
+/* ADF4377 REG0022 Bit Definition */
+#define ADF4377_R022_RSV1 0x32
+
+/* ADF4377 REG0023 Map */
+#define ADF4377_CAT_CT_SEL BIT(7)
+#define ADF4377_R023_RSV1_MSK GENMASK(6, 0)
+
+/* ADF4377 REG0024 Map */
+#define ADF4377_DCLK_MODE_MSK BIT(2)
+
+/* ADF4377 REG0024 Bit Definition */
+#define ADF4377_DCLK_MODE_DIS 0x0
+#define ADF4377_DCLK_MODE_EN 0x1
+
+/* ADF4377 REG0025 Map */
+#define ADF4377_CLKODIV_DB_MSK BIT(7)
+#define ADF4377_DCLK_DB_MSK BIT(6)
+#define ADF4377_R025_RSV1_MSK GENMASK(5, 0)
+
+/* ADF4377 REG0025 Bit Definition */
+#define ADF4377_CLKODIV_DB_DIS 0x0
+#define ADF4377_CLKODIV_DB_EN 0x1
+
+#define ADF4377_DCLK_DIV_DB_DIS 0x0
+#define ADF4377_DCLK_DIV_DB_EN 0x1
+
+/* ADF4377 REG0026 Map */
+#define ADF4377_VCO_BAND_DIV_MSK GENMASK(7, 0)
+
+/* ADF4377 REG0027 Map */
+#define ADF4377_SYNTH_LOCK_TO_LSB_MSK GENMASK(7, 0)
+
+/* ADF4377 REG0028 Map */
+#define ADF4377_O_VCO_DB_MSK BIT(7)
+#define ADF4377_SYNTH_LOCK_TO_MSB_MSK GENMASK(6, 0)
+
+/* ADF4377 REG0028 Bit Definition */
+#define ADF4377_O_VCO_DB_DIS 0x0
+#define ADF4377_O_VCO_DB_EN 0x1
+
+/* ADF4377 REG0029 Map */
+#define ADF4377_VCO_ALC_TO_LSB_MSK GENMASK(7, 0)
+
+/* ADF4377 REG002A Map */
+#define ADF4377_DEL_CTRL_DB_MSK BIT(7)
+#define ADF4377_VCO_ALC_TO_MSB_MSK GENMASK(6, 0)
+
+/* ADF4377 REG002A Bit Definition */
+#define ADF4377_DEL_CTRL_DB_DIS 0x0
+#define ADF4377_DEL_CTRL_DB_EN 0x1
+
+/* ADF4377 REG002C Map */
+#define ADF4377_R02C_RSV1 0xC0
+
+/* ADF4377 REG002D Map */
+#define ADF4377_ADC_CLK_DIV_MSK GENMASK(7, 0)
+
+/* ADF4377 REG002E Map */
+#define ADF4377_EN_ADC_CNV_MSK BIT(7)
+#define ADF4377_EN_ADC_MSK BIT(1)
+#define ADF4377_ADC_A_CONV_MSK BIT(0)
+
+/* ADF4377 REG002E Bit Definition */
+#define ADF4377_EN_ADC_CNV_DIS 0x0
+#define ADF4377_EN_ADC_CNV_EN 0x1
+
+#define ADF4377_EN_ADC_DIS 0x0
+#define ADF4377_EN_ADC_EN 0x1
+
+#define ADF4377_ADC_A_CONV_ADC_ST_CNV 0x0
+#define ADF4377_ADC_A_CONV_VCO_CALIB 0x1
+
+/* ADF4377 REG002F Map */
+#define ADF4377_DCLK_DIV1_MSK GENMASK(1, 0)
+
+/* ADF4377 REG002F Bit Definition */
+#define ADF4377_DCLK_DIV1_1 0x0
+#define ADF4377_DCLK_DIV1_2 0x1
+#define ADF4377_DCLK_DIV1_8 0x2
+#define ADF4377_DCLK_DIV1_32 0x3
+
+/* ADF4377 REG0031 Bit Definition */
+#define ADF4377_R031_RSV1 0x09
+
+/* ADF4377 REG0032 Map */
+#define ADF4377_ADC_CLK_SEL_MSK BIT(6)
+#define ADF4377_R032_RSV1_MSK GENMASK(5, 0)
+
+/* ADF4377 REG0032 Bit Definition */
+#define ADF4377_R032_RSV1 0x9
+
+/* ADF4377 REG0032 Bit Definition */
+#define ADF4377_ADC_CLK_SEL_N_OP 0x0
+#define ADF4377_ADC_CLK_SEL_SPI_CLK 0x1
+
+/* ADF4377 REG0033 Bit Definition */
+#define ADF4377_R033_RSV1 0x18
+
+/* ADF4377 REG0034 Bit Definition */
+#define ADF4377_R034_RSV1 0x08
+
+/* ADF4377 REG003A Bit Definition */
+#define ADF4377_R03A_RSV1 0x5D
+
+/* ADF4377 REG003B Bit Definition */
+#define ADF4377_R03B_RSV1 0x2B
+
+/* ADF4377 REG003D Map */
+#define ADF4377_O_VCO_BAND_MSK BIT(3)
+#define ADF4377_O_VCO_CORE_MSK BIT(2)
+#define ADF4377_O_VCO_BIAS_MSK BIT(1)
+
+/* ADF4377 REG003D Bit Definition */
+#define ADF4377_O_VCO_BAND_VCO_CALIB 0x0
+#define ADF4377_O_VCO_BAND_M_VCO 0x1
+
+#define ADF4377_O_VCO_CORE_VCO_CALIB 0x0
+#define ADF4377_O_VCO_CORE_M_VCO 0x1
+
+#define ADF4377_O_VCO_BIAS_VCO_CALIB 0x0
+#define ADF4377_O_VCO_BIAS_M_VCO 0x1
+
+/* ADF4377 REG0042 Map */
+#define ADF4377_R042_RSV1 0x05
+
+/* ADF4377 REG0045 Map */
+#define ADF4377_ADC_ST_CNV_MSK BIT(0)
+
+/* ADF4377 REG0045 Bit Definition */
+#define ADF4377_ADC_ST_ADC_DIS 0x0
+#define ADF4377_ADC_ST_ADC_EN 0x1
+
+/* ADF4377 REG0049 Map */
+#define ADF4377_EN_CLK2_MSK BIT(7)
+#define ADF4377_EN_CLK1_MSK BIT(6)
+#define ADF4377_REF_OK_MSK BIT(3)
+#define ADF4377_ADC_BUSY_MSK BIT(2)
+#define ADF4377_FSM_BUSY_MSK BIT(1)
+#define ADF4377_LOCKED_MSK BIT(0)
+
+/* ADF4377 REG004B Map */
+#define ADF4377_VCO_CORE_MSK GENMASK(1, 0)
+
+/* ADF4377 REG004C Map */
+#define ADF4377_CHIP_TEMP_LSB_MSK GENMASK(7, 0)
+
+/* ADF4377 REG004D Map */
+#define ADF4377_CHIP_TEMP_MSB_MSK BIT(0)
+
+/* ADF4377 REG004F Map */
+#define ADF4377_VCO_BAND_MSK GENMASK(7, 0)
+
+/* ADF4377 REG0051 Map */
+#define ADF4377_VCO_BIAS_MSK GENMASK(3, 0)
+
+/* ADF4377 REG0054 Map */
+#define ADF4377_CHIP_VERSION_MSK GENMASK(7, 0)
+
+/* Specifications */
+#define ADF4377_SPI_READ_CMD BIT(7)
+#define ADF4377_MAX_VCO_FREQ (12800ULL * HZ_PER_MHZ)
+#define ADF4377_MIN_VCO_FREQ (6400ULL * HZ_PER_MHZ)
+#define ADF4377_MAX_REFIN_FREQ (1000 * HZ_PER_MHZ)
+#define ADF4377_MIN_REFIN_FREQ (10 * HZ_PER_MHZ)
+#define ADF4377_MAX_FREQ_PFD (500 * HZ_PER_MHZ)
+#define ADF4377_MIN_FREQ_PFD (3 * HZ_PER_MHZ)
+#define ADF4377_MAX_CLKPN_FREQ ADF4377_MAX_VCO_FREQ
+#define ADF4377_MIN_CLKPN_FREQ (ADF4377_MIN_VCO_FREQ / 8)
+#define ADF4377_FREQ_PFD_80MHZ (80 * HZ_PER_MHZ)
+#define ADF4377_FREQ_PFD_125MHZ (125 * HZ_PER_MHZ)
+#define ADF4377_FREQ_PFD_160MHZ (160 * HZ_PER_MHZ)
+#define ADF4377_FREQ_PFD_250MHZ (250 * HZ_PER_MHZ)
+#define ADF4377_FREQ_PFD_320MHZ (320 * HZ_PER_MHZ)
+
+enum adf4377_dev_type {
+ ADF4377,
+ ADF4378,
+};
+
+enum {
+ ADF4377_FREQ,
+};
+
+enum muxout_select_modes {
+ ADF4377_MUXOUT_HIGH_Z = 0x0,
+ ADF4377_MUXOUT_LKDET = 0x1,
+ ADF4377_MUXOUT_LOW = 0x2,
+ ADF4377_MUXOUT_DIV_RCLK_2 = 0x4,
+ ADF4377_MUXOUT_DIV_NCLK_2 = 0x5,
+ ADF4377_MUXOUT_HIGH = 0x8,
+};
+
+struct adf4377_state {
+ struct spi_device *spi;
+ enum adf4377_dev_type type;
+ struct regmap *regmap;
+ struct clk *clkin;
+ /* Protect against concurrent accesses to the device and data content */
+ struct mutex lock;
+ struct notifier_block nb;
+ /* Reference Divider */
+ unsigned int ref_div_factor;
+ /* PFD Frequency */
+ unsigned int f_pfd;
+ /* Input Reference Clock */
+ unsigned int clkin_freq;
+ /* CLKOUT Divider */
+ u8 clkout_div_sel;
+ /* Feedback Divider (N) */
+ u16 n_int;
+ u16 synth_lock_timeout;
+ u16 vco_alc_timeout;
+ u16 adc_clk_div;
+ u16 vco_band_div;
+ u8 dclk_div1;
+ u8 dclk_div2;
+ u8 dclk_mode;
+ unsigned int f_div_rclk;
+ struct gpio_desc *gpio_ce;
+ struct gpio_desc *gpio_enclk1;
+ struct gpio_desc *gpio_enclk2;
+ u8 buf[2] ____cacheline_aligned;
+};
+
+static const char * const adf4377_muxout_modes[] = {
+ [ADF4377_MUXOUT_HIGH_Z] = "high_z",
+ [ADF4377_MUXOUT_LKDET] = "lock_detect",
+ [ADF4377_MUXOUT_LOW] = "muxout_low",
+ [ADF4377_MUXOUT_DIV_RCLK_2] = "f_div_rclk_2",
+ [ADF4377_MUXOUT_DIV_NCLK_2] = "f_div_nclk_2",
+ [ADF4377_MUXOUT_HIGH] = "muxout_high",
+};
+
+static const struct regmap_config adf4377_regmap_config = {
+ .reg_bits = 16,
+ .val_bits = 8,
+ .read_flag_mask = BIT(7),
+ .max_register = 0x54,
+};
+
+static int adf4377_reg_access(struct iio_dev *indio_dev,
+ unsigned int reg,
+ unsigned int write_val,
+ unsigned int *read_val)
+{
+ struct adf4377_state *st = iio_priv(indio_dev);
+
+ if (read_val)
+ return regmap_read(st->regmap, reg, read_val);
+
+ return regmap_write(st->regmap, reg, write_val);
+}
+
+static const struct iio_info adf4377_info = {
+ .debugfs_reg_access = &adf4377_reg_access,
+};
+
+static int adf4377_soft_reset(struct adf4377_state *st)
+{
+ unsigned int read_val;
+ int ret;
+
+ ret = regmap_update_bits(st->regmap, 0x0, ADF4377_SOFT_RESET_MSK |
+ ADF4377_SOFT_RESET_R_MSK,
+ FIELD_PREP(ADF4377_SOFT_RESET_MSK, 1) |
+ FIELD_PREP(ADF4377_SOFT_RESET_R_MSK, 1));
+ if (ret)
+ return ret;
+
+ return regmap_read_poll_timeout(st->regmap, 0x0, read_val,
+ !(read_val & (ADF4377_SOFT_RESET_R_MSK |
+ ADF4377_SOFT_RESET_R_MSK)), 200, 200 * 100);
+}
+
+static int adf4377_set_default(struct adf4377_state *st)
+{
+ int ret;
+
+ /* Set default registers bits */
+ ret = regmap_write(st->regmap, 0x42, ADF4377_R042_RSV1);
+ if (ret)
+ return ret;
+
+ ret = regmap_write(st->regmap, 0x3B, ADF4377_R03B_RSV1);
+ if (ret)
+ return ret;
+
+ ret = regmap_write(st->regmap, 0x3A, ADF4377_R03A_RSV1);
+ if (ret)
+ return ret;
+
+ ret = regmap_write(st->regmap, 0x34, ADF4377_R034_RSV1);
+ if (ret)
+ return ret;
+
+ ret = regmap_write(st->regmap, 0x33, ADF4377_R033_RSV1);
+ if (ret)
+ return ret;
+
+ ret = regmap_update_bits(st->regmap, 0x32, ADF4377_R032_RSV1_MSK,
+ FIELD_PREP(ADF4377_R032_RSV1_MSK, 0x9));
+ if (ret)
+ return ret;
+
+ ret = regmap_write(st->regmap, 0x31, ADF4377_R031_RSV1);
+ if (ret)
+ return ret;
+
+ ret = regmap_write(st->regmap, 0x2C, ADF4377_R02C_RSV1);
+ if (ret)
+ return ret;
+
+ ret = regmap_update_bits(st->regmap, 0x25, ADF4377_R025_RSV1_MSK,
+ FIELD_PREP(ADF4377_R025_RSV1_MSK, 0x16));
+ if (ret)
+ return ret;
+
+ ret = regmap_update_bits(st->regmap, 0x23, ADF4377_R023_RSV1_MSK,
+ FIELD_PREP(ADF4377_R023_RSV1_MSK, 0x18));
+ if (ret)
+ return ret;
+
+ ret = regmap_write(st->regmap, 0x22, ADF4377_R022_RSV1);
+ if (ret)
+ return ret;
+
+ ret = regmap_write(st->regmap, 0x21, ADF4377_R021_RSV1);
+ if (ret)
+ return ret;
+
+ ret = regmap_update_bits(st->regmap, 0x1f, ADF4377_R01F_RSV1_MSK,
+ FIELD_PREP(ADF4377_R01F_RSV1_MSK, 0x7));
+ if (ret)
+ return ret;
+
+ return regmap_update_bits(st->regmap, 0x1c, ADF4377_R01C_RSV1_MSK,
+ FIELD_PREP(ADF4377_R01C_RSV1_MSK, 0x1));
+}
+
+int adf4377_get_freq(struct adf4377_state *st, u64 *freq)
+{
+ unsigned int ref_div_factor, n_int;
+ u64 clkin_freq;
+ int ret;
+
+ mutex_lock(&st->lock);
+ ret = regmap_read(st->regmap, 0x12, &ref_div_factor);
+ if (ret)
+ goto exit;
+
+ ret = regmap_bulk_read(st->regmap, 0x10, st->buf, sizeof(st->buf));
+ if (ret)
+ goto exit;
+
+ clkin_freq = clk_get_rate(st->clkin);
+ ref_div_factor = FIELD_GET(ADF4377_R_DIV_MSK, ref_div_factor);
+ n_int = FIELD_GET(ADF4377_N_INT_LSB_MSK, st->buf[0]) |
+ (FIELD_GET(ADF4377_N_INT_MSB_MSK, st->buf[1]) << 8);
+
+ *freq = div_u64(clkin_freq, ref_div_factor) * n_int;
+exit:
+ mutex_unlock(&st->lock);
+
+ return ret;
+}
+
+int adf4377_set_freq(struct adf4377_state *st, u64 freq)
+{
+ unsigned int read_val;
+ u64 f_vco;
+ int ret;
+
+ ret = regmap_update_bits(st->regmap, 0x1C, ADF4377_EN_DNCLK_MSK | ADF4377_EN_DRCLK_MSK,
+ FIELD_PREP(ADF4377_EN_DNCLK_MSK, ADF4377_EN_DNCLK_ON) |
+ FIELD_PREP(ADF4377_EN_DRCLK_MSK, ADF4377_EN_DRCLK_ON));
+ if (ret)
+ return ret;
+
+ ret = regmap_update_bits(st->regmap, 0x11, ADF4377_EN_AUTOCAL_MSK | ADF4377_DCLK_DIV2_MSK,
+ FIELD_PREP(ADF4377_EN_AUTOCAL_MSK, ADF4377_VCO_CALIB_EN) |
+ FIELD_PREP(ADF4377_DCLK_DIV2_MSK, st->dclk_div2));
+ if (ret)
+ return ret;
+
+ ret = regmap_update_bits(st->regmap, 0x2E, ADF4377_EN_ADC_CNV_MSK | ADF4377_EN_ADC_MSK |
+ ADF4377_ADC_A_CONV_MSK,
+ FIELD_PREP(ADF4377_EN_ADC_CNV_MSK, ADF4377_EN_ADC_CNV_EN) |
+ FIELD_PREP(ADF4377_EN_ADC_MSK, ADF4377_EN_ADC_EN) |
+ FIELD_PREP(ADF4377_ADC_A_CONV_MSK, ADF4377_ADC_A_CONV_VCO_CALIB));
+ if (ret)
+ return ret;
+
+ ret = regmap_update_bits(st->regmap, 0x20, ADF4377_EN_ADC_CLK_MSK,
+ FIELD_PREP(ADF4377_EN_ADC_CLK_MSK, ADF4377_EN_ADC_CLK_EN));
+ if (ret)
+ return ret;
+
+ ret = regmap_update_bits(st->regmap, 0x2F, ADF4377_DCLK_DIV1_MSK,
+ FIELD_PREP(ADF4377_DCLK_DIV1_MSK, st->dclk_div1));
+ if (ret)
+ return ret;
+
+ ret = regmap_update_bits(st->regmap, 0x24, ADF4377_DCLK_MODE_MSK,
+ FIELD_PREP(ADF4377_DCLK_MODE_MSK, st->dclk_mode));
+ if (ret)
+ return ret;
+
+ ret = regmap_write(st->regmap, 0x27,
+ FIELD_PREP(ADF4377_SYNTH_LOCK_TO_LSB_MSK, st->synth_lock_timeout));
+ if (ret)
+ return ret;
+
+ ret = regmap_update_bits(st->regmap, 0x28, ADF4377_SYNTH_LOCK_TO_MSB_MSK,
+ FIELD_PREP(ADF4377_SYNTH_LOCK_TO_MSB_MSK,
+ st->synth_lock_timeout >> 8));
+ if (ret)
+ return ret;
+
+ ret = regmap_write(st->regmap, 0x29,
+ FIELD_PREP(ADF4377_VCO_ALC_TO_LSB_MSK, st->vco_alc_timeout));
+ if (ret)
+ return ret;
+
+ ret = regmap_update_bits(st->regmap, 0x2A, ADF4377_VCO_ALC_TO_MSB_MSK,
+ FIELD_PREP(ADF4377_VCO_ALC_TO_MSB_MSK, st->vco_alc_timeout >> 8));
+ if (ret)
+ return ret;
+
+ ret = regmap_write(st->regmap, 0x26,
+ FIELD_PREP(ADF4377_VCO_BAND_DIV_MSK, st->vco_band_div));
+ if (ret)
+ return ret;
+
+ ret = regmap_write(st->regmap, 0x2D,
+ FIELD_PREP(ADF4377_ADC_CLK_DIV_MSK, st->adc_clk_div));
+ if (ret)
+ return ret;
+
+ st->clkout_div_sel = 0;
+
+ if (freq > ADF4377_MAX_CLKPN_FREQ || freq < ADF4377_MIN_CLKPN_FREQ) {
+ ret = -EINVAL;
+ return ret;
+ }
+
+ f_vco = freq;
+
+ while (f_vco < ADF4377_MIN_VCO_FREQ) {
+ f_vco <<= 1;
+ st->clkout_div_sel++;
+ }
+
+ st->n_int = div_u64(freq, st->f_pfd);
+
+ ret = regmap_update_bits(st->regmap, 0x11, ADF4377_EN_RDBLR_MSK | ADF4377_N_INT_MSB_MSK,
+ FIELD_PREP(ADF4377_EN_RDBLR_MSK, ADF4377_REF_DBLR_DIS) |
+ FIELD_PREP(ADF4377_N_INT_MSB_MSK, st->n_int >> 8));
+ if (ret)
+ return ret;
+
+ ret = regmap_update_bits(st->regmap, 0x12, ADF4377_R_DIV_MSK | ADF4377_CLKOUT_DIV_MSK,
+ FIELD_PREP(ADF4377_CLKOUT_DIV_MSK, st->clkout_div_sel) |
+ FIELD_PREP(ADF4377_R_DIV_MSK, st->ref_div_factor));
+ if (ret)
+ return ret;
+
+ ret = regmap_write(st->regmap, 0x10,
+ FIELD_PREP(ADF4377_N_INT_LSB_MSK, st->n_int));
+ if (ret)
+ return ret;
+
+ ret = regmap_read_poll_timeout(st->regmap, 0x49, read_val,
+ !(read_val & (ADF4377_FSM_BUSY_MSK)), 200, 200 * 100);
+ if (ret)
+ return ret;
+
+ /* Disable EN_DNCLK, EN_DRCLK */
+ ret = regmap_update_bits(st->regmap, 0x1C, ADF4377_EN_DNCLK_MSK | ADF4377_EN_DRCLK_MSK,
+ FIELD_PREP(ADF4377_EN_DNCLK_MSK, ADF4377_EN_DNCLK_OFF) |
+ FIELD_PREP(ADF4377_EN_DRCLK_MSK, ADF4377_EN_DRCLK_OFF));
+ if (ret)
+ return ret;
+
+ /* Disable EN_ADC_CLK */
+ ret = regmap_update_bits(st->regmap, 0x20, ADF4377_EN_ADC_CLK_MSK,
+ FIELD_PREP(ADF4377_EN_ADC_CLK_MSK, ADF4377_EN_ADC_CLK_DIS));
+ if (ret)
+ return ret;
+
+ /* Set output Amplitude */
+ return regmap_update_bits(st->regmap, 0x19, ADF4377_CLKOUT2_OP_MSK | ADF4377_CLKOUT1_OP_MSK,
+ FIELD_PREP(ADF4377_CLKOUT1_OP_MSK, ADF4377_CLKOUT_420MV) |
+ FIELD_PREP(ADF4377_CLKOUT2_OP_MSK, ADF4377_CLKOUT_420MV));
+}
+
+static void adf4377_gpio_init(struct adf4377_state *st)
+{
+ if (st->gpio_ce) {
+ gpiod_set_value(st->gpio_ce, 1);
+
+ /* Delay for SPI register bits to settle to their power-on reset state */
+ usleep_range(200, 250);
+ }
+
+ if (st->gpio_enclk1)
+ gpiod_set_value(st->gpio_enclk1, 1);
+
+ if (st->gpio_enclk2 && st->type == ADF4377)
+ gpiod_set_value(st->gpio_enclk2, 1);
+}
+
+static int adf4377_init(struct adf4377_state *st)
+{
+ int ret;
+
+ /* GPIO Inititalization */
+ adf4377_gpio_init(st);
+
+ /* Software reset */
+ ret = adf4377_soft_reset(st);
+ if (ret)
+ return ret;
+
+ /* Set Default Registers */
+ ret = adf4377_set_default(st);
+ if (ret)
+ return ret;
+
+ ret = regmap_update_bits(st->regmap, 0x15, ADF4377_CP_I_MSK,
+ FIELD_PREP(ADF4377_CP_I_MSK, ADF4377_CP_10MA1));
+ if (ret)
+ return ret;
+
+ ret = regmap_update_bits(st->regmap, 0x00,
+ ADF4377_SDO_ACTIVE_MSK | ADF4377_SDO_ACTIVE_R_MSK,
+ FIELD_PREP(ADF4377_SDO_ACTIVE_MSK, ADF4377_SDO_ACTIVE_SPI_4W) |
+ FIELD_PREP(ADF4377_SDO_ACTIVE_R_MSK, ADF4377_SDO_ACTIVE_SPI_4W));
+ if (ret)
+ return ret;
+
+ st->clkin_freq = clk_get_rate(st->clkin);
+
+ /* Power Up */
+ ret = regmap_write(st->regmap, 0x1a,
+ FIELD_PREP(ADF4377_PD_ALL_MSK, ADF4377_PD_ALL_N_OP) |
+ FIELD_PREP(ADF4377_PD_RDIV_MSK, ADF4377_PD_RDIV_N_OP) |
+ FIELD_PREP(ADF4377_PD_NDIV_MSK, ADF4377_PD_NDIV_N_OP) |
+ FIELD_PREP(ADF4377_PD_VCO_MSK, ADF4377_PD_VCO_N_OP) |
+ FIELD_PREP(ADF4377_PD_LD_MSK, ADF4377_PD_LD_N_OP) |
+ FIELD_PREP(ADF4377_PD_PFDCP_MSK, ADF4377_PD_PFDCP_N_OP) |
+ FIELD_PREP(ADF4377_PD_CLKOUT1_MSK, ADF4377_PD_CLKOUT1_N_OP) |
+ FIELD_PREP(ADF4377_PD_CLKOUT2_MSK, ADF4377_PD_CLKOUT2_N_OP));
+ if (ret)
+ return ret;
+
+ /* Compute PFD */
+ st->ref_div_factor = 0;
+ do {
+ st->ref_div_factor++;
+ st->f_pfd = st->clkin_freq / st->ref_div_factor;
+ } while (st->f_pfd > ADF4377_MAX_FREQ_PFD);
+
+ if (st->f_pfd > ADF4377_MAX_FREQ_PFD || st->f_pfd < ADF4377_MIN_FREQ_PFD)
+ return -EINVAL;
+
+ st->f_div_rclk = st->f_pfd;
+
+ if (st->f_pfd <= ADF4377_FREQ_PFD_80MHZ) {
+ st->dclk_div1 = ADF4377_DCLK_DIV1_1;
+ st->dclk_div2 = ADF4377_DCLK_DIV2_1;
+ st->dclk_mode = ADF4377_DCLK_MODE_DIS;
+ } else if (st->f_pfd <= ADF4377_FREQ_PFD_125MHZ) {
+ st->dclk_div1 = ADF4377_DCLK_DIV1_1;
+ st->dclk_div2 = ADF4377_DCLK_DIV2_1;
+ st->dclk_mode = ADF4377_DCLK_MODE_EN;
+ } else if (st->f_pfd <= ADF4377_FREQ_PFD_160MHZ) {
+ st->dclk_div1 = ADF4377_DCLK_DIV1_2;
+ st->dclk_div2 = ADF4377_DCLK_DIV2_1;
+ st->dclk_mode = ADF4377_DCLK_MODE_DIS;
+ st->f_div_rclk /= 2;
+ } else if (st->f_pfd <= ADF4377_FREQ_PFD_250MHZ) {
+ st->dclk_div1 = ADF4377_DCLK_DIV1_2;
+ st->dclk_div2 = ADF4377_DCLK_DIV2_1;
+ st->dclk_mode = ADF4377_DCLK_MODE_EN;
+ st->f_div_rclk /= 2;
+ } else if (st->f_pfd <= ADF4377_FREQ_PFD_320MHZ) {
+ st->dclk_div1 = ADF4377_DCLK_DIV1_2;
+ st->dclk_div2 = ADF4377_DCLK_DIV2_2;
+ st->dclk_mode = ADF4377_DCLK_MODE_DIS;
+ st->f_div_rclk /= 4;
+ } else {
+ st->dclk_div1 = ADF4377_DCLK_DIV1_2;
+ st->dclk_div2 = ADF4377_DCLK_DIV2_2;
+ st->dclk_mode = ADF4377_DCLK_MODE_EN;
+ st->f_div_rclk /= 4;
+ }
+
+ st->synth_lock_timeout = DIV_ROUND_UP(st->f_div_rclk, 50000);
+ st->vco_alc_timeout = DIV_ROUND_UP(st->f_div_rclk, 20000);
+ st->vco_band_div = DIV_ROUND_UP(st->f_div_rclk, 150000 * 16 * (1 << st->dclk_mode));
+ st->adc_clk_div = DIV_ROUND_UP((st->f_div_rclk / 400000 - 2), 4);
+
+ return 0;
+}
+
+static ssize_t adf4377_read(struct iio_dev *indio_dev, uintptr_t private,
+ const struct iio_chan_spec *chan, char *buf)
+{
+ struct adf4377_state *st = iio_priv(indio_dev);
+ u64 val = 0;
+ int ret;
+
+ switch ((u32)private) {
+ case ADF4377_FREQ:
+ ret = adf4377_get_freq(st, &val);
+ break;
+ default:
+ ret = -EINVAL;
+ val = 0;
+ break;
+ }
+
+ return ret ?: sysfs_emit(buf, "%llu\n", val);
+}
+
+static ssize_t adf4377_write(struct iio_dev *indio_dev, uintptr_t private,
+ const struct iio_chan_spec *chan, const char *buf,
+ size_t len)
+{
+ struct adf4377_state *st = iio_priv(indio_dev);
+ unsigned long long freq;
+ int ret;
+
+ mutex_lock(&st->lock);
+ switch ((u32)private) {
+ case ADF4377_FREQ:
+ ret = kstrtoull(buf, 10, &freq);
+ if (ret)
+ break;
+
+ ret = adf4377_set_freq(st, freq);
+ break;
+ default:
+ ret = -EINVAL;
+ break;
+ }
+
+ mutex_unlock(&st->lock);
+
+ return ret ? ret : len;
+}
+
+static int adf4377_set_muxout_mode(struct iio_dev *indio_dev,
+ const struct iio_chan_spec *chan,
+ unsigned int mode)
+{
+ struct adf4377_state *st = iio_priv(indio_dev);
+
+ return regmap_update_bits(st->regmap, 0x1D,
+ ADF4377_MUXOUT_MSK,
+ FIELD_PREP(ADF4377_MUXOUT_MSK, mode));
+}
+
+static int adf4377_get_muxout_mode(struct iio_dev *indio_dev,
+ const struct iio_chan_spec *chan)
+{
+ struct adf4377_state *st = iio_priv(indio_dev);
+ unsigned int mode;
+ int ret;
+
+ ret = regmap_read(st->regmap, 0x1D, &mode);
+
+ return ret ? : FIELD_GET(ADF4377_MUXOUT_MSK, mode);
+}
+
+static const struct iio_enum adf4377_muxout_enum = {
+ .items = adf4377_muxout_modes,
+ .num_items = ARRAY_SIZE(adf4377_muxout_modes),
+ .get = adf4377_get_muxout_mode,
+ .set = adf4377_set_muxout_mode,
+};
+
+#define _ADF4377_EXT_INFO(_name, _shared, _ident) { \
+ .name = _name, \
+ .read = adf4377_read, \
+ .write = adf4377_write, \
+ .private = _ident, \
+ .shared = _shared, \
+ }
+
+static const struct iio_chan_spec_ext_info adf4377_ext_info[] = {
+ /*
+ * Usually we use IIO_CHAN_INFO_FREQUENCY, but there are
+ * values > 2^32 in order to support the entire frequency range
+ * in Hz.
+ */
+ _ADF4377_EXT_INFO("frequency", IIO_SHARED_BY_ALL, ADF4377_FREQ),
+ IIO_ENUM("muxout_select", IIO_SHARED_BY_ALL, &adf4377_muxout_enum),
+ IIO_ENUM_AVAILABLE("muxout_select", IIO_SHARED_BY_ALL, &adf4377_muxout_enum),
+ { },
+};
+
+static const struct iio_chan_spec adf4377_channels[] = {
+ {
+ .type = IIO_ALTVOLTAGE,
+ .indexed = 1,
+ .output = 1,
+ .channel = 0,
+ .ext_info = adf4377_ext_info,
+ },
+};
+
+static int adf4377_properties_parse(struct adf4377_state *st)
+{
+ struct spi_device *spi = st->spi;
+
+ st->clkin = devm_clk_get(&spi->dev, "ref_in");
+ if (IS_ERR(st->clkin))
+ return dev_err_probe(&spi->dev, PTR_ERR(st->clkin),
+ "failed to get the reference input clock\n");
+
+ st->gpio_ce = devm_gpiod_get_optional(&st->spi->dev, "ce-en",
+ GPIOD_OUT_HIGH);
+ if (IS_ERR(st->gpio_ce))
+ return dev_err_probe(&spi->dev, PTR_ERR(st->gpio_ce),
+ "failed to get the CE GPIO\n");
+
+ st->gpio_enclk1 = devm_gpiod_get_optional(&st->spi->dev, "enclk1",
+ GPIOD_OUT_HIGH);
+ if (IS_ERR(st->gpio_enclk1))
+ return dev_err_probe(&spi->dev, PTR_ERR(st->gpio_enclk1),
+ "failed to get the CE GPIO\n");
+
+ if (st->type == ADF4377) {
+ st->gpio_enclk2 = devm_gpiod_get_optional(&st->spi->dev, "enclk2",
+ GPIOD_OUT_HIGH);
+ if (IS_ERR(st->gpio_enclk2))
+ return dev_err_probe(&spi->dev, PTR_ERR(st->gpio_enclk2),
+ "failed to get the CE GPIO\n");
+ }
+
+ return 0;
+}
+
+static int adf4377_freq_change(struct notifier_block *nb, unsigned long action, void *data)
+{
+ struct adf4377_state *st = container_of(nb, struct adf4377_state, nb);
+ int ret;
+
+ if (action == POST_RATE_CHANGE) {
+ mutex_lock(&st->lock);
+ ret = notifier_from_errno(adf4377_init(st));
+ mutex_unlock(&st->lock);
+ return ret;
+ }
+
+ return NOTIFY_OK;
+}
+
+static void adf4377_clk_disable(void *data)
+{
+ clk_disable_unprepare(data);
+}
+
+static int adf4377_probe(struct spi_device *spi)
+{
+ struct iio_dev *indio_dev;
+ struct regmap *regmap;
+ struct adf4377_state *st;
+ int ret;
+
+ indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*st));
+ if (!indio_dev)
+ return -ENOMEM;
+
+ regmap = devm_regmap_init_spi(spi, &adf4377_regmap_config);
+ if (IS_ERR(regmap))
+ return PTR_ERR(regmap);
+
+ st = iio_priv(indio_dev);
+
+ indio_dev->info = &adf4377_info;
+ indio_dev->name = "adf4377";
+ indio_dev->channels = adf4377_channels;
+ indio_dev->num_channels = ARRAY_SIZE(adf4377_channels);
+
+ st->regmap = regmap;
+ st->spi = spi;
+ st->type = spi_get_device_id(spi)->driver_data;
+ mutex_init(&st->lock);
+
+ ret = adf4377_properties_parse(st);
+ if (ret)
+ return ret;
+
+ ret = clk_prepare_enable(st->clkin);
+ if (ret)
+ return ret;
+
+ ret = devm_add_action_or_reset(&spi->dev, adf4377_clk_disable, st->clkin);
+ if (ret)
+ return ret;
+
+ st->nb.notifier_call = adf4377_freq_change;
+ ret = devm_clk_notifier_register(&spi->dev, st->clkin, &st->nb);
+ if (ret)
+ return ret;
+
+ ret = adf4377_init(st);
+ if (ret) {
+ dev_err(&spi->dev, "adf4377 init failed\n");
+ return ret;
+ }
+
+ return devm_iio_device_register(&spi->dev, indio_dev);
+}
+
+static const struct spi_device_id adf4377_id[] = {
+ { "adf4377", ADF4377 },
+ { "adf4378", ADF4378 },
+ {},
+};
+MODULE_DEVICE_TABLE(spi, adf4377_id);
+
+static const struct of_device_id adf4377_of_match[] = {
+ { .compatible = "adi,adf4377" },
+ { .compatible = "adi,adf4378" },
+ {},
+};
+MODULE_DEVICE_TABLE(of, adf4377_of_match);
+
+static struct spi_driver adf4377_driver = {
+ .driver = {
+ .name = "adf4377",
+ .of_match_table = adf4377_of_match,
+ },
+ .probe = adf4377_probe,
+ .id_table = adf4377_id,
+};
+module_spi_driver(adf4377_driver);
+
+MODULE_AUTHOR("Antoniu Miclaus <[email protected]>");
+MODULE_DESCRIPTION("Analog Devices ADF4377");
+MODULE_LICENSE("GPL");
--
2.38.1
Le 04/11/2022 à 10:28, Antoniu Miclaus a écrit :
> The ADF4377 is a high performance, ultralow jitter, dual output integer-N
> phased locked loop (PLL) with integrated voltage controlled oscillator
> (VCO) ideally suited for data converter and mixed signal front end (MxFE)
> clock applications.
>
> Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/adf4377.pdf
> Signed-off-by: Antoniu Miclaus <[email protected]>
> ---
[]
> +static int adf4377_properties_parse(struct adf4377_state *st)
> +{
> + struct spi_device *spi = st->spi;
> +
> + st->clkin = devm_clk_get(&spi->dev, "ref_in");
Hi,
this could be devm_clk_get_enabled() in order to...
> + if (IS_ERR(st->clkin))
> + return dev_err_probe(&spi->dev, PTR_ERR(st->clkin),
> + "failed to get the reference input clock\n");
> +
> + st->gpio_ce = devm_gpiod_get_optional(&st->spi->dev, "ce-en",
> + GPIOD_OUT_HIGH);
> + if (IS_ERR(st->gpio_ce))
> + return dev_err_probe(&spi->dev, PTR_ERR(st->gpio_ce),
> + "failed to get the CE GPIO\n");
> +
> + st->gpio_enclk1 = devm_gpiod_get_optional(&st->spi->dev, "enclk1",
> + GPIOD_OUT_HIGH);
> + if (IS_ERR(st->gpio_enclk1))
> + return dev_err_probe(&spi->dev, PTR_ERR(st->gpio_enclk1),
> + "failed to get the CE GPIO\n");
> +
> + if (st->type == ADF4377) {
> + st->gpio_enclk2 = devm_gpiod_get_optional(&st->spi->dev, "enclk2",
> + GPIOD_OUT_HIGH);
> + if (IS_ERR(st->gpio_enclk2))
> + return dev_err_probe(&spi->dev, PTR_ERR(st->gpio_enclk2),
> + "failed to get the CE GPIO\n");
> + }
> +
> + return 0;
> +}
> +
> +static int adf4377_freq_change(struct notifier_block *nb, unsigned long action, void *data)
> +{
> + struct adf4377_state *st = container_of(nb, struct adf4377_state, nb);
> + int ret;
> +
> + if (action == POST_RATE_CHANGE) {
> + mutex_lock(&st->lock);
> + ret = notifier_from_errno(adf4377_init(st));
> + mutex_unlock(&st->lock);
> + return ret;
> + }
> +
> + return NOTIFY_OK;
> +}
> +
> +static void adf4377_clk_disable(void *data)
> +{
> + clk_disable_unprepare(data);
> +}
... remove this...
> +
> +static int adf4377_probe(struct spi_device *spi)
> +{
> + struct iio_dev *indio_dev;
> + struct regmap *regmap;
> + struct adf4377_state *st;
> + int ret;
> +
> + indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*st));
> + if (!indio_dev)
> + return -ENOMEM;
> +
> + regmap = devm_regmap_init_spi(spi, &adf4377_regmap_config);
> + if (IS_ERR(regmap))
> + return PTR_ERR(regmap);
> +
> + st = iio_priv(indio_dev);
> +
> + indio_dev->info = &adf4377_info;
> + indio_dev->name = "adf4377";
> + indio_dev->channels = adf4377_channels;
> + indio_dev->num_channels = ARRAY_SIZE(adf4377_channels);
> +
> + st->regmap = regmap;
> + st->spi = spi;
> + st->type = spi_get_device_id(spi)->driver_data;
> + mutex_init(&st->lock);
> +
> + ret = adf4377_properties_parse(st);
> + if (ret)
> + return ret;
> +
> + ret = clk_prepare_enable(st->clkin);
> + if (ret)
> + return ret;
... and this...
> +
> + ret = devm_add_action_or_reset(&spi->dev, adf4377_clk_disable, st->clkin);
> + if (ret)
> + return ret;
... and this.
CJ
> +
> + st->nb.notifier_call = adf4377_freq_change;
> + ret = devm_clk_notifier_register(&spi->dev, st->clkin, &st->nb);
> + if (ret)
> + return ret;
> +
> + ret = adf4377_init(st);
> + if (ret) {
> + dev_err(&spi->dev, "adf4377 init failed\n");
> + return ret;
> + }
> +
> + return devm_iio_device_register(&spi->dev, indio_dev);
> +}
[]
On Fri, 2022-11-04 at 11:28 +0200, Antoniu Miclaus wrote:
> Add myself as maintainer for the ADF4377 driver.
>
> Signed-off-by: Antoniu Miclaus <[email protected]>
> ---
> MAINTAINERS | 8 ++++++++
> 1 file changed, 8 insertions(+)
>
> diff --git a/MAINTAINERS b/MAINTAINERS
> index e1bc31a6624b..19a2f689e43e 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -1189,6 +1189,14 @@
> W: https://ez.analog.com/linux-software-drivers
> F: Documentation/devicetree/bindings/iio/amplifiers/adi,ada4250.
> yaml
> F: drivers/iio/amplifiers/ada4250.c
>
> +ANALOG DEVICES INC ADF4377 DRIVER
> +M: Antoniu Miclaus <[email protected]>
> +L: [email protected]
> +S: Supported
> +W: https://ez.analog.com/linux-software-drivers
> +F: Documentation/devicetree/bindings/iio/frequency/adi,adf4377.y
> aml
> +F: drivers/iio/frequency/adf4377.c
> +
> ANALOG DEVICES INC ADGS1408 DRIVER
> M: Mircea Caprioru <[email protected]>
> S: Supported
I think this file should be already added on patch 1 where the only
file would obviously be adi,adf4377.yaml.
I believe checkpatch should complain about this?
- Nuno Sá
Hi Antoniu,
I love your patch! Perhaps something to improve:
[auto build test WARNING on jic23-iio/togreg]
[also build test WARNING on robh/for-next linus/master v6.1-rc3 next-20221104]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]
url: https://github.com/intel-lab-lkp/linux/commits/Antoniu-Miclaus/dt-bindings-iio-frequency-add-adf4377-doc/20221104-182826
base: https://git.kernel.org/pub/scm/linux/kernel/git/jic23/iio.git togreg
patch link: https://lore.kernel.org/r/20221104092802.90725-3-antoniu.miclaus%40analog.com
patch subject: [PATCH 2/4] iio: frequency: adf4377: add support for ADF4377
config: sparc-allyesconfig
compiler: sparc64-linux-gcc (GCC) 12.1.0
reproduce (this is a W=1 build):
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross
chmod +x ~/bin/make.cross
# https://github.com/intel-lab-lkp/linux/commit/3ededf4b65510d3944acd01c6c88717fd7669561
git remote add linux-review https://github.com/intel-lab-lkp/linux
git fetch --no-tags linux-review Antoniu-Miclaus/dt-bindings-iio-frequency-add-adf4377-doc/20221104-182826
git checkout 3ededf4b65510d3944acd01c6c88717fd7669561
# save the config file
mkdir build_dir && cp config build_dir/.config
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-12.1.0 make.cross W=1 O=build_dir ARCH=sparc SHELL=/bin/bash drivers/iio/
If you fix the issue, kindly add following tag where applicable
| Reported-by: kernel test robot <[email protected]>
All warnings (new ones prefixed by >>):
>> drivers/iio/frequency/adf4377.c:650:5: warning: no previous prototype for 'adf4377_get_freq' [-Wmissing-prototypes]
650 | int adf4377_get_freq(struct adf4377_state *st, u64 *freq)
| ^~~~~~~~~~~~~~~~
>> drivers/iio/frequency/adf4377.c:677:5: warning: no previous prototype for 'adf4377_set_freq' [-Wmissing-prototypes]
677 | int adf4377_set_freq(struct adf4377_state *st, u64 freq)
| ^~~~~~~~~~~~~~~~
vim +/adf4377_get_freq +650 drivers/iio/frequency/adf4377.c
649
> 650 int adf4377_get_freq(struct adf4377_state *st, u64 *freq)
651 {
652 unsigned int ref_div_factor, n_int;
653 u64 clkin_freq;
654 int ret;
655
656 mutex_lock(&st->lock);
657 ret = regmap_read(st->regmap, 0x12, &ref_div_factor);
658 if (ret)
659 goto exit;
660
661 ret = regmap_bulk_read(st->regmap, 0x10, st->buf, sizeof(st->buf));
662 if (ret)
663 goto exit;
664
665 clkin_freq = clk_get_rate(st->clkin);
666 ref_div_factor = FIELD_GET(ADF4377_R_DIV_MSK, ref_div_factor);
667 n_int = FIELD_GET(ADF4377_N_INT_LSB_MSK, st->buf[0]) |
668 (FIELD_GET(ADF4377_N_INT_MSB_MSK, st->buf[1]) << 8);
669
670 *freq = div_u64(clkin_freq, ref_div_factor) * n_int;
671 exit:
672 mutex_unlock(&st->lock);
673
674 return ret;
675 }
676
> 677 int adf4377_set_freq(struct adf4377_state *st, u64 freq)
678 {
679 unsigned int read_val;
680 u64 f_vco;
681 int ret;
682
683 ret = regmap_update_bits(st->regmap, 0x1C, ADF4377_EN_DNCLK_MSK | ADF4377_EN_DRCLK_MSK,
684 FIELD_PREP(ADF4377_EN_DNCLK_MSK, ADF4377_EN_DNCLK_ON) |
685 FIELD_PREP(ADF4377_EN_DRCLK_MSK, ADF4377_EN_DRCLK_ON));
686 if (ret)
687 return ret;
688
689 ret = regmap_update_bits(st->regmap, 0x11, ADF4377_EN_AUTOCAL_MSK | ADF4377_DCLK_DIV2_MSK,
690 FIELD_PREP(ADF4377_EN_AUTOCAL_MSK, ADF4377_VCO_CALIB_EN) |
691 FIELD_PREP(ADF4377_DCLK_DIV2_MSK, st->dclk_div2));
692 if (ret)
693 return ret;
694
695 ret = regmap_update_bits(st->regmap, 0x2E, ADF4377_EN_ADC_CNV_MSK | ADF4377_EN_ADC_MSK |
696 ADF4377_ADC_A_CONV_MSK,
697 FIELD_PREP(ADF4377_EN_ADC_CNV_MSK, ADF4377_EN_ADC_CNV_EN) |
698 FIELD_PREP(ADF4377_EN_ADC_MSK, ADF4377_EN_ADC_EN) |
699 FIELD_PREP(ADF4377_ADC_A_CONV_MSK, ADF4377_ADC_A_CONV_VCO_CALIB));
700 if (ret)
701 return ret;
702
703 ret = regmap_update_bits(st->regmap, 0x20, ADF4377_EN_ADC_CLK_MSK,
704 FIELD_PREP(ADF4377_EN_ADC_CLK_MSK, ADF4377_EN_ADC_CLK_EN));
705 if (ret)
706 return ret;
707
708 ret = regmap_update_bits(st->regmap, 0x2F, ADF4377_DCLK_DIV1_MSK,
709 FIELD_PREP(ADF4377_DCLK_DIV1_MSK, st->dclk_div1));
710 if (ret)
711 return ret;
712
713 ret = regmap_update_bits(st->regmap, 0x24, ADF4377_DCLK_MODE_MSK,
714 FIELD_PREP(ADF4377_DCLK_MODE_MSK, st->dclk_mode));
715 if (ret)
716 return ret;
717
718 ret = regmap_write(st->regmap, 0x27,
719 FIELD_PREP(ADF4377_SYNTH_LOCK_TO_LSB_MSK, st->synth_lock_timeout));
720 if (ret)
721 return ret;
722
723 ret = regmap_update_bits(st->regmap, 0x28, ADF4377_SYNTH_LOCK_TO_MSB_MSK,
724 FIELD_PREP(ADF4377_SYNTH_LOCK_TO_MSB_MSK,
725 st->synth_lock_timeout >> 8));
726 if (ret)
727 return ret;
728
729 ret = regmap_write(st->regmap, 0x29,
730 FIELD_PREP(ADF4377_VCO_ALC_TO_LSB_MSK, st->vco_alc_timeout));
731 if (ret)
732 return ret;
733
734 ret = regmap_update_bits(st->regmap, 0x2A, ADF4377_VCO_ALC_TO_MSB_MSK,
735 FIELD_PREP(ADF4377_VCO_ALC_TO_MSB_MSK, st->vco_alc_timeout >> 8));
736 if (ret)
737 return ret;
738
739 ret = regmap_write(st->regmap, 0x26,
740 FIELD_PREP(ADF4377_VCO_BAND_DIV_MSK, st->vco_band_div));
741 if (ret)
742 return ret;
743
744 ret = regmap_write(st->regmap, 0x2D,
745 FIELD_PREP(ADF4377_ADC_CLK_DIV_MSK, st->adc_clk_div));
746 if (ret)
747 return ret;
748
749 st->clkout_div_sel = 0;
750
751 if (freq > ADF4377_MAX_CLKPN_FREQ || freq < ADF4377_MIN_CLKPN_FREQ) {
752 ret = -EINVAL;
753 return ret;
754 }
755
756 f_vco = freq;
757
758 while (f_vco < ADF4377_MIN_VCO_FREQ) {
759 f_vco <<= 1;
760 st->clkout_div_sel++;
761 }
762
763 st->n_int = div_u64(freq, st->f_pfd);
764
765 ret = regmap_update_bits(st->regmap, 0x11, ADF4377_EN_RDBLR_MSK | ADF4377_N_INT_MSB_MSK,
766 FIELD_PREP(ADF4377_EN_RDBLR_MSK, ADF4377_REF_DBLR_DIS) |
767 FIELD_PREP(ADF4377_N_INT_MSB_MSK, st->n_int >> 8));
768 if (ret)
769 return ret;
770
771 ret = regmap_update_bits(st->regmap, 0x12, ADF4377_R_DIV_MSK | ADF4377_CLKOUT_DIV_MSK,
772 FIELD_PREP(ADF4377_CLKOUT_DIV_MSK, st->clkout_div_sel) |
773 FIELD_PREP(ADF4377_R_DIV_MSK, st->ref_div_factor));
774 if (ret)
775 return ret;
776
777 ret = regmap_write(st->regmap, 0x10,
778 FIELD_PREP(ADF4377_N_INT_LSB_MSK, st->n_int));
779 if (ret)
780 return ret;
781
782 ret = regmap_read_poll_timeout(st->regmap, 0x49, read_val,
783 !(read_val & (ADF4377_FSM_BUSY_MSK)), 200, 200 * 100);
784 if (ret)
785 return ret;
786
787 /* Disable EN_DNCLK, EN_DRCLK */
788 ret = regmap_update_bits(st->regmap, 0x1C, ADF4377_EN_DNCLK_MSK | ADF4377_EN_DRCLK_MSK,
789 FIELD_PREP(ADF4377_EN_DNCLK_MSK, ADF4377_EN_DNCLK_OFF) |
790 FIELD_PREP(ADF4377_EN_DRCLK_MSK, ADF4377_EN_DRCLK_OFF));
791 if (ret)
792 return ret;
793
794 /* Disable EN_ADC_CLK */
795 ret = regmap_update_bits(st->regmap, 0x20, ADF4377_EN_ADC_CLK_MSK,
796 FIELD_PREP(ADF4377_EN_ADC_CLK_MSK, ADF4377_EN_ADC_CLK_DIS));
797 if (ret)
798 return ret;
799
800 /* Set output Amplitude */
801 return regmap_update_bits(st->regmap, 0x19, ADF4377_CLKOUT2_OP_MSK | ADF4377_CLKOUT1_OP_MSK,
802 FIELD_PREP(ADF4377_CLKOUT1_OP_MSK, ADF4377_CLKOUT_420MV) |
803 FIELD_PREP(ADF4377_CLKOUT2_OP_MSK, ADF4377_CLKOUT_420MV));
804 }
805
--
0-DAY CI Kernel Test Service
https://01.org/lkp
On Fri, 2022-11-04 at 11:28 +0200, Antoniu Miclaus wrote:
> The ADF4377 is a high performance, ultralow jitter, dual output
> integer-N
> phased locked loop (PLL) with integrated voltage controlled
> oscillator
> (VCO) ideally suited for data converter and mixed signal front end
> (MxFE)
> clock applications.
>
> Datasheet:
> https://www.analog.com/media/en/technical-documentation/data-sheets/adf4377.pdf
> Signed-off-by: Antoniu Miclaus <[email protected]>
> ---
> drivers/iio/frequency/Kconfig | 10 +
> drivers/iio/frequency/Makefile | 1 +
> drivers/iio/frequency/adf4377.c | 1154
> +++++++++++++++++++++++++++++++
> 3 files changed, 1165 insertions(+)
> create mode 100644 drivers/iio/frequency/adf4377.c
>
> diff --git a/drivers/iio/frequency/Kconfig
> b/drivers/iio/frequency/Kconfig
> index f3702f36436c..9e85dfa58508 100644
> --- a/drivers/iio/frequency/Kconfig
> +++ b/drivers/iio/frequency/Kconfig
> @@ -50,6 +50,16 @@ config ADF4371
> To compile this driver as a module, choose M here: the
> module will be called adf4371.
>
> +config ADF4377
> + tristate "Analog Devices ADF4377 Microwave Wideband
> Synthesizer"
> + depends on SPI && COMMON_CLK
> + help
> + Say yes here to build support for Analog Devices ADF4377
> Microwave
> + Wideband Synthesizer.
> +
> + To compile this driver as a module, choose M here: the
> + module will be called adf4377.
> +
> 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 48add732f1d3..b616c29b4a08 100644
> --- a/drivers/iio/frequency/Makefile
> +++ b/drivers/iio/frequency/Makefile
> @@ -7,6 +7,7 @@
> obj-$(CONFIG_AD9523) += ad9523.o
> obj-$(CONFIG_ADF4350) += adf4350.o
> obj-$(CONFIG_ADF4371) += adf4371.o
> +obj-$(CONFIG_ADF4377) += adf4377.o
> obj-$(CONFIG_ADMV1013) += admv1013.o
> obj-$(CONFIG_ADMV1014) += admv1014.o
> obj-$(CONFIG_ADMV4420) += admv4420.o
> diff --git a/drivers/iio/frequency/adf4377.c
> b/drivers/iio/frequency/adf4377.c
> new file mode 100644
> index 000000000000..1901dde1003e
> --- /dev/null
> +++ b/drivers/iio/frequency/adf4377.c
> @@ -0,0 +1,1154 @@
> +// SPDX-License-Identifier: GPL-2.0-only
> +/*
> + * ADF4377 driver
> + *
> + * Copyright 2022 Analog Devices Inc.
> + */
> +
> +#include <linux/bitfield.h>
> +#include <linux/bits.h>
> +#include <linux/clk.h>
> +#include <linux/clkdev.h>
> +#include <linux/delay.h>
> +#include <linux/device.h>
> +#include <linux/module.h>
> +#include <linux/notifier.h>
> +#include <linux/property.h>
> +#include <linux/spi/spi.h>
> +#include <linux/iio/iio.h>
> +#include <linux/regmap.h>
> +#include <linux/units.h>
> +
> +#include <linux/gpio/consumer.h>
> +
> +/* ADF4377 REG0000 Map */
> +#define ADF4377_SOFT_RESET_R_MSK BIT(7)
> +#define ADF4377_LSB_FIRST_R_MSK BIT(6)
> +#define ADF4377_ADDRESS_ASC_R_MSK BIT(5)
> +#define ADF4377_SDO_ACTIVE_R_MSK BIT(4)
> +#define ADF4377_SDO_ACTIVE_MSK BIT(3)
> +#define ADF4377_ADDRESS_ASC_MSK BIT(2)
> +#define ADF4377_LSB_FIRST_MSK BIT(1)
> +#define ADF4377_SOFT_RESET_MSK BIT(0)
> +
> +/* ADF4377 REG0000 Bit Definition */
> +#define ADF4377_SDO_ACTIVE_SPI_3W 0x0
> +#define ADF4377_SDO_ACTIVE_SPI_4W 0x1
> +
> +#define ADF4377_ADDR_ASC_AUTO_DECR 0x0
> +#define ADF4377_ADDR_ASC_AUTO_INCR 0x1
> +
> +#define ADF4377_LSB_FIRST_MSB 0x0
> +#define ADF4377_LSB_FIRST_LSB 0x1
> +
> +#define ADF4377_SOFT_RESET_N_OP 0x0
> +#define ADF4377_SOFT_RESET_EN 0x1
> +
> +/* ADF4377 REG0001 Map */
> +#define ADF4377_SINGLE_INSTR_MSK BIT(7)
> +#define ADF4377_MASTER_RB_CTRL_MSK BIT(5)
> +
> +/* ADF4377 REG0001 Bit Definition */
> +#define ADF4377_SPI_STREAM_EN 0x0
> +#define ADF4377_SPI_STREAM_DIS 0x1
> +
> +#define ADF4377_RB_SLAVE_REG 0x0
> +#define ADF4377_RB_MASTER_REG 0x1
> +
> +/* ADF4377 REG0003 Bit Definition */
> +#define ADF4377_CHIP_TYPE 0x06
> +
> +/* ADF4377 REG0004 Bit Definition */
> +#define ADF4377_PRODUCT_ID_LSB 0x0005
> +
> +/* ADF4377 REG0005 Bit Definition */
> +#define ADF4377_PRODUCT_ID_MSB 0x0005
> +
> +/* ADF4377 REG000A Map */
> +#define ADF4377_SCRATCHPAD_MSK GENMASK(7, 0)
> +
> +/* ADF4377 REG000C Bit Definition */
> +#define ADF4377_VENDOR_ID_LSB 0x56
> +
> +/* ADF4377 REG000D Bit Definition */
> +#define ADF4377_VENDOR_ID_MSB 0x04
> +
> +/* ADF4377 REG000F Bit Definition */
> +#define ADF4377_R00F_RSV1_MSK GENMASK(7, 0)
> +
> +/* ADF4377 REG0010 Map*/
> +#define ADF4377_N_INT_LSB_MSK GENMASK(7, 0)
> +
> +/* ADF4377 REG0011 Map*/
> +#define ADF4377_EN_AUTOCAL_MSK BIT(7)
> +#define ADF4377_EN_RDBLR_MSK BIT(6)
> +#define ADF4377_DCLK_DIV2_MSK GENMASK(5, 4)
> +#define ADF4377_N_INT_MSB_MSK GENMASK(3, 0)
> +
> +/* ADF4377 REG0011 Bit Definition */
> +#define ADF4377_VCO_CALIB_DIS 0x0
> +#define ADF4377_VCO_CALIB_EN 0x1
> +
> +#define ADF4377_REF_DBLR_DIS 0x0
> +#define ADF4377_REF_DBLR_EN 0x1
> +
> +#define ADF4377_DCLK_DIV2_1 0x0
> +#define ADF4377_DCLK_DIV2_2 0x1
> +#define ADF4377_DCLK_DIV2_4 0x2
> +#define ADF4377_DCLK_DIV2_8 0x3
> +
> +/* ADF4377 REG0012 Map*/
> +#define ADF4377_CLKOUT_DIV_MSK GENMASK(7, 6)
> +#define ADF4377_R_DIV_MSK GENMASK(5, 0)
> +
> +/* ADF4377 REG0012 Bit Definition */
> +#define ADF4377_CLKOUT_DIV_1 0x0
> +#define ADF4377_CLKOUT_DIV_2 0x1
> +#define ADF4377_CLKOUT_DIV_4 0x2
> +#define ADF4377_CLKOUT_DIV_8 0x3
> +
> +/* ADF4377 REG0013 Map */
> +#define ADF4377_M_VCO_CORE_MSK GENMASK(5, 4)
> +#define ADF4377_M_VCO_BIAS_MSK GENMASK(3, 0)
> +
> +/* ADF4377 REG0013 Bit Definition */
> +#define ADF4377_M_VCO_0 0x0
> +#define ADF4377_M_VCO_1 0x1
> +#define ADF4377_M_VCO_2 0x2
> +#define ADF4377_M_VCO_3 0x3
> +
> +/* ADF4377 REG0014 Map */
> +#define ADF4377_M_VCO_BAND_MSK GENMASK(7, 0)
> +
> +/* ADF4377 REG0015 Map */
> +#define ADF4377_BLEED_I_LSB_MSK GENMASK(7, 6)
> +#define ADF4377_BLEED_POL_MSK BIT(5)
> +#define ADF4377_EN_BLEED_MSK BIT(4)
> +#define ADF4377_CP_I_MSK GENMASK(3, 0)
> +
> +/* ADF4377 REG0015 Bit Definition */
> +#define ADF4377_CURRENT_SINK 0x0
> +#define ADF4377_CURRENT_SOURCE 0x1
> +
> +#define ADF4377_BLEED_CURR_DIS 0x0
> +#define ADF4377_BLEED_CURR_EN 0x1
> +
> +#define ADF4377_CP_0MA7 0x0
> +#define ADF4377_CP_0MA9 0x1
> +#define ADF4377_CP_1MA1 0x2
> +#define ADF4377_CP_1MA3 0x3
> +#define ADF4377_CP_1MA4 0x4
> +#define ADF4377_CP_1MA8 0x5
> +#define ADF4377_CP_2MA2 0x6
> +#define ADF4377_CP_2MA5 0x7
> +#define ADF4377_CP_2MA9 0x8
> +#define ADF4377_CP_3MA6 0x9
> +#define ADF4377_CP_4MA3 0xA
> +#define ADF4377_CP_5MA0 0xB
> +#define ADF4377_CP_5MA7 0xC
> +#define ADF4377_CP_7MA2 0xD
> +#define ADF4377_CP_8MA6 0xE
> +#define ADF4377_CP_10MA1 0xF
> +
> +/* ADF4377 REG0016 Map */
> +#define ADF4377_BLEED_I_MSB_MSK GENMASK(7, 0)
> +
> +/* ADF4377 REG0017 Map */
> +#define ADF4377_INV_CLKOUT_MSK BIT(7)
> +#define ADF4377_N_DEL_MSK GENMASK(6, 0)
> +
> +/* ADF4377 REG0017 Bit Definition */
> +#define ADF4377_CLKOUT_INV_DIS 0x0
> +#define ADF4377_CLKOUT_INV_EN 0x1
> +
> +/* ADF4377 REG0018 Map */
> +#define ADF4377_CMOS_OV_MSK BIT(7)
> +#define ADF4377_R_DEL_MSK GENMASK(6, 0)
> +
> +/* ADF4377 REG0018 Bit Definition */
> +#define ADF4377_1V8_LOGIC 0x0
> +#define ADF4377_3V3_LOGIC 0x1
> +
> +/* ADF4377 REG0019 Map */
> +#define ADF4377_CLKOUT2_OP_MSK GENMASK(7, 6)
> +#define ADF4377_CLKOUT1_OP_MSK GENMASK(5, 4)
> +#define ADF4377_PD_CLK_MSK BIT(3)
> +#define ADF4377_PD_RDET_MSK BIT(2)
> +#define ADF4377_PD_ADC_MSK BIT(1)
> +#define ADF4377_PD_CALADC_MSK BIT(0)
> +
> +/* ADF4377 REG0019 Bit Definition */
> +#define ADF4377_CLKOUT_320MV 0x0
> +#define ADF4377_CLKOUT_420MV 0x1
> +#define ADF4377_CLKOUT_530MV 0x2
> +#define ADF4377_CLKOUT_640MV 0x3
> +
> +#define ADF4377_PD_CLK_N_OP 0x0
> +#define ADF4377_PD_CLK_PD 0x1
> +
> +#define ADF4377_PD_RDET_N_OP 0x0
> +#define ADF4377_PD_RDET_PD 0x1
> +
> +#define ADF4377_PD_ADC_N_OP 0x0
> +#define ADF4377_PD_ADC_PD 0x1
> +
> +#define ADF4377_PD_CALADC_N_OP 0x0
> +#define ADF4377_PD_CALADC_PD 0x1
> +
> +/* ADF4377 REG001A Map */
> +#define ADF4377_PD_ALL_MSK BIT(7)
> +#define ADF4377_PD_RDIV_MSK BIT(6)
> +#define ADF4377_PD_NDIV_MSK BIT(5)
> +#define ADF4377_PD_VCO_MSK BIT(4)
> +#define ADF4377_PD_LD_MSK BIT(3)
> +#define ADF4377_PD_PFDCP_MSK BIT(2)
> +#define ADF4377_PD_CLKOUT1_MSK BIT(1)
> +#define ADF4377_PD_CLKOUT2_MSK BIT(0)
> +
> +/* ADF4377 REG001A Bit Definition */
> +#define ADF4377_PD_ALL_N_OP 0x0
> +#define ADF4377_PD_ALL_PD 0x1
> +
> +#define ADF4377_PD_RDIV_N_OP 0x0
> +#define ADF4377_PD_RDIV_PD 0x1
> +
> +#define ADF4377_PD_NDIV_N_OP 0x0
> +#define ADF4377_PD_NDIV_PD 0x1
> +
> +#define ADF4377_PD_VCO_N_OP 0x0
> +#define ADF4377_PD_VCO_PD 0x1
> +
> +#define ADF4377_PD_LD_N_OP 0x0
> +#define ADF4377_PD_LD_PD 0x1
> +
> +#define ADF4377_PD_PFDCP_N_OP 0x0
> +#define ADF4377_PD_PFDCP_PD 0x1
> +
> +#define ADF4377_PD_CLKOUT1_N_OP 0x0
> +#define ADF4377_PD_CLKOUT1_PD 0x1
> +
> +#define ADF4377_PD_CLKOUT2_N_OP 0x0
> +#define ADF4377_PD_CLKOUT2_PD 0x1
> +
> +/* ADF4377 REG001B Map */
> +#define ADF4377_EN_LOL_MSK BIT(7)
> +#define ADF4377_LDWIN_PW_MSK BIT(6)
> +#define ADF4377_EN_LDWIN_MSK BIT(5)
> +#define ADF4377_LD_COUNT_MSK GENMASK(4, 0)
> +
> +/* ADF4377 REG001B Bit Definition */
> +#define ADF4377_EN_LOL_DIS 0x0
> +#define ADF4377_EN_LOL_EN 0x1
> +
> +#define ADF4377_LDWIN_PW_NARROW 0x0
> +#define ADF4377_LDWIN_PW_WIDE 0x1
> +
> +#define ADF4377_EN_LDWIN_DIS 0x0
> +#define ADF4377_EN_LDWIN_EN 0x1
> +
> +/* ADF4377 REG001C Map */
> +#define ADF4377_EN_DNCLK_MSK BIT(7)
> +#define ADF4377_EN_DRCLK_MSK BIT(6)
> +#define ADF4377_RST_LD_MSK BIT(2)
> +#define ADF4377_R01C_RSV1_MSK BIT(0)
> +
> +/* ADF4377 REG001C Bit Definition */
> +#define ADF4377_EN_DNCLK_OFF 0x0
> +#define ADF4377_EN_DNCLK_ON 0x1
> +
> +#define ADF4377_EN_DRCLK_OFF 0x0
> +#define ADF4377_EN_DRCLK_ON 0x1
> +
> +#define ADF4377_RST_LD_INACTIVE 0x0
> +#define ADF4377_RST_LD_ACTIVE 0x1
> +
> +/* ADF4377 REG001D Map */
> +#define ADF4377_MUXOUT_MSK GENMASK(7, 4)
> +#define ADF4377_EN_CPTEST_MSK BIT(2)
> +#define ADF4377_CP_DOWN_MSK BIT(1)
> +#define ADF4377_CP_UP_MSK BIT(0)
> +
> +#define ADF4377_EN_CPTEST_OFF 0x0
> +#define ADF4377_EN_CPTEST_ON 0x1
> +
> +#define ADF4377_CP_DOWN_OFF 0x0
> +#define ADF4377_CP_DOWN_ON 0x1
> +
> +#define ADF4377_CP_UP_OFF 0x0
> +#define ADF4377_CP_UP_ON 0x1
> +
> +/* ADF4377 REG001F Map */
> +#define ADF4377_BST_REF_MSK BIT(7)
> +#define ADF4377_FILT_REF_MSK BIT(6)
> +#define ADF4377_REF_SEL_MSK BIT(5)
> +#define ADF4377_R01F_RSV1_MSK GENMASK(4, 0)
> +
> +/* ADF4377 REG001F Bit Definition */
> +#define ADF4377_BST_LARGE_REF_IN 0x0
> +#define ADF4377_BST_SMALL_REF_IN 0x1
> +
> +#define ADF4377_FILT_REF_OFF 0x0
> +#define ADF4377_FILT_REF_ON 0x1
> +
> +#define ADF4377_REF_SEL_DMA 0x0
> +#define ADF4377_REF_SEL_LNA 0x1
> +
> +/* ADF4377 REG0020 Map */
> +#define ADF4377_RST_SYS_MSK BIT(4)
> +#define ADF4377_EN_ADC_CLK_MSK BIT(3)
> +#define ADF4377_R020_RSV1_MSK BIT(0)
> +
> +/* ADF4377 REG0020 Bit Definition */
> +#define ADF4377_RST_SYS_INACTIVE 0x0
> +#define ADF4377_RST_SYS_ACTIVE 0x1
> +
> +#define ADF4377_EN_ADC_CLK_DIS 0x0
> +#define ADF4377_EN_ADC_CLK_EN 0x1
> +
> +/* ADF4377 REG0021 Bit Definition */
> +#define ADF4377_R021_RSV1 0xD3
> +
> +/* ADF4377 REG0022 Bit Definition */
> +#define ADF4377_R022_RSV1 0x32
> +
> +/* ADF4377 REG0023 Map */
> +#define ADF4377_CAT_CT_SEL BIT(7)
> +#define ADF4377_R023_RSV1_MSK GENMASK(6, 0)
> +
> +/* ADF4377 REG0024 Map */
> +#define ADF4377_DCLK_MODE_MSK BIT(2)
> +
> +/* ADF4377 REG0024 Bit Definition */
> +#define ADF4377_DCLK_MODE_DIS 0x0
> +#define ADF4377_DCLK_MODE_EN 0x1
> +
> +/* ADF4377 REG0025 Map */
> +#define ADF4377_CLKODIV_DB_MSK BIT(7)
> +#define ADF4377_DCLK_DB_MSK BIT(6)
> +#define ADF4377_R025_RSV1_MSK GENMASK(5, 0)
> +
> +/* ADF4377 REG0025 Bit Definition */
> +#define ADF4377_CLKODIV_DB_DIS 0x0
> +#define ADF4377_CLKODIV_DB_EN 0x1
> +
> +#define ADF4377_DCLK_DIV_DB_DIS 0x0
> +#define ADF4377_DCLK_DIV_DB_EN 0x1
> +
> +/* ADF4377 REG0026 Map */
> +#define ADF4377_VCO_BAND_DIV_MSK GENMASK(7, 0)
> +
> +/* ADF4377 REG0027 Map */
> +#define ADF4377_SYNTH_LOCK_TO_LSB_MSK GENMASK(7, 0)
> +
> +/* ADF4377 REG0028 Map */
> +#define ADF4377_O_VCO_DB_MSK BIT(7)
> +#define ADF4377_SYNTH_LOCK_TO_MSB_MSK GENMASK(6, 0)
> +
> +/* ADF4377 REG0028 Bit Definition */
> +#define ADF4377_O_VCO_DB_DIS 0x0
> +#define ADF4377_O_VCO_DB_EN 0x1
> +
> +/* ADF4377 REG0029 Map */
> +#define ADF4377_VCO_ALC_TO_LSB_MSK GENMASK(7, 0)
> +
> +/* ADF4377 REG002A Map */
> +#define ADF4377_DEL_CTRL_DB_MSK BIT(7)
> +#define ADF4377_VCO_ALC_TO_MSB_MSK GENMASK(6, 0)
> +
> +/* ADF4377 REG002A Bit Definition */
> +#define ADF4377_DEL_CTRL_DB_DIS 0x0
> +#define ADF4377_DEL_CTRL_DB_EN 0x1
> +
> +/* ADF4377 REG002C Map */
> +#define ADF4377_R02C_RSV1 0xC0
> +
> +/* ADF4377 REG002D Map */
> +#define ADF4377_ADC_CLK_DIV_MSK GENMASK(7, 0)
> +
> +/* ADF4377 REG002E Map */
> +#define ADF4377_EN_ADC_CNV_MSK BIT(7)
> +#define ADF4377_EN_ADC_MSK BIT(1)
> +#define ADF4377_ADC_A_CONV_MSK BIT(0)
> +
> +/* ADF4377 REG002E Bit Definition */
> +#define ADF4377_EN_ADC_CNV_DIS 0x0
> +#define ADF4377_EN_ADC_CNV_EN 0x1
> +
> +#define ADF4377_EN_ADC_DIS 0x0
> +#define ADF4377_EN_ADC_EN 0x1
> +
> +#define ADF4377_ADC_A_CONV_ADC_ST_CNV 0x0
> +#define ADF4377_ADC_A_CONV_VCO_CALIB 0x1
> +
> +/* ADF4377 REG002F Map */
> +#define ADF4377_DCLK_DIV1_MSK GENMASK(1, 0)
> +
> +/* ADF4377 REG002F Bit Definition */
> +#define ADF4377_DCLK_DIV1_1 0x0
> +#define ADF4377_DCLK_DIV1_2 0x1
> +#define ADF4377_DCLK_DIV1_8 0x2
> +#define ADF4377_DCLK_DIV1_32 0x3
> +
> +/* ADF4377 REG0031 Bit Definition */
> +#define ADF4377_R031_RSV1 0x09
> +
> +/* ADF4377 REG0032 Map */
> +#define ADF4377_ADC_CLK_SEL_MSK BIT(6)
> +#define ADF4377_R032_RSV1_MSK GENMASK(5, 0)
> +
> +/* ADF4377 REG0032 Bit Definition */
> +#define ADF4377_R032_RSV1 0x9
> +
> +/* ADF4377 REG0032 Bit Definition */
> +#define ADF4377_ADC_CLK_SEL_N_OP 0x0
> +#define ADF4377_ADC_CLK_SEL_SPI_CLK 0x1
> +
> +/* ADF4377 REG0033 Bit Definition */
> +#define ADF4377_R033_RSV1 0x18
> +
> +/* ADF4377 REG0034 Bit Definition */
> +#define ADF4377_R034_RSV1 0x08
> +
> +/* ADF4377 REG003A Bit Definition */
> +#define ADF4377_R03A_RSV1 0x5D
> +
> +/* ADF4377 REG003B Bit Definition */
> +#define ADF4377_R03B_RSV1 0x2B
> +
> +/* ADF4377 REG003D Map */
> +#define ADF4377_O_VCO_BAND_MSK BIT(3)
> +#define ADF4377_O_VCO_CORE_MSK BIT(2)
> +#define ADF4377_O_VCO_BIAS_MSK BIT(1)
> +
> +/* ADF4377 REG003D Bit Definition */
> +#define ADF4377_O_VCO_BAND_VCO_CALIB 0x0
> +#define ADF4377_O_VCO_BAND_M_VCO 0x1
> +
> +#define ADF4377_O_VCO_CORE_VCO_CALIB 0x0
> +#define ADF4377_O_VCO_CORE_M_VCO 0x1
> +
> +#define ADF4377_O_VCO_BIAS_VCO_CALIB 0x0
> +#define ADF4377_O_VCO_BIAS_M_VCO 0x1
> +
> +/* ADF4377 REG0042 Map */
> +#define ADF4377_R042_RSV1 0x05
> +
> +/* ADF4377 REG0045 Map */
> +#define ADF4377_ADC_ST_CNV_MSK BIT(0)
> +
> +/* ADF4377 REG0045 Bit Definition */
> +#define ADF4377_ADC_ST_ADC_DIS 0x0
> +#define ADF4377_ADC_ST_ADC_EN 0x1
> +
> +/* ADF4377 REG0049 Map */
> +#define ADF4377_EN_CLK2_MSK BIT(7)
> +#define ADF4377_EN_CLK1_MSK BIT(6)
> +#define ADF4377_REF_OK_MSK BIT(3)
> +#define ADF4377_ADC_BUSY_MSK BIT(2)
> +#define ADF4377_FSM_BUSY_MSK BIT(1)
> +#define ADF4377_LOCKED_MSK BIT(0)
> +
> +/* ADF4377 REG004B Map */
> +#define ADF4377_VCO_CORE_MSK GENMASK(1, 0)
> +
> +/* ADF4377 REG004C Map */
> +#define ADF4377_CHIP_TEMP_LSB_MSK GENMASK(7, 0)
> +
> +/* ADF4377 REG004D Map */
> +#define ADF4377_CHIP_TEMP_MSB_MSK BIT(0)
> +
> +/* ADF4377 REG004F Map */
> +#define ADF4377_VCO_BAND_MSK GENMASK(7, 0)
> +
> +/* ADF4377 REG0051 Map */
> +#define ADF4377_VCO_BIAS_MSK GENMASK(3, 0)
> +
> +/* ADF4377 REG0054 Map */
> +#define ADF4377_CHIP_VERSION_MSK GENMASK(7, 0)
> +
> +/* Specifications */
> +#define ADF4377_SPI_READ_CMD BIT(7)
> +#define ADF4377_MAX_VCO_FREQ (12800ULL * HZ_PER_MHZ)
> +#define ADF4377_MIN_VCO_FREQ (6400ULL * HZ_PER_MHZ)
> +#define ADF4377_MAX_REFIN_FREQ (1000 * HZ_PER_MHZ)
> +#define ADF4377_MIN_REFIN_FREQ (10 * HZ_PER_MHZ)
> +#define ADF4377_MAX_FREQ_PFD (500 * HZ_PER_MHZ)
> +#define ADF4377_MIN_FREQ_PFD (3 * HZ_PER_MHZ)
> +#define ADF4377_MAX_CLKPN_FREQ ADF4377_MAX_VCO_FREQ
> +#define ADF4377_MIN_CLKPN_FREQ (ADF4377_MIN_VCO_FREQ / 8)
> +#define ADF4377_FREQ_PFD_80MHZ (80 * HZ_PER_MHZ)
> +#define ADF4377_FREQ_PFD_125MHZ (125 * HZ_PER_MHZ)
> +#define ADF4377_FREQ_PFD_160MHZ (160 * HZ_PER_MHZ)
> +#define ADF4377_FREQ_PFD_250MHZ (250 * HZ_PER_MHZ)
> +#define ADF4377_FREQ_PFD_320MHZ (320 * HZ_PER_MHZ)
> +
> +enum adf4377_dev_type {
> + ADF4377,
> + ADF4378,
> +};
> +
> +enum {
> + ADF4377_FREQ,
> +};
> +
> +enum muxout_select_modes {
> + ADF4377_MUXOUT_HIGH_Z = 0x0,
> + ADF4377_MUXOUT_LKDET = 0x1,
> + ADF4377_MUXOUT_LOW = 0x2,
> + ADF4377_MUXOUT_DIV_RCLK_2 = 0x4,
> + ADF4377_MUXOUT_DIV_NCLK_2 = 0x5,
> + ADF4377_MUXOUT_HIGH = 0x8,
> +};
> +
> +struct adf4377_state {
> + struct spi_device *spi;
> + enum adf4377_dev_type type;
> + struct regmap *regmap;
> + struct clk *clkin;
> + /* Protect against concurrent accesses to the device and data
> content */
> + struct mutex lock;
> + struct notifier_block nb;
> + /* Reference Divider */
> + unsigned int ref_div_factor;
> + /* PFD Frequency */
> + unsigned int f_pfd;
> + /* Input Reference Clock */
> + unsigned int clkin_freq;
> + /* CLKOUT Divider */
> + u8 clkout_div_sel;
> + /* Feedback Divider (N) */
> + u16 n_int;
> + u16 synth_lock_timeout;
> + u16 vco_alc_timeout;
> + u16 adc_clk_div;
> + u16 vco_band_div;
> + u8 dclk_div1;
> + u8 dclk_div2;
> + u8 dclk_mode;
> + unsigned int f_div_rclk;
> + struct gpio_desc *gpio_ce;
> + struct gpio_desc *gpio_enclk1;
> + struct gpio_desc *gpio_enclk2;
> + u8 buf[2] ____cacheline_aligned;
> +};
> +
> +static const char * const adf4377_muxout_modes[] = {
> + [ADF4377_MUXOUT_HIGH_Z] = "high_z",
> + [ADF4377_MUXOUT_LKDET] = "lock_detect",
> + [ADF4377_MUXOUT_LOW] = "muxout_low",
> + [ADF4377_MUXOUT_DIV_RCLK_2] = "f_div_rclk_2",
> + [ADF4377_MUXOUT_DIV_NCLK_2] = "f_div_nclk_2",
> + [ADF4377_MUXOUT_HIGH] = "muxout_high",
> +};
> +
> +static const struct regmap_config adf4377_regmap_config = {
> + .reg_bits = 16,
> + .val_bits = 8,
> + .read_flag_mask = BIT(7),
> + .max_register = 0x54,
> +};
> +
> +static int adf4377_reg_access(struct iio_dev *indio_dev,
> + unsigned int reg,
> + unsigned int write_val,
> + unsigned int *read_val)
> +{
> + struct adf4377_state *st = iio_priv(indio_dev);
> +
> + if (read_val)
> + return regmap_read(st->regmap, reg, read_val);
> +
> + return regmap_write(st->regmap, reg, write_val);
> +}
> +
> +static const struct iio_info adf4377_info = {
> + .debugfs_reg_access = &adf4377_reg_access,
> +};
> +
> +static int adf4377_soft_reset(struct adf4377_state *st)
> +{
> + unsigned int read_val;
> + int ret;
> +
> + ret = regmap_update_bits(st->regmap, 0x0,
> ADF4377_SOFT_RESET_MSK |
> + ADF4377_SOFT_RESET_R_MSK,
> + FIELD_PREP(ADF4377_SOFT_RESET_MSK,
> 1) |
> + FIELD_PREP(ADF4377_SOFT_RESET_R_MSK,
> 1));
> + if (ret)
> + return ret;
> +
> + return regmap_read_poll_timeout(st->regmap, 0x0, read_val,
> + !(read_val &
> (ADF4377_SOFT_RESET_R_MSK |
> + ADF4377_SOFT_RESET_R_MSK)),
> 200, 200 * 100);
> +}
> +
> +static int adf4377_set_default(struct adf4377_state *st)
> +{
> + int ret;
> +
> + /* Set default registers bits */
> + ret = regmap_write(st->regmap, 0x42, ADF4377_R042_RSV1);
> + if (ret)
> + return ret;
> +
> + ret = regmap_write(st->regmap, 0x3B, ADF4377_R03B_RSV1);
> + if (ret)
> + return ret;
> +
> + ret = regmap_write(st->regmap, 0x3A, ADF4377_R03A_RSV1);
> + if (ret)
> + return ret;
> +
> + ret = regmap_write(st->regmap, 0x34, ADF4377_R034_RSV1);
> + if (ret)
> + return ret;
> +
> + ret = regmap_write(st->regmap, 0x33, ADF4377_R033_RSV1);
> + if (ret)
> + return ret;
> +
> + ret = regmap_update_bits(st->regmap, 0x32,
> ADF4377_R032_RSV1_MSK,
> + FIELD_PREP(ADF4377_R032_RSV1_MSK,
> 0x9));
> + if (ret)
> + return ret;
> +
> + ret = regmap_write(st->regmap, 0x31, ADF4377_R031_RSV1);
> + if (ret)
> + return ret;
> +
> + ret = regmap_write(st->regmap, 0x2C, ADF4377_R02C_RSV1);
> + if (ret)
> + return ret;
> +
> + ret = regmap_update_bits(st->regmap, 0x25,
> ADF4377_R025_RSV1_MSK,
> + FIELD_PREP(ADF4377_R025_RSV1_MSK,
> 0x16));
> + if (ret)
> + return ret;
> +
> + ret = regmap_update_bits(st->regmap, 0x23,
> ADF4377_R023_RSV1_MSK,
> + FIELD_PREP(ADF4377_R023_RSV1_MSK,
> 0x18));
> + if (ret)
> + return ret;
> +
> + ret = regmap_write(st->regmap, 0x22, ADF4377_R022_RSV1);
> + if (ret)
> + return ret;
> +
> + ret = regmap_write(st->regmap, 0x21, ADF4377_R021_RSV1);
> + if (ret)
> + return ret;
> +
> + ret = regmap_update_bits(st->regmap, 0x1f,
> ADF4377_R01F_RSV1_MSK,
> + FIELD_PREP(ADF4377_R01F_RSV1_MSK,
> 0x7));
> + if (ret)
> + return ret;
> +
> + return regmap_update_bits(st->regmap, 0x1c,
> ADF4377_R01C_RSV1_MSK,
> + FIELD_PREP(ADF4377_R01C_RSV1_MSK,
> 0x1));
> +}
> +
> +int adf4377_get_freq(struct adf4377_state *st, u64 *freq)
> +{
> + unsigned int ref_div_factor, n_int;
> + u64 clkin_freq;
> + int ret;
> +
> + mutex_lock(&st->lock);
> + ret = regmap_read(st->regmap, 0x12, &ref_div_factor);
> + if (ret)
> + goto exit;
> +
> + ret = regmap_bulk_read(st->regmap, 0x10, st->buf, sizeof(st-
> >buf));
> + if (ret)
> + goto exit;
> +
> + clkin_freq = clk_get_rate(st->clkin);
> + ref_div_factor = FIELD_GET(ADF4377_R_DIV_MSK,
> ref_div_factor);
> + n_int = FIELD_GET(ADF4377_N_INT_LSB_MSK, st->buf[0]) |
> + (FIELD_GET(ADF4377_N_INT_MSB_MSK, st->buf[1]) << 8);
> +
Maybe we could refactor this to use the proper get_unaligned() call? I
think we would also need one FIELD_GET() in that case...
> + *freq = div_u64(clkin_freq, ref_div_factor) * n_int;
> +exit:
> + mutex_unlock(&st->lock);
> +
> + return ret;
> +}
> +
> +int adf4377_set_freq(struct adf4377_state *st, u64 freq)
> +{
> + unsigned int read_val;
> + u64 f_vco;
> + int ret;
> +
> + ret = regmap_update_bits(st->regmap, 0x1C,
> ADF4377_EN_DNCLK_MSK | ADF4377_EN_DRCLK_MSK,
> + FIELD_PREP(ADF4377_EN_DNCLK_MSK,
> ADF4377_EN_DNCLK_ON) |
> + FIELD_PREP(ADF4377_EN_DRCLK_MSK,
> ADF4377_EN_DRCLK_ON));
> + if (ret)
> + return ret;
> +
> + ret = regmap_update_bits(st->regmap, 0x11,
> ADF4377_EN_AUTOCAL_MSK | ADF4377_DCLK_DIV2_MSK,
> + FIELD_PREP(ADF4377_EN_AUTOCAL_MSK,
> ADF4377_VCO_CALIB_EN) |
> + FIELD_PREP(ADF4377_DCLK_DIV2_MSK,
> st->dclk_div2));
> + if (ret)
> + return ret;
> +
> + ret = regmap_update_bits(st->regmap, 0x2E,
> ADF4377_EN_ADC_CNV_MSK | ADF4377_EN_ADC_MSK |
> + ADF4377_ADC_A_CONV_MSK,
> + FIELD_PREP(ADF4377_EN_ADC_CNV_MSK,
> ADF4377_EN_ADC_CNV_EN) |
> + FIELD_PREP(ADF4377_EN_ADC_MSK,
> ADF4377_EN_ADC_EN) |
> + FIELD_PREP(ADF4377_ADC_A_CONV_MSK,
> ADF4377_ADC_A_CONV_VCO_CALIB));
> + if (ret)
> + return ret;
> +
> + ret = regmap_update_bits(st->regmap, 0x20,
> ADF4377_EN_ADC_CLK_MSK,
> + FIELD_PREP(ADF4377_EN_ADC_CLK_MSK,
> ADF4377_EN_ADC_CLK_EN));
> + if (ret)
> + return ret;
> +
> + ret = regmap_update_bits(st->regmap, 0x2F,
> ADF4377_DCLK_DIV1_MSK,
> + FIELD_PREP(ADF4377_DCLK_DIV1_MSK,
> st->dclk_div1));
> + if (ret)
> + return ret;
> +
> + ret = regmap_update_bits(st->regmap, 0x24,
> ADF4377_DCLK_MODE_MSK,
> + FIELD_PREP(ADF4377_DCLK_MODE_MSK,
> st->dclk_mode));
> + if (ret)
> + return ret;
> +
> + ret = regmap_write(st->regmap, 0x27,
> + FIELD_PREP(ADF4377_SYNTH_LOCK_TO_LSB_MSK,
> st->synth_lock_timeout));
> + if (ret)
> + return ret;
> +
> + ret = regmap_update_bits(st->regmap, 0x28,
> ADF4377_SYNTH_LOCK_TO_MSB_MSK,
> +
> FIELD_PREP(ADF4377_SYNTH_LOCK_TO_MSB_MSK,
> + st->synth_lock_timeout >>
> 8));
> + if (ret)
> + return ret;
> +
> + ret = regmap_write(st->regmap, 0x29,
> + FIELD_PREP(ADF4377_VCO_ALC_TO_LSB_MSK, st-
> >vco_alc_timeout));
> + if (ret)
> + return ret;
> +
> + ret = regmap_update_bits(st->regmap, 0x2A,
> ADF4377_VCO_ALC_TO_MSB_MSK,
> +
> FIELD_PREP(ADF4377_VCO_ALC_TO_MSB_MSK, st->vco_alc_timeout >> 8));
> + if (ret)
> + return ret;
> +
> + ret = regmap_write(st->regmap, 0x26,
> + FIELD_PREP(ADF4377_VCO_BAND_DIV_MSK, st-
> >vco_band_div));
> + if (ret)
> + return ret;
> +
> + ret = regmap_write(st->regmap, 0x2D,
> + FIELD_PREP(ADF4377_ADC_CLK_DIV_MSK, st-
> >adc_clk_div));
> + if (ret)
> + return ret;
> +
> + st->clkout_div_sel = 0;
> +
> + if (freq > ADF4377_MAX_CLKPN_FREQ || freq <
> ADF4377_MIN_CLKPN_FREQ) {
> + ret = -EINVAL;
> + return ret;
> + }
> +
> + f_vco = freq;
> +
> + while (f_vco < ADF4377_MIN_VCO_FREQ) {
> + f_vco <<= 1;
> + st->clkout_div_sel++;
> + }
> +
> + st->n_int = div_u64(freq, st->f_pfd);
> +
> + ret = regmap_update_bits(st->regmap, 0x11,
> ADF4377_EN_RDBLR_MSK | ADF4377_N_INT_MSB_MSK,
> + FIELD_PREP(ADF4377_EN_RDBLR_MSK,
> ADF4377_REF_DBLR_DIS) |
> + FIELD_PREP(ADF4377_N_INT_MSB_MSK,
> st->n_int >> 8));
> + if (ret)
> + return ret;
> +
> + ret = regmap_update_bits(st->regmap, 0x12, ADF4377_R_DIV_MSK
> | ADF4377_CLKOUT_DIV_MSK,
> + FIELD_PREP(ADF4377_CLKOUT_DIV_MSK,
> st->clkout_div_sel) |
> + FIELD_PREP(ADF4377_R_DIV_MSK, st-
> >ref_div_factor));
> + if (ret)
> + return ret;
> +
> + ret = regmap_write(st->regmap, 0x10,
> + FIELD_PREP(ADF4377_N_INT_LSB_MSK, st-
> >n_int));
> + if (ret)
> + return ret;
> +
> + ret = regmap_read_poll_timeout(st->regmap, 0x49, read_val,
> + !(read_val &
> (ADF4377_FSM_BUSY_MSK)), 200, 200 * 100);
> + if (ret)
> + return ret;
> +
> + /* Disable EN_DNCLK, EN_DRCLK */
> + ret = regmap_update_bits(st->regmap, 0x1C,
> ADF4377_EN_DNCLK_MSK | ADF4377_EN_DRCLK_MSK,
> + FIELD_PREP(ADF4377_EN_DNCLK_MSK,
> ADF4377_EN_DNCLK_OFF) |
> + FIELD_PREP(ADF4377_EN_DRCLK_MSK,
> ADF4377_EN_DRCLK_OFF));
> + if (ret)
> + return ret;
> +
> + /* Disable EN_ADC_CLK */
> + ret = regmap_update_bits(st->regmap, 0x20,
> ADF4377_EN_ADC_CLK_MSK,
> + FIELD_PREP(ADF4377_EN_ADC_CLK_MSK,
> ADF4377_EN_ADC_CLK_DIS));
> + if (ret)
> + return ret;
> +
> + /* Set output Amplitude */
> + return regmap_update_bits(st->regmap, 0x19,
> ADF4377_CLKOUT2_OP_MSK | ADF4377_CLKOUT1_OP_MSK,
> + FIELD_PREP(ADF4377_CLKOUT1_OP_MSK,
> ADF4377_CLKOUT_420MV) |
> + FIELD_PREP(ADF4377_CLKOUT2_OP_MSK,
> ADF4377_CLKOUT_420MV));
> +}
> +
> +static void adf4377_gpio_init(struct adf4377_state *st)
> +{
> + if (st->gpio_ce) {
> + gpiod_set_value(st->gpio_ce, 1);
> +
> + /* Delay for SPI register bits to settle to their
> power-on reset state */
> + usleep_range(200, 250);
fsleep()?
> + }
> +
> + if (st->gpio_enclk1)
> + gpiod_set_value(st->gpio_enclk1, 1);
> +
> + if (st->gpio_enclk2 && st->type == ADF4377)
> + gpiod_set_value(st->gpio_enclk2, 1);
> +}
> +
> +static int adf4377_init(struct adf4377_state *st)
> +{
> + int ret;
> +
> + /* GPIO Inititalization */
> + adf4377_gpio_init(st);
> +
> + /* Software reset */
> + ret = adf4377_soft_reset(st);
> + if (ret)
> + return ret;
> +
> + /* Set Default Registers */
> + ret = adf4377_set_default(st);
> + if (ret)
> + return ret;
> +
> + ret = regmap_update_bits(st->regmap, 0x15, ADF4377_CP_I_MSK,
> + FIELD_PREP(ADF4377_CP_I_MSK,
> ADF4377_CP_10MA1));
> + if (ret)
> + return ret;
> +
> + ret = regmap_update_bits(st->regmap, 0x00,
we should have some meaningful names for the registers...
> + ADF4377_SDO_ACTIVE_MSK |
> ADF4377_SDO_ACTIVE_R_MSK,
> + FIELD_PREP(ADF4377_SDO_ACTIVE_MSK,
> ADF4377_SDO_ACTIVE_SPI_4W) |
> + FIELD_PREP(ADF4377_SDO_ACTIVE_R_MSK,
> ADF4377_SDO_ACTIVE_SPI_4W));
> + if (ret)
> + return ret;
> +
> + st->clkin_freq = clk_get_rate(st->clkin);
> +
> + /* Power Up */
> + ret = regmap_write(st->regmap, 0x1a,
> + FIELD_PREP(ADF4377_PD_ALL_MSK,
> ADF4377_PD_ALL_N_OP) |
> + FIELD_PREP(ADF4377_PD_RDIV_MSK,
> ADF4377_PD_RDIV_N_OP) |
> + FIELD_PREP(ADF4377_PD_NDIV_MSK,
> ADF4377_PD_NDIV_N_OP) |
> + FIELD_PREP(ADF4377_PD_VCO_MSK,
> ADF4377_PD_VCO_N_OP) |
> + FIELD_PREP(ADF4377_PD_LD_MSK,
> ADF4377_PD_LD_N_OP) |
> + FIELD_PREP(ADF4377_PD_PFDCP_MSK,
> ADF4377_PD_PFDCP_N_OP) |
> + FIELD_PREP(ADF4377_PD_CLKOUT1_MSK,
> ADF4377_PD_CLKOUT1_N_OP) |
> + FIELD_PREP(ADF4377_PD_CLKOUT2_MSK,
> ADF4377_PD_CLKOUT2_N_OP));
> + if (ret)
> + return ret;
> +
> + /* Compute PFD */
> + st->ref_div_factor = 0;
> + do {
> + st->ref_div_factor++;
> + st->f_pfd = st->clkin_freq / st->ref_div_factor;
> + } while (st->f_pfd > ADF4377_MAX_FREQ_PFD);
> +
> + if (st->f_pfd > ADF4377_MAX_FREQ_PFD || st->f_pfd <
> ADF4377_MIN_FREQ_PFD)
> + return -EINVAL;
> +
> + st->f_div_rclk = st->f_pfd;
> +
> + if (st->f_pfd <= ADF4377_FREQ_PFD_80MHZ) {
> + st->dclk_div1 = ADF4377_DCLK_DIV1_1;
> + st->dclk_div2 = ADF4377_DCLK_DIV2_1;
> + st->dclk_mode = ADF4377_DCLK_MODE_DIS;
> + } else if (st->f_pfd <= ADF4377_FREQ_PFD_125MHZ) {
> + st->dclk_div1 = ADF4377_DCLK_DIV1_1;
> + st->dclk_div2 = ADF4377_DCLK_DIV2_1;
> + st->dclk_mode = ADF4377_DCLK_MODE_EN;
> + } else if (st->f_pfd <= ADF4377_FREQ_PFD_160MHZ) {
> + st->dclk_div1 = ADF4377_DCLK_DIV1_2;
> + st->dclk_div2 = ADF4377_DCLK_DIV2_1;
> + st->dclk_mode = ADF4377_DCLK_MODE_DIS;
> + st->f_div_rclk /= 2;
> + } else if (st->f_pfd <= ADF4377_FREQ_PFD_250MHZ) {
> + st->dclk_div1 = ADF4377_DCLK_DIV1_2;
> + st->dclk_div2 = ADF4377_DCLK_DIV2_1;
> + st->dclk_mode = ADF4377_DCLK_MODE_EN;
> + st->f_div_rclk /= 2;
> + } else if (st->f_pfd <= ADF4377_FREQ_PFD_320MHZ) {
> + st->dclk_div1 = ADF4377_DCLK_DIV1_2;
> + st->dclk_div2 = ADF4377_DCLK_DIV2_2;
> + st->dclk_mode = ADF4377_DCLK_MODE_DIS;
> + st->f_div_rclk /= 4;
> + } else {
> + st->dclk_div1 = ADF4377_DCLK_DIV1_2;
> + st->dclk_div2 = ADF4377_DCLK_DIV2_2;
> + st->dclk_mode = ADF4377_DCLK_MODE_EN;
> + st->f_div_rclk /= 4;
> + }
> +
> + st->synth_lock_timeout = DIV_ROUND_UP(st->f_div_rclk, 50000);
> + st->vco_alc_timeout = DIV_ROUND_UP(st->f_div_rclk, 20000);
> + st->vco_band_div = DIV_ROUND_UP(st->f_div_rclk, 150000 * 16 *
> (1 << st->dclk_mode));
> + st->adc_clk_div = DIV_ROUND_UP((st->f_div_rclk / 400000 - 2),
> 4);
> +
> + return 0;
> +}
> +
> +static ssize_t adf4377_read(struct iio_dev *indio_dev, uintptr_t
> private,
> + const struct iio_chan_spec *chan, char
> *buf)
> +{
> + struct adf4377_state *st = iio_priv(indio_dev);
> + u64 val = 0;
> + int ret;
> +
> + switch ((u32)private) {
> + case ADF4377_FREQ:
> + ret = adf4377_get_freq(st, &val);
> + break;
> + default:
> + ret = -EINVAL;
> + val = 0;
> + break;
> + }
> +
> + return ret ?: sysfs_emit(buf, "%llu\n", val);
I would also return in place. I've come to prefer it but that's me :)
> +}
> +
> +static ssize_t adf4377_write(struct iio_dev *indio_dev, uintptr_t
> private,
> + const struct iio_chan_spec *chan, const
> char *buf,
> + size_t len)
> +{
> + struct adf4377_state *st = iio_priv(indio_dev);
> + unsigned long long freq;
> + int ret;
> +
> + mutex_lock(&st->lock);
> + switch ((u32)private) {
> + case ADF4377_FREQ:
> + ret = kstrtoull(buf, 10, &freq);
> + if (ret)
> + break;
> +
> + ret = adf4377_set_freq(st, freq);
> + break;
> + default:
> + ret = -EINVAL;
> + break;
> + }
> +
I think we can just return in place on the each switch()... We can just
move the lock inside adf4377_set_freq()?
> + mutex_unlock(&st->lock);
> +
> + return ret ? ret : len;
> +}
> +
> +static int adf4377_set_muxout_mode(struct iio_dev *indio_dev,
> + const struct iio_chan_spec *chan,
> + unsigned int mode)
> +{
> + struct adf4377_state *st = iio_priv(indio_dev);
> +
> + return regmap_update_bits(st->regmap, 0x1D,
> + ADF4377_MUXOUT_MSK,
> + FIELD_PREP(ADF4377_MUXOUT_MSK,
> mode));
> +}
> +
> +static int adf4377_get_muxout_mode(struct iio_dev *indio_dev,
> + const struct iio_chan_spec *chan)
> +{
> + struct adf4377_state *st = iio_priv(indio_dev);
> + unsigned int mode;
> + int ret;
> +
> + ret = regmap_read(st->regmap, 0x1D, &mode);
> +
Maybe something more descriptive than 0x1D?
> + return ret ? : FIELD_GET(ADF4377_MUXOUT_MSK, mode);
> +}
> +
> +static const struct iio_enum adf4377_muxout_enum = {
> + .items = adf4377_muxout_modes,
> + .num_items = ARRAY_SIZE(adf4377_muxout_modes),
> + .get = adf4377_get_muxout_mode,
> + .set = adf4377_set_muxout_mode,
> +};
> +
> +#define _ADF4377_EXT_INFO(_name, _shared, _ident) { \
> + .name = _name, \
> + .read = adf4377_read, \
> + .write = adf4377_write, \
> + .private = _ident, \
> + .shared = _shared, \
> + }
> +
> +static const struct iio_chan_spec_ext_info adf4377_ext_info[] = {
> + /*
> + * Usually we use IIO_CHAN_INFO_FREQUENCY, but there are
> + * values > 2^32 in order to support the entire frequency
> range
> + * in Hz.
> + */
> + _ADF4377_EXT_INFO("frequency", IIO_SHARED_BY_ALL,
> ADF4377_FREQ),
Can't we have u64 already in IIO_CHAN_INFO_FREQUENCY? I know the write
side is a bit awkward but I think we can make it better.
> + IIO_ENUM("muxout_select", IIO_SHARED_BY_ALL,
> &adf4377_muxout_enum),
> + IIO_ENUM_AVAILABLE("muxout_select", IIO_SHARED_BY_ALL,
> &adf4377_muxout_enum),
> + { },
> +};
> +
> +static const struct iio_chan_spec adf4377_channels[] = {
> + {
> + .type = IIO_ALTVOLTAGE,
> + .indexed = 1,
> + .output = 1,
> + .channel = 0,
> + .ext_info = adf4377_ext_info,
> + },
> +};
> +
> +static int adf4377_properties_parse(struct adf4377_state *st)
> +{
> + struct spi_device *spi = st->spi;
> +
> + st->clkin = devm_clk_get(&spi->dev, "ref_in");
> + if (IS_ERR(st->clkin))
> + return dev_err_probe(&spi->dev, PTR_ERR(st->clkin),
> + "failed to get the reference
> input clock\n");
> +
> + st->gpio_ce = devm_gpiod_get_optional(&st->spi->dev, "ce-en",
> + GPIOD_OUT_HIGH);
> + if (IS_ERR(st->gpio_ce))
> + return dev_err_probe(&spi->dev, PTR_ERR(st->gpio_ce),
> + "failed to get the CE GPIO\n");
> +
> + st->gpio_enclk1 = devm_gpiod_get_optional(&st->spi->dev,
> "enclk1",
> + GPIOD_OUT_HIGH);
> + if (IS_ERR(st->gpio_enclk1))
> + return dev_err_probe(&spi->dev, PTR_ERR(st-
> >gpio_enclk1),
> + "failed to get the CE GPIO\n");
> +
> + if (st->type == ADF4377) {
> + st->gpio_enclk2 = devm_gpiod_get_optional(&st->spi-
> >dev, "enclk2",
> +
> GPIOD_OUT_HIGH);
> + if (IS_ERR(st->gpio_enclk2))
> + return dev_err_probe(&spi->dev, PTR_ERR(st-
> >gpio_enclk2),
> + "failed to get the CE
> GPIO\n");
> + }
> +
> + return 0;
> +}
> +
> +static int adf4377_freq_change(struct notifier_block *nb, unsigned
> long action, void *data)
> +{
> + struct adf4377_state *st = container_of(nb, struct
> adf4377_state, nb);
> + int ret;
> +
> + if (action == POST_RATE_CHANGE) {
> + mutex_lock(&st->lock);
> + ret = notifier_from_errno(adf4377_init(st));
> + mutex_unlock(&st->lock);
> + return ret;
> + }
> +
> + return NOTIFY_OK;
> +}
> +
> +static void adf4377_clk_disable(void *data)
> +{
> + clk_disable_unprepare(data);
> +}
> +
> +static int adf4377_probe(struct spi_device *spi)
> +{
> + struct iio_dev *indio_dev;
> + struct regmap *regmap;
> + struct adf4377_state *st;
> + int ret;
> +
> + indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*st));
> + if (!indio_dev)
> + return -ENOMEM;
> +
> + regmap = devm_regmap_init_spi(spi, &adf4377_regmap_config);
> + if (IS_ERR(regmap))
> + return PTR_ERR(regmap);
> +
> + st = iio_priv(indio_dev);
> +
> + indio_dev->info = &adf4377_info;
> + indio_dev->name = "adf4377";
> + indio_dev->channels = adf4377_channels;
> + indio_dev->num_channels = ARRAY_SIZE(adf4377_channels);
> +
> + st->regmap = regmap;
> + st->spi = spi;
> + st->type = spi_get_device_id(spi)->driver_data;
Hmm this is something that came up internally the other day. Are we
guaranteed that this will always work? For OF I think it is but I'm not
sure about ACPI? At first glance, it seems that it might be ok but I
did not went too deep in the ACPI code.
> + mutex_init(&st->lock);
> +
> + ret = adf4377_properties_parse(st);
> + if (ret)
> + return ret;
> +
> + ret = clk_prepare_enable(st->clkin);
> + if (ret)
> + return ret;
> +
> + ret = devm_add_action_or_reset(&spi->dev,
> adf4377_clk_disable, st->clkin);
> + if (ret)
> + return ret;
> +
> + st->nb.notifier_call = adf4377_freq_change;
> + ret = devm_clk_notifier_register(&spi->dev, st->clkin, &st-
> >nb);
> + if (ret)
> + return ret;
> +
> + ret = adf4377_init(st);
> + if (ret) {
> + dev_err(&spi->dev, "adf4377 init failed\n");
I would make sure to print all the error paths (that matter) in
adf4377_init() and just return in here...
- Nuno Sá
On 04/11/2022 05:27, Antoniu Miclaus wrote:
> Add device tree bindings for the ADF4377 driver.
Subject: drop "doc"
>
> Signed-off-by: Antoniu Miclaus <[email protected]>
> ---
> .../bindings/iio/frequency/adi,adf4377.yaml | 78 +++++++++++++++++++
> 1 file changed, 78 insertions(+)
> create mode 100644 Documentation/devicetree/bindings/iio/frequency/adi,adf4377.yaml
>
> diff --git a/Documentation/devicetree/bindings/iio/frequency/adi,adf4377.yaml b/Documentation/devicetree/bindings/iio/frequency/adi,adf4377.yaml
> new file mode 100644
> index 000000000000..3f5c83e03bb9
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/iio/frequency/adi,adf4377.yaml
> @@ -0,0 +1,78 @@
> +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
> +%YAML 1.2
> +---
> +$id: http://devicetree.org/schemas/iio/frequency/adi,adf4377.yaml#
> +$schema: http://devicetree.org/meta-schemas/core.yaml#
> +
> +title: ADF4377 Microwave Wideband Synthesizer with Integrated VCO
> +
> +maintainers:
> + - Antoniu Miclaus <[email protected]>
> + - Dragos Bogdan <[email protected]>
> +
> +description: |
> + The ADF4377 is a high performance, ultralow jitter, dual output integer-N
> + phased locked loop (PLL) with integrated voltage controlled oscillator (VCO)
> + ideally suited for data converter and mixed signal front end (MxFE) clock
> + applications.
> +
> + https://www.analog.com/en/products/adf4377.html
> +
> +properties:
> + compatible:
> + enum:
> + - adi,adf4377
> + - adi,adf4378
> +
> + reg:
> + maxItems: 1
> +
> + spi-max-frequency:
> + maximum: 10000000
> +
> + clocks:
> + maxItems: 1
> +
> + clock-names:
> + description:
> + External clock that provides reference input frequency.
> + items:
> + - const: ref_in
> +
> + ce-en-gpios:
chip-enable-gpios
> + description:
> + Gpio that controls the Chip Enable Pin.
s/Gpio/GPIO/
(other places as well)
> + maxItems: 1
> +
> + enclk1-gpios:
clk1-enable-gpios
> + description:
> + Gpio that controls the Enable Clock 1 Output Buffer Pin.
> + maxItems: 1
> +
> + enclk2-gpios:
clk2-enable-gpios
> + description:
> + Gpio that controls the Enable Clock 2 Output Buffer Pin.
> + maxItems: 1
> +
> +required:
> + - compatible
> + - reg
> + - clocks
> + - clock-names
> +
allOf with reference to spi-peripheral-props.yaml
> +additionalProperties: false
> +
> +examples:
> + - |
> + spi {
> + #address-cells = <1>;
> + #size-cells = <0>;
> + frequency@0 {
> + compatible = "adi,adf4377";
> + reg = <0>;
> + spi-max-frequency = <10000000>;
> + clocks = <&adf4377_ref_in>;
> + clock-names = "ref_in";
> + };
> + };
> +...
Best regards,
Krzysztof
> > +
> > +required:
> > + - compatible
> > + - reg
> > + - clocks
> > + - clock-names
> > +
>
> allOf with reference to spi-peripheral-props.yaml
>
> > +additionalProperties: false
switch to unevaluatedProperties: false
as well when you do the spi-peripheral-props.yaml addition.
Easy to forget.
Jonathan
> > +
> > +examples:
> > + - |
> > + spi {
> > + #address-cells = <1>;
> > + #size-cells = <0>;
> > + frequency@0 {
> > + compatible = "adi,adf4377";
> > + reg = <0>;
> > + spi-max-frequency = <10000000>;
> > + clocks = <&adf4377_ref_in>;
> > + clock-names = "ref_in";
> > + };
> > + };
> > +...
>
> Best regards,
> Krzysztof
>
On Fri, 4 Nov 2022 11:27:58 +0200
Antoniu Miclaus <[email protected]> wrote:
> The ADF4377 is a high performance, ultralow jitter, dual output integer-N
> phased locked loop (PLL) with integrated voltage controlled oscillator
> (VCO) ideally suited for data converter and mixed signal front end (MxFE)
> clock applications.
>
> Antoniu Miclaus (3):
> dt-bindings: iio: frequency: add adf4377 doc
> iio: frequency: adf4377: add support for ADF4377
> Documentation: ABI: testing: adf4377: add ABI docs
4 patches in series. I guess you cut and paste from a different version
and overwrote that bit...
J
>
> .../testing/sysfs-bus-iio-frequency-adf4377 | 32 +
> .../bindings/iio/frequency/adi,adf4377.yaml | 78 ++
> drivers/iio/frequency/Kconfig | 10 +
> drivers/iio/frequency/Makefile | 1 +
> drivers/iio/frequency/adf4377.c | 1155 +++++++++++++++++
> 5 files changed, 1276 insertions(+)
> create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4377
> create mode 100644 Documentation/devicetree/bindings/iio/frequency/adi,adf4377.yaml
> create mode 100644 drivers/iio/frequency/adf4377.c
>
On Fri, 4 Nov 2022 11:28:01 +0200
Antoniu Miclaus <[email protected]> wrote:
> Add documentation for the use of the output frequency and muxout select.
>
> Signed-off-by: Antoniu Miclaus <[email protected]>
Hi Antoniu,
A few questions inline.
> ---
> .../testing/sysfs-bus-iio-frequency-adf4377 | 32 +++++++++++++++++++
> 1 file changed, 32 insertions(+)
> create mode 100644 Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4377
>
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4377 b/Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4377
> new file mode 100644
> index 000000000000..0324de5c9328
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-bus-iio-frequency-adf4377
> @@ -0,0 +1,32 @@
> +What: /sys/bus/iio/devices/iio:deviceX/frequency
> +KernelVersion:
> +Contact: [email protected]
> +Description:
> + Stores the PLL frequency in Hz for output channels.
> + Reading returns the frequency in Hz.
I'm a little confused. Should we not tie this to the output channels?
out_altvoltageX_frequency
> +
> +What: /sys/bus/iio/devices/iio:deviceX/muxout_select
Why would userspace change this?
I'd sort of expect this to typically be chosen by what it is physically wired
up to.
You could treat muxout_low and muxout_high as a gpio (possibly high_z as well).
If that were the case, then device tree binding should allow you detect that usecase.
Lock detector is normally wired to a GPI so that software can check if the lock is
successful (or it's wired to some other circuits we can't see). The two
clock dividers should be represented as a clock provider.
Note this is partly driven by my desire to keep custom ABI to the minimum because
it is rare that userspace has a clue what to do with it. That is probably less
of a consideration here though as I doubt this device is going to be much used
with software stacks that don't know exactly what it is.
Jonathan
> +KernelVersion:
> +Contact: [email protected]
> +Description:
> + The mux output allows the user to access various internal points on
> + the chip. Valid values that can be written are:
> + * high_z -> high impedance output
> + * lock_detect -> digital lock detector output
> + * muxout_low -> low output
> + * f_div_rclk_2 -> fdiv_rclk/2
> + * f_div_nclk_2 -> fdiv_nclk/2
> + * muxout_high -> high output
> +
> +What: /sys/bus/iio/devices/iio:deviceX/muxout_select_available
> +KernelVersion:
> +Contact: [email protected]
> +Description:
> + Reading this returns the valid values that can be written to the
> + muxout_mode attribute:
> + * high_z
> + * lock_detect
> + * muxout_low
> + * f_div_rclk_2
> + * f_div_nclk_2
> + * muxout_high
On Fri, 04 Nov 2022 12:38:07 +0100
Nuno Sá <[email protected]> wrote:
> On Fri, 2022-11-04 at 11:28 +0200, Antoniu Miclaus wrote:
> > The ADF4377 is a high performance, ultralow jitter, dual output
> > integer-N
> > phased locked loop (PLL) with integrated voltage controlled
> > oscillator
> > (VCO) ideally suited for data converter and mixed signal front end
> > (MxFE)
> > clock applications.
> >
> > Datasheet:
> > https://www.analog.com/media/en/technical-documentation/data-sheets/adf4377.pdf
> > Signed-off-by: Antoniu Miclaus <[email protected]>
Nuno, please crop to the bit you comment on. Doom scrolling isn't fun ;)
A few follow up comments inline.
Jonathan
> > ---
> > drivers/iio/frequency/Kconfig | 10 +
> > drivers/iio/frequency/Makefile | 1 +
> > drivers/iio/frequency/adf4377.c | 1154
...
> > +static ssize_t adf4377_read(struct iio_dev *indio_dev, uintptr_t
> > private,
> > + const struct iio_chan_spec *chan, char
> > *buf)
> > +{
> > + struct adf4377_state *st = iio_priv(indio_dev);
> > + u64 val = 0;
> > + int ret;
> > +
> > + switch ((u32)private) {
> > + case ADF4377_FREQ:
> > + ret = adf4377_get_freq(st, &val);
> > + break;
> > + default:
> > + ret = -EINVAL;
> > + val = 0;
> > + break;
> > + }
> > +
> > + return ret ?: sysfs_emit(buf, "%llu\n", val);
>
> I would also return in place. I've come to prefer it but that's me :)
Definitely if alternative is a ternary!
> > + return ret ? : FIELD_GET(ADF4377_MUXOUT_MSK, mode);
> > +}
> > +
> > +static const struct iio_enum adf4377_muxout_enum = {
> > + .items = adf4377_muxout_modes,
> > + .num_items = ARRAY_SIZE(adf4377_muxout_modes),
> > + .get = adf4377_get_muxout_mode,
> > + .set = adf4377_set_muxout_mode,
> > +};
> > +
> > +#define _ADF4377_EXT_INFO(_name, _shared, _ident) { \
> > + .name = _name, \
> > + .read = adf4377_read, \
> > + .write = adf4377_write, \
> > + .private = _ident, \
> > + .shared = _shared, \
> > + }
> > +
> > +static const struct iio_chan_spec_ext_info adf4377_ext_info[] = {
> > + /*
> > + * Usually we use IIO_CHAN_INFO_FREQUENCY, but there are
> > + * values > 2^32 in order to support the entire frequency
> > range
> > + * in Hz.
> > + */
> > + _ADF4377_EXT_INFO("frequency", IIO_SHARED_BY_ALL,
> > ADF4377_FREQ),
>
> Can't we have u64 already in IIO_CHAN_INFO_FREQUENCY? I know the write
> side is a bit awkward but I think we can make it better.
hmm. I think we only have s64. If 63 bits is enough then we are good to go :)
(in the annals of bad design decisions, thinking years ago that no one would
go beyond 32 bits... oops).
>
> > + IIO_ENUM("muxout_select", IIO_SHARED_BY_ALL,
> > &adf4377_muxout_enum),
> > + IIO_ENUM_AVAILABLE("muxout_select", IIO_SHARED_BY_ALL,
> > &adf4377_muxout_enum),
> > + { },
> > +};
> > +
...
> > +
> > +static int adf4377_probe(struct spi_device *spi)
> > +{
> > + struct iio_dev *indio_dev;
> > + struct regmap *regmap;
> > + struct adf4377_state *st;
> > + int ret;
> > +
> > + indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*st));
> > + if (!indio_dev)
> > + return -ENOMEM;
> > +
> > + regmap = devm_regmap_init_spi(spi, &adf4377_regmap_config);
> > + if (IS_ERR(regmap))
> > + return PTR_ERR(regmap);
> > +
> > + st = iio_priv(indio_dev);
> > +
> > + indio_dev->info = &adf4377_info;
> > + indio_dev->name = "adf4377";
> > + indio_dev->channels = adf4377_channels;
> > + indio_dev->num_channels = ARRAY_SIZE(adf4377_channels);
> > +
> > + st->regmap = regmap;
> > + st->spi = spi;
> > + st->type = spi_get_device_id(spi)->driver_data;
>
> Hmm this is something that came up internally the other day. Are we
> guaranteed that this will always work? For OF I think it is but I'm not
> sure about ACPI? At first glance, it seems that it might be ok but I
> did not went too deep in the ACPI code.
Better indeed to not assume it and indeed ACPI can't do this magic, because
there isn't a match between the actual ACPI ID and the spi_device_ids.
Not sure what it does with PRP0001 case (where it uses the of_device_id table).
st->type = device_get_match_id()->driver_data;
if (!st->type) {
const struct spi_device_id *id = spi_get_device_id(spi);
if (!id)
return -EINVAL;
st->type = spi_get_device_id(spi)->driver_data;
}
would be my preferred pattern. Andy had a suggestion to roll this
up in a standard function, but not gone anywhere yet.
>
Jonathan
On Fri, 4 Nov 2022 11:28:00 +0200
Antoniu Miclaus <[email protected]> wrote:
> The ADF4377 is a high performance, ultralow jitter, dual output integer-N
> phased locked loop (PLL) with integrated voltage controlled oscillator
> (VCO) ideally suited for data converter and mixed signal front end (MxFE)
> clock applications.
>
> Datasheet: https://www.analog.com/media/en/technical-documentation/data-sheets/adf4377.pdf
> Signed-off-by: Antoniu Miclaus <[email protected]>
Mainly because I can't remember the argument, though I clearly accepted it in
the past ;) Why do we have these PLL devices in IIO rather than via the clk framework?
A few comments inline to add to those of the other reviewers - I've tried not
to overlap too much!
> ---
> drivers/iio/frequency/Kconfig | 10 +
> drivers/iio/frequency/Makefile | 1 +
> drivers/iio/frequency/adf4377.c | 1154 +++++++++++++++++++++++++++++++
> 3 files changed, 1165 insertions(+)
> create mode 100644 drivers/iio/frequency/adf4377.c
>
...
> diff --git a/drivers/iio/frequency/adf4377.c b/drivers/iio/frequency/adf4377.c
> new file mode 100644
> index 000000000000..1901dde1003e
> --- /dev/null
> +++ b/drivers/iio/frequency/adf4377.c
> @@ -0,0 +1,1154 @@
> +// SPDX-License-Identifier: GPL-2.0-only
> +/*
> + * ADF4377 driver
> + *
> + * Copyright 2022 Analog Devices Inc.
> + */
> +
> +#include <linux/bitfield.h>
> +#include <linux/bits.h>
> +#include <linux/clk.h>
> +#include <linux/clkdev.h>
> +#include <linux/delay.h>
> +#include <linux/device.h>
> +#include <linux/module.h>
> +#include <linux/notifier.h>
> +#include <linux/property.h>
> +#include <linux/spi/spi.h>
> +#include <linux/iio/iio.h>
> +#include <linux/regmap.h>
> +#include <linux/units.h>
> +
> +#include <linux/gpio/consumer.h>
Why singled out for it's own block?
That would kind of make sense for the iio headers because this is an IIO
driver but not this one.
> +
> +/* ADF4377 REG0000 Map */
Normally we'd somehow encode which register it is
within the field defines. Seems this particular part
doesn't bother with register names. Maybe..
#define ADF4377_0000_SOFT_RESET_R_MSK
etc? Ideally then dropping the comments, perhaps with the
exception of one at the top saying the datasheet doesn't give
any registers names so we have to use the address.
> +#define ADF4377_SOFT_RESET_R_MSK BIT(7)
> +#define ADF4377_LSB_FIRST_R_MSK BIT(6)
> +#define ADF4377_ADDRESS_ASC_R_MSK BIT(5)
> +#define ADF4377_SDO_ACTIVE_R_MSK BIT(4)
> +#define ADF4377_SDO_ACTIVE_MSK BIT(3)
> +#define ADF4377_ADDRESS_ASC_MSK BIT(2)
> +#define ADF4377_LSB_FIRST_MSK BIT(1)
> +#define ADF4377_SOFT_RESET_MSK BIT(0)
> +
> +/* ADF4377 REG0000 Bit Definition */
> +#define ADF4377_SDO_ACTIVE_SPI_3W 0x0
> +#define ADF4377_SDO_ACTIVE_SPI_4W 0x1
These would need the register address prefix as well.
I'd also be tempted to just ignore the docs and call that
bit ADF4377_0000_4_WIRE
That way you won't need to define the values of the field.
Might be able to do similar with some of the others.
> +
> +#define ADF4377_ADDR_ASC_AUTO_DECR 0x0
> +#define ADF4377_ADDR_ASC_AUTO_INCR 0x1
> +
> +#define ADF4377_LSB_FIRST_MSB 0x0
> +#define ADF4377_LSB_FIRST_LSB 0x1
Again, you can probably make this a flag with the 1 value and 0 value
having obvious meaning.
> +
> +#define ADF4377_SOFT_RESET_N_OP 0x0
I'd define the bit as SOFT_RESET_EN then value of 1 and 0 is obvious
without needing defines.
Same might be doable for later fields, but I haven't looked closely.
> +#define ADF4377_SOFT_RESET_EN 0x1
> +
> +/* ADF4377 REG0001 Map */
> +#define ADF4377_SINGLE_INSTR_MSK BIT(7)
> +#define ADF4377_MASTER_RB_CTRL_MSK BIT(5)
> +
> +/* ADF4377 REG0001 Bit Definition */
> +#define ADF4377_SPI_STREAM_EN 0x0
> +#define ADF4377_SPI_STREAM_DIS 0x1
Just call the bit SPI_STREAM_DIS and use FIELD_PREP(ADF4377_00001_SPI_STREAM_DIS, 0) etc.
> +
> +#define ADF4377_RB_SLAVE_REG 0x0
subordinate on datasheet.
> +#define ADF4377_RB_MASTER_REG 0x1
main on datasheet.
> +
...
> +/* ADF4377 REG001A Map */
> +#define ADF4377_PD_ALL_MSK BIT(7)
> +#define ADF4377_PD_RDIV_MSK BIT(6)
> +#define ADF4377_PD_NDIV_MSK BIT(5)
> +#define ADF4377_PD_VCO_MSK BIT(4)
> +#define ADF4377_PD_LD_MSK BIT(3)
> +#define ADF4377_PD_PFDCP_MSK BIT(2)
> +#define ADF4377_PD_CLKOUT1_MSK BIT(1)
> +#define ADF4377_PD_CLKOUT2_MSK BIT(0)
> +
> +/* ADF4377 REG001A Bit Definition */
> +#define ADF4377_PD_ALL_N_OP 0x0
Don't bother with normal operation defines. Also
just define the mask.
#define ADF4377_001A_PD_ALL BIT(7)
FIELD_PREP(ADF4377_001A_PD_ALL, 0 or 1)
is then clear with fewer defines and short lines at call site.
Anyhow, I've picked out a few examples. Similar approaches may
make other parts of the code more readable.
> +#define ADF4377_PD_ALL_PD 0x1
> +
...
> +struct adf4377_state {
> + struct spi_device *spi;
> + enum adf4377_dev_type type;
> + struct regmap *regmap;
> + struct clk *clkin;
> + /* Protect against concurrent accesses to the device and data content */
> + struct mutex lock;
> + struct notifier_block nb;
> + /* Reference Divider */
> + unsigned int ref_div_factor;
> + /* PFD Frequency */
> + unsigned int f_pfd;
> + /* Input Reference Clock */
> + unsigned int clkin_freq;
> + /* CLKOUT Divider */
> + u8 clkout_div_sel;
> + /* Feedback Divider (N) */
> + u16 n_int;
> + u16 synth_lock_timeout;
> + u16 vco_alc_timeout;
> + u16 adc_clk_div;
> + u16 vco_band_div;
> + u8 dclk_div1;
> + u8 dclk_div2;
> + u8 dclk_mode;
> + unsigned int f_div_rclk;
> + struct gpio_desc *gpio_ce;
> + struct gpio_desc *gpio_enclk1;
> + struct gpio_desc *gpio_enclk2;
> + u8 buf[2] ____cacheline_aligned;
__aligned(IIO_DMA_MINALIGN)
Cacheline line alignment isn't enough on few obsure ARM cores where
that reflects the l1 cacheline, but coherency needs handling at
a slower cache level which has longer cachelines.
> +};
> +
> +static int adf4377_set_default(struct adf4377_state *st)
regmap has infrastructure to do this from a table. Use that rather
than hand coding it. If there is a strong reason to do otherwise
then add a comment here.
...
> +
> +int adf4377_set_freq(struct adf4377_state *st, u64 freq)
This is awfully involved. Perhaps a comment or spec reference for the register
write sequence?
> +{
> + unsigned int read_val;
> + u64 f_vco;
> + int ret;
> +
> + ret = regmap_update_bits(st->regmap, 0x1C, ADF4377_EN_DNCLK_MSK | ADF4377_EN_DRCLK_MSK,
> + FIELD_PREP(ADF4377_EN_DNCLK_MSK, ADF4377_EN_DNCLK_ON) |
> + FIELD_PREP(ADF4377_EN_DRCLK_MSK, ADF4377_EN_DRCLK_ON));
> + if (ret)
> + return ret;
> +
> + ret = regmap_update_bits(st->regmap, 0x11, ADF4377_EN_AUTOCAL_MSK | ADF4377_DCLK_DIV2_MSK,
> + FIELD_PREP(ADF4377_EN_AUTOCAL_MSK, ADF4377_VCO_CALIB_EN) |
> + FIELD_PREP(ADF4377_DCLK_DIV2_MSK, st->dclk_div2));
> + if (ret)
> + return ret;
> +
... lots more ...
> +
> +static void adf4377_gpio_init(struct adf4377_state *st)
> +{
> + if (st->gpio_ce) {
> + gpiod_set_value(st->gpio_ce, 1);
This was driven high at the gpiod_get_optional() so we are leaving it the same. Maybe makes
sense to drive it low at request and high here so as to force a reset?
> +
> + /* Delay for SPI register bits to settle to their power-on reset state */
> + usleep_range(200, 250);
> + }
> +
> + if (st->gpio_enclk1)
> + gpiod_set_value(st->gpio_enclk1, 1);
So is the assumption here that if we don't have control of these they are all tied to 1?
Perhaps a comment to say that if so...
Is turning these off a power saving thing? If so I'd expect that in the remove() path
probably via a devm_add_action_or_reset() type call.
> +
> + if (st->gpio_enclk2 && st->type == ADF4377)
> + gpiod_set_value(st->gpio_enclk2, 1);
> +}
> +
> +static int adf4377_init(struct adf4377_state *st)
> +{
> + int ret;
> +
> + /* GPIO Inititalization */
> + adf4377_gpio_init(st);
> +
> + /* Software reset */
> + ret = adf4377_soft_reset(st);
If I read the datasheet right, we could have already done a hardware reset.
Normally we'd not bother doing both.
> + if (ret)
> + return ret;
> +
> + /* Set Default Registers */
Name of function rather removes need for the comment. Same for the other two above.
> + ret = adf4377_set_default(st);
> + if (ret)
> + return ret;
> +
> + ret = regmap_update_bits(st->regmap, 0x15, ADF4377_CP_I_MSK,
Unlike the above calls, not so obvious what this is doing so a comment would be helpful.
> + FIELD_PREP(ADF4377_CP_I_MSK, ADF4377_CP_10MA1));
> + if (ret)
> + return ret;
> +
> + ret = regmap_update_bits(st->regmap, 0x00,
> + ADF4377_SDO_ACTIVE_MSK | ADF4377_SDO_ACTIVE_R_MSK,
> + FIELD_PREP(ADF4377_SDO_ACTIVE_MSK, ADF4377_SDO_ACTIVE_SPI_4W) |
> + FIELD_PREP(ADF4377_SDO_ACTIVE_R_MSK, ADF4377_SDO_ACTIVE_SPI_4W));
> + if (ret)
> + return ret;
> +
> + st->clkin_freq = clk_get_rate(st->clkin);
> +
> + /* Power Up */
> + ret = regmap_write(st->regmap, 0x1a,
> + FIELD_PREP(ADF4377_PD_ALL_MSK, ADF4377_PD_ALL_N_OP) |
> + FIELD_PREP(ADF4377_PD_RDIV_MSK, ADF4377_PD_RDIV_N_OP) |
> + FIELD_PREP(ADF4377_PD_NDIV_MSK, ADF4377_PD_NDIV_N_OP) |
> + FIELD_PREP(ADF4377_PD_VCO_MSK, ADF4377_PD_VCO_N_OP) |
> + FIELD_PREP(ADF4377_PD_LD_MSK, ADF4377_PD_LD_N_OP) |
> + FIELD_PREP(ADF4377_PD_PFDCP_MSK, ADF4377_PD_PFDCP_N_OP) |
> + FIELD_PREP(ADF4377_PD_CLKOUT1_MSK, ADF4377_PD_CLKOUT1_N_OP) |
> + FIELD_PREP(ADF4377_PD_CLKOUT2_MSK, ADF4377_PD_CLKOUT2_N_OP));
> + if (ret)
> + return ret;
> +
> + /* Compute PFD */
> + st->ref_div_factor = 0;
> + do {
> + st->ref_div_factor++;
> + st->f_pfd = st->clkin_freq / st->ref_div_factor;
> + } while (st->f_pfd > ADF4377_MAX_FREQ_PFD);
> +
> + if (st->f_pfd > ADF4377_MAX_FREQ_PFD || st->f_pfd < ADF4377_MIN_FREQ_PFD)
> + return -EINVAL;
> +
> + st->f_div_rclk = st->f_pfd;
> +
> + if (st->f_pfd <= ADF4377_FREQ_PFD_80MHZ) {
> + st->dclk_div1 = ADF4377_DCLK_DIV1_1;
> + st->dclk_div2 = ADF4377_DCLK_DIV2_1;
> + st->dclk_mode = ADF4377_DCLK_MODE_DIS;
> + } else if (st->f_pfd <= ADF4377_FREQ_PFD_125MHZ) {
> + st->dclk_div1 = ADF4377_DCLK_DIV1_1;
> + st->dclk_div2 = ADF4377_DCLK_DIV2_1;
> + st->dclk_mode = ADF4377_DCLK_MODE_EN;
> + } else if (st->f_pfd <= ADF4377_FREQ_PFD_160MHZ) {
> + st->dclk_div1 = ADF4377_DCLK_DIV1_2;
> + st->dclk_div2 = ADF4377_DCLK_DIV2_1;
> + st->dclk_mode = ADF4377_DCLK_MODE_DIS;
> + st->f_div_rclk /= 2;
> + } else if (st->f_pfd <= ADF4377_FREQ_PFD_250MHZ) {
> + st->dclk_div1 = ADF4377_DCLK_DIV1_2;
> + st->dclk_div2 = ADF4377_DCLK_DIV2_1;
> + st->dclk_mode = ADF4377_DCLK_MODE_EN;
> + st->f_div_rclk /= 2;
> + } else if (st->f_pfd <= ADF4377_FREQ_PFD_320MHZ) {
> + st->dclk_div1 = ADF4377_DCLK_DIV1_2;
> + st->dclk_div2 = ADF4377_DCLK_DIV2_2;
> + st->dclk_mode = ADF4377_DCLK_MODE_DIS;
> + st->f_div_rclk /= 4;
> + } else {
> + st->dclk_div1 = ADF4377_DCLK_DIV1_2;
> + st->dclk_div2 = ADF4377_DCLK_DIV2_2;
> + st->dclk_mode = ADF4377_DCLK_MODE_EN;
> + st->f_div_rclk /= 4;
> + }
> +
> + st->synth_lock_timeout = DIV_ROUND_UP(st->f_div_rclk, 50000);
> + st->vco_alc_timeout = DIV_ROUND_UP(st->f_div_rclk, 20000);
> + st->vco_band_div = DIV_ROUND_UP(st->f_div_rclk, 150000 * 16 * (1 << st->dclk_mode));
> + st->adc_clk_div = DIV_ROUND_UP((st->f_div_rclk / 400000 - 2), 4);
> +
> + return 0;
> +}
> +
> +
> +static const struct spi_device_id adf4377_id[] = {
> + { "adf4377", ADF4377 },
> + { "adf4378", ADF4378 },
> + {},
As below.
> +};
> +MODULE_DEVICE_TABLE(spi, adf4377_id);
> +
> +static const struct of_device_id adf4377_of_match[] = {
> + { .compatible = "adi,adf4377" },
> + { .compatible = "adi,adf4378" },
> + {},
No comma on NULL terminators. We shouldn't add anything after
them, so good to make that explicit.
> +};
> +MODULE_DEVICE_TABLE(of, adf4377_of_match);
> +
> +static struct spi_driver adf4377_driver = {
> + .driver = {
> + .name = "adf4377",
> + .of_match_table = adf4377_of_match,
> + },
> + .probe = adf4377_probe,
> + .id_table = adf4377_id,
> +};
> +module_spi_driver(adf4377_driver);
> +
> +MODULE_AUTHOR("Antoniu Miclaus <[email protected]>");
> +MODULE_DESCRIPTION("Analog Devices ADF4377");
> +MODULE_LICENSE("GPL");
On Sun, 2022-11-06 at 17:51 +0000, Jonathan Cameron wrote:
> On Fri, 04 Nov 2022 12:38:07 +0100
> Nuno Sá <[email protected]> wrote:
>
> > On Fri, 2022-11-04 at 11:28 +0200, Antoniu Miclaus wrote:
> > > The ADF4377 is a high performance, ultralow jitter, dual output
> > > integer-N
> > > phased locked loop (PLL) with integrated voltage controlled
> > > oscillator
> > > (VCO) ideally suited for data converter and mixed signal front
> > > end
> > > (MxFE)
> > > clock applications.
> > >
> > > Datasheet:
> > > https://www.analog.com/media/en/technical-documentation/data-sheets/adf4377.pdf
> > > Signed-off-by: Antoniu Miclaus <[email protected]>
>
> Nuno, please crop to the bit you comment on. Doom scrolling isn't
> fun ;)
>
Right, sorry about that :)
> A few follow up comments inline.
>
> Jonathan
>
> > > ---
> > > drivers/iio/frequency/Kconfig | 10 +
> > > drivers/iio/frequency/Makefile | 1 +
> > > drivers/iio/frequency/adf4377.c | 1154
>
> ...
> > > +static ssize_t adf4377_read(struct iio_dev *indio_dev, uintptr_t
> > > private,
> > > + const struct iio_chan_spec *chan,
> > > char
> > > *buf)
> > > +{
> > > + struct adf4377_state *st = iio_priv(indio_dev);
> > > + u64 val = 0;
> > > + int ret;
> > > +
> > > + switch ((u32)private) {
> > > + case ADF4377_FREQ:
> > > + ret = adf4377_get_freq(st, &val);
> > > + break;
> > > + default:
> > > + ret = -EINVAL;
> > > + val = 0;
> > > + break;
> > > + }
> > > +
> > > + return ret ?: sysfs_emit(buf, "%llu\n", val);
> >
> > I would also return in place. I've come to prefer it but that's me
> > :)
>
> Definitely if alternative is a ternary!
>
>
> > > + return ret ? : FIELD_GET(ADF4377_MUXOUT_MSK, mode);
> > > +}
> > > +
> > > +static const struct iio_enum adf4377_muxout_enum = {
> > > + .items = adf4377_muxout_modes,
> > > + .num_items = ARRAY_SIZE(adf4377_muxout_modes),
> > > + .get = adf4377_get_muxout_mode,
> > > + .set = adf4377_set_muxout_mode,
> > > +};
> > > +
> > > +#define _ADF4377_EXT_INFO(_name, _shared, _ident) { \
> > > + .name = _name, \
> > > + .read = adf4377_read, \
> > > + .write = adf4377_write, \
> > > + .private = _ident, \
> > > + .shared = _shared, \
> > > + }
> > > +
> > > +static const struct iio_chan_spec_ext_info adf4377_ext_info[] =
> > > {
> > > + /*
> > > + * Usually we use IIO_CHAN_INFO_FREQUENCY, but there are
> > > + * values > 2^32 in order to support the entire frequency
> > > range
> > > + * in Hz.
> > > + */
> > > + _ADF4377_EXT_INFO("frequency", IIO_SHARED_BY_ALL,
> > > ADF4377_FREQ),
> >
> > Can't we have u64 already in IIO_CHAN_INFO_FREQUENCY? I know the
> > write
> > side is a bit awkward but I think we can make it better.
>
> hmm. I think we only have s64. If 63 bits is enough then we are good
> to go :)
>
> (in the annals of bad design decisions, thinking years ago that no
> one would
> go beyond 32 bits... oops).
>
> >
> > > + IIO_ENUM("muxout_select", IIO_SHARED_BY_ALL,
> > > &adf4377_muxout_enum),
> > > + IIO_ENUM_AVAILABLE("muxout_select", IIO_SHARED_BY_ALL,
> > > &adf4377_muxout_enum),
> > > + { },
> > > +};
> > > +
>
> ...
>
> > > +
> > > +static int adf4377_probe(struct spi_device *spi)
> > > +{
> > > + struct iio_dev *indio_dev;
> > > + struct regmap *regmap;
> > > + struct adf4377_state *st;
> > > + int ret;
> > > +
> > > + indio_dev = devm_iio_device_alloc(&spi->dev,
> > > sizeof(*st));
> > > + if (!indio_dev)
> > > + return -ENOMEM;
> > > +
> > > + regmap = devm_regmap_init_spi(spi,
> > > &adf4377_regmap_config);
> > > + if (IS_ERR(regmap))
> > > + return PTR_ERR(regmap);
> > > +
> > > + st = iio_priv(indio_dev);
> > > +
> > > + indio_dev->info = &adf4377_info;
> > > + indio_dev->name = "adf4377";
> > > + indio_dev->channels = adf4377_channels;
> > > + indio_dev->num_channels = ARRAY_SIZE(adf4377_channels);
> > > +
> > > + st->regmap = regmap;
> > > + st->spi = spi;
> > > + st->type = spi_get_device_id(spi)->driver_data;
> >
> > Hmm this is something that came up internally the other day. Are we
> > guaranteed that this will always work? For OF I think it is but I'm
> > not
> > sure about ACPI? At first glance, it seems that it might be ok but
> > I
> > did not went too deep in the ACPI code.
>
> Better indeed to not assume it and indeed ACPI can't do this magic,
> because
> there isn't a match between the actual ACPI ID and the
> spi_device_ids.
> Not sure what it does with PRP0001 case (where it uses the
> of_device_id table).
Some comments/questions on the pattern:
>
>
> st->type = device_get_match_id()->driver_data;
Are we sure that device_get_match_id() (I guess you meant
device_get_match_data()) cannot return NULL? I'm always a bit on the
careful side with these dereferences...
> if (!st->type) {
> const struct spi_device_id *id =
> spi_get_device_id(spi);
>
> if (!id)
> return -EINVAL;
>
> st->type = spi_get_device_id(spi)->driver_data;
id->driver_data :)
> }
- Nuno Sá
device_get_match_id()->driver_data;