1 // SPDX-License-Identifier: GPL-2.0-only
5 * Copyright 2021 Analog Devices Inc.
8 #include <linux/bitfield.h>
9 #include <linux/bits.h>
10 #include <linux/clk.h>
11 #include <linux/device.h>
12 #include <linux/iio/iio.h>
13 #include <linux/module.h>
14 #include <linux/mod_devicetable.h>
15 #include <linux/notifier.h>
16 #include <linux/property.h>
17 #include <linux/regulator/consumer.h>
18 #include <linux/spi/spi.h>
19 #include <linux/units.h>
21 #include <asm/unaligned.h>
23 /* ADMV1013 Register Map */
24 #define ADMV1013_REG_SPI_CONTROL 0x00
25 #define ADMV1013_REG_ALARM 0x01
26 #define ADMV1013_REG_ALARM_MASKS 0x02
27 #define ADMV1013_REG_ENABLE 0x03
28 #define ADMV1013_REG_LO_AMP_I 0x05
29 #define ADMV1013_REG_LO_AMP_Q 0x06
30 #define ADMV1013_REG_OFFSET_ADJUST_I 0x07
31 #define ADMV1013_REG_OFFSET_ADJUST_Q 0x08
32 #define ADMV1013_REG_QUAD 0x09
33 #define ADMV1013_REG_VVA_TEMP_COMP 0x0A
35 /* ADMV1013_REG_SPI_CONTROL Map */
36 #define ADMV1013_PARITY_EN_MSK BIT(15)
37 #define ADMV1013_SPI_SOFT_RESET_MSK BIT(14)
38 #define ADMV1013_CHIP_ID_MSK GENMASK(11, 4)
39 #define ADMV1013_CHIP_ID 0xA
40 #define ADMV1013_REVISION_ID_MSK GENMASK(3, 0)
42 /* ADMV1013_REG_ALARM Map */
43 #define ADMV1013_PARITY_ERROR_MSK BIT(15)
44 #define ADMV1013_TOO_FEW_ERRORS_MSK BIT(14)
45 #define ADMV1013_TOO_MANY_ERRORS_MSK BIT(13)
46 #define ADMV1013_ADDRESS_RANGE_ERROR_MSK BIT(12)
48 /* ADMV1013_REG_ENABLE Map */
49 #define ADMV1013_VGA_PD_MSK BIT(15)
50 #define ADMV1013_MIXER_PD_MSK BIT(14)
51 #define ADMV1013_QUAD_PD_MSK GENMASK(13, 11)
52 #define ADMV1013_BG_PD_MSK BIT(10)
53 #define ADMV1013_MIXER_IF_EN_MSK BIT(7)
54 #define ADMV1013_DET_EN_MSK BIT(5)
56 /* ADMV1013_REG_LO_AMP Map */
57 #define ADMV1013_LOAMP_PH_ADJ_FINE_MSK GENMASK(13, 7)
58 #define ADMV1013_MIXER_VGATE_MSK GENMASK(6, 0)
60 /* ADMV1013_REG_OFFSET_ADJUST Map */
61 #define ADMV1013_MIXER_OFF_ADJ_P_MSK GENMASK(15, 9)
62 #define ADMV1013_MIXER_OFF_ADJ_N_MSK GENMASK(8, 2)
64 /* ADMV1013_REG_QUAD Map */
65 #define ADMV1013_QUAD_SE_MODE_MSK GENMASK(9, 6)
66 #define ADMV1013_QUAD_FILTERS_MSK GENMASK(3, 0)
68 /* ADMV1013_REG_VVA_TEMP_COMP Map */
69 #define ADMV1013_VVA_TEMP_COMP_MSK GENMASK(15, 0)
71 /* ADMV1013 Miscellaneous Defines */
72 #define ADMV1013_READ BIT(7)
73 #define ADMV1013_REG_ADDR_READ_MSK GENMASK(6, 1)
74 #define ADMV1013_REG_ADDR_WRITE_MSK GENMASK(22, 17)
75 #define ADMV1013_REG_DATA_MSK GENMASK(16, 1)
83 ADMV1013_RFMOD_I_CALIBPHASE,
84 ADMV1013_RFMOD_Q_CALIBPHASE,
88 ADMV1013_SE_MODE_POS = 6,
89 ADMV1013_SE_MODE_NEG = 9,
90 ADMV1013_SE_MODE_DIFF = 12
93 struct admv1013_state {
94 struct spi_device *spi;
96 /* Protect against concurrent accesses to the device and to data */
98 struct regulator *reg;
99 struct notifier_block nb;
100 unsigned int input_mode;
101 unsigned int quad_se_mode;
103 u8 data[3] __aligned(IIO_DMA_MINALIGN);
106 static int __admv1013_spi_read(struct admv1013_state *st, unsigned int reg,
110 struct spi_transfer t = {0};
112 st->data[0] = ADMV1013_READ | FIELD_PREP(ADMV1013_REG_ADDR_READ_MSK, reg);
116 t.rx_buf = &st->data[0];
117 t.tx_buf = &st->data[0];
120 ret = spi_sync_transfer(st->spi, &t, 1);
124 *val = FIELD_GET(ADMV1013_REG_DATA_MSK, get_unaligned_be24(&st->data[0]));
129 static int admv1013_spi_read(struct admv1013_state *st, unsigned int reg,
134 mutex_lock(&st->lock);
135 ret = __admv1013_spi_read(st, reg, val);
136 mutex_unlock(&st->lock);
141 static int __admv1013_spi_write(struct admv1013_state *st,
145 put_unaligned_be24(FIELD_PREP(ADMV1013_REG_DATA_MSK, val) |
146 FIELD_PREP(ADMV1013_REG_ADDR_WRITE_MSK, reg), &st->data[0]);
148 return spi_write(st->spi, &st->data[0], 3);
151 static int admv1013_spi_write(struct admv1013_state *st, unsigned int reg,
156 mutex_lock(&st->lock);
157 ret = __admv1013_spi_write(st, reg, val);
158 mutex_unlock(&st->lock);
163 static int __admv1013_spi_update_bits(struct admv1013_state *st, unsigned int reg,
164 unsigned int mask, unsigned int val)
167 unsigned int data, temp;
169 ret = __admv1013_spi_read(st, reg, &data);
173 temp = (data & ~mask) | (val & mask);
175 return __admv1013_spi_write(st, reg, temp);
178 static int admv1013_spi_update_bits(struct admv1013_state *st, unsigned int reg,
179 unsigned int mask, unsigned int val)
183 mutex_lock(&st->lock);
184 ret = __admv1013_spi_update_bits(st, reg, mask, val);
185 mutex_unlock(&st->lock);
190 static int admv1013_read_raw(struct iio_dev *indio_dev,
191 struct iio_chan_spec const *chan,
192 int *val, int *val2, long info)
194 struct admv1013_state *st = iio_priv(indio_dev);
195 unsigned int data, addr;
199 case IIO_CHAN_INFO_CALIBBIAS:
200 switch (chan->channel) {
202 addr = ADMV1013_REG_OFFSET_ADJUST_I;
205 addr = ADMV1013_REG_OFFSET_ADJUST_Q;
211 ret = admv1013_spi_read(st, addr, &data);
216 *val = FIELD_GET(ADMV1013_MIXER_OFF_ADJ_P_MSK, data);
218 *val = FIELD_GET(ADMV1013_MIXER_OFF_ADJ_N_MSK, data);
226 static int admv1013_write_raw(struct iio_dev *indio_dev,
227 struct iio_chan_spec const *chan,
228 int val, int val2, long info)
230 struct admv1013_state *st = iio_priv(indio_dev);
231 unsigned int addr, data, msk;
234 case IIO_CHAN_INFO_CALIBBIAS:
235 switch (chan->channel2) {
237 addr = ADMV1013_REG_OFFSET_ADJUST_I;
240 addr = ADMV1013_REG_OFFSET_ADJUST_Q;
246 if (!chan->channel) {
247 msk = ADMV1013_MIXER_OFF_ADJ_P_MSK;
248 data = FIELD_PREP(ADMV1013_MIXER_OFF_ADJ_P_MSK, val);
250 msk = ADMV1013_MIXER_OFF_ADJ_N_MSK;
251 data = FIELD_PREP(ADMV1013_MIXER_OFF_ADJ_N_MSK, val);
254 return admv1013_spi_update_bits(st, addr, msk, data);
260 static ssize_t admv1013_read(struct iio_dev *indio_dev,
262 const struct iio_chan_spec *chan,
265 struct admv1013_state *st = iio_priv(indio_dev);
266 unsigned int data, addr;
269 switch ((u32)private) {
270 case ADMV1013_RFMOD_I_CALIBPHASE:
271 addr = ADMV1013_REG_LO_AMP_I;
273 case ADMV1013_RFMOD_Q_CALIBPHASE:
274 addr = ADMV1013_REG_LO_AMP_Q;
280 ret = admv1013_spi_read(st, addr, &data);
284 data = FIELD_GET(ADMV1013_LOAMP_PH_ADJ_FINE_MSK, data);
286 return sysfs_emit(buf, "%u\n", data);
289 static ssize_t admv1013_write(struct iio_dev *indio_dev,
291 const struct iio_chan_spec *chan,
292 const char *buf, size_t len)
294 struct admv1013_state *st = iio_priv(indio_dev);
298 ret = kstrtou32(buf, 10, &data);
302 data = FIELD_PREP(ADMV1013_LOAMP_PH_ADJ_FINE_MSK, data);
304 switch ((u32)private) {
305 case ADMV1013_RFMOD_I_CALIBPHASE:
306 ret = admv1013_spi_update_bits(st, ADMV1013_REG_LO_AMP_I,
307 ADMV1013_LOAMP_PH_ADJ_FINE_MSK,
312 case ADMV1013_RFMOD_Q_CALIBPHASE:
313 ret = admv1013_spi_update_bits(st, ADMV1013_REG_LO_AMP_Q,
314 ADMV1013_LOAMP_PH_ADJ_FINE_MSK,
323 return ret ? ret : len;
326 static int admv1013_update_quad_filters(struct admv1013_state *st)
328 unsigned int filt_raw;
329 u64 rate = clk_get_rate(st->clkin);
331 if (rate >= (5400 * HZ_PER_MHZ) && rate <= (7000 * HZ_PER_MHZ))
333 else if (rate >= (5400 * HZ_PER_MHZ) && rate <= (8000 * HZ_PER_MHZ))
335 else if (rate >= (6600 * HZ_PER_MHZ) && rate <= (9200 * HZ_PER_MHZ))
340 return __admv1013_spi_update_bits(st, ADMV1013_REG_QUAD,
341 ADMV1013_QUAD_FILTERS_MSK,
342 FIELD_PREP(ADMV1013_QUAD_FILTERS_MSK, filt_raw));
345 static int admv1013_update_mixer_vgate(struct admv1013_state *st)
347 unsigned int mixer_vgate;
350 vcm = regulator_get_voltage(st->reg);
355 mixer_vgate = (2389 * vcm / 1000000 + 8100) / 100;
356 else if (vcm > 1800000 && vcm < 2600000)
357 mixer_vgate = (2375 * vcm / 1000000 + 125) / 100;
361 return __admv1013_spi_update_bits(st, ADMV1013_REG_LO_AMP_I,
362 ADMV1013_MIXER_VGATE_MSK,
363 FIELD_PREP(ADMV1013_MIXER_VGATE_MSK, mixer_vgate));
366 static int admv1013_reg_access(struct iio_dev *indio_dev,
368 unsigned int write_val,
369 unsigned int *read_val)
371 struct admv1013_state *st = iio_priv(indio_dev);
374 return admv1013_spi_read(st, reg, read_val);
376 return admv1013_spi_write(st, reg, write_val);
379 static const struct iio_info admv1013_info = {
380 .read_raw = admv1013_read_raw,
381 .write_raw = admv1013_write_raw,
382 .debugfs_reg_access = &admv1013_reg_access,
385 static int admv1013_freq_change(struct notifier_block *nb, unsigned long action, void *data)
387 struct admv1013_state *st = container_of(nb, struct admv1013_state, nb);
390 if (action == POST_RATE_CHANGE) {
391 mutex_lock(&st->lock);
392 ret = notifier_from_errno(admv1013_update_quad_filters(st));
393 mutex_unlock(&st->lock);
400 #define _ADMV1013_EXT_INFO(_name, _shared, _ident) { \
402 .read = admv1013_read, \
403 .write = admv1013_write, \
408 static const struct iio_chan_spec_ext_info admv1013_ext_info[] = {
409 _ADMV1013_EXT_INFO("i_calibphase", IIO_SEPARATE, ADMV1013_RFMOD_I_CALIBPHASE),
410 _ADMV1013_EXT_INFO("q_calibphase", IIO_SEPARATE, ADMV1013_RFMOD_Q_CALIBPHASE),
414 #define ADMV1013_CHAN_PHASE(_channel, _channel2, _admv1013_ext_info) { \
415 .type = IIO_ALTVOLTAGE, \
418 .channel2 = _channel2, \
419 .channel = _channel, \
421 .ext_info = _admv1013_ext_info, \
424 #define ADMV1013_CHAN_CALIB(_channel, rf_comp) { \
425 .type = IIO_ALTVOLTAGE, \
428 .channel = _channel, \
429 .channel2 = IIO_MOD_##rf_comp, \
430 .info_mask_separate = BIT(IIO_CHAN_INFO_CALIBBIAS), \
433 static const struct iio_chan_spec admv1013_channels[] = {
434 ADMV1013_CHAN_PHASE(0, 1, admv1013_ext_info),
435 ADMV1013_CHAN_CALIB(0, I),
436 ADMV1013_CHAN_CALIB(0, Q),
437 ADMV1013_CHAN_CALIB(1, I),
438 ADMV1013_CHAN_CALIB(1, Q),
441 static int admv1013_init(struct admv1013_state *st)
445 struct spi_device *spi = st->spi;
447 /* Perform a software reset */
448 ret = __admv1013_spi_update_bits(st, ADMV1013_REG_SPI_CONTROL,
449 ADMV1013_SPI_SOFT_RESET_MSK,
450 FIELD_PREP(ADMV1013_SPI_SOFT_RESET_MSK, 1));
454 ret = __admv1013_spi_update_bits(st, ADMV1013_REG_SPI_CONTROL,
455 ADMV1013_SPI_SOFT_RESET_MSK,
456 FIELD_PREP(ADMV1013_SPI_SOFT_RESET_MSK, 0));
460 ret = __admv1013_spi_read(st, ADMV1013_REG_SPI_CONTROL, &data);
464 data = FIELD_GET(ADMV1013_CHIP_ID_MSK, data);
465 if (data != ADMV1013_CHIP_ID) {
466 dev_err(&spi->dev, "Invalid Chip ID.\n");
470 ret = __admv1013_spi_write(st, ADMV1013_REG_VVA_TEMP_COMP, 0xE700);
474 data = FIELD_PREP(ADMV1013_QUAD_SE_MODE_MSK, st->quad_se_mode);
476 ret = __admv1013_spi_update_bits(st, ADMV1013_REG_QUAD,
477 ADMV1013_QUAD_SE_MODE_MSK, data);
481 ret = admv1013_update_mixer_vgate(st);
485 ret = admv1013_update_quad_filters(st);
489 return __admv1013_spi_update_bits(st, ADMV1013_REG_ENABLE,
490 ADMV1013_DET_EN_MSK |
491 ADMV1013_MIXER_IF_EN_MSK,
496 static void admv1013_reg_disable(void *data)
498 regulator_disable(data);
501 static void admv1013_powerdown(void *data)
503 unsigned int enable_reg, enable_reg_msk;
505 /* Disable all components in the Enable Register */
506 enable_reg_msk = ADMV1013_VGA_PD_MSK |
507 ADMV1013_MIXER_PD_MSK |
508 ADMV1013_QUAD_PD_MSK |
510 ADMV1013_MIXER_IF_EN_MSK |
513 enable_reg = FIELD_PREP(ADMV1013_VGA_PD_MSK, 1) |
514 FIELD_PREP(ADMV1013_MIXER_PD_MSK, 1) |
515 FIELD_PREP(ADMV1013_QUAD_PD_MSK, 7) |
516 FIELD_PREP(ADMV1013_BG_PD_MSK, 1) |
517 FIELD_PREP(ADMV1013_MIXER_IF_EN_MSK, 0) |
518 FIELD_PREP(ADMV1013_DET_EN_MSK, 0);
520 admv1013_spi_update_bits(data, ADMV1013_REG_ENABLE, enable_reg_msk, enable_reg);
523 static int admv1013_properties_parse(struct admv1013_state *st)
527 struct spi_device *spi = st->spi;
529 st->det_en = device_property_read_bool(&spi->dev, "adi,detector-enable");
531 ret = device_property_read_string(&spi->dev, "adi,input-mode", &str);
533 st->input_mode = ADMV1013_IQ_MODE;
535 if (!strcmp(str, "iq"))
536 st->input_mode = ADMV1013_IQ_MODE;
537 else if (!strcmp(str, "if"))
538 st->input_mode = ADMV1013_IF_MODE;
542 ret = device_property_read_string(&spi->dev, "adi,quad-se-mode", &str);
544 st->quad_se_mode = ADMV1013_SE_MODE_DIFF;
546 if (!strcmp(str, "diff"))
547 st->quad_se_mode = ADMV1013_SE_MODE_DIFF;
548 else if (!strcmp(str, "se-pos"))
549 st->quad_se_mode = ADMV1013_SE_MODE_POS;
550 else if (!strcmp(str, "se-neg"))
551 st->quad_se_mode = ADMV1013_SE_MODE_NEG;
555 st->reg = devm_regulator_get(&spi->dev, "vcm");
557 return dev_err_probe(&spi->dev, PTR_ERR(st->reg),
558 "failed to get the common-mode voltage\n");
563 static int admv1013_probe(struct spi_device *spi)
565 struct iio_dev *indio_dev;
566 struct admv1013_state *st;
569 indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*st));
573 st = iio_priv(indio_dev);
575 indio_dev->info = &admv1013_info;
576 indio_dev->name = "admv1013";
577 indio_dev->channels = admv1013_channels;
578 indio_dev->num_channels = ARRAY_SIZE(admv1013_channels);
582 ret = admv1013_properties_parse(st);
586 ret = regulator_enable(st->reg);
588 dev_err(&spi->dev, "Failed to enable specified Common-Mode Voltage!\n");
592 ret = devm_add_action_or_reset(&spi->dev, admv1013_reg_disable,
597 st->clkin = devm_clk_get_enabled(&spi->dev, "lo_in");
598 if (IS_ERR(st->clkin))
599 return dev_err_probe(&spi->dev, PTR_ERR(st->clkin),
600 "failed to get the LO input clock\n");
602 st->nb.notifier_call = admv1013_freq_change;
603 ret = devm_clk_notifier_register(&spi->dev, st->clkin, &st->nb);
607 mutex_init(&st->lock);
609 ret = admv1013_init(st);
611 dev_err(&spi->dev, "admv1013 init failed\n");
615 ret = devm_add_action_or_reset(&spi->dev, admv1013_powerdown, st);
619 return devm_iio_device_register(&spi->dev, indio_dev);
622 static const struct spi_device_id admv1013_id[] = {
626 MODULE_DEVICE_TABLE(spi, admv1013_id);
628 static const struct of_device_id admv1013_of_match[] = {
629 { .compatible = "adi,admv1013" },
632 MODULE_DEVICE_TABLE(of, admv1013_of_match);
634 static struct spi_driver admv1013_driver = {
637 .of_match_table = admv1013_of_match,
639 .probe = admv1013_probe,
640 .id_table = admv1013_id,
642 module_spi_driver(admv1013_driver);
644 MODULE_AUTHOR("Antoniu Miclaus <antoniu.miclaus@analog.com");
645 MODULE_DESCRIPTION("Analog Devices ADMV1013");
646 MODULE_LICENSE("GPL v2");