2 * INA2XX Current and Power Monitors
4 * Copyright 2015 Baylibre SAS.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation.
10 * Based on linux/drivers/iio/adc/ad7291.c
11 * Copyright 2010-2011 Analog Devices Inc.
13 * Based on linux/drivers/hwmon/ina2xx.c
14 * Copyright 2012 Lothar Felten <l-felten@ti.com>
16 * Licensed under the GPL-2 or later.
18 * IIO driver for INA219-220-226-230-231
20 * Configurable 7-bit I2C slave address from 0x40 to 0x4F
23 #include <linux/delay.h>
24 #include <linux/i2c.h>
25 #include <linux/iio/kfifo_buf.h>
26 #include <linux/iio/sysfs.h>
27 #include <linux/kthread.h>
28 #include <linux/module.h>
29 #include <linux/regmap.h>
30 #include <linux/util_macros.h>
32 #include <linux/platform_data/ina2xx.h>
34 /* INA2XX registers definition */
35 #define INA2XX_CONFIG 0x00
36 #define INA2XX_SHUNT_VOLTAGE 0x01 /* readonly */
37 #define INA2XX_BUS_VOLTAGE 0x02 /* readonly */
38 #define INA2XX_POWER 0x03 /* readonly */
39 #define INA2XX_CURRENT 0x04 /* readonly */
40 #define INA2XX_CALIBRATION 0x05
42 #define INA226_ALERT_MASK GENMASK(2, 1)
43 #define INA266_CVRF BIT(3)
45 #define INA2XX_MAX_REGISTERS 8
47 /* settings - depend on use case */
48 #define INA219_CONFIG_DEFAULT 0x399F /* PGA=8 */
49 #define INA226_CONFIG_DEFAULT 0x4327
50 #define INA226_DEFAULT_AVG 4
51 #define INA226_DEFAULT_IT 1110
53 #define INA2XX_RSHUNT_DEFAULT 10000
56 * bit mask for reading the averaging setting in the configuration register
57 * FIXME: use regmap_fields.
59 #define INA2XX_MODE_MASK GENMASK(3, 0)
61 #define INA226_AVG_MASK GENMASK(11, 9)
62 #define INA226_SHIFT_AVG(val) ((val) << 9)
64 /* Integration time for VBus */
65 #define INA226_ITB_MASK GENMASK(8, 6)
66 #define INA226_SHIFT_ITB(val) ((val) << 6)
68 /* Integration time for VShunt */
69 #define INA226_ITS_MASK GENMASK(5, 3)
70 #define INA226_SHIFT_ITS(val) ((val) << 3)
72 /* Cosmetic macro giving the sampling period for a full P=UxI cycle */
73 #define SAMPLING_PERIOD(c) ((c->int_time_vbus + c->int_time_vshunt) \
76 static bool ina2xx_is_writeable_reg(struct device
*dev
, unsigned int reg
)
78 return (reg
== INA2XX_CONFIG
) || (reg
> INA2XX_CURRENT
);
81 static bool ina2xx_is_volatile_reg(struct device
*dev
, unsigned int reg
)
83 return (reg
!= INA2XX_CONFIG
);
86 static inline bool is_signed_reg(unsigned int reg
)
88 return (reg
== INA2XX_SHUNT_VOLTAGE
) || (reg
== INA2XX_CURRENT
);
91 static const struct regmap_config ina2xx_regmap_config
= {
94 .max_register
= INA2XX_MAX_REGISTERS
,
95 .writeable_reg
= ina2xx_is_writeable_reg
,
96 .volatile_reg
= ina2xx_is_volatile_reg
,
99 enum ina2xx_ids
{ ina219
, ina226
};
101 struct ina2xx_config
{
103 int calibration_factor
;
105 int bus_voltage_shift
;
106 int bus_voltage_lsb
; /* uV */
107 int power_lsb
; /* uW */
110 struct ina2xx_chip_info
{
111 struct regmap
*regmap
;
112 struct task_struct
*task
;
113 const struct ina2xx_config
*config
;
114 struct mutex state_lock
;
115 unsigned int shunt_resistor
;
117 int int_time_vbus
; /* Bus voltage integration time uS */
118 int int_time_vshunt
; /* Shunt voltage integration time uS */
119 bool allow_async_readout
;
122 static const struct ina2xx_config ina2xx_config
[] = {
124 .config_default
= INA219_CONFIG_DEFAULT
,
125 .calibration_factor
= 40960000,
127 .bus_voltage_shift
= 3,
128 .bus_voltage_lsb
= 4000,
132 .config_default
= INA226_CONFIG_DEFAULT
,
133 .calibration_factor
= 5120000,
135 .bus_voltage_shift
= 0,
136 .bus_voltage_lsb
= 1250,
141 static int ina2xx_read_raw(struct iio_dev
*indio_dev
,
142 struct iio_chan_spec
const *chan
,
143 int *val
, int *val2
, long mask
)
146 struct ina2xx_chip_info
*chip
= iio_priv(indio_dev
);
150 case IIO_CHAN_INFO_RAW
:
151 ret
= regmap_read(chip
->regmap
, chan
->address
, ®val
);
155 if (is_signed_reg(chan
->address
))
162 case IIO_CHAN_INFO_OVERSAMPLING_RATIO
:
166 case IIO_CHAN_INFO_INT_TIME
:
168 if (chan
->address
== INA2XX_SHUNT_VOLTAGE
)
169 *val2
= chip
->int_time_vshunt
;
171 *val2
= chip
->int_time_vbus
;
173 return IIO_VAL_INT_PLUS_MICRO
;
175 case IIO_CHAN_INFO_SAMP_FREQ
:
177 * Sample freq is read only, it is a consequence of
178 * 1/AVG*(CT_bus+CT_shunt).
180 *val
= DIV_ROUND_CLOSEST(1000000, SAMPLING_PERIOD(chip
));
184 case IIO_CHAN_INFO_SCALE
:
185 switch (chan
->address
) {
186 case INA2XX_SHUNT_VOLTAGE
:
187 /* processed (mV) = raw/shunt_div */
188 *val2
= chip
->config
->shunt_div
;
190 return IIO_VAL_FRACTIONAL
;
192 case INA2XX_BUS_VOLTAGE
:
193 /* processed (mV) = raw*lsb (uV) / (1000 << shift) */
194 *val
= chip
->config
->bus_voltage_lsb
;
195 *val2
= 1000 << chip
->config
->bus_voltage_shift
;
196 return IIO_VAL_FRACTIONAL
;
199 /* processed (mW) = raw*lsb (uW) / 1000 */
200 *val
= chip
->config
->power_lsb
;
202 return IIO_VAL_FRACTIONAL
;
205 /* processed (mA) = raw (mA) */
215 * Available averaging rates for ina226. The indices correspond with
216 * the bit values expected by the chip (according to the ina226 datasheet,
217 * table 3 AVG bit settings, found at
218 * http://www.ti.com/lit/ds/symlink/ina226.pdf.
220 static const int ina226_avg_tab
[] = { 1, 4, 16, 64, 128, 256, 512, 1024 };
222 static int ina226_set_average(struct ina2xx_chip_info
*chip
, unsigned int val
,
223 unsigned int *config
)
227 if (val
> 1024 || val
< 1)
230 bits
= find_closest(val
, ina226_avg_tab
,
231 ARRAY_SIZE(ina226_avg_tab
));
233 chip
->avg
= ina226_avg_tab
[bits
];
235 *config
&= ~INA226_AVG_MASK
;
236 *config
|= INA226_SHIFT_AVG(bits
) & INA226_AVG_MASK
;
241 /* Conversion times in uS */
242 static const int ina226_conv_time_tab
[] = { 140, 204, 332, 588, 1100,
245 static int ina226_set_int_time_vbus(struct ina2xx_chip_info
*chip
,
246 unsigned int val_us
, unsigned int *config
)
250 if (val_us
> 8244 || val_us
< 140)
253 bits
= find_closest(val_us
, ina226_conv_time_tab
,
254 ARRAY_SIZE(ina226_conv_time_tab
));
256 chip
->int_time_vbus
= ina226_conv_time_tab
[bits
];
258 *config
&= ~INA226_ITB_MASK
;
259 *config
|= INA226_SHIFT_ITB(bits
) & INA226_ITB_MASK
;
264 static int ina226_set_int_time_vshunt(struct ina2xx_chip_info
*chip
,
265 unsigned int val_us
, unsigned int *config
)
269 if (val_us
> 8244 || val_us
< 140)
272 bits
= find_closest(val_us
, ina226_conv_time_tab
,
273 ARRAY_SIZE(ina226_conv_time_tab
));
275 chip
->int_time_vshunt
= ina226_conv_time_tab
[bits
];
277 *config
&= ~INA226_ITS_MASK
;
278 *config
|= INA226_SHIFT_ITS(bits
) & INA226_ITS_MASK
;
283 static int ina2xx_write_raw(struct iio_dev
*indio_dev
,
284 struct iio_chan_spec
const *chan
,
285 int val
, int val2
, long mask
)
287 struct ina2xx_chip_info
*chip
= iio_priv(indio_dev
);
288 unsigned int config
, tmp
;
291 if (iio_buffer_enabled(indio_dev
))
294 mutex_lock(&chip
->state_lock
);
296 ret
= regmap_read(chip
->regmap
, INA2XX_CONFIG
, &config
);
303 case IIO_CHAN_INFO_OVERSAMPLING_RATIO
:
304 ret
= ina226_set_average(chip
, val
, &tmp
);
307 case IIO_CHAN_INFO_INT_TIME
:
308 if (chan
->address
== INA2XX_SHUNT_VOLTAGE
)
309 ret
= ina226_set_int_time_vshunt(chip
, val2
, &tmp
);
311 ret
= ina226_set_int_time_vbus(chip
, val2
, &tmp
);
318 if (!ret
&& (tmp
!= config
))
319 ret
= regmap_write(chip
->regmap
, INA2XX_CONFIG
, tmp
);
321 mutex_unlock(&chip
->state_lock
);
326 static ssize_t
ina2xx_allow_async_readout_show(struct device
*dev
,
327 struct device_attribute
*attr
,
330 struct ina2xx_chip_info
*chip
= iio_priv(dev_to_iio_dev(dev
));
332 return sprintf(buf
, "%d\n", chip
->allow_async_readout
);
335 static ssize_t
ina2xx_allow_async_readout_store(struct device
*dev
,
336 struct device_attribute
*attr
,
337 const char *buf
, size_t len
)
339 struct ina2xx_chip_info
*chip
= iio_priv(dev_to_iio_dev(dev
));
343 ret
= strtobool((const char *) buf
, &val
);
347 chip
->allow_async_readout
= val
;
353 * Set current LSB to 1mA, shunt is in uOhms
354 * (equation 13 in datasheet). We hardcode a Current_LSB
355 * of 1.0 x10-6. The only remaining parameter is RShunt.
356 * There is no need to expose the CALIBRATION register
357 * to the user for now. But we need to reset this register
358 * if the user updates RShunt after driver init, e.g upon
359 * reading an EEPROM/Probe-type value.
361 static int ina2xx_set_calibration(struct ina2xx_chip_info
*chip
)
363 u16 regval
= DIV_ROUND_CLOSEST(chip
->config
->calibration_factor
,
364 chip
->shunt_resistor
);
366 return regmap_write(chip
->regmap
, INA2XX_CALIBRATION
, regval
);
369 static int set_shunt_resistor(struct ina2xx_chip_info
*chip
, unsigned int val
)
371 if (val
<= 0 || val
> chip
->config
->calibration_factor
)
374 chip
->shunt_resistor
= val
;
379 static ssize_t
ina2xx_shunt_resistor_show(struct device
*dev
,
380 struct device_attribute
*attr
,
383 struct ina2xx_chip_info
*chip
= iio_priv(dev_to_iio_dev(dev
));
385 return sprintf(buf
, "%d\n", chip
->shunt_resistor
);
388 static ssize_t
ina2xx_shunt_resistor_store(struct device
*dev
,
389 struct device_attribute
*attr
,
390 const char *buf
, size_t len
)
392 struct ina2xx_chip_info
*chip
= iio_priv(dev_to_iio_dev(dev
));
396 ret
= kstrtoul((const char *) buf
, 10, &val
);
400 ret
= set_shunt_resistor(chip
, val
);
404 /* Update the Calibration register */
405 ret
= ina2xx_set_calibration(chip
);
412 #define INA2XX_CHAN(_type, _index, _address) { \
414 .address = (_address), \
416 .channel = (_index), \
417 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) \
418 | BIT(IIO_CHAN_INFO_SCALE), \
419 .info_mask_shared_by_dir = BIT(IIO_CHAN_INFO_SAMP_FREQ) | \
420 BIT(IIO_CHAN_INFO_OVERSAMPLING_RATIO), \
421 .scan_index = (_index), \
426 .endianness = IIO_CPU, \
431 * Sampling Freq is a consequence of the integration times of
432 * the Voltage channels.
434 #define INA2XX_CHAN_VOLTAGE(_index, _address) { \
435 .type = IIO_VOLTAGE, \
436 .address = (_address), \
438 .channel = (_index), \
439 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) | \
440 BIT(IIO_CHAN_INFO_SCALE) | \
441 BIT(IIO_CHAN_INFO_INT_TIME), \
442 .scan_index = (_index), \
447 .endianness = IIO_LE, \
451 static const struct iio_chan_spec ina2xx_channels
[] = {
452 INA2XX_CHAN_VOLTAGE(0, INA2XX_SHUNT_VOLTAGE
),
453 INA2XX_CHAN_VOLTAGE(1, INA2XX_BUS_VOLTAGE
),
454 INA2XX_CHAN(IIO_POWER
, 2, INA2XX_POWER
),
455 INA2XX_CHAN(IIO_CURRENT
, 3, INA2XX_CURRENT
),
456 IIO_CHAN_SOFT_TIMESTAMP(4),
459 static int ina2xx_work_buffer(struct iio_dev
*indio_dev
)
461 struct ina2xx_chip_info
*chip
= iio_priv(indio_dev
);
462 unsigned short data
[8];
467 time_a
= iio_get_time_ns(indio_dev
);
470 * Because the timer thread and the chip conversion clock
471 * are asynchronous, the period difference will eventually
472 * result in reading V[k-1] again, or skip V[k] at time Tk.
473 * In order to resync the timer with the conversion process
474 * we check the ConVersionReadyFlag.
475 * On hardware that supports using the ALERT pin to toggle a
476 * GPIO a triggered buffer could be used instead.
477 * For now, we pay for that extra read of the ALERT register
479 if (!chip
->allow_async_readout
)
481 ret
= regmap_read(chip
->regmap
, INA226_ALERT_MASK
,
486 alert
&= INA266_CVRF
;
490 * Single register reads: bulk_read will not work with ina226
491 * as there is no auto-increment of the address register for
492 * data length longer than 16bits.
494 for_each_set_bit(bit
, indio_dev
->active_scan_mask
,
495 indio_dev
->masklength
) {
498 ret
= regmap_read(chip
->regmap
,
499 INA2XX_SHUNT_VOLTAGE
+ bit
, &val
);
506 time_b
= iio_get_time_ns(indio_dev
);
508 iio_push_to_buffers_with_timestamp(indio_dev
,
509 (unsigned int *)data
, time_a
);
511 return (unsigned long)(time_b
- time_a
) / 1000;
514 static int ina2xx_capture_thread(void *data
)
516 struct iio_dev
*indio_dev
= data
;
517 struct ina2xx_chip_info
*chip
= iio_priv(indio_dev
);
518 unsigned int sampling_us
= SAMPLING_PERIOD(chip
);
522 * Poll a bit faster than the chip internal Fs, in case
523 * we wish to sync with the conversion ready flag.
525 if (!chip
->allow_async_readout
)
529 buffer_us
= ina2xx_work_buffer(indio_dev
);
533 if (sampling_us
> buffer_us
)
534 udelay(sampling_us
- buffer_us
);
536 } while (!kthread_should_stop());
541 static int ina2xx_buffer_enable(struct iio_dev
*indio_dev
)
543 struct ina2xx_chip_info
*chip
= iio_priv(indio_dev
);
544 unsigned int sampling_us
= SAMPLING_PERIOD(chip
);
546 dev_dbg(&indio_dev
->dev
, "Enabling buffer w/ scan_mask %02x, freq = %d, avg =%u\n",
547 (unsigned int)(*indio_dev
->active_scan_mask
),
548 1000000 / sampling_us
, chip
->avg
);
550 dev_dbg(&indio_dev
->dev
, "Expected work period: %u us\n", sampling_us
);
551 dev_dbg(&indio_dev
->dev
, "Async readout mode: %d\n",
552 chip
->allow_async_readout
);
554 chip
->task
= kthread_run(ina2xx_capture_thread
, (void *)indio_dev
,
555 "%s:%d-%uus", indio_dev
->name
, indio_dev
->id
,
558 return PTR_ERR_OR_ZERO(chip
->task
);
561 static int ina2xx_buffer_disable(struct iio_dev
*indio_dev
)
563 struct ina2xx_chip_info
*chip
= iio_priv(indio_dev
);
566 kthread_stop(chip
->task
);
573 static const struct iio_buffer_setup_ops ina2xx_setup_ops
= {
574 .postenable
= &ina2xx_buffer_enable
,
575 .predisable
= &ina2xx_buffer_disable
,
578 static int ina2xx_debug_reg(struct iio_dev
*indio_dev
,
579 unsigned reg
, unsigned writeval
, unsigned *readval
)
581 struct ina2xx_chip_info
*chip
= iio_priv(indio_dev
);
584 return regmap_write(chip
->regmap
, reg
, writeval
);
586 return regmap_read(chip
->regmap
, reg
, readval
);
589 /* Possible integration times for vshunt and vbus */
590 static IIO_CONST_ATTR_INT_TIME_AVAIL("0.000140 0.000204 0.000332 0.000588 0.001100 0.002116 0.004156 0.008244");
592 static IIO_DEVICE_ATTR(in_allow_async_readout
, S_IRUGO
| S_IWUSR
,
593 ina2xx_allow_async_readout_show
,
594 ina2xx_allow_async_readout_store
, 0);
596 static IIO_DEVICE_ATTR(in_shunt_resistor
, S_IRUGO
| S_IWUSR
,
597 ina2xx_shunt_resistor_show
,
598 ina2xx_shunt_resistor_store
, 0);
600 static struct attribute
*ina2xx_attributes
[] = {
601 &iio_dev_attr_in_allow_async_readout
.dev_attr
.attr
,
602 &iio_const_attr_integration_time_available
.dev_attr
.attr
,
603 &iio_dev_attr_in_shunt_resistor
.dev_attr
.attr
,
607 static const struct attribute_group ina2xx_attribute_group
= {
608 .attrs
= ina2xx_attributes
,
611 static const struct iio_info ina2xx_info
= {
612 .driver_module
= THIS_MODULE
,
613 .attrs
= &ina2xx_attribute_group
,
614 .read_raw
= ina2xx_read_raw
,
615 .write_raw
= ina2xx_write_raw
,
616 .debugfs_reg_access
= ina2xx_debug_reg
,
619 /* Initialize the configuration and calibration registers. */
620 static int ina2xx_init(struct ina2xx_chip_info
*chip
, unsigned int config
)
622 int ret
= regmap_write(chip
->regmap
, INA2XX_CONFIG
, config
);
626 return ina2xx_set_calibration(chip
);
629 static int ina2xx_probe(struct i2c_client
*client
,
630 const struct i2c_device_id
*id
)
632 struct ina2xx_chip_info
*chip
;
633 struct iio_dev
*indio_dev
;
634 struct iio_buffer
*buffer
;
638 indio_dev
= devm_iio_device_alloc(&client
->dev
, sizeof(*chip
));
642 chip
= iio_priv(indio_dev
);
644 /* This is only used for device removal purposes. */
645 i2c_set_clientdata(client
, indio_dev
);
647 chip
->regmap
= devm_regmap_init_i2c(client
, &ina2xx_regmap_config
);
648 if (IS_ERR(chip
->regmap
)) {
649 dev_err(&client
->dev
, "failed to allocate register map\n");
650 return PTR_ERR(chip
->regmap
);
653 chip
->config
= &ina2xx_config
[id
->driver_data
];
655 mutex_init(&chip
->state_lock
);
657 if (of_property_read_u32(client
->dev
.of_node
,
658 "shunt-resistor", &val
) < 0) {
659 struct ina2xx_platform_data
*pdata
=
660 dev_get_platdata(&client
->dev
);
663 val
= pdata
->shunt_uohms
;
665 val
= INA2XX_RSHUNT_DEFAULT
;
668 ret
= set_shunt_resistor(chip
, val
);
672 /* Patch the current config register with default. */
673 val
= chip
->config
->config_default
;
675 if (id
->driver_data
== ina226
) {
676 ina226_set_average(chip
, INA226_DEFAULT_AVG
, &val
);
677 ina226_set_int_time_vbus(chip
, INA226_DEFAULT_IT
, &val
);
678 ina226_set_int_time_vshunt(chip
, INA226_DEFAULT_IT
, &val
);
681 ret
= ina2xx_init(chip
, val
);
683 dev_err(&client
->dev
, "error configuring the device\n");
687 indio_dev
->modes
= INDIO_DIRECT_MODE
| INDIO_BUFFER_SOFTWARE
;
688 indio_dev
->dev
.parent
= &client
->dev
;
689 indio_dev
->dev
.of_node
= client
->dev
.of_node
;
690 indio_dev
->channels
= ina2xx_channels
;
691 indio_dev
->num_channels
= ARRAY_SIZE(ina2xx_channels
);
692 indio_dev
->name
= id
->name
;
693 indio_dev
->info
= &ina2xx_info
;
694 indio_dev
->setup_ops
= &ina2xx_setup_ops
;
696 buffer
= devm_iio_kfifo_allocate(&indio_dev
->dev
);
700 iio_device_attach_buffer(indio_dev
, buffer
);
702 return iio_device_register(indio_dev
);
705 static int ina2xx_remove(struct i2c_client
*client
)
707 struct iio_dev
*indio_dev
= i2c_get_clientdata(client
);
708 struct ina2xx_chip_info
*chip
= iio_priv(indio_dev
);
710 iio_device_unregister(indio_dev
);
713 return regmap_update_bits(chip
->regmap
, INA2XX_CONFIG
,
714 INA2XX_MODE_MASK
, 0);
717 static const struct i2c_device_id ina2xx_id
[] = {
725 MODULE_DEVICE_TABLE(i2c
, ina2xx_id
);
727 static struct i2c_driver ina2xx_driver
= {
729 .name
= KBUILD_MODNAME
,
731 .probe
= ina2xx_probe
,
732 .remove
= ina2xx_remove
,
733 .id_table
= ina2xx_id
,
735 module_i2c_driver(ina2xx_driver
);
737 MODULE_AUTHOR("Marc Titinger <marc.titinger@baylibre.com>");
738 MODULE_DESCRIPTION("Texas Instruments INA2XX ADC driver");
739 MODULE_LICENSE("GPL v2");