xref: /netbsd-src/sys/dev/pcmcia/com_pcmcia.c (revision 9fbd88883c38d0c0fbfcbe66d76fe6b0fab3f9de)
1 /*	$NetBSD: com_pcmcia.c,v 1.25 2001/12/24 12:07:27 christos Exp $	 */
2 
3 /*-
4  * Copyright (c) 1998 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Charles M. Hannum.
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  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *        This product includes software developed by the NetBSD
21  *        Foundation, Inc. and its contributors.
22  * 4. Neither the name of The NetBSD Foundation nor the names of its
23  *    contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  */
38 
39 /*-
40  * Copyright (c) 1991 The Regents of the University of California.
41  * All rights reserved.
42  *
43  * Redistribution and use in source and binary forms, with or without
44  * modification, are permitted provided that the following conditions
45  * are met:
46  * 1. Redistributions of source code must retain the above copyright
47  *    notice, this list of conditions and the following disclaimer.
48  * 2. Redistributions in binary form must reproduce the above copyright
49  *    notice, this list of conditions and the following disclaimer in the
50  *    documentation and/or other materials provided with the distribution.
51  * 3. All advertising materials mentioning features or use of this software
52  *    must display the following acknowledgement:
53  *	This product includes software developed by the University of
54  *	California, Berkeley and its contributors.
55  * 4. Neither the name of the University nor the names of its contributors
56  *    may be used to endorse or promote products derived from this software
57  *    without specific prior written permission.
58  *
59  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
60  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
61  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
62  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
63  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
64  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
65  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
66  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
67  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
68  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
69  * SUCH DAMAGE.
70  *
71  *	@(#)com.c	7.5 (Berkeley) 5/16/91
72  */
73 
74 #include <sys/cdefs.h>
75 __KERNEL_RCSID(0, "$NetBSD: com_pcmcia.c,v 1.25 2001/12/24 12:07:27 christos Exp $");
76 
77 #include <sys/param.h>
78 #include <sys/systm.h>
79 #include <sys/ioctl.h>
80 #include <sys/select.h>
81 #include <sys/tty.h>
82 #include <sys/proc.h>
83 #include <sys/user.h>
84 #include <sys/conf.h>
85 #include <sys/file.h>
86 #include <sys/uio.h>
87 #include <sys/kernel.h>
88 #include <sys/syslog.h>
89 #include <sys/device.h>
90 
91 #include <machine/intr.h>
92 #include <machine/bus.h>
93 
94 #include <dev/pcmcia/pcmciavar.h>
95 #include <dev/pcmcia/pcmciareg.h>
96 #include <dev/pcmcia/pcmciadevs.h>
97 
98 #include <dev/ic/comreg.h>
99 #include <dev/ic/comvar.h>
100 
101 #include <dev/isa/isareg.h>
102 
103 struct com_dev {
104 	char	*name;
105 	char	*cis1_info[4];
106 };
107 
108 /* Devices that we need to match by CIS strings */
109 static struct com_dev com_devs[] = {
110 	{ PCMCIA_STR_MEGAHERTZ_XJ2288, PCMCIA_CIS_MEGAHERTZ_XJ2288 },
111 };
112 
113 
114 static int com_devs_size = sizeof(com_devs) / sizeof(com_devs[0]);
115 static struct com_dev *com_dev_match __P((struct pcmcia_card *));
116 
117 int com_pcmcia_match __P((struct device *, struct cfdata *, void *));
118 void com_pcmcia_attach __P((struct device *, struct device *, void *));
119 int com_pcmcia_detach __P((struct device *, int));
120 void com_pcmcia_cleanup __P((void *));
121 
122 int com_pcmcia_enable __P((struct com_softc *));
123 void com_pcmcia_disable __P((struct com_softc *));
124 int com_pcmcia_enable1 __P((struct com_softc *));
125 void com_pcmcia_disable1 __P((struct com_softc *));
126 
127 struct com_pcmcia_softc {
128 	struct com_softc sc_com;		/* real "com" softc */
129 
130 	/* PCMCIA-specific goo */
131 	struct pcmcia_io_handle sc_pcioh;	/* PCMCIA i/o space info */
132 	int sc_io_window;			/* our i/o window */
133 	struct pcmcia_function *sc_pf;		/* our PCMCIA function */
134 	void *sc_ih;				/* interrupt handler */
135 };
136 
137 struct cfattach com_pcmcia_ca = {
138 	sizeof(struct com_pcmcia_softc), com_pcmcia_match, com_pcmcia_attach,
139 	com_pcmcia_detach, com_activate
140 };
141 
142 /* Look for pcmcia cards with particular CIS strings */
143 static struct com_dev *
144 com_dev_match(card)
145 	struct pcmcia_card *card;
146 {
147 	int i, j;
148 
149 	for (i = 0; i < com_devs_size; i++) {
150 		for (j = 0; j < 4; j++)
151 			if (com_devs[i].cis1_info[j] &&
152 			    strcmp(com_devs[i].cis1_info[j],
153 			    card->cis1_info[j]) != 0)
154 				break;
155 		if (j == 4)
156 			return &com_devs[i];
157 	}
158 
159 	return NULL;
160 }
161 
162 
163 int
164 com_pcmcia_match(parent, match, aux)
165 	struct device *parent;
166 	struct cfdata *match;
167 	void *aux;
168 {
169 	int comportmask;
170 	struct pcmcia_attach_args *pa = aux;
171 	struct pcmcia_config_entry *cfe;
172 
173 	/* 1. Does it claim to be a serial device? */
174 	if (pa->pf->function == PCMCIA_FUNCTION_SERIAL)
175 		return 1;
176 
177 	/* 2. Does it have all four 'standard' port ranges? */
178 	comportmask = 0;
179 	for (cfe = pa->pf->cfe_head.sqh_first; cfe;
180 	    cfe = cfe->cfe_list.sqe_next) {
181 		switch (cfe->iospace[0].start) {
182 		case IO_COM1:
183 			comportmask |= 1;
184 			break;
185 		case IO_COM2:
186 			comportmask |= 2;
187 			break;
188 		case IO_COM3:
189 			comportmask |= 4;
190 			break;
191 		case IO_COM4:
192 			comportmask |= 8;
193 			break;
194 		}
195 	}
196 
197 	if (comportmask == 15)
198 		return 1;
199 
200 	/* 3. Is this a card we know about? */
201 	if (com_dev_match(pa->card) != NULL)
202 		return 1;
203 
204 	return 0;
205 }
206 
207 void
208 com_pcmcia_attach(parent, self, aux)
209 	struct device  *parent, *self;
210 	void *aux;
211 {
212 	struct com_pcmcia_softc *psc = (void *) self;
213 	struct com_softc *sc = &psc->sc_com;
214 	struct pcmcia_attach_args *pa = aux;
215 	struct pcmcia_config_entry *cfe;
216 	int             autoalloc = 0;
217 
218 	psc->sc_pf = pa->pf;
219 
220 retry:
221 	/* find a cfe we can use */
222 
223 	for (cfe = pa->pf->cfe_head.sqh_first; cfe;
224 	    cfe = cfe->cfe_list.sqe_next) {
225 #if 0
226 		/*
227 		 * Some modem cards (e.g. Xircom CM33) also have
228 		 * mem space.  Don't bother with this check.
229 		 */
230 		if (cfe->num_memspace != 0)
231 			continue;
232 #endif
233 
234 		if (cfe->num_iospace != 1)
235 			continue;
236 
237 		if (autoalloc == 0) {
238 			/*
239 			 * cfe->iomask == 3 is our test for the "generic"
240 			 * config table entry, which we want to avoid on the
241 			 * first pass and use exclusively on the second pass.
242 			 */
243 			if ((cfe->iomask != 3) &&
244 			    (cfe->iospace[0].start != 0)) {
245 				if (!pcmcia_io_alloc(pa->pf,
246 				    cfe->iospace[0].start,
247 				    cfe->iospace[0].length, 0,
248 				    &psc->sc_pcioh)) {
249 					goto found;
250 				}
251 			}
252 		} else {
253 			if (cfe->iomask == 3) {
254 				if (!pcmcia_io_alloc(pa->pf, 0,
255 				    cfe->iospace[0].length,
256 				    cfe->iospace[0].length, &psc->sc_pcioh)) {
257 					goto found;
258 				}
259 			}
260 		}
261 	}
262 	if (autoalloc == 0) {
263 		autoalloc = 1;
264 		goto retry;
265 	} else if (!cfe) {
266 		printf(": can't allocate i/o space\n");
267 		return;
268 	}
269 found:
270 	sc->sc_iot = psc->sc_pcioh.iot;
271 	sc->sc_ioh = psc->sc_pcioh.ioh;
272 
273 	/* Enable the card. */
274 	pcmcia_function_init(pa->pf, cfe);
275 	if (com_pcmcia_enable1(sc))
276 		printf(": function enable failed\n");
277 
278 	sc->enabled = 1;
279 
280 	/* map in the io space */
281 
282 	if (pcmcia_io_map(pa->pf, ((cfe->flags & PCMCIA_CFE_IO16) ?
283 	    PCMCIA_WIDTH_IO16 : PCMCIA_WIDTH_IO8), 0, psc->sc_pcioh.size,
284 	    &psc->sc_pcioh, &psc->sc_io_window)) {
285 		printf(": can't map i/o space\n");
286 		return;
287 	}
288 	sc->sc_iobase = -1;
289 	sc->sc_frequency = COM_FREQ;
290 
291 	sc->enable = com_pcmcia_enable;
292 	sc->disable = com_pcmcia_disable;
293 
294 	printf(": serial device\n%s", sc->sc_dev.dv_xname);
295 
296 	com_attach_subr(sc);
297 
298 	sc->enabled = 0;
299 
300 	com_pcmcia_disable1(sc);
301 }
302 
303 int
304 com_pcmcia_detach(self, flags)
305 	struct device  *self;
306 	int flags;
307 {
308 	struct com_pcmcia_softc *psc = (struct com_pcmcia_softc *) self;
309 	int error;
310 
311 	if ((error = com_detach(self, flags)) != 0)
312 		return error;
313 
314 	/* Unmap our i/o window. */
315 	pcmcia_io_unmap(psc->sc_pf, psc->sc_io_window);
316 
317 	/* Free our i/o space. */
318 	pcmcia_io_free(psc->sc_pf, &psc->sc_pcioh);
319 
320 	return 0;
321 }
322 
323 int
324 com_pcmcia_enable(sc)
325 	struct com_softc *sc;
326 {
327 	struct com_pcmcia_softc *psc = (struct com_pcmcia_softc *) sc;
328 	struct pcmcia_function *pf = psc->sc_pf;
329 	int error;
330 
331 	if ((error = com_pcmcia_enable1(sc)) != 0)
332 		return error;
333 
334 	/* establish the interrupt. */
335 	psc->sc_ih = pcmcia_intr_establish(pf, IPL_SERIAL, comintr, sc);
336 	if (psc->sc_ih == NULL) {
337 		printf("%s: couldn't establish interrupt\n",
338 		    sc->sc_dev.dv_xname);
339 		com_pcmcia_disable1(sc);
340 		return 1;
341 	}
342 	return 0;
343 }
344 
345 int
346 com_pcmcia_enable1(sc)
347 	struct com_softc *sc;
348 {
349 	struct com_pcmcia_softc *psc = (struct com_pcmcia_softc *) sc;
350 	struct pcmcia_function *pf = psc->sc_pf;
351 	int ret;
352 
353 	if ((ret = pcmcia_function_enable(pf)) != 0)
354 		return ret;
355 
356 	if ((psc->sc_pf->sc->card.product == PCMCIA_PRODUCT_3COM_3C562) ||
357 	    (psc->sc_pf->sc->card.product == PCMCIA_PRODUCT_3COM_3CXEM556) ||
358 	    (psc->sc_pf->sc->card.product == PCMCIA_PRODUCT_3COM_3CXEM556INT)) {
359 		int reg;
360 
361 		/* turn off the ethernet-disable bit */
362 
363 		reg = pcmcia_ccr_read(pf, PCMCIA_CCR_OPTION);
364 		if (reg & 0x08) {
365 			reg &= ~0x08;
366 			pcmcia_ccr_write(pf, PCMCIA_CCR_OPTION, reg);
367 		}
368 	}
369 	return ret;
370 }
371 
372 void
373 com_pcmcia_disable(sc)
374 	struct com_softc *sc;
375 {
376 	struct com_pcmcia_softc *psc = (struct com_pcmcia_softc *) sc;
377 
378 	pcmcia_intr_disestablish(psc->sc_pf, psc->sc_ih);
379 	com_pcmcia_disable1(sc);
380 }
381 
382 void
383 com_pcmcia_disable1(sc)
384 	struct com_softc *sc;
385 {
386 	struct com_pcmcia_softc *psc = (struct com_pcmcia_softc *) sc;
387 
388 	pcmcia_function_disable(psc->sc_pf);
389 }
390