9a5596bf85712adfb47ee8d1c1def51dc67c59ca
[linux-2.6.git] / arch / mips / kernel / time.c
1 /*
2  * Copyright 2001 MontaVista Software Inc.
3  * Author: Jun Sun, jsun@mvista.com or jsun@junsun.net
4  * Copyright (c) 2003, 2004  Maciej W. Rozycki
5  *
6  * Common time service routines for MIPS machines. See
7  * Documentation/mips/time.README.
8  *
9  * This program is free software; you can redistribute  it and/or modify it
10  * under  the terms of  the GNU General  Public License as published by the
11  * Free Software Foundation;  either version 2 of the  License, or (at your
12  * option) any later version.
13  */
14 #include <linux/types.h>
15 #include <linux/kernel.h>
16 #include <linux/init.h>
17 #include <linux/sched.h>
18 #include <linux/param.h>
19 #include <linux/profile.h>
20 #include <linux/time.h>
21 #include <linux/timex.h>
22 #include <linux/smp.h>
23 #include <linux/kernel_stat.h>
24 #include <linux/spinlock.h>
25 #include <linux/interrupt.h>
26 #include <linux/module.h>
27
28 #include <asm/bootinfo.h>
29 #include <asm/cache.h>
30 #include <asm/compiler.h>
31 #include <asm/cpu.h>
32 #include <asm/cpu-features.h>
33 #include <asm/div64.h>
34 #include <asm/sections.h>
35 #include <asm/time.h>
36
37 /*
38  * The integer part of the number of usecs per jiffy is taken from tick,
39  * but the fractional part is not recorded, so we calculate it using the
40  * initial value of HZ.  This aids systems where tick isn't really an
41  * integer (e.g. for HZ = 128).
42  */
43 #define USECS_PER_JIFFY         TICK_SIZE
44 #define USECS_PER_JIFFY_FRAC    ((unsigned long)(u32)((1000000ULL << 32) / HZ))
45
46 #define TICK_SIZE       (tick_nsec / 1000)
47
48 /*
49  * forward reference
50  */
51 DEFINE_SPINLOCK(rtc_lock);
52
53 /*
54  * By default we provide the null RTC ops
55  */
56 static unsigned long null_rtc_get_time(void)
57 {
58         return mktime(2000, 1, 1, 0, 0, 0);
59 }
60
61 static int null_rtc_set_time(unsigned long sec)
62 {
63         return 0;
64 }
65
66 unsigned long (*rtc_mips_get_time)(void) = null_rtc_get_time;
67 int (*rtc_mips_set_time)(unsigned long) = null_rtc_set_time;
68 int (*rtc_mips_set_mmss)(unsigned long);
69
70
71 /* how many counter cycles in a jiffy */
72 static unsigned long cycles_per_jiffy __read_mostly;
73
74 /* expirelo is the count value for next CPU timer interrupt */
75 static unsigned int expirelo;
76
77
78 /*
79  * Null timer ack for systems not needing one (e.g. i8254).
80  */
81 static void null_timer_ack(void) { /* nothing */ }
82
83 /*
84  * Null high precision timer functions for systems lacking one.
85  */
86 static cycle_t null_hpt_read(void)
87 {
88         return 0;
89 }
90
91 /*
92  * Timer ack for an R4k-compatible timer of a known frequency.
93  */
94 static void c0_timer_ack(void)
95 {
96         unsigned int count;
97
98         /* Ack this timer interrupt and set the next one.  */
99         expirelo += cycles_per_jiffy;
100         write_c0_compare(expirelo);
101
102         /* Check to see if we have missed any timer interrupts.  */
103         while (((count = read_c0_count()) - expirelo) < 0x7fffffff) {
104                 /* missed_timer_count++; */
105                 expirelo = count + cycles_per_jiffy;
106                 write_c0_compare(expirelo);
107         }
108 }
109
110 /*
111  * High precision timer functions for a R4k-compatible timer.
112  */
113 static cycle_t c0_hpt_read(void)
114 {
115         return read_c0_count();
116 }
117
118 /* For use both as a high precision timer and an interrupt source.  */
119 static void __init c0_hpt_timer_init(void)
120 {
121         expirelo = read_c0_count() + cycles_per_jiffy;
122         write_c0_compare(expirelo);
123 }
124
125 int (*mips_timer_state)(void);
126 void (*mips_timer_ack)(void);
127
128 /* last time when xtime and rtc are sync'ed up */
129 static long last_rtc_update;
130
131 /*
132  * local_timer_interrupt() does profiling and process accounting
133  * on a per-CPU basis.
134  *
135  * In UP mode, it is invoked from the (global) timer_interrupt.
136  *
137  * In SMP mode, it might invoked by per-CPU timer interrupt, or
138  * a broadcasted inter-processor interrupt which itself is triggered
139  * by the global timer interrupt.
140  */
141 void local_timer_interrupt(int irq, void *dev_id)
142 {
143         profile_tick(CPU_PROFILING);
144         update_process_times(user_mode(get_irq_regs()));
145 }
146
147 /*
148  * High-level timer interrupt service routines.  This function
149  * is set as irqaction->handler and is invoked through do_IRQ.
150  */
151 irqreturn_t timer_interrupt(int irq, void *dev_id)
152 {
153         write_seqlock(&xtime_lock);
154
155         mips_timer_ack();
156
157         /*
158          * call the generic timer interrupt handling
159          */
160         do_timer(1);
161
162         /*
163          * If we have an externally synchronized Linux clock, then update
164          * CMOS clock accordingly every ~11 minutes. rtc_mips_set_time() has to be
165          * called as close as possible to 500 ms before the new second starts.
166          */
167         if (ntp_synced() &&
168             xtime.tv_sec > last_rtc_update + 660 &&
169             (xtime.tv_nsec / 1000) >= 500000 - ((unsigned) TICK_SIZE) / 2 &&
170             (xtime.tv_nsec / 1000) <= 500000 + ((unsigned) TICK_SIZE) / 2) {
171                 if (rtc_mips_set_mmss(xtime.tv_sec) == 0) {
172                         last_rtc_update = xtime.tv_sec;
173                 } else {
174                         /* do it again in 60 s */
175                         last_rtc_update = xtime.tv_sec - 600;
176                 }
177         }
178
179         write_sequnlock(&xtime_lock);
180
181         /*
182          * In UP mode, we call local_timer_interrupt() to do profiling
183          * and process accouting.
184          *
185          * In SMP mode, local_timer_interrupt() is invoked by appropriate
186          * low-level local timer interrupt handler.
187          */
188         local_timer_interrupt(irq, dev_id);
189
190         return IRQ_HANDLED;
191 }
192
193 int null_perf_irq(void)
194 {
195         return 0;
196 }
197
198 int (*perf_irq)(void) = null_perf_irq;
199
200 EXPORT_SYMBOL(null_perf_irq);
201 EXPORT_SYMBOL(perf_irq);
202
203 /*
204  * Timer interrupt
205  */
206 int cp0_compare_irq;
207
208 /*
209  * Performance counter IRQ or -1 if shared with timer
210  */
211 int cp0_perfcount_irq;
212 EXPORT_SYMBOL_GPL(cp0_perfcount_irq);
213
214 /*
215  * Possibly handle a performance counter interrupt.
216  * Return true if the timer interrupt should not be checked
217  */
218 static inline int handle_perf_irq (int r2)
219 {
220         /*
221          * The performance counter overflow interrupt may be shared with the
222          * timer interrupt (cp0_perfcount_irq < 0). If it is and a
223          * performance counter has overflowed (perf_irq() == IRQ_HANDLED)
224          * and we can't reliably determine if a counter interrupt has also
225          * happened (!r2) then don't check for a timer interrupt.
226          */
227         return (cp0_perfcount_irq < 0) &&
228                 perf_irq() == IRQ_HANDLED &&
229                 !r2;
230 }
231
232 asmlinkage void ll_timer_interrupt(int irq)
233 {
234         int r2 = cpu_has_mips_r2;
235
236         irq_enter();
237         kstat_this_cpu.irqs[irq]++;
238
239         if (handle_perf_irq(r2))
240                 goto out;
241
242         if (r2 && ((read_c0_cause() & (1 << 30)) == 0))
243                 goto out;
244
245         timer_interrupt(irq, NULL);
246
247 out:
248         irq_exit();
249 }
250
251 asmlinkage void ll_local_timer_interrupt(int irq)
252 {
253         irq_enter();
254         if (smp_processor_id() != 0)
255                 kstat_this_cpu.irqs[irq]++;
256
257         /* we keep interrupt disabled all the time */
258         local_timer_interrupt(irq, NULL);
259
260         irq_exit();
261 }
262
263 /*
264  * time_init() - it does the following things.
265  *
266  * 1) board_time_init() -
267  *      a) (optional) set up RTC routines,
268  *      b) (optional) calibrate and set the mips_hpt_frequency
269  *          (only needed if you intended to use cpu counter as timer interrupt
270  *           source)
271  * 2) setup xtime based on rtc_mips_get_time().
272  * 3) calculate a couple of cached variables for later usage
273  * 4) plat_timer_setup() -
274  *      a) (optional) over-write any choices made above by time_init().
275  *      b) machine specific code should setup the timer irqaction.
276  *      c) enable the timer interrupt
277  */
278
279 void (*board_time_init)(void);
280
281 unsigned int mips_hpt_frequency;
282
283 static struct irqaction timer_irqaction = {
284         .handler = timer_interrupt,
285         .flags = IRQF_DISABLED | IRQF_PERCPU,
286         .name = "timer",
287 };
288
289 static unsigned int __init calibrate_hpt(void)
290 {
291         cycle_t frequency, hpt_start, hpt_end, hpt_count, hz;
292
293         const int loops = HZ / 10;
294         int log_2_loops = 0;
295         int i;
296
297         /*
298          * We want to calibrate for 0.1s, but to avoid a 64-bit
299          * division we round the number of loops up to the nearest
300          * power of 2.
301          */
302         while (loops > 1 << log_2_loops)
303                 log_2_loops++;
304         i = 1 << log_2_loops;
305
306         /*
307          * Wait for a rising edge of the timer interrupt.
308          */
309         while (mips_timer_state());
310         while (!mips_timer_state());
311
312         /*
313          * Now see how many high precision timer ticks happen
314          * during the calculated number of periods between timer
315          * interrupts.
316          */
317         hpt_start = clocksource_mips.read();
318         do {
319                 while (mips_timer_state());
320                 while (!mips_timer_state());
321         } while (--i);
322         hpt_end = clocksource_mips.read();
323
324         hpt_count = (hpt_end - hpt_start) & clocksource_mips.mask;
325         hz = HZ;
326         frequency = hpt_count * hz;
327
328         return frequency >> log_2_loops;
329 }
330
331 struct clocksource clocksource_mips = {
332         .name           = "MIPS",
333         .mask           = CLOCKSOURCE_MASK(32),
334         .flags          = CLOCK_SOURCE_IS_CONTINUOUS,
335 };
336
337 static void __init init_mips_clocksource(void)
338 {
339         u64 temp;
340         u32 shift;
341
342         if (!mips_hpt_frequency || clocksource_mips.read == null_hpt_read)
343                 return;
344
345         /* Calclate a somewhat reasonable rating value */
346         clocksource_mips.rating = 200 + mips_hpt_frequency / 10000000;
347         /* Find a shift value */
348         for (shift = 32; shift > 0; shift--) {
349                 temp = (u64) NSEC_PER_SEC << shift;
350                 do_div(temp, mips_hpt_frequency);
351                 if ((temp >> 32) == 0)
352                         break;
353         }
354         clocksource_mips.shift = shift;
355         clocksource_mips.mult = (u32)temp;
356
357         clocksource_register(&clocksource_mips);
358 }
359
360 void __init time_init(void)
361 {
362         if (board_time_init)
363                 board_time_init();
364
365         if (!rtc_mips_set_mmss)
366                 rtc_mips_set_mmss = rtc_mips_set_time;
367
368         xtime.tv_sec = rtc_mips_get_time();
369         xtime.tv_nsec = 0;
370
371         set_normalized_timespec(&wall_to_monotonic,
372                                 -xtime.tv_sec, -xtime.tv_nsec);
373
374         /* Choose appropriate high precision timer routines.  */
375         if (!cpu_has_counter && !clocksource_mips.read)
376                 /* No high precision timer -- sorry.  */
377                 clocksource_mips.read = null_hpt_read;
378         else if (!mips_hpt_frequency && !mips_timer_state) {
379                 /* A high precision timer of unknown frequency.  */
380                 if (!clocksource_mips.read)
381                         /* No external high precision timer -- use R4k.  */
382                         clocksource_mips.read = c0_hpt_read;
383         } else {
384                 /* We know counter frequency.  Or we can get it.  */
385                 if (!clocksource_mips.read) {
386                         /* No external high precision timer -- use R4k.  */
387                         clocksource_mips.read = c0_hpt_read;
388
389                         if (!mips_timer_state) {
390                                 /* No external timer interrupt -- use R4k.  */
391                                 mips_timer_ack = c0_timer_ack;
392                                 /* Calculate cache parameters.  */
393                                 cycles_per_jiffy =
394                                         (mips_hpt_frequency + HZ / 2) / HZ;
395                                 /*
396                                  * This sets up the high precision
397                                  * timer for the first interrupt.
398                                  */
399                                 c0_hpt_timer_init();
400                         }
401                 }
402                 if (!mips_hpt_frequency)
403                         mips_hpt_frequency = calibrate_hpt();
404
405                 /* Report the high precision timer rate for a reference.  */
406                 printk("Using %u.%03u MHz high precision timer.\n",
407                        ((mips_hpt_frequency + 500) / 1000) / 1000,
408                        ((mips_hpt_frequency + 500) / 1000) % 1000);
409         }
410
411         if (!mips_timer_ack)
412                 /* No timer interrupt ack (e.g. i8254).  */
413                 mips_timer_ack = null_timer_ack;
414
415         /*
416          * Call board specific timer interrupt setup.
417          *
418          * this pointer must be setup in machine setup routine.
419          *
420          * Even if a machine chooses to use a low-level timer interrupt,
421          * it still needs to setup the timer_irqaction.
422          * In that case, it might be better to set timer_irqaction.handler
423          * to be NULL function so that we are sure the high-level code
424          * is not invoked accidentally.
425          */
426         plat_timer_setup(&timer_irqaction);
427
428         init_mips_clocksource();
429 }
430
431 #define FEBRUARY                2
432 #define STARTOFTIME             1970
433 #define SECDAY                  86400L
434 #define SECYR                   (SECDAY * 365)
435 #define leapyear(y)             ((!((y) % 4) && ((y) % 100)) || !((y) % 400))
436 #define days_in_year(y)         (leapyear(y) ? 366 : 365)
437 #define days_in_month(m)        (month_days[(m) - 1])
438
439 static int month_days[12] = {
440         31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31
441 };
442
443 void to_tm(unsigned long tim, struct rtc_time *tm)
444 {
445         long hms, day, gday;
446         int i;
447
448         gday = day = tim / SECDAY;
449         hms = tim % SECDAY;
450
451         /* Hours, minutes, seconds are easy */
452         tm->tm_hour = hms / 3600;
453         tm->tm_min = (hms % 3600) / 60;
454         tm->tm_sec = (hms % 3600) % 60;
455
456         /* Number of years in days */
457         for (i = STARTOFTIME; day >= days_in_year(i); i++)
458                 day -= days_in_year(i);
459         tm->tm_year = i;
460
461         /* Number of months in days left */
462         if (leapyear(tm->tm_year))
463                 days_in_month(FEBRUARY) = 29;
464         for (i = 1; day >= days_in_month(i); i++)
465                 day -= days_in_month(i);
466         days_in_month(FEBRUARY) = 28;
467         tm->tm_mon = i - 1;             /* tm_mon starts from 0 to 11 */
468
469         /* Days are what is left over (+1) from all that. */
470         tm->tm_mday = day + 1;
471
472         /*
473          * Determine the day of week
474          */
475         tm->tm_wday = (gday + 4) % 7;   /* 1970/1/1 was Thursday */
476 }
477
478 EXPORT_SYMBOL(rtc_lock);
479 EXPORT_SYMBOL(to_tm);
480 EXPORT_SYMBOL(rtc_mips_set_time);
481 EXPORT_SYMBOL(rtc_mips_get_time);