drivers/staging/iio/meter/ade7754.c

   1 /*
   2  * ADE7754 Polyphase Multifunction Energy Metering IC 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 #include "ade7754.h"
  25
  26 static int ade7754_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_to_iio_dev(dev);
  32         struct ade7754_state *st = iio_priv(indio_dev);
  33
  34         mutex_lock(&st->buf_lock);
  35         st->tx[0] = ADE7754_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 ade7754_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_to_iio_dev(dev);
  50         struct ade7754_state *st = iio_priv(indio_dev);
  51
  52         mutex_lock(&st->buf_lock);
  53         st->tx[0] = ADE7754_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 ade7754_spi_read_reg_8(struct device *dev,
  63                 u8 reg_address,
  64                 u8 *val)
  65 {
  66         struct iio_dev *indio_dev = dev_to_iio_dev(dev);
  67         struct ade7754_state *st = iio_priv(indio_dev);
  68         int ret;
  69
  70         ret = spi_w8r8(st->us, ADE7754_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 ade7754_spi_read_reg_16(struct device *dev,
  82                 u8 reg_address,
  83                 u16 *val)
  84 {
  85         struct iio_dev *indio_dev = dev_to_iio_dev(dev);
  86         struct ade7754_state *st = iio_priv(indio_dev);
  87         int ret;
  88
  89         ret = spi_w8r16(st->us, ADE7754_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 ade7754_spi_read_reg_24(struct device *dev,
 103                 u8 reg_address,
 104                 u32 *val)
 105 {
 106         struct iio_dev *indio_dev = dev_to_iio_dev(dev);
 107         struct ade7754_state *st = iio_priv(indio_dev);
 108         int ret;
 109         struct spi_transfer xfers[] = {
 110                 {
 111                         .tx_buf = st->tx,
 112                         .rx_buf = st->rx,
 113                         .bits_per_word = 8,
 114                         .len = 4,
 115                 },
 116         };
 117
 118         mutex_lock(&st->buf_lock);
 119         st->tx[0] = ADE7754_READ_REG(reg_address);
 120         st->tx[1] = 0;
 121         st->tx[2] = 0;
 122         st->tx[3] = 0;
 123
 124         ret = spi_sync_transfer(st->us, xfers, ARRAY_SIZE(xfers));
 125         if (ret) {
 126                 dev_err(&st->us->dev, "problem when reading 24 bit register 0x%02X",
 127                                 reg_address);
 128                 goto error_ret;
 129         }
 130         *val = (st->rx[1] << 16) | (st->rx[2] << 8) | st->rx[3];
 131
 132 error_ret:
 133         mutex_unlock(&st->buf_lock);
 134         return ret;
 135 }
 136
 137 static ssize_t ade7754_read_8bit(struct device *dev,
 138                 struct device_attribute *attr,
 139                 char *buf)
 140 {
 141         int ret;
 142         u8 val = 0;
 143         struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
 144
 145         ret = ade7754_spi_read_reg_8(dev, this_attr->address, &val);
 146         if (ret)
 147                 return ret;
 148
 149         return sprintf(buf, "%u\n", val);
 150 }
 151
 152 static ssize_t ade7754_read_16bit(struct device *dev,
 153                 struct device_attribute *attr,
 154                 char *buf)
 155 {
 156         int ret;
 157         u16 val = 0;
 158         struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
 159
 160         ret = ade7754_spi_read_reg_16(dev, this_attr->address, &val);
 161         if (ret)
 162                 return ret;
 163
 164         return sprintf(buf, "%u\n", val);
 165 }
 166
 167 static ssize_t ade7754_read_24bit(struct device *dev,
 168                 struct device_attribute *attr,
 169                 char *buf)
 170 {
 171         int ret;
 172         u32 val = 0;
 173         struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
 174
 175         ret = ade7754_spi_read_reg_24(dev, this_attr->address, &val);
 176         if (ret)
 177                 return ret;
 178
 179         return sprintf(buf, "%u\n", val & 0xFFFFFF);
 180 }
 181
 182 static ssize_t ade7754_write_8bit(struct device *dev,
 183                 struct device_attribute *attr,
 184                 const char *buf,
 185                 size_t len)
 186 {
 187         struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
 188         int ret;
 189         long val;
 190
 191         ret = strict_strtol(buf, 10, &val);
 192         if (ret)
 193                 goto error_ret;
 194         ret = ade7754_spi_write_reg_8(dev, this_attr->address, val);
 195
 196 error_ret:
 197         return ret ? ret : len;
 198 }
 199
 200 static ssize_t ade7754_write_16bit(struct device *dev,
 201                 struct device_attribute *attr,
 202                 const char *buf,
 203                 size_t len)
 204 {
 205         struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
 206         int ret;
 207         long val;
 208
 209         ret = strict_strtol(buf, 10, &val);
 210         if (ret)
 211                 goto error_ret;
 212         ret = ade7754_spi_write_reg_16(dev, this_attr->address, val);
 213
 214 error_ret:
 215         return ret ? ret : len;
 216 }
 217
 218 static int ade7754_reset(struct device *dev)
 219 {
 220         u8 val;
 221
 222         ade7754_spi_read_reg_8(dev, ADE7754_OPMODE, &val);
 223         val |= 1 << 6; /* Software Chip Reset */
 224         return ade7754_spi_write_reg_8(dev, ADE7754_OPMODE, val);
 225 }
 226
 227 static IIO_DEV_ATTR_AENERGY(ade7754_read_24bit, ADE7754_AENERGY);
 228 static IIO_DEV_ATTR_LAENERGY(ade7754_read_24bit, ADE7754_LAENERGY);
 229 static IIO_DEV_ATTR_VAENERGY(ade7754_read_24bit, ADE7754_VAENERGY);
 230 static IIO_DEV_ATTR_LVAENERGY(ade7754_read_24bit, ADE7754_LVAENERGY);
 231 static IIO_DEV_ATTR_VPEAK(S_IWUSR | S_IRUGO,
 232                 ade7754_read_8bit,
 233                 ade7754_write_8bit,
 234                 ADE7754_VPEAK);
 235 static IIO_DEV_ATTR_IPEAK(S_IWUSR | S_IRUGO,
 236                 ade7754_read_8bit,
 237                 ade7754_write_8bit,
 238                 ADE7754_VPEAK);
 239 static IIO_DEV_ATTR_APHCAL(S_IWUSR | S_IRUGO,
 240                 ade7754_read_8bit,
 241                 ade7754_write_8bit,
 242                 ADE7754_APHCAL);
 243 static IIO_DEV_ATTR_BPHCAL(S_IWUSR | S_IRUGO,
 244                 ade7754_read_8bit,
 245                 ade7754_write_8bit,
 246                 ADE7754_BPHCAL);
 247 static IIO_DEV_ATTR_CPHCAL(S_IWUSR | S_IRUGO,
 248                 ade7754_read_8bit,
 249                 ade7754_write_8bit,
 250                 ADE7754_CPHCAL);
 251 static IIO_DEV_ATTR_AAPOS(S_IWUSR | S_IRUGO,
 252                 ade7754_read_16bit,
 253                 ade7754_write_16bit,
 254                 ADE7754_AAPOS);
 255 static IIO_DEV_ATTR_BAPOS(S_IWUSR | S_IRUGO,
 256                 ade7754_read_16bit,
 257                 ade7754_write_16bit,
 258                 ADE7754_BAPOS);
 259 static IIO_DEV_ATTR_CAPOS(S_IWUSR | S_IRUGO,
 260                 ade7754_read_16bit,
 261                 ade7754_write_16bit,
 262                 ADE7754_CAPOS);
 263 static IIO_DEV_ATTR_WDIV(S_IWUSR | S_IRUGO,
 264                 ade7754_read_8bit,
 265                 ade7754_write_8bit,
 266                 ADE7754_WDIV);
 267 static IIO_DEV_ATTR_VADIV(S_IWUSR | S_IRUGO,
 268                 ade7754_read_8bit,
 269                 ade7754_write_8bit,
 270                 ADE7754_VADIV);
 271 static IIO_DEV_ATTR_CFNUM(S_IWUSR | S_IRUGO,
 272                 ade7754_read_16bit,
 273                 ade7754_write_16bit,
 274                 ADE7754_CFNUM);
 275 static IIO_DEV_ATTR_CFDEN(S_IWUSR | S_IRUGO,
 276                 ade7754_read_16bit,
 277                 ade7754_write_16bit,
 278                 ADE7754_CFDEN);
 279 static IIO_DEV_ATTR_ACTIVE_POWER_A_GAIN(S_IWUSR | S_IRUGO,
 280                 ade7754_read_16bit,
 281                 ade7754_write_16bit,
 282                 ADE7754_AAPGAIN);
 283 static IIO_DEV_ATTR_ACTIVE_POWER_B_GAIN(S_IWUSR | S_IRUGO,
 284                 ade7754_read_16bit,
 285                 ade7754_write_16bit,
 286                 ADE7754_BAPGAIN);
 287 static IIO_DEV_ATTR_ACTIVE_POWER_C_GAIN(S_IWUSR | S_IRUGO,
 288                 ade7754_read_16bit,
 289                 ade7754_write_16bit,
 290                 ADE7754_CAPGAIN);
 291 static IIO_DEV_ATTR_AIRMS(S_IRUGO,
 292                 ade7754_read_24bit,
 293                 NULL,
 294                 ADE7754_AIRMS);
 295 static IIO_DEV_ATTR_BIRMS(S_IRUGO,
 296                 ade7754_read_24bit,
 297                 NULL,
 298                 ADE7754_BIRMS);
 299 static IIO_DEV_ATTR_CIRMS(S_IRUGO,
 300                 ade7754_read_24bit,
 301                 NULL,
 302                 ADE7754_CIRMS);
 303 static IIO_DEV_ATTR_AVRMS(S_IRUGO,
 304                 ade7754_read_24bit,
 305                 NULL,
 306                 ADE7754_AVRMS);
 307 static IIO_DEV_ATTR_BVRMS(S_IRUGO,
 308                 ade7754_read_24bit,
 309                 NULL,
 310                 ADE7754_BVRMS);
 311 static IIO_DEV_ATTR_CVRMS(S_IRUGO,
 312                 ade7754_read_24bit,
 313                 NULL,
 314                 ADE7754_CVRMS);
 315 static IIO_DEV_ATTR_AIRMSOS(S_IRUGO,
 316                 ade7754_read_16bit,
 317                 ade7754_write_16bit,
 318                 ADE7754_AIRMSOS);
 319 static IIO_DEV_ATTR_BIRMSOS(S_IRUGO,
 320                 ade7754_read_16bit,
 321                 ade7754_write_16bit,
 322                 ADE7754_BIRMSOS);
 323 static IIO_DEV_ATTR_CIRMSOS(S_IRUGO,
 324                 ade7754_read_16bit,
 325                 ade7754_write_16bit,
 326                 ADE7754_CIRMSOS);
 327 static IIO_DEV_ATTR_AVRMSOS(S_IRUGO,
 328                 ade7754_read_16bit,
 329                 ade7754_write_16bit,
 330                 ADE7754_AVRMSOS);
 331 static IIO_DEV_ATTR_BVRMSOS(S_IRUGO,
 332                 ade7754_read_16bit,
 333                 ade7754_write_16bit,
 334                 ADE7754_BVRMSOS);
 335 static IIO_DEV_ATTR_CVRMSOS(S_IRUGO,
 336                 ade7754_read_16bit,
 337                 ade7754_write_16bit,
 338                 ADE7754_CVRMSOS);
 339
 340 static int ade7754_set_irq(struct device *dev, bool enable)
 341 {
 342         int ret;
 343         u16 irqen;
 344         ret = ade7754_spi_read_reg_16(dev, ADE7754_IRQEN, &irqen);
 345         if (ret)
 346                 goto error_ret;
 347
 348         if (enable)
 349                 irqen |= 1 << 14; /* Enables an interrupt when a data is
 350                                      present in the waveform register */
 351         else
 352                 irqen &= ~(1 << 14);
 353
 354         ret = ade7754_spi_write_reg_16(dev, ADE7754_IRQEN, irqen);
 355         if (ret)
 356                 goto error_ret;
 357
 358 error_ret:
 359         return ret;
 360 }
 361
 362 /* Power down the device */
 363 static int ade7754_stop_device(struct device *dev)
 364 {
 365         u8 val;
 366
 367         ade7754_spi_read_reg_8(dev, ADE7754_OPMODE, &val);
 368         val |= 7 << 3;  /* ADE7754 powered down */
 369         return ade7754_spi_write_reg_8(dev, ADE7754_OPMODE, val);
 370 }
 371
 372 static int ade7754_initial_setup(struct iio_dev *indio_dev)
 373 {
 374         int ret;
 375         struct ade7754_state *st = iio_priv(indio_dev);
 376         struct device *dev = &indio_dev->dev;
 377
 378         /* use low spi speed for init */
 379         st->us->mode = SPI_MODE_3;
 380         spi_setup(st->us);
 381
 382         /* Disable IRQ */
 383         ret = ade7754_set_irq(dev, false);
 384         if (ret) {
 385                 dev_err(dev, "disable irq failed");
 386                 goto err_ret;
 387         }
 388
 389         ade7754_reset(dev);
 390         msleep(ADE7754_STARTUP_DELAY);
 391
 392 err_ret:
 393         return ret;
 394 }
 395
 396 static ssize_t ade7754_read_frequency(struct device *dev,
 397                 struct device_attribute *attr,
 398                 char *buf)
 399 {
 400         int ret;
 401         u8 t;
 402         int sps;
 403         ret = ade7754_spi_read_reg_8(dev,
 404                         ADE7754_WAVMODE,
 405                         &t);
 406         if (ret)
 407                 return ret;
 408
 409         t = (t >> 3) & 0x3;
 410         sps = 26000 / (1 + t);
 411
 412         return sprintf(buf, "%d\n", sps);
 413 }
 414
 415 static ssize_t ade7754_write_frequency(struct device *dev,
 416                 struct device_attribute *attr,
 417                 const char *buf,
 418                 size_t len)
 419 {
 420         struct iio_dev *indio_dev = dev_to_iio_dev(dev);
 421         struct ade7754_state *st = iio_priv(indio_dev);
 422         unsigned long val;
 423         int ret;
 424         u8 reg, t;
 425
 426         ret = strict_strtol(buf, 10, &val);
 427         if (ret)
 428                 return ret;
 429         if (val == 0)
 430                 return -EINVAL;
 431
 432         mutex_lock(&indio_dev->mlock);
 433
 434         t = (26000 / val);
 435         if (t > 0)
 436                 t--;
 437
 438         if (t > 1)
 439                 st->us->max_speed_hz = ADE7754_SPI_SLOW;
 440         else
 441                 st->us->max_speed_hz = ADE7754_SPI_FAST;
 442
 443         ret = ade7754_spi_read_reg_8(dev, ADE7754_WAVMODE, &reg);
 444         if (ret)
 445                 goto out;
 446
 447         reg &= ~(3 << 3);
 448         reg |= t << 3;
 449
 450         ret = ade7754_spi_write_reg_8(dev, ADE7754_WAVMODE, reg);
 451
 452 out:
 453         mutex_unlock(&indio_dev->mlock);
 454
 455         return ret ? ret : len;
 456 }
 457 static IIO_DEV_ATTR_TEMP_RAW(ade7754_read_8bit);
 458 static IIO_CONST_ATTR(in_temp_offset, "129 C");
 459 static IIO_CONST_ATTR(in_temp_scale, "4 C");
 460
 461 static IIO_DEV_ATTR_SAMP_FREQ(S_IWUSR | S_IRUGO,
 462                 ade7754_read_frequency,
 463                 ade7754_write_frequency);
 464
 465 static IIO_CONST_ATTR_SAMP_FREQ_AVAIL("26000 13000 65000 33000");
 466
 467 static struct attribute *ade7754_attributes[] = {
 468         &iio_dev_attr_in_temp_raw.dev_attr.attr,
 469         &iio_const_attr_in_temp_offset.dev_attr.attr,
 470         &iio_const_attr_in_temp_scale.dev_attr.attr,
 471         &iio_dev_attr_sampling_frequency.dev_attr.attr,
 472         &iio_const_attr_sampling_frequency_available.dev_attr.attr,
 473         &iio_dev_attr_aenergy.dev_attr.attr,
 474         &iio_dev_attr_laenergy.dev_attr.attr,
 475         &iio_dev_attr_vaenergy.dev_attr.attr,
 476         &iio_dev_attr_lvaenergy.dev_attr.attr,
 477         &iio_dev_attr_vpeak.dev_attr.attr,
 478         &iio_dev_attr_ipeak.dev_attr.attr,
 479         &iio_dev_attr_aphcal.dev_attr.attr,
 480         &iio_dev_attr_bphcal.dev_attr.attr,
 481         &iio_dev_attr_cphcal.dev_attr.attr,
 482         &iio_dev_attr_aapos.dev_attr.attr,
 483         &iio_dev_attr_bapos.dev_attr.attr,
 484         &iio_dev_attr_capos.dev_attr.attr,
 485         &iio_dev_attr_wdiv.dev_attr.attr,
 486         &iio_dev_attr_vadiv.dev_attr.attr,
 487         &iio_dev_attr_cfnum.dev_attr.attr,
 488         &iio_dev_attr_cfden.dev_attr.attr,
 489         &iio_dev_attr_active_power_a_gain.dev_attr.attr,
 490         &iio_dev_attr_active_power_b_gain.dev_attr.attr,
 491         &iio_dev_attr_active_power_c_gain.dev_attr.attr,
 492         &iio_dev_attr_airms.dev_attr.attr,
 493         &iio_dev_attr_birms.dev_attr.attr,
 494         &iio_dev_attr_cirms.dev_attr.attr,
 495         &iio_dev_attr_avrms.dev_attr.attr,
 496         &iio_dev_attr_bvrms.dev_attr.attr,
 497         &iio_dev_attr_cvrms.dev_attr.attr,
 498         &iio_dev_attr_airmsos.dev_attr.attr,
 499         &iio_dev_attr_birmsos.dev_attr.attr,
 500         &iio_dev_attr_cirmsos.dev_attr.attr,
 501         &iio_dev_attr_avrmsos.dev_attr.attr,
 502         &iio_dev_attr_bvrmsos.dev_attr.attr,
 503         &iio_dev_attr_cvrmsos.dev_attr.attr,
 504         NULL,
 505 };
 506
 507 static const struct attribute_group ade7754_attribute_group = {
 508         .attrs = ade7754_attributes,
 509 };
 510
 511 static const struct iio_info ade7754_info = {
 512         .attrs = &ade7754_attribute_group,
 513         .driver_module = THIS_MODULE,
 514 };
 515
 516 static int ade7754_probe(struct spi_device *spi)
 517 {
 518         int ret;
 519         struct ade7754_state *st;
 520         struct iio_dev *indio_dev;
 521
 522         /* setup the industrialio driver allocated elements */
 523         indio_dev = iio_device_alloc(sizeof(*st));
 524         if (indio_dev == NULL) {
 525                 ret = -ENOMEM;
 526                 goto error_ret;
 527         }
 528         /* this is only used for removal purposes */
 529         spi_set_drvdata(spi, indio_dev);
 530
 531         st = iio_priv(indio_dev);
 532         st->us = spi;
 533         mutex_init(&st->buf_lock);
 534
 535         indio_dev->name = spi->dev.driver->name;
 536         indio_dev->dev.parent = &spi->dev;
 537         indio_dev->info = &ade7754_info;
 538         indio_dev->modes = INDIO_DIRECT_MODE;
 539
 540         /* Get the device into a sane initial state */
 541         ret = ade7754_initial_setup(indio_dev);
 542         if (ret)
 543                 goto error_free_dev;
 544         ret = iio_device_register(indio_dev);
 545         if (ret)
 546                 goto error_free_dev;
 547
 548         return 0;
 549
 550 error_free_dev:
 551         iio_device_free(indio_dev);
 552
 553 error_ret:
 554         return ret;
 555 }
 556
 557 /* fixme, confirm ordering in this function */
 558 static int ade7754_remove(struct spi_device *spi)
 559 {
 560         struct iio_dev *indio_dev = spi_get_drvdata(spi);
 561
 562         iio_device_unregister(indio_dev);
 563         ade7754_stop_device(&indio_dev->dev);
 564         iio_device_free(indio_dev);
 565
 566         return 0;
 567 }
 568
 569 static struct spi_driver ade7754_driver = {
 570         .driver = {
 571                 .name = "ade7754",
 572                 .owner = THIS_MODULE,
 573         },
 574         .probe = ade7754_probe,
 575         .remove = ade7754_remove,
 576 };
 577 module_spi_driver(ade7754_driver);
 578
 579 MODULE_AUTHOR("Barry Song <21cnbao@gmail.com>");
 580 MODULE_DESCRIPTION("Analog Devices ADE7754 Polyphase Multifunction Energy Metering IC Driver");
 581 MODULE_LICENSE("GPL v2");
 582 MODULE_ALIAS("spi:ad7754");