macio.c revision 178599
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: head/sys/powerpc/powermac/macio.c 178599 2008-04-26 18:35:44Z marcel $ 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/module.h> 39#include <sys/bus.h> 40#include <machine/bus.h> 41#include <sys/rman.h> 42 43#include <machine/vmparam.h> 44#include <vm/vm.h> 45#include <vm/pmap.h> 46#include <machine/pmap.h> 47 48#include <machine/resource.h> 49 50#include <dev/ofw/ofw_bus.h> 51#include <dev/ofw/ofw_bus_subr.h> 52#include <dev/ofw/openfirm.h> 53 54#include <powerpc/powermac/maciovar.h> 55 56#include <dev/pci/pcivar.h> 57#include <dev/pci/pcireg.h> 58 59/* 60 * Macio softc 61 */ 62struct macio_softc { 63 phandle_t sc_node; 64 vm_offset_t sc_base; 65 vm_offset_t sc_size; 66 struct rman sc_mem_rman; 67}; 68 69static MALLOC_DEFINE(M_MACIO, "macio", "macio device information"); 70 71static int macio_probe(device_t); 72static int macio_attach(device_t); 73static int macio_print_child(device_t dev, device_t child); 74static void macio_probe_nomatch(device_t, device_t); 75static struct resource *macio_alloc_resource(device_t, device_t, int, int *, 76 u_long, u_long, u_long, u_int); 77static int macio_activate_resource(device_t, device_t, int, int, 78 struct resource *); 79static int macio_deactivate_resource(device_t, device_t, int, int, 80 struct resource *); 81static int macio_release_resource(device_t, device_t, int, int, 82 struct resource *); 83static struct resource_list *macio_get_resource_list (device_t, device_t); 84static ofw_bus_get_devinfo_t macio_get_devinfo; 85 86/* 87 * Bus interface definition 88 */ 89static device_method_t macio_methods[] = { 90 /* Device interface */ 91 DEVMETHOD(device_probe, macio_probe), 92 DEVMETHOD(device_attach, macio_attach), 93 DEVMETHOD(device_detach, bus_generic_detach), 94 DEVMETHOD(device_shutdown, bus_generic_shutdown), 95 DEVMETHOD(device_suspend, bus_generic_suspend), 96 DEVMETHOD(device_resume, bus_generic_resume), 97 98 /* Bus interface */ 99 DEVMETHOD(bus_print_child, macio_print_child), 100 DEVMETHOD(bus_probe_nomatch, macio_probe_nomatch), 101 DEVMETHOD(bus_setup_intr, bus_generic_setup_intr), 102 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr), 103 104 DEVMETHOD(bus_alloc_resource, macio_alloc_resource), 105 DEVMETHOD(bus_release_resource, macio_release_resource), 106 DEVMETHOD(bus_activate_resource, macio_activate_resource), 107 DEVMETHOD(bus_deactivate_resource, macio_deactivate_resource), 108 DEVMETHOD(bus_get_resource_list, macio_get_resource_list), 109 110 /* ofw_bus interface */ 111 DEVMETHOD(ofw_bus_get_devinfo, macio_get_devinfo), 112 DEVMETHOD(ofw_bus_get_compat, ofw_bus_gen_get_compat), 113 DEVMETHOD(ofw_bus_get_model, ofw_bus_gen_get_model), 114 DEVMETHOD(ofw_bus_get_name, ofw_bus_gen_get_name), 115 DEVMETHOD(ofw_bus_get_node, ofw_bus_gen_get_node), 116 DEVMETHOD(ofw_bus_get_type, ofw_bus_gen_get_type), 117 118 { 0, 0 } 119}; 120 121static driver_t macio_pci_driver = { 122 "macio", 123 macio_methods, 124 sizeof(struct macio_softc) 125}; 126 127devclass_t macio_devclass; 128 129DRIVER_MODULE(macio, pci, macio_pci_driver, macio_devclass, 0, 0); 130 131/* 132 * PCI ID search table 133 */ 134static struct macio_pci_dev { 135 u_int32_t mpd_devid; 136 char *mpd_desc; 137} macio_pci_devlist[] = { 138 { 0x0017106b, "Paddington I/O Controller" }, 139 { 0x0022106b, "KeyLargo I/O Controller" }, 140 { 0x0025106b, "Pangea I/O Controller" }, 141 { 0x003e106b, "Intrepid I/O Controller" }, 142 { 0, NULL } 143}; 144 145/* 146 * Devices to exclude from the probe 147 * XXX some of these may be required in the future... 148 */ 149#define MACIO_QUIRK_IGNORE 0x00000001 150#define MACIO_QUIRK_CHILD_HAS_INTR 0x00000002 151 152struct macio_quirk_entry { 153 const char *mq_name; 154 int mq_quirks; 155}; 156 157static struct macio_quirk_entry macio_quirks[] = { 158 { "escc-legacy", MACIO_QUIRK_IGNORE }, 159 { "timer", MACIO_QUIRK_IGNORE }, 160 { "escc", MACIO_QUIRK_CHILD_HAS_INTR }, 161 { NULL, 0 } 162}; 163 164static int 165macio_get_quirks(const char *name) 166{ 167 struct macio_quirk_entry *mqe; 168 169 for (mqe = macio_quirks; mqe->mq_name != NULL; mqe++) 170 if (strcmp(name, mqe->mq_name) == 0) 171 return (mqe->mq_quirks); 172 return (0); 173} 174 175 176/* 177 * Add an interrupt to the dev's resource list if present 178 */ 179static void 180macio_add_intr(phandle_t devnode, struct macio_devinfo *dinfo) 181{ 182 int *intr; 183 int i, nintr; 184 phandle_t iparent; 185 int icells; 186 187 if (dinfo->mdi_ninterrupts >= 6) { 188 printf("macio: device has more than 6 interrupts\n"); 189 return; 190 } 191 192 icells = 1; 193 194 if (OF_getprop(devnode, "interrupt-parent", &iparent, sizeof(iparent)) == sizeof(iparent)) 195 OF_getprop(iparent, "#interrupt-cells", &icells, sizeof(icells)); 196 197 nintr = OF_getprop_alloc(devnode, "interrupts", sizeof(*intr), 198 (void **)&intr); 199 if (nintr == -1) { 200 nintr = OF_getprop_alloc(devnode, "AAPL,interrupts", 201 sizeof(*intr), (void **)&intr); 202 if (nintr == -1) 203 return; 204 } 205 206 if (intr[0] == -1) 207 return; 208 209 for (i = 0; i < nintr; i+=icells) { 210 resource_list_add(&dinfo->mdi_resources, SYS_RES_IRQ, 211 dinfo->mdi_ninterrupts, intr[i], intr[i], 1); 212 213 dinfo->mdi_interrupts[dinfo->mdi_ninterrupts] = intr[i]; 214 dinfo->mdi_ninterrupts++; 215 } 216} 217 218 219static void 220macio_add_reg(phandle_t devnode, struct macio_devinfo *dinfo) 221{ 222 struct macio_reg *reg; 223 int i, nreg; 224 225 nreg = OF_getprop_alloc(devnode, "reg", sizeof(*reg), (void **)®); 226 if (nreg == -1) 227 return; 228 229 for (i = 0; i < nreg; i++) { 230 resource_list_add(&dinfo->mdi_resources, SYS_RES_MEMORY, i, 231 reg[i].mr_base, reg[i].mr_base + reg[i].mr_size, 232 reg[i].mr_size); 233 } 234} 235 236/* 237 * PCI probe 238 */ 239static int 240macio_probe(device_t dev) 241{ 242 int i; 243 u_int32_t devid; 244 245 devid = pci_get_devid(dev); 246 for (i = 0; macio_pci_devlist[i].mpd_desc != NULL; i++) { 247 if (devid == macio_pci_devlist[i].mpd_devid) { 248 device_set_desc(dev, macio_pci_devlist[i].mpd_desc); 249 return (0); 250 } 251 } 252 253 return (ENXIO); 254} 255 256/* 257 * PCI attach: scan Open Firmware child nodes, and attach these as children 258 * of the macio bus 259 */ 260static int 261macio_attach(device_t dev) 262{ 263 struct macio_softc *sc; 264 struct macio_devinfo *dinfo; 265 phandle_t root; 266 phandle_t child; 267 phandle_t subchild; 268 device_t cdev; 269 u_int reg[3]; 270 int quirks; 271 272 sc = device_get_softc(dev); 273 root = sc->sc_node = OF_finddevice("mac-io"); 274 275 /* 276 * Locate the device node and it's base address 277 */ 278 if (OF_getprop(root, "assigned-addresses", 279 reg, sizeof(reg)) < sizeof(reg)) { 280 return (ENXIO); 281 } 282 283 sc->sc_base = reg[2]; 284 sc->sc_size = MACIO_REG_SIZE; 285 286 sc->sc_mem_rman.rm_type = RMAN_ARRAY; 287 sc->sc_mem_rman.rm_descr = "MacIO Device Memory"; 288 if (rman_init(&sc->sc_mem_rman) != 0) { 289 device_printf(dev, 290 "failed to init mem range resources\n"); 291 return (ENXIO); 292 } 293 rman_manage_region(&sc->sc_mem_rman, 0, sc->sc_size); 294 295 /* 296 * Iterate through the sub-devices 297 */ 298 for (child = OF_child(root); child != 0; child = OF_peer(child)) { 299 dinfo = malloc(sizeof(*dinfo), M_MACIO, M_WAITOK | M_ZERO); 300 if (ofw_bus_gen_setup_devinfo(&dinfo->mdi_obdinfo, child) != 301 0) { 302 free(dinfo, M_MACIO); 303 continue; 304 } 305 quirks = macio_get_quirks(dinfo->mdi_obdinfo.obd_name); 306 if ((quirks & MACIO_QUIRK_IGNORE) != 0) { 307 ofw_bus_gen_destroy_devinfo(&dinfo->mdi_obdinfo); 308 free(dinfo, M_MACIO); 309 continue; 310 } 311 resource_list_init(&dinfo->mdi_resources); 312 dinfo->mdi_ninterrupts = 0; 313 macio_add_intr(child, dinfo); 314 macio_add_reg(child, dinfo); 315 if ((quirks & MACIO_QUIRK_CHILD_HAS_INTR) != 0) 316 for (subchild = OF_child(child); subchild != 0; 317 subchild = OF_peer(subchild)) 318 macio_add_intr(subchild, dinfo); 319 cdev = device_add_child(dev, NULL, -1); 320 if (cdev == NULL) { 321 device_printf(dev, "<%s>: device_add_child failed\n", 322 dinfo->mdi_obdinfo.obd_name); 323 resource_list_free(&dinfo->mdi_resources); 324 ofw_bus_gen_destroy_devinfo(&dinfo->mdi_obdinfo); 325 free(dinfo, M_MACIO); 326 continue; 327 } 328 device_set_ivars(cdev, dinfo); 329 } 330 331 return (bus_generic_attach(dev)); 332} 333 334 335static int 336macio_print_child(device_t dev, device_t child) 337{ 338 struct macio_devinfo *dinfo; 339 struct resource_list *rl; 340 int retval = 0; 341 342 dinfo = device_get_ivars(child); 343 rl = &dinfo->mdi_resources; 344 345 retval += bus_print_child_header(dev, child); 346 347 retval += resource_list_print_type(rl, "mem", SYS_RES_MEMORY, "%#lx"); 348 retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld"); 349 350 retval += bus_print_child_footer(dev, child); 351 352 return (retval); 353} 354 355 356static void 357macio_probe_nomatch(device_t dev, device_t child) 358{ 359 struct macio_devinfo *dinfo; 360 struct resource_list *rl; 361 const char *type; 362 363 if (bootverbose) { 364 dinfo = device_get_ivars(child); 365 rl = &dinfo->mdi_resources; 366 367 if ((type = ofw_bus_get_type(child)) == NULL) 368 type = "(unknown)"; 369 device_printf(dev, "<%s, %s>", type, ofw_bus_get_name(child)); 370 resource_list_print_type(rl, "mem", SYS_RES_MEMORY, "%#lx"); 371 resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld"); 372 printf(" (no driver attached)\n"); 373 } 374} 375 376 377static struct resource * 378macio_alloc_resource(device_t bus, device_t child, int type, int *rid, 379 u_long start, u_long end, u_long count, u_int flags) 380{ 381 struct macio_softc *sc; 382 int needactivate; 383 struct resource *rv; 384 struct rman *rm; 385 u_long adjstart, adjend, adjcount; 386 struct macio_devinfo *dinfo; 387 struct resource_list_entry *rle; 388 389 sc = device_get_softc(bus); 390 dinfo = device_get_ivars(child); 391 392 needactivate = flags & RF_ACTIVE; 393 flags &= ~RF_ACTIVE; 394 395 switch (type) { 396 case SYS_RES_MEMORY: 397 case SYS_RES_IOPORT: 398 rle = resource_list_find(&dinfo->mdi_resources, SYS_RES_MEMORY, 399 *rid); 400 if (rle == NULL) { 401 device_printf(bus, "no rle for %s memory %d\n", 402 device_get_nameunit(child), *rid); 403 return (NULL); 404 } 405 406 if (start < rle->start) 407 adjstart = rle->start; 408 else if (start > rle->end) 409 adjstart = rle->end; 410 else 411 adjstart = start; 412 413 if (end < rle->start) 414 adjend = rle->start; 415 else if (end > rle->end) 416 adjend = rle->end; 417 else 418 adjend = end; 419 420 adjcount = adjend - adjstart; 421 422 rm = &sc->sc_mem_rman; 423 break; 424 425 case SYS_RES_IRQ: 426 rle = resource_list_find(&dinfo->mdi_resources, SYS_RES_IRQ, 427 *rid); 428 if (rle == NULL) { 429 if (dinfo->mdi_ninterrupts >= 6) { 430 device_printf(bus, 431 "%s has more than 6 interrupts\n", 432 device_get_nameunit(child)); 433 return (NULL); 434 } 435 resource_list_add(&dinfo->mdi_resources, SYS_RES_IRQ, 436 dinfo->mdi_ninterrupts, start, start, 1); 437 438 dinfo->mdi_interrupts[dinfo->mdi_ninterrupts] = start; 439 dinfo->mdi_ninterrupts++; 440 } 441 442 return (resource_list_alloc(&dinfo->mdi_resources, bus, child, 443 type, rid, start, end, count, flags)); 444 445 default: 446 device_printf(bus, "unknown resource request from %s\n", 447 device_get_nameunit(child)); 448 return (NULL); 449 } 450 451 rv = rman_reserve_resource(rm, adjstart, adjend, adjcount, flags, 452 child); 453 if (rv == NULL) { 454 device_printf(bus, 455 "failed to reserve resource %#lx - %#lx (%#lx) for %s\n", 456 adjstart, adjend, adjcount, device_get_nameunit(child)); 457 return (NULL); 458 } 459 460 rman_set_rid(rv, *rid); 461 462 if (needactivate) { 463 if (bus_activate_resource(child, type, *rid, rv) != 0) { 464 device_printf(bus, 465 "failed to activate resource for %s\n", 466 device_get_nameunit(child)); 467 rman_release_resource(rv); 468 return (NULL); 469 } 470 } 471 472 return (rv); 473} 474 475 476static int 477macio_release_resource(device_t bus, device_t child, int type, int rid, 478 struct resource *res) 479{ 480 if (rman_get_flags(res) & RF_ACTIVE) { 481 int error = bus_deactivate_resource(child, type, rid, res); 482 if (error) 483 return error; 484 } 485 486 return (rman_release_resource(res)); 487} 488 489 490static int 491macio_activate_resource(device_t bus, device_t child, int type, int rid, 492 struct resource *res) 493{ 494 struct macio_softc *sc; 495 void *p; 496 497 sc = device_get_softc(bus); 498 499 if (type == SYS_RES_IRQ) 500 return (bus_activate_resource(bus, type, rid, res)); 501 502 if ((type == SYS_RES_MEMORY) || (type == SYS_RES_IOPORT)) { 503 p = pmap_mapdev((vm_offset_t)rman_get_start(res) + sc->sc_base, 504 (vm_size_t)rman_get_size(res)); 505 if (p == NULL) 506 return (ENOMEM); 507 rman_set_virtual(res, p); 508 rman_set_bustag(res, &bs_le_tag); 509 rman_set_bushandle(res, (u_long)p); 510 } 511 512 return (rman_activate_resource(res)); 513} 514 515 516static int 517macio_deactivate_resource(device_t bus, device_t child, int type, int rid, 518 struct resource *res) 519{ 520 /* 521 * If this is a memory resource, unmap it. 522 */ 523 if ((type == SYS_RES_MEMORY) || (type == SYS_RES_IOPORT)) { 524 u_int32_t psize; 525 526 psize = rman_get_size(res); 527 pmap_unmapdev((vm_offset_t)rman_get_virtual(res), psize); 528 } 529 530 return (rman_deactivate_resource(res)); 531} 532 533 534static struct resource_list * 535macio_get_resource_list (device_t dev, device_t child) 536{ 537 struct macio_devinfo *dinfo; 538 539 dinfo = device_get_ivars(child); 540 return (&dinfo->mdi_resources); 541} 542 543static const struct ofw_bus_devinfo * 544macio_get_devinfo(device_t dev, device_t child) 545{ 546 struct macio_devinfo *dinfo; 547 548 dinfo = device_get_ivars(child); 549 return (&dinfo->mdi_obdinfo); 550} 551