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/resource.h>
70 #include <isa/isavar.h>
72 #include <pc98/cbus/cbus.h>
74 #include <i386/isa/isa.h>
77 #include <sys/rtprio.h>
79 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
81 struct resource_list nx_resources;
84 #define DEVTONX(dev) ((struct nexus_device *)device_get_ivars(dev))
86 static struct rman irq_rman, drq_rman, port_rman, mem_rman;
88 static int nexus_probe(device_t);
89 static int nexus_attach(device_t);
90 static int nexus_print_all_resources(device_t dev);
91 static int nexus_print_child(device_t, device_t);
92 static device_t nexus_add_child(device_t bus, int order, const char *name,
94 static struct resource *nexus_alloc_resource(device_t, device_t, int, int *,
95 u_long, u_long, u_long, u_int);
96 static int nexus_config_intr(device_t, int, enum intr_trigger,
98 static int nexus_activate_resource(device_t, device_t, int, int,
100 static int nexus_deactivate_resource(device_t, device_t, int, int,
102 static int nexus_release_resource(device_t, device_t, int, int,
104 static int nexus_setup_intr(device_t, device_t, struct resource *, int flags,
105 driver_filter_t filter, void (*)(void *), void *,
107 static int nexus_teardown_intr(device_t, device_t, struct resource *,
109 static struct resource_list *nexus_get_reslist(device_t dev, device_t child);
110 static int nexus_set_resource(device_t, device_t, int, int, u_long, u_long);
111 static int nexus_get_resource(device_t, device_t, int, int, u_long *, u_long *);
112 static void nexus_delete_resource(device_t, device_t, int, int);
114 static int nexus_alloc_msi(device_t pcib, device_t dev, int count, int maxcount, int *irqs);
115 static int nexus_release_msi(device_t pcib, device_t dev, int count, int *irqs);
116 static int nexus_alloc_msix(device_t pcib, device_t dev, int *irq);
117 static int nexus_release_msix(device_t pcib, device_t dev, int irq);
118 static int nexus_map_msi(device_t pcib, device_t dev, int irq, uint64_t *addr, uint32_t *data);
121 static device_method_t nexus_methods[] = {
122 /* Device interface */
123 DEVMETHOD(device_probe, nexus_probe),
124 DEVMETHOD(device_attach, nexus_attach),
125 DEVMETHOD(device_detach, bus_generic_detach),
126 DEVMETHOD(device_shutdown, bus_generic_shutdown),
127 DEVMETHOD(device_suspend, bus_generic_suspend),
128 DEVMETHOD(device_resume, bus_generic_resume),
131 DEVMETHOD(bus_print_child, nexus_print_child),
132 DEVMETHOD(bus_add_child, nexus_add_child),
133 DEVMETHOD(bus_alloc_resource, nexus_alloc_resource),
134 DEVMETHOD(bus_release_resource, nexus_release_resource),
135 DEVMETHOD(bus_activate_resource, nexus_activate_resource),
136 DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource),
137 DEVMETHOD(bus_setup_intr, nexus_setup_intr),
138 DEVMETHOD(bus_teardown_intr, nexus_teardown_intr),
139 DEVMETHOD(bus_config_intr, nexus_config_intr),
140 DEVMETHOD(bus_get_resource_list, nexus_get_reslist),
141 DEVMETHOD(bus_set_resource, nexus_set_resource),
142 DEVMETHOD(bus_get_resource, nexus_get_resource),
143 DEVMETHOD(bus_delete_resource, nexus_delete_resource),
147 DEVMETHOD(pcib_alloc_msi, nexus_alloc_msi),
148 DEVMETHOD(pcib_release_msi, nexus_release_msi),
149 DEVMETHOD(pcib_alloc_msix, nexus_alloc_msix),
150 DEVMETHOD(pcib_release_msix, nexus_release_msix),
151 DEVMETHOD(pcib_map_msi, nexus_map_msi),
157 static driver_t nexus_driver = {
162 static devclass_t nexus_devclass;
164 DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0);
167 nexus_probe(device_t dev)
171 device_quiet(dev); /* suppress attach message for neatness */
176 * - IRQ resource creation should be moved to the PIC/APIC driver.
177 * - DRQ resource creation should be moved to the DMAC driver.
178 * - The above should be sorted to probe earlier than any child busses.
180 * - Leave I/O and memory creation here, as child probes may need them.
181 * (especially eg. ACPI)
185 * IRQ's are on the mainboard on old systems, but on the ISA part
186 * of PCI->ISA bridges. There would be multiple sets of IRQs on
187 * multi-ISA-bus systems. PCI interrupts are routed to the ISA
188 * component, so in a way, PCI can be a partial child of an ISA bus(!).
189 * APIC interrupts are global though.
191 irq_rman.rm_start = 0;
192 irq_rman.rm_type = RMAN_ARRAY;
193 irq_rman.rm_descr = "Interrupt request lines";
194 irq_rman.rm_end = NUM_IO_INTS - 1;
195 if (rman_init(&irq_rman))
196 panic("nexus_probe irq_rman");
199 * We search for regions of existing IRQs and add those to the IRQ
202 for (irq = 0; irq < NUM_IO_INTS; irq++)
203 if (intr_lookup_source(irq) != NULL)
204 if (rman_manage_region(&irq_rman, irq, irq) != 0)
205 panic("nexus_probe irq_rman add");
208 * ISA DMA on PCI systems is implemented in the ISA part of each
209 * PCI->ISA bridge and the channels can be duplicated if there are
210 * multiple bridges. (eg: laptops with docking stations)
212 drq_rman.rm_start = 0;
218 drq_rman.rm_type = RMAN_ARRAY;
219 drq_rman.rm_descr = "DMA request lines";
220 /* XXX drq 0 not available on some machines */
221 if (rman_init(&drq_rman)
222 || rman_manage_region(&drq_rman,
223 drq_rman.rm_start, drq_rman.rm_end))
224 panic("nexus_probe drq_rman");
227 * However, IO ports and Memory truely are global at this level,
228 * as are APIC interrupts (however many IO APICS there turn out
229 * to be on large systems..)
231 port_rman.rm_start = 0;
232 port_rman.rm_end = 0xffff;
233 port_rman.rm_type = RMAN_ARRAY;
234 port_rman.rm_descr = "I/O ports";
235 if (rman_init(&port_rman)
236 || rman_manage_region(&port_rman, 0, 0xffff))
237 panic("nexus_probe port_rman");
239 mem_rman.rm_start = 0;
240 mem_rman.rm_end = ~0u;
241 mem_rman.rm_type = RMAN_ARRAY;
242 mem_rman.rm_descr = "I/O memory addresses";
243 if (rman_init(&mem_rman)
244 || rman_manage_region(&mem_rman, 0, ~0))
245 panic("nexus_probe mem_rman");
251 nexus_attach(device_t dev)
254 bus_generic_probe(dev);
255 bus_generic_attach(dev);
260 nexus_print_all_resources(device_t dev)
262 struct nexus_device *ndev = DEVTONX(dev);
263 struct resource_list *rl = &ndev->nx_resources;
266 if (STAILQ_FIRST(rl))
267 retval += printf(" at");
269 retval += resource_list_print_type(rl, "port", SYS_RES_IOPORT, "%#lx");
270 retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#lx");
271 retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
277 nexus_print_child(device_t bus, device_t child)
281 retval += bus_print_child_header(bus, child);
282 retval += nexus_print_all_resources(child);
283 if (device_get_flags(child))
284 retval += printf(" flags %#x", device_get_flags(child));
285 retval += printf(" on motherboard\n"); /* XXX "motherboard", ick */
291 nexus_add_child(device_t bus, int order, const char *name, int unit)
294 struct nexus_device *ndev;
296 ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_NOWAIT|M_ZERO);
299 resource_list_init(&ndev->nx_resources);
301 child = device_add_child_ordered(bus, order, name, unit);
303 /* should we free this in nexus_child_detached? */
304 device_set_ivars(child, ndev);
310 * Allocate a resource on behalf of child. NB: child is usually going to be a
311 * child of one of our descendants, not a direct child of nexus0.
312 * (Exceptions include npx.)
314 static struct resource *
315 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
316 u_long start, u_long end, u_long count, u_int flags)
318 struct nexus_device *ndev = DEVTONX(child);
320 struct resource_list_entry *rle;
322 int needactivate = flags & RF_ACTIVE;
325 * If this is an allocation of the "default" range for a given RID, and
326 * we know what the resources for this device are (ie. they aren't maintained
327 * by a child bus), then work out the start/end values.
329 if ((start == 0UL) && (end == ~0UL) && (count == 1)) {
332 rle = resource_list_find(&ndev->nx_resources, type, *rid);
363 rv = rman_reserve_resource(rm, start, end, count, flags, child);
366 rman_set_rid(rv, *rid);
369 if (bus_activate_resource(child, type, *rid, rv)) {
370 rman_release_resource(rv);
379 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
383 bus_space_handle_t bh;
389 * If this is a memory resource, map it into the kernel.
394 error = i386_bus_space_handle_alloc(I386_BUS_SPACE_IO,
395 rman_get_start(r), rman_get_size(r), &bh);
398 rman_set_bushandle(r, bh);
400 rman_set_bushandle(r, rman_get_start(r));
402 rman_set_bustag(r, I386_BUS_SPACE_IO);
406 error = i386_bus_space_handle_alloc(I386_BUS_SPACE_MEM,
407 rman_get_start(r), rman_get_size(r), &bh);
411 vaddr = pmap_mapdev(rman_get_start(r), rman_get_size(r));
412 rman_set_virtual(r, vaddr);
413 rman_set_bustag(r, I386_BUS_SPACE_MEM);
415 /* PC-98: the type of bus_space_handle_t is the structure. */
416 bh->bsh_base = (bus_addr_t) vaddr;
417 rman_set_bushandle(r, bh);
419 /* IBM-PC: the type of bus_space_handle_t is u_int */
420 rman_set_bushandle(r, (bus_space_handle_t) vaddr);
423 return (rman_activate_resource(r));
427 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
432 * If this is a memory resource, unmap it.
434 if (type == SYS_RES_MEMORY) {
435 pmap_unmapdev((vm_offset_t)rman_get_virtual(r),
439 if (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT) {
440 bus_space_handle_t bh;
442 bh = rman_get_bushandle(r);
443 i386_bus_space_handle_free(rman_get_bustag(r), bh, bh->bsh_sz);
446 return (rman_deactivate_resource(r));
450 nexus_release_resource(device_t bus, device_t child, int type, int rid,
453 if (rman_get_flags(r) & RF_ACTIVE) {
454 int error = bus_deactivate_resource(child, type, rid, r);
458 return (rman_release_resource(r));
462 * Currently this uses the really grody interface from kern/kern_intr.c
463 * (which really doesn't belong in kern/anything.c). Eventually, all of
464 * the code in kern_intr.c and machdep_intr.c should get moved here, since
465 * this is going to be the official interface.
468 nexus_setup_intr(device_t bus, device_t child, struct resource *irq,
469 int flags, driver_filter_t filter, void (*ihand)(void *),
470 void *arg, void **cookiep)
474 /* somebody tried to setup an irq that failed to allocate! */
476 panic("nexus_setup_intr: NULL irq resource!");
479 if ((rman_get_flags(irq) & RF_SHAREABLE) == 0)
483 * We depend here on rman_activate_resource() being idempotent.
485 error = rman_activate_resource(irq);
489 error = intr_add_handler(device_get_nameunit(child),
490 rman_get_start(irq), filter, ihand, arg, flags, cookiep);
496 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
498 return (intr_remove_handler(ih));
502 nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
503 enum intr_polarity pol)
505 return (intr_config_intr(irq, trig, pol));
508 static struct resource_list *
509 nexus_get_reslist(device_t dev, device_t child)
511 struct nexus_device *ndev = DEVTONX(child);
513 return (&ndev->nx_resources);
517 nexus_set_resource(device_t dev, device_t child, int type, int rid, u_long start, u_long count)
519 struct nexus_device *ndev = DEVTONX(child);
520 struct resource_list *rl = &ndev->nx_resources;
522 /* XXX this should return a success/failure indicator */
523 resource_list_add(rl, type, rid, start, start + count - 1, count);
528 nexus_get_resource(device_t dev, device_t child, int type, int rid, u_long *startp, u_long *countp)
530 struct nexus_device *ndev = DEVTONX(child);
531 struct resource_list *rl = &ndev->nx_resources;
532 struct resource_list_entry *rle;
534 rle = resource_list_find(rl, type, rid);
538 *startp = rle->start;
540 *countp = rle->count;
545 nexus_delete_resource(device_t dev, device_t child, int type, int rid)
547 struct nexus_device *ndev = DEVTONX(child);
548 struct resource_list *rl = &ndev->nx_resources;
550 resource_list_delete(rl, type, rid);
553 /* Called from the MSI code to add new IRQs to the IRQ rman. */
555 nexus_add_irq(u_long irq)
558 if (rman_manage_region(&irq_rman, irq, irq) != 0)
559 panic("%s: failed", __func__);
564 nexus_alloc_msix(device_t pcib, device_t dev, int *irq)
567 return (msix_alloc(dev, irq));
571 nexus_release_msix(device_t pcib, device_t dev, int irq)
574 return (msix_release(irq));
578 nexus_alloc_msi(device_t pcib, device_t dev, int count, int maxcount, int *irqs)
581 return (msi_alloc(dev, count, maxcount, irqs));
585 nexus_release_msi(device_t pcib, device_t dev, int count, int *irqs)
588 return (msi_release(irqs, count));
592 nexus_map_msi(device_t pcib, device_t dev, int irq, uint64_t *addr, uint32_t *data)
595 return (msi_map(irq, addr, data));
599 /* Placeholder for system RAM. */
601 ram_identify(driver_t *driver, device_t parent)
604 if (resource_disabled("ram", 0))
606 if (BUS_ADD_CHILD(parent, 0, "ram", 0) == NULL)
607 panic("ram_identify");
611 ram_probe(device_t dev)
615 device_set_desc(dev, "System RAM");
620 ram_attach(device_t dev)
622 struct resource *res;
627 * We use the dump_avail[] array rather than phys_avail[] for
628 * the memory map as phys_avail[] contains holes for kernel
629 * memory, page 0, the message buffer, and the dcons buffer.
630 * We test the end address in the loop instead of the start
631 * since the start address for the first segment is 0.
633 * XXX: It would be preferable to use the SMAP if it exists
634 * instead since if the SMAP is very fragmented we may not
635 * include some memory regions in dump_avail[] and phys_avail[].
637 for (i = 0, p = dump_avail; p[1] != 0; i++, p += 2) {
641 * Resources use long's to track resources, so we can't
642 * include memory regions above 4GB.
647 error = bus_set_resource(dev, SYS_RES_MEMORY, rid, p[0],
650 panic("ram_attach: resource %d failed set with %d", i,
652 res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, 0);
654 panic("ram_attach: resource %d failed to attach", i);
659 static device_method_t ram_methods[] = {
660 /* Device interface */
661 DEVMETHOD(device_identify, ram_identify),
662 DEVMETHOD(device_probe, ram_probe),
663 DEVMETHOD(device_attach, ram_attach),
667 static driver_t ram_driver = {
673 static devclass_t ram_devclass;
675 DRIVER_MODULE(ram, nexus, ram_driver, ram_devclass, 0, 0);
679 * Placeholder which claims PnP 'devices' which describe system
682 static struct isa_pnp_id sysresource_ids[] = {
683 { 0x010cd041 /* PNP0c01 */, "System Memory" },
684 { 0x020cd041 /* PNP0c02 */, "System Resource" },
689 sysresource_probe(device_t dev)
693 if ((result = ISA_PNP_PROBE(device_get_parent(dev), dev, sysresource_ids)) <= 0) {
700 sysresource_attach(device_t dev)
705 static device_method_t sysresource_methods[] = {
706 /* Device interface */
707 DEVMETHOD(device_probe, sysresource_probe),
708 DEVMETHOD(device_attach, sysresource_attach),
709 DEVMETHOD(device_detach, bus_generic_detach),
710 DEVMETHOD(device_shutdown, bus_generic_shutdown),
711 DEVMETHOD(device_suspend, bus_generic_suspend),
712 DEVMETHOD(device_resume, bus_generic_resume),
716 static driver_t sysresource_driver = {
722 static devclass_t sysresource_devclass;
724 DRIVER_MODULE(sysresource, isa, sysresource_driver, sysresource_devclass, 0, 0);