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