2 * Copyright (C) 2011 Samsung Electronics Co., Ltd.
3 * MyungJoo Ham <myungjoo.ham@samsung.com>
5 * This driver enables to monitor battery health and control charger
6 * during suspend-to-mem.
7 * Charger manager depends on other devices. register this later than
8 * the depending devices.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
16 #include <linux/module.h>
17 #include <linux/irq.h>
18 #include <linux/interrupt.h>
19 #include <linux/rtc.h>
20 #include <linux/slab.h>
21 #include <linux/workqueue.h>
22 #include <linux/platform_device.h>
23 #include <linux/power/charger-manager.h>
24 #include <linux/regulator/consumer.h>
27 * Regard CM_JIFFIES_SMALL jiffies is small enough to ignore for
28 * delayed works so that we can run delayed works with CM_JIFFIES_SMALL
31 #define CM_JIFFIES_SMALL (2)
33 /* If y is valid (> 0) and smaller than x, do x = y */
34 #define CM_MIN_VALID(x, y) x = (((y > 0) && ((x) > (y))) ? (y) : (x))
37 * Regard CM_RTC_SMALL (sec) is small enough to ignore error in invoking
38 * rtc alarm. It should be 2 or larger
40 #define CM_RTC_SMALL (2)
42 #define UEVENT_BUF_SIZE 32
44 static LIST_HEAD(cm_list
);
45 static DEFINE_MUTEX(cm_list_mtx
);
47 /* About in-suspend (suspend-again) monitoring */
48 static struct rtc_device
*rtc_dev
;
51 * Save the wakeup alarm before entering suspend-to-RAM
53 static struct rtc_wkalrm rtc_wkalarm_save
;
54 /* Backup RTC alarm time in terms of seconds since 01-01-1970 00:00:00 */
55 static unsigned long rtc_wkalarm_save_time
;
56 static bool cm_suspended
;
57 static bool cm_rtc_set
;
58 static unsigned long cm_suspend_duration_ms
;
60 /* Global charger-manager description */
61 static struct charger_global_desc
*g_desc
; /* init with setup_charger_manager */
64 * is_batt_present - See if the battery presents in place.
65 * @cm: the Charger Manager representing the battery.
67 static bool is_batt_present(struct charger_manager
*cm
)
69 union power_supply_propval val
;
73 switch (cm
->desc
->battery_present
) {
75 ret
= cm
->fuel_gauge
->get_property(cm
->fuel_gauge
,
76 POWER_SUPPLY_PROP_PRESENT
, &val
);
77 if (ret
== 0 && val
.intval
)
81 for (i
= 0; cm
->charger_stat
[i
]; i
++) {
82 ret
= cm
->charger_stat
[i
]->get_property(
84 POWER_SUPPLY_PROP_PRESENT
, &val
);
85 if (ret
== 0 && val
.intval
) {
97 * is_ext_pwr_online - See if an external power source is attached to charge
98 * @cm: the Charger Manager representing the battery.
100 * Returns true if at least one of the chargers of the battery has an external
101 * power source attached to charge the battery regardless of whether it is
102 * actually charging or not.
104 static bool is_ext_pwr_online(struct charger_manager
*cm
)
106 union power_supply_propval val
;
110 /* If at least one of them has one, it's yes. */
111 for (i
= 0; cm
->charger_stat
[i
]; i
++) {
112 ret
= cm
->charger_stat
[i
]->get_property(
114 POWER_SUPPLY_PROP_ONLINE
, &val
);
115 if (ret
== 0 && val
.intval
) {
125 * is_charging - Returns true if the battery is being charged.
126 * @cm: the Charger Manager representing the battery.
128 static bool is_charging(struct charger_manager
*cm
)
131 bool charging
= false;
132 union power_supply_propval val
;
134 /* If there is no battery, it cannot be charged */
135 if (!is_batt_present(cm
))
138 /* If at least one of the charger is charging, return yes */
139 for (i
= 0; cm
->charger_stat
[i
]; i
++) {
140 /* 1. The charger sholuld not be DISABLED */
141 if (cm
->emergency_stop
)
143 if (!cm
->charger_enabled
)
146 /* 2. The charger should be online (ext-power) */
147 ret
= cm
->charger_stat
[i
]->get_property(
149 POWER_SUPPLY_PROP_ONLINE
, &val
);
151 dev_warn(cm
->dev
, "Cannot read ONLINE value from %s.\n",
152 cm
->desc
->psy_charger_stat
[i
]);
159 * 3. The charger should not be FULL, DISCHARGING,
162 ret
= cm
->charger_stat
[i
]->get_property(
164 POWER_SUPPLY_PROP_STATUS
, &val
);
166 dev_warn(cm
->dev
, "Cannot read STATUS value from %s.\n",
167 cm
->desc
->psy_charger_stat
[i
]);
170 if (val
.intval
== POWER_SUPPLY_STATUS_FULL
||
171 val
.intval
== POWER_SUPPLY_STATUS_DISCHARGING
||
172 val
.intval
== POWER_SUPPLY_STATUS_NOT_CHARGING
)
175 /* Then, this is charging. */
184 * is_polling_required - Return true if need to continue polling for this CM.
185 * @cm: the Charger Manager representing the battery.
187 static bool is_polling_required(struct charger_manager
*cm
)
189 switch (cm
->desc
->polling_mode
) {
190 case CM_POLL_DISABLE
:
194 case CM_POLL_EXTERNAL_POWER_ONLY
:
195 return is_ext_pwr_online(cm
);
196 case CM_POLL_CHARGING_ONLY
:
197 return is_charging(cm
);
199 dev_warn(cm
->dev
, "Incorrect polling_mode (%d)\n",
200 cm
->desc
->polling_mode
);
207 * try_charger_enable - Enable/Disable chargers altogether
208 * @cm: the Charger Manager representing the battery.
209 * @enable: true: enable / false: disable
211 * Note that Charger Manager keeps the charger enabled regardless whether
212 * the charger is charging or not (because battery is full or no external
213 * power source exists) except when CM needs to disable chargers forcibly
214 * bacause of emergency causes; when the battery is overheated or too cold.
216 static int try_charger_enable(struct charger_manager
*cm
, bool enable
)
219 struct charger_desc
*desc
= cm
->desc
;
221 /* Ignore if it's redundent command */
222 if (enable
&& cm
->charger_enabled
)
224 if (!enable
&& !cm
->charger_enabled
)
228 if (cm
->emergency_stop
)
230 err
= regulator_bulk_enable(desc
->num_charger_regulators
,
231 desc
->charger_regulators
);
234 * Abnormal battery state - Stop charging forcibly,
235 * even if charger was enabled at the other places
237 err
= regulator_bulk_disable(desc
->num_charger_regulators
,
238 desc
->charger_regulators
);
240 for (i
= 0; i
< desc
->num_charger_regulators
; i
++) {
241 if (regulator_is_enabled(
242 desc
->charger_regulators
[i
].consumer
)) {
243 regulator_force_disable(
244 desc
->charger_regulators
[i
].consumer
);
246 "Disable regulator(%s) forcibly.\n",
247 desc
->charger_regulators
[i
].supply
);
253 cm
->charger_enabled
= enable
;
259 * uevent_notify - Let users know something has changed.
260 * @cm: the Charger Manager representing the battery.
261 * @event: the event string.
263 * If @event is null, it implies that uevent_notify is called
264 * by resume function. When called in the resume function, cm_suspended
265 * should be already reset to false in order to let uevent_notify
266 * notify the recent event during the suspend to users. While
267 * suspended, uevent_notify does not notify users, but tracks
268 * events so that uevent_notify can notify users later after resumed.
270 static void uevent_notify(struct charger_manager
*cm
, const char *event
)
272 static char env_str
[UEVENT_BUF_SIZE
+ 1] = "";
273 static char env_str_save
[UEVENT_BUF_SIZE
+ 1] = "";
276 /* Nothing in suspended-event buffer */
277 if (env_str_save
[0] == 0) {
278 if (!strncmp(env_str
, event
, UEVENT_BUF_SIZE
))
279 return; /* status not changed */
280 strncpy(env_str_save
, event
, UEVENT_BUF_SIZE
);
284 if (!strncmp(env_str_save
, event
, UEVENT_BUF_SIZE
))
285 return; /* Duplicated. */
287 strncpy(env_str_save
, event
, UEVENT_BUF_SIZE
);
293 /* No messages pending */
294 if (!env_str_save
[0])
297 strncpy(env_str
, env_str_save
, UEVENT_BUF_SIZE
);
298 kobject_uevent(&cm
->dev
->kobj
, KOBJ_CHANGE
);
304 /* status not changed */
305 if (!strncmp(env_str
, event
, UEVENT_BUF_SIZE
))
308 /* save the status and notify the update */
309 strncpy(env_str
, event
, UEVENT_BUF_SIZE
);
310 kobject_uevent(&cm
->dev
->kobj
, KOBJ_CHANGE
);
312 dev_info(cm
->dev
, event
);
316 * _cm_monitor - Monitor the temperature and return true for exceptions.
317 * @cm: the Charger Manager representing the battery.
319 * Returns true if there is an event to notify for the battery.
320 * (True if the status of "emergency_stop" changes)
322 static bool _cm_monitor(struct charger_manager
*cm
)
324 struct charger_desc
*desc
= cm
->desc
;
325 int temp
= desc
->temperature_out_of_range(&cm
->last_temp_mC
);
327 dev_dbg(cm
->dev
, "monitoring (%2.2d.%3.3dC)\n",
328 cm
->last_temp_mC
/ 1000, cm
->last_temp_mC
% 1000);
330 /* It has been stopped or charging already */
331 if (!!temp
== !!cm
->emergency_stop
)
335 cm
->emergency_stop
= temp
;
336 if (!try_charger_enable(cm
, false)) {
338 uevent_notify(cm
, "OVERHEAT");
340 uevent_notify(cm
, "COLD");
343 cm
->emergency_stop
= 0;
344 if (!try_charger_enable(cm
, true))
345 uevent_notify(cm
, "CHARGING");
352 * cm_monitor - Monitor every battery.
354 * Returns true if there is an event to notify from any of the batteries.
355 * (True if the status of "emergency_stop" changes)
357 static bool cm_monitor(void)
360 struct charger_manager
*cm
;
362 mutex_lock(&cm_list_mtx
);
364 list_for_each_entry(cm
, &cm_list
, entry
)
365 stop
= stop
|| _cm_monitor(cm
);
367 mutex_unlock(&cm_list_mtx
);
373 * cm_setup_timer - For in-suspend monitoring setup wakeup alarm
376 * Returns true if the alarm is set for Charger Manager to use.
378 * cm_setup_timer fails to set an alarm,
379 * cm_setup_timer does not need to set an alarm for Charger Manager,
380 * or an alarm previously configured is to be used.
382 static bool cm_setup_timer(void)
384 struct charger_manager
*cm
;
385 unsigned int wakeup_ms
= UINT_MAX
;
388 mutex_lock(&cm_list_mtx
);
390 list_for_each_entry(cm
, &cm_list
, entry
) {
391 /* Skip if polling is not required for this CM */
392 if (!is_polling_required(cm
) && !cm
->emergency_stop
)
394 if (cm
->desc
->polling_interval_ms
== 0)
396 CM_MIN_VALID(wakeup_ms
, cm
->desc
->polling_interval_ms
);
399 mutex_unlock(&cm_list_mtx
);
401 if (wakeup_ms
< UINT_MAX
&& wakeup_ms
> 0) {
402 pr_info("Charger Manager wakeup timer: %u ms.\n", wakeup_ms
);
404 struct rtc_wkalrm tmp
;
405 unsigned long time
, now
;
406 unsigned long add
= DIV_ROUND_UP(wakeup_ms
, 1000);
409 * Set alarm with the polling interval (wakeup_ms)
410 * except when rtc_wkalarm_save comes first.
411 * However, the alarm time should be NOW +
412 * CM_RTC_SMALL or later.
415 rtc_read_time(rtc_dev
, &tmp
.time
);
416 rtc_tm_to_time(&tmp
.time
, &now
);
417 if (add
< CM_RTC_SMALL
)
423 if (rtc_wkalarm_save
.enabled
&&
424 rtc_wkalarm_save_time
&&
425 rtc_wkalarm_save_time
< time
) {
426 if (rtc_wkalarm_save_time
< now
+ CM_RTC_SMALL
)
427 time
= now
+ CM_RTC_SMALL
;
429 time
= rtc_wkalarm_save_time
;
431 /* The timer is not appointed by CM */
435 pr_info("Waking up after %lu secs.\n",
438 rtc_time_to_tm(time
, &tmp
.time
);
439 rtc_set_alarm(rtc_dev
, &tmp
);
440 cm_suspend_duration_ms
+= wakeup_ms
;
446 rtc_set_alarm(rtc_dev
, &rtc_wkalarm_save
);
451 * cm_suspend_again - Determine whether suspend again or not
453 * Returns true if the system should be suspended again
454 * Returns false if the system should be woken up
456 bool cm_suspend_again(void)
458 struct charger_manager
*cm
;
461 if (!g_desc
|| !g_desc
->rtc_only_wakeup
|| !g_desc
->rtc_only_wakeup() ||
469 mutex_lock(&cm_list_mtx
);
470 list_for_each_entry(cm
, &cm_list
, entry
) {
471 if (cm
->status_save_ext_pwr_inserted
!= is_ext_pwr_online(cm
) ||
472 cm
->status_save_batt
!= is_batt_present(cm
))
475 mutex_unlock(&cm_list_mtx
);
477 cm_rtc_set
= cm_setup_timer();
479 /* It's about the time when the non-CM appointed timer goes off */
480 if (rtc_wkalarm_save
.enabled
) {
484 rtc_read_time(rtc_dev
, &tmp
);
485 rtc_tm_to_time(&tmp
, &now
);
487 if (rtc_wkalarm_save_time
&&
488 now
+ CM_RTC_SMALL
>= rtc_wkalarm_save_time
)
493 EXPORT_SYMBOL_GPL(cm_suspend_again
);
496 * setup_charger_manager - initialize charger_global_desc data
497 * @gd: pointer to instance of charger_global_desc
499 int setup_charger_manager(struct charger_global_desc
*gd
)
505 rtc_class_close(rtc_dev
);
509 if (!gd
->rtc_only_wakeup
) {
510 pr_err("The callback rtc_only_wakeup is not given.\n");
515 rtc_dev
= rtc_class_open(gd
->rtc_name
);
516 if (IS_ERR_OR_NULL(rtc_dev
)) {
518 /* Retry at probe. RTC may be not registered yet */
521 pr_warn("No wakeup timer is given for charger manager."
522 "In-suspend monitoring won't work.\n");
528 EXPORT_SYMBOL_GPL(setup_charger_manager
);
530 static int charger_manager_probe(struct platform_device
*pdev
)
532 struct charger_desc
*desc
= dev_get_platdata(&pdev
->dev
);
533 struct charger_manager
*cm
;
536 if (g_desc
&& !rtc_dev
&& g_desc
->rtc_name
) {
537 rtc_dev
= rtc_class_open(g_desc
->rtc_name
);
538 if (IS_ERR_OR_NULL(rtc_dev
)) {
540 dev_err(&pdev
->dev
, "Cannot get RTC %s.\n",
548 dev_err(&pdev
->dev
, "No platform data (desc) found.\n");
553 cm
= kzalloc(sizeof(struct charger_manager
), GFP_KERNEL
);
555 dev_err(&pdev
->dev
, "Cannot allocate memory.\n");
560 /* Basic Values. Unspecified are Null or 0 */
561 cm
->dev
= &pdev
->dev
;
562 cm
->desc
= kzalloc(sizeof(struct charger_desc
), GFP_KERNEL
);
564 dev_err(&pdev
->dev
, "Cannot allocate memory.\n");
568 memcpy(cm
->desc
, desc
, sizeof(struct charger_desc
));
569 cm
->last_temp_mC
= INT_MIN
; /* denotes "unmeasured, yet" */
571 if (!desc
->charger_regulators
|| desc
->num_charger_regulators
< 1) {
573 dev_err(&pdev
->dev
, "charger_regulators undefined.\n");
577 if (!desc
->psy_charger_stat
|| !desc
->psy_charger_stat
[0]) {
578 dev_err(&pdev
->dev
, "No power supply defined.\n");
580 goto err_no_charger_stat
;
583 /* Counting index only */
584 while (desc
->psy_charger_stat
[i
])
587 cm
->charger_stat
= kzalloc(sizeof(struct power_supply
*) * (i
+ 1),
589 if (!cm
->charger_stat
) {
591 goto err_no_charger_stat
;
594 for (i
= 0; desc
->psy_charger_stat
[i
]; i
++) {
595 cm
->charger_stat
[i
] = power_supply_get_by_name(
596 desc
->psy_charger_stat
[i
]);
597 if (!cm
->charger_stat
[i
]) {
598 dev_err(&pdev
->dev
, "Cannot find power supply "
600 desc
->psy_charger_stat
[i
]);
606 cm
->fuel_gauge
= power_supply_get_by_name(desc
->psy_fuel_gauge
);
607 if (!cm
->fuel_gauge
) {
608 dev_err(&pdev
->dev
, "Cannot find power supply \"%s\"\n",
609 desc
->psy_fuel_gauge
);
614 if (desc
->polling_interval_ms
== 0 ||
615 msecs_to_jiffies(desc
->polling_interval_ms
) <= CM_JIFFIES_SMALL
) {
616 dev_err(&pdev
->dev
, "polling_interval_ms is too small\n");
621 if (!desc
->temperature_out_of_range
) {
622 dev_err(&pdev
->dev
, "there is no temperature_out_of_range\n");
627 platform_set_drvdata(pdev
, cm
);
629 ret
= regulator_bulk_get(&pdev
->dev
, desc
->num_charger_regulators
,
630 desc
->charger_regulators
);
632 dev_err(&pdev
->dev
, "Cannot get charger regulators.\n");
636 ret
= try_charger_enable(cm
, true);
638 dev_err(&pdev
->dev
, "Cannot enable charger regulators\n");
642 /* Add to the list */
643 mutex_lock(&cm_list_mtx
);
644 list_add(&cm
->entry
, &cm_list
);
645 mutex_unlock(&cm_list_mtx
);
650 if (desc
->charger_regulators
)
651 regulator_bulk_free(desc
->num_charger_regulators
,
652 desc
->charger_regulators
);
654 kfree(cm
->charger_stat
);
664 static int __devexit
charger_manager_remove(struct platform_device
*pdev
)
666 struct charger_manager
*cm
= platform_get_drvdata(pdev
);
667 struct charger_desc
*desc
= cm
->desc
;
669 /* Remove from the list */
670 mutex_lock(&cm_list_mtx
);
671 list_del(&cm
->entry
);
672 mutex_unlock(&cm_list_mtx
);
674 if (desc
->charger_regulators
)
675 regulator_bulk_free(desc
->num_charger_regulators
,
676 desc
->charger_regulators
);
677 kfree(cm
->charger_stat
);
684 const struct platform_device_id charger_manager_id
[] = {
685 { "charger-manager", 0 },
689 static int cm_suspend_prepare(struct device
*dev
)
691 struct platform_device
*pdev
= container_of(dev
, struct platform_device
,
693 struct charger_manager
*cm
= platform_get_drvdata(pdev
);
700 rtc_read_alarm(rtc_dev
, &rtc_wkalarm_save
);
701 rtc_read_time(rtc_dev
, &tmp
);
703 if (rtc_wkalarm_save
.enabled
) {
704 rtc_tm_to_time(&rtc_wkalarm_save
.time
,
705 &rtc_wkalarm_save_time
);
706 rtc_tm_to_time(&tmp
, &now
);
707 if (now
> rtc_wkalarm_save_time
)
708 rtc_wkalarm_save_time
= 0;
710 rtc_wkalarm_save_time
= 0;
716 cm
->status_save_ext_pwr_inserted
= is_ext_pwr_online(cm
);
717 cm
->status_save_batt
= is_batt_present(cm
);
720 cm_suspend_duration_ms
= 0;
721 cm_rtc_set
= cm_setup_timer();
727 static void cm_suspend_complete(struct device
*dev
)
729 struct platform_device
*pdev
= container_of(dev
, struct platform_device
,
731 struct charger_manager
*cm
= platform_get_drvdata(pdev
);
735 struct rtc_wkalrm tmp
;
737 rtc_read_alarm(rtc_dev
, &tmp
);
738 rtc_wkalarm_save
.pending
= tmp
.pending
;
739 rtc_set_alarm(rtc_dev
, &rtc_wkalarm_save
);
741 cm_suspended
= false;
745 uevent_notify(cm
, NULL
);
748 static const struct dev_pm_ops charger_manager_pm
= {
749 .prepare
= cm_suspend_prepare
,
750 .complete
= cm_suspend_complete
,
753 static struct platform_driver charger_manager_driver
= {
755 .name
= "charger-manager",
756 .owner
= THIS_MODULE
,
757 .pm
= &charger_manager_pm
,
759 .probe
= charger_manager_probe
,
760 .remove
= __devexit_p(charger_manager_remove
),
761 .id_table
= charger_manager_id
,
764 static int __init
charger_manager_init(void)
766 return platform_driver_register(&charger_manager_driver
);
768 late_initcall(charger_manager_init
);
770 static void __exit
charger_manager_cleanup(void)
772 platform_driver_unregister(&charger_manager_driver
);
774 module_exit(charger_manager_cleanup
);
776 MODULE_AUTHOR("MyungJoo Ham <myungjoo.ham@samsung.com>");
777 MODULE_DESCRIPTION("Charger Manager");
778 MODULE_LICENSE("GPL");
779 MODULE_ALIAS("charger-manager");