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