Merge branch 'x86-pti-for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git...
[linux-2.6-block.git] / Documentation / hwmon / ina3221.rst
CommitLineData
7cb6dcff
AD
1Kernel driver ina3221
2=====================
3
4Supported chips:
b04f2f7d 5
7cb6dcff 6 * Texas Instruments INA3221
b04f2f7d 7
7cb6dcff 8 Prefix: 'ina3221'
b04f2f7d 9
7cb6dcff 10 Addresses: I2C 0x40 - 0x43
b04f2f7d 11
7cb6dcff 12 Datasheet: Publicly available at the Texas Instruments website
b04f2f7d
MCC
13
14 http://www.ti.com/
7cb6dcff
AD
15
16Author: Andrew F. Davis <afd@ti.com>
17
18Description
19-----------
20
21The Texas Instruments INA3221 monitors voltage, current, and power on the high
22side of up to three D.C. power supplies. The INA3221 monitors both shunt drop
23and supply voltage, with programmable conversion times and averaging, current
24and power are calculated host-side from these.
25
26Sysfs entries
27-------------
28
b04f2f7d 29======================= =======================================================
a9e9dd9c
NC
30in[123]_label Voltage channel labels
31in[123]_enable Voltage channel enable controls
7cb6dcff
AD
32in[123]_input Bus voltage(mV) channels
33curr[123]_input Current(mA) measurement channels
34shunt[123]_resistor Shunt resistance(uOhm) channels
35curr[123]_crit Critical alert current(mA) setting, activates the
b04f2f7d
MCC
36 corresponding alarm when the respective current
37 is above this value
7cb6dcff
AD
38curr[123]_crit_alarm Critical alert current limit exceeded
39curr[123]_max Warning alert current(mA) setting, activates the
b04f2f7d
MCC
40 corresponding alarm when the respective current
41 average is above this value.
7cb6dcff
AD
42curr[123]_max_alarm Warning alert current limit exceeded
43in[456]_input Shunt voltage(uV) for channels 1, 2, and 3 respectively
5c090abf 44samples Number of samples using in the averaging mode.
b04f2f7d
MCC
45
46 Supports the list of number of samples:
47
5c090abf 48 1, 4, 16, 64, 128, 256, 512, 1024
023912db
NC
49
50update_interval Data conversion time in millisecond, following:
51
52 update_interval = C x S x (BC + SC)
53
54 * C: number of enabled channels
55 * S: number of samples
56 * BC: bus-voltage conversion time in millisecond
57 * SC: shunt-voltage conversion time in millisecond
58
59 Affects both Bus- and Shunt-voltage conversion time.
60 Note that setting update_interval to 0ms sets both BC
61 and SC to 140 us (minimum conversion time).
b04f2f7d 62======================= =======================================================