puc.c revision 152662
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: head/sys/dev/puc/puc.c 152662 2005-11-21 20:22:35Z jhb $"); 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 103struct puc_device { 104 struct resource_list resources; 105 int port; 106 int regshft; 107 u_int serialfreq; 108 u_int subtype; 109}; 110 111static void puc_intr(void *arg); 112 113static int puc_find_free_unit(char *); 114#ifdef PUC_DEBUG 115static void puc_print_resource_list(struct resource_list *); 116#endif 117 118devclass_t puc_devclass; 119 120static int 121puc_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 140static int 141puc_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 169int 170puc_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(device_get_parent(dev), 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 irq_setup = BUS_SETUP_INTR(device_get_parent(dev), dev, res, 207 INTR_TYPE_TTY, puc_intr, sc, &sc->intr_cookie); 208#else 209 irq_setup = BUS_SETUP_INTR(device_get_parent(dev), dev, res, 210 INTR_TYPE_TTY, puc_intr, sc, &sc->intr_cookie); 211#endif 212 if (irq_setup != 0) 213 return (ENXIO); 214 215 rid = 0; 216 for (i = 0; PUC_PORT_VALID(sc->sc_desc, i); i++) { 217 if (i > 0 && rid == sc->sc_desc.ports[i].bar) 218 sc->barmuxed = 1; 219 rid = sc->sc_desc.ports[i].bar; 220 bidx = puc_port_bar_index(sc, rid); 221 222 if (bidx < 0 || sc->sc_bar_mappings[bidx].res != NULL) 223 continue; 224 225 type = (sc->sc_desc.ports[i].flags & PUC_FLAGS_MEMORY) 226 ? SYS_RES_MEMORY : SYS_RES_IOPORT; 227 228 res = bus_alloc_resource_any(dev, type, &rid, 229 RF_ACTIVE); 230 if (res == NULL && 231 sc->sc_desc.ports[i].flags & PUC_FLAGS_ALTRES) { 232 type = (type == SYS_RES_IOPORT) 233 ? SYS_RES_MEMORY : SYS_RES_IOPORT; 234 res = bus_alloc_resource_any(dev, type, &rid, 235 RF_ACTIVE); 236 } 237 if (res == NULL) { 238 device_printf(dev, "could not get resource\n"); 239 continue; 240 } 241 sc->sc_bar_mappings[bidx].type = type; 242 sc->sc_bar_mappings[bidx].res = res; 243 244 if (sc->sc_desc.ilr_type != PUC_ILR_TYPE_NONE) { 245 sc->ilr_enabled = puc_probe_ilr(sc, res); 246 if (sc->ilr_enabled) 247 device_printf(dev, "ILR enabled\n"); 248 else 249 device_printf(dev, "ILR disabled\n"); 250 } 251#ifdef PUC_DEBUG 252 printf("%s rid %d bst %lx, start %lx, end %lx\n", 253 (type == SYS_RES_MEMORY) ? "memory" : "port", rid, 254 (u_long)rman_get_bustag(res), (u_long)rman_get_start(res), 255 (u_long)rman_get_end(res)); 256#endif 257 } 258 259 if (desc->init != NULL) { 260 i = desc->init(sc); 261 if (i != 0) 262 return (i); 263 } 264 265 for (i = 0; PUC_PORT_VALID(sc->sc_desc, i); i++) { 266 rid = sc->sc_desc.ports[i].bar; 267 bidx = puc_port_bar_index(sc, rid); 268 if (bidx < 0 || sc->sc_bar_mappings[bidx].res == NULL) 269 continue; 270 271 switch (sc->sc_desc.ports[i].type & ~PUC_PORT_SUBTYPE_MASK) { 272 case PUC_PORT_TYPE_COM: 273 typestr = "sio"; 274 break; 275 case PUC_PORT_TYPE_LPT: 276 typestr = "ppc"; 277 break; 278 case PUC_PORT_TYPE_UART: 279 typestr = "uart"; 280 break; 281 default: 282 continue; 283 } 284 switch (sc->sc_desc.ports[i].type & PUC_PORT_SUBTYPE_MASK) { 285 case PUC_PORT_UART_SAB82532: 286 ressz = 64; 287 break; 288 case PUC_PORT_UART_Z8530: 289 ressz = 2; 290 break; 291 default: 292 ressz = 8; 293 break; 294 } 295 pdev = malloc(sizeof(struct puc_device), M_DEVBUF, 296 M_NOWAIT | M_ZERO); 297 if (!pdev) 298 continue; 299 resource_list_init(&pdev->resources); 300 301 /* First fake up an IRQ resource. */ 302 resource_list_add(&pdev->resources, SYS_RES_IRQ, 0, 303 rman_get_start(sc->irqres), rman_get_end(sc->irqres), 304 rman_get_end(sc->irqres) - rman_get_start(sc->irqres) + 1); 305 rle = resource_list_find(&pdev->resources, SYS_RES_IRQ, 0); 306 rle->res = sc->irqres; 307 308 /* Now fake an IOPORT or MEMORY resource */ 309 res = sc->sc_bar_mappings[bidx].res; 310 type = sc->sc_bar_mappings[bidx].type; 311 resource_list_add(&pdev->resources, type, 0, 312 rman_get_start(res) + sc->sc_desc.ports[i].offset, 313 rman_get_start(res) + sc->sc_desc.ports[i].offset 314 + ressz - 1, ressz); 315 rle = resource_list_find(&pdev->resources, type, 0); 316 317 if (sc->barmuxed == 0) { 318 rle->res = sc->sc_bar_mappings[bidx].res; 319 } else { 320 rle->res = rman_secret_puc_alloc_resource(M_WAITOK); 321 if (rle->res == NULL) { 322 free(pdev, M_DEVBUF); 323 return (ENOMEM); 324 } 325 326 rman_set_start(rle->res, rman_get_start(res) + 327 sc->sc_desc.ports[i].offset); 328 rman_set_end(rle->res, rman_get_start(rle->res) + 329 ressz - 1); 330 rman_set_bustag(rle->res, rman_get_bustag(res)); 331 bus_space_subregion(rman_get_bustag(rle->res), 332 rman_get_bushandle(res), 333 sc->sc_desc.ports[i].offset, ressz, 334 &bh); 335 rman_set_bushandle(rle->res, bh); 336 } 337 338 pdev->port = i + 1; 339 pdev->serialfreq = sc->sc_desc.ports[i].serialfreq; 340 pdev->subtype = sc->sc_desc.ports[i].type & 341 PUC_PORT_SUBTYPE_MASK; 342 pdev->regshft = sc->sc_desc.ports[i].regshft; 343 344 childunit = puc_find_free_unit(typestr); 345 if (childunit < 0 && strcmp(typestr, "uart") != 0) { 346 typestr = "uart"; 347 childunit = puc_find_free_unit(typestr); 348 } 349 sc->sc_ports[i].dev = device_add_child(dev, typestr, 350 childunit); 351 if (sc->sc_ports[i].dev == NULL) { 352 if (sc->barmuxed) { 353 bus_space_unmap(rman_get_bustag(rle->res), 354 rman_get_bushandle(rle->res), ressz); 355 rman_secret_puc_free_resource(rle->res); 356 free(pdev, M_DEVBUF); 357 } 358 continue; 359 } 360 device_set_ivars(sc->sc_ports[i].dev, pdev); 361 device_set_desc(sc->sc_ports[i].dev, sc->sc_desc.name); 362#ifdef PUC_DEBUG 363 printf("puc: type %d, bar %x, offset %x\n", 364 sc->sc_desc.ports[i].type, 365 sc->sc_desc.ports[i].bar, 366 sc->sc_desc.ports[i].offset); 367 puc_print_resource_list(&pdev->resources); 368#endif 369 device_set_flags(sc->sc_ports[i].dev, 370 sc->sc_desc.ports[i].flags); 371 if (device_probe_and_attach(sc->sc_ports[i].dev) != 0) { 372 if (sc->barmuxed) { 373 bus_space_unmap(rman_get_bustag(rle->res), 374 rman_get_bushandle(rle->res), ressz); 375 rman_secret_puc_free_resource(rle->res); 376 free(pdev, M_DEVBUF); 377 } 378 } 379 } 380 381#ifdef PUC_DEBUG 382 bootverbose = 0; 383#endif 384 return (0); 385} 386 387static u_int32_t 388puc_ilr_read(struct puc_softc *sc) 389{ 390 u_int32_t mask; 391 int i; 392 393 mask = 0; 394 switch (sc->sc_desc.ilr_type) { 395 case PUC_ILR_TYPE_DIGI: 396 for (i = 1; i >= 0 && sc->sc_desc.ilr_offset[i] != 0; i--) { 397 mask = (mask << 8) | (bus_space_read_1(sc->ilr_st, 398 sc->ilr_sh, sc->sc_desc.ilr_offset[i]) & 0xff); 399 } 400 break; 401 402 default: 403 mask = 0xffffffff; 404 break; 405 } 406 return (mask); 407} 408 409/* 410 * This is an interrupt handler. For boards that can't tell us which 411 * device generated the interrupt it just calls all the registered 412 * handlers sequencially, but for boards that can tell us which 413 * device(s) generated the interrupt it calls only handlers for devices 414 * that actually generated the interrupt. 415 */ 416static void 417puc_intr(void *arg) 418{ 419 int i; 420 u_int32_t ilr_mask; 421 struct puc_softc *sc; 422 423 sc = (struct puc_softc *)arg; 424 ilr_mask = sc->ilr_enabled ? puc_ilr_read(sc) : 0xffffffff; 425 for (i = 0; i < PUC_MAX_PORTS; i++) 426 if (sc->sc_ports[i].ihand != NULL && 427 ((ilr_mask >> i) & 0x00000001)) 428 (sc->sc_ports[i].ihand)(sc->sc_ports[i].ihandarg); 429} 430 431static int 432puc_find_free_unit(char *name) 433{ 434 devclass_t dc; 435 int start; 436 int unit; 437 438 unit = 0; 439 start = 0; 440 while (resource_int_value(name, unit, "port", &start) == 0 && 441 start > 0) 442 unit++; 443 dc = devclass_find(name); 444 if (dc == NULL) 445 return (-1); 446 while (devclass_get_device(dc, unit)) 447 unit++; 448#ifdef PUC_DEBUG 449 printf("puc: Using %s%d\n", name, unit); 450#endif 451 return (unit); 452} 453 454#ifdef PUC_DEBUG 455static void 456puc_print_resource_list(struct resource_list *rl) 457{ 458#if 0 459 struct resource_list_entry *rle; 460 461 printf("print_resource_list: rl %p\n", rl); 462 SLIST_FOREACH(rle, rl, link) 463 printf(" type %x, rid %x start %lx end %lx count %lx\n", 464 rle->type, rle->rid, rle->start, rle->end, rle->count); 465 printf("print_resource_list: end.\n"); 466#endif 467} 468#endif 469 470struct resource * 471puc_alloc_resource(device_t dev, device_t child, int type, int *rid, 472 u_long start, u_long end, u_long count, u_int flags) 473{ 474 struct puc_device *pdev; 475 struct resource *retval; 476 struct resource_list *rl; 477 struct resource_list_entry *rle; 478 device_t my_child; 479 480 /* 481 * in the case of a child of child we need to find our immediate child 482 */ 483 for (my_child = child; device_get_parent(my_child) != dev; 484 my_child = device_get_parent(my_child)); 485 486 pdev = device_get_ivars(my_child); 487 rl = &pdev->resources; 488 489#ifdef PUC_DEBUG 490 printf("puc_alloc_resource: pdev %p, looking for t %x, r %x\n", 491 pdev, type, *rid); 492 puc_print_resource_list(rl); 493#endif 494 retval = NULL; 495 rle = resource_list_find(rl, type, *rid); 496 if (rle) { 497#ifdef PUC_DEBUG 498 printf("found rle, %lx, %lx, %lx\n", rle->start, rle->end, 499 rle->count); 500#endif 501 retval = rle->res; 502 } 503#ifdef PUC_DEBUG 504 else 505 printf("oops rle is gone\n"); 506#endif 507 508 return (retval); 509} 510 511int 512puc_release_resource(device_t dev, device_t child, int type, int rid, 513 struct resource *res) 514{ 515 return (0); 516} 517 518int 519puc_get_resource(device_t dev, device_t child, int type, int rid, 520 u_long *startp, u_long *countp) 521{ 522 struct puc_device *pdev; 523 struct resource_list *rl; 524 struct resource_list_entry *rle; 525 526 pdev = device_get_ivars(child); 527 rl = &pdev->resources; 528 529#ifdef PUC_DEBUG 530 printf("puc_get_resource: pdev %p, looking for t %x, r %x\n", pdev, 531 type, rid); 532 puc_print_resource_list(rl); 533#endif 534 rle = resource_list_find(rl, type, rid); 535 if (rle) { 536#ifdef PUC_DEBUG 537 printf("found rle %p,", rle); 538#endif 539 if (startp != NULL) 540 *startp = rle->start; 541 if (countp != NULL) 542 *countp = rle->count; 543#ifdef PUC_DEBUG 544 printf(" %lx, %lx\n", rle->start, rle->count); 545#endif 546 return (0); 547 } else 548 printf("oops rle is gone\n"); 549 return (ENXIO); 550} 551 552int 553puc_setup_intr(device_t dev, device_t child, struct resource *r, int flags, 554 void (*ihand)(void *), void *arg, void **cookiep) 555{ 556 int i; 557 struct puc_softc *sc; 558 559 sc = (struct puc_softc *)device_get_softc(dev); 560 if ((flags & INTR_FAST) != sc->fastintr) 561 return (ENXIO); 562 for (i = 0; PUC_PORT_VALID(sc->sc_desc, i); i++) { 563 if (sc->sc_ports[i].dev == child) { 564 if (sc->sc_ports[i].ihand != 0) 565 return (ENXIO); 566 sc->sc_ports[i].ihand = ihand; 567 sc->sc_ports[i].ihandarg = arg; 568 *cookiep = arg; 569 return (0); 570 } 571 } 572 return (ENXIO); 573} 574 575int 576puc_teardown_intr(device_t dev, device_t child, struct resource *r, 577 void *cookie) 578{ 579 int i; 580 struct puc_softc *sc; 581 582 sc = (struct puc_softc *)device_get_softc(dev); 583 for (i = 0; PUC_PORT_VALID(sc->sc_desc, i); i++) { 584 if (sc->sc_ports[i].dev == child) { 585 sc->sc_ports[i].ihand = NULL; 586 sc->sc_ports[i].ihandarg = NULL; 587 return (0); 588 } 589 } 590 return (ENXIO); 591} 592 593int 594puc_read_ivar(device_t dev, device_t child, int index, uintptr_t *result) 595{ 596 struct puc_device *pdev; 597 598 pdev = device_get_ivars(child); 599 if (pdev == NULL) 600 return (ENOENT); 601 602 switch(index) { 603 case PUC_IVAR_FREQ: 604 *result = pdev->serialfreq; 605 break; 606 case PUC_IVAR_PORT: 607 *result = pdev->port; 608 break; 609 case PUC_IVAR_REGSHFT: 610 *result = pdev->regshft; 611 break; 612 case PUC_IVAR_SUBTYPE: 613 *result = pdev->subtype; 614 break; 615 default: 616 return (ENOENT); 617 } 618 return (0); 619} 620