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
)) {
83 st
->val
= cpu_to_be32(st
->regs
[i
] | i
);
84 ret
= spi_write(st
->spi
, &st
->val
, 4);
87 st
->regs_hw
[i
] = st
->regs
[i
];
88 dev_dbg(&st
->spi
->dev
, "[%d] 0x%X\n",
89 i
, (u32
)st
->regs
[i
] | i
);
95 static int adf4350_reg_access(struct iio_dev
*indio_dev
,
96 unsigned reg
, unsigned writeval
,
99 struct adf4350_state
*st
= iio_priv(indio_dev
);
102 if (reg
> ADF4350_REG5
)
105 mutex_lock(&indio_dev
->mlock
);
106 if (readval
== NULL
) {
107 st
->regs
[reg
] = writeval
& ~(BIT(0) | BIT(1) | BIT(2));
108 ret
= adf4350_sync_config(st
);
110 *readval
= st
->regs_hw
[reg
];
113 mutex_unlock(&indio_dev
->mlock
);
118 static int adf4350_tune_r_cnt(struct adf4350_state
*st
, unsigned short r_cnt
)
120 struct adf4350_platform_data
*pdata
= st
->pdata
;
124 st
->fpfd
= (st
->clkin
* (pdata
->ref_doubler_en
? 2 : 1)) /
125 (r_cnt
* (pdata
->ref_div2_en
? 2 : 1));
126 } while (st
->fpfd
> ADF4350_MAX_FREQ_PFD
);
131 static int adf4350_set_freq(struct adf4350_state
*st
, unsigned long long freq
)
133 struct adf4350_platform_data
*pdata
= st
->pdata
;
135 u32 div_gcd
, prescaler
, chspc
;
139 if (freq
> ADF4350_MAX_OUT_FREQ
|| freq
< st
->min_out_freq
)
142 if (freq
> ADF4350_MAX_FREQ_45_PRESC
) {
143 prescaler
= ADF4350_REG1_PRESCALER
;
150 st
->r4_rf_div_sel
= 0;
152 while (freq
< ADF4350_MIN_VCO_FREQ
) {
158 * Allow a predefined reference division factor
159 * if not set, compute our own
161 if (pdata
->ref_div_factor
)
162 r_cnt
= pdata
->ref_div_factor
- 1;
169 r_cnt
= adf4350_tune_r_cnt(st
, r_cnt
);
170 st
->r1_mod
= st
->fpfd
/ chspc
;
171 if (r_cnt
> ADF4350_MAX_R_CNT
) {
172 /* try higher spacing values */
176 } while ((st
->r1_mod
> ADF4350_MAX_MODULUS
) && r_cnt
);
177 } while (r_cnt
== 0);
179 tmp
= freq
* (u64
)st
->r1_mod
+ (st
->fpfd
>> 1);
180 do_div(tmp
, st
->fpfd
); /* Div round closest (n + d/2)/d */
181 st
->r0_fract
= do_div(tmp
, st
->r1_mod
);
183 } while (mdiv
> st
->r0_int
);
185 band_sel_div
= DIV_ROUND_UP(st
->fpfd
, ADF4350_MAX_BANDSEL_CLK
);
187 if (st
->r0_fract
&& st
->r1_mod
) {
188 div_gcd
= gcd(st
->r1_mod
, st
->r0_fract
);
189 st
->r1_mod
/= div_gcd
;
190 st
->r0_fract
/= div_gcd
;
196 dev_dbg(&st
->spi
->dev
, "VCO: %llu Hz, PFD %lu Hz\n"
197 "REF_DIV %d, R0_INT %d, R0_FRACT %d\n"
198 "R1_MOD %d, RF_DIV %d\nPRESCALER %s, BAND_SEL_DIV %d\n",
199 freq
, st
->fpfd
, r_cnt
, st
->r0_int
, st
->r0_fract
, st
->r1_mod
,
200 1 << st
->r4_rf_div_sel
, prescaler
? "8/9" : "4/5",
203 st
->regs
[ADF4350_REG0
] = ADF4350_REG0_INT(st
->r0_int
) |
204 ADF4350_REG0_FRACT(st
->r0_fract
);
206 st
->regs
[ADF4350_REG1
] = ADF4350_REG1_PHASE(1) |
207 ADF4350_REG1_MOD(st
->r1_mod
) |
210 st
->regs
[ADF4350_REG2
] =
211 ADF4350_REG2_10BIT_R_CNT(r_cnt
) |
212 ADF4350_REG2_DOUBLE_BUFF_EN
|
213 (pdata
->ref_doubler_en
? ADF4350_REG2_RMULT2_EN
: 0) |
214 (pdata
->ref_div2_en
? ADF4350_REG2_RDIV2_EN
: 0) |
215 (pdata
->r2_user_settings
& (ADF4350_REG2_PD_POLARITY_POS
|
216 ADF4350_REG2_LDP_6ns
| ADF4350_REG2_LDF_INT_N
|
217 ADF4350_REG2_CHARGE_PUMP_CURR_uA(5000) |
218 ADF4350_REG2_MUXOUT(0x7) | ADF4350_REG2_NOISE_MODE(0x3)));
220 st
->regs
[ADF4350_REG3
] = pdata
->r3_user_settings
&
221 (ADF4350_REG3_12BIT_CLKDIV(0xFFF) |
222 ADF4350_REG3_12BIT_CLKDIV_MODE(0x3) |
223 ADF4350_REG3_12BIT_CSR_EN
|
224 ADF4351_REG3_CHARGE_CANCELLATION_EN
|
225 ADF4351_REG3_ANTI_BACKLASH_3ns_EN
|
226 ADF4351_REG3_BAND_SEL_CLOCK_MODE_HIGH
);
228 st
->regs
[ADF4350_REG4
] =
229 ADF4350_REG4_FEEDBACK_FUND
|
230 ADF4350_REG4_RF_DIV_SEL(st
->r4_rf_div_sel
) |
231 ADF4350_REG4_8BIT_BAND_SEL_CLKDIV(band_sel_div
) |
232 ADF4350_REG4_RF_OUT_EN
|
233 (pdata
->r4_user_settings
&
234 (ADF4350_REG4_OUTPUT_PWR(0x3) |
235 ADF4350_REG4_AUX_OUTPUT_PWR(0x3) |
236 ADF4350_REG4_AUX_OUTPUT_EN
|
237 ADF4350_REG4_AUX_OUTPUT_FUND
|
238 ADF4350_REG4_MUTE_TILL_LOCK_EN
));
240 st
->regs
[ADF4350_REG5
] = ADF4350_REG5_LD_PIN_MODE_DIGITAL
;
243 return adf4350_sync_config(st
);
246 static ssize_t
adf4350_write(struct iio_dev
*indio_dev
,
248 const struct iio_chan_spec
*chan
,
249 const char *buf
, size_t len
)
251 struct adf4350_state
*st
= iio_priv(indio_dev
);
252 unsigned long long readin
;
256 ret
= kstrtoull(buf
, 10, &readin
);
260 mutex_lock(&indio_dev
->mlock
);
261 switch ((u32
)private) {
263 ret
= adf4350_set_freq(st
, readin
);
265 case ADF4350_FREQ_REFIN
:
266 if (readin
> ADF4350_MAX_FREQ_REFIN
) {
272 tmp
= clk_round_rate(st
->clk
, readin
);
277 ret
= clk_set_rate(st
->clk
, tmp
);
282 ret
= adf4350_set_freq(st
, st
->freq_req
);
284 case ADF4350_FREQ_RESOLUTION
:
290 case ADF4350_PWRDOWN
:
292 st
->regs
[ADF4350_REG2
] |= ADF4350_REG2_POWER_DOWN_EN
;
294 st
->regs
[ADF4350_REG2
] &= ~ADF4350_REG2_POWER_DOWN_EN
;
296 adf4350_sync_config(st
);
301 mutex_unlock(&indio_dev
->mlock
);
303 return ret
? ret
: len
;
306 static ssize_t
adf4350_read(struct iio_dev
*indio_dev
,
308 const struct iio_chan_spec
*chan
,
311 struct adf4350_state
*st
= iio_priv(indio_dev
);
312 unsigned long long val
;
315 mutex_lock(&indio_dev
->mlock
);
316 switch ((u32
)private) {
318 val
= (u64
)((st
->r0_int
* st
->r1_mod
) + st
->r0_fract
) *
320 do_div(val
, st
->r1_mod
* (1 << st
->r4_rf_div_sel
));
321 /* PLL unlocked? return error */
322 if (gpio_is_valid(st
->pdata
->gpio_lock_detect
))
323 if (!gpio_get_value(st
->pdata
->gpio_lock_detect
)) {
324 dev_dbg(&st
->spi
->dev
, "PLL un-locked\n");
328 case ADF4350_FREQ_REFIN
:
330 st
->clkin
= clk_get_rate(st
->clk
);
334 case ADF4350_FREQ_RESOLUTION
:
337 case ADF4350_PWRDOWN
:
338 val
= !!(st
->regs
[ADF4350_REG2
] & ADF4350_REG2_POWER_DOWN_EN
);
344 mutex_unlock(&indio_dev
->mlock
);
346 return ret
< 0 ? ret
: sprintf(buf
, "%llu\n", val
);
349 #define _ADF4350_EXT_INFO(_name, _ident) { \
351 .read = adf4350_read, \
352 .write = adf4350_write, \
354 .shared = IIO_SEPARATE, \
357 static const struct iio_chan_spec_ext_info adf4350_ext_info
[] = {
358 /* Ideally we use IIO_CHAN_INFO_FREQUENCY, but there are
359 * values > 2^32 in order to support the entire frequency range
360 * in Hz. Using scale is a bit ugly.
362 _ADF4350_EXT_INFO("frequency", ADF4350_FREQ
),
363 _ADF4350_EXT_INFO("frequency_resolution", ADF4350_FREQ_RESOLUTION
),
364 _ADF4350_EXT_INFO("refin_frequency", ADF4350_FREQ_REFIN
),
365 _ADF4350_EXT_INFO("powerdown", ADF4350_PWRDOWN
),
369 static const struct iio_chan_spec adf4350_chan
= {
370 .type
= IIO_ALTVOLTAGE
,
373 .ext_info
= adf4350_ext_info
,
376 static const struct iio_info adf4350_info
= {
377 .debugfs_reg_access
= &adf4350_reg_access
,
378 .driver_module
= THIS_MODULE
,
382 static struct adf4350_platform_data
*adf4350_parse_dt(struct device
*dev
)
384 struct device_node
*np
= dev
->of_node
;
385 struct adf4350_platform_data
*pdata
;
389 pdata
= devm_kzalloc(dev
, sizeof(*pdata
), GFP_KERNEL
);
391 dev_err(dev
, "could not allocate memory for platform data\n");
395 strncpy(&pdata
->name
[0], np
->name
, SPI_NAME_SIZE
- 1);
398 of_property_read_u32(np
, "adi,channel-spacing", &tmp
);
399 pdata
->channel_spacing
= tmp
;
402 of_property_read_u32(np
, "adi,power-up-frequency", &tmp
);
403 pdata
->power_up_frequency
= tmp
;
406 of_property_read_u32(np
, "adi,reference-div-factor", &tmp
);
407 pdata
->ref_div_factor
= tmp
;
409 ret
= of_get_gpio(np
, 0);
411 pdata
->gpio_lock_detect
= -1;
413 pdata
->gpio_lock_detect
= ret
;
415 pdata
->ref_doubler_en
= of_property_read_bool(np
,
416 "adi,reference-doubler-enable");
417 pdata
->ref_div2_en
= of_property_read_bool(np
,
418 "adi,reference-div2-enable");
420 /* r2_user_settings */
421 pdata
->r2_user_settings
= of_property_read_bool(np
,
422 "adi,phase-detector-polarity-positive-enable") ?
423 ADF4350_REG2_PD_POLARITY_POS
: 0;
424 pdata
->r2_user_settings
|= of_property_read_bool(np
,
425 "adi,lock-detect-precision-6ns-enable") ?
426 ADF4350_REG2_LDP_6ns
: 0;
427 pdata
->r2_user_settings
|= of_property_read_bool(np
,
428 "adi,lock-detect-function-integer-n-enable") ?
429 ADF4350_REG2_LDF_INT_N
: 0;
432 of_property_read_u32(np
, "adi,charge-pump-current", &tmp
);
433 pdata
->r2_user_settings
|= ADF4350_REG2_CHARGE_PUMP_CURR_uA(tmp
);
436 of_property_read_u32(np
, "adi,muxout-select", &tmp
);
437 pdata
->r2_user_settings
|= ADF4350_REG2_MUXOUT(tmp
);
439 pdata
->r2_user_settings
|= of_property_read_bool(np
,
440 "adi,low-spur-mode-enable") ?
441 ADF4350_REG2_NOISE_MODE(0x3) : 0;
443 /* r3_user_settings */
445 pdata
->r3_user_settings
= of_property_read_bool(np
,
446 "adi,cycle-slip-reduction-enable") ?
447 ADF4350_REG3_12BIT_CSR_EN
: 0;
448 pdata
->r3_user_settings
|= of_property_read_bool(np
,
449 "adi,charge-cancellation-enable") ?
450 ADF4351_REG3_CHARGE_CANCELLATION_EN
: 0;
452 pdata
->r3_user_settings
|= of_property_read_bool(np
,
453 "adi,anti-backlash-3ns-enable") ?
454 ADF4351_REG3_ANTI_BACKLASH_3ns_EN
: 0;
455 pdata
->r3_user_settings
|= of_property_read_bool(np
,
456 "adi,band-select-clock-mode-high-enable") ?
457 ADF4351_REG3_BAND_SEL_CLOCK_MODE_HIGH
: 0;
460 of_property_read_u32(np
, "adi,12bit-clk-divider", &tmp
);
461 pdata
->r3_user_settings
|= ADF4350_REG3_12BIT_CLKDIV(tmp
);
464 of_property_read_u32(np
, "adi,clk-divider-mode", &tmp
);
465 pdata
->r3_user_settings
|= ADF4350_REG3_12BIT_CLKDIV_MODE(tmp
);
467 /* r4_user_settings */
469 pdata
->r4_user_settings
= of_property_read_bool(np
,
470 "adi,aux-output-enable") ?
471 ADF4350_REG4_AUX_OUTPUT_EN
: 0;
472 pdata
->r4_user_settings
|= of_property_read_bool(np
,
473 "adi,aux-output-fundamental-enable") ?
474 ADF4350_REG4_AUX_OUTPUT_FUND
: 0;
475 pdata
->r4_user_settings
|= of_property_read_bool(np
,
476 "adi,mute-till-lock-enable") ?
477 ADF4350_REG4_MUTE_TILL_LOCK_EN
: 0;
480 of_property_read_u32(np
, "adi,output-power", &tmp
);
481 pdata
->r4_user_settings
|= ADF4350_REG4_OUTPUT_PWR(tmp
);
484 of_property_read_u32(np
, "adi,aux-output-power", &tmp
);
485 pdata
->r4_user_settings
|= ADF4350_REG4_AUX_OUTPUT_PWR(tmp
);
491 struct adf4350_platform_data
*adf4350_parse_dt(struct device
*dev
)
497 static int adf4350_probe(struct spi_device
*spi
)
499 struct adf4350_platform_data
*pdata
;
500 struct iio_dev
*indio_dev
;
501 struct adf4350_state
*st
;
502 struct clk
*clk
= NULL
;
505 if (spi
->dev
.of_node
) {
506 pdata
= adf4350_parse_dt(&spi
->dev
);
510 pdata
= spi
->dev
.platform_data
;
514 dev_warn(&spi
->dev
, "no platform data? using default\n");
515 pdata
= &default_pdata
;
519 clk
= devm_clk_get(&spi
->dev
, "clkin");
521 return -EPROBE_DEFER
;
523 ret
= clk_prepare_enable(clk
);
528 indio_dev
= devm_iio_device_alloc(&spi
->dev
, sizeof(*st
));
529 if (indio_dev
== NULL
) {
531 goto error_disable_clk
;
534 st
= iio_priv(indio_dev
);
536 st
->reg
= devm_regulator_get(&spi
->dev
, "vcc");
537 if (!IS_ERR(st
->reg
)) {
538 ret
= regulator_enable(st
->reg
);
540 goto error_disable_clk
;
543 spi_set_drvdata(spi
, indio_dev
);
547 indio_dev
->dev
.parent
= &spi
->dev
;
548 indio_dev
->name
= (pdata
->name
[0] != 0) ? pdata
->name
:
549 spi_get_device_id(spi
)->name
;
551 indio_dev
->info
= &adf4350_info
;
552 indio_dev
->modes
= INDIO_DIRECT_MODE
;
553 indio_dev
->channels
= &adf4350_chan
;
554 indio_dev
->num_channels
= 1;
556 st
->chspc
= pdata
->channel_spacing
;
559 st
->clkin
= clk_get_rate(clk
);
561 st
->clkin
= pdata
->clkin
;
564 st
->min_out_freq
= spi_get_device_id(spi
)->driver_data
== 4351 ?
565 ADF4351_MIN_OUT_FREQ
: ADF4350_MIN_OUT_FREQ
;
567 memset(st
->regs_hw
, 0xFF, sizeof(st
->regs_hw
));
569 if (gpio_is_valid(pdata
->gpio_lock_detect
)) {
570 ret
= devm_gpio_request(&spi
->dev
, pdata
->gpio_lock_detect
,
573 dev_err(&spi
->dev
, "fail to request lock detect GPIO-%d",
574 pdata
->gpio_lock_detect
);
575 goto error_disable_reg
;
577 gpio_direction_input(pdata
->gpio_lock_detect
);
580 if (pdata
->power_up_frequency
) {
581 ret
= adf4350_set_freq(st
, pdata
->power_up_frequency
);
583 goto error_disable_reg
;
586 ret
= iio_device_register(indio_dev
);
588 goto error_disable_reg
;
593 if (!IS_ERR(st
->reg
))
594 regulator_disable(st
->reg
);
597 clk_disable_unprepare(clk
);
602 static int adf4350_remove(struct spi_device
*spi
)
604 struct iio_dev
*indio_dev
= spi_get_drvdata(spi
);
605 struct adf4350_state
*st
= iio_priv(indio_dev
);
606 struct regulator
*reg
= st
->reg
;
608 st
->regs
[ADF4350_REG2
] |= ADF4350_REG2_POWER_DOWN_EN
;
609 adf4350_sync_config(st
);
611 iio_device_unregister(indio_dev
);
614 clk_disable_unprepare(st
->clk
);
617 regulator_disable(reg
);
623 static const struct spi_device_id adf4350_id
[] = {
629 static struct spi_driver adf4350_driver
= {
632 .owner
= THIS_MODULE
,
634 .probe
= adf4350_probe
,
635 .remove
= adf4350_remove
,
636 .id_table
= adf4350_id
,
638 module_spi_driver(adf4350_driver
);
640 MODULE_AUTHOR("Michael Hennerich <michael.hennerich@analog.com>");
641 MODULE_DESCRIPTION("Analog Devices ADF4350/ADF4351 PLL");
642 MODULE_LICENSE("GPL v2");