ARM: socfpga: initial support for Altera's SOCFPGA platform
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / linux / hrtimer.h
CommitLineData
c0a31329
TG
1/*
2 * include/linux/hrtimer.h
3 *
4 * hrtimers - High-resolution kernel timers
5 *
6 * Copyright(C) 2005, Thomas Gleixner <tglx@linutronix.de>
7 * Copyright(C) 2005, Red Hat, Inc., Ingo Molnar
8 *
9 * data type definitions, declarations, prototypes
10 *
11 * Started by: Thomas Gleixner and Ingo Molnar
12 *
13 * For licencing details see kernel-base/COPYING
14 */
15#ifndef _LINUX_HRTIMER_H
16#define _LINUX_HRTIMER_H
17
18#include <linux/rbtree.h>
19#include <linux/ktime.h>
20#include <linux/init.h>
21#include <linux/list.h>
22#include <linux/wait.h>
40b86062 23#include <linux/percpu.h>
507e1231 24#include <linux/timer.h>
998adc3d 25#include <linux/timerqueue.h>
c0a31329 26
3c8aa39d
TG
27struct hrtimer_clock_base;
28struct hrtimer_cpu_base;
29
c0a31329
TG
30/*
31 * Mode arguments of xxx_hrtimer functions:
32 */
33enum hrtimer_mode {
597d0275
AB
34 HRTIMER_MODE_ABS = 0x0, /* Time value is absolute */
35 HRTIMER_MODE_REL = 0x1, /* Time value is relative to now */
36 HRTIMER_MODE_PINNED = 0x02, /* Timer is bound to CPU */
37 HRTIMER_MODE_ABS_PINNED = 0x02,
38 HRTIMER_MODE_REL_PINNED = 0x03,
c0a31329
TG
39};
40
c9cb2e3d
TG
41/*
42 * Return values for the callback function
43 */
c0a31329 44enum hrtimer_restart {
c9cb2e3d
TG
45 HRTIMER_NORESTART, /* Timer is not restarted */
46 HRTIMER_RESTART, /* Timer must be restarted */
c0a31329
TG
47};
48
54cdfdb4
TG
49/*
50 * Values to track state of the timer
303e967f
TG
51 *
52 * Possible states:
53 *
54 * 0x00 inactive
55 * 0x01 enqueued into rbtree
56 * 0x02 callback function running
53370d2e 57 * 0x04 timer is migrated to another cpu
54cdfdb4 58 *
b00c1a99 59 * Special cases:
303e967f
TG
60 * 0x03 callback function running and enqueued
61 * (was requeued on another CPU)
53370d2e
TG
62 * 0x05 timer was migrated on CPU hotunplug
63 *
303e967f
TG
64 * The "callback function running and enqueued" status is only possible on
65 * SMP. It happens for example when a posix timer expired and the callback
66 * queued a signal. Between dropping the lock which protects the posix timer
67 * and reacquiring the base lock of the hrtimer, another CPU can deliver the
68 * signal and rearm the timer. We have to preserve the callback running state,
69 * as otherwise the timer could be removed before the softirq code finishes the
70 * the handling of the timer.
71 *
53370d2e
TG
72 * The HRTIMER_STATE_ENQUEUED bit is always or'ed to the current state
73 * to preserve the HRTIMER_STATE_CALLBACK in the above scenario. This
74 * also affects HRTIMER_STATE_MIGRATE where the preservation is not
75 * necessary. HRTIMER_STATE_MIGRATE is cleared after the timer is
76 * enqueued on the new cpu.
303e967f
TG
77 *
78 * All state transitions are protected by cpu_base->lock.
79 */
80#define HRTIMER_STATE_INACTIVE 0x00
81#define HRTIMER_STATE_ENQUEUED 0x01
82#define HRTIMER_STATE_CALLBACK 0x02
ca109491 83#define HRTIMER_STATE_MIGRATE 0x04
303e967f 84
c0a31329
TG
85/**
86 * struct hrtimer - the basic hrtimer structure
998adc3d
JS
87 * @node: timerqueue node, which also manages node.expires,
88 * the absolute expiry time in the hrtimers internal
c0a31329 89 * representation. The time is related to the clock on
592aa999
TG
90 * which the timer is based. Is setup by adding
91 * slack to the _softexpires value. For non range timers
92 * identical to _softexpires.
93 * @_softexpires: the absolute earliest expiry time of the hrtimer.
94 * The time which was given as expiry time when the timer
95 * was armed.
c0a31329 96 * @function: timer expiry callback function
c0a31329 97 * @base: pointer to the timer base (per cpu and per clock)
303e967f 98 * @state: state information (See bit values above)
54cdfdb4
TG
99 * @start_site: timer statistics field to store the site where the timer
100 * was started
101 * @start_comm: timer statistics field to store the name of the process which
102 * started the timer
103 * @start_pid: timer statistics field to store the pid of the task which
104 * started the timer
c0a31329 105 *
54cdfdb4 106 * The hrtimer structure must be initialized by hrtimer_init()
c0a31329
TG
107 */
108struct hrtimer {
998adc3d 109 struct timerqueue_node node;
654c8e0b 110 ktime_t _softexpires;
3c8aa39d
TG
111 enum hrtimer_restart (*function)(struct hrtimer *);
112 struct hrtimer_clock_base *base;
303e967f 113 unsigned long state;
82f67cd9 114#ifdef CONFIG_TIMER_STATS
1b024690 115 int start_pid;
82f67cd9
IM
116 void *start_site;
117 char start_comm[16];
82f67cd9 118#endif
c0a31329
TG
119};
120
00362e33
TG
121/**
122 * struct hrtimer_sleeper - simple sleeper structure
00362e33
TG
123 * @timer: embedded timer structure
124 * @task: task to wake up
125 *
126 * task is set to NULL, when the timer expires.
127 */
128struct hrtimer_sleeper {
129 struct hrtimer timer;
130 struct task_struct *task;
131};
132
c0a31329 133/**
d1d67174 134 * struct hrtimer_clock_base - the timer base for a specific clock
05fb6bf0 135 * @cpu_base: per cpu clock base
3c8aa39d
TG
136 * @index: clock type index for per_cpu support when moving a
137 * timer to a base on another cpu.
4d258b25 138 * @clockid: clock id for per_cpu support
92127c7a 139 * @active: red black tree root node for the active timers
92127c7a
TG
140 * @resolution: the resolution of the clock, in nanoseconds
141 * @get_time: function to retrieve the current time of the clock
92127c7a 142 * @softirq_time: the time when running the hrtimer queue in the softirq
54cdfdb4 143 * @offset: offset of this clock to the monotonic base
c0a31329 144 */
3c8aa39d
TG
145struct hrtimer_clock_base {
146 struct hrtimer_cpu_base *cpu_base;
ab8177bc
TG
147 int index;
148 clockid_t clockid;
998adc3d 149 struct timerqueue_head active;
e2787630 150 ktime_t resolution;
c0a31329 151 ktime_t (*get_time)(void);
92127c7a 152 ktime_t softirq_time;
54cdfdb4 153 ktime_t offset;
3c8aa39d
TG
154};
155
e06383db 156enum hrtimer_base_type {
e06383db 157 HRTIMER_BASE_MONOTONIC,
68fa61c0 158 HRTIMER_BASE_REALTIME,
70a08cca 159 HRTIMER_BASE_BOOTTIME,
e06383db
JS
160 HRTIMER_MAX_CLOCK_BASES,
161};
3c8aa39d
TG
162
163/*
164 * struct hrtimer_cpu_base - the per cpu clock bases
165 * @lock: lock protecting the base and associated clock bases
166 * and timers
ab8177bc 167 * @active_bases: Bitfield to mark bases with active timers
54cdfdb4
TG
168 * @expires_next: absolute time of the next event which was scheduled
169 * via clock_set_next_event()
170 * @hres_active: State of high resolution mode
41d2e494
TG
171 * @hang_detected: The last hrtimer interrupt detected a hang
172 * @nr_events: Total number of hrtimer interrupt events
173 * @nr_retries: Total number of hrtimer interrupt retries
174 * @nr_hangs: Total number of hrtimer interrupt hangs
175 * @max_hang_time: Maximum time spent in hrtimer_interrupt
ab8177bc 176 * @clock_base: array of clock bases for this cpu
3c8aa39d
TG
177 */
178struct hrtimer_cpu_base {
ecb49d1a 179 raw_spinlock_t lock;
ab8177bc 180 unsigned long active_bases;
54cdfdb4
TG
181#ifdef CONFIG_HIGH_RES_TIMERS
182 ktime_t expires_next;
183 int hres_active;
41d2e494 184 int hang_detected;
54cdfdb4 185 unsigned long nr_events;
41d2e494
TG
186 unsigned long nr_retries;
187 unsigned long nr_hangs;
188 ktime_t max_hang_time;
54cdfdb4 189#endif
f24444b0 190 struct hrtimer_clock_base clock_base[HRTIMER_MAX_CLOCK_BASES];
c0a31329
TG
191};
192
63ca243b
AV
193static inline void hrtimer_set_expires(struct hrtimer *timer, ktime_t time)
194{
998adc3d 195 timer->node.expires = time;
654c8e0b 196 timer->_softexpires = time;
63ca243b 197}
654c8e0b
AV
198
199static inline void hrtimer_set_expires_range(struct hrtimer *timer, ktime_t time, ktime_t delta)
200{
201 timer->_softexpires = time;
998adc3d 202 timer->node.expires = ktime_add_safe(time, delta);
654c8e0b
AV
203}
204
205static inline void hrtimer_set_expires_range_ns(struct hrtimer *timer, ktime_t time, unsigned long delta)
206{
207 timer->_softexpires = time;
998adc3d 208 timer->node.expires = ktime_add_safe(time, ns_to_ktime(delta));
654c8e0b
AV
209}
210
63ca243b
AV
211static inline void hrtimer_set_expires_tv64(struct hrtimer *timer, s64 tv64)
212{
998adc3d 213 timer->node.expires.tv64 = tv64;
654c8e0b 214 timer->_softexpires.tv64 = tv64;
63ca243b
AV
215}
216
217static inline void hrtimer_add_expires(struct hrtimer *timer, ktime_t time)
218{
998adc3d 219 timer->node.expires = ktime_add_safe(timer->node.expires, time);
654c8e0b 220 timer->_softexpires = ktime_add_safe(timer->_softexpires, time);
63ca243b
AV
221}
222
7597bc94 223static inline void hrtimer_add_expires_ns(struct hrtimer *timer, u64 ns)
63ca243b 224{
998adc3d 225 timer->node.expires = ktime_add_ns(timer->node.expires, ns);
654c8e0b 226 timer->_softexpires = ktime_add_ns(timer->_softexpires, ns);
63ca243b
AV
227}
228
229static inline ktime_t hrtimer_get_expires(const struct hrtimer *timer)
230{
998adc3d 231 return timer->node.expires;
63ca243b
AV
232}
233
654c8e0b
AV
234static inline ktime_t hrtimer_get_softexpires(const struct hrtimer *timer)
235{
236 return timer->_softexpires;
237}
238
63ca243b
AV
239static inline s64 hrtimer_get_expires_tv64(const struct hrtimer *timer)
240{
998adc3d 241 return timer->node.expires.tv64;
63ca243b 242}
654c8e0b
AV
243static inline s64 hrtimer_get_softexpires_tv64(const struct hrtimer *timer)
244{
245 return timer->_softexpires.tv64;
246}
63ca243b
AV
247
248static inline s64 hrtimer_get_expires_ns(const struct hrtimer *timer)
249{
998adc3d 250 return ktime_to_ns(timer->node.expires);
63ca243b
AV
251}
252
253static inline ktime_t hrtimer_expires_remaining(const struct hrtimer *timer)
254{
998adc3d 255 return ktime_sub(timer->node.expires, timer->base->get_time());
63ca243b
AV
256}
257
54cdfdb4
TG
258#ifdef CONFIG_HIGH_RES_TIMERS
259struct clock_event_device;
260
54cdfdb4
TG
261extern void hrtimer_interrupt(struct clock_event_device *dev);
262
263/*
264 * In high resolution mode the time reference must be read accurate
265 */
266static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
267{
268 return timer->base->get_time();
269}
270
8f4d37ec
PZ
271static inline int hrtimer_is_hres_active(struct hrtimer *timer)
272{
273 return timer->base->cpu_base->hres_active;
274}
275
2075eb8d
AV
276extern void hrtimer_peek_ahead_timers(void);
277
54cdfdb4
TG
278/*
279 * The resolution of the clocks. The resolution value is returned in
280 * the clock_getres() system call to give application programmers an
281 * idea of the (in)accuracy of timers. Timer values are rounded up to
282 * this resolution values.
283 */
151db1fc
TB
284# define HIGH_RES_NSEC 1
285# define KTIME_HIGH_RES (ktime_t) { .tv64 = HIGH_RES_NSEC }
286# define MONOTONIC_RES_NSEC HIGH_RES_NSEC
54cdfdb4
TG
287# define KTIME_MONOTONIC_RES KTIME_HIGH_RES
288
289#else
290
151db1fc 291# define MONOTONIC_RES_NSEC LOW_RES_NSEC
54cdfdb4
TG
292# define KTIME_MONOTONIC_RES KTIME_LOW_RES
293
2075eb8d 294static inline void hrtimer_peek_ahead_timers(void) { }
54cdfdb4
TG
295
296/*
297 * In non high resolution mode the time reference is taken from
298 * the base softirq time variable.
299 */
300static inline ktime_t hrtimer_cb_get_time(struct hrtimer *timer)
301{
302 return timer->base->softirq_time;
303}
304
8f4d37ec
PZ
305static inline int hrtimer_is_hres_active(struct hrtimer *timer)
306{
307 return 0;
308}
54cdfdb4
TG
309#endif
310
b12a03ce 311extern void clock_was_set(void);
9ec26907
TG
312#ifdef CONFIG_TIMERFD
313extern void timerfd_clock_was_set(void);
314#else
315static inline void timerfd_clock_was_set(void) { }
316#endif
b12a03ce
TG
317extern void hrtimers_resume(void);
318
d316c57f
TG
319extern ktime_t ktime_get(void);
320extern ktime_t ktime_get_real(void);
abb3a4ea 321extern ktime_t ktime_get_boottime(void);
99ee5315 322extern ktime_t ktime_get_monotonic_offset(void);
becf8b5d 323
2e94d1f7 324DECLARE_PER_CPU(struct tick_device, tick_cpu_device);
2e94d1f7
AV
325
326
c0a31329
TG
327/* Exported timer functions: */
328
329/* Initialize timers: */
7978672c
GA
330extern void hrtimer_init(struct hrtimer *timer, clockid_t which_clock,
331 enum hrtimer_mode mode);
c0a31329 332
237fc6e7
TG
333#ifdef CONFIG_DEBUG_OBJECTS_TIMERS
334extern void hrtimer_init_on_stack(struct hrtimer *timer, clockid_t which_clock,
335 enum hrtimer_mode mode);
336
337extern void destroy_hrtimer_on_stack(struct hrtimer *timer);
338#else
339static inline void hrtimer_init_on_stack(struct hrtimer *timer,
340 clockid_t which_clock,
341 enum hrtimer_mode mode)
342{
343 hrtimer_init(timer, which_clock, mode);
344}
345static inline void destroy_hrtimer_on_stack(struct hrtimer *timer) { }
346#endif
347
c0a31329
TG
348/* Basic timer operations: */
349extern int hrtimer_start(struct hrtimer *timer, ktime_t tim,
350 const enum hrtimer_mode mode);
da8f2e17
AV
351extern int hrtimer_start_range_ns(struct hrtimer *timer, ktime_t tim,
352 unsigned long range_ns, const enum hrtimer_mode mode);
7f1e2ca9
PZ
353extern int
354__hrtimer_start_range_ns(struct hrtimer *timer, ktime_t tim,
355 unsigned long delta_ns,
356 const enum hrtimer_mode mode, int wakeup);
357
c0a31329
TG
358extern int hrtimer_cancel(struct hrtimer *timer);
359extern int hrtimer_try_to_cancel(struct hrtimer *timer);
360
63ca243b
AV
361static inline int hrtimer_start_expires(struct hrtimer *timer,
362 enum hrtimer_mode mode)
363{
da8f2e17
AV
364 unsigned long delta;
365 ktime_t soft, hard;
366 soft = hrtimer_get_softexpires(timer);
367 hard = hrtimer_get_expires(timer);
368 delta = ktime_to_ns(ktime_sub(hard, soft));
4ce105d3 369 return hrtimer_start_range_ns(timer, soft, delta, mode);
63ca243b
AV
370}
371
c9cb2e3d
TG
372static inline int hrtimer_restart(struct hrtimer *timer)
373{
654c8e0b 374 return hrtimer_start_expires(timer, HRTIMER_MODE_ABS);
c9cb2e3d 375}
c0a31329
TG
376
377/* Query timers: */
378extern ktime_t hrtimer_get_remaining(const struct hrtimer *timer);
379extern int hrtimer_get_res(const clockid_t which_clock, struct timespec *tp);
380
69239749 381extern ktime_t hrtimer_get_next_event(void);
69239749 382
303e967f 383/*
53370d2e
TG
384 * A timer is active, when it is enqueued into the rbtree or the
385 * callback function is running or it's in the state of being migrated
386 * to another cpu.
303e967f 387 */
c0a31329
TG
388static inline int hrtimer_active(const struct hrtimer *timer)
389{
303e967f 390 return timer->state != HRTIMER_STATE_INACTIVE;
c0a31329
TG
391}
392
54cdfdb4
TG
393/*
394 * Helper function to check, whether the timer is on one of the queues
395 */
396static inline int hrtimer_is_queued(struct hrtimer *timer)
397{
ca109491 398 return timer->state & HRTIMER_STATE_ENQUEUED;
54cdfdb4
TG
399}
400
4346f654
OH
401/*
402 * Helper function to check, whether the timer is running the callback
403 * function
404 */
405static inline int hrtimer_callback_running(struct hrtimer *timer)
406{
407 return timer->state & HRTIMER_STATE_CALLBACK;
408}
409
c0a31329 410/* Forward a hrtimer so it expires after now: */
4d672e7a 411extern u64
44f21475 412hrtimer_forward(struct hrtimer *timer, ktime_t now, ktime_t interval);
c0a31329 413
5e05ad7d 414/* Forward a hrtimer so it expires after the hrtimer's current now */
4d672e7a
DL
415static inline u64 hrtimer_forward_now(struct hrtimer *timer,
416 ktime_t interval)
5e05ad7d
DL
417{
418 return hrtimer_forward(timer, timer->base->get_time(), interval);
419}
420
10c94ec1
TG
421/* Precise sleep: */
422extern long hrtimer_nanosleep(struct timespec *rqtp,
080344b9 423 struct timespec __user *rmtp,
10c94ec1
TG
424 const enum hrtimer_mode mode,
425 const clockid_t clockid);
1711ef38 426extern long hrtimer_nanosleep_restart(struct restart_block *restart_block);
10c94ec1 427
00362e33
TG
428extern void hrtimer_init_sleeper(struct hrtimer_sleeper *sl,
429 struct task_struct *tsk);
430
654c8e0b
AV
431extern int schedule_hrtimeout_range(ktime_t *expires, unsigned long delta,
432 const enum hrtimer_mode mode);
351b3f7a
CE
433extern int schedule_hrtimeout_range_clock(ktime_t *expires,
434 unsigned long delta, const enum hrtimer_mode mode, int clock);
7bb67439
AV
435extern int schedule_hrtimeout(ktime_t *expires, const enum hrtimer_mode mode);
436
c0a31329
TG
437/* Soft interrupt function to run the hrtimer queues: */
438extern void hrtimer_run_queues(void);
d3d74453 439extern void hrtimer_run_pending(void);
c0a31329
TG
440
441/* Bootup initialization: */
442extern void __init hrtimers_init(void);
443
79bf2bb3 444#if BITS_PER_LONG < 64
4d672e7a 445extern u64 ktime_divns(const ktime_t kt, s64 div);
79bf2bb3 446#else /* BITS_PER_LONG < 64 */
4d672e7a 447# define ktime_divns(kt, div) (u64)((kt).tv64 / (div))
79bf2bb3
TG
448#endif
449
88ad0bf6
IM
450/* Show pending timers: */
451extern void sysrq_timer_list_show(void);
452
c0a31329 453#endif