2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2003 John Baldwin <jhb@FreeBSD.org>
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * PIC driver for the 8259A Master and Slave PICs in PC/AT machines.
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
35 #include "opt_auto_eoi.h"
38 #include <sys/param.h>
39 #include <sys/systm.h>
41 #include <sys/interrupt.h>
42 #include <sys/kernel.h>
44 #include <sys/module.h>
46 #include <machine/cpufunc.h>
47 #include <machine/frame.h>
48 #include <machine/intr_machdep.h>
49 #include <machine/md_var.h>
50 #include <machine/resource.h>
51 #include <machine/segments.h>
53 #include <dev/ic/i8259.h>
54 #include <x86/isa/icu.h>
55 #include <isa/isareg.h>
56 #include <isa/isavar.h>
59 #define SDT_ATPIC SDT_SYSIGT
62 #define SDT_ATPIC SDT_SYS386IGT
63 #define GSEL_ATPIC GSEL(GCODE_SEL, SEL_KPL)
69 #define IMEN_MASK(ai) (IRQ_MASK((ai)->at_irq))
71 #define NUM_ISA_IRQS 16
73 static void atpic_init(void *dummy);
76 IDTVEC(atpic_intr0), IDTVEC(atpic_intr1), IDTVEC(atpic_intr2),
77 IDTVEC(atpic_intr3), IDTVEC(atpic_intr4), IDTVEC(atpic_intr5),
78 IDTVEC(atpic_intr6), IDTVEC(atpic_intr7), IDTVEC(atpic_intr8),
79 IDTVEC(atpic_intr9), IDTVEC(atpic_intr10), IDTVEC(atpic_intr11),
80 IDTVEC(atpic_intr12), IDTVEC(atpic_intr13), IDTVEC(atpic_intr14),
82 /* XXXKIB i386 uses stubs until pti comes */
84 IDTVEC(atpic_intr0_pti), IDTVEC(atpic_intr1_pti),
85 IDTVEC(atpic_intr2_pti), IDTVEC(atpic_intr3_pti),
86 IDTVEC(atpic_intr4_pti), IDTVEC(atpic_intr5_pti),
87 IDTVEC(atpic_intr6_pti), IDTVEC(atpic_intr7_pti),
88 IDTVEC(atpic_intr8_pti), IDTVEC(atpic_intr9_pti),
89 IDTVEC(atpic_intr10_pti), IDTVEC(atpic_intr11_pti),
90 IDTVEC(atpic_intr12_pti), IDTVEC(atpic_intr13_pti),
91 IDTVEC(atpic_intr14_pti), IDTVEC(atpic_intr15_pti);
93 #define IRQ(ap, ai) ((ap)->at_irqbase + (ai)->at_irq)
95 #define ATPIC(io, base, eoi) { \
97 .pic_register_sources = atpic_register_sources, \
98 .pic_enable_source = atpic_enable_source, \
99 .pic_disable_source = atpic_disable_source, \
100 .pic_eoi_source = (eoi), \
101 .pic_enable_intr = atpic_enable_intr, \
102 .pic_disable_intr = atpic_disable_intr, \
103 .pic_vector = atpic_vector, \
104 .pic_source_pending = atpic_source_pending, \
105 .pic_resume = atpic_resume, \
106 .pic_config_intr = atpic_config_intr, \
107 .pic_assign_cpu = atpic_assign_cpu \
110 .at_irqbase = (base), \
111 .at_intbase = IDT_IO_INTS + (base), \
115 #define INTSRC(irq) \
116 { { &atpics[(irq) / 8].at_pic }, IDTVEC(atpic_intr ## irq ), \
117 IDTVEC(atpic_intr ## irq ## _pti), (irq) % 8 }
127 struct atpic_intsrc {
128 struct intsrc at_intsrc;
129 inthand_t *at_intr, *at_intr_pti;
130 int at_irq; /* Relative to PIC base. */
131 enum intr_trigger at_trigger;
133 u_long at_straycount;
136 static void atpic_register_sources(struct pic *pic);
137 static void atpic_enable_source(struct intsrc *isrc);
138 static void atpic_disable_source(struct intsrc *isrc, int eoi);
139 static void atpic_eoi_master(struct intsrc *isrc);
140 static void atpic_eoi_slave(struct intsrc *isrc);
141 static void atpic_enable_intr(struct intsrc *isrc);
142 static void atpic_disable_intr(struct intsrc *isrc);
143 static int atpic_vector(struct intsrc *isrc);
144 static void atpic_resume(struct pic *pic, bool suspend_cancelled);
145 static int atpic_source_pending(struct intsrc *isrc);
146 static int atpic_config_intr(struct intsrc *isrc, enum intr_trigger trig,
147 enum intr_polarity pol);
148 static int atpic_assign_cpu(struct intsrc *isrc, u_int apic_id);
149 static void i8259_init(struct atpic *pic, int slave);
151 static struct atpic atpics[] = {
152 ATPIC(IO_ICU1, 0, atpic_eoi_master),
153 ATPIC(IO_ICU2, 8, atpic_eoi_slave)
156 static struct atpic_intsrc atintrs[] = {
175 CTASSERT(nitems(atintrs) == NUM_ISA_IRQS);
178 _atpic_eoi_master(struct intsrc *isrc)
181 KASSERT(isrc->is_pic == &atpics[MASTER].at_pic,
182 ("%s: mismatched pic", __func__));
184 outb(atpics[MASTER].at_ioaddr, OCW2_EOI);
189 * The data sheet says no auto-EOI on slave, but it sometimes works.
190 * So, if AUTO_EOI_2 is enabled, we use it.
193 _atpic_eoi_slave(struct intsrc *isrc)
196 KASSERT(isrc->is_pic == &atpics[SLAVE].at_pic,
197 ("%s: mismatched pic", __func__));
199 outb(atpics[SLAVE].at_ioaddr, OCW2_EOI);
201 outb(atpics[MASTER].at_ioaddr, OCW2_EOI);
207 atpic_register_sources(struct pic *pic)
209 struct atpic *ap = (struct atpic *)pic;
210 struct atpic_intsrc *ai;
214 * If any of the ISA IRQs have an interrupt source already, then
215 * assume that the I/O APICs are being used and don't register any
216 * of our interrupt sources. This makes sure we don't accidentally
217 * use mixed mode. The "accidental" use could otherwise occur on
218 * machines that route the ACPI SCI interrupt to a different ISA
219 * IRQ (at least one machine routes it to IRQ 13) thus disabling
220 * that APIC ISA routing and allowing the ATPIC source for that IRQ
221 * to leak through. We used to depend on this feature for routing
222 * IRQ0 via mixed mode, but now we don't use mixed mode at all.
224 * To avoid the slave not register sources after the master
225 * registers its sources, register all IRQs when this function is
226 * called on the master.
228 if (ap != &atpics[MASTER])
230 for (i = 0; i < NUM_ISA_IRQS; i++)
231 if (intr_lookup_source(i) != NULL)
234 /* Loop through all interrupt sources and add them. */
235 for (i = 0, ai = atintrs; i < NUM_ISA_IRQS; i++, ai++) {
236 if (i == ICU_SLAVEID)
238 intr_register_source(&ai->at_intsrc);
243 atpic_enable_source(struct intsrc *isrc)
245 struct atpic_intsrc *ai = (struct atpic_intsrc *)isrc;
246 struct atpic *ap = (struct atpic *)isrc->is_pic;
249 if (ap->at_imen & IMEN_MASK(ai)) {
250 ap->at_imen &= ~IMEN_MASK(ai);
251 outb(ap->at_ioaddr + ICU_IMR_OFFSET, ap->at_imen);
257 atpic_disable_source(struct intsrc *isrc, int eoi)
259 struct atpic_intsrc *ai = (struct atpic_intsrc *)isrc;
260 struct atpic *ap = (struct atpic *)isrc->is_pic;
263 if (ai->at_trigger != INTR_TRIGGER_EDGE) {
264 ap->at_imen |= IMEN_MASK(ai);
265 outb(ap->at_ioaddr + ICU_IMR_OFFSET, ap->at_imen);
269 * Take care to call these functions directly instead of through
270 * a function pointer. All of the referenced variables should
271 * still be hot in the cache.
273 if (eoi == PIC_EOI) {
274 if (isrc->is_pic == &atpics[MASTER].at_pic)
275 _atpic_eoi_master(isrc);
277 _atpic_eoi_slave(isrc);
284 atpic_eoi_master(struct intsrc *isrc)
288 _atpic_eoi_master(isrc);
294 atpic_eoi_slave(struct intsrc *isrc)
298 _atpic_eoi_slave(isrc);
304 atpic_enable_intr(struct intsrc *isrc)
309 atpic_disable_intr(struct intsrc *isrc)
315 atpic_vector(struct intsrc *isrc)
317 struct atpic_intsrc *ai = (struct atpic_intsrc *)isrc;
318 struct atpic *ap = (struct atpic *)isrc->is_pic;
320 return (IRQ(ap, ai));
324 atpic_source_pending(struct intsrc *isrc)
326 struct atpic_intsrc *ai = (struct atpic_intsrc *)isrc;
327 struct atpic *ap = (struct atpic *)isrc->is_pic;
329 return (inb(ap->at_ioaddr) & IMEN_MASK(ai));
333 atpic_resume(struct pic *pic, bool suspend_cancelled)
335 struct atpic *ap = (struct atpic *)pic;
337 i8259_init(ap, ap == &atpics[SLAVE]);
338 if (ap == &atpics[SLAVE] && elcr_found)
343 atpic_config_intr(struct intsrc *isrc, enum intr_trigger trig,
344 enum intr_polarity pol)
346 struct atpic_intsrc *ai = (struct atpic_intsrc *)isrc;
349 /* Map conforming values to edge/hi and sanity check the values. */
350 if (trig == INTR_TRIGGER_CONFORM)
351 trig = INTR_TRIGGER_EDGE;
352 if (pol == INTR_POLARITY_CONFORM)
353 pol = INTR_POLARITY_HIGH;
354 vector = atpic_vector(isrc);
355 if ((trig == INTR_TRIGGER_EDGE && pol == INTR_POLARITY_LOW) ||
356 (trig == INTR_TRIGGER_LEVEL && pol == INTR_POLARITY_HIGH)) {
358 "atpic: Mismatched config for IRQ%u: trigger %s, polarity %s\n",
359 vector, trig == INTR_TRIGGER_EDGE ? "edge" : "level",
360 pol == INTR_POLARITY_HIGH ? "high" : "low");
364 /* If there is no change, just return. */
365 if (ai->at_trigger == trig)
369 * Certain IRQs can never be level/lo, so don't try to set them
370 * that way if asked. At least some ELCR registers ignore setting
371 * these bits as well.
373 if ((vector == 0 || vector == 1 || vector == 2 || vector == 13) &&
374 trig == INTR_TRIGGER_LEVEL) {
377 "atpic: Ignoring invalid level/low configuration for IRQ%u\n",
383 printf("atpic: No ELCR to configure IRQ%u as %s\n",
384 vector, trig == INTR_TRIGGER_EDGE ? "edge/high" :
389 printf("atpic: Programming IRQ%u as %s\n", vector,
390 trig == INTR_TRIGGER_EDGE ? "edge/high" : "level/low");
392 elcr_write_trigger(atpic_vector(isrc), trig);
393 ai->at_trigger = trig;
399 atpic_assign_cpu(struct intsrc *isrc, u_int apic_id)
403 * 8259A's are only used in UP in which case all interrupts always
404 * go to the sole CPU and this function shouldn't even be called.
406 panic("%s: bad cookie", __func__);
410 i8259_init(struct atpic *pic, int slave)
414 /* Reset the PIC and program with next four bytes. */
416 outb(pic->at_ioaddr, ICW1_RESET | ICW1_IC4);
417 imr_addr = pic->at_ioaddr + ICU_IMR_OFFSET;
420 outb(imr_addr, pic->at_intbase);
423 * Setup slave links. For the master pic, indicate what line
424 * the slave is configured on. For the slave indicate
425 * which line on the master we are connected to.
428 outb(imr_addr, ICU_SLAVEID);
430 outb(imr_addr, IRQ_MASK(ICU_SLAVEID));
434 outb(imr_addr, SLAVE_MODE);
436 outb(imr_addr, MASTER_MODE);
438 /* Set interrupt enable mask. */
439 outb(imr_addr, pic->at_imen);
441 /* Reset is finished, default to IRR on read. */
442 outb(pic->at_ioaddr, OCW3_SEL | OCW3_RR);
444 /* OCW2_L1 sets priority order to 3-7, 0-2 (com2 first). */
446 outb(pic->at_ioaddr, OCW2_R | OCW2_SL | OCW2_L1);
454 struct atpic_intsrc *ai;
457 /* Start off with all interrupts disabled. */
458 i8259_init(&atpics[MASTER], 0);
459 i8259_init(&atpics[SLAVE], 1);
460 atpic_enable_source((struct intsrc *)&atintrs[ICU_SLAVEID]);
462 /* Install low-level interrupt handlers for all of our IRQs. */
463 for (i = 0, ai = atintrs; i < NUM_ISA_IRQS; i++, ai++) {
464 if (i == ICU_SLAVEID)
466 ai->at_intsrc.is_count = &ai->at_count;
467 ai->at_intsrc.is_straycount = &ai->at_straycount;
468 setidt(((struct atpic *)ai->at_intsrc.is_pic)->at_intbase +
469 ai->at_irq, pti ? ai->at_intr_pti : ai->at_intr, SDT_ATPIC,
470 SEL_KPL, GSEL_ATPIC);
474 * Look for an ELCR. If we find one, update the trigger modes.
475 * If we don't find one, assume that IRQs 0, 1, 2, and 13 are
476 * edge triggered and that everything else is level triggered.
477 * We only use the trigger information to reprogram the ELCR if
478 * we have one and as an optimization to avoid masking edge
479 * triggered interrupts. For the case that we don't have an ELCR,
480 * it doesn't hurt to mask an edge triggered interrupt, so we
481 * assume level trigger for any interrupt that we aren't sure is
485 for (i = 0, ai = atintrs; i < NUM_ISA_IRQS; i++, ai++)
486 ai->at_trigger = elcr_read_trigger(i);
488 for (i = 0, ai = atintrs; i < NUM_ISA_IRQS; i++, ai++)
495 ai->at_trigger = INTR_TRIGGER_EDGE;
498 ai->at_trigger = INTR_TRIGGER_LEVEL;
505 atpic_init(void *dummy __unused)
509 * Register our PICs, even if we aren't going to use any of their
510 * pins so that they are suspended and resumed.
512 if (intr_register_pic(&atpics[0].at_pic) != 0 ||
513 intr_register_pic(&atpics[1].at_pic) != 0)
514 panic("Unable to register ATPICs");
516 if (num_io_irqs == 0)
517 num_io_irqs = NUM_ISA_IRQS;
519 SYSINIT(atpic_init, SI_SUB_INTR, SI_ORDER_FOURTH, atpic_init, NULL);
522 atpic_handle_intr(u_int vector, struct trapframe *frame)
526 KASSERT(vector < NUM_ISA_IRQS, ("unknown int %u\n", vector));
527 isrc = &atintrs[vector].at_intsrc;
530 * If we don't have an event, see if this is a spurious
533 if (isrc->is_event == NULL && (vector == 7 || vector == 15)) {
537 * Read the ISR register to see if IRQ 7/15 is really
538 * pending. Reset read register back to IRR when done.
540 port = ((struct atpic *)isrc->is_pic)->at_ioaddr;
542 outb(port, OCW3_SEL | OCW3_RR | OCW3_RIS);
544 outb(port, OCW3_SEL | OCW3_RR);
546 if ((isr & IRQ_MASK(7)) == 0)
549 intr_execute_handlers(isrc, frame);
554 * Bus attachment for the ISA PIC.
556 static struct isa_pnp_id atpic_ids[] = {
557 { 0x0000d041 /* PNP0000 */, "AT interrupt controller" },
562 atpic_probe(device_t dev)
566 result = ISA_PNP_PROBE(device_get_parent(dev), dev, atpic_ids);
573 * We might be granted IRQ 2, as this is typically consumed by chaining
574 * between the two PIC components. If we're using the APIC, however,
575 * this may not be the case, and as such we should free the resource.
578 * The generic ISA attachment code will handle allocating any other resources
579 * that we don't explicitly claim here.
582 atpic_attach(device_t dev)
584 struct resource *res;
587 /* Try to allocate our IRQ and then free it. */
589 res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, 0);
591 bus_release_resource(dev, SYS_RES_IRQ, rid, res);
596 * Return a bitmap of the current interrupt requests. This is 8259-specific
597 * and is only suitable for use at probe time.
600 isa_irq_pending(void)
607 return ((irr2 << 8) | irr1);
610 static device_method_t atpic_methods[] = {
611 /* Device interface */
612 DEVMETHOD(device_probe, atpic_probe),
613 DEVMETHOD(device_attach, atpic_attach),
614 DEVMETHOD(device_detach, bus_generic_detach),
615 DEVMETHOD(device_shutdown, bus_generic_shutdown),
616 DEVMETHOD(device_suspend, bus_generic_suspend),
617 DEVMETHOD(device_resume, bus_generic_resume),
621 static driver_t atpic_driver = {
627 static devclass_t atpic_devclass;
629 DRIVER_MODULE(atpic, isa, atpic_driver, atpic_devclass, 0, 0);
630 DRIVER_MODULE(atpic, acpi, atpic_driver, atpic_devclass, 0, 0);
631 ISA_PNP_INFO(atpic_ids);