alarmtimer.c 21 KB

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