xref: /netbsd-src/sys/dev/pcmcia/com_pcmcia.c (revision 8b0f9554ff8762542c4defc4f70e1eb76fb508fa)
1 /*	$NetBSD: com_pcmcia.c,v 1.56 2007/10/19 12:01:03 ad 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.56 2007/10/19 12:01:03 ad 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 <sys/intr.h>
88 #include <sys/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 
104 int com_pcmcia_enable(struct com_softc *);
105 void com_pcmcia_disable(struct com_softc *);
106 
107 struct com_pcmcia_softc {
108 	struct com_softc sc_com;		/* real "com" softc */
109 
110 	/* PCMCIA-specific goo */
111 	struct pcmcia_function *sc_pf;		/* our PCMCIA function */
112 	void *sc_ih;				/* interrupt handler */
113 	int sc_attached;
114 };
115 
116 CFATTACH_DECL(com_pcmcia, sizeof(struct com_pcmcia_softc),
117     com_pcmcia_match, com_pcmcia_attach, com_pcmcia_detach, com_activate);
118 
119 static const struct pcmcia_product com_pcmcia_products[] = {
120 	{ PCMCIA_VENDOR_INVALID, PCMCIA_PRODUCT_INVALID,
121 	  PCMCIA_CIS_MEGAHERTZ_XJ2288 },
122 	{ PCMCIA_VENDOR_TDK, PCMCIA_PRODUCT_TDK_BLUETOOTH_PCCARD,
123 	  PCMCIA_CIS_INVALID },
124 };
125 static const size_t com_pcmcia_nproducts =
126     sizeof(com_pcmcia_products) / sizeof(com_pcmcia_products[0]);
127 
128 int
129 com_pcmcia_match(struct device *parent, struct cfdata *match,
130     void *aux)
131 {
132 	int comportmask;
133 	struct pcmcia_attach_args *pa = aux;
134 	struct pcmcia_config_entry *cfe;
135 
136 	/* 1. Does it claim to be a serial device? */
137 	if (pa->pf->function == PCMCIA_FUNCTION_SERIAL)
138 		return 1;
139 
140 	/* 2. Does it have all four 'standard' port ranges? */
141 	comportmask = 0;
142 	SIMPLEQ_FOREACH(cfe, &pa->pf->cfe_head, cfe_list) {
143 		switch (cfe->iospace[0].start) {
144 		case IO_COM1:
145 			comportmask |= 1;
146 			break;
147 		case IO_COM2:
148 			comportmask |= 2;
149 			break;
150 		case IO_COM3:
151 			comportmask |= 4;
152 			break;
153 		case IO_COM4:
154 			comportmask |= 8;
155 			break;
156 		}
157 	}
158 
159 	if (comportmask == 15)
160 		return 1;
161 
162 	/* 3. Is this a card we know about? */
163 	if (pcmcia_product_lookup(pa, com_pcmcia_products, com_pcmcia_nproducts,
164 	    sizeof(com_pcmcia_products[0]), NULL))
165 		return 1;
166 
167 	return 0;
168 }
169 
170 int
171 com_pcmcia_validate_config(cfe)
172 	struct pcmcia_config_entry *cfe;
173 {
174 	if (cfe->iftype != PCMCIA_IFTYPE_IO ||
175 	    cfe->num_iospace != 1)
176 		return (EINVAL);
177 	/* Some cards have a memory space, but we don't use it. */
178 	cfe->num_memspace = 0;
179 	return (0);
180 }
181 
182 void
183 com_pcmcia_attach(struct device *parent, struct device *self,
184     void *aux)
185 {
186 	struct com_pcmcia_softc *psc = (void *) self;
187 	struct com_softc *sc = &psc->sc_com;
188 	struct pcmcia_attach_args *pa = aux;
189 	struct pcmcia_config_entry *cfe;
190 	int error;
191 
192 	psc->sc_pf = pa->pf;
193 
194 	error = pcmcia_function_configure(pa->pf, com_pcmcia_validate_config);
195 	if (error) {
196 		aprint_error("%s: configure failed, error=%d\n", self->dv_xname,
197 		    error);
198 		return;
199 	}
200 
201 	cfe = pa->pf->cfe;
202 	COM_INIT_REGS(sc->sc_regs, cfe->iospace[0].handle.iot,
203 	    cfe->iospace[0].handle.ioh, -1);
204 
205 	error = com_pcmcia_enable(sc);
206 	if (error)
207 		goto fail;
208 
209 	sc->enabled = 1;
210 
211 	sc->sc_frequency = COM_FREQ;
212 
213 	sc->enable = com_pcmcia_enable;
214 	sc->disable = com_pcmcia_disable;
215 
216 	aprint_normal("%s", self->dv_xname);
217 
218 	com_attach_subr(sc);
219 
220 	sc->enabled = 0;
221 
222 	psc->sc_attached = 1;
223 	com_pcmcia_disable(sc);
224 	return;
225 
226 fail:
227 	pcmcia_function_unconfigure(pa->pf);
228 }
229 
230 int
231 com_pcmcia_detach(self, flags)
232 	struct device  *self;
233 	int flags;
234 {
235 	struct com_pcmcia_softc *psc = (struct com_pcmcia_softc *) self;
236 	int error;
237 
238 	if (!psc->sc_attached)
239 		return (0);
240 
241 	if ((error = com_detach(self, flags)) != 0)
242 		return error;
243 
244 	pcmcia_function_unconfigure(psc->sc_pf);
245 	return (0);
246 }
247 
248 int
249 com_pcmcia_enable(sc)
250 	struct com_softc *sc;
251 {
252 	struct com_pcmcia_softc *psc = (struct com_pcmcia_softc *) sc;
253 	struct pcmcia_function *pf = psc->sc_pf;
254 	int error;
255 
256 	/* establish the interrupt. */
257 	psc->sc_ih = pcmcia_intr_establish(pf, IPL_SERIAL, comintr, sc);
258 	if (psc->sc_ih == NULL) {
259 		printf("%s: couldn't establish interrupt\n",
260 		    sc->sc_dev.dv_xname);
261 		return (1);
262 	}
263 
264 	if ((error = pcmcia_function_enable(pf)) != 0) {
265 		pcmcia_intr_disestablish(pf, psc->sc_ih);
266 		psc->sc_ih = 0;
267 		return (error);
268 	}
269 
270 	if ((psc->sc_pf->sc->card.product == PCMCIA_PRODUCT_3COM_3C562) ||
271 	    (psc->sc_pf->sc->card.product == PCMCIA_PRODUCT_3COM_3CXEM556) ||
272 	    (psc->sc_pf->sc->card.product == PCMCIA_PRODUCT_3COM_3CXEM556INT)) {
273 		int reg;
274 
275 		/* turn off the ethernet-disable bit */
276 		reg = pcmcia_ccr_read(pf, PCMCIA_CCR_OPTION);
277 		if (reg & 0x08) {
278 			reg &= ~0x08;
279 			pcmcia_ccr_write(pf, PCMCIA_CCR_OPTION, reg);
280 		}
281 	}
282 
283 	return (0);
284 }
285 
286 void
287 com_pcmcia_disable(sc)
288 	struct com_softc *sc;
289 {
290 	struct com_pcmcia_softc *psc = (struct com_pcmcia_softc *) sc;
291 
292 	pcmcia_function_disable(psc->sc_pf);
293 	pcmcia_intr_disestablish(psc->sc_pf, psc->sc_ih);
294 	psc->sc_ih = 0;
295 }
296