drivers/staging/iio/meter/ade7759.c

   1 /*
   2  * ADE7759 Active Energy Metering IC with di/dt Sensor Interface Driver
   3  *
   4  * Copyright 2010 Analog Devices Inc.
   5  *
   6  * Licensed under the GPL-2 or later.
   7  */
   8
   9 #include <linux/interrupt.h>
  10 #include <linux/irq.h>
  11 #include <linux/gpio.h>
  12 #include <linux/delay.h>
  13 #include <linux/mutex.h>
  14 #include <linux/device.h>
  15 #include <linux/kernel.h>
  16 #include <linux/spi/spi.h>
  17 #include <linux/slab.h>
  18 #include <linux/sysfs.h>
  19 #include <linux/list.h>
  20
  21 #include "../iio.h"
  22 #include "../sysfs.h"
  23 #include "meter.h"
  24 #include "ade7759.h"
  25
  26 static int ade7759_spi_write_reg_8(struct device *dev,
  27                 u8 reg_address,
  28                 u8 val)
  29 {
  30         int ret;
  31         struct iio_dev *indio_dev = dev_get_drvdata(dev);
  32         struct ade7759_state *st = iio_dev_get_devdata(indio_dev);
  33
  34         mutex_lock(&st->buf_lock);
  35         st->tx[0] = ADE7759_WRITE_REG(reg_address);
  36         st->tx[1] = val;
  37
  38         ret = spi_write(st->us, st->tx, 2);
  39         mutex_unlock(&st->buf_lock);
  40
  41         return ret;
  42 }
  43
  44 static int ade7759_spi_write_reg_16(struct device *dev,
  45                 u8 reg_address,
  46                 u16 value)
  47 {
  48         int ret;
  49         struct iio_dev *indio_dev = dev_get_drvdata(dev);
  50         struct ade7759_state *st = iio_dev_get_devdata(indio_dev);
  51
  52         mutex_lock(&st->buf_lock);
  53         st->tx[0] = ADE7759_WRITE_REG(reg_address);
  54         st->tx[1] = (value >> 8) & 0xFF;
  55         st->tx[2] = value & 0xFF;
  56         ret = spi_write(st->us, st->tx, 3);
  57         mutex_unlock(&st->buf_lock);
  58
  59         return ret;
  60 }
  61
  62 static int ade7759_spi_read_reg_8(struct device *dev,
  63                 u8 reg_address,
  64                 u8 *val)
  65 {
  66         struct iio_dev *indio_dev = dev_get_drvdata(dev);
  67         struct ade7759_state *st = iio_dev_get_devdata(indio_dev);
  68         int ret;
  69
  70         ret = spi_w8r8(st->us, ADE7759_READ_REG(reg_address));
  71         if (ret < 0) {
  72                 dev_err(&st->us->dev, "problem when reading 8 bit register 0x%02X",
  73                                 reg_address);
  74                 return ret;
  75         }
  76         *val = ret;
  77
  78         return 0;
  79 }
  80
  81 static int ade7759_spi_read_reg_16(struct device *dev,
  82                 u8 reg_address,
  83                 u16 *val)
  84 {
  85         struct iio_dev *indio_dev = dev_get_drvdata(dev);
  86         struct ade7759_state *st = iio_dev_get_devdata(indio_dev);
  87         int ret;
  88
  89         ret = spi_w8r16(st->us, ADE7759_READ_REG(reg_address));
  90         if (ret < 0) {
  91                 dev_err(&st->us->dev, "problem when reading 16 bit register 0x%02X",
  92                         reg_address);
  93                 return ret;
  94         }
  95
  96         *val = ret;
  97         *val = be16_to_cpup(val);
  98
  99         return 0;
 100 }
 101
 102 static int ade7759_spi_read_reg_40(struct device *dev,
 103                 u8 reg_address,
 104                 u64 *val)
 105 {
 106         struct spi_message msg;
 107         struct iio_dev *indio_dev = dev_get_drvdata(dev);
 108         struct ade7759_state *st = iio_dev_get_devdata(indio_dev);
 109         int ret;
 110         struct spi_transfer xfers[] = {
 111                 {
 112                         .tx_buf = st->tx,
 113                         .rx_buf = st->rx,
 114                         .bits_per_word = 8,
 115                         .len = 6,
 116                 },
 117         };
 118
 119         mutex_lock(&st->buf_lock);
 120         st->tx[0] = ADE7759_READ_REG(reg_address);
 121         memset(&st->tx[1], 0 , 5);
 122
 123         spi_message_init(&msg);
 124         spi_message_add_tail(xfers, &msg);
 125         ret = spi_sync(st->us, &msg);
 126         if (ret) {
 127                 dev_err(&st->us->dev, "problem when reading 40 bit register 0x%02X",
 128                                 reg_address);
 129                 goto error_ret;
 130         }
 131         *val = ((u64)st->rx[1] << 32) | (st->rx[2] << 24) |
 132                 (st->rx[3] << 16) | (st->rx[4] << 8) | st->rx[5];
 133
 134 error_ret:
 135         mutex_unlock(&st->buf_lock);
 136         return ret;
 137 }
 138
 139 static ssize_t ade7759_read_8bit(struct device *dev,
 140                 struct device_attribute *attr,
 141                 char *buf)
 142 {
 143         int ret;
 144         u8 val = 0;
 145         struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
 146
 147         ret = ade7759_spi_read_reg_8(dev, this_attr->address, &val);
 148         if (ret)
 149                 return ret;
 150
 151         return sprintf(buf, "%u\n", val);
 152 }
 153
 154 static ssize_t ade7759_read_16bit(struct device *dev,
 155                 struct device_attribute *attr,
 156                 char *buf)
 157 {
 158         int ret;
 159         u16 val = 0;
 160         struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
 161
 162         ret = ade7759_spi_read_reg_16(dev, this_attr->address, &val);
 163         if (ret)
 164                 return ret;
 165
 166         return sprintf(buf, "%u\n", val);
 167 }
 168
 169 static ssize_t ade7759_read_40bit(struct device *dev,
 170                 struct device_attribute *attr,
 171                 char *buf)
 172 {
 173         int ret;
 174         u64 val = 0;
 175         struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
 176
 177         ret = ade7759_spi_read_reg_40(dev, this_attr->address, &val);
 178         if (ret)
 179                 return ret;
 180
 181         return sprintf(buf, "%llu\n", val);
 182 }
 183
 184 static ssize_t ade7759_write_8bit(struct device *dev,
 185                 struct device_attribute *attr,
 186                 const char *buf,
 187                 size_t len)
 188 {
 189         struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
 190         int ret;
 191         long val;
 192
 193         ret = strict_strtol(buf, 10, &val);
 194         if (ret)
 195                 goto error_ret;
 196         ret = ade7759_spi_write_reg_8(dev, this_attr->address, val);
 197
 198 error_ret:
 199         return ret ? ret : len;
 200 }
 201
 202 static ssize_t ade7759_write_16bit(struct device *dev,
 203                 struct device_attribute *attr,
 204                 const char *buf,
 205                 size_t len)
 206 {
 207         struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
 208         int ret;
 209         long val;
 210
 211         ret = strict_strtol(buf, 10, &val);
 212         if (ret)
 213                 goto error_ret;
 214         ret = ade7759_spi_write_reg_16(dev, this_attr->address, val);
 215
 216 error_ret:
 217         return ret ? ret : len;
 218 }
 219
 220 static int ade7759_reset(struct device *dev)
 221 {
 222         int ret;
 223         u16 val;
 224         ade7759_spi_read_reg_16(dev,
 225                         ADE7759_MODE,
 226                         &val);
 227         val |= 1 << 6; /* Software Chip Reset */
 228         ret = ade7759_spi_write_reg_16(dev,
 229                         ADE7759_MODE,
 230                         val);
 231
 232         return ret;
 233 }
 234
 235 static ssize_t ade7759_write_reset(struct device *dev,
 236                 struct device_attribute *attr,
 237                 const char *buf, size_t len)
 238 {
 239         if (len < 1)
 240                 return -1;
 241         switch (buf[0]) {
 242         case '1':
 243         case 'y':
 244         case 'Y':
 245                 return ade7759_reset(dev);
 246         }
 247         return -1;
 248 }
 249
 250 static IIO_DEV_ATTR_AENERGY(ade7759_read_40bit, ADE7759_AENERGY);
 251 static IIO_DEV_ATTR_CFDEN(S_IWUSR | S_IRUGO,
 252                 ade7759_read_16bit,
 253                 ade7759_write_16bit,
 254                 ADE7759_CFDEN);
 255 static IIO_DEV_ATTR_CFNUM(S_IWUSR | S_IRUGO,
 256                 ade7759_read_8bit,
 257                 ade7759_write_8bit,
 258                 ADE7759_CFNUM);
 259 static IIO_DEV_ATTR_CHKSUM(ade7759_read_8bit, ADE7759_CHKSUM);
 260 static IIO_DEV_ATTR_PHCAL(S_IWUSR | S_IRUGO,
 261                 ade7759_read_16bit,
 262                 ade7759_write_16bit,
 263                 ADE7759_PHCAL);
 264 static IIO_DEV_ATTR_APOS(S_IWUSR | S_IRUGO,
 265                 ade7759_read_16bit,
 266                 ade7759_write_16bit,
 267                 ADE7759_APOS);
 268 static IIO_DEV_ATTR_SAGCYC(S_IWUSR | S_IRUGO,
 269                 ade7759_read_8bit,
 270                 ade7759_write_8bit,
 271                 ADE7759_SAGCYC);
 272 static IIO_DEV_ATTR_SAGLVL(S_IWUSR | S_IRUGO,
 273                 ade7759_read_8bit,
 274                 ade7759_write_8bit,
 275                 ADE7759_SAGLVL);
 276 static IIO_DEV_ATTR_LINECYC(S_IWUSR | S_IRUGO,
 277                 ade7759_read_8bit,
 278                 ade7759_write_8bit,
 279                 ADE7759_LINECYC);
 280 static IIO_DEV_ATTR_LENERGY(ade7759_read_40bit, ADE7759_LENERGY);
 281 static IIO_DEV_ATTR_PGA_GAIN(S_IWUSR | S_IRUGO,
 282                 ade7759_read_8bit,
 283                 ade7759_write_8bit,
 284                 ADE7759_GAIN);
 285 static IIO_DEV_ATTR_ACTIVE_POWER_GAIN(S_IWUSR | S_IRUGO,
 286                 ade7759_read_16bit,
 287                 ade7759_write_16bit,
 288                 ADE7759_APGAIN);
 289 static IIO_DEV_ATTR_CH_OFF(1, S_IWUSR | S_IRUGO,
 290                 ade7759_read_8bit,
 291                 ade7759_write_8bit,
 292                 ADE7759_CH1OS);
 293 static IIO_DEV_ATTR_CH_OFF(2, S_IWUSR | S_IRUGO,
 294                 ade7759_read_8bit,
 295                 ade7759_write_8bit,
 296                 ADE7759_CH2OS);
 297
 298 static int ade7759_set_irq(struct device *dev, bool enable)
 299 {
 300         int ret;
 301         u8 irqen;
 302         ret = ade7759_spi_read_reg_8(dev, ADE7759_IRQEN, &irqen);
 303         if (ret)
 304                 goto error_ret;
 305
 306         if (enable)
 307                 irqen |= 1 << 3; /* Enables an interrupt when a data is
 308                                     present in the waveform register */
 309         else
 310                 irqen &= ~(1 << 3);
 311
 312         ret = ade7759_spi_write_reg_8(dev, ADE7759_IRQEN, irqen);
 313
 314 error_ret:
 315         return ret;
 316 }
 317
 318 /* Power down the device */
 319 static int ade7759_stop_device(struct device *dev)
 320 {
 321         u16 val;
 322
 323         ade7759_spi_read_reg_16(dev,
 324                         ADE7759_MODE,
 325                         &val);
 326         val |= 1 << 4;  /* AD converters can be turned off */
 327
 328         return ade7759_spi_write_reg_16(dev, ADE7759_MODE, val);
 329 }
 330
 331 static int ade7759_initial_setup(struct ade7759_state *st)
 332 {
 333         int ret;
 334         struct device *dev = &st->indio_dev->dev;
 335
 336         /* use low spi speed for init */
 337         st->us->mode = SPI_MODE_3;
 338         spi_setup(st->us);
 339
 340         /* Disable IRQ */
 341         ret = ade7759_set_irq(dev, false);
 342         if (ret) {
 343                 dev_err(dev, "disable irq failed");
 344                 goto err_ret;
 345         }
 346
 347         ade7759_reset(dev);
 348         msleep(ADE7759_STARTUP_DELAY);
 349
 350 err_ret:
 351         return ret;
 352 }
 353
 354 static ssize_t ade7759_read_frequency(struct device *dev,
 355                 struct device_attribute *attr,
 356                 char *buf)
 357 {
 358         int ret;
 359         u16 t;
 360         int sps;
 361         ret = ade7759_spi_read_reg_16(dev,
 362                         ADE7759_MODE,
 363                         &t);
 364         if (ret)
 365                 return ret;
 366
 367         t = (t >> 3) & 0x3;
 368         sps = 27900 / (1 + t);
 369
 370         return sprintf(buf, "%d\n", sps);
 371 }
 372
 373 static ssize_t ade7759_write_frequency(struct device *dev,
 374                 struct device_attribute *attr,
 375                 const char *buf,
 376                 size_t len)
 377 {
 378         struct iio_dev *indio_dev = dev_get_drvdata(dev);
 379         struct ade7759_state *st = iio_dev_get_devdata(indio_dev);
 380         unsigned long val;
 381         int ret;
 382         u16 reg, t;
 383
 384         ret = strict_strtol(buf, 10, &val);
 385         if (ret)
 386                 return ret;
 387
 388         mutex_lock(&indio_dev->mlock);
 389
 390         t = (27900 / val);
 391         if (t > 0)
 392                 t--;
 393
 394         if (t > 1)
 395                 st->us->max_speed_hz = ADE7759_SPI_SLOW;
 396         else
 397                 st->us->max_speed_hz = ADE7759_SPI_FAST;
 398
 399         ret = ade7759_spi_read_reg_16(dev, ADE7759_MODE, &reg);
 400         if (ret)
 401                 goto out;
 402
 403         reg &= ~(3 << 13);
 404         reg |= t << 13;
 405
 406         ret = ade7759_spi_write_reg_16(dev, ADE7759_MODE, reg);
 407
 408 out:
 409         mutex_unlock(&indio_dev->mlock);
 410
 411         return ret ? ret : len;
 412 }
 413 static IIO_DEV_ATTR_TEMP_RAW(ade7759_read_8bit);
 414 static IIO_CONST_ATTR(temp_offset, "70 C");
 415 static IIO_CONST_ATTR(temp_scale, "1 C");
 416
 417 static IIO_DEV_ATTR_SAMP_FREQ(S_IWUSR | S_IRUGO,
 418                 ade7759_read_frequency,
 419                 ade7759_write_frequency);
 420
 421 static IIO_DEV_ATTR_RESET(ade7759_write_reset);
 422
 423 static IIO_CONST_ATTR_SAMP_FREQ_AVAIL("27900 14000 7000 3500");
 424
 425 static struct attribute *ade7759_attributes[] = {
 426         &iio_dev_attr_temp_raw.dev_attr.attr,
 427         &iio_const_attr_temp_offset.dev_attr.attr,
 428         &iio_const_attr_temp_scale.dev_attr.attr,
 429         &iio_dev_attr_sampling_frequency.dev_attr.attr,
 430         &iio_const_attr_sampling_frequency_available.dev_attr.attr,
 431         &iio_dev_attr_reset.dev_attr.attr,
 432         &iio_dev_attr_phcal.dev_attr.attr,
 433         &iio_dev_attr_cfden.dev_attr.attr,
 434         &iio_dev_attr_aenergy.dev_attr.attr,
 435         &iio_dev_attr_cfnum.dev_attr.attr,
 436         &iio_dev_attr_apos.dev_attr.attr,
 437         &iio_dev_attr_sagcyc.dev_attr.attr,
 438         &iio_dev_attr_saglvl.dev_attr.attr,
 439         &iio_dev_attr_linecyc.dev_attr.attr,
 440         &iio_dev_attr_lenergy.dev_attr.attr,
 441         &iio_dev_attr_chksum.dev_attr.attr,
 442         &iio_dev_attr_pga_gain.dev_attr.attr,
 443         &iio_dev_attr_active_power_gain.dev_attr.attr,
 444         &iio_dev_attr_choff_1.dev_attr.attr,
 445         &iio_dev_attr_choff_2.dev_attr.attr,
 446         NULL,
 447 };
 448
 449 static const struct attribute_group ade7759_attribute_group = {
 450         .attrs = ade7759_attributes,
 451 };
 452
 453 static const struct iio_info ade7759_info = {
 454         .attrs = &ade7759_attribute_group,
 455         .driver_module = THIS_MODULE,
 456 };
 457
 458 static int __devinit ade7759_probe(struct spi_device *spi)
 459 {
 460         int ret;
 461         struct ade7759_state *st = kzalloc(sizeof *st, GFP_KERNEL);
 462         if (!st) {
 463                 ret =  -ENOMEM;
 464                 goto error_ret;
 465         }
 466         /* this is only used for removal purposes */
 467         spi_set_drvdata(spi, st);
 468
 469         /* Allocate the comms buffers */
 470         st->rx = kzalloc(sizeof(*st->rx)*ADE7759_MAX_RX, GFP_KERNEL);
 471         if (st->rx == NULL) {
 472                 ret = -ENOMEM;
 473                 goto error_free_st;
 474         }
 475         st->tx = kzalloc(sizeof(*st->tx)*ADE7759_MAX_TX, GFP_KERNEL);
 476         if (st->tx == NULL) {
 477                 ret = -ENOMEM;
 478                 goto error_free_rx;
 479         }
 480         st->us = spi;
 481         mutex_init(&st->buf_lock);
 482         /* setup the industrialio driver allocated elements */
 483         st->indio_dev = iio_allocate_device(0);
 484         if (st->indio_dev == NULL) {
 485                 ret = -ENOMEM;
 486                 goto error_free_tx;
 487         }
 488
 489         st->indio_dev->name = spi->dev.driver->name;
 490         st->indio_dev->dev.parent = &spi->dev;
 491
 492         st->indio_dev->info = &ade7759_info;
 493         st->indio_dev->dev_data = (void *)(st);
 494         st->indio_dev->modes = INDIO_DIRECT_MODE;
 495
 496         ret = iio_device_register(st->indio_dev);
 497         if (ret)
 498                 goto error_free_dev;
 499
 500         /* Get the device into a sane initial state */
 501         ret = ade7759_initial_setup(st);
 502         if (ret)
 503                 goto error_unreg_dev;
 504         return 0;
 505
 506
 507 error_unreg_dev:
 508         iio_device_unregister(st->indio_dev);
 509 error_free_dev:
 510         iio_free_device(st->indio_dev);
 511 error_free_tx:
 512         kfree(st->tx);
 513 error_free_rx:
 514         kfree(st->rx);
 515 error_free_st:
 516         kfree(st);
 517 error_ret:
 518         return ret;
 519 }
 520
 521 /* fixme, confirm ordering in this function */
 522 static int ade7759_remove(struct spi_device *spi)
 523 {
 524         int ret;
 525         struct ade7759_state *st = spi_get_drvdata(spi);
 526         struct iio_dev *indio_dev = st->indio_dev;
 527
 528         ret = ade7759_stop_device(&(indio_dev->dev));
 529         if (ret)
 530                 goto err_ret;
 531
 532         iio_device_unregister(indio_dev);
 533         kfree(st->tx);
 534         kfree(st->rx);
 535         kfree(st);
 536
 537         return 0;
 538
 539 err_ret:
 540         return ret;
 541 }
 542
 543 static struct spi_driver ade7759_driver = {
 544         .driver = {
 545                 .name = "ade7759",
 546                 .owner = THIS_MODULE,
 547         },
 548         .probe = ade7759_probe,
 549         .remove = __devexit_p(ade7759_remove),
 550 };
 551
 552 static __init int ade7759_init(void)
 553 {
 554         return spi_register_driver(&ade7759_driver);
 555 }
 556 module_init(ade7759_init);
 557
 558 static __exit void ade7759_exit(void)
 559 {
 560         spi_unregister_driver(&ade7759_driver);
 561 }
 562 module_exit(ade7759_exit);
 563
 564 MODULE_AUTHOR("Barry Song <21cnbao@gmail.com>");
 565 MODULE_DESCRIPTION("Analog Devices ADE7759 Active Energy Metering IC Driver");
 566 MODULE_LICENSE("GPL v2");