2 * TWL4030/TPS65950 BCI (Battery Charger Interface) driver
4 * Copyright (C) 2010 Gražvydas Ignotas <notasas@gmail.com>
6 * based on twl4030_bci_battery.c by TI
7 * Copyright (C) 2008 Texas Instruments, Inc.
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.
15 #include <linux/init.h>
16 #include <linux/module.h>
17 #include <linux/slab.h>
18 #include <linux/err.h>
19 #include <linux/platform_device.h>
20 #include <linux/interrupt.h>
21 #include <linux/i2c/twl.h>
22 #include <linux/power_supply.h>
23 #include <linux/notifier.h>
24 #include <linux/usb/otg.h>
25 #include <linux/regulator/machine.h>
27 #define TWL4030_BCIMSTATEC 0x02
28 #define TWL4030_BCIICHG 0x08
29 #define TWL4030_BCIVAC 0x0a
30 #define TWL4030_BCIVBUS 0x0c
31 #define TWL4030_BCIMFSTS4 0x10
32 #define TWL4030_BCICTL1 0x23
33 #define TWL4030_BB_CFG 0x12
35 #define TWL4030_BCIAUTOWEN BIT(5)
36 #define TWL4030_CONFIG_DONE BIT(4)
37 #define TWL4030_BCIAUTOUSB BIT(1)
38 #define TWL4030_BCIAUTOAC BIT(0)
39 #define TWL4030_CGAIN BIT(5)
40 #define TWL4030_USBFASTMCHG BIT(2)
41 #define TWL4030_STS_VBUS BIT(7)
42 #define TWL4030_STS_USB_ID BIT(2)
43 #define TWL4030_BBCHEN BIT(4)
44 #define TWL4030_BBSEL_MASK 0x0c
45 #define TWL4030_BBSEL_2V5 0x00
46 #define TWL4030_BBSEL_3V0 0x04
47 #define TWL4030_BBSEL_3V1 0x08
48 #define TWL4030_BBSEL_3V2 0x0c
49 #define TWL4030_BBISEL_MASK 0x03
50 #define TWL4030_BBISEL_25uA 0x00
51 #define TWL4030_BBISEL_150uA 0x01
52 #define TWL4030_BBISEL_500uA 0x02
53 #define TWL4030_BBISEL_1000uA 0x03
56 #define TWL4030_WOVF BIT(0) /* Watchdog overflow */
57 #define TWL4030_TMOVF BIT(1) /* Timer overflow */
58 #define TWL4030_ICHGHIGH BIT(2) /* Battery charge current high */
59 #define TWL4030_ICHGLOW BIT(3) /* Battery cc. low / FSM state change */
60 #define TWL4030_ICHGEOC BIT(4) /* Battery current end-of-charge */
61 #define TWL4030_TBATOR2 BIT(5) /* Battery temperature out of range 2 */
62 #define TWL4030_TBATOR1 BIT(6) /* Battery temperature out of range 1 */
63 #define TWL4030_BATSTS BIT(7) /* Battery status */
65 #define TWL4030_VBATLVL BIT(0) /* VBAT level */
66 #define TWL4030_VBATOV BIT(1) /* VBAT overvoltage */
67 #define TWL4030_VBUSOV BIT(2) /* VBUS overvoltage */
68 #define TWL4030_ACCHGOV BIT(3) /* Ac charger overvoltage */
70 #define TWL4030_MSTATEC_USB BIT(4)
71 #define TWL4030_MSTATEC_AC BIT(5)
72 #define TWL4030_MSTATEC_MASK 0x0f
73 #define TWL4030_MSTATEC_QUICK1 0x02
74 #define TWL4030_MSTATEC_QUICK7 0x07
75 #define TWL4030_MSTATEC_COMPLETE1 0x0b
76 #define TWL4030_MSTATEC_COMPLETE4 0x0e
78 static bool allow_usb;
79 module_param(allow_usb, bool, 0644);
80 MODULE_PARM_DESC(allow_usb, "Allow USB charge drawing default current");
84 struct power_supply ac;
85 struct power_supply usb;
86 struct usb_phy *transceiver;
87 struct notifier_block usb_nb;
88 struct work_struct work;
91 struct regulator *usb_reg;
98 * clear and set bits on an given register on a given module
100 static int twl4030_clear_set(u8 mod_no, u8 clear, u8 set, u8 reg)
105 ret = twl_i2c_read_u8(mod_no, &val, reg);
112 return twl_i2c_write_u8(mod_no, val, reg);
115 static int twl4030_bci_read(u8 reg, u8 *val)
117 return twl_i2c_read_u8(TWL_MODULE_MAIN_CHARGE, val, reg);
120 static int twl4030_clear_set_boot_bci(u8 clear, u8 set)
122 return twl4030_clear_set(TWL_MODULE_PM_MASTER, clear,
123 TWL4030_CONFIG_DONE | TWL4030_BCIAUTOWEN | set,
124 TWL4030_PM_MASTER_BOOT_BCI);
127 static int twl4030bci_read_adc_val(u8 reg)
133 ret = twl4030_bci_read(reg + 1, &val);
137 temp = (int)(val & 0x03) << 8;
140 ret = twl4030_bci_read(reg, &val);
148 * Check if VBUS power is present
150 static int twl4030_bci_have_vbus(struct twl4030_bci *bci)
155 ret = twl_i2c_read_u8(TWL_MODULE_PM_MASTER, &hwsts,
156 TWL4030_PM_MASTER_STS_HW_CONDITIONS);
160 dev_dbg(bci->dev, "check_vbus: HW_CONDITIONS %02x\n", hwsts);
162 /* in case we also have STS_USB_ID, VBUS is driven by TWL itself */
163 if ((hwsts & TWL4030_STS_VBUS) && !(hwsts & TWL4030_STS_USB_ID))
170 * Enable/Disable USB Charge functionality.
172 static int twl4030_charger_enable_usb(struct twl4030_bci *bci, bool enable)
177 /* Check for USB charger connected */
178 if (!twl4030_bci_have_vbus(bci))
182 * Until we can find out what current the device can provide,
183 * require a module param to enable USB charging.
186 dev_warn(bci->dev, "USB charging is disabled.\n");
190 /* Need to keep regulator on */
191 if (!bci->usb_enabled) {
192 regulator_enable(bci->usb_reg);
193 bci->usb_enabled = 1;
196 /* forcing the field BCIAUTOUSB (BOOT_BCI[1]) to 1 */
197 ret = twl4030_clear_set_boot_bci(0, TWL4030_BCIAUTOUSB);
201 /* forcing USBFASTMCHG(BCIMFSTS4[2]) to 1 */
202 ret = twl4030_clear_set(TWL_MODULE_MAIN_CHARGE, 0,
203 TWL4030_USBFASTMCHG, TWL4030_BCIMFSTS4);
205 ret = twl4030_clear_set_boot_bci(TWL4030_BCIAUTOUSB, 0);
206 if (bci->usb_enabled) {
207 regulator_disable(bci->usb_reg);
208 bci->usb_enabled = 0;
216 * Enable/Disable AC Charge funtionality.
218 static int twl4030_charger_enable_ac(bool enable)
223 ret = twl4030_clear_set_boot_bci(0, TWL4030_BCIAUTOAC);
225 ret = twl4030_clear_set_boot_bci(TWL4030_BCIAUTOAC, 0);
231 * Enable/Disable charging of Backup Battery.
233 static int twl4030_charger_enable_backup(int uvolt, int uamp)
238 if (uvolt < 2500000 ||
240 /* disable charging of backup battery */
241 ret = twl4030_clear_set(TWL_MODULE_PM_RECEIVER,
242 TWL4030_BBCHEN, 0, TWL4030_BB_CFG);
246 flags = TWL4030_BBCHEN;
247 if (uvolt >= 3200000)
248 flags |= TWL4030_BBSEL_3V2;
249 else if (uvolt >= 3100000)
250 flags |= TWL4030_BBSEL_3V1;
251 else if (uvolt >= 3000000)
252 flags |= TWL4030_BBSEL_3V0;
254 flags |= TWL4030_BBSEL_2V5;
257 flags |= TWL4030_BBISEL_1000uA;
258 else if (uamp >= 500)
259 flags |= TWL4030_BBISEL_500uA;
260 else if (uamp >= 150)
261 flags |= TWL4030_BBISEL_150uA;
263 flags |= TWL4030_BBISEL_25uA;
265 ret = twl4030_clear_set(TWL_MODULE_PM_RECEIVER,
266 TWL4030_BBSEL_MASK | TWL4030_BBISEL_MASK,
274 * TWL4030 CHG_PRES (AC charger presence) events
276 static irqreturn_t twl4030_charger_interrupt(int irq, void *arg)
278 struct twl4030_bci *bci = arg;
280 dev_dbg(bci->dev, "CHG_PRES irq\n");
281 power_supply_changed(&bci->ac);
282 power_supply_changed(&bci->usb);
288 * TWL4030 BCI monitoring events
290 static irqreturn_t twl4030_bci_interrupt(int irq, void *arg)
292 struct twl4030_bci *bci = arg;
296 ret = twl_i2c_read_u8(TWL4030_MODULE_INTERRUPTS, &irqs1,
297 TWL4030_INTERRUPTS_BCIISR1A);
301 ret = twl_i2c_read_u8(TWL4030_MODULE_INTERRUPTS, &irqs2,
302 TWL4030_INTERRUPTS_BCIISR2A);
306 dev_dbg(bci->dev, "BCI irq %02x %02x\n", irqs2, irqs1);
308 if (irqs1 & (TWL4030_ICHGLOW | TWL4030_ICHGEOC)) {
309 /* charger state change, inform the core */
310 power_supply_changed(&bci->ac);
311 power_supply_changed(&bci->usb);
314 /* various monitoring events, for now we just log them here */
315 if (irqs1 & (TWL4030_TBATOR2 | TWL4030_TBATOR1))
316 dev_warn(bci->dev, "battery temperature out of range\n");
318 if (irqs1 & TWL4030_BATSTS)
319 dev_crit(bci->dev, "battery disconnected\n");
321 if (irqs2 & TWL4030_VBATOV)
322 dev_crit(bci->dev, "VBAT overvoltage\n");
324 if (irqs2 & TWL4030_VBUSOV)
325 dev_crit(bci->dev, "VBUS overvoltage\n");
327 if (irqs2 & TWL4030_ACCHGOV)
328 dev_crit(bci->dev, "Ac charger overvoltage\n");
333 static void twl4030_bci_usb_work(struct work_struct *data)
335 struct twl4030_bci *bci = container_of(data, struct twl4030_bci, work);
337 switch (bci->event) {
339 case USB_EVENT_CHARGER:
340 twl4030_charger_enable_usb(bci, true);
343 twl4030_charger_enable_usb(bci, false);
348 static int twl4030_bci_usb_ncb(struct notifier_block *nb, unsigned long val,
351 struct twl4030_bci *bci = container_of(nb, struct twl4030_bci, usb_nb);
353 dev_dbg(bci->dev, "OTG notify %lu\n", val);
356 schedule_work(&bci->work);
362 * TI provided formulas:
363 * CGAIN == 0: ICHG = (BCIICHG * 1.7) / (2^10 - 1) - 0.85
364 * CGAIN == 1: ICHG = (BCIICHG * 3.4) / (2^10 - 1) - 1.7
365 * Here we use integer approximation of:
366 * CGAIN == 0: val * 1.6618 - 0.85
367 * CGAIN == 1: (val * 1.6618 - 0.85) * 2
369 static int twl4030_charger_get_current(void)
375 curr = twl4030bci_read_adc_val(TWL4030_BCIICHG);
379 ret = twl4030_bci_read(TWL4030_BCICTL1, &bcictl1);
383 ret = (curr * 16618 - 850 * 10000) / 10;
384 if (bcictl1 & TWL4030_CGAIN)
391 * Returns the main charge FSM state
394 static int twl4030bci_state(struct twl4030_bci *bci)
399 ret = twl4030_bci_read(TWL4030_BCIMSTATEC, &state);
401 pr_err("twl4030_bci: error reading BCIMSTATEC\n");
405 dev_dbg(bci->dev, "state: %02x\n", state);
410 static int twl4030_bci_state_to_status(int state)
412 state &= TWL4030_MSTATEC_MASK;
413 if (TWL4030_MSTATEC_QUICK1 <= state && state <= TWL4030_MSTATEC_QUICK7)
414 return POWER_SUPPLY_STATUS_CHARGING;
415 else if (TWL4030_MSTATEC_COMPLETE1 <= state &&
416 state <= TWL4030_MSTATEC_COMPLETE4)
417 return POWER_SUPPLY_STATUS_FULL;
419 return POWER_SUPPLY_STATUS_NOT_CHARGING;
422 static int twl4030_bci_get_property(struct power_supply *psy,
423 enum power_supply_property psp,
424 union power_supply_propval *val)
426 struct twl4030_bci *bci = dev_get_drvdata(psy->dev->parent);
431 state = twl4030bci_state(bci);
435 if (psy->type == POWER_SUPPLY_TYPE_USB)
436 is_charging = state & TWL4030_MSTATEC_USB;
438 is_charging = state & TWL4030_MSTATEC_AC;
441 case POWER_SUPPLY_PROP_STATUS:
443 val->intval = twl4030_bci_state_to_status(state);
445 val->intval = POWER_SUPPLY_STATUS_NOT_CHARGING;
447 case POWER_SUPPLY_PROP_VOLTAGE_NOW:
448 /* charging must be active for meaningful result */
451 if (psy->type == POWER_SUPPLY_TYPE_USB) {
452 ret = twl4030bci_read_adc_val(TWL4030_BCIVBUS);
455 /* BCIVBUS uses ADCIN8, 7/1023 V/step */
456 val->intval = ret * 6843;
458 ret = twl4030bci_read_adc_val(TWL4030_BCIVAC);
461 /* BCIVAC uses ADCIN11, 10/1023 V/step */
462 val->intval = ret * 9775;
465 case POWER_SUPPLY_PROP_CURRENT_NOW:
468 /* current measurement is shared between AC and USB */
469 ret = twl4030_charger_get_current();
474 case POWER_SUPPLY_PROP_ONLINE:
475 val->intval = is_charging &&
476 twl4030_bci_state_to_status(state) !=
477 POWER_SUPPLY_STATUS_NOT_CHARGING;
486 static enum power_supply_property twl4030_charger_props[] = {
487 POWER_SUPPLY_PROP_STATUS,
488 POWER_SUPPLY_PROP_ONLINE,
489 POWER_SUPPLY_PROP_VOLTAGE_NOW,
490 POWER_SUPPLY_PROP_CURRENT_NOW,
493 static int __init twl4030_bci_probe(struct platform_device *pdev)
495 struct twl4030_bci *bci;
496 struct twl4030_bci_platform_data *pdata = pdev->dev.platform_data;
500 bci = kzalloc(sizeof(*bci), GFP_KERNEL);
504 bci->dev = &pdev->dev;
505 bci->irq_chg = platform_get_irq(pdev, 0);
506 bci->irq_bci = platform_get_irq(pdev, 1);
508 platform_set_drvdata(pdev, bci);
510 bci->ac.name = "twl4030_ac";
511 bci->ac.type = POWER_SUPPLY_TYPE_MAINS;
512 bci->ac.properties = twl4030_charger_props;
513 bci->ac.num_properties = ARRAY_SIZE(twl4030_charger_props);
514 bci->ac.get_property = twl4030_bci_get_property;
516 ret = power_supply_register(&pdev->dev, &bci->ac);
518 dev_err(&pdev->dev, "failed to register ac: %d\n", ret);
519 goto fail_register_ac;
522 bci->usb.name = "twl4030_usb";
523 bci->usb.type = POWER_SUPPLY_TYPE_USB;
524 bci->usb.properties = twl4030_charger_props;
525 bci->usb.num_properties = ARRAY_SIZE(twl4030_charger_props);
526 bci->usb.get_property = twl4030_bci_get_property;
528 bci->usb_reg = regulator_get(bci->dev, "bci3v1");
530 ret = power_supply_register(&pdev->dev, &bci->usb);
532 dev_err(&pdev->dev, "failed to register usb: %d\n", ret);
533 goto fail_register_usb;
536 ret = request_threaded_irq(bci->irq_chg, NULL,
537 twl4030_charger_interrupt, IRQF_ONESHOT, pdev->name,
540 dev_err(&pdev->dev, "could not request irq %d, status %d\n",
545 ret = request_threaded_irq(bci->irq_bci, NULL,
546 twl4030_bci_interrupt, IRQF_ONESHOT, pdev->name, bci);
548 dev_err(&pdev->dev, "could not request irq %d, status %d\n",
553 INIT_WORK(&bci->work, twl4030_bci_usb_work);
555 bci->transceiver = usb_get_phy(USB_PHY_TYPE_USB2);
556 if (!IS_ERR_OR_NULL(bci->transceiver)) {
557 bci->usb_nb.notifier_call = twl4030_bci_usb_ncb;
558 usb_register_notifier(bci->transceiver, &bci->usb_nb);
561 /* Enable interrupts now. */
562 reg = ~(u32)(TWL4030_ICHGLOW | TWL4030_ICHGEOC | TWL4030_TBATOR2 |
563 TWL4030_TBATOR1 | TWL4030_BATSTS);
564 ret = twl_i2c_write_u8(TWL4030_MODULE_INTERRUPTS, reg,
565 TWL4030_INTERRUPTS_BCIIMR1A);
567 dev_err(&pdev->dev, "failed to unmask interrupts: %d\n", ret);
568 goto fail_unmask_interrupts;
571 reg = ~(u32)(TWL4030_VBATOV | TWL4030_VBUSOV | TWL4030_ACCHGOV);
572 ret = twl_i2c_write_u8(TWL4030_MODULE_INTERRUPTS, reg,
573 TWL4030_INTERRUPTS_BCIIMR2A);
575 dev_warn(&pdev->dev, "failed to unmask interrupts: %d\n", ret);
577 twl4030_charger_enable_ac(true);
578 twl4030_charger_enable_usb(bci, true);
579 twl4030_charger_enable_backup(pdata->bb_uvolt,
584 fail_unmask_interrupts:
585 if (!IS_ERR_OR_NULL(bci->transceiver)) {
586 usb_unregister_notifier(bci->transceiver, &bci->usb_nb);
587 usb_put_phy(bci->transceiver);
589 free_irq(bci->irq_bci, bci);
591 free_irq(bci->irq_chg, bci);
593 power_supply_unregister(&bci->usb);
595 power_supply_unregister(&bci->ac);
597 platform_set_drvdata(pdev, NULL);
603 static int __exit twl4030_bci_remove(struct platform_device *pdev)
605 struct twl4030_bci *bci = platform_get_drvdata(pdev);
607 twl4030_charger_enable_ac(false);
608 twl4030_charger_enable_usb(bci, false);
609 twl4030_charger_enable_backup(0, 0);
611 /* mask interrupts */
612 twl_i2c_write_u8(TWL4030_MODULE_INTERRUPTS, 0xff,
613 TWL4030_INTERRUPTS_BCIIMR1A);
614 twl_i2c_write_u8(TWL4030_MODULE_INTERRUPTS, 0xff,
615 TWL4030_INTERRUPTS_BCIIMR2A);
617 if (!IS_ERR_OR_NULL(bci->transceiver)) {
618 usb_unregister_notifier(bci->transceiver, &bci->usb_nb);
619 usb_put_phy(bci->transceiver);
621 free_irq(bci->irq_bci, bci);
622 free_irq(bci->irq_chg, bci);
623 power_supply_unregister(&bci->usb);
624 power_supply_unregister(&bci->ac);
625 platform_set_drvdata(pdev, NULL);
631 static struct platform_driver twl4030_bci_driver = {
633 .name = "twl4030_bci",
634 .owner = THIS_MODULE,
636 .remove = __exit_p(twl4030_bci_remove),
639 static int __init twl4030_bci_init(void)
641 return platform_driver_probe(&twl4030_bci_driver, twl4030_bci_probe);
643 module_init(twl4030_bci_init);
645 static void __exit twl4030_bci_exit(void)
647 platform_driver_unregister(&twl4030_bci_driver);
649 module_exit(twl4030_bci_exit);
651 MODULE_AUTHOR("Gražvydas Ignotas");
652 MODULE_DESCRIPTION("TWL4030 Battery Charger Interface driver");
653 MODULE_LICENSE("GPL");
654 MODULE_ALIAS("platform:twl4030_bci");