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
29 * $FreeBSD: src/sys/i386/i386/nexus.c,v 1.26.2.10 2003/02/22 13:16:45 imp Exp $
30 * $DragonFly: src/sys/platform/pc32/i386/nexus.c,v 1.13 2005/05/23 18:19:51 dillon Exp $
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.
46 #include <sys/param.h>
47 #include <sys/systm.h>
49 #include <sys/kernel.h>
50 #include <sys/malloc.h>
51 #include <sys/module.h>
52 #include <machine/bus.h>
55 #include <machine/vmparam.h>
58 #include <machine/pmap.h>
60 #include <machine/nexusvar.h>
61 #include <machine/resource.h>
63 #include <machine/smp.h>
64 #include <machine/mpapic.h>
67 #include <bus/isa/isavar.h>
68 #include <bus/isa/i386/isa.h>
69 #include <i386/isa/intr_machdep.h>
71 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
73 struct resource_list nx_resources;
77 #define DEVTONX(dev) ((struct nexus_device *)device_get_ivars(dev))
79 static struct rman irq_rman, drq_rman, port_rman, mem_rman;
81 static void nexus_identify(driver_t *, device_t);
82 static int nexus_probe(device_t);
83 static int nexus_attach(device_t);
84 static int nexus_print_all_resources(device_t dev);
85 static int nexus_print_child(device_t, device_t);
86 static device_t nexus_add_child(device_t bus, int order, const char *name,
88 static struct resource *nexus_alloc_resource(device_t, device_t, int, int *,
89 u_long, u_long, u_long, u_int);
90 static int nexus_read_ivar(device_t, device_t, int, uintptr_t *);
91 static int nexus_write_ivar(device_t, device_t, int, uintptr_t);
92 static int nexus_activate_resource(device_t, device_t, int, int,
94 static int nexus_deactivate_resource(device_t, device_t, int, int,
96 static int nexus_release_resource(device_t, device_t, int, int,
98 static int nexus_setup_intr(device_t, device_t, struct resource *, int flags,
99 void (*)(void *), void *, void **);
100 static int nexus_teardown_intr(device_t, device_t, struct resource *,
102 static void nexus_enable_intr(device_t, device_t, void *);
103 static void nexus_disable_intr(device_t, device_t, void *);
104 static int nexus_set_resource(device_t, device_t, int, int, u_long, u_long);
105 static int nexus_get_resource(device_t, device_t, int, int, u_long *, u_long *);
106 static void nexus_delete_resource(device_t, device_t, int, int);
108 static device_method_t nexus_methods[] = {
109 /* Device interface */
110 DEVMETHOD(device_identify, nexus_identify),
111 DEVMETHOD(device_probe, nexus_probe),
112 DEVMETHOD(device_attach, nexus_attach),
113 DEVMETHOD(device_detach, bus_generic_detach),
114 DEVMETHOD(device_shutdown, bus_generic_shutdown),
115 DEVMETHOD(device_suspend, bus_generic_suspend),
116 DEVMETHOD(device_resume, bus_generic_resume),
119 DEVMETHOD(bus_print_child, nexus_print_child),
120 DEVMETHOD(bus_add_child, nexus_add_child),
121 DEVMETHOD(bus_read_ivar, nexus_read_ivar),
122 DEVMETHOD(bus_write_ivar, nexus_write_ivar),
123 DEVMETHOD(bus_alloc_resource, nexus_alloc_resource),
124 DEVMETHOD(bus_release_resource, nexus_release_resource),
125 DEVMETHOD(bus_activate_resource, nexus_activate_resource),
126 DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource),
127 DEVMETHOD(bus_setup_intr, nexus_setup_intr),
128 DEVMETHOD(bus_disable_intr, nexus_disable_intr),
129 DEVMETHOD(bus_enable_intr, nexus_enable_intr),
130 DEVMETHOD(bus_teardown_intr, nexus_teardown_intr),
131 DEVMETHOD(bus_set_resource, nexus_set_resource),
132 DEVMETHOD(bus_get_resource, nexus_get_resource),
133 DEVMETHOD(bus_delete_resource, nexus_delete_resource),
138 static driver_t nexus_driver = {
143 static devclass_t nexus_devclass;
145 DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, 0, 0);
148 nexus_identify(driver_t *driver, device_t parent)
151 * Add child device with order of 1 so it gets probed
152 * after ACPI (which is at order 0.
154 if (BUS_ADD_CHILD(parent, 1, "legacy", 0) == NULL)
155 panic("legacy: could not attach");
159 nexus_probe(device_t dev)
167 * Fail to probe if ACPI is ok.
169 acpi = devclass_get_device(devclass_find("acpi"), 0);
170 if (acpi != NULL && device_is_alive(acpi))
174 device_quiet(dev); /* suppress attach message for neatness */
177 * IRQ's are on the mainboard on old systems, but on the ISA part
178 * of PCI->ISA bridges. There would be multiple sets of IRQs on
179 * multi-ISA-bus systems. PCI interrupts are routed to the ISA
180 * component, so in a way, PCI can be a partial child of an ISA bus(!).
181 * APIC interrupts are global though.
182 * In the non-APIC case, disallow the use of IRQ 2.
184 irq_rman.rm_start = 0;
185 irq_rman.rm_type = RMAN_ARRAY;
186 irq_rman.rm_descr = "Interrupt request lines";
188 irq_rman.rm_end = APIC_INTMAPSIZE - 1;
189 if (rman_init(&irq_rman)
190 || rman_manage_region(&irq_rman,
191 irq_rman.rm_start, irq_rman.rm_end))
192 panic("nexus_probe irq_rman");
194 irq_rman.rm_end = 15;
195 if (rman_init(&irq_rman)
196 || rman_manage_region(&irq_rman, irq_rman.rm_start, 1)
197 || rman_manage_region(&irq_rman, 3, irq_rman.rm_end))
198 panic("nexus_probe irq_rman");
202 * ISA DMA on PCI systems is implemented in the ISA part of each
203 * PCI->ISA bridge and the channels can be duplicated if there are
204 * multiple bridges. (eg: laptops with docking stations)
206 drq_rman.rm_start = 0;
208 drq_rman.rm_type = RMAN_ARRAY;
209 drq_rman.rm_descr = "DMA request lines";
210 /* XXX drq 0 not available on some machines */
211 if (rman_init(&drq_rman)
212 || rman_manage_region(&drq_rman,
213 drq_rman.rm_start, drq_rman.rm_end))
214 panic("nexus_probe drq_rman");
217 * However, IO ports and Memory truely are global at this level,
218 * as are APIC interrupts (however many IO APICS there turn out
219 * to be on large systems..)
221 port_rman.rm_start = 0;
222 port_rman.rm_end = 0xffff;
223 port_rman.rm_type = RMAN_ARRAY;
224 port_rman.rm_descr = "I/O ports";
225 if (rman_init(&port_rman)
226 || rman_manage_region(&port_rman, 0, 0xffff))
227 panic("nexus_probe port_rman");
229 mem_rman.rm_start = 0;
230 mem_rman.rm_end = ~0u;
231 mem_rman.rm_type = RMAN_ARRAY;
232 mem_rman.rm_descr = "I/O memory addresses";
233 if (rman_init(&mem_rman)
234 || rman_manage_region(&mem_rman, 0, ~0))
235 panic("nexus_probe mem_rman");
237 return bus_generic_probe(dev);
241 nexus_attach(device_t dev)
246 * First, let our child driver's identify any child devices that
247 * they can find. Once that is done attach any devices that we
251 bus_generic_probe(dev);
253 bus_generic_attach(dev);
256 * And if we didn't see EISA or ISA on a pci bridge, create some
257 * connection points now so they show up "on motherboard".
259 if (!devclass_get_device(devclass_find("eisa"), 0)) {
260 child = BUS_ADD_CHILD(dev, 0, "eisa", 0);
262 panic("nexus_attach eisa");
263 device_probe_and_attach(child);
266 if (!devclass_get_device(devclass_find("mca"), 0)) {
267 child = BUS_ADD_CHILD(dev, 0, "mca", 0);
269 panic("nexus_probe mca");
270 device_probe_and_attach(child);
273 if (!devclass_get_device(devclass_find("isa"), 0)) {
274 child = BUS_ADD_CHILD(dev, 0, "isa", 0);
276 panic("nexus_attach isa");
277 device_probe_and_attach(child);
284 nexus_print_all_resources(device_t dev)
286 struct nexus_device *ndev = DEVTONX(dev);
287 struct resource_list *rl = &ndev->nx_resources;
290 if (SLIST_FIRST(rl) || ndev->nx_pcibus != -1)
291 retval += printf(" at");
293 retval += resource_list_print_type(rl, "port", SYS_RES_IOPORT, "%#lx");
294 retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#lx");
295 retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
301 nexus_print_child(device_t bus, device_t child)
303 struct nexus_device *ndev = DEVTONX(child);
306 retval += bus_print_child_header(bus, child);
307 retval += nexus_print_all_resources(child);
308 if (ndev->nx_pcibus != -1)
309 retval += printf(" pcibus %d", ndev->nx_pcibus);
310 retval += printf(" on motherboard\n");
316 nexus_add_child(device_t bus, int order, const char *name, int unit)
319 struct nexus_device *ndev;
321 ndev = malloc(sizeof(struct nexus_device), M_NEXUSDEV, M_INTWAIT|M_ZERO);
324 resource_list_init(&ndev->nx_resources);
325 ndev->nx_pcibus = -1;
327 child = device_add_child_ordered(bus, order, name, unit);
329 /* should we free this in nexus_child_detached? */
330 device_set_ivars(child, ndev);
336 nexus_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
338 struct nexus_device *ndev = DEVTONX(child);
341 case NEXUS_IVAR_PCIBUS:
342 *result = ndev->nx_pcibus;
351 nexus_write_ivar(device_t dev, device_t child, int which, uintptr_t value)
353 struct nexus_device *ndev = DEVTONX(child);
356 case NEXUS_IVAR_PCIBUS:
357 ndev->nx_pcibus = value;
366 * Allocate a resource on behalf of child. NB: child is usually going to be a
367 * child of one of our descendants, not a direct child of nexus0.
368 * (Exceptions include npx.)
370 static struct resource *
371 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
372 u_long start, u_long end, u_long count, u_int flags)
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 RID, and
382 * we know what the resources for this device are (ie. they aren't maintained
383 * by a child bus), then work out the start/end values.
385 if ((start == 0UL) && (end == ~0UL) && (count == 1)) {
388 rle = resource_list_find(&ndev->nx_resources, type, *rid);
419 rv = rman_reserve_resource(rm, start, end, count, flags, child);
423 if (type == SYS_RES_MEMORY) {
424 rman_set_bustag(rv, I386_BUS_SPACE_MEM);
425 } else if (type == SYS_RES_IOPORT) {
426 rman_set_bustag(rv, I386_BUS_SPACE_IO);
427 rman_set_bushandle(rv, rv->r_start);
431 if (bus_activate_resource(child, type, *rid, rv)) {
432 rman_release_resource(rv);
441 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
445 * If this is a memory resource, map it into the kernel.
447 if (rman_get_bustag(r) == I386_BUS_SPACE_MEM) {
450 if (rman_get_end(r) < 1024 * 1024) {
452 * The first 1Mb is mapped at KERNBASE.
454 vaddr = (caddr_t)(uintptr_t)(KERNBASE + rman_get_start(r));
460 paddr = rman_get_start(r);
461 psize = rman_get_size(r);
463 poffs = paddr - trunc_page(paddr);
464 vaddr = (caddr_t) pmap_mapdev(paddr-poffs, psize+poffs) + poffs;
466 rman_set_virtual(r, vaddr);
467 /* IBM-PC: the type of bus_space_handle_t is u_int */
468 rman_set_bushandle(r, (bus_space_handle_t) vaddr);
470 return (rman_activate_resource(r));
474 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
478 * If this is a memory resource, unmap it.
480 if ((rman_get_bustag(r) == I386_BUS_SPACE_MEM) &&
481 (rman_get_end(r) >= 1024 * 1024)) {
484 psize = rman_get_size(r);
485 pmap_unmapdev((vm_offset_t)rman_get_virtual(r), psize);
488 return (rman_deactivate_resource(r));
492 nexus_release_resource(device_t bus, device_t child, int type, int rid,
495 if (rman_get_flags(r) & RF_ACTIVE) {
496 int error = bus_deactivate_resource(child, type, rid, r);
500 return (rman_release_resource(r));
504 * Currently this uses the really grody interface from kern/kern_intr.c
505 * (which really doesn't belong in kern/anything.c). Eventually, all of
506 * the code in kern_intr.c and machdep_intr.c should get moved here, since
507 * this is going to be the official interface.
510 nexus_setup_intr(device_t bus, device_t child, struct resource *irq,
511 int flags, void (*ihand)(void *), void *arg, void **cookiep)
517 /* somebody tried to setup an irq that failed to allocate! */
519 panic("nexus_setup_intr: NULL irq resource!");
522 if (irq->r_flags & RF_SHAREABLE)
527 driver = device_get_driver(child);
528 switch (flags & INTR_TYPE_MASK) {
544 printf("nexus: Warning: do not know what imask to use for INTR_TYPE_CLK\n");
550 panic("still using grody create_intr interface");
552 if (flags & INTR_FAST)
553 icflags |= INTR_FAST;
556 * We depend here on rman_activate_resource() being idempotent.
558 error = rman_activate_resource(irq);
562 *cookiep = inthand_add(device_get_nameunit(child), irq->r_start,
563 ihand, arg, mask, icflags);
564 if (*cookiep == NULL)
565 error = EINVAL; /* XXX ??? */
571 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
573 return (inthand_remove(ih));
577 nexus_disable_intr(device_t dev, device_t child, void *ih)
579 inthand_disabled(ih);
583 nexus_enable_intr(device_t dev, device_t child, void *ih)
589 nexus_set_resource(device_t dev, device_t child, int type, int rid, u_long start, u_long count)
591 struct nexus_device *ndev = DEVTONX(child);
592 struct resource_list *rl = &ndev->nx_resources;
594 /* XXX this should return a success/failure indicator */
595 resource_list_add(rl, type, rid, start, start + count - 1, count);
600 nexus_get_resource(device_t dev, device_t child, int type, int rid, u_long *startp, u_long *countp)
602 struct nexus_device *ndev = DEVTONX(child);
603 struct resource_list *rl = &ndev->nx_resources;
604 struct resource_list_entry *rle;
606 rle = resource_list_find(rl, type, rid);
607 device_printf(child, "type %d rid %d startp %p countp %p - got %p\n",
608 type, rid, startp, countp, rle);
612 *startp = rle->start;
614 *countp = rle->count;
619 nexus_delete_resource(device_t dev, device_t child, int type, int rid)
621 struct nexus_device *ndev = DEVTONX(child);
622 struct resource_list *rl = &ndev->nx_resources;
624 resource_list_delete(rl, type, rid);
628 * Placeholder which claims PnP 'devices' which describe system
631 static struct isa_pnp_id sysresource_ids[] = {
632 { 0x010cd041 /* PNP0c01 */, "System Memory" },
633 { 0x020cd041 /* PNP0c02 */, "System Resource" },
638 sysresource_probe(device_t dev)
642 if ((result = ISA_PNP_PROBE(device_get_parent(dev), dev, sysresource_ids)) >= 0) {
649 sysresource_attach(device_t dev)
654 static device_method_t sysresource_methods[] = {
655 /* Device interface */
656 DEVMETHOD(device_probe, sysresource_probe),
657 DEVMETHOD(device_attach, sysresource_attach),
658 DEVMETHOD(device_detach, bus_generic_detach),
659 DEVMETHOD(device_shutdown, bus_generic_shutdown),
660 DEVMETHOD(device_suspend, bus_generic_suspend),
661 DEVMETHOD(device_resume, bus_generic_resume),
665 static driver_t sysresource_driver = {
671 static devclass_t sysresource_devclass;
673 DRIVER_MODULE(sysresource, isa, sysresource_driver, sysresource_devclass, 0, 0);