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,
31 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
32 struct ade7754_state *st = iio_priv(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 iio_dev *indio_dev = dev_to_iio_dev(dev);
50 struct ade7754_state *st = iio_priv(indio_dev);
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);
62 static int ade7754_spi_read_reg_8(struct device *dev,
66 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
67 struct ade7754_state *st = iio_priv(indio_dev);
70 ret = spi_w8r8(st->us, ADE7754_READ_REG(reg_address));
72 dev_err(&st->us->dev, "problem when reading 8 bit register 0x%02X",
81 static int ade7754_spi_read_reg_16(struct device *dev,
85 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
86 struct ade7754_state *st = iio_priv(indio_dev);
89 ret = spi_w8r16(st->us, ADE7754_READ_REG(reg_address));
91 dev_err(&st->us->dev, "problem when reading 16 bit register 0x%02X",
97 *val = be16_to_cpup(val);
102 static int ade7754_spi_read_reg_24(struct device *dev,
106 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
107 struct ade7754_state *st = iio_priv(indio_dev);
109 struct spi_transfer xfers[] = {
118 mutex_lock(&st->buf_lock);
119 st->tx[0] = ADE7754_READ_REG(reg_address);
124 ret = spi_sync_transfer(st->us, xfers, ARRAY_SIZE(xfers));
126 dev_err(&st->us->dev, "problem when reading 24 bit register 0x%02X",
130 *val = (st->rx[1] << 16) | (st->rx[2] << 8) | st->rx[3];
133 mutex_unlock(&st->buf_lock);
137 static ssize_t ade7754_read_8bit(struct device *dev,
138 struct device_attribute *attr,
143 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
145 ret = ade7754_spi_read_reg_8(dev, this_attr->address, &val);
149 return sprintf(buf, "%u\n", val);
152 static ssize_t ade7754_read_16bit(struct device *dev,
153 struct device_attribute *attr,
158 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
160 ret = ade7754_spi_read_reg_16(dev, this_attr->address, &val);
164 return sprintf(buf, "%u\n", val);
167 static ssize_t ade7754_read_24bit(struct device *dev,
168 struct device_attribute *attr,
173 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
175 ret = ade7754_spi_read_reg_24(dev, this_attr->address, &val);
179 return sprintf(buf, "%u\n", val & 0xFFFFFF);
182 static ssize_t ade7754_write_8bit(struct device *dev,
183 struct device_attribute *attr,
187 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
191 ret = strict_strtol(buf, 10, &val);
194 ret = ade7754_spi_write_reg_8(dev, this_attr->address, val);
197 return ret ? ret : len;
200 static ssize_t ade7754_write_16bit(struct device *dev,
201 struct device_attribute *attr,
205 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
209 ret = strict_strtol(buf, 10, &val);
212 ret = ade7754_spi_write_reg_16(dev, this_attr->address, val);
215 return ret ? ret : len;
218 static int ade7754_reset(struct device *dev)
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);
228 static ssize_t ade7754_write_reset(struct device *dev,
229 struct device_attribute *attr,
230 const char *buf, size_t len)
238 return ade7754_reset(dev);
243 static IIO_DEV_ATTR_AENERGY(ade7754_read_24bit, ADE7754_AENERGY);
244 static IIO_DEV_ATTR_LAENERGY(ade7754_read_24bit, ADE7754_LAENERGY);
245 static IIO_DEV_ATTR_VAENERGY(ade7754_read_24bit, ADE7754_VAENERGY);
246 static IIO_DEV_ATTR_LVAENERGY(ade7754_read_24bit, ADE7754_LVAENERGY);
247 static IIO_DEV_ATTR_VPEAK(S_IWUSR | S_IRUGO,
251 static IIO_DEV_ATTR_IPEAK(S_IWUSR | S_IRUGO,
255 static IIO_DEV_ATTR_APHCAL(S_IWUSR | S_IRUGO,
259 static IIO_DEV_ATTR_BPHCAL(S_IWUSR | S_IRUGO,
263 static IIO_DEV_ATTR_CPHCAL(S_IWUSR | S_IRUGO,
267 static IIO_DEV_ATTR_AAPOS(S_IWUSR | S_IRUGO,
271 static IIO_DEV_ATTR_BAPOS(S_IWUSR | S_IRUGO,
275 static IIO_DEV_ATTR_CAPOS(S_IWUSR | S_IRUGO,
279 static IIO_DEV_ATTR_WDIV(S_IWUSR | S_IRUGO,
283 static IIO_DEV_ATTR_VADIV(S_IWUSR | S_IRUGO,
287 static IIO_DEV_ATTR_CFNUM(S_IWUSR | S_IRUGO,
291 static IIO_DEV_ATTR_CFDEN(S_IWUSR | S_IRUGO,
295 static IIO_DEV_ATTR_ACTIVE_POWER_A_GAIN(S_IWUSR | S_IRUGO,
299 static IIO_DEV_ATTR_ACTIVE_POWER_B_GAIN(S_IWUSR | S_IRUGO,
303 static IIO_DEV_ATTR_ACTIVE_POWER_C_GAIN(S_IWUSR | S_IRUGO,
307 static IIO_DEV_ATTR_AIRMS(S_IRUGO,
311 static IIO_DEV_ATTR_BIRMS(S_IRUGO,
315 static IIO_DEV_ATTR_CIRMS(S_IRUGO,
319 static IIO_DEV_ATTR_AVRMS(S_IRUGO,
323 static IIO_DEV_ATTR_BVRMS(S_IRUGO,
327 static IIO_DEV_ATTR_CVRMS(S_IRUGO,
331 static IIO_DEV_ATTR_AIRMSOS(S_IRUGO,
335 static IIO_DEV_ATTR_BIRMSOS(S_IRUGO,
339 static IIO_DEV_ATTR_CIRMSOS(S_IRUGO,
343 static IIO_DEV_ATTR_AVRMSOS(S_IRUGO,
347 static IIO_DEV_ATTR_BVRMSOS(S_IRUGO,
351 static IIO_DEV_ATTR_CVRMSOS(S_IRUGO,
356 static int ade7754_set_irq(struct device *dev, bool enable)
360 ret = ade7754_spi_read_reg_16(dev, ADE7754_IRQEN, &irqen);
365 irqen |= 1 << 14; /* Enables an interrupt when a data is
366 present in the waveform register */
370 ret = ade7754_spi_write_reg_16(dev, ADE7754_IRQEN, irqen);
378 /* Power down the device */
379 static int ade7754_stop_device(struct device *dev)
383 ade7754_spi_read_reg_8(dev, ADE7754_OPMODE, &val);
384 val |= 7 << 3; /* ADE7754 powered down */
385 return ade7754_spi_write_reg_8(dev, ADE7754_OPMODE, val);
388 static int ade7754_initial_setup(struct iio_dev *indio_dev)
391 struct ade7754_state *st = iio_priv(indio_dev);
392 struct device *dev = &indio_dev->dev;
394 /* use low spi speed for init */
395 st->us->mode = SPI_MODE_3;
399 ret = ade7754_set_irq(dev, false);
401 dev_err(dev, "disable irq failed");
406 msleep(ADE7754_STARTUP_DELAY);
412 static ssize_t ade7754_read_frequency(struct device *dev,
413 struct device_attribute *attr,
419 ret = ade7754_spi_read_reg_8(dev,
426 sps = 26000 / (1 + t);
428 return sprintf(buf, "%d\n", sps);
431 static ssize_t ade7754_write_frequency(struct device *dev,
432 struct device_attribute *attr,
436 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
437 struct ade7754_state *st = iio_priv(indio_dev);
442 ret = strict_strtol(buf, 10, &val);
448 mutex_lock(&indio_dev->mlock);
455 st->us->max_speed_hz = ADE7754_SPI_SLOW;
457 st->us->max_speed_hz = ADE7754_SPI_FAST;
459 ret = ade7754_spi_read_reg_8(dev, ADE7754_WAVMODE, ®);
466 ret = ade7754_spi_write_reg_8(dev, ADE7754_WAVMODE, reg);
469 mutex_unlock(&indio_dev->mlock);
471 return ret ? ret : len;
473 static IIO_DEV_ATTR_TEMP_RAW(ade7754_read_8bit);
474 static IIO_CONST_ATTR(in_temp_offset, "129 C");
475 static IIO_CONST_ATTR(in_temp_scale, "4 C");
477 static IIO_DEV_ATTR_SAMP_FREQ(S_IWUSR | S_IRUGO,
478 ade7754_read_frequency,
479 ade7754_write_frequency);
481 static IIO_DEV_ATTR_RESET(ade7754_write_reset);
483 static IIO_CONST_ATTR_SAMP_FREQ_AVAIL("26000 13000 65000 33000");
485 static struct attribute *ade7754_attributes[] = {
486 &iio_dev_attr_in_temp_raw.dev_attr.attr,
487 &iio_const_attr_in_temp_offset.dev_attr.attr,
488 &iio_const_attr_in_temp_scale.dev_attr.attr,
489 &iio_dev_attr_sampling_frequency.dev_attr.attr,
490 &iio_const_attr_sampling_frequency_available.dev_attr.attr,
491 &iio_dev_attr_reset.dev_attr.attr,
492 &iio_dev_attr_aenergy.dev_attr.attr,
493 &iio_dev_attr_laenergy.dev_attr.attr,
494 &iio_dev_attr_vaenergy.dev_attr.attr,
495 &iio_dev_attr_lvaenergy.dev_attr.attr,
496 &iio_dev_attr_vpeak.dev_attr.attr,
497 &iio_dev_attr_ipeak.dev_attr.attr,
498 &iio_dev_attr_aphcal.dev_attr.attr,
499 &iio_dev_attr_bphcal.dev_attr.attr,
500 &iio_dev_attr_cphcal.dev_attr.attr,
501 &iio_dev_attr_aapos.dev_attr.attr,
502 &iio_dev_attr_bapos.dev_attr.attr,
503 &iio_dev_attr_capos.dev_attr.attr,
504 &iio_dev_attr_wdiv.dev_attr.attr,
505 &iio_dev_attr_vadiv.dev_attr.attr,
506 &iio_dev_attr_cfnum.dev_attr.attr,
507 &iio_dev_attr_cfden.dev_attr.attr,
508 &iio_dev_attr_active_power_a_gain.dev_attr.attr,
509 &iio_dev_attr_active_power_b_gain.dev_attr.attr,
510 &iio_dev_attr_active_power_c_gain.dev_attr.attr,
511 &iio_dev_attr_airms.dev_attr.attr,
512 &iio_dev_attr_birms.dev_attr.attr,
513 &iio_dev_attr_cirms.dev_attr.attr,
514 &iio_dev_attr_avrms.dev_attr.attr,
515 &iio_dev_attr_bvrms.dev_attr.attr,
516 &iio_dev_attr_cvrms.dev_attr.attr,
517 &iio_dev_attr_airmsos.dev_attr.attr,
518 &iio_dev_attr_birmsos.dev_attr.attr,
519 &iio_dev_attr_cirmsos.dev_attr.attr,
520 &iio_dev_attr_avrmsos.dev_attr.attr,
521 &iio_dev_attr_bvrmsos.dev_attr.attr,
522 &iio_dev_attr_cvrmsos.dev_attr.attr,
526 static const struct attribute_group ade7754_attribute_group = {
527 .attrs = ade7754_attributes,
530 static const struct iio_info ade7754_info = {
531 .attrs = &ade7754_attribute_group,
532 .driver_module = THIS_MODULE,
535 static int ade7754_probe(struct spi_device *spi)
538 struct ade7754_state *st;
539 struct iio_dev *indio_dev;
541 /* setup the industrialio driver allocated elements */
542 indio_dev = iio_device_alloc(sizeof(*st));
543 if (indio_dev == NULL) {
547 /* this is only used for removal purposes */
548 spi_set_drvdata(spi, indio_dev);
550 st = iio_priv(indio_dev);
552 mutex_init(&st->buf_lock);
554 indio_dev->name = spi->dev.driver->name;
555 indio_dev->dev.parent = &spi->dev;
556 indio_dev->info = &ade7754_info;
557 indio_dev->modes = INDIO_DIRECT_MODE;
559 /* Get the device into a sane initial state */
560 ret = ade7754_initial_setup(indio_dev);
563 ret = iio_device_register(indio_dev);
570 iio_device_free(indio_dev);
576 /* fixme, confirm ordering in this function */
577 static int ade7754_remove(struct spi_device *spi)
579 struct iio_dev *indio_dev = spi_get_drvdata(spi);
581 iio_device_unregister(indio_dev);
582 ade7754_stop_device(&indio_dev->dev);
583 iio_device_free(indio_dev);
588 static struct spi_driver ade7754_driver = {
591 .owner = THIS_MODULE,
593 .probe = ade7754_probe,
594 .remove = ade7754_remove,
596 module_spi_driver(ade7754_driver);
598 MODULE_AUTHOR("Barry Song <21cnbao@gmail.com>");
599 MODULE_DESCRIPTION("Analog Devices ADE7754 Polyphase Multifunction Energy Metering IC Driver");
600 MODULE_LICENSE("GPL v2");
601 MODULE_ALIAS("spi:ad7754");