2 * Hardware monitoring driver for LM25056 / LM25063 / LM25066 / LM5064 / LM5066
4 * Copyright (c) 2011 Ericsson AB.
5 * Copyright (c) 2013 Guenter Roeck
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 #include <linux/bitops.h>
23 #include <linux/kernel.h>
24 #include <linux/module.h>
25 #include <linux/init.h>
26 #include <linux/err.h>
27 #include <linux/slab.h>
28 #include <linux/i2c.h>
31 enum chips { lm25056, lm25063, lm25066, lm5064, lm5066 };
33 #define LM25066_READ_VAUX 0xd0
34 #define LM25066_MFR_READ_IIN 0xd1
35 #define LM25066_MFR_READ_PIN 0xd2
36 #define LM25066_MFR_IIN_OC_WARN_LIMIT 0xd3
37 #define LM25066_MFR_PIN_OP_WARN_LIMIT 0xd4
38 #define LM25066_READ_PIN_PEAK 0xd5
39 #define LM25066_CLEAR_PIN_PEAK 0xd6
40 #define LM25066_DEVICE_SETUP 0xd9
41 #define LM25066_READ_AVG_VIN 0xdc
42 #define LM25066_READ_AVG_VOUT 0xdd
43 #define LM25066_READ_AVG_IIN 0xde
44 #define LM25066_READ_AVG_PIN 0xdf
46 #define LM25066_DEV_SETUP_CL BIT(4) /* Current limit */
50 #define LM25056_VAUX_OV_WARN_LIMIT 0xe3
51 #define LM25056_VAUX_UV_WARN_LIMIT 0xe4
53 #define LM25056_MFR_STS_VAUX_OV_WARN BIT(1)
54 #define LM25056_MFR_STS_VAUX_UV_WARN BIT(0)
58 #define LM25063_READ_VOUT_MAX 0xe5
59 #define LM25063_READ_VOUT_MIN 0xe6
65 #define PSC_CURRENT_IN_L (PSC_NUM_CLASSES)
66 #define PSC_POWER_L (PSC_NUM_CLASSES + 1)
68 static struct __coeff lm25066_coeff[5][PSC_NUM_CLASSES + 2] = {
78 [PSC_CURRENT_IN_L] = {
101 [PSC_VOLTAGE_OUT] = {
109 [PSC_CURRENT_IN_L] = {
121 [PSC_TEMPERATURE] = {
130 [PSC_VOLTAGE_OUT] = {
138 [PSC_CURRENT_IN_L] = {
150 [PSC_TEMPERATURE] = {
160 [PSC_VOLTAGE_OUT] = {
168 [PSC_CURRENT_IN_L] = {
180 [PSC_TEMPERATURE] = {
189 [PSC_VOLTAGE_OUT] = {
197 [PSC_CURRENT_IN_L] = {
209 [PSC_TEMPERATURE] = {
215 struct lm25066_data {
217 u16 rlimit; /* Maximum register value */
218 struct pmbus_driver_info info;
221 #define to_lm25066_data(x) container_of(x, struct lm25066_data, info)
223 static int lm25066_read_word_data(struct i2c_client *client, int page, int reg)
225 const struct pmbus_driver_info *info = pmbus_get_driver_info(client);
226 const struct lm25066_data *data = to_lm25066_data(info);
230 case PMBUS_VIRT_READ_VMON:
231 ret = pmbus_read_word_data(client, 0, LM25066_READ_VAUX);
234 /* Adjust returned value to match VIN coefficients */
237 /* VIN: 6.14 mV VAUX: 293 uV LSB */
238 ret = DIV_ROUND_CLOSEST(ret * 293, 6140);
241 /* VIN: 6.25 mV VAUX: 200.0 uV LSB */
242 ret = DIV_ROUND_CLOSEST(ret * 20, 625);
245 /* VIN: 4.54 mV VAUX: 283.2 uV LSB */
246 ret = DIV_ROUND_CLOSEST(ret * 2832, 45400);
249 /* VIN: 4.53 mV VAUX: 700 uV LSB */
250 ret = DIV_ROUND_CLOSEST(ret * 70, 453);
253 /* VIN: 2.18 mV VAUX: 725 uV LSB */
254 ret = DIV_ROUND_CLOSEST(ret * 725, 2180);
259 ret = pmbus_read_word_data(client, 0, LM25066_MFR_READ_IIN);
262 ret = pmbus_read_word_data(client, 0, LM25066_MFR_READ_PIN);
264 case PMBUS_IIN_OC_WARN_LIMIT:
265 ret = pmbus_read_word_data(client, 0,
266 LM25066_MFR_IIN_OC_WARN_LIMIT);
268 case PMBUS_PIN_OP_WARN_LIMIT:
269 ret = pmbus_read_word_data(client, 0,
270 LM25066_MFR_PIN_OP_WARN_LIMIT);
272 case PMBUS_VIRT_READ_VIN_AVG:
273 ret = pmbus_read_word_data(client, 0, LM25066_READ_AVG_VIN);
275 case PMBUS_VIRT_READ_VOUT_AVG:
276 ret = pmbus_read_word_data(client, 0, LM25066_READ_AVG_VOUT);
278 case PMBUS_VIRT_READ_IIN_AVG:
279 ret = pmbus_read_word_data(client, 0, LM25066_READ_AVG_IIN);
281 case PMBUS_VIRT_READ_PIN_AVG:
282 ret = pmbus_read_word_data(client, 0, LM25066_READ_AVG_PIN);
284 case PMBUS_VIRT_READ_PIN_MAX:
285 ret = pmbus_read_word_data(client, 0, LM25066_READ_PIN_PEAK);
287 case PMBUS_VIRT_RESET_PIN_HISTORY:
297 static int lm25063_read_word_data(struct i2c_client *client, int page, int reg)
302 case PMBUS_VIRT_READ_VOUT_MAX:
303 ret = pmbus_read_word_data(client, 0, LM25063_READ_VOUT_MAX);
305 case PMBUS_VIRT_READ_VOUT_MIN:
306 ret = pmbus_read_word_data(client, 0, LM25063_READ_VOUT_MIN);
309 ret = lm25066_read_word_data(client, page, reg);
315 static int lm25056_read_word_data(struct i2c_client *client, int page, int reg)
320 case PMBUS_VIRT_VMON_UV_WARN_LIMIT:
321 ret = pmbus_read_word_data(client, 0,
322 LM25056_VAUX_UV_WARN_LIMIT);
325 /* Adjust returned value to match VIN coefficients */
326 ret = DIV_ROUND_CLOSEST(ret * 293, 6140);
328 case PMBUS_VIRT_VMON_OV_WARN_LIMIT:
329 ret = pmbus_read_word_data(client, 0,
330 LM25056_VAUX_OV_WARN_LIMIT);
333 /* Adjust returned value to match VIN coefficients */
334 ret = DIV_ROUND_CLOSEST(ret * 293, 6140);
337 ret = lm25066_read_word_data(client, page, reg);
343 static int lm25056_read_byte_data(struct i2c_client *client, int page, int reg)
348 case PMBUS_VIRT_STATUS_VMON:
349 ret = pmbus_read_byte_data(client, 0,
350 PMBUS_STATUS_MFR_SPECIFIC);
354 if (ret & LM25056_MFR_STS_VAUX_UV_WARN)
355 s |= PB_VOLTAGE_UV_WARNING;
356 if (ret & LM25056_MFR_STS_VAUX_OV_WARN)
357 s |= PB_VOLTAGE_OV_WARNING;
367 static int lm25066_write_word_data(struct i2c_client *client, int page, int reg,
370 const struct pmbus_driver_info *info = pmbus_get_driver_info(client);
371 const struct lm25066_data *data = to_lm25066_data(info);
375 case PMBUS_POUT_OP_FAULT_LIMIT:
376 case PMBUS_POUT_OP_WARN_LIMIT:
377 case PMBUS_VOUT_UV_WARN_LIMIT:
378 case PMBUS_OT_FAULT_LIMIT:
379 case PMBUS_OT_WARN_LIMIT:
380 case PMBUS_IIN_OC_FAULT_LIMIT:
381 case PMBUS_VIN_UV_WARN_LIMIT:
382 case PMBUS_VIN_UV_FAULT_LIMIT:
383 case PMBUS_VIN_OV_FAULT_LIMIT:
384 case PMBUS_VIN_OV_WARN_LIMIT:
385 word = ((s16)word < 0) ? 0 : clamp_val(word, 0, data->rlimit);
386 ret = pmbus_write_word_data(client, 0, reg, word);
387 pmbus_clear_cache(client);
389 case PMBUS_IIN_OC_WARN_LIMIT:
390 word = ((s16)word < 0) ? 0 : clamp_val(word, 0, data->rlimit);
391 ret = pmbus_write_word_data(client, 0,
392 LM25066_MFR_IIN_OC_WARN_LIMIT,
394 pmbus_clear_cache(client);
396 case PMBUS_PIN_OP_WARN_LIMIT:
397 word = ((s16)word < 0) ? 0 : clamp_val(word, 0, data->rlimit);
398 ret = pmbus_write_word_data(client, 0,
399 LM25066_MFR_PIN_OP_WARN_LIMIT,
401 pmbus_clear_cache(client);
403 case PMBUS_VIRT_VMON_UV_WARN_LIMIT:
404 /* Adjust from VIN coefficients (for LM25056) */
405 word = DIV_ROUND_CLOSEST((int)word * 6140, 293);
406 word = ((s16)word < 0) ? 0 : clamp_val(word, 0, data->rlimit);
407 ret = pmbus_write_word_data(client, 0,
408 LM25056_VAUX_UV_WARN_LIMIT, word);
409 pmbus_clear_cache(client);
411 case PMBUS_VIRT_VMON_OV_WARN_LIMIT:
412 /* Adjust from VIN coefficients (for LM25056) */
413 word = DIV_ROUND_CLOSEST((int)word * 6140, 293);
414 word = ((s16)word < 0) ? 0 : clamp_val(word, 0, data->rlimit);
415 ret = pmbus_write_word_data(client, 0,
416 LM25056_VAUX_OV_WARN_LIMIT, word);
417 pmbus_clear_cache(client);
419 case PMBUS_VIRT_RESET_PIN_HISTORY:
420 ret = pmbus_write_byte(client, 0, LM25066_CLEAR_PIN_PEAK);
429 static int lm25066_probe(struct i2c_client *client,
430 const struct i2c_device_id *id)
433 struct lm25066_data *data;
434 struct pmbus_driver_info *info;
435 struct __coeff *coeff;
437 if (!i2c_check_functionality(client->adapter,
438 I2C_FUNC_SMBUS_READ_BYTE_DATA))
441 data = devm_kzalloc(&client->dev, sizeof(struct lm25066_data),
446 config = i2c_smbus_read_byte_data(client, LM25066_DEVICE_SETUP);
450 data->id = id->driver_data;
454 info->format[PSC_VOLTAGE_IN] = direct;
455 info->format[PSC_VOLTAGE_OUT] = direct;
456 info->format[PSC_CURRENT_IN] = direct;
457 info->format[PSC_TEMPERATURE] = direct;
458 info->format[PSC_POWER] = direct;
460 info->func[0] = PMBUS_HAVE_VIN | PMBUS_HAVE_VMON
461 | PMBUS_HAVE_PIN | PMBUS_HAVE_IIN | PMBUS_HAVE_STATUS_INPUT
462 | PMBUS_HAVE_TEMP | PMBUS_HAVE_STATUS_TEMP;
464 if (data->id == lm25056) {
465 info->func[0] |= PMBUS_HAVE_STATUS_VMON;
466 info->read_word_data = lm25056_read_word_data;
467 info->read_byte_data = lm25056_read_byte_data;
468 data->rlimit = 0x0fff;
469 } else if (data->id == lm25063) {
470 info->func[0] |= PMBUS_HAVE_VOUT | PMBUS_HAVE_STATUS_VOUT
472 info->read_word_data = lm25063_read_word_data;
473 data->rlimit = 0xffff;
475 info->func[0] |= PMBUS_HAVE_VOUT | PMBUS_HAVE_STATUS_VOUT;
476 info->read_word_data = lm25066_read_word_data;
477 data->rlimit = 0x0fff;
479 info->write_word_data = lm25066_write_word_data;
481 coeff = &lm25066_coeff[data->id][0];
482 info->m[PSC_TEMPERATURE] = coeff[PSC_TEMPERATURE].m;
483 info->b[PSC_TEMPERATURE] = coeff[PSC_TEMPERATURE].b;
484 info->R[PSC_TEMPERATURE] = coeff[PSC_TEMPERATURE].R;
485 info->m[PSC_VOLTAGE_IN] = coeff[PSC_VOLTAGE_IN].m;
486 info->b[PSC_VOLTAGE_IN] = coeff[PSC_VOLTAGE_IN].b;
487 info->R[PSC_VOLTAGE_IN] = coeff[PSC_VOLTAGE_IN].R;
488 info->m[PSC_VOLTAGE_OUT] = coeff[PSC_VOLTAGE_OUT].m;
489 info->b[PSC_VOLTAGE_OUT] = coeff[PSC_VOLTAGE_OUT].b;
490 info->R[PSC_VOLTAGE_OUT] = coeff[PSC_VOLTAGE_OUT].R;
491 info->b[PSC_CURRENT_IN] = coeff[PSC_CURRENT_IN].b;
492 info->R[PSC_CURRENT_IN] = coeff[PSC_CURRENT_IN].R;
493 info->b[PSC_POWER] = coeff[PSC_POWER].b;
494 info->R[PSC_POWER] = coeff[PSC_POWER].R;
495 if (config & LM25066_DEV_SETUP_CL) {
496 info->m[PSC_CURRENT_IN] = coeff[PSC_CURRENT_IN_L].m;
497 info->m[PSC_POWER] = coeff[PSC_POWER_L].m;
499 info->m[PSC_CURRENT_IN] = coeff[PSC_CURRENT_IN].m;
500 info->m[PSC_POWER] = coeff[PSC_POWER].m;
503 return pmbus_do_probe(client, id, info);
506 static const struct i2c_device_id lm25066_id[] = {
507 {"lm25056", lm25056},
508 {"lm25063", lm25063},
509 {"lm25066", lm25066},
515 MODULE_DEVICE_TABLE(i2c, lm25066_id);
517 /* This is the driver that will be inserted */
518 static struct i2c_driver lm25066_driver = {
522 .probe = lm25066_probe,
523 .remove = pmbus_do_remove,
524 .id_table = lm25066_id,
527 module_i2c_driver(lm25066_driver);
529 MODULE_AUTHOR("Guenter Roeck");
530 MODULE_DESCRIPTION("PMBus driver for LM25066 and compatible chips");
531 MODULE_LICENSE("GPL");