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/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>
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
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)
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 */
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 */
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
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");
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;
78 bool ac_charge_enable;
79 bool usb_charge_enable;
82 struct ratelimit_state ratelimit;
86 * clear and set bits on an given register on a given module
88 static int twl4030_clear_set(u8 mod_no, u8 clear, u8 set, u8 reg)
93 ret = twl_i2c_read_u8(mod_no, &val, reg);
100 return twl_i2c_write_u8(mod_no, val, reg);
103 static int twl4030_bci_read(u8 reg, u8 *val)
105 return twl_i2c_read_u8(TWL4030_MODULE_MAIN_CHARGE, val, reg);
108 static int twl4030_clear_set_boot_bci(u8 clear, u8 set)
110 return twl4030_clear_set(TWL4030_MODULE_PM_MASTER, 0,
111 TWL4030_CONFIG_DONE | TWL4030_BCIAUTOWEN | set,
112 TWL4030_PM_MASTER_BOOT_BCI);
115 static int twl4030bci_read_adc_val(u8 reg)
121 ret = twl4030_bci_read(reg + 1, &val);
125 temp = (int)(val & 0x03) << 8;
128 ret = twl4030_bci_read(reg, &val);
136 * Check if VBUS power is present
138 static int twl4030_bci_have_vbus(struct twl4030_bci *bci)
143 ret = twl_i2c_read_u8(TWL4030_MODULE_PM_MASTER, &hwsts,
144 TWL4030_PM_MASTER_STS_HW_CONDITIONS);
148 dev_dbg(bci->dev, "check_vbus: HW_CONDITIONS %02x\n", hwsts);
150 /* in case we also have STS_USB_ID, VBUS is driven by TWL itself */
151 if ((hwsts & TWL4030_STS_VBUS) && !(hwsts & TWL4030_STS_USB_ID))
158 * Enable/Disable USB Charge funtionality.
160 static int twl4030_charger_enable_usb(struct twl4030_bci *bci, bool enable)
165 if (!bci->usb_charge_enable)
168 /* Check for USB charger conneted */
169 if (!twl4030_bci_have_vbus(bci))
173 * Until we can find out what current the device can provide,
174 * require a module param to enable USB charging.
177 dev_warn(bci->dev, "USB charging is disabled.\n");
181 /* forcing the field BCIAUTOUSB (BOOT_BCI[1]) to 1 */
182 ret = twl4030_clear_set_boot_bci(0, TWL4030_BCIAUTOUSB);
186 /* forcing USBFASTMCHG(BCIMFSTS4[2]) to 1 */
187 ret = twl4030_clear_set(TWL4030_MODULE_MAIN_CHARGE, 0,
188 TWL4030_USBFASTMCHG, TWL4030_BCIMFSTS4);
190 ret = twl4030_clear_set_boot_bci(TWL4030_BCIAUTOUSB, 0);
197 * Enable/Disable AC Charge funtionality.
199 static int twl4030_charger_enable_ac(bool enable)
204 ret = twl4030_clear_set_boot_bci(0, TWL4030_BCIAUTOAC);
206 ret = twl4030_clear_set_boot_bci(TWL4030_BCIAUTOAC, 0);
212 * TWL4030 CHG_PRES (AC charger presence) events
214 static irqreturn_t twl4030_charger_interrupt(int irq, void *arg)
216 struct twl4030_bci *bci = arg;
218 dev_dbg(bci->dev, "CHG_PRES irq\n");
219 power_supply_changed(&bci->ac);
220 power_supply_changed(&bci->usb);
226 * TWL4030 BCI monitoring events
228 static irqreturn_t twl4030_bci_interrupt(int irq, void *arg)
230 struct twl4030_bci *bci = arg;
234 ret = twl_i2c_read_u8(TWL4030_MODULE_INTERRUPTS, &irqs1,
235 TWL4030_INTERRUPTS_BCIISR1A);
239 ret = twl_i2c_read_u8(TWL4030_MODULE_INTERRUPTS, &irqs2,
240 TWL4030_INTERRUPTS_BCIISR2A);
244 dev_dbg(bci->dev, "BCI irq %02x %02x\n", irqs2, irqs1);
246 if (irqs1 & (TWL4030_ICHGLOW | TWL4030_ICHGEOC)) {
247 /* charger state change, inform the core */
248 power_supply_changed(&bci->ac);
249 power_supply_changed(&bci->usb);
252 /* various monitoring events, for now we just log them here */
253 if (irqs1 & (TWL4030_TBATOR2 | TWL4030_TBATOR1) &&
254 __ratelimit(&bci->ratelimit))
255 dev_warn(bci->dev, "battery temperature out of range\n");
257 if (irqs1 & TWL4030_BATSTS && __ratelimit(&bci->ratelimit))
258 dev_crit(bci->dev, "battery disconnected\n");
260 if (irqs2 & TWL4030_VBATOV && __ratelimit(&bci->ratelimit))
261 dev_crit(bci->dev, "VBAT overvoltage\n");
263 if (irqs2 & TWL4030_VBUSOV && __ratelimit(&bci->ratelimit))
264 dev_crit(bci->dev, "VBUS overvoltage\n");
266 if (irqs2 & TWL4030_ACCHGOV && __ratelimit(&bci->ratelimit))
267 dev_crit(bci->dev, "Ac charger overvoltage\n");
269 /* ack the interrupts */
270 twl_i2c_write_u8(TWL4030_MODULE_INTERRUPTS, irqs1,
271 TWL4030_INTERRUPTS_BCIISR1A);
272 twl_i2c_write_u8(TWL4030_MODULE_INTERRUPTS, irqs2,
273 TWL4030_INTERRUPTS_BCIISR2A);
278 static void twl4030_bci_usb_work(struct work_struct *data)
280 struct twl4030_bci *bci = container_of(data, struct twl4030_bci, work);
282 switch (bci->event) {
284 case USB_EVENT_CHARGER:
285 twl4030_charger_enable_usb(bci, true);
288 twl4030_charger_enable_usb(bci, false);
293 static int twl4030_bci_usb_ncb(struct notifier_block *nb, unsigned long val,
296 struct twl4030_bci *bci = container_of(nb, struct twl4030_bci, otg_nb);
298 dev_dbg(bci->dev, "OTG notify %lu\n", val);
301 schedule_work(&bci->work);
307 * TI provided formulas:
308 * CGAIN == 0: ICHG = (BCIICHG * 1.7) / (2^10 - 1) - 0.85
309 * CGAIN == 1: ICHG = (BCIICHG * 3.4) / (2^10 - 1) - 1.7
310 * Here we use integer approximation of:
311 * CGAIN == 0: val * 1.6618 - 0.85
312 * CGAIN == 1: (val * 1.6618 - 0.85) * 2
314 static int twl4030_charger_get_current(void)
320 curr = twl4030bci_read_adc_val(TWL4030_BCIICHG);
324 ret = twl4030_bci_read(TWL4030_BCICTL1, &bcictl1);
328 ret = (curr * 16618 - 850 * 10000) / 10;
329 if (bcictl1 & TWL4030_CGAIN)
335 static ssize_t twl4030_bci_ac_show_enable(struct device *dev,
336 struct device_attribute *attr,
342 ret = twl_i2c_read_u8(TWL4030_MODULE_PM_MASTER, &boot_bci,
343 TWL4030_PM_MASTER_BOOT_BCI);
347 return sprintf(buf, "%d\n", (boot_bci & TWL4030_BCIAUTOAC) ? 1 : 0);
350 static ssize_t twl4030_bci_ac_store_enable(struct device *dev,
351 struct device_attribute *attr,
352 const char *buf, size_t count)
354 struct power_supply *psy = dev_get_drvdata(dev);
355 struct twl4030_bci *bci = container_of(psy, struct twl4030_bci, ac);
356 unsigned long enable;
359 ret = strict_strtoul(buf, 10, &enable);
360 if (ret || enable > 1)
363 bci->ac_charge_enable = enable;
364 twl4030_charger_enable_ac(enable);
368 static const struct device_attribute dev_attr_enable_ac =
369 __ATTR(enable, S_IRUGO | S_IWUSR, twl4030_bci_ac_show_enable,
370 twl4030_bci_ac_store_enable);
372 static ssize_t twl4030_bci_usb_show_enable(struct device *dev,
373 struct device_attribute *attr,
379 ret = twl_i2c_read_u8(TWL4030_MODULE_PM_MASTER, &boot_bci,
380 TWL4030_PM_MASTER_BOOT_BCI);
384 return sprintf(buf, "%d\n", (boot_bci & TWL4030_BCIAUTOUSB) ? 1 : 0);
387 static ssize_t twl4030_bci_usb_store_enable(struct device *dev,
388 struct device_attribute *attr,
389 const char *buf, size_t count)
391 struct power_supply *psy = dev_get_drvdata(dev);
392 struct twl4030_bci *bci = container_of(psy, struct twl4030_bci, usb);
393 unsigned long enable;
396 ret = strict_strtoul(buf, 10, &enable);
397 if (ret || enable > 1)
400 bci->usb_charge_enable = enable;
401 twl4030_charger_enable_usb(bci, enable);
405 static const struct device_attribute dev_attr_enable_usb =
406 __ATTR(enable, S_IRUGO | S_IWUSR, twl4030_bci_usb_show_enable,
407 twl4030_bci_usb_store_enable);
410 * Returns the main charge FSM state
413 static int twl4030bci_state(struct twl4030_bci *bci)
418 ret = twl4030_bci_read(TWL4030_BCIMSTATEC, &state);
420 pr_err("twl4030_bci: error reading BCIMSTATEC\n");
424 dev_dbg(bci->dev, "state: %02x\n", state);
429 static int twl4030_bci_state_to_status(int state)
431 state &= TWL4030_MSTATEC_MASK;
432 if (TWL4030_MSTATEC_QUICK1 <= state && state <= TWL4030_MSTATEC_QUICK7)
433 return POWER_SUPPLY_STATUS_CHARGING;
434 else if (TWL4030_MSTATEC_COMPLETE1 <= state &&
435 state <= TWL4030_MSTATEC_COMPLETE4)
436 return POWER_SUPPLY_STATUS_FULL;
438 return POWER_SUPPLY_STATUS_NOT_CHARGING;
441 static int twl4030_bci_get_property(struct power_supply *psy,
442 enum power_supply_property psp,
443 union power_supply_propval *val)
445 struct twl4030_bci *bci = dev_get_drvdata(psy->dev->parent);
450 state = twl4030bci_state(bci);
454 if (psy->type == POWER_SUPPLY_TYPE_USB)
455 is_charging = state & TWL4030_MSTATEC_USB;
457 is_charging = state & TWL4030_MSTATEC_AC;
460 case POWER_SUPPLY_PROP_STATUS:
462 val->intval = twl4030_bci_state_to_status(state);
464 val->intval = POWER_SUPPLY_STATUS_NOT_CHARGING;
466 case POWER_SUPPLY_PROP_VOLTAGE_NOW:
467 /* charging must be active for meaningful result */
470 if (psy->type == POWER_SUPPLY_TYPE_USB) {
471 ret = twl4030bci_read_adc_val(TWL4030_BCIVBUS);
474 /* BCIVBUS uses ADCIN8, 7/1023 V/step */
475 val->intval = ret * 6843;
477 ret = twl4030bci_read_adc_val(TWL4030_BCIVAC);
480 /* BCIVAC uses ADCIN11, 10/1023 V/step */
481 val->intval = ret * 9775;
484 case POWER_SUPPLY_PROP_CURRENT_NOW:
487 /* current measurement is shared between AC and USB */
488 ret = twl4030_charger_get_current();
493 case POWER_SUPPLY_PROP_ONLINE:
494 val->intval = is_charging &&
495 twl4030_bci_state_to_status(state) !=
496 POWER_SUPPLY_STATUS_NOT_CHARGING;
505 static enum power_supply_property twl4030_charger_props[] = {
506 POWER_SUPPLY_PROP_STATUS,
507 POWER_SUPPLY_PROP_ONLINE,
508 POWER_SUPPLY_PROP_VOLTAGE_NOW,
509 POWER_SUPPLY_PROP_CURRENT_NOW,
512 static int __init twl4030_bci_probe(struct platform_device *pdev)
514 struct twl4030_bci *bci;
518 bci = kzalloc(sizeof(*bci), GFP_KERNEL);
522 bci->dev = &pdev->dev;
523 bci->irq_chg = platform_get_irq(pdev, 0);
524 bci->irq_bci = platform_get_irq(pdev, 1);
526 platform_set_drvdata(pdev, bci);
528 ratelimit_state_init(&bci->ratelimit, HZ, 2);
530 bci->ac.name = "twl4030_ac";
531 bci->ac.type = POWER_SUPPLY_TYPE_MAINS;
532 bci->ac.properties = twl4030_charger_props;
533 bci->ac.num_properties = ARRAY_SIZE(twl4030_charger_props);
534 bci->ac.get_property = twl4030_bci_get_property;
536 ret = power_supply_register(&pdev->dev, &bci->ac);
538 dev_err(&pdev->dev, "failed to register ac: %d\n", ret);
539 goto fail_register_ac;
542 bci->usb.name = "twl4030_usb";
543 bci->usb.type = POWER_SUPPLY_TYPE_USB;
544 bci->usb.properties = twl4030_charger_props;
545 bci->usb.num_properties = ARRAY_SIZE(twl4030_charger_props);
546 bci->usb.get_property = twl4030_bci_get_property;
548 ret = power_supply_register(&pdev->dev, &bci->usb);
550 dev_err(&pdev->dev, "failed to register usb: %d\n", ret);
551 goto fail_register_usb;
554 ret = request_threaded_irq(bci->irq_chg, NULL,
555 twl4030_charger_interrupt, 0, pdev->name, bci);
557 dev_err(&pdev->dev, "could not request irq %d, status %d\n",
562 ret = request_threaded_irq(bci->irq_bci, NULL,
563 twl4030_bci_interrupt, 0, pdev->name, bci);
565 dev_err(&pdev->dev, "could not request irq %d, status %d\n",
570 INIT_WORK(&bci->work, twl4030_bci_usb_work);
572 bci->transceiver = otg_get_transceiver();
573 if (bci->transceiver != NULL) {
574 bci->otg_nb.notifier_call = twl4030_bci_usb_ncb;
575 otg_register_notifier(bci->transceiver, &bci->otg_nb);
578 ret = device_create_file(bci->ac.dev, &dev_attr_enable_ac);
580 dev_err(&pdev->dev, "failed to create sysfs file: %d\n", ret);
584 ret = device_create_file(bci->usb.dev, &dev_attr_enable_usb);
586 dev_err(&pdev->dev, "failed to create sysfs file: %d\n", ret);
590 /* Enable interrupts now. */
591 reg = ~(u32)(TWL4030_ICHGLOW | TWL4030_ICHGEOC | TWL4030_TBATOR2 |
592 TWL4030_TBATOR1 | TWL4030_BATSTS);
593 ret = twl_i2c_write_u8(TWL4030_MODULE_INTERRUPTS, reg,
594 TWL4030_INTERRUPTS_BCIIMR1A);
596 dev_err(&pdev->dev, "failed to unmask interrupts: %d\n", ret);
597 goto fail_unmask_interrupts;
600 reg = ~(u32)(TWL4030_VBATOV | TWL4030_VBUSOV | TWL4030_ACCHGOV);
601 ret = twl_i2c_write_u8(TWL4030_MODULE_INTERRUPTS, reg,
602 TWL4030_INTERRUPTS_BCIIMR2A);
604 dev_warn(&pdev->dev, "failed to unmask interrupts: %d\n", ret);
606 bci->ac_charge_enable = true;
607 bci->usb_charge_enable = true;
608 twl4030_charger_enable_ac(true);
609 twl4030_charger_enable_usb(bci, true);
613 fail_unmask_interrupts:
614 device_remove_file(bci->usb.dev, &dev_attr_enable_usb);
616 device_remove_file(bci->ac.dev, &dev_attr_enable_ac);
618 if (bci->transceiver != NULL) {
619 otg_unregister_notifier(bci->transceiver, &bci->otg_nb);
620 otg_put_transceiver(bci->transceiver);
622 free_irq(bci->irq_bci, bci);
624 free_irq(bci->irq_chg, bci);
626 power_supply_unregister(&bci->usb);
628 power_supply_unregister(&bci->ac);
630 platform_set_drvdata(pdev, NULL);
636 static int __exit twl4030_bci_remove(struct platform_device *pdev)
638 struct twl4030_bci *bci = platform_get_drvdata(pdev);
640 device_remove_file(bci->usb.dev, &dev_attr_enable_usb);
641 device_remove_file(bci->ac.dev, &dev_attr_enable_ac);
643 twl4030_charger_enable_ac(false);
644 twl4030_charger_enable_usb(bci, false);
646 /* mask interrupts */
647 twl_i2c_write_u8(TWL4030_MODULE_INTERRUPTS, 0xff,
648 TWL4030_INTERRUPTS_BCIIMR1A);
649 twl_i2c_write_u8(TWL4030_MODULE_INTERRUPTS, 0xff,
650 TWL4030_INTERRUPTS_BCIIMR2A);
652 if (bci->transceiver != NULL) {
653 otg_unregister_notifier(bci->transceiver, &bci->otg_nb);
654 otg_put_transceiver(bci->transceiver);
656 free_irq(bci->irq_bci, bci);
657 free_irq(bci->irq_chg, bci);
658 power_supply_unregister(&bci->usb);
659 power_supply_unregister(&bci->ac);
660 platform_set_drvdata(pdev, NULL);
666 static struct platform_driver twl4030_bci_driver = {
668 .name = "twl4030_bci",
669 .owner = THIS_MODULE,
671 .remove = __exit_p(twl4030_bci_remove),
674 static int __init twl4030_bci_init(void)
676 return platform_driver_probe(&twl4030_bci_driver, twl4030_bci_probe);
678 module_init(twl4030_bci_init);
680 static void __exit twl4030_bci_exit(void)
682 platform_driver_unregister(&twl4030_bci_driver);
684 module_exit(twl4030_bci_exit);
686 MODULE_AUTHOR("Gražvydas Ignotas");
687 MODULE_DESCRIPTION("TWL4030 Battery Charger Interface driver");
688 MODULE_LICENSE("GPL");
689 MODULE_ALIAS("platform:twl4030_bci");