1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * AD5446 SPI DAC driver
5 * Copyright 2010 Analog Devices Inc.
8 #include <linux/interrupt.h>
9 #include <linux/workqueue.h>
10 #include <linux/device.h>
11 #include <linux/kernel.h>
12 #include <linux/slab.h>
13 #include <linux/sysfs.h>
14 #include <linux/list.h>
15 #include <linux/spi/spi.h>
16 #include <linux/i2c.h>
17 #include <linux/regulator/consumer.h>
18 #include <linux/err.h>
19 #include <linux/module.h>
20 #include <linux/mod_devicetable.h>
22 #include <linux/iio/iio.h>
23 #include <linux/iio/sysfs.h>
25 #include <asm/unaligned.h>
27 #define MODE_PWRDWN_1k 0x1
28 #define MODE_PWRDWN_100k 0x2
29 #define MODE_PWRDWN_TRISTATE 0x3
32 * struct ad5446_state - driver instance specific data
34 * @chip_info: chip model specific constants, available modes etc
35 * @reg: supply regulator
36 * @vref_mv: actual reference voltage used
37 * @cached_val: store/retrieve values during power down
38 * @pwr_down_mode: power down mode (1k, 100k or tristate)
39 * @pwr_down: true if the device is in power down
40 * @lock: lock to protect the data buffer during write ops
45 const struct ad5446_chip_info *chip_info;
46 struct regulator *reg;
47 unsigned short vref_mv;
49 unsigned pwr_down_mode;
55 * struct ad5446_chip_info - chip specific information
56 * @channel: channel spec for the DAC
57 * @int_vref_mv: AD5620/40/60: the internal reference voltage
58 * @write: chip specific helper function to write to the register
61 struct ad5446_chip_info {
62 struct iio_chan_spec channel;
64 int (*write)(struct ad5446_state *st, unsigned val);
67 static const char * const ad5446_powerdown_modes[] = {
68 "1kohm_to_gnd", "100kohm_to_gnd", "three_state"
71 static int ad5446_set_powerdown_mode(struct iio_dev *indio_dev,
72 const struct iio_chan_spec *chan, unsigned int mode)
74 struct ad5446_state *st = iio_priv(indio_dev);
76 st->pwr_down_mode = mode + 1;
81 static int ad5446_get_powerdown_mode(struct iio_dev *indio_dev,
82 const struct iio_chan_spec *chan)
84 struct ad5446_state *st = iio_priv(indio_dev);
86 return st->pwr_down_mode - 1;
89 static const struct iio_enum ad5446_powerdown_mode_enum = {
90 .items = ad5446_powerdown_modes,
91 .num_items = ARRAY_SIZE(ad5446_powerdown_modes),
92 .get = ad5446_get_powerdown_mode,
93 .set = ad5446_set_powerdown_mode,
96 static ssize_t ad5446_read_dac_powerdown(struct iio_dev *indio_dev,
98 const struct iio_chan_spec *chan,
101 struct ad5446_state *st = iio_priv(indio_dev);
103 return sysfs_emit(buf, "%d\n", st->pwr_down);
106 static ssize_t ad5446_write_dac_powerdown(struct iio_dev *indio_dev,
108 const struct iio_chan_spec *chan,
109 const char *buf, size_t len)
111 struct ad5446_state *st = iio_priv(indio_dev);
117 ret = strtobool(buf, &powerdown);
121 mutex_lock(&st->lock);
122 st->pwr_down = powerdown;
125 shift = chan->scan_type.realbits + chan->scan_type.shift;
126 val = st->pwr_down_mode << shift;
128 val = st->cached_val;
131 ret = st->chip_info->write(st, val);
132 mutex_unlock(&st->lock);
134 return ret ? ret : len;
137 static const struct iio_chan_spec_ext_info ad5446_ext_info_powerdown[] = {
140 .read = ad5446_read_dac_powerdown,
141 .write = ad5446_write_dac_powerdown,
142 .shared = IIO_SEPARATE,
144 IIO_ENUM("powerdown_mode", IIO_SEPARATE, &ad5446_powerdown_mode_enum),
145 IIO_ENUM_AVAILABLE("powerdown_mode", IIO_SHARED_BY_TYPE, &ad5446_powerdown_mode_enum),
149 #define _AD5446_CHANNEL(bits, storage, _shift, ext) { \
150 .type = IIO_VOLTAGE, \
154 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), \
155 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE), \
158 .realbits = (bits), \
159 .storagebits = (storage), \
165 #define AD5446_CHANNEL(bits, storage, shift) \
166 _AD5446_CHANNEL(bits, storage, shift, NULL)
168 #define AD5446_CHANNEL_POWERDOWN(bits, storage, shift) \
169 _AD5446_CHANNEL(bits, storage, shift, ad5446_ext_info_powerdown)
171 static int ad5446_read_raw(struct iio_dev *indio_dev,
172 struct iio_chan_spec const *chan,
177 struct ad5446_state *st = iio_priv(indio_dev);
180 case IIO_CHAN_INFO_RAW:
181 *val = st->cached_val;
183 case IIO_CHAN_INFO_SCALE:
185 *val2 = chan->scan_type.realbits;
186 return IIO_VAL_FRACTIONAL_LOG2;
191 static int ad5446_write_raw(struct iio_dev *indio_dev,
192 struct iio_chan_spec const *chan,
197 struct ad5446_state *st = iio_priv(indio_dev);
201 case IIO_CHAN_INFO_RAW:
202 if (val >= (1 << chan->scan_type.realbits) || val < 0)
205 val <<= chan->scan_type.shift;
206 mutex_lock(&st->lock);
207 st->cached_val = val;
209 ret = st->chip_info->write(st, val);
210 mutex_unlock(&st->lock);
219 static const struct iio_info ad5446_info = {
220 .read_raw = ad5446_read_raw,
221 .write_raw = ad5446_write_raw,
224 static int ad5446_probe(struct device *dev, const char *name,
225 const struct ad5446_chip_info *chip_info)
227 struct ad5446_state *st;
228 struct iio_dev *indio_dev;
229 struct regulator *reg;
230 int ret, voltage_uv = 0;
232 reg = devm_regulator_get(dev, "vcc");
234 ret = regulator_enable(reg);
238 ret = regulator_get_voltage(reg);
240 goto error_disable_reg;
245 indio_dev = devm_iio_device_alloc(dev, sizeof(*st));
246 if (indio_dev == NULL) {
248 goto error_disable_reg;
250 st = iio_priv(indio_dev);
251 st->chip_info = chip_info;
253 dev_set_drvdata(dev, indio_dev);
257 indio_dev->name = name;
258 indio_dev->info = &ad5446_info;
259 indio_dev->modes = INDIO_DIRECT_MODE;
260 indio_dev->channels = &st->chip_info->channel;
261 indio_dev->num_channels = 1;
263 mutex_init(&st->lock);
265 st->pwr_down_mode = MODE_PWRDWN_1k;
267 if (st->chip_info->int_vref_mv)
268 st->vref_mv = st->chip_info->int_vref_mv;
270 st->vref_mv = voltage_uv / 1000;
272 dev_warn(dev, "reference voltage unspecified\n");
274 ret = iio_device_register(indio_dev);
276 goto error_disable_reg;
282 regulator_disable(reg);
286 static void ad5446_remove(struct device *dev)
288 struct iio_dev *indio_dev = dev_get_drvdata(dev);
289 struct ad5446_state *st = iio_priv(indio_dev);
291 iio_device_unregister(indio_dev);
292 if (!IS_ERR(st->reg))
293 regulator_disable(st->reg);
296 #if IS_ENABLED(CONFIG_SPI_MASTER)
298 static int ad5446_write(struct ad5446_state *st, unsigned val)
300 struct spi_device *spi = to_spi_device(st->dev);
301 __be16 data = cpu_to_be16(val);
303 return spi_write(spi, &data, sizeof(data));
306 static int ad5660_write(struct ad5446_state *st, unsigned val)
308 struct spi_device *spi = to_spi_device(st->dev);
311 put_unaligned_be24(val, &data[0]);
313 return spi_write(spi, data, sizeof(data));
317 * ad5446_supported_spi_device_ids:
318 * The AD5620/40/60 parts are available in different fixed internal reference
319 * voltage options. The actual part numbers may look differently
320 * (and a bit cryptic), however this style is used to make clear which
321 * parts are supported here.
323 enum ad5446_supported_spi_device_ids {
348 static const struct ad5446_chip_info ad5446_spi_chip_info[] = {
350 .channel = AD5446_CHANNEL_POWERDOWN(8, 16, 4),
351 .write = ad5446_write,
354 .channel = AD5446_CHANNEL_POWERDOWN(10, 16, 2),
355 .write = ad5446_write,
358 .channel = AD5446_CHANNEL_POWERDOWN(12, 16, 0),
359 .write = ad5446_write,
362 .channel = AD5446_CHANNEL(12, 16, 2),
363 .write = ad5446_write,
366 .channel = AD5446_CHANNEL(14, 16, 0),
367 .write = ad5446_write,
370 .channel = AD5446_CHANNEL(8, 16, 6),
371 .write = ad5446_write,
374 .channel = AD5446_CHANNEL(10, 16, 4),
375 .write = ad5446_write,
378 .channel = AD5446_CHANNEL(16, 16, 0),
379 .write = ad5446_write,
382 .channel = AD5446_CHANNEL(12, 16, 4),
383 .write = ad5446_write,
386 .channel = AD5446_CHANNEL(14, 16, 0),
387 .write = ad5446_write,
390 .channel = AD5446_CHANNEL(16, 16, 0),
391 .write = ad5446_write,
394 .channel = AD5446_CHANNEL_POWERDOWN(8, 16, 6),
395 .write = ad5446_write,
398 .channel = AD5446_CHANNEL_POWERDOWN(10, 16, 4),
399 .write = ad5446_write,
402 .channel = AD5446_CHANNEL_POWERDOWN(12, 16, 2),
403 .write = ad5446_write,
406 .channel = AD5446_CHANNEL_POWERDOWN(14, 16, 0),
407 .write = ad5446_write,
410 .channel = AD5446_CHANNEL_POWERDOWN(12, 16, 2),
412 .write = ad5446_write,
415 .channel = AD5446_CHANNEL_POWERDOWN(12, 16, 2),
417 .write = ad5446_write,
420 .channel = AD5446_CHANNEL_POWERDOWN(14, 16, 0),
422 .write = ad5446_write,
425 .channel = AD5446_CHANNEL_POWERDOWN(14, 16, 0),
427 .write = ad5446_write,
430 .channel = AD5446_CHANNEL_POWERDOWN(16, 16, 0),
432 .write = ad5660_write,
435 .channel = AD5446_CHANNEL_POWERDOWN(16, 16, 0),
437 .write = ad5660_write,
440 .channel = AD5446_CHANNEL_POWERDOWN(16, 16, 0),
441 .write = ad5660_write,
445 static const struct spi_device_id ad5446_spi_ids[] = {
446 {"ad5300", ID_AD5300},
447 {"ad5310", ID_AD5310},
448 {"ad5320", ID_AD5320},
449 {"ad5444", ID_AD5444},
450 {"ad5446", ID_AD5446},
451 {"ad5450", ID_AD5450},
452 {"ad5451", ID_AD5451},
453 {"ad5452", ID_AD5444}, /* ad5452 is compatible to the ad5444 */
454 {"ad5453", ID_AD5446}, /* ad5453 is compatible to the ad5446 */
455 {"ad5512a", ID_AD5512A},
456 {"ad5541a", ID_AD5541A},
457 {"ad5542a", ID_AD5541A}, /* ad5541a and ad5542a are compatible */
458 {"ad5543", ID_AD5541A}, /* ad5541a and ad5543 are compatible */
459 {"ad5553", ID_AD5553},
460 {"ad5600", ID_AD5600},
461 {"ad5601", ID_AD5601},
462 {"ad5611", ID_AD5611},
463 {"ad5621", ID_AD5621},
464 {"ad5641", ID_AD5641},
465 {"ad5620-2500", ID_AD5620_2500}, /* AD5620/40/60: */
466 {"ad5620-1250", ID_AD5620_1250}, /* part numbers may look differently */
467 {"ad5640-2500", ID_AD5640_2500},
468 {"ad5640-1250", ID_AD5640_1250},
469 {"ad5660-2500", ID_AD5660_2500},
470 {"ad5660-1250", ID_AD5660_1250},
471 {"ad5662", ID_AD5662},
472 {"dac081s101", ID_AD5300}, /* compatible Texas Instruments chips */
473 {"dac101s101", ID_AD5310},
474 {"dac121s101", ID_AD5320},
475 {"dac7512", ID_AD5320},
478 MODULE_DEVICE_TABLE(spi, ad5446_spi_ids);
480 static const struct of_device_id ad5446_of_ids[] = {
481 { .compatible = "ti,dac7512" },
484 MODULE_DEVICE_TABLE(of, ad5446_of_ids);
486 static int ad5446_spi_probe(struct spi_device *spi)
488 const struct spi_device_id *id = spi_get_device_id(spi);
490 return ad5446_probe(&spi->dev, id->name,
491 &ad5446_spi_chip_info[id->driver_data]);
494 static int ad5446_spi_remove(struct spi_device *spi)
496 ad5446_remove(&spi->dev);
501 static struct spi_driver ad5446_spi_driver = {
504 .of_match_table = ad5446_of_ids,
506 .probe = ad5446_spi_probe,
507 .remove = ad5446_spi_remove,
508 .id_table = ad5446_spi_ids,
511 static int __init ad5446_spi_register_driver(void)
513 return spi_register_driver(&ad5446_spi_driver);
516 static void ad5446_spi_unregister_driver(void)
518 spi_unregister_driver(&ad5446_spi_driver);
523 static inline int ad5446_spi_register_driver(void) { return 0; }
524 static inline void ad5446_spi_unregister_driver(void) { }
528 #if IS_ENABLED(CONFIG_I2C)
530 static int ad5622_write(struct ad5446_state *st, unsigned val)
532 struct i2c_client *client = to_i2c_client(st->dev);
533 __be16 data = cpu_to_be16(val);
536 ret = i2c_master_send(client, (char *)&data, sizeof(data));
539 if (ret != sizeof(data))
546 * ad5446_supported_i2c_device_ids:
547 * The AD5620/40/60 parts are available in different fixed internal reference
548 * voltage options. The actual part numbers may look differently
549 * (and a bit cryptic), however this style is used to make clear which
550 * parts are supported here.
552 enum ad5446_supported_i2c_device_ids {
558 static const struct ad5446_chip_info ad5446_i2c_chip_info[] = {
560 .channel = AD5446_CHANNEL_POWERDOWN(8, 16, 4),
561 .write = ad5622_write,
564 .channel = AD5446_CHANNEL_POWERDOWN(10, 16, 2),
565 .write = ad5622_write,
568 .channel = AD5446_CHANNEL_POWERDOWN(12, 16, 0),
569 .write = ad5622_write,
573 static int ad5446_i2c_probe(struct i2c_client *i2c,
574 const struct i2c_device_id *id)
576 return ad5446_probe(&i2c->dev, id->name,
577 &ad5446_i2c_chip_info[id->driver_data]);
580 static int ad5446_i2c_remove(struct i2c_client *i2c)
582 ad5446_remove(&i2c->dev);
587 static const struct i2c_device_id ad5446_i2c_ids[] = {
588 {"ad5301", ID_AD5602},
589 {"ad5311", ID_AD5612},
590 {"ad5321", ID_AD5622},
591 {"ad5602", ID_AD5602},
592 {"ad5612", ID_AD5612},
593 {"ad5622", ID_AD5622},
596 MODULE_DEVICE_TABLE(i2c, ad5446_i2c_ids);
598 static struct i2c_driver ad5446_i2c_driver = {
602 .probe = ad5446_i2c_probe,
603 .remove = ad5446_i2c_remove,
604 .id_table = ad5446_i2c_ids,
607 static int __init ad5446_i2c_register_driver(void)
609 return i2c_add_driver(&ad5446_i2c_driver);
612 static void __exit ad5446_i2c_unregister_driver(void)
614 i2c_del_driver(&ad5446_i2c_driver);
619 static inline int ad5446_i2c_register_driver(void) { return 0; }
620 static inline void ad5446_i2c_unregister_driver(void) { }
624 static int __init ad5446_init(void)
628 ret = ad5446_spi_register_driver();
632 ret = ad5446_i2c_register_driver();
634 ad5446_spi_unregister_driver();
640 module_init(ad5446_init);
642 static void __exit ad5446_exit(void)
644 ad5446_i2c_unregister_driver();
645 ad5446_spi_unregister_driver();
647 module_exit(ad5446_exit);
649 MODULE_AUTHOR("Michael Hennerich <michael.hennerich@analog.com>");
650 MODULE_DESCRIPTION("Analog Devices AD5444/AD5446 DAC");
651 MODULE_LICENSE("GPL v2");