xref: /linux/Documentation/hwmon/ina238.rst (revision 03ab8e6297acd1bc0eedaa050e2a1635c576fd11)
1*eacb52f0SNathan Rossi.. SPDX-License-Identifier: GPL-2.0-only
2*eacb52f0SNathan Rossi
3*eacb52f0SNathan RossiKernel driver ina238
4*eacb52f0SNathan Rossi====================
5*eacb52f0SNathan Rossi
6*eacb52f0SNathan RossiSupported chips:
7*eacb52f0SNathan Rossi
8*eacb52f0SNathan Rossi  * Texas Instruments INA238
9*eacb52f0SNathan Rossi
10*eacb52f0SNathan Rossi    Prefix: 'ina238'
11*eacb52f0SNathan Rossi
12*eacb52f0SNathan Rossi    Addresses: I2C 0x40 - 0x4f
13*eacb52f0SNathan Rossi
14*eacb52f0SNathan Rossi    Datasheet:
15*eacb52f0SNathan Rossi	https://www.ti.com/lit/gpn/ina238
16*eacb52f0SNathan Rossi
17*eacb52f0SNathan RossiAuthor: Nathan Rossi <nathan.rossi@digi.com>
18*eacb52f0SNathan Rossi
19*eacb52f0SNathan RossiDescription
20*eacb52f0SNathan Rossi-----------
21*eacb52f0SNathan Rossi
22*eacb52f0SNathan RossiThe INA238 is a current shunt, power and temperature monitor with an I2C
23*eacb52f0SNathan Rossiinterface. It includes a number of programmable functions including alerts,
24*eacb52f0SNathan Rossiconversion rate, sample averaging and selectable shunt voltage accuracy.
25*eacb52f0SNathan Rossi
26*eacb52f0SNathan RossiThe shunt value in micro-ohms can be set via platform data or device tree at
27*eacb52f0SNathan Rossicompile-time or via the shunt_resistor attribute in sysfs at run-time. Please
28*eacb52f0SNathan Rossirefer to the Documentation/devicetree/bindings/hwmon/ti,ina2xx.yaml for bindings
29*eacb52f0SNathan Rossiif the device tree is used.
30*eacb52f0SNathan Rossi
31*eacb52f0SNathan RossiSysfs entries
32*eacb52f0SNathan Rossi-------------
33*eacb52f0SNathan Rossi
34*eacb52f0SNathan Rossi======================= =======================================================
35*eacb52f0SNathan Rossiin0_input		Shunt voltage (mV)
36*eacb52f0SNathan Rossiin0_min			Minimum shunt voltage threshold (mV)
37*eacb52f0SNathan Rossiin0_min_alarm		Minimum shunt voltage alarm
38*eacb52f0SNathan Rossiin0_max			Maximum shunt voltage threshold (mV)
39*eacb52f0SNathan Rossiin0_max_alarm		Maximum shunt voltage alarm
40*eacb52f0SNathan Rossi
41*eacb52f0SNathan Rossiin1_input		Bus voltage (mV)
42*eacb52f0SNathan Rossiin1_min			Minimum bus voltage threshold (mV)
43*eacb52f0SNathan Rossiin1_min_alarm		Minimum shunt voltage alarm
44*eacb52f0SNathan Rossiin1_max			Maximum bus voltage threshold (mV)
45*eacb52f0SNathan Rossiin1_max_alarm		Maximum shunt voltage alarm
46*eacb52f0SNathan Rossi
47*eacb52f0SNathan Rossipower1_input		Power measurement (uW)
48*eacb52f0SNathan Rossipower1_max		Maximum power threshold (uW)
49*eacb52f0SNathan Rossipower1_max_alarm	Maximum power alarm
50*eacb52f0SNathan Rossi
51*eacb52f0SNathan Rossicurr1_input		Current measurement (mA)
52*eacb52f0SNathan Rossi
53*eacb52f0SNathan Rossitemp1_input		Die temperature measurement (mC)
54*eacb52f0SNathan Rossitemp1_max		Maximum die temperature threshold (mC)
55*eacb52f0SNathan Rossitemp1_max_alarm		Maximum die temperature alarm
56*eacb52f0SNathan Rossi======================= =======================================================
57