2 * ADF4350/ADF4351 SPI Wideband Synthesizer driver
4 * Copyright 2012-2013 Analog Devices Inc.
6 * Licensed under the GPL-2.
9 #include <linux/device.h>
10 #include <linux/kernel.h>
11 #include <linux/slab.h>
12 #include <linux/sysfs.h>
13 #include <linux/spi/spi.h>
14 #include <linux/regulator/consumer.h>
15 #include <linux/err.h>
16 #include <linux/module.h>
17 #include <linux/gcd.h>
18 #include <linux/gpio.h>
19 #include <asm/div64.h>
20 #include <linux/clk.h>
22 #include <linux/of_gpio.h>
24 #include <linux/iio/iio.h>
25 #include <linux/iio/sysfs.h>
26 #include <linux/iio/frequency/adf4350.h>
31 ADF4350_FREQ_RESOLUTION
,
35 struct adf4350_state
{
36 struct spi_device
*spi
;
37 struct regulator
*reg
;
38 struct adf4350_platform_data
*pdata
;
41 unsigned long chspc
; /* Channel Spacing */
42 unsigned long fpfd
; /* Phase Frequency Detector */
43 unsigned long min_out_freq
;
47 unsigned r4_rf_div_sel
;
48 unsigned long regs
[6];
49 unsigned long regs_hw
[6];
50 unsigned long long freq_req
;
52 * DMA (thus cache coherency maintenance) requires the
53 * transfer buffers to live in their own cache lines.
55 __be32 val ____cacheline_aligned
;
58 static struct adf4350_platform_data default_pdata
= {
59 .channel_spacing
= 10000,
60 .r2_user_settings
= ADF4350_REG2_PD_POLARITY_POS
|
61 ADF4350_REG2_CHARGE_PUMP_CURR_uA(2500),
62 .r3_user_settings
= ADF4350_REG3_12BIT_CLKDIV_MODE(0),
63 .r4_user_settings
= ADF4350_REG4_OUTPUT_PWR(3) |
64 ADF4350_REG4_MUTE_TILL_LOCK_EN
,
65 .gpio_lock_detect
= -1,
68 static int adf4350_sync_config(struct adf4350_state
*st
)
70 int ret
, i
, doublebuf
= 0;
72 for (i
= ADF4350_REG5
; i
>= ADF4350_REG0
; i
--) {
73 if ((st
->regs_hw
[i
] != st
->regs
[i
]) ||
74 ((i
== ADF4350_REG0
) && doublebuf
)) {
82 st
->val
= cpu_to_be32(st
->regs
[i
] | i
);
83 ret
= spi_write(st
->spi
, &st
->val
, 4);
86 st
->regs_hw
[i
] = st
->regs
[i
];
87 dev_dbg(&st
->spi
->dev
, "[%d] 0x%X\n",
88 i
, (u32
)st
->regs
[i
] | i
);
94 static int adf4350_reg_access(struct iio_dev
*indio_dev
,
95 unsigned reg
, unsigned writeval
,
98 struct adf4350_state
*st
= iio_priv(indio_dev
);
101 if (reg
> ADF4350_REG5
)
104 mutex_lock(&indio_dev
->mlock
);
105 if (readval
== NULL
) {
106 st
->regs
[reg
] = writeval
& ~(BIT(0) | BIT(1) | BIT(2));
107 ret
= adf4350_sync_config(st
);
109 *readval
= st
->regs_hw
[reg
];
112 mutex_unlock(&indio_dev
->mlock
);
117 static int adf4350_tune_r_cnt(struct adf4350_state
*st
, unsigned short r_cnt
)
119 struct adf4350_platform_data
*pdata
= st
->pdata
;
123 st
->fpfd
= (st
->clkin
* (pdata
->ref_doubler_en
? 2 : 1)) /
124 (r_cnt
* (pdata
->ref_div2_en
? 2 : 1));
125 } while (st
->fpfd
> ADF4350_MAX_FREQ_PFD
);
130 static int adf4350_set_freq(struct adf4350_state
*st
, unsigned long long freq
)
132 struct adf4350_platform_data
*pdata
= st
->pdata
;
134 u32 div_gcd
, prescaler
, chspc
;
138 if (freq
> ADF4350_MAX_OUT_FREQ
|| freq
< st
->min_out_freq
)
141 if (freq
> ADF4350_MAX_FREQ_45_PRESC
) {
142 prescaler
= ADF4350_REG1_PRESCALER
;
149 st
->r4_rf_div_sel
= 0;
151 while (freq
< ADF4350_MIN_VCO_FREQ
) {
157 * Allow a predefined reference division factor
158 * if not set, compute our own
160 if (pdata
->ref_div_factor
)
161 r_cnt
= pdata
->ref_div_factor
- 1;
168 r_cnt
= adf4350_tune_r_cnt(st
, r_cnt
);
169 st
->r1_mod
= st
->fpfd
/ chspc
;
170 if (r_cnt
> ADF4350_MAX_R_CNT
) {
171 /* try higher spacing values */
175 } while ((st
->r1_mod
> ADF4350_MAX_MODULUS
) && r_cnt
);
176 } while (r_cnt
== 0);
178 tmp
= freq
* (u64
)st
->r1_mod
+ (st
->fpfd
>> 1);
179 do_div(tmp
, st
->fpfd
); /* Div round closest (n + d/2)/d */
180 st
->r0_fract
= do_div(tmp
, st
->r1_mod
);
182 } while (mdiv
> st
->r0_int
);
184 band_sel_div
= DIV_ROUND_UP(st
->fpfd
, ADF4350_MAX_BANDSEL_CLK
);
186 if (st
->r0_fract
&& st
->r1_mod
) {
187 div_gcd
= gcd(st
->r1_mod
, st
->r0_fract
);
188 st
->r1_mod
/= div_gcd
;
189 st
->r0_fract
/= div_gcd
;
195 dev_dbg(&st
->spi
->dev
, "VCO: %llu Hz, PFD %lu Hz\n"
196 "REF_DIV %d, R0_INT %d, R0_FRACT %d\n"
197 "R1_MOD %d, RF_DIV %d\nPRESCALER %s, BAND_SEL_DIV %d\n",
198 freq
, st
->fpfd
, r_cnt
, st
->r0_int
, st
->r0_fract
, st
->r1_mod
,
199 1 << st
->r4_rf_div_sel
, prescaler
? "8/9" : "4/5",
202 st
->regs
[ADF4350_REG0
] = ADF4350_REG0_INT(st
->r0_int
) |
203 ADF4350_REG0_FRACT(st
->r0_fract
);
205 st
->regs
[ADF4350_REG1
] = ADF4350_REG1_PHASE(1) |
206 ADF4350_REG1_MOD(st
->r1_mod
) |
209 st
->regs
[ADF4350_REG2
] =
210 ADF4350_REG2_10BIT_R_CNT(r_cnt
) |
211 ADF4350_REG2_DOUBLE_BUFF_EN
|
212 (pdata
->ref_doubler_en
? ADF4350_REG2_RMULT2_EN
: 0) |
213 (pdata
->ref_div2_en
? ADF4350_REG2_RDIV2_EN
: 0) |
214 (pdata
->r2_user_settings
& (ADF4350_REG2_PD_POLARITY_POS
|
215 ADF4350_REG2_LDP_6ns
| ADF4350_REG2_LDF_INT_N
|
216 ADF4350_REG2_CHARGE_PUMP_CURR_uA(5000) |
217 ADF4350_REG2_MUXOUT(0x7) | ADF4350_REG2_NOISE_MODE(0x3)));
219 st
->regs
[ADF4350_REG3
] = pdata
->r3_user_settings
&
220 (ADF4350_REG3_12BIT_CLKDIV(0xFFF) |
221 ADF4350_REG3_12BIT_CLKDIV_MODE(0x3) |
222 ADF4350_REG3_12BIT_CSR_EN
|
223 ADF4351_REG3_CHARGE_CANCELLATION_EN
|
224 ADF4351_REG3_ANTI_BACKLASH_3ns_EN
|
225 ADF4351_REG3_BAND_SEL_CLOCK_MODE_HIGH
);
227 st
->regs
[ADF4350_REG4
] =
228 ADF4350_REG4_FEEDBACK_FUND
|
229 ADF4350_REG4_RF_DIV_SEL(st
->r4_rf_div_sel
) |
230 ADF4350_REG4_8BIT_BAND_SEL_CLKDIV(band_sel_div
) |
231 ADF4350_REG4_RF_OUT_EN
|
232 (pdata
->r4_user_settings
&
233 (ADF4350_REG4_OUTPUT_PWR(0x3) |
234 ADF4350_REG4_AUX_OUTPUT_PWR(0x3) |
235 ADF4350_REG4_AUX_OUTPUT_EN
|
236 ADF4350_REG4_AUX_OUTPUT_FUND
|
237 ADF4350_REG4_MUTE_TILL_LOCK_EN
));
239 st
->regs
[ADF4350_REG5
] = ADF4350_REG5_LD_PIN_MODE_DIGITAL
;
242 return adf4350_sync_config(st
);
245 static ssize_t
adf4350_write(struct iio_dev
*indio_dev
,
247 const struct iio_chan_spec
*chan
,
248 const char *buf
, size_t len
)
250 struct adf4350_state
*st
= iio_priv(indio_dev
);
251 unsigned long long readin
;
255 ret
= kstrtoull(buf
, 10, &readin
);
259 mutex_lock(&indio_dev
->mlock
);
260 switch ((u32
)private) {
262 ret
= adf4350_set_freq(st
, readin
);
264 case ADF4350_FREQ_REFIN
:
265 if (readin
> ADF4350_MAX_FREQ_REFIN
) {
271 tmp
= clk_round_rate(st
->clk
, readin
);
276 ret
= clk_set_rate(st
->clk
, tmp
);
281 ret
= adf4350_set_freq(st
, st
->freq_req
);
283 case ADF4350_FREQ_RESOLUTION
:
289 case ADF4350_PWRDOWN
:
291 st
->regs
[ADF4350_REG2
] |= ADF4350_REG2_POWER_DOWN_EN
;
293 st
->regs
[ADF4350_REG2
] &= ~ADF4350_REG2_POWER_DOWN_EN
;
295 adf4350_sync_config(st
);
300 mutex_unlock(&indio_dev
->mlock
);
302 return ret
? ret
: len
;
305 static ssize_t
adf4350_read(struct iio_dev
*indio_dev
,
307 const struct iio_chan_spec
*chan
,
310 struct adf4350_state
*st
= iio_priv(indio_dev
);
311 unsigned long long val
;
314 mutex_lock(&indio_dev
->mlock
);
315 switch ((u32
)private) {
317 val
= (u64
)((st
->r0_int
* st
->r1_mod
) + st
->r0_fract
) *
319 do_div(val
, st
->r1_mod
* (1 << st
->r4_rf_div_sel
));
320 /* PLL unlocked? return error */
321 if (gpio_is_valid(st
->pdata
->gpio_lock_detect
))
322 if (!gpio_get_value(st
->pdata
->gpio_lock_detect
)) {
323 dev_dbg(&st
->spi
->dev
, "PLL un-locked\n");
327 case ADF4350_FREQ_REFIN
:
329 st
->clkin
= clk_get_rate(st
->clk
);
333 case ADF4350_FREQ_RESOLUTION
:
336 case ADF4350_PWRDOWN
:
337 val
= !!(st
->regs
[ADF4350_REG2
] & ADF4350_REG2_POWER_DOWN_EN
);
343 mutex_unlock(&indio_dev
->mlock
);
345 return ret
< 0 ? ret
: sprintf(buf
, "%llu\n", val
);
348 #define _ADF4350_EXT_INFO(_name, _ident) { \
350 .read = adf4350_read, \
351 .write = adf4350_write, \
353 .shared = IIO_SEPARATE, \
356 static const struct iio_chan_spec_ext_info adf4350_ext_info
[] = {
357 /* Ideally we use IIO_CHAN_INFO_FREQUENCY, but there are
358 * values > 2^32 in order to support the entire frequency range
359 * in Hz. Using scale is a bit ugly.
361 _ADF4350_EXT_INFO("frequency", ADF4350_FREQ
),
362 _ADF4350_EXT_INFO("frequency_resolution", ADF4350_FREQ_RESOLUTION
),
363 _ADF4350_EXT_INFO("refin_frequency", ADF4350_FREQ_REFIN
),
364 _ADF4350_EXT_INFO("powerdown", ADF4350_PWRDOWN
),
368 static const struct iio_chan_spec adf4350_chan
= {
369 .type
= IIO_ALTVOLTAGE
,
372 .ext_info
= adf4350_ext_info
,
375 static const struct iio_info adf4350_info
= {
376 .debugfs_reg_access
= &adf4350_reg_access
,
380 static struct adf4350_platform_data
*adf4350_parse_dt(struct device
*dev
)
382 struct device_node
*np
= dev
->of_node
;
383 struct adf4350_platform_data
*pdata
;
387 pdata
= devm_kzalloc(dev
, sizeof(*pdata
), GFP_KERNEL
);
391 strncpy(&pdata
->name
[0], np
->name
, SPI_NAME_SIZE
- 1);
394 of_property_read_u32(np
, "adi,channel-spacing", &tmp
);
395 pdata
->channel_spacing
= tmp
;
398 of_property_read_u32(np
, "adi,power-up-frequency", &tmp
);
399 pdata
->power_up_frequency
= tmp
;
402 of_property_read_u32(np
, "adi,reference-div-factor", &tmp
);
403 pdata
->ref_div_factor
= tmp
;
405 ret
= of_get_gpio(np
, 0);
407 pdata
->gpio_lock_detect
= -1;
409 pdata
->gpio_lock_detect
= ret
;
411 pdata
->ref_doubler_en
= of_property_read_bool(np
,
412 "adi,reference-doubler-enable");
413 pdata
->ref_div2_en
= of_property_read_bool(np
,
414 "adi,reference-div2-enable");
416 /* r2_user_settings */
417 pdata
->r2_user_settings
= of_property_read_bool(np
,
418 "adi,phase-detector-polarity-positive-enable") ?
419 ADF4350_REG2_PD_POLARITY_POS
: 0;
420 pdata
->r2_user_settings
|= of_property_read_bool(np
,
421 "adi,lock-detect-precision-6ns-enable") ?
422 ADF4350_REG2_LDP_6ns
: 0;
423 pdata
->r2_user_settings
|= of_property_read_bool(np
,
424 "adi,lock-detect-function-integer-n-enable") ?
425 ADF4350_REG2_LDF_INT_N
: 0;
428 of_property_read_u32(np
, "adi,charge-pump-current", &tmp
);
429 pdata
->r2_user_settings
|= ADF4350_REG2_CHARGE_PUMP_CURR_uA(tmp
);
432 of_property_read_u32(np
, "adi,muxout-select", &tmp
);
433 pdata
->r2_user_settings
|= ADF4350_REG2_MUXOUT(tmp
);
435 pdata
->r2_user_settings
|= of_property_read_bool(np
,
436 "adi,low-spur-mode-enable") ?
437 ADF4350_REG2_NOISE_MODE(0x3) : 0;
439 /* r3_user_settings */
441 pdata
->r3_user_settings
= of_property_read_bool(np
,
442 "adi,cycle-slip-reduction-enable") ?
443 ADF4350_REG3_12BIT_CSR_EN
: 0;
444 pdata
->r3_user_settings
|= of_property_read_bool(np
,
445 "adi,charge-cancellation-enable") ?
446 ADF4351_REG3_CHARGE_CANCELLATION_EN
: 0;
448 pdata
->r3_user_settings
|= of_property_read_bool(np
,
449 "adi,anti-backlash-3ns-enable") ?
450 ADF4351_REG3_ANTI_BACKLASH_3ns_EN
: 0;
451 pdata
->r3_user_settings
|= of_property_read_bool(np
,
452 "adi,band-select-clock-mode-high-enable") ?
453 ADF4351_REG3_BAND_SEL_CLOCK_MODE_HIGH
: 0;
456 of_property_read_u32(np
, "adi,12bit-clk-divider", &tmp
);
457 pdata
->r3_user_settings
|= ADF4350_REG3_12BIT_CLKDIV(tmp
);
460 of_property_read_u32(np
, "adi,clk-divider-mode", &tmp
);
461 pdata
->r3_user_settings
|= ADF4350_REG3_12BIT_CLKDIV_MODE(tmp
);
463 /* r4_user_settings */
465 pdata
->r4_user_settings
= of_property_read_bool(np
,
466 "adi,aux-output-enable") ?
467 ADF4350_REG4_AUX_OUTPUT_EN
: 0;
468 pdata
->r4_user_settings
|= of_property_read_bool(np
,
469 "adi,aux-output-fundamental-enable") ?
470 ADF4350_REG4_AUX_OUTPUT_FUND
: 0;
471 pdata
->r4_user_settings
|= of_property_read_bool(np
,
472 "adi,mute-till-lock-enable") ?
473 ADF4350_REG4_MUTE_TILL_LOCK_EN
: 0;
476 of_property_read_u32(np
, "adi,output-power", &tmp
);
477 pdata
->r4_user_settings
|= ADF4350_REG4_OUTPUT_PWR(tmp
);
480 of_property_read_u32(np
, "adi,aux-output-power", &tmp
);
481 pdata
->r4_user_settings
|= ADF4350_REG4_AUX_OUTPUT_PWR(tmp
);
487 struct adf4350_platform_data
*adf4350_parse_dt(struct device
*dev
)
493 static int adf4350_probe(struct spi_device
*spi
)
495 struct adf4350_platform_data
*pdata
;
496 struct iio_dev
*indio_dev
;
497 struct adf4350_state
*st
;
498 struct clk
*clk
= NULL
;
501 if (spi
->dev
.of_node
) {
502 pdata
= adf4350_parse_dt(&spi
->dev
);
506 pdata
= spi
->dev
.platform_data
;
510 dev_warn(&spi
->dev
, "no platform data? using default\n");
511 pdata
= &default_pdata
;
515 clk
= devm_clk_get(&spi
->dev
, "clkin");
517 return -EPROBE_DEFER
;
519 ret
= clk_prepare_enable(clk
);
524 indio_dev
= devm_iio_device_alloc(&spi
->dev
, sizeof(*st
));
525 if (indio_dev
== NULL
) {
527 goto error_disable_clk
;
530 st
= iio_priv(indio_dev
);
532 st
->reg
= devm_regulator_get(&spi
->dev
, "vcc");
533 if (!IS_ERR(st
->reg
)) {
534 ret
= regulator_enable(st
->reg
);
536 goto error_disable_clk
;
539 spi_set_drvdata(spi
, indio_dev
);
543 indio_dev
->dev
.parent
= &spi
->dev
;
544 indio_dev
->name
= (pdata
->name
[0] != 0) ? pdata
->name
:
545 spi_get_device_id(spi
)->name
;
547 indio_dev
->info
= &adf4350_info
;
548 indio_dev
->modes
= INDIO_DIRECT_MODE
;
549 indio_dev
->channels
= &adf4350_chan
;
550 indio_dev
->num_channels
= 1;
552 st
->chspc
= pdata
->channel_spacing
;
555 st
->clkin
= clk_get_rate(clk
);
557 st
->clkin
= pdata
->clkin
;
560 st
->min_out_freq
= spi_get_device_id(spi
)->driver_data
== 4351 ?
561 ADF4351_MIN_OUT_FREQ
: ADF4350_MIN_OUT_FREQ
;
563 memset(st
->regs_hw
, 0xFF, sizeof(st
->regs_hw
));
565 if (gpio_is_valid(pdata
->gpio_lock_detect
)) {
566 ret
= devm_gpio_request(&spi
->dev
, pdata
->gpio_lock_detect
,
569 dev_err(&spi
->dev
, "fail to request lock detect GPIO-%d",
570 pdata
->gpio_lock_detect
);
571 goto error_disable_reg
;
573 gpio_direction_input(pdata
->gpio_lock_detect
);
576 if (pdata
->power_up_frequency
) {
577 ret
= adf4350_set_freq(st
, pdata
->power_up_frequency
);
579 goto error_disable_reg
;
582 ret
= iio_device_register(indio_dev
);
584 goto error_disable_reg
;
589 if (!IS_ERR(st
->reg
))
590 regulator_disable(st
->reg
);
593 clk_disable_unprepare(clk
);
598 static int adf4350_remove(struct spi_device
*spi
)
600 struct iio_dev
*indio_dev
= spi_get_drvdata(spi
);
601 struct adf4350_state
*st
= iio_priv(indio_dev
);
602 struct regulator
*reg
= st
->reg
;
604 st
->regs
[ADF4350_REG2
] |= ADF4350_REG2_POWER_DOWN_EN
;
605 adf4350_sync_config(st
);
607 iio_device_unregister(indio_dev
);
610 clk_disable_unprepare(st
->clk
);
613 regulator_disable(reg
);
618 static const struct of_device_id adf4350_of_match
[] = {
619 { .compatible
= "adi,adf4350", },
620 { .compatible
= "adi,adf4351", },
623 MODULE_DEVICE_TABLE(of
, adf4350_of_match
);
625 static const struct spi_device_id adf4350_id
[] = {
630 MODULE_DEVICE_TABLE(spi
, adf4350_id
);
632 static struct spi_driver adf4350_driver
= {
635 .of_match_table
= of_match_ptr(adf4350_of_match
),
637 .probe
= adf4350_probe
,
638 .remove
= adf4350_remove
,
639 .id_table
= adf4350_id
,
641 module_spi_driver(adf4350_driver
);
643 MODULE_AUTHOR("Michael Hennerich <michael.hennerich@analog.com>");
644 MODULE_DESCRIPTION("Analog Devices ADF4350/ADF4351 PLL");
645 MODULE_LICENSE("GPL v2");