blob: 3e5cba274475df2ab70edb04d9695dfe28a945aa [file] [log] [blame]
John Stultzff3ead92011-01-11 09:42:13 -08001/*
2 * Alarmtimer interface
3 *
4 * This interface provides a timer which is similarto hrtimers,
5 * but triggers a RTC alarm if the box is suspend.
6 *
7 * This interface is influenced by the Android RTC Alarm timer
8 * interface.
9 *
10 * Copyright (C) 2010 IBM Corperation
11 *
12 * Author: John Stultz <john.stultz@linaro.org>
13 *
14 * This program is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU General Public License version 2 as
16 * published by the Free Software Foundation.
17 */
18#include <linux/time.h>
19#include <linux/hrtimer.h>
20#include <linux/timerqueue.h>
21#include <linux/rtc.h>
22#include <linux/alarmtimer.h>
23#include <linux/mutex.h>
24#include <linux/platform_device.h>
25#include <linux/posix-timers.h>
26#include <linux/workqueue.h>
27#include <linux/freezer.h>
28
John Stultz180bf812011-04-28 12:58:11 -070029/**
30 * struct alarm_base - Alarm timer bases
31 * @lock: Lock for syncrhonized access to the base
32 * @timerqueue: Timerqueue head managing the list of events
33 * @timer: hrtimer used to schedule events while running
34 * @gettime: Function to read the time correlating to the base
35 * @base_clockid: clockid for the base
John Stultz180bf812011-04-28 12:58:11 -070036 */
John Stultzff3ead92011-01-11 09:42:13 -080037static struct alarm_base {
38 spinlock_t lock;
39 struct timerqueue_head timerqueue;
John Stultzff3ead92011-01-11 09:42:13 -080040 ktime_t (*gettime)(void);
41 clockid_t base_clockid;
John Stultzff3ead92011-01-11 09:42:13 -080042} alarm_bases[ALARM_NUMTYPE];
43
John Stultzc008ba582011-06-16 18:27:09 -070044/* freezer delta & lock used to handle clock_nanosleep triggered wakeups */
45static ktime_t freezer_delta;
46static DEFINE_SPINLOCK(freezer_delta_lock);
47
Todd Poynor59a93c22012-08-09 00:37:27 -070048static struct wakeup_source *ws;
49
John Stultz472647d2011-04-29 15:03:10 -070050#ifdef CONFIG_RTC_CLASS
John Stultz180bf812011-04-28 12:58:11 -070051/* rtc timer and device for setting alarm wakeups at suspend */
Thomas Gleixnerc5e14e72012-03-24 12:46:23 +010052static struct rtc_timer rtctimer;
John Stultzff3ead92011-01-11 09:42:13 -080053static struct rtc_device *rtcdev;
John Stultzc008ba582011-06-16 18:27:09 -070054static DEFINE_SPINLOCK(rtcdev_lock);
John Stultzff3ead92011-01-11 09:42:13 -080055
John Stultzc008ba582011-06-16 18:27:09 -070056/**
John Stultzc008ba582011-06-16 18:27:09 -070057 * alarmtimer_get_rtcdev - Return selected rtcdevice
58 *
59 * This function returns the rtc device to use for wakealarms.
60 * If one has not already been chosen, it checks to see if a
61 * functional rtc device is available.
62 */
John Stultz57c498f2012-04-20 12:31:45 -070063struct rtc_device *alarmtimer_get_rtcdev(void)
John Stultzc008ba582011-06-16 18:27:09 -070064{
John Stultzc008ba582011-06-16 18:27:09 -070065 unsigned long flags;
66 struct rtc_device *ret;
67
68 spin_lock_irqsave(&rtcdev_lock, flags);
John Stultzc008ba582011-06-16 18:27:09 -070069 ret = rtcdev;
70 spin_unlock_irqrestore(&rtcdev_lock, flags);
71
72 return ret;
73}
John Stultz8bc0daf2011-07-14 18:35:13 -070074
75
76static int alarmtimer_rtc_add_device(struct device *dev,
77 struct class_interface *class_intf)
78{
79 unsigned long flags;
80 struct rtc_device *rtc = to_rtc_device(dev);
81
82 if (rtcdev)
83 return -EBUSY;
84
85 if (!rtc->ops->set_alarm)
86 return -1;
87 if (!device_may_wakeup(rtc->dev.parent))
88 return -1;
89
90 spin_lock_irqsave(&rtcdev_lock, flags);
91 if (!rtcdev) {
92 rtcdev = rtc;
93 /* hold a reference so it doesn't go away */
94 get_device(dev);
95 }
96 spin_unlock_irqrestore(&rtcdev_lock, flags);
97 return 0;
98}
99
Thomas Gleixnerc5e14e72012-03-24 12:46:23 +0100100static inline void alarmtimer_rtc_timer_init(void)
101{
102 rtc_timer_init(&rtctimer, NULL, NULL);
103}
104
John Stultz8bc0daf2011-07-14 18:35:13 -0700105static struct class_interface alarmtimer_rtc_interface = {
106 .add_dev = &alarmtimer_rtc_add_device,
107};
108
Thomas Gleixner4523f6a2011-09-14 10:54:29 +0200109static int alarmtimer_rtc_interface_setup(void)
John Stultz8bc0daf2011-07-14 18:35:13 -0700110{
111 alarmtimer_rtc_interface.class = rtc_class;
Thomas Gleixner4523f6a2011-09-14 10:54:29 +0200112 return class_interface_register(&alarmtimer_rtc_interface);
113}
114static void alarmtimer_rtc_interface_remove(void)
115{
116 class_interface_unregister(&alarmtimer_rtc_interface);
John Stultz8bc0daf2011-07-14 18:35:13 -0700117}
John Stultz1c6b39a2011-06-16 18:47:37 -0700118#else
John Stultz57c498f2012-04-20 12:31:45 -0700119struct rtc_device *alarmtimer_get_rtcdev(void)
Thomas Gleixner4523f6a2011-09-14 10:54:29 +0200120{
121 return NULL;
122}
123#define rtcdev (NULL)
124static inline int alarmtimer_rtc_interface_setup(void) { return 0; }
125static inline void alarmtimer_rtc_interface_remove(void) { }
Thomas Gleixnerc5e14e72012-03-24 12:46:23 +0100126static inline void alarmtimer_rtc_timer_init(void) { }
John Stultzc008ba582011-06-16 18:27:09 -0700127#endif
John Stultzff3ead92011-01-11 09:42:13 -0800128
John Stultz180bf812011-04-28 12:58:11 -0700129/**
John Stultzff3ead92011-01-11 09:42:13 -0800130 * alarmtimer_enqueue - Adds an alarm timer to an alarm_base timerqueue
131 * @base: pointer to the base where the timer is being run
132 * @alarm: pointer to alarm being enqueued.
133 *
John Stultzdae373b2012-09-13 19:12:16 -0400134 * Adds alarm to a alarm_base timerqueue
John Stultzff3ead92011-01-11 09:42:13 -0800135 *
136 * Must hold base->lock when calling.
137 */
138static void alarmtimer_enqueue(struct alarm_base *base, struct alarm *alarm)
139{
John Stultzdae373b2012-09-13 19:12:16 -0400140 if (alarm->state & ALARMTIMER_STATE_ENQUEUED)
141 timerqueue_del(&base->timerqueue, &alarm->node);
142
John Stultzff3ead92011-01-11 09:42:13 -0800143 timerqueue_add(&base->timerqueue, &alarm->node);
John Stultza28cde82011-08-10 12:30:21 -0700144 alarm->state |= ALARMTIMER_STATE_ENQUEUED;
John Stultzff3ead92011-01-11 09:42:13 -0800145}
146
John Stultz180bf812011-04-28 12:58:11 -0700147/**
John Stultza65bcc12012-09-13 19:25:22 -0400148 * alarmtimer_dequeue - Removes an alarm timer from an alarm_base timerqueue
John Stultzff3ead92011-01-11 09:42:13 -0800149 * @base: pointer to the base where the timer is running
150 * @alarm: pointer to alarm being removed
151 *
John Stultzdae373b2012-09-13 19:12:16 -0400152 * Removes alarm to a alarm_base timerqueue
John Stultzff3ead92011-01-11 09:42:13 -0800153 *
154 * Must hold base->lock when calling.
155 */
John Stultza65bcc12012-09-13 19:25:22 -0400156static void alarmtimer_dequeue(struct alarm_base *base, struct alarm *alarm)
John Stultzff3ead92011-01-11 09:42:13 -0800157{
John Stultza28cde82011-08-10 12:30:21 -0700158 if (!(alarm->state & ALARMTIMER_STATE_ENQUEUED))
159 return;
160
John Stultzff3ead92011-01-11 09:42:13 -0800161 timerqueue_del(&base->timerqueue, &alarm->node);
John Stultza28cde82011-08-10 12:30:21 -0700162 alarm->state &= ~ALARMTIMER_STATE_ENQUEUED;
John Stultzff3ead92011-01-11 09:42:13 -0800163}
164
John Stultz7068b7a2011-04-28 13:29:18 -0700165
John Stultz180bf812011-04-28 12:58:11 -0700166/**
John Stultz7068b7a2011-04-28 13:29:18 -0700167 * alarmtimer_fired - Handles alarm hrtimer being fired.
168 * @timer: pointer to hrtimer being run
John Stultzff3ead92011-01-11 09:42:13 -0800169 *
John Stultz180bf812011-04-28 12:58:11 -0700170 * When a alarm timer fires, this runs through the timerqueue to
171 * see which alarms expired, and runs those. If there are more alarm
172 * timers queued for the future, we set the hrtimer to fire when
173 * when the next future alarm timer expires.
John Stultzff3ead92011-01-11 09:42:13 -0800174 */
John Stultz7068b7a2011-04-28 13:29:18 -0700175static enum hrtimer_restart alarmtimer_fired(struct hrtimer *timer)
John Stultzff3ead92011-01-11 09:42:13 -0800176{
John Stultzdae373b2012-09-13 19:12:16 -0400177 struct alarm *alarm = container_of(timer, struct alarm, timer);
178 struct alarm_base *base = &alarm_bases[alarm->type];
John Stultzff3ead92011-01-11 09:42:13 -0800179 unsigned long flags;
John Stultz7068b7a2011-04-28 13:29:18 -0700180 int ret = HRTIMER_NORESTART;
John Stultz54da23b2011-08-10 11:08:07 -0700181 int restart = ALARMTIMER_NORESTART;
John Stultzff3ead92011-01-11 09:42:13 -0800182
183 spin_lock_irqsave(&base->lock, flags);
John Stultza65bcc12012-09-13 19:25:22 -0400184 alarmtimer_dequeue(base, alarm);
John Stultzdae373b2012-09-13 19:12:16 -0400185 spin_unlock_irqrestore(&base->lock, flags);
John Stultzff3ead92011-01-11 09:42:13 -0800186
John Stultzdae373b2012-09-13 19:12:16 -0400187 if (alarm->function)
188 restart = alarm->function(alarm, base->gettime());
John Stultzff3ead92011-01-11 09:42:13 -0800189
John Stultzdae373b2012-09-13 19:12:16 -0400190 spin_lock_irqsave(&base->lock, flags);
191 if (restart != ALARMTIMER_NORESTART) {
192 hrtimer_set_expires(&alarm->timer, alarm->node.expires);
193 alarmtimer_enqueue(base, alarm);
John Stultz7068b7a2011-04-28 13:29:18 -0700194 ret = HRTIMER_RESTART;
John Stultzff3ead92011-01-11 09:42:13 -0800195 }
196 spin_unlock_irqrestore(&base->lock, flags);
John Stultzff3ead92011-01-11 09:42:13 -0800197
John Stultz7068b7a2011-04-28 13:29:18 -0700198 return ret;
John Stultzff3ead92011-01-11 09:42:13 -0800199
John Stultzff3ead92011-01-11 09:42:13 -0800200}
201
Todd Poynor6cffe002013-05-15 14:38:11 -0700202ktime_t alarm_expires_remaining(const struct alarm *alarm)
203{
204 struct alarm_base *base = &alarm_bases[alarm->type];
205 return ktime_sub(alarm->node.expires, base->gettime());
206}
207
John Stultz472647d2011-04-29 15:03:10 -0700208#ifdef CONFIG_RTC_CLASS
John Stultz180bf812011-04-28 12:58:11 -0700209/**
John Stultzff3ead92011-01-11 09:42:13 -0800210 * alarmtimer_suspend - Suspend time callback
211 * @dev: unused
212 * @state: unused
213 *
214 * When we are going into suspend, we look through the bases
215 * to see which is the soonest timer to expire. We then
216 * set an rtc timer to fire that far into the future, which
217 * will wake us from suspend.
218 */
219static int alarmtimer_suspend(struct device *dev)
220{
221 struct rtc_time tm;
222 ktime_t min, now;
223 unsigned long flags;
John Stultzc008ba582011-06-16 18:27:09 -0700224 struct rtc_device *rtc;
John Stultzff3ead92011-01-11 09:42:13 -0800225 int i;
Todd Poynor59a93c22012-08-09 00:37:27 -0700226 int ret;
John Stultzff3ead92011-01-11 09:42:13 -0800227
228 spin_lock_irqsave(&freezer_delta_lock, flags);
229 min = freezer_delta;
230 freezer_delta = ktime_set(0, 0);
231 spin_unlock_irqrestore(&freezer_delta_lock, flags);
232
John Stultz8bc0daf2011-07-14 18:35:13 -0700233 rtc = alarmtimer_get_rtcdev();
John Stultzff3ead92011-01-11 09:42:13 -0800234 /* If we have no rtcdev, just return */
John Stultzc008ba582011-06-16 18:27:09 -0700235 if (!rtc)
John Stultzff3ead92011-01-11 09:42:13 -0800236 return 0;
237
238 /* Find the soonest timer to expire*/
239 for (i = 0; i < ALARM_NUMTYPE; i++) {
240 struct alarm_base *base = &alarm_bases[i];
241 struct timerqueue_node *next;
242 ktime_t delta;
243
244 spin_lock_irqsave(&base->lock, flags);
245 next = timerqueue_getnext(&base->timerqueue);
246 spin_unlock_irqrestore(&base->lock, flags);
247 if (!next)
248 continue;
249 delta = ktime_sub(next->expires, base->gettime());
250 if (!min.tv64 || (delta.tv64 < min.tv64))
251 min = delta;
252 }
253 if (min.tv64 == 0)
254 return 0;
255
Todd Poynor59a93c22012-08-09 00:37:27 -0700256 if (ktime_to_ns(min) < 2 * NSEC_PER_SEC) {
257 __pm_wakeup_event(ws, 2 * MSEC_PER_SEC);
258 return -EBUSY;
259 }
John Stultzff3ead92011-01-11 09:42:13 -0800260
261 /* Setup an rtc timer to fire that far in the future */
John Stultzc008ba582011-06-16 18:27:09 -0700262 rtc_timer_cancel(rtc, &rtctimer);
263 rtc_read_time(rtc, &tm);
John Stultzff3ead92011-01-11 09:42:13 -0800264 now = rtc_tm_to_ktime(tm);
265 now = ktime_add(now, min);
266
Todd Poynor59a93c22012-08-09 00:37:27 -0700267 /* Set alarm, if in the past reject suspend briefly to handle */
268 ret = rtc_timer_start(rtc, &rtctimer, now, ktime_set(0, 0));
269 if (ret < 0)
270 __pm_wakeup_event(ws, MSEC_PER_SEC);
271 return ret;
John Stultzff3ead92011-01-11 09:42:13 -0800272}
John Stultz472647d2011-04-29 15:03:10 -0700273#else
274static int alarmtimer_suspend(struct device *dev)
275{
276 return 0;
277}
278#endif
John Stultzff3ead92011-01-11 09:42:13 -0800279
John Stultz9a7adcf2011-01-11 09:54:33 -0800280static void alarmtimer_freezerset(ktime_t absexp, enum alarmtimer_type type)
281{
282 ktime_t delta;
283 unsigned long flags;
284 struct alarm_base *base = &alarm_bases[type];
285
286 delta = ktime_sub(absexp, base->gettime());
287
288 spin_lock_irqsave(&freezer_delta_lock, flags);
289 if (!freezer_delta.tv64 || (delta.tv64 < freezer_delta.tv64))
290 freezer_delta = delta;
291 spin_unlock_irqrestore(&freezer_delta_lock, flags);
292}
293
294
John Stultz180bf812011-04-28 12:58:11 -0700295/**
John Stultzff3ead92011-01-11 09:42:13 -0800296 * alarm_init - Initialize an alarm structure
297 * @alarm: ptr to alarm to be initialized
298 * @type: the type of the alarm
299 * @function: callback that is run when the alarm fires
John Stultzff3ead92011-01-11 09:42:13 -0800300 */
301void alarm_init(struct alarm *alarm, enum alarmtimer_type type,
John Stultz4b413082011-08-10 10:37:59 -0700302 enum alarmtimer_restart (*function)(struct alarm *, ktime_t))
John Stultzff3ead92011-01-11 09:42:13 -0800303{
304 timerqueue_init(&alarm->node);
John Stultzdae373b2012-09-13 19:12:16 -0400305 hrtimer_init(&alarm->timer, alarm_bases[type].base_clockid,
306 HRTIMER_MODE_ABS);
307 alarm->timer.function = alarmtimer_fired;
John Stultzff3ead92011-01-11 09:42:13 -0800308 alarm->function = function;
309 alarm->type = type;
John Stultza28cde82011-08-10 12:30:21 -0700310 alarm->state = ALARMTIMER_STATE_INACTIVE;
John Stultzff3ead92011-01-11 09:42:13 -0800311}
312
John Stultz180bf812011-04-28 12:58:11 -0700313/**
Todd Poynor6cffe002013-05-15 14:38:11 -0700314 * alarm_start - Sets an absolute alarm to fire
John Stultzff3ead92011-01-11 09:42:13 -0800315 * @alarm: ptr to alarm to set
316 * @start: time to run the alarm
John Stultzff3ead92011-01-11 09:42:13 -0800317 */
John Stultzdae373b2012-09-13 19:12:16 -0400318int alarm_start(struct alarm *alarm, ktime_t start)
John Stultzff3ead92011-01-11 09:42:13 -0800319{
320 struct alarm_base *base = &alarm_bases[alarm->type];
321 unsigned long flags;
John Stultzdae373b2012-09-13 19:12:16 -0400322 int ret;
John Stultzff3ead92011-01-11 09:42:13 -0800323
324 spin_lock_irqsave(&base->lock, flags);
John Stultzff3ead92011-01-11 09:42:13 -0800325 alarm->node.expires = start;
John Stultzff3ead92011-01-11 09:42:13 -0800326 alarmtimer_enqueue(base, alarm);
John Stultzdae373b2012-09-13 19:12:16 -0400327 ret = hrtimer_start(&alarm->timer, alarm->node.expires,
328 HRTIMER_MODE_ABS);
John Stultzff3ead92011-01-11 09:42:13 -0800329 spin_unlock_irqrestore(&base->lock, flags);
John Stultzdae373b2012-09-13 19:12:16 -0400330 return ret;
John Stultzff3ead92011-01-11 09:42:13 -0800331}
332
John Stultz180bf812011-04-28 12:58:11 -0700333/**
Todd Poynor6cffe002013-05-15 14:38:11 -0700334 * alarm_start_relative - Sets a relative alarm to fire
335 * @alarm: ptr to alarm to set
336 * @start: time relative to now to run the alarm
337 */
338int alarm_start_relative(struct alarm *alarm, ktime_t start)
339{
340 struct alarm_base *base = &alarm_bases[alarm->type];
341
342 start = ktime_add(start, base->gettime());
343 return alarm_start(alarm, start);
344}
345
346void alarm_restart(struct alarm *alarm)
347{
348 struct alarm_base *base = &alarm_bases[alarm->type];
349 unsigned long flags;
350
351 spin_lock_irqsave(&base->lock, flags);
352 hrtimer_set_expires(&alarm->timer, alarm->node.expires);
353 hrtimer_restart(&alarm->timer);
354 alarmtimer_enqueue(base, alarm);
355 spin_unlock_irqrestore(&base->lock, flags);
356}
357
358/**
John Stultz9082c462011-08-10 12:41:36 -0700359 * alarm_try_to_cancel - Tries to cancel an alarm timer
John Stultzff3ead92011-01-11 09:42:13 -0800360 * @alarm: ptr to alarm to be canceled
John Stultz9082c462011-08-10 12:41:36 -0700361 *
362 * Returns 1 if the timer was canceled, 0 if it was not running,
363 * and -1 if the callback was running
John Stultzff3ead92011-01-11 09:42:13 -0800364 */
John Stultz9082c462011-08-10 12:41:36 -0700365int alarm_try_to_cancel(struct alarm *alarm)
John Stultzff3ead92011-01-11 09:42:13 -0800366{
367 struct alarm_base *base = &alarm_bases[alarm->type];
368 unsigned long flags;
John Stultzdae373b2012-09-13 19:12:16 -0400369 int ret;
370
John Stultzff3ead92011-01-11 09:42:13 -0800371 spin_lock_irqsave(&base->lock, flags);
John Stultzdae373b2012-09-13 19:12:16 -0400372 ret = hrtimer_try_to_cancel(&alarm->timer);
373 if (ret >= 0)
John Stultza65bcc12012-09-13 19:25:22 -0400374 alarmtimer_dequeue(base, alarm);
John Stultzff3ead92011-01-11 09:42:13 -0800375 spin_unlock_irqrestore(&base->lock, flags);
John Stultz9082c462011-08-10 12:41:36 -0700376 return ret;
John Stultzff3ead92011-01-11 09:42:13 -0800377}
378
379
John Stultz9082c462011-08-10 12:41:36 -0700380/**
381 * alarm_cancel - Spins trying to cancel an alarm timer until it is done
382 * @alarm: ptr to alarm to be canceled
383 *
384 * Returns 1 if the timer was canceled, 0 if it was not active.
385 */
386int alarm_cancel(struct alarm *alarm)
387{
388 for (;;) {
389 int ret = alarm_try_to_cancel(alarm);
390 if (ret >= 0)
391 return ret;
392 cpu_relax();
393 }
394}
395
John Stultzdce75a82011-08-10 11:31:03 -0700396
397u64 alarm_forward(struct alarm *alarm, ktime_t now, ktime_t interval)
398{
399 u64 overrun = 1;
400 ktime_t delta;
401
402 delta = ktime_sub(now, alarm->node.expires);
403
404 if (delta.tv64 < 0)
405 return 0;
406
407 if (unlikely(delta.tv64 >= interval.tv64)) {
408 s64 incr = ktime_to_ns(interval);
409
410 overrun = ktime_divns(delta, incr);
411
412 alarm->node.expires = ktime_add_ns(alarm->node.expires,
413 incr*overrun);
414
415 if (alarm->node.expires.tv64 > now.tv64)
416 return overrun;
417 /*
418 * This (and the ktime_add() below) is the
419 * correction for exact:
420 */
421 overrun++;
422 }
423
424 alarm->node.expires = ktime_add(alarm->node.expires, interval);
425 return overrun;
426}
427
Todd Poynor6cffe002013-05-15 14:38:11 -0700428u64 alarm_forward_now(struct alarm *alarm, ktime_t interval)
429{
430 struct alarm_base *base = &alarm_bases[alarm->type];
431
432 return alarm_forward(alarm, base->gettime(), interval);
433}
John Stultzdce75a82011-08-10 11:31:03 -0700434
435
436
John Stultz180bf812011-04-28 12:58:11 -0700437/**
John Stultz9a7adcf2011-01-11 09:54:33 -0800438 * clock2alarm - helper that converts from clockid to alarmtypes
439 * @clockid: clockid.
John Stultz9a7adcf2011-01-11 09:54:33 -0800440 */
441static enum alarmtimer_type clock2alarm(clockid_t clockid)
442{
443 if (clockid == CLOCK_REALTIME_ALARM)
444 return ALARM_REALTIME;
445 if (clockid == CLOCK_BOOTTIME_ALARM)
446 return ALARM_BOOTTIME;
447 return -1;
448}
449
John Stultz180bf812011-04-28 12:58:11 -0700450/**
John Stultz9a7adcf2011-01-11 09:54:33 -0800451 * alarm_handle_timer - Callback for posix timers
452 * @alarm: alarm that fired
453 *
454 * Posix timer callback for expired alarm timers.
455 */
John Stultz4b413082011-08-10 10:37:59 -0700456static enum alarmtimer_restart alarm_handle_timer(struct alarm *alarm,
457 ktime_t now)
John Stultz9a7adcf2011-01-11 09:54:33 -0800458{
459 struct k_itimer *ptr = container_of(alarm, struct k_itimer,
John Stultz9e264762011-08-10 12:09:24 -0700460 it.alarm.alarmtimer);
John Stultz9a7adcf2011-01-11 09:54:33 -0800461 if (posix_timer_event(ptr, 0) != 0)
462 ptr->it_overrun++;
John Stultz4b413082011-08-10 10:37:59 -0700463
John Stultz54da23b2011-08-10 11:08:07 -0700464 /* Re-add periodic timers */
John Stultz9e264762011-08-10 12:09:24 -0700465 if (ptr->it.alarm.interval.tv64) {
466 ptr->it_overrun += alarm_forward(alarm, now,
467 ptr->it.alarm.interval);
John Stultz54da23b2011-08-10 11:08:07 -0700468 return ALARMTIMER_RESTART;
469 }
John Stultz4b413082011-08-10 10:37:59 -0700470 return ALARMTIMER_NORESTART;
John Stultz9a7adcf2011-01-11 09:54:33 -0800471}
472
John Stultz180bf812011-04-28 12:58:11 -0700473/**
John Stultz9a7adcf2011-01-11 09:54:33 -0800474 * alarm_clock_getres - posix getres interface
475 * @which_clock: clockid
476 * @tp: timespec to fill
477 *
478 * Returns the granularity of underlying alarm base clock
479 */
480static int alarm_clock_getres(const clockid_t which_clock, struct timespec *tp)
481{
482 clockid_t baseid = alarm_bases[clock2alarm(which_clock)].base_clockid;
483
John Stultz1c6b39a2011-06-16 18:47:37 -0700484 if (!alarmtimer_get_rtcdev())
485 return -ENOTSUPP;
486
John Stultz9a7adcf2011-01-11 09:54:33 -0800487 return hrtimer_get_res(baseid, tp);
488}
489
490/**
491 * alarm_clock_get - posix clock_get interface
492 * @which_clock: clockid
493 * @tp: timespec to fill.
494 *
495 * Provides the underlying alarm base time.
496 */
497static int alarm_clock_get(clockid_t which_clock, struct timespec *tp)
498{
499 struct alarm_base *base = &alarm_bases[clock2alarm(which_clock)];
500
John Stultz1c6b39a2011-06-16 18:47:37 -0700501 if (!alarmtimer_get_rtcdev())
502 return -ENOTSUPP;
503
John Stultz9a7adcf2011-01-11 09:54:33 -0800504 *tp = ktime_to_timespec(base->gettime());
505 return 0;
506}
507
508/**
509 * alarm_timer_create - posix timer_create interface
510 * @new_timer: k_itimer pointer to manage
511 *
512 * Initializes the k_itimer structure.
513 */
514static int alarm_timer_create(struct k_itimer *new_timer)
515{
516 enum alarmtimer_type type;
517 struct alarm_base *base;
518
John Stultz1c6b39a2011-06-16 18:47:37 -0700519 if (!alarmtimer_get_rtcdev())
520 return -ENOTSUPP;
521
John Stultz9a7adcf2011-01-11 09:54:33 -0800522 if (!capable(CAP_WAKE_ALARM))
523 return -EPERM;
524
525 type = clock2alarm(new_timer->it_clock);
526 base = &alarm_bases[type];
John Stultz9e264762011-08-10 12:09:24 -0700527 alarm_init(&new_timer->it.alarm.alarmtimer, type, alarm_handle_timer);
John Stultz9a7adcf2011-01-11 09:54:33 -0800528 return 0;
529}
530
531/**
532 * alarm_timer_get - posix timer_get interface
533 * @new_timer: k_itimer pointer
534 * @cur_setting: itimerspec data to fill
535 *
536 * Copies the itimerspec data out from the k_itimer
537 */
538static void alarm_timer_get(struct k_itimer *timr,
539 struct itimerspec *cur_setting)
540{
John Stultzea7802f2011-08-04 07:51:56 -0700541 memset(cur_setting, 0, sizeof(struct itimerspec));
542
John Stultz9a7adcf2011-01-11 09:54:33 -0800543 cur_setting->it_interval =
John Stultz9e264762011-08-10 12:09:24 -0700544 ktime_to_timespec(timr->it.alarm.interval);
John Stultz9a7adcf2011-01-11 09:54:33 -0800545 cur_setting->it_value =
John Stultz9e264762011-08-10 12:09:24 -0700546 ktime_to_timespec(timr->it.alarm.alarmtimer.node.expires);
John Stultz9a7adcf2011-01-11 09:54:33 -0800547 return;
548}
549
550/**
551 * alarm_timer_del - posix timer_del interface
552 * @timr: k_itimer pointer to be deleted
553 *
554 * Cancels any programmed alarms for the given timer.
555 */
556static int alarm_timer_del(struct k_itimer *timr)
557{
John Stultz1c6b39a2011-06-16 18:47:37 -0700558 if (!rtcdev)
559 return -ENOTSUPP;
560
John Stultz9082c462011-08-10 12:41:36 -0700561 if (alarm_try_to_cancel(&timr->it.alarm.alarmtimer) < 0)
562 return TIMER_RETRY;
563
John Stultz9a7adcf2011-01-11 09:54:33 -0800564 return 0;
565}
566
567/**
568 * alarm_timer_set - posix timer_set interface
569 * @timr: k_itimer pointer to be deleted
570 * @flags: timer flags
571 * @new_setting: itimerspec to be used
572 * @old_setting: itimerspec being replaced
573 *
574 * Sets the timer to new_setting, and starts the timer.
575 */
576static int alarm_timer_set(struct k_itimer *timr, int flags,
577 struct itimerspec *new_setting,
578 struct itimerspec *old_setting)
579{
John Stultz1c6b39a2011-06-16 18:47:37 -0700580 if (!rtcdev)
581 return -ENOTSUPP;
582
John Stultz971c90b2011-08-04 07:25:35 -0700583 if (old_setting)
584 alarm_timer_get(timr, old_setting);
John Stultz9a7adcf2011-01-11 09:54:33 -0800585
586 /* If the timer was already set, cancel it */
John Stultz9082c462011-08-10 12:41:36 -0700587 if (alarm_try_to_cancel(&timr->it.alarm.alarmtimer) < 0)
588 return TIMER_RETRY;
John Stultz9a7adcf2011-01-11 09:54:33 -0800589
590 /* start the timer */
John Stultz9e264762011-08-10 12:09:24 -0700591 timr->it.alarm.interval = timespec_to_ktime(new_setting->it_interval);
592 alarm_start(&timr->it.alarm.alarmtimer,
593 timespec_to_ktime(new_setting->it_value));
John Stultz9a7adcf2011-01-11 09:54:33 -0800594 return 0;
595}
596
597/**
598 * alarmtimer_nsleep_wakeup - Wakeup function for alarm_timer_nsleep
599 * @alarm: ptr to alarm that fired
600 *
601 * Wakes up the task that set the alarmtimer
602 */
John Stultz4b413082011-08-10 10:37:59 -0700603static enum alarmtimer_restart alarmtimer_nsleep_wakeup(struct alarm *alarm,
604 ktime_t now)
John Stultz9a7adcf2011-01-11 09:54:33 -0800605{
606 struct task_struct *task = (struct task_struct *)alarm->data;
607
608 alarm->data = NULL;
609 if (task)
610 wake_up_process(task);
John Stultz4b413082011-08-10 10:37:59 -0700611 return ALARMTIMER_NORESTART;
John Stultz9a7adcf2011-01-11 09:54:33 -0800612}
613
614/**
615 * alarmtimer_do_nsleep - Internal alarmtimer nsleep implementation
616 * @alarm: ptr to alarmtimer
617 * @absexp: absolute expiration time
618 *
619 * Sets the alarm timer and sleeps until it is fired or interrupted.
620 */
621static int alarmtimer_do_nsleep(struct alarm *alarm, ktime_t absexp)
622{
623 alarm->data = (void *)current;
624 do {
625 set_current_state(TASK_INTERRUPTIBLE);
John Stultz9e264762011-08-10 12:09:24 -0700626 alarm_start(alarm, absexp);
John Stultz9a7adcf2011-01-11 09:54:33 -0800627 if (likely(alarm->data))
628 schedule();
629
630 alarm_cancel(alarm);
631 } while (alarm->data && !signal_pending(current));
632
633 __set_current_state(TASK_RUNNING);
634
635 return (alarm->data == NULL);
636}
637
638
639/**
640 * update_rmtp - Update remaining timespec value
641 * @exp: expiration time
642 * @type: timer type
643 * @rmtp: user pointer to remaining timepsec value
644 *
645 * Helper function that fills in rmtp value with time between
646 * now and the exp value
647 */
648static int update_rmtp(ktime_t exp, enum alarmtimer_type type,
649 struct timespec __user *rmtp)
650{
651 struct timespec rmt;
652 ktime_t rem;
653
654 rem = ktime_sub(exp, alarm_bases[type].gettime());
655
656 if (rem.tv64 <= 0)
657 return 0;
658 rmt = ktime_to_timespec(rem);
659
660 if (copy_to_user(rmtp, &rmt, sizeof(*rmtp)))
661 return -EFAULT;
662
663 return 1;
664
665}
666
667/**
668 * alarm_timer_nsleep_restart - restartblock alarmtimer nsleep
669 * @restart: ptr to restart block
670 *
671 * Handles restarted clock_nanosleep calls
672 */
673static long __sched alarm_timer_nsleep_restart(struct restart_block *restart)
674{
Thomas Gleixnerab8177b2011-05-20 13:05:15 +0200675 enum alarmtimer_type type = restart->nanosleep.clockid;
John Stultz9a7adcf2011-01-11 09:54:33 -0800676 ktime_t exp;
677 struct timespec __user *rmtp;
678 struct alarm alarm;
679 int ret = 0;
680
681 exp.tv64 = restart->nanosleep.expires;
682 alarm_init(&alarm, type, alarmtimer_nsleep_wakeup);
683
684 if (alarmtimer_do_nsleep(&alarm, exp))
685 goto out;
686
687 if (freezing(current))
688 alarmtimer_freezerset(exp, type);
689
690 rmtp = restart->nanosleep.rmtp;
691 if (rmtp) {
692 ret = update_rmtp(exp, type, rmtp);
693 if (ret <= 0)
694 goto out;
695 }
696
697
698 /* The other values in restart are already filled in */
699 ret = -ERESTART_RESTARTBLOCK;
700out:
701 return ret;
702}
703
704/**
705 * alarm_timer_nsleep - alarmtimer nanosleep
706 * @which_clock: clockid
707 * @flags: determins abstime or relative
708 * @tsreq: requested sleep time (abs or rel)
709 * @rmtp: remaining sleep time saved
710 *
711 * Handles clock_nanosleep calls against _ALARM clockids
712 */
713static int alarm_timer_nsleep(const clockid_t which_clock, int flags,
714 struct timespec *tsreq, struct timespec __user *rmtp)
715{
716 enum alarmtimer_type type = clock2alarm(which_clock);
717 struct alarm alarm;
718 ktime_t exp;
719 int ret = 0;
720 struct restart_block *restart;
721
John Stultz1c6b39a2011-06-16 18:47:37 -0700722 if (!alarmtimer_get_rtcdev())
723 return -ENOTSUPP;
724
John Stultz9a7adcf2011-01-11 09:54:33 -0800725 if (!capable(CAP_WAKE_ALARM))
726 return -EPERM;
727
728 alarm_init(&alarm, type, alarmtimer_nsleep_wakeup);
729
730 exp = timespec_to_ktime(*tsreq);
731 /* Convert (if necessary) to absolute time */
732 if (flags != TIMER_ABSTIME) {
733 ktime_t now = alarm_bases[type].gettime();
734 exp = ktime_add(now, exp);
735 }
736
737 if (alarmtimer_do_nsleep(&alarm, exp))
738 goto out;
739
740 if (freezing(current))
741 alarmtimer_freezerset(exp, type);
742
743 /* abs timers don't set remaining time or restart */
744 if (flags == TIMER_ABSTIME) {
745 ret = -ERESTARTNOHAND;
746 goto out;
747 }
748
749 if (rmtp) {
750 ret = update_rmtp(exp, type, rmtp);
751 if (ret <= 0)
752 goto out;
753 }
754
755 restart = &current_thread_info()->restart_block;
756 restart->fn = alarm_timer_nsleep_restart;
Thomas Gleixnerab8177b2011-05-20 13:05:15 +0200757 restart->nanosleep.clockid = type;
John Stultz9a7adcf2011-01-11 09:54:33 -0800758 restart->nanosleep.expires = exp.tv64;
759 restart->nanosleep.rmtp = rmtp;
760 ret = -ERESTART_RESTARTBLOCK;
761
762out:
763 return ret;
764}
John Stultzff3ead92011-01-11 09:42:13 -0800765
John Stultzff3ead92011-01-11 09:42:13 -0800766
767/* Suspend hook structures */
768static const struct dev_pm_ops alarmtimer_pm_ops = {
769 .suspend = alarmtimer_suspend,
770};
771
772static struct platform_driver alarmtimer_driver = {
773 .driver = {
774 .name = "alarmtimer",
775 .pm = &alarmtimer_pm_ops,
776 }
777};
778
779/**
780 * alarmtimer_init - Initialize alarm timer code
781 *
782 * This function initializes the alarm bases and registers
783 * the posix clock ids.
784 */
785static int __init alarmtimer_init(void)
786{
Thomas Gleixner4523f6a2011-09-14 10:54:29 +0200787 struct platform_device *pdev;
John Stultzff3ead92011-01-11 09:42:13 -0800788 int error = 0;
789 int i;
John Stultz9a7adcf2011-01-11 09:54:33 -0800790 struct k_clock alarm_clock = {
791 .clock_getres = alarm_clock_getres,
792 .clock_get = alarm_clock_get,
793 .timer_create = alarm_timer_create,
794 .timer_set = alarm_timer_set,
795 .timer_del = alarm_timer_del,
796 .timer_get = alarm_timer_get,
797 .nsleep = alarm_timer_nsleep,
798 };
799
Thomas Gleixnerc5e14e72012-03-24 12:46:23 +0100800 alarmtimer_rtc_timer_init();
John Stultzad30dfa2012-03-23 15:52:25 -0700801
John Stultz9a7adcf2011-01-11 09:54:33 -0800802 posix_timers_register_clock(CLOCK_REALTIME_ALARM, &alarm_clock);
803 posix_timers_register_clock(CLOCK_BOOTTIME_ALARM, &alarm_clock);
John Stultzff3ead92011-01-11 09:42:13 -0800804
805 /* Initialize alarm bases */
806 alarm_bases[ALARM_REALTIME].base_clockid = CLOCK_REALTIME;
807 alarm_bases[ALARM_REALTIME].gettime = &ktime_get_real;
808 alarm_bases[ALARM_BOOTTIME].base_clockid = CLOCK_BOOTTIME;
809 alarm_bases[ALARM_BOOTTIME].gettime = &ktime_get_boottime;
810 for (i = 0; i < ALARM_NUMTYPE; i++) {
811 timerqueue_init_head(&alarm_bases[i].timerqueue);
812 spin_lock_init(&alarm_bases[i].lock);
John Stultzff3ead92011-01-11 09:42:13 -0800813 }
John Stultz8bc0daf2011-07-14 18:35:13 -0700814
Thomas Gleixner4523f6a2011-09-14 10:54:29 +0200815 error = alarmtimer_rtc_interface_setup();
816 if (error)
817 return error;
John Stultzff3ead92011-01-11 09:42:13 -0800818
Thomas Gleixner4523f6a2011-09-14 10:54:29 +0200819 error = platform_driver_register(&alarmtimer_driver);
820 if (error)
821 goto out_if;
822
823 pdev = platform_device_register_simple("alarmtimer", -1, NULL, 0);
824 if (IS_ERR(pdev)) {
825 error = PTR_ERR(pdev);
826 goto out_drv;
827 }
Todd Poynor59a93c22012-08-09 00:37:27 -0700828 ws = wakeup_source_register("alarmtimer");
Thomas Gleixner4523f6a2011-09-14 10:54:29 +0200829 return 0;
830
831out_drv:
832 platform_driver_unregister(&alarmtimer_driver);
833out_if:
834 alarmtimer_rtc_interface_remove();
John Stultzff3ead92011-01-11 09:42:13 -0800835 return error;
836}
837device_initcall(alarmtimer_init);