2 * Copyright 1998 Massachusetts Institute of Technology
3 * Copyright (c) 2008 The DragonFly Project.
5 * Permission to use, copy, modify, and distribute this software and
6 * its documentation for any purpose and without fee is hereby
7 * granted, provided that both the above copyright notice and this
8 * permission notice appear in all copies, that both the above
9 * copyright notice and this permission notice appear in all
10 * supporting documentation, and that the name of M.I.T. not be used
11 * in advertising or publicity pertaining to distribution of the
12 * software without specific, written prior permission. M.I.T. makes
13 * no representations about the suitability of this software for any
14 * purpose. It is provided "as is" without express or implied
17 * THIS SOFTWARE IS PROVIDED BY M.I.T. ``AS IS''. M.I.T. DISCLAIMS
18 * ALL EXPRESS OR IMPLIED WARRANTIES WITH REGARD TO THIS SOFTWARE,
19 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
20 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. IN NO EVENT
21 * SHALL M.I.T. BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
24 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
26 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
27 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * $FreeBSD: src/sys/i386/i386/nexus.c,v 1.26.2.10 2003/02/22 13:16:45 imp 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.
44 #include <sys/param.h>
45 #include <sys/systm.h>
47 #include <sys/kernel.h>
48 #include <sys/malloc.h>
49 #include <sys/module.h>
51 #include <sys/interrupt.h>
52 #include <sys/machintr.h>
54 #include <machine/vmparam.h>
57 #include <machine/pmap.h>
59 #include <machine/nexusvar.h>
60 #include <machine/smp.h>
61 #include <machine/intr_machdep.h>
62 #include <machine_base/apic/lapic.h>
63 #include <machine_base/apic/ioapic.h>
67 #define I386_BUS_SPACE_IO 0 /* space is i/o space */
68 #define I386_BUS_SPACE_MEM 1 /* space is mem space */
70 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device");
72 struct resource_list nx_resources;
76 #define DEVTONX(dev) ((struct nexus_device *)device_get_ivars(dev))
78 static struct rman irq_rman[MAXCPU], drq_rman, port_rman, mem_rman;
80 static int nexus_probe(device_t);
81 static int nexus_attach(device_t);
82 static int nexus_print_all_resources(device_t dev);
83 static int nexus_print_child(device_t, device_t);
84 static device_t nexus_add_child(device_t bus, device_t parent, int order,
85 const char *name, int unit);
86 static struct resource *nexus_alloc_resource(device_t, device_t, int, int *,
87 u_long, u_long, u_long, u_int, int);
88 static int nexus_read_ivar(device_t, device_t, int, uintptr_t *);
89 static int nexus_write_ivar(device_t, device_t, int, uintptr_t);
90 static int nexus_activate_resource(device_t, device_t, int, int,
92 static int nexus_deactivate_resource(device_t, device_t, int, int,
94 static int nexus_release_resource(device_t, device_t, int, int,
96 static int nexus_config_intr(device_t, device_t, int, enum intr_trigger,
98 static int nexus_setup_intr(device_t, device_t, struct resource *, int flags,
99 void (*)(void *), void *, void **, lwkt_serialize_t,
101 static int nexus_teardown_intr(device_t, device_t, struct resource *,
103 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 int nexus_alloc_msi(device_t, device_t, int, int, int *, int);
109 static int nexus_release_msi(device_t, device_t, int, int *, int);
110 static int nexus_map_msi(device_t, device_t, int, uint64_t *, uint32_t *, int);
111 static int nexus_alloc_msix(device_t, device_t, int *, int);
112 static int nexus_release_msix(device_t, device_t, int, int);
115 * The device_identify method will cause nexus to automatically associate
116 * and attach to the root bus.
118 static device_method_t nexus_methods[] = {
119 /* Device interface */
120 DEVMETHOD(device_identify, bus_generic_identify),
121 DEVMETHOD(device_probe, nexus_probe),
122 DEVMETHOD(device_attach, nexus_attach),
123 DEVMETHOD(device_detach, bus_generic_detach),
124 DEVMETHOD(device_shutdown, bus_generic_shutdown),
125 DEVMETHOD(device_suspend, bus_generic_suspend),
126 DEVMETHOD(device_resume, bus_generic_resume),
129 DEVMETHOD(bus_print_child, nexus_print_child),
130 DEVMETHOD(bus_add_child, nexus_add_child),
131 DEVMETHOD(bus_read_ivar, nexus_read_ivar),
132 DEVMETHOD(bus_write_ivar, nexus_write_ivar),
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_config_intr, nexus_config_intr),
138 DEVMETHOD(bus_setup_intr, nexus_setup_intr),
139 DEVMETHOD(bus_teardown_intr, nexus_teardown_intr),
140 DEVMETHOD(bus_set_resource, nexus_set_resource),
141 DEVMETHOD(bus_get_resource, nexus_get_resource),
142 DEVMETHOD(bus_delete_resource, nexus_delete_resource),
144 DEVMETHOD(pcib_alloc_msi, nexus_alloc_msi),
145 DEVMETHOD(pcib_release_msi, nexus_release_msi),
146 DEVMETHOD(pcib_map_msi, nexus_map_msi),
147 DEVMETHOD(pcib_alloc_msix, nexus_alloc_msix),
148 DEVMETHOD(pcib_release_msix, nexus_release_msix),
153 static driver_t nexus_driver = {
158 static devclass_t nexus_devclass;
160 DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, NULL, NULL);
163 nexus_probe(device_t dev)
167 device_quiet(dev); /* suppress attach message for neatness */
169 for (cpuid = 0; cpuid < ncpus; ++cpuid) {
170 struct rman *rm = &irq_rman[cpuid];
173 rm->rm_end = IDT_HWI_VECTORS - 1;
174 rm->rm_type = RMAN_ARRAY;
175 rm->rm_descr = "Interrupt request lines";
177 if (rman_init(rm, cpuid))
178 panic("nexus_probe rman_init");
179 MachIntrABI.rman_setup(rm);
183 * ISA DMA on PCI systems is implemented in the ISA part of each
184 * PCI->ISA bridge and the channels can be duplicated if there are
185 * multiple bridges. (eg: laptops with docking stations)
187 drq_rman.rm_start = 0;
189 drq_rman.rm_type = RMAN_ARRAY;
190 drq_rman.rm_descr = "DMA request lines";
191 /* XXX drq 0 not available on some machines */
192 if (rman_init(&drq_rman, -1)
193 || rman_manage_region(&drq_rman,
194 drq_rman.rm_start, drq_rman.rm_end))
195 panic("nexus_probe drq_rman");
198 * However, IO ports and Memory truely are global at this level,
199 * as are APIC interrupts (however many IO APICS there turn out
200 * to be on large systems..)
202 port_rman.rm_start = 0;
203 port_rman.rm_end = 0xffff;
204 port_rman.rm_type = RMAN_ARRAY;
205 port_rman.rm_descr = "I/O ports";
206 if (rman_init(&port_rman, -1)
207 || rman_manage_region(&port_rman, 0, 0xffff))
208 panic("nexus_probe port_rman");
210 mem_rman.rm_start = 0;
211 mem_rman.rm_end = ~0u;
212 mem_rman.rm_type = RMAN_ARRAY;
213 mem_rman.rm_descr = "I/O memory addresses";
214 if (rman_init(&mem_rman, -1)
215 || rman_manage_region(&mem_rman, 0, ~0))
216 panic("nexus_probe mem_rman");
218 return bus_generic_probe(dev);
222 nexus_attach(device_t dev)
227 * First, let our child driver's identify any child devices that
228 * they can find. Once that is done attach any devices that we
232 bus_generic_probe(dev);
234 bus_generic_attach(dev);
237 * And if we didn't see ISA on a pci bridge, create a
238 * connection point now so it shows up "on motherboard".
240 if (!devclass_get_device(devclass_find("isa"), 0)) {
241 child = BUS_ADD_CHILD(dev, dev, 0, "isa", 0);
243 panic("nexus_attach isa");
244 device_probe_and_attach(child);
251 nexus_print_all_resources(device_t dev)
253 struct nexus_device *ndev = DEVTONX(dev);
254 struct resource_list *rl = &ndev->nx_resources;
257 if (SLIST_FIRST(rl) || ndev->nx_pcibus != -1)
258 retval += kprintf(" at");
260 retval += resource_list_print_type(rl, "port", SYS_RES_IOPORT, "%#lx");
261 retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#lx");
262 retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld");
268 nexus_print_child(device_t bus, device_t child)
270 struct nexus_device *ndev = DEVTONX(child);
273 retval += bus_print_child_header(bus, child);
274 retval += nexus_print_all_resources(child);
275 if (ndev->nx_pcibus != -1)
276 retval += kprintf(" pcibus %d", ndev->nx_pcibus);
277 retval += kprintf(" on motherboard\n");
283 nexus_add_child(device_t bus, device_t parent, int order,
284 const char *name, int unit)
287 struct nexus_device *ndev;
289 ndev = kmalloc(sizeof(struct nexus_device), M_NEXUSDEV, M_INTWAIT|M_ZERO);
292 resource_list_init(&ndev->nx_resources);
293 ndev->nx_pcibus = -1;
295 child = device_add_child_ordered(parent, order, name, unit);
297 /* should we free this in nexus_child_detached? */
298 device_set_ivars(child, ndev);
304 nexus_read_ivar(device_t dev, device_t child, int which, uintptr_t *result)
306 struct nexus_device *ndev = DEVTONX(child);
309 case NEXUS_IVAR_PCIBUS:
310 *result = ndev->nx_pcibus;
319 nexus_write_ivar(device_t dev, device_t child, int which, uintptr_t value)
321 struct nexus_device *ndev = DEVTONX(child);
324 case NEXUS_IVAR_PCIBUS:
325 ndev->nx_pcibus = value;
334 * Allocate a resource on behalf of child. NB: child is usually going to be a
335 * child of one of our descendants, not a direct child of nexus0.
336 * (Exceptions include npx.)
338 static struct resource *
339 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid,
340 u_long start, u_long end, u_long count, u_int flags, int cpuid)
342 struct nexus_device *ndev = DEVTONX(child);
344 struct resource_list_entry *rle;
346 int needactivate = flags & RF_ACTIVE;
349 * If this is an allocation of the "default" range for a given RID, and
350 * we know what the resources for this device are (ie. they aren't maintained
351 * by a child bus), then work out the start/end values.
353 if ((start == 0UL) && (end == ~0UL) && (count == 1)) {
356 rle = resource_list_find(&ndev->nx_resources, type, *rid);
369 KASSERT(cpuid >= 0 && cpuid < ncpus,
370 ("nexus invalid cpuid: %d", cpuid));
371 rm = &irq_rman[cpuid];
390 rv = rman_reserve_resource(rm, start, end, count, flags, child);
393 rman_set_rid(rv, *rid);
395 if (type == SYS_RES_MEMORY) {
396 rman_set_bustag(rv, I386_BUS_SPACE_MEM);
397 } else if (type == SYS_RES_IOPORT) {
398 rman_set_bustag(rv, I386_BUS_SPACE_IO);
399 rman_set_bushandle(rv, rv->r_start);
403 if (bus_activate_resource(child, type, *rid, rv)) {
404 rman_release_resource(rv);
413 nexus_activate_resource(device_t bus, device_t child, int type, int rid,
417 * If this is a memory resource, map it into the kernel.
419 if (rman_get_bustag(r) == I386_BUS_SPACE_MEM) {
422 if (rman_get_end(r) < 1024 * 1024) {
424 * The first 1Mb is mapped at KERNBASE.
426 vaddr = (caddr_t)(uintptr_t)(KERNBASE + rman_get_start(r));
432 paddr = rman_get_start(r);
433 psize = rman_get_size(r);
435 poffs = paddr - trunc_page(paddr);
436 vaddr = (caddr_t) pmap_mapdev(paddr-poffs, psize+poffs) + poffs;
438 rman_set_virtual(r, vaddr);
439 /* IBM-PC: the type of bus_space_handle_t is u_int */
440 rman_set_bushandle(r, (bus_space_handle_t) vaddr);
442 return (rman_activate_resource(r));
446 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid,
450 * If this is a memory resource, unmap it.
452 if ((rman_get_bustag(r) == I386_BUS_SPACE_MEM) &&
453 (rman_get_end(r) >= 1024 * 1024)) {
456 psize = rman_get_size(r);
457 pmap_unmapdev((vm_offset_t)rman_get_virtual(r), psize);
460 return (rman_deactivate_resource(r));
464 nexus_release_resource(device_t bus, device_t child, int type, int rid,
467 if (rman_get_flags(r) & RF_ACTIVE) {
468 int error = bus_deactivate_resource(child, type, rid, r);
472 return (rman_release_resource(r));
476 nexus_config_intr(device_t bus, device_t chile, int irq,
477 enum intr_trigger trig, enum intr_polarity pola)
479 machintr_legacy_intr_config(irq, trig, pola);
484 * Currently this uses the really grody interface from kern/kern_intr.c
485 * (which really doesn't belong in kern/anything.c). Eventually, all of
486 * the code in kern_intr.c and machdep_intr.c should get moved here, since
487 * this is going to be the official interface.
490 nexus_setup_intr(device_t bus, device_t child, struct resource *irq,
491 int flags, void (*ihand)(void *), void *arg, void **cookiep,
492 lwkt_serialize_t serializer, const char *desc)
496 /* somebody tried to setup an irq that failed to allocate! */
498 panic("nexus_setup_intr: NULL irq resource!");
502 if ((irq->r_flags & RF_SHAREABLE) == 0)
503 icflags |= INTR_EXCL;
506 * We depend here on rman_activate_resource() being idempotent.
508 error = rman_activate_resource(irq);
512 /* Use device name, if description is not specified */
514 desc = device_get_nameunit(child);
517 * XXX cast the interrupt handler function to an inthand2_t. The
518 * difference is that an additional frame argument is passed which
519 * we do not currently want to expose the BUS subsystem to.
521 *cookiep = register_int(irq->r_start, (inthand2_t *)ihand, arg,
522 desc, serializer, icflags, rman_get_cpuid(irq));
523 if (*cookiep == NULL)
529 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih)
532 unregister_int(ih, rman_get_cpuid(r));
539 nexus_set_resource(device_t dev, device_t child, int type, int rid,
540 u_long start, u_long count, int cpuid)
542 struct nexus_device *ndev = DEVTONX(child);
543 struct resource_list *rl = &ndev->nx_resources;
545 /* XXX this should return a success/failure indicator */
546 resource_list_add(rl, type, rid, start, start + count - 1, count,
552 nexus_get_resource(device_t dev, device_t child, int type, int rid, u_long *startp, u_long *countp)
554 struct nexus_device *ndev = DEVTONX(child);
555 struct resource_list *rl = &ndev->nx_resources;
556 struct resource_list_entry *rle;
558 rle = resource_list_find(rl, type, rid);
559 device_printf(child, "type %d rid %d startp %p countp %p - got %p\n",
560 type, rid, startp, countp, rle);
564 *startp = rle->start;
566 *countp = rle->count;
571 nexus_delete_resource(device_t dev, device_t child, int type, int rid)
573 struct nexus_device *ndev = DEVTONX(child);
574 struct resource_list *rl = &ndev->nx_resources;
576 resource_list_delete(rl, type, rid);
580 nexus_alloc_msi(device_t dev, device_t child, int count, int maxcount,
581 int *irqs, int cpuid)
586 return MachIntrABI.msi_alloc(irqs, count, cpuid);
590 nexus_release_msi(device_t dev, device_t child, int count, int *irqs, int cpuid)
592 KKASSERT(lapic_enable);
593 MachIntrABI.msi_release(irqs, count, cpuid);
598 nexus_map_msi(device_t dev, device_t child, int irq, uint64_t *addr,
599 uint32_t *data, int cpuid)
601 KKASSERT(lapic_enable);
602 MachIntrABI.msi_map(irq, addr, data, cpuid);
607 nexus_alloc_msix(device_t dev, device_t child, int *irq, int cpuid)
612 return MachIntrABI.msix_alloc(irq, cpuid);
616 nexus_release_msix(device_t dev, device_t child, int irq, int cpuid)
618 KKASSERT(lapic_enable);
619 MachIntrABI.msix_release(irq, cpuid);