4 * Copyright (c) 1999 Michael Gee <michael@linuxspecific.com>
5 * Copyright (c) 1999 Pavel Machek <pavel@suse.cz>
6 * Copyright (c) 2000 Randy Dunlap <rdunlap@xenotime.net>
7 * Copyright (c) 2000 Vojtech Pavlik <vojtech@suse.cz>
8 # Copyright (c) 2001 Pete Zaitcev <zaitcev@redhat.com>
9 # Copyright (c) 2001 David Paschal <paschal@rcsis.com>
10 * Copyright (c) 2006 Oliver Neukum <oliver@neukum.name>
12 * USB Printer Device Class driver for USB printers and printer cables
17 * v0.1 - thorough cleaning, URBification, almost a rewrite
18 * v0.2 - some more cleanups
19 * v0.3 - cleaner again, waitqueue fixes
20 * v0.4 - fixes in unidirectional mode
21 * v0.5 - add DEVICE_ID string support
22 * v0.6 - never time out
23 * v0.7 - fixed bulk-IN read and poll (David Paschal)
24 * v0.8 - add devfs support
25 * v0.9 - fix unplug-while-open paths
26 * v0.10- remove sleep_on, fix error on oom (oliver@neukum.org)
27 * v0.11 - add proto_bias option (Pete Zaitcev)
28 * v0.12 - add hpoj.sourceforge.net ioctls (David Paschal)
29 * v0.13 - alloc space for statusbuf (<status> not on stack);
30 * use usb_buffer_alloc() for read buf & write buf;
31 * none - Maintained in Linux kernel after v0.13
35 * This program is free software; you can redistribute it and/or modify
36 * it under the terms of the GNU General Public License as published by
37 * the Free Software Foundation; either version 2 of the License, or
38 * (at your option) any later version.
40 * This program is distributed in the hope that it will be useful,
41 * but WITHOUT ANY WARRANTY; without even the implied warranty of
42 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
43 * GNU General Public License for more details.
45 * You should have received a copy of the GNU General Public License
46 * along with this program; if not, write to the Free Software
47 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
50 #include <linux/module.h>
51 #include <linux/kernel.h>
52 #include <linux/sched.h>
53 #include <linux/signal.h>
54 #include <linux/poll.h>
55 #include <linux/init.h>
56 #include <linux/slab.h>
58 #include <linux/mutex.h>
60 #include <linux/usb.h>
65 #define DRIVER_AUTHOR "Michael Gee, Pavel Machek, Vojtech Pavlik, Randy Dunlap, Pete Zaitcev, David Paschal"
66 #define DRIVER_DESC "USB Printer Device Class driver"
68 #define USBLP_BUF_SIZE 8192
69 #define USBLP_BUF_SIZE_IN 1024
70 #define USBLP_DEVICE_ID_SIZE 1024
73 #define IOCNR_GET_DEVICE_ID 1
74 #define IOCNR_GET_PROTOCOLS 2
75 #define IOCNR_SET_PROTOCOL 3
76 #define IOCNR_HP_SET_CHANNEL 4
77 #define IOCNR_GET_BUS_ADDRESS 5
78 #define IOCNR_GET_VID_PID 6
79 #define IOCNR_SOFT_RESET 7
80 /* Get device_id string: */
81 #define LPIOC_GET_DEVICE_ID(len) _IOC(_IOC_READ, 'P', IOCNR_GET_DEVICE_ID, len)
82 /* The following ioctls were added for http://hpoj.sourceforge.net: */
84 * [0]=current protocol (1=7/1/1, 2=7/1/2, 3=7/1/3),
85 * [1]=supported protocol mask (mask&(1<<n)!=0 means 7/1/n supported): */
86 #define LPIOC_GET_PROTOCOLS(len) _IOC(_IOC_READ, 'P', IOCNR_GET_PROTOCOLS, len)
87 /* Set protocol (arg: 1=7/1/1, 2=7/1/2, 3=7/1/3): */
88 #define LPIOC_SET_PROTOCOL _IOC(_IOC_WRITE, 'P', IOCNR_SET_PROTOCOL, 0)
89 /* Set channel number (HP Vendor-specific command): */
90 #define LPIOC_HP_SET_CHANNEL _IOC(_IOC_WRITE, 'P', IOCNR_HP_SET_CHANNEL, 0)
91 /* Get two-int array: [0]=bus number, [1]=device address: */
92 #define LPIOC_GET_BUS_ADDRESS(len) _IOC(_IOC_READ, 'P', IOCNR_GET_BUS_ADDRESS, len)
93 /* Get two-int array: [0]=vendor ID, [1]=product ID: */
94 #define LPIOC_GET_VID_PID(len) _IOC(_IOC_READ, 'P', IOCNR_GET_VID_PID, len)
95 /* Perform class specific soft reset */
96 #define LPIOC_SOFT_RESET _IOC(_IOC_NONE, 'P', IOCNR_SOFT_RESET, 0);
99 * A DEVICE_ID string may include the printer's serial number.
100 * It should end with a semi-colon (';').
101 * An example from an HP 970C DeskJet printer is (this is one long string,
102 * with the serial number changed):
103 MFG:HEWLETT-PACKARD;MDL:DESKJET 970C;CMD:MLC,PCL,PML;CLASS:PRINTER;DESCRIPTION:Hewlett-Packard DeskJet 970C;SERN:US970CSEPROF;VSTATUS:$HB0$NC0,ff,DN,IDLE,CUT,K1,C0,DP,NR,KP000,CP027;VP:0800,FL,B0;VJ: ;
107 * USB Printer Requests
110 #define USBLP_REQ_GET_ID 0x00
111 #define USBLP_REQ_GET_STATUS 0x01
112 #define USBLP_REQ_RESET 0x02
113 #define USBLP_REQ_HP_CHANNEL_CHANGE_REQUEST 0x00 /* HP Vendor-specific */
115 #define USBLP_MINORS 16
116 #define USBLP_MINOR_BASE 0
118 #define USBLP_CTL_TIMEOUT 5000 /* 5 seconds */
120 #define USBLP_FIRST_PROTOCOL 1
121 #define USBLP_LAST_PROTOCOL 3
122 #define USBLP_MAX_PROTOCOLS (USBLP_LAST_PROTOCOL+1)
125 * some arbitrary status buffer size;
126 * need a status buffer that is allocated via kmalloc(), not on stack
128 #define STATUS_BUF_SIZE 8
131 * Locks down the locking order:
132 * ->wmut locks wstatus.
133 * ->mut locks the whole usblp, except [rw]complete, and thus, by indirection,
134 * [rw]status. We only touch status when we know the side idle.
135 * ->lock locks what interrupt accesses.
138 struct usb_device *dev; /* USB device */
141 spinlock_t lock; /* locks rcomplete, wcomplete */
142 char *readbuf; /* read transfer_buffer */
143 char *statusbuf; /* status transfer_buffer */
144 struct usb_anchor urbs;
145 wait_queue_head_t rwait, wwait;
146 int readcount; /* Counter for reads */
147 int ifnum; /* Interface number */
148 struct usb_interface *intf; /* The interface */
149 /* Alternate-setting numbers and endpoints for each protocol
150 * (7/1/{index=1,2,3}) that the device supports: */
153 struct usb_endpoint_descriptor *epwrite;
154 struct usb_endpoint_descriptor *epread;
155 } protocol[USBLP_MAX_PROTOCOLS];
156 int current_protocol;
157 int minor; /* minor number of device */
158 int wcomplete, rcomplete;
159 int wstatus; /* bytes written or error */
160 int rstatus; /* bytes ready or error */
161 unsigned int quirks; /* quirks flags */
162 unsigned int flags; /* mode flags */
163 unsigned char used; /* True if open */
164 unsigned char present; /* True if not disconnected */
165 unsigned char bidir; /* interface is bidirectional */
166 unsigned char sleeping; /* interface is suspended */
167 unsigned char no_paper; /* Paper Out happened */
168 unsigned char *device_id_string; /* IEEE 1284 DEVICE ID string (ptr) */
169 /* first 2 bytes are (big-endian) length */
173 static void usblp_dump(struct usblp *usblp) {
176 dbg("usblp=0x%p", usblp);
177 dbg("dev=0x%p", usblp->dev);
178 dbg("present=%d", usblp->present);
179 dbg("readbuf=0x%p", usblp->readbuf);
180 dbg("readcount=%d", usblp->readcount);
181 dbg("ifnum=%d", usblp->ifnum);
182 for (p = USBLP_FIRST_PROTOCOL; p <= USBLP_LAST_PROTOCOL; p++) {
183 dbg("protocol[%d].alt_setting=%d", p, usblp->protocol[p].alt_setting);
184 dbg("protocol[%d].epwrite=%p", p, usblp->protocol[p].epwrite);
185 dbg("protocol[%d].epread=%p", p, usblp->protocol[p].epread);
187 dbg("current_protocol=%d", usblp->current_protocol);
188 dbg("minor=%d", usblp->minor);
189 dbg("wstatus=%d", usblp->wstatus);
190 dbg("rstatus=%d", usblp->rstatus);
191 dbg("quirks=%d", usblp->quirks);
192 dbg("used=%d", usblp->used);
193 dbg("bidir=%d", usblp->bidir);
194 dbg("sleeping=%d", usblp->sleeping);
195 dbg("device_id_string=\"%s\"",
196 usblp->device_id_string ?
197 usblp->device_id_string + 2 :
198 (unsigned char *)"(null)");
202 /* Quirks: various printer quirks are handled by this table & its flags. */
204 struct quirk_printer_struct {
210 #define USBLP_QUIRK_BIDIR 0x1 /* reports bidir but requires unidirectional mode (no INs/reads) */
211 #define USBLP_QUIRK_USB_INIT 0x2 /* needs vendor USB init string */
212 #define USBLP_QUIRK_BAD_CLASS 0x4 /* descriptor uses vendor-specific Class or SubClass */
214 static const struct quirk_printer_struct quirk_printers[] = {
215 { 0x03f0, 0x0004, USBLP_QUIRK_BIDIR }, /* HP DeskJet 895C */
216 { 0x03f0, 0x0104, USBLP_QUIRK_BIDIR }, /* HP DeskJet 880C */
217 { 0x03f0, 0x0204, USBLP_QUIRK_BIDIR }, /* HP DeskJet 815C */
218 { 0x03f0, 0x0304, USBLP_QUIRK_BIDIR }, /* HP DeskJet 810C/812C */
219 { 0x03f0, 0x0404, USBLP_QUIRK_BIDIR }, /* HP DeskJet 830C */
220 { 0x03f0, 0x0504, USBLP_QUIRK_BIDIR }, /* HP DeskJet 885C */
221 { 0x03f0, 0x0604, USBLP_QUIRK_BIDIR }, /* HP DeskJet 840C */
222 { 0x03f0, 0x0804, USBLP_QUIRK_BIDIR }, /* HP DeskJet 816C */
223 { 0x03f0, 0x1104, USBLP_QUIRK_BIDIR }, /* HP Deskjet 959C */
224 { 0x0409, 0xefbe, USBLP_QUIRK_BIDIR }, /* NEC Picty900 (HP OEM) */
225 { 0x0409, 0xbef4, USBLP_QUIRK_BIDIR }, /* NEC Picty760 (HP OEM) */
226 { 0x0409, 0xf0be, USBLP_QUIRK_BIDIR }, /* NEC Picty920 (HP OEM) */
227 { 0x0409, 0xf1be, USBLP_QUIRK_BIDIR }, /* NEC Picty800 (HP OEM) */
228 { 0x0482, 0x0010, USBLP_QUIRK_BIDIR }, /* Kyocera Mita FS 820, by zut <kernel@zut.de> */
229 { 0x04b8, 0x0202, USBLP_QUIRK_BAD_CLASS }, /* Seiko Epson Receipt Printer M129C */
233 static int usblp_wwait(struct usblp *usblp, int nonblock);
234 static int usblp_wtest(struct usblp *usblp, int nonblock);
235 static int usblp_rwait_and_lock(struct usblp *usblp, int nonblock);
236 static int usblp_rtest(struct usblp *usblp, int nonblock);
237 static int usblp_submit_read(struct usblp *usblp);
238 static int usblp_select_alts(struct usblp *usblp);
239 static int usblp_set_protocol(struct usblp *usblp, int protocol);
240 static int usblp_cache_device_id_string(struct usblp *usblp);
242 /* forward reference to make our lives easier */
243 static struct usb_driver usblp_driver;
244 static DEFINE_MUTEX(usblp_mutex); /* locks the existence of usblp's */
247 * Functions for usblp control messages.
250 static int usblp_ctrl_msg(struct usblp *usblp, int request, int type, int dir, int recip, int value, void *buf, int len)
253 int index = usblp->ifnum;
255 /* High byte has the interface index.
256 Low byte has the alternate setting.
258 if ((request == USBLP_REQ_GET_ID) && (type == USB_TYPE_CLASS)) {
259 index = (usblp->ifnum<<8)|usblp->protocol[usblp->current_protocol].alt_setting;
262 retval = usb_control_msg(usblp->dev,
263 dir ? usb_rcvctrlpipe(usblp->dev, 0) : usb_sndctrlpipe(usblp->dev, 0),
264 request, type | dir | recip, value, index, buf, len, USBLP_CTL_TIMEOUT);
265 dbg("usblp_control_msg: rq: 0x%02x dir: %d recip: %d value: %d idx: %d len: %#x result: %d",
266 request, !!dir, recip, value, index, len, retval);
267 return retval < 0 ? retval : 0;
270 #define usblp_read_status(usblp, status)\
271 usblp_ctrl_msg(usblp, USBLP_REQ_GET_STATUS, USB_TYPE_CLASS, USB_DIR_IN, USB_RECIP_INTERFACE, 0, status, 1)
272 #define usblp_get_id(usblp, config, id, maxlen)\
273 usblp_ctrl_msg(usblp, USBLP_REQ_GET_ID, USB_TYPE_CLASS, USB_DIR_IN, USB_RECIP_INTERFACE, config, id, maxlen)
274 #define usblp_reset(usblp)\
275 usblp_ctrl_msg(usblp, USBLP_REQ_RESET, USB_TYPE_CLASS, USB_DIR_OUT, USB_RECIP_OTHER, 0, NULL, 0)
277 #define usblp_hp_channel_change_request(usblp, channel, buffer) \
278 usblp_ctrl_msg(usblp, USBLP_REQ_HP_CHANNEL_CHANGE_REQUEST, USB_TYPE_VENDOR, USB_DIR_IN, USB_RECIP_INTERFACE, channel, buffer, 1)
281 * See the description for usblp_select_alts() below for the usage
282 * explanation. Look into your /proc/bus/usb/devices and dmesg in
283 * case of any trouble.
285 static int proto_bias = -1;
291 static void usblp_bulk_read(struct urb *urb)
293 struct usblp *usblp = urb->context;
294 int status = urb->status;
296 if (usblp->present && usblp->used) {
298 printk(KERN_WARNING "usblp%d: "
299 "nonzero read bulk status received: %d\n",
300 usblp->minor, status);
302 spin_lock(&usblp->lock);
304 usblp->rstatus = status;
306 usblp->rstatus = urb->actual_length;
307 usblp->rcomplete = 1;
308 wake_up(&usblp->rwait);
309 spin_unlock(&usblp->lock);
314 static void usblp_bulk_write(struct urb *urb)
316 struct usblp *usblp = urb->context;
317 int status = urb->status;
319 if (usblp->present && usblp->used) {
321 printk(KERN_WARNING "usblp%d: "
322 "nonzero write bulk status received: %d\n",
323 usblp->minor, status);
325 spin_lock(&usblp->lock);
327 usblp->wstatus = status;
329 usblp->wstatus = urb->actual_length;
331 usblp->wcomplete = 1;
332 wake_up(&usblp->wwait);
333 spin_unlock(&usblp->lock);
339 * Get and print printer errors.
342 static const char *usblp_messages[] = { "ok", "out of paper", "off-line", "on fire" };
344 static int usblp_check_status(struct usblp *usblp, int err)
346 unsigned char status, newerr = 0;
349 mutex_lock(&usblp->mut);
350 if ((error = usblp_read_status(usblp, usblp->statusbuf)) < 0) {
351 mutex_unlock(&usblp->mut);
352 if (printk_ratelimit())
354 "usblp%d: error %d reading printer status\n",
355 usblp->minor, error);
358 status = *usblp->statusbuf;
359 mutex_unlock(&usblp->mut);
361 if (~status & LP_PERRORP)
363 if (status & LP_POUTPA)
365 if (~status & LP_PSELECD)
369 printk(KERN_INFO "usblp%d: %s\n",
370 usblp->minor, usblp_messages[newerr]);
376 static int handle_bidir (struct usblp *usblp)
378 if (usblp->bidir && usblp->used && !usblp->sleeping) {
379 if (usblp_submit_read(usblp) < 0)
389 static int usblp_open(struct inode *inode, struct file *file)
391 int minor = iminor(inode);
393 struct usb_interface *intf;
399 mutex_lock (&usblp_mutex);
402 intf = usb_find_interface(&usblp_driver, minor);
406 usblp = usb_get_intfdata (intf);
407 if (!usblp || !usblp->dev || !usblp->present)
415 * We do not implement LP_ABORTOPEN/LPABORTOPEN for two reasons:
416 * - We do not want persistent state which close(2) does not clear
417 * - It is not used anyway, according to CUPS people
420 retval = usb_autopm_get_interface(intf);
424 file->private_data = usblp;
426 usblp->wcomplete = 1; /* we begin writeable */
428 usblp->rcomplete = 0;
430 if (handle_bidir(usblp) < 0) {
432 file->private_data = NULL;
436 mutex_unlock (&usblp_mutex);
440 static void usblp_cleanup (struct usblp *usblp)
442 printk(KERN_INFO "usblp%d: removed\n", usblp->minor);
444 kfree(usblp->readbuf);
445 kfree (usblp->device_id_string);
446 kfree (usblp->statusbuf);
450 static void usblp_unlink_urbs(struct usblp *usblp)
452 usb_kill_anchored_urbs(&usblp->urbs);
455 static int usblp_release(struct inode *inode, struct file *file)
457 struct usblp *usblp = file->private_data;
459 usblp->flags &= ~LP_ABORT;
461 mutex_lock (&usblp_mutex);
463 if (usblp->present) {
464 usblp_unlink_urbs(usblp);
465 usb_autopm_put_interface(usblp->intf);
466 } else /* finish cleanup from disconnect */
467 usblp_cleanup (usblp);
468 mutex_unlock (&usblp_mutex);
472 /* No kernel lock - fine */
473 static unsigned int usblp_poll(struct file *file, struct poll_table_struct *wait)
478 struct usblp *usblp = file->private_data;
479 /* Should we check file->f_mode & FMODE_WRITE before poll_wait()? */
480 poll_wait(file, &usblp->rwait, wait);
481 poll_wait(file, &usblp->wwait, wait);
482 spin_lock_irqsave(&usblp->lock, flags);
483 ret = ((usblp->bidir && usblp->rcomplete) ? POLLIN | POLLRDNORM : 0) |
484 ((usblp->no_paper || usblp->wcomplete) ? POLLOUT | POLLWRNORM : 0);
485 spin_unlock_irqrestore(&usblp->lock, flags);
489 static long usblp_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
491 struct usblp *usblp = file->private_data;
493 unsigned char newChannel;
498 mutex_lock (&usblp->mut);
499 if (!usblp->present) {
504 if (usblp->sleeping) {
509 dbg("usblp_ioctl: cmd=0x%x (%c nr=%d len=%d dir=%d)", cmd, _IOC_TYPE(cmd),
510 _IOC_NR(cmd), _IOC_SIZE(cmd), _IOC_DIR(cmd) );
512 if (_IOC_TYPE(cmd) == 'P') /* new-style ioctl number */
514 switch (_IOC_NR(cmd)) {
516 case IOCNR_GET_DEVICE_ID: /* get the DEVICE_ID string */
517 if (_IOC_DIR(cmd) != _IOC_READ) {
522 length = usblp_cache_device_id_string(usblp);
527 if (length > _IOC_SIZE(cmd))
528 length = _IOC_SIZE(cmd); /* truncate */
530 if (copy_to_user((void __user *) arg,
531 usblp->device_id_string,
532 (unsigned long) length)) {
539 case IOCNR_GET_PROTOCOLS:
540 if (_IOC_DIR(cmd) != _IOC_READ ||
541 _IOC_SIZE(cmd) < sizeof(twoints)) {
546 twoints[0] = usblp->current_protocol;
548 for (i = USBLP_FIRST_PROTOCOL;
549 i <= USBLP_LAST_PROTOCOL; i++) {
550 if (usblp->protocol[i].alt_setting >= 0)
551 twoints[1] |= (1<<i);
554 if (copy_to_user((void __user *)arg,
555 (unsigned char *)twoints,
563 case IOCNR_SET_PROTOCOL:
564 if (_IOC_DIR(cmd) != _IOC_WRITE) {
576 usblp_unlink_urbs(usblp);
577 retval = usblp_set_protocol(usblp, arg);
579 usblp_set_protocol(usblp,
580 usblp->current_protocol);
584 case IOCNR_HP_SET_CHANNEL:
585 if (_IOC_DIR(cmd) != _IOC_WRITE ||
586 le16_to_cpu(usblp->dev->descriptor.idVendor) != 0x03F0 ||
587 usblp->quirks & USBLP_QUIRK_BIDIR) {
592 err = usblp_hp_channel_change_request(usblp,
595 err("usblp%d: error = %d setting "
602 dbg("usblp%d requested/got HP channel %ld/%d",
603 usblp->minor, arg, newChannel);
606 case IOCNR_GET_BUS_ADDRESS:
607 if (_IOC_DIR(cmd) != _IOC_READ ||
608 _IOC_SIZE(cmd) < sizeof(twoints)) {
613 twoints[0] = usblp->dev->bus->busnum;
614 twoints[1] = usblp->dev->devnum;
615 if (copy_to_user((void __user *)arg,
616 (unsigned char *)twoints,
622 dbg("usblp%d is bus=%d, device=%d",
623 usblp->minor, twoints[0], twoints[1]);
626 case IOCNR_GET_VID_PID:
627 if (_IOC_DIR(cmd) != _IOC_READ ||
628 _IOC_SIZE(cmd) < sizeof(twoints)) {
633 twoints[0] = le16_to_cpu(usblp->dev->descriptor.idVendor);
634 twoints[1] = le16_to_cpu(usblp->dev->descriptor.idProduct);
635 if (copy_to_user((void __user *)arg,
636 (unsigned char *)twoints,
642 dbg("usblp%d is VID=0x%4.4X, PID=0x%4.4X",
643 usblp->minor, twoints[0], twoints[1]);
646 case IOCNR_SOFT_RESET:
647 if (_IOC_DIR(cmd) != _IOC_NONE) {
651 retval = usblp_reset(usblp);
656 else /* old-style ioctl value */
660 if ((retval = usblp_read_status(usblp, usblp->statusbuf))) {
661 if (printk_ratelimit())
662 printk(KERN_ERR "usblp%d:"
663 "failed reading printer status (%d)\n",
664 usblp->minor, retval);
668 status = *usblp->statusbuf;
669 if (copy_to_user ((void __user *)arg, &status, sizeof(int)))
675 usblp->flags |= LP_ABORT;
677 usblp->flags &= ~LP_ABORT;
685 mutex_unlock (&usblp->mut);
689 static ssize_t usblp_write(struct file *file, const char __user *buffer, size_t count, loff_t *ppos)
691 struct usblp *usblp = file->private_data;
693 struct urb *writeurb;
696 ssize_t writecount = 0;
698 if (mutex_lock_interruptible(&usblp->wmut)) {
702 if ((rv = usblp_wwait(usblp, !!(file->f_flags & O_NONBLOCK))) < 0)
705 while (writecount < count) {
707 * Step 1: Submit next block.
709 if ((transfer_length = count - writecount) > USBLP_BUF_SIZE)
710 transfer_length = USBLP_BUF_SIZE;
713 if ((writebuf = kmalloc(USBLP_BUF_SIZE, GFP_KERNEL)) == NULL)
715 if ((writeurb = usb_alloc_urb(0, GFP_KERNEL)) == NULL)
717 usb_fill_bulk_urb(writeurb, usblp->dev,
718 usb_sndbulkpipe(usblp->dev,
719 usblp->protocol[usblp->current_protocol].epwrite->bEndpointAddress),
720 writebuf, transfer_length, usblp_bulk_write, usblp);
721 writeurb->transfer_flags |= URB_FREE_BUFFER;
722 usb_anchor_urb(writeurb, &usblp->urbs);
724 if (copy_from_user(writebuf,
725 buffer + writecount, transfer_length)) {
730 spin_lock_irq(&usblp->lock);
731 usblp->wcomplete = 0;
732 spin_unlock_irq(&usblp->lock);
733 if ((rv = usb_submit_urb(writeurb, GFP_KERNEL)) < 0) {
735 spin_lock_irq(&usblp->lock);
737 usblp->wcomplete = 1;
738 wake_up(&usblp->wwait);
739 spin_unlock_irq(&usblp->lock);
746 * Step 2: Wait for transfer to end, collect results.
748 rv = usblp_wwait(usblp, !!(file->f_flags&O_NONBLOCK));
751 /* Presume that it's going to complete well. */
752 writecount += transfer_length;
755 spin_lock_irq(&usblp->lock);
756 usblp->no_paper = 1; /* Mark for poll(2) */
757 spin_unlock_irq(&usblp->lock);
758 writecount += transfer_length;
760 /* Leave URB dangling, to be cleaned on close. */
764 if (usblp->wstatus < 0) {
769 * This is critical: it must be our URB, not other writer's.
770 * The wmut exists mainly to cover us here.
772 writecount += usblp->wstatus;
775 mutex_unlock(&usblp->wmut);
780 usb_unanchor_urb(writeurb);
781 usb_free_urb(writeurb);
786 collect_error: /* Out of raise sequence */
787 mutex_unlock(&usblp->wmut);
789 return writecount ? writecount : rv;
793 * Notice that we fail to restart in a few cases: on EFAULT, on restart
794 * error, etc. This is the historical behaviour. In all such cases we return
795 * EIO, and applications loop in order to get the new read going.
797 static ssize_t usblp_read(struct file *file, char __user *buffer, size_t len, loff_t *ppos)
799 struct usblp *usblp = file->private_data;
807 rv = usblp_rwait_and_lock(usblp, !!(file->f_flags & O_NONBLOCK));
811 if ((avail = usblp->rstatus) < 0) {
812 printk(KERN_ERR "usblp%d: error %d reading from printer\n",
813 usblp->minor, (int)avail);
814 usblp_submit_read(usblp);
819 count = len < avail - usblp->readcount ? len : avail - usblp->readcount;
821 copy_to_user(buffer, usblp->readbuf + usblp->readcount, count)) {
826 if ((usblp->readcount += count) == avail) {
827 if (usblp_submit_read(usblp) < 0) {
828 /* We don't want to leak USB return codes into errno. */
836 mutex_unlock (&usblp->mut);
841 * Wait for the write path to come idle.
842 * This is called under the ->wmut, so the idle path stays idle.
844 * Our write path has a peculiar property: it does not buffer like a tty,
845 * but waits for the write to succeed. This allows our ->release to bug out
846 * without waiting for writes to drain. But it obviously does not work
847 * when O_NONBLOCK is set. So, applications setting O_NONBLOCK must use
848 * select(2) or poll(2) to wait for the buffer to drain before closing.
849 * Alternatively, set blocking mode with fcntl and issue a zero-size write.
851 static int usblp_wwait(struct usblp *usblp, int nonblock)
853 DECLARE_WAITQUEUE(waita, current);
857 add_wait_queue(&usblp->wwait, &waita);
859 set_current_state(TASK_INTERRUPTIBLE);
860 if (mutex_lock_interruptible(&usblp->mut)) {
864 rc = usblp_wtest(usblp, nonblock);
865 mutex_unlock(&usblp->mut);
869 if (usblp->flags & LP_ABORT) {
870 if (schedule_timeout(msecs_to_jiffies(5000)) == 0) {
871 err = usblp_check_status(usblp, err);
872 if (err == 1) { /* Paper out */
881 set_current_state(TASK_RUNNING);
882 remove_wait_queue(&usblp->wwait, &waita);
886 static int usblp_wtest(struct usblp *usblp, int nonblock)
892 if (signal_pending(current))
894 spin_lock_irqsave(&usblp->lock, flags);
895 if (usblp->wcomplete) {
896 spin_unlock_irqrestore(&usblp->lock, flags);
899 spin_unlock_irqrestore(&usblp->lock, flags);
908 * Wait for read bytes to become available. This probably should have been
909 * called usblp_r_lock_and_wait(), because we lock first. But it's a traditional
910 * name for functions which lock and return.
912 * We do not use wait_event_interruptible because it makes locking iffy.
914 static int usblp_rwait_and_lock(struct usblp *usblp, int nonblock)
916 DECLARE_WAITQUEUE(waita, current);
919 add_wait_queue(&usblp->rwait, &waita);
921 if (mutex_lock_interruptible(&usblp->mut)) {
925 set_current_state(TASK_INTERRUPTIBLE);
926 if ((rc = usblp_rtest(usblp, nonblock)) < 0) {
927 mutex_unlock(&usblp->mut);
930 if (rc == 0) /* Keep it locked */
932 mutex_unlock(&usblp->mut);
935 set_current_state(TASK_RUNNING);
936 remove_wait_queue(&usblp->rwait, &waita);
940 static int usblp_rtest(struct usblp *usblp, int nonblock)
946 if (signal_pending(current))
948 spin_lock_irqsave(&usblp->lock, flags);
949 if (usblp->rcomplete) {
950 spin_unlock_irqrestore(&usblp->lock, flags);
953 spin_unlock_irqrestore(&usblp->lock, flags);
962 * Please check ->bidir and other such things outside for now.
964 static int usblp_submit_read(struct usblp *usblp)
971 if ((urb = usb_alloc_urb(0, GFP_KERNEL)) == NULL)
974 usb_fill_bulk_urb(urb, usblp->dev,
975 usb_rcvbulkpipe(usblp->dev,
976 usblp->protocol[usblp->current_protocol].epread->bEndpointAddress),
977 usblp->readbuf, USBLP_BUF_SIZE_IN,
978 usblp_bulk_read, usblp);
979 usb_anchor_urb(urb, &usblp->urbs);
981 spin_lock_irqsave(&usblp->lock, flags);
982 usblp->readcount = 0; /* XXX Why here? */
983 usblp->rcomplete = 0;
984 spin_unlock_irqrestore(&usblp->lock, flags);
985 if ((rc = usb_submit_urb(urb, GFP_KERNEL)) < 0) {
986 dbg("error submitting urb (%d)", rc);
987 spin_lock_irqsave(&usblp->lock, flags);
989 usblp->rcomplete = 1;
990 spin_unlock_irqrestore(&usblp->lock, flags);
997 usb_unanchor_urb(urb);
1004 * Checks for printers that have quirks, such as requiring unidirectional
1005 * communication but reporting bidirectional; currently some HP printers
1006 * have this flaw (HP 810, 880, 895, etc.), or needing an init string
1007 * sent at each open (like some Epsons).
1008 * Returns 1 if found, 0 if not found.
1010 * HP recommended that we use the bidirectional interface but
1011 * don't attempt any bulk IN transfers from the IN endpoint.
1012 * Here's some more detail on the problem:
1013 * The problem is not that it isn't bidirectional though. The problem
1014 * is that if you request a device ID, or status information, while
1015 * the buffers are full, the return data will end up in the print data
1016 * buffer. For example if you make sure you never request the device ID
1017 * while you are sending print data, and you don't try to query the
1018 * printer status every couple of milliseconds, you will probably be OK.
1020 static unsigned int usblp_quirks (__u16 vendor, __u16 product)
1024 for (i = 0; quirk_printers[i].vendorId; i++) {
1025 if (vendor == quirk_printers[i].vendorId &&
1026 product == quirk_printers[i].productId)
1027 return quirk_printers[i].quirks;
1032 static const struct file_operations usblp_fops = {
1033 .owner = THIS_MODULE,
1035 .write = usblp_write,
1037 .unlocked_ioctl = usblp_ioctl,
1038 .compat_ioctl = usblp_ioctl,
1040 .release = usblp_release,
1043 static struct usb_class_driver usblp_class = {
1045 .fops = &usblp_fops,
1046 .minor_base = USBLP_MINOR_BASE,
1049 static ssize_t usblp_show_ieee1284_id(struct device *dev, struct device_attribute *attr, char *buf)
1051 struct usb_interface *intf = to_usb_interface(dev);
1052 struct usblp *usblp = usb_get_intfdata (intf);
1054 if (usblp->device_id_string[0] == 0 &&
1055 usblp->device_id_string[1] == 0)
1058 return sprintf(buf, "%s", usblp->device_id_string+2);
1061 static DEVICE_ATTR(ieee1284_id, S_IRUGO, usblp_show_ieee1284_id, NULL);
1063 static int usblp_probe(struct usb_interface *intf,
1064 const struct usb_device_id *id)
1066 struct usb_device *dev = interface_to_usbdev (intf);
1067 struct usblp *usblp = NULL;
1071 /* Malloc and start initializing usblp structure so we can use it
1073 if (!(usblp = kzalloc(sizeof(struct usblp), GFP_KERNEL))) {
1078 mutex_init(&usblp->wmut);
1079 mutex_init (&usblp->mut);
1080 spin_lock_init(&usblp->lock);
1081 init_waitqueue_head(&usblp->rwait);
1082 init_waitqueue_head(&usblp->wwait);
1083 init_usb_anchor(&usblp->urbs);
1084 usblp->ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
1087 /* Malloc device ID string buffer to the largest expected length,
1088 * since we can re-query it on an ioctl and a dynamic string
1089 * could change in length. */
1090 if (!(usblp->device_id_string = kmalloc(USBLP_DEVICE_ID_SIZE, GFP_KERNEL))) {
1096 * Allocate read buffer. We somewhat wastefully
1097 * malloc both regardless of bidirectionality, because the
1098 * alternate setting can be changed later via an ioctl.
1100 if (!(usblp->readbuf = kmalloc(USBLP_BUF_SIZE_IN, GFP_KERNEL))) {
1105 /* Allocate buffer for printer status */
1106 usblp->statusbuf = kmalloc(STATUS_BUF_SIZE, GFP_KERNEL);
1107 if (!usblp->statusbuf) {
1112 /* Lookup quirks for this printer. */
1113 usblp->quirks = usblp_quirks(
1114 le16_to_cpu(dev->descriptor.idVendor),
1115 le16_to_cpu(dev->descriptor.idProduct));
1117 /* Analyze and pick initial alternate settings and endpoints. */
1118 protocol = usblp_select_alts(usblp);
1120 dbg("incompatible printer-class device 0x%4.4X/0x%4.4X",
1121 le16_to_cpu(dev->descriptor.idVendor),
1122 le16_to_cpu(dev->descriptor.idProduct));
1127 /* Setup the selected alternate setting and endpoints. */
1128 if (usblp_set_protocol(usblp, protocol) < 0) {
1129 retval = -ENODEV; /* ->probe isn't ->ioctl */
1133 /* Retrieve and store the device ID string. */
1134 usblp_cache_device_id_string(usblp);
1135 retval = device_create_file(&intf->dev, &dev_attr_ieee1284_id);
1137 goto abort_intfdata;
1140 usblp_check_status(usblp, 0);
1143 usb_set_intfdata (intf, usblp);
1147 retval = usb_register_dev(intf, &usblp_class);
1149 printk(KERN_ERR "usblp: Not able to get a minor"
1150 " (base %u, slice default): %d\n",
1151 USBLP_MINOR_BASE, retval);
1152 goto abort_intfdata;
1154 usblp->minor = intf->minor;
1155 printk(KERN_INFO "usblp%d: USB %sdirectional printer dev %d "
1156 "if %d alt %d proto %d vid 0x%4.4X pid 0x%4.4X\n",
1157 usblp->minor, usblp->bidir ? "Bi" : "Uni", dev->devnum,
1159 usblp->protocol[usblp->current_protocol].alt_setting,
1160 usblp->current_protocol,
1161 le16_to_cpu(usblp->dev->descriptor.idVendor),
1162 le16_to_cpu(usblp->dev->descriptor.idProduct));
1167 usb_set_intfdata (intf, NULL);
1168 device_remove_file(&intf->dev, &dev_attr_ieee1284_id);
1171 kfree(usblp->readbuf);
1172 kfree(usblp->statusbuf);
1173 kfree(usblp->device_id_string);
1180 * We are a "new" style driver with usb_device_id table,
1181 * but our requirements are too intricate for simple match to handle.
1183 * The "proto_bias" option may be used to specify the preferred protocol
1184 * for all USB printers (1=7/1/1, 2=7/1/2, 3=7/1/3). If the device
1185 * supports the preferred protocol, then we bind to it.
1187 * The best interface for us is 7/1/2, because it is compatible
1188 * with a stream of characters. If we find it, we bind to it.
1190 * Note that the people from hpoj.sourceforge.net need to be able to
1191 * bind to 7/1/3 (MLC/1284.4), so we provide them ioctls for this purpose.
1193 * Failing 7/1/2, we look for 7/1/3, even though it's probably not
1194 * stream-compatible, because this matches the behaviour of the old code.
1196 * If nothing else, we bind to 7/1/1 - the unidirectional interface.
1198 static int usblp_select_alts(struct usblp *usblp)
1200 struct usb_interface *if_alt;
1201 struct usb_host_interface *ifd;
1202 struct usb_endpoint_descriptor *epd, *epwrite, *epread;
1205 if_alt = usblp->intf;
1207 for (p = 0; p < USBLP_MAX_PROTOCOLS; p++)
1208 usblp->protocol[p].alt_setting = -1;
1210 /* Find out what we have. */
1211 for (i = 0; i < if_alt->num_altsetting; i++) {
1212 ifd = &if_alt->altsetting[i];
1214 if (ifd->desc.bInterfaceClass != 7 || ifd->desc.bInterfaceSubClass != 1)
1215 if (!(usblp->quirks & USBLP_QUIRK_BAD_CLASS))
1218 if (ifd->desc.bInterfaceProtocol < USBLP_FIRST_PROTOCOL ||
1219 ifd->desc.bInterfaceProtocol > USBLP_LAST_PROTOCOL)
1222 /* Look for bulk OUT and IN endpoints. */
1223 epwrite = epread = NULL;
1224 for (e = 0; e < ifd->desc.bNumEndpoints; e++) {
1225 epd = &ifd->endpoint[e].desc;
1227 if (usb_endpoint_is_bulk_out(epd))
1231 if (usb_endpoint_is_bulk_in(epd))
1236 /* Ignore buggy hardware without the right endpoints. */
1237 if (!epwrite || (ifd->desc.bInterfaceProtocol > 1 && !epread))
1240 /* Turn off reads for 7/1/1 (unidirectional) interfaces
1241 * and buggy bidirectional printers. */
1242 if (ifd->desc.bInterfaceProtocol == 1) {
1244 } else if (usblp->quirks & USBLP_QUIRK_BIDIR) {
1245 printk(KERN_INFO "usblp%d: Disabling reads from "
1246 "problematic bidirectional printer\n",
1251 usblp->protocol[ifd->desc.bInterfaceProtocol].alt_setting =
1252 ifd->desc.bAlternateSetting;
1253 usblp->protocol[ifd->desc.bInterfaceProtocol].epwrite = epwrite;
1254 usblp->protocol[ifd->desc.bInterfaceProtocol].epread = epread;
1257 /* If our requested protocol is supported, then use it. */
1258 if (proto_bias >= USBLP_FIRST_PROTOCOL &&
1259 proto_bias <= USBLP_LAST_PROTOCOL &&
1260 usblp->protocol[proto_bias].alt_setting != -1)
1263 /* Ordering is important here. */
1264 if (usblp->protocol[2].alt_setting != -1)
1266 if (usblp->protocol[1].alt_setting != -1)
1268 if (usblp->protocol[3].alt_setting != -1)
1271 /* If nothing is available, then don't bind to this device. */
1275 static int usblp_set_protocol(struct usblp *usblp, int protocol)
1279 if (protocol < USBLP_FIRST_PROTOCOL || protocol > USBLP_LAST_PROTOCOL)
1282 alts = usblp->protocol[protocol].alt_setting;
1285 r = usb_set_interface(usblp->dev, usblp->ifnum, alts);
1287 printk(KERN_ERR "usblp: can't set desired altsetting %d on interface %d\n",
1288 alts, usblp->ifnum);
1292 usblp->bidir = (usblp->protocol[protocol].epread != NULL);
1293 usblp->current_protocol = protocol;
1294 dbg("usblp%d set protocol %d", usblp->minor, protocol);
1298 /* Retrieves and caches device ID string.
1299 * Returns length, including length bytes but not null terminator.
1300 * On error, returns a negative errno value. */
1301 static int usblp_cache_device_id_string(struct usblp *usblp)
1305 err = usblp_get_id(usblp, 0, usblp->device_id_string, USBLP_DEVICE_ID_SIZE - 1);
1307 dbg("usblp%d: error = %d reading IEEE-1284 Device ID string",
1309 usblp->device_id_string[0] = usblp->device_id_string[1] = '\0';
1313 /* First two bytes are length in big-endian.
1314 * They count themselves, and we copy them into
1315 * the user's buffer. */
1316 length = be16_to_cpu(*((__be16 *)usblp->device_id_string));
1319 else if (length >= USBLP_DEVICE_ID_SIZE)
1320 length = USBLP_DEVICE_ID_SIZE - 1;
1321 usblp->device_id_string[length] = '\0';
1323 dbg("usblp%d Device ID string [len=%d]=\"%s\"",
1324 usblp->minor, length, &usblp->device_id_string[2]);
1329 static void usblp_disconnect(struct usb_interface *intf)
1331 struct usblp *usblp = usb_get_intfdata (intf);
1333 usb_deregister_dev(intf, &usblp_class);
1335 if (!usblp || !usblp->dev) {
1336 err("bogus disconnect");
1340 device_remove_file(&intf->dev, &dev_attr_ieee1284_id);
1342 mutex_lock (&usblp_mutex);
1343 mutex_lock (&usblp->mut);
1345 wake_up(&usblp->wwait);
1346 wake_up(&usblp->rwait);
1347 usb_set_intfdata (intf, NULL);
1349 usblp_unlink_urbs(usblp);
1350 mutex_unlock (&usblp->mut);
1353 usblp_cleanup (usblp);
1354 mutex_unlock (&usblp_mutex);
1357 static int usblp_suspend (struct usb_interface *intf, pm_message_t message)
1359 struct usblp *usblp = usb_get_intfdata (intf);
1361 /* we take no more IO */
1362 usblp->sleeping = 1;
1363 usblp_unlink_urbs(usblp);
1364 #if 0 /* XXX Do we want this? What if someone is reading, should we fail? */
1365 /* not strictly necessary, but just in case */
1366 wake_up(&usblp->wwait);
1367 wake_up(&usblp->rwait);
1373 static int usblp_resume (struct usb_interface *intf)
1375 struct usblp *usblp = usb_get_intfdata (intf);
1378 usblp->sleeping = 0;
1379 r = handle_bidir (usblp);
1384 static struct usb_device_id usblp_ids [] = {
1385 { USB_DEVICE_INFO(7, 1, 1) },
1386 { USB_DEVICE_INFO(7, 1, 2) },
1387 { USB_DEVICE_INFO(7, 1, 3) },
1388 { USB_INTERFACE_INFO(7, 1, 1) },
1389 { USB_INTERFACE_INFO(7, 1, 2) },
1390 { USB_INTERFACE_INFO(7, 1, 3) },
1391 { USB_DEVICE(0x04b8, 0x0202) }, /* Seiko Epson Receipt Printer M129C */
1392 { } /* Terminating entry */
1395 MODULE_DEVICE_TABLE (usb, usblp_ids);
1397 static struct usb_driver usblp_driver = {
1399 .probe = usblp_probe,
1400 .disconnect = usblp_disconnect,
1401 .suspend = usblp_suspend,
1402 .resume = usblp_resume,
1403 .id_table = usblp_ids,
1404 .supports_autosuspend = 1,
1407 static int __init usblp_init(void)
1409 return usb_register(&usblp_driver);
1412 static void __exit usblp_exit(void)
1414 usb_deregister(&usblp_driver);
1417 module_init(usblp_init);
1418 module_exit(usblp_exit);
1420 MODULE_AUTHOR( DRIVER_AUTHOR );
1421 MODULE_DESCRIPTION( DRIVER_DESC );
1422 module_param(proto_bias, int, S_IRUGO | S_IWUSR);
1423 MODULE_PARM_DESC(proto_bias, "Favourite protocol number");
1424 MODULE_LICENSE("GPL");