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
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
34 * This code implements a `root nexus' for Intel Architecture
35 * machines. The function of the root nexus is to serve as an
36 * attachment point for both processors and buses, and to manage
37 * resources which are common to all of them. In particular,
38 * this code implements the core resource managers for interrupt
39 * requests, DMA requests (which rightfully should be a part of the
40 * ISA code but it's easier to do it here for now), I/O port addresses,
41 * and I/O memory address space.
47 #include <sys/param.h>
48 #include <sys/systm.h>
50 #include <sys/kernel.h>
51 #include <sys/malloc.h>
52 #include <sys/module.h>
53 #include <machine/bus.h>
54 #include <machine/intr_machdep.h>
56 #include <sys/interrupt.h>
58 #include <machine/vmparam.h>
61 #include <machine/pmap.h>
63 #include <machine/nexusvar.h>
64 #include <machine/resource.h>
71 #include <isa/isavar.h>
73 #include <pc98/cbus/cbus.h>
75 #include <i386/isa/isa.h>
78 #include <sys/rtprio.h>
80 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
82 #define DEVTONX(dev) ((struct nexus_device *)device_get_ivars(dev))
84 struct rman irq_rman, drq_rman, port_rman, mem_rman;
86 static int nexus_probe(device_t);
87 static int nexus_attach(device_t);
88 static int nexus_print_all_resources(device_t dev);
89 static int nexus_print_child(device_t, device_t);
90 static device_t nexus_add_child(device_t bus, int order, const char *name,
92 static struct resource *nexus_alloc_resource(device_t, device_t, int, int *,
93 u_long, u_long, u_long, u_int);
95 static int nexus_bind_intr(device_t, device_t, struct resource *, int);
97 static int nexus_config_intr(device_t, int, enum intr_trigger,
99 static int nexus_activate_resource(device_t, device_t, int, int,
101 static int nexus_deactivate_resource(device_t, device_t, int, int,
103 static int nexus_release_resource(device_t, device_t, int, int,
105 static int nexus_setup_intr(device_t, device_t, struct resource *, int flags,
106 driver_filter_t filter, void (*)(void *), void *,
108 static int nexus_teardown_intr(device_t, device_t, struct resource *,
110 static struct resource_list *nexus_get_reslist(device_t dev, device_t child);
111 static int nexus_set_resource(device_t, device_t, int, int, u_long, u_long);
112 static int nexus_get_resource(device_t, device_t, int, int, u_long *, u_long *);
113 static void nexus_delete_resource(device_t, device_t, int, int);
115 static int nexus_alloc_msi(device_t pcib, device_t dev, int count, int maxcount, int *irqs);
116 static int nexus_release_msi(device_t pcib, device_t dev, int count, int *irqs);
117 static int nexus_alloc_msix(device_t pcib, device_t dev, int *irq);
118 static int nexus_release_msix(device_t pcib, device_t dev, int irq);
119 static int nexus_map_msi(device_t pcib, device_t dev, int irq, uint64_t *addr, uint32_t *data);
122 static device_method_t nexus_methods[] = {
123 /* Device interface */
124 DEVMETHOD(device_probe, nexus_probe),
125 DEVMETHOD(device_attach, nexus_attach),
126 DEVMETHOD(device_detach, bus_generic_detach),
127 DEVMETHOD(device_shutdown, bus_generic_shutdown),
128 DEVMETHOD(device_suspend, bus_generic_suspend),
129 DEVMETHOD(device_resume, bus_generic_resume),
132 DEVMETHOD(bus_print_child, nexus_print_child),
133 DEVMETHOD(bus_add_child, nexus_add_child),
134 DEVMETHOD(bus_alloc_resource, nexus_alloc_resource),
135 DEVMETHOD(bus_release_resource, nexus_release_resource),
136 DEVMETHOD(bus_activate_resource, nexus_activate_resource),
137 DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource),
138 DEVMETHOD(bus_setup_intr, nexus_setup_intr),
139 DEVMETHOD(bus_teardown_intr, nexus_teardown_intr),
141 DEVMETHOD(bus_bind_intr, nexus_bind_intr),
143 DEVMETHOD(bus_config_intr, nexus_config_intr),
144 DEVMETHOD(bus_get_resource_list, nexus_get_reslist),
145 DEVMETHOD(bus_set_resource, nexus_set_resource),
146 DEVMETHOD(bus_get_resource, nexus_get_resource),
147 DEVMETHOD(bus_delete_resource, nexus_delete_resource),
151 DEVMETHOD(pcib_alloc_msi, nexus_alloc_msi),
152 DEVMETHOD(pcib_release_msi, nexus_release_msi),
153 DEVMETHOD(pcib_alloc_msix, nexus_alloc_msix),
154 DEVMETHOD(pcib_release_msix, nexus_release_msix),
155 DEVMETHOD(pcib_map_msi, nexus_map_msi),
161 DEFINE_CLASS_0(nexus, nexus_driver, nexus_methods, 1);
162 static devclass_t nexus_devclass;
164 DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0);
167 nexus_probe(device_t dev)
170 device_quiet(dev); /* suppress attach message for neatness */
171 return (BUS_PROBE_GENERIC);
175 nexus_init_resources(void)
182 * - IRQ resource creation should be moved to the PIC/APIC driver.
183 * - DRQ resource creation should be moved to the DMAC driver.
184 * - The above should be sorted to probe earlier than any child busses.
186 * - Leave I/O and memory creation here, as child probes may need them.
187 * (especially eg. ACPI)
191 * IRQ's are on the mainboard on old systems, but on the ISA part
192 * of PCI->ISA bridges. There would be multiple sets of IRQs on
193 * multi-ISA-bus systems. PCI interrupts are routed to the ISA
194 * component, so in a way, PCI can be a partial child of an ISA bus(!).
195 * APIC interrupts are global though.
197 irq_rman.rm_start = 0;
198 irq_rman.rm_type = RMAN_ARRAY;
199 irq_rman.rm_descr = "Interrupt request lines";
200 irq_rman.rm_end = NUM_IO_INTS - 1;
201 if (rman_init(&irq_rman))
202 panic("nexus_init_resources irq_rman");
205 * We search for regions of existing IRQs and add those to the IRQ
208 for (irq = 0; irq < NUM_IO_INTS; irq++)
209 if (intr_lookup_source(irq) != NULL)
210 if (rman_manage_region(&irq_rman, irq, irq) != 0)
211 panic("nexus_init_resources irq_rman add");
214 * ISA DMA on PCI systems is implemented in the ISA part of each
215 * PCI->ISA bridge and the channels can be duplicated if there are
216 * multiple bridges. (eg: laptops with docking stations)
218 drq_rman.rm_start = 0;
224 drq_rman.rm_type = RMAN_ARRAY;
225 drq_rman.rm_descr = "DMA request lines";
226 /* XXX drq 0 not available on some machines */
227 if (rman_init(&drq_rman)
228 || rman_manage_region(&drq_rman,
229 drq_rman.rm_start, drq_rman.rm_end))
230 panic("nexus_init_resources drq_rman");
233 * However, IO ports and Memory truely are global at this level,
234 * as are APIC interrupts (however many IO APICS there turn out
235 * to be on large systems..)
237 port_rman.rm_start = 0;
238 port_rman.rm_end = 0xffff;
239 port_rman.rm_type = RMAN_ARRAY;
240 port_rman.rm_descr = "I/O ports";
241 if (rman_init(&port_rman)
242 || rman_manage_region(&port_rman, 0, 0xffff))
243 panic("nexus_init_resources port_rman");
245 mem_rman.rm_start = 0;
246 mem_rman.rm_end = ~0u;
247 mem_rman.rm_type = RMAN_ARRAY;
248 mem_rman.rm_descr = "I/O memory addresses";
249 if (rman_init(&mem_rman)
250 || rman_manage_region(&mem_rman, 0, ~0))
251 panic("nexus_init_resources mem_rman");
255 nexus_attach(device_t dev)
258 nexus_init_resources();
259 bus_generic_probe(dev);
262 * Explicitly add the legacy0 device here. Other platform
263 * types (such as ACPI), use their own nexus(4) subclass
264 * driver to override this routine and add their own root bus.
266 if (BUS_ADD_CHILD(dev, 10, "legacy", 0) == NULL)
267 panic("legacy: could not attach");
268 bus_generic_attach(dev);
273 nexus_print_all_resources(device_t dev)
275 struct nexus_device *ndev = DEVTONX(dev);
276 struct resource_list *rl = &ndev->nx_resources;
279 if (STAILQ_FIRST(rl))
280 retval += printf(" at");
282 retval += resource_list_print_type(rl, "port", SYS_RES_IOPORT, "%#lx");
283 retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#lx");
284 retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
290 nexus_print_child(device_t bus, device_t child)
294 retval += bus_print_child_header(bus, child);
295 retval += nexus_print_all_resources(child);
296 if (device_get_flags(child))
297 retval += printf(" flags %#x", device_get_flags(child));
298 retval += printf(" on motherboard\n"); /* XXX "motherboard", ick */
304 nexus_add_child(device_t bus, int order, const char *name, int unit)
307 struct nexus_device *ndev;
309 ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_NOWAIT|M_ZERO);
312 resource_list_init(&ndev->nx_resources);
314 child = device_add_child_ordered(bus, order, name, unit);
316 /* should we free this in nexus_child_detached? */
317 device_set_ivars(child, ndev);
323 * Allocate a resource on behalf of child. NB: child is usually going to be a
324 * child of one of our descendants, not a direct child of nexus0.
325 * (Exceptions include npx.)
327 static struct resource *
328 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
329 u_long start, u_long end, u_long count, u_int flags)
331 struct nexus_device *ndev = DEVTONX(child);
333 struct resource_list_entry *rle;
335 int needactivate = flags & RF_ACTIVE;
338 * If this is an allocation of the "default" range for a given RID, and
339 * we know what the resources for this device are (ie. they aren't maintained
340 * by a child bus), then work out the start/end values.
342 if ((start == 0UL) && (end == ~0UL) && (count == 1)) {
345 rle = resource_list_find(&ndev->nx_resources, type, *rid);
376 rv = rman_reserve_resource(rm, start, end, count, flags, child);
379 rman_set_rid(rv, *rid);
382 if (bus_activate_resource(child, type, *rid, rv)) {
383 rman_release_resource(rv);
392 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
396 bus_space_handle_t bh;
402 * If this is a memory resource, map it into the kernel.
407 error = i386_bus_space_handle_alloc(I386_BUS_SPACE_IO,
408 rman_get_start(r), rman_get_size(r), &bh);
411 rman_set_bushandle(r, bh);
413 rman_set_bushandle(r, rman_get_start(r));
415 rman_set_bustag(r, I386_BUS_SPACE_IO);
419 error = i386_bus_space_handle_alloc(I386_BUS_SPACE_MEM,
420 rman_get_start(r), rman_get_size(r), &bh);
424 vaddr = pmap_mapdev(rman_get_start(r), rman_get_size(r));
425 rman_set_virtual(r, vaddr);
426 rman_set_bustag(r, I386_BUS_SPACE_MEM);
428 /* PC-98: the type of bus_space_handle_t is the structure. */
429 bh->bsh_base = (bus_addr_t) vaddr;
430 rman_set_bushandle(r, bh);
432 /* IBM-PC: the type of bus_space_handle_t is u_int */
433 rman_set_bushandle(r, (bus_space_handle_t) vaddr);
436 return (rman_activate_resource(r));
440 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
445 * If this is a memory resource, unmap it.
447 if (type == SYS_RES_MEMORY) {
448 pmap_unmapdev((vm_offset_t)rman_get_virtual(r),
452 if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
453 bus_space_handle_t bh;
455 bh = rman_get_bushandle(r);
456 i386_bus_space_handle_free(rman_get_bustag(r), bh, bh->bsh_sz);
459 return (rman_deactivate_resource(r));
463 nexus_release_resource(device_t bus, device_t child, int type, int rid,
466 if (rman_get_flags(r) & RF_ACTIVE) {
467 int error = bus_deactivate_resource(child, type, rid, r);
471 return (rman_release_resource(r));
475 * Currently this uses the really grody interface from kern/kern_intr.c
476 * (which really doesn't belong in kern/anything.c). Eventually, all of
477 * the code in kern_intr.c and machdep_intr.c should get moved here, since
478 * this is going to be the official interface.
481 nexus_setup_intr(device_t bus, device_t child, struct resource *irq,
482 int flags, driver_filter_t filter, void (*ihand)(void *),
483 void *arg, void **cookiep)
487 /* somebody tried to setup an irq that failed to allocate! */
489 panic("nexus_setup_intr: NULL irq resource!");
492 if ((rman_get_flags(irq) & RF_SHAREABLE) == 0)
496 * We depend here on rman_activate_resource() being idempotent.
498 error = rman_activate_resource(irq);
502 error = intr_add_handler(device_get_nameunit(child),
503 rman_get_start(irq), filter, ihand, arg, flags, cookiep);
509 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
511 return (intr_remove_handler(ih));
516 nexus_bind_intr(device_t dev, device_t child, struct resource *irq, int cpu)
518 return (intr_bind(rman_get_start(irq), cpu));
523 nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
524 enum intr_polarity pol)
526 return (intr_config_intr(irq, trig, pol));
529 static struct resource_list *
530 nexus_get_reslist(device_t dev, device_t child)
532 struct nexus_device *ndev = DEVTONX(child);
534 return (&ndev->nx_resources);
538 nexus_set_resource(device_t dev, device_t child, int type, int rid, u_long start, u_long count)
540 struct nexus_device *ndev = DEVTONX(child);
541 struct resource_list *rl = &ndev->nx_resources;
543 /* XXX this should return a success/failure indicator */
544 resource_list_add(rl, type, rid, start, start + count - 1, count);
549 nexus_get_resource(device_t dev, device_t child, int type, int rid, u_long *startp, u_long *countp)
551 struct nexus_device *ndev = DEVTONX(child);
552 struct resource_list *rl = &ndev->nx_resources;
553 struct resource_list_entry *rle;
555 rle = resource_list_find(rl, type, rid);
559 *startp = rle->start;
561 *countp = rle->count;
566 nexus_delete_resource(device_t dev, device_t child, int type, int rid)
568 struct nexus_device *ndev = DEVTONX(child);
569 struct resource_list *rl = &ndev->nx_resources;
571 resource_list_delete(rl, type, rid);
574 /* Called from the MSI code to add new IRQs to the IRQ rman. */
576 nexus_add_irq(u_long irq)
579 if (rman_manage_region(&irq_rman, irq, irq) != 0)
580 panic("%s: failed", __func__);
585 nexus_alloc_msix(device_t pcib, device_t dev, int *irq)
588 return (msix_alloc(dev, irq));
592 nexus_release_msix(device_t pcib, device_t dev, int irq)
595 return (msix_release(irq));
599 nexus_alloc_msi(device_t pcib, device_t dev, int count, int maxcount, int *irqs)
602 return (msi_alloc(dev, count, maxcount, irqs));
606 nexus_release_msi(device_t pcib, device_t dev, int count, int *irqs)
609 return (msi_release(irqs, count));
613 nexus_map_msi(device_t pcib, device_t dev, int irq, uint64_t *addr, uint32_t *data)
616 return (msi_map(irq, addr, data));
620 /* Placeholder for system RAM. */
622 ram_identify(driver_t *driver, device_t parent)
625 if (resource_disabled("ram", 0))
627 if (BUS_ADD_CHILD(parent, 0, "ram", 0) == NULL)
628 panic("ram_identify");
632 ram_probe(device_t dev)
636 device_set_desc(dev, "System RAM");
641 ram_attach(device_t dev)
643 struct resource *res;
648 * We use the dump_avail[] array rather than phys_avail[] for
649 * the memory map as phys_avail[] contains holes for kernel
650 * memory, page 0, the message buffer, and the dcons buffer.
651 * We test the end address in the loop instead of the start
652 * since the start address for the first segment is 0.
654 * XXX: It would be preferable to use the SMAP if it exists
655 * instead since if the SMAP is very fragmented we may not
656 * include some memory regions in dump_avail[] and phys_avail[].
658 for (i = 0, p = dump_avail; p[1] != 0; i++, p += 2) {
662 * Resources use long's to track resources, so we can't
663 * include memory regions above 4GB.
668 error = bus_set_resource(dev, SYS_RES_MEMORY, rid, p[0],
671 panic("ram_attach: resource %d failed set with %d", i,
673 res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, 0);
675 panic("ram_attach: resource %d failed to attach", i);
680 static device_method_t ram_methods[] = {
681 /* Device interface */
682 DEVMETHOD(device_identify, ram_identify),
683 DEVMETHOD(device_probe, ram_probe),
684 DEVMETHOD(device_attach, ram_attach),
688 static driver_t ram_driver = {
694 static devclass_t ram_devclass;
696 DRIVER_MODULE(ram, nexus, ram_driver, ram_devclass, 0, 0);
700 * Placeholder which claims PnP 'devices' which describe system
703 static struct isa_pnp_id sysresource_ids[] = {
704 { 0x010cd041 /* PNP0c01 */, "System Memory" },
705 { 0x020cd041 /* PNP0c02 */, "System Resource" },
710 sysresource_probe(device_t dev)
714 if ((result = ISA_PNP_PROBE(device_get_parent(dev), dev, sysresource_ids)) <= 0) {
721 sysresource_attach(device_t dev)
726 static device_method_t sysresource_methods[] = {
727 /* Device interface */
728 DEVMETHOD(device_probe, sysresource_probe),
729 DEVMETHOD(device_attach, sysresource_attach),
730 DEVMETHOD(device_detach, bus_generic_detach),
731 DEVMETHOD(device_shutdown, bus_generic_shutdown),
732 DEVMETHOD(device_suspend, bus_generic_suspend),
733 DEVMETHOD(device_resume, bus_generic_resume),
737 static driver_t sysresource_driver = {
743 static devclass_t sysresource_devclass;
745 DRIVER_MODULE(sysresource, isa, sysresource_driver, sysresource_devclass, 0, 0);