usblp.c 39 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433
  1. // SPDX-License-Identifier: GPL-2.0+
  2. /*
  3. * usblp.c
  4. *
  5. * Copyright (c) 1999 Michael Gee <michael@linuxspecific.com>
  6. * Copyright (c) 1999 Pavel Machek <pavel@ucw.cz>
  7. * Copyright (c) 2000 Randy Dunlap <rdunlap@xenotime.net>
  8. * 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>
  11. * Copyright (c) 2006 Oliver Neukum <oliver@neukum.name>
  12. *
  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);
  31. * use usb_alloc_coherent() for read buf & write buf;
  32. * none - Maintained in Linux kernel after v0.13
  33. */
  34. #include <linux/module.h>
  35. #include <linux/kernel.h>
  36. #include <linux/sched/signal.h>
  37. #include <linux/signal.h>
  38. #include <linux/poll.h>
  39. #include <linux/slab.h>
  40. #include <linux/lp.h>
  41. #include <linux/mutex.h>
  42. #undef DEBUG
  43. #include <linux/usb.h>
  44. #include <linux/usb/ch9.h>
  45. #include <linux/ratelimit.h>
  46. /*
  47. * Version Information
  48. */
  49. #define DRIVER_AUTHOR "Michael Gee, Pavel Machek, Vojtech Pavlik, Randy Dunlap, Pete Zaitcev, David Paschal"
  50. #define DRIVER_DESC "USB Printer Device Class driver"
  51. #define USBLP_BUF_SIZE 8192
  52. #define USBLP_BUF_SIZE_IN 1024
  53. #define USBLP_DEVICE_ID_SIZE 1024
  54. /* ioctls: */
  55. #define IOCNR_GET_DEVICE_ID 1
  56. #define IOCNR_GET_PROTOCOLS 2
  57. #define IOCNR_SET_PROTOCOL 3
  58. #define IOCNR_HP_SET_CHANNEL 4
  59. #define IOCNR_GET_BUS_ADDRESS 5
  60. #define IOCNR_GET_VID_PID 6
  61. #define IOCNR_SOFT_RESET 7
  62. /* Get device_id string: */
  63. #define LPIOC_GET_DEVICE_ID(len) _IOC(_IOC_READ, 'P', IOCNR_GET_DEVICE_ID, len)
  64. /* The following ioctls were added for http://hpoj.sourceforge.net:
  65. * Get two-int array:
  66. * [0]=current protocol
  67. * (1=USB_CLASS_PRINTER/1/1, 2=USB_CLASS_PRINTER/1/2,
  68. * 3=USB_CLASS_PRINTER/1/3),
  69. * [1]=supported protocol mask (mask&(1<<n)!=0 means
  70. * USB_CLASS_PRINTER/1/n supported):
  71. */
  72. #define LPIOC_GET_PROTOCOLS(len) _IOC(_IOC_READ, 'P', IOCNR_GET_PROTOCOLS, len)
  73. /*
  74. * Set protocol
  75. * (arg: 1=USB_CLASS_PRINTER/1/1, 2=USB_CLASS_PRINTER/1/2,
  76. * 3=USB_CLASS_PRINTER/1/3):
  77. */
  78. #define LPIOC_SET_PROTOCOL _IOC(_IOC_WRITE, 'P', IOCNR_SET_PROTOCOL, 0)
  79. /* Set channel number (HP Vendor-specific command): */
  80. #define LPIOC_HP_SET_CHANNEL _IOC(_IOC_WRITE, 'P', IOCNR_HP_SET_CHANNEL, 0)
  81. /* Get two-int array: [0]=bus number, [1]=device address: */
  82. #define LPIOC_GET_BUS_ADDRESS(len) _IOC(_IOC_READ, 'P', IOCNR_GET_BUS_ADDRESS, len)
  83. /* Get two-int array: [0]=vendor ID, [1]=product ID: */
  84. #define LPIOC_GET_VID_PID(len) _IOC(_IOC_READ, 'P', IOCNR_GET_VID_PID, len)
  85. /* Perform class specific soft reset */
  86. #define LPIOC_SOFT_RESET _IOC(_IOC_NONE, 'P', IOCNR_SOFT_RESET, 0);
  87. /*
  88. * A DEVICE_ID string may include the printer's serial number.
  89. * It should end with a semi-colon (';').
  90. * An example from an HP 970C DeskJet printer is (this is one long string,
  91. * with the serial number changed):
  92. MFG:HEWLETT-PACKARD;MDL:DESKJET 970C;CMD:MLC,PCL,PML;CLASS:PRINTER;DESCRIPTION:Hewlett-Packard DeskJet 970C;SERN:US970CSEPROF;VSTATUS:$HB0$NC0,ff,DN,IDLE,CUT,K1,C0,DP,NR,KP000,CP027;VP:0800,FL,B0;VJ: ;
  93. */
  94. /*
  95. * USB Printer Requests
  96. */
  97. #define USBLP_REQ_GET_ID 0x00
  98. #define USBLP_REQ_GET_STATUS 0x01
  99. #define USBLP_REQ_RESET 0x02
  100. #define USBLP_REQ_HP_CHANNEL_CHANGE_REQUEST 0x00 /* HP Vendor-specific */
  101. #define USBLP_MINORS 16
  102. #define USBLP_MINOR_BASE 0
  103. #define USBLP_CTL_TIMEOUT 5000 /* 5 seconds */
  104. #define USBLP_FIRST_PROTOCOL 1
  105. #define USBLP_LAST_PROTOCOL 3
  106. #define USBLP_MAX_PROTOCOLS (USBLP_LAST_PROTOCOL+1)
  107. /*
  108. * some arbitrary status buffer size;
  109. * need a status buffer that is allocated via kmalloc(), not on stack
  110. */
  111. #define STATUS_BUF_SIZE 8
  112. /*
  113. * Locks down the locking order:
  114. * ->wmut locks wstatus.
  115. * ->mut locks the whole usblp, except [rw]complete, and thus, by indirection,
  116. * [rw]status. We only touch status when we know the side idle.
  117. * ->lock locks what interrupt accesses.
  118. */
  119. struct usblp {
  120. struct usb_device *dev; /* USB device */
  121. struct mutex wmut;
  122. struct mutex mut;
  123. spinlock_t lock; /* locks rcomplete, wcomplete */
  124. char *readbuf; /* read transfer_buffer */
  125. char *statusbuf; /* status transfer_buffer */
  126. struct usb_anchor urbs;
  127. wait_queue_head_t rwait, wwait;
  128. int readcount; /* Counter for reads */
  129. int ifnum; /* Interface number */
  130. struct usb_interface *intf; /* The interface */
  131. /*
  132. * Alternate-setting numbers and endpoints for each protocol
  133. * (USB_CLASS_PRINTER/1/{index=1,2,3}) that the device supports:
  134. */
  135. struct {
  136. int alt_setting;
  137. struct usb_endpoint_descriptor *epwrite;
  138. struct usb_endpoint_descriptor *epread;
  139. } protocol[USBLP_MAX_PROTOCOLS];
  140. int current_protocol;
  141. int minor; /* minor number of device */
  142. int wcomplete, rcomplete;
  143. int wstatus; /* bytes written or error */
  144. int rstatus; /* bytes ready or error */
  145. unsigned int quirks; /* quirks flags */
  146. unsigned int flags; /* mode flags */
  147. unsigned char used; /* True if open */
  148. unsigned char present; /* True if not disconnected */
  149. unsigned char bidir; /* interface is bidirectional */
  150. unsigned char no_paper; /* Paper Out happened */
  151. unsigned char *device_id_string; /* IEEE 1284 DEVICE ID string (ptr) */
  152. /* first 2 bytes are (big-endian) length */
  153. };
  154. #ifdef DEBUG
  155. static void usblp_dump(struct usblp *usblp)
  156. {
  157. struct device *dev = &usblp->intf->dev;
  158. int p;
  159. dev_dbg(dev, "usblp=0x%p\n", usblp);
  160. dev_dbg(dev, "dev=0x%p\n", usblp->dev);
  161. dev_dbg(dev, "present=%d\n", usblp->present);
  162. dev_dbg(dev, "readbuf=0x%p\n", usblp->readbuf);
  163. dev_dbg(dev, "readcount=%d\n", usblp->readcount);
  164. dev_dbg(dev, "ifnum=%d\n", usblp->ifnum);
  165. for (p = USBLP_FIRST_PROTOCOL; p <= USBLP_LAST_PROTOCOL; p++) {
  166. dev_dbg(dev, "protocol[%d].alt_setting=%d\n", p,
  167. usblp->protocol[p].alt_setting);
  168. dev_dbg(dev, "protocol[%d].epwrite=%p\n", p,
  169. usblp->protocol[p].epwrite);
  170. dev_dbg(dev, "protocol[%d].epread=%p\n", p,
  171. usblp->protocol[p].epread);
  172. }
  173. dev_dbg(dev, "current_protocol=%d\n", usblp->current_protocol);
  174. dev_dbg(dev, "minor=%d\n", usblp->minor);
  175. dev_dbg(dev, "wstatus=%d\n", usblp->wstatus);
  176. dev_dbg(dev, "rstatus=%d\n", usblp->rstatus);
  177. dev_dbg(dev, "quirks=%d\n", usblp->quirks);
  178. dev_dbg(dev, "used=%d\n", usblp->used);
  179. dev_dbg(dev, "bidir=%d\n", usblp->bidir);
  180. dev_dbg(dev, "device_id_string=\"%s\"\n",
  181. usblp->device_id_string ?
  182. usblp->device_id_string + 2 :
  183. (unsigned char *)"(null)");
  184. }
  185. #endif
  186. /* Quirks: various printer quirks are handled by this table & its flags. */
  187. struct quirk_printer_struct {
  188. __u16 vendorId;
  189. __u16 productId;
  190. unsigned int quirks;
  191. };
  192. #define USBLP_QUIRK_BIDIR 0x1 /* reports bidir but requires unidirectional mode (no INs/reads) */
  193. #define USBLP_QUIRK_USB_INIT 0x2 /* needs vendor USB init string */
  194. #define USBLP_QUIRK_BAD_CLASS 0x4 /* descriptor uses vendor-specific Class or SubClass */
  195. static const struct quirk_printer_struct quirk_printers[] = {
  196. { 0x03f0, 0x0004, USBLP_QUIRK_BIDIR }, /* HP DeskJet 895C */
  197. { 0x03f0, 0x0104, USBLP_QUIRK_BIDIR }, /* HP DeskJet 880C */
  198. { 0x03f0, 0x0204, USBLP_QUIRK_BIDIR }, /* HP DeskJet 815C */
  199. { 0x03f0, 0x0304, USBLP_QUIRK_BIDIR }, /* HP DeskJet 810C/812C */
  200. { 0x03f0, 0x0404, USBLP_QUIRK_BIDIR }, /* HP DeskJet 830C */
  201. { 0x03f0, 0x0504, USBLP_QUIRK_BIDIR }, /* HP DeskJet 885C */
  202. { 0x03f0, 0x0604, USBLP_QUIRK_BIDIR }, /* HP DeskJet 840C */
  203. { 0x03f0, 0x0804, USBLP_QUIRK_BIDIR }, /* HP DeskJet 816C */
  204. { 0x03f0, 0x1104, USBLP_QUIRK_BIDIR }, /* HP Deskjet 959C */
  205. { 0x0409, 0xefbe, USBLP_QUIRK_BIDIR }, /* NEC Picty900 (HP OEM) */
  206. { 0x0409, 0xbef4, USBLP_QUIRK_BIDIR }, /* NEC Picty760 (HP OEM) */
  207. { 0x0409, 0xf0be, USBLP_QUIRK_BIDIR }, /* NEC Picty920 (HP OEM) */
  208. { 0x0409, 0xf1be, USBLP_QUIRK_BIDIR }, /* NEC Picty800 (HP OEM) */
  209. { 0x0482, 0x0010, USBLP_QUIRK_BIDIR }, /* Kyocera Mita FS 820, by zut <kernel@zut.de> */
  210. { 0x04f9, 0x000d, USBLP_QUIRK_BIDIR }, /* Brother Industries, Ltd HL-1440 Laser Printer */
  211. { 0x04b8, 0x0202, USBLP_QUIRK_BAD_CLASS }, /* Seiko Epson Receipt Printer M129C */
  212. { 0, 0 }
  213. };
  214. static int usblp_wwait(struct usblp *usblp, int nonblock);
  215. static int usblp_wtest(struct usblp *usblp, int nonblock);
  216. static int usblp_rwait_and_lock(struct usblp *usblp, int nonblock);
  217. static int usblp_rtest(struct usblp *usblp, int nonblock);
  218. static int usblp_submit_read(struct usblp *usblp);
  219. static int usblp_select_alts(struct usblp *usblp);
  220. static int usblp_set_protocol(struct usblp *usblp, int protocol);
  221. static int usblp_cache_device_id_string(struct usblp *usblp);
  222. /* forward reference to make our lives easier */
  223. static struct usb_driver usblp_driver;
  224. static DEFINE_MUTEX(usblp_mutex); /* locks the existence of usblp's */
  225. /*
  226. * Functions for usblp control messages.
  227. */
  228. static int usblp_ctrl_msg(struct usblp *usblp, int request, int type, int dir, int recip, int value, void *buf, int len)
  229. {
  230. int retval;
  231. int index = usblp->ifnum;
  232. /* High byte has the interface index.
  233. Low byte has the alternate setting.
  234. */
  235. if ((request == USBLP_REQ_GET_ID) && (type == USB_TYPE_CLASS))
  236. index = (usblp->ifnum<<8)|usblp->protocol[usblp->current_protocol].alt_setting;
  237. retval = usb_control_msg(usblp->dev,
  238. dir ? usb_rcvctrlpipe(usblp->dev, 0) : usb_sndctrlpipe(usblp->dev, 0),
  239. request, type | dir | recip, value, index, buf, len, USBLP_CTL_TIMEOUT);
  240. dev_dbg(&usblp->intf->dev,
  241. "usblp_control_msg: rq: 0x%02x dir: %d recip: %d value: %d idx: %d len: %#x result: %d\n",
  242. request, !!dir, recip, value, index, len, retval);
  243. return retval < 0 ? retval : 0;
  244. }
  245. #define usblp_read_status(usblp, status)\
  246. usblp_ctrl_msg(usblp, USBLP_REQ_GET_STATUS, USB_TYPE_CLASS, USB_DIR_IN, USB_RECIP_INTERFACE, 0, status, 1)
  247. #define usblp_get_id(usblp, config, id, maxlen)\
  248. usblp_ctrl_msg(usblp, USBLP_REQ_GET_ID, USB_TYPE_CLASS, USB_DIR_IN, USB_RECIP_INTERFACE, config, id, maxlen)
  249. #define usblp_reset(usblp)\
  250. usblp_ctrl_msg(usblp, USBLP_REQ_RESET, USB_TYPE_CLASS, USB_DIR_OUT, USB_RECIP_OTHER, 0, NULL, 0)
  251. #define usblp_hp_channel_change_request(usblp, channel, buffer) \
  252. usblp_ctrl_msg(usblp, USBLP_REQ_HP_CHANNEL_CHANGE_REQUEST, USB_TYPE_VENDOR, USB_DIR_IN, USB_RECIP_INTERFACE, channel, buffer, 1)
  253. /*
  254. * See the description for usblp_select_alts() below for the usage
  255. * explanation. Look into your /sys/kernel/debug/usb/devices and dmesg in
  256. * case of any trouble.
  257. */
  258. static int proto_bias = -1;
  259. /*
  260. * URB callback.
  261. */
  262. static void usblp_bulk_read(struct urb *urb)
  263. {
  264. struct usblp *usblp = urb->context;
  265. int status = urb->status;
  266. unsigned long flags;
  267. if (usblp->present && usblp->used) {
  268. if (status)
  269. printk(KERN_WARNING "usblp%d: "
  270. "nonzero read bulk status received: %d\n",
  271. usblp->minor, status);
  272. }
  273. spin_lock_irqsave(&usblp->lock, flags);
  274. if (status < 0)
  275. usblp->rstatus = status;
  276. else
  277. usblp->rstatus = urb->actual_length;
  278. usblp->rcomplete = 1;
  279. wake_up(&usblp->rwait);
  280. spin_unlock_irqrestore(&usblp->lock, flags);
  281. usb_free_urb(urb);
  282. }
  283. static void usblp_bulk_write(struct urb *urb)
  284. {
  285. struct usblp *usblp = urb->context;
  286. int status = urb->status;
  287. unsigned long flags;
  288. if (usblp->present && usblp->used) {
  289. if (status)
  290. printk(KERN_WARNING "usblp%d: "
  291. "nonzero write bulk status received: %d\n",
  292. usblp->minor, status);
  293. }
  294. spin_lock_irqsave(&usblp->lock, flags);
  295. if (status < 0)
  296. usblp->wstatus = status;
  297. else
  298. usblp->wstatus = urb->actual_length;
  299. usblp->no_paper = 0;
  300. usblp->wcomplete = 1;
  301. wake_up(&usblp->wwait);
  302. spin_unlock_irqrestore(&usblp->lock, flags);
  303. usb_free_urb(urb);
  304. }
  305. /*
  306. * Get and print printer errors.
  307. */
  308. static const char *usblp_messages[] = { "ok", "out of paper", "off-line", "on fire" };
  309. static int usblp_check_status(struct usblp *usblp, int err)
  310. {
  311. unsigned char status, newerr = 0;
  312. int error;
  313. mutex_lock(&usblp->mut);
  314. if ((error = usblp_read_status(usblp, usblp->statusbuf)) < 0) {
  315. mutex_unlock(&usblp->mut);
  316. printk_ratelimited(KERN_ERR
  317. "usblp%d: error %d reading printer status\n",
  318. usblp->minor, error);
  319. return 0;
  320. }
  321. status = *usblp->statusbuf;
  322. mutex_unlock(&usblp->mut);
  323. if (~status & LP_PERRORP)
  324. newerr = 3;
  325. if (status & LP_POUTPA)
  326. newerr = 1;
  327. if (~status & LP_PSELECD)
  328. newerr = 2;
  329. if (newerr != err) {
  330. printk(KERN_INFO "usblp%d: %s\n",
  331. usblp->minor, usblp_messages[newerr]);
  332. }
  333. return newerr;
  334. }
  335. static int handle_bidir(struct usblp *usblp)
  336. {
  337. if (usblp->bidir && usblp->used) {
  338. if (usblp_submit_read(usblp) < 0)
  339. return -EIO;
  340. }
  341. return 0;
  342. }
  343. /*
  344. * File op functions.
  345. */
  346. static int usblp_open(struct inode *inode, struct file *file)
  347. {
  348. int minor = iminor(inode);
  349. struct usblp *usblp;
  350. struct usb_interface *intf;
  351. int retval;
  352. if (minor < 0)
  353. return -ENODEV;
  354. mutex_lock(&usblp_mutex);
  355. retval = -ENODEV;
  356. intf = usb_find_interface(&usblp_driver, minor);
  357. if (!intf)
  358. goto out;
  359. usblp = usb_get_intfdata(intf);
  360. if (!usblp || !usblp->dev || !usblp->present)
  361. goto out;
  362. retval = -EBUSY;
  363. if (usblp->used)
  364. goto out;
  365. /*
  366. * We do not implement LP_ABORTOPEN/LPABORTOPEN for two reasons:
  367. * - We do not want persistent state which close(2) does not clear
  368. * - It is not used anyway, according to CUPS people
  369. */
  370. retval = usb_autopm_get_interface(intf);
  371. if (retval < 0)
  372. goto out;
  373. usblp->used = 1;
  374. file->private_data = usblp;
  375. usblp->wcomplete = 1; /* we begin writeable */
  376. usblp->wstatus = 0;
  377. usblp->rcomplete = 0;
  378. if (handle_bidir(usblp) < 0) {
  379. usb_autopm_put_interface(intf);
  380. usblp->used = 0;
  381. file->private_data = NULL;
  382. retval = -EIO;
  383. }
  384. out:
  385. mutex_unlock(&usblp_mutex);
  386. return retval;
  387. }
  388. static void usblp_cleanup(struct usblp *usblp)
  389. {
  390. printk(KERN_INFO "usblp%d: removed\n", usblp->minor);
  391. kfree(usblp->readbuf);
  392. kfree(usblp->device_id_string);
  393. kfree(usblp->statusbuf);
  394. kfree(usblp);
  395. }
  396. static void usblp_unlink_urbs(struct usblp *usblp)
  397. {
  398. usb_kill_anchored_urbs(&usblp->urbs);
  399. }
  400. static int usblp_release(struct inode *inode, struct file *file)
  401. {
  402. struct usblp *usblp = file->private_data;
  403. usblp->flags &= ~LP_ABORT;
  404. mutex_lock(&usblp_mutex);
  405. usblp->used = 0;
  406. if (usblp->present) {
  407. usblp_unlink_urbs(usblp);
  408. usb_autopm_put_interface(usblp->intf);
  409. } else /* finish cleanup from disconnect */
  410. usblp_cleanup(usblp);
  411. mutex_unlock(&usblp_mutex);
  412. return 0;
  413. }
  414. /* No kernel lock - fine */
  415. static __poll_t usblp_poll(struct file *file, struct poll_table_struct *wait)
  416. {
  417. __poll_t ret;
  418. unsigned long flags;
  419. struct usblp *usblp = file->private_data;
  420. /* Should we check file->f_mode & FMODE_WRITE before poll_wait()? */
  421. poll_wait(file, &usblp->rwait, wait);
  422. poll_wait(file, &usblp->wwait, wait);
  423. spin_lock_irqsave(&usblp->lock, flags);
  424. ret = ((usblp->bidir && usblp->rcomplete) ? EPOLLIN | EPOLLRDNORM : 0) |
  425. ((usblp->no_paper || usblp->wcomplete) ? EPOLLOUT | EPOLLWRNORM : 0);
  426. spin_unlock_irqrestore(&usblp->lock, flags);
  427. return ret;
  428. }
  429. static long usblp_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
  430. {
  431. struct usblp *usblp = file->private_data;
  432. int length, err, i;
  433. unsigned char newChannel;
  434. int status;
  435. int twoints[2];
  436. int retval = 0;
  437. mutex_lock(&usblp->mut);
  438. if (!usblp->present) {
  439. retval = -ENODEV;
  440. goto done;
  441. }
  442. dev_dbg(&usblp->intf->dev,
  443. "usblp_ioctl: cmd=0x%x (%c nr=%d len=%d dir=%d)\n", cmd,
  444. _IOC_TYPE(cmd), _IOC_NR(cmd), _IOC_SIZE(cmd), _IOC_DIR(cmd));
  445. if (_IOC_TYPE(cmd) == 'P') /* new-style ioctl number */
  446. switch (_IOC_NR(cmd)) {
  447. case IOCNR_GET_DEVICE_ID: /* get the DEVICE_ID string */
  448. if (_IOC_DIR(cmd) != _IOC_READ) {
  449. retval = -EINVAL;
  450. goto done;
  451. }
  452. length = usblp_cache_device_id_string(usblp);
  453. if (length < 0) {
  454. retval = length;
  455. goto done;
  456. }
  457. if (length > _IOC_SIZE(cmd))
  458. length = _IOC_SIZE(cmd); /* truncate */
  459. if (copy_to_user((void __user *) arg,
  460. usblp->device_id_string,
  461. (unsigned long) length)) {
  462. retval = -EFAULT;
  463. goto done;
  464. }
  465. break;
  466. case IOCNR_GET_PROTOCOLS:
  467. if (_IOC_DIR(cmd) != _IOC_READ ||
  468. _IOC_SIZE(cmd) < sizeof(twoints)) {
  469. retval = -EINVAL;
  470. goto done;
  471. }
  472. twoints[0] = usblp->current_protocol;
  473. twoints[1] = 0;
  474. for (i = USBLP_FIRST_PROTOCOL;
  475. i <= USBLP_LAST_PROTOCOL; i++) {
  476. if (usblp->protocol[i].alt_setting >= 0)
  477. twoints[1] |= (1<<i);
  478. }
  479. if (copy_to_user((void __user *)arg,
  480. (unsigned char *)twoints,
  481. sizeof(twoints))) {
  482. retval = -EFAULT;
  483. goto done;
  484. }
  485. break;
  486. case IOCNR_SET_PROTOCOL:
  487. if (_IOC_DIR(cmd) != _IOC_WRITE) {
  488. retval = -EINVAL;
  489. goto done;
  490. }
  491. #ifdef DEBUG
  492. if (arg == -10) {
  493. usblp_dump(usblp);
  494. break;
  495. }
  496. #endif
  497. usblp_unlink_urbs(usblp);
  498. retval = usblp_set_protocol(usblp, arg);
  499. if (retval < 0) {
  500. usblp_set_protocol(usblp,
  501. usblp->current_protocol);
  502. }
  503. break;
  504. case IOCNR_HP_SET_CHANNEL:
  505. if (_IOC_DIR(cmd) != _IOC_WRITE ||
  506. le16_to_cpu(usblp->dev->descriptor.idVendor) != 0x03F0 ||
  507. usblp->quirks & USBLP_QUIRK_BIDIR) {
  508. retval = -EINVAL;
  509. goto done;
  510. }
  511. err = usblp_hp_channel_change_request(usblp,
  512. arg, &newChannel);
  513. if (err < 0) {
  514. dev_err(&usblp->dev->dev,
  515. "usblp%d: error = %d setting "
  516. "HP channel\n",
  517. usblp->minor, err);
  518. retval = -EIO;
  519. goto done;
  520. }
  521. dev_dbg(&usblp->intf->dev,
  522. "usblp%d requested/got HP channel %ld/%d\n",
  523. usblp->minor, arg, newChannel);
  524. break;
  525. case IOCNR_GET_BUS_ADDRESS:
  526. if (_IOC_DIR(cmd) != _IOC_READ ||
  527. _IOC_SIZE(cmd) < sizeof(twoints)) {
  528. retval = -EINVAL;
  529. goto done;
  530. }
  531. twoints[0] = usblp->dev->bus->busnum;
  532. twoints[1] = usblp->dev->devnum;
  533. if (copy_to_user((void __user *)arg,
  534. (unsigned char *)twoints,
  535. sizeof(twoints))) {
  536. retval = -EFAULT;
  537. goto done;
  538. }
  539. dev_dbg(&usblp->intf->dev,
  540. "usblp%d is bus=%d, device=%d\n",
  541. usblp->minor, twoints[0], twoints[1]);
  542. break;
  543. case IOCNR_GET_VID_PID:
  544. if (_IOC_DIR(cmd) != _IOC_READ ||
  545. _IOC_SIZE(cmd) < sizeof(twoints)) {
  546. retval = -EINVAL;
  547. goto done;
  548. }
  549. twoints[0] = le16_to_cpu(usblp->dev->descriptor.idVendor);
  550. twoints[1] = le16_to_cpu(usblp->dev->descriptor.idProduct);
  551. if (copy_to_user((void __user *)arg,
  552. (unsigned char *)twoints,
  553. sizeof(twoints))) {
  554. retval = -EFAULT;
  555. goto done;
  556. }
  557. dev_dbg(&usblp->intf->dev,
  558. "usblp%d is VID=0x%4.4X, PID=0x%4.4X\n",
  559. usblp->minor, twoints[0], twoints[1]);
  560. break;
  561. case IOCNR_SOFT_RESET:
  562. if (_IOC_DIR(cmd) != _IOC_NONE) {
  563. retval = -EINVAL;
  564. goto done;
  565. }
  566. retval = usblp_reset(usblp);
  567. break;
  568. default:
  569. retval = -ENOTTY;
  570. }
  571. else /* old-style ioctl value */
  572. switch (cmd) {
  573. case LPGETSTATUS:
  574. retval = usblp_read_status(usblp, usblp->statusbuf);
  575. if (retval) {
  576. printk_ratelimited(KERN_ERR "usblp%d:"
  577. "failed reading printer status (%d)\n",
  578. usblp->minor, retval);
  579. retval = -EIO;
  580. goto done;
  581. }
  582. status = *usblp->statusbuf;
  583. if (copy_to_user((void __user *)arg, &status, sizeof(int)))
  584. retval = -EFAULT;
  585. break;
  586. case LPABORT:
  587. if (arg)
  588. usblp->flags |= LP_ABORT;
  589. else
  590. usblp->flags &= ~LP_ABORT;
  591. break;
  592. default:
  593. retval = -ENOTTY;
  594. }
  595. done:
  596. mutex_unlock(&usblp->mut);
  597. return retval;
  598. }
  599. static struct urb *usblp_new_writeurb(struct usblp *usblp, int transfer_length)
  600. {
  601. struct urb *urb;
  602. char *writebuf;
  603. writebuf = kmalloc(transfer_length, GFP_KERNEL);
  604. if (writebuf == NULL)
  605. return NULL;
  606. urb = usb_alloc_urb(0, GFP_KERNEL);
  607. if (urb == NULL) {
  608. kfree(writebuf);
  609. return NULL;
  610. }
  611. usb_fill_bulk_urb(urb, usblp->dev,
  612. usb_sndbulkpipe(usblp->dev,
  613. usblp->protocol[usblp->current_protocol].epwrite->bEndpointAddress),
  614. writebuf, transfer_length, usblp_bulk_write, usblp);
  615. urb->transfer_flags |= URB_FREE_BUFFER;
  616. return urb;
  617. }
  618. static ssize_t usblp_write(struct file *file, const char __user *buffer, size_t count, loff_t *ppos)
  619. {
  620. struct usblp *usblp = file->private_data;
  621. struct urb *writeurb;
  622. int rv;
  623. int transfer_length;
  624. ssize_t writecount = 0;
  625. if (mutex_lock_interruptible(&usblp->wmut)) {
  626. rv = -EINTR;
  627. goto raise_biglock;
  628. }
  629. if ((rv = usblp_wwait(usblp, !!(file->f_flags & O_NONBLOCK))) < 0)
  630. goto raise_wait;
  631. while (writecount < count) {
  632. /*
  633. * Step 1: Submit next block.
  634. */
  635. if ((transfer_length = count - writecount) > USBLP_BUF_SIZE)
  636. transfer_length = USBLP_BUF_SIZE;
  637. rv = -ENOMEM;
  638. writeurb = usblp_new_writeurb(usblp, transfer_length);
  639. if (writeurb == NULL)
  640. goto raise_urb;
  641. usb_anchor_urb(writeurb, &usblp->urbs);
  642. if (copy_from_user(writeurb->transfer_buffer,
  643. buffer + writecount, transfer_length)) {
  644. rv = -EFAULT;
  645. goto raise_badaddr;
  646. }
  647. spin_lock_irq(&usblp->lock);
  648. usblp->wcomplete = 0;
  649. spin_unlock_irq(&usblp->lock);
  650. if ((rv = usb_submit_urb(writeurb, GFP_KERNEL)) < 0) {
  651. usblp->wstatus = 0;
  652. spin_lock_irq(&usblp->lock);
  653. usblp->no_paper = 0;
  654. usblp->wcomplete = 1;
  655. wake_up(&usblp->wwait);
  656. spin_unlock_irq(&usblp->lock);
  657. if (rv != -ENOMEM)
  658. rv = -EIO;
  659. goto raise_submit;
  660. }
  661. /*
  662. * Step 2: Wait for transfer to end, collect results.
  663. */
  664. rv = usblp_wwait(usblp, !!(file->f_flags&O_NONBLOCK));
  665. if (rv < 0) {
  666. if (rv == -EAGAIN) {
  667. /* Presume that it's going to complete well. */
  668. writecount += transfer_length;
  669. }
  670. if (rv == -ENOSPC) {
  671. spin_lock_irq(&usblp->lock);
  672. usblp->no_paper = 1; /* Mark for poll(2) */
  673. spin_unlock_irq(&usblp->lock);
  674. writecount += transfer_length;
  675. }
  676. /* Leave URB dangling, to be cleaned on close. */
  677. goto collect_error;
  678. }
  679. if (usblp->wstatus < 0) {
  680. rv = -EIO;
  681. goto collect_error;
  682. }
  683. /*
  684. * This is critical: it must be our URB, not other writer's.
  685. * The wmut exists mainly to cover us here.
  686. */
  687. writecount += usblp->wstatus;
  688. }
  689. mutex_unlock(&usblp->wmut);
  690. return writecount;
  691. raise_submit:
  692. raise_badaddr:
  693. usb_unanchor_urb(writeurb);
  694. usb_free_urb(writeurb);
  695. raise_urb:
  696. raise_wait:
  697. collect_error: /* Out of raise sequence */
  698. mutex_unlock(&usblp->wmut);
  699. raise_biglock:
  700. return writecount ? writecount : rv;
  701. }
  702. /*
  703. * Notice that we fail to restart in a few cases: on EFAULT, on restart
  704. * error, etc. This is the historical behaviour. In all such cases we return
  705. * EIO, and applications loop in order to get the new read going.
  706. */
  707. static ssize_t usblp_read(struct file *file, char __user *buffer, size_t len, loff_t *ppos)
  708. {
  709. struct usblp *usblp = file->private_data;
  710. ssize_t count;
  711. ssize_t avail;
  712. int rv;
  713. if (!usblp->bidir)
  714. return -EINVAL;
  715. rv = usblp_rwait_and_lock(usblp, !!(file->f_flags & O_NONBLOCK));
  716. if (rv < 0)
  717. return rv;
  718. if ((avail = usblp->rstatus) < 0) {
  719. printk(KERN_ERR "usblp%d: error %d reading from printer\n",
  720. usblp->minor, (int)avail);
  721. usblp_submit_read(usblp);
  722. count = -EIO;
  723. goto done;
  724. }
  725. count = len < avail - usblp->readcount ? len : avail - usblp->readcount;
  726. if (count != 0 &&
  727. copy_to_user(buffer, usblp->readbuf + usblp->readcount, count)) {
  728. count = -EFAULT;
  729. goto done;
  730. }
  731. if ((usblp->readcount += count) == avail) {
  732. if (usblp_submit_read(usblp) < 0) {
  733. /* We don't want to leak USB return codes into errno. */
  734. if (count == 0)
  735. count = -EIO;
  736. goto done;
  737. }
  738. }
  739. done:
  740. mutex_unlock(&usblp->mut);
  741. return count;
  742. }
  743. /*
  744. * Wait for the write path to come idle.
  745. * This is called under the ->wmut, so the idle path stays idle.
  746. *
  747. * Our write path has a peculiar property: it does not buffer like a tty,
  748. * but waits for the write to succeed. This allows our ->release to bug out
  749. * without waiting for writes to drain. But it obviously does not work
  750. * when O_NONBLOCK is set. So, applications setting O_NONBLOCK must use
  751. * select(2) or poll(2) to wait for the buffer to drain before closing.
  752. * Alternatively, set blocking mode with fcntl and issue a zero-size write.
  753. */
  754. static int usblp_wwait(struct usblp *usblp, int nonblock)
  755. {
  756. DECLARE_WAITQUEUE(waita, current);
  757. int rc;
  758. int err = 0;
  759. add_wait_queue(&usblp->wwait, &waita);
  760. for (;;) {
  761. if (mutex_lock_interruptible(&usblp->mut)) {
  762. rc = -EINTR;
  763. break;
  764. }
  765. set_current_state(TASK_INTERRUPTIBLE);
  766. rc = usblp_wtest(usblp, nonblock);
  767. mutex_unlock(&usblp->mut);
  768. if (rc <= 0)
  769. break;
  770. if (schedule_timeout(msecs_to_jiffies(1500)) == 0) {
  771. if (usblp->flags & LP_ABORT) {
  772. err = usblp_check_status(usblp, err);
  773. if (err == 1) { /* Paper out */
  774. rc = -ENOSPC;
  775. break;
  776. }
  777. } else {
  778. /* Prod the printer, Gentoo#251237. */
  779. mutex_lock(&usblp->mut);
  780. usblp_read_status(usblp, usblp->statusbuf);
  781. mutex_unlock(&usblp->mut);
  782. }
  783. }
  784. }
  785. set_current_state(TASK_RUNNING);
  786. remove_wait_queue(&usblp->wwait, &waita);
  787. return rc;
  788. }
  789. static int usblp_wtest(struct usblp *usblp, int nonblock)
  790. {
  791. unsigned long flags;
  792. if (!usblp->present)
  793. return -ENODEV;
  794. if (signal_pending(current))
  795. return -EINTR;
  796. spin_lock_irqsave(&usblp->lock, flags);
  797. if (usblp->wcomplete) {
  798. spin_unlock_irqrestore(&usblp->lock, flags);
  799. return 0;
  800. }
  801. spin_unlock_irqrestore(&usblp->lock, flags);
  802. if (nonblock)
  803. return -EAGAIN;
  804. return 1;
  805. }
  806. /*
  807. * Wait for read bytes to become available. This probably should have been
  808. * called usblp_r_lock_and_wait(), because we lock first. But it's a traditional
  809. * name for functions which lock and return.
  810. *
  811. * We do not use wait_event_interruptible because it makes locking iffy.
  812. */
  813. static int usblp_rwait_and_lock(struct usblp *usblp, int nonblock)
  814. {
  815. DECLARE_WAITQUEUE(waita, current);
  816. int rc;
  817. add_wait_queue(&usblp->rwait, &waita);
  818. for (;;) {
  819. if (mutex_lock_interruptible(&usblp->mut)) {
  820. rc = -EINTR;
  821. break;
  822. }
  823. set_current_state(TASK_INTERRUPTIBLE);
  824. if ((rc = usblp_rtest(usblp, nonblock)) < 0) {
  825. mutex_unlock(&usblp->mut);
  826. break;
  827. }
  828. if (rc == 0) /* Keep it locked */
  829. break;
  830. mutex_unlock(&usblp->mut);
  831. schedule();
  832. }
  833. set_current_state(TASK_RUNNING);
  834. remove_wait_queue(&usblp->rwait, &waita);
  835. return rc;
  836. }
  837. static int usblp_rtest(struct usblp *usblp, int nonblock)
  838. {
  839. unsigned long flags;
  840. if (!usblp->present)
  841. return -ENODEV;
  842. if (signal_pending(current))
  843. return -EINTR;
  844. spin_lock_irqsave(&usblp->lock, flags);
  845. if (usblp->rcomplete) {
  846. spin_unlock_irqrestore(&usblp->lock, flags);
  847. return 0;
  848. }
  849. spin_unlock_irqrestore(&usblp->lock, flags);
  850. if (nonblock)
  851. return -EAGAIN;
  852. return 1;
  853. }
  854. /*
  855. * Please check ->bidir and other such things outside for now.
  856. */
  857. static int usblp_submit_read(struct usblp *usblp)
  858. {
  859. struct urb *urb;
  860. unsigned long flags;
  861. int rc;
  862. rc = -ENOMEM;
  863. urb = usb_alloc_urb(0, GFP_KERNEL);
  864. if (urb == NULL)
  865. goto raise_urb;
  866. usb_fill_bulk_urb(urb, usblp->dev,
  867. usb_rcvbulkpipe(usblp->dev,
  868. usblp->protocol[usblp->current_protocol].epread->bEndpointAddress),
  869. usblp->readbuf, USBLP_BUF_SIZE_IN,
  870. usblp_bulk_read, usblp);
  871. usb_anchor_urb(urb, &usblp->urbs);
  872. spin_lock_irqsave(&usblp->lock, flags);
  873. usblp->readcount = 0; /* XXX Why here? */
  874. usblp->rcomplete = 0;
  875. spin_unlock_irqrestore(&usblp->lock, flags);
  876. if ((rc = usb_submit_urb(urb, GFP_KERNEL)) < 0) {
  877. dev_dbg(&usblp->intf->dev, "error submitting urb (%d)\n", rc);
  878. spin_lock_irqsave(&usblp->lock, flags);
  879. usblp->rstatus = rc;
  880. usblp->rcomplete = 1;
  881. spin_unlock_irqrestore(&usblp->lock, flags);
  882. goto raise_submit;
  883. }
  884. return 0;
  885. raise_submit:
  886. usb_unanchor_urb(urb);
  887. usb_free_urb(urb);
  888. raise_urb:
  889. return rc;
  890. }
  891. /*
  892. * Checks for printers that have quirks, such as requiring unidirectional
  893. * communication but reporting bidirectional; currently some HP printers
  894. * have this flaw (HP 810, 880, 895, etc.), or needing an init string
  895. * sent at each open (like some Epsons).
  896. * Returns 1 if found, 0 if not found.
  897. *
  898. * HP recommended that we use the bidirectional interface but
  899. * don't attempt any bulk IN transfers from the IN endpoint.
  900. * Here's some more detail on the problem:
  901. * The problem is not that it isn't bidirectional though. The problem
  902. * is that if you request a device ID, or status information, while
  903. * the buffers are full, the return data will end up in the print data
  904. * buffer. For example if you make sure you never request the device ID
  905. * while you are sending print data, and you don't try to query the
  906. * printer status every couple of milliseconds, you will probably be OK.
  907. */
  908. static unsigned int usblp_quirks(__u16 vendor, __u16 product)
  909. {
  910. int i;
  911. for (i = 0; quirk_printers[i].vendorId; i++) {
  912. if (vendor == quirk_printers[i].vendorId &&
  913. product == quirk_printers[i].productId)
  914. return quirk_printers[i].quirks;
  915. }
  916. return 0;
  917. }
  918. static const struct file_operations usblp_fops = {
  919. .owner = THIS_MODULE,
  920. .read = usblp_read,
  921. .write = usblp_write,
  922. .poll = usblp_poll,
  923. .unlocked_ioctl = usblp_ioctl,
  924. .compat_ioctl = usblp_ioctl,
  925. .open = usblp_open,
  926. .release = usblp_release,
  927. .llseek = noop_llseek,
  928. };
  929. static char *usblp_devnode(struct device *dev, umode_t *mode)
  930. {
  931. return kasprintf(GFP_KERNEL, "usb/%s", dev_name(dev));
  932. }
  933. static struct usb_class_driver usblp_class = {
  934. .name = "lp%d",
  935. .devnode = usblp_devnode,
  936. .fops = &usblp_fops,
  937. .minor_base = USBLP_MINOR_BASE,
  938. };
  939. static ssize_t ieee1284_id_show(struct device *dev, struct device_attribute *attr, char *buf)
  940. {
  941. struct usb_interface *intf = to_usb_interface(dev);
  942. struct usblp *usblp = usb_get_intfdata(intf);
  943. if (usblp->device_id_string[0] == 0 &&
  944. usblp->device_id_string[1] == 0)
  945. return 0;
  946. return sprintf(buf, "%s", usblp->device_id_string+2);
  947. }
  948. static DEVICE_ATTR_RO(ieee1284_id);
  949. static int usblp_probe(struct usb_interface *intf,
  950. const struct usb_device_id *id)
  951. {
  952. struct usb_device *dev = interface_to_usbdev(intf);
  953. struct usblp *usblp;
  954. int protocol;
  955. int retval;
  956. /* Malloc and start initializing usblp structure so we can use it
  957. * directly. */
  958. usblp = kzalloc(sizeof(struct usblp), GFP_KERNEL);
  959. if (!usblp) {
  960. retval = -ENOMEM;
  961. goto abort_ret;
  962. }
  963. usblp->dev = dev;
  964. mutex_init(&usblp->wmut);
  965. mutex_init(&usblp->mut);
  966. spin_lock_init(&usblp->lock);
  967. init_waitqueue_head(&usblp->rwait);
  968. init_waitqueue_head(&usblp->wwait);
  969. init_usb_anchor(&usblp->urbs);
  970. usblp->ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
  971. usblp->intf = intf;
  972. /* Malloc device ID string buffer to the largest expected length,
  973. * since we can re-query it on an ioctl and a dynamic string
  974. * could change in length. */
  975. if (!(usblp->device_id_string = kmalloc(USBLP_DEVICE_ID_SIZE, GFP_KERNEL))) {
  976. retval = -ENOMEM;
  977. goto abort;
  978. }
  979. /*
  980. * Allocate read buffer. We somewhat wastefully
  981. * malloc both regardless of bidirectionality, because the
  982. * alternate setting can be changed later via an ioctl.
  983. */
  984. if (!(usblp->readbuf = kmalloc(USBLP_BUF_SIZE_IN, GFP_KERNEL))) {
  985. retval = -ENOMEM;
  986. goto abort;
  987. }
  988. /* Allocate buffer for printer status */
  989. usblp->statusbuf = kmalloc(STATUS_BUF_SIZE, GFP_KERNEL);
  990. if (!usblp->statusbuf) {
  991. retval = -ENOMEM;
  992. goto abort;
  993. }
  994. /* Lookup quirks for this printer. */
  995. usblp->quirks = usblp_quirks(
  996. le16_to_cpu(dev->descriptor.idVendor),
  997. le16_to_cpu(dev->descriptor.idProduct));
  998. /* Analyze and pick initial alternate settings and endpoints. */
  999. protocol = usblp_select_alts(usblp);
  1000. if (protocol < 0) {
  1001. dev_dbg(&intf->dev,
  1002. "incompatible printer-class device 0x%4.4X/0x%4.4X\n",
  1003. le16_to_cpu(dev->descriptor.idVendor),
  1004. le16_to_cpu(dev->descriptor.idProduct));
  1005. retval = -ENODEV;
  1006. goto abort;
  1007. }
  1008. /* Setup the selected alternate setting and endpoints. */
  1009. if (usblp_set_protocol(usblp, protocol) < 0) {
  1010. retval = -ENODEV; /* ->probe isn't ->ioctl */
  1011. goto abort;
  1012. }
  1013. /* Retrieve and store the device ID string. */
  1014. usblp_cache_device_id_string(usblp);
  1015. retval = device_create_file(&intf->dev, &dev_attr_ieee1284_id);
  1016. if (retval)
  1017. goto abort_intfdata;
  1018. #ifdef DEBUG
  1019. usblp_check_status(usblp, 0);
  1020. #endif
  1021. usb_set_intfdata(intf, usblp);
  1022. usblp->present = 1;
  1023. retval = usb_register_dev(intf, &usblp_class);
  1024. if (retval) {
  1025. dev_err(&intf->dev,
  1026. "usblp: Not able to get a minor (base %u, slice default): %d\n",
  1027. USBLP_MINOR_BASE, retval);
  1028. goto abort_intfdata;
  1029. }
  1030. usblp->minor = intf->minor;
  1031. dev_info(&intf->dev,
  1032. "usblp%d: USB %sdirectional printer dev %d if %d alt %d proto %d vid 0x%4.4X pid 0x%4.4X\n",
  1033. usblp->minor, usblp->bidir ? "Bi" : "Uni", dev->devnum,
  1034. usblp->ifnum,
  1035. usblp->protocol[usblp->current_protocol].alt_setting,
  1036. usblp->current_protocol,
  1037. le16_to_cpu(usblp->dev->descriptor.idVendor),
  1038. le16_to_cpu(usblp->dev->descriptor.idProduct));
  1039. return 0;
  1040. abort_intfdata:
  1041. usb_set_intfdata(intf, NULL);
  1042. device_remove_file(&intf->dev, &dev_attr_ieee1284_id);
  1043. abort:
  1044. kfree(usblp->readbuf);
  1045. kfree(usblp->statusbuf);
  1046. kfree(usblp->device_id_string);
  1047. kfree(usblp);
  1048. abort_ret:
  1049. return retval;
  1050. }
  1051. /*
  1052. * We are a "new" style driver with usb_device_id table,
  1053. * but our requirements are too intricate for simple match to handle.
  1054. *
  1055. * The "proto_bias" option may be used to specify the preferred protocol
  1056. * for all USB printers (1=USB_CLASS_PRINTER/1/1, 2=USB_CLASS_PRINTER/1/2,
  1057. * 3=USB_CLASS_PRINTER/1/3). If the device supports the preferred protocol,
  1058. * then we bind to it.
  1059. *
  1060. * The best interface for us is USB_CLASS_PRINTER/1/2, because it
  1061. * is compatible with a stream of characters. If we find it, we bind to it.
  1062. *
  1063. * Note that the people from hpoj.sourceforge.net need to be able to
  1064. * bind to USB_CLASS_PRINTER/1/3 (MLC/1284.4), so we provide them ioctls
  1065. * for this purpose.
  1066. *
  1067. * Failing USB_CLASS_PRINTER/1/2, we look for USB_CLASS_PRINTER/1/3,
  1068. * even though it's probably not stream-compatible, because this matches
  1069. * the behaviour of the old code.
  1070. *
  1071. * If nothing else, we bind to USB_CLASS_PRINTER/1/1
  1072. * - the unidirectional interface.
  1073. */
  1074. static int usblp_select_alts(struct usblp *usblp)
  1075. {
  1076. struct usb_interface *if_alt;
  1077. struct usb_host_interface *ifd;
  1078. struct usb_endpoint_descriptor *epwrite, *epread;
  1079. int p, i;
  1080. int res;
  1081. if_alt = usblp->intf;
  1082. for (p = 0; p < USBLP_MAX_PROTOCOLS; p++)
  1083. usblp->protocol[p].alt_setting = -1;
  1084. /* Find out what we have. */
  1085. for (i = 0; i < if_alt->num_altsetting; i++) {
  1086. ifd = &if_alt->altsetting[i];
  1087. if (ifd->desc.bInterfaceClass != USB_CLASS_PRINTER ||
  1088. ifd->desc.bInterfaceSubClass != 1)
  1089. if (!(usblp->quirks & USBLP_QUIRK_BAD_CLASS))
  1090. continue;
  1091. if (ifd->desc.bInterfaceProtocol < USBLP_FIRST_PROTOCOL ||
  1092. ifd->desc.bInterfaceProtocol > USBLP_LAST_PROTOCOL)
  1093. continue;
  1094. /* Look for the expected bulk endpoints. */
  1095. if (ifd->desc.bInterfaceProtocol > 1) {
  1096. res = usb_find_common_endpoints(ifd,
  1097. &epread, &epwrite, NULL, NULL);
  1098. } else {
  1099. epread = NULL;
  1100. res = usb_find_bulk_out_endpoint(ifd, &epwrite);
  1101. }
  1102. /* Ignore buggy hardware without the right endpoints. */
  1103. if (res)
  1104. continue;
  1105. /* Turn off reads for buggy bidirectional printers. */
  1106. if (usblp->quirks & USBLP_QUIRK_BIDIR) {
  1107. printk(KERN_INFO "usblp%d: Disabling reads from "
  1108. "problematic bidirectional printer\n",
  1109. usblp->minor);
  1110. epread = NULL;
  1111. }
  1112. usblp->protocol[ifd->desc.bInterfaceProtocol].alt_setting =
  1113. ifd->desc.bAlternateSetting;
  1114. usblp->protocol[ifd->desc.bInterfaceProtocol].epwrite = epwrite;
  1115. usblp->protocol[ifd->desc.bInterfaceProtocol].epread = epread;
  1116. }
  1117. /* If our requested protocol is supported, then use it. */
  1118. if (proto_bias >= USBLP_FIRST_PROTOCOL &&
  1119. proto_bias <= USBLP_LAST_PROTOCOL &&
  1120. usblp->protocol[proto_bias].alt_setting != -1)
  1121. return proto_bias;
  1122. /* Ordering is important here. */
  1123. if (usblp->protocol[2].alt_setting != -1)
  1124. return 2;
  1125. if (usblp->protocol[1].alt_setting != -1)
  1126. return 1;
  1127. if (usblp->protocol[3].alt_setting != -1)
  1128. return 3;
  1129. /* If nothing is available, then don't bind to this device. */
  1130. return -1;
  1131. }
  1132. static int usblp_set_protocol(struct usblp *usblp, int protocol)
  1133. {
  1134. int r, alts;
  1135. if (protocol < USBLP_FIRST_PROTOCOL || protocol > USBLP_LAST_PROTOCOL)
  1136. return -EINVAL;
  1137. alts = usblp->protocol[protocol].alt_setting;
  1138. if (alts < 0)
  1139. return -EINVAL;
  1140. r = usb_set_interface(usblp->dev, usblp->ifnum, alts);
  1141. if (r < 0) {
  1142. printk(KERN_ERR "usblp: can't set desired altsetting %d on interface %d\n",
  1143. alts, usblp->ifnum);
  1144. return r;
  1145. }
  1146. usblp->bidir = (usblp->protocol[protocol].epread != NULL);
  1147. usblp->current_protocol = protocol;
  1148. dev_dbg(&usblp->intf->dev, "usblp%d set protocol %d\n",
  1149. usblp->minor, protocol);
  1150. return 0;
  1151. }
  1152. /* Retrieves and caches device ID string.
  1153. * Returns length, including length bytes but not null terminator.
  1154. * On error, returns a negative errno value. */
  1155. static int usblp_cache_device_id_string(struct usblp *usblp)
  1156. {
  1157. int err, length;
  1158. err = usblp_get_id(usblp, 0, usblp->device_id_string, USBLP_DEVICE_ID_SIZE - 1);
  1159. if (err < 0) {
  1160. dev_dbg(&usblp->intf->dev,
  1161. "usblp%d: error = %d reading IEEE-1284 Device ID string\n",
  1162. usblp->minor, err);
  1163. usblp->device_id_string[0] = usblp->device_id_string[1] = '\0';
  1164. return -EIO;
  1165. }
  1166. /* First two bytes are length in big-endian.
  1167. * They count themselves, and we copy them into
  1168. * the user's buffer. */
  1169. length = be16_to_cpu(*((__be16 *)usblp->device_id_string));
  1170. if (length < 2)
  1171. length = 2;
  1172. else if (length >= USBLP_DEVICE_ID_SIZE)
  1173. length = USBLP_DEVICE_ID_SIZE - 1;
  1174. usblp->device_id_string[length] = '\0';
  1175. dev_dbg(&usblp->intf->dev, "usblp%d Device ID string [len=%d]=\"%s\"\n",
  1176. usblp->minor, length, &usblp->device_id_string[2]);
  1177. return length;
  1178. }
  1179. static void usblp_disconnect(struct usb_interface *intf)
  1180. {
  1181. struct usblp *usblp = usb_get_intfdata(intf);
  1182. usb_deregister_dev(intf, &usblp_class);
  1183. if (!usblp || !usblp->dev) {
  1184. dev_err(&intf->dev, "bogus disconnect\n");
  1185. BUG();
  1186. }
  1187. device_remove_file(&intf->dev, &dev_attr_ieee1284_id);
  1188. mutex_lock(&usblp_mutex);
  1189. mutex_lock(&usblp->mut);
  1190. usblp->present = 0;
  1191. wake_up(&usblp->wwait);
  1192. wake_up(&usblp->rwait);
  1193. usb_set_intfdata(intf, NULL);
  1194. usblp_unlink_urbs(usblp);
  1195. mutex_unlock(&usblp->mut);
  1196. if (!usblp->used)
  1197. usblp_cleanup(usblp);
  1198. mutex_unlock(&usblp_mutex);
  1199. }
  1200. static int usblp_suspend(struct usb_interface *intf, pm_message_t message)
  1201. {
  1202. struct usblp *usblp = usb_get_intfdata(intf);
  1203. usblp_unlink_urbs(usblp);
  1204. #if 0 /* XXX Do we want this? What if someone is reading, should we fail? */
  1205. /* not strictly necessary, but just in case */
  1206. wake_up(&usblp->wwait);
  1207. wake_up(&usblp->rwait);
  1208. #endif
  1209. return 0;
  1210. }
  1211. static int usblp_resume(struct usb_interface *intf)
  1212. {
  1213. struct usblp *usblp = usb_get_intfdata(intf);
  1214. int r;
  1215. r = handle_bidir(usblp);
  1216. return r;
  1217. }
  1218. static const struct usb_device_id usblp_ids[] = {
  1219. { USB_DEVICE_INFO(USB_CLASS_PRINTER, 1, 1) },
  1220. { USB_DEVICE_INFO(USB_CLASS_PRINTER, 1, 2) },
  1221. { USB_DEVICE_INFO(USB_CLASS_PRINTER, 1, 3) },
  1222. { USB_INTERFACE_INFO(USB_CLASS_PRINTER, 1, 1) },
  1223. { USB_INTERFACE_INFO(USB_CLASS_PRINTER, 1, 2) },
  1224. { USB_INTERFACE_INFO(USB_CLASS_PRINTER, 1, 3) },
  1225. { USB_DEVICE(0x04b8, 0x0202) }, /* Seiko Epson Receipt Printer M129C */
  1226. { } /* Terminating entry */
  1227. };
  1228. MODULE_DEVICE_TABLE(usb, usblp_ids);
  1229. static struct usb_driver usblp_driver = {
  1230. .name = "usblp",
  1231. .probe = usblp_probe,
  1232. .disconnect = usblp_disconnect,
  1233. .suspend = usblp_suspend,
  1234. .resume = usblp_resume,
  1235. .id_table = usblp_ids,
  1236. .supports_autosuspend = 1,
  1237. };
  1238. module_usb_driver(usblp_driver);
  1239. MODULE_AUTHOR(DRIVER_AUTHOR);
  1240. MODULE_DESCRIPTION(DRIVER_DESC);
  1241. module_param(proto_bias, int, S_IRUGO | S_IWUSR);
  1242. MODULE_PARM_DESC(proto_bias, "Favourite protocol number");
  1243. MODULE_LICENSE("GPL");