1 /* $OpenBSD: puc.c,v 1.29 2020/03/02 19:45:42 patrick 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 65 #include <dev/ic/comreg.h> 66 #include <dev/ic/comvar.h> 67 68 #include "com.h" 69 70 struct puc_pci_softc { 71 struct puc_softc sc_psc; 72 73 pci_chipset_tag_t pc; 74 pci_intr_handle_t ih; 75 }; 76 77 int puc_pci_match(struct device *, void *, void *); 78 void puc_pci_attach(struct device *, struct device *, void *); 79 int puc_pci_detach(struct device *, int); 80 const char *puc_pci_intr_string(struct puc_attach_args *); 81 void *puc_pci_intr_establish(struct puc_attach_args *, int, 82 int (*)(void *), void *, char *); 83 84 struct cfattach puc_pci_ca = { 85 sizeof(struct puc_pci_softc), puc_pci_match, 86 puc_pci_attach, puc_pci_detach 87 }; 88 89 struct cfdriver puc_cd = { 90 NULL, "puc", DV_DULL 91 }; 92 93 const char *puc_port_type_name(int); 94 95 int 96 puc_pci_match(struct device *parent, void *match, void *aux) 97 { 98 struct pci_attach_args *pa = aux; 99 const struct puc_device_description *desc; 100 pcireg_t bhlc, subsys; 101 102 bhlc = pci_conf_read(pa->pa_pc, pa->pa_tag, PCI_BHLC_REG); 103 if (PCI_HDRTYPE_TYPE(bhlc) != 0) 104 return (0); 105 106 subsys = pci_conf_read(pa->pa_pc, pa->pa_tag, PCI_SUBSYS_ID_REG); 107 108 desc = puc_find_description(PCI_VENDOR(pa->pa_id), 109 PCI_PRODUCT(pa->pa_id), PCI_VENDOR(subsys), PCI_PRODUCT(subsys)); 110 if (desc != NULL) 111 return (1); 112 113 return (0); 114 } 115 116 const char * 117 puc_pci_intr_string(struct puc_attach_args *paa) 118 { 119 struct puc_pci_softc *sc = paa->puc; 120 121 return (pci_intr_string(sc->pc, sc->ih)); 122 } 123 124 void * 125 puc_pci_intr_establish(struct puc_attach_args *paa, int type, 126 int (*func)(void *), void *arg, char *name) 127 { 128 struct puc_pci_softc *sc = paa->puc; 129 struct puc_softc *psc = &sc->sc_psc; 130 131 psc->sc_ports[paa->port].intrhand = 132 pci_intr_establish(sc->pc, sc->ih, type, func, arg, name); 133 134 return (psc->sc_ports[paa->port].intrhand); 135 } 136 137 void 138 puc_pci_attach(struct device *parent, struct device *self, void *aux) 139 { 140 struct puc_pci_softc *psc = (struct puc_pci_softc *)self; 141 struct puc_softc *sc = &psc->sc_psc; 142 struct pci_attach_args *pa = aux; 143 struct puc_attach_args paa; 144 pcireg_t subsys; 145 int i; 146 147 subsys = pci_conf_read(pa->pa_pc, pa->pa_tag, PCI_SUBSYS_ID_REG); 148 sc->sc_desc = puc_find_description(PCI_VENDOR(pa->pa_id), 149 PCI_PRODUCT(pa->pa_id), PCI_VENDOR(subsys), PCI_PRODUCT(subsys)); 150 151 puc_print_ports(sc->sc_desc); 152 153 for (i = 0; i < PUC_NBARS; i++) { 154 pcireg_t type; 155 int bar; 156 157 sc->sc_bar_mappings[i].mapped = 0; 158 bar = PCI_MAPREG_START + 4 * i; 159 if (!pci_mapreg_probe(pa->pa_pc, pa->pa_tag, bar, &type)) 160 continue; 161 162 sc->sc_bar_mappings[i].mapped = (pci_mapreg_map(pa, bar, type, 163 0, &sc->sc_bar_mappings[i].t, &sc->sc_bar_mappings[i].h, 164 &sc->sc_bar_mappings[i].a, &sc->sc_bar_mappings[i].s, 0) 165 == 0); 166 if (sc->sc_bar_mappings[i].mapped) { 167 if (type == PCI_MAPREG_MEM_TYPE_64BIT) 168 i++; 169 continue; 170 } 171 172 #if NCOM > 0 173 /* 174 * If a port on this card is used as serial console, 175 * mapping the associated BAR will fail because the 176 * bus space is already mapped. In that case, we try 177 * to re-use the already existing mapping. 178 * Unfortunately this means that if a BAR is used to 179 * support multiple ports, only the first port will 180 * work. 181 */ 182 if (pci_mapreg_info(pa->pa_pc, pa->pa_tag, bar, type, 183 &sc->sc_bar_mappings[i].a, NULL, NULL) == 0 && 184 pa->pa_iot == comconsiot && 185 sc->sc_bar_mappings[i].a == comconsaddr) { 186 sc->sc_bar_mappings[i].t = comconsiot; 187 sc->sc_bar_mappings[i].h = comconsioh; 188 sc->sc_bar_mappings[i].s = COM_NPORTS; 189 sc->sc_bar_mappings[i].mapped = 1; 190 if (type == PCI_MAPREG_MEM_TYPE_64BIT) 191 i++; 192 continue; 193 } 194 #endif 195 196 printf("%s: couldn't map BAR at offset 0x%lx\n", 197 sc->sc_dev.dv_xname, (long)bar); 198 } 199 200 /* Map interrupt. */ 201 psc->pc = pa->pa_pc; 202 if (pci_intr_map(pa, &psc->ih)) { 203 printf("%s: couldn't map interrupt\n", sc->sc_dev.dv_xname); 204 return; 205 } 206 207 paa.puc = sc; 208 paa.intr_string = &puc_pci_intr_string; 209 paa.intr_establish = &puc_pci_intr_establish; 210 211 puc_common_attach(sc, &paa); 212 } 213 214 void 215 puc_common_attach(struct puc_softc *sc, struct puc_attach_args *paa) 216 { 217 const struct puc_device_description *desc = sc->sc_desc; 218 int i, bar; 219 220 /* Configure each port. */ 221 for (i = 0; i < PUC_MAX_PORTS; i++) { 222 if (desc->ports[i].type == 0) /* neither com or lpt */ 223 continue; 224 /* make sure the base address register is mapped */ 225 bar = PUC_PORT_BAR_INDEX(desc->ports[i].bar); 226 if (!sc->sc_bar_mappings[bar].mapped) { 227 printf("%s: %s port uses unmapped BAR (0x%x)\n", 228 sc->sc_dev.dv_xname, 229 puc_port_type_name(desc->ports[i].type), 230 desc->ports[i].bar); 231 continue; 232 } 233 234 /* set up to configure the child device */ 235 paa->port = i; 236 paa->a = sc->sc_bar_mappings[bar].a; 237 paa->t = sc->sc_bar_mappings[bar].t; 238 239 paa->type = desc->ports[i].type; 240 241 if (desc->ports[i].offset >= sc->sc_bar_mappings[bar].s || 242 bus_space_subregion(sc->sc_bar_mappings[bar].t, 243 sc->sc_bar_mappings[bar].h, desc->ports[i].offset, 244 sc->sc_bar_mappings[bar].s - desc->ports[i].offset, 245 &paa->h)) { 246 printf("%s: couldn't get subregion for port %d\n", 247 sc->sc_dev.dv_xname, i); 248 continue; 249 } 250 251 #if 0 252 if (autoconf_verbose) 253 printf("%s: port %d: %s @ (index %d) 0x%x " 254 "(0x%lx, 0x%lx)\n", sc->sc_dev.dv_xname, paa->port, 255 puc_port_type_name(paa->type), bar, (int)paa->a, 256 (long)paa->t, (long)paa->h); 257 #endif 258 259 /* and configure it */ 260 sc->sc_ports[i].dev = config_found_sm(&sc->sc_dev, paa, 261 puc_print, puc_submatch); 262 } 263 } 264 265 int 266 puc_pci_detach(struct device *self, int flags) 267 { 268 struct puc_pci_softc *sc = (struct puc_pci_softc *)self; 269 struct puc_softc *psc = &sc->sc_psc; 270 int i, rv; 271 272 for (i = PUC_MAX_PORTS; i--; ) { 273 if (psc->sc_ports[i].intrhand) 274 pci_intr_disestablish(sc->pc, 275 psc->sc_ports[i].intrhand); 276 if (psc->sc_ports[i].dev) 277 if ((rv = config_detach(psc->sc_ports[i].dev, flags))) 278 return (rv); 279 } 280 281 for (i = PUC_NBARS; i--; ) 282 if (psc->sc_bar_mappings[i].mapped) 283 bus_space_unmap(psc->sc_bar_mappings[i].t, 284 psc->sc_bar_mappings[i].h, 285 psc->sc_bar_mappings[i].s); 286 287 return (0); 288 } 289 290 int 291 puc_print(void *aux, const char *pnp) 292 { 293 struct puc_attach_args *paa = aux; 294 295 if (pnp) 296 printf("%s at %s", puc_port_type_name(paa->type), pnp); 297 printf(" port %d", paa->port); 298 return (UNCONF); 299 } 300 301 int 302 puc_submatch(struct device *parent, void *vcf, void *aux) 303 { 304 struct cfdata *cf = (struct cfdata *)vcf; 305 struct puc_attach_args *aa = aux; 306 307 if (cf->cf_loc[0] != -1 && cf->cf_loc[0] != aa->port) 308 return 0; 309 return ((*cf->cf_attach->ca_match)(parent, cf, aux)); 310 } 311 312 const struct puc_device_description * 313 puc_find_description(u_int16_t vend, u_int16_t prod, 314 u_int16_t svend, u_int16_t sprod) 315 { 316 int i; 317 318 for (i = 0; i < puc_ndevs; i++) 319 if ((vend & puc_devs[i].rmask[0]) == puc_devs[i].rval[0] && 320 (prod & puc_devs[i].rmask[1]) == puc_devs[i].rval[1] && 321 (svend & puc_devs[i].rmask[2]) == puc_devs[i].rval[2] && 322 (sprod & puc_devs[i].rmask[3]) == puc_devs[i].rval[3]) 323 return (&puc_devs[i]); 324 325 return (NULL); 326 } 327 328 const char * 329 puc_port_type_name(int type) 330 { 331 332 if (PUC_IS_COM(type)) 333 return "com"; 334 if (PUC_IS_LPT(type)) 335 return "lpt"; 336 return (NULL); 337 } 338 339 void 340 puc_print_ports(const struct puc_device_description *desc) 341 { 342 int i, ncom, nlpt; 343 344 printf(": ports: "); 345 for (i = ncom = nlpt = 0; i < PUC_MAX_PORTS; i++) { 346 if (PUC_IS_COM(desc->ports[i].type)) 347 ncom++; 348 else if (PUC_IS_LPT(desc->ports[i].type)) 349 nlpt++; 350 } 351 if (ncom) 352 printf("%d com", ncom); 353 if (nlpt) { 354 if (ncom) 355 printf(", "); 356 printf("%d lpt", nlpt); 357 } 358 printf("\n"); 359 } 360