[PATCH] jiffies_64 cleanup
[linux-3.10.git] / arch / ppc / kernel / time.c
1 /*
2  * Common time routines among all ppc machines.
3  *
4  * Written by Cort Dougan (cort@cs.nmt.edu) to merge
5  * Paul Mackerras' version and mine for PReP and Pmac.
6  * MPC8xx/MBX changes by Dan Malek (dmalek@jlc.net).
7  *
8  * First round of bugfixes by Gabriel Paubert (paubert@iram.es)
9  * to make clock more stable (2.4.0-test5). The only thing
10  * that this code assumes is that the timebases have been synchronized
11  * by firmware on SMP and are never stopped (never do sleep
12  * on SMP then, nap and doze are OK).
13  *
14  * TODO (not necessarily in this file):
15  * - improve precision and reproducibility of timebase frequency
16  * measurement at boot time.
17  * - get rid of xtime_lock for gettimeofday (generic kernel problem
18  * to be implemented on all architectures for SMP scalability and
19  * eventually implementing gettimeofday without entering the kernel).
20  * - put all time/clock related variables in a single structure
21  * to minimize number of cache lines touched by gettimeofday()
22  * - for astronomical applications: add a new function to get
23  * non ambiguous timestamps even around leap seconds. This needs
24  * a new timestamp format and a good name.
25  *
26  *
27  * The following comment is partially obsolete (at least the long wait
28  * is no more a valid reason):
29  * Since the MPC8xx has a programmable interrupt timer, I decided to
30  * use that rather than the decrementer.  Two reasons: 1.) the clock
31  * frequency is low, causing 2.) a long wait in the timer interrupt
32  *              while ((d = get_dec()) == dval)
33  * loop.  The MPC8xx can be driven from a variety of input clocks,
34  * so a number of assumptions have been made here because the kernel
35  * parameter HZ is a constant.  We assume (correctly, today :-) that
36  * the MPC8xx on the MBX board is driven from a 32.768 kHz crystal.
37  * This is then divided by 4, providing a 8192 Hz clock into the PIT.
38  * Since it is not possible to get a nice 100 Hz clock out of this, without
39  * creating a software PLL, I have set HZ to 128.  -- Dan
40  *
41  * 1997-09-10  Updated NTP code according to technical memorandum Jan '96
42  *             "A Kernel Model for Precision Timekeeping" by Dave Mills
43  */
44
45 #include <linux/config.h>
46 #include <linux/errno.h>
47 #include <linux/sched.h>
48 #include <linux/kernel.h>
49 #include <linux/param.h>
50 #include <linux/string.h>
51 #include <linux/mm.h>
52 #include <linux/module.h>
53 #include <linux/interrupt.h>
54 #include <linux/timex.h>
55 #include <linux/kernel_stat.h>
56 #include <linux/mc146818rtc.h>
57 #include <linux/time.h>
58 #include <linux/init.h>
59 #include <linux/profile.h>
60
61 #include <asm/io.h>
62 #include <asm/nvram.h>
63 #include <asm/cache.h>
64 #include <asm/8xx_immap.h>
65 #include <asm/machdep.h>
66
67 #include <asm/time.h>
68
69 unsigned long disarm_decr[NR_CPUS];
70
71 extern struct timezone sys_tz;
72
73 /* keep track of when we need to update the rtc */
74 time_t last_rtc_update;
75
76 /* The decrementer counts down by 128 every 128ns on a 601. */
77 #define DECREMENTER_COUNT_601   (1000000000 / HZ)
78
79 unsigned tb_ticks_per_jiffy;
80 unsigned tb_to_us;
81 unsigned tb_last_stamp;
82 unsigned long tb_to_ns_scale;
83
84 extern unsigned long wall_jiffies;
85
86 /* used for timezone offset */
87 static long timezone_offset;
88
89 DEFINE_SPINLOCK(rtc_lock);
90
91 EXPORT_SYMBOL(rtc_lock);
92
93 /* Timer interrupt helper function */
94 static inline int tb_delta(unsigned *jiffy_stamp) {
95         int delta;
96         if (__USE_RTC()) {
97                 delta = get_rtcl();
98                 if (delta < *jiffy_stamp) *jiffy_stamp -= 1000000000;
99                 delta -= *jiffy_stamp;
100         } else {
101                 delta = get_tbl() - *jiffy_stamp;
102         }
103         return delta;
104 }
105
106 #ifdef CONFIG_SMP
107 unsigned long profile_pc(struct pt_regs *regs)
108 {
109         unsigned long pc = instruction_pointer(regs);
110
111         if (in_lock_functions(pc))
112                 return regs->link;
113
114         return pc;
115 }
116 EXPORT_SYMBOL(profile_pc);
117 #endif
118
119 /*
120  * timer_interrupt - gets called when the decrementer overflows,
121  * with interrupts disabled.
122  * We set it up to overflow again in 1/HZ seconds.
123  */
124 void timer_interrupt(struct pt_regs * regs)
125 {
126         int next_dec;
127         unsigned long cpu = smp_processor_id();
128         unsigned jiffy_stamp = last_jiffy_stamp(cpu);
129         extern void do_IRQ(struct pt_regs *);
130
131         if (atomic_read(&ppc_n_lost_interrupts) != 0)
132                 do_IRQ(regs);
133
134         irq_enter();
135
136         while ((next_dec = tb_ticks_per_jiffy - tb_delta(&jiffy_stamp)) <= 0) {
137                 jiffy_stamp += tb_ticks_per_jiffy;
138                 
139                 profile_tick(CPU_PROFILING, regs);
140                 update_process_times(user_mode(regs));
141
142                 if (smp_processor_id())
143                         continue;
144
145                 /* We are in an interrupt, no need to save/restore flags */
146                 write_seqlock(&xtime_lock);
147                 tb_last_stamp = jiffy_stamp;
148                 do_timer(regs);
149
150                 /*
151                  * update the rtc when needed, this should be performed on the
152                  * right fraction of a second. Half or full second ?
153                  * Full second works on mk48t59 clocks, others need testing.
154                  * Note that this update is basically only used through
155                  * the adjtimex system calls. Setting the HW clock in
156                  * any other way is a /dev/rtc and userland business.
157                  * This is still wrong by -0.5/+1.5 jiffies because of the
158                  * timer interrupt resolution and possible delay, but here we
159                  * hit a quantization limit which can only be solved by higher
160                  * resolution timers and decoupling time management from timer
161                  * interrupts. This is also wrong on the clocks
162                  * which require being written at the half second boundary.
163                  * We should have an rtc call that only sets the minutes and
164                  * seconds like on Intel to avoid problems with non UTC clocks.
165                  */
166                 if ( ppc_md.set_rtc_time && ntp_synced() &&
167                      xtime.tv_sec - last_rtc_update >= 659 &&
168                      abs((xtime.tv_nsec / 1000) - (1000000-1000000/HZ)) < 500000/HZ &&
169                      jiffies - wall_jiffies == 1) {
170                         if (ppc_md.set_rtc_time(xtime.tv_sec+1 + timezone_offset) == 0)
171                                 last_rtc_update = xtime.tv_sec+1;
172                         else
173                                 /* Try again one minute later */
174                                 last_rtc_update += 60;
175                 }
176                 write_sequnlock(&xtime_lock);
177         }
178         if ( !disarm_decr[smp_processor_id()] )
179                 set_dec(next_dec);
180         last_jiffy_stamp(cpu) = jiffy_stamp;
181
182         if (ppc_md.heartbeat && !ppc_md.heartbeat_count--)
183                 ppc_md.heartbeat();
184
185         irq_exit();
186 }
187
188 /*
189  * This version of gettimeofday has microsecond resolution.
190  */
191 void do_gettimeofday(struct timeval *tv)
192 {
193         unsigned long flags;
194         unsigned long seq;
195         unsigned delta, lost_ticks, usec, sec;
196
197         do {
198                 seq = read_seqbegin_irqsave(&xtime_lock, flags);
199                 sec = xtime.tv_sec;
200                 usec = (xtime.tv_nsec / 1000);
201                 delta = tb_ticks_since(tb_last_stamp);
202 #ifdef CONFIG_SMP
203                 /* As long as timebases are not in sync, gettimeofday can only
204                  * have jiffy resolution on SMP.
205                  */
206                 if (!smp_tb_synchronized)
207                         delta = 0;
208 #endif /* CONFIG_SMP */
209                 lost_ticks = jiffies - wall_jiffies;
210         } while (read_seqretry_irqrestore(&xtime_lock, seq, flags));
211
212         usec += mulhwu(tb_to_us, tb_ticks_per_jiffy * lost_ticks + delta);
213         while (usec >= 1000000) {
214                 sec++;
215                 usec -= 1000000;
216         }
217         tv->tv_sec = sec;
218         tv->tv_usec = usec;
219 }
220
221 EXPORT_SYMBOL(do_gettimeofday);
222
223 int do_settimeofday(struct timespec *tv)
224 {
225         time_t wtm_sec, new_sec = tv->tv_sec;
226         long wtm_nsec, new_nsec = tv->tv_nsec;
227         unsigned long flags;
228         int tb_delta;
229
230         if ((unsigned long)tv->tv_nsec >= NSEC_PER_SEC)
231                 return -EINVAL;
232
233         write_seqlock_irqsave(&xtime_lock, flags);
234         /* Updating the RTC is not the job of this code. If the time is
235          * stepped under NTP, the RTC will be update after STA_UNSYNC
236          * is cleared. Tool like clock/hwclock either copy the RTC
237          * to the system time, in which case there is no point in writing
238          * to the RTC again, or write to the RTC but then they don't call
239          * settimeofday to perform this operation. Note also that
240          * we don't touch the decrementer since:
241          * a) it would lose timer interrupt synchronization on SMP
242          * (if it is working one day)
243          * b) it could make one jiffy spuriously shorter or longer
244          * which would introduce another source of uncertainty potentially
245          * harmful to relatively short timers.
246          */
247
248         /* This works perfectly on SMP only if the tb are in sync but
249          * guarantees an error < 1 jiffy even if they are off by eons,
250          * still reasonable when gettimeofday resolution is 1 jiffy.
251          */
252         tb_delta = tb_ticks_since(last_jiffy_stamp(smp_processor_id()));
253         tb_delta += (jiffies - wall_jiffies) * tb_ticks_per_jiffy;
254
255         new_nsec -= 1000 * mulhwu(tb_to_us, tb_delta);
256
257         wtm_sec  = wall_to_monotonic.tv_sec + (xtime.tv_sec - new_sec);
258         wtm_nsec = wall_to_monotonic.tv_nsec + (xtime.tv_nsec - new_nsec);
259
260         set_normalized_timespec(&xtime, new_sec, new_nsec);
261         set_normalized_timespec(&wall_to_monotonic, wtm_sec, wtm_nsec);
262
263         /* In case of a large backwards jump in time with NTP, we want the
264          * clock to be updated as soon as the PLL is again in lock.
265          */
266         last_rtc_update = new_sec - 658;
267
268         ntp_clear();
269         write_sequnlock_irqrestore(&xtime_lock, flags);
270         clock_was_set();
271         return 0;
272 }
273
274 EXPORT_SYMBOL(do_settimeofday);
275
276 /* This function is only called on the boot processor */
277 void __init time_init(void)
278 {
279         time_t sec, old_sec;
280         unsigned old_stamp, stamp, elapsed;
281
282         if (ppc_md.time_init != NULL)
283                 timezone_offset = ppc_md.time_init();
284
285         if (__USE_RTC()) {
286                 /* 601 processor: dec counts down by 128 every 128ns */
287                 tb_ticks_per_jiffy = DECREMENTER_COUNT_601;
288                 /* mulhwu_scale_factor(1000000000, 1000000) is 0x418937 */
289                 tb_to_us = 0x418937;
290         } else {
291                 ppc_md.calibrate_decr();
292                 tb_to_ns_scale = mulhwu(tb_to_us, 1000 << 10);
293         }
294
295         /* Now that the decrementer is calibrated, it can be used in case the
296          * clock is stuck, but the fact that we have to handle the 601
297          * makes things more complex. Repeatedly read the RTC until the
298          * next second boundary to try to achieve some precision.  If there
299          * is no RTC, we still need to set tb_last_stamp and
300          * last_jiffy_stamp(cpu 0) to the current stamp.
301          */
302         stamp = get_native_tbl();
303         if (ppc_md.get_rtc_time) {
304                 sec = ppc_md.get_rtc_time();
305                 elapsed = 0;
306                 do {
307                         old_stamp = stamp;
308                         old_sec = sec;
309                         stamp = get_native_tbl();
310                         if (__USE_RTC() && stamp < old_stamp)
311                                 old_stamp -= 1000000000;
312                         elapsed += stamp - old_stamp;
313                         sec = ppc_md.get_rtc_time();
314                 } while ( sec == old_sec && elapsed < 2*HZ*tb_ticks_per_jiffy);
315                 if (sec==old_sec)
316                         printk("Warning: real time clock seems stuck!\n");
317                 xtime.tv_sec = sec;
318                 xtime.tv_nsec = 0;
319                 /* No update now, we just read the time from the RTC ! */
320                 last_rtc_update = xtime.tv_sec;
321         }
322         last_jiffy_stamp(0) = tb_last_stamp = stamp;
323
324         /* Not exact, but the timer interrupt takes care of this */
325         set_dec(tb_ticks_per_jiffy);
326
327         /* If platform provided a timezone (pmac), we correct the time */
328         if (timezone_offset) {
329                 sys_tz.tz_minuteswest = -timezone_offset / 60;
330                 sys_tz.tz_dsttime = 0;
331                 xtime.tv_sec -= timezone_offset;
332         }
333         set_normalized_timespec(&wall_to_monotonic,
334                                 -xtime.tv_sec, -xtime.tv_nsec);
335 }
336
337 #define FEBRUARY                2
338 #define STARTOFTIME             1970
339 #define SECDAY                  86400L
340 #define SECYR                   (SECDAY * 365)
341
342 /*
343  * Note: this is wrong for 2100, but our signed 32-bit time_t will
344  * have overflowed long before that, so who cares.  -- paulus
345  */
346 #define leapyear(year)          ((year) % 4 == 0)
347 #define days_in_year(a)         (leapyear(a) ? 366 : 365)
348 #define days_in_month(a)        (month_days[(a) - 1])
349
350 static int month_days[12] = {
351         31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31
352 };
353
354 void to_tm(int tim, struct rtc_time * tm)
355 {
356         register int i;
357         register long hms, day, gday;
358
359         gday = day = tim / SECDAY;
360         hms = tim % SECDAY;
361
362         /* Hours, minutes, seconds are easy */
363         tm->tm_hour = hms / 3600;
364         tm->tm_min = (hms % 3600) / 60;
365         tm->tm_sec = (hms % 3600) % 60;
366
367         /* Number of years in days */
368         for (i = STARTOFTIME; day >= days_in_year(i); i++)
369                 day -= days_in_year(i);
370         tm->tm_year = i;
371
372         /* Number of months in days left */
373         if (leapyear(tm->tm_year))
374                 days_in_month(FEBRUARY) = 29;
375         for (i = 1; day >= days_in_month(i); i++)
376                 day -= days_in_month(i);
377         days_in_month(FEBRUARY) = 28;
378         tm->tm_mon = i;
379
380         /* Days are what is left over (+1) from all that. */
381         tm->tm_mday = day + 1;
382
383         /*
384          * Determine the day of week. Jan. 1, 1970 was a Thursday.
385          */
386         tm->tm_wday = (gday + 4) % 7;
387 }
388
389 /* Auxiliary function to compute scaling factors */
390 /* Actually the choice of a timebase running at 1/4 the of the bus
391  * frequency giving resolution of a few tens of nanoseconds is quite nice.
392  * It makes this computation very precise (27-28 bits typically) which
393  * is optimistic considering the stability of most processor clock
394  * oscillators and the precision with which the timebase frequency
395  * is measured but does not harm.
396  */
397 unsigned mulhwu_scale_factor(unsigned inscale, unsigned outscale) {
398         unsigned mlt=0, tmp, err;
399         /* No concern for performance, it's done once: use a stupid
400          * but safe and compact method to find the multiplier.
401          */
402         for (tmp = 1U<<31; tmp != 0; tmp >>= 1) {
403                 if (mulhwu(inscale, mlt|tmp) < outscale) mlt|=tmp;
404         }
405         /* We might still be off by 1 for the best approximation.
406          * A side effect of this is that if outscale is too large
407          * the returned value will be zero.
408          * Many corner cases have been checked and seem to work,
409          * some might have been forgotten in the test however.
410          */
411         err = inscale*(mlt+1);
412         if (err <= inscale/2) mlt++;
413         return mlt;
414 }
415
416 unsigned long long sched_clock(void)
417 {
418         unsigned long lo, hi, hi2;
419         unsigned long long tb;
420
421         if (!__USE_RTC()) {
422                 do {
423                         hi = get_tbu();
424                         lo = get_tbl();
425                         hi2 = get_tbu();
426                 } while (hi2 != hi);
427                 tb = ((unsigned long long) hi << 32) | lo;
428                 tb = (tb * tb_to_ns_scale) >> 10;
429         } else {
430                 do {
431                         hi = get_rtcu();
432                         lo = get_rtcl();
433                         hi2 = get_rtcu();
434                 } while (hi2 != hi);
435                 tb = ((unsigned long long) hi) * 1000000000 + lo;
436         }
437         return tb;
438 }