2 * Copyright (c) 2003 John Baldwin <jhb@FreeBSD.org>
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. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * Machine dependent interrupt code for x86. For x86, we have to
31 * deal with different PICs. Thus, we use the passed in vector to lookup
32 * an interrupt source associated with that vector. The interrupt source
33 * describes which PIC the source belongs to and includes methods to handle
37 #include "opt_atpic.h"
40 #include <sys/param.h>
42 #include <sys/interrupt.h>
44 #include <sys/kernel.h>
46 #include <sys/mutex.h>
50 #include <sys/syslog.h>
51 #include <sys/systm.h>
52 #include <machine/clock.h>
53 #include <machine/intr_machdep.h>
54 #include <machine/smp.h>
60 #include <machine/segments.h>
61 #include <machine/frame.h>
62 #include <dev/ic/i8259.h>
63 #include <x86/isa/icu.h>
65 #include <pc98/cbus/cbus.h>
67 #include <x86/isa/isa.h>
71 #define MAX_STRAY_LOG 5
73 typedef void (*mask_fn)(void *);
75 static int intrcnt_index;
76 static struct intsrc *interrupt_sources[NUM_IO_INTS];
77 static struct sx intrsrc_lock;
78 static struct mtx intrpic_lock;
79 static struct mtx intrcnt_lock;
80 static TAILQ_HEAD(pics_head, pic) pics;
83 static int assign_cpu;
86 u_long intrcnt[INTRCNT_COUNT];
87 char intrnames[INTRCNT_COUNT * (MAXCOMLEN + 1)];
88 size_t sintrcnt = sizeof(intrcnt);
89 size_t sintrnames = sizeof(intrnames);
91 static int intr_assign_cpu(void *arg, u_char cpu);
92 static void intr_disable_src(void *arg);
93 static void intr_init(void *__dummy);
94 static int intr_pic_registered(struct pic *pic);
95 static void intrcnt_setname(const char *name, int index);
96 static void intrcnt_updatename(struct intsrc *is);
97 static void intrcnt_register(struct intsrc *is);
100 intr_pic_registered(struct pic *pic)
104 TAILQ_FOREACH(p, &pics, pics) {
112 * Register a new interrupt controller (PIC). This is to support suspend
113 * and resume where we suspend/resume controllers rather than individual
114 * sources. This also allows controllers with no active sources (such as
115 * 8259As in a system using the APICs) to participate in suspend and resume.
118 intr_register_pic(struct pic *pic)
122 mtx_lock(&intrpic_lock);
123 if (intr_pic_registered(pic))
126 TAILQ_INSERT_TAIL(&pics, pic, pics);
129 mtx_unlock(&intrpic_lock);
134 * Register a new interrupt source with the global interrupt system.
135 * The global interrupts need to be disabled when this function is
139 intr_register_source(struct intsrc *isrc)
143 KASSERT(intr_pic_registered(isrc->is_pic), ("unregistered PIC"));
144 vector = isrc->is_pic->pic_vector(isrc);
145 if (interrupt_sources[vector] != NULL)
147 error = intr_event_create(&isrc->is_event, isrc, 0, vector,
148 intr_disable_src, (mask_fn)isrc->is_pic->pic_enable_source,
149 (mask_fn)isrc->is_pic->pic_eoi_source, intr_assign_cpu, "irq%d:",
153 sx_xlock(&intrsrc_lock);
154 if (interrupt_sources[vector] != NULL) {
155 sx_xunlock(&intrsrc_lock);
156 intr_event_destroy(isrc->is_event);
159 intrcnt_register(isrc);
160 interrupt_sources[vector] = isrc;
161 isrc->is_handlers = 0;
162 sx_xunlock(&intrsrc_lock);
167 intr_lookup_source(int vector)
170 return (interrupt_sources[vector]);
174 intr_add_handler(const char *name, int vector, driver_filter_t filter,
175 driver_intr_t handler, void *arg, enum intr_type flags, void **cookiep)
180 isrc = intr_lookup_source(vector);
183 error = intr_event_add_handler(isrc->is_event, name, filter, handler,
184 arg, intr_priority(flags), flags, cookiep);
186 sx_xlock(&intrsrc_lock);
187 intrcnt_updatename(isrc);
189 if (isrc->is_handlers == 1) {
190 isrc->is_pic->pic_enable_intr(isrc);
191 isrc->is_pic->pic_enable_source(isrc);
193 sx_xunlock(&intrsrc_lock);
199 intr_remove_handler(void *cookie)
204 isrc = intr_handler_source(cookie);
205 error = intr_event_remove_handler(cookie);
207 sx_xlock(&intrsrc_lock);
209 if (isrc->is_handlers == 0) {
210 isrc->is_pic->pic_disable_source(isrc, PIC_NO_EOI);
211 isrc->is_pic->pic_disable_intr(isrc);
213 intrcnt_updatename(isrc);
214 sx_xunlock(&intrsrc_lock);
220 intr_config_intr(int vector, enum intr_trigger trig, enum intr_polarity pol)
224 isrc = intr_lookup_source(vector);
227 return (isrc->is_pic->pic_config_intr(isrc, trig, pol));
231 intr_disable_src(void *arg)
236 isrc->is_pic->pic_disable_source(isrc, PIC_EOI);
240 intr_execute_handlers(struct intsrc *isrc, struct trapframe *frame)
242 struct intr_event *ie;
246 * We count software interrupts when we process them. The
247 * code here follows previous practice, but there's an
248 * argument for counting hardware interrupts when they're
252 PCPU_INC(cnt.v_intr);
257 * XXX: We assume that IRQ 0 is only used for the ISA timer
260 vector = isrc->is_pic->pic_vector(isrc);
265 * For stray interrupts, mask and EOI the source, bump the
266 * stray count, and log the condition.
268 if (intr_event_handle(ie, frame) != 0) {
269 isrc->is_pic->pic_disable_source(isrc, PIC_EOI);
270 (*isrc->is_straycount)++;
271 if (*isrc->is_straycount < MAX_STRAY_LOG)
272 log(LOG_ERR, "stray irq%d\n", vector);
273 else if (*isrc->is_straycount == MAX_STRAY_LOG)
275 "too many stray irq %d's: not logging anymore\n",
281 intr_resume(bool suspend_cancelled)
288 mtx_lock(&intrpic_lock);
289 TAILQ_FOREACH(pic, &pics, pics) {
290 if (pic->pic_resume != NULL)
291 pic->pic_resume(pic, suspend_cancelled);
293 mtx_unlock(&intrpic_lock);
301 mtx_lock(&intrpic_lock);
302 TAILQ_FOREACH_REVERSE(pic, &pics, pics_head, pics) {
303 if (pic->pic_suspend != NULL)
304 pic->pic_suspend(pic);
306 mtx_unlock(&intrpic_lock);
310 intr_assign_cpu(void *arg, u_char cpu)
317 * Don't do anything during early boot. We will pick up the
318 * assignment once the APs are started.
320 if (assign_cpu && cpu != NOCPU) {
322 sx_xlock(&intrsrc_lock);
323 error = isrc->is_pic->pic_assign_cpu(isrc, cpu_apic_ids[cpu]);
324 sx_xunlock(&intrsrc_lock);
334 intrcnt_setname(const char *name, int index)
337 snprintf(intrnames + (MAXCOMLEN + 1) * index, MAXCOMLEN + 1, "%-*s",
342 intrcnt_updatename(struct intsrc *is)
345 intrcnt_setname(is->is_event->ie_fullname, is->is_index);
349 intrcnt_register(struct intsrc *is)
351 char straystr[MAXCOMLEN + 1];
353 KASSERT(is->is_event != NULL, ("%s: isrc with no event", __func__));
354 mtx_lock_spin(&intrcnt_lock);
355 is->is_index = intrcnt_index;
357 snprintf(straystr, MAXCOMLEN + 1, "stray irq%d",
358 is->is_pic->pic_vector(is));
359 intrcnt_updatename(is);
360 is->is_count = &intrcnt[is->is_index];
361 intrcnt_setname(straystr, is->is_index + 1);
362 is->is_straycount = &intrcnt[is->is_index + 1];
363 mtx_unlock_spin(&intrcnt_lock);
367 intrcnt_add(const char *name, u_long **countp)
370 mtx_lock_spin(&intrcnt_lock);
371 *countp = &intrcnt[intrcnt_index];
372 intrcnt_setname(name, intrcnt_index);
374 mtx_unlock_spin(&intrcnt_lock);
378 intr_init(void *dummy __unused)
381 intrcnt_setname("???", 0);
384 mtx_init(&intrpic_lock, "intrpic", NULL, MTX_DEF);
385 sx_init(&intrsrc_lock, "intrsrc");
386 mtx_init(&intrcnt_lock, "intrcnt", NULL, MTX_SPIN);
388 SYSINIT(intr_init, SI_SUB_INTR, SI_ORDER_FIRST, intr_init, NULL);
391 /* Initialize the two 8259A's to a known-good shutdown state. */
396 outb(IO_ICU1, ICW1_RESET | ICW1_IC4);
397 outb(IO_ICU1 + ICU_IMR_OFFSET, IDT_IO_INTS);
398 outb(IO_ICU1 + ICU_IMR_OFFSET, IRQ_MASK(ICU_SLAVEID));
399 outb(IO_ICU1 + ICU_IMR_OFFSET, MASTER_MODE);
400 outb(IO_ICU1 + ICU_IMR_OFFSET, 0xff);
401 outb(IO_ICU1, OCW3_SEL | OCW3_RR);
403 outb(IO_ICU2, ICW1_RESET | ICW1_IC4);
404 outb(IO_ICU2 + ICU_IMR_OFFSET, IDT_IO_INTS + 8);
405 outb(IO_ICU2 + ICU_IMR_OFFSET, ICU_SLAVEID);
406 outb(IO_ICU2 + ICU_IMR_OFFSET, SLAVE_MODE);
407 outb(IO_ICU2 + ICU_IMR_OFFSET, 0xff);
408 outb(IO_ICU2, OCW3_SEL | OCW3_RR);
412 /* Add a description to an active interrupt handler. */
414 intr_describe(u_int vector, void *ih, const char *descr)
419 isrc = intr_lookup_source(vector);
422 error = intr_event_describe_handler(isrc->is_event, ih, descr);
425 intrcnt_updatename(isrc);
431 * Dump data about interrupt handlers
433 DB_SHOW_COMMAND(irqs, db_show_irqs)
435 struct intsrc **isrc;
438 if (strcmp(modif, "v") == 0)
442 isrc = interrupt_sources;
443 for (i = 0; i < NUM_IO_INTS && !db_pager_quit; i++, isrc++)
445 db_dump_intr_event((*isrc)->is_event, verbose);
451 * Support for balancing interrupt sources across CPUs. For now we just
452 * allocate CPUs round-robin.
455 static cpuset_t intr_cpus = CPUSET_T_INITIALIZER(0x1);
456 static int current_cpu;
459 * Return the CPU that the next interrupt source should use. For now
460 * this just returns the next local APIC according to round-robin.
467 /* Leave all interrupts on the BSP during boot. */
469 return (PCPU_GET(apic_id));
471 mtx_lock_spin(&icu_lock);
472 apic_id = cpu_apic_ids[current_cpu];
475 if (current_cpu > mp_maxid)
477 } while (!CPU_ISSET(current_cpu, &intr_cpus));
478 mtx_unlock_spin(&icu_lock);
482 /* Attempt to bind the specified IRQ to the specified CPU. */
484 intr_bind(u_int vector, u_char cpu)
488 isrc = intr_lookup_source(vector);
491 return (intr_event_bind(isrc->is_event, cpu));
495 * Add a CPU to our mask of valid CPUs that can be destinations of
499 intr_add_cpu(u_int cpu)
503 panic("%s: Invalid CPU ID", __func__);
505 printf("INTR: Adding local APIC %d as a target\n",
508 CPU_SET(cpu, &intr_cpus);
512 * Distribute all the interrupt sources among the available CPUs once the
513 * AP's have been launched.
516 intr_shuffle_irqs(void *arg __unused)
528 /* Don't bother on UP. */
532 /* Round-robin assign a CPU to each enabled source. */
533 sx_xlock(&intrsrc_lock);
535 for (i = 0; i < NUM_IO_INTS; i++) {
536 isrc = interrupt_sources[i];
537 if (isrc != NULL && isrc->is_handlers > 0) {
539 * If this event is already bound to a CPU,
540 * then assign the source to that CPU instead
541 * of picking one via round-robin. Note that
542 * this is careful to only advance the
543 * round-robin if the CPU assignment succeeds.
545 if (isrc->is_event->ie_cpu != NOCPU)
546 (void)isrc->is_pic->pic_assign_cpu(isrc,
547 cpu_apic_ids[isrc->is_event->ie_cpu]);
548 else if (isrc->is_pic->pic_assign_cpu(isrc,
549 cpu_apic_ids[current_cpu]) == 0)
550 (void)intr_next_cpu();
554 sx_xunlock(&intrsrc_lock);
556 SYSINIT(intr_shuffle_irqs, SI_SUB_SMP, SI_ORDER_SECOND, intr_shuffle_irqs,
560 * Always route interrupts to the current processor in the UP case.
566 return (PCPU_GET(apic_id));