drivers/power/twl4030_charger.c

   1 /*
   2  * TWL4030/TPS65950 BCI (Battery Charger Interface) driver
   3  *
   4  * Copyright (C) 2010 Gražvydas Ignotas <notasas@gmail.com>
   5  *
   6  * based on twl4030_bci_battery.c by TI
   7  * Copyright (C) 2008 Texas Instruments, Inc.
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  */
  14
  15 #include <linux/init.h>
  16 #include <linux/module.h>
  17 #include <linux/slab.h>
  18 #include <linux/platform_device.h>
  19 #include <linux/interrupt.h>
  20 #include <linux/i2c/twl.h>
  21 #include <linux/power_supply.h>
  22 #include <linux/notifier.h>
  23 #include <linux/usb/otg.h>
  24 #include <linux/ratelimit.h>
  25
  26 #define TWL4030_BCIMSTATEC      0x02
  27 #define TWL4030_BCIICHG         0x08
  28 #define TWL4030_BCIVAC          0x0a
  29 #define TWL4030_BCIVBUS         0x0c
  30 #define TWL4030_BCIMFSTS4       0x10
  31 #define TWL4030_BCICTL1         0x23
  32
  33 #define TWL4030_BCIAUTOWEN      BIT(5)
  34 #define TWL4030_CONFIG_DONE     BIT(4)
  35 #define TWL4030_BCIAUTOUSB      BIT(1)
  36 #define TWL4030_BCIAUTOAC       BIT(0)
  37 #define TWL4030_CGAIN           BIT(5)
  38 #define TWL4030_USBFASTMCHG     BIT(2)
  39 #define TWL4030_STS_VBUS        BIT(7)
  40 #define TWL4030_STS_USB_ID      BIT(2)
  41
  42 /* BCI interrupts */
  43 #define TWL4030_WOVF            BIT(0) /* Watchdog overflow */
  44 #define TWL4030_TMOVF           BIT(1) /* Timer overflow */
  45 #define TWL4030_ICHGHIGH        BIT(2) /* Battery charge current high */
  46 #define TWL4030_ICHGLOW         BIT(3) /* Battery cc. low / FSM state change */
  47 #define TWL4030_ICHGEOC         BIT(4) /* Battery current end-of-charge */
  48 #define TWL4030_TBATOR2         BIT(5) /* Battery temperature out of range 2 */
  49 #define TWL4030_TBATOR1         BIT(6) /* Battery temperature out of range 1 */
  50 #define TWL4030_BATSTS          BIT(7) /* Battery status */
  51
  52 #define TWL4030_VBATLVL         BIT(0) /* VBAT level */
  53 #define TWL4030_VBATOV          BIT(1) /* VBAT overvoltage */
  54 #define TWL4030_VBUSOV          BIT(2) /* VBUS overvoltage */
  55 #define TWL4030_ACCHGOV         BIT(3) /* Ac charger overvoltage */
  56
  57 #define TWL4030_MSTATEC_USB             BIT(4)
  58 #define TWL4030_MSTATEC_AC              BIT(5)
  59 #define TWL4030_MSTATEC_MASK            0x0f
  60 #define TWL4030_MSTATEC_QUICK1          0x02
  61 #define TWL4030_MSTATEC_QUICK7          0x07
  62 #define TWL4030_MSTATEC_COMPLETE1       0x0b
  63 #define TWL4030_MSTATEC_COMPLETE4       0x0e
  64
  65 static bool allow_usb = 1;
  66 module_param(allow_usb, bool, 0644);
  67 MODULE_PARM_DESC(allow_usb, "Allow USB charge drawing default current");
  68
  69 struct twl4030_bci {
  70         struct device           *dev;
  71         struct power_supply     ac;
  72         struct power_supply     usb;
  73         struct otg_transceiver  *transceiver;
  74         struct notifier_block   otg_nb;
  75         struct work_struct      work;
  76         int                     irq_chg;
  77         int                     irq_bci;
  78
  79         unsigned long           event;
  80         struct ratelimit_state  ratelimit;
  81 };
  82
  83 /*
  84  * clear and set bits on an given register on a given module
  85  */
  86 static int twl4030_clear_set(u8 mod_no, u8 clear, u8 set, u8 reg)
  87 {
  88         u8 val = 0;
  89         int ret;
  90
  91         ret = twl_i2c_read_u8(mod_no, &val, reg);
  92         if (ret)
  93                 return ret;
  94
  95         val &= ~clear;
  96         val |= set;
  97
  98         return twl_i2c_write_u8(mod_no, val, reg);
  99 }
 100
 101 static int twl4030_bci_read(u8 reg, u8 *val)
 102 {
 103         return twl_i2c_read_u8(TWL4030_MODULE_MAIN_CHARGE, val, reg);
 104 }
 105
 106 static int twl4030_clear_set_boot_bci(u8 clear, u8 set)
 107 {
 108         return twl4030_clear_set(TWL4030_MODULE_PM_MASTER, 0,
 109                         TWL4030_CONFIG_DONE | TWL4030_BCIAUTOWEN | set,
 110                         TWL4030_PM_MASTER_BOOT_BCI);
 111 }
 112
 113 static int twl4030bci_read_adc_val(u8 reg)
 114 {
 115         int ret, temp;
 116         u8 val;
 117
 118         /* read MSB */
 119         ret = twl4030_bci_read(reg + 1, &val);
 120         if (ret)
 121                 return ret;
 122
 123         temp = (int)(val & 0x03) << 8;
 124
 125         /* read LSB */
 126         ret = twl4030_bci_read(reg, &val);
 127         if (ret)
 128                 return ret;
 129
 130         return temp | val;
 131 }
 132
 133 /*
 134  * Check if VBUS power is present
 135  */
 136 static int twl4030_bci_have_vbus(struct twl4030_bci *bci)
 137 {
 138         int ret;
 139         u8 hwsts;
 140
 141         ret = twl_i2c_read_u8(TWL4030_MODULE_PM_MASTER, &hwsts,
 142                               TWL4030_PM_MASTER_STS_HW_CONDITIONS);
 143         if (ret < 0)
 144                 return 0;
 145
 146         dev_dbg(bci->dev, "check_vbus: HW_CONDITIONS %02x\n", hwsts);
 147
 148         /* in case we also have STS_USB_ID, VBUS is driven by TWL itself */
 149         if ((hwsts & TWL4030_STS_VBUS) && !(hwsts & TWL4030_STS_USB_ID))
 150                 return 1;
 151
 152         return 0;
 153 }
 154
 155 /*
 156  * Enable/Disable USB Charge funtionality.
 157  */
 158 static int twl4030_charger_enable_usb(struct twl4030_bci *bci, bool enable)
 159 {
 160         int ret;
 161
 162         if (enable) {
 163                 /* Check for USB charger conneted */
 164                 if (!twl4030_bci_have_vbus(bci))
 165                         return -ENODEV;
 166
 167                 /*
 168                  * Until we can find out what current the device can provide,
 169                  * require a module param to enable USB charging.
 170                  */
 171                 if (!allow_usb) {
 172                         dev_warn(bci->dev, "USB charging is disabled.\n");
 173                         return -EACCES;
 174                 }
 175
 176                 /* forcing the field BCIAUTOUSB (BOOT_BCI[1]) to 1 */
 177                 ret = twl4030_clear_set_boot_bci(0, TWL4030_BCIAUTOUSB);
 178                 if (ret < 0)
 179                         return ret;
 180
 181                 /* forcing USBFASTMCHG(BCIMFSTS4[2]) to 1 */
 182                 ret = twl4030_clear_set(TWL4030_MODULE_MAIN_CHARGE, 0,
 183                         TWL4030_USBFASTMCHG, TWL4030_BCIMFSTS4);
 184         } else {
 185                 ret = twl4030_clear_set_boot_bci(TWL4030_BCIAUTOUSB, 0);
 186         }
 187
 188         return ret;
 189 }
 190
 191 /*
 192  * Enable/Disable AC Charge funtionality.
 193  */
 194 static int twl4030_charger_enable_ac(bool enable)
 195 {
 196         int ret;
 197
 198         if (enable)
 199                 ret = twl4030_clear_set_boot_bci(0, TWL4030_BCIAUTOAC);
 200         else
 201                 ret = twl4030_clear_set_boot_bci(TWL4030_BCIAUTOAC, 0);
 202
 203         return ret;
 204 }
 205
 206 /*
 207  * TWL4030 CHG_PRES (AC charger presence) events
 208  */
 209 static irqreturn_t twl4030_charger_interrupt(int irq, void *arg)
 210 {
 211         struct twl4030_bci *bci = arg;
 212
 213         dev_dbg(bci->dev, "CHG_PRES irq\n");
 214         power_supply_changed(&bci->ac);
 215         power_supply_changed(&bci->usb);
 216
 217         return IRQ_HANDLED;
 218 }
 219
 220 /*
 221  * TWL4030 BCI monitoring events
 222  */
 223 static irqreturn_t twl4030_bci_interrupt(int irq, void *arg)
 224 {
 225         struct twl4030_bci *bci = arg;
 226         u8 irqs1, irqs2;
 227         int ret;
 228
 229         ret = twl_i2c_read_u8(TWL4030_MODULE_INTERRUPTS, &irqs1,
 230                               TWL4030_INTERRUPTS_BCIISR1A);
 231         if (ret < 0)
 232                 return IRQ_HANDLED;
 233
 234         ret = twl_i2c_read_u8(TWL4030_MODULE_INTERRUPTS, &irqs2,
 235                               TWL4030_INTERRUPTS_BCIISR2A);
 236         if (ret < 0)
 237                 return IRQ_HANDLED;
 238
 239         dev_dbg(bci->dev, "BCI irq %02x %02x\n", irqs2, irqs1);
 240
 241         if (irqs1 & (TWL4030_ICHGLOW | TWL4030_ICHGEOC)) {
 242                 /* charger state change, inform the core */
 243                 power_supply_changed(&bci->ac);
 244                 power_supply_changed(&bci->usb);
 245         }
 246
 247         /* various monitoring events, for now we just log them here */
 248         if (irqs1 & (TWL4030_TBATOR2 | TWL4030_TBATOR1) &&
 249                         __ratelimit(&bci->ratelimit))
 250                 dev_warn(bci->dev, "battery temperature out of range\n");
 251
 252         if (irqs1 & TWL4030_BATSTS && __ratelimit(&bci->ratelimit))
 253                 dev_crit(bci->dev, "battery disconnected\n");
 254
 255         if (irqs2 & TWL4030_VBATOV && __ratelimit(&bci->ratelimit))
 256                 dev_crit(bci->dev, "VBAT overvoltage\n");
 257
 258         if (irqs2 & TWL4030_VBUSOV && __ratelimit(&bci->ratelimit))
 259                 dev_crit(bci->dev, "VBUS overvoltage\n");
 260
 261         if (irqs2 & TWL4030_ACCHGOV && __ratelimit(&bci->ratelimit))
 262                 dev_crit(bci->dev, "Ac charger overvoltage\n");
 263
 264         /* ack the interrupts */
 265         twl_i2c_write_u8(TWL4030_MODULE_INTERRUPTS, irqs1,
 266                          TWL4030_INTERRUPTS_BCIISR1A);
 267         twl_i2c_write_u8(TWL4030_MODULE_INTERRUPTS, irqs2,
 268                          TWL4030_INTERRUPTS_BCIISR2A);
 269
 270         return IRQ_HANDLED;
 271 }
 272
 273 static void twl4030_bci_usb_work(struct work_struct *data)
 274 {
 275         struct twl4030_bci *bci = container_of(data, struct twl4030_bci, work);
 276
 277         switch (bci->event) {
 278         case USB_EVENT_VBUS:
 279         case USB_EVENT_CHARGER:
 280                 twl4030_charger_enable_usb(bci, true);
 281                 break;
 282         case USB_EVENT_NONE:
 283                 twl4030_charger_enable_usb(bci, false);
 284                 break;
 285         }
 286 }
 287
 288 static int twl4030_bci_usb_ncb(struct notifier_block *nb, unsigned long val,
 289                                void *priv)
 290 {
 291         struct twl4030_bci *bci = container_of(nb, struct twl4030_bci, otg_nb);
 292
 293         dev_dbg(bci->dev, "OTG notify %lu\n", val);
 294
 295         bci->event = val;
 296         schedule_work(&bci->work);
 297
 298         return NOTIFY_OK;
 299 }
 300
 301 /*
 302  * TI provided formulas:
 303  * CGAIN == 0: ICHG = (BCIICHG * 1.7) / (2^10 - 1) - 0.85
 304  * CGAIN == 1: ICHG = (BCIICHG * 3.4) / (2^10 - 1) - 1.7
 305  * Here we use integer approximation of:
 306  * CGAIN == 0: val * 1.6618 - 0.85
 307  * CGAIN == 1: (val * 1.6618 - 0.85) * 2
 308  */
 309 static int twl4030_charger_get_current(void)
 310 {
 311         int curr;
 312         int ret;
 313         u8 bcictl1;
 314
 315         curr = twl4030bci_read_adc_val(TWL4030_BCIICHG);
 316         if (curr < 0)
 317                 return curr;
 318
 319         ret = twl4030_bci_read(TWL4030_BCICTL1, &bcictl1);
 320         if (ret)
 321                 return ret;
 322
 323         ret = (curr * 16618 - 850 * 10000) / 10;
 324         if (bcictl1 & TWL4030_CGAIN)
 325                 ret *= 2;
 326
 327         return ret;
 328 }
 329
 330 /*
 331  * Returns the main charge FSM state
 332  * Or < 0 on failure.
 333  */
 334 static int twl4030bci_state(struct twl4030_bci *bci)
 335 {
 336         int ret;
 337         u8 state;
 338
 339         ret = twl4030_bci_read(TWL4030_BCIMSTATEC, &state);
 340         if (ret) {
 341                 pr_err("twl4030_bci: error reading BCIMSTATEC\n");
 342                 return ret;
 343         }
 344
 345         dev_dbg(bci->dev, "state: %02x\n", state);
 346
 347         return state;
 348 }
 349
 350 static int twl4030_bci_state_to_status(int state)
 351 {
 352         state &= TWL4030_MSTATEC_MASK;
 353         if (TWL4030_MSTATEC_QUICK1 <= state && state <= TWL4030_MSTATEC_QUICK7)
 354                 return POWER_SUPPLY_STATUS_CHARGING;
 355         else if (TWL4030_MSTATEC_COMPLETE1 <= state &&
 356                                         state <= TWL4030_MSTATEC_COMPLETE4)
 357                 return POWER_SUPPLY_STATUS_FULL;
 358         else
 359                 return POWER_SUPPLY_STATUS_NOT_CHARGING;
 360 }
 361
 362 static int twl4030_bci_get_property(struct power_supply *psy,
 363                                     enum power_supply_property psp,
 364                                     union power_supply_propval *val)
 365 {
 366         struct twl4030_bci *bci = dev_get_drvdata(psy->dev->parent);
 367         int is_charging;
 368         int state;
 369         int ret;
 370
 371         state = twl4030bci_state(bci);
 372         if (state < 0)
 373                 return state;
 374
 375         if (psy->type == POWER_SUPPLY_TYPE_USB)
 376                 is_charging = state & TWL4030_MSTATEC_USB;
 377         else
 378                 is_charging = state & TWL4030_MSTATEC_AC;
 379
 380         switch (psp) {
 381         case POWER_SUPPLY_PROP_STATUS:
 382                 if (is_charging)
 383                         val->intval = twl4030_bci_state_to_status(state);
 384                 else
 385                         val->intval = POWER_SUPPLY_STATUS_NOT_CHARGING;
 386                 break;
 387         case POWER_SUPPLY_PROP_VOLTAGE_NOW:
 388                 /* charging must be active for meaningful result */
 389                 if (!is_charging)
 390                         return -ENODATA;
 391                 if (psy->type == POWER_SUPPLY_TYPE_USB) {
 392                         ret = twl4030bci_read_adc_val(TWL4030_BCIVBUS);
 393                         if (ret < 0)
 394                                 return ret;
 395                         /* BCIVBUS uses ADCIN8, 7/1023 V/step */
 396                         val->intval = ret * 6843;
 397                 } else {
 398                         ret = twl4030bci_read_adc_val(TWL4030_BCIVAC);
 399                         if (ret < 0)
 400                                 return ret;
 401                         /* BCIVAC uses ADCIN11, 10/1023 V/step */
 402                         val->intval = ret * 9775;
 403                 }
 404                 break;
 405         case POWER_SUPPLY_PROP_CURRENT_NOW:
 406                 if (!is_charging)
 407                         return -ENODATA;
 408                 /* current measurement is shared between AC and USB */
 409                 ret = twl4030_charger_get_current();
 410                 if (ret < 0)
 411                         return ret;
 412                 val->intval = ret;
 413                 break;
 414         case POWER_SUPPLY_PROP_ONLINE:
 415                 val->intval = is_charging &&
 416                         twl4030_bci_state_to_status(state) !=
 417                                 POWER_SUPPLY_STATUS_NOT_CHARGING;
 418                 break;
 419         default:
 420                 return -EINVAL;
 421         }
 422
 423         return 0;
 424 }
 425
 426 static enum power_supply_property twl4030_charger_props[] = {
 427         POWER_SUPPLY_PROP_STATUS,
 428         POWER_SUPPLY_PROP_ONLINE,
 429         POWER_SUPPLY_PROP_VOLTAGE_NOW,
 430         POWER_SUPPLY_PROP_CURRENT_NOW,
 431 };
 432
 433 static int __init twl4030_bci_probe(struct platform_device *pdev)
 434 {
 435         struct twl4030_bci *bci;
 436         int ret;
 437         u32 reg;
 438
 439         bci = kzalloc(sizeof(*bci), GFP_KERNEL);
 440         if (bci == NULL)
 441                 return -ENOMEM;
 442
 443         bci->dev = &pdev->dev;
 444         bci->irq_chg = platform_get_irq(pdev, 0);
 445         bci->irq_bci = platform_get_irq(pdev, 1);
 446
 447         platform_set_drvdata(pdev, bci);
 448
 449         ratelimit_state_init(&bci->ratelimit, HZ, 2);
 450
 451         bci->ac.name = "twl4030_ac";
 452         bci->ac.type = POWER_SUPPLY_TYPE_MAINS;
 453         bci->ac.properties = twl4030_charger_props;
 454         bci->ac.num_properties = ARRAY_SIZE(twl4030_charger_props);
 455         bci->ac.get_property = twl4030_bci_get_property;
 456
 457         ret = power_supply_register(&pdev->dev, &bci->ac);
 458         if (ret) {
 459                 dev_err(&pdev->dev, "failed to register ac: %d\n", ret);
 460                 goto fail_register_ac;
 461         }
 462
 463         bci->usb.name = "twl4030_usb";
 464         bci->usb.type = POWER_SUPPLY_TYPE_USB;
 465         bci->usb.properties = twl4030_charger_props;
 466         bci->usb.num_properties = ARRAY_SIZE(twl4030_charger_props);
 467         bci->usb.get_property = twl4030_bci_get_property;
 468
 469         ret = power_supply_register(&pdev->dev, &bci->usb);
 470         if (ret) {
 471                 dev_err(&pdev->dev, "failed to register usb: %d\n", ret);
 472                 goto fail_register_usb;
 473         }
 474
 475         ret = request_threaded_irq(bci->irq_chg, NULL,
 476                         twl4030_charger_interrupt, 0, pdev->name, bci);
 477         if (ret < 0) {
 478                 dev_err(&pdev->dev, "could not request irq %d, status %d\n",
 479                         bci->irq_chg, ret);
 480                 goto fail_chg_irq;
 481         }
 482
 483         ret = request_threaded_irq(bci->irq_bci, NULL,
 484                         twl4030_bci_interrupt, 0, pdev->name, bci);
 485         if (ret < 0) {
 486                 dev_err(&pdev->dev, "could not request irq %d, status %d\n",
 487                         bci->irq_bci, ret);
 488                 goto fail_bci_irq;
 489         }
 490
 491         INIT_WORK(&bci->work, twl4030_bci_usb_work);
 492
 493         bci->transceiver = otg_get_transceiver();
 494         if (bci->transceiver != NULL) {
 495                 bci->otg_nb.notifier_call = twl4030_bci_usb_ncb;
 496                 otg_register_notifier(bci->transceiver, &bci->otg_nb);
 497         }
 498
 499         /* Enable interrupts now. */
 500         reg = ~(u32)(TWL4030_ICHGLOW | TWL4030_ICHGEOC | TWL4030_TBATOR2 |
 501                 TWL4030_TBATOR1 | TWL4030_BATSTS);
 502         ret = twl_i2c_write_u8(TWL4030_MODULE_INTERRUPTS, reg,
 503                                TWL4030_INTERRUPTS_BCIIMR1A);
 504         if (ret < 0) {
 505                 dev_err(&pdev->dev, "failed to unmask interrupts: %d\n", ret);
 506                 goto fail_unmask_interrupts;
 507         }
 508
 509         reg = ~(u32)(TWL4030_VBATOV | TWL4030_VBUSOV | TWL4030_ACCHGOV);
 510         ret = twl_i2c_write_u8(TWL4030_MODULE_INTERRUPTS, reg,
 511                                TWL4030_INTERRUPTS_BCIIMR2A);
 512         if (ret < 0)
 513                 dev_warn(&pdev->dev, "failed to unmask interrupts: %d\n", ret);
 514
 515         twl4030_charger_enable_ac(true);
 516         twl4030_charger_enable_usb(bci, true);
 517
 518         return 0;
 519
 520 fail_unmask_interrupts:
 521         if (bci->transceiver != NULL) {
 522                 otg_unregister_notifier(bci->transceiver, &bci->otg_nb);
 523                 otg_put_transceiver(bci->transceiver);
 524         }
 525         free_irq(bci->irq_bci, bci);
 526 fail_bci_irq:
 527         free_irq(bci->irq_chg, bci);
 528 fail_chg_irq:
 529         power_supply_unregister(&bci->usb);
 530 fail_register_usb:
 531         power_supply_unregister(&bci->ac);
 532 fail_register_ac:
 533         platform_set_drvdata(pdev, NULL);
 534         kfree(bci);
 535
 536         return ret;
 537 }
 538
 539 static int __exit twl4030_bci_remove(struct platform_device *pdev)
 540 {
 541         struct twl4030_bci *bci = platform_get_drvdata(pdev);
 542
 543         twl4030_charger_enable_ac(false);
 544         twl4030_charger_enable_usb(bci, false);
 545
 546         /* mask interrupts */
 547         twl_i2c_write_u8(TWL4030_MODULE_INTERRUPTS, 0xff,
 548                          TWL4030_INTERRUPTS_BCIIMR1A);
 549         twl_i2c_write_u8(TWL4030_MODULE_INTERRUPTS, 0xff,
 550                          TWL4030_INTERRUPTS_BCIIMR2A);
 551
 552         if (bci->transceiver != NULL) {
 553                 otg_unregister_notifier(bci->transceiver, &bci->otg_nb);
 554                 otg_put_transceiver(bci->transceiver);
 555         }
 556         free_irq(bci->irq_bci, bci);
 557         free_irq(bci->irq_chg, bci);
 558         power_supply_unregister(&bci->usb);
 559         power_supply_unregister(&bci->ac);
 560         platform_set_drvdata(pdev, NULL);
 561         kfree(bci);
 562
 563         return 0;
 564 }
 565
 566 static struct platform_driver twl4030_bci_driver = {
 567         .driver = {
 568                 .name   = "twl4030_bci",
 569                 .owner  = THIS_MODULE,
 570         },
 571         .remove = __exit_p(twl4030_bci_remove),
 572 };
 573
 574 static int __init twl4030_bci_init(void)
 575 {
 576         return platform_driver_probe(&twl4030_bci_driver, twl4030_bci_probe);
 577 }
 578 module_init(twl4030_bci_init);
 579
 580 static void __exit twl4030_bci_exit(void)
 581 {
 582         platform_driver_unregister(&twl4030_bci_driver);
 583 }
 584 module_exit(twl4030_bci_exit);
 585
 586 MODULE_AUTHOR("Gražvydas Ignotas");
 587 MODULE_DESCRIPTION("TWL4030 Battery Charger Interface driver");
 588 MODULE_LICENSE("GPL");
 589 MODULE_ALIAS("platform:twl4030_bci");