blob: fb87c17ed6faf8302c1eebd210a10be4a23f69ce [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>
Ingo Molnar174cd4b2017-02-02 19:15:33 +010052#include <linux/sched/signal.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>
Krzysztof Opasiak298b9922015-06-22 15:50:22 +020060#include <linux/usb/ch9.h>
Manuel Zerpies305e7be2011-06-16 14:15:54 +020061#include <linux/ratelimit.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070062
63/*
64 * Version Information
65 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070066#define DRIVER_AUTHOR "Michael Gee, Pavel Machek, Vojtech Pavlik, Randy Dunlap, Pete Zaitcev, David Paschal"
67#define DRIVER_DESC "USB Printer Device Class driver"
68
69#define USBLP_BUF_SIZE 8192
Pete Zaitcev317c67b2007-06-21 12:44:56 -070070#define USBLP_BUF_SIZE_IN 1024
Linus Torvalds1da177e2005-04-16 15:20:36 -070071#define USBLP_DEVICE_ID_SIZE 1024
72
73/* ioctls: */
Linus Torvalds1da177e2005-04-16 15:20:36 -070074#define IOCNR_GET_DEVICE_ID 1
75#define IOCNR_GET_PROTOCOLS 2
76#define IOCNR_SET_PROTOCOL 3
77#define IOCNR_HP_SET_CHANNEL 4
78#define IOCNR_GET_BUS_ADDRESS 5
79#define IOCNR_GET_VID_PID 6
80#define IOCNR_SOFT_RESET 7
81/* Get device_id string: */
82#define LPIOC_GET_DEVICE_ID(len) _IOC(_IOC_READ, 'P', IOCNR_GET_DEVICE_ID, len)
Krzysztof Opasiak298b9922015-06-22 15:50:22 +020083/* The following ioctls were added for http://hpoj.sourceforge.net:
84 * Get two-int array:
85 * [0]=current protocol
86 * (1=USB_CLASS_PRINTER/1/1, 2=USB_CLASS_PRINTER/1/2,
87 * 3=USB_CLASS_PRINTER/1/3),
88 * [1]=supported protocol mask (mask&(1<<n)!=0 means
89 * USB_CLASS_PRINTER/1/n supported):
90 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070091#define LPIOC_GET_PROTOCOLS(len) _IOC(_IOC_READ, 'P', IOCNR_GET_PROTOCOLS, len)
Krzysztof Opasiak298b9922015-06-22 15:50:22 +020092/*
93 * Set protocol
94 * (arg: 1=USB_CLASS_PRINTER/1/1, 2=USB_CLASS_PRINTER/1/2,
95 * 3=USB_CLASS_PRINTER/1/3):
96 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070097#define LPIOC_SET_PROTOCOL _IOC(_IOC_WRITE, 'P', IOCNR_SET_PROTOCOL, 0)
98/* Set channel number (HP Vendor-specific command): */
99#define LPIOC_HP_SET_CHANNEL _IOC(_IOC_WRITE, 'P', IOCNR_HP_SET_CHANNEL, 0)
100/* Get two-int array: [0]=bus number, [1]=device address: */
101#define LPIOC_GET_BUS_ADDRESS(len) _IOC(_IOC_READ, 'P', IOCNR_GET_BUS_ADDRESS, len)
102/* Get two-int array: [0]=vendor ID, [1]=product ID: */
103#define LPIOC_GET_VID_PID(len) _IOC(_IOC_READ, 'P', IOCNR_GET_VID_PID, len)
104/* Perform class specific soft reset */
105#define LPIOC_SOFT_RESET _IOC(_IOC_NONE, 'P', IOCNR_SOFT_RESET, 0);
106
107/*
108 * A DEVICE_ID string may include the printer's serial number.
109 * It should end with a semi-colon (';').
110 * An example from an HP 970C DeskJet printer is (this is one long string,
111 * with the serial number changed):
112MFG: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: ;
113 */
114
115/*
116 * USB Printer Requests
117 */
118
119#define USBLP_REQ_GET_ID 0x00
120#define USBLP_REQ_GET_STATUS 0x01
121#define USBLP_REQ_RESET 0x02
122#define USBLP_REQ_HP_CHANNEL_CHANGE_REQUEST 0x00 /* HP Vendor-specific */
123
124#define USBLP_MINORS 16
125#define USBLP_MINOR_BASE 0
126
Pete Zaitcev283face2007-08-13 22:54:29 -0700127#define USBLP_CTL_TIMEOUT 5000 /* 5 seconds */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
129#define USBLP_FIRST_PROTOCOL 1
130#define USBLP_LAST_PROTOCOL 3
131#define USBLP_MAX_PROTOCOLS (USBLP_LAST_PROTOCOL+1)
132
133/*
134 * some arbitrary status buffer size;
135 * need a status buffer that is allocated via kmalloc(), not on stack
136 */
137#define STATUS_BUF_SIZE 8
138
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700139/*
140 * Locks down the locking order:
141 * ->wmut locks wstatus.
142 * ->mut locks the whole usblp, except [rw]complete, and thus, by indirection,
143 * [rw]status. We only touch status when we know the side idle.
144 * ->lock locks what interrupt accesses.
145 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146struct usblp {
Nicolas Kaiser916de022010-06-25 20:25:37 +0200147 struct usb_device *dev; /* USB device */
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700148 struct mutex wmut;
149 struct mutex mut;
150 spinlock_t lock; /* locks rcomplete, wcomplete */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 char *readbuf; /* read transfer_buffer */
152 char *statusbuf; /* status transfer_buffer */
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700153 struct usb_anchor urbs;
154 wait_queue_head_t rwait, wwait;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 int readcount; /* Counter for reads */
156 int ifnum; /* Interface number */
157 struct usb_interface *intf; /* The interface */
Krzysztof Opasiak298b9922015-06-22 15:50:22 +0200158 /*
159 * Alternate-setting numbers and endpoints for each protocol
160 * (USB_CLASS_PRINTER/1/{index=1,2,3}) that the device supports:
161 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162 struct {
163 int alt_setting;
164 struct usb_endpoint_descriptor *epwrite;
165 struct usb_endpoint_descriptor *epread;
166 } protocol[USBLP_MAX_PROTOCOLS];
167 int current_protocol;
168 int minor; /* minor number of device */
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700169 int wcomplete, rcomplete;
170 int wstatus; /* bytes written or error */
171 int rstatus; /* bytes ready or error */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172 unsigned int quirks; /* quirks flags */
Pete Zaitcev7f477352007-07-23 01:58:15 -0700173 unsigned int flags; /* mode flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 unsigned char used; /* True if open */
175 unsigned char present; /* True if not disconnected */
176 unsigned char bidir; /* interface is bidirectional */
Pete Zaitcev7f477352007-07-23 01:58:15 -0700177 unsigned char no_paper; /* Paper Out happened */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 unsigned char *device_id_string; /* IEEE 1284 DEVICE ID string (ptr) */
179 /* first 2 bytes are (big-endian) length */
180};
181
182#ifdef DEBUG
Nicolas Kaiser916de022010-06-25 20:25:37 +0200183static void usblp_dump(struct usblp *usblp)
184{
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -0700185 struct device *dev = &usblp->intf->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 int p;
187
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -0700188 dev_dbg(dev, "usblp=0x%p\n", usblp);
189 dev_dbg(dev, "dev=0x%p\n", usblp->dev);
190 dev_dbg(dev, "present=%d\n", usblp->present);
191 dev_dbg(dev, "readbuf=0x%p\n", usblp->readbuf);
192 dev_dbg(dev, "readcount=%d\n", usblp->readcount);
193 dev_dbg(dev, "ifnum=%d\n", usblp->ifnum);
194 for (p = USBLP_FIRST_PROTOCOL; p <= USBLP_LAST_PROTOCOL; p++) {
195 dev_dbg(dev, "protocol[%d].alt_setting=%d\n", p,
196 usblp->protocol[p].alt_setting);
197 dev_dbg(dev, "protocol[%d].epwrite=%p\n", p,
198 usblp->protocol[p].epwrite);
199 dev_dbg(dev, "protocol[%d].epread=%p\n", p,
200 usblp->protocol[p].epread);
201 }
202 dev_dbg(dev, "current_protocol=%d\n", usblp->current_protocol);
203 dev_dbg(dev, "minor=%d\n", usblp->minor);
204 dev_dbg(dev, "wstatus=%d\n", usblp->wstatus);
205 dev_dbg(dev, "rstatus=%d\n", usblp->rstatus);
206 dev_dbg(dev, "quirks=%d\n", usblp->quirks);
207 dev_dbg(dev, "used=%d\n", usblp->used);
208 dev_dbg(dev, "bidir=%d\n", usblp->bidir);
209 dev_dbg(dev, "device_id_string=\"%s\"\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 usblp->device_id_string ?
211 usblp->device_id_string + 2 :
212 (unsigned char *)"(null)");
213}
214#endif
215
216/* Quirks: various printer quirks are handled by this table & its flags. */
217
218struct quirk_printer_struct {
219 __u16 vendorId;
220 __u16 productId;
221 unsigned int quirks;
222};
223
224#define USBLP_QUIRK_BIDIR 0x1 /* reports bidir but requires unidirectional mode (no INs/reads) */
225#define USBLP_QUIRK_USB_INIT 0x2 /* needs vendor USB init string */
Alan Stern5ec71db2007-03-16 15:53:07 -0400226#define USBLP_QUIRK_BAD_CLASS 0x4 /* descriptor uses vendor-specific Class or SubClass */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227
Arjan van de Ven4c4c9432005-11-29 09:43:42 +0100228static const struct quirk_printer_struct quirk_printers[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 { 0x03f0, 0x0004, USBLP_QUIRK_BIDIR }, /* HP DeskJet 895C */
230 { 0x03f0, 0x0104, USBLP_QUIRK_BIDIR }, /* HP DeskJet 880C */
231 { 0x03f0, 0x0204, USBLP_QUIRK_BIDIR }, /* HP DeskJet 815C */
232 { 0x03f0, 0x0304, USBLP_QUIRK_BIDIR }, /* HP DeskJet 810C/812C */
233 { 0x03f0, 0x0404, USBLP_QUIRK_BIDIR }, /* HP DeskJet 830C */
234 { 0x03f0, 0x0504, USBLP_QUIRK_BIDIR }, /* HP DeskJet 885C */
Nicolas Kaiser916de022010-06-25 20:25:37 +0200235 { 0x03f0, 0x0604, USBLP_QUIRK_BIDIR }, /* HP DeskJet 840C */
236 { 0x03f0, 0x0804, USBLP_QUIRK_BIDIR }, /* HP DeskJet 816C */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 { 0x03f0, 0x1104, USBLP_QUIRK_BIDIR }, /* HP Deskjet 959C */
238 { 0x0409, 0xefbe, USBLP_QUIRK_BIDIR }, /* NEC Picty900 (HP OEM) */
239 { 0x0409, 0xbef4, USBLP_QUIRK_BIDIR }, /* NEC Picty760 (HP OEM) */
240 { 0x0409, 0xf0be, USBLP_QUIRK_BIDIR }, /* NEC Picty920 (HP OEM) */
241 { 0x0409, 0xf1be, USBLP_QUIRK_BIDIR }, /* NEC Picty800 (HP OEM) */
Martin Williges4f45d0382006-12-28 20:52:10 +0100242 { 0x0482, 0x0010, USBLP_QUIRK_BIDIR }, /* Kyocera Mita FS 820, by zut <kernel@zut.de> */
Brandon Philips06a743b2009-01-05 08:30:39 -0800243 { 0x04f9, 0x000d, USBLP_QUIRK_BIDIR }, /* Brother Industries, Ltd HL-1440 Laser Printer */
Alan Stern5ec71db2007-03-16 15:53:07 -0400244 { 0x04b8, 0x0202, USBLP_QUIRK_BAD_CLASS }, /* Seiko Epson Receipt Printer M129C */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245 { 0, 0 }
246};
247
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700248static int usblp_wwait(struct usblp *usblp, int nonblock);
249static int usblp_wtest(struct usblp *usblp, int nonblock);
250static int usblp_rwait_and_lock(struct usblp *usblp, int nonblock);
251static int usblp_rtest(struct usblp *usblp, int nonblock);
252static int usblp_submit_read(struct usblp *usblp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253static int usblp_select_alts(struct usblp *usblp);
254static int usblp_set_protocol(struct usblp *usblp, int protocol);
255static int usblp_cache_device_id_string(struct usblp *usblp);
256
257/* forward reference to make our lives easier */
258static struct usb_driver usblp_driver;
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100259static DEFINE_MUTEX(usblp_mutex); /* locks the existence of usblp's */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260
261/*
262 * Functions for usblp control messages.
263 */
264
265static int usblp_ctrl_msg(struct usblp *usblp, int request, int type, int dir, int recip, int value, void *buf, int len)
266{
267 int retval;
268 int index = usblp->ifnum;
269
270 /* High byte has the interface index.
271 Low byte has the alternate setting.
272 */
Nicolas Kaiser916de022010-06-25 20:25:37 +0200273 if ((request == USBLP_REQ_GET_ID) && (type == USB_TYPE_CLASS))
274 index = (usblp->ifnum<<8)|usblp->protocol[usblp->current_protocol].alt_setting;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275
276 retval = usb_control_msg(usblp->dev,
277 dir ? usb_rcvctrlpipe(usblp->dev, 0) : usb_sndctrlpipe(usblp->dev, 0),
Pete Zaitcev283face2007-08-13 22:54:29 -0700278 request, type | dir | recip, value, index, buf, len, USBLP_CTL_TIMEOUT);
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -0700279 dev_dbg(&usblp->intf->dev,
280 "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 -0700281 request, !!dir, recip, value, index, len, retval);
282 return retval < 0 ? retval : 0;
283}
284
285#define usblp_read_status(usblp, status)\
286 usblp_ctrl_msg(usblp, USBLP_REQ_GET_STATUS, USB_TYPE_CLASS, USB_DIR_IN, USB_RECIP_INTERFACE, 0, status, 1)
287#define usblp_get_id(usblp, config, id, maxlen)\
288 usblp_ctrl_msg(usblp, USBLP_REQ_GET_ID, USB_TYPE_CLASS, USB_DIR_IN, USB_RECIP_INTERFACE, config, id, maxlen)
289#define usblp_reset(usblp)\
290 usblp_ctrl_msg(usblp, USBLP_REQ_RESET, USB_TYPE_CLASS, USB_DIR_OUT, USB_RECIP_OTHER, 0, NULL, 0)
291
292#define usblp_hp_channel_change_request(usblp, channel, buffer) \
293 usblp_ctrl_msg(usblp, USBLP_REQ_HP_CHANNEL_CHANGE_REQUEST, USB_TYPE_VENDOR, USB_DIR_IN, USB_RECIP_INTERFACE, channel, buffer, 1)
294
295/*
296 * See the description for usblp_select_alts() below for the usage
Mauro Carvalho Chehab21470e32017-04-16 21:51:07 -0300297 * explanation. Look into your /sys/kernel/debug/usb/devices and dmesg in
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 * case of any trouble.
299 */
300static int proto_bias = -1;
301
302/*
303 * URB callback.
304 */
305
David Howells7d12e782006-10-05 14:55:46 +0100306static void usblp_bulk_read(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307{
308 struct usblp *usblp = urb->context;
Greg Kroah-Hartman18ac3012007-07-18 10:58:02 -0700309 int status = urb->status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700311 if (usblp->present && usblp->used) {
Greg Kroah-Hartman18ac3012007-07-18 10:58:02 -0700312 if (status)
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700313 printk(KERN_WARNING "usblp%d: "
314 "nonzero read bulk status received: %d\n",
Greg Kroah-Hartman18ac3012007-07-18 10:58:02 -0700315 usblp->minor, status);
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700316 }
317 spin_lock(&usblp->lock);
Greg Kroah-Hartman18ac3012007-07-18 10:58:02 -0700318 if (status < 0)
319 usblp->rstatus = status;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700320 else
321 usblp->rstatus = urb->actual_length;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 usblp->rcomplete = 1;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700323 wake_up(&usblp->rwait);
324 spin_unlock(&usblp->lock);
325
326 usb_free_urb(urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327}
328
David Howells7d12e782006-10-05 14:55:46 +0100329static void usblp_bulk_write(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330{
331 struct usblp *usblp = urb->context;
Greg Kroah-Hartman18ac3012007-07-18 10:58:02 -0700332 int status = urb->status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700334 if (usblp->present && usblp->used) {
Greg Kroah-Hartman18ac3012007-07-18 10:58:02 -0700335 if (status)
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700336 printk(KERN_WARNING "usblp%d: "
337 "nonzero write bulk status received: %d\n",
Greg Kroah-Hartman18ac3012007-07-18 10:58:02 -0700338 usblp->minor, status);
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700339 }
340 spin_lock(&usblp->lock);
Greg Kroah-Hartman18ac3012007-07-18 10:58:02 -0700341 if (status < 0)
342 usblp->wstatus = status;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700343 else
344 usblp->wstatus = urb->actual_length;
Pete Zaitcev7f477352007-07-23 01:58:15 -0700345 usblp->no_paper = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346 usblp->wcomplete = 1;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700347 wake_up(&usblp->wwait);
348 spin_unlock(&usblp->lock);
349
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700350 usb_free_urb(urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351}
352
353/*
354 * Get and print printer errors.
355 */
356
Arjan van de Ven4c4c9432005-11-29 09:43:42 +0100357static const char *usblp_messages[] = { "ok", "out of paper", "off-line", "on fire" };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358
359static int usblp_check_status(struct usblp *usblp, int err)
360{
361 unsigned char status, newerr = 0;
362 int error;
363
Pete Zaitcevfc401e62007-08-13 22:50:13 -0700364 mutex_lock(&usblp->mut);
365 if ((error = usblp_read_status(usblp, usblp->statusbuf)) < 0) {
366 mutex_unlock(&usblp->mut);
Manuel Zerpies305e7be2011-06-16 14:15:54 +0200367 printk_ratelimited(KERN_ERR
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700368 "usblp%d: error %d reading printer status\n",
Randy Dunlap0bc8e002005-07-31 20:41:19 -0700369 usblp->minor, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700370 return 0;
371 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372 status = *usblp->statusbuf;
Pete Zaitcevfc401e62007-08-13 22:50:13 -0700373 mutex_unlock(&usblp->mut);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374
375 if (~status & LP_PERRORP)
376 newerr = 3;
377 if (status & LP_POUTPA)
378 newerr = 1;
379 if (~status & LP_PSELECD)
380 newerr = 2;
381
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700382 if (newerr != err) {
383 printk(KERN_INFO "usblp%d: %s\n",
384 usblp->minor, usblp_messages[newerr]);
385 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386
387 return newerr;
388}
389
Nicolas Kaiser916de022010-06-25 20:25:37 +0200390static int handle_bidir(struct usblp *usblp)
Oliver Neukum516077c2006-10-05 09:04:11 +0200391{
Oliver Neukum3a90f812009-12-28 00:52:17 +0100392 if (usblp->bidir && usblp->used) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700393 if (usblp_submit_read(usblp) < 0)
Oliver Neukum516077c2006-10-05 09:04:11 +0200394 return -EIO;
Oliver Neukum516077c2006-10-05 09:04:11 +0200395 }
Oliver Neukum516077c2006-10-05 09:04:11 +0200396 return 0;
397}
398
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399/*
400 * File op functions.
401 */
402
403static int usblp_open(struct inode *inode, struct file *file)
404{
405 int minor = iminor(inode);
406 struct usblp *usblp;
407 struct usb_interface *intf;
408 int retval;
409
410 if (minor < 0)
411 return -ENODEV;
412
Nicolas Kaiser916de022010-06-25 20:25:37 +0200413 mutex_lock(&usblp_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414
415 retval = -ENODEV;
416 intf = usb_find_interface(&usblp_driver, minor);
Nicolas Kaiser916de022010-06-25 20:25:37 +0200417 if (!intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 goto out;
Nicolas Kaiser916de022010-06-25 20:25:37 +0200419 usblp = usb_get_intfdata(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420 if (!usblp || !usblp->dev || !usblp->present)
421 goto out;
422
423 retval = -EBUSY;
424 if (usblp->used)
425 goto out;
426
427 /*
Pete Zaitcev7f477352007-07-23 01:58:15 -0700428 * We do not implement LP_ABORTOPEN/LPABORTOPEN for two reasons:
429 * - We do not want persistent state which close(2) does not clear
430 * - It is not used anyway, according to CUPS people
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432
Oliver Neukumd0532182007-01-18 15:06:07 +0100433 retval = usb_autopm_get_interface(intf);
434 if (retval < 0)
435 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436 usblp->used = 1;
437 file->private_data = usblp;
438
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 usblp->wcomplete = 1; /* we begin writeable */
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700440 usblp->wstatus = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 usblp->rcomplete = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442
Oliver Neukum516077c2006-10-05 09:04:11 +0200443 if (handle_bidir(usblp) < 0) {
Oliver Neukum19028692008-02-12 19:08:30 +0100444 usb_autopm_put_interface(intf);
Pete Zaitcev97cb95d2007-05-24 21:59:19 -0700445 usblp->used = 0;
Oliver Neukum516077c2006-10-05 09:04:11 +0200446 file->private_data = NULL;
447 retval = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 }
449out:
Nicolas Kaiser916de022010-06-25 20:25:37 +0200450 mutex_unlock(&usblp_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 return retval;
452}
453
Nicolas Kaiser916de022010-06-25 20:25:37 +0200454static void usblp_cleanup(struct usblp *usblp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455{
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700456 printk(KERN_INFO "usblp%d: removed\n", usblp->minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700458 kfree(usblp->readbuf);
Nicolas Kaiser916de022010-06-25 20:25:37 +0200459 kfree(usblp->device_id_string);
460 kfree(usblp->statusbuf);
461 kfree(usblp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462}
463
464static void usblp_unlink_urbs(struct usblp *usblp)
465{
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700466 usb_kill_anchored_urbs(&usblp->urbs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467}
468
469static int usblp_release(struct inode *inode, struct file *file)
470{
471 struct usblp *usblp = file->private_data;
472
Pete Zaitcev7f477352007-07-23 01:58:15 -0700473 usblp->flags &= ~LP_ABORT;
474
Nicolas Kaiser916de022010-06-25 20:25:37 +0200475 mutex_lock(&usblp_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 usblp->used = 0;
477 if (usblp->present) {
478 usblp_unlink_urbs(usblp);
Oliver Neukumd0532182007-01-18 15:06:07 +0100479 usb_autopm_put_interface(usblp->intf);
Nicolas Kaiser916de022010-06-25 20:25:37 +0200480 } else /* finish cleanup from disconnect */
481 usblp_cleanup(usblp);
482 mutex_unlock(&usblp_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483 return 0;
484}
485
486/* No kernel lock - fine */
487static unsigned int usblp_poll(struct file *file, struct poll_table_struct *wait)
488{
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700489 int ret;
490 unsigned long flags;
491
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 struct usblp *usblp = file->private_data;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700493 /* Should we check file->f_mode & FMODE_WRITE before poll_wait()? */
494 poll_wait(file, &usblp->rwait, wait);
495 poll_wait(file, &usblp->wwait, wait);
496 spin_lock_irqsave(&usblp->lock, flags);
Pete Zaitcev283face2007-08-13 22:54:29 -0700497 ret = ((usblp->bidir && usblp->rcomplete) ? POLLIN | POLLRDNORM : 0) |
498 ((usblp->no_paper || usblp->wcomplete) ? POLLOUT | POLLWRNORM : 0);
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700499 spin_unlock_irqrestore(&usblp->lock, flags);
500 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501}
502
Pete Zaitcev318e4792005-12-21 17:03:24 -0800503static long usblp_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504{
505 struct usblp *usblp = file->private_data;
506 int length, err, i;
507 unsigned char newChannel;
508 int status;
509 int twoints[2];
510 int retval = 0;
511
Nicolas Kaiser916de022010-06-25 20:25:37 +0200512 mutex_lock(&usblp->mut);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 if (!usblp->present) {
514 retval = -ENODEV;
515 goto done;
516 }
517
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -0700518 dev_dbg(&usblp->intf->dev,
519 "usblp_ioctl: cmd=0x%x (%c nr=%d len=%d dir=%d)\n", cmd,
520 _IOC_TYPE(cmd), _IOC_NR(cmd), _IOC_SIZE(cmd), _IOC_DIR(cmd));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521
522 if (_IOC_TYPE(cmd) == 'P') /* new-style ioctl number */
523
524 switch (_IOC_NR(cmd)) {
525
Nicolas Kaiser916de022010-06-25 20:25:37 +0200526 case IOCNR_GET_DEVICE_ID: /* get the DEVICE_ID string */
527 if (_IOC_DIR(cmd) != _IOC_READ) {
528 retval = -EINVAL;
529 goto done;
530 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531
Nicolas Kaiser916de022010-06-25 20:25:37 +0200532 length = usblp_cache_device_id_string(usblp);
533 if (length < 0) {
534 retval = length;
535 goto done;
536 }
537 if (length > _IOC_SIZE(cmd))
538 length = _IOC_SIZE(cmd); /* truncate */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539
Nicolas Kaiser916de022010-06-25 20:25:37 +0200540 if (copy_to_user((void __user *) arg,
541 usblp->device_id_string,
542 (unsigned long) length)) {
543 retval = -EFAULT;
544 goto done;
545 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546
Nicolas Kaiser916de022010-06-25 20:25:37 +0200547 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548
Nicolas Kaiser916de022010-06-25 20:25:37 +0200549 case IOCNR_GET_PROTOCOLS:
550 if (_IOC_DIR(cmd) != _IOC_READ ||
551 _IOC_SIZE(cmd) < sizeof(twoints)) {
552 retval = -EINVAL;
553 goto done;
554 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555
Nicolas Kaiser916de022010-06-25 20:25:37 +0200556 twoints[0] = usblp->current_protocol;
557 twoints[1] = 0;
558 for (i = USBLP_FIRST_PROTOCOL;
559 i <= USBLP_LAST_PROTOCOL; i++) {
560 if (usblp->protocol[i].alt_setting >= 0)
561 twoints[1] |= (1<<i);
562 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563
Nicolas Kaiser916de022010-06-25 20:25:37 +0200564 if (copy_to_user((void __user *)arg,
565 (unsigned char *)twoints,
566 sizeof(twoints))) {
567 retval = -EFAULT;
568 goto done;
569 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570
Nicolas Kaiser916de022010-06-25 20:25:37 +0200571 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572
Nicolas Kaiser916de022010-06-25 20:25:37 +0200573 case IOCNR_SET_PROTOCOL:
574 if (_IOC_DIR(cmd) != _IOC_WRITE) {
575 retval = -EINVAL;
576 goto done;
577 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578
579#ifdef DEBUG
Nicolas Kaiser916de022010-06-25 20:25:37 +0200580 if (arg == -10) {
581 usblp_dump(usblp);
582 break;
583 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584#endif
585
Nicolas Kaiser916de022010-06-25 20:25:37 +0200586 usblp_unlink_urbs(usblp);
587 retval = usblp_set_protocol(usblp, arg);
588 if (retval < 0) {
589 usblp_set_protocol(usblp,
590 usblp->current_protocol);
591 }
592 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593
Nicolas Kaiser916de022010-06-25 20:25:37 +0200594 case IOCNR_HP_SET_CHANNEL:
595 if (_IOC_DIR(cmd) != _IOC_WRITE ||
596 le16_to_cpu(usblp->dev->descriptor.idVendor) != 0x03F0 ||
597 usblp->quirks & USBLP_QUIRK_BIDIR) {
598 retval = -EINVAL;
599 goto done;
600 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601
Nicolas Kaiser916de022010-06-25 20:25:37 +0200602 err = usblp_hp_channel_change_request(usblp,
603 arg, &newChannel);
604 if (err < 0) {
605 dev_err(&usblp->dev->dev,
606 "usblp%d: error = %d setting "
607 "HP channel\n",
608 usblp->minor, err);
609 retval = -EIO;
610 goto done;
611 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -0700613 dev_dbg(&usblp->intf->dev,
614 "usblp%d requested/got HP channel %ld/%d\n",
Nicolas Kaiser916de022010-06-25 20:25:37 +0200615 usblp->minor, arg, newChannel);
616 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617
Nicolas Kaiser916de022010-06-25 20:25:37 +0200618 case IOCNR_GET_BUS_ADDRESS:
619 if (_IOC_DIR(cmd) != _IOC_READ ||
620 _IOC_SIZE(cmd) < sizeof(twoints)) {
621 retval = -EINVAL;
622 goto done;
623 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624
Nicolas Kaiser916de022010-06-25 20:25:37 +0200625 twoints[0] = usblp->dev->bus->busnum;
626 twoints[1] = usblp->dev->devnum;
627 if (copy_to_user((void __user *)arg,
628 (unsigned char *)twoints,
629 sizeof(twoints))) {
630 retval = -EFAULT;
631 goto done;
632 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -0700634 dev_dbg(&usblp->intf->dev,
635 "usblp%d is bus=%d, device=%d\n",
Nicolas Kaiser916de022010-06-25 20:25:37 +0200636 usblp->minor, twoints[0], twoints[1]);
637 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638
Nicolas Kaiser916de022010-06-25 20:25:37 +0200639 case IOCNR_GET_VID_PID:
640 if (_IOC_DIR(cmd) != _IOC_READ ||
641 _IOC_SIZE(cmd) < sizeof(twoints)) {
642 retval = -EINVAL;
643 goto done;
644 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645
Nicolas Kaiser916de022010-06-25 20:25:37 +0200646 twoints[0] = le16_to_cpu(usblp->dev->descriptor.idVendor);
647 twoints[1] = le16_to_cpu(usblp->dev->descriptor.idProduct);
648 if (copy_to_user((void __user *)arg,
649 (unsigned char *)twoints,
650 sizeof(twoints))) {
651 retval = -EFAULT;
652 goto done;
653 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -0700655 dev_dbg(&usblp->intf->dev,
656 "usblp%d is VID=0x%4.4X, PID=0x%4.4X\n",
Nicolas Kaiser916de022010-06-25 20:25:37 +0200657 usblp->minor, twoints[0], twoints[1]);
658 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659
Nicolas Kaiser916de022010-06-25 20:25:37 +0200660 case IOCNR_SOFT_RESET:
661 if (_IOC_DIR(cmd) != _IOC_NONE) {
662 retval = -EINVAL;
663 goto done;
664 }
665 retval = usblp_reset(usblp);
666 break;
667 default:
668 retval = -ENOTTY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 }
670 else /* old-style ioctl value */
671 switch (cmd) {
672
Nicolas Kaiser916de022010-06-25 20:25:37 +0200673 case LPGETSTATUS:
Greg Kroah-Hartman2fcdbdf2015-04-30 11:33:06 +0200674 retval = usblp_read_status(usblp, usblp->statusbuf);
675 if (retval) {
Manuel Zerpies305e7be2011-06-16 14:15:54 +0200676 printk_ratelimited(KERN_ERR "usblp%d:"
Nicolas Kaiser916de022010-06-25 20:25:37 +0200677 "failed reading printer status (%d)\n",
678 usblp->minor, retval);
679 retval = -EIO;
680 goto done;
681 }
682 status = *usblp->statusbuf;
683 if (copy_to_user((void __user *)arg, &status, sizeof(int)))
684 retval = -EFAULT;
685 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686
Nicolas Kaiser916de022010-06-25 20:25:37 +0200687 case LPABORT:
688 if (arg)
689 usblp->flags |= LP_ABORT;
690 else
691 usblp->flags &= ~LP_ABORT;
692 break;
Pete Zaitcev7f477352007-07-23 01:58:15 -0700693
Nicolas Kaiser916de022010-06-25 20:25:37 +0200694 default:
695 retval = -ENOTTY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696 }
697
698done:
Nicolas Kaiser916de022010-06-25 20:25:37 +0200699 mutex_unlock(&usblp->mut);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 return retval;
701}
702
Pete Zaitcev42cb9672007-08-14 13:19:16 -0700703static struct urb *usblp_new_writeurb(struct usblp *usblp, int transfer_length)
704{
705 struct urb *urb;
706 char *writebuf;
707
Greg Kroah-Hartman2fcdbdf2015-04-30 11:33:06 +0200708 writebuf = kmalloc(transfer_length, GFP_KERNEL);
709 if (writebuf == NULL)
Pete Zaitcev42cb9672007-08-14 13:19:16 -0700710 return NULL;
Greg Kroah-Hartman2fcdbdf2015-04-30 11:33:06 +0200711 urb = usb_alloc_urb(0, GFP_KERNEL);
712 if (urb == NULL) {
Pete Zaitcev42cb9672007-08-14 13:19:16 -0700713 kfree(writebuf);
714 return NULL;
715 }
716
717 usb_fill_bulk_urb(urb, usblp->dev,
718 usb_sndbulkpipe(usblp->dev,
719 usblp->protocol[usblp->current_protocol].epwrite->bEndpointAddress),
720 writebuf, transfer_length, usblp_bulk_write, usblp);
721 urb->transfer_flags |= URB_FREE_BUFFER;
722
723 return urb;
724}
725
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726static ssize_t usblp_write(struct file *file, const char __user *buffer, size_t count, loff_t *ppos)
727{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728 struct usblp *usblp = file->private_data;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700729 struct urb *writeurb;
730 int rv;
731 int transfer_length;
732 ssize_t writecount = 0;
733
734 if (mutex_lock_interruptible(&usblp->wmut)) {
735 rv = -EINTR;
736 goto raise_biglock;
737 }
738 if ((rv = usblp_wwait(usblp, !!(file->f_flags & O_NONBLOCK))) < 0)
739 goto raise_wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740
741 while (writecount < count) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700742 /*
743 * Step 1: Submit next block.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 */
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700745 if ((transfer_length = count - writecount) > USBLP_BUF_SIZE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 transfer_length = USBLP_BUF_SIZE;
747
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700748 rv = -ENOMEM;
Greg Kroah-Hartman2fcdbdf2015-04-30 11:33:06 +0200749 writeurb = usblp_new_writeurb(usblp, transfer_length);
750 if (writeurb == NULL)
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700751 goto raise_urb;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700752 usb_anchor_urb(writeurb, &usblp->urbs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753
Pete Zaitcev42cb9672007-08-14 13:19:16 -0700754 if (copy_from_user(writeurb->transfer_buffer,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755 buffer + writecount, transfer_length)) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700756 rv = -EFAULT;
757 goto raise_badaddr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 }
759
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700760 spin_lock_irq(&usblp->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 usblp->wcomplete = 0;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700762 spin_unlock_irq(&usblp->lock);
763 if ((rv = usb_submit_urb(writeurb, GFP_KERNEL)) < 0) {
764 usblp->wstatus = 0;
765 spin_lock_irq(&usblp->lock);
Pete Zaitcev7f477352007-07-23 01:58:15 -0700766 usblp->no_paper = 0;
Oliver Neukum6c8df792006-10-28 11:36:59 +0200767 usblp->wcomplete = 1;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700768 wake_up(&usblp->wwait);
769 spin_unlock_irq(&usblp->lock);
770 if (rv != -ENOMEM)
771 rv = -EIO;
772 goto raise_submit;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773 }
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700774
775 /*
776 * Step 2: Wait for transfer to end, collect results.
777 */
778 rv = usblp_wwait(usblp, !!(file->f_flags&O_NONBLOCK));
779 if (rv < 0) {
Pete Zaitcev10e48522007-07-10 20:09:58 -0700780 if (rv == -EAGAIN) {
781 /* Presume that it's going to complete well. */
782 writecount += transfer_length;
783 }
Pete Zaitcev7f477352007-07-23 01:58:15 -0700784 if (rv == -ENOSPC) {
785 spin_lock_irq(&usblp->lock);
786 usblp->no_paper = 1; /* Mark for poll(2) */
787 spin_unlock_irq(&usblp->lock);
788 writecount += transfer_length;
789 }
Pete Zaitcev10e48522007-07-10 20:09:58 -0700790 /* Leave URB dangling, to be cleaned on close. */
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700791 goto collect_error;
792 }
793
794 if (usblp->wstatus < 0) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700795 rv = -EIO;
796 goto collect_error;
797 }
798 /*
799 * This is critical: it must be our URB, not other writer's.
800 * The wmut exists mainly to cover us here.
801 */
802 writecount += usblp->wstatus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803 }
804
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700805 mutex_unlock(&usblp->wmut);
806 return writecount;
807
808raise_submit:
809raise_badaddr:
810 usb_unanchor_urb(writeurb);
811 usb_free_urb(writeurb);
812raise_urb:
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700813raise_wait:
814collect_error: /* Out of raise sequence */
815 mutex_unlock(&usblp->wmut);
816raise_biglock:
817 return writecount ? writecount : rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818}
819
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700820/*
821 * Notice that we fail to restart in a few cases: on EFAULT, on restart
822 * error, etc. This is the historical behaviour. In all such cases we return
823 * EIO, and applications loop in order to get the new read going.
824 */
825static ssize_t usblp_read(struct file *file, char __user *buffer, size_t len, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826{
827 struct usblp *usblp = file->private_data;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700828 ssize_t count;
829 ssize_t avail;
830 int rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831
832 if (!usblp->bidir)
833 return -EINVAL;
834
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700835 rv = usblp_rwait_and_lock(usblp, !!(file->f_flags & O_NONBLOCK));
836 if (rv < 0)
837 return rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700839 if ((avail = usblp->rstatus) < 0) {
840 printk(KERN_ERR "usblp%d: error %d reading from printer\n",
841 usblp->minor, (int)avail);
842 usblp_submit_read(usblp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 count = -EIO;
844 goto done;
845 }
846
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700847 count = len < avail - usblp->readcount ? len : avail - usblp->readcount;
848 if (count != 0 &&
849 copy_to_user(buffer, usblp->readbuf + usblp->readcount, count)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 count = -EFAULT;
851 goto done;
852 }
853
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700854 if ((usblp->readcount += count) == avail) {
855 if (usblp_submit_read(usblp) < 0) {
856 /* We don't want to leak USB return codes into errno. */
857 if (count == 0)
858 count = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 goto done;
860 }
861 }
862
863done:
Nicolas Kaiser916de022010-06-25 20:25:37 +0200864 mutex_unlock(&usblp->mut);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 return count;
866}
867
868/*
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700869 * Wait for the write path to come idle.
870 * This is called under the ->wmut, so the idle path stays idle.
871 *
872 * Our write path has a peculiar property: it does not buffer like a tty,
873 * but waits for the write to succeed. This allows our ->release to bug out
874 * without waiting for writes to drain. But it obviously does not work
875 * when O_NONBLOCK is set. So, applications setting O_NONBLOCK must use
876 * select(2) or poll(2) to wait for the buffer to drain before closing.
877 * Alternatively, set blocking mode with fcntl and issue a zero-size write.
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700878 */
879static int usblp_wwait(struct usblp *usblp, int nonblock)
880{
881 DECLARE_WAITQUEUE(waita, current);
882 int rc;
Pete Zaitcev7f477352007-07-23 01:58:15 -0700883 int err = 0;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700884
885 add_wait_queue(&usblp->wwait, &waita);
886 for (;;) {
887 if (mutex_lock_interruptible(&usblp->mut)) {
888 rc = -EINTR;
889 break;
890 }
Jiri Slaby19cd80a2015-11-02 10:27:00 +0100891 set_current_state(TASK_INTERRUPTIBLE);
Pete Zaitcev7f477352007-07-23 01:58:15 -0700892 rc = usblp_wtest(usblp, nonblock);
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700893 mutex_unlock(&usblp->mut);
Pete Zaitcev7f477352007-07-23 01:58:15 -0700894 if (rc <= 0)
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700895 break;
Pete Zaitcev7f477352007-07-23 01:58:15 -0700896
Pete Zaitcevdd44be62009-01-06 17:20:42 -0700897 if (schedule_timeout(msecs_to_jiffies(1500)) == 0) {
898 if (usblp->flags & LP_ABORT) {
Pete Zaitcev7f477352007-07-23 01:58:15 -0700899 err = usblp_check_status(usblp, err);
900 if (err == 1) { /* Paper out */
901 rc = -ENOSPC;
902 break;
903 }
Pete Zaitcevdd44be62009-01-06 17:20:42 -0700904 } else {
905 /* Prod the printer, Gentoo#251237. */
906 mutex_lock(&usblp->mut);
907 usblp_read_status(usblp, usblp->statusbuf);
908 mutex_unlock(&usblp->mut);
Pete Zaitcev7f477352007-07-23 01:58:15 -0700909 }
Pete Zaitcev7f477352007-07-23 01:58:15 -0700910 }
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700911 }
912 set_current_state(TASK_RUNNING);
913 remove_wait_queue(&usblp->wwait, &waita);
914 return rc;
915}
916
917static int usblp_wtest(struct usblp *usblp, int nonblock)
918{
919 unsigned long flags;
920
921 if (!usblp->present)
922 return -ENODEV;
923 if (signal_pending(current))
924 return -EINTR;
925 spin_lock_irqsave(&usblp->lock, flags);
926 if (usblp->wcomplete) {
927 spin_unlock_irqrestore(&usblp->lock, flags);
928 return 0;
929 }
930 spin_unlock_irqrestore(&usblp->lock, flags);
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700931 if (nonblock)
932 return -EAGAIN;
933 return 1;
934}
935
936/*
937 * Wait for read bytes to become available. This probably should have been
938 * called usblp_r_lock_and_wait(), because we lock first. But it's a traditional
939 * name for functions which lock and return.
940 *
941 * We do not use wait_event_interruptible because it makes locking iffy.
942 */
943static int usblp_rwait_and_lock(struct usblp *usblp, int nonblock)
944{
945 DECLARE_WAITQUEUE(waita, current);
946 int rc;
947
948 add_wait_queue(&usblp->rwait, &waita);
949 for (;;) {
950 if (mutex_lock_interruptible(&usblp->mut)) {
951 rc = -EINTR;
952 break;
953 }
954 set_current_state(TASK_INTERRUPTIBLE);
955 if ((rc = usblp_rtest(usblp, nonblock)) < 0) {
956 mutex_unlock(&usblp->mut);
957 break;
958 }
959 if (rc == 0) /* Keep it locked */
960 break;
961 mutex_unlock(&usblp->mut);
962 schedule();
963 }
964 set_current_state(TASK_RUNNING);
965 remove_wait_queue(&usblp->rwait, &waita);
966 return rc;
967}
968
969static int usblp_rtest(struct usblp *usblp, int nonblock)
970{
971 unsigned long flags;
972
973 if (!usblp->present)
974 return -ENODEV;
975 if (signal_pending(current))
976 return -EINTR;
977 spin_lock_irqsave(&usblp->lock, flags);
978 if (usblp->rcomplete) {
979 spin_unlock_irqrestore(&usblp->lock, flags);
980 return 0;
981 }
982 spin_unlock_irqrestore(&usblp->lock, flags);
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700983 if (nonblock)
984 return -EAGAIN;
985 return 1;
986}
987
988/*
989 * Please check ->bidir and other such things outside for now.
990 */
991static int usblp_submit_read(struct usblp *usblp)
992{
993 struct urb *urb;
994 unsigned long flags;
995 int rc;
996
997 rc = -ENOMEM;
Greg Kroah-Hartman2fcdbdf2015-04-30 11:33:06 +0200998 urb = usb_alloc_urb(0, GFP_KERNEL);
999 if (urb == NULL)
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001000 goto raise_urb;
1001
1002 usb_fill_bulk_urb(urb, usblp->dev,
1003 usb_rcvbulkpipe(usblp->dev,
1004 usblp->protocol[usblp->current_protocol].epread->bEndpointAddress),
1005 usblp->readbuf, USBLP_BUF_SIZE_IN,
1006 usblp_bulk_read, usblp);
1007 usb_anchor_urb(urb, &usblp->urbs);
1008
1009 spin_lock_irqsave(&usblp->lock, flags);
1010 usblp->readcount = 0; /* XXX Why here? */
1011 usblp->rcomplete = 0;
1012 spin_unlock_irqrestore(&usblp->lock, flags);
1013 if ((rc = usb_submit_urb(urb, GFP_KERNEL)) < 0) {
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -07001014 dev_dbg(&usblp->intf->dev, "error submitting urb (%d)\n", rc);
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001015 spin_lock_irqsave(&usblp->lock, flags);
1016 usblp->rstatus = rc;
1017 usblp->rcomplete = 1;
1018 spin_unlock_irqrestore(&usblp->lock, flags);
1019 goto raise_submit;
1020 }
1021
1022 return 0;
1023
1024raise_submit:
1025 usb_unanchor_urb(urb);
1026 usb_free_urb(urb);
1027raise_urb:
1028 return rc;
1029}
1030
1031/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032 * Checks for printers that have quirks, such as requiring unidirectional
1033 * communication but reporting bidirectional; currently some HP printers
1034 * have this flaw (HP 810, 880, 895, etc.), or needing an init string
1035 * sent at each open (like some Epsons).
1036 * Returns 1 if found, 0 if not found.
1037 *
1038 * HP recommended that we use the bidirectional interface but
1039 * don't attempt any bulk IN transfers from the IN endpoint.
1040 * Here's some more detail on the problem:
1041 * The problem is not that it isn't bidirectional though. The problem
1042 * is that if you request a device ID, or status information, while
1043 * the buffers are full, the return data will end up in the print data
1044 * buffer. For example if you make sure you never request the device ID
1045 * while you are sending print data, and you don't try to query the
1046 * printer status every couple of milliseconds, you will probably be OK.
1047 */
Nicolas Kaiser916de022010-06-25 20:25:37 +02001048static unsigned int usblp_quirks(__u16 vendor, __u16 product)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001049{
1050 int i;
1051
1052 for (i = 0; quirk_printers[i].vendorId; i++) {
1053 if (vendor == quirk_printers[i].vendorId &&
1054 product == quirk_printers[i].productId)
1055 return quirk_printers[i].quirks;
Nicolas Kaiser916de022010-06-25 20:25:37 +02001056 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057 return 0;
1058}
1059
Luiz Fernando N. Capitulino066202d2006-08-05 20:37:11 -03001060static const struct file_operations usblp_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061 .owner = THIS_MODULE,
1062 .read = usblp_read,
1063 .write = usblp_write,
1064 .poll = usblp_poll,
Pete Zaitcev318e4792005-12-21 17:03:24 -08001065 .unlocked_ioctl = usblp_ioctl,
1066 .compat_ioctl = usblp_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067 .open = usblp_open,
1068 .release = usblp_release,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001069 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001070};
1071
Al Viro2c9ede52011-07-23 20:24:48 -04001072static char *usblp_devnode(struct device *dev, umode_t *mode)
Kay Sieversf7a386c2009-04-30 15:23:42 +02001073{
1074 return kasprintf(GFP_KERNEL, "usb/%s", dev_name(dev));
1075}
1076
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077static struct usb_class_driver usblp_class = {
Greg Kroah-Hartmand6e5bcf2005-06-20 21:15:16 -07001078 .name = "lp%d",
Kay Sieverse454cea2009-09-18 23:01:12 +02001079 .devnode = usblp_devnode,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001080 .fops = &usblp_fops,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081 .minor_base = USBLP_MINOR_BASE,
1082};
1083
David Woodhousea9714c82005-12-23 16:41:41 +00001084static ssize_t usblp_show_ieee1284_id(struct device *dev, struct device_attribute *attr, char *buf)
1085{
1086 struct usb_interface *intf = to_usb_interface(dev);
Nicolas Kaiser916de022010-06-25 20:25:37 +02001087 struct usblp *usblp = usb_get_intfdata(intf);
David Woodhousea9714c82005-12-23 16:41:41 +00001088
1089 if (usblp->device_id_string[0] == 0 &&
1090 usblp->device_id_string[1] == 0)
1091 return 0;
1092
1093 return sprintf(buf, "%s", usblp->device_id_string+2);
1094}
1095
1096static DEVICE_ATTR(ieee1284_id, S_IRUGO, usblp_show_ieee1284_id, NULL);
1097
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098static int usblp_probe(struct usb_interface *intf,
1099 const struct usb_device_id *id)
1100{
Nicolas Kaiser916de022010-06-25 20:25:37 +02001101 struct usb_device *dev = interface_to_usbdev(intf);
Julia Lawall49b707b2008-07-16 18:00:42 +02001102 struct usblp *usblp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103 int protocol;
1104 int retval;
1105
1106 /* Malloc and start initializing usblp structure so we can use it
1107 * directly. */
Julia Lawall49b707b2008-07-16 18:00:42 +02001108 usblp = kzalloc(sizeof(struct usblp), GFP_KERNEL);
1109 if (!usblp) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001110 retval = -ENOMEM;
Julia Lawall49b707b2008-07-16 18:00:42 +02001111 goto abort_ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113 usblp->dev = dev;
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001114 mutex_init(&usblp->wmut);
Nicolas Kaiser916de022010-06-25 20:25:37 +02001115 mutex_init(&usblp->mut);
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001116 spin_lock_init(&usblp->lock);
1117 init_waitqueue_head(&usblp->rwait);
1118 init_waitqueue_head(&usblp->wwait);
1119 init_usb_anchor(&usblp->urbs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120 usblp->ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
1121 usblp->intf = intf;
1122
Linus Torvalds1da177e2005-04-16 15:20:36 -07001123 /* Malloc device ID string buffer to the largest expected length,
1124 * since we can re-query it on an ioctl and a dynamic string
1125 * could change in length. */
1126 if (!(usblp->device_id_string = kmalloc(USBLP_DEVICE_ID_SIZE, GFP_KERNEL))) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001127 retval = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128 goto abort;
1129 }
1130
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001131 /*
1132 * Allocate read buffer. We somewhat wastefully
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133 * malloc both regardless of bidirectionality, because the
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001134 * alternate setting can be changed later via an ioctl.
1135 */
1136 if (!(usblp->readbuf = kmalloc(USBLP_BUF_SIZE_IN, GFP_KERNEL))) {
1137 retval = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138 goto abort;
1139 }
1140
1141 /* Allocate buffer for printer status */
1142 usblp->statusbuf = kmalloc(STATUS_BUF_SIZE, GFP_KERNEL);
1143 if (!usblp->statusbuf) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001144 retval = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001145 goto abort;
1146 }
1147
1148 /* Lookup quirks for this printer. */
1149 usblp->quirks = usblp_quirks(
1150 le16_to_cpu(dev->descriptor.idVendor),
1151 le16_to_cpu(dev->descriptor.idProduct));
1152
1153 /* Analyze and pick initial alternate settings and endpoints. */
1154 protocol = usblp_select_alts(usblp);
1155 if (protocol < 0) {
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -07001156 dev_dbg(&intf->dev,
1157 "incompatible printer-class device 0x%4.4X/0x%4.4X\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158 le16_to_cpu(dev->descriptor.idVendor),
1159 le16_to_cpu(dev->descriptor.idProduct));
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001160 retval = -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001161 goto abort;
1162 }
1163
1164 /* Setup the selected alternate setting and endpoints. */
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001165 if (usblp_set_protocol(usblp, protocol) < 0) {
1166 retval = -ENODEV; /* ->probe isn't ->ioctl */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167 goto abort;
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001168 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169
1170 /* Retrieve and store the device ID string. */
1171 usblp_cache_device_id_string(usblp);
Greg Kroah-Hartman96cede52006-08-28 11:43:25 -07001172 retval = device_create_file(&intf->dev, &dev_attr_ieee1284_id);
1173 if (retval)
1174 goto abort_intfdata;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175
1176#ifdef DEBUG
1177 usblp_check_status(usblp, 0);
1178#endif
1179
Nicolas Kaiser916de022010-06-25 20:25:37 +02001180 usb_set_intfdata(intf, usblp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181
1182 usblp->present = 1;
1183
1184 retval = usb_register_dev(intf, &usblp_class);
1185 if (retval) {
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -07001186 dev_err(&intf->dev,
1187 "usblp: Not able to get a minor (base %u, slice default): %d\n",
1188 USBLP_MINOR_BASE, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001189 goto abort_intfdata;
1190 }
1191 usblp->minor = intf->minor;
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -07001192 dev_info(&intf->dev,
1193 "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 +00001194 usblp->minor, usblp->bidir ? "Bi" : "Uni", dev->devnum,
1195 usblp->ifnum,
1196 usblp->protocol[usblp->current_protocol].alt_setting,
1197 usblp->current_protocol,
1198 le16_to_cpu(usblp->dev->descriptor.idVendor),
1199 le16_to_cpu(usblp->dev->descriptor.idProduct));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200
1201 return 0;
1202
1203abort_intfdata:
Nicolas Kaiser916de022010-06-25 20:25:37 +02001204 usb_set_intfdata(intf, NULL);
David Woodhousea9714c82005-12-23 16:41:41 +00001205 device_remove_file(&intf->dev, &dev_attr_ieee1284_id);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001206abort:
Julia Lawall49b707b2008-07-16 18:00:42 +02001207 kfree(usblp->readbuf);
1208 kfree(usblp->statusbuf);
1209 kfree(usblp->device_id_string);
1210 kfree(usblp);
1211abort_ret:
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001212 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213}
1214
1215/*
1216 * We are a "new" style driver with usb_device_id table,
1217 * but our requirements are too intricate for simple match to handle.
1218 *
1219 * The "proto_bias" option may be used to specify the preferred protocol
Krzysztof Opasiak298b9922015-06-22 15:50:22 +02001220 * for all USB printers (1=USB_CLASS_PRINTER/1/1, 2=USB_CLASS_PRINTER/1/2,
1221 * 3=USB_CLASS_PRINTER/1/3). If the device supports the preferred protocol,
1222 * then we bind to it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223 *
Krzysztof Opasiak298b9922015-06-22 15:50:22 +02001224 * The best interface for us is USB_CLASS_PRINTER/1/2, because it
1225 * is compatible with a stream of characters. If we find it, we bind to it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226 *
1227 * Note that the people from hpoj.sourceforge.net need to be able to
Krzysztof Opasiak298b9922015-06-22 15:50:22 +02001228 * bind to USB_CLASS_PRINTER/1/3 (MLC/1284.4), so we provide them ioctls
1229 * for this purpose.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230 *
Krzysztof Opasiak298b9922015-06-22 15:50:22 +02001231 * Failing USB_CLASS_PRINTER/1/2, we look for USB_CLASS_PRINTER/1/3,
1232 * even though it's probably not stream-compatible, because this matches
1233 * the behaviour of the old code.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234 *
Krzysztof Opasiak298b9922015-06-22 15:50:22 +02001235 * If nothing else, we bind to USB_CLASS_PRINTER/1/1
1236 * - the unidirectional interface.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237 */
1238static int usblp_select_alts(struct usblp *usblp)
1239{
1240 struct usb_interface *if_alt;
1241 struct usb_host_interface *ifd;
Johan Hovold53708602017-03-17 11:35:50 +01001242 struct usb_endpoint_descriptor *epwrite, *epread;
1243 int p, i;
1244 int res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245
1246 if_alt = usblp->intf;
1247
1248 for (p = 0; p < USBLP_MAX_PROTOCOLS; p++)
1249 usblp->protocol[p].alt_setting = -1;
1250
1251 /* Find out what we have. */
1252 for (i = 0; i < if_alt->num_altsetting; i++) {
1253 ifd = &if_alt->altsetting[i];
1254
Krzysztof Opasiak298b9922015-06-22 15:50:22 +02001255 if (ifd->desc.bInterfaceClass != USB_CLASS_PRINTER ||
1256 ifd->desc.bInterfaceSubClass != 1)
Alan Stern5ec71db2007-03-16 15:53:07 -04001257 if (!(usblp->quirks & USBLP_QUIRK_BAD_CLASS))
1258 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001259
1260 if (ifd->desc.bInterfaceProtocol < USBLP_FIRST_PROTOCOL ||
1261 ifd->desc.bInterfaceProtocol > USBLP_LAST_PROTOCOL)
1262 continue;
1263
Johan Hovold53708602017-03-17 11:35:50 +01001264 /* Look for the expected bulk endpoints. */
1265 if (ifd->desc.bInterfaceProtocol > 1) {
1266 res = usb_find_common_endpoints(ifd,
1267 &epread, &epwrite, NULL, NULL);
1268 } else {
1269 epread = NULL;
1270 res = usb_find_bulk_out_endpoint(ifd, &epwrite);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271 }
1272
1273 /* Ignore buggy hardware without the right endpoints. */
Johan Hovold53708602017-03-17 11:35:50 +01001274 if (res)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275 continue;
1276
Johan Hovold53708602017-03-17 11:35:50 +01001277 /* Turn off reads for buggy bidirectional printers. */
1278 if (usblp->quirks & USBLP_QUIRK_BIDIR) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001279 printk(KERN_INFO "usblp%d: Disabling reads from "
1280 "problematic bidirectional printer\n",
1281 usblp->minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001282 epread = NULL;
1283 }
1284
1285 usblp->protocol[ifd->desc.bInterfaceProtocol].alt_setting =
1286 ifd->desc.bAlternateSetting;
1287 usblp->protocol[ifd->desc.bInterfaceProtocol].epwrite = epwrite;
1288 usblp->protocol[ifd->desc.bInterfaceProtocol].epread = epread;
1289 }
1290
1291 /* If our requested protocol is supported, then use it. */
1292 if (proto_bias >= USBLP_FIRST_PROTOCOL &&
1293 proto_bias <= USBLP_LAST_PROTOCOL &&
1294 usblp->protocol[proto_bias].alt_setting != -1)
1295 return proto_bias;
1296
1297 /* Ordering is important here. */
1298 if (usblp->protocol[2].alt_setting != -1)
1299 return 2;
1300 if (usblp->protocol[1].alt_setting != -1)
1301 return 1;
1302 if (usblp->protocol[3].alt_setting != -1)
1303 return 3;
1304
1305 /* If nothing is available, then don't bind to this device. */
1306 return -1;
1307}
1308
1309static int usblp_set_protocol(struct usblp *usblp, int protocol)
1310{
1311 int r, alts;
1312
1313 if (protocol < USBLP_FIRST_PROTOCOL || protocol > USBLP_LAST_PROTOCOL)
1314 return -EINVAL;
1315
1316 alts = usblp->protocol[protocol].alt_setting;
1317 if (alts < 0)
1318 return -EINVAL;
1319 r = usb_set_interface(usblp->dev, usblp->ifnum, alts);
1320 if (r < 0) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001321 printk(KERN_ERR "usblp: can't set desired altsetting %d on interface %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001322 alts, usblp->ifnum);
1323 return r;
1324 }
1325
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326 usblp->bidir = (usblp->protocol[protocol].epread != NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327 usblp->current_protocol = protocol;
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -07001328 dev_dbg(&usblp->intf->dev, "usblp%d set protocol %d\n",
1329 usblp->minor, protocol);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330 return 0;
1331}
1332
1333/* Retrieves and caches device ID string.
1334 * Returns length, including length bytes but not null terminator.
1335 * On error, returns a negative errno value. */
1336static int usblp_cache_device_id_string(struct usblp *usblp)
1337{
1338 int err, length;
1339
1340 err = usblp_get_id(usblp, 0, usblp->device_id_string, USBLP_DEVICE_ID_SIZE - 1);
1341 if (err < 0) {
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -07001342 dev_dbg(&usblp->intf->dev,
1343 "usblp%d: error = %d reading IEEE-1284 Device ID string\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344 usblp->minor, err);
1345 usblp->device_id_string[0] = usblp->device_id_string[1] = '\0';
1346 return -EIO;
1347 }
1348
1349 /* First two bytes are length in big-endian.
1350 * They count themselves, and we copy them into
1351 * the user's buffer. */
1352 length = be16_to_cpu(*((__be16 *)usblp->device_id_string));
1353 if (length < 2)
1354 length = 2;
1355 else if (length >= USBLP_DEVICE_ID_SIZE)
1356 length = USBLP_DEVICE_ID_SIZE - 1;
1357 usblp->device_id_string[length] = '\0';
1358
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -07001359 dev_dbg(&usblp->intf->dev, "usblp%d Device ID string [len=%d]=\"%s\"\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 usblp->minor, length, &usblp->device_id_string[2]);
1361
1362 return length;
1363}
1364
1365static void usblp_disconnect(struct usb_interface *intf)
1366{
Nicolas Kaiser916de022010-06-25 20:25:37 +02001367 struct usblp *usblp = usb_get_intfdata(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368
1369 usb_deregister_dev(intf, &usblp_class);
1370
1371 if (!usblp || !usblp->dev) {
Greg Kroah-Hartman9908a322008-08-14 09:37:34 -07001372 dev_err(&intf->dev, "bogus disconnect\n");
Nicolas Kaiser916de022010-06-25 20:25:37 +02001373 BUG();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374 }
1375
David Woodhousea9714c82005-12-23 16:41:41 +00001376 device_remove_file(&intf->dev, &dev_attr_ieee1284_id);
1377
Nicolas Kaiser916de022010-06-25 20:25:37 +02001378 mutex_lock(&usblp_mutex);
1379 mutex_lock(&usblp->mut);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380 usblp->present = 0;
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001381 wake_up(&usblp->wwait);
1382 wake_up(&usblp->rwait);
Nicolas Kaiser916de022010-06-25 20:25:37 +02001383 usb_set_intfdata(intf, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384
1385 usblp_unlink_urbs(usblp);
Nicolas Kaiser916de022010-06-25 20:25:37 +02001386 mutex_unlock(&usblp->mut);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387
1388 if (!usblp->used)
Nicolas Kaiser916de022010-06-25 20:25:37 +02001389 usblp_cleanup(usblp);
1390 mutex_unlock(&usblp_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001391}
1392
Oliver Neukum3a90f812009-12-28 00:52:17 +01001393static int usblp_suspend(struct usb_interface *intf, pm_message_t message)
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
Oliver Neukum516077c2006-10-05 09:04:11 +02001397 usblp_unlink_urbs(usblp);
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001398#if 0 /* XXX Do we want this? What if someone is reading, should we fail? */
1399 /* not strictly necessary, but just in case */
1400 wake_up(&usblp->wwait);
1401 wake_up(&usblp->rwait);
1402#endif
Oliver Neukum516077c2006-10-05 09:04:11 +02001403
1404 return 0;
1405}
1406
Oliver Neukum3a90f812009-12-28 00:52:17 +01001407static int usblp_resume(struct usb_interface *intf)
Oliver Neukum516077c2006-10-05 09:04:11 +02001408{
Nicolas Kaiser916de022010-06-25 20:25:37 +02001409 struct usblp *usblp = usb_get_intfdata(intf);
Oliver Neukum516077c2006-10-05 09:04:11 +02001410 int r;
1411
Nicolas Kaiser916de022010-06-25 20:25:37 +02001412 r = handle_bidir(usblp);
Oliver Neukum516077c2006-10-05 09:04:11 +02001413
Oliver Neukum516077c2006-10-05 09:04:11 +02001414 return r;
1415}
1416
Németh Márton6ef48522010-01-10 15:33:45 +01001417static const struct usb_device_id usblp_ids[] = {
Krzysztof Opasiak298b9922015-06-22 15:50:22 +02001418 { USB_DEVICE_INFO(USB_CLASS_PRINTER, 1, 1) },
1419 { USB_DEVICE_INFO(USB_CLASS_PRINTER, 1, 2) },
1420 { USB_DEVICE_INFO(USB_CLASS_PRINTER, 1, 3) },
1421 { USB_INTERFACE_INFO(USB_CLASS_PRINTER, 1, 1) },
1422 { USB_INTERFACE_INFO(USB_CLASS_PRINTER, 1, 2) },
1423 { USB_INTERFACE_INFO(USB_CLASS_PRINTER, 1, 3) },
Alan Stern5ec71db2007-03-16 15:53:07 -04001424 { USB_DEVICE(0x04b8, 0x0202) }, /* Seiko Epson Receipt Printer M129C */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425 { } /* Terminating entry */
1426};
1427
Nicolas Kaiser916de022010-06-25 20:25:37 +02001428MODULE_DEVICE_TABLE(usb, usblp_ids);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429
1430static struct usb_driver usblp_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431 .name = "usblp",
1432 .probe = usblp_probe,
1433 .disconnect = usblp_disconnect,
Oliver Neukum516077c2006-10-05 09:04:11 +02001434 .suspend = usblp_suspend,
1435 .resume = usblp_resume,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436 .id_table = usblp_ids,
Oliver Neukumd0532182007-01-18 15:06:07 +01001437 .supports_autosuspend = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001438};
1439
Greg Kroah-Hartman65db4302011-11-18 09:34:02 -08001440module_usb_driver(usblp_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001441
Nicolas Kaiser916de022010-06-25 20:25:37 +02001442MODULE_AUTHOR(DRIVER_AUTHOR);
1443MODULE_DESCRIPTION(DRIVER_DESC);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444module_param(proto_bias, int, S_IRUGO | S_IWUSR);
1445MODULE_PARM_DESC(proto_bias, "Favourite protocol number");
1446MODULE_LICENSE("GPL");