blob: 9a547bbf7d2bcc33f2cee3ed53e41ff4610aa1fe [file] [log] [blame]
Lars-Peter Clausen68b14d72011-12-05 17:05:41 +01001/*
2 * Analog devices AD5764, AD5764R, AD5744, AD5744R quad-channel
3 * Digital to Analog Converters driver
4 *
5 * Copyright 2011 Analog Devices Inc.
6 *
7 * Licensed under the GPL-2.
8 */
9
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/slab.h>
16#include <linux/sysfs.h>
17#include <linux/regulator/consumer.h>
18
Jonathan Cameron06458e22012-04-25 15:54:58 +010019#include <linux/iio/iio.h>
20#include <linux/iio/sysfs.h>
Lars-Peter Clausen68b14d72011-12-05 17:05:41 +010021
22#define AD5764_REG_SF_NOP 0x0
23#define AD5764_REG_SF_CONFIG 0x1
24#define AD5764_REG_SF_CLEAR 0x4
25#define AD5764_REG_SF_LOAD 0x5
26#define AD5764_REG_DATA(x) ((2 << 3) | (x))
27#define AD5764_REG_COARSE_GAIN(x) ((3 << 3) | (x))
28#define AD5764_REG_FINE_GAIN(x) ((4 << 3) | (x))
29#define AD5764_REG_OFFSET(x) ((5 << 3) | (x))
30
31#define AD5764_NUM_CHANNELS 4
32
33/**
34 * struct ad5764_chip_info - chip specific information
35 * @int_vref: Value of the internal reference voltage in uV - 0 if external
36 * reference voltage is used
37 * @channel channel specification
38*/
39
40struct ad5764_chip_info {
41 unsigned long int_vref;
42 const struct iio_chan_spec *channels;
43};
44
45/**
46 * struct ad5764_state - driver instance specific data
47 * @spi: spi_device
48 * @chip_info: chip info
49 * @vref_reg: vref supply regulators
50 * @data: spi transfer buffers
51 */
52
53struct ad5764_state {
54 struct spi_device *spi;
55 const struct ad5764_chip_info *chip_info;
56 struct regulator_bulk_data vref_reg[2];
57
58 /*
59 * DMA (thus cache coherency maintenance) requires the
60 * transfer buffers to live in their own cache lines.
61 */
62 union {
63 __be32 d32;
64 u8 d8[4];
65 } data[2] ____cacheline_aligned;
66};
67
68enum ad5764_type {
69 ID_AD5744,
70 ID_AD5744R,
71 ID_AD5764,
72 ID_AD5764R,
73};
74
75#define AD5764_CHANNEL(_chan, _bits) { \
76 .type = IIO_VOLTAGE, \
77 .indexed = 1, \
78 .output = 1, \
79 .channel = (_chan), \
80 .address = (_chan), \
Jonathan Cameronf4d9df12013-02-27 19:28:00 +000081 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) | \
82 BIT(IIO_CHAN_INFO_SCALE) | \
83 BIT(IIO_CHAN_INFO_CALIBSCALE) | \
84 BIT(IIO_CHAN_INFO_CALIBBIAS), \
85 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_OFFSET), \
Jonathan Cameron560101d2013-12-11 18:45:00 +000086 .scan_type = { \
87 .sign = 'u', \
88 .realbits = (_bits), \
89 .storagebits = 16, \
90 .shift = 16 - (_bits), \
91 }, \
Lars-Peter Clausen68b14d72011-12-05 17:05:41 +010092}
93
94#define DECLARE_AD5764_CHANNELS(_name, _bits) \
95const struct iio_chan_spec _name##_channels[] = { \
96 AD5764_CHANNEL(0, (_bits)), \
97 AD5764_CHANNEL(1, (_bits)), \
98 AD5764_CHANNEL(2, (_bits)), \
99 AD5764_CHANNEL(3, (_bits)), \
100};
101
102static DECLARE_AD5764_CHANNELS(ad5764, 16);
103static DECLARE_AD5764_CHANNELS(ad5744, 14);
104
105static const struct ad5764_chip_info ad5764_chip_infos[] = {
106 [ID_AD5744] = {
107 .int_vref = 0,
108 .channels = ad5744_channels,
109 },
110 [ID_AD5744R] = {
111 .int_vref = 5000000,
112 .channels = ad5744_channels,
113 },
114 [ID_AD5764] = {
115 .int_vref = 0,
116 .channels = ad5764_channels,
117 },
118 [ID_AD5764R] = {
119 .int_vref = 5000000,
120 .channels = ad5764_channels,
121 },
122};
123
124static int ad5764_write(struct iio_dev *indio_dev, unsigned int reg,
125 unsigned int val)
126{
127 struct ad5764_state *st = iio_priv(indio_dev);
128 int ret;
129
130 mutex_lock(&indio_dev->mlock);
131 st->data[0].d32 = cpu_to_be32((reg << 16) | val);
132
133 ret = spi_write(st->spi, &st->data[0].d8[1], 3);
134 mutex_unlock(&indio_dev->mlock);
135
136 return ret;
137}
138
139static int ad5764_read(struct iio_dev *indio_dev, unsigned int reg,
140 unsigned int *val)
141{
142 struct ad5764_state *st = iio_priv(indio_dev);
Lars-Peter Clausen68b14d72011-12-05 17:05:41 +0100143 int ret;
144 struct spi_transfer t[] = {
145 {
146 .tx_buf = &st->data[0].d8[1],
147 .len = 3,
148 .cs_change = 1,
149 }, {
150 .rx_buf = &st->data[1].d8[1],
151 .len = 3,
152 },
153 };
154
Lars-Peter Clausen68b14d72011-12-05 17:05:41 +0100155 mutex_lock(&indio_dev->mlock);
156
157 st->data[0].d32 = cpu_to_be32((1 << 23) | (reg << 16));
158
Lars-Peter Clausen14543a02013-01-09 17:31:00 +0000159 ret = spi_sync_transfer(st->spi, t, ARRAY_SIZE(t));
Lars-Peter Clausen68b14d72011-12-05 17:05:41 +0100160 if (ret >= 0)
161 *val = be32_to_cpu(st->data[1].d32) & 0xffff;
162
163 mutex_unlock(&indio_dev->mlock);
164
165 return ret;
166}
167
168static int ad5764_chan_info_to_reg(struct iio_chan_spec const *chan, long info)
169{
170 switch (info) {
171 case 0:
172 return AD5764_REG_DATA(chan->address);
173 case IIO_CHAN_INFO_CALIBBIAS:
174 return AD5764_REG_OFFSET(chan->address);
175 case IIO_CHAN_INFO_CALIBSCALE:
176 return AD5764_REG_FINE_GAIN(chan->address);
177 default:
178 break;
179 }
180
181 return 0;
182}
183
184static int ad5764_write_raw(struct iio_dev *indio_dev,
185 struct iio_chan_spec const *chan, int val, int val2, long info)
186{
187 const int max_val = (1 << chan->scan_type.realbits);
188 unsigned int reg;
189
190 switch (info) {
Jonathan Cameron09f4eb42012-04-15 17:41:19 +0100191 case IIO_CHAN_INFO_RAW:
Lars-Peter Clausen68b14d72011-12-05 17:05:41 +0100192 if (val >= max_val || val < 0)
193 return -EINVAL;
194 val <<= chan->scan_type.shift;
195 break;
196 case IIO_CHAN_INFO_CALIBBIAS:
197 if (val >= 128 || val < -128)
198 return -EINVAL;
199 break;
200 case IIO_CHAN_INFO_CALIBSCALE:
201 if (val >= 32 || val < -32)
202 return -EINVAL;
203 break;
204 default:
205 return -EINVAL;
206 }
207
208 reg = ad5764_chan_info_to_reg(chan, info);
209 return ad5764_write(indio_dev, reg, (u16)val);
210}
211
212static int ad5764_get_channel_vref(struct ad5764_state *st,
213 unsigned int channel)
214{
215 if (st->chip_info->int_vref)
216 return st->chip_info->int_vref;
217 else
218 return regulator_get_voltage(st->vref_reg[channel / 2].consumer);
219}
220
221static int ad5764_read_raw(struct iio_dev *indio_dev,
222 struct iio_chan_spec const *chan, int *val, int *val2, long info)
223{
224 struct ad5764_state *st = iio_priv(indio_dev);
Lars-Peter Clausen68b14d72011-12-05 17:05:41 +0100225 unsigned int reg;
226 int vref;
227 int ret;
228
229 switch (info) {
Jonathan Cameron09f4eb42012-04-15 17:41:19 +0100230 case IIO_CHAN_INFO_RAW:
Lars-Peter Clausen68b14d72011-12-05 17:05:41 +0100231 reg = AD5764_REG_DATA(chan->address);
232 ret = ad5764_read(indio_dev, reg, val);
233 if (ret < 0)
234 return ret;
235 *val >>= chan->scan_type.shift;
236 return IIO_VAL_INT;
237 case IIO_CHAN_INFO_CALIBBIAS:
238 reg = AD5764_REG_OFFSET(chan->address);
239 ret = ad5764_read(indio_dev, reg, val);
240 if (ret < 0)
241 return ret;
242 *val = sign_extend32(*val, 7);
243 return IIO_VAL_INT;
244 case IIO_CHAN_INFO_CALIBSCALE:
245 reg = AD5764_REG_FINE_GAIN(chan->address);
246 ret = ad5764_read(indio_dev, reg, val);
247 if (ret < 0)
248 return ret;
249 *val = sign_extend32(*val, 5);
250 return IIO_VAL_INT;
251 case IIO_CHAN_INFO_SCALE:
Lars-Peter Clausen3f83dae2013-09-28 10:31:00 +0100252 /* vout = 4 * vref + ((dac_code / 65536) - 0.5) */
Lars-Peter Clausen68b14d72011-12-05 17:05:41 +0100253 vref = ad5764_get_channel_vref(st, chan->channel);
254 if (vref < 0)
255 return vref;
256
Lars-Peter Clausen3f83dae2013-09-28 10:31:00 +0100257 *val = vref * 4 / 1000;
258 *val2 = chan->scan_type.realbits;
259 return IIO_VAL_FRACTIONAL_LOG2;
Lars-Peter Clausen68b14d72011-12-05 17:05:41 +0100260 case IIO_CHAN_INFO_OFFSET:
261 *val = -(1 << chan->scan_type.realbits) / 2;
262 return IIO_VAL_INT;
263 }
264
265 return -EINVAL;
266}
267
268static const struct iio_info ad5764_info = {
269 .read_raw = ad5764_read_raw,
270 .write_raw = ad5764_write_raw,
271 .driver_module = THIS_MODULE,
272};
273
Greg Kroah-Hartmanfc526922012-12-21 13:21:43 -0800274static int ad5764_probe(struct spi_device *spi)
Lars-Peter Clausen68b14d72011-12-05 17:05:41 +0100275{
276 enum ad5764_type type = spi_get_device_id(spi)->driver_data;
277 struct iio_dev *indio_dev;
278 struct ad5764_state *st;
279 int ret;
280
Sachin Kamat7ff0de32013-08-19 12:38:00 +0100281 indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*st));
Lars-Peter Clausen68b14d72011-12-05 17:05:41 +0100282 if (indio_dev == NULL) {
283 dev_err(&spi->dev, "Failed to allocate iio device\n");
284 return -ENOMEM;
285 }
286
287 st = iio_priv(indio_dev);
288 spi_set_drvdata(spi, indio_dev);
289
290 st->spi = spi;
291 st->chip_info = &ad5764_chip_infos[type];
292
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;
299
300 if (st->chip_info->int_vref == 0) {
301 st->vref_reg[0].supply = "vrefAB";
302 st->vref_reg[1].supply = "vrefCD";
303
Sachin Kamat7ff0de32013-08-19 12:38:00 +0100304 ret = devm_regulator_bulk_get(&st->spi->dev,
Lars-Peter Clausen68b14d72011-12-05 17:05:41 +0100305 ARRAY_SIZE(st->vref_reg), st->vref_reg);
306 if (ret) {
307 dev_err(&spi->dev, "Failed to request vref regulators: %d\n",
308 ret);
Sachin Kamat7ff0de32013-08-19 12:38:00 +0100309 return ret;
Lars-Peter Clausen68b14d72011-12-05 17:05:41 +0100310 }
311
312 ret = regulator_bulk_enable(ARRAY_SIZE(st->vref_reg),
313 st->vref_reg);
314 if (ret) {
315 dev_err(&spi->dev, "Failed to enable vref regulators: %d\n",
316 ret);
Sachin Kamat7ff0de32013-08-19 12:38:00 +0100317 return ret;
Lars-Peter Clausen68b14d72011-12-05 17:05:41 +0100318 }
319 }
320
321 ret = iio_device_register(indio_dev);
322 if (ret) {
323 dev_err(&spi->dev, "Failed to register iio device: %d\n", ret);
324 goto error_disable_reg;
325 }
326
327 return 0;
328
329error_disable_reg:
330 if (st->chip_info->int_vref == 0)
331 regulator_bulk_disable(ARRAY_SIZE(st->vref_reg), st->vref_reg);
Lars-Peter Clausen68b14d72011-12-05 17:05:41 +0100332 return ret;
333}
334
Greg Kroah-Hartmanfc526922012-12-21 13:21:43 -0800335static int ad5764_remove(struct spi_device *spi)
Lars-Peter Clausen68b14d72011-12-05 17:05:41 +0100336{
337 struct iio_dev *indio_dev = spi_get_drvdata(spi);
338 struct ad5764_state *st = iio_priv(indio_dev);
339
340 iio_device_unregister(indio_dev);
341
Sachin Kamat7ff0de32013-08-19 12:38:00 +0100342 if (st->chip_info->int_vref == 0)
Lars-Peter Clausen68b14d72011-12-05 17:05:41 +0100343 regulator_bulk_disable(ARRAY_SIZE(st->vref_reg), st->vref_reg);
Lars-Peter Clausen68b14d72011-12-05 17:05:41 +0100344
345 return 0;
346}
347
348static const struct spi_device_id ad5764_ids[] = {
349 { "ad5744", ID_AD5744 },
350 { "ad5744r", ID_AD5744R },
351 { "ad5764", ID_AD5764 },
352 { "ad5764r", ID_AD5764R },
353 { }
354};
355MODULE_DEVICE_TABLE(spi, ad5764_ids);
356
357static struct spi_driver ad5764_driver = {
358 .driver = {
359 .name = "ad5764",
Lars-Peter Clausen68b14d72011-12-05 17:05:41 +0100360 },
361 .probe = ad5764_probe,
Greg Kroah-Hartmanfc526922012-12-21 13:21:43 -0800362 .remove = ad5764_remove,
Lars-Peter Clausen68b14d72011-12-05 17:05:41 +0100363 .id_table = ad5764_ids,
364};
Lars-Peter Clausen519ff1d2012-02-20 19:42:38 +0100365module_spi_driver(ad5764_driver);
Lars-Peter Clausen68b14d72011-12-05 17:05:41 +0100366
367MODULE_AUTHOR("Lars-Peter Clausen <lars@metafoo.de>");
368MODULE_DESCRIPTION("Analog Devices AD5744/AD5744R/AD5764/AD5764R DAC");
369MODULE_LICENSE("GPL v2");