0fadf95debe1f3a1b6415623926fc884fbc719ac
[linux-2.6.git] / include / linux / tick.h
1 /*  linux/include/linux/tick.h
2  *
3  *  This file contains the structure definitions for tick related functions
4  *
5  */
6 #ifndef _LINUX_TICK_H
7 #define _LINUX_TICK_H
8
9 #include <linux/clockchips.h>
10
11 #ifdef CONFIG_GENERIC_CLOCKEVENTS
12
13 enum tick_device_mode {
14         TICKDEV_MODE_PERIODIC,
15         TICKDEV_MODE_ONESHOT,
16 };
17
18 struct tick_device {
19         struct clock_event_device *evtdev;
20         enum tick_device_mode mode;
21 };
22
23 enum tick_nohz_mode {
24         NOHZ_MODE_INACTIVE,
25         NOHZ_MODE_LOWRES,
26         NOHZ_MODE_HIGHRES,
27 };
28
29 /**
30  * struct tick_sched - sched tick emulation and no idle tick control/stats
31  * @sched_timer:        hrtimer to schedule the periodic tick in high
32  *                      resolution mode
33  * @idle_tick:          Store the last idle tick expiry time when the tick
34  *                      timer is modified for idle sleeps. This is necessary
35  *                      to resume the tick timer operation in the timeline
36  *                      when the CPU returns from idle
37  * @tick_stopped:       Indicator that the idle tick has been stopped
38  * @idle_jiffies:       jiffies at the entry to idle for idle time accounting
39  * @idle_calls:         Total number of idle calls
40  * @idle_sleeps:        Number of idle calls, where the sched tick was stopped
41  * @idle_entrytime:     Time when the idle call was entered
42  * @idle_sleeptime:     Sum of the time slept in idle with sched tick stopped
43  * @sleep_length:       Duration of the current idle sleep
44  */
45 struct tick_sched {
46         struct hrtimer                  sched_timer;
47         unsigned long                   check_clocks;
48         enum tick_nohz_mode             nohz_mode;
49         ktime_t                         idle_tick;
50         int                             tick_stopped;
51         unsigned long                   idle_jiffies;
52         unsigned long                   idle_calls;
53         unsigned long                   idle_sleeps;
54         int                             idle_active;
55         ktime_t                         idle_entrytime;
56         ktime_t                         idle_sleeptime;
57         ktime_t                         idle_lastupdate;
58         ktime_t                         sleep_length;
59         unsigned long                   last_jiffies;
60         unsigned long                   next_jiffies;
61         ktime_t                         idle_expires;
62 };
63
64 extern void __init tick_init(void);
65 extern int tick_is_oneshot_available(void);
66 extern struct tick_device *tick_get_device(int cpu);
67
68 # ifdef CONFIG_HIGH_RES_TIMERS
69 extern int tick_init_highres(void);
70 extern int tick_program_event(ktime_t expires, int force);
71 extern void tick_setup_sched_timer(void);
72 extern void tick_cancel_sched_timer(int cpu);
73 # else
74 static inline void tick_cancel_sched_timer(int cpu) { }
75 # endif /* HIGHRES */
76
77 # ifdef CONFIG_GENERIC_CLOCKEVENTS_BROADCAST
78 extern struct tick_device *tick_get_broadcast_device(void);
79 extern cpumask_t *tick_get_broadcast_mask(void);
80
81 #  ifdef CONFIG_TICK_ONESHOT
82 extern cpumask_t *tick_get_broadcast_oneshot_mask(void);
83 #  endif
84
85 # endif /* BROADCAST */
86
87 # ifdef CONFIG_TICK_ONESHOT
88 extern void tick_clock_notify(void);
89 extern int tick_check_oneshot_change(int allow_nohz);
90 extern struct tick_sched *tick_get_tick_sched(int cpu);
91 # else
92 static inline void tick_clock_notify(void) { }
93 static inline int tick_check_oneshot_change(int allow_nohz) { return 0; }
94 # endif
95
96 #else /* CONFIG_GENERIC_CLOCKEVENTS */
97 static inline void tick_init(void) { }
98 static inline void tick_cancel_sched_timer(int cpu) { }
99 static inline void tick_clock_notify(void) { }
100 static inline int tick_check_oneshot_change(int allow_nohz) { return 0; }
101 #endif /* !CONFIG_GENERIC_CLOCKEVENTS */
102
103 # ifdef CONFIG_NO_HZ
104 extern void tick_nohz_stop_sched_tick(void);
105 extern void tick_nohz_restart_sched_tick(void);
106 extern void tick_nohz_update_jiffies(void);
107 extern ktime_t tick_nohz_get_sleep_length(void);
108 extern void tick_nohz_stop_idle(int cpu);
109 extern u64 get_cpu_idle_time_us(int cpu, u64 *last_update_time);
110 # else
111 static inline void tick_nohz_stop_sched_tick(void) { }
112 static inline void tick_nohz_restart_sched_tick(void) { }
113 static inline void tick_nohz_update_jiffies(void) { }
114 static inline ktime_t tick_nohz_get_sleep_length(void)
115 {
116         ktime_t len = { .tv64 = NSEC_PER_SEC/HZ };
117
118         return len;
119 }
120 static inline void tick_nohz_stop_idle(int cpu) { }
121 static inline u64 get_cpu_idle_time_us(int cpu, u64 *unused) { return 0; }
122 # endif /* !NO_HZ */
123
124 #endif