Merge from vendor branch LESS:
[dragonfly.git] / sys / platform / pc32 / isa / clock.c
1 /*-
2  * Copyright (c) 1990 The Regents of the University of California.
3  * All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * William Jolitz and Don Ahn.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *      This product includes software developed by the University of
19  *      California, Berkeley and its contributors.
20  * 4. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  *      from: @(#)clock.c       7.2 (Berkeley) 5/12/91
37  * $FreeBSD: src/sys/i386/isa/clock.c,v 1.149.2.6 2002/11/02 04:41:50 iwasaki Exp $
38  * $DragonFly: src/sys/platform/pc32/isa/clock.c,v 1.53 2007/06/04 17:22:02 dillon Exp $
39  */
40
41 /*
42  * Routines to handle clock hardware.
43  */
44
45 /*
46  * inittodr, settodr and support routines written
47  * by Christoph Robitschko <chmr@edvz.tu-graz.ac.at>
48  *
49  * reintroduced and updated by Chris Stenton <chris@gnome.co.uk> 8/10/94
50  */
51
52 #include "use_apm.h"
53 #include "opt_clock.h"
54
55 #include <sys/param.h>
56 #include <sys/systm.h>
57 #include <sys/eventhandler.h>
58 #include <sys/time.h>
59 #include <sys/kernel.h>
60 #include <sys/bus.h>
61 #ifndef SMP
62 #include <sys/lock.h>
63 #endif
64 #include <sys/sysctl.h>
65 #include <sys/cons.h>
66 #include <sys/systimer.h>
67 #include <sys/globaldata.h>
68 #include <sys/thread2.h>
69 #include <sys/systimer.h>
70 #include <sys/machintr.h>
71
72 #include <machine/clock.h>
73 #ifdef CLK_CALIBRATION_LOOP
74 #endif
75 #include <machine/cputypes.h>
76 #include <machine/frame.h>
77 #include <machine/ipl.h>
78 #include <machine/limits.h>
79 #include <machine/md_var.h>
80 #include <machine/psl.h>
81 #include <machine/segments.h>
82 #include <machine/smp.h>
83 #include <machine/specialreg.h>
84
85 #include <machine_base/icu/icu.h>
86 #include <bus/isa/i386/isa.h>
87 #include <bus/isa/rtc.h>
88 #include <machine_base/isa/timerreg.h>
89
90 #include <machine_base/isa/intr_machdep.h>
91
92 #ifdef APIC_IO
93 /* The interrupt triggered by the 8254 (timer) chip */
94 int apic_8254_intr;
95 static void setup_8254_mixed_mode (void);
96 #endif
97 static void i8254_restore(void);
98 static void resettodr_on_shutdown(void *arg __unused);
99
100 /*
101  * 32-bit time_t's can't reach leap years before 1904 or after 2036, so we
102  * can use a simple formula for leap years.
103  */
104 #define LEAPYEAR(y) ((u_int)(y) % 4 == 0)
105 #define DAYSPERYEAR   (31+28+31+30+31+30+31+31+30+31+30+31)
106
107 #ifndef TIMER_FREQ
108 #define TIMER_FREQ   1193182
109 #endif
110
111 static uint8_t i8254_walltimer_sel;
112 static uint16_t i8254_walltimer_cntr;
113
114 int     adjkerntz;              /* local offset from GMT in seconds */
115 int     disable_rtc_set;        /* disable resettodr() if != 0 */
116 int     statclock_disable = 1;  /* we don't use the statclock right now */
117 int     tsc_present;
118 u_int   tsc_freq;               /* XXX obsolete, convert users */
119 int64_t tsc_frequency;
120 int     tsc_is_broken;
121 int     wall_cmos_clock;        /* wall CMOS clock assumed if != 0 */
122 int     timer0_running;
123 enum tstate { RELEASED, ACQUIRED };
124 enum tstate timer0_state;
125 enum tstate timer1_state;
126 enum tstate timer2_state;
127
128 static  int     beeping = 0;
129 static  const u_char daysinmonth[] = {31,28,31,30,31,30,31,31,30,31,30,31};
130 static  u_char  rtc_statusa = RTCSA_DIVIDER | RTCSA_NOPROF;
131 static  u_char  rtc_statusb = RTCSB_24HR | RTCSB_PINTR;
132 static  int     rtc_loaded;
133
134 static int i8254_cputimer_div;
135
136 static struct callout sysbeepstop_ch;
137
138 static sysclock_t i8254_cputimer_count(void);
139 static void i8254_cputimer_construct(struct cputimer *cputimer, sysclock_t last);
140 static void i8254_cputimer_destruct(struct cputimer *cputimer);
141
142 static struct cputimer  i8254_cputimer = {
143     SLIST_ENTRY_INITIALIZER,
144     "i8254",
145     CPUTIMER_PRI_8254,
146     0,
147     i8254_cputimer_count,
148     cputimer_default_fromhz,
149     cputimer_default_fromus,
150     i8254_cputimer_construct,
151     i8254_cputimer_destruct,
152     TIMER_FREQ,
153     0, 0, 0
154 };
155
156 /*
157  * timer0 clock interrupt.  Timer0 is in one-shot mode and has stopped
158  * counting as of this interrupt.  We use timer1 in free-running mode (not
159  * generating any interrupts) as our main counter.  Each cpu has timeouts
160  * pending.
161  *
162  * This code is INTR_MPSAFE and may be called without the BGL held.
163  */
164 static void
165 clkintr(void *dummy, void *frame_arg)
166 {
167         static sysclock_t sysclock_count;       /* NOTE! Must be static */
168         struct globaldata *gd = mycpu;
169 #ifdef SMP
170         struct globaldata *gscan;
171         int n;
172 #endif
173
174         /*
175          * SWSTROBE mode is a one-shot, the timer is no longer running
176          */
177         timer0_running = 0;
178
179         /*
180          * XXX the dispatcher needs work.  right now we call systimer_intr()
181          * directly or via IPI for any cpu with systimers queued, which is
182          * usually *ALL* of them.  We need to use the LAPIC timer for this.
183          */
184         sysclock_count = sys_cputimer->count();
185 #ifdef SMP
186         for (n = 0; n < ncpus; ++n) {
187             gscan = globaldata_find(n);
188             if (TAILQ_FIRST(&gscan->gd_systimerq) == NULL)
189                 continue;
190             if (gscan != gd) {
191                 lwkt_send_ipiq3(gscan, (ipifunc3_t)systimer_intr, 
192                                 &sysclock_count, 0);
193             } else {
194                 systimer_intr(&sysclock_count, 0, frame_arg);
195             }
196         }
197 #else
198         if (TAILQ_FIRST(&gd->gd_systimerq) != NULL)
199             systimer_intr(&sysclock_count, 0, frame_arg);
200 #endif
201 }
202
203
204 /*
205  * NOTE! not MP safe.
206  */
207 int
208 acquire_timer2(int mode)
209 {
210         if (timer2_state != RELEASED)
211                 return (-1);
212         timer2_state = ACQUIRED;
213
214         /*
215          * This access to the timer registers is as atomic as possible
216          * because it is a single instruction.  We could do better if we
217          * knew the rate.
218          */
219         outb(TIMER_MODE, TIMER_SEL2 | (mode & 0x3f));
220         return (0);
221 }
222
223 int
224 release_timer2(void)
225 {
226         if (timer2_state != ACQUIRED)
227                 return (-1);
228         outb(TIMER_MODE, TIMER_SEL2 | TIMER_SQWAVE | TIMER_16BIT);
229         timer2_state = RELEASED;
230         return (0);
231 }
232
233 /*
234  * This routine receives statistical clock interrupts from the RTC.
235  * As explained above, these occur at 128 interrupts per second.
236  * When profiling, we receive interrupts at a rate of 1024 Hz.
237  *
238  * This does not actually add as much overhead as it sounds, because
239  * when the statistical clock is active, the hardclock driver no longer
240  * needs to keep (inaccurate) statistics on its own.  This decouples
241  * statistics gathering from scheduling interrupts.
242  *
243  * The RTC chip requires that we read status register C (RTC_INTR)
244  * to acknowledge an interrupt, before it will generate the next one.
245  * Under high interrupt load, rtcintr() can be indefinitely delayed and
246  * the clock can tick immediately after the read from RTC_INTR.  In this
247  * case, the mc146818A interrupt signal will not drop for long enough
248  * to register with the 8259 PIC.  If an interrupt is missed, the stat
249  * clock will halt, considerably degrading system performance.  This is
250  * why we use 'while' rather than a more straightforward 'if' below.
251  * Stat clock ticks can still be lost, causing minor loss of accuracy
252  * in the statistics, but the stat clock will no longer stop.
253  */
254 static void
255 rtcintr(void *dummy, void *frame)
256 {
257         while (rtcin(RTC_INTR) & RTCIR_PERIOD)
258                 ;
259                 /* statclock(frame); no longer used */
260 }
261
262 #include "opt_ddb.h"
263 #ifdef DDB
264 #include <ddb/ddb.h>
265
266 DB_SHOW_COMMAND(rtc, rtc)
267 {
268         kprintf("%02x/%02x/%02x %02x:%02x:%02x, A = %02x, B = %02x, C = %02x\n",
269                rtcin(RTC_YEAR), rtcin(RTC_MONTH), rtcin(RTC_DAY),
270                rtcin(RTC_HRS), rtcin(RTC_MIN), rtcin(RTC_SEC),
271                rtcin(RTC_STATUSA), rtcin(RTC_STATUSB), rtcin(RTC_INTR));
272 }
273 #endif /* DDB */
274
275 /*
276  * Return the current cpu timer count as a 32 bit integer.
277  */
278 static
279 sysclock_t
280 i8254_cputimer_count(void)
281 {
282         static __uint16_t cputimer_last;
283         __uint16_t count;
284         sysclock_t ret;
285
286         clock_lock();
287         outb(TIMER_MODE, i8254_walltimer_sel | TIMER_LATCH);
288         count = (__uint8_t)inb(i8254_walltimer_cntr);           /* get countdown */
289         count |= ((__uint8_t)inb(i8254_walltimer_cntr) << 8);
290         count = -count;                                 /* -> countup */
291         if (count < cputimer_last)                      /* rollover */
292                 i8254_cputimer.base += 0x00010000;
293         ret = i8254_cputimer.base | count;
294         cputimer_last = count;
295         clock_unlock();
296         return(ret);
297 }
298
299 /*
300  * This function is called whenever the system timebase changes, allowing
301  * us to calculate what is needed to convert a system timebase tick 
302  * into an 8254 tick for the interrupt timer.  If we can convert to a
303  * simple shift, multiplication, or division, we do so.  Otherwise 64
304  * bit arithmatic is required every time the interrupt timer is reloaded.
305  */
306 void
307 cputimer_intr_config(struct cputimer *timer)
308 {
309     int freq;
310     int div;
311
312     /*
313      * Will a simple divide do the trick?
314      */
315     div = (timer->freq + (i8254_cputimer.freq / 2)) / i8254_cputimer.freq;
316     freq = i8254_cputimer.freq * div;
317
318     if (freq >= timer->freq - 1 && freq <= timer->freq + 1)
319         i8254_cputimer_div = div;
320     else
321         i8254_cputimer_div = 0;
322 }
323
324 /*
325  * Reload for the next timeout.  It is possible for the reload value
326  * to be 0 or negative, indicating that an immediate timer interrupt
327  * is desired.  For now make the minimum 2 ticks.
328  *
329  * We may have to convert from the system timebase to the 8254 timebase.
330  */
331 void
332 cputimer_intr_reload(sysclock_t reload)
333 {
334     __uint16_t count;
335
336     if (i8254_cputimer_div)
337         reload /= i8254_cputimer_div;
338     else
339         reload = (int64_t)reload * i8254_cputimer.freq / sys_cputimer->freq;
340
341     if ((int)reload < 2)
342         reload = 2;
343
344     clock_lock();
345     if (timer0_running) {
346         outb(TIMER_MODE, TIMER_SEL0 | TIMER_LATCH);     /* count-down timer */
347         count = (__uint8_t)inb(TIMER_CNTR0);            /* lsb */
348         count |= ((__uint8_t)inb(TIMER_CNTR0) << 8);    /* msb */
349         if (reload < count) {
350             outb(TIMER_MODE, TIMER_SEL0 | TIMER_SWSTROBE | TIMER_16BIT);
351             outb(TIMER_CNTR0, (__uint8_t)reload);       /* lsb */
352             outb(TIMER_CNTR0, (__uint8_t)(reload >> 8)); /* msb */
353         }
354     } else {
355         timer0_running = 1;
356         if (reload > 0xFFFF)
357             reload = 0;         /* full count */
358         outb(TIMER_MODE, TIMER_SEL0 | TIMER_SWSTROBE | TIMER_16BIT);
359         outb(TIMER_CNTR0, (__uint8_t)reload);           /* lsb */
360         outb(TIMER_CNTR0, (__uint8_t)(reload >> 8));    /* msb */
361     }
362     clock_unlock();
363 }
364
365 /*
366  * DELAY(usec)       - Spin for the specified number of microseconds.
367  * DRIVERSLEEP(usec) - Spin for the specified number of microseconds,
368  *                     but do a thread switch in the loop
369  *
370  * Relies on timer 1 counting down from (cputimer_freq / hz)
371  * Note: timer had better have been programmed before this is first used!
372  */
373 static void
374 DODELAY(int n, int doswitch)
375 {
376         int delta, prev_tick, tick, ticks_left;
377
378 #ifdef DELAYDEBUG
379         int getit_calls = 1;
380         int n1;
381         static int state = 0;
382
383         if (state == 0) {
384                 state = 1;
385                 for (n1 = 1; n1 <= 10000000; n1 *= 10)
386                         DELAY(n1);
387                 state = 2;
388         }
389         if (state == 1)
390                 kprintf("DELAY(%d)...", n);
391 #endif
392         /*
393          * Guard against the timer being uninitialized if we are called
394          * early for console i/o.
395          */
396         if (timer0_state == RELEASED)
397                 i8254_restore();
398
399         /*
400          * Read the counter first, so that the rest of the setup overhead is
401          * counted.  Then calculate the number of hardware timer ticks
402          * required, rounding up to be sure we delay at least the requested
403          * number of microseconds.
404          */
405         prev_tick = sys_cputimer->count();
406         ticks_left = ((u_int)n * (int64_t)sys_cputimer->freq + 999999) /
407                      1000000;
408
409         /*
410          * Loop until done.
411          */
412         while (ticks_left > 0) {
413                 tick = sys_cputimer->count();
414 #ifdef DELAYDEBUG
415                 ++getit_calls;
416 #endif
417                 delta = tick - prev_tick;
418                 prev_tick = tick;
419                 if (delta < 0)
420                         delta = 0;
421                 ticks_left -= delta;
422                 if (doswitch && ticks_left > 0)
423                         lwkt_switch();
424         }
425 #ifdef DELAYDEBUG
426         if (state == 1)
427                 kprintf(" %d calls to getit() at %d usec each\n",
428                        getit_calls, (n + 5) / getit_calls);
429 #endif
430 }
431
432 void
433 DELAY(int n)
434 {
435         DODELAY(n, 0);
436 }
437
438 void
439 DRIVERSLEEP(int usec)
440 {
441         globaldata_t gd = mycpu;
442
443         if (gd->gd_intr_nesting_level || 
444             gd->gd_spinlock_rd ||
445             gd->gd_spinlocks_wr) {
446                 DODELAY(usec, 0);
447         } else {
448                 DODELAY(usec, 1);
449         }
450 }
451
452 static void
453 sysbeepstop(void *chan)
454 {
455         outb(IO_PPI, inb(IO_PPI)&0xFC); /* disable counter2 output to speaker */
456         beeping = 0;
457         release_timer2();
458 }
459
460 int
461 sysbeep(int pitch, int period)
462 {
463         if (acquire_timer2(TIMER_SQWAVE|TIMER_16BIT))
464                 return(-1);
465         /*
466          * Nobody else is using timer2, we do not need the clock lock
467          */
468         outb(TIMER_CNTR2, pitch);
469         outb(TIMER_CNTR2, (pitch>>8));
470         if (!beeping) {
471                 /* enable counter2 output to speaker */
472                 outb(IO_PPI, inb(IO_PPI) | 3);
473                 beeping = period;
474                 callout_reset(&sysbeepstop_ch, period, sysbeepstop, NULL);
475         }
476         return (0);
477 }
478
479 /*
480  * RTC support routines
481  */
482
483 int
484 rtcin(int reg)
485 {
486         u_char val;
487
488         crit_enter();
489         outb(IO_RTC, reg);
490         inb(0x84);
491         val = inb(IO_RTC + 1);
492         inb(0x84);
493         crit_exit();
494         return (val);
495 }
496
497 static __inline void
498 writertc(u_char reg, u_char val)
499 {
500         crit_enter();
501         inb(0x84);
502         outb(IO_RTC, reg);
503         inb(0x84);
504         outb(IO_RTC + 1, val);
505         inb(0x84);              /* XXX work around wrong order in rtcin() */
506         crit_exit();
507 }
508
509 static __inline int
510 readrtc(int port)
511 {
512         return(bcd2bin(rtcin(port)));
513 }
514
515 static u_int
516 calibrate_clocks(void)
517 {
518         u_int64_t old_tsc;
519         u_int count, prev_count, tot_count;
520         int sec, start_sec, timeout;
521
522         if (bootverbose)
523                 kprintf("Calibrating clock(s) ... ");
524         if (!(rtcin(RTC_STATUSD) & RTCSD_PWR))
525                 goto fail;
526         timeout = 100000000;
527
528         /* Read the mc146818A seconds counter. */
529         for (;;) {
530                 if (!(rtcin(RTC_STATUSA) & RTCSA_TUP)) {
531                         sec = rtcin(RTC_SEC);
532                         break;
533                 }
534                 if (--timeout == 0)
535                         goto fail;
536         }
537
538         /* Wait for the mC146818A seconds counter to change. */
539         start_sec = sec;
540         for (;;) {
541                 if (!(rtcin(RTC_STATUSA) & RTCSA_TUP)) {
542                         sec = rtcin(RTC_SEC);
543                         if (sec != start_sec)
544                                 break;
545                 }
546                 if (--timeout == 0)
547                         goto fail;
548         }
549
550         /* Start keeping track of the i8254 counter. */
551         prev_count = sys_cputimer->count();
552         tot_count = 0;
553
554         if (tsc_present) 
555                 old_tsc = rdtsc();
556         else
557                 old_tsc = 0;            /* shut up gcc */
558
559         /*
560          * Wait for the mc146818A seconds counter to change.  Read the i8254
561          * counter for each iteration since this is convenient and only
562          * costs a few usec of inaccuracy. The timing of the final reads
563          * of the counters almost matches the timing of the initial reads,
564          * so the main cause of inaccuracy is the varying latency from 
565          * inside getit() or rtcin(RTC_STATUSA) to the beginning of the
566          * rtcin(RTC_SEC) that returns a changed seconds count.  The
567          * maximum inaccuracy from this cause is < 10 usec on 486's.
568          */
569         start_sec = sec;
570         for (;;) {
571                 if (!(rtcin(RTC_STATUSA) & RTCSA_TUP))
572                         sec = rtcin(RTC_SEC);
573                 count = sys_cputimer->count();
574                 tot_count += (int)(count - prev_count);
575                 prev_count = count;
576                 if (sec != start_sec)
577                         break;
578                 if (--timeout == 0)
579                         goto fail;
580         }
581
582         /*
583          * Read the cpu cycle counter.  The timing considerations are
584          * similar to those for the i8254 clock.
585          */
586         if (tsc_present) {
587                 tsc_frequency = rdtsc() - old_tsc;
588                 tsc_freq = (u_int)tsc_frequency;        /* XXX */
589         }
590
591         if (tsc_present)
592                 kprintf("TSC clock: %u Hz, ", tsc_freq);
593         kprintf("i8254 clock: %u Hz\n", tot_count);
594         return (tot_count);
595
596 fail:
597         kprintf("failed, using default i8254 clock of %u Hz\n",
598                 i8254_cputimer.freq);
599         return (i8254_cputimer.freq);
600 }
601
602 static void
603 i8254_restore(void)
604 {
605         timer0_state = ACQUIRED;
606
607         clock_lock();
608
609         /*
610          * Timer0 is our fine-grained variable clock interrupt
611          */
612         outb(TIMER_MODE, TIMER_SEL0 | TIMER_SWSTROBE | TIMER_16BIT);
613         outb(TIMER_CNTR0, 2);   /* lsb */
614         outb(TIMER_CNTR0, 0);   /* msb */
615         clock_unlock();
616
617         /*
618          * Timer1 or timer2 is our free-running clock, but only if another
619          * has not been selected.
620          */
621         cputimer_register(&i8254_cputimer);
622         cputimer_select(&i8254_cputimer, 0);
623 }
624
625 static void
626 i8254_cputimer_construct(struct cputimer *timer, sysclock_t oldclock)
627 {
628         int which;
629
630         /*
631          * Should we use timer 1 or timer 2 ?
632          */
633         which = 0;
634         TUNABLE_INT_FETCH("hw.i8254.walltimer", &which);
635         if (which != 1 && which != 2)
636                 which = 2;
637
638         switch(which) {
639         case 1:
640                 timer->name = "i8254_timer1";
641                 timer->type = CPUTIMER_8254_SEL1;
642                 i8254_walltimer_sel = TIMER_SEL1;
643                 i8254_walltimer_cntr = TIMER_CNTR1;
644                 timer1_state = ACQUIRED;
645                 break;
646         case 2:
647                 timer->name = "i8254_timer2";
648                 timer->type = CPUTIMER_8254_SEL2;
649                 i8254_walltimer_sel = TIMER_SEL2;
650                 i8254_walltimer_cntr = TIMER_CNTR2;
651                 timer2_state = ACQUIRED;
652                 break;
653         }
654
655         timer->base = (oldclock + 0xFFFF) & ~0xFFFF;
656
657         clock_lock();
658         outb(TIMER_MODE, i8254_walltimer_sel | TIMER_RATEGEN | TIMER_16BIT);
659         outb(i8254_walltimer_cntr, 0);  /* lsb */
660         outb(i8254_walltimer_cntr, 0);  /* msb */
661         outb(IO_PPI, inb(IO_PPI) | 1);  /* bit 0: enable gate, bit 1: spkr */
662         clock_unlock();
663 }
664
665 static void
666 i8254_cputimer_destruct(struct cputimer *timer)
667 {
668         switch(timer->type) {
669         case CPUTIMER_8254_SEL1:
670             timer1_state = RELEASED;
671             break;
672         case CPUTIMER_8254_SEL2:
673             timer2_state = RELEASED;
674             break;
675         default:
676             break;
677         }
678         timer->type = 0;
679 }
680
681 static void
682 rtc_restore(void)
683 {
684         /* Restore all of the RTC's "status" (actually, control) registers. */
685         writertc(RTC_STATUSB, RTCSB_24HR);
686         writertc(RTC_STATUSA, rtc_statusa);
687         writertc(RTC_STATUSB, rtc_statusb);
688 }
689
690 /*
691  * Restore all the timers.
692  *
693  * This function is called to resynchronize our core timekeeping after a
694  * long halt, e.g. from apm_default_resume() and friends.  It is also 
695  * called if after a BIOS call we have detected munging of the 8254.
696  * It is necessary because cputimer_count() counter's delta may have grown
697  * too large for nanouptime() and friends to handle, or (in the case of 8254
698  * munging) might cause the SYSTIMER code to prematurely trigger.
699  */
700 void
701 timer_restore(void)
702 {
703         crit_enter();
704         i8254_restore();                /* restore timer_freq and hz */
705         rtc_restore();                  /* reenable RTC interrupts */
706         crit_exit();
707 }
708
709 /*
710  * Initialize 8254 timer 0 early so that it can be used in DELAY().
711  */
712 void
713 startrtclock(void)
714 {
715         u_int delta, freq;
716
717         /* 
718          * Can we use the TSC?
719          */
720         if (cpu_feature & CPUID_TSC)
721                 tsc_present = 1;
722         else
723                 tsc_present = 0;
724
725         /*
726          * Initial RTC state, don't do anything unexpected
727          */
728         writertc(RTC_STATUSA, rtc_statusa);
729         writertc(RTC_STATUSB, RTCSB_24HR);
730
731         /*
732          * Set the 8254 timer0 in TIMER_SWSTROBE mode and cause it to 
733          * generate an interrupt, which we will ignore for now.
734          *
735          * Set the 8254 timer1 in TIMER_RATEGEN mode and load 0x0000
736          * (so it counts a full 2^16 and repeats).  We will use this timer
737          * for our counting.
738          */
739         i8254_restore();
740         freq = calibrate_clocks();
741 #ifdef CLK_CALIBRATION_LOOP
742         if (bootverbose) {
743                 kprintf(
744                 "Press a key on the console to abort clock calibration\n");
745                 while (cncheckc() == -1)
746                         calibrate_clocks();
747         }
748 #endif
749
750         /*
751          * Use the calibrated i8254 frequency if it seems reasonable.
752          * Otherwise use the default, and don't use the calibrated i586
753          * frequency.
754          */
755         delta = freq > i8254_cputimer.freq ? 
756                         freq - i8254_cputimer.freq : i8254_cputimer.freq - freq;
757         if (delta < i8254_cputimer.freq / 100) {
758 #ifndef CLK_USE_I8254_CALIBRATION
759                 if (bootverbose)
760                         kprintf(
761 "CLK_USE_I8254_CALIBRATION not specified - using default frequency\n");
762                 freq = i8254_cputimer.freq;
763 #endif
764                 cputimer_set_frequency(&i8254_cputimer, freq);
765         } else {
766                 if (bootverbose)
767                         kprintf(
768                     "%d Hz differs from default of %d Hz by more than 1%%\n",
769                                freq, i8254_cputimer.freq);
770                 tsc_freq = 0;
771                 tsc_frequency = 0;
772         }
773
774 #ifndef CLK_USE_TSC_CALIBRATION
775         if (tsc_freq != 0) {
776                 if (bootverbose)
777                         kprintf(
778 "CLK_USE_TSC_CALIBRATION not specified - using old calibration method\n");
779                 tsc_freq = 0;
780                 tsc_frequency = 0;
781         }
782 #endif
783         if (tsc_present && tsc_frequency == 0) {
784                 /*
785                  * Calibration of the i586 clock relative to the mc146818A
786                  * clock failed.  Do a less accurate calibration relative
787                  * to the i8254 clock.
788                  */
789                 u_int64_t old_tsc = rdtsc();
790
791                 DELAY(1000000);
792                 tsc_frequency = rdtsc() - old_tsc;
793                 tsc_freq = (u_int)tsc_frequency;
794 #ifdef CLK_USE_TSC_CALIBRATION
795                 if (bootverbose)
796                         kprintf("TSC clock: %u Hz (Method B)\n", tsc_freq);
797 #endif
798         }
799
800         EVENTHANDLER_REGISTER(shutdown_post_sync, resettodr_on_shutdown, NULL, SHUTDOWN_PRI_LAST);
801
802 #if !defined(SMP)
803         /*
804          * We can not use the TSC in SMP mode, until we figure out a
805          * cheap (impossible), reliable and precise (yeah right!)  way
806          * to synchronize the TSCs of all the CPUs.
807          * Curse Intel for leaving the counter out of the I/O APIC.
808          */
809
810 #if NAPM > 0
811         /*
812          * We can not use the TSC if we support APM. Precise timekeeping
813          * on an APM'ed machine is at best a fools pursuit, since 
814          * any and all of the time spent in various SMM code can't 
815          * be reliably accounted for.  Reading the RTC is your only
816          * source of reliable time info.  The i8254 looses too of course
817          * but we need to have some kind of time...
818          * We don't know at this point whether APM is going to be used
819          * or not, nor when it might be activated.  Play it safe.
820          */
821         return;
822 #endif /* NAPM > 0 */
823
824 #endif /* !defined(SMP) */
825 }
826
827 /*
828  * Sync the time of day back to the RTC on shutdown, but only if
829  * we have already loaded it and have not crashed.
830  */
831 static void
832 resettodr_on_shutdown(void *arg __unused)
833 {
834         if (rtc_loaded && panicstr == NULL) {
835                 resettodr();
836         }
837 }
838
839 /*
840  * Initialize the time of day register, based on the time base which is, e.g.
841  * from a filesystem.
842  */
843 void
844 inittodr(time_t base)
845 {
846         unsigned long   sec, days;
847         int             yd;
848         int             year, month;
849         int             y, m;
850         struct timespec ts;
851
852         if (base) {
853                 ts.tv_sec = base;
854                 ts.tv_nsec = 0;
855                 set_timeofday(&ts);
856         }
857
858         /* Look if we have a RTC present and the time is valid */
859         if (!(rtcin(RTC_STATUSD) & RTCSD_PWR))
860                 goto wrong_time;
861
862         /* wait for time update to complete */
863         /* If RTCSA_TUP is zero, we have at least 244us before next update */
864         crit_enter();
865         while (rtcin(RTC_STATUSA) & RTCSA_TUP) {
866                 crit_exit();
867                 crit_enter();
868         }
869
870         days = 0;
871 #ifdef USE_RTC_CENTURY
872         year = readrtc(RTC_YEAR) + readrtc(RTC_CENTURY) * 100;
873 #else
874         year = readrtc(RTC_YEAR) + 1900;
875         if (year < 1970)
876                 year += 100;
877 #endif
878         if (year < 1970) {
879                 crit_exit();
880                 goto wrong_time;
881         }
882         month = readrtc(RTC_MONTH);
883         for (m = 1; m < month; m++)
884                 days += daysinmonth[m-1];
885         if ((month > 2) && LEAPYEAR(year))
886                 days ++;
887         days += readrtc(RTC_DAY) - 1;
888         yd = days;
889         for (y = 1970; y < year; y++)
890                 days += DAYSPERYEAR + LEAPYEAR(y);
891         sec = ((( days * 24 +
892                   readrtc(RTC_HRS)) * 60 +
893                   readrtc(RTC_MIN)) * 60 +
894                   readrtc(RTC_SEC));
895         /* sec now contains the number of seconds, since Jan 1 1970,
896            in the local time zone */
897
898         sec += tz.tz_minuteswest * 60 + (wall_cmos_clock ? adjkerntz : 0);
899
900         y = time_second - sec;
901         if (y <= -2 || y >= 2) {
902                 /* badly off, adjust it */
903                 ts.tv_sec = sec;
904                 ts.tv_nsec = 0;
905                 set_timeofday(&ts);
906         }
907         rtc_loaded = 1;
908         crit_exit();
909         return;
910
911 wrong_time:
912         kprintf("Invalid time in real time clock.\n");
913         kprintf("Check and reset the date immediately!\n");
914 }
915
916 /*
917  * Write system time back to RTC
918  */
919 void
920 resettodr(void)
921 {
922         struct timeval tv;
923         unsigned long tm;
924         int m;
925         int y;
926
927         if (disable_rtc_set)
928                 return;
929
930         microtime(&tv);
931         tm = tv.tv_sec;
932
933         crit_enter();
934         /* Disable RTC updates and interrupts. */
935         writertc(RTC_STATUSB, RTCSB_HALT | RTCSB_24HR);
936
937         /* Calculate local time to put in RTC */
938
939         tm -= tz.tz_minuteswest * 60 + (wall_cmos_clock ? adjkerntz : 0);
940
941         writertc(RTC_SEC, bin2bcd(tm%60)); tm /= 60;    /* Write back Seconds */
942         writertc(RTC_MIN, bin2bcd(tm%60)); tm /= 60;    /* Write back Minutes */
943         writertc(RTC_HRS, bin2bcd(tm%24)); tm /= 24;    /* Write back Hours   */
944
945         /* We have now the days since 01-01-1970 in tm */
946         writertc(RTC_WDAY, (tm+4)%7);                   /* Write back Weekday */
947         for (y = 1970, m = DAYSPERYEAR + LEAPYEAR(y);
948              tm >= m;
949              y++,      m = DAYSPERYEAR + LEAPYEAR(y))
950              tm -= m;
951
952         /* Now we have the years in y and the day-of-the-year in tm */
953         writertc(RTC_YEAR, bin2bcd(y%100));             /* Write back Year    */
954 #ifdef USE_RTC_CENTURY
955         writertc(RTC_CENTURY, bin2bcd(y/100));          /* ... and Century    */
956 #endif
957         for (m = 0; ; m++) {
958                 int ml;
959
960                 ml = daysinmonth[m];
961                 if (m == 1 && LEAPYEAR(y))
962                         ml++;
963                 if (tm < ml)
964                         break;
965                 tm -= ml;
966         }
967
968         writertc(RTC_MONTH, bin2bcd(m + 1));            /* Write back Month   */
969         writertc(RTC_DAY, bin2bcd(tm + 1));             /* Write back Month Day */
970
971         /* Reenable RTC updates and interrupts. */
972         writertc(RTC_STATUSB, rtc_statusb);
973         crit_exit();
974 }
975
976
977 /*
978  * Start both clocks running.  DragonFly note: the stat clock is no longer
979  * used.  Instead, 8254 based systimers are used for all major clock
980  * interrupts.  statclock_disable is set by default.
981  */
982 void
983 cpu_initclocks(void *arg __unused)
984 {
985         int diag;
986 #ifdef APIC_IO
987         int apic_8254_trial;
988         void *clkdesc;
989 #endif /* APIC_IO */
990
991         if (statclock_disable) {
992                 /*
993                  * The stat interrupt mask is different without the
994                  * statistics clock.  Also, don't set the interrupt
995                  * flag which would normally cause the RTC to generate
996                  * interrupts.
997                  */
998                 rtc_statusb = RTCSB_24HR;
999         } else {
1000                 /* Setting stathz to nonzero early helps avoid races. */
1001                 stathz = RTC_NOPROFRATE;
1002                 profhz = RTC_PROFRATE;
1003         }
1004
1005         /* Finish initializing 8253 timer 0. */
1006 #ifdef APIC_IO
1007
1008         apic_8254_intr = isa_apic_irq(0);
1009         apic_8254_trial = 0;
1010         if (apic_8254_intr >= 0 ) {
1011                 if (apic_int_type(0, 0) == 3)
1012                         apic_8254_trial = 1;
1013         } else {
1014                 /* look for ExtInt on pin 0 */
1015                 if (apic_int_type(0, 0) == 3) {
1016                         apic_8254_intr = apic_irq(0, 0);
1017                         setup_8254_mixed_mode();
1018                 } else 
1019                         panic("APIC_IO: Cannot route 8254 interrupt to CPU");
1020         }
1021
1022         clkdesc = register_int(apic_8254_intr, clkintr, NULL, "clk",
1023                                NULL,
1024                                INTR_EXCL | INTR_FAST | 
1025                                INTR_NOPOLL | INTR_MPSAFE | 
1026                                INTR_NOENTROPY);
1027         machintr_intren(apic_8254_intr);
1028         
1029 #else /* APIC_IO */
1030
1031         register_int(0, clkintr, NULL, "clk", NULL,
1032                      INTR_EXCL | INTR_FAST | 
1033                      INTR_NOPOLL | INTR_MPSAFE |
1034                      INTR_NOENTROPY);
1035         machintr_intren(ICU_IRQ0);
1036
1037 #endif /* APIC_IO */
1038
1039         /* Initialize RTC. */
1040         writertc(RTC_STATUSA, rtc_statusa);
1041         writertc(RTC_STATUSB, RTCSB_24HR);
1042
1043         if (statclock_disable == 0) {
1044                 diag = rtcin(RTC_DIAG);
1045                 if (diag != 0)
1046                         kprintf("RTC BIOS diagnostic error %b\n", diag, RTCDG_BITS);
1047
1048 #ifdef APIC_IO
1049                 if (isa_apic_irq(8) != 8)
1050                         panic("APIC RTC != 8");
1051 #endif /* APIC_IO */
1052
1053                 register_int(8, (inthand2_t *)rtcintr, NULL, "rtc", NULL,
1054                              INTR_EXCL | INTR_FAST | INTR_NOPOLL |
1055                              INTR_NOENTROPY);
1056                 machintr_intren(8);
1057
1058                 writertc(RTC_STATUSB, rtc_statusb);
1059         }
1060
1061 #ifdef APIC_IO
1062         if (apic_8254_trial) {
1063                 sysclock_t base;
1064                 long lastcnt;
1065
1066                 lastcnt = get_interrupt_counter(apic_8254_intr);
1067
1068                 /*
1069                  * XXX this assumes the 8254 is the cpu timer.  Force an
1070                  * 8254 Timer0 interrupt and wait 1/100s for it to happen,
1071                  * then see if we got it.
1072                  */
1073                 kprintf("APIC_IO: Testing 8254 interrupt delivery\n");
1074                 cputimer_intr_reload(2);        /* XXX assumes 8254 */
1075                 base = sys_cputimer->count();
1076                 while (sys_cputimer->count() - base < sys_cputimer->freq / 100)
1077                         ;       /* nothing */
1078                 if (get_interrupt_counter(apic_8254_intr) - lastcnt == 0) {
1079                         /* 
1080                          * The MP table is broken.
1081                          * The 8254 was not connected to the specified pin
1082                          * on the IO APIC.
1083                          * Workaround: Limited variant of mixed mode.
1084                          */
1085                         machintr_intrdis(apic_8254_intr);
1086                         unregister_int(clkdesc);
1087                         kprintf("APIC_IO: Broken MP table detected: "
1088                                "8254 is not connected to "
1089                                "IOAPIC #%d intpin %d\n",
1090                                int_to_apicintpin[apic_8254_intr].ioapic,
1091                                int_to_apicintpin[apic_8254_intr].int_pin);
1092                         /* 
1093                          * Revoke current ISA IRQ 0 assignment and 
1094                          * configure a fallback interrupt routing from
1095                          * the 8254 Timer via the 8259 PIC to the
1096                          * an ExtInt interrupt line on IOAPIC #0 intpin 0.
1097                          * We reuse the low level interrupt handler number.
1098                          */
1099                         if (apic_irq(0, 0) < 0) {
1100                                 revoke_apic_irq(apic_8254_intr);
1101                                 assign_apic_irq(0, 0, apic_8254_intr);
1102                         }
1103                         apic_8254_intr = apic_irq(0, 0);
1104                         setup_8254_mixed_mode();
1105                         register_int(apic_8254_intr, clkintr, NULL, "clk",
1106                                      NULL,
1107                                      INTR_EXCL | INTR_FAST | 
1108                                      INTR_NOPOLL | INTR_MPSAFE |
1109                                      INTR_NOENTROPY);
1110                         machintr_intren(apic_8254_intr);
1111                 }
1112                 
1113         }
1114         if (apic_int_type(0, 0) != 3 ||
1115             int_to_apicintpin[apic_8254_intr].ioapic != 0 ||
1116             int_to_apicintpin[apic_8254_intr].int_pin != 0) {
1117                 kprintf("APIC_IO: routing 8254 via IOAPIC #%d intpin %d\n",
1118                        int_to_apicintpin[apic_8254_intr].ioapic,
1119                        int_to_apicintpin[apic_8254_intr].int_pin);
1120         } else {
1121                 kprintf("APIC_IO: "
1122                        "routing 8254 via 8259 and IOAPIC #0 intpin 0\n");
1123         }
1124 #endif
1125         callout_init(&sysbeepstop_ch);
1126 }
1127 SYSINIT(clocks8254, SI_BOOT2_CLOCKREG, SI_ORDER_FIRST, cpu_initclocks, NULL)
1128
1129 #ifdef APIC_IO
1130
1131 static void 
1132 setup_8254_mixed_mode(void)
1133 {
1134         /*
1135          * Allow 8254 timer to INTerrupt 8259:
1136          *  re-initialize master 8259:
1137          *   reset; prog 4 bytes, single ICU, edge triggered
1138          */
1139         outb(IO_ICU1, 0x13);
1140         outb(IO_ICU1 + 1, IDT_OFFSET);  /* start vector (unused) */
1141         outb(IO_ICU1 + 1, 0x00);        /* ignore slave */
1142         outb(IO_ICU1 + 1, 0x03);        /* auto EOI, 8086 */
1143         outb(IO_ICU1 + 1, 0xfe);        /* unmask INT0 */
1144         
1145         /* program IO APIC for type 3 INT on INT0 */
1146         if (ext_int_setup(0, 0) < 0)
1147                 panic("8254 redirect via APIC pin0 impossible!");
1148 }
1149 #endif
1150
1151 void
1152 setstatclockrate(int newhz)
1153 {
1154         if (newhz == RTC_PROFRATE)
1155                 rtc_statusa = RTCSA_DIVIDER | RTCSA_PROF;
1156         else
1157                 rtc_statusa = RTCSA_DIVIDER | RTCSA_NOPROF;
1158         writertc(RTC_STATUSA, rtc_statusa);
1159 }
1160
1161 #if 0
1162 static unsigned
1163 tsc_get_timecount(struct timecounter *tc)
1164 {
1165         return (rdtsc());
1166 }
1167 #endif
1168
1169 #ifdef KERN_TIMESTAMP
1170 #define KERN_TIMESTAMP_SIZE 16384
1171 static u_long tsc[KERN_TIMESTAMP_SIZE] ;
1172 SYSCTL_OPAQUE(_debug, OID_AUTO, timestamp, CTLFLAG_RD, tsc,
1173         sizeof(tsc), "LU", "Kernel timestamps");
1174 void  
1175 _TSTMP(u_int32_t x)
1176 {
1177         static int i;
1178
1179         tsc[i] = (u_int32_t)rdtsc();
1180         tsc[i+1] = x;
1181         i = i + 2;
1182         if (i >= KERN_TIMESTAMP_SIZE)
1183                 i = 0;
1184         tsc[i] = 0; /* mark last entry */
1185 }
1186 #endif /* KERN_TIMESTAMP */
1187
1188 /*
1189  *
1190  */
1191
1192 static int
1193 hw_i8254_timestamp(SYSCTL_HANDLER_ARGS)
1194 {
1195     sysclock_t count;
1196     __uint64_t tscval;
1197     char buf[32];
1198
1199     crit_enter();
1200     if (sys_cputimer == &i8254_cputimer)
1201         count = sys_cputimer->count();
1202     else
1203         count = 0;
1204     if (tsc_present)
1205         tscval = rdtsc();
1206     else
1207         tscval = 0;
1208     crit_exit();
1209     ksnprintf(buf, sizeof(buf), "%08x %016llx", count, (long long)tscval);
1210     return(SYSCTL_OUT(req, buf, strlen(buf) + 1));
1211 }
1212
1213 SYSCTL_NODE(_hw, OID_AUTO, i8254, CTLFLAG_RW, 0, "I8254");
1214 SYSCTL_UINT(_hw_i8254, OID_AUTO, freq, CTLFLAG_RD, &i8254_cputimer.freq, 0,
1215             "frequency");
1216 SYSCTL_PROC(_hw_i8254, OID_AUTO, timestamp, CTLTYPE_STRING|CTLFLAG_RD,
1217             0, 0, hw_i8254_timestamp, "A", "");
1218