1 /* 2 * Copyright 2002 by Peter Grehan. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 1. Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * 2. Redistributions in binary form must reproduce the above copyright 10 * notice, this list of conditions and the following disclaimer in the 11 * documentation and/or other materials provided with the distribution. 12 * 3. The name of the author may not be used to endorse or promote products 13 * derived from this software without specific prior written permission. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 20 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 21 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 22 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 23 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25 * SUCH DAMAGE. 26 * 27 * $FreeBSD$ 28 */ 29 30 /* 31 * Driver for KeyLargo/Pangea, the MacPPC south bridge ASIC. 32 */ 33 34 #include <sys/param.h> 35 #include <sys/systm.h> 36 #include <sys/kernel.h> 37 #include <sys/malloc.h> 38 #include <sys/bus.h> 39 #include <machine/bus.h> 40 #include <sys/rman.h> 41 42 #include <machine/vmparam.h> 43 #include <vm/vm.h> 44 #include <vm/pmap.h> 45 #include <machine/pmap.h> 46 47 #include <machine/resource.h> 48 49 #include <dev/ofw/openfirm.h> 50 51 #include <powerpc/powermac/maciovar.h> 52 53 #include <dev/pci/pcivar.h> 54 #include <dev/pci/pcireg.h> 55 56 static MALLOC_DEFINE(M_MACIO, "macio", "macio device information"); 57 58 static int macio_probe(device_t); 59 static int macio_attach(device_t); 60 static int macio_print_child(device_t dev, device_t child); 61 static void macio_probe_nomatch(device_t, device_t); 62 static int macio_read_ivar(device_t, device_t, int, uintptr_t *); 63 static int macio_write_ivar(device_t, device_t, int, uintptr_t); 64 static struct resource *macio_alloc_resource(device_t, device_t, int, int *, 65 u_long, u_long, u_long, u_int); 66 static int macio_activate_resource(device_t, device_t, int, int, 67 struct resource *); 68 static int macio_deactivate_resource(device_t, device_t, int, int, 69 struct resource *); 70 static int macio_release_resource(device_t, device_t, int, int, 71 struct resource *); 72 static struct resource_list *macio_get_resource_list (device_t, device_t); 73 74 /* 75 * Bus interface definition 76 */ 77 static device_method_t macio_methods[] = { 78 /* Device interface */ 79 DEVMETHOD(device_probe, macio_probe), 80 DEVMETHOD(device_attach, macio_attach), 81 DEVMETHOD(device_detach, bus_generic_detach), 82 DEVMETHOD(device_shutdown, bus_generic_shutdown), 83 DEVMETHOD(device_suspend, bus_generic_suspend), 84 DEVMETHOD(device_resume, bus_generic_resume), 85 86 /* Bus interface */ 87 DEVMETHOD(bus_print_child, macio_print_child), 88 DEVMETHOD(bus_probe_nomatch, macio_probe_nomatch), 89 DEVMETHOD(bus_read_ivar, macio_read_ivar), 90 DEVMETHOD(bus_write_ivar, macio_write_ivar), 91 DEVMETHOD(bus_setup_intr, bus_generic_setup_intr), 92 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr), 93 94 DEVMETHOD(bus_alloc_resource, macio_alloc_resource), 95 DEVMETHOD(bus_release_resource, macio_release_resource), 96 DEVMETHOD(bus_activate_resource, macio_activate_resource), 97 DEVMETHOD(bus_deactivate_resource, macio_deactivate_resource), 98 DEVMETHOD(bus_get_resource_list, macio_get_resource_list), 99 100 { 0, 0 } 101 }; 102 103 static driver_t macio_pci_driver = { 104 "macio", 105 macio_methods, 106 sizeof(struct macio_softc) 107 }; 108 109 devclass_t macio_devclass; 110 111 DRIVER_MODULE(macio, pci, macio_pci_driver, macio_devclass, 0, 0); 112 113 /* 114 * PCI ID search table 115 */ 116 static struct macio_pci_dev { 117 u_int32_t mpd_devid; 118 char *mpd_desc; 119 } macio_pci_devlist[] = { 120 { 0x0025106b, "Pangea I/O Controller" }, 121 { 0x0022106b, "KeyLargo I/O Controller" }, 122 { 0, NULL } 123 }; 124 125 /* 126 * Devices to exclude from the probe 127 * XXX some of these may be required in the future... 128 */ 129 #define MACIO_QUIRK_IGNORE 0x00000001 130 #define MACIO_QUIRK_CHILD_HAS_INTR 0x00000002 131 132 struct macio_quirk_entry { 133 const char *mq_name; 134 int mq_quirks; 135 }; 136 137 static struct macio_quirk_entry macio_quirks[] = { 138 { "interrupt-controller", MACIO_QUIRK_IGNORE }, 139 { "escc-legacy", MACIO_QUIRK_IGNORE }, 140 { "timer", MACIO_QUIRK_IGNORE }, 141 { "escc", MACIO_QUIRK_CHILD_HAS_INTR }, 142 { NULL, 0 } 143 }; 144 145 static int 146 macio_get_quirks(const char *name) 147 { 148 struct macio_quirk_entry *mqe; 149 150 for (mqe = macio_quirks; mqe->mq_name != NULL; mqe++) 151 if (strcmp(name, mqe->mq_name) == 0) 152 return (mqe->mq_quirks); 153 return (0); 154 } 155 156 157 /* 158 * Add an interrupt to the dev's resource list if present 159 */ 160 static void 161 macio_add_intr(phandle_t devnode, struct macio_devinfo *dinfo) 162 { 163 int intr; 164 165 if (dinfo->mdi_ninterrupts >= 5) { 166 printf("macio: device has more than 5 interrupts\n"); 167 return; 168 } 169 170 if (OF_getprop(devnode, "interrupts", &intr, sizeof(intr)) == -1) { 171 if (OF_getprop(devnode, "AAPL,interrupts", &intr, 172 sizeof(intr)) == -1) 173 return; 174 } 175 176 if (intr == -1) 177 return; 178 179 resource_list_add(&dinfo->mdi_resources, SYS_RES_IRQ, 180 dinfo->mdi_ninterrupts, intr, intr, 1); 181 182 dinfo->mdi_interrupts[dinfo->mdi_ninterrupts] = intr; 183 dinfo->mdi_ninterrupts++; 184 } 185 186 187 static void 188 macio_add_reg(phandle_t devnode, struct macio_devinfo *dinfo) 189 { 190 struct macio_reg *reg; 191 int i, nreg; 192 193 nreg = OF_getprop_alloc(devnode, "reg", sizeof(*reg), (void **)®); 194 if (nreg == -1) 195 return; 196 197 dinfo->mdi_nregs = nreg; 198 dinfo->mdi_regs = reg; 199 200 for (i = 0; i < nreg; i++) { 201 resource_list_add(&dinfo->mdi_resources, SYS_RES_MEMORY, i, 202 reg[i].mr_base, reg[i].mr_base + reg[i].mr_size, 203 reg[i].mr_size); 204 } 205 } 206 207 /* 208 * PCI probe 209 */ 210 static int 211 macio_probe(device_t dev) 212 { 213 int i; 214 u_int32_t devid; 215 216 devid = pci_get_devid(dev); 217 for (i = 0; macio_pci_devlist[i].mpd_desc != NULL; i++) { 218 if (devid == macio_pci_devlist[i].mpd_devid) { 219 device_set_desc(dev, macio_pci_devlist[i].mpd_desc); 220 return (0); 221 } 222 } 223 224 return (ENXIO); 225 } 226 227 /* 228 * PCI attach: scan OpenFirmware child nodes, and attach these as children 229 * of the macio bus 230 */ 231 static int 232 macio_attach(device_t dev) 233 { 234 struct macio_softc *sc; 235 struct macio_devinfo *dinfo; 236 phandle_t root; 237 phandle_t child; 238 phandle_t subchild; 239 device_t cdev; 240 u_int reg[3]; 241 char *name, *type; 242 int quirks; 243 244 sc = device_get_softc(dev); 245 root = sc->sc_node = OF_finddevice("mac-io"); 246 247 /* 248 * Locate the device node and it's base address 249 */ 250 if (OF_getprop(root, "assigned-addresses", 251 reg, sizeof(reg)) < sizeof(reg)) { 252 return (ENXIO); 253 } 254 255 sc->sc_base = reg[2]; 256 sc->sc_size = MACIO_REG_SIZE; 257 258 sc->sc_mem_rman.rm_type = RMAN_ARRAY; 259 sc->sc_mem_rman.rm_descr = "MacIO Device Memory"; 260 if (rman_init(&sc->sc_mem_rman) != 0) { 261 device_printf(dev, 262 "failed to init mem range resources\n"); 263 return (ENXIO); 264 } 265 rman_manage_region(&sc->sc_mem_rman, 0, sc->sc_size); 266 267 /* 268 * Iterate through the sub-devices 269 */ 270 for (child = OF_child(root); child != 0; child = OF_peer(child)) { 271 OF_getprop_alloc(child, "name", 1, (void **)&name); 272 OF_getprop_alloc(child, "device_type", 1, (void **)&type); 273 274 quirks = macio_get_quirks(name); 275 if ((quirks & MACIO_QUIRK_IGNORE) != 0) { 276 free(name, M_OFWPROP); 277 free(type, M_OFWPROP); 278 continue; 279 } 280 281 cdev = device_add_child(dev, NULL, -1); 282 if (cdev != NULL) { 283 dinfo = malloc(sizeof(*dinfo), M_MACIO, 0); 284 memset(dinfo, 0, sizeof(*dinfo)); 285 resource_list_init(&dinfo->mdi_resources); 286 dinfo->mdi_node = child; 287 dinfo->mdi_name = name; 288 dinfo->mdi_device_type = type; 289 dinfo->mdi_ninterrupts = 0; 290 macio_add_intr(child, dinfo); 291 macio_add_reg(child, dinfo); 292 293 294 if ((quirks & MACIO_QUIRK_CHILD_HAS_INTR) != 0) { 295 for (subchild = OF_child(child); subchild != 0; 296 subchild = OF_peer(subchild)) { 297 macio_add_intr(subchild, dinfo); 298 } 299 } 300 301 device_set_ivars(cdev, dinfo); 302 } else { 303 free(name, M_OFWPROP); 304 free(type, M_OFWPROP); 305 } 306 } 307 308 return (bus_generic_attach(dev)); 309 } 310 311 312 static int 313 macio_print_child(device_t dev, device_t child) 314 { 315 struct macio_devinfo *dinfo; 316 struct resource_list *rl; 317 int retval = 0; 318 319 dinfo = device_get_ivars(child); 320 rl = &dinfo->mdi_resources; 321 322 retval += bus_print_child_header(dev, child); 323 324 retval += resource_list_print_type(rl, "mem", SYS_RES_MEMORY, "%#lx"); 325 retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld"); 326 327 retval += bus_print_child_footer(dev, child); 328 329 return (retval); 330 } 331 332 333 static void 334 macio_probe_nomatch(device_t dev, device_t child) 335 { 336 struct macio_devinfo *dinfo; 337 struct resource_list *rl; 338 339 if (bootverbose) { 340 dinfo = device_get_ivars(child); 341 rl = &dinfo->mdi_resources; 342 343 device_printf(dev, "<%s, %s>", macio_get_devtype(child), 344 macio_get_name(child)); 345 resource_list_print_type(rl, "mem", SYS_RES_MEMORY, "%#lx"); 346 resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld"); 347 printf(" (no driver attached)\n"); 348 } 349 } 350 351 352 static int 353 macio_read_ivar(device_t dev, device_t child, int which, uintptr_t *result) 354 { 355 struct macio_devinfo *dinfo; 356 357 if ((dinfo = device_get_ivars(child)) == 0) 358 return (ENOENT); 359 360 switch (which) { 361 case MACIO_IVAR_NODE: 362 *result = dinfo->mdi_node; 363 break; 364 case MACIO_IVAR_NAME: 365 *result = (uintptr_t)dinfo->mdi_name; 366 break; 367 case MACIO_IVAR_DEVTYPE: 368 *result = (uintptr_t)dinfo->mdi_device_type; 369 break; 370 case MACIO_IVAR_NREGS: 371 *result = dinfo->mdi_nregs; 372 break; 373 case MACIO_IVAR_REGS: 374 *result = (uintptr_t)dinfo->mdi_regs; 375 break; 376 default: 377 return (ENOENT); 378 } 379 380 return (0); 381 } 382 383 384 static int 385 macio_write_ivar(device_t dev, device_t child, int which, uintptr_t value) 386 { 387 return (EINVAL); 388 } 389 390 391 static struct resource * 392 macio_alloc_resource(device_t bus, device_t child, int type, int *rid, 393 u_long start, u_long end, u_long count, u_int flags) 394 { 395 struct macio_softc *sc; 396 int needactivate; 397 struct resource *rv; 398 struct rman *rm; 399 bus_space_tag_t tagval; 400 u_long adjstart, adjend, adjcount; 401 struct macio_devinfo *dinfo; 402 struct resource_list_entry *rle; 403 404 sc = device_get_softc(bus); 405 dinfo = device_get_ivars(child); 406 407 needactivate = flags & RF_ACTIVE; 408 flags &= ~RF_ACTIVE; 409 410 switch (type) { 411 case SYS_RES_MEMORY: 412 case SYS_RES_IOPORT: 413 rle = resource_list_find(&dinfo->mdi_resources, SYS_RES_MEMORY, 414 *rid); 415 if (rle == NULL) { 416 device_printf(bus, "no rle for %s memory %d\n", 417 device_get_nameunit(child), *rid); 418 return (NULL); 419 } 420 421 if (start < rle->start) 422 adjstart = rle->start; 423 else if (start > rle->end) 424 adjstart = rle->end; 425 else 426 adjstart = start; 427 428 if (end < rle->start) 429 adjend = rle->start; 430 else if (end > rle->end) 431 adjend = rle->end; 432 else 433 adjend = end; 434 435 adjcount = adjend - adjstart; 436 437 rm = &sc->sc_mem_rman; 438 439 tagval = PPC_BUS_SPACE_MEM; 440 if (flags & PPC_BUS_SPARSE4) 441 tagval |= 4; 442 443 break; 444 445 case SYS_RES_IRQ: 446 rle = resource_list_find(&dinfo->mdi_resources, SYS_RES_IRQ, 447 *rid); 448 if (rle == NULL) { 449 if (dinfo->mdi_ninterrupts >= 5) { 450 device_printf(bus, 451 "%s has more than 5 interrupts\n", 452 device_get_nameunit(child)); 453 return (NULL); 454 } 455 resource_list_add(&dinfo->mdi_resources, SYS_RES_IRQ, 456 dinfo->mdi_ninterrupts, start, start, 1); 457 458 dinfo->mdi_interrupts[dinfo->mdi_ninterrupts] = start; 459 dinfo->mdi_ninterrupts++; 460 } 461 462 return (resource_list_alloc(&dinfo->mdi_resources, bus, child, 463 type, rid, start, end, count, flags)); 464 break; 465 466 default: 467 device_printf(bus, "unknown resource request from %s\n", 468 device_get_nameunit(child)); 469 return (NULL); 470 } 471 472 rv = rman_reserve_resource(rm, adjstart, adjend, adjcount, flags, 473 child); 474 if (rv == NULL) { 475 device_printf(bus, 476 "failed to reserve resource %#lx - %#lx (%#lx) for %s\n", 477 adjstart, adjend, adjcount, device_get_nameunit(child)); 478 return (NULL); 479 } 480 481 rman_set_bustag(rv, tagval); 482 rman_set_bushandle(rv, rman_get_start(rv)); 483 484 if (needactivate) { 485 if (bus_activate_resource(child, type, *rid, rv) != 0) { 486 device_printf(bus, 487 "failed to activate resource for %s\n", 488 device_get_nameunit(child)); 489 rman_release_resource(rv); 490 return (NULL); 491 } 492 } 493 494 return (rv); 495 } 496 497 498 static int 499 macio_release_resource(device_t bus, device_t child, int type, int rid, 500 struct resource *res) 501 { 502 if (rman_get_flags(res) & RF_ACTIVE) { 503 int error = bus_deactivate_resource(child, type, rid, res); 504 if (error) 505 return error; 506 } 507 508 return (rman_release_resource(res)); 509 } 510 511 512 static int 513 macio_activate_resource(device_t bus, device_t child, int type, int rid, 514 struct resource *res) 515 { 516 struct macio_softc *sc; 517 void *p; 518 519 sc = device_get_softc(bus); 520 521 if (type == SYS_RES_IRQ) 522 return (bus_activate_resource(bus, type, rid, res)); 523 524 if ((type == SYS_RES_MEMORY) || (type == SYS_RES_IOPORT)) { 525 p = pmap_mapdev((vm_offset_t)rman_get_start(res) + sc->sc_base, 526 (vm_size_t)rman_get_size(res)); 527 if (p == NULL) 528 return (ENOMEM); 529 rman_set_virtual(res, p); 530 rman_set_bushandle(res, (u_long)p); 531 } 532 533 return (rman_activate_resource(res)); 534 } 535 536 537 static int 538 macio_deactivate_resource(device_t bus, device_t child, int type, int rid, 539 struct resource *res) 540 { 541 /* 542 * If this is a memory resource, unmap it. 543 */ 544 if ((type == SYS_RES_MEMORY) || (type == SYS_RES_IOPORT)) { 545 u_int32_t psize; 546 547 psize = rman_get_size(res); 548 pmap_unmapdev((vm_offset_t)rman_get_virtual(res), psize); 549 } 550 551 return (rman_deactivate_resource(res)); 552 } 553 554 555 static struct resource_list * 556 macio_get_resource_list (device_t dev, device_t child) 557 { 558 struct macio_devinfo *dinfo = device_get_ivars(child); 559 struct resource_list *rl = &dinfo->mdi_resources; 560 561 if (!rl) 562 return (NULL); 563 564 return (rl); 565 } 566