Home | History | Annotate | Line # | Download | only in pcmcia
pcmcom.c revision 1.42
      1 /*	$NetBSD: pcmcom.c,v 1.42 2021/04/24 23:36:58 thorpej Exp $	*/
      2 
      3 /*-
      4  * Copyright (c) 1998, 2000, 2004 The NetBSD Foundation, Inc.
      5  * All rights reserved.
      6  *
      7  * This code is derived from software contributed to The NetBSD Foundation
      8  * by RedBack Networks, Inc.
      9  *
     10  * Redistribution and use in source and binary forms, with or without
     11  * modification, are permitted provided that the following conditions
     12  * are met:
     13  * 1. Redistributions of source code must retain the above copyright
     14  *    notice, this list of conditions and the following disclaimer.
     15  * 2. Redistributions in binary form must reproduce the above copyright
     16  *    notice, this list of conditions and the following disclaimer in the
     17  *    documentation and/or other materials provided with the distribution.
     18  *
     19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
     20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
     21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
     23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
     24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
     25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
     26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
     27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
     28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
     29  * POSSIBILITY OF SUCH DAMAGE.
     30  */
     31 
     32 /*
     33  * Device driver for multi-port PCMCIA serial cards, written by
     34  * Jason R. Thorpe for RedBack Networks, Inc.
     35  *
     36  * Most of these cards are simply multiple UARTs sharing a single interrupt
     37  * line, and rely on the fact that PCMCIA level-triggered interrupts can
     38  * be shared.  There are no special interrupt registers on them, as there
     39  * are on most ISA multi-port serial cards.
     40  *
     41  * If there are other cards that have interrupt registers, they should not
     42  * be glued into this driver.  Rather, separate drivers should be written
     43  * for those devices, as we have in the ISA multi-port serial card case.
     44  */
     45 
     46 #include <sys/cdefs.h>
     47 __KERNEL_RCSID(0, "$NetBSD: pcmcom.c,v 1.42 2021/04/24 23:36:58 thorpej Exp $");
     48 
     49 #include <sys/param.h>
     50 #include <sys/systm.h>
     51 #include <sys/device.h>
     52 #include <sys/termios.h>
     53 #include <sys/malloc.h>
     54 
     55 #include <sys/bus.h>
     56 #include <sys/intr.h>
     57 
     58 #include <dev/ic/comreg.h>
     59 #include <dev/ic/comvar.h>
     60 
     61 #include <dev/pcmcia/pcmciavar.h>
     62 #include <dev/pcmcia/pcmciareg.h>
     63 #include <dev/pcmcia/pcmciadevs.h>
     64 
     65 #include "com.h"
     66 #include "pcmcom.h"
     67 
     68 #include "locators.h"
     69 
     70 struct pcmcom_softc {
     71 	device_t sc_dev;			/* generic device glue */
     72 
     73 	struct pcmcia_function *sc_pf;		/* our PCMCIA function */
     74 	void *sc_ih;				/* interrupt handle */
     75 	int sc_enabled_count;			/* enabled count */
     76 
     77 #define	NSLAVES			8
     78 	device_t sc_slaves[NSLAVES];	/* slave info */
     79 	int sc_nslaves;				/* slave count */
     80 
     81 	int sc_state;
     82 #define	PCMCOM_ATTACHED		3
     83 };
     84 
     85 struct pcmcom_attach_args {
     86 	bus_space_tag_t pca_iot;		/* I/O tag */
     87 	bus_space_handle_t pca_ioh;		/* I/O handle */
     88 	int pca_slave;				/* slave # */
     89 };
     90 
     91 int	pcmcom_match(device_t, cfdata_t, void *);
     92 int	pcmcom_validate_config(struct pcmcia_config_entry *);
     93 void	pcmcom_attach(device_t, device_t, void *);
     94 int	pcmcom_detach(device_t, int);
     95 void	pcmcom_childdet(device_t, device_t);
     96 
     97 CFATTACH_DECL_NEW(pcmcom, sizeof(struct pcmcom_softc),
     98     pcmcom_match, pcmcom_attach, pcmcom_detach, NULL);
     99 
    100 const struct pcmcia_product pcmcom_products[] = {
    101 	{ PCMCIA_VENDOR_SOCKET, PCMCIA_PRODUCT_SOCKET_DUAL_RS232,
    102 	  PCMCIA_CIS_INVALID },
    103 #if 0	/* does not work */
    104 	{ PCMCIA_VENDOR_SOCKET, PCMCIA_PRODUCT_SOCKET_DUAL_RS232_A,
    105 	  PCMCIA_CIS_INVALID },
    106 #endif
    107 };
    108 const size_t pcmcom_nproducts = __arraycount(pcmcom_products);
    109 
    110 int	pcmcom_print(void *, const char *);
    111 
    112 int	pcmcom_enable(struct pcmcom_softc *);
    113 void	pcmcom_disable(struct pcmcom_softc *);
    114 
    115 int	pcmcom_intr(void *);
    116 
    117 int
    118 pcmcom_match(device_t parent, cfdata_t cf, void *aux)
    119 {
    120 	struct pcmcia_attach_args *pa = aux;
    121 
    122 	if (pcmcia_product_lookup(pa, pcmcom_products, pcmcom_nproducts,
    123 	    sizeof(pcmcom_products[0]), NULL))
    124 		return (2);	/* beat com_pcmcia */
    125 	return (0);
    126 }
    127 
    128 int
    129 pcmcom_validate_config(struct pcmcia_config_entry *cfe)
    130 {
    131 	if (cfe->iftype != PCMCIA_IFTYPE_IO ||
    132 	    cfe->num_iospace < 1 || cfe->num_iospace > NSLAVES)
    133 		return (EINVAL);
    134 	return (0);
    135 }
    136 
    137 void
    138 pcmcom_attach(device_t parent, device_t self, void *aux)
    139 {
    140 	struct pcmcom_softc *sc = device_private(self);
    141 	struct pcmcia_attach_args *pa = aux;
    142 	struct pcmcia_config_entry *cfe;
    143 	int slave;
    144 	int error;
    145 	int locs[PCMCOMCF_NLOCS];
    146 
    147 	sc->sc_dev = self;
    148 
    149 	sc->sc_pf = pa->pf;
    150 
    151 	error = pcmcia_function_configure(pa->pf, pcmcom_validate_config);
    152 	if (error) {
    153 		aprint_error_dev(self, "configure failed, error=%d\n", error);
    154 		return;
    155 	}
    156 
    157 	cfe = pa->pf->cfe;
    158 	sc->sc_nslaves = cfe->num_iospace;
    159 
    160 	error = pcmcom_enable(sc);
    161 	if (error)
    162 		goto fail;
    163 
    164 	/* Attach the children. */
    165 	for (slave = 0; slave < sc->sc_nslaves; slave++) {
    166 		struct pcmcom_attach_args pca;
    167 
    168 		printf("%s: slave %d\n", device_xname(self), slave);
    169 
    170 		pca.pca_iot = cfe->iospace[slave].handle.iot;
    171 		pca.pca_ioh = cfe->iospace[slave].handle.ioh;
    172 		pca.pca_slave = slave;
    173 
    174 		locs[PCMCOMCF_SLAVE] = slave;
    175 
    176 		sc->sc_slaves[slave] =
    177 		    config_found(sc->sc_dev, &pca, pcmcom_print,
    178 				 CFARG_SUBMATCH, config_stdsubmatch,
    179 				 CFARG_LOCATORS, locs,
    180 				 CFARG_EOL);
    181 	}
    182 
    183 	pcmcom_disable(sc);
    184 	sc->sc_state = PCMCOM_ATTACHED;
    185 	return;
    186 
    187 fail:
    188 	pcmcia_function_unconfigure(pa->pf);
    189 }
    190 
    191 void
    192 pcmcom_childdet(device_t self, device_t child)
    193 {
    194 	struct pcmcom_softc *sc = device_private(self);
    195 	int slave;
    196 
    197 	for (slave = sc->sc_nslaves - 1; slave >= 0; slave--) {
    198 		if (sc->sc_slaves[slave] == child)
    199 			sc->sc_slaves[slave] = NULL;
    200 	}
    201 }
    202 
    203 int
    204 pcmcom_detach(device_t self, int flags)
    205 {
    206 	struct pcmcom_softc *sc = device_private(self);
    207 	int slave, error;
    208 
    209 	if (sc->sc_state != PCMCOM_ATTACHED)
    210 		return (0);
    211 
    212 	for (slave = sc->sc_nslaves - 1; slave >= 0; slave--) {
    213 		if (sc->sc_slaves[slave]) {
    214 			/* Detach the child. */
    215 			error = config_detach(sc->sc_slaves[slave], flags);
    216 			if (error)
    217 				return (error);
    218 		}
    219 	}
    220 
    221 	pcmcia_function_unconfigure(sc->sc_pf);
    222 
    223 	return (0);
    224 }
    225 
    226 int
    227 pcmcom_print(void *aux, const char *pnp)
    228 {
    229 	struct pcmcom_attach_args *pca = aux;
    230 
    231 	/* only com's can attach to pcmcom's; easy... */
    232 	if (pnp)
    233 		aprint_normal("com at %s", pnp);
    234 
    235 	aprint_normal(" slave %d", pca->pca_slave);
    236 
    237 	return (UNCONF);
    238 }
    239 
    240 int
    241 pcmcom_intr(void *arg)
    242 {
    243 #if NCOM > 0
    244 	struct pcmcom_softc *sc = arg;
    245 	int i, rval = 0;
    246 
    247 	if (sc->sc_enabled_count == 0)
    248 		return (0);
    249 
    250 	for (i = 0; i < sc->sc_nslaves; i++) {
    251 		if (sc->sc_slaves[i])
    252 			rval |= comintr(sc->sc_slaves[i]);
    253 	}
    254 
    255 	return (rval);
    256 #else
    257 	return (0);
    258 #endif /* NCOM > 0 */
    259 }
    260 
    261 int
    262 pcmcom_enable(struct pcmcom_softc *sc)
    263 {
    264 	int error;
    265 
    266 	if (sc->sc_enabled_count++ != 0)
    267 		return (0);
    268 
    269 	/* Establish the interrupt. */
    270 	sc->sc_ih = pcmcia_intr_establish(sc->sc_pf, IPL_SERIAL,
    271 	    pcmcom_intr, sc);
    272 	if (!sc->sc_ih)
    273 		return (EIO);
    274 
    275 	error = pcmcia_function_enable(sc->sc_pf);
    276 	if (error) {
    277 		pcmcia_intr_disestablish(sc->sc_pf, sc->sc_ih);
    278 		sc->sc_ih = 0;
    279 	}
    280 
    281 	return (error);
    282 }
    283 
    284 void
    285 pcmcom_disable(struct pcmcom_softc *sc)
    286 {
    287 
    288 	if (--sc->sc_enabled_count != 0)
    289 		return;
    290 
    291 	pcmcia_function_disable(sc->sc_pf);
    292 	pcmcia_intr_disestablish(sc->sc_pf, sc->sc_ih);
    293 	sc->sc_ih = 0;
    294 }
    295 
    296 /****** Here begins the com attachment code. ******/
    297 
    298 #if NCOM_PCMCOM > 0
    299 int	com_pcmcom_match(device_t, cfdata_t , void *);
    300 void	com_pcmcom_attach(device_t, device_t, void *);
    301 
    302 /* No pcmcom-specific goo in the softc; it's all in the parent. */
    303 CFATTACH_DECL_NEW(com_pcmcom, sizeof(struct com_softc),
    304     com_pcmcom_match, com_pcmcom_attach, com_detach, NULL);
    305 
    306 int	com_pcmcom_enable(struct com_softc *);
    307 void	com_pcmcom_disable(struct com_softc *);
    308 
    309 int
    310 com_pcmcom_match(device_t parent, cfdata_t cf, void *aux)
    311 {
    312 
    313 	/* Device is always present. */
    314 	return (1);
    315 }
    316 
    317 void
    318 com_pcmcom_attach(device_t parent, device_t self, void *aux)
    319 {
    320 	struct com_softc *sc = device_private(self);
    321 	struct pcmcom_attach_args *pca = aux;
    322 
    323 	sc->sc_dev = self;
    324 	com_init_regs(&sc->sc_regs, pca->pca_iot, pca->pca_ioh, -1);
    325 	sc->enabled = 1;
    326 
    327 	sc->sc_frequency = COM_FREQ;
    328 
    329 	sc->enable = com_pcmcom_enable;
    330 	sc->disable = com_pcmcom_disable;
    331 
    332 	com_attach_subr(sc);
    333 
    334 	sc->enabled = 0;
    335 }
    336 
    337 int
    338 com_pcmcom_enable(struct com_softc *sc)
    339 {
    340 	return pcmcom_enable(device_private(device_parent(sc->sc_dev)));
    341 }
    342 
    343 void
    344 com_pcmcom_disable(struct com_softc *sc)
    345 {
    346 
    347 	pcmcom_disable(device_private(device_parent(sc->sc_dev)));
    348 }
    349 #endif /* NCOM_PCMCOM > 0 */
    350