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                 .channels = ad7606_channels,
 264                 .num_channels = 9,
 265         },
 266         [ID_AD7606_6] = {
 267                 .channels = ad7606_channels,
 268                 .num_channels = 7,
 269         },
 270         [ID_AD7606_4] = {
 271                 .channels = ad7606_channels,
 272                 .num_channels = 5,
 273         },
 274 };
 275
 276 static int ad7606_request_gpios(struct ad7606_state *st)
 277 {
 278         struct gpio gpio_array[3] = {
 279                 [0] = {
 280                         .gpio =  st->pdata->gpio_os0,
 281                         .flags = GPIOF_DIR_OUT | ((st->oversampling & 1) ?
 282                                  GPIOF_INIT_HIGH : GPIOF_INIT_LOW),
 283                         .label = "AD7606_OS0",
 284                 },
 285                 [1] = {
 286                         .gpio =  st->pdata->gpio_os1,
 287                         .flags = GPIOF_DIR_OUT | ((st->oversampling & 2) ?
 288                                  GPIOF_INIT_HIGH : GPIOF_INIT_LOW),
 289                         .label = "AD7606_OS1",
 290                 },
 291                 [2] = {
 292                         .gpio =  st->pdata->gpio_os2,
 293                         .flags = GPIOF_DIR_OUT | ((st->oversampling & 4) ?
 294                                  GPIOF_INIT_HIGH : GPIOF_INIT_LOW),
 295                         .label = "AD7606_OS2",
 296                 },
 297         };
 298         int ret;
 299
 300         if (gpio_is_valid(st->pdata->gpio_convst)) {
 301                 ret = gpio_request_one(st->pdata->gpio_convst,
 302                                        GPIOF_OUT_INIT_LOW,
 303                                        "AD7606_CONVST");
 304                 if (ret) {
 305                         dev_err(st->dev, "failed to request GPIO CONVST\n");
 306                         goto error_ret;
 307                 }
 308         } else {
 309                 ret = -EIO;
 310                 goto error_ret;
 311         }
 312
 313         if (gpio_is_valid(st->pdata->gpio_os0) &&
 314             gpio_is_valid(st->pdata->gpio_os1) &&
 315             gpio_is_valid(st->pdata->gpio_os2)) {
 316                 ret = gpio_request_array(gpio_array, ARRAY_SIZE(gpio_array));
 317                 if (ret < 0)
 318                         goto error_free_convst;
 319         }
 320
 321         if (gpio_is_valid(st->pdata->gpio_reset)) {
 322                 ret = gpio_request_one(st->pdata->gpio_reset,
 323                                        GPIOF_OUT_INIT_LOW,
 324                                        "AD7606_RESET");
 325                 if (ret < 0)
 326                         goto error_free_os;
 327         }
 328
 329         if (gpio_is_valid(st->pdata->gpio_range)) {
 330                 ret = gpio_request_one(st->pdata->gpio_range, GPIOF_DIR_OUT |
 331                                        ((st->range == 10000) ? GPIOF_INIT_HIGH :
 332                                         GPIOF_INIT_LOW), "AD7606_RANGE");
 333                 if (ret < 0)
 334                         goto error_free_reset;
 335         }
 336         if (gpio_is_valid(st->pdata->gpio_stby)) {
 337                 ret = gpio_request_one(st->pdata->gpio_stby,
 338                                        GPIOF_OUT_INIT_HIGH,
 339                                        "AD7606_STBY");
 340                 if (ret < 0)
 341                         goto error_free_range;
 342         }
 343
 344         if (gpio_is_valid(st->pdata->gpio_frstdata)) {
 345                 ret = gpio_request_one(st->pdata->gpio_frstdata, GPIOF_IN,
 346                                        "AD7606_FRSTDATA");
 347                 if (ret < 0)
 348                         goto error_free_stby;
 349         }
 350
 351         return 0;
 352
 353 error_free_stby:
 354         if (gpio_is_valid(st->pdata->gpio_stby))
 355                 gpio_free(st->pdata->gpio_stby);
 356 error_free_range:
 357         if (gpio_is_valid(st->pdata->gpio_range))
 358                 gpio_free(st->pdata->gpio_range);
 359 error_free_reset:
 360         if (gpio_is_valid(st->pdata->gpio_reset))
 361                 gpio_free(st->pdata->gpio_reset);
 362 error_free_os:
 363         if (gpio_is_valid(st->pdata->gpio_os0) &&
 364             gpio_is_valid(st->pdata->gpio_os1) &&
 365             gpio_is_valid(st->pdata->gpio_os2))
 366                 gpio_free_array(gpio_array, ARRAY_SIZE(gpio_array));
 367 error_free_convst:
 368         gpio_free(st->pdata->gpio_convst);
 369 error_ret:
 370         return ret;
 371 }
 372
 373 static void ad7606_free_gpios(struct ad7606_state *st)
 374 {
 375         if (gpio_is_valid(st->pdata->gpio_frstdata))
 376                 gpio_free(st->pdata->gpio_frstdata);
 377         if (gpio_is_valid(st->pdata->gpio_stby))
 378                 gpio_free(st->pdata->gpio_stby);
 379         if (gpio_is_valid(st->pdata->gpio_range))
 380                 gpio_free(st->pdata->gpio_range);
 381         if (gpio_is_valid(st->pdata->gpio_reset))
 382                 gpio_free(st->pdata->gpio_reset);
 383         if (gpio_is_valid(st->pdata->gpio_os0) &&
 384             gpio_is_valid(st->pdata->gpio_os1) &&
 385             gpio_is_valid(st->pdata->gpio_os2)) {
 386                 gpio_free(st->pdata->gpio_os2);
 387                 gpio_free(st->pdata->gpio_os1);
 388                 gpio_free(st->pdata->gpio_os0);
 389         }
 390         gpio_free(st->pdata->gpio_convst);
 391 }
 392
 393 /**
 394  *  Interrupt handler
 395  */
 396 static irqreturn_t ad7606_interrupt(int irq, void *dev_id)
 397 {
 398         struct iio_dev *indio_dev = dev_id;
 399         struct ad7606_state *st = iio_priv(indio_dev);
 400
 401         if (iio_buffer_enabled(indio_dev)) {
 402                 schedule_work(&st->poll_work);
 403         } else {
 404                 st->done = true;
 405                 wake_up_interruptible(&st->wq_data_avail);
 406         }
 407
 408         return IRQ_HANDLED;
 409 };
 410
 411 static const struct iio_info ad7606_info_no_os_or_range = {
 412         .driver_module = THIS_MODULE,
 413         .read_raw = &ad7606_read_raw,
 414 };
 415
 416 static const struct iio_info ad7606_info_os_and_range = {
 417         .driver_module = THIS_MODULE,
 418         .read_raw = &ad7606_read_raw,
 419         .write_raw = &ad7606_write_raw,
 420         .attrs = &ad7606_attribute_group_os_and_range,
 421 };
 422
 423 static const struct iio_info ad7606_info_os = {
 424         .driver_module = THIS_MODULE,
 425         .read_raw = &ad7606_read_raw,
 426         .write_raw = &ad7606_write_raw,
 427         .attrs = &ad7606_attribute_group_os,
 428 };
 429
 430 static const struct iio_info ad7606_info_range = {
 431         .driver_module = THIS_MODULE,
 432         .read_raw = &ad7606_read_raw,
 433         .attrs = &ad7606_attribute_group_range,
 434 };
 435
 436 struct iio_dev *ad7606_probe(struct device *dev, int irq,
 437                              void __iomem *base_address,
 438                              const char *name, unsigned int id,
 439                              const struct ad7606_bus_ops *bops)
 440 {
 441         struct ad7606_platform_data *pdata = dev->platform_data;
 442         struct ad7606_state *st;
 443         int ret;
 444         struct iio_dev *indio_dev;
 445
 446         indio_dev = devm_iio_device_alloc(dev, sizeof(*st));
 447         if (!indio_dev)
 448                 return ERR_PTR(-ENOMEM);
 449
 450         st = iio_priv(indio_dev);
 451
 452         st->dev = dev;
 453         st->bops = bops;
 454         st->base_address = base_address;
 455         st->range = 5000;
 456         st->oversampling = 0;
 457
 458         st->reg = devm_regulator_get(dev, "vcc");
 459         if (!IS_ERR(st->reg)) {
 460                 ret = regulator_enable(st->reg);
 461                 if (ret)
 462                         return ERR_PTR(ret);
 463         }
 464
 465         st->pdata = pdata;
 466         st->chip_info = &ad7606_chip_info_tbl[id];
 467
 468         indio_dev->dev.parent = dev;
 469         if (gpio_is_valid(st->pdata->gpio_os0) &&
 470             gpio_is_valid(st->pdata->gpio_os1) &&
 471             gpio_is_valid(st->pdata->gpio_os2)) {
 472                 if (gpio_is_valid(st->pdata->gpio_range))
 473                         indio_dev->info = &ad7606_info_os_and_range;
 474                 else
 475                         indio_dev->info = &ad7606_info_os;
 476         } else {
 477                 if (gpio_is_valid(st->pdata->gpio_range))
 478                         indio_dev->info = &ad7606_info_range;
 479                 else
 480                         indio_dev->info = &ad7606_info_no_os_or_range;
 481         }
 482         indio_dev->modes = INDIO_DIRECT_MODE;
 483         indio_dev->name = name;
 484         indio_dev->channels = st->chip_info->channels;
 485         indio_dev->num_channels = st->chip_info->num_channels;
 486
 487         init_waitqueue_head(&st->wq_data_avail);
 488
 489         ret = ad7606_request_gpios(st);
 490         if (ret)
 491                 goto error_disable_reg;
 492
 493         ret = ad7606_reset(st);
 494         if (ret)
 495                 dev_warn(st->dev, "failed to RESET: no RESET GPIO specified\n");
 496
 497         ret = request_irq(irq, ad7606_interrupt, IRQF_TRIGGER_FALLING, name,
 498                           indio_dev);
 499         if (ret)
 500                 goto error_free_gpios;
 501
 502         ret = ad7606_register_ring_funcs_and_init(indio_dev);
 503         if (ret)
 504                 goto error_free_irq;
 505
 506         ret = iio_device_register(indio_dev);
 507         if (ret)
 508                 goto error_unregister_ring;
 509
 510         return indio_dev;
 511 error_unregister_ring:
 512         ad7606_ring_cleanup(indio_dev);
 513
 514 error_free_irq:
 515         free_irq(irq, indio_dev);
 516
 517 error_free_gpios:
 518         ad7606_free_gpios(st);
 519
 520 error_disable_reg:
 521         if (!IS_ERR(st->reg))
 522                 regulator_disable(st->reg);
 523         return ERR_PTR(ret);
 524 }
 525 EXPORT_SYMBOL_GPL(ad7606_probe);
 526
 527 int ad7606_remove(struct iio_dev *indio_dev, int irq)
 528 {
 529         struct ad7606_state *st = iio_priv(indio_dev);
 530
 531         iio_device_unregister(indio_dev);
 532         ad7606_ring_cleanup(indio_dev);
 533
 534         free_irq(irq, indio_dev);
 535         if (!IS_ERR(st->reg))
 536                 regulator_disable(st->reg);
 537
 538         ad7606_free_gpios(st);
 539
 540         return 0;
 541 }
 542 EXPORT_SYMBOL_GPL(ad7606_remove);
 543
 544 #ifdef CONFIG_PM_SLEEP
 545
 546 static int ad7606_suspend(struct device *dev)
 547 {
 548         struct iio_dev *indio_dev = dev_get_drvdata(dev);
 549         struct ad7606_state *st = iio_priv(indio_dev);
 550
 551         if (gpio_is_valid(st->pdata->gpio_stby)) {
 552                 if (gpio_is_valid(st->pdata->gpio_range))
 553                         gpio_set_value(st->pdata->gpio_range, 1);
 554                 gpio_set_value(st->pdata->gpio_stby, 0);
 555         }
 556
 557         return 0;
 558 }
 559
 560 static int ad7606_resume(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,
 568                                        st->range == 10000);
 569
 570                 gpio_set_value(st->pdata->gpio_stby, 1);
 571                 ad7606_reset(st);
 572         }
 573
 574         return 0;
 575 }
 576
 577 SIMPLE_DEV_PM_OPS(ad7606_pm_ops, ad7606_suspend, ad7606_resume);
 578 EXPORT_SYMBOL_GPL(ad7606_pm_ops);
 579
 580 #endif
 581
 582 MODULE_AUTHOR("Michael Hennerich <hennerich@blackfin.uclinux.org>");
 583 MODULE_DESCRIPTION("Analog Devices AD7606 ADC");
 584 MODULE_LICENSE("GPL v2");