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