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/gpio.h>
12 #include <linux/delay.h>
13 #include <linux/mutex.h>
14 #include <linux/device.h>
15 #include <linux/kernel.h>
16 #include <linux/spi/spi.h>
17 #include <linux/slab.h>
18 #include <linux/sysfs.h>
19 #include <linux/list.h>
26 static int ade7754_spi_write_reg_8(struct device *dev,
31 struct iio_dev *indio_dev = dev_get_drvdata(dev);
32 struct ade7754_state *st = iio_dev_get_devdata(indio_dev);
34 mutex_lock(&st->buf_lock);
35 st->tx[0] = ADE7754_WRITE_REG(reg_address);
38 ret = spi_write(st->us, st->tx, 2);
39 mutex_unlock(&st->buf_lock);
44 static int ade7754_spi_write_reg_16(struct device *dev,
49 struct spi_message msg;
50 struct iio_dev *indio_dev = dev_get_drvdata(dev);
51 struct ade7754_state *st = iio_dev_get_devdata(indio_dev);
52 struct spi_transfer xfers[] = {
60 mutex_lock(&st->buf_lock);
61 st->tx[0] = ADE7754_WRITE_REG(reg_address);
62 st->tx[1] = (value >> 8) & 0xFF;
63 st->tx[2] = value & 0xFF;
65 spi_message_init(&msg);
66 spi_message_add_tail(xfers, &msg);
67 ret = spi_sync(st->us, &msg);
68 mutex_unlock(&st->buf_lock);
73 static int ade7754_spi_read_reg_8(struct device *dev,
77 struct spi_message msg;
78 struct iio_dev *indio_dev = dev_get_drvdata(dev);
79 struct ade7754_state *st = iio_dev_get_devdata(indio_dev);
81 struct spi_transfer xfers[] = {
90 mutex_lock(&st->buf_lock);
91 st->tx[0] = ADE7754_READ_REG(reg_address);
94 spi_message_init(&msg);
95 spi_message_add_tail(xfers, &msg);
96 ret = spi_sync(st->us, &msg);
98 dev_err(&st->us->dev, "problem when reading 8 bit register 0x%02X",
105 mutex_unlock(&st->buf_lock);
109 static int ade7754_spi_read_reg_16(struct device *dev,
113 struct spi_message msg;
114 struct iio_dev *indio_dev = dev_get_drvdata(dev);
115 struct ade7754_state *st = iio_dev_get_devdata(indio_dev);
117 struct spi_transfer xfers[] = {
126 mutex_lock(&st->buf_lock);
127 st->tx[0] = ADE7754_READ_REG(reg_address);
131 spi_message_init(&msg);
132 spi_message_add_tail(xfers, &msg);
133 ret = spi_sync(st->us, &msg);
135 dev_err(&st->us->dev, "problem when reading 16 bit register 0x%02X",
139 *val = (st->rx[1] << 8) | st->rx[2];
142 mutex_unlock(&st->buf_lock);
146 static int ade7754_spi_read_reg_24(struct device *dev,
150 struct spi_message msg;
151 struct iio_dev *indio_dev = dev_get_drvdata(dev);
152 struct ade7754_state *st = iio_dev_get_devdata(indio_dev);
154 struct spi_transfer xfers[] = {
163 mutex_lock(&st->buf_lock);
164 st->tx[0] = ADE7754_READ_REG(reg_address);
169 spi_message_init(&msg);
170 spi_message_add_tail(xfers, &msg);
171 ret = spi_sync(st->us, &msg);
173 dev_err(&st->us->dev, "problem when reading 24 bit register 0x%02X",
177 *val = (st->rx[1] << 16) | (st->rx[2] << 8) | st->rx[3];
180 mutex_unlock(&st->buf_lock);
184 static ssize_t ade7754_read_8bit(struct device *dev,
185 struct device_attribute *attr,
190 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
192 ret = ade7754_spi_read_reg_8(dev, this_attr->address, &val);
196 return sprintf(buf, "%u\n", val);
199 static ssize_t ade7754_read_16bit(struct device *dev,
200 struct device_attribute *attr,
205 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
207 ret = ade7754_spi_read_reg_16(dev, this_attr->address, &val);
211 return sprintf(buf, "%u\n", val);
214 static ssize_t ade7754_read_24bit(struct device *dev,
215 struct device_attribute *attr,
220 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
222 ret = ade7754_spi_read_reg_24(dev, this_attr->address, &val);
226 return sprintf(buf, "%u\n", val & 0xFFFFFF);
229 static ssize_t ade7754_write_8bit(struct device *dev,
230 struct device_attribute *attr,
234 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
238 ret = strict_strtol(buf, 10, &val);
241 ret = ade7754_spi_write_reg_8(dev, this_attr->address, val);
244 return ret ? ret : len;
247 static ssize_t ade7754_write_16bit(struct device *dev,
248 struct device_attribute *attr,
252 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
256 ret = strict_strtol(buf, 10, &val);
259 ret = ade7754_spi_write_reg_16(dev, this_attr->address, val);
262 return ret ? ret : len;
265 static int ade7754_reset(struct device *dev)
269 ade7754_spi_read_reg_8(dev,
272 val |= 1 << 6; /* Software Chip Reset */
273 ret = ade7754_spi_write_reg_8(dev,
281 static ssize_t ade7754_write_reset(struct device *dev,
282 struct device_attribute *attr,
283 const char *buf, size_t len)
291 return ade7754_reset(dev);
296 static IIO_DEV_ATTR_AENERGY(ade7754_read_24bit, ADE7754_AENERGY);
297 static IIO_DEV_ATTR_LAENERGY(ade7754_read_24bit, ADE7754_LAENERGY);
298 static IIO_DEV_ATTR_VAENERGY(ade7754_read_24bit, ADE7754_VAENERGY);
299 static IIO_DEV_ATTR_LVAENERGY(ade7754_read_24bit, ADE7754_LVAENERGY);
300 static IIO_DEV_ATTR_VPEAK(S_IWUSR | S_IRUGO,
304 static IIO_DEV_ATTR_IPEAK(S_IWUSR | S_IRUGO,
308 static IIO_DEV_ATTR_APHCAL(S_IWUSR | S_IRUGO,
312 static IIO_DEV_ATTR_BPHCAL(S_IWUSR | S_IRUGO,
316 static IIO_DEV_ATTR_CPHCAL(S_IWUSR | S_IRUGO,
320 static IIO_DEV_ATTR_AAPOS(S_IWUSR | S_IRUGO,
324 static IIO_DEV_ATTR_BAPOS(S_IWUSR | S_IRUGO,
328 static IIO_DEV_ATTR_CAPOS(S_IWUSR | S_IRUGO,
332 static IIO_DEV_ATTR_WDIV(S_IWUSR | S_IRUGO,
336 static IIO_DEV_ATTR_VADIV(S_IWUSR | S_IRUGO,
340 static IIO_DEV_ATTR_CFNUM(S_IWUSR | S_IRUGO,
344 static IIO_DEV_ATTR_CFDEN(S_IWUSR | S_IRUGO,
348 static IIO_DEV_ATTR_ACTIVE_POWER_A_GAIN(S_IWUSR | S_IRUGO,
352 static IIO_DEV_ATTR_ACTIVE_POWER_B_GAIN(S_IWUSR | S_IRUGO,
356 static IIO_DEV_ATTR_ACTIVE_POWER_C_GAIN(S_IWUSR | S_IRUGO,
360 static IIO_DEV_ATTR_AIRMS(S_IRUGO,
364 static IIO_DEV_ATTR_BIRMS(S_IRUGO,
368 static IIO_DEV_ATTR_CIRMS(S_IRUGO,
372 static IIO_DEV_ATTR_AVRMS(S_IRUGO,
376 static IIO_DEV_ATTR_BVRMS(S_IRUGO,
380 static IIO_DEV_ATTR_CVRMS(S_IRUGO,
384 static IIO_DEV_ATTR_AIRMSOS(S_IRUGO,
388 static IIO_DEV_ATTR_BIRMSOS(S_IRUGO,
392 static IIO_DEV_ATTR_CIRMSOS(S_IRUGO,
396 static IIO_DEV_ATTR_AVRMSOS(S_IRUGO,
400 static IIO_DEV_ATTR_BVRMSOS(S_IRUGO,
404 static IIO_DEV_ATTR_CVRMSOS(S_IRUGO,
409 static int ade7754_set_irq(struct device *dev, bool enable)
413 ret = ade7754_spi_read_reg_16(dev, ADE7754_IRQEN, &irqen);
418 irqen |= 1 << 14; /* Enables an interrupt when a data is
419 present in the waveform register */
423 ret = ade7754_spi_write_reg_16(dev, ADE7754_IRQEN, irqen);
431 /* Power down the device */
432 static int ade7754_stop_device(struct device *dev)
436 ade7754_spi_read_reg_8(dev,
439 val |= 7 << 3; /* ADE7754 powered down */
440 ret = ade7754_spi_write_reg_8(dev,
447 static int ade7754_initial_setup(struct ade7754_state *st)
450 struct device *dev = &st->indio_dev->dev;
452 /* use low spi speed for init */
453 st->us->mode = SPI_MODE_3;
457 ret = ade7754_set_irq(dev, false);
459 dev_err(dev, "disable irq failed");
464 msleep(ADE7754_STARTUP_DELAY);
470 static ssize_t ade7754_read_frequency(struct device *dev,
471 struct device_attribute *attr,
477 ret = ade7754_spi_read_reg_8(dev,
484 sps = 26000 / (1 + t);
486 len = sprintf(buf, "%d SPS\n", sps);
490 static ssize_t ade7754_write_frequency(struct device *dev,
491 struct device_attribute *attr,
495 struct iio_dev *indio_dev = dev_get_drvdata(dev);
496 struct ade7754_state *st = iio_dev_get_devdata(indio_dev);
501 ret = strict_strtol(buf, 10, &val);
505 mutex_lock(&indio_dev->mlock);
512 st->us->max_speed_hz = ADE7754_SPI_SLOW;
514 st->us->max_speed_hz = ADE7754_SPI_FAST;
516 ret = ade7754_spi_read_reg_8(dev,
525 ret = ade7754_spi_write_reg_8(dev,
530 mutex_unlock(&indio_dev->mlock);
532 return ret ? ret : len;
534 static IIO_DEV_ATTR_TEMP_RAW(ade7754_read_8bit);
535 static IIO_CONST_ATTR(temp_offset, "129 C");
536 static IIO_CONST_ATTR(temp_scale, "4 C");
538 static IIO_DEV_ATTR_SAMP_FREQ(S_IWUSR | S_IRUGO,
539 ade7754_read_frequency,
540 ade7754_write_frequency);
542 static IIO_DEV_ATTR_RESET(ade7754_write_reset);
544 static IIO_CONST_ATTR_SAMP_FREQ_AVAIL("26000 13000 65000 33000");
546 static IIO_CONST_ATTR(name, "ade7754");
548 static struct attribute *ade7754_event_attributes[] = {
552 static struct attribute_group ade7754_event_attribute_group = {
553 .attrs = ade7754_event_attributes,
556 static struct attribute *ade7754_attributes[] = {
557 &iio_dev_attr_temp_raw.dev_attr.attr,
558 &iio_const_attr_temp_offset.dev_attr.attr,
559 &iio_const_attr_temp_scale.dev_attr.attr,
560 &iio_dev_attr_sampling_frequency.dev_attr.attr,
561 &iio_const_attr_sampling_frequency_available.dev_attr.attr,
562 &iio_dev_attr_reset.dev_attr.attr,
563 &iio_const_attr_name.dev_attr.attr,
564 &iio_dev_attr_aenergy.dev_attr.attr,
565 &iio_dev_attr_laenergy.dev_attr.attr,
566 &iio_dev_attr_vaenergy.dev_attr.attr,
567 &iio_dev_attr_lvaenergy.dev_attr.attr,
568 &iio_dev_attr_vpeak.dev_attr.attr,
569 &iio_dev_attr_ipeak.dev_attr.attr,
570 &iio_dev_attr_aphcal.dev_attr.attr,
571 &iio_dev_attr_bphcal.dev_attr.attr,
572 &iio_dev_attr_cphcal.dev_attr.attr,
573 &iio_dev_attr_aapos.dev_attr.attr,
574 &iio_dev_attr_bapos.dev_attr.attr,
575 &iio_dev_attr_capos.dev_attr.attr,
576 &iio_dev_attr_wdiv.dev_attr.attr,
577 &iio_dev_attr_vadiv.dev_attr.attr,
578 &iio_dev_attr_cfnum.dev_attr.attr,
579 &iio_dev_attr_cfden.dev_attr.attr,
580 &iio_dev_attr_active_power_a_gain.dev_attr.attr,
581 &iio_dev_attr_active_power_b_gain.dev_attr.attr,
582 &iio_dev_attr_active_power_c_gain.dev_attr.attr,
583 &iio_dev_attr_airms.dev_attr.attr,
584 &iio_dev_attr_birms.dev_attr.attr,
585 &iio_dev_attr_cirms.dev_attr.attr,
586 &iio_dev_attr_avrms.dev_attr.attr,
587 &iio_dev_attr_bvrms.dev_attr.attr,
588 &iio_dev_attr_cvrms.dev_attr.attr,
589 &iio_dev_attr_airmsos.dev_attr.attr,
590 &iio_dev_attr_birmsos.dev_attr.attr,
591 &iio_dev_attr_cirmsos.dev_attr.attr,
592 &iio_dev_attr_avrmsos.dev_attr.attr,
593 &iio_dev_attr_bvrmsos.dev_attr.attr,
594 &iio_dev_attr_cvrmsos.dev_attr.attr,
598 static const struct attribute_group ade7754_attribute_group = {
599 .attrs = ade7754_attributes,
604 static int __devinit ade7754_probe(struct spi_device *spi)
606 int ret, regdone = 0;
607 struct ade7754_state *st = kzalloc(sizeof *st, GFP_KERNEL);
612 /* this is only used for removal purposes */
613 spi_set_drvdata(spi, st);
615 /* Allocate the comms buffers */
616 st->rx = kzalloc(sizeof(*st->rx)*ADE7754_MAX_RX, GFP_KERNEL);
617 if (st->rx == NULL) {
621 st->tx = kzalloc(sizeof(*st->tx)*ADE7754_MAX_TX, GFP_KERNEL);
622 if (st->tx == NULL) {
627 mutex_init(&st->buf_lock);
628 /* setup the industrialio driver allocated elements */
629 st->indio_dev = iio_allocate_device();
630 if (st->indio_dev == NULL) {
635 st->indio_dev->dev.parent = &spi->dev;
636 st->indio_dev->num_interrupt_lines = 1;
637 st->indio_dev->event_attrs = &ade7754_event_attribute_group;
638 st->indio_dev->attrs = &ade7754_attribute_group;
639 st->indio_dev->dev_data = (void *)(st);
640 st->indio_dev->driver_module = THIS_MODULE;
641 st->indio_dev->modes = INDIO_DIRECT_MODE;
643 ret = ade7754_configure_ring(st->indio_dev);
647 ret = iio_device_register(st->indio_dev);
649 goto error_unreg_ring_funcs;
652 ret = ade7754_initialize_ring(st->indio_dev->ring);
654 printk(KERN_ERR "failed to initialize the ring\n");
655 goto error_unreg_ring_funcs;
659 ret = iio_register_interrupt_line(spi->irq,
662 IRQF_TRIGGER_FALLING,
665 goto error_uninitialize_ring;
667 ret = ade7754_probe_trigger(st->indio_dev);
669 goto error_unregister_line;
672 /* Get the device into a sane initial state */
673 ret = ade7754_initial_setup(st);
675 goto error_remove_trigger;
678 error_remove_trigger:
679 if (st->indio_dev->modes & INDIO_RING_TRIGGERED)
680 ade7754_remove_trigger(st->indio_dev);
681 error_unregister_line:
682 if (st->indio_dev->modes & INDIO_RING_TRIGGERED)
683 iio_unregister_interrupt_line(st->indio_dev, 0);
684 error_uninitialize_ring:
685 ade7754_uninitialize_ring(st->indio_dev->ring);
686 error_unreg_ring_funcs:
687 ade7754_unconfigure_ring(st->indio_dev);
690 iio_device_unregister(st->indio_dev);
692 iio_free_device(st->indio_dev);
703 /* fixme, confirm ordering in this function */
704 static int ade7754_remove(struct spi_device *spi)
707 struct ade7754_state *st = spi_get_drvdata(spi);
708 struct iio_dev *indio_dev = st->indio_dev;
710 ret = ade7754_stop_device(&(indio_dev->dev));
714 flush_scheduled_work();
716 ade7754_remove_trigger(indio_dev);
718 iio_unregister_interrupt_line(indio_dev, 0);
720 ade7754_uninitialize_ring(indio_dev->ring);
721 ade7754_unconfigure_ring(indio_dev);
722 iio_device_unregister(indio_dev);
733 static struct spi_driver ade7754_driver = {
736 .owner = THIS_MODULE,
738 .probe = ade7754_probe,
739 .remove = __devexit_p(ade7754_remove),
742 static __init int ade7754_init(void)
744 return spi_register_driver(&ade7754_driver);
746 module_init(ade7754_init);
748 static __exit void ade7754_exit(void)
750 spi_unregister_driver(&ade7754_driver);
752 module_exit(ade7754_exit);
754 MODULE_AUTHOR("Barry Song <21cnbao@gmail.com>");
755 MODULE_DESCRIPTION("Analog Devices ADE7754 Polyphase Multifunction Energy Metering IC Driver");
756 MODULE_LICENSE("GPL v2");