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