1 /* 2 * Copyright 1998 Massachusetts Institute of Technology 3 * Copyright (c) 2008 The DragonFly Project. 4 * 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 15 * warranty. 16 * 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 28 * SUCH DAMAGE. 29 * 30 * $FreeBSD: src/sys/i386/i386/nexus.c,v 1.26.2.10 2003/02/22 13:16:45 imp Exp $ 31 */ 32 33 /* 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. 42 */ 43 44 #include <sys/param.h> 45 #include <sys/systm.h> 46 #include <sys/bus.h> 47 #include <sys/kernel.h> 48 #include <sys/malloc.h> 49 #include <sys/module.h> 50 #include <sys/rman.h> 51 #include <sys/interrupt.h> 52 #include <sys/machintr.h> 53 54 #include <machine/vmparam.h> 55 #include <vm/vm.h> 56 #include <vm/pmap.h> 57 #include <machine/pmap.h> 58 59 #include <machine/nexusvar.h> 60 #include <machine/smp.h> 61 #include <machine/intr_machdep.h> 62 #include <machine_base/apic/ioapic.h> 63 64 #define I386_BUS_SPACE_IO 0 /* space is i/o space */ 65 #define I386_BUS_SPACE_MEM 1 /* space is mem space */ 66 67 static MALLOC_DEFINE(M_NEXUSDEV, "nexusdev", "Nexus device"); 68 struct nexus_device { 69 struct resource_list nx_resources; 70 int nx_pcibus; 71 }; 72 73 #define DEVTONX(dev) ((struct nexus_device *)device_get_ivars(dev)) 74 75 static struct rman irq_rman[MAXCPU], drq_rman, port_rman, mem_rman; 76 77 static int nexus_probe(device_t); 78 static int nexus_attach(device_t); 79 static int nexus_print_all_resources(device_t dev); 80 static int nexus_print_child(device_t, device_t); 81 static device_t nexus_add_child(device_t bus, device_t parent, int order, 82 const char *name, int unit); 83 static struct resource *nexus_alloc_resource(device_t, device_t, int, int *, 84 u_long, u_long, u_long, u_int, int); 85 static int nexus_read_ivar(device_t, device_t, int, uintptr_t *); 86 static int nexus_write_ivar(device_t, device_t, int, uintptr_t); 87 static int nexus_activate_resource(device_t, device_t, int, int, 88 struct resource *); 89 static int nexus_deactivate_resource(device_t, device_t, int, int, 90 struct resource *); 91 static int nexus_release_resource(device_t, device_t, int, int, 92 struct resource *); 93 static int nexus_config_intr(device_t, device_t, int, enum intr_trigger, 94 enum intr_polarity); 95 static int nexus_setup_intr(device_t, device_t, struct resource *, int flags, 96 void (*)(void *), void *, 97 void **, lwkt_serialize_t); 98 static int nexus_teardown_intr(device_t, device_t, struct resource *, 99 void *); 100 static int nexus_set_resource(device_t, device_t, int, int, u_long, u_long, 101 int); 102 static int nexus_get_resource(device_t, device_t, int, int, u_long *, u_long *); 103 static void nexus_delete_resource(device_t, device_t, int, int); 104 105 /* 106 * The device_identify method will cause nexus to automatically associate 107 * and attach to the root bus. 108 */ 109 static device_method_t nexus_methods[] = { 110 /* Device interface */ 111 DEVMETHOD(device_identify, bus_generic_identify), 112 DEVMETHOD(device_probe, nexus_probe), 113 DEVMETHOD(device_attach, nexus_attach), 114 DEVMETHOD(device_detach, bus_generic_detach), 115 DEVMETHOD(device_shutdown, bus_generic_shutdown), 116 DEVMETHOD(device_suspend, bus_generic_suspend), 117 DEVMETHOD(device_resume, bus_generic_resume), 118 119 /* Bus interface */ 120 DEVMETHOD(bus_print_child, nexus_print_child), 121 DEVMETHOD(bus_add_child, nexus_add_child), 122 DEVMETHOD(bus_read_ivar, nexus_read_ivar), 123 DEVMETHOD(bus_write_ivar, nexus_write_ivar), 124 DEVMETHOD(bus_alloc_resource, nexus_alloc_resource), 125 DEVMETHOD(bus_release_resource, nexus_release_resource), 126 DEVMETHOD(bus_activate_resource, nexus_activate_resource), 127 DEVMETHOD(bus_deactivate_resource, nexus_deactivate_resource), 128 DEVMETHOD(bus_config_intr, nexus_config_intr), 129 DEVMETHOD(bus_setup_intr, nexus_setup_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), 134 135 { 0, 0 } 136 }; 137 138 static driver_t nexus_driver = { 139 "nexus", 140 nexus_methods, 141 1, /* no softc */ 142 }; 143 static devclass_t nexus_devclass; 144 145 DRIVER_MODULE(nexus, root, nexus_driver, nexus_devclass, NULL, NULL); 146 147 static int 148 nexus_probe(device_t dev) 149 { 150 int cpuid; 151 152 device_quiet(dev); /* suppress attach message for neatness */ 153 154 for (cpuid = 0; cpuid < ncpus; ++cpuid) { 155 struct rman *rm = &irq_rman[cpuid]; 156 157 /* 158 * IRQ's are on the mainboard on old systems, but on 159 * the ISA part of PCI->ISA bridges. There would be 160 * multiple sets of IRQs on multi-ISA-bus systems. 161 * PCI interrupts are routed to the ISA component, 162 * so in a way, PCI can be a partial child of an ISA 163 * bus(!). APIC interrupts are global though. In the 164 * non-APIC case, disallow the use of IRQ 2. 165 */ 166 rm->rm_start = 0; 167 rm->rm_type = RMAN_ARRAY; 168 rm->rm_descr = "Interrupt request lines"; 169 170 /* 171 * XXX should use MachIntrABI.rman_setup 172 */ 173 if (ioapic_enable) { 174 rm->rm_end = IDT_HWI_VECTORS - 1; 175 if (rman_init(rm, cpuid) || 176 rman_manage_region(rm, 177 rm->rm_start, rm->rm_end)) 178 panic("nexus_probe irq_rman"); 179 } else { 180 rm->rm_end = 15; 181 if (rman_init(rm, cpuid) || 182 rman_manage_region(rm, rm->rm_start, 1) || 183 rman_manage_region(rm, 3, rm->rm_end)) 184 panic("nexus_probe irq_rman"); 185 } 186 } 187 188 /* 189 * ISA DMA on PCI systems is implemented in the ISA part of each 190 * PCI->ISA bridge and the channels can be duplicated if there are 191 * multiple bridges. (eg: laptops with docking stations) 192 */ 193 drq_rman.rm_start = 0; 194 drq_rman.rm_end = 7; 195 drq_rman.rm_type = RMAN_ARRAY; 196 drq_rman.rm_descr = "DMA request lines"; 197 /* XXX drq 0 not available on some machines */ 198 if (rman_init(&drq_rman, -1) 199 || rman_manage_region(&drq_rman, 200 drq_rman.rm_start, drq_rman.rm_end)) 201 panic("nexus_probe drq_rman"); 202 203 /* 204 * However, IO ports and Memory truely are global at this level, 205 * as are APIC interrupts (however many IO APICS there turn out 206 * to be on large systems..) 207 */ 208 port_rman.rm_start = 0; 209 port_rman.rm_end = 0xffff; 210 port_rman.rm_type = RMAN_ARRAY; 211 port_rman.rm_descr = "I/O ports"; 212 if (rman_init(&port_rman, -1) 213 || rman_manage_region(&port_rman, 0, 0xffff)) 214 panic("nexus_probe port_rman"); 215 216 mem_rman.rm_start = 0; 217 mem_rman.rm_end = ~0u; 218 mem_rman.rm_type = RMAN_ARRAY; 219 mem_rman.rm_descr = "I/O memory addresses"; 220 if (rman_init(&mem_rman, -1) 221 || rman_manage_region(&mem_rman, 0, ~0)) 222 panic("nexus_probe mem_rman"); 223 224 return bus_generic_probe(dev); 225 } 226 227 static int 228 nexus_attach(device_t dev) 229 { 230 device_t child; 231 232 /* 233 * First, let our child driver's identify any child devices that 234 * they can find. Once that is done attach any devices that we 235 * found. 236 */ 237 #if 0 /* FUTURE */ 238 bus_generic_probe(dev); 239 #endif 240 bus_generic_attach(dev); 241 242 /* 243 * And if we didn't see ISA on a pci bridge, create a 244 * connection point now so it shows up "on motherboard". 245 */ 246 if (!devclass_get_device(devclass_find("isa"), 0)) { 247 child = BUS_ADD_CHILD(dev, dev, 0, "isa", 0); 248 if (child == NULL) 249 panic("nexus_attach isa"); 250 device_probe_and_attach(child); 251 } 252 253 return 0; 254 } 255 256 static int 257 nexus_print_all_resources(device_t dev) 258 { 259 struct nexus_device *ndev = DEVTONX(dev); 260 struct resource_list *rl = &ndev->nx_resources; 261 int retval = 0; 262 263 if (SLIST_FIRST(rl) || ndev->nx_pcibus != -1) 264 retval += kprintf(" at"); 265 266 retval += resource_list_print_type(rl, "port", SYS_RES_IOPORT, "%#lx"); 267 retval += resource_list_print_type(rl, "iomem", SYS_RES_MEMORY, "%#lx"); 268 retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld"); 269 270 return retval; 271 } 272 273 static int 274 nexus_print_child(device_t bus, device_t child) 275 { 276 struct nexus_device *ndev = DEVTONX(child); 277 int retval = 0; 278 279 retval += bus_print_child_header(bus, child); 280 retval += nexus_print_all_resources(child); 281 if (ndev->nx_pcibus != -1) 282 retval += kprintf(" pcibus %d", ndev->nx_pcibus); 283 retval += kprintf(" on motherboard\n"); 284 285 return (retval); 286 } 287 288 static device_t 289 nexus_add_child(device_t bus, device_t parent, int order, 290 const char *name, int unit) 291 { 292 device_t child; 293 struct nexus_device *ndev; 294 295 ndev = kmalloc(sizeof(struct nexus_device), M_NEXUSDEV, M_INTWAIT|M_ZERO); 296 if (!ndev) 297 return(0); 298 resource_list_init(&ndev->nx_resources); 299 ndev->nx_pcibus = -1; 300 301 child = device_add_child_ordered(parent, order, name, unit); 302 303 /* should we free this in nexus_child_detached? */ 304 device_set_ivars(child, ndev); 305 306 return(child); 307 } 308 309 static int 310 nexus_read_ivar(device_t dev, device_t child, int which, uintptr_t *result) 311 { 312 struct nexus_device *ndev = DEVTONX(child); 313 314 switch (which) { 315 case NEXUS_IVAR_PCIBUS: 316 *result = ndev->nx_pcibus; 317 break; 318 default: 319 return ENOENT; 320 } 321 return 0; 322 } 323 324 static int 325 nexus_write_ivar(device_t dev, device_t child, int which, uintptr_t value) 326 { 327 struct nexus_device *ndev = DEVTONX(child); 328 329 switch (which) { 330 case NEXUS_IVAR_PCIBUS: 331 ndev->nx_pcibus = value; 332 break; 333 default: 334 return ENOENT; 335 } 336 return 0; 337 } 338 339 /* 340 * Allocate a resource on behalf of child. NB: child is usually going to be a 341 * child of one of our descendants, not a direct child of nexus0. 342 * (Exceptions include npx.) 343 */ 344 static struct resource * 345 nexus_alloc_resource(device_t bus, device_t child, int type, int *rid, 346 u_long start, u_long end, u_long count, u_int flags, int cpuid) 347 { 348 struct nexus_device *ndev = DEVTONX(child); 349 struct resource *rv; 350 struct resource_list_entry *rle; 351 struct rman *rm; 352 int needactivate = flags & RF_ACTIVE; 353 354 /* 355 * If this is an allocation of the "default" range for a given RID, and 356 * we know what the resources for this device are (ie. they aren't maintained 357 * by a child bus), then work out the start/end values. 358 */ 359 if ((start == 0UL) && (end == ~0UL) && (count == 1)) { 360 if (ndev == NULL) 361 return(NULL); 362 rle = resource_list_find(&ndev->nx_resources, type, *rid); 363 if (rle == NULL) 364 return(NULL); 365 start = rle->start; 366 end = rle->end; 367 count = rle->count; 368 cpuid = rle->cpuid; 369 } 370 371 flags &= ~RF_ACTIVE; 372 373 switch (type) { 374 case SYS_RES_IRQ: 375 if (cpuid < 0 || cpuid >= ncpus) { 376 kprintf("NEXUS cpuid %d:\n", cpuid); 377 print_backtrace(-1); 378 cpuid = 0; /* XXX */ 379 } 380 rm = &irq_rman[cpuid]; 381 break; 382 383 case SYS_RES_DRQ: 384 rm = &drq_rman; 385 break; 386 387 case SYS_RES_IOPORT: 388 rm = &port_rman; 389 break; 390 391 case SYS_RES_MEMORY: 392 rm = &mem_rman; 393 break; 394 395 default: 396 return 0; 397 } 398 399 rv = rman_reserve_resource(rm, start, end, count, flags, child); 400 if (rv == 0) 401 return 0; 402 403 if (type == SYS_RES_MEMORY) { 404 rman_set_bustag(rv, I386_BUS_SPACE_MEM); 405 } else if (type == SYS_RES_IOPORT) { 406 rman_set_bustag(rv, I386_BUS_SPACE_IO); 407 rman_set_bushandle(rv, rv->r_start); 408 } 409 410 if (needactivate) { 411 if (bus_activate_resource(child, type, *rid, rv)) { 412 rman_release_resource(rv); 413 return 0; 414 } 415 } 416 417 return rv; 418 } 419 420 static int 421 nexus_activate_resource(device_t bus, device_t child, int type, int rid, 422 struct resource *r) 423 { 424 /* 425 * If this is a memory resource, map it into the kernel. 426 */ 427 if (rman_get_bustag(r) == I386_BUS_SPACE_MEM) { 428 caddr_t vaddr = 0; 429 430 if (rman_get_end(r) < 1024 * 1024) { 431 /* 432 * The first 1Mb is mapped at KERNBASE. 433 */ 434 vaddr = (caddr_t)(uintptr_t)(KERNBASE + rman_get_start(r)); 435 } else { 436 u_int64_t paddr; 437 u_int64_t psize; 438 u_int32_t poffs; 439 440 paddr = rman_get_start(r); 441 psize = rman_get_size(r); 442 443 poffs = paddr - trunc_page(paddr); 444 vaddr = (caddr_t) pmap_mapdev(paddr-poffs, psize+poffs) + poffs; 445 } 446 rman_set_virtual(r, vaddr); 447 /* IBM-PC: the type of bus_space_handle_t is u_int */ 448 rman_set_bushandle(r, (bus_space_handle_t) vaddr); 449 } 450 return (rman_activate_resource(r)); 451 } 452 453 static int 454 nexus_deactivate_resource(device_t bus, device_t child, int type, int rid, 455 struct resource *r) 456 { 457 /* 458 * If this is a memory resource, unmap it. 459 */ 460 if ((rman_get_bustag(r) == I386_BUS_SPACE_MEM) && 461 (rman_get_end(r) >= 1024 * 1024)) { 462 u_int32_t psize; 463 464 psize = rman_get_size(r); 465 pmap_unmapdev((vm_offset_t)rman_get_virtual(r), psize); 466 } 467 468 return (rman_deactivate_resource(r)); 469 } 470 471 static int 472 nexus_release_resource(device_t bus, device_t child, int type, int rid, 473 struct resource *r) 474 { 475 if (rman_get_flags(r) & RF_ACTIVE) { 476 int error = bus_deactivate_resource(child, type, rid, r); 477 if (error) 478 return error; 479 } 480 return (rman_release_resource(r)); 481 } 482 483 static int 484 nexus_config_intr(device_t bus, device_t chile, int irq, 485 enum intr_trigger trig, enum intr_polarity pola) 486 { 487 machintr_intr_config(irq, trig, pola); 488 return 0; 489 } 490 491 /* 492 * Currently this uses the really grody interface from kern/kern_intr.c 493 * (which really doesn't belong in kern/anything.c). Eventually, all of 494 * the code in kern_intr.c and machdep_intr.c should get moved here, since 495 * this is going to be the official interface. 496 */ 497 static int 498 nexus_setup_intr(device_t bus, device_t child, struct resource *irq, 499 int flags, void (*ihand)(void *), void *arg, 500 void **cookiep, lwkt_serialize_t serializer) 501 { 502 int error, icflags; 503 504 /* somebody tried to setup an irq that failed to allocate! */ 505 if (irq == NULL) 506 panic("nexus_setup_intr: NULL irq resource!"); 507 508 *cookiep = 0; 509 icflags = flags; 510 if ((irq->r_flags & RF_SHAREABLE) == 0) 511 icflags |= INTR_EXCL; 512 513 /* 514 * We depend here on rman_activate_resource() being idempotent. 515 */ 516 error = rman_activate_resource(irq); 517 if (error) 518 return (error); 519 520 /* 521 * XXX cast the interrupt handler function to an inthand2_t. The 522 * difference is that an additional frame argument is passed which 523 * we do not currently want to expose the BUS subsystem to. 524 */ 525 *cookiep = register_int(irq->r_start, (inthand2_t *)ihand, arg, 526 device_get_nameunit(child), serializer, 527 icflags, rman_get_cpuid(irq)); 528 if (*cookiep == NULL) 529 error = EINVAL; 530 return (error); 531 } 532 533 static int 534 nexus_teardown_intr(device_t dev, device_t child, struct resource *r, void *ih) 535 { 536 if (ih) { 537 unregister_int(ih, rman_get_cpuid(r)); 538 return (0); 539 } 540 return(-1); 541 } 542 543 static int 544 nexus_set_resource(device_t dev, device_t child, int type, int rid, 545 u_long start, u_long count, int cpuid) 546 { 547 struct nexus_device *ndev = DEVTONX(child); 548 struct resource_list *rl = &ndev->nx_resources; 549 550 /* XXX this should return a success/failure indicator */ 551 resource_list_add(rl, type, rid, start, start + count - 1, count, 552 cpuid); 553 return(0); 554 } 555 556 static int 557 nexus_get_resource(device_t dev, device_t child, int type, int rid, u_long *startp, u_long *countp) 558 { 559 struct nexus_device *ndev = DEVTONX(child); 560 struct resource_list *rl = &ndev->nx_resources; 561 struct resource_list_entry *rle; 562 563 rle = resource_list_find(rl, type, rid); 564 device_printf(child, "type %d rid %d startp %p countp %p - got %p\n", 565 type, rid, startp, countp, rle); 566 if (!rle) 567 return(ENOENT); 568 if (startp) 569 *startp = rle->start; 570 if (countp) 571 *countp = rle->count; 572 return(0); 573 } 574 575 static void 576 nexus_delete_resource(device_t dev, device_t child, int type, int rid) 577 { 578 struct nexus_device *ndev = DEVTONX(child); 579 struct resource_list *rl = &ndev->nx_resources; 580 581 resource_list_delete(rl, type, rid); 582 } 583 584