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.
52 #include <sys/param.h>
53 #include <sys/systm.h>
55 #include <sys/interrupt.h>
56 #include <sys/kernel.h>
57 #include <sys/linker.h>
58 #include <sys/malloc.h>
59 #include <sys/module.h>
63 #include <vm/vm_param.h>
64 #include <vm/vm_page.h>
65 #include <vm/vm_phys.h>
66 #include <vm/vm_dumpset.h>
69 #include <machine/bus.h>
70 #include <machine/intr_machdep.h>
71 #include <machine/md_var.h>
72 #include <machine/metadata.h>
73 #include <machine/nexusvar.h>
74 #include <machine/pc/bios.h>
75 #include <machine/resource.h>
82 #include <isa/isavar.h>
83 #include <isa/isareg.h>
86 #define ELF_KERN_STR ("elf"__XSTRING(__ELF_WORD_SIZE)" kernel")
88 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
90 #define DEVTONX(dev) ((struct nexus_device *)device_get_ivars(dev))
92 struct rman irq_rman, drq_rman, port_rman, mem_rman;
94 static int nexus_print_all_resources(device_t dev);
96 static device_probe_t nexus_probe;
97 static device_attach_t nexus_attach;
99 static bus_add_child_t nexus_add_child;
100 static bus_print_child_t nexus_print_child;
102 static bus_activate_resource_t nexus_activate_resource;
103 static bus_adjust_resource_t nexus_adjust_resource;
104 static bus_alloc_resource_t nexus_alloc_resource;
105 static bus_deactivate_resource_t nexus_deactivate_resource;
106 static bus_delete_resource_t nexus_delete_resource;
107 static bus_get_resource_t nexus_get_resource;
108 static bus_get_resource_list_t nexus_get_reslist;
109 static bus_map_resource_t nexus_map_resource;
110 static bus_release_resource_t nexus_release_resource;
111 static bus_set_resource_t nexus_set_resource;
112 static bus_unmap_resource_t nexus_unmap_resource;
115 static bus_bind_intr_t nexus_bind_intr;
117 static bus_config_intr_t nexus_config_intr;
118 static bus_describe_intr_t nexus_describe_intr;
119 static bus_resume_intr_t nexus_resume_intr;
120 static bus_setup_intr_t nexus_setup_intr;
121 static bus_suspend_intr_t nexus_suspend_intr;
122 static bus_teardown_intr_t nexus_teardown_intr;
124 static bus_get_cpus_t nexus_get_cpus;
126 #if defined(DEV_APIC) && defined(DEV_PCI)
127 static pcib_alloc_msi_t nexus_alloc_msi;
128 static pcib_release_msi_t nexus_release_msi;
129 static pcib_alloc_msix_t nexus_alloc_msix;
130 static pcib_release_msix_t nexus_release_msix;
131 static pcib_map_msi_t nexus_map_msi;
134 static device_method_t nexus_methods[] = {
135 /* Device interface */
136 DEVMETHOD(device_probe, nexus_probe),
137 DEVMETHOD(device_attach, nexus_attach),
138 DEVMETHOD(device_detach, bus_generic_detach),
139 DEVMETHOD(device_shutdown, bus_generic_shutdown),
140 DEVMETHOD(device_suspend, bus_generic_suspend),
141 DEVMETHOD(device_resume, bus_generic_resume),
144 DEVMETHOD(bus_print_child, nexus_print_child),
145 DEVMETHOD(bus_add_child, nexus_add_child),
146 DEVMETHOD(bus_activate_resource, nexus_activate_resource),
147 DEVMETHOD(bus_adjust_resource, nexus_adjust_resource),
148 DEVMETHOD(bus_alloc_resource, nexus_alloc_resource),
149 DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource),
150 DEVMETHOD(bus_get_resource, nexus_get_resource),
151 DEVMETHOD(bus_get_resource_list, nexus_get_reslist),
152 DEVMETHOD(bus_delete_resource, nexus_delete_resource),
153 DEVMETHOD(bus_map_resource, nexus_map_resource),
154 DEVMETHOD(bus_release_resource, nexus_release_resource),
155 DEVMETHOD(bus_set_resource, nexus_set_resource),
156 DEVMETHOD(bus_unmap_resource, nexus_unmap_resource),
158 DEVMETHOD(bus_bind_intr, nexus_bind_intr),
160 DEVMETHOD(bus_config_intr, nexus_config_intr),
161 DEVMETHOD(bus_describe_intr, nexus_describe_intr),
162 DEVMETHOD(bus_resume_intr, nexus_resume_intr),
163 DEVMETHOD(bus_setup_intr, nexus_setup_intr),
164 DEVMETHOD(bus_suspend_intr, nexus_suspend_intr),
165 DEVMETHOD(bus_teardown_intr, nexus_teardown_intr),
166 DEVMETHOD(bus_get_cpus, nexus_get_cpus),
169 #if defined(DEV_APIC) && defined(DEV_PCI)
170 DEVMETHOD(pcib_alloc_msi, nexus_alloc_msi),
171 DEVMETHOD(pcib_release_msi, nexus_release_msi),
172 DEVMETHOD(pcib_alloc_msix, nexus_alloc_msix),
173 DEVMETHOD(pcib_release_msix, nexus_release_msix),
174 DEVMETHOD(pcib_map_msi, nexus_map_msi),
179 DEFINE_CLASS_0(nexus, nexus_driver, nexus_methods, 1);
180 static devclass_t nexus_devclass;
182 DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0);
185 nexus_probe(device_t dev)
188 device_quiet(dev); /* suppress attach message for neatness */
189 return (BUS_PROBE_GENERIC);
193 nexus_init_resources(void)
200 * - IRQ resource creation should be moved to the PIC/APIC driver.
201 * - DRQ resource creation should be moved to the DMAC driver.
202 * - The above should be sorted to probe earlier than any child buses.
204 * - Leave I/O and memory creation here, as child probes may need them.
205 * (especially eg. ACPI)
209 * IRQ's are on the mainboard on old systems, but on the ISA part
210 * of PCI->ISA bridges. There would be multiple sets of IRQs on
211 * multi-ISA-bus systems. PCI interrupts are routed to the ISA
212 * component, so in a way, PCI can be a partial child of an ISA bus(!).
213 * APIC interrupts are global though.
215 irq_rman.rm_start = 0;
216 irq_rman.rm_type = RMAN_ARRAY;
217 irq_rman.rm_descr = "Interrupt request lines";
218 irq_rman.rm_end = num_io_irqs - 1;
219 if (rman_init(&irq_rman))
220 panic("nexus_init_resources irq_rman");
223 * We search for regions of existing IRQs and add those to the IRQ
226 for (irq = 0; irq < num_io_irqs; irq++)
227 if (intr_lookup_source(irq) != NULL)
228 if (rman_manage_region(&irq_rman, irq, irq) != 0)
229 panic("nexus_init_resources irq_rman add");
232 * ISA DMA on PCI systems is implemented in the ISA part of each
233 * PCI->ISA bridge and the channels can be duplicated if there are
234 * multiple bridges. (eg: laptops with docking stations)
236 drq_rman.rm_start = 0;
238 drq_rman.rm_type = RMAN_ARRAY;
239 drq_rman.rm_descr = "DMA request lines";
240 /* XXX drq 0 not available on some machines */
241 if (rman_init(&drq_rman)
242 || rman_manage_region(&drq_rman,
243 drq_rman.rm_start, drq_rman.rm_end))
244 panic("nexus_init_resources drq_rman");
247 * However, IO ports and Memory truely are global at this level,
248 * as are APIC interrupts (however many IO APICS there turn out
249 * to be on large systems..)
251 port_rman.rm_start = 0;
252 port_rman.rm_end = 0xffff;
253 port_rman.rm_type = RMAN_ARRAY;
254 port_rman.rm_descr = "I/O ports";
255 if (rman_init(&port_rman)
256 || rman_manage_region(&port_rman, 0, 0xffff))
257 panic("nexus_init_resources port_rman");
259 mem_rman.rm_start = 0;
260 mem_rman.rm_end = cpu_getmaxphyaddr();
261 mem_rman.rm_type = RMAN_ARRAY;
262 mem_rman.rm_descr = "I/O memory addresses";
263 if (rman_init(&mem_rman)
264 || rman_manage_region(&mem_rman, 0, mem_rman.rm_end))
265 panic("nexus_init_resources mem_rman");
269 nexus_attach(device_t dev)
272 nexus_init_resources();
273 bus_generic_probe(dev);
276 * Explicitly add the legacy0 device here. Other platform
277 * types (such as ACPI), use their own nexus(4) subclass
278 * driver to override this routine and add their own root bus.
280 if (BUS_ADD_CHILD(dev, 10, "legacy", 0) == NULL)
281 panic("legacy: could not attach");
282 bus_generic_attach(dev);
287 nexus_print_all_resources(device_t dev)
289 struct nexus_device *ndev = DEVTONX(dev);
290 struct resource_list *rl = &ndev->nx_resources;
293 if (STAILQ_FIRST(rl))
294 retval += printf(" at");
296 retval += resource_list_print_type(rl, "port", SYS_RES_IOPORT, "%#jx");
297 retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#jx");
298 retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%jd");
304 nexus_print_child(device_t bus, device_t child)
308 retval += bus_print_child_header(bus, child);
309 retval += nexus_print_all_resources(child);
310 if (device_get_flags(child))
311 retval += printf(" flags %#x", device_get_flags(child));
312 retval += printf("\n");
318 nexus_add_child(device_t bus, u_int order, const char *name, int unit)
321 struct nexus_device *ndev;
323 ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_NOWAIT|M_ZERO);
326 resource_list_init(&ndev->nx_resources);
328 child = device_add_child_ordered(bus, order, name, unit);
330 /* should we free this in nexus_child_detached? */
331 device_set_ivars(child, ndev);
354 * Allocate a resource on behalf of child. NB: child is usually going to be a
355 * child of one of our descendants, not a direct child of nexus0.
357 static struct resource *
358 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
359 rman_res_t start, rman_res_t end, rman_res_t count,
362 struct nexus_device *ndev = DEVTONX(child);
364 struct resource_list_entry *rle;
366 int needactivate = flags & RF_ACTIVE;
369 * If this is an allocation of the "default" range for a given
370 * RID, and we know what the resources for this device are
371 * (ie. they aren't maintained by a child bus), then work out
372 * the start/end values.
374 if (RMAN_IS_DEFAULT_RANGE(start, end) && (count == 1)) {
375 if (device_get_parent(child) != bus || ndev == NULL)
377 rle = resource_list_find(&ndev->nx_resources, type, *rid);
386 rm = nexus_rman(type);
390 rv = rman_reserve_resource(rm, start, end, count, flags, child);
393 rman_set_rid(rv, *rid);
396 if (bus_activate_resource(child, type, *rid, rv)) {
397 rman_release_resource(rv);
406 nexus_adjust_resource(device_t bus, device_t child, int type,
407 struct resource *r, rman_res_t start, rman_res_t end)
411 rm = nexus_rman(type);
414 if (!rman_is_region_manager(r, rm))
416 return (rman_adjust_resource(r, start, end));
420 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
423 struct resource_map map;
426 error = rman_activate_resource(r);
430 if (!(rman_get_flags(r) & RF_UNMAPPED) &&
431 (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT)) {
432 error = nexus_map_resource(bus, child, type, r, NULL, &map);
434 rman_deactivate_resource(r);
438 rman_set_mapping(r,&map);
444 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
447 struct resource_map map;
450 error = rman_deactivate_resource(r);
454 if (!(rman_get_flags(r) & RF_UNMAPPED) &&
455 (type == SYS_RES_MEMORY || type == SYS_RES_IOPORT)) {
456 rman_get_mapping(r, &map);
457 nexus_unmap_resource(bus, child, type, r, &map);
463 nexus_map_resource(device_t bus, device_t child, int type, struct resource *r,
464 struct resource_map_request *argsp, struct resource_map *map)
466 struct resource_map_request args;
467 rman_res_t end, length, start;
469 /* Resources must be active to be mapped. */
470 if (!(rman_get_flags(r) & RF_ACTIVE))
473 /* Mappings are only supported on I/O and memory resources. */
482 resource_init_map_request(&args);
484 bcopy(argsp, &args, imin(argsp->size, args.size));
485 start = rman_get_start(r) + args.offset;
486 if (args.length == 0)
487 length = rman_get_size(r);
489 length = args.length;
490 end = start + length - 1;
491 if (start > rman_get_end(r) || start < rman_get_start(r))
493 if (end > rman_get_end(r) || end < start)
497 * If this is a memory resource, map it into the kernel.
501 map->r_bushandle = start;
502 map->r_bustag = X86_BUS_SPACE_IO;
503 map->r_size = length;
507 map->r_vaddr = pmap_mapdev_attr(start, length, args.memattr);
508 map->r_bustag = X86_BUS_SPACE_MEM;
509 map->r_size = length;
512 * The handle is the virtual address.
514 map->r_bushandle = (bus_space_handle_t)map->r_vaddr;
521 nexus_unmap_resource(device_t bus, device_t child, int type, struct resource *r,
522 struct resource_map *map)
526 * If this is a memory resource, unmap it.
530 pmap_unmapdev((vm_offset_t)map->r_vaddr, map->r_size);
541 nexus_release_resource(device_t bus, device_t child, int type, int rid,
546 if (rman_get_flags(r) & RF_ACTIVE) {
547 error = bus_deactivate_resource(child, type, rid, r);
551 return (rman_release_resource(r));
555 * Currently this uses the really grody interface from kern/kern_intr.c
556 * (which really doesn't belong in kern/anything.c). Eventually, all of
557 * the code in kern_intr.c and machdep_intr.c should get moved here, since
558 * this is going to be the official interface.
561 nexus_setup_intr(device_t bus, device_t child, struct resource *irq,
562 int flags, driver_filter_t filter, void (*ihand)(void *),
563 void *arg, void **cookiep)
567 /* somebody tried to setup an irq that failed to allocate! */
569 panic("nexus_setup_intr: NULL irq resource!");
572 if ((rman_get_flags(irq) & RF_SHAREABLE) == 0)
576 * We depend here on rman_activate_resource() being idempotent.
578 error = rman_activate_resource(irq);
581 if (bus_get_domain(child, &domain) != 0)
584 error = intr_add_handler(device_get_nameunit(child),
585 rman_get_start(irq), filter, ihand, arg, flags, cookiep, domain);
587 rman_set_irq_cookie(irq, *cookiep);
593 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
597 error = intr_remove_handler(ih);
599 rman_set_irq_cookie(r, NULL);
604 nexus_suspend_intr(device_t dev, device_t child, struct resource *irq)
606 return (intr_event_suspend_handler(rman_get_irq_cookie(irq)));
610 nexus_resume_intr(device_t dev, device_t child, struct resource *irq)
612 return (intr_event_resume_handler(rman_get_irq_cookie(irq)));
617 nexus_bind_intr(device_t dev, device_t child, struct resource *irq, int cpu)
619 return (intr_bind(rman_get_start(irq), cpu));
624 nexus_config_intr(device_t dev, int irq, enum intr_trigger trig,
625 enum intr_polarity pol)
627 return (intr_config_intr(irq, trig, pol));
631 nexus_describe_intr(device_t dev, device_t child, struct resource *irq,
632 void *cookie, const char *descr)
635 return (intr_describe(rman_get_start(irq), cookie, descr));
638 static struct resource_list *
639 nexus_get_reslist(device_t dev, device_t child)
641 struct nexus_device *ndev = DEVTONX(child);
643 return (&ndev->nx_resources);
647 nexus_set_resource(device_t dev, device_t child, int type, int rid,
648 rman_res_t start, rman_res_t count)
650 struct nexus_device *ndev = DEVTONX(child);
651 struct resource_list *rl = &ndev->nx_resources;
653 /* XXX this should return a success/failure indicator */
654 resource_list_add(rl, type, rid, start, start + count - 1, count);
659 nexus_get_resource(device_t dev, device_t child, int type, int rid,
660 rman_res_t *startp, rman_res_t *countp)
662 struct nexus_device *ndev = DEVTONX(child);
663 struct resource_list *rl = &ndev->nx_resources;
664 struct resource_list_entry *rle;
666 rle = resource_list_find(rl, type, rid);
670 *startp = rle->start;
672 *countp = rle->count;
677 nexus_delete_resource(device_t dev, device_t child, int type, int rid)
679 struct nexus_device *ndev = DEVTONX(child);
680 struct resource_list *rl = &ndev->nx_resources;
682 resource_list_delete(rl, type, rid);
686 nexus_get_cpus(device_t dev, device_t child, enum cpu_sets op, size_t setsize,
693 if (setsize != sizeof(cpuset_t))
699 return (bus_generic_get_cpus(dev, child, op, setsize, cpuset));
703 /* Called from the MSI code to add new IRQs to the IRQ rman. */
705 nexus_add_irq(u_long irq)
708 if (rman_manage_region(&irq_rman, irq, irq) != 0)
709 panic("%s: failed", __func__);
712 #if defined(DEV_APIC) && defined(DEV_PCI)
714 nexus_alloc_msix(device_t pcib, device_t dev, int *irq)
717 return (msix_alloc(dev, irq));
721 nexus_release_msix(device_t pcib, device_t dev, int irq)
724 return (msix_release(irq));
728 nexus_alloc_msi(device_t pcib, device_t dev, int count, int maxcount, int *irqs)
731 return (msi_alloc(dev, count, maxcount, irqs));
735 nexus_release_msi(device_t pcib, device_t dev, int count, int *irqs)
738 return (msi_release(irqs, count));
742 nexus_map_msi(device_t pcib, device_t dev, int irq, uint64_t *addr, uint32_t *data)
745 return (msi_map(irq, addr, data));
747 #endif /* DEV_APIC && DEV_PCI */
749 /* Placeholder for system RAM. */
751 ram_identify(driver_t *driver, device_t parent)
754 if (resource_disabled("ram", 0))
756 if (BUS_ADD_CHILD(parent, 0, "ram", 0) == NULL)
757 panic("ram_identify");
761 ram_probe(device_t dev)
765 device_set_desc(dev, "System RAM");
770 ram_attach(device_t dev)
772 struct bios_smap *smapbase, *smap, *smapend;
773 struct resource *res;
780 /* Retrieve the system memory map from the loader. */
781 kmdp = preload_search_by_type("elf kernel");
783 kmdp = preload_search_by_type(ELF_KERN_STR);
784 smapbase = (struct bios_smap *)preload_search_info(kmdp,
785 MODINFO_METADATA | MODINFOMD_SMAP);
786 if (smapbase != NULL) {
787 smapsize = *((u_int32_t *)smapbase - 1);
788 smapend = (struct bios_smap *)((uintptr_t)smapbase + smapsize);
791 for (smap = smapbase; smap < smapend; smap++) {
792 if (smap->type != SMAP_TYPE_MEMORY ||
795 if (smap->base > mem_rman.rm_end)
797 length = smap->base + smap->length > mem_rman.rm_end ?
798 mem_rman.rm_end - smap->base : smap->length;
799 error = bus_set_resource(dev, SYS_RES_MEMORY, rid,
803 "ram_attach: resource %d failed set with %d",
805 res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
808 panic("ram_attach: resource %d failed to attach",
816 * If the system map is not available, fall back to using
817 * dump_avail[]. We use the dump_avail[] array rather than
818 * phys_avail[] for the memory map as phys_avail[] contains
819 * holes for kernel memory, page 0, the message buffer, and
820 * the dcons buffer. We test the end address in the loop
821 * instead of the start since the start address for the first
824 for (rid = 0, p = dump_avail; p[1] != 0; rid++, p += 2) {
825 if (p[0] > mem_rman.rm_end)
827 length = (p[1] > mem_rman.rm_end ? mem_rman.rm_end : p[1]) -
829 error = bus_set_resource(dev, SYS_RES_MEMORY, rid, p[0],
832 panic("ram_attach: resource %d failed set with %d", rid,
834 res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, 0);
836 panic("ram_attach: resource %d failed to attach", rid);
841 static device_method_t ram_methods[] = {
842 /* Device interface */
843 DEVMETHOD(device_identify, ram_identify),
844 DEVMETHOD(device_probe, ram_probe),
845 DEVMETHOD(device_attach, ram_attach),
850 static driver_t ram_driver = {
856 static devclass_t ram_devclass;
858 DRIVER_MODULE(ram, nexus, ram_driver, ram_devclass, 0, 0);
862 * Placeholder which claims PnP 'devices' which describe system
865 static struct isa_pnp_id sysresource_ids[] = {
866 { 0x010cd041 /* PNP0c01 */, "System Memory" },
867 { 0x020cd041 /* PNP0c02 */, "System Resource" },
872 sysresource_probe(device_t dev)
876 if ((result = ISA_PNP_PROBE(device_get_parent(dev), dev, sysresource_ids)) <= 0) {
883 sysresource_attach(device_t dev)
888 static device_method_t sysresource_methods[] = {
889 /* Device interface */
890 DEVMETHOD(device_probe, sysresource_probe),
891 DEVMETHOD(device_attach, sysresource_attach),
892 DEVMETHOD(device_detach, bus_generic_detach),
893 DEVMETHOD(device_shutdown, bus_generic_shutdown),
894 DEVMETHOD(device_suspend, bus_generic_suspend),
895 DEVMETHOD(device_resume, bus_generic_resume),
900 static driver_t sysresource_driver = {
906 static devclass_t sysresource_devclass;
908 DRIVER_MODULE(sysresource, isa, sysresource_driver, sysresource_devclass, 0, 0);
909 ISA_PNP_INFO(sysresource_ids);