1 /* $OpenBSD: puc.c,v 1.32 2024/11/09 10:23:06 miod Exp $ */ 2 /* $NetBSD: puc.c,v 1.3 1999/02/06 06:29:54 cgd Exp $ */ 3 4 /* 5 * Copyright (c) 1996, 1998, 1999 6 * Christopher G. Demetriou. All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 3. All advertising materials mentioning features or use of this software 17 * must display the following acknowledgement: 18 * This product includes software developed by Christopher G. Demetriou 19 * for the NetBSD Project. 20 * 4. The name of the author may not be used to endorse or promote products 21 * derived from this software without specific prior written permission 22 * 23 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 24 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 25 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 26 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 27 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 28 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 32 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 33 */ 34 35 /* 36 * PCI "universal" communication card device driver, glues com, lpt, 37 * and similar ports to PCI via bridge chip often much larger than 38 * the devices being glued. 39 * 40 * Author: Christopher G. Demetriou, May 14, 1998 (derived from NetBSD 41 * sys/dev/pci/pciide.c, revision 1.6). 42 * 43 * These devices could be (and some times are) described as 44 * communications/{serial,parallel}, etc. devices with known 45 * programming interfaces, but those programming interfaces (in 46 * particular the BAR assignments for devices, etc.) in fact are not 47 * particularly well defined. 48 * 49 * After I/we have seen more of these devices, it may be possible 50 * to generalize some of these bits. In particular, devices which 51 * describe themselves as communications/serial/16[45]50, and 52 * communications/parallel/??? might be attached via direct 53 * 'com' and 'lpt' attachments to pci. 54 */ 55 56 #include <sys/param.h> 57 #include <sys/systm.h> 58 #include <sys/device.h> 59 #include <sys/tty.h> 60 61 #include <dev/pci/pcireg.h> 62 #include <dev/pci/pcivar.h> 63 #include <dev/pci/pucvar.h> 64 #include <dev/pci/pcidevs.h> 65 66 #include <dev/ic/comreg.h> 67 #include <dev/ic/comvar.h> 68 69 #include "com.h" 70 71 struct puc_pci_softc { 72 struct puc_softc sc_psc; 73 74 pci_chipset_tag_t pc; 75 pci_intr_handle_t ih; 76 }; 77 78 int puc_pci_match(struct device *, void *, void *); 79 void puc_pci_attach(struct device *, struct device *, void *); 80 int puc_pci_detach(struct device *, int); 81 const char *puc_pci_intr_string(struct puc_attach_args *); 82 void *puc_pci_intr_establish(struct puc_attach_args *, int, 83 int (*)(void *), void *, char *); 84 int puc_pci_xr17v35x_intr(void *arg); 85 86 const struct cfattach puc_pci_ca = { 87 sizeof(struct puc_pci_softc), puc_pci_match, 88 puc_pci_attach, puc_pci_detach 89 }; 90 91 struct cfdriver puc_cd = { 92 NULL, "puc", DV_DULL 93 }; 94 95 const char *puc_port_type_name(int); 96 97 int 98 puc_pci_match(struct device *parent, void *match, void *aux) 99 { 100 struct pci_attach_args *pa = aux; 101 const struct puc_device_description *desc; 102 pcireg_t bhlc, subsys; 103 104 bhlc = pci_conf_read(pa->pa_pc, pa->pa_tag, PCI_BHLC_REG); 105 if (PCI_HDRTYPE_TYPE(bhlc) != 0) 106 return (0); 107 108 subsys = pci_conf_read(pa->pa_pc, pa->pa_tag, PCI_SUBSYS_ID_REG); 109 110 desc = puc_find_description(PCI_VENDOR(pa->pa_id), 111 PCI_PRODUCT(pa->pa_id), PCI_VENDOR(subsys), PCI_PRODUCT(subsys)); 112 if (desc != NULL) 113 return (1); 114 115 return (0); 116 } 117 118 const char * 119 puc_pci_intr_string(struct puc_attach_args *paa) 120 { 121 struct puc_pci_softc *sc = paa->puc; 122 123 return (pci_intr_string(sc->pc, sc->ih)); 124 } 125 126 void * 127 puc_pci_intr_establish(struct puc_attach_args *paa, int type, 128 int (*func)(void *), void *arg, char *name) 129 { 130 struct puc_pci_softc *sc = paa->puc; 131 struct puc_softc *psc = &sc->sc_psc; 132 133 if (psc->sc_xr17v35x) { 134 psc->sc_ports[paa->port].real_intrhand = func; 135 psc->sc_ports[paa->port].real_intrhand_arg = arg; 136 if (paa->port == 0) 137 psc->sc_ports[paa->port].intrhand = 138 pci_intr_establish(sc->pc, sc->ih, type, 139 puc_pci_xr17v35x_intr, sc, name); 140 return (psc->sc_ports[paa->port].real_intrhand); 141 } 142 143 psc->sc_ports[paa->port].intrhand = 144 pci_intr_establish(sc->pc, sc->ih, type, func, arg, name); 145 146 return (psc->sc_ports[paa->port].intrhand); 147 } 148 149 void 150 puc_pci_attach(struct device *parent, struct device *self, void *aux) 151 { 152 struct puc_pci_softc *psc = (struct puc_pci_softc *)self; 153 struct puc_softc *sc = &psc->sc_psc; 154 struct pci_attach_args *pa = aux; 155 struct puc_attach_args paa; 156 pcireg_t subsys; 157 int i; 158 159 subsys = pci_conf_read(pa->pa_pc, pa->pa_tag, PCI_SUBSYS_ID_REG); 160 sc->sc_desc = puc_find_description(PCI_VENDOR(pa->pa_id), 161 PCI_PRODUCT(pa->pa_id), PCI_VENDOR(subsys), PCI_PRODUCT(subsys)); 162 163 if (PCI_VENDOR(pa->pa_id) == PCI_VENDOR_EXAR && 164 (PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_EXAR_XR17V352 || 165 PCI_PRODUCT(pa->pa_id) == PCI_PRODUCT_EXAR_XR17V354)) 166 sc->sc_xr17v35x = 1; 167 168 puc_print_ports(sc->sc_desc); 169 170 for (i = 0; i < PUC_NBARS; i++) { 171 pcireg_t type; 172 int bar; 173 174 sc->sc_bar_mappings[i].mapped = 0; 175 bar = PCI_MAPREG_START + 4 * i; 176 if (!pci_mapreg_probe(pa->pa_pc, pa->pa_tag, bar, &type)) 177 continue; 178 179 sc->sc_bar_mappings[i].mapped = (pci_mapreg_map(pa, bar, type, 180 0, &sc->sc_bar_mappings[i].t, &sc->sc_bar_mappings[i].h, 181 &sc->sc_bar_mappings[i].a, &sc->sc_bar_mappings[i].s, 0) 182 == 0); 183 if (sc->sc_bar_mappings[i].mapped) { 184 if (type == PCI_MAPREG_MEM_TYPE_64BIT) 185 i++; 186 continue; 187 } 188 189 #if NCOM > 0 190 /* 191 * If a port on this card is used as serial console, 192 * mapping the associated BAR will fail because the 193 * bus space is already mapped. In that case, we try 194 * to re-use the already existing mapping. 195 * Unfortunately this means that if a BAR is used to 196 * support multiple ports, only the first port will 197 * work. 198 */ 199 if (pci_mapreg_info(pa->pa_pc, pa->pa_tag, bar, type, 200 &sc->sc_bar_mappings[i].a, NULL, NULL) == 0 && 201 pa->pa_iot == comconsiot && 202 sc->sc_bar_mappings[i].a == comconsaddr) { 203 sc->sc_bar_mappings[i].t = comconsiot; 204 sc->sc_bar_mappings[i].h = comconsioh; 205 sc->sc_bar_mappings[i].s = COM_NPORTS; 206 sc->sc_bar_mappings[i].mapped = 1; 207 if (type == PCI_MAPREG_MEM_TYPE_64BIT) 208 i++; 209 continue; 210 } 211 #endif 212 213 printf("%s: couldn't map BAR at offset 0x%lx\n", 214 sc->sc_dev.dv_xname, (long)bar); 215 } 216 217 /* Map interrupt. */ 218 psc->pc = pa->pa_pc; 219 if (pci_intr_map(pa, &psc->ih)) { 220 printf("%s: couldn't map interrupt\n", sc->sc_dev.dv_xname); 221 return; 222 } 223 224 paa.puc = sc; 225 paa.intr_string = &puc_pci_intr_string; 226 paa.intr_establish = &puc_pci_intr_establish; 227 228 puc_common_attach(sc, &paa); 229 } 230 231 void 232 puc_common_attach(struct puc_softc *sc, struct puc_attach_args *paa) 233 { 234 const struct puc_device_description *desc = sc->sc_desc; 235 int i, bar; 236 237 /* Configure each port. */ 238 for (i = 0; i < PUC_MAX_PORTS; i++) { 239 if (desc->ports[i].type == 0) /* neither com or lpt */ 240 continue; 241 /* make sure the base address register is mapped */ 242 bar = PUC_PORT_BAR_INDEX(desc->ports[i].bar); 243 if (!sc->sc_bar_mappings[bar].mapped) { 244 printf("%s: %s port uses unmapped BAR (0x%x)\n", 245 sc->sc_dev.dv_xname, 246 puc_port_type_name(desc->ports[i].type), 247 desc->ports[i].bar); 248 continue; 249 } 250 251 /* set up to configure the child device */ 252 paa->port = i; 253 paa->a = sc->sc_bar_mappings[bar].a; 254 paa->t = sc->sc_bar_mappings[bar].t; 255 256 paa->type = desc->ports[i].type; 257 258 if (desc->ports[i].offset >= sc->sc_bar_mappings[bar].s || 259 bus_space_subregion(sc->sc_bar_mappings[bar].t, 260 sc->sc_bar_mappings[bar].h, desc->ports[i].offset, 261 sc->sc_bar_mappings[bar].s - desc->ports[i].offset, 262 &paa->h)) { 263 printf("%s: couldn't get subregion for port %d\n", 264 sc->sc_dev.dv_xname, i); 265 continue; 266 } 267 268 #if 0 269 if (autoconf_verbose) 270 printf("%s: port %d: %s @ (index %d) 0x%x " 271 "(0x%lx, 0x%lx)\n", sc->sc_dev.dv_xname, paa->port, 272 puc_port_type_name(paa->type), bar, (int)paa->a, 273 (long)paa->t, (long)paa->h); 274 #endif 275 276 /* and configure it */ 277 sc->sc_ports[i].dev = config_found_sm(&sc->sc_dev, paa, 278 puc_print, puc_submatch); 279 } 280 } 281 282 int 283 puc_pci_detach(struct device *self, int flags) 284 { 285 struct puc_pci_softc *sc = (struct puc_pci_softc *)self; 286 struct puc_softc *psc = &sc->sc_psc; 287 int i, rv; 288 289 for (i = PUC_MAX_PORTS; i--; ) { 290 if (psc->sc_ports[i].intrhand) 291 pci_intr_disestablish(sc->pc, 292 psc->sc_ports[i].intrhand); 293 if (psc->sc_ports[i].dev) 294 if ((rv = config_detach(psc->sc_ports[i].dev, flags))) 295 return (rv); 296 } 297 298 for (i = PUC_NBARS; i--; ) 299 if (psc->sc_bar_mappings[i].mapped) 300 bus_space_unmap(psc->sc_bar_mappings[i].t, 301 psc->sc_bar_mappings[i].h, 302 psc->sc_bar_mappings[i].s); 303 304 return (0); 305 } 306 307 int 308 puc_print(void *aux, const char *pnp) 309 { 310 struct puc_attach_args *paa = aux; 311 312 if (pnp) 313 printf("%s at %s", puc_port_type_name(paa->type), pnp); 314 printf(" port %d", paa->port); 315 return (UNCONF); 316 } 317 318 int 319 puc_submatch(struct device *parent, void *vcf, void *aux) 320 { 321 struct cfdata *cf = (struct cfdata *)vcf; 322 struct puc_attach_args *aa = aux; 323 324 if (cf->cf_loc[0] != -1 && cf->cf_loc[0] != aa->port) 325 return 0; 326 return ((*cf->cf_attach->ca_match)(parent, cf, aux)); 327 } 328 329 const struct puc_device_description * 330 puc_find_description(u_int16_t vend, u_int16_t prod, 331 u_int16_t svend, u_int16_t sprod) 332 { 333 int i; 334 335 for (i = 0; i < puc_ndevs; i++) 336 if ((vend & puc_devs[i].rmask[0]) == puc_devs[i].rval[0] && 337 (prod & puc_devs[i].rmask[1]) == puc_devs[i].rval[1] && 338 (svend & puc_devs[i].rmask[2]) == puc_devs[i].rval[2] && 339 (sprod & puc_devs[i].rmask[3]) == puc_devs[i].rval[3]) 340 return (&puc_devs[i]); 341 342 return (NULL); 343 } 344 345 const char * 346 puc_port_type_name(int type) 347 { 348 if (PUC_IS_COM(type)) 349 return "com"; 350 if (PUC_IS_LPT(type)) 351 return "lpt"; 352 return (NULL); 353 } 354 355 void 356 puc_print_ports(const struct puc_device_description *desc) 357 { 358 int i, ncom, nlpt; 359 360 printf(": ports: "); 361 for (i = ncom = nlpt = 0; i < PUC_MAX_PORTS; i++) { 362 if (PUC_IS_COM(desc->ports[i].type)) 363 ncom++; 364 else if (PUC_IS_LPT(desc->ports[i].type)) 365 nlpt++; 366 } 367 if (ncom) 368 printf("%d com", ncom); 369 if (nlpt) { 370 if (ncom) 371 printf(", "); 372 printf("%d lpt", nlpt); 373 } 374 printf("\n"); 375 } 376 377 int 378 puc_pci_xr17v35x_intr(void *arg) 379 { 380 struct puc_pci_softc *sc = arg; 381 struct puc_softc *psc = &sc->sc_psc; 382 int ports, i; 383 384 ports = bus_space_read_1(psc->sc_bar_mappings[0].t, 385 psc->sc_bar_mappings[0].h, UART_EXAR_INT0); 386 387 for (i = 0; i < 8; i++) { 388 if ((ports & (1 << i)) && psc->sc_ports[i].real_intrhand) 389 (*(psc->sc_ports[i].real_intrhand))( 390 psc->sc_ports[i].real_intrhand_arg); 391 } 392 393 return (1); 394 } 395