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