xref: /freebsd/sys/dev/ppbus/lpt.c (revision 9517e866259191fcd39434a97ad849a9b59b9b9f)
1 /*-
2  * Copyright (c) 1990 William F. Jolitz, TeleMuse
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  * 3. All advertising materials mentioning features or use of this software
14  *    must display the following acknowledgement:
15  *	This software is a component of "386BSD" developed by
16  *	William F. Jolitz, TeleMuse.
17  * 4. Neither the name of the developer nor the name "386BSD"
18  *    may be used to endorse or promote products derived from this software
19  *    without specific prior written permission.
20  *
21  * THIS SOFTWARE IS A COMPONENT OF 386BSD DEVELOPED BY WILLIAM F. JOLITZ
22  * AND IS INTENDED FOR RESEARCH AND EDUCATIONAL PURPOSES ONLY. THIS
23  * SOFTWARE SHOULD NOT BE CONSIDERED TO BE A COMMERCIAL PRODUCT.
24  * THE DEVELOPER URGES THAT USERS WHO REQUIRE A COMMERCIAL PRODUCT
25  * NOT MAKE USE OF THIS WORK.
26  *
27  * FOR USERS WHO WISH TO UNDERSTAND THE 386BSD SYSTEM DEVELOPED
28  * BY WILLIAM F. JOLITZ, WE RECOMMEND THE USER STUDY WRITTEN
29  * REFERENCES SUCH AS THE  "PORTING UNIX TO THE 386" SERIES
30  * (BEGINNING JANUARY 1991 "DR. DOBBS JOURNAL", USA AND BEGINNING
31  * JUNE 1991 "UNIX MAGAZIN", GERMANY) BY WILLIAM F. JOLITZ AND
32  * LYNNE GREER JOLITZ, AS WELL AS OTHER BOOKS ON UNIX AND THE
33  * ON-LINE 386BSD USER MANUAL BEFORE USE. A BOOK DISCUSSING THE INTERNALS
34  * OF 386BSD ENTITLED "386BSD FROM THE INSIDE OUT" WILL BE AVAILABLE LATE 1992.
35  *
36  * THIS SOFTWARE IS PROVIDED BY THE DEVELOPER ``AS IS'' AND
37  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
38  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
39  * ARE DISCLAIMED.  IN NO EVENT SHALL THE DEVELOPER BE LIABLE
40  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
41  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
42  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
43  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
44  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
45  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
46  * SUCH DAMAGE.
47  *
48  *	from: unknown origin, 386BSD 0.1
49  *	From Id: lpt.c,v 1.55.2.1 1996/11/12 09:08:38 phk Exp
50  *	From Id: nlpt.c,v 1.14 1999/02/08 13:55:43 des Exp
51  */
52 
53 #include <sys/cdefs.h>
54 __FBSDID("$FreeBSD$");
55 
56 /*
57  * Device Driver for AT parallel printer port
58  * Written by William Jolitz 12/18/90
59  */
60 
61 /*
62  * Updated for ppbus by Nicolas Souchu
63  * [Mon Jul 28 1997]
64  */
65 
66 #include "opt_lpt.h"
67 
68 #include <sys/param.h>
69 #include <sys/systm.h>
70 #include <sys/module.h>
71 #include <sys/bus.h>
72 #include <sys/conf.h>
73 #include <sys/kernel.h>
74 #include <sys/uio.h>
75 #include <sys/syslog.h>
76 #include <sys/malloc.h>
77 
78 #include <machine/bus.h>
79 #include <machine/resource.h>
80 #include <sys/rman.h>
81 
82 #include <dev/ppbus/lptio.h>
83 #include <dev/ppbus/ppbconf.h>
84 #include <dev/ppbus/ppb_1284.h>
85 #include <dev/ppbus/lpt.h>
86 #include "ppbus_if.h"
87 #include <dev/ppbus/ppbio.h>
88 
89 #ifndef LPT_DEBUG
90 #define	lprintf(args)
91 #else
92 #define	lprintf(args)						\
93 		do {						\
94 			if (lptflag)				\
95 				printf args;			\
96 		} while (0)
97 static int volatile lptflag = 1;
98 #endif
99 
100 #define	LPINITRDY	4	/* wait up to 4 seconds for a ready */
101 #define	LPTOUTINITIAL	10	/* initial timeout to wait for ready 1/10 s */
102 #define	LPTOUTMAX	1	/* maximal timeout 1 s */
103 #define	LPPRI		(PZERO+8)
104 #define	BUFSIZE		1024
105 #define	BUFSTATSIZE	32
106 
107 struct lpt_data {
108 	device_t sc_dev;
109 	struct cdev *sc_cdev;
110 	struct cdev *sc_cdev_bypass;
111 	short	sc_state;
112 	/* default case: negative prime, negative ack, handshake strobe,
113 	   prime once */
114 	u_char	sc_control;
115 	char	sc_flags;
116 #define	LP_POS_INIT	0x04	/* if we are a postive init signal */
117 #define	LP_POS_ACK	0x08	/* if we are a positive going ack */
118 #define	LP_NO_PRIME	0x10	/* don't prime the printer at all */
119 #define	LP_PRIMEOPEN	0x20	/* prime on every open */
120 #define	LP_AUTOLF	0x40	/* tell printer to do an automatic lf */
121 #define	LP_BYPASS	0x80	/* bypass  printer ready checks */
122 	void	*sc_inbuf;
123 	void	*sc_statbuf;
124 	short	sc_xfercnt ;
125 	char	sc_primed;
126 	char	*sc_cp ;
127 	u_short	sc_irq ;	/* IRQ status of port */
128 #define	LP_HAS_IRQ	0x01	/* we have an irq available */
129 #define	LP_USE_IRQ	0x02	/* we are using our irq */
130 #define	LP_ENABLE_IRQ	0x04	/* enable IRQ on open */
131 #define	LP_ENABLE_EXT	0x10	/* we shall use advanced mode when possible */
132 	u_char	sc_backoff ;	/* time to call lptout() again */
133 	struct callout sc_timer;
134 
135 	struct resource *sc_intr_resource;	/* interrupt resource */
136 	void	*sc_intr_cookie;		/* interrupt cookie */
137 };
138 
139 #define	LPT_NAME	"lpt"		/* our official name */
140 
141 static timeout_t lptout;
142 static int	lpt_port_test(device_t dev, u_char data, u_char mask);
143 static int	lpt_detect(device_t dev);
144 
145 #define	DEVTOSOFTC(dev) \
146 	((struct lpt_data *)device_get_softc(dev))
147 
148 static void lptintr(void *arg);
149 
150 static devclass_t lpt_devclass;
151 
152 
153 /* bits for state */
154 #define	OPEN		(1<<0)	/* device is open */
155 #define	ASLP		(1<<1)	/* awaiting draining of printer */
156 #define	EERROR		(1<<2)	/* error was received from printer */
157 #define	OBUSY		(1<<3)	/* printer is busy doing output */
158 #define	LPTOUT		(1<<4)	/* timeout while not selected */
159 #define	TOUT		(1<<5)	/* timeout while not selected */
160 #define	LPTINIT		(1<<6)	/* waiting to initialize for open */
161 #define	INTERRUPTED	(1<<7)	/* write call was interrupted */
162 #define	HAVEBUS		(1<<8)	/* the driver owns the bus */
163 
164 /* status masks to interrogate printer status */
165 #define	RDY_MASK	(LPS_SEL|LPS_OUT|LPS_NBSY|LPS_NERR)	/* ready ? */
166 #define	LP_READY	(LPS_SEL|LPS_NBSY|LPS_NERR)
167 
168 /* Printer Ready condition  - from lpa.c */
169 /* Only used in polling code */
170 #define	LPS_INVERT	(LPS_NBSY | LPS_NACK |           LPS_SEL | LPS_NERR)
171 #define	LPS_MASK	(LPS_NBSY | LPS_NACK | LPS_OUT | LPS_SEL | LPS_NERR)
172 #define	NOT_READY(ppbus) ((ppb_rstr(ppbus)^LPS_INVERT)&LPS_MASK)
173 
174 #define	MAX_SLEEP	(hz*5)	/* Timeout while waiting for device ready */
175 #define	MAX_SPIN	20	/* Max delay for device ready in usecs */
176 
177 
178 static	d_open_t	lptopen;
179 static	d_close_t	lptclose;
180 static	d_write_t	lptwrite;
181 static	d_read_t	lptread;
182 static	d_ioctl_t	lptioctl;
183 
184 static struct cdevsw lpt_cdevsw = {
185 	.d_version =	D_VERSION,
186 	.d_open =	lptopen,
187 	.d_close =	lptclose,
188 	.d_read =	lptread,
189 	.d_write =	lptwrite,
190 	.d_ioctl =	lptioctl,
191 	.d_name =	LPT_NAME,
192 };
193 
194 static int
195 lpt_request_ppbus(device_t dev, int how)
196 {
197 	device_t ppbus = device_get_parent(dev);
198 	struct lpt_data *sc = DEVTOSOFTC(dev);
199 	int error;
200 
201 	/*
202 	 * We might already have the bus for a write(2) after an interrupted
203 	 * write(2) call.
204 	 */
205 	ppb_assert_locked(ppbus);
206 	if (sc->sc_state & HAVEBUS)
207 		return (0);
208 
209 	error = ppb_request_bus(ppbus, dev, how);
210 	if (error == 0)
211 		sc->sc_state |= HAVEBUS;
212 	return (error);
213 }
214 
215 static int
216 lpt_release_ppbus(device_t dev)
217 {
218 	device_t ppbus = device_get_parent(dev);
219 	struct lpt_data *sc = DEVTOSOFTC(dev);
220 	int error = 0;
221 
222 	ppb_assert_locked(ppbus);
223 	if (sc->sc_state & HAVEBUS) {
224 		error = ppb_release_bus(ppbus, dev);
225 		if (error == 0)
226 			sc->sc_state &= ~HAVEBUS;
227 	}
228 	return (error);
229 }
230 
231 /*
232  * Internal routine to lptprobe to do port tests of one byte value
233  */
234 static int
235 lpt_port_test(device_t ppbus, u_char data, u_char mask)
236 {
237 	int	temp, timeout;
238 
239 	data = data & mask;
240 	ppb_wdtr(ppbus, data);
241 	timeout = 10000;
242 	do {
243 		DELAY(10);
244 		temp = ppb_rdtr(ppbus) & mask;
245 	}
246 	while (temp != data && --timeout);
247 	lprintf(("out=%x\tin=%x\ttout=%d\n", data, temp, timeout));
248 	return (temp == data);
249 }
250 
251 /*
252  * Probe simplified by replacing multiple loops with a hardcoded
253  * test pattern - 1999/02/08 des@freebsd.org
254  *
255  * New lpt port probe Geoff Rehmet - Rhodes University - 14/2/94
256  * Based partially on Rod Grimes' printer probe
257  *
258  * Logic:
259  *	1) If no port address was given, use the bios detected ports
260  *	   and autodetect what ports the printers are on.
261  *	2) Otherwise, probe the data port at the address given,
262  *	   using the method in Rod Grimes' port probe.
263  *	   (Much code ripped off directly from Rod's probe.)
264  *
265  * Comments from Rod's probe:
266  * Logic:
267  *	1) You should be able to write to and read back the same value
268  *	   to the data port.  Do an alternating zeros, alternating ones,
269  *	   walking zero, and walking one test to check for stuck bits.
270  *
271  *	2) You should be able to write to and read back the same value
272  *	   to the control port lower 5 bits, the upper 3 bits are reserved
273  *	   per the IBM PC technical reference manauls and different boards
274  *	   do different things with them.  Do an alternating zeros, alternating
275  *	   ones, walking zero, and walking one test to check for stuck bits.
276  *
277  *	   Some printers drag the strobe line down when the are powered off
278  * 	   so this bit has been masked out of the control port test.
279  *
280  *	   XXX Some printers may not like a fast pulse on init or strobe, I
281  *	   don't know at this point, if that becomes a problem these bits
282  *	   should be turned off in the mask byte for the control port test.
283  *
284  *	   We are finally left with a mask of 0x14, due to some printers
285  *	   being adamant about holding other bits high ........
286  *
287  *	   Before probing the control port, we write a 0 to the data port -
288  *	   If not, some printers chuck out garbage when the strobe line
289  *	   gets toggled.
290  *
291  *	3) Set the data and control ports to a value of 0
292  *
293  *	This probe routine has been tested on Epson Lx-800, HP LJ3P,
294  *	Epson FX-1170 and C.Itoh 8510RM
295  *	printers.
296  *	Quick exit on fail added.
297  */
298 static int
299 lpt_detect(device_t dev)
300 {
301 	device_t ppbus = device_get_parent(dev);
302 
303 	static u_char	testbyte[18] = {
304 		0x55,			/* alternating zeros */
305 		0xaa,			/* alternating ones */
306 		0xfe, 0xfd, 0xfb, 0xf7,
307 		0xef, 0xdf, 0xbf, 0x7f,	/* walking zero */
308 		0x01, 0x02, 0x04, 0x08,
309 		0x10, 0x20, 0x40, 0x80	/* walking one */
310 	};
311 	int		i, error, status;
312 
313 	status = 1;				/* assume success */
314 
315 	ppb_lock(ppbus);
316 	if ((error = lpt_request_ppbus(dev, PPB_DONTWAIT))) {
317 		ppb_unlock(ppbus);
318 		device_printf(dev, "cannot alloc ppbus (%d)!\n", error);
319 		return (0);
320 	}
321 
322 	for (i = 0; i < 18 && status; i++)
323 		if (!lpt_port_test(ppbus, testbyte[i], 0xff)) {
324 			status = 0;
325 			break;
326 		}
327 
328 	/* write 0's to control and data ports */
329 	ppb_wdtr(ppbus, 0);
330 	ppb_wctr(ppbus, 0);
331 
332 	lpt_release_ppbus(dev);
333 	ppb_unlock(ppbus);
334 
335 	return (status);
336 }
337 
338 static void
339 lpt_identify(driver_t *driver, device_t parent)
340 {
341 
342 	device_t dev;
343 
344 	dev = device_find_child(parent, LPT_NAME, -1);
345 	if (!dev)
346 		BUS_ADD_CHILD(parent, 0, LPT_NAME, -1);
347 }
348 
349 /*
350  * lpt_probe()
351  */
352 static int
353 lpt_probe(device_t dev)
354 {
355 
356 	if (!lpt_detect(dev))
357 		return (ENXIO);
358 
359 	device_set_desc(dev, "Printer");
360 
361 	return (0);
362 }
363 
364 static int
365 lpt_attach(device_t dev)
366 {
367 	device_t ppbus = device_get_parent(dev);
368 	struct lpt_data *sc = DEVTOSOFTC(dev);
369 	int rid = 0, unit = device_get_unit(dev);
370 	int error;
371 
372 	sc->sc_primed = 0;	/* not primed yet */
373 	ppb_init_callout(ppbus, &sc->sc_timer, 0);
374 
375 	ppb_lock(ppbus);
376 	if ((error = lpt_request_ppbus(dev, PPB_DONTWAIT))) {
377 		ppb_unlock(ppbus);
378 		device_printf(dev, "cannot alloc ppbus (%d)!\n", error);
379 		return (0);
380 	}
381 
382 	ppb_wctr(ppbus, LPC_NINIT);
383 	lpt_release_ppbus(dev);
384 	ppb_unlock(ppbus);
385 
386 	/* declare our interrupt handler */
387 	sc->sc_intr_resource = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
388 	    RF_SHAREABLE);
389 	if (sc->sc_intr_resource) {
390 		error = bus_setup_intr(dev, sc->sc_intr_resource,
391 		    INTR_TYPE_TTY | INTR_MPSAFE, NULL, lptintr, sc,
392 		    &sc->sc_intr_cookie);
393 		if (error) {
394 			bus_release_resource(dev, SYS_RES_IRQ, rid,
395 			    sc->sc_intr_resource);
396 			device_printf(dev,
397 			    "Unable to register interrupt handler\n");
398 			return (error);
399 		}
400 		sc->sc_irq = LP_HAS_IRQ | LP_USE_IRQ | LP_ENABLE_IRQ;
401 		device_printf(dev, "Interrupt-driven port\n");
402 	} else {
403 		sc->sc_irq = 0;
404 		device_printf(dev, "Polled port\n");
405 	}
406 	lprintf(("irq %x\n", sc->sc_irq));
407 
408 	sc->sc_inbuf = malloc(BUFSIZE, M_DEVBUF, M_WAITOK);
409 	sc->sc_statbuf = malloc(BUFSTATSIZE, M_DEVBUF, M_WAITOK);
410 	sc->sc_dev = dev;
411 	sc->sc_cdev = make_dev(&lpt_cdevsw, unit,
412 	    UID_ROOT, GID_WHEEL, 0600, LPT_NAME "%d", unit);
413 	sc->sc_cdev->si_drv1 = sc;
414 	sc->sc_cdev->si_drv2 = 0;
415 	sc->sc_cdev_bypass = make_dev(&lpt_cdevsw, unit,
416 	    UID_ROOT, GID_WHEEL, 0600, LPT_NAME "%d.ctl", unit);
417 	sc->sc_cdev_bypass->si_drv1 = sc;
418 	sc->sc_cdev_bypass->si_drv2 = (void *)LP_BYPASS;
419 	return (0);
420 }
421 
422 static int
423 lpt_detach(device_t dev)
424 {
425 	struct lpt_data *sc = DEVTOSOFTC(dev);
426 	device_t ppbus = device_get_parent(dev);
427 
428 	destroy_dev(sc->sc_cdev);
429 	destroy_dev(sc->sc_cdev_bypass);
430 	ppb_lock(ppbus);
431 	lpt_release_ppbus(dev);
432 	ppb_unlock(ppbus);
433 	callout_drain(&sc->sc_timer);
434 	if (sc->sc_intr_resource != NULL) {
435 		bus_teardown_intr(dev, sc->sc_intr_resource,
436 		    sc->sc_intr_cookie);
437 		bus_release_resource(dev, SYS_RES_IRQ, 0, sc->sc_intr_resource);
438 	}
439 	free(sc->sc_inbuf, M_DEVBUF);
440 	free(sc->sc_statbuf, M_DEVBUF);
441 
442 	return (0);
443 }
444 
445 static void
446 lptout(void *arg)
447 {
448 	struct lpt_data *sc = arg;
449 	device_t dev = sc->sc_dev;
450 #if defined(INVARIANTS) || defined(LPT_DEBUG)
451 	device_t ppbus = device_get_parent(dev);
452 #endif
453 
454 	ppb_assert_locked(ppbus);
455 	lprintf(("T %x ", ppb_rstr(ppbus)));
456 	if (sc->sc_state & OPEN) {
457 		sc->sc_backoff++;
458 		if (sc->sc_backoff > hz/LPTOUTMAX)
459 			sc->sc_backoff = sc->sc_backoff > hz/LPTOUTMAX;
460 		callout_reset(&sc->sc_timer, sc->sc_backoff, lptout, sc);
461 	} else
462 		sc->sc_state &= ~TOUT;
463 
464 	if (sc->sc_state & EERROR)
465 		sc->sc_state &= ~EERROR;
466 
467 	/*
468 	 * Avoid possible hangs due to missed interrupts
469 	 */
470 	if (sc->sc_xfercnt) {
471 		lptintr(sc);
472 	} else {
473 		sc->sc_state &= ~OBUSY;
474 		wakeup(dev);
475 	}
476 }
477 
478 /*
479  * lptopen -- reset the printer, then wait until it's selected and not busy.
480  *	If LP_BYPASS flag is selected, then we do not try to select the
481  *	printer -- this is just used for passing ioctls.
482  */
483 
484 static	int
485 lptopen(struct cdev *dev, int flags, int fmt, struct thread *td)
486 {
487 	int trys, err;
488 	struct lpt_data *sc = dev->si_drv1;
489 	device_t lptdev = sc->sc_dev;
490 	device_t ppbus = device_get_parent(lptdev);
491 
492 	if (!sc)
493 		return (ENXIO);
494 
495 	ppb_lock(ppbus);
496 	if (sc->sc_state) {
497 		lprintf(("%s: still open %x\n", device_get_nameunit(lptdev),
498 		    sc->sc_state));
499 		ppb_unlock(ppbus);
500 		return(EBUSY);
501 	} else
502 		sc->sc_state |= LPTINIT;
503 
504 	sc->sc_flags = (uintptr_t)dev->si_drv2;
505 
506 	/* Check for open with BYPASS flag set. */
507 	if (sc->sc_flags & LP_BYPASS) {
508 		sc->sc_state = OPEN;
509 		ppb_unlock(ppbus);
510 		return(0);
511 	}
512 
513 	/* request the ppbus only if we don't have it already */
514 	if ((err = lpt_request_ppbus(lptdev, PPB_WAIT|PPB_INTR)) != 0) {
515 		/* give it a chance to try later */
516 		sc->sc_state = 0;
517 		ppb_unlock(ppbus);
518 		return (err);
519 	}
520 
521 	lprintf(("%s flags 0x%x\n", device_get_nameunit(lptdev),
522 	    sc->sc_flags));
523 
524 	/* set IRQ status according to ENABLE_IRQ flag
525 	 */
526 	if (sc->sc_irq & LP_ENABLE_IRQ)
527 		sc->sc_irq |= LP_USE_IRQ;
528 	else
529 		sc->sc_irq &= ~LP_USE_IRQ;
530 
531 	/* init printer */
532 	if ((sc->sc_flags & LP_NO_PRIME) == 0) {
533 		if ((sc->sc_flags & LP_PRIMEOPEN) || sc->sc_primed == 0) {
534 			ppb_wctr(ppbus, 0);
535 			sc->sc_primed++;
536 			DELAY(500);
537 		}
538 	}
539 
540 	ppb_wctr(ppbus, LPC_SEL|LPC_NINIT);
541 
542 	/* wait till ready (printer running diagnostics) */
543 	trys = 0;
544 	do {
545 		/* ran out of waiting for the printer */
546 		if (trys++ >= LPINITRDY*4) {
547 			lprintf(("status %x\n", ppb_rstr(ppbus)));
548 
549 			lpt_release_ppbus(lptdev);
550 			sc->sc_state = 0;
551 			ppb_unlock(ppbus);
552 			return (EBUSY);
553 		}
554 
555 		/* wait 1/4 second, give up if we get a signal */
556 		if (ppb_sleep(ppbus, lptdev, LPPRI | PCATCH, "lptinit",
557 		    hz / 4) != EWOULDBLOCK) {
558 			lpt_release_ppbus(lptdev);
559 			sc->sc_state = 0;
560 			ppb_unlock(ppbus);
561 			return (EBUSY);
562 		}
563 
564 		/* is printer online and ready for output */
565 	} while ((ppb_rstr(ppbus) &
566 			(LPS_SEL|LPS_OUT|LPS_NBSY|LPS_NERR)) !=
567 					(LPS_SEL|LPS_NBSY|LPS_NERR));
568 
569 	sc->sc_control = LPC_SEL|LPC_NINIT;
570 	if (sc->sc_flags & LP_AUTOLF)
571 		sc->sc_control |= LPC_AUTOL;
572 
573 	/* enable interrupt if interrupt-driven */
574 	if (sc->sc_irq & LP_USE_IRQ)
575 		sc->sc_control |= LPC_ENA;
576 
577 	ppb_wctr(ppbus, sc->sc_control);
578 
579 	sc->sc_state &= ~LPTINIT;
580 	sc->sc_state |= OPEN;
581 	sc->sc_xfercnt = 0;
582 
583 	/* only use timeout if using interrupt */
584 	lprintf(("irq %x\n", sc->sc_irq));
585 	if (sc->sc_irq & LP_USE_IRQ) {
586 		sc->sc_state |= TOUT;
587 		sc->sc_backoff = hz / LPTOUTINITIAL;
588 		callout_reset(&sc->sc_timer, sc->sc_backoff, lptout, sc);
589 	}
590 
591 	/* release the ppbus */
592 	lpt_release_ppbus(lptdev);
593 	ppb_unlock(ppbus);
594 
595 	lprintf(("opened.\n"));
596 	return(0);
597 }
598 
599 /*
600  * lptclose -- close the device, free the local line buffer.
601  *
602  * Check for interrupted write call added.
603  */
604 
605 static	int
606 lptclose(struct cdev *dev, int flags, int fmt, struct thread *td)
607 {
608 	struct lpt_data *sc = dev->si_drv1;
609 	device_t lptdev = sc->sc_dev;
610 	device_t ppbus = device_get_parent(lptdev);
611 	int err;
612 
613 	ppb_lock(ppbus);
614 	if (sc->sc_flags & LP_BYPASS)
615 		goto end_close;
616 
617 	if ((err = lpt_request_ppbus(lptdev, PPB_WAIT|PPB_INTR)) != 0) {
618 		ppb_unlock(ppbus);
619 		return (err);
620 	}
621 
622 	/* if the last write was interrupted, don't complete it */
623 	if ((!(sc->sc_state  & INTERRUPTED)) && (sc->sc_irq & LP_USE_IRQ))
624 		while ((ppb_rstr(ppbus) &
625 			(LPS_SEL|LPS_OUT|LPS_NBSY|LPS_NERR)) !=
626 			(LPS_SEL|LPS_NBSY|LPS_NERR) || sc->sc_xfercnt)
627 			/* wait 1/4 second, give up if we get a signal */
628 			if (ppb_sleep(ppbus, lptdev, LPPRI | PCATCH, "lpclose",
629 			    hz) != EWOULDBLOCK)
630 				break;
631 
632 	sc->sc_state &= ~OPEN;
633 	callout_stop(&sc->sc_timer);
634 	ppb_wctr(ppbus, LPC_NINIT);
635 
636 	/*
637 	 * unregistration of interrupt forced by release
638 	 */
639 	lpt_release_ppbus(lptdev);
640 
641 end_close:
642 	sc->sc_state = 0;
643 	sc->sc_xfercnt = 0;
644 	ppb_unlock(ppbus);
645 	lprintf(("closed.\n"));
646 	return(0);
647 }
648 
649 /*
650  * lpt_pushbytes()
651  *	Workhorse for actually spinning and writing bytes to printer
652  *	Derived from lpa.c
653  *	Originally by ?
654  *
655  *	This code is only used when we are polling the port
656  */
657 static int
658 lpt_pushbytes(struct lpt_data *sc)
659 {
660 	device_t dev = sc->sc_dev;
661 	device_t ppbus = device_get_parent(dev);
662 	int spin, err, tic;
663 	char ch;
664 
665 	ppb_assert_locked(ppbus);
666 	lprintf(("p"));
667 	/* loop for every character .. */
668 	while (sc->sc_xfercnt > 0) {
669 		/* printer data */
670 		ch = *(sc->sc_cp);
671 		sc->sc_cp++;
672 		sc->sc_xfercnt--;
673 
674 		/*
675 		 * Wait for printer ready.
676 		 * Loop 20 usecs testing BUSY bit, then sleep
677 		 * for exponentially increasing timeout. (vak)
678 		 */
679 		for (spin = 0; NOT_READY(ppbus) && spin < MAX_SPIN; ++spin)
680 			DELAY(1);	/* XXX delay is NOT this accurate! */
681 		if (spin >= MAX_SPIN) {
682 			tic = 0;
683 			while (NOT_READY(ppbus)) {
684 				/*
685 				 * Now sleep, every cycle a
686 				 * little longer ..
687 				 */
688 				tic = tic + tic + 1;
689 				/*
690 				 * But no more than 10 seconds. (vak)
691 				 */
692 				if (tic > MAX_SLEEP)
693 					tic = MAX_SLEEP;
694 				err = ppb_sleep(ppbus, dev, LPPRI,
695 					LPT_NAME "poll", tic);
696 				if (err != EWOULDBLOCK) {
697 					return (err);
698 				}
699 			}
700 		}
701 
702 		/* output data */
703 		ppb_wdtr(ppbus, ch);
704 		/* strobe */
705 		ppb_wctr(ppbus, sc->sc_control|LPC_STB);
706 		ppb_wctr(ppbus, sc->sc_control);
707 
708 	}
709 	return(0);
710 }
711 
712 /*
713  * lptread --retrieve printer status in IEEE1284 NIBBLE mode
714  */
715 
716 static int
717 lptread(struct cdev *dev, struct uio *uio, int ioflag)
718 {
719 	struct lpt_data *sc = dev->si_drv1;
720 	device_t lptdev = sc->sc_dev;
721 	device_t ppbus = device_get_parent(lptdev);
722 	int error = 0, len;
723 
724 	if (sc->sc_flags & LP_BYPASS) {
725 		/* we can't do reads in bypass mode */
726 		return (EPERM);
727 	}
728 
729 	ppb_lock(ppbus);
730 	if ((error = ppb_1284_negociate(ppbus, PPB_NIBBLE, 0))) {
731 		ppb_unlock(ppbus);
732 		return (error);
733 	}
734 
735 	/* read data in an other buffer, read/write may be simultaneous */
736 	len = 0;
737 	while (uio->uio_resid) {
738 		if ((error = ppb_1284_read(ppbus, PPB_NIBBLE,
739 				sc->sc_statbuf, min(BUFSTATSIZE,
740 				uio->uio_resid), &len))) {
741 			goto error;
742 		}
743 
744 		if (!len)
745 			goto error;		/* no more data */
746 
747 		ppb_unlock(ppbus);
748 		error = uiomove(sc->sc_statbuf, len, uio);
749 		ppb_lock(ppbus);
750 		if (error)
751 			goto error;
752 	}
753 
754 error:
755 	ppb_1284_terminate(ppbus);
756 	ppb_unlock(ppbus);
757 	return (error);
758 }
759 
760 /*
761  * lptwrite --copy a line from user space to a local buffer, then call
762  * putc to get the chars moved to the output queue.
763  *
764  * Flagging of interrupted write added.
765  */
766 
767 static	int
768 lptwrite(struct cdev *dev, struct uio *uio, int ioflag)
769 {
770 	register unsigned n;
771 	int err;
772 	struct lpt_data *sc = dev->si_drv1;
773 	device_t lptdev = sc->sc_dev;
774 	device_t ppbus = device_get_parent(lptdev);
775 
776 	if (sc->sc_flags & LP_BYPASS) {
777 		/* we can't do writes in bypass mode */
778 		return (EPERM);
779 	}
780 
781 	/* request the ppbus only if we don't have it already */
782 	ppb_lock(ppbus);
783 	if ((err = lpt_request_ppbus(lptdev, PPB_WAIT|PPB_INTR)) != 0) {
784 		ppb_unlock(ppbus);
785 		return (err);
786 	}
787 
788 	sc->sc_state &= ~INTERRUPTED;
789 	while ((n = min(BUFSIZE, uio->uio_resid)) != 0) {
790 		sc->sc_cp = sc->sc_inbuf;
791 		ppb_unlock(ppbus);
792 		err = uiomove(sc->sc_cp, n, uio);
793 		ppb_lock(ppbus);
794 		if (err)
795 			break;
796 		sc->sc_xfercnt = n;
797 
798 		if (sc->sc_irq & LP_ENABLE_EXT) {
799 			/* try any extended mode */
800 			err = ppb_write(ppbus, sc->sc_cp,
801 					sc->sc_xfercnt, 0);
802 			switch (err) {
803 			case 0:
804 				/* if not all data was sent, we could rely
805 				 * on polling for the last bytes */
806 				sc->sc_xfercnt = 0;
807 				break;
808 			case EINTR:
809 				sc->sc_state |= INTERRUPTED;
810 				ppb_unlock(ppbus);
811 				return (err);
812 			case EINVAL:
813 				/* advanced mode not avail */
814 				log(LOG_NOTICE,
815 				    "%s: advanced mode not avail, polling\n",
816 				    device_get_nameunit(sc->sc_dev));
817 				break;
818 			default:
819 				ppb_unlock(ppbus);
820 				return (err);
821 			}
822 		} else while ((sc->sc_xfercnt > 0)&&(sc->sc_irq & LP_USE_IRQ)) {
823 			lprintf(("i"));
824 			/* if the printer is ready for a char, */
825 			/* give it one */
826 			if ((sc->sc_state & OBUSY) == 0){
827 				lprintf(("\nC %d. ", sc->sc_xfercnt));
828 				lptintr(sc);
829 			}
830 			lprintf(("W "));
831 			if (sc->sc_state & OBUSY)
832 				if ((err = ppb_sleep(ppbus, lptdev,
833 					 LPPRI|PCATCH, LPT_NAME "write", 0))) {
834 					sc->sc_state |= INTERRUPTED;
835 					ppb_unlock(ppbus);
836 					return(err);
837 				}
838 		}
839 
840 		/* check to see if we must do a polled write */
841 		if (!(sc->sc_irq & LP_USE_IRQ) && (sc->sc_xfercnt)) {
842 			lprintf(("p"));
843 
844 			err = lpt_pushbytes(sc);
845 
846 			if (err) {
847 				ppb_unlock(ppbus);
848 				return (err);
849 			}
850 		}
851 	}
852 
853 	/* we have not been interrupted, release the ppbus */
854 	lpt_release_ppbus(lptdev);
855 	ppb_unlock(ppbus);
856 
857 	return (err);
858 }
859 
860 /*
861  * lptintr -- handle printer interrupts which occur when the printer is
862  * ready to accept another char.
863  *
864  * do checking for interrupted write call.
865  */
866 static void
867 lptintr(void *arg)
868 {
869 	struct lpt_data *sc = arg;
870 	device_t lptdev = sc->sc_dev;
871 	device_t ppbus = device_get_parent(lptdev);
872 	int sts = 0;
873 	int i;
874 
875 	/*
876 	 * Is printer online and ready for output?
877 	 *
878 	 * Avoid falling back to lptout() too quickly.  First spin-loop
879 	 * to see if the printer will become ready ``really soon now''.
880 	 */
881 	for (i = 0; i < 100 &&
882 	     ((sts=ppb_rstr(ppbus)) & RDY_MASK) != LP_READY; i++) ;
883 
884 	if ((sts & RDY_MASK) == LP_READY) {
885 		sc->sc_state = (sc->sc_state | OBUSY) & ~EERROR;
886 		sc->sc_backoff = hz / LPTOUTINITIAL;
887 
888 		if (sc->sc_xfercnt) {
889 			/* send char */
890 			/*lprintf(("%x ", *sc->sc_cp)); */
891 			ppb_wdtr(ppbus, *sc->sc_cp++) ;
892 			ppb_wctr(ppbus, sc->sc_control|LPC_STB);
893 			/* DELAY(X) */
894 			ppb_wctr(ppbus, sc->sc_control);
895 
896 			/* any more data for printer */
897 			if (--(sc->sc_xfercnt) > 0)
898 				return;
899 		}
900 
901 		/*
902 		 * No more data waiting for printer.
903 		 * Wakeup is not done if write call was not interrupted.
904 		 */
905 		sc->sc_state &= ~OBUSY;
906 
907 		if (!(sc->sc_state & INTERRUPTED))
908 			wakeup(lptdev);
909 		lprintf(("w "));
910 		return;
911 	} else	{	/* check for error */
912 		if (((sts & (LPS_NERR | LPS_OUT) ) != LPS_NERR) &&
913 				(sc->sc_state & OPEN))
914 			sc->sc_state |= EERROR;
915 		/* lptout() will jump in and try to restart. */
916 	}
917 	lprintf(("sts %x ", sts));
918 }
919 
920 static	int
921 lptioctl(struct cdev *dev, u_long cmd, caddr_t data, int flags, struct thread *td)
922 {
923 	int	error = 0;
924 	struct lpt_data *sc = dev->si_drv1;
925 	device_t ppbus;
926 	u_char	old_sc_irq;	/* old printer IRQ status */
927 
928 	switch (cmd) {
929 	case LPT_IRQ :
930 		ppbus = device_get_parent(sc->sc_dev);
931 		ppb_lock(ppbus);
932 		if (sc->sc_irq & LP_HAS_IRQ) {
933 			/*
934 			 * NOTE:
935 			 * If the IRQ status is changed,
936 			 * this will only be visible on the
937 			 * next open.
938 			 *
939 			 * If interrupt status changes,
940 			 * this gets syslog'd.
941 			 */
942 			old_sc_irq = sc->sc_irq;
943 			switch (*(int*)data) {
944 			case 0:
945 				sc->sc_irq &= (~LP_ENABLE_IRQ);
946 				break;
947 			case 1:
948 				sc->sc_irq &= (~LP_ENABLE_EXT);
949 				sc->sc_irq |= LP_ENABLE_IRQ;
950 				break;
951 			case 2:
952 				/* classic irq based transfer and advanced
953 				 * modes are in conflict
954 				 */
955 				sc->sc_irq &= (~LP_ENABLE_IRQ);
956 				sc->sc_irq |= LP_ENABLE_EXT;
957 				break;
958 			case 3:
959 				sc->sc_irq &= (~LP_ENABLE_EXT);
960 				break;
961 			default:
962 				break;
963 			}
964 
965 			if (old_sc_irq != sc->sc_irq )
966 				log(LOG_NOTICE, "%s: switched to %s %s mode\n",
967 					device_get_nameunit(sc->sc_dev),
968 					(sc->sc_irq & LP_ENABLE_IRQ)?
969 					"interrupt-driven":"polled",
970 					(sc->sc_irq & LP_ENABLE_EXT)?
971 					"extended":"standard");
972 		} else /* polled port */
973 			error = EOPNOTSUPP;
974 		ppb_unlock(ppbus);
975 		break;
976 	default:
977 		error = ENODEV;
978 	}
979 
980 	return(error);
981 }
982 
983 static device_method_t lpt_methods[] = {
984 	/* device interface */
985 	DEVMETHOD(device_identify,	lpt_identify),
986 	DEVMETHOD(device_probe,		lpt_probe),
987 	DEVMETHOD(device_attach,	lpt_attach),
988 	DEVMETHOD(device_detach,	lpt_detach),
989 
990 	{ 0, 0 }
991 };
992 
993 static driver_t lpt_driver = {
994 	LPT_NAME,
995 	lpt_methods,
996 	sizeof(struct lpt_data),
997 };
998 
999 DRIVER_MODULE(lpt, ppbus, lpt_driver, lpt_devclass, 0, 0);
1000 MODULE_DEPEND(lpt, ppbus, 1, 1, 1);
1001