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 s64 prev_ns
; /* track buffer capture time, check for underruns */
118 int int_time_vbus
; /* Bus voltage integration time uS */
119 int int_time_vshunt
; /* Shunt voltage integration time uS */
120 bool allow_async_readout
;
123 static const struct ina2xx_config ina2xx_config
[] = {
125 .config_default
= INA219_CONFIG_DEFAULT
,
126 .calibration_factor
= 40960000,
128 .bus_voltage_shift
= 3,
129 .bus_voltage_lsb
= 4000,
133 .config_default
= INA226_CONFIG_DEFAULT
,
134 .calibration_factor
= 5120000,
136 .bus_voltage_shift
= 0,
137 .bus_voltage_lsb
= 1250,
142 static int ina2xx_read_raw(struct iio_dev
*indio_dev
,
143 struct iio_chan_spec
const *chan
,
144 int *val
, int *val2
, long mask
)
147 struct ina2xx_chip_info
*chip
= iio_priv(indio_dev
);
151 case IIO_CHAN_INFO_RAW
:
152 ret
= regmap_read(chip
->regmap
, chan
->address
, ®val
);
156 if (is_signed_reg(chan
->address
))
163 case IIO_CHAN_INFO_OVERSAMPLING_RATIO
:
167 case IIO_CHAN_INFO_INT_TIME
:
169 if (chan
->address
== INA2XX_SHUNT_VOLTAGE
)
170 *val2
= chip
->int_time_vshunt
;
172 *val2
= chip
->int_time_vbus
;
174 return IIO_VAL_INT_PLUS_MICRO
;
176 case IIO_CHAN_INFO_SAMP_FREQ
:
178 * Sample freq is read only, it is a consequence of
179 * 1/AVG*(CT_bus+CT_shunt).
181 *val
= DIV_ROUND_CLOSEST(1000000, SAMPLING_PERIOD(chip
));
185 case IIO_CHAN_INFO_SCALE
:
186 switch (chan
->address
) {
187 case INA2XX_SHUNT_VOLTAGE
:
188 /* processed (mV) = raw*1000/shunt_div */
189 *val2
= chip
->config
->shunt_div
;
191 return IIO_VAL_FRACTIONAL
;
193 case INA2XX_BUS_VOLTAGE
:
194 /* processed (mV) = raw*lsb (uV) / (1000 << shift) */
195 *val
= chip
->config
->bus_voltage_lsb
;
196 *val2
= 1000 << chip
->config
->bus_voltage_shift
;
197 return IIO_VAL_FRACTIONAL
;
200 /* processed (mW) = raw*lsb (uW) / 1000 */
201 *val
= chip
->config
->power_lsb
;
203 return IIO_VAL_FRACTIONAL
;
206 /* processed (mA) = raw (mA) */
216 * Available averaging rates for ina226. The indices correspond with
217 * the bit values expected by the chip (according to the ina226 datasheet,
218 * table 3 AVG bit settings, found at
219 * http://www.ti.com/lit/ds/symlink/ina226.pdf.
221 static const int ina226_avg_tab
[] = { 1, 4, 16, 64, 128, 256, 512, 1024 };
223 static int ina226_set_average(struct ina2xx_chip_info
*chip
, unsigned int val
,
224 unsigned int *config
)
228 if (val
> 1024 || val
< 1)
231 bits
= find_closest(val
, ina226_avg_tab
,
232 ARRAY_SIZE(ina226_avg_tab
));
234 chip
->avg
= ina226_avg_tab
[bits
];
236 *config
&= ~INA226_AVG_MASK
;
237 *config
|= INA226_SHIFT_AVG(bits
) & INA226_AVG_MASK
;
242 /* Conversion times in uS */
243 static const int ina226_conv_time_tab
[] = { 140, 204, 332, 588, 1100,
246 static int ina226_set_int_time_vbus(struct ina2xx_chip_info
*chip
,
247 unsigned int val_us
, unsigned int *config
)
251 if (val_us
> 8244 || val_us
< 140)
254 bits
= find_closest(val_us
, ina226_conv_time_tab
,
255 ARRAY_SIZE(ina226_conv_time_tab
));
257 chip
->int_time_vbus
= ina226_conv_time_tab
[bits
];
259 *config
&= ~INA226_ITB_MASK
;
260 *config
|= INA226_SHIFT_ITB(bits
) & INA226_ITB_MASK
;
265 static int ina226_set_int_time_vshunt(struct ina2xx_chip_info
*chip
,
266 unsigned int val_us
, unsigned int *config
)
270 if (val_us
> 8244 || val_us
< 140)
273 bits
= find_closest(val_us
, ina226_conv_time_tab
,
274 ARRAY_SIZE(ina226_conv_time_tab
));
276 chip
->int_time_vshunt
= ina226_conv_time_tab
[bits
];
278 *config
&= ~INA226_ITS_MASK
;
279 *config
|= INA226_SHIFT_ITS(bits
) & INA226_ITS_MASK
;
284 static int ina2xx_write_raw(struct iio_dev
*indio_dev
,
285 struct iio_chan_spec
const *chan
,
286 int val
, int val2
, long mask
)
288 struct ina2xx_chip_info
*chip
= iio_priv(indio_dev
);
289 unsigned int config
, tmp
;
292 if (iio_buffer_enabled(indio_dev
))
295 mutex_lock(&chip
->state_lock
);
297 ret
= regmap_read(chip
->regmap
, INA2XX_CONFIG
, &config
);
304 case IIO_CHAN_INFO_OVERSAMPLING_RATIO
:
305 ret
= ina226_set_average(chip
, val
, &tmp
);
308 case IIO_CHAN_INFO_INT_TIME
:
309 if (chan
->address
== INA2XX_SHUNT_VOLTAGE
)
310 ret
= ina226_set_int_time_vshunt(chip
, val2
, &tmp
);
312 ret
= ina226_set_int_time_vbus(chip
, val2
, &tmp
);
319 if (!ret
&& (tmp
!= config
))
320 ret
= regmap_write(chip
->regmap
, INA2XX_CONFIG
, tmp
);
322 mutex_unlock(&chip
->state_lock
);
327 static ssize_t
ina2xx_allow_async_readout_show(struct device
*dev
,
328 struct device_attribute
*attr
,
331 struct ina2xx_chip_info
*chip
= iio_priv(dev_to_iio_dev(dev
));
333 return sprintf(buf
, "%d\n", chip
->allow_async_readout
);
336 static ssize_t
ina2xx_allow_async_readout_store(struct device
*dev
,
337 struct device_attribute
*attr
,
338 const char *buf
, size_t len
)
340 struct ina2xx_chip_info
*chip
= iio_priv(dev_to_iio_dev(dev
));
344 ret
= strtobool((const char *) buf
, &val
);
348 chip
->allow_async_readout
= val
;
353 static int set_shunt_resistor(struct ina2xx_chip_info
*chip
, unsigned int val
)
355 if (val
<= 0 || val
> chip
->config
->calibration_factor
)
358 chip
->shunt_resistor
= val
;
363 static ssize_t
ina2xx_shunt_resistor_show(struct device
*dev
,
364 struct device_attribute
*attr
,
367 struct ina2xx_chip_info
*chip
= iio_priv(dev_to_iio_dev(dev
));
369 return sprintf(buf
, "%d\n", chip
->shunt_resistor
);
372 static ssize_t
ina2xx_shunt_resistor_store(struct device
*dev
,
373 struct device_attribute
*attr
,
374 const char *buf
, size_t len
)
376 struct ina2xx_chip_info
*chip
= iio_priv(dev_to_iio_dev(dev
));
380 ret
= kstrtoul((const char *) buf
, 10, &val
);
384 ret
= set_shunt_resistor(chip
, val
);
391 #define INA2XX_CHAN(_type, _index, _address) { \
393 .address = (_address), \
395 .channel = (_index), \
396 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) \
397 | BIT(IIO_CHAN_INFO_SCALE), \
398 .info_mask_shared_by_dir = BIT(IIO_CHAN_INFO_SAMP_FREQ) | \
399 BIT(IIO_CHAN_INFO_OVERSAMPLING_RATIO), \
400 .scan_index = (_index), \
405 .endianness = IIO_CPU, \
410 * Sampling Freq is a consequence of the integration times of
411 * the Voltage channels.
413 #define INA2XX_CHAN_VOLTAGE(_index, _address) { \
414 .type = IIO_VOLTAGE, \
415 .address = (_address), \
417 .channel = (_index), \
418 .info_mask_separate = BIT(IIO_CHAN_INFO_RAW) | \
419 BIT(IIO_CHAN_INFO_SCALE) | \
420 BIT(IIO_CHAN_INFO_INT_TIME), \
421 .scan_index = (_index), \
426 .endianness = IIO_LE, \
430 static const struct iio_chan_spec ina2xx_channels
[] = {
431 INA2XX_CHAN_VOLTAGE(0, INA2XX_SHUNT_VOLTAGE
),
432 INA2XX_CHAN_VOLTAGE(1, INA2XX_BUS_VOLTAGE
),
433 INA2XX_CHAN(IIO_POWER
, 2, INA2XX_POWER
),
434 INA2XX_CHAN(IIO_CURRENT
, 3, INA2XX_CURRENT
),
435 IIO_CHAN_SOFT_TIMESTAMP(4),
438 static int ina2xx_work_buffer(struct iio_dev
*indio_dev
)
440 struct ina2xx_chip_info
*chip
= iio_priv(indio_dev
);
441 unsigned short data
[8];
446 time_a
= iio_get_time_ns();
449 * Because the timer thread and the chip conversion clock
450 * are asynchronous, the period difference will eventually
451 * result in reading V[k-1] again, or skip V[k] at time Tk.
452 * In order to resync the timer with the conversion process
453 * we check the ConVersionReadyFlag.
454 * On hardware that supports using the ALERT pin to toggle a
455 * GPIO a triggered buffer could be used instead.
456 * For now, we pay for that extra read of the ALERT register
458 if (!chip
->allow_async_readout
)
460 ret
= regmap_read(chip
->regmap
, INA226_ALERT_MASK
,
465 alert
&= INA266_CVRF
;
469 * Single register reads: bulk_read will not work with ina226
470 * as there is no auto-increment of the address register for
471 * data length longer than 16bits.
473 for_each_set_bit(bit
, indio_dev
->active_scan_mask
,
474 indio_dev
->masklength
) {
477 ret
= regmap_read(chip
->regmap
,
478 INA2XX_SHUNT_VOLTAGE
+ bit
, &val
);
485 time_b
= iio_get_time_ns();
487 iio_push_to_buffers_with_timestamp(indio_dev
,
488 (unsigned int *)data
, time_a
);
490 chip
->prev_ns
= time_a
;
492 return (unsigned long)(time_b
- time_a
) / 1000;
495 static int ina2xx_capture_thread(void *data
)
497 struct iio_dev
*indio_dev
= data
;
498 struct ina2xx_chip_info
*chip
= iio_priv(indio_dev
);
499 unsigned int sampling_us
= SAMPLING_PERIOD(chip
);
503 * Poll a bit faster than the chip internal Fs, in case
504 * we wish to sync with the conversion ready flag.
506 if (!chip
->allow_async_readout
)
510 buffer_us
= ina2xx_work_buffer(indio_dev
);
514 if (sampling_us
> buffer_us
)
515 udelay(sampling_us
- buffer_us
);
517 } while (!kthread_should_stop());
522 static int ina2xx_buffer_enable(struct iio_dev
*indio_dev
)
524 struct ina2xx_chip_info
*chip
= iio_priv(indio_dev
);
525 unsigned int sampling_us
= SAMPLING_PERIOD(chip
);
527 dev_dbg(&indio_dev
->dev
, "Enabling buffer w/ scan_mask %02x, freq = %d, avg =%u\n",
528 (unsigned int)(*indio_dev
->active_scan_mask
),
529 1000000 / sampling_us
, chip
->avg
);
531 dev_dbg(&indio_dev
->dev
, "Expected work period: %u us\n", sampling_us
);
532 dev_dbg(&indio_dev
->dev
, "Async readout mode: %d\n",
533 chip
->allow_async_readout
);
535 chip
->prev_ns
= iio_get_time_ns();
537 chip
->task
= kthread_run(ina2xx_capture_thread
, (void *)indio_dev
,
538 "%s:%d-%uus", indio_dev
->name
, indio_dev
->id
,
541 return PTR_ERR_OR_ZERO(chip
->task
);
544 static int ina2xx_buffer_disable(struct iio_dev
*indio_dev
)
546 struct ina2xx_chip_info
*chip
= iio_priv(indio_dev
);
549 kthread_stop(chip
->task
);
556 static const struct iio_buffer_setup_ops ina2xx_setup_ops
= {
557 .postenable
= &ina2xx_buffer_enable
,
558 .predisable
= &ina2xx_buffer_disable
,
561 static int ina2xx_debug_reg(struct iio_dev
*indio_dev
,
562 unsigned reg
, unsigned writeval
, unsigned *readval
)
564 struct ina2xx_chip_info
*chip
= iio_priv(indio_dev
);
567 return regmap_write(chip
->regmap
, reg
, writeval
);
569 return regmap_read(chip
->regmap
, reg
, readval
);
572 /* Possible integration times for vshunt and vbus */
573 static IIO_CONST_ATTR_INT_TIME_AVAIL("0.000140 0.000204 0.000332 0.000588 0.001100 0.002116 0.004156 0.008244");
575 static IIO_DEVICE_ATTR(in_allow_async_readout
, S_IRUGO
| S_IWUSR
,
576 ina2xx_allow_async_readout_show
,
577 ina2xx_allow_async_readout_store
, 0);
579 static IIO_DEVICE_ATTR(in_shunt_resistor
, S_IRUGO
| S_IWUSR
,
580 ina2xx_shunt_resistor_show
,
581 ina2xx_shunt_resistor_store
, 0);
583 static struct attribute
*ina2xx_attributes
[] = {
584 &iio_dev_attr_in_allow_async_readout
.dev_attr
.attr
,
585 &iio_const_attr_integration_time_available
.dev_attr
.attr
,
586 &iio_dev_attr_in_shunt_resistor
.dev_attr
.attr
,
590 static const struct attribute_group ina2xx_attribute_group
= {
591 .attrs
= ina2xx_attributes
,
594 static const struct iio_info ina2xx_info
= {
595 .driver_module
= THIS_MODULE
,
596 .attrs
= &ina2xx_attribute_group
,
597 .read_raw
= ina2xx_read_raw
,
598 .write_raw
= ina2xx_write_raw
,
599 .debugfs_reg_access
= ina2xx_debug_reg
,
602 /* Initialize the configuration and calibration registers. */
603 static int ina2xx_init(struct ina2xx_chip_info
*chip
, unsigned int config
)
608 ret
= regmap_write(chip
->regmap
, INA2XX_CONFIG
, config
);
613 * Set current LSB to 1mA, shunt is in uOhms
614 * (equation 13 in datasheet). We hardcode a Current_LSB
615 * of 1.0 x10-6. The only remaining parameter is RShunt.
616 * There is no need to expose the CALIBRATION register
617 * to the user for now.
619 regval
= DIV_ROUND_CLOSEST(chip
->config
->calibration_factor
,
620 chip
->shunt_resistor
);
622 return regmap_write(chip
->regmap
, INA2XX_CALIBRATION
, regval
);
625 static int ina2xx_probe(struct i2c_client
*client
,
626 const struct i2c_device_id
*id
)
628 struct ina2xx_chip_info
*chip
;
629 struct iio_dev
*indio_dev
;
630 struct iio_buffer
*buffer
;
634 indio_dev
= devm_iio_device_alloc(&client
->dev
, sizeof(*chip
));
638 chip
= iio_priv(indio_dev
);
640 /* This is only used for device removal purposes. */
641 i2c_set_clientdata(client
, indio_dev
);
643 chip
->regmap
= devm_regmap_init_i2c(client
, &ina2xx_regmap_config
);
644 if (IS_ERR(chip
->regmap
)) {
645 dev_err(&client
->dev
, "failed to allocate register map\n");
646 return PTR_ERR(chip
->regmap
);
649 chip
->config
= &ina2xx_config
[id
->driver_data
];
651 mutex_init(&chip
->state_lock
);
653 if (of_property_read_u32(client
->dev
.of_node
,
654 "shunt-resistor", &val
) < 0) {
655 struct ina2xx_platform_data
*pdata
=
656 dev_get_platdata(&client
->dev
);
659 val
= pdata
->shunt_uohms
;
661 val
= INA2XX_RSHUNT_DEFAULT
;
664 ret
= set_shunt_resistor(chip
, val
);
668 /* Patch the current config register with default. */
669 val
= chip
->config
->config_default
;
671 if (id
->driver_data
== ina226
) {
672 ina226_set_average(chip
, INA226_DEFAULT_AVG
, &val
);
673 ina226_set_int_time_vbus(chip
, INA226_DEFAULT_IT
, &val
);
674 ina226_set_int_time_vshunt(chip
, INA226_DEFAULT_IT
, &val
);
677 ret
= ina2xx_init(chip
, val
);
679 dev_err(&client
->dev
, "error configuring the device\n");
683 indio_dev
->modes
= INDIO_DIRECT_MODE
| INDIO_BUFFER_SOFTWARE
;
684 indio_dev
->dev
.parent
= &client
->dev
;
685 indio_dev
->channels
= ina2xx_channels
;
686 indio_dev
->num_channels
= ARRAY_SIZE(ina2xx_channels
);
687 indio_dev
->name
= id
->name
;
688 indio_dev
->info
= &ina2xx_info
;
689 indio_dev
->setup_ops
= &ina2xx_setup_ops
;
691 buffer
= devm_iio_kfifo_allocate(&indio_dev
->dev
);
695 iio_device_attach_buffer(indio_dev
, buffer
);
697 return iio_device_register(indio_dev
);
700 static int ina2xx_remove(struct i2c_client
*client
)
702 struct iio_dev
*indio_dev
= i2c_get_clientdata(client
);
703 struct ina2xx_chip_info
*chip
= iio_priv(indio_dev
);
705 iio_device_unregister(indio_dev
);
708 return regmap_update_bits(chip
->regmap
, INA2XX_CONFIG
,
709 INA2XX_MODE_MASK
, 0);
712 static const struct i2c_device_id ina2xx_id
[] = {
720 MODULE_DEVICE_TABLE(i2c
, ina2xx_id
);
722 static struct i2c_driver ina2xx_driver
= {
724 .name
= KBUILD_MODNAME
,
726 .probe
= ina2xx_probe
,
727 .remove
= ina2xx_remove
,
728 .id_table
= ina2xx_id
,
730 module_i2c_driver(ina2xx_driver
);
732 MODULE_AUTHOR("Marc Titinger <marc.titinger@baylibre.com>");
733 MODULE_DESCRIPTION("Texas Instruments INA2XX ADC driver");
734 MODULE_LICENSE("GPL v2");