2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (C) 2008-2010 Nathan Whitehorn
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
20 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
22 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
23 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
24 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
25 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
31 #include <sys/param.h>
32 #include <sys/systm.h>
33 #include <sys/module.h>
36 #include <sys/kernel.h>
37 #include <sys/pciio.h>
40 #include <dev/ofw/openfirm.h>
41 #include <dev/ofw/ofw_pci.h>
43 #include <dev/pci/pcivar.h>
44 #include <dev/pci/pcireg.h>
46 #include <machine/bus.h>
47 #include <machine/intr_machdep.h>
48 #include <machine/md_var.h>
49 #include <machine/openpicreg.h>
50 #include <machine/openpicvar.h>
51 #include <machine/pio.h>
52 #include <machine/resource.h>
54 #include <dev/ofw/ofw_bus.h>
55 #include <dev/ofw/ofw_bus_subr.h>
56 #include <dev/ofw/ofwpci.h>
62 #include <dev/pci/pcib_private.h>
66 * IBM CPC9X5 Hypertransport Device interface.
68 static int cpcht_probe(device_t);
69 static int cpcht_attach(device_t);
71 static void cpcht_configure_htbridge(device_t, phandle_t);
76 static u_int32_t cpcht_read_config(device_t, u_int, u_int, u_int,
78 static void cpcht_write_config(device_t, u_int, u_int, u_int,
79 u_int, u_int32_t, int);
80 static int cpcht_route_interrupt(device_t, device_t, int);
81 static int cpcht_alloc_msi(device_t dev, device_t child,
82 int count, int maxcount, int *irqs);
83 static int cpcht_release_msi(device_t dev, device_t child,
84 int count, int *irqs);
85 static int cpcht_alloc_msix(device_t dev, device_t child,
87 static int cpcht_release_msix(device_t dev, device_t child,
89 static int cpcht_map_msi(device_t dev, device_t child,
90 int irq, uint64_t *addr, uint32_t *data);
95 static device_method_t cpcht_methods[] = {
96 /* Device interface */
97 DEVMETHOD(device_probe, cpcht_probe),
98 DEVMETHOD(device_attach, cpcht_attach),
101 DEVMETHOD(pcib_read_config, cpcht_read_config),
102 DEVMETHOD(pcib_write_config, cpcht_write_config),
103 DEVMETHOD(pcib_route_interrupt, cpcht_route_interrupt),
104 DEVMETHOD(pcib_alloc_msi, cpcht_alloc_msi),
105 DEVMETHOD(pcib_release_msi, cpcht_release_msi),
106 DEVMETHOD(pcib_alloc_msix, cpcht_alloc_msix),
107 DEVMETHOD(pcib_release_msix, cpcht_release_msix),
108 DEVMETHOD(pcib_map_msi, cpcht_map_msi),
109 DEVMETHOD(pcib_request_feature, pcib_request_feature_allow),
116 IRQ_NONE, IRQ_HT, IRQ_MSI, IRQ_INTERNAL
122 vm_offset_t apple_eoi;
127 static struct cpcht_irq *cpcht_irqmap = NULL;
128 uint32_t cpcht_msipic = 0;
131 struct ofw_pci_softc pci_sc;
133 uint64_t sc_populated_slots;
135 struct cpcht_irq htirq_map[128];
136 struct mtx htirq_mtx;
139 static devclass_t cpcht_devclass;
140 DEFINE_CLASS_1(pcib, cpcht_driver, cpcht_methods, sizeof(struct cpcht_softc),
142 DRIVER_MODULE(cpcht, ofwbus, cpcht_driver, cpcht_devclass, 0, 0);
144 #define CPCHT_IOPORT_BASE 0xf4000000UL /* Hardwired */
145 #define CPCHT_IOPORT_SIZE 0x00400000UL
147 #define HTAPIC_REQUEST_EOI 0x20
148 #define HTAPIC_TRIGGER_LEVEL 0x02
149 #define HTAPIC_MASK 0x01
152 cpcht_probe(device_t dev)
154 const char *type, *compatible;
156 type = ofw_bus_get_type(dev);
157 compatible = ofw_bus_get_compat(dev);
159 if (type == NULL || compatible == NULL)
162 if (strcmp(type, "ht") != 0)
165 if (strcmp(compatible, "u3-ht") != 0)
168 device_set_desc(dev, "IBM CPC9X5 HyperTransport Tunnel");
173 cpcht_attach(device_t dev)
175 struct cpcht_softc *sc;
176 phandle_t node, child;
180 node = ofw_bus_get_node(dev);
181 sc = device_get_softc(dev);
183 if (OF_getencprop(node, "reg", reg, sizeof(reg)) < 12)
186 if (OF_getproplen(node, "ranges") <= 0)
187 sc->pci_sc.sc_quirks = OFW_PCI_QUIRK_RANGES_ON_CHILDREN;
188 sc->sc_populated_slots = 0;
189 sc->sc_data = (vm_offset_t)pmap_mapdev(reg[1], reg[2]);
192 * Set up the resource manager and the HT->MPIC mapping. For cpcht,
193 * the ranges are properties of the child bridges, and this is also
194 * where we get the HT interrupts properties.
198 /* I/O port mappings are usually not in the device tree */
199 rman_manage_region(&sc->pci_sc.sc_io_rman, 0, CPCHT_IOPORT_SIZE - 1);
202 bzero(sc->htirq_map, sizeof(sc->htirq_map));
203 mtx_init(&sc->htirq_mtx, "cpcht irq", NULL, MTX_DEF);
204 for (i = 0; i < 8; i++)
205 sc->htirq_map[i].irq_type = IRQ_INTERNAL;
206 for (child = OF_child(node); child != 0; child = OF_peer(child))
207 cpcht_configure_htbridge(dev, child);
209 /* Now make the mapping table available to the MPIC */
210 cpcht_irqmap = sc->htirq_map;
212 return (ofw_pci_attach(dev));
216 cpcht_configure_htbridge(device_t dev, phandle_t child)
218 struct cpcht_softc *sc;
219 struct ofw_pci_register pcir;
225 sc = device_get_softc(dev);
226 if (OF_getencprop(child, "reg", (pcell_t *)&pcir, sizeof(pcir)) == -1)
229 b = OFW_PCI_PHYS_HI_BUS(pcir.phys_hi);
230 s = OFW_PCI_PHYS_HI_DEVICE(pcir.phys_hi);
231 f = OFW_PCI_PHYS_HI_FUNCTION(pcir.phys_hi);
234 * Mark this slot is populated. The remote south bridge does
235 * not like us talking to unpopulated slots on the root bus.
237 sc->sc_populated_slots |= (1 << s);
240 * Next build up any HT->MPIC mappings for this sub-bus. One would
241 * naively hope that enabling, disabling, and EOIing interrupts would
242 * cause the appropriate HT bus transactions to that effect. This is
245 * Instead, we have to muck about on the HT peer's root PCI bridges,
246 * figure out what interrupts they send, enable them, and cache
247 * the location of their WaitForEOI registers so that we can
251 /* All the devices we are interested in have caps */
252 if (!(PCIB_READ_CONFIG(dev, b, s, f, PCIR_STATUS, 2)
253 & PCIM_STATUS_CAPPRESENT))
256 nextptr = PCIB_READ_CONFIG(dev, b, s, f, PCIR_CAP_PTR, 1);
257 while (nextptr != 0) {
259 nextptr = PCIB_READ_CONFIG(dev, b, s, f,
260 ptr + PCICAP_NEXTPTR, 1);
262 /* Find the HT IRQ capabilities */
263 if (PCIB_READ_CONFIG(dev, b, s, f,
264 ptr + PCICAP_ID, 1) != PCIY_HT)
267 val = PCIB_READ_CONFIG(dev, b, s, f, ptr + PCIR_HT_COMMAND, 2);
268 if ((val & PCIM_HTCMD_CAP_MASK) != PCIM_HTCAP_INTERRUPT)
271 /* Ask for the IRQ count */
272 PCIB_WRITE_CONFIG(dev, b, s, f, ptr + PCIR_HT_COMMAND, 0x1, 1);
273 nirq = PCIB_READ_CONFIG(dev, b, s, f, ptr + 4, 4);
274 nirq = ((nirq >> 16) & 0xff) + 1;
276 device_printf(dev, "%d HT IRQs on device %d.%d\n", nirq, s, f);
278 for (i = 0; i < nirq; i++) {
279 PCIB_WRITE_CONFIG(dev, b, s, f,
280 ptr + PCIR_HT_COMMAND, 0x10 + (i << 1), 1);
281 irq = PCIB_READ_CONFIG(dev, b, s, f, ptr + 4, 4);
284 * Mask this interrupt for now.
286 PCIB_WRITE_CONFIG(dev, b, s, f, ptr + 4,
287 irq | HTAPIC_MASK, 4);
288 irq = (irq >> 16) & 0xff;
290 sc->htirq_map[irq].irq_type = IRQ_HT;
291 sc->htirq_map[irq].ht_source = i;
292 sc->htirq_map[irq].ht_base = sc->sc_data +
293 (((((s & 0x1f) << 3) | (f & 0x07)) << 8) | (ptr));
295 PCIB_WRITE_CONFIG(dev, b, s, f,
296 ptr + PCIR_HT_COMMAND, 0x11 + (i << 1), 1);
297 sc->htirq_map[irq].eoi_data =
298 PCIB_READ_CONFIG(dev, b, s, f, ptr + 4, 4) |
302 * Apple uses a non-compliant IO/APIC that differs
303 * in how we signal EOIs. Check if this device was
304 * made by Apple, and act accordingly.
306 vend = PCIB_READ_CONFIG(dev, b, s, f,
308 if ((vend & 0xffff) == 0x106b)
309 sc->htirq_map[irq].apple_eoi =
310 (sc->htirq_map[irq].ht_base - ptr) + 0x60;
316 cpcht_read_config(device_t dev, u_int bus, u_int slot, u_int func, u_int reg,
319 struct cpcht_softc *sc;
322 sc = device_get_softc(dev);
323 caoff = sc->sc_data +
324 (((((slot & 0x1f) << 3) | (func & 0x07)) << 8) | reg);
326 if (bus == 0 && (!(sc->sc_populated_slots & (1 << slot)) || func > 0))
330 caoff += 0x01000000UL + (bus << 16);
334 return (in8rb(caoff));
337 return (in16rb(caoff));
340 return (in32rb(caoff));
348 cpcht_write_config(device_t dev, u_int bus, u_int slot, u_int func,
349 u_int reg, u_int32_t val, int width)
351 struct cpcht_softc *sc;
354 sc = device_get_softc(dev);
355 caoff = sc->sc_data +
356 (((((slot & 0x1f) << 3) | (func & 0x07)) << 8) | reg);
358 if (bus == 0 && (!(sc->sc_populated_slots & (1 << slot)) || func > 0))
362 caoff += 0x01000000UL + (bus << 16);
378 cpcht_route_interrupt(device_t bus, device_t dev, int pin)
384 cpcht_alloc_msi(device_t dev, device_t child, int count, int maxcount,
387 struct cpcht_softc *sc;
390 sc = device_get_softc(dev);
393 /* Bail if no MSI PIC yet */
394 if (cpcht_msipic == 0)
397 mtx_lock(&sc->htirq_mtx);
398 for (i = 8; i < 124 - count; i++) {
399 for (j = 0; j < count; j++) {
400 if (sc->htirq_map[i+j].irq_type != IRQ_NONE)
406 i += j; /* We know there isn't a large enough run */
410 mtx_unlock(&sc->htirq_mtx);
414 for (j = 0; j < count; j++) {
415 irqs[j] = MAP_IRQ(cpcht_msipic, i+j);
416 sc->htirq_map[i+j].irq_type = IRQ_MSI;
418 mtx_unlock(&sc->htirq_mtx);
424 cpcht_release_msi(device_t dev, device_t child, int count, int *irqs)
426 struct cpcht_softc *sc;
429 sc = device_get_softc(dev);
431 mtx_lock(&sc->htirq_mtx);
432 for (i = 0; i < count; i++)
433 sc->htirq_map[irqs[i] & 0xff].irq_type = IRQ_NONE;
434 mtx_unlock(&sc->htirq_mtx);
440 cpcht_alloc_msix(device_t dev, device_t child, int *irq)
442 struct cpcht_softc *sc;
445 sc = device_get_softc(dev);
447 /* Bail if no MSI PIC yet */
448 if (cpcht_msipic == 0)
451 mtx_lock(&sc->htirq_mtx);
452 for (i = 8; i < 124; i++) {
453 if (sc->htirq_map[i].irq_type == IRQ_NONE) {
454 sc->htirq_map[i].irq_type = IRQ_MSI;
455 *irq = MAP_IRQ(cpcht_msipic, i);
457 mtx_unlock(&sc->htirq_mtx);
461 mtx_unlock(&sc->htirq_mtx);
467 cpcht_release_msix(device_t dev, device_t child, int irq)
469 struct cpcht_softc *sc;
471 sc = device_get_softc(dev);
473 mtx_lock(&sc->htirq_mtx);
474 sc->htirq_map[irq & 0xff].irq_type = IRQ_NONE;
475 mtx_unlock(&sc->htirq_mtx);
481 cpcht_map_msi(device_t dev, device_t child, int irq, uint64_t *addr,
485 struct pci_devinfo *dinfo;
486 struct pcicfg_ht *ht = NULL;
488 for (pcib = child; pcib != dev; pcib =
489 device_get_parent(device_get_parent(pcib))) {
490 dinfo = device_get_ivars(pcib);
500 *addr = ht->ht_msiaddr;
507 * Driver for the integrated MPIC on U3/U4 (CPC925/CPC945)
510 static int openpic_cpcht_probe(device_t);
511 static int openpic_cpcht_attach(device_t);
512 static void openpic_cpcht_config(device_t, u_int irq,
513 enum intr_trigger trig, enum intr_polarity pol);
514 static void openpic_cpcht_enable(device_t, u_int irq, u_int vector);
515 static void openpic_cpcht_unmask(device_t, u_int irq);
516 static void openpic_cpcht_eoi(device_t, u_int irq);
518 static device_method_t openpic_cpcht_methods[] = {
519 /* Device interface */
520 DEVMETHOD(device_probe, openpic_cpcht_probe),
521 DEVMETHOD(device_attach, openpic_cpcht_attach),
524 DEVMETHOD(pic_bind, openpic_bind),
525 DEVMETHOD(pic_config, openpic_cpcht_config),
526 DEVMETHOD(pic_dispatch, openpic_dispatch),
527 DEVMETHOD(pic_enable, openpic_cpcht_enable),
528 DEVMETHOD(pic_eoi, openpic_cpcht_eoi),
529 DEVMETHOD(pic_ipi, openpic_ipi),
530 DEVMETHOD(pic_mask, openpic_mask),
531 DEVMETHOD(pic_unmask, openpic_cpcht_unmask),
536 struct openpic_cpcht_softc {
537 struct openpic_softc sc_openpic;
539 struct mtx sc_ht_mtx;
542 static driver_t openpic_cpcht_driver = {
544 openpic_cpcht_methods,
545 sizeof(struct openpic_cpcht_softc),
548 DRIVER_MODULE(openpic, unin, openpic_cpcht_driver, openpic_devclass, 0, 0);
551 openpic_cpcht_probe(device_t dev)
553 const char *type = ofw_bus_get_type(dev);
555 if (strcmp(type, "open-pic") != 0)
558 device_set_desc(dev, OPENPIC_DEVSTR);
563 openpic_cpcht_attach(device_t dev)
565 struct openpic_cpcht_softc *sc;
569 node = ofw_bus_get_node(dev);
570 err = openpic_common_attach(dev, node);
575 * The HT APIC stuff is not thread-safe, so we need a mutex to
578 sc = device_get_softc(dev);
579 mtx_init(&sc->sc_ht_mtx, "htpic", NULL, MTX_SPIN);
582 * Interrupts 0-3 are internally sourced and are level triggered
583 * active low. Interrupts 4-123 are connected to a pulse generator
584 * and should be programmed as edge triggered low-to-high.
586 * IBM CPC945 Manual, Section 9.3.
589 for (irq = 0; irq < 4; irq++)
590 openpic_config(dev, irq, INTR_TRIGGER_LEVEL, INTR_POLARITY_LOW);
591 for (irq = 4; irq < 124; irq++)
592 openpic_config(dev, irq, INTR_TRIGGER_EDGE, INTR_POLARITY_LOW);
595 * Use this PIC for MSI only if it is the root PIC. This may not
596 * be necessary, but Linux does it, and I cannot find any U3 machines
597 * with MSI devices to test.
606 openpic_cpcht_config(device_t dev, u_int irq, enum intr_trigger trig,
607 enum intr_polarity pol)
609 struct openpic_cpcht_softc *sc;
613 * The interrupt settings for the MPIC are completely determined
614 * by the internal wiring in the northbridge. Real changes to these
615 * settings need to be negotiated with the remote IO-APIC on the HT
619 sc = device_get_softc(dev);
621 if (cpcht_irqmap != NULL && irq < 128 &&
622 cpcht_irqmap[irq].ht_base > 0 && !cpcht_irqmap[irq].edge) {
623 mtx_lock_spin(&sc->sc_ht_mtx);
625 /* Program the data port */
626 out8rb(cpcht_irqmap[irq].ht_base + PCIR_HT_COMMAND,
627 0x10 + (cpcht_irqmap[irq].ht_source << 1));
629 /* Grab the IRQ config register */
630 ht_irq = in32rb(cpcht_irqmap[irq].ht_base + 4);
632 /* Mask the IRQ while we fiddle settings */
633 out32rb(cpcht_irqmap[irq].ht_base + 4, ht_irq | HTAPIC_MASK);
635 /* Program the interrupt sense */
636 ht_irq &= ~(HTAPIC_TRIGGER_LEVEL | HTAPIC_REQUEST_EOI);
637 if (trig == INTR_TRIGGER_EDGE) {
638 cpcht_irqmap[irq].edge = 1;
640 cpcht_irqmap[irq].edge = 0;
641 ht_irq |= HTAPIC_TRIGGER_LEVEL | HTAPIC_REQUEST_EOI;
643 out32rb(cpcht_irqmap[irq].ht_base + 4, ht_irq);
645 mtx_unlock_spin(&sc->sc_ht_mtx);
650 openpic_cpcht_enable(device_t dev, u_int irq, u_int vec)
652 struct openpic_cpcht_softc *sc;
655 openpic_enable(dev, irq, vec);
657 sc = device_get_softc(dev);
659 if (cpcht_irqmap != NULL && irq < 128 &&
660 cpcht_irqmap[irq].ht_base > 0) {
661 mtx_lock_spin(&sc->sc_ht_mtx);
663 /* Program the data port */
664 out8rb(cpcht_irqmap[irq].ht_base + PCIR_HT_COMMAND,
665 0x10 + (cpcht_irqmap[irq].ht_source << 1));
667 /* Unmask the interrupt */
668 ht_irq = in32rb(cpcht_irqmap[irq].ht_base + 4);
669 ht_irq &= ~HTAPIC_MASK;
670 out32rb(cpcht_irqmap[irq].ht_base + 4, ht_irq);
672 mtx_unlock_spin(&sc->sc_ht_mtx);
675 openpic_cpcht_eoi(dev, irq);
679 openpic_cpcht_unmask(device_t dev, u_int irq)
681 struct openpic_cpcht_softc *sc;
684 openpic_unmask(dev, irq);
686 sc = device_get_softc(dev);
688 if (cpcht_irqmap != NULL && irq < 128 &&
689 cpcht_irqmap[irq].ht_base > 0) {
690 mtx_lock_spin(&sc->sc_ht_mtx);
692 /* Program the data port */
693 out8rb(cpcht_irqmap[irq].ht_base + PCIR_HT_COMMAND,
694 0x10 + (cpcht_irqmap[irq].ht_source << 1));
696 /* Unmask the interrupt */
697 ht_irq = in32rb(cpcht_irqmap[irq].ht_base + 4);
698 ht_irq &= ~HTAPIC_MASK;
699 out32rb(cpcht_irqmap[irq].ht_base + 4, ht_irq);
701 mtx_unlock_spin(&sc->sc_ht_mtx);
704 openpic_cpcht_eoi(dev, irq);
708 openpic_cpcht_eoi(device_t dev, u_int irq)
710 struct openpic_cpcht_softc *sc;
716 sc = device_get_softc(dev);
718 if (cpcht_irqmap != NULL && irq < 128 &&
719 cpcht_irqmap[irq].ht_base > 0 && !cpcht_irqmap[irq].edge) {
720 /* If this is an HT IRQ, acknowledge it at the remote APIC */
722 if (cpcht_irqmap[irq].apple_eoi) {
723 off = (cpcht_irqmap[irq].ht_source >> 3) & ~3;
724 mask = 1 << (cpcht_irqmap[irq].ht_source & 0x1f);
725 out32rb(cpcht_irqmap[irq].apple_eoi + off, mask);
727 mtx_lock_spin(&sc->sc_ht_mtx);
729 out8rb(cpcht_irqmap[irq].ht_base + PCIR_HT_COMMAND,
730 0x11 + (cpcht_irqmap[irq].ht_source << 1));
731 out32rb(cpcht_irqmap[irq].ht_base + 4,
732 cpcht_irqmap[irq].eoi_data);
734 mtx_unlock_spin(&sc->sc_ht_mtx);
738 openpic_eoi(dev, irq);