[PATCH] add suspend/resume for timer
[linux-2.6.git] / arch / i386 / kernel / time.c
1 /*
2  *  linux/arch/i386/kernel/time.c
3  *
4  *  Copyright (C) 1991, 1992, 1995  Linus Torvalds
5  *
6  * This file contains the PC-specific time handling details:
7  * reading the RTC at bootup, etc..
8  * 1994-07-02    Alan Modra
9  *      fixed set_rtc_mmss, fixed time.year for >= 2000, new mktime
10  * 1995-03-26    Markus Kuhn
11  *      fixed 500 ms bug at call to set_rtc_mmss, fixed DS12887
12  *      precision CMOS clock update
13  * 1996-05-03    Ingo Molnar
14  *      fixed time warps in do_[slow|fast]_gettimeoffset()
15  * 1997-09-10   Updated NTP code according to technical memorandum Jan '96
16  *              "A Kernel Model for Precision Timekeeping" by Dave Mills
17  * 1998-09-05    (Various)
18  *      More robust do_fast_gettimeoffset() algorithm implemented
19  *      (works with APM, Cyrix 6x86MX and Centaur C6),
20  *      monotonic gettimeofday() with fast_get_timeoffset(),
21  *      drift-proof precision TSC calibration on boot
22  *      (C. Scott Ananian <cananian@alumni.princeton.edu>, Andrew D.
23  *      Balsa <andrebalsa@altern.org>, Philip Gladstone <philip@raptor.com>;
24  *      ported from 2.0.35 Jumbo-9 by Michael Krause <m.krause@tu-harburg.de>).
25  * 1998-12-16    Andrea Arcangeli
26  *      Fixed Jumbo-9 code in 2.1.131: do_gettimeofday was missing 1 jiffy
27  *      because was not accounting lost_ticks.
28  * 1998-12-24 Copyright (C) 1998  Andrea Arcangeli
29  *      Fixed a xtime SMP race (we need the xtime_lock rw spinlock to
30  *      serialize accesses to xtime/lost_ticks).
31  */
32
33 #include <linux/errno.h>
34 #include <linux/sched.h>
35 #include <linux/kernel.h>
36 #include <linux/param.h>
37 #include <linux/string.h>
38 #include <linux/mm.h>
39 #include <linux/interrupt.h>
40 #include <linux/time.h>
41 #include <linux/delay.h>
42 #include <linux/init.h>
43 #include <linux/smp.h>
44 #include <linux/module.h>
45 #include <linux/sysdev.h>
46 #include <linux/bcd.h>
47 #include <linux/efi.h>
48 #include <linux/mca.h>
49
50 #include <asm/io.h>
51 #include <asm/smp.h>
52 #include <asm/irq.h>
53 #include <asm/msr.h>
54 #include <asm/delay.h>
55 #include <asm/mpspec.h>
56 #include <asm/uaccess.h>
57 #include <asm/processor.h>
58 #include <asm/timer.h>
59
60 #include "mach_time.h"
61
62 #include <linux/timex.h>
63 #include <linux/config.h>
64
65 #include <asm/hpet.h>
66
67 #include <asm/arch_hooks.h>
68
69 #include "io_ports.h"
70
71 #include <asm/i8259.h>
72
73 int pit_latch_buggy;              /* extern */
74
75 #include "do_timer.h"
76
77 u64 jiffies_64 = INITIAL_JIFFIES;
78
79 EXPORT_SYMBOL(jiffies_64);
80
81 unsigned int cpu_khz;   /* Detected as we calibrate the TSC */
82 EXPORT_SYMBOL(cpu_khz);
83
84 extern unsigned long wall_jiffies;
85
86 DEFINE_SPINLOCK(rtc_lock);
87 EXPORT_SYMBOL(rtc_lock);
88
89 #include <asm/i8253.h>
90
91 DEFINE_SPINLOCK(i8253_lock);
92 EXPORT_SYMBOL(i8253_lock);
93
94 struct timer_opts *cur_timer __read_mostly = &timer_none;
95
96 /*
97  * This is a special lock that is owned by the CPU and holds the index
98  * register we are working with.  It is required for NMI access to the
99  * CMOS/RTC registers.  See include/asm-i386/mc146818rtc.h for details.
100  */
101 volatile unsigned long cmos_lock = 0;
102 EXPORT_SYMBOL(cmos_lock);
103
104 /* Routines for accessing the CMOS RAM/RTC. */
105 unsigned char rtc_cmos_read(unsigned char addr)
106 {
107         unsigned char val;
108         lock_cmos_prefix(addr);
109         outb_p(addr, RTC_PORT(0));
110         val = inb_p(RTC_PORT(1));
111         lock_cmos_suffix(addr);
112         return val;
113 }
114 EXPORT_SYMBOL(rtc_cmos_read);
115
116 void rtc_cmos_write(unsigned char val, unsigned char addr)
117 {
118         lock_cmos_prefix(addr);
119         outb_p(addr, RTC_PORT(0));
120         outb_p(val, RTC_PORT(1));
121         lock_cmos_suffix(addr);
122 }
123 EXPORT_SYMBOL(rtc_cmos_write);
124
125 /*
126  * This version of gettimeofday has microsecond resolution
127  * and better than microsecond precision on fast x86 machines with TSC.
128  */
129 void do_gettimeofday(struct timeval *tv)
130 {
131         unsigned long seq;
132         unsigned long usec, sec;
133         unsigned long max_ntp_tick;
134
135         do {
136                 unsigned long lost;
137
138                 seq = read_seqbegin(&xtime_lock);
139
140                 usec = cur_timer->get_offset();
141                 lost = jiffies - wall_jiffies;
142
143                 /*
144                  * If time_adjust is negative then NTP is slowing the clock
145                  * so make sure not to go into next possible interval.
146                  * Better to lose some accuracy than have time go backwards..
147                  */
148                 if (unlikely(time_adjust < 0)) {
149                         max_ntp_tick = (USEC_PER_SEC / HZ) - tickadj;
150                         usec = min(usec, max_ntp_tick);
151
152                         if (lost)
153                                 usec += lost * max_ntp_tick;
154                 }
155                 else if (unlikely(lost))
156                         usec += lost * (USEC_PER_SEC / HZ);
157
158                 sec = xtime.tv_sec;
159                 usec += (xtime.tv_nsec / 1000);
160         } while (read_seqretry(&xtime_lock, seq));
161
162         while (usec >= 1000000) {
163                 usec -= 1000000;
164                 sec++;
165         }
166
167         tv->tv_sec = sec;
168         tv->tv_usec = usec;
169 }
170
171 EXPORT_SYMBOL(do_gettimeofday);
172
173 int do_settimeofday(struct timespec *tv)
174 {
175         time_t wtm_sec, sec = tv->tv_sec;
176         long wtm_nsec, nsec = tv->tv_nsec;
177
178         if ((unsigned long)tv->tv_nsec >= NSEC_PER_SEC)
179                 return -EINVAL;
180
181         write_seqlock_irq(&xtime_lock);
182         /*
183          * This is revolting. We need to set "xtime" correctly. However, the
184          * value in this location is the value at the most recent update of
185          * wall time.  Discover what correction gettimeofday() would have
186          * made, and then undo it!
187          */
188         nsec -= cur_timer->get_offset() * NSEC_PER_USEC;
189         nsec -= (jiffies - wall_jiffies) * TICK_NSEC;
190
191         wtm_sec  = wall_to_monotonic.tv_sec + (xtime.tv_sec - sec);
192         wtm_nsec = wall_to_monotonic.tv_nsec + (xtime.tv_nsec - nsec);
193
194         set_normalized_timespec(&xtime, sec, nsec);
195         set_normalized_timespec(&wall_to_monotonic, wtm_sec, wtm_nsec);
196
197         time_adjust = 0;                /* stop active adjtime() */
198         time_status |= STA_UNSYNC;
199         time_maxerror = NTP_PHASE_LIMIT;
200         time_esterror = NTP_PHASE_LIMIT;
201         write_sequnlock_irq(&xtime_lock);
202         clock_was_set();
203         return 0;
204 }
205
206 EXPORT_SYMBOL(do_settimeofday);
207
208 static int set_rtc_mmss(unsigned long nowtime)
209 {
210         int retval;
211
212         WARN_ON(irqs_disabled());
213
214         /* gets recalled with irq locally disabled */
215         spin_lock_irq(&rtc_lock);
216         if (efi_enabled)
217                 retval = efi_set_rtc_mmss(nowtime);
218         else
219                 retval = mach_set_rtc_mmss(nowtime);
220         spin_unlock_irq(&rtc_lock);
221
222         return retval;
223 }
224
225
226 int timer_ack;
227
228 /* monotonic_clock(): returns # of nanoseconds passed since time_init()
229  *              Note: This function is required to return accurate
230  *              time even in the absence of multiple timer ticks.
231  */
232 unsigned long long monotonic_clock(void)
233 {
234         return cur_timer->monotonic_clock();
235 }
236 EXPORT_SYMBOL(monotonic_clock);
237
238 #if defined(CONFIG_SMP) && defined(CONFIG_FRAME_POINTER)
239 unsigned long profile_pc(struct pt_regs *regs)
240 {
241         unsigned long pc = instruction_pointer(regs);
242
243         if (in_lock_functions(pc))
244                 return *(unsigned long *)(regs->ebp + 4);
245
246         return pc;
247 }
248 EXPORT_SYMBOL(profile_pc);
249 #endif
250
251 /*
252  * timer_interrupt() needs to keep up the real-time clock,
253  * as well as call the "do_timer()" routine every clocktick
254  */
255 static inline void do_timer_interrupt(int irq, void *dev_id,
256                                         struct pt_regs *regs)
257 {
258 #ifdef CONFIG_X86_IO_APIC
259         if (timer_ack) {
260                 /*
261                  * Subtle, when I/O APICs are used we have to ack timer IRQ
262                  * manually to reset the IRR bit for do_slow_gettimeoffset().
263                  * This will also deassert NMI lines for the watchdog if run
264                  * on an 82489DX-based system.
265                  */
266                 spin_lock(&i8259A_lock);
267                 outb(0x0c, PIC_MASTER_OCW3);
268                 /* Ack the IRQ; AEOI will end it automatically. */
269                 inb(PIC_MASTER_POLL);
270                 spin_unlock(&i8259A_lock);
271         }
272 #endif
273
274         do_timer_interrupt_hook(regs);
275
276
277         if (MCA_bus) {
278                 /* The PS/2 uses level-triggered interrupts.  You can't
279                 turn them off, nor would you want to (any attempt to
280                 enable edge-triggered interrupts usually gets intercepted by a
281                 special hardware circuit).  Hence we have to acknowledge
282                 the timer interrupt.  Through some incredibly stupid
283                 design idea, the reset for IRQ 0 is done by setting the
284                 high bit of the PPI port B (0x61).  Note that some PS/2s,
285                 notably the 55SX, work fine if this is removed.  */
286
287                 irq = inb_p( 0x61 );    /* read the current state */
288                 outb_p( irq|0x80, 0x61 );       /* reset the IRQ */
289         }
290 }
291
292 /*
293  * This is the same as the above, except we _also_ save the current
294  * Time Stamp Counter value at the time of the timer interrupt, so that
295  * we later on can estimate the time of day more exactly.
296  */
297 irqreturn_t timer_interrupt(int irq, void *dev_id, struct pt_regs *regs)
298 {
299         /*
300          * Here we are in the timer irq handler. We just have irqs locally
301          * disabled but we don't know if the timer_bh is running on the other
302          * CPU. We need to avoid to SMP race with it. NOTE: we don' t need
303          * the irq version of write_lock because as just said we have irq
304          * locally disabled. -arca
305          */
306         write_seqlock(&xtime_lock);
307
308         cur_timer->mark_offset();
309  
310         do_timer_interrupt(irq, NULL, regs);
311
312         write_sequnlock(&xtime_lock);
313         return IRQ_HANDLED;
314 }
315
316 /* not static: needed by APM */
317 unsigned long get_cmos_time(void)
318 {
319         unsigned long retval;
320
321         spin_lock(&rtc_lock);
322
323         if (efi_enabled)
324                 retval = efi_get_time();
325         else
326                 retval = mach_get_cmos_time();
327
328         spin_unlock(&rtc_lock);
329
330         return retval;
331 }
332 EXPORT_SYMBOL(get_cmos_time);
333
334 static void sync_cmos_clock(unsigned long dummy);
335
336 static struct timer_list sync_cmos_timer =
337                                       TIMER_INITIALIZER(sync_cmos_clock, 0, 0);
338
339 static void sync_cmos_clock(unsigned long dummy)
340 {
341         struct timeval now, next;
342         int fail = 1;
343
344         /*
345          * If we have an externally synchronized Linux clock, then update
346          * CMOS clock accordingly every ~11 minutes. Set_rtc_mmss() has to be
347          * called as close as possible to 500 ms before the new second starts.
348          * This code is run on a timer.  If the clock is set, that timer
349          * may not expire at the correct time.  Thus, we adjust...
350          */
351         if ((time_status & STA_UNSYNC) != 0)
352                 /*
353                  * Not synced, exit, do not restart a timer (if one is
354                  * running, let it run out).
355                  */
356                 return;
357
358         do_gettimeofday(&now);
359         if (now.tv_usec >= USEC_AFTER - ((unsigned) TICK_SIZE) / 2 &&
360             now.tv_usec <= USEC_BEFORE + ((unsigned) TICK_SIZE) / 2)
361                 fail = set_rtc_mmss(now.tv_sec);
362
363         next.tv_usec = USEC_AFTER - now.tv_usec;
364         if (next.tv_usec <= 0)
365                 next.tv_usec += USEC_PER_SEC;
366
367         if (!fail)
368                 next.tv_sec = 659;
369         else
370                 next.tv_sec = 0;
371
372         if (next.tv_usec >= USEC_PER_SEC) {
373                 next.tv_sec++;
374                 next.tv_usec -= USEC_PER_SEC;
375         }
376         mod_timer(&sync_cmos_timer, jiffies + timeval_to_jiffies(&next));
377 }
378
379 void notify_arch_cmos_timer(void)
380 {
381         mod_timer(&sync_cmos_timer, jiffies + 1);
382 }
383
384 static long clock_cmos_diff, sleep_start;
385
386 static struct timer_opts *last_timer;
387 static int timer_suspend(struct sys_device *dev, pm_message_t state)
388 {
389         /*
390          * Estimate time zone so that set_time can update the clock
391          */
392         clock_cmos_diff = -get_cmos_time();
393         clock_cmos_diff += get_seconds();
394         sleep_start = get_cmos_time();
395         last_timer = cur_timer;
396         cur_timer = &timer_none;
397         if (last_timer->suspend)
398                 last_timer->suspend(state);
399         return 0;
400 }
401
402 static int timer_resume(struct sys_device *dev)
403 {
404         unsigned long flags;
405         unsigned long sec;
406         unsigned long sleep_length;
407
408 #ifdef CONFIG_HPET_TIMER
409         if (is_hpet_enabled())
410                 hpet_reenable();
411 #endif
412         setup_pit_timer();
413         sec = get_cmos_time() + clock_cmos_diff;
414         sleep_length = (get_cmos_time() - sleep_start) * HZ;
415         write_seqlock_irqsave(&xtime_lock, flags);
416         xtime.tv_sec = sec;
417         xtime.tv_nsec = 0;
418         write_sequnlock_irqrestore(&xtime_lock, flags);
419         jiffies += sleep_length;
420         wall_jiffies += sleep_length;
421         if (last_timer->resume)
422                 last_timer->resume();
423         cur_timer = last_timer;
424         last_timer = NULL;
425         return 0;
426 }
427
428 static struct sysdev_class timer_sysclass = {
429         .resume = timer_resume,
430         .suspend = timer_suspend,
431         set_kset_name("timer"),
432 };
433
434
435 /* XXX this driverfs stuff should probably go elsewhere later -john */
436 static struct sys_device device_timer = {
437         .id     = 0,
438         .cls    = &timer_sysclass,
439 };
440
441 static int time_init_device(void)
442 {
443         int error = sysdev_class_register(&timer_sysclass);
444         if (!error)
445                 error = sysdev_register(&device_timer);
446         return error;
447 }
448
449 device_initcall(time_init_device);
450
451 #ifdef CONFIG_HPET_TIMER
452 extern void (*late_time_init)(void);
453 /* Duplicate of time_init() below, with hpet_enable part added */
454 static void __init hpet_time_init(void)
455 {
456         xtime.tv_sec = get_cmos_time();
457         xtime.tv_nsec = (INITIAL_JIFFIES % HZ) * (NSEC_PER_SEC / HZ);
458         set_normalized_timespec(&wall_to_monotonic,
459                 -xtime.tv_sec, -xtime.tv_nsec);
460
461         if ((hpet_enable() >= 0) && hpet_use_timer) {
462                 printk("Using HPET for base-timer\n");
463         }
464
465         cur_timer = select_timer();
466         printk(KERN_INFO "Using %s for high-res timesource\n",cur_timer->name);
467
468         time_init_hook();
469 }
470 #endif
471
472 void __init time_init(void)
473 {
474 #ifdef CONFIG_HPET_TIMER
475         if (is_hpet_capable()) {
476                 /*
477                  * HPET initialization needs to do memory-mapped io. So, let
478                  * us do a late initialization after mem_init().
479                  */
480                 late_time_init = hpet_time_init;
481                 return;
482         }
483 #endif
484         xtime.tv_sec = get_cmos_time();
485         xtime.tv_nsec = (INITIAL_JIFFIES % HZ) * (NSEC_PER_SEC / HZ);
486         set_normalized_timespec(&wall_to_monotonic,
487                 -xtime.tv_sec, -xtime.tv_nsec);
488
489         cur_timer = select_timer();
490         printk(KERN_INFO "Using %s for high-res timesource\n",cur_timer->name);
491
492         time_init_hook();
493 }