xref: /linux/Documentation/hwmon/ina238.rst (revision 55a42f78ffd386e01a5404419f8c5ded7db70a21)
1.. SPDX-License-Identifier: GPL-2.0-only
2
3Kernel driver ina238
4====================
5
6Supported chips:
7
8  * Texas Instruments INA228
9
10    Prefix: 'ina228'
11
12    Addresses: I2C 0x40 - 0x4f
13
14    Datasheet:
15	https://www.ti.com/lit/gpn/ina228
16
17  * Texas Instruments INA237
18
19    Prefix: 'ina237'
20
21    Addresses: I2C 0x40 - 0x4f
22
23    Datasheet:
24	https://www.ti.com/lit/gpn/ina237
25
26  * Texas Instruments INA238
27
28    Prefix: 'ina238'
29
30    Addresses: I2C 0x40 - 0x4f
31
32    Datasheet:
33	https://www.ti.com/lit/gpn/ina238
34
35  * Texas Instruments INA700
36
37    Datasheet:
38	https://www.ti.com/product/ina700
39
40  * Texas Instruments INA780
41
42    Datasheet:
43	https://www.ti.com/product/ina780a
44
45  * Silergy SQ52206
46
47    Prefix: 'SQ52206'
48
49    Addresses: I2C 0x40 - 0x4f
50
51Author: Nathan Rossi <nathan.rossi@digi.com>
52
53Description
54-----------
55
56The INA238 is a current shunt, power and temperature monitor with an I2C
57interface. It includes a number of programmable functions including alerts,
58conversion rate, sample averaging and selectable shunt voltage accuracy.
59
60The shunt value in micro-ohms can be set via device properties, either from
61platform code or from device tree data. Please refer to
62Documentation/devicetree/bindings/hwmon/ti,ina2xx.yaml for bindings if
63device tree is used.
64
65INA237 is a functionally equivalent variant of INA238 with slightly
66different accuracy. INA228 is another variant of INA238 with higher ADC
67resolution. This chip also reports the energy.
68
69INA700 and INA780 are variants of the chip series with built-in shunt resistor.
70They also report the energy.
71
72SQ52206 is a mostly compatible chip from Sylergy. It reports the energy
73as well as the peak power consumption.
74
75Sysfs entries
76-------------
77
78======================= =======================================================
79in0_input		Shunt voltage (mV)
80in0_min			Minimum shunt voltage threshold (mV)
81in0_min_alarm		Minimum shunt voltage alarm
82in0_max			Maximum shunt voltage threshold (mV)
83in0_max_alarm		Maximum shunt voltage alarm
84
85in1_input		Bus voltage (mV)
86in1_min			Minimum bus voltage threshold (mV)
87in1_min_alarm		Minimum shunt voltage alarm
88in1_max			Maximum bus voltage threshold (mV)
89in1_max_alarm		Maximum shunt voltage alarm
90
91power1_input		Power measurement (uW)
92power1_max		Maximum power threshold (uW)
93power1_max_alarm	Maximum power alarm
94power1_input_highest	Peak Power (uW)
95				(SQ52206 only)
96
97curr1_input		Current measurement (mA)
98curr1_min		Minimum current threshold (mA)
99curr1_min_alarm		Minimum current alarm
100curr1_max		Maximum current threshold (mA)
101curr1_max_alarm		Maximum current alarm
102
103energy1_input		Energy measurement (uJ)
104				(SQ52206, INA237, and INA780 only)
105
106temp1_input		Die temperature measurement (mC)
107temp1_max		Maximum die temperature threshold (mC)
108temp1_max_alarm		Maximum die temperature alarm
109======================= =======================================================
110