Home | History | Annotate | Line # | Download | only in ic
lpt.c revision 1.58
      1 /*	$NetBSD: lpt.c,v 1.58 2001/11/13 13:14:40 lukem Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 1993, 1994 Charles M. Hannum.
      5  * Copyright (c) 1990 William F. Jolitz, TeleMuse
      6  * All rights reserved.
      7  *
      8  * Redistribution and use in source and binary forms, with or without
      9  * modification, are permitted provided that the following conditions
     10  * are met:
     11  * 1. Redistributions of source code must retain the above copyright
     12  *    notice, this list of conditions and the following disclaimer.
     13  * 2. Redistributions in binary form must reproduce the above copyright
     14  *    notice, this list of conditions and the following disclaimer in the
     15  *    documentation and/or other materials provided with the distribution.
     16  * 3. All advertising materials mentioning features or use of this software
     17  *    must display the following acknowledgement:
     18  *	This software is a component of "386BSD" developed by
     19  *	William F. Jolitz, TeleMuse.
     20  * 4. Neither the name of the developer nor the name "386BSD"
     21  *    may be used to endorse or promote products derived from this software
     22  *    without specific prior written permission.
     23  *
     24  * THIS SOFTWARE IS A COMPONENT OF 386BSD DEVELOPED BY WILLIAM F. JOLITZ
     25  * AND IS INTENDED FOR RESEARCH AND EDUCATIONAL PURPOSES ONLY. THIS
     26  * SOFTWARE SHOULD NOT BE CONSIDERED TO BE A COMMERCIAL PRODUCT.
     27  * THE DEVELOPER URGES THAT USERS WHO REQUIRE A COMMERCIAL PRODUCT
     28  * NOT MAKE USE OF THIS WORK.
     29  *
     30  * FOR USERS WHO WISH TO UNDERSTAND THE 386BSD SYSTEM DEVELOPED
     31  * BY WILLIAM F. JOLITZ, WE RECOMMEND THE USER STUDY WRITTEN
     32  * REFERENCES SUCH AS THE  "PORTING UNIX TO THE 386" SERIES
     33  * (BEGINNING JANUARY 1991 "DR. DOBBS JOURNAL", USA AND BEGINNING
     34  * JUNE 1991 "UNIX MAGAZIN", GERMANY) BY WILLIAM F. JOLITZ AND
     35  * LYNNE GREER JOLITZ, AS WELL AS OTHER BOOKS ON UNIX AND THE
     36  * ON-LINE 386BSD USER MANUAL BEFORE USE. A BOOK DISCUSSING THE INTERNALS
     37  * OF 386BSD ENTITLED "386BSD FROM THE INSIDE OUT" WILL BE AVAILABLE LATE 1992.
     38  *
     39  * THIS SOFTWARE IS PROVIDED BY THE DEVELOPER ``AS IS'' AND
     40  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     41  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     42  * ARE DISCLAIMED.  IN NO EVENT SHALL THE DEVELOPER BE LIABLE
     43  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     44  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     45  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     46  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     47  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     48  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     49  * SUCH DAMAGE.
     50  */
     51 
     52 /*
     53  * Device Driver for AT style parallel printer port
     54  */
     55 
     56 #include <sys/cdefs.h>
     57 __KERNEL_RCSID(0, "$NetBSD: lpt.c,v 1.58 2001/11/13 13:14:40 lukem Exp $");
     58 
     59 #include <sys/param.h>
     60 #include <sys/systm.h>
     61 #include <sys/proc.h>
     62 #include <sys/user.h>
     63 #include <sys/malloc.h>
     64 #include <sys/kernel.h>
     65 #include <sys/ioctl.h>
     66 #include <sys/uio.h>
     67 #include <sys/device.h>
     68 #include <sys/conf.h>
     69 #include <sys/syslog.h>
     70 
     71 #include <machine/bus.h>
     72 #include <machine/intr.h>
     73 
     74 #include <dev/ic/lptreg.h>
     75 #include <dev/ic/lptvar.h>
     76 
     77 #define	TIMEOUT		hz*16	/* wait up to 16 seconds for a ready */
     78 #define	STEP		hz/4
     79 
     80 #define	LPTPRI		(PZERO+8)
     81 #define	LPT_BSIZE	1024
     82 
     83 #define LPTDEBUG
     84 
     85 #ifndef LPTDEBUG
     86 #define LPRINTF(a)
     87 #else
     88 #define LPRINTF(a)	if (lptdebug) printf a
     89 int lptdebug = 0;
     90 #endif
     91 
     92 /* XXX does not belong here */
     93 cdev_decl(lpt);
     94 
     95 extern struct cfdriver lpt_cd;
     96 
     97 #define	LPTUNIT(s)	(minor(s) & 0x1f)
     98 #define	LPTFLAGS(s)	(minor(s) & 0xe0)
     99 
    100 void
    101 lpt_attach_subr(sc)
    102 	struct lpt_softc *sc;
    103 {
    104 	bus_space_tag_t iot;
    105 	bus_space_handle_t ioh;
    106 
    107 	sc->sc_state = 0;
    108 
    109 	iot = sc->sc_iot;
    110 	ioh = sc->sc_ioh;
    111 
    112 	bus_space_write_1(iot, ioh, lpt_control, LPC_NINIT);
    113 
    114 	callout_init(&sc->sc_wakeup_ch);
    115 
    116 	sc->sc_dev_ok = 1;
    117 }
    118 
    119 /*
    120  * Reset the printer, then wait until it's selected and not busy.
    121  */
    122 int
    123 lptopen(dev, flag, mode, p)
    124 	dev_t dev;
    125 	int flag;
    126 	int mode;
    127 	struct proc *p;
    128 {
    129 	u_char flags = LPTFLAGS(dev);
    130 	struct lpt_softc *sc;
    131 	bus_space_tag_t iot;
    132 	bus_space_handle_t ioh;
    133 	u_char control;
    134 	int error;
    135 	int spin;
    136 
    137 	sc = device_lookup(&lpt_cd, LPTUNIT(dev));
    138 	if (!sc || !sc->sc_dev_ok)
    139 		return ENXIO;
    140 
    141 #if 0	/* XXX what to do? */
    142 	if (sc->sc_irq == IRQUNK && (flags & LPT_NOINTR) == 0)
    143 		return ENXIO;
    144 #endif
    145 
    146 #ifdef DIAGNOSTIC
    147 	if (sc->sc_state)
    148 		printf("%s: stat=0x%x not zero\n", sc->sc_dev.dv_xname,
    149 		    sc->sc_state);
    150 #endif
    151 
    152 	if (sc->sc_state)
    153 		return EBUSY;
    154 
    155 	sc->sc_state = LPT_INIT;
    156 	sc->sc_flags = flags;
    157 	LPRINTF(("%s: open: flags=0x%x\n", sc->sc_dev.dv_xname,
    158 	    (unsigned)flags));
    159 	iot = sc->sc_iot;
    160 	ioh = sc->sc_ioh;
    161 
    162 	if ((flags & LPT_NOPRIME) == 0) {
    163 		/* assert INIT for 100 usec to start up printer */
    164 		bus_space_write_1(iot, ioh, lpt_control, LPC_SELECT);
    165 		delay(100);
    166 	}
    167 
    168 	control = LPC_SELECT | LPC_NINIT;
    169 	bus_space_write_1(iot, ioh, lpt_control, control);
    170 
    171 	/* wait till ready (printer running diagnostics) */
    172 	for (spin = 0; NOT_READY_ERR(); spin += STEP) {
    173 		if (spin >= TIMEOUT) {
    174 			sc->sc_state = 0;
    175 			return EBUSY;
    176 		}
    177 
    178 		/* wait 1/4 second, give up if we get a signal */
    179 		error = tsleep((caddr_t)sc, LPTPRI | PCATCH, "lptopen", STEP);
    180 		if (error != EWOULDBLOCK) {
    181 			sc->sc_state = 0;
    182 			return error;
    183 		}
    184 	}
    185 
    186 	if ((flags & LPT_NOINTR) == 0)
    187 		control |= LPC_IENABLE;
    188 	if (flags & LPT_AUTOLF)
    189 		control |= LPC_AUTOLF;
    190 	sc->sc_control = control;
    191 	bus_space_write_1(iot, ioh, lpt_control, control);
    192 
    193 	sc->sc_inbuf = malloc(LPT_BSIZE, M_DEVBUF, M_WAITOK);
    194 	sc->sc_count = 0;
    195 	sc->sc_state = LPT_OPEN;
    196 
    197 	if ((sc->sc_flags & LPT_NOINTR) == 0)
    198 		lptwakeup(sc);
    199 
    200 	LPRINTF(("%s: opened\n", sc->sc_dev.dv_xname));
    201 	return 0;
    202 }
    203 
    204 int
    205 lptnotready(status, sc)
    206 	u_char status;
    207 	struct lpt_softc *sc;
    208 {
    209 	u_char new;
    210 
    211 	status = (status ^ LPS_INVERT) & LPS_MASK;
    212 	new = status & ~sc->sc_laststatus;
    213 	sc->sc_laststatus = status;
    214 
    215 	if (sc->sc_state & LPT_OPEN) {
    216 		if (new & LPS_SELECT)
    217 			log(LOG_NOTICE,
    218 			    "%s: offline\n", sc->sc_dev.dv_xname);
    219 		else if (new & LPS_NOPAPER)
    220 			log(LOG_NOTICE,
    221 			    "%s: out of paper\n", sc->sc_dev.dv_xname);
    222 		else if (new & LPS_NERR)
    223 			log(LOG_NOTICE,
    224 			    "%s: output error\n", sc->sc_dev.dv_xname);
    225 	}
    226 
    227 	return status;
    228 }
    229 
    230 void
    231 lptwakeup(arg)
    232 	void *arg;
    233 {
    234 	struct lpt_softc *sc = arg;
    235 	int s;
    236 
    237 	s = spllpt();
    238 	lptintr(sc);
    239 	splx(s);
    240 
    241 	callout_reset(&sc->sc_wakeup_ch, STEP, lptwakeup, sc);
    242 }
    243 
    244 /*
    245  * Close the device, and free the local line buffer.
    246  */
    247 int
    248 lptclose(dev, flag, mode, p)
    249 	dev_t dev;
    250 	int flag;
    251 	int mode;
    252 	struct proc *p;
    253 {
    254 	struct lpt_softc *sc = device_lookup(&lpt_cd, LPTUNIT(dev));
    255 	bus_space_tag_t iot = sc->sc_iot;
    256 	bus_space_handle_t ioh = sc->sc_ioh;
    257 
    258 	if (sc->sc_count)
    259 		(void) lptpushbytes(sc);
    260 
    261 	if ((sc->sc_flags & LPT_NOINTR) == 0)
    262 		callout_stop(&sc->sc_wakeup_ch);
    263 
    264 	bus_space_write_1(iot, ioh, lpt_control, LPC_NINIT);
    265 	sc->sc_state = 0;
    266 	bus_space_write_1(iot, ioh, lpt_control, LPC_NINIT);
    267 	free(sc->sc_inbuf, M_DEVBUF);
    268 
    269 	LPRINTF(("%s: closed\n", sc->sc_dev.dv_xname));
    270 	return 0;
    271 }
    272 
    273 int
    274 lptpushbytes(sc)
    275 	struct lpt_softc *sc;
    276 {
    277 	bus_space_tag_t iot = sc->sc_iot;
    278 	bus_space_handle_t ioh = sc->sc_ioh;
    279 	int error;
    280 
    281 	if (sc->sc_flags & LPT_NOINTR) {
    282 		int spin, tic;
    283 		u_char control = sc->sc_control;
    284 
    285 		while (sc->sc_count > 0) {
    286 			spin = 0;
    287 			while (NOT_READY()) {
    288 				if (++spin < sc->sc_spinmax)
    289 					continue;
    290 				tic = 0;
    291 				/* adapt busy-wait algorithm */
    292 				sc->sc_spinmax++;
    293 				while (NOT_READY_ERR()) {
    294 					/* exponential backoff */
    295 					tic = tic + tic + 1;
    296 					if (tic > TIMEOUT)
    297 						tic = TIMEOUT;
    298 					error = tsleep((caddr_t)sc,
    299 					    LPTPRI | PCATCH, "lptpsh", tic);
    300 					if (error != EWOULDBLOCK)
    301 						return error;
    302 				}
    303 				break;
    304 			}
    305 
    306 			bus_space_write_1(iot, ioh, lpt_data, *sc->sc_cp++);
    307 			bus_space_write_1(iot, ioh, lpt_control,
    308 			    control | LPC_STROBE);
    309 			sc->sc_count--;
    310 			bus_space_write_1(iot, ioh, lpt_control, control);
    311 
    312 			/* adapt busy-wait algorithm */
    313 			if (spin*2 + 16 < sc->sc_spinmax)
    314 				sc->sc_spinmax--;
    315 		}
    316 	} else {
    317 		int s;
    318 
    319 		while (sc->sc_count > 0) {
    320 			/* if the printer is ready for a char, give it one */
    321 			if ((sc->sc_state & LPT_OBUSY) == 0) {
    322 				LPRINTF(("%s: write %lu\n", sc->sc_dev.dv_xname,
    323 				    (u_long)sc->sc_count));
    324 				s = spllpt();
    325 				(void) lptintr(sc);
    326 				splx(s);
    327 			}
    328 			error = tsleep((caddr_t)sc, LPTPRI | PCATCH,
    329 			    "lptwrite2", 0);
    330 			if (error)
    331 				return error;
    332 		}
    333 	}
    334 	return 0;
    335 }
    336 
    337 /*
    338  * Copy a line from user space to a local buffer, then call putc to get the
    339  * chars moved to the output queue.
    340  */
    341 int
    342 lptwrite(dev, uio, flags)
    343 	dev_t dev;
    344 	struct uio *uio;
    345 	int flags;
    346 {
    347 	struct lpt_softc *sc = device_lookup(&lpt_cd, LPTUNIT(dev));
    348 	size_t n;
    349 	int error = 0;
    350 
    351 	while ((n = min(LPT_BSIZE, uio->uio_resid)) != 0) {
    352 		uiomove(sc->sc_cp = sc->sc_inbuf, n, uio);
    353 		sc->sc_count = n;
    354 		error = lptpushbytes(sc);
    355 		if (error) {
    356 			/*
    357 			 * Return accurate residual if interrupted or timed
    358 			 * out.
    359 			 */
    360 			uio->uio_resid += sc->sc_count;
    361 			sc->sc_count = 0;
    362 			return error;
    363 		}
    364 	}
    365 	return 0;
    366 }
    367 
    368 /*
    369  * Handle printer interrupts which occur when the printer is ready to accept
    370  * another char.
    371  */
    372 int
    373 lptintr(arg)
    374 	void *arg;
    375 {
    376 	struct lpt_softc *sc = arg;
    377 	bus_space_tag_t iot = sc->sc_iot;
    378 	bus_space_handle_t ioh = sc->sc_ioh;
    379 
    380 #if 0
    381 	if ((sc->sc_state & LPT_OPEN) == 0)
    382 		return 0;
    383 #endif
    384 
    385 	/* is printer online and ready for output */
    386 	if (NOT_READY() && NOT_READY_ERR())
    387 		return 0;
    388 
    389 	if (sc->sc_count) {
    390 		u_char control = sc->sc_control;
    391 		/* send char */
    392 		bus_space_write_1(iot, ioh, lpt_data, *sc->sc_cp++);
    393 		DELAY(1);
    394 		bus_space_write_1(iot, ioh, lpt_control, control | LPC_STROBE);
    395 		DELAY(1);
    396 		sc->sc_count--;
    397 		bus_space_write_1(iot, ioh, lpt_control, control);
    398 		sc->sc_state |= LPT_OBUSY;
    399 	} else
    400 		sc->sc_state &= ~LPT_OBUSY;
    401 
    402 	if (sc->sc_count == 0) {
    403 		/* none, wake up the top half to get more */
    404 		wakeup((caddr_t)sc);
    405 	}
    406 
    407 	return 1;
    408 }
    409 
    410 int
    411 lptioctl(dev, cmd, data, flag, p)
    412 	dev_t dev;
    413 	u_long cmd;
    414 	caddr_t data;
    415 	int flag;
    416 	struct proc *p;
    417 {
    418 	int error = 0;
    419 
    420 	switch (cmd) {
    421 	default:
    422 		error = ENODEV;
    423 	}
    424 
    425 	return error;
    426 }
    427