2 * Copyright (c) 1996, by Steve Passe
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. The name of the developer may NOT be used to endorse or promote products
11 * derived from this software without specific prior written permission.
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25 * $FreeBSD: src/sys/i386/i386/mpapic.c,v 1.37.2.7 2003/01/25 02:31:47 peter Exp $
26 * $DragonFly: src/sys/platform/pc32/apic/mpapic.c,v 1.13 2005/11/04 01:21:39 dillon Exp $
29 #include <sys/param.h>
30 #include <sys/systm.h>
31 #include <machine/globaldata.h>
32 #include <machine/smp.h>
33 #include <arch/apic/mpapic.h>
34 #include <machine/segments.h>
35 #include <sys/thread2.h>
37 #include <i386/isa/intr_machdep.h> /* Xspuriousint() */
39 /* EISA Edge/Level trigger control registers */
40 #define ELCR0 0x4d0 /* eisa irq 0-7 */
41 #define ELCR1 0x4d1 /* eisa irq 8-15 */
44 * pointers to pmapped apic hardware.
48 volatile ioapic_t **ioapic;
52 * Enable APIC, configure interrupts.
60 * setup LVT1 as ExtINT. Edge trigger, active high.
62 temp = lapic.lvt_lint0;
63 temp &= ~(APIC_LVT_MASKED | APIC_LVT_TRIG_MASK |
64 APIC_LVT_POLARITY_MASK | APIC_LVT_DM_MASK);
65 if (mycpu->gd_cpuid == 0)
66 temp |= APIC_LVT_DM_EXTINT;
68 temp |= APIC_LVT_DM_EXTINT | APIC_LVT_MASKED;
69 lapic.lvt_lint0 = temp;
72 * setup LVT2 as NMI, masked till later. Edge trigger, active high.
74 temp = lapic.lvt_lint1;
75 temp &= ~(APIC_LVT_MASKED | APIC_LVT_TRIG_MASK |
76 APIC_LVT_POLARITY_MASK | APIC_LVT_DM_MASK);
77 temp |= APIC_LVT_MASKED | APIC_LVT_DM_NMI;
78 lapic.lvt_lint1 = temp;
81 * Set the Task Priority Register as needed. At the moment allow
82 * interrupts on all cpus (the APs will remain CLId until they are
83 * ready to deal). We could disable all but IPIs by setting
84 * temp |= TPR_IPI_ONLY for cpu != 0.
87 temp &= ~APIC_TPR_PRIO; /* clear priority field */
91 /* enable the local APIC */
93 temp &= ~APIC_SVR_FOCUS_DISABLE; /* enable lopri focus processor */
94 temp |= APIC_SVR_ENABLE; /* enable the APIC */
97 * Set the spurious interrupt vector. The low 4 bits of the vector
100 if ((XSPURIOUSINT_OFFSET & 0x0F) != 0x0F)
101 panic("bad XSPURIOUSINT_OFFSET: 0x%08x", XSPURIOUSINT_OFFSET);
102 temp &= ~APIC_SVR_VECTOR;
103 temp |= XSPURIOUSINT_OFFSET;
108 apic_dump("apic_initialize()");
113 * dump contents of local APIC registers
118 printf("SMP: CPU%d %s:\n", mycpu->gd_cpuid, str);
119 printf(" lint0: 0x%08x lint1: 0x%08x TPR: 0x%08x SVR: 0x%08x\n",
120 lapic.lvt_lint0, lapic.lvt_lint1, lapic.tpr, lapic.svr);
130 #define IOAPIC_ISA_INTS 16
131 #define REDIRCNT_IOAPIC(A) \
132 ((int)((io_apic_versions[(A)] & IOART_VER_MAXREDIR) >> MAXREDIRSHIFT) + 1)
134 static int trigger (int apic, int pin, u_int32_t * flags);
135 static void polarity (int apic, int pin, u_int32_t * flags, int level);
137 #define DEFAULT_FLAGS \
143 #define DEFAULT_ISA_FLAGS \
152 io_apic_set_id(int apic, int id)
156 ux = io_apic_read(apic, IOAPIC_ID); /* get current contents */
157 if (((ux & APIC_ID_MASK) >> 24) != id) {
158 printf("Changing APIC ID for IO APIC #%d"
159 " from %d to %d on chip\n",
160 apic, ((ux & APIC_ID_MASK) >> 24), id);
161 ux &= ~APIC_ID_MASK; /* clear the ID field */
163 io_apic_write(apic, IOAPIC_ID, ux); /* write new value */
164 ux = io_apic_read(apic, IOAPIC_ID); /* re-read && test */
165 if (((ux & APIC_ID_MASK) >> 24) != id)
166 panic("can't control IO APIC #%d ID, reg: 0x%08x",
173 io_apic_get_id(int apic)
175 return (io_apic_read(apic, IOAPIC_ID) & APIC_ID_MASK) >> 24;
184 extern int apic_pin_trigger; /* 'opaque' */
187 io_apic_setup_intpin(int apic, int pin)
189 int bus, bustype, irq;
190 u_char select; /* the select register is 8 bits */
191 u_int32_t flags; /* the window register is 32 bits */
192 u_int32_t target; /* the window register is 32 bits */
193 u_int32_t vector; /* the window register is 32 bits */
196 select = pin * 2 + IOAPIC_REDTBL0; /* register */
199 * Always clear an IO APIC pin before [re]programming it. This is
200 * particularly important if the pin is set up for a level interrupt
201 * as the IOART_REM_IRR bit might be set. When we reprogram the
202 * vector any EOI from pending ints on this pin could be lost and
203 * IRR might never get reset.
205 * To fix this problem, clear the vector and make sure it is
206 * programmed as an edge interrupt. This should theoretically
207 * clear IRR so we can later, safely program it as a level
212 flags = io_apic_read(apic, select) & IOART_RESV;
213 flags |= IOART_INTMSET | IOART_TRGREDG | IOART_INTAHI;
214 flags |= IOART_DESTPHY | IOART_DELFIXED;
216 target = io_apic_read(apic, select + 1) & IOART_HI_DEST_RESV;
217 target |= 0; /* fixed mode cpu mask of 0 - don't deliver anywhere */
221 io_apic_write(apic, select, flags | vector);
222 io_apic_write(apic, select + 1, target);
227 * We only deal with vectored interrupts here. ? documentation is
228 * lacking, I'm guessing an interrupt type of 0 is the 'INT' type,
231 * This test also catches unconfigured pins.
233 if (apic_int_type(apic, pin) != 0)
237 * Leave the pin unprogrammed if it does not correspond to
240 irq = apic_irq(apic, pin);
244 /* determine the bus type for this pin */
245 bus = apic_src_bus_id(apic, pin);
248 bustype = apic_bus_type(bus);
250 if ((bustype == ISA) &&
251 (pin < IOAPIC_ISA_INTS) &&
253 (apic_polarity(apic, pin) == 0x1) &&
254 (apic_trigger(apic, pin) == 0x3)) {
256 * A broken BIOS might describe some ISA
257 * interrupts as active-high level-triggered.
258 * Use default ISA flags for those interrupts.
260 flags = DEFAULT_ISA_FLAGS;
263 * Program polarity and trigger mode according to
266 flags = DEFAULT_FLAGS;
267 level = trigger(apic, pin, &flags);
269 apic_pin_trigger |= (1 << irq);
270 polarity(apic, pin, &flags, level);
274 printf("IOAPIC #%d intpin %d -> irq %d\n",
279 * Program the appropriate registers. This routing may be
280 * overridden when an interrupt handler for a device is
281 * actually added (see inthand_add(), which calls through
282 * the MACHINTR ABI to set up an interrupt handler/vector).
284 * The order in which we must program the two registers for
285 * safety is unclear! XXX
289 vector = IDT_OFFSET + irq; /* IDT vec */
290 target = io_apic_read(apic, select + 1) & IOART_HI_DEST_RESV;
291 target |= IOART_HI_DEST_BROADCAST;
292 flags |= io_apic_read(apic, select) & IOART_RESV;
293 io_apic_write(apic, select, flags | vector);
294 io_apic_write(apic, select + 1, target);
300 io_apic_setup(int apic)
306 apic_pin_trigger = 0; /* default to edge-triggered */
308 maxpin = REDIRCNT_IOAPIC(apic); /* pins in APIC */
309 printf("Programming %d pins in IOAPIC #%d\n", maxpin, apic);
311 for (pin = 0; pin < maxpin; ++pin) {
312 io_apic_setup_intpin(apic, pin);
315 /* return GOOD status */
318 #undef DEFAULT_ISA_FLAGS
322 #define DEFAULT_EXTINT_FLAGS \
331 * Setup the source of External INTerrupts.
334 ext_int_setup(int apic, int intr)
336 u_char select; /* the select register is 8 bits */
337 u_int32_t flags; /* the window register is 32 bits */
338 u_int32_t target; /* the window register is 32 bits */
339 u_int32_t vector; /* the window register is 32 bits */
341 if (apic_int_type(apic, intr) != 3)
344 target = IOART_HI_DEST_BROADCAST;
345 select = IOAPIC_REDTBL0 + (2 * intr);
346 vector = NRSVIDT + intr;
347 flags = DEFAULT_EXTINT_FLAGS;
349 io_apic_write(apic, select, flags | vector);
350 io_apic_write(apic, select + 1, target);
354 #undef DEFAULT_EXTINT_FLAGS
358 * Set the trigger level for an IO APIC pin.
361 trigger(int apic, int pin, u_int32_t * flags)
366 static int intcontrol = -1;
368 switch (apic_trigger(apic, pin)) {
374 *flags &= ~IOART_TRGRLVL; /* *flags |= IOART_TRGREDG */
378 *flags |= IOART_TRGRLVL;
386 if ((id = apic_src_bus_id(apic, pin)) == -1)
389 switch (apic_bus_type(id)) {
391 *flags &= ~IOART_TRGRLVL; /* *flags |= IOART_TRGREDG; */
395 eirq = apic_src_bus_irq(apic, pin);
397 if (eirq < 0 || eirq > 15) {
398 printf("EISA IRQ %d?!?!\n", eirq);
402 if (intcontrol == -1) {
403 intcontrol = inb(ELCR1) << 8;
404 intcontrol |= inb(ELCR0);
405 printf("EISA INTCONTROL = %08x\n", intcontrol);
408 /* Use ELCR settings to determine level or edge mode */
409 level = (intcontrol >> eirq) & 1;
412 * Note that on older Neptune chipset based systems, any
413 * pci interrupts often show up here and in the ELCR as well
414 * as level sensitive interrupts attributed to the EISA bus.
418 *flags |= IOART_TRGRLVL;
420 *flags &= ~IOART_TRGRLVL;
425 *flags |= IOART_TRGRLVL;
434 panic("bad APIC IO INT flags");
439 * Set the polarity value for an IO APIC pin.
442 polarity(int apic, int pin, u_int32_t * flags, int level)
446 switch (apic_polarity(apic, pin)) {
452 *flags &= ~IOART_INTALO; /* *flags |= IOART_INTAHI */
456 *flags |= IOART_INTALO;
464 if ((id = apic_src_bus_id(apic, pin)) == -1)
467 switch (apic_bus_type(id)) {
469 *flags &= ~IOART_INTALO; /* *flags |= IOART_INTAHI */
473 /* polarity converter always gives active high */
474 *flags &= ~IOART_INTALO;
478 *flags |= IOART_INTALO;
487 panic("bad APIC IO INT flags");
492 * Print contents of apic_imen.
494 extern u_int apic_imen; /* keep apic_imen 'opaque' */
500 printf("SMP: enabled INTs: ");
501 for (x = 0; x < 24; ++x)
502 if ((apic_imen & (1 << x)) == 0)
504 printf("apic_imen: 0x%08x\n", apic_imen);
509 * Inter Processor Interrupt functions.
514 * Send APIC IPI 'vector' to 'destType' via 'deliveryMode'.
516 * destType is 1 of: APIC_DEST_SELF, APIC_DEST_ALLISELF, APIC_DEST_ALLESELF
517 * vector is any valid SYSTEM INT vector
518 * delivery_mode is 1 of: APIC_DELMODE_FIXED, APIC_DELMODE_LOWPRIO
520 * A backlog of requests can create a deadlock between cpus. To avoid this
521 * we have to be able to accept IPIs at the same time we are trying to send
522 * them. The critical section prevents us from attempting to send additional
523 * IPIs reentrantly, but also prevents IPIQ processing so we have to call
524 * lwkt_process_ipiq() manually. It's rather messy and expensive for this
525 * to occur but fortunately it does not happen too often.
528 apic_ipi(int dest_type, int vector, int delivery_mode)
533 if ((lapic.icr_lo & APIC_DELSTAT_MASK) != 0) {
534 unsigned int eflags = read_eflags();
536 while ((lapic.icr_lo & APIC_DELSTAT_MASK) != 0) {
539 write_eflags(eflags);
542 icr_lo = (lapic.icr_lo & APIC_ICRLO_RESV_MASK) | dest_type |
543 delivery_mode | vector;
544 lapic.icr_lo = icr_lo;
550 single_apic_ipi(int cpu, int vector, int delivery_mode)
556 if ((lapic.icr_lo & APIC_DELSTAT_MASK) != 0) {
557 unsigned int eflags = read_eflags();
559 while ((lapic.icr_lo & APIC_DELSTAT_MASK) != 0) {
562 write_eflags(eflags);
564 icr_hi = lapic.icr_hi & ~APIC_ID_MASK;
565 icr_hi |= (CPU_TO_ID(cpu) << 24);
566 lapic.icr_hi = icr_hi;
569 icr_lo = (lapic.icr_lo & APIC_ICRLO_RESV_MASK)
570 | APIC_DEST_DESTFLD | delivery_mode | vector;
573 lapic.icr_lo = icr_lo;
580 * Returns 0 if the apic is busy, 1 if we were able to queue the request.
582 * NOT WORKING YET! The code as-is may end up not queueing an IPI at all
583 * to the target, and the scheduler does not 'poll' for IPI messages.
586 single_apic_ipi_passive(int cpu, int vector, int delivery_mode)
592 if ((lapic.icr_lo & APIC_DELSTAT_MASK) != 0) {
596 icr_hi = lapic.icr_hi & ~APIC_ID_MASK;
597 icr_hi |= (CPU_TO_ID(cpu) << 24);
598 lapic.icr_hi = icr_hi;
601 icr_lo = (lapic.icr_lo & APIC_RESV2_MASK)
602 | APIC_DEST_DESTFLD | delivery_mode | vector;
605 lapic.icr_lo = icr_lo;
613 * Send APIC IPI 'vector' to 'target's via 'delivery_mode'.
615 * target is a bitmask of destination cpus. Vector is any
616 * valid system INT vector. Delivery mode may be either
617 * APIC_DELMODE_FIXED or APIC_DELMODE_LOWPRIO.
620 selected_apic_ipi(u_int target, int vector, int delivery_mode)
624 int n = bsfl(target);
626 single_apic_ipi(n, vector, delivery_mode);
634 * Timer code, in development...
635 * - suggested by rgrimes@gndrsh.aac.dev.com
638 /** XXX FIXME: temp hack till we can determin bus clock */
640 #define BUS_CLOCK 66000000
641 #define bus_clock() 66000000
645 int acquire_apic_timer (void);
646 int release_apic_timer (void);
649 * Acquire the APIC timer for exclusive use.
652 acquire_apic_timer(void)
657 /** XXX FIXME: make this really do something */
658 panic("APIC timer in use when attempting to aquire");
664 * Return the APIC timer.
667 release_apic_timer(void)
672 /** XXX FIXME: make this really do something */
673 panic("APIC timer was already released");
680 * Load a 'downcount time' in uSeconds.
683 set_apic_timer(int value)
686 long ticks_per_microsec;
689 * Calculate divisor and count from value:
691 * timeBase == CPU bus clock divisor == [1,2,4,8,16,32,64,128]
692 * value == time in uS
694 lapic.dcr_timer = APIC_TDCR_1;
695 ticks_per_microsec = bus_clock() / 1000000;
697 /* configure timer as one-shot */
698 lvtt = lapic.lvt_timer;
699 lvtt &= ~(APIC_LVTT_VECTOR | APIC_LVTT_DS);
700 lvtt &= ~(APIC_LVTT_PERIODIC);
701 lvtt |= APIC_LVTT_MASKED; /* no INT, one-shot */
702 lapic.lvt_timer = lvtt;
705 lapic.icr_timer = value * ticks_per_microsec;
710 * Read remaining time in timer.
713 read_apic_timer(void)
716 /** XXX FIXME: we need to return the actual remaining time,
717 * for now we just return the remaining count.
720 return lapic.ccr_timer;
726 * Spin-style delay, set delay time in uS, spin till it drains.
731 set_apic_timer(count);
732 while (read_apic_timer())