Merge branch 'for-next' of git://git.kernel.org/pub/scm/linux/kernel/git/gerg/m68knommu
[linux-2.6-microblaze.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   * Texas Instruments INA231
30     Prefix: 'ina231'
31     Addresses: I2C 0x40 - 0x4f
32     Datasheet: Publicly available at the Texas Instruments website
33                http://www.ti.com/
34
35 Author: Lothar Felten <l-felten@ti.com>
36
37 Description
38 -----------
39
40 The INA219 is a high-side current shunt and power monitor with an I2C
41 interface. The INA219 monitors both shunt drop and supply voltage, with
42 programmable conversion times and filtering.
43
44 The INA220 is a high or low side current shunt and power monitor with an I2C
45 interface. The INA220 monitors both shunt drop and supply voltage.
46
47 The INA226 is a current shunt and power monitor with an I2C interface.
48 The INA226 monitors both a shunt voltage drop and bus supply voltage.
49
50 INA230 and INA231 are high or low side current shunt and power monitors
51 with an I2C interface. The chips monitor both a shunt voltage drop and
52 bus supply voltage.
53
54 The shunt value in micro-ohms can be set via platform data or device tree at
55 compile-time or via the shunt_resistor attribute in sysfs at run-time. Please
56 refer to the Documentation/devicetree/bindings/hwmon/ina2xx.txt for bindings
57 if the device tree is used.
58
59 Additionally ina226 supports update_interval attribute as described in
60 Documentation/hwmon/sysfs-interface. Internally the interval is the sum of
61 bus and shunt voltage conversion times multiplied by the averaging rate. We
62 don't touch the conversion times and only modify the number of averages. The
63 lower limit of the update_interval is 2 ms, the upper limit is 2253 ms.
64 The actual programmed interval may vary from the desired value.