alarmtimer.c 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894
  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. * @gettime: Function to read the time correlating to the base
  33. * @base_clockid: clockid for the base
  34. */
  35. static struct alarm_base {
  36. spinlock_t lock;
  37. struct timerqueue_head timerqueue;
  38. ktime_t (*gettime)(void);
  39. clockid_t base_clockid;
  40. } alarm_bases[ALARM_NUMTYPE];
  41. /* freezer delta & lock used to handle clock_nanosleep triggered wakeups */
  42. static ktime_t freezer_delta;
  43. static DEFINE_SPINLOCK(freezer_delta_lock);
  44. static struct wakeup_source *ws;
  45. #ifdef CONFIG_RTC_CLASS
  46. /* rtc timer and device for setting alarm wakeups at suspend */
  47. static struct rtc_timer rtctimer;
  48. static struct rtc_device *rtcdev;
  49. static DEFINE_SPINLOCK(rtcdev_lock);
  50. /**
  51. * alarmtimer_get_rtcdev - Return selected rtcdevice
  52. *
  53. * This function returns the rtc device to use for wakealarms.
  54. * If one has not already been chosen, it checks to see if a
  55. * functional rtc device is available.
  56. */
  57. struct rtc_device *alarmtimer_get_rtcdev(void)
  58. {
  59. unsigned long flags;
  60. struct rtc_device *ret;
  61. spin_lock_irqsave(&rtcdev_lock, flags);
  62. ret = rtcdev;
  63. spin_unlock_irqrestore(&rtcdev_lock, flags);
  64. return ret;
  65. }
  66. EXPORT_SYMBOL_GPL(alarmtimer_get_rtcdev);
  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. static int alarmtimer_resume(struct device *dev)
  240. {
  241. struct rtc_device *rtc;
  242. rtc = alarmtimer_get_rtcdev();
  243. if (rtc)
  244. rtc_timer_cancel(rtc, &rtctimer);
  245. return 0;
  246. }
  247. #else
  248. static int alarmtimer_suspend(struct device *dev)
  249. {
  250. return 0;
  251. }
  252. static int alarmtimer_resume(struct device *dev)
  253. {
  254. return 0;
  255. }
  256. #endif
  257. static void alarmtimer_freezerset(ktime_t absexp, enum alarmtimer_type type)
  258. {
  259. ktime_t delta;
  260. unsigned long flags;
  261. struct alarm_base *base = &alarm_bases[type];
  262. delta = ktime_sub(absexp, base->gettime());
  263. spin_lock_irqsave(&freezer_delta_lock, flags);
  264. if (!freezer_delta.tv64 || (delta.tv64 < freezer_delta.tv64))
  265. freezer_delta = delta;
  266. spin_unlock_irqrestore(&freezer_delta_lock, flags);
  267. }
  268. /**
  269. * alarm_init - Initialize an alarm structure
  270. * @alarm: ptr to alarm to be initialized
  271. * @type: the type of the alarm
  272. * @function: callback that is run when the alarm fires
  273. */
  274. void alarm_init(struct alarm *alarm, enum alarmtimer_type type,
  275. enum alarmtimer_restart (*function)(struct alarm *, ktime_t))
  276. {
  277. timerqueue_init(&alarm->node);
  278. hrtimer_init(&alarm->timer, alarm_bases[type].base_clockid,
  279. HRTIMER_MODE_ABS);
  280. alarm->timer.function = alarmtimer_fired;
  281. alarm->function = function;
  282. alarm->type = type;
  283. alarm->state = ALARMTIMER_STATE_INACTIVE;
  284. }
  285. EXPORT_SYMBOL_GPL(alarm_init);
  286. /**
  287. * alarm_start - Sets an absolute 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. alarm->node.expires = start;
  297. alarmtimer_enqueue(base, alarm);
  298. hrtimer_start(&alarm->timer, alarm->node.expires, HRTIMER_MODE_ABS);
  299. spin_unlock_irqrestore(&base->lock, flags);
  300. }
  301. EXPORT_SYMBOL_GPL(alarm_start);
  302. /**
  303. * alarm_start_relative - Sets a relative alarm to fire
  304. * @alarm: ptr to alarm to set
  305. * @start: time relative to now to run the alarm
  306. */
  307. void alarm_start_relative(struct alarm *alarm, ktime_t start)
  308. {
  309. struct alarm_base *base = &alarm_bases[alarm->type];
  310. start = ktime_add_safe(start, base->gettime());
  311. alarm_start(alarm, start);
  312. }
  313. EXPORT_SYMBOL_GPL(alarm_start_relative);
  314. void alarm_restart(struct alarm *alarm)
  315. {
  316. struct alarm_base *base = &alarm_bases[alarm->type];
  317. unsigned long flags;
  318. spin_lock_irqsave(&base->lock, flags);
  319. hrtimer_set_expires(&alarm->timer, alarm->node.expires);
  320. hrtimer_restart(&alarm->timer);
  321. alarmtimer_enqueue(base, alarm);
  322. spin_unlock_irqrestore(&base->lock, flags);
  323. }
  324. EXPORT_SYMBOL_GPL(alarm_restart);
  325. /**
  326. * alarm_try_to_cancel - Tries to cancel an alarm timer
  327. * @alarm: ptr to alarm to be canceled
  328. *
  329. * Returns 1 if the timer was canceled, 0 if it was not running,
  330. * and -1 if the callback was running
  331. */
  332. int alarm_try_to_cancel(struct alarm *alarm)
  333. {
  334. struct alarm_base *base = &alarm_bases[alarm->type];
  335. unsigned long flags;
  336. int ret;
  337. spin_lock_irqsave(&base->lock, flags);
  338. ret = hrtimer_try_to_cancel(&alarm->timer);
  339. if (ret >= 0)
  340. alarmtimer_dequeue(base, alarm);
  341. spin_unlock_irqrestore(&base->lock, flags);
  342. return ret;
  343. }
  344. EXPORT_SYMBOL_GPL(alarm_try_to_cancel);
  345. /**
  346. * alarm_cancel - Spins trying to cancel an alarm timer until it is done
  347. * @alarm: ptr to alarm to be canceled
  348. *
  349. * Returns 1 if the timer was canceled, 0 if it was not active.
  350. */
  351. int alarm_cancel(struct alarm *alarm)
  352. {
  353. for (;;) {
  354. int ret = alarm_try_to_cancel(alarm);
  355. if (ret >= 0)
  356. return ret;
  357. cpu_relax();
  358. }
  359. }
  360. EXPORT_SYMBOL_GPL(alarm_cancel);
  361. u64 alarm_forward(struct alarm *alarm, ktime_t now, ktime_t interval)
  362. {
  363. u64 overrun = 1;
  364. ktime_t delta;
  365. delta = ktime_sub(now, alarm->node.expires);
  366. if (delta.tv64 < 0)
  367. return 0;
  368. if (unlikely(delta.tv64 >= interval.tv64)) {
  369. s64 incr = ktime_to_ns(interval);
  370. overrun = ktime_divns(delta, incr);
  371. alarm->node.expires = ktime_add_ns(alarm->node.expires,
  372. incr*overrun);
  373. if (alarm->node.expires.tv64 > now.tv64)
  374. return overrun;
  375. /*
  376. * This (and the ktime_add() below) is the
  377. * correction for exact:
  378. */
  379. overrun++;
  380. }
  381. alarm->node.expires = ktime_add_safe(alarm->node.expires, interval);
  382. return overrun;
  383. }
  384. EXPORT_SYMBOL_GPL(alarm_forward);
  385. u64 alarm_forward_now(struct alarm *alarm, ktime_t interval)
  386. {
  387. struct alarm_base *base = &alarm_bases[alarm->type];
  388. return alarm_forward(alarm, base->gettime(), interval);
  389. }
  390. EXPORT_SYMBOL_GPL(alarm_forward_now);
  391. /**
  392. * clock2alarm - helper that converts from clockid to alarmtypes
  393. * @clockid: clockid.
  394. */
  395. static enum alarmtimer_type clock2alarm(clockid_t clockid)
  396. {
  397. if (clockid == CLOCK_REALTIME_ALARM)
  398. return ALARM_REALTIME;
  399. if (clockid == CLOCK_BOOTTIME_ALARM)
  400. return ALARM_BOOTTIME;
  401. return -1;
  402. }
  403. /**
  404. * alarm_handle_timer - Callback for posix timers
  405. * @alarm: alarm that fired
  406. *
  407. * Posix timer callback for expired alarm timers.
  408. */
  409. static enum alarmtimer_restart alarm_handle_timer(struct alarm *alarm,
  410. ktime_t now)
  411. {
  412. unsigned long flags;
  413. struct k_itimer *ptr = container_of(alarm, struct k_itimer,
  414. it.alarm.alarmtimer);
  415. enum alarmtimer_restart result = ALARMTIMER_NORESTART;
  416. spin_lock_irqsave(&ptr->it_lock, flags);
  417. if ((ptr->it_sigev_notify & ~SIGEV_THREAD_ID) != SIGEV_NONE) {
  418. if (posix_timer_event(ptr, 0) != 0)
  419. ptr->it_overrun++;
  420. }
  421. /* Re-add periodic timers */
  422. if (ptr->it.alarm.interval.tv64) {
  423. ptr->it_overrun += alarm_forward(alarm, now,
  424. ptr->it.alarm.interval);
  425. result = ALARMTIMER_RESTART;
  426. }
  427. spin_unlock_irqrestore(&ptr->it_lock, flags);
  428. return result;
  429. }
  430. /**
  431. * alarm_clock_getres - posix getres interface
  432. * @which_clock: clockid
  433. * @tp: timespec to fill
  434. *
  435. * Returns the granularity of underlying alarm base clock
  436. */
  437. static int alarm_clock_getres(const clockid_t which_clock, struct timespec *tp)
  438. {
  439. if (!alarmtimer_get_rtcdev())
  440. return -EINVAL;
  441. tp->tv_sec = 0;
  442. tp->tv_nsec = hrtimer_resolution;
  443. return 0;
  444. }
  445. /**
  446. * alarm_clock_get - posix clock_get interface
  447. * @which_clock: clockid
  448. * @tp: timespec to fill.
  449. *
  450. * Provides the underlying alarm base time.
  451. */
  452. static int alarm_clock_get(clockid_t which_clock, struct timespec *tp)
  453. {
  454. struct alarm_base *base = &alarm_bases[clock2alarm(which_clock)];
  455. if (!alarmtimer_get_rtcdev())
  456. return -EINVAL;
  457. *tp = ktime_to_timespec(base->gettime());
  458. return 0;
  459. }
  460. /**
  461. * alarm_timer_create - posix timer_create interface
  462. * @new_timer: k_itimer pointer to manage
  463. *
  464. * Initializes the k_itimer structure.
  465. */
  466. static int alarm_timer_create(struct k_itimer *new_timer)
  467. {
  468. enum alarmtimer_type type;
  469. if (!alarmtimer_get_rtcdev())
  470. return -ENOTSUPP;
  471. if (!capable(CAP_WAKE_ALARM))
  472. return -EPERM;
  473. type = clock2alarm(new_timer->it_clock);
  474. alarm_init(&new_timer->it.alarm.alarmtimer, type, alarm_handle_timer);
  475. return 0;
  476. }
  477. /**
  478. * alarm_timer_get - posix timer_get interface
  479. * @new_timer: k_itimer pointer
  480. * @cur_setting: itimerspec data to fill
  481. *
  482. * Copies out the current itimerspec data
  483. */
  484. static void alarm_timer_get(struct k_itimer *timr,
  485. struct itimerspec *cur_setting)
  486. {
  487. ktime_t relative_expiry_time =
  488. alarm_expires_remaining(&(timr->it.alarm.alarmtimer));
  489. if (ktime_to_ns(relative_expiry_time) > 0) {
  490. cur_setting->it_value = ktime_to_timespec(relative_expiry_time);
  491. } else {
  492. cur_setting->it_value.tv_sec = 0;
  493. cur_setting->it_value.tv_nsec = 0;
  494. }
  495. cur_setting->it_interval = ktime_to_timespec(timr->it.alarm.interval);
  496. }
  497. /**
  498. * alarm_timer_del - posix timer_del interface
  499. * @timr: k_itimer pointer to be deleted
  500. *
  501. * Cancels any programmed alarms for the given timer.
  502. */
  503. static int alarm_timer_del(struct k_itimer *timr)
  504. {
  505. if (!rtcdev)
  506. return -ENOTSUPP;
  507. if (alarm_try_to_cancel(&timr->it.alarm.alarmtimer) < 0)
  508. return TIMER_RETRY;
  509. return 0;
  510. }
  511. /**
  512. * alarm_timer_set - posix timer_set interface
  513. * @timr: k_itimer pointer to be deleted
  514. * @flags: timer flags
  515. * @new_setting: itimerspec to be used
  516. * @old_setting: itimerspec being replaced
  517. *
  518. * Sets the timer to new_setting, and starts the timer.
  519. */
  520. static int alarm_timer_set(struct k_itimer *timr, int flags,
  521. struct itimerspec *new_setting,
  522. struct itimerspec *old_setting)
  523. {
  524. ktime_t exp;
  525. if (!rtcdev)
  526. return -ENOTSUPP;
  527. if (flags & ~TIMER_ABSTIME)
  528. return -EINVAL;
  529. if (old_setting)
  530. alarm_timer_get(timr, old_setting);
  531. /* If the timer was already set, cancel it */
  532. if (alarm_try_to_cancel(&timr->it.alarm.alarmtimer) < 0)
  533. return TIMER_RETRY;
  534. /* start the timer */
  535. timr->it.alarm.interval = timespec_to_ktime(new_setting->it_interval);
  536. /*
  537. * Rate limit to the tick as a hot fix to prevent DOS. Will be
  538. * mopped up later.
  539. */
  540. if (timr->it.alarm.interval.tv64 &&
  541. ktime_to_ns(timr->it.alarm.interval) < TICK_NSEC)
  542. timr->it.alarm.interval = ktime_set(0, TICK_NSEC);
  543. exp = timespec_to_ktime(new_setting->it_value);
  544. /* Convert (if necessary) to absolute time */
  545. if (flags != TIMER_ABSTIME) {
  546. ktime_t now;
  547. now = alarm_bases[timr->it.alarm.alarmtimer.type].gettime();
  548. exp = ktime_add_safe(now, exp);
  549. }
  550. alarm_start(&timr->it.alarm.alarmtimer, exp);
  551. return 0;
  552. }
  553. /**
  554. * alarmtimer_nsleep_wakeup - Wakeup function for alarm_timer_nsleep
  555. * @alarm: ptr to alarm that fired
  556. *
  557. * Wakes up the task that set the alarmtimer
  558. */
  559. static enum alarmtimer_restart alarmtimer_nsleep_wakeup(struct alarm *alarm,
  560. ktime_t now)
  561. {
  562. struct task_struct *task = (struct task_struct *)alarm->data;
  563. alarm->data = NULL;
  564. if (task)
  565. wake_up_process(task);
  566. return ALARMTIMER_NORESTART;
  567. }
  568. /**
  569. * alarmtimer_do_nsleep - Internal alarmtimer nsleep implementation
  570. * @alarm: ptr to alarmtimer
  571. * @absexp: absolute expiration time
  572. *
  573. * Sets the alarm timer and sleeps until it is fired or interrupted.
  574. */
  575. static int alarmtimer_do_nsleep(struct alarm *alarm, ktime_t absexp)
  576. {
  577. alarm->data = (void *)current;
  578. do {
  579. set_current_state(TASK_INTERRUPTIBLE);
  580. alarm_start(alarm, absexp);
  581. if (likely(alarm->data))
  582. schedule();
  583. alarm_cancel(alarm);
  584. } while (alarm->data && !signal_pending(current));
  585. __set_current_state(TASK_RUNNING);
  586. return (alarm->data == NULL);
  587. }
  588. /**
  589. * update_rmtp - Update remaining timespec value
  590. * @exp: expiration time
  591. * @type: timer type
  592. * @rmtp: user pointer to remaining timepsec value
  593. *
  594. * Helper function that fills in rmtp value with time between
  595. * now and the exp value
  596. */
  597. static int update_rmtp(ktime_t exp, enum alarmtimer_type type,
  598. struct timespec __user *rmtp)
  599. {
  600. struct timespec rmt;
  601. ktime_t rem;
  602. rem = ktime_sub(exp, alarm_bases[type].gettime());
  603. if (rem.tv64 <= 0)
  604. return 0;
  605. rmt = ktime_to_timespec(rem);
  606. if (copy_to_user(rmtp, &rmt, sizeof(*rmtp)))
  607. return -EFAULT;
  608. return 1;
  609. }
  610. /**
  611. * alarm_timer_nsleep_restart - restartblock alarmtimer nsleep
  612. * @restart: ptr to restart block
  613. *
  614. * Handles restarted clock_nanosleep calls
  615. */
  616. static long __sched alarm_timer_nsleep_restart(struct restart_block *restart)
  617. {
  618. enum alarmtimer_type type = restart->nanosleep.clockid;
  619. ktime_t exp;
  620. struct timespec __user *rmtp;
  621. struct alarm alarm;
  622. int ret = 0;
  623. exp.tv64 = restart->nanosleep.expires;
  624. alarm_init(&alarm, type, alarmtimer_nsleep_wakeup);
  625. if (alarmtimer_do_nsleep(&alarm, exp))
  626. goto out;
  627. if (freezing(current))
  628. alarmtimer_freezerset(exp, type);
  629. rmtp = restart->nanosleep.rmtp;
  630. if (rmtp) {
  631. ret = update_rmtp(exp, type, rmtp);
  632. if (ret <= 0)
  633. goto out;
  634. }
  635. /* The other values in restart are already filled in */
  636. ret = -ERESTART_RESTARTBLOCK;
  637. out:
  638. return ret;
  639. }
  640. /**
  641. * alarm_timer_nsleep - alarmtimer nanosleep
  642. * @which_clock: clockid
  643. * @flags: determins abstime or relative
  644. * @tsreq: requested sleep time (abs or rel)
  645. * @rmtp: remaining sleep time saved
  646. *
  647. * Handles clock_nanosleep calls against _ALARM clockids
  648. */
  649. static int alarm_timer_nsleep(const clockid_t which_clock, int flags,
  650. struct timespec *tsreq, struct timespec __user *rmtp)
  651. {
  652. enum alarmtimer_type type = clock2alarm(which_clock);
  653. struct alarm alarm;
  654. ktime_t exp;
  655. int ret = 0;
  656. struct restart_block *restart;
  657. if (!alarmtimer_get_rtcdev())
  658. return -ENOTSUPP;
  659. if (flags & ~TIMER_ABSTIME)
  660. return -EINVAL;
  661. if (!capable(CAP_WAKE_ALARM))
  662. return -EPERM;
  663. alarm_init(&alarm, type, alarmtimer_nsleep_wakeup);
  664. exp = timespec_to_ktime(*tsreq);
  665. /* Convert (if necessary) to absolute time */
  666. if (flags != TIMER_ABSTIME) {
  667. ktime_t now = alarm_bases[type].gettime();
  668. exp = ktime_add(now, exp);
  669. }
  670. if (alarmtimer_do_nsleep(&alarm, exp))
  671. goto out;
  672. if (freezing(current))
  673. alarmtimer_freezerset(exp, type);
  674. /* abs timers don't set remaining time or restart */
  675. if (flags == TIMER_ABSTIME) {
  676. ret = -ERESTARTNOHAND;
  677. goto out;
  678. }
  679. if (rmtp) {
  680. ret = update_rmtp(exp, type, rmtp);
  681. if (ret <= 0)
  682. goto out;
  683. }
  684. restart = &current->restart_block;
  685. restart->fn = alarm_timer_nsleep_restart;
  686. restart->nanosleep.clockid = type;
  687. restart->nanosleep.expires = exp.tv64;
  688. restart->nanosleep.rmtp = rmtp;
  689. ret = -ERESTART_RESTARTBLOCK;
  690. out:
  691. return ret;
  692. }
  693. /* Suspend hook structures */
  694. static const struct dev_pm_ops alarmtimer_pm_ops = {
  695. .suspend = alarmtimer_suspend,
  696. .resume = alarmtimer_resume,
  697. };
  698. static struct platform_driver alarmtimer_driver = {
  699. .driver = {
  700. .name = "alarmtimer",
  701. .pm = &alarmtimer_pm_ops,
  702. }
  703. };
  704. /**
  705. * alarmtimer_init - Initialize alarm timer code
  706. *
  707. * This function initializes the alarm bases and registers
  708. * the posix clock ids.
  709. */
  710. static int __init alarmtimer_init(void)
  711. {
  712. struct platform_device *pdev;
  713. int error = 0;
  714. int i;
  715. struct k_clock alarm_clock = {
  716. .clock_getres = alarm_clock_getres,
  717. .clock_get = alarm_clock_get,
  718. .timer_create = alarm_timer_create,
  719. .timer_set = alarm_timer_set,
  720. .timer_del = alarm_timer_del,
  721. .timer_get = alarm_timer_get,
  722. .nsleep = alarm_timer_nsleep,
  723. };
  724. alarmtimer_rtc_timer_init();
  725. posix_timers_register_clock(CLOCK_REALTIME_ALARM, &alarm_clock);
  726. posix_timers_register_clock(CLOCK_BOOTTIME_ALARM, &alarm_clock);
  727. /* Initialize alarm bases */
  728. alarm_bases[ALARM_REALTIME].base_clockid = CLOCK_REALTIME;
  729. alarm_bases[ALARM_REALTIME].gettime = &ktime_get_real;
  730. alarm_bases[ALARM_BOOTTIME].base_clockid = CLOCK_BOOTTIME;
  731. alarm_bases[ALARM_BOOTTIME].gettime = &ktime_get_boottime;
  732. for (i = 0; i < ALARM_NUMTYPE; i++) {
  733. timerqueue_init_head(&alarm_bases[i].timerqueue);
  734. spin_lock_init(&alarm_bases[i].lock);
  735. }
  736. error = alarmtimer_rtc_interface_setup();
  737. if (error)
  738. return error;
  739. error = platform_driver_register(&alarmtimer_driver);
  740. if (error)
  741. goto out_if;
  742. pdev = platform_device_register_simple("alarmtimer", -1, NULL, 0);
  743. if (IS_ERR(pdev)) {
  744. error = PTR_ERR(pdev);
  745. goto out_drv;
  746. }
  747. ws = wakeup_source_register("alarmtimer");
  748. return 0;
  749. out_drv:
  750. platform_driver_unregister(&alarmtimer_driver);
  751. out_if:
  752. alarmtimer_rtc_interface_remove();
  753. return error;
  754. }
  755. device_initcall(alarmtimer_init);