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