[PATCH] Simplify the registration of clocksources
[safe/jmp/linux-2.6] / arch / i386 / kernel / tsc.c
1 /*
2  * This code largely moved from arch/i386/kernel/timer/timer_tsc.c
3  * which was originally moved from arch/i386/kernel/time.c.
4  * See comments there for proper credits.
5  */
6
7 #include <linux/clocksource.h>
8 #include <linux/workqueue.h>
9 #include <linux/cpufreq.h>
10 #include <linux/jiffies.h>
11 #include <linux/init.h>
12 #include <linux/dmi.h>
13
14 #include <asm/delay.h>
15 #include <asm/tsc.h>
16 #include <asm/io.h>
17
18 #include "mach_timer.h"
19
20 /*
21  * On some systems the TSC frequency does not
22  * change with the cpu frequency. So we need
23  * an extra value to store the TSC freq
24  */
25 unsigned int tsc_khz;
26 unsigned long long (*custom_sched_clock)(void);
27
28 int tsc_disable;
29
30 #ifdef CONFIG_X86_TSC
31 static int __init tsc_setup(char *str)
32 {
33         printk(KERN_WARNING "notsc: Kernel compiled with CONFIG_X86_TSC, "
34                                 "cannot disable TSC.\n");
35         return 1;
36 }
37 #else
38 /*
39  * disable flag for tsc. Takes effect by clearing the TSC cpu flag
40  * in cpu/common.c
41  */
42 static int __init tsc_setup(char *str)
43 {
44         tsc_disable = 1;
45
46         return 1;
47 }
48 #endif
49
50 __setup("notsc", tsc_setup);
51
52 /*
53  * code to mark and check if the TSC is unstable
54  * due to cpufreq or due to unsynced TSCs
55  */
56 static int tsc_unstable;
57
58 static inline int check_tsc_unstable(void)
59 {
60         return tsc_unstable;
61 }
62
63 void mark_tsc_unstable(void)
64 {
65         tsc_unstable = 1;
66 }
67 EXPORT_SYMBOL_GPL(mark_tsc_unstable);
68
69 /* Accellerators for sched_clock()
70  * convert from cycles(64bits) => nanoseconds (64bits)
71  *  basic equation:
72  *              ns = cycles / (freq / ns_per_sec)
73  *              ns = cycles * (ns_per_sec / freq)
74  *              ns = cycles * (10^9 / (cpu_khz * 10^3))
75  *              ns = cycles * (10^6 / cpu_khz)
76  *
77  *      Then we use scaling math (suggested by george@mvista.com) to get:
78  *              ns = cycles * (10^6 * SC / cpu_khz) / SC
79  *              ns = cycles * cyc2ns_scale / SC
80  *
81  *      And since SC is a constant power of two, we can convert the div
82  *  into a shift.
83  *
84  *  We can use khz divisor instead of mhz to keep a better percision, since
85  *  cyc2ns_scale is limited to 10^6 * 2^10, which fits in 32 bits.
86  *  (mathieu.desnoyers@polymtl.ca)
87  *
88  *                      -johnstul@us.ibm.com "math is hard, lets go shopping!"
89  */
90 static unsigned long cyc2ns_scale __read_mostly;
91
92 #define CYC2NS_SCALE_FACTOR 10 /* 2^10, carefully chosen */
93
94 static inline void set_cyc2ns_scale(unsigned long cpu_khz)
95 {
96         cyc2ns_scale = (1000000 << CYC2NS_SCALE_FACTOR)/cpu_khz;
97 }
98
99 static inline unsigned long long cycles_2_ns(unsigned long long cyc)
100 {
101         return (cyc * cyc2ns_scale) >> CYC2NS_SCALE_FACTOR;
102 }
103
104 /*
105  * Scheduler clock - returns current time in nanosec units.
106  */
107 unsigned long long sched_clock(void)
108 {
109         unsigned long long this_offset;
110
111         if (unlikely(custom_sched_clock))
112                 return (*custom_sched_clock)();
113
114         /*
115          * Fall back to jiffies if there's no TSC available:
116          */
117         if (unlikely(tsc_disable))
118                 /* No locking but a rare wrong value is not a big deal: */
119                 return (jiffies_64 - INITIAL_JIFFIES) * (1000000000 / HZ);
120
121         /* read the Time Stamp Counter: */
122         rdtscll(this_offset);
123
124         /* return the value in ns */
125         return cycles_2_ns(this_offset);
126 }
127
128 static unsigned long calculate_cpu_khz(void)
129 {
130         unsigned long long start, end;
131         unsigned long count;
132         u64 delta64;
133         int i;
134         unsigned long flags;
135
136         local_irq_save(flags);
137
138         /* run 3 times to ensure the cache is warm */
139         for (i = 0; i < 3; i++) {
140                 mach_prepare_counter();
141                 rdtscll(start);
142                 mach_countup(&count);
143                 rdtscll(end);
144         }
145         /*
146          * Error: ECTCNEVERSET
147          * The CTC wasn't reliable: we got a hit on the very first read,
148          * or the CPU was so fast/slow that the quotient wouldn't fit in
149          * 32 bits..
150          */
151         if (count <= 1)
152                 goto err;
153
154         delta64 = end - start;
155
156         /* cpu freq too fast: */
157         if (delta64 > (1ULL<<32))
158                 goto err;
159
160         /* cpu freq too slow: */
161         if (delta64 <= CALIBRATE_TIME_MSEC)
162                 goto err;
163
164         delta64 += CALIBRATE_TIME_MSEC/2; /* round for do_div */
165         do_div(delta64,CALIBRATE_TIME_MSEC);
166
167         local_irq_restore(flags);
168         return (unsigned long)delta64;
169 err:
170         local_irq_restore(flags);
171         return 0;
172 }
173
174 int recalibrate_cpu_khz(void)
175 {
176 #ifndef CONFIG_SMP
177         unsigned long cpu_khz_old = cpu_khz;
178
179         if (cpu_has_tsc) {
180                 cpu_khz = calculate_cpu_khz();
181                 tsc_khz = cpu_khz;
182                 cpu_data[0].loops_per_jiffy =
183                         cpufreq_scale(cpu_data[0].loops_per_jiffy,
184                                         cpu_khz_old, cpu_khz);
185                 return 0;
186         } else
187                 return -ENODEV;
188 #else
189         return -ENODEV;
190 #endif
191 }
192
193 EXPORT_SYMBOL(recalibrate_cpu_khz);
194
195 void __init tsc_init(void)
196 {
197         if (!cpu_has_tsc || tsc_disable)
198                 goto out_no_tsc;
199
200         cpu_khz = calculate_cpu_khz();
201         tsc_khz = cpu_khz;
202
203         if (!cpu_khz)
204                 goto out_no_tsc;
205
206         printk("Detected %lu.%03lu MHz processor.\n",
207                                 (unsigned long)cpu_khz / 1000,
208                                 (unsigned long)cpu_khz % 1000);
209
210         set_cyc2ns_scale(cpu_khz);
211         use_tsc_delay();
212         return;
213
214 out_no_tsc:
215         /*
216          * Set the tsc_disable flag if there's no TSC support, this
217          * makes it a fast flag for the kernel to see whether it
218          * should be using the TSC.
219          */
220         tsc_disable = 1;
221 }
222
223 #ifdef CONFIG_CPU_FREQ
224
225 /*
226  * if the CPU frequency is scaled, TSC-based delays will need a different
227  * loops_per_jiffy value to function properly.
228  */
229 static unsigned int ref_freq = 0;
230 static unsigned long loops_per_jiffy_ref = 0;
231 static unsigned long cpu_khz_ref = 0;
232
233 static int
234 time_cpufreq_notifier(struct notifier_block *nb, unsigned long val, void *data)
235 {
236         struct cpufreq_freqs *freq = data;
237
238         if (val != CPUFREQ_RESUMECHANGE && val != CPUFREQ_SUSPENDCHANGE)
239                 write_seqlock_irq(&xtime_lock);
240
241         if (!ref_freq) {
242                 if (!freq->old){
243                         ref_freq = freq->new;
244                         goto end;
245                 }
246                 ref_freq = freq->old;
247                 loops_per_jiffy_ref = cpu_data[freq->cpu].loops_per_jiffy;
248                 cpu_khz_ref = cpu_khz;
249         }
250
251         if ((val == CPUFREQ_PRECHANGE  && freq->old < freq->new) ||
252             (val == CPUFREQ_POSTCHANGE && freq->old > freq->new) ||
253             (val == CPUFREQ_RESUMECHANGE)) {
254                 if (!(freq->flags & CPUFREQ_CONST_LOOPS))
255                         cpu_data[freq->cpu].loops_per_jiffy =
256                                 cpufreq_scale(loops_per_jiffy_ref,
257                                                 ref_freq, freq->new);
258
259                 if (cpu_khz) {
260
261                         if (num_online_cpus() == 1)
262                                 cpu_khz = cpufreq_scale(cpu_khz_ref,
263                                                 ref_freq, freq->new);
264                         if (!(freq->flags & CPUFREQ_CONST_LOOPS)) {
265                                 tsc_khz = cpu_khz;
266                                 set_cyc2ns_scale(cpu_khz);
267                                 /*
268                                  * TSC based sched_clock turns
269                                  * to junk w/ cpufreq
270                                  */
271                                 mark_tsc_unstable();
272                         }
273                 }
274         }
275 end:
276         if (val != CPUFREQ_RESUMECHANGE && val != CPUFREQ_SUSPENDCHANGE)
277                 write_sequnlock_irq(&xtime_lock);
278
279         return 0;
280 }
281
282 static struct notifier_block time_cpufreq_notifier_block = {
283         .notifier_call  = time_cpufreq_notifier
284 };
285
286 static int __init cpufreq_tsc(void)
287 {
288         return cpufreq_register_notifier(&time_cpufreq_notifier_block,
289                                          CPUFREQ_TRANSITION_NOTIFIER);
290 }
291 core_initcall(cpufreq_tsc);
292
293 #endif
294
295 /* clock source code */
296
297 static unsigned long current_tsc_khz = 0;
298 static int tsc_update_callback(void);
299
300 static cycle_t read_tsc(void)
301 {
302         cycle_t ret;
303
304         rdtscll(ret);
305
306         return ret;
307 }
308
309 static struct clocksource clocksource_tsc = {
310         .name                   = "tsc",
311         .rating                 = 300,
312         .read                   = read_tsc,
313         .mask                   = CLOCKSOURCE_MASK(64),
314         .mult                   = 0, /* to be set */
315         .shift                  = 22,
316         .update_callback        = tsc_update_callback,
317         .is_continuous          = 1,
318 };
319
320 static int tsc_update_callback(void)
321 {
322         int change = 0;
323
324         /* check to see if we should switch to the safe clocksource: */
325         if (clocksource_tsc.rating != 0 && check_tsc_unstable()) {
326                 clocksource_change_rating(&clocksource_tsc, 0);
327                 change = 1;
328         }
329
330         /* only update if tsc_khz has changed: */
331         if (current_tsc_khz != tsc_khz) {
332                 current_tsc_khz = tsc_khz;
333                 clocksource_tsc.mult = clocksource_khz2mult(current_tsc_khz,
334                                                         clocksource_tsc.shift);
335                 change = 1;
336         }
337
338         return change;
339 }
340
341 static int __init dmi_mark_tsc_unstable(struct dmi_system_id *d)
342 {
343         printk(KERN_NOTICE "%s detected: marking TSC unstable.\n",
344                        d->ident);
345         mark_tsc_unstable();
346         return 0;
347 }
348
349 /* List of systems that have known TSC problems */
350 static struct dmi_system_id __initdata bad_tsc_dmi_table[] = {
351         {
352          .callback = dmi_mark_tsc_unstable,
353          .ident = "IBM Thinkpad 380XD",
354          .matches = {
355                      DMI_MATCH(DMI_BOARD_VENDOR, "IBM"),
356                      DMI_MATCH(DMI_BOARD_NAME, "2635FA0"),
357                      },
358          },
359          {}
360 };
361
362 #define TSC_FREQ_CHECK_INTERVAL (10*MSEC_PER_SEC) /* 10sec in MS */
363 static struct timer_list verify_tsc_freq_timer;
364
365 /* XXX - Probably should add locking */
366 static void verify_tsc_freq(unsigned long unused)
367 {
368         static u64 last_tsc;
369         static unsigned long last_jiffies;
370
371         u64 now_tsc, interval_tsc;
372         unsigned long now_jiffies, interval_jiffies;
373
374
375         if (check_tsc_unstable())
376                 return;
377
378         rdtscll(now_tsc);
379         now_jiffies = jiffies;
380
381         if (!last_jiffies) {
382                 goto out;
383         }
384
385         interval_jiffies = now_jiffies - last_jiffies;
386         interval_tsc = now_tsc - last_tsc;
387         interval_tsc *= HZ;
388         do_div(interval_tsc, cpu_khz*1000);
389
390         if (interval_tsc < (interval_jiffies * 3 / 4)) {
391                 printk("TSC appears to be running slowly. "
392                         "Marking it as unstable\n");
393                 mark_tsc_unstable();
394                 return;
395         }
396
397 out:
398         last_tsc = now_tsc;
399         last_jiffies = now_jiffies;
400         /* set us up to go off on the next interval: */
401         mod_timer(&verify_tsc_freq_timer,
402                 jiffies + msecs_to_jiffies(TSC_FREQ_CHECK_INTERVAL));
403 }
404
405 /*
406  * Make an educated guess if the TSC is trustworthy and synchronized
407  * over all CPUs.
408  */
409 static __init int unsynchronized_tsc(void)
410 {
411         /*
412          * Intel systems are normally all synchronized.
413          * Exceptions must mark TSC as unstable:
414          */
415         if (boot_cpu_data.x86_vendor == X86_VENDOR_INTEL)
416                 return 0;
417
418         /* assume multi socket systems are not synchronized: */
419         return num_possible_cpus() > 1;
420 }
421
422 static int __init init_tsc_clocksource(void)
423 {
424
425         if (cpu_has_tsc && tsc_khz && !tsc_disable) {
426                 /* check blacklist */
427                 dmi_check_system(bad_tsc_dmi_table);
428
429                 if (unsynchronized_tsc()) /* mark unstable if unsynced */
430                         mark_tsc_unstable();
431                 current_tsc_khz = tsc_khz;
432                 clocksource_tsc.mult = clocksource_khz2mult(current_tsc_khz,
433                                                         clocksource_tsc.shift);
434                 /* lower the rating if we already know its unstable: */
435                 if (check_tsc_unstable())
436                         clocksource_tsc.rating = 0;
437
438                 init_timer(&verify_tsc_freq_timer);
439                 verify_tsc_freq_timer.function = verify_tsc_freq;
440                 verify_tsc_freq_timer.expires =
441                         jiffies + msecs_to_jiffies(TSC_FREQ_CHECK_INTERVAL);
442                 add_timer(&verify_tsc_freq_timer);
443
444                 return clocksource_register(&clocksource_tsc);
445         }
446
447         return 0;
448 }
449
450 module_init(init_tsc_clocksource);