sys/platform/pc32/isa/clock.c

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