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