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 mutex mut; /* 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) */
220 { 0x0482, 0x0010, USBLP_QUIRK_BIDIR }, /* Kyocera Mita FS 820, by zut <kernel@zut.de> */
224 static int usblp_select_alts(struct usblp *usblp);
225 static int usblp_set_protocol(struct usblp *usblp, int protocol);
226 static int usblp_cache_device_id_string(struct usblp *usblp);
228 /* forward reference to make our lives easier */
229 static struct usb_driver usblp_driver;
230 static DEFINE_MUTEX(usblp_mutex); /* locks the existence of usblp's */
233 * Functions for usblp control messages.
236 static int usblp_ctrl_msg(struct usblp *usblp, int request, int type, int dir, int recip, int value, void *buf, int len)
239 int index = usblp->ifnum;
241 /* High byte has the interface index.
242 Low byte has the alternate setting.
244 if ((request == USBLP_REQ_GET_ID) && (type == USB_TYPE_CLASS)) {
245 index = (usblp->ifnum<<8)|usblp->protocol[usblp->current_protocol].alt_setting;
248 retval = usb_control_msg(usblp->dev,
249 dir ? usb_rcvctrlpipe(usblp->dev, 0) : usb_sndctrlpipe(usblp->dev, 0),
250 request, type | dir | recip, value, index, buf, len, USBLP_WRITE_TIMEOUT);
251 dbg("usblp_control_msg: rq: 0x%02x dir: %d recip: %d value: %d idx: %d len: %#x result: %d",
252 request, !!dir, recip, value, index, len, retval);
253 return retval < 0 ? retval : 0;
256 #define usblp_read_status(usblp, status)\
257 usblp_ctrl_msg(usblp, USBLP_REQ_GET_STATUS, USB_TYPE_CLASS, USB_DIR_IN, USB_RECIP_INTERFACE, 0, status, 1)
258 #define usblp_get_id(usblp, config, id, maxlen)\
259 usblp_ctrl_msg(usblp, USBLP_REQ_GET_ID, USB_TYPE_CLASS, USB_DIR_IN, USB_RECIP_INTERFACE, config, id, maxlen)
260 #define usblp_reset(usblp)\
261 usblp_ctrl_msg(usblp, USBLP_REQ_RESET, USB_TYPE_CLASS, USB_DIR_OUT, USB_RECIP_OTHER, 0, NULL, 0)
263 #define usblp_hp_channel_change_request(usblp, channel, buffer) \
264 usblp_ctrl_msg(usblp, USBLP_REQ_HP_CHANNEL_CHANGE_REQUEST, USB_TYPE_VENDOR, USB_DIR_IN, USB_RECIP_INTERFACE, channel, buffer, 1)
267 * See the description for usblp_select_alts() below for the usage
268 * explanation. Look into your /proc/bus/usb/devices and dmesg in
269 * case of any trouble.
271 static int proto_bias = -1;
277 static void usblp_bulk_read(struct urb *urb)
279 struct usblp *usblp = urb->context;
281 if (unlikely(!usblp || !usblp->dev || !usblp->used))
284 if (unlikely(!usblp->present))
286 if (unlikely(urb->status))
287 warn("usblp%d: nonzero read/write bulk status received: %d",
288 usblp->minor, urb->status);
289 usblp->rcomplete = 1;
291 wake_up_interruptible(&usblp->wait);
294 static void usblp_bulk_write(struct urb *urb)
296 struct usblp *usblp = urb->context;
298 if (unlikely(!usblp || !usblp->dev || !usblp->used))
300 if (unlikely(!usblp->present))
302 if (unlikely(urb->status))
303 warn("usblp%d: nonzero read/write bulk status received: %d",
304 usblp->minor, urb->status);
305 usblp->wcomplete = 1;
307 wake_up_interruptible(&usblp->wait);
311 * Get and print printer errors.
314 static const char *usblp_messages[] = { "ok", "out of paper", "off-line", "on fire" };
316 static int usblp_check_status(struct usblp *usblp, int err)
318 unsigned char status, newerr = 0;
321 error = usblp_read_status (usblp, usblp->statusbuf);
323 if (printk_ratelimit())
324 err("usblp%d: error %d reading printer status",
325 usblp->minor, error);
329 status = *usblp->statusbuf;
331 if (~status & LP_PERRORP)
333 if (status & LP_POUTPA)
335 if (~status & LP_PSELECD)
339 info("usblp%d: %s", usblp->minor, usblp_messages[newerr]);
344 static int handle_bidir (struct usblp *usblp)
346 if (usblp->bidir && usblp->used && !usblp->sleeping) {
347 usblp->readcount = 0;
348 usblp->readurb->dev = usblp->dev;
349 if (usb_submit_urb(usblp->readurb, GFP_KERNEL) < 0) {
362 static int usblp_open(struct inode *inode, struct file *file)
364 int minor = iminor(inode);
366 struct usb_interface *intf;
372 mutex_lock (&usblp_mutex);
375 intf = usb_find_interface(&usblp_driver, minor);
379 usblp = usb_get_intfdata (intf);
380 if (!usblp || !usblp->dev || !usblp->present)
388 * TODO: need to implement LP_ABORTOPEN + O_NONBLOCK as in drivers/char/lp.c ???
389 * This is #if 0-ed because we *don't* want to fail an open
390 * just because the printer is off-line.
393 if ((retval = usblp_check_status(usblp, 0))) {
394 retval = retval > 1 ? -EIO : -ENOSPC;
402 file->private_data = usblp;
404 usblp->writeurb->transfer_buffer_length = 0;
405 usblp->wcomplete = 1; /* we begin writeable */
406 usblp->rcomplete = 0;
407 usblp->writeurb->status = 0;
408 usblp->readurb->status = 0;
410 if (handle_bidir(usblp) < 0) {
411 file->private_data = NULL;
415 mutex_unlock (&usblp_mutex);
419 static void usblp_cleanup (struct usblp *usblp)
421 info("usblp%d: removed", usblp->minor);
423 kfree (usblp->device_id_string);
424 kfree (usblp->statusbuf);
425 usb_free_urb(usblp->writeurb);
426 usb_free_urb(usblp->readurb);
430 static void usblp_unlink_urbs(struct usblp *usblp)
432 usb_kill_urb(usblp->writeurb);
434 usb_kill_urb(usblp->readurb);
437 static int usblp_release(struct inode *inode, struct file *file)
439 struct usblp *usblp = file->private_data;
441 mutex_lock (&usblp_mutex);
443 if (usblp->present) {
444 usblp_unlink_urbs(usblp);
445 } else /* finish cleanup from disconnect */
446 usblp_cleanup (usblp);
447 mutex_unlock (&usblp_mutex);
451 /* No kernel lock - fine */
452 static unsigned int usblp_poll(struct file *file, struct poll_table_struct *wait)
454 struct usblp *usblp = file->private_data;
455 poll_wait(file, &usblp->wait, wait);
456 return ((!usblp->bidir || !usblp->rcomplete) ? 0 : POLLIN | POLLRDNORM)
457 | (!usblp->wcomplete ? 0 : POLLOUT | POLLWRNORM);
460 static long usblp_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
462 struct usblp *usblp = file->private_data;
464 unsigned char newChannel;
469 mutex_lock (&usblp->mut);
470 if (!usblp->present) {
475 if (usblp->sleeping) {
480 dbg("usblp_ioctl: cmd=0x%x (%c nr=%d len=%d dir=%d)", cmd, _IOC_TYPE(cmd),
481 _IOC_NR(cmd), _IOC_SIZE(cmd), _IOC_DIR(cmd) );
483 if (_IOC_TYPE(cmd) == 'P') /* new-style ioctl number */
485 switch (_IOC_NR(cmd)) {
487 case IOCNR_GET_DEVICE_ID: /* get the DEVICE_ID string */
488 if (_IOC_DIR(cmd) != _IOC_READ) {
493 length = usblp_cache_device_id_string(usblp);
498 if (length > _IOC_SIZE(cmd))
499 length = _IOC_SIZE(cmd); /* truncate */
501 if (copy_to_user((void __user *) arg,
502 usblp->device_id_string,
503 (unsigned long) length)) {
510 case IOCNR_GET_PROTOCOLS:
511 if (_IOC_DIR(cmd) != _IOC_READ ||
512 _IOC_SIZE(cmd) < sizeof(twoints)) {
517 twoints[0] = usblp->current_protocol;
519 for (i = USBLP_FIRST_PROTOCOL;
520 i <= USBLP_LAST_PROTOCOL; i++) {
521 if (usblp->protocol[i].alt_setting >= 0)
522 twoints[1] |= (1<<i);
525 if (copy_to_user((void __user *)arg,
526 (unsigned char *)twoints,
534 case IOCNR_SET_PROTOCOL:
535 if (_IOC_DIR(cmd) != _IOC_WRITE) {
547 usblp_unlink_urbs(usblp);
548 retval = usblp_set_protocol(usblp, arg);
550 usblp_set_protocol(usblp,
551 usblp->current_protocol);
555 case IOCNR_HP_SET_CHANNEL:
556 if (_IOC_DIR(cmd) != _IOC_WRITE ||
557 le16_to_cpu(usblp->dev->descriptor.idVendor) != 0x03F0 ||
558 usblp->quirks & USBLP_QUIRK_BIDIR) {
563 err = usblp_hp_channel_change_request(usblp,
566 err("usblp%d: error = %d setting "
573 dbg("usblp%d requested/got HP channel %ld/%d",
574 usblp->minor, arg, newChannel);
577 case IOCNR_GET_BUS_ADDRESS:
578 if (_IOC_DIR(cmd) != _IOC_READ ||
579 _IOC_SIZE(cmd) < sizeof(twoints)) {
584 twoints[0] = usblp->dev->bus->busnum;
585 twoints[1] = usblp->dev->devnum;
586 if (copy_to_user((void __user *)arg,
587 (unsigned char *)twoints,
593 dbg("usblp%d is bus=%d, device=%d",
594 usblp->minor, twoints[0], twoints[1]);
597 case IOCNR_GET_VID_PID:
598 if (_IOC_DIR(cmd) != _IOC_READ ||
599 _IOC_SIZE(cmd) < sizeof(twoints)) {
604 twoints[0] = le16_to_cpu(usblp->dev->descriptor.idVendor);
605 twoints[1] = le16_to_cpu(usblp->dev->descriptor.idProduct);
606 if (copy_to_user((void __user *)arg,
607 (unsigned char *)twoints,
613 dbg("usblp%d is VID=0x%4.4X, PID=0x%4.4X",
614 usblp->minor, twoints[0], twoints[1]);
617 case IOCNR_SOFT_RESET:
618 if (_IOC_DIR(cmd) != _IOC_NONE) {
622 retval = usblp_reset(usblp);
627 else /* old-style ioctl value */
631 if (usblp_read_status(usblp, usblp->statusbuf)) {
632 if (printk_ratelimit())
633 err("usblp%d: failed reading printer status",
638 status = *usblp->statusbuf;
639 if (copy_to_user ((void __user *)arg, &status, sizeof(int)))
648 mutex_unlock (&usblp->mut);
652 static ssize_t usblp_write(struct file *file, const char __user *buffer, size_t count, loff_t *ppos)
654 struct usblp *usblp = file->private_data;
655 int timeout, intr, rv, err = 0, transfer_length = 0;
656 size_t writecount = 0;
658 while (writecount < count) {
659 if (!usblp->wcomplete) {
661 if (file->f_flags & O_NONBLOCK) {
662 writecount += transfer_length;
663 return writecount ? writecount : -EAGAIN;
666 timeout = USBLP_WRITE_TIMEOUT;
668 rv = wait_event_interruptible_timeout(usblp->wait, usblp->wcomplete || !usblp->present , timeout);
670 return writecount ? writecount : -EINTR;
672 intr = mutex_lock_interruptible (&usblp->mut);
674 return writecount ? writecount : -EINTR;
675 if (!usblp->present) {
676 mutex_unlock (&usblp->mut);
680 if (usblp->sleeping) {
681 mutex_unlock (&usblp->mut);
682 return writecount ? writecount : -ENODEV;
685 if (usblp->writeurb->status != 0) {
686 if (usblp->quirks & USBLP_QUIRK_BIDIR) {
687 if (!usblp->wcomplete)
688 err("usblp%d: error %d writing to printer",
689 usblp->minor, usblp->writeurb->status);
690 err = usblp->writeurb->status;
692 err = usblp_check_status(usblp, err);
693 mutex_unlock (&usblp->mut);
695 /* if the fault was due to disconnect, let khubd's
696 * call to usblp_disconnect() grab usblp->mut ...
702 /* We must increment writecount here, and not at the
703 * end of the loop. Otherwise, the final loop iteration may
704 * be skipped, leading to incomplete printer output.
706 writecount += transfer_length;
707 if (writecount == count) {
708 mutex_unlock(&usblp->mut);
712 transfer_length=(count - writecount);
713 if (transfer_length > USBLP_BUF_SIZE)
714 transfer_length = USBLP_BUF_SIZE;
716 usblp->writeurb->transfer_buffer_length = transfer_length;
718 if (copy_from_user(usblp->writeurb->transfer_buffer,
719 buffer + writecount, transfer_length)) {
720 mutex_unlock(&usblp->mut);
721 return writecount ? writecount : -EFAULT;
724 usblp->writeurb->dev = usblp->dev;
725 usblp->wcomplete = 0;
726 err = usb_submit_urb(usblp->writeurb, GFP_KERNEL);
728 usblp->wcomplete = 1;
732 count = writecount ? writecount : -ENOMEM;
733 mutex_unlock (&usblp->mut);
736 mutex_unlock (&usblp->mut);
742 static ssize_t usblp_read(struct file *file, char __user *buffer, size_t count, loff_t *ppos)
744 struct usblp *usblp = file->private_data;
750 intr = mutex_lock_interruptible (&usblp->mut);
753 if (!usblp->present) {
758 if (!usblp->rcomplete) {
761 if (file->f_flags & O_NONBLOCK) {
765 mutex_unlock(&usblp->mut);
766 rv = wait_event_interruptible(usblp->wait, usblp->rcomplete || !usblp->present);
767 mutex_lock(&usblp->mut);
774 if (!usblp->present) {
779 if (usblp->sleeping) {
784 if (usblp->readurb->status) {
785 err("usblp%d: error %d reading from printer",
786 usblp->minor, usblp->readurb->status);
787 usblp->readurb->dev = usblp->dev;
788 usblp->readcount = 0;
789 usblp->rcomplete = 0;
790 if (usb_submit_urb(usblp->readurb, GFP_KERNEL) < 0)
791 dbg("error submitting urb");
796 count = count < usblp->readurb->actual_length - usblp->readcount ?
797 count : usblp->readurb->actual_length - usblp->readcount;
799 if (copy_to_user(buffer, usblp->readurb->transfer_buffer + usblp->readcount, count)) {
804 if ((usblp->readcount += count) == usblp->readurb->actual_length) {
805 usblp->readcount = 0;
806 usblp->readurb->dev = usblp->dev;
807 usblp->rcomplete = 0;
808 if (usb_submit_urb(usblp->readurb, GFP_KERNEL)) {
815 mutex_unlock (&usblp->mut);
820 * Checks for printers that have quirks, such as requiring unidirectional
821 * communication but reporting bidirectional; currently some HP printers
822 * have this flaw (HP 810, 880, 895, etc.), or needing an init string
823 * sent at each open (like some Epsons).
824 * Returns 1 if found, 0 if not found.
826 * HP recommended that we use the bidirectional interface but
827 * don't attempt any bulk IN transfers from the IN endpoint.
828 * Here's some more detail on the problem:
829 * The problem is not that it isn't bidirectional though. The problem
830 * is that if you request a device ID, or status information, while
831 * the buffers are full, the return data will end up in the print data
832 * buffer. For example if you make sure you never request the device ID
833 * while you are sending print data, and you don't try to query the
834 * printer status every couple of milliseconds, you will probably be OK.
836 static unsigned int usblp_quirks (__u16 vendor, __u16 product)
840 for (i = 0; quirk_printers[i].vendorId; i++) {
841 if (vendor == quirk_printers[i].vendorId &&
842 product == quirk_printers[i].productId)
843 return quirk_printers[i].quirks;
848 static const struct file_operations usblp_fops = {
849 .owner = THIS_MODULE,
851 .write = usblp_write,
853 .unlocked_ioctl = usblp_ioctl,
854 .compat_ioctl = usblp_ioctl,
856 .release = usblp_release,
859 static struct usb_class_driver usblp_class = {
862 .minor_base = USBLP_MINOR_BASE,
865 static ssize_t usblp_show_ieee1284_id(struct device *dev, struct device_attribute *attr, char *buf)
867 struct usb_interface *intf = to_usb_interface(dev);
868 struct usblp *usblp = usb_get_intfdata (intf);
870 if (usblp->device_id_string[0] == 0 &&
871 usblp->device_id_string[1] == 0)
874 return sprintf(buf, "%s", usblp->device_id_string+2);
877 static DEVICE_ATTR(ieee1284_id, S_IRUGO, usblp_show_ieee1284_id, NULL);
879 static int usblp_probe(struct usb_interface *intf,
880 const struct usb_device_id *id)
882 struct usb_device *dev = interface_to_usbdev (intf);
883 struct usblp *usblp = NULL;
887 /* Malloc and start initializing usblp structure so we can use it
889 if (!(usblp = kzalloc(sizeof(struct usblp), GFP_KERNEL))) {
890 err("out of memory for usblp");
894 mutex_init (&usblp->mut);
895 init_waitqueue_head(&usblp->wait);
896 usblp->ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
899 usblp->writeurb = usb_alloc_urb(0, GFP_KERNEL);
900 if (!usblp->writeurb) {
901 err("out of memory");
904 usblp->readurb = usb_alloc_urb(0, GFP_KERNEL);
905 if (!usblp->readurb) {
906 err("out of memory");
910 /* Malloc device ID string buffer to the largest expected length,
911 * since we can re-query it on an ioctl and a dynamic string
912 * could change in length. */
913 if (!(usblp->device_id_string = kmalloc(USBLP_DEVICE_ID_SIZE, GFP_KERNEL))) {
914 err("out of memory for device_id_string");
918 usblp->writebuf = usblp->readbuf = NULL;
919 usblp->writeurb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
920 usblp->readurb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
921 /* Malloc write & read buffers. We somewhat wastefully
922 * malloc both regardless of bidirectionality, because the
923 * alternate setting can be changed later via an ioctl. */
924 if (!(usblp->writebuf = usb_buffer_alloc(dev, USBLP_BUF_SIZE,
925 GFP_KERNEL, &usblp->writeurb->transfer_dma))) {
926 err("out of memory for write buf");
929 if (!(usblp->readbuf = usb_buffer_alloc(dev, USBLP_BUF_SIZE,
930 GFP_KERNEL, &usblp->readurb->transfer_dma))) {
931 err("out of memory for read buf");
935 /* Allocate buffer for printer status */
936 usblp->statusbuf = kmalloc(STATUS_BUF_SIZE, GFP_KERNEL);
937 if (!usblp->statusbuf) {
938 err("out of memory for statusbuf");
942 /* Lookup quirks for this printer. */
943 usblp->quirks = usblp_quirks(
944 le16_to_cpu(dev->descriptor.idVendor),
945 le16_to_cpu(dev->descriptor.idProduct));
947 /* Analyze and pick initial alternate settings and endpoints. */
948 protocol = usblp_select_alts(usblp);
950 dbg("incompatible printer-class device 0x%4.4X/0x%4.4X",
951 le16_to_cpu(dev->descriptor.idVendor),
952 le16_to_cpu(dev->descriptor.idProduct));
956 /* Setup the selected alternate setting and endpoints. */
957 if (usblp_set_protocol(usblp, protocol) < 0)
960 /* Retrieve and store the device ID string. */
961 usblp_cache_device_id_string(usblp);
962 retval = device_create_file(&intf->dev, &dev_attr_ieee1284_id);
967 usblp_check_status(usblp, 0);
970 usb_set_intfdata (intf, usblp);
974 retval = usb_register_dev(intf, &usblp_class);
976 err("Not able to get a minor for this device.");
979 usblp->minor = intf->minor;
980 info("usblp%d: USB %sdirectional printer dev %d "
981 "if %d alt %d proto %d vid 0x%4.4X pid 0x%4.4X",
982 usblp->minor, usblp->bidir ? "Bi" : "Uni", dev->devnum,
984 usblp->protocol[usblp->current_protocol].alt_setting,
985 usblp->current_protocol,
986 le16_to_cpu(usblp->dev->descriptor.idVendor),
987 le16_to_cpu(usblp->dev->descriptor.idProduct));
992 usb_set_intfdata (intf, NULL);
993 device_remove_file(&intf->dev, &dev_attr_ieee1284_id);
997 usb_buffer_free (usblp->dev, USBLP_BUF_SIZE,
998 usblp->writebuf, usblp->writeurb->transfer_dma);
1000 usb_buffer_free (usblp->dev, USBLP_BUF_SIZE,
1001 usblp->readbuf, usblp->writeurb->transfer_dma);
1002 kfree(usblp->statusbuf);
1003 kfree(usblp->device_id_string);
1004 usb_free_urb(usblp->writeurb);
1005 usb_free_urb(usblp->readurb);
1012 * We are a "new" style driver with usb_device_id table,
1013 * but our requirements are too intricate for simple match to handle.
1015 * The "proto_bias" option may be used to specify the preferred protocol
1016 * for all USB printers (1=7/1/1, 2=7/1/2, 3=7/1/3). If the device
1017 * supports the preferred protocol, then we bind to it.
1019 * The best interface for us is 7/1/2, because it is compatible
1020 * with a stream of characters. If we find it, we bind to it.
1022 * Note that the people from hpoj.sourceforge.net need to be able to
1023 * bind to 7/1/3 (MLC/1284.4), so we provide them ioctls for this purpose.
1025 * Failing 7/1/2, we look for 7/1/3, even though it's probably not
1026 * stream-compatible, because this matches the behaviour of the old code.
1028 * If nothing else, we bind to 7/1/1 - the unidirectional interface.
1030 static int usblp_select_alts(struct usblp *usblp)
1032 struct usb_interface *if_alt;
1033 struct usb_host_interface *ifd;
1034 struct usb_endpoint_descriptor *epd, *epwrite, *epread;
1037 if_alt = usblp->intf;
1039 for (p = 0; p < USBLP_MAX_PROTOCOLS; p++)
1040 usblp->protocol[p].alt_setting = -1;
1042 /* Find out what we have. */
1043 for (i = 0; i < if_alt->num_altsetting; i++) {
1044 ifd = &if_alt->altsetting[i];
1046 if (ifd->desc.bInterfaceClass != 7 || ifd->desc.bInterfaceSubClass != 1)
1049 if (ifd->desc.bInterfaceProtocol < USBLP_FIRST_PROTOCOL ||
1050 ifd->desc.bInterfaceProtocol > USBLP_LAST_PROTOCOL)
1053 /* Look for bulk OUT and IN endpoints. */
1054 epwrite = epread = NULL;
1055 for (e = 0; e < ifd->desc.bNumEndpoints; e++) {
1056 epd = &ifd->endpoint[e].desc;
1058 if (usb_endpoint_is_bulk_out(epd))
1062 if (usb_endpoint_is_bulk_in(epd))
1067 /* Ignore buggy hardware without the right endpoints. */
1068 if (!epwrite || (ifd->desc.bInterfaceProtocol > 1 && !epread))
1071 /* Turn off reads for 7/1/1 (unidirectional) interfaces
1072 * and buggy bidirectional printers. */
1073 if (ifd->desc.bInterfaceProtocol == 1) {
1075 } else if (usblp->quirks & USBLP_QUIRK_BIDIR) {
1076 info("Disabling reads from problem bidirectional "
1077 "printer on usblp%d", usblp->minor);
1081 usblp->protocol[ifd->desc.bInterfaceProtocol].alt_setting =
1082 ifd->desc.bAlternateSetting;
1083 usblp->protocol[ifd->desc.bInterfaceProtocol].epwrite = epwrite;
1084 usblp->protocol[ifd->desc.bInterfaceProtocol].epread = epread;
1087 /* If our requested protocol is supported, then use it. */
1088 if (proto_bias >= USBLP_FIRST_PROTOCOL &&
1089 proto_bias <= USBLP_LAST_PROTOCOL &&
1090 usblp->protocol[proto_bias].alt_setting != -1)
1093 /* Ordering is important here. */
1094 if (usblp->protocol[2].alt_setting != -1)
1096 if (usblp->protocol[1].alt_setting != -1)
1098 if (usblp->protocol[3].alt_setting != -1)
1101 /* If nothing is available, then don't bind to this device. */
1105 static int usblp_set_protocol(struct usblp *usblp, int protocol)
1109 if (protocol < USBLP_FIRST_PROTOCOL || protocol > USBLP_LAST_PROTOCOL)
1112 alts = usblp->protocol[protocol].alt_setting;
1115 r = usb_set_interface(usblp->dev, usblp->ifnum, alts);
1117 err("can't set desired altsetting %d on interface %d",
1118 alts, usblp->ifnum);
1122 usb_fill_bulk_urb(usblp->writeurb, usblp->dev,
1123 usb_sndbulkpipe(usblp->dev,
1124 usblp->protocol[protocol].epwrite->bEndpointAddress),
1126 usblp_bulk_write, usblp);
1128 usblp->bidir = (usblp->protocol[protocol].epread != NULL);
1130 usb_fill_bulk_urb(usblp->readurb, usblp->dev,
1131 usb_rcvbulkpipe(usblp->dev,
1132 usblp->protocol[protocol].epread->bEndpointAddress),
1133 usblp->readbuf, USBLP_BUF_SIZE,
1134 usblp_bulk_read, usblp);
1136 usblp->current_protocol = protocol;
1137 dbg("usblp%d set protocol %d", usblp->minor, protocol);
1141 /* Retrieves and caches device ID string.
1142 * Returns length, including length bytes but not null terminator.
1143 * On error, returns a negative errno value. */
1144 static int usblp_cache_device_id_string(struct usblp *usblp)
1148 err = usblp_get_id(usblp, 0, usblp->device_id_string, USBLP_DEVICE_ID_SIZE - 1);
1150 dbg("usblp%d: error = %d reading IEEE-1284 Device ID string",
1152 usblp->device_id_string[0] = usblp->device_id_string[1] = '\0';
1156 /* First two bytes are length in big-endian.
1157 * They count themselves, and we copy them into
1158 * the user's buffer. */
1159 length = be16_to_cpu(*((__be16 *)usblp->device_id_string));
1162 else if (length >= USBLP_DEVICE_ID_SIZE)
1163 length = USBLP_DEVICE_ID_SIZE - 1;
1164 usblp->device_id_string[length] = '\0';
1166 dbg("usblp%d Device ID string [len=%d]=\"%s\"",
1167 usblp->minor, length, &usblp->device_id_string[2]);
1172 static void usblp_disconnect(struct usb_interface *intf)
1174 struct usblp *usblp = usb_get_intfdata (intf);
1176 usb_deregister_dev(intf, &usblp_class);
1178 if (!usblp || !usblp->dev) {
1179 err("bogus disconnect");
1183 device_remove_file(&intf->dev, &dev_attr_ieee1284_id);
1185 mutex_lock (&usblp_mutex);
1186 mutex_lock (&usblp->mut);
1188 usb_set_intfdata (intf, NULL);
1190 usblp_unlink_urbs(usblp);
1191 usb_buffer_free (usblp->dev, USBLP_BUF_SIZE,
1192 usblp->writebuf, usblp->writeurb->transfer_dma);
1193 usb_buffer_free (usblp->dev, USBLP_BUF_SIZE,
1194 usblp->readbuf, usblp->readurb->transfer_dma);
1195 mutex_unlock (&usblp->mut);
1198 usblp_cleanup (usblp);
1199 mutex_unlock (&usblp_mutex);
1202 static int usblp_suspend (struct usb_interface *intf, pm_message_t message)
1204 struct usblp *usblp = usb_get_intfdata (intf);
1206 /* this races against normal access and open */
1207 mutex_lock (&usblp_mutex);
1208 mutex_lock (&usblp->mut);
1209 /* we take no more IO */
1210 usblp->sleeping = 1;
1211 usblp_unlink_urbs(usblp);
1212 mutex_unlock (&usblp->mut);
1213 mutex_unlock (&usblp_mutex);
1218 static int usblp_resume (struct usb_interface *intf)
1220 struct usblp *usblp = usb_get_intfdata (intf);
1223 mutex_lock (&usblp_mutex);
1224 mutex_lock (&usblp->mut);
1226 usblp->sleeping = 0;
1227 r = handle_bidir (usblp);
1229 mutex_unlock (&usblp->mut);
1230 mutex_unlock (&usblp_mutex);
1235 static struct usb_device_id usblp_ids [] = {
1236 { USB_DEVICE_INFO(7, 1, 1) },
1237 { USB_DEVICE_INFO(7, 1, 2) },
1238 { USB_DEVICE_INFO(7, 1, 3) },
1239 { USB_INTERFACE_INFO(7, 1, 1) },
1240 { USB_INTERFACE_INFO(7, 1, 2) },
1241 { USB_INTERFACE_INFO(7, 1, 3) },
1242 { } /* Terminating entry */
1245 MODULE_DEVICE_TABLE (usb, usblp_ids);
1247 static struct usb_driver usblp_driver = {
1249 .probe = usblp_probe,
1250 .disconnect = usblp_disconnect,
1251 .suspend = usblp_suspend,
1252 .resume = usblp_resume,
1253 .id_table = usblp_ids,
1256 static int __init usblp_init(void)
1259 retval = usb_register(&usblp_driver);
1261 info(DRIVER_VERSION ": " DRIVER_DESC);
1266 static void __exit usblp_exit(void)
1268 usb_deregister(&usblp_driver);
1271 module_init(usblp_init);
1272 module_exit(usblp_exit);
1274 MODULE_AUTHOR( DRIVER_AUTHOR );
1275 MODULE_DESCRIPTION( DRIVER_DESC );
1276 module_param(proto_bias, int, S_IRUGO | S_IWUSR);
1277 MODULE_PARM_DESC(proto_bias, "Favourite protocol number");
1278 MODULE_LICENSE("GPL");