2 * ADE7754 Polyphase Multifunction Energy Metering IC Driver
4 * Copyright 2010 Analog Devices Inc.
6 * Licensed under the GPL-2 or later.
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>
21 #include <linux/iio/iio.h>
22 #include <linux/iio/sysfs.h>
26 static int ade7754_spi_write_reg_8(struct device *dev, u8 reg_address, u8 val)
29 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
30 struct ade7754_state *st = iio_priv(indio_dev);
32 mutex_lock(&st->buf_lock);
33 st->tx[0] = ADE7754_WRITE_REG(reg_address);
36 ret = spi_write(st->us, st->tx, 2);
37 mutex_unlock(&st->buf_lock);
42 static int ade7754_spi_write_reg_16(struct device *dev,
43 u8 reg_address, u16 value)
46 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
47 struct ade7754_state *st = iio_priv(indio_dev);
49 mutex_lock(&st->buf_lock);
50 st->tx[0] = ADE7754_WRITE_REG(reg_address);
51 st->tx[1] = (value >> 8) & 0xFF;
52 st->tx[2] = value & 0xFF;
53 ret = spi_write(st->us, st->tx, 3);
54 mutex_unlock(&st->buf_lock);
59 static int ade7754_spi_read_reg_8(struct device *dev, u8 reg_address, u8 *val)
61 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
62 struct ade7754_state *st = iio_priv(indio_dev);
65 ret = spi_w8r8(st->us, ADE7754_READ_REG(reg_address));
67 dev_err(&st->us->dev, "problem when reading 8 bit register 0x%02X",
76 static int ade7754_spi_read_reg_16(struct device *dev,
77 u8 reg_address, u16 *val)
79 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
80 struct ade7754_state *st = iio_priv(indio_dev);
83 ret = spi_w8r16be(st->us, ADE7754_READ_REG(reg_address));
85 dev_err(&st->us->dev, "problem when reading 16 bit register 0x%02X",
95 static int ade7754_spi_read_reg_24(struct device *dev,
96 u8 reg_address, u32 *val)
98 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
99 struct ade7754_state *st = iio_priv(indio_dev);
101 struct spi_transfer xfers[] = {
110 mutex_lock(&st->buf_lock);
111 st->tx[0] = ADE7754_READ_REG(reg_address);
116 ret = spi_sync_transfer(st->us, xfers, ARRAY_SIZE(xfers));
118 dev_err(&st->us->dev, "problem when reading 24 bit register 0x%02X",
122 *val = (st->rx[1] << 16) | (st->rx[2] << 8) | st->rx[3];
125 mutex_unlock(&st->buf_lock);
129 static ssize_t ade7754_read_8bit(struct device *dev,
130 struct device_attribute *attr,
135 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
137 ret = ade7754_spi_read_reg_8(dev, this_attr->address, &val);
141 return sprintf(buf, "%u\n", val);
144 static ssize_t ade7754_read_16bit(struct device *dev,
145 struct device_attribute *attr,
150 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
152 ret = ade7754_spi_read_reg_16(dev, this_attr->address, &val);
156 return sprintf(buf, "%u\n", val);
159 static ssize_t ade7754_read_24bit(struct device *dev,
160 struct device_attribute *attr,
165 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
167 ret = ade7754_spi_read_reg_24(dev, this_attr->address, &val);
171 return sprintf(buf, "%u\n", val & 0xFFFFFF);
174 static ssize_t ade7754_write_8bit(struct device *dev,
175 struct device_attribute *attr,
179 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
183 ret = kstrtou8(buf, 10, &val);
186 ret = ade7754_spi_write_reg_8(dev, this_attr->address, val);
189 return ret ? ret : len;
192 static ssize_t ade7754_write_16bit(struct device *dev,
193 struct device_attribute *attr,
197 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
201 ret = kstrtou16(buf, 10, &val);
204 ret = ade7754_spi_write_reg_16(dev, this_attr->address, val);
207 return ret ? ret : len;
210 static int ade7754_reset(struct device *dev)
215 ret = ade7754_spi_read_reg_8(dev, ADE7754_OPMODE, &val);
219 val |= BIT(6); /* Software Chip Reset */
220 return ade7754_spi_write_reg_8(dev, ADE7754_OPMODE, val);
223 static IIO_DEV_ATTR_AENERGY(ade7754_read_24bit, ADE7754_AENERGY);
224 static IIO_DEV_ATTR_LAENERGY(ade7754_read_24bit, ADE7754_LAENERGY);
225 static IIO_DEV_ATTR_VAENERGY(ade7754_read_24bit, ADE7754_VAENERGY);
226 static IIO_DEV_ATTR_LVAENERGY(ade7754_read_24bit, ADE7754_LVAENERGY);
227 static IIO_DEV_ATTR_VPEAK(S_IWUSR | S_IRUGO,
231 static IIO_DEV_ATTR_IPEAK(S_IWUSR | S_IRUGO,
235 static IIO_DEV_ATTR_APHCAL(S_IWUSR | S_IRUGO,
239 static IIO_DEV_ATTR_BPHCAL(S_IWUSR | S_IRUGO,
243 static IIO_DEV_ATTR_CPHCAL(S_IWUSR | S_IRUGO,
247 static IIO_DEV_ATTR_AAPOS(S_IWUSR | S_IRUGO,
251 static IIO_DEV_ATTR_BAPOS(S_IWUSR | S_IRUGO,
255 static IIO_DEV_ATTR_CAPOS(S_IWUSR | S_IRUGO,
259 static IIO_DEV_ATTR_WDIV(S_IWUSR | S_IRUGO,
263 static IIO_DEV_ATTR_VADIV(S_IWUSR | S_IRUGO,
267 static IIO_DEV_ATTR_CFNUM(S_IWUSR | S_IRUGO,
271 static IIO_DEV_ATTR_CFDEN(S_IWUSR | S_IRUGO,
275 static IIO_DEV_ATTR_ACTIVE_POWER_A_GAIN(S_IWUSR | S_IRUGO,
279 static IIO_DEV_ATTR_ACTIVE_POWER_B_GAIN(S_IWUSR | S_IRUGO,
283 static IIO_DEV_ATTR_ACTIVE_POWER_C_GAIN(S_IWUSR | S_IRUGO,
287 static IIO_DEV_ATTR_AIRMS(S_IRUGO,
291 static IIO_DEV_ATTR_BIRMS(S_IRUGO,
295 static IIO_DEV_ATTR_CIRMS(S_IRUGO,
299 static IIO_DEV_ATTR_AVRMS(S_IRUGO,
303 static IIO_DEV_ATTR_BVRMS(S_IRUGO,
307 static IIO_DEV_ATTR_CVRMS(S_IRUGO,
311 static IIO_DEV_ATTR_AIRMSOS(S_IRUGO,
315 static IIO_DEV_ATTR_BIRMSOS(S_IRUGO,
319 static IIO_DEV_ATTR_CIRMSOS(S_IRUGO,
323 static IIO_DEV_ATTR_AVRMSOS(S_IRUGO,
327 static IIO_DEV_ATTR_BVRMSOS(S_IRUGO,
331 static IIO_DEV_ATTR_CVRMSOS(S_IRUGO,
336 static int ade7754_set_irq(struct device *dev, bool enable)
341 ret = ade7754_spi_read_reg_16(dev, ADE7754_IRQEN, &irqen);
346 irqen |= BIT(14); /* Enables an interrupt when a data is
347 * present in the waveform register
352 ret = ade7754_spi_write_reg_16(dev, ADE7754_IRQEN, irqen);
357 /* Power down the device */
358 static int ade7754_stop_device(struct device *dev)
363 ret = ade7754_spi_read_reg_8(dev, ADE7754_OPMODE, &val);
365 dev_err(dev, "unable to power down the device, error: %d",
370 val |= 7 << 3; /* ADE7754 powered down */
371 return ade7754_spi_write_reg_8(dev, ADE7754_OPMODE, val);
374 static int ade7754_initial_setup(struct iio_dev *indio_dev)
377 struct ade7754_state *st = iio_priv(indio_dev);
378 struct device *dev = &indio_dev->dev;
380 /* use low spi speed for init */
381 st->us->mode = SPI_MODE_3;
385 ret = ade7754_set_irq(dev, false);
387 dev_err(dev, "disable irq failed");
392 msleep(ADE7754_STARTUP_DELAY);
398 static ssize_t ade7754_read_frequency(struct device *dev,
399 struct device_attribute *attr,
406 ret = ade7754_spi_read_reg_8(dev, ADE7754_WAVMODE, &t);
411 sps = 26000 / (1 + t);
413 return sprintf(buf, "%d\n", sps);
416 static ssize_t ade7754_write_frequency(struct device *dev,
417 struct device_attribute *attr,
421 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
422 struct ade7754_state *st = iio_priv(indio_dev);
427 ret = kstrtou16(buf, 10, &val);
433 mutex_lock(&indio_dev->mlock);
440 st->us->max_speed_hz = ADE7754_SPI_SLOW;
442 st->us->max_speed_hz = ADE7754_SPI_FAST;
444 ret = ade7754_spi_read_reg_8(dev, ADE7754_WAVMODE, ®);
451 ret = ade7754_spi_write_reg_8(dev, ADE7754_WAVMODE, reg);
454 mutex_unlock(&indio_dev->mlock);
456 return ret ? ret : len;
458 static IIO_DEV_ATTR_TEMP_RAW(ade7754_read_8bit);
459 static IIO_CONST_ATTR(in_temp_offset, "129 C");
460 static IIO_CONST_ATTR(in_temp_scale, "4 C");
462 static IIO_DEV_ATTR_SAMP_FREQ(S_IWUSR | S_IRUGO,
463 ade7754_read_frequency,
464 ade7754_write_frequency);
466 static IIO_CONST_ATTR_SAMP_FREQ_AVAIL("26000 13000 65000 33000");
468 static struct attribute *ade7754_attributes[] = {
469 &iio_dev_attr_in_temp_raw.dev_attr.attr,
470 &iio_const_attr_in_temp_offset.dev_attr.attr,
471 &iio_const_attr_in_temp_scale.dev_attr.attr,
472 &iio_dev_attr_sampling_frequency.dev_attr.attr,
473 &iio_const_attr_sampling_frequency_available.dev_attr.attr,
474 &iio_dev_attr_aenergy.dev_attr.attr,
475 &iio_dev_attr_laenergy.dev_attr.attr,
476 &iio_dev_attr_vaenergy.dev_attr.attr,
477 &iio_dev_attr_lvaenergy.dev_attr.attr,
478 &iio_dev_attr_vpeak.dev_attr.attr,
479 &iio_dev_attr_ipeak.dev_attr.attr,
480 &iio_dev_attr_aphcal.dev_attr.attr,
481 &iio_dev_attr_bphcal.dev_attr.attr,
482 &iio_dev_attr_cphcal.dev_attr.attr,
483 &iio_dev_attr_aapos.dev_attr.attr,
484 &iio_dev_attr_bapos.dev_attr.attr,
485 &iio_dev_attr_capos.dev_attr.attr,
486 &iio_dev_attr_wdiv.dev_attr.attr,
487 &iio_dev_attr_vadiv.dev_attr.attr,
488 &iio_dev_attr_cfnum.dev_attr.attr,
489 &iio_dev_attr_cfden.dev_attr.attr,
490 &iio_dev_attr_active_power_a_gain.dev_attr.attr,
491 &iio_dev_attr_active_power_b_gain.dev_attr.attr,
492 &iio_dev_attr_active_power_c_gain.dev_attr.attr,
493 &iio_dev_attr_airms.dev_attr.attr,
494 &iio_dev_attr_birms.dev_attr.attr,
495 &iio_dev_attr_cirms.dev_attr.attr,
496 &iio_dev_attr_avrms.dev_attr.attr,
497 &iio_dev_attr_bvrms.dev_attr.attr,
498 &iio_dev_attr_cvrms.dev_attr.attr,
499 &iio_dev_attr_airmsos.dev_attr.attr,
500 &iio_dev_attr_birmsos.dev_attr.attr,
501 &iio_dev_attr_cirmsos.dev_attr.attr,
502 &iio_dev_attr_avrmsos.dev_attr.attr,
503 &iio_dev_attr_bvrmsos.dev_attr.attr,
504 &iio_dev_attr_cvrmsos.dev_attr.attr,
508 static const struct attribute_group ade7754_attribute_group = {
509 .attrs = ade7754_attributes,
512 static const struct iio_info ade7754_info = {
513 .attrs = &ade7754_attribute_group,
514 .driver_module = THIS_MODULE,
517 static int ade7754_probe(struct spi_device *spi)
520 struct ade7754_state *st;
521 struct iio_dev *indio_dev;
523 /* setup the industrialio driver allocated elements */
524 indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*st));
527 /* this is only used for removal purposes */
528 spi_set_drvdata(spi, indio_dev);
530 st = iio_priv(indio_dev);
532 mutex_init(&st->buf_lock);
534 indio_dev->name = spi->dev.driver->name;
535 indio_dev->dev.parent = &spi->dev;
536 indio_dev->info = &ade7754_info;
537 indio_dev->modes = INDIO_DIRECT_MODE;
539 /* Get the device into a sane initial state */
540 ret = ade7754_initial_setup(indio_dev);
542 goto powerdown_on_error;
543 ret = iio_device_register(indio_dev);
545 goto powerdown_on_error;
549 ade7754_stop_device(&indio_dev->dev);
553 static int ade7754_remove(struct spi_device *spi)
555 struct iio_dev *indio_dev = spi_get_drvdata(spi);
557 iio_device_unregister(indio_dev);
558 ade7754_stop_device(&indio_dev->dev);
563 static struct spi_driver ade7754_driver = {
567 .probe = ade7754_probe,
568 .remove = ade7754_remove,
570 module_spi_driver(ade7754_driver);
572 MODULE_AUTHOR("Barry Song <21cnbao@gmail.com>");
573 MODULE_DESCRIPTION("Analog Devices ADE7754 Polyphase Multifunction Energy Metering IC Driver");
574 MODULE_LICENSE("GPL v2");
575 MODULE_ALIAS("spi:ad7754");