xref: /linux/Documentation/hwmon/ina233.rst (revision 4f9786035f9e519db41375818e1d0b5f20da2f10)
1*b64b6cb1SLeo Yang.. SPDX-License-Identifier: GPL-2.0
2*b64b6cb1SLeo Yang
3*b64b6cb1SLeo YangKernel driver ina233
4*b64b6cb1SLeo Yang====================
5*b64b6cb1SLeo Yang
6*b64b6cb1SLeo YangSupported chips:
7*b64b6cb1SLeo Yang
8*b64b6cb1SLeo Yang  * TI INA233
9*b64b6cb1SLeo Yang
10*b64b6cb1SLeo Yang    Prefix: 'ina233'
11*b64b6cb1SLeo Yang
12*b64b6cb1SLeo Yang  * Datasheet
13*b64b6cb1SLeo Yang
14*b64b6cb1SLeo Yang    Publicly available at the TI website : https://www.ti.com/lit/ds/symlink/ina233.pdf
15*b64b6cb1SLeo Yang
16*b64b6cb1SLeo YangAuthor: Leo Yang <leo.yang.sy0@gmail.com>
17*b64b6cb1SLeo Yang
18*b64b6cb1SLeo YangUsage Notes
19*b64b6cb1SLeo Yang-----------
20*b64b6cb1SLeo Yang
21*b64b6cb1SLeo YangThe shunt resistor value can be configured by a device tree property;
22*b64b6cb1SLeo Yangsee Documentation/devicetree/bindings/hwmon/ti,ina2xx.yaml for details.
23*b64b6cb1SLeo Yang
24*b64b6cb1SLeo Yang
25*b64b6cb1SLeo YangDescription
26*b64b6cb1SLeo Yang-----------
27*b64b6cb1SLeo Yang
28*b64b6cb1SLeo YangThis driver supports hardware monitoring for TI INA233.
29*b64b6cb1SLeo Yang
30*b64b6cb1SLeo YangThe driver is a client driver to the core PMBus driver. Please see
31*b64b6cb1SLeo YangDocumentation/hwmon/pmbus.rst for details on PMBus client drivers.
32*b64b6cb1SLeo Yang
33*b64b6cb1SLeo YangThe driver provides the following attributes for input voltage:
34*b64b6cb1SLeo Yang
35*b64b6cb1SLeo Yang**in1_input**
36*b64b6cb1SLeo Yang
37*b64b6cb1SLeo Yang**in1_label**
38*b64b6cb1SLeo Yang
39*b64b6cb1SLeo Yang**in1_max**
40*b64b6cb1SLeo Yang
41*b64b6cb1SLeo Yang**in1_max_alarm**
42*b64b6cb1SLeo Yang
43*b64b6cb1SLeo Yang**in1_min**
44*b64b6cb1SLeo Yang
45*b64b6cb1SLeo Yang**in1_min_alarm**
46*b64b6cb1SLeo Yang
47*b64b6cb1SLeo YangThe driver provides the following attributes for shunt voltage:
48*b64b6cb1SLeo Yang
49*b64b6cb1SLeo Yang**in2_input**
50*b64b6cb1SLeo Yang
51*b64b6cb1SLeo Yang**in2_label**
52*b64b6cb1SLeo Yang
53*b64b6cb1SLeo YangThe driver provides the following attributes for output voltage:
54*b64b6cb1SLeo Yang
55*b64b6cb1SLeo Yang**in3_input**
56*b64b6cb1SLeo Yang
57*b64b6cb1SLeo Yang**in3_label**
58*b64b6cb1SLeo Yang
59*b64b6cb1SLeo Yang**in3_alarm**
60*b64b6cb1SLeo Yang
61*b64b6cb1SLeo YangThe driver provides the following attributes for output current:
62*b64b6cb1SLeo Yang
63*b64b6cb1SLeo Yang**curr1_input**
64*b64b6cb1SLeo Yang
65*b64b6cb1SLeo Yang**curr1_label**
66*b64b6cb1SLeo Yang
67*b64b6cb1SLeo Yang**curr1_max**
68*b64b6cb1SLeo Yang
69*b64b6cb1SLeo Yang**curr1_max_alarm**
70*b64b6cb1SLeo Yang
71*b64b6cb1SLeo YangThe driver provides the following attributes for input power:
72*b64b6cb1SLeo Yang
73*b64b6cb1SLeo Yang**power1_input**
74*b64b6cb1SLeo Yang
75*b64b6cb1SLeo Yang**power1_label**
76