]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blame - kernel/time/alarmtimer.c
Merge remote-tracking branches 'asoc/topic/omap', 'asoc/topic/oom' and 'asoc/topic...
[mirror_ubuntu-artful-kernel.git] / kernel / time / alarmtimer.c
CommitLineData
ff3ead96
JS
1/*
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
180bf812
JS
29/**
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
180bf812 36 */
ff3ead96
JS
37static struct alarm_base {
38 spinlock_t lock;
39 struct timerqueue_head timerqueue;
ff3ead96
JS
40 ktime_t (*gettime)(void);
41 clockid_t base_clockid;
ff3ead96
JS
42} alarm_bases[ALARM_NUMTYPE];
43
c008ba58
JS
44/* freezer delta & lock used to handle clock_nanosleep triggered wakeups */
45static ktime_t freezer_delta;
46static DEFINE_SPINLOCK(freezer_delta_lock);
47
59a93c27
TP
48static struct wakeup_source *ws;
49
472647dc 50#ifdef CONFIG_RTC_CLASS
180bf812 51/* rtc timer and device for setting alarm wakeups at suspend */
c5e14e76 52static struct rtc_timer rtctimer;
ff3ead96 53static struct rtc_device *rtcdev;
c008ba58 54static DEFINE_SPINLOCK(rtcdev_lock);
ff3ead96 55
c008ba58
JS
56/**
57 * 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 */
57c498fa 63struct rtc_device *alarmtimer_get_rtcdev(void)
c008ba58 64{
c008ba58
JS
65 unsigned long flags;
66 struct rtc_device *ret;
67
68 spin_lock_irqsave(&rtcdev_lock, flags);
c008ba58
JS
69 ret = rtcdev;
70 spin_unlock_irqrestore(&rtcdev_lock, flags);
71
72 return ret;
73}
8bc0dafb
JS
74
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
c5e14e76
TG
100static inline void alarmtimer_rtc_timer_init(void)
101{
102 rtc_timer_init(&rtctimer, NULL, NULL);
103}
104
8bc0dafb
JS
105static struct class_interface alarmtimer_rtc_interface = {
106 .add_dev = &alarmtimer_rtc_add_device,
107};
108
4523f6ad 109static int alarmtimer_rtc_interface_setup(void)
8bc0dafb
JS
110{
111 alarmtimer_rtc_interface.class = rtc_class;
4523f6ad
TG
112 return class_interface_register(&alarmtimer_rtc_interface);
113}
114static void alarmtimer_rtc_interface_remove(void)
115{
116 class_interface_unregister(&alarmtimer_rtc_interface);
8bc0dafb 117}
1c6b39ad 118#else
57c498fa 119struct rtc_device *alarmtimer_get_rtcdev(void)
4523f6ad
TG
120{
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) { }
c5e14e76 126static inline void alarmtimer_rtc_timer_init(void) { }
c008ba58 127#endif
ff3ead96 128
180bf812 129/**
ff3ead96
JS
130 * 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 *
dae373be 134 * Adds alarm to a alarm_base timerqueue
ff3ead96
JS
135 *
136 * Must hold base->lock when calling.
137 */
138static void alarmtimer_enqueue(struct alarm_base *base, struct alarm *alarm)
139{
dae373be
JS
140 if (alarm->state & ALARMTIMER_STATE_ENQUEUED)
141 timerqueue_del(&base->timerqueue, &alarm->node);
142
ff3ead96 143 timerqueue_add(&base->timerqueue, &alarm->node);
a28cde81 144 alarm->state |= ALARMTIMER_STATE_ENQUEUED;
ff3ead96
JS
145}
146
180bf812 147/**
a65bcc12 148 * alarmtimer_dequeue - Removes an alarm timer from an alarm_base timerqueue
ff3ead96
JS
149 * @base: pointer to the base where the timer is running
150 * @alarm: pointer to alarm being removed
151 *
dae373be 152 * Removes alarm to a alarm_base timerqueue
ff3ead96
JS
153 *
154 * Must hold base->lock when calling.
155 */
a65bcc12 156static void alarmtimer_dequeue(struct alarm_base *base, struct alarm *alarm)
ff3ead96 157{
a28cde81
JS
158 if (!(alarm->state & ALARMTIMER_STATE_ENQUEUED))
159 return;
160
ff3ead96 161 timerqueue_del(&base->timerqueue, &alarm->node);
a28cde81 162 alarm->state &= ~ALARMTIMER_STATE_ENQUEUED;
ff3ead96
JS
163}
164
7068b7a1 165
180bf812 166/**
7068b7a1
JS
167 * alarmtimer_fired - Handles alarm hrtimer being fired.
168 * @timer: pointer to hrtimer being run
ff3ead96 169 *
180bf812
JS
170 * 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.
ff3ead96 174 */
7068b7a1 175static enum hrtimer_restart alarmtimer_fired(struct hrtimer *timer)
ff3ead96 176{
dae373be
JS
177 struct alarm *alarm = container_of(timer, struct alarm, timer);
178 struct alarm_base *base = &alarm_bases[alarm->type];
ff3ead96 179 unsigned long flags;
7068b7a1 180 int ret = HRTIMER_NORESTART;
54da23b7 181 int restart = ALARMTIMER_NORESTART;
ff3ead96
JS
182
183 spin_lock_irqsave(&base->lock, flags);
a65bcc12 184 alarmtimer_dequeue(base, alarm);
dae373be 185 spin_unlock_irqrestore(&base->lock, flags);
54da23b7 186
dae373be
JS
187 if (alarm->function)
188 restart = alarm->function(alarm, base->gettime());
ff3ead96 189
dae373be
JS
190 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);
7068b7a1 194 ret = HRTIMER_RESTART;
ff3ead96
JS
195 }
196 spin_unlock_irqrestore(&base->lock, flags);
ff3ead96 197
7068b7a1 198 return ret;
ff3ead96 199
ff3ead96
JS
200}
201
6cffe00f
TP
202ktime_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}
11682a41 207EXPORT_SYMBOL_GPL(alarm_expires_remaining);
6cffe00f 208
472647dc 209#ifdef CONFIG_RTC_CLASS
180bf812 210/**
ff3ead96
JS
211 * alarmtimer_suspend - Suspend time callback
212 * @dev: unused
213 * @state: unused
214 *
215 * When we are going into suspend, we look through the bases
216 * to see which is the soonest timer to expire. We then
217 * set an rtc timer to fire that far into the future, which
218 * will wake us from suspend.
219 */
220static int alarmtimer_suspend(struct device *dev)
221{
222 struct rtc_time tm;
223 ktime_t min, now;
224 unsigned long flags;
c008ba58 225 struct rtc_device *rtc;
ff3ead96 226 int i;
59a93c27 227 int ret;
ff3ead96
JS
228
229 spin_lock_irqsave(&freezer_delta_lock, flags);
230 min = freezer_delta;
231 freezer_delta = ktime_set(0, 0);
232 spin_unlock_irqrestore(&freezer_delta_lock, flags);
233
8bc0dafb 234 rtc = alarmtimer_get_rtcdev();
ff3ead96 235 /* If we have no rtcdev, just return */
c008ba58 236 if (!rtc)
ff3ead96
JS
237 return 0;
238
239 /* Find the soonest timer to expire*/
240 for (i = 0; i < ALARM_NUMTYPE; i++) {
241 struct alarm_base *base = &alarm_bases[i];
242 struct timerqueue_node *next;
243 ktime_t delta;
244
245 spin_lock_irqsave(&base->lock, flags);
246 next = timerqueue_getnext(&base->timerqueue);
247 spin_unlock_irqrestore(&base->lock, flags);
248 if (!next)
249 continue;
250 delta = ktime_sub(next->expires, base->gettime());
251 if (!min.tv64 || (delta.tv64 < min.tv64))
252 min = delta;
253 }
254 if (min.tv64 == 0)
255 return 0;
256
59a93c27
TP
257 if (ktime_to_ns(min) < 2 * NSEC_PER_SEC) {
258 __pm_wakeup_event(ws, 2 * MSEC_PER_SEC);
259 return -EBUSY;
260 }
ff3ead96
JS
261
262 /* Setup an rtc timer to fire that far in the future */
c008ba58
JS
263 rtc_timer_cancel(rtc, &rtctimer);
264 rtc_read_time(rtc, &tm);
ff3ead96
JS
265 now = rtc_tm_to_ktime(tm);
266 now = ktime_add(now, min);
267
59a93c27
TP
268 /* Set alarm, if in the past reject suspend briefly to handle */
269 ret = rtc_timer_start(rtc, &rtctimer, now, ktime_set(0, 0));
270 if (ret < 0)
271 __pm_wakeup_event(ws, MSEC_PER_SEC);
272 return ret;
ff3ead96 273}
472647dc
JS
274#else
275static int alarmtimer_suspend(struct device *dev)
276{
277 return 0;
278}
279#endif
ff3ead96 280
9a7adcf5
JS
281static void alarmtimer_freezerset(ktime_t absexp, enum alarmtimer_type type)
282{
283 ktime_t delta;
284 unsigned long flags;
285 struct alarm_base *base = &alarm_bases[type];
286
287 delta = ktime_sub(absexp, base->gettime());
288
289 spin_lock_irqsave(&freezer_delta_lock, flags);
290 if (!freezer_delta.tv64 || (delta.tv64 < freezer_delta.tv64))
291 freezer_delta = delta;
292 spin_unlock_irqrestore(&freezer_delta_lock, flags);
293}
294
295
180bf812 296/**
ff3ead96
JS
297 * alarm_init - Initialize an alarm structure
298 * @alarm: ptr to alarm to be initialized
299 * @type: the type of the alarm
300 * @function: callback that is run when the alarm fires
ff3ead96
JS
301 */
302void alarm_init(struct alarm *alarm, enum alarmtimer_type type,
4b41308d 303 enum alarmtimer_restart (*function)(struct alarm *, ktime_t))
ff3ead96
JS
304{
305 timerqueue_init(&alarm->node);
dae373be
JS
306 hrtimer_init(&alarm->timer, alarm_bases[type].base_clockid,
307 HRTIMER_MODE_ABS);
308 alarm->timer.function = alarmtimer_fired;
ff3ead96
JS
309 alarm->function = function;
310 alarm->type = type;
a28cde81 311 alarm->state = ALARMTIMER_STATE_INACTIVE;
ff3ead96 312}
11682a41 313EXPORT_SYMBOL_GPL(alarm_init);
ff3ead96 314
180bf812 315/**
6cffe00f 316 * alarm_start - Sets an absolute alarm to fire
ff3ead96
JS
317 * @alarm: ptr to alarm to set
318 * @start: time to run the alarm
ff3ead96 319 */
dae373be 320int alarm_start(struct alarm *alarm, ktime_t start)
ff3ead96
JS
321{
322 struct alarm_base *base = &alarm_bases[alarm->type];
323 unsigned long flags;
dae373be 324 int ret;
ff3ead96
JS
325
326 spin_lock_irqsave(&base->lock, flags);
ff3ead96 327 alarm->node.expires = start;
ff3ead96 328 alarmtimer_enqueue(base, alarm);
dae373be
JS
329 ret = hrtimer_start(&alarm->timer, alarm->node.expires,
330 HRTIMER_MODE_ABS);
ff3ead96 331 spin_unlock_irqrestore(&base->lock, flags);
dae373be 332 return ret;
ff3ead96 333}
11682a41 334EXPORT_SYMBOL_GPL(alarm_start);
ff3ead96 335
6cffe00f
TP
336/**
337 * alarm_start_relative - Sets a relative alarm to fire
338 * @alarm: ptr to alarm to set
339 * @start: time relative to now to run the alarm
340 */
341int alarm_start_relative(struct alarm *alarm, ktime_t start)
342{
343 struct alarm_base *base = &alarm_bases[alarm->type];
344
345 start = ktime_add(start, base->gettime());
346 return alarm_start(alarm, start);
347}
11682a41 348EXPORT_SYMBOL_GPL(alarm_start_relative);
6cffe00f
TP
349
350void alarm_restart(struct alarm *alarm)
351{
352 struct alarm_base *base = &alarm_bases[alarm->type];
353 unsigned long flags;
354
355 spin_lock_irqsave(&base->lock, flags);
356 hrtimer_set_expires(&alarm->timer, alarm->node.expires);
357 hrtimer_restart(&alarm->timer);
358 alarmtimer_enqueue(base, alarm);
359 spin_unlock_irqrestore(&base->lock, flags);
360}
11682a41 361EXPORT_SYMBOL_GPL(alarm_restart);
6cffe00f 362
180bf812 363/**
9082c465 364 * alarm_try_to_cancel - Tries to cancel an alarm timer
ff3ead96 365 * @alarm: ptr to alarm to be canceled
9082c465
JS
366 *
367 * Returns 1 if the timer was canceled, 0 if it was not running,
368 * and -1 if the callback was running
ff3ead96 369 */
9082c465 370int alarm_try_to_cancel(struct alarm *alarm)
ff3ead96
JS
371{
372 struct alarm_base *base = &alarm_bases[alarm->type];
373 unsigned long flags;
dae373be 374 int ret;
9082c465 375
dae373be
JS
376 spin_lock_irqsave(&base->lock, flags);
377 ret = hrtimer_try_to_cancel(&alarm->timer);
378 if (ret >= 0)
a65bcc12 379 alarmtimer_dequeue(base, alarm);
ff3ead96 380 spin_unlock_irqrestore(&base->lock, flags);
9082c465 381 return ret;
ff3ead96 382}
11682a41 383EXPORT_SYMBOL_GPL(alarm_try_to_cancel);
ff3ead96
JS
384
385
9082c465
JS
386/**
387 * alarm_cancel - Spins trying to cancel an alarm timer until it is done
388 * @alarm: ptr to alarm to be canceled
389 *
390 * Returns 1 if the timer was canceled, 0 if it was not active.
391 */
392int alarm_cancel(struct alarm *alarm)
393{
394 for (;;) {
395 int ret = alarm_try_to_cancel(alarm);
396 if (ret >= 0)
397 return ret;
398 cpu_relax();
399 }
400}
11682a41 401EXPORT_SYMBOL_GPL(alarm_cancel);
9082c465 402
dce75a8c
JS
403
404u64 alarm_forward(struct alarm *alarm, ktime_t now, ktime_t interval)
405{
406 u64 overrun = 1;
407 ktime_t delta;
408
409 delta = ktime_sub(now, alarm->node.expires);
410
411 if (delta.tv64 < 0)
412 return 0;
413
414 if (unlikely(delta.tv64 >= interval.tv64)) {
415 s64 incr = ktime_to_ns(interval);
416
417 overrun = ktime_divns(delta, incr);
418
419 alarm->node.expires = ktime_add_ns(alarm->node.expires,
420 incr*overrun);
421
422 if (alarm->node.expires.tv64 > now.tv64)
423 return overrun;
424 /*
425 * This (and the ktime_add() below) is the
426 * correction for exact:
427 */
428 overrun++;
429 }
430
431 alarm->node.expires = ktime_add(alarm->node.expires, interval);
432 return overrun;
433}
11682a41 434EXPORT_SYMBOL_GPL(alarm_forward);
dce75a8c 435
6cffe00f
TP
436u64 alarm_forward_now(struct alarm *alarm, ktime_t interval)
437{
438 struct alarm_base *base = &alarm_bases[alarm->type];
439
440 return alarm_forward(alarm, base->gettime(), interval);
441}
11682a41 442EXPORT_SYMBOL_GPL(alarm_forward_now);
dce75a8c
JS
443
444
180bf812 445/**
9a7adcf5
JS
446 * clock2alarm - helper that converts from clockid to alarmtypes
447 * @clockid: clockid.
9a7adcf5
JS
448 */
449static enum alarmtimer_type clock2alarm(clockid_t clockid)
450{
451 if (clockid == CLOCK_REALTIME_ALARM)
452 return ALARM_REALTIME;
453 if (clockid == CLOCK_BOOTTIME_ALARM)
454 return ALARM_BOOTTIME;
455 return -1;
456}
457
180bf812 458/**
9a7adcf5
JS
459 * alarm_handle_timer - Callback for posix timers
460 * @alarm: alarm that fired
461 *
462 * Posix timer callback for expired alarm timers.
463 */
4b41308d
JS
464static enum alarmtimer_restart alarm_handle_timer(struct alarm *alarm,
465 ktime_t now)
9a7adcf5
JS
466{
467 struct k_itimer *ptr = container_of(alarm, struct k_itimer,
9e264762 468 it.alarm.alarmtimer);
9a7adcf5
JS
469 if (posix_timer_event(ptr, 0) != 0)
470 ptr->it_overrun++;
4b41308d 471
54da23b7 472 /* Re-add periodic timers */
9e264762
JS
473 if (ptr->it.alarm.interval.tv64) {
474 ptr->it_overrun += alarm_forward(alarm, now,
475 ptr->it.alarm.interval);
54da23b7
JS
476 return ALARMTIMER_RESTART;
477 }
4b41308d 478 return ALARMTIMER_NORESTART;
9a7adcf5
JS
479}
480
180bf812 481/**
9a7adcf5
JS
482 * alarm_clock_getres - posix getres interface
483 * @which_clock: clockid
484 * @tp: timespec to fill
485 *
486 * Returns the granularity of underlying alarm base clock
487 */
488static int alarm_clock_getres(const clockid_t which_clock, struct timespec *tp)
489{
490 clockid_t baseid = alarm_bases[clock2alarm(which_clock)].base_clockid;
491
1c6b39ad 492 if (!alarmtimer_get_rtcdev())
98d6f4dd 493 return -EINVAL;
1c6b39ad 494
9a7adcf5
JS
495 return hrtimer_get_res(baseid, tp);
496}
497
498/**
499 * alarm_clock_get - posix clock_get interface
500 * @which_clock: clockid
501 * @tp: timespec to fill.
502 *
503 * Provides the underlying alarm base time.
504 */
505static int alarm_clock_get(clockid_t which_clock, struct timespec *tp)
506{
507 struct alarm_base *base = &alarm_bases[clock2alarm(which_clock)];
508
1c6b39ad 509 if (!alarmtimer_get_rtcdev())
98d6f4dd 510 return -EINVAL;
1c6b39ad 511
9a7adcf5
JS
512 *tp = ktime_to_timespec(base->gettime());
513 return 0;
514}
515
516/**
517 * alarm_timer_create - posix timer_create interface
518 * @new_timer: k_itimer pointer to manage
519 *
520 * Initializes the k_itimer structure.
521 */
522static int alarm_timer_create(struct k_itimer *new_timer)
523{
524 enum alarmtimer_type type;
525 struct alarm_base *base;
526
1c6b39ad
JS
527 if (!alarmtimer_get_rtcdev())
528 return -ENOTSUPP;
529
9a7adcf5
JS
530 if (!capable(CAP_WAKE_ALARM))
531 return -EPERM;
532
533 type = clock2alarm(new_timer->it_clock);
534 base = &alarm_bases[type];
9e264762 535 alarm_init(&new_timer->it.alarm.alarmtimer, type, alarm_handle_timer);
9a7adcf5
JS
536 return 0;
537}
538
539/**
540 * alarm_timer_get - posix timer_get interface
541 * @new_timer: k_itimer pointer
542 * @cur_setting: itimerspec data to fill
543 *
544 * Copies the itimerspec data out from the k_itimer
545 */
546static void alarm_timer_get(struct k_itimer *timr,
547 struct itimerspec *cur_setting)
548{
ea7802f6
JS
549 memset(cur_setting, 0, sizeof(struct itimerspec));
550
9a7adcf5 551 cur_setting->it_interval =
9e264762 552 ktime_to_timespec(timr->it.alarm.interval);
9a7adcf5 553 cur_setting->it_value =
9e264762 554 ktime_to_timespec(timr->it.alarm.alarmtimer.node.expires);
9a7adcf5
JS
555 return;
556}
557
558/**
559 * alarm_timer_del - posix timer_del interface
560 * @timr: k_itimer pointer to be deleted
561 *
562 * Cancels any programmed alarms for the given timer.
563 */
564static int alarm_timer_del(struct k_itimer *timr)
565{
1c6b39ad
JS
566 if (!rtcdev)
567 return -ENOTSUPP;
568
9082c465
JS
569 if (alarm_try_to_cancel(&timr->it.alarm.alarmtimer) < 0)
570 return TIMER_RETRY;
571
9a7adcf5
JS
572 return 0;
573}
574
575/**
576 * alarm_timer_set - posix timer_set interface
577 * @timr: k_itimer pointer to be deleted
578 * @flags: timer flags
579 * @new_setting: itimerspec to be used
580 * @old_setting: itimerspec being replaced
581 *
582 * Sets the timer to new_setting, and starts the timer.
583 */
584static int alarm_timer_set(struct k_itimer *timr, int flags,
585 struct itimerspec *new_setting,
586 struct itimerspec *old_setting)
587{
16927776
JS
588 ktime_t exp;
589
1c6b39ad
JS
590 if (!rtcdev)
591 return -ENOTSUPP;
592
16927776
JS
593 if (flags & ~TIMER_ABSTIME)
594 return -EINVAL;
595
971c90bf
JS
596 if (old_setting)
597 alarm_timer_get(timr, old_setting);
9a7adcf5
JS
598
599 /* If the timer was already set, cancel it */
9082c465
JS
600 if (alarm_try_to_cancel(&timr->it.alarm.alarmtimer) < 0)
601 return TIMER_RETRY;
9a7adcf5
JS
602
603 /* start the timer */
9e264762 604 timr->it.alarm.interval = timespec_to_ktime(new_setting->it_interval);
16927776
JS
605 exp = timespec_to_ktime(new_setting->it_value);
606 /* Convert (if necessary) to absolute time */
607 if (flags != TIMER_ABSTIME) {
608 ktime_t now;
609
610 now = alarm_bases[timr->it.alarm.alarmtimer.type].gettime();
611 exp = ktime_add(now, exp);
612 }
613
614 alarm_start(&timr->it.alarm.alarmtimer, exp);
9a7adcf5
JS
615 return 0;
616}
617
618/**
619 * alarmtimer_nsleep_wakeup - Wakeup function for alarm_timer_nsleep
620 * @alarm: ptr to alarm that fired
621 *
622 * Wakes up the task that set the alarmtimer
623 */
4b41308d
JS
624static enum alarmtimer_restart alarmtimer_nsleep_wakeup(struct alarm *alarm,
625 ktime_t now)
9a7adcf5
JS
626{
627 struct task_struct *task = (struct task_struct *)alarm->data;
628
629 alarm->data = NULL;
630 if (task)
631 wake_up_process(task);
4b41308d 632 return ALARMTIMER_NORESTART;
9a7adcf5
JS
633}
634
635/**
636 * alarmtimer_do_nsleep - Internal alarmtimer nsleep implementation
637 * @alarm: ptr to alarmtimer
638 * @absexp: absolute expiration time
639 *
640 * Sets the alarm timer and sleeps until it is fired or interrupted.
641 */
642static int alarmtimer_do_nsleep(struct alarm *alarm, ktime_t absexp)
643{
644 alarm->data = (void *)current;
645 do {
646 set_current_state(TASK_INTERRUPTIBLE);
9e264762 647 alarm_start(alarm, absexp);
9a7adcf5
JS
648 if (likely(alarm->data))
649 schedule();
650
651 alarm_cancel(alarm);
652 } while (alarm->data && !signal_pending(current));
653
654 __set_current_state(TASK_RUNNING);
655
656 return (alarm->data == NULL);
657}
658
659
660/**
661 * update_rmtp - Update remaining timespec value
662 * @exp: expiration time
663 * @type: timer type
664 * @rmtp: user pointer to remaining timepsec value
665 *
666 * Helper function that fills in rmtp value with time between
667 * now and the exp value
668 */
669static int update_rmtp(ktime_t exp, enum alarmtimer_type type,
670 struct timespec __user *rmtp)
671{
672 struct timespec rmt;
673 ktime_t rem;
674
675 rem = ktime_sub(exp, alarm_bases[type].gettime());
676
677 if (rem.tv64 <= 0)
678 return 0;
679 rmt = ktime_to_timespec(rem);
680
681 if (copy_to_user(rmtp, &rmt, sizeof(*rmtp)))
682 return -EFAULT;
683
684 return 1;
685
686}
687
688/**
689 * alarm_timer_nsleep_restart - restartblock alarmtimer nsleep
690 * @restart: ptr to restart block
691 *
692 * Handles restarted clock_nanosleep calls
693 */
694static long __sched alarm_timer_nsleep_restart(struct restart_block *restart)
695{
ab8177bc 696 enum alarmtimer_type type = restart->nanosleep.clockid;
9a7adcf5
JS
697 ktime_t exp;
698 struct timespec __user *rmtp;
699 struct alarm alarm;
700 int ret = 0;
701
702 exp.tv64 = restart->nanosleep.expires;
703 alarm_init(&alarm, type, alarmtimer_nsleep_wakeup);
704
705 if (alarmtimer_do_nsleep(&alarm, exp))
706 goto out;
707
708 if (freezing(current))
709 alarmtimer_freezerset(exp, type);
710
711 rmtp = restart->nanosleep.rmtp;
712 if (rmtp) {
713 ret = update_rmtp(exp, type, rmtp);
714 if (ret <= 0)
715 goto out;
716 }
717
718
719 /* The other values in restart are already filled in */
720 ret = -ERESTART_RESTARTBLOCK;
721out:
722 return ret;
723}
724
725/**
726 * alarm_timer_nsleep - alarmtimer nanosleep
727 * @which_clock: clockid
728 * @flags: determins abstime or relative
729 * @tsreq: requested sleep time (abs or rel)
730 * @rmtp: remaining sleep time saved
731 *
732 * Handles clock_nanosleep calls against _ALARM clockids
733 */
734static int alarm_timer_nsleep(const clockid_t which_clock, int flags,
735 struct timespec *tsreq, struct timespec __user *rmtp)
736{
737 enum alarmtimer_type type = clock2alarm(which_clock);
738 struct alarm alarm;
739 ktime_t exp;
740 int ret = 0;
741 struct restart_block *restart;
742
1c6b39ad
JS
743 if (!alarmtimer_get_rtcdev())
744 return -ENOTSUPP;
745
16927776
JS
746 if (flags & ~TIMER_ABSTIME)
747 return -EINVAL;
748
9a7adcf5
JS
749 if (!capable(CAP_WAKE_ALARM))
750 return -EPERM;
751
752 alarm_init(&alarm, type, alarmtimer_nsleep_wakeup);
753
754 exp = timespec_to_ktime(*tsreq);
755 /* Convert (if necessary) to absolute time */
756 if (flags != TIMER_ABSTIME) {
757 ktime_t now = alarm_bases[type].gettime();
758 exp = ktime_add(now, exp);
759 }
760
761 if (alarmtimer_do_nsleep(&alarm, exp))
762 goto out;
763
764 if (freezing(current))
765 alarmtimer_freezerset(exp, type);
766
767 /* abs timers don't set remaining time or restart */
768 if (flags == TIMER_ABSTIME) {
769 ret = -ERESTARTNOHAND;
770 goto out;
771 }
772
773 if (rmtp) {
774 ret = update_rmtp(exp, type, rmtp);
775 if (ret <= 0)
776 goto out;
777 }
778
779 restart = &current_thread_info()->restart_block;
780 restart->fn = alarm_timer_nsleep_restart;
ab8177bc 781 restart->nanosleep.clockid = type;
9a7adcf5
JS
782 restart->nanosleep.expires = exp.tv64;
783 restart->nanosleep.rmtp = rmtp;
784 ret = -ERESTART_RESTARTBLOCK;
785
786out:
787 return ret;
788}
ff3ead96 789
ff3ead96
JS
790
791/* Suspend hook structures */
792static const struct dev_pm_ops alarmtimer_pm_ops = {
793 .suspend = alarmtimer_suspend,
794};
795
796static struct platform_driver alarmtimer_driver = {
797 .driver = {
798 .name = "alarmtimer",
799 .pm = &alarmtimer_pm_ops,
800 }
801};
802
803/**
804 * alarmtimer_init - Initialize alarm timer code
805 *
806 * This function initializes the alarm bases and registers
807 * the posix clock ids.
808 */
809static int __init alarmtimer_init(void)
810{
4523f6ad 811 struct platform_device *pdev;
ff3ead96
JS
812 int error = 0;
813 int i;
9a7adcf5
JS
814 struct k_clock alarm_clock = {
815 .clock_getres = alarm_clock_getres,
816 .clock_get = alarm_clock_get,
817 .timer_create = alarm_timer_create,
818 .timer_set = alarm_timer_set,
819 .timer_del = alarm_timer_del,
820 .timer_get = alarm_timer_get,
821 .nsleep = alarm_timer_nsleep,
822 };
823
c5e14e76 824 alarmtimer_rtc_timer_init();
ad30dfa9 825
9a7adcf5
JS
826 posix_timers_register_clock(CLOCK_REALTIME_ALARM, &alarm_clock);
827 posix_timers_register_clock(CLOCK_BOOTTIME_ALARM, &alarm_clock);
ff3ead96
JS
828
829 /* Initialize alarm bases */
830 alarm_bases[ALARM_REALTIME].base_clockid = CLOCK_REALTIME;
831 alarm_bases[ALARM_REALTIME].gettime = &ktime_get_real;
832 alarm_bases[ALARM_BOOTTIME].base_clockid = CLOCK_BOOTTIME;
833 alarm_bases[ALARM_BOOTTIME].gettime = &ktime_get_boottime;
834 for (i = 0; i < ALARM_NUMTYPE; i++) {
835 timerqueue_init_head(&alarm_bases[i].timerqueue);
836 spin_lock_init(&alarm_bases[i].lock);
ff3ead96 837 }
8bc0dafb 838
4523f6ad
TG
839 error = alarmtimer_rtc_interface_setup();
840 if (error)
841 return error;
842
ff3ead96 843 error = platform_driver_register(&alarmtimer_driver);
4523f6ad
TG
844 if (error)
845 goto out_if;
ff3ead96 846
4523f6ad
TG
847 pdev = platform_device_register_simple("alarmtimer", -1, NULL, 0);
848 if (IS_ERR(pdev)) {
849 error = PTR_ERR(pdev);
850 goto out_drv;
851 }
59a93c27 852 ws = wakeup_source_register("alarmtimer");
4523f6ad
TG
853 return 0;
854
855out_drv:
856 platform_driver_unregister(&alarmtimer_driver);
857out_if:
858 alarmtimer_rtc_interface_remove();
ff3ead96
JS
859 return error;
860}
861device_initcall(alarmtimer_init);