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