1 // SPDX-License-Identifier: GPL-2.0+
3 // Fuel gauge driver for Maxim 17042 / 8966 / 8997
4 // Note that Maxim 8966 and 8997 are mfd and this is its subdevice.
6 // Copyright (C) 2011 Samsung Electronics
7 // MyungJoo Ham <myungjoo.ham@samsung.com>
9 // This driver is based on max17040_battery.c
11 #include <linux/acpi.h>
12 #include <linux/init.h>
13 #include <linux/module.h>
14 #include <linux/slab.h>
15 #include <linux/i2c.h>
16 #include <linux/delay.h>
17 #include <linux/interrupt.h>
19 #include <linux/mod_devicetable.h>
20 #include <linux/power_supply.h>
21 #include <linux/power/max17042_battery.h>
23 #include <linux/regmap.h>
25 /* Status register bits */
26 #define STATUS_POR_BIT (1 << 1)
27 #define STATUS_BST_BIT (1 << 3)
28 #define STATUS_VMN_BIT (1 << 8)
29 #define STATUS_TMN_BIT (1 << 9)
30 #define STATUS_SMN_BIT (1 << 10)
31 #define STATUS_BI_BIT (1 << 11)
32 #define STATUS_VMX_BIT (1 << 12)
33 #define STATUS_TMX_BIT (1 << 13)
34 #define STATUS_SMX_BIT (1 << 14)
35 #define STATUS_BR_BIT (1 << 15)
37 /* Interrupt mask bits */
38 #define CONFIG_ALRT_BIT_ENBL (1 << 2)
40 #define VFSOC0_LOCK 0x0000
41 #define VFSOC0_UNLOCK 0x0080
42 #define MODEL_UNLOCK1 0X0059
43 #define MODEL_UNLOCK2 0X00C4
44 #define MODEL_LOCK1 0X0000
45 #define MODEL_LOCK2 0X0000
47 #define dQ_ACC_DIV 0x4
48 #define dP_ACC_100 0x1900
49 #define dP_ACC_200 0x3200
51 #define MAX17042_VMAX_TOLERANCE 50 /* 50 mV */
53 struct max17042_chip {
54 struct i2c_client *client;
55 struct regmap *regmap;
56 struct power_supply *battery;
57 enum max170xx_chip_type chip_type;
58 struct max17042_platform_data *pdata;
59 struct work_struct work;
63 static enum power_supply_property max17042_battery_props[] = {
64 POWER_SUPPLY_PROP_STATUS,
65 POWER_SUPPLY_PROP_PRESENT,
66 POWER_SUPPLY_PROP_TECHNOLOGY,
67 POWER_SUPPLY_PROP_CYCLE_COUNT,
68 POWER_SUPPLY_PROP_VOLTAGE_MAX,
69 POWER_SUPPLY_PROP_VOLTAGE_MIN,
70 POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
71 POWER_SUPPLY_PROP_VOLTAGE_NOW,
72 POWER_SUPPLY_PROP_VOLTAGE_AVG,
73 POWER_SUPPLY_PROP_VOLTAGE_OCV,
74 POWER_SUPPLY_PROP_CAPACITY,
75 POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN,
76 POWER_SUPPLY_PROP_CHARGE_FULL,
77 POWER_SUPPLY_PROP_CHARGE_NOW,
78 POWER_SUPPLY_PROP_CHARGE_COUNTER,
79 POWER_SUPPLY_PROP_CHARGE_TERM_CURRENT,
80 POWER_SUPPLY_PROP_TEMP,
81 POWER_SUPPLY_PROP_TEMP_ALERT_MIN,
82 POWER_SUPPLY_PROP_TEMP_ALERT_MAX,
83 POWER_SUPPLY_PROP_TEMP_MIN,
84 POWER_SUPPLY_PROP_TEMP_MAX,
85 POWER_SUPPLY_PROP_HEALTH,
86 POWER_SUPPLY_PROP_SCOPE,
87 POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW,
88 // these two have to be at the end on the list
89 POWER_SUPPLY_PROP_CURRENT_NOW,
90 POWER_SUPPLY_PROP_CURRENT_AVG,
93 static int max17042_get_temperature(struct max17042_chip *chip, int *temp)
97 struct regmap *map = chip->regmap;
99 ret = regmap_read(map, MAX17042_TEMP, &data);
103 *temp = sign_extend32(data, 15);
104 /* The value is converted into deci-centigrade scale */
105 /* Units of LSB = 1 / 256 degree Celsius */
106 *temp = *temp * 10 / 256;
110 static int max17042_get_status(struct max17042_chip *chip, int *status)
112 int ret, charge_full, charge_now;
116 ret = power_supply_am_i_supplied(chip->battery);
118 *status = POWER_SUPPLY_STATUS_UNKNOWN;
122 *status = POWER_SUPPLY_STATUS_DISCHARGING;
127 * The MAX170xx has builtin end-of-charge detection and will update
128 * FullCAP to match RepCap when it detects end of charging.
130 * When this cycle the battery gets charged to a higher (calculated)
131 * capacity then the previous cycle then FullCAP will get updated
132 * continuously once end-of-charge detection kicks in, so allow the
136 ret = regmap_read(chip->regmap, MAX17042_FullCAP, &charge_full);
140 ret = regmap_read(chip->regmap, MAX17042_RepCap, &charge_now);
144 if ((charge_full - charge_now) <= MAX17042_FULL_THRESHOLD) {
145 *status = POWER_SUPPLY_STATUS_FULL;
150 * Even though we are supplied, we may still be discharging if the
151 * supply is e.g. only delivering 5V 0.5A. Check current if available.
153 if (!chip->pdata->enable_current_sense) {
154 *status = POWER_SUPPLY_STATUS_CHARGING;
158 ret = regmap_read(chip->regmap, MAX17042_AvgCurrent, &data);
162 avg_current = sign_extend32(data, 15);
163 avg_current *= 1562500 / chip->pdata->r_sns;
166 *status = POWER_SUPPLY_STATUS_CHARGING;
168 *status = POWER_SUPPLY_STATUS_DISCHARGING;
173 static int max17042_get_battery_health(struct max17042_chip *chip, int *health)
175 int temp, vavg, vbatt, ret;
178 ret = regmap_read(chip->regmap, MAX17042_AvgVCELL, &val);
182 /* bits [0-3] unused */
183 vavg = val * 625 / 8;
184 /* Convert to millivolts */
187 ret = regmap_read(chip->regmap, MAX17042_VCELL, &val);
191 /* bits [0-3] unused */
192 vbatt = val * 625 / 8;
193 /* Convert to millivolts */
196 if (vavg < chip->pdata->vmin) {
197 *health = POWER_SUPPLY_HEALTH_DEAD;
201 if (vbatt > chip->pdata->vmax + MAX17042_VMAX_TOLERANCE) {
202 *health = POWER_SUPPLY_HEALTH_OVERVOLTAGE;
206 ret = max17042_get_temperature(chip, &temp);
210 if (temp < chip->pdata->temp_min) {
211 *health = POWER_SUPPLY_HEALTH_COLD;
215 if (temp > chip->pdata->temp_max) {
216 *health = POWER_SUPPLY_HEALTH_OVERHEAT;
220 *health = POWER_SUPPLY_HEALTH_GOOD;
229 static int max17042_get_property(struct power_supply *psy,
230 enum power_supply_property psp,
231 union power_supply_propval *val)
233 struct max17042_chip *chip = power_supply_get_drvdata(psy);
234 struct regmap *map = chip->regmap;
239 if (!chip->init_complete)
243 case POWER_SUPPLY_PROP_STATUS:
244 ret = max17042_get_status(chip, &val->intval);
248 case POWER_SUPPLY_PROP_PRESENT:
249 ret = regmap_read(map, MAX17042_STATUS, &data);
253 if (data & MAX17042_STATUS_BattAbsent)
258 case POWER_SUPPLY_PROP_TECHNOLOGY:
259 val->intval = POWER_SUPPLY_TECHNOLOGY_LION;
261 case POWER_SUPPLY_PROP_CYCLE_COUNT:
262 ret = regmap_read(map, MAX17042_Cycles, &data);
268 case POWER_SUPPLY_PROP_VOLTAGE_MAX:
269 ret = regmap_read(map, MAX17042_MinMaxVolt, &data);
273 val->intval = data >> 8;
274 val->intval *= 20000; /* Units of LSB = 20mV */
276 case POWER_SUPPLY_PROP_VOLTAGE_MIN:
277 ret = regmap_read(map, MAX17042_MinMaxVolt, &data);
281 val->intval = (data & 0xff) * 20000; /* Units of 20mV */
283 case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
284 if (chip->chip_type == MAXIM_DEVICE_TYPE_MAX17042)
285 ret = regmap_read(map, MAX17042_V_empty, &data);
287 ret = regmap_read(map, MAX17047_V_empty, &data);
291 val->intval = data >> 7;
292 val->intval *= 10000; /* Units of LSB = 10mV */
294 case POWER_SUPPLY_PROP_VOLTAGE_NOW:
295 ret = regmap_read(map, MAX17042_VCELL, &data);
299 val->intval = data * 625 / 8;
301 case POWER_SUPPLY_PROP_VOLTAGE_AVG:
302 ret = regmap_read(map, MAX17042_AvgVCELL, &data);
306 val->intval = data * 625 / 8;
308 case POWER_SUPPLY_PROP_VOLTAGE_OCV:
309 ret = regmap_read(map, MAX17042_OCVInternal, &data);
313 val->intval = data * 625 / 8;
315 case POWER_SUPPLY_PROP_CAPACITY:
316 if (chip->pdata->enable_current_sense)
317 ret = regmap_read(map, MAX17042_RepSOC, &data);
319 ret = regmap_read(map, MAX17042_VFSOC, &data);
323 val->intval = data >> 8;
325 case POWER_SUPPLY_PROP_CHARGE_FULL_DESIGN:
326 ret = regmap_read(map, MAX17042_DesignCap, &data);
330 data64 = data * 5000000ll;
331 do_div(data64, chip->pdata->r_sns);
332 val->intval = data64;
334 case POWER_SUPPLY_PROP_CHARGE_FULL:
335 ret = regmap_read(map, MAX17042_FullCAP, &data);
339 data64 = data * 5000000ll;
340 do_div(data64, chip->pdata->r_sns);
341 val->intval = data64;
343 case POWER_SUPPLY_PROP_CHARGE_NOW:
344 ret = regmap_read(map, MAX17042_RepCap, &data);
348 data64 = data * 5000000ll;
349 do_div(data64, chip->pdata->r_sns);
350 val->intval = data64;
352 case POWER_SUPPLY_PROP_CHARGE_COUNTER:
353 ret = regmap_read(map, MAX17042_QH, &data);
357 data64 = sign_extend64(data, 15) * 5000000ll;
358 val->intval = div_s64(data64, chip->pdata->r_sns);
360 case POWER_SUPPLY_PROP_TEMP:
361 ret = max17042_get_temperature(chip, &val->intval);
365 case POWER_SUPPLY_PROP_TEMP_ALERT_MIN:
366 ret = regmap_read(map, MAX17042_TALRT_Th, &data);
369 /* LSB is Alert Minimum. In deci-centigrade */
370 val->intval = sign_extend32(data & 0xff, 7) * 10;
372 case POWER_SUPPLY_PROP_TEMP_ALERT_MAX:
373 ret = regmap_read(map, MAX17042_TALRT_Th, &data);
376 /* MSB is Alert Maximum. In deci-centigrade */
377 val->intval = sign_extend32(data >> 8, 7) * 10;
379 case POWER_SUPPLY_PROP_TEMP_MIN:
380 val->intval = chip->pdata->temp_min;
382 case POWER_SUPPLY_PROP_TEMP_MAX:
383 val->intval = chip->pdata->temp_max;
385 case POWER_SUPPLY_PROP_HEALTH:
386 ret = max17042_get_battery_health(chip, &val->intval);
390 case POWER_SUPPLY_PROP_SCOPE:
391 val->intval = POWER_SUPPLY_SCOPE_SYSTEM;
393 case POWER_SUPPLY_PROP_CURRENT_NOW:
394 if (chip->pdata->enable_current_sense) {
395 ret = regmap_read(map, MAX17042_Current, &data);
399 data64 = sign_extend64(data, 15) * 1562500ll;
400 val->intval = div_s64(data64, chip->pdata->r_sns);
405 case POWER_SUPPLY_PROP_CURRENT_AVG:
406 if (chip->pdata->enable_current_sense) {
407 ret = regmap_read(map, MAX17042_AvgCurrent, &data);
411 data64 = sign_extend64(data, 15) * 1562500ll;
412 val->intval = div_s64(data64, chip->pdata->r_sns);
417 case POWER_SUPPLY_PROP_CHARGE_TERM_CURRENT:
418 ret = regmap_read(map, MAX17042_ICHGTerm, &data);
422 data64 = data * 1562500ll;
423 val->intval = div_s64(data64, chip->pdata->r_sns);
425 case POWER_SUPPLY_PROP_TIME_TO_EMPTY_NOW:
426 ret = regmap_read(map, MAX17042_TTE, &data);
430 val->intval = data * 5625 / 1000;
438 static int max17042_set_property(struct power_supply *psy,
439 enum power_supply_property psp,
440 const union power_supply_propval *val)
442 struct max17042_chip *chip = power_supply_get_drvdata(psy);
443 struct regmap *map = chip->regmap;
449 case POWER_SUPPLY_PROP_TEMP_ALERT_MIN:
450 ret = regmap_read(map, MAX17042_TALRT_Th, &data);
454 /* Input in deci-centigrade, convert to centigrade */
455 temp = val->intval / 10;
456 /* force min < max */
457 if (temp >= (int8_t)(data >> 8))
458 temp = (int8_t)(data >> 8) - 1;
459 /* Write both MAX and MIN ALERT */
460 data = (data & 0xff00) + temp;
461 ret = regmap_write(map, MAX17042_TALRT_Th, data);
463 case POWER_SUPPLY_PROP_TEMP_ALERT_MAX:
464 ret = regmap_read(map, MAX17042_TALRT_Th, &data);
468 /* Input in Deci-Centigrade, convert to centigrade */
469 temp = val->intval / 10;
470 /* force max > min */
471 if (temp <= (int8_t)(data & 0xff))
472 temp = (int8_t)(data & 0xff) + 1;
473 /* Write both MAX and MIN ALERT */
474 data = (data & 0xff) + (temp << 8);
475 ret = regmap_write(map, MAX17042_TALRT_Th, data);
484 static int max17042_property_is_writeable(struct power_supply *psy,
485 enum power_supply_property psp)
490 case POWER_SUPPLY_PROP_TEMP_ALERT_MIN:
491 case POWER_SUPPLY_PROP_TEMP_ALERT_MAX:
501 static void max17042_external_power_changed(struct power_supply *psy)
503 power_supply_changed(psy);
506 static int max17042_write_verify_reg(struct regmap *map, u8 reg, u32 value)
513 ret = regmap_write(map, reg, value);
514 regmap_read(map, reg, &read_value);
515 if (read_value != value) {
519 } while (retries && read_value != value);
522 pr_err("%s: err %d\n", __func__, ret);
527 static inline void max17042_override_por(struct regmap *map,
531 regmap_write(map, reg, value);
534 static inline void max17042_unlock_model(struct max17042_chip *chip)
536 struct regmap *map = chip->regmap;
538 regmap_write(map, MAX17042_MLOCKReg1, MODEL_UNLOCK1);
539 regmap_write(map, MAX17042_MLOCKReg2, MODEL_UNLOCK2);
542 static inline void max17042_lock_model(struct max17042_chip *chip)
544 struct regmap *map = chip->regmap;
546 regmap_write(map, MAX17042_MLOCKReg1, MODEL_LOCK1);
547 regmap_write(map, MAX17042_MLOCKReg2, MODEL_LOCK2);
550 static inline void max17042_write_model_data(struct max17042_chip *chip,
553 struct regmap *map = chip->regmap;
556 for (i = 0; i < size; i++)
557 regmap_write(map, addr + i,
558 chip->pdata->config_data->cell_char_tbl[i]);
561 static inline void max17042_read_model_data(struct max17042_chip *chip,
562 u8 addr, u16 *data, int size)
564 struct regmap *map = chip->regmap;
568 for (i = 0; i < size; i++) {
569 regmap_read(map, addr + i, &tmp);
574 static inline int max17042_model_data_compare(struct max17042_chip *chip,
575 u16 *data1, u16 *data2, int size)
579 if (memcmp(data1, data2, size)) {
580 dev_err(&chip->client->dev, "%s compare failed\n", __func__);
581 for (i = 0; i < size; i++)
582 dev_info(&chip->client->dev, "0x%x, 0x%x",
584 dev_info(&chip->client->dev, "\n");
590 static int max17042_init_model(struct max17042_chip *chip)
593 int table_size = ARRAY_SIZE(chip->pdata->config_data->cell_char_tbl);
596 temp_data = kcalloc(table_size, sizeof(*temp_data), GFP_KERNEL);
600 max17042_unlock_model(chip);
601 max17042_write_model_data(chip, MAX17042_MODELChrTbl,
603 max17042_read_model_data(chip, MAX17042_MODELChrTbl, temp_data,
606 ret = max17042_model_data_compare(
608 chip->pdata->config_data->cell_char_tbl,
612 max17042_lock_model(chip);
618 static int max17042_verify_model_lock(struct max17042_chip *chip)
621 int table_size = ARRAY_SIZE(chip->pdata->config_data->cell_char_tbl);
625 temp_data = kcalloc(table_size, sizeof(*temp_data), GFP_KERNEL);
629 max17042_read_model_data(chip, MAX17042_MODELChrTbl, temp_data,
631 for (i = 0; i < table_size; i++)
639 static void max17042_write_config_regs(struct max17042_chip *chip)
641 struct max17042_config_data *config = chip->pdata->config_data;
642 struct regmap *map = chip->regmap;
644 regmap_write(map, MAX17042_CONFIG, config->config);
645 regmap_write(map, MAX17042_LearnCFG, config->learn_cfg);
646 regmap_write(map, MAX17042_FilterCFG,
648 regmap_write(map, MAX17042_RelaxCFG, config->relax_cfg);
649 if (chip->chip_type == MAXIM_DEVICE_TYPE_MAX17047 ||
650 chip->chip_type == MAXIM_DEVICE_TYPE_MAX17050 ||
651 chip->chip_type == MAXIM_DEVICE_TYPE_MAX17055)
652 regmap_write(map, MAX17047_FullSOCThr,
653 config->full_soc_thresh);
656 static void max17042_write_custom_regs(struct max17042_chip *chip)
658 struct max17042_config_data *config = chip->pdata->config_data;
659 struct regmap *map = chip->regmap;
661 max17042_write_verify_reg(map, MAX17042_RCOMP0, config->rcomp0);
662 max17042_write_verify_reg(map, MAX17042_TempCo, config->tcompc0);
663 max17042_write_verify_reg(map, MAX17042_ICHGTerm, config->ichgt_term);
664 if (chip->chip_type == MAXIM_DEVICE_TYPE_MAX17042) {
665 regmap_write(map, MAX17042_EmptyTempCo, config->empty_tempco);
666 max17042_write_verify_reg(map, MAX17042_K_empty0,
669 max17042_write_verify_reg(map, MAX17047_QRTbl00,
671 max17042_write_verify_reg(map, MAX17047_QRTbl10,
673 max17042_write_verify_reg(map, MAX17047_QRTbl20,
675 max17042_write_verify_reg(map, MAX17047_QRTbl30,
680 static void max17042_update_capacity_regs(struct max17042_chip *chip)
682 struct max17042_config_data *config = chip->pdata->config_data;
683 struct regmap *map = chip->regmap;
685 max17042_write_verify_reg(map, MAX17042_FullCAP,
687 regmap_write(map, MAX17042_DesignCap, config->design_cap);
688 max17042_write_verify_reg(map, MAX17042_FullCAPNom,
692 static void max17042_reset_vfsoc0_reg(struct max17042_chip *chip)
695 struct regmap *map = chip->regmap;
697 regmap_read(map, MAX17042_VFSOC, &vfSoc);
698 regmap_write(map, MAX17042_VFSOC0Enable, VFSOC0_UNLOCK);
699 max17042_write_verify_reg(map, MAX17042_VFSOC0, vfSoc);
700 regmap_write(map, MAX17042_VFSOC0Enable, VFSOC0_LOCK);
703 static void max17042_load_new_capacity_params(struct max17042_chip *chip)
705 u32 full_cap0, rep_cap, dq_acc, vfSoc;
708 struct max17042_config_data *config = chip->pdata->config_data;
709 struct regmap *map = chip->regmap;
711 regmap_read(map, MAX17042_FullCAP0, &full_cap0);
712 regmap_read(map, MAX17042_VFSOC, &vfSoc);
714 /* fg_vfSoc needs to shifted by 8 bits to get the
715 * perc in 1% accuracy, to get the right rem_cap multiply
716 * full_cap0, fg_vfSoc and devide by 100
718 rem_cap = ((vfSoc >> 8) * full_cap0) / 100;
719 max17042_write_verify_reg(map, MAX17042_RemCap, rem_cap);
722 max17042_write_verify_reg(map, MAX17042_RepCap, rep_cap);
724 /* Write dQ_acc to 200% of Capacity and dP_acc to 200% */
725 dq_acc = config->fullcap / dQ_ACC_DIV;
726 max17042_write_verify_reg(map, MAX17042_dQacc, dq_acc);
727 max17042_write_verify_reg(map, MAX17042_dPacc, dP_ACC_200);
729 max17042_write_verify_reg(map, MAX17042_FullCAP,
731 regmap_write(map, MAX17042_DesignCap,
733 max17042_write_verify_reg(map, MAX17042_FullCAPNom,
735 /* Update SOC register with new SOC */
736 regmap_write(map, MAX17042_RepSOC, vfSoc);
740 * Block write all the override values coming from platform data.
741 * This function MUST be called before the POR initialization procedure
742 * specified by maxim.
744 static inline void max17042_override_por_values(struct max17042_chip *chip)
746 struct regmap *map = chip->regmap;
747 struct max17042_config_data *config = chip->pdata->config_data;
749 max17042_override_por(map, MAX17042_TGAIN, config->tgain);
750 max17042_override_por(map, MAX17042_TOFF, config->toff);
751 max17042_override_por(map, MAX17042_CGAIN, config->cgain);
752 max17042_override_por(map, MAX17042_COFF, config->coff);
754 max17042_override_por(map, MAX17042_VALRT_Th, config->valrt_thresh);
755 max17042_override_por(map, MAX17042_TALRT_Th, config->talrt_thresh);
756 max17042_override_por(map, MAX17042_SALRT_Th,
757 config->soc_alrt_thresh);
758 max17042_override_por(map, MAX17042_CONFIG, config->config);
759 max17042_override_por(map, MAX17042_SHDNTIMER, config->shdntimer);
761 max17042_override_por(map, MAX17042_DesignCap, config->design_cap);
762 max17042_override_por(map, MAX17042_ICHGTerm, config->ichgt_term);
764 max17042_override_por(map, MAX17042_AtRate, config->at_rate);
765 max17042_override_por(map, MAX17042_LearnCFG, config->learn_cfg);
766 max17042_override_por(map, MAX17042_FilterCFG, config->filter_cfg);
767 max17042_override_por(map, MAX17042_RelaxCFG, config->relax_cfg);
768 max17042_override_por(map, MAX17042_MiscCFG, config->misc_cfg);
770 max17042_override_por(map, MAX17042_FullCAP, config->fullcap);
771 max17042_override_por(map, MAX17042_FullCAPNom, config->fullcapnom);
772 max17042_override_por(map, MAX17042_dQacc, config->dqacc);
773 max17042_override_por(map, MAX17042_dPacc, config->dpacc);
775 max17042_override_por(map, MAX17042_RCOMP0, config->rcomp0);
776 max17042_override_por(map, MAX17042_TempCo, config->tcompc0);
778 if (chip->chip_type == MAXIM_DEVICE_TYPE_MAX17042) {
779 max17042_override_por(map, MAX17042_MaskSOC, config->masksoc);
780 max17042_override_por(map, MAX17042_SOC_empty, config->socempty);
781 max17042_override_por(map, MAX17042_V_empty, config->vempty);
782 max17042_override_por(map, MAX17042_EmptyTempCo, config->empty_tempco);
783 max17042_override_por(map, MAX17042_K_empty0, config->kempty0);
786 if ((chip->chip_type == MAXIM_DEVICE_TYPE_MAX17042) ||
787 (chip->chip_type == MAXIM_DEVICE_TYPE_MAX17047) ||
788 (chip->chip_type == MAXIM_DEVICE_TYPE_MAX17050)) {
789 max17042_override_por(map, MAX17042_IAvg_empty, config->iavg_empty);
790 max17042_override_por(map, MAX17042_TempNom, config->temp_nom);
791 max17042_override_por(map, MAX17042_TempLim, config->temp_lim);
792 max17042_override_por(map, MAX17042_FCTC, config->fctc);
795 if ((chip->chip_type == MAXIM_DEVICE_TYPE_MAX17047) ||
796 (chip->chip_type == MAXIM_DEVICE_TYPE_MAX17050) ||
797 (chip->chip_type == MAXIM_DEVICE_TYPE_MAX17055)) {
798 max17042_override_por(map, MAX17047_V_empty, config->vempty);
802 static int max17042_init_chip(struct max17042_chip *chip)
804 struct regmap *map = chip->regmap;
807 max17042_override_por_values(chip);
808 /* After Power up, the MAX17042 requires 500mS in order
809 * to perform signal debouncing and initial SOC reporting
813 /* Initialize configuration */
814 max17042_write_config_regs(chip);
816 /* write cell characterization data */
817 ret = max17042_init_model(chip);
819 dev_err(&chip->client->dev, "%s init failed\n",
824 ret = max17042_verify_model_lock(chip);
826 dev_err(&chip->client->dev, "%s lock verify failed\n",
830 /* write custom parameters */
831 max17042_write_custom_regs(chip);
833 /* update capacity params */
834 max17042_update_capacity_regs(chip);
836 /* delay must be atleast 350mS to allow VFSOC
837 * to be calculated from the new configuration
841 /* reset vfsoc0 reg */
842 max17042_reset_vfsoc0_reg(chip);
844 /* load new capacity params */
845 max17042_load_new_capacity_params(chip);
847 /* Init complete, Clear the POR bit */
848 regmap_update_bits(map, MAX17042_STATUS, STATUS_POR_BIT, 0x0);
852 static void max17042_set_soc_threshold(struct max17042_chip *chip, u16 off)
854 struct regmap *map = chip->regmap;
857 /* program interrupt thresholds such that we should
858 * get interrupt for every 'off' perc change in the soc
860 regmap_read(map, MAX17042_RepSOC, &soc);
862 soc_tr = (soc + off) << 8;
865 regmap_write(map, MAX17042_SALRT_Th, soc_tr);
868 static irqreturn_t max17042_thread_handler(int id, void *dev)
870 struct max17042_chip *chip = dev;
874 ret = regmap_read(chip->regmap, MAX17042_STATUS, &val);
878 if ((val & STATUS_SMN_BIT) || (val & STATUS_SMX_BIT)) {
879 dev_dbg(&chip->client->dev, "SOC threshold INTR\n");
880 max17042_set_soc_threshold(chip, 1);
883 /* we implicitly handle all alerts via power_supply_changed */
884 regmap_clear_bits(chip->regmap, MAX17042_STATUS,
885 0xFFFF & ~(STATUS_POR_BIT | STATUS_BST_BIT));
887 power_supply_changed(chip->battery);
891 static void max17042_init_worker(struct work_struct *work)
893 struct max17042_chip *chip = container_of(work,
894 struct max17042_chip, work);
897 /* Initialize registers according to values from the platform data */
898 if (chip->pdata->enable_por_init && chip->pdata->config_data) {
899 ret = max17042_init_chip(chip);
904 chip->init_complete = 1;
908 static struct max17042_platform_data *
909 max17042_get_of_pdata(struct max17042_chip *chip)
911 struct device *dev = &chip->client->dev;
912 struct device_node *np = dev->of_node;
914 struct max17042_platform_data *pdata;
916 pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
921 * Require current sense resistor value to be specified for
922 * current-sense functionality to be enabled at all.
924 if (of_property_read_u32(np, "maxim,rsns-microohm", &prop) == 0) {
926 pdata->enable_current_sense = true;
929 if (of_property_read_s32(np, "maxim,cold-temp", &pdata->temp_min))
930 pdata->temp_min = INT_MIN;
931 if (of_property_read_s32(np, "maxim,over-heat-temp", &pdata->temp_max))
932 pdata->temp_max = INT_MAX;
933 if (of_property_read_s32(np, "maxim,dead-volt", &pdata->vmin))
934 pdata->vmin = INT_MIN;
935 if (of_property_read_s32(np, "maxim,over-volt", &pdata->vmax))
936 pdata->vmax = INT_MAX;
942 static struct max17042_reg_data max17047_default_pdata_init_regs[] = {
944 * Some firmwares do not set FullSOCThr, Enable End-of-Charge Detection
945 * when the voltage FG reports 95%, as recommended in the datasheet.
947 { MAX17047_FullSOCThr, MAX17042_BATTERY_FULL << 8 },
950 static struct max17042_platform_data *
951 max17042_get_default_pdata(struct max17042_chip *chip)
953 struct device *dev = &chip->client->dev;
954 struct max17042_platform_data *pdata;
958 * The MAX17047 gets used on x86 where we might not have pdata, assume
959 * the firmware will already have initialized the fuel-gauge and provide
960 * default values for the non init bits to make things work.
962 pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
966 if ((chip->chip_type == MAXIM_DEVICE_TYPE_MAX17047) ||
967 (chip->chip_type == MAXIM_DEVICE_TYPE_MAX17050)) {
968 pdata->init_data = max17047_default_pdata_init_regs;
969 pdata->num_init_data =
970 ARRAY_SIZE(max17047_default_pdata_init_regs);
973 ret = regmap_read(chip->regmap, MAX17042_MiscCFG, &misc_cfg);
977 /* If bits 0-1 are set to 3 then only Voltage readings are used */
978 if ((misc_cfg & 0x3) == 0x3)
979 pdata->enable_current_sense = false;
981 pdata->enable_current_sense = true;
983 pdata->vmin = MAX17042_DEFAULT_VMIN;
984 pdata->vmax = MAX17042_DEFAULT_VMAX;
985 pdata->temp_min = MAX17042_DEFAULT_TEMP_MIN;
986 pdata->temp_max = MAX17042_DEFAULT_TEMP_MAX;
991 static struct max17042_platform_data *
992 max17042_get_pdata(struct max17042_chip *chip)
994 struct device *dev = &chip->client->dev;
998 return max17042_get_of_pdata(chip);
1000 if (dev->platform_data)
1001 return dev->platform_data;
1003 return max17042_get_default_pdata(chip);
1006 static const struct regmap_config max17042_regmap_config = {
1009 .val_format_endian = REGMAP_ENDIAN_NATIVE,
1012 static const struct power_supply_desc max17042_psy_desc = {
1013 .name = "max170xx_battery",
1014 .type = POWER_SUPPLY_TYPE_BATTERY,
1015 .get_property = max17042_get_property,
1016 .set_property = max17042_set_property,
1017 .property_is_writeable = max17042_property_is_writeable,
1018 .external_power_changed = max17042_external_power_changed,
1019 .properties = max17042_battery_props,
1020 .num_properties = ARRAY_SIZE(max17042_battery_props),
1023 static const struct power_supply_desc max17042_no_current_sense_psy_desc = {
1024 .name = "max170xx_battery",
1025 .type = POWER_SUPPLY_TYPE_BATTERY,
1026 .get_property = max17042_get_property,
1027 .set_property = max17042_set_property,
1028 .property_is_writeable = max17042_property_is_writeable,
1029 .properties = max17042_battery_props,
1030 .num_properties = ARRAY_SIZE(max17042_battery_props) - 2,
1033 static void max17042_stop_work(void *data)
1035 struct max17042_chip *chip = data;
1037 cancel_work_sync(&chip->work);
1040 static int max17042_probe(struct i2c_client *client,
1041 const struct i2c_device_id *id)
1043 struct i2c_adapter *adapter = client->adapter;
1044 const struct power_supply_desc *max17042_desc = &max17042_psy_desc;
1045 struct power_supply_config psy_cfg = {};
1046 const struct acpi_device_id *acpi_id = NULL;
1047 struct device *dev = &client->dev;
1048 struct max17042_chip *chip;
1053 if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_WORD_DATA))
1056 chip = devm_kzalloc(&client->dev, sizeof(*chip), GFP_KERNEL);
1060 chip->client = client;
1062 chip->chip_type = id->driver_data;
1064 acpi_id = acpi_match_device(dev->driver->acpi_match_table, dev);
1068 chip->chip_type = acpi_id->driver_data;
1070 chip->regmap = devm_regmap_init_i2c(client, &max17042_regmap_config);
1071 if (IS_ERR(chip->regmap)) {
1072 dev_err(&client->dev, "Failed to initialize regmap\n");
1076 chip->pdata = max17042_get_pdata(chip);
1078 dev_err(&client->dev, "no platform data provided\n");
1082 i2c_set_clientdata(client, chip);
1083 psy_cfg.drv_data = chip;
1084 psy_cfg.of_node = dev->of_node;
1086 /* When current is not measured,
1087 * CURRENT_NOW and CURRENT_AVG properties should be invisible. */
1088 if (!chip->pdata->enable_current_sense)
1089 max17042_desc = &max17042_no_current_sense_psy_desc;
1091 if (chip->pdata->r_sns == 0)
1092 chip->pdata->r_sns = MAX17042_DEFAULT_SNS_RESISTOR;
1094 if (chip->pdata->init_data)
1095 for (i = 0; i < chip->pdata->num_init_data; i++)
1096 regmap_write(chip->regmap,
1097 chip->pdata->init_data[i].addr,
1098 chip->pdata->init_data[i].data);
1100 if (!chip->pdata->enable_current_sense) {
1101 regmap_write(chip->regmap, MAX17042_CGAIN, 0x0000);
1102 regmap_write(chip->regmap, MAX17042_MiscCFG, 0x0003);
1103 regmap_write(chip->regmap, MAX17042_LearnCFG, 0x0007);
1106 chip->battery = devm_power_supply_register(&client->dev, max17042_desc,
1108 if (IS_ERR(chip->battery)) {
1109 dev_err(&client->dev, "failed: power supply register\n");
1110 return PTR_ERR(chip->battery);
1114 unsigned int flags = IRQF_ONESHOT;
1117 * On ACPI systems the IRQ may be handled by ACPI-event code,
1118 * so we need to share (if the ACPI code is willing to share).
1121 flags |= IRQF_SHARED | IRQF_PROBE_SHARED;
1123 ret = devm_request_threaded_irq(&client->dev, client->irq,
1125 max17042_thread_handler, flags,
1126 chip->battery->desc->name,
1129 regmap_update_bits(chip->regmap, MAX17042_CONFIG,
1130 CONFIG_ALRT_BIT_ENBL,
1131 CONFIG_ALRT_BIT_ENBL);
1132 max17042_set_soc_threshold(chip, 1);
1136 dev_err(&client->dev, "Failed to get IRQ\n");
1139 /* Not able to update the charge threshold when exceeded? -> disable */
1141 regmap_write(chip->regmap, MAX17042_SALRT_Th, 0xff00);
1143 regmap_read(chip->regmap, MAX17042_STATUS, &val);
1144 if (val & STATUS_POR_BIT) {
1145 INIT_WORK(&chip->work, max17042_init_worker);
1146 ret = devm_add_action(&client->dev, max17042_stop_work, chip);
1149 schedule_work(&chip->work);
1151 chip->init_complete = 1;
1157 #ifdef CONFIG_PM_SLEEP
1158 static int max17042_suspend(struct device *dev)
1160 struct max17042_chip *chip = dev_get_drvdata(dev);
1163 * disable the irq and enable irq_wake
1164 * capability to the interrupt line.
1166 if (chip->client->irq) {
1167 disable_irq(chip->client->irq);
1168 enable_irq_wake(chip->client->irq);
1174 static int max17042_resume(struct device *dev)
1176 struct max17042_chip *chip = dev_get_drvdata(dev);
1178 if (chip->client->irq) {
1179 disable_irq_wake(chip->client->irq);
1180 enable_irq(chip->client->irq);
1181 /* re-program the SOC thresholds to 1% change */
1182 max17042_set_soc_threshold(chip, 1);
1189 static SIMPLE_DEV_PM_OPS(max17042_pm_ops, max17042_suspend,
1193 static const struct acpi_device_id max17042_acpi_match[] = {
1194 { "MAX17047", MAXIM_DEVICE_TYPE_MAX17047 },
1197 MODULE_DEVICE_TABLE(acpi, max17042_acpi_match);
1201 static const struct of_device_id max17042_dt_match[] = {
1202 { .compatible = "maxim,max17042" },
1203 { .compatible = "maxim,max17047" },
1204 { .compatible = "maxim,max17050" },
1205 { .compatible = "maxim,max17055" },
1206 { .compatible = "maxim,max77849-battery" },
1209 MODULE_DEVICE_TABLE(of, max17042_dt_match);
1212 static const struct i2c_device_id max17042_id[] = {
1213 { "max17042", MAXIM_DEVICE_TYPE_MAX17042 },
1214 { "max17047", MAXIM_DEVICE_TYPE_MAX17047 },
1215 { "max17050", MAXIM_DEVICE_TYPE_MAX17050 },
1216 { "max17055", MAXIM_DEVICE_TYPE_MAX17055 },
1217 { "max77849-battery", MAXIM_DEVICE_TYPE_MAX17047 },
1220 MODULE_DEVICE_TABLE(i2c, max17042_id);
1222 static struct i2c_driver max17042_i2c_driver = {
1225 .acpi_match_table = ACPI_PTR(max17042_acpi_match),
1226 .of_match_table = of_match_ptr(max17042_dt_match),
1227 .pm = &max17042_pm_ops,
1229 .probe = max17042_probe,
1230 .id_table = max17042_id,
1232 module_i2c_driver(max17042_i2c_driver);
1234 MODULE_AUTHOR("MyungJoo Ham <myungjoo.ham@samsung.com>");
1235 MODULE_DESCRIPTION("MAX17042 Fuel Gauge");
1236 MODULE_LICENSE("GPL");