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