time: Correct the *settime* parameters
[linux-2.6.git] / kernel / time / tick-common.c
1 /*
2  * linux/kernel/time/tick-common.c
3  *
4  * This file contains the base functions to manage periodic tick
5  * related events.
6  *
7  * Copyright(C) 2005-2006, Thomas Gleixner <tglx@linutronix.de>
8  * Copyright(C) 2005-2007, Red Hat, Inc., Ingo Molnar
9  * Copyright(C) 2006-2007, Timesys Corp., Thomas Gleixner
10  *
11  * This code is licenced under the GPL version 2. For details see
12  * kernel-base/COPYING.
13  */
14 #include <linux/cpu.h>
15 #include <linux/err.h>
16 #include <linux/hrtimer.h>
17 #include <linux/interrupt.h>
18 #include <linux/percpu.h>
19 #include <linux/profile.h>
20 #include <linux/sched.h>
21
22 #include <asm/irq_regs.h>
23
24 #include "tick-internal.h"
25
26 /*
27  * Tick devices
28  */
29 DEFINE_PER_CPU(struct tick_device, tick_cpu_device);
30 /*
31  * Tick next event: keeps track of the tick time
32  */
33 ktime_t tick_next_period;
34 ktime_t tick_period;
35 int tick_do_timer_cpu __read_mostly = TICK_DO_TIMER_BOOT;
36 static DEFINE_RAW_SPINLOCK(tick_device_lock);
37
38 /*
39  * Debugging: see timer_list.c
40  */
41 struct tick_device *tick_get_device(int cpu)
42 {
43         return &per_cpu(tick_cpu_device, cpu);
44 }
45
46 /**
47  * tick_is_oneshot_available - check for a oneshot capable event device
48  */
49 int tick_is_oneshot_available(void)
50 {
51         struct clock_event_device *dev = __this_cpu_read(tick_cpu_device.evtdev);
52
53         return dev && (dev->features & CLOCK_EVT_FEAT_ONESHOT);
54 }
55
56 /*
57  * Periodic tick
58  */
59 static void tick_periodic(int cpu)
60 {
61         if (tick_do_timer_cpu == cpu) {
62                 write_seqlock(&xtime_lock);
63
64                 /* Keep track of the next tick event */
65                 tick_next_period = ktime_add(tick_next_period, tick_period);
66
67                 do_timer(1);
68                 write_sequnlock(&xtime_lock);
69         }
70
71         update_process_times(user_mode(get_irq_regs()));
72         profile_tick(CPU_PROFILING);
73 }
74
75 /*
76  * Event handler for periodic ticks
77  */
78 void tick_handle_periodic(struct clock_event_device *dev)
79 {
80         int cpu = smp_processor_id();
81         ktime_t next;
82
83         tick_periodic(cpu);
84
85         if (dev->mode != CLOCK_EVT_MODE_ONESHOT)
86                 return;
87         /*
88          * Setup the next period for devices, which do not have
89          * periodic mode:
90          */
91         next = ktime_add(dev->next_event, tick_period);
92         for (;;) {
93                 if (!clockevents_program_event(dev, next, ktime_get()))
94                         return;
95                 /*
96                  * Have to be careful here. If we're in oneshot mode,
97                  * before we call tick_periodic() in a loop, we need
98                  * to be sure we're using a real hardware clocksource.
99                  * Otherwise we could get trapped in an infinite
100                  * loop, as the tick_periodic() increments jiffies,
101                  * when then will increment time, posibly causing
102                  * the loop to trigger again and again.
103                  */
104                 if (timekeeping_valid_for_hres())
105                         tick_periodic(cpu);
106                 next = ktime_add(next, tick_period);
107         }
108 }
109
110 /*
111  * Setup the device for a periodic tick
112  */
113 void tick_setup_periodic(struct clock_event_device *dev, int broadcast)
114 {
115         tick_set_periodic_handler(dev, broadcast);
116
117         /* Broadcast setup ? */
118         if (!tick_device_is_functional(dev))
119                 return;
120
121         if ((dev->features & CLOCK_EVT_FEAT_PERIODIC) &&
122             !tick_broadcast_oneshot_active()) {
123                 clockevents_set_mode(dev, CLOCK_EVT_MODE_PERIODIC);
124         } else {
125                 unsigned long seq;
126                 ktime_t next;
127
128                 do {
129                         seq = read_seqbegin(&xtime_lock);
130                         next = tick_next_period;
131                 } while (read_seqretry(&xtime_lock, seq));
132
133                 clockevents_set_mode(dev, CLOCK_EVT_MODE_ONESHOT);
134
135                 for (;;) {
136                         if (!clockevents_program_event(dev, next, ktime_get()))
137                                 return;
138                         next = ktime_add(next, tick_period);
139                 }
140         }
141 }
142
143 /*
144  * Setup the tick device
145  */
146 static void tick_setup_device(struct tick_device *td,
147                               struct clock_event_device *newdev, int cpu,
148                               const struct cpumask *cpumask)
149 {
150         ktime_t next_event;
151         void (*handler)(struct clock_event_device *) = NULL;
152
153         /*
154          * First device setup ?
155          */
156         if (!td->evtdev) {
157                 /*
158                  * If no cpu took the do_timer update, assign it to
159                  * this cpu:
160                  */
161                 if (tick_do_timer_cpu == TICK_DO_TIMER_BOOT) {
162                         tick_do_timer_cpu = cpu;
163                         tick_next_period = ktime_get();
164                         tick_period = ktime_set(0, NSEC_PER_SEC / HZ);
165                 }
166
167                 /*
168                  * Startup in periodic mode first.
169                  */
170                 td->mode = TICKDEV_MODE_PERIODIC;
171         } else {
172                 handler = td->evtdev->event_handler;
173                 next_event = td->evtdev->next_event;
174                 td->evtdev->event_handler = clockevents_handle_noop;
175         }
176
177         td->evtdev = newdev;
178
179         /*
180          * When the device is not per cpu, pin the interrupt to the
181          * current cpu:
182          */
183         if (!cpumask_equal(newdev->cpumask, cpumask))
184                 irq_set_affinity(newdev->irq, cpumask);
185
186         /*
187          * When global broadcasting is active, check if the current
188          * device is registered as a placeholder for broadcast mode.
189          * This allows us to handle this x86 misfeature in a generic
190          * way.
191          */
192         if (tick_device_uses_broadcast(newdev, cpu))
193                 return;
194
195         if (td->mode == TICKDEV_MODE_PERIODIC)
196                 tick_setup_periodic(newdev, 0);
197         else
198                 tick_setup_oneshot(newdev, handler, next_event);
199 }
200
201 /*
202  * Check, if the new registered device should be used.
203  */
204 static int tick_check_new_device(struct clock_event_device *newdev)
205 {
206         struct clock_event_device *curdev;
207         struct tick_device *td;
208         int cpu, ret = NOTIFY_OK;
209         unsigned long flags;
210
211         raw_spin_lock_irqsave(&tick_device_lock, flags);
212
213         cpu = smp_processor_id();
214         if (!cpumask_test_cpu(cpu, newdev->cpumask))
215                 goto out_bc;
216
217         td = &per_cpu(tick_cpu_device, cpu);
218         curdev = td->evtdev;
219
220         /* cpu local device ? */
221         if (!cpumask_equal(newdev->cpumask, cpumask_of(cpu))) {
222
223                 /*
224                  * If the cpu affinity of the device interrupt can not
225                  * be set, ignore it.
226                  */
227                 if (!irq_can_set_affinity(newdev->irq))
228                         goto out_bc;
229
230                 /*
231                  * If we have a cpu local device already, do not replace it
232                  * by a non cpu local device
233                  */
234                 if (curdev && cpumask_equal(curdev->cpumask, cpumask_of(cpu)))
235                         goto out_bc;
236         }
237
238         /*
239          * If we have an active device, then check the rating and the oneshot
240          * feature.
241          */
242         if (curdev) {
243                 /*
244                  * Prefer one shot capable devices !
245                  */
246                 if ((curdev->features & CLOCK_EVT_FEAT_ONESHOT) &&
247                     !(newdev->features & CLOCK_EVT_FEAT_ONESHOT))
248                         goto out_bc;
249                 /*
250                  * Check the rating
251                  */
252                 if (curdev->rating >= newdev->rating)
253                         goto out_bc;
254         }
255
256         /*
257          * Replace the eventually existing device by the new
258          * device. If the current device is the broadcast device, do
259          * not give it back to the clockevents layer !
260          */
261         if (tick_is_broadcast_device(curdev)) {
262                 clockevents_shutdown(curdev);
263                 curdev = NULL;
264         }
265         clockevents_exchange_device(curdev, newdev);
266         tick_setup_device(td, newdev, cpu, cpumask_of(cpu));
267         if (newdev->features & CLOCK_EVT_FEAT_ONESHOT)
268                 tick_oneshot_notify();
269
270         raw_spin_unlock_irqrestore(&tick_device_lock, flags);
271         return NOTIFY_STOP;
272
273 out_bc:
274         /*
275          * Can the new device be used as a broadcast device ?
276          */
277         if (tick_check_broadcast_device(newdev))
278                 ret = NOTIFY_STOP;
279
280         raw_spin_unlock_irqrestore(&tick_device_lock, flags);
281
282         return ret;
283 }
284
285 /*
286  * Transfer the do_timer job away from a dying cpu.
287  *
288  * Called with interrupts disabled.
289  */
290 static void tick_handover_do_timer(int *cpup)
291 {
292         if (*cpup == tick_do_timer_cpu) {
293                 int cpu = cpumask_first(cpu_online_mask);
294
295                 tick_do_timer_cpu = (cpu < nr_cpu_ids) ? cpu :
296                         TICK_DO_TIMER_NONE;
297         }
298 }
299
300 /*
301  * Shutdown an event device on a given cpu:
302  *
303  * This is called on a life CPU, when a CPU is dead. So we cannot
304  * access the hardware device itself.
305  * We just set the mode and remove it from the lists.
306  */
307 static void tick_shutdown(unsigned int *cpup)
308 {
309         struct tick_device *td = &per_cpu(tick_cpu_device, *cpup);
310         struct clock_event_device *dev = td->evtdev;
311         unsigned long flags;
312
313         raw_spin_lock_irqsave(&tick_device_lock, flags);
314         td->mode = TICKDEV_MODE_PERIODIC;
315         if (dev) {
316                 /*
317                  * Prevent that the clock events layer tries to call
318                  * the set mode function!
319                  */
320                 dev->mode = CLOCK_EVT_MODE_UNUSED;
321                 clockevents_exchange_device(dev, NULL);
322                 td->evtdev = NULL;
323         }
324         raw_spin_unlock_irqrestore(&tick_device_lock, flags);
325 }
326
327 static void tick_suspend(void)
328 {
329         struct tick_device *td = &__get_cpu_var(tick_cpu_device);
330         unsigned long flags;
331
332         raw_spin_lock_irqsave(&tick_device_lock, flags);
333         clockevents_shutdown(td->evtdev);
334         raw_spin_unlock_irqrestore(&tick_device_lock, flags);
335 }
336
337 static void tick_resume(void)
338 {
339         struct tick_device *td = &__get_cpu_var(tick_cpu_device);
340         unsigned long flags;
341         int broadcast = tick_resume_broadcast();
342
343         raw_spin_lock_irqsave(&tick_device_lock, flags);
344         clockevents_set_mode(td->evtdev, CLOCK_EVT_MODE_RESUME);
345
346         if (!broadcast) {
347                 if (td->mode == TICKDEV_MODE_PERIODIC)
348                         tick_setup_periodic(td->evtdev, 0);
349                 else
350                         tick_resume_oneshot();
351         }
352         raw_spin_unlock_irqrestore(&tick_device_lock, flags);
353 }
354
355 /*
356  * Notification about clock event devices
357  */
358 static int tick_notify(struct notifier_block *nb, unsigned long reason,
359                                void *dev)
360 {
361         switch (reason) {
362
363         case CLOCK_EVT_NOTIFY_ADD:
364                 return tick_check_new_device(dev);
365
366         case CLOCK_EVT_NOTIFY_BROADCAST_ON:
367         case CLOCK_EVT_NOTIFY_BROADCAST_OFF:
368         case CLOCK_EVT_NOTIFY_BROADCAST_FORCE:
369                 tick_broadcast_on_off(reason, dev);
370                 break;
371
372         case CLOCK_EVT_NOTIFY_BROADCAST_ENTER:
373         case CLOCK_EVT_NOTIFY_BROADCAST_EXIT:
374                 tick_broadcast_oneshot_control(reason);
375                 break;
376
377         case CLOCK_EVT_NOTIFY_CPU_DYING:
378                 tick_handover_do_timer(dev);
379                 break;
380
381         case CLOCK_EVT_NOTIFY_CPU_DEAD:
382                 tick_shutdown_broadcast_oneshot(dev);
383                 tick_shutdown_broadcast(dev);
384                 tick_shutdown(dev);
385                 break;
386
387         case CLOCK_EVT_NOTIFY_SUSPEND:
388                 tick_suspend();
389                 tick_suspend_broadcast();
390                 break;
391
392         case CLOCK_EVT_NOTIFY_RESUME:
393                 tick_resume();
394                 break;
395
396         default:
397                 break;
398         }
399
400         return NOTIFY_OK;
401 }
402
403 static struct notifier_block tick_notifier = {
404         .notifier_call = tick_notify,
405 };
406
407 /**
408  * tick_init - initialize the tick control
409  *
410  * Register the notifier with the clockevents framework
411  */
412 void __init tick_init(void)
413 {
414         clockevents_register_notifier(&tick_notifier);
415 }