[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / linux / timer.h

#ifndef _LINUX_TIMER_H
#define _LINUX_TIMER_H

#include <linux/list.h>
#include <linux/ktime.h>
#include <linux/stddef.h>
#include <linux/debugobjects.h>
#include <linux/stringify.h>

struct tvec_base;

struct timer_list {
	/*
	 * All fields that change during normal runtime grouped to the
	 * same cacheline
	 */
	struct list_head entry;
	unsigned long expires;
	struct tvec_base *base;

	void (*function)(unsigned long);
	unsigned long data;

	int slack;

#ifdef CONFIG_TIMER_STATS
	int start_pid;
	void *start_site;
	char start_comm[16];
#endif
#ifdef CONFIG_LOCKDEP
	struct lockdep_map lockdep_map;
#endif
};

extern struct tvec_base boot_tvec_bases;

#ifdef CONFIG_LOCKDEP
/*
 * NB: because we have to copy the lockdep_map, setting the lockdep_map key
 * (second argument) here is required, otherwise it could be initialised to
 * the copy of the lockdep_map later! We use the pointer to and the string
 * "<file>:<line>" as the key resp. the name of the lockdep_map.
 */
#define __TIMER_LOCKDEP_MAP_INITIALIZER(_kn)				\
	.lockdep_map = STATIC_LOCKDEP_MAP_INIT(_kn, &_kn),
#else
#define __TIMER_LOCKDEP_MAP_INITIALIZER(_kn)
#endif

/*
 * Note that all tvec_bases are 2 byte aligned and lower bit of
 * base in timer_list is guaranteed to be zero. Use the LSB to
 * indicate whether the timer is deferrable.
 *
 * A deferrable timer will work normally when the system is busy, but
 * will not cause a CPU to come out of idle just to service it; instead,
 * the timer will be serviced when the CPU eventually wakes up with a
 * subsequent non-deferrable timer.
 */
#define TIMER_DEFERRABLE		0x1LU

#define TIMER_FLAG_MASK			0x1LU

#define TIMER_INITIALIZER(_function, _expires, _data) {		\
		.entry = { .prev = TIMER_ENTRY_STATIC },	\
		.function = (_function),			\
		.expires = (_expires),				\
		.data = (_data),				\
		.base = &boot_tvec_bases,			\
		.slack = -1,					\
		__TIMER_LOCKDEP_MAP_INITIALIZER(		\
			__FILE__ ":" __stringify(__LINE__))	\
	}

#define TBASE_MAKE_DEFERRED(ptr) ((struct tvec_base *)		\
		  ((unsigned char *)(ptr) + TIMER_DEFERRABLE))

#define TIMER_DEFERRED_INITIALIZER(_function, _expires, _data) {\
		.entry = { .prev = TIMER_ENTRY_STATIC },	\
		.function = (_function),			\
		.expires = (_expires),				\
		.data = (_data),				\
		.base = TBASE_MAKE_DEFERRED(&boot_tvec_bases),	\
		__TIMER_LOCKDEP_MAP_INITIALIZER(		\
			__FILE__ ":" __stringify(__LINE__))	\
	}

#define DEFINE_TIMER(_name, _function, _expires, _data)		\
	struct timer_list _name =				\
		TIMER_INITIALIZER(_function, _expires, _data)

void init_timer_key(struct timer_list *timer,
		    const char *name,
		    struct lock_class_key *key);
void init_timer_deferrable_key(struct timer_list *timer,
			       const char *name,
			       struct lock_class_key *key);

#ifdef CONFIG_LOCKDEP
#define init_timer(timer)						\
	do {								\
		static struct lock_class_key __key;			\
		init_timer_key((timer), #timer, &__key);		\
	} while (0)

#define init_timer_deferrable(timer)					\
	do {								\
		static struct lock_class_key __key;			\
		init_timer_deferrable_key((timer), #timer, &__key);	\
	} while (0)

#define init_timer_on_stack(timer)					\
	do {								\
		static struct lock_class_key __key;			\
		init_timer_on_stack_key((timer), #timer, &__key);	\
	} while (0)

#define setup_timer(timer, fn, data)					\
	do {								\
		static struct lock_class_key __key;			\
		setup_timer_key((timer), #timer, &__key, (fn), (data));\
	} while (0)

#define setup_timer_on_stack(timer, fn, data)				\
	do {								\
		static struct lock_class_key __key;			\
		setup_timer_on_stack_key((timer), #timer, &__key,	\
					 (fn), (data));			\
	} while (0)
#define setup_deferrable_timer_on_stack(timer, fn, data)		\
	do {								\
		static struct lock_class_key __key;			\
		setup_deferrable_timer_on_stack_key((timer), #timer,	\
						    &__key, (fn),	\
						    (data));		\
	} while (0)
#else
#define init_timer(timer)\
	init_timer_key((timer), NULL, NULL)
#define init_timer_deferrable(timer)\
	init_timer_deferrable_key((timer), NULL, NULL)
#define init_timer_on_stack(timer)\
	init_timer_on_stack_key((timer), NULL, NULL)
#define setup_timer(timer, fn, data)\
	setup_timer_key((timer), NULL, NULL, (fn), (data))
#define setup_timer_on_stack(timer, fn, data)\
	setup_timer_on_stack_key((timer), NULL, NULL, (fn), (data))
#define setup_deferrable_timer_on_stack(timer, fn, data)\
	setup_deferrable_timer_on_stack_key((timer), NULL, NULL, (fn), (data))
#endif

#ifdef CONFIG_DEBUG_OBJECTS_TIMERS
extern void init_timer_on_stack_key(struct timer_list *timer,
				    const char *name,
				    struct lock_class_key *key);
extern void destroy_timer_on_stack(struct timer_list *timer);
#else
static inline void destroy_timer_on_stack(struct timer_list *timer) { }
static inline void init_timer_on_stack_key(struct timer_list *timer,
					   const char *name,
					   struct lock_class_key *key)
{
	init_timer_key(timer, name, key);
}
#endif

static inline void setup_timer_key(struct timer_list * timer,
				const char *name,
				struct lock_class_key *key,
				void (*function)(unsigned long),
				unsigned long data)
{
	timer->function = function;
	timer->data = data;
	init_timer_key(timer, name, key);
}

static inline void setup_timer_on_stack_key(struct timer_list *timer,
					const char *name,
					struct lock_class_key *key,
					void (*function)(unsigned long),
					unsigned long data)
{
	timer->function = function;
	timer->data = data;
	init_timer_on_stack_key(timer, name, key);
}

extern void setup_deferrable_timer_on_stack_key(struct timer_list *timer,
						const char *name,
						struct lock_class_key *key,
						void (*function)(unsigned long),
						unsigned long data);

/**
 * timer_pending - is a timer pending?
 * @timer: the timer in question
 *
 * timer_pending will tell whether a given timer is currently pending,
 * or not. Callers must ensure serialization wrt. other operations done
 * to this timer, eg. interrupt contexts, or other CPUs on SMP.
 *
 * return value: 1 if the timer is pending, 0 if not.
 */
static inline int timer_pending(const struct timer_list * timer)
{
	return timer->entry.next != NULL;
}

extern void add_timer_on(struct timer_list *timer, int cpu);
extern int del_timer(struct timer_list * timer);
extern int mod_timer(struct timer_list *timer, unsigned long expires);
extern int mod_timer_pending(struct timer_list *timer, unsigned long expires);
extern int mod_timer_pinned(struct timer_list *timer, unsigned long expires);

extern void set_timer_slack(struct timer_list *time, int slack_hz);

#define TIMER_NOT_PINNED	0
#define TIMER_PINNED		1
/*
 * The jiffies value which is added to now, when there is no timer
 * in the timer wheel:
 */
#define NEXT_TIMER_MAX_DELTA	((1UL << 30) - 1)

/*
 * Return when the next timer-wheel timeout occurs (in absolute jiffies),
 * locks the timer base and does the comparison against the given
 * jiffie.
 */
extern unsigned long get_next_timer_interrupt(unsigned long now);

/*
 * Timer-statistics info:
 */
#ifdef CONFIG_TIMER_STATS

extern int timer_stats_active;

#define TIMER_STATS_FLAG_DEFERRABLE	0x1

extern void init_timer_stats(void);

extern void timer_stats_update_stats(void *timer, pid_t pid, void *startf,
				     void *timerf, char *comm,
				     unsigned int timer_flag);

extern void __timer_stats_timer_set_start_info(struct timer_list *timer,
					       void *addr);

static inline void timer_stats_timer_set_start_info(struct timer_list *timer)
{
	if (likely(!timer_stats_active))
		return;
	__timer_stats_timer_set_start_info(timer, __builtin_return_address(0));
}

static inline void timer_stats_timer_clear_start_info(struct timer_list *timer)
{
	timer->start_site = NULL;
}
#else
static inline void init_timer_stats(void)
{
}

static inline void timer_stats_timer_set_start_info(struct timer_list *timer)
{
}

static inline void timer_stats_timer_clear_start_info(struct timer_list *timer)
{
}
#endif

extern void add_timer(struct timer_list *timer);

extern int try_to_del_timer_sync(struct timer_list *timer);

#ifdef CONFIG_SMP
  extern int del_timer_sync(struct timer_list *timer);
#else
# define del_timer_sync(t)		del_timer(t)
#endif

#define del_singleshot_timer_sync(t) del_timer_sync(t)

extern void init_timers(void);
extern void run_local_timers(void);
struct hrtimer;
extern enum hrtimer_restart it_real_fn(struct hrtimer *);

unsigned long __round_jiffies(unsigned long j, int cpu);
unsigned long __round_jiffies_relative(unsigned long j, int cpu);
unsigned long round_jiffies(unsigned long j);
unsigned long round_jiffies_relative(unsigned long j);

unsigned long __round_jiffies_up(unsigned long j, int cpu);
unsigned long __round_jiffies_up_relative(unsigned long j, int cpu);
unsigned long round_jiffies_up(unsigned long j);
unsigned long round_jiffies_up_relative(unsigned long j);

#endif
Commit	Line	Data
1da177e4 LT	1	#ifndef _LINUX_TIMER_H
	2	#define _LINUX_TIMER_H
	3
1da177e4	4	#include <linux/list.h>
82f67cd9	5	#include <linux/ktime.h>
1da177e4	6	#include <linux/stddef.h>
c6f3a97f	7	#include <linux/debugobjects.h>
6f2b9b9a	8	#include <linux/stringify.h>
1da177e4	9
a6fa8e5a	10	struct tvec_base;
1da177e4 LT	11
1da177e4 LT	12	struct timer_list {
3bbb9ec9 AV	13	/*
	14	* All fields that change during normal runtime grouped to the
	15	* same cacheline
	16	*/
1da177e4 LT	17	struct list_head entry;
1da177e4 LT	18	unsigned long expires;
3bbb9ec9	19	struct tvec_base *base;
1da177e4	20
1da177e4 LT	21	void (*function)(unsigned long);
	22	unsigned long data;
	23
3bbb9ec9 AV	24	int slack;
3bbb9ec9 AV	25
82f67cd9	26	#ifdef CONFIG_TIMER_STATS
d0959024	27	int start_pid;
82f67cd9 IM	28	void *start_site;
82f67cd9 IM	29	char start_comm[16];
82f67cd9	30	#endif
6f2b9b9a JB	31	#ifdef CONFIG_LOCKDEP
	32	struct lockdep_map lockdep_map;
	33	#endif
1da177e4 LT	34	};
1da177e4 LT	35
a6fa8e5a	36	extern struct tvec_base boot_tvec_bases;
55c888d6	37
6f2b9b9a JB	38	#ifdef CONFIG_LOCKDEP
	39	/*
	40	* NB: because we have to copy the lockdep_map, setting the lockdep_map key
	41	* (second argument) here is required, otherwise it could be initialised to
	42	* the copy of the lockdep_map later! We use the pointer to and the string
	43	* "<file>:<line>" as the key resp. the name of the lockdep_map.
	44	*/
	45	#define __TIMER_LOCKDEP_MAP_INITIALIZER(_kn) \
	46	.lockdep_map = STATIC_LOCKDEP_MAP_INIT(_kn, &_kn),
	47	#else
	48	#define __TIMER_LOCKDEP_MAP_INITIALIZER(_kn)
	49	#endif
	50
dd6414b5 PC	51	/*
	52	* Note that all tvec_bases are 2 byte aligned and lower bit of
	53	* base in timer_list is guaranteed to be zero. Use the LSB to
	54	* indicate whether the timer is deferrable.
	55	*
	56	* A deferrable timer will work normally when the system is busy, but
	57	* will not cause a CPU to come out of idle just to service it; instead,
	58	* the timer will be serviced when the CPU eventually wakes up with a
	59	* subsequent non-deferrable timer.
	60	*/
e52b1db3 TH	61	#define TIMER_DEFERRABLE 0x1LU
	62
	63	#define TIMER_FLAG_MASK 0x1LU
dd6414b5	64
1da177e4	65	#define TIMER_INITIALIZER(_function, _expires, _data) { \
c6f3a97f	66	.entry = { .prev = TIMER_ENTRY_STATIC }, \
1da177e4 LT	67	.function = (_function), \
	68	.expires = (_expires), \
	69	.data = (_data), \
3691c519	70	.base = &boot_tvec_bases, \
aaabe31c	71	.slack = -1, \
6f2b9b9a JB	72	__TIMER_LOCKDEP_MAP_INITIALIZER( \
6f2b9b9a JB	73	__FILE__ ":" __stringify(__LINE__)) \
1da177e4 LT	74	}
1da177e4 LT	75
dd6414b5	76	#define TBASE_MAKE_DEFERRED(ptr) ((struct tvec_base *) \
e52b1db3	77	((unsigned char *)(ptr) + TIMER_DEFERRABLE))
dd6414b5 PC	78
	79	#define TIMER_DEFERRED_INITIALIZER(_function, _expires, _data) {\
	80	.entry = { .prev = TIMER_ENTRY_STATIC }, \
	81	.function = (_function), \
	82	.expires = (_expires), \
	83	.data = (_data), \
	84	.base = TBASE_MAKE_DEFERRED(&boot_tvec_bases), \
	85	__TIMER_LOCKDEP_MAP_INITIALIZER( \
	86	__FILE__ ":" __stringify(__LINE__)) \
	87	}
	88
8d06afab IM	89	#define DEFINE_TIMER(_name, _function, _expires, _data) \
	90	struct timer_list _name = \
	91	TIMER_INITIALIZER(_function, _expires, _data)
	92
6f2b9b9a JB	93	void init_timer_key(struct timer_list *timer,
	94	const char *name,
	95	struct lock_class_key *key);
	96	void init_timer_deferrable_key(struct timer_list *timer,
	97	const char *name,
	98	struct lock_class_key *key);
	99
	100	#ifdef CONFIG_LOCKDEP
	101	#define init_timer(timer) \
	102	do { \
	103	static struct lock_class_key __key; \
	104	init_timer_key((timer), #timer, &__key); \
	105	} while (0)
	106
	107	#define init_timer_deferrable(timer) \
	108	do { \
	109	static struct lock_class_key __key; \
	110	init_timer_deferrable_key((timer), #timer, &__key); \
	111	} while (0)
	112
	113	#define init_timer_on_stack(timer) \
	114	do { \
	115	static struct lock_class_key __key; \
	116	init_timer_on_stack_key((timer), #timer, &__key); \
	117	} while (0)
	118
	119	#define setup_timer(timer, fn, data) \
	120	do { \
	121	static struct lock_class_key __key; \
	122	setup_timer_key((timer), #timer, &__key, (fn), (data));\
	123	} while (0)
	124
	125	#define setup_timer_on_stack(timer, fn, data) \
	126	do { \
	127	static struct lock_class_key __key; \
	128	setup_timer_on_stack_key((timer), #timer, &__key, \
	129	(fn), (data)); \
	130	} while (0)
8cadd283 JB	131	#define setup_deferrable_timer_on_stack(timer, fn, data) \
	132	do { \
	133	static struct lock_class_key __key; \
	134	setup_deferrable_timer_on_stack_key((timer), #timer, \
	135	&__key, (fn), \
	136	(data)); \
	137	} while (0)
6f2b9b9a JB	138	#else
	139	#define init_timer(timer)\
	140	init_timer_key((timer), NULL, NULL)
	141	#define init_timer_deferrable(timer)\
	142	init_timer_deferrable_key((timer), NULL, NULL)
	143	#define init_timer_on_stack(timer)\
	144	init_timer_on_stack_key((timer), NULL, NULL)
	145	#define setup_timer(timer, fn, data)\
	146	setup_timer_key((timer), NULL, NULL, (fn), (data))
	147	#define setup_timer_on_stack(timer, fn, data)\
	148	setup_timer_on_stack_key((timer), NULL, NULL, (fn), (data))
8cadd283 JB	149	#define setup_deferrable_timer_on_stack(timer, fn, data)\
8cadd283 JB	150	setup_deferrable_timer_on_stack_key((timer), NULL, NULL, (fn), (data))
6f2b9b9a	151	#endif
1da177e4	152
c6f3a97f	153	#ifdef CONFIG_DEBUG_OBJECTS_TIMERS
6f2b9b9a JB	154	extern void init_timer_on_stack_key(struct timer_list *timer,
	155	const char *name,
	156	struct lock_class_key *key);
c6f3a97f TG	157	extern void destroy_timer_on_stack(struct timer_list *timer);
	158	#else
	159	static inline void destroy_timer_on_stack(struct timer_list *timer) { }
6f2b9b9a JB	160	static inline void init_timer_on_stack_key(struct timer_list *timer,
	161	const char *name,
	162	struct lock_class_key *key)
c6f3a97f	163	{
6f2b9b9a	164	init_timer_key(timer, name, key);
c6f3a97f TG	165	}
	166	#endif
	167
6f2b9b9a JB	168	static inline void setup_timer_key(struct timer_list * timer,
	169	const char *name,
	170	struct lock_class_key *key,
a8db2db1 ON	171	void (*function)(unsigned long),
	172	unsigned long data)
	173	{
	174	timer->function = function;
	175	timer->data = data;
6f2b9b9a	176	init_timer_key(timer, name, key);
a8db2db1 ON	177	}
a8db2db1 ON	178
6f2b9b9a JB	179	static inline void setup_timer_on_stack_key(struct timer_list *timer,
	180	const char *name,
	181	struct lock_class_key *key,
c6f3a97f TG	182	void (*function)(unsigned long),
	183	unsigned long data)
	184	{
	185	timer->function = function;
	186	timer->data = data;
6f2b9b9a	187	init_timer_on_stack_key(timer, name, key);
c6f3a97f TG	188	}
c6f3a97f TG	189
8cadd283 JB	190	extern void setup_deferrable_timer_on_stack_key(struct timer_list *timer,
	191	const char *name,
	192	struct lock_class_key *key,
	193	void (*function)(unsigned long),
	194	unsigned long data);
	195
45f8bde0	196	/**
1da177e4 LT	197	* timer_pending - is a timer pending?
	198	* @timer: the timer in question
	199	*
	200	* timer_pending will tell whether a given timer is currently pending,
	201	* or not. Callers must ensure serialization wrt. other operations done
	202	* to this timer, eg. interrupt contexts, or other CPUs on SMP.
	203	*
	204	* return value: 1 if the timer is pending, 0 if not.
	205	*/
	206	static inline int timer_pending(const struct timer_list * timer)
	207	{
55c888d6	208	return timer->entry.next != NULL;
1da177e4 LT	209	}
	210
	211	extern void add_timer_on(struct timer_list *timer, int cpu);
	212	extern int del_timer(struct timer_list * timer);
1da177e4	213	extern int mod_timer(struct timer_list *timer, unsigned long expires);
74019224	214	extern int mod_timer_pending(struct timer_list *timer, unsigned long expires);
597d0275	215	extern int mod_timer_pinned(struct timer_list *timer, unsigned long expires);
1da177e4	216
3bbb9ec9 AV	217	extern void set_timer_slack(struct timer_list *time, int slack_hz);
3bbb9ec9 AV	218
597d0275 AB	219	#define TIMER_NOT_PINNED 0
597d0275 AB	220	#define TIMER_PINNED 1
eaad084b TG	221	/*
	222	* The jiffies value which is added to now, when there is no timer
	223	* in the timer wheel:
	224	*/
	225	#define NEXT_TIMER_MAX_DELTA ((1UL << 30) - 1)
	226
fd064b9b TG	227	/*
	228	* Return when the next timer-wheel timeout occurs (in absolute jiffies),
	229	* locks the timer base and does the comparison against the given
	230	* jiffie.
	231	*/
	232	extern unsigned long get_next_timer_interrupt(unsigned long now);
1da177e4	233
82f67cd9 IM	234	/*
	235	* Timer-statistics info:
	236	*/
	237	#ifdef CONFIG_TIMER_STATS
	238
507e1231 HC	239	extern int timer_stats_active;
507e1231 HC	240
c5c061b8 VP	241	#define TIMER_STATS_FLAG_DEFERRABLE 0x1
c5c061b8 VP	242
82f67cd9 IM	243	extern void init_timer_stats(void);
	244
	245	extern void timer_stats_update_stats(void timer, pid_t pid, void startf,
c5c061b8 VP	246	void timerf, char comm,
c5c061b8 VP	247	unsigned int timer_flag);
82f67cd9 IM	248
	249	extern void __timer_stats_timer_set_start_info(struct timer_list *timer,
	250	void *addr);
	251
	252	static inline void timer_stats_timer_set_start_info(struct timer_list *timer)
	253	{
507e1231 HC	254	if (likely(!timer_stats_active))
507e1231 HC	255	return;
82f67cd9 IM	256	__timer_stats_timer_set_start_info(timer, __builtin_return_address(0));
	257	}
	258
	259	static inline void timer_stats_timer_clear_start_info(struct timer_list *timer)
	260	{
	261	timer->start_site = NULL;
	262	}
	263	#else
	264	static inline void init_timer_stats(void)
	265	{
	266	}
	267
82f67cd9 IM	268	static inline void timer_stats_timer_set_start_info(struct timer_list *timer)
	269	{
	270	}
	271
	272	static inline void timer_stats_timer_clear_start_info(struct timer_list *timer)
	273	{
	274	}
	275	#endif
	276
74019224	277	extern void add_timer(struct timer_list *timer);
1da177e4	278
6f1bc451 YZ	279	extern int try_to_del_timer_sync(struct timer_list *timer);
6f1bc451 YZ	280
1da177e4 LT	281	#ifdef CONFIG_SMP
1da177e4 LT	282	extern int del_timer_sync(struct timer_list *timer);
1da177e4	283	#else
fd450b73	284	# define del_timer_sync(t) del_timer(t)
1da177e4 LT	285	#endif
1da177e4 LT	286
55c888d6 ON	287	#define del_singleshot_timer_sync(t) del_timer_sync(t)
55c888d6 ON	288
1da177e4 LT	289	extern void init_timers(void);
1da177e4 LT	290	extern void run_local_timers(void);
05cfb614	291	struct hrtimer;
c9cb2e3d	292	extern enum hrtimer_restart it_real_fn(struct hrtimer *);
1da177e4	293
4c36a5de AV	294	unsigned long __round_jiffies(unsigned long j, int cpu);
	295	unsigned long __round_jiffies_relative(unsigned long j, int cpu);
	296	unsigned long round_jiffies(unsigned long j);
	297	unsigned long round_jiffies_relative(unsigned long j);
	298
9c133c46 AS	299	unsigned long __round_jiffies_up(unsigned long j, int cpu);
	300	unsigned long __round_jiffies_up_relative(unsigned long j, int cpu);
	301	unsigned long round_jiffies_up(unsigned long j);
	302	unsigned long round_jiffies_up_relative(unsigned long j);
	303
1da177e4	304	#endif