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>
60 #include <dev/pci/pcib_private.h>
64 * IBM CPC9X5 Hypertransport Device interface.
66 static int cpcht_probe(device_t);
67 static int cpcht_attach(device_t);
69 static void cpcht_configure_htbridge(device_t, phandle_t);
74 static u_int32_t cpcht_read_config(device_t, u_int, u_int, u_int,
76 static void cpcht_write_config(device_t, u_int, u_int, u_int,
77 u_int, u_int32_t, int);
78 static int cpcht_route_interrupt(device_t, device_t, int);
79 static int cpcht_alloc_msi(device_t dev, device_t child,
80 int count, int maxcount, int *irqs);
81 static int cpcht_release_msi(device_t dev, device_t child,
82 int count, int *irqs);
83 static int cpcht_alloc_msix(device_t dev, device_t child,
85 static int cpcht_release_msix(device_t dev, device_t child,
87 static int cpcht_map_msi(device_t dev, device_t child,
88 int irq, uint64_t *addr, uint32_t *data);
93 static device_method_t cpcht_methods[] = {
94 /* Device interface */
95 DEVMETHOD(device_probe, cpcht_probe),
96 DEVMETHOD(device_attach, cpcht_attach),
99 DEVMETHOD(pcib_read_config, cpcht_read_config),
100 DEVMETHOD(pcib_write_config, cpcht_write_config),
101 DEVMETHOD(pcib_route_interrupt, cpcht_route_interrupt),
102 DEVMETHOD(pcib_alloc_msi, cpcht_alloc_msi),
103 DEVMETHOD(pcib_release_msi, cpcht_release_msi),
104 DEVMETHOD(pcib_alloc_msix, cpcht_alloc_msix),
105 DEVMETHOD(pcib_release_msix, cpcht_release_msix),
106 DEVMETHOD(pcib_map_msi, cpcht_map_msi),
107 DEVMETHOD(pcib_request_feature, pcib_request_feature_allow),
114 IRQ_NONE, IRQ_HT, IRQ_MSI, IRQ_INTERNAL
120 vm_offset_t apple_eoi;
125 static struct cpcht_irq *cpcht_irqmap = NULL;
126 uint32_t cpcht_msipic = 0;
129 struct ofw_pci_softc pci_sc;
131 uint64_t sc_populated_slots;
133 struct cpcht_irq htirq_map[128];
134 struct mtx htirq_mtx;
137 static devclass_t cpcht_devclass;
138 DEFINE_CLASS_1(pcib, cpcht_driver, cpcht_methods, sizeof(struct cpcht_softc),
140 DRIVER_MODULE(cpcht, ofwbus, cpcht_driver, cpcht_devclass, 0, 0);
142 #define CPCHT_IOPORT_BASE 0xf4000000UL /* Hardwired */
143 #define CPCHT_IOPORT_SIZE 0x00400000UL
145 #define HTAPIC_REQUEST_EOI 0x20
146 #define HTAPIC_TRIGGER_LEVEL 0x02
147 #define HTAPIC_MASK 0x01
150 cpcht_probe(device_t dev)
152 const char *type, *compatible;
154 type = ofw_bus_get_type(dev);
155 compatible = ofw_bus_get_compat(dev);
157 if (type == NULL || compatible == NULL)
160 if (strcmp(type, "ht") != 0)
163 if (strcmp(compatible, "u3-ht") != 0)
166 device_set_desc(dev, "IBM CPC9X5 HyperTransport Tunnel");
171 cpcht_attach(device_t dev)
173 struct cpcht_softc *sc;
174 phandle_t node, child;
178 node = ofw_bus_get_node(dev);
179 sc = device_get_softc(dev);
181 if (OF_getencprop(node, "reg", reg, sizeof(reg)) < 12)
184 if (OF_getproplen(node, "ranges") <= 0)
185 sc->pci_sc.sc_quirks = OFW_PCI_QUIRK_RANGES_ON_CHILDREN;
186 sc->sc_populated_slots = 0;
187 sc->sc_data = (vm_offset_t)pmap_mapdev(reg[1], reg[2]);
190 * Set up the resource manager and the HT->MPIC mapping. For cpcht,
191 * the ranges are properties of the child bridges, and this is also
192 * where we get the HT interrupts properties.
196 /* I/O port mappings are usually not in the device tree */
197 rman_manage_region(&sc->pci_sc.sc_io_rman, 0, CPCHT_IOPORT_SIZE - 1);
200 bzero(sc->htirq_map, sizeof(sc->htirq_map));
201 mtx_init(&sc->htirq_mtx, "cpcht irq", NULL, MTX_DEF);
202 for (i = 0; i < 8; i++)
203 sc->htirq_map[i].irq_type = IRQ_INTERNAL;
204 for (child = OF_child(node); child != 0; child = OF_peer(child))
205 cpcht_configure_htbridge(dev, child);
207 /* Now make the mapping table available to the MPIC */
208 cpcht_irqmap = sc->htirq_map;
210 return (ofw_pci_attach(dev));
214 cpcht_configure_htbridge(device_t dev, phandle_t child)
216 struct cpcht_softc *sc;
217 struct ofw_pci_register pcir;
223 sc = device_get_softc(dev);
224 if (OF_getencprop(child, "reg", (pcell_t *)&pcir, sizeof(pcir)) == -1)
227 b = OFW_PCI_PHYS_HI_BUS(pcir.phys_hi);
228 s = OFW_PCI_PHYS_HI_DEVICE(pcir.phys_hi);
229 f = OFW_PCI_PHYS_HI_FUNCTION(pcir.phys_hi);
232 * Mark this slot is populated. The remote south bridge does
233 * not like us talking to unpopulated slots on the root bus.
235 sc->sc_populated_slots |= (1 << s);
238 * Next build up any HT->MPIC mappings for this sub-bus. One would
239 * naively hope that enabling, disabling, and EOIing interrupts would
240 * cause the appropriate HT bus transactions to that effect. This is
243 * Instead, we have to muck about on the HT peer's root PCI bridges,
244 * figure out what interrupts they send, enable them, and cache
245 * the location of their WaitForEOI registers so that we can
249 /* All the devices we are interested in have caps */
250 if (!(PCIB_READ_CONFIG(dev, b, s, f, PCIR_STATUS, 2)
251 & PCIM_STATUS_CAPPRESENT))
254 nextptr = PCIB_READ_CONFIG(dev, b, s, f, PCIR_CAP_PTR, 1);
255 while (nextptr != 0) {
257 nextptr = PCIB_READ_CONFIG(dev, b, s, f,
258 ptr + PCICAP_NEXTPTR, 1);
260 /* Find the HT IRQ capabilities */
261 if (PCIB_READ_CONFIG(dev, b, s, f,
262 ptr + PCICAP_ID, 1) != PCIY_HT)
265 val = PCIB_READ_CONFIG(dev, b, s, f, ptr + PCIR_HT_COMMAND, 2);
266 if ((val & PCIM_HTCMD_CAP_MASK) != PCIM_HTCAP_INTERRUPT)
269 /* Ask for the IRQ count */
270 PCIB_WRITE_CONFIG(dev, b, s, f, ptr + PCIR_HT_COMMAND, 0x1, 1);
271 nirq = PCIB_READ_CONFIG(dev, b, s, f, ptr + 4, 4);
272 nirq = ((nirq >> 16) & 0xff) + 1;
274 device_printf(dev, "%d HT IRQs on device %d.%d\n", nirq, s, f);
276 for (i = 0; i < nirq; i++) {
277 PCIB_WRITE_CONFIG(dev, b, s, f,
278 ptr + PCIR_HT_COMMAND, 0x10 + (i << 1), 1);
279 irq = PCIB_READ_CONFIG(dev, b, s, f, ptr + 4, 4);
282 * Mask this interrupt for now.
284 PCIB_WRITE_CONFIG(dev, b, s, f, ptr + 4,
285 irq | HTAPIC_MASK, 4);
286 irq = (irq >> 16) & 0xff;
288 sc->htirq_map[irq].irq_type = IRQ_HT;
289 sc->htirq_map[irq].ht_source = i;
290 sc->htirq_map[irq].ht_base = sc->sc_data +
291 (((((s & 0x1f) << 3) | (f & 0x07)) << 8) | (ptr));
293 PCIB_WRITE_CONFIG(dev, b, s, f,
294 ptr + PCIR_HT_COMMAND, 0x11 + (i << 1), 1);
295 sc->htirq_map[irq].eoi_data =
296 PCIB_READ_CONFIG(dev, b, s, f, ptr + 4, 4) |
300 * Apple uses a non-compliant IO/APIC that differs
301 * in how we signal EOIs. Check if this device was
302 * made by Apple, and act accordingly.
304 vend = PCIB_READ_CONFIG(dev, b, s, f,
306 if ((vend & 0xffff) == 0x106b)
307 sc->htirq_map[irq].apple_eoi =
308 (sc->htirq_map[irq].ht_base - ptr) + 0x60;
314 cpcht_read_config(device_t dev, u_int bus, u_int slot, u_int func, u_int reg,
317 struct cpcht_softc *sc;
320 sc = device_get_softc(dev);
321 caoff = sc->sc_data +
322 (((((slot & 0x1f) << 3) | (func & 0x07)) << 8) | reg);
324 if (bus == 0 && (!(sc->sc_populated_slots & (1 << slot)) || func > 0))
328 caoff += 0x01000000UL + (bus << 16);
332 return (in8rb(caoff));
335 return (in16rb(caoff));
338 return (in32rb(caoff));
346 cpcht_write_config(device_t dev, u_int bus, u_int slot, u_int func,
347 u_int reg, u_int32_t val, int width)
349 struct cpcht_softc *sc;
352 sc = device_get_softc(dev);
353 caoff = sc->sc_data +
354 (((((slot & 0x1f) << 3) | (func & 0x07)) << 8) | reg);
356 if (bus == 0 && (!(sc->sc_populated_slots & (1 << slot)) || func > 0))
360 caoff += 0x01000000UL + (bus << 16);
376 cpcht_route_interrupt(device_t bus, device_t dev, int pin)
382 cpcht_alloc_msi(device_t dev, device_t child, int count, int maxcount,
385 struct cpcht_softc *sc;
388 sc = device_get_softc(dev);
391 /* Bail if no MSI PIC yet */
392 if (cpcht_msipic == 0)
395 mtx_lock(&sc->htirq_mtx);
396 for (i = 8; i < 124 - count; i++) {
397 for (j = 0; j < count; j++) {
398 if (sc->htirq_map[i+j].irq_type != IRQ_NONE)
404 i += j; /* We know there isn't a large enough run */
408 mtx_unlock(&sc->htirq_mtx);
412 for (j = 0; j < count; j++) {
413 irqs[j] = MAP_IRQ(cpcht_msipic, i+j);
414 sc->htirq_map[i+j].irq_type = IRQ_MSI;
416 mtx_unlock(&sc->htirq_mtx);
422 cpcht_release_msi(device_t dev, device_t child, int count, int *irqs)
424 struct cpcht_softc *sc;
427 sc = device_get_softc(dev);
429 mtx_lock(&sc->htirq_mtx);
430 for (i = 0; i < count; i++)
431 sc->htirq_map[irqs[i] & 0xff].irq_type = IRQ_NONE;
432 mtx_unlock(&sc->htirq_mtx);
438 cpcht_alloc_msix(device_t dev, device_t child, int *irq)
440 struct cpcht_softc *sc;
443 sc = device_get_softc(dev);
445 /* Bail if no MSI PIC yet */
446 if (cpcht_msipic == 0)
449 mtx_lock(&sc->htirq_mtx);
450 for (i = 8; i < 124; i++) {
451 if (sc->htirq_map[i].irq_type == IRQ_NONE) {
452 sc->htirq_map[i].irq_type = IRQ_MSI;
453 *irq = MAP_IRQ(cpcht_msipic, i);
455 mtx_unlock(&sc->htirq_mtx);
459 mtx_unlock(&sc->htirq_mtx);
465 cpcht_release_msix(device_t dev, device_t child, int irq)
467 struct cpcht_softc *sc;
469 sc = device_get_softc(dev);
471 mtx_lock(&sc->htirq_mtx);
472 sc->htirq_map[irq & 0xff].irq_type = IRQ_NONE;
473 mtx_unlock(&sc->htirq_mtx);
479 cpcht_map_msi(device_t dev, device_t child, int irq, uint64_t *addr,
483 struct pci_devinfo *dinfo;
484 struct pcicfg_ht *ht = NULL;
486 for (pcib = child; pcib != dev; pcib =
487 device_get_parent(device_get_parent(pcib))) {
488 dinfo = device_get_ivars(pcib);
498 *addr = ht->ht_msiaddr;
505 * Driver for the integrated MPIC on U3/U4 (CPC925/CPC945)
508 static int openpic_cpcht_probe(device_t);
509 static int openpic_cpcht_attach(device_t);
510 static void openpic_cpcht_config(device_t, u_int irq,
511 enum intr_trigger trig, enum intr_polarity pol);
512 static void openpic_cpcht_enable(device_t, u_int irq, u_int vector);
513 static void openpic_cpcht_unmask(device_t, u_int irq);
514 static void openpic_cpcht_eoi(device_t, u_int irq);
516 static device_method_t openpic_cpcht_methods[] = {
517 /* Device interface */
518 DEVMETHOD(device_probe, openpic_cpcht_probe),
519 DEVMETHOD(device_attach, openpic_cpcht_attach),
522 DEVMETHOD(pic_bind, openpic_bind),
523 DEVMETHOD(pic_config, openpic_cpcht_config),
524 DEVMETHOD(pic_dispatch, openpic_dispatch),
525 DEVMETHOD(pic_enable, openpic_cpcht_enable),
526 DEVMETHOD(pic_eoi, openpic_cpcht_eoi),
527 DEVMETHOD(pic_ipi, openpic_ipi),
528 DEVMETHOD(pic_mask, openpic_mask),
529 DEVMETHOD(pic_unmask, openpic_cpcht_unmask),
534 struct openpic_cpcht_softc {
535 struct openpic_softc sc_openpic;
537 struct mtx sc_ht_mtx;
540 static driver_t openpic_cpcht_driver = {
542 openpic_cpcht_methods,
543 sizeof(struct openpic_cpcht_softc),
546 DRIVER_MODULE(openpic, unin, openpic_cpcht_driver, openpic_devclass, 0, 0);
549 openpic_cpcht_probe(device_t dev)
551 const char *type = ofw_bus_get_type(dev);
553 if (strcmp(type, "open-pic") != 0)
556 device_set_desc(dev, OPENPIC_DEVSTR);
561 openpic_cpcht_attach(device_t dev)
563 struct openpic_cpcht_softc *sc;
567 node = ofw_bus_get_node(dev);
568 err = openpic_common_attach(dev, node);
573 * The HT APIC stuff is not thread-safe, so we need a mutex to
576 sc = device_get_softc(dev);
577 mtx_init(&sc->sc_ht_mtx, "htpic", NULL, MTX_SPIN);
580 * Interrupts 0-3 are internally sourced and are level triggered
581 * active low. Interrupts 4-123 are connected to a pulse generator
582 * and should be programmed as edge triggered low-to-high.
584 * IBM CPC945 Manual, Section 9.3.
587 for (irq = 0; irq < 4; irq++)
588 openpic_config(dev, irq, INTR_TRIGGER_LEVEL, INTR_POLARITY_LOW);
589 for (irq = 4; irq < 124; irq++)
590 openpic_config(dev, irq, INTR_TRIGGER_EDGE, INTR_POLARITY_LOW);
593 * Use this PIC for MSI only if it is the root PIC. This may not
594 * be necessary, but Linux does it, and I cannot find any U3 machines
595 * with MSI devices to test.
604 openpic_cpcht_config(device_t dev, u_int irq, enum intr_trigger trig,
605 enum intr_polarity pol)
607 struct openpic_cpcht_softc *sc;
611 * The interrupt settings for the MPIC are completely determined
612 * by the internal wiring in the northbridge. Real changes to these
613 * settings need to be negotiated with the remote IO-APIC on the HT
617 sc = device_get_softc(dev);
619 if (cpcht_irqmap != NULL && irq < 128 &&
620 cpcht_irqmap[irq].ht_base > 0 && !cpcht_irqmap[irq].edge) {
621 mtx_lock_spin(&sc->sc_ht_mtx);
623 /* Program the data port */
624 out8rb(cpcht_irqmap[irq].ht_base + PCIR_HT_COMMAND,
625 0x10 + (cpcht_irqmap[irq].ht_source << 1));
627 /* Grab the IRQ config register */
628 ht_irq = in32rb(cpcht_irqmap[irq].ht_base + 4);
630 /* Mask the IRQ while we fiddle settings */
631 out32rb(cpcht_irqmap[irq].ht_base + 4, ht_irq | HTAPIC_MASK);
633 /* Program the interrupt sense */
634 ht_irq &= ~(HTAPIC_TRIGGER_LEVEL | HTAPIC_REQUEST_EOI);
635 if (trig == INTR_TRIGGER_EDGE) {
636 cpcht_irqmap[irq].edge = 1;
638 cpcht_irqmap[irq].edge = 0;
639 ht_irq |= HTAPIC_TRIGGER_LEVEL | HTAPIC_REQUEST_EOI;
641 out32rb(cpcht_irqmap[irq].ht_base + 4, ht_irq);
643 mtx_unlock_spin(&sc->sc_ht_mtx);
648 openpic_cpcht_enable(device_t dev, u_int irq, u_int vec)
650 struct openpic_cpcht_softc *sc;
653 openpic_enable(dev, irq, vec);
655 sc = device_get_softc(dev);
657 if (cpcht_irqmap != NULL && irq < 128 &&
658 cpcht_irqmap[irq].ht_base > 0) {
659 mtx_lock_spin(&sc->sc_ht_mtx);
661 /* Program the data port */
662 out8rb(cpcht_irqmap[irq].ht_base + PCIR_HT_COMMAND,
663 0x10 + (cpcht_irqmap[irq].ht_source << 1));
665 /* Unmask the interrupt */
666 ht_irq = in32rb(cpcht_irqmap[irq].ht_base + 4);
667 ht_irq &= ~HTAPIC_MASK;
668 out32rb(cpcht_irqmap[irq].ht_base + 4, ht_irq);
670 mtx_unlock_spin(&sc->sc_ht_mtx);
673 openpic_cpcht_eoi(dev, irq);
677 openpic_cpcht_unmask(device_t dev, u_int irq)
679 struct openpic_cpcht_softc *sc;
682 openpic_unmask(dev, irq);
684 sc = device_get_softc(dev);
686 if (cpcht_irqmap != NULL && irq < 128 &&
687 cpcht_irqmap[irq].ht_base > 0) {
688 mtx_lock_spin(&sc->sc_ht_mtx);
690 /* Program the data port */
691 out8rb(cpcht_irqmap[irq].ht_base + PCIR_HT_COMMAND,
692 0x10 + (cpcht_irqmap[irq].ht_source << 1));
694 /* Unmask the interrupt */
695 ht_irq = in32rb(cpcht_irqmap[irq].ht_base + 4);
696 ht_irq &= ~HTAPIC_MASK;
697 out32rb(cpcht_irqmap[irq].ht_base + 4, ht_irq);
699 mtx_unlock_spin(&sc->sc_ht_mtx);
702 openpic_cpcht_eoi(dev, irq);
706 openpic_cpcht_eoi(device_t dev, u_int irq)
708 struct openpic_cpcht_softc *sc;
714 sc = device_get_softc(dev);
716 if (cpcht_irqmap != NULL && irq < 128 &&
717 cpcht_irqmap[irq].ht_base > 0 && !cpcht_irqmap[irq].edge) {
718 /* If this is an HT IRQ, acknowledge it at the remote APIC */
720 if (cpcht_irqmap[irq].apple_eoi) {
721 off = (cpcht_irqmap[irq].ht_source >> 3) & ~3;
722 mask = 1 << (cpcht_irqmap[irq].ht_source & 0x1f);
723 out32rb(cpcht_irqmap[irq].apple_eoi + off, mask);
725 mtx_lock_spin(&sc->sc_ht_mtx);
727 out8rb(cpcht_irqmap[irq].ht_base + PCIR_HT_COMMAND,
728 0x11 + (cpcht_irqmap[irq].ht_source << 1));
729 out32rb(cpcht_irqmap[irq].ht_base + 4,
730 cpcht_irqmap[irq].eoi_data);
732 mtx_unlock_spin(&sc->sc_ht_mtx);
736 openpic_eoi(dev, irq);