1 // SPDX-License-Identifier: GPL-2.0-only
3 * TI LP8788 MFD - battery charger driver
5 * Copyright 2012 Texas Instruments
7 * Author: Milo(Woogyom) Kim <milo.kim@ti.com>
10 #include <linux/err.h>
11 #include <linux/iio/consumer.h>
12 #include <linux/interrupt.h>
13 #include <linux/irqdomain.h>
14 #include <linux/mfd/lp8788.h>
15 #include <linux/module.h>
16 #include <linux/platform_device.h>
17 #include <linux/power_supply.h>
18 #include <linux/slab.h>
19 #include <linux/workqueue.h>
21 /* register address */
22 #define LP8788_CHG_STATUS 0x07
23 #define LP8788_CHG_IDCIN 0x13
24 #define LP8788_CHG_IBATT 0x14
25 #define LP8788_CHG_VTERM 0x15
26 #define LP8788_CHG_EOC 0x16
29 #define LP8788_CHG_INPUT_STATE_M 0x03 /* Addr 07h */
30 #define LP8788_CHG_STATE_M 0x3C
31 #define LP8788_CHG_STATE_S 2
32 #define LP8788_NO_BATT_M BIT(6)
33 #define LP8788_BAD_BATT_M BIT(7)
34 #define LP8788_CHG_IBATT_M 0x1F /* Addr 14h */
35 #define LP8788_CHG_VTERM_M 0x0F /* Addr 15h */
36 #define LP8788_CHG_EOC_LEVEL_M 0x30 /* Addr 16h */
37 #define LP8788_CHG_EOC_LEVEL_S 4
38 #define LP8788_CHG_EOC_TIME_M 0x0E
39 #define LP8788_CHG_EOC_TIME_S 1
40 #define LP8788_CHG_EOC_MODE_M BIT(0)
42 #define LP8788_CHARGER_NAME "charger"
43 #define LP8788_BATTERY_NAME "main_batt"
45 #define LP8788_CHG_START 0x11
46 #define LP8788_CHG_END 0x1C
48 #define LP8788_ISEL_MAX 23
49 #define LP8788_ISEL_STEP 50
50 #define LP8788_VTERM_MIN 4100
51 #define LP8788_VTERM_STEP 25
52 #define LP8788_MAX_BATT_CAPACITY 100
53 #define LP8788_MAX_CHG_IRQS 11
55 enum lp8788_charging_state
{
58 LP8788_LOW_INPUT
= 0x3,
64 LP8788_SYSTEM_SUPPORT
= 0xC,
65 LP8788_HIGH_CURRENT
= 0xF,
69 enum lp8788_charger_adc_sel
{
75 enum lp8788_charger_input_state
{
76 LP8788_SYSTEM_SUPPLY
= 1,
81 * struct lp8788_chg_irq
82 * @which : lp8788 interrupt id
83 * @virq : Linux IRQ number from irq_domain
85 struct lp8788_chg_irq
{
86 enum lp8788_int_id which
;
91 * struct lp8788_charger
92 * @lp : used for accessing the registers of mfd lp8788 device
93 * @charger : power supply driver for the battery charger
94 * @battery : power supply driver for the battery
95 * @charger_work : work queue for charger input interrupts
96 * @chan : iio channels for getting adc values
97 * eg) battery voltage, capacity and temperature
98 * @irqs : charger dedicated interrupts
99 * @num_irqs : total numbers of charger interrupts
100 * @pdata : charger platform specific data
102 struct lp8788_charger
{
104 struct power_supply
*charger
;
105 struct power_supply
*battery
;
106 struct work_struct charger_work
;
107 struct iio_channel
*chan
[LP8788_NUM_CHG_ADC
];
108 struct lp8788_chg_irq irqs
[LP8788_MAX_CHG_IRQS
];
110 struct lp8788_charger_platform_data
*pdata
;
113 static char *battery_supplied_to
[] = {
117 static enum power_supply_property lp8788_charger_prop
[] = {
118 POWER_SUPPLY_PROP_ONLINE
,
119 POWER_SUPPLY_PROP_CURRENT_MAX
,
122 static enum power_supply_property lp8788_battery_prop
[] = {
123 POWER_SUPPLY_PROP_STATUS
,
124 POWER_SUPPLY_PROP_HEALTH
,
125 POWER_SUPPLY_PROP_PRESENT
,
126 POWER_SUPPLY_PROP_VOLTAGE_NOW
,
127 POWER_SUPPLY_PROP_CAPACITY
,
128 POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT
,
129 POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX
,
130 POWER_SUPPLY_PROP_TEMP
,
133 static bool lp8788_is_charger_detected(struct lp8788_charger
*pchg
)
137 lp8788_read_byte(pchg
->lp
, LP8788_CHG_STATUS
, &data
);
138 data
&= LP8788_CHG_INPUT_STATE_M
;
140 return data
== LP8788_SYSTEM_SUPPLY
|| data
== LP8788_FULL_FUNCTION
;
143 static int lp8788_charger_get_property(struct power_supply
*psy
,
144 enum power_supply_property psp
,
145 union power_supply_propval
*val
)
147 struct lp8788_charger
*pchg
= dev_get_drvdata(psy
->dev
.parent
);
151 case POWER_SUPPLY_PROP_ONLINE
:
152 val
->intval
= lp8788_is_charger_detected(pchg
);
154 case POWER_SUPPLY_PROP_CURRENT_MAX
:
155 lp8788_read_byte(pchg
->lp
, LP8788_CHG_IDCIN
, &read
);
156 val
->intval
= LP8788_ISEL_STEP
*
157 (min_t(int, read
, LP8788_ISEL_MAX
) + 1);
166 static int lp8788_get_battery_status(struct lp8788_charger
*pchg
,
167 union power_supply_propval
*val
)
169 enum lp8788_charging_state state
;
173 ret
= lp8788_read_byte(pchg
->lp
, LP8788_CHG_STATUS
, &data
);
177 state
= (data
& LP8788_CHG_STATE_M
) >> LP8788_CHG_STATE_S
;
180 val
->intval
= POWER_SUPPLY_STATUS_DISCHARGING
;
182 case LP8788_PRECHARGE
:
185 case LP8788_HIGH_CURRENT
:
186 val
->intval
= POWER_SUPPLY_STATUS_CHARGING
;
188 case LP8788_MAINTENANCE
:
189 val
->intval
= POWER_SUPPLY_STATUS_FULL
;
192 val
->intval
= POWER_SUPPLY_STATUS_NOT_CHARGING
;
199 static int lp8788_get_battery_health(struct lp8788_charger
*pchg
,
200 union power_supply_propval
*val
)
205 ret
= lp8788_read_byte(pchg
->lp
, LP8788_CHG_STATUS
, &data
);
209 if (data
& LP8788_NO_BATT_M
)
210 val
->intval
= POWER_SUPPLY_HEALTH_UNSPEC_FAILURE
;
211 else if (data
& LP8788_BAD_BATT_M
)
212 val
->intval
= POWER_SUPPLY_HEALTH_DEAD
;
214 val
->intval
= POWER_SUPPLY_HEALTH_GOOD
;
219 static int lp8788_get_battery_present(struct lp8788_charger
*pchg
,
220 union power_supply_propval
*val
)
225 ret
= lp8788_read_byte(pchg
->lp
, LP8788_CHG_STATUS
, &data
);
229 val
->intval
= !(data
& LP8788_NO_BATT_M
);
233 static int lp8788_get_vbatt_adc(struct lp8788_charger
*pchg
, int *result
)
235 struct iio_channel
*channel
= pchg
->chan
[LP8788_VBATT
];
240 return iio_read_channel_processed(channel
, result
);
243 static int lp8788_get_battery_voltage(struct lp8788_charger
*pchg
,
244 union power_supply_propval
*val
)
246 return lp8788_get_vbatt_adc(pchg
, &val
->intval
);
249 static int lp8788_get_battery_capacity(struct lp8788_charger
*pchg
,
250 union power_supply_propval
*val
)
252 struct lp8788
*lp
= pchg
->lp
;
253 struct lp8788_charger_platform_data
*pdata
= pchg
->pdata
;
254 unsigned int max_vbatt
;
256 enum lp8788_charging_state state
;
263 max_vbatt
= pdata
->max_vbatt_mv
;
267 ret
= lp8788_read_byte(lp
, LP8788_CHG_STATUS
, &data
);
271 state
= (data
& LP8788_CHG_STATE_M
) >> LP8788_CHG_STATE_S
;
273 if (state
== LP8788_MAINTENANCE
) {
274 val
->intval
= LP8788_MAX_BATT_CAPACITY
;
276 ret
= lp8788_get_vbatt_adc(pchg
, &vbatt
);
280 val
->intval
= (vbatt
* LP8788_MAX_BATT_CAPACITY
) / max_vbatt
;
281 val
->intval
= min(val
->intval
, LP8788_MAX_BATT_CAPACITY
);
287 static int lp8788_get_battery_temperature(struct lp8788_charger
*pchg
,
288 union power_supply_propval
*val
)
290 struct iio_channel
*channel
= pchg
->chan
[LP8788_BATT_TEMP
];
297 ret
= iio_read_channel_processed(channel
, &result
);
302 val
->intval
= result
* 10;
307 static int lp8788_get_battery_charging_current(struct lp8788_charger
*pchg
,
308 union power_supply_propval
*val
)
312 lp8788_read_byte(pchg
->lp
, LP8788_CHG_IBATT
, &read
);
313 read
&= LP8788_CHG_IBATT_M
;
314 val
->intval
= LP8788_ISEL_STEP
*
315 (min_t(int, read
, LP8788_ISEL_MAX
) + 1);
320 static int lp8788_get_charging_termination_voltage(struct lp8788_charger
*pchg
,
321 union power_supply_propval
*val
)
325 lp8788_read_byte(pchg
->lp
, LP8788_CHG_VTERM
, &read
);
326 read
&= LP8788_CHG_VTERM_M
;
327 val
->intval
= LP8788_VTERM_MIN
+ LP8788_VTERM_STEP
* read
;
332 static int lp8788_battery_get_property(struct power_supply
*psy
,
333 enum power_supply_property psp
,
334 union power_supply_propval
*val
)
336 struct lp8788_charger
*pchg
= dev_get_drvdata(psy
->dev
.parent
);
339 case POWER_SUPPLY_PROP_STATUS
:
340 return lp8788_get_battery_status(pchg
, val
);
341 case POWER_SUPPLY_PROP_HEALTH
:
342 return lp8788_get_battery_health(pchg
, val
);
343 case POWER_SUPPLY_PROP_PRESENT
:
344 return lp8788_get_battery_present(pchg
, val
);
345 case POWER_SUPPLY_PROP_VOLTAGE_NOW
:
346 return lp8788_get_battery_voltage(pchg
, val
);
347 case POWER_SUPPLY_PROP_CAPACITY
:
348 return lp8788_get_battery_capacity(pchg
, val
);
349 case POWER_SUPPLY_PROP_TEMP
:
350 return lp8788_get_battery_temperature(pchg
, val
);
351 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_CURRENT
:
352 return lp8788_get_battery_charging_current(pchg
, val
);
353 case POWER_SUPPLY_PROP_CONSTANT_CHARGE_VOLTAGE_MAX
:
354 return lp8788_get_charging_termination_voltage(pchg
, val
);
360 static inline bool lp8788_is_valid_charger_register(u8 addr
)
362 return addr
>= LP8788_CHG_START
&& addr
<= LP8788_CHG_END
;
365 static int lp8788_update_charger_params(struct platform_device
*pdev
,
366 struct lp8788_charger
*pchg
)
368 struct lp8788
*lp
= pchg
->lp
;
369 struct lp8788_charger_platform_data
*pdata
= pchg
->pdata
;
370 struct lp8788_chg_param
*param
;
374 if (!pdata
|| !pdata
->chg_params
) {
375 dev_info(&pdev
->dev
, "skip updating charger parameters\n");
379 /* settting charging parameters */
380 for (i
= 0; i
< pdata
->num_chg_params
; i
++) {
381 param
= pdata
->chg_params
+ i
;
383 if (lp8788_is_valid_charger_register(param
->addr
)) {
384 ret
= lp8788_write_byte(lp
, param
->addr
, param
->val
);
393 static const struct power_supply_desc lp8788_psy_charger_desc
= {
394 .name
= LP8788_CHARGER_NAME
,
395 .type
= POWER_SUPPLY_TYPE_MAINS
,
396 .properties
= lp8788_charger_prop
,
397 .num_properties
= ARRAY_SIZE(lp8788_charger_prop
),
398 .get_property
= lp8788_charger_get_property
,
401 static const struct power_supply_desc lp8788_psy_battery_desc
= {
402 .name
= LP8788_BATTERY_NAME
,
403 .type
= POWER_SUPPLY_TYPE_BATTERY
,
404 .properties
= lp8788_battery_prop
,
405 .num_properties
= ARRAY_SIZE(lp8788_battery_prop
),
406 .get_property
= lp8788_battery_get_property
,
409 static void lp8788_psy_unregister(struct lp8788_charger
*pchg
)
411 power_supply_unregister(pchg
->battery
);
412 power_supply_unregister(pchg
->charger
);
415 static void lp8788_charger_event(struct work_struct
*work
)
417 struct lp8788_charger
*pchg
=
418 container_of(work
, struct lp8788_charger
, charger_work
);
419 struct lp8788_charger_platform_data
*pdata
= pchg
->pdata
;
420 enum lp8788_charger_event event
= lp8788_is_charger_detected(pchg
);
422 pdata
->charger_event(pchg
->lp
, event
);
425 static bool lp8788_find_irq_id(struct lp8788_charger
*pchg
, int virq
, int *id
)
430 for (i
= 0; i
< pchg
->num_irqs
; i
++) {
431 if (pchg
->irqs
[i
].virq
== virq
) {
432 *id
= pchg
->irqs
[i
].which
;
441 static irqreturn_t
lp8788_charger_irq_thread(int virq
, void *ptr
)
443 struct lp8788_charger
*pchg
= ptr
;
444 struct lp8788_charger_platform_data
*pdata
= pchg
->pdata
;
447 if (!lp8788_find_irq_id(pchg
, virq
, &id
))
451 case LP8788_INT_CHG_INPUT_STATE
:
452 case LP8788_INT_CHG_STATE
:
454 case LP8788_INT_BATT_LOW
:
455 case LP8788_INT_NO_BATT
:
456 power_supply_changed(pchg
->charger
);
457 power_supply_changed(pchg
->battery
);
463 /* report charger dectection event if used */
467 if (pdata
->charger_event
&& id
== LP8788_INT_CHG_INPUT_STATE
)
468 schedule_work(&pchg
->charger_work
);
474 static int lp8788_set_irqs(struct platform_device
*pdev
,
475 struct lp8788_charger
*pchg
, const char *name
)
478 struct irq_domain
*irqdm
= pchg
->lp
->irqdm
;
486 /* no error even if no irq resource */
487 r
= platform_get_resource_byname(pdev
, IORESOURCE_IRQ
, name
);
491 irq_start
= r
->start
;
494 for (i
= irq_start
; i
<= irq_end
; i
++) {
495 nr_irq
= pchg
->num_irqs
;
497 virq
= irq_create_mapping(irqdm
, i
);
498 pchg
->irqs
[nr_irq
].virq
= virq
;
499 pchg
->irqs
[nr_irq
].which
= i
;
502 ret
= request_threaded_irq(virq
, NULL
,
503 lp8788_charger_irq_thread
,
515 for (i
= 0; i
< pchg
->num_irqs
; i
++)
516 free_irq(pchg
->irqs
[i
].virq
, pchg
);
520 static int lp8788_irq_register(struct platform_device
*pdev
,
521 struct lp8788_charger
*pchg
)
523 const char *name
[] = {
524 LP8788_CHG_IRQ
, LP8788_PRSW_IRQ
, LP8788_BATT_IRQ
529 INIT_WORK(&pchg
->charger_work
, lp8788_charger_event
);
532 for (i
= 0; i
< ARRAY_SIZE(name
); i
++) {
533 ret
= lp8788_set_irqs(pdev
, pchg
, name
[i
]);
535 dev_warn(&pdev
->dev
, "irq setup failed: %s\n", name
[i
]);
540 if (pchg
->num_irqs
> LP8788_MAX_CHG_IRQS
) {
541 dev_err(&pdev
->dev
, "invalid total number of irqs: %d\n",
550 static void lp8788_irq_unregister(struct platform_device
*pdev
,
551 struct lp8788_charger
*pchg
)
556 for (i
= 0; i
< pchg
->num_irqs
; i
++) {
557 irq
= pchg
->irqs
[i
].virq
;
565 static void lp8788_setup_adc_channel(struct device
*dev
,
566 struct lp8788_charger
*pchg
)
568 struct lp8788_charger_platform_data
*pdata
= pchg
->pdata
;
569 struct iio_channel
*chan
;
574 /* ADC channel for battery voltage */
575 chan
= devm_iio_channel_get(dev
, pdata
->adc_vbatt
);
576 pchg
->chan
[LP8788_VBATT
] = IS_ERR(chan
) ? NULL
: chan
;
578 /* ADC channel for battery temperature */
579 chan
= devm_iio_channel_get(dev
, pdata
->adc_batt_temp
);
580 pchg
->chan
[LP8788_BATT_TEMP
] = IS_ERR(chan
) ? NULL
: chan
;
583 static ssize_t
lp8788_show_charger_status(struct device
*dev
,
584 struct device_attribute
*attr
, char *buf
)
586 struct lp8788_charger
*pchg
= dev_get_drvdata(dev
);
587 enum lp8788_charging_state state
;
588 static const char * const desc
[LP8788_MAX_CHG_STATE
] = {
589 [LP8788_OFF
] = "CHARGER OFF",
590 [LP8788_WARM_UP
] = "WARM UP",
591 [LP8788_LOW_INPUT
] = "LOW INPUT STATE",
592 [LP8788_PRECHARGE
] = "CHARGING - PRECHARGE",
593 [LP8788_CC
] = "CHARGING - CC",
594 [LP8788_CV
] = "CHARGING - CV",
595 [LP8788_MAINTENANCE
] = "NO CHARGING - MAINTENANCE",
596 [LP8788_BATTERY_FAULT
] = "BATTERY FAULT",
597 [LP8788_SYSTEM_SUPPORT
] = "SYSTEM SUPPORT",
598 [LP8788_HIGH_CURRENT
] = "HIGH CURRENT",
602 lp8788_read_byte(pchg
->lp
, LP8788_CHG_STATUS
, &data
);
603 state
= (data
& LP8788_CHG_STATE_M
) >> LP8788_CHG_STATE_S
;
605 return scnprintf(buf
, PAGE_SIZE
, "%s\n", desc
[state
]);
608 static ssize_t
lp8788_show_eoc_time(struct device
*dev
,
609 struct device_attribute
*attr
, char *buf
)
611 struct lp8788_charger
*pchg
= dev_get_drvdata(dev
);
612 static const char * const stime
[] = {
613 "400ms", "5min", "10min", "15min",
614 "20min", "25min", "30min", "No timeout"
618 lp8788_read_byte(pchg
->lp
, LP8788_CHG_EOC
, &val
);
619 val
= (val
& LP8788_CHG_EOC_TIME_M
) >> LP8788_CHG_EOC_TIME_S
;
621 return scnprintf(buf
, PAGE_SIZE
, "End Of Charge Time: %s\n",
625 static ssize_t
lp8788_show_eoc_level(struct device
*dev
,
626 struct device_attribute
*attr
, char *buf
)
628 struct lp8788_charger
*pchg
= dev_get_drvdata(dev
);
629 static const char * const abs_level
[] = {
630 "25mA", "49mA", "75mA", "98mA"
632 static const char * const relative_level
[] = {
633 "5%", "10%", "15%", "20%"
639 lp8788_read_byte(pchg
->lp
, LP8788_CHG_EOC
, &val
);
641 mode
= val
& LP8788_CHG_EOC_MODE_M
;
642 val
= (val
& LP8788_CHG_EOC_LEVEL_M
) >> LP8788_CHG_EOC_LEVEL_S
;
643 level
= mode
? abs_level
[val
] : relative_level
[val
];
645 return scnprintf(buf
, PAGE_SIZE
, "End Of Charge Level: %s\n", level
);
648 static DEVICE_ATTR(charger_status
, S_IRUSR
, lp8788_show_charger_status
, NULL
);
649 static DEVICE_ATTR(eoc_time
, S_IRUSR
, lp8788_show_eoc_time
, NULL
);
650 static DEVICE_ATTR(eoc_level
, S_IRUSR
, lp8788_show_eoc_level
, NULL
);
652 static struct attribute
*lp8788_charger_sysfs_attrs
[] = {
653 &dev_attr_charger_status
.attr
,
654 &dev_attr_eoc_time
.attr
,
655 &dev_attr_eoc_level
.attr
,
659 ATTRIBUTE_GROUPS(lp8788_charger_sysfs
);
661 static int lp8788_psy_register(struct platform_device
*pdev
,
662 struct lp8788_charger
*pchg
)
664 struct power_supply_config charger_cfg
= {};
666 charger_cfg
.attr_grp
= lp8788_charger_sysfs_groups
;
667 charger_cfg
.supplied_to
= battery_supplied_to
;
668 charger_cfg
.num_supplicants
= ARRAY_SIZE(battery_supplied_to
);
670 pchg
->charger
= power_supply_register(&pdev
->dev
,
671 &lp8788_psy_charger_desc
,
673 if (IS_ERR(pchg
->charger
))
676 pchg
->battery
= power_supply_register(&pdev
->dev
,
677 &lp8788_psy_battery_desc
, NULL
);
678 if (IS_ERR(pchg
->battery
)) {
679 power_supply_unregister(pchg
->charger
);
686 static int lp8788_charger_probe(struct platform_device
*pdev
)
688 struct lp8788
*lp
= dev_get_drvdata(pdev
->dev
.parent
);
689 struct lp8788_charger
*pchg
;
690 struct device
*dev
= &pdev
->dev
;
693 pchg
= devm_kzalloc(dev
, sizeof(struct lp8788_charger
), GFP_KERNEL
);
698 pchg
->pdata
= lp
->pdata
? lp
->pdata
->chg_pdata
: NULL
;
699 platform_set_drvdata(pdev
, pchg
);
701 ret
= lp8788_update_charger_params(pdev
, pchg
);
705 lp8788_setup_adc_channel(&pdev
->dev
, pchg
);
707 ret
= lp8788_psy_register(pdev
, pchg
);
711 ret
= lp8788_irq_register(pdev
, pchg
);
713 dev_warn(dev
, "failed to register charger irq: %d\n", ret
);
718 static int lp8788_charger_remove(struct platform_device
*pdev
)
720 struct lp8788_charger
*pchg
= platform_get_drvdata(pdev
);
722 flush_work(&pchg
->charger_work
);
723 lp8788_irq_unregister(pdev
, pchg
);
724 lp8788_psy_unregister(pchg
);
729 static struct platform_driver lp8788_charger_driver
= {
730 .probe
= lp8788_charger_probe
,
731 .remove
= lp8788_charger_remove
,
733 .name
= LP8788_DEV_CHARGER
,
736 module_platform_driver(lp8788_charger_driver
);
738 MODULE_DESCRIPTION("TI LP8788 Charger Driver");
739 MODULE_AUTHOR("Milo Kim");
740 MODULE_LICENSE("GPL");
741 MODULE_ALIAS("platform:lp8788-charger");