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