sys/platform/pc64/isa/clock.c

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