alarmtimer.c 20 KB

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