2 * AD5024, AD5025, AD5044, AD5045, AD5064, AD5064-1, AD5065, AD5628, AD5629R,
3 * AD5648, AD5666, AD5668, AD5669R Digital to analog converters driver
5 * Copyright 2011 Analog Devices Inc.
7 * Licensed under the GPL-2.
10 #include <linux/device.h>
11 #include <linux/err.h>
12 #include <linux/module.h>
13 #include <linux/kernel.h>
14 #include <linux/spi/spi.h>
15 #include <linux/i2c.h>
16 #include <linux/slab.h>
17 #include <linux/sysfs.h>
18 #include <linux/regulator/consumer.h>
19 #include <asm/unaligned.h>
21 #include <linux/iio/iio.h>
22 #include <linux/iio/sysfs.h>
24 #define AD5064_MAX_DAC_CHANNELS 8
25 #define AD5064_MAX_VREFS 4
27 #define AD5064_ADDR(x) ((x) << 20)
28 #define AD5064_CMD(x) ((x) << 24)
30 #define AD5064_ADDR_ALL_DAC 0xF
32 #define AD5064_CMD_WRITE_INPUT_N 0x0
33 #define AD5064_CMD_UPDATE_DAC_N 0x1
34 #define AD5064_CMD_WRITE_INPUT_N_UPDATE_ALL 0x2
35 #define AD5064_CMD_WRITE_INPUT_N_UPDATE_N 0x3
36 #define AD5064_CMD_POWERDOWN_DAC 0x4
37 #define AD5064_CMD_CLEAR 0x5
38 #define AD5064_CMD_LDAC_MASK 0x6
39 #define AD5064_CMD_RESET 0x7
40 #define AD5064_CMD_CONFIG 0x8
42 #define AD5064_CONFIG_DAISY_CHAIN_ENABLE BIT(1)
43 #define AD5064_CONFIG_INT_VREF_ENABLE BIT(0)
45 #define AD5064_LDAC_PWRDN_NONE 0x0
46 #define AD5064_LDAC_PWRDN_1K 0x1
47 #define AD5064_LDAC_PWRDN_100K 0x2
48 #define AD5064_LDAC_PWRDN_3STATE 0x3
51 * struct ad5064_chip_info - chip specific information
52 * @shared_vref: whether the vref supply is shared between channels
53 * @internal_vref: internal reference voltage. 0 if the chip has no internal
55 * @channel: channel specification
56 * @num_channels: number of channels
59 struct ad5064_chip_info {
61 unsigned long internal_vref;
62 const struct iio_chan_spec *channels;
63 unsigned int num_channels;
68 typedef int (*ad5064_write_func)(struct ad5064_state *st, unsigned int cmd,
69 unsigned int addr, unsigned int val);
72 * struct ad5064_state - driver instance specific data
73 * @dev: the device for this driver instance
74 * @chip_info: chip model specific constants, available modes etc
75 * @vref_reg: vref supply regulators
76 * @pwr_down: whether channel is powered down
77 * @pwr_down_mode: channel's current power down mode
78 * @dac_cache: current DAC raw value (chip does not support readback)
79 * @use_internal_vref: set to true if the internal reference voltage should be
81 * @write: register write callback
82 * @data: i2c/spi transfer buffers
87 const struct ad5064_chip_info *chip_info;
88 struct regulator_bulk_data vref_reg[AD5064_MAX_VREFS];
89 bool pwr_down[AD5064_MAX_DAC_CHANNELS];
90 u8 pwr_down_mode[AD5064_MAX_DAC_CHANNELS];
91 unsigned int dac_cache[AD5064_MAX_DAC_CHANNELS];
92 bool use_internal_vref;
94 ad5064_write_func write;
97 * DMA (thus cache coherency maintenance) requires the
98 * transfer buffers to live in their own cache lines.
103 } data ____cacheline_aligned;
124 static int ad5064_write(struct ad5064_state *st, unsigned int cmd,
125 unsigned int addr, unsigned int val, unsigned int shift)
129 return st->write(st, cmd, addr, val);
132 static int ad5064_sync_powerdown_mode(struct ad5064_state *st,
133 const struct iio_chan_spec *chan)
138 val = (0x1 << chan->address);
140 if (st->pwr_down[chan->channel])
141 val |= st->pwr_down_mode[chan->channel] << 8;
143 ret = ad5064_write(st, AD5064_CMD_POWERDOWN_DAC, 0, val, 0);
148 static const char * const ad5064_powerdown_modes[] = {
154 static int ad5064_get_powerdown_mode(struct iio_dev *indio_dev,
155 const struct iio_chan_spec *chan)
157 struct ad5064_state *st = iio_priv(indio_dev);
159 return st->pwr_down_mode[chan->channel] - 1;
162 static int ad5064_set_powerdown_mode(struct iio_dev *indio_dev,
163 const struct iio_chan_spec *chan, unsigned int mode)
165 struct ad5064_state *st = iio_priv(indio_dev);
168 mutex_lock(&indio_dev->mlock);
169 st->pwr_down_mode[chan->channel] = mode + 1;
171 ret = ad5064_sync_powerdown_mode(st, chan);
172 mutex_unlock(&indio_dev->mlock);
177 static const struct iio_enum ad5064_powerdown_mode_enum = {
178 .items = ad5064_powerdown_modes,
179 .num_items = ARRAY_SIZE(ad5064_powerdown_modes),
180 .get = ad5064_get_powerdown_mode,
181 .set = ad5064_set_powerdown_mode,
184 static ssize_t ad5064_read_dac_powerdown(struct iio_dev *indio_dev,
185 uintptr_t private, const struct iio_chan_spec *chan, char *buf)
187 struct ad5064_state *st = iio_priv(indio_dev);
189 return sprintf(buf, "%d\n", st->pwr_down[chan->channel]);
192 static ssize_t ad5064_write_dac_powerdown(struct iio_dev *indio_dev,
193 uintptr_t private, const struct iio_chan_spec *chan, const char *buf,
196 struct ad5064_state *st = iio_priv(indio_dev);
200 ret = strtobool(buf, &pwr_down);
204 mutex_lock(&indio_dev->mlock);
205 st->pwr_down[chan->channel] = pwr_down;
207 ret = ad5064_sync_powerdown_mode(st, chan);
208 mutex_unlock(&indio_dev->mlock);
209 return ret ? ret : len;
212 static int ad5064_get_vref(struct ad5064_state *st,
213 struct iio_chan_spec const *chan)
217 if (st->use_internal_vref)
218 return st->chip_info->internal_vref;
220 i = st->chip_info->shared_vref ? 0 : chan->channel;
221 return regulator_get_voltage(st->vref_reg[i].consumer);
224 static int ad5064_read_raw(struct iio_dev *indio_dev,
225 struct iio_chan_spec const *chan,
230 struct ad5064_state *st = iio_priv(indio_dev);
234 case IIO_CHAN_INFO_RAW:
235 *val = st->dac_cache[chan->channel];
237 case IIO_CHAN_INFO_SCALE:
238 scale_uv = ad5064_get_vref(st, chan);
242 *val = scale_uv / 1000;
243 *val2 = chan->scan_type.realbits;
244 return IIO_VAL_FRACTIONAL_LOG2;
251 static int ad5064_write_raw(struct iio_dev *indio_dev,
252 struct iio_chan_spec const *chan, int val, int val2, long mask)
254 struct ad5064_state *st = iio_priv(indio_dev);
258 case IIO_CHAN_INFO_RAW:
259 if (val >= (1 << chan->scan_type.realbits) || val < 0)
262 mutex_lock(&indio_dev->mlock);
263 ret = ad5064_write(st, AD5064_CMD_WRITE_INPUT_N_UPDATE_N,
264 chan->address, val, chan->scan_type.shift);
266 st->dac_cache[chan->channel] = val;
267 mutex_unlock(&indio_dev->mlock);
276 static const struct iio_info ad5064_info = {
277 .read_raw = ad5064_read_raw,
278 .write_raw = ad5064_write_raw,
279 .driver_module = THIS_MODULE,
282 static const struct iio_chan_spec_ext_info ad5064_ext_info[] = {
285 .read = ad5064_read_dac_powerdown,
286 .write = ad5064_write_dac_powerdown,
287 .shared = IIO_SEPARATE,
289 IIO_ENUM("powerdown_mode", IIO_SEPARATE, &ad5064_powerdown_mode_enum),
290 IIO_ENUM_AVAILABLE("powerdown_mode", &ad5064_powerdown_mode_enum),
294 #define AD5064_CHANNEL(chan, addr, bits) { \
295 .type = IIO_VOLTAGE, \
299 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) | \
300 BIT(IIO_CHAN_INFO_SCALE), \
304 .realbits = (bits), \
306 .shift = 20 - bits, \
308 .ext_info = ad5064_ext_info, \
311 #define DECLARE_AD5064_CHANNELS(name, bits) \
312 const struct iio_chan_spec name[] = { \
313 AD5064_CHANNEL(0, 0, bits), \
314 AD5064_CHANNEL(1, 1, bits), \
315 AD5064_CHANNEL(2, 2, bits), \
316 AD5064_CHANNEL(3, 3, bits), \
317 AD5064_CHANNEL(4, 4, bits), \
318 AD5064_CHANNEL(5, 5, bits), \
319 AD5064_CHANNEL(6, 6, bits), \
320 AD5064_CHANNEL(7, 7, bits), \
323 #define DECLARE_AD5065_CHANNELS(name, bits) \
324 const struct iio_chan_spec name[] = { \
325 AD5064_CHANNEL(0, 0, bits), \
326 AD5064_CHANNEL(1, 3, bits), \
329 static DECLARE_AD5064_CHANNELS(ad5024_channels, 12);
330 static DECLARE_AD5064_CHANNELS(ad5044_channels, 14);
331 static DECLARE_AD5064_CHANNELS(ad5064_channels, 16);
333 static DECLARE_AD5065_CHANNELS(ad5025_channels, 12);
334 static DECLARE_AD5065_CHANNELS(ad5045_channels, 14);
335 static DECLARE_AD5065_CHANNELS(ad5065_channels, 16);
337 static const struct ad5064_chip_info ad5064_chip_info_tbl[] = {
339 .shared_vref = false,
340 .channels = ad5024_channels,
344 .shared_vref = false,
345 .channels = ad5025_channels,
349 .shared_vref = false,
350 .channels = ad5044_channels,
354 .shared_vref = false,
355 .channels = ad5045_channels,
359 .shared_vref = false,
360 .channels = ad5064_channels,
365 .channels = ad5064_channels,
369 .shared_vref = false,
370 .channels = ad5065_channels,
375 .internal_vref = 2500000,
376 .channels = ad5024_channels,
381 .internal_vref = 5000000,
382 .channels = ad5024_channels,
387 .internal_vref = 2500000,
388 .channels = ad5044_channels,
393 .internal_vref = 5000000,
394 .channels = ad5044_channels,
399 .internal_vref = 2500000,
400 .channels = ad5064_channels,
405 .internal_vref = 5000000,
406 .channels = ad5064_channels,
411 .internal_vref = 2500000,
412 .channels = ad5064_channels,
417 .internal_vref = 5000000,
418 .channels = ad5064_channels,
423 static inline unsigned int ad5064_num_vref(struct ad5064_state *st)
425 return st->chip_info->shared_vref ? 1 : st->chip_info->num_channels;
428 static const char * const ad5064_vref_names[] = {
435 static const char * const ad5064_vref_name(struct ad5064_state *st,
438 return st->chip_info->shared_vref ? "vref" : ad5064_vref_names[vref];
441 static int ad5064_probe(struct device *dev, enum ad5064_type type,
442 const char *name, ad5064_write_func write)
444 struct iio_dev *indio_dev;
445 struct ad5064_state *st;
446 unsigned int midscale;
450 indio_dev = devm_iio_device_alloc(dev, sizeof(*st));
451 if (indio_dev == NULL)
454 st = iio_priv(indio_dev);
455 dev_set_drvdata(dev, indio_dev);
457 st->chip_info = &ad5064_chip_info_tbl[type];
461 for (i = 0; i < ad5064_num_vref(st); ++i)
462 st->vref_reg[i].supply = ad5064_vref_name(st, i);
464 ret = devm_regulator_bulk_get(dev, ad5064_num_vref(st),
467 if (!st->chip_info->internal_vref)
469 st->use_internal_vref = true;
470 ret = ad5064_write(st, AD5064_CMD_CONFIG, 0,
471 AD5064_CONFIG_INT_VREF_ENABLE, 0);
473 dev_err(dev, "Failed to enable internal vref: %d\n",
478 ret = regulator_bulk_enable(ad5064_num_vref(st), st->vref_reg);
483 indio_dev->dev.parent = dev;
484 indio_dev->name = name;
485 indio_dev->info = &ad5064_info;
486 indio_dev->modes = INDIO_DIRECT_MODE;
487 indio_dev->channels = st->chip_info->channels;
488 indio_dev->num_channels = st->chip_info->num_channels;
490 midscale = (1 << indio_dev->channels[0].scan_type.realbits) / 2;
492 for (i = 0; i < st->chip_info->num_channels; ++i) {
493 st->pwr_down_mode[i] = AD5064_LDAC_PWRDN_1K;
494 st->dac_cache[i] = midscale;
497 ret = iio_device_register(indio_dev);
499 goto error_disable_reg;
504 if (!st->use_internal_vref)
505 regulator_bulk_disable(ad5064_num_vref(st), st->vref_reg);
510 static int ad5064_remove(struct device *dev)
512 struct iio_dev *indio_dev = dev_get_drvdata(dev);
513 struct ad5064_state *st = iio_priv(indio_dev);
515 iio_device_unregister(indio_dev);
517 if (!st->use_internal_vref)
518 regulator_bulk_disable(ad5064_num_vref(st), st->vref_reg);
523 #if IS_ENABLED(CONFIG_SPI_MASTER)
525 static int ad5064_spi_write(struct ad5064_state *st, unsigned int cmd,
526 unsigned int addr, unsigned int val)
528 struct spi_device *spi = to_spi_device(st->dev);
530 st->data.spi = cpu_to_be32(AD5064_CMD(cmd) | AD5064_ADDR(addr) | val);
531 return spi_write(spi, &st->data.spi, sizeof(st->data.spi));
534 static int ad5064_spi_probe(struct spi_device *spi)
536 const struct spi_device_id *id = spi_get_device_id(spi);
538 return ad5064_probe(&spi->dev, id->driver_data, id->name,
542 static int ad5064_spi_remove(struct spi_device *spi)
544 return ad5064_remove(&spi->dev);
547 static const struct spi_device_id ad5064_spi_ids[] = {
548 {"ad5024", ID_AD5024},
549 {"ad5025", ID_AD5025},
550 {"ad5044", ID_AD5044},
551 {"ad5045", ID_AD5045},
552 {"ad5064", ID_AD5064},
553 {"ad5064-1", ID_AD5064_1},
554 {"ad5065", ID_AD5065},
555 {"ad5628-1", ID_AD5628_1},
556 {"ad5628-2", ID_AD5628_2},
557 {"ad5648-1", ID_AD5648_1},
558 {"ad5648-2", ID_AD5648_2},
559 {"ad5666-1", ID_AD5666_1},
560 {"ad5666-2", ID_AD5666_2},
561 {"ad5668-1", ID_AD5668_1},
562 {"ad5668-2", ID_AD5668_2},
563 {"ad5668-3", ID_AD5668_2}, /* similar enough to ad5668-2 */
566 MODULE_DEVICE_TABLE(spi, ad5064_spi_ids);
568 static struct spi_driver ad5064_spi_driver = {
571 .owner = THIS_MODULE,
573 .probe = ad5064_spi_probe,
574 .remove = ad5064_spi_remove,
575 .id_table = ad5064_spi_ids,
578 static int __init ad5064_spi_register_driver(void)
580 return spi_register_driver(&ad5064_spi_driver);
583 static void ad5064_spi_unregister_driver(void)
585 spi_unregister_driver(&ad5064_spi_driver);
590 static inline int ad5064_spi_register_driver(void) { return 0; }
591 static inline void ad5064_spi_unregister_driver(void) { }
595 #if IS_ENABLED(CONFIG_I2C)
597 static int ad5064_i2c_write(struct ad5064_state *st, unsigned int cmd,
598 unsigned int addr, unsigned int val)
600 struct i2c_client *i2c = to_i2c_client(st->dev);
602 st->data.i2c[0] = (cmd << 4) | addr;
603 put_unaligned_be16(val, &st->data.i2c[1]);
604 return i2c_master_send(i2c, st->data.i2c, 3);
607 static int ad5064_i2c_probe(struct i2c_client *i2c,
608 const struct i2c_device_id *id)
610 return ad5064_probe(&i2c->dev, id->driver_data, id->name,
614 static int ad5064_i2c_remove(struct i2c_client *i2c)
616 return ad5064_remove(&i2c->dev);
619 static const struct i2c_device_id ad5064_i2c_ids[] = {
620 {"ad5629-1", ID_AD5628_1},
621 {"ad5629-2", ID_AD5628_2},
622 {"ad5629-3", ID_AD5628_2}, /* similar enough to ad5629-2 */
623 {"ad5669-1", ID_AD5668_1},
624 {"ad5669-2", ID_AD5668_2},
625 {"ad5669-3", ID_AD5668_2}, /* similar enough to ad5669-2 */
628 MODULE_DEVICE_TABLE(i2c, ad5064_i2c_ids);
630 static struct i2c_driver ad5064_i2c_driver = {
633 .owner = THIS_MODULE,
635 .probe = ad5064_i2c_probe,
636 .remove = ad5064_i2c_remove,
637 .id_table = ad5064_i2c_ids,
640 static int __init ad5064_i2c_register_driver(void)
642 return i2c_add_driver(&ad5064_i2c_driver);
645 static void __exit ad5064_i2c_unregister_driver(void)
647 i2c_del_driver(&ad5064_i2c_driver);
652 static inline int ad5064_i2c_register_driver(void) { return 0; }
653 static inline void ad5064_i2c_unregister_driver(void) { }
657 static int __init ad5064_init(void)
661 ret = ad5064_spi_register_driver();
665 ret = ad5064_i2c_register_driver();
667 ad5064_spi_unregister_driver();
673 module_init(ad5064_init);
675 static void __exit ad5064_exit(void)
677 ad5064_i2c_unregister_driver();
678 ad5064_spi_unregister_driver();
680 module_exit(ad5064_exit);
682 MODULE_AUTHOR("Lars-Peter Clausen <lars@metafoo.de>");
683 MODULE_DESCRIPTION("Analog Devices AD5024 and similar multi-channel DACs");
684 MODULE_LICENSE("GPL v2");