drivers/power/max17042_battery.c

   1 /*
   2  * Fuel gauge driver for Maxim 17042 / 8966 / 8997
   3  *  Note that Maxim 8966 and 8997 are mfd and this is its subdevice.
   4  *
   5  * Copyright (C) 2011 Samsung Electronics
   6  * MyungJoo Ham <myungjoo.ham@samsung.com>
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  *
  22  * This driver is based on max17040_battery.c
  23  */
  24
  25 #include <linux/init.h>
  26 #include <linux/module.h>
  27 #include <linux/slab.h>
  28 #include <linux/i2c.h>
  29 #include <linux/delay.h>
  30 #include <linux/interrupt.h>
  31 #include <linux/pm.h>
  32 #include <linux/mod_devicetable.h>
  33 #include <linux/power_supply.h>
  34 #include <linux/power/max17042_battery.h>
  35 #include <linux/of.h>
  36 #include <linux/regmap.h>
  37
  38 /* Status register bits */
  39 #define STATUS_POR_BIT         (1 << 1)
  40 #define STATUS_BST_BIT         (1 << 3)
  41 #define STATUS_VMN_BIT         (1 << 8)
  42 #define STATUS_TMN_BIT         (1 << 9)
  43 #define STATUS_SMN_BIT         (1 << 10)
  44 #define STATUS_BI_BIT          (1 << 11)
  45 #define STATUS_VMX_BIT         (1 << 12)
  46 #define STATUS_TMX_BIT         (1 << 13)
  47 #define STATUS_SMX_BIT         (1 << 14)
  48 #define STATUS_BR_BIT          (1 << 15)
  49
  50 /* Interrupt mask bits */
  51 #define CONFIG_ALRT_BIT_ENBL    (1 << 2)
  52 #define STATUS_INTR_SOCMIN_BIT  (1 << 10)
  53 #define STATUS_INTR_SOCMAX_BIT  (1 << 14)
  54
  55 #define VFSOC0_LOCK             0x0000
  56 #define VFSOC0_UNLOCK           0x0080
  57 #define MODEL_UNLOCK1   0X0059
  58 #define MODEL_UNLOCK2   0X00C4
  59 #define MODEL_LOCK1             0X0000
  60 #define MODEL_LOCK2             0X0000
  61
  62 #define dQ_ACC_DIV      0x4
  63 #define dP_ACC_100      0x1900
  64 #define dP_ACC_200      0x3200
  65
  66 #define MAX17042_IC_VERSION     0x0092
  67 #define MAX17047_IC_VERSION     0x00AC  /* same for max17050 */
  68
  69 struct max17042_chip {
  70         struct i2c_client *client;
  71         struct regmap *regmap;
  72         struct power_supply *battery;
  73         enum max170xx_chip_type chip_type;
  74         struct max17042_platform_data *pdata;
  75         struct work_struct work;
  76         int    init_complete;
  77 };
  78
  79 static enum power_supply_property max17042_battery_props[] = {
  80         POWER_SUPPLY_PROP_PRESENT,
  81         POWER_SUPPLY_PROP_CYCLE_COUNT,
  82         POWER_SUPPLY_PROP_VOLTAGE_MAX,
  83         POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN,
  84         POWER_SUPPLY_PROP_VOLTAGE_NOW,
  85         POWER_SUPPLY_PROP_VOLTAGE_AVG,
  86         POWER_SUPPLY_PROP_VOLTAGE_OCV,
  87         POWER_SUPPLY_PROP_CAPACITY,
  88         POWER_SUPPLY_PROP_CHARGE_FULL,
  89         POWER_SUPPLY_PROP_CHARGE_COUNTER,
  90         POWER_SUPPLY_PROP_TEMP,
  91         POWER_SUPPLY_PROP_CURRENT_NOW,
  92         POWER_SUPPLY_PROP_CURRENT_AVG,
  93 };
  94
  95 static int max17042_get_property(struct power_supply *psy,
  96                             enum power_supply_property psp,
  97                             union power_supply_propval *val)
  98 {
  99         struct max17042_chip *chip = power_supply_get_drvdata(psy);
 100         struct regmap *map = chip->regmap;
 101         int ret;
 102         u32 data;
 103
 104         if (!chip->init_complete)
 105                 return -EAGAIN;
 106
 107         switch (psp) {
 108         case POWER_SUPPLY_PROP_PRESENT:
 109                 ret = regmap_read(map, MAX17042_STATUS, &data);
 110                 if (ret < 0)
 111                         return ret;
 112
 113                 if (data & MAX17042_STATUS_BattAbsent)
 114                         val->intval = 0;
 115                 else
 116                         val->intval = 1;
 117                 break;
 118         case POWER_SUPPLY_PROP_CYCLE_COUNT:
 119                 ret = regmap_read(map, MAX17042_Cycles, &data);
 120                 if (ret < 0)
 121                         return ret;
 122
 123                 val->intval = data;
 124                 break;
 125         case POWER_SUPPLY_PROP_VOLTAGE_MAX:
 126                 ret = regmap_read(map, MAX17042_MinMaxVolt, &data);
 127                 if (ret < 0)
 128                         return ret;
 129
 130                 val->intval = data >> 8;
 131                 val->intval *= 20000; /* Units of LSB = 20mV */
 132                 break;
 133         case POWER_SUPPLY_PROP_VOLTAGE_MIN_DESIGN:
 134                 if (chip->chip_type == MAX17042)
 135                         ret = regmap_read(map, MAX17042_V_empty, &data);
 136                 else
 137                         ret = regmap_read(map, MAX17047_V_empty, &data);
 138                 if (ret < 0)
 139                         return ret;
 140
 141                 val->intval = data >> 7;
 142                 val->intval *= 10000; /* Units of LSB = 10mV */
 143                 break;
 144         case POWER_SUPPLY_PROP_VOLTAGE_NOW:
 145                 ret = regmap_read(map, MAX17042_VCELL, &data);
 146                 if (ret < 0)
 147                         return ret;
 148
 149                 val->intval = data * 625 / 8;
 150                 break;
 151         case POWER_SUPPLY_PROP_VOLTAGE_AVG:
 152                 ret = regmap_read(map, MAX17042_AvgVCELL, &data);
 153                 if (ret < 0)
 154                         return ret;
 155
 156                 val->intval = data * 625 / 8;
 157                 break;
 158         case POWER_SUPPLY_PROP_VOLTAGE_OCV:
 159                 ret = regmap_read(map, MAX17042_OCVInternal, &data);
 160                 if (ret < 0)
 161                         return ret;
 162
 163                 val->intval = data * 625 / 8;
 164                 break;
 165         case POWER_SUPPLY_PROP_CAPACITY:
 166                 ret = regmap_read(map, MAX17042_RepSOC, &data);
 167                 if (ret < 0)
 168                         return ret;
 169
 170                 val->intval = data >> 8;
 171                 break;
 172         case POWER_SUPPLY_PROP_CHARGE_FULL:
 173                 ret = regmap_read(map, MAX17042_FullCAP, &data);
 174                 if (ret < 0)
 175                         return ret;
 176
 177                 val->intval = data * 1000 / 2;
 178                 break;
 179         case POWER_SUPPLY_PROP_CHARGE_COUNTER:
 180                 ret = regmap_read(map, MAX17042_QH, &data);
 181                 if (ret < 0)
 182                         return ret;
 183
 184                 val->intval = data * 1000 / 2;
 185                 break;
 186         case POWER_SUPPLY_PROP_TEMP:
 187                 ret = regmap_read(map, MAX17042_TEMP, &data);
 188                 if (ret < 0)
 189                         return ret;
 190
 191                 val->intval = data;
 192                 /* The value is signed. */
 193                 if (val->intval & 0x8000) {
 194                         val->intval = (0x7fff & ~val->intval) + 1;
 195                         val->intval *= -1;
 196                 }
 197                 /* The value is converted into deci-centigrade scale */
 198                 /* Units of LSB = 1 / 256 degree Celsius */
 199                 val->intval = val->intval * 10 / 256;
 200                 break;
 201         case POWER_SUPPLY_PROP_CURRENT_NOW:
 202                 if (chip->pdata->enable_current_sense) {
 203                         ret = regmap_read(map, MAX17042_Current, &data);
 204                         if (ret < 0)
 205                                 return ret;
 206
 207                         val->intval = data;
 208                         if (val->intval & 0x8000) {
 209                                 /* Negative */
 210                                 val->intval = ~val->intval & 0x7fff;
 211                                 val->intval++;
 212                                 val->intval *= -1;
 213                         }
 214                         val->intval *= 1562500 / chip->pdata->r_sns;
 215                 } else {
 216                         return -EINVAL;
 217                 }
 218                 break;
 219         case POWER_SUPPLY_PROP_CURRENT_AVG:
 220                 if (chip->pdata->enable_current_sense) {
 221                         ret = regmap_read(map, MAX17042_AvgCurrent, &data);
 222                         if (ret < 0)
 223                                 return ret;
 224
 225                         val->intval = data;
 226                         if (val->intval & 0x8000) {
 227                                 /* Negative */
 228                                 val->intval = ~val->intval & 0x7fff;
 229                                 val->intval++;
 230                                 val->intval *= -1;
 231                         }
 232                         val->intval *= 1562500 / chip->pdata->r_sns;
 233                 } else {
 234                         return -EINVAL;
 235                 }
 236                 break;
 237         default:
 238                 return -EINVAL;
 239         }
 240         return 0;
 241 }
 242
 243 static int max17042_write_verify_reg(struct regmap *map, u8 reg, u32 value)
 244 {
 245         int retries = 8;
 246         int ret;
 247         u32 read_value;
 248
 249         do {
 250                 ret = regmap_write(map, reg, value);
 251                 regmap_read(map, reg, &read_value);
 252                 if (read_value != value) {
 253                         ret = -EIO;
 254                         retries--;
 255                 }
 256         } while (retries && read_value != value);
 257
 258         if (ret < 0)
 259                 pr_err("%s: err %d\n", __func__, ret);
 260
 261         return ret;
 262 }
 263
 264 static inline void max17042_override_por(struct regmap *map,
 265                                          u8 reg, u16 value)
 266 {
 267         if (value)
 268                 regmap_write(map, reg, value);
 269 }
 270
 271 static inline void max10742_unlock_model(struct max17042_chip *chip)
 272 {
 273         struct regmap *map = chip->regmap;
 274         regmap_write(map, MAX17042_MLOCKReg1, MODEL_UNLOCK1);
 275         regmap_write(map, MAX17042_MLOCKReg2, MODEL_UNLOCK2);
 276 }
 277
 278 static inline void max10742_lock_model(struct max17042_chip *chip)
 279 {
 280         struct regmap *map = chip->regmap;
 281
 282         regmap_write(map, MAX17042_MLOCKReg1, MODEL_LOCK1);
 283         regmap_write(map, MAX17042_MLOCKReg2, MODEL_LOCK2);
 284 }
 285
 286 static inline void max17042_write_model_data(struct max17042_chip *chip,
 287                                         u8 addr, int size)
 288 {
 289         struct regmap *map = chip->regmap;
 290         int i;
 291         for (i = 0; i < size; i++)
 292                 regmap_write(map, addr + i,
 293                         chip->pdata->config_data->cell_char_tbl[i]);
 294 }
 295
 296 static inline void max17042_read_model_data(struct max17042_chip *chip,
 297                                         u8 addr, u32 *data, int size)
 298 {
 299         struct regmap *map = chip->regmap;
 300         int i;
 301
 302         for (i = 0; i < size; i++)
 303                 regmap_read(map, addr + i, &data[i]);
 304 }
 305
 306 static inline int max17042_model_data_compare(struct max17042_chip *chip,
 307                                         u16 *data1, u16 *data2, int size)
 308 {
 309         int i;
 310
 311         if (memcmp(data1, data2, size)) {
 312                 dev_err(&chip->client->dev, "%s compare failed\n", __func__);
 313                 for (i = 0; i < size; i++)
 314                         dev_info(&chip->client->dev, "0x%x, 0x%x",
 315                                 data1[i], data2[i]);
 316                 dev_info(&chip->client->dev, "\n");
 317                 return -EINVAL;
 318         }
 319         return 0;
 320 }
 321
 322 static int max17042_init_model(struct max17042_chip *chip)
 323 {
 324         int ret;
 325         int table_size = ARRAY_SIZE(chip->pdata->config_data->cell_char_tbl);
 326         u32 *temp_data;
 327
 328         temp_data = kcalloc(table_size, sizeof(*temp_data), GFP_KERNEL);
 329         if (!temp_data)
 330                 return -ENOMEM;
 331
 332         max10742_unlock_model(chip);
 333         max17042_write_model_data(chip, MAX17042_MODELChrTbl,
 334                                 table_size);
 335         max17042_read_model_data(chip, MAX17042_MODELChrTbl, temp_data,
 336                                 table_size);
 337
 338         ret = max17042_model_data_compare(
 339                 chip,
 340                 chip->pdata->config_data->cell_char_tbl,
 341                 (u16 *)temp_data,
 342                 table_size);
 343
 344         max10742_lock_model(chip);
 345         kfree(temp_data);
 346
 347         return ret;
 348 }
 349
 350 static int max17042_verify_model_lock(struct max17042_chip *chip)
 351 {
 352         int i;
 353         int table_size = ARRAY_SIZE(chip->pdata->config_data->cell_char_tbl);
 354         u32 *temp_data;
 355         int ret = 0;
 356
 357         temp_data = kcalloc(table_size, sizeof(*temp_data), GFP_KERNEL);
 358         if (!temp_data)
 359                 return -ENOMEM;
 360
 361         max17042_read_model_data(chip, MAX17042_MODELChrTbl, temp_data,
 362                                 table_size);
 363         for (i = 0; i < table_size; i++)
 364                 if (temp_data[i])
 365                         ret = -EINVAL;
 366
 367         kfree(temp_data);
 368         return ret;
 369 }
 370
 371 static void max17042_write_config_regs(struct max17042_chip *chip)
 372 {
 373         struct max17042_config_data *config = chip->pdata->config_data;
 374         struct regmap *map = chip->regmap;
 375
 376         regmap_write(map, MAX17042_CONFIG, config->config);
 377         regmap_write(map, MAX17042_LearnCFG, config->learn_cfg);
 378         regmap_write(map, MAX17042_FilterCFG,
 379                         config->filter_cfg);
 380         regmap_write(map, MAX17042_RelaxCFG, config->relax_cfg);
 381         if (chip->chip_type == MAX17047)
 382                 regmap_write(map, MAX17047_FullSOCThr,
 383                                                 config->full_soc_thresh);
 384 }
 385
 386 static void  max17042_write_custom_regs(struct max17042_chip *chip)
 387 {
 388         struct max17042_config_data *config = chip->pdata->config_data;
 389         struct regmap *map = chip->regmap;
 390
 391         max17042_write_verify_reg(map, MAX17042_RCOMP0, config->rcomp0);
 392         max17042_write_verify_reg(map, MAX17042_TempCo, config->tcompc0);
 393         max17042_write_verify_reg(map, MAX17042_ICHGTerm, config->ichgt_term);
 394         if (chip->chip_type == MAX17042) {
 395                 regmap_write(map, MAX17042_EmptyTempCo, config->empty_tempco);
 396                 max17042_write_verify_reg(map, MAX17042_K_empty0,
 397                                         config->kempty0);
 398         } else {
 399                 max17042_write_verify_reg(map, MAX17047_QRTbl00,
 400                                                 config->qrtbl00);
 401                 max17042_write_verify_reg(map, MAX17047_QRTbl10,
 402                                                 config->qrtbl10);
 403                 max17042_write_verify_reg(map, MAX17047_QRTbl20,
 404                                                 config->qrtbl20);
 405                 max17042_write_verify_reg(map, MAX17047_QRTbl30,
 406                                                 config->qrtbl30);
 407         }
 408 }
 409
 410 static void max17042_update_capacity_regs(struct max17042_chip *chip)
 411 {
 412         struct max17042_config_data *config = chip->pdata->config_data;
 413         struct regmap *map = chip->regmap;
 414
 415         max17042_write_verify_reg(map, MAX17042_FullCAP,
 416                                 config->fullcap);
 417         regmap_write(map, MAX17042_DesignCap, config->design_cap);
 418         max17042_write_verify_reg(map, MAX17042_FullCAPNom,
 419                                 config->fullcapnom);
 420 }
 421
 422 static void max17042_reset_vfsoc0_reg(struct max17042_chip *chip)
 423 {
 424         unsigned int vfSoc;
 425         struct regmap *map = chip->regmap;
 426
 427         regmap_read(map, MAX17042_VFSOC, &vfSoc);
 428         regmap_write(map, MAX17042_VFSOC0Enable, VFSOC0_UNLOCK);
 429         max17042_write_verify_reg(map, MAX17042_VFSOC0, vfSoc);
 430         regmap_write(map, MAX17042_VFSOC0Enable, VFSOC0_LOCK);
 431 }
 432
 433 static void max17042_load_new_capacity_params(struct max17042_chip *chip)
 434 {
 435         u32 full_cap0, rep_cap, dq_acc, vfSoc;
 436         u32 rem_cap;
 437
 438         struct max17042_config_data *config = chip->pdata->config_data;
 439         struct regmap *map = chip->regmap;
 440
 441         regmap_read(map, MAX17042_FullCAP0, &full_cap0);
 442         regmap_read(map, MAX17042_VFSOC, &vfSoc);
 443
 444         /* fg_vfSoc needs to shifted by 8 bits to get the
 445          * perc in 1% accuracy, to get the right rem_cap multiply
 446          * full_cap0, fg_vfSoc and devide by 100
 447          */
 448         rem_cap = ((vfSoc >> 8) * full_cap0) / 100;
 449         max17042_write_verify_reg(map, MAX17042_RemCap, rem_cap);
 450
 451         rep_cap = rem_cap;
 452         max17042_write_verify_reg(map, MAX17042_RepCap, rep_cap);
 453
 454         /* Write dQ_acc to 200% of Capacity and dP_acc to 200% */
 455         dq_acc = config->fullcap / dQ_ACC_DIV;
 456         max17042_write_verify_reg(map, MAX17042_dQacc, dq_acc);
 457         max17042_write_verify_reg(map, MAX17042_dPacc, dP_ACC_200);
 458
 459         max17042_write_verify_reg(map, MAX17042_FullCAP,
 460                         config->fullcap);
 461         regmap_write(map, MAX17042_DesignCap,
 462                         config->design_cap);
 463         max17042_write_verify_reg(map, MAX17042_FullCAPNom,
 464                         config->fullcapnom);
 465         /* Update SOC register with new SOC */
 466         regmap_write(map, MAX17042_RepSOC, vfSoc);
 467 }
 468
 469 /*
 470  * Block write all the override values coming from platform data.
 471  * This function MUST be called before the POR initialization proceedure
 472  * specified by maxim.
 473  */
 474 static inline void max17042_override_por_values(struct max17042_chip *chip)
 475 {
 476         struct regmap *map = chip->regmap;
 477         struct max17042_config_data *config = chip->pdata->config_data;
 478
 479         max17042_override_por(map, MAX17042_TGAIN, config->tgain);
 480         max17042_override_por(map, MAx17042_TOFF, config->toff);
 481         max17042_override_por(map, MAX17042_CGAIN, config->cgain);
 482         max17042_override_por(map, MAX17042_COFF, config->coff);
 483
 484         max17042_override_por(map, MAX17042_VALRT_Th, config->valrt_thresh);
 485         max17042_override_por(map, MAX17042_TALRT_Th, config->talrt_thresh);
 486         max17042_override_por(map, MAX17042_SALRT_Th,
 487                                                 config->soc_alrt_thresh);
 488         max17042_override_por(map, MAX17042_CONFIG, config->config);
 489         max17042_override_por(map, MAX17042_SHDNTIMER, config->shdntimer);
 490
 491         max17042_override_por(map, MAX17042_DesignCap, config->design_cap);
 492         max17042_override_por(map, MAX17042_ICHGTerm, config->ichgt_term);
 493
 494         max17042_override_por(map, MAX17042_AtRate, config->at_rate);
 495         max17042_override_por(map, MAX17042_LearnCFG, config->learn_cfg);
 496         max17042_override_por(map, MAX17042_FilterCFG, config->filter_cfg);
 497         max17042_override_por(map, MAX17042_RelaxCFG, config->relax_cfg);
 498         max17042_override_por(map, MAX17042_MiscCFG, config->misc_cfg);
 499         max17042_override_por(map, MAX17042_MaskSOC, config->masksoc);
 500
 501         max17042_override_por(map, MAX17042_FullCAP, config->fullcap);
 502         max17042_override_por(map, MAX17042_FullCAPNom, config->fullcapnom);
 503         if (chip->chip_type == MAX17042)
 504                 max17042_override_por(map, MAX17042_SOC_empty,
 505                                                 config->socempty);
 506         max17042_override_por(map, MAX17042_LAvg_empty, config->lavg_empty);
 507         max17042_override_por(map, MAX17042_dQacc, config->dqacc);
 508         max17042_override_por(map, MAX17042_dPacc, config->dpacc);
 509
 510         if (chip->chip_type == MAX17042)
 511                 max17042_override_por(map, MAX17042_V_empty, config->vempty);
 512         else
 513                 max17042_override_por(map, MAX17047_V_empty, config->vempty);
 514         max17042_override_por(map, MAX17042_TempNom, config->temp_nom);
 515         max17042_override_por(map, MAX17042_TempLim, config->temp_lim);
 516         max17042_override_por(map, MAX17042_FCTC, config->fctc);
 517         max17042_override_por(map, MAX17042_RCOMP0, config->rcomp0);
 518         max17042_override_por(map, MAX17042_TempCo, config->tcompc0);
 519         if (chip->chip_type) {
 520                 max17042_override_por(map, MAX17042_EmptyTempCo,
 521                                                 config->empty_tempco);
 522                 max17042_override_por(map, MAX17042_K_empty0,
 523                                                 config->kempty0);
 524         }
 525 }
 526
 527 static int max17042_init_chip(struct max17042_chip *chip)
 528 {
 529         struct regmap *map = chip->regmap;
 530         int ret;
 531
 532         max17042_override_por_values(chip);
 533         /* After Power up, the MAX17042 requires 500mS in order
 534          * to perform signal debouncing and initial SOC reporting
 535          */
 536         msleep(500);
 537
 538         /* Initialize configaration */
 539         max17042_write_config_regs(chip);
 540
 541         /* write cell characterization data */
 542         ret = max17042_init_model(chip);
 543         if (ret) {
 544                 dev_err(&chip->client->dev, "%s init failed\n",
 545                         __func__);
 546                 return -EIO;
 547         }
 548
 549         ret = max17042_verify_model_lock(chip);
 550         if (ret) {
 551                 dev_err(&chip->client->dev, "%s lock verify failed\n",
 552                         __func__);
 553                 return -EIO;
 554         }
 555         /* write custom parameters */
 556         max17042_write_custom_regs(chip);
 557
 558         /* update capacity params */
 559         max17042_update_capacity_regs(chip);
 560
 561         /* delay must be atleast 350mS to allow VFSOC
 562          * to be calculated from the new configuration
 563          */
 564         msleep(350);
 565
 566         /* reset vfsoc0 reg */
 567         max17042_reset_vfsoc0_reg(chip);
 568
 569         /* load new capacity params */
 570         max17042_load_new_capacity_params(chip);
 571
 572         /* Init complete, Clear the POR bit */
 573         regmap_update_bits(map, MAX17042_STATUS, STATUS_POR_BIT, 0x0);
 574         return 0;
 575 }
 576
 577 static void max17042_set_soc_threshold(struct max17042_chip *chip, u16 off)
 578 {
 579         struct regmap *map = chip->regmap;
 580         u32 soc, soc_tr;
 581
 582         /* program interrupt thesholds such that we should
 583          * get interrupt for every 'off' perc change in the soc
 584          */
 585         regmap_read(map, MAX17042_RepSOC, &soc);
 586         soc >>= 8;
 587         soc_tr = (soc + off) << 8;
 588         soc_tr |= (soc - off);
 589         regmap_write(map, MAX17042_SALRT_Th, soc_tr);
 590 }
 591
 592 static irqreturn_t max17042_thread_handler(int id, void *dev)
 593 {
 594         struct max17042_chip *chip = dev;
 595         u32 val;
 596
 597         regmap_read(chip->regmap, MAX17042_STATUS, &val);
 598         if ((val & STATUS_INTR_SOCMIN_BIT) ||
 599                 (val & STATUS_INTR_SOCMAX_BIT)) {
 600                 dev_info(&chip->client->dev, "SOC threshold INTR\n");
 601                 max17042_set_soc_threshold(chip, 1);
 602         }
 603
 604         power_supply_changed(chip->battery);
 605         return IRQ_HANDLED;
 606 }
 607
 608 static void max17042_init_worker(struct work_struct *work)
 609 {
 610         struct max17042_chip *chip = container_of(work,
 611                                 struct max17042_chip, work);
 612         int ret;
 613
 614         /* Initialize registers according to values from the platform data */
 615         if (chip->pdata->enable_por_init && chip->pdata->config_data) {
 616                 ret = max17042_init_chip(chip);
 617                 if (ret)
 618                         return;
 619         }
 620
 621         chip->init_complete = 1;
 622 }
 623
 624 #ifdef CONFIG_OF
 625 static struct max17042_platform_data *
 626 max17042_get_pdata(struct device *dev)
 627 {
 628         struct device_node *np = dev->of_node;
 629         u32 prop;
 630         struct max17042_platform_data *pdata;
 631
 632         if (!np)
 633                 return dev->platform_data;
 634
 635         pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
 636         if (!pdata)
 637                 return NULL;
 638
 639         /*
 640          * Require current sense resistor value to be specified for
 641          * current-sense functionality to be enabled at all.
 642          */
 643         if (of_property_read_u32(np, "maxim,rsns-microohm", &prop) == 0) {
 644                 pdata->r_sns = prop;
 645                 pdata->enable_current_sense = true;
 646         }
 647
 648         return pdata;
 649 }
 650 #else
 651 static struct max17042_platform_data *
 652 max17042_get_pdata(struct device *dev)
 653 {
 654         return dev->platform_data;
 655 }
 656 #endif
 657
 658 static const struct regmap_config max17042_regmap_config = {
 659         .reg_bits = 8,
 660         .val_bits = 16,
 661         .val_format_endian = REGMAP_ENDIAN_NATIVE,
 662 };
 663
 664 static const struct power_supply_desc max17042_psy_desc = {
 665         .name           = "max170xx_battery",
 666         .type           = POWER_SUPPLY_TYPE_BATTERY,
 667         .get_property   = max17042_get_property,
 668         .properties     = max17042_battery_props,
 669         .num_properties = ARRAY_SIZE(max17042_battery_props),
 670 };
 671
 672 static const struct power_supply_desc max17042_no_current_sense_psy_desc = {
 673         .name           = "max170xx_battery",
 674         .type           = POWER_SUPPLY_TYPE_BATTERY,
 675         .get_property   = max17042_get_property,
 676         .properties     = max17042_battery_props,
 677         .num_properties = ARRAY_SIZE(max17042_battery_props) - 2,
 678 };
 679
 680 static int max17042_probe(struct i2c_client *client,
 681                         const struct i2c_device_id *id)
 682 {
 683         struct i2c_adapter *adapter = to_i2c_adapter(client->dev.parent);
 684         const struct power_supply_desc *max17042_desc = &max17042_psy_desc;
 685         struct power_supply_config psy_cfg = {};
 686         struct max17042_chip *chip;
 687         int ret;
 688         int i;
 689         u32 val;
 690
 691         if (!i2c_check_functionality(adapter, I2C_FUNC_SMBUS_WORD_DATA))
 692                 return -EIO;
 693
 694         chip = devm_kzalloc(&client->dev, sizeof(*chip), GFP_KERNEL);
 695         if (!chip)
 696                 return -ENOMEM;
 697
 698         chip->client = client;
 699         chip->regmap = devm_regmap_init_i2c(client, &max17042_regmap_config);
 700         if (IS_ERR(chip->regmap)) {
 701                 dev_err(&client->dev, "Failed to initialize regmap\n");
 702                 return -EINVAL;
 703         }
 704
 705         chip->pdata = max17042_get_pdata(&client->dev);
 706         if (!chip->pdata) {
 707                 dev_err(&client->dev, "no platform data provided\n");
 708                 return -EINVAL;
 709         }
 710
 711         i2c_set_clientdata(client, chip);
 712         psy_cfg.drv_data = chip;
 713
 714         regmap_read(chip->regmap, MAX17042_DevName, &val);
 715         if (val == MAX17042_IC_VERSION) {
 716                 dev_dbg(&client->dev, "chip type max17042 detected\n");
 717                 chip->chip_type = MAX17042;
 718         } else if (val == MAX17047_IC_VERSION) {
 719                 dev_dbg(&client->dev, "chip type max17047/50 detected\n");
 720                 chip->chip_type = MAX17047;
 721         } else {
 722                 dev_err(&client->dev, "device version mismatch: %x\n", val);
 723                 return -EIO;
 724         }
 725
 726         /* When current is not measured,
 727          * CURRENT_NOW and CURRENT_AVG properties should be invisible. */
 728         if (!chip->pdata->enable_current_sense)
 729                 max17042_desc = &max17042_no_current_sense_psy_desc;
 730
 731         if (chip->pdata->r_sns == 0)
 732                 chip->pdata->r_sns = MAX17042_DEFAULT_SNS_RESISTOR;
 733
 734         if (chip->pdata->init_data)
 735                 for (i = 0; i < chip->pdata->num_init_data; i++)
 736                         regmap_write(chip->regmap,
 737                                         chip->pdata->init_data[i].addr,
 738                                         chip->pdata->init_data[i].data);
 739
 740         if (!chip->pdata->enable_current_sense) {
 741                 regmap_write(chip->regmap, MAX17042_CGAIN, 0x0000);
 742                 regmap_write(chip->regmap, MAX17042_MiscCFG, 0x0003);
 743                 regmap_write(chip->regmap, MAX17042_LearnCFG, 0x0007);
 744         }
 745
 746         chip->battery = power_supply_register(&client->dev, max17042_desc,
 747                                                 &psy_cfg);
 748         if (IS_ERR(chip->battery)) {
 749                 dev_err(&client->dev, "failed: power supply register\n");
 750                 return PTR_ERR(chip->battery);
 751         }
 752
 753         if (client->irq) {
 754                 ret = request_threaded_irq(client->irq, NULL,
 755                                         max17042_thread_handler,
 756                                         IRQF_TRIGGER_FALLING | IRQF_ONESHOT,
 757                                         chip->battery->desc->name, chip);
 758                 if (!ret) {
 759                         regmap_update_bits(chip->regmap, MAX17042_CONFIG,
 760                                         CONFIG_ALRT_BIT_ENBL,
 761                                         CONFIG_ALRT_BIT_ENBL);
 762                         max17042_set_soc_threshold(chip, 1);
 763                 } else {
 764                         client->irq = 0;
 765                         dev_err(&client->dev, "%s(): cannot get IRQ\n",
 766                                 __func__);
 767                 }
 768         }
 769
 770         regmap_read(chip->regmap, MAX17042_STATUS, &val);
 771         if (val & STATUS_POR_BIT) {
 772                 INIT_WORK(&chip->work, max17042_init_worker);
 773                 schedule_work(&chip->work);
 774         } else {
 775                 chip->init_complete = 1;
 776         }
 777
 778         return 0;
 779 }
 780
 781 static int max17042_remove(struct i2c_client *client)
 782 {
 783         struct max17042_chip *chip = i2c_get_clientdata(client);
 784
 785         if (client->irq)
 786                 free_irq(client->irq, chip);
 787         power_supply_unregister(chip->battery);
 788         return 0;
 789 }
 790
 791 #ifdef CONFIG_PM_SLEEP
 792 static int max17042_suspend(struct device *dev)
 793 {
 794         struct max17042_chip *chip = dev_get_drvdata(dev);
 795
 796         /*
 797          * disable the irq and enable irq_wake
 798          * capability to the interrupt line.
 799          */
 800         if (chip->client->irq) {
 801                 disable_irq(chip->client->irq);
 802                 enable_irq_wake(chip->client->irq);
 803         }
 804
 805         return 0;
 806 }
 807
 808 static int max17042_resume(struct device *dev)
 809 {
 810         struct max17042_chip *chip = dev_get_drvdata(dev);
 811
 812         if (chip->client->irq) {
 813                 disable_irq_wake(chip->client->irq);
 814                 enable_irq(chip->client->irq);
 815                 /* re-program the SOC thresholds to 1% change */
 816                 max17042_set_soc_threshold(chip, 1);
 817         }
 818
 819         return 0;
 820 }
 821 #endif
 822
 823 static SIMPLE_DEV_PM_OPS(max17042_pm_ops, max17042_suspend,
 824                         max17042_resume);
 825
 826 #ifdef CONFIG_OF
 827 static const struct of_device_id max17042_dt_match[] = {
 828         { .compatible = "maxim,max17042" },
 829         { .compatible = "maxim,max17047" },
 830         { .compatible = "maxim,max17050" },
 831         { },
 832 };
 833 MODULE_DEVICE_TABLE(of, max17042_dt_match);
 834 #endif
 835
 836 static const struct i2c_device_id max17042_id[] = {
 837         { "max17042", 0 },
 838         { "max17047", 1 },
 839         { "max17050", 2 },
 840         { }
 841 };
 842 MODULE_DEVICE_TABLE(i2c, max17042_id);
 843
 844 static struct i2c_driver max17042_i2c_driver = {
 845         .driver = {
 846                 .name   = "max17042",
 847                 .of_match_table = of_match_ptr(max17042_dt_match),
 848                 .pm     = &max17042_pm_ops,
 849         },
 850         .probe          = max17042_probe,
 851         .remove         = max17042_remove,
 852         .id_table       = max17042_id,
 853 };
 854 module_i2c_driver(max17042_i2c_driver);
 855
 856 MODULE_AUTHOR("MyungJoo Ham <myungjoo.ham@samsung.com>");
 857 MODULE_DESCRIPTION("MAX17042 Fuel Gauge");
 858 MODULE_LICENSE("GPL");