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