kernel/time/alarmtimer.c

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