3 * Copyright (C) 2007-2009 Google, Inc.
5 * This software is licensed under the terms of the GNU General Public
6 * License version 2, as published by the Free Software Foundation, and
7 * may be copied, distributed, and modified under those terms.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
16 #include <asm/mach/time.h>
17 #include <linux/android_alarm.h>
18 #include <linux/device.h>
19 #include <linux/miscdevice.h>
20 #include <linux/platform_device.h>
21 #include <linux/rtc.h>
22 #include <linux/sched.h>
23 #include <linux/spinlock.h>
24 #include <linux/sysdev.h>
25 #include <linux/wakelock.h>
27 #define ANDROID_ALARM_PRINT_ERROR (1U << 0)
28 #define ANDROID_ALARM_PRINT_INIT_STATUS (1U << 1)
29 #define ANDROID_ALARM_PRINT_TSET (1U << 2)
30 #define ANDROID_ALARM_PRINT_CALL (1U << 3)
31 #define ANDROID_ALARM_PRINT_SUSPEND (1U << 4)
32 #define ANDROID_ALARM_PRINT_INT (1U << 5)
33 #define ANDROID_ALARM_PRINT_FLOW (1U << 6)
35 static int debug_mask = ANDROID_ALARM_PRINT_ERROR | \
36 ANDROID_ALARM_PRINT_INIT_STATUS;
37 module_param_named(debug_mask, debug_mask, int, S_IRUGO | S_IWUSR | S_IWGRP);
39 #define pr_alarm(debug_level_mask, args...) \
41 if (debug_mask & ANDROID_ALARM_PRINT_##debug_level_mask) { \
46 #define ANDROID_ALARM_WAKEUP_MASK ( \
47 ANDROID_ALARM_RTC_WAKEUP_MASK | \
48 ANDROID_ALARM_ELAPSED_REALTIME_WAKEUP_MASK)
50 /* support old usespace code */
51 #define ANDROID_ALARM_SET_OLD _IOW('a', 2, time_t) /* set alarm */
52 #define ANDROID_ALARM_SET_AND_WAIT_OLD _IOW('a', 3, time_t)
55 struct rb_root alarms;
56 struct rb_node *first;
63 static struct rtc_device *alarm_rtc_dev;
64 static DEFINE_SPINLOCK(alarm_slock);
65 static DEFINE_MUTEX(alarm_setrtc_mutex);
66 static struct wake_lock alarm_rtc_wake_lock;
67 static struct platform_device *alarm_platform_dev;
68 struct alarm_queue alarms[ANDROID_ALARM_TYPE_COUNT];
69 static bool suspended;
71 static void update_timer_locked(struct alarm_queue *base, bool head_removed)
74 bool is_wakeup = base == &alarms[ANDROID_ALARM_RTC_WAKEUP] ||
75 base == &alarms[ANDROID_ALARM_ELAPSED_REALTIME_WAKEUP];
78 pr_alarm(FLOW, "changed alarm while setting the wall time\n");
82 if (is_wakeup && !suspended && head_removed)
83 wake_unlock(&alarm_rtc_wake_lock);
88 alarm = container_of(base->first, struct alarm, node);
90 pr_alarm(FLOW, "selected alarm, type %d, func %pF at %lld\n",
91 alarm->type, alarm->function, ktime_to_ns(alarm->expires));
93 if (is_wakeup && suspended) {
94 pr_alarm(FLOW, "changed alarm while suspened\n");
95 wake_lock_timeout(&alarm_rtc_wake_lock, 1 * HZ);
99 hrtimer_try_to_cancel(&base->timer);
100 base->timer._expires = ktime_add(base->delta, alarm->expires);
101 base->timer._softexpires = ktime_add(base->delta, alarm->softexpires);
102 hrtimer_start_expires(&base->timer, HRTIMER_MODE_ABS);
105 static void alarm_enqueue_locked(struct alarm *alarm)
107 struct alarm_queue *base = &alarms[alarm->type];
108 struct rb_node **link = &base->alarms.rb_node;
109 struct rb_node *parent = NULL;
113 pr_alarm(FLOW, "added alarm, type %d, func %pF at %lld\n",
114 alarm->type, alarm->function, ktime_to_ns(alarm->expires));
116 if (base->first == &alarm->node)
117 base->first = rb_next(&alarm->node);
118 if (!RB_EMPTY_NODE(&alarm->node)) {
119 rb_erase(&alarm->node, &base->alarms);
120 RB_CLEAR_NODE(&alarm->node);
125 entry = rb_entry(parent, struct alarm, node);
127 * We dont care about collisions. Nodes with
128 * the same expiry time stay together.
130 if (alarm->expires.tv64 < entry->expires.tv64) {
131 link = &(*link)->rb_left;
133 link = &(*link)->rb_right;
138 base->first = &alarm->node;
139 update_timer_locked(base, false);
142 rb_link_node(&alarm->node, parent, link);
143 rb_insert_color(&alarm->node, &base->alarms);
147 * alarm_init - initialize an alarm
148 * @alarm: the alarm to be initialized
149 * @type: the alarm type to be used
150 * @function: alarm callback function
152 void alarm_init(struct alarm *alarm,
153 enum android_alarm_type type, void (*function)(struct alarm *))
155 RB_CLEAR_NODE(&alarm->node);
157 alarm->function = function;
159 pr_alarm(FLOW, "created alarm, type %d, func %pF\n", type, function);
164 * alarm_start_range - (re)start an alarm
165 * @alarm: the alarm to be added
166 * @start: earliest expiry time
169 void alarm_start_range(struct alarm *alarm, ktime_t start, ktime_t end)
173 spin_lock_irqsave(&alarm_slock, flags);
174 alarm->softexpires = start;
175 alarm->expires = end;
176 alarm_enqueue_locked(alarm);
177 spin_unlock_irqrestore(&alarm_slock, flags);
181 * alarm_try_to_cancel - try to deactivate an alarm
182 * @alarm: alarm to stop
185 * 0 when the alarm was not active
186 * 1 when the alarm was active
187 * -1 when the alarm may currently be excuting the callback function and
188 * cannot be stopped (it may also be inactive)
190 int alarm_try_to_cancel(struct alarm *alarm)
192 struct alarm_queue *base = &alarms[alarm->type];
197 spin_lock_irqsave(&alarm_slock, flags);
198 if (!RB_EMPTY_NODE(&alarm->node)) {
199 pr_alarm(FLOW, "canceled alarm, type %d, func %pF at %lld\n",
200 alarm->type, alarm->function,
201 ktime_to_ns(alarm->expires));
203 if (base->first == &alarm->node) {
204 base->first = rb_next(&alarm->node);
207 rb_erase(&alarm->node, &base->alarms);
208 RB_CLEAR_NODE(&alarm->node);
210 update_timer_locked(base, true);
212 pr_alarm(FLOW, "tried to cancel alarm, type %d, func %pF\n",
213 alarm->type, alarm->function);
214 spin_unlock_irqrestore(&alarm_slock, flags);
215 if (!ret && hrtimer_callback_running(&base->timer))
221 * alarm_cancel - cancel an alarm and wait for the handler to finish.
222 * @alarm: the alarm to be cancelled
225 * 0 when the alarm was not active
226 * 1 when the alarm was active
228 int alarm_cancel(struct alarm *alarm)
231 int ret = alarm_try_to_cancel(alarm);
237 int rtc_change_time(struct timespec new_time)
242 struct rtc_time rtc_new_rtc_time;
243 struct timespec tmp_time;
245 rtc_time_to_tm(new_time.tv_sec, &rtc_new_rtc_time);
247 printk("set rtc %ld %ld - rtc %02d:%02d:%02d %02d/%02d/%04d\n",
248 new_time.tv_sec, new_time.tv_nsec,
249 rtc_new_rtc_time.tm_hour, rtc_new_rtc_time.tm_min,
250 rtc_new_rtc_time.tm_sec, rtc_new_rtc_time.tm_mon + 1,
251 rtc_new_rtc_time.tm_mday,
252 rtc_new_rtc_time.tm_year + 1900);
256 * alarm_set_rtc - set the kernel and rtc walltime
257 * @new_time: timespec value containing the new time
259 int alarm_set_rtc(struct timespec new_time)
264 struct rtc_time rtc_new_rtc_time;
265 struct timespec tmp_time;
267 rtc_time_to_tm(new_time.tv_sec, &rtc_new_rtc_time);
269 printk("set rtc %ld %ld - rtc %02d:%02d:%02d %02d/%02d/%04d\n",
270 new_time.tv_sec, new_time.tv_nsec,
271 rtc_new_rtc_time.tm_hour, rtc_new_rtc_time.tm_min,
272 rtc_new_rtc_time.tm_sec, rtc_new_rtc_time.tm_mon + 1,
273 rtc_new_rtc_time.tm_mday,
274 rtc_new_rtc_time.tm_year + 1900);
276 mutex_lock(&alarm_setrtc_mutex);
277 spin_lock_irqsave(&alarm_slock, flags);
278 wake_lock(&alarm_rtc_wake_lock);
279 getnstimeofday(&tmp_time);
280 for (i = 0; i < ANDROID_ALARM_SYSTEMTIME; i++) {
281 hrtimer_try_to_cancel(&alarms[i].timer);
282 alarms[i].stopped = true;
283 alarms[i].stopped_time = timespec_to_ktime(tmp_time);
285 alarms[ANDROID_ALARM_ELAPSED_REALTIME_WAKEUP].delta =
286 alarms[ANDROID_ALARM_ELAPSED_REALTIME].delta =
287 ktime_sub(alarms[ANDROID_ALARM_ELAPSED_REALTIME].delta,
288 timespec_to_ktime(timespec_sub(tmp_time, new_time)));
289 spin_unlock_irqrestore(&alarm_slock, flags);
290 ret = do_settimeofday(&new_time);
291 spin_lock_irqsave(&alarm_slock, flags);
292 for (i = 0; i < ANDROID_ALARM_SYSTEMTIME; i++) {
293 alarms[i].stopped = false;
294 update_timer_locked(&alarms[i], false);
296 spin_unlock_irqrestore(&alarm_slock, flags);
298 pr_alarm(ERROR, "alarm_set_rtc: Failed to set time\n");
301 if (!alarm_rtc_dev) {
303 "alarm_set_rtc: no RTC, time will be lost on reboot\n");
306 ret = rtc_set_time(alarm_rtc_dev, &rtc_new_rtc_time);
308 pr_alarm(ERROR, "alarm_set_rtc: "
309 "Failed to set RTC, time will be lost on reboot\n");
311 wake_unlock(&alarm_rtc_wake_lock);
312 mutex_unlock(&alarm_setrtc_mutex);
317 * alarm_get_elapsed_realtime - get the elapsed real time in ktime_t format
319 * returns the time in ktime_t format
321 ktime_t alarm_get_elapsed_realtime(void)
325 struct alarm_queue *base = &alarms[ANDROID_ALARM_ELAPSED_REALTIME];
327 spin_lock_irqsave(&alarm_slock, flags);
328 now = base->stopped ? base->stopped_time : ktime_get_real();
329 now = ktime_sub(now, base->delta);
330 spin_unlock_irqrestore(&alarm_slock, flags);
334 static enum hrtimer_restart alarm_timer_triggered(struct hrtimer *timer)
336 struct alarm_queue *base;
340 printk("alarm_timer_triggered\n");
341 spin_lock_irqsave(&alarm_slock, flags);
343 base = container_of(timer, struct alarm_queue, timer);
344 now = base->stopped ? base->stopped_time : hrtimer_cb_get_time(timer);
345 now = ktime_sub(now, base->delta);
347 printk( "alarm_timer_triggered type %d at %lld\n",
348 base - alarms, ktime_to_ns(now));
350 while (base->first) {
351 alarm = container_of(base->first, struct alarm, node);
352 if (alarm->softexpires.tv64 > now.tv64) {
353 printk( "don't call alarm, %pF, %lld (s %lld)\n",
354 alarm->function, ktime_to_ns(alarm->expires),
355 ktime_to_ns(alarm->softexpires));
358 base->first = rb_next(&alarm->node);
359 rb_erase(&alarm->node, &base->alarms);
360 RB_CLEAR_NODE(&alarm->node);
361 printk("call alarm, type %d, func %pF, %lld (s %lld)\n",
362 alarm->type, alarm->function,
363 ktime_to_ns(alarm->expires),
364 ktime_to_ns(alarm->softexpires));
365 spin_unlock_irqrestore(&alarm_slock, flags);
366 alarm->function(alarm);
367 spin_lock_irqsave(&alarm_slock, flags);
370 printk( "no more alarms of type %d\n", base - alarms);
371 update_timer_locked(base, true);
372 spin_unlock_irqrestore(&alarm_slock, flags);
373 printk("---alarm_timer_triggered---\n");
374 return HRTIMER_NORESTART;
377 static void alarm_triggered_func(void *p)
379 struct rtc_device *rtc = alarm_rtc_dev;
380 if (!(rtc->irq_data & RTC_AF))
382 pr_alarm(INT, "rtc alarm triggered\n");
383 wake_lock_timeout(&alarm_rtc_wake_lock, 1 * HZ);
386 static int alarm_suspend(struct platform_device *pdev, pm_message_t state)
390 struct rtc_wkalrm rtc_alarm;
391 struct rtc_time rtc_current_rtc_time;
392 unsigned long rtc_current_time;
393 unsigned long rtc_alarm_time;
394 struct timespec rtc_current_timespec;
395 struct timespec rtc_delta;
396 struct alarm_queue *wakeup_queue = NULL;
397 struct alarm_queue *tmp_queue = NULL;
399 printk( "alarm_suspend(%p, %d)\n", pdev, state.event);
401 spin_lock_irqsave(&alarm_slock, flags);
403 spin_unlock_irqrestore(&alarm_slock, flags);
405 hrtimer_cancel(&alarms[ANDROID_ALARM_RTC_WAKEUP].timer);
406 hrtimer_cancel(&alarms[
407 ANDROID_ALARM_ELAPSED_REALTIME_WAKEUP_MASK].timer);
409 tmp_queue = &alarms[ANDROID_ALARM_RTC_WAKEUP];
410 if (tmp_queue->first)
411 wakeup_queue = tmp_queue;
412 tmp_queue = &alarms[ANDROID_ALARM_ELAPSED_REALTIME_WAKEUP];
413 if (tmp_queue->first && (!wakeup_queue ||
414 hrtimer_get_expires(&tmp_queue->timer).tv64 <
415 hrtimer_get_expires(&wakeup_queue->timer).tv64))
416 wakeup_queue = tmp_queue;
418 rtc_read_time(alarm_rtc_dev, &rtc_current_rtc_time);
419 rtc_current_timespec.tv_nsec = 0;
420 rtc_tm_to_time(&rtc_current_rtc_time,
421 &rtc_current_timespec.tv_sec);
422 save_time_delta(&rtc_delta, &rtc_current_timespec);
424 rtc_alarm_time = timespec_sub(ktime_to_timespec(
425 hrtimer_get_expires(&wakeup_queue->timer)),
428 rtc_time_to_tm(rtc_alarm_time, &rtc_alarm.time);
429 rtc_alarm.enabled = 1;
430 //rtc_alarm.time.tm_min +=4;
431 rtc_set_alarm(alarm_rtc_dev, &rtc_alarm);
432 rtc_read_time(alarm_rtc_dev, &rtc_current_rtc_time);
433 rtc_tm_to_time(&rtc_current_rtc_time, &rtc_current_time);
435 "rtc alarm set at %ld, now %ld, rtc delta %ld.%09ld\n",
436 rtc_alarm_time, rtc_current_time,
437 rtc_delta.tv_sec, rtc_delta.tv_nsec);
438 if (rtc_current_time + 1 >= rtc_alarm_time) {
439 pr_alarm(SUSPEND, "alarm about to go off\n");
440 memset(&rtc_alarm, 0, sizeof(rtc_alarm));
441 rtc_alarm.enabled = 0;
442 rtc_set_alarm(alarm_rtc_dev, &rtc_alarm);
444 spin_lock_irqsave(&alarm_slock, flags);
446 wake_lock_timeout(&alarm_rtc_wake_lock, 2 * HZ);
447 update_timer_locked(&alarms[ANDROID_ALARM_RTC_WAKEUP],
449 update_timer_locked(&alarms[
450 ANDROID_ALARM_ELAPSED_REALTIME_WAKEUP], false);
452 spin_unlock_irqrestore(&alarm_slock, flags);
455 printk( "alarm_suspend over\n");
459 static int alarm_shutdown(struct platform_device *pdev, pm_message_t state)
463 struct rtc_wkalrm rtc_alarm;
464 struct rtc_time rtc_current_rtc_time;
465 unsigned long rtc_current_time;
466 unsigned long rtc_alarm_time;
467 struct timespec rtc_current_timespec;
468 struct timespec rtc_delta;
469 struct alarm_queue *wakeup_queue = NULL;
470 struct alarm_queue *tmp_queue = NULL;
472 printk( "alarm_suspend(%p, %d)\n", pdev, state.event);
474 spin_lock_irqsave(&alarm_slock, flags);
476 spin_unlock_irqrestore(&alarm_slock, flags);
478 hrtimer_cancel(&alarms[ANDROID_ALARM_RTC_WAKEUP].timer);
479 hrtimer_cancel(&alarms[
480 ANDROID_ALARM_ELAPSED_REALTIME_WAKEUP_MASK].timer);
482 tmp_queue = &alarms[ANDROID_ALARM_RTC_WAKEUP];
483 if (tmp_queue->first)
484 wakeup_queue = tmp_queue;
485 tmp_queue = &alarms[ANDROID_ALARM_ELAPSED_REALTIME_WAKEUP];
486 if (tmp_queue->first && (!wakeup_queue ||
487 hrtimer_get_expires(&tmp_queue->timer).tv64 <
488 hrtimer_get_expires(&wakeup_queue->timer).tv64))
489 wakeup_queue = tmp_queue;
491 rtc_read_time(alarm_rtc_dev, &rtc_current_rtc_time);
492 rtc_current_timespec.tv_nsec = 0;
493 rtc_tm_to_time(&rtc_current_rtc_time,
494 &rtc_current_timespec.tv_sec);
495 save_time_delta(&rtc_delta, &rtc_current_timespec);
497 rtc_alarm_time = timespec_sub(ktime_to_timespec(
498 hrtimer_get_expires(&wakeup_queue->timer)),
501 rtc_time_to_tm(rtc_alarm_time, &rtc_alarm.time);
502 rtc_alarm.enabled = 1;
503 rtc_set_alarm(alarm_rtc_dev, &rtc_alarm);
504 rtc_read_time(alarm_rtc_dev, &rtc_current_rtc_time);
505 rtc_tm_to_time(&rtc_current_rtc_time, &rtc_current_time);
507 "rtc alarm set at %ld, now %ld, rtc delta %ld.%09ld\n",
508 rtc_alarm_time, rtc_current_time,
509 rtc_delta.tv_sec, rtc_delta.tv_nsec);
510 if (rtc_current_time + 1 >= rtc_alarm_time) {
511 pr_alarm(SUSPEND, "alarm about to go off\n");
512 memset(&rtc_alarm, 0, sizeof(rtc_alarm));
513 rtc_alarm.enabled = 0;
514 rtc_set_alarm(alarm_rtc_dev, &rtc_alarm);
516 spin_lock_irqsave(&alarm_slock, flags);
518 wake_lock_timeout(&alarm_rtc_wake_lock, 2 * HZ);
519 update_timer_locked(&alarms[ANDROID_ALARM_RTC_WAKEUP],
521 update_timer_locked(&alarms[
522 ANDROID_ALARM_ELAPSED_REALTIME_WAKEUP], false);
524 spin_unlock_irqrestore(&alarm_slock, flags);
527 printk( "alarm_suspend over\n");
530 static int alarm_resume(struct platform_device *pdev)
532 struct rtc_wkalrm alarm;
535 printk( "alarm_resume(%p)\n", pdev);
537 memset(&alarm, 0, sizeof(alarm));
539 rtc_set_alarm(alarm_rtc_dev, &alarm);
541 spin_lock_irqsave(&alarm_slock, flags);
543 update_timer_locked(&alarms[ANDROID_ALARM_RTC_WAKEUP], false);
544 update_timer_locked(&alarms[ANDROID_ALARM_ELAPSED_REALTIME_WAKEUP],
546 spin_unlock_irqrestore(&alarm_slock, flags);
551 static struct rtc_task alarm_rtc_task = {
552 .func = alarm_triggered_func
555 static int rtc_alarm_add_device(struct device *dev,
556 struct class_interface *class_intf)
559 struct rtc_device *rtc = to_rtc_device(dev);
561 mutex_lock(&alarm_setrtc_mutex);
569 platform_device_register_simple("alarm", -1, NULL, 0);
570 if (IS_ERR(alarm_platform_dev)) {
571 err = PTR_ERR(alarm_platform_dev);
574 err = rtc_irq_register(rtc, &alarm_rtc_task);
578 pr_alarm(INIT_STATUS, "using rtc device, %s, for alarms", rtc->name);
579 mutex_unlock(&alarm_setrtc_mutex);
584 platform_device_unregister(alarm_platform_dev);
587 mutex_unlock(&alarm_setrtc_mutex);
591 static void rtc_alarm_remove_device(struct device *dev,
592 struct class_interface *class_intf)
594 if (dev == &alarm_rtc_dev->dev) {
595 pr_alarm(INIT_STATUS, "lost rtc device for alarms");
596 rtc_irq_unregister(alarm_rtc_dev, &alarm_rtc_task);
597 platform_device_unregister(alarm_platform_dev);
598 alarm_rtc_dev = NULL;
602 static struct class_interface rtc_alarm_interface = {
603 .add_dev = &rtc_alarm_add_device,
604 .remove_dev = &rtc_alarm_remove_device,
607 static struct platform_driver alarm_driver = {
608 .suspend = alarm_suspend,
609 .resume = alarm_resume,
610 .shutdown = alarm_shutdown,
616 static int __init alarm_late_init(void)
619 struct timespec tmp_time, system_time;
620 printk("alarm_late_init\n");
621 /* this needs to run after the rtc is read at boot */
622 spin_lock_irqsave(&alarm_slock, flags);
623 /* We read the current rtc and system time so we can later calulate
624 * elasped realtime to be (boot_systemtime + rtc - boot_rtc) ==
625 * (rtc - (boot_rtc - boot_systemtime))
627 getnstimeofday(&tmp_time);
628 ktime_get_ts(&system_time);
629 alarms[ANDROID_ALARM_ELAPSED_REALTIME_WAKEUP].delta =
630 alarms[ANDROID_ALARM_ELAPSED_REALTIME].delta =
631 timespec_to_ktime(timespec_sub(tmp_time, system_time));
633 spin_unlock_irqrestore(&alarm_slock, flags);
634 printk("---alarm_late_init----\n");
638 static int __init alarm_driver_init(void)
642 printk("alarm_driver_init\n");
643 for (i = 0; i < ANDROID_ALARM_SYSTEMTIME; i++) {
644 hrtimer_init(&alarms[i].timer,
645 CLOCK_REALTIME, HRTIMER_MODE_ABS);
646 alarms[i].timer.function = alarm_timer_triggered;
648 hrtimer_init(&alarms[ANDROID_ALARM_SYSTEMTIME].timer,
649 CLOCK_MONOTONIC, HRTIMER_MODE_ABS);
650 alarms[ANDROID_ALARM_SYSTEMTIME].timer.function = alarm_timer_triggered;
651 err = platform_driver_register(&alarm_driver);
654 wake_lock_init(&alarm_rtc_wake_lock, WAKE_LOCK_SUSPEND, "alarm_rtc");
655 rtc_alarm_interface.class = rtc_class;
656 err = class_interface_register(&rtc_alarm_interface);
659 printk("---alarm_driver_init---\n");
663 wake_lock_destroy(&alarm_rtc_wake_lock);
664 platform_driver_unregister(&alarm_driver);
669 static void __exit alarm_exit(void)
671 class_interface_unregister(&rtc_alarm_interface);
672 wake_lock_destroy(&alarm_rtc_wake_lock);
673 platform_driver_unregister(&alarm_driver);
676 late_initcall(alarm_late_init);
677 module_init(alarm_driver_init);
678 module_exit(alarm_exit);