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>
67 #include <machine/metadata.h>
68 #include <machine/nexusvar.h>
69 #include <machine/resource.h>
70 #include <machine/pc/bios.h>
77 #include <isa/isavar.h>
78 #include <isa/isareg.h>
80 #include <sys/rtprio.h>
82 #define ELF_KERN_STR ("elf"__XSTRING(__ELF_WORD_SIZE)" kernel")
84 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
86 #define DEVTONX(dev) ((struct nexus_device *)device_get_ivars(dev))
88 struct rman irq_rman, drq_rman, port_rman, mem_rman;
90 static int nexus_probe(device_t);
91 static int nexus_attach(device_t);
92 static int nexus_print_all_resources(device_t dev);
93 static int nexus_print_child(device_t, device_t);
94 static device_t nexus_add_child(device_t bus, u_int order, const char *name,
96 static struct resource *nexus_alloc_resource(device_t, device_t, int, int *,
97 rman_res_t, rman_res_t, rman_res_t,
99 static int nexus_adjust_resource(device_t, device_t, int, struct resource *,
100 rman_res_t, rman_res_t);
102 static int nexus_bind_intr(device_t, device_t, struct resource *, int);
104 static int nexus_config_intr(device_t, int, enum intr_trigger,
106 static int nexus_describe_intr(device_t dev, device_t child,
107 struct resource *irq, void *cookie,
109 static int nexus_activate_resource(device_t, device_t, int, int,
111 static int nexus_deactivate_resource(device_t, device_t, int, int,
113 static int nexus_map_resource(device_t bus, device_t child, int type,
115 struct resource_map_request *argsp,
116 struct resource_map *map);
117 static int nexus_unmap_resource(device_t bus, device_t child, int type,
118 struct resource *r, struct resource_map *map);
119 static int nexus_release_resource(device_t, device_t, int, int,
121 static int nexus_setup_intr(device_t, device_t, struct resource *, int flags,
122 driver_filter_t filter, void (*)(void *), void *,
124 static int nexus_teardown_intr(device_t, device_t, struct resource *,
126 static struct resource_list *nexus_get_reslist(device_t dev, device_t child);
127 static int nexus_set_resource(device_t, device_t, int, int,
128 rman_res_t, rman_res_t);
129 static int nexus_get_resource(device_t, device_t, int, int,
130 rman_res_t *, rman_res_t *);
131 static void nexus_delete_resource(device_t, device_t, int, int);
132 static int nexus_get_cpus(device_t, device_t, enum cpu_sets, size_t,
135 static int nexus_alloc_msi(device_t pcib, device_t dev, int count, int maxcount, int *irqs);
136 static int nexus_release_msi(device_t pcib, device_t dev, int count, int *irqs);
137 static int nexus_alloc_msix(device_t pcib, device_t dev, int *irq);
138 static int nexus_release_msix(device_t pcib, device_t dev, int irq);
139 static int nexus_map_msi(device_t pcib, device_t dev, int irq, uint64_t *addr, uint32_t *data);
142 static device_method_t nexus_methods[] = {
143 /* Device interface */
144 DEVMETHOD(device_probe, nexus_probe),
145 DEVMETHOD(device_attach, nexus_attach),
146 DEVMETHOD(device_detach, bus_generic_detach),
147 DEVMETHOD(device_shutdown, bus_generic_shutdown),
148 DEVMETHOD(device_suspend, bus_generic_suspend),
149 DEVMETHOD(device_resume, bus_generic_resume),
152 DEVMETHOD(bus_print_child, nexus_print_child),
153 DEVMETHOD(bus_add_child, nexus_add_child),
154 DEVMETHOD(bus_alloc_resource, nexus_alloc_resource),
155 DEVMETHOD(bus_adjust_resource, nexus_adjust_resource),
156 DEVMETHOD(bus_release_resource, nexus_release_resource),
157 DEVMETHOD(bus_activate_resource, nexus_activate_resource),
158 DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource),
159 DEVMETHOD(bus_map_resource, nexus_map_resource),
160 DEVMETHOD(bus_unmap_resource, nexus_unmap_resource),
161 DEVMETHOD(bus_setup_intr, nexus_setup_intr),
162 DEVMETHOD(bus_teardown_intr, nexus_teardown_intr),
164 DEVMETHOD(bus_bind_intr, nexus_bind_intr),
166 DEVMETHOD(bus_config_intr, nexus_config_intr),
167 DEVMETHOD(bus_describe_intr, nexus_describe_intr),
168 DEVMETHOD(bus_get_resource_list, nexus_get_reslist),
169 DEVMETHOD(bus_set_resource, nexus_set_resource),
170 DEVMETHOD(bus_get_resource, nexus_get_resource),
171 DEVMETHOD(bus_delete_resource, nexus_delete_resource),
172 DEVMETHOD(bus_get_cpus, nexus_get_cpus),
176 DEVMETHOD(pcib_alloc_msi, nexus_alloc_msi),
177 DEVMETHOD(pcib_release_msi, nexus_release_msi),
178 DEVMETHOD(pcib_alloc_msix, nexus_alloc_msix),
179 DEVMETHOD(pcib_release_msix, nexus_release_msix),
180 DEVMETHOD(pcib_map_msi, nexus_map_msi),
186 DEFINE_CLASS_0(nexus, nexus_driver, nexus_methods, 1);
187 static devclass_t nexus_devclass;
189 DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0);
192 nexus_probe(device_t dev)
195 device_quiet(dev); /* suppress attach message for neatness */
196 return (BUS_PROBE_GENERIC);
200 nexus_init_resources(void)
207 * - IRQ resource creation should be moved to the PIC/APIC driver.
208 * - DRQ resource creation should be moved to the DMAC driver.
209 * - The above should be sorted to probe earlier than any child buses.
211 * - Leave I/O and memory creation here, as child probes may need them.
212 * (especially eg. ACPI)
216 * IRQ's are on the mainboard on old systems, but on the ISA part
217 * of PCI->ISA bridges. There would be multiple sets of IRQs on
218 * multi-ISA-bus systems. PCI interrupts are routed to the ISA
219 * component, so in a way, PCI can be a partial child of an ISA bus(!).
220 * APIC interrupts are global though.
222 irq_rman.rm_start = 0;
223 irq_rman.rm_type = RMAN_ARRAY;
224 irq_rman.rm_descr = "Interrupt request lines";
225 irq_rman.rm_end = NUM_IO_INTS - 1;
226 if (rman_init(&irq_rman))
227 panic("nexus_init_resources irq_rman");
230 * We search for regions of existing IRQs and add those to the IRQ
233 for (irq = 0; irq < NUM_IO_INTS; irq++)
234 if (intr_lookup_source(irq) != NULL)
235 if (rman_manage_region(&irq_rman, irq, irq) != 0)
236 panic("nexus_init_resources irq_rman add");
239 * ISA DMA on PCI systems is implemented in the ISA part of each
240 * PCI->ISA bridge and the channels can be duplicated if there are
241 * multiple bridges. (eg: laptops with docking stations)
243 drq_rman.rm_start = 0;
245 drq_rman.rm_type = RMAN_ARRAY;
246 drq_rman.rm_descr = "DMA request lines";
247 /* XXX drq 0 not available on some machines */
248 if (rman_init(&drq_rman)
249 || rman_manage_region(&drq_rman,
250 drq_rman.rm_start, drq_rman.rm_end))
251 panic("nexus_init_resources drq_rman");
254 * However, IO ports and Memory truely are global at this level,
255 * as are APIC interrupts (however many IO APICS there turn out
256 * to be on large systems..)
258 port_rman.rm_start = 0;
259 port_rman.rm_end = 0xffff;
260 port_rman.rm_type = RMAN_ARRAY;
261 port_rman.rm_descr = "I/O ports";
262 if (rman_init(&port_rman)
263 || rman_manage_region(&port_rman, 0, 0xffff))
264 panic("nexus_init_resources port_rman");
266 mem_rman.rm_start = 0;
268 mem_rman.rm_end = BUS_SPACE_MAXADDR;
270 mem_rman.rm_end = ((1ULL << cpu_maxphyaddr) - 1);
272 mem_rman.rm_type = RMAN_ARRAY;
273 mem_rman.rm_descr = "I/O memory addresses";
274 if (rman_init(&mem_rman)
275 || rman_manage_region(&mem_rman, 0, mem_rman.rm_end))
276 panic("nexus_init_resources mem_rman");
280 nexus_attach(device_t dev)
283 nexus_init_resources();
284 bus_generic_probe(dev);
287 * Explicitly add the legacy0 device here. Other platform
288 * types (such as ACPI), use their own nexus(4) subclass
289 * driver to override this routine and add their own root bus.
291 if (BUS_ADD_CHILD(dev, 10, "legacy", 0) == NULL)
292 panic("legacy: could not attach");
293 bus_generic_attach(dev);
298 nexus_print_all_resources(device_t dev)
300 struct nexus_device *ndev = DEVTONX(dev);
301 struct resource_list *rl = &ndev->nx_resources;
304 if (STAILQ_FIRST(rl))
305 retval += printf(" at");
307 retval += resource_list_print_type(rl, "port", SYS_RES_IOPORT, "%#jx");
308 retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#jx");
309 retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%jd");
315 nexus_print_child(device_t bus, device_t child)
319 retval += bus_print_child_header(bus, child);
320 retval += nexus_print_all_resources(child);
321 if (device_get_flags(child))
322 retval += printf(" flags %#x", device_get_flags(child));
323 retval += printf(" on motherboard\n"); /* XXX "motherboard", ick */
329 nexus_add_child(device_t bus, u_int order, const char *name, int unit)
332 struct nexus_device *ndev;
334 ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_NOWAIT|M_ZERO);
337 resource_list_init(&ndev->nx_resources);
339 child = device_add_child_ordered(bus, order, name, unit);
341 /* should we free this in nexus_child_detached? */
342 device_set_ivars(child, ndev);
365 * Allocate a resource on behalf of child. NB: child is usually going to be a
366 * child of one of our descendants, not a direct child of nexus0.
367 * (Exceptions include npx.)
369 static struct resource *
370 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
371 rman_res_t start, rman_res_t end, rman_res_t count,
374 struct nexus_device *ndev = DEVTONX(child);
376 struct resource_list_entry *rle;
378 int needactivate = flags & RF_ACTIVE;
381 * If this is an allocation of the "default" range for a given
382 * RID, and we know what the resources for this device are
383 * (ie. they aren't maintained by a child bus), then work out
384 * the start/end values.
386 if (RMAN_IS_DEFAULT_RANGE(start, end) && (count == 1)) {
387 if (device_get_parent(child) != bus || ndev == NULL)
389 rle = resource_list_find(&ndev->nx_resources, type, *rid);
398 rm = nexus_rman(type);
402 rv = rman_reserve_resource(rm, start, end, count, flags, child);
405 rman_set_rid(rv, *rid);
408 if (bus_activate_resource(child, type, *rid, rv)) {
409 rman_release_resource(rv);
418 nexus_adjust_resource(device_t bus, device_t child, int type,
419 struct resource *r, rman_res_t start, rman_res_t end)
423 rm = nexus_rman(type);
426 if (!rman_is_region_manager(r, rm))
428 return (rman_adjust_resource(r, start, end));
432 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
435 struct resource_map map;
438 error = rman_activate_resource(r);
442 if (!(rman_get_flags(r) & RF_UNMAPPED) &&
443 (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT)) {
444 error = nexus_map_resource(bus, child, type, r, NULL, &map);
446 rman_deactivate_resource(r);
450 rman_set_mapping(r,&map);
456 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
459 struct resource_map map;
462 error = rman_deactivate_resource(r);
466 if (!(rman_get_flags(r) & RF_UNMAPPED) &&
467 (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT)) {
468 rman_get_mapping(r, &map);
469 nexus_unmap_resource(bus, child, type, r, &map);
475 nexus_map_resource(device_t bus, device_t child, int type, struct resource *r,
476 struct resource_map_request *argsp, struct resource_map *map)
478 struct resource_map_request args;
479 rman_res_t end, length, start;
481 /* Resources must be active to be mapped. */
482 if (!(rman_get_flags(r) & RF_ACTIVE))
485 /* Mappings are only supported on I/O and memory resources. */
494 resource_init_map_request(&args);
496 bcopy(argsp, &args, imin(argsp->size, args.size));
497 start = rman_get_start(r) + args.offset;
498 if (args.length == 0)
499 length = rman_get_size(r);
501 length = args.length;
502 end = start + length - 1;
503 if (start > rman_get_end(r) || start < rman_get_start(r))
505 if (end > rman_get_end(r) || end < start)
509 * If this is a memory resource, map it into the kernel.
513 map->r_bushandle = start;
514 map->r_bustag = X86_BUS_SPACE_IO;
515 map->r_size = length;
519 map->r_vaddr = pmap_mapdev_attr(start, length, args.memattr);
520 map->r_bustag = X86_BUS_SPACE_MEM;
521 map->r_size = length;
524 * The handle is the virtual address.
526 map->r_bushandle = (bus_space_handle_t)map->r_vaddr;
533 nexus_unmap_resource(device_t bus, device_t child, int type, struct resource *r,
534 struct resource_map *map)
538 * If this is a memory resource, unmap it.
542 pmap_unmapdev((vm_offset_t)map->r_vaddr, map->r_size);
553 nexus_release_resource(device_t bus, device_t child, int type, int rid,
557 if (rman_get_flags(r) & RF_ACTIVE) {
558 int error = bus_deactivate_resource(child, type, rid, r);
562 return (rman_release_resource(r));
566 * Currently this uses the really grody interface from kern/kern_intr.c
567 * (which really doesn't belong in kern/anything.c). Eventually, all of
568 * the code in kern_intr.c and machdep_intr.c should get moved here, since
569 * this is going to be the official interface.
572 nexus_setup_intr(device_t bus, device_t child, struct resource *irq,
573 int flags, driver_filter_t filter, void (*ihand)(void *),
574 void *arg, void **cookiep)
578 /* somebody tried to setup an irq that failed to allocate! */
580 panic("nexus_setup_intr: NULL irq resource!");
583 if ((rman_get_flags(irq) & RF_SHAREABLE) == 0)
587 * We depend here on rman_activate_resource() being idempotent.
589 error = rman_activate_resource(irq);
593 error = intr_add_handler(device_get_nameunit(child),
594 rman_get_start(irq), filter, ihand, arg, flags, cookiep);
600 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
602 return (intr_remove_handler(ih));
607 nexus_bind_intr(device_t dev, device_t child, struct resource *irq, int cpu)
609 return (intr_bind(rman_get_start(irq), cpu));
614 nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
615 enum intr_polarity pol)
617 return (intr_config_intr(irq, trig, pol));
621 nexus_describe_intr(device_t dev, device_t child, struct resource *irq,
622 void *cookie, const char *descr)
625 return (intr_describe(rman_get_start(irq), cookie, descr));
628 static struct resource_list *
629 nexus_get_reslist(device_t dev, device_t child)
631 struct nexus_device *ndev = DEVTONX(child);
633 return (&ndev->nx_resources);
637 nexus_set_resource(device_t dev, device_t child, int type, int rid,
638 rman_res_t start, rman_res_t count)
640 struct nexus_device *ndev = DEVTONX(child);
641 struct resource_list *rl = &ndev->nx_resources;
643 /* XXX this should return a success/failure indicator */
644 resource_list_add(rl, type, rid, start, start + count - 1, count);
649 nexus_get_resource(device_t dev, device_t child, int type, int rid,
650 rman_res_t *startp, rman_res_t *countp)
652 struct nexus_device *ndev = DEVTONX(child);
653 struct resource_list *rl = &ndev->nx_resources;
654 struct resource_list_entry *rle;
656 rle = resource_list_find(rl, type, rid);
660 *startp = rle->start;
662 *countp = rle->count;
667 nexus_delete_resource(device_t dev, device_t child, int type, int rid)
669 struct nexus_device *ndev = DEVTONX(child);
670 struct resource_list *rl = &ndev->nx_resources;
672 resource_list_delete(rl, type, rid);
676 nexus_get_cpus(device_t dev, device_t child, enum cpu_sets op, size_t setsize,
683 if (setsize != sizeof(cpuset_t))
689 return (bus_generic_get_cpus(dev, child, op, setsize, cpuset));
693 /* Called from the MSI code to add new IRQs to the IRQ rman. */
695 nexus_add_irq(u_long irq)
698 if (rman_manage_region(&irq_rman, irq, irq) != 0)
699 panic("%s: failed", __func__);
704 nexus_alloc_msix(device_t pcib, device_t dev, int *irq)
707 return (msix_alloc(dev, irq));
711 nexus_release_msix(device_t pcib, device_t dev, int irq)
714 return (msix_release(irq));
718 nexus_alloc_msi(device_t pcib, device_t dev, int count, int maxcount, int *irqs)
721 return (msi_alloc(dev, count, maxcount, irqs));
725 nexus_release_msi(device_t pcib, device_t dev, int count, int *irqs)
728 return (msi_release(irqs, count));
732 nexus_map_msi(device_t pcib, device_t dev, int irq, uint64_t *addr, uint32_t *data)
735 return (msi_map(irq, addr, data));
739 /* Placeholder for system RAM. */
741 ram_identify(driver_t *driver, device_t parent)
744 if (resource_disabled("ram", 0))
746 if (BUS_ADD_CHILD(parent, 0, "ram", 0) == NULL)
747 panic("ram_identify");
751 ram_probe(device_t dev)
755 device_set_desc(dev, "System RAM");
760 ram_attach(device_t dev)
762 struct bios_smap *smapbase, *smap, *smapend;
763 struct resource *res;
769 /* Retrieve the system memory map from the loader. */
770 kmdp = preload_search_by_type("elf kernel");
772 kmdp = preload_search_by_type(ELF_KERN_STR);
773 smapbase = (struct bios_smap *)preload_search_info(kmdp,
774 MODINFO_METADATA | MODINFOMD_SMAP);
775 if (smapbase != NULL) {
776 smapsize = *((u_int32_t *)smapbase - 1);
777 smapend = (struct bios_smap *)((uintptr_t)smapbase + smapsize);
780 for (smap = smapbase; smap < smapend; smap++) {
781 if (smap->type != SMAP_TYPE_MEMORY ||
786 * Resources use long's to track resources, so
787 * we can't include memory regions above 4GB.
789 if (smap->base > ~0ul)
792 error = bus_set_resource(dev, SYS_RES_MEMORY, rid,
793 smap->base, smap->length);
796 "ram_attach: resource %d failed set with %d",
798 res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
801 panic("ram_attach: resource %d failed to attach",
809 * If the system map is not available, fall back to using
810 * dump_avail[]. We use the dump_avail[] array rather than
811 * phys_avail[] for the memory map as phys_avail[] contains
812 * holes for kernel memory, page 0, the message buffer, and
813 * the dcons buffer. We test the end address in the loop
814 * instead of the start since the start address for the first
817 for (rid = 0, p = dump_avail; p[1] != 0; rid++, p += 2) {
820 * Resources use long's to track resources, so we can't
821 * include memory regions above 4GB.
826 error = bus_set_resource(dev, SYS_RES_MEMORY, rid, p[0],
829 panic("ram_attach: resource %d failed set with %d", rid,
831 res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, 0);
833 panic("ram_attach: resource %d failed to attach", rid);
838 static device_method_t ram_methods[] = {
839 /* Device interface */
840 DEVMETHOD(device_identify, ram_identify),
841 DEVMETHOD(device_probe, ram_probe),
842 DEVMETHOD(device_attach, ram_attach),
846 static driver_t ram_driver = {
852 static devclass_t ram_devclass;
854 DRIVER_MODULE(ram, nexus, ram_driver, ram_devclass, 0, 0);
858 * Placeholder which claims PnP 'devices' which describe system
861 static struct isa_pnp_id sysresource_ids[] = {
862 { 0x010cd041 /* PNP0c01 */, "System Memory" },
863 { 0x020cd041 /* PNP0c02 */, "System Resource" },
868 sysresource_probe(device_t dev)
872 if ((result = ISA_PNP_PROBE(device_get_parent(dev), dev, sysresource_ids)) <= 0) {
879 sysresource_attach(device_t dev)
884 static device_method_t sysresource_methods[] = {
885 /* Device interface */
886 DEVMETHOD(device_probe, sysresource_probe),
887 DEVMETHOD(device_attach, sysresource_attach),
888 DEVMETHOD(device_detach, bus_generic_detach),
889 DEVMETHOD(device_shutdown, bus_generic_shutdown),
890 DEVMETHOD(device_suspend, bus_generic_suspend),
891 DEVMETHOD(device_resume, bus_generic_resume),
895 static driver_t sysresource_driver = {
901 static devclass_t sysresource_devclass;
903 DRIVER_MODULE(sysresource, isa, sysresource_driver, sysresource_devclass, 0, 0);