Home | History | Annotate | Line # | Download | only in ic
lpt.c revision 1.52
      1 /*	$NetBSD: lpt.c,v 1.52 1998/10/14 20:09:06 perry 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/param.h>
     57 #include <sys/systm.h>
     58 #include <sys/proc.h>
     59 #include <sys/user.h>
     60 #include <sys/malloc.h>
     61 #include <sys/kernel.h>
     62 #include <sys/ioctl.h>
     63 #include <sys/uio.h>
     64 #include <sys/device.h>
     65 #include <sys/conf.h>
     66 #include <sys/syslog.h>
     67 
     68 #include <machine/bus.h>
     69 #include <machine/intr.h>
     70 
     71 #include <dev/ic/lptreg.h>
     72 #include <dev/ic/lptvar.h>
     73 
     74 #define	TIMEOUT		hz*16	/* wait up to 16 seconds for a ready */
     75 #define	STEP		hz/4
     76 
     77 #define	LPTPRI		(PZERO+8)
     78 #define	LPT_BSIZE	1024
     79 
     80 #define LPTDEBUG
     81 
     82 #ifndef LPTDEBUG
     83 #define LPRINTF(a)
     84 #else
     85 #define LPRINTF(a)	if (lptdebug) printf a
     86 int lptdebug = 0;
     87 #endif
     88 
     89 /* XXX does not belong here */
     90 cdev_decl(lpt);
     91 
     92 extern struct cfdriver lpt_cd;
     93 
     94 #define	LPTUNIT(s)	(minor(s) & 0x1f)
     95 #define	LPTFLAGS(s)	(minor(s) & 0xe0)
     96 
     97 void
     98 lpt_attach_subr(sc)
     99 	struct lpt_softc *sc;
    100 {
    101 	bus_space_tag_t iot;
    102 	bus_space_handle_t ioh;
    103 
    104 	sc->sc_state = 0;
    105 
    106 	iot = sc->sc_iot;
    107 	ioh = sc->sc_ioh;
    108 
    109 	bus_space_write_1(iot, ioh, lpt_control, LPC_NINIT);
    110 
    111 	sc->sc_dev_ok = 1;
    112 }
    113 
    114 /*
    115  * Reset the printer, then wait until it's selected and not busy.
    116  */
    117 int
    118 lptopen(dev, flag, mode, p)
    119 	dev_t dev;
    120 	int flag;
    121 	int mode;
    122 	struct proc *p;
    123 {
    124 	int unit = LPTUNIT(dev);
    125 	u_char flags = LPTFLAGS(dev);
    126 	struct lpt_softc *sc;
    127 	bus_space_tag_t iot;
    128 	bus_space_handle_t ioh;
    129 	u_char control;
    130 	int error;
    131 	int spin;
    132 
    133 	if (unit >= lpt_cd.cd_ndevs)
    134 		return ENXIO;
    135 	sc = lpt_cd.cd_devs[unit];
    136 	if (!sc || !sc->sc_dev_ok)
    137 		return ENXIO;
    138 
    139 #if 0	/* XXX what to do? */
    140 	if (sc->sc_irq == IRQUNK && (flags & LPT_NOINTR) == 0)
    141 		return ENXIO;
    142 #endif
    143 
    144 #ifdef DIAGNOSTIC
    145 	if (sc->sc_state)
    146 		printf("%s: stat=0x%x not zero\n", sc->sc_dev.dv_xname,
    147 		    sc->sc_state);
    148 #endif
    149 
    150 	if (sc->sc_state)
    151 		return EBUSY;
    152 
    153 	sc->sc_state = LPT_INIT;
    154 	sc->sc_flags = flags;
    155 	LPRINTF(("%s: open: flags=0x%x\n", sc->sc_dev.dv_xname,
    156 	    (unsigned)flags));
    157 	iot = sc->sc_iot;
    158 	ioh = sc->sc_ioh;
    159 
    160 	if ((flags & LPT_NOPRIME) == 0) {
    161 		/* assert INIT for 100 usec to start up printer */
    162 		bus_space_write_1(iot, ioh, lpt_control, LPC_SELECT);
    163 		delay(100);
    164 	}
    165 
    166 	control = LPC_SELECT | LPC_NINIT;
    167 	bus_space_write_1(iot, ioh, lpt_control, control);
    168 
    169 	/* wait till ready (printer running diagnostics) */
    170 	for (spin = 0; NOT_READY_ERR(); spin += STEP) {
    171 		if (spin >= TIMEOUT) {
    172 			sc->sc_state = 0;
    173 			return EBUSY;
    174 		}
    175 
    176 		/* wait 1/4 second, give up if we get a signal */
    177 		error = tsleep((caddr_t)sc, LPTPRI | PCATCH, "lptopen", STEP);
    178 		if (error != EWOULDBLOCK) {
    179 			sc->sc_state = 0;
    180 			return error;
    181 		}
    182 	}
    183 
    184 	if ((flags & LPT_NOINTR) == 0)
    185 		control |= LPC_IENABLE;
    186 	if (flags & LPT_AUTOLF)
    187 		control |= LPC_AUTOLF;
    188 	sc->sc_control = control;
    189 	bus_space_write_1(iot, ioh, lpt_control, control);
    190 
    191 	sc->sc_inbuf = malloc(LPT_BSIZE, M_DEVBUF, M_WAITOK);
    192 	sc->sc_count = 0;
    193 	sc->sc_state = LPT_OPEN;
    194 
    195 	if ((sc->sc_flags & LPT_NOINTR) == 0)
    196 		lptwakeup(sc);
    197 
    198 	LPRINTF(("%s: opened\n", sc->sc_dev.dv_xname));
    199 	return 0;
    200 }
    201 
    202 int
    203 lptnotready(status, sc)
    204 	u_char status;
    205 	struct lpt_softc *sc;
    206 {
    207 	u_char new;
    208 
    209 	status = (status ^ LPS_INVERT) & LPS_MASK;
    210 	new = status & ~sc->sc_laststatus;
    211 	sc->sc_laststatus = status;
    212 
    213 	if (sc->sc_state & LPT_OPEN) {
    214 		if (new & LPS_SELECT)
    215 			log(LOG_NOTICE,
    216 			    "%s: offline\n", sc->sc_dev.dv_xname);
    217 		else if (new & LPS_NOPAPER)
    218 			log(LOG_NOTICE,
    219 			    "%s: out of paper\n", sc->sc_dev.dv_xname);
    220 		else if (new & LPS_NERR)
    221 			log(LOG_NOTICE,
    222 			    "%s: output error\n", sc->sc_dev.dv_xname);
    223 	}
    224 
    225 	return status;
    226 }
    227 
    228 void
    229 lptwakeup(arg)
    230 	void *arg;
    231 {
    232 	struct lpt_softc *sc = arg;
    233 	int s;
    234 
    235 	s = spllpt();
    236 	lptintr(sc);
    237 	splx(s);
    238 
    239 	timeout(lptwakeup, sc, STEP);
    240 }
    241 
    242 /*
    243  * Close the device, and free the local line buffer.
    244  */
    245 int
    246 lptclose(dev, flag, mode, p)
    247 	dev_t dev;
    248 	int flag;
    249 	int mode;
    250 	struct proc *p;
    251 {
    252 	int unit = LPTUNIT(dev);
    253 	struct lpt_softc *sc = lpt_cd.cd_devs[unit];
    254 	bus_space_tag_t iot = sc->sc_iot;
    255 	bus_space_handle_t ioh = sc->sc_ioh;
    256 
    257 	if (sc->sc_count)
    258 		(void) lptpushbytes(sc);
    259 
    260 	if ((sc->sc_flags & LPT_NOINTR) == 0)
    261 		untimeout(lptwakeup, sc);
    262 
    263 	bus_space_write_1(iot, ioh, lpt_control, LPC_NINIT);
    264 	sc->sc_state = 0;
    265 	bus_space_write_1(iot, ioh, lpt_control, LPC_NINIT);
    266 	free(sc->sc_inbuf, M_DEVBUF);
    267 
    268 	LPRINTF(("%s: closed\n", sc->sc_dev.dv_xname));
    269 	return 0;
    270 }
    271 
    272 int
    273 lptpushbytes(sc)
    274 	struct lpt_softc *sc;
    275 {
    276 	bus_space_tag_t iot = sc->sc_iot;
    277 	bus_space_handle_t ioh = sc->sc_ioh;
    278 	int error;
    279 
    280 	if (sc->sc_flags & LPT_NOINTR) {
    281 		int spin, tic;
    282 		u_char control = sc->sc_control;
    283 
    284 		while (sc->sc_count > 0) {
    285 			spin = 0;
    286 			while (NOT_READY()) {
    287 				if (++spin < sc->sc_spinmax)
    288 					continue;
    289 				tic = 0;
    290 				/* adapt busy-wait algorithm */
    291 				sc->sc_spinmax++;
    292 				while (NOT_READY_ERR()) {
    293 					/* exponential backoff */
    294 					tic = tic + tic + 1;
    295 					if (tic > TIMEOUT)
    296 						tic = TIMEOUT;
    297 					error = tsleep((caddr_t)sc,
    298 					    LPTPRI | PCATCH, "lptpsh", tic);
    299 					if (error != EWOULDBLOCK)
    300 						return error;
    301 				}
    302 				break;
    303 			}
    304 
    305 			bus_space_write_1(iot, ioh, lpt_data, *sc->sc_cp++);
    306 			bus_space_write_1(iot, ioh, lpt_control,
    307 			    control | LPC_STROBE);
    308 			sc->sc_count--;
    309 			bus_space_write_1(iot, ioh, lpt_control, control);
    310 
    311 			/* adapt busy-wait algorithm */
    312 			if (spin*2 + 16 < sc->sc_spinmax)
    313 				sc->sc_spinmax--;
    314 		}
    315 	} else {
    316 		int s;
    317 
    318 		while (sc->sc_count > 0) {
    319 			/* if the printer is ready for a char, give it one */
    320 			if ((sc->sc_state & LPT_OBUSY) == 0) {
    321 				LPRINTF(("%s: write %u\n", sc->sc_dev.dv_xname,
    322 				    sc->sc_count));
    323 				s = spllpt();
    324 				(void) lptintr(sc);
    325 				splx(s);
    326 			}
    327 			error = tsleep((caddr_t)sc, LPTPRI | PCATCH,
    328 			    "lptwrite2", 0);
    329 			if (error)
    330 				return error;
    331 		}
    332 	}
    333 	return 0;
    334 }
    335 
    336 /*
    337  * Copy a line from user space to a local buffer, then call putc to get the
    338  * chars moved to the output queue.
    339  */
    340 int
    341 lptwrite(dev, uio, flags)
    342 	dev_t dev;
    343 	struct uio *uio;
    344 	int flags;
    345 {
    346 	struct lpt_softc *sc = lpt_cd.cd_devs[LPTUNIT(dev)];
    347 	size_t n;
    348 	int error = 0;
    349 
    350 	while ((n = min(LPT_BSIZE, uio->uio_resid)) != 0) {
    351 		uiomove(sc->sc_cp = sc->sc_inbuf, n, uio);
    352 		sc->sc_count = n;
    353 		error = lptpushbytes(sc);
    354 		if (error) {
    355 			/*
    356 			 * Return accurate residual if interrupted or timed
    357 			 * out.
    358 			 */
    359 			uio->uio_resid += sc->sc_count;
    360 			sc->sc_count = 0;
    361 			return error;
    362 		}
    363 	}
    364 	return 0;
    365 }
    366 
    367 /*
    368  * Handle printer interrupts which occur when the printer is ready to accept
    369  * another char.
    370  */
    371 int
    372 lptintr(arg)
    373 	void *arg;
    374 {
    375 	struct lpt_softc *sc = arg;
    376 	bus_space_tag_t iot = sc->sc_iot;
    377 	bus_space_handle_t ioh = sc->sc_ioh;
    378 
    379 #if 0
    380 	if ((sc->sc_state & LPT_OPEN) == 0)
    381 		return 0;
    382 #endif
    383 
    384 	/* is printer online and ready for output */
    385 	if (NOT_READY() && NOT_READY_ERR())
    386 		return 0;
    387 
    388 	if (sc->sc_count) {
    389 		u_char control = sc->sc_control;
    390 		/* send char */
    391 		bus_space_write_1(iot, ioh, lpt_data, *sc->sc_cp++);
    392 		bus_space_write_1(iot, ioh, lpt_control, control | LPC_STROBE);
    393 		sc->sc_count--;
    394 		bus_space_write_1(iot, ioh, lpt_control, control);
    395 		sc->sc_state |= LPT_OBUSY;
    396 	} else
    397 		sc->sc_state &= ~LPT_OBUSY;
    398 
    399 	if (sc->sc_count == 0) {
    400 		/* none, wake up the top half to get more */
    401 		wakeup((caddr_t)sc);
    402 	}
    403 
    404 	return 1;
    405 }
    406 
    407 int
    408 lptioctl(dev, cmd, data, flag, p)
    409 	dev_t dev;
    410 	u_long cmd;
    411 	caddr_t data;
    412 	int flag;
    413 	struct proc *p;
    414 {
    415 	int error = 0;
    416 
    417 	switch (cmd) {
    418 	default:
    419 		error = ENODEV;
    420 	}
    421 
    422 	return error;
    423 }
    424