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