drivers/staging/iio/adc/ad7606_core.c

   1 /*
   2  * AD7606 SPI ADC driver
   3  *
   4  * Copyright 2011 Analog Devices Inc.
   5  *
   6  * Licensed under the GPL-2.
   7  */
   8
   9 #include <linux/interrupt.h>
  10 #include <linux/device.h>
  11 #include <linux/kernel.h>
  12 #include <linux/slab.h>
  13 #include <linux/sysfs.h>
  14 #include <linux/regulator/consumer.h>
  15 #include <linux/err.h>
  16 #include <linux/gpio.h>
  17 #include <linux/delay.h>
  18 #include <linux/sched.h>
  19 #include <linux/module.h>
  20
  21 #include <linux/iio/iio.h>
  22 #include <linux/iio/sysfs.h>
  23 #include <linux/iio/buffer.h>
  24
  25 #include "ad7606.h"
  26
  27 int ad7606_reset(struct ad7606_state *st)
  28 {
  29         if (gpio_is_valid(st->pdata->gpio_reset)) {
  30                 gpio_set_value(st->pdata->gpio_reset, 1);
  31                 ndelay(100); /* t_reset >= 100ns */
  32                 gpio_set_value(st->pdata->gpio_reset, 0);
  33                 return 0;
  34         }
  35
  36         return -ENODEV;
  37 }
  38
  39 int ad7606_read_samples(struct ad7606_state *st)
  40 {
  41         unsigned int num = st->chip_info->num_channels;
  42         u16 *data = st->data;
  43         int ret;
  44
  45         /*
  46          * The frstdata signal is set to high while and after reading the sample
  47          * of the first channel and low for all other channels. This can be used
  48          * to check that the incoming data is correctly aligned. During normal
  49          * operation the data should never become unaligned, but some glitch or
  50          * electrostatic discharge might cause an extra read or clock cycle.
  51          * Monitoring the frstdata signal allows to recover from such failure
  52          * situations.
  53          */
  54
  55         if (gpio_is_valid(st->pdata->gpio_frstdata)) {
  56                 ret = st->bops->read_block(st->dev, 1, data);
  57                 if (ret)
  58                         return ret;
  59
  60                 if (!gpio_get_value(st->pdata->gpio_frstdata)) {
  61                         ad7606_reset(st);
  62                         return -EIO;
  63                 }
  64
  65                 data++;
  66                 num--;
  67         }
  68
  69         return st->bops->read_block(st->dev, num, data);
  70 }
  71
  72 static int ad7606_scan_direct(struct iio_dev *indio_dev, unsigned int ch)
  73 {
  74         struct ad7606_state *st = iio_priv(indio_dev);
  75         int ret;
  76
  77         st->done = false;
  78         gpio_set_value(st->pdata->gpio_convst, 1);
  79
  80         ret = wait_event_interruptible(st->wq_data_avail, st->done);
  81         if (ret)
  82                 goto error_ret;
  83
  84         ret = ad7606_read_samples(st);
  85         if (ret == 0)
  86                 ret = st->data[ch];
  87
  88 error_ret:
  89         gpio_set_value(st->pdata->gpio_convst, 0);
  90
  91         return ret;
  92 }
  93
  94 static int ad7606_read_raw(struct iio_dev *indio_dev,
  95                            struct iio_chan_spec const *chan,
  96                            int *val,
  97                            int *val2,
  98                            long m)
  99 {
 100         int ret;
 101         struct ad7606_state *st = iio_priv(indio_dev);
 102
 103         switch (m) {
 104         case IIO_CHAN_INFO_RAW:
 105                 ret = iio_device_claim_direct_mode(indio_dev);
 106                 if (ret)
 107                         return ret;
 108
 109                 ret = ad7606_scan_direct(indio_dev, chan->address);
 110                 iio_device_release_direct_mode(indio_dev);
 111
 112                 if (ret < 0)
 113                         return ret;
 114                 *val = (short)ret;
 115                 return IIO_VAL_INT;
 116         case IIO_CHAN_INFO_SCALE:
 117                 *val = st->range * 2;
 118                 *val2 = st->chip_info->channels[0].scan_type.realbits;
 119                 return IIO_VAL_FRACTIONAL_LOG2;
 120         case IIO_CHAN_INFO_OVERSAMPLING_RATIO:
 121                 *val = st->oversampling;
 122                 return IIO_VAL_INT;
 123         }
 124         return -EINVAL;
 125 }
 126
 127 static ssize_t ad7606_show_range(struct device *dev,
 128                                  struct device_attribute *attr, char *buf)
 129 {
 130         struct iio_dev *indio_dev = dev_to_iio_dev(dev);
 131         struct ad7606_state *st = iio_priv(indio_dev);
 132
 133         return sprintf(buf, "%u\n", st->range);
 134 }
 135
 136 static ssize_t ad7606_store_range(struct device *dev,
 137                                   struct device_attribute *attr,
 138                                   const char *buf, size_t count)
 139 {
 140         struct iio_dev *indio_dev = dev_to_iio_dev(dev);
 141         struct ad7606_state *st = iio_priv(indio_dev);
 142         unsigned long lval;
 143         int ret;
 144
 145         ret = kstrtoul(buf, 10, &lval);
 146         if (ret)
 147                 return ret;
 148
 149         if (!(lval == 5000 || lval == 10000))
 150                 return -EINVAL;
 151
 152         mutex_lock(&indio_dev->mlock);
 153         gpio_set_value(st->pdata->gpio_range, lval == 10000);
 154         st->range = lval;
 155         mutex_unlock(&indio_dev->mlock);
 156
 157         return count;
 158 }
 159
 160 static IIO_DEVICE_ATTR(in_voltage_range, S_IRUGO | S_IWUSR,
 161                        ad7606_show_range, ad7606_store_range, 0);
 162 static IIO_CONST_ATTR(in_voltage_range_available, "5000 10000");
 163
 164 static int ad7606_oversampling_get_index(unsigned int val)
 165 {
 166         unsigned char supported[] = {1, 2, 4, 8, 16, 32, 64};
 167         int i;
 168
 169         for (i = 0; i < ARRAY_SIZE(supported); i++)
 170                 if (val == supported[i])
 171                         return i;
 172
 173         return -EINVAL;
 174 }
 175
 176 static int ad7606_write_raw(struct iio_dev *indio_dev,
 177                             struct iio_chan_spec const *chan,
 178                             int val,
 179                             int val2,
 180                             long mask)
 181 {
 182         struct ad7606_state *st = iio_priv(indio_dev);
 183         int ret;
 184
 185         switch (mask) {
 186         case IIO_CHAN_INFO_OVERSAMPLING_RATIO:
 187                 if (val2)
 188                         return -EINVAL;
 189                 ret = ad7606_oversampling_get_index(val);
 190                 if (ret < 0)
 191                         return ret;
 192
 193                 mutex_lock(&indio_dev->mlock);
 194                 gpio_set_value(st->pdata->gpio_os0, (ret >> 0) & 1);
 195                 gpio_set_value(st->pdata->gpio_os1, (ret >> 1) & 1);
 196                 gpio_set_value(st->pdata->gpio_os2, (ret >> 2) & 1);
 197                 st->oversampling = val;
 198                 mutex_unlock(&indio_dev->mlock);
 199                 return 0;
 200         default:
 201                 return -EINVAL;
 202         }
 203 }
 204
 205 static IIO_CONST_ATTR(oversampling_ratio_available, "1 2 4 8 16 32 64");
 206
 207 static struct attribute *ad7606_attributes_os_and_range[] = {
 208         &iio_dev_attr_in_voltage_range.dev_attr.attr,
 209         &iio_const_attr_in_voltage_range_available.dev_attr.attr,
 210         &iio_const_attr_oversampling_ratio_available.dev_attr.attr,
 211         NULL,
 212 };
 213
 214 static const struct attribute_group ad7606_attribute_group_os_and_range = {
 215         .attrs = ad7606_attributes_os_and_range,
 216 };
 217
 218 static struct attribute *ad7606_attributes_os[] = {
 219         &iio_const_attr_oversampling_ratio_available.dev_attr.attr,
 220         NULL,
 221 };
 222
 223 static const struct attribute_group ad7606_attribute_group_os = {
 224         .attrs = ad7606_attributes_os,
 225 };
 226
 227 static struct attribute *ad7606_attributes_range[] = {
 228         &iio_dev_attr_in_voltage_range.dev_attr.attr,
 229         &iio_const_attr_in_voltage_range_available.dev_attr.attr,
 230         NULL,
 231 };
 232
 233 static const struct attribute_group ad7606_attribute_group_range = {
 234         .attrs = ad7606_attributes_range,
 235 };
 236
 237 #define AD7606_CHANNEL(num)                                     \
 238         {                                                       \
 239                 .type = IIO_VOLTAGE,                            \
 240                 .indexed = 1,                                   \
 241                 .channel = num,                                 \
 242                 .address = num,                                 \
 243                 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),   \
 244                 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE),\
 245                 .info_mask_shared_by_all =                      \
 246                         BIT(IIO_CHAN_INFO_OVERSAMPLING_RATIO),  \
 247                 .scan_index = num,                              \
 248                 .scan_type = {                                  \
 249                         .sign = 's',                            \
 250                         .realbits = 16,                         \
 251                         .storagebits = 16,                      \
 252                         .endianness = IIO_CPU,                  \
 253                 },                                              \
 254         }
 255
 256 static const struct iio_chan_spec ad7606_channels[] = {
 257         IIO_CHAN_SOFT_TIMESTAMP(8),
 258         AD7606_CHANNEL(0),
 259         AD7606_CHANNEL(1),
 260         AD7606_CHANNEL(2),
 261         AD7606_CHANNEL(3),
 262         AD7606_CHANNEL(4),
 263         AD7606_CHANNEL(5),
 264         AD7606_CHANNEL(6),
 265         AD7606_CHANNEL(7),
 266 };
 267
 268 static const struct ad7606_chip_info ad7606_chip_info_tbl[] = {
 269         /*
 270          * More devices added in future
 271          */
 272         [ID_AD7606_8] = {
 273                 .channels = ad7606_channels,
 274                 .num_channels = 9,
 275         },
 276         [ID_AD7606_6] = {
 277                 .channels = ad7606_channels,
 278                 .num_channels = 7,
 279         },
 280         [ID_AD7606_4] = {
 281                 .channels = ad7606_channels,
 282                 .num_channels = 5,
 283         },
 284 };
 285
 286 static int ad7606_request_gpios(struct ad7606_state *st)
 287 {
 288         struct gpio gpio_array[3] = {
 289                 [0] = {
 290                         .gpio =  st->pdata->gpio_os0,
 291                         .flags = GPIOF_DIR_OUT | ((st->oversampling & 1) ?
 292                                  GPIOF_INIT_HIGH : GPIOF_INIT_LOW),
 293                         .label = "AD7606_OS0",
 294                 },
 295                 [1] = {
 296                         .gpio =  st->pdata->gpio_os1,
 297                         .flags = GPIOF_DIR_OUT | ((st->oversampling & 2) ?
 298                                  GPIOF_INIT_HIGH : GPIOF_INIT_LOW),
 299                         .label = "AD7606_OS1",
 300                 },
 301                 [2] = {
 302                         .gpio =  st->pdata->gpio_os2,
 303                         .flags = GPIOF_DIR_OUT | ((st->oversampling & 4) ?
 304                                  GPIOF_INIT_HIGH : GPIOF_INIT_LOW),
 305                         .label = "AD7606_OS2",
 306                 },
 307         };
 308         int ret;
 309
 310         if (gpio_is_valid(st->pdata->gpio_convst)) {
 311                 ret = gpio_request_one(st->pdata->gpio_convst,
 312                                        GPIOF_OUT_INIT_LOW,
 313                                        "AD7606_CONVST");
 314                 if (ret) {
 315                         dev_err(st->dev, "failed to request GPIO CONVST\n");
 316                         goto error_ret;
 317                 }
 318         } else {
 319                 ret = -EIO;
 320                 goto error_ret;
 321         }
 322
 323         if (gpio_is_valid(st->pdata->gpio_os0) &&
 324             gpio_is_valid(st->pdata->gpio_os1) &&
 325             gpio_is_valid(st->pdata->gpio_os2)) {
 326                 ret = gpio_request_array(gpio_array, ARRAY_SIZE(gpio_array));
 327                 if (ret < 0)
 328                         goto error_free_convst;
 329         }
 330
 331         if (gpio_is_valid(st->pdata->gpio_reset)) {
 332                 ret = gpio_request_one(st->pdata->gpio_reset,
 333                                        GPIOF_OUT_INIT_LOW,
 334                                        "AD7606_RESET");
 335                 if (ret < 0)
 336                         goto error_free_os;
 337         }
 338
 339         if (gpio_is_valid(st->pdata->gpio_range)) {
 340                 ret = gpio_request_one(st->pdata->gpio_range, GPIOF_DIR_OUT |
 341                                        ((st->range == 10000) ? GPIOF_INIT_HIGH :
 342                                         GPIOF_INIT_LOW), "AD7606_RANGE");
 343                 if (ret < 0)
 344                         goto error_free_reset;
 345         }
 346         if (gpio_is_valid(st->pdata->gpio_stby)) {
 347                 ret = gpio_request_one(st->pdata->gpio_stby,
 348                                        GPIOF_OUT_INIT_HIGH,
 349                                        "AD7606_STBY");
 350                 if (ret < 0)
 351                         goto error_free_range;
 352         }
 353
 354         if (gpio_is_valid(st->pdata->gpio_frstdata)) {
 355                 ret = gpio_request_one(st->pdata->gpio_frstdata, GPIOF_IN,
 356                                        "AD7606_FRSTDATA");
 357                 if (ret < 0)
 358                         goto error_free_stby;
 359         }
 360
 361         return 0;
 362
 363 error_free_stby:
 364         if (gpio_is_valid(st->pdata->gpio_stby))
 365                 gpio_free(st->pdata->gpio_stby);
 366 error_free_range:
 367         if (gpio_is_valid(st->pdata->gpio_range))
 368                 gpio_free(st->pdata->gpio_range);
 369 error_free_reset:
 370         if (gpio_is_valid(st->pdata->gpio_reset))
 371                 gpio_free(st->pdata->gpio_reset);
 372 error_free_os:
 373         if (gpio_is_valid(st->pdata->gpio_os0) &&
 374             gpio_is_valid(st->pdata->gpio_os1) &&
 375             gpio_is_valid(st->pdata->gpio_os2))
 376                 gpio_free_array(gpio_array, ARRAY_SIZE(gpio_array));
 377 error_free_convst:
 378         gpio_free(st->pdata->gpio_convst);
 379 error_ret:
 380         return ret;
 381 }
 382
 383 static void ad7606_free_gpios(struct ad7606_state *st)
 384 {
 385         if (gpio_is_valid(st->pdata->gpio_frstdata))
 386                 gpio_free(st->pdata->gpio_frstdata);
 387         if (gpio_is_valid(st->pdata->gpio_stby))
 388                 gpio_free(st->pdata->gpio_stby);
 389         if (gpio_is_valid(st->pdata->gpio_range))
 390                 gpio_free(st->pdata->gpio_range);
 391         if (gpio_is_valid(st->pdata->gpio_reset))
 392                 gpio_free(st->pdata->gpio_reset);
 393         if (gpio_is_valid(st->pdata->gpio_os0) &&
 394             gpio_is_valid(st->pdata->gpio_os1) &&
 395             gpio_is_valid(st->pdata->gpio_os2)) {
 396                 gpio_free(st->pdata->gpio_os2);
 397                 gpio_free(st->pdata->gpio_os1);
 398                 gpio_free(st->pdata->gpio_os0);
 399         }
 400         gpio_free(st->pdata->gpio_convst);
 401 }
 402
 403 /**
 404  *  Interrupt handler
 405  */
 406 static irqreturn_t ad7606_interrupt(int irq, void *dev_id)
 407 {
 408         struct iio_dev *indio_dev = dev_id;
 409         struct ad7606_state *st = iio_priv(indio_dev);
 410
 411         if (iio_buffer_enabled(indio_dev)) {
 412                 schedule_work(&st->poll_work);
 413         } else {
 414                 st->done = true;
 415                 wake_up_interruptible(&st->wq_data_avail);
 416         }
 417
 418         return IRQ_HANDLED;
 419 };
 420
 421 static const struct iio_info ad7606_info_no_os_or_range = {
 422         .driver_module = THIS_MODULE,
 423         .read_raw = &ad7606_read_raw,
 424 };
 425
 426 static const struct iio_info ad7606_info_os_and_range = {
 427         .driver_module = THIS_MODULE,
 428         .read_raw = &ad7606_read_raw,
 429         .write_raw = &ad7606_write_raw,
 430         .attrs = &ad7606_attribute_group_os_and_range,
 431 };
 432
 433 static const struct iio_info ad7606_info_os = {
 434         .driver_module = THIS_MODULE,
 435         .read_raw = &ad7606_read_raw,
 436         .write_raw = &ad7606_write_raw,
 437         .attrs = &ad7606_attribute_group_os,
 438 };
 439
 440 static const struct iio_info ad7606_info_range = {
 441         .driver_module = THIS_MODULE,
 442         .read_raw = &ad7606_read_raw,
 443         .attrs = &ad7606_attribute_group_range,
 444 };
 445
 446 struct iio_dev *ad7606_probe(struct device *dev, int irq,
 447                              void __iomem *base_address,
 448                              const char *name, unsigned int id,
 449                              const struct ad7606_bus_ops *bops)
 450 {
 451         struct ad7606_platform_data *pdata = dev->platform_data;
 452         struct ad7606_state *st;
 453         int ret;
 454         struct iio_dev *indio_dev;
 455
 456         indio_dev = devm_iio_device_alloc(dev, sizeof(*st));
 457         if (!indio_dev)
 458                 return ERR_PTR(-ENOMEM);
 459
 460         st = iio_priv(indio_dev);
 461
 462         st->dev = dev;
 463         st->bops = bops;
 464         st->base_address = base_address;
 465         st->range = 5000;
 466         st->oversampling = 1;
 467
 468         st->reg = devm_regulator_get(dev, "vcc");
 469         if (!IS_ERR(st->reg)) {
 470                 ret = regulator_enable(st->reg);
 471                 if (ret)
 472                         return ERR_PTR(ret);
 473         }
 474
 475         st->pdata = pdata;
 476         st->chip_info = &ad7606_chip_info_tbl[id];
 477
 478         indio_dev->dev.parent = dev;
 479         if (gpio_is_valid(st->pdata->gpio_os0) &&
 480             gpio_is_valid(st->pdata->gpio_os1) &&
 481             gpio_is_valid(st->pdata->gpio_os2)) {
 482                 if (gpio_is_valid(st->pdata->gpio_range))
 483                         indio_dev->info = &ad7606_info_os_and_range;
 484                 else
 485                         indio_dev->info = &ad7606_info_os;
 486         } else {
 487                 if (gpio_is_valid(st->pdata->gpio_range))
 488                         indio_dev->info = &ad7606_info_range;
 489                 else
 490                         indio_dev->info = &ad7606_info_no_os_or_range;
 491         }
 492         indio_dev->modes = INDIO_DIRECT_MODE;
 493         indio_dev->name = name;
 494         indio_dev->channels = st->chip_info->channels;
 495         indio_dev->num_channels = st->chip_info->num_channels;
 496
 497         init_waitqueue_head(&st->wq_data_avail);
 498
 499         ret = ad7606_request_gpios(st);
 500         if (ret)
 501                 goto error_disable_reg;
 502
 503         ret = ad7606_reset(st);
 504         if (ret)
 505                 dev_warn(st->dev, "failed to RESET: no RESET GPIO specified\n");
 506
 507         ret = request_irq(irq, ad7606_interrupt, IRQF_TRIGGER_FALLING, name,
 508                           indio_dev);
 509         if (ret)
 510                 goto error_free_gpios;
 511
 512         ret = ad7606_register_ring_funcs_and_init(indio_dev);
 513         if (ret)
 514                 goto error_free_irq;
 515
 516         ret = iio_device_register(indio_dev);
 517         if (ret)
 518                 goto error_unregister_ring;
 519
 520         dev_set_drvdata(dev, indio_dev);
 521
 522         return indio_dev;
 523 error_unregister_ring:
 524         ad7606_ring_cleanup(indio_dev);
 525
 526 error_free_irq:
 527         free_irq(irq, indio_dev);
 528
 529 error_free_gpios:
 530         ad7606_free_gpios(st);
 531
 532 error_disable_reg:
 533         if (!IS_ERR(st->reg))
 534                 regulator_disable(st->reg);
 535         return ERR_PTR(ret);
 536 }
 537 EXPORT_SYMBOL_GPL(ad7606_probe);
 538
 539 int ad7606_remove(struct iio_dev *indio_dev, int irq)
 540 {
 541         struct ad7606_state *st = iio_priv(indio_dev);
 542
 543         iio_device_unregister(indio_dev);
 544         ad7606_ring_cleanup(indio_dev);
 545
 546         free_irq(irq, indio_dev);
 547         if (!IS_ERR(st->reg))
 548                 regulator_disable(st->reg);
 549
 550         ad7606_free_gpios(st);
 551
 552         return 0;
 553 }
 554 EXPORT_SYMBOL_GPL(ad7606_remove);
 555
 556 #ifdef CONFIG_PM_SLEEP
 557
 558 static int ad7606_suspend(struct device *dev)
 559 {
 560         struct iio_dev *indio_dev = dev_get_drvdata(dev);
 561         struct ad7606_state *st = iio_priv(indio_dev);
 562
 563         if (gpio_is_valid(st->pdata->gpio_stby)) {
 564                 if (gpio_is_valid(st->pdata->gpio_range))
 565                         gpio_set_value(st->pdata->gpio_range, 1);
 566                 gpio_set_value(st->pdata->gpio_stby, 0);
 567         }
 568
 569         return 0;
 570 }
 571
 572 static int ad7606_resume(struct device *dev)
 573 {
 574         struct iio_dev *indio_dev = dev_get_drvdata(dev);
 575         struct ad7606_state *st = iio_priv(indio_dev);
 576
 577         if (gpio_is_valid(st->pdata->gpio_stby)) {
 578                 if (gpio_is_valid(st->pdata->gpio_range))
 579                         gpio_set_value(st->pdata->gpio_range,
 580                                        st->range == 10000);
 581
 582                 gpio_set_value(st->pdata->gpio_stby, 1);
 583                 ad7606_reset(st);
 584         }
 585
 586         return 0;
 587 }
 588
 589 SIMPLE_DEV_PM_OPS(ad7606_pm_ops, ad7606_suspend, ad7606_resume);
 590 EXPORT_SYMBOL_GPL(ad7606_pm_ops);
 591
 592 #endif
 593
 594 MODULE_AUTHOR("Michael Hennerich <hennerich@blackfin.uclinux.org>");
 595 MODULE_DESCRIPTION("Analog Devices AD7606 ADC");
 596 MODULE_LICENSE("GPL v2");