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