gcc-plugins: Use dynamic initializers
[linux-2.6/btrfs-unstable.git] / kernel / time / clockevents.c
blob16c027e9cc730a38d1bb97da89dd9f30c4557145
1 /*
2 * linux/kernel/time/clockevents.c
4 * This file contains functions which manage clock event devices.
6 * Copyright(C) 2005-2006, Thomas Gleixner <tglx@linutronix.de>
7 * Copyright(C) 2005-2007, Red Hat, Inc., Ingo Molnar
8 * Copyright(C) 2006-2007, Timesys Corp., Thomas Gleixner
10 * This code is licenced under the GPL version 2. For details see
11 * kernel-base/COPYING.
14 #include <linux/clockchips.h>
15 #include <linux/hrtimer.h>
16 #include <linux/init.h>
17 #include <linux/module.h>
18 #include <linux/smp.h>
19 #include <linux/device.h>
21 #include "tick-internal.h"
23 /* The registered clock event devices */
24 static LIST_HEAD(clockevent_devices);
25 static LIST_HEAD(clockevents_released);
26 /* Protection for the above */
27 static DEFINE_RAW_SPINLOCK(clockevents_lock);
28 /* Protection for unbind operations */
29 static DEFINE_MUTEX(clockevents_mutex);
31 struct ce_unbind {
32 struct clock_event_device *ce;
33 int res;
36 static u64 cev_delta2ns(unsigned long latch, struct clock_event_device *evt,
37 bool ismax)
39 u64 clc = (u64) latch << evt->shift;
40 u64 rnd;
42 if (unlikely(!evt->mult)) {
43 evt->mult = 1;
44 WARN_ON(1);
46 rnd = (u64) evt->mult - 1;
49 * Upper bound sanity check. If the backwards conversion is
50 * not equal latch, we know that the above shift overflowed.
52 if ((clc >> evt->shift) != (u64)latch)
53 clc = ~0ULL;
56 * Scaled math oddities:
58 * For mult <= (1 << shift) we can safely add mult - 1 to
59 * prevent integer rounding loss. So the backwards conversion
60 * from nsec to device ticks will be correct.
62 * For mult > (1 << shift), i.e. device frequency is > 1GHz we
63 * need to be careful. Adding mult - 1 will result in a value
64 * which when converted back to device ticks can be larger
65 * than latch by up to (mult - 1) >> shift. For the min_delta
66 * calculation we still want to apply this in order to stay
67 * above the minimum device ticks limit. For the upper limit
68 * we would end up with a latch value larger than the upper
69 * limit of the device, so we omit the add to stay below the
70 * device upper boundary.
72 * Also omit the add if it would overflow the u64 boundary.
74 if ((~0ULL - clc > rnd) &&
75 (!ismax || evt->mult <= (1ULL << evt->shift)))
76 clc += rnd;
78 do_div(clc, evt->mult);
80 /* Deltas less than 1usec are pointless noise */
81 return clc > 1000 ? clc : 1000;
84 /**
85 * clockevents_delta2ns - Convert a latch value (device ticks) to nanoseconds
86 * @latch: value to convert
87 * @evt: pointer to clock event device descriptor
89 * Math helper, returns latch value converted to nanoseconds (bound checked)
91 u64 clockevent_delta2ns(unsigned long latch, struct clock_event_device *evt)
93 return cev_delta2ns(latch, evt, false);
95 EXPORT_SYMBOL_GPL(clockevent_delta2ns);
97 static int __clockevents_switch_state(struct clock_event_device *dev,
98 enum clock_event_state state)
100 if (dev->features & CLOCK_EVT_FEAT_DUMMY)
101 return 0;
103 /* Transition with new state-specific callbacks */
104 switch (state) {
105 case CLOCK_EVT_STATE_DETACHED:
106 /* The clockevent device is getting replaced. Shut it down. */
108 case CLOCK_EVT_STATE_SHUTDOWN:
109 if (dev->set_state_shutdown)
110 return dev->set_state_shutdown(dev);
111 return 0;
113 case CLOCK_EVT_STATE_PERIODIC:
114 /* Core internal bug */
115 if (!(dev->features & CLOCK_EVT_FEAT_PERIODIC))
116 return -ENOSYS;
117 if (dev->set_state_periodic)
118 return dev->set_state_periodic(dev);
119 return 0;
121 case CLOCK_EVT_STATE_ONESHOT:
122 /* Core internal bug */
123 if (!(dev->features & CLOCK_EVT_FEAT_ONESHOT))
124 return -ENOSYS;
125 if (dev->set_state_oneshot)
126 return dev->set_state_oneshot(dev);
127 return 0;
129 case CLOCK_EVT_STATE_ONESHOT_STOPPED:
130 /* Core internal bug */
131 if (WARN_ONCE(!clockevent_state_oneshot(dev),
132 "Current state: %d\n",
133 clockevent_get_state(dev)))
134 return -EINVAL;
136 if (dev->set_state_oneshot_stopped)
137 return dev->set_state_oneshot_stopped(dev);
138 else
139 return -ENOSYS;
141 default:
142 return -ENOSYS;
147 * clockevents_switch_state - set the operating state of a clock event device
148 * @dev: device to modify
149 * @state: new state
151 * Must be called with interrupts disabled !
153 void clockevents_switch_state(struct clock_event_device *dev,
154 enum clock_event_state state)
156 if (clockevent_get_state(dev) != state) {
157 if (__clockevents_switch_state(dev, state))
158 return;
160 clockevent_set_state(dev, state);
163 * A nsec2cyc multiplicator of 0 is invalid and we'd crash
164 * on it, so fix it up and emit a warning:
166 if (clockevent_state_oneshot(dev)) {
167 if (unlikely(!dev->mult)) {
168 dev->mult = 1;
169 WARN_ON(1);
176 * clockevents_shutdown - shutdown the device and clear next_event
177 * @dev: device to shutdown
179 void clockevents_shutdown(struct clock_event_device *dev)
181 clockevents_switch_state(dev, CLOCK_EVT_STATE_SHUTDOWN);
182 dev->next_event = KTIME_MAX;
186 * clockevents_tick_resume - Resume the tick device before using it again
187 * @dev: device to resume
189 int clockevents_tick_resume(struct clock_event_device *dev)
191 int ret = 0;
193 if (dev->tick_resume)
194 ret = dev->tick_resume(dev);
196 return ret;
199 #ifdef CONFIG_GENERIC_CLOCKEVENTS_MIN_ADJUST
201 /* Limit min_delta to a jiffie */
202 #define MIN_DELTA_LIMIT (NSEC_PER_SEC / HZ)
205 * clockevents_increase_min_delta - raise minimum delta of a clock event device
206 * @dev: device to increase the minimum delta
208 * Returns 0 on success, -ETIME when the minimum delta reached the limit.
210 static int clockevents_increase_min_delta(struct clock_event_device *dev)
212 /* Nothing to do if we already reached the limit */
213 if (dev->min_delta_ns >= MIN_DELTA_LIMIT) {
214 printk_deferred(KERN_WARNING
215 "CE: Reprogramming failure. Giving up\n");
216 dev->next_event = KTIME_MAX;
217 return -ETIME;
220 if (dev->min_delta_ns < 5000)
221 dev->min_delta_ns = 5000;
222 else
223 dev->min_delta_ns += dev->min_delta_ns >> 1;
225 if (dev->min_delta_ns > MIN_DELTA_LIMIT)
226 dev->min_delta_ns = MIN_DELTA_LIMIT;
228 printk_deferred(KERN_WARNING
229 "CE: %s increased min_delta_ns to %llu nsec\n",
230 dev->name ? dev->name : "?",
231 (unsigned long long) dev->min_delta_ns);
232 return 0;
236 * clockevents_program_min_delta - Set clock event device to the minimum delay.
237 * @dev: device to program
239 * Returns 0 on success, -ETIME when the retry loop failed.
241 static int clockevents_program_min_delta(struct clock_event_device *dev)
243 unsigned long long clc;
244 int64_t delta;
245 int i;
247 for (i = 0;;) {
248 delta = dev->min_delta_ns;
249 dev->next_event = ktime_add_ns(ktime_get(), delta);
251 if (clockevent_state_shutdown(dev))
252 return 0;
254 dev->retries++;
255 clc = ((unsigned long long) delta * dev->mult) >> dev->shift;
256 if (dev->set_next_event((unsigned long) clc, dev) == 0)
257 return 0;
259 if (++i > 2) {
261 * We tried 3 times to program the device with the
262 * given min_delta_ns. Try to increase the minimum
263 * delta, if that fails as well get out of here.
265 if (clockevents_increase_min_delta(dev))
266 return -ETIME;
267 i = 0;
272 #else /* CONFIG_GENERIC_CLOCKEVENTS_MIN_ADJUST */
275 * clockevents_program_min_delta - Set clock event device to the minimum delay.
276 * @dev: device to program
278 * Returns 0 on success, -ETIME when the retry loop failed.
280 static int clockevents_program_min_delta(struct clock_event_device *dev)
282 unsigned long long clc;
283 int64_t delta = 0;
284 int i;
286 for (i = 0; i < 10; i++) {
287 delta += dev->min_delta_ns;
288 dev->next_event = ktime_add_ns(ktime_get(), delta);
290 if (clockevent_state_shutdown(dev))
291 return 0;
293 dev->retries++;
294 clc = ((unsigned long long) delta * dev->mult) >> dev->shift;
295 if (dev->set_next_event((unsigned long) clc, dev) == 0)
296 return 0;
298 return -ETIME;
301 #endif /* CONFIG_GENERIC_CLOCKEVENTS_MIN_ADJUST */
304 * clockevents_program_event - Reprogram the clock event device.
305 * @dev: device to program
306 * @expires: absolute expiry time (monotonic clock)
307 * @force: program minimum delay if expires can not be set
309 * Returns 0 on success, -ETIME when the event is in the past.
311 int clockevents_program_event(struct clock_event_device *dev, ktime_t expires,
312 bool force)
314 unsigned long long clc;
315 int64_t delta;
316 int rc;
318 if (unlikely(expires < 0)) {
319 WARN_ON_ONCE(1);
320 return -ETIME;
323 dev->next_event = expires;
325 if (clockevent_state_shutdown(dev))
326 return 0;
328 /* We must be in ONESHOT state here */
329 WARN_ONCE(!clockevent_state_oneshot(dev), "Current state: %d\n",
330 clockevent_get_state(dev));
332 /* Shortcut for clockevent devices that can deal with ktime. */
333 if (dev->features & CLOCK_EVT_FEAT_KTIME)
334 return dev->set_next_ktime(expires, dev);
336 delta = ktime_to_ns(ktime_sub(expires, ktime_get()));
337 if (delta <= 0)
338 return force ? clockevents_program_min_delta(dev) : -ETIME;
340 delta = min(delta, (int64_t) dev->max_delta_ns);
341 delta = max(delta, (int64_t) dev->min_delta_ns);
343 clc = ((unsigned long long) delta * dev->mult) >> dev->shift;
344 rc = dev->set_next_event((unsigned long) clc, dev);
346 return (rc && force) ? clockevents_program_min_delta(dev) : rc;
350 * Called after a notify add to make devices available which were
351 * released from the notifier call.
353 static void clockevents_notify_released(void)
355 struct clock_event_device *dev;
357 while (!list_empty(&clockevents_released)) {
358 dev = list_entry(clockevents_released.next,
359 struct clock_event_device, list);
360 list_del(&dev->list);
361 list_add(&dev->list, &clockevent_devices);
362 tick_check_new_device(dev);
367 * Try to install a replacement clock event device
369 static int clockevents_replace(struct clock_event_device *ced)
371 struct clock_event_device *dev, *newdev = NULL;
373 list_for_each_entry(dev, &clockevent_devices, list) {
374 if (dev == ced || !clockevent_state_detached(dev))
375 continue;
377 if (!tick_check_replacement(newdev, dev))
378 continue;
380 if (!try_module_get(dev->owner))
381 continue;
383 if (newdev)
384 module_put(newdev->owner);
385 newdev = dev;
387 if (newdev) {
388 tick_install_replacement(newdev);
389 list_del_init(&ced->list);
391 return newdev ? 0 : -EBUSY;
395 * Called with clockevents_mutex and clockevents_lock held
397 static int __clockevents_try_unbind(struct clock_event_device *ced, int cpu)
399 /* Fast track. Device is unused */
400 if (clockevent_state_detached(ced)) {
401 list_del_init(&ced->list);
402 return 0;
405 return ced == per_cpu(tick_cpu_device, cpu).evtdev ? -EAGAIN : -EBUSY;
409 * SMP function call to unbind a device
411 static void __clockevents_unbind(void *arg)
413 struct ce_unbind *cu = arg;
414 int res;
416 raw_spin_lock(&clockevents_lock);
417 res = __clockevents_try_unbind(cu->ce, smp_processor_id());
418 if (res == -EAGAIN)
419 res = clockevents_replace(cu->ce);
420 cu->res = res;
421 raw_spin_unlock(&clockevents_lock);
425 * Issues smp function call to unbind a per cpu device. Called with
426 * clockevents_mutex held.
428 static int clockevents_unbind(struct clock_event_device *ced, int cpu)
430 struct ce_unbind cu = { .ce = ced, .res = -ENODEV };
432 smp_call_function_single(cpu, __clockevents_unbind, &cu, 1);
433 return cu.res;
437 * Unbind a clockevents device.
439 int clockevents_unbind_device(struct clock_event_device *ced, int cpu)
441 int ret;
443 mutex_lock(&clockevents_mutex);
444 ret = clockevents_unbind(ced, cpu);
445 mutex_unlock(&clockevents_mutex);
446 return ret;
448 EXPORT_SYMBOL_GPL(clockevents_unbind_device);
451 * clockevents_register_device - register a clock event device
452 * @dev: device to register
454 void clockevents_register_device(struct clock_event_device *dev)
456 unsigned long flags;
458 /* Initialize state to DETACHED */
459 clockevent_set_state(dev, CLOCK_EVT_STATE_DETACHED);
461 if (!dev->cpumask) {
462 WARN_ON(num_possible_cpus() > 1);
463 dev->cpumask = cpumask_of(smp_processor_id());
466 raw_spin_lock_irqsave(&clockevents_lock, flags);
468 list_add(&dev->list, &clockevent_devices);
469 tick_check_new_device(dev);
470 clockevents_notify_released();
472 raw_spin_unlock_irqrestore(&clockevents_lock, flags);
474 EXPORT_SYMBOL_GPL(clockevents_register_device);
476 static void clockevents_config(struct clock_event_device *dev, u32 freq)
478 u64 sec;
480 if (!(dev->features & CLOCK_EVT_FEAT_ONESHOT))
481 return;
484 * Calculate the maximum number of seconds we can sleep. Limit
485 * to 10 minutes for hardware which can program more than
486 * 32bit ticks so we still get reasonable conversion values.
488 sec = dev->max_delta_ticks;
489 do_div(sec, freq);
490 if (!sec)
491 sec = 1;
492 else if (sec > 600 && dev->max_delta_ticks > UINT_MAX)
493 sec = 600;
495 clockevents_calc_mult_shift(dev, freq, sec);
496 dev->min_delta_ns = cev_delta2ns(dev->min_delta_ticks, dev, false);
497 dev->max_delta_ns = cev_delta2ns(dev->max_delta_ticks, dev, true);
501 * clockevents_config_and_register - Configure and register a clock event device
502 * @dev: device to register
503 * @freq: The clock frequency
504 * @min_delta: The minimum clock ticks to program in oneshot mode
505 * @max_delta: The maximum clock ticks to program in oneshot mode
507 * min/max_delta can be 0 for devices which do not support oneshot mode.
509 void clockevents_config_and_register(struct clock_event_device *dev,
510 u32 freq, unsigned long min_delta,
511 unsigned long max_delta)
513 dev->min_delta_ticks = min_delta;
514 dev->max_delta_ticks = max_delta;
515 clockevents_config(dev, freq);
516 clockevents_register_device(dev);
518 EXPORT_SYMBOL_GPL(clockevents_config_and_register);
520 int __clockevents_update_freq(struct clock_event_device *dev, u32 freq)
522 clockevents_config(dev, freq);
524 if (clockevent_state_oneshot(dev))
525 return clockevents_program_event(dev, dev->next_event, false);
527 if (clockevent_state_periodic(dev))
528 return __clockevents_switch_state(dev, CLOCK_EVT_STATE_PERIODIC);
530 return 0;
534 * clockevents_update_freq - Update frequency and reprogram a clock event device.
535 * @dev: device to modify
536 * @freq: new device frequency
538 * Reconfigure and reprogram a clock event device in oneshot
539 * mode. Must be called on the cpu for which the device delivers per
540 * cpu timer events. If called for the broadcast device the core takes
541 * care of serialization.
543 * Returns 0 on success, -ETIME when the event is in the past.
545 int clockevents_update_freq(struct clock_event_device *dev, u32 freq)
547 unsigned long flags;
548 int ret;
550 local_irq_save(flags);
551 ret = tick_broadcast_update_freq(dev, freq);
552 if (ret == -ENODEV)
553 ret = __clockevents_update_freq(dev, freq);
554 local_irq_restore(flags);
555 return ret;
559 * Noop handler when we shut down an event device
561 void clockevents_handle_noop(struct clock_event_device *dev)
566 * clockevents_exchange_device - release and request clock devices
567 * @old: device to release (can be NULL)
568 * @new: device to request (can be NULL)
570 * Called from various tick functions with clockevents_lock held and
571 * interrupts disabled.
573 void clockevents_exchange_device(struct clock_event_device *old,
574 struct clock_event_device *new)
577 * Caller releases a clock event device. We queue it into the
578 * released list and do a notify add later.
580 if (old) {
581 module_put(old->owner);
582 clockevents_switch_state(old, CLOCK_EVT_STATE_DETACHED);
583 list_del(&old->list);
584 list_add(&old->list, &clockevents_released);
587 if (new) {
588 BUG_ON(!clockevent_state_detached(new));
589 clockevents_shutdown(new);
594 * clockevents_suspend - suspend clock devices
596 void clockevents_suspend(void)
598 struct clock_event_device *dev;
600 list_for_each_entry_reverse(dev, &clockevent_devices, list)
601 if (dev->suspend && !clockevent_state_detached(dev))
602 dev->suspend(dev);
606 * clockevents_resume - resume clock devices
608 void clockevents_resume(void)
610 struct clock_event_device *dev;
612 list_for_each_entry(dev, &clockevent_devices, list)
613 if (dev->resume && !clockevent_state_detached(dev))
614 dev->resume(dev);
617 #ifdef CONFIG_HOTPLUG_CPU
619 * tick_cleanup_dead_cpu - Cleanup the tick and clockevents of a dead cpu
621 void tick_cleanup_dead_cpu(int cpu)
623 struct clock_event_device *dev, *tmp;
624 unsigned long flags;
626 raw_spin_lock_irqsave(&clockevents_lock, flags);
628 tick_shutdown_broadcast_oneshot(cpu);
629 tick_shutdown_broadcast(cpu);
630 tick_shutdown(cpu);
632 * Unregister the clock event devices which were
633 * released from the users in the notify chain.
635 list_for_each_entry_safe(dev, tmp, &clockevents_released, list)
636 list_del(&dev->list);
638 * Now check whether the CPU has left unused per cpu devices
640 list_for_each_entry_safe(dev, tmp, &clockevent_devices, list) {
641 if (cpumask_test_cpu(cpu, dev->cpumask) &&
642 cpumask_weight(dev->cpumask) == 1 &&
643 !tick_is_broadcast_device(dev)) {
644 BUG_ON(!clockevent_state_detached(dev));
645 list_del(&dev->list);
648 raw_spin_unlock_irqrestore(&clockevents_lock, flags);
650 #endif
652 #ifdef CONFIG_SYSFS
653 static struct bus_type clockevents_subsys = {
654 .name = "clockevents",
655 .dev_name = "clockevent",
658 static DEFINE_PER_CPU(struct device, tick_percpu_dev);
659 static struct tick_device *tick_get_tick_dev(struct device *dev);
661 static ssize_t sysfs_show_current_tick_dev(struct device *dev,
662 struct device_attribute *attr,
663 char *buf)
665 struct tick_device *td;
666 ssize_t count = 0;
668 raw_spin_lock_irq(&clockevents_lock);
669 td = tick_get_tick_dev(dev);
670 if (td && td->evtdev)
671 count = snprintf(buf, PAGE_SIZE, "%s\n", td->evtdev->name);
672 raw_spin_unlock_irq(&clockevents_lock);
673 return count;
675 static DEVICE_ATTR(current_device, 0444, sysfs_show_current_tick_dev, NULL);
677 /* We don't support the abomination of removable broadcast devices */
678 static ssize_t sysfs_unbind_tick_dev(struct device *dev,
679 struct device_attribute *attr,
680 const char *buf, size_t count)
682 char name[CS_NAME_LEN];
683 ssize_t ret = sysfs_get_uname(buf, name, count);
684 struct clock_event_device *ce;
686 if (ret < 0)
687 return ret;
689 ret = -ENODEV;
690 mutex_lock(&clockevents_mutex);
691 raw_spin_lock_irq(&clockevents_lock);
692 list_for_each_entry(ce, &clockevent_devices, list) {
693 if (!strcmp(ce->name, name)) {
694 ret = __clockevents_try_unbind(ce, dev->id);
695 break;
698 raw_spin_unlock_irq(&clockevents_lock);
700 * We hold clockevents_mutex, so ce can't go away
702 if (ret == -EAGAIN)
703 ret = clockevents_unbind(ce, dev->id);
704 mutex_unlock(&clockevents_mutex);
705 return ret ? ret : count;
707 static DEVICE_ATTR(unbind_device, 0200, NULL, sysfs_unbind_tick_dev);
709 #ifdef CONFIG_GENERIC_CLOCKEVENTS_BROADCAST
710 static struct device tick_bc_dev = {
711 .init_name = "broadcast",
712 .id = 0,
713 .bus = &clockevents_subsys,
716 static struct tick_device *tick_get_tick_dev(struct device *dev)
718 return dev == &tick_bc_dev ? tick_get_broadcast_device() :
719 &per_cpu(tick_cpu_device, dev->id);
722 static __init int tick_broadcast_init_sysfs(void)
724 int err = device_register(&tick_bc_dev);
726 if (!err)
727 err = device_create_file(&tick_bc_dev, &dev_attr_current_device);
728 return err;
730 #else
731 static struct tick_device *tick_get_tick_dev(struct device *dev)
733 return &per_cpu(tick_cpu_device, dev->id);
735 static inline int tick_broadcast_init_sysfs(void) { return 0; }
736 #endif
738 static int __init tick_init_sysfs(void)
740 int cpu;
742 for_each_possible_cpu(cpu) {
743 struct device *dev = &per_cpu(tick_percpu_dev, cpu);
744 int err;
746 dev->id = cpu;
747 dev->bus = &clockevents_subsys;
748 err = device_register(dev);
749 if (!err)
750 err = device_create_file(dev, &dev_attr_current_device);
751 if (!err)
752 err = device_create_file(dev, &dev_attr_unbind_device);
753 if (err)
754 return err;
756 return tick_broadcast_init_sysfs();
759 static int __init clockevents_init_sysfs(void)
761 int err = subsys_system_register(&clockevents_subsys, NULL);
763 if (!err)
764 err = tick_init_sysfs();
765 return err;
767 device_initcall(clockevents_init_sysfs);
768 #endif /* SYSFS */