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_BCIMFSTS3 0x0F
32 #define TWL4030_BCIMFSTS4 0x10
33 #define TWL4030_BCICTL1 0x23
34 #define TWL4030_BB_CFG 0x12
36 #define TWL4030_BCIMFSTS1 0x01
38 #define TWL4030_BCIAUTOWEN BIT(5)
39 #define TWL4030_CONFIG_DONE BIT(4)
40 #define TWL4030_BCIAUTOUSB BIT(1)
41 #define TWL4030_BCIAUTOAC BIT(0)
42 #define TWL4030_CGAIN BIT(5)
43 #define TWL4030_USBFASTMCHG BIT(2)
44 #define TWL4030_STS_VBUS BIT(7)
45 #define TWL4030_STS_USB_ID BIT(2)
46 #define TWL4030_BBCHEN BIT(4)
47 #define TWL4030_BBSEL_MASK 0x0c
48 #define TWL4030_BBSEL_2V5 0x00
49 #define TWL4030_BBSEL_3V0 0x04
50 #define TWL4030_BBSEL_3V1 0x08
51 #define TWL4030_BBSEL_3V2 0x0c
52 #define TWL4030_BBISEL_MASK 0x03
53 #define TWL4030_BBISEL_25uA 0x00
54 #define TWL4030_BBISEL_150uA 0x01
55 #define TWL4030_BBISEL_500uA 0x02
56 #define TWL4030_BBISEL_1000uA 0x03
58 #define TWL4030_BATSTSPCHG BIT(2)
59 #define TWL4030_BATSTSMCHG BIT(6)
62 #define TWL4030_WOVF BIT(0) /* Watchdog overflow */
63 #define TWL4030_TMOVF BIT(1) /* Timer overflow */
64 #define TWL4030_ICHGHIGH BIT(2) /* Battery charge current high */
65 #define TWL4030_ICHGLOW BIT(3) /* Battery cc. low / FSM state change */
66 #define TWL4030_ICHGEOC BIT(4) /* Battery current end-of-charge */
67 #define TWL4030_TBATOR2 BIT(5) /* Battery temperature out of range 2 */
68 #define TWL4030_TBATOR1 BIT(6) /* Battery temperature out of range 1 */
69 #define TWL4030_BATSTS BIT(7) /* Battery status */
71 #define TWL4030_VBATLVL BIT(0) /* VBAT level */
72 #define TWL4030_VBATOV BIT(1) /* VBAT overvoltage */
73 #define TWL4030_VBUSOV BIT(2) /* VBUS overvoltage */
74 #define TWL4030_ACCHGOV BIT(3) /* Ac charger overvoltage */
76 #define TWL4030_MSTATEC_USB BIT(4)
77 #define TWL4030_MSTATEC_AC BIT(5)
78 #define TWL4030_MSTATEC_MASK 0x0f
79 #define TWL4030_MSTATEC_QUICK1 0x02
80 #define TWL4030_MSTATEC_QUICK7 0x07
81 #define TWL4030_MSTATEC_COMPLETE1 0x0b
82 #define TWL4030_MSTATEC_COMPLETE4 0x0e
84 static bool allow_usb
;
85 module_param(allow_usb
, bool, 0644);
86 MODULE_PARM_DESC(allow_usb
, "Allow USB charge drawing default current");
90 struct power_supply ac
;
91 struct power_supply usb
;
92 struct usb_phy
*transceiver
;
93 struct notifier_block usb_nb
;
94 struct work_struct work
;
97 struct regulator
*usb_reg
;
104 * clear and set bits on an given register on a given module
106 static int twl4030_clear_set(u8 mod_no
, u8 clear
, u8 set
, u8 reg
)
111 ret
= twl_i2c_read_u8(mod_no
, &val
, reg
);
118 return twl_i2c_write_u8(mod_no
, val
, reg
);
121 static int twl4030_bci_read(u8 reg
, u8
*val
)
123 return twl_i2c_read_u8(TWL_MODULE_MAIN_CHARGE
, val
, reg
);
126 static int twl4030_clear_set_boot_bci(u8 clear
, u8 set
)
128 return twl4030_clear_set(TWL_MODULE_PM_MASTER
, clear
,
129 TWL4030_CONFIG_DONE
| TWL4030_BCIAUTOWEN
| set
,
130 TWL4030_PM_MASTER_BOOT_BCI
);
133 static int twl4030bci_read_adc_val(u8 reg
)
139 ret
= twl4030_bci_read(reg
+ 1, &val
);
143 temp
= (int)(val
& 0x03) << 8;
146 ret
= twl4030_bci_read(reg
, &val
);
154 * Check if Battery Pack was present
156 static int twl4030_is_battery_present(struct twl4030_bci
*bci
)
161 /* Battery presence in Main charge? */
162 ret
= twl_i2c_read_u8(TWL_MODULE_MAIN_CHARGE
, &val
, TWL4030_BCIMFSTS3
);
165 if (val
& TWL4030_BATSTSMCHG
)
169 * OK, It could be that bootloader did not enable main charger,
170 * pre-charge is h/w auto. So, Battery presence in Pre-charge?
172 ret
= twl_i2c_read_u8(TWL4030_MODULE_PRECHARGE
, &val
,
176 if (val
& TWL4030_BATSTSPCHG
)
183 * Check if VBUS power is present
185 static int twl4030_bci_have_vbus(struct twl4030_bci
*bci
)
190 ret
= twl_i2c_read_u8(TWL_MODULE_PM_MASTER
, &hwsts
,
191 TWL4030_PM_MASTER_STS_HW_CONDITIONS
);
195 dev_dbg(bci
->dev
, "check_vbus: HW_CONDITIONS %02x\n", hwsts
);
197 /* in case we also have STS_USB_ID, VBUS is driven by TWL itself */
198 if ((hwsts
& TWL4030_STS_VBUS
) && !(hwsts
& TWL4030_STS_USB_ID
))
205 * Enable/Disable USB Charge functionality.
207 static int twl4030_charger_enable_usb(struct twl4030_bci
*bci
, bool enable
)
212 /* Check for USB charger connected */
213 if (!twl4030_bci_have_vbus(bci
))
217 * Until we can find out what current the device can provide,
218 * require a module param to enable USB charging.
221 dev_warn(bci
->dev
, "USB charging is disabled.\n");
225 /* Need to keep regulator on */
226 if (!bci
->usb_enabled
) {
227 ret
= regulator_enable(bci
->usb_reg
);
230 "Failed to enable regulator\n");
233 bci
->usb_enabled
= 1;
236 /* forcing the field BCIAUTOUSB (BOOT_BCI[1]) to 1 */
237 ret
= twl4030_clear_set_boot_bci(0, TWL4030_BCIAUTOUSB
);
241 /* forcing USBFASTMCHG(BCIMFSTS4[2]) to 1 */
242 ret
= twl4030_clear_set(TWL_MODULE_MAIN_CHARGE
, 0,
243 TWL4030_USBFASTMCHG
, TWL4030_BCIMFSTS4
);
245 ret
= twl4030_clear_set_boot_bci(TWL4030_BCIAUTOUSB
, 0);
246 if (bci
->usb_enabled
) {
247 regulator_disable(bci
->usb_reg
);
248 bci
->usb_enabled
= 0;
256 * Enable/Disable AC Charge funtionality.
258 static int twl4030_charger_enable_ac(bool enable
)
263 ret
= twl4030_clear_set_boot_bci(0, TWL4030_BCIAUTOAC
);
265 ret
= twl4030_clear_set_boot_bci(TWL4030_BCIAUTOAC
, 0);
271 * Enable/Disable charging of Backup Battery.
273 static int twl4030_charger_enable_backup(int uvolt
, int uamp
)
278 if (uvolt
< 2500000 ||
280 /* disable charging of backup battery */
281 ret
= twl4030_clear_set(TWL_MODULE_PM_RECEIVER
,
282 TWL4030_BBCHEN
, 0, TWL4030_BB_CFG
);
286 flags
= TWL4030_BBCHEN
;
287 if (uvolt
>= 3200000)
288 flags
|= TWL4030_BBSEL_3V2
;
289 else if (uvolt
>= 3100000)
290 flags
|= TWL4030_BBSEL_3V1
;
291 else if (uvolt
>= 3000000)
292 flags
|= TWL4030_BBSEL_3V0
;
294 flags
|= TWL4030_BBSEL_2V5
;
297 flags
|= TWL4030_BBISEL_1000uA
;
298 else if (uamp
>= 500)
299 flags
|= TWL4030_BBISEL_500uA
;
300 else if (uamp
>= 150)
301 flags
|= TWL4030_BBISEL_150uA
;
303 flags
|= TWL4030_BBISEL_25uA
;
305 ret
= twl4030_clear_set(TWL_MODULE_PM_RECEIVER
,
306 TWL4030_BBSEL_MASK
| TWL4030_BBISEL_MASK
,
314 * TWL4030 CHG_PRES (AC charger presence) events
316 static irqreturn_t
twl4030_charger_interrupt(int irq
, void *arg
)
318 struct twl4030_bci
*bci
= arg
;
320 dev_dbg(bci
->dev
, "CHG_PRES irq\n");
321 power_supply_changed(&bci
->ac
);
322 power_supply_changed(&bci
->usb
);
328 * TWL4030 BCI monitoring events
330 static irqreturn_t
twl4030_bci_interrupt(int irq
, void *arg
)
332 struct twl4030_bci
*bci
= arg
;
336 ret
= twl_i2c_read_u8(TWL4030_MODULE_INTERRUPTS
, &irqs1
,
337 TWL4030_INTERRUPTS_BCIISR1A
);
341 ret
= twl_i2c_read_u8(TWL4030_MODULE_INTERRUPTS
, &irqs2
,
342 TWL4030_INTERRUPTS_BCIISR2A
);
346 dev_dbg(bci
->dev
, "BCI irq %02x %02x\n", irqs2
, irqs1
);
348 if (irqs1
& (TWL4030_ICHGLOW
| TWL4030_ICHGEOC
)) {
349 /* charger state change, inform the core */
350 power_supply_changed(&bci
->ac
);
351 power_supply_changed(&bci
->usb
);
354 /* various monitoring events, for now we just log them here */
355 if (irqs1
& (TWL4030_TBATOR2
| TWL4030_TBATOR1
))
356 dev_warn(bci
->dev
, "battery temperature out of range\n");
358 if (irqs1
& TWL4030_BATSTS
)
359 dev_crit(bci
->dev
, "battery disconnected\n");
361 if (irqs2
& TWL4030_VBATOV
)
362 dev_crit(bci
->dev
, "VBAT overvoltage\n");
364 if (irqs2
& TWL4030_VBUSOV
)
365 dev_crit(bci
->dev
, "VBUS overvoltage\n");
367 if (irqs2
& TWL4030_ACCHGOV
)
368 dev_crit(bci
->dev
, "Ac charger overvoltage\n");
373 static void twl4030_bci_usb_work(struct work_struct
*data
)
375 struct twl4030_bci
*bci
= container_of(data
, struct twl4030_bci
, work
);
377 switch (bci
->event
) {
379 case USB_EVENT_CHARGER
:
380 twl4030_charger_enable_usb(bci
, true);
383 twl4030_charger_enable_usb(bci
, false);
388 static int twl4030_bci_usb_ncb(struct notifier_block
*nb
, unsigned long val
,
391 struct twl4030_bci
*bci
= container_of(nb
, struct twl4030_bci
, usb_nb
);
393 dev_dbg(bci
->dev
, "OTG notify %lu\n", val
);
396 schedule_work(&bci
->work
);
402 * TI provided formulas:
403 * CGAIN == 0: ICHG = (BCIICHG * 1.7) / (2^10 - 1) - 0.85
404 * CGAIN == 1: ICHG = (BCIICHG * 3.4) / (2^10 - 1) - 1.7
405 * Here we use integer approximation of:
406 * CGAIN == 0: val * 1.6618 - 0.85
407 * CGAIN == 1: (val * 1.6618 - 0.85) * 2
409 static int twl4030_charger_get_current(void)
415 curr
= twl4030bci_read_adc_val(TWL4030_BCIICHG
);
419 ret
= twl4030_bci_read(TWL4030_BCICTL1
, &bcictl1
);
423 ret
= (curr
* 16618 - 850 * 10000) / 10;
424 if (bcictl1
& TWL4030_CGAIN
)
431 * Returns the main charge FSM state
434 static int twl4030bci_state(struct twl4030_bci
*bci
)
439 ret
= twl4030_bci_read(TWL4030_BCIMSTATEC
, &state
);
441 pr_err("twl4030_bci: error reading BCIMSTATEC\n");
445 dev_dbg(bci
->dev
, "state: %02x\n", state
);
450 static int twl4030_bci_state_to_status(int state
)
452 state
&= TWL4030_MSTATEC_MASK
;
453 if (TWL4030_MSTATEC_QUICK1
<= state
&& state
<= TWL4030_MSTATEC_QUICK7
)
454 return POWER_SUPPLY_STATUS_CHARGING
;
455 else if (TWL4030_MSTATEC_COMPLETE1
<= state
&&
456 state
<= TWL4030_MSTATEC_COMPLETE4
)
457 return POWER_SUPPLY_STATUS_FULL
;
459 return POWER_SUPPLY_STATUS_NOT_CHARGING
;
462 static int twl4030_bci_get_property(struct power_supply
*psy
,
463 enum power_supply_property psp
,
464 union power_supply_propval
*val
)
466 struct twl4030_bci
*bci
= dev_get_drvdata(psy
->dev
->parent
);
471 state
= twl4030bci_state(bci
);
475 if (psy
->type
== POWER_SUPPLY_TYPE_USB
)
476 is_charging
= state
& TWL4030_MSTATEC_USB
;
478 is_charging
= state
& TWL4030_MSTATEC_AC
;
481 case POWER_SUPPLY_PROP_STATUS
:
483 val
->intval
= twl4030_bci_state_to_status(state
);
485 val
->intval
= POWER_SUPPLY_STATUS_NOT_CHARGING
;
487 case POWER_SUPPLY_PROP_VOLTAGE_NOW
:
488 /* charging must be active for meaningful result */
491 if (psy
->type
== POWER_SUPPLY_TYPE_USB
) {
492 ret
= twl4030bci_read_adc_val(TWL4030_BCIVBUS
);
495 /* BCIVBUS uses ADCIN8, 7/1023 V/step */
496 val
->intval
= ret
* 6843;
498 ret
= twl4030bci_read_adc_val(TWL4030_BCIVAC
);
501 /* BCIVAC uses ADCIN11, 10/1023 V/step */
502 val
->intval
= ret
* 9775;
505 case POWER_SUPPLY_PROP_CURRENT_NOW
:
508 /* current measurement is shared between AC and USB */
509 ret
= twl4030_charger_get_current();
514 case POWER_SUPPLY_PROP_ONLINE
:
515 val
->intval
= is_charging
&&
516 twl4030_bci_state_to_status(state
) !=
517 POWER_SUPPLY_STATUS_NOT_CHARGING
;
526 static enum power_supply_property twl4030_charger_props
[] = {
527 POWER_SUPPLY_PROP_STATUS
,
528 POWER_SUPPLY_PROP_ONLINE
,
529 POWER_SUPPLY_PROP_VOLTAGE_NOW
,
530 POWER_SUPPLY_PROP_CURRENT_NOW
,
534 static const struct twl4030_bci_platform_data
*
535 twl4030_bci_parse_dt(struct device
*dev
)
537 struct device_node
*np
= dev
->of_node
;
538 struct twl4030_bci_platform_data
*pdata
;
543 pdata
= devm_kzalloc(dev
, sizeof(*pdata
), GFP_KERNEL
);
547 if (of_property_read_u32(np
, "ti,bb-uvolt", &num
) == 0)
548 pdata
->bb_uvolt
= num
;
549 if (of_property_read_u32(np
, "ti,bb-uamp", &num
) == 0)
550 pdata
->bb_uamp
= num
;
554 static inline const struct twl4030_bci_platform_data
*
555 twl4030_bci_parse_dt(struct device
*dev
)
561 static int __init
twl4030_bci_probe(struct platform_device
*pdev
)
563 struct twl4030_bci
*bci
;
564 const struct twl4030_bci_platform_data
*pdata
= pdev
->dev
.platform_data
;
568 bci
= kzalloc(sizeof(*bci
), GFP_KERNEL
);
573 pdata
= twl4030_bci_parse_dt(&pdev
->dev
);
575 bci
->dev
= &pdev
->dev
;
576 bci
->irq_chg
= platform_get_irq(pdev
, 0);
577 bci
->irq_bci
= platform_get_irq(pdev
, 1);
579 /* Only proceed further *IF* battery is physically present */
580 ret
= twl4030_is_battery_present(bci
);
582 dev_crit(&pdev
->dev
, "Battery was not detected:%d\n", ret
);
583 goto fail_no_battery
;
586 platform_set_drvdata(pdev
, bci
);
587 bci
->ac
.name
= "twl4030_ac";
588 bci
->ac
.type
= POWER_SUPPLY_TYPE_MAINS
;
589 bci
->ac
.properties
= twl4030_charger_props
;
590 bci
->ac
.num_properties
= ARRAY_SIZE(twl4030_charger_props
);
591 bci
->ac
.get_property
= twl4030_bci_get_property
;
593 ret
= power_supply_register(&pdev
->dev
, &bci
->ac
);
595 dev_err(&pdev
->dev
, "failed to register ac: %d\n", ret
);
596 goto fail_register_ac
;
599 bci
->usb
.name
= "twl4030_usb";
600 bci
->usb
.type
= POWER_SUPPLY_TYPE_USB
;
601 bci
->usb
.properties
= twl4030_charger_props
;
602 bci
->usb
.num_properties
= ARRAY_SIZE(twl4030_charger_props
);
603 bci
->usb
.get_property
= twl4030_bci_get_property
;
605 bci
->usb_reg
= regulator_get(bci
->dev
, "bci3v1");
607 ret
= power_supply_register(&pdev
->dev
, &bci
->usb
);
609 dev_err(&pdev
->dev
, "failed to register usb: %d\n", ret
);
610 goto fail_register_usb
;
613 ret
= request_threaded_irq(bci
->irq_chg
, NULL
,
614 twl4030_charger_interrupt
, IRQF_ONESHOT
, pdev
->name
,
617 dev_err(&pdev
->dev
, "could not request irq %d, status %d\n",
622 ret
= request_threaded_irq(bci
->irq_bci
, NULL
,
623 twl4030_bci_interrupt
, IRQF_ONESHOT
, pdev
->name
, bci
);
625 dev_err(&pdev
->dev
, "could not request irq %d, status %d\n",
630 INIT_WORK(&bci
->work
, twl4030_bci_usb_work
);
632 bci
->transceiver
= usb_get_phy(USB_PHY_TYPE_USB2
);
633 if (!IS_ERR_OR_NULL(bci
->transceiver
)) {
634 bci
->usb_nb
.notifier_call
= twl4030_bci_usb_ncb
;
635 usb_register_notifier(bci
->transceiver
, &bci
->usb_nb
);
638 /* Enable interrupts now. */
639 reg
= ~(u32
)(TWL4030_ICHGLOW
| TWL4030_ICHGEOC
| TWL4030_TBATOR2
|
640 TWL4030_TBATOR1
| TWL4030_BATSTS
);
641 ret
= twl_i2c_write_u8(TWL4030_MODULE_INTERRUPTS
, reg
,
642 TWL4030_INTERRUPTS_BCIIMR1A
);
644 dev_err(&pdev
->dev
, "failed to unmask interrupts: %d\n", ret
);
645 goto fail_unmask_interrupts
;
648 reg
= ~(u32
)(TWL4030_VBATOV
| TWL4030_VBUSOV
| TWL4030_ACCHGOV
);
649 ret
= twl_i2c_write_u8(TWL4030_MODULE_INTERRUPTS
, reg
,
650 TWL4030_INTERRUPTS_BCIIMR2A
);
652 dev_warn(&pdev
->dev
, "failed to unmask interrupts: %d\n", ret
);
654 twl4030_charger_enable_ac(true);
655 twl4030_charger_enable_usb(bci
, true);
657 twl4030_charger_enable_backup(pdata
->bb_uvolt
,
660 twl4030_charger_enable_backup(0, 0);
664 fail_unmask_interrupts
:
665 if (!IS_ERR_OR_NULL(bci
->transceiver
)) {
666 usb_unregister_notifier(bci
->transceiver
, &bci
->usb_nb
);
667 usb_put_phy(bci
->transceiver
);
669 free_irq(bci
->irq_bci
, bci
);
671 free_irq(bci
->irq_chg
, bci
);
673 power_supply_unregister(&bci
->usb
);
675 power_supply_unregister(&bci
->ac
);
683 static int __exit
twl4030_bci_remove(struct platform_device
*pdev
)
685 struct twl4030_bci
*bci
= platform_get_drvdata(pdev
);
687 twl4030_charger_enable_ac(false);
688 twl4030_charger_enable_usb(bci
, false);
689 twl4030_charger_enable_backup(0, 0);
691 /* mask interrupts */
692 twl_i2c_write_u8(TWL4030_MODULE_INTERRUPTS
, 0xff,
693 TWL4030_INTERRUPTS_BCIIMR1A
);
694 twl_i2c_write_u8(TWL4030_MODULE_INTERRUPTS
, 0xff,
695 TWL4030_INTERRUPTS_BCIIMR2A
);
697 if (!IS_ERR_OR_NULL(bci
->transceiver
)) {
698 usb_unregister_notifier(bci
->transceiver
, &bci
->usb_nb
);
699 usb_put_phy(bci
->transceiver
);
701 free_irq(bci
->irq_bci
, bci
);
702 free_irq(bci
->irq_chg
, bci
);
703 power_supply_unregister(&bci
->usb
);
704 power_supply_unregister(&bci
->ac
);
710 static const struct of_device_id twl_bci_of_match
[] = {
711 {.compatible
= "ti,twl4030-bci", },
714 MODULE_DEVICE_TABLE(of
, twl_bci_of_match
);
716 static struct platform_driver twl4030_bci_driver
= {
718 .name
= "twl4030_bci",
719 .of_match_table
= of_match_ptr(twl_bci_of_match
),
721 .remove
= __exit_p(twl4030_bci_remove
),
724 module_platform_driver_probe(twl4030_bci_driver
, twl4030_bci_probe
);
726 MODULE_AUTHOR("Gražvydas Ignotas");
727 MODULE_DESCRIPTION("TWL4030 Battery Charger Interface driver");
728 MODULE_LICENSE("GPL");
729 MODULE_ALIAS("platform:twl4030_bci");