2 * ADE7758 Poly Phase Multifunction Energy Metering IC driver
4 * Copyright 2010-2011 Analog Devices Inc.
6 * Licensed under the GPL-2.
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>
23 #include <linux/iio/buffer.h>
27 int ade7758_spi_write_reg_8(struct device *dev, u8 reg_address, u8 val)
30 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
31 struct ade7758_state *st = iio_priv(indio_dev);
33 mutex_lock(&st->buf_lock);
34 st->tx[0] = ADE7758_WRITE_REG(reg_address);
37 ret = spi_write(st->us, st->tx, 2);
38 mutex_unlock(&st->buf_lock);
43 static int ade7758_spi_write_reg_16(struct device *dev, u8 reg_address,
47 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
48 struct ade7758_state *st = iio_priv(indio_dev);
49 struct spi_transfer xfers[] = {
57 mutex_lock(&st->buf_lock);
58 st->tx[0] = ADE7758_WRITE_REG(reg_address);
59 st->tx[1] = (value >> 8) & 0xFF;
60 st->tx[2] = value & 0xFF;
62 ret = spi_sync_transfer(st->us, xfers, ARRAY_SIZE(xfers));
63 mutex_unlock(&st->buf_lock);
68 static int ade7758_spi_write_reg_24(struct device *dev, u8 reg_address,
72 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
73 struct ade7758_state *st = iio_priv(indio_dev);
74 struct spi_transfer xfers[] = {
82 mutex_lock(&st->buf_lock);
83 st->tx[0] = ADE7758_WRITE_REG(reg_address);
84 st->tx[1] = (value >> 16) & 0xFF;
85 st->tx[2] = (value >> 8) & 0xFF;
86 st->tx[3] = value & 0xFF;
88 ret = spi_sync_transfer(st->us, xfers, ARRAY_SIZE(xfers));
89 mutex_unlock(&st->buf_lock);
94 int ade7758_spi_read_reg_8(struct device *dev, u8 reg_address, u8 *val)
96 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
97 struct ade7758_state *st = iio_priv(indio_dev);
99 struct spi_transfer xfers[] = {
107 .tx_buf = &st->tx[1],
114 mutex_lock(&st->buf_lock);
115 st->tx[0] = ADE7758_READ_REG(reg_address);
118 ret = spi_sync_transfer(st->us, xfers, ARRAY_SIZE(xfers));
120 dev_err(&st->us->dev, "problem when reading 8 bit register 0x%02X",
127 mutex_unlock(&st->buf_lock);
131 static int ade7758_spi_read_reg_16(struct device *dev, u8 reg_address,
134 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
135 struct ade7758_state *st = iio_priv(indio_dev);
137 struct spi_transfer xfers[] = {
145 .tx_buf = &st->tx[1],
152 mutex_lock(&st->buf_lock);
153 st->tx[0] = ADE7758_READ_REG(reg_address);
157 ret = spi_sync_transfer(st->us, xfers, ARRAY_SIZE(xfers));
159 dev_err(&st->us->dev, "problem when reading 16 bit register 0x%02X",
164 *val = (st->rx[0] << 8) | st->rx[1];
167 mutex_unlock(&st->buf_lock);
171 static int ade7758_spi_read_reg_24(struct device *dev, u8 reg_address,
174 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
175 struct ade7758_state *st = iio_priv(indio_dev);
177 struct spi_transfer xfers[] = {
185 .tx_buf = &st->tx[1],
192 mutex_lock(&st->buf_lock);
193 st->tx[0] = ADE7758_READ_REG(reg_address);
198 ret = spi_sync_transfer(st->us, xfers, ARRAY_SIZE(xfers));
200 dev_err(&st->us->dev, "problem when reading 24 bit register 0x%02X",
204 *val = (st->rx[0] << 16) | (st->rx[1] << 8) | st->rx[2];
207 mutex_unlock(&st->buf_lock);
211 static ssize_t ade7758_read_8bit(struct device *dev,
212 struct device_attribute *attr, char *buf)
216 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
218 ret = ade7758_spi_read_reg_8(dev, this_attr->address, &val);
222 return sprintf(buf, "%u\n", val);
225 static ssize_t ade7758_read_16bit(struct device *dev,
226 struct device_attribute *attr, char *buf)
230 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
232 ret = ade7758_spi_read_reg_16(dev, this_attr->address, &val);
236 return sprintf(buf, "%u\n", val);
239 static ssize_t ade7758_read_24bit(struct device *dev,
240 struct device_attribute *attr, char *buf)
244 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
246 ret = ade7758_spi_read_reg_24(dev, this_attr->address, &val);
250 return sprintf(buf, "%u\n", val & 0xFFFFFF);
253 static ssize_t ade7758_write_8bit(struct device *dev,
254 struct device_attribute *attr,
255 const char *buf, size_t len)
257 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
261 ret = kstrtou8(buf, 10, &val);
264 ret = ade7758_spi_write_reg_8(dev, this_attr->address, val);
267 return ret ? ret : len;
270 static ssize_t ade7758_write_16bit(struct device *dev,
271 struct device_attribute *attr,
272 const char *buf, size_t len)
274 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
278 ret = kstrtou16(buf, 10, &val);
281 ret = ade7758_spi_write_reg_16(dev, this_attr->address, val);
284 return ret ? ret : len;
287 static int ade7758_reset(struct device *dev)
292 ret = ade7758_spi_read_reg_8(dev, ADE7758_OPMODE, &val);
294 dev_err(dev, "Failed to read opmode reg\n");
297 val |= BIT(6); /* Software Chip Reset */
298 ret = ade7758_spi_write_reg_8(dev, ADE7758_OPMODE, val);
300 dev_err(dev, "Failed to write opmode reg\n");
304 static IIO_DEV_ATTR_VPEAK(0644,
308 static IIO_DEV_ATTR_IPEAK(0644,
312 static IIO_DEV_ATTR_APHCAL(0644,
316 static IIO_DEV_ATTR_BPHCAL(0644,
320 static IIO_DEV_ATTR_CPHCAL(0644,
324 static IIO_DEV_ATTR_WDIV(0644,
328 static IIO_DEV_ATTR_VADIV(0644,
332 static IIO_DEV_ATTR_AIRMS(0444,
336 static IIO_DEV_ATTR_BIRMS(0444,
340 static IIO_DEV_ATTR_CIRMS(0444,
344 static IIO_DEV_ATTR_AVRMS(0444,
348 static IIO_DEV_ATTR_BVRMS(0444,
352 static IIO_DEV_ATTR_CVRMS(0444,
356 static IIO_DEV_ATTR_AIRMSOS(0644,
360 static IIO_DEV_ATTR_BIRMSOS(0644,
364 static IIO_DEV_ATTR_CIRMSOS(0644,
368 static IIO_DEV_ATTR_AVRMSOS(0644,
372 static IIO_DEV_ATTR_BVRMSOS(0644,
376 static IIO_DEV_ATTR_CVRMSOS(0644,
380 static IIO_DEV_ATTR_AIGAIN(0644,
384 static IIO_DEV_ATTR_BIGAIN(0644,
388 static IIO_DEV_ATTR_CIGAIN(0644,
392 static IIO_DEV_ATTR_AVRMSGAIN(0644,
396 static IIO_DEV_ATTR_BVRMSGAIN(0644,
400 static IIO_DEV_ATTR_CVRMSGAIN(0644,
405 int ade7758_set_irq(struct device *dev, bool enable)
410 ret = ade7758_spi_read_reg_24(dev, ADE7758_MASK, &irqen);
415 irqen |= BIT(16); /* Enables an interrupt when a data is
416 * present in the waveform register
421 ret = ade7758_spi_write_reg_24(dev, ADE7758_MASK, irqen);
426 /* Power down the device */
427 static int ade7758_stop_device(struct device *dev)
432 ret = ade7758_spi_read_reg_8(dev, ADE7758_OPMODE, &val);
434 dev_err(dev, "Failed to read opmode reg\n");
437 val |= 7 << 3; /* ADE7758 powered down */
438 ret = ade7758_spi_write_reg_8(dev, ADE7758_OPMODE, val);
440 dev_err(dev, "Failed to write opmode reg\n");
444 static int ade7758_initial_setup(struct iio_dev *indio_dev)
446 struct ade7758_state *st = iio_priv(indio_dev);
447 struct device *dev = &indio_dev->dev;
450 /* use low spi speed for init */
451 st->us->mode = SPI_MODE_1;
455 ret = ade7758_set_irq(dev, false);
457 dev_err(dev, "disable irq failed");
462 usleep_range(ADE7758_STARTUP_DELAY, ADE7758_STARTUP_DELAY + 100);
468 static int ade7758_read_samp_freq(struct device *dev, int *val)
473 ret = ade7758_spi_read_reg_8(dev, ADE7758_WAVMODE, &t);
478 *val = 26040 / (1 << t);
483 static int ade7758_write_samp_freq(struct device *dev, int val)
506 ret = ade7758_spi_read_reg_8(dev, ADE7758_WAVMODE, ®);
513 ret = ade7758_spi_write_reg_8(dev, ADE7758_WAVMODE, reg);
519 static int ade7758_read_raw(struct iio_dev *indio_dev,
520 struct iio_chan_spec const *chan,
528 case IIO_CHAN_INFO_SAMP_FREQ:
529 mutex_lock(&indio_dev->mlock);
530 ret = ade7758_read_samp_freq(&indio_dev->dev, val);
531 mutex_unlock(&indio_dev->mlock);
540 static int ade7758_write_raw(struct iio_dev *indio_dev,
541 struct iio_chan_spec const *chan,
542 int val, int val2, long mask)
547 case IIO_CHAN_INFO_SAMP_FREQ:
550 mutex_lock(&indio_dev->mlock);
551 ret = ade7758_write_samp_freq(&indio_dev->dev, val);
552 mutex_unlock(&indio_dev->mlock);
561 static IIO_DEV_ATTR_TEMP_RAW(ade7758_read_8bit);
562 static IIO_CONST_ATTR(in_temp_offset, "129 C");
563 static IIO_CONST_ATTR(in_temp_scale, "4 C");
565 static IIO_DEV_ATTR_AWATTHR(ade7758_read_16bit,
567 static IIO_DEV_ATTR_BWATTHR(ade7758_read_16bit,
569 static IIO_DEV_ATTR_CWATTHR(ade7758_read_16bit,
571 static IIO_DEV_ATTR_AVARHR(ade7758_read_16bit,
573 static IIO_DEV_ATTR_BVARHR(ade7758_read_16bit,
575 static IIO_DEV_ATTR_CVARHR(ade7758_read_16bit,
577 static IIO_DEV_ATTR_AVAHR(ade7758_read_16bit,
579 static IIO_DEV_ATTR_BVAHR(ade7758_read_16bit,
581 static IIO_DEV_ATTR_CVAHR(ade7758_read_16bit,
584 static IIO_CONST_ATTR_SAMP_FREQ_AVAIL("26040 13020 6510 3255");
586 static struct attribute *ade7758_attributes[] = {
587 &iio_dev_attr_in_temp_raw.dev_attr.attr,
588 &iio_const_attr_in_temp_offset.dev_attr.attr,
589 &iio_const_attr_in_temp_scale.dev_attr.attr,
590 &iio_const_attr_sampling_frequency_available.dev_attr.attr,
591 &iio_dev_attr_awatthr.dev_attr.attr,
592 &iio_dev_attr_bwatthr.dev_attr.attr,
593 &iio_dev_attr_cwatthr.dev_attr.attr,
594 &iio_dev_attr_avarhr.dev_attr.attr,
595 &iio_dev_attr_bvarhr.dev_attr.attr,
596 &iio_dev_attr_cvarhr.dev_attr.attr,
597 &iio_dev_attr_avahr.dev_attr.attr,
598 &iio_dev_attr_bvahr.dev_attr.attr,
599 &iio_dev_attr_cvahr.dev_attr.attr,
600 &iio_dev_attr_vpeak.dev_attr.attr,
601 &iio_dev_attr_ipeak.dev_attr.attr,
602 &iio_dev_attr_aphcal.dev_attr.attr,
603 &iio_dev_attr_bphcal.dev_attr.attr,
604 &iio_dev_attr_cphcal.dev_attr.attr,
605 &iio_dev_attr_wdiv.dev_attr.attr,
606 &iio_dev_attr_vadiv.dev_attr.attr,
607 &iio_dev_attr_airms.dev_attr.attr,
608 &iio_dev_attr_birms.dev_attr.attr,
609 &iio_dev_attr_cirms.dev_attr.attr,
610 &iio_dev_attr_avrms.dev_attr.attr,
611 &iio_dev_attr_bvrms.dev_attr.attr,
612 &iio_dev_attr_cvrms.dev_attr.attr,
613 &iio_dev_attr_aigain.dev_attr.attr,
614 &iio_dev_attr_bigain.dev_attr.attr,
615 &iio_dev_attr_cigain.dev_attr.attr,
616 &iio_dev_attr_avrmsgain.dev_attr.attr,
617 &iio_dev_attr_bvrmsgain.dev_attr.attr,
618 &iio_dev_attr_cvrmsgain.dev_attr.attr,
619 &iio_dev_attr_airmsos.dev_attr.attr,
620 &iio_dev_attr_birmsos.dev_attr.attr,
621 &iio_dev_attr_cirmsos.dev_attr.attr,
622 &iio_dev_attr_avrmsos.dev_attr.attr,
623 &iio_dev_attr_bvrmsos.dev_attr.attr,
624 &iio_dev_attr_cvrmsos.dev_attr.attr,
628 static const struct attribute_group ade7758_attribute_group = {
629 .attrs = ade7758_attributes,
632 static const struct iio_chan_spec ade7758_channels[] = {
637 .info_mask_shared_by_all = BIT(IIO_CHAN_INFO_SAMP_FREQ),
638 .address = AD7758_WT(AD7758_PHASE_A, AD7758_VOLTAGE),
649 .info_mask_shared_by_all = BIT(IIO_CHAN_INFO_SAMP_FREQ),
650 .address = AD7758_WT(AD7758_PHASE_A, AD7758_CURRENT),
661 .extend_name = "apparent",
662 .info_mask_shared_by_all = BIT(IIO_CHAN_INFO_SAMP_FREQ),
663 .address = AD7758_WT(AD7758_PHASE_A, AD7758_APP_PWR),
674 .extend_name = "active",
675 .info_mask_shared_by_all = BIT(IIO_CHAN_INFO_SAMP_FREQ),
676 .address = AD7758_WT(AD7758_PHASE_A, AD7758_ACT_PWR),
687 .extend_name = "reactive",
688 .info_mask_shared_by_all = BIT(IIO_CHAN_INFO_SAMP_FREQ),
689 .address = AD7758_WT(AD7758_PHASE_A, AD7758_REACT_PWR),
700 .info_mask_shared_by_all = BIT(IIO_CHAN_INFO_SAMP_FREQ),
701 .address = AD7758_WT(AD7758_PHASE_B, AD7758_VOLTAGE),
712 .info_mask_shared_by_all = BIT(IIO_CHAN_INFO_SAMP_FREQ),
713 .address = AD7758_WT(AD7758_PHASE_B, AD7758_CURRENT),
724 .extend_name = "apparent",
725 .info_mask_shared_by_all = BIT(IIO_CHAN_INFO_SAMP_FREQ),
726 .address = AD7758_WT(AD7758_PHASE_B, AD7758_APP_PWR),
737 .extend_name = "active",
738 .info_mask_shared_by_all = BIT(IIO_CHAN_INFO_SAMP_FREQ),
739 .address = AD7758_WT(AD7758_PHASE_B, AD7758_ACT_PWR),
750 .extend_name = "reactive",
751 .info_mask_shared_by_all = BIT(IIO_CHAN_INFO_SAMP_FREQ),
752 .address = AD7758_WT(AD7758_PHASE_B, AD7758_REACT_PWR),
763 .info_mask_shared_by_all = BIT(IIO_CHAN_INFO_SAMP_FREQ),
764 .address = AD7758_WT(AD7758_PHASE_C, AD7758_VOLTAGE),
775 .info_mask_shared_by_all = BIT(IIO_CHAN_INFO_SAMP_FREQ),
776 .address = AD7758_WT(AD7758_PHASE_C, AD7758_CURRENT),
787 .extend_name = "apparent",
788 .info_mask_shared_by_all = BIT(IIO_CHAN_INFO_SAMP_FREQ),
789 .address = AD7758_WT(AD7758_PHASE_C, AD7758_APP_PWR),
800 .extend_name = "active",
801 .info_mask_shared_by_all = BIT(IIO_CHAN_INFO_SAMP_FREQ),
802 .address = AD7758_WT(AD7758_PHASE_C, AD7758_ACT_PWR),
813 .extend_name = "reactive",
814 .info_mask_shared_by_all = BIT(IIO_CHAN_INFO_SAMP_FREQ),
815 .address = AD7758_WT(AD7758_PHASE_C, AD7758_REACT_PWR),
823 IIO_CHAN_SOFT_TIMESTAMP(15),
826 static const struct iio_info ade7758_info = {
827 .attrs = &ade7758_attribute_group,
828 .read_raw = &ade7758_read_raw,
829 .write_raw = &ade7758_write_raw,
830 .driver_module = THIS_MODULE,
833 static int ade7758_probe(struct spi_device *spi)
836 struct ade7758_state *st;
837 struct iio_dev *indio_dev;
839 indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*st));
843 st = iio_priv(indio_dev);
844 /* this is only used for removal purposes */
845 spi_set_drvdata(spi, indio_dev);
847 /* Allocate the comms buffers */
848 st->rx = kcalloc(ADE7758_MAX_RX, sizeof(*st->rx), GFP_KERNEL);
851 st->tx = kcalloc(ADE7758_MAX_TX, sizeof(*st->tx), GFP_KERNEL);
857 mutex_init(&st->buf_lock);
859 indio_dev->name = spi->dev.driver->name;
860 indio_dev->dev.parent = &spi->dev;
861 indio_dev->info = &ade7758_info;
862 indio_dev->modes = INDIO_DIRECT_MODE;
863 indio_dev->channels = ade7758_channels;
864 indio_dev->num_channels = ARRAY_SIZE(ade7758_channels);
866 ret = ade7758_configure_ring(indio_dev);
870 /* Get the device into a sane initial state */
871 ret = ade7758_initial_setup(indio_dev);
873 goto error_unreg_ring_funcs;
876 ret = ade7758_probe_trigger(indio_dev);
878 goto error_unreg_ring_funcs;
881 ret = iio_device_register(indio_dev);
883 goto error_remove_trigger;
887 error_remove_trigger:
889 ade7758_remove_trigger(indio_dev);
890 error_unreg_ring_funcs:
891 ade7758_unconfigure_ring(indio_dev);
899 static int ade7758_remove(struct spi_device *spi)
901 struct iio_dev *indio_dev = spi_get_drvdata(spi);
902 struct ade7758_state *st = iio_priv(indio_dev);
904 iio_device_unregister(indio_dev);
905 ade7758_stop_device(&indio_dev->dev);
906 ade7758_remove_trigger(indio_dev);
907 ade7758_unconfigure_ring(indio_dev);
914 static const struct spi_device_id ade7758_id[] = {
918 MODULE_DEVICE_TABLE(spi, ade7758_id);
920 static struct spi_driver ade7758_driver = {
924 .probe = ade7758_probe,
925 .remove = ade7758_remove,
926 .id_table = ade7758_id,
928 module_spi_driver(ade7758_driver);
930 MODULE_AUTHOR("Barry Song <21cnbao@gmail.com>");
931 MODULE_DESCRIPTION("Analog Devices ADE7758 Polyphase Multifunction Energy Metering IC Driver");
932 MODULE_LICENSE("GPL v2");