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