1
2
3
4
5
6
7
8
9#include <linux/device.h>
10#include <linux/kernel.h>
11#include <linux/slab.h>
12#include <linux/sysfs.h>
13#include <linux/spi/spi.h>
14#include <linux/regulator/consumer.h>
15#include <linux/err.h>
16#include <linux/module.h>
17#include <linux/of.h>
18
19#include <linux/iio/iio.h>
20#include <linux/iio/sysfs.h>
21
22#define ADS8688_CMD_REG(x) (x << 8)
23#define ADS8688_CMD_REG_NOOP 0x00
24#define ADS8688_CMD_REG_RST 0x85
25#define ADS8688_CMD_REG_MAN_CH(chan) (0xC0 | (4 * chan))
26#define ADS8688_CMD_DONT_CARE_BITS 16
27
28#define ADS8688_PROG_REG(x) (x << 9)
29#define ADS8688_PROG_REG_RANGE_CH(chan) (0x05 + chan)
30#define ADS8688_PROG_WR_BIT BIT(8)
31#define ADS8688_PROG_DONT_CARE_BITS 8
32
33#define ADS8688_REG_PLUSMINUS25VREF 0
34#define ADS8688_REG_PLUSMINUS125VREF 1
35#define ADS8688_REG_PLUSMINUS0625VREF 2
36#define ADS8688_REG_PLUS25VREF 5
37#define ADS8688_REG_PLUS125VREF 6
38
39#define ADS8688_VREF_MV 4096
40#define ADS8688_REALBITS 16
41
42
43
44
45
46
47
48
49
50enum ads8688_range {
51 ADS8688_PLUSMINUS25VREF,
52 ADS8688_PLUSMINUS125VREF,
53 ADS8688_PLUSMINUS0625VREF,
54 ADS8688_PLUS25VREF,
55 ADS8688_PLUS125VREF,
56};
57
58struct ads8688_chip_info {
59 const struct iio_chan_spec *channels;
60 unsigned int num_channels;
61};
62
63struct ads8688_state {
64 struct mutex lock;
65 const struct ads8688_chip_info *chip_info;
66 struct spi_device *spi;
67 struct regulator *reg;
68 unsigned int vref_mv;
69 enum ads8688_range range[8];
70 union {
71 __be32 d32;
72 u8 d8[4];
73 } data[2] ____cacheline_aligned;
74};
75
76enum ads8688_id {
77 ID_ADS8684,
78 ID_ADS8688,
79};
80
81struct ads8688_ranges {
82 enum ads8688_range range;
83 unsigned int scale;
84 int offset;
85 u8 reg;
86};
87
88static const struct ads8688_ranges ads8688_range_def[5] = {
89 {
90 .range = ADS8688_PLUSMINUS25VREF,
91 .scale = 76295,
92 .offset = -(1 << (ADS8688_REALBITS - 1)),
93 .reg = ADS8688_REG_PLUSMINUS25VREF,
94 }, {
95 .range = ADS8688_PLUSMINUS125VREF,
96 .scale = 38148,
97 .offset = -(1 << (ADS8688_REALBITS - 1)),
98 .reg = ADS8688_REG_PLUSMINUS125VREF,
99 }, {
100 .range = ADS8688_PLUSMINUS0625VREF,
101 .scale = 19074,
102 .offset = -(1 << (ADS8688_REALBITS - 1)),
103 .reg = ADS8688_REG_PLUSMINUS0625VREF,
104 }, {
105 .range = ADS8688_PLUS25VREF,
106 .scale = 38148,
107 .offset = 0,
108 .reg = ADS8688_REG_PLUS25VREF,
109 }, {
110 .range = ADS8688_PLUS125VREF,
111 .scale = 19074,
112 .offset = 0,
113 .reg = ADS8688_REG_PLUS125VREF,
114 }
115};
116
117static ssize_t ads8688_show_scales(struct device *dev,
118 struct device_attribute *attr, char *buf)
119{
120 struct ads8688_state *st = iio_priv(dev_to_iio_dev(dev));
121
122 return sprintf(buf, "0.%09u 0.%09u 0.%09u\n",
123 ads8688_range_def[0].scale * st->vref_mv,
124 ads8688_range_def[1].scale * st->vref_mv,
125 ads8688_range_def[2].scale * st->vref_mv);
126}
127
128static ssize_t ads8688_show_offsets(struct device *dev,
129 struct device_attribute *attr, char *buf)
130{
131 return sprintf(buf, "%d %d\n", ads8688_range_def[0].offset,
132 ads8688_range_def[3].offset);
133}
134
135static IIO_DEVICE_ATTR(in_voltage_scale_available, S_IRUGO,
136 ads8688_show_scales, NULL, 0);
137static IIO_DEVICE_ATTR(in_voltage_offset_available, S_IRUGO,
138 ads8688_show_offsets, NULL, 0);
139
140static struct attribute *ads8688_attributes[] = {
141 &iio_dev_attr_in_voltage_scale_available.dev_attr.attr,
142 &iio_dev_attr_in_voltage_offset_available.dev_attr.attr,
143 NULL,
144};
145
146static const struct attribute_group ads8688_attribute_group = {
147 .attrs = ads8688_attributes,
148};
149
150#define ADS8688_CHAN(index) \
151{ \
152 .type = IIO_VOLTAGE, \
153 .indexed = 1, \
154 .channel = index, \
155 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) \
156 | BIT(IIO_CHAN_INFO_SCALE) \
157 | BIT(IIO_CHAN_INFO_OFFSET), \
158}
159
160static const struct iio_chan_spec ads8684_channels[] = {
161 ADS8688_CHAN(0),
162 ADS8688_CHAN(1),
163 ADS8688_CHAN(2),
164 ADS8688_CHAN(3),
165};
166
167static const struct iio_chan_spec ads8688_channels[] = {
168 ADS8688_CHAN(0),
169 ADS8688_CHAN(1),
170 ADS8688_CHAN(2),
171 ADS8688_CHAN(3),
172 ADS8688_CHAN(4),
173 ADS8688_CHAN(5),
174 ADS8688_CHAN(6),
175 ADS8688_CHAN(7),
176};
177
178static int ads8688_prog_write(struct iio_dev *indio_dev, unsigned int addr,
179 unsigned int val)
180{
181 struct ads8688_state *st = iio_priv(indio_dev);
182 u32 tmp;
183
184 tmp = ADS8688_PROG_REG(addr) | ADS8688_PROG_WR_BIT | val;
185 tmp <<= ADS8688_PROG_DONT_CARE_BITS;
186 st->data[0].d32 = cpu_to_be32(tmp);
187
188 return spi_write(st->spi, &st->data[0].d8[1], 3);
189}
190
191static int ads8688_reset(struct iio_dev *indio_dev)
192{
193 struct ads8688_state *st = iio_priv(indio_dev);
194 u32 tmp;
195
196 tmp = ADS8688_CMD_REG(ADS8688_CMD_REG_RST);
197 tmp <<= ADS8688_CMD_DONT_CARE_BITS;
198 st->data[0].d32 = cpu_to_be32(tmp);
199
200 return spi_write(st->spi, &st->data[0].d8[0], 4);
201}
202
203static int ads8688_read(struct iio_dev *indio_dev, unsigned int chan)
204{
205 struct ads8688_state *st = iio_priv(indio_dev);
206 int ret;
207 u32 tmp;
208 struct spi_transfer t[] = {
209 {
210 .tx_buf = &st->data[0].d8[0],
211 .len = 4,
212 .cs_change = 1,
213 }, {
214 .tx_buf = &st->data[1].d8[0],
215 .rx_buf = &st->data[1].d8[0],
216 .len = 4,
217 },
218 };
219
220 tmp = ADS8688_CMD_REG(ADS8688_CMD_REG_MAN_CH(chan));
221 tmp <<= ADS8688_CMD_DONT_CARE_BITS;
222 st->data[0].d32 = cpu_to_be32(tmp);
223
224 tmp = ADS8688_CMD_REG(ADS8688_CMD_REG_NOOP);
225 tmp <<= ADS8688_CMD_DONT_CARE_BITS;
226 st->data[1].d32 = cpu_to_be32(tmp);
227
228 ret = spi_sync_transfer(st->spi, t, ARRAY_SIZE(t));
229 if (ret < 0)
230 return ret;
231
232 return be32_to_cpu(st->data[1].d32) & 0xffff;
233}
234
235static int ads8688_read_raw(struct iio_dev *indio_dev,
236 struct iio_chan_spec const *chan,
237 int *val, int *val2, long m)
238{
239 int ret, offset;
240 unsigned long scale_mv;
241
242 struct ads8688_state *st = iio_priv(indio_dev);
243
244 mutex_lock(&st->lock);
245 switch (m) {
246 case IIO_CHAN_INFO_RAW:
247 ret = ads8688_read(indio_dev, chan->channel);
248 mutex_unlock(&st->lock);
249 if (ret < 0)
250 return ret;
251 *val = ret;
252 return IIO_VAL_INT;
253 case IIO_CHAN_INFO_SCALE:
254 scale_mv = st->vref_mv;
255 scale_mv *= ads8688_range_def[st->range[chan->channel]].scale;
256 *val = 0;
257 *val2 = scale_mv;
258 mutex_unlock(&st->lock);
259 return IIO_VAL_INT_PLUS_NANO;
260 case IIO_CHAN_INFO_OFFSET:
261 offset = ads8688_range_def[st->range[chan->channel]].offset;
262 *val = offset;
263 mutex_unlock(&st->lock);
264 return IIO_VAL_INT;
265 }
266 mutex_unlock(&st->lock);
267
268 return -EINVAL;
269}
270
271static int ads8688_write_reg_range(struct iio_dev *indio_dev,
272 struct iio_chan_spec const *chan,
273 enum ads8688_range range)
274{
275 unsigned int tmp;
276 int ret;
277
278 tmp = ADS8688_PROG_REG_RANGE_CH(chan->channel);
279 ret = ads8688_prog_write(indio_dev, tmp, range);
280
281 return ret;
282}
283
284static int ads8688_write_raw(struct iio_dev *indio_dev,
285 struct iio_chan_spec const *chan,
286 int val, int val2, long mask)
287{
288 struct ads8688_state *st = iio_priv(indio_dev);
289 unsigned int scale = 0;
290 int ret = -EINVAL, i, offset = 0;
291
292 mutex_lock(&st->lock);
293 switch (mask) {
294 case IIO_CHAN_INFO_SCALE:
295
296 offset = ads8688_range_def[st->range[chan->channel]].offset;
297 if (offset == 0 && val2 == ads8688_range_def[0].scale * st->vref_mv) {
298 mutex_unlock(&st->lock);
299 return -EINVAL;
300 }
301
302
303 for (i = 0; i < ARRAY_SIZE(ads8688_range_def); i++)
304 if (val2 == ads8688_range_def[i].scale * st->vref_mv &&
305 offset == ads8688_range_def[i].offset) {
306 ret = ads8688_write_reg_range(indio_dev, chan,
307 ads8688_range_def[i].reg);
308 break;
309 }
310 break;
311 case IIO_CHAN_INFO_OFFSET:
312
313
314
315
316 if (!(ads8688_range_def[0].offset == val ||
317 ads8688_range_def[3].offset == val)) {
318 mutex_unlock(&st->lock);
319 return -EINVAL;
320 }
321
322
323
324
325
326 if (val == 0 &&
327 st->range[chan->channel] == ADS8688_PLUSMINUS25VREF) {
328 mutex_unlock(&st->lock);
329 return -EINVAL;
330 }
331
332 scale = ads8688_range_def[st->range[chan->channel]].scale;
333
334
335 for (i = 0; i < ARRAY_SIZE(ads8688_range_def); i++)
336 if (val == ads8688_range_def[i].offset &&
337 scale == ads8688_range_def[i].scale) {
338 ret = ads8688_write_reg_range(indio_dev, chan,
339 ads8688_range_def[i].reg);
340 break;
341 }
342 break;
343 }
344
345 if (!ret)
346 st->range[chan->channel] = ads8688_range_def[i].range;
347
348 mutex_unlock(&st->lock);
349
350 return ret;
351}
352
353static int ads8688_write_raw_get_fmt(struct iio_dev *indio_dev,
354 struct iio_chan_spec const *chan,
355 long mask)
356{
357 switch (mask) {
358 case IIO_CHAN_INFO_SCALE:
359 return IIO_VAL_INT_PLUS_NANO;
360 case IIO_CHAN_INFO_OFFSET:
361 return IIO_VAL_INT;
362 }
363
364 return -EINVAL;
365}
366
367static const struct iio_info ads8688_info = {
368 .read_raw = &ads8688_read_raw,
369 .write_raw = &ads8688_write_raw,
370 .write_raw_get_fmt = &ads8688_write_raw_get_fmt,
371 .attrs = &ads8688_attribute_group,
372 .driver_module = THIS_MODULE,
373};
374
375static const struct ads8688_chip_info ads8688_chip_info_tbl[] = {
376 [ID_ADS8684] = {
377 .channels = ads8684_channels,
378 .num_channels = ARRAY_SIZE(ads8684_channels),
379 },
380 [ID_ADS8688] = {
381 .channels = ads8688_channels,
382 .num_channels = ARRAY_SIZE(ads8688_channels),
383 },
384};
385
386static int ads8688_probe(struct spi_device *spi)
387{
388 struct ads8688_state *st;
389 struct iio_dev *indio_dev;
390 int ret;
391
392 indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*st));
393 if (indio_dev == NULL)
394 return -ENOMEM;
395
396 st = iio_priv(indio_dev);
397
398 st->reg = devm_regulator_get_optional(&spi->dev, "vref");
399 if (!IS_ERR(st->reg)) {
400 ret = regulator_enable(st->reg);
401 if (ret)
402 return ret;
403
404 ret = regulator_get_voltage(st->reg);
405 if (ret < 0)
406 goto error_out;
407
408 st->vref_mv = ret / 1000;
409 } else {
410
411 st->vref_mv = ADS8688_VREF_MV;
412 }
413
414 st->chip_info = &ads8688_chip_info_tbl[spi_get_device_id(spi)->driver_data];
415
416 spi->mode = SPI_MODE_1;
417
418 spi_set_drvdata(spi, indio_dev);
419
420 st->spi = spi;
421
422 indio_dev->name = spi_get_device_id(spi)->name;
423 indio_dev->dev.parent = &spi->dev;
424 indio_dev->dev.of_node = spi->dev.of_node;
425 indio_dev->modes = INDIO_DIRECT_MODE;
426 indio_dev->channels = st->chip_info->channels;
427 indio_dev->num_channels = st->chip_info->num_channels;
428 indio_dev->info = &ads8688_info;
429
430 ads8688_reset(indio_dev);
431
432 mutex_init(&st->lock);
433
434 ret = iio_device_register(indio_dev);
435 if (ret)
436 goto error_out;
437
438 return 0;
439
440error_out:
441 if (!IS_ERR(st->reg))
442 regulator_disable(st->reg);
443
444 return ret;
445}
446
447static int ads8688_remove(struct spi_device *spi)
448{
449 struct iio_dev *indio_dev = spi_get_drvdata(spi);
450 struct ads8688_state *st = iio_priv(indio_dev);
451
452 iio_device_unregister(indio_dev);
453
454 if (!IS_ERR(st->reg))
455 regulator_disable(st->reg);
456
457 return 0;
458}
459
460static const struct spi_device_id ads8688_id[] = {
461 {"ads8684", ID_ADS8684},
462 {"ads8688", ID_ADS8688},
463 {}
464};
465MODULE_DEVICE_TABLE(spi, ads8688_id);
466
467static const struct of_device_id ads8688_of_match[] = {
468 { .compatible = "ti,ads8684" },
469 { .compatible = "ti,ads8688" },
470 { }
471};
472MODULE_DEVICE_TABLE(of, ads8688_of_match);
473
474static struct spi_driver ads8688_driver = {
475 .driver = {
476 .name = "ads8688",
477 .owner = THIS_MODULE,
478 },
479 .probe = ads8688_probe,
480 .remove = ads8688_remove,
481 .id_table = ads8688_id,
482};
483module_spi_driver(ads8688_driver);
484
485MODULE_AUTHOR("Sean Nyekjaer <sean.nyekjaer@prevas.dk>");
486MODULE_DESCRIPTION("Texas Instruments ADS8688 driver");
487MODULE_LICENSE("GPL v2");
488
