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