blob: 80ec1039d670c928159652e9c3f18fd6210ea674 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Pete Zaitcev317c67b2007-06-21 12:44:56 -07002 * usblp.c
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
4 * Copyright (c) 1999 Michael Gee <michael@linuxspecific.com>
5 * Copyright (c) 1999 Pavel Machek <pavel@suse.cz>
Adrian Bunkf4b09eb2006-01-03 13:37:51 +01006 * Copyright (c) 2000 Randy Dunlap <rdunlap@xenotime.net>
Linus Torvalds1da177e2005-04-16 15:20:36 -07007 * 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>
Oliver Neukum8e695cd2006-01-07 21:35:20 +010010 * Copyright (c) 2006 Oliver Neukum <oliver@neukum.name>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011 *
12 * USB Printer Device Class driver for USB printers and printer cables
13 *
14 * Sponsored by SuSE
15 *
16 * ChangeLog:
17 * v0.1 - thorough cleaning, URBification, almost a rewrite
18 * v0.2 - some more cleanups
19 * v0.3 - cleaner again, waitqueue fixes
20 * v0.4 - fixes in unidirectional mode
21 * v0.5 - add DEVICE_ID string support
22 * v0.6 - never time out
23 * v0.7 - fixed bulk-IN read and poll (David Paschal)
24 * v0.8 - add devfs support
25 * v0.9 - fix unplug-while-open paths
26 * v0.10- remove sleep_on, fix error on oom (oliver@neukum.org)
27 * v0.11 - add proto_bias option (Pete Zaitcev)
28 * v0.12 - add hpoj.sourceforge.net ioctls (David Paschal)
29 * v0.13 - alloc space for statusbuf (<status> not on stack);
30 * use usb_buffer_alloc() for read buf & write buf;
31 */
32
33/*
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.
38 *
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.
43 *
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
47 */
48
49#include <linux/module.h>
50#include <linux/kernel.h>
51#include <linux/sched.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070052#include <linux/signal.h>
53#include <linux/poll.h>
54#include <linux/init.h>
55#include <linux/slab.h>
56#include <linux/lp.h>
Arjan van de Ven4186ecf2006-01-11 15:55:29 +010057#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070058#undef DEBUG
59#include <linux/usb.h>
60
61/*
62 * Version Information
63 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070064#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
Pete Zaitcev317c67b2007-06-21 12:44:56 -070068#define USBLP_BUF_SIZE_IN 1024
Linus Torvalds1da177e2005-04-16 15:20:36 -070069#define USBLP_DEVICE_ID_SIZE 1024
70
71/* ioctls: */
72#define LPGETSTATUS 0x060b /* same as in drivers/char/lp.c */
73#define IOCNR_GET_DEVICE_ID 1
74#define IOCNR_GET_PROTOCOLS 2
75#define IOCNR_SET_PROTOCOL 3
76#define IOCNR_HP_SET_CHANNEL 4
77#define IOCNR_GET_BUS_ADDRESS 5
78#define IOCNR_GET_VID_PID 6
79#define IOCNR_SOFT_RESET 7
80/* Get device_id string: */
81#define LPIOC_GET_DEVICE_ID(len) _IOC(_IOC_READ, 'P', IOCNR_GET_DEVICE_ID, len)
82/* The following ioctls were added for http://hpoj.sourceforge.net: */
83/* Get two-int array:
84 * [0]=current protocol (1=7/1/1, 2=7/1/2, 3=7/1/3),
85 * [1]=supported protocol mask (mask&(1<<n)!=0 means 7/1/n supported): */
86#define LPIOC_GET_PROTOCOLS(len) _IOC(_IOC_READ, 'P', IOCNR_GET_PROTOCOLS, len)
87/* Set protocol (arg: 1=7/1/1, 2=7/1/2, 3=7/1/3): */
88#define LPIOC_SET_PROTOCOL _IOC(_IOC_WRITE, 'P', IOCNR_SET_PROTOCOL, 0)
89/* Set channel number (HP Vendor-specific command): */
90#define LPIOC_HP_SET_CHANNEL _IOC(_IOC_WRITE, 'P', IOCNR_HP_SET_CHANNEL, 0)
91/* Get two-int array: [0]=bus number, [1]=device address: */
92#define LPIOC_GET_BUS_ADDRESS(len) _IOC(_IOC_READ, 'P', IOCNR_GET_BUS_ADDRESS, len)
93/* Get two-int array: [0]=vendor ID, [1]=product ID: */
94#define LPIOC_GET_VID_PID(len) _IOC(_IOC_READ, 'P', IOCNR_GET_VID_PID, len)
95/* Perform class specific soft reset */
96#define LPIOC_SOFT_RESET _IOC(_IOC_NONE, 'P', IOCNR_SOFT_RESET, 0);
97
98/*
99 * A DEVICE_ID string may include the printer's serial number.
100 * It should end with a semi-colon (';').
101 * An example from an HP 970C DeskJet printer is (this is one long string,
102 * with the serial number changed):
103MFG: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: ;
104 */
105
106/*
107 * USB Printer Requests
108 */
109
110#define USBLP_REQ_GET_ID 0x00
111#define USBLP_REQ_GET_STATUS 0x01
112#define USBLP_REQ_RESET 0x02
113#define USBLP_REQ_HP_CHANNEL_CHANGE_REQUEST 0x00 /* HP Vendor-specific */
114
115#define USBLP_MINORS 16
116#define USBLP_MINOR_BASE 0
117
118#define USBLP_WRITE_TIMEOUT (5000) /* 5 seconds */
119
120#define USBLP_FIRST_PROTOCOL 1
121#define USBLP_LAST_PROTOCOL 3
122#define USBLP_MAX_PROTOCOLS (USBLP_LAST_PROTOCOL+1)
123
124/*
125 * some arbitrary status buffer size;
126 * need a status buffer that is allocated via kmalloc(), not on stack
127 */
128#define STATUS_BUF_SIZE 8
129
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700130/*
131 * Locks down the locking order:
132 * ->wmut locks wstatus.
133 * ->mut locks the whole usblp, except [rw]complete, and thus, by indirection,
134 * [rw]status. We only touch status when we know the side idle.
135 * ->lock locks what interrupt accesses.
136 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137struct usblp {
138 struct usb_device *dev; /* USB device */
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700139 struct mutex wmut;
140 struct mutex mut;
141 spinlock_t lock; /* locks rcomplete, wcomplete */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 char *readbuf; /* read transfer_buffer */
143 char *statusbuf; /* status transfer_buffer */
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700144 struct usb_anchor urbs;
145 wait_queue_head_t rwait, wwait;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 int readcount; /* Counter for reads */
147 int ifnum; /* Interface number */
148 struct usb_interface *intf; /* The interface */
149 /* Alternate-setting numbers and endpoints for each protocol
150 * (7/1/{index=1,2,3}) that the device supports: */
151 struct {
152 int alt_setting;
153 struct usb_endpoint_descriptor *epwrite;
154 struct usb_endpoint_descriptor *epread;
155 } protocol[USBLP_MAX_PROTOCOLS];
156 int current_protocol;
157 int minor; /* minor number of device */
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700158 int wcomplete, rcomplete;
159 int wstatus; /* bytes written or error */
160 int rstatus; /* bytes ready or error */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 unsigned int quirks; /* quirks flags */
162 unsigned char used; /* True if open */
163 unsigned char present; /* True if not disconnected */
164 unsigned char bidir; /* interface is bidirectional */
Oliver Neukum516077c2006-10-05 09:04:11 +0200165 unsigned char sleeping; /* interface is suspended */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 unsigned char *device_id_string; /* IEEE 1284 DEVICE ID string (ptr) */
167 /* first 2 bytes are (big-endian) length */
168};
169
170#ifdef DEBUG
171static void usblp_dump(struct usblp *usblp) {
172 int p;
173
174 dbg("usblp=0x%p", usblp);
175 dbg("dev=0x%p", usblp->dev);
176 dbg("present=%d", usblp->present);
177 dbg("readbuf=0x%p", usblp->readbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 dbg("readcount=%d", usblp->readcount);
179 dbg("ifnum=%d", usblp->ifnum);
180 for (p = USBLP_FIRST_PROTOCOL; p <= USBLP_LAST_PROTOCOL; p++) {
181 dbg("protocol[%d].alt_setting=%d", p, usblp->protocol[p].alt_setting);
182 dbg("protocol[%d].epwrite=%p", p, usblp->protocol[p].epwrite);
183 dbg("protocol[%d].epread=%p", p, usblp->protocol[p].epread);
184 }
185 dbg("current_protocol=%d", usblp->current_protocol);
186 dbg("minor=%d", usblp->minor);
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700187 dbg("wstatus=%d", usblp->wstatus);
188 dbg("rstatus=%d", usblp->rstatus);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 dbg("quirks=%d", usblp->quirks);
190 dbg("used=%d", usblp->used);
191 dbg("bidir=%d", usblp->bidir);
Oliver Neukum516077c2006-10-05 09:04:11 +0200192 dbg("sleeping=%d", usblp->sleeping);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 dbg("device_id_string=\"%s\"",
194 usblp->device_id_string ?
195 usblp->device_id_string + 2 :
196 (unsigned char *)"(null)");
197}
198#endif
199
200/* Quirks: various printer quirks are handled by this table & its flags. */
201
202struct quirk_printer_struct {
203 __u16 vendorId;
204 __u16 productId;
205 unsigned int quirks;
206};
207
208#define USBLP_QUIRK_BIDIR 0x1 /* reports bidir but requires unidirectional mode (no INs/reads) */
209#define USBLP_QUIRK_USB_INIT 0x2 /* needs vendor USB init string */
Alan Stern5ec71db2007-03-16 15:53:07 -0400210#define USBLP_QUIRK_BAD_CLASS 0x4 /* descriptor uses vendor-specific Class or SubClass */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211
Arjan van de Ven4c4c9432005-11-29 09:43:42 +0100212static const struct quirk_printer_struct quirk_printers[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213 { 0x03f0, 0x0004, USBLP_QUIRK_BIDIR }, /* HP DeskJet 895C */
214 { 0x03f0, 0x0104, USBLP_QUIRK_BIDIR }, /* HP DeskJet 880C */
215 { 0x03f0, 0x0204, USBLP_QUIRK_BIDIR }, /* HP DeskJet 815C */
216 { 0x03f0, 0x0304, USBLP_QUIRK_BIDIR }, /* HP DeskJet 810C/812C */
217 { 0x03f0, 0x0404, USBLP_QUIRK_BIDIR }, /* HP DeskJet 830C */
218 { 0x03f0, 0x0504, USBLP_QUIRK_BIDIR }, /* HP DeskJet 885C */
219 { 0x03f0, 0x0604, USBLP_QUIRK_BIDIR }, /* HP DeskJet 840C */
220 { 0x03f0, 0x0804, USBLP_QUIRK_BIDIR }, /* HP DeskJet 816C */
221 { 0x03f0, 0x1104, USBLP_QUIRK_BIDIR }, /* HP Deskjet 959C */
222 { 0x0409, 0xefbe, USBLP_QUIRK_BIDIR }, /* NEC Picty900 (HP OEM) */
223 { 0x0409, 0xbef4, USBLP_QUIRK_BIDIR }, /* NEC Picty760 (HP OEM) */
224 { 0x0409, 0xf0be, USBLP_QUIRK_BIDIR }, /* NEC Picty920 (HP OEM) */
225 { 0x0409, 0xf1be, USBLP_QUIRK_BIDIR }, /* NEC Picty800 (HP OEM) */
Martin Williges4f45d032006-12-28 20:52:10 +0100226 { 0x0482, 0x0010, USBLP_QUIRK_BIDIR }, /* Kyocera Mita FS 820, by zut <kernel@zut.de> */
Alan Stern5ec71db2007-03-16 15:53:07 -0400227 { 0x04b8, 0x0202, USBLP_QUIRK_BAD_CLASS }, /* Seiko Epson Receipt Printer M129C */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228 { 0, 0 }
229};
230
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700231static int usblp_wwait(struct usblp *usblp, int nonblock);
232static int usblp_wtest(struct usblp *usblp, int nonblock);
233static int usblp_rwait_and_lock(struct usblp *usblp, int nonblock);
234static int usblp_rtest(struct usblp *usblp, int nonblock);
235static int usblp_submit_read(struct usblp *usblp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236static int usblp_select_alts(struct usblp *usblp);
237static int usblp_set_protocol(struct usblp *usblp, int protocol);
238static int usblp_cache_device_id_string(struct usblp *usblp);
239
240/* forward reference to make our lives easier */
241static struct usb_driver usblp_driver;
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100242static DEFINE_MUTEX(usblp_mutex); /* locks the existence of usblp's */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243
244/*
245 * Functions for usblp control messages.
246 */
247
248static int usblp_ctrl_msg(struct usblp *usblp, int request, int type, int dir, int recip, int value, void *buf, int len)
249{
250 int retval;
251 int index = usblp->ifnum;
252
253 /* High byte has the interface index.
254 Low byte has the alternate setting.
255 */
256 if ((request == USBLP_REQ_GET_ID) && (type == USB_TYPE_CLASS)) {
257 index = (usblp->ifnum<<8)|usblp->protocol[usblp->current_protocol].alt_setting;
258 }
259
260 retval = usb_control_msg(usblp->dev,
261 dir ? usb_rcvctrlpipe(usblp->dev, 0) : usb_sndctrlpipe(usblp->dev, 0),
262 request, type | dir | recip, value, index, buf, len, USBLP_WRITE_TIMEOUT);
263 dbg("usblp_control_msg: rq: 0x%02x dir: %d recip: %d value: %d idx: %d len: %#x result: %d",
264 request, !!dir, recip, value, index, len, retval);
265 return retval < 0 ? retval : 0;
266}
267
268#define usblp_read_status(usblp, status)\
269 usblp_ctrl_msg(usblp, USBLP_REQ_GET_STATUS, USB_TYPE_CLASS, USB_DIR_IN, USB_RECIP_INTERFACE, 0, status, 1)
270#define usblp_get_id(usblp, config, id, maxlen)\
271 usblp_ctrl_msg(usblp, USBLP_REQ_GET_ID, USB_TYPE_CLASS, USB_DIR_IN, USB_RECIP_INTERFACE, config, id, maxlen)
272#define usblp_reset(usblp)\
273 usblp_ctrl_msg(usblp, USBLP_REQ_RESET, USB_TYPE_CLASS, USB_DIR_OUT, USB_RECIP_OTHER, 0, NULL, 0)
274
275#define usblp_hp_channel_change_request(usblp, channel, buffer) \
276 usblp_ctrl_msg(usblp, USBLP_REQ_HP_CHANNEL_CHANGE_REQUEST, USB_TYPE_VENDOR, USB_DIR_IN, USB_RECIP_INTERFACE, channel, buffer, 1)
277
278/*
279 * See the description for usblp_select_alts() below for the usage
280 * explanation. Look into your /proc/bus/usb/devices and dmesg in
281 * case of any trouble.
282 */
283static int proto_bias = -1;
284
285/*
286 * URB callback.
287 */
288
David Howells7d12e782006-10-05 14:55:46 +0100289static void usblp_bulk_read(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290{
291 struct usblp *usblp = urb->context;
292
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700293 if (usblp->present && usblp->used) {
294 if (urb->status)
295 printk(KERN_WARNING "usblp%d: "
296 "nonzero read bulk status received: %d\n",
297 usblp->minor, urb->status);
298 }
299 spin_lock(&usblp->lock);
300 if (urb->status < 0)
301 usblp->rstatus = urb->status;
302 else
303 usblp->rstatus = urb->actual_length;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 usblp->rcomplete = 1;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700305 wake_up(&usblp->rwait);
306 spin_unlock(&usblp->lock);
307
308 usb_free_urb(urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309}
310
David Howells7d12e782006-10-05 14:55:46 +0100311static void usblp_bulk_write(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700312{
313 struct usblp *usblp = urb->context;
314
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700315 if (usblp->present && usblp->used) {
316 if (urb->status)
317 printk(KERN_WARNING "usblp%d: "
318 "nonzero write bulk status received: %d\n",
319 usblp->minor, urb->status);
320 }
321 spin_lock(&usblp->lock);
322 if (urb->status < 0)
323 usblp->wstatus = urb->status;
324 else
325 usblp->wstatus = urb->actual_length;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 usblp->wcomplete = 1;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700327 wake_up(&usblp->wwait);
328 spin_unlock(&usblp->lock);
329
330 /* XXX Use usb_setup_bulk_urb when available. Talk to Marcel. */
331 kfree(urb->transfer_buffer);
332 urb->transfer_buffer = NULL; /* Not refcounted, so to be safe... */
333 usb_free_urb(urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334}
335
336/*
337 * Get and print printer errors.
338 */
339
Arjan van de Ven4c4c9432005-11-29 09:43:42 +0100340static const char *usblp_messages[] = { "ok", "out of paper", "off-line", "on fire" };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341
342static int usblp_check_status(struct usblp *usblp, int err)
343{
344 unsigned char status, newerr = 0;
345 int error;
346
347 error = usblp_read_status (usblp, usblp->statusbuf);
348 if (error < 0) {
Randy Dunlap0bc8e002005-07-31 20:41:19 -0700349 if (printk_ratelimit())
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700350 printk(KERN_ERR
351 "usblp%d: error %d reading printer status\n",
Randy Dunlap0bc8e002005-07-31 20:41:19 -0700352 usblp->minor, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353 return 0;
354 }
355
356 status = *usblp->statusbuf;
357
358 if (~status & LP_PERRORP)
359 newerr = 3;
360 if (status & LP_POUTPA)
361 newerr = 1;
362 if (~status & LP_PSELECD)
363 newerr = 2;
364
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700365 if (newerr != err) {
366 printk(KERN_INFO "usblp%d: %s\n",
367 usblp->minor, usblp_messages[newerr]);
368 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369
370 return newerr;
371}
372
Oliver Neukum516077c2006-10-05 09:04:11 +0200373static int handle_bidir (struct usblp *usblp)
374{
375 if (usblp->bidir && usblp->used && !usblp->sleeping) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700376 if (usblp_submit_read(usblp) < 0)
Oliver Neukum516077c2006-10-05 09:04:11 +0200377 return -EIO;
Oliver Neukum516077c2006-10-05 09:04:11 +0200378 }
Oliver Neukum516077c2006-10-05 09:04:11 +0200379 return 0;
380}
381
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382/*
383 * File op functions.
384 */
385
386static int usblp_open(struct inode *inode, struct file *file)
387{
388 int minor = iminor(inode);
389 struct usblp *usblp;
390 struct usb_interface *intf;
391 int retval;
392
393 if (minor < 0)
394 return -ENODEV;
395
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100396 mutex_lock (&usblp_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397
398 retval = -ENODEV;
399 intf = usb_find_interface(&usblp_driver, minor);
400 if (!intf) {
401 goto out;
402 }
403 usblp = usb_get_intfdata (intf);
404 if (!usblp || !usblp->dev || !usblp->present)
405 goto out;
406
407 retval = -EBUSY;
408 if (usblp->used)
409 goto out;
410
411 /*
412 * TODO: need to implement LP_ABORTOPEN + O_NONBLOCK as in drivers/char/lp.c ???
413 * This is #if 0-ed because we *don't* want to fail an open
414 * just because the printer is off-line.
415 */
416#if 0
417 if ((retval = usblp_check_status(usblp, 0))) {
418 retval = retval > 1 ? -EIO : -ENOSPC;
419 goto out;
420 }
421#else
422 retval = 0;
423#endif
424
Oliver Neukumd0532182007-01-18 15:06:07 +0100425 retval = usb_autopm_get_interface(intf);
426 if (retval < 0)
427 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 usblp->used = 1;
429 file->private_data = usblp;
430
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 usblp->wcomplete = 1; /* we begin writeable */
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700432 usblp->wstatus = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433 usblp->rcomplete = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434
Oliver Neukum516077c2006-10-05 09:04:11 +0200435 if (handle_bidir(usblp) < 0) {
Pete Zaitcev97cb95d2007-05-24 21:59:19 -0700436 usblp->used = 0;
Oliver Neukum516077c2006-10-05 09:04:11 +0200437 file->private_data = NULL;
438 retval = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 }
440out:
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100441 mutex_unlock (&usblp_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 return retval;
443}
444
445static void usblp_cleanup (struct usblp *usblp)
446{
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700447 printk(KERN_INFO "usblp%d: removed\n", usblp->minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700449 kfree(usblp->readbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 kfree (usblp->device_id_string);
451 kfree (usblp->statusbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 kfree (usblp);
453}
454
455static void usblp_unlink_urbs(struct usblp *usblp)
456{
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700457 usb_kill_anchored_urbs(&usblp->urbs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458}
459
460static int usblp_release(struct inode *inode, struct file *file)
461{
462 struct usblp *usblp = file->private_data;
463
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100464 mutex_lock (&usblp_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 usblp->used = 0;
466 if (usblp->present) {
467 usblp_unlink_urbs(usblp);
Oliver Neukumd0532182007-01-18 15:06:07 +0100468 usb_autopm_put_interface(usblp->intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 } else /* finish cleanup from disconnect */
470 usblp_cleanup (usblp);
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100471 mutex_unlock (&usblp_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472 return 0;
473}
474
475/* No kernel lock - fine */
476static unsigned int usblp_poll(struct file *file, struct poll_table_struct *wait)
477{
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700478 int ret;
479 unsigned long flags;
480
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 struct usblp *usblp = file->private_data;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700482 /* Should we check file->f_mode & FMODE_WRITE before poll_wait()? */
483 poll_wait(file, &usblp->rwait, wait);
484 poll_wait(file, &usblp->wwait, wait);
485 spin_lock_irqsave(&usblp->lock, flags);
486 ret = ((!usblp->bidir || !usblp->rcomplete) ? 0 : POLLIN | POLLRDNORM)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 | (!usblp->wcomplete ? 0 : POLLOUT | POLLWRNORM);
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700488 spin_unlock_irqrestore(&usblp->lock, flags);
489 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490}
491
Pete Zaitcev318e4792005-12-21 17:03:24 -0800492static long usblp_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493{
494 struct usblp *usblp = file->private_data;
495 int length, err, i;
496 unsigned char newChannel;
497 int status;
498 int twoints[2];
499 int retval = 0;
500
Oliver Neukum8e422662006-12-03 09:46:35 +0100501 mutex_lock (&usblp->mut);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 if (!usblp->present) {
503 retval = -ENODEV;
504 goto done;
505 }
506
Oliver Neukum516077c2006-10-05 09:04:11 +0200507 if (usblp->sleeping) {
508 retval = -ENODEV;
509 goto done;
510 }
511
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 dbg("usblp_ioctl: cmd=0x%x (%c nr=%d len=%d dir=%d)", cmd, _IOC_TYPE(cmd),
513 _IOC_NR(cmd), _IOC_SIZE(cmd), _IOC_DIR(cmd) );
514
515 if (_IOC_TYPE(cmd) == 'P') /* new-style ioctl number */
516
517 switch (_IOC_NR(cmd)) {
518
519 case IOCNR_GET_DEVICE_ID: /* get the DEVICE_ID string */
520 if (_IOC_DIR(cmd) != _IOC_READ) {
521 retval = -EINVAL;
522 goto done;
523 }
524
525 length = usblp_cache_device_id_string(usblp);
526 if (length < 0) {
527 retval = length;
528 goto done;
529 }
530 if (length > _IOC_SIZE(cmd))
531 length = _IOC_SIZE(cmd); /* truncate */
532
533 if (copy_to_user((void __user *) arg,
534 usblp->device_id_string,
535 (unsigned long) length)) {
536 retval = -EFAULT;
537 goto done;
538 }
539
540 break;
541
542 case IOCNR_GET_PROTOCOLS:
543 if (_IOC_DIR(cmd) != _IOC_READ ||
544 _IOC_SIZE(cmd) < sizeof(twoints)) {
545 retval = -EINVAL;
546 goto done;
547 }
548
549 twoints[0] = usblp->current_protocol;
550 twoints[1] = 0;
551 for (i = USBLP_FIRST_PROTOCOL;
552 i <= USBLP_LAST_PROTOCOL; i++) {
553 if (usblp->protocol[i].alt_setting >= 0)
554 twoints[1] |= (1<<i);
555 }
556
557 if (copy_to_user((void __user *)arg,
558 (unsigned char *)twoints,
559 sizeof(twoints))) {
560 retval = -EFAULT;
561 goto done;
562 }
563
564 break;
565
566 case IOCNR_SET_PROTOCOL:
567 if (_IOC_DIR(cmd) != _IOC_WRITE) {
568 retval = -EINVAL;
569 goto done;
570 }
571
572#ifdef DEBUG
573 if (arg == -10) {
574 usblp_dump(usblp);
575 break;
576 }
577#endif
578
579 usblp_unlink_urbs(usblp);
580 retval = usblp_set_protocol(usblp, arg);
581 if (retval < 0) {
582 usblp_set_protocol(usblp,
583 usblp->current_protocol);
584 }
585 break;
586
587 case IOCNR_HP_SET_CHANNEL:
588 if (_IOC_DIR(cmd) != _IOC_WRITE ||
589 le16_to_cpu(usblp->dev->descriptor.idVendor) != 0x03F0 ||
590 usblp->quirks & USBLP_QUIRK_BIDIR) {
591 retval = -EINVAL;
592 goto done;
593 }
594
595 err = usblp_hp_channel_change_request(usblp,
596 arg, &newChannel);
597 if (err < 0) {
598 err("usblp%d: error = %d setting "
599 "HP channel",
600 usblp->minor, err);
601 retval = -EIO;
602 goto done;
603 }
604
605 dbg("usblp%d requested/got HP channel %ld/%d",
606 usblp->minor, arg, newChannel);
607 break;
608
609 case IOCNR_GET_BUS_ADDRESS:
610 if (_IOC_DIR(cmd) != _IOC_READ ||
611 _IOC_SIZE(cmd) < sizeof(twoints)) {
612 retval = -EINVAL;
613 goto done;
614 }
615
616 twoints[0] = usblp->dev->bus->busnum;
617 twoints[1] = usblp->dev->devnum;
618 if (copy_to_user((void __user *)arg,
619 (unsigned char *)twoints,
620 sizeof(twoints))) {
621 retval = -EFAULT;
622 goto done;
623 }
624
625 dbg("usblp%d is bus=%d, device=%d",
626 usblp->minor, twoints[0], twoints[1]);
627 break;
628
629 case IOCNR_GET_VID_PID:
630 if (_IOC_DIR(cmd) != _IOC_READ ||
631 _IOC_SIZE(cmd) < sizeof(twoints)) {
632 retval = -EINVAL;
633 goto done;
634 }
635
636 twoints[0] = le16_to_cpu(usblp->dev->descriptor.idVendor);
637 twoints[1] = le16_to_cpu(usblp->dev->descriptor.idProduct);
638 if (copy_to_user((void __user *)arg,
639 (unsigned char *)twoints,
640 sizeof(twoints))) {
641 retval = -EFAULT;
642 goto done;
643 }
644
645 dbg("usblp%d is VID=0x%4.4X, PID=0x%4.4X",
646 usblp->minor, twoints[0], twoints[1]);
647 break;
648
649 case IOCNR_SOFT_RESET:
650 if (_IOC_DIR(cmd) != _IOC_NONE) {
651 retval = -EINVAL;
652 goto done;
653 }
654 retval = usblp_reset(usblp);
655 break;
656 default:
657 retval = -ENOTTY;
658 }
659 else /* old-style ioctl value */
660 switch (cmd) {
661
662 case LPGETSTATUS:
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700663 if ((retval = usblp_read_status(usblp, usblp->statusbuf))) {
Randy Dunlap0bc8e002005-07-31 20:41:19 -0700664 if (printk_ratelimit())
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700665 printk(KERN_ERR "usblp%d:"
666 "failed reading printer status (%d)\n",
667 usblp->minor, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 retval = -EIO;
669 goto done;
670 }
671 status = *usblp->statusbuf;
672 if (copy_to_user ((void __user *)arg, &status, sizeof(int)))
673 retval = -EFAULT;
674 break;
675
676 default:
677 retval = -ENOTTY;
678 }
679
680done:
Oliver Neukum8e422662006-12-03 09:46:35 +0100681 mutex_unlock (&usblp->mut);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682 return retval;
683}
684
685static ssize_t usblp_write(struct file *file, const char __user *buffer, size_t count, loff_t *ppos)
686{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 struct usblp *usblp = file->private_data;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700688 char *writebuf;
689 struct urb *writeurb;
690 int rv;
691 int transfer_length;
692 ssize_t writecount = 0;
693
694 if (mutex_lock_interruptible(&usblp->wmut)) {
695 rv = -EINTR;
696 goto raise_biglock;
697 }
698 if ((rv = usblp_wwait(usblp, !!(file->f_flags & O_NONBLOCK))) < 0)
699 goto raise_wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700
701 while (writecount < count) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700702 /*
703 * Step 1: Submit next block.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704 */
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700705 if ((transfer_length = count - writecount) > USBLP_BUF_SIZE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706 transfer_length = USBLP_BUF_SIZE;
707
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700708 rv = -ENOMEM;
709 if ((writebuf = kmalloc(USBLP_BUF_SIZE, GFP_KERNEL)) == NULL)
710 goto raise_buf;
711 if ((writeurb = usb_alloc_urb(0, GFP_KERNEL)) == NULL)
712 goto raise_urb;
713 usb_fill_bulk_urb(writeurb, usblp->dev,
714 usb_sndbulkpipe(usblp->dev,
715 usblp->protocol[usblp->current_protocol].epwrite->bEndpointAddress),
716 writebuf, transfer_length, usblp_bulk_write, usblp);
717 usb_anchor_urb(writeurb, &usblp->urbs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700719 if (copy_from_user(writebuf,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 buffer + writecount, transfer_length)) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700721 rv = -EFAULT;
722 goto raise_badaddr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 }
724
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700725 spin_lock_irq(&usblp->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 usblp->wcomplete = 0;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700727 spin_unlock_irq(&usblp->lock);
728 if ((rv = usb_submit_urb(writeurb, GFP_KERNEL)) < 0) {
729 usblp->wstatus = 0;
730 spin_lock_irq(&usblp->lock);
Oliver Neukum6c8df792006-10-28 11:36:59 +0200731 usblp->wcomplete = 1;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700732 wake_up(&usblp->wwait);
733 spin_unlock_irq(&usblp->lock);
734 if (rv != -ENOMEM)
735 rv = -EIO;
736 goto raise_submit;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 }
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700738
739 /*
740 * Step 2: Wait for transfer to end, collect results.
741 */
742 rv = usblp_wwait(usblp, !!(file->f_flags&O_NONBLOCK));
743 if (rv < 0) {
Pete Zaitcev10e48522007-07-10 20:09:58 -0700744 if (rv == -EAGAIN) {
745 /* Presume that it's going to complete well. */
746 writecount += transfer_length;
747 }
748 /* Leave URB dangling, to be cleaned on close. */
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700749 goto collect_error;
750 }
751
752 if (usblp->wstatus < 0) {
753 usblp_check_status(usblp, 0);
754 rv = -EIO;
755 goto collect_error;
756 }
757 /*
758 * This is critical: it must be our URB, not other writer's.
759 * The wmut exists mainly to cover us here.
760 */
761 writecount += usblp->wstatus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762 }
763
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700764 mutex_unlock(&usblp->wmut);
765 return writecount;
766
767raise_submit:
768raise_badaddr:
769 usb_unanchor_urb(writeurb);
770 usb_free_urb(writeurb);
771raise_urb:
772 kfree(writebuf);
773raise_buf:
774raise_wait:
775collect_error: /* Out of raise sequence */
776 mutex_unlock(&usblp->wmut);
777raise_biglock:
778 return writecount ? writecount : rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779}
780
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700781/*
782 * Notice that we fail to restart in a few cases: on EFAULT, on restart
783 * error, etc. This is the historical behaviour. In all such cases we return
784 * EIO, and applications loop in order to get the new read going.
785 */
786static ssize_t usblp_read(struct file *file, char __user *buffer, size_t len, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787{
788 struct usblp *usblp = file->private_data;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700789 ssize_t count;
790 ssize_t avail;
791 int rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792
793 if (!usblp->bidir)
794 return -EINVAL;
795
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700796 rv = usblp_rwait_and_lock(usblp, !!(file->f_flags & O_NONBLOCK));
797 if (rv < 0)
798 return rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700800 if ((avail = usblp->rstatus) < 0) {
801 printk(KERN_ERR "usblp%d: error %d reading from printer\n",
802 usblp->minor, (int)avail);
803 usblp_submit_read(usblp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804 count = -EIO;
805 goto done;
806 }
807
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700808 count = len < avail - usblp->readcount ? len : avail - usblp->readcount;
809 if (count != 0 &&
810 copy_to_user(buffer, usblp->readbuf + usblp->readcount, count)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 count = -EFAULT;
812 goto done;
813 }
814
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700815 if ((usblp->readcount += count) == avail) {
816 if (usblp_submit_read(usblp) < 0) {
817 /* We don't want to leak USB return codes into errno. */
818 if (count == 0)
819 count = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 goto done;
821 }
822 }
823
824done:
Oliver Neukum8e422662006-12-03 09:46:35 +0100825 mutex_unlock (&usblp->mut);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826 return count;
827}
828
829/*
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700830 * Wait for the write path to come idle.
831 * This is called under the ->wmut, so the idle path stays idle.
832 *
833 * Our write path has a peculiar property: it does not buffer like a tty,
834 * but waits for the write to succeed. This allows our ->release to bug out
835 * without waiting for writes to drain. But it obviously does not work
836 * when O_NONBLOCK is set. So, applications setting O_NONBLOCK must use
837 * select(2) or poll(2) to wait for the buffer to drain before closing.
838 * Alternatively, set blocking mode with fcntl and issue a zero-size write.
839 *
840 * Old v0.13 code had a non-functional timeout for wait_event(). Someone forgot
841 * to check the return code for timeout expiration, so it had no effect.
842 * Apparently, it was intended to check for error conditons, such as out
843 * of paper. It is going to return when we settle things with CUPS. XXX
844 */
845static int usblp_wwait(struct usblp *usblp, int nonblock)
846{
847 DECLARE_WAITQUEUE(waita, current);
848 int rc;
849
850 add_wait_queue(&usblp->wwait, &waita);
851 for (;;) {
852 if (mutex_lock_interruptible(&usblp->mut)) {
853 rc = -EINTR;
854 break;
855 }
856 set_current_state(TASK_INTERRUPTIBLE);
857 if ((rc = usblp_wtest(usblp, nonblock)) < 0) {
858 mutex_unlock(&usblp->mut);
859 break;
860 }
861 mutex_unlock(&usblp->mut);
862 if (rc == 0)
863 break;
864 schedule();
865 }
866 set_current_state(TASK_RUNNING);
867 remove_wait_queue(&usblp->wwait, &waita);
868 return rc;
869}
870
871static int usblp_wtest(struct usblp *usblp, int nonblock)
872{
873 unsigned long flags;
874
875 if (!usblp->present)
876 return -ENODEV;
877 if (signal_pending(current))
878 return -EINTR;
879 spin_lock_irqsave(&usblp->lock, flags);
880 if (usblp->wcomplete) {
881 spin_unlock_irqrestore(&usblp->lock, flags);
882 return 0;
883 }
884 spin_unlock_irqrestore(&usblp->lock, flags);
885 if (usblp->sleeping)
886 return -ENODEV;
887 if (nonblock)
888 return -EAGAIN;
889 return 1;
890}
891
892/*
893 * Wait for read bytes to become available. This probably should have been
894 * called usblp_r_lock_and_wait(), because we lock first. But it's a traditional
895 * name for functions which lock and return.
896 *
897 * We do not use wait_event_interruptible because it makes locking iffy.
898 */
899static int usblp_rwait_and_lock(struct usblp *usblp, int nonblock)
900{
901 DECLARE_WAITQUEUE(waita, current);
902 int rc;
903
904 add_wait_queue(&usblp->rwait, &waita);
905 for (;;) {
906 if (mutex_lock_interruptible(&usblp->mut)) {
907 rc = -EINTR;
908 break;
909 }
910 set_current_state(TASK_INTERRUPTIBLE);
911 if ((rc = usblp_rtest(usblp, nonblock)) < 0) {
912 mutex_unlock(&usblp->mut);
913 break;
914 }
915 if (rc == 0) /* Keep it locked */
916 break;
917 mutex_unlock(&usblp->mut);
918 schedule();
919 }
920 set_current_state(TASK_RUNNING);
921 remove_wait_queue(&usblp->rwait, &waita);
922 return rc;
923}
924
925static int usblp_rtest(struct usblp *usblp, int nonblock)
926{
927 unsigned long flags;
928
929 if (!usblp->present)
930 return -ENODEV;
931 if (signal_pending(current))
932 return -EINTR;
933 spin_lock_irqsave(&usblp->lock, flags);
934 if (usblp->rcomplete) {
935 spin_unlock_irqrestore(&usblp->lock, flags);
936 return 0;
937 }
938 spin_unlock_irqrestore(&usblp->lock, flags);
939 if (usblp->sleeping)
940 return -ENODEV;
941 if (nonblock)
942 return -EAGAIN;
943 return 1;
944}
945
946/*
947 * Please check ->bidir and other such things outside for now.
948 */
949static int usblp_submit_read(struct usblp *usblp)
950{
951 struct urb *urb;
952 unsigned long flags;
953 int rc;
954
955 rc = -ENOMEM;
956 if ((urb = usb_alloc_urb(0, GFP_KERNEL)) == NULL)
957 goto raise_urb;
958
959 usb_fill_bulk_urb(urb, usblp->dev,
960 usb_rcvbulkpipe(usblp->dev,
961 usblp->protocol[usblp->current_protocol].epread->bEndpointAddress),
962 usblp->readbuf, USBLP_BUF_SIZE_IN,
963 usblp_bulk_read, usblp);
964 usb_anchor_urb(urb, &usblp->urbs);
965
966 spin_lock_irqsave(&usblp->lock, flags);
967 usblp->readcount = 0; /* XXX Why here? */
968 usblp->rcomplete = 0;
969 spin_unlock_irqrestore(&usblp->lock, flags);
970 if ((rc = usb_submit_urb(urb, GFP_KERNEL)) < 0) {
971 dbg("error submitting urb (%d)", rc);
972 spin_lock_irqsave(&usblp->lock, flags);
973 usblp->rstatus = rc;
974 usblp->rcomplete = 1;
975 spin_unlock_irqrestore(&usblp->lock, flags);
976 goto raise_submit;
977 }
978
979 return 0;
980
981raise_submit:
982 usb_unanchor_urb(urb);
983 usb_free_urb(urb);
984raise_urb:
985 return rc;
986}
987
988/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989 * Checks for printers that have quirks, such as requiring unidirectional
990 * communication but reporting bidirectional; currently some HP printers
991 * have this flaw (HP 810, 880, 895, etc.), or needing an init string
992 * sent at each open (like some Epsons).
993 * Returns 1 if found, 0 if not found.
994 *
995 * HP recommended that we use the bidirectional interface but
996 * don't attempt any bulk IN transfers from the IN endpoint.
997 * Here's some more detail on the problem:
998 * The problem is not that it isn't bidirectional though. The problem
999 * is that if you request a device ID, or status information, while
1000 * the buffers are full, the return data will end up in the print data
1001 * buffer. For example if you make sure you never request the device ID
1002 * while you are sending print data, and you don't try to query the
1003 * printer status every couple of milliseconds, you will probably be OK.
1004 */
1005static unsigned int usblp_quirks (__u16 vendor, __u16 product)
1006{
1007 int i;
1008
1009 for (i = 0; quirk_printers[i].vendorId; i++) {
1010 if (vendor == quirk_printers[i].vendorId &&
1011 product == quirk_printers[i].productId)
1012 return quirk_printers[i].quirks;
1013 }
1014 return 0;
1015}
1016
Luiz Fernando N. Capitulino066202d2006-08-05 20:37:11 -03001017static const struct file_operations usblp_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018 .owner = THIS_MODULE,
1019 .read = usblp_read,
1020 .write = usblp_write,
1021 .poll = usblp_poll,
Pete Zaitcev318e4792005-12-21 17:03:24 -08001022 .unlocked_ioctl = usblp_ioctl,
1023 .compat_ioctl = usblp_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024 .open = usblp_open,
1025 .release = usblp_release,
1026};
1027
1028static struct usb_class_driver usblp_class = {
Greg Kroah-Hartmand6e5bcf2005-06-20 21:15:16 -07001029 .name = "lp%d",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030 .fops = &usblp_fops,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031 .minor_base = USBLP_MINOR_BASE,
1032};
1033
David Woodhousea9714c82005-12-23 16:41:41 +00001034static ssize_t usblp_show_ieee1284_id(struct device *dev, struct device_attribute *attr, char *buf)
1035{
1036 struct usb_interface *intf = to_usb_interface(dev);
1037 struct usblp *usblp = usb_get_intfdata (intf);
1038
1039 if (usblp->device_id_string[0] == 0 &&
1040 usblp->device_id_string[1] == 0)
1041 return 0;
1042
1043 return sprintf(buf, "%s", usblp->device_id_string+2);
1044}
1045
1046static DEVICE_ATTR(ieee1284_id, S_IRUGO, usblp_show_ieee1284_id, NULL);
1047
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048static int usblp_probe(struct usb_interface *intf,
1049 const struct usb_device_id *id)
1050{
1051 struct usb_device *dev = interface_to_usbdev (intf);
1052 struct usblp *usblp = NULL;
1053 int protocol;
1054 int retval;
1055
1056 /* Malloc and start initializing usblp structure so we can use it
1057 * directly. */
Oliver Neukum8e695cd2006-01-07 21:35:20 +01001058 if (!(usblp = kzalloc(sizeof(struct usblp), GFP_KERNEL))) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001059 retval = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001060 goto abort;
1061 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062 usblp->dev = dev;
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001063 mutex_init(&usblp->wmut);
Oliver Neukum8e422662006-12-03 09:46:35 +01001064 mutex_init (&usblp->mut);
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001065 spin_lock_init(&usblp->lock);
1066 init_waitqueue_head(&usblp->rwait);
1067 init_waitqueue_head(&usblp->wwait);
1068 init_usb_anchor(&usblp->urbs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001069 usblp->ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
1070 usblp->intf = intf;
1071
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072 /* Malloc device ID string buffer to the largest expected length,
1073 * since we can re-query it on an ioctl and a dynamic string
1074 * could change in length. */
1075 if (!(usblp->device_id_string = kmalloc(USBLP_DEVICE_ID_SIZE, GFP_KERNEL))) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001076 retval = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077 goto abort;
1078 }
1079
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001080 /*
1081 * Allocate read buffer. We somewhat wastefully
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082 * malloc both regardless of bidirectionality, because the
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001083 * alternate setting can be changed later via an ioctl.
1084 */
1085 if (!(usblp->readbuf = kmalloc(USBLP_BUF_SIZE_IN, GFP_KERNEL))) {
1086 retval = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087 goto abort;
1088 }
1089
1090 /* Allocate buffer for printer status */
1091 usblp->statusbuf = kmalloc(STATUS_BUF_SIZE, GFP_KERNEL);
1092 if (!usblp->statusbuf) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001093 retval = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001094 goto abort;
1095 }
1096
1097 /* Lookup quirks for this printer. */
1098 usblp->quirks = usblp_quirks(
1099 le16_to_cpu(dev->descriptor.idVendor),
1100 le16_to_cpu(dev->descriptor.idProduct));
1101
1102 /* Analyze and pick initial alternate settings and endpoints. */
1103 protocol = usblp_select_alts(usblp);
1104 if (protocol < 0) {
1105 dbg("incompatible printer-class device 0x%4.4X/0x%4.4X",
1106 le16_to_cpu(dev->descriptor.idVendor),
1107 le16_to_cpu(dev->descriptor.idProduct));
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001108 retval = -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109 goto abort;
1110 }
1111
1112 /* Setup the selected alternate setting and endpoints. */
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001113 if (usblp_set_protocol(usblp, protocol) < 0) {
1114 retval = -ENODEV; /* ->probe isn't ->ioctl */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115 goto abort;
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001116 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117
1118 /* Retrieve and store the device ID string. */
1119 usblp_cache_device_id_string(usblp);
Greg Kroah-Hartman96cede52006-08-28 11:43:25 -07001120 retval = device_create_file(&intf->dev, &dev_attr_ieee1284_id);
1121 if (retval)
1122 goto abort_intfdata;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123
1124#ifdef DEBUG
1125 usblp_check_status(usblp, 0);
1126#endif
1127
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128 usb_set_intfdata (intf, usblp);
1129
1130 usblp->present = 1;
1131
1132 retval = usb_register_dev(intf, &usblp_class);
1133 if (retval) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001134 printk(KERN_ERR "usblp: Not able to get a minor"
1135 " (base %u, slice default): %d\n",
1136 USBLP_MINOR_BASE, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001137 goto abort_intfdata;
1138 }
1139 usblp->minor = intf->minor;
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001140 printk(KERN_INFO "usblp%d: USB %sdirectional printer dev %d "
1141 "if %d alt %d proto %d vid 0x%4.4X pid 0x%4.4X\n",
David Woodhousea9714c82005-12-23 16:41:41 +00001142 usblp->minor, usblp->bidir ? "Bi" : "Uni", dev->devnum,
1143 usblp->ifnum,
1144 usblp->protocol[usblp->current_protocol].alt_setting,
1145 usblp->current_protocol,
1146 le16_to_cpu(usblp->dev->descriptor.idVendor),
1147 le16_to_cpu(usblp->dev->descriptor.idProduct));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148
1149 return 0;
1150
1151abort_intfdata:
1152 usb_set_intfdata (intf, NULL);
David Woodhousea9714c82005-12-23 16:41:41 +00001153 device_remove_file(&intf->dev, &dev_attr_ieee1284_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154abort:
1155 if (usblp) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001156 kfree(usblp->readbuf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157 kfree(usblp->statusbuf);
1158 kfree(usblp->device_id_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159 kfree(usblp);
1160 }
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001161 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162}
1163
1164/*
1165 * We are a "new" style driver with usb_device_id table,
1166 * but our requirements are too intricate for simple match to handle.
1167 *
1168 * The "proto_bias" option may be used to specify the preferred protocol
1169 * for all USB printers (1=7/1/1, 2=7/1/2, 3=7/1/3). If the device
1170 * supports the preferred protocol, then we bind to it.
1171 *
1172 * The best interface for us is 7/1/2, because it is compatible
1173 * with a stream of characters. If we find it, we bind to it.
1174 *
1175 * Note that the people from hpoj.sourceforge.net need to be able to
1176 * bind to 7/1/3 (MLC/1284.4), so we provide them ioctls for this purpose.
1177 *
1178 * Failing 7/1/2, we look for 7/1/3, even though it's probably not
1179 * stream-compatible, because this matches the behaviour of the old code.
1180 *
1181 * If nothing else, we bind to 7/1/1 - the unidirectional interface.
1182 */
1183static int usblp_select_alts(struct usblp *usblp)
1184{
1185 struct usb_interface *if_alt;
1186 struct usb_host_interface *ifd;
1187 struct usb_endpoint_descriptor *epd, *epwrite, *epread;
1188 int p, i, e;
1189
1190 if_alt = usblp->intf;
1191
1192 for (p = 0; p < USBLP_MAX_PROTOCOLS; p++)
1193 usblp->protocol[p].alt_setting = -1;
1194
1195 /* Find out what we have. */
1196 for (i = 0; i < if_alt->num_altsetting; i++) {
1197 ifd = &if_alt->altsetting[i];
1198
1199 if (ifd->desc.bInterfaceClass != 7 || ifd->desc.bInterfaceSubClass != 1)
Alan Stern5ec71db2007-03-16 15:53:07 -04001200 if (!(usblp->quirks & USBLP_QUIRK_BAD_CLASS))
1201 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202
1203 if (ifd->desc.bInterfaceProtocol < USBLP_FIRST_PROTOCOL ||
1204 ifd->desc.bInterfaceProtocol > USBLP_LAST_PROTOCOL)
1205 continue;
1206
1207 /* Look for bulk OUT and IN endpoints. */
1208 epwrite = epread = NULL;
1209 for (e = 0; e < ifd->desc.bNumEndpoints; e++) {
1210 epd = &ifd->endpoint[e].desc;
1211
Luiz Fernando N. Capitulino5bc66d52006-09-27 11:58:53 -07001212 if (usb_endpoint_is_bulk_out(epd))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213 if (!epwrite)
1214 epwrite = epd;
1215
Luiz Fernando N. Capitulino5bc66d52006-09-27 11:58:53 -07001216 if (usb_endpoint_is_bulk_in(epd))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217 if (!epread)
1218 epread = epd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219 }
1220
1221 /* Ignore buggy hardware without the right endpoints. */
1222 if (!epwrite || (ifd->desc.bInterfaceProtocol > 1 && !epread))
1223 continue;
1224
1225 /* Turn off reads for 7/1/1 (unidirectional) interfaces
1226 * and buggy bidirectional printers. */
1227 if (ifd->desc.bInterfaceProtocol == 1) {
1228 epread = NULL;
1229 } else if (usblp->quirks & USBLP_QUIRK_BIDIR) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001230 printk(KERN_INFO "usblp%d: Disabling reads from "
1231 "problematic bidirectional printer\n",
1232 usblp->minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233 epread = NULL;
1234 }
1235
1236 usblp->protocol[ifd->desc.bInterfaceProtocol].alt_setting =
1237 ifd->desc.bAlternateSetting;
1238 usblp->protocol[ifd->desc.bInterfaceProtocol].epwrite = epwrite;
1239 usblp->protocol[ifd->desc.bInterfaceProtocol].epread = epread;
1240 }
1241
1242 /* If our requested protocol is supported, then use it. */
1243 if (proto_bias >= USBLP_FIRST_PROTOCOL &&
1244 proto_bias <= USBLP_LAST_PROTOCOL &&
1245 usblp->protocol[proto_bias].alt_setting != -1)
1246 return proto_bias;
1247
1248 /* Ordering is important here. */
1249 if (usblp->protocol[2].alt_setting != -1)
1250 return 2;
1251 if (usblp->protocol[1].alt_setting != -1)
1252 return 1;
1253 if (usblp->protocol[3].alt_setting != -1)
1254 return 3;
1255
1256 /* If nothing is available, then don't bind to this device. */
1257 return -1;
1258}
1259
1260static int usblp_set_protocol(struct usblp *usblp, int protocol)
1261{
1262 int r, alts;
1263
1264 if (protocol < USBLP_FIRST_PROTOCOL || protocol > USBLP_LAST_PROTOCOL)
1265 return -EINVAL;
1266
1267 alts = usblp->protocol[protocol].alt_setting;
1268 if (alts < 0)
1269 return -EINVAL;
1270 r = usb_set_interface(usblp->dev, usblp->ifnum, alts);
1271 if (r < 0) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001272 printk(KERN_ERR "usblp: can't set desired altsetting %d on interface %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001273 alts, usblp->ifnum);
1274 return r;
1275 }
1276
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277 usblp->bidir = (usblp->protocol[protocol].epread != NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278 usblp->current_protocol = protocol;
1279 dbg("usblp%d set protocol %d", usblp->minor, protocol);
1280 return 0;
1281}
1282
1283/* Retrieves and caches device ID string.
1284 * Returns length, including length bytes but not null terminator.
1285 * On error, returns a negative errno value. */
1286static int usblp_cache_device_id_string(struct usblp *usblp)
1287{
1288 int err, length;
1289
1290 err = usblp_get_id(usblp, 0, usblp->device_id_string, USBLP_DEVICE_ID_SIZE - 1);
1291 if (err < 0) {
1292 dbg("usblp%d: error = %d reading IEEE-1284 Device ID string",
1293 usblp->minor, err);
1294 usblp->device_id_string[0] = usblp->device_id_string[1] = '\0';
1295 return -EIO;
1296 }
1297
1298 /* First two bytes are length in big-endian.
1299 * They count themselves, and we copy them into
1300 * the user's buffer. */
1301 length = be16_to_cpu(*((__be16 *)usblp->device_id_string));
1302 if (length < 2)
1303 length = 2;
1304 else if (length >= USBLP_DEVICE_ID_SIZE)
1305 length = USBLP_DEVICE_ID_SIZE - 1;
1306 usblp->device_id_string[length] = '\0';
1307
1308 dbg("usblp%d Device ID string [len=%d]=\"%s\"",
1309 usblp->minor, length, &usblp->device_id_string[2]);
1310
1311 return length;
1312}
1313
1314static void usblp_disconnect(struct usb_interface *intf)
1315{
1316 struct usblp *usblp = usb_get_intfdata (intf);
1317
1318 usb_deregister_dev(intf, &usblp_class);
1319
1320 if (!usblp || !usblp->dev) {
1321 err("bogus disconnect");
1322 BUG ();
1323 }
1324
David Woodhousea9714c82005-12-23 16:41:41 +00001325 device_remove_file(&intf->dev, &dev_attr_ieee1284_id);
1326
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01001327 mutex_lock (&usblp_mutex);
Oliver Neukum8e422662006-12-03 09:46:35 +01001328 mutex_lock (&usblp->mut);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001329 usblp->present = 0;
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001330 wake_up(&usblp->wwait);
1331 wake_up(&usblp->rwait);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332 usb_set_intfdata (intf, NULL);
1333
1334 usblp_unlink_urbs(usblp);
Oliver Neukum8e422662006-12-03 09:46:35 +01001335 mutex_unlock (&usblp->mut);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336
1337 if (!usblp->used)
1338 usblp_cleanup (usblp);
Arjan van de Ven4186ecf2006-01-11 15:55:29 +01001339 mutex_unlock (&usblp_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001340}
1341
Oliver Neukum516077c2006-10-05 09:04:11 +02001342static int usblp_suspend (struct usb_interface *intf, pm_message_t message)
1343{
1344 struct usblp *usblp = usb_get_intfdata (intf);
1345
Oliver Neukum516077c2006-10-05 09:04:11 +02001346 /* we take no more IO */
1347 usblp->sleeping = 1;
Oliver Neukum516077c2006-10-05 09:04:11 +02001348 usblp_unlink_urbs(usblp);
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001349#if 0 /* XXX Do we want this? What if someone is reading, should we fail? */
1350 /* not strictly necessary, but just in case */
1351 wake_up(&usblp->wwait);
1352 wake_up(&usblp->rwait);
1353#endif
Oliver Neukum516077c2006-10-05 09:04:11 +02001354
1355 return 0;
1356}
1357
1358static int usblp_resume (struct usb_interface *intf)
1359{
1360 struct usblp *usblp = usb_get_intfdata (intf);
1361 int r;
1362
Oliver Neukum516077c2006-10-05 09:04:11 +02001363 usblp->sleeping = 0;
1364 r = handle_bidir (usblp);
1365
Oliver Neukum516077c2006-10-05 09:04:11 +02001366 return r;
1367}
1368
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369static struct usb_device_id usblp_ids [] = {
1370 { USB_DEVICE_INFO(7, 1, 1) },
1371 { USB_DEVICE_INFO(7, 1, 2) },
1372 { USB_DEVICE_INFO(7, 1, 3) },
1373 { USB_INTERFACE_INFO(7, 1, 1) },
1374 { USB_INTERFACE_INFO(7, 1, 2) },
1375 { USB_INTERFACE_INFO(7, 1, 3) },
Alan Stern5ec71db2007-03-16 15:53:07 -04001376 { USB_DEVICE(0x04b8, 0x0202) }, /* Seiko Epson Receipt Printer M129C */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377 { } /* Terminating entry */
1378};
1379
1380MODULE_DEVICE_TABLE (usb, usblp_ids);
1381
1382static struct usb_driver usblp_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383 .name = "usblp",
1384 .probe = usblp_probe,
1385 .disconnect = usblp_disconnect,
Oliver Neukum516077c2006-10-05 09:04:11 +02001386 .suspend = usblp_suspend,
1387 .resume = usblp_resume,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388 .id_table = usblp_ids,
Oliver Neukumd0532182007-01-18 15:06:07 +01001389 .supports_autosuspend = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390};
1391
1392static int __init usblp_init(void)
1393{
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001394 return usb_register(&usblp_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395}
1396
1397static void __exit usblp_exit(void)
1398{
1399 usb_deregister(&usblp_driver);
1400}
1401
1402module_init(usblp_init);
1403module_exit(usblp_exit);
1404
1405MODULE_AUTHOR( DRIVER_AUTHOR );
1406MODULE_DESCRIPTION( DRIVER_DESC );
1407module_param(proto_bias, int, S_IRUGO | S_IWUSR);
1408MODULE_PARM_DESC(proto_bias, "Favourite protocol number");
1409MODULE_LICENSE("GPL");