2 * linux/kernel/time/tick-broadcast.c
4 * This file contains functions which emulate a local clock-event
5 * device via a broadcast event source.
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
11 * This code is licenced under the GPL version 2. For details see
12 * kernel-base/COPYING.
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 #include <linux/tick.h>
23 #include "tick-internal.h"
26 * Broadcast support for broken x86 hardware, where the local apic
27 * timer stops in C3 state.
30 struct tick_device tick_broadcast_device;
31 static cpumask_t tick_broadcast_mask;
32 static DEFINE_SPINLOCK(tick_broadcast_lock);
33 static int tick_broadcast_force;
35 #ifdef CONFIG_TICK_ONESHOT
36 static void tick_broadcast_clear_oneshot(int cpu);
38 static inline void tick_broadcast_clear_oneshot(int cpu) { }
42 * Debugging: see timer_list.c
44 struct tick_device *tick_get_broadcast_device(void)
46 return &tick_broadcast_device;
49 cpumask_t *tick_get_broadcast_mask(void)
51 return &tick_broadcast_mask;
55 * Start the device in periodic mode
57 static void tick_broadcast_start_periodic(struct clock_event_device *bc)
60 tick_setup_periodic(bc, 1);
64 * Check, if the device can be utilized as broadcast device:
66 int tick_check_broadcast_device(struct clock_event_device *dev)
68 if ((tick_broadcast_device.evtdev &&
69 tick_broadcast_device.evtdev->rating >= dev->rating) ||
70 (dev->features & CLOCK_EVT_FEAT_C3STOP))
73 clockevents_exchange_device(NULL, dev);
74 tick_broadcast_device.evtdev = dev;
75 if (!cpus_empty(tick_broadcast_mask))
76 tick_broadcast_start_periodic(dev);
81 * Check, if the device is the broadcast device
83 int tick_is_broadcast_device(struct clock_event_device *dev)
85 return (dev && tick_broadcast_device.evtdev == dev);
89 * Check, if the device is disfunctional and a place holder, which
90 * needs to be handled by the broadcast device.
92 int tick_device_uses_broadcast(struct clock_event_device *dev, int cpu)
97 spin_lock_irqsave(&tick_broadcast_lock, flags);
100 * Devices might be registered with both periodic and oneshot
101 * mode disabled. This signals, that the device needs to be
102 * operated from the broadcast device and is a placeholder for
103 * the cpu local device.
105 if (!tick_device_is_functional(dev)) {
106 dev->event_handler = tick_handle_periodic;
107 cpu_set(cpu, tick_broadcast_mask);
108 tick_broadcast_start_periodic(tick_broadcast_device.evtdev);
112 * When the new device is not affected by the stop
113 * feature and the cpu is marked in the broadcast mask
114 * then clear the broadcast bit.
116 if (!(dev->features & CLOCK_EVT_FEAT_C3STOP)) {
117 int cpu = smp_processor_id();
119 cpu_clear(cpu, tick_broadcast_mask);
120 tick_broadcast_clear_oneshot(cpu);
123 spin_unlock_irqrestore(&tick_broadcast_lock, flags);
128 * Broadcast the event to the cpus, which are set in the mask
130 static void tick_do_broadcast(cpumask_t mask)
132 int cpu = smp_processor_id();
133 struct tick_device *td;
136 * Check, if the current cpu is in the mask
138 if (cpu_isset(cpu, mask)) {
139 cpu_clear(cpu, mask);
140 td = &per_cpu(tick_cpu_device, cpu);
141 td->evtdev->event_handler(td->evtdev);
144 if (!cpus_empty(mask)) {
146 * It might be necessary to actually check whether the devices
147 * have different broadcast functions. For now, just use the
148 * one of the first device. This works as long as we have this
149 * misfeature only on x86 (lapic)
151 cpu = first_cpu(mask);
152 td = &per_cpu(tick_cpu_device, cpu);
153 td->evtdev->broadcast(mask);
158 * Periodic broadcast:
159 * - invoke the broadcast handlers
161 static void tick_do_periodic_broadcast(void)
165 spin_lock(&tick_broadcast_lock);
167 cpus_and(mask, cpu_online_map, tick_broadcast_mask);
168 tick_do_broadcast(mask);
170 spin_unlock(&tick_broadcast_lock);
174 * Event handler for periodic broadcast ticks
176 static void tick_handle_periodic_broadcast(struct clock_event_device *dev)
180 tick_do_periodic_broadcast();
183 * The device is in periodic mode. No reprogramming necessary:
185 if (dev->mode == CLOCK_EVT_MODE_PERIODIC)
189 * Setup the next period for devices, which do not have
190 * periodic mode. We read dev->next_event first and add to it
191 * when the event alrady expired. clockevents_program_event()
192 * sets dev->next_event only when the event is really
193 * programmed to the device.
195 for (next = dev->next_event; ;) {
196 next = ktime_add(next, tick_period);
198 if (!clockevents_program_event(dev, next, ktime_get()))
200 tick_do_periodic_broadcast();
205 * Powerstate information: The system enters/leaves a state, where
206 * affected devices might stop
208 static void tick_do_broadcast_on_off(void *why)
210 struct clock_event_device *bc, *dev;
211 struct tick_device *td;
212 unsigned long flags, *reason = why;
215 spin_lock_irqsave(&tick_broadcast_lock, flags);
217 cpu = smp_processor_id();
218 td = &per_cpu(tick_cpu_device, cpu);
220 bc = tick_broadcast_device.evtdev;
223 * Is the device not affected by the powerstate ?
225 if (!dev || !(dev->features & CLOCK_EVT_FEAT_C3STOP))
228 if (!tick_device_is_functional(dev))
231 bc_stopped = cpus_empty(tick_broadcast_mask);
234 case CLOCK_EVT_NOTIFY_BROADCAST_ON:
235 case CLOCK_EVT_NOTIFY_BROADCAST_FORCE:
236 if (!cpu_isset(cpu, tick_broadcast_mask)) {
237 cpu_set(cpu, tick_broadcast_mask);
238 if (tick_broadcast_device.mode ==
239 TICKDEV_MODE_PERIODIC)
240 clockevents_shutdown(dev);
242 if (*reason == CLOCK_EVT_NOTIFY_BROADCAST_FORCE)
243 tick_broadcast_force = 1;
245 case CLOCK_EVT_NOTIFY_BROADCAST_OFF:
246 if (!tick_broadcast_force &&
247 cpu_isset(cpu, tick_broadcast_mask)) {
248 cpu_clear(cpu, tick_broadcast_mask);
249 if (tick_broadcast_device.mode ==
250 TICKDEV_MODE_PERIODIC)
251 tick_setup_periodic(dev, 0);
256 if (cpus_empty(tick_broadcast_mask)) {
258 clockevents_shutdown(bc);
259 } else if (bc_stopped) {
260 if (tick_broadcast_device.mode == TICKDEV_MODE_PERIODIC)
261 tick_broadcast_start_periodic(bc);
263 tick_broadcast_setup_oneshot(bc);
266 spin_unlock_irqrestore(&tick_broadcast_lock, flags);
270 * Powerstate information: The system enters/leaves a state, where
271 * affected devices might stop.
273 void tick_broadcast_on_off(unsigned long reason, int *oncpu)
275 if (!cpu_isset(*oncpu, cpu_online_map))
276 printk(KERN_ERR "tick-broadcast: ignoring broadcast for "
277 "offline CPU #%d\n", *oncpu);
279 smp_call_function_single(*oncpu, tick_do_broadcast_on_off,
284 * Set the periodic handler depending on broadcast on/off
286 void tick_set_periodic_handler(struct clock_event_device *dev, int broadcast)
289 dev->event_handler = tick_handle_periodic;
291 dev->event_handler = tick_handle_periodic_broadcast;
295 * Remove a CPU from broadcasting
297 void tick_shutdown_broadcast(unsigned int *cpup)
299 struct clock_event_device *bc;
301 unsigned int cpu = *cpup;
303 spin_lock_irqsave(&tick_broadcast_lock, flags);
305 bc = tick_broadcast_device.evtdev;
306 cpu_clear(cpu, tick_broadcast_mask);
308 if (tick_broadcast_device.mode == TICKDEV_MODE_PERIODIC) {
309 if (bc && cpus_empty(tick_broadcast_mask))
310 clockevents_shutdown(bc);
313 spin_unlock_irqrestore(&tick_broadcast_lock, flags);
316 void tick_suspend_broadcast(void)
318 struct clock_event_device *bc;
321 spin_lock_irqsave(&tick_broadcast_lock, flags);
323 bc = tick_broadcast_device.evtdev;
325 clockevents_shutdown(bc);
327 spin_unlock_irqrestore(&tick_broadcast_lock, flags);
330 int tick_resume_broadcast(void)
332 struct clock_event_device *bc;
336 spin_lock_irqsave(&tick_broadcast_lock, flags);
338 bc = tick_broadcast_device.evtdev;
341 clockevents_set_mode(bc, CLOCK_EVT_MODE_RESUME);
343 switch (tick_broadcast_device.mode) {
344 case TICKDEV_MODE_PERIODIC:
345 if(!cpus_empty(tick_broadcast_mask))
346 tick_broadcast_start_periodic(bc);
347 broadcast = cpu_isset(smp_processor_id(),
348 tick_broadcast_mask);
350 case TICKDEV_MODE_ONESHOT:
351 broadcast = tick_resume_broadcast_oneshot(bc);
355 spin_unlock_irqrestore(&tick_broadcast_lock, flags);
361 #ifdef CONFIG_TICK_ONESHOT
363 static cpumask_t tick_broadcast_oneshot_mask;
366 * Debugging: see timer_list.c
368 cpumask_t *tick_get_broadcast_oneshot_mask(void)
370 return &tick_broadcast_oneshot_mask;
373 static int tick_broadcast_set_event(ktime_t expires, int force)
375 struct clock_event_device *bc = tick_broadcast_device.evtdev;
377 return tick_dev_program_event(bc, expires, force);
380 int tick_resume_broadcast_oneshot(struct clock_event_device *bc)
382 clockevents_set_mode(bc, CLOCK_EVT_MODE_ONESHOT);
387 * Handle oneshot mode broadcasting
389 static void tick_handle_oneshot_broadcast(struct clock_event_device *dev)
391 struct tick_device *td;
393 ktime_t now, next_event;
396 spin_lock(&tick_broadcast_lock);
398 dev->next_event.tv64 = KTIME_MAX;
399 next_event.tv64 = KTIME_MAX;
400 mask = CPU_MASK_NONE;
402 /* Find all expired events */
403 for_each_cpu_mask_nr(cpu, tick_broadcast_oneshot_mask) {
404 td = &per_cpu(tick_cpu_device, cpu);
405 if (td->evtdev->next_event.tv64 <= now.tv64)
407 else if (td->evtdev->next_event.tv64 < next_event.tv64)
408 next_event.tv64 = td->evtdev->next_event.tv64;
412 * Wakeup the cpus which have an expired event.
414 tick_do_broadcast(mask);
417 * Two reasons for reprogram:
419 * - The global event did not expire any CPU local
420 * events. This happens in dyntick mode, as the maximum PIT
421 * delta is quite small.
423 * - There are pending events on sleeping CPUs which were not
426 if (next_event.tv64 != KTIME_MAX) {
428 * Rearm the broadcast device. If event expired,
431 if (tick_broadcast_set_event(next_event, 0))
434 spin_unlock(&tick_broadcast_lock);
438 * Powerstate information: The system enters/leaves a state, where
439 * affected devices might stop
441 void tick_broadcast_oneshot_control(unsigned long reason)
443 struct clock_event_device *bc, *dev;
444 struct tick_device *td;
448 spin_lock_irqsave(&tick_broadcast_lock, flags);
451 * Periodic mode does not care about the enter/exit of power
454 if (tick_broadcast_device.mode == TICKDEV_MODE_PERIODIC)
457 bc = tick_broadcast_device.evtdev;
458 cpu = smp_processor_id();
459 td = &per_cpu(tick_cpu_device, cpu);
462 if (!(dev->features & CLOCK_EVT_FEAT_C3STOP))
465 if (reason == CLOCK_EVT_NOTIFY_BROADCAST_ENTER) {
466 if (!cpu_isset(cpu, tick_broadcast_oneshot_mask)) {
467 cpu_set(cpu, tick_broadcast_oneshot_mask);
468 clockevents_set_mode(dev, CLOCK_EVT_MODE_SHUTDOWN);
469 if (dev->next_event.tv64 < bc->next_event.tv64)
470 tick_broadcast_set_event(dev->next_event, 1);
473 if (cpu_isset(cpu, tick_broadcast_oneshot_mask)) {
474 cpu_clear(cpu, tick_broadcast_oneshot_mask);
475 clockevents_set_mode(dev, CLOCK_EVT_MODE_ONESHOT);
476 if (dev->next_event.tv64 != KTIME_MAX)
477 tick_program_event(dev->next_event, 1);
482 spin_unlock_irqrestore(&tick_broadcast_lock, flags);
486 * Reset the one shot broadcast for a cpu
488 * Called with tick_broadcast_lock held
490 static void tick_broadcast_clear_oneshot(int cpu)
492 cpu_clear(cpu, tick_broadcast_oneshot_mask);
495 static void tick_broadcast_init_next_event(cpumask_t *mask, ktime_t expires)
497 struct tick_device *td;
500 for_each_cpu_mask_nr(cpu, *mask) {
501 td = &per_cpu(tick_cpu_device, cpu);
503 td->evtdev->next_event = expires;
508 * tick_broadcast_setup_oneshot - setup the broadcast device
510 void tick_broadcast_setup_oneshot(struct clock_event_device *bc)
512 /* Set it up only once ! */
513 if (bc->event_handler != tick_handle_oneshot_broadcast) {
514 int was_periodic = bc->mode == CLOCK_EVT_MODE_PERIODIC;
515 int cpu = smp_processor_id();
518 bc->event_handler = tick_handle_oneshot_broadcast;
519 clockevents_set_mode(bc, CLOCK_EVT_MODE_ONESHOT);
521 /* Take the do_timer update */
522 tick_do_timer_cpu = cpu;
525 * We must be careful here. There might be other CPUs
526 * waiting for periodic broadcast. We need to set the
527 * oneshot_mask bits for those and program the
528 * broadcast device to fire.
530 mask = tick_broadcast_mask;
531 cpu_clear(cpu, mask);
532 cpus_or(tick_broadcast_oneshot_mask,
533 tick_broadcast_oneshot_mask, mask);
535 if (was_periodic && !cpus_empty(mask)) {
536 tick_broadcast_init_next_event(&mask, tick_next_period);
537 tick_broadcast_set_event(tick_next_period, 1);
539 bc->next_event.tv64 = KTIME_MAX;
544 * Select oneshot operating mode for the broadcast device
546 void tick_broadcast_switch_to_oneshot(void)
548 struct clock_event_device *bc;
551 spin_lock_irqsave(&tick_broadcast_lock, flags);
553 tick_broadcast_device.mode = TICKDEV_MODE_ONESHOT;
554 bc = tick_broadcast_device.evtdev;
556 tick_broadcast_setup_oneshot(bc);
557 spin_unlock_irqrestore(&tick_broadcast_lock, flags);
562 * Remove a dead CPU from broadcasting
564 void tick_shutdown_broadcast_oneshot(unsigned int *cpup)
567 unsigned int cpu = *cpup;
569 spin_lock_irqsave(&tick_broadcast_lock, flags);
572 * Clear the broadcast mask flag for the dead cpu, but do not
573 * stop the broadcast device!
575 cpu_clear(cpu, tick_broadcast_oneshot_mask);
577 spin_unlock_irqrestore(&tick_broadcast_lock, flags);
581 * Check, whether the broadcast device is in one shot mode
583 int tick_broadcast_oneshot_active(void)
585 return tick_broadcast_device.mode == TICKDEV_MODE_ONESHOT;