1 /* $NetBSD: puc.c,v 1.7 2000/07/29 17:43:38 jlam Exp $ */ 2 3 /*- 4 * Copyright (c) 2002 JF Hay. All rights reserved. 5 * Copyright (c) 2000 M. Warner Losh. All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 26 * SUCH DAMAGE. 27 */ 28 29 /*- 30 * Copyright (c) 1996, 1998, 1999 31 * Christopher G. Demetriou. All rights reserved. 32 * 33 * Redistribution and use in source and binary forms, with or without 34 * modification, are permitted provided that the following conditions 35 * are met: 36 * 1. Redistributions of source code must retain the above copyright 37 * notice, this list of conditions and the following disclaimer. 38 * 2. Redistributions in binary form must reproduce the above copyright 39 * notice, this list of conditions and the following disclaimer in the 40 * documentation and/or other materials provided with the distribution. 41 * 3. All advertising materials mentioning features or use of this software 42 * must display the following acknowledgement: 43 * This product includes software developed by Christopher G. Demetriou 44 * for the NetBSD Project. 45 * 4. The name of the author may not be used to endorse or promote products 46 * derived from this software without specific prior written permission 47 * 48 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 49 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 50 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 51 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 52 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 53 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 54 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 55 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 56 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 57 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 58 */ 59 60 #include <sys/cdefs.h> 61 __FBSDID("$FreeBSD$"); 62 63 /* 64 * PCI "universal" communication card device driver, glues com, lpt, 65 * and similar ports to PCI via bridge chip often much larger than 66 * the devices being glued. 67 * 68 * Author: Christopher G. Demetriou, May 14, 1998 (derived from NetBSD 69 * sys/dev/pci/pciide.c, revision 1.6). 70 * 71 * These devices could be (and some times are) described as 72 * communications/{serial,parallel}, etc. devices with known 73 * programming interfaces, but those programming interfaces (in 74 * particular the BAR assignments for devices, etc.) in fact are not 75 * particularly well defined. 76 * 77 * After I/we have seen more of these devices, it may be possible 78 * to generalize some of these bits. In particular, devices which 79 * describe themselves as communications/serial/16[45]50, and 80 * communications/parallel/??? might be attached via direct 81 * 'com' and 'lpt' attachments to pci. 82 */ 83 84 #include "opt_puc.h" 85 86 #include <sys/param.h> 87 #include <sys/systm.h> 88 #include <sys/kernel.h> 89 #include <sys/bus.h> 90 #include <sys/conf.h> 91 #include <sys/malloc.h> 92 93 #include <machine/bus.h> 94 #include <machine/resource.h> 95 #include <sys/rman.h> 96 97 #include <dev/pci/pcireg.h> 98 #include <dev/pci/pcivar.h> 99 100 #define PUC_ENTRAILS 1 101 #include <dev/puc/pucvar.h> 102 103 struct puc_device { 104 struct resource_list resources; 105 int port; 106 int regshft; 107 u_int serialfreq; 108 u_int subtype; 109 }; 110 111 static void puc_intr(void *arg); 112 113 static int puc_find_free_unit(char *); 114 #ifdef PUC_DEBUG 115 static void puc_print_resource_list(struct resource_list *); 116 #endif 117 118 devclass_t puc_devclass; 119 120 static int 121 puc_port_bar_index(struct puc_softc *sc, int bar) 122 { 123 int i; 124 125 for (i = 0; i < PUC_MAX_BAR; i += 1) { 126 if (!sc->sc_bar_mappings[i].used) 127 break; 128 if (sc->sc_bar_mappings[i].bar == bar) 129 return (i); 130 } 131 if (i == PUC_MAX_BAR) { 132 printf("%s: out of bars!\n", __func__); 133 return (-1); 134 } 135 sc->sc_bar_mappings[i].bar = bar; 136 sc->sc_bar_mappings[i].used = 1; 137 return (i); 138 } 139 140 static int 141 puc_probe_ilr(struct puc_softc *sc, struct resource *res) 142 { 143 u_char t1, t2; 144 int i; 145 146 switch (sc->sc_desc.ilr_type) { 147 case PUC_ILR_TYPE_DIGI: 148 sc->ilr_st = rman_get_bustag(res); 149 sc->ilr_sh = rman_get_bushandle(res); 150 for (i = 0; i < 2 && sc->sc_desc.ilr_offset[i] != 0; i++) { 151 t1 = bus_space_read_1(sc->ilr_st, sc->ilr_sh, 152 sc->sc_desc.ilr_offset[i]); 153 t1 = ~t1; 154 bus_space_write_1(sc->ilr_st, sc->ilr_sh, 155 sc->sc_desc.ilr_offset[i], t1); 156 t2 = bus_space_read_1(sc->ilr_st, sc->ilr_sh, 157 sc->sc_desc.ilr_offset[i]); 158 if (t2 == t1) 159 return (0); 160 } 161 return (1); 162 163 default: 164 break; 165 } 166 return (0); 167 } 168 169 int 170 puc_attach(device_t dev, const struct puc_device_description *desc) 171 { 172 char *typestr; 173 int bidx, childunit, i, irq_setup, ressz, rid, type; 174 struct puc_softc *sc; 175 struct puc_device *pdev; 176 struct resource *res; 177 struct resource_list_entry *rle; 178 bus_space_handle_t bh; 179 180 if (desc == NULL) 181 return (ENXIO); 182 183 sc = (struct puc_softc *)device_get_softc(dev); 184 bzero(sc, sizeof(*sc)); 185 sc->sc_desc = *desc; 186 187 #ifdef PUC_DEBUG 188 bootverbose = 1; 189 190 printf("puc: name: %s\n", sc->sc_desc.name); 191 #endif 192 rid = 0; 193 res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, 194 RF_ACTIVE | RF_SHAREABLE); 195 if (!res) 196 return (ENXIO); 197 198 sc->irqres = res; 199 sc->irqrid = rid; 200 #ifdef PUC_FASTINTR 201 irq_setup = bus_setup_intr(dev, res, 202 INTR_TYPE_TTY | INTR_FAST, puc_intr, sc, &sc->intr_cookie); 203 if (irq_setup == 0) 204 sc->fastintr = INTR_FAST; 205 else 206 #else 207 irq_setup = bus_setup_intr(dev, res, 208 INTR_TYPE_TTY, puc_intr, sc, &sc->intr_cookie); 209 #endif 210 if (irq_setup != 0) 211 return (ENXIO); 212 213 rid = 0; 214 for (i = 0; PUC_PORT_VALID(sc->sc_desc, i); i++) { 215 if (i > 0 && rid == sc->sc_desc.ports[i].bar) 216 sc->barmuxed = 1; 217 rid = sc->sc_desc.ports[i].bar; 218 bidx = puc_port_bar_index(sc, rid); 219 220 if (bidx < 0 || sc->sc_bar_mappings[bidx].res != NULL) 221 continue; 222 223 type = (sc->sc_desc.ports[i].flags & PUC_FLAGS_MEMORY) 224 ? SYS_RES_MEMORY : SYS_RES_IOPORT; 225 226 res = bus_alloc_resource_any(dev, type, &rid, 227 RF_ACTIVE); 228 if (res == NULL && 229 sc->sc_desc.ports[i].flags & PUC_FLAGS_ALTRES) { 230 type = (type == SYS_RES_IOPORT) 231 ? SYS_RES_MEMORY : SYS_RES_IOPORT; 232 res = bus_alloc_resource_any(dev, type, &rid, 233 RF_ACTIVE); 234 } 235 if (res == NULL) { 236 device_printf(dev, "could not get resource\n"); 237 continue; 238 } 239 sc->sc_bar_mappings[bidx].type = type; 240 sc->sc_bar_mappings[bidx].res = res; 241 242 if (sc->sc_desc.ilr_type != PUC_ILR_TYPE_NONE) { 243 sc->ilr_enabled = puc_probe_ilr(sc, res); 244 if (sc->ilr_enabled) 245 device_printf(dev, "ILR enabled\n"); 246 else 247 device_printf(dev, "ILR disabled\n"); 248 } 249 #ifdef PUC_DEBUG 250 printf("%s rid %d bst %lx, start %lx, end %lx\n", 251 (type == SYS_RES_MEMORY) ? "memory" : "port", rid, 252 (u_long)rman_get_bustag(res), (u_long)rman_get_start(res), 253 (u_long)rman_get_end(res)); 254 #endif 255 } 256 257 if (desc->init != NULL) { 258 i = desc->init(sc); 259 if (i != 0) 260 return (i); 261 } 262 263 for (i = 0; PUC_PORT_VALID(sc->sc_desc, i); i++) { 264 rid = sc->sc_desc.ports[i].bar; 265 bidx = puc_port_bar_index(sc, rid); 266 if (bidx < 0 || sc->sc_bar_mappings[bidx].res == NULL) 267 continue; 268 269 switch (sc->sc_desc.ports[i].type & ~PUC_PORT_SUBTYPE_MASK) { 270 case PUC_PORT_TYPE_COM: 271 typestr = "sio"; 272 break; 273 case PUC_PORT_TYPE_LPT: 274 typestr = "ppc"; 275 break; 276 case PUC_PORT_TYPE_UART: 277 typestr = "uart"; 278 break; 279 default: 280 continue; 281 } 282 switch (sc->sc_desc.ports[i].type & PUC_PORT_SUBTYPE_MASK) { 283 case PUC_PORT_UART_SAB82532: 284 ressz = 64; 285 break; 286 case PUC_PORT_UART_Z8530: 287 ressz = 2; 288 break; 289 default: 290 ressz = 8; 291 break; 292 } 293 pdev = malloc(sizeof(struct puc_device), M_DEVBUF, 294 M_NOWAIT | M_ZERO); 295 if (!pdev) 296 continue; 297 resource_list_init(&pdev->resources); 298 299 /* First fake up an IRQ resource. */ 300 resource_list_add(&pdev->resources, SYS_RES_IRQ, 0, 301 rman_get_start(sc->irqres), rman_get_end(sc->irqres), 302 rman_get_end(sc->irqres) - rman_get_start(sc->irqres) + 1); 303 rle = resource_list_find(&pdev->resources, SYS_RES_IRQ, 0); 304 rle->res = sc->irqres; 305 306 /* Now fake an IOPORT or MEMORY resource */ 307 res = sc->sc_bar_mappings[bidx].res; 308 type = sc->sc_bar_mappings[bidx].type; 309 resource_list_add(&pdev->resources, type, 0, 310 rman_get_start(res) + sc->sc_desc.ports[i].offset, 311 rman_get_start(res) + sc->sc_desc.ports[i].offset 312 + ressz - 1, ressz); 313 rle = resource_list_find(&pdev->resources, type, 0); 314 315 if (sc->barmuxed == 0) { 316 rle->res = sc->sc_bar_mappings[bidx].res; 317 } else { 318 rle->res = rman_secret_puc_alloc_resource(M_WAITOK); 319 if (rle->res == NULL) { 320 free(pdev, M_DEVBUF); 321 return (ENOMEM); 322 } 323 324 rman_set_start(rle->res, rman_get_start(res) + 325 sc->sc_desc.ports[i].offset); 326 rman_set_end(rle->res, rman_get_start(rle->res) + 327 ressz - 1); 328 rman_set_bustag(rle->res, rman_get_bustag(res)); 329 bus_space_subregion(rman_get_bustag(rle->res), 330 rman_get_bushandle(res), 331 sc->sc_desc.ports[i].offset, ressz, 332 &bh); 333 rman_set_bushandle(rle->res, bh); 334 } 335 336 pdev->port = i + 1; 337 pdev->serialfreq = sc->sc_desc.ports[i].serialfreq; 338 pdev->subtype = sc->sc_desc.ports[i].type & 339 PUC_PORT_SUBTYPE_MASK; 340 pdev->regshft = sc->sc_desc.ports[i].regshft; 341 342 childunit = puc_find_free_unit(typestr); 343 if (childunit < 0 && strcmp(typestr, "uart") != 0) { 344 typestr = "uart"; 345 childunit = puc_find_free_unit(typestr); 346 } 347 sc->sc_ports[i].dev = device_add_child(dev, typestr, 348 childunit); 349 if (sc->sc_ports[i].dev == NULL) { 350 if (sc->barmuxed) { 351 bus_space_unmap(rman_get_bustag(rle->res), 352 rman_get_bushandle(rle->res), ressz); 353 rman_secret_puc_free_resource(rle->res); 354 free(pdev, M_DEVBUF); 355 } 356 continue; 357 } 358 device_set_ivars(sc->sc_ports[i].dev, pdev); 359 device_set_desc(sc->sc_ports[i].dev, sc->sc_desc.name); 360 #ifdef PUC_DEBUG 361 printf("puc: type %d, bar %x, offset %x\n", 362 sc->sc_desc.ports[i].type, 363 sc->sc_desc.ports[i].bar, 364 sc->sc_desc.ports[i].offset); 365 puc_print_resource_list(&pdev->resources); 366 #endif 367 device_set_flags(sc->sc_ports[i].dev, 368 sc->sc_desc.ports[i].flags); 369 if (device_probe_and_attach(sc->sc_ports[i].dev) != 0) { 370 if (sc->barmuxed) { 371 bus_space_unmap(rman_get_bustag(rle->res), 372 rman_get_bushandle(rle->res), ressz); 373 rman_secret_puc_free_resource(rle->res); 374 free(pdev, M_DEVBUF); 375 } 376 } 377 } 378 379 #ifdef PUC_DEBUG 380 bootverbose = 0; 381 #endif 382 return (0); 383 } 384 385 static u_int32_t 386 puc_ilr_read(struct puc_softc *sc) 387 { 388 u_int32_t mask; 389 int i; 390 391 mask = 0; 392 switch (sc->sc_desc.ilr_type) { 393 case PUC_ILR_TYPE_DIGI: 394 for (i = 1; i >= 0 && sc->sc_desc.ilr_offset[i] != 0; i--) { 395 mask = (mask << 8) | (bus_space_read_1(sc->ilr_st, 396 sc->ilr_sh, sc->sc_desc.ilr_offset[i]) & 0xff); 397 } 398 break; 399 400 default: 401 mask = 0xffffffff; 402 break; 403 } 404 return (mask); 405 } 406 407 /* 408 * This is an interrupt handler. For boards that can't tell us which 409 * device generated the interrupt it just calls all the registered 410 * handlers sequencially, but for boards that can tell us which 411 * device(s) generated the interrupt it calls only handlers for devices 412 * that actually generated the interrupt. 413 */ 414 static void 415 puc_intr(void *arg) 416 { 417 int i; 418 u_int32_t ilr_mask; 419 struct puc_softc *sc; 420 421 sc = (struct puc_softc *)arg; 422 ilr_mask = sc->ilr_enabled ? puc_ilr_read(sc) : 0xffffffff; 423 for (i = 0; i < PUC_MAX_PORTS; i++) 424 if (sc->sc_ports[i].ihand != NULL && 425 ((ilr_mask >> i) & 0x00000001)) 426 (sc->sc_ports[i].ihand)(sc->sc_ports[i].ihandarg); 427 } 428 429 static int 430 puc_find_free_unit(char *name) 431 { 432 devclass_t dc; 433 int start; 434 int unit; 435 436 unit = 0; 437 start = 0; 438 while (resource_int_value(name, unit, "port", &start) == 0 && 439 start > 0) 440 unit++; 441 dc = devclass_find(name); 442 if (dc == NULL) 443 return (-1); 444 while (devclass_get_device(dc, unit)) 445 unit++; 446 #ifdef PUC_DEBUG 447 printf("puc: Using %s%d\n", name, unit); 448 #endif 449 return (unit); 450 } 451 452 #ifdef PUC_DEBUG 453 static void 454 puc_print_resource_list(struct resource_list *rl) 455 { 456 #if 0 457 struct resource_list_entry *rle; 458 459 printf("print_resource_list: rl %p\n", rl); 460 SLIST_FOREACH(rle, rl, link) 461 printf(" type %x, rid %x start %lx end %lx count %lx\n", 462 rle->type, rle->rid, rle->start, rle->end, rle->count); 463 printf("print_resource_list: end.\n"); 464 #endif 465 } 466 #endif 467 468 struct resource * 469 puc_alloc_resource(device_t dev, device_t child, int type, int *rid, 470 u_long start, u_long end, u_long count, u_int flags) 471 { 472 struct puc_device *pdev; 473 struct resource *retval; 474 struct resource_list *rl; 475 struct resource_list_entry *rle; 476 device_t my_child; 477 478 /* 479 * in the case of a child of child we need to find our immediate child 480 */ 481 for (my_child = child; device_get_parent(my_child) != dev; 482 my_child = device_get_parent(my_child)); 483 484 pdev = device_get_ivars(my_child); 485 rl = &pdev->resources; 486 487 #ifdef PUC_DEBUG 488 printf("puc_alloc_resource: pdev %p, looking for t %x, r %x\n", 489 pdev, type, *rid); 490 puc_print_resource_list(rl); 491 #endif 492 retval = NULL; 493 rle = resource_list_find(rl, type, *rid); 494 if (rle) { 495 #ifdef PUC_DEBUG 496 printf("found rle, %lx, %lx, %lx\n", rle->start, rle->end, 497 rle->count); 498 #endif 499 retval = rle->res; 500 } 501 #ifdef PUC_DEBUG 502 else 503 printf("oops rle is gone\n"); 504 #endif 505 506 return (retval); 507 } 508 509 int 510 puc_release_resource(device_t dev, device_t child, int type, int rid, 511 struct resource *res) 512 { 513 return (0); 514 } 515 516 int 517 puc_get_resource(device_t dev, device_t child, int type, int rid, 518 u_long *startp, u_long *countp) 519 { 520 struct puc_device *pdev; 521 struct resource_list *rl; 522 struct resource_list_entry *rle; 523 524 pdev = device_get_ivars(child); 525 rl = &pdev->resources; 526 527 #ifdef PUC_DEBUG 528 printf("puc_get_resource: pdev %p, looking for t %x, r %x\n", pdev, 529 type, rid); 530 puc_print_resource_list(rl); 531 #endif 532 rle = resource_list_find(rl, type, rid); 533 if (rle) { 534 #ifdef PUC_DEBUG 535 printf("found rle %p,", rle); 536 #endif 537 if (startp != NULL) 538 *startp = rle->start; 539 if (countp != NULL) 540 *countp = rle->count; 541 #ifdef PUC_DEBUG 542 printf(" %lx, %lx\n", rle->start, rle->count); 543 #endif 544 return (0); 545 } else 546 printf("oops rle is gone\n"); 547 return (ENXIO); 548 } 549 550 int 551 puc_setup_intr(device_t dev, device_t child, struct resource *r, int flags, 552 void (*ihand)(void *), void *arg, void **cookiep) 553 { 554 int i; 555 struct puc_softc *sc; 556 557 sc = (struct puc_softc *)device_get_softc(dev); 558 if ((flags & INTR_FAST) != sc->fastintr) 559 return (ENXIO); 560 for (i = 0; PUC_PORT_VALID(sc->sc_desc, i); i++) { 561 if (sc->sc_ports[i].dev == child) { 562 if (sc->sc_ports[i].ihand != 0) 563 return (ENXIO); 564 sc->sc_ports[i].ihand = ihand; 565 sc->sc_ports[i].ihandarg = arg; 566 *cookiep = arg; 567 return (0); 568 } 569 } 570 return (ENXIO); 571 } 572 573 int 574 puc_teardown_intr(device_t dev, device_t child, struct resource *r, 575 void *cookie) 576 { 577 int i; 578 struct puc_softc *sc; 579 580 sc = (struct puc_softc *)device_get_softc(dev); 581 for (i = 0; PUC_PORT_VALID(sc->sc_desc, i); i++) { 582 if (sc->sc_ports[i].dev == child) { 583 sc->sc_ports[i].ihand = NULL; 584 sc->sc_ports[i].ihandarg = NULL; 585 return (0); 586 } 587 } 588 return (ENXIO); 589 } 590 591 int 592 puc_read_ivar(device_t dev, device_t child, int index, uintptr_t *result) 593 { 594 struct puc_device *pdev; 595 596 pdev = device_get_ivars(child); 597 if (pdev == NULL) 598 return (ENOENT); 599 600 switch(index) { 601 case PUC_IVAR_FREQ: 602 *result = pdev->serialfreq; 603 break; 604 case PUC_IVAR_PORT: 605 *result = pdev->port; 606 break; 607 case PUC_IVAR_REGSHFT: 608 *result = pdev->regshft; 609 break; 610 case PUC_IVAR_SUBTYPE: 611 *result = pdev->subtype; 612 break; 613 default: 614 return (ENOENT); 615 } 616 return (0); 617 } 618