blob: 084c48c5848fc90354216254ffbd48c17a7be030 [file] [log] [blame]
Greg Kroah-Hartman5fd54ac2017-11-03 11:28:30 +01001// SPDX-License-Identifier: GPL-2.0+
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
Pete Zaitcev317c67b2007-06-21 12:44:56 -07003 * usblp.c
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
5 * Copyright (c) 1999 Michael Gee <michael@linuxspecific.com>
Pavel Macheka2531292010-07-18 14:27:13 +02006 * Copyright (c) 1999 Pavel Machek <pavel@ucw.cz>
Adrian Bunkf4b09eb2006-01-03 13:37:51 +01007 * Copyright (c) 2000 Randy Dunlap <rdunlap@xenotime.net>
Linus Torvalds1da177e2005-04-16 15:20:36 -07008 * Copyright (c) 2000 Vojtech Pavlik <vojtech@suse.cz>
9 # Copyright (c) 2001 Pete Zaitcev <zaitcev@redhat.com>
10 # Copyright (c) 2001 David Paschal <paschal@rcsis.com>
Oliver Neukum8e695cd2006-01-07 21:35:20 +010011 * Copyright (c) 2006 Oliver Neukum <oliver@neukum.name>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012 *
13 * USB Printer Device Class driver for USB printers and printer cables
14 *
15 * Sponsored by SuSE
16 *
17 * ChangeLog:
18 * v0.1 - thorough cleaning, URBification, almost a rewrite
19 * v0.2 - some more cleanups
20 * v0.3 - cleaner again, waitqueue fixes
21 * v0.4 - fixes in unidirectional mode
22 * v0.5 - add DEVICE_ID string support
23 * v0.6 - never time out
24 * v0.7 - fixed bulk-IN read and poll (David Paschal)
25 * v0.8 - add devfs support
26 * v0.9 - fix unplug-while-open paths
27 * v0.10- remove sleep_on, fix error on oom (oliver@neukum.org)
28 * v0.11 - add proto_bias option (Pete Zaitcev)
29 * v0.12 - add hpoj.sourceforge.net ioctls (David Paschal)
30 * v0.13 - alloc space for statusbuf (<status> not on stack);
Daniel Mack997ea582010-04-12 13:17:25 +020031 * use usb_alloc_coherent() for read buf & write buf;
Pete Zaitcev283face2007-08-13 22:54:29 -070032 * none - Maintained in Linux kernel after v0.13
Linus Torvalds1da177e2005-04-16 15:20:36 -070033 */
34
Linus Torvalds1da177e2005-04-16 15:20:36 -070035#include <linux/module.h>
36#include <linux/kernel.h>
Ingo Molnar174cd4b2017-02-02 19:15:33 +010037#include <linux/sched/signal.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070038#include <linux/signal.h>
39#include <linux/poll.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070040#include <linux/slab.h>
41#include <linux/lp.h>
Arjan van de Ven4186ecf2006-01-11 15:55:29 +010042#include <linux/mutex.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070043#undef DEBUG
44#include <linux/usb.h>
Krzysztof Opasiak298b9922015-06-22 15:50:22 +020045#include <linux/usb/ch9.h>
Manuel Zerpies305e7be2011-06-16 14:15:54 +020046#include <linux/ratelimit.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070047
48/*
49 * Version Information
50 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070051#define DRIVER_AUTHOR "Michael Gee, Pavel Machek, Vojtech Pavlik, Randy Dunlap, Pete Zaitcev, David Paschal"
52#define DRIVER_DESC "USB Printer Device Class driver"
53
54#define USBLP_BUF_SIZE 8192
Pete Zaitcev317c67b2007-06-21 12:44:56 -070055#define USBLP_BUF_SIZE_IN 1024
Linus Torvalds1da177e2005-04-16 15:20:36 -070056#define USBLP_DEVICE_ID_SIZE 1024
57
58/* ioctls: */
Linus Torvalds1da177e2005-04-16 15:20:36 -070059#define IOCNR_GET_DEVICE_ID 1
60#define IOCNR_GET_PROTOCOLS 2
61#define IOCNR_SET_PROTOCOL 3
62#define IOCNR_HP_SET_CHANNEL 4
63#define IOCNR_GET_BUS_ADDRESS 5
64#define IOCNR_GET_VID_PID 6
65#define IOCNR_SOFT_RESET 7
66/* Get device_id string: */
67#define LPIOC_GET_DEVICE_ID(len) _IOC(_IOC_READ, 'P', IOCNR_GET_DEVICE_ID, len)
Krzysztof Opasiak298b9922015-06-22 15:50:22 +020068/* The following ioctls were added for http://hpoj.sourceforge.net:
69 * Get two-int array:
70 * [0]=current protocol
71 * (1=USB_CLASS_PRINTER/1/1, 2=USB_CLASS_PRINTER/1/2,
72 * 3=USB_CLASS_PRINTER/1/3),
73 * [1]=supported protocol mask (mask&(1<<n)!=0 means
74 * USB_CLASS_PRINTER/1/n supported):
75 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070076#define LPIOC_GET_PROTOCOLS(len) _IOC(_IOC_READ, 'P', IOCNR_GET_PROTOCOLS, len)
Krzysztof Opasiak298b9922015-06-22 15:50:22 +020077/*
78 * Set protocol
79 * (arg: 1=USB_CLASS_PRINTER/1/1, 2=USB_CLASS_PRINTER/1/2,
80 * 3=USB_CLASS_PRINTER/1/3):
81 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070082#define LPIOC_SET_PROTOCOL _IOC(_IOC_WRITE, 'P', IOCNR_SET_PROTOCOL, 0)
83/* Set channel number (HP Vendor-specific command): */
84#define LPIOC_HP_SET_CHANNEL _IOC(_IOC_WRITE, 'P', IOCNR_HP_SET_CHANNEL, 0)
85/* Get two-int array: [0]=bus number, [1]=device address: */
86#define LPIOC_GET_BUS_ADDRESS(len) _IOC(_IOC_READ, 'P', IOCNR_GET_BUS_ADDRESS, len)
87/* Get two-int array: [0]=vendor ID, [1]=product ID: */
88#define LPIOC_GET_VID_PID(len) _IOC(_IOC_READ, 'P', IOCNR_GET_VID_PID, len)
89/* Perform class specific soft reset */
90#define LPIOC_SOFT_RESET _IOC(_IOC_NONE, 'P', IOCNR_SOFT_RESET, 0);
91
92/*
93 * A DEVICE_ID string may include the printer's serial number.
94 * It should end with a semi-colon (';').
95 * An example from an HP 970C DeskJet printer is (this is one long string,
96 * with the serial number changed):
97MFG: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: ;
98 */
99
100/*
101 * USB Printer Requests
102 */
103
104#define USBLP_REQ_GET_ID 0x00
105#define USBLP_REQ_GET_STATUS 0x01
106#define USBLP_REQ_RESET 0x02
107#define USBLP_REQ_HP_CHANNEL_CHANGE_REQUEST 0x00 /* HP Vendor-specific */
108
109#define USBLP_MINORS 16
110#define USBLP_MINOR_BASE 0
111
Pete Zaitcev283face2007-08-13 22:54:29 -0700112#define USBLP_CTL_TIMEOUT 5000 /* 5 seconds */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113
114#define USBLP_FIRST_PROTOCOL 1
115#define USBLP_LAST_PROTOCOL 3
116#define USBLP_MAX_PROTOCOLS (USBLP_LAST_PROTOCOL+1)
117
118/*
119 * some arbitrary status buffer size;
120 * need a status buffer that is allocated via kmalloc(), not on stack
121 */
122#define STATUS_BUF_SIZE 8
123
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700124/*
125 * Locks down the locking order:
126 * ->wmut locks wstatus.
127 * ->mut locks the whole usblp, except [rw]complete, and thus, by indirection,
128 * [rw]status. We only touch status when we know the side idle.
129 * ->lock locks what interrupt accesses.
130 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131struct usblp {
Nicolas Kaiser916de022010-06-25 20:25:37 +0200132 struct usb_device *dev; /* USB device */
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700133 struct mutex wmut;
134 struct mutex mut;
135 spinlock_t lock; /* locks rcomplete, wcomplete */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 char *readbuf; /* read transfer_buffer */
137 char *statusbuf; /* status transfer_buffer */
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700138 struct usb_anchor urbs;
139 wait_queue_head_t rwait, wwait;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140 int readcount; /* Counter for reads */
141 int ifnum; /* Interface number */
142 struct usb_interface *intf; /* The interface */
Krzysztof Opasiak298b9922015-06-22 15:50:22 +0200143 /*
144 * Alternate-setting numbers and endpoints for each protocol
145 * (USB_CLASS_PRINTER/1/{index=1,2,3}) that the device supports:
146 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 struct {
148 int alt_setting;
149 struct usb_endpoint_descriptor *epwrite;
150 struct usb_endpoint_descriptor *epread;
151 } protocol[USBLP_MAX_PROTOCOLS];
152 int current_protocol;
153 int minor; /* minor number of device */
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700154 int wcomplete, rcomplete;
155 int wstatus; /* bytes written or error */
156 int rstatus; /* bytes ready or error */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 unsigned int quirks; /* quirks flags */
Pete Zaitcev7f477352007-07-23 01:58:15 -0700158 unsigned int flags; /* mode flags */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 unsigned char used; /* True if open */
160 unsigned char present; /* True if not disconnected */
161 unsigned char bidir; /* interface is bidirectional */
Pete Zaitcev7f477352007-07-23 01:58:15 -0700162 unsigned char no_paper; /* Paper Out happened */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 unsigned char *device_id_string; /* IEEE 1284 DEVICE ID string (ptr) */
164 /* first 2 bytes are (big-endian) length */
165};
166
167#ifdef DEBUG
Nicolas Kaiser916de022010-06-25 20:25:37 +0200168static void usblp_dump(struct usblp *usblp)
169{
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -0700170 struct device *dev = &usblp->intf->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 int p;
172
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -0700173 dev_dbg(dev, "usblp=0x%p\n", usblp);
174 dev_dbg(dev, "dev=0x%p\n", usblp->dev);
175 dev_dbg(dev, "present=%d\n", usblp->present);
176 dev_dbg(dev, "readbuf=0x%p\n", usblp->readbuf);
177 dev_dbg(dev, "readcount=%d\n", usblp->readcount);
178 dev_dbg(dev, "ifnum=%d\n", usblp->ifnum);
179 for (p = USBLP_FIRST_PROTOCOL; p <= USBLP_LAST_PROTOCOL; p++) {
180 dev_dbg(dev, "protocol[%d].alt_setting=%d\n", p,
181 usblp->protocol[p].alt_setting);
182 dev_dbg(dev, "protocol[%d].epwrite=%p\n", p,
183 usblp->protocol[p].epwrite);
184 dev_dbg(dev, "protocol[%d].epread=%p\n", p,
185 usblp->protocol[p].epread);
186 }
187 dev_dbg(dev, "current_protocol=%d\n", usblp->current_protocol);
188 dev_dbg(dev, "minor=%d\n", usblp->minor);
189 dev_dbg(dev, "wstatus=%d\n", usblp->wstatus);
190 dev_dbg(dev, "rstatus=%d\n", usblp->rstatus);
191 dev_dbg(dev, "quirks=%d\n", usblp->quirks);
192 dev_dbg(dev, "used=%d\n", usblp->used);
193 dev_dbg(dev, "bidir=%d\n", usblp->bidir);
194 dev_dbg(dev, "device_id_string=\"%s\"\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 usblp->device_id_string ?
196 usblp->device_id_string + 2 :
197 (unsigned char *)"(null)");
198}
199#endif
200
201/* Quirks: various printer quirks are handled by this table & its flags. */
202
203struct quirk_printer_struct {
204 __u16 vendorId;
205 __u16 productId;
206 unsigned int quirks;
207};
208
209#define USBLP_QUIRK_BIDIR 0x1 /* reports bidir but requires unidirectional mode (no INs/reads) */
210#define USBLP_QUIRK_USB_INIT 0x2 /* needs vendor USB init string */
Alan Stern5ec71db2007-03-16 15:53:07 -0400211#define USBLP_QUIRK_BAD_CLASS 0x4 /* descriptor uses vendor-specific Class or SubClass */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212
Arjan van de Ven4c4c9432005-11-29 09:43:42 +0100213static const struct quirk_printer_struct quirk_printers[] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 { 0x03f0, 0x0004, USBLP_QUIRK_BIDIR }, /* HP DeskJet 895C */
215 { 0x03f0, 0x0104, USBLP_QUIRK_BIDIR }, /* HP DeskJet 880C */
216 { 0x03f0, 0x0204, USBLP_QUIRK_BIDIR }, /* HP DeskJet 815C */
217 { 0x03f0, 0x0304, USBLP_QUIRK_BIDIR }, /* HP DeskJet 810C/812C */
218 { 0x03f0, 0x0404, USBLP_QUIRK_BIDIR }, /* HP DeskJet 830C */
219 { 0x03f0, 0x0504, USBLP_QUIRK_BIDIR }, /* HP DeskJet 885C */
Nicolas Kaiser916de022010-06-25 20:25:37 +0200220 { 0x03f0, 0x0604, USBLP_QUIRK_BIDIR }, /* HP DeskJet 840C */
221 { 0x03f0, 0x0804, USBLP_QUIRK_BIDIR }, /* HP DeskJet 816C */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 { 0x03f0, 0x1104, USBLP_QUIRK_BIDIR }, /* HP Deskjet 959C */
223 { 0x0409, 0xefbe, USBLP_QUIRK_BIDIR }, /* NEC Picty900 (HP OEM) */
224 { 0x0409, 0xbef4, USBLP_QUIRK_BIDIR }, /* NEC Picty760 (HP OEM) */
225 { 0x0409, 0xf0be, USBLP_QUIRK_BIDIR }, /* NEC Picty920 (HP OEM) */
226 { 0x0409, 0xf1be, USBLP_QUIRK_BIDIR }, /* NEC Picty800 (HP OEM) */
Martin Williges4f45d0382006-12-28 20:52:10 +0100227 { 0x0482, 0x0010, USBLP_QUIRK_BIDIR }, /* Kyocera Mita FS 820, by zut <kernel@zut.de> */
Brandon Philips06a743b2009-01-05 08:30:39 -0800228 { 0x04f9, 0x000d, USBLP_QUIRK_BIDIR }, /* Brother Industries, Ltd HL-1440 Laser Printer */
Alan Stern5ec71db2007-03-16 15:53:07 -0400229 { 0x04b8, 0x0202, USBLP_QUIRK_BAD_CLASS }, /* Seiko Epson Receipt Printer M129C */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 { 0, 0 }
231};
232
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700233static int usblp_wwait(struct usblp *usblp, int nonblock);
234static int usblp_wtest(struct usblp *usblp, int nonblock);
235static int usblp_rwait_and_lock(struct usblp *usblp, int nonblock);
236static int usblp_rtest(struct usblp *usblp, int nonblock);
237static int usblp_submit_read(struct usblp *usblp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238static int usblp_select_alts(struct usblp *usblp);
239static int usblp_set_protocol(struct usblp *usblp, int protocol);
240static int usblp_cache_device_id_string(struct usblp *usblp);
241
242/* forward reference to make our lives easier */
243static struct usb_driver usblp_driver;
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100244static DEFINE_MUTEX(usblp_mutex); /* locks the existence of usblp's */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245
246/*
247 * Functions for usblp control messages.
248 */
249
250static int usblp_ctrl_msg(struct usblp *usblp, int request, int type, int dir, int recip, int value, void *buf, int len)
251{
252 int retval;
253 int index = usblp->ifnum;
254
255 /* High byte has the interface index.
256 Low byte has the alternate setting.
257 */
Nicolas Kaiser916de022010-06-25 20:25:37 +0200258 if ((request == USBLP_REQ_GET_ID) && (type == USB_TYPE_CLASS))
259 index = (usblp->ifnum<<8)|usblp->protocol[usblp->current_protocol].alt_setting;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260
261 retval = usb_control_msg(usblp->dev,
262 dir ? usb_rcvctrlpipe(usblp->dev, 0) : usb_sndctrlpipe(usblp->dev, 0),
Pete Zaitcev283face2007-08-13 22:54:29 -0700263 request, type | dir | recip, value, index, buf, len, USBLP_CTL_TIMEOUT);
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -0700264 dev_dbg(&usblp->intf->dev,
265 "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 -0700266 request, !!dir, recip, value, index, len, retval);
267 return retval < 0 ? retval : 0;
268}
269
270#define usblp_read_status(usblp, status)\
271 usblp_ctrl_msg(usblp, USBLP_REQ_GET_STATUS, USB_TYPE_CLASS, USB_DIR_IN, USB_RECIP_INTERFACE, 0, status, 1)
272#define usblp_get_id(usblp, config, id, maxlen)\
273 usblp_ctrl_msg(usblp, USBLP_REQ_GET_ID, USB_TYPE_CLASS, USB_DIR_IN, USB_RECIP_INTERFACE, config, id, maxlen)
274#define usblp_reset(usblp)\
275 usblp_ctrl_msg(usblp, USBLP_REQ_RESET, USB_TYPE_CLASS, USB_DIR_OUT, USB_RECIP_OTHER, 0, NULL, 0)
276
277#define usblp_hp_channel_change_request(usblp, channel, buffer) \
278 usblp_ctrl_msg(usblp, USBLP_REQ_HP_CHANNEL_CHANGE_REQUEST, USB_TYPE_VENDOR, USB_DIR_IN, USB_RECIP_INTERFACE, channel, buffer, 1)
279
280/*
281 * See the description for usblp_select_alts() below for the usage
Mauro Carvalho Chehab21470e32017-04-16 21:51:07 -0300282 * explanation. Look into your /sys/kernel/debug/usb/devices and dmesg in
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 * case of any trouble.
284 */
285static int proto_bias = -1;
286
287/*
288 * URB callback.
289 */
290
David Howells7d12e782006-10-05 14:55:46 +0100291static void usblp_bulk_read(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292{
293 struct usblp *usblp = urb->context;
Greg Kroah-Hartman18ac3012007-07-18 10:58:02 -0700294 int status = urb->status;
Sebastian Andrzej Siewior0f5f7ac2018-06-25 00:08:38 +0200295 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700297 if (usblp->present && usblp->used) {
Greg Kroah-Hartman18ac3012007-07-18 10:58:02 -0700298 if (status)
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700299 printk(KERN_WARNING "usblp%d: "
300 "nonzero read bulk status received: %d\n",
Greg Kroah-Hartman18ac3012007-07-18 10:58:02 -0700301 usblp->minor, status);
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700302 }
Sebastian Andrzej Siewior0f5f7ac2018-06-25 00:08:38 +0200303 spin_lock_irqsave(&usblp->lock, flags);
Greg Kroah-Hartman18ac3012007-07-18 10:58:02 -0700304 if (status < 0)
305 usblp->rstatus = status;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700306 else
307 usblp->rstatus = urb->actual_length;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308 usblp->rcomplete = 1;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700309 wake_up(&usblp->rwait);
Sebastian Andrzej Siewior0f5f7ac2018-06-25 00:08:38 +0200310 spin_unlock_irqrestore(&usblp->lock, flags);
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700311
312 usb_free_urb(urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313}
314
David Howells7d12e782006-10-05 14:55:46 +0100315static void usblp_bulk_write(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316{
317 struct usblp *usblp = urb->context;
Greg Kroah-Hartman18ac3012007-07-18 10:58:02 -0700318 int status = urb->status;
Sebastian Andrzej Siewior0f5f7ac2018-06-25 00:08:38 +0200319 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700321 if (usblp->present && usblp->used) {
Greg Kroah-Hartman18ac3012007-07-18 10:58:02 -0700322 if (status)
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700323 printk(KERN_WARNING "usblp%d: "
324 "nonzero write bulk status received: %d\n",
Greg Kroah-Hartman18ac3012007-07-18 10:58:02 -0700325 usblp->minor, status);
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700326 }
Sebastian Andrzej Siewior0f5f7ac2018-06-25 00:08:38 +0200327 spin_lock_irqsave(&usblp->lock, flags);
Greg Kroah-Hartman18ac3012007-07-18 10:58:02 -0700328 if (status < 0)
329 usblp->wstatus = status;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700330 else
331 usblp->wstatus = urb->actual_length;
Pete Zaitcev7f477352007-07-23 01:58:15 -0700332 usblp->no_paper = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333 usblp->wcomplete = 1;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700334 wake_up(&usblp->wwait);
Sebastian Andrzej Siewior0f5f7ac2018-06-25 00:08:38 +0200335 spin_unlock_irqrestore(&usblp->lock, flags);
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700336
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700337 usb_free_urb(urb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338}
339
340/*
341 * Get and print printer errors.
342 */
343
Arjan van de Ven4c4c9432005-11-29 09:43:42 +0100344static const char *usblp_messages[] = { "ok", "out of paper", "off-line", "on fire" };
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345
346static int usblp_check_status(struct usblp *usblp, int err)
347{
348 unsigned char status, newerr = 0;
349 int error;
350
Pete Zaitcevfc401e62007-08-13 22:50:13 -0700351 mutex_lock(&usblp->mut);
352 if ((error = usblp_read_status(usblp, usblp->statusbuf)) < 0) {
353 mutex_unlock(&usblp->mut);
Manuel Zerpies305e7be2011-06-16 14:15:54 +0200354 printk_ratelimited(KERN_ERR
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700355 "usblp%d: error %d reading printer status\n",
Randy Dunlap0bc8e002005-07-31 20:41:19 -0700356 usblp->minor, error);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 return 0;
358 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 status = *usblp->statusbuf;
Pete Zaitcevfc401e62007-08-13 22:50:13 -0700360 mutex_unlock(&usblp->mut);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361
362 if (~status & LP_PERRORP)
363 newerr = 3;
364 if (status & LP_POUTPA)
365 newerr = 1;
366 if (~status & LP_PSELECD)
367 newerr = 2;
368
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700369 if (newerr != err) {
370 printk(KERN_INFO "usblp%d: %s\n",
371 usblp->minor, usblp_messages[newerr]);
372 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373
374 return newerr;
375}
376
Nicolas Kaiser916de022010-06-25 20:25:37 +0200377static int handle_bidir(struct usblp *usblp)
Oliver Neukum516077c2006-10-05 09:04:11 +0200378{
Oliver Neukum3a90f812009-12-28 00:52:17 +0100379 if (usblp->bidir && usblp->used) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700380 if (usblp_submit_read(usblp) < 0)
Oliver Neukum516077c2006-10-05 09:04:11 +0200381 return -EIO;
Oliver Neukum516077c2006-10-05 09:04:11 +0200382 }
Oliver Neukum516077c2006-10-05 09:04:11 +0200383 return 0;
384}
385
Linus Torvalds1da177e2005-04-16 15:20:36 -0700386/*
387 * File op functions.
388 */
389
390static int usblp_open(struct inode *inode, struct file *file)
391{
392 int minor = iminor(inode);
393 struct usblp *usblp;
394 struct usb_interface *intf;
395 int retval;
396
397 if (minor < 0)
398 return -ENODEV;
399
Nicolas Kaiser916de022010-06-25 20:25:37 +0200400 mutex_lock(&usblp_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401
402 retval = -ENODEV;
403 intf = usb_find_interface(&usblp_driver, minor);
Nicolas Kaiser916de022010-06-25 20:25:37 +0200404 if (!intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 goto out;
Nicolas Kaiser916de022010-06-25 20:25:37 +0200406 usblp = usb_get_intfdata(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 if (!usblp || !usblp->dev || !usblp->present)
408 goto out;
409
410 retval = -EBUSY;
411 if (usblp->used)
412 goto out;
413
414 /*
Pete Zaitcev7f477352007-07-23 01:58:15 -0700415 * We do not implement LP_ABORTOPEN/LPABORTOPEN for two reasons:
416 * - We do not want persistent state which close(2) does not clear
417 * - It is not used anyway, according to CUPS people
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419
Oliver Neukumd0532182007-01-18 15:06:07 +0100420 retval = usb_autopm_get_interface(intf);
421 if (retval < 0)
422 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 usblp->used = 1;
424 file->private_data = usblp;
425
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 usblp->wcomplete = 1; /* we begin writeable */
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700427 usblp->wstatus = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 usblp->rcomplete = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429
Oliver Neukum516077c2006-10-05 09:04:11 +0200430 if (handle_bidir(usblp) < 0) {
Oliver Neukum19028692008-02-12 19:08:30 +0100431 usb_autopm_put_interface(intf);
Pete Zaitcev97cb95d2007-05-24 21:59:19 -0700432 usblp->used = 0;
Oliver Neukum516077c2006-10-05 09:04:11 +0200433 file->private_data = NULL;
434 retval = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 }
436out:
Nicolas Kaiser916de022010-06-25 20:25:37 +0200437 mutex_unlock(&usblp_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438 return retval;
439}
440
Nicolas Kaiser916de022010-06-25 20:25:37 +0200441static void usblp_cleanup(struct usblp *usblp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442{
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700443 printk(KERN_INFO "usblp%d: removed\n", usblp->minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700445 kfree(usblp->readbuf);
Nicolas Kaiser916de022010-06-25 20:25:37 +0200446 kfree(usblp->device_id_string);
447 kfree(usblp->statusbuf);
Johan Hovold7a759192019-10-15 19:55:22 +0200448 usb_put_intf(usblp->intf);
Nicolas Kaiser916de022010-06-25 20:25:37 +0200449 kfree(usblp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450}
451
452static void usblp_unlink_urbs(struct usblp *usblp)
453{
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700454 usb_kill_anchored_urbs(&usblp->urbs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455}
456
457static int usblp_release(struct inode *inode, struct file *file)
458{
459 struct usblp *usblp = file->private_data;
460
Pete Zaitcev7f477352007-07-23 01:58:15 -0700461 usblp->flags &= ~LP_ABORT;
462
Nicolas Kaiser916de022010-06-25 20:25:37 +0200463 mutex_lock(&usblp_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 usblp->used = 0;
Johan Hovold9a315352019-10-01 10:49:06 +0200465 if (usblp->present)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 usblp_unlink_urbs(usblp);
Johan Hovold9a315352019-10-01 10:49:06 +0200467
468 usb_autopm_put_interface(usblp->intf);
469
470 if (!usblp->present) /* finish cleanup from disconnect */
Oliver Neukum296a1932020-05-07 10:58:06 +0200471 usblp_cleanup(usblp); /* any URBs must be dead */
472
Nicolas Kaiser916de022010-06-25 20:25:37 +0200473 mutex_unlock(&usblp_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 return 0;
475}
476
477/* No kernel lock - fine */
Al Viroafc9a422017-07-03 06:39:46 -0400478static __poll_t usblp_poll(struct file *file, struct poll_table_struct *wait)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479{
Al Viroafc9a422017-07-03 06:39:46 -0400480 __poll_t ret;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700481 unsigned long flags;
482
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483 struct usblp *usblp = file->private_data;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700484 /* Should we check file->f_mode & FMODE_WRITE before poll_wait()? */
485 poll_wait(file, &usblp->rwait, wait);
486 poll_wait(file, &usblp->wwait, wait);
487 spin_lock_irqsave(&usblp->lock, flags);
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800488 ret = ((usblp->bidir && usblp->rcomplete) ? EPOLLIN | EPOLLRDNORM : 0) |
489 ((usblp->no_paper || usblp->wcomplete) ? EPOLLOUT | EPOLLWRNORM : 0);
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700490 spin_unlock_irqrestore(&usblp->lock, flags);
491 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492}
493
Pete Zaitcev318e4792005-12-21 17:03:24 -0800494static long usblp_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495{
496 struct usblp *usblp = file->private_data;
497 int length, err, i;
498 unsigned char newChannel;
499 int status;
500 int twoints[2];
501 int retval = 0;
502
Nicolas Kaiser916de022010-06-25 20:25:37 +0200503 mutex_lock(&usblp->mut);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 if (!usblp->present) {
505 retval = -ENODEV;
506 goto done;
507 }
508
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -0700509 dev_dbg(&usblp->intf->dev,
510 "usblp_ioctl: cmd=0x%x (%c nr=%d len=%d dir=%d)\n", cmd,
511 _IOC_TYPE(cmd), _IOC_NR(cmd), _IOC_SIZE(cmd), _IOC_DIR(cmd));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512
513 if (_IOC_TYPE(cmd) == 'P') /* new-style ioctl number */
514
515 switch (_IOC_NR(cmd)) {
516
Nicolas Kaiser916de022010-06-25 20:25:37 +0200517 case IOCNR_GET_DEVICE_ID: /* get the DEVICE_ID string */
518 if (_IOC_DIR(cmd) != _IOC_READ) {
519 retval = -EINVAL;
520 goto done;
521 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522
Nicolas Kaiser916de022010-06-25 20:25:37 +0200523 length = usblp_cache_device_id_string(usblp);
524 if (length < 0) {
525 retval = length;
526 goto done;
527 }
528 if (length > _IOC_SIZE(cmd))
529 length = _IOC_SIZE(cmd); /* truncate */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530
Nicolas Kaiser916de022010-06-25 20:25:37 +0200531 if (copy_to_user((void __user *) arg,
532 usblp->device_id_string,
533 (unsigned long) length)) {
534 retval = -EFAULT;
535 goto done;
536 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537
Nicolas Kaiser916de022010-06-25 20:25:37 +0200538 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539
Nicolas Kaiser916de022010-06-25 20:25:37 +0200540 case IOCNR_GET_PROTOCOLS:
541 if (_IOC_DIR(cmd) != _IOC_READ ||
542 _IOC_SIZE(cmd) < sizeof(twoints)) {
543 retval = -EINVAL;
544 goto done;
545 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546
Nicolas Kaiser916de022010-06-25 20:25:37 +0200547 twoints[0] = usblp->current_protocol;
548 twoints[1] = 0;
549 for (i = USBLP_FIRST_PROTOCOL;
550 i <= USBLP_LAST_PROTOCOL; i++) {
551 if (usblp->protocol[i].alt_setting >= 0)
552 twoints[1] |= (1<<i);
553 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554
Nicolas Kaiser916de022010-06-25 20:25:37 +0200555 if (copy_to_user((void __user *)arg,
556 (unsigned char *)twoints,
557 sizeof(twoints))) {
558 retval = -EFAULT;
559 goto done;
560 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561
Nicolas Kaiser916de022010-06-25 20:25:37 +0200562 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563
Nicolas Kaiser916de022010-06-25 20:25:37 +0200564 case IOCNR_SET_PROTOCOL:
565 if (_IOC_DIR(cmd) != _IOC_WRITE) {
566 retval = -EINVAL;
567 goto done;
568 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569
570#ifdef DEBUG
Nicolas Kaiser916de022010-06-25 20:25:37 +0200571 if (arg == -10) {
572 usblp_dump(usblp);
573 break;
574 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575#endif
576
Nicolas Kaiser916de022010-06-25 20:25:37 +0200577 usblp_unlink_urbs(usblp);
578 retval = usblp_set_protocol(usblp, arg);
579 if (retval < 0) {
580 usblp_set_protocol(usblp,
581 usblp->current_protocol);
582 }
583 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584
Nicolas Kaiser916de022010-06-25 20:25:37 +0200585 case IOCNR_HP_SET_CHANNEL:
586 if (_IOC_DIR(cmd) != _IOC_WRITE ||
587 le16_to_cpu(usblp->dev->descriptor.idVendor) != 0x03F0 ||
588 usblp->quirks & USBLP_QUIRK_BIDIR) {
589 retval = -EINVAL;
590 goto done;
591 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592
Nicolas Kaiser916de022010-06-25 20:25:37 +0200593 err = usblp_hp_channel_change_request(usblp,
594 arg, &newChannel);
595 if (err < 0) {
596 dev_err(&usblp->dev->dev,
597 "usblp%d: error = %d setting "
598 "HP channel\n",
599 usblp->minor, err);
600 retval = -EIO;
601 goto done;
602 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -0700604 dev_dbg(&usblp->intf->dev,
605 "usblp%d requested/got HP channel %ld/%d\n",
Nicolas Kaiser916de022010-06-25 20:25:37 +0200606 usblp->minor, arg, newChannel);
607 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700608
Nicolas Kaiser916de022010-06-25 20:25:37 +0200609 case IOCNR_GET_BUS_ADDRESS:
610 if (_IOC_DIR(cmd) != _IOC_READ ||
611 _IOC_SIZE(cmd) < sizeof(twoints)) {
612 retval = -EINVAL;
613 goto done;
614 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615
Nicolas Kaiser916de022010-06-25 20:25:37 +0200616 twoints[0] = usblp->dev->bus->busnum;
617 twoints[1] = usblp->dev->devnum;
618 if (copy_to_user((void __user *)arg,
619 (unsigned char *)twoints,
620 sizeof(twoints))) {
621 retval = -EFAULT;
622 goto done;
623 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -0700625 dev_dbg(&usblp->intf->dev,
626 "usblp%d is bus=%d, device=%d\n",
Nicolas Kaiser916de022010-06-25 20:25:37 +0200627 usblp->minor, twoints[0], twoints[1]);
628 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629
Nicolas Kaiser916de022010-06-25 20:25:37 +0200630 case IOCNR_GET_VID_PID:
631 if (_IOC_DIR(cmd) != _IOC_READ ||
632 _IOC_SIZE(cmd) < sizeof(twoints)) {
633 retval = -EINVAL;
634 goto done;
635 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636
Nicolas Kaiser916de022010-06-25 20:25:37 +0200637 twoints[0] = le16_to_cpu(usblp->dev->descriptor.idVendor);
638 twoints[1] = le16_to_cpu(usblp->dev->descriptor.idProduct);
639 if (copy_to_user((void __user *)arg,
640 (unsigned char *)twoints,
641 sizeof(twoints))) {
642 retval = -EFAULT;
643 goto done;
644 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -0700646 dev_dbg(&usblp->intf->dev,
647 "usblp%d is VID=0x%4.4X, PID=0x%4.4X\n",
Nicolas Kaiser916de022010-06-25 20:25:37 +0200648 usblp->minor, twoints[0], twoints[1]);
649 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650
Nicolas Kaiser916de022010-06-25 20:25:37 +0200651 case IOCNR_SOFT_RESET:
652 if (_IOC_DIR(cmd) != _IOC_NONE) {
653 retval = -EINVAL;
654 goto done;
655 }
656 retval = usblp_reset(usblp);
657 break;
658 default:
659 retval = -ENOTTY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 }
661 else /* old-style ioctl value */
662 switch (cmd) {
663
Nicolas Kaiser916de022010-06-25 20:25:37 +0200664 case LPGETSTATUS:
Greg Kroah-Hartman2fcdbdf2015-04-30 11:33:06 +0200665 retval = usblp_read_status(usblp, usblp->statusbuf);
666 if (retval) {
Manuel Zerpies305e7be2011-06-16 14:15:54 +0200667 printk_ratelimited(KERN_ERR "usblp%d:"
Nicolas Kaiser916de022010-06-25 20:25:37 +0200668 "failed reading printer status (%d)\n",
669 usblp->minor, retval);
670 retval = -EIO;
671 goto done;
672 }
673 status = *usblp->statusbuf;
674 if (copy_to_user((void __user *)arg, &status, sizeof(int)))
675 retval = -EFAULT;
676 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677
Nicolas Kaiser916de022010-06-25 20:25:37 +0200678 case LPABORT:
679 if (arg)
680 usblp->flags |= LP_ABORT;
681 else
682 usblp->flags &= ~LP_ABORT;
683 break;
Pete Zaitcev7f477352007-07-23 01:58:15 -0700684
Nicolas Kaiser916de022010-06-25 20:25:37 +0200685 default:
686 retval = -ENOTTY;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 }
688
689done:
Nicolas Kaiser916de022010-06-25 20:25:37 +0200690 mutex_unlock(&usblp->mut);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 return retval;
692}
693
Pete Zaitcev42cb9672007-08-14 13:19:16 -0700694static struct urb *usblp_new_writeurb(struct usblp *usblp, int transfer_length)
695{
696 struct urb *urb;
697 char *writebuf;
698
Greg Kroah-Hartman2fcdbdf2015-04-30 11:33:06 +0200699 writebuf = kmalloc(transfer_length, GFP_KERNEL);
700 if (writebuf == NULL)
Pete Zaitcev42cb9672007-08-14 13:19:16 -0700701 return NULL;
Greg Kroah-Hartman2fcdbdf2015-04-30 11:33:06 +0200702 urb = usb_alloc_urb(0, GFP_KERNEL);
703 if (urb == NULL) {
Pete Zaitcev42cb9672007-08-14 13:19:16 -0700704 kfree(writebuf);
705 return NULL;
706 }
707
708 usb_fill_bulk_urb(urb, usblp->dev,
709 usb_sndbulkpipe(usblp->dev,
710 usblp->protocol[usblp->current_protocol].epwrite->bEndpointAddress),
711 writebuf, transfer_length, usblp_bulk_write, usblp);
712 urb->transfer_flags |= URB_FREE_BUFFER;
713
714 return urb;
715}
716
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717static ssize_t usblp_write(struct file *file, const char __user *buffer, size_t count, loff_t *ppos)
718{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719 struct usblp *usblp = file->private_data;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700720 struct urb *writeurb;
721 int rv;
722 int transfer_length;
723 ssize_t writecount = 0;
724
725 if (mutex_lock_interruptible(&usblp->wmut)) {
726 rv = -EINTR;
727 goto raise_biglock;
728 }
729 if ((rv = usblp_wwait(usblp, !!(file->f_flags & O_NONBLOCK))) < 0)
730 goto raise_wait;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731
732 while (writecount < count) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700733 /*
734 * Step 1: Submit next block.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 */
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700736 if ((transfer_length = count - writecount) > USBLP_BUF_SIZE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 transfer_length = USBLP_BUF_SIZE;
738
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700739 rv = -ENOMEM;
Greg Kroah-Hartman2fcdbdf2015-04-30 11:33:06 +0200740 writeurb = usblp_new_writeurb(usblp, transfer_length);
741 if (writeurb == NULL)
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700742 goto raise_urb;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700743 usb_anchor_urb(writeurb, &usblp->urbs);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744
Pete Zaitcev42cb9672007-08-14 13:19:16 -0700745 if (copy_from_user(writeurb->transfer_buffer,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700746 buffer + writecount, transfer_length)) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700747 rv = -EFAULT;
748 goto raise_badaddr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 }
750
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700751 spin_lock_irq(&usblp->lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 usblp->wcomplete = 0;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700753 spin_unlock_irq(&usblp->lock);
754 if ((rv = usb_submit_urb(writeurb, GFP_KERNEL)) < 0) {
755 usblp->wstatus = 0;
756 spin_lock_irq(&usblp->lock);
Pete Zaitcev7f477352007-07-23 01:58:15 -0700757 usblp->no_paper = 0;
Oliver Neukum6c8df792006-10-28 11:36:59 +0200758 usblp->wcomplete = 1;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700759 wake_up(&usblp->wwait);
760 spin_unlock_irq(&usblp->lock);
761 if (rv != -ENOMEM)
762 rv = -EIO;
763 goto raise_submit;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764 }
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700765
766 /*
767 * Step 2: Wait for transfer to end, collect results.
768 */
769 rv = usblp_wwait(usblp, !!(file->f_flags&O_NONBLOCK));
770 if (rv < 0) {
Pete Zaitcev10e48522007-07-10 20:09:58 -0700771 if (rv == -EAGAIN) {
772 /* Presume that it's going to complete well. */
773 writecount += transfer_length;
774 }
Pete Zaitcev7f477352007-07-23 01:58:15 -0700775 if (rv == -ENOSPC) {
776 spin_lock_irq(&usblp->lock);
777 usblp->no_paper = 1; /* Mark for poll(2) */
778 spin_unlock_irq(&usblp->lock);
779 writecount += transfer_length;
780 }
Pete Zaitcev10e48522007-07-10 20:09:58 -0700781 /* Leave URB dangling, to be cleaned on close. */
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700782 goto collect_error;
783 }
784
785 if (usblp->wstatus < 0) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700786 rv = -EIO;
787 goto collect_error;
788 }
789 /*
790 * This is critical: it must be our URB, not other writer's.
791 * The wmut exists mainly to cover us here.
792 */
793 writecount += usblp->wstatus;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794 }
795
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700796 mutex_unlock(&usblp->wmut);
797 return writecount;
798
799raise_submit:
800raise_badaddr:
801 usb_unanchor_urb(writeurb);
802 usb_free_urb(writeurb);
803raise_urb:
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700804raise_wait:
805collect_error: /* Out of raise sequence */
806 mutex_unlock(&usblp->wmut);
807raise_biglock:
808 return writecount ? writecount : rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809}
810
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700811/*
812 * Notice that we fail to restart in a few cases: on EFAULT, on restart
813 * error, etc. This is the historical behaviour. In all such cases we return
814 * EIO, and applications loop in order to get the new read going.
815 */
816static ssize_t usblp_read(struct file *file, char __user *buffer, size_t len, loff_t *ppos)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817{
818 struct usblp *usblp = file->private_data;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700819 ssize_t count;
820 ssize_t avail;
821 int rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822
823 if (!usblp->bidir)
824 return -EINVAL;
825
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700826 rv = usblp_rwait_and_lock(usblp, !!(file->f_flags & O_NONBLOCK));
827 if (rv < 0)
828 return rv;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700830 if ((avail = usblp->rstatus) < 0) {
831 printk(KERN_ERR "usblp%d: error %d reading from printer\n",
832 usblp->minor, (int)avail);
833 usblp_submit_read(usblp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 count = -EIO;
835 goto done;
836 }
837
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700838 count = len < avail - usblp->readcount ? len : avail - usblp->readcount;
839 if (count != 0 &&
840 copy_to_user(buffer, usblp->readbuf + usblp->readcount, count)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841 count = -EFAULT;
842 goto done;
843 }
844
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700845 if ((usblp->readcount += count) == avail) {
846 if (usblp_submit_read(usblp) < 0) {
847 /* We don't want to leak USB return codes into errno. */
848 if (count == 0)
849 count = -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 goto done;
851 }
852 }
853
854done:
Nicolas Kaiser916de022010-06-25 20:25:37 +0200855 mutex_unlock(&usblp->mut);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 return count;
857}
858
859/*
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700860 * Wait for the write path to come idle.
861 * This is called under the ->wmut, so the idle path stays idle.
862 *
863 * Our write path has a peculiar property: it does not buffer like a tty,
864 * but waits for the write to succeed. This allows our ->release to bug out
865 * without waiting for writes to drain. But it obviously does not work
866 * when O_NONBLOCK is set. So, applications setting O_NONBLOCK must use
867 * select(2) or poll(2) to wait for the buffer to drain before closing.
868 * Alternatively, set blocking mode with fcntl and issue a zero-size write.
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700869 */
870static int usblp_wwait(struct usblp *usblp, int nonblock)
871{
872 DECLARE_WAITQUEUE(waita, current);
873 int rc;
Pete Zaitcev7f477352007-07-23 01:58:15 -0700874 int err = 0;
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700875
876 add_wait_queue(&usblp->wwait, &waita);
877 for (;;) {
878 if (mutex_lock_interruptible(&usblp->mut)) {
879 rc = -EINTR;
880 break;
881 }
Jiri Slaby19cd80a2015-11-02 10:27:00 +0100882 set_current_state(TASK_INTERRUPTIBLE);
Pete Zaitcev7f477352007-07-23 01:58:15 -0700883 rc = usblp_wtest(usblp, nonblock);
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700884 mutex_unlock(&usblp->mut);
Pete Zaitcev7f477352007-07-23 01:58:15 -0700885 if (rc <= 0)
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700886 break;
Pete Zaitcev7f477352007-07-23 01:58:15 -0700887
Pete Zaitcevdd44be62009-01-06 17:20:42 -0700888 if (schedule_timeout(msecs_to_jiffies(1500)) == 0) {
889 if (usblp->flags & LP_ABORT) {
Pete Zaitcev7f477352007-07-23 01:58:15 -0700890 err = usblp_check_status(usblp, err);
891 if (err == 1) { /* Paper out */
892 rc = -ENOSPC;
893 break;
894 }
Pete Zaitcevdd44be62009-01-06 17:20:42 -0700895 } else {
896 /* Prod the printer, Gentoo#251237. */
897 mutex_lock(&usblp->mut);
898 usblp_read_status(usblp, usblp->statusbuf);
899 mutex_unlock(&usblp->mut);
Pete Zaitcev7f477352007-07-23 01:58:15 -0700900 }
Pete Zaitcev7f477352007-07-23 01:58:15 -0700901 }
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700902 }
903 set_current_state(TASK_RUNNING);
904 remove_wait_queue(&usblp->wwait, &waita);
905 return rc;
906}
907
908static int usblp_wtest(struct usblp *usblp, int nonblock)
909{
910 unsigned long flags;
911
912 if (!usblp->present)
913 return -ENODEV;
914 if (signal_pending(current))
915 return -EINTR;
916 spin_lock_irqsave(&usblp->lock, flags);
917 if (usblp->wcomplete) {
918 spin_unlock_irqrestore(&usblp->lock, flags);
919 return 0;
920 }
921 spin_unlock_irqrestore(&usblp->lock, flags);
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700922 if (nonblock)
923 return -EAGAIN;
924 return 1;
925}
926
927/*
928 * Wait for read bytes to become available. This probably should have been
929 * called usblp_r_lock_and_wait(), because we lock first. But it's a traditional
930 * name for functions which lock and return.
931 *
932 * We do not use wait_event_interruptible because it makes locking iffy.
933 */
934static int usblp_rwait_and_lock(struct usblp *usblp, int nonblock)
935{
936 DECLARE_WAITQUEUE(waita, current);
937 int rc;
938
939 add_wait_queue(&usblp->rwait, &waita);
940 for (;;) {
941 if (mutex_lock_interruptible(&usblp->mut)) {
942 rc = -EINTR;
943 break;
944 }
945 set_current_state(TASK_INTERRUPTIBLE);
946 if ((rc = usblp_rtest(usblp, nonblock)) < 0) {
947 mutex_unlock(&usblp->mut);
948 break;
949 }
950 if (rc == 0) /* Keep it locked */
951 break;
952 mutex_unlock(&usblp->mut);
953 schedule();
954 }
955 set_current_state(TASK_RUNNING);
956 remove_wait_queue(&usblp->rwait, &waita);
957 return rc;
958}
959
960static int usblp_rtest(struct usblp *usblp, int nonblock)
961{
962 unsigned long flags;
963
964 if (!usblp->present)
965 return -ENODEV;
966 if (signal_pending(current))
967 return -EINTR;
968 spin_lock_irqsave(&usblp->lock, flags);
969 if (usblp->rcomplete) {
970 spin_unlock_irqrestore(&usblp->lock, flags);
971 return 0;
972 }
973 spin_unlock_irqrestore(&usblp->lock, flags);
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700974 if (nonblock)
975 return -EAGAIN;
976 return 1;
977}
978
979/*
980 * Please check ->bidir and other such things outside for now.
981 */
982static int usblp_submit_read(struct usblp *usblp)
983{
984 struct urb *urb;
985 unsigned long flags;
986 int rc;
987
988 rc = -ENOMEM;
Greg Kroah-Hartman2fcdbdf2015-04-30 11:33:06 +0200989 urb = usb_alloc_urb(0, GFP_KERNEL);
990 if (urb == NULL)
Pete Zaitcev317c67b2007-06-21 12:44:56 -0700991 goto raise_urb;
992
993 usb_fill_bulk_urb(urb, usblp->dev,
994 usb_rcvbulkpipe(usblp->dev,
995 usblp->protocol[usblp->current_protocol].epread->bEndpointAddress),
996 usblp->readbuf, USBLP_BUF_SIZE_IN,
997 usblp_bulk_read, usblp);
998 usb_anchor_urb(urb, &usblp->urbs);
999
1000 spin_lock_irqsave(&usblp->lock, flags);
1001 usblp->readcount = 0; /* XXX Why here? */
1002 usblp->rcomplete = 0;
1003 spin_unlock_irqrestore(&usblp->lock, flags);
1004 if ((rc = usb_submit_urb(urb, GFP_KERNEL)) < 0) {
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -07001005 dev_dbg(&usblp->intf->dev, "error submitting urb (%d)\n", rc);
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001006 spin_lock_irqsave(&usblp->lock, flags);
1007 usblp->rstatus = rc;
1008 usblp->rcomplete = 1;
1009 spin_unlock_irqrestore(&usblp->lock, flags);
1010 goto raise_submit;
1011 }
1012
1013 return 0;
1014
1015raise_submit:
1016 usb_unanchor_urb(urb);
1017 usb_free_urb(urb);
1018raise_urb:
1019 return rc;
1020}
1021
1022/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001023 * Checks for printers that have quirks, such as requiring unidirectional
1024 * communication but reporting bidirectional; currently some HP printers
1025 * have this flaw (HP 810, 880, 895, etc.), or needing an init string
1026 * sent at each open (like some Epsons).
1027 * Returns 1 if found, 0 if not found.
1028 *
1029 * HP recommended that we use the bidirectional interface but
1030 * don't attempt any bulk IN transfers from the IN endpoint.
1031 * Here's some more detail on the problem:
1032 * The problem is not that it isn't bidirectional though. The problem
1033 * is that if you request a device ID, or status information, while
1034 * the buffers are full, the return data will end up in the print data
1035 * buffer. For example if you make sure you never request the device ID
1036 * while you are sending print data, and you don't try to query the
1037 * printer status every couple of milliseconds, you will probably be OK.
1038 */
Nicolas Kaiser916de022010-06-25 20:25:37 +02001039static unsigned int usblp_quirks(__u16 vendor, __u16 product)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001040{
1041 int i;
1042
1043 for (i = 0; quirk_printers[i].vendorId; i++) {
1044 if (vendor == quirk_printers[i].vendorId &&
1045 product == quirk_printers[i].productId)
1046 return quirk_printers[i].quirks;
Nicolas Kaiser916de022010-06-25 20:25:37 +02001047 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048 return 0;
1049}
1050
Luiz Fernando N. Capitulino066202d2006-08-05 20:37:11 -03001051static const struct file_operations usblp_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001052 .owner = THIS_MODULE,
1053 .read = usblp_read,
1054 .write = usblp_write,
1055 .poll = usblp_poll,
Pete Zaitcev318e4792005-12-21 17:03:24 -08001056 .unlocked_ioctl = usblp_ioctl,
1057 .compat_ioctl = usblp_ioctl,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058 .open = usblp_open,
1059 .release = usblp_release,
Arnd Bergmann6038f372010-08-15 18:52:59 +02001060 .llseek = noop_llseek,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061};
1062
Al Viro2c9ede52011-07-23 20:24:48 -04001063static char *usblp_devnode(struct device *dev, umode_t *mode)
Kay Sieversf7a386c2009-04-30 15:23:42 +02001064{
1065 return kasprintf(GFP_KERNEL, "usb/%s", dev_name(dev));
1066}
1067
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068static struct usb_class_driver usblp_class = {
Greg Kroah-Hartmand6e5bcf2005-06-20 21:15:16 -07001069 .name = "lp%d",
Kay Sieverse454cea2009-09-18 23:01:12 +02001070 .devnode = usblp_devnode,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071 .fops = &usblp_fops,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072 .minor_base = USBLP_MINOR_BASE,
1073};
1074
Greg Kroah-Hartman7f26ee42018-01-23 11:24:06 +01001075static ssize_t ieee1284_id_show(struct device *dev, struct device_attribute *attr, char *buf)
David Woodhousea9714c82005-12-23 16:41:41 +00001076{
1077 struct usb_interface *intf = to_usb_interface(dev);
Nicolas Kaiser916de022010-06-25 20:25:37 +02001078 struct usblp *usblp = usb_get_intfdata(intf);
David Woodhousea9714c82005-12-23 16:41:41 +00001079
1080 if (usblp->device_id_string[0] == 0 &&
1081 usblp->device_id_string[1] == 0)
1082 return 0;
1083
1084 return sprintf(buf, "%s", usblp->device_id_string+2);
1085}
1086
Greg Kroah-Hartman7f26ee42018-01-23 11:24:06 +01001087static DEVICE_ATTR_RO(ieee1284_id);
David Woodhousea9714c82005-12-23 16:41:41 +00001088
Greg Kroah-Hartman02c4d452019-08-06 16:44:55 +02001089static struct attribute *usblp_attrs[] = {
1090 &dev_attr_ieee1284_id.attr,
1091 NULL,
1092};
1093ATTRIBUTE_GROUPS(usblp);
1094
Linus Torvalds1da177e2005-04-16 15:20:36 -07001095static int usblp_probe(struct usb_interface *intf,
1096 const struct usb_device_id *id)
1097{
Nicolas Kaiser916de022010-06-25 20:25:37 +02001098 struct usb_device *dev = interface_to_usbdev(intf);
Julia Lawall49b707b2008-07-16 18:00:42 +02001099 struct usblp *usblp;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100 int protocol;
1101 int retval;
1102
1103 /* Malloc and start initializing usblp structure so we can use it
1104 * directly. */
Julia Lawall49b707b2008-07-16 18:00:42 +02001105 usblp = kzalloc(sizeof(struct usblp), GFP_KERNEL);
1106 if (!usblp) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001107 retval = -ENOMEM;
Julia Lawall49b707b2008-07-16 18:00:42 +02001108 goto abort_ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001110 usblp->dev = dev;
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001111 mutex_init(&usblp->wmut);
Nicolas Kaiser916de022010-06-25 20:25:37 +02001112 mutex_init(&usblp->mut);
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001113 spin_lock_init(&usblp->lock);
1114 init_waitqueue_head(&usblp->rwait);
1115 init_waitqueue_head(&usblp->wwait);
1116 init_usb_anchor(&usblp->urbs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001117 usblp->ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
Johan Hovold7a759192019-10-15 19:55:22 +02001118 usblp->intf = usb_get_intf(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119
Linus Torvalds1da177e2005-04-16 15:20:36 -07001120 /* Malloc device ID string buffer to the largest expected length,
1121 * since we can re-query it on an ioctl and a dynamic string
1122 * could change in length. */
1123 if (!(usblp->device_id_string = kmalloc(USBLP_DEVICE_ID_SIZE, GFP_KERNEL))) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001124 retval = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125 goto abort;
1126 }
1127
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001128 /*
1129 * Allocate read buffer. We somewhat wastefully
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130 * malloc both regardless of bidirectionality, because the
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001131 * alternate setting can be changed later via an ioctl.
1132 */
1133 if (!(usblp->readbuf = kmalloc(USBLP_BUF_SIZE_IN, GFP_KERNEL))) {
1134 retval = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135 goto abort;
1136 }
1137
1138 /* Allocate buffer for printer status */
1139 usblp->statusbuf = kmalloc(STATUS_BUF_SIZE, GFP_KERNEL);
1140 if (!usblp->statusbuf) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001141 retval = -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001142 goto abort;
1143 }
1144
1145 /* Lookup quirks for this printer. */
1146 usblp->quirks = usblp_quirks(
1147 le16_to_cpu(dev->descriptor.idVendor),
1148 le16_to_cpu(dev->descriptor.idProduct));
1149
1150 /* Analyze and pick initial alternate settings and endpoints. */
1151 protocol = usblp_select_alts(usblp);
1152 if (protocol < 0) {
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -07001153 dev_dbg(&intf->dev,
1154 "incompatible printer-class device 0x%4.4X/0x%4.4X\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155 le16_to_cpu(dev->descriptor.idVendor),
1156 le16_to_cpu(dev->descriptor.idProduct));
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001157 retval = -ENODEV;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158 goto abort;
1159 }
1160
1161 /* Setup the selected alternate setting and endpoints. */
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001162 if (usblp_set_protocol(usblp, protocol) < 0) {
1163 retval = -ENODEV; /* ->probe isn't ->ioctl */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001164 goto abort;
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001165 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166
1167 /* Retrieve and store the device ID string. */
1168 usblp_cache_device_id_string(usblp);
1169
1170#ifdef DEBUG
1171 usblp_check_status(usblp, 0);
1172#endif
1173
Nicolas Kaiser916de022010-06-25 20:25:37 +02001174 usb_set_intfdata(intf, usblp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175
1176 usblp->present = 1;
1177
1178 retval = usb_register_dev(intf, &usblp_class);
1179 if (retval) {
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -07001180 dev_err(&intf->dev,
1181 "usblp: Not able to get a minor (base %u, slice default): %d\n",
1182 USBLP_MINOR_BASE, retval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001183 goto abort_intfdata;
1184 }
1185 usblp->minor = intf->minor;
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -07001186 dev_info(&intf->dev,
1187 "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 +00001188 usblp->minor, usblp->bidir ? "Bi" : "Uni", dev->devnum,
1189 usblp->ifnum,
1190 usblp->protocol[usblp->current_protocol].alt_setting,
1191 usblp->current_protocol,
1192 le16_to_cpu(usblp->dev->descriptor.idVendor),
1193 le16_to_cpu(usblp->dev->descriptor.idProduct));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194
1195 return 0;
1196
1197abort_intfdata:
Nicolas Kaiser916de022010-06-25 20:25:37 +02001198 usb_set_intfdata(intf, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199abort:
Julia Lawall49b707b2008-07-16 18:00:42 +02001200 kfree(usblp->readbuf);
1201 kfree(usblp->statusbuf);
1202 kfree(usblp->device_id_string);
Johan Hovold7a759192019-10-15 19:55:22 +02001203 usb_put_intf(usblp->intf);
Julia Lawall49b707b2008-07-16 18:00:42 +02001204 kfree(usblp);
1205abort_ret:
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001206 return retval;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207}
1208
1209/*
1210 * We are a "new" style driver with usb_device_id table,
1211 * but our requirements are too intricate for simple match to handle.
1212 *
1213 * The "proto_bias" option may be used to specify the preferred protocol
Krzysztof Opasiak298b9922015-06-22 15:50:22 +02001214 * for all USB printers (1=USB_CLASS_PRINTER/1/1, 2=USB_CLASS_PRINTER/1/2,
1215 * 3=USB_CLASS_PRINTER/1/3). If the device supports the preferred protocol,
1216 * then we bind to it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217 *
Krzysztof Opasiak298b9922015-06-22 15:50:22 +02001218 * The best interface for us is USB_CLASS_PRINTER/1/2, because it
1219 * is compatible with a stream of characters. If we find it, we bind to it.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001220 *
1221 * Note that the people from hpoj.sourceforge.net need to be able to
Krzysztof Opasiak298b9922015-06-22 15:50:22 +02001222 * bind to USB_CLASS_PRINTER/1/3 (MLC/1284.4), so we provide them ioctls
1223 * for this purpose.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224 *
Krzysztof Opasiak298b9922015-06-22 15:50:22 +02001225 * Failing USB_CLASS_PRINTER/1/2, we look for USB_CLASS_PRINTER/1/3,
1226 * even though it's probably not stream-compatible, because this matches
1227 * the behaviour of the old code.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001228 *
Krzysztof Opasiak298b9922015-06-22 15:50:22 +02001229 * If nothing else, we bind to USB_CLASS_PRINTER/1/1
1230 * - the unidirectional interface.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001231 */
1232static int usblp_select_alts(struct usblp *usblp)
1233{
1234 struct usb_interface *if_alt;
1235 struct usb_host_interface *ifd;
Johan Hovold53708602017-03-17 11:35:50 +01001236 struct usb_endpoint_descriptor *epwrite, *epread;
1237 int p, i;
1238 int res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239
1240 if_alt = usblp->intf;
1241
1242 for (p = 0; p < USBLP_MAX_PROTOCOLS; p++)
1243 usblp->protocol[p].alt_setting = -1;
1244
1245 /* Find out what we have. */
1246 for (i = 0; i < if_alt->num_altsetting; i++) {
1247 ifd = &if_alt->altsetting[i];
1248
Krzysztof Opasiak298b9922015-06-22 15:50:22 +02001249 if (ifd->desc.bInterfaceClass != USB_CLASS_PRINTER ||
1250 ifd->desc.bInterfaceSubClass != 1)
Alan Stern5ec71db2007-03-16 15:53:07 -04001251 if (!(usblp->quirks & USBLP_QUIRK_BAD_CLASS))
1252 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253
1254 if (ifd->desc.bInterfaceProtocol < USBLP_FIRST_PROTOCOL ||
1255 ifd->desc.bInterfaceProtocol > USBLP_LAST_PROTOCOL)
1256 continue;
1257
Johan Hovold53708602017-03-17 11:35:50 +01001258 /* Look for the expected bulk endpoints. */
1259 if (ifd->desc.bInterfaceProtocol > 1) {
1260 res = usb_find_common_endpoints(ifd,
1261 &epread, &epwrite, NULL, NULL);
1262 } else {
1263 epread = NULL;
1264 res = usb_find_bulk_out_endpoint(ifd, &epwrite);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265 }
1266
1267 /* Ignore buggy hardware without the right endpoints. */
Johan Hovold53708602017-03-17 11:35:50 +01001268 if (res)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269 continue;
1270
Johan Hovold53708602017-03-17 11:35:50 +01001271 /* Turn off reads for buggy bidirectional printers. */
1272 if (usblp->quirks & USBLP_QUIRK_BIDIR) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001273 printk(KERN_INFO "usblp%d: Disabling reads from "
1274 "problematic bidirectional printer\n",
1275 usblp->minor);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001276 epread = NULL;
1277 }
1278
1279 usblp->protocol[ifd->desc.bInterfaceProtocol].alt_setting =
1280 ifd->desc.bAlternateSetting;
1281 usblp->protocol[ifd->desc.bInterfaceProtocol].epwrite = epwrite;
1282 usblp->protocol[ifd->desc.bInterfaceProtocol].epread = epread;
1283 }
1284
1285 /* If our requested protocol is supported, then use it. */
1286 if (proto_bias >= USBLP_FIRST_PROTOCOL &&
1287 proto_bias <= USBLP_LAST_PROTOCOL &&
1288 usblp->protocol[proto_bias].alt_setting != -1)
1289 return proto_bias;
1290
1291 /* Ordering is important here. */
1292 if (usblp->protocol[2].alt_setting != -1)
1293 return 2;
1294 if (usblp->protocol[1].alt_setting != -1)
1295 return 1;
1296 if (usblp->protocol[3].alt_setting != -1)
1297 return 3;
1298
1299 /* If nothing is available, then don't bind to this device. */
1300 return -1;
1301}
1302
1303static int usblp_set_protocol(struct usblp *usblp, int protocol)
1304{
1305 int r, alts;
1306
1307 if (protocol < USBLP_FIRST_PROTOCOL || protocol > USBLP_LAST_PROTOCOL)
1308 return -EINVAL;
1309
1310 alts = usblp->protocol[protocol].alt_setting;
1311 if (alts < 0)
1312 return -EINVAL;
1313 r = usb_set_interface(usblp->dev, usblp->ifnum, alts);
1314 if (r < 0) {
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001315 printk(KERN_ERR "usblp: can't set desired altsetting %d on interface %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 alts, usblp->ifnum);
1317 return r;
1318 }
1319
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 usblp->bidir = (usblp->protocol[protocol].epread != NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 usblp->current_protocol = protocol;
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -07001322 dev_dbg(&usblp->intf->dev, "usblp%d set protocol %d\n",
1323 usblp->minor, protocol);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324 return 0;
1325}
1326
1327/* Retrieves and caches device ID string.
1328 * Returns length, including length bytes but not null terminator.
1329 * On error, returns a negative errno value. */
1330static int usblp_cache_device_id_string(struct usblp *usblp)
1331{
1332 int err, length;
1333
1334 err = usblp_get_id(usblp, 0, usblp->device_id_string, USBLP_DEVICE_ID_SIZE - 1);
1335 if (err < 0) {
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -07001336 dev_dbg(&usblp->intf->dev,
1337 "usblp%d: error = %d reading IEEE-1284 Device ID string\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338 usblp->minor, err);
1339 usblp->device_id_string[0] = usblp->device_id_string[1] = '\0';
1340 return -EIO;
1341 }
1342
1343 /* First two bytes are length in big-endian.
1344 * They count themselves, and we copy them into
1345 * the user's buffer. */
1346 length = be16_to_cpu(*((__be16 *)usblp->device_id_string));
1347 if (length < 2)
1348 length = 2;
1349 else if (length >= USBLP_DEVICE_ID_SIZE)
1350 length = USBLP_DEVICE_ID_SIZE - 1;
1351 usblp->device_id_string[length] = '\0';
1352
Greg Kroah-Hartman4f306302012-05-01 21:33:31 -07001353 dev_dbg(&usblp->intf->dev, "usblp%d Device ID string [len=%d]=\"%s\"\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -07001354 usblp->minor, length, &usblp->device_id_string[2]);
1355
1356 return length;
1357}
1358
1359static void usblp_disconnect(struct usb_interface *intf)
1360{
Nicolas Kaiser916de022010-06-25 20:25:37 +02001361 struct usblp *usblp = usb_get_intfdata(intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362
1363 usb_deregister_dev(intf, &usblp_class);
1364
1365 if (!usblp || !usblp->dev) {
Greg Kroah-Hartman9908a322008-08-14 09:37:34 -07001366 dev_err(&intf->dev, "bogus disconnect\n");
Nicolas Kaiser916de022010-06-25 20:25:37 +02001367 BUG();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368 }
1369
Nicolas Kaiser916de022010-06-25 20:25:37 +02001370 mutex_lock(&usblp_mutex);
1371 mutex_lock(&usblp->mut);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001372 usblp->present = 0;
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001373 wake_up(&usblp->wwait);
1374 wake_up(&usblp->rwait);
Nicolas Kaiser916de022010-06-25 20:25:37 +02001375 usb_set_intfdata(intf, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376
1377 usblp_unlink_urbs(usblp);
Nicolas Kaiser916de022010-06-25 20:25:37 +02001378 mutex_unlock(&usblp->mut);
Oliver Neukum296a1932020-05-07 10:58:06 +02001379 usb_poison_anchored_urbs(&usblp->urbs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380
1381 if (!usblp->used)
Nicolas Kaiser916de022010-06-25 20:25:37 +02001382 usblp_cleanup(usblp);
Oliver Neukum296a1932020-05-07 10:58:06 +02001383
Nicolas Kaiser916de022010-06-25 20:25:37 +02001384 mutex_unlock(&usblp_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385}
1386
Oliver Neukum3a90f812009-12-28 00:52:17 +01001387static int usblp_suspend(struct usb_interface *intf, pm_message_t message)
Oliver Neukum516077c2006-10-05 09:04:11 +02001388{
Nicolas Kaiser916de022010-06-25 20:25:37 +02001389 struct usblp *usblp = usb_get_intfdata(intf);
Oliver Neukum516077c2006-10-05 09:04:11 +02001390
Oliver Neukum516077c2006-10-05 09:04:11 +02001391 usblp_unlink_urbs(usblp);
Pete Zaitcev317c67b2007-06-21 12:44:56 -07001392#if 0 /* XXX Do we want this? What if someone is reading, should we fail? */
1393 /* not strictly necessary, but just in case */
1394 wake_up(&usblp->wwait);
1395 wake_up(&usblp->rwait);
1396#endif
Oliver Neukum516077c2006-10-05 09:04:11 +02001397
1398 return 0;
1399}
1400
Oliver Neukum3a90f812009-12-28 00:52:17 +01001401static int usblp_resume(struct usb_interface *intf)
Oliver Neukum516077c2006-10-05 09:04:11 +02001402{
Nicolas Kaiser916de022010-06-25 20:25:37 +02001403 struct usblp *usblp = usb_get_intfdata(intf);
Oliver Neukum516077c2006-10-05 09:04:11 +02001404 int r;
1405
Nicolas Kaiser916de022010-06-25 20:25:37 +02001406 r = handle_bidir(usblp);
Oliver Neukum516077c2006-10-05 09:04:11 +02001407
Oliver Neukum516077c2006-10-05 09:04:11 +02001408 return r;
1409}
1410
Németh Márton6ef48522010-01-10 15:33:45 +01001411static const struct usb_device_id usblp_ids[] = {
Krzysztof Opasiak298b9922015-06-22 15:50:22 +02001412 { USB_DEVICE_INFO(USB_CLASS_PRINTER, 1, 1) },
1413 { USB_DEVICE_INFO(USB_CLASS_PRINTER, 1, 2) },
1414 { USB_DEVICE_INFO(USB_CLASS_PRINTER, 1, 3) },
1415 { USB_INTERFACE_INFO(USB_CLASS_PRINTER, 1, 1) },
1416 { USB_INTERFACE_INFO(USB_CLASS_PRINTER, 1, 2) },
1417 { USB_INTERFACE_INFO(USB_CLASS_PRINTER, 1, 3) },
Alan Stern5ec71db2007-03-16 15:53:07 -04001418 { USB_DEVICE(0x04b8, 0x0202) }, /* Seiko Epson Receipt Printer M129C */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001419 { } /* Terminating entry */
1420};
1421
Nicolas Kaiser916de022010-06-25 20:25:37 +02001422MODULE_DEVICE_TABLE(usb, usblp_ids);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423
1424static struct usb_driver usblp_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425 .name = "usblp",
1426 .probe = usblp_probe,
1427 .disconnect = usblp_disconnect,
Oliver Neukum516077c2006-10-05 09:04:11 +02001428 .suspend = usblp_suspend,
1429 .resume = usblp_resume,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430 .id_table = usblp_ids,
Greg Kroah-Hartman02c4d452019-08-06 16:44:55 +02001431 .dev_groups = usblp_groups,
Oliver Neukumd0532182007-01-18 15:06:07 +01001432 .supports_autosuspend = 1,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433};
1434
Greg Kroah-Hartman65db4302011-11-18 09:34:02 -08001435module_usb_driver(usblp_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001436
Nicolas Kaiser916de022010-06-25 20:25:37 +02001437MODULE_AUTHOR(DRIVER_AUTHOR);
1438MODULE_DESCRIPTION(DRIVER_DESC);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439module_param(proto_bias, int, S_IRUGO | S_IWUSR);
1440MODULE_PARM_DESC(proto_bias, "Favourite protocol number");
1441MODULE_LICENSE("GPL");