clockevents: Make minimum delay adjustments configurable
[deliverable/linux.git] / kernel / time / clockevents.c
CommitLineData
d316c57f
TG
1/*
2 * linux/kernel/time/clockevents.c
3 *
4 * This file contains functions which manage clock event devices.
5 *
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
9 *
10 * This code is licenced under the GPL version 2. For details see
11 * kernel-base/COPYING.
12 */
13
14#include <linux/clockchips.h>
15#include <linux/hrtimer.h>
16#include <linux/init.h>
17#include <linux/module.h>
18#include <linux/notifier.h>
19#include <linux/smp.h>
20#include <linux/sysdev.h>
21
8e1a928a
HS
22#include "tick-internal.h"
23
d316c57f
TG
24/* The registered clock event devices */
25static LIST_HEAD(clockevent_devices);
26static LIST_HEAD(clockevents_released);
27
28/* Notification for clock events */
29static RAW_NOTIFIER_HEAD(clockevents_chain);
30
31/* Protection for the above */
b5f91da0 32static DEFINE_RAW_SPINLOCK(clockevents_lock);
d316c57f
TG
33
34/**
35 * clockevents_delta2ns - Convert a latch value (device ticks) to nanoseconds
36 * @latch: value to convert
37 * @evt: pointer to clock event device descriptor
38 *
39 * Math helper, returns latch value converted to nanoseconds (bound checked)
40 */
97813f2f 41u64 clockevent_delta2ns(unsigned long latch, struct clock_event_device *evt)
d316c57f 42{
97813f2f 43 u64 clc = (u64) latch << evt->shift;
d316c57f 44
45fe4fe1
IM
45 if (unlikely(!evt->mult)) {
46 evt->mult = 1;
47 WARN_ON(1);
48 }
49
d316c57f
TG
50 do_div(clc, evt->mult);
51 if (clc < 1000)
52 clc = 1000;
97813f2f
JH
53 if (clc > KTIME_MAX)
54 clc = KTIME_MAX;
d316c57f 55
97813f2f 56 return clc;
d316c57f 57}
c81fc2c3 58EXPORT_SYMBOL_GPL(clockevent_delta2ns);
d316c57f
TG
59
60/**
61 * clockevents_set_mode - set the operating mode of a clock event device
62 * @dev: device to modify
63 * @mode: new mode
64 *
65 * Must be called with interrupts disabled !
66 */
67void clockevents_set_mode(struct clock_event_device *dev,
68 enum clock_event_mode mode)
69{
70 if (dev->mode != mode) {
71 dev->set_mode(mode, dev);
72 dev->mode = mode;
2d68259d
MD
73
74 /*
75 * A nsec2cyc multiplicator of 0 is invalid and we'd crash
76 * on it, so fix it up and emit a warning:
77 */
78 if (mode == CLOCK_EVT_MODE_ONESHOT) {
79 if (unlikely(!dev->mult)) {
80 dev->mult = 1;
81 WARN_ON(1);
82 }
83 }
d316c57f
TG
84 }
85}
86
2344abbc
TG
87/**
88 * clockevents_shutdown - shutdown the device and clear next_event
89 * @dev: device to shutdown
90 */
91void clockevents_shutdown(struct clock_event_device *dev)
92{
93 clockevents_set_mode(dev, CLOCK_EVT_MODE_SHUTDOWN);
94 dev->next_event.tv64 = KTIME_MAX;
95}
96
d1748302
MS
97#ifdef CONFIG_GENERIC_CLOCKEVENTS_MIN_ADJUST
98
99/* Limit min_delta to a jiffie */
100#define MIN_DELTA_LIMIT (NSEC_PER_SEC / HZ)
101
102/**
103 * clockevents_increase_min_delta - raise minimum delta of a clock event device
104 * @dev: device to increase the minimum delta
105 *
106 * Returns 0 on success, -ETIME when the minimum delta reached the limit.
107 */
108static int clockevents_increase_min_delta(struct clock_event_device *dev)
109{
110 /* Nothing to do if we already reached the limit */
111 if (dev->min_delta_ns >= MIN_DELTA_LIMIT) {
112 printk(KERN_WARNING "CE: Reprogramming failure. Giving up\n");
113 dev->next_event.tv64 = KTIME_MAX;
114 return -ETIME;
115 }
116
117 if (dev->min_delta_ns < 5000)
118 dev->min_delta_ns = 5000;
119 else
120 dev->min_delta_ns += dev->min_delta_ns >> 1;
121
122 if (dev->min_delta_ns > MIN_DELTA_LIMIT)
123 dev->min_delta_ns = MIN_DELTA_LIMIT;
124
125 printk(KERN_WARNING "CE: %s increased min_delta_ns to %llu nsec\n",
126 dev->name ? dev->name : "?",
127 (unsigned long long) dev->min_delta_ns);
128 return 0;
129}
130
131/**
132 * clockevents_program_min_delta - Set clock event device to the minimum delay.
133 * @dev: device to program
134 *
135 * Returns 0 on success, -ETIME when the retry loop failed.
136 */
137static int clockevents_program_min_delta(struct clock_event_device *dev)
138{
139 unsigned long long clc;
140 int64_t delta;
141 int i;
142
143 for (i = 0;;) {
144 delta = dev->min_delta_ns;
145 dev->next_event = ktime_add_ns(ktime_get(), delta);
146
147 if (dev->mode == CLOCK_EVT_MODE_SHUTDOWN)
148 return 0;
149
150 dev->retries++;
151 clc = ((unsigned long long) delta * dev->mult) >> dev->shift;
152 if (dev->set_next_event((unsigned long) clc, dev) == 0)
153 return 0;
154
155 if (++i > 2) {
156 /*
157 * We tried 3 times to program the device with the
158 * given min_delta_ns. Try to increase the minimum
159 * delta, if that fails as well get out of here.
160 */
161 if (clockevents_increase_min_delta(dev))
162 return -ETIME;
163 i = 0;
164 }
165 }
166}
167
168#else /* CONFIG_GENERIC_CLOCKEVENTS_MIN_ADJUST */
169
170/**
171 * clockevents_program_min_delta - Set clock event device to the minimum delay.
172 * @dev: device to program
173 *
174 * Returns 0 on success, -ETIME when the retry loop failed.
175 */
176static int clockevents_program_min_delta(struct clock_event_device *dev)
177{
178 unsigned long long clc;
179 int64_t delta;
180
181 delta = dev->min_delta_ns;
182 dev->next_event = ktime_add_ns(ktime_get(), delta);
183
184 if (dev->mode == CLOCK_EVT_MODE_SHUTDOWN)
185 return 0;
186
187 dev->retries++;
188 clc = ((unsigned long long) delta * dev->mult) >> dev->shift;
189 return dev->set_next_event((unsigned long) clc, dev);
190}
191
192#endif /* CONFIG_GENERIC_CLOCKEVENTS_MIN_ADJUST */
193
d316c57f
TG
194/**
195 * clockevents_program_event - Reprogram the clock event device.
d1748302 196 * @dev: device to program
d316c57f 197 * @expires: absolute expiry time (monotonic clock)
d1748302 198 * @force: program minimum delay if expires can not be set
d316c57f
TG
199 *
200 * Returns 0 on success, -ETIME when the event is in the past.
201 */
202int clockevents_program_event(struct clock_event_device *dev, ktime_t expires,
d1748302 203 bool force)
d316c57f
TG
204{
205 unsigned long long clc;
206 int64_t delta;
d1748302 207 int rc;
d316c57f 208
167b1de3
TG
209 if (unlikely(expires.tv64 < 0)) {
210 WARN_ON_ONCE(1);
211 return -ETIME;
212 }
213
d316c57f
TG
214 dev->next_event = expires;
215
216 if (dev->mode == CLOCK_EVT_MODE_SHUTDOWN)
217 return 0;
218
d1748302
MS
219 delta = ktime_to_ns(ktime_sub(expires, ktime_get()));
220 if (delta <= 0)
221 return force ? clockevents_program_min_delta(dev) : -ETIME;
d316c57f 222
d1748302
MS
223 delta = min(delta, (int64_t) dev->max_delta_ns);
224 delta = max(delta, (int64_t) dev->min_delta_ns);
d316c57f 225
d1748302
MS
226 clc = ((unsigned long long) delta * dev->mult) >> dev->shift;
227 rc = dev->set_next_event((unsigned long) clc, dev);
228
229 return (rc && force) ? clockevents_program_min_delta(dev) : rc;
d316c57f
TG
230}
231
232/**
233 * clockevents_register_notifier - register a clock events change listener
234 */
235int clockevents_register_notifier(struct notifier_block *nb)
236{
f833bab8 237 unsigned long flags;
d316c57f
TG
238 int ret;
239
b5f91da0 240 raw_spin_lock_irqsave(&clockevents_lock, flags);
d316c57f 241 ret = raw_notifier_chain_register(&clockevents_chain, nb);
b5f91da0 242 raw_spin_unlock_irqrestore(&clockevents_lock, flags);
d316c57f
TG
243
244 return ret;
245}
246
d316c57f
TG
247/*
248 * Notify about a clock event change. Called with clockevents_lock
249 * held.
250 */
251static void clockevents_do_notify(unsigned long reason, void *dev)
252{
253 raw_notifier_call_chain(&clockevents_chain, reason, dev);
254}
255
256/*
3eb05676 257 * Called after a notify add to make devices available which were
d316c57f
TG
258 * released from the notifier call.
259 */
260static void clockevents_notify_released(void)
261{
262 struct clock_event_device *dev;
263
264 while (!list_empty(&clockevents_released)) {
265 dev = list_entry(clockevents_released.next,
266 struct clock_event_device, list);
267 list_del(&dev->list);
268 list_add(&dev->list, &clockevent_devices);
269 clockevents_do_notify(CLOCK_EVT_NOTIFY_ADD, dev);
270 }
271}
272
273/**
274 * clockevents_register_device - register a clock event device
275 * @dev: device to register
276 */
277void clockevents_register_device(struct clock_event_device *dev)
278{
f833bab8
SS
279 unsigned long flags;
280
d316c57f 281 BUG_ON(dev->mode != CLOCK_EVT_MODE_UNUSED);
1b054b67
TG
282 if (!dev->cpumask) {
283 WARN_ON(num_possible_cpus() > 1);
284 dev->cpumask = cpumask_of(smp_processor_id());
285 }
320ab2b0 286
b5f91da0 287 raw_spin_lock_irqsave(&clockevents_lock, flags);
d316c57f
TG
288
289 list_add(&dev->list, &clockevent_devices);
290 clockevents_do_notify(CLOCK_EVT_NOTIFY_ADD, dev);
291 clockevents_notify_released();
292
b5f91da0 293 raw_spin_unlock_irqrestore(&clockevents_lock, flags);
d316c57f 294}
c81fc2c3 295EXPORT_SYMBOL_GPL(clockevents_register_device);
d316c57f 296
57f0fcbe
TG
297static void clockevents_config(struct clock_event_device *dev,
298 u32 freq)
299{
c0e299b1 300 u64 sec;
57f0fcbe
TG
301
302 if (!(dev->features & CLOCK_EVT_FEAT_ONESHOT))
303 return;
304
305 /*
306 * Calculate the maximum number of seconds we can sleep. Limit
307 * to 10 minutes for hardware which can program more than
308 * 32bit ticks so we still get reasonable conversion values.
309 */
310 sec = dev->max_delta_ticks;
311 do_div(sec, freq);
312 if (!sec)
313 sec = 1;
314 else if (sec > 600 && dev->max_delta_ticks > UINT_MAX)
315 sec = 600;
316
317 clockevents_calc_mult_shift(dev, freq, sec);
318 dev->min_delta_ns = clockevent_delta2ns(dev->min_delta_ticks, dev);
319 dev->max_delta_ns = clockevent_delta2ns(dev->max_delta_ticks, dev);
320}
321
322/**
323 * clockevents_config_and_register - Configure and register a clock event device
324 * @dev: device to register
325 * @freq: The clock frequency
326 * @min_delta: The minimum clock ticks to program in oneshot mode
327 * @max_delta: The maximum clock ticks to program in oneshot mode
328 *
329 * min/max_delta can be 0 for devices which do not support oneshot mode.
330 */
331void clockevents_config_and_register(struct clock_event_device *dev,
332 u32 freq, unsigned long min_delta,
333 unsigned long max_delta)
334{
335 dev->min_delta_ticks = min_delta;
336 dev->max_delta_ticks = max_delta;
337 clockevents_config(dev, freq);
338 clockevents_register_device(dev);
339}
340
80b816b7
TG
341/**
342 * clockevents_update_freq - Update frequency and reprogram a clock event device.
343 * @dev: device to modify
344 * @freq: new device frequency
345 *
346 * Reconfigure and reprogram a clock event device in oneshot
347 * mode. Must be called on the cpu for which the device delivers per
348 * cpu timer events with interrupts disabled! Returns 0 on success,
349 * -ETIME when the event is in the past.
350 */
351int clockevents_update_freq(struct clock_event_device *dev, u32 freq)
352{
353 clockevents_config(dev, freq);
354
355 if (dev->mode != CLOCK_EVT_MODE_ONESHOT)
356 return 0;
357
d1748302 358 return clockevents_program_event(dev, dev->next_event, false);
80b816b7
TG
359}
360
d316c57f
TG
361/*
362 * Noop handler when we shut down an event device
363 */
7c1e7689 364void clockevents_handle_noop(struct clock_event_device *dev)
d316c57f
TG
365{
366}
367
368/**
369 * clockevents_exchange_device - release and request clock devices
370 * @old: device to release (can be NULL)
371 * @new: device to request (can be NULL)
372 *
373 * Called from the notifier chain. clockevents_lock is held already
374 */
375void clockevents_exchange_device(struct clock_event_device *old,
376 struct clock_event_device *new)
377{
378 unsigned long flags;
379
380 local_irq_save(flags);
381 /*
382 * Caller releases a clock event device. We queue it into the
383 * released list and do a notify add later.
384 */
385 if (old) {
d316c57f
TG
386 clockevents_set_mode(old, CLOCK_EVT_MODE_UNUSED);
387 list_del(&old->list);
388 list_add(&old->list, &clockevents_released);
389 }
390
391 if (new) {
392 BUG_ON(new->mode != CLOCK_EVT_MODE_UNUSED);
2344abbc 393 clockevents_shutdown(new);
d316c57f
TG
394 }
395 local_irq_restore(flags);
396}
397
de68d9b1 398#ifdef CONFIG_GENERIC_CLOCKEVENTS
d316c57f
TG
399/**
400 * clockevents_notify - notification about relevant events
401 */
402void clockevents_notify(unsigned long reason, void *arg)
403{
bb6eddf7 404 struct clock_event_device *dev, *tmp;
f833bab8 405 unsigned long flags;
bb6eddf7 406 int cpu;
0b858e6f 407
b5f91da0 408 raw_spin_lock_irqsave(&clockevents_lock, flags);
d316c57f
TG
409 clockevents_do_notify(reason, arg);
410
411 switch (reason) {
412 case CLOCK_EVT_NOTIFY_CPU_DEAD:
413 /*
414 * Unregister the clock event devices which were
415 * released from the users in the notify chain.
416 */
bb6eddf7
TG
417 list_for_each_entry_safe(dev, tmp, &clockevents_released, list)
418 list_del(&dev->list);
419 /*
420 * Now check whether the CPU has left unused per cpu devices
421 */
422 cpu = *((int *)arg);
423 list_for_each_entry_safe(dev, tmp, &clockevent_devices, list) {
424 if (cpumask_test_cpu(cpu, dev->cpumask) &&
ea9d8e3f
XF
425 cpumask_weight(dev->cpumask) == 1 &&
426 !tick_is_broadcast_device(dev)) {
bb6eddf7
TG
427 BUG_ON(dev->mode != CLOCK_EVT_MODE_UNUSED);
428 list_del(&dev->list);
429 }
430 }
d316c57f
TG
431 break;
432 default:
433 break;
434 }
b5f91da0 435 raw_spin_unlock_irqrestore(&clockevents_lock, flags);
d316c57f
TG
436}
437EXPORT_SYMBOL_GPL(clockevents_notify);
de68d9b1 438#endif
This page took 0.409122 seconds and 5 git commands to generate.