xref: /netbsd-src/sys/dev/pcmcia/com_pcmcia.c (revision aaf4ece63a859a04e37cf3a7229b5fab0157cc06)
1 /*	$NetBSD: com_pcmcia.c,v 1.51 2005/12/11 12:23:22 christos Exp $	 */
2 
3 /*-
4  * Copyright (c) 1998, 2004 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. Neither the name of the University nor the names of its contributors
52  *    may be used to endorse or promote products derived from this software
53  *    without specific prior written permission.
54  *
55  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
56  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
57  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
58  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
59  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
60  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
61  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
62  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
63  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
64  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
65  * SUCH DAMAGE.
66  *
67  *	@(#)com.c	7.5 (Berkeley) 5/16/91
68  */
69 
70 #include <sys/cdefs.h>
71 __KERNEL_RCSID(0, "$NetBSD: com_pcmcia.c,v 1.51 2005/12/11 12:23:22 christos Exp $");
72 
73 #include <sys/param.h>
74 #include <sys/systm.h>
75 #include <sys/ioctl.h>
76 #include <sys/select.h>
77 #include <sys/tty.h>
78 #include <sys/proc.h>
79 #include <sys/user.h>
80 #include <sys/conf.h>
81 #include <sys/file.h>
82 #include <sys/uio.h>
83 #include <sys/kernel.h>
84 #include <sys/syslog.h>
85 #include <sys/device.h>
86 
87 #include <machine/intr.h>
88 #include <machine/bus.h>
89 
90 #include <dev/pcmcia/pcmciavar.h>
91 #include <dev/pcmcia/pcmciareg.h>
92 #include <dev/pcmcia/pcmciadevs.h>
93 
94 #include <dev/ic/comreg.h>
95 #include <dev/ic/comvar.h>
96 
97 #include <dev/isa/isareg.h>
98 
99 int com_pcmcia_match(struct device *, struct cfdata *, void *);
100 int com_pcmcia_validate_config(struct pcmcia_config_entry *);
101 void com_pcmcia_attach(struct device *, struct device *, void *);
102 int com_pcmcia_detach(struct device *, int);
103 void com_pcmcia_cleanup(void *);
104 
105 int com_pcmcia_enable(struct com_softc *);
106 void com_pcmcia_disable(struct com_softc *);
107 
108 struct com_pcmcia_softc {
109 	struct com_softc sc_com;		/* real "com" softc */
110 
111 	/* PCMCIA-specific goo */
112 	struct pcmcia_function *sc_pf;		/* our PCMCIA function */
113 	void *sc_ih;				/* interrupt handler */
114 	int sc_attached;
115 };
116 
117 CFATTACH_DECL(com_pcmcia, sizeof(struct com_pcmcia_softc),
118     com_pcmcia_match, com_pcmcia_attach, com_pcmcia_detach, com_activate);
119 
120 static const struct pcmcia_product com_pcmcia_products[] = {
121 	{ PCMCIA_VENDOR_INVALID, PCMCIA_PRODUCT_INVALID,
122 	  PCMCIA_CIS_MEGAHERTZ_XJ2288 },
123 };
124 static const size_t com_pcmcia_nproducts =
125     sizeof(com_pcmcia_products) / sizeof(com_pcmcia_products[0]);
126 
127 int
128 com_pcmcia_match(parent, match, aux)
129 	struct device *parent;
130 	struct cfdata *match;
131 	void *aux;
132 {
133 	int comportmask;
134 	struct pcmcia_attach_args *pa = aux;
135 	struct pcmcia_config_entry *cfe;
136 
137 	/* 1. Does it claim to be a serial device? */
138 	if (pa->pf->function == PCMCIA_FUNCTION_SERIAL)
139 		return 1;
140 
141 	/* 2. Does it have all four 'standard' port ranges? */
142 	comportmask = 0;
143 	SIMPLEQ_FOREACH(cfe, &pa->pf->cfe_head, cfe_list) {
144 		switch (cfe->iospace[0].start) {
145 		case IO_COM1:
146 			comportmask |= 1;
147 			break;
148 		case IO_COM2:
149 			comportmask |= 2;
150 			break;
151 		case IO_COM3:
152 			comportmask |= 4;
153 			break;
154 		case IO_COM4:
155 			comportmask |= 8;
156 			break;
157 		}
158 	}
159 
160 	if (comportmask == 15)
161 		return 1;
162 
163 	/* 3. Is this a card we know about? */
164 	if (pcmcia_product_lookup(pa, com_pcmcia_products, com_pcmcia_nproducts,
165 	    sizeof(com_pcmcia_products[0]), NULL))
166 		return 1;
167 
168 	return 0;
169 }
170 
171 int
172 com_pcmcia_validate_config(cfe)
173 	struct pcmcia_config_entry *cfe;
174 {
175 	if (cfe->iftype != PCMCIA_IFTYPE_IO ||
176 	    cfe->num_iospace != 1)
177 		return (EINVAL);
178 	/* Some cards have a memory space, but we don't use it. */
179 	cfe->num_memspace = 0;
180 	return (0);
181 }
182 
183 void
184 com_pcmcia_attach(parent, self, aux)
185 	struct device  *parent, *self;
186 	void *aux;
187 {
188 	struct com_pcmcia_softc *psc = (void *) self;
189 	struct com_softc *sc = &psc->sc_com;
190 	struct pcmcia_attach_args *pa = aux;
191 	struct pcmcia_config_entry *cfe;
192 	int error;
193 
194 	psc->sc_pf = pa->pf;
195 
196 	error = pcmcia_function_configure(pa->pf, com_pcmcia_validate_config);
197 	if (error) {
198 		aprint_error("%s: configure failed, error=%d\n", self->dv_xname,
199 		    error);
200 		return;
201 	}
202 
203 	cfe = pa->pf->cfe;
204 	sc->sc_iot = cfe->iospace[0].handle.iot;
205 	sc->sc_ioh = cfe->iospace[0].handle.ioh;
206 
207 	error = com_pcmcia_enable(sc);
208 	if (error)
209 		goto fail;
210 
211 	sc->enabled = 1;
212 
213 	sc->sc_iobase = -1;
214 	sc->sc_frequency = COM_FREQ;
215 
216 	sc->enable = com_pcmcia_enable;
217 	sc->disable = com_pcmcia_disable;
218 
219 	aprint_normal("%s", self->dv_xname);
220 
221 	com_attach_subr(sc);
222 
223 	sc->enabled = 0;
224 
225 	psc->sc_attached = 1;
226 	com_pcmcia_disable(sc);
227 	return;
228 
229 fail:
230 	pcmcia_function_unconfigure(pa->pf);
231 }
232 
233 int
234 com_pcmcia_detach(self, flags)
235 	struct device  *self;
236 	int flags;
237 {
238 	struct com_pcmcia_softc *psc = (struct com_pcmcia_softc *) self;
239 	int error;
240 
241 	if (!psc->sc_attached)
242 		return (0);
243 
244 	if ((error = com_detach(self, flags)) != 0)
245 		return error;
246 
247 	pcmcia_function_unconfigure(psc->sc_pf);
248 	return (0);
249 }
250 
251 int
252 com_pcmcia_enable(sc)
253 	struct com_softc *sc;
254 {
255 	struct com_pcmcia_softc *psc = (struct com_pcmcia_softc *) sc;
256 	struct pcmcia_function *pf = psc->sc_pf;
257 	int error;
258 
259 	/* establish the interrupt. */
260 	psc->sc_ih = pcmcia_intr_establish(pf, IPL_SERIAL, comintr, sc);
261 	if (psc->sc_ih == NULL) {
262 		printf("%s: couldn't establish interrupt\n",
263 		    sc->sc_dev.dv_xname);
264 		return (1);
265 	}
266 
267 	if ((error = pcmcia_function_enable(pf)) != 0) {
268 		pcmcia_intr_disestablish(pf, psc->sc_ih);
269 		psc->sc_ih = 0;
270 		return (error);
271 	}
272 
273 	if ((psc->sc_pf->sc->card.product == PCMCIA_PRODUCT_3COM_3C562) ||
274 	    (psc->sc_pf->sc->card.product == PCMCIA_PRODUCT_3COM_3CXEM556) ||
275 	    (psc->sc_pf->sc->card.product == PCMCIA_PRODUCT_3COM_3CXEM556INT)) {
276 		int reg;
277 
278 		/* turn off the ethernet-disable bit */
279 		reg = pcmcia_ccr_read(pf, PCMCIA_CCR_OPTION);
280 		if (reg & 0x08) {
281 			reg &= ~0x08;
282 			pcmcia_ccr_write(pf, PCMCIA_CCR_OPTION, reg);
283 		}
284 	}
285 
286 	return (0);
287 }
288 
289 void
290 com_pcmcia_disable(sc)
291 	struct com_softc *sc;
292 {
293 	struct com_pcmcia_softc *psc = (struct com_pcmcia_softc *) sc;
294 
295 	pcmcia_function_disable(psc->sc_pf);
296 	pcmcia_intr_disestablish(psc->sc_pf, psc->sc_ih);
297 	psc->sc_ih = 0;
298 }
299