1 Kernel driver pmbus 1 Kernel driver pmbus
2 =================== 2 ===================
3 3
4 Supported chips: 4 Supported chips:
5 5
6 * Flex BMR310, BMR453, BMR454, BMR456, BMR45 6 * Flex BMR310, BMR453, BMR454, BMR456, BMR457, BMR458, BMR480,
7 BMR490, BMR491, BMR492 7 BMR490, BMR491, BMR492
8 8
9 Prefixes: 'bmr310', 'bmr453', 'bmr454', 'b 9 Prefixes: 'bmr310', 'bmr453', 'bmr454', 'bmr456', 'bmr457', 'bmr458', 'bmr480',
10 'bmr490', 'bmr491', 'bmr492' 10 'bmr490', 'bmr491', 'bmr492'
11 11
12 Addresses scanned: - 12 Addresses scanned: -
13 13
14 Datasheets: 14 Datasheets:
15 15
16 https://flexpowermodules.com/products 16 https://flexpowermodules.com/products
17 17
18 18
19 * ON Semiconductor ADP4000, NCP4200, NCP4208 19 * ON Semiconductor ADP4000, NCP4200, NCP4208
20 20
21 Prefixes: 'adp4000', 'ncp4200', 'ncp4208' 21 Prefixes: 'adp4000', 'ncp4200', 'ncp4208'
22 22
23 Addresses scanned: - 23 Addresses scanned: -
24 24
25 Datasheets: 25 Datasheets:
26 26
27 https://www.onsemi.com/pub_link/Collat 27 https://www.onsemi.com/pub_link/Collateral/ADP4000-D.PDF
28 28
29 https://www.onsemi.com/pub_link/Collat 29 https://www.onsemi.com/pub_link/Collateral/NCP4200-D.PDF
30 30
31 https://www.onsemi.com/pub_link/Collat 31 https://www.onsemi.com/pub_link/Collateral/JUNE%202009-%20REV.%200.PDF
32 32
33 * Lineage Power 33 * Lineage Power
34 34
35 Prefixes: 'mdt040', 'pdt003', 'pdt006', 'p 35 Prefixes: 'mdt040', 'pdt003', 'pdt006', 'pdt012', 'udt020'
36 36
37 Addresses scanned: - 37 Addresses scanned: -
38 38
39 Datasheets: 39 Datasheets:
40 40
41 http://www.lineagepower.com/oem/pdf/PD 41 http://www.lineagepower.com/oem/pdf/PDT003A0X.pdf
42 42
43 http://www.lineagepower.com/oem/pdf/PD 43 http://www.lineagepower.com/oem/pdf/PDT006A0X.pdf
44 44
45 http://www.lineagepower.com/oem/pdf/PD 45 http://www.lineagepower.com/oem/pdf/PDT012A0X.pdf
46 46
47 http://www.lineagepower.com/oem/pdf/UD 47 http://www.lineagepower.com/oem/pdf/UDT020A0X.pdf
48 48
49 http://www.lineagepower.com/oem/pdf/MD 49 http://www.lineagepower.com/oem/pdf/MDT040A0X.pdf
50 50
51 * Texas Instruments TPS40400, TPS544B20, TPS 51 * Texas Instruments TPS40400, TPS544B20, TPS544B25, TPS544C20, TPS544C25
52 52
53 Prefixes: 'tps40400', 'tps544b20', 'tps544 53 Prefixes: 'tps40400', 'tps544b20', 'tps544b25', 'tps544c20', 'tps544c25'
54 54
55 Addresses scanned: - 55 Addresses scanned: -
56 56
57 Datasheets: 57 Datasheets:
58 58
59 https://www.ti.com/lit/gpn/tps40400 59 https://www.ti.com/lit/gpn/tps40400
60 60
61 https://www.ti.com/lit/gpn/tps544b20 61 https://www.ti.com/lit/gpn/tps544b20
62 62
63 https://www.ti.com/lit/gpn/tps544b25 63 https://www.ti.com/lit/gpn/tps544b25
64 64
65 https://www.ti.com/lit/gpn/tps544c20 65 https://www.ti.com/lit/gpn/tps544c20
66 66
67 https://www.ti.com/lit/gpn/tps544c25 67 https://www.ti.com/lit/gpn/tps544c25
68 68
69 * Maxim MAX20796 69 * Maxim MAX20796
70 70
71 Prefix: 'max20796' 71 Prefix: 'max20796'
72 72
73 Addresses scanned: - 73 Addresses scanned: -
74 74
75 Datasheet: 75 Datasheet:
76 76
77 Not published 77 Not published
78 78
79 * Generic PMBus devices 79 * Generic PMBus devices
80 80
81 Prefix: 'pmbus' 81 Prefix: 'pmbus'
82 82
83 Addresses scanned: - 83 Addresses scanned: -
84 84
85 Datasheet: n.a. 85 Datasheet: n.a.
86 86
87 87
88 Author: Guenter Roeck <linux@roeck-us.net> 88 Author: Guenter Roeck <linux@roeck-us.net>
89 89
90 90
91 Description 91 Description
92 ----------- 92 -----------
93 93
94 This driver supports hardware monitoring for v 94 This driver supports hardware monitoring for various PMBus compliant devices.
95 It supports voltage, current, power, and tempe 95 It supports voltage, current, power, and temperature sensors as supported
96 by the device. 96 by the device.
97 97
98 Each monitored channel has its own high and lo 98 Each monitored channel has its own high and low limits, plus a critical
99 limit. 99 limit.
100 100
101 Fan support will be added in a later version o 101 Fan support will be added in a later version of this driver.
102 102
103 103
104 Usage Notes 104 Usage Notes
105 ----------- 105 -----------
106 106
107 This driver does not probe for PMBus devices, 107 This driver does not probe for PMBus devices, since there is no register
108 which can be safely used to identify the chip 108 which can be safely used to identify the chip (The MFG_ID register is not
109 supported by all chips), and since there is no 109 supported by all chips), and since there is no well defined address range for
110 PMBus devices. You will have to instantiate th 110 PMBus devices. You will have to instantiate the devices explicitly.
111 111
112 Example: the following will load the driver fo 112 Example: the following will load the driver for an LTC2978 at address 0x60
113 on I2C bus #1:: 113 on I2C bus #1::
114 114
115 $ modprobe pmbus 115 $ modprobe pmbus
116 $ echo ltc2978 0x60 > /sys/bus/i2c/dev 116 $ echo ltc2978 0x60 > /sys/bus/i2c/devices/i2c-1/new_device
117 117
118 118
119 Platform data support 119 Platform data support
120 --------------------- 120 ---------------------
121 121
122 Support for additional PMBus chips can be adde 122 Support for additional PMBus chips can be added by defining chip parameters in
123 a new chip specific driver file. For example, 123 a new chip specific driver file. For example, (untested) code to add support for
124 Emerson DS1200 power modules might look as fol 124 Emerson DS1200 power modules might look as follows::
125 125
126 static struct pmbus_driver_info ds1200_info 126 static struct pmbus_driver_info ds1200_info = {
127 .pages = 1, 127 .pages = 1,
128 /* Note: All other sensors are in line 128 /* Note: All other sensors are in linear mode */
129 .direct[PSC_VOLTAGE_OUT] = true, 129 .direct[PSC_VOLTAGE_OUT] = true,
130 .direct[PSC_TEMPERATURE] = true, 130 .direct[PSC_TEMPERATURE] = true,
131 .direct[PSC_CURRENT_OUT] = true, 131 .direct[PSC_CURRENT_OUT] = true,
132 .m[PSC_VOLTAGE_IN] = 1, 132 .m[PSC_VOLTAGE_IN] = 1,
133 .b[PSC_VOLTAGE_IN] = 0, 133 .b[PSC_VOLTAGE_IN] = 0,
134 .R[PSC_VOLTAGE_IN] = 3, 134 .R[PSC_VOLTAGE_IN] = 3,
135 .m[PSC_VOLTAGE_OUT] = 1, 135 .m[PSC_VOLTAGE_OUT] = 1,
136 .b[PSC_VOLTAGE_OUT] = 0, 136 .b[PSC_VOLTAGE_OUT] = 0,
137 .R[PSC_VOLTAGE_OUT] = 3, 137 .R[PSC_VOLTAGE_OUT] = 3,
138 .m[PSC_TEMPERATURE] = 1, 138 .m[PSC_TEMPERATURE] = 1,
139 .b[PSC_TEMPERATURE] = 0, 139 .b[PSC_TEMPERATURE] = 0,
140 .R[PSC_TEMPERATURE] = 3, 140 .R[PSC_TEMPERATURE] = 3,
141 .func[0] = PMBUS_HAVE_VIN | PMBUS_HAVE 141 .func[0] = PMBUS_HAVE_VIN | PMBUS_HAVE_IIN | PMBUS_HAVE_STATUS_INPUT
142 | PMBUS_HAVE_VOUT | PMBUS_H 142 | PMBUS_HAVE_VOUT | PMBUS_HAVE_STATUS_VOUT
143 | PMBUS_HAVE_IOUT | PMBUS_H 143 | PMBUS_HAVE_IOUT | PMBUS_HAVE_STATUS_IOUT
144 | PMBUS_HAVE_PIN | PMBUS_HA 144 | PMBUS_HAVE_PIN | PMBUS_HAVE_POUT
145 | PMBUS_HAVE_TEMP | PMBUS_H 145 | PMBUS_HAVE_TEMP | PMBUS_HAVE_STATUS_TEMP
146 | PMBUS_HAVE_FAN12 | PMBUS_ 146 | PMBUS_HAVE_FAN12 | PMBUS_HAVE_STATUS_FAN12,
147 }; 147 };
148 148
149 static int ds1200_probe(struct i2c_client *c 149 static int ds1200_probe(struct i2c_client *client)
150 { 150 {
151 return pmbus_do_probe(client, &ds1200_ 151 return pmbus_do_probe(client, &ds1200_info);
152 } 152 }
153 153
154 static const struct i2c_device_id ds1200_id[ 154 static const struct i2c_device_id ds1200_id[] = {
155 {"ds1200"}, 155 {"ds1200"},
156 {} 156 {}
157 }; 157 };
158 158
159 MODULE_DEVICE_TABLE(i2c, ds1200_id); 159 MODULE_DEVICE_TABLE(i2c, ds1200_id);
160 160
161 /* This is the driver that will be inserted 161 /* This is the driver that will be inserted */
162 static struct i2c_driver ds1200_driver = { 162 static struct i2c_driver ds1200_driver = {
163 .driver = { 163 .driver = {
164 .name = "ds1200", 164 .name = "ds1200",
165 }, 165 },
166 .probe = ds1200_probe, 166 .probe = ds1200_probe,
167 .id_table = ds1200_id, 167 .id_table = ds1200_id,
168 }; 168 };
169 169
170 static int __init ds1200_init(void) 170 static int __init ds1200_init(void)
171 { 171 {
172 return i2c_add_driver(&ds1200_driver); 172 return i2c_add_driver(&ds1200_driver);
173 } 173 }
174 174
175 static void __exit ds1200_exit(void) 175 static void __exit ds1200_exit(void)
176 { 176 {
177 i2c_del_driver(&ds1200_driver); 177 i2c_del_driver(&ds1200_driver);
178 } 178 }
179 179
180 180
181 Sysfs entries 181 Sysfs entries
182 ------------- 182 -------------
183 183
184 When probing the chip, the driver identifies w 184 When probing the chip, the driver identifies which PMBus registers are
185 supported, and determines available sensors fr 185 supported, and determines available sensors from this information.
186 Attribute files only exist if respective senso 186 Attribute files only exist if respective sensors are supported by the chip.
187 Labels are provided to inform the user about t 187 Labels are provided to inform the user about the sensor associated with
188 a given sysfs entry. 188 a given sysfs entry.
189 189
190 The following attributes are supported. Limits 190 The following attributes are supported. Limits are read-write; all other
191 attributes are read-only. 191 attributes are read-only.
192 192
193 ======================= ====================== 193 ======================= ========================================================
194 inX_input Measured voltage. From 194 inX_input Measured voltage. From READ_VIN or READ_VOUT register.
195 inX_min Minimum Voltage. 195 inX_min Minimum Voltage.
196 From VIN_UV_WARN_LIMIT 196 From VIN_UV_WARN_LIMIT or VOUT_UV_WARN_LIMIT register.
197 inX_max Maximum voltage. 197 inX_max Maximum voltage.
198 From VIN_OV_WARN_LIMIT 198 From VIN_OV_WARN_LIMIT or VOUT_OV_WARN_LIMIT register.
199 inX_lcrit Critical minimum Volta 199 inX_lcrit Critical minimum Voltage.
200 From VIN_UV_FAULT_LIMI 200 From VIN_UV_FAULT_LIMIT or VOUT_UV_FAULT_LIMIT register.
201 inX_crit Critical maximum volta 201 inX_crit Critical maximum voltage.
202 From VIN_OV_FAULT_LIMI 202 From VIN_OV_FAULT_LIMIT or VOUT_OV_FAULT_LIMIT register.
203 inX_min_alarm Voltage low alarm. Fro 203 inX_min_alarm Voltage low alarm. From VOLTAGE_UV_WARNING status.
204 inX_max_alarm Voltage high alarm. Fr 204 inX_max_alarm Voltage high alarm. From VOLTAGE_OV_WARNING status.
205 inX_lcrit_alarm Voltage critical low a 205 inX_lcrit_alarm Voltage critical low alarm.
206 From VOLTAGE_UV_FAULT 206 From VOLTAGE_UV_FAULT status.
207 inX_crit_alarm Voltage critical high 207 inX_crit_alarm Voltage critical high alarm.
208 From VOLTAGE_OV_FAULT 208 From VOLTAGE_OV_FAULT status.
209 inX_label "vin", "vcap", or "vou 209 inX_label "vin", "vcap", or "voutY"
210 inX_rated_min Minimum rated voltage. 210 inX_rated_min Minimum rated voltage.
211 From MFR_VIN_MIN or MF 211 From MFR_VIN_MIN or MFR_VOUT_MIN register.
212 inX_rated_max Maximum rated voltage. 212 inX_rated_max Maximum rated voltage.
213 From MFR_VIN_MAX or MF 213 From MFR_VIN_MAX or MFR_VOUT_MAX register.
214 214
215 currX_input Measured current. From 215 currX_input Measured current. From READ_IIN or READ_IOUT register.
216 currX_max Maximum current. 216 currX_max Maximum current.
217 From IIN_OC_WARN_LIMIT 217 From IIN_OC_WARN_LIMIT or IOUT_OC_WARN_LIMIT register.
218 currX_lcrit Critical minimum outpu 218 currX_lcrit Critical minimum output current.
219 From IOUT_UC_FAULT_LIM 219 From IOUT_UC_FAULT_LIMIT register.
220 currX_crit Critical maximum curre 220 currX_crit Critical maximum current.
221 From IIN_OC_FAULT_LIMI 221 From IIN_OC_FAULT_LIMIT or IOUT_OC_FAULT_LIMIT register.
222 currX_alarm Current high alarm. 222 currX_alarm Current high alarm.
223 From IIN_OC_WARNING or 223 From IIN_OC_WARNING or IOUT_OC_WARNING status.
224 currX_max_alarm Current high alarm. 224 currX_max_alarm Current high alarm.
225 From IIN_OC_WARN_LIMIT 225 From IIN_OC_WARN_LIMIT or IOUT_OC_WARN_LIMIT status.
226 currX_lcrit_alarm Output current critica 226 currX_lcrit_alarm Output current critical low alarm.
227 From IOUT_UC_FAULT sta 227 From IOUT_UC_FAULT status.
228 currX_crit_alarm Current critical high 228 currX_crit_alarm Current critical high alarm.
229 From IIN_OC_FAULT or I 229 From IIN_OC_FAULT or IOUT_OC_FAULT status.
230 currX_label "iin", "iinY", "iinY.Z 230 currX_label "iin", "iinY", "iinY.Z", "ioutY", or "ioutY.Z",
231 where Y reflects the p 231 where Y reflects the page number and Z reflects the
232 phase. 232 phase.
233 currX_rated_max Maximum rated current. 233 currX_rated_max Maximum rated current.
234 From MFR_IIN_MAX or MF 234 From MFR_IIN_MAX or MFR_IOUT_MAX register.
235 235
236 powerX_input Measured power. From R 236 powerX_input Measured power. From READ_PIN or READ_POUT register.
237 powerX_cap Output power cap. From 237 powerX_cap Output power cap. From POUT_MAX register.
238 powerX_max Power limit. From PIN_ 238 powerX_max Power limit. From PIN_OP_WARN_LIMIT or
239 POUT_OP_WARN_LIMIT reg 239 POUT_OP_WARN_LIMIT register.
240 powerX_crit Critical output power 240 powerX_crit Critical output power limit.
241 From POUT_OP_FAULT_LIM 241 From POUT_OP_FAULT_LIMIT register.
242 powerX_alarm Power high alarm. 242 powerX_alarm Power high alarm.
243 From PIN_OP_WARNING or 243 From PIN_OP_WARNING or POUT_OP_WARNING status.
244 powerX_crit_alarm Output power critical 244 powerX_crit_alarm Output power critical high alarm.
245 From POUT_OP_FAULT sta 245 From POUT_OP_FAULT status.
246 powerX_label "pin", "pinY", "pinY.Z 246 powerX_label "pin", "pinY", "pinY.Z", "poutY", or "poutY.Z",
247 where Y reflects the p 247 where Y reflects the page number and Z reflects the
248 phase. 248 phase.
249 powerX_rated_max Maximum rated power. 249 powerX_rated_max Maximum rated power.
250 From MFR_PIN_MAX or MF 250 From MFR_PIN_MAX or MFR_POUT_MAX register.
251 251
252 tempX_input Measured temperature. 252 tempX_input Measured temperature.
253 From READ_TEMPERATURE_ 253 From READ_TEMPERATURE_X register.
254 tempX_min Minimum temperature. F 254 tempX_min Minimum temperature. From UT_WARN_LIMIT register.
255 tempX_max Maximum temperature. F 255 tempX_max Maximum temperature. From OT_WARN_LIMIT register.
256 tempX_lcrit Critical low temperatu 256 tempX_lcrit Critical low temperature.
257 From UT_FAULT_LIMIT re 257 From UT_FAULT_LIMIT register.
258 tempX_crit Critical high temperat 258 tempX_crit Critical high temperature.
259 From OT_FAULT_LIMIT re 259 From OT_FAULT_LIMIT register.
260 tempX_min_alarm Chip temperature low a 260 tempX_min_alarm Chip temperature low alarm. Set by comparing
261 READ_TEMPERATURE_X wit 261 READ_TEMPERATURE_X with UT_WARN_LIMIT if
262 TEMP_UT_WARNING status 262 TEMP_UT_WARNING status is set.
263 tempX_max_alarm Chip temperature high 263 tempX_max_alarm Chip temperature high alarm. Set by comparing
264 READ_TEMPERATURE_X wit 264 READ_TEMPERATURE_X with OT_WARN_LIMIT if
265 TEMP_OT_WARNING status 265 TEMP_OT_WARNING status is set.
266 tempX_lcrit_alarm Chip temperature criti 266 tempX_lcrit_alarm Chip temperature critical low alarm. Set by comparing
267 READ_TEMPERATURE_X wit 267 READ_TEMPERATURE_X with UT_FAULT_LIMIT if
268 TEMP_UT_FAULT status i 268 TEMP_UT_FAULT status is set.
269 tempX_crit_alarm Chip temperature criti 269 tempX_crit_alarm Chip temperature critical high alarm. Set by comparing
270 READ_TEMPERATURE_X wit 270 READ_TEMPERATURE_X with OT_FAULT_LIMIT if
271 TEMP_OT_FAULT status i 271 TEMP_OT_FAULT status is set.
272 tempX_rated_min Minimum rated temperat 272 tempX_rated_min Minimum rated temperature.
273 From MFR_TAMBIENT_MIN 273 From MFR_TAMBIENT_MIN register.
274 tempX_rated_max Maximum rated temperat 274 tempX_rated_max Maximum rated temperature.
275 From MFR_TAMBIENT_MAX, 275 From MFR_TAMBIENT_MAX, MFR_MAX_TEMP_1, MFR_MAX_TEMP_2 or
276 MFR_MAX_TEMP_3 registe 276 MFR_MAX_TEMP_3 register.
277 ======================= ====================== 277 ======================= ========================================================
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.