blob: b7045793bd56150a272d572bfe0b5c1a26baca79 [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;
40 struct hrtimer timer;
41 ktime_t (*gettime)(void);
42 clockid_t base_clockid;
John Stultzff3ead92011-01-11 09:42:13 -080043} alarm_bases[ALARM_NUMTYPE];
44
John Stultzc008ba52011-06-16 18:27:09 -070045/* freezer delta & lock used to handle clock_nanosleep triggered wakeups */
46static ktime_t freezer_delta;
47static DEFINE_SPINLOCK(freezer_delta_lock);
48
John Stultz472647d2011-04-29 15:03:10 -070049#ifdef CONFIG_RTC_CLASS
John Stultz180bf812011-04-28 12:58:11 -070050/* rtc timer and device for setting alarm wakeups at suspend */
Thomas Gleixnerc5e14e72012-03-24 12:46:23 +010051static struct rtc_timer rtctimer;
John Stultzff3ead92011-01-11 09:42:13 -080052static struct rtc_device *rtcdev;
John Stultzc008ba52011-06-16 18:27:09 -070053static DEFINE_SPINLOCK(rtcdev_lock);
John Stultzff3ead92011-01-11 09:42:13 -080054
John Stultzc008ba52011-06-16 18:27:09 -070055/**
John Stultzc008ba52011-06-16 18:27:09 -070056 * alarmtimer_get_rtcdev - Return selected rtcdevice
57 *
58 * This function returns the rtc device to use for wakealarms.
59 * If one has not already been chosen, it checks to see if a
60 * functional rtc device is available.
61 */
62static struct rtc_device *alarmtimer_get_rtcdev(void)
63{
John Stultzc008ba52011-06-16 18:27:09 -070064 unsigned long flags;
65 struct rtc_device *ret;
66
67 spin_lock_irqsave(&rtcdev_lock, flags);
John Stultzc008ba52011-06-16 18:27:09 -070068 ret = rtcdev;
69 spin_unlock_irqrestore(&rtcdev_lock, flags);
70
71 return ret;
72}
John Stultz8bc0daf2011-07-14 18:35:13 -070073
74
75static int alarmtimer_rtc_add_device(struct device *dev,
76 struct class_interface *class_intf)
77{
78 unsigned long flags;
79 struct rtc_device *rtc = to_rtc_device(dev);
80
81 if (rtcdev)
82 return -EBUSY;
83
84 if (!rtc->ops->set_alarm)
85 return -1;
86 if (!device_may_wakeup(rtc->dev.parent))
87 return -1;
88
89 spin_lock_irqsave(&rtcdev_lock, flags);
90 if (!rtcdev) {
91 rtcdev = rtc;
92 /* hold a reference so it doesn't go away */
93 get_device(dev);
94 }
95 spin_unlock_irqrestore(&rtcdev_lock, flags);
96 return 0;
97}
98
Thomas Gleixnerc5e14e72012-03-24 12:46:23 +010099static inline void alarmtimer_rtc_timer_init(void)
100{
101 rtc_timer_init(&rtctimer, NULL, NULL);
102}
103
John Stultz8bc0daf2011-07-14 18:35:13 -0700104static struct class_interface alarmtimer_rtc_interface = {
105 .add_dev = &alarmtimer_rtc_add_device,
106};
107
Thomas Gleixner4523f6a2011-09-14 10:54:29 +0200108static int alarmtimer_rtc_interface_setup(void)
John Stultz8bc0daf2011-07-14 18:35:13 -0700109{
110 alarmtimer_rtc_interface.class = rtc_class;
Thomas Gleixner4523f6a2011-09-14 10:54:29 +0200111 return class_interface_register(&alarmtimer_rtc_interface);
112}
113static void alarmtimer_rtc_interface_remove(void)
114{
115 class_interface_unregister(&alarmtimer_rtc_interface);
John Stultz8bc0daf2011-07-14 18:35:13 -0700116}
John Stultz1c6b39a2011-06-16 18:47:37 -0700117#else
Thomas Gleixner4523f6a2011-09-14 10:54:29 +0200118static inline struct rtc_device *alarmtimer_get_rtcdev(void)
119{
120 return NULL;
121}
122#define rtcdev (NULL)
123static inline int alarmtimer_rtc_interface_setup(void) { return 0; }
124static inline void alarmtimer_rtc_interface_remove(void) { }
Thomas Gleixnerc5e14e72012-03-24 12:46:23 +0100125static inline void alarmtimer_rtc_timer_init(void) { }
John Stultzc008ba52011-06-16 18:27:09 -0700126#endif
John Stultzff3ead92011-01-11 09:42:13 -0800127
John Stultz180bf812011-04-28 12:58:11 -0700128/**
John Stultzff3ead92011-01-11 09:42:13 -0800129 * alarmtimer_enqueue - Adds an alarm timer to an alarm_base timerqueue
130 * @base: pointer to the base where the timer is being run
131 * @alarm: pointer to alarm being enqueued.
132 *
133 * Adds alarm to a alarm_base timerqueue and if necessary sets
134 * an hrtimer to run.
135 *
136 * Must hold base->lock when calling.
137 */
138static void alarmtimer_enqueue(struct alarm_base *base, struct alarm *alarm)
139{
140 timerqueue_add(&base->timerqueue, &alarm->node);
John Stultza28cde82011-08-10 12:30:21 -0700141 alarm->state |= ALARMTIMER_STATE_ENQUEUED;
142
John Stultzff3ead92011-01-11 09:42:13 -0800143 if (&alarm->node == timerqueue_getnext(&base->timerqueue)) {
144 hrtimer_try_to_cancel(&base->timer);
145 hrtimer_start(&base->timer, alarm->node.expires,
146 HRTIMER_MODE_ABS);
147 }
148}
149
John Stultz180bf812011-04-28 12:58:11 -0700150/**
John Stultzff3ead92011-01-11 09:42:13 -0800151 * alarmtimer_remove - Removes an alarm timer from an alarm_base timerqueue
152 * @base: pointer to the base where the timer is running
153 * @alarm: pointer to alarm being removed
154 *
155 * Removes alarm to a alarm_base timerqueue and if necessary sets
156 * a new timer to run.
157 *
158 * Must hold base->lock when calling.
159 */
160static void alarmtimer_remove(struct alarm_base *base, struct alarm *alarm)
161{
162 struct timerqueue_node *next = timerqueue_getnext(&base->timerqueue);
163
John Stultza28cde82011-08-10 12:30:21 -0700164 if (!(alarm->state & ALARMTIMER_STATE_ENQUEUED))
165 return;
166
John Stultzff3ead92011-01-11 09:42:13 -0800167 timerqueue_del(&base->timerqueue, &alarm->node);
John Stultza28cde82011-08-10 12:30:21 -0700168 alarm->state &= ~ALARMTIMER_STATE_ENQUEUED;
169
John Stultzff3ead92011-01-11 09:42:13 -0800170 if (next == &alarm->node) {
171 hrtimer_try_to_cancel(&base->timer);
172 next = timerqueue_getnext(&base->timerqueue);
173 if (!next)
174 return;
175 hrtimer_start(&base->timer, next->expires, HRTIMER_MODE_ABS);
176 }
177}
178
John Stultz7068b7a2011-04-28 13:29:18 -0700179
John Stultz180bf812011-04-28 12:58:11 -0700180/**
John Stultz7068b7a2011-04-28 13:29:18 -0700181 * alarmtimer_fired - Handles alarm hrtimer being fired.
182 * @timer: pointer to hrtimer being run
John Stultzff3ead92011-01-11 09:42:13 -0800183 *
John Stultz180bf812011-04-28 12:58:11 -0700184 * When a alarm timer fires, this runs through the timerqueue to
185 * see which alarms expired, and runs those. If there are more alarm
186 * timers queued for the future, we set the hrtimer to fire when
187 * when the next future alarm timer expires.
John Stultzff3ead92011-01-11 09:42:13 -0800188 */
John Stultz7068b7a2011-04-28 13:29:18 -0700189static enum hrtimer_restart alarmtimer_fired(struct hrtimer *timer)
John Stultzff3ead92011-01-11 09:42:13 -0800190{
John Stultz7068b7a2011-04-28 13:29:18 -0700191 struct alarm_base *base = container_of(timer, struct alarm_base, timer);
John Stultzff3ead92011-01-11 09:42:13 -0800192 struct timerqueue_node *next;
193 unsigned long flags;
194 ktime_t now;
John Stultz7068b7a2011-04-28 13:29:18 -0700195 int ret = HRTIMER_NORESTART;
John Stultz54da23b2011-08-10 11:08:07 -0700196 int restart = ALARMTIMER_NORESTART;
John Stultzff3ead92011-01-11 09:42:13 -0800197
198 spin_lock_irqsave(&base->lock, flags);
199 now = base->gettime();
200 while ((next = timerqueue_getnext(&base->timerqueue))) {
201 struct alarm *alarm;
202 ktime_t expired = next->expires;
203
Thomas Gleixnerc9c024b2011-12-05 21:20:23 +0100204 if (expired.tv64 > now.tv64)
John Stultzff3ead92011-01-11 09:42:13 -0800205 break;
206
207 alarm = container_of(next, struct alarm, node);
208
209 timerqueue_del(&base->timerqueue, &alarm->node);
John Stultza28cde82011-08-10 12:30:21 -0700210 alarm->state &= ~ALARMTIMER_STATE_ENQUEUED;
John Stultz54da23b2011-08-10 11:08:07 -0700211
John Stultza28cde82011-08-10 12:30:21 -0700212 alarm->state |= ALARMTIMER_STATE_CALLBACK;
John Stultz54da23b2011-08-10 11:08:07 -0700213 spin_unlock_irqrestore(&base->lock, flags);
214 if (alarm->function)
215 restart = alarm->function(alarm, now);
216 spin_lock_irqsave(&base->lock, flags);
John Stultza28cde82011-08-10 12:30:21 -0700217 alarm->state &= ~ALARMTIMER_STATE_CALLBACK;
John Stultz54da23b2011-08-10 11:08:07 -0700218
219 if (restart != ALARMTIMER_NORESTART) {
John Stultzff3ead92011-01-11 09:42:13 -0800220 timerqueue_add(&base->timerqueue, &alarm->node);
John Stultza28cde82011-08-10 12:30:21 -0700221 alarm->state |= ALARMTIMER_STATE_ENQUEUED;
John Stultzff3ead92011-01-11 09:42:13 -0800222 }
John Stultzff3ead92011-01-11 09:42:13 -0800223 }
224
225 if (next) {
John Stultz7068b7a2011-04-28 13:29:18 -0700226 hrtimer_set_expires(&base->timer, next->expires);
227 ret = HRTIMER_RESTART;
John Stultzff3ead92011-01-11 09:42:13 -0800228 }
229 spin_unlock_irqrestore(&base->lock, flags);
John Stultzff3ead92011-01-11 09:42:13 -0800230
John Stultz7068b7a2011-04-28 13:29:18 -0700231 return ret;
John Stultzff3ead92011-01-11 09:42:13 -0800232
John Stultzff3ead92011-01-11 09:42:13 -0800233}
234
John Stultz472647d2011-04-29 15:03:10 -0700235#ifdef CONFIG_RTC_CLASS
John Stultz180bf812011-04-28 12:58:11 -0700236/**
John Stultzff3ead92011-01-11 09:42:13 -0800237 * alarmtimer_suspend - Suspend time callback
238 * @dev: unused
239 * @state: unused
240 *
241 * When we are going into suspend, we look through the bases
242 * to see which is the soonest timer to expire. We then
243 * set an rtc timer to fire that far into the future, which
244 * will wake us from suspend.
245 */
246static int alarmtimer_suspend(struct device *dev)
247{
248 struct rtc_time tm;
249 ktime_t min, now;
250 unsigned long flags;
John Stultzc008ba52011-06-16 18:27:09 -0700251 struct rtc_device *rtc;
John Stultzff3ead92011-01-11 09:42:13 -0800252 int i;
253
254 spin_lock_irqsave(&freezer_delta_lock, flags);
255 min = freezer_delta;
256 freezer_delta = ktime_set(0, 0);
257 spin_unlock_irqrestore(&freezer_delta_lock, flags);
258
John Stultz8bc0daf2011-07-14 18:35:13 -0700259 rtc = alarmtimer_get_rtcdev();
John Stultzff3ead92011-01-11 09:42:13 -0800260 /* If we have no rtcdev, just return */
John Stultzc008ba52011-06-16 18:27:09 -0700261 if (!rtc)
John Stultzff3ead92011-01-11 09:42:13 -0800262 return 0;
263
264 /* Find the soonest timer to expire*/
265 for (i = 0; i < ALARM_NUMTYPE; i++) {
266 struct alarm_base *base = &alarm_bases[i];
267 struct timerqueue_node *next;
268 ktime_t delta;
269
270 spin_lock_irqsave(&base->lock, flags);
271 next = timerqueue_getnext(&base->timerqueue);
272 spin_unlock_irqrestore(&base->lock, flags);
273 if (!next)
274 continue;
275 delta = ktime_sub(next->expires, base->gettime());
276 if (!min.tv64 || (delta.tv64 < min.tv64))
277 min = delta;
278 }
279 if (min.tv64 == 0)
280 return 0;
281
282 /* XXX - Should we enforce a minimum sleep time? */
283 WARN_ON(min.tv64 < NSEC_PER_SEC);
284
285 /* Setup an rtc timer to fire that far in the future */
John Stultzc008ba52011-06-16 18:27:09 -0700286 rtc_timer_cancel(rtc, &rtctimer);
287 rtc_read_time(rtc, &tm);
John Stultzff3ead92011-01-11 09:42:13 -0800288 now = rtc_tm_to_ktime(tm);
289 now = ktime_add(now, min);
290
John Stultzc008ba52011-06-16 18:27:09 -0700291 rtc_timer_start(rtc, &rtctimer, now, ktime_set(0, 0));
John Stultzff3ead92011-01-11 09:42:13 -0800292
293 return 0;
294}
John Stultz472647d2011-04-29 15:03:10 -0700295#else
296static int alarmtimer_suspend(struct device *dev)
297{
298 return 0;
299}
300#endif
John Stultzff3ead92011-01-11 09:42:13 -0800301
John Stultz9a7adcf2011-01-11 09:54:33 -0800302static void alarmtimer_freezerset(ktime_t absexp, enum alarmtimer_type type)
303{
304 ktime_t delta;
305 unsigned long flags;
306 struct alarm_base *base = &alarm_bases[type];
307
308 delta = ktime_sub(absexp, base->gettime());
309
310 spin_lock_irqsave(&freezer_delta_lock, flags);
311 if (!freezer_delta.tv64 || (delta.tv64 < freezer_delta.tv64))
312 freezer_delta = delta;
313 spin_unlock_irqrestore(&freezer_delta_lock, flags);
314}
315
316
John Stultz180bf812011-04-28 12:58:11 -0700317/**
John Stultzff3ead92011-01-11 09:42:13 -0800318 * alarm_init - Initialize an alarm structure
319 * @alarm: ptr to alarm to be initialized
320 * @type: the type of the alarm
321 * @function: callback that is run when the alarm fires
John Stultzff3ead92011-01-11 09:42:13 -0800322 */
323void alarm_init(struct alarm *alarm, enum alarmtimer_type type,
John Stultz4b413082011-08-10 10:37:59 -0700324 enum alarmtimer_restart (*function)(struct alarm *, ktime_t))
John Stultzff3ead92011-01-11 09:42:13 -0800325{
326 timerqueue_init(&alarm->node);
John Stultzff3ead92011-01-11 09:42:13 -0800327 alarm->function = function;
328 alarm->type = type;
John Stultza28cde82011-08-10 12:30:21 -0700329 alarm->state = ALARMTIMER_STATE_INACTIVE;
John Stultzff3ead92011-01-11 09:42:13 -0800330}
331
John Stultz180bf812011-04-28 12:58:11 -0700332/**
John Stultzff3ead92011-01-11 09:42:13 -0800333 * alarm_start - Sets an alarm to fire
334 * @alarm: ptr to alarm to set
335 * @start: time to run the alarm
John Stultzff3ead92011-01-11 09:42:13 -0800336 */
John Stultz9e264762011-08-10 12:09:24 -0700337void alarm_start(struct alarm *alarm, ktime_t start)
John Stultzff3ead92011-01-11 09:42:13 -0800338{
339 struct alarm_base *base = &alarm_bases[alarm->type];
340 unsigned long flags;
341
342 spin_lock_irqsave(&base->lock, flags);
John Stultza28cde82011-08-10 12:30:21 -0700343 if (alarmtimer_active(alarm))
John Stultzff3ead92011-01-11 09:42:13 -0800344 alarmtimer_remove(base, alarm);
345 alarm->node.expires = start;
John Stultzff3ead92011-01-11 09:42:13 -0800346 alarmtimer_enqueue(base, alarm);
John Stultzff3ead92011-01-11 09:42:13 -0800347 spin_unlock_irqrestore(&base->lock, flags);
348}
349
John Stultz180bf812011-04-28 12:58:11 -0700350/**
John Stultz9082c462011-08-10 12:41:36 -0700351 * alarm_try_to_cancel - Tries to cancel an alarm timer
John Stultzff3ead92011-01-11 09:42:13 -0800352 * @alarm: ptr to alarm to be canceled
John Stultz9082c462011-08-10 12:41:36 -0700353 *
354 * Returns 1 if the timer was canceled, 0 if it was not running,
355 * and -1 if the callback was running
John Stultzff3ead92011-01-11 09:42:13 -0800356 */
John Stultz9082c462011-08-10 12:41:36 -0700357int alarm_try_to_cancel(struct alarm *alarm)
John Stultzff3ead92011-01-11 09:42:13 -0800358{
359 struct alarm_base *base = &alarm_bases[alarm->type];
360 unsigned long flags;
John Stultz9082c462011-08-10 12:41:36 -0700361 int ret = -1;
John Stultzff3ead92011-01-11 09:42:13 -0800362 spin_lock_irqsave(&base->lock, flags);
John Stultz9082c462011-08-10 12:41:36 -0700363
364 if (alarmtimer_callback_running(alarm))
365 goto out;
366
367 if (alarmtimer_is_queued(alarm)) {
John Stultzff3ead92011-01-11 09:42:13 -0800368 alarmtimer_remove(base, alarm);
John Stultz9082c462011-08-10 12:41:36 -0700369 ret = 1;
370 } else
371 ret = 0;
372out:
John Stultzff3ead92011-01-11 09:42:13 -0800373 spin_unlock_irqrestore(&base->lock, flags);
John Stultz9082c462011-08-10 12:41:36 -0700374 return ret;
John Stultzff3ead92011-01-11 09:42:13 -0800375}
376
377
John Stultz9082c462011-08-10 12:41:36 -0700378/**
379 * alarm_cancel - Spins trying to cancel an alarm timer until it is done
380 * @alarm: ptr to alarm to be canceled
381 *
382 * Returns 1 if the timer was canceled, 0 if it was not active.
383 */
384int alarm_cancel(struct alarm *alarm)
385{
386 for (;;) {
387 int ret = alarm_try_to_cancel(alarm);
388 if (ret >= 0)
389 return ret;
390 cpu_relax();
391 }
392}
393
John Stultzdce75a82011-08-10 11:31:03 -0700394
395u64 alarm_forward(struct alarm *alarm, ktime_t now, ktime_t interval)
396{
397 u64 overrun = 1;
398 ktime_t delta;
399
400 delta = ktime_sub(now, alarm->node.expires);
401
402 if (delta.tv64 < 0)
403 return 0;
404
405 if (unlikely(delta.tv64 >= interval.tv64)) {
406 s64 incr = ktime_to_ns(interval);
407
408 overrun = ktime_divns(delta, incr);
409
410 alarm->node.expires = ktime_add_ns(alarm->node.expires,
411 incr*overrun);
412
413 if (alarm->node.expires.tv64 > now.tv64)
414 return overrun;
415 /*
416 * This (and the ktime_add() below) is the
417 * correction for exact:
418 */
419 overrun++;
420 }
421
422 alarm->node.expires = ktime_add(alarm->node.expires, interval);
423 return overrun;
424}
425
426
427
428
John Stultz180bf812011-04-28 12:58:11 -0700429/**
John Stultz9a7adcf2011-01-11 09:54:33 -0800430 * clock2alarm - helper that converts from clockid to alarmtypes
431 * @clockid: clockid.
John Stultz9a7adcf2011-01-11 09:54:33 -0800432 */
433static enum alarmtimer_type clock2alarm(clockid_t clockid)
434{
435 if (clockid == CLOCK_REALTIME_ALARM)
436 return ALARM_REALTIME;
437 if (clockid == CLOCK_BOOTTIME_ALARM)
438 return ALARM_BOOTTIME;
439 return -1;
440}
441
John Stultz180bf812011-04-28 12:58:11 -0700442/**
John Stultz9a7adcf2011-01-11 09:54:33 -0800443 * alarm_handle_timer - Callback for posix timers
444 * @alarm: alarm that fired
445 *
446 * Posix timer callback for expired alarm timers.
447 */
John Stultz4b413082011-08-10 10:37:59 -0700448static enum alarmtimer_restart alarm_handle_timer(struct alarm *alarm,
449 ktime_t now)
John Stultz9a7adcf2011-01-11 09:54:33 -0800450{
451 struct k_itimer *ptr = container_of(alarm, struct k_itimer,
John Stultz9e264762011-08-10 12:09:24 -0700452 it.alarm.alarmtimer);
John Stultz9a7adcf2011-01-11 09:54:33 -0800453 if (posix_timer_event(ptr, 0) != 0)
454 ptr->it_overrun++;
John Stultz4b413082011-08-10 10:37:59 -0700455
John Stultz54da23b2011-08-10 11:08:07 -0700456 /* Re-add periodic timers */
John Stultz9e264762011-08-10 12:09:24 -0700457 if (ptr->it.alarm.interval.tv64) {
458 ptr->it_overrun += alarm_forward(alarm, now,
459 ptr->it.alarm.interval);
John Stultz54da23b2011-08-10 11:08:07 -0700460 return ALARMTIMER_RESTART;
461 }
John Stultz4b413082011-08-10 10:37:59 -0700462 return ALARMTIMER_NORESTART;
John Stultz9a7adcf2011-01-11 09:54:33 -0800463}
464
John Stultz180bf812011-04-28 12:58:11 -0700465/**
John Stultz9a7adcf2011-01-11 09:54:33 -0800466 * alarm_clock_getres - posix getres interface
467 * @which_clock: clockid
468 * @tp: timespec to fill
469 *
470 * Returns the granularity of underlying alarm base clock
471 */
472static int alarm_clock_getres(const clockid_t which_clock, struct timespec *tp)
473{
474 clockid_t baseid = alarm_bases[clock2alarm(which_clock)].base_clockid;
475
John Stultz1c6b39a2011-06-16 18:47:37 -0700476 if (!alarmtimer_get_rtcdev())
KOSAKI Motohiro3e050922013-10-14 17:33:16 -0400477 return -EINVAL;
John Stultz1c6b39a2011-06-16 18:47:37 -0700478
John Stultz9a7adcf2011-01-11 09:54:33 -0800479 return hrtimer_get_res(baseid, tp);
480}
481
482/**
483 * alarm_clock_get - posix clock_get interface
484 * @which_clock: clockid
485 * @tp: timespec to fill.
486 *
487 * Provides the underlying alarm base time.
488 */
489static int alarm_clock_get(clockid_t which_clock, struct timespec *tp)
490{
491 struct alarm_base *base = &alarm_bases[clock2alarm(which_clock)];
492
John Stultz1c6b39a2011-06-16 18:47:37 -0700493 if (!alarmtimer_get_rtcdev())
KOSAKI Motohiro3e050922013-10-14 17:33:16 -0400494 return -EINVAL;
John Stultz1c6b39a2011-06-16 18:47:37 -0700495
John Stultz9a7adcf2011-01-11 09:54:33 -0800496 *tp = ktime_to_timespec(base->gettime());
497 return 0;
498}
499
500/**
501 * alarm_timer_create - posix timer_create interface
502 * @new_timer: k_itimer pointer to manage
503 *
504 * Initializes the k_itimer structure.
505 */
506static int alarm_timer_create(struct k_itimer *new_timer)
507{
508 enum alarmtimer_type type;
509 struct alarm_base *base;
510
John Stultz1c6b39a2011-06-16 18:47:37 -0700511 if (!alarmtimer_get_rtcdev())
512 return -ENOTSUPP;
513
John Stultz9a7adcf2011-01-11 09:54:33 -0800514 if (!capable(CAP_WAKE_ALARM))
515 return -EPERM;
516
517 type = clock2alarm(new_timer->it_clock);
518 base = &alarm_bases[type];
John Stultz9e264762011-08-10 12:09:24 -0700519 alarm_init(&new_timer->it.alarm.alarmtimer, type, alarm_handle_timer);
John Stultz9a7adcf2011-01-11 09:54:33 -0800520 return 0;
521}
522
523/**
524 * alarm_timer_get - posix timer_get interface
525 * @new_timer: k_itimer pointer
526 * @cur_setting: itimerspec data to fill
527 *
528 * Copies the itimerspec data out from the k_itimer
529 */
530static void alarm_timer_get(struct k_itimer *timr,
531 struct itimerspec *cur_setting)
532{
John Stultzea7802f2011-08-04 07:51:56 -0700533 memset(cur_setting, 0, sizeof(struct itimerspec));
534
John Stultz9a7adcf2011-01-11 09:54:33 -0800535 cur_setting->it_interval =
John Stultz9e264762011-08-10 12:09:24 -0700536 ktime_to_timespec(timr->it.alarm.interval);
John Stultz9a7adcf2011-01-11 09:54:33 -0800537 cur_setting->it_value =
John Stultz9e264762011-08-10 12:09:24 -0700538 ktime_to_timespec(timr->it.alarm.alarmtimer.node.expires);
John Stultz9a7adcf2011-01-11 09:54:33 -0800539 return;
540}
541
542/**
543 * alarm_timer_del - posix timer_del interface
544 * @timr: k_itimer pointer to be deleted
545 *
546 * Cancels any programmed alarms for the given timer.
547 */
548static int alarm_timer_del(struct k_itimer *timr)
549{
John Stultz1c6b39a2011-06-16 18:47:37 -0700550 if (!rtcdev)
551 return -ENOTSUPP;
552
John Stultz9082c462011-08-10 12:41:36 -0700553 if (alarm_try_to_cancel(&timr->it.alarm.alarmtimer) < 0)
554 return TIMER_RETRY;
555
John Stultz9a7adcf2011-01-11 09:54:33 -0800556 return 0;
557}
558
559/**
560 * alarm_timer_set - posix timer_set interface
561 * @timr: k_itimer pointer to be deleted
562 * @flags: timer flags
563 * @new_setting: itimerspec to be used
564 * @old_setting: itimerspec being replaced
565 *
566 * Sets the timer to new_setting, and starts the timer.
567 */
568static int alarm_timer_set(struct k_itimer *timr, int flags,
569 struct itimerspec *new_setting,
570 struct itimerspec *old_setting)
571{
John Stultz299e6672014-07-07 14:06:11 -0700572 ktime_t exp;
573
John Stultz1c6b39a2011-06-16 18:47:37 -0700574 if (!rtcdev)
575 return -ENOTSUPP;
576
John Stultz299e6672014-07-07 14:06:11 -0700577 if (flags & ~TIMER_ABSTIME)
578 return -EINVAL;
579
John Stultz971c90b2011-08-04 07:25:35 -0700580 if (old_setting)
581 alarm_timer_get(timr, old_setting);
John Stultz9a7adcf2011-01-11 09:54:33 -0800582
583 /* If the timer was already set, cancel it */
John Stultz9082c462011-08-10 12:41:36 -0700584 if (alarm_try_to_cancel(&timr->it.alarm.alarmtimer) < 0)
585 return TIMER_RETRY;
John Stultz9a7adcf2011-01-11 09:54:33 -0800586
587 /* start the timer */
John Stultz9e264762011-08-10 12:09:24 -0700588 timr->it.alarm.interval = timespec_to_ktime(new_setting->it_interval);
John Stultz299e6672014-07-07 14:06:11 -0700589 exp = timespec_to_ktime(new_setting->it_value);
590 /* Convert (if necessary) to absolute time */
591 if (flags != TIMER_ABSTIME) {
592 ktime_t now;
593
594 now = alarm_bases[timr->it.alarm.alarmtimer.type].gettime();
595 exp = ktime_add(now, exp);
596 }
597
598 alarm_start(&timr->it.alarm.alarmtimer, exp);
John Stultz9a7adcf2011-01-11 09:54:33 -0800599 return 0;
600}
601
602/**
603 * alarmtimer_nsleep_wakeup - Wakeup function for alarm_timer_nsleep
604 * @alarm: ptr to alarm that fired
605 *
606 * Wakes up the task that set the alarmtimer
607 */
John Stultz4b413082011-08-10 10:37:59 -0700608static enum alarmtimer_restart alarmtimer_nsleep_wakeup(struct alarm *alarm,
609 ktime_t now)
John Stultz9a7adcf2011-01-11 09:54:33 -0800610{
611 struct task_struct *task = (struct task_struct *)alarm->data;
612
613 alarm->data = NULL;
614 if (task)
615 wake_up_process(task);
John Stultz4b413082011-08-10 10:37:59 -0700616 return ALARMTIMER_NORESTART;
John Stultz9a7adcf2011-01-11 09:54:33 -0800617}
618
619/**
620 * alarmtimer_do_nsleep - Internal alarmtimer nsleep implementation
621 * @alarm: ptr to alarmtimer
622 * @absexp: absolute expiration time
623 *
624 * Sets the alarm timer and sleeps until it is fired or interrupted.
625 */
626static int alarmtimer_do_nsleep(struct alarm *alarm, ktime_t absexp)
627{
628 alarm->data = (void *)current;
629 do {
630 set_current_state(TASK_INTERRUPTIBLE);
John Stultz9e264762011-08-10 12:09:24 -0700631 alarm_start(alarm, absexp);
John Stultz9a7adcf2011-01-11 09:54:33 -0800632 if (likely(alarm->data))
633 schedule();
634
635 alarm_cancel(alarm);
636 } while (alarm->data && !signal_pending(current));
637
638 __set_current_state(TASK_RUNNING);
639
640 return (alarm->data == NULL);
641}
642
643
644/**
645 * update_rmtp - Update remaining timespec value
646 * @exp: expiration time
647 * @type: timer type
648 * @rmtp: user pointer to remaining timepsec value
649 *
650 * Helper function that fills in rmtp value with time between
651 * now and the exp value
652 */
653static int update_rmtp(ktime_t exp, enum alarmtimer_type type,
654 struct timespec __user *rmtp)
655{
656 struct timespec rmt;
657 ktime_t rem;
658
659 rem = ktime_sub(exp, alarm_bases[type].gettime());
660
661 if (rem.tv64 <= 0)
662 return 0;
663 rmt = ktime_to_timespec(rem);
664
665 if (copy_to_user(rmtp, &rmt, sizeof(*rmtp)))
666 return -EFAULT;
667
668 return 1;
669
670}
671
672/**
673 * alarm_timer_nsleep_restart - restartblock alarmtimer nsleep
674 * @restart: ptr to restart block
675 *
676 * Handles restarted clock_nanosleep calls
677 */
678static long __sched alarm_timer_nsleep_restart(struct restart_block *restart)
679{
Thomas Gleixnerab8177b2011-05-20 13:05:15 +0200680 enum alarmtimer_type type = restart->nanosleep.clockid;
John Stultz9a7adcf2011-01-11 09:54:33 -0800681 ktime_t exp;
682 struct timespec __user *rmtp;
683 struct alarm alarm;
684 int ret = 0;
685
686 exp.tv64 = restart->nanosleep.expires;
687 alarm_init(&alarm, type, alarmtimer_nsleep_wakeup);
688
689 if (alarmtimer_do_nsleep(&alarm, exp))
690 goto out;
691
692 if (freezing(current))
693 alarmtimer_freezerset(exp, type);
694
695 rmtp = restart->nanosleep.rmtp;
696 if (rmtp) {
697 ret = update_rmtp(exp, type, rmtp);
698 if (ret <= 0)
699 goto out;
700 }
701
702
703 /* The other values in restart are already filled in */
704 ret = -ERESTART_RESTARTBLOCK;
705out:
706 return ret;
707}
708
709/**
710 * alarm_timer_nsleep - alarmtimer nanosleep
711 * @which_clock: clockid
712 * @flags: determins abstime or relative
713 * @tsreq: requested sleep time (abs or rel)
714 * @rmtp: remaining sleep time saved
715 *
716 * Handles clock_nanosleep calls against _ALARM clockids
717 */
718static int alarm_timer_nsleep(const clockid_t which_clock, int flags,
719 struct timespec *tsreq, struct timespec __user *rmtp)
720{
721 enum alarmtimer_type type = clock2alarm(which_clock);
722 struct alarm alarm;
723 ktime_t exp;
724 int ret = 0;
725 struct restart_block *restart;
726
John Stultz1c6b39a2011-06-16 18:47:37 -0700727 if (!alarmtimer_get_rtcdev())
728 return -ENOTSUPP;
729
John Stultz299e6672014-07-07 14:06:11 -0700730 if (flags & ~TIMER_ABSTIME)
731 return -EINVAL;
732
John Stultz9a7adcf2011-01-11 09:54:33 -0800733 if (!capable(CAP_WAKE_ALARM))
734 return -EPERM;
735
736 alarm_init(&alarm, type, alarmtimer_nsleep_wakeup);
737
738 exp = timespec_to_ktime(*tsreq);
739 /* Convert (if necessary) to absolute time */
740 if (flags != TIMER_ABSTIME) {
741 ktime_t now = alarm_bases[type].gettime();
742 exp = ktime_add(now, exp);
743 }
744
745 if (alarmtimer_do_nsleep(&alarm, exp))
746 goto out;
747
748 if (freezing(current))
749 alarmtimer_freezerset(exp, type);
750
751 /* abs timers don't set remaining time or restart */
752 if (flags == TIMER_ABSTIME) {
753 ret = -ERESTARTNOHAND;
754 goto out;
755 }
756
757 if (rmtp) {
758 ret = update_rmtp(exp, type, rmtp);
759 if (ret <= 0)
760 goto out;
761 }
762
763 restart = &current_thread_info()->restart_block;
764 restart->fn = alarm_timer_nsleep_restart;
Thomas Gleixnerab8177b2011-05-20 13:05:15 +0200765 restart->nanosleep.clockid = type;
John Stultz9a7adcf2011-01-11 09:54:33 -0800766 restart->nanosleep.expires = exp.tv64;
767 restart->nanosleep.rmtp = rmtp;
768 ret = -ERESTART_RESTARTBLOCK;
769
770out:
771 return ret;
772}
John Stultzff3ead92011-01-11 09:42:13 -0800773
John Stultzff3ead92011-01-11 09:42:13 -0800774
775/* Suspend hook structures */
776static const struct dev_pm_ops alarmtimer_pm_ops = {
777 .suspend = alarmtimer_suspend,
778};
779
780static struct platform_driver alarmtimer_driver = {
781 .driver = {
782 .name = "alarmtimer",
783 .pm = &alarmtimer_pm_ops,
784 }
785};
786
787/**
788 * alarmtimer_init - Initialize alarm timer code
789 *
790 * This function initializes the alarm bases and registers
791 * the posix clock ids.
792 */
793static int __init alarmtimer_init(void)
794{
Thomas Gleixner4523f6a2011-09-14 10:54:29 +0200795 struct platform_device *pdev;
John Stultzff3ead92011-01-11 09:42:13 -0800796 int error = 0;
797 int i;
John Stultz9a7adcf2011-01-11 09:54:33 -0800798 struct k_clock alarm_clock = {
799 .clock_getres = alarm_clock_getres,
800 .clock_get = alarm_clock_get,
801 .timer_create = alarm_timer_create,
802 .timer_set = alarm_timer_set,
803 .timer_del = alarm_timer_del,
804 .timer_get = alarm_timer_get,
805 .nsleep = alarm_timer_nsleep,
806 };
807
Thomas Gleixnerc5e14e72012-03-24 12:46:23 +0100808 alarmtimer_rtc_timer_init();
John Stultzad30dfa2012-03-23 15:52:25 -0700809
John Stultz9a7adcf2011-01-11 09:54:33 -0800810 posix_timers_register_clock(CLOCK_REALTIME_ALARM, &alarm_clock);
811 posix_timers_register_clock(CLOCK_BOOTTIME_ALARM, &alarm_clock);
John Stultzff3ead92011-01-11 09:42:13 -0800812
813 /* Initialize alarm bases */
814 alarm_bases[ALARM_REALTIME].base_clockid = CLOCK_REALTIME;
815 alarm_bases[ALARM_REALTIME].gettime = &ktime_get_real;
816 alarm_bases[ALARM_BOOTTIME].base_clockid = CLOCK_BOOTTIME;
817 alarm_bases[ALARM_BOOTTIME].gettime = &ktime_get_boottime;
818 for (i = 0; i < ALARM_NUMTYPE; i++) {
819 timerqueue_init_head(&alarm_bases[i].timerqueue);
820 spin_lock_init(&alarm_bases[i].lock);
821 hrtimer_init(&alarm_bases[i].timer,
822 alarm_bases[i].base_clockid,
823 HRTIMER_MODE_ABS);
824 alarm_bases[i].timer.function = alarmtimer_fired;
John Stultzff3ead92011-01-11 09:42:13 -0800825 }
John Stultz8bc0daf2011-07-14 18:35:13 -0700826
Thomas Gleixner4523f6a2011-09-14 10:54:29 +0200827 error = alarmtimer_rtc_interface_setup();
828 if (error)
829 return error;
John Stultzff3ead92011-01-11 09:42:13 -0800830
Thomas Gleixner4523f6a2011-09-14 10:54:29 +0200831 error = platform_driver_register(&alarmtimer_driver);
832 if (error)
833 goto out_if;
834
835 pdev = platform_device_register_simple("alarmtimer", -1, NULL, 0);
836 if (IS_ERR(pdev)) {
837 error = PTR_ERR(pdev);
838 goto out_drv;
839 }
840 return 0;
841
842out_drv:
843 platform_driver_unregister(&alarmtimer_driver);
844out_if:
845 alarmtimer_rtc_interface_remove();
John Stultzff3ead92011-01-11 09:42:13 -0800846 return error;
847}
848device_initcall(alarmtimer_init);