xref: /netbsd-src/sys/dev/mvme/lpt_mvme.c (revision 10ad5ffa714ce1a679dcc9dd8159648df2d67b5a)
1 /*	$NetBSD: lpt_mvme.c,v 1.15 2009/03/14 15:36:19 dsl 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.15 2009/03/14 15:36:19 dsl Exp $");
88 
89 #include <sys/param.h>
90 #include <sys/systm.h>
91 #include <sys/proc.h>
92 #include <sys/user.h>
93 #include <sys/buf.h>
94 #include <sys/kernel.h>
95 #include <sys/ioctl.h>
96 #include <sys/uio.h>
97 #include <sys/device.h>
98 #include <sys/conf.h>
99 #include <sys/syslog.h>
100 
101 #include <sys/cpu.h>
102 #include <sys/bus.h>
103 
104 #include <dev/mvme/lptvar.h>
105 
106 
107 #define	TIMEOUT		hz*16	/* wait up to 16 seconds for a ready */
108 #define	STEP		hz/4
109 
110 #define	LPTPRI		(PZERO+8)
111 #define	LPT_BSIZE	1024
112 
113 #if !defined(DEBUG) || !defined(notdef)
114 #define LPRINTF(a)
115 #else
116 #define LPRINTF		if (lptdebug) aprint_verbose_dev a
117 int lptdebug = 1;
118 #endif
119 
120 #define	LPTUNIT(s)	(minor(s) & 0x0f)
121 #define	LPTFLAGS(s)	(minor(s) & 0xf0)
122 
123 static void lpt_wakeup(void *arg);
124 static int pushbytes(struct lpt_softc *);
125 
126 extern struct cfdriver lpt_cd;
127 
128 dev_type_open(lptopen);
129 dev_type_close(lptclose);
130 dev_type_write(lptwrite);
131 dev_type_ioctl(lptioctl);
132 
133 const struct cdevsw lpt_cdevsw = {
134 	lptopen, lptclose, noread, lptwrite, lptioctl,
135 	nostop, notty, nopoll, nommap, nokqfilter,
136 };
137 
138 void
139 lpt_attach_subr(struct lpt_softc *sc)
140 {
141 
142 	sc->sc_state = 0;
143 	callout_init(&sc->sc_wakeup_ch, 0);
144 }
145 
146 /*
147  * Reset the printer, then wait until it's selected and not busy.
148  */
149 int
150 lptopen(dev_t dev, int flag, int mode, struct lwp *l)
151 {
152 	u_char flags;
153 	struct lpt_softc *sc;
154 	int error;
155 	int spin;
156 
157 	flags = LPTFLAGS(dev);
158 
159 	sc = device_lookup_private(&lpt_cd, LPTUNIT(dev));
160 	if (!sc)
161 		return (ENXIO);
162 
163 #ifdef DIAGNOSTIC
164 	if (sc->sc_state)
165 		aprint_verbose_dev(sc->sc_dev, "stat=0x%x not zero\n",
166 		    sc->sc_state);
167 #endif
168 
169 	if (sc->sc_state)
170 		return (EBUSY);
171 
172 	sc->sc_state = LPT_INIT;
173 	sc->sc_flags = flags;
174 	LPRINTF((sc->sc_dev, "open: flags=0x%x\n", flags));
175 
176 	if ((flags & LPT_NOPRIME) == 0) {
177 		/* assert Input Prime for 100 usec to start up printer */
178 		(sc->sc_funcs->lf_iprime) (sc);
179 	}
180 
181 	/* select fast or slow strobe depending on minor device number */
182 	if (flags & LPT_FAST_STROBE)
183 		(sc->sc_funcs->lf_speed) (sc, LPT_STROBE_FAST);
184 	else
185 		(sc->sc_funcs->lf_speed) (sc, LPT_STROBE_SLOW);
186 
187 	/* wait till ready (printer running diagnostics) */
188 	for (spin = 0; (sc->sc_funcs->lf_notrdy) (sc, 1); spin += STEP) {
189 		if (spin >= TIMEOUT) {
190 			sc->sc_state = 0;
191 			return (EBUSY);
192 		}
193 		/* wait 1/4 second, give up if we get a signal */
194 		error = tsleep((void *) sc, LPTPRI | PCATCH, "lptopen", STEP);
195 		if (error != EWOULDBLOCK) {
196 			sc->sc_state = 0;
197 			return (error);
198 		}
199 	}
200 
201 	sc->sc_inbuf = geteblk(LPT_BSIZE);
202 	sc->sc_count = 0;
203 	sc->sc_state = LPT_OPEN;
204 
205 	if ((sc->sc_flags & LPT_NOINTR) == 0)
206 		lpt_wakeup(sc);
207 
208 	(sc->sc_funcs->lf_open) (sc, sc->sc_flags & LPT_NOINTR);
209 
210 	LPRINTF((sc->sc_dev, "opened\n"));
211 	return (0);
212 }
213 
214 void
215 lpt_wakeup(void *arg)
216 {
217 	struct lpt_softc *sc;
218 	int s;
219 
220 	sc = arg;
221 
222 	s = spltty();
223 	lpt_intr(sc);
224 	splx(s);
225 
226 	callout_reset(&sc->sc_wakeup_ch, STEP, lpt_wakeup, sc);
227 }
228 
229 /*
230  * Close the device, and free the local line buffer.
231  */
232 int
233 lptclose(dev_t dev, int flag, int mode, struct lwp *l)
234 {
235 	struct lpt_softc *sc;
236 
237 	sc = device_lookup_private(&lpt_cd, LPTUNIT(dev));
238 
239 	if (sc->sc_count)
240 		(void) pushbytes(sc);
241 
242 	if ((sc->sc_flags & LPT_NOINTR) == 0)
243 		callout_stop(&sc->sc_wakeup_ch);
244 
245 	(sc->sc_funcs->lf_close) (sc);
246 
247 	sc->sc_state = 0;
248 	brelse(sc->sc_inbuf, 0);
249 
250 	LPRINTF((sc->sc_dev, "%s: closed\n"));
251 	return (0);
252 }
253 
254 int
255 pushbytes(struct lpt_softc *sc)
256 {
257 	int s, error, spin, tic;
258 
259 	if (sc->sc_flags & LPT_NOINTR) {
260 		while (sc->sc_count > 0) {
261 			spin = 0;
262 			while ((sc->sc_funcs->lf_notrdy) (sc, 0)) {
263 				if (++spin < sc->sc_spinmax)
264 					continue;
265 				tic = 0;
266 				/* adapt busy-wait algorithm */
267 				sc->sc_spinmax++;
268 				while ((sc->sc_funcs->lf_notrdy) (sc, 1)) {
269 					/* exponential backoff */
270 					tic = tic + tic + 1;
271 					if (tic > TIMEOUT)
272 						tic = TIMEOUT;
273 					error = tsleep((void *) sc,
274 					    LPTPRI | PCATCH, "lptpsh", tic);
275 					if (error != EWOULDBLOCK)
276 						return (error);
277 				}
278 				break;
279 			}
280 
281 			(sc->sc_funcs->lf_wrdata) (sc, *sc->sc_cp++);
282 			sc->sc_count--;
283 
284 			/* adapt busy-wait algorithm */
285 			if (spin * 2 + 16 < sc->sc_spinmax)
286 				sc->sc_spinmax--;
287 		}
288 	} else {
289 		while (sc->sc_count > 0) {
290 			/* if the printer is ready for a char, give it one */
291 			if ((sc->sc_state & LPT_OBUSY) == 0) {
292 				LPRINTF((sc->sc_dev, "write %d\n",
293 					sc->sc_count));
294 				s = spltty();
295 				(void) lpt_intr(sc);
296 				splx(s);
297 			}
298 			error = tsleep((void *) sc, LPTPRI | PCATCH,
299 			    "lptwrite2", 0);
300 			if (error)
301 				return (error);
302 		}
303 	}
304 	return (0);
305 }
306 
307 /*
308  * Copy a line from user space to a local buffer, then call putc to get the
309  * chars moved to the output queue.
310  */
311 int
312 lptwrite(dev_t dev, struct uio *uio, int flags)
313 {
314 	struct lpt_softc *sc;
315 	size_t n;
316 	int error;
317 
318 	sc = device_lookup_private(&lpt_cd, LPTUNIT(dev));
319 	error = 0;
320 
321 	while ((n = min(LPT_BSIZE, uio->uio_resid)) != 0) {
322 		uiomove(sc->sc_cp = sc->sc_inbuf->b_data, n, uio);
323 		sc->sc_count = n;
324 		error = pushbytes(sc);
325 		if (error) {
326 			/*
327 			 * Return accurate residual if interrupted or timed
328 			 * out.
329 			 */
330 			uio->uio_resid += sc->sc_count;
331 			sc->sc_count = 0;
332 			return (error);
333 		}
334 	}
335 	return (0);
336 }
337 
338 /*
339  * Handle printer interrupts which occur when the printer is ready to accept
340  * another char.
341  */
342 int
343 lpt_intr(struct lpt_softc *sc)
344 {
345 
346 	if (sc->sc_count) {
347 		/* send char */
348 		(sc->sc_funcs->lf_wrdata) (sc, *sc->sc_cp++);
349 		sc->sc_count--;
350 		sc->sc_state |= LPT_OBUSY;
351 	} else
352 		sc->sc_state &= ~LPT_OBUSY;
353 
354 	if (sc->sc_count == 0) {
355 		/* none, wake up the top half to get more */
356 		wakeup((void *) sc);
357 	}
358 
359 	return (1);
360 }
361 
362 /* ARGSUSED */
363 int
364 lptioctl(dev_t dev, u_long cmd, void *data, int flag, struct lwp *l)
365 {
366 
367 	return (ENODEV);
368 }
369