1 // SPDX-License-Identifier: GPL-2.0-only
3 * Analog devices AD5764, AD5764R, AD5744, AD5744R quad-channel
4 * Digital to Analog Converters driver
6 * Copyright 2011 Analog Devices Inc.
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/regulator/consumer.h>
18 #include <linux/iio/iio.h>
19 #include <linux/iio/sysfs.h>
21 #define AD5764_REG_SF_NOP 0x0
22 #define AD5764_REG_SF_CONFIG 0x1
23 #define AD5764_REG_SF_CLEAR 0x4
24 #define AD5764_REG_SF_LOAD 0x5
25 #define AD5764_REG_DATA(x) ((2 << 3) | (x))
26 #define AD5764_REG_COARSE_GAIN(x) ((3 << 3) | (x))
27 #define AD5764_REG_FINE_GAIN(x) ((4 << 3) | (x))
28 #define AD5764_REG_OFFSET(x) ((5 << 3) | (x))
30 #define AD5764_NUM_CHANNELS 4
33 * struct ad5764_chip_info - chip specific information
34 * @int_vref: Value of the internal reference voltage in uV - 0 if external
35 * reference voltage is used
36 * @channel channel specification
39 struct ad5764_chip_info {
40 unsigned long int_vref;
41 const struct iio_chan_spec *channels;
45 * struct ad5764_state - driver instance specific data
47 * @chip_info: chip info
48 * @vref_reg: vref supply regulators
49 * @lock lock to protect the data buffer during SPI ops
50 * @data: spi transfer buffers
54 struct spi_device *spi;
55 const struct ad5764_chip_info *chip_info;
56 struct regulator_bulk_data vref_reg[2];
60 * DMA (thus cache coherency maintenance) requires the
61 * transfer buffers to live in their own cache lines.
66 } data[2] ____cacheline_aligned;
76 #define AD5764_CHANNEL(_chan, _bits) { \
77 .type = IIO_VOLTAGE, \
82 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) | \
83 BIT(IIO_CHAN_INFO_SCALE) | \
84 BIT(IIO_CHAN_INFO_CALIBSCALE) | \
85 BIT(IIO_CHAN_INFO_CALIBBIAS), \
86 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET), \
89 .realbits = (_bits), \
91 .shift = 16 - (_bits), \
95 #define DECLARE_AD5764_CHANNELS(_name, _bits) \
96 const struct iio_chan_spec _name##_channels[] = { \
97 AD5764_CHANNEL(0, (_bits)), \
98 AD5764_CHANNEL(1, (_bits)), \
99 AD5764_CHANNEL(2, (_bits)), \
100 AD5764_CHANNEL(3, (_bits)), \
103 static DECLARE_AD5764_CHANNELS(ad5764, 16);
104 static DECLARE_AD5764_CHANNELS(ad5744, 14);
106 static const struct ad5764_chip_info ad5764_chip_infos[] = {
109 .channels = ad5744_channels,
113 .channels = ad5744_channels,
117 .channels = ad5764_channels,
121 .channels = ad5764_channels,
125 static int ad5764_write(struct iio_dev *indio_dev, unsigned int reg,
128 struct ad5764_state *st = iio_priv(indio_dev);
131 mutex_lock(&st->lock);
132 st->data[0].d32 = cpu_to_be32((reg << 16) | val);
134 ret = spi_write(st->spi, &st->data[0].d8[1], 3);
135 mutex_unlock(&st->lock);
140 static int ad5764_read(struct iio_dev *indio_dev, unsigned int reg,
143 struct ad5764_state *st = iio_priv(indio_dev);
145 struct spi_transfer t[] = {
147 .tx_buf = &st->data[0].d8[1],
151 .rx_buf = &st->data[1].d8[1],
156 mutex_lock(&st->lock);
158 st->data[0].d32 = cpu_to_be32((1 << 23) | (reg << 16));
160 ret = spi_sync_transfer(st->spi, t, ARRAY_SIZE(t));
162 *val = be32_to_cpu(st->data[1].d32) & 0xffff;
164 mutex_unlock(&st->lock);
169 static int ad5764_chan_info_to_reg(struct iio_chan_spec const *chan, long info)
172 case IIO_CHAN_INFO_RAW:
173 return AD5764_REG_DATA(chan->address);
174 case IIO_CHAN_INFO_CALIBBIAS:
175 return AD5764_REG_OFFSET(chan->address);
176 case IIO_CHAN_INFO_CALIBSCALE:
177 return AD5764_REG_FINE_GAIN(chan->address);
185 static int ad5764_write_raw(struct iio_dev *indio_dev,
186 struct iio_chan_spec const *chan, int val, int val2, long info)
188 const int max_val = (1 << chan->scan_type.realbits);
192 case IIO_CHAN_INFO_RAW:
193 if (val >= max_val || val < 0)
195 val <<= chan->scan_type.shift;
197 case IIO_CHAN_INFO_CALIBBIAS:
198 if (val >= 128 || val < -128)
201 case IIO_CHAN_INFO_CALIBSCALE:
202 if (val >= 32 || val < -32)
209 reg = ad5764_chan_info_to_reg(chan, info);
210 return ad5764_write(indio_dev, reg, (u16)val);
213 static int ad5764_get_channel_vref(struct ad5764_state *st,
214 unsigned int channel)
216 if (st->chip_info->int_vref)
217 return st->chip_info->int_vref;
219 return regulator_get_voltage(st->vref_reg[channel / 2].consumer);
222 static int ad5764_read_raw(struct iio_dev *indio_dev,
223 struct iio_chan_spec const *chan, int *val, int *val2, long info)
225 struct ad5764_state *st = iio_priv(indio_dev);
231 case IIO_CHAN_INFO_RAW:
232 reg = AD5764_REG_DATA(chan->address);
233 ret = ad5764_read(indio_dev, reg, val);
236 *val >>= chan->scan_type.shift;
238 case IIO_CHAN_INFO_CALIBBIAS:
239 reg = AD5764_REG_OFFSET(chan->address);
240 ret = ad5764_read(indio_dev, reg, val);
243 *val = sign_extend32(*val, 7);
245 case IIO_CHAN_INFO_CALIBSCALE:
246 reg = AD5764_REG_FINE_GAIN(chan->address);
247 ret = ad5764_read(indio_dev, reg, val);
250 *val = sign_extend32(*val, 5);
252 case IIO_CHAN_INFO_SCALE:
253 /* vout = 4 * vref + ((dac_code / 65536) - 0.5) */
254 vref = ad5764_get_channel_vref(st, chan->channel);
258 *val = vref * 4 / 1000;
259 *val2 = chan->scan_type.realbits;
260 return IIO_VAL_FRACTIONAL_LOG2;
261 case IIO_CHAN_INFO_OFFSET:
262 *val = -(1 << chan->scan_type.realbits) / 2;
269 static const struct iio_info ad5764_info = {
270 .read_raw = ad5764_read_raw,
271 .write_raw = ad5764_write_raw,
274 static int ad5764_probe(struct spi_device *spi)
276 enum ad5764_type type = spi_get_device_id(spi)->driver_data;
277 struct iio_dev *indio_dev;
278 struct ad5764_state *st;
281 indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*st));
282 if (indio_dev == NULL) {
283 dev_err(&spi->dev, "Failed to allocate iio device\n");
287 st = iio_priv(indio_dev);
288 spi_set_drvdata(spi, indio_dev);
291 st->chip_info = &ad5764_chip_infos[type];
293 indio_dev->dev.parent = &spi->dev;
294 indio_dev->name = spi_get_device_id(spi)->name;
295 indio_dev->info = &ad5764_info;
296 indio_dev->modes = INDIO_DIRECT_MODE;
297 indio_dev->num_channels = AD5764_NUM_CHANNELS;
298 indio_dev->channels = st->chip_info->channels;
300 mutex_init(&st->lock);
302 if (st->chip_info->int_vref == 0) {
303 st->vref_reg[0].supply = "vrefAB";
304 st->vref_reg[1].supply = "vrefCD";
306 ret = devm_regulator_bulk_get(&st->spi->dev,
307 ARRAY_SIZE(st->vref_reg), st->vref_reg);
309 dev_err(&spi->dev, "Failed to request vref regulators: %d\n",
314 ret = regulator_bulk_enable(ARRAY_SIZE(st->vref_reg),
317 dev_err(&spi->dev, "Failed to enable vref regulators: %d\n",
323 ret = iio_device_register(indio_dev);
325 dev_err(&spi->dev, "Failed to register iio device: %d\n", ret);
326 goto error_disable_reg;
332 if (st->chip_info->int_vref == 0)
333 regulator_bulk_disable(ARRAY_SIZE(st->vref_reg), st->vref_reg);
337 static int ad5764_remove(struct spi_device *spi)
339 struct iio_dev *indio_dev = spi_get_drvdata(spi);
340 struct ad5764_state *st = iio_priv(indio_dev);
342 iio_device_unregister(indio_dev);
344 if (st->chip_info->int_vref == 0)
345 regulator_bulk_disable(ARRAY_SIZE(st->vref_reg), st->vref_reg);
350 static const struct spi_device_id ad5764_ids[] = {
351 { "ad5744", ID_AD5744 },
352 { "ad5744r", ID_AD5744R },
353 { "ad5764", ID_AD5764 },
354 { "ad5764r", ID_AD5764R },
357 MODULE_DEVICE_TABLE(spi, ad5764_ids);
359 static struct spi_driver ad5764_driver = {
363 .probe = ad5764_probe,
364 .remove = ad5764_remove,
365 .id_table = ad5764_ids,
367 module_spi_driver(ad5764_driver);
369 MODULE_AUTHOR("Lars-Peter Clausen <lars@metafoo.de>");
370 MODULE_DESCRIPTION("Analog Devices AD5744/AD5744R/AD5764/AD5764R DAC");
371 MODULE_LICENSE("GPL v2");