blob: 0924ee40a9661b74ed5e1d189a482984ac3a91ef [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>
Pavel Macheka2531292010-07-18 14:27:13 +02005 * Copyright (c) 1999 Pavel Machek <pavel@ucw.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);
Daniel Mack997ea582010-04-12 13:17:25 +020030 * use usb_alloc_coherent() for read buf & write buf;
Pete Zaitcev283face2007-08-13 22:54:29 -070031 * none - Maintained in Linux kernel after v0.13
Linus Torvalds1da177e2005-04-16 15:20:36 -070032 */
33
34/*
35 * This program is free software; you can redistribute it and/or modify
36 * it under the terms of the GNU General Public License as published by
37 * the Free Software Foundation; either version 2 of the License, or
38 * (at your option) any later version.
39 *
40 * This program is distributed in the hope that it will be useful,
41 * but WITHOUT ANY WARRANTY; without even the implied warranty of
42 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
43 * GNU General Public License for more details.
44 *
45 * You should have received a copy of the GNU General Public License
46 * along with this program; if not, write to the Free Software
47 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
48 */
49
50#include <linux/module.h>
51#include <linux/kernel.h>
52#include <linux/sched.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070053#include <linux/signal.h>
54#include <linux/poll.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070055#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>
Manuel Zerpies305e7be2011-06-16 14:15:54 +020060#include <linux/ratelimit.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
62/*
63 * Version Information
64 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070065#define DRIVER_AUTHOR "Michael Gee, Pavel Machek, Vojtech Pavlik, Randy Dunlap, Pete Zaitcev, David Paschal"
66#define DRIVER_DESC "USB Printer Device Class driver"
67
68#define USBLP_BUF_SIZE 8192
Pete Zaitcev317c67b2007-06-21 12:44:56 -070069#define USBLP_BUF_SIZE_IN 1024
Linus Torvalds1da177e2005-04-16 15:20:36 -070070#define USBLP_DEVICE_ID_SIZE 1024
71
72/* ioctls: */
Linus Torvalds1da177e2005-04-16 15:20:36 -070073#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
Pete Zaitcev283face2007-08-13 22:54:29 -0700118#define USBLP_CTL_TIMEOUT 5000 /* 5 seconds */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
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 {
Nicolas Kaiser916de022010-06-25 20:25:37 +0200138 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 */
Pete Zaitcev7f477352007-07-23 01:58:15 -0700162 unsigned int flags; /* mode flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 unsigned char used; /* True if open */
164 unsigned char present; /* True if not disconnected */
165 unsigned char bidir; /* interface is bidirectional */
Pete Zaitcev7f477352007-07-23 01:58:15 -0700166 unsigned char no_paper; /* Paper Out happened */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167 unsigned char *device_id_string; /* IEEE 1284 DEVICE ID string (ptr) */
168 /* first 2 bytes are (big-endian) length */
169};
170
171#ifdef DEBUG
Nicolas Kaiser916de022010-06-25 20:25:37 +0200172static void usblp_dump(struct usblp *usblp)
173{
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -0700174 struct device *dev = &usblp->intf->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175 int p;
176
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -0700177 dev_dbg(dev, "usblp=0x%p\n", usblp);
178 dev_dbg(dev, "dev=0x%p\n", usblp->dev);
179 dev_dbg(dev, "present=%d\n", usblp->present);
180 dev_dbg(dev, "readbuf=0x%p\n", usblp->readbuf);
181 dev_dbg(dev, "readcount=%d\n", usblp->readcount);
182 dev_dbg(dev, "ifnum=%d\n", usblp->ifnum);
183 for (p = USBLP_FIRST_PROTOCOL; p <= USBLP_LAST_PROTOCOL; p++) {
184 dev_dbg(dev, "protocol[%d].alt_setting=%d\n", p,
185 usblp->protocol[p].alt_setting);
186 dev_dbg(dev, "protocol[%d].epwrite=%p\n", p,
187 usblp->protocol[p].epwrite);
188 dev_dbg(dev, "protocol[%d].epread=%p\n", p,
189 usblp->protocol[p].epread);
190 }
191 dev_dbg(dev, "current_protocol=%d\n", usblp->current_protocol);
192 dev_dbg(dev, "minor=%d\n", usblp->minor);
193 dev_dbg(dev, "wstatus=%d\n", usblp->wstatus);
194 dev_dbg(dev, "rstatus=%d\n", usblp->rstatus);
195 dev_dbg(dev, "quirks=%d\n", usblp->quirks);
196 dev_dbg(dev, "used=%d\n", usblp->used);
197 dev_dbg(dev, "bidir=%d\n", usblp->bidir);
198 dev_dbg(dev, "device_id_string=\"%s\"\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 usblp->device_id_string ?
200 usblp->device_id_string + 2 :
201 (unsigned char *)"(null)");
202}
203#endif
204
205/* Quirks: various printer quirks are handled by this table & its flags. */
206
207struct quirk_printer_struct {
208 __u16 vendorId;
209 __u16 productId;
210 unsigned int quirks;
211};
212
213#define USBLP_QUIRK_BIDIR 0x1 /* reports bidir but requires unidirectional mode (no INs/reads) */
214#define USBLP_QUIRK_USB_INIT 0x2 /* needs vendor USB init string */
Alan Stern5ec71db2007-03-16 15:53:07 -0400215#define USBLP_QUIRK_BAD_CLASS 0x4 /* descriptor uses vendor-specific Class or SubClass */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216
Arjan van de Ven4c4c9432005-11-29 09:43:42 +0100217static const struct quirk_printer_struct quirk_printers[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 { 0x03f0, 0x0004, USBLP_QUIRK_BIDIR }, /* HP DeskJet 895C */
219 { 0x03f0, 0x0104, USBLP_QUIRK_BIDIR }, /* HP DeskJet 880C */
220 { 0x03f0, 0x0204, USBLP_QUIRK_BIDIR }, /* HP DeskJet 815C */
221 { 0x03f0, 0x0304, USBLP_QUIRK_BIDIR }, /* HP DeskJet 810C/812C */
222 { 0x03f0, 0x0404, USBLP_QUIRK_BIDIR }, /* HP DeskJet 830C */
223 { 0x03f0, 0x0504, USBLP_QUIRK_BIDIR }, /* HP DeskJet 885C */
Nicolas Kaiser916de022010-06-25 20:25:37 +0200224 { 0x03f0, 0x0604, USBLP_QUIRK_BIDIR }, /* HP DeskJet 840C */
225 { 0x03f0, 0x0804, USBLP_QUIRK_BIDIR }, /* HP DeskJet 816C */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226 { 0x03f0, 0x1104, USBLP_QUIRK_BIDIR }, /* HP Deskjet 959C */
227 { 0x0409, 0xefbe, USBLP_QUIRK_BIDIR }, /* NEC Picty900 (HP OEM) */
228 { 0x0409, 0xbef4, USBLP_QUIRK_BIDIR }, /* NEC Picty760 (HP OEM) */
229 { 0x0409, 0xf0be, USBLP_QUIRK_BIDIR }, /* NEC Picty920 (HP OEM) */
230 { 0x0409, 0xf1be, USBLP_QUIRK_BIDIR }, /* NEC Picty800 (HP OEM) */
Martin Williges4f45d0382006-12-28 20:52:10 +0100231 { 0x0482, 0x0010, USBLP_QUIRK_BIDIR }, /* Kyocera Mita FS 820, by zut <kernel@zut.de> */
Brandon Philips06a743b2009-01-05 08:30:39 -0800232 { 0x04f9, 0x000d, USBLP_QUIRK_BIDIR }, /* Brother Industries, Ltd HL-1440 Laser Printer */
Alan Stern5ec71db2007-03-16 15:53:07 -0400233 { 0x04b8, 0x0202, USBLP_QUIRK_BAD_CLASS }, /* Seiko Epson Receipt Printer M129C */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 { 0, 0 }
235};
236
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700237static int usblp_wwait(struct usblp *usblp, int nonblock);
238static int usblp_wtest(struct usblp *usblp, int nonblock);
239static int usblp_rwait_and_lock(struct usblp *usblp, int nonblock);
240static int usblp_rtest(struct usblp *usblp, int nonblock);
241static int usblp_submit_read(struct usblp *usblp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242static int usblp_select_alts(struct usblp *usblp);
243static int usblp_set_protocol(struct usblp *usblp, int protocol);
244static int usblp_cache_device_id_string(struct usblp *usblp);
245
246/* forward reference to make our lives easier */
247static struct usb_driver usblp_driver;
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100248static DEFINE_MUTEX(usblp_mutex); /* locks the existence of usblp's */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249
250/*
251 * Functions for usblp control messages.
252 */
253
254static int usblp_ctrl_msg(struct usblp *usblp, int request, int type, int dir, int recip, int value, void *buf, int len)
255{
256 int retval;
257 int index = usblp->ifnum;
258
259 /* High byte has the interface index.
260 Low byte has the alternate setting.
261 */
Nicolas Kaiser916de022010-06-25 20:25:37 +0200262 if ((request == USBLP_REQ_GET_ID) && (type == USB_TYPE_CLASS))
263 index = (usblp->ifnum<<8)|usblp->protocol[usblp->current_protocol].alt_setting;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264
265 retval = usb_control_msg(usblp->dev,
266 dir ? usb_rcvctrlpipe(usblp->dev, 0) : usb_sndctrlpipe(usblp->dev, 0),
Pete Zaitcev283face2007-08-13 22:54:29 -0700267 request, type | dir | recip, value, index, buf, len, USBLP_CTL_TIMEOUT);
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -0700268 dev_dbg(&usblp->intf->dev,
269 "usblp_control_msg: rq: 0x%02x dir: %d recip: %d value: %d idx: %d len: %#x result: %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270 request, !!dir, recip, value, index, len, retval);
271 return retval < 0 ? retval : 0;
272}
273
274#define usblp_read_status(usblp, status)\
275 usblp_ctrl_msg(usblp, USBLP_REQ_GET_STATUS, USB_TYPE_CLASS, USB_DIR_IN, USB_RECIP_INTERFACE, 0, status, 1)
276#define usblp_get_id(usblp, config, id, maxlen)\
277 usblp_ctrl_msg(usblp, USBLP_REQ_GET_ID, USB_TYPE_CLASS, USB_DIR_IN, USB_RECIP_INTERFACE, config, id, maxlen)
278#define usblp_reset(usblp)\
279 usblp_ctrl_msg(usblp, USBLP_REQ_RESET, USB_TYPE_CLASS, USB_DIR_OUT, USB_RECIP_OTHER, 0, NULL, 0)
280
281#define usblp_hp_channel_change_request(usblp, channel, buffer) \
282 usblp_ctrl_msg(usblp, USBLP_REQ_HP_CHANNEL_CHANGE_REQUEST, USB_TYPE_VENDOR, USB_DIR_IN, USB_RECIP_INTERFACE, channel, buffer, 1)
283
284/*
285 * See the description for usblp_select_alts() below for the usage
286 * explanation. Look into your /proc/bus/usb/devices and dmesg in
287 * case of any trouble.
288 */
289static int proto_bias = -1;
290
291/*
292 * URB callback.
293 */
294
David Howells7d12e782006-10-05 14:55:46 +0100295static void usblp_bulk_read(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296{
297 struct usblp *usblp = urb->context;
Greg Kroah-Hartman18ac3012007-07-18 10:58:02 -0700298 int status = urb->status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700300 if (usblp->present && usblp->used) {
Greg Kroah-Hartman18ac3012007-07-18 10:58:02 -0700301 if (status)
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700302 printk(KERN_WARNING "usblp%d: "
303 "nonzero read bulk status received: %d\n",
Greg Kroah-Hartman18ac3012007-07-18 10:58:02 -0700304 usblp->minor, status);
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700305 }
306 spin_lock(&usblp->lock);
Greg Kroah-Hartman18ac3012007-07-18 10:58:02 -0700307 if (status < 0)
308 usblp->rstatus = status;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700309 else
310 usblp->rstatus = urb->actual_length;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 usblp->rcomplete = 1;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700312 wake_up(&usblp->rwait);
313 spin_unlock(&usblp->lock);
314
315 usb_free_urb(urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316}
317
David Howells7d12e782006-10-05 14:55:46 +0100318static void usblp_bulk_write(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319{
320 struct usblp *usblp = urb->context;
Greg Kroah-Hartman18ac3012007-07-18 10:58:02 -0700321 int status = urb->status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700323 if (usblp->present && usblp->used) {
Greg Kroah-Hartman18ac3012007-07-18 10:58:02 -0700324 if (status)
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700325 printk(KERN_WARNING "usblp%d: "
326 "nonzero write bulk status received: %d\n",
Greg Kroah-Hartman18ac3012007-07-18 10:58:02 -0700327 usblp->minor, status);
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700328 }
329 spin_lock(&usblp->lock);
Greg Kroah-Hartman18ac3012007-07-18 10:58:02 -0700330 if (status < 0)
331 usblp->wstatus = status;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700332 else
333 usblp->wstatus = urb->actual_length;
Pete Zaitcev7f477352007-07-23 01:58:15 -0700334 usblp->no_paper = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 usblp->wcomplete = 1;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700336 wake_up(&usblp->wwait);
337 spin_unlock(&usblp->lock);
338
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700339 usb_free_urb(urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340}
341
342/*
343 * Get and print printer errors.
344 */
345
Arjan van de Ven4c4c9432005-11-29 09:43:42 +0100346static const char *usblp_messages[] = { "ok", "out of paper", "off-line", "on fire" };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347
348static int usblp_check_status(struct usblp *usblp, int err)
349{
350 unsigned char status, newerr = 0;
351 int error;
352
Pete Zaitcevfc401e62007-08-13 22:50:13 -0700353 mutex_lock(&usblp->mut);
354 if ((error = usblp_read_status(usblp, usblp->statusbuf)) < 0) {
355 mutex_unlock(&usblp->mut);
Manuel Zerpies305e7be2011-06-16 14:15:54 +0200356 printk_ratelimited(KERN_ERR
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700357 "usblp%d: error %d reading printer status\n",
Randy Dunlap0bc8e002005-07-31 20:41:19 -0700358 usblp->minor, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 return 0;
360 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361 status = *usblp->statusbuf;
Pete Zaitcevfc401e62007-08-13 22:50:13 -0700362 mutex_unlock(&usblp->mut);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363
364 if (~status & LP_PERRORP)
365 newerr = 3;
366 if (status & LP_POUTPA)
367 newerr = 1;
368 if (~status & LP_PSELECD)
369 newerr = 2;
370
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700371 if (newerr != err) {
372 printk(KERN_INFO "usblp%d: %s\n",
373 usblp->minor, usblp_messages[newerr]);
374 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375
376 return newerr;
377}
378
Nicolas Kaiser916de022010-06-25 20:25:37 +0200379static int handle_bidir(struct usblp *usblp)
Oliver Neukum516077c2006-10-05 09:04:11 +0200380{
Oliver Neukum3a90f812009-12-28 00:52:17 +0100381 if (usblp->bidir && usblp->used) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700382 if (usblp_submit_read(usblp) < 0)
Oliver Neukum516077c2006-10-05 09:04:11 +0200383 return -EIO;
Oliver Neukum516077c2006-10-05 09:04:11 +0200384 }
Oliver Neukum516077c2006-10-05 09:04:11 +0200385 return 0;
386}
387
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388/*
389 * File op functions.
390 */
391
392static int usblp_open(struct inode *inode, struct file *file)
393{
394 int minor = iminor(inode);
395 struct usblp *usblp;
396 struct usb_interface *intf;
397 int retval;
398
399 if (minor < 0)
400 return -ENODEV;
401
Nicolas Kaiser916de022010-06-25 20:25:37 +0200402 mutex_lock(&usblp_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403
404 retval = -ENODEV;
405 intf = usb_find_interface(&usblp_driver, minor);
Nicolas Kaiser916de022010-06-25 20:25:37 +0200406 if (!intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 goto out;
Nicolas Kaiser916de022010-06-25 20:25:37 +0200408 usblp = usb_get_intfdata(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 if (!usblp || !usblp->dev || !usblp->present)
410 goto out;
411
412 retval = -EBUSY;
413 if (usblp->used)
414 goto out;
415
416 /*
Pete Zaitcev7f477352007-07-23 01:58:15 -0700417 * We do not implement LP_ABORTOPEN/LPABORTOPEN for two reasons:
418 * - We do not want persistent state which close(2) does not clear
419 * - It is not used anyway, according to CUPS people
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421
Oliver Neukumd0532182007-01-18 15:06:07 +0100422 retval = usb_autopm_get_interface(intf);
423 if (retval < 0)
424 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 usblp->used = 1;
426 file->private_data = usblp;
427
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 usblp->wcomplete = 1; /* we begin writeable */
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700429 usblp->wstatus = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 usblp->rcomplete = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431
Oliver Neukum516077c2006-10-05 09:04:11 +0200432 if (handle_bidir(usblp) < 0) {
Oliver Neukum19028692008-02-12 19:08:30 +0100433 usb_autopm_put_interface(intf);
Pete Zaitcev97cb95d2007-05-24 21:59:19 -0700434 usblp->used = 0;
Oliver Neukum516077c2006-10-05 09:04:11 +0200435 file->private_data = NULL;
436 retval = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 }
438out:
Nicolas Kaiser916de022010-06-25 20:25:37 +0200439 mutex_unlock(&usblp_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 return retval;
441}
442
Nicolas Kaiser916de022010-06-25 20:25:37 +0200443static void usblp_cleanup(struct usblp *usblp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444{
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700445 printk(KERN_INFO "usblp%d: removed\n", usblp->minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700447 kfree(usblp->readbuf);
Nicolas Kaiser916de022010-06-25 20:25:37 +0200448 kfree(usblp->device_id_string);
449 kfree(usblp->statusbuf);
450 kfree(usblp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451}
452
453static void usblp_unlink_urbs(struct usblp *usblp)
454{
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700455 usb_kill_anchored_urbs(&usblp->urbs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456}
457
458static int usblp_release(struct inode *inode, struct file *file)
459{
460 struct usblp *usblp = file->private_data;
461
Pete Zaitcev7f477352007-07-23 01:58:15 -0700462 usblp->flags &= ~LP_ABORT;
463
Nicolas Kaiser916de022010-06-25 20:25:37 +0200464 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);
Nicolas Kaiser916de022010-06-25 20:25:37 +0200469 } else /* finish cleanup from disconnect */
470 usblp_cleanup(usblp);
471 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);
Pete Zaitcev283face2007-08-13 22:54:29 -0700486 ret = ((usblp->bidir && usblp->rcomplete) ? POLLIN | POLLRDNORM : 0) |
487 ((usblp->no_paper || usblp->wcomplete) ? POLLOUT | POLLWRNORM : 0);
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
Nicolas Kaiser916de022010-06-25 20:25:37 +0200501 mutex_lock(&usblp->mut);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502 if (!usblp->present) {
503 retval = -ENODEV;
504 goto done;
505 }
506
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -0700507 dev_dbg(&usblp->intf->dev,
508 "usblp_ioctl: cmd=0x%x (%c nr=%d len=%d dir=%d)\n", cmd,
509 _IOC_TYPE(cmd), _IOC_NR(cmd), _IOC_SIZE(cmd), _IOC_DIR(cmd));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510
511 if (_IOC_TYPE(cmd) == 'P') /* new-style ioctl number */
512
513 switch (_IOC_NR(cmd)) {
514
Nicolas Kaiser916de022010-06-25 20:25:37 +0200515 case IOCNR_GET_DEVICE_ID: /* get the DEVICE_ID string */
516 if (_IOC_DIR(cmd) != _IOC_READ) {
517 retval = -EINVAL;
518 goto done;
519 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520
Nicolas Kaiser916de022010-06-25 20:25:37 +0200521 length = usblp_cache_device_id_string(usblp);
522 if (length < 0) {
523 retval = length;
524 goto done;
525 }
526 if (length > _IOC_SIZE(cmd))
527 length = _IOC_SIZE(cmd); /* truncate */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528
Nicolas Kaiser916de022010-06-25 20:25:37 +0200529 if (copy_to_user((void __user *) arg,
530 usblp->device_id_string,
531 (unsigned long) length)) {
532 retval = -EFAULT;
533 goto done;
534 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535
Nicolas Kaiser916de022010-06-25 20:25:37 +0200536 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537
Nicolas Kaiser916de022010-06-25 20:25:37 +0200538 case IOCNR_GET_PROTOCOLS:
539 if (_IOC_DIR(cmd) != _IOC_READ ||
540 _IOC_SIZE(cmd) < sizeof(twoints)) {
541 retval = -EINVAL;
542 goto done;
543 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544
Nicolas Kaiser916de022010-06-25 20:25:37 +0200545 twoints[0] = usblp->current_protocol;
546 twoints[1] = 0;
547 for (i = USBLP_FIRST_PROTOCOL;
548 i <= USBLP_LAST_PROTOCOL; i++) {
549 if (usblp->protocol[i].alt_setting >= 0)
550 twoints[1] |= (1<<i);
551 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552
Nicolas Kaiser916de022010-06-25 20:25:37 +0200553 if (copy_to_user((void __user *)arg,
554 (unsigned char *)twoints,
555 sizeof(twoints))) {
556 retval = -EFAULT;
557 goto done;
558 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559
Nicolas Kaiser916de022010-06-25 20:25:37 +0200560 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561
Nicolas Kaiser916de022010-06-25 20:25:37 +0200562 case IOCNR_SET_PROTOCOL:
563 if (_IOC_DIR(cmd) != _IOC_WRITE) {
564 retval = -EINVAL;
565 goto done;
566 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567
568#ifdef DEBUG
Nicolas Kaiser916de022010-06-25 20:25:37 +0200569 if (arg == -10) {
570 usblp_dump(usblp);
571 break;
572 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573#endif
574
Nicolas Kaiser916de022010-06-25 20:25:37 +0200575 usblp_unlink_urbs(usblp);
576 retval = usblp_set_protocol(usblp, arg);
577 if (retval < 0) {
578 usblp_set_protocol(usblp,
579 usblp->current_protocol);
580 }
581 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582
Nicolas Kaiser916de022010-06-25 20:25:37 +0200583 case IOCNR_HP_SET_CHANNEL:
584 if (_IOC_DIR(cmd) != _IOC_WRITE ||
585 le16_to_cpu(usblp->dev->descriptor.idVendor) != 0x03F0 ||
586 usblp->quirks & USBLP_QUIRK_BIDIR) {
587 retval = -EINVAL;
588 goto done;
589 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590
Nicolas Kaiser916de022010-06-25 20:25:37 +0200591 err = usblp_hp_channel_change_request(usblp,
592 arg, &newChannel);
593 if (err < 0) {
594 dev_err(&usblp->dev->dev,
595 "usblp%d: error = %d setting "
596 "HP channel\n",
597 usblp->minor, err);
598 retval = -EIO;
599 goto done;
600 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -0700602 dev_dbg(&usblp->intf->dev,
603 "usblp%d requested/got HP channel %ld/%d\n",
Nicolas Kaiser916de022010-06-25 20:25:37 +0200604 usblp->minor, arg, newChannel);
605 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606
Nicolas Kaiser916de022010-06-25 20:25:37 +0200607 case IOCNR_GET_BUS_ADDRESS:
608 if (_IOC_DIR(cmd) != _IOC_READ ||
609 _IOC_SIZE(cmd) < sizeof(twoints)) {
610 retval = -EINVAL;
611 goto done;
612 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613
Nicolas Kaiser916de022010-06-25 20:25:37 +0200614 twoints[0] = usblp->dev->bus->busnum;
615 twoints[1] = usblp->dev->devnum;
616 if (copy_to_user((void __user *)arg,
617 (unsigned char *)twoints,
618 sizeof(twoints))) {
619 retval = -EFAULT;
620 goto done;
621 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -0700623 dev_dbg(&usblp->intf->dev,
624 "usblp%d is bus=%d, device=%d\n",
Nicolas Kaiser916de022010-06-25 20:25:37 +0200625 usblp->minor, twoints[0], twoints[1]);
626 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700627
Nicolas Kaiser916de022010-06-25 20:25:37 +0200628 case IOCNR_GET_VID_PID:
629 if (_IOC_DIR(cmd) != _IOC_READ ||
630 _IOC_SIZE(cmd) < sizeof(twoints)) {
631 retval = -EINVAL;
632 goto done;
633 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634
Nicolas Kaiser916de022010-06-25 20:25:37 +0200635 twoints[0] = le16_to_cpu(usblp->dev->descriptor.idVendor);
636 twoints[1] = le16_to_cpu(usblp->dev->descriptor.idProduct);
637 if (copy_to_user((void __user *)arg,
638 (unsigned char *)twoints,
639 sizeof(twoints))) {
640 retval = -EFAULT;
641 goto done;
642 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -0700644 dev_dbg(&usblp->intf->dev,
645 "usblp%d is VID=0x%4.4X, PID=0x%4.4X\n",
Nicolas Kaiser916de022010-06-25 20:25:37 +0200646 usblp->minor, twoints[0], twoints[1]);
647 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648
Nicolas Kaiser916de022010-06-25 20:25:37 +0200649 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;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 }
659 else /* old-style ioctl value */
660 switch (cmd) {
661
Nicolas Kaiser916de022010-06-25 20:25:37 +0200662 case LPGETSTATUS:
663 if ((retval = usblp_read_status(usblp, usblp->statusbuf))) {
Manuel Zerpies305e7be2011-06-16 14:15:54 +0200664 printk_ratelimited(KERN_ERR "usblp%d:"
Nicolas Kaiser916de022010-06-25 20:25:37 +0200665 "failed reading printer status (%d)\n",
666 usblp->minor, retval);
667 retval = -EIO;
668 goto done;
669 }
670 status = *usblp->statusbuf;
671 if (copy_to_user((void __user *)arg, &status, sizeof(int)))
672 retval = -EFAULT;
673 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674
Nicolas Kaiser916de022010-06-25 20:25:37 +0200675 case LPABORT:
676 if (arg)
677 usblp->flags |= LP_ABORT;
678 else
679 usblp->flags &= ~LP_ABORT;
680 break;
Pete Zaitcev7f477352007-07-23 01:58:15 -0700681
Nicolas Kaiser916de022010-06-25 20:25:37 +0200682 default:
683 retval = -ENOTTY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 }
685
686done:
Nicolas Kaiser916de022010-06-25 20:25:37 +0200687 mutex_unlock(&usblp->mut);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700688 return retval;
689}
690
Pete Zaitcev42cb9672007-08-14 13:19:16 -0700691static struct urb *usblp_new_writeurb(struct usblp *usblp, int transfer_length)
692{
693 struct urb *urb;
694 char *writebuf;
695
696 if ((writebuf = kmalloc(transfer_length, GFP_KERNEL)) == NULL)
697 return NULL;
698 if ((urb = usb_alloc_urb(0, GFP_KERNEL)) == NULL) {
699 kfree(writebuf);
700 return NULL;
701 }
702
703 usb_fill_bulk_urb(urb, usblp->dev,
704 usb_sndbulkpipe(usblp->dev,
705 usblp->protocol[usblp->current_protocol].epwrite->bEndpointAddress),
706 writebuf, transfer_length, usblp_bulk_write, usblp);
707 urb->transfer_flags |= URB_FREE_BUFFER;
708
709 return urb;
710}
711
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712static ssize_t usblp_write(struct file *file, const char __user *buffer, size_t count, loff_t *ppos)
713{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714 struct usblp *usblp = file->private_data;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700715 struct urb *writeurb;
716 int rv;
717 int transfer_length;
718 ssize_t writecount = 0;
719
720 if (mutex_lock_interruptible(&usblp->wmut)) {
721 rv = -EINTR;
722 goto raise_biglock;
723 }
724 if ((rv = usblp_wwait(usblp, !!(file->f_flags & O_NONBLOCK))) < 0)
725 goto raise_wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726
727 while (writecount < count) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700728 /*
729 * Step 1: Submit next block.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 */
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700731 if ((transfer_length = count - writecount) > USBLP_BUF_SIZE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 transfer_length = USBLP_BUF_SIZE;
733
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700734 rv = -ENOMEM;
Pete Zaitcev42cb9672007-08-14 13:19:16 -0700735 if ((writeurb = usblp_new_writeurb(usblp, transfer_length)) == NULL)
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700736 goto raise_urb;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700737 usb_anchor_urb(writeurb, &usblp->urbs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738
Pete Zaitcev42cb9672007-08-14 13:19:16 -0700739 if (copy_from_user(writeurb->transfer_buffer,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 buffer + writecount, transfer_length)) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700741 rv = -EFAULT;
742 goto raise_badaddr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 }
744
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700745 spin_lock_irq(&usblp->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 usblp->wcomplete = 0;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700747 spin_unlock_irq(&usblp->lock);
748 if ((rv = usb_submit_urb(writeurb, GFP_KERNEL)) < 0) {
749 usblp->wstatus = 0;
750 spin_lock_irq(&usblp->lock);
Pete Zaitcev7f477352007-07-23 01:58:15 -0700751 usblp->no_paper = 0;
Oliver Neukum6c8df792006-10-28 11:36:59 +0200752 usblp->wcomplete = 1;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700753 wake_up(&usblp->wwait);
754 spin_unlock_irq(&usblp->lock);
755 if (rv != -ENOMEM)
756 rv = -EIO;
757 goto raise_submit;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 }
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700759
760 /*
761 * Step 2: Wait for transfer to end, collect results.
762 */
763 rv = usblp_wwait(usblp, !!(file->f_flags&O_NONBLOCK));
764 if (rv < 0) {
Pete Zaitcev10e48522007-07-10 20:09:58 -0700765 if (rv == -EAGAIN) {
766 /* Presume that it's going to complete well. */
767 writecount += transfer_length;
768 }
Pete Zaitcev7f477352007-07-23 01:58:15 -0700769 if (rv == -ENOSPC) {
770 spin_lock_irq(&usblp->lock);
771 usblp->no_paper = 1; /* Mark for poll(2) */
772 spin_unlock_irq(&usblp->lock);
773 writecount += transfer_length;
774 }
Pete Zaitcev10e48522007-07-10 20:09:58 -0700775 /* Leave URB dangling, to be cleaned on close. */
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700776 goto collect_error;
777 }
778
779 if (usblp->wstatus < 0) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700780 rv = -EIO;
781 goto collect_error;
782 }
783 /*
784 * This is critical: it must be our URB, not other writer's.
785 * The wmut exists mainly to cover us here.
786 */
787 writecount += usblp->wstatus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 }
789
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700790 mutex_unlock(&usblp->wmut);
791 return writecount;
792
793raise_submit:
794raise_badaddr:
795 usb_unanchor_urb(writeurb);
796 usb_free_urb(writeurb);
797raise_urb:
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700798raise_wait:
799collect_error: /* Out of raise sequence */
800 mutex_unlock(&usblp->wmut);
801raise_biglock:
802 return writecount ? writecount : rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803}
804
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700805/*
806 * Notice that we fail to restart in a few cases: on EFAULT, on restart
807 * error, etc. This is the historical behaviour. In all such cases we return
808 * EIO, and applications loop in order to get the new read going.
809 */
810static ssize_t usblp_read(struct file *file, char __user *buffer, size_t len, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811{
812 struct usblp *usblp = file->private_data;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700813 ssize_t count;
814 ssize_t avail;
815 int rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816
817 if (!usblp->bidir)
818 return -EINVAL;
819
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700820 rv = usblp_rwait_and_lock(usblp, !!(file->f_flags & O_NONBLOCK));
821 if (rv < 0)
822 return rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700824 if ((avail = usblp->rstatus) < 0) {
825 printk(KERN_ERR "usblp%d: error %d reading from printer\n",
826 usblp->minor, (int)avail);
827 usblp_submit_read(usblp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 count = -EIO;
829 goto done;
830 }
831
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700832 count = len < avail - usblp->readcount ? len : avail - usblp->readcount;
833 if (count != 0 &&
834 copy_to_user(buffer, usblp->readbuf + usblp->readcount, count)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 count = -EFAULT;
836 goto done;
837 }
838
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700839 if ((usblp->readcount += count) == avail) {
840 if (usblp_submit_read(usblp) < 0) {
841 /* We don't want to leak USB return codes into errno. */
842 if (count == 0)
843 count = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844 goto done;
845 }
846 }
847
848done:
Nicolas Kaiser916de022010-06-25 20:25:37 +0200849 mutex_unlock(&usblp->mut);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 return count;
851}
852
853/*
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700854 * Wait for the write path to come idle.
855 * This is called under the ->wmut, so the idle path stays idle.
856 *
857 * Our write path has a peculiar property: it does not buffer like a tty,
858 * but waits for the write to succeed. This allows our ->release to bug out
859 * without waiting for writes to drain. But it obviously does not work
860 * when O_NONBLOCK is set. So, applications setting O_NONBLOCK must use
861 * select(2) or poll(2) to wait for the buffer to drain before closing.
862 * Alternatively, set blocking mode with fcntl and issue a zero-size write.
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700863 */
864static int usblp_wwait(struct usblp *usblp, int nonblock)
865{
866 DECLARE_WAITQUEUE(waita, current);
867 int rc;
Pete Zaitcev7f477352007-07-23 01:58:15 -0700868 int err = 0;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700869
870 add_wait_queue(&usblp->wwait, &waita);
871 for (;;) {
Pete Zaitcev7f477352007-07-23 01:58:15 -0700872 set_current_state(TASK_INTERRUPTIBLE);
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700873 if (mutex_lock_interruptible(&usblp->mut)) {
874 rc = -EINTR;
875 break;
876 }
Pete Zaitcev7f477352007-07-23 01:58:15 -0700877 rc = usblp_wtest(usblp, nonblock);
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700878 mutex_unlock(&usblp->mut);
Pete Zaitcev7f477352007-07-23 01:58:15 -0700879 if (rc <= 0)
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700880 break;
Pete Zaitcev7f477352007-07-23 01:58:15 -0700881
Pete Zaitcevdd44be62009-01-06 17:20:42 -0700882 if (schedule_timeout(msecs_to_jiffies(1500)) == 0) {
883 if (usblp->flags & LP_ABORT) {
Pete Zaitcev7f477352007-07-23 01:58:15 -0700884 err = usblp_check_status(usblp, err);
885 if (err == 1) { /* Paper out */
886 rc = -ENOSPC;
887 break;
888 }
Pete Zaitcevdd44be62009-01-06 17:20:42 -0700889 } else {
890 /* Prod the printer, Gentoo#251237. */
891 mutex_lock(&usblp->mut);
892 usblp_read_status(usblp, usblp->statusbuf);
893 mutex_unlock(&usblp->mut);
Pete Zaitcev7f477352007-07-23 01:58:15 -0700894 }
Pete Zaitcev7f477352007-07-23 01:58:15 -0700895 }
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700896 }
897 set_current_state(TASK_RUNNING);
898 remove_wait_queue(&usblp->wwait, &waita);
899 return rc;
900}
901
902static int usblp_wtest(struct usblp *usblp, int nonblock)
903{
904 unsigned long flags;
905
906 if (!usblp->present)
907 return -ENODEV;
908 if (signal_pending(current))
909 return -EINTR;
910 spin_lock_irqsave(&usblp->lock, flags);
911 if (usblp->wcomplete) {
912 spin_unlock_irqrestore(&usblp->lock, flags);
913 return 0;
914 }
915 spin_unlock_irqrestore(&usblp->lock, flags);
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700916 if (nonblock)
917 return -EAGAIN;
918 return 1;
919}
920
921/*
922 * Wait for read bytes to become available. This probably should have been
923 * called usblp_r_lock_and_wait(), because we lock first. But it's a traditional
924 * name for functions which lock and return.
925 *
926 * We do not use wait_event_interruptible because it makes locking iffy.
927 */
928static int usblp_rwait_and_lock(struct usblp *usblp, int nonblock)
929{
930 DECLARE_WAITQUEUE(waita, current);
931 int rc;
932
933 add_wait_queue(&usblp->rwait, &waita);
934 for (;;) {
935 if (mutex_lock_interruptible(&usblp->mut)) {
936 rc = -EINTR;
937 break;
938 }
939 set_current_state(TASK_INTERRUPTIBLE);
940 if ((rc = usblp_rtest(usblp, nonblock)) < 0) {
941 mutex_unlock(&usblp->mut);
942 break;
943 }
944 if (rc == 0) /* Keep it locked */
945 break;
946 mutex_unlock(&usblp->mut);
947 schedule();
948 }
949 set_current_state(TASK_RUNNING);
950 remove_wait_queue(&usblp->rwait, &waita);
951 return rc;
952}
953
954static int usblp_rtest(struct usblp *usblp, int nonblock)
955{
956 unsigned long flags;
957
958 if (!usblp->present)
959 return -ENODEV;
960 if (signal_pending(current))
961 return -EINTR;
962 spin_lock_irqsave(&usblp->lock, flags);
963 if (usblp->rcomplete) {
964 spin_unlock_irqrestore(&usblp->lock, flags);
965 return 0;
966 }
967 spin_unlock_irqrestore(&usblp->lock, flags);
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700968 if (nonblock)
969 return -EAGAIN;
970 return 1;
971}
972
973/*
974 * Please check ->bidir and other such things outside for now.
975 */
976static int usblp_submit_read(struct usblp *usblp)
977{
978 struct urb *urb;
979 unsigned long flags;
980 int rc;
981
982 rc = -ENOMEM;
983 if ((urb = usb_alloc_urb(0, GFP_KERNEL)) == NULL)
984 goto raise_urb;
985
986 usb_fill_bulk_urb(urb, usblp->dev,
987 usb_rcvbulkpipe(usblp->dev,
988 usblp->protocol[usblp->current_protocol].epread->bEndpointAddress),
989 usblp->readbuf, USBLP_BUF_SIZE_IN,
990 usblp_bulk_read, usblp);
991 usb_anchor_urb(urb, &usblp->urbs);
992
993 spin_lock_irqsave(&usblp->lock, flags);
994 usblp->readcount = 0; /* XXX Why here? */
995 usblp->rcomplete = 0;
996 spin_unlock_irqrestore(&usblp->lock, flags);
997 if ((rc = usb_submit_urb(urb, GFP_KERNEL)) < 0) {
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -0700998 dev_dbg(&usblp->intf->dev, "error submitting urb (%d)\n", rc);
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700999 spin_lock_irqsave(&usblp->lock, flags);
1000 usblp->rstatus = rc;
1001 usblp->rcomplete = 1;
1002 spin_unlock_irqrestore(&usblp->lock, flags);
1003 goto raise_submit;
1004 }
1005
1006 return 0;
1007
1008raise_submit:
1009 usb_unanchor_urb(urb);
1010 usb_free_urb(urb);
1011raise_urb:
1012 return rc;
1013}
1014
1015/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016 * Checks for printers that have quirks, such as requiring unidirectional
1017 * communication but reporting bidirectional; currently some HP printers
1018 * have this flaw (HP 810, 880, 895, etc.), or needing an init string
1019 * sent at each open (like some Epsons).
1020 * Returns 1 if found, 0 if not found.
1021 *
1022 * HP recommended that we use the bidirectional interface but
1023 * don't attempt any bulk IN transfers from the IN endpoint.
1024 * Here's some more detail on the problem:
1025 * The problem is not that it isn't bidirectional though. The problem
1026 * is that if you request a device ID, or status information, while
1027 * the buffers are full, the return data will end up in the print data
1028 * buffer. For example if you make sure you never request the device ID
1029 * while you are sending print data, and you don't try to query the
1030 * printer status every couple of milliseconds, you will probably be OK.
1031 */
Nicolas Kaiser916de022010-06-25 20:25:37 +02001032static unsigned int usblp_quirks(__u16 vendor, __u16 product)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033{
1034 int i;
1035
1036 for (i = 0; quirk_printers[i].vendorId; i++) {
1037 if (vendor == quirk_printers[i].vendorId &&
1038 product == quirk_printers[i].productId)
1039 return quirk_printers[i].quirks;
Nicolas Kaiser916de022010-06-25 20:25:37 +02001040 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001041 return 0;
1042}
1043
Luiz Fernando N. Capitulino066202d2006-08-05 20:37:11 -03001044static const struct file_operations usblp_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045 .owner = THIS_MODULE,
1046 .read = usblp_read,
1047 .write = usblp_write,
1048 .poll = usblp_poll,
Pete Zaitcev318e4792005-12-21 17:03:24 -08001049 .unlocked_ioctl = usblp_ioctl,
1050 .compat_ioctl = usblp_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001051 .open = usblp_open,
1052 .release = usblp_release,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001053 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054};
1055
Al Viro2c9ede52011-07-23 20:24:48 -04001056static char *usblp_devnode(struct device *dev, umode_t *mode)
Kay Sieversf7a386c2009-04-30 15:23:42 +02001057{
1058 return kasprintf(GFP_KERNEL, "usb/%s", dev_name(dev));
1059}
1060
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061static struct usb_class_driver usblp_class = {
Greg Kroah-Hartmand6e5bcf2005-06-20 21:15:16 -07001062 .name = "lp%d",
Kay Sieverse454cea2009-09-18 23:01:12 +02001063 .devnode = usblp_devnode,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064 .fops = &usblp_fops,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065 .minor_base = USBLP_MINOR_BASE,
1066};
1067
David Woodhousea9714c82005-12-23 16:41:41 +00001068static ssize_t usblp_show_ieee1284_id(struct device *dev, struct device_attribute *attr, char *buf)
1069{
1070 struct usb_interface *intf = to_usb_interface(dev);
Nicolas Kaiser916de022010-06-25 20:25:37 +02001071 struct usblp *usblp = usb_get_intfdata(intf);
David Woodhousea9714c82005-12-23 16:41:41 +00001072
1073 if (usblp->device_id_string[0] == 0 &&
1074 usblp->device_id_string[1] == 0)
1075 return 0;
1076
1077 return sprintf(buf, "%s", usblp->device_id_string+2);
1078}
1079
1080static DEVICE_ATTR(ieee1284_id, S_IRUGO, usblp_show_ieee1284_id, NULL);
1081
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082static int usblp_probe(struct usb_interface *intf,
1083 const struct usb_device_id *id)
1084{
Nicolas Kaiser916de022010-06-25 20:25:37 +02001085 struct usb_device *dev = interface_to_usbdev(intf);
Julia Lawall49b707b2008-07-16 18:00:42 +02001086 struct usblp *usblp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001087 int protocol;
1088 int retval;
1089
1090 /* Malloc and start initializing usblp structure so we can use it
1091 * directly. */
Julia Lawall49b707b2008-07-16 18:00:42 +02001092 usblp = kzalloc(sizeof(struct usblp), GFP_KERNEL);
1093 if (!usblp) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001094 retval = -ENOMEM;
Julia Lawall49b707b2008-07-16 18:00:42 +02001095 goto abort_ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 usblp->dev = dev;
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001098 mutex_init(&usblp->wmut);
Nicolas Kaiser916de022010-06-25 20:25:37 +02001099 mutex_init(&usblp->mut);
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001100 spin_lock_init(&usblp->lock);
1101 init_waitqueue_head(&usblp->rwait);
1102 init_waitqueue_head(&usblp->wwait);
1103 init_usb_anchor(&usblp->urbs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001104 usblp->ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
1105 usblp->intf = intf;
1106
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107 /* Malloc device ID string buffer to the largest expected length,
1108 * since we can re-query it on an ioctl and a dynamic string
1109 * could change in length. */
1110 if (!(usblp->device_id_string = kmalloc(USBLP_DEVICE_ID_SIZE, GFP_KERNEL))) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001111 retval = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112 goto abort;
1113 }
1114
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001115 /*
1116 * Allocate read buffer. We somewhat wastefully
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117 * malloc both regardless of bidirectionality, because the
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001118 * alternate setting can be changed later via an ioctl.
1119 */
1120 if (!(usblp->readbuf = kmalloc(USBLP_BUF_SIZE_IN, GFP_KERNEL))) {
1121 retval = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001122 goto abort;
1123 }
1124
1125 /* Allocate buffer for printer status */
1126 usblp->statusbuf = kmalloc(STATUS_BUF_SIZE, GFP_KERNEL);
1127 if (!usblp->statusbuf) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001128 retval = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001129 goto abort;
1130 }
1131
1132 /* Lookup quirks for this printer. */
1133 usblp->quirks = usblp_quirks(
1134 le16_to_cpu(dev->descriptor.idVendor),
1135 le16_to_cpu(dev->descriptor.idProduct));
1136
1137 /* Analyze and pick initial alternate settings and endpoints. */
1138 protocol = usblp_select_alts(usblp);
1139 if (protocol < 0) {
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -07001140 dev_dbg(&intf->dev,
1141 "incompatible printer-class device 0x%4.4X/0x%4.4X\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142 le16_to_cpu(dev->descriptor.idVendor),
1143 le16_to_cpu(dev->descriptor.idProduct));
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001144 retval = -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145 goto abort;
1146 }
1147
1148 /* Setup the selected alternate setting and endpoints. */
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001149 if (usblp_set_protocol(usblp, protocol) < 0) {
1150 retval = -ENODEV; /* ->probe isn't ->ioctl */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151 goto abort;
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001152 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001153
1154 /* Retrieve and store the device ID string. */
1155 usblp_cache_device_id_string(usblp);
Greg Kroah-Hartman96cede52006-08-28 11:43:25 -07001156 retval = device_create_file(&intf->dev, &dev_attr_ieee1284_id);
1157 if (retval)
1158 goto abort_intfdata;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159
1160#ifdef DEBUG
1161 usblp_check_status(usblp, 0);
1162#endif
1163
Nicolas Kaiser916de022010-06-25 20:25:37 +02001164 usb_set_intfdata(intf, usblp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165
1166 usblp->present = 1;
1167
1168 retval = usb_register_dev(intf, &usblp_class);
1169 if (retval) {
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -07001170 dev_err(&intf->dev,
1171 "usblp: Not able to get a minor (base %u, slice default): %d\n",
1172 USBLP_MINOR_BASE, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173 goto abort_intfdata;
1174 }
1175 usblp->minor = intf->minor;
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -07001176 dev_info(&intf->dev,
1177 "usblp%d: USB %sdirectional printer dev %d if %d alt %d proto %d vid 0x%4.4X pid 0x%4.4X\n",
David Woodhousea9714c82005-12-23 16:41:41 +00001178 usblp->minor, usblp->bidir ? "Bi" : "Uni", dev->devnum,
1179 usblp->ifnum,
1180 usblp->protocol[usblp->current_protocol].alt_setting,
1181 usblp->current_protocol,
1182 le16_to_cpu(usblp->dev->descriptor.idVendor),
1183 le16_to_cpu(usblp->dev->descriptor.idProduct));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184
1185 return 0;
1186
1187abort_intfdata:
Nicolas Kaiser916de022010-06-25 20:25:37 +02001188 usb_set_intfdata(intf, NULL);
David Woodhousea9714c82005-12-23 16:41:41 +00001189 device_remove_file(&intf->dev, &dev_attr_ieee1284_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001190abort:
Julia Lawall49b707b2008-07-16 18:00:42 +02001191 kfree(usblp->readbuf);
1192 kfree(usblp->statusbuf);
1193 kfree(usblp->device_id_string);
1194 kfree(usblp);
1195abort_ret:
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001196 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197}
1198
1199/*
1200 * We are a "new" style driver with usb_device_id table,
1201 * but our requirements are too intricate for simple match to handle.
1202 *
1203 * The "proto_bias" option may be used to specify the preferred protocol
1204 * for all USB printers (1=7/1/1, 2=7/1/2, 3=7/1/3). If the device
1205 * supports the preferred protocol, then we bind to it.
1206 *
1207 * The best interface for us is 7/1/2, because it is compatible
1208 * with a stream of characters. If we find it, we bind to it.
1209 *
1210 * Note that the people from hpoj.sourceforge.net need to be able to
1211 * bind to 7/1/3 (MLC/1284.4), so we provide them ioctls for this purpose.
1212 *
1213 * Failing 7/1/2, we look for 7/1/3, even though it's probably not
1214 * stream-compatible, because this matches the behaviour of the old code.
1215 *
1216 * If nothing else, we bind to 7/1/1 - the unidirectional interface.
1217 */
1218static int usblp_select_alts(struct usblp *usblp)
1219{
1220 struct usb_interface *if_alt;
1221 struct usb_host_interface *ifd;
1222 struct usb_endpoint_descriptor *epd, *epwrite, *epread;
1223 int p, i, e;
1224
1225 if_alt = usblp->intf;
1226
1227 for (p = 0; p < USBLP_MAX_PROTOCOLS; p++)
1228 usblp->protocol[p].alt_setting = -1;
1229
1230 /* Find out what we have. */
1231 for (i = 0; i < if_alt->num_altsetting; i++) {
1232 ifd = &if_alt->altsetting[i];
1233
1234 if (ifd->desc.bInterfaceClass != 7 || ifd->desc.bInterfaceSubClass != 1)
Alan Stern5ec71db2007-03-16 15:53:07 -04001235 if (!(usblp->quirks & USBLP_QUIRK_BAD_CLASS))
1236 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237
1238 if (ifd->desc.bInterfaceProtocol < USBLP_FIRST_PROTOCOL ||
1239 ifd->desc.bInterfaceProtocol > USBLP_LAST_PROTOCOL)
1240 continue;
1241
1242 /* Look for bulk OUT and IN endpoints. */
1243 epwrite = epread = NULL;
1244 for (e = 0; e < ifd->desc.bNumEndpoints; e++) {
1245 epd = &ifd->endpoint[e].desc;
1246
Luiz Fernando N. Capitulino5bc66d52006-09-27 11:58:53 -07001247 if (usb_endpoint_is_bulk_out(epd))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001248 if (!epwrite)
1249 epwrite = epd;
1250
Luiz Fernando N. Capitulino5bc66d52006-09-27 11:58:53 -07001251 if (usb_endpoint_is_bulk_in(epd))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252 if (!epread)
1253 epread = epd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001254 }
1255
1256 /* Ignore buggy hardware without the right endpoints. */
1257 if (!epwrite || (ifd->desc.bInterfaceProtocol > 1 && !epread))
1258 continue;
1259
1260 /* Turn off reads for 7/1/1 (unidirectional) interfaces
1261 * and buggy bidirectional printers. */
1262 if (ifd->desc.bInterfaceProtocol == 1) {
1263 epread = NULL;
1264 } else if (usblp->quirks & USBLP_QUIRK_BIDIR) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001265 printk(KERN_INFO "usblp%d: Disabling reads from "
1266 "problematic bidirectional printer\n",
1267 usblp->minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268 epread = NULL;
1269 }
1270
1271 usblp->protocol[ifd->desc.bInterfaceProtocol].alt_setting =
1272 ifd->desc.bAlternateSetting;
1273 usblp->protocol[ifd->desc.bInterfaceProtocol].epwrite = epwrite;
1274 usblp->protocol[ifd->desc.bInterfaceProtocol].epread = epread;
1275 }
1276
1277 /* If our requested protocol is supported, then use it. */
1278 if (proto_bias >= USBLP_FIRST_PROTOCOL &&
1279 proto_bias <= USBLP_LAST_PROTOCOL &&
1280 usblp->protocol[proto_bias].alt_setting != -1)
1281 return proto_bias;
1282
1283 /* Ordering is important here. */
1284 if (usblp->protocol[2].alt_setting != -1)
1285 return 2;
1286 if (usblp->protocol[1].alt_setting != -1)
1287 return 1;
1288 if (usblp->protocol[3].alt_setting != -1)
1289 return 3;
1290
1291 /* If nothing is available, then don't bind to this device. */
1292 return -1;
1293}
1294
1295static int usblp_set_protocol(struct usblp *usblp, int protocol)
1296{
1297 int r, alts;
1298
1299 if (protocol < USBLP_FIRST_PROTOCOL || protocol > USBLP_LAST_PROTOCOL)
1300 return -EINVAL;
1301
1302 alts = usblp->protocol[protocol].alt_setting;
1303 if (alts < 0)
1304 return -EINVAL;
1305 r = usb_set_interface(usblp->dev, usblp->ifnum, alts);
1306 if (r < 0) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001307 printk(KERN_ERR "usblp: can't set desired altsetting %d on interface %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308 alts, usblp->ifnum);
1309 return r;
1310 }
1311
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312 usblp->bidir = (usblp->protocol[protocol].epread != NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313 usblp->current_protocol = protocol;
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -07001314 dev_dbg(&usblp->intf->dev, "usblp%d set protocol %d\n",
1315 usblp->minor, protocol);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 return 0;
1317}
1318
1319/* Retrieves and caches device ID string.
1320 * Returns length, including length bytes but not null terminator.
1321 * On error, returns a negative errno value. */
1322static int usblp_cache_device_id_string(struct usblp *usblp)
1323{
1324 int err, length;
1325
1326 err = usblp_get_id(usblp, 0, usblp->device_id_string, USBLP_DEVICE_ID_SIZE - 1);
1327 if (err < 0) {
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -07001328 dev_dbg(&usblp->intf->dev,
1329 "usblp%d: error = %d reading IEEE-1284 Device ID string\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330 usblp->minor, err);
1331 usblp->device_id_string[0] = usblp->device_id_string[1] = '\0';
1332 return -EIO;
1333 }
1334
1335 /* First two bytes are length in big-endian.
1336 * They count themselves, and we copy them into
1337 * the user's buffer. */
1338 length = be16_to_cpu(*((__be16 *)usblp->device_id_string));
1339 if (length < 2)
1340 length = 2;
1341 else if (length >= USBLP_DEVICE_ID_SIZE)
1342 length = USBLP_DEVICE_ID_SIZE - 1;
1343 usblp->device_id_string[length] = '\0';
1344
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -07001345 dev_dbg(&usblp->intf->dev, "usblp%d Device ID string [len=%d]=\"%s\"\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346 usblp->minor, length, &usblp->device_id_string[2]);
1347
1348 return length;
1349}
1350
1351static void usblp_disconnect(struct usb_interface *intf)
1352{
Nicolas Kaiser916de022010-06-25 20:25:37 +02001353 struct usblp *usblp = usb_get_intfdata(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354
1355 usb_deregister_dev(intf, &usblp_class);
1356
1357 if (!usblp || !usblp->dev) {
Greg Kroah-Hartman9908a322008-08-14 09:37:34 -07001358 dev_err(&intf->dev, "bogus disconnect\n");
Nicolas Kaiser916de022010-06-25 20:25:37 +02001359 BUG();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 }
1361
David Woodhousea9714c82005-12-23 16:41:41 +00001362 device_remove_file(&intf->dev, &dev_attr_ieee1284_id);
1363
Nicolas Kaiser916de022010-06-25 20:25:37 +02001364 mutex_lock(&usblp_mutex);
1365 mutex_lock(&usblp->mut);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001366 usblp->present = 0;
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001367 wake_up(&usblp->wwait);
1368 wake_up(&usblp->rwait);
Nicolas Kaiser916de022010-06-25 20:25:37 +02001369 usb_set_intfdata(intf, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370
1371 usblp_unlink_urbs(usblp);
Nicolas Kaiser916de022010-06-25 20:25:37 +02001372 mutex_unlock(&usblp->mut);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373
1374 if (!usblp->used)
Nicolas Kaiser916de022010-06-25 20:25:37 +02001375 usblp_cleanup(usblp);
1376 mutex_unlock(&usblp_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377}
1378
Oliver Neukum3a90f812009-12-28 00:52:17 +01001379static int usblp_suspend(struct usb_interface *intf, pm_message_t message)
Oliver Neukum516077c2006-10-05 09:04:11 +02001380{
Nicolas Kaiser916de022010-06-25 20:25:37 +02001381 struct usblp *usblp = usb_get_intfdata(intf);
Oliver Neukum516077c2006-10-05 09:04:11 +02001382
Oliver Neukum516077c2006-10-05 09:04:11 +02001383 usblp_unlink_urbs(usblp);
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001384#if 0 /* XXX Do we want this? What if someone is reading, should we fail? */
1385 /* not strictly necessary, but just in case */
1386 wake_up(&usblp->wwait);
1387 wake_up(&usblp->rwait);
1388#endif
Oliver Neukum516077c2006-10-05 09:04:11 +02001389
1390 return 0;
1391}
1392
Oliver Neukum3a90f812009-12-28 00:52:17 +01001393static int usblp_resume(struct usb_interface *intf)
Oliver Neukum516077c2006-10-05 09:04:11 +02001394{
Nicolas Kaiser916de022010-06-25 20:25:37 +02001395 struct usblp *usblp = usb_get_intfdata(intf);
Oliver Neukum516077c2006-10-05 09:04:11 +02001396 int r;
1397
Nicolas Kaiser916de022010-06-25 20:25:37 +02001398 r = handle_bidir(usblp);
Oliver Neukum516077c2006-10-05 09:04:11 +02001399
Oliver Neukum516077c2006-10-05 09:04:11 +02001400 return r;
1401}
1402
Németh Márton6ef48522010-01-10 15:33:45 +01001403static const struct usb_device_id usblp_ids[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404 { USB_DEVICE_INFO(7, 1, 1) },
1405 { USB_DEVICE_INFO(7, 1, 2) },
1406 { USB_DEVICE_INFO(7, 1, 3) },
1407 { USB_INTERFACE_INFO(7, 1, 1) },
1408 { USB_INTERFACE_INFO(7, 1, 2) },
1409 { USB_INTERFACE_INFO(7, 1, 3) },
Alan Stern5ec71db2007-03-16 15:53:07 -04001410 { USB_DEVICE(0x04b8, 0x0202) }, /* Seiko Epson Receipt Printer M129C */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001411 { } /* Terminating entry */
1412};
1413
Nicolas Kaiser916de022010-06-25 20:25:37 +02001414MODULE_DEVICE_TABLE(usb, usblp_ids);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001415
1416static struct usb_driver usblp_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001417 .name = "usblp",
1418 .probe = usblp_probe,
1419 .disconnect = usblp_disconnect,
Oliver Neukum516077c2006-10-05 09:04:11 +02001420 .suspend = usblp_suspend,
1421 .resume = usblp_resume,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 .id_table = usblp_ids,
Oliver Neukumd0532182007-01-18 15:06:07 +01001423 .supports_autosuspend = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001424};
1425
Greg Kroah-Hartman65db4302011-11-18 09:34:02 -08001426module_usb_driver(usblp_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001427
Nicolas Kaiser916de022010-06-25 20:25:37 +02001428MODULE_AUTHOR(DRIVER_AUTHOR);
1429MODULE_DESCRIPTION(DRIVER_DESC);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430module_param(proto_bias, int, S_IRUGO | S_IWUSR);
1431MODULE_PARM_DESC(proto_bias, "Favourite protocol number");
1432MODULE_LICENSE("GPL");