xref: /netbsd/sys/dev/mca/com_mca.c (revision bf9ec67e)
1 /*	$NetBSD: com_mca.c,v 1.6 2001/11/15 09:48:11 lukem Exp $	*/
2 
3 /*-
4  * Copyright (c) 2001 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 /*
75  * This driver attaches serial port boards and internal modems.
76  */
77 
78 #include <sys/cdefs.h>
79 __KERNEL_RCSID(0, "$NetBSD: com_mca.c,v 1.6 2001/11/15 09:48:11 lukem Exp $");
80 
81 #include <sys/param.h>
82 #include <sys/systm.h>
83 #include <sys/ioctl.h>
84 #include <sys/select.h>
85 #include <sys/tty.h>
86 #include <sys/proc.h>
87 #include <sys/user.h>
88 #include <sys/file.h>
89 #include <sys/uio.h>
90 #include <sys/kernel.h>
91 #include <sys/syslog.h>
92 #include <sys/device.h>
93 
94 #include <machine/intr.h>
95 #include <machine/bus.h>
96 
97 #include <dev/ic/comreg.h>
98 #include <dev/ic/comvar.h>
99 
100 #include <dev/mca/mcavar.h>
101 #include <dev/mca/mcadevs.h>
102 
103 struct com_mca_softc {
104 	struct	com_softc sc_com;	/* real "com" softc */
105 
106 	/* MCA-specific goo. */
107 	void	*sc_ih;			/* interrupt handler */
108 };
109 
110 int com_mca_probe __P((struct device *, struct cfdata *, void *));
111 void com_mca_attach __P((struct device *, struct device *, void *));
112 void com_mca_cleanup __P((void *));
113 
114 static int ibm_modem_getcfg __P((struct mca_attach_args *, int *, int *));
115 static int neocom1_getcfg __P((struct mca_attach_args *, int *, int *));
116 static int ibm_mpcom_getcfg __P((struct mca_attach_args *, int *, int *));
117 
118 struct cfattach com_mca_ca = {
119 	sizeof(struct com_mca_softc), com_mca_probe, com_mca_attach
120 };
121 
122 static const struct com_mca_product {
123 	u_int32_t	cp_prodid;	/* MCA product ID */
124 	const char	*cp_name;	/* device name */
125 	int (*cp_getcfg) __P((struct mca_attach_args *, int *iobase, int *irq));
126 					/* get device i/o base and irq */
127 } com_mca_products[] = {
128 	{ MCA_PRODUCT_IBM_MOD,	"IBM Internal Modem",	ibm_modem_getcfg },
129 	{ MCA_PRODUCT_NEOCOM1,	"NeoTecH Single RS-232 Async. Adapter, SM110",
130 		neocom1_getcfg },
131 	{ MCA_PRODUCT_IBM_MPCOM,"IBM Multi-Protocol Communications Adapter",
132 		ibm_mpcom_getcfg },
133 	{ 0,			NULL,			NULL },
134 };
135 
136 static const struct com_mca_product *com_mca_lookup __P((int));
137 
138 static const struct com_mca_product *
139 com_mca_lookup(ma_id)
140 	int ma_id;
141 {
142 	const struct com_mca_product *cpp;
143 
144 	for (cpp = com_mca_products; cpp->cp_name != NULL; cpp++)
145 		if (cpp->cp_prodid == ma_id)
146 			return (cpp);
147 
148 	return (NULL);
149 }
150 
151 int
152 com_mca_probe(parent, match, aux)
153 	struct device *parent;
154 	struct cfdata *match;
155 	void *aux;
156 {
157 	struct mca_attach_args *ma = aux;
158 
159 	if (com_mca_lookup(ma->ma_id))
160 		return (1);
161 
162 	return (0);
163 }
164 
165 void
166 com_mca_attach(parent, self, aux)
167 	struct device *parent, *self;
168 	void *aux;
169 {
170 	struct com_mca_softc *isc = (void *)self;
171 	struct com_softc *sc = &isc->sc_com;
172 	int iobase, irq;
173 	struct mca_attach_args *ma = aux;
174 	const struct com_mca_product *cpp;
175 
176 	cpp = com_mca_lookup(ma->ma_id);
177 
178 	/* get iobase and irq */
179 	if ((*cpp->cp_getcfg)(ma, &iobase, &irq))
180 		return;
181 
182 	if (bus_space_map(ma->ma_iot, iobase, COM_NPORTS, 0, &sc->sc_ioh)) {
183 		printf(": can't map i/o space\n");
184 		return;
185 	}
186 
187 	sc->sc_frequency = COM_FREQ;
188 	sc->sc_iot = ma->ma_iot;
189 	sc->sc_iobase = iobase;
190 
191 	printf(" slot %d i/o %#x-%#x irq %d", ma->ma_slot + 1,
192 		iobase, iobase + COM_NPORTS - 1, irq);
193 
194 	com_attach_subr(sc);
195 
196 	printf("%s: %s\n", sc->sc_dev.dv_xname, cpp->cp_name);
197 
198 	isc->sc_ih = mca_intr_establish(ma->ma_mc, irq, IPL_SERIAL,
199 			comintr, sc);
200 	if (isc->sc_ih == NULL) {
201                 printf("%s: couldn't establish interrupt handler\n",
202                     sc->sc_dev.dv_xname);
203                 return;
204         }
205 
206 	/*
207 	 * Shutdown hook for buggy BIOSs that don't recognize the UART
208 	 * without a disabled FIFO.
209 	 * XXX is this necessary on MCA ? --- jdolecek
210 	 */
211 	if (shutdownhook_establish(com_mca_cleanup, sc) == NULL)
212 		panic("com_mca_attach: could not establish shutdown hook");
213 }
214 
215 void
216 com_mca_cleanup(arg)
217 	void *arg;
218 {
219 	struct com_softc *sc = arg;
220 
221 	if (ISSET(sc->sc_hwflags, COM_HW_FIFO))
222 		bus_space_write_1(sc->sc_iot, sc->sc_ioh, com_fifo, 0);
223 }
224 
225 /* map serial_X to iobase and irq */
226 static const struct {
227 	int iobase;
228 	int irq;
229 } MCA_SERIAL[] = {
230 	{ 0x03f8,	4 },	/* SERIAL_1 */
231 	{ 0x02f8,	3 },	/* SERIAL_2 */
232 	{ 0x3220,	3 },	/* SERIAL_3 */
233 	{ 0x3228,	3 },	/* SERIAL_4 */
234 	{ 0x4220,	3 },	/* SERIAL_5 */
235 	{ 0x4228,	3 },	/* SERIAL_6 */
236 	{ 0x5220,	3 },	/* SERIAL_7 */
237 	{ 0x5228,	3 },	/* SERIAL_8 */
238 };
239 
240 /*
241  * Get config for IBM Internal Modem (ID 0xEDFF). This beast doesn't
242  * seem to support even AT commands, it's good as example for adding
243  * other stuff though.
244  */
245 static int
246 ibm_modem_getcfg(ma, iobasep, irqp)
247 	struct mca_attach_args *ma;
248 	int *iobasep, *irqp;
249 {
250 	int pos2;
251 	int snum;
252 
253 	pos2 = mca_conf_read(ma->ma_mc, ma->ma_slot, 2);
254 
255 	/*
256 	 * POS register 2: (adf pos0)
257 	 * 7 6 5 4 3 2 1 0
258 	 *         \__/  \__ enable: 0=adapter disabled, 1=adapter enabled
259 	 *            \_____ Serial Configuration: XX=SERIAL_XX
260 	 */
261 
262 	snum = (pos2 & 0x0e) >> 1;
263 
264 	*iobasep = MCA_SERIAL[snum].iobase;
265 	*irqp = MCA_SERIAL[snum].irq;
266 
267 	return (0);
268 }
269 
270 /*
271  * Get configuration for NeoTecH Single RS-232 Async. Adapter, SM110.
272  */
273 static int
274 neocom1_getcfg(ma, iobasep, irqp)
275 	struct mca_attach_args *ma;
276 	int *iobasep, *irqp;
277 {
278 	int pos2, pos3, pos4;
279 	static const int neotech_irq[] = { 12, 9, 4, 3 };
280 
281 	pos2 = mca_conf_read(ma->ma_mc, ma->ma_slot, 2);
282 	pos3 = mca_conf_read(ma->ma_mc, ma->ma_slot, 3);
283 	pos4 = mca_conf_read(ma->ma_mc, ma->ma_slot, 4);
284 
285 	/*
286 	 * POS register 2: (adf pos0)
287 	 * 7 6 5 4 3 2 1 0
288 	 *     1     \_/ \__ enable: 0=adapter disabled, 1=adapter enabled
289 	 *             \____ IRQ: 11=3 10=4 01=9 00=12
290 	 *
291 	 * POS register 3: (adf pos1)
292 	 * 7 6 5 4 3 2 1 0
293 	 * \______/
294 	 *        \_________ I/O Address: bits 7-3
295 	 *
296 	 * POS register 4: (adf pos2)
297 	 * 7 6 5 4 3 2 1 0
298 	 * \_____________/
299 	 *               \__ I/O Address: bits 15-8
300 	 */
301 
302 	*iobasep = (pos4 << 8) | (pos3 & 0xf8);
303 	*irqp = neotech_irq[(pos2 & 0x06) >> 1];
304 
305 	return (0);
306 }
307 
308 /*
309  * Get configuration for IBM Multi-Protocol Communications Adapter.
310  * We only support SERIAL mode, bail out if set to SDLC or BISYNC.
311  */
312 static int
313 ibm_mpcom_getcfg(ma, iobasep, irqp)
314 	struct mca_attach_args *ma;
315 	int *iobasep, *irqp;
316 {
317 	int snum, pos2;
318 
319 	pos2 = mca_conf_read(ma->ma_mc, ma->ma_slot, 2);
320 
321 	/*
322 	 * For SERIAL mode, bit 4 has to be 0.
323 	 *
324 	 * POS register 2: (adf pos0)
325 	 * 7 6 5 4 3 2 1 0
326 	 *       0 \__/  \__ enable: 0=adapter disabled, 1=adapter enabled
327 	 *            \_____ Serial Configuration: XX=SERIAL_XX
328 	 */
329 
330 	if (pos2 & 0x10) {
331 		printf(": not set to SERIAL mode, ignored\n");
332 		return (1);
333 	}
334 
335 	snum = (pos2 & 0x0e) >> 1;
336 
337 	*iobasep = MCA_SERIAL[snum].iobase;
338 	*irqp = MCA_SERIAL[snum].irq;
339 
340 	return (0);
341 }
342