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