sh_eth: fix EESIPR values for SH77{34|63}
[linux/fpc-iii.git] / drivers / iio / frequency / ad9523.c
blob99eba524f6ddbe063d2cf2ac359491287177d10b
1 /*
2 * AD9523 SPI Low Jitter Clock Generator
4 * Copyright 2012 Analog Devices Inc.
6 * Licensed under the GPL-2.
7 */
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/delay.h>
19 #include <linux/iio/iio.h>
20 #include <linux/iio/sysfs.h>
21 #include <linux/iio/frequency/ad9523.h>
23 #define AD9523_READ (1 << 15)
24 #define AD9523_WRITE (0 << 15)
25 #define AD9523_CNT(x) (((x) - 1) << 13)
26 #define AD9523_ADDR(x) ((x) & 0xFFF)
28 #define AD9523_R1B (1 << 16)
29 #define AD9523_R2B (2 << 16)
30 #define AD9523_R3B (3 << 16)
31 #define AD9523_TRANSF_LEN(x) ((x) >> 16)
33 #define AD9523_SERIAL_PORT_CONFIG (AD9523_R1B | 0x0)
34 #define AD9523_VERSION_REGISTER (AD9523_R1B | 0x2)
35 #define AD9523_PART_REGISTER (AD9523_R1B | 0x3)
36 #define AD9523_READBACK_CTRL (AD9523_R1B | 0x4)
38 #define AD9523_EEPROM_CUSTOMER_VERSION_ID (AD9523_R2B | 0x6)
40 #define AD9523_PLL1_REF_A_DIVIDER (AD9523_R2B | 0x11)
41 #define AD9523_PLL1_REF_B_DIVIDER (AD9523_R2B | 0x13)
42 #define AD9523_PLL1_REF_TEST_DIVIDER (AD9523_R1B | 0x14)
43 #define AD9523_PLL1_FEEDBACK_DIVIDER (AD9523_R2B | 0x17)
44 #define AD9523_PLL1_CHARGE_PUMP_CTRL (AD9523_R2B | 0x19)
45 #define AD9523_PLL1_INPUT_RECEIVERS_CTRL (AD9523_R1B | 0x1A)
46 #define AD9523_PLL1_REF_CTRL (AD9523_R1B | 0x1B)
47 #define AD9523_PLL1_MISC_CTRL (AD9523_R1B | 0x1C)
48 #define AD9523_PLL1_LOOP_FILTER_CTRL (AD9523_R1B | 0x1D)
50 #define AD9523_PLL2_CHARGE_PUMP (AD9523_R1B | 0xF0)
51 #define AD9523_PLL2_FEEDBACK_DIVIDER_AB (AD9523_R1B | 0xF1)
52 #define AD9523_PLL2_CTRL (AD9523_R1B | 0xF2)
53 #define AD9523_PLL2_VCO_CTRL (AD9523_R1B | 0xF3)
54 #define AD9523_PLL2_VCO_DIVIDER (AD9523_R1B | 0xF4)
55 #define AD9523_PLL2_LOOP_FILTER_CTRL (AD9523_R2B | 0xF6)
56 #define AD9523_PLL2_R2_DIVIDER (AD9523_R1B | 0xF7)
58 #define AD9523_CHANNEL_CLOCK_DIST(ch) (AD9523_R3B | (0x192 + 3 * ch))
60 #define AD9523_PLL1_OUTPUT_CTRL (AD9523_R1B | 0x1BA)
61 #define AD9523_PLL1_OUTPUT_CHANNEL_CTRL (AD9523_R1B | 0x1BB)
63 #define AD9523_READBACK_0 (AD9523_R1B | 0x22C)
64 #define AD9523_READBACK_1 (AD9523_R1B | 0x22D)
66 #define AD9523_STATUS_SIGNALS (AD9523_R3B | 0x232)
67 #define AD9523_POWER_DOWN_CTRL (AD9523_R1B | 0x233)
68 #define AD9523_IO_UPDATE (AD9523_R1B | 0x234)
70 #define AD9523_EEPROM_DATA_XFER_STATUS (AD9523_R1B | 0xB00)
71 #define AD9523_EEPROM_ERROR_READBACK (AD9523_R1B | 0xB01)
72 #define AD9523_EEPROM_CTRL1 (AD9523_R1B | 0xB02)
73 #define AD9523_EEPROM_CTRL2 (AD9523_R1B | 0xB03)
75 /* AD9523_SERIAL_PORT_CONFIG */
77 #define AD9523_SER_CONF_SDO_ACTIVE (1 << 7)
78 #define AD9523_SER_CONF_SOFT_RESET (1 << 5)
80 /* AD9523_READBACK_CTRL */
81 #define AD9523_READBACK_CTRL_READ_BUFFERED (1 << 0)
83 /* AD9523_PLL1_CHARGE_PUMP_CTRL */
84 #define AD9523_PLL1_CHARGE_PUMP_CURRENT_nA(x) (((x) / 500) & 0x7F)
85 #define AD9523_PLL1_CHARGE_PUMP_TRISTATE (1 << 7)
86 #define AD9523_PLL1_CHARGE_PUMP_MODE_NORMAL (3 << 8)
87 #define AD9523_PLL1_CHARGE_PUMP_MODE_PUMP_DOWN (2 << 8)
88 #define AD9523_PLL1_CHARGE_PUMP_MODE_PUMP_UP (1 << 8)
89 #define AD9523_PLL1_CHARGE_PUMP_MODE_TRISTATE (0 << 8)
90 #define AD9523_PLL1_BACKLASH_PW_MIN (0 << 10)
91 #define AD9523_PLL1_BACKLASH_PW_LOW (1 << 10)
92 #define AD9523_PLL1_BACKLASH_PW_HIGH (2 << 10)
93 #define AD9523_PLL1_BACKLASH_PW_MAX (3 << 10)
95 /* AD9523_PLL1_INPUT_RECEIVERS_CTRL */
96 #define AD9523_PLL1_REF_TEST_RCV_EN (1 << 7)
97 #define AD9523_PLL1_REFB_DIFF_RCV_EN (1 << 6)
98 #define AD9523_PLL1_REFA_DIFF_RCV_EN (1 << 5)
99 #define AD9523_PLL1_REFB_RCV_EN (1 << 4)
100 #define AD9523_PLL1_REFA_RCV_EN (1 << 3)
101 #define AD9523_PLL1_REFA_REFB_PWR_CTRL_EN (1 << 2)
102 #define AD9523_PLL1_OSC_IN_CMOS_NEG_INP_EN (1 << 1)
103 #define AD9523_PLL1_OSC_IN_DIFF_EN (1 << 0)
105 /* AD9523_PLL1_REF_CTRL */
106 #define AD9523_PLL1_BYPASS_REF_TEST_DIV_EN (1 << 7)
107 #define AD9523_PLL1_BYPASS_FEEDBACK_DIV_EN (1 << 6)
108 #define AD9523_PLL1_ZERO_DELAY_MODE_INT (1 << 5)
109 #define AD9523_PLL1_ZERO_DELAY_MODE_EXT (0 << 5)
110 #define AD9523_PLL1_OSC_IN_PLL_FEEDBACK_EN (1 << 4)
111 #define AD9523_PLL1_ZD_IN_CMOS_NEG_INP_EN (1 << 3)
112 #define AD9523_PLL1_ZD_IN_DIFF_EN (1 << 2)
113 #define AD9523_PLL1_REFB_CMOS_NEG_INP_EN (1 << 1)
114 #define AD9523_PLL1_REFA_CMOS_NEG_INP_EN (1 << 0)
116 /* AD9523_PLL1_MISC_CTRL */
117 #define AD9523_PLL1_REFB_INDEP_DIV_CTRL_EN (1 << 7)
118 #define AD9523_PLL1_OSC_CTRL_FAIL_VCC_BY2_EN (1 << 6)
119 #define AD9523_PLL1_REF_MODE(x) ((x) << 2)
120 #define AD9523_PLL1_BYPASS_REFB_DIV (1 << 1)
121 #define AD9523_PLL1_BYPASS_REFA_DIV (1 << 0)
123 /* AD9523_PLL1_LOOP_FILTER_CTRL */
124 #define AD9523_PLL1_LOOP_FILTER_RZERO(x) ((x) & 0xF)
126 /* AD9523_PLL2_CHARGE_PUMP */
127 #define AD9523_PLL2_CHARGE_PUMP_CURRENT_nA(x) ((x) / 3500)
129 /* AD9523_PLL2_FEEDBACK_DIVIDER_AB */
130 #define AD9523_PLL2_FB_NDIV_A_CNT(x) (((x) & 0x3) << 6)
131 #define AD9523_PLL2_FB_NDIV_B_CNT(x) (((x) & 0x3F) << 0)
132 #define AD9523_PLL2_FB_NDIV(a, b) (4 * (b) + (a))
134 /* AD9523_PLL2_CTRL */
135 #define AD9523_PLL2_CHARGE_PUMP_MODE_NORMAL (3 << 0)
136 #define AD9523_PLL2_CHARGE_PUMP_MODE_PUMP_DOWN (2 << 0)
137 #define AD9523_PLL2_CHARGE_PUMP_MODE_PUMP_UP (1 << 0)
138 #define AD9523_PLL2_CHARGE_PUMP_MODE_TRISTATE (0 << 0)
139 #define AD9523_PLL2_BACKLASH_PW_MIN (0 << 2)
140 #define AD9523_PLL2_BACKLASH_PW_LOW (1 << 2)
141 #define AD9523_PLL2_BACKLASH_PW_HIGH (2 << 2)
142 #define AD9523_PLL2_BACKLASH_PW_MAX (3 << 1)
143 #define AD9523_PLL2_BACKLASH_CTRL_EN (1 << 4)
144 #define AD9523_PLL2_FREQ_DOUBLER_EN (1 << 5)
145 #define AD9523_PLL2_LOCK_DETECT_PWR_DOWN_EN (1 << 7)
147 /* AD9523_PLL2_VCO_CTRL */
148 #define AD9523_PLL2_VCO_CALIBRATE (1 << 1)
149 #define AD9523_PLL2_FORCE_VCO_MIDSCALE (1 << 2)
150 #define AD9523_PLL2_FORCE_REFERENCE_VALID (1 << 3)
151 #define AD9523_PLL2_FORCE_RELEASE_SYNC (1 << 4)
153 /* AD9523_PLL2_VCO_DIVIDER */
154 #define AD9523_PLL2_VCO_DIV_M1(x) ((((x) - 3) & 0x3) << 0)
155 #define AD9523_PLL2_VCO_DIV_M2(x) ((((x) - 3) & 0x3) << 4)
156 #define AD9523_PLL2_VCO_DIV_M1_PWR_DOWN_EN (1 << 2)
157 #define AD9523_PLL2_VCO_DIV_M2_PWR_DOWN_EN (1 << 6)
159 /* AD9523_PLL2_LOOP_FILTER_CTRL */
160 #define AD9523_PLL2_LOOP_FILTER_CPOLE1(x) (((x) & 0x7) << 0)
161 #define AD9523_PLL2_LOOP_FILTER_RZERO(x) (((x) & 0x7) << 3)
162 #define AD9523_PLL2_LOOP_FILTER_RPOLE2(x) (((x) & 0x7) << 6)
163 #define AD9523_PLL2_LOOP_FILTER_RZERO_BYPASS_EN (1 << 8)
165 /* AD9523_PLL2_R2_DIVIDER */
166 #define AD9523_PLL2_R2_DIVIDER_VAL(x) (((x) & 0x1F) << 0)
168 /* AD9523_CHANNEL_CLOCK_DIST */
169 #define AD9523_CLK_DIST_DIV_PHASE(x) (((x) & 0x3F) << 18)
170 #define AD9523_CLK_DIST_DIV_PHASE_REV(x) ((ret >> 18) & 0x3F)
171 #define AD9523_CLK_DIST_DIV(x) ((((x) - 1) & 0x3FF) << 8)
172 #define AD9523_CLK_DIST_DIV_REV(x) (((ret >> 8) & 0x3FF) + 1)
173 #define AD9523_CLK_DIST_INV_DIV_OUTPUT_EN (1 << 7)
174 #define AD9523_CLK_DIST_IGNORE_SYNC_EN (1 << 6)
175 #define AD9523_CLK_DIST_PWR_DOWN_EN (1 << 5)
176 #define AD9523_CLK_DIST_LOW_PWR_MODE_EN (1 << 4)
177 #define AD9523_CLK_DIST_DRIVER_MODE(x) (((x) & 0xF) << 0)
179 /* AD9523_PLL1_OUTPUT_CTRL */
180 #define AD9523_PLL1_OUTP_CTRL_VCO_DIV_SEL_CH6_M2 (1 << 7)
181 #define AD9523_PLL1_OUTP_CTRL_VCO_DIV_SEL_CH5_M2 (1 << 6)
182 #define AD9523_PLL1_OUTP_CTRL_VCO_DIV_SEL_CH4_M2 (1 << 5)
183 #define AD9523_PLL1_OUTP_CTRL_CMOS_DRV_WEAK (1 << 4)
184 #define AD9523_PLL1_OUTP_CTRL_OUTPUT_DIV_1 (0 << 0)
185 #define AD9523_PLL1_OUTP_CTRL_OUTPUT_DIV_2 (1 << 0)
186 #define AD9523_PLL1_OUTP_CTRL_OUTPUT_DIV_4 (2 << 0)
187 #define AD9523_PLL1_OUTP_CTRL_OUTPUT_DIV_8 (4 << 0)
188 #define AD9523_PLL1_OUTP_CTRL_OUTPUT_DIV_16 (8 << 0)
190 /* AD9523_PLL1_OUTPUT_CHANNEL_CTRL */
191 #define AD9523_PLL1_OUTP_CH_CTRL_OUTPUT_PWR_DOWN_EN (1 << 7)
192 #define AD9523_PLL1_OUTP_CH_CTRL_VCO_DIV_SEL_CH9_M2 (1 << 6)
193 #define AD9523_PLL1_OUTP_CH_CTRL_VCO_DIV_SEL_CH8_M2 (1 << 5)
194 #define AD9523_PLL1_OUTP_CH_CTRL_VCO_DIV_SEL_CH7_M2 (1 << 4)
195 #define AD9523_PLL1_OUTP_CH_CTRL_VCXO_SRC_SEL_CH3 (1 << 3)
196 #define AD9523_PLL1_OUTP_CH_CTRL_VCXO_SRC_SEL_CH2 (1 << 2)
197 #define AD9523_PLL1_OUTP_CH_CTRL_VCXO_SRC_SEL_CH1 (1 << 1)
198 #define AD9523_PLL1_OUTP_CH_CTRL_VCXO_SRC_SEL_CH0 (1 << 0)
200 /* AD9523_READBACK_0 */
201 #define AD9523_READBACK_0_STAT_PLL2_REF_CLK (1 << 7)
202 #define AD9523_READBACK_0_STAT_PLL2_FB_CLK (1 << 6)
203 #define AD9523_READBACK_0_STAT_VCXO (1 << 5)
204 #define AD9523_READBACK_0_STAT_REF_TEST (1 << 4)
205 #define AD9523_READBACK_0_STAT_REFB (1 << 3)
206 #define AD9523_READBACK_0_STAT_REFA (1 << 2)
207 #define AD9523_READBACK_0_STAT_PLL2_LD (1 << 1)
208 #define AD9523_READBACK_0_STAT_PLL1_LD (1 << 0)
210 /* AD9523_READBACK_1 */
211 #define AD9523_READBACK_1_HOLDOVER_ACTIVE (1 << 3)
212 #define AD9523_READBACK_1_AUTOMODE_SEL_REFB (1 << 2)
213 #define AD9523_READBACK_1_VCO_CALIB_IN_PROGRESS (1 << 0)
215 /* AD9523_STATUS_SIGNALS */
216 #define AD9523_STATUS_SIGNALS_SYNC_MAN_CTRL (1 << 16)
217 #define AD9523_STATUS_MONITOR_01_PLL12_LOCKED (0x302)
218 /* AD9523_POWER_DOWN_CTRL */
219 #define AD9523_POWER_DOWN_CTRL_PLL1_PWR_DOWN (1 << 2)
220 #define AD9523_POWER_DOWN_CTRL_PLL2_PWR_DOWN (1 << 1)
221 #define AD9523_POWER_DOWN_CTRL_DIST_PWR_DOWN (1 << 0)
223 /* AD9523_IO_UPDATE */
224 #define AD9523_IO_UPDATE_EN (1 << 0)
226 /* AD9523_EEPROM_DATA_XFER_STATUS */
227 #define AD9523_EEPROM_DATA_XFER_IN_PROGRESS (1 << 0)
229 /* AD9523_EEPROM_ERROR_READBACK */
230 #define AD9523_EEPROM_ERROR_READBACK_FAIL (1 << 0)
232 /* AD9523_EEPROM_CTRL1 */
233 #define AD9523_EEPROM_CTRL1_SOFT_EEPROM (1 << 1)
234 #define AD9523_EEPROM_CTRL1_EEPROM_WRITE_PROT_DIS (1 << 0)
236 /* AD9523_EEPROM_CTRL2 */
237 #define AD9523_EEPROM_CTRL2_REG2EEPROM (1 << 0)
239 #define AD9523_NUM_CHAN 14
240 #define AD9523_NUM_CHAN_ALT_CLK_SRC 10
242 /* Helpers to avoid excess line breaks */
243 #define AD_IFE(_pde, _a, _b) ((pdata->_pde) ? _a : _b)
244 #define AD_IF(_pde, _a) AD_IFE(_pde, _a, 0)
246 enum {
247 AD9523_STAT_PLL1_LD,
248 AD9523_STAT_PLL2_LD,
249 AD9523_STAT_REFA,
250 AD9523_STAT_REFB,
251 AD9523_STAT_REF_TEST,
252 AD9523_STAT_VCXO,
253 AD9523_STAT_PLL2_FB_CLK,
254 AD9523_STAT_PLL2_REF_CLK,
255 AD9523_SYNC,
256 AD9523_EEPROM,
259 enum {
260 AD9523_VCO1,
261 AD9523_VCO2,
262 AD9523_VCXO,
263 AD9523_NUM_CLK_SRC,
266 struct ad9523_state {
267 struct spi_device *spi;
268 struct regulator *reg;
269 struct ad9523_platform_data *pdata;
270 struct iio_chan_spec ad9523_channels[AD9523_NUM_CHAN];
272 unsigned long vcxo_freq;
273 unsigned long vco_freq;
274 unsigned long vco_out_freq[AD9523_NUM_CLK_SRC];
275 unsigned char vco_out_map[AD9523_NUM_CHAN_ALT_CLK_SRC];
278 * DMA (thus cache coherency maintenance) requires the
279 * transfer buffers to live in their own cache lines.
281 union {
282 __be32 d32;
283 u8 d8[4];
284 } data[2] ____cacheline_aligned;
287 static int ad9523_read(struct iio_dev *indio_dev, unsigned int addr)
289 struct ad9523_state *st = iio_priv(indio_dev);
290 int ret;
292 /* We encode the register size 1..3 bytes into the register address.
293 * On transfer we get the size from the register datum, and make sure
294 * the result is properly aligned.
297 struct spi_transfer t[] = {
299 .tx_buf = &st->data[0].d8[2],
300 .len = 2,
301 }, {
302 .rx_buf = &st->data[1].d8[4 - AD9523_TRANSF_LEN(addr)],
303 .len = AD9523_TRANSF_LEN(addr),
307 st->data[0].d32 = cpu_to_be32(AD9523_READ |
308 AD9523_CNT(AD9523_TRANSF_LEN(addr)) |
309 AD9523_ADDR(addr));
311 ret = spi_sync_transfer(st->spi, t, ARRAY_SIZE(t));
312 if (ret < 0)
313 dev_err(&indio_dev->dev, "read failed (%d)", ret);
314 else
315 ret = be32_to_cpu(st->data[1].d32) & (0xFFFFFF >>
316 (8 * (3 - AD9523_TRANSF_LEN(addr))));
318 return ret;
321 static int ad9523_write(struct iio_dev *indio_dev,
322 unsigned int addr, unsigned int val)
324 struct ad9523_state *st = iio_priv(indio_dev);
325 int ret;
326 struct spi_transfer t[] = {
328 .tx_buf = &st->data[0].d8[2],
329 .len = 2,
330 }, {
331 .tx_buf = &st->data[1].d8[4 - AD9523_TRANSF_LEN(addr)],
332 .len = AD9523_TRANSF_LEN(addr),
336 st->data[0].d32 = cpu_to_be32(AD9523_WRITE |
337 AD9523_CNT(AD9523_TRANSF_LEN(addr)) |
338 AD9523_ADDR(addr));
339 st->data[1].d32 = cpu_to_be32(val);
341 ret = spi_sync_transfer(st->spi, t, ARRAY_SIZE(t));
343 if (ret < 0)
344 dev_err(&indio_dev->dev, "write failed (%d)", ret);
346 return ret;
349 static int ad9523_io_update(struct iio_dev *indio_dev)
351 return ad9523_write(indio_dev, AD9523_IO_UPDATE, AD9523_IO_UPDATE_EN);
354 static int ad9523_vco_out_map(struct iio_dev *indio_dev,
355 unsigned int ch, unsigned int out)
357 struct ad9523_state *st = iio_priv(indio_dev);
358 int ret;
359 unsigned int mask;
361 switch (ch) {
362 case 0 ... 3:
363 ret = ad9523_read(indio_dev, AD9523_PLL1_OUTPUT_CHANNEL_CTRL);
364 if (ret < 0)
365 break;
366 mask = AD9523_PLL1_OUTP_CH_CTRL_VCXO_SRC_SEL_CH0 << ch;
367 if (out) {
368 ret |= mask;
369 out = 2;
370 } else {
371 ret &= ~mask;
373 ret = ad9523_write(indio_dev,
374 AD9523_PLL1_OUTPUT_CHANNEL_CTRL, ret);
375 break;
376 case 4 ... 6:
377 ret = ad9523_read(indio_dev, AD9523_PLL1_OUTPUT_CTRL);
378 if (ret < 0)
379 break;
380 mask = AD9523_PLL1_OUTP_CTRL_VCO_DIV_SEL_CH4_M2 << (ch - 4);
381 if (out)
382 ret |= mask;
383 else
384 ret &= ~mask;
385 ret = ad9523_write(indio_dev, AD9523_PLL1_OUTPUT_CTRL, ret);
386 break;
387 case 7 ... 9:
388 ret = ad9523_read(indio_dev, AD9523_PLL1_OUTPUT_CHANNEL_CTRL);
389 if (ret < 0)
390 break;
391 mask = AD9523_PLL1_OUTP_CH_CTRL_VCO_DIV_SEL_CH7_M2 << (ch - 7);
392 if (out)
393 ret |= mask;
394 else
395 ret &= ~mask;
396 ret = ad9523_write(indio_dev,
397 AD9523_PLL1_OUTPUT_CHANNEL_CTRL, ret);
398 break;
399 default:
400 return 0;
403 st->vco_out_map[ch] = out;
405 return ret;
408 static int ad9523_set_clock_provider(struct iio_dev *indio_dev,
409 unsigned int ch, unsigned long freq)
411 struct ad9523_state *st = iio_priv(indio_dev);
412 long tmp1, tmp2;
413 bool use_alt_clk_src;
415 switch (ch) {
416 case 0 ... 3:
417 use_alt_clk_src = (freq == st->vco_out_freq[AD9523_VCXO]);
418 break;
419 case 4 ... 9:
420 tmp1 = st->vco_out_freq[AD9523_VCO1] / freq;
421 tmp2 = st->vco_out_freq[AD9523_VCO2] / freq;
422 tmp1 *= freq;
423 tmp2 *= freq;
424 use_alt_clk_src = (abs(tmp1 - freq) > abs(tmp2 - freq));
425 break;
426 default:
427 /* Ch 10..14: No action required, return success */
428 return 0;
431 return ad9523_vco_out_map(indio_dev, ch, use_alt_clk_src);
434 static int ad9523_store_eeprom(struct iio_dev *indio_dev)
436 int ret, tmp;
438 ret = ad9523_write(indio_dev, AD9523_EEPROM_CTRL1,
439 AD9523_EEPROM_CTRL1_EEPROM_WRITE_PROT_DIS);
440 if (ret < 0)
441 return ret;
442 ret = ad9523_write(indio_dev, AD9523_EEPROM_CTRL2,
443 AD9523_EEPROM_CTRL2_REG2EEPROM);
444 if (ret < 0)
445 return ret;
447 tmp = 4;
448 do {
449 msleep(20);
450 ret = ad9523_read(indio_dev,
451 AD9523_EEPROM_DATA_XFER_STATUS);
452 if (ret < 0)
453 return ret;
454 } while ((ret & AD9523_EEPROM_DATA_XFER_IN_PROGRESS) && tmp--);
456 ret = ad9523_write(indio_dev, AD9523_EEPROM_CTRL1, 0);
457 if (ret < 0)
458 return ret;
460 ret = ad9523_read(indio_dev, AD9523_EEPROM_ERROR_READBACK);
461 if (ret < 0)
462 return ret;
464 if (ret & AD9523_EEPROM_ERROR_READBACK_FAIL) {
465 dev_err(&indio_dev->dev, "Verify EEPROM failed");
466 ret = -EIO;
469 return ret;
472 static int ad9523_sync(struct iio_dev *indio_dev)
474 int ret, tmp;
476 ret = ad9523_read(indio_dev, AD9523_STATUS_SIGNALS);
477 if (ret < 0)
478 return ret;
480 tmp = ret;
481 tmp |= AD9523_STATUS_SIGNALS_SYNC_MAN_CTRL;
483 ret = ad9523_write(indio_dev, AD9523_STATUS_SIGNALS, tmp);
484 if (ret < 0)
485 return ret;
487 ad9523_io_update(indio_dev);
488 tmp &= ~AD9523_STATUS_SIGNALS_SYNC_MAN_CTRL;
490 ret = ad9523_write(indio_dev, AD9523_STATUS_SIGNALS, tmp);
491 if (ret < 0)
492 return ret;
494 return ad9523_io_update(indio_dev);
497 static ssize_t ad9523_store(struct device *dev,
498 struct device_attribute *attr,
499 const char *buf, size_t len)
501 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
502 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
503 bool state;
504 int ret;
506 ret = strtobool(buf, &state);
507 if (ret < 0)
508 return ret;
510 if (!state)
511 return 0;
513 mutex_lock(&indio_dev->mlock);
514 switch ((u32)this_attr->address) {
515 case AD9523_SYNC:
516 ret = ad9523_sync(indio_dev);
517 break;
518 case AD9523_EEPROM:
519 ret = ad9523_store_eeprom(indio_dev);
520 break;
521 default:
522 ret = -ENODEV;
524 mutex_unlock(&indio_dev->mlock);
526 return ret ? ret : len;
529 static ssize_t ad9523_show(struct device *dev,
530 struct device_attribute *attr,
531 char *buf)
533 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
534 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
535 int ret;
537 mutex_lock(&indio_dev->mlock);
538 ret = ad9523_read(indio_dev, AD9523_READBACK_0);
539 if (ret >= 0) {
540 ret = sprintf(buf, "%d\n", !!(ret & (1 <<
541 (u32)this_attr->address)));
543 mutex_unlock(&indio_dev->mlock);
545 return ret;
548 static IIO_DEVICE_ATTR(pll1_locked, S_IRUGO,
549 ad9523_show,
550 NULL,
551 AD9523_STAT_PLL1_LD);
553 static IIO_DEVICE_ATTR(pll2_locked, S_IRUGO,
554 ad9523_show,
555 NULL,
556 AD9523_STAT_PLL2_LD);
558 static IIO_DEVICE_ATTR(pll1_reference_clk_a_present, S_IRUGO,
559 ad9523_show,
560 NULL,
561 AD9523_STAT_REFA);
563 static IIO_DEVICE_ATTR(pll1_reference_clk_b_present, S_IRUGO,
564 ad9523_show,
565 NULL,
566 AD9523_STAT_REFB);
568 static IIO_DEVICE_ATTR(pll1_reference_clk_test_present, S_IRUGO,
569 ad9523_show,
570 NULL,
571 AD9523_STAT_REF_TEST);
573 static IIO_DEVICE_ATTR(vcxo_clk_present, S_IRUGO,
574 ad9523_show,
575 NULL,
576 AD9523_STAT_VCXO);
578 static IIO_DEVICE_ATTR(pll2_feedback_clk_present, S_IRUGO,
579 ad9523_show,
580 NULL,
581 AD9523_STAT_PLL2_FB_CLK);
583 static IIO_DEVICE_ATTR(pll2_reference_clk_present, S_IRUGO,
584 ad9523_show,
585 NULL,
586 AD9523_STAT_PLL2_REF_CLK);
588 static IIO_DEVICE_ATTR(sync_dividers, S_IWUSR,
589 NULL,
590 ad9523_store,
591 AD9523_SYNC);
593 static IIO_DEVICE_ATTR(store_eeprom, S_IWUSR,
594 NULL,
595 ad9523_store,
596 AD9523_EEPROM);
598 static struct attribute *ad9523_attributes[] = {
599 &iio_dev_attr_sync_dividers.dev_attr.attr,
600 &iio_dev_attr_store_eeprom.dev_attr.attr,
601 &iio_dev_attr_pll2_feedback_clk_present.dev_attr.attr,
602 &iio_dev_attr_pll2_reference_clk_present.dev_attr.attr,
603 &iio_dev_attr_pll1_reference_clk_a_present.dev_attr.attr,
604 &iio_dev_attr_pll1_reference_clk_b_present.dev_attr.attr,
605 &iio_dev_attr_pll1_reference_clk_test_present.dev_attr.attr,
606 &iio_dev_attr_vcxo_clk_present.dev_attr.attr,
607 &iio_dev_attr_pll1_locked.dev_attr.attr,
608 &iio_dev_attr_pll2_locked.dev_attr.attr,
609 NULL,
612 static const struct attribute_group ad9523_attribute_group = {
613 .attrs = ad9523_attributes,
616 static int ad9523_read_raw(struct iio_dev *indio_dev,
617 struct iio_chan_spec const *chan,
618 int *val,
619 int *val2,
620 long m)
622 struct ad9523_state *st = iio_priv(indio_dev);
623 unsigned int code;
624 int ret;
626 mutex_lock(&indio_dev->mlock);
627 ret = ad9523_read(indio_dev, AD9523_CHANNEL_CLOCK_DIST(chan->channel));
628 mutex_unlock(&indio_dev->mlock);
630 if (ret < 0)
631 return ret;
633 switch (m) {
634 case IIO_CHAN_INFO_RAW:
635 *val = !(ret & AD9523_CLK_DIST_PWR_DOWN_EN);
636 return IIO_VAL_INT;
637 case IIO_CHAN_INFO_FREQUENCY:
638 *val = st->vco_out_freq[st->vco_out_map[chan->channel]] /
639 AD9523_CLK_DIST_DIV_REV(ret);
640 return IIO_VAL_INT;
641 case IIO_CHAN_INFO_PHASE:
642 code = (AD9523_CLK_DIST_DIV_PHASE_REV(ret) * 3141592) /
643 AD9523_CLK_DIST_DIV_REV(ret);
644 *val = code / 1000000;
645 *val2 = (code % 1000000) * 10;
646 return IIO_VAL_INT_PLUS_MICRO;
647 default:
648 return -EINVAL;
652 static int ad9523_write_raw(struct iio_dev *indio_dev,
653 struct iio_chan_spec const *chan,
654 int val,
655 int val2,
656 long mask)
658 struct ad9523_state *st = iio_priv(indio_dev);
659 unsigned int reg;
660 int ret, tmp, code;
662 mutex_lock(&indio_dev->mlock);
663 ret = ad9523_read(indio_dev, AD9523_CHANNEL_CLOCK_DIST(chan->channel));
664 if (ret < 0)
665 goto out;
667 reg = ret;
669 switch (mask) {
670 case IIO_CHAN_INFO_RAW:
671 if (val)
672 reg &= ~AD9523_CLK_DIST_PWR_DOWN_EN;
673 else
674 reg |= AD9523_CLK_DIST_PWR_DOWN_EN;
675 break;
676 case IIO_CHAN_INFO_FREQUENCY:
677 if (val <= 0) {
678 ret = -EINVAL;
679 goto out;
681 ret = ad9523_set_clock_provider(indio_dev, chan->channel, val);
682 if (ret < 0)
683 goto out;
684 tmp = st->vco_out_freq[st->vco_out_map[chan->channel]] / val;
685 tmp = clamp(tmp, 1, 1024);
686 reg &= ~(0x3FF << 8);
687 reg |= AD9523_CLK_DIST_DIV(tmp);
688 break;
689 case IIO_CHAN_INFO_PHASE:
690 code = val * 1000000 + val2 % 1000000;
691 tmp = (code * AD9523_CLK_DIST_DIV_REV(ret)) / 3141592;
692 tmp = clamp(tmp, 0, 63);
693 reg &= ~AD9523_CLK_DIST_DIV_PHASE(~0);
694 reg |= AD9523_CLK_DIST_DIV_PHASE(tmp);
695 break;
696 default:
697 ret = -EINVAL;
698 goto out;
701 ret = ad9523_write(indio_dev, AD9523_CHANNEL_CLOCK_DIST(chan->channel),
702 reg);
703 if (ret < 0)
704 goto out;
706 ad9523_io_update(indio_dev);
707 out:
708 mutex_unlock(&indio_dev->mlock);
709 return ret;
712 static int ad9523_reg_access(struct iio_dev *indio_dev,
713 unsigned int reg, unsigned int writeval,
714 unsigned int *readval)
716 int ret;
718 mutex_lock(&indio_dev->mlock);
719 if (readval == NULL) {
720 ret = ad9523_write(indio_dev, reg | AD9523_R1B, writeval);
721 ad9523_io_update(indio_dev);
722 } else {
723 ret = ad9523_read(indio_dev, reg | AD9523_R1B);
724 if (ret < 0)
725 goto out_unlock;
726 *readval = ret;
727 ret = 0;
730 out_unlock:
731 mutex_unlock(&indio_dev->mlock);
733 return ret;
736 static const struct iio_info ad9523_info = {
737 .read_raw = &ad9523_read_raw,
738 .write_raw = &ad9523_write_raw,
739 .debugfs_reg_access = &ad9523_reg_access,
740 .attrs = &ad9523_attribute_group,
741 .driver_module = THIS_MODULE,
744 static int ad9523_setup(struct iio_dev *indio_dev)
746 struct ad9523_state *st = iio_priv(indio_dev);
747 struct ad9523_platform_data *pdata = st->pdata;
748 struct ad9523_channel_spec *chan;
749 unsigned long active_mask = 0;
750 int ret, i;
752 ret = ad9523_write(indio_dev, AD9523_SERIAL_PORT_CONFIG,
753 AD9523_SER_CONF_SOFT_RESET |
754 (st->spi->mode & SPI_3WIRE ? 0 :
755 AD9523_SER_CONF_SDO_ACTIVE));
756 if (ret < 0)
757 return ret;
759 ret = ad9523_write(indio_dev, AD9523_READBACK_CTRL,
760 AD9523_READBACK_CTRL_READ_BUFFERED);
761 if (ret < 0)
762 return ret;
764 ret = ad9523_io_update(indio_dev);
765 if (ret < 0)
766 return ret;
769 * PLL1 Setup
771 ret = ad9523_write(indio_dev, AD9523_PLL1_REF_A_DIVIDER,
772 pdata->refa_r_div);
773 if (ret < 0)
774 return ret;
776 ret = ad9523_write(indio_dev, AD9523_PLL1_REF_B_DIVIDER,
777 pdata->refb_r_div);
778 if (ret < 0)
779 return ret;
781 ret = ad9523_write(indio_dev, AD9523_PLL1_FEEDBACK_DIVIDER,
782 pdata->pll1_feedback_div);
783 if (ret < 0)
784 return ret;
786 ret = ad9523_write(indio_dev, AD9523_PLL1_CHARGE_PUMP_CTRL,
787 AD9523_PLL1_CHARGE_PUMP_CURRENT_nA(pdata->
788 pll1_charge_pump_current_nA) |
789 AD9523_PLL1_CHARGE_PUMP_MODE_NORMAL |
790 AD9523_PLL1_BACKLASH_PW_MIN);
791 if (ret < 0)
792 return ret;
794 ret = ad9523_write(indio_dev, AD9523_PLL1_INPUT_RECEIVERS_CTRL,
795 AD_IF(refa_diff_rcv_en, AD9523_PLL1_REFA_RCV_EN) |
796 AD_IF(refb_diff_rcv_en, AD9523_PLL1_REFB_RCV_EN) |
797 AD_IF(osc_in_diff_en, AD9523_PLL1_OSC_IN_DIFF_EN) |
798 AD_IF(osc_in_cmos_neg_inp_en,
799 AD9523_PLL1_OSC_IN_CMOS_NEG_INP_EN) |
800 AD_IF(refa_diff_rcv_en, AD9523_PLL1_REFA_DIFF_RCV_EN) |
801 AD_IF(refb_diff_rcv_en, AD9523_PLL1_REFB_DIFF_RCV_EN));
802 if (ret < 0)
803 return ret;
805 ret = ad9523_write(indio_dev, AD9523_PLL1_REF_CTRL,
806 AD_IF(zd_in_diff_en, AD9523_PLL1_ZD_IN_DIFF_EN) |
807 AD_IF(zd_in_cmos_neg_inp_en,
808 AD9523_PLL1_ZD_IN_CMOS_NEG_INP_EN) |
809 AD_IF(zero_delay_mode_internal_en,
810 AD9523_PLL1_ZERO_DELAY_MODE_INT) |
811 AD_IF(osc_in_feedback_en, AD9523_PLL1_OSC_IN_PLL_FEEDBACK_EN) |
812 AD_IF(refa_cmos_neg_inp_en, AD9523_PLL1_REFA_CMOS_NEG_INP_EN) |
813 AD_IF(refb_cmos_neg_inp_en, AD9523_PLL1_REFB_CMOS_NEG_INP_EN));
814 if (ret < 0)
815 return ret;
817 ret = ad9523_write(indio_dev, AD9523_PLL1_MISC_CTRL,
818 AD9523_PLL1_REFB_INDEP_DIV_CTRL_EN |
819 AD9523_PLL1_REF_MODE(pdata->ref_mode));
820 if (ret < 0)
821 return ret;
823 ret = ad9523_write(indio_dev, AD9523_PLL1_LOOP_FILTER_CTRL,
824 AD9523_PLL1_LOOP_FILTER_RZERO(pdata->pll1_loop_filter_rzero));
825 if (ret < 0)
826 return ret;
828 * PLL2 Setup
831 ret = ad9523_write(indio_dev, AD9523_PLL2_CHARGE_PUMP,
832 AD9523_PLL2_CHARGE_PUMP_CURRENT_nA(pdata->
833 pll2_charge_pump_current_nA));
834 if (ret < 0)
835 return ret;
837 ret = ad9523_write(indio_dev, AD9523_PLL2_FEEDBACK_DIVIDER_AB,
838 AD9523_PLL2_FB_NDIV_A_CNT(pdata->pll2_ndiv_a_cnt) |
839 AD9523_PLL2_FB_NDIV_B_CNT(pdata->pll2_ndiv_b_cnt));
840 if (ret < 0)
841 return ret;
843 ret = ad9523_write(indio_dev, AD9523_PLL2_CTRL,
844 AD9523_PLL2_CHARGE_PUMP_MODE_NORMAL |
845 AD9523_PLL2_BACKLASH_CTRL_EN |
846 AD_IF(pll2_freq_doubler_en, AD9523_PLL2_FREQ_DOUBLER_EN));
847 if (ret < 0)
848 return ret;
850 st->vco_freq = (pdata->vcxo_freq * (pdata->pll2_freq_doubler_en ? 2 : 1)
851 / pdata->pll2_r2_div) * AD9523_PLL2_FB_NDIV(pdata->
852 pll2_ndiv_a_cnt, pdata->pll2_ndiv_b_cnt);
854 ret = ad9523_write(indio_dev, AD9523_PLL2_VCO_CTRL,
855 AD9523_PLL2_VCO_CALIBRATE);
856 if (ret < 0)
857 return ret;
859 ret = ad9523_write(indio_dev, AD9523_PLL2_VCO_DIVIDER,
860 AD9523_PLL2_VCO_DIV_M1(pdata->pll2_vco_diff_m1) |
861 AD9523_PLL2_VCO_DIV_M2(pdata->pll2_vco_diff_m2) |
862 AD_IFE(pll2_vco_diff_m1, 0,
863 AD9523_PLL2_VCO_DIV_M1_PWR_DOWN_EN) |
864 AD_IFE(pll2_vco_diff_m2, 0,
865 AD9523_PLL2_VCO_DIV_M2_PWR_DOWN_EN));
866 if (ret < 0)
867 return ret;
869 if (pdata->pll2_vco_diff_m1)
870 st->vco_out_freq[AD9523_VCO1] =
871 st->vco_freq / pdata->pll2_vco_diff_m1;
873 if (pdata->pll2_vco_diff_m2)
874 st->vco_out_freq[AD9523_VCO2] =
875 st->vco_freq / pdata->pll2_vco_diff_m2;
877 st->vco_out_freq[AD9523_VCXO] = pdata->vcxo_freq;
879 ret = ad9523_write(indio_dev, AD9523_PLL2_R2_DIVIDER,
880 AD9523_PLL2_R2_DIVIDER_VAL(pdata->pll2_r2_div));
881 if (ret < 0)
882 return ret;
884 ret = ad9523_write(indio_dev, AD9523_PLL2_LOOP_FILTER_CTRL,
885 AD9523_PLL2_LOOP_FILTER_CPOLE1(pdata->cpole1) |
886 AD9523_PLL2_LOOP_FILTER_RZERO(pdata->rzero) |
887 AD9523_PLL2_LOOP_FILTER_RPOLE2(pdata->rpole2) |
888 AD_IF(rzero_bypass_en,
889 AD9523_PLL2_LOOP_FILTER_RZERO_BYPASS_EN));
890 if (ret < 0)
891 return ret;
893 for (i = 0; i < pdata->num_channels; i++) {
894 chan = &pdata->channels[i];
895 if (chan->channel_num < AD9523_NUM_CHAN) {
896 __set_bit(chan->channel_num, &active_mask);
897 ret = ad9523_write(indio_dev,
898 AD9523_CHANNEL_CLOCK_DIST(chan->channel_num),
899 AD9523_CLK_DIST_DRIVER_MODE(chan->driver_mode) |
900 AD9523_CLK_DIST_DIV(chan->channel_divider) |
901 AD9523_CLK_DIST_DIV_PHASE(chan->divider_phase) |
902 (chan->sync_ignore_en ?
903 AD9523_CLK_DIST_IGNORE_SYNC_EN : 0) |
904 (chan->divider_output_invert_en ?
905 AD9523_CLK_DIST_INV_DIV_OUTPUT_EN : 0) |
906 (chan->low_power_mode_en ?
907 AD9523_CLK_DIST_LOW_PWR_MODE_EN : 0) |
908 (chan->output_dis ?
909 AD9523_CLK_DIST_PWR_DOWN_EN : 0));
910 if (ret < 0)
911 return ret;
913 ret = ad9523_vco_out_map(indio_dev, chan->channel_num,
914 chan->use_alt_clock_src);
915 if (ret < 0)
916 return ret;
918 st->ad9523_channels[i].type = IIO_ALTVOLTAGE;
919 st->ad9523_channels[i].output = 1;
920 st->ad9523_channels[i].indexed = 1;
921 st->ad9523_channels[i].channel = chan->channel_num;
922 st->ad9523_channels[i].extend_name =
923 chan->extended_name;
924 st->ad9523_channels[i].info_mask_separate =
925 BIT(IIO_CHAN_INFO_RAW) |
926 BIT(IIO_CHAN_INFO_PHASE) |
927 BIT(IIO_CHAN_INFO_FREQUENCY);
931 for_each_clear_bit(i, &active_mask, AD9523_NUM_CHAN)
932 ad9523_write(indio_dev,
933 AD9523_CHANNEL_CLOCK_DIST(i),
934 AD9523_CLK_DIST_DRIVER_MODE(TRISTATE) |
935 AD9523_CLK_DIST_PWR_DOWN_EN);
937 ret = ad9523_write(indio_dev, AD9523_POWER_DOWN_CTRL, 0);
938 if (ret < 0)
939 return ret;
941 ret = ad9523_write(indio_dev, AD9523_STATUS_SIGNALS,
942 AD9523_STATUS_MONITOR_01_PLL12_LOCKED);
943 if (ret < 0)
944 return ret;
946 ret = ad9523_io_update(indio_dev);
947 if (ret < 0)
948 return ret;
950 return 0;
953 static int ad9523_probe(struct spi_device *spi)
955 struct ad9523_platform_data *pdata = spi->dev.platform_data;
956 struct iio_dev *indio_dev;
957 struct ad9523_state *st;
958 int ret;
960 if (!pdata) {
961 dev_err(&spi->dev, "no platform data?\n");
962 return -EINVAL;
965 indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*st));
966 if (indio_dev == NULL)
967 return -ENOMEM;
969 st = iio_priv(indio_dev);
971 st->reg = devm_regulator_get(&spi->dev, "vcc");
972 if (!IS_ERR(st->reg)) {
973 ret = regulator_enable(st->reg);
974 if (ret)
975 return ret;
978 spi_set_drvdata(spi, indio_dev);
979 st->spi = spi;
980 st->pdata = pdata;
982 indio_dev->dev.parent = &spi->dev;
983 indio_dev->name = (pdata->name[0] != 0) ? pdata->name :
984 spi_get_device_id(spi)->name;
985 indio_dev->info = &ad9523_info;
986 indio_dev->modes = INDIO_DIRECT_MODE;
987 indio_dev->channels = st->ad9523_channels;
988 indio_dev->num_channels = pdata->num_channels;
990 ret = ad9523_setup(indio_dev);
991 if (ret < 0)
992 goto error_disable_reg;
994 ret = iio_device_register(indio_dev);
995 if (ret)
996 goto error_disable_reg;
998 dev_info(&spi->dev, "probed %s\n", indio_dev->name);
1000 return 0;
1002 error_disable_reg:
1003 if (!IS_ERR(st->reg))
1004 regulator_disable(st->reg);
1006 return ret;
1009 static int ad9523_remove(struct spi_device *spi)
1011 struct iio_dev *indio_dev = spi_get_drvdata(spi);
1012 struct ad9523_state *st = iio_priv(indio_dev);
1014 iio_device_unregister(indio_dev);
1016 if (!IS_ERR(st->reg))
1017 regulator_disable(st->reg);
1019 return 0;
1022 static const struct spi_device_id ad9523_id[] = {
1023 {"ad9523-1", 9523},
1026 MODULE_DEVICE_TABLE(spi, ad9523_id);
1028 static struct spi_driver ad9523_driver = {
1029 .driver = {
1030 .name = "ad9523",
1032 .probe = ad9523_probe,
1033 .remove = ad9523_remove,
1034 .id_table = ad9523_id,
1036 module_spi_driver(ad9523_driver);
1038 MODULE_AUTHOR("Michael Hennerich <hennerich@blackfin.uclinux.org>");
1039 MODULE_DESCRIPTION("Analog Devices AD9523 CLOCKDIST/PLL");
1040 MODULE_LICENSE("GPL v2");