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] = {
80 [PSC_CURRENT_IN_L] = {
107 [PSC_VOLTAGE_OUT] = {
117 [PSC_CURRENT_IN_L] = {
132 [PSC_TEMPERATURE] = {
141 [PSC_VOLTAGE_OUT] = {
149 [PSC_CURRENT_IN_L] = {
161 [PSC_TEMPERATURE] = {
172 [PSC_VOLTAGE_OUT] = {
182 [PSC_CURRENT_IN_L] = {
197 [PSC_TEMPERATURE] = {
207 [PSC_VOLTAGE_OUT] = {
217 [PSC_CURRENT_IN_L] = {
232 [PSC_TEMPERATURE] = {
238 struct lm25066_data {
240 u16 rlimit; /* Maximum register value */
241 struct pmbus_driver_info info;
244 #define to_lm25066_data(x) container_of(x, struct lm25066_data, info)
246 static int lm25066_read_word_data(struct i2c_client *client, int page, int reg)
248 const struct pmbus_driver_info *info = pmbus_get_driver_info(client);
249 const struct lm25066_data *data = to_lm25066_data(info);
253 case PMBUS_VIRT_READ_VMON:
254 ret = pmbus_read_word_data(client, 0, LM25066_READ_VAUX);
257 /* Adjust returned value to match VIN coefficients */
260 /* VIN: 6.14 mV VAUX: 293 uV LSB */
261 ret = DIV_ROUND_CLOSEST(ret * 293, 6140);
264 /* VIN: 6.25 mV VAUX: 200.0 uV LSB */
265 ret = DIV_ROUND_CLOSEST(ret * 20, 625);
268 /* VIN: 4.54 mV VAUX: 283.2 uV LSB */
269 ret = DIV_ROUND_CLOSEST(ret * 2832, 45400);
272 /* VIN: 4.53 mV VAUX: 700 uV LSB */
273 ret = DIV_ROUND_CLOSEST(ret * 70, 453);
276 /* VIN: 2.18 mV VAUX: 725 uV LSB */
277 ret = DIV_ROUND_CLOSEST(ret * 725, 2180);
282 ret = pmbus_read_word_data(client, 0, LM25066_MFR_READ_IIN);
285 ret = pmbus_read_word_data(client, 0, LM25066_MFR_READ_PIN);
287 case PMBUS_IIN_OC_WARN_LIMIT:
288 ret = pmbus_read_word_data(client, 0,
289 LM25066_MFR_IIN_OC_WARN_LIMIT);
291 case PMBUS_PIN_OP_WARN_LIMIT:
292 ret = pmbus_read_word_data(client, 0,
293 LM25066_MFR_PIN_OP_WARN_LIMIT);
295 case PMBUS_VIRT_READ_VIN_AVG:
296 ret = pmbus_read_word_data(client, 0, LM25066_READ_AVG_VIN);
298 case PMBUS_VIRT_READ_VOUT_AVG:
299 ret = pmbus_read_word_data(client, 0, LM25066_READ_AVG_VOUT);
301 case PMBUS_VIRT_READ_IIN_AVG:
302 ret = pmbus_read_word_data(client, 0, LM25066_READ_AVG_IIN);
304 case PMBUS_VIRT_READ_PIN_AVG:
305 ret = pmbus_read_word_data(client, 0, LM25066_READ_AVG_PIN);
307 case PMBUS_VIRT_READ_PIN_MAX:
308 ret = pmbus_read_word_data(client, 0, LM25066_READ_PIN_PEAK);
310 case PMBUS_VIRT_RESET_PIN_HISTORY:
320 static int lm25063_read_word_data(struct i2c_client *client, int page, int reg)
325 case PMBUS_VIRT_READ_VOUT_MAX:
326 ret = pmbus_read_word_data(client, 0, LM25063_READ_VOUT_MAX);
328 case PMBUS_VIRT_READ_VOUT_MIN:
329 ret = pmbus_read_word_data(client, 0, LM25063_READ_VOUT_MIN);
332 ret = lm25066_read_word_data(client, page, reg);
338 static int lm25056_read_word_data(struct i2c_client *client, int page, int reg)
343 case PMBUS_VIRT_VMON_UV_WARN_LIMIT:
344 ret = pmbus_read_word_data(client, 0,
345 LM25056_VAUX_UV_WARN_LIMIT);
348 /* Adjust returned value to match VIN coefficients */
349 ret = DIV_ROUND_CLOSEST(ret * 293, 6140);
351 case PMBUS_VIRT_VMON_OV_WARN_LIMIT:
352 ret = pmbus_read_word_data(client, 0,
353 LM25056_VAUX_OV_WARN_LIMIT);
356 /* Adjust returned value to match VIN coefficients */
357 ret = DIV_ROUND_CLOSEST(ret * 293, 6140);
360 ret = lm25066_read_word_data(client, page, reg);
366 static int lm25056_read_byte_data(struct i2c_client *client, int page, int reg)
371 case PMBUS_VIRT_STATUS_VMON:
372 ret = pmbus_read_byte_data(client, 0,
373 PMBUS_STATUS_MFR_SPECIFIC);
377 if (ret & LM25056_MFR_STS_VAUX_UV_WARN)
378 s |= PB_VOLTAGE_UV_WARNING;
379 if (ret & LM25056_MFR_STS_VAUX_OV_WARN)
380 s |= PB_VOLTAGE_OV_WARNING;
390 static int lm25066_write_word_data(struct i2c_client *client, int page, int reg,
393 const struct pmbus_driver_info *info = pmbus_get_driver_info(client);
394 const struct lm25066_data *data = to_lm25066_data(info);
398 case PMBUS_POUT_OP_FAULT_LIMIT:
399 case PMBUS_POUT_OP_WARN_LIMIT:
400 case PMBUS_VOUT_UV_WARN_LIMIT:
401 case PMBUS_OT_FAULT_LIMIT:
402 case PMBUS_OT_WARN_LIMIT:
403 case PMBUS_IIN_OC_FAULT_LIMIT:
404 case PMBUS_VIN_UV_WARN_LIMIT:
405 case PMBUS_VIN_UV_FAULT_LIMIT:
406 case PMBUS_VIN_OV_FAULT_LIMIT:
407 case PMBUS_VIN_OV_WARN_LIMIT:
408 word = ((s16)word < 0) ? 0 : clamp_val(word, 0, data->rlimit);
409 ret = pmbus_write_word_data(client, 0, reg, word);
410 pmbus_clear_cache(client);
412 case PMBUS_IIN_OC_WARN_LIMIT:
413 word = ((s16)word < 0) ? 0 : clamp_val(word, 0, data->rlimit);
414 ret = pmbus_write_word_data(client, 0,
415 LM25066_MFR_IIN_OC_WARN_LIMIT,
417 pmbus_clear_cache(client);
419 case PMBUS_PIN_OP_WARN_LIMIT:
420 word = ((s16)word < 0) ? 0 : clamp_val(word, 0, data->rlimit);
421 ret = pmbus_write_word_data(client, 0,
422 LM25066_MFR_PIN_OP_WARN_LIMIT,
424 pmbus_clear_cache(client);
426 case PMBUS_VIRT_VMON_UV_WARN_LIMIT:
427 /* Adjust from VIN coefficients (for LM25056) */
428 word = DIV_ROUND_CLOSEST((int)word * 6140, 293);
429 word = ((s16)word < 0) ? 0 : clamp_val(word, 0, data->rlimit);
430 ret = pmbus_write_word_data(client, 0,
431 LM25056_VAUX_UV_WARN_LIMIT, word);
432 pmbus_clear_cache(client);
434 case PMBUS_VIRT_VMON_OV_WARN_LIMIT:
435 /* Adjust from VIN coefficients (for LM25056) */
436 word = DIV_ROUND_CLOSEST((int)word * 6140, 293);
437 word = ((s16)word < 0) ? 0 : clamp_val(word, 0, data->rlimit);
438 ret = pmbus_write_word_data(client, 0,
439 LM25056_VAUX_OV_WARN_LIMIT, word);
440 pmbus_clear_cache(client);
442 case PMBUS_VIRT_RESET_PIN_HISTORY:
443 ret = pmbus_write_byte(client, 0, LM25066_CLEAR_PIN_PEAK);
452 static int lm25066_probe(struct i2c_client *client,
453 const struct i2c_device_id *id)
456 struct lm25066_data *data;
457 struct pmbus_driver_info *info;
458 struct __coeff *coeff;
460 if (!i2c_check_functionality(client->adapter,
461 I2C_FUNC_SMBUS_READ_BYTE_DATA))
464 data = devm_kzalloc(&client->dev, sizeof(struct lm25066_data),
469 config = i2c_smbus_read_byte_data(client, LM25066_DEVICE_SETUP);
473 data->id = id->driver_data;
477 info->format[PSC_VOLTAGE_IN] = direct;
478 info->format[PSC_VOLTAGE_OUT] = direct;
479 info->format[PSC_CURRENT_IN] = direct;
480 info->format[PSC_TEMPERATURE] = direct;
481 info->format[PSC_POWER] = direct;
483 info->func[0] = PMBUS_HAVE_VIN | PMBUS_HAVE_VMON
484 | PMBUS_HAVE_PIN | PMBUS_HAVE_IIN | PMBUS_HAVE_STATUS_INPUT
485 | PMBUS_HAVE_TEMP | PMBUS_HAVE_STATUS_TEMP;
487 if (data->id == lm25056) {
488 info->func[0] |= PMBUS_HAVE_STATUS_VMON;
489 info->read_word_data = lm25056_read_word_data;
490 info->read_byte_data = lm25056_read_byte_data;
491 data->rlimit = 0x0fff;
492 } else if (data->id == lm25063) {
493 info->func[0] |= PMBUS_HAVE_VOUT | PMBUS_HAVE_STATUS_VOUT
495 info->read_word_data = lm25063_read_word_data;
496 data->rlimit = 0xffff;
498 info->func[0] |= PMBUS_HAVE_VOUT | PMBUS_HAVE_STATUS_VOUT;
499 info->read_word_data = lm25066_read_word_data;
500 data->rlimit = 0x0fff;
502 info->write_word_data = lm25066_write_word_data;
504 coeff = &lm25066_coeff[data->id][0];
505 info->m[PSC_TEMPERATURE] = coeff[PSC_TEMPERATURE].m;
506 info->b[PSC_TEMPERATURE] = coeff[PSC_TEMPERATURE].b;
507 info->R[PSC_TEMPERATURE] = coeff[PSC_TEMPERATURE].R;
508 info->m[PSC_VOLTAGE_IN] = coeff[PSC_VOLTAGE_IN].m;
509 info->b[PSC_VOLTAGE_IN] = coeff[PSC_VOLTAGE_IN].b;
510 info->R[PSC_VOLTAGE_IN] = coeff[PSC_VOLTAGE_IN].R;
511 info->m[PSC_VOLTAGE_OUT] = coeff[PSC_VOLTAGE_OUT].m;
512 info->b[PSC_VOLTAGE_OUT] = coeff[PSC_VOLTAGE_OUT].b;
513 info->R[PSC_VOLTAGE_OUT] = coeff[PSC_VOLTAGE_OUT].R;
514 info->b[PSC_CURRENT_IN] = coeff[PSC_CURRENT_IN].b;
515 info->R[PSC_CURRENT_IN] = coeff[PSC_CURRENT_IN].R;
516 info->b[PSC_POWER] = coeff[PSC_POWER].b;
517 info->R[PSC_POWER] = coeff[PSC_POWER].R;
518 if (config & LM25066_DEV_SETUP_CL) {
519 info->m[PSC_CURRENT_IN] = coeff[PSC_CURRENT_IN_L].m;
520 info->m[PSC_POWER] = coeff[PSC_POWER_L].m;
522 info->m[PSC_CURRENT_IN] = coeff[PSC_CURRENT_IN].m;
523 info->m[PSC_POWER] = coeff[PSC_POWER].m;
526 return pmbus_do_probe(client, id, info);
529 static const struct i2c_device_id lm25066_id[] = {
530 {"lm25056", lm25056},
531 {"lm25063", lm25063},
532 {"lm25066", lm25066},
538 MODULE_DEVICE_TABLE(i2c, lm25066_id);
540 /* This is the driver that will be inserted */
541 static struct i2c_driver lm25066_driver = {
545 .probe = lm25066_probe,
546 .remove = pmbus_do_remove,
547 .id_table = lm25066_id,
550 module_i2c_driver(lm25066_driver);
552 MODULE_AUTHOR("Guenter Roeck");
553 MODULE_DESCRIPTION("PMBus driver for LM25066 and compatible chips");
554 MODULE_LICENSE("GPL");