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 #ifdef SMP
 365 extern void     lapic_timer_intr_reload(sysclock_t);
 366 #endif
 367
 368 void
 369 cputimer_intr_reload(sysclock_t reload)
 370 {
 371         i8254_intr_reload(reload);
 372 #ifdef SMP
 373         lapic_timer_intr_reload(reload);
 374 #endif
 375 }
 376
 377 /*
 378  * DELAY(usec)       - Spin for the specified number of microseconds.
 379  * DRIVERSLEEP(usec) - Spin for the specified number of microseconds,
 380  *                     but do a thread switch in the loop
 381  *
 382  * Relies on timer 1 counting down from (cputimer_freq / hz)
 383  * Note: timer had better have been programmed before this is first used!
 384  */
 385 static void
 386 DODELAY(int n, int doswitch)
 387 {
 388         int delta, prev_tick, tick, ticks_left;
 389
 390 #ifdef DELAYDEBUG
 391         int getit_calls = 1;
 392         int n1;
 393         static int state = 0;
 394
 395         if (state == 0) {
 396                 state = 1;
 397                 for (n1 = 1; n1 <= 10000000; n1 *= 10)
 398                         DELAY(n1);
 399                 state = 2;
 400         }
 401         if (state == 1)
 402                 kprintf("DELAY(%d)...", n);
 403 #endif
 404         /*
 405          * Guard against the timer being uninitialized if we are called
 406          * early for console i/o.
 407          */
 408         if (timer0_state == RELEASED)
 409                 i8254_restore();
 410
 411         /*
 412          * Read the counter first, so that the rest of the setup overhead is
 413          * counted.  Then calculate the number of hardware timer ticks
 414          * required, rounding up to be sure we delay at least the requested
 415          * number of microseconds.
 416          */
 417         prev_tick = sys_cputimer->count();
 418         ticks_left = ((u_int)n * (int64_t)sys_cputimer->freq + 999999) /
 419                      1000000;
 420
 421         /*
 422          * Loop until done.
 423          */
 424         while (ticks_left > 0) {
 425                 tick = sys_cputimer->count();
 426 #ifdef DELAYDEBUG
 427                 ++getit_calls;
 428 #endif
 429                 delta = tick - prev_tick;
 430                 prev_tick = tick;
 431                 if (delta < 0)
 432                         delta = 0;
 433                 ticks_left -= delta;
 434                 if (doswitch && ticks_left > 0)
 435                         lwkt_switch();
 436         }
 437 #ifdef DELAYDEBUG
 438         if (state == 1)
 439                 kprintf(" %d calls to getit() at %d usec each\n",
 440                        getit_calls, (n + 5) / getit_calls);
 441 #endif
 442 }
 443
 444 void
 445 DELAY(int n)
 446 {
 447         DODELAY(n, 0);
 448 }
 449
 450 void
 451 DRIVERSLEEP(int usec)
 452 {
 453         globaldata_t gd = mycpu;
 454
 455         if (gd->gd_intr_nesting_level ||
 456             gd->gd_spinlock_rd ||
 457             gd->gd_spinlocks_wr) {
 458                 DODELAY(usec, 0);
 459         } else {
 460                 DODELAY(usec, 1);
 461         }
 462 }
 463
 464 static void
 465 sysbeepstop(void *chan)
 466 {
 467         outb(IO_PPI, inb(IO_PPI)&0xFC); /* disable counter2 output to speaker */
 468         beeping = 0;
 469         release_timer2();
 470 }
 471
 472 int
 473 sysbeep(int pitch, int period)
 474 {
 475         if (acquire_timer2(TIMER_SQWAVE|TIMER_16BIT))
 476                 return(-1);
 477         /*
 478          * Nobody else is using timer2, we do not need the clock lock
 479          */
 480         outb(TIMER_CNTR2, pitch);
 481         outb(TIMER_CNTR2, (pitch>>8));
 482         if (!beeping) {
 483                 /* enable counter2 output to speaker */
 484                 outb(IO_PPI, inb(IO_PPI) | 3);
 485                 beeping = period;
 486                 callout_reset(&sysbeepstop_ch, period, sysbeepstop, NULL);
 487         }
 488         return (0);
 489 }
 490
 491 /*
 492  * RTC support routines
 493  */
 494
 495 int
 496 rtcin(int reg)
 497 {
 498         u_char val;
 499
 500         crit_enter();
 501         outb(IO_RTC, reg);
 502         inb(0x84);
 503         val = inb(IO_RTC + 1);
 504         inb(0x84);
 505         crit_exit();
 506         return (val);
 507 }
 508
 509 static __inline void
 510 writertc(u_char reg, u_char val)
 511 {
 512         crit_enter();
 513         inb(0x84);
 514         outb(IO_RTC, reg);
 515         inb(0x84);
 516         outb(IO_RTC + 1, val);
 517         inb(0x84);              /* XXX work around wrong order in rtcin() */
 518         crit_exit();
 519 }
 520
 521 static __inline int
 522 readrtc(int port)
 523 {
 524         return(bcd2bin(rtcin(port)));
 525 }
 526
 527 static u_int
 528 calibrate_clocks(void)
 529 {
 530         u_int64_t old_tsc;
 531         u_int count, prev_count, tot_count;
 532         int sec, start_sec, timeout;
 533
 534         if (bootverbose)
 535                 kprintf("Calibrating clock(s) ... ");
 536         if (!(rtcin(RTC_STATUSD) & RTCSD_PWR))
 537                 goto fail;
 538         timeout = 100000000;
 539
 540         /* Read the mc146818A seconds counter. */
 541         for (;;) {
 542                 if (!(rtcin(RTC_STATUSA) & RTCSA_TUP)) {
 543                         sec = rtcin(RTC_SEC);
 544                         break;
 545                 }
 546                 if (--timeout == 0)
 547                         goto fail;
 548         }
 549
 550         /* Wait for the mC146818A seconds counter to change. */
 551         start_sec = sec;
 552         for (;;) {
 553                 if (!(rtcin(RTC_STATUSA) & RTCSA_TUP)) {
 554                         sec = rtcin(RTC_SEC);
 555                         if (sec != start_sec)
 556                                 break;
 557                 }
 558                 if (--timeout == 0)
 559                         goto fail;
 560         }
 561
 562         /* Start keeping track of the i8254 counter. */
 563         prev_count = sys_cputimer->count();
 564         tot_count = 0;
 565
 566         if (tsc_present)
 567                 old_tsc = rdtsc();
 568         else
 569                 old_tsc = 0;            /* shut up gcc */
 570
 571         /*
 572          * Wait for the mc146818A seconds counter to change.  Read the i8254
 573          * counter for each iteration since this is convenient and only
 574          * costs a few usec of inaccuracy. The timing of the final reads
 575          * of the counters almost matches the timing of the initial reads,
 576          * so the main cause of inaccuracy is the varying latency from
 577          * inside getit() or rtcin(RTC_STATUSA) to the beginning of the
 578          * rtcin(RTC_SEC) that returns a changed seconds count.  The
 579          * maximum inaccuracy from this cause is < 10 usec on 486's.
 580          */
 581         start_sec = sec;
 582         for (;;) {
 583                 if (!(rtcin(RTC_STATUSA) & RTCSA_TUP))
 584                         sec = rtcin(RTC_SEC);
 585                 count = sys_cputimer->count();
 586                 tot_count += (int)(count - prev_count);
 587                 prev_count = count;
 588                 if (sec != start_sec)
 589                         break;
 590                 if (--timeout == 0)
 591                         goto fail;
 592         }
 593
 594         /*
 595          * Read the cpu cycle counter.  The timing considerations are
 596          * similar to those for the i8254 clock.
 597          */
 598         if (tsc_present) {
 599                 tsc_frequency = rdtsc() - old_tsc;
 600         }
 601
 602         if (tsc_present)
 603                 kprintf("TSC clock: %llu Hz, ", tsc_frequency);
 604         kprintf("i8254 clock: %u Hz\n", tot_count);
 605         return (tot_count);
 606
 607 fail:
 608         kprintf("failed, using default i8254 clock of %u Hz\n",
 609                 i8254_cputimer.freq);
 610         return (i8254_cputimer.freq);
 611 }
 612
 613 static void
 614 i8254_restore(void)
 615 {
 616         timer0_state = ACQUIRED;
 617
 618         clock_lock();
 619
 620         /*
 621          * Timer0 is our fine-grained variable clock interrupt
 622          */
 623         outb(TIMER_MODE, TIMER_SEL0 | TIMER_SWSTROBE | TIMER_16BIT);
 624         outb(TIMER_CNTR0, 2);   /* lsb */
 625         outb(TIMER_CNTR0, 0);   /* msb */
 626         clock_unlock();
 627
 628         /*
 629          * Timer1 or timer2 is our free-running clock, but only if another
 630          * has not been selected.
 631          */
 632         cputimer_register(&i8254_cputimer);
 633         cputimer_select(&i8254_cputimer, 0);
 634 }
 635
 636 static void
 637 i8254_cputimer_construct(struct cputimer *timer, sysclock_t oldclock)
 638 {
 639         int which;
 640
 641         /*
 642          * Should we use timer 1 or timer 2 ?
 643          */
 644         which = 0;
 645         TUNABLE_INT_FETCH("hw.i8254.walltimer", &which);
 646         if (which != 1 && which != 2)
 647                 which = 2;
 648
 649         switch(which) {
 650         case 1:
 651                 timer->name = "i8254_timer1";
 652                 timer->type = CPUTIMER_8254_SEL1;
 653                 i8254_walltimer_sel = TIMER_SEL1;
 654                 i8254_walltimer_cntr = TIMER_CNTR1;
 655                 timer1_state = ACQUIRED;
 656                 break;
 657         case 2:
 658                 timer->name = "i8254_timer2";
 659                 timer->type = CPUTIMER_8254_SEL2;
 660                 i8254_walltimer_sel = TIMER_SEL2;
 661                 i8254_walltimer_cntr = TIMER_CNTR2;
 662                 timer2_state = ACQUIRED;
 663                 break;
 664         }
 665
 666         timer->base = (oldclock + 0xFFFF) & ~0xFFFF;
 667
 668         clock_lock();
 669         outb(TIMER_MODE, i8254_walltimer_sel | TIMER_RATEGEN | TIMER_16BIT);
 670         outb(i8254_walltimer_cntr, 0);  /* lsb */
 671         outb(i8254_walltimer_cntr, 0);  /* msb */
 672         outb(IO_PPI, inb(IO_PPI) | 1);  /* bit 0: enable gate, bit 1: spkr */
 673         clock_unlock();
 674 }
 675
 676 static void
 677 i8254_cputimer_destruct(struct cputimer *timer)
 678 {
 679         switch(timer->type) {
 680         case CPUTIMER_8254_SEL1:
 681             timer1_state = RELEASED;
 682             break;
 683         case CPUTIMER_8254_SEL2:
 684             timer2_state = RELEASED;
 685             break;
 686         default:
 687             break;
 688         }
 689         timer->type = 0;
 690 }
 691
 692 static void
 693 rtc_restore(void)
 694 {
 695         /* Restore all of the RTC's "status" (actually, control) registers. */
 696         writertc(RTC_STATUSB, RTCSB_24HR);
 697         writertc(RTC_STATUSA, rtc_statusa);
 698         writertc(RTC_STATUSB, rtc_statusb);
 699 }
 700
 701 /*
 702  * Restore all the timers.
 703  *
 704  * This function is called to resynchronize our core timekeeping after a
 705  * long halt, e.g. from apm_default_resume() and friends.  It is also
 706  * called if after a BIOS call we have detected munging of the 8254.
 707  * It is necessary because cputimer_count() counter's delta may have grown
 708  * too large for nanouptime() and friends to handle, or (in the case of 8254
 709  * munging) might cause the SYSTIMER code to prematurely trigger.
 710  */
 711 void
 712 timer_restore(void)
 713 {
 714         crit_enter();
 715         i8254_restore();                /* restore timer_freq and hz */
 716         rtc_restore();                  /* reenable RTC interrupts */
 717         crit_exit();
 718 }
 719
 720 /*
 721  * Initialize 8254 timer 0 early so that it can be used in DELAY().
 722  */
 723 void
 724 startrtclock(void)
 725 {
 726         u_int delta, freq;
 727
 728         /*
 729          * Can we use the TSC?
 730          */
 731         if (cpu_feature & CPUID_TSC)
 732                 tsc_present = 1;
 733         else
 734                 tsc_present = 0;
 735
 736         /*
 737          * Initial RTC state, don't do anything unexpected
 738          */
 739         writertc(RTC_STATUSA, rtc_statusa);
 740         writertc(RTC_STATUSB, RTCSB_24HR);
 741
 742         /*
 743          * Set the 8254 timer0 in TIMER_SWSTROBE mode and cause it to
 744          * generate an interrupt, which we will ignore for now.
 745          *
 746          * Set the 8254 timer1 in TIMER_RATEGEN mode and load 0x0000
 747          * (so it counts a full 2^16 and repeats).  We will use this timer
 748          * for our counting.
 749          */
 750         i8254_restore();
 751         freq = calibrate_clocks();
 752 #ifdef CLK_CALIBRATION_LOOP
 753         if (bootverbose) {
 754                 kprintf(
 755                 "Press a key on the console to abort clock calibration\n");
 756                 while (cncheckc() == -1)
 757                         calibrate_clocks();
 758         }
 759 #endif
 760
 761         /*
 762          * Use the calibrated i8254 frequency if it seems reasonable.
 763          * Otherwise use the default, and don't use the calibrated i586
 764          * frequency.
 765          */
 766         delta = freq > i8254_cputimer.freq ?
 767                         freq - i8254_cputimer.freq : i8254_cputimer.freq - freq;
 768         if (delta < i8254_cputimer.freq / 100) {
 769 #ifndef CLK_USE_I8254_CALIBRATION
 770                 if (bootverbose)
 771                         kprintf(
 772 "CLK_USE_I8254_CALIBRATION not specified - using default frequency\n");
 773                 freq = i8254_cputimer.freq;
 774 #endif
 775                 cputimer_set_frequency(&i8254_cputimer, freq);
 776         } else {
 777                 if (bootverbose)
 778                         kprintf(
 779                     "%d Hz differs from default of %d Hz by more than 1%%\n",
 780                                freq, i8254_cputimer.freq);
 781                 tsc_frequency = 0;
 782         }
 783
 784 #ifndef CLK_USE_TSC_CALIBRATION
 785         if (tsc_frequency != 0) {
 786                 if (bootverbose)
 787                         kprintf(
 788 "CLK_USE_TSC_CALIBRATION not specified - using old calibration method\n");
 789                 tsc_frequency = 0;
 790         }
 791 #endif
 792         if (tsc_present && tsc_frequency == 0) {
 793                 /*
 794                  * Calibration of the i586 clock relative to the mc146818A
 795                  * clock failed.  Do a less accurate calibration relative
 796                  * to the i8254 clock.
 797                  */
 798                 u_int64_t old_tsc = rdtsc();
 799
 800                 DELAY(1000000);
 801                 tsc_frequency = rdtsc() - old_tsc;
 802 #ifdef CLK_USE_TSC_CALIBRATION
 803                 if (bootverbose) {
 804                         kprintf("TSC clock: %llu Hz (Method B)\n",
 805                                 tsc_frequency);
 806                 }
 807 #endif
 808         }
 809
 810         EVENTHANDLER_REGISTER(shutdown_post_sync, resettodr_on_shutdown, NULL, SHUTDOWN_PRI_LAST);
 811
 812 #if !defined(SMP)
 813         /*
 814          * We can not use the TSC in SMP mode, until we figure out a
 815          * cheap (impossible), reliable and precise (yeah right!)  way
 816          * to synchronize the TSCs of all the CPUs.
 817          * Curse Intel for leaving the counter out of the I/O APIC.
 818          */
 819
 820 #if NAPM > 0
 821         /*
 822          * We can not use the TSC if we support APM. Precise timekeeping
 823          * on an APM'ed machine is at best a fools pursuit, since
 824          * any and all of the time spent in various SMM code can't
 825          * be reliably accounted for.  Reading the RTC is your only
 826          * source of reliable time info.  The i8254 looses too of course
 827          * but we need to have some kind of time...
 828          * We don't know at this point whether APM is going to be used
 829          * or not, nor when it might be activated.  Play it safe.
 830          */
 831         return;
 832 #endif /* NAPM > 0 */
 833
 834 #endif /* !defined(SMP) */
 835 }
 836
 837 /*
 838  * Sync the time of day back to the RTC on shutdown, but only if
 839  * we have already loaded it and have not crashed.
 840  */
 841 static void
 842 resettodr_on_shutdown(void *arg __unused)
 843 {
 844         if (rtc_loaded && panicstr == NULL) {
 845                 resettodr();
 846         }
 847 }
 848
 849 /*
 850  * Initialize the time of day register, based on the time base which is, e.g.
 851  * from a filesystem.
 852  */
 853 void
 854 inittodr(time_t base)
 855 {
 856         unsigned long   sec, days;
 857         int             yd;
 858         int             year, month;
 859         int             y, m;
 860         struct timespec ts;
 861
 862         if (base) {
 863                 ts.tv_sec = base;
 864                 ts.tv_nsec = 0;
 865                 set_timeofday(&ts);
 866         }
 867
 868         /* Look if we have a RTC present and the time is valid */
 869         if (!(rtcin(RTC_STATUSD) & RTCSD_PWR))
 870                 goto wrong_time;
 871
 872         /* wait for time update to complete */
 873         /* If RTCSA_TUP is zero, we have at least 244us before next update */
 874         crit_enter();
 875         while (rtcin(RTC_STATUSA) & RTCSA_TUP) {
 876                 crit_exit();
 877                 crit_enter();
 878         }
 879
 880         days = 0;
 881 #ifdef USE_RTC_CENTURY
 882         year = readrtc(RTC_YEAR) + readrtc(RTC_CENTURY) * 100;
 883 #else
 884         year = readrtc(RTC_YEAR) + 1900;
 885         if (year < 1970)
 886                 year += 100;
 887 #endif
 888         if (year < 1970) {
 889                 crit_exit();
 890                 goto wrong_time;
 891         }
 892         month = readrtc(RTC_MONTH);
 893         for (m = 1; m < month; m++)
 894                 days += daysinmonth[m-1];
 895         if ((month > 2) && LEAPYEAR(year))
 896                 days ++;
 897         days += readrtc(RTC_DAY) - 1;
 898         yd = days;
 899         for (y = 1970; y < year; y++)
 900                 days += DAYSPERYEAR + LEAPYEAR(y);
 901         sec = ((( days * 24 +
 902                   readrtc(RTC_HRS)) * 60 +
 903                   readrtc(RTC_MIN)) * 60 +
 904                   readrtc(RTC_SEC));
 905         /* sec now contains the number of seconds, since Jan 1 1970,
 906            in the local time zone */
 907
 908         sec += tz.tz_minuteswest * 60 + (wall_cmos_clock ? adjkerntz : 0);
 909
 910         y = time_second - sec;
 911         if (y <= -2 || y >= 2) {
 912                 /* badly off, adjust it */
 913                 ts.tv_sec = sec;
 914                 ts.tv_nsec = 0;
 915                 set_timeofday(&ts);
 916         }
 917         rtc_loaded = 1;
 918         crit_exit();
 919         return;
 920
 921 wrong_time:
 922         kprintf("Invalid time in real time clock.\n");
 923         kprintf("Check and reset the date immediately!\n");
 924 }
 925
 926 /*
 927  * Write system time back to RTC
 928  */
 929 void
 930 resettodr(void)
 931 {
 932         struct timeval tv;
 933         unsigned long tm;
 934         int m;
 935         int y;
 936
 937         if (disable_rtc_set)
 938                 return;
 939
 940         microtime(&tv);
 941         tm = tv.tv_sec;
 942
 943         crit_enter();
 944         /* Disable RTC updates and interrupts. */
 945         writertc(RTC_STATUSB, RTCSB_HALT | RTCSB_24HR);
 946
 947         /* Calculate local time to put in RTC */
 948
 949         tm -= tz.tz_minuteswest * 60 + (wall_cmos_clock ? adjkerntz : 0);
 950
 951         writertc(RTC_SEC, bin2bcd(tm%60)); tm /= 60;    /* Write back Seconds */
 952         writertc(RTC_MIN, bin2bcd(tm%60)); tm /= 60;    /* Write back Minutes */
 953         writertc(RTC_HRS, bin2bcd(tm%24)); tm /= 24;    /* Write back Hours   */
 954
 955         /* We have now the days since 01-01-1970 in tm */
 956         writertc(RTC_WDAY, (tm+4)%7);                   /* Write back Weekday */
 957         for (y = 1970, m = DAYSPERYEAR + LEAPYEAR(y);
 958              tm >= m;
 959              y++,      m = DAYSPERYEAR + LEAPYEAR(y))
 960              tm -= m;
 961
 962         /* Now we have the years in y and the day-of-the-year in tm */
 963         writertc(RTC_YEAR, bin2bcd(y%100));             /* Write back Year    */
 964 #ifdef USE_RTC_CENTURY
 965         writertc(RTC_CENTURY, bin2bcd(y/100));          /* ... and Century    */
 966 #endif
 967         for (m = 0; ; m++) {
 968                 int ml;
 969
 970                 ml = daysinmonth[m];
 971                 if (m == 1 && LEAPYEAR(y))
 972                         ml++;
 973                 if (tm < ml)
 974                         break;
 975                 tm -= ml;
 976         }
 977
 978         writertc(RTC_MONTH, bin2bcd(m + 1));            /* Write back Month   */
 979         writertc(RTC_DAY, bin2bcd(tm + 1));             /* Write back Month Day */
 980
 981         /* Reenable RTC updates and interrupts. */
 982         writertc(RTC_STATUSB, rtc_statusb);
 983         crit_exit();
 984 }
 985
 986
 987 /*
 988  * Start both clocks running.  DragonFly note: the stat clock is no longer
 989  * used.  Instead, 8254 based systimers are used for all major clock
 990  * interrupts.  statclock_disable is set by default.
 991  */
 992 void
 993 cpu_initclocks(void *arg __unused)
 994 {
 995         int diag;
 996 #ifdef APIC_IO
 997         int apic_8254_trial;
 998         void *clkdesc;
 999 #endif /* APIC_IO */
1000
1001         callout_init(&sysbeepstop_ch);
1002
1003         if (statclock_disable) {
1004                 /*
1005                  * The stat interrupt mask is different without the
1006                  * statistics clock.  Also, don't set the interrupt
1007                  * flag which would normally cause the RTC to generate
1008                  * interrupts.
1009                  */
1010                 rtc_statusb = RTCSB_24HR;
1011         } else {
1012                 /* Setting stathz to nonzero early helps avoid races. */
1013                 stathz = RTC_NOPROFRATE;
1014                 profhz = RTC_PROFRATE;
1015         }
1016
1017         /* Finish initializing 8253 timer 0. */
1018 #ifdef APIC_IO
1019
1020         apic_8254_intr = isa_apic_irq(0);
1021         apic_8254_trial = 0;
1022         if (apic_8254_intr >= 0 ) {
1023                 if (apic_int_type(0, 0) == 3)
1024                         apic_8254_trial = 1;
1025         } else {
1026                 /* look for ExtInt on pin 0 */
1027                 if (apic_int_type(0, 0) == 3) {
1028                         apic_8254_intr = apic_irq(0, 0);
1029                         setup_8254_mixed_mode();
1030                 } else
1031                         panic("APIC_IO: Cannot route 8254 interrupt to CPU");
1032         }
1033
1034         clkdesc = register_int(apic_8254_intr, clkintr, NULL, "clk",
1035                                NULL,
1036                                INTR_EXCL | INTR_FAST |
1037                                INTR_NOPOLL | INTR_MPSAFE |
1038                                INTR_NOENTROPY);
1039         machintr_intren(apic_8254_intr);
1040
1041 #else /* APIC_IO */
1042
1043         register_int(0, clkintr, NULL, "clk", NULL,
1044                      INTR_EXCL | INTR_FAST |
1045                      INTR_NOPOLL | INTR_MPSAFE |
1046                      INTR_NOENTROPY);
1047         machintr_intren(ICU_IRQ0);
1048
1049 #endif /* APIC_IO */
1050
1051         /* Initialize RTC. */
1052         writertc(RTC_STATUSA, rtc_statusa);
1053         writertc(RTC_STATUSB, RTCSB_24HR);
1054
1055         if (statclock_disable == 0) {
1056                 diag = rtcin(RTC_DIAG);
1057                 if (diag != 0)
1058                         kprintf("RTC BIOS diagnostic error %b\n", diag, RTCDG_BITS);
1059
1060 #ifdef APIC_IO
1061                 if (isa_apic_irq(8) != 8)
1062                         panic("APIC RTC != 8");
1063 #endif /* APIC_IO */
1064
1065                 register_int(8, (inthand2_t *)rtcintr, NULL, "rtc", NULL,
1066                              INTR_EXCL | INTR_FAST | INTR_NOPOLL |
1067                              INTR_NOENTROPY);
1068                 machintr_intren(8);
1069
1070                 writertc(RTC_STATUSB, rtc_statusb);
1071         }
1072
1073 #ifdef APIC_IO
1074         if (apic_8254_trial) {
1075                 sysclock_t base;
1076                 long lastcnt;
1077
1078                 /*
1079                  * Following code assumes the 8254 is the cpu timer,
1080                  * so make sure it is.
1081                  */
1082                 KKASSERT(sys_cputimer == &i8254_cputimer);
1083
1084                 lastcnt = get_interrupt_counter(apic_8254_intr);
1085
1086                 /*
1087                  * Force an 8254 Timer0 interrupt and wait 1/100s for
1088                  * it to happen, then see if we got it.
1089                  */
1090                 kprintf("APIC_IO: Testing 8254 interrupt delivery\n");
1091                 i8254_intr_reload(2);
1092                 base = sys_cputimer->count();
1093                 while (sys_cputimer->count() - base < sys_cputimer->freq / 100)
1094                         ;       /* nothing */
1095                 if (get_interrupt_counter(apic_8254_intr) - lastcnt == 0) {
1096                         /*
1097                          * The MP table is broken.
1098                          * The 8254 was not connected to the specified pin
1099                          * on the IO APIC.
1100                          * Workaround: Limited variant of mixed mode.
1101                          */
1102                         machintr_intrdis(apic_8254_intr);
1103                         unregister_int(clkdesc);
1104                         kprintf("APIC_IO: Broken MP table detected: "
1105                                "8254 is not connected to "
1106                                "IOAPIC #%d intpin %d\n",
1107                                int_to_apicintpin[apic_8254_intr].ioapic,
1108                                int_to_apicintpin[apic_8254_intr].int_pin);
1109                         /*
1110                          * Revoke current ISA IRQ 0 assignment and
1111                          * configure a fallback interrupt routing from
1112                          * the 8254 Timer via the 8259 PIC to the
1113                          * an ExtInt interrupt line on IOAPIC #0 intpin 0.
1114                          * We reuse the low level interrupt handler number.
1115                          */
1116                         if (apic_irq(0, 0) < 0) {
1117                                 revoke_apic_irq(apic_8254_intr);
1118                                 assign_apic_irq(0, 0, apic_8254_intr);
1119                         }
1120                         apic_8254_intr = apic_irq(0, 0);
1121                         setup_8254_mixed_mode();
1122                         register_int(apic_8254_intr, clkintr, NULL, "clk",
1123                                      NULL,
1124                                      INTR_EXCL | INTR_FAST |
1125                                      INTR_NOPOLL | INTR_MPSAFE |
1126                                      INTR_NOENTROPY);
1127                         machintr_intren(apic_8254_intr);
1128                 }
1129
1130         }
1131         if (apic_int_type(0, 0) != 3 ||
1132             int_to_apicintpin[apic_8254_intr].ioapic != 0 ||
1133             int_to_apicintpin[apic_8254_intr].int_pin != 0) {
1134                 kprintf("APIC_IO: routing 8254 via IOAPIC #%d intpin %d\n",
1135                        int_to_apicintpin[apic_8254_intr].ioapic,
1136                        int_to_apicintpin[apic_8254_intr].int_pin);
1137         } else {
1138                 kprintf("APIC_IO: "
1139                        "routing 8254 via 8259 and IOAPIC #0 intpin 0\n");
1140         }
1141 #endif
1142 }
1143 SYSINIT(clocks8254, SI_BOOT2_CLOCKREG, SI_ORDER_FIRST, cpu_initclocks, NULL)
1144
1145 #ifdef APIC_IO
1146
1147 static void
1148 setup_8254_mixed_mode(void)
1149 {
1150         /*
1151          * Allow 8254 timer to INTerrupt 8259:
1152          *  re-initialize master 8259:
1153          *   reset; prog 4 bytes, single ICU, edge triggered
1154          */
1155         outb(IO_ICU1, 0x13);
1156         outb(IO_ICU1 + 1, IDT_OFFSET);  /* start vector (unused) */
1157         outb(IO_ICU1 + 1, 0x00);        /* ignore slave */
1158         outb(IO_ICU1 + 1, 0x03);        /* auto EOI, 8086 */
1159         outb(IO_ICU1 + 1, 0xfe);        /* unmask INT0 */
1160
1161         /* program IO APIC for type 3 INT on INT0 */
1162         if (ext_int_setup(0, 0) < 0)
1163                 panic("8254 redirect via APIC pin0 impossible!");
1164 }
1165 #endif
1166
1167 void
1168 setstatclockrate(int newhz)
1169 {
1170         if (newhz == RTC_PROFRATE)
1171                 rtc_statusa = RTCSA_DIVIDER | RTCSA_PROF;
1172         else
1173                 rtc_statusa = RTCSA_DIVIDER | RTCSA_NOPROF;
1174         writertc(RTC_STATUSA, rtc_statusa);
1175 }
1176
1177 #if 0
1178 static unsigned
1179 tsc_get_timecount(struct timecounter *tc)
1180 {
1181         return (rdtsc());
1182 }
1183 #endif
1184
1185 #ifdef KERN_TIMESTAMP
1186 #define KERN_TIMESTAMP_SIZE 16384
1187 static u_long tsc[KERN_TIMESTAMP_SIZE] ;
1188 SYSCTL_OPAQUE(_debug, OID_AUTO, timestamp, CTLFLAG_RD, tsc,
1189         sizeof(tsc), "LU", "Kernel timestamps");
1190 void
1191 _TSTMP(u_int32_t x)
1192 {
1193         static int i;
1194
1195         tsc[i] = (u_int32_t)rdtsc();
1196         tsc[i+1] = x;
1197         i = i + 2;
1198         if (i >= KERN_TIMESTAMP_SIZE)
1199                 i = 0;
1200         tsc[i] = 0; /* mark last entry */
1201 }
1202 #endif /* KERN_TIMESTAMP */
1203
1204 /*
1205  *
1206  */
1207
1208 static int
1209 hw_i8254_timestamp(SYSCTL_HANDLER_ARGS)
1210 {
1211     sysclock_t count;
1212     __uint64_t tscval;
1213     char buf[32];
1214
1215     crit_enter();
1216     if (sys_cputimer == &i8254_cputimer)
1217         count = sys_cputimer->count();
1218     else
1219         count = 0;
1220     if (tsc_present)
1221         tscval = rdtsc();
1222     else
1223         tscval = 0;
1224     crit_exit();
1225     ksnprintf(buf, sizeof(buf), "%08x %016llx", count, (long long)tscval);
1226     return(SYSCTL_OUT(req, buf, strlen(buf) + 1));
1227 }
1228
1229 SYSCTL_NODE(_hw, OID_AUTO, i8254, CTLFLAG_RW, 0, "I8254");
1230 SYSCTL_UINT(_hw_i8254, OID_AUTO, freq, CTLFLAG_RD, &i8254_cputimer.freq, 0,
1231             "frequency");
1232 SYSCTL_PROC(_hw_i8254, OID_AUTO, timestamp, CTLTYPE_STRING|CTLFLAG_RD,
1233             0, 0, hw_i8254_timestamp, "A", "");
1234
1235 SYSCTL_INT(_hw, OID_AUTO, tsc_present, CTLFLAG_RD,
1236             &tsc_present, 0, "TSC Available");
1237 SYSCTL_QUAD(_hw, OID_AUTO, tsc_frequency, CTLFLAG_RD,
1238             &tsc_frequency, 0, "TSC Frequency");
1239