Christophe Leroy | 0eac259 | 2013-02-13 06:47:00 +0000 | [diff] [blame] | 1 | /* |
Lars-Peter Clausen | f2f7a44 | 2013-03-04 19:30:00 +0000 | [diff] [blame] | 2 | * AD7904/AD7914/AD7923/AD7924 SPI ADC driver |
Christophe Leroy | 0eac259 | 2013-02-13 06:47:00 +0000 | [diff] [blame] | 3 | * |
| 4 | * Copyright 2011 Analog Devices Inc (from AD7923 Driver) |
| 5 | * Copyright 2012 CS Systemes d'Information |
| 6 | * |
| 7 | * Licensed under the GPL-2. |
| 8 | */ |
| 9 | |
| 10 | #include <linux/device.h> |
| 11 | #include <linux/kernel.h> |
| 12 | #include <linux/slab.h> |
| 13 | #include <linux/sysfs.h> |
| 14 | #include <linux/spi/spi.h> |
Lars-Peter Clausen | ecf6ca2 | 2013-03-04 19:30:00 +0000 | [diff] [blame] | 15 | #include <linux/regulator/consumer.h> |
Christophe Leroy | 0eac259 | 2013-02-13 06:47:00 +0000 | [diff] [blame] | 16 | #include <linux/err.h> |
| 17 | #include <linux/delay.h> |
| 18 | #include <linux/module.h> |
| 19 | #include <linux/interrupt.h> |
| 20 | |
| 21 | #include <linux/iio/iio.h> |
| 22 | #include <linux/iio/sysfs.h> |
| 23 | #include <linux/iio/buffer.h> |
| 24 | #include <linux/iio/trigger_consumer.h> |
| 25 | #include <linux/iio/triggered_buffer.h> |
| 26 | |
| 27 | #define AD7923_WRITE_CR (1 << 11) /* write control register */ |
| 28 | #define AD7923_RANGE (1 << 1) /* range to REFin */ |
| 29 | #define AD7923_CODING (1 << 0) /* coding is straight binary */ |
| 30 | #define AD7923_PM_MODE_AS (1) /* auto shutdown */ |
| 31 | #define AD7923_PM_MODE_FS (2) /* full shutdown */ |
| 32 | #define AD7923_PM_MODE_OPS (3) /* normal operation */ |
| 33 | #define AD7923_CHANNEL_0 (0) /* analog input 0 */ |
| 34 | #define AD7923_CHANNEL_1 (1) /* analog input 1 */ |
| 35 | #define AD7923_CHANNEL_2 (2) /* analog input 2 */ |
| 36 | #define AD7923_CHANNEL_3 (3) /* analog input 3 */ |
| 37 | #define AD7923_SEQUENCE_OFF (0) /* no sequence fonction */ |
| 38 | #define AD7923_SEQUENCE_PROTECT (2) /* no interrupt write cycle */ |
| 39 | #define AD7923_SEQUENCE_ON (3) /* continuous sequence */ |
| 40 | |
| 41 | #define AD7923_MAX_CHAN 4 |
| 42 | |
| 43 | #define AD7923_PM_MODE_WRITE(mode) (mode << 4) /* write mode */ |
| 44 | #define AD7923_CHANNEL_WRITE(channel) (channel << 6) /* write channel */ |
| 45 | #define AD7923_SEQUENCE_WRITE(sequence) (((sequence & 1) << 3) \ |
| 46 | + ((sequence & 2) << 9)) |
| 47 | /* write sequence fonction */ |
| 48 | /* left shift for CR : bit 11 transmit in first */ |
| 49 | #define AD7923_SHIFT_REGISTER 4 |
| 50 | |
| 51 | /* val = value, dec = left shift, bits = number of bits of the mask */ |
| 52 | #define EXTRACT(val, dec, bits) ((val >> dec) & ((1 << bits) - 1)) |
| 53 | |
| 54 | struct ad7923_state { |
| 55 | struct spi_device *spi; |
| 56 | struct spi_transfer ring_xfer[5]; |
| 57 | struct spi_transfer scan_single_xfer[2]; |
| 58 | struct spi_message ring_msg; |
| 59 | struct spi_message scan_single_msg; |
Lars-Peter Clausen | ecf6ca2 | 2013-03-04 19:30:00 +0000 | [diff] [blame] | 60 | |
| 61 | struct regulator *reg; |
| 62 | |
| 63 | unsigned int settings; |
| 64 | |
Christophe Leroy | 0eac259 | 2013-02-13 06:47:00 +0000 | [diff] [blame] | 65 | /* |
| 66 | * DMA (thus cache coherency maintenance) requires the |
| 67 | * transfer buffers to live in their own cache lines. |
| 68 | */ |
| 69 | __be16 rx_buf[4] ____cacheline_aligned; |
| 70 | __be16 tx_buf[4]; |
| 71 | }; |
| 72 | |
Lars-Peter Clausen | f2f7a44 | 2013-03-04 19:30:00 +0000 | [diff] [blame] | 73 | struct ad7923_chip_info { |
| 74 | const struct iio_chan_spec *channels; |
| 75 | unsigned int num_channels; |
| 76 | }; |
| 77 | |
| 78 | enum ad7923_id { |
| 79 | AD7904, |
| 80 | AD7914, |
| 81 | AD7924, |
| 82 | }; |
| 83 | |
| 84 | #define AD7923_V_CHAN(index, bits) \ |
Christophe Leroy | 0eac259 | 2013-02-13 06:47:00 +0000 | [diff] [blame] | 85 | { \ |
| 86 | .type = IIO_VOLTAGE, \ |
| 87 | .indexed = 1, \ |
| 88 | .channel = index, \ |
Jonathan Cameron | 7657719 | 2013-03-03 12:26:47 +0000 | [diff] [blame] | 89 | .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), \ |
| 90 | .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE), \ |
Christophe Leroy | 0eac259 | 2013-02-13 06:47:00 +0000 | [diff] [blame] | 91 | .address = index, \ |
| 92 | .scan_index = index, \ |
| 93 | .scan_type = { \ |
| 94 | .sign = 'u', \ |
Lars-Peter Clausen | f2f7a44 | 2013-03-04 19:30:00 +0000 | [diff] [blame] | 95 | .realbits = (bits), \ |
Christophe Leroy | 0eac259 | 2013-02-13 06:47:00 +0000 | [diff] [blame] | 96 | .storagebits = 16, \ |
| 97 | .endianness = IIO_BE, \ |
| 98 | }, \ |
| 99 | } |
| 100 | |
Lars-Peter Clausen | f2f7a44 | 2013-03-04 19:30:00 +0000 | [diff] [blame] | 101 | #define DECLARE_AD7923_CHANNELS(name, bits) \ |
| 102 | const struct iio_chan_spec name ## _channels[] = { \ |
| 103 | AD7923_V_CHAN(0, bits), \ |
| 104 | AD7923_V_CHAN(1, bits), \ |
| 105 | AD7923_V_CHAN(2, bits), \ |
| 106 | AD7923_V_CHAN(3, bits), \ |
| 107 | IIO_CHAN_SOFT_TIMESTAMP(4), \ |
| 108 | } |
| 109 | |
| 110 | static DECLARE_AD7923_CHANNELS(ad7904, 8); |
| 111 | static DECLARE_AD7923_CHANNELS(ad7914, 10); |
| 112 | static DECLARE_AD7923_CHANNELS(ad7924, 12); |
| 113 | |
| 114 | static const struct ad7923_chip_info ad7923_chip_info[] = { |
| 115 | [AD7904] = { |
| 116 | .channels = ad7904_channels, |
| 117 | .num_channels = ARRAY_SIZE(ad7904_channels), |
| 118 | }, |
| 119 | [AD7914] = { |
| 120 | .channels = ad7914_channels, |
| 121 | .num_channels = ARRAY_SIZE(ad7914_channels), |
| 122 | }, |
| 123 | [AD7924] = { |
| 124 | .channels = ad7924_channels, |
| 125 | .num_channels = ARRAY_SIZE(ad7924_channels), |
| 126 | }, |
Christophe Leroy | 0eac259 | 2013-02-13 06:47:00 +0000 | [diff] [blame] | 127 | }; |
| 128 | |
| 129 | /** |
| 130 | * ad7923_update_scan_mode() setup the spi transfer buffer for the new scan mask |
| 131 | **/ |
| 132 | static int ad7923_update_scan_mode(struct iio_dev *indio_dev, |
| 133 | const unsigned long *active_scan_mask) |
| 134 | { |
| 135 | struct ad7923_state *st = iio_priv(indio_dev); |
| 136 | int i, cmd, len; |
| 137 | |
| 138 | len = 0; |
| 139 | for_each_set_bit(i, active_scan_mask, AD7923_MAX_CHAN) { |
Lars-Peter Clausen | ecf6ca2 | 2013-03-04 19:30:00 +0000 | [diff] [blame] | 140 | cmd = AD7923_WRITE_CR | AD7923_CHANNEL_WRITE(i) | |
Christophe Leroy | 0eac259 | 2013-02-13 06:47:00 +0000 | [diff] [blame] | 141 | AD7923_SEQUENCE_WRITE(AD7923_SEQUENCE_OFF) | |
Lars-Peter Clausen | ecf6ca2 | 2013-03-04 19:30:00 +0000 | [diff] [blame] | 142 | st->settings; |
Christophe Leroy | 0eac259 | 2013-02-13 06:47:00 +0000 | [diff] [blame] | 143 | cmd <<= AD7923_SHIFT_REGISTER; |
| 144 | st->tx_buf[len++] = cpu_to_be16(cmd); |
| 145 | } |
| 146 | /* build spi ring message */ |
| 147 | st->ring_xfer[0].tx_buf = &st->tx_buf[0]; |
| 148 | st->ring_xfer[0].len = len; |
| 149 | st->ring_xfer[0].cs_change = 1; |
| 150 | |
| 151 | spi_message_init(&st->ring_msg); |
| 152 | spi_message_add_tail(&st->ring_xfer[0], &st->ring_msg); |
| 153 | |
| 154 | for (i = 0; i < len; i++) { |
| 155 | st->ring_xfer[i + 1].rx_buf = &st->rx_buf[i]; |
| 156 | st->ring_xfer[i + 1].len = 2; |
| 157 | st->ring_xfer[i + 1].cs_change = 1; |
| 158 | spi_message_add_tail(&st->ring_xfer[i + 1], &st->ring_msg); |
| 159 | } |
| 160 | /* make sure last transfer cs_change is not set */ |
| 161 | st->ring_xfer[i + 1].cs_change = 0; |
| 162 | |
| 163 | return 0; |
| 164 | } |
| 165 | |
| 166 | /** |
| 167 | * ad7923_trigger_handler() bh of trigger launched polling to ring buffer |
| 168 | * |
| 169 | * Currently there is no option in this driver to disable the saving of |
| 170 | * timestamps within the ring. |
| 171 | **/ |
| 172 | static irqreturn_t ad7923_trigger_handler(int irq, void *p) |
| 173 | { |
| 174 | struct iio_poll_func *pf = p; |
| 175 | struct iio_dev *indio_dev = pf->indio_dev; |
| 176 | struct ad7923_state *st = iio_priv(indio_dev); |
| 177 | s64 time_ns = 0; |
| 178 | int b_sent; |
| 179 | |
| 180 | b_sent = spi_sync(st->spi, &st->ring_msg); |
| 181 | if (b_sent) |
| 182 | goto done; |
| 183 | |
| 184 | if (indio_dev->scan_timestamp) { |
| 185 | time_ns = iio_get_time_ns(); |
| 186 | memcpy((u8 *)st->rx_buf + indio_dev->scan_bytes - sizeof(s64), |
| 187 | &time_ns, sizeof(time_ns)); |
| 188 | } |
| 189 | |
| 190 | iio_push_to_buffers(indio_dev, (u8 *)st->rx_buf); |
| 191 | |
| 192 | done: |
| 193 | iio_trigger_notify_done(indio_dev->trig); |
| 194 | |
| 195 | return IRQ_HANDLED; |
| 196 | } |
| 197 | |
| 198 | static int ad7923_scan_direct(struct ad7923_state *st, unsigned ch) |
| 199 | { |
| 200 | int ret, cmd; |
| 201 | |
Lars-Peter Clausen | ecf6ca2 | 2013-03-04 19:30:00 +0000 | [diff] [blame] | 202 | cmd = AD7923_WRITE_CR | AD7923_CHANNEL_WRITE(ch) | |
| 203 | AD7923_SEQUENCE_WRITE(AD7923_SEQUENCE_OFF) | |
| 204 | st->settings; |
Christophe Leroy | 0eac259 | 2013-02-13 06:47:00 +0000 | [diff] [blame] | 205 | cmd <<= AD7923_SHIFT_REGISTER; |
| 206 | st->tx_buf[0] = cpu_to_be16(cmd); |
| 207 | |
| 208 | ret = spi_sync(st->spi, &st->scan_single_msg); |
| 209 | if (ret) |
| 210 | return ret; |
| 211 | |
| 212 | return be16_to_cpu(st->rx_buf[0]); |
| 213 | } |
| 214 | |
Lars-Peter Clausen | ecf6ca2 | 2013-03-04 19:30:00 +0000 | [diff] [blame] | 215 | static int ad7923_get_range(struct ad7923_state *st) |
| 216 | { |
| 217 | int vref; |
| 218 | |
| 219 | vref = regulator_get_voltage(st->reg); |
| 220 | if (vref < 0) |
| 221 | return vref; |
| 222 | |
| 223 | vref /= 1000; |
| 224 | |
| 225 | if (!(st->settings & AD7923_RANGE)) |
| 226 | vref *= 2; |
| 227 | |
| 228 | return vref; |
| 229 | } |
| 230 | |
Christophe Leroy | 0eac259 | 2013-02-13 06:47:00 +0000 | [diff] [blame] | 231 | static int ad7923_read_raw(struct iio_dev *indio_dev, |
| 232 | struct iio_chan_spec const *chan, |
| 233 | int *val, |
| 234 | int *val2, |
| 235 | long m) |
| 236 | { |
| 237 | int ret; |
| 238 | struct ad7923_state *st = iio_priv(indio_dev); |
| 239 | |
| 240 | switch (m) { |
| 241 | case IIO_CHAN_INFO_RAW: |
| 242 | mutex_lock(&indio_dev->mlock); |
| 243 | if (iio_buffer_enabled(indio_dev)) |
| 244 | ret = -EBUSY; |
| 245 | else |
| 246 | ret = ad7923_scan_direct(st, chan->address); |
| 247 | mutex_unlock(&indio_dev->mlock); |
| 248 | |
| 249 | if (ret < 0) |
| 250 | return ret; |
| 251 | |
| 252 | if (chan->address == EXTRACT(ret, 12, 4)) |
| 253 | *val = EXTRACT(ret, 0, 12); |
Lars-Peter Clausen | 135f064 | 2013-03-04 19:30:00 +0000 | [diff] [blame] | 254 | else |
| 255 | return -EIO; |
Christophe Leroy | 0eac259 | 2013-02-13 06:47:00 +0000 | [diff] [blame] | 256 | |
| 257 | return IIO_VAL_INT; |
Lars-Peter Clausen | ecf6ca2 | 2013-03-04 19:30:00 +0000 | [diff] [blame] | 258 | case IIO_CHAN_INFO_SCALE: |
| 259 | ret = ad7923_get_range(st); |
| 260 | if (ret < 0) |
| 261 | return ret; |
| 262 | *val = ret; |
| 263 | *val2 = chan->scan_type.realbits; |
| 264 | return IIO_VAL_FRACTIONAL_LOG2; |
Christophe Leroy | 0eac259 | 2013-02-13 06:47:00 +0000 | [diff] [blame] | 265 | } |
| 266 | return -EINVAL; |
| 267 | } |
| 268 | |
| 269 | static const struct iio_info ad7923_info = { |
| 270 | .read_raw = &ad7923_read_raw, |
| 271 | .update_scan_mode = ad7923_update_scan_mode, |
| 272 | .driver_module = THIS_MODULE, |
| 273 | }; |
| 274 | |
| 275 | static int ad7923_probe(struct spi_device *spi) |
| 276 | { |
| 277 | struct ad7923_state *st; |
Sachin Kamat | e59576d | 2013-07-23 09:58:00 +0100 | [diff] [blame] | 278 | struct iio_dev *indio_dev; |
Lars-Peter Clausen | f2f7a44 | 2013-03-04 19:30:00 +0000 | [diff] [blame] | 279 | const struct ad7923_chip_info *info; |
Christophe Leroy | 0eac259 | 2013-02-13 06:47:00 +0000 | [diff] [blame] | 280 | int ret; |
| 281 | |
Sachin Kamat | e59576d | 2013-07-23 09:58:00 +0100 | [diff] [blame] | 282 | indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*st)); |
Christophe Leroy | 0eac259 | 2013-02-13 06:47:00 +0000 | [diff] [blame] | 283 | if (indio_dev == NULL) |
| 284 | return -ENOMEM; |
| 285 | |
| 286 | st = iio_priv(indio_dev); |
| 287 | |
| 288 | spi_set_drvdata(spi, indio_dev); |
| 289 | |
| 290 | st->spi = spi; |
Lars-Peter Clausen | ecf6ca2 | 2013-03-04 19:30:00 +0000 | [diff] [blame] | 291 | st->settings = AD7923_CODING | AD7923_RANGE | |
| 292 | AD7923_PM_MODE_WRITE(AD7923_PM_MODE_OPS); |
Christophe Leroy | 0eac259 | 2013-02-13 06:47:00 +0000 | [diff] [blame] | 293 | |
Lars-Peter Clausen | f2f7a44 | 2013-03-04 19:30:00 +0000 | [diff] [blame] | 294 | info = &ad7923_chip_info[spi_get_device_id(spi)->driver_data]; |
| 295 | |
Christophe Leroy | 0eac259 | 2013-02-13 06:47:00 +0000 | [diff] [blame] | 296 | indio_dev->name = spi_get_device_id(spi)->name; |
| 297 | indio_dev->dev.parent = &spi->dev; |
| 298 | indio_dev->modes = INDIO_DIRECT_MODE; |
Lars-Peter Clausen | f2f7a44 | 2013-03-04 19:30:00 +0000 | [diff] [blame] | 299 | indio_dev->channels = info->channels; |
| 300 | indio_dev->num_channels = info->num_channels; |
Christophe Leroy | 0eac259 | 2013-02-13 06:47:00 +0000 | [diff] [blame] | 301 | indio_dev->info = &ad7923_info; |
| 302 | |
| 303 | /* Setup default message */ |
| 304 | |
| 305 | st->scan_single_xfer[0].tx_buf = &st->tx_buf[0]; |
| 306 | st->scan_single_xfer[0].len = 2; |
| 307 | st->scan_single_xfer[0].cs_change = 1; |
| 308 | st->scan_single_xfer[1].rx_buf = &st->rx_buf[0]; |
| 309 | st->scan_single_xfer[1].len = 2; |
| 310 | |
| 311 | spi_message_init(&st->scan_single_msg); |
| 312 | spi_message_add_tail(&st->scan_single_xfer[0], &st->scan_single_msg); |
| 313 | spi_message_add_tail(&st->scan_single_xfer[1], &st->scan_single_msg); |
| 314 | |
Sachin Kamat | e59576d | 2013-07-23 09:58:00 +0100 | [diff] [blame] | 315 | st->reg = devm_regulator_get(&spi->dev, "refin"); |
| 316 | if (IS_ERR(st->reg)) |
| 317 | return PTR_ERR(st->reg); |
| 318 | |
Lars-Peter Clausen | ecf6ca2 | 2013-03-04 19:30:00 +0000 | [diff] [blame] | 319 | ret = regulator_enable(st->reg); |
| 320 | if (ret) |
Sachin Kamat | e59576d | 2013-07-23 09:58:00 +0100 | [diff] [blame] | 321 | return ret; |
Lars-Peter Clausen | ecf6ca2 | 2013-03-04 19:30:00 +0000 | [diff] [blame] | 322 | |
Christophe Leroy | 0eac259 | 2013-02-13 06:47:00 +0000 | [diff] [blame] | 323 | ret = iio_triggered_buffer_setup(indio_dev, NULL, |
| 324 | &ad7923_trigger_handler, NULL); |
| 325 | if (ret) |
Lars-Peter Clausen | ecf6ca2 | 2013-03-04 19:30:00 +0000 | [diff] [blame] | 326 | goto error_disable_reg; |
Christophe Leroy | 0eac259 | 2013-02-13 06:47:00 +0000 | [diff] [blame] | 327 | |
| 328 | ret = iio_device_register(indio_dev); |
| 329 | if (ret) |
| 330 | goto error_cleanup_ring; |
| 331 | |
| 332 | return 0; |
| 333 | |
| 334 | error_cleanup_ring: |
| 335 | iio_triggered_buffer_cleanup(indio_dev); |
Lars-Peter Clausen | ecf6ca2 | 2013-03-04 19:30:00 +0000 | [diff] [blame] | 336 | error_disable_reg: |
| 337 | regulator_disable(st->reg); |
Christophe Leroy | 0eac259 | 2013-02-13 06:47:00 +0000 | [diff] [blame] | 338 | |
| 339 | return ret; |
| 340 | } |
| 341 | |
| 342 | static int ad7923_remove(struct spi_device *spi) |
| 343 | { |
| 344 | struct iio_dev *indio_dev = spi_get_drvdata(spi); |
Lars-Peter Clausen | ecf6ca2 | 2013-03-04 19:30:00 +0000 | [diff] [blame] | 345 | struct ad7923_state *st = iio_priv(indio_dev); |
Christophe Leroy | 0eac259 | 2013-02-13 06:47:00 +0000 | [diff] [blame] | 346 | |
| 347 | iio_device_unregister(indio_dev); |
| 348 | iio_triggered_buffer_cleanup(indio_dev); |
Lars-Peter Clausen | ecf6ca2 | 2013-03-04 19:30:00 +0000 | [diff] [blame] | 349 | regulator_disable(st->reg); |
Christophe Leroy | 0eac259 | 2013-02-13 06:47:00 +0000 | [diff] [blame] | 350 | |
| 351 | return 0; |
| 352 | } |
| 353 | |
| 354 | static const struct spi_device_id ad7923_id[] = { |
Lars-Peter Clausen | f2f7a44 | 2013-03-04 19:30:00 +0000 | [diff] [blame] | 355 | {"ad7904", AD7904}, |
| 356 | {"ad7914", AD7914}, |
| 357 | {"ad7923", AD7924}, |
| 358 | {"ad7924", AD7924}, |
Christophe Leroy | 0eac259 | 2013-02-13 06:47:00 +0000 | [diff] [blame] | 359 | {} |
| 360 | }; |
| 361 | MODULE_DEVICE_TABLE(spi, ad7923_id); |
| 362 | |
| 363 | static struct spi_driver ad7923_driver = { |
| 364 | .driver = { |
| 365 | .name = "ad7923", |
| 366 | .owner = THIS_MODULE, |
| 367 | }, |
| 368 | .probe = ad7923_probe, |
| 369 | .remove = ad7923_remove, |
| 370 | .id_table = ad7923_id, |
| 371 | }; |
| 372 | module_spi_driver(ad7923_driver); |
| 373 | |
| 374 | MODULE_AUTHOR("Michael Hennerich <hennerich@blackfin.uclinux.org>"); |
| 375 | MODULE_AUTHOR("Patrick Vasseur <patrick.vasseur@c-s.fr>"); |
Lars-Peter Clausen | f2f7a44 | 2013-03-04 19:30:00 +0000 | [diff] [blame] | 376 | MODULE_DESCRIPTION("Analog Devices AD7904/AD7914/AD7923/AD7924 ADC"); |
Christophe Leroy | 0eac259 | 2013-02-13 06:47:00 +0000 | [diff] [blame] | 377 | MODULE_LICENSE("GPL v2"); |