alarmtimer.c 20 KB

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