ad7266.c revision 2ebc39c0bbb30d6f06c3fe65c458e546db275f6d
1/* 2 * AD7266/65 SPI ADC driver 3 * 4 * Copyright 2012 Analog Devices Inc. 5 * 6 * Licensed under the GPL-2. 7 */ 8 9#include <linux/device.h> 10#include <linux/kernel.h> 11#include <linux/slab.h> 12#include <linux/spi/spi.h> 13#include <linux/regulator/consumer.h> 14#include <linux/err.h> 15#include <linux/gpio.h> 16#include <linux/module.h> 17 18#include <linux/interrupt.h> 19 20#include <linux/iio/iio.h> 21#include <linux/iio/buffer.h> 22#include <linux/iio/trigger_consumer.h> 23#include <linux/iio/triggered_buffer.h> 24 25#include <linux/platform_data/ad7266.h> 26 27struct ad7266_state { 28 struct spi_device *spi; 29 struct regulator *reg; 30 unsigned long vref_mv; 31 32 struct spi_transfer single_xfer[3]; 33 struct spi_message single_msg; 34 35 enum ad7266_range range; 36 enum ad7266_mode mode; 37 bool fixed_addr; 38 struct gpio gpios[3]; 39 40 /* 41 * DMA (thus cache coherency maintenance) requires the 42 * transfer buffers to live in their own cache lines. 43 * The buffer needs to be large enough to hold two samples (4 bytes) and 44 * the naturally aligned timestamp (8 bytes). 45 */ 46 uint8_t data[ALIGN(4, sizeof(s64)) + sizeof(s64)] ____cacheline_aligned; 47}; 48 49static int ad7266_wakeup(struct ad7266_state *st) 50{ 51 /* Any read with >= 2 bytes will wake the device */ 52 return spi_read(st->spi, st->data, 2); 53} 54 55static int ad7266_powerdown(struct ad7266_state *st) 56{ 57 /* Any read with < 2 bytes will powerdown the device */ 58 return spi_read(st->spi, st->data, 1); 59} 60 61static int ad7266_preenable(struct iio_dev *indio_dev) 62{ 63 struct ad7266_state *st = iio_priv(indio_dev); 64 int ret; 65 66 ret = ad7266_wakeup(st); 67 if (ret) 68 return ret; 69 70 ret = iio_sw_buffer_preenable(indio_dev); 71 if (ret) 72 ad7266_powerdown(st); 73 74 return ret; 75} 76 77static int ad7266_postdisable(struct iio_dev *indio_dev) 78{ 79 struct ad7266_state *st = iio_priv(indio_dev); 80 return ad7266_powerdown(st); 81} 82 83static const struct iio_buffer_setup_ops iio_triggered_buffer_setup_ops = { 84 .preenable = &ad7266_preenable, 85 .postenable = &iio_triggered_buffer_postenable, 86 .predisable = &iio_triggered_buffer_predisable, 87 .postdisable = &ad7266_postdisable, 88}; 89 90static irqreturn_t ad7266_trigger_handler(int irq, void *p) 91{ 92 struct iio_poll_func *pf = p; 93 struct iio_dev *indio_dev = pf->indio_dev; 94 struct ad7266_state *st = iio_priv(indio_dev); 95 int ret; 96 97 ret = spi_read(st->spi, st->data, 4); 98 if (ret == 0) { 99 iio_push_to_buffers_with_timestamp(indio_dev, st->data, 100 pf->timestamp); 101 } 102 103 iio_trigger_notify_done(indio_dev->trig); 104 105 return IRQ_HANDLED; 106} 107 108static void ad7266_select_input(struct ad7266_state *st, unsigned int nr) 109{ 110 unsigned int i; 111 112 if (st->fixed_addr) 113 return; 114 115 switch (st->mode) { 116 case AD7266_MODE_SINGLE_ENDED: 117 nr >>= 1; 118 break; 119 case AD7266_MODE_PSEUDO_DIFF: 120 nr |= 1; 121 break; 122 case AD7266_MODE_DIFF: 123 nr &= ~1; 124 break; 125 } 126 127 for (i = 0; i < 3; ++i) 128 gpio_set_value(st->gpios[i].gpio, (bool)(nr & BIT(i))); 129} 130 131static int ad7266_update_scan_mode(struct iio_dev *indio_dev, 132 const unsigned long *scan_mask) 133{ 134 struct ad7266_state *st = iio_priv(indio_dev); 135 unsigned int nr = find_first_bit(scan_mask, indio_dev->masklength); 136 137 ad7266_select_input(st, nr); 138 139 return 0; 140} 141 142static int ad7266_read_single(struct ad7266_state *st, int *val, 143 unsigned int address) 144{ 145 int ret; 146 147 ad7266_select_input(st, address); 148 149 ret = spi_sync(st->spi, &st->single_msg); 150 *val = be16_to_cpu(st->data[address % 2]); 151 152 return ret; 153} 154 155static int ad7266_read_raw(struct iio_dev *indio_dev, 156 struct iio_chan_spec const *chan, int *val, int *val2, long m) 157{ 158 struct ad7266_state *st = iio_priv(indio_dev); 159 unsigned long scale_mv; 160 int ret; 161 162 switch (m) { 163 case IIO_CHAN_INFO_RAW: 164 if (iio_buffer_enabled(indio_dev)) 165 return -EBUSY; 166 167 ret = ad7266_read_single(st, val, chan->address); 168 if (ret) 169 return ret; 170 171 *val = (*val >> 2) & 0xfff; 172 if (chan->scan_type.sign == 's') 173 *val = sign_extend32(*val, 11); 174 175 return IIO_VAL_INT; 176 case IIO_CHAN_INFO_SCALE: 177 scale_mv = st->vref_mv; 178 if (st->mode == AD7266_MODE_DIFF) 179 scale_mv *= 2; 180 if (st->range == AD7266_RANGE_2VREF) 181 scale_mv *= 2; 182 183 *val = scale_mv; 184 *val2 = chan->scan_type.realbits; 185 return IIO_VAL_FRACTIONAL_LOG2; 186 case IIO_CHAN_INFO_OFFSET: 187 if (st->range == AD7266_RANGE_2VREF && 188 st->mode != AD7266_MODE_DIFF) 189 *val = 2048; 190 else 191 *val = 0; 192 return IIO_VAL_INT; 193 } 194 return -EINVAL; 195} 196 197#define AD7266_CHAN(_chan, _sign) { \ 198 .type = IIO_VOLTAGE, \ 199 .indexed = 1, \ 200 .channel = (_chan), \ 201 .address = (_chan), \ 202 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), \ 203 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE) \ 204 | BIT(IIO_CHAN_INFO_OFFSET), \ 205 .scan_index = (_chan), \ 206 .scan_type = { \ 207 .sign = (_sign), \ 208 .realbits = 12, \ 209 .storagebits = 16, \ 210 .shift = 2, \ 211 .endianness = IIO_BE, \ 212 }, \ 213} 214 215#define AD7266_DECLARE_SINGLE_ENDED_CHANNELS(_name, _sign) \ 216const struct iio_chan_spec ad7266_channels_##_name[] = { \ 217 AD7266_CHAN(0, (_sign)), \ 218 AD7266_CHAN(1, (_sign)), \ 219 AD7266_CHAN(2, (_sign)), \ 220 AD7266_CHAN(3, (_sign)), \ 221 AD7266_CHAN(4, (_sign)), \ 222 AD7266_CHAN(5, (_sign)), \ 223 AD7266_CHAN(6, (_sign)), \ 224 AD7266_CHAN(7, (_sign)), \ 225 AD7266_CHAN(8, (_sign)), \ 226 AD7266_CHAN(9, (_sign)), \ 227 AD7266_CHAN(10, (_sign)), \ 228 AD7266_CHAN(11, (_sign)), \ 229 IIO_CHAN_SOFT_TIMESTAMP(13), \ 230} 231 232#define AD7266_DECLARE_SINGLE_ENDED_CHANNELS_FIXED(_name, _sign) \ 233const struct iio_chan_spec ad7266_channels_##_name##_fixed[] = { \ 234 AD7266_CHAN(0, (_sign)), \ 235 AD7266_CHAN(1, (_sign)), \ 236 IIO_CHAN_SOFT_TIMESTAMP(2), \ 237} 238 239static AD7266_DECLARE_SINGLE_ENDED_CHANNELS(u, 'u'); 240static AD7266_DECLARE_SINGLE_ENDED_CHANNELS(s, 's'); 241static AD7266_DECLARE_SINGLE_ENDED_CHANNELS_FIXED(u, 'u'); 242static AD7266_DECLARE_SINGLE_ENDED_CHANNELS_FIXED(s, 's'); 243 244#define AD7266_CHAN_DIFF(_chan, _sign) { \ 245 .type = IIO_VOLTAGE, \ 246 .indexed = 1, \ 247 .channel = (_chan) * 2, \ 248 .channel2 = (_chan) * 2 + 1, \ 249 .address = (_chan), \ 250 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW), \ 251 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE) \ 252 | BIT(IIO_CHAN_INFO_OFFSET), \ 253 .scan_index = (_chan), \ 254 .scan_type = { \ 255 .sign = _sign, \ 256 .realbits = 12, \ 257 .storagebits = 16, \ 258 .shift = 2, \ 259 .endianness = IIO_BE, \ 260 }, \ 261 .differential = 1, \ 262} 263 264#define AD7266_DECLARE_DIFF_CHANNELS(_name, _sign) \ 265const struct iio_chan_spec ad7266_channels_diff_##_name[] = { \ 266 AD7266_CHAN_DIFF(0, (_sign)), \ 267 AD7266_CHAN_DIFF(1, (_sign)), \ 268 AD7266_CHAN_DIFF(2, (_sign)), \ 269 AD7266_CHAN_DIFF(3, (_sign)), \ 270 AD7266_CHAN_DIFF(4, (_sign)), \ 271 AD7266_CHAN_DIFF(5, (_sign)), \ 272 IIO_CHAN_SOFT_TIMESTAMP(6), \ 273} 274 275static AD7266_DECLARE_DIFF_CHANNELS(s, 's'); 276static AD7266_DECLARE_DIFF_CHANNELS(u, 'u'); 277 278#define AD7266_DECLARE_DIFF_CHANNELS_FIXED(_name, _sign) \ 279const struct iio_chan_spec ad7266_channels_diff_fixed_##_name[] = { \ 280 AD7266_CHAN_DIFF(0, (_sign)), \ 281 AD7266_CHAN_DIFF(1, (_sign)), \ 282 IIO_CHAN_SOFT_TIMESTAMP(2), \ 283} 284 285static AD7266_DECLARE_DIFF_CHANNELS_FIXED(s, 's'); 286static AD7266_DECLARE_DIFF_CHANNELS_FIXED(u, 'u'); 287 288static const struct iio_info ad7266_info = { 289 .read_raw = &ad7266_read_raw, 290 .update_scan_mode = &ad7266_update_scan_mode, 291 .driver_module = THIS_MODULE, 292}; 293 294static const unsigned long ad7266_available_scan_masks[] = { 295 0x003, 296 0x00c, 297 0x030, 298 0x0c0, 299 0x300, 300 0xc00, 301 0x000, 302}; 303 304static const unsigned long ad7266_available_scan_masks_diff[] = { 305 0x003, 306 0x00c, 307 0x030, 308 0x000, 309}; 310 311static const unsigned long ad7266_available_scan_masks_fixed[] = { 312 0x003, 313 0x000, 314}; 315 316struct ad7266_chan_info { 317 const struct iio_chan_spec *channels; 318 unsigned int num_channels; 319 const unsigned long *scan_masks; 320}; 321 322#define AD7266_CHAN_INFO_INDEX(_differential, _signed, _fixed) \ 323 (((_differential) << 2) | ((_signed) << 1) | ((_fixed) << 0)) 324 325static const struct ad7266_chan_info ad7266_chan_infos[] = { 326 [AD7266_CHAN_INFO_INDEX(0, 0, 0)] = { 327 .channels = ad7266_channels_u, 328 .num_channels = ARRAY_SIZE(ad7266_channels_u), 329 .scan_masks = ad7266_available_scan_masks, 330 }, 331 [AD7266_CHAN_INFO_INDEX(0, 0, 1)] = { 332 .channels = ad7266_channels_u_fixed, 333 .num_channels = ARRAY_SIZE(ad7266_channels_u_fixed), 334 .scan_masks = ad7266_available_scan_masks_fixed, 335 }, 336 [AD7266_CHAN_INFO_INDEX(0, 1, 0)] = { 337 .channels = ad7266_channels_s, 338 .num_channels = ARRAY_SIZE(ad7266_channels_s), 339 .scan_masks = ad7266_available_scan_masks, 340 }, 341 [AD7266_CHAN_INFO_INDEX(0, 1, 1)] = { 342 .channels = ad7266_channels_s_fixed, 343 .num_channels = ARRAY_SIZE(ad7266_channels_s_fixed), 344 .scan_masks = ad7266_available_scan_masks_fixed, 345 }, 346 [AD7266_CHAN_INFO_INDEX(1, 0, 0)] = { 347 .channels = ad7266_channels_diff_u, 348 .num_channels = ARRAY_SIZE(ad7266_channels_diff_u), 349 .scan_masks = ad7266_available_scan_masks_diff, 350 }, 351 [AD7266_CHAN_INFO_INDEX(1, 0, 1)] = { 352 .channels = ad7266_channels_diff_fixed_u, 353 .num_channels = ARRAY_SIZE(ad7266_channels_diff_fixed_u), 354 .scan_masks = ad7266_available_scan_masks_fixed, 355 }, 356 [AD7266_CHAN_INFO_INDEX(1, 1, 0)] = { 357 .channels = ad7266_channels_diff_s, 358 .num_channels = ARRAY_SIZE(ad7266_channels_diff_s), 359 .scan_masks = ad7266_available_scan_masks_diff, 360 }, 361 [AD7266_CHAN_INFO_INDEX(1, 1, 1)] = { 362 .channels = ad7266_channels_diff_fixed_s, 363 .num_channels = ARRAY_SIZE(ad7266_channels_diff_fixed_s), 364 .scan_masks = ad7266_available_scan_masks_fixed, 365 }, 366}; 367 368static void ad7266_init_channels(struct iio_dev *indio_dev) 369{ 370 struct ad7266_state *st = iio_priv(indio_dev); 371 bool is_differential, is_signed; 372 const struct ad7266_chan_info *chan_info; 373 int i; 374 375 is_differential = st->mode != AD7266_MODE_SINGLE_ENDED; 376 is_signed = (st->range == AD7266_RANGE_2VREF) | 377 (st->mode == AD7266_MODE_DIFF); 378 379 i = AD7266_CHAN_INFO_INDEX(is_differential, is_signed, st->fixed_addr); 380 chan_info = &ad7266_chan_infos[i]; 381 382 indio_dev->channels = chan_info->channels; 383 indio_dev->num_channels = chan_info->num_channels; 384 indio_dev->available_scan_masks = chan_info->scan_masks; 385 indio_dev->masklength = chan_info->num_channels - 1; 386} 387 388static const char * const ad7266_gpio_labels[] = { 389 "AD0", "AD1", "AD2", 390}; 391 392static int ad7266_probe(struct spi_device *spi) 393{ 394 struct ad7266_platform_data *pdata = spi->dev.platform_data; 395 struct iio_dev *indio_dev; 396 struct ad7266_state *st; 397 unsigned int i; 398 int ret; 399 400 indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*st)); 401 if (indio_dev == NULL) 402 return -ENOMEM; 403 404 st = iio_priv(indio_dev); 405 406 st->reg = devm_regulator_get(&spi->dev, "vref"); 407 if (!IS_ERR_OR_NULL(st->reg)) { 408 ret = regulator_enable(st->reg); 409 if (ret) 410 return ret; 411 412 ret = regulator_get_voltage(st->reg); 413 if (ret < 0) 414 goto error_disable_reg; 415 416 st->vref_mv = ret / 1000; 417 } else { 418 /* Use internal reference */ 419 st->vref_mv = 2500; 420 } 421 422 if (pdata) { 423 st->fixed_addr = pdata->fixed_addr; 424 st->mode = pdata->mode; 425 st->range = pdata->range; 426 427 if (!st->fixed_addr) { 428 for (i = 0; i < ARRAY_SIZE(st->gpios); ++i) { 429 st->gpios[i].gpio = pdata->addr_gpios[i]; 430 st->gpios[i].flags = GPIOF_OUT_INIT_LOW; 431 st->gpios[i].label = ad7266_gpio_labels[i]; 432 } 433 ret = gpio_request_array(st->gpios, 434 ARRAY_SIZE(st->gpios)); 435 if (ret) 436 goto error_disable_reg; 437 } 438 } else { 439 st->fixed_addr = true; 440 st->range = AD7266_RANGE_VREF; 441 st->mode = AD7266_MODE_DIFF; 442 } 443 444 spi_set_drvdata(spi, indio_dev); 445 st->spi = spi; 446 447 indio_dev->dev.parent = &spi->dev; 448 indio_dev->name = spi_get_device_id(spi)->name; 449 indio_dev->modes = INDIO_DIRECT_MODE; 450 indio_dev->info = &ad7266_info; 451 452 ad7266_init_channels(indio_dev); 453 454 /* wakeup */ 455 st->single_xfer[0].rx_buf = &st->data; 456 st->single_xfer[0].len = 2; 457 st->single_xfer[0].cs_change = 1; 458 /* conversion */ 459 st->single_xfer[1].rx_buf = &st->data; 460 st->single_xfer[1].len = 4; 461 st->single_xfer[1].cs_change = 1; 462 /* powerdown */ 463 st->single_xfer[2].tx_buf = &st->data; 464 st->single_xfer[2].len = 1; 465 466 spi_message_init(&st->single_msg); 467 spi_message_add_tail(&st->single_xfer[0], &st->single_msg); 468 spi_message_add_tail(&st->single_xfer[1], &st->single_msg); 469 spi_message_add_tail(&st->single_xfer[2], &st->single_msg); 470 471 ret = iio_triggered_buffer_setup(indio_dev, &iio_pollfunc_store_time, 472 &ad7266_trigger_handler, &iio_triggered_buffer_setup_ops); 473 if (ret) 474 goto error_free_gpios; 475 476 ret = iio_device_register(indio_dev); 477 if (ret) 478 goto error_buffer_cleanup; 479 480 return 0; 481 482error_buffer_cleanup: 483 iio_triggered_buffer_cleanup(indio_dev); 484error_free_gpios: 485 if (!st->fixed_addr) 486 gpio_free_array(st->gpios, ARRAY_SIZE(st->gpios)); 487error_disable_reg: 488 if (!IS_ERR_OR_NULL(st->reg)) 489 regulator_disable(st->reg); 490 491 return ret; 492} 493 494static int ad7266_remove(struct spi_device *spi) 495{ 496 struct iio_dev *indio_dev = spi_get_drvdata(spi); 497 struct ad7266_state *st = iio_priv(indio_dev); 498 499 iio_device_unregister(indio_dev); 500 iio_triggered_buffer_cleanup(indio_dev); 501 if (!st->fixed_addr) 502 gpio_free_array(st->gpios, ARRAY_SIZE(st->gpios)); 503 if (!IS_ERR_OR_NULL(st->reg)) 504 regulator_disable(st->reg); 505 506 return 0; 507} 508 509static const struct spi_device_id ad7266_id[] = { 510 {"ad7265", 0}, 511 {"ad7266", 0}, 512 { } 513}; 514MODULE_DEVICE_TABLE(spi, ad7266_id); 515 516static struct spi_driver ad7266_driver = { 517 .driver = { 518 .name = "ad7266", 519 .owner = THIS_MODULE, 520 }, 521 .probe = ad7266_probe, 522 .remove = ad7266_remove, 523 .id_table = ad7266_id, 524}; 525module_spi_driver(ad7266_driver); 526 527MODULE_AUTHOR("Lars-Peter Clausen <lars@metafoo.de>"); 528MODULE_DESCRIPTION("Analog Devices AD7266/65 ADC"); 529MODULE_LICENSE("GPL v2"); 530