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.
51 #include <sys/param.h>
52 #include <sys/systm.h>
54 #include <sys/kernel.h>
55 #include <sys/linker.h>
56 #include <sys/malloc.h>
57 #include <sys/module.h>
58 #include <machine/bus.h>
59 #include <machine/intr_machdep.h>
61 #include <sys/interrupt.h>
63 #include <machine/vmparam.h>
66 #include <machine/pmap.h>
68 #include <machine/metadata.h>
69 #include <machine/nexusvar.h>
70 #include <machine/resource.h>
71 #include <machine/pc/bios.h>
78 #include <isa/isavar.h>
80 #include <pc98/cbus/cbus.h>
81 #elif defined(__amd64__)
82 #include <amd64/isa/isa.h>
84 #include <i386/isa/isa.h>
87 #include <sys/rtprio.h>
90 #define BUS_SPACE_IO AMD64_BUS_SPACE_IO
91 #define BUS_SPACE_MEM AMD64_BUS_SPACE_MEM
93 #define BUS_SPACE_IO I386_BUS_SPACE_IO
94 #define BUS_SPACE_MEM I386_BUS_SPACE_MEM
97 #define ELF_KERN_STR ("elf"__XSTRING(__ELF_WORD_SIZE)" kernel")
99 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
101 #define DEVTONX(dev) ((struct nexus_device *)device_get_ivars(dev))
103 struct rman irq_rman, drq_rman, port_rman, mem_rman;
105 static int nexus_probe(device_t);
106 static int nexus_attach(device_t);
107 static int nexus_print_all_resources(device_t dev);
108 static int nexus_print_child(device_t, device_t);
109 static device_t nexus_add_child(device_t bus, u_int order, const char *name,
111 static struct resource *nexus_alloc_resource(device_t, device_t, int, int *,
112 u_long, u_long, u_long, u_int);
114 static int nexus_bind_intr(device_t, device_t, struct resource *, int);
116 static int nexus_config_intr(device_t, int, enum intr_trigger,
118 static int nexus_describe_intr(device_t dev, device_t child,
119 struct resource *irq, void *cookie,
121 static int nexus_activate_resource(device_t, device_t, int, int,
123 static int nexus_deactivate_resource(device_t, device_t, int, int,
125 static int nexus_release_resource(device_t, device_t, int, int,
127 static int nexus_setup_intr(device_t, device_t, struct resource *, int flags,
128 driver_filter_t filter, void (*)(void *), void *,
130 static int nexus_teardown_intr(device_t, device_t, struct resource *,
132 static struct resource_list *nexus_get_reslist(device_t dev, device_t child);
133 static int nexus_set_resource(device_t, device_t, int, int, u_long, u_long);
134 static int nexus_get_resource(device_t, device_t, int, int, u_long *, u_long *);
135 static void nexus_delete_resource(device_t, device_t, int, int);
137 static int nexus_alloc_msi(device_t pcib, device_t dev, int count, int maxcount, int *irqs);
138 static int nexus_release_msi(device_t pcib, device_t dev, int count, int *irqs);
139 static int nexus_alloc_msix(device_t pcib, device_t dev, int *irq);
140 static int nexus_release_msix(device_t pcib, device_t dev, int irq);
141 static int nexus_map_msi(device_t pcib, device_t dev, int irq, uint64_t *addr, uint32_t *data);
144 static device_method_t nexus_methods[] = {
145 /* Device interface */
146 DEVMETHOD(device_probe, nexus_probe),
147 DEVMETHOD(device_attach, nexus_attach),
148 DEVMETHOD(device_detach, bus_generic_detach),
149 DEVMETHOD(device_shutdown, bus_generic_shutdown),
150 DEVMETHOD(device_suspend, bus_generic_suspend),
151 DEVMETHOD(device_resume, bus_generic_resume),
154 DEVMETHOD(bus_print_child, nexus_print_child),
155 DEVMETHOD(bus_add_child, nexus_add_child),
156 DEVMETHOD(bus_alloc_resource, nexus_alloc_resource),
157 DEVMETHOD(bus_release_resource, nexus_release_resource),
158 DEVMETHOD(bus_activate_resource, nexus_activate_resource),
159 DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource),
160 DEVMETHOD(bus_setup_intr, nexus_setup_intr),
161 DEVMETHOD(bus_teardown_intr, nexus_teardown_intr),
163 DEVMETHOD(bus_bind_intr, nexus_bind_intr),
165 DEVMETHOD(bus_config_intr, nexus_config_intr),
166 DEVMETHOD(bus_describe_intr, nexus_describe_intr),
167 DEVMETHOD(bus_get_resource_list, nexus_get_reslist),
168 DEVMETHOD(bus_set_resource, nexus_set_resource),
169 DEVMETHOD(bus_get_resource, nexus_get_resource),
170 DEVMETHOD(bus_delete_resource, nexus_delete_resource),
174 DEVMETHOD(pcib_alloc_msi, nexus_alloc_msi),
175 DEVMETHOD(pcib_release_msi, nexus_release_msi),
176 DEVMETHOD(pcib_alloc_msix, nexus_alloc_msix),
177 DEVMETHOD(pcib_release_msix, nexus_release_msix),
178 DEVMETHOD(pcib_map_msi, nexus_map_msi),
184 DEFINE_CLASS_0(nexus, nexus_driver, nexus_methods, 1);
185 static devclass_t nexus_devclass;
187 DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0);
190 nexus_probe(device_t dev)
193 device_quiet(dev); /* suppress attach message for neatness */
194 return (BUS_PROBE_GENERIC);
198 nexus_init_resources(void)
205 * - IRQ resource creation should be moved to the PIC/APIC driver.
206 * - DRQ resource creation should be moved to the DMAC driver.
207 * - The above should be sorted to probe earlier than any child busses.
209 * - Leave I/O and memory creation here, as child probes may need them.
210 * (especially eg. ACPI)
214 * IRQ's are on the mainboard on old systems, but on the ISA part
215 * of PCI->ISA bridges. There would be multiple sets of IRQs on
216 * multi-ISA-bus systems. PCI interrupts are routed to the ISA
217 * component, so in a way, PCI can be a partial child of an ISA bus(!).
218 * APIC interrupts are global though.
220 irq_rman.rm_start = 0;
221 irq_rman.rm_type = RMAN_ARRAY;
222 irq_rman.rm_descr = "Interrupt request lines";
223 irq_rman.rm_end = NUM_IO_INTS - 1;
224 if (rman_init(&irq_rman))
225 panic("nexus_init_resources irq_rman");
228 * We search for regions of existing IRQs and add those to the IRQ
231 for (irq = 0; irq < NUM_IO_INTS; irq++)
232 if (intr_lookup_source(irq) != NULL)
233 if (rman_manage_region(&irq_rman, irq, irq) != 0)
234 panic("nexus_init_resources irq_rman add");
237 * ISA DMA on PCI systems is implemented in the ISA part of each
238 * PCI->ISA bridge and the channels can be duplicated if there are
239 * multiple bridges. (eg: laptops with docking stations)
241 drq_rman.rm_start = 0;
247 drq_rman.rm_type = RMAN_ARRAY;
248 drq_rman.rm_descr = "DMA request lines";
249 /* XXX drq 0 not available on some machines */
250 if (rman_init(&drq_rman)
251 || rman_manage_region(&drq_rman,
252 drq_rman.rm_start, drq_rman.rm_end))
253 panic("nexus_init_resources drq_rman");
256 * However, IO ports and Memory truely are global at this level,
257 * as are APIC interrupts (however many IO APICS there turn out
258 * to be on large systems..)
260 port_rman.rm_start = 0;
261 port_rman.rm_end = 0xffff;
262 port_rman.rm_type = RMAN_ARRAY;
263 port_rman.rm_descr = "I/O ports";
264 if (rman_init(&port_rman)
265 || rman_manage_region(&port_rman, 0, 0xffff))
266 panic("nexus_init_resources port_rman");
268 mem_rman.rm_start = 0;
269 mem_rman.rm_end = ~0u;
270 mem_rman.rm_type = RMAN_ARRAY;
271 mem_rman.rm_descr = "I/O memory addresses";
272 if (rman_init(&mem_rman)
273 || rman_manage_region(&mem_rman, 0, ~0))
274 panic("nexus_init_resources mem_rman");
278 nexus_attach(device_t dev)
281 nexus_init_resources();
282 bus_generic_probe(dev);
285 * Explicitly add the legacy0 device here. Other platform
286 * types (such as ACPI), use their own nexus(4) subclass
287 * driver to override this routine and add their own root bus.
289 if (BUS_ADD_CHILD(dev, 10, "legacy", 0) == NULL)
290 panic("legacy: could not attach");
291 bus_generic_attach(dev);
296 nexus_print_all_resources(device_t dev)
298 struct nexus_device *ndev = DEVTONX(dev);
299 struct resource_list *rl = &ndev->nx_resources;
302 if (STAILQ_FIRST(rl))
303 retval += printf(" at");
305 retval += resource_list_print_type(rl, "port", SYS_RES_IOPORT, "%#lx");
306 retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#lx");
307 retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
313 nexus_print_child(device_t bus, device_t child)
317 retval += bus_print_child_header(bus, child);
318 retval += nexus_print_all_resources(child);
319 if (device_get_flags(child))
320 retval += printf(" flags %#x", device_get_flags(child));
321 retval += printf(" on motherboard\n"); /* XXX "motherboard", ick */
327 nexus_add_child(device_t bus, u_int order, const char *name, int unit)
330 struct nexus_device *ndev;
332 ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_NOWAIT|M_ZERO);
335 resource_list_init(&ndev->nx_resources);
337 child = device_add_child_ordered(bus, order, name, unit);
339 /* should we free this in nexus_child_detached? */
340 device_set_ivars(child, ndev);
346 * Allocate a resource on behalf of child. NB: child is usually going to be a
347 * child of one of our descendants, not a direct child of nexus0.
348 * (Exceptions include npx.)
350 static struct resource *
351 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
352 u_long start, u_long end, u_long count, u_int flags)
354 struct nexus_device *ndev = DEVTONX(child);
356 struct resource_list_entry *rle;
358 int needactivate = flags & RF_ACTIVE;
361 * If this is an allocation of the "default" range for a given RID, and
362 * we know what the resources for this device are (ie. they aren't maintained
363 * by a child bus), then work out the start/end values.
365 if ((start == 0UL) && (end == ~0UL) && (count == 1)) {
368 rle = resource_list_find(&ndev->nx_resources, type, *rid);
399 rv = rman_reserve_resource(rm, start, end, count, flags, child);
402 rman_set_rid(rv, *rid);
405 if (bus_activate_resource(child, type, *rid, rv)) {
406 rman_release_resource(rv);
415 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
419 bus_space_handle_t bh;
425 * If this is a memory resource, map it into the kernel.
430 error = i386_bus_space_handle_alloc(I386_BUS_SPACE_IO,
431 rman_get_start(r), rman_get_size(r), &bh);
434 rman_set_bushandle(r, bh);
436 rman_set_bushandle(r, rman_get_start(r));
438 rman_set_bustag(r, BUS_SPACE_IO);
442 error = i386_bus_space_handle_alloc(I386_BUS_SPACE_MEM,
443 rman_get_start(r), rman_get_size(r), &bh);
447 vaddr = pmap_mapdev(rman_get_start(r), rman_get_size(r));
448 rman_set_virtual(r, vaddr);
449 rman_set_bustag(r, BUS_SPACE_MEM);
451 /* PC-98: the type of bus_space_handle_t is the structure. */
452 bh->bsh_base = (bus_addr_t) vaddr;
453 rman_set_bushandle(r, bh);
455 /* IBM-PC: the type of bus_space_handle_t is u_int */
456 rman_set_bushandle(r, (bus_space_handle_t) vaddr);
459 return (rman_activate_resource(r));
463 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
468 * If this is a memory resource, unmap it.
470 if (type == SYS_RES_MEMORY) {
471 pmap_unmapdev((vm_offset_t)rman_get_virtual(r),
475 if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
476 bus_space_handle_t bh;
478 bh = rman_get_bushandle(r);
479 i386_bus_space_handle_free(rman_get_bustag(r), bh, bh->bsh_sz);
482 return (rman_deactivate_resource(r));
486 nexus_release_resource(device_t bus, device_t child, int type, int rid,
489 if (rman_get_flags(r) & RF_ACTIVE) {
490 int error = bus_deactivate_resource(child, type, rid, r);
494 return (rman_release_resource(r));
498 * Currently this uses the really grody interface from kern/kern_intr.c
499 * (which really doesn't belong in kern/anything.c). Eventually, all of
500 * the code in kern_intr.c and machdep_intr.c should get moved here, since
501 * this is going to be the official interface.
504 nexus_setup_intr(device_t bus, device_t child, struct resource *irq,
505 int flags, driver_filter_t filter, void (*ihand)(void *),
506 void *arg, void **cookiep)
510 /* somebody tried to setup an irq that failed to allocate! */
512 panic("nexus_setup_intr: NULL irq resource!");
515 if ((rman_get_flags(irq) & RF_SHAREABLE) == 0)
519 * We depend here on rman_activate_resource() being idempotent.
521 error = rman_activate_resource(irq);
525 error = intr_add_handler(device_get_nameunit(child),
526 rman_get_start(irq), filter, ihand, arg, flags, cookiep);
532 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
534 return (intr_remove_handler(ih));
539 nexus_bind_intr(device_t dev, device_t child, struct resource *irq, int cpu)
541 return (intr_bind(rman_get_start(irq), cpu));
546 nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
547 enum intr_polarity pol)
549 return (intr_config_intr(irq, trig, pol));
553 nexus_describe_intr(device_t dev, device_t child, struct resource *irq,
554 void *cookie, const char *descr)
557 return (intr_describe(rman_get_start(irq), cookie, descr));
560 static struct resource_list *
561 nexus_get_reslist(device_t dev, device_t child)
563 struct nexus_device *ndev = DEVTONX(child);
565 return (&ndev->nx_resources);
569 nexus_set_resource(device_t dev, device_t child, int type, int rid, u_long start, u_long count)
571 struct nexus_device *ndev = DEVTONX(child);
572 struct resource_list *rl = &ndev->nx_resources;
574 /* XXX this should return a success/failure indicator */
575 resource_list_add(rl, type, rid, start, start + count - 1, count);
580 nexus_get_resource(device_t dev, device_t child, int type, int rid, u_long *startp, u_long *countp)
582 struct nexus_device *ndev = DEVTONX(child);
583 struct resource_list *rl = &ndev->nx_resources;
584 struct resource_list_entry *rle;
586 rle = resource_list_find(rl, type, rid);
590 *startp = rle->start;
592 *countp = rle->count;
597 nexus_delete_resource(device_t dev, device_t child, int type, int rid)
599 struct nexus_device *ndev = DEVTONX(child);
600 struct resource_list *rl = &ndev->nx_resources;
602 resource_list_delete(rl, type, rid);
605 /* Called from the MSI code to add new IRQs to the IRQ rman. */
607 nexus_add_irq(u_long irq)
610 if (rman_manage_region(&irq_rman, irq, irq) != 0)
611 panic("%s: failed", __func__);
616 nexus_alloc_msix(device_t pcib, device_t dev, int *irq)
619 return (msix_alloc(dev, irq));
623 nexus_release_msix(device_t pcib, device_t dev, int irq)
626 return (msix_release(irq));
630 nexus_alloc_msi(device_t pcib, device_t dev, int count, int maxcount, int *irqs)
633 return (msi_alloc(dev, count, maxcount, irqs));
637 nexus_release_msi(device_t pcib, device_t dev, int count, int *irqs)
640 return (msi_release(irqs, count));
644 nexus_map_msi(device_t pcib, device_t dev, int irq, uint64_t *addr, uint32_t *data)
647 return (msi_map(irq, addr, data));
651 /* Placeholder for system RAM. */
653 ram_identify(driver_t *driver, device_t parent)
656 if (resource_disabled("ram", 0))
658 if (BUS_ADD_CHILD(parent, 0, "ram", 0) == NULL)
659 panic("ram_identify");
663 ram_probe(device_t dev)
667 device_set_desc(dev, "System RAM");
672 ram_attach(device_t dev)
674 struct bios_smap *smapbase, *smap, *smapend;
675 struct resource *res;
681 /* Retrieve the system memory map from the loader. */
682 kmdp = preload_search_by_type("elf kernel");
684 kmdp = preload_search_by_type(ELF_KERN_STR);
686 smapbase = (struct bios_smap *)preload_search_info(kmdp,
687 MODINFO_METADATA | MODINFOMD_SMAP);
690 if (smapbase != NULL) {
691 smapsize = *((u_int32_t *)smapbase - 1);
692 smapend = (struct bios_smap *)((uintptr_t)smapbase + smapsize);
695 for (smap = smapbase; smap < smapend; smap++) {
696 if (smap->type != SMAP_TYPE_MEMORY ||
701 * Resources use long's to track resources, so
702 * we can't include memory regions above 4GB.
704 if (smap->base > ~0ul)
707 error = bus_set_resource(dev, SYS_RES_MEMORY, rid,
708 smap->base, smap->length);
711 "ram_attach: resource %d failed set with %d",
713 res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
716 panic("ram_attach: resource %d failed to attach",
724 * If the system map is not available, fall back to using
725 * dump_avail[]. We use the dump_avail[] array rather than
726 * phys_avail[] for the memory map as phys_avail[] contains
727 * holes for kernel memory, page 0, the message buffer, and
728 * the dcons buffer. We test the end address in the loop
729 * instead of the start since the start address for the first
732 for (rid = 0, p = dump_avail; p[1] != 0; rid++, p += 2) {
735 * Resources use long's to track resources, so we can't
736 * include memory regions above 4GB.
741 error = bus_set_resource(dev, SYS_RES_MEMORY, rid, p[0],
744 panic("ram_attach: resource %d failed set with %d", rid,
746 res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, 0);
748 panic("ram_attach: resource %d failed to attach", rid);
753 static device_method_t ram_methods[] = {
754 /* Device interface */
755 DEVMETHOD(device_identify, ram_identify),
756 DEVMETHOD(device_probe, ram_probe),
757 DEVMETHOD(device_attach, ram_attach),
761 static driver_t ram_driver = {
767 static devclass_t ram_devclass;
769 DRIVER_MODULE(ram, nexus, ram_driver, ram_devclass, 0, 0);
773 * Placeholder which claims PnP 'devices' which describe system
776 static struct isa_pnp_id sysresource_ids[] = {
777 { 0x010cd041 /* PNP0c01 */, "System Memory" },
778 { 0x020cd041 /* PNP0c02 */, "System Resource" },
783 sysresource_probe(device_t dev)
787 if ((result = ISA_PNP_PROBE(device_get_parent(dev), dev, sysresource_ids)) <= 0) {
794 sysresource_attach(device_t dev)
799 static device_method_t sysresource_methods[] = {
800 /* Device interface */
801 DEVMETHOD(device_probe, sysresource_probe),
802 DEVMETHOD(device_attach, sysresource_attach),
803 DEVMETHOD(device_detach, bus_generic_detach),
804 DEVMETHOD(device_shutdown, bus_generic_shutdown),
805 DEVMETHOD(device_suspend, bus_generic_suspend),
806 DEVMETHOD(device_resume, bus_generic_resume),
810 static driver_t sysresource_driver = {
816 static devclass_t sysresource_devclass;
818 DRIVER_MODULE(sysresource, isa, sysresource_driver, sysresource_devclass, 0, 0);