[PATCH] devfs: Remove the mode field from usb_class_driver as it's no longer needed
[linux-2.6.git] / drivers / usb / class / usblp.c
1 /*
2  * usblp.c  Version 0.13
3  *
4  * Copyright (c) 1999 Michael Gee       <michael@linuxspecific.com>
5  * Copyright (c) 1999 Pavel Machek      <pavel@suse.cz>
6  * Copyright (c) 2000 Randy Dunlap      <rddunlap@osdl.org>
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  *
11  * USB Printer Device Class driver for USB printers and printer cables
12  *
13  * Sponsored by SuSE
14  *
15  * ChangeLog:
16  *      v0.1 - thorough cleaning, URBification, almost a rewrite
17  *      v0.2 - some more cleanups
18  *      v0.3 - cleaner again, waitqueue fixes
19  *      v0.4 - fixes in unidirectional mode
20  *      v0.5 - add DEVICE_ID string support
21  *      v0.6 - never time out
22  *      v0.7 - fixed bulk-IN read and poll (David Paschal)
23  *      v0.8 - add devfs support
24  *      v0.9 - fix unplug-while-open paths
25  *      v0.10- remove sleep_on, fix error on oom (oliver@neukum.org)
26  *      v0.11 - add proto_bias option (Pete Zaitcev)
27  *      v0.12 - add hpoj.sourceforge.net ioctls (David Paschal)
28  *      v0.13 - alloc space for statusbuf (<status> not on stack);
29  *              use usb_buffer_alloc() for read buf & write buf;
30  */
31
32 /*
33  * This program is free software; you can redistribute it and/or modify
34  * it under the terms of the GNU General Public License as published by
35  * the Free Software Foundation; either version 2 of the License, or
36  * (at your option) any later version.
37  *
38  * This program is distributed in the hope that it will be useful,
39  * but WITHOUT ANY WARRANTY; without even the implied warranty of
40  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
41  * GNU General Public License for more details.
42  *
43  * You should have received a copy of the GNU General Public License
44  * along with this program; if not, write to the Free Software
45  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
46  */
47
48 #include <linux/module.h>
49 #include <linux/kernel.h>
50 #include <linux/sched.h>
51 #include <linux/smp_lock.h>
52 #include <linux/signal.h>
53 #include <linux/poll.h>
54 #include <linux/init.h>
55 #include <linux/slab.h>
56 #include <linux/lp.h>
57 #undef DEBUG
58 #include <linux/usb.h>
59
60 /*
61  * Version Information
62  */
63 #define DRIVER_VERSION "v0.13"
64 #define DRIVER_AUTHOR "Michael Gee, Pavel Machek, Vojtech Pavlik, Randy Dunlap, Pete Zaitcev, David Paschal"
65 #define DRIVER_DESC "USB Printer Device Class driver"
66
67 #define USBLP_BUF_SIZE          8192
68 #define USBLP_DEVICE_ID_SIZE    1024
69
70 /* ioctls: */
71 #define LPGETSTATUS             0x060b          /* same as in drivers/char/lp.c */
72 #define IOCNR_GET_DEVICE_ID             1
73 #define IOCNR_GET_PROTOCOLS             2
74 #define IOCNR_SET_PROTOCOL              3
75 #define IOCNR_HP_SET_CHANNEL            4
76 #define IOCNR_GET_BUS_ADDRESS           5
77 #define IOCNR_GET_VID_PID               6
78 #define IOCNR_SOFT_RESET                7
79 /* Get device_id string: */
80 #define LPIOC_GET_DEVICE_ID(len) _IOC(_IOC_READ, 'P', IOCNR_GET_DEVICE_ID, len)
81 /* The following ioctls were added for http://hpoj.sourceforge.net: */
82 /* Get two-int array:
83  * [0]=current protocol (1=7/1/1, 2=7/1/2, 3=7/1/3),
84  * [1]=supported protocol mask (mask&(1<<n)!=0 means 7/1/n supported): */
85 #define LPIOC_GET_PROTOCOLS(len) _IOC(_IOC_READ, 'P', IOCNR_GET_PROTOCOLS, len)
86 /* Set protocol (arg: 1=7/1/1, 2=7/1/2, 3=7/1/3): */
87 #define LPIOC_SET_PROTOCOL _IOC(_IOC_WRITE, 'P', IOCNR_SET_PROTOCOL, 0)
88 /* Set channel number (HP Vendor-specific command): */
89 #define LPIOC_HP_SET_CHANNEL _IOC(_IOC_WRITE, 'P', IOCNR_HP_SET_CHANNEL, 0)
90 /* Get two-int array: [0]=bus number, [1]=device address: */
91 #define LPIOC_GET_BUS_ADDRESS(len) _IOC(_IOC_READ, 'P', IOCNR_GET_BUS_ADDRESS, len)
92 /* Get two-int array: [0]=vendor ID, [1]=product ID: */
93 #define LPIOC_GET_VID_PID(len) _IOC(_IOC_READ, 'P', IOCNR_GET_VID_PID, len)
94 /* Perform class specific soft reset */
95 #define LPIOC_SOFT_RESET _IOC(_IOC_NONE, 'P', IOCNR_SOFT_RESET, 0);
96
97 /*
98  * A DEVICE_ID string may include the printer's serial number.
99  * It should end with a semi-colon (';').
100  * An example from an HP 970C DeskJet printer is (this is one long string,
101  * with the serial number changed):
102 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:                    ;
103  */
104
105 /*
106  * USB Printer Requests
107  */
108
109 #define USBLP_REQ_GET_ID                        0x00
110 #define USBLP_REQ_GET_STATUS                    0x01
111 #define USBLP_REQ_RESET                         0x02
112 #define USBLP_REQ_HP_CHANNEL_CHANGE_REQUEST     0x00    /* HP Vendor-specific */
113
114 #define USBLP_MINORS            16
115 #define USBLP_MINOR_BASE        0
116
117 #define USBLP_WRITE_TIMEOUT     (5000)                  /* 5 seconds */
118
119 #define USBLP_FIRST_PROTOCOL    1
120 #define USBLP_LAST_PROTOCOL     3
121 #define USBLP_MAX_PROTOCOLS     (USBLP_LAST_PROTOCOL+1)
122
123 /*
124  * some arbitrary status buffer size;
125  * need a status buffer that is allocated via kmalloc(), not on stack
126  */
127 #define STATUS_BUF_SIZE         8
128
129 struct usblp {
130         struct usb_device       *dev;                   /* USB device */
131         struct semaphore        sem;                    /* locks this struct, especially "dev" */
132         char                    *writebuf;              /* write transfer_buffer */
133         char                    *readbuf;               /* read transfer_buffer */
134         char                    *statusbuf;             /* status transfer_buffer */
135         struct urb              *readurb, *writeurb;    /* The urbs */
136         wait_queue_head_t       wait;                   /* Zzzzz ... */
137         int                     readcount;              /* Counter for reads */
138         int                     ifnum;                  /* Interface number */
139         struct usb_interface    *intf;                  /* The interface */
140         /* Alternate-setting numbers and endpoints for each protocol
141          * (7/1/{index=1,2,3}) that the device supports: */
142         struct {
143                 int                             alt_setting;
144                 struct usb_endpoint_descriptor  *epwrite;
145                 struct usb_endpoint_descriptor  *epread;
146         }                       protocol[USBLP_MAX_PROTOCOLS];
147         int                     current_protocol;
148         int                     minor;                  /* minor number of device */
149         int                     wcomplete;              /* writing is completed */
150         int                     rcomplete;              /* reading is completed */
151         unsigned int            quirks;                 /* quirks flags */
152         unsigned char           used;                   /* True if open */
153         unsigned char           present;                /* True if not disconnected */
154         unsigned char           bidir;                  /* interface is bidirectional */
155         unsigned char           *device_id_string;      /* IEEE 1284 DEVICE ID string (ptr) */
156                                                         /* first 2 bytes are (big-endian) length */
157 };
158
159 #ifdef DEBUG
160 static void usblp_dump(struct usblp *usblp) {
161         int p;
162
163         dbg("usblp=0x%p", usblp);
164         dbg("dev=0x%p", usblp->dev);
165         dbg("present=%d", usblp->present);
166         dbg("readbuf=0x%p", usblp->readbuf);
167         dbg("writebuf=0x%p", usblp->writebuf);
168         dbg("readurb=0x%p", usblp->readurb);
169         dbg("writeurb=0x%p", usblp->writeurb);
170         dbg("readcount=%d", usblp->readcount);
171         dbg("ifnum=%d", usblp->ifnum);
172     for (p = USBLP_FIRST_PROTOCOL; p <= USBLP_LAST_PROTOCOL; p++) {
173         dbg("protocol[%d].alt_setting=%d", p, usblp->protocol[p].alt_setting);
174         dbg("protocol[%d].epwrite=%p", p, usblp->protocol[p].epwrite);
175         dbg("protocol[%d].epread=%p", p, usblp->protocol[p].epread);
176     }
177         dbg("current_protocol=%d", usblp->current_protocol);
178         dbg("minor=%d", usblp->minor);
179         dbg("wcomplete=%d", usblp->wcomplete);
180         dbg("rcomplete=%d", usblp->rcomplete);
181         dbg("quirks=%d", usblp->quirks);
182         dbg("used=%d", usblp->used);
183         dbg("bidir=%d", usblp->bidir);
184         dbg("device_id_string=\"%s\"",
185                 usblp->device_id_string ?
186                         usblp->device_id_string + 2 :
187                         (unsigned char *)"(null)");
188 }
189 #endif
190
191 /* Quirks: various printer quirks are handled by this table & its flags. */
192
193 struct quirk_printer_struct {
194         __u16 vendorId;
195         __u16 productId;
196         unsigned int quirks;
197 };
198
199 #define USBLP_QUIRK_BIDIR       0x1     /* reports bidir but requires unidirectional mode (no INs/reads) */
200 #define USBLP_QUIRK_USB_INIT    0x2     /* needs vendor USB init string */
201
202 static struct quirk_printer_struct quirk_printers[] = {
203         { 0x03f0, 0x0004, USBLP_QUIRK_BIDIR }, /* HP DeskJet 895C */
204         { 0x03f0, 0x0104, USBLP_QUIRK_BIDIR }, /* HP DeskJet 880C */
205         { 0x03f0, 0x0204, USBLP_QUIRK_BIDIR }, /* HP DeskJet 815C */
206         { 0x03f0, 0x0304, USBLP_QUIRK_BIDIR }, /* HP DeskJet 810C/812C */
207         { 0x03f0, 0x0404, USBLP_QUIRK_BIDIR }, /* HP DeskJet 830C */
208         { 0x03f0, 0x0504, USBLP_QUIRK_BIDIR }, /* HP DeskJet 885C */
209         { 0x03f0, 0x0604, USBLP_QUIRK_BIDIR }, /* HP DeskJet 840C */   
210         { 0x03f0, 0x0804, USBLP_QUIRK_BIDIR }, /* HP DeskJet 816C */   
211         { 0x03f0, 0x1104, USBLP_QUIRK_BIDIR }, /* HP Deskjet 959C */
212         { 0x0409, 0xefbe, USBLP_QUIRK_BIDIR }, /* NEC Picty900 (HP OEM) */
213         { 0x0409, 0xbef4, USBLP_QUIRK_BIDIR }, /* NEC Picty760 (HP OEM) */
214         { 0x0409, 0xf0be, USBLP_QUIRK_BIDIR }, /* NEC Picty920 (HP OEM) */
215         { 0x0409, 0xf1be, USBLP_QUIRK_BIDIR }, /* NEC Picty800 (HP OEM) */
216         { 0, 0 }
217 };
218
219 static int usblp_select_alts(struct usblp *usblp);
220 static int usblp_set_protocol(struct usblp *usblp, int protocol);
221 static int usblp_cache_device_id_string(struct usblp *usblp);
222
223 /* forward reference to make our lives easier */
224 static struct usb_driver usblp_driver;
225 static DECLARE_MUTEX(usblp_sem);        /* locks the existence of usblp's */
226
227 /*
228  * Functions for usblp control messages.
229  */
230
231 static int usblp_ctrl_msg(struct usblp *usblp, int request, int type, int dir, int recip, int value, void *buf, int len)
232 {
233         int retval;
234         int index = usblp->ifnum;
235
236         /* High byte has the interface index.
237            Low byte has the alternate setting.
238          */
239         if ((request == USBLP_REQ_GET_ID) && (type == USB_TYPE_CLASS)) {
240           index = (usblp->ifnum<<8)|usblp->protocol[usblp->current_protocol].alt_setting;
241         }
242
243         retval = usb_control_msg(usblp->dev,
244                 dir ? usb_rcvctrlpipe(usblp->dev, 0) : usb_sndctrlpipe(usblp->dev, 0),
245                 request, type | dir | recip, value, index, buf, len, USBLP_WRITE_TIMEOUT);
246         dbg("usblp_control_msg: rq: 0x%02x dir: %d recip: %d value: %d idx: %d len: %#x result: %d",
247                 request, !!dir, recip, value, index, len, retval);
248         return retval < 0 ? retval : 0;
249 }
250
251 #define usblp_read_status(usblp, status)\
252         usblp_ctrl_msg(usblp, USBLP_REQ_GET_STATUS, USB_TYPE_CLASS, USB_DIR_IN, USB_RECIP_INTERFACE, 0, status, 1)
253 #define usblp_get_id(usblp, config, id, maxlen)\
254         usblp_ctrl_msg(usblp, USBLP_REQ_GET_ID, USB_TYPE_CLASS, USB_DIR_IN, USB_RECIP_INTERFACE, config, id, maxlen)
255 #define usblp_reset(usblp)\
256         usblp_ctrl_msg(usblp, USBLP_REQ_RESET, USB_TYPE_CLASS, USB_DIR_OUT, USB_RECIP_OTHER, 0, NULL, 0)
257
258 #define usblp_hp_channel_change_request(usblp, channel, buffer) \
259         usblp_ctrl_msg(usblp, USBLP_REQ_HP_CHANNEL_CHANGE_REQUEST, USB_TYPE_VENDOR, USB_DIR_IN, USB_RECIP_INTERFACE, channel, buffer, 1)
260
261 /*
262  * See the description for usblp_select_alts() below for the usage
263  * explanation.  Look into your /proc/bus/usb/devices and dmesg in
264  * case of any trouble.
265  */
266 static int proto_bias = -1;
267
268 /*
269  * URB callback.
270  */
271
272 static void usblp_bulk_read(struct urb *urb, struct pt_regs *regs)
273 {
274         struct usblp *usblp = urb->context;
275
276         if (!usblp || !usblp->dev || !usblp->used || !usblp->present)
277                 return;
278
279         if (unlikely(urb->status))
280                 warn("usblp%d: nonzero read/write bulk status received: %d",
281                         usblp->minor, urb->status);
282         usblp->rcomplete = 1;
283         wake_up_interruptible(&usblp->wait);
284 }
285
286 static void usblp_bulk_write(struct urb *urb, struct pt_regs *regs)
287 {
288         struct usblp *usblp = urb->context;
289
290         if (!usblp || !usblp->dev || !usblp->used || !usblp->present)
291                 return;
292
293         if (unlikely(urb->status))
294                 warn("usblp%d: nonzero read/write bulk status received: %d",
295                         usblp->minor, urb->status);
296         usblp->wcomplete = 1;
297         wake_up_interruptible(&usblp->wait);
298 }
299
300 /*
301  * Get and print printer errors.
302  */
303
304 static char *usblp_messages[] = { "ok", "out of paper", "off-line", "on fire" };
305
306 static int usblp_check_status(struct usblp *usblp, int err)
307 {
308         unsigned char status, newerr = 0;
309         int error;
310
311         error = usblp_read_status (usblp, usblp->statusbuf);
312         if (error < 0) {
313                 if (printk_ratelimit())
314                         err("usblp%d: error %d reading printer status",
315                                 usblp->minor, error);
316                 return 0;
317         }
318
319         status = *usblp->statusbuf;
320
321         if (~status & LP_PERRORP)
322                 newerr = 3;
323         if (status & LP_POUTPA)
324                 newerr = 1;
325         if (~status & LP_PSELECD)
326                 newerr = 2;
327
328         if (newerr != err)
329                 info("usblp%d: %s", usblp->minor, usblp_messages[newerr]);
330
331         return newerr;
332 }
333
334 /*
335  * File op functions.
336  */
337
338 static int usblp_open(struct inode *inode, struct file *file)
339 {
340         int minor = iminor(inode);
341         struct usblp *usblp;
342         struct usb_interface *intf;
343         int retval;
344
345         if (minor < 0)
346                 return -ENODEV;
347
348         down (&usblp_sem);
349
350         retval = -ENODEV;
351         intf = usb_find_interface(&usblp_driver, minor);
352         if (!intf) {
353                 goto out;
354         }
355         usblp = usb_get_intfdata (intf);
356         if (!usblp || !usblp->dev || !usblp->present)
357                 goto out;
358
359         retval = -EBUSY;
360         if (usblp->used)
361                 goto out;
362
363         /*
364          * TODO: need to implement LP_ABORTOPEN + O_NONBLOCK as in drivers/char/lp.c ???
365          * This is #if 0-ed because we *don't* want to fail an open
366          * just because the printer is off-line.
367          */
368 #if 0
369         if ((retval = usblp_check_status(usblp, 0))) {
370                 retval = retval > 1 ? -EIO : -ENOSPC;
371                 goto out;
372         }
373 #else
374         retval = 0;
375 #endif
376
377         usblp->used = 1;
378         file->private_data = usblp;
379
380         usblp->writeurb->transfer_buffer_length = 0;
381         usblp->wcomplete = 1; /* we begin writeable */
382         usblp->rcomplete = 0;
383         usblp->writeurb->status = 0;
384         usblp->readurb->status = 0;
385
386         if (usblp->bidir) {
387                 usblp->readcount = 0;
388                 usblp->readurb->dev = usblp->dev;
389                 if (usb_submit_urb(usblp->readurb, GFP_KERNEL) < 0) {
390                         retval = -EIO;
391                         usblp->used = 0;
392                         file->private_data = NULL;
393                 }
394         }
395 out:
396         up (&usblp_sem);
397         return retval;
398 }
399
400 static void usblp_cleanup (struct usblp *usblp)
401 {
402         info("usblp%d: removed", usblp->minor);
403
404         kfree (usblp->device_id_string);
405         kfree (usblp->statusbuf);
406         usb_free_urb(usblp->writeurb);
407         usb_free_urb(usblp->readurb);
408         kfree (usblp);
409 }
410
411 static void usblp_unlink_urbs(struct usblp *usblp)
412 {
413         usb_kill_urb(usblp->writeurb);
414         if (usblp->bidir)
415                 usb_kill_urb(usblp->readurb);
416 }
417
418 static int usblp_release(struct inode *inode, struct file *file)
419 {
420         struct usblp *usblp = file->private_data;
421
422         down (&usblp_sem);
423         usblp->used = 0;
424         if (usblp->present) {
425                 usblp_unlink_urbs(usblp);
426         } else          /* finish cleanup from disconnect */
427                 usblp_cleanup (usblp);
428         up (&usblp_sem);
429         return 0;
430 }
431
432 /* No kernel lock - fine */
433 static unsigned int usblp_poll(struct file *file, struct poll_table_struct *wait)
434 {
435         struct usblp *usblp = file->private_data;
436         poll_wait(file, &usblp->wait, wait);
437         return ((!usblp->bidir || !usblp->rcomplete) ? 0 : POLLIN  | POLLRDNORM)
438                                | (!usblp->wcomplete ? 0 : POLLOUT | POLLWRNORM);
439 }
440
441 static int usblp_ioctl(struct inode *inode, struct file *file, unsigned int cmd, unsigned long arg)
442 {
443         struct usblp *usblp = file->private_data;
444         int length, err, i;
445         unsigned char newChannel;
446         int status;
447         int twoints[2];
448         int retval = 0;
449
450         down (&usblp->sem);
451         if (!usblp->present) {
452                 retval = -ENODEV;
453                 goto done;
454         }
455
456         dbg("usblp_ioctl: cmd=0x%x (%c nr=%d len=%d dir=%d)", cmd, _IOC_TYPE(cmd),
457                 _IOC_NR(cmd), _IOC_SIZE(cmd), _IOC_DIR(cmd) );
458
459         if (_IOC_TYPE(cmd) == 'P')      /* new-style ioctl number */
460
461                 switch (_IOC_NR(cmd)) {
462
463                         case IOCNR_GET_DEVICE_ID: /* get the DEVICE_ID string */
464                                 if (_IOC_DIR(cmd) != _IOC_READ) {
465                                         retval = -EINVAL;
466                                         goto done;
467                                 }
468
469                                 length = usblp_cache_device_id_string(usblp);
470                                 if (length < 0) {
471                                         retval = length;
472                                         goto done;
473                                 }
474                                 if (length > _IOC_SIZE(cmd))
475                                         length = _IOC_SIZE(cmd); /* truncate */
476
477                                 if (copy_to_user((void __user *) arg,
478                                                 usblp->device_id_string,
479                                                 (unsigned long) length)) {
480                                         retval = -EFAULT;
481                                         goto done;
482                                 }
483
484                                 break;
485
486                         case IOCNR_GET_PROTOCOLS:
487                                 if (_IOC_DIR(cmd) != _IOC_READ ||
488                                     _IOC_SIZE(cmd) < sizeof(twoints)) {
489                                         retval = -EINVAL;
490                                         goto done;
491                                 }
492
493                                 twoints[0] = usblp->current_protocol;
494                                 twoints[1] = 0;
495                                 for (i = USBLP_FIRST_PROTOCOL;
496                                      i <= USBLP_LAST_PROTOCOL; i++) {
497                                         if (usblp->protocol[i].alt_setting >= 0)
498                                                 twoints[1] |= (1<<i);
499                                 }
500
501                                 if (copy_to_user((void __user *)arg,
502                                                 (unsigned char *)twoints,
503                                                 sizeof(twoints))) {
504                                         retval = -EFAULT;
505                                         goto done;
506                                 }
507
508                                 break;
509
510                         case IOCNR_SET_PROTOCOL:
511                                 if (_IOC_DIR(cmd) != _IOC_WRITE) {
512                                         retval = -EINVAL;
513                                         goto done;
514                                 }
515
516 #ifdef DEBUG
517                                 if (arg == -10) {
518                                         usblp_dump(usblp);
519                                         break;
520                                 }
521 #endif
522
523                                 usblp_unlink_urbs(usblp);
524                                 retval = usblp_set_protocol(usblp, arg);
525                                 if (retval < 0) {
526                                         usblp_set_protocol(usblp,
527                                                 usblp->current_protocol);
528                                 }
529                                 break;
530
531                         case IOCNR_HP_SET_CHANNEL:
532                                 if (_IOC_DIR(cmd) != _IOC_WRITE ||
533                                     le16_to_cpu(usblp->dev->descriptor.idVendor) != 0x03F0 ||
534                                     usblp->quirks & USBLP_QUIRK_BIDIR) {
535                                         retval = -EINVAL;
536                                         goto done;
537                                 }
538
539                                 err = usblp_hp_channel_change_request(usblp,
540                                         arg, &newChannel);
541                                 if (err < 0) {
542                                         err("usblp%d: error = %d setting "
543                                                 "HP channel",
544                                                 usblp->minor, err);
545                                         retval = -EIO;
546                                         goto done;
547                                 }
548
549                                 dbg("usblp%d requested/got HP channel %ld/%d",
550                                         usblp->minor, arg, newChannel);
551                                 break;
552
553                         case IOCNR_GET_BUS_ADDRESS:
554                                 if (_IOC_DIR(cmd) != _IOC_READ ||
555                                     _IOC_SIZE(cmd) < sizeof(twoints)) {
556                                         retval = -EINVAL;
557                                         goto done;
558                                 }
559
560                                 twoints[0] = usblp->dev->bus->busnum;
561                                 twoints[1] = usblp->dev->devnum;
562                                 if (copy_to_user((void __user *)arg,
563                                                 (unsigned char *)twoints,
564                                                 sizeof(twoints))) {
565                                         retval = -EFAULT;
566                                         goto done;
567                                 }
568
569                                 dbg("usblp%d is bus=%d, device=%d",
570                                         usblp->minor, twoints[0], twoints[1]);
571                                 break;
572
573                         case IOCNR_GET_VID_PID:
574                                 if (_IOC_DIR(cmd) != _IOC_READ ||
575                                     _IOC_SIZE(cmd) < sizeof(twoints)) {
576                                         retval = -EINVAL;
577                                         goto done;
578                                 }
579
580                                 twoints[0] = le16_to_cpu(usblp->dev->descriptor.idVendor);
581                                 twoints[1] = le16_to_cpu(usblp->dev->descriptor.idProduct);
582                                 if (copy_to_user((void __user *)arg,
583                                                 (unsigned char *)twoints,
584                                                 sizeof(twoints))) {
585                                         retval = -EFAULT;
586                                         goto done;
587                                 }
588
589                                 dbg("usblp%d is VID=0x%4.4X, PID=0x%4.4X",
590                                         usblp->minor, twoints[0], twoints[1]);
591                                 break;
592
593                         case IOCNR_SOFT_RESET:
594                                 if (_IOC_DIR(cmd) != _IOC_NONE) {
595                                         retval = -EINVAL;
596                                         goto done;
597                                 }
598                                 retval = usblp_reset(usblp);
599                                 break;
600                         default:
601                                 retval = -ENOTTY;
602                 }
603         else    /* old-style ioctl value */
604                 switch (cmd) {
605
606                         case LPGETSTATUS:
607                                 if (usblp_read_status(usblp, usblp->statusbuf)) {
608                                         if (printk_ratelimit())
609                                                 err("usblp%d: failed reading printer status",
610                                                         usblp->minor);
611                                         retval = -EIO;
612                                         goto done;
613                                 }
614                                 status = *usblp->statusbuf;
615                                 if (copy_to_user ((void __user *)arg, &status, sizeof(int)))
616                                         retval = -EFAULT;
617                                 break;
618
619                         default:
620                                 retval = -ENOTTY;
621                 }
622
623 done:
624         up (&usblp->sem);
625         return retval;
626 }
627
628 static ssize_t usblp_write(struct file *file, const char __user *buffer, size_t count, loff_t *ppos)
629 {
630         DECLARE_WAITQUEUE(wait, current);
631         struct usblp *usblp = file->private_data;
632         int timeout, err = 0, transfer_length = 0;
633         size_t writecount = 0;
634
635         while (writecount < count) {
636                 if (!usblp->wcomplete) {
637                         barrier();
638                         if (file->f_flags & O_NONBLOCK) {
639                                 writecount += transfer_length;
640                                 return writecount ? writecount : -EAGAIN;
641                         }
642
643                         timeout = USBLP_WRITE_TIMEOUT;
644                         add_wait_queue(&usblp->wait, &wait);
645                         while ( 1==1 ) {
646
647                                 if (signal_pending(current)) {
648                                         remove_wait_queue(&usblp->wait, &wait);
649                                         return writecount ? writecount : -EINTR;
650                                 }
651                                 set_current_state(TASK_INTERRUPTIBLE);
652                                 if (timeout && !usblp->wcomplete) {
653                                         timeout = schedule_timeout(timeout);
654                                 } else {
655                                         set_current_state(TASK_RUNNING);
656                                         break;
657                                 }
658                         }
659                         remove_wait_queue(&usblp->wait, &wait);
660                 }
661
662                 down (&usblp->sem);
663                 if (!usblp->present) {
664                         up (&usblp->sem);
665                         return -ENODEV;
666                 }
667
668                 if (usblp->writeurb->status != 0) {
669                         if (usblp->quirks & USBLP_QUIRK_BIDIR) {
670                                 if (!usblp->wcomplete)
671                                         err("usblp%d: error %d writing to printer",
672                                                 usblp->minor, usblp->writeurb->status);
673                                 err = usblp->writeurb->status;
674                         } else
675                                 err = usblp_check_status(usblp, err);
676                         up (&usblp->sem);
677
678                         /* if the fault was due to disconnect, let khubd's
679                          * call to usblp_disconnect() grab usblp->sem ...
680                          */
681                         schedule ();
682                         continue;
683                 }
684
685                 /* We must increment writecount here, and not at the
686                  * end of the loop. Otherwise, the final loop iteration may
687                  * be skipped, leading to incomplete printer output.
688                  */
689                 writecount += transfer_length;
690                 if (writecount == count) {
691                         up(&usblp->sem);
692                         break;
693                 }
694
695                 transfer_length=(count - writecount);
696                 if (transfer_length > USBLP_BUF_SIZE)
697                         transfer_length = USBLP_BUF_SIZE;
698
699                 usblp->writeurb->transfer_buffer_length = transfer_length;
700
701                 if (copy_from_user(usblp->writeurb->transfer_buffer, 
702                                    buffer + writecount, transfer_length)) {
703                         up(&usblp->sem);
704                         return writecount ? writecount : -EFAULT;
705                 }
706
707                 usblp->writeurb->dev = usblp->dev;
708                 usblp->wcomplete = 0;
709                 err = usb_submit_urb(usblp->writeurb, GFP_KERNEL);
710                 if (err) {
711                         if (err != -ENOMEM)
712                                 count = -EIO;
713                         else
714                                 count = writecount ? writecount : -ENOMEM;
715                         up (&usblp->sem);
716                         break;
717                 }
718                 up (&usblp->sem);
719         }
720
721         return count;
722 }
723
724 static ssize_t usblp_read(struct file *file, char __user *buffer, size_t count, loff_t *ppos)
725 {
726         struct usblp *usblp = file->private_data;
727         DECLARE_WAITQUEUE(wait, current);
728
729         if (!usblp->bidir)
730                 return -EINVAL;
731
732         down (&usblp->sem);
733         if (!usblp->present) {
734                 count = -ENODEV;
735                 goto done;
736         }
737
738         if (!usblp->rcomplete) {
739                 barrier();
740
741                 if (file->f_flags & O_NONBLOCK) {
742                         count = -EAGAIN;
743                         goto done;
744                 }
745
746                 add_wait_queue(&usblp->wait, &wait);
747                 while (1==1) {
748                         if (signal_pending(current)) {
749                                 count = -EINTR;
750                                 remove_wait_queue(&usblp->wait, &wait);
751                                 goto done;
752                         }
753                         up (&usblp->sem);
754                         set_current_state(TASK_INTERRUPTIBLE);
755                         if (!usblp->rcomplete) {
756                                 schedule();
757                         } else {
758                                 set_current_state(TASK_RUNNING);
759                                 down(&usblp->sem);
760                                 break;
761                         }
762                         down (&usblp->sem);
763                 }
764                 remove_wait_queue(&usblp->wait, &wait);
765         }
766
767         if (!usblp->present) {
768                 count = -ENODEV;
769                 goto done;
770         }
771
772         if (usblp->readurb->status) {
773                 err("usblp%d: error %d reading from printer",
774                         usblp->minor, usblp->readurb->status);
775                 usblp->readurb->dev = usblp->dev;
776                 usblp->readcount = 0;
777                 usblp->rcomplete = 0;
778                 if (usb_submit_urb(usblp->readurb, GFP_KERNEL) < 0)
779                         dbg("error submitting urb");
780                 count = -EIO;
781                 goto done;
782         }
783
784         count = count < usblp->readurb->actual_length - usblp->readcount ?
785                 count : usblp->readurb->actual_length - usblp->readcount;
786
787         if (copy_to_user(buffer, usblp->readurb->transfer_buffer + usblp->readcount, count)) {
788                 count = -EFAULT;
789                 goto done;
790         }
791
792         if ((usblp->readcount += count) == usblp->readurb->actual_length) {
793                 usblp->readcount = 0;
794                 usblp->readurb->dev = usblp->dev;
795                 usblp->rcomplete = 0;
796                 if (usb_submit_urb(usblp->readurb, GFP_KERNEL)) {
797                         count = -EIO;
798                         goto done;
799                 }
800         }
801
802 done:
803         up (&usblp->sem);
804         return count;
805 }
806
807 /*
808  * Checks for printers that have quirks, such as requiring unidirectional
809  * communication but reporting bidirectional; currently some HP printers
810  * have this flaw (HP 810, 880, 895, etc.), or needing an init string
811  * sent at each open (like some Epsons).
812  * Returns 1 if found, 0 if not found.
813  *
814  * HP recommended that we use the bidirectional interface but
815  * don't attempt any bulk IN transfers from the IN endpoint.
816  * Here's some more detail on the problem:
817  * The problem is not that it isn't bidirectional though. The problem
818  * is that if you request a device ID, or status information, while
819  * the buffers are full, the return data will end up in the print data
820  * buffer. For example if you make sure you never request the device ID
821  * while you are sending print data, and you don't try to query the
822  * printer status every couple of milliseconds, you will probably be OK.
823  */
824 static unsigned int usblp_quirks (__u16 vendor, __u16 product)
825 {
826         int i;
827
828         for (i = 0; quirk_printers[i].vendorId; i++) {
829                 if (vendor == quirk_printers[i].vendorId &&
830                     product == quirk_printers[i].productId)
831                         return quirk_printers[i].quirks;
832         }
833         return 0;
834 }
835
836 static struct file_operations usblp_fops = {
837         .owner =        THIS_MODULE,
838         .read =         usblp_read,
839         .write =        usblp_write,
840         .poll =         usblp_poll,
841         .ioctl =        usblp_ioctl,
842         .open =         usblp_open,
843         .release =      usblp_release,
844 };
845
846 static struct usb_class_driver usblp_class = {
847         .name =         "lp%d",
848         .fops =         &usblp_fops,
849         .minor_base =   USBLP_MINOR_BASE,
850 };
851
852 static int usblp_probe(struct usb_interface *intf,
853                        const struct usb_device_id *id)
854 {
855         struct usb_device *dev = interface_to_usbdev (intf);
856         struct usblp *usblp = NULL;
857         int protocol;
858         int retval;
859
860         /* Malloc and start initializing usblp structure so we can use it
861          * directly. */
862         if (!(usblp = kmalloc(sizeof(struct usblp), GFP_KERNEL))) {
863                 err("out of memory for usblp");
864                 goto abort;
865         }
866         memset(usblp, 0, sizeof(struct usblp));
867         usblp->dev = dev;
868         init_MUTEX (&usblp->sem);
869         init_waitqueue_head(&usblp->wait);
870         usblp->ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
871         usblp->intf = intf;
872
873         usblp->writeurb = usb_alloc_urb(0, GFP_KERNEL);
874         if (!usblp->writeurb) {
875                 err("out of memory");
876                 goto abort;
877         }
878         usblp->readurb = usb_alloc_urb(0, GFP_KERNEL);
879         if (!usblp->readurb) {
880                 err("out of memory");
881                 goto abort;
882         }
883
884         /* Malloc device ID string buffer to the largest expected length,
885          * since we can re-query it on an ioctl and a dynamic string
886          * could change in length. */
887         if (!(usblp->device_id_string = kmalloc(USBLP_DEVICE_ID_SIZE, GFP_KERNEL))) {
888                 err("out of memory for device_id_string");
889                 goto abort;
890         }
891
892         usblp->writebuf = usblp->readbuf = NULL;
893         usblp->writeurb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
894         usblp->readurb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
895         /* Malloc write & read buffers.  We somewhat wastefully
896          * malloc both regardless of bidirectionality, because the
897          * alternate setting can be changed later via an ioctl. */
898         if (!(usblp->writebuf = usb_buffer_alloc(dev, USBLP_BUF_SIZE,
899                                 GFP_KERNEL, &usblp->writeurb->transfer_dma))) {
900                 err("out of memory for write buf");
901                 goto abort;
902         }
903         if (!(usblp->readbuf = usb_buffer_alloc(dev, USBLP_BUF_SIZE,
904                                 GFP_KERNEL, &usblp->readurb->transfer_dma))) {
905                 err("out of memory for read buf");
906                 goto abort;
907         }
908
909         /* Allocate buffer for printer status */
910         usblp->statusbuf = kmalloc(STATUS_BUF_SIZE, GFP_KERNEL);
911         if (!usblp->statusbuf) {
912                 err("out of memory for statusbuf");
913                 goto abort;
914         }
915
916         /* Lookup quirks for this printer. */
917         usblp->quirks = usblp_quirks(
918                 le16_to_cpu(dev->descriptor.idVendor),
919                 le16_to_cpu(dev->descriptor.idProduct));
920
921         /* Analyze and pick initial alternate settings and endpoints. */
922         protocol = usblp_select_alts(usblp);
923         if (protocol < 0) {
924                 dbg("incompatible printer-class device 0x%4.4X/0x%4.4X",
925                         le16_to_cpu(dev->descriptor.idVendor),
926                         le16_to_cpu(dev->descriptor.idProduct));
927                 goto abort;
928         }
929
930         /* Setup the selected alternate setting and endpoints. */
931         if (usblp_set_protocol(usblp, protocol) < 0)
932                 goto abort;
933
934         /* Retrieve and store the device ID string. */
935         usblp_cache_device_id_string(usblp);
936
937 #ifdef DEBUG
938         usblp_check_status(usblp, 0);
939 #endif
940
941         info("usblp%d: USB %sdirectional printer dev %d "
942                 "if %d alt %d proto %d vid 0x%4.4X pid 0x%4.4X",
943                 usblp->minor, usblp->bidir ? "Bi" : "Uni", dev->devnum,
944                 usblp->ifnum,
945                 usblp->protocol[usblp->current_protocol].alt_setting,
946                 usblp->current_protocol,
947                 le16_to_cpu(usblp->dev->descriptor.idVendor),
948                 le16_to_cpu(usblp->dev->descriptor.idProduct));
949
950         usb_set_intfdata (intf, usblp);
951
952         usblp->present = 1;
953
954         retval = usb_register_dev(intf, &usblp_class);
955         if (retval) {
956                 err("Not able to get a minor for this device.");
957                 goto abort_intfdata;
958         }
959         usblp->minor = intf->minor;
960
961         return 0;
962
963 abort_intfdata:
964         usb_set_intfdata (intf, NULL);
965 abort:
966         if (usblp) {
967                 if (usblp->writebuf)
968                         usb_buffer_free (usblp->dev, USBLP_BUF_SIZE,
969                                 usblp->writebuf, usblp->writeurb->transfer_dma);
970                 if (usblp->readbuf)
971                         usb_buffer_free (usblp->dev, USBLP_BUF_SIZE,
972                                 usblp->readbuf, usblp->writeurb->transfer_dma);
973                 kfree(usblp->statusbuf);
974                 kfree(usblp->device_id_string);
975                 usb_free_urb(usblp->writeurb);
976                 usb_free_urb(usblp->readurb);
977                 kfree(usblp);
978         }
979         return -EIO;
980 }
981
982 /*
983  * We are a "new" style driver with usb_device_id table,
984  * but our requirements are too intricate for simple match to handle.
985  *
986  * The "proto_bias" option may be used to specify the preferred protocol
987  * for all USB printers (1=7/1/1, 2=7/1/2, 3=7/1/3).  If the device
988  * supports the preferred protocol, then we bind to it.
989  *
990  * The best interface for us is 7/1/2, because it is compatible
991  * with a stream of characters. If we find it, we bind to it.
992  *
993  * Note that the people from hpoj.sourceforge.net need to be able to
994  * bind to 7/1/3 (MLC/1284.4), so we provide them ioctls for this purpose.
995  *
996  * Failing 7/1/2, we look for 7/1/3, even though it's probably not
997  * stream-compatible, because this matches the behaviour of the old code.
998  *
999  * If nothing else, we bind to 7/1/1 - the unidirectional interface.
1000  */
1001 static int usblp_select_alts(struct usblp *usblp)
1002 {
1003         struct usb_interface *if_alt;
1004         struct usb_host_interface *ifd;
1005         struct usb_endpoint_descriptor *epd, *epwrite, *epread;
1006         int p, i, e;
1007
1008         if_alt = usblp->intf;
1009
1010         for (p = 0; p < USBLP_MAX_PROTOCOLS; p++)
1011                 usblp->protocol[p].alt_setting = -1;
1012
1013         /* Find out what we have. */
1014         for (i = 0; i < if_alt->num_altsetting; i++) {
1015                 ifd = &if_alt->altsetting[i];
1016
1017                 if (ifd->desc.bInterfaceClass != 7 || ifd->desc.bInterfaceSubClass != 1)
1018                         continue;
1019
1020                 if (ifd->desc.bInterfaceProtocol < USBLP_FIRST_PROTOCOL ||
1021                     ifd->desc.bInterfaceProtocol > USBLP_LAST_PROTOCOL)
1022                         continue;
1023
1024                 /* Look for bulk OUT and IN endpoints. */
1025                 epwrite = epread = NULL;
1026                 for (e = 0; e < ifd->desc.bNumEndpoints; e++) {
1027                         epd = &ifd->endpoint[e].desc;
1028
1029                         if ((epd->bmAttributes&USB_ENDPOINT_XFERTYPE_MASK)!=
1030                             USB_ENDPOINT_XFER_BULK)
1031                                 continue;
1032
1033                         if (!(epd->bEndpointAddress & USB_ENDPOINT_DIR_MASK)) {
1034                                 if (!epwrite)
1035                                         epwrite = epd;
1036
1037                         } else {
1038                                 if (!epread)
1039                                         epread = epd;
1040                         }
1041                 }
1042
1043                 /* Ignore buggy hardware without the right endpoints. */
1044                 if (!epwrite || (ifd->desc.bInterfaceProtocol > 1 && !epread))
1045                         continue;
1046
1047                 /* Turn off reads for 7/1/1 (unidirectional) interfaces
1048                  * and buggy bidirectional printers. */
1049                 if (ifd->desc.bInterfaceProtocol == 1) {
1050                         epread = NULL;
1051                 } else if (usblp->quirks & USBLP_QUIRK_BIDIR) {
1052                         info("Disabling reads from problem bidirectional "
1053                                 "printer on usblp%d", usblp->minor);
1054                         epread = NULL;
1055                 }
1056
1057                 usblp->protocol[ifd->desc.bInterfaceProtocol].alt_setting =
1058                                 ifd->desc.bAlternateSetting;
1059                 usblp->protocol[ifd->desc.bInterfaceProtocol].epwrite = epwrite;
1060                 usblp->protocol[ifd->desc.bInterfaceProtocol].epread = epread;
1061         }
1062
1063         /* If our requested protocol is supported, then use it. */
1064         if (proto_bias >= USBLP_FIRST_PROTOCOL &&
1065             proto_bias <= USBLP_LAST_PROTOCOL &&
1066             usblp->protocol[proto_bias].alt_setting != -1)
1067                 return proto_bias;
1068
1069         /* Ordering is important here. */
1070         if (usblp->protocol[2].alt_setting != -1)
1071                 return 2;
1072         if (usblp->protocol[1].alt_setting != -1)
1073                 return 1;
1074         if (usblp->protocol[3].alt_setting != -1)
1075                 return 3;
1076
1077         /* If nothing is available, then don't bind to this device. */
1078         return -1;
1079 }
1080
1081 static int usblp_set_protocol(struct usblp *usblp, int protocol)
1082 {
1083         int r, alts;
1084
1085         if (protocol < USBLP_FIRST_PROTOCOL || protocol > USBLP_LAST_PROTOCOL)
1086                 return -EINVAL;
1087
1088         alts = usblp->protocol[protocol].alt_setting;
1089         if (alts < 0)
1090                 return -EINVAL;
1091         r = usb_set_interface(usblp->dev, usblp->ifnum, alts);
1092         if (r < 0) {
1093                 err("can't set desired altsetting %d on interface %d",
1094                         alts, usblp->ifnum);
1095                 return r;
1096         }
1097
1098         usb_fill_bulk_urb(usblp->writeurb, usblp->dev,
1099                 usb_sndbulkpipe(usblp->dev,
1100                   usblp->protocol[protocol].epwrite->bEndpointAddress),
1101                 usblp->writebuf, 0,
1102                 usblp_bulk_write, usblp);
1103
1104         usblp->bidir = (usblp->protocol[protocol].epread != NULL);
1105         if (usblp->bidir)
1106                 usb_fill_bulk_urb(usblp->readurb, usblp->dev,
1107                         usb_rcvbulkpipe(usblp->dev,
1108                           usblp->protocol[protocol].epread->bEndpointAddress),
1109                         usblp->readbuf, USBLP_BUF_SIZE,
1110                         usblp_bulk_read, usblp);
1111
1112         usblp->current_protocol = protocol;
1113         dbg("usblp%d set protocol %d", usblp->minor, protocol);
1114         return 0;
1115 }
1116
1117 /* Retrieves and caches device ID string.
1118  * Returns length, including length bytes but not null terminator.
1119  * On error, returns a negative errno value. */
1120 static int usblp_cache_device_id_string(struct usblp *usblp)
1121 {
1122         int err, length;
1123
1124         err = usblp_get_id(usblp, 0, usblp->device_id_string, USBLP_DEVICE_ID_SIZE - 1);
1125         if (err < 0) {
1126                 dbg("usblp%d: error = %d reading IEEE-1284 Device ID string",
1127                         usblp->minor, err);
1128                 usblp->device_id_string[0] = usblp->device_id_string[1] = '\0';
1129                 return -EIO;
1130         }
1131
1132         /* First two bytes are length in big-endian.
1133          * They count themselves, and we copy them into
1134          * the user's buffer. */
1135         length = be16_to_cpu(*((__be16 *)usblp->device_id_string));
1136         if (length < 2)
1137                 length = 2;
1138         else if (length >= USBLP_DEVICE_ID_SIZE)
1139                 length = USBLP_DEVICE_ID_SIZE - 1;
1140         usblp->device_id_string[length] = '\0';
1141
1142         dbg("usblp%d Device ID string [len=%d]=\"%s\"",
1143                 usblp->minor, length, &usblp->device_id_string[2]);
1144
1145         return length;
1146 }
1147
1148 static void usblp_disconnect(struct usb_interface *intf)
1149 {
1150         struct usblp *usblp = usb_get_intfdata (intf);
1151
1152         usb_deregister_dev(intf, &usblp_class);
1153
1154         if (!usblp || !usblp->dev) {
1155                 err("bogus disconnect");
1156                 BUG ();
1157         }
1158
1159         down (&usblp_sem);
1160         down (&usblp->sem);
1161         usblp->present = 0;
1162         usb_set_intfdata (intf, NULL);
1163
1164         usblp_unlink_urbs(usblp);
1165         usb_buffer_free (usblp->dev, USBLP_BUF_SIZE,
1166                         usblp->writebuf, usblp->writeurb->transfer_dma);
1167         usb_buffer_free (usblp->dev, USBLP_BUF_SIZE,
1168                         usblp->readbuf, usblp->readurb->transfer_dma);
1169         up (&usblp->sem);
1170
1171         if (!usblp->used)
1172                 usblp_cleanup (usblp);
1173         up (&usblp_sem);
1174 }
1175
1176 static struct usb_device_id usblp_ids [] = {
1177         { USB_DEVICE_INFO(7, 1, 1) },
1178         { USB_DEVICE_INFO(7, 1, 2) },
1179         { USB_DEVICE_INFO(7, 1, 3) },
1180         { USB_INTERFACE_INFO(7, 1, 1) },
1181         { USB_INTERFACE_INFO(7, 1, 2) },
1182         { USB_INTERFACE_INFO(7, 1, 3) },
1183         { }                                             /* Terminating entry */
1184 };
1185
1186 MODULE_DEVICE_TABLE (usb, usblp_ids);
1187
1188 static struct usb_driver usblp_driver = {
1189         .owner =        THIS_MODULE,
1190         .name =         "usblp",
1191         .probe =        usblp_probe,
1192         .disconnect =   usblp_disconnect,
1193         .id_table =     usblp_ids,
1194 };
1195
1196 static int __init usblp_init(void)
1197 {
1198         int retval;
1199         retval = usb_register(&usblp_driver);
1200         if (retval)
1201                 goto out;
1202         info(DRIVER_VERSION ": " DRIVER_DESC);
1203 out:
1204         return retval;
1205 }
1206
1207 static void __exit usblp_exit(void)
1208 {
1209         usb_deregister(&usblp_driver);
1210 }
1211
1212 module_init(usblp_init);
1213 module_exit(usblp_exit);
1214
1215 MODULE_AUTHOR( DRIVER_AUTHOR );
1216 MODULE_DESCRIPTION( DRIVER_DESC );
1217 module_param(proto_bias, int, S_IRUGO | S_IWUSR);
1218 MODULE_PARM_DESC(proto_bias, "Favourite protocol number");
1219 MODULE_LICENSE("GPL");