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