xref: /netbsd-src/sys/dev/mvme/lpt_mvme.c (revision b7b7574d3bf8eeb51a1fa3977b59142ec6434a55)
1 /*	$NetBSD: lpt_mvme.c,v 1.17 2014/03/16 05:20:28 dholland Exp $	*/
2 
3 /*-
4  * Copyright (c) 1999, 2002 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Steve C. Woodford.
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  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 /*
33  * Copyright (c) 1993, 1994 Charles M. Hannum.
34  * Copyright (c) 1990 William F. Jolitz, TeleMuse
35  * All rights reserved.
36  *
37  * Redistribution and use in source and binary forms, with or without
38  * modification, are permitted provided that the following conditions
39  * are met:
40  * 1. Redistributions of source code must retain the above copyright
41  *    notice, this list of conditions and the following disclaimer.
42  * 2. Redistributions in binary form must reproduce the above copyright
43  *    notice, this list of conditions and the following disclaimer in the
44  *    documentation and/or other materials provided with the distribution.
45  * 3. All advertising materials mentioning features or use of this software
46  *    must display the following acknowledgement:
47  *	This software is a component of "386BSD" developed by
48  *	William F. Jolitz, TeleMuse.
49  * 4. Neither the name of the developer nor the name "386BSD"
50  *    may be used to endorse or promote products derived from this software
51  *    without specific prior written permission.
52  *
53  * THIS SOFTWARE IS A COMPONENT OF 386BSD DEVELOPED BY WILLIAM F. JOLITZ
54  * AND IS INTENDED FOR RESEARCH AND EDUCATIONAL PURPOSES ONLY. THIS
55  * SOFTWARE SHOULD NOT BE CONSIDERED TO BE A COMMERCIAL PRODUCT.
56  * THE DEVELOPER URGES THAT USERS WHO REQUIRE A COMMERCIAL PRODUCT
57  * NOT MAKE USE OF THIS WORK.
58  *
59  * FOR USERS WHO WISH TO UNDERSTAND THE 386BSD SYSTEM DEVELOPED
60  * BY WILLIAM F. JOLITZ, WE RECOMMEND THE USER STUDY WRITTEN
61  * REFERENCES SUCH AS THE  "PORTING UNIX TO THE 386" SERIES
62  * (BEGINNING JANUARY 1991 "DR. DOBBS JOURNAL", USA AND BEGINNING
63  * JUNE 1991 "UNIX MAGAZIN", GERMANY) BY WILLIAM F. JOLITZ AND
64  * LYNNE GREER JOLITZ, AS WELL AS OTHER BOOKS ON UNIX AND THE
65  * ON-LINE 386BSD USER MANUAL BEFORE USE. A BOOK DISCUSSING THE INTERNALS
66  * OF 386BSD ENTITLED "386BSD FROM THE INSIDE OUT" WILL BE AVAILABLE LATE 1992.
67  *
68  * THIS SOFTWARE IS PROVIDED BY THE DEVELOPER ``AS IS'' AND
69  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
70  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
71  * ARE DISCLAIMED.  IN NO EVENT SHALL THE DEVELOPER BE LIABLE
72  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
73  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
74  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
75  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
76  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
77  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
78  * SUCH DAMAGE.
79  */
80 
81 /*
82  * Device Driver for an MVME68K/MVME88K board's parallel printer port
83  * This driver attaches above the board-specific back-end.
84  */
85 
86 #include <sys/cdefs.h>
87 __KERNEL_RCSID(0, "$NetBSD: lpt_mvme.c,v 1.17 2014/03/16 05:20:28 dholland Exp $");
88 
89 #include <sys/param.h>
90 #include <sys/systm.h>
91 #include <sys/proc.h>
92 #include <sys/buf.h>
93 #include <sys/kernel.h>
94 #include <sys/ioctl.h>
95 #include <sys/uio.h>
96 #include <sys/device.h>
97 #include <sys/conf.h>
98 #include <sys/syslog.h>
99 
100 #include <sys/cpu.h>
101 #include <sys/bus.h>
102 
103 #include <dev/mvme/lptvar.h>
104 
105 
106 #define	TIMEOUT		hz*16	/* wait up to 16 seconds for a ready */
107 #define	STEP		hz/4
108 
109 #define	LPTPRI		(PZERO+8)
110 #define	LPT_BSIZE	1024
111 
112 #if !defined(DEBUG) || !defined(notdef)
113 #define LPRINTF(a)
114 #else
115 #define LPRINTF		if (lptdebug) aprint_verbose_dev a
116 int lptdebug = 1;
117 #endif
118 
119 #define	LPTUNIT(s)	(minor(s) & 0x0f)
120 #define	LPTFLAGS(s)	(minor(s) & 0xf0)
121 
122 static void lpt_wakeup(void *arg);
123 static int pushbytes(struct lpt_softc *);
124 
125 extern struct cfdriver lpt_cd;
126 
127 dev_type_open(lptopen);
128 dev_type_close(lptclose);
129 dev_type_write(lptwrite);
130 dev_type_ioctl(lptioctl);
131 
132 const struct cdevsw lpt_cdevsw = {
133 	.d_open = lptopen,
134 	.d_close = lptclose,
135 	.d_read = noread,
136 	.d_write = lptwrite,
137 	.d_ioctl = lptioctl,
138 	.d_stop = nostop,
139 	.d_tty = notty,
140 	.d_poll = nopoll,
141 	.d_mmap = nommap,
142 	.d_kqfilter = nokqfilter,
143 	.d_flag = 0
144 };
145 
146 void
147 lpt_attach_subr(struct lpt_softc *sc)
148 {
149 
150 	sc->sc_state = 0;
151 	callout_init(&sc->sc_wakeup_ch, 0);
152 }
153 
154 /*
155  * Reset the printer, then wait until it's selected and not busy.
156  */
157 int
158 lptopen(dev_t dev, int flag, int mode, struct lwp *l)
159 {
160 	u_char flags;
161 	struct lpt_softc *sc;
162 	int error;
163 	int spin;
164 
165 	flags = LPTFLAGS(dev);
166 
167 	sc = device_lookup_private(&lpt_cd, LPTUNIT(dev));
168 	if (!sc)
169 		return (ENXIO);
170 
171 #ifdef DIAGNOSTIC
172 	if (sc->sc_state)
173 		aprint_verbose_dev(sc->sc_dev, "stat=0x%x not zero\n",
174 		    sc->sc_state);
175 #endif
176 
177 	if (sc->sc_state)
178 		return (EBUSY);
179 
180 	sc->sc_state = LPT_INIT;
181 	sc->sc_flags = flags;
182 	LPRINTF((sc->sc_dev, "open: flags=0x%x\n", flags));
183 
184 	if ((flags & LPT_NOPRIME) == 0) {
185 		/* assert Input Prime for 100 usec to start up printer */
186 		(sc->sc_funcs->lf_iprime) (sc);
187 	}
188 
189 	/* select fast or slow strobe depending on minor device number */
190 	if (flags & LPT_FAST_STROBE)
191 		(sc->sc_funcs->lf_speed) (sc, LPT_STROBE_FAST);
192 	else
193 		(sc->sc_funcs->lf_speed) (sc, LPT_STROBE_SLOW);
194 
195 	/* wait till ready (printer running diagnostics) */
196 	for (spin = 0; (sc->sc_funcs->lf_notrdy) (sc, 1); spin += STEP) {
197 		if (spin >= TIMEOUT) {
198 			sc->sc_state = 0;
199 			return (EBUSY);
200 		}
201 		/* wait 1/4 second, give up if we get a signal */
202 		error = tsleep((void *) sc, LPTPRI | PCATCH, "lptopen", STEP);
203 		if (error != EWOULDBLOCK) {
204 			sc->sc_state = 0;
205 			return (error);
206 		}
207 	}
208 
209 	sc->sc_inbuf = geteblk(LPT_BSIZE);
210 	sc->sc_count = 0;
211 	sc->sc_state = LPT_OPEN;
212 
213 	if ((sc->sc_flags & LPT_NOINTR) == 0)
214 		lpt_wakeup(sc);
215 
216 	(sc->sc_funcs->lf_open) (sc, sc->sc_flags & LPT_NOINTR);
217 
218 	LPRINTF((sc->sc_dev, "opened\n"));
219 	return (0);
220 }
221 
222 void
223 lpt_wakeup(void *arg)
224 {
225 	struct lpt_softc *sc;
226 	int s;
227 
228 	sc = arg;
229 
230 	s = spltty();
231 	lpt_intr(sc);
232 	splx(s);
233 
234 	callout_reset(&sc->sc_wakeup_ch, STEP, lpt_wakeup, sc);
235 }
236 
237 /*
238  * Close the device, and free the local line buffer.
239  */
240 int
241 lptclose(dev_t dev, int flag, int mode, struct lwp *l)
242 {
243 	struct lpt_softc *sc;
244 
245 	sc = device_lookup_private(&lpt_cd, LPTUNIT(dev));
246 
247 	if (sc->sc_count)
248 		(void) pushbytes(sc);
249 
250 	if ((sc->sc_flags & LPT_NOINTR) == 0)
251 		callout_stop(&sc->sc_wakeup_ch);
252 
253 	(sc->sc_funcs->lf_close) (sc);
254 
255 	sc->sc_state = 0;
256 	brelse(sc->sc_inbuf, 0);
257 
258 	LPRINTF((sc->sc_dev, "%s: closed\n"));
259 	return (0);
260 }
261 
262 int
263 pushbytes(struct lpt_softc *sc)
264 {
265 	int s, error, spin, tic;
266 
267 	if (sc->sc_flags & LPT_NOINTR) {
268 		while (sc->sc_count > 0) {
269 			spin = 0;
270 			while ((sc->sc_funcs->lf_notrdy) (sc, 0)) {
271 				if (++spin < sc->sc_spinmax)
272 					continue;
273 				tic = 0;
274 				/* adapt busy-wait algorithm */
275 				sc->sc_spinmax++;
276 				while ((sc->sc_funcs->lf_notrdy) (sc, 1)) {
277 					/* exponential backoff */
278 					tic = tic + tic + 1;
279 					if (tic > TIMEOUT)
280 						tic = TIMEOUT;
281 					error = tsleep((void *) sc,
282 					    LPTPRI | PCATCH, "lptpsh", tic);
283 					if (error != EWOULDBLOCK)
284 						return (error);
285 				}
286 				break;
287 			}
288 
289 			(sc->sc_funcs->lf_wrdata) (sc, *sc->sc_cp++);
290 			sc->sc_count--;
291 
292 			/* adapt busy-wait algorithm */
293 			if (spin * 2 + 16 < sc->sc_spinmax)
294 				sc->sc_spinmax--;
295 		}
296 	} else {
297 		while (sc->sc_count > 0) {
298 			/* if the printer is ready for a char, give it one */
299 			if ((sc->sc_state & LPT_OBUSY) == 0) {
300 				LPRINTF((sc->sc_dev, "write %d\n",
301 					sc->sc_count));
302 				s = spltty();
303 				(void) lpt_intr(sc);
304 				splx(s);
305 			}
306 			error = tsleep((void *) sc, LPTPRI | PCATCH,
307 			    "lptwrite2", 0);
308 			if (error)
309 				return (error);
310 		}
311 	}
312 	return (0);
313 }
314 
315 /*
316  * Copy a line from user space to a local buffer, then call putc to get the
317  * chars moved to the output queue.
318  */
319 int
320 lptwrite(dev_t dev, struct uio *uio, int flags)
321 {
322 	struct lpt_softc *sc;
323 	size_t n;
324 	int error;
325 
326 	sc = device_lookup_private(&lpt_cd, LPTUNIT(dev));
327 	error = 0;
328 
329 	while ((n = min(LPT_BSIZE, uio->uio_resid)) != 0) {
330 		uiomove(sc->sc_cp = sc->sc_inbuf->b_data, n, uio);
331 		sc->sc_count = n;
332 		error = pushbytes(sc);
333 		if (error) {
334 			/*
335 			 * Return accurate residual if interrupted or timed
336 			 * out.
337 			 */
338 			uio->uio_resid += sc->sc_count;
339 			sc->sc_count = 0;
340 			return (error);
341 		}
342 	}
343 	return (0);
344 }
345 
346 /*
347  * Handle printer interrupts which occur when the printer is ready to accept
348  * another char.
349  */
350 int
351 lpt_intr(struct lpt_softc *sc)
352 {
353 
354 	if (sc->sc_count) {
355 		/* send char */
356 		(sc->sc_funcs->lf_wrdata) (sc, *sc->sc_cp++);
357 		sc->sc_count--;
358 		sc->sc_state |= LPT_OBUSY;
359 	} else
360 		sc->sc_state &= ~LPT_OBUSY;
361 
362 	if (sc->sc_count == 0) {
363 		/* none, wake up the top half to get more */
364 		wakeup((void *) sc);
365 	}
366 
367 	return (1);
368 }
369 
370 /* ARGSUSED */
371 int
372 lptioctl(dev_t dev, u_long cmd, void *data, int flag, struct lwp *l)
373 {
374 
375 	return (ENODEV);
376 }
377