2 * Copyright (C) 2008-2010 Nathan Whitehorn
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 ``AS IS'' AND ANY EXPRESS OR
15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
17 * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
18 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
20 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
21 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
22 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
23 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 #include <sys/cdefs.h>
27 __FBSDID("$FreeBSD$");
29 #include <sys/param.h>
30 #include <sys/systm.h>
31 #include <sys/module.h>
34 #include <sys/kernel.h>
35 #include <sys/pciio.h>
38 #include <dev/ofw/openfirm.h>
39 #include <dev/ofw/ofw_pci.h>
41 #include <dev/pci/pcivar.h>
42 #include <dev/pci/pcireg.h>
44 #include <machine/bus.h>
45 #include <machine/intr_machdep.h>
46 #include <machine/md_var.h>
47 #include <machine/openpicreg.h>
48 #include <machine/openpicvar.h>
49 #include <machine/pio.h>
50 #include <machine/resource.h>
52 #include <dev/ofw/ofw_bus.h>
53 #include <dev/ofw/ofw_bus_subr.h>
54 #include <dev/ofw/ofwpci.h>
63 * IBM CPC9X5 Hypertransport Device interface.
65 static int cpcht_probe(device_t);
66 static int cpcht_attach(device_t);
68 static void cpcht_configure_htbridge(device_t, phandle_t);
73 static u_int32_t cpcht_read_config(device_t, u_int, u_int, u_int,
75 static void cpcht_write_config(device_t, u_int, u_int, u_int,
76 u_int, u_int32_t, int);
77 static int cpcht_route_interrupt(device_t, device_t, int);
78 static int cpcht_alloc_msi(device_t dev, device_t child,
79 int count, int maxcount, int *irqs);
80 static int cpcht_release_msi(device_t dev, device_t child,
81 int count, int *irqs);
82 static int cpcht_alloc_msix(device_t dev, device_t child,
84 static int cpcht_release_msix(device_t dev, device_t child,
86 static int cpcht_map_msi(device_t dev, device_t child,
87 int irq, uint64_t *addr, uint32_t *data);
92 static device_method_t cpcht_methods[] = {
93 /* Device interface */
94 DEVMETHOD(device_probe, cpcht_probe),
95 DEVMETHOD(device_attach, cpcht_attach),
98 DEVMETHOD(pcib_read_config, cpcht_read_config),
99 DEVMETHOD(pcib_write_config, cpcht_write_config),
100 DEVMETHOD(pcib_route_interrupt, cpcht_route_interrupt),
101 DEVMETHOD(pcib_alloc_msi, cpcht_alloc_msi),
102 DEVMETHOD(pcib_release_msi, cpcht_release_msi),
103 DEVMETHOD(pcib_alloc_msix, cpcht_alloc_msix),
104 DEVMETHOD(pcib_release_msix, cpcht_release_msix),
105 DEVMETHOD(pcib_map_msi, cpcht_map_msi),
112 IRQ_NONE, IRQ_HT, IRQ_MSI, IRQ_INTERNAL
118 vm_offset_t apple_eoi;
123 static struct cpcht_irq *cpcht_irqmap = NULL;
124 uint32_t cpcht_msipic = 0;
127 struct ofw_pci_softc pci_sc;
129 uint64_t sc_populated_slots;
131 struct cpcht_irq htirq_map[128];
132 struct mtx htirq_mtx;
135 static devclass_t cpcht_devclass;
136 DEFINE_CLASS_1(pcib, cpcht_driver, cpcht_methods, sizeof(struct cpcht_softc),
138 DRIVER_MODULE(cpcht, ofwbus, cpcht_driver, cpcht_devclass, 0, 0);
140 #define CPCHT_IOPORT_BASE 0xf4000000UL /* Hardwired */
141 #define CPCHT_IOPORT_SIZE 0x00400000UL
143 #define HTAPIC_REQUEST_EOI 0x20
144 #define HTAPIC_TRIGGER_LEVEL 0x02
145 #define HTAPIC_MASK 0x01
148 cpcht_probe(device_t dev)
150 const char *type, *compatible;
152 type = ofw_bus_get_type(dev);
153 compatible = ofw_bus_get_compat(dev);
155 if (type == NULL || compatible == NULL)
158 if (strcmp(type, "ht") != 0)
161 if (strcmp(compatible, "u3-ht") != 0)
164 device_set_desc(dev, "IBM CPC9X5 HyperTransport Tunnel");
169 cpcht_attach(device_t dev)
171 struct cpcht_softc *sc;
172 phandle_t node, child;
176 node = ofw_bus_get_node(dev);
177 sc = device_get_softc(dev);
179 if (OF_getencprop(node, "reg", reg, sizeof(reg)) < 12)
182 if (OF_getproplen(node, "ranges") <= 0)
183 sc->pci_sc.sc_quirks = OFW_PCI_QUIRK_RANGES_ON_CHILDREN;
184 sc->sc_populated_slots = 0;
185 sc->sc_data = (vm_offset_t)pmap_mapdev(reg[1], reg[2]);
188 * Set up the resource manager and the HT->MPIC mapping. For cpcht,
189 * the ranges are properties of the child bridges, and this is also
190 * where we get the HT interrupts properties.
194 /* I/O port mappings are usually not in the device tree */
195 rman_manage_region(&sc->pci_sc.sc_io_rman, 0, CPCHT_IOPORT_SIZE - 1);
198 bzero(sc->htirq_map, sizeof(sc->htirq_map));
199 mtx_init(&sc->htirq_mtx, "cpcht irq", NULL, MTX_DEF);
200 for (i = 0; i < 8; i++)
201 sc->htirq_map[i].irq_type = IRQ_INTERNAL;
202 for (child = OF_child(node); child != 0; child = OF_peer(child))
203 cpcht_configure_htbridge(dev, child);
205 /* Now make the mapping table available to the MPIC */
206 cpcht_irqmap = sc->htirq_map;
208 return (ofw_pci_attach(dev));
212 cpcht_configure_htbridge(device_t dev, phandle_t child)
214 struct cpcht_softc *sc;
215 struct ofw_pci_register pcir;
221 sc = device_get_softc(dev);
222 if (OF_getencprop(child, "reg", (pcell_t *)&pcir, sizeof(pcir)) == -1)
225 b = OFW_PCI_PHYS_HI_BUS(pcir.phys_hi);
226 s = OFW_PCI_PHYS_HI_DEVICE(pcir.phys_hi);
227 f = OFW_PCI_PHYS_HI_FUNCTION(pcir.phys_hi);
230 * Mark this slot is populated. The remote south bridge does
231 * not like us talking to unpopulated slots on the root bus.
233 sc->sc_populated_slots |= (1 << s);
236 * Next build up any HT->MPIC mappings for this sub-bus. One would
237 * naively hope that enabling, disabling, and EOIing interrupts would
238 * cause the appropriate HT bus transactions to that effect. This is
241 * Instead, we have to muck about on the HT peer's root PCI bridges,
242 * figure out what interrupts they send, enable them, and cache
243 * the location of their WaitForEOI registers so that we can
247 /* All the devices we are interested in have caps */
248 if (!(PCIB_READ_CONFIG(dev, b, s, f, PCIR_STATUS, 2)
249 & PCIM_STATUS_CAPPRESENT))
252 nextptr = PCIB_READ_CONFIG(dev, b, s, f, PCIR_CAP_PTR, 1);
253 while (nextptr != 0) {
255 nextptr = PCIB_READ_CONFIG(dev, b, s, f,
256 ptr + PCICAP_NEXTPTR, 1);
258 /* Find the HT IRQ capabilities */
259 if (PCIB_READ_CONFIG(dev, b, s, f,
260 ptr + PCICAP_ID, 1) != PCIY_HT)
263 val = PCIB_READ_CONFIG(dev, b, s, f, ptr + PCIR_HT_COMMAND, 2);
264 if ((val & PCIM_HTCMD_CAP_MASK) != PCIM_HTCAP_INTERRUPT)
267 /* Ask for the IRQ count */
268 PCIB_WRITE_CONFIG(dev, b, s, f, ptr + PCIR_HT_COMMAND, 0x1, 1);
269 nirq = PCIB_READ_CONFIG(dev, b, s, f, ptr + 4, 4);
270 nirq = ((nirq >> 16) & 0xff) + 1;
272 device_printf(dev, "%d HT IRQs on device %d.%d\n", nirq, s, f);
274 for (i = 0; i < nirq; i++) {
275 PCIB_WRITE_CONFIG(dev, b, s, f,
276 ptr + PCIR_HT_COMMAND, 0x10 + (i << 1), 1);
277 irq = PCIB_READ_CONFIG(dev, b, s, f, ptr + 4, 4);
280 * Mask this interrupt for now.
282 PCIB_WRITE_CONFIG(dev, b, s, f, ptr + 4,
283 irq | HTAPIC_MASK, 4);
284 irq = (irq >> 16) & 0xff;
286 sc->htirq_map[irq].irq_type = IRQ_HT;
287 sc->htirq_map[irq].ht_source = i;
288 sc->htirq_map[irq].ht_base = sc->sc_data +
289 (((((s & 0x1f) << 3) | (f & 0x07)) << 8) | (ptr));
291 PCIB_WRITE_CONFIG(dev, b, s, f,
292 ptr + PCIR_HT_COMMAND, 0x11 + (i << 1), 1);
293 sc->htirq_map[irq].eoi_data =
294 PCIB_READ_CONFIG(dev, b, s, f, ptr + 4, 4) |
298 * Apple uses a non-compliant IO/APIC that differs
299 * in how we signal EOIs. Check if this device was
300 * made by Apple, and act accordingly.
302 vend = PCIB_READ_CONFIG(dev, b, s, f,
304 if ((vend & 0xffff) == 0x106b)
305 sc->htirq_map[irq].apple_eoi =
306 (sc->htirq_map[irq].ht_base - ptr) + 0x60;
312 cpcht_read_config(device_t dev, u_int bus, u_int slot, u_int func, u_int reg,
315 struct cpcht_softc *sc;
318 sc = device_get_softc(dev);
319 caoff = sc->sc_data +
320 (((((slot & 0x1f) << 3) | (func & 0x07)) << 8) | reg);
322 if (bus == 0 && (!(sc->sc_populated_slots & (1 << slot)) || func > 0))
326 caoff += 0x01000000UL + (bus << 16);
330 return (in8rb(caoff));
333 return (in16rb(caoff));
336 return (in32rb(caoff));
344 cpcht_write_config(device_t dev, u_int bus, u_int slot, u_int func,
345 u_int reg, u_int32_t val, int width)
347 struct cpcht_softc *sc;
350 sc = device_get_softc(dev);
351 caoff = sc->sc_data +
352 (((((slot & 0x1f) << 3) | (func & 0x07)) << 8) | reg);
354 if (bus == 0 && (!(sc->sc_populated_slots & (1 << slot)) || func > 0))
358 caoff += 0x01000000UL + (bus << 16);
374 cpcht_route_interrupt(device_t bus, device_t dev, int pin)
380 cpcht_alloc_msi(device_t dev, device_t child, int count, int maxcount,
383 struct cpcht_softc *sc;
386 sc = device_get_softc(dev);
389 /* Bail if no MSI PIC yet */
390 if (cpcht_msipic == 0)
393 mtx_lock(&sc->htirq_mtx);
394 for (i = 8; i < 124 - count; i++) {
395 for (j = 0; j < count; j++) {
396 if (sc->htirq_map[i+j].irq_type != IRQ_NONE)
402 i += j; /* We know there isn't a large enough run */
406 mtx_unlock(&sc->htirq_mtx);
410 for (j = 0; j < count; j++) {
411 irqs[j] = MAP_IRQ(cpcht_msipic, i+j);
412 sc->htirq_map[i+j].irq_type = IRQ_MSI;
414 mtx_unlock(&sc->htirq_mtx);
420 cpcht_release_msi(device_t dev, device_t child, int count, int *irqs)
422 struct cpcht_softc *sc;
425 sc = device_get_softc(dev);
427 mtx_lock(&sc->htirq_mtx);
428 for (i = 0; i < count; i++)
429 sc->htirq_map[irqs[i] & 0xff].irq_type = IRQ_NONE;
430 mtx_unlock(&sc->htirq_mtx);
436 cpcht_alloc_msix(device_t dev, device_t child, int *irq)
438 struct cpcht_softc *sc;
441 sc = device_get_softc(dev);
443 /* Bail if no MSI PIC yet */
444 if (cpcht_msipic == 0)
447 mtx_lock(&sc->htirq_mtx);
448 for (i = 8; i < 124; i++) {
449 if (sc->htirq_map[i].irq_type == IRQ_NONE) {
450 sc->htirq_map[i].irq_type = IRQ_MSI;
451 *irq = MAP_IRQ(cpcht_msipic, i);
453 mtx_unlock(&sc->htirq_mtx);
457 mtx_unlock(&sc->htirq_mtx);
463 cpcht_release_msix(device_t dev, device_t child, int irq)
465 struct cpcht_softc *sc;
467 sc = device_get_softc(dev);
469 mtx_lock(&sc->htirq_mtx);
470 sc->htirq_map[irq & 0xff].irq_type = IRQ_NONE;
471 mtx_unlock(&sc->htirq_mtx);
477 cpcht_map_msi(device_t dev, device_t child, int irq, uint64_t *addr,
481 struct pci_devinfo *dinfo;
482 struct pcicfg_ht *ht = NULL;
484 for (pcib = child; pcib != dev; pcib =
485 device_get_parent(device_get_parent(pcib))) {
486 dinfo = device_get_ivars(pcib);
496 *addr = ht->ht_msiaddr;
503 * Driver for the integrated MPIC on U3/U4 (CPC925/CPC945)
506 static int openpic_cpcht_probe(device_t);
507 static int openpic_cpcht_attach(device_t);
508 static void openpic_cpcht_config(device_t, u_int irq,
509 enum intr_trigger trig, enum intr_polarity pol);
510 static void openpic_cpcht_enable(device_t, u_int irq, u_int vector);
511 static void openpic_cpcht_unmask(device_t, u_int irq);
512 static void openpic_cpcht_eoi(device_t, u_int irq);
514 static device_method_t openpic_cpcht_methods[] = {
515 /* Device interface */
516 DEVMETHOD(device_probe, openpic_cpcht_probe),
517 DEVMETHOD(device_attach, openpic_cpcht_attach),
520 DEVMETHOD(pic_bind, openpic_bind),
521 DEVMETHOD(pic_config, openpic_cpcht_config),
522 DEVMETHOD(pic_dispatch, openpic_dispatch),
523 DEVMETHOD(pic_enable, openpic_cpcht_enable),
524 DEVMETHOD(pic_eoi, openpic_cpcht_eoi),
525 DEVMETHOD(pic_ipi, openpic_ipi),
526 DEVMETHOD(pic_mask, openpic_mask),
527 DEVMETHOD(pic_unmask, openpic_cpcht_unmask),
532 struct openpic_cpcht_softc {
533 struct openpic_softc sc_openpic;
535 struct mtx sc_ht_mtx;
538 static driver_t openpic_cpcht_driver = {
540 openpic_cpcht_methods,
541 sizeof(struct openpic_cpcht_softc),
544 DRIVER_MODULE(openpic, unin, openpic_cpcht_driver, openpic_devclass, 0, 0);
547 openpic_cpcht_probe(device_t dev)
549 const char *type = ofw_bus_get_type(dev);
551 if (strcmp(type, "open-pic") != 0)
554 device_set_desc(dev, OPENPIC_DEVSTR);
559 openpic_cpcht_attach(device_t dev)
561 struct openpic_cpcht_softc *sc;
565 node = ofw_bus_get_node(dev);
566 err = openpic_common_attach(dev, node);
571 * The HT APIC stuff is not thread-safe, so we need a mutex to
574 sc = device_get_softc(dev);
575 mtx_init(&sc->sc_ht_mtx, "htpic", NULL, MTX_SPIN);
578 * Interrupts 0-3 are internally sourced and are level triggered
579 * active low. Interrupts 4-123 are connected to a pulse generator
580 * and should be programmed as edge triggered low-to-high.
582 * IBM CPC945 Manual, Section 9.3.
585 for (irq = 0; irq < 4; irq++)
586 openpic_config(dev, irq, INTR_TRIGGER_LEVEL, INTR_POLARITY_LOW);
587 for (irq = 4; irq < 124; irq++)
588 openpic_config(dev, irq, INTR_TRIGGER_EDGE, INTR_POLARITY_LOW);
591 * Use this PIC for MSI only if it is the root PIC. This may not
592 * be necessary, but Linux does it, and I cannot find any U3 machines
593 * with MSI devices to test.
602 openpic_cpcht_config(device_t dev, u_int irq, enum intr_trigger trig,
603 enum intr_polarity pol)
605 struct openpic_cpcht_softc *sc;
609 * The interrupt settings for the MPIC are completely determined
610 * by the internal wiring in the northbridge. Real changes to these
611 * settings need to be negotiated with the remote IO-APIC on the HT
615 sc = device_get_softc(dev);
617 if (cpcht_irqmap != NULL && irq < 128 &&
618 cpcht_irqmap[irq].ht_base > 0 && !cpcht_irqmap[irq].edge) {
619 mtx_lock_spin(&sc->sc_ht_mtx);
621 /* Program the data port */
622 out8rb(cpcht_irqmap[irq].ht_base + PCIR_HT_COMMAND,
623 0x10 + (cpcht_irqmap[irq].ht_source << 1));
625 /* Grab the IRQ config register */
626 ht_irq = in32rb(cpcht_irqmap[irq].ht_base + 4);
628 /* Mask the IRQ while we fiddle settings */
629 out32rb(cpcht_irqmap[irq].ht_base + 4, ht_irq | HTAPIC_MASK);
631 /* Program the interrupt sense */
632 ht_irq &= ~(HTAPIC_TRIGGER_LEVEL | HTAPIC_REQUEST_EOI);
633 if (trig == INTR_TRIGGER_EDGE) {
634 cpcht_irqmap[irq].edge = 1;
636 cpcht_irqmap[irq].edge = 0;
637 ht_irq |= HTAPIC_TRIGGER_LEVEL | HTAPIC_REQUEST_EOI;
639 out32rb(cpcht_irqmap[irq].ht_base + 4, ht_irq);
641 mtx_unlock_spin(&sc->sc_ht_mtx);
646 openpic_cpcht_enable(device_t dev, u_int irq, u_int vec)
648 struct openpic_cpcht_softc *sc;
651 openpic_enable(dev, irq, vec);
653 sc = device_get_softc(dev);
655 if (cpcht_irqmap != NULL && irq < 128 &&
656 cpcht_irqmap[irq].ht_base > 0) {
657 mtx_lock_spin(&sc->sc_ht_mtx);
659 /* Program the data port */
660 out8rb(cpcht_irqmap[irq].ht_base + PCIR_HT_COMMAND,
661 0x10 + (cpcht_irqmap[irq].ht_source << 1));
663 /* Unmask the interrupt */
664 ht_irq = in32rb(cpcht_irqmap[irq].ht_base + 4);
665 ht_irq &= ~HTAPIC_MASK;
666 out32rb(cpcht_irqmap[irq].ht_base + 4, ht_irq);
668 mtx_unlock_spin(&sc->sc_ht_mtx);
671 openpic_cpcht_eoi(dev, irq);
675 openpic_cpcht_unmask(device_t dev, u_int irq)
677 struct openpic_cpcht_softc *sc;
680 openpic_unmask(dev, irq);
682 sc = device_get_softc(dev);
684 if (cpcht_irqmap != NULL && irq < 128 &&
685 cpcht_irqmap[irq].ht_base > 0) {
686 mtx_lock_spin(&sc->sc_ht_mtx);
688 /* Program the data port */
689 out8rb(cpcht_irqmap[irq].ht_base + PCIR_HT_COMMAND,
690 0x10 + (cpcht_irqmap[irq].ht_source << 1));
692 /* Unmask the interrupt */
693 ht_irq = in32rb(cpcht_irqmap[irq].ht_base + 4);
694 ht_irq &= ~HTAPIC_MASK;
695 out32rb(cpcht_irqmap[irq].ht_base + 4, ht_irq);
697 mtx_unlock_spin(&sc->sc_ht_mtx);
700 openpic_cpcht_eoi(dev, irq);
704 openpic_cpcht_eoi(device_t dev, u_int irq)
706 struct openpic_cpcht_softc *sc;
712 sc = device_get_softc(dev);
714 if (cpcht_irqmap != NULL && irq < 128 &&
715 cpcht_irqmap[irq].ht_base > 0 && !cpcht_irqmap[irq].edge) {
716 /* If this is an HT IRQ, acknowledge it at the remote APIC */
718 if (cpcht_irqmap[irq].apple_eoi) {
719 off = (cpcht_irqmap[irq].ht_source >> 3) & ~3;
720 mask = 1 << (cpcht_irqmap[irq].ht_source & 0x1f);
721 out32rb(cpcht_irqmap[irq].apple_eoi + off, mask);
723 mtx_lock_spin(&sc->sc_ht_mtx);
725 out8rb(cpcht_irqmap[irq].ht_base + PCIR_HT_COMMAND,
726 0x11 + (cpcht_irqmap[irq].ht_source << 1));
727 out32rb(cpcht_irqmap[irq].ht_base + 4,
728 cpcht_irqmap[irq].eoi_data);
730 mtx_unlock_spin(&sc->sc_ht_mtx);
734 openpic_eoi(dev, irq);