1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (C) 2015 Prevas A/S
6 #include <linux/device.h>
7 #include <linux/kernel.h>
8 #include <linux/slab.h>
9 #include <linux/sysfs.h>
10 #include <linux/spi/spi.h>
11 #include <linux/regulator/consumer.h>
12 #include <linux/err.h>
13 #include <linux/module.h>
16 #include <linux/iio/iio.h>
17 #include <linux/iio/buffer.h>
18 #include <linux/iio/trigger_consumer.h>
19 #include <linux/iio/triggered_buffer.h>
20 #include <linux/iio/sysfs.h>
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
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
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
39 #define ADS8688_VREF_MV 4096
40 #define ADS8688_REALBITS 16
41 #define ADS8688_MAX_CHANNELS 8
44 * enum ads8688_range - ADS8688 reference voltage range
45 * @ADS8688_PLUSMINUS25VREF: Device is configured for input range ±2.5 * VREF
46 * @ADS8688_PLUSMINUS125VREF: Device is configured for input range ±1.25 * VREF
47 * @ADS8688_PLUSMINUS0625VREF: Device is configured for input range ±0.625 * VREF
48 * @ADS8688_PLUS25VREF: Device is configured for input range 0 - 2.5 * VREF
49 * @ADS8688_PLUS125VREF: Device is configured for input range 0 - 1.25 * VREF
52 ADS8688_PLUSMINUS25VREF,
53 ADS8688_PLUSMINUS125VREF,
54 ADS8688_PLUSMINUS0625VREF,
59 struct ads8688_chip_info {
60 const struct iio_chan_spec *channels;
61 unsigned int num_channels;
64 struct ads8688_state {
66 const struct ads8688_chip_info *chip_info;
67 struct spi_device *spi;
68 struct regulator *reg;
70 enum ads8688_range range[8];
74 } data[2] ____cacheline_aligned;
82 struct ads8688_ranges {
83 enum ads8688_range range;
89 static const struct ads8688_ranges ads8688_range_def[5] = {
91 .range = ADS8688_PLUSMINUS25VREF,
93 .offset = -(1 << (ADS8688_REALBITS - 1)),
94 .reg = ADS8688_REG_PLUSMINUS25VREF,
96 .range = ADS8688_PLUSMINUS125VREF,
98 .offset = -(1 << (ADS8688_REALBITS - 1)),
99 .reg = ADS8688_REG_PLUSMINUS125VREF,
101 .range = ADS8688_PLUSMINUS0625VREF,
103 .offset = -(1 << (ADS8688_REALBITS - 1)),
104 .reg = ADS8688_REG_PLUSMINUS0625VREF,
106 .range = ADS8688_PLUS25VREF,
109 .reg = ADS8688_REG_PLUS25VREF,
111 .range = ADS8688_PLUS125VREF,
114 .reg = ADS8688_REG_PLUS125VREF,
118 static ssize_t ads8688_show_scales(struct device *dev,
119 struct device_attribute *attr, char *buf)
121 struct ads8688_state *st = iio_priv(dev_to_iio_dev(dev));
123 return sprintf(buf, "0.%09u 0.%09u 0.%09u\n",
124 ads8688_range_def[0].scale * st->vref_mv,
125 ads8688_range_def[1].scale * st->vref_mv,
126 ads8688_range_def[2].scale * st->vref_mv);
129 static ssize_t ads8688_show_offsets(struct device *dev,
130 struct device_attribute *attr, char *buf)
132 return sprintf(buf, "%d %d\n", ads8688_range_def[0].offset,
133 ads8688_range_def[3].offset);
136 static IIO_DEVICE_ATTR(in_voltage_scale_available, S_IRUGO,
137 ads8688_show_scales, NULL, 0);
138 static IIO_DEVICE_ATTR(in_voltage_offset_available, S_IRUGO,
139 ads8688_show_offsets, NULL, 0);
141 static struct attribute *ads8688_attributes[] = {
142 &iio_dev_attr_in_voltage_scale_available.dev_attr.attr,
143 &iio_dev_attr_in_voltage_offset_available.dev_attr.attr,
147 static const struct attribute_group ads8688_attribute_group = {
148 .attrs = ads8688_attributes,
151 #define ADS8688_CHAN(index) \
153 .type = IIO_VOLTAGE, \
156 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) \
157 | BIT(IIO_CHAN_INFO_SCALE) \
158 | BIT(IIO_CHAN_INFO_OFFSET), \
159 .scan_index = index, \
164 .endianness = IIO_BE, \
168 static const struct iio_chan_spec ads8684_channels[] = {
175 static const struct iio_chan_spec ads8688_channels[] = {
186 static int ads8688_prog_write(struct iio_dev *indio_dev, unsigned int addr,
189 struct ads8688_state *st = iio_priv(indio_dev);
192 tmp = ADS8688_PROG_REG(addr) | ADS8688_PROG_WR_BIT | val;
193 tmp <<= ADS8688_PROG_DONT_CARE_BITS;
194 st->data[0].d32 = cpu_to_be32(tmp);
196 return spi_write(st->spi, &st->data[0].d8[1], 3);
199 static int ads8688_reset(struct iio_dev *indio_dev)
201 struct ads8688_state *st = iio_priv(indio_dev);
204 tmp = ADS8688_CMD_REG(ADS8688_CMD_REG_RST);
205 tmp <<= ADS8688_CMD_DONT_CARE_BITS;
206 st->data[0].d32 = cpu_to_be32(tmp);
208 return spi_write(st->spi, &st->data[0].d8[0], 4);
211 static int ads8688_read(struct iio_dev *indio_dev, unsigned int chan)
213 struct ads8688_state *st = iio_priv(indio_dev);
216 struct spi_transfer t[] = {
218 .tx_buf = &st->data[0].d8[0],
222 .tx_buf = &st->data[1].d8[0],
223 .rx_buf = &st->data[1].d8[0],
228 tmp = ADS8688_CMD_REG(ADS8688_CMD_REG_MAN_CH(chan));
229 tmp <<= ADS8688_CMD_DONT_CARE_BITS;
230 st->data[0].d32 = cpu_to_be32(tmp);
232 tmp = ADS8688_CMD_REG(ADS8688_CMD_REG_NOOP);
233 tmp <<= ADS8688_CMD_DONT_CARE_BITS;
234 st->data[1].d32 = cpu_to_be32(tmp);
236 ret = spi_sync_transfer(st->spi, t, ARRAY_SIZE(t));
240 return be32_to_cpu(st->data[1].d32) & 0xffff;
243 static int ads8688_read_raw(struct iio_dev *indio_dev,
244 struct iio_chan_spec const *chan,
245 int *val, int *val2, long m)
248 unsigned long scale_mv;
250 struct ads8688_state *st = iio_priv(indio_dev);
252 mutex_lock(&st->lock);
254 case IIO_CHAN_INFO_RAW:
255 ret = ads8688_read(indio_dev, chan->channel);
256 mutex_unlock(&st->lock);
261 case IIO_CHAN_INFO_SCALE:
262 scale_mv = st->vref_mv;
263 scale_mv *= ads8688_range_def[st->range[chan->channel]].scale;
266 mutex_unlock(&st->lock);
267 return IIO_VAL_INT_PLUS_NANO;
268 case IIO_CHAN_INFO_OFFSET:
269 offset = ads8688_range_def[st->range[chan->channel]].offset;
271 mutex_unlock(&st->lock);
274 mutex_unlock(&st->lock);
279 static int ads8688_write_reg_range(struct iio_dev *indio_dev,
280 struct iio_chan_spec const *chan,
281 enum ads8688_range range)
286 tmp = ADS8688_PROG_REG_RANGE_CH(chan->channel);
287 ret = ads8688_prog_write(indio_dev, tmp, range);
292 static int ads8688_write_raw(struct iio_dev *indio_dev,
293 struct iio_chan_spec const *chan,
294 int val, int val2, long mask)
296 struct ads8688_state *st = iio_priv(indio_dev);
297 unsigned int scale = 0;
298 int ret = -EINVAL, i, offset = 0;
300 mutex_lock(&st->lock);
302 case IIO_CHAN_INFO_SCALE:
303 /* If the offset is 0 the ±2.5 * VREF mode is not available */
304 offset = ads8688_range_def[st->range[chan->channel]].offset;
305 if (offset == 0 && val2 == ads8688_range_def[0].scale * st->vref_mv) {
306 mutex_unlock(&st->lock);
310 /* Lookup new mode */
311 for (i = 0; i < ARRAY_SIZE(ads8688_range_def); i++)
312 if (val2 == ads8688_range_def[i].scale * st->vref_mv &&
313 offset == ads8688_range_def[i].offset) {
314 ret = ads8688_write_reg_range(indio_dev, chan,
315 ads8688_range_def[i].reg);
319 case IIO_CHAN_INFO_OFFSET:
321 * There are only two available offsets:
322 * 0 and -(1 << (ADS8688_REALBITS - 1))
324 if (!(ads8688_range_def[0].offset == val ||
325 ads8688_range_def[3].offset == val)) {
326 mutex_unlock(&st->lock);
331 * If the device are in ±2.5 * VREF mode, it's not allowed to
332 * switch to a mode where the offset is 0
335 st->range[chan->channel] == ADS8688_PLUSMINUS25VREF) {
336 mutex_unlock(&st->lock);
340 scale = ads8688_range_def[st->range[chan->channel]].scale;
342 /* Lookup new mode */
343 for (i = 0; i < ARRAY_SIZE(ads8688_range_def); i++)
344 if (val == ads8688_range_def[i].offset &&
345 scale == ads8688_range_def[i].scale) {
346 ret = ads8688_write_reg_range(indio_dev, chan,
347 ads8688_range_def[i].reg);
354 st->range[chan->channel] = ads8688_range_def[i].range;
356 mutex_unlock(&st->lock);
361 static int ads8688_write_raw_get_fmt(struct iio_dev *indio_dev,
362 struct iio_chan_spec const *chan,
366 case IIO_CHAN_INFO_SCALE:
367 return IIO_VAL_INT_PLUS_NANO;
368 case IIO_CHAN_INFO_OFFSET:
375 static const struct iio_info ads8688_info = {
376 .read_raw = &ads8688_read_raw,
377 .write_raw = &ads8688_write_raw,
378 .write_raw_get_fmt = &ads8688_write_raw_get_fmt,
379 .attrs = &ads8688_attribute_group,
382 static irqreturn_t ads8688_trigger_handler(int irq, void *p)
384 struct iio_poll_func *pf = p;
385 struct iio_dev *indio_dev = pf->indio_dev;
386 /* Ensure naturally aligned timestamp */
387 u16 buffer[ADS8688_MAX_CHANNELS + sizeof(s64)/sizeof(u16)] __aligned(8);
390 for (i = 0; i < indio_dev->masklength; i++) {
391 if (!test_bit(i, indio_dev->active_scan_mask))
393 buffer[j] = ads8688_read(indio_dev, i);
397 iio_push_to_buffers_with_timestamp(indio_dev, buffer,
398 iio_get_time_ns(indio_dev));
400 iio_trigger_notify_done(indio_dev->trig);
405 static const struct ads8688_chip_info ads8688_chip_info_tbl[] = {
407 .channels = ads8684_channels,
408 .num_channels = ARRAY_SIZE(ads8684_channels),
411 .channels = ads8688_channels,
412 .num_channels = ARRAY_SIZE(ads8688_channels),
416 static int ads8688_probe(struct spi_device *spi)
418 struct ads8688_state *st;
419 struct iio_dev *indio_dev;
422 indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*st));
423 if (indio_dev == NULL)
426 st = iio_priv(indio_dev);
428 st->reg = devm_regulator_get_optional(&spi->dev, "vref");
429 if (!IS_ERR(st->reg)) {
430 ret = regulator_enable(st->reg);
434 ret = regulator_get_voltage(st->reg);
436 goto err_regulator_disable;
438 st->vref_mv = ret / 1000;
440 /* Use internal reference */
441 st->vref_mv = ADS8688_VREF_MV;
444 st->chip_info = &ads8688_chip_info_tbl[spi_get_device_id(spi)->driver_data];
446 spi->mode = SPI_MODE_1;
448 spi_set_drvdata(spi, indio_dev);
452 indio_dev->name = spi_get_device_id(spi)->name;
453 indio_dev->modes = INDIO_DIRECT_MODE;
454 indio_dev->channels = st->chip_info->channels;
455 indio_dev->num_channels = st->chip_info->num_channels;
456 indio_dev->info = &ads8688_info;
458 ads8688_reset(indio_dev);
460 mutex_init(&st->lock);
462 ret = iio_triggered_buffer_setup(indio_dev, NULL, ads8688_trigger_handler, NULL);
464 dev_err(&spi->dev, "iio triggered buffer setup failed\n");
465 goto err_regulator_disable;
468 ret = iio_device_register(indio_dev);
470 goto err_buffer_cleanup;
475 iio_triggered_buffer_cleanup(indio_dev);
477 err_regulator_disable:
478 if (!IS_ERR(st->reg))
479 regulator_disable(st->reg);
484 static int ads8688_remove(struct spi_device *spi)
486 struct iio_dev *indio_dev = spi_get_drvdata(spi);
487 struct ads8688_state *st = iio_priv(indio_dev);
489 iio_device_unregister(indio_dev);
490 iio_triggered_buffer_cleanup(indio_dev);
492 if (!IS_ERR(st->reg))
493 regulator_disable(st->reg);
498 static const struct spi_device_id ads8688_id[] = {
499 {"ads8684", ID_ADS8684},
500 {"ads8688", ID_ADS8688},
503 MODULE_DEVICE_TABLE(spi, ads8688_id);
505 static const struct of_device_id ads8688_of_match[] = {
506 { .compatible = "ti,ads8684" },
507 { .compatible = "ti,ads8688" },
510 MODULE_DEVICE_TABLE(of, ads8688_of_match);
512 static struct spi_driver ads8688_driver = {
516 .probe = ads8688_probe,
517 .remove = ads8688_remove,
518 .id_table = ads8688_id,
520 module_spi_driver(ads8688_driver);
522 MODULE_AUTHOR("Sean Nyekjaer <sean@geanix.dk>");
523 MODULE_DESCRIPTION("Texas Instruments ADS8688 driver");
524 MODULE_LICENSE("GPL v2");