]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - kernel/time/alarmtimer.c
alarmtimer: Do not signal SIGEV_NONE timers
[mirror_ubuntu-jammy-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}
71d5d2b7 74EXPORT_SYMBOL_GPL(alarmtimer_get_rtcdev);
8bc0dafb
JS
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);
265b81d2
RL
469 if ((ptr->it_sigev_notify & ~SIGEV_THREAD_ID) != SIGEV_NONE) {
470 if (posix_timer_event(ptr, 0) != 0)
471 ptr->it_overrun++;
472 }
4b41308d 473
54da23b7 474 /* Re-add periodic timers */
9e264762
JS
475 if (ptr->it.alarm.interval.tv64) {
476 ptr->it_overrun += alarm_forward(alarm, now,
477 ptr->it.alarm.interval);
54da23b7
JS
478 return ALARMTIMER_RESTART;
479 }
4b41308d 480 return ALARMTIMER_NORESTART;
9a7adcf5
JS
481}
482
180bf812 483/**
9a7adcf5
JS
484 * alarm_clock_getres - posix getres interface
485 * @which_clock: clockid
486 * @tp: timespec to fill
487 *
488 * Returns the granularity of underlying alarm base clock
489 */
490static int alarm_clock_getres(const clockid_t which_clock, struct timespec *tp)
491{
492 clockid_t baseid = alarm_bases[clock2alarm(which_clock)].base_clockid;
493
1c6b39ad 494 if (!alarmtimer_get_rtcdev())
98d6f4dd 495 return -EINVAL;
1c6b39ad 496
9a7adcf5
JS
497 return hrtimer_get_res(baseid, tp);
498}
499
500/**
501 * alarm_clock_get - posix clock_get interface
502 * @which_clock: clockid
503 * @tp: timespec to fill.
504 *
505 * Provides the underlying alarm base time.
506 */
507static int alarm_clock_get(clockid_t which_clock, struct timespec *tp)
508{
509 struct alarm_base *base = &alarm_bases[clock2alarm(which_clock)];
510
1c6b39ad 511 if (!alarmtimer_get_rtcdev())
98d6f4dd 512 return -EINVAL;
1c6b39ad 513
9a7adcf5
JS
514 *tp = ktime_to_timespec(base->gettime());
515 return 0;
516}
517
518/**
519 * alarm_timer_create - posix timer_create interface
520 * @new_timer: k_itimer pointer to manage
521 *
522 * Initializes the k_itimer structure.
523 */
524static int alarm_timer_create(struct k_itimer *new_timer)
525{
526 enum alarmtimer_type type;
527 struct alarm_base *base;
528
1c6b39ad
JS
529 if (!alarmtimer_get_rtcdev())
530 return -ENOTSUPP;
531
9a7adcf5
JS
532 if (!capable(CAP_WAKE_ALARM))
533 return -EPERM;
534
535 type = clock2alarm(new_timer->it_clock);
536 base = &alarm_bases[type];
9e264762 537 alarm_init(&new_timer->it.alarm.alarmtimer, type, alarm_handle_timer);
9a7adcf5
JS
538 return 0;
539}
540
541/**
542 * alarm_timer_get - posix timer_get interface
543 * @new_timer: k_itimer pointer
544 * @cur_setting: itimerspec data to fill
545 *
e86fea76 546 * Copies out the current itimerspec data
9a7adcf5
JS
547 */
548static void alarm_timer_get(struct k_itimer *timr,
549 struct itimerspec *cur_setting)
550{
e86fea76
RL
551 ktime_t relative_expiry_time =
552 alarm_expires_remaining(&(timr->it.alarm.alarmtimer));
553
554 if (ktime_to_ns(relative_expiry_time) > 0) {
555 cur_setting->it_value = ktime_to_timespec(relative_expiry_time);
556 } else {
557 cur_setting->it_value.tv_sec = 0;
558 cur_setting->it_value.tv_nsec = 0;
559 }
ea7802f6 560
e86fea76 561 cur_setting->it_interval = ktime_to_timespec(timr->it.alarm.interval);
9a7adcf5
JS
562}
563
564/**
565 * alarm_timer_del - posix timer_del interface
566 * @timr: k_itimer pointer to be deleted
567 *
568 * Cancels any programmed alarms for the given timer.
569 */
570static int alarm_timer_del(struct k_itimer *timr)
571{
1c6b39ad
JS
572 if (!rtcdev)
573 return -ENOTSUPP;
574
9082c465
JS
575 if (alarm_try_to_cancel(&timr->it.alarm.alarmtimer) < 0)
576 return TIMER_RETRY;
577
9a7adcf5
JS
578 return 0;
579}
580
581/**
582 * alarm_timer_set - posix timer_set interface
583 * @timr: k_itimer pointer to be deleted
584 * @flags: timer flags
585 * @new_setting: itimerspec to be used
586 * @old_setting: itimerspec being replaced
587 *
588 * Sets the timer to new_setting, and starts the timer.
589 */
590static int alarm_timer_set(struct k_itimer *timr, int flags,
591 struct itimerspec *new_setting,
592 struct itimerspec *old_setting)
593{
16927776
JS
594 ktime_t exp;
595
1c6b39ad
JS
596 if (!rtcdev)
597 return -ENOTSUPP;
598
16927776
JS
599 if (flags & ~TIMER_ABSTIME)
600 return -EINVAL;
601
971c90bf
JS
602 if (old_setting)
603 alarm_timer_get(timr, old_setting);
9a7adcf5
JS
604
605 /* If the timer was already set, cancel it */
9082c465
JS
606 if (alarm_try_to_cancel(&timr->it.alarm.alarmtimer) < 0)
607 return TIMER_RETRY;
9a7adcf5
JS
608
609 /* start the timer */
9e264762 610 timr->it.alarm.interval = timespec_to_ktime(new_setting->it_interval);
16927776
JS
611 exp = timespec_to_ktime(new_setting->it_value);
612 /* Convert (if necessary) to absolute time */
613 if (flags != TIMER_ABSTIME) {
614 ktime_t now;
615
616 now = alarm_bases[timr->it.alarm.alarmtimer.type].gettime();
617 exp = ktime_add(now, exp);
618 }
619
620 alarm_start(&timr->it.alarm.alarmtimer, exp);
9a7adcf5
JS
621 return 0;
622}
623
624/**
625 * alarmtimer_nsleep_wakeup - Wakeup function for alarm_timer_nsleep
626 * @alarm: ptr to alarm that fired
627 *
628 * Wakes up the task that set the alarmtimer
629 */
4b41308d
JS
630static enum alarmtimer_restart alarmtimer_nsleep_wakeup(struct alarm *alarm,
631 ktime_t now)
9a7adcf5
JS
632{
633 struct task_struct *task = (struct task_struct *)alarm->data;
634
635 alarm->data = NULL;
636 if (task)
637 wake_up_process(task);
4b41308d 638 return ALARMTIMER_NORESTART;
9a7adcf5
JS
639}
640
641/**
642 * alarmtimer_do_nsleep - Internal alarmtimer nsleep implementation
643 * @alarm: ptr to alarmtimer
644 * @absexp: absolute expiration time
645 *
646 * Sets the alarm timer and sleeps until it is fired or interrupted.
647 */
648static int alarmtimer_do_nsleep(struct alarm *alarm, ktime_t absexp)
649{
650 alarm->data = (void *)current;
651 do {
652 set_current_state(TASK_INTERRUPTIBLE);
9e264762 653 alarm_start(alarm, absexp);
9a7adcf5
JS
654 if (likely(alarm->data))
655 schedule();
656
657 alarm_cancel(alarm);
658 } while (alarm->data && !signal_pending(current));
659
660 __set_current_state(TASK_RUNNING);
661
662 return (alarm->data == NULL);
663}
664
665
666/**
667 * update_rmtp - Update remaining timespec value
668 * @exp: expiration time
669 * @type: timer type
670 * @rmtp: user pointer to remaining timepsec value
671 *
672 * Helper function that fills in rmtp value with time between
673 * now and the exp value
674 */
675static int update_rmtp(ktime_t exp, enum alarmtimer_type type,
676 struct timespec __user *rmtp)
677{
678 struct timespec rmt;
679 ktime_t rem;
680
681 rem = ktime_sub(exp, alarm_bases[type].gettime());
682
683 if (rem.tv64 <= 0)
684 return 0;
685 rmt = ktime_to_timespec(rem);
686
687 if (copy_to_user(rmtp, &rmt, sizeof(*rmtp)))
688 return -EFAULT;
689
690 return 1;
691
692}
693
694/**
695 * alarm_timer_nsleep_restart - restartblock alarmtimer nsleep
696 * @restart: ptr to restart block
697 *
698 * Handles restarted clock_nanosleep calls
699 */
700static long __sched alarm_timer_nsleep_restart(struct restart_block *restart)
701{
ab8177bc 702 enum alarmtimer_type type = restart->nanosleep.clockid;
9a7adcf5
JS
703 ktime_t exp;
704 struct timespec __user *rmtp;
705 struct alarm alarm;
706 int ret = 0;
707
708 exp.tv64 = restart->nanosleep.expires;
709 alarm_init(&alarm, type, alarmtimer_nsleep_wakeup);
710
711 if (alarmtimer_do_nsleep(&alarm, exp))
712 goto out;
713
714 if (freezing(current))
715 alarmtimer_freezerset(exp, type);
716
717 rmtp = restart->nanosleep.rmtp;
718 if (rmtp) {
719 ret = update_rmtp(exp, type, rmtp);
720 if (ret <= 0)
721 goto out;
722 }
723
724
725 /* The other values in restart are already filled in */
726 ret = -ERESTART_RESTARTBLOCK;
727out:
728 return ret;
729}
730
731/**
732 * alarm_timer_nsleep - alarmtimer nanosleep
733 * @which_clock: clockid
734 * @flags: determins abstime or relative
735 * @tsreq: requested sleep time (abs or rel)
736 * @rmtp: remaining sleep time saved
737 *
738 * Handles clock_nanosleep calls against _ALARM clockids
739 */
740static int alarm_timer_nsleep(const clockid_t which_clock, int flags,
741 struct timespec *tsreq, struct timespec __user *rmtp)
742{
743 enum alarmtimer_type type = clock2alarm(which_clock);
744 struct alarm alarm;
745 ktime_t exp;
746 int ret = 0;
747 struct restart_block *restart;
748
1c6b39ad
JS
749 if (!alarmtimer_get_rtcdev())
750 return -ENOTSUPP;
751
16927776
JS
752 if (flags & ~TIMER_ABSTIME)
753 return -EINVAL;
754
9a7adcf5
JS
755 if (!capable(CAP_WAKE_ALARM))
756 return -EPERM;
757
758 alarm_init(&alarm, type, alarmtimer_nsleep_wakeup);
759
760 exp = timespec_to_ktime(*tsreq);
761 /* Convert (if necessary) to absolute time */
762 if (flags != TIMER_ABSTIME) {
763 ktime_t now = alarm_bases[type].gettime();
764 exp = ktime_add(now, exp);
765 }
766
767 if (alarmtimer_do_nsleep(&alarm, exp))
768 goto out;
769
770 if (freezing(current))
771 alarmtimer_freezerset(exp, type);
772
773 /* abs timers don't set remaining time or restart */
774 if (flags == TIMER_ABSTIME) {
775 ret = -ERESTARTNOHAND;
776 goto out;
777 }
778
779 if (rmtp) {
780 ret = update_rmtp(exp, type, rmtp);
781 if (ret <= 0)
782 goto out;
783 }
784
785 restart = &current_thread_info()->restart_block;
786 restart->fn = alarm_timer_nsleep_restart;
ab8177bc 787 restart->nanosleep.clockid = type;
9a7adcf5
JS
788 restart->nanosleep.expires = exp.tv64;
789 restart->nanosleep.rmtp = rmtp;
790 ret = -ERESTART_RESTARTBLOCK;
791
792out:
793 return ret;
794}
ff3ead96 795
ff3ead96
JS
796
797/* Suspend hook structures */
798static const struct dev_pm_ops alarmtimer_pm_ops = {
799 .suspend = alarmtimer_suspend,
800};
801
802static struct platform_driver alarmtimer_driver = {
803 .driver = {
804 .name = "alarmtimer",
805 .pm = &alarmtimer_pm_ops,
806 }
807};
808
809/**
810 * alarmtimer_init - Initialize alarm timer code
811 *
812 * This function initializes the alarm bases and registers
813 * the posix clock ids.
814 */
815static int __init alarmtimer_init(void)
816{
4523f6ad 817 struct platform_device *pdev;
ff3ead96
JS
818 int error = 0;
819 int i;
9a7adcf5
JS
820 struct k_clock alarm_clock = {
821 .clock_getres = alarm_clock_getres,
822 .clock_get = alarm_clock_get,
823 .timer_create = alarm_timer_create,
824 .timer_set = alarm_timer_set,
825 .timer_del = alarm_timer_del,
826 .timer_get = alarm_timer_get,
827 .nsleep = alarm_timer_nsleep,
828 };
829
c5e14e76 830 alarmtimer_rtc_timer_init();
ad30dfa9 831
9a7adcf5
JS
832 posix_timers_register_clock(CLOCK_REALTIME_ALARM, &alarm_clock);
833 posix_timers_register_clock(CLOCK_BOOTTIME_ALARM, &alarm_clock);
ff3ead96
JS
834
835 /* Initialize alarm bases */
836 alarm_bases[ALARM_REALTIME].base_clockid = CLOCK_REALTIME;
837 alarm_bases[ALARM_REALTIME].gettime = &ktime_get_real;
838 alarm_bases[ALARM_BOOTTIME].base_clockid = CLOCK_BOOTTIME;
839 alarm_bases[ALARM_BOOTTIME].gettime = &ktime_get_boottime;
840 for (i = 0; i < ALARM_NUMTYPE; i++) {
841 timerqueue_init_head(&alarm_bases[i].timerqueue);
842 spin_lock_init(&alarm_bases[i].lock);
ff3ead96 843 }
8bc0dafb 844
4523f6ad
TG
845 error = alarmtimer_rtc_interface_setup();
846 if (error)
847 return error;
848
ff3ead96 849 error = platform_driver_register(&alarmtimer_driver);
4523f6ad
TG
850 if (error)
851 goto out_if;
ff3ead96 852
4523f6ad
TG
853 pdev = platform_device_register_simple("alarmtimer", -1, NULL, 0);
854 if (IS_ERR(pdev)) {
855 error = PTR_ERR(pdev);
856 goto out_drv;
857 }
59a93c27 858 ws = wakeup_source_register("alarmtimer");
4523f6ad
TG
859 return 0;
860
861out_drv:
862 platform_driver_unregister(&alarmtimer_driver);
863out_if:
864 alarmtimer_rtc_interface_remove();
ff3ead96
JS
865 return error;
866}
867device_initcall(alarmtimer_init);