Merge tag 'fixes-for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/arm...
[linux-2.6.git] / drivers / iio / dac / ad5755.c
blob9a78d5abb2f6646579fe6ffea21acd51dce91ca7
1 /*
2 * AD5755, AD5755-1, AD5757, AD5735, AD5737 Digital to analog converters driver
4 * Copyright 2012 Analog Devices Inc.
6 * Licensed under the GPL-2.
7 */
9 #include <linux/device.h>
10 #include <linux/err.h>
11 #include <linux/module.h>
12 #include <linux/kernel.h>
13 #include <linux/spi/spi.h>
14 #include <linux/slab.h>
15 #include <linux/sysfs.h>
16 #include <linux/delay.h>
17 #include <linux/iio/iio.h>
18 #include <linux/iio/sysfs.h>
19 #include <linux/platform_data/ad5755.h>
21 #define AD5755_NUM_CHANNELS 4
23 #define AD5755_ADDR(x) ((x) << 16)
25 #define AD5755_WRITE_REG_DATA(chan) (chan)
26 #define AD5755_WRITE_REG_GAIN(chan) (0x08 | (chan))
27 #define AD5755_WRITE_REG_OFFSET(chan) (0x10 | (chan))
28 #define AD5755_WRITE_REG_CTRL(chan) (0x1c | (chan))
30 #define AD5755_READ_REG_DATA(chan) (chan)
31 #define AD5755_READ_REG_CTRL(chan) (0x4 | (chan))
32 #define AD5755_READ_REG_GAIN(chan) (0x8 | (chan))
33 #define AD5755_READ_REG_OFFSET(chan) (0xc | (chan))
34 #define AD5755_READ_REG_CLEAR(chan) (0x10 | (chan))
35 #define AD5755_READ_REG_SLEW(chan) (0x14 | (chan))
36 #define AD5755_READ_REG_STATUS 0x18
37 #define AD5755_READ_REG_MAIN 0x19
38 #define AD5755_READ_REG_DC_DC 0x1a
40 #define AD5755_CTRL_REG_SLEW 0x0
41 #define AD5755_CTRL_REG_MAIN 0x1
42 #define AD5755_CTRL_REG_DAC 0x2
43 #define AD5755_CTRL_REG_DC_DC 0x3
44 #define AD5755_CTRL_REG_SW 0x4
46 #define AD5755_READ_FLAG 0x800000
48 #define AD5755_NOOP 0x1CE000
50 #define AD5755_DAC_INT_EN BIT(8)
51 #define AD5755_DAC_CLR_EN BIT(7)
52 #define AD5755_DAC_OUT_EN BIT(6)
53 #define AD5755_DAC_INT_CURRENT_SENSE_RESISTOR BIT(5)
54 #define AD5755_DAC_DC_DC_EN BIT(4)
55 #define AD5755_DAC_VOLTAGE_OVERRANGE_EN BIT(3)
57 #define AD5755_DC_DC_MAXV 0
58 #define AD5755_DC_DC_FREQ_SHIFT 2
59 #define AD5755_DC_DC_PHASE_SHIFT 4
60 #define AD5755_EXT_DC_DC_COMP_RES BIT(6)
62 #define AD5755_SLEW_STEP_SIZE_SHIFT 0
63 #define AD5755_SLEW_RATE_SHIFT 3
64 #define AD5755_SLEW_ENABLE BIT(12)
66 /**
67 * struct ad5755_chip_info - chip specific information
68 * @channel_template: channel specification
69 * @calib_shift: shift for the calibration data registers
70 * @has_voltage_out: whether the chip has voltage outputs
72 struct ad5755_chip_info {
73 const struct iio_chan_spec channel_template;
74 unsigned int calib_shift;
75 bool has_voltage_out;
78 /**
79 * struct ad5755_state - driver instance specific data
80 * @spi: spi device the driver is attached to
81 * @chip_info: chip model specific constants, available modes etc
82 * @pwr_down: bitmask which contains hether a channel is powered down or not
83 * @ctrl: software shadow of the channel ctrl registers
84 * @channels: iio channel spec for the device
85 * @data: spi transfer buffers
87 struct ad5755_state {
88 struct spi_device *spi;
89 const struct ad5755_chip_info *chip_info;
90 unsigned int pwr_down;
91 unsigned int ctrl[AD5755_NUM_CHANNELS];
92 struct iio_chan_spec channels[AD5755_NUM_CHANNELS];
95 * DMA (thus cache coherency maintenance) requires the
96 * transfer buffers to live in their own cache lines.
99 union {
100 u32 d32;
101 u8 d8[4];
102 } data[2] ____cacheline_aligned;
105 enum ad5755_type {
106 ID_AD5755,
107 ID_AD5757,
108 ID_AD5735,
109 ID_AD5737,
112 static int ad5755_write_unlocked(struct iio_dev *indio_dev,
113 unsigned int reg, unsigned int val)
115 struct ad5755_state *st = iio_priv(indio_dev);
117 st->data[0].d32 = cpu_to_be32((reg << 16) | val);
119 return spi_write(st->spi, &st->data[0].d8[1], 3);
122 static int ad5755_write_ctrl_unlocked(struct iio_dev *indio_dev,
123 unsigned int channel, unsigned int reg, unsigned int val)
125 return ad5755_write_unlocked(indio_dev,
126 AD5755_WRITE_REG_CTRL(channel), (reg << 13) | val);
129 static int ad5755_write(struct iio_dev *indio_dev, unsigned int reg,
130 unsigned int val)
132 int ret;
134 mutex_lock(&indio_dev->mlock);
135 ret = ad5755_write_unlocked(indio_dev, reg, val);
136 mutex_unlock(&indio_dev->mlock);
138 return ret;
141 static int ad5755_write_ctrl(struct iio_dev *indio_dev, unsigned int channel,
142 unsigned int reg, unsigned int val)
144 int ret;
146 mutex_lock(&indio_dev->mlock);
147 ret = ad5755_write_ctrl_unlocked(indio_dev, channel, reg, val);
148 mutex_unlock(&indio_dev->mlock);
150 return ret;
153 static int ad5755_read(struct iio_dev *indio_dev, unsigned int addr)
155 struct ad5755_state *st = iio_priv(indio_dev);
156 int ret;
157 struct spi_transfer t[] = {
159 .tx_buf = &st->data[0].d8[1],
160 .len = 3,
161 .cs_change = 1,
162 }, {
163 .tx_buf = &st->data[1].d8[1],
164 .rx_buf = &st->data[1].d8[1],
165 .len = 3,
169 mutex_lock(&indio_dev->mlock);
171 st->data[0].d32 = cpu_to_be32(AD5755_READ_FLAG | (addr << 16));
172 st->data[1].d32 = cpu_to_be32(AD5755_NOOP);
174 ret = spi_sync_transfer(st->spi, t, ARRAY_SIZE(t));
175 if (ret >= 0)
176 ret = be32_to_cpu(st->data[1].d32) & 0xffff;
178 mutex_unlock(&indio_dev->mlock);
180 return ret;
183 static int ad5755_update_dac_ctrl(struct iio_dev *indio_dev,
184 unsigned int channel, unsigned int set, unsigned int clr)
186 struct ad5755_state *st = iio_priv(indio_dev);
187 int ret;
189 st->ctrl[channel] |= set;
190 st->ctrl[channel] &= ~clr;
192 ret = ad5755_write_ctrl_unlocked(indio_dev, channel,
193 AD5755_CTRL_REG_DAC, st->ctrl[channel]);
195 return ret;
198 static int ad5755_set_channel_pwr_down(struct iio_dev *indio_dev,
199 unsigned int channel, bool pwr_down)
201 struct ad5755_state *st = iio_priv(indio_dev);
202 unsigned int mask = BIT(channel);
204 mutex_lock(&indio_dev->mlock);
206 if ((bool)(st->pwr_down & mask) == pwr_down)
207 goto out_unlock;
209 if (!pwr_down) {
210 st->pwr_down &= ~mask;
211 ad5755_update_dac_ctrl(indio_dev, channel,
212 AD5755_DAC_INT_EN | AD5755_DAC_DC_DC_EN, 0);
213 udelay(200);
214 ad5755_update_dac_ctrl(indio_dev, channel,
215 AD5755_DAC_OUT_EN, 0);
216 } else {
217 st->pwr_down |= mask;
218 ad5755_update_dac_ctrl(indio_dev, channel,
219 0, AD5755_DAC_INT_EN | AD5755_DAC_OUT_EN |
220 AD5755_DAC_DC_DC_EN);
223 out_unlock:
224 mutex_unlock(&indio_dev->mlock);
226 return 0;
229 static const int ad5755_min_max_table[][2] = {
230 [AD5755_MODE_VOLTAGE_0V_5V] = { 0, 5000 },
231 [AD5755_MODE_VOLTAGE_0V_10V] = { 0, 10000 },
232 [AD5755_MODE_VOLTAGE_PLUSMINUS_5V] = { -5000, 5000 },
233 [AD5755_MODE_VOLTAGE_PLUSMINUS_10V] = { -10000, 10000 },
234 [AD5755_MODE_CURRENT_4mA_20mA] = { 4, 20 },
235 [AD5755_MODE_CURRENT_0mA_20mA] = { 0, 20 },
236 [AD5755_MODE_CURRENT_0mA_24mA] = { 0, 24 },
239 static void ad5755_get_min_max(struct ad5755_state *st,
240 struct iio_chan_spec const *chan, int *min, int *max)
242 enum ad5755_mode mode = st->ctrl[chan->channel] & 7;
243 *min = ad5755_min_max_table[mode][0];
244 *max = ad5755_min_max_table[mode][1];
247 static inline int ad5755_get_offset(struct ad5755_state *st,
248 struct iio_chan_spec const *chan)
250 int min, max;
252 ad5755_get_min_max(st, chan, &min, &max);
253 return (min * (1 << chan->scan_type.realbits)) / (max - min);
256 static int ad5755_chan_reg_info(struct ad5755_state *st,
257 struct iio_chan_spec const *chan, long info, bool write,
258 unsigned int *reg, unsigned int *shift, unsigned int *offset)
260 switch (info) {
261 case IIO_CHAN_INFO_RAW:
262 if (write)
263 *reg = AD5755_WRITE_REG_DATA(chan->address);
264 else
265 *reg = AD5755_READ_REG_DATA(chan->address);
266 *shift = chan->scan_type.shift;
267 *offset = 0;
268 break;
269 case IIO_CHAN_INFO_CALIBBIAS:
270 if (write)
271 *reg = AD5755_WRITE_REG_OFFSET(chan->address);
272 else
273 *reg = AD5755_READ_REG_OFFSET(chan->address);
274 *shift = st->chip_info->calib_shift;
275 *offset = 32768;
276 break;
277 case IIO_CHAN_INFO_CALIBSCALE:
278 if (write)
279 *reg = AD5755_WRITE_REG_GAIN(chan->address);
280 else
281 *reg = AD5755_READ_REG_GAIN(chan->address);
282 *shift = st->chip_info->calib_shift;
283 *offset = 0;
284 break;
285 default:
286 return -EINVAL;
289 return 0;
292 static int ad5755_read_raw(struct iio_dev *indio_dev,
293 const struct iio_chan_spec *chan, int *val, int *val2, long info)
295 struct ad5755_state *st = iio_priv(indio_dev);
296 unsigned int reg, shift, offset;
297 int min, max;
298 int ret;
300 switch (info) {
301 case IIO_CHAN_INFO_SCALE:
302 ad5755_get_min_max(st, chan, &min, &max);
303 *val = max - min;
304 *val2 = chan->scan_type.realbits;
305 return IIO_VAL_FRACTIONAL_LOG2;
306 case IIO_CHAN_INFO_OFFSET:
307 *val = ad5755_get_offset(st, chan);
308 return IIO_VAL_INT;
309 default:
310 ret = ad5755_chan_reg_info(st, chan, info, false,
311 &reg, &shift, &offset);
312 if (ret)
313 return ret;
315 ret = ad5755_read(indio_dev, reg);
316 if (ret < 0)
317 return ret;
319 *val = (ret - offset) >> shift;
321 return IIO_VAL_INT;
324 return -EINVAL;
327 static int ad5755_write_raw(struct iio_dev *indio_dev,
328 const struct iio_chan_spec *chan, int val, int val2, long info)
330 struct ad5755_state *st = iio_priv(indio_dev);
331 unsigned int shift, reg, offset;
332 int ret;
334 ret = ad5755_chan_reg_info(st, chan, info, true,
335 &reg, &shift, &offset);
336 if (ret)
337 return ret;
339 val <<= shift;
340 val += offset;
342 if (val < 0 || val > 0xffff)
343 return -EINVAL;
345 return ad5755_write(indio_dev, reg, val);
348 static ssize_t ad5755_read_powerdown(struct iio_dev *indio_dev, uintptr_t priv,
349 const struct iio_chan_spec *chan, char *buf)
351 struct ad5755_state *st = iio_priv(indio_dev);
353 return sprintf(buf, "%d\n",
354 (bool)(st->pwr_down & (1 << chan->channel)));
357 static ssize_t ad5755_write_powerdown(struct iio_dev *indio_dev, uintptr_t priv,
358 struct iio_chan_spec const *chan, const char *buf, size_t len)
360 bool pwr_down;
361 int ret;
363 ret = strtobool(buf, &pwr_down);
364 if (ret)
365 return ret;
367 ret = ad5755_set_channel_pwr_down(indio_dev, chan->channel, pwr_down);
368 return ret ? ret : len;
371 static const struct iio_info ad5755_info = {
372 .read_raw = ad5755_read_raw,
373 .write_raw = ad5755_write_raw,
374 .driver_module = THIS_MODULE,
377 static const struct iio_chan_spec_ext_info ad5755_ext_info[] = {
379 .name = "powerdown",
380 .read = ad5755_read_powerdown,
381 .write = ad5755_write_powerdown,
382 .shared = IIO_SEPARATE,
384 { },
387 #define AD5755_CHANNEL(_bits) { \
388 .indexed = 1, \
389 .output = 1, \
390 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) | \
391 BIT(IIO_CHAN_INFO_SCALE) | \
392 BIT(IIO_CHAN_INFO_OFFSET) | \
393 BIT(IIO_CHAN_INFO_CALIBSCALE) | \
394 BIT(IIO_CHAN_INFO_CALIBBIAS), \
395 .scan_type = IIO_ST('u', (_bits), 16, 16 - (_bits)), \
396 .ext_info = ad5755_ext_info, \
399 static const struct ad5755_chip_info ad5755_chip_info_tbl[] = {
400 [ID_AD5735] = {
401 .channel_template = AD5755_CHANNEL(14),
402 .has_voltage_out = true,
403 .calib_shift = 4,
405 [ID_AD5737] = {
406 .channel_template = AD5755_CHANNEL(14),
407 .has_voltage_out = false,
408 .calib_shift = 4,
410 [ID_AD5755] = {
411 .channel_template = AD5755_CHANNEL(16),
412 .has_voltage_out = true,
413 .calib_shift = 0,
415 [ID_AD5757] = {
416 .channel_template = AD5755_CHANNEL(16),
417 .has_voltage_out = false,
418 .calib_shift = 0,
422 static bool ad5755_is_valid_mode(struct ad5755_state *st, enum ad5755_mode mode)
424 switch (mode) {
425 case AD5755_MODE_VOLTAGE_0V_5V:
426 case AD5755_MODE_VOLTAGE_0V_10V:
427 case AD5755_MODE_VOLTAGE_PLUSMINUS_5V:
428 case AD5755_MODE_VOLTAGE_PLUSMINUS_10V:
429 return st->chip_info->has_voltage_out;
430 case AD5755_MODE_CURRENT_4mA_20mA:
431 case AD5755_MODE_CURRENT_0mA_20mA:
432 case AD5755_MODE_CURRENT_0mA_24mA:
433 return true;
434 default:
435 return false;
439 static int ad5755_setup_pdata(struct iio_dev *indio_dev,
440 const struct ad5755_platform_data *pdata)
442 struct ad5755_state *st = iio_priv(indio_dev);
443 unsigned int val;
444 unsigned int i;
445 int ret;
447 if (pdata->dc_dc_phase > AD5755_DC_DC_PHASE_90_DEGREE ||
448 pdata->dc_dc_freq > AD5755_DC_DC_FREQ_650kHZ ||
449 pdata->dc_dc_maxv > AD5755_DC_DC_MAXV_29V5)
450 return -EINVAL;
452 val = pdata->dc_dc_maxv << AD5755_DC_DC_MAXV;
453 val |= pdata->dc_dc_freq << AD5755_DC_DC_FREQ_SHIFT;
454 val |= pdata->dc_dc_phase << AD5755_DC_DC_PHASE_SHIFT;
455 if (pdata->ext_dc_dc_compenstation_resistor)
456 val |= AD5755_EXT_DC_DC_COMP_RES;
458 ret = ad5755_write_ctrl(indio_dev, 0, AD5755_CTRL_REG_DC_DC, val);
459 if (ret < 0)
460 return ret;
462 for (i = 0; i < ARRAY_SIZE(pdata->dac); ++i) {
463 val = pdata->dac[i].slew.step_size <<
464 AD5755_SLEW_STEP_SIZE_SHIFT;
465 val |= pdata->dac[i].slew.rate <<
466 AD5755_SLEW_RATE_SHIFT;
467 if (pdata->dac[i].slew.enable)
468 val |= AD5755_SLEW_ENABLE;
470 ret = ad5755_write_ctrl(indio_dev, i,
471 AD5755_CTRL_REG_SLEW, val);
472 if (ret < 0)
473 return ret;
476 for (i = 0; i < ARRAY_SIZE(pdata->dac); ++i) {
477 if (!ad5755_is_valid_mode(st, pdata->dac[i].mode))
478 return -EINVAL;
480 val = 0;
481 if (!pdata->dac[i].ext_current_sense_resistor)
482 val |= AD5755_DAC_INT_CURRENT_SENSE_RESISTOR;
483 if (pdata->dac[i].enable_voltage_overrange)
484 val |= AD5755_DAC_VOLTAGE_OVERRANGE_EN;
485 val |= pdata->dac[i].mode;
487 ret = ad5755_update_dac_ctrl(indio_dev, i, val, 0);
488 if (ret < 0)
489 return ret;
492 return 0;
495 static bool ad5755_is_voltage_mode(enum ad5755_mode mode)
497 switch (mode) {
498 case AD5755_MODE_VOLTAGE_0V_5V:
499 case AD5755_MODE_VOLTAGE_0V_10V:
500 case AD5755_MODE_VOLTAGE_PLUSMINUS_5V:
501 case AD5755_MODE_VOLTAGE_PLUSMINUS_10V:
502 return true;
503 default:
504 return false;
508 static int ad5755_init_channels(struct iio_dev *indio_dev,
509 const struct ad5755_platform_data *pdata)
511 struct ad5755_state *st = iio_priv(indio_dev);
512 struct iio_chan_spec *channels = st->channels;
513 unsigned int i;
515 for (i = 0; i < AD5755_NUM_CHANNELS; ++i) {
516 channels[i] = st->chip_info->channel_template;
517 channels[i].channel = i;
518 channels[i].address = i;
519 if (pdata && ad5755_is_voltage_mode(pdata->dac[i].mode))
520 channels[i].type = IIO_VOLTAGE;
521 else
522 channels[i].type = IIO_CURRENT;
525 indio_dev->channels = channels;
527 return 0;
530 #define AD5755_DEFAULT_DAC_PDATA { \
531 .mode = AD5755_MODE_CURRENT_4mA_20mA, \
532 .ext_current_sense_resistor = true, \
533 .enable_voltage_overrange = false, \
534 .slew = { \
535 .enable = false, \
536 .rate = AD5755_SLEW_RATE_64k, \
537 .step_size = AD5755_SLEW_STEP_SIZE_1, \
538 }, \
541 static const struct ad5755_platform_data ad5755_default_pdata = {
542 .ext_dc_dc_compenstation_resistor = false,
543 .dc_dc_phase = AD5755_DC_DC_PHASE_ALL_SAME_EDGE,
544 .dc_dc_freq = AD5755_DC_DC_FREQ_410kHZ,
545 .dc_dc_maxv = AD5755_DC_DC_MAXV_23V,
546 .dac = {
547 [0] = AD5755_DEFAULT_DAC_PDATA,
548 [1] = AD5755_DEFAULT_DAC_PDATA,
549 [2] = AD5755_DEFAULT_DAC_PDATA,
550 [3] = AD5755_DEFAULT_DAC_PDATA,
554 static int ad5755_probe(struct spi_device *spi)
556 enum ad5755_type type = spi_get_device_id(spi)->driver_data;
557 const struct ad5755_platform_data *pdata = dev_get_platdata(&spi->dev);
558 struct iio_dev *indio_dev;
559 struct ad5755_state *st;
560 int ret;
562 indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*st));
563 if (indio_dev == NULL) {
564 dev_err(&spi->dev, "Failed to allocate iio device\n");
565 return -ENOMEM;
568 st = iio_priv(indio_dev);
569 spi_set_drvdata(spi, indio_dev);
571 st->chip_info = &ad5755_chip_info_tbl[type];
572 st->spi = spi;
573 st->pwr_down = 0xf;
575 indio_dev->dev.parent = &spi->dev;
576 indio_dev->name = spi_get_device_id(spi)->name;
577 indio_dev->info = &ad5755_info;
578 indio_dev->modes = INDIO_DIRECT_MODE;
579 indio_dev->num_channels = AD5755_NUM_CHANNELS;
581 if (!pdata)
582 pdata = &ad5755_default_pdata;
584 ret = ad5755_init_channels(indio_dev, pdata);
585 if (ret)
586 return ret;
588 ret = ad5755_setup_pdata(indio_dev, pdata);
589 if (ret)
590 return ret;
592 return iio_device_register(indio_dev);
595 static int ad5755_remove(struct spi_device *spi)
597 struct iio_dev *indio_dev = spi_get_drvdata(spi);
599 iio_device_unregister(indio_dev);
601 return 0;
604 static const struct spi_device_id ad5755_id[] = {
605 { "ad5755", ID_AD5755 },
606 { "ad5755-1", ID_AD5755 },
607 { "ad5757", ID_AD5757 },
608 { "ad5735", ID_AD5735 },
609 { "ad5737", ID_AD5737 },
612 MODULE_DEVICE_TABLE(spi, ad5755_id);
614 static struct spi_driver ad5755_driver = {
615 .driver = {
616 .name = "ad5755",
617 .owner = THIS_MODULE,
619 .probe = ad5755_probe,
620 .remove = ad5755_remove,
621 .id_table = ad5755_id,
623 module_spi_driver(ad5755_driver);
625 MODULE_AUTHOR("Lars-Peter Clausen <lars@metafoo.de>");
626 MODULE_DESCRIPTION("Analog Devices AD5755/55-1/57/35/37 DAC");
627 MODULE_LICENSE("GPL v2");