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,
32 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
33 struct ade7758_state *st = iio_priv(indio_dev);
35 mutex_lock(&st->buf_lock);
36 st->tx[0] = ADE7758_WRITE_REG(reg_address);
39 ret = spi_write(st->us, st->tx, 2);
40 mutex_unlock(&st->buf_lock);
45 static int ade7758_spi_write_reg_16(struct device *dev,
50 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
51 struct ade7758_state *st = iio_priv(indio_dev);
52 struct spi_transfer xfers[] = {
60 mutex_lock(&st->buf_lock);
61 st->tx[0] = ADE7758_WRITE_REG(reg_address);
62 st->tx[1] = (value >> 8) & 0xFF;
63 st->tx[2] = value & 0xFF;
65 ret = spi_sync_transfer(st->us, xfers, ARRAY_SIZE(xfers));
66 mutex_unlock(&st->buf_lock);
71 static int ade7758_spi_write_reg_24(struct device *dev,
76 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
77 struct ade7758_state *st = iio_priv(indio_dev);
78 struct spi_transfer xfers[] = {
86 mutex_lock(&st->buf_lock);
87 st->tx[0] = ADE7758_WRITE_REG(reg_address);
88 st->tx[1] = (value >> 16) & 0xFF;
89 st->tx[2] = (value >> 8) & 0xFF;
90 st->tx[3] = value & 0xFF;
92 ret = spi_sync_transfer(st->us, xfers, ARRAY_SIZE(xfers));
93 mutex_unlock(&st->buf_lock);
98 int ade7758_spi_read_reg_8(struct device *dev,
102 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
103 struct ade7758_state *st = iio_priv(indio_dev);
105 struct spi_transfer xfers[] = {
113 .tx_buf = &st->tx[1],
120 mutex_lock(&st->buf_lock);
121 st->tx[0] = ADE7758_READ_REG(reg_address);
124 ret = spi_sync_transfer(st->us, xfers, ARRAY_SIZE(xfers));
126 dev_err(&st->us->dev, "problem when reading 8 bit register 0x%02X",
133 mutex_unlock(&st->buf_lock);
137 static int ade7758_spi_read_reg_16(struct device *dev,
141 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
142 struct ade7758_state *st = iio_priv(indio_dev);
144 struct spi_transfer xfers[] = {
152 .tx_buf = &st->tx[1],
160 mutex_lock(&st->buf_lock);
161 st->tx[0] = ADE7758_READ_REG(reg_address);
165 ret = spi_sync_transfer(st->us, xfers, ARRAY_SIZE(xfers));
167 dev_err(&st->us->dev, "problem when reading 16 bit register 0x%02X",
172 *val = (st->rx[0] << 8) | st->rx[1];
175 mutex_unlock(&st->buf_lock);
179 static int ade7758_spi_read_reg_24(struct device *dev,
183 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
184 struct ade7758_state *st = iio_priv(indio_dev);
186 struct spi_transfer xfers[] = {
194 .tx_buf = &st->tx[1],
201 mutex_lock(&st->buf_lock);
202 st->tx[0] = ADE7758_READ_REG(reg_address);
207 ret = spi_sync_transfer(st->us, xfers, ARRAY_SIZE(xfers));
209 dev_err(&st->us->dev, "problem when reading 24 bit register 0x%02X",
213 *val = (st->rx[0] << 16) | (st->rx[1] << 8) | st->rx[2];
216 mutex_unlock(&st->buf_lock);
220 static ssize_t ade7758_read_8bit(struct device *dev,
221 struct device_attribute *attr,
226 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
228 ret = ade7758_spi_read_reg_8(dev, this_attr->address, &val);
232 return sprintf(buf, "%u\n", val);
235 static ssize_t ade7758_read_16bit(struct device *dev,
236 struct device_attribute *attr,
241 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
243 ret = ade7758_spi_read_reg_16(dev, this_attr->address, &val);
247 return sprintf(buf, "%u\n", val);
250 static ssize_t ade7758_read_24bit(struct device *dev,
251 struct device_attribute *attr,
256 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
258 ret = ade7758_spi_read_reg_24(dev, this_attr->address, &val);
262 return sprintf(buf, "%u\n", val & 0xFFFFFF);
265 static ssize_t ade7758_write_8bit(struct device *dev,
266 struct device_attribute *attr,
270 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
274 ret = kstrtou8(buf, 10, &val);
277 ret = ade7758_spi_write_reg_8(dev, this_attr->address, val);
280 return ret ? ret : len;
283 static ssize_t ade7758_write_16bit(struct device *dev,
284 struct device_attribute *attr,
288 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
292 ret = kstrtou16(buf, 10, &val);
295 ret = ade7758_spi_write_reg_16(dev, this_attr->address, val);
298 return ret ? ret : len;
301 static int ade7758_reset(struct device *dev)
305 ade7758_spi_read_reg_8(dev,
308 val |= 1 << 6; /* Software Chip Reset */
309 ret = ade7758_spi_write_reg_8(dev,
316 static IIO_DEV_ATTR_VPEAK(S_IWUSR | S_IRUGO,
320 static IIO_DEV_ATTR_IPEAK(S_IWUSR | S_IRUGO,
324 static IIO_DEV_ATTR_APHCAL(S_IWUSR | S_IRUGO,
328 static IIO_DEV_ATTR_BPHCAL(S_IWUSR | S_IRUGO,
332 static IIO_DEV_ATTR_CPHCAL(S_IWUSR | S_IRUGO,
336 static IIO_DEV_ATTR_WDIV(S_IWUSR | S_IRUGO,
340 static IIO_DEV_ATTR_VADIV(S_IWUSR | S_IRUGO,
344 static IIO_DEV_ATTR_AIRMS(S_IRUGO,
348 static IIO_DEV_ATTR_BIRMS(S_IRUGO,
352 static IIO_DEV_ATTR_CIRMS(S_IRUGO,
356 static IIO_DEV_ATTR_AVRMS(S_IRUGO,
360 static IIO_DEV_ATTR_BVRMS(S_IRUGO,
364 static IIO_DEV_ATTR_CVRMS(S_IRUGO,
368 static IIO_DEV_ATTR_AIRMSOS(S_IWUSR | S_IRUGO,
372 static IIO_DEV_ATTR_BIRMSOS(S_IWUSR | S_IRUGO,
376 static IIO_DEV_ATTR_CIRMSOS(S_IWUSR | S_IRUGO,
380 static IIO_DEV_ATTR_AVRMSOS(S_IWUSR | S_IRUGO,
384 static IIO_DEV_ATTR_BVRMSOS(S_IWUSR | S_IRUGO,
388 static IIO_DEV_ATTR_CVRMSOS(S_IWUSR | S_IRUGO,
392 static IIO_DEV_ATTR_AIGAIN(S_IWUSR | S_IRUGO,
396 static IIO_DEV_ATTR_BIGAIN(S_IWUSR | S_IRUGO,
400 static IIO_DEV_ATTR_CIGAIN(S_IWUSR | S_IRUGO,
404 static IIO_DEV_ATTR_AVRMSGAIN(S_IWUSR | S_IRUGO,
408 static IIO_DEV_ATTR_BVRMSGAIN(S_IWUSR | S_IRUGO,
412 static IIO_DEV_ATTR_CVRMSGAIN(S_IWUSR | S_IRUGO,
417 int ade7758_set_irq(struct device *dev, bool enable)
421 ret = ade7758_spi_read_reg_24(dev, ADE7758_MASK, &irqen);
426 irqen |= 1 << 16; /* Enables an interrupt when a data is
427 present in the waveform register */
431 ret = ade7758_spi_write_reg_24(dev, ADE7758_MASK, irqen);
439 /* Power down the device */
440 static int ade7758_stop_device(struct device *dev)
444 ade7758_spi_read_reg_8(dev,
447 val |= 7 << 3; /* ADE7758 powered down */
448 ret = ade7758_spi_write_reg_8(dev,
455 static int ade7758_initial_setup(struct iio_dev *indio_dev)
457 struct ade7758_state *st = iio_priv(indio_dev);
458 struct device *dev = &indio_dev->dev;
461 /* use low spi speed for init */
462 st->us->mode = SPI_MODE_1;
466 ret = ade7758_set_irq(dev, false);
468 dev_err(dev, "disable irq failed");
473 msleep(ADE7758_STARTUP_DELAY);
479 static ssize_t ade7758_read_frequency(struct device *dev,
480 struct device_attribute *attr,
486 ret = ade7758_spi_read_reg_8(dev,
493 sps = 26040 / (1 << t);
495 len = sprintf(buf, "%d SPS\n", sps);
499 static ssize_t ade7758_write_frequency(struct device *dev,
500 struct device_attribute *attr,
504 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
509 ret = kstrtou16(buf, 10, &val);
513 mutex_lock(&indio_dev->mlock);
533 ret = ade7758_spi_read_reg_8(dev,
542 ret = ade7758_spi_write_reg_8(dev,
547 mutex_unlock(&indio_dev->mlock);
549 return ret ? ret : len;
552 static IIO_DEV_ATTR_TEMP_RAW(ade7758_read_8bit);
553 static IIO_CONST_ATTR(in_temp_offset, "129 C");
554 static IIO_CONST_ATTR(in_temp_scale, "4 C");
556 static IIO_DEV_ATTR_AWATTHR(ade7758_read_16bit,
558 static IIO_DEV_ATTR_BWATTHR(ade7758_read_16bit,
560 static IIO_DEV_ATTR_CWATTHR(ade7758_read_16bit,
562 static IIO_DEV_ATTR_AVARHR(ade7758_read_16bit,
564 static IIO_DEV_ATTR_BVARHR(ade7758_read_16bit,
566 static IIO_DEV_ATTR_CVARHR(ade7758_read_16bit,
568 static IIO_DEV_ATTR_AVAHR(ade7758_read_16bit,
570 static IIO_DEV_ATTR_BVAHR(ade7758_read_16bit,
572 static IIO_DEV_ATTR_CVAHR(ade7758_read_16bit,
575 static IIO_DEV_ATTR_SAMP_FREQ(S_IWUSR | S_IRUGO,
576 ade7758_read_frequency,
577 ade7758_write_frequency);
579 static IIO_CONST_ATTR_SAMP_FREQ_AVAIL("26040 13020 6510 3255");
581 static struct attribute *ade7758_attributes[] = {
582 &iio_dev_attr_in_temp_raw.dev_attr.attr,
583 &iio_const_attr_in_temp_offset.dev_attr.attr,
584 &iio_const_attr_in_temp_scale.dev_attr.attr,
585 &iio_dev_attr_sampling_frequency.dev_attr.attr,
586 &iio_const_attr_sampling_frequency_available.dev_attr.attr,
587 &iio_dev_attr_awatthr.dev_attr.attr,
588 &iio_dev_attr_bwatthr.dev_attr.attr,
589 &iio_dev_attr_cwatthr.dev_attr.attr,
590 &iio_dev_attr_avarhr.dev_attr.attr,
591 &iio_dev_attr_bvarhr.dev_attr.attr,
592 &iio_dev_attr_cvarhr.dev_attr.attr,
593 &iio_dev_attr_avahr.dev_attr.attr,
594 &iio_dev_attr_bvahr.dev_attr.attr,
595 &iio_dev_attr_cvahr.dev_attr.attr,
596 &iio_dev_attr_vpeak.dev_attr.attr,
597 &iio_dev_attr_ipeak.dev_attr.attr,
598 &iio_dev_attr_aphcal.dev_attr.attr,
599 &iio_dev_attr_bphcal.dev_attr.attr,
600 &iio_dev_attr_cphcal.dev_attr.attr,
601 &iio_dev_attr_wdiv.dev_attr.attr,
602 &iio_dev_attr_vadiv.dev_attr.attr,
603 &iio_dev_attr_airms.dev_attr.attr,
604 &iio_dev_attr_birms.dev_attr.attr,
605 &iio_dev_attr_cirms.dev_attr.attr,
606 &iio_dev_attr_avrms.dev_attr.attr,
607 &iio_dev_attr_bvrms.dev_attr.attr,
608 &iio_dev_attr_cvrms.dev_attr.attr,
609 &iio_dev_attr_aigain.dev_attr.attr,
610 &iio_dev_attr_bigain.dev_attr.attr,
611 &iio_dev_attr_cigain.dev_attr.attr,
612 &iio_dev_attr_avrmsgain.dev_attr.attr,
613 &iio_dev_attr_bvrmsgain.dev_attr.attr,
614 &iio_dev_attr_cvrmsgain.dev_attr.attr,
615 &iio_dev_attr_airmsos.dev_attr.attr,
616 &iio_dev_attr_birmsos.dev_attr.attr,
617 &iio_dev_attr_cirmsos.dev_attr.attr,
618 &iio_dev_attr_avrmsos.dev_attr.attr,
619 &iio_dev_attr_bvrmsos.dev_attr.attr,
620 &iio_dev_attr_cvrmsos.dev_attr.attr,
624 static const struct attribute_group ade7758_attribute_group = {
625 .attrs = ade7758_attributes,
628 static const struct iio_chan_spec ade7758_channels[] = {
633 .extend_name = "raw",
634 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
635 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE),
636 .address = AD7758_WT(AD7758_PHASE_A, AD7758_VOLTAGE),
647 .extend_name = "raw",
648 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
649 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE),
650 .address = AD7758_WT(AD7758_PHASE_A, AD7758_CURRENT),
661 .extend_name = "apparent_raw",
662 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
663 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE),
664 .address = AD7758_WT(AD7758_PHASE_A, AD7758_APP_PWR),
675 .extend_name = "active_raw",
676 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
677 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE),
678 .address = AD7758_WT(AD7758_PHASE_A, AD7758_ACT_PWR),
689 .extend_name = "reactive_raw",
690 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
691 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE),
692 .address = AD7758_WT(AD7758_PHASE_A, AD7758_REACT_PWR),
703 .extend_name = "raw",
704 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
705 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE),
706 .address = AD7758_WT(AD7758_PHASE_B, AD7758_VOLTAGE),
717 .extend_name = "raw",
718 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
719 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE),
720 .address = AD7758_WT(AD7758_PHASE_B, AD7758_CURRENT),
731 .extend_name = "apparent_raw",
732 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
733 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE),
734 .address = AD7758_WT(AD7758_PHASE_B, AD7758_APP_PWR),
745 .extend_name = "active_raw",
746 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
747 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE),
748 .address = AD7758_WT(AD7758_PHASE_B, AD7758_ACT_PWR),
759 .extend_name = "reactive_raw",
760 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
761 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE),
762 .address = AD7758_WT(AD7758_PHASE_B, AD7758_REACT_PWR),
773 .extend_name = "raw",
774 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
775 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE),
776 .address = AD7758_WT(AD7758_PHASE_C, AD7758_VOLTAGE),
787 .extend_name = "raw",
788 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
789 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE),
790 .address = AD7758_WT(AD7758_PHASE_C, AD7758_CURRENT),
801 .extend_name = "apparent_raw",
802 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
803 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE),
804 .address = AD7758_WT(AD7758_PHASE_C, AD7758_APP_PWR),
815 .extend_name = "active_raw",
816 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
817 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE),
818 .address = AD7758_WT(AD7758_PHASE_C, AD7758_ACT_PWR),
829 .extend_name = "reactive_raw",
830 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW),
831 .info_mask_shared_by_type = BIT(IIO_CHAN_INFO_SCALE),
832 .address = AD7758_WT(AD7758_PHASE_C, AD7758_REACT_PWR),
840 IIO_CHAN_SOFT_TIMESTAMP(15),
843 static const struct iio_info ade7758_info = {
844 .attrs = &ade7758_attribute_group,
845 .driver_module = THIS_MODULE,
848 static int ade7758_probe(struct spi_device *spi)
851 struct ade7758_state *st;
852 struct iio_dev *indio_dev;
854 indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*st));
858 st = iio_priv(indio_dev);
859 /* this is only used for removal purposes */
860 spi_set_drvdata(spi, indio_dev);
862 /* Allocate the comms buffers */
863 st->rx = kcalloc(ADE7758_MAX_RX, sizeof(*st->rx), GFP_KERNEL);
866 st->tx = kcalloc(ADE7758_MAX_TX, sizeof(*st->tx), GFP_KERNEL);
867 if (st->tx == NULL) {
872 st->ade7758_ring_channels = &ade7758_channels[0];
873 mutex_init(&st->buf_lock);
875 indio_dev->name = spi->dev.driver->name;
876 indio_dev->dev.parent = &spi->dev;
877 indio_dev->info = &ade7758_info;
878 indio_dev->modes = INDIO_DIRECT_MODE;
880 ret = ade7758_configure_ring(indio_dev);
884 ret = iio_buffer_register(indio_dev,
885 &ade7758_channels[0],
886 ARRAY_SIZE(ade7758_channels));
888 dev_err(&spi->dev, "failed to initialize the ring\n");
889 goto error_unreg_ring_funcs;
892 /* Get the device into a sane initial state */
893 ret = ade7758_initial_setup(indio_dev);
895 goto error_uninitialize_ring;
898 ret = ade7758_probe_trigger(indio_dev);
900 goto error_uninitialize_ring;
903 ret = iio_device_register(indio_dev);
905 goto error_remove_trigger;
909 error_remove_trigger:
911 ade7758_remove_trigger(indio_dev);
912 error_uninitialize_ring:
913 ade7758_uninitialize_ring(indio_dev);
914 error_unreg_ring_funcs:
915 ade7758_unconfigure_ring(indio_dev);
923 static int ade7758_remove(struct spi_device *spi)
925 struct iio_dev *indio_dev = spi_get_drvdata(spi);
926 struct ade7758_state *st = iio_priv(indio_dev);
928 iio_device_unregister(indio_dev);
929 ade7758_stop_device(&indio_dev->dev);
930 ade7758_remove_trigger(indio_dev);
931 ade7758_uninitialize_ring(indio_dev);
932 ade7758_unconfigure_ring(indio_dev);
939 static const struct spi_device_id ade7758_id[] = {
943 MODULE_DEVICE_TABLE(spi, ade7758_id);
945 static struct spi_driver ade7758_driver = {
948 .owner = THIS_MODULE,
950 .probe = ade7758_probe,
951 .remove = ade7758_remove,
952 .id_table = ade7758_id,
954 module_spi_driver(ade7758_driver);
956 MODULE_AUTHOR("Barry Song <21cnbao@gmail.com>");
957 MODULE_DESCRIPTION("Analog Devices ADE7758 Polyphase Multifunction Energy Metering IC Driver");
958 MODULE_LICENSE("GPL v2");