hwmon: (ina2xx) implement update_interval attribute for ina226
[cascardo/linux.git] / Documentation / hwmon / ina2xx
1 Kernel driver ina2xx
2 ====================
3
4 Supported chips:
5   * Texas Instruments INA219
6     Prefix: 'ina219'
7     Addresses: I2C 0x40 - 0x4f
8     Datasheet: Publicly available at the Texas Instruments website
9                http://www.ti.com/
10
11   * Texas Instruments INA220
12     Prefix: 'ina220'
13     Addresses: I2C 0x40 - 0x4f
14     Datasheet: Publicly available at the Texas Instruments website
15                http://www.ti.com/
16
17   * Texas Instruments INA226
18     Prefix: 'ina226'
19     Addresses: I2C 0x40 - 0x4f
20     Datasheet: Publicly available at the Texas Instruments website
21                http://www.ti.com/
22
23   * Texas Instruments INA230
24     Prefix: 'ina230'
25     Addresses: I2C 0x40 - 0x4f
26     Datasheet: Publicly available at the Texas Instruments website
27                http://www.ti.com/
28
29 Author: Lothar Felten <l-felten@ti.com>
30
31 Description
32 -----------
33
34 The INA219 is a high-side current shunt and power monitor with an I2C
35 interface. The INA219 monitors both shunt drop and supply voltage, with
36 programmable conversion times and filtering.
37
38 The INA220 is a high or low side current shunt and power monitor with an I2C
39 interface. The INA220 monitors both shunt drop and supply voltage.
40
41 The INA226 is a current shunt and power monitor with an I2C interface.
42 The INA226 monitors both a shunt voltage drop and bus supply voltage.
43
44 The INA230 is a high or low side current shunt and power monitor with an I2C
45 interface. The INA230 monitors both a shunt voltage drop and bus supply voltage.
46
47 The shunt value in micro-ohms can be set via platform data or device tree at
48 compile-time or via the shunt_resistor attribute in sysfs at run-time. Please
49 refer to the Documentation/devicetree/bindings/i2c/ina2xx.txt for bindings
50 if the device tree is used.
51
52 Additionally ina226 supports update_interval attribute as described in
53 Documentation/hwmon/sysfs-interface. Internally the interval is the sum of
54 bus and shunt voltage conversion times multiplied by the averaging rate. We
55 don't touch the conversion times and only modify the number of averages. The
56 lower limit of the update_interval is 2 ms, the upper limit is 2253 ms.
57 The actual programmed interval may vary from the desired value.