xref: /netbsd-src/sys/dev/pcmcia/pcmcom.c (revision 274254cdae52594c1aa480a736aef78313d15c9c)
1 /*	$NetBSD: pcmcom.c,v 1.35 2009/03/14 15:36:20 dsl 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.35 2009/03/14 15:36:20 dsl 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 	struct device 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 	struct device *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(struct device *, struct cfdata *, void *);
92 int	pcmcom_validate_config(struct pcmcia_config_entry *);
93 void	pcmcom_attach(struct device *, struct device *, void *);
94 int	pcmcom_detach(struct device *, int);
95 int	pcmcom_activate(struct device *, enum devact);
96 
97 CFATTACH_DECL(pcmcom, sizeof(struct pcmcom_softc),
98     pcmcom_match, pcmcom_attach, pcmcom_detach, pcmcom_activate);
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 =
109     sizeof(pcmcom_products) / sizeof(pcmcom_products[0]);
110 
111 int	pcmcom_print(void *, const char *);
112 
113 int	pcmcom_enable(struct pcmcom_softc *);
114 void	pcmcom_disable(struct pcmcom_softc *);
115 
116 int	pcmcom_intr(void *);
117 
118 int
119 pcmcom_match(struct device *parent, struct cfdata *cf,
120     void *aux)
121 {
122 	struct pcmcia_attach_args *pa = aux;
123 
124 	if (pcmcia_product_lookup(pa, pcmcom_products, pcmcom_nproducts,
125 	    sizeof(pcmcom_products[0]), NULL))
126 		return (2);	/* beat com_pcmcia */
127 	return (0);
128 }
129 
130 int
131 pcmcom_validate_config(struct pcmcia_config_entry *cfe)
132 {
133 	if (cfe->iftype != PCMCIA_IFTYPE_IO ||
134 	    cfe->num_iospace < 1 || cfe->num_iospace > NSLAVES)
135 		return (EINVAL);
136 	return (0);
137 }
138 
139 void
140 pcmcom_attach(struct device *parent, struct device *self, void *aux)
141 {
142 	struct pcmcom_softc *sc = (void *)self;
143 	struct pcmcia_attach_args *pa = aux;
144 	struct pcmcia_config_entry *cfe;
145 	int slave;
146 	int error;
147 	int locs[PCMCOMCF_NLOCS];
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",
154 		    error);
155 		return;
156 	}
157 
158 	cfe = pa->pf->cfe;
159 	sc->sc_nslaves = cfe->num_iospace;
160 
161 	error = pcmcom_enable(sc);
162 	if (error)
163 		goto fail;
164 
165 	/* Attach the children. */
166 	for (slave = 0; slave < sc->sc_nslaves; slave++) {
167 		struct pcmcom_attach_args pca;
168 
169 		printf("%s: slave %d\n", device_xname(self), slave);
170 
171 		pca.pca_iot = cfe->iospace[slave].handle.iot;
172 		pca.pca_ioh = cfe->iospace[slave].handle.ioh;
173 		pca.pca_slave = slave;
174 
175 		locs[PCMCOMCF_SLAVE] = slave;
176 
177 		sc->sc_slaves[slave] = config_found_sm_loc(&sc->sc_dev,
178 			"pcmcom", locs,
179 			&pca, pcmcom_print, config_stdsubmatch);
180 	}
181 
182 	pcmcom_disable(sc);
183 	sc->sc_state = PCMCOM_ATTACHED;
184 	return;
185 
186 fail:
187 	pcmcia_function_unconfigure(pa->pf);
188 }
189 
190 int
191 pcmcom_detach(struct device *self, int flags)
192 {
193 	struct pcmcom_softc *sc = (void *)self;
194 	int slave, error;
195 
196 	if (sc->sc_state != PCMCOM_ATTACHED)
197 		return (0);
198 
199 	for (slave = sc->sc_nslaves - 1; slave >= 0; slave--) {
200 		if (sc->sc_slaves[slave]) {
201 			/* Detach the child. */
202 			error = config_detach(sc->sc_slaves[slave], flags);
203 			if (error)
204 				return (error);
205 			sc->sc_slaves[slave] = 0;
206 		}
207 	}
208 
209 	pcmcia_function_unconfigure(sc->sc_pf);
210 
211 	return (0);
212 }
213 
214 int
215 pcmcom_activate(struct device *self, enum devact act)
216 {
217 	struct pcmcom_softc *sc = (void *)self;
218 	int slave, error = 0, s;
219 
220 	s = splserial();
221 	switch (act) {
222 	case DVACT_ACTIVATE:
223 		error = EOPNOTSUPP;
224 		break;
225 
226 	case DVACT_DEACTIVATE:
227 		for (slave = sc->sc_nslaves - 1; slave >= 0; slave--) {
228 			if (sc->sc_slaves[slave]) {
229 				/*
230 				 * Deactivate the child.  Doing so will cause
231 				 * our own enabled count to drop to 0, once all
232 				 * children are deactivated.
233 				 */
234 				error = config_deactivate(sc->sc_slaves[slave]);
235 				if (error)
236 					break;
237 			}
238 		}
239 		break;
240 	}
241 	splx(s);
242 	return (error);
243 }
244 
245 int
246 pcmcom_print(void *aux, const char *pnp)
247 {
248 	struct pcmcom_attach_args *pca = aux;
249 
250 	/* only com's can attach to pcmcom's; easy... */
251 	if (pnp)
252 		aprint_normal("com at %s", pnp);
253 
254 	aprint_normal(" slave %d", pca->pca_slave);
255 
256 	return (UNCONF);
257 }
258 
259 int
260 pcmcom_intr(void *arg)
261 {
262 #if NCOM > 0
263 	struct pcmcom_softc *sc = arg;
264 	int i, rval = 0;
265 
266 	if (sc->sc_enabled_count == 0)
267 		return (0);
268 
269 	for (i = 0; i < sc->sc_nslaves; i++) {
270 		if (sc->sc_slaves[i])
271 			rval |= comintr(sc->sc_slaves[i]);
272 	}
273 
274 	return (rval);
275 #else
276 	return (0);
277 #endif /* NCOM > 0 */
278 }
279 
280 int
281 pcmcom_enable(struct pcmcom_softc *sc)
282 {
283 	int error;
284 
285 	if (sc->sc_enabled_count++ != 0)
286 		return (0);
287 
288 	/* Establish the interrupt. */
289 	sc->sc_ih = pcmcia_intr_establish(sc->sc_pf, IPL_SERIAL,
290 	    pcmcom_intr, sc);
291 	if (!sc->sc_ih)
292 		return (EIO);
293 
294 	error = pcmcia_function_enable(sc->sc_pf);
295 	if (error) {
296 		pcmcia_intr_disestablish(sc->sc_pf, sc->sc_ih);
297 		sc->sc_ih = 0;
298 	}
299 
300 	return (error);
301 }
302 
303 void
304 pcmcom_disable(struct pcmcom_softc *sc)
305 {
306 
307 	if (--sc->sc_enabled_count != 0)
308 		return;
309 
310 	pcmcia_function_disable(sc->sc_pf);
311 	pcmcia_intr_disestablish(sc->sc_pf, sc->sc_ih);
312 	sc->sc_ih = 0;
313 }
314 
315 /****** Here begins the com attachment code. ******/
316 
317 #if NCOM_PCMCOM > 0
318 int	com_pcmcom_match(device_t, cfdata_t , void *);
319 void	com_pcmcom_attach(device_t, device_t, void *);
320 
321 /* No pcmcom-specific goo in the softc; it's all in the parent. */
322 CFATTACH_DECL(com_pcmcom, sizeof(struct com_softc),
323     com_pcmcom_match, com_pcmcom_attach, com_detach, com_activate);
324 
325 int	com_pcmcom_enable(struct com_softc *);
326 void	com_pcmcom_disable(struct com_softc *);
327 
328 int
329 com_pcmcom_match(device_t parent, cfdata_t cf, void *aux)
330 {
331 
332 	/* Device is always present. */
333 	return (1);
334 }
335 
336 void
337 com_pcmcom_attach(device_t parent, device_t self, void *aux)
338 {
339 	struct com_softc *sc = device_private(self);
340 	struct pcmcom_attach_args *pca = aux;
341 
342 	sc->sc_dev = self;
343 	COM_INIT_REGS(sc->sc_regs, pca->pca_iot, pca->pca_ioh, -1);
344 	sc->enabled = 1;
345 
346 	sc->sc_frequency = COM_FREQ;
347 
348 	sc->enable = com_pcmcom_enable;
349 	sc->disable = com_pcmcom_disable;
350 
351 	com_attach_subr(sc);
352 
353 	sc->enabled = 0;
354 }
355 
356 int
357 com_pcmcom_enable(struct com_softc *sc)
358 {
359 
360 	return (pcmcom_enable(device_private(device_parent(sc->sc_dev))));
361 }
362 
363 void
364 com_pcmcom_disable(struct com_softc *sc)
365 {
366 
367 	pcmcom_disable(device_private(device_parent(sc->sc_dev)));
368 }
369 #endif /* NCOM_PCMCOM > 0 */
370