xref: /linux/Documentation/hwmon/tps53679.rst (revision 95298d63c67673c654c08952672d016212b26054)
1Kernel driver tps53679
2======================
3
4Supported chips:
5
6  * Texas Instruments TPS53647
7
8    Prefix: 'tps53647'
9
10    Addresses scanned: -
11
12    Datasheet: http://www.ti.com/lit/gpn/tps53647
13
14  * Texas Instruments TPS53667
15
16    Prefix: 'tps53667'
17
18    Addresses scanned: -
19
20    Datasheet: http://www.ti.com/lit/gpn/TPS53667
21
22  * Texas Instruments TPS53679
23
24    Prefix: 'tps53679'
25
26    Addresses scanned: -
27
28    Datasheet: http://www.ti.com/lit/gpn/TPS53679 (short version)
29
30  * Texas Instruments TPS53681
31
32    Prefix: 'tps53681'
33
34    Addresses scanned: -
35
36    Datasheet: http://www.ti.com/lit/gpn/TPS53681
37
38  * Texas Instruments TPS53688
39
40    Prefix: 'tps53688'
41
42    Addresses scanned: -
43
44    Datasheet: Available under NDA
45
46
47Authors:
48	Vadim Pasternak <vadimp@mellanox.com>
49	Guenter Roeck <linux@roeck-us.net>
50
51
52Description
53-----------
54
55Chips in this series are multi-phase step-down converters with one or two
56output channels and up to 8 phases per channel.
57
58
59Usage Notes
60-----------
61
62This driver does not probe for PMBus devices. You will have to instantiate
63devices explicitly.
64
65Example: the following commands will load the driver for an TPS53681 at address
660x60 on I2C bus #1::
67
68	# modprobe tps53679
69	# echo tps53681 0x60 > /sys/bus/i2c/devices/i2c-1/new_device
70
71
72Sysfs attributes
73----------------
74
75======================= ========================================================
76in1_label		"vin"
77
78in1_input		Measured input voltage.
79
80in1_lcrit		Critical minimum input voltage
81
82			TPS53679, TPS53681, TPS53688 only.
83
84in1_lcrit_alarm		Input voltage critical low alarm.
85
86			TPS53679, TPS53681, TPS53688 only.
87
88in1_crit		Critical maximum input voltage.
89
90in1_crit_alarm		Input voltage critical high alarm.
91
92in[N]_label		"vout[1-2]"
93
94			- TPS53647, TPS53667: N=2
95			- TPS53679, TPS53588: N=2,3
96
97in[N]_input		Measured output voltage.
98
99in[N]_lcrit		Critical minimum input voltage.
100
101			TPS53679, TPS53681, TPS53688 only.
102
103in[N]_lcrit_alarm	Critical minimum voltage alarm.
104
105			TPS53679, TPS53681, TPS53688 only.
106
107in[N]_alarm		Output voltage alarm.
108
109			TPS53647, TPS53667 only.
110
111in[N]_crit		Critical maximum output voltage.
112
113			TPS53679, TPS53681, TPS53688 only.
114
115in[N]_crit_alarm	Output voltage critical high alarm.
116
117			TPS53679, TPS53681, TPS53688 only.
118
119temp[N]_input		Measured temperature.
120
121			- TPS53647, TPS53667: N=1
122			- TPS53679, TPS53681, TPS53588: N=1,2
123
124temp[N]_max		Maximum temperature.
125
126temp[N]_crit		Critical high temperature.
127
128temp[N]_max_alarm	Temperature high alarm.
129
130temp[N]_crit_alarm	Temperature critical high alarm.
131
132power1_label		"pin".
133
134power1_input		Measured input power.
135
136power[N]_label		"pout[1-2]".
137
138			- TPS53647, TPS53667: N=2
139			- TPS53679, TPS53681, TPS53588: N=2,3
140
141power[N]_input		Measured output power.
142
143curr1_label		"iin".
144
145curr1_input		Measured input current.
146
147curr1_max		Maximum input current.
148
149curr1_max_alarm		Input current high alarm.
150
151curr1_crit		Critical input current.
152
153curr1_crit_alarm	Input current critical alarm.
154
155curr[N]_label		"iout[1-2]" or "iout1.[0-5]".
156
157			The first digit is the output channel, the second
158			digit is the phase within the channel. Per-phase
159			telemetry supported on TPS53681 only.
160
161			- TPS53647, TPS53667: N=2
162			- TPS53679, TPS53588: N=2,3
163			- TPS53681: N=2-9
164
165curr[N]_input		Measured output current.
166
167curr[N]_max		Maximum output current.
168
169curr[N]_crit		Critical high output current.
170
171curr[N]_max_alarm	Output current high alarm.
172
173curr[N]_crit_alarm	Output current critical high alarm.
174
175			Limit and alarm attributes are only available for
176			non-phase telemetry (iout1, iout2).
177
178======================= ========================================================
179