1 /*- 2 * Copyright (C) 2002 Benno Rice. 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY Benno Rice ``AS IS'' AND ANY EXPRESS OR 15 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 16 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 17 * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 18 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 20 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 21 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 22 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 23 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 24 * 25 * $FreeBSD$ 26 */ 27 28 #include <sys/param.h> 29 #include <sys/systm.h> 30 #include <sys/module.h> 31 #include <sys/bus.h> 32 #include <sys/conf.h> 33 #include <sys/kernel.h> 34 35 #include <dev/ofw/openfirm.h> 36 #include <dev/ofw/ofw_pci.h> 37 #include <dev/ofw/ofw_bus.h> 38 #include <dev/ofw/ofw_bus_subr.h> 39 40 #include <dev/pci/pcivar.h> 41 #include <dev/pci/pcireg.h> 42 43 #include <machine/bus.h> 44 #include <machine/intr_machdep.h> 45 #include <machine/md_var.h> 46 #include <machine/pio.h> 47 #include <machine/resource.h> 48 49 #include <sys/rman.h> 50 51 #include <powerpc/powermac/uninorthvar.h> 52 53 #include <vm/vm.h> 54 #include <vm/pmap.h> 55 56 /* 57 * Driver for the Uninorth chip itself. 58 */ 59 60 static MALLOC_DEFINE(M_UNIN, "unin", "unin device information"); 61 62 /* 63 * Device interface. 64 */ 65 66 static int unin_chip_probe(device_t); 67 static int unin_chip_attach(device_t); 68 69 /* 70 * Bus interface. 71 */ 72 static int unin_chip_print_child(device_t dev, device_t child); 73 static void unin_chip_probe_nomatch(device_t, device_t); 74 static struct resource *unin_chip_alloc_resource(device_t, device_t, int, int *, 75 u_long, u_long, u_long, u_int); 76 static int unin_chip_activate_resource(device_t, device_t, int, int, 77 struct resource *); 78 static int unin_chip_deactivate_resource(device_t, device_t, int, int, 79 struct resource *); 80 static int unin_chip_release_resource(device_t, device_t, int, int, 81 struct resource *); 82 static struct resource_list *unin_chip_get_resource_list (device_t, device_t); 83 84 /* 85 * OFW Bus interface 86 */ 87 88 static ofw_bus_get_devinfo_t unin_chip_get_devinfo; 89 90 /* 91 * Local routines 92 */ 93 94 static void unin_enable_gmac(device_t dev); 95 static void unin_enable_mpic(device_t dev); 96 97 /* 98 * Driver methods. 99 */ 100 static device_method_t unin_chip_methods[] = { 101 102 /* Device interface */ 103 DEVMETHOD(device_probe, unin_chip_probe), 104 DEVMETHOD(device_attach, unin_chip_attach), 105 106 /* Bus interface */ 107 DEVMETHOD(bus_print_child, unin_chip_print_child), 108 DEVMETHOD(bus_probe_nomatch, unin_chip_probe_nomatch), 109 DEVMETHOD(bus_setup_intr, bus_generic_setup_intr), 110 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr), 111 112 DEVMETHOD(bus_alloc_resource, unin_chip_alloc_resource), 113 DEVMETHOD(bus_release_resource, unin_chip_release_resource), 114 DEVMETHOD(bus_activate_resource, unin_chip_activate_resource), 115 DEVMETHOD(bus_deactivate_resource, unin_chip_deactivate_resource), 116 DEVMETHOD(bus_get_resource_list, unin_chip_get_resource_list), 117 118 DEVMETHOD(bus_child_pnpinfo_str, ofw_bus_gen_child_pnpinfo_str), 119 120 /* ofw_bus interface */ 121 DEVMETHOD(ofw_bus_get_devinfo, unin_chip_get_devinfo), 122 DEVMETHOD(ofw_bus_get_compat, ofw_bus_gen_get_compat), 123 DEVMETHOD(ofw_bus_get_model, ofw_bus_gen_get_model), 124 DEVMETHOD(ofw_bus_get_name, ofw_bus_gen_get_name), 125 DEVMETHOD(ofw_bus_get_node, ofw_bus_gen_get_node), 126 DEVMETHOD(ofw_bus_get_type, ofw_bus_gen_get_type), 127 128 { 0, 0 } 129 }; 130 131 static driver_t unin_chip_driver = { 132 "unin", 133 unin_chip_methods, 134 sizeof(struct unin_chip_softc) 135 }; 136 137 static devclass_t unin_chip_devclass; 138 139 DRIVER_MODULE(unin, nexus, unin_chip_driver, unin_chip_devclass, 0, 0); 140 141 /* 142 * Add an interrupt to the dev's resource list if present 143 */ 144 static void 145 unin_chip_add_intr(phandle_t devnode, struct unin_chip_devinfo *dinfo) 146 { 147 phandle_t iparent; 148 int *intr; 149 int i, nintr; 150 int icells; 151 152 if (dinfo->udi_ninterrupts >= 6) { 153 printf("unin: device has more than 6 interrupts\n"); 154 return; 155 } 156 157 nintr = OF_getprop_alloc(devnode, "interrupts", sizeof(*intr), 158 (void **)&intr); 159 if (nintr == -1) { 160 nintr = OF_getprop_alloc(devnode, "AAPL,interrupts", 161 sizeof(*intr), (void **)&intr); 162 if (nintr == -1) 163 return; 164 } 165 166 if (intr[0] == -1) 167 return; 168 169 if (OF_getprop(devnode, "interrupt-parent", &iparent, sizeof(iparent)) 170 <= 0) 171 panic("Interrupt but no interrupt parent!\n"); 172 173 if (OF_searchprop(iparent, "#interrupt-cells", &icells, sizeof(icells)) 174 <= 0) 175 icells = 1; 176 177 for (i = 0; i < nintr; i+=icells) { 178 resource_list_add(&dinfo->udi_resources, SYS_RES_IRQ, 179 dinfo->udi_ninterrupts, INTR_VEC(iparent, intr[i]), 180 INTR_VEC(iparent, intr[i]), 1); 181 182 if (icells > 1) { 183 powerpc_config_intr(INTR_VEC(iparent, intr[i]), 184 (intr[i+1] & 1) ? INTR_TRIGGER_LEVEL : 185 INTR_TRIGGER_EDGE, INTR_POLARITY_LOW); 186 } 187 188 dinfo->udi_interrupts[dinfo->udi_ninterrupts] = 189 INTR_VEC(iparent, intr[i]); 190 dinfo->udi_ninterrupts++; 191 } 192 } 193 194 static void 195 unin_chip_add_reg(phandle_t devnode, struct unin_chip_devinfo *dinfo) 196 { 197 struct unin_chip_reg *reg; 198 int i, nreg; 199 200 nreg = OF_getprop_alloc(devnode, "reg", sizeof(*reg), (void **)®); 201 if (nreg == -1) 202 return; 203 204 for (i = 0; i < nreg; i++) { 205 resource_list_add(&dinfo->udi_resources, SYS_RES_MEMORY, i, 206 reg[i].mr_base, 207 reg[i].mr_base + reg[i].mr_size, 208 reg[i].mr_size); 209 } 210 } 211 212 static void 213 unin_enable_gmac(device_t dev) 214 { 215 volatile u_int *clkreg; 216 struct unin_chip_softc *sc; 217 u_int32_t tmpl; 218 219 sc = device_get_softc(dev); 220 clkreg = (void *)(sc->sc_addr + UNIN_CLOCKCNTL); 221 tmpl = inl(clkreg); 222 tmpl |= UNIN_CLOCKCNTL_GMAC; 223 outl(clkreg, tmpl); 224 } 225 226 static void 227 unin_enable_mpic(device_t dev) 228 { 229 volatile u_int *toggle; 230 struct unin_chip_softc *sc; 231 u_int32_t tmpl; 232 233 sc = device_get_softc(dev); 234 toggle = (void *)(sc->sc_addr + UNIN_TOGGLE_REG); 235 tmpl = inl(toggle); 236 tmpl |= UNIN_MPIC_RESET | UNIN_MPIC_OUTPUT_ENABLE; 237 outl(toggle, tmpl); 238 } 239 240 static int 241 unin_chip_probe(device_t dev) 242 { 243 const char *name; 244 245 name = ofw_bus_get_name(dev); 246 247 if (name == NULL) 248 return (ENXIO); 249 250 if (strcmp(name, "uni-n") != 0 && strcmp(name, "u3") != 0 251 && strcmp(name, "u4") != 0) 252 return (ENXIO); 253 254 device_set_desc(dev, "Apple UniNorth System Controller"); 255 return (0); 256 } 257 258 static int 259 unin_chip_attach(device_t dev) 260 { 261 struct unin_chip_softc *sc; 262 struct unin_chip_devinfo *dinfo; 263 phandle_t root; 264 phandle_t child; 265 device_t cdev; 266 char compat[32]; 267 u_int reg[3]; 268 int error, i = 0; 269 270 sc = device_get_softc(dev); 271 root = ofw_bus_get_node(dev); 272 273 if (OF_getprop(root, "reg", reg, sizeof(reg)) < 8) 274 return (ENXIO); 275 276 if (strcmp(ofw_bus_get_name(dev), "u3") == 0 277 || strcmp(ofw_bus_get_name(dev), "u4") == 0) 278 i = 1; /* #address-cells lies */ 279 280 sc->sc_physaddr = reg[i]; 281 sc->sc_size = reg[i+1]; 282 283 sc->sc_mem_rman.rm_type = RMAN_ARRAY; 284 sc->sc_mem_rman.rm_descr = "UniNorth Device Memory"; 285 286 error = rman_init(&sc->sc_mem_rman); 287 288 if (error) { 289 device_printf(dev, "rman_init() failed. error = %d\n", error); 290 return (error); 291 } 292 293 error = rman_manage_region(&sc->sc_mem_rman, sc->sc_physaddr, 294 sc->sc_physaddr + sc->sc_size - 1); 295 if (error) { 296 device_printf(dev, 297 "rman_manage_region() failed. error = %d\n", 298 error); 299 return (error); 300 } 301 302 /* 303 * Iterate through the sub-devices 304 */ 305 for (child = OF_child(root); child != 0; child = OF_peer(child)) { 306 dinfo = malloc(sizeof(*dinfo), M_UNIN, M_WAITOK | M_ZERO); 307 if (ofw_bus_gen_setup_devinfo(&dinfo->udi_obdinfo, child) 308 != 0) 309 { 310 free(dinfo, M_UNIN); 311 continue; 312 } 313 314 resource_list_init(&dinfo->udi_resources); 315 dinfo->udi_ninterrupts = 0; 316 unin_chip_add_intr(child, dinfo); 317 318 unin_chip_add_reg(child, dinfo); 319 320 cdev = device_add_child(dev, NULL, -1); 321 if (cdev == NULL) { 322 device_printf(dev, "<%s>: device_add_child failed\n", 323 dinfo->udi_obdinfo.obd_name); 324 resource_list_free(&dinfo->udi_resources); 325 ofw_bus_gen_destroy_devinfo(&dinfo->udi_obdinfo); 326 free(dinfo, M_UNIN); 327 continue; 328 } 329 330 device_set_ivars(cdev, dinfo); 331 } 332 333 /* 334 * Only map the first page, since that is where the registers 335 * of interest lie. 336 */ 337 sc->sc_addr = (vm_offset_t)pmap_mapdev(sc->sc_physaddr, PAGE_SIZE); 338 339 sc->sc_version = *(u_int *)sc->sc_addr; 340 device_printf(dev, "Version %d\n", sc->sc_version); 341 342 /* 343 * Enable the GMAC Ethernet cell and the integrated OpenPIC 344 * if Open Firmware says they are used. 345 */ 346 for (child = OF_child(root); child; child = OF_peer(child)) { 347 memset(compat, 0, sizeof(compat)); 348 OF_getprop(child, "compatible", compat, sizeof(compat)); 349 if (strcmp(compat, "gmac") == 0) 350 unin_enable_gmac(dev); 351 if (strcmp(compat, "chrp,open-pic") == 0) 352 unin_enable_mpic(dev); 353 } 354 355 /* 356 * GMAC lives under the PCI bus, so just check if enet is gmac. 357 */ 358 child = OF_finddevice("enet"); 359 memset(compat, 0, sizeof(compat)); 360 OF_getprop(child, "compatible", compat, sizeof(compat)); 361 if (strcmp(compat, "gmac") == 0) 362 unin_enable_gmac(dev); 363 364 return (bus_generic_attach(dev)); 365 } 366 367 static int 368 unin_chip_print_child(device_t dev, device_t child) 369 { 370 struct unin_chip_devinfo *dinfo; 371 struct resource_list *rl; 372 int retval = 0; 373 374 dinfo = device_get_ivars(child); 375 rl = &dinfo->udi_resources; 376 377 retval += bus_print_child_header(dev, child); 378 379 retval += resource_list_print_type(rl, "mem", SYS_RES_MEMORY, "%#lx"); 380 retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld"); 381 382 retval += bus_print_child_footer(dev, child); 383 384 return (retval); 385 } 386 387 static void 388 unin_chip_probe_nomatch(device_t dev, device_t child) 389 { 390 struct unin_chip_devinfo *dinfo; 391 struct resource_list *rl; 392 const char *type; 393 394 if (bootverbose) { 395 dinfo = device_get_ivars(child); 396 rl = &dinfo->udi_resources; 397 398 if ((type = ofw_bus_get_type(child)) == NULL) 399 type = "(unknown)"; 400 device_printf(dev, "<%s, %s>", type, ofw_bus_get_name(child)); 401 resource_list_print_type(rl, "mem", SYS_RES_MEMORY, "%#lx"); 402 resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld"); 403 printf(" (no driver attached)\n"); 404 } 405 } 406 407 408 static struct resource * 409 unin_chip_alloc_resource(device_t bus, device_t child, int type, int *rid, 410 u_long start, u_long end, u_long count, u_int flags) 411 { 412 struct unin_chip_softc *sc; 413 int needactivate; 414 struct resource *rv; 415 struct rman *rm; 416 u_long adjstart, adjend, adjcount; 417 struct unin_chip_devinfo *dinfo; 418 struct resource_list_entry *rle; 419 420 sc = device_get_softc(bus); 421 dinfo = device_get_ivars(child); 422 423 needactivate = flags & RF_ACTIVE; 424 flags &= ~RF_ACTIVE; 425 426 switch (type) { 427 case SYS_RES_MEMORY: 428 case SYS_RES_IOPORT: 429 rle = resource_list_find(&dinfo->udi_resources, SYS_RES_MEMORY, 430 *rid); 431 if (rle == NULL) { 432 device_printf(bus, "no rle for %s memory %d\n", 433 device_get_nameunit(child), *rid); 434 return (NULL); 435 } 436 437 rle->end = rle->end - 1; /* Hack? */ 438 439 if (start < rle->start) 440 adjstart = rle->start; 441 else if (start > rle->end) 442 adjstart = rle->end; 443 else 444 adjstart = start; 445 446 if (end < rle->start) 447 adjend = rle->start; 448 else if (end > rle->end) 449 adjend = rle->end; 450 else 451 adjend = end; 452 453 adjcount = adjend - adjstart; 454 455 rm = &sc->sc_mem_rman; 456 break; 457 458 case SYS_RES_IRQ: 459 /* Check for passthrough from subattachments. */ 460 if (device_get_parent(child) != bus) 461 return BUS_ALLOC_RESOURCE(device_get_parent(bus), child, 462 type, rid, start, end, count, 463 flags); 464 465 rle = resource_list_find(&dinfo->udi_resources, SYS_RES_IRQ, 466 *rid); 467 if (rle == NULL) { 468 if (dinfo->udi_ninterrupts >= 6) { 469 device_printf(bus, 470 "%s has more than 6 interrupts\n", 471 device_get_nameunit(child)); 472 return (NULL); 473 } 474 resource_list_add(&dinfo->udi_resources, SYS_RES_IRQ, 475 dinfo->udi_ninterrupts, start, start, 476 1); 477 478 dinfo->udi_interrupts[dinfo->udi_ninterrupts] = start; 479 dinfo->udi_ninterrupts++; 480 } 481 482 return (resource_list_alloc(&dinfo->udi_resources, bus, child, 483 type, rid, start, end, count, 484 flags)); 485 default: 486 device_printf(bus, "unknown resource request from %s\n", 487 device_get_nameunit(child)); 488 return (NULL); 489 } 490 491 rv = rman_reserve_resource(rm, adjstart, adjend, adjcount, flags, 492 child); 493 if (rv == NULL) { 494 device_printf(bus, 495 "failed to reserve resource %#lx - %#lx (%#lx)" 496 " for %s\n", adjstart, adjend, adjcount, 497 device_get_nameunit(child)); 498 return (NULL); 499 } 500 501 rman_set_rid(rv, *rid); 502 503 if (needactivate) { 504 if (bus_activate_resource(child, type, *rid, rv) != 0) { 505 device_printf(bus, 506 "failed to activate resource for %s\n", 507 device_get_nameunit(child)); 508 rman_release_resource(rv); 509 return (NULL); 510 } 511 } 512 513 return (rv); 514 } 515 516 static int 517 unin_chip_release_resource(device_t bus, device_t child, int type, int rid, 518 struct resource *res) 519 { 520 if (rman_get_flags(res) & RF_ACTIVE) { 521 int error = bus_deactivate_resource(child, type, rid, res); 522 if (error) 523 return error; 524 } 525 526 return (rman_release_resource(res)); 527 } 528 529 static int 530 unin_chip_activate_resource(device_t bus, device_t child, int type, int rid, 531 struct resource *res) 532 { 533 struct unin_chip_softc *sc; 534 void *p; 535 536 sc = device_get_softc(bus); 537 538 if (type == SYS_RES_IRQ) 539 return (bus_activate_resource(bus, type, rid, res)); 540 541 if ((type == SYS_RES_MEMORY) || (type == SYS_RES_IOPORT)) { 542 vm_offset_t start; 543 544 start = (vm_offset_t) rman_get_start(res); 545 546 if (bootverbose) 547 printf("unin mapdev: start %zx, len %ld\n", start, 548 rman_get_size(res)); 549 550 p = pmap_mapdev(start, (vm_size_t) rman_get_size(res)); 551 if (p == NULL) 552 return (ENOMEM); 553 rman_set_virtual(res, p); 554 rman_set_bustag(res, &bs_be_tag); 555 rman_set_bushandle(res, (u_long)p); 556 } 557 558 return (rman_activate_resource(res)); 559 } 560 561 562 static int 563 unin_chip_deactivate_resource(device_t bus, device_t child, int type, int rid, 564 struct resource *res) 565 { 566 /* 567 * If this is a memory resource, unmap it. 568 */ 569 if ((type == SYS_RES_MEMORY) || (type == SYS_RES_IOPORT)) { 570 u_int32_t psize; 571 572 psize = rman_get_size(res); 573 pmap_unmapdev((vm_offset_t)rman_get_virtual(res), psize); 574 } 575 576 return (rman_deactivate_resource(res)); 577 } 578 579 580 static struct resource_list * 581 unin_chip_get_resource_list (device_t dev, device_t child) 582 { 583 struct unin_chip_devinfo *dinfo; 584 585 dinfo = device_get_ivars(child); 586 return (&dinfo->udi_resources); 587 } 588 589 static const struct ofw_bus_devinfo * 590 unin_chip_get_devinfo(device_t dev, device_t child) 591 { 592 struct unin_chip_devinfo *dinfo; 593 594 dinfo = device_get_ivars(child); 595 return (&dinfo->udi_obdinfo); 596 } 597 598