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_w8r16be(st->us, ADE7754_READ_REG(reg_address));
91 dev_err(&st->us->dev, "problem when reading 16 bit register 0x%02X",
101 static int ade7754_spi_read_reg_24(struct device *dev,
105 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
106 struct ade7754_state *st = iio_priv(indio_dev);
108 struct spi_transfer xfers[] = {
117 mutex_lock(&st->buf_lock);
118 st->tx[0] = ADE7754_READ_REG(reg_address);
123 ret = spi_sync_transfer(st->us, xfers, ARRAY_SIZE(xfers));
125 dev_err(&st->us->dev, "problem when reading 24 bit register 0x%02X",
129 *val = (st->rx[1] << 16) | (st->rx[2] << 8) | st->rx[3];
132 mutex_unlock(&st->buf_lock);
136 static ssize_t ade7754_read_8bit(struct device *dev,
137 struct device_attribute *attr,
142 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
144 ret = ade7754_spi_read_reg_8(dev, this_attr->address, &val);
148 return sprintf(buf, "%u\n", val);
151 static ssize_t ade7754_read_16bit(struct device *dev,
152 struct device_attribute *attr,
157 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
159 ret = ade7754_spi_read_reg_16(dev, this_attr->address, &val);
163 return sprintf(buf, "%u\n", val);
166 static ssize_t ade7754_read_24bit(struct device *dev,
167 struct device_attribute *attr,
172 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
174 ret = ade7754_spi_read_reg_24(dev, this_attr->address, &val);
178 return sprintf(buf, "%u\n", val & 0xFFFFFF);
181 static ssize_t ade7754_write_8bit(struct device *dev,
182 struct device_attribute *attr,
186 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
190 ret = kstrtou8(buf, 10, &val);
193 ret = ade7754_spi_write_reg_8(dev, this_attr->address, val);
196 return ret ? ret : len;
199 static ssize_t ade7754_write_16bit(struct device *dev,
200 struct device_attribute *attr,
204 struct iio_dev_attr *this_attr = to_iio_dev_attr(attr);
208 ret = kstrtou16(buf, 10, &val);
211 ret = ade7754_spi_write_reg_16(dev, this_attr->address, val);
214 return ret ? ret : len;
217 static int ade7754_reset(struct device *dev)
221 ade7754_spi_read_reg_8(dev, ADE7754_OPMODE, &val);
222 val |= 1 << 6; /* Software Chip Reset */
223 return ade7754_spi_write_reg_8(dev, ADE7754_OPMODE, val);
226 static IIO_DEV_ATTR_AENERGY(ade7754_read_24bit, ADE7754_AENERGY);
227 static IIO_DEV_ATTR_LAENERGY(ade7754_read_24bit, ADE7754_LAENERGY);
228 static IIO_DEV_ATTR_VAENERGY(ade7754_read_24bit, ADE7754_VAENERGY);
229 static IIO_DEV_ATTR_LVAENERGY(ade7754_read_24bit, ADE7754_LVAENERGY);
230 static IIO_DEV_ATTR_VPEAK(S_IWUSR | S_IRUGO,
234 static IIO_DEV_ATTR_IPEAK(S_IWUSR | S_IRUGO,
238 static IIO_DEV_ATTR_APHCAL(S_IWUSR | S_IRUGO,
242 static IIO_DEV_ATTR_BPHCAL(S_IWUSR | S_IRUGO,
246 static IIO_DEV_ATTR_CPHCAL(S_IWUSR | S_IRUGO,
250 static IIO_DEV_ATTR_AAPOS(S_IWUSR | S_IRUGO,
254 static IIO_DEV_ATTR_BAPOS(S_IWUSR | S_IRUGO,
258 static IIO_DEV_ATTR_CAPOS(S_IWUSR | S_IRUGO,
262 static IIO_DEV_ATTR_WDIV(S_IWUSR | S_IRUGO,
266 static IIO_DEV_ATTR_VADIV(S_IWUSR | S_IRUGO,
270 static IIO_DEV_ATTR_CFNUM(S_IWUSR | S_IRUGO,
274 static IIO_DEV_ATTR_CFDEN(S_IWUSR | S_IRUGO,
278 static IIO_DEV_ATTR_ACTIVE_POWER_A_GAIN(S_IWUSR | S_IRUGO,
282 static IIO_DEV_ATTR_ACTIVE_POWER_B_GAIN(S_IWUSR | S_IRUGO,
286 static IIO_DEV_ATTR_ACTIVE_POWER_C_GAIN(S_IWUSR | S_IRUGO,
290 static IIO_DEV_ATTR_AIRMS(S_IRUGO,
294 static IIO_DEV_ATTR_BIRMS(S_IRUGO,
298 static IIO_DEV_ATTR_CIRMS(S_IRUGO,
302 static IIO_DEV_ATTR_AVRMS(S_IRUGO,
306 static IIO_DEV_ATTR_BVRMS(S_IRUGO,
310 static IIO_DEV_ATTR_CVRMS(S_IRUGO,
314 static IIO_DEV_ATTR_AIRMSOS(S_IRUGO,
318 static IIO_DEV_ATTR_BIRMSOS(S_IRUGO,
322 static IIO_DEV_ATTR_CIRMSOS(S_IRUGO,
326 static IIO_DEV_ATTR_AVRMSOS(S_IRUGO,
330 static IIO_DEV_ATTR_BVRMSOS(S_IRUGO,
334 static IIO_DEV_ATTR_CVRMSOS(S_IRUGO,
339 static int ade7754_set_irq(struct device *dev, bool enable)
343 ret = ade7754_spi_read_reg_16(dev, ADE7754_IRQEN, &irqen);
348 irqen |= 1 << 14; /* Enables an interrupt when a data is
349 present in the waveform register */
353 ret = ade7754_spi_write_reg_16(dev, ADE7754_IRQEN, irqen);
361 /* Power down the device */
362 static int ade7754_stop_device(struct device *dev)
366 ade7754_spi_read_reg_8(dev, ADE7754_OPMODE, &val);
367 val |= 7 << 3; /* ADE7754 powered down */
368 return ade7754_spi_write_reg_8(dev, ADE7754_OPMODE, val);
371 static int ade7754_initial_setup(struct iio_dev *indio_dev)
374 struct ade7754_state *st = iio_priv(indio_dev);
375 struct device *dev = &indio_dev->dev;
377 /* use low spi speed for init */
378 st->us->mode = SPI_MODE_3;
382 ret = ade7754_set_irq(dev, false);
384 dev_err(dev, "disable irq failed");
389 msleep(ADE7754_STARTUP_DELAY);
395 static ssize_t ade7754_read_frequency(struct device *dev,
396 struct device_attribute *attr,
402 ret = ade7754_spi_read_reg_8(dev,
409 sps = 26000 / (1 + t);
411 return sprintf(buf, "%d\n", sps);
414 static ssize_t ade7754_write_frequency(struct device *dev,
415 struct device_attribute *attr,
419 struct iio_dev *indio_dev = dev_to_iio_dev(dev);
420 struct ade7754_state *st = iio_priv(indio_dev);
425 ret = kstrtou16(buf, 10, &val);
431 mutex_lock(&indio_dev->mlock);
438 st->us->max_speed_hz = ADE7754_SPI_SLOW;
440 st->us->max_speed_hz = ADE7754_SPI_FAST;
442 ret = ade7754_spi_read_reg_8(dev, ADE7754_WAVMODE, ®);
449 ret = ade7754_spi_write_reg_8(dev, ADE7754_WAVMODE, reg);
452 mutex_unlock(&indio_dev->mlock);
454 return ret ? ret : len;
456 static IIO_DEV_ATTR_TEMP_RAW(ade7754_read_8bit);
457 static IIO_CONST_ATTR(in_temp_offset, "129 C");
458 static IIO_CONST_ATTR(in_temp_scale, "4 C");
460 static IIO_DEV_ATTR_SAMP_FREQ(S_IWUSR | S_IRUGO,
461 ade7754_read_frequency,
462 ade7754_write_frequency);
464 static IIO_CONST_ATTR_SAMP_FREQ_AVAIL("26000 13000 65000 33000");
466 static struct attribute *ade7754_attributes[] = {
467 &iio_dev_attr_in_temp_raw.dev_attr.attr,
468 &iio_const_attr_in_temp_offset.dev_attr.attr,
469 &iio_const_attr_in_temp_scale.dev_attr.attr,
470 &iio_dev_attr_sampling_frequency.dev_attr.attr,
471 &iio_const_attr_sampling_frequency_available.dev_attr.attr,
472 &iio_dev_attr_aenergy.dev_attr.attr,
473 &iio_dev_attr_laenergy.dev_attr.attr,
474 &iio_dev_attr_vaenergy.dev_attr.attr,
475 &iio_dev_attr_lvaenergy.dev_attr.attr,
476 &iio_dev_attr_vpeak.dev_attr.attr,
477 &iio_dev_attr_ipeak.dev_attr.attr,
478 &iio_dev_attr_aphcal.dev_attr.attr,
479 &iio_dev_attr_bphcal.dev_attr.attr,
480 &iio_dev_attr_cphcal.dev_attr.attr,
481 &iio_dev_attr_aapos.dev_attr.attr,
482 &iio_dev_attr_bapos.dev_attr.attr,
483 &iio_dev_attr_capos.dev_attr.attr,
484 &iio_dev_attr_wdiv.dev_attr.attr,
485 &iio_dev_attr_vadiv.dev_attr.attr,
486 &iio_dev_attr_cfnum.dev_attr.attr,
487 &iio_dev_attr_cfden.dev_attr.attr,
488 &iio_dev_attr_active_power_a_gain.dev_attr.attr,
489 &iio_dev_attr_active_power_b_gain.dev_attr.attr,
490 &iio_dev_attr_active_power_c_gain.dev_attr.attr,
491 &iio_dev_attr_airms.dev_attr.attr,
492 &iio_dev_attr_birms.dev_attr.attr,
493 &iio_dev_attr_cirms.dev_attr.attr,
494 &iio_dev_attr_avrms.dev_attr.attr,
495 &iio_dev_attr_bvrms.dev_attr.attr,
496 &iio_dev_attr_cvrms.dev_attr.attr,
497 &iio_dev_attr_airmsos.dev_attr.attr,
498 &iio_dev_attr_birmsos.dev_attr.attr,
499 &iio_dev_attr_cirmsos.dev_attr.attr,
500 &iio_dev_attr_avrmsos.dev_attr.attr,
501 &iio_dev_attr_bvrmsos.dev_attr.attr,
502 &iio_dev_attr_cvrmsos.dev_attr.attr,
506 static const struct attribute_group ade7754_attribute_group = {
507 .attrs = ade7754_attributes,
510 static const struct iio_info ade7754_info = {
511 .attrs = &ade7754_attribute_group,
512 .driver_module = THIS_MODULE,
515 static int ade7754_probe(struct spi_device *spi)
518 struct ade7754_state *st;
519 struct iio_dev *indio_dev;
521 /* setup the industrialio driver allocated elements */
522 indio_dev = devm_iio_device_alloc(&spi->dev, sizeof(*st));
525 /* this is only used for removal purposes */
526 spi_set_drvdata(spi, indio_dev);
528 st = iio_priv(indio_dev);
530 mutex_init(&st->buf_lock);
532 indio_dev->name = spi->dev.driver->name;
533 indio_dev->dev.parent = &spi->dev;
534 indio_dev->info = &ade7754_info;
535 indio_dev->modes = INDIO_DIRECT_MODE;
537 /* Get the device into a sane initial state */
538 ret = ade7754_initial_setup(indio_dev);
541 ret = iio_device_register(indio_dev);
548 /* fixme, confirm ordering in this function */
549 static int ade7754_remove(struct spi_device *spi)
551 struct iio_dev *indio_dev = spi_get_drvdata(spi);
553 iio_device_unregister(indio_dev);
554 ade7754_stop_device(&indio_dev->dev);
559 static struct spi_driver ade7754_driver = {
562 .owner = THIS_MODULE,
564 .probe = ade7754_probe,
565 .remove = ade7754_remove,
567 module_spi_driver(ade7754_driver);
569 MODULE_AUTHOR("Barry Song <21cnbao@gmail.com>");
570 MODULE_DESCRIPTION("Analog Devices ADE7754 Polyphase Multifunction Energy Metering IC Driver");
571 MODULE_LICENSE("GPL v2");
572 MODULE_ALIAS("spi:ad7754");