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