f07954353b0ddb0c914ef3ddac2e8f1ff140c45d
[dragonfly.git] / sys / dev / misc / lpt / lpt.c
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  * $FreeBSD: src/sys/dev/ppbus/lpt.c,v 1.15.2.3 2000/07/07 00:30:40 obrien Exp $
52  * $DragonFly: src/sys/dev/misc/lpt/lpt.c,v 1.19 2006/12/22 23:26:17 swildner Exp $
53  */
54
55 /*
56  * Device Driver for AT parallel printer port
57  * Written by William Jolitz 12/18/90
58  */
59
60 /*
61  * Updated for ppbus by Nicolas Souchu
62  * [Mon Jul 28 1997]
63  */
64
65 #include "opt_lpt.h"
66
67 #include <sys/param.h>
68 #include <sys/systm.h>
69 #include <sys/module.h>
70 #include <sys/bus.h>
71 #include <sys/conf.h>
72 #include <sys/device.h>
73 #include <sys/kernel.h>
74 #include <sys/uio.h>
75 #include <sys/syslog.h>
76 #include <sys/thread2.h>
77 #include <sys/malloc.h>
78 #include <sys/rman.h>
79
80 #include <machine/clock.h>
81
82 #include "lptio.h"
83 #include <bus/ppbus/ppbconf.h>
84 #include <bus/ppbus/ppb_1284.h>
85 #include "lpt.h"
86 #include "ppbus_if.h"
87 #include <bus/ppbus/ppbio.h>
88
89 MALLOC_DEFINE(M_LPT, "lpt", "LPT buffers");
90
91 #ifndef LPT_DEBUG
92 #define lprintf(args)
93 #else
94 #define lprintf(args)                                           \
95                 do {                                            \
96                         if (lptflag)                            \
97                                 kprintf args;                   \
98                 } while (0)
99 static int volatile lptflag = 1;
100 #endif
101
102 #define LPINITRDY       4       /* wait up to 4 seconds for a ready */
103 #define LPTOUTINITIAL   10      /* initial timeout to wait for ready 1/10 s */
104 #define LPTOUTMAX       1       /* maximal timeout 1 s */
105 #define BUFSIZE         1024
106 #define BUFSTATSIZE     32
107
108 #define LPTUNIT(s)      ((s)&0x03)
109 #define LPTFLAGS(s)     ((s)&0xfc)
110
111 struct lpt_data {
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_UNITMASK     0x03    /* up to 4 units */
118 #define LP_POS_INIT     0x04    /* if we are a postive init signal */
119 #define LP_POS_ACK      0x08    /* if we are a positive going ack */
120 #define LP_NO_PRIME     0x10    /* don't prime the printer at all */
121 #define LP_PRIMEOPEN    0x20    /* prime on every open */
122 #define LP_AUTOLF       0x40    /* tell printer to do an automatic lf */
123 #define LP_BYPASS       0x80    /* bypass  printer ready checks */
124         void    *sc_inbuf;
125         void    *sc_statbuf;
126         short   sc_xfercnt ;
127         char    sc_primed;
128         char    *sc_cp ;
129         u_short sc_irq ;        /* IRQ status of port */
130 #define LP_HAS_IRQ      0x01    /* we have an irq available */
131 #define LP_USE_IRQ      0x02    /* we are using our irq */
132 #define LP_ENABLE_IRQ   0x04    /* enable IRQ on open */
133 #define LP_ENABLE_EXT   0x10    /* we shall use advanced mode when possible */
134         u_char  sc_backoff ;    /* time to call lptout() again */
135
136         struct resource *intr_resource; /* interrupt resource */
137         void *intr_cookie;              /* interrupt registration cookie */
138         struct callout  sc_callout;
139 };
140
141 #define LPT_NAME        "lpt"           /* our official name */
142
143 static timeout_t lptout;
144 static int      lpt_port_test(device_t dev, u_char data, u_char mask);
145 static int      lpt_detect(device_t dev);
146
147 #define DEVTOSOFTC(dev) \
148         ((struct lpt_data *)device_get_softc(dev))
149 #define UNITOSOFTC(unit) \
150         ((struct lpt_data *)devclass_get_softc(lpt_devclass, (unit)))
151 #define UNITODEVICE(unit) \
152         (devclass_get_device(lpt_devclass, (unit)))
153
154 static void lptintr(device_t dev);
155 static void lpt_intr(void *arg);        /* without spls */
156
157 static devclass_t lpt_devclass;
158
159
160 /* bits for state */
161 #define OPEN            (1<<0)  /* device is open */
162 #define ASLP            (1<<1)  /* awaiting draining of printer */
163 #define EERROR          (1<<2)  /* error was received from printer */
164 #define OBUSY           (1<<3)  /* printer is busy doing output */
165 #define LPTOUT          (1<<4)  /* timeout while not selected */
166 #define TOUT            (1<<5)  /* timeout while not selected */
167 #define LPTINIT         (1<<6)  /* waiting to initialize for open */
168 #define INTERRUPTED     (1<<7)  /* write call was interrupted */
169
170 #define HAVEBUS         (1<<8)  /* the driver owns the bus */
171
172
173 /* status masks to interrogate printer status */
174 #define RDY_MASK        (LPS_SEL|LPS_OUT|LPS_NBSY|LPS_NERR)     /* ready ? */
175 #define LP_READY        (LPS_SEL|LPS_NBSY|LPS_NERR)
176
177 /* Printer Ready condition  - from lpa.c */
178 /* Only used in polling code */
179 #define LPS_INVERT      (LPS_NBSY | LPS_NACK |           LPS_SEL | LPS_NERR)
180 #define LPS_MASK        (LPS_NBSY | LPS_NACK | LPS_OUT | LPS_SEL | LPS_NERR)
181 #define NOT_READY(ppbus) ((ppb_rstr(ppbus)^LPS_INVERT)&LPS_MASK)
182
183 #define MAX_SLEEP       (hz*5)  /* Timeout while waiting for device ready */
184 #define MAX_SPIN        20      /* Max delay for device ready in usecs */
185
186
187 static  d_open_t        lptopen;
188 static  d_close_t       lptclose;
189 static  d_write_t       lptwrite;
190 static  d_read_t        lptread;
191 static  d_ioctl_t       lptioctl;
192
193 #define CDEV_MAJOR 16
194 static struct dev_ops lpt_ops = {
195         { LPT_NAME, CDEV_MAJOR, 0 },
196         .d_open =       lptopen,
197         .d_close =      lptclose,
198         .d_read =       lptread,
199         .d_write =      lptwrite,
200         .d_ioctl =      lptioctl,
201 };
202
203 static int
204 lpt_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
220 static int
221 lpt_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  */
236 static int
237 lpt_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  */
300 static int
301 lpt_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                 kprintf(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
329 end_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
339 /*
340  * lpt_probe()
341  */
342 static int
343 lpt_probe(device_t dev)
344 {
345         struct lpt_data *sc;
346         
347         sc = DEVTOSOFTC(dev);
348         bzero(sc, sizeof(struct lpt_data));
349
350         /*
351          * Now, try to detect the printer.
352          */
353         if (!lpt_detect(dev))
354                 return (ENXIO);
355
356         device_set_desc(dev, "Printer");
357
358         return (0);
359 }
360
361 static int
362 lpt_attach(device_t dev)
363 {
364         device_t ppbus = device_get_parent(dev);
365         struct lpt_data *sc = DEVTOSOFTC(dev);
366         int zero = 0, unit = device_get_unit(dev);
367         int error;
368         uintptr_t irq;
369
370         sc->sc_primed = 0;      /* not primed yet */
371         callout_init(&sc->sc_callout);
372
373         if ((error = lpt_request_ppbus(dev, PPB_DONTWAIT))) {
374                 kprintf(LPT_NAME ": cannot alloc ppbus (%d)!\n", error);
375                 return (0);
376         }
377
378         ppb_wctr(ppbus, LPC_NINIT);
379
380         /* check if we can use interrupt, should be done by ppc stuff */
381         lprintf(("oldirq %x\n", sc->sc_irq));
382
383         /* retrieve the ppbus irq */
384         BUS_READ_IVAR(ppbus, dev, PPBUS_IVAR_IRQ, &irq);
385
386         if (irq > 0) {
387                 /* declare our interrupt handler */
388                 sc->intr_resource = bus_alloc_resource(dev, SYS_RES_IRQ,
389                                                        &zero, irq, irq, 1, RF_SHAREABLE);
390         }
391         if (sc->intr_resource) {
392                 sc->sc_irq = LP_HAS_IRQ | LP_USE_IRQ | LP_ENABLE_IRQ;
393                 device_printf(dev, "Interrupt-driven port\n");
394         } else {
395                 sc->sc_irq = 0;
396                 device_printf(dev, "Polled port\n");
397         }
398         lprintf(("irq %x %x\n", irq, sc->sc_irq));
399
400         lpt_release_ppbus(dev);
401
402         dev_ops_add(&lpt_ops, LP_UNITMASK, unit);
403         make_dev(&lpt_ops, unit,
404             UID_ROOT, GID_WHEEL, 0600, LPT_NAME "%d", unit);
405         make_dev(&lpt_ops, unit | LP_BYPASS,
406             UID_ROOT, GID_WHEEL, 0600, LPT_NAME "%d.ctl", unit);
407         return (0);
408 }
409
410 static void
411 lptout(void *arg)
412 {
413         device_t dev = (device_t)arg;
414         struct lpt_data *sc = DEVTOSOFTC(dev);
415 #ifdef LPT_DEBUG
416         device_t ppbus = device_get_parent(dev);
417 #endif
418
419         lprintf(("T %x ", ppb_rstr(ppbus)));
420         if (sc->sc_state & OPEN) {
421                 sc->sc_backoff++;
422                 if (sc->sc_backoff > hz/LPTOUTMAX)
423                         sc->sc_backoff = sc->sc_backoff > hz/LPTOUTMAX;
424                 callout_reset(&sc->sc_callout, sc->sc_backoff, lptout, dev);
425         } else {
426                 sc->sc_state &= ~TOUT;
427         }
428
429         if (sc->sc_state & EERROR)
430                 sc->sc_state &= ~EERROR;
431
432         /*
433          * Avoid possible hangs due to missed interrupts
434          */
435         if (sc->sc_xfercnt) {
436                 lptintr(dev);
437         } else {
438                 sc->sc_state &= ~OBUSY;
439                 wakeup((caddr_t)dev);
440         }
441 }
442
443 /*
444  * lptopen -- reset the printer, then wait until it's selected and not busy.
445  *      If LP_BYPASS flag is selected, then we do not try to select the
446  *      printer -- this is just used for passing ioctls.
447  */
448
449 static  int
450 lptopen(struct dev_open_args *ap)
451 {
452         cdev_t dev = ap->a_head.a_dev;
453         int trys, err;
454         u_int unit = LPTUNIT(minor(dev));
455         struct lpt_data *sc = UNITOSOFTC(unit);
456         device_t lptdev = UNITODEVICE(unit);
457         device_t ppbus = device_get_parent(lptdev);
458
459         if (!sc)
460                 return (ENXIO);
461
462         if (sc->sc_state) {
463                 lprintf((LPT_NAME ": still open %x\n", sc->sc_state));
464                 return(EBUSY);
465         } else
466                 sc->sc_state |= LPTINIT;
467
468         sc->sc_flags = LPTFLAGS(minor(dev));
469
470         /* Check for open with BYPASS flag set. */
471         if (sc->sc_flags & LP_BYPASS) {
472                 sc->sc_state = OPEN;
473                 return(0);
474         }
475
476         /* request the ppbus only if we don't have it already */
477         if ((err = lpt_request_ppbus(lptdev, PPB_WAIT|PPB_INTR)) != 0) {
478                 /* give it a chance to try later */
479                 sc->sc_state = 0;
480                 return (err);
481         }
482
483         crit_enter();
484         lprintf((LPT_NAME " flags 0x%x\n", sc->sc_flags));
485
486         /* set IRQ status according to ENABLE_IRQ flag
487          */
488         if (sc->sc_irq & LP_ENABLE_IRQ)
489                 sc->sc_irq |= LP_USE_IRQ;
490         else
491                 sc->sc_irq &= ~LP_USE_IRQ;
492
493         /* init printer */
494         if ((sc->sc_flags & LP_NO_PRIME) == 0) {
495                 if((sc->sc_flags & LP_PRIMEOPEN) || sc->sc_primed == 0) {
496                         ppb_wctr(ppbus, 0);
497                         sc->sc_primed++;
498                         DELAY(500);
499                 }
500         }
501
502         ppb_wctr(ppbus, LPC_SEL|LPC_NINIT);
503
504         /* wait till ready (printer running diagnostics) */
505         trys = 0;
506         do {
507                 /* ran out of waiting for the printer */
508                 if (trys++ >= LPINITRDY*4) {
509                         crit_exit();
510                         sc->sc_state = 0;
511                         lprintf(("status %x\n", ppb_rstr(ppbus)));
512
513                         lpt_release_ppbus(lptdev);
514                         return (EBUSY);
515                 }
516
517                 /* wait 1/4 second, give up if we get a signal */
518                 if (tsleep((caddr_t)lptdev, PCATCH, "lptinit", hz/4) !=
519                     EWOULDBLOCK) {
520                         sc->sc_state = 0;
521                         crit_exit();
522
523                         lpt_release_ppbus(lptdev);
524                         return (EBUSY);
525                 }
526
527                 /* is printer online and ready for output */
528         } while ((ppb_rstr(ppbus) &
529                         (LPS_SEL|LPS_OUT|LPS_NBSY|LPS_NERR)) !=
530                                         (LPS_SEL|LPS_NBSY|LPS_NERR));
531
532         sc->sc_control = LPC_SEL|LPC_NINIT;
533         if (sc->sc_flags & LP_AUTOLF)
534                 sc->sc_control |= LPC_AUTOL;
535
536         /* enable interrupt if interrupt-driven */
537         if (sc->sc_irq & LP_USE_IRQ)
538                 sc->sc_control |= LPC_ENA;
539
540         ppb_wctr(ppbus, sc->sc_control);
541
542         sc->sc_state = OPEN;
543         sc->sc_inbuf = kmalloc(BUFSIZE, M_LPT, M_WAITOK);
544         sc->sc_statbuf = kmalloc(BUFSTATSIZE, M_LPT, M_WAITOK);
545         sc->sc_xfercnt = 0;
546
547         crit_exit();
548
549         /* release the ppbus */
550         lpt_release_ppbus(lptdev);
551
552         /* only use timeout if using interrupt */
553         lprintf(("irq %x\n", sc->sc_irq));
554         if (sc->sc_irq & LP_USE_IRQ) {
555                 sc->sc_state |= TOUT;
556                 sc->sc_backoff = hz / LPTOUTINITIAL;
557                 callout_reset(&sc->sc_callout, sc->sc_backoff, lptout, lptdev);
558         }
559
560         lprintf(("opened.\n"));
561         return(0);
562 }
563
564 /*
565  * lptclose -- close the device, free the local line buffer.
566  *
567  * Check for interrupted write call added.
568  */
569
570 static  int
571 lptclose(struct dev_close_args *ap)
572 {
573         cdev_t dev = ap->a_head.a_dev;
574         u_int unit = LPTUNIT(minor(dev));
575         struct lpt_data *sc = UNITOSOFTC(unit);
576         device_t lptdev = UNITODEVICE(unit);
577         device_t ppbus = device_get_parent(lptdev);
578         int err;
579
580         if(sc->sc_flags & LP_BYPASS)
581                 goto end_close;
582
583         if ((err = lpt_request_ppbus(lptdev, PPB_WAIT|PPB_INTR)) != 0)
584                 return (err);
585
586         sc->sc_state &= ~OPEN;
587
588         /* if the last write was interrupted, don't complete it */
589         if((!(sc->sc_state & INTERRUPTED)) && (sc->sc_irq & LP_USE_IRQ)) {
590                 while ((ppb_rstr(ppbus) &
591                     (LPS_SEL|LPS_OUT|LPS_NBSY|LPS_NERR)) !=
592                     (LPS_SEL|LPS_NBSY|LPS_NERR) || sc->sc_xfercnt) {
593                         /* wait 1/4 second, give up if we get a signal */
594                         if (tsleep((caddr_t)lptdev, PCATCH,
595                             "lpclose", hz) != EWOULDBLOCK) {
596                                 break;
597                         }
598                 }
599         }
600         callout_stop(&sc->sc_callout);
601         ppb_wctr(ppbus, LPC_NINIT);
602         kfree(sc->sc_inbuf, M_LPT);
603         kfree(sc->sc_statbuf, M_LPT);
604
605 end_close:
606         /* release the bus anyway
607          * unregistration of interrupt forced by release
608          */
609         lpt_release_ppbus(lptdev);
610
611         sc->sc_state = 0;
612         sc->sc_xfercnt = 0;
613         lprintf(("closed.\n"));
614         return(0);
615 }
616
617 /*
618  * lpt_pushbytes()
619  *      Workhorse for actually spinning and writing bytes to printer
620  *      Derived from lpa.c
621  *      Originally by ?
622  *
623  *      This code is only used when we are polling the port
624  */
625 static int
626 lpt_pushbytes(device_t dev)
627 {
628         struct lpt_data *sc = DEVTOSOFTC(dev);
629         device_t ppbus = device_get_parent(dev);
630         int spin, err, tic;
631         char ch;
632
633         lprintf(("p"));
634         /* loop for every character .. */
635         while (sc->sc_xfercnt > 0) {
636                 /* printer data */
637                 ch = *(sc->sc_cp);
638                 sc->sc_cp++;
639                 sc->sc_xfercnt--;
640
641                 /*
642                  * Wait for printer ready.
643                  * Loop 20 usecs testing BUSY bit, then sleep
644                  * for exponentially increasing timeout. (vak)
645                  */
646                 for (spin = 0; NOT_READY(ppbus) && spin < MAX_SPIN; ++spin)
647                         DELAY(1);       /* XXX delay is NOT this accurate! */
648                 if (spin >= MAX_SPIN) {
649                         tic = 0;
650                         while (NOT_READY(ppbus)) {
651                                 /*
652                                  * Now sleep, every cycle a
653                                  * little longer ..
654                                  */
655                                 tic = tic + tic + 1;
656                                 /*
657                                  * But no more than 10 seconds. (vak)
658                                  */
659                                 if (tic > MAX_SLEEP)
660                                         tic = MAX_SLEEP;
661                                 err = tsleep((caddr_t)dev, 0,
662                                         LPT_NAME "poll", tic);
663                                 if (err != EWOULDBLOCK) {
664                                         return (err);
665                                 }
666                         }
667                 }
668
669                 /* output data */
670                 ppb_wdtr(ppbus, ch);
671                 /* strobe */
672                 ppb_wctr(ppbus, sc->sc_control|LPC_STB);
673                 ppb_wctr(ppbus, sc->sc_control);
674
675         }
676         return(0);
677 }
678
679 /*
680  * lptread --retrieve printer status in IEEE1284 NIBBLE mode
681  */
682
683 static int
684 lptread(struct dev_read_args *ap)
685 {
686         cdev_t dev = ap->a_head.a_dev;
687         struct uio *uio = ap->a_uio;
688         u_int   unit = LPTUNIT(minor(dev));
689         struct lpt_data *sc = UNITOSOFTC(unit);
690         device_t lptdev = UNITODEVICE(unit);
691         device_t ppbus = device_get_parent(lptdev);
692         int error = 0, len;
693
694         if (sc->sc_flags & LP_BYPASS) {
695                 /* we can't do reads in bypass mode */
696                 return (EPERM);
697         }
698
699         if ((error = ppb_1284_negociate(ppbus, PPB_NIBBLE, 0)))
700                 return (error);
701
702         /* read data in an other buffer, read/write may be simultaneous */
703         len = 0;
704         while (uio->uio_resid) {
705                 if ((error = ppb_1284_read(ppbus, PPB_NIBBLE,
706                                 sc->sc_statbuf, min(BUFSTATSIZE,
707                                 uio->uio_resid), &len))) {
708                         goto error;
709                 }
710
711                 if (!len)
712                         goto error;             /* no more data */
713
714                 if ((error = uiomove(sc->sc_statbuf, len, uio)))
715                         goto error;
716         }
717
718 error:
719         ppb_1284_terminate(ppbus);
720         return (error);
721 }
722
723 /*
724  * lptwrite --copy a line from user space to a local buffer, then call
725  * putc to get the chars moved to the output queue.
726  *
727  * Flagging of interrupted write added.
728  */
729
730 static  int
731 lptwrite(struct dev_write_args *ap)
732 {
733         cdev_t dev = ap->a_head.a_dev;
734         struct uio *uio = ap->a_uio;
735         unsigned n;
736         int err;
737         u_int   unit = LPTUNIT(minor(dev));
738         struct lpt_data *sc = UNITOSOFTC(unit);
739         device_t lptdev = UNITODEVICE(unit);
740         device_t ppbus = device_get_parent(lptdev);
741
742         if(sc->sc_flags & LP_BYPASS) {
743                 /* we can't do writes in bypass mode */
744                 return(EPERM);
745         }
746
747         /* request the ppbus only if we don't have it already */
748         /* XXX interrupt registration?! */
749         if ((err = lpt_request_ppbus(lptdev, PPB_WAIT|PPB_INTR)) != 0)
750                 return (err);
751
752         /* if interrupts are working, register the handler */
753         if (sc->sc_irq & LP_USE_IRQ) {
754                 /* register our interrupt handler */
755                 err = BUS_SETUP_INTR(ppbus, lptdev, sc->intr_resource,
756                                0, lpt_intr, lptdev,
757                                &sc->intr_cookie, NULL);
758                 if (err) {
759                         device_printf(lptdev, "handler registration failed, polled mode.\n");
760                         sc->sc_irq &= ~LP_USE_IRQ;
761                 }
762         }
763
764         sc->sc_state &= ~INTERRUPTED;
765         while ((n = min(BUFSIZE, uio->uio_resid)) != 0) {
766                 sc->sc_cp = sc->sc_inbuf;
767                 uiomove(sc->sc_cp, n, uio);
768                 sc->sc_xfercnt = n ;
769
770                 if (sc->sc_irq & LP_ENABLE_EXT) {
771                         /* try any extended mode */
772                         err = ppb_write(ppbus, sc->sc_cp,
773                                         sc->sc_xfercnt, 0);
774                         switch (err) {
775                         case 0:
776                                 /* if not all data was sent, we could rely
777                                  * on polling for the last bytes */
778                                 sc->sc_xfercnt = 0;
779                                 break;
780                         case EINTR:
781                                 sc->sc_state |= INTERRUPTED;    
782                                 return(err);
783                         case EINVAL:
784                                 /* advanced mode not avail */
785                                 log(LOG_NOTICE, LPT_NAME "%d: advanced mode not avail, polling\n", unit);
786                                 break;
787                         default:
788                                 return(err);
789                         }
790                 } else while ((sc->sc_xfercnt > 0)&&(sc->sc_irq & LP_USE_IRQ)) {
791                         lprintf(("i"));
792                         /* if the printer is ready for a char, */
793                         /* give it one */
794                         if ((sc->sc_state & OBUSY) == 0){
795                                 lprintf(("\nC %d. ", sc->sc_xfercnt));
796                                 lptintr(lptdev);
797                         }
798                         lprintf(("W "));
799                         if (sc->sc_state & OBUSY)
800                                 if ((err = tsleep((caddr_t)lptdev,
801                                          PCATCH, LPT_NAME "write", 0))) {
802                                         sc->sc_state |= INTERRUPTED;
803                                         return(err);
804                                 }
805                 }
806
807                 /* check to see if we must do a polled write */
808                 if(!(sc->sc_irq & LP_USE_IRQ) && (sc->sc_xfercnt)) {
809                         lprintf(("p"));
810
811                         err = lpt_pushbytes(lptdev);
812
813                         if (err)
814                                 return(err);
815                 }
816         }
817
818         /* we have not been interrupted, release the ppbus */
819         lpt_release_ppbus(lptdev);
820
821         return(0);
822 }
823
824 /*
825  * lpt_intr -- handle printer interrupts which occur when the printer is
826  * ready to accept another char.
827  *
828  * do checking for interrupted write call.
829  */
830
831 static void
832 lpt_intr(void *arg)
833 {
834         device_t lptdev = (device_t)arg;
835         device_t ppbus = device_get_parent(lptdev);
836         struct lpt_data *sc = DEVTOSOFTC(lptdev);
837         int sts = 0;
838         int i;
839         
840         /* we must own the bus to use it */
841         if ((sc->sc_state & HAVEBUS) == 0)
842                 return;
843
844         /*
845          * Is printer online and ready for output?
846          *
847          * Avoid falling back to lptout() too quickly.  First spin-loop
848          * to see if the printer will become ready ``really soon now''.
849          */
850         for (i = 0; i < 100 &&
851              ((sts=ppb_rstr(ppbus)) & RDY_MASK) != LP_READY; i++) ;
852
853         if ((sts & RDY_MASK) == LP_READY) {
854                 sc->sc_state = (sc->sc_state | OBUSY) & ~EERROR;
855                 sc->sc_backoff = hz/LPTOUTINITIAL;
856
857                 if (sc->sc_xfercnt) {
858                         /* send char */
859                         /*lprintf(("%x ", *sc->sc_cp)); */
860                         ppb_wdtr(ppbus, *sc->sc_cp++) ;
861                         ppb_wctr(ppbus, sc->sc_control|LPC_STB);
862                         /* DELAY(X) */
863                         ppb_wctr(ppbus, sc->sc_control);
864
865                         /* any more data for printer */
866                         if(--(sc->sc_xfercnt) > 0) return;
867                 }
868
869                 /*
870                  * No more data waiting for printer.
871                  * Wakeup is not done if write call was not interrupted.
872                  */
873                 sc->sc_state &= ~OBUSY;
874
875                 if(!(sc->sc_state & INTERRUPTED))
876                         wakeup((caddr_t)lptdev);
877                 lprintf(("w "));
878                 return;
879         } else  {       /* check for error */
880                 if(((sts & (LPS_NERR | LPS_OUT) ) != LPS_NERR) &&
881                                 (sc->sc_state & OPEN))
882                         sc->sc_state |= EERROR;
883                 /* lptout() will jump in and try to restart. */
884         }
885         lprintf(("sts %x ", sts));
886 }
887
888 static void
889 lptintr(device_t dev)
890 {
891         /* call the interrupt at required spl level */
892         crit_enter();
893
894         lpt_intr(dev);
895
896         crit_exit();
897 }
898
899 static  int
900 lptioctl(struct dev_ioctl_args *ap)
901 {
902         cdev_t dev = ap->a_head.a_dev;
903         int     error = 0;
904         u_int   unit = LPTUNIT(minor(dev));
905         struct  lpt_data *sc = UNITOSOFTC(unit);
906         u_char  old_sc_irq;     /* old printer IRQ status */
907
908         switch (ap->a_cmd) {
909         case LPT_IRQ :
910                 if(sc->sc_irq & LP_HAS_IRQ) {
911                         /*
912                          * NOTE:
913                          * If the IRQ status is changed,
914                          * this will only be visible on the
915                          * next open.
916                          *
917                          * If interrupt status changes,
918                          * this gets syslog'd.
919                          */
920                         old_sc_irq = sc->sc_irq;
921                         switch(*(int*)ap->a_data) {
922                         case 0:
923                                 sc->sc_irq &= (~LP_ENABLE_IRQ);
924                                 break;
925                         case 1:
926                                 sc->sc_irq &= (~LP_ENABLE_EXT);
927                                 sc->sc_irq |= LP_ENABLE_IRQ;
928                                 break;
929                         case 2:
930                                 /* classic irq based transfer and advanced
931                                  * modes are in conflict
932                                  */
933                                 sc->sc_irq &= (~LP_ENABLE_IRQ);
934                                 sc->sc_irq |= LP_ENABLE_EXT;
935                                 break;
936                         case 3:
937                                 sc->sc_irq &= (~LP_ENABLE_EXT);
938                                 break;
939                         default:
940                                 break;
941                         }
942                                 
943                         if (old_sc_irq != sc->sc_irq )
944                                 log(LOG_NOTICE, LPT_NAME "%d: switched to %s %s mode\n",
945                                         unit,
946                                         (sc->sc_irq & LP_ENABLE_IRQ)?
947                                         "interrupt-driven":"polled",
948                                         (sc->sc_irq & LP_ENABLE_EXT)?
949                                         "extended":"standard");
950                 } else /* polled port */
951                         error = EOPNOTSUPP;
952                 break;
953         default:
954                 error = ENODEV;
955         }
956
957         return(error);
958 }
959
960 /*
961  * Because lpt is a static device that always exists under a ppbus device,
962  * and not scanned by the ppbus device, we need an identify function to
963  * install its device.
964  */
965 static device_method_t lpt_methods[] = {
966         /* device interface */
967         DEVMETHOD(device_identify,      bus_generic_identify),
968         DEVMETHOD(device_probe,         lpt_probe),
969         DEVMETHOD(device_attach,        lpt_attach),
970
971         { 0, 0 }
972 };
973
974 static driver_t lpt_driver = {
975         LPT_NAME,
976         lpt_methods,
977         sizeof(struct lpt_data),
978 };
979
980 DRIVER_MODULE(lpt, ppbus, lpt_driver, lpt_devclass, 0, 0);
981