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;
34 * This program is free software; you can redistribute it and/or modify
35 * it under the terms of the GNU General Public License as published by
36 * the Free Software Foundation; either version 2 of the License, or
37 * (at your option) any later version.
39 * This program is distributed in the hope that it will be useful,
40 * but WITHOUT ANY WARRANTY; without even the implied warranty of
41 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
42 * GNU General Public License for more details.
44 * You should have received a copy of the GNU General Public License
45 * along with this program; if not, write to the Free Software
46 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
49 #include <linux/module.h>
50 #include <linux/kernel.h>
51 #include <linux/sched.h>
52 #include <linux/smp_lock.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_VERSION "v0.13"
66 #define DRIVER_AUTHOR "Michael Gee, Pavel Machek, Vojtech Pavlik, Randy Dunlap, Pete Zaitcev, David Paschal"
67 #define DRIVER_DESC "USB Printer Device Class driver"
69 #define USBLP_BUF_SIZE 8192
70 #define USBLP_DEVICE_ID_SIZE 1024
73 #define LPGETSTATUS 0x060b /* same as in drivers/char/lp.c */
74 #define IOCNR_GET_DEVICE_ID 1
75 #define IOCNR_GET_PROTOCOLS 2
76 #define IOCNR_SET_PROTOCOL 3
77 #define IOCNR_HP_SET_CHANNEL 4
78 #define IOCNR_GET_BUS_ADDRESS 5
79 #define IOCNR_GET_VID_PID 6
80 #define IOCNR_SOFT_RESET 7
81 /* Get device_id string: */
82 #define LPIOC_GET_DEVICE_ID(len) _IOC(_IOC_READ, 'P', IOCNR_GET_DEVICE_ID, len)
83 /* The following ioctls were added for http://hpoj.sourceforge.net: */
85 * [0]=current protocol (1=7/1/1, 2=7/1/2, 3=7/1/3),
86 * [1]=supported protocol mask (mask&(1<<n)!=0 means 7/1/n supported): */
87 #define LPIOC_GET_PROTOCOLS(len) _IOC(_IOC_READ, 'P', IOCNR_GET_PROTOCOLS, len)
88 /* Set protocol (arg: 1=7/1/1, 2=7/1/2, 3=7/1/3): */
89 #define LPIOC_SET_PROTOCOL _IOC(_IOC_WRITE, 'P', IOCNR_SET_PROTOCOL, 0)
90 /* Set channel number (HP Vendor-specific command): */
91 #define LPIOC_HP_SET_CHANNEL _IOC(_IOC_WRITE, 'P', IOCNR_HP_SET_CHANNEL, 0)
92 /* Get two-int array: [0]=bus number, [1]=device address: */
93 #define LPIOC_GET_BUS_ADDRESS(len) _IOC(_IOC_READ, 'P', IOCNR_GET_BUS_ADDRESS, len)
94 /* Get two-int array: [0]=vendor ID, [1]=product ID: */
95 #define LPIOC_GET_VID_PID(len) _IOC(_IOC_READ, 'P', IOCNR_GET_VID_PID, len)
96 /* Perform class specific soft reset */
97 #define LPIOC_SOFT_RESET _IOC(_IOC_NONE, 'P', IOCNR_SOFT_RESET, 0);
100 * A DEVICE_ID string may include the printer's serial number.
101 * It should end with a semi-colon (';').
102 * An example from an HP 970C DeskJet printer is (this is one long string,
103 * with the serial number changed):
104 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: ;
108 * USB Printer Requests
111 #define USBLP_REQ_GET_ID 0x00
112 #define USBLP_REQ_GET_STATUS 0x01
113 #define USBLP_REQ_RESET 0x02
114 #define USBLP_REQ_HP_CHANNEL_CHANGE_REQUEST 0x00 /* HP Vendor-specific */
116 #define USBLP_MINORS 16
117 #define USBLP_MINOR_BASE 0
119 #define USBLP_WRITE_TIMEOUT (5000) /* 5 seconds */
121 #define USBLP_FIRST_PROTOCOL 1
122 #define USBLP_LAST_PROTOCOL 3
123 #define USBLP_MAX_PROTOCOLS (USBLP_LAST_PROTOCOL+1)
126 * some arbitrary status buffer size;
127 * need a status buffer that is allocated via kmalloc(), not on stack
129 #define STATUS_BUF_SIZE 8
132 struct usb_device *dev; /* USB device */
133 struct semaphore sem; /* locks this struct, especially "dev" */
134 char *writebuf; /* write transfer_buffer */
135 char *readbuf; /* read transfer_buffer */
136 char *statusbuf; /* status transfer_buffer */
137 struct urb *readurb, *writeurb; /* The urbs */
138 wait_queue_head_t wait; /* Zzzzz ... */
139 int readcount; /* Counter for reads */
140 int ifnum; /* Interface number */
141 struct usb_interface *intf; /* The interface */
142 /* Alternate-setting numbers and endpoints for each protocol
143 * (7/1/{index=1,2,3}) that the device supports: */
146 struct usb_endpoint_descriptor *epwrite;
147 struct usb_endpoint_descriptor *epread;
148 } protocol[USBLP_MAX_PROTOCOLS];
149 int current_protocol;
150 int minor; /* minor number of device */
151 int wcomplete; /* writing is completed */
152 int rcomplete; /* reading is completed */
153 unsigned int quirks; /* quirks flags */
154 unsigned char used; /* True if open */
155 unsigned char present; /* True if not disconnected */
156 unsigned char bidir; /* interface is bidirectional */
157 unsigned char sleeping; /* interface is suspended */
158 unsigned char *device_id_string; /* IEEE 1284 DEVICE ID string (ptr) */
159 /* first 2 bytes are (big-endian) length */
163 static void usblp_dump(struct usblp *usblp) {
166 dbg("usblp=0x%p", usblp);
167 dbg("dev=0x%p", usblp->dev);
168 dbg("present=%d", usblp->present);
169 dbg("readbuf=0x%p", usblp->readbuf);
170 dbg("writebuf=0x%p", usblp->writebuf);
171 dbg("readurb=0x%p", usblp->readurb);
172 dbg("writeurb=0x%p", usblp->writeurb);
173 dbg("readcount=%d", usblp->readcount);
174 dbg("ifnum=%d", usblp->ifnum);
175 for (p = USBLP_FIRST_PROTOCOL; p <= USBLP_LAST_PROTOCOL; p++) {
176 dbg("protocol[%d].alt_setting=%d", p, usblp->protocol[p].alt_setting);
177 dbg("protocol[%d].epwrite=%p", p, usblp->protocol[p].epwrite);
178 dbg("protocol[%d].epread=%p", p, usblp->protocol[p].epread);
180 dbg("current_protocol=%d", usblp->current_protocol);
181 dbg("minor=%d", usblp->minor);
182 dbg("wcomplete=%d", usblp->wcomplete);
183 dbg("rcomplete=%d", usblp->rcomplete);
184 dbg("quirks=%d", usblp->quirks);
185 dbg("used=%d", usblp->used);
186 dbg("bidir=%d", usblp->bidir);
187 dbg("sleeping=%d", usblp->sleeping);
188 dbg("device_id_string=\"%s\"",
189 usblp->device_id_string ?
190 usblp->device_id_string + 2 :
191 (unsigned char *)"(null)");
195 /* Quirks: various printer quirks are handled by this table & its flags. */
197 struct quirk_printer_struct {
203 #define USBLP_QUIRK_BIDIR 0x1 /* reports bidir but requires unidirectional mode (no INs/reads) */
204 #define USBLP_QUIRK_USB_INIT 0x2 /* needs vendor USB init string */
206 static const struct quirk_printer_struct quirk_printers[] = {
207 { 0x03f0, 0x0004, USBLP_QUIRK_BIDIR }, /* HP DeskJet 895C */
208 { 0x03f0, 0x0104, USBLP_QUIRK_BIDIR }, /* HP DeskJet 880C */
209 { 0x03f0, 0x0204, USBLP_QUIRK_BIDIR }, /* HP DeskJet 815C */
210 { 0x03f0, 0x0304, USBLP_QUIRK_BIDIR }, /* HP DeskJet 810C/812C */
211 { 0x03f0, 0x0404, USBLP_QUIRK_BIDIR }, /* HP DeskJet 830C */
212 { 0x03f0, 0x0504, USBLP_QUIRK_BIDIR }, /* HP DeskJet 885C */
213 { 0x03f0, 0x0604, USBLP_QUIRK_BIDIR }, /* HP DeskJet 840C */
214 { 0x03f0, 0x0804, USBLP_QUIRK_BIDIR }, /* HP DeskJet 816C */
215 { 0x03f0, 0x1104, USBLP_QUIRK_BIDIR }, /* HP Deskjet 959C */
216 { 0x0409, 0xefbe, USBLP_QUIRK_BIDIR }, /* NEC Picty900 (HP OEM) */
217 { 0x0409, 0xbef4, USBLP_QUIRK_BIDIR }, /* NEC Picty760 (HP OEM) */
218 { 0x0409, 0xf0be, USBLP_QUIRK_BIDIR }, /* NEC Picty920 (HP OEM) */
219 { 0x0409, 0xf1be, USBLP_QUIRK_BIDIR }, /* NEC Picty800 (HP OEM) */
223 static int usblp_select_alts(struct usblp *usblp);
224 static int usblp_set_protocol(struct usblp *usblp, int protocol);
225 static int usblp_cache_device_id_string(struct usblp *usblp);
227 /* forward reference to make our lives easier */
228 static struct usb_driver usblp_driver;
229 static DEFINE_MUTEX(usblp_mutex); /* locks the existence of usblp's */
232 * Functions for usblp control messages.
235 static int usblp_ctrl_msg(struct usblp *usblp, int request, int type, int dir, int recip, int value, void *buf, int len)
238 int index = usblp->ifnum;
240 /* High byte has the interface index.
241 Low byte has the alternate setting.
243 if ((request == USBLP_REQ_GET_ID) && (type == USB_TYPE_CLASS)) {
244 index = (usblp->ifnum<<8)|usblp->protocol[usblp->current_protocol].alt_setting;
247 retval = usb_control_msg(usblp->dev,
248 dir ? usb_rcvctrlpipe(usblp->dev, 0) : usb_sndctrlpipe(usblp->dev, 0),
249 request, type | dir | recip, value, index, buf, len, USBLP_WRITE_TIMEOUT);
250 dbg("usblp_control_msg: rq: 0x%02x dir: %d recip: %d value: %d idx: %d len: %#x result: %d",
251 request, !!dir, recip, value, index, len, retval);
252 return retval < 0 ? retval : 0;
255 #define usblp_read_status(usblp, status)\
256 usblp_ctrl_msg(usblp, USBLP_REQ_GET_STATUS, USB_TYPE_CLASS, USB_DIR_IN, USB_RECIP_INTERFACE, 0, status, 1)
257 #define usblp_get_id(usblp, config, id, maxlen)\
258 usblp_ctrl_msg(usblp, USBLP_REQ_GET_ID, USB_TYPE_CLASS, USB_DIR_IN, USB_RECIP_INTERFACE, config, id, maxlen)
259 #define usblp_reset(usblp)\
260 usblp_ctrl_msg(usblp, USBLP_REQ_RESET, USB_TYPE_CLASS, USB_DIR_OUT, USB_RECIP_OTHER, 0, NULL, 0)
262 #define usblp_hp_channel_change_request(usblp, channel, buffer) \
263 usblp_ctrl_msg(usblp, USBLP_REQ_HP_CHANNEL_CHANGE_REQUEST, USB_TYPE_VENDOR, USB_DIR_IN, USB_RECIP_INTERFACE, channel, buffer, 1)
266 * See the description for usblp_select_alts() below for the usage
267 * explanation. Look into your /proc/bus/usb/devices and dmesg in
268 * case of any trouble.
270 static int proto_bias = -1;
276 static void usblp_bulk_read(struct urb *urb)
278 struct usblp *usblp = urb->context;
280 if (unlikely(!usblp || !usblp->dev || !usblp->used))
283 if (unlikely(!usblp->present))
285 if (unlikely(urb->status))
286 warn("usblp%d: nonzero read/write bulk status received: %d",
287 usblp->minor, urb->status);
288 usblp->rcomplete = 1;
290 wake_up_interruptible(&usblp->wait);
293 static void usblp_bulk_write(struct urb *urb)
295 struct usblp *usblp = urb->context;
297 if (unlikely(!usblp || !usblp->dev || !usblp->used))
299 if (unlikely(!usblp->present))
301 if (unlikely(urb->status))
302 warn("usblp%d: nonzero read/write bulk status received: %d",
303 usblp->minor, urb->status);
304 usblp->wcomplete = 1;
306 wake_up_interruptible(&usblp->wait);
310 * Get and print printer errors.
313 static const char *usblp_messages[] = { "ok", "out of paper", "off-line", "on fire" };
315 static int usblp_check_status(struct usblp *usblp, int err)
317 unsigned char status, newerr = 0;
320 error = usblp_read_status (usblp, usblp->statusbuf);
322 if (printk_ratelimit())
323 err("usblp%d: error %d reading printer status",
324 usblp->minor, error);
328 status = *usblp->statusbuf;
330 if (~status & LP_PERRORP)
332 if (status & LP_POUTPA)
334 if (~status & LP_PSELECD)
338 info("usblp%d: %s", usblp->minor, usblp_messages[newerr]);
343 static int handle_bidir (struct usblp *usblp)
345 if (usblp->bidir && usblp->used && !usblp->sleeping) {
346 usblp->readcount = 0;
347 usblp->readurb->dev = usblp->dev;
348 if (usb_submit_urb(usblp->readurb, GFP_KERNEL) < 0) {
361 static int usblp_open(struct inode *inode, struct file *file)
363 int minor = iminor(inode);
365 struct usb_interface *intf;
371 mutex_lock (&usblp_mutex);
374 intf = usb_find_interface(&usblp_driver, minor);
378 usblp = usb_get_intfdata (intf);
379 if (!usblp || !usblp->dev || !usblp->present)
387 * TODO: need to implement LP_ABORTOPEN + O_NONBLOCK as in drivers/char/lp.c ???
388 * This is #if 0-ed because we *don't* want to fail an open
389 * just because the printer is off-line.
392 if ((retval = usblp_check_status(usblp, 0))) {
393 retval = retval > 1 ? -EIO : -ENOSPC;
401 file->private_data = usblp;
403 usblp->writeurb->transfer_buffer_length = 0;
404 usblp->wcomplete = 1; /* we begin writeable */
405 usblp->rcomplete = 0;
406 usblp->writeurb->status = 0;
407 usblp->readurb->status = 0;
409 if (handle_bidir(usblp) < 0) {
410 file->private_data = NULL;
414 mutex_unlock (&usblp_mutex);
418 static void usblp_cleanup (struct usblp *usblp)
420 info("usblp%d: removed", usblp->minor);
422 kfree (usblp->device_id_string);
423 kfree (usblp->statusbuf);
424 usb_free_urb(usblp->writeurb);
425 usb_free_urb(usblp->readurb);
429 static void usblp_unlink_urbs(struct usblp *usblp)
431 usb_kill_urb(usblp->writeurb);
433 usb_kill_urb(usblp->readurb);
436 static int usblp_release(struct inode *inode, struct file *file)
438 struct usblp *usblp = file->private_data;
440 mutex_lock (&usblp_mutex);
442 if (usblp->present) {
443 usblp_unlink_urbs(usblp);
444 } else /* finish cleanup from disconnect */
445 usblp_cleanup (usblp);
446 mutex_unlock (&usblp_mutex);
450 /* No kernel lock - fine */
451 static unsigned int usblp_poll(struct file *file, struct poll_table_struct *wait)
453 struct usblp *usblp = file->private_data;
454 poll_wait(file, &usblp->wait, wait);
455 return ((!usblp->bidir || !usblp->rcomplete) ? 0 : POLLIN | POLLRDNORM)
456 | (!usblp->wcomplete ? 0 : POLLOUT | POLLWRNORM);
459 static long usblp_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
461 struct usblp *usblp = file->private_data;
463 unsigned char newChannel;
469 if (!usblp->present) {
474 if (usblp->sleeping) {
479 dbg("usblp_ioctl: cmd=0x%x (%c nr=%d len=%d dir=%d)", cmd, _IOC_TYPE(cmd),
480 _IOC_NR(cmd), _IOC_SIZE(cmd), _IOC_DIR(cmd) );
482 if (_IOC_TYPE(cmd) == 'P') /* new-style ioctl number */
484 switch (_IOC_NR(cmd)) {
486 case IOCNR_GET_DEVICE_ID: /* get the DEVICE_ID string */
487 if (_IOC_DIR(cmd) != _IOC_READ) {
492 length = usblp_cache_device_id_string(usblp);
497 if (length > _IOC_SIZE(cmd))
498 length = _IOC_SIZE(cmd); /* truncate */
500 if (copy_to_user((void __user *) arg,
501 usblp->device_id_string,
502 (unsigned long) length)) {
509 case IOCNR_GET_PROTOCOLS:
510 if (_IOC_DIR(cmd) != _IOC_READ ||
511 _IOC_SIZE(cmd) < sizeof(twoints)) {
516 twoints[0] = usblp->current_protocol;
518 for (i = USBLP_FIRST_PROTOCOL;
519 i <= USBLP_LAST_PROTOCOL; i++) {
520 if (usblp->protocol[i].alt_setting >= 0)
521 twoints[1] |= (1<<i);
524 if (copy_to_user((void __user *)arg,
525 (unsigned char *)twoints,
533 case IOCNR_SET_PROTOCOL:
534 if (_IOC_DIR(cmd) != _IOC_WRITE) {
546 usblp_unlink_urbs(usblp);
547 retval = usblp_set_protocol(usblp, arg);
549 usblp_set_protocol(usblp,
550 usblp->current_protocol);
554 case IOCNR_HP_SET_CHANNEL:
555 if (_IOC_DIR(cmd) != _IOC_WRITE ||
556 le16_to_cpu(usblp->dev->descriptor.idVendor) != 0x03F0 ||
557 usblp->quirks & USBLP_QUIRK_BIDIR) {
562 err = usblp_hp_channel_change_request(usblp,
565 err("usblp%d: error = %d setting "
572 dbg("usblp%d requested/got HP channel %ld/%d",
573 usblp->minor, arg, newChannel);
576 case IOCNR_GET_BUS_ADDRESS:
577 if (_IOC_DIR(cmd) != _IOC_READ ||
578 _IOC_SIZE(cmd) < sizeof(twoints)) {
583 twoints[0] = usblp->dev->bus->busnum;
584 twoints[1] = usblp->dev->devnum;
585 if (copy_to_user((void __user *)arg,
586 (unsigned char *)twoints,
592 dbg("usblp%d is bus=%d, device=%d",
593 usblp->minor, twoints[0], twoints[1]);
596 case IOCNR_GET_VID_PID:
597 if (_IOC_DIR(cmd) != _IOC_READ ||
598 _IOC_SIZE(cmd) < sizeof(twoints)) {
603 twoints[0] = le16_to_cpu(usblp->dev->descriptor.idVendor);
604 twoints[1] = le16_to_cpu(usblp->dev->descriptor.idProduct);
605 if (copy_to_user((void __user *)arg,
606 (unsigned char *)twoints,
612 dbg("usblp%d is VID=0x%4.4X, PID=0x%4.4X",
613 usblp->minor, twoints[0], twoints[1]);
616 case IOCNR_SOFT_RESET:
617 if (_IOC_DIR(cmd) != _IOC_NONE) {
621 retval = usblp_reset(usblp);
626 else /* old-style ioctl value */
630 if (usblp_read_status(usblp, usblp->statusbuf)) {
631 if (printk_ratelimit())
632 err("usblp%d: failed reading printer status",
637 status = *usblp->statusbuf;
638 if (copy_to_user ((void __user *)arg, &status, sizeof(int)))
651 static ssize_t usblp_write(struct file *file, const char __user *buffer, size_t count, loff_t *ppos)
653 struct usblp *usblp = file->private_data;
654 int timeout, rv, err = 0, transfer_length = 0;
655 size_t writecount = 0;
657 while (writecount < count) {
658 if (!usblp->wcomplete) {
660 if (file->f_flags & O_NONBLOCK) {
661 writecount += transfer_length;
662 return writecount ? writecount : -EAGAIN;
665 timeout = USBLP_WRITE_TIMEOUT;
667 rv = wait_event_interruptible_timeout(usblp->wait, usblp->wcomplete || !usblp->present , timeout);
669 return writecount ? writecount : -EINTR;
672 if (!usblp->present) {
677 if (usblp->sleeping) {
679 return writecount ? writecount : -ENODEV;
682 if (usblp->writeurb->status != 0) {
683 if (usblp->quirks & USBLP_QUIRK_BIDIR) {
684 if (!usblp->wcomplete)
685 err("usblp%d: error %d writing to printer",
686 usblp->minor, usblp->writeurb->status);
687 err = usblp->writeurb->status;
689 err = usblp_check_status(usblp, err);
692 /* if the fault was due to disconnect, let khubd's
693 * call to usblp_disconnect() grab usblp->sem ...
699 /* We must increment writecount here, and not at the
700 * end of the loop. Otherwise, the final loop iteration may
701 * be skipped, leading to incomplete printer output.
703 writecount += transfer_length;
704 if (writecount == count) {
709 transfer_length=(count - writecount);
710 if (transfer_length > USBLP_BUF_SIZE)
711 transfer_length = USBLP_BUF_SIZE;
713 usblp->writeurb->transfer_buffer_length = transfer_length;
715 if (copy_from_user(usblp->writeurb->transfer_buffer,
716 buffer + writecount, transfer_length)) {
718 return writecount ? writecount : -EFAULT;
721 usblp->writeurb->dev = usblp->dev;
722 usblp->wcomplete = 0;
723 err = usb_submit_urb(usblp->writeurb, GFP_KERNEL);
728 count = writecount ? writecount : -ENOMEM;
738 static ssize_t usblp_read(struct file *file, char __user *buffer, size_t count, loff_t *ppos)
740 struct usblp *usblp = file->private_data;
747 if (!usblp->present) {
752 if (!usblp->rcomplete) {
755 if (file->f_flags & O_NONBLOCK) {
760 rv = wait_event_interruptible(usblp->wait, usblp->rcomplete || !usblp->present);
768 if (!usblp->present) {
773 if (usblp->sleeping) {
778 if (usblp->readurb->status) {
779 err("usblp%d: error %d reading from printer",
780 usblp->minor, usblp->readurb->status);
781 usblp->readurb->dev = usblp->dev;
782 usblp->readcount = 0;
783 usblp->rcomplete = 0;
784 if (usb_submit_urb(usblp->readurb, GFP_KERNEL) < 0)
785 dbg("error submitting urb");
790 count = count < usblp->readurb->actual_length - usblp->readcount ?
791 count : usblp->readurb->actual_length - usblp->readcount;
793 if (copy_to_user(buffer, usblp->readurb->transfer_buffer + usblp->readcount, count)) {
798 if ((usblp->readcount += count) == usblp->readurb->actual_length) {
799 usblp->readcount = 0;
800 usblp->readurb->dev = usblp->dev;
801 usblp->rcomplete = 0;
802 if (usb_submit_urb(usblp->readurb, GFP_KERNEL)) {
814 * Checks for printers that have quirks, such as requiring unidirectional
815 * communication but reporting bidirectional; currently some HP printers
816 * have this flaw (HP 810, 880, 895, etc.), or needing an init string
817 * sent at each open (like some Epsons).
818 * Returns 1 if found, 0 if not found.
820 * HP recommended that we use the bidirectional interface but
821 * don't attempt any bulk IN transfers from the IN endpoint.
822 * Here's some more detail on the problem:
823 * The problem is not that it isn't bidirectional though. The problem
824 * is that if you request a device ID, or status information, while
825 * the buffers are full, the return data will end up in the print data
826 * buffer. For example if you make sure you never request the device ID
827 * while you are sending print data, and you don't try to query the
828 * printer status every couple of milliseconds, you will probably be OK.
830 static unsigned int usblp_quirks (__u16 vendor, __u16 product)
834 for (i = 0; quirk_printers[i].vendorId; i++) {
835 if (vendor == quirk_printers[i].vendorId &&
836 product == quirk_printers[i].productId)
837 return quirk_printers[i].quirks;
842 static const struct file_operations usblp_fops = {
843 .owner = THIS_MODULE,
845 .write = usblp_write,
847 .unlocked_ioctl = usblp_ioctl,
848 .compat_ioctl = usblp_ioctl,
850 .release = usblp_release,
853 static struct usb_class_driver usblp_class = {
856 .minor_base = USBLP_MINOR_BASE,
859 static ssize_t usblp_show_ieee1284_id(struct device *dev, struct device_attribute *attr, char *buf)
861 struct usb_interface *intf = to_usb_interface(dev);
862 struct usblp *usblp = usb_get_intfdata (intf);
864 if (usblp->device_id_string[0] == 0 &&
865 usblp->device_id_string[1] == 0)
868 return sprintf(buf, "%s", usblp->device_id_string+2);
871 static DEVICE_ATTR(ieee1284_id, S_IRUGO, usblp_show_ieee1284_id, NULL);
873 static int usblp_probe(struct usb_interface *intf,
874 const struct usb_device_id *id)
876 struct usb_device *dev = interface_to_usbdev (intf);
877 struct usblp *usblp = NULL;
881 /* Malloc and start initializing usblp structure so we can use it
883 if (!(usblp = kzalloc(sizeof(struct usblp), GFP_KERNEL))) {
884 err("out of memory for usblp");
888 init_MUTEX (&usblp->sem);
889 init_waitqueue_head(&usblp->wait);
890 usblp->ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
893 usblp->writeurb = usb_alloc_urb(0, GFP_KERNEL);
894 if (!usblp->writeurb) {
895 err("out of memory");
898 usblp->readurb = usb_alloc_urb(0, GFP_KERNEL);
899 if (!usblp->readurb) {
900 err("out of memory");
904 /* Malloc device ID string buffer to the largest expected length,
905 * since we can re-query it on an ioctl and a dynamic string
906 * could change in length. */
907 if (!(usblp->device_id_string = kmalloc(USBLP_DEVICE_ID_SIZE, GFP_KERNEL))) {
908 err("out of memory for device_id_string");
912 usblp->writebuf = usblp->readbuf = NULL;
913 usblp->writeurb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
914 usblp->readurb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
915 /* Malloc write & read buffers. We somewhat wastefully
916 * malloc both regardless of bidirectionality, because the
917 * alternate setting can be changed later via an ioctl. */
918 if (!(usblp->writebuf = usb_buffer_alloc(dev, USBLP_BUF_SIZE,
919 GFP_KERNEL, &usblp->writeurb->transfer_dma))) {
920 err("out of memory for write buf");
923 if (!(usblp->readbuf = usb_buffer_alloc(dev, USBLP_BUF_SIZE,
924 GFP_KERNEL, &usblp->readurb->transfer_dma))) {
925 err("out of memory for read buf");
929 /* Allocate buffer for printer status */
930 usblp->statusbuf = kmalloc(STATUS_BUF_SIZE, GFP_KERNEL);
931 if (!usblp->statusbuf) {
932 err("out of memory for statusbuf");
936 /* Lookup quirks for this printer. */
937 usblp->quirks = usblp_quirks(
938 le16_to_cpu(dev->descriptor.idVendor),
939 le16_to_cpu(dev->descriptor.idProduct));
941 /* Analyze and pick initial alternate settings and endpoints. */
942 protocol = usblp_select_alts(usblp);
944 dbg("incompatible printer-class device 0x%4.4X/0x%4.4X",
945 le16_to_cpu(dev->descriptor.idVendor),
946 le16_to_cpu(dev->descriptor.idProduct));
950 /* Setup the selected alternate setting and endpoints. */
951 if (usblp_set_protocol(usblp, protocol) < 0)
954 /* Retrieve and store the device ID string. */
955 usblp_cache_device_id_string(usblp);
956 retval = device_create_file(&intf->dev, &dev_attr_ieee1284_id);
961 usblp_check_status(usblp, 0);
964 usb_set_intfdata (intf, usblp);
968 retval = usb_register_dev(intf, &usblp_class);
970 err("Not able to get a minor for this device.");
973 usblp->minor = intf->minor;
974 info("usblp%d: USB %sdirectional printer dev %d "
975 "if %d alt %d proto %d vid 0x%4.4X pid 0x%4.4X",
976 usblp->minor, usblp->bidir ? "Bi" : "Uni", dev->devnum,
978 usblp->protocol[usblp->current_protocol].alt_setting,
979 usblp->current_protocol,
980 le16_to_cpu(usblp->dev->descriptor.idVendor),
981 le16_to_cpu(usblp->dev->descriptor.idProduct));
986 usb_set_intfdata (intf, NULL);
987 device_remove_file(&intf->dev, &dev_attr_ieee1284_id);
991 usb_buffer_free (usblp->dev, USBLP_BUF_SIZE,
992 usblp->writebuf, usblp->writeurb->transfer_dma);
994 usb_buffer_free (usblp->dev, USBLP_BUF_SIZE,
995 usblp->readbuf, usblp->writeurb->transfer_dma);
996 kfree(usblp->statusbuf);
997 kfree(usblp->device_id_string);
998 usb_free_urb(usblp->writeurb);
999 usb_free_urb(usblp->readurb);
1006 * We are a "new" style driver with usb_device_id table,
1007 * but our requirements are too intricate for simple match to handle.
1009 * The "proto_bias" option may be used to specify the preferred protocol
1010 * for all USB printers (1=7/1/1, 2=7/1/2, 3=7/1/3). If the device
1011 * supports the preferred protocol, then we bind to it.
1013 * The best interface for us is 7/1/2, because it is compatible
1014 * with a stream of characters. If we find it, we bind to it.
1016 * Note that the people from hpoj.sourceforge.net need to be able to
1017 * bind to 7/1/3 (MLC/1284.4), so we provide them ioctls for this purpose.
1019 * Failing 7/1/2, we look for 7/1/3, even though it's probably not
1020 * stream-compatible, because this matches the behaviour of the old code.
1022 * If nothing else, we bind to 7/1/1 - the unidirectional interface.
1024 static int usblp_select_alts(struct usblp *usblp)
1026 struct usb_interface *if_alt;
1027 struct usb_host_interface *ifd;
1028 struct usb_endpoint_descriptor *epd, *epwrite, *epread;
1031 if_alt = usblp->intf;
1033 for (p = 0; p < USBLP_MAX_PROTOCOLS; p++)
1034 usblp->protocol[p].alt_setting = -1;
1036 /* Find out what we have. */
1037 for (i = 0; i < if_alt->num_altsetting; i++) {
1038 ifd = &if_alt->altsetting[i];
1040 if (ifd->desc.bInterfaceClass != 7 || ifd->desc.bInterfaceSubClass != 1)
1043 if (ifd->desc.bInterfaceProtocol < USBLP_FIRST_PROTOCOL ||
1044 ifd->desc.bInterfaceProtocol > USBLP_LAST_PROTOCOL)
1047 /* Look for bulk OUT and IN endpoints. */
1048 epwrite = epread = NULL;
1049 for (e = 0; e < ifd->desc.bNumEndpoints; e++) {
1050 epd = &ifd->endpoint[e].desc;
1052 if (usb_endpoint_is_bulk_out(epd))
1056 if (usb_endpoint_is_bulk_in(epd))
1061 /* Ignore buggy hardware without the right endpoints. */
1062 if (!epwrite || (ifd->desc.bInterfaceProtocol > 1 && !epread))
1065 /* Turn off reads for 7/1/1 (unidirectional) interfaces
1066 * and buggy bidirectional printers. */
1067 if (ifd->desc.bInterfaceProtocol == 1) {
1069 } else if (usblp->quirks & USBLP_QUIRK_BIDIR) {
1070 info("Disabling reads from problem bidirectional "
1071 "printer on usblp%d", usblp->minor);
1075 usblp->protocol[ifd->desc.bInterfaceProtocol].alt_setting =
1076 ifd->desc.bAlternateSetting;
1077 usblp->protocol[ifd->desc.bInterfaceProtocol].epwrite = epwrite;
1078 usblp->protocol[ifd->desc.bInterfaceProtocol].epread = epread;
1081 /* If our requested protocol is supported, then use it. */
1082 if (proto_bias >= USBLP_FIRST_PROTOCOL &&
1083 proto_bias <= USBLP_LAST_PROTOCOL &&
1084 usblp->protocol[proto_bias].alt_setting != -1)
1087 /* Ordering is important here. */
1088 if (usblp->protocol[2].alt_setting != -1)
1090 if (usblp->protocol[1].alt_setting != -1)
1092 if (usblp->protocol[3].alt_setting != -1)
1095 /* If nothing is available, then don't bind to this device. */
1099 static int usblp_set_protocol(struct usblp *usblp, int protocol)
1103 if (protocol < USBLP_FIRST_PROTOCOL || protocol > USBLP_LAST_PROTOCOL)
1106 alts = usblp->protocol[protocol].alt_setting;
1109 r = usb_set_interface(usblp->dev, usblp->ifnum, alts);
1111 err("can't set desired altsetting %d on interface %d",
1112 alts, usblp->ifnum);
1116 usb_fill_bulk_urb(usblp->writeurb, usblp->dev,
1117 usb_sndbulkpipe(usblp->dev,
1118 usblp->protocol[protocol].epwrite->bEndpointAddress),
1120 usblp_bulk_write, usblp);
1122 usblp->bidir = (usblp->protocol[protocol].epread != NULL);
1124 usb_fill_bulk_urb(usblp->readurb, usblp->dev,
1125 usb_rcvbulkpipe(usblp->dev,
1126 usblp->protocol[protocol].epread->bEndpointAddress),
1127 usblp->readbuf, USBLP_BUF_SIZE,
1128 usblp_bulk_read, usblp);
1130 usblp->current_protocol = protocol;
1131 dbg("usblp%d set protocol %d", usblp->minor, protocol);
1135 /* Retrieves and caches device ID string.
1136 * Returns length, including length bytes but not null terminator.
1137 * On error, returns a negative errno value. */
1138 static int usblp_cache_device_id_string(struct usblp *usblp)
1142 err = usblp_get_id(usblp, 0, usblp->device_id_string, USBLP_DEVICE_ID_SIZE - 1);
1144 dbg("usblp%d: error = %d reading IEEE-1284 Device ID string",
1146 usblp->device_id_string[0] = usblp->device_id_string[1] = '\0';
1150 /* First two bytes are length in big-endian.
1151 * They count themselves, and we copy them into
1152 * the user's buffer. */
1153 length = be16_to_cpu(*((__be16 *)usblp->device_id_string));
1156 else if (length >= USBLP_DEVICE_ID_SIZE)
1157 length = USBLP_DEVICE_ID_SIZE - 1;
1158 usblp->device_id_string[length] = '\0';
1160 dbg("usblp%d Device ID string [len=%d]=\"%s\"",
1161 usblp->minor, length, &usblp->device_id_string[2]);
1166 static void usblp_disconnect(struct usb_interface *intf)
1168 struct usblp *usblp = usb_get_intfdata (intf);
1170 usb_deregister_dev(intf, &usblp_class);
1172 if (!usblp || !usblp->dev) {
1173 err("bogus disconnect");
1177 device_remove_file(&intf->dev, &dev_attr_ieee1284_id);
1179 mutex_lock (&usblp_mutex);
1182 usb_set_intfdata (intf, NULL);
1184 usblp_unlink_urbs(usblp);
1185 usb_buffer_free (usblp->dev, USBLP_BUF_SIZE,
1186 usblp->writebuf, usblp->writeurb->transfer_dma);
1187 usb_buffer_free (usblp->dev, USBLP_BUF_SIZE,
1188 usblp->readbuf, usblp->readurb->transfer_dma);
1192 usblp_cleanup (usblp);
1193 mutex_unlock (&usblp_mutex);
1196 static int usblp_suspend (struct usb_interface *intf, pm_message_t message)
1198 struct usblp *usblp = usb_get_intfdata (intf);
1200 /* this races against normal access and open */
1201 mutex_lock (&usblp_mutex);
1203 /* we take no more IO */
1204 usblp->sleeping = 1;
1205 /* we wait for anything printing */
1206 wait_event (usblp->wait, usblp->wcomplete || !usblp->present);
1207 usblp_unlink_urbs(usblp);
1209 mutex_unlock (&usblp_mutex);
1214 static int usblp_resume (struct usb_interface *intf)
1216 struct usblp *usblp = usb_get_intfdata (intf);
1219 mutex_lock (&usblp_mutex);
1222 usblp->sleeping = 0;
1223 r = handle_bidir (usblp);
1226 mutex_unlock (&usblp_mutex);
1231 static struct usb_device_id usblp_ids [] = {
1232 { USB_DEVICE_INFO(7, 1, 1) },
1233 { USB_DEVICE_INFO(7, 1, 2) },
1234 { USB_DEVICE_INFO(7, 1, 3) },
1235 { USB_INTERFACE_INFO(7, 1, 1) },
1236 { USB_INTERFACE_INFO(7, 1, 2) },
1237 { USB_INTERFACE_INFO(7, 1, 3) },
1238 { } /* Terminating entry */
1241 MODULE_DEVICE_TABLE (usb, usblp_ids);
1243 static struct usb_driver usblp_driver = {
1245 .probe = usblp_probe,
1246 .disconnect = usblp_disconnect,
1247 .suspend = usblp_suspend,
1248 .resume = usblp_resume,
1249 .id_table = usblp_ids,
1252 static int __init usblp_init(void)
1255 retval = usb_register(&usblp_driver);
1257 info(DRIVER_VERSION ": " DRIVER_DESC);
1262 static void __exit usblp_exit(void)
1264 usb_deregister(&usblp_driver);
1267 module_init(usblp_init);
1268 module_exit(usblp_exit);
1270 MODULE_AUTHOR( DRIVER_AUTHOR );
1271 MODULE_DESCRIPTION( DRIVER_DESC );
1272 module_param(proto_bias, int, S_IRUGO | S_IWUSR);
1273 MODULE_PARM_DESC(proto_bias, "Favourite protocol number");
1274 MODULE_LICENSE("GPL");