xref: /netbsd-src/sys/dev/qbus/dl.c (revision 3b01aba77a7a698587faaae455bbfe740923c1f5)
1 /*	$NetBSD: dl.c,v 1.18 2001/05/26 21:24:38 ragge Exp $	*/
2 
3 /*-
4  * Copyright (c) 1996, 1997 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Jason R. Thorpe.
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) 1997  Ben Harris.  All rights reserved.
41  * Copyright (c) 1996  Ken C. Wellsch.  All rights reserved.
42  * Copyright (c) 1982, 1986, 1990, 1992, 1993
43  *	The Regents of the University of California.  All rights reserved.
44  *
45  * This code is derived from software contributed to Berkeley by
46  * Ralph Campbell and Rick Macklem.
47  *
48  * Redistribution and use in source and binary forms, with or without
49  * modification, are permitted provided that the following conditions
50  * are met:
51  * 1. Redistributions of source code must retain the above copyright
52  *    notice, this list of conditions and the following disclaimer.
53  * 2. Redistributions in binary form must reproduce the above copyright
54  *    notice, this list of conditions and the following disclaimer in the
55  *    documentation and/or other materials provided with the distribution.
56  * 3. All advertising materials mentioning features or use of this software
57  *    must display the following acknowledgement:
58  *	This product includes software developed by the University of
59  *	California, Berkeley and its contributors.
60  * 4. Neither the name of the University nor the names of its contributors
61  *    may be used to endorse or promote products derived from this software
62  *    without specific prior written permission.
63  *
64  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
65  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
66  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
67  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
68  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
69  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
70  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
71  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
72  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
73  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
74  * SUCH DAMAGE.
75  */
76 
77 /*
78  * dl.c -- Device driver for the DL11 and DLV11 serial cards.
79  *
80  * OS-interface code derived from the dz and dca (hp300) drivers.
81  */
82 
83 #include <sys/param.h>
84 #include <sys/systm.h>
85 #include <sys/ioctl.h>
86 #include <sys/tty.h>
87 #include <sys/proc.h>
88 #include <sys/map.h>
89 #include <sys/buf.h>
90 #include <sys/conf.h>
91 #include <sys/file.h>
92 #include <sys/uio.h>
93 #include <sys/kernel.h>
94 #include <sys/syslog.h>
95 #include <sys/device.h>
96 
97 #include <machine/bus.h>
98 
99 #include <dev/qbus/ubavar.h>
100 
101 #include <dev/qbus/dlreg.h>
102 
103 #include "ioconf.h"
104 
105 struct dl_softc {
106 	struct device	sc_dev;
107 	struct evcnt	sc_rintrcnt;
108 	struct evcnt	sc_tintrcnt;
109 	bus_space_tag_t	sc_iot;
110 	bus_space_handle_t sc_ioh;
111 	struct tty	*sc_tty;
112 };
113 
114 static	int	dl_match (struct device *, struct cfdata *, void *);
115 static	void	dl_attach (struct device *, struct device *, void *);
116 static	void	dlrint (void *);
117 static	void	dlxint (void *);
118 static	void	dlstart (struct tty *);
119 static	int	dlparam (struct tty *, struct termios *);
120 static	void	dlbrk (struct dl_softc *, int);
121 struct	tty *	dltty (dev_t);
122 
123 cdev_decl(dl);
124 
125 struct cfattach dl_ca = {
126 	sizeof(struct dl_softc), dl_match, dl_attach
127 };
128 
129 #define	DL_READ_WORD(reg) \
130 	bus_space_read_2(sc->sc_iot, sc->sc_ioh, reg)
131 #define	DL_WRITE_WORD(reg, val) \
132 	bus_space_write_2(sc->sc_iot, sc->sc_ioh, reg, val)
133 #define	DL_WRITE_BYTE(reg, val) \
134 	bus_space_write_1(sc->sc_iot, sc->sc_ioh, reg, val)
135 
136 /* Autoconfig handles: setup the controller to interrupt, */
137 /* then complete the housecleaning for full operation */
138 
139 static int
140 dl_match (struct device *parent, struct cfdata *cf, void *aux)
141 {
142 	struct uba_attach_args *ua = aux;
143 
144 #ifdef DL_DEBUG
145 	printf("Probing for dl at %lo ... ", (long)ua->ua_iaddr);
146 #endif
147 
148 	bus_space_write_2(ua->ua_iot, ua->ua_ioh, DL_UBA_XCSR, DL_XCSR_TXIE);
149 	if (bus_space_read_2(ua->ua_iot, ua->ua_ioh, DL_UBA_XCSR) !=
150 	    (DL_XCSR_TXIE | DL_XCSR_TX_READY)) {
151 #ifdef DL_DEBUG
152 	        printf("failed (step 1; XCSR = %.4b)\n",
153 		    bus_space_read_2(ua->ua_iot, ua->ua_ioh, DL_UBA_XCSR),
154 		    DL_XCSR_BITS);
155 #endif
156 		return 0;
157 	}
158 
159 	/*
160 	 * We have to force an interrupt so the uba driver can work
161 	 * out where we are.  Unfortunately, the only way to make a
162 	 * DL11 interrupt is to get it to send or receive a
163 	 * character.  We'll send a NUL and hope it doesn't hurt
164 	 * anything.
165 	 */
166 
167 	bus_space_write_1(ua->ua_iot, ua->ua_ioh, DL_UBA_XBUFL, '\0');
168 #if 0 /* This test seems to fail 2/3 of the time :-( */
169 	if (dladdr->dl_xcsr != (DL_XCSR_TXIE)) {
170 #ifdef DL_DEBUG
171 	        printf("failed (step 2; XCSR = %.4b)\n", dladdr->dl_xcsr,
172 		       DL_XCSR_BITS);
173 #endif
174 		return 0;
175 	}
176 #endif
177 	DELAY(100000); /* delay 1/10 s for character to transmit */
178 	if (bus_space_read_2(ua->ua_iot, ua->ua_ioh, DL_UBA_XCSR) !=
179 	    (DL_XCSR_TXIE | DL_XCSR_TX_READY)) {
180 #ifdef DL_DEBUG
181 	        printf("failed (step 3; XCSR = %.4b)\n",
182 		    bus_space_read_2(ua->ua_iot, ua->ua_ioh, DL_UBA_XCSR),
183 		    DL_XCSR_BITS);
184 #endif
185 		return 0;
186 	}
187 
188 
189         /* What else do I need to do? */
190 
191 	return 1;
192 
193 }
194 
195 static void
196 dl_attach (struct device *parent, struct device *self, void *aux)
197 {
198 	struct dl_softc *sc = (void *)self;
199 	struct uba_attach_args *ua = aux;
200 
201 	sc->sc_iot = ua->ua_iot;
202 	sc->sc_ioh = ua->ua_ioh;
203 
204 	/* Tidy up the device */
205 
206 	DL_WRITE_WORD(DL_UBA_RCSR, DL_RCSR_RXIE);
207 	DL_WRITE_WORD(DL_UBA_XCSR, DL_XCSR_TXIE);
208 
209 	/* Initialize our softc structure. Should be done in open? */
210 
211 	sc->sc_tty = ttymalloc();
212 	tty_attach(sc->sc_tty);
213 
214 	/* Now register the TX & RX interrupt handlers */
215 	uba_intr_establish(ua->ua_icookie, ua->ua_cvec,
216 		dlxint, sc, &sc->sc_tintrcnt);
217 	uba_intr_establish(ua->ua_icookie, ua->ua_cvec - 4,
218 		dlrint, sc, &sc->sc_rintrcnt);
219 	evcnt_attach_dynamic(&sc->sc_rintrcnt, EVCNT_TYPE_INTR, ua->ua_evcnt,
220 		sc->sc_dev.dv_xname, "rintr");
221 	evcnt_attach_dynamic(&sc->sc_tintrcnt, EVCNT_TYPE_INTR, ua->ua_evcnt,
222 		sc->sc_dev.dv_xname, "tintr");
223 
224 	printf("\n");
225 }
226 
227 /* Receiver Interrupt Handler */
228 
229 static void
230 dlrint(void *arg)
231 {
232 	struct dl_softc *sc = arg;
233 
234 	if (DL_READ_WORD(DL_UBA_RCSR) & DL_RCSR_RX_DONE) {
235 		struct tty *tp = sc->sc_tty;
236 		unsigned c;
237 		int cc;
238 
239 	        c = DL_READ_WORD(DL_UBA_RBUF);
240 		cc = c & 0xFF;
241 
242 		if (!(tp->t_state & TS_ISOPEN)) {
243 			wakeup((caddr_t)&tp->t_rawq);
244 			return;
245 		}
246 
247 		if (c & DL_RBUF_OVERRUN_ERR) {
248 			/*
249 			 * XXX: This should really be logged somwhere
250 			 * else where we can afford the time.
251 			 */
252 			log(LOG_WARNING, "%s: rx overrun\n",
253 			    sc->sc_dev.dv_xname);
254 		}
255 		if (c & DL_RBUF_FRAMING_ERR)
256 			cc |= TTY_FE;
257 		if (c & DL_RBUF_PARITY_ERR)
258 			cc |= TTY_PE;
259 
260 		(*tp->t_linesw->l_rint)(cc, tp);
261 #if defined(DIAGNOSTIC)
262 	} else {
263 		log(LOG_WARNING, "%s: stray rx interrupt\n",
264 		    sc->sc_dev.dv_xname);
265 #endif
266 	}
267 }
268 
269 /* Transmitter Interrupt Handler */
270 
271 static void
272 dlxint(void *arg)
273 {
274 	struct dl_softc *sc = arg;
275 	struct tty *tp = sc->sc_tty;
276 
277 	tp->t_state &= ~(TS_BUSY | TS_FLUSH);
278 	(*tp->t_linesw->l_start)(tp);
279 
280 	return;
281 }
282 
283 int
284 dlopen(dev_t dev, int flag, int mode, struct proc *p)
285 {
286 	struct tty *tp;
287 	struct dl_softc *sc;
288 	int unit;
289 
290 	unit = minor(dev);
291 
292 	if (unit >= dl_cd.cd_ndevs || dl_cd.cd_devs[unit] == NULL)
293 		return ENXIO;
294 	sc = dl_cd.cd_devs[unit];
295 
296 	tp = sc->sc_tty;
297 	if (tp == NULL)
298 		return ENODEV;
299 	tp->t_oproc = dlstart;
300 	tp->t_param = dlparam;
301 	tp->t_dev = dev;
302 
303 	if (!(tp->t_state & TS_ISOPEN)) {
304 		ttychars(tp);
305 		tp->t_iflag = TTYDEF_IFLAG;
306 		tp->t_oflag = TTYDEF_OFLAG;
307 		/* No modem control, so set CLOCAL. */
308 		tp->t_cflag = TTYDEF_CFLAG | CLOCAL;
309 		tp->t_lflag = TTYDEF_LFLAG;
310 		tp->t_ispeed = tp->t_ospeed = TTYDEF_SPEED;
311 
312 		dlparam(tp, &tp->t_termios);
313 		ttsetwater(tp);
314 
315 	} else if ((tp->t_state & TS_XCLUDE) && p->p_ucred->cr_uid != 0)
316 		return EBUSY;
317 
318 	return ((*tp->t_linesw->l_open)(dev, tp));
319 }
320 
321 /*ARGSUSED*/
322 int
323 dlclose(dev_t dev, int flag, int mode, struct proc *p)
324 {
325 	struct dl_softc *sc = dl_cd.cd_devs[minor(dev)];
326 	struct tty *tp = sc->sc_tty;
327 
328 	(*tp->t_linesw->l_close)(tp, flag);
329 
330 	/* Make sure a BREAK state is not left enabled. */
331 	dlbrk(sc, 0);
332 
333 	return (ttyclose(tp));
334 }
335 
336 int
337 dlread(dev_t dev, struct uio *uio, int flag)
338 {
339 	struct dl_softc *sc = dl_cd.cd_devs[minor(dev)];
340 	struct tty *tp = sc->sc_tty;
341 
342 	return ((*tp->t_linesw->l_read)(tp, uio, flag));
343 }
344 
345 int
346 dlwrite(dev_t dev, struct uio *uio, int flag)
347 {
348 	struct dl_softc *sc = dl_cd.cd_devs[minor(dev)];
349 	struct tty *tp = sc->sc_tty;
350 
351 	return ((*tp->t_linesw->l_write)(tp, uio, flag));
352 }
353 
354 int
355 dlpoll(dev_t dev, int events, struct proc *p)
356 {
357 	struct dl_softc *sc = dl_cd.cd_devs[minor(dev)];
358 	struct tty *tp = sc->sc_tty;
359 
360 	return ((*tp->t_linesw->l_poll)(tp, events, p));
361 }
362 
363 int
364 dlioctl(dev_t dev, unsigned long cmd, caddr_t data, int flag, struct proc *p)
365 {
366 	struct dl_softc *sc = dl_cd.cd_devs[minor(dev)];
367         struct tty *tp = sc->sc_tty;
368         int error;
369 
370 
371         error = (*tp->t_linesw->l_ioctl)(tp, cmd, data, flag, p);
372         if (error >= 0)
373                 return (error);
374         error = ttioctl(tp, cmd, data, flag, p);
375         if (error >= 0)
376                 return (error);
377 
378 	switch (cmd) {
379 
380         case TIOCSBRK:
381                 dlbrk(sc, 1);
382                 break;
383 
384         case TIOCCBRK:
385                 dlbrk(sc, 0);
386                 break;
387 
388         case TIOCMGET:
389 		/* No modem control, assume they're all low. */
390                 *(int *)data = 0;
391                 break;
392 
393         default:
394                 return (ENOTTY);
395         }
396         return (0);
397 }
398 
399 struct tty *
400 dltty(dev_t dev)
401 {
402 	struct dl_softc *sc = dl_cd.cd_devs[minor(dev)];
403 
404 	return sc->sc_tty;
405 }
406 
407 void
408 dlstop(struct tty *tp, int flag)
409 {
410 	int s = spltty();
411 
412 	if ((tp->t_state & (TS_BUSY|TS_TTSTOP)) == TS_BUSY)
413 		tp->t_state |= TS_FLUSH;
414         splx(s);
415 }
416 
417 static void
418 dlstart(struct tty *tp)
419 {
420 	struct dl_softc *sc = dl_cd.cd_devs[minor(tp->t_dev)];
421 	int s = spltty();
422 
423         if (tp->t_state & (TS_TIMEOUT|TS_BUSY|TS_TTSTOP))
424                 goto out;
425         if (tp->t_outq.c_cc <= tp->t_lowat) {
426                 if (tp->t_state & TS_ASLEEP) {
427                         tp->t_state &= ~TS_ASLEEP;
428                         wakeup((caddr_t)&tp->t_outq);
429                 }
430                 selwakeup(&tp->t_wsel);
431         }
432         if (tp->t_outq.c_cc == 0)
433                 goto out;
434 
435 
436 	if (DL_READ_WORD(DL_UBA_XCSR) & DL_XCSR_TX_READY) {
437 		tp->t_state |= TS_BUSY;
438 		DL_WRITE_BYTE(DL_UBA_XBUFL, getc(&tp->t_outq));
439 	}
440 out:
441 	splx(s);
442 	return;
443 }
444 
445 /*ARGSUSED*/
446 static int
447 dlparam(struct tty *tp, struct termios *t)
448 {
449 	/*
450 	 * All this kind of stuff (speed, character format, whatever)
451 	 * is set by jumpers on the card.  Changing it is thus rather
452 	 * tricky for a mere device driver.
453 	 */
454 	return 0;
455 }
456 
457 static void
458 dlbrk(struct dl_softc *sc, int state)
459 {
460 	int s = spltty();
461 
462 	if (state) {
463 		DL_WRITE_WORD(DL_UBA_XCSR, DL_READ_WORD(DL_UBA_XCSR) |
464 		    DL_XCSR_TX_BREAK);
465 	} else {
466 		DL_WRITE_WORD(DL_UBA_XCSR, DL_READ_WORD(DL_UBA_XCSR) &
467 		    ~DL_XCSR_TX_BREAK);
468 	}
469 	splx(s);
470 }
471