blob: c72d3ddcdff044b14396413cfa2500746e6f0566 [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
Richard Larocque7ccf24b2014-09-09 18:31:03 -0700235ktime_t alarm_expires_remaining(const struct alarm *alarm)
236{
237 struct alarm_base *base = &alarm_bases[alarm->type];
238 return ktime_sub(alarm->node.expires, base->gettime());
239}
240
John Stultz472647d2011-04-29 15:03:10 -0700241#ifdef CONFIG_RTC_CLASS
John Stultz180bf812011-04-28 12:58:11 -0700242/**
John Stultzff3ead92011-01-11 09:42:13 -0800243 * alarmtimer_suspend - Suspend time callback
244 * @dev: unused
245 * @state: unused
246 *
247 * When we are going into suspend, we look through the bases
248 * to see which is the soonest timer to expire. We then
249 * set an rtc timer to fire that far into the future, which
250 * will wake us from suspend.
251 */
252static int alarmtimer_suspend(struct device *dev)
253{
254 struct rtc_time tm;
255 ktime_t min, now;
256 unsigned long flags;
John Stultzc008ba52011-06-16 18:27:09 -0700257 struct rtc_device *rtc;
John Stultzff3ead92011-01-11 09:42:13 -0800258 int i;
259
260 spin_lock_irqsave(&freezer_delta_lock, flags);
261 min = freezer_delta;
262 freezer_delta = ktime_set(0, 0);
263 spin_unlock_irqrestore(&freezer_delta_lock, flags);
264
John Stultz8bc0daf2011-07-14 18:35:13 -0700265 rtc = alarmtimer_get_rtcdev();
John Stultzff3ead92011-01-11 09:42:13 -0800266 /* If we have no rtcdev, just return */
John Stultzc008ba52011-06-16 18:27:09 -0700267 if (!rtc)
John Stultzff3ead92011-01-11 09:42:13 -0800268 return 0;
269
270 /* Find the soonest timer to expire*/
271 for (i = 0; i < ALARM_NUMTYPE; i++) {
272 struct alarm_base *base = &alarm_bases[i];
273 struct timerqueue_node *next;
274 ktime_t delta;
275
276 spin_lock_irqsave(&base->lock, flags);
277 next = timerqueue_getnext(&base->timerqueue);
278 spin_unlock_irqrestore(&base->lock, flags);
279 if (!next)
280 continue;
281 delta = ktime_sub(next->expires, base->gettime());
282 if (!min.tv64 || (delta.tv64 < min.tv64))
283 min = delta;
284 }
285 if (min.tv64 == 0)
286 return 0;
287
288 /* XXX - Should we enforce a minimum sleep time? */
289 WARN_ON(min.tv64 < NSEC_PER_SEC);
290
291 /* Setup an rtc timer to fire that far in the future */
John Stultzc008ba52011-06-16 18:27:09 -0700292 rtc_timer_cancel(rtc, &rtctimer);
293 rtc_read_time(rtc, &tm);
John Stultzff3ead92011-01-11 09:42:13 -0800294 now = rtc_tm_to_ktime(tm);
295 now = ktime_add(now, min);
296
John Stultzc008ba52011-06-16 18:27:09 -0700297 rtc_timer_start(rtc, &rtctimer, now, ktime_set(0, 0));
John Stultzff3ead92011-01-11 09:42:13 -0800298
299 return 0;
300}
John Stultz472647d2011-04-29 15:03:10 -0700301#else
302static int alarmtimer_suspend(struct device *dev)
303{
304 return 0;
305}
306#endif
John Stultzff3ead92011-01-11 09:42:13 -0800307
John Stultz9a7adcf2011-01-11 09:54:33 -0800308static void alarmtimer_freezerset(ktime_t absexp, enum alarmtimer_type type)
309{
310 ktime_t delta;
311 unsigned long flags;
312 struct alarm_base *base = &alarm_bases[type];
313
314 delta = ktime_sub(absexp, base->gettime());
315
316 spin_lock_irqsave(&freezer_delta_lock, flags);
317 if (!freezer_delta.tv64 || (delta.tv64 < freezer_delta.tv64))
318 freezer_delta = delta;
319 spin_unlock_irqrestore(&freezer_delta_lock, flags);
320}
321
322
John Stultz180bf812011-04-28 12:58:11 -0700323/**
John Stultzff3ead92011-01-11 09:42:13 -0800324 * alarm_init - Initialize an alarm structure
325 * @alarm: ptr to alarm to be initialized
326 * @type: the type of the alarm
327 * @function: callback that is run when the alarm fires
John Stultzff3ead92011-01-11 09:42:13 -0800328 */
329void alarm_init(struct alarm *alarm, enum alarmtimer_type type,
John Stultz4b413082011-08-10 10:37:59 -0700330 enum alarmtimer_restart (*function)(struct alarm *, ktime_t))
John Stultzff3ead92011-01-11 09:42:13 -0800331{
332 timerqueue_init(&alarm->node);
John Stultzff3ead92011-01-11 09:42:13 -0800333 alarm->function = function;
334 alarm->type = type;
John Stultza28cde82011-08-10 12:30:21 -0700335 alarm->state = ALARMTIMER_STATE_INACTIVE;
John Stultzff3ead92011-01-11 09:42:13 -0800336}
337
John Stultz180bf812011-04-28 12:58:11 -0700338/**
John Stultzff3ead92011-01-11 09:42:13 -0800339 * alarm_start - Sets an alarm to fire
340 * @alarm: ptr to alarm to set
341 * @start: time to run the alarm
John Stultzff3ead92011-01-11 09:42:13 -0800342 */
John Stultz9e264762011-08-10 12:09:24 -0700343void alarm_start(struct alarm *alarm, ktime_t start)
John Stultzff3ead92011-01-11 09:42:13 -0800344{
345 struct alarm_base *base = &alarm_bases[alarm->type];
346 unsigned long flags;
347
348 spin_lock_irqsave(&base->lock, flags);
John Stultza28cde82011-08-10 12:30:21 -0700349 if (alarmtimer_active(alarm))
John Stultzff3ead92011-01-11 09:42:13 -0800350 alarmtimer_remove(base, alarm);
351 alarm->node.expires = start;
John Stultzff3ead92011-01-11 09:42:13 -0800352 alarmtimer_enqueue(base, alarm);
John Stultzff3ead92011-01-11 09:42:13 -0800353 spin_unlock_irqrestore(&base->lock, flags);
354}
355
John Stultz180bf812011-04-28 12:58:11 -0700356/**
John Stultz9082c462011-08-10 12:41:36 -0700357 * alarm_try_to_cancel - Tries to cancel an alarm timer
John Stultzff3ead92011-01-11 09:42:13 -0800358 * @alarm: ptr to alarm to be canceled
John Stultz9082c462011-08-10 12:41:36 -0700359 *
360 * Returns 1 if the timer was canceled, 0 if it was not running,
361 * and -1 if the callback was running
John Stultzff3ead92011-01-11 09:42:13 -0800362 */
John Stultz9082c462011-08-10 12:41:36 -0700363int alarm_try_to_cancel(struct alarm *alarm)
John Stultzff3ead92011-01-11 09:42:13 -0800364{
365 struct alarm_base *base = &alarm_bases[alarm->type];
366 unsigned long flags;
John Stultz9082c462011-08-10 12:41:36 -0700367 int ret = -1;
John Stultzff3ead92011-01-11 09:42:13 -0800368 spin_lock_irqsave(&base->lock, flags);
John Stultz9082c462011-08-10 12:41:36 -0700369
370 if (alarmtimer_callback_running(alarm))
371 goto out;
372
373 if (alarmtimer_is_queued(alarm)) {
John Stultzff3ead92011-01-11 09:42:13 -0800374 alarmtimer_remove(base, alarm);
John Stultz9082c462011-08-10 12:41:36 -0700375 ret = 1;
376 } else
377 ret = 0;
378out:
John Stultzff3ead92011-01-11 09:42:13 -0800379 spin_unlock_irqrestore(&base->lock, flags);
John Stultz9082c462011-08-10 12:41:36 -0700380 return ret;
John Stultzff3ead92011-01-11 09:42:13 -0800381}
382
383
John Stultz9082c462011-08-10 12:41:36 -0700384/**
385 * alarm_cancel - Spins trying to cancel an alarm timer until it is done
386 * @alarm: ptr to alarm to be canceled
387 *
388 * Returns 1 if the timer was canceled, 0 if it was not active.
389 */
390int alarm_cancel(struct alarm *alarm)
391{
392 for (;;) {
393 int ret = alarm_try_to_cancel(alarm);
394 if (ret >= 0)
395 return ret;
396 cpu_relax();
397 }
398}
399
John Stultzdce75a82011-08-10 11:31:03 -0700400
401u64 alarm_forward(struct alarm *alarm, ktime_t now, ktime_t interval)
402{
403 u64 overrun = 1;
404 ktime_t delta;
405
406 delta = ktime_sub(now, alarm->node.expires);
407
408 if (delta.tv64 < 0)
409 return 0;
410
411 if (unlikely(delta.tv64 >= interval.tv64)) {
412 s64 incr = ktime_to_ns(interval);
413
414 overrun = ktime_divns(delta, incr);
415
416 alarm->node.expires = ktime_add_ns(alarm->node.expires,
417 incr*overrun);
418
419 if (alarm->node.expires.tv64 > now.tv64)
420 return overrun;
421 /*
422 * This (and the ktime_add() below) is the
423 * correction for exact:
424 */
425 overrun++;
426 }
427
428 alarm->node.expires = ktime_add(alarm->node.expires, interval);
429 return overrun;
430}
431
432
433
434
John Stultz180bf812011-04-28 12:58:11 -0700435/**
John Stultz9a7adcf2011-01-11 09:54:33 -0800436 * clock2alarm - helper that converts from clockid to alarmtypes
437 * @clockid: clockid.
John Stultz9a7adcf2011-01-11 09:54:33 -0800438 */
439static enum alarmtimer_type clock2alarm(clockid_t clockid)
440{
441 if (clockid == CLOCK_REALTIME_ALARM)
442 return ALARM_REALTIME;
443 if (clockid == CLOCK_BOOTTIME_ALARM)
444 return ALARM_BOOTTIME;
445 return -1;
446}
447
John Stultz180bf812011-04-28 12:58:11 -0700448/**
John Stultz9a7adcf2011-01-11 09:54:33 -0800449 * alarm_handle_timer - Callback for posix timers
450 * @alarm: alarm that fired
451 *
452 * Posix timer callback for expired alarm timers.
453 */
John Stultz4b413082011-08-10 10:37:59 -0700454static enum alarmtimer_restart alarm_handle_timer(struct alarm *alarm,
455 ktime_t now)
John Stultz9a7adcf2011-01-11 09:54:33 -0800456{
457 struct k_itimer *ptr = container_of(alarm, struct k_itimer,
John Stultz9e264762011-08-10 12:09:24 -0700458 it.alarm.alarmtimer);
John Stultz9a7adcf2011-01-11 09:54:33 -0800459 if (posix_timer_event(ptr, 0) != 0)
460 ptr->it_overrun++;
John Stultz4b413082011-08-10 10:37:59 -0700461
John Stultz54da23b2011-08-10 11:08:07 -0700462 /* Re-add periodic timers */
John Stultz9e264762011-08-10 12:09:24 -0700463 if (ptr->it.alarm.interval.tv64) {
464 ptr->it_overrun += alarm_forward(alarm, now,
465 ptr->it.alarm.interval);
John Stultz54da23b2011-08-10 11:08:07 -0700466 return ALARMTIMER_RESTART;
467 }
John Stultz4b413082011-08-10 10:37:59 -0700468 return ALARMTIMER_NORESTART;
John Stultz9a7adcf2011-01-11 09:54:33 -0800469}
470
John Stultz180bf812011-04-28 12:58:11 -0700471/**
John Stultz9a7adcf2011-01-11 09:54:33 -0800472 * alarm_clock_getres - posix getres interface
473 * @which_clock: clockid
474 * @tp: timespec to fill
475 *
476 * Returns the granularity of underlying alarm base clock
477 */
478static int alarm_clock_getres(const clockid_t which_clock, struct timespec *tp)
479{
480 clockid_t baseid = alarm_bases[clock2alarm(which_clock)].base_clockid;
481
John Stultz1c6b39a2011-06-16 18:47:37 -0700482 if (!alarmtimer_get_rtcdev())
KOSAKI Motohiro3e050922013-10-14 17:33:16 -0400483 return -EINVAL;
John Stultz1c6b39a2011-06-16 18:47:37 -0700484
John Stultz9a7adcf2011-01-11 09:54:33 -0800485 return hrtimer_get_res(baseid, tp);
486}
487
488/**
489 * alarm_clock_get - posix clock_get interface
490 * @which_clock: clockid
491 * @tp: timespec to fill.
492 *
493 * Provides the underlying alarm base time.
494 */
495static int alarm_clock_get(clockid_t which_clock, struct timespec *tp)
496{
497 struct alarm_base *base = &alarm_bases[clock2alarm(which_clock)];
498
John Stultz1c6b39a2011-06-16 18:47:37 -0700499 if (!alarmtimer_get_rtcdev())
KOSAKI Motohiro3e050922013-10-14 17:33:16 -0400500 return -EINVAL;
John Stultz1c6b39a2011-06-16 18:47:37 -0700501
John Stultz9a7adcf2011-01-11 09:54:33 -0800502 *tp = ktime_to_timespec(base->gettime());
503 return 0;
504}
505
506/**
507 * alarm_timer_create - posix timer_create interface
508 * @new_timer: k_itimer pointer to manage
509 *
510 * Initializes the k_itimer structure.
511 */
512static int alarm_timer_create(struct k_itimer *new_timer)
513{
514 enum alarmtimer_type type;
515 struct alarm_base *base;
516
John Stultz1c6b39a2011-06-16 18:47:37 -0700517 if (!alarmtimer_get_rtcdev())
518 return -ENOTSUPP;
519
John Stultz9a7adcf2011-01-11 09:54:33 -0800520 if (!capable(CAP_WAKE_ALARM))
521 return -EPERM;
522
523 type = clock2alarm(new_timer->it_clock);
524 base = &alarm_bases[type];
John Stultz9e264762011-08-10 12:09:24 -0700525 alarm_init(&new_timer->it.alarm.alarmtimer, type, alarm_handle_timer);
John Stultz9a7adcf2011-01-11 09:54:33 -0800526 return 0;
527}
528
529/**
530 * alarm_timer_get - posix timer_get interface
531 * @new_timer: k_itimer pointer
532 * @cur_setting: itimerspec data to fill
533 *
Richard Larocque7ccf24b2014-09-09 18:31:03 -0700534 * Copies out the current itimerspec data
John Stultz9a7adcf2011-01-11 09:54:33 -0800535 */
536static void alarm_timer_get(struct k_itimer *timr,
537 struct itimerspec *cur_setting)
538{
Richard Larocque7ccf24b2014-09-09 18:31:03 -0700539 ktime_t relative_expiry_time =
540 alarm_expires_remaining(&(timr->it.alarm.alarmtimer));
John Stultzea7802f2011-08-04 07:51:56 -0700541
Richard Larocque7ccf24b2014-09-09 18:31:03 -0700542 if (ktime_to_ns(relative_expiry_time) > 0) {
543 cur_setting->it_value = ktime_to_timespec(relative_expiry_time);
544 } else {
545 cur_setting->it_value.tv_sec = 0;
546 cur_setting->it_value.tv_nsec = 0;
547 }
548
549 cur_setting->it_interval = ktime_to_timespec(timr->it.alarm.interval);
John Stultz9a7adcf2011-01-11 09:54:33 -0800550}
551
552/**
553 * alarm_timer_del - posix timer_del interface
554 * @timr: k_itimer pointer to be deleted
555 *
556 * Cancels any programmed alarms for the given timer.
557 */
558static int alarm_timer_del(struct k_itimer *timr)
559{
John Stultz1c6b39a2011-06-16 18:47:37 -0700560 if (!rtcdev)
561 return -ENOTSUPP;
562
John Stultz9082c462011-08-10 12:41:36 -0700563 if (alarm_try_to_cancel(&timr->it.alarm.alarmtimer) < 0)
564 return TIMER_RETRY;
565
John Stultz9a7adcf2011-01-11 09:54:33 -0800566 return 0;
567}
568
569/**
570 * alarm_timer_set - posix timer_set interface
571 * @timr: k_itimer pointer to be deleted
572 * @flags: timer flags
573 * @new_setting: itimerspec to be used
574 * @old_setting: itimerspec being replaced
575 *
576 * Sets the timer to new_setting, and starts the timer.
577 */
578static int alarm_timer_set(struct k_itimer *timr, int flags,
579 struct itimerspec *new_setting,
580 struct itimerspec *old_setting)
581{
John Stultz299e6672014-07-07 14:06:11 -0700582 ktime_t exp;
583
John Stultz1c6b39a2011-06-16 18:47:37 -0700584 if (!rtcdev)
585 return -ENOTSUPP;
586
John Stultz299e6672014-07-07 14:06:11 -0700587 if (flags & ~TIMER_ABSTIME)
588 return -EINVAL;
589
John Stultz971c90b2011-08-04 07:25:35 -0700590 if (old_setting)
591 alarm_timer_get(timr, old_setting);
John Stultz9a7adcf2011-01-11 09:54:33 -0800592
593 /* If the timer was already set, cancel it */
John Stultz9082c462011-08-10 12:41:36 -0700594 if (alarm_try_to_cancel(&timr->it.alarm.alarmtimer) < 0)
595 return TIMER_RETRY;
John Stultz9a7adcf2011-01-11 09:54:33 -0800596
597 /* start the timer */
John Stultz9e264762011-08-10 12:09:24 -0700598 timr->it.alarm.interval = timespec_to_ktime(new_setting->it_interval);
John Stultz299e6672014-07-07 14:06:11 -0700599 exp = timespec_to_ktime(new_setting->it_value);
600 /* Convert (if necessary) to absolute time */
601 if (flags != TIMER_ABSTIME) {
602 ktime_t now;
603
604 now = alarm_bases[timr->it.alarm.alarmtimer.type].gettime();
605 exp = ktime_add(now, exp);
606 }
607
608 alarm_start(&timr->it.alarm.alarmtimer, exp);
John Stultz9a7adcf2011-01-11 09:54:33 -0800609 return 0;
610}
611
612/**
613 * alarmtimer_nsleep_wakeup - Wakeup function for alarm_timer_nsleep
614 * @alarm: ptr to alarm that fired
615 *
616 * Wakes up the task that set the alarmtimer
617 */
John Stultz4b413082011-08-10 10:37:59 -0700618static enum alarmtimer_restart alarmtimer_nsleep_wakeup(struct alarm *alarm,
619 ktime_t now)
John Stultz9a7adcf2011-01-11 09:54:33 -0800620{
621 struct task_struct *task = (struct task_struct *)alarm->data;
622
623 alarm->data = NULL;
624 if (task)
625 wake_up_process(task);
John Stultz4b413082011-08-10 10:37:59 -0700626 return ALARMTIMER_NORESTART;
John Stultz9a7adcf2011-01-11 09:54:33 -0800627}
628
629/**
630 * alarmtimer_do_nsleep - Internal alarmtimer nsleep implementation
631 * @alarm: ptr to alarmtimer
632 * @absexp: absolute expiration time
633 *
634 * Sets the alarm timer and sleeps until it is fired or interrupted.
635 */
636static int alarmtimer_do_nsleep(struct alarm *alarm, ktime_t absexp)
637{
638 alarm->data = (void *)current;
639 do {
640 set_current_state(TASK_INTERRUPTIBLE);
John Stultz9e264762011-08-10 12:09:24 -0700641 alarm_start(alarm, absexp);
John Stultz9a7adcf2011-01-11 09:54:33 -0800642 if (likely(alarm->data))
643 schedule();
644
645 alarm_cancel(alarm);
646 } while (alarm->data && !signal_pending(current));
647
648 __set_current_state(TASK_RUNNING);
649
650 return (alarm->data == NULL);
651}
652
653
654/**
655 * update_rmtp - Update remaining timespec value
656 * @exp: expiration time
657 * @type: timer type
658 * @rmtp: user pointer to remaining timepsec value
659 *
660 * Helper function that fills in rmtp value with time between
661 * now and the exp value
662 */
663static int update_rmtp(ktime_t exp, enum alarmtimer_type type,
664 struct timespec __user *rmtp)
665{
666 struct timespec rmt;
667 ktime_t rem;
668
669 rem = ktime_sub(exp, alarm_bases[type].gettime());
670
671 if (rem.tv64 <= 0)
672 return 0;
673 rmt = ktime_to_timespec(rem);
674
675 if (copy_to_user(rmtp, &rmt, sizeof(*rmtp)))
676 return -EFAULT;
677
678 return 1;
679
680}
681
682/**
683 * alarm_timer_nsleep_restart - restartblock alarmtimer nsleep
684 * @restart: ptr to restart block
685 *
686 * Handles restarted clock_nanosleep calls
687 */
688static long __sched alarm_timer_nsleep_restart(struct restart_block *restart)
689{
Thomas Gleixnerab8177b2011-05-20 13:05:15 +0200690 enum alarmtimer_type type = restart->nanosleep.clockid;
John Stultz9a7adcf2011-01-11 09:54:33 -0800691 ktime_t exp;
692 struct timespec __user *rmtp;
693 struct alarm alarm;
694 int ret = 0;
695
696 exp.tv64 = restart->nanosleep.expires;
697 alarm_init(&alarm, type, alarmtimer_nsleep_wakeup);
698
699 if (alarmtimer_do_nsleep(&alarm, exp))
700 goto out;
701
702 if (freezing(current))
703 alarmtimer_freezerset(exp, type);
704
705 rmtp = restart->nanosleep.rmtp;
706 if (rmtp) {
707 ret = update_rmtp(exp, type, rmtp);
708 if (ret <= 0)
709 goto out;
710 }
711
712
713 /* The other values in restart are already filled in */
714 ret = -ERESTART_RESTARTBLOCK;
715out:
716 return ret;
717}
718
719/**
720 * alarm_timer_nsleep - alarmtimer nanosleep
721 * @which_clock: clockid
722 * @flags: determins abstime or relative
723 * @tsreq: requested sleep time (abs or rel)
724 * @rmtp: remaining sleep time saved
725 *
726 * Handles clock_nanosleep calls against _ALARM clockids
727 */
728static int alarm_timer_nsleep(const clockid_t which_clock, int flags,
729 struct timespec *tsreq, struct timespec __user *rmtp)
730{
731 enum alarmtimer_type type = clock2alarm(which_clock);
732 struct alarm alarm;
733 ktime_t exp;
734 int ret = 0;
735 struct restart_block *restart;
736
John Stultz1c6b39a2011-06-16 18:47:37 -0700737 if (!alarmtimer_get_rtcdev())
738 return -ENOTSUPP;
739
John Stultz299e6672014-07-07 14:06:11 -0700740 if (flags & ~TIMER_ABSTIME)
741 return -EINVAL;
742
John Stultz9a7adcf2011-01-11 09:54:33 -0800743 if (!capable(CAP_WAKE_ALARM))
744 return -EPERM;
745
746 alarm_init(&alarm, type, alarmtimer_nsleep_wakeup);
747
748 exp = timespec_to_ktime(*tsreq);
749 /* Convert (if necessary) to absolute time */
750 if (flags != TIMER_ABSTIME) {
751 ktime_t now = alarm_bases[type].gettime();
752 exp = ktime_add(now, exp);
753 }
754
755 if (alarmtimer_do_nsleep(&alarm, exp))
756 goto out;
757
758 if (freezing(current))
759 alarmtimer_freezerset(exp, type);
760
761 /* abs timers don't set remaining time or restart */
762 if (flags == TIMER_ABSTIME) {
763 ret = -ERESTARTNOHAND;
764 goto out;
765 }
766
767 if (rmtp) {
768 ret = update_rmtp(exp, type, rmtp);
769 if (ret <= 0)
770 goto out;
771 }
772
773 restart = &current_thread_info()->restart_block;
774 restart->fn = alarm_timer_nsleep_restart;
Thomas Gleixnerab8177b2011-05-20 13:05:15 +0200775 restart->nanosleep.clockid = type;
John Stultz9a7adcf2011-01-11 09:54:33 -0800776 restart->nanosleep.expires = exp.tv64;
777 restart->nanosleep.rmtp = rmtp;
778 ret = -ERESTART_RESTARTBLOCK;
779
780out:
781 return ret;
782}
John Stultzff3ead92011-01-11 09:42:13 -0800783
John Stultzff3ead92011-01-11 09:42:13 -0800784
785/* Suspend hook structures */
786static const struct dev_pm_ops alarmtimer_pm_ops = {
787 .suspend = alarmtimer_suspend,
788};
789
790static struct platform_driver alarmtimer_driver = {
791 .driver = {
792 .name = "alarmtimer",
793 .pm = &alarmtimer_pm_ops,
794 }
795};
796
797/**
798 * alarmtimer_init - Initialize alarm timer code
799 *
800 * This function initializes the alarm bases and registers
801 * the posix clock ids.
802 */
803static int __init alarmtimer_init(void)
804{
Thomas Gleixner4523f6a2011-09-14 10:54:29 +0200805 struct platform_device *pdev;
John Stultzff3ead92011-01-11 09:42:13 -0800806 int error = 0;
807 int i;
John Stultz9a7adcf2011-01-11 09:54:33 -0800808 struct k_clock alarm_clock = {
809 .clock_getres = alarm_clock_getres,
810 .clock_get = alarm_clock_get,
811 .timer_create = alarm_timer_create,
812 .timer_set = alarm_timer_set,
813 .timer_del = alarm_timer_del,
814 .timer_get = alarm_timer_get,
815 .nsleep = alarm_timer_nsleep,
816 };
817
Thomas Gleixnerc5e14e72012-03-24 12:46:23 +0100818 alarmtimer_rtc_timer_init();
John Stultzad30dfa2012-03-23 15:52:25 -0700819
John Stultz9a7adcf2011-01-11 09:54:33 -0800820 posix_timers_register_clock(CLOCK_REALTIME_ALARM, &alarm_clock);
821 posix_timers_register_clock(CLOCK_BOOTTIME_ALARM, &alarm_clock);
John Stultzff3ead92011-01-11 09:42:13 -0800822
823 /* Initialize alarm bases */
824 alarm_bases[ALARM_REALTIME].base_clockid = CLOCK_REALTIME;
825 alarm_bases[ALARM_REALTIME].gettime = &ktime_get_real;
826 alarm_bases[ALARM_BOOTTIME].base_clockid = CLOCK_BOOTTIME;
827 alarm_bases[ALARM_BOOTTIME].gettime = &ktime_get_boottime;
828 for (i = 0; i < ALARM_NUMTYPE; i++) {
829 timerqueue_init_head(&alarm_bases[i].timerqueue);
830 spin_lock_init(&alarm_bases[i].lock);
831 hrtimer_init(&alarm_bases[i].timer,
832 alarm_bases[i].base_clockid,
833 HRTIMER_MODE_ABS);
834 alarm_bases[i].timer.function = alarmtimer_fired;
John Stultzff3ead92011-01-11 09:42:13 -0800835 }
John Stultz8bc0daf2011-07-14 18:35:13 -0700836
Thomas Gleixner4523f6a2011-09-14 10:54:29 +0200837 error = alarmtimer_rtc_interface_setup();
838 if (error)
839 return error;
John Stultzff3ead92011-01-11 09:42:13 -0800840
Thomas Gleixner4523f6a2011-09-14 10:54:29 +0200841 error = platform_driver_register(&alarmtimer_driver);
842 if (error)
843 goto out_if;
844
845 pdev = platform_device_register_simple("alarmtimer", -1, NULL, 0);
846 if (IS_ERR(pdev)) {
847 error = PTR_ERR(pdev);
848 goto out_drv;
849 }
850 return 0;
851
852out_drv:
853 platform_driver_unregister(&alarmtimer_driver);
854out_if:
855 alarmtimer_rtc_interface_remove();
John Stultzff3ead92011-01-11 09:42:13 -0800856 return error;
857}
858device_initcall(alarmtimer_init);