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 /* 115 * PCI ID search table 116 */ 117 static struct macio_pci_dev { 118 u_int32_t mpd_devid; 119 char *mpd_desc; 120 } macio_pci_devlist[] = { 121 { 0x0025106b, "Pangea I/O Controller" }, 122 { 0x0022106b, "KeyLargo I/O Controller" }, 123 { 0, NULL } 124 }; 125 126 /* 127 * Devices to exclude from the probe 128 * XXX some of these may be required in the future... 129 */ 130 static char *macio_excl_name[] = { 131 "interrupt-controller", 132 "escc-legacy", 133 "gpio", 134 "timer", 135 NULL 136 }; 137 138 static int 139 macio_inlist(char *name) 140 { 141 int i; 142 143 for (i = 0; macio_excl_name[i] != NULL; i++) 144 if (strcmp(name, macio_excl_name[i]) == 0) 145 return (1); 146 return (0); 147 } 148 149 150 /* 151 * Add an interrupt to the dev's resource list if present 152 */ 153 static void 154 macio_add_intr(phandle_t devnode, struct macio_devinfo *dinfo) 155 { 156 u_int intr = -1; 157 158 if ((OF_getprop(devnode, "interrupts", &intr, sizeof(intr)) != -1) || 159 (OF_getprop(devnode, "AAPL,interrupts", 160 &intr, sizeof(intr) != -1))) { 161 resource_list_add(&dinfo->mdi_resources, 162 SYS_RES_IRQ, 0, intr, intr, 1); 163 } 164 dinfo->mdi_interrupt = intr; 165 } 166 167 168 static void 169 macio_add_reg(phandle_t devnode, struct macio_devinfo *dinfo) 170 { 171 u_int size; 172 u_int start; 173 u_int end; 174 175 size = OF_getprop(devnode, "reg", dinfo->mdi_reg, 176 sizeof(dinfo->mdi_reg)); 177 178 if (size != -1) { 179 180 /* 181 * Only do a single range for the moment... 182 */ 183 dinfo->mdi_nregs = 1; 184 start = dinfo->mdi_reg[0]; 185 end = start + dinfo->mdi_reg[1] - 1; 186 resource_list_add(&dinfo->mdi_resources, SYS_RES_MEMORY, 0, 187 start, end, end - start + 1); 188 } else { 189 dinfo->mdi_nregs = -1; 190 } 191 } 192 193 /* 194 * PCI probe 195 */ 196 static int 197 macio_probe(device_t dev) 198 { 199 int i; 200 u_int32_t devid; 201 202 devid = pci_get_devid(dev); 203 for (i = 0; macio_pci_devlist[i].mpd_desc != NULL; i++) { 204 if (devid == macio_pci_devlist[i].mpd_devid) { 205 device_set_desc(dev, macio_pci_devlist[i].mpd_desc); 206 return (0); 207 } 208 } 209 210 return (ENXIO); 211 } 212 213 /* 214 * PCI attach: scan OpenFirmware child nodes, and attach these as children 215 * of the macio bus 216 */ 217 static int 218 macio_attach(device_t dev) 219 { 220 struct macio_softc *sc; 221 struct macio_devinfo *dinfo; 222 phandle_t root; 223 phandle_t child; 224 device_t cdev; 225 u_int reg[3]; 226 char *name, *type; 227 228 sc = device_get_softc(dev); 229 root = sc->sc_node = OF_finddevice("mac-io"); 230 231 /* 232 * Locate the device node and it's base address 233 */ 234 if (OF_getprop(root, "assigned-addresses", 235 reg, sizeof(reg)) < sizeof(reg)) { 236 return (ENXIO); 237 } 238 239 sc->sc_base = reg[2]; 240 sc->sc_size = MACIO_REG_SIZE; 241 242 sc->sc_mem_rman.rm_type = RMAN_ARRAY; 243 sc->sc_mem_rman.rm_descr = "IOBus Device Memory"; 244 if (rman_init(&sc->sc_mem_rman) != 0) { 245 device_printf(dev, 246 "failed to init mem range resources\n"); 247 return (ENXIO); 248 } 249 rman_manage_region(&sc->sc_mem_rman, 0, sc->sc_size); 250 251 /* 252 * Iterate through the sub-devices 253 */ 254 for (child = OF_child(root); child != 0; child = OF_peer(child)) { 255 OF_getprop_alloc(child, "name", 1, (void **)&name); 256 OF_getprop_alloc(child, "device_type", 1, (void **)&type); 257 258 if (macio_inlist(name)) { 259 free(name, M_OFWPROP); 260 free(type, M_OFWPROP); 261 continue; 262 } 263 264 cdev = device_add_child(dev, NULL, -1); 265 if (cdev != NULL) { 266 dinfo = malloc(sizeof(*dinfo), M_MACIO, M_WAITOK); 267 memset(dinfo, 0, sizeof(*dinfo)); 268 resource_list_init(&dinfo->mdi_resources); 269 dinfo->mdi_node = child; 270 dinfo->mdi_name = name; 271 dinfo->mdi_device_type = type; 272 macio_add_intr(child, dinfo); 273 macio_add_reg(child, dinfo); 274 device_set_ivars(cdev, dinfo); 275 } else { 276 free(name, M_OFWPROP); 277 free(type, M_OFWPROP); 278 } 279 } 280 281 return (bus_generic_attach(dev)); 282 } 283 284 285 static int 286 macio_print_child(device_t dev, device_t child) 287 { 288 struct macio_devinfo *dinfo; 289 struct resource_list *rl; 290 int retval = 0; 291 292 dinfo = device_get_ivars(child); 293 rl = &dinfo->mdi_resources; 294 295 retval += bus_print_child_header(dev, child); 296 297 retval += resource_list_print_type(rl, "mem", SYS_RES_MEMORY, "%#lx"); 298 retval += resource_list_print_type(rl, "irq", SYS_RES_IRQ, "%ld"); 299 300 retval += bus_print_child_footer(dev, child); 301 302 return (retval); 303 } 304 305 306 static void 307 macio_probe_nomatch(device_t dev, device_t child) 308 { 309 u_int *regs; 310 311 if (bootverbose) { 312 regs = macio_get_regs(child); 313 314 device_printf(dev, "<%s, %s>", macio_get_devtype(child), 315 macio_get_name(child)); 316 printf("at offset 0x%x (no driver attached)\n", regs[0]); 317 } 318 } 319 320 321 static int 322 macio_read_ivar(device_t dev, device_t child, int which, uintptr_t *result) 323 { 324 struct macio_devinfo *dinfo; 325 326 if ((dinfo = device_get_ivars(child)) == 0) 327 return (ENOENT); 328 329 switch (which) { 330 case MACIO_IVAR_NODE: 331 *result = dinfo->mdi_node; 332 break; 333 case MACIO_IVAR_NAME: 334 *result = (uintptr_t)dinfo->mdi_name; 335 break; 336 case MACIO_IVAR_DEVTYPE: 337 *result = (uintptr_t)dinfo->mdi_device_type; 338 break; 339 case MACIO_IVAR_NREGS: 340 *result = dinfo->mdi_nregs; 341 break; 342 case MACIO_IVAR_REGS: 343 *result = (uintptr_t) &dinfo->mdi_reg[0]; 344 break; 345 default: 346 return (ENOENT); 347 } 348 349 return (0); 350 } 351 352 353 static int 354 macio_write_ivar(device_t dev, device_t child, int which, uintptr_t value) 355 { 356 return (EINVAL); 357 } 358 359 360 static struct resource * 361 macio_alloc_resource(device_t bus, device_t child, int type, int *rid, 362 u_long start, u_long end, u_long count, u_int flags) 363 { 364 struct macio_softc *sc; 365 int needactivate; 366 struct resource *rv; 367 struct rman *rm; 368 bus_space_tag_t tagval; 369 370 sc = device_get_softc(bus); 371 372 needactivate = flags & RF_ACTIVE; 373 flags &= ~RF_ACTIVE; 374 375 switch (type) { 376 case SYS_RES_MEMORY: 377 case SYS_RES_IOPORT: 378 rm = &sc->sc_mem_rman; 379 tagval = PPC_BUS_SPACE_MEM; 380 if (flags & PPC_BUS_SPARSE4) 381 tagval |= 4; 382 break; 383 case SYS_RES_IRQ: 384 return (bus_alloc_resource(bus, type, rid, start, end, count, 385 flags)); 386 break; 387 default: 388 device_printf(bus, "unknown resource request from %s\n", 389 device_get_nameunit(child)); 390 return (NULL); 391 } 392 393 rv = rman_reserve_resource(rm, start, end, count, flags, child); 394 if (rv == NULL) { 395 device_printf(bus, "failed to reserve resource for %s\n", 396 device_get_nameunit(child)); 397 return (NULL); 398 } 399 400 rman_set_bustag(rv, tagval); 401 rman_set_bushandle(rv, rman_get_start(rv)); 402 403 if (needactivate) { 404 if (bus_activate_resource(child, type, *rid, rv) != 0) { 405 device_printf(bus, 406 "failed to activate resource for %s\n", 407 device_get_nameunit(child)); 408 rman_release_resource(rv); 409 return (NULL); 410 } 411 } 412 413 return (rv); 414 } 415 416 417 static int 418 macio_release_resource(device_t bus, device_t child, int type, int rid, 419 struct resource *res) 420 { 421 if (rman_get_flags(res) & RF_ACTIVE) { 422 int error = bus_deactivate_resource(child, type, rid, res); 423 if (error) 424 return error; 425 } 426 427 return (rman_release_resource(res)); 428 } 429 430 431 static int 432 macio_activate_resource(device_t bus, device_t child, int type, int rid, 433 struct resource *res) 434 { 435 struct macio_softc *sc; 436 void *p; 437 438 sc = device_get_softc(bus); 439 440 if (type == SYS_RES_IRQ) 441 return (bus_activate_resource(bus, type, rid, res)); 442 443 if ((type == SYS_RES_MEMORY) || (type == SYS_RES_IOPORT)) { 444 p = pmap_mapdev((vm_offset_t)rman_get_start(res) + sc->sc_base, 445 (vm_size_t)rman_get_size(res)); 446 if (p == NULL) 447 return (ENOMEM); 448 rman_set_virtual(res, p); 449 rman_set_bushandle(res, (u_long)p); 450 } 451 452 return (rman_activate_resource(res)); 453 } 454 455 456 static int 457 macio_deactivate_resource(device_t bus, device_t child, int type, int rid, 458 struct resource *res) 459 { 460 /* 461 * If this is a memory resource, unmap it. 462 */ 463 if ((type == SYS_RES_MEMORY) || (type == SYS_RES_IOPORT)) { 464 u_int32_t psize; 465 466 psize = rman_get_size(res); 467 pmap_unmapdev((vm_offset_t)rman_get_virtual(res), psize); 468 } 469 470 return (rman_deactivate_resource(res)); 471 } 472 473 474 static struct resource_list * 475 macio_get_resource_list (device_t dev, device_t child) 476 { 477 struct macio_devinfo *dinfo = device_get_ivars(child); 478 struct resource_list *rl = &dinfo->mdi_resources; 479 480 if (!rl) 481 return (NULL); 482 483 return (rl); 484 } 485