lpt.c revision 183397
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: head/sys/dev/ppbus/lpt.c 183397 2008-09-27 08:51:18Z ed $");
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)
97static 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#define	LPTUNIT(s)	((s)&0x03)
108#define	LPTFLAGS(s)	((s)&0xfc)
109
110struct lpt_data {
111
112	short	sc_state;
113	/* default case: negative prime, negative ack, handshake strobe,
114	   prime once */
115	u_char	sc_control;
116	char	sc_flags;
117#define LP_POS_INIT	0x04	/* if we are a postive init signal */
118#define LP_POS_ACK	0x08	/* if we are a positive going ack */
119#define LP_NO_PRIME	0x10	/* don't prime the printer at all */
120#define LP_PRIMEOPEN	0x20	/* prime on every open */
121#define LP_AUTOLF	0x40	/* tell printer to do an automatic lf */
122#define LP_BYPASS	0x80	/* bypass  printer ready checks */
123	void	*sc_inbuf;
124	void	*sc_statbuf;
125	short	sc_xfercnt ;
126	char	sc_primed;
127	char	*sc_cp ;
128	u_short	sc_irq ;	/* IRQ status of port */
129#define LP_HAS_IRQ	0x01	/* we have an irq available */
130#define LP_USE_IRQ	0x02	/* we are using our irq */
131#define LP_ENABLE_IRQ	0x04	/* enable IRQ on open */
132#define LP_ENABLE_EXT	0x10	/* we shall use advanced mode when possible */
133	u_char	sc_backoff ;	/* time to call lptout() again */
134
135	struct resource *intr_resource;	/* interrupt resource */
136	void *intr_cookie;		/* interrupt registration cookie */
137
138};
139
140#define LPT_NAME	"lpt"		/* our official name */
141
142static timeout_t lptout;
143static int	lpt_port_test(device_t dev, u_char data, u_char mask);
144static int	lpt_detect(device_t dev);
145
146#define DEVTOSOFTC(dev) \
147	((struct lpt_data *)device_get_softc(dev))
148#define UNITOSOFTC(unit) \
149	((struct lpt_data *)devclass_get_softc(lpt_devclass, (unit)))
150#define UNITODEVICE(unit) \
151	(devclass_get_device(lpt_devclass, (unit)))
152
153static void lptintr(device_t dev);
154static void lpt_intr(void *arg);	/* without spls */
155
156static devclass_t lpt_devclass;
157
158
159/* bits for state */
160#define	OPEN		(1<<0)	/* device is open */
161#define	ASLP		(1<<1)	/* awaiting draining of printer */
162#define	EERROR		(1<<2)	/* error was received from printer */
163#define	OBUSY		(1<<3)	/* printer is busy doing output */
164#define LPTOUT		(1<<4)	/* timeout while not selected */
165#define TOUT		(1<<5)	/* timeout while not selected */
166#define LPTINIT		(1<<6)	/* waiting to initialize for open */
167#define INTERRUPTED	(1<<7)	/* write call was interrupted */
168
169#define HAVEBUS		(1<<8)	/* the driver owns the bus */
170
171
172/* status masks to interrogate printer status */
173#define RDY_MASK	(LPS_SEL|LPS_OUT|LPS_NBSY|LPS_NERR)	/* ready ? */
174#define LP_READY	(LPS_SEL|LPS_NBSY|LPS_NERR)
175
176/* Printer Ready condition  - from lpa.c */
177/* Only used in polling code */
178#define	LPS_INVERT	(LPS_NBSY | LPS_NACK |           LPS_SEL | LPS_NERR)
179#define	LPS_MASK	(LPS_NBSY | LPS_NACK | LPS_OUT | LPS_SEL | LPS_NERR)
180#define	NOT_READY(ppbus) ((ppb_rstr(ppbus)^LPS_INVERT)&LPS_MASK)
181
182#define	MAX_SLEEP	(hz*5)	/* Timeout while waiting for device ready */
183#define	MAX_SPIN	20	/* Max delay for device ready in usecs */
184
185
186static	d_open_t	lptopen;
187static	d_close_t	lptclose;
188static	d_write_t	lptwrite;
189static	d_read_t	lptread;
190static	d_ioctl_t	lptioctl;
191
192static struct cdevsw lpt_cdevsw = {
193	.d_version =	D_VERSION,
194	.d_flags =	D_NEEDGIANT,
195	.d_open =	lptopen,
196	.d_close =	lptclose,
197	.d_read =	lptread,
198	.d_write =	lptwrite,
199	.d_ioctl =	lptioctl,
200	.d_name =	LPT_NAME,
201};
202
203static int
204lpt_request_ppbus(device_t dev, int how)
205{
206	device_t ppbus = device_get_parent(dev);
207	struct lpt_data *sc = DEVTOSOFTC(dev);
208	int error;
209
210	if (sc->sc_state & HAVEBUS)
211		return (0);
212
213	/* we have the bus only if the request succeded */
214	if ((error = ppb_request_bus(ppbus, dev, how)) == 0)
215		sc->sc_state |= HAVEBUS;
216
217	return (error);
218}
219
220static int
221lpt_release_ppbus(device_t dev)
222{
223	device_t ppbus = device_get_parent(dev);
224	struct lpt_data *sc = DEVTOSOFTC(dev);
225	int error = 0;
226
227	if ((error = ppb_release_bus(ppbus, dev)) == 0)
228		sc->sc_state &= ~HAVEBUS;
229
230	return (error);
231}
232
233/*
234 * Internal routine to lptprobe to do port tests of one byte value
235 */
236static int
237lpt_port_test(device_t ppbus, u_char data, u_char mask)
238{
239	int	temp, timeout;
240
241	data = data & mask;
242	ppb_wdtr(ppbus, data);
243	timeout = 10000;
244	do {
245		DELAY(10);
246		temp = ppb_rdtr(ppbus) & mask;
247	}
248	while (temp != data && --timeout);
249	lprintf(("out=%x\tin=%x\ttout=%d\n", data, temp, timeout));
250	return (temp == data);
251}
252
253/*
254 * Probe simplified by replacing multiple loops with a hardcoded
255 * test pattern - 1999/02/08 des@freebsd.org
256 *
257 * New lpt port probe Geoff Rehmet - Rhodes University - 14/2/94
258 * Based partially on Rod Grimes' printer probe
259 *
260 * Logic:
261 *	1) If no port address was given, use the bios detected ports
262 *	   and autodetect what ports the printers are on.
263 *	2) Otherwise, probe the data port at the address given,
264 *	   using the method in Rod Grimes' port probe.
265 *	   (Much code ripped off directly from Rod's probe.)
266 *
267 * Comments from Rod's probe:
268 * Logic:
269 *	1) You should be able to write to and read back the same value
270 *	   to the data port.  Do an alternating zeros, alternating ones,
271 *	   walking zero, and walking one test to check for stuck bits.
272 *
273 *	2) You should be able to write to and read back the same value
274 *	   to the control port lower 5 bits, the upper 3 bits are reserved
275 *	   per the IBM PC technical reference manauls and different boards
276 *	   do different things with them.  Do an alternating zeros, alternating
277 *	   ones, walking zero, and walking one test to check for stuck bits.
278 *
279 *	   Some printers drag the strobe line down when the are powered off
280 * 	   so this bit has been masked out of the control port test.
281 *
282 *	   XXX Some printers may not like a fast pulse on init or strobe, I
283 *	   don't know at this point, if that becomes a problem these bits
284 *	   should be turned off in the mask byte for the control port test.
285 *
286 *	   We are finally left with a mask of 0x14, due to some printers
287 *	   being adamant about holding other bits high ........
288 *
289 *	   Before probing the control port, we write a 0 to the data port -
290 *	   If not, some printers chuck out garbage when the strobe line
291 *	   gets toggled.
292 *
293 *	3) Set the data and control ports to a value of 0
294 *
295 *	This probe routine has been tested on Epson Lx-800, HP LJ3P,
296 *	Epson FX-1170 and C.Itoh 8510RM
297 *	printers.
298 *	Quick exit on fail added.
299 */
300static int
301lpt_detect(device_t dev)
302{
303	device_t ppbus = device_get_parent(dev);
304
305	static u_char	testbyte[18] = {
306		0x55,			/* alternating zeros */
307		0xaa,			/* alternating ones */
308		0xfe, 0xfd, 0xfb, 0xf7,
309		0xef, 0xdf, 0xbf, 0x7f,	/* walking zero */
310		0x01, 0x02, 0x04, 0x08,
311		0x10, 0x20, 0x40, 0x80	/* walking one */
312	};
313	int		i, error, status;
314
315	status = 1;				/* assume success */
316
317	if ((error = lpt_request_ppbus(dev, PPB_DONTWAIT))) {
318		printf(LPT_NAME ": cannot alloc ppbus (%d)!\n", error);
319		status = 0;
320		goto end_probe;
321	}
322
323	for (i = 0; i < 18 && status; i++)
324		if (!lpt_port_test(ppbus, testbyte[i], 0xff)) {
325			status = 0;
326			goto end_probe;
327		}
328
329end_probe:
330	/* write 0's to control and data ports */
331	ppb_wdtr(ppbus, 0);
332	ppb_wctr(ppbus, 0);
333
334	lpt_release_ppbus(dev);
335
336	return (status);
337}
338
339static void
340lpt_identify(driver_t *driver, device_t parent)
341{
342
343	device_t dev;
344
345	dev = device_find_child(parent, LPT_NAME, -1);
346	if (!dev)
347		BUS_ADD_CHILD(parent, 0, LPT_NAME, -1);
348}
349
350/*
351 * lpt_probe()
352 */
353static int
354lpt_probe(device_t dev)
355{
356
357	if (!lpt_detect(dev))
358		return (ENXIO);
359
360	device_set_desc(dev, "Printer");
361
362	return (0);
363}
364
365static int
366lpt_attach(device_t dev)
367{
368	device_t ppbus = device_get_parent(dev);
369	struct lpt_data *sc = DEVTOSOFTC(dev);
370	int rid = 0, unit = device_get_unit(dev);
371	int error;
372
373	sc->sc_primed = 0;	/* not primed yet */
374
375	if ((error = lpt_request_ppbus(dev, PPB_DONTWAIT))) {
376		printf(LPT_NAME ": cannot alloc ppbus (%d)!\n", error);
377		return (0);
378	}
379
380	ppb_wctr(ppbus, LPC_NINIT);
381
382	/* check if we can use interrupt, should be done by ppc stuff */
383	lprintf(("oldirq %x\n", sc->sc_irq));
384
385	/* declare our interrupt handler */
386	sc->intr_resource = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
387	    RF_SHAREABLE);
388	if (sc->intr_resource) {
389		sc->sc_irq = LP_HAS_IRQ | LP_USE_IRQ | LP_ENABLE_IRQ;
390		device_printf(dev, "Interrupt-driven port\n");
391	} else {
392		sc->sc_irq = 0;
393		device_printf(dev, "Polled port\n");
394	}
395	lprintf(("irq %x\n", sc->sc_irq));
396
397	lpt_release_ppbus(dev);
398
399	make_dev(&lpt_cdevsw, unit,
400	    UID_ROOT, GID_WHEEL, 0600, LPT_NAME "%d", unit);
401	make_dev(&lpt_cdevsw, unit | LP_BYPASS,
402	    UID_ROOT, GID_WHEEL, 0600, LPT_NAME "%d.ctl", unit);
403	return (0);
404}
405
406static int
407lpt_detach(device_t dev)
408{
409	struct lpt_data *sc = DEVTOSOFTC(dev);
410
411	lpt_release_ppbus(dev);
412	if (sc->intr_resource != 0) {
413		BUS_TEARDOWN_INTR(device_get_parent(dev), dev,
414		    sc->intr_resource, sc->intr_cookie);
415		bus_release_resource(dev, SYS_RES_IRQ, 0, sc->intr_resource);
416	}
417
418	return (0);
419}
420
421static void
422lptout(void *arg)
423{
424	device_t dev = (device_t)arg;
425	struct lpt_data *sc = DEVTOSOFTC(dev);
426#ifdef LPT_DEBUG
427	device_t ppbus = device_get_parent(dev);
428#endif
429
430	lprintf(("T %x ", ppb_rstr(ppbus)));
431	if (sc->sc_state & OPEN) {
432		sc->sc_backoff++;
433		if (sc->sc_backoff > hz/LPTOUTMAX)
434			sc->sc_backoff = sc->sc_backoff > hz/LPTOUTMAX;
435		timeout(lptout, (caddr_t)dev, sc->sc_backoff);
436	} else
437		sc->sc_state &= ~TOUT;
438
439	if (sc->sc_state & EERROR)
440		sc->sc_state &= ~EERROR;
441
442	/*
443	 * Avoid possible hangs due to missed interrupts
444	 */
445	if (sc->sc_xfercnt) {
446		lptintr(dev);
447	} else {
448		sc->sc_state &= ~OBUSY;
449		wakeup(dev);
450	}
451}
452
453/*
454 * lptopen -- reset the printer, then wait until it's selected and not busy.
455 *	If LP_BYPASS flag is selected, then we do not try to select the
456 *	printer -- this is just used for passing ioctls.
457 */
458
459static	int
460lptopen(struct cdev *dev, int flags, int fmt, struct thread *td)
461{
462	int s;
463	int trys, err;
464	u_int unit = LPTUNIT(dev2unit(dev));
465	struct lpt_data *sc = UNITOSOFTC(unit);
466	device_t lptdev = UNITODEVICE(unit);
467	device_t ppbus = device_get_parent(lptdev);
468
469	if (!sc)
470		return (ENXIO);
471
472	if (sc->sc_state) {
473		lprintf((LPT_NAME ": still open %x\n", sc->sc_state));
474		return(EBUSY);
475	} else
476		sc->sc_state |= LPTINIT;
477
478	sc->sc_flags = LPTFLAGS(dev2unit(dev));
479
480	/* Check for open with BYPASS flag set. */
481	if (sc->sc_flags & LP_BYPASS) {
482		sc->sc_state = OPEN;
483		return(0);
484	}
485
486	/* request the ppbus only if we don't have it already */
487	if ((err = lpt_request_ppbus(lptdev, PPB_WAIT|PPB_INTR)) != 0) {
488		/* give it a chance to try later */
489		sc->sc_state = 0;
490		return (err);
491	}
492
493	s = spltty();
494	lprintf((LPT_NAME " flags 0x%x\n", sc->sc_flags));
495
496	/* set IRQ status according to ENABLE_IRQ flag
497	 */
498	if (sc->sc_irq & LP_ENABLE_IRQ)
499		sc->sc_irq |= LP_USE_IRQ;
500	else
501		sc->sc_irq &= ~LP_USE_IRQ;
502
503	/* init printer */
504	if ((sc->sc_flags & LP_NO_PRIME) == 0) {
505		if((sc->sc_flags & LP_PRIMEOPEN) || sc->sc_primed == 0) {
506			ppb_wctr(ppbus, 0);
507			sc->sc_primed++;
508			DELAY(500);
509		}
510	}
511
512	ppb_wctr(ppbus, LPC_SEL|LPC_NINIT);
513
514	/* wait till ready (printer running diagnostics) */
515	trys = 0;
516	do {
517		/* ran out of waiting for the printer */
518		if (trys++ >= LPINITRDY*4) {
519			splx(s);
520			sc->sc_state = 0;
521			lprintf(("status %x\n", ppb_rstr(ppbus)));
522
523			lpt_release_ppbus(lptdev);
524			return (EBUSY);
525		}
526
527		/* wait 1/4 second, give up if we get a signal */
528		if (tsleep(lptdev, LPPRI|PCATCH, "lptinit", hz/4) !=
529		    EWOULDBLOCK) {
530			sc->sc_state = 0;
531			splx(s);
532
533			lpt_release_ppbus(lptdev);
534			return (EBUSY);
535		}
536
537		/* is printer online and ready for output */
538	} while ((ppb_rstr(ppbus) &
539			(LPS_SEL|LPS_OUT|LPS_NBSY|LPS_NERR)) !=
540					(LPS_SEL|LPS_NBSY|LPS_NERR));
541
542	sc->sc_control = LPC_SEL|LPC_NINIT;
543	if (sc->sc_flags & LP_AUTOLF)
544		sc->sc_control |= LPC_AUTOL;
545
546	/* enable interrupt if interrupt-driven */
547	if (sc->sc_irq & LP_USE_IRQ)
548		sc->sc_control |= LPC_ENA;
549
550	ppb_wctr(ppbus, sc->sc_control);
551
552	sc->sc_state = OPEN;
553	sc->sc_inbuf = malloc(BUFSIZE, M_DEVBUF, M_WAITOK);
554	sc->sc_statbuf = malloc(BUFSTATSIZE, M_DEVBUF, M_WAITOK);
555	sc->sc_xfercnt = 0;
556	splx(s);
557
558	/* release the ppbus */
559	lpt_release_ppbus(lptdev);
560
561	/* only use timeout if using interrupt */
562	lprintf(("irq %x\n", sc->sc_irq));
563	if (sc->sc_irq & LP_USE_IRQ) {
564		sc->sc_state |= TOUT;
565		timeout(lptout, (caddr_t)lptdev,
566			 (sc->sc_backoff = hz/LPTOUTINITIAL));
567	}
568
569	lprintf(("opened.\n"));
570	return(0);
571}
572
573/*
574 * lptclose -- close the device, free the local line buffer.
575 *
576 * Check for interrupted write call added.
577 */
578
579static	int
580lptclose(struct cdev *dev, int flags, int fmt, struct thread *td)
581{
582	u_int unit = LPTUNIT(dev2unit(dev));
583	struct lpt_data *sc = UNITOSOFTC(unit);
584	device_t lptdev = UNITODEVICE(unit);
585        device_t ppbus = device_get_parent(lptdev);
586	int err;
587
588	if(sc->sc_flags & LP_BYPASS)
589		goto end_close;
590
591	if ((err = lpt_request_ppbus(lptdev, PPB_WAIT|PPB_INTR)) != 0)
592		return (err);
593
594	sc->sc_state &= ~OPEN;
595
596	/* if the last write was interrupted, don't complete it */
597	if((!(sc->sc_state  & INTERRUPTED)) && (sc->sc_irq & LP_USE_IRQ))
598		while ((ppb_rstr(ppbus) &
599			(LPS_SEL|LPS_OUT|LPS_NBSY|LPS_NERR)) !=
600			(LPS_SEL|LPS_NBSY|LPS_NERR) || sc->sc_xfercnt)
601			/* wait 1/4 second, give up if we get a signal */
602			if (tsleep(lptdev, LPPRI|PCATCH,
603				"lpclose", hz) != EWOULDBLOCK)
604				break;
605
606	ppb_wctr(ppbus, LPC_NINIT);
607	free(sc->sc_inbuf, M_DEVBUF);
608	free(sc->sc_statbuf, M_DEVBUF);
609
610end_close:
611	/* release the bus anyway
612	 * unregistration of interrupt forced by release
613	 */
614	lpt_release_ppbus(lptdev);
615
616	sc->sc_state = 0;
617	sc->sc_xfercnt = 0;
618	lprintf(("closed.\n"));
619	return(0);
620}
621
622/*
623 * lpt_pushbytes()
624 *	Workhorse for actually spinning and writing bytes to printer
625 *	Derived from lpa.c
626 *	Originally by ?
627 *
628 *	This code is only used when we are polling the port
629 */
630static int
631lpt_pushbytes(device_t dev)
632{
633	struct lpt_data *sc = DEVTOSOFTC(dev);
634	device_t ppbus = device_get_parent(dev);
635	int spin, err, tic;
636	char ch;
637
638	lprintf(("p"));
639	/* loop for every character .. */
640	while (sc->sc_xfercnt > 0) {
641		/* printer data */
642		ch = *(sc->sc_cp);
643		sc->sc_cp++;
644		sc->sc_xfercnt--;
645
646		/*
647		 * Wait for printer ready.
648		 * Loop 20 usecs testing BUSY bit, then sleep
649		 * for exponentially increasing timeout. (vak)
650		 */
651		for (spin = 0; NOT_READY(ppbus) && spin < MAX_SPIN; ++spin)
652			DELAY(1);	/* XXX delay is NOT this accurate! */
653		if (spin >= MAX_SPIN) {
654			tic = 0;
655			while (NOT_READY(ppbus)) {
656				/*
657				 * Now sleep, every cycle a
658				 * little longer ..
659				 */
660				tic = tic + tic + 1;
661				/*
662				 * But no more than 10 seconds. (vak)
663				 */
664				if (tic > MAX_SLEEP)
665					tic = MAX_SLEEP;
666				err = tsleep(dev, LPPRI,
667					LPT_NAME "poll", tic);
668				if (err != EWOULDBLOCK) {
669					return (err);
670				}
671			}
672		}
673
674		/* output data */
675		ppb_wdtr(ppbus, ch);
676		/* strobe */
677		ppb_wctr(ppbus, sc->sc_control|LPC_STB);
678		ppb_wctr(ppbus, sc->sc_control);
679
680	}
681	return(0);
682}
683
684/*
685 * lptread --retrieve printer status in IEEE1284 NIBBLE mode
686 */
687
688static int
689lptread(struct cdev *dev, struct uio *uio, int ioflag)
690{
691        u_int	unit = LPTUNIT(dev2unit(dev));
692	struct lpt_data *sc = UNITOSOFTC(unit);
693	device_t lptdev = UNITODEVICE(unit);
694        device_t ppbus = device_get_parent(lptdev);
695	int error = 0, len;
696
697	if (sc->sc_flags & LP_BYPASS) {
698		/* we can't do reads in bypass mode */
699		return (EPERM);
700	}
701
702	if ((error = ppb_1284_negociate(ppbus, PPB_NIBBLE, 0)))
703		return (error);
704
705	/* read data in an other buffer, read/write may be simultaneous */
706	len = 0;
707	while (uio->uio_resid) {
708		if ((error = ppb_1284_read(ppbus, PPB_NIBBLE,
709				sc->sc_statbuf, min(BUFSTATSIZE,
710				uio->uio_resid), &len))) {
711			goto error;
712		}
713
714		if (!len)
715			goto error;		/* no more data */
716
717		if ((error = uiomove(sc->sc_statbuf, len, uio)))
718			goto error;
719	}
720
721error:
722	ppb_1284_terminate(ppbus);
723	return (error);
724}
725
726/*
727 * lptwrite --copy a line from user space to a local buffer, then call
728 * putc to get the chars moved to the output queue.
729 *
730 * Flagging of interrupted write added.
731 */
732
733static	int
734lptwrite(struct cdev *dev, struct uio *uio, int ioflag)
735{
736	register unsigned n;
737	int err;
738        u_int	unit = LPTUNIT(dev2unit(dev));
739	struct lpt_data *sc = UNITOSOFTC(unit);
740	device_t lptdev = UNITODEVICE(unit);
741        device_t ppbus = device_get_parent(lptdev);
742
743	if(sc->sc_flags & LP_BYPASS) {
744		/* we can't do writes in bypass mode */
745		return(EPERM);
746	}
747
748	/* request the ppbus only if we don't have it already */
749	/* XXX interrupt registration?! */
750	if ((err = lpt_request_ppbus(lptdev, PPB_WAIT|PPB_INTR)) != 0)
751		return (err);
752
753	/* if interrupts are working, register the handler */
754	if (sc->sc_irq & LP_USE_IRQ) {
755		/* register our interrupt handler */
756		err = bus_setup_intr(lptdev, sc->intr_resource,
757			       INTR_TYPE_TTY, NULL, lpt_intr, lptdev,
758			       &sc->intr_cookie);
759		if (err) {
760			device_printf(lptdev, "handler registration failed, polled mode.\n");
761			sc->sc_irq &= ~LP_USE_IRQ;
762		}
763	}
764
765	sc->sc_state &= ~INTERRUPTED;
766	while ((n = min(BUFSIZE, uio->uio_resid)) != 0) {
767		sc->sc_cp = sc->sc_inbuf;
768		uiomove(sc->sc_cp, n, uio);
769		sc->sc_xfercnt = n ;
770
771		if (sc->sc_irq & LP_ENABLE_EXT) {
772			/* try any extended mode */
773			err = ppb_write(ppbus, sc->sc_cp,
774					sc->sc_xfercnt, 0);
775			switch (err) {
776			case 0:
777				/* if not all data was sent, we could rely
778				 * on polling for the last bytes */
779				sc->sc_xfercnt = 0;
780				break;
781			case EINTR:
782				sc->sc_state |= INTERRUPTED;
783				return(err);
784			case EINVAL:
785				/* advanced mode not avail */
786				log(LOG_NOTICE, LPT_NAME "%d: advanced mode not avail, polling\n", unit);
787				break;
788			default:
789				return(err);
790			}
791		} else while ((sc->sc_xfercnt > 0)&&(sc->sc_irq & LP_USE_IRQ)) {
792			lprintf(("i"));
793			/* if the printer is ready for a char, */
794			/* give it one */
795			if ((sc->sc_state & OBUSY) == 0){
796				lprintf(("\nC %d. ", sc->sc_xfercnt));
797				lptintr(lptdev);
798			}
799			lprintf(("W "));
800			if (sc->sc_state & OBUSY)
801				if ((err = tsleep(lptdev,
802					 LPPRI|PCATCH, LPT_NAME "write", 0))) {
803					sc->sc_state |= INTERRUPTED;
804					return(err);
805				}
806		}
807
808		/* check to see if we must do a polled write */
809		if(!(sc->sc_irq & LP_USE_IRQ) && (sc->sc_xfercnt)) {
810			lprintf(("p"));
811
812			err = lpt_pushbytes(lptdev);
813
814			if (err)
815				return(err);
816		}
817	}
818
819	/* we have not been interrupted, release the ppbus */
820	lpt_release_ppbus(lptdev);
821
822	return(0);
823}
824
825/*
826 * lpt_intr -- handle printer interrupts which occur when the printer is
827 * ready to accept another char.
828 *
829 * do checking for interrupted write call.
830 */
831
832static void
833lpt_intr(void *arg)
834{
835	device_t lptdev = (device_t)arg;
836        device_t ppbus = device_get_parent(lptdev);
837	struct lpt_data *sc = DEVTOSOFTC(lptdev);
838	int sts = 0;
839	int i;
840
841	/* we must own the bus to use it */
842	if ((sc->sc_state & HAVEBUS) == 0)
843		return;
844
845	/*
846	 * Is printer online and ready for output?
847	 *
848	 * Avoid falling back to lptout() too quickly.  First spin-loop
849	 * to see if the printer will become ready ``really soon now''.
850	 */
851	for (i = 0; i < 100 &&
852	     ((sts=ppb_rstr(ppbus)) & RDY_MASK) != LP_READY; i++) ;
853
854	if ((sts & RDY_MASK) == LP_READY) {
855		sc->sc_state = (sc->sc_state | OBUSY) & ~EERROR;
856		sc->sc_backoff = hz/LPTOUTINITIAL;
857
858		if (sc->sc_xfercnt) {
859			/* send char */
860			/*lprintf(("%x ", *sc->sc_cp)); */
861			ppb_wdtr(ppbus, *sc->sc_cp++) ;
862			ppb_wctr(ppbus, sc->sc_control|LPC_STB);
863			/* DELAY(X) */
864			ppb_wctr(ppbus, sc->sc_control);
865
866			/* any more data for printer */
867			if(--(sc->sc_xfercnt) > 0) return;
868		}
869
870		/*
871		 * No more data waiting for printer.
872		 * Wakeup is not done if write call was not interrupted.
873		 */
874		sc->sc_state &= ~OBUSY;
875
876		if(!(sc->sc_state & INTERRUPTED))
877			wakeup(lptdev);
878		lprintf(("w "));
879		return;
880	} else	{	/* check for error */
881		if(((sts & (LPS_NERR | LPS_OUT) ) != LPS_NERR) &&
882				(sc->sc_state & OPEN))
883			sc->sc_state |= EERROR;
884		/* lptout() will jump in and try to restart. */
885	}
886	lprintf(("sts %x ", sts));
887}
888
889static void
890lptintr(device_t dev)
891{
892	/* call the interrupt at required spl level */
893	int s = spltty();
894
895	lpt_intr(dev);
896
897	splx(s);
898	return;
899}
900
901static	int
902lptioctl(struct cdev *dev, u_long cmd, caddr_t data, int flags, struct thread *td)
903{
904	int	error = 0;
905        u_int	unit = LPTUNIT(dev2unit(dev));
906        struct	lpt_data *sc = UNITOSOFTC(unit);
907	u_char	old_sc_irq;	/* old printer IRQ status */
908
909	switch (cmd) {
910	case LPT_IRQ :
911		if(sc->sc_irq & LP_HAS_IRQ) {
912			/*
913			 * NOTE:
914			 * If the IRQ status is changed,
915			 * this will only be visible on the
916			 * next open.
917			 *
918			 * If interrupt status changes,
919			 * this gets syslog'd.
920			 */
921			old_sc_irq = sc->sc_irq;
922			switch(*(int*)data) {
923			case 0:
924				sc->sc_irq &= (~LP_ENABLE_IRQ);
925				break;
926			case 1:
927				sc->sc_irq &= (~LP_ENABLE_EXT);
928				sc->sc_irq |= LP_ENABLE_IRQ;
929				break;
930			case 2:
931				/* classic irq based transfer and advanced
932				 * modes are in conflict
933				 */
934				sc->sc_irq &= (~LP_ENABLE_IRQ);
935				sc->sc_irq |= LP_ENABLE_EXT;
936				break;
937			case 3:
938				sc->sc_irq &= (~LP_ENABLE_EXT);
939				break;
940			default:
941				break;
942			}
943
944			if (old_sc_irq != sc->sc_irq )
945				log(LOG_NOTICE, LPT_NAME "%d: switched to %s %s mode\n",
946					unit,
947					(sc->sc_irq & LP_ENABLE_IRQ)?
948					"interrupt-driven":"polled",
949					(sc->sc_irq & LP_ENABLE_EXT)?
950					"extended":"standard");
951		} else /* polled port */
952			error = EOPNOTSUPP;
953		break;
954	default:
955		error = ENODEV;
956	}
957
958	return(error);
959}
960
961static device_method_t lpt_methods[] = {
962	/* device interface */
963	DEVMETHOD(device_identify,	lpt_identify),
964	DEVMETHOD(device_probe,		lpt_probe),
965	DEVMETHOD(device_attach,	lpt_attach),
966	DEVMETHOD(device_detach,	lpt_detach),
967
968	{ 0, 0 }
969};
970
971static driver_t lpt_driver = {
972	LPT_NAME,
973	lpt_methods,
974	sizeof(struct lpt_data),
975};
976
977DRIVER_MODULE(lpt, ppbus, lpt_driver, lpt_devclass, 0, 0);
978MODULE_DEPEND(lpt, ppbus, 1, 1, 1);
979