xref: /linux/drivers/char/lp.c (revision bd628c1bed7902ec1f24ba0fe70758949146abbe)
1 /*
2  * Generic parallel printer driver
3  *
4  * Copyright (C) 1992 by Jim Weigand and Linus Torvalds
5  * Copyright (C) 1992,1993 by Michael K. Johnson
6  * - Thanks much to Gunter Windau for pointing out to me where the error
7  *   checking ought to be.
8  * Copyright (C) 1993 by Nigel Gamble (added interrupt code)
9  * Copyright (C) 1994 by Alan Cox (Modularised it)
10  * LPCAREFUL, LPABORT, LPGETSTATUS added by Chris Metcalf, metcalf@lcs.mit.edu
11  * Statistics and support for slow printers by Rob Janssen, rob@knoware.nl
12  * "lp=" command line parameters added by Grant Guenther, grant@torque.net
13  * lp_read (Status readback) support added by Carsten Gross,
14  *                                             carsten@sol.wohnheim.uni-ulm.de
15  * Support for parport by Philip Blundell <philb@gnu.org>
16  * Parport sharing hacking by Andrea Arcangeli
17  * Fixed kernel_(to/from)_user memory copy to check for errors
18  * 				by Riccardo Facchetti <fizban@tin.it>
19  * 22-JAN-1998  Added support for devfs  Richard Gooch <rgooch@atnf.csiro.au>
20  * Redesigned interrupt handling for handle printers with buggy handshake
21  *				by Andrea Arcangeli, 11 May 1998
22  * Full efficient handling of printer with buggy irq handshake (now I have
23  * understood the meaning of the strange handshake). This is done sending new
24  * characters if the interrupt is just happened, even if the printer say to
25  * be still BUSY. This is needed at least with Epson Stylus Color. To enable
26  * the new TRUST_IRQ mode read the `LP OPTIMIZATION' section below...
27  * Fixed the irq on the rising edge of the strobe case.
28  * Obsoleted the CAREFUL flag since a printer that doesn' t work with
29  * CAREFUL will block a bit after in lp_check_status().
30  *				Andrea Arcangeli, 15 Oct 1998
31  * Obsoleted and removed all the lowlevel stuff implemented in the last
32  * month to use the IEEE1284 functions (that handle the _new_ compatibilty
33  * mode fine).
34  */
35 
36 /* This driver should, in theory, work with any parallel port that has an
37  * appropriate low-level driver; all I/O is done through the parport
38  * abstraction layer.
39  *
40  * If this driver is built into the kernel, you can configure it using the
41  * kernel command-line.  For example:
42  *
43  *	lp=parport1,none,parport2	(bind lp0 to parport1, disable lp1 and
44  *					 bind lp2 to parport2)
45  *
46  *	lp=auto				(assign lp devices to all ports that
47  *				         have printers attached, as determined
48  *					 by the IEEE-1284 autoprobe)
49  *
50  *	lp=reset			(reset the printer during
51  *					 initialisation)
52  *
53  *	lp=off				(disable the printer driver entirely)
54  *
55  * If the driver is loaded as a module, similar functionality is available
56  * using module parameters.  The equivalent of the above commands would be:
57  *
58  *	# insmod lp.o parport=1,none,2
59  *
60  *	# insmod lp.o parport=auto
61  *
62  *	# insmod lp.o reset=1
63  */
64 
65 /* COMPATIBILITY WITH OLD KERNELS
66  *
67  * Under Linux 2.0 and previous versions, lp devices were bound to ports at
68  * particular I/O addresses, as follows:
69  *
70  *	lp0		0x3bc
71  *	lp1		0x378
72  *	lp2		0x278
73  *
74  * The new driver, by default, binds lp devices to parport devices as it
75  * finds them.  This means that if you only have one port, it will be bound
76  * to lp0 regardless of its I/O address.  If you need the old behaviour, you
77  * can force it using the parameters described above.
78  */
79 
80 /*
81  * The new interrupt handling code take care of the buggy handshake
82  * of some HP and Epson printer:
83  * ___
84  * ACK    _______________    ___________
85  *                       |__|
86  * ____
87  * BUSY   _________              _______
88  *                 |____________|
89  *
90  * I discovered this using the printer scanner that you can find at:
91  *
92  *	ftp://e-mind.com/pub/linux/pscan/
93  *
94  *					11 May 98, Andrea Arcangeli
95  *
96  * My printer scanner run on an Epson Stylus Color show that such printer
97  * generates the irq on the _rising_ edge of the STROBE. Now lp handle
98  * this case fine too.
99  *
100  *					15 Oct 1998, Andrea Arcangeli
101  *
102  * The so called `buggy' handshake is really the well documented
103  * compatibility mode IEEE1284 handshake. They changed the well known
104  * Centronics handshake acking in the middle of busy expecting to not
105  * break drivers or legacy application, while they broken linux lp
106  * until I fixed it reverse engineering the protocol by hand some
107  * month ago...
108  *
109  *                                     14 Dec 1998, Andrea Arcangeli
110  *
111  * Copyright (C) 2000 by Tim Waugh (added LPSETTIMEOUT ioctl)
112  */
113 
114 #include <linux/module.h>
115 #include <linux/init.h>
116 
117 #include <linux/errno.h>
118 #include <linux/kernel.h>
119 #include <linux/major.h>
120 #include <linux/sched/signal.h>
121 #include <linux/slab.h>
122 #include <linux/fcntl.h>
123 #include <linux/delay.h>
124 #include <linux/poll.h>
125 #include <linux/console.h>
126 #include <linux/device.h>
127 #include <linux/wait.h>
128 #include <linux/jiffies.h>
129 #include <linux/mutex.h>
130 #include <linux/compat.h>
131 
132 #include <linux/parport.h>
133 #undef LP_STATS
134 #include <linux/lp.h>
135 
136 #include <asm/irq.h>
137 #include <linux/uaccess.h>
138 
139 /* if you have more than 8 printers, remember to increase LP_NO */
140 #define LP_NO 8
141 
142 static DEFINE_MUTEX(lp_mutex);
143 static struct lp_struct lp_table[LP_NO];
144 static int port_num[LP_NO];
145 
146 static unsigned int lp_count = 0;
147 static struct class *lp_class;
148 
149 #ifdef CONFIG_LP_CONSOLE
150 static struct parport *console_registered;
151 #endif /* CONFIG_LP_CONSOLE */
152 
153 #undef LP_DEBUG
154 
155 /* Bits used to manage claiming the parport device */
156 #define LP_PREEMPT_REQUEST 1
157 #define LP_PARPORT_CLAIMED 2
158 
159 /* --- low-level port access ----------------------------------- */
160 
161 #define r_dtr(x)	(parport_read_data(lp_table[(x)].dev->port))
162 #define r_str(x)	(parport_read_status(lp_table[(x)].dev->port))
163 #define w_ctr(x,y)	do { parport_write_control(lp_table[(x)].dev->port, (y)); } while (0)
164 #define w_dtr(x,y)	do { parport_write_data(lp_table[(x)].dev->port, (y)); } while (0)
165 
166 /* Claim the parport or block trying unless we've already claimed it */
167 static void lp_claim_parport_or_block(struct lp_struct *this_lp)
168 {
169 	if (!test_and_set_bit(LP_PARPORT_CLAIMED, &this_lp->bits)) {
170 		parport_claim_or_block(this_lp->dev);
171 	}
172 }
173 
174 /* Claim the parport or block trying unless we've already claimed it */
175 static void lp_release_parport(struct lp_struct *this_lp)
176 {
177 	if (test_and_clear_bit(LP_PARPORT_CLAIMED, &this_lp->bits)) {
178 		parport_release(this_lp->dev);
179 	}
180 }
181 
182 
183 
184 static int lp_preempt(void *handle)
185 {
186 	struct lp_struct *this_lp = (struct lp_struct *)handle;
187 	set_bit(LP_PREEMPT_REQUEST, &this_lp->bits);
188 	return 1;
189 }
190 
191 
192 /*
193  * Try to negotiate to a new mode; if unsuccessful negotiate to
194  * compatibility mode.  Return the mode we ended up in.
195  */
196 static int lp_negotiate(struct parport *port, int mode)
197 {
198 	if (parport_negotiate(port, mode) != 0) {
199 		mode = IEEE1284_MODE_COMPAT;
200 		parport_negotiate(port, mode);
201 	}
202 
203 	return mode;
204 }
205 
206 static int lp_reset(int minor)
207 {
208 	int retval;
209 	lp_claim_parport_or_block(&lp_table[minor]);
210 	w_ctr(minor, LP_PSELECP);
211 	udelay(LP_DELAY);
212 	w_ctr(minor, LP_PSELECP | LP_PINITP);
213 	retval = r_str(minor);
214 	lp_release_parport(&lp_table[minor]);
215 	return retval;
216 }
217 
218 static void lp_error(int minor)
219 {
220 	DEFINE_WAIT(wait);
221 	int polling;
222 
223 	if (LP_F(minor) & LP_ABORT)
224 		return;
225 
226 	polling = lp_table[minor].dev->port->irq == PARPORT_IRQ_NONE;
227 	if (polling)
228 		lp_release_parport(&lp_table[minor]);
229 	prepare_to_wait(&lp_table[minor].waitq, &wait, TASK_INTERRUPTIBLE);
230 	schedule_timeout(LP_TIMEOUT_POLLED);
231 	finish_wait(&lp_table[minor].waitq, &wait);
232 	if (polling)
233 		lp_claim_parport_or_block(&lp_table[minor]);
234 	else
235 		parport_yield_blocking(lp_table[minor].dev);
236 }
237 
238 static int lp_check_status(int minor)
239 {
240 	int error = 0;
241 	unsigned int last = lp_table[minor].last_error;
242 	unsigned char status = r_str(minor);
243 	if ((status & LP_PERRORP) && !(LP_F(minor) & LP_CAREFUL))
244 		/* No error. */
245 		last = 0;
246 	else if ((status & LP_POUTPA)) {
247 		if (last != LP_POUTPA) {
248 			last = LP_POUTPA;
249 			printk(KERN_INFO "lp%d out of paper\n", minor);
250 		}
251 		error = -ENOSPC;
252 	} else if (!(status & LP_PSELECD)) {
253 		if (last != LP_PSELECD) {
254 			last = LP_PSELECD;
255 			printk(KERN_INFO "lp%d off-line\n", minor);
256 		}
257 		error = -EIO;
258 	} else if (!(status & LP_PERRORP)) {
259 		if (last != LP_PERRORP) {
260 			last = LP_PERRORP;
261 			printk(KERN_INFO "lp%d on fire\n", minor);
262 		}
263 		error = -EIO;
264 	} else {
265 		last = 0; /* Come here if LP_CAREFUL is set and no
266 			     errors are reported. */
267 	}
268 
269 	lp_table[minor].last_error = last;
270 
271 	if (last != 0)
272 		lp_error(minor);
273 
274 	return error;
275 }
276 
277 static int lp_wait_ready(int minor, int nonblock)
278 {
279 	int error = 0;
280 
281 	/* If we're not in compatibility mode, we're ready now! */
282 	if (lp_table[minor].current_mode != IEEE1284_MODE_COMPAT) {
283 		return 0;
284 	}
285 
286 	do {
287 		error = lp_check_status(minor);
288 		if (error && (nonblock || (LP_F(minor) & LP_ABORT)))
289 			break;
290 		if (signal_pending(current)) {
291 			error = -EINTR;
292 			break;
293 		}
294 	} while (error);
295 	return error;
296 }
297 
298 static ssize_t lp_write(struct file *file, const char __user *buf,
299 			size_t count, loff_t *ppos)
300 {
301 	unsigned int minor = iminor(file_inode(file));
302 	struct parport *port = lp_table[minor].dev->port;
303 	char *kbuf = lp_table[minor].lp_buffer;
304 	ssize_t retv = 0;
305 	ssize_t written;
306 	size_t copy_size = count;
307 	int nonblock = ((file->f_flags & O_NONBLOCK) ||
308 			(LP_F(minor) & LP_ABORT));
309 
310 #ifdef LP_STATS
311 	if (time_after(jiffies, lp_table[minor].lastcall + LP_TIME(minor)))
312 		lp_table[minor].runchars = 0;
313 
314 	lp_table[minor].lastcall = jiffies;
315 #endif
316 
317 	/* Need to copy the data from user-space. */
318 	if (copy_size > LP_BUFFER_SIZE)
319 		copy_size = LP_BUFFER_SIZE;
320 
321 	if (mutex_lock_interruptible(&lp_table[minor].port_mutex))
322 		return -EINTR;
323 
324 	if (copy_from_user(kbuf, buf, copy_size)) {
325 		retv = -EFAULT;
326 		goto out_unlock;
327 	}
328 
329 	/* Claim Parport or sleep until it becomes available
330 	 */
331 	lp_claim_parport_or_block(&lp_table[minor]);
332 	/* Go to the proper mode. */
333 	lp_table[minor].current_mode = lp_negotiate(port,
334 						    lp_table[minor].best_mode);
335 
336 	parport_set_timeout(lp_table[minor].dev,
337 			    (nonblock ? PARPORT_INACTIVITY_O_NONBLOCK
338 			     : lp_table[minor].timeout));
339 
340 	if ((retv = lp_wait_ready(minor, nonblock)) == 0)
341 	do {
342 		/* Write the data. */
343 		written = parport_write(port, kbuf, copy_size);
344 		if (written > 0) {
345 			copy_size -= written;
346 			count -= written;
347 			buf  += written;
348 			retv += written;
349 		}
350 
351 		if (signal_pending(current)) {
352 			if (retv == 0)
353 				retv = -EINTR;
354 
355 			break;
356 		}
357 
358 		if (copy_size > 0) {
359 			/* incomplete write -> check error ! */
360 			int error;
361 
362 			parport_negotiate(lp_table[minor].dev->port,
363 					  IEEE1284_MODE_COMPAT);
364 			lp_table[minor].current_mode = IEEE1284_MODE_COMPAT;
365 
366 			error = lp_wait_ready(minor, nonblock);
367 
368 			if (error) {
369 				if (retv == 0)
370 					retv = error;
371 				break;
372 			} else if (nonblock) {
373 				if (retv == 0)
374 					retv = -EAGAIN;
375 				break;
376 			}
377 
378 			parport_yield_blocking(lp_table[minor].dev);
379 			lp_table[minor].current_mode
380 			  = lp_negotiate(port,
381 					 lp_table[minor].best_mode);
382 
383 		} else if (need_resched())
384 			schedule();
385 
386 		if (count) {
387 			copy_size = count;
388 			if (copy_size > LP_BUFFER_SIZE)
389 				copy_size = LP_BUFFER_SIZE;
390 
391 			if (copy_from_user(kbuf, buf, copy_size)) {
392 				if (retv == 0)
393 					retv = -EFAULT;
394 				break;
395 			}
396 		}
397 	} while (count > 0);
398 
399 	if (test_and_clear_bit(LP_PREEMPT_REQUEST,
400 			       &lp_table[minor].bits)) {
401 		printk(KERN_INFO "lp%d releasing parport\n", minor);
402 		parport_negotiate(lp_table[minor].dev->port,
403 				  IEEE1284_MODE_COMPAT);
404 		lp_table[minor].current_mode = IEEE1284_MODE_COMPAT;
405 		lp_release_parport(&lp_table[minor]);
406 	}
407 out_unlock:
408 	mutex_unlock(&lp_table[minor].port_mutex);
409 
410 	return retv;
411 }
412 
413 #ifdef CONFIG_PARPORT_1284
414 
415 /* Status readback conforming to ieee1284 */
416 static ssize_t lp_read(struct file *file, char __user *buf,
417 		       size_t count, loff_t *ppos)
418 {
419 	DEFINE_WAIT(wait);
420 	unsigned int minor=iminor(file_inode(file));
421 	struct parport *port = lp_table[minor].dev->port;
422 	ssize_t retval = 0;
423 	char *kbuf = lp_table[minor].lp_buffer;
424 	int nonblock = ((file->f_flags & O_NONBLOCK) ||
425 			(LP_F(minor) & LP_ABORT));
426 
427 	if (count > LP_BUFFER_SIZE)
428 		count = LP_BUFFER_SIZE;
429 
430 	if (mutex_lock_interruptible(&lp_table[minor].port_mutex))
431 		return -EINTR;
432 
433 	lp_claim_parport_or_block(&lp_table[minor]);
434 
435 	parport_set_timeout(lp_table[minor].dev,
436 			    (nonblock ? PARPORT_INACTIVITY_O_NONBLOCK
437 			     : lp_table[minor].timeout));
438 
439 	parport_negotiate(lp_table[minor].dev->port, IEEE1284_MODE_COMPAT);
440 	if (parport_negotiate(lp_table[minor].dev->port,
441 			      IEEE1284_MODE_NIBBLE)) {
442 		retval = -EIO;
443 		goto out;
444 	}
445 
446 	while (retval == 0) {
447 		retval = parport_read(port, kbuf, count);
448 
449 		if (retval > 0)
450 			break;
451 
452 		if (nonblock) {
453 			retval = -EAGAIN;
454 			break;
455 		}
456 
457 		/* Wait for data. */
458 
459 		if (lp_table[minor].dev->port->irq == PARPORT_IRQ_NONE) {
460 			parport_negotiate(lp_table[minor].dev->port,
461 					  IEEE1284_MODE_COMPAT);
462 			lp_error(minor);
463 			if (parport_negotiate(lp_table[minor].dev->port,
464 					      IEEE1284_MODE_NIBBLE)) {
465 				retval = -EIO;
466 				goto out;
467 			}
468 		} else {
469 			prepare_to_wait(&lp_table[minor].waitq, &wait, TASK_INTERRUPTIBLE);
470 			schedule_timeout(LP_TIMEOUT_POLLED);
471 			finish_wait(&lp_table[minor].waitq, &wait);
472 		}
473 
474 		if (signal_pending(current)) {
475 			retval = -ERESTARTSYS;
476 			break;
477 		}
478 
479 		cond_resched();
480 	}
481 	parport_negotiate(lp_table[minor].dev->port, IEEE1284_MODE_COMPAT);
482  out:
483 	lp_release_parport(&lp_table[minor]);
484 
485 	if (retval > 0 && copy_to_user(buf, kbuf, retval))
486 		retval = -EFAULT;
487 
488 	mutex_unlock(&lp_table[minor].port_mutex);
489 
490 	return retval;
491 }
492 
493 #endif /* IEEE 1284 support */
494 
495 static int lp_open(struct inode *inode, struct file *file)
496 {
497 	unsigned int minor = iminor(inode);
498 	int ret = 0;
499 
500 	mutex_lock(&lp_mutex);
501 	if (minor >= LP_NO) {
502 		ret = -ENXIO;
503 		goto out;
504 	}
505 	if ((LP_F(minor) & LP_EXIST) == 0) {
506 		ret = -ENXIO;
507 		goto out;
508 	}
509 	if (test_and_set_bit(LP_BUSY_BIT_POS, &LP_F(minor))) {
510 		ret = -EBUSY;
511 		goto out;
512 	}
513 	/* If ABORTOPEN is set and the printer is offline or out of paper,
514 	   we may still want to open it to perform ioctl()s.  Therefore we
515 	   have commandeered O_NONBLOCK, even though it is being used in
516 	   a non-standard manner.  This is strictly a Linux hack, and
517 	   should most likely only ever be used by the tunelp application. */
518 	if ((LP_F(minor) & LP_ABORTOPEN) && !(file->f_flags & O_NONBLOCK)) {
519 		int status;
520 		lp_claim_parport_or_block(&lp_table[minor]);
521 		status = r_str(minor);
522 		lp_release_parport(&lp_table[minor]);
523 		if (status & LP_POUTPA) {
524 			printk(KERN_INFO "lp%d out of paper\n", minor);
525 			LP_F(minor) &= ~LP_BUSY;
526 			ret = -ENOSPC;
527 			goto out;
528 		} else if (!(status & LP_PSELECD)) {
529 			printk(KERN_INFO "lp%d off-line\n", minor);
530 			LP_F(minor) &= ~LP_BUSY;
531 			ret = -EIO;
532 			goto out;
533 		} else if (!(status & LP_PERRORP)) {
534 			printk(KERN_ERR "lp%d printer error\n", minor);
535 			LP_F(minor) &= ~LP_BUSY;
536 			ret = -EIO;
537 			goto out;
538 		}
539 	}
540 	lp_table[minor].lp_buffer = kmalloc(LP_BUFFER_SIZE, GFP_KERNEL);
541 	if (!lp_table[minor].lp_buffer) {
542 		LP_F(minor) &= ~LP_BUSY;
543 		ret = -ENOMEM;
544 		goto out;
545 	}
546 	/* Determine if the peripheral supports ECP mode */
547 	lp_claim_parport_or_block(&lp_table[minor]);
548 	if ( (lp_table[minor].dev->port->modes & PARPORT_MODE_ECP) &&
549 	     !parport_negotiate(lp_table[minor].dev->port,
550 				 IEEE1284_MODE_ECP)) {
551 		printk(KERN_INFO "lp%d: ECP mode\n", minor);
552 		lp_table[minor].best_mode = IEEE1284_MODE_ECP;
553 	} else {
554 		lp_table[minor].best_mode = IEEE1284_MODE_COMPAT;
555 	}
556 	/* Leave peripheral in compatibility mode */
557 	parport_negotiate(lp_table[minor].dev->port, IEEE1284_MODE_COMPAT);
558 	lp_release_parport(&lp_table[minor]);
559 	lp_table[minor].current_mode = IEEE1284_MODE_COMPAT;
560 out:
561 	mutex_unlock(&lp_mutex);
562 	return ret;
563 }
564 
565 static int lp_release(struct inode *inode, struct file *file)
566 {
567 	unsigned int minor = iminor(inode);
568 
569 	lp_claim_parport_or_block(&lp_table[minor]);
570 	parport_negotiate(lp_table[minor].dev->port, IEEE1284_MODE_COMPAT);
571 	lp_table[minor].current_mode = IEEE1284_MODE_COMPAT;
572 	lp_release_parport(&lp_table[minor]);
573 	kfree(lp_table[minor].lp_buffer);
574 	lp_table[minor].lp_buffer = NULL;
575 	LP_F(minor) &= ~LP_BUSY;
576 	return 0;
577 }
578 
579 static int lp_do_ioctl(unsigned int minor, unsigned int cmd,
580 	unsigned long arg, void __user *argp)
581 {
582 	int status;
583 	int retval = 0;
584 
585 #ifdef LP_DEBUG
586 	printk(KERN_DEBUG "lp%d ioctl, cmd: 0x%x, arg: 0x%lx\n", minor, cmd, arg);
587 #endif
588 	if (minor >= LP_NO)
589 		return -ENODEV;
590 	if ((LP_F(minor) & LP_EXIST) == 0)
591 		return -ENODEV;
592 	switch ( cmd ) {
593 		case LPTIME:
594 			if (arg > UINT_MAX / HZ)
595 				return -EINVAL;
596 			LP_TIME(minor) = arg * HZ/100;
597 			break;
598 		case LPCHAR:
599 			LP_CHAR(minor) = arg;
600 			break;
601 		case LPABORT:
602 			if (arg)
603 				LP_F(minor) |= LP_ABORT;
604 			else
605 				LP_F(minor) &= ~LP_ABORT;
606 			break;
607 		case LPABORTOPEN:
608 			if (arg)
609 				LP_F(minor) |= LP_ABORTOPEN;
610 			else
611 				LP_F(minor) &= ~LP_ABORTOPEN;
612 			break;
613 		case LPCAREFUL:
614 			if (arg)
615 				LP_F(minor) |= LP_CAREFUL;
616 			else
617 				LP_F(minor) &= ~LP_CAREFUL;
618 			break;
619 		case LPWAIT:
620 			LP_WAIT(minor) = arg;
621 			break;
622 		case LPSETIRQ:
623 			return -EINVAL;
624 			break;
625 		case LPGETIRQ:
626 			if (copy_to_user(argp, &LP_IRQ(minor),
627 					sizeof(int)))
628 				return -EFAULT;
629 			break;
630 		case LPGETSTATUS:
631 			if (mutex_lock_interruptible(&lp_table[minor].port_mutex))
632 				return -EINTR;
633 			lp_claim_parport_or_block(&lp_table[minor]);
634 			status = r_str(minor);
635 			lp_release_parport(&lp_table[minor]);
636 			mutex_unlock(&lp_table[minor].port_mutex);
637 
638 			if (copy_to_user(argp, &status, sizeof(int)))
639 				return -EFAULT;
640 			break;
641 		case LPRESET:
642 			lp_reset(minor);
643 			break;
644 #ifdef LP_STATS
645 		case LPGETSTATS:
646 			if (copy_to_user(argp, &LP_STAT(minor),
647 					sizeof(struct lp_stats)))
648 				return -EFAULT;
649 			if (capable(CAP_SYS_ADMIN))
650 				memset(&LP_STAT(minor), 0,
651 						sizeof(struct lp_stats));
652 			break;
653 #endif
654 		case LPGETFLAGS:
655 			status = LP_F(minor);
656 			if (copy_to_user(argp, &status, sizeof(int)))
657 				return -EFAULT;
658 			break;
659 
660 		default:
661 			retval = -EINVAL;
662 	}
663 	return retval;
664 }
665 
666 static int lp_set_timeout(unsigned int minor, s64 tv_sec, long tv_usec)
667 {
668 	long to_jiffies;
669 
670 	/* Convert to jiffies, place in lp_table */
671 	if (tv_sec < 0 || tv_usec < 0)
672 		return -EINVAL;
673 
674 	/*
675 	 * we used to not check, so let's not make this fatal,
676 	 * but deal with user space passing a 32-bit tv_nsec in
677 	 * a 64-bit field, capping the timeout to 1 second
678 	 * worth of microseconds, and capping the total at
679 	 * MAX_JIFFY_OFFSET.
680 	 */
681 	if (tv_usec > 999999)
682 		tv_usec = 999999;
683 
684 	if (tv_sec >= MAX_SEC_IN_JIFFIES - 1) {
685 		to_jiffies = MAX_JIFFY_OFFSET;
686 	} else {
687 		to_jiffies = DIV_ROUND_UP(tv_usec, 1000000/HZ);
688 		to_jiffies += tv_sec * (long) HZ;
689 	}
690 
691 	if (to_jiffies <= 0) {
692 		return -EINVAL;
693 	}
694 	lp_table[minor].timeout = to_jiffies;
695 	return 0;
696 }
697 
698 static int lp_set_timeout32(unsigned int minor, void __user *arg)
699 {
700 	s32 karg[2];
701 
702 	if (copy_from_user(karg, arg, sizeof(karg)))
703 		return -EFAULT;
704 
705 	return lp_set_timeout(minor, karg[0], karg[1]);
706 }
707 
708 static int lp_set_timeout64(unsigned int minor, void __user *arg)
709 {
710 	s64 karg[2];
711 
712 	if (copy_from_user(karg, arg, sizeof(karg)))
713 		return -EFAULT;
714 
715 	return lp_set_timeout(minor, karg[0], karg[1]);
716 }
717 
718 static long lp_ioctl(struct file *file, unsigned int cmd,
719 			unsigned long arg)
720 {
721 	unsigned int minor;
722 	int ret;
723 
724 	minor = iminor(file_inode(file));
725 	mutex_lock(&lp_mutex);
726 	switch (cmd) {
727 	case LPSETTIMEOUT_OLD:
728 		if (BITS_PER_LONG == 32) {
729 			ret = lp_set_timeout32(minor, (void __user *)arg);
730 			break;
731 		}
732 		/* fallthrough for 64-bit */
733 	case LPSETTIMEOUT_NEW:
734 		ret = lp_set_timeout64(minor, (void __user *)arg);
735 		break;
736 	default:
737 		ret = lp_do_ioctl(minor, cmd, arg, (void __user *)arg);
738 		break;
739 	}
740 	mutex_unlock(&lp_mutex);
741 
742 	return ret;
743 }
744 
745 #ifdef CONFIG_COMPAT
746 static long lp_compat_ioctl(struct file *file, unsigned int cmd,
747 			unsigned long arg)
748 {
749 	unsigned int minor;
750 	int ret;
751 
752 	minor = iminor(file_inode(file));
753 	mutex_lock(&lp_mutex);
754 	switch (cmd) {
755 	case LPSETTIMEOUT_OLD:
756 		if (!COMPAT_USE_64BIT_TIME) {
757 			ret = lp_set_timeout32(minor, (void __user *)arg);
758 			break;
759 		}
760 		/* fallthrough for x32 mode */
761 	case LPSETTIMEOUT_NEW:
762 		ret = lp_set_timeout64(minor, (void __user *)arg);
763 		break;
764 #ifdef LP_STATS
765 	case LPGETSTATS:
766 		/* FIXME: add an implementation if you set LP_STATS */
767 		ret = -EINVAL;
768 		break;
769 #endif
770 	default:
771 		ret = lp_do_ioctl(minor, cmd, arg, compat_ptr(arg));
772 		break;
773 	}
774 	mutex_unlock(&lp_mutex);
775 
776 	return ret;
777 }
778 #endif
779 
780 static const struct file_operations lp_fops = {
781 	.owner		= THIS_MODULE,
782 	.write		= lp_write,
783 	.unlocked_ioctl	= lp_ioctl,
784 #ifdef CONFIG_COMPAT
785 	.compat_ioctl	= lp_compat_ioctl,
786 #endif
787 	.open		= lp_open,
788 	.release	= lp_release,
789 #ifdef CONFIG_PARPORT_1284
790 	.read		= lp_read,
791 #endif
792 	.llseek		= noop_llseek,
793 };
794 
795 /* --- support for console on the line printer ----------------- */
796 
797 #ifdef CONFIG_LP_CONSOLE
798 
799 #define CONSOLE_LP 0
800 
801 /* If the printer is out of paper, we can either lose the messages or
802  * stall until the printer is happy again.  Define CONSOLE_LP_STRICT
803  * non-zero to get the latter behaviour. */
804 #define CONSOLE_LP_STRICT 1
805 
806 /* The console must be locked when we get here. */
807 
808 static void lp_console_write(struct console *co, const char *s,
809 			     unsigned count)
810 {
811 	struct pardevice *dev = lp_table[CONSOLE_LP].dev;
812 	struct parport *port = dev->port;
813 	ssize_t written;
814 
815 	if (parport_claim(dev))
816 		/* Nothing we can do. */
817 		return;
818 
819 	parport_set_timeout(dev, 0);
820 
821 	/* Go to compatibility mode. */
822 	parport_negotiate(port, IEEE1284_MODE_COMPAT);
823 
824 	do {
825 		/* Write the data, converting LF->CRLF as we go. */
826 		ssize_t canwrite = count;
827 		char *lf = memchr(s, '\n', count);
828 		if (lf)
829 			canwrite = lf - s;
830 
831 		if (canwrite > 0) {
832 			written = parport_write(port, s, canwrite);
833 
834 			if (written <= 0)
835 				continue;
836 
837 			s += written;
838 			count -= written;
839 			canwrite -= written;
840 		}
841 
842 		if (lf && canwrite <= 0) {
843 			const char *crlf = "\r\n";
844 			int i = 2;
845 
846 			/* Dodge the original '\n', and put '\r\n' instead. */
847 			s++;
848 			count--;
849 			do {
850 				written = parport_write(port, crlf, i);
851 				if (written > 0)
852 					i -= written, crlf += written;
853 			} while (i > 0 && (CONSOLE_LP_STRICT || written > 0));
854 		}
855 	} while (count > 0 && (CONSOLE_LP_STRICT || written > 0));
856 
857 	parport_release(dev);
858 }
859 
860 static struct console lpcons = {
861 	.name		= "lp",
862 	.write		= lp_console_write,
863 	.flags		= CON_PRINTBUFFER,
864 };
865 
866 #endif /* console on line printer */
867 
868 /* --- initialisation code ------------------------------------- */
869 
870 static int parport_nr[LP_NO] = { [0 ... LP_NO-1] = LP_PARPORT_UNSPEC };
871 static char *parport[LP_NO];
872 static bool reset;
873 
874 module_param_array(parport, charp, NULL, 0);
875 module_param(reset, bool, 0);
876 
877 #ifndef MODULE
878 static int __init lp_setup(char *str)
879 {
880 	static int parport_ptr;
881 	int x;
882 
883 	if (get_option(&str, &x)) {
884 		if (x == 0) {
885 			/* disable driver on "lp=" or "lp=0" */
886 			parport_nr[0] = LP_PARPORT_OFF;
887 		} else {
888 			printk(KERN_WARNING "warning: 'lp=0x%x' is deprecated, ignored\n", x);
889 			return 0;
890 		}
891 	} else if (!strncmp(str, "parport", 7)) {
892 		int n = simple_strtoul(str+7, NULL, 10);
893 		if (parport_ptr < LP_NO)
894 			parport_nr[parport_ptr++] = n;
895 		else
896 			printk(KERN_INFO "lp: too many ports, %s ignored.\n",
897 			       str);
898 	} else if (!strcmp(str, "auto")) {
899 		parport_nr[0] = LP_PARPORT_AUTO;
900 	} else if (!strcmp(str, "none")) {
901 		if (parport_ptr < LP_NO)
902 			parport_nr[parport_ptr++] = LP_PARPORT_NONE;
903 		else
904 			printk(KERN_INFO "lp: too many ports, %s ignored.\n",
905 			       str);
906 	} else if (!strcmp(str, "reset")) {
907 		reset = true;
908 	}
909 	return 1;
910 }
911 #endif
912 
913 static int lp_register(int nr, struct parport *port)
914 {
915 	struct pardev_cb ppdev_cb;
916 
917 	memset(&ppdev_cb, 0, sizeof(ppdev_cb));
918 	ppdev_cb.preempt = lp_preempt;
919 	ppdev_cb.private = &lp_table[nr];
920 	lp_table[nr].dev = parport_register_dev_model(port, "lp",
921 						      &ppdev_cb, nr);
922 	if (lp_table[nr].dev == NULL)
923 		return 1;
924 	lp_table[nr].flags |= LP_EXIST;
925 
926 	if (reset)
927 		lp_reset(nr);
928 
929 	device_create(lp_class, port->dev, MKDEV(LP_MAJOR, nr), NULL,
930 		      "lp%d", nr);
931 
932 	printk(KERN_INFO "lp%d: using %s (%s).\n", nr, port->name,
933 	       (port->irq == PARPORT_IRQ_NONE)?"polling":"interrupt-driven");
934 
935 #ifdef CONFIG_LP_CONSOLE
936 	if (!nr) {
937 		if (port->modes & PARPORT_MODE_SAFEININT) {
938 			register_console(&lpcons);
939 			console_registered = port;
940 			printk(KERN_INFO "lp%d: console ready\n", CONSOLE_LP);
941 		} else
942 			printk(KERN_ERR "lp%d: cannot run console on %s\n",
943 			       CONSOLE_LP, port->name);
944 	}
945 #endif
946 	port_num[nr] = port->number;
947 
948 	return 0;
949 }
950 
951 static void lp_attach(struct parport *port)
952 {
953 	unsigned int i;
954 
955 	switch (parport_nr[0]) {
956 	case LP_PARPORT_UNSPEC:
957 	case LP_PARPORT_AUTO:
958 		if (parport_nr[0] == LP_PARPORT_AUTO &&
959 		    port->probe_info[0].class != PARPORT_CLASS_PRINTER)
960 			return;
961 		if (lp_count == LP_NO) {
962 			printk(KERN_INFO "lp: ignoring parallel port (max. %d)\n",LP_NO);
963 			return;
964 		}
965 		for (i = 0; i < LP_NO; i++)
966 			if (port_num[i] == -1)
967 				break;
968 
969 		if (!lp_register(i, port))
970 			lp_count++;
971 		break;
972 
973 	default:
974 		for (i = 0; i < LP_NO; i++) {
975 			if (port->number == parport_nr[i]) {
976 				if (!lp_register(i, port))
977 					lp_count++;
978 				break;
979 			}
980 		}
981 		break;
982 	}
983 }
984 
985 static void lp_detach(struct parport *port)
986 {
987 	int n;
988 
989 	/* Write this some day. */
990 #ifdef CONFIG_LP_CONSOLE
991 	if (console_registered == port) {
992 		unregister_console(&lpcons);
993 		console_registered = NULL;
994 	}
995 #endif /* CONFIG_LP_CONSOLE */
996 
997 	for (n = 0; n < LP_NO; n++) {
998 		if (port_num[n] == port->number) {
999 			port_num[n] = -1;
1000 			lp_count--;
1001 			device_destroy(lp_class, MKDEV(LP_MAJOR, n));
1002 			parport_unregister_device(lp_table[n].dev);
1003 		}
1004 	}
1005 }
1006 
1007 static struct parport_driver lp_driver = {
1008 	.name = "lp",
1009 	.match_port = lp_attach,
1010 	.detach = lp_detach,
1011 	.devmodel = true,
1012 };
1013 
1014 static int __init lp_init(void)
1015 {
1016 	int i, err = 0;
1017 
1018 	if (parport_nr[0] == LP_PARPORT_OFF)
1019 		return 0;
1020 
1021 	for (i = 0; i < LP_NO; i++) {
1022 		lp_table[i].dev = NULL;
1023 		lp_table[i].flags = 0;
1024 		lp_table[i].chars = LP_INIT_CHAR;
1025 		lp_table[i].time = LP_INIT_TIME;
1026 		lp_table[i].wait = LP_INIT_WAIT;
1027 		lp_table[i].lp_buffer = NULL;
1028 #ifdef LP_STATS
1029 		lp_table[i].lastcall = 0;
1030 		lp_table[i].runchars = 0;
1031 		memset(&lp_table[i].stats, 0, sizeof(struct lp_stats));
1032 #endif
1033 		lp_table[i].last_error = 0;
1034 		init_waitqueue_head(&lp_table[i].waitq);
1035 		init_waitqueue_head(&lp_table[i].dataq);
1036 		mutex_init(&lp_table[i].port_mutex);
1037 		lp_table[i].timeout = 10 * HZ;
1038 		port_num[i] = -1;
1039 	}
1040 
1041 	if (register_chrdev(LP_MAJOR, "lp", &lp_fops)) {
1042 		printk(KERN_ERR "lp: unable to get major %d\n", LP_MAJOR);
1043 		return -EIO;
1044 	}
1045 
1046 	lp_class = class_create(THIS_MODULE, "printer");
1047 	if (IS_ERR(lp_class)) {
1048 		err = PTR_ERR(lp_class);
1049 		goto out_reg;
1050 	}
1051 
1052 	if (parport_register_driver(&lp_driver)) {
1053 		printk(KERN_ERR "lp: unable to register with parport\n");
1054 		err = -EIO;
1055 		goto out_class;
1056 	}
1057 
1058 	if (!lp_count) {
1059 		printk(KERN_INFO "lp: driver loaded but no devices found\n");
1060 #ifndef CONFIG_PARPORT_1284
1061 		if (parport_nr[0] == LP_PARPORT_AUTO)
1062 			printk(KERN_INFO "lp: (is IEEE 1284 support enabled?)\n");
1063 #endif
1064 	}
1065 
1066 	return 0;
1067 
1068 out_class:
1069 	class_destroy(lp_class);
1070 out_reg:
1071 	unregister_chrdev(LP_MAJOR, "lp");
1072 	return err;
1073 }
1074 
1075 static int __init lp_init_module(void)
1076 {
1077 	if (parport[0]) {
1078 		/* The user gave some parameters.  Let's see what they were.  */
1079 		if (!strncmp(parport[0], "auto", 4))
1080 			parport_nr[0] = LP_PARPORT_AUTO;
1081 		else {
1082 			int n;
1083 			for (n = 0; n < LP_NO && parport[n]; n++) {
1084 				if (!strncmp(parport[n], "none", 4))
1085 					parport_nr[n] = LP_PARPORT_NONE;
1086 				else {
1087 					char *ep;
1088 					unsigned long r = simple_strtoul(parport[n], &ep, 0);
1089 					if (ep != parport[n])
1090 						parport_nr[n] = r;
1091 					else {
1092 						printk(KERN_ERR "lp: bad port specifier `%s'\n", parport[n]);
1093 						return -ENODEV;
1094 					}
1095 				}
1096 			}
1097 		}
1098 	}
1099 
1100 	return lp_init();
1101 }
1102 
1103 static void lp_cleanup_module(void)
1104 {
1105 	parport_unregister_driver(&lp_driver);
1106 
1107 #ifdef CONFIG_LP_CONSOLE
1108 	unregister_console(&lpcons);
1109 #endif
1110 
1111 	unregister_chrdev(LP_MAJOR, "lp");
1112 	class_destroy(lp_class);
1113 }
1114 
1115 __setup("lp=", lp_setup);
1116 module_init(lp_init_module);
1117 module_exit(lp_cleanup_module);
1118 
1119 MODULE_ALIAS_CHARDEV_MAJOR(LP_MAJOR);
1120 MODULE_LICENSE("GPL");
1121