initial commit
[freebsd-arm:freebsd-arm.git] / amd64 / 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  * 4. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  *      from: @(#)clock.c       7.2 (Berkeley) 5/12/91
33  */
34
35 #include <sys/cdefs.h>
36 __FBSDID("$FreeBSD$");
37
38 /*
39  * Routines to handle clock hardware.
40  */
41
42 #include "opt_clock.h"
43 #include "opt_isa.h"
44
45 #include <sys/param.h>
46 #include <sys/systm.h>
47 #include <sys/bus.h>
48 #include <sys/lock.h>
49 #include <sys/kdb.h>
50 #include <sys/mutex.h>
51 #include <sys/proc.h>
52 #include <sys/timetc.h>
53 #include <sys/kernel.h>
54 #include <sys/module.h>
55 #include <sys/sched.h>
56 #include <sys/smp.h>
57 #include <sys/sysctl.h>
58
59 #include <machine/clock.h>
60 #include <machine/cpu.h>
61 #include <machine/intr_machdep.h>
62 #include <machine/md_var.h>
63 #include <machine/apicvar.h>
64 #include <machine/ppireg.h>
65 #include <machine/timerreg.h>
66 #include <machine/smp.h>
67
68 #include <isa/rtc.h>
69 #ifdef DEV_ISA
70 #include <isa/isareg.h>
71 #include <isa/isavar.h>
72 #endif
73
74 #define TIMER_DIV(x) ((i8254_freq + (x) / 2) / (x))
75
76 int     clkintr_pending;
77 static int pscnt = 1;
78 static int psdiv = 1;
79 #ifndef TIMER_FREQ
80 #define TIMER_FREQ   1193182
81 #endif
82 u_int   i8254_freq = TIMER_FREQ;
83 TUNABLE_INT("hw.i8254.freq", &i8254_freq);
84 int     i8254_max_count;
85 static int i8254_real_max_count;
86
87 struct mtx clock_lock;
88 static  struct intsrc *i8254_intsrc;
89 static  u_int32_t i8254_lastcount;
90 static  u_int32_t i8254_offset;
91 static  int     (*i8254_pending)(struct intsrc *);
92 static  int     i8254_ticked;
93 static  int     using_atrtc_timer;
94 static  enum lapic_clock using_lapic_timer = LAPIC_CLOCK_NONE;
95
96 /* Values for timerX_state: */
97 #define RELEASED        0
98 #define RELEASE_PENDING 1
99 #define ACQUIRED        2
100 #define ACQUIRE_PENDING 3
101
102 static  u_char  timer2_state;
103
104 static  unsigned i8254_get_timecount(struct timecounter *tc);
105 static  unsigned i8254_simple_get_timecount(struct timecounter *tc);
106 static  void    set_i8254_freq(u_int freq, int intr_freq);
107
108 static struct timecounter i8254_timecounter = {
109         i8254_get_timecount,    /* get_timecount */
110         0,                      /* no poll_pps */
111         ~0u,                    /* counter_mask */
112         0,                      /* frequency */
113         "i8254",                /* name */
114         0                       /* quality */
115 };
116
117 int
118 hardclockintr(struct trapframe *frame)
119 {
120
121         if (PCPU_GET(cpuid) == 0)
122                 hardclock(TRAPF_USERMODE(frame), TRAPF_PC(frame));
123         else
124                 hardclock_cpu(TRAPF_USERMODE(frame));
125         return (FILTER_HANDLED);
126 }
127
128 int
129 statclockintr(struct trapframe *frame)
130 {
131
132         profclockintr(frame);
133         statclock(TRAPF_USERMODE(frame));
134         return (FILTER_HANDLED);
135 }
136
137 int
138 profclockintr(struct trapframe *frame)
139 {
140
141         if (!using_atrtc_timer)
142                 hardclockintr(frame);
143         if (profprocs != 0)
144                 profclock(TRAPF_USERMODE(frame), TRAPF_PC(frame));
145         return (FILTER_HANDLED);
146 }
147
148 static int
149 clkintr(struct trapframe *frame)
150 {
151
152         if (timecounter->tc_get_timecount == i8254_get_timecount) {
153                 mtx_lock_spin(&clock_lock);
154                 if (i8254_ticked)
155                         i8254_ticked = 0;
156                 else {
157                         i8254_offset += i8254_max_count;
158                         i8254_lastcount = 0;
159                 }
160                 clkintr_pending = 0;
161                 mtx_unlock_spin(&clock_lock);
162         }
163         KASSERT(using_lapic_timer == LAPIC_CLOCK_NONE,
164             ("clk interrupt enabled with lapic timer"));
165
166         if (using_atrtc_timer) {
167 #ifdef SMP
168                 if (smp_started)
169                         ipi_all_but_self(IPI_HARDCLOCK);
170 #endif
171                 hardclockintr(frame);
172         } else {
173                 if (--pscnt <= 0) {
174                         pscnt = psratio;
175 #ifdef SMP
176                         if (smp_started)
177                                 ipi_all_but_self(IPI_STATCLOCK);
178 #endif
179                         statclockintr(frame);
180                 } else {
181 #ifdef SMP
182                         if (smp_started)
183                                 ipi_all_but_self(IPI_PROFCLOCK);
184 #endif
185                         profclockintr(frame);
186                 }
187         }
188
189         return (FILTER_HANDLED);
190 }
191
192 int
193 timer_spkr_acquire(void)
194 {
195         int mode;
196
197         mode = TIMER_SEL2 | TIMER_SQWAVE | TIMER_16BIT;
198
199         if (timer2_state != RELEASED)
200                 return (-1);
201         timer2_state = ACQUIRED;
202
203         /*
204          * This access to the timer registers is as atomic as possible
205          * because it is a single instruction.  We could do better if we
206          * knew the rate.  Use of splclock() limits glitches to 10-100us,
207          * and this is probably good enough for timer2, so we aren't as
208          * careful with it as with timer0.
209          */
210         outb(TIMER_MODE, TIMER_SEL2 | (mode & 0x3f));
211         ppi_spkr_on();          /* enable counter2 output to speaker */
212         return (0);
213 }
214
215 int
216 timer_spkr_release(void)
217 {
218
219         if (timer2_state != ACQUIRED)
220                 return (-1);
221         timer2_state = RELEASED;
222         outb(TIMER_MODE, TIMER_SEL2 | TIMER_SQWAVE | TIMER_16BIT);
223         ppi_spkr_off();         /* disable counter2 output to speaker */
224         return (0);
225 }
226
227 void
228 timer_spkr_setfreq(int freq)
229 {
230
231         freq = i8254_freq / freq;
232         mtx_lock_spin(&clock_lock);
233         outb(TIMER_CNTR2, freq & 0xff);
234         outb(TIMER_CNTR2, freq >> 8);
235         mtx_unlock_spin(&clock_lock);
236 }
237
238 /*
239  * This routine receives statistical clock interrupts from the RTC.
240  * As explained above, these occur at 128 interrupts per second.
241  * When profiling, we receive interrupts at a rate of 1024 Hz.
242  *
243  * This does not actually add as much overhead as it sounds, because
244  * when the statistical clock is active, the hardclock driver no longer
245  * needs to keep (inaccurate) statistics on its own.  This decouples
246  * statistics gathering from scheduling interrupts.
247  *
248  * The RTC chip requires that we read status register C (RTC_INTR)
249  * to acknowledge an interrupt, before it will generate the next one.
250  * Under high interrupt load, rtcintr() can be indefinitely delayed and
251  * the clock can tick immediately after the read from RTC_INTR.  In this
252  * case, the mc146818A interrupt signal will not drop for long enough
253  * to register with the 8259 PIC.  If an interrupt is missed, the stat
254  * clock will halt, considerably degrading system performance.  This is
255  * why we use 'while' rather than a more straightforward 'if' below.
256  * Stat clock ticks can still be lost, causing minor loss of accuracy
257  * in the statistics, but the stat clock will no longer stop.
258  */
259 static int
260 rtcintr(struct trapframe *frame)
261 {
262         int flag = 0;
263
264         while (rtcin(RTC_INTR) & RTCIR_PERIOD) {
265                 flag = 1;
266                 if (--pscnt <= 0) {
267                         pscnt = psdiv;
268 #ifdef SMP
269                         if (smp_started)
270                                 ipi_all_but_self(IPI_STATCLOCK);
271 #endif
272                         statclockintr(frame);
273                 } else {
274 #ifdef SMP
275                         if (smp_started)
276                                 ipi_all_but_self(IPI_PROFCLOCK);
277 #endif
278                         profclockintr(frame);
279                 }
280         }
281         return(flag ? FILTER_HANDLED : FILTER_STRAY);
282 }
283
284 static int
285 getit(void)
286 {
287         int high, low;
288
289         mtx_lock_spin(&clock_lock);
290
291         /* Select timer0 and latch counter value. */
292         outb(TIMER_MODE, TIMER_SEL0 | TIMER_LATCH);
293
294         low = inb(TIMER_CNTR0);
295         high = inb(TIMER_CNTR0);
296
297         mtx_unlock_spin(&clock_lock);
298         return ((high << 8) | low);
299 }
300
301 /*
302  * Wait "n" microseconds.
303  * Relies on timer 1 counting down from (i8254_freq / hz)
304  * Note: timer had better have been programmed before this is first used!
305  */
306 void
307 DELAY(int n)
308 {
309         int delta, prev_tick, tick, ticks_left;
310
311 #ifdef DELAYDEBUG
312         int getit_calls = 1;
313         int n1;
314         static int state = 0;
315 #endif
316
317         if (tsc_freq != 0 && !tsc_is_broken) {
318                 uint64_t start, end, now;
319
320                 sched_pin();
321                 start = rdtsc();
322                 end = start + (tsc_freq * n) / 1000000;
323                 do {
324                         cpu_spinwait();
325                         now = rdtsc();
326                 } while (now < end || (now > start && end < start));
327                 sched_unpin();
328                 return;
329         }
330 #ifdef DELAYDEBUG
331         if (state == 0) {
332                 state = 1;
333                 for (n1 = 1; n1 <= 10000000; n1 *= 10)
334                         DELAY(n1);
335                 state = 2;
336         }
337         if (state == 1)
338                 printf("DELAY(%d)...", n);
339 #endif
340         /*
341          * Read the counter first, so that the rest of the setup overhead is
342          * counted.  Guess the initial overhead is 20 usec (on most systems it
343          * takes about 1.5 usec for each of the i/o's in getit().  The loop
344          * takes about 6 usec on a 486/33 and 13 usec on a 386/20.  The
345          * multiplications and divisions to scale the count take a while).
346          *
347          * However, if ddb is active then use a fake counter since reading
348          * the i8254 counter involves acquiring a lock.  ddb must not do
349          * locking for many reasons, but it calls here for at least atkbd
350          * input.
351          */
352 #ifdef KDB
353         if (kdb_active)
354                 prev_tick = 1;
355         else
356 #endif
357                 prev_tick = getit();
358         n -= 0;                 /* XXX actually guess no initial overhead */
359         /*
360          * Calculate (n * (i8254_freq / 1e6)) without using floating point
361          * and without any avoidable overflows.
362          */
363         if (n <= 0)
364                 ticks_left = 0;
365         else if (n < 256)
366                 /*
367                  * Use fixed point to avoid a slow division by 1000000.
368                  * 39099 = 1193182 * 2^15 / 10^6 rounded to nearest.
369                  * 2^15 is the first power of 2 that gives exact results
370                  * for n between 0 and 256.
371                  */
372                 ticks_left = ((u_int)n * 39099 + (1 << 15) - 1) >> 15;
373         else
374                 /*
375                  * Don't bother using fixed point, although gcc-2.7.2
376                  * generates particularly poor code for the long long
377                  * division, since even the slow way will complete long
378                  * before the delay is up (unless we're interrupted).
379                  */
380                 ticks_left = ((u_int)n * (long long)i8254_freq + 999999)
381                              / 1000000;
382
383         while (ticks_left > 0) {
384 #ifdef KDB
385                 if (kdb_active) {
386                         inb(0x84);
387                         tick = prev_tick - 1;
388                         if (tick <= 0)
389                                 tick = i8254_max_count;
390                 } else
391 #endif
392                         tick = getit();
393 #ifdef DELAYDEBUG
394                 ++getit_calls;
395 #endif
396                 delta = prev_tick - tick;
397                 prev_tick = tick;
398                 if (delta < 0) {
399                         delta += i8254_max_count;
400                         /*
401                          * Guard against i8254_max_count being wrong.
402                          * This shouldn't happen in normal operation,
403                          * but it may happen if set_i8254_freq() is
404                          * traced.
405                          */
406                         if (delta < 0)
407                                 delta = 0;
408                 }
409                 ticks_left -= delta;
410         }
411 #ifdef DELAYDEBUG
412         if (state == 1)
413                 printf(" %d calls to getit() at %d usec each\n",
414                        getit_calls, (n + 5) / getit_calls);
415 #endif
416 }
417
418 static void
419 set_i8254_freq(u_int freq, int intr_freq)
420 {
421         int new_i8254_real_max_count;
422
423         i8254_timecounter.tc_frequency = freq;
424         mtx_lock_spin(&clock_lock);
425         i8254_freq = freq;
426         if (using_lapic_timer != LAPIC_CLOCK_NONE)
427                 new_i8254_real_max_count = 0x10000;
428         else
429                 new_i8254_real_max_count = TIMER_DIV(intr_freq);
430         if (new_i8254_real_max_count != i8254_real_max_count) {
431                 i8254_real_max_count = new_i8254_real_max_count;
432                 if (i8254_real_max_count == 0x10000)
433                         i8254_max_count = 0xffff;
434                 else
435                         i8254_max_count = i8254_real_max_count;
436                 outb(TIMER_MODE, TIMER_SEL0 | TIMER_RATEGEN | TIMER_16BIT);
437                 outb(TIMER_CNTR0, i8254_real_max_count & 0xff);
438                 outb(TIMER_CNTR0, i8254_real_max_count >> 8);
439         }
440         mtx_unlock_spin(&clock_lock);
441 }
442
443 static void
444 i8254_restore(void)
445 {
446
447         mtx_lock_spin(&clock_lock);
448         outb(TIMER_MODE, TIMER_SEL0 | TIMER_RATEGEN | TIMER_16BIT);
449         outb(TIMER_CNTR0, i8254_real_max_count & 0xff);
450         outb(TIMER_CNTR0, i8254_real_max_count >> 8);
451         mtx_unlock_spin(&clock_lock);
452 }
453
454 /* This is separate from startrtclock() so that it can be called early. */
455 void
456 i8254_init(void)
457 {
458
459         mtx_init(&clock_lock, "clk", NULL, MTX_SPIN | MTX_NOPROFILE);
460         set_i8254_freq(i8254_freq, hz);
461 }
462
463 void
464 startrtclock()
465 {
466
467         atrtc_start();
468
469         set_i8254_freq(i8254_freq, hz);
470         tc_init(&i8254_timecounter);
471
472         init_TSC();
473 }
474
475 /*
476  * Start both clocks running.
477  */
478 void
479 cpu_initclocks()
480 {
481
482         using_lapic_timer = lapic_setup_clock();
483         /*
484          * If we aren't using the local APIC timer to drive the kernel
485          * clocks, setup the interrupt handler for the 8254 timer 0 so
486          * that it can drive hardclock().  Otherwise, change the 8254
487          * timecounter to user a simpler algorithm.
488          */
489         if (using_lapic_timer == LAPIC_CLOCK_NONE) {
490                 intr_add_handler("clk", 0, (driver_filter_t *)clkintr, NULL,
491                     NULL, INTR_TYPE_CLK, NULL);
492                 i8254_intsrc = intr_lookup_source(0);
493                 if (i8254_intsrc != NULL)
494                         i8254_pending =
495                             i8254_intsrc->is_pic->pic_source_pending;
496         } else {
497                 i8254_timecounter.tc_get_timecount =
498                     i8254_simple_get_timecount;
499                 i8254_timecounter.tc_counter_mask = 0xffff;
500                 set_i8254_freq(i8254_freq, hz);
501         }
502
503         /* Initialize RTC. */
504         atrtc_start();
505
506         /*
507          * If the separate statistics clock hasn't been explicility disabled
508          * and we aren't already using the local APIC timer to drive the
509          * kernel clocks, then setup the RTC to periodically interrupt to
510          * drive statclock() and profclock().
511          */
512         if (using_lapic_timer != LAPIC_CLOCK_ALL) {
513                 using_atrtc_timer = atrtc_setup_clock();
514                 if (using_atrtc_timer) {
515                         /* Enable periodic interrupts from the RTC. */
516                         intr_add_handler("rtc", 8,
517                             (driver_filter_t *)rtcintr, NULL, NULL,
518                             INTR_TYPE_CLK, NULL);
519                         atrtc_enable_intr();
520                 } else {
521                         profhz = hz;
522                         if (hz < 128)
523                                 stathz = hz;
524                         else
525                                 stathz = hz / (hz / 128);
526                 }
527         }
528
529         init_TSC_tc();
530 }
531
532 void
533 cpu_startprofclock(void)
534 {
535
536         if (using_lapic_timer == LAPIC_CLOCK_ALL || !using_atrtc_timer)
537                 return;
538         atrtc_rate(RTCSA_PROF);
539         psdiv = pscnt = psratio;
540 }
541
542 void
543 cpu_stopprofclock(void)
544 {
545
546         if (using_lapic_timer == LAPIC_CLOCK_ALL || !using_atrtc_timer)
547                 return;
548         atrtc_rate(RTCSA_NOPROF);
549         psdiv = pscnt = 1;
550 }
551
552 static int
553 sysctl_machdep_i8254_freq(SYSCTL_HANDLER_ARGS)
554 {
555         int error;
556         u_int freq;
557
558         /*
559          * Use `i8254' instead of `timer' in external names because `timer'
560          * is is too generic.  Should use it everywhere.
561          */
562         freq = i8254_freq;
563         error = sysctl_handle_int(oidp, &freq, 0, req);
564         if (error == 0 && req->newptr != NULL)
565                 set_i8254_freq(freq, hz);
566         return (error);
567 }
568
569 SYSCTL_PROC(_machdep, OID_AUTO, i8254_freq, CTLTYPE_INT | CTLFLAG_RW,
570     0, sizeof(u_int), sysctl_machdep_i8254_freq, "IU", "");
571
572 static unsigned
573 i8254_simple_get_timecount(struct timecounter *tc)
574 {
575
576         return (i8254_max_count - getit());
577 }
578
579 static unsigned
580 i8254_get_timecount(struct timecounter *tc)
581 {
582         u_int count;
583         u_int high, low;
584         u_long rflags;
585
586         rflags = read_rflags();
587         mtx_lock_spin(&clock_lock);
588
589         /* Select timer0 and latch counter value. */
590         outb(TIMER_MODE, TIMER_SEL0 | TIMER_LATCH);
591
592         low = inb(TIMER_CNTR0);
593         high = inb(TIMER_CNTR0);
594         count = i8254_max_count - ((high << 8) | low);
595         if (count < i8254_lastcount ||
596             (!i8254_ticked && (clkintr_pending ||
597             ((count < 20 || (!(rflags & PSL_I) &&
598             count < i8254_max_count / 2u)) &&
599             i8254_pending != NULL && i8254_pending(i8254_intsrc))))) {
600                 i8254_ticked = 1;
601                 i8254_offset += i8254_max_count;
602         }
603         i8254_lastcount = count;
604         count += i8254_offset;
605         mtx_unlock_spin(&clock_lock);
606         return (count);
607 }
608
609 #ifdef DEV_ISA
610 /*
611  * Attach to the ISA PnP descriptors for the timer
612  */
613 static struct isa_pnp_id attimer_ids[] = {
614         { 0x0001d041 /* PNP0100 */, "AT timer" },
615         { 0 }
616 };
617
618 static int
619 attimer_probe(device_t dev)
620 {
621         int result;
622         
623         result = ISA_PNP_PROBE(device_get_parent(dev), dev, attimer_ids);
624         if (result <= 0)
625                 device_quiet(dev);
626         return(result);
627 }
628
629 static int
630 attimer_attach(device_t dev)
631 {
632         return(0);
633 }
634
635 static int
636 attimer_resume(device_t dev)
637 {
638
639         i8254_restore();
640         return(0);
641 }
642
643 static device_method_t attimer_methods[] = {
644         /* Device interface */
645         DEVMETHOD(device_probe,         attimer_probe),
646         DEVMETHOD(device_attach,        attimer_attach),
647         DEVMETHOD(device_detach,        bus_generic_detach),
648         DEVMETHOD(device_shutdown,      bus_generic_shutdown),
649         DEVMETHOD(device_suspend,       bus_generic_suspend),
650         DEVMETHOD(device_resume,        attimer_resume),
651         { 0, 0 }
652 };
653
654 static driver_t attimer_driver = {
655         "attimer",
656         attimer_methods,
657         1,              /* no softc */
658 };
659
660 static devclass_t attimer_devclass;
661
662 DRIVER_MODULE(attimer, isa, attimer_driver, attimer_devclass, 0, 0);
663 DRIVER_MODULE(attimer, acpi, attimer_driver, attimer_devclass, 0, 0);
664
665 #endif /* DEV_ISA */