Gitiles
Code Review Sign In
review.shift-gmbh.com / SHIFTPHONES / mainline / linux / 710c476514313c74045c41c0571bb5178fd16e3d / . / Documentation / hwmon / ina2xx.rst
blob: 27d2e39bc8ac71d585cd0c73898a1b61f34cb3ba [file] [log] [blame]
Felten, Lotharf7c2fe32012-05-12 04:36:38 -0400[diff] [blame]1Kernel driver ina2xx
2====================
3
4Supported chips:
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]5
Felten, Lotharf7c2fe32012-05-12 04:36:38 -0400[diff] [blame]6 * Texas Instruments INA219
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]7
8
Felten, Lotharf7c2fe32012-05-12 04:36:38 -0400[diff] [blame]9 Prefix: 'ina219'
10 Addresses: I2C 0x40 - 0x4f
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]11
Felten, Lotharf7c2fe32012-05-12 04:36:38 -0400[diff] [blame]12 Datasheet: Publicly available at the Texas Instruments website
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]13
Alexander A. Klimov49dc2fb2020-07-19 20:15:30 +0200[diff] [blame]14 https://www.ti.com/
Felten, Lotharf7c2fe32012-05-12 04:36:38 -0400[diff] [blame]15
Guenter Roeckdc92cd02012-05-12 11:33:11 -0700[diff] [blame]16 * Texas Instruments INA220
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]17
Guenter Roeckdc92cd02012-05-12 11:33:11 -0700[diff] [blame]18 Prefix: 'ina220'
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]19
Guenter Roeckdc92cd02012-05-12 11:33:11 -0700[diff] [blame]20 Addresses: I2C 0x40 - 0x4f
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]21
Guenter Roeckdc92cd02012-05-12 11:33:11 -0700[diff] [blame]22 Datasheet: Publicly available at the Texas Instruments website
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]23
Alexander A. Klimov49dc2fb2020-07-19 20:15:30 +0200[diff] [blame]24 https://www.ti.com/
Guenter Roeckdc92cd02012-05-12 11:33:11 -0700[diff] [blame]25
Felten, Lotharf7c2fe32012-05-12 04:36:38 -0400[diff] [blame]26 * Texas Instruments INA226
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]27
Felten, Lotharf7c2fe32012-05-12 04:36:38 -0400[diff] [blame]28 Prefix: 'ina226'
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]29
Felten, Lotharf7c2fe32012-05-12 04:36:38 -0400[diff] [blame]30 Addresses: I2C 0x40 - 0x4f
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]31
Felten, Lotharf7c2fe32012-05-12 04:36:38 -0400[diff] [blame]32 Datasheet: Publicly available at the Texas Instruments website
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]33
Alexander A. Klimov49dc2fb2020-07-19 20:15:30 +0200[diff] [blame]34 https://www.ti.com/
Felten, Lotharf7c2fe32012-05-12 04:36:38 -0400[diff] [blame]35
Guenter Roeckdc92cd02012-05-12 11:33:11 -0700[diff] [blame]36 * Texas Instruments INA230
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]37
Guenter Roeckdc92cd02012-05-12 11:33:11 -0700[diff] [blame]38 Prefix: 'ina230'
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]39
Guenter Roeckdc92cd02012-05-12 11:33:11 -0700[diff] [blame]40 Addresses: I2C 0x40 - 0x4f
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]41
Guenter Roeckdc92cd02012-05-12 11:33:11 -0700[diff] [blame]42 Datasheet: Publicly available at the Texas Instruments website
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]43
Alexander A. Klimov49dc2fb2020-07-19 20:15:30 +0200[diff] [blame]44 https://www.ti.com/
Guenter Roeckdc92cd02012-05-12 11:33:11 -0700[diff] [blame]45
Kevin Hilmanadd513b2015-01-14 17:34:58 -0800[diff] [blame]46 * Texas Instruments INA231
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]47
Kevin Hilmanadd513b2015-01-14 17:34:58 -0800[diff] [blame]48 Prefix: 'ina231'
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]49
Kevin Hilmanadd513b2015-01-14 17:34:58 -0800[diff] [blame]50 Addresses: I2C 0x40 - 0x4f
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]51
Kevin Hilmanadd513b2015-01-14 17:34:58 -0800[diff] [blame]52 Datasheet: Publicly available at the Texas Instruments website
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]53
Alexander A. Klimov49dc2fb2020-07-19 20:15:30 +0200[diff] [blame]54 https://www.ti.com/
Kevin Hilmanadd513b2015-01-14 17:34:58 -0800[diff] [blame]55
Lothar Felten3ad86702018-08-14 09:09:37 +0200[diff] [blame]56Author: Lothar Felten <lothar.felten@gmail.com>
Felten, Lotharf7c2fe32012-05-12 04:36:38 -0400[diff] [blame]57
58Description
59-----------
60
61The INA219 is a high-side current shunt and power monitor with an I2C
62interface. The INA219 monitors both shunt drop and supply voltage, with
63programmable conversion times and filtering.
64
Guenter Roeckdc92cd02012-05-12 11:33:11 -0700[diff] [blame]65The INA220 is a high or low side current shunt and power monitor with an I2C
66interface. The INA220 monitors both shunt drop and supply voltage.
67
Felten, Lotharf7c2fe32012-05-12 04:36:38 -0400[diff] [blame]68The INA226 is a current shunt and power monitor with an I2C interface.
69The INA226 monitors both a shunt voltage drop and bus supply voltage.
70
Kevin Hilmanadd513b2015-01-14 17:34:58 -0800[diff] [blame]71INA230 and INA231 are high or low side current shunt and power monitors
72with an I2C interface. The chips monitor both a shunt voltage drop and
73bus supply voltage.
Guenter Roeckdc92cd02012-05-12 11:33:11 -0700[diff] [blame]74
Bartosz Golaszewski8a5fc792015-01-05 15:20:55 +0100[diff] [blame]75The shunt value in micro-ohms can be set via platform data or device tree at
76compile-time or via the shunt_resistor attribute in sysfs at run-time. Please
Mauro Carvalho Chehabf6aed682021-01-13 11:59:17 +0100[diff] [blame]77refer to the Documentation/devicetree/bindings/hwmon/ti,ina2xx.yaml for bindings
Tang Yuantian31e7ad72013-06-19 14:50:20 +0800[diff] [blame]78if the device tree is used.
Bartosz Golaszewski72a87a42015-01-09 17:03:42 +0100[diff] [blame]79
80Additionally ina226 supports update_interval attribute as described in
Mauro Carvalho Chehab7ebd8b662019-04-17 06:46:29 -0300[diff] [blame]81Documentation/hwmon/sysfs-interface.rst. Internally the interval is the sum of
Bartosz Golaszewski72a87a42015-01-09 17:03:42 +0100[diff] [blame]82bus and shunt voltage conversion times multiplied by the averaging rate. We
83don't touch the conversion times and only modify the number of averages. The
84lower limit of the update_interval is 2 ms, the upper limit is 2253 ms.
85The actual programmed interval may vary from the desired value.
Nicolin Chen9a629d72018-11-19 12:31:16 -0800[diff] [blame]86
87General sysfs entries
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]88---------------------
Nicolin Chen9a629d72018-11-19 12:31:16 -0800[diff] [blame]89
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]90======================= ===============================
Nicolin Chen9a629d72018-11-19 12:31:16 -0800[diff] [blame]91in0_input Shunt voltage(mV) channel
92in1_input Bus voltage(mV) channel
93curr1_input Current(mA) measurement channel
94power1_input Power(uW) measurement channel
95shunt_resistor Shunt resistance(uOhm) channel
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]96======================= ===============================
Nicolin Chen9a629d72018-11-19 12:31:16 -0800[diff] [blame]97
98Sysfs entries for ina226, ina230 and ina231 only
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]99------------------------------------------------
Nicolin Chen9a629d72018-11-19 12:31:16 -0800[diff] [blame]100
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]101======================= ====================================================
Alex Qiu5a56a392020-05-04 17:59:45 -0700[diff] [blame]102in0_lcrit Critical low shunt voltage
103in0_crit Critical high shunt voltage
104in0_lcrit_alarm Shunt voltage critical low alarm
105in0_crit_alarm Shunt voltage critical high alarm
106in1_lcrit Critical low bus voltage
107in1_crit Critical high bus voltage
108in1_lcrit_alarm Bus voltage critical low alarm
109in1_crit_alarm Bus voltage critical high alarm
110power1_crit Critical high power
111power1_crit_alarm Power critical high alarm
Nicolin Chen9a629d72018-11-19 12:31:16 -0800[diff] [blame]112update_interval data conversion time; affects number of samples used
113 to average results for shunt and bus voltages.
Mauro Carvalho Chehabb32570a2019-04-17 06:46:27 -0300[diff] [blame]114======================= ====================================================
Alex Qiu5a56a392020-05-04 17:59:45 -0700[diff] [blame]115
116.. note::
117
118 - Configure `shunt_resistor` before configure `power1_crit`, because power
119 value is calculated based on `shunt_resistor` set.
120 - Because of the underlying register implementation, only one `*crit` setting
121 and its `alarm` can be active. Writing to one `*crit` setting clears other
122 `*crit` settings and alarms. Writing 0 to any `*crit` setting clears all
123 `*crit` settings and alarms.