2 * Copyright 1998 Massachusetts Institute of Technology
4 * Permission to use, copy, modify, and distribute this software and
5 * its documentation for any purpose and without fee is hereby
6 * granted, provided that both the above copyright notice and this
7 * permission notice appear in all copies, that both the above
8 * copyright notice and this permission notice appear in all
9 * supporting documentation, and that the name of M.I.T. not be used
10 * in advertising or publicity pertaining to distribution of the
11 * software without specific, written prior permission. M.I.T. makes
12 * no representations about the suitability of this software for any
13 * purpose. It is provided "as is" without express or implied
16 * THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''. M.I.T. DISCLAIMS
17 * ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE,
18 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
20 * SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
23 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
25 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
26 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 * $FreeBSD: src/sys/i386/i386/nexus.c,v 1.26.2.10 2003/02/22 13:16:45 imp Exp $
33 * This code implements a `root nexus' for Intel Architecture
34 * machines. The function of the root nexus is to serve as an
35 * attachment point for both processors and buses, and to manage
36 * resources which are common to all of them. In particular,
37 * this code implements the core resource managers for interrupt
38 * requests, DMA requests (which rightfully should be a part of the
39 * ISA code but it's easier to do it here for now), I/O port addresses,
40 * and I/O memory address space.
43 #include <sys/param.h>
44 #include <sys/systm.h>
46 #include <sys/kernel.h>
47 #include <sys/malloc.h>
48 #include <sys/module.h>
50 #include <sys/interrupt.h>
51 #include <sys/machintr.h>
53 #include <machine/vmparam.h>
56 #include <machine/pmap.h>
58 #include <machine/nexusvar.h>
59 #include <machine/smp.h>
60 #include <machine/intr_machdep.h>
61 #include <machine_base/apic/ioapic.h>
63 #include <bus/pci/pcivar.h>
64 #include <bus/pci/pcireg.h>
65 #include <bus/pci/pcibus.h>
66 #include <bus/pci/pci_cfgreg.h>
67 #include <bus/pci/pcib_private.h>
71 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
73 struct resource_list nx_resources;
77 #define DEVTONX(dev) ((struct nexus_device *)device_get_ivars(dev))
79 static struct rman irq_rman[MAXCPU], drq_rman, port_rman, mem_rman;
81 static int nexus_probe(device_t);
82 static int nexus_attach(device_t);
83 static int nexus_print_all_resources(device_t dev);
84 static int nexus_print_child(device_t, device_t);
85 static device_t nexus_add_child(device_t bus, device_t parent, int order,
86 const char *name, int unit);
87 static struct resource *nexus_alloc_resource(device_t, device_t, int, int *,
88 u_long, u_long, u_long, u_int, int);
89 static int nexus_read_ivar(device_t, device_t, int, uintptr_t *);
90 static int nexus_write_ivar(device_t, device_t, int, uintptr_t);
91 static int nexus_activate_resource(device_t, device_t, int, int,
93 static int nexus_deactivate_resource(device_t, device_t, int, int,
95 static int nexus_release_resource(device_t, device_t, int, int,
97 static int nexus_config_intr(device_t, device_t, int, enum intr_trigger,
99 static int nexus_setup_intr(device_t, device_t, struct resource *, int flags,
100 void (*)(void *), void *,
101 void **, lwkt_serialize_t);
102 static int nexus_teardown_intr(device_t, device_t, struct resource *,
104 static int nexus_set_resource(device_t, device_t, int, int, u_long, u_long,
106 static int nexus_get_resource(device_t, device_t, int, int, u_long *, u_long *);
107 static void nexus_delete_resource(device_t, device_t, int, int);
110 * The device_identify method will cause nexus to automatically associate
111 * and attach to the root bus.
113 static device_method_t nexus_methods[] = {
114 /* Device interface */
115 DEVMETHOD(device_identify, bus_generic_identify),
116 DEVMETHOD(device_probe, nexus_probe),
117 DEVMETHOD(device_attach, nexus_attach),
118 DEVMETHOD(device_detach, bus_generic_detach),
119 DEVMETHOD(device_shutdown, bus_generic_shutdown),
120 DEVMETHOD(device_suspend, bus_generic_suspend),
121 DEVMETHOD(device_resume, bus_generic_resume),
124 DEVMETHOD(bus_print_child, nexus_print_child),
125 DEVMETHOD(bus_add_child, nexus_add_child),
126 DEVMETHOD(bus_read_ivar, nexus_read_ivar),
127 DEVMETHOD(bus_write_ivar, nexus_write_ivar),
128 DEVMETHOD(bus_alloc_resource, nexus_alloc_resource),
129 DEVMETHOD(bus_release_resource, nexus_release_resource),
130 DEVMETHOD(bus_activate_resource, nexus_activate_resource),
131 DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource),
132 DEVMETHOD(bus_config_intr, nexus_config_intr),
133 DEVMETHOD(bus_setup_intr, nexus_setup_intr),
134 DEVMETHOD(bus_teardown_intr, nexus_teardown_intr),
135 DEVMETHOD(bus_set_resource, nexus_set_resource),
136 DEVMETHOD(bus_get_resource, nexus_get_resource),
137 DEVMETHOD(bus_delete_resource, nexus_delete_resource),
142 static driver_t nexus_driver = {
147 static devclass_t nexus_devclass;
149 DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, NULL, NULL);
152 nexus_probe(device_t dev)
156 device_quiet(dev); /* suppress attach message for neatness */
158 for (cpuid = 0; cpuid < ncpus; ++cpuid) {
159 struct rman *rm = &irq_rman[cpuid];
162 * IRQ's are on the mainboard on old systems, but on
163 * the ISA part of PCI->ISA bridges. There would be
164 * multiple sets of IRQs on multi-ISA-bus systems.
165 * PCI interrupts are routed to the ISA component,
166 * so in a way, PCI can be a partial child of an ISA
167 * bus(!). APIC interrupts are global though. In the
168 * non-APIC case, disallow the use of IRQ 2.
171 rm->rm_type = RMAN_ARRAY;
172 rm->rm_descr = "Interrupt request lines";
175 * XXX should use MachIntrABI.rman_setup
178 rm->rm_end = IDT_HWI_VECTORS - 1;
179 if (rman_init(rm, cpuid) ||
180 rman_manage_region(rm,
181 rm->rm_start, rm->rm_end))
182 panic("nexus_probe irq_rman");
185 if (rman_init(rm, cpuid) ||
186 rman_manage_region(rm, rm->rm_start, 1) ||
187 rman_manage_region(rm, 3, rm->rm_end))
188 panic("nexus_probe irq_rman");
193 * ISA DMA on PCI systems is implemented in the ISA part of each
194 * PCI->ISA bridge and the channels can be duplicated if there are
195 * multiple bridges. (eg: laptops with docking stations)
197 drq_rman.rm_start = 0;
199 drq_rman.rm_type = RMAN_ARRAY;
200 drq_rman.rm_descr = "DMA request lines";
201 /* XXX drq 0 not available on some machines */
202 if (rman_init(&drq_rman, -1)
203 || rman_manage_region(&drq_rman,
204 drq_rman.rm_start, drq_rman.rm_end))
205 panic("nexus_probe drq_rman");
208 * However, IO ports and Memory truely are global at this level,
209 * as are APIC interrupts (however many IO APICS there turn out
210 * to be on large systems..)
212 port_rman.rm_start = 0;
213 port_rman.rm_end = 0xffff;
214 port_rman.rm_type = RMAN_ARRAY;
215 port_rman.rm_descr = "I/O ports";
216 if (rman_init(&port_rman, -1)
217 || rman_manage_region(&port_rman, 0, 0xffff))
218 panic("nexus_probe port_rman");
220 mem_rman.rm_start = 0;
221 mem_rman.rm_end = ~0u;
222 mem_rman.rm_type = RMAN_ARRAY;
223 mem_rman.rm_descr = "I/O memory addresses";
224 if (rman_init(&mem_rman, -1)
225 || rman_manage_region(&mem_rman, 0, ~0))
226 panic("nexus_probe mem_rman");
228 return bus_generic_probe(dev);
232 nexus_attach(device_t dev)
237 * First, let our child driver's identify any child devices that
238 * they can find. Once that is done attach any devices that we
242 bus_generic_probe(dev);
244 bus_generic_attach(dev);
247 * And if we didn't see ISA on a pci bridge, create a
248 * connection point now so it shows up "on motherboard".
250 if (!devclass_get_device(devclass_find("isa"), 0)) {
251 child = BUS_ADD_CHILD(dev, dev, 0, "isa", 0);
253 panic("nexus_attach isa");
254 device_probe_and_attach(child);
261 nexus_print_all_resources(device_t dev)
263 struct nexus_device *ndev = DEVTONX(dev);
264 struct resource_list *rl = &ndev->nx_resources;
267 if (SLIST_FIRST(rl) || ndev->nx_pcibus != -1)
268 retval += kprintf(" at");
270 retval += resource_list_print_type(rl, "port", SYS_RES_IOPORT, "%#lx");
271 retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#lx");
272 retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
278 nexus_print_child(device_t bus, device_t child)
280 struct nexus_device *ndev = DEVTONX(child);
283 retval += bus_print_child_header(bus, child);
284 retval += nexus_print_all_resources(child);
285 if (ndev->nx_pcibus != -1)
286 retval += kprintf(" pcibus %d", ndev->nx_pcibus);
287 retval += kprintf(" on motherboard\n");
293 nexus_add_child(device_t bus, device_t parent, int order,
294 const char *name, int unit)
297 struct nexus_device *ndev;
299 ndev = kmalloc(sizeof(struct nexus_device), M_NEXUSDEV, M_INTWAIT|M_ZERO);
302 resource_list_init(&ndev->nx_resources);
303 ndev->nx_pcibus = -1;
305 child = device_add_child_ordered(parent, order, name, unit);
307 /* should we free this in nexus_child_detached? */
308 device_set_ivars(child, ndev);
314 nexus_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
316 struct nexus_device *ndev = DEVTONX(child);
319 case NEXUS_IVAR_PCIBUS:
320 *result = ndev->nx_pcibus;
329 nexus_write_ivar(device_t dev, device_t child, int which, uintptr_t value)
331 struct nexus_device *ndev = DEVTONX(child);
334 case NEXUS_IVAR_PCIBUS:
335 ndev->nx_pcibus = value;
344 * Allocate a resource on behalf of child. NB: child is usually going to be a
345 * child of one of our descendants, not a direct child of nexus0.
346 * (Exceptions include npx.)
348 static struct resource *
349 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
350 u_long start, u_long end, u_long count, u_int flags, int cpuid)
352 struct nexus_device *ndev = DEVTONX(child);
354 struct resource_list_entry *rle;
356 int needactivate = flags & RF_ACTIVE;
359 * If this is an allocation of the "default" range for a given RID, and
360 * we know what the resources for this device are (ie. they aren't maintained
361 * by a child bus), then work out the start/end values.
363 if ((start == 0UL) && (end == ~0UL) && (count == 1)) {
366 rle = resource_list_find(&ndev->nx_resources, type, *rid);
379 if (cpuid < 0 || cpuid >= ncpus) {
380 kprintf("NEXUS cpuid %d:\n", cpuid);
384 rm = &irq_rman[cpuid];
403 rv = rman_reserve_resource(rm, start, end, count, flags, child);
407 if (type == SYS_RES_MEMORY) {
408 rman_set_bustag(rv, I386_BUS_SPACE_MEM);
409 } else if (type == SYS_RES_IOPORT) {
410 rman_set_bustag(rv, I386_BUS_SPACE_IO);
411 rman_set_bushandle(rv, rv->r_start);
415 if (bus_activate_resource(child, type, *rid, rv)) {
416 rman_release_resource(rv);
425 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
429 * If this is a memory resource, map it into the kernel.
431 if (rman_get_bustag(r) == I386_BUS_SPACE_MEM) {
434 if (rman_get_end(r) < 1024 * 1024) {
436 * The first 1Mb is mapped at KERNBASE.
438 vaddr = (caddr_t)(uintptr_t)(KERNBASE + rman_get_start(r));
444 paddr = rman_get_start(r);
445 psize = rman_get_size(r);
447 poffs = paddr - trunc_page(paddr);
448 vaddr = (caddr_t) pmap_mapdev(paddr-poffs, psize+poffs) + poffs;
450 rman_set_virtual(r, vaddr);
451 /* IBM-PC: the type of bus_space_handle_t is u_int */
452 rman_set_bushandle(r, (bus_space_handle_t) vaddr);
454 return (rman_activate_resource(r));
458 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
462 * If this is a memory resource, unmap it.
464 if ((rman_get_bustag(r) == I386_BUS_SPACE_MEM) &&
465 (rman_get_end(r) >= 1024 * 1024)) {
468 psize = rman_get_size(r);
469 pmap_unmapdev((vm_offset_t)rman_get_virtual(r), psize);
472 return (rman_deactivate_resource(r));
476 nexus_release_resource(device_t bus, device_t child, int type, int rid,
479 if (rman_get_flags(r) & RF_ACTIVE) {
480 int error = bus_deactivate_resource(child, type, rid, r);
484 return (rman_release_resource(r));
488 nexus_config_intr(device_t bus, device_t chile, int irq,
489 enum intr_trigger trig, enum intr_polarity pola)
491 machintr_intr_config(irq, trig, pola);
496 * Currently this uses the really grody interface from kern/kern_intr.c
497 * (which really doesn't belong in kern/anything.c). Eventually, all of
498 * the code in kern_intr.c and machdep_intr.c should get moved here, since
499 * this is going to be the official interface.
502 nexus_setup_intr(device_t bus, device_t child, struct resource *irq,
503 int flags, void (*ihand)(void *), void *arg,
504 void **cookiep, lwkt_serialize_t serializer)
508 /* somebody tried to setup an irq that failed to allocate! */
510 panic("nexus_setup_intr: NULL irq resource!");
514 if ((irq->r_flags & RF_SHAREABLE) == 0)
515 icflags |= INTR_EXCL;
518 * We depend here on rman_activate_resource() being idempotent.
520 error = rman_activate_resource(irq);
525 * XXX cast the interrupt handler function to an inthand2_t. The
526 * difference is that an additional frame argument is passed which
527 * we do not currently want to expose the BUS subsystem to.
529 *cookiep = register_int(irq->r_start, (inthand2_t *)ihand, arg,
530 device_get_nameunit(child), serializer,
531 icflags, rman_get_cpuid(irq));
532 if (*cookiep == NULL)
538 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
541 unregister_int(ih, rman_get_cpuid(r));
548 nexus_set_resource(device_t dev, device_t child, int type, int rid,
549 u_long start, u_long count, int cpuid)
551 struct nexus_device *ndev = DEVTONX(child);
552 struct resource_list *rl = &ndev->nx_resources;
554 /* XXX this should return a success/failure indicator */
555 resource_list_add(rl, type, rid, start, start + count - 1, count,
561 nexus_get_resource(device_t dev, device_t child, int type, int rid, u_long *startp, u_long *countp)
563 struct nexus_device *ndev = DEVTONX(child);
564 struct resource_list *rl = &ndev->nx_resources;
565 struct resource_list_entry *rle;
567 rle = resource_list_find(rl, type, rid);
568 device_printf(child, "type %d rid %d startp %p countp %p - got %p\n",
569 type, rid, startp, countp, rle);
573 *startp = rle->start;
575 *countp = rle->count;
580 nexus_delete_resource(device_t dev, device_t child, int type, int rid)
582 struct nexus_device *ndev = DEVTONX(child);
583 struct resource_list *rl = &ndev->nx_resources;
585 resource_list_delete(rl, type, rid);