usblp.c 39 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438
  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. usb_put_intf(usblp->intf);
  395. kfree(usblp);
  396. }
  397. static void usblp_unlink_urbs(struct usblp *usblp)
  398. {
  399. usb_kill_anchored_urbs(&usblp->urbs);
  400. }
  401. static int usblp_release(struct inode *inode, struct file *file)
  402. {
  403. struct usblp *usblp = file->private_data;
  404. usblp->flags &= ~LP_ABORT;
  405. mutex_lock(&usblp_mutex);
  406. usblp->used = 0;
  407. if (usblp->present)
  408. usblp_unlink_urbs(usblp);
  409. usb_autopm_put_interface(usblp->intf);
  410. if (!usblp->present) /* finish cleanup from disconnect */
  411. usblp_cleanup(usblp);
  412. mutex_unlock(&usblp_mutex);
  413. return 0;
  414. }
  415. /* No kernel lock - fine */
  416. static __poll_t usblp_poll(struct file *file, struct poll_table_struct *wait)
  417. {
  418. __poll_t ret;
  419. unsigned long flags;
  420. struct usblp *usblp = file->private_data;
  421. /* Should we check file->f_mode & FMODE_WRITE before poll_wait()? */
  422. poll_wait(file, &usblp->rwait, wait);
  423. poll_wait(file, &usblp->wwait, wait);
  424. spin_lock_irqsave(&usblp->lock, flags);
  425. ret = ((usblp->bidir && usblp->rcomplete) ? EPOLLIN | EPOLLRDNORM : 0) |
  426. ((usblp->no_paper || usblp->wcomplete) ? EPOLLOUT | EPOLLWRNORM : 0);
  427. spin_unlock_irqrestore(&usblp->lock, flags);
  428. return ret;
  429. }
  430. static long usblp_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
  431. {
  432. struct usblp *usblp = file->private_data;
  433. int length, err, i;
  434. unsigned char newChannel;
  435. int status;
  436. int twoints[2];
  437. int retval = 0;
  438. mutex_lock(&usblp->mut);
  439. if (!usblp->present) {
  440. retval = -ENODEV;
  441. goto done;
  442. }
  443. dev_dbg(&usblp->intf->dev,
  444. "usblp_ioctl: cmd=0x%x (%c nr=%d len=%d dir=%d)\n", cmd,
  445. _IOC_TYPE(cmd), _IOC_NR(cmd), _IOC_SIZE(cmd), _IOC_DIR(cmd));
  446. if (_IOC_TYPE(cmd) == 'P') /* new-style ioctl number */
  447. switch (_IOC_NR(cmd)) {
  448. case IOCNR_GET_DEVICE_ID: /* get the DEVICE_ID string */
  449. if (_IOC_DIR(cmd) != _IOC_READ) {
  450. retval = -EINVAL;
  451. goto done;
  452. }
  453. length = usblp_cache_device_id_string(usblp);
  454. if (length < 0) {
  455. retval = length;
  456. goto done;
  457. }
  458. if (length > _IOC_SIZE(cmd))
  459. length = _IOC_SIZE(cmd); /* truncate */
  460. if (copy_to_user((void __user *) arg,
  461. usblp->device_id_string,
  462. (unsigned long) length)) {
  463. retval = -EFAULT;
  464. goto done;
  465. }
  466. break;
  467. case IOCNR_GET_PROTOCOLS:
  468. if (_IOC_DIR(cmd) != _IOC_READ ||
  469. _IOC_SIZE(cmd) < sizeof(twoints)) {
  470. retval = -EINVAL;
  471. goto done;
  472. }
  473. twoints[0] = usblp->current_protocol;
  474. twoints[1] = 0;
  475. for (i = USBLP_FIRST_PROTOCOL;
  476. i <= USBLP_LAST_PROTOCOL; i++) {
  477. if (usblp->protocol[i].alt_setting >= 0)
  478. twoints[1] |= (1<<i);
  479. }
  480. if (copy_to_user((void __user *)arg,
  481. (unsigned char *)twoints,
  482. sizeof(twoints))) {
  483. retval = -EFAULT;
  484. goto done;
  485. }
  486. break;
  487. case IOCNR_SET_PROTOCOL:
  488. if (_IOC_DIR(cmd) != _IOC_WRITE) {
  489. retval = -EINVAL;
  490. goto done;
  491. }
  492. #ifdef DEBUG
  493. if (arg == -10) {
  494. usblp_dump(usblp);
  495. break;
  496. }
  497. #endif
  498. usblp_unlink_urbs(usblp);
  499. retval = usblp_set_protocol(usblp, arg);
  500. if (retval < 0) {
  501. usblp_set_protocol(usblp,
  502. usblp->current_protocol);
  503. }
  504. break;
  505. case IOCNR_HP_SET_CHANNEL:
  506. if (_IOC_DIR(cmd) != _IOC_WRITE ||
  507. le16_to_cpu(usblp->dev->descriptor.idVendor) != 0x03F0 ||
  508. usblp->quirks & USBLP_QUIRK_BIDIR) {
  509. retval = -EINVAL;
  510. goto done;
  511. }
  512. err = usblp_hp_channel_change_request(usblp,
  513. arg, &newChannel);
  514. if (err < 0) {
  515. dev_err(&usblp->dev->dev,
  516. "usblp%d: error = %d setting "
  517. "HP channel\n",
  518. usblp->minor, err);
  519. retval = -EIO;
  520. goto done;
  521. }
  522. dev_dbg(&usblp->intf->dev,
  523. "usblp%d requested/got HP channel %ld/%d\n",
  524. usblp->minor, arg, newChannel);
  525. break;
  526. case IOCNR_GET_BUS_ADDRESS:
  527. if (_IOC_DIR(cmd) != _IOC_READ ||
  528. _IOC_SIZE(cmd) < sizeof(twoints)) {
  529. retval = -EINVAL;
  530. goto done;
  531. }
  532. twoints[0] = usblp->dev->bus->busnum;
  533. twoints[1] = usblp->dev->devnum;
  534. if (copy_to_user((void __user *)arg,
  535. (unsigned char *)twoints,
  536. sizeof(twoints))) {
  537. retval = -EFAULT;
  538. goto done;
  539. }
  540. dev_dbg(&usblp->intf->dev,
  541. "usblp%d is bus=%d, device=%d\n",
  542. usblp->minor, twoints[0], twoints[1]);
  543. break;
  544. case IOCNR_GET_VID_PID:
  545. if (_IOC_DIR(cmd) != _IOC_READ ||
  546. _IOC_SIZE(cmd) < sizeof(twoints)) {
  547. retval = -EINVAL;
  548. goto done;
  549. }
  550. twoints[0] = le16_to_cpu(usblp->dev->descriptor.idVendor);
  551. twoints[1] = le16_to_cpu(usblp->dev->descriptor.idProduct);
  552. if (copy_to_user((void __user *)arg,
  553. (unsigned char *)twoints,
  554. sizeof(twoints))) {
  555. retval = -EFAULT;
  556. goto done;
  557. }
  558. dev_dbg(&usblp->intf->dev,
  559. "usblp%d is VID=0x%4.4X, PID=0x%4.4X\n",
  560. usblp->minor, twoints[0], twoints[1]);
  561. break;
  562. case IOCNR_SOFT_RESET:
  563. if (_IOC_DIR(cmd) != _IOC_NONE) {
  564. retval = -EINVAL;
  565. goto done;
  566. }
  567. retval = usblp_reset(usblp);
  568. break;
  569. default:
  570. retval = -ENOTTY;
  571. }
  572. else /* old-style ioctl value */
  573. switch (cmd) {
  574. case LPGETSTATUS:
  575. retval = usblp_read_status(usblp, usblp->statusbuf);
  576. if (retval) {
  577. printk_ratelimited(KERN_ERR "usblp%d:"
  578. "failed reading printer status (%d)\n",
  579. usblp->minor, retval);
  580. retval = -EIO;
  581. goto done;
  582. }
  583. status = *usblp->statusbuf;
  584. if (copy_to_user((void __user *)arg, &status, sizeof(int)))
  585. retval = -EFAULT;
  586. break;
  587. case LPABORT:
  588. if (arg)
  589. usblp->flags |= LP_ABORT;
  590. else
  591. usblp->flags &= ~LP_ABORT;
  592. break;
  593. default:
  594. retval = -ENOTTY;
  595. }
  596. done:
  597. mutex_unlock(&usblp->mut);
  598. return retval;
  599. }
  600. static struct urb *usblp_new_writeurb(struct usblp *usblp, int transfer_length)
  601. {
  602. struct urb *urb;
  603. char *writebuf;
  604. writebuf = kmalloc(transfer_length, GFP_KERNEL);
  605. if (writebuf == NULL)
  606. return NULL;
  607. urb = usb_alloc_urb(0, GFP_KERNEL);
  608. if (urb == NULL) {
  609. kfree(writebuf);
  610. return NULL;
  611. }
  612. usb_fill_bulk_urb(urb, usblp->dev,
  613. usb_sndbulkpipe(usblp->dev,
  614. usblp->protocol[usblp->current_protocol].epwrite->bEndpointAddress),
  615. writebuf, transfer_length, usblp_bulk_write, usblp);
  616. urb->transfer_flags |= URB_FREE_BUFFER;
  617. return urb;
  618. }
  619. static ssize_t usblp_write(struct file *file, const char __user *buffer, size_t count, loff_t *ppos)
  620. {
  621. struct usblp *usblp = file->private_data;
  622. struct urb *writeurb;
  623. int rv;
  624. int transfer_length;
  625. ssize_t writecount = 0;
  626. if (mutex_lock_interruptible(&usblp->wmut)) {
  627. rv = -EINTR;
  628. goto raise_biglock;
  629. }
  630. if ((rv = usblp_wwait(usblp, !!(file->f_flags & O_NONBLOCK))) < 0)
  631. goto raise_wait;
  632. while (writecount < count) {
  633. /*
  634. * Step 1: Submit next block.
  635. */
  636. if ((transfer_length = count - writecount) > USBLP_BUF_SIZE)
  637. transfer_length = USBLP_BUF_SIZE;
  638. rv = -ENOMEM;
  639. writeurb = usblp_new_writeurb(usblp, transfer_length);
  640. if (writeurb == NULL)
  641. goto raise_urb;
  642. usb_anchor_urb(writeurb, &usblp->urbs);
  643. if (copy_from_user(writeurb->transfer_buffer,
  644. buffer + writecount, transfer_length)) {
  645. rv = -EFAULT;
  646. goto raise_badaddr;
  647. }
  648. spin_lock_irq(&usblp->lock);
  649. usblp->wcomplete = 0;
  650. spin_unlock_irq(&usblp->lock);
  651. if ((rv = usb_submit_urb(writeurb, GFP_KERNEL)) < 0) {
  652. usblp->wstatus = 0;
  653. spin_lock_irq(&usblp->lock);
  654. usblp->no_paper = 0;
  655. usblp->wcomplete = 1;
  656. wake_up(&usblp->wwait);
  657. spin_unlock_irq(&usblp->lock);
  658. if (rv != -ENOMEM)
  659. rv = -EIO;
  660. goto raise_submit;
  661. }
  662. /*
  663. * Step 2: Wait for transfer to end, collect results.
  664. */
  665. rv = usblp_wwait(usblp, !!(file->f_flags&O_NONBLOCK));
  666. if (rv < 0) {
  667. if (rv == -EAGAIN) {
  668. /* Presume that it's going to complete well. */
  669. writecount += transfer_length;
  670. }
  671. if (rv == -ENOSPC) {
  672. spin_lock_irq(&usblp->lock);
  673. usblp->no_paper = 1; /* Mark for poll(2) */
  674. spin_unlock_irq(&usblp->lock);
  675. writecount += transfer_length;
  676. }
  677. /* Leave URB dangling, to be cleaned on close. */
  678. goto collect_error;
  679. }
  680. if (usblp->wstatus < 0) {
  681. rv = -EIO;
  682. goto collect_error;
  683. }
  684. /*
  685. * This is critical: it must be our URB, not other writer's.
  686. * The wmut exists mainly to cover us here.
  687. */
  688. writecount += usblp->wstatus;
  689. }
  690. mutex_unlock(&usblp->wmut);
  691. return writecount;
  692. raise_submit:
  693. raise_badaddr:
  694. usb_unanchor_urb(writeurb);
  695. usb_free_urb(writeurb);
  696. raise_urb:
  697. raise_wait:
  698. collect_error: /* Out of raise sequence */
  699. mutex_unlock(&usblp->wmut);
  700. raise_biglock:
  701. return writecount ? writecount : rv;
  702. }
  703. /*
  704. * Notice that we fail to restart in a few cases: on EFAULT, on restart
  705. * error, etc. This is the historical behaviour. In all such cases we return
  706. * EIO, and applications loop in order to get the new read going.
  707. */
  708. static ssize_t usblp_read(struct file *file, char __user *buffer, size_t len, loff_t *ppos)
  709. {
  710. struct usblp *usblp = file->private_data;
  711. ssize_t count;
  712. ssize_t avail;
  713. int rv;
  714. if (!usblp->bidir)
  715. return -EINVAL;
  716. rv = usblp_rwait_and_lock(usblp, !!(file->f_flags & O_NONBLOCK));
  717. if (rv < 0)
  718. return rv;
  719. if ((avail = usblp->rstatus) < 0) {
  720. printk(KERN_ERR "usblp%d: error %d reading from printer\n",
  721. usblp->minor, (int)avail);
  722. usblp_submit_read(usblp);
  723. count = -EIO;
  724. goto done;
  725. }
  726. count = len < avail - usblp->readcount ? len : avail - usblp->readcount;
  727. if (count != 0 &&
  728. copy_to_user(buffer, usblp->readbuf + usblp->readcount, count)) {
  729. count = -EFAULT;
  730. goto done;
  731. }
  732. if ((usblp->readcount += count) == avail) {
  733. if (usblp_submit_read(usblp) < 0) {
  734. /* We don't want to leak USB return codes into errno. */
  735. if (count == 0)
  736. count = -EIO;
  737. goto done;
  738. }
  739. }
  740. done:
  741. mutex_unlock(&usblp->mut);
  742. return count;
  743. }
  744. /*
  745. * Wait for the write path to come idle.
  746. * This is called under the ->wmut, so the idle path stays idle.
  747. *
  748. * Our write path has a peculiar property: it does not buffer like a tty,
  749. * but waits for the write to succeed. This allows our ->release to bug out
  750. * without waiting for writes to drain. But it obviously does not work
  751. * when O_NONBLOCK is set. So, applications setting O_NONBLOCK must use
  752. * select(2) or poll(2) to wait for the buffer to drain before closing.
  753. * Alternatively, set blocking mode with fcntl and issue a zero-size write.
  754. */
  755. static int usblp_wwait(struct usblp *usblp, int nonblock)
  756. {
  757. DECLARE_WAITQUEUE(waita, current);
  758. int rc;
  759. int err = 0;
  760. add_wait_queue(&usblp->wwait, &waita);
  761. for (;;) {
  762. if (mutex_lock_interruptible(&usblp->mut)) {
  763. rc = -EINTR;
  764. break;
  765. }
  766. set_current_state(TASK_INTERRUPTIBLE);
  767. rc = usblp_wtest(usblp, nonblock);
  768. mutex_unlock(&usblp->mut);
  769. if (rc <= 0)
  770. break;
  771. if (schedule_timeout(msecs_to_jiffies(1500)) == 0) {
  772. if (usblp->flags & LP_ABORT) {
  773. err = usblp_check_status(usblp, err);
  774. if (err == 1) { /* Paper out */
  775. rc = -ENOSPC;
  776. break;
  777. }
  778. } else {
  779. /* Prod the printer, Gentoo#251237. */
  780. mutex_lock(&usblp->mut);
  781. usblp_read_status(usblp, usblp->statusbuf);
  782. mutex_unlock(&usblp->mut);
  783. }
  784. }
  785. }
  786. set_current_state(TASK_RUNNING);
  787. remove_wait_queue(&usblp->wwait, &waita);
  788. return rc;
  789. }
  790. static int usblp_wtest(struct usblp *usblp, int nonblock)
  791. {
  792. unsigned long flags;
  793. if (!usblp->present)
  794. return -ENODEV;
  795. if (signal_pending(current))
  796. return -EINTR;
  797. spin_lock_irqsave(&usblp->lock, flags);
  798. if (usblp->wcomplete) {
  799. spin_unlock_irqrestore(&usblp->lock, flags);
  800. return 0;
  801. }
  802. spin_unlock_irqrestore(&usblp->lock, flags);
  803. if (nonblock)
  804. return -EAGAIN;
  805. return 1;
  806. }
  807. /*
  808. * Wait for read bytes to become available. This probably should have been
  809. * called usblp_r_lock_and_wait(), because we lock first. But it's a traditional
  810. * name for functions which lock and return.
  811. *
  812. * We do not use wait_event_interruptible because it makes locking iffy.
  813. */
  814. static int usblp_rwait_and_lock(struct usblp *usblp, int nonblock)
  815. {
  816. DECLARE_WAITQUEUE(waita, current);
  817. int rc;
  818. add_wait_queue(&usblp->rwait, &waita);
  819. for (;;) {
  820. if (mutex_lock_interruptible(&usblp->mut)) {
  821. rc = -EINTR;
  822. break;
  823. }
  824. set_current_state(TASK_INTERRUPTIBLE);
  825. if ((rc = usblp_rtest(usblp, nonblock)) < 0) {
  826. mutex_unlock(&usblp->mut);
  827. break;
  828. }
  829. if (rc == 0) /* Keep it locked */
  830. break;
  831. mutex_unlock(&usblp->mut);
  832. schedule();
  833. }
  834. set_current_state(TASK_RUNNING);
  835. remove_wait_queue(&usblp->rwait, &waita);
  836. return rc;
  837. }
  838. static int usblp_rtest(struct usblp *usblp, int nonblock)
  839. {
  840. unsigned long flags;
  841. if (!usblp->present)
  842. return -ENODEV;
  843. if (signal_pending(current))
  844. return -EINTR;
  845. spin_lock_irqsave(&usblp->lock, flags);
  846. if (usblp->rcomplete) {
  847. spin_unlock_irqrestore(&usblp->lock, flags);
  848. return 0;
  849. }
  850. spin_unlock_irqrestore(&usblp->lock, flags);
  851. if (nonblock)
  852. return -EAGAIN;
  853. return 1;
  854. }
  855. /*
  856. * Please check ->bidir and other such things outside for now.
  857. */
  858. static int usblp_submit_read(struct usblp *usblp)
  859. {
  860. struct urb *urb;
  861. unsigned long flags;
  862. int rc;
  863. rc = -ENOMEM;
  864. urb = usb_alloc_urb(0, GFP_KERNEL);
  865. if (urb == NULL)
  866. goto raise_urb;
  867. usb_fill_bulk_urb(urb, usblp->dev,
  868. usb_rcvbulkpipe(usblp->dev,
  869. usblp->protocol[usblp->current_protocol].epread->bEndpointAddress),
  870. usblp->readbuf, USBLP_BUF_SIZE_IN,
  871. usblp_bulk_read, usblp);
  872. usb_anchor_urb(urb, &usblp->urbs);
  873. spin_lock_irqsave(&usblp->lock, flags);
  874. usblp->readcount = 0; /* XXX Why here? */
  875. usblp->rcomplete = 0;
  876. spin_unlock_irqrestore(&usblp->lock, flags);
  877. if ((rc = usb_submit_urb(urb, GFP_KERNEL)) < 0) {
  878. dev_dbg(&usblp->intf->dev, "error submitting urb (%d)\n", rc);
  879. spin_lock_irqsave(&usblp->lock, flags);
  880. usblp->rstatus = rc;
  881. usblp->rcomplete = 1;
  882. spin_unlock_irqrestore(&usblp->lock, flags);
  883. goto raise_submit;
  884. }
  885. return 0;
  886. raise_submit:
  887. usb_unanchor_urb(urb);
  888. usb_free_urb(urb);
  889. raise_urb:
  890. return rc;
  891. }
  892. /*
  893. * Checks for printers that have quirks, such as requiring unidirectional
  894. * communication but reporting bidirectional; currently some HP printers
  895. * have this flaw (HP 810, 880, 895, etc.), or needing an init string
  896. * sent at each open (like some Epsons).
  897. * Returns 1 if found, 0 if not found.
  898. *
  899. * HP recommended that we use the bidirectional interface but
  900. * don't attempt any bulk IN transfers from the IN endpoint.
  901. * Here's some more detail on the problem:
  902. * The problem is not that it isn't bidirectional though. The problem
  903. * is that if you request a device ID, or status information, while
  904. * the buffers are full, the return data will end up in the print data
  905. * buffer. For example if you make sure you never request the device ID
  906. * while you are sending print data, and you don't try to query the
  907. * printer status every couple of milliseconds, you will probably be OK.
  908. */
  909. static unsigned int usblp_quirks(__u16 vendor, __u16 product)
  910. {
  911. int i;
  912. for (i = 0; quirk_printers[i].vendorId; i++) {
  913. if (vendor == quirk_printers[i].vendorId &&
  914. product == quirk_printers[i].productId)
  915. return quirk_printers[i].quirks;
  916. }
  917. return 0;
  918. }
  919. static const struct file_operations usblp_fops = {
  920. .owner = THIS_MODULE,
  921. .read = usblp_read,
  922. .write = usblp_write,
  923. .poll = usblp_poll,
  924. .unlocked_ioctl = usblp_ioctl,
  925. .compat_ioctl = usblp_ioctl,
  926. .open = usblp_open,
  927. .release = usblp_release,
  928. .llseek = noop_llseek,
  929. };
  930. static char *usblp_devnode(struct device *dev, umode_t *mode)
  931. {
  932. return kasprintf(GFP_KERNEL, "usb/%s", dev_name(dev));
  933. }
  934. static struct usb_class_driver usblp_class = {
  935. .name = "lp%d",
  936. .devnode = usblp_devnode,
  937. .fops = &usblp_fops,
  938. .minor_base = USBLP_MINOR_BASE,
  939. };
  940. static ssize_t ieee1284_id_show(struct device *dev, struct device_attribute *attr, char *buf)
  941. {
  942. struct usb_interface *intf = to_usb_interface(dev);
  943. struct usblp *usblp = usb_get_intfdata(intf);
  944. if (usblp->device_id_string[0] == 0 &&
  945. usblp->device_id_string[1] == 0)
  946. return 0;
  947. return sprintf(buf, "%s", usblp->device_id_string+2);
  948. }
  949. static DEVICE_ATTR_RO(ieee1284_id);
  950. static int usblp_probe(struct usb_interface *intf,
  951. const struct usb_device_id *id)
  952. {
  953. struct usb_device *dev = interface_to_usbdev(intf);
  954. struct usblp *usblp;
  955. int protocol;
  956. int retval;
  957. /* Malloc and start initializing usblp structure so we can use it
  958. * directly. */
  959. usblp = kzalloc(sizeof(struct usblp), GFP_KERNEL);
  960. if (!usblp) {
  961. retval = -ENOMEM;
  962. goto abort_ret;
  963. }
  964. usblp->dev = dev;
  965. mutex_init(&usblp->wmut);
  966. mutex_init(&usblp->mut);
  967. spin_lock_init(&usblp->lock);
  968. init_waitqueue_head(&usblp->rwait);
  969. init_waitqueue_head(&usblp->wwait);
  970. init_usb_anchor(&usblp->urbs);
  971. usblp->ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
  972. usblp->intf = usb_get_intf(intf);
  973. /* Malloc device ID string buffer to the largest expected length,
  974. * since we can re-query it on an ioctl and a dynamic string
  975. * could change in length. */
  976. if (!(usblp->device_id_string = kmalloc(USBLP_DEVICE_ID_SIZE, GFP_KERNEL))) {
  977. retval = -ENOMEM;
  978. goto abort;
  979. }
  980. /*
  981. * Allocate read buffer. We somewhat wastefully
  982. * malloc both regardless of bidirectionality, because the
  983. * alternate setting can be changed later via an ioctl.
  984. */
  985. if (!(usblp->readbuf = kmalloc(USBLP_BUF_SIZE_IN, GFP_KERNEL))) {
  986. retval = -ENOMEM;
  987. goto abort;
  988. }
  989. /* Allocate buffer for printer status */
  990. usblp->statusbuf = kmalloc(STATUS_BUF_SIZE, GFP_KERNEL);
  991. if (!usblp->statusbuf) {
  992. retval = -ENOMEM;
  993. goto abort;
  994. }
  995. /* Lookup quirks for this printer. */
  996. usblp->quirks = usblp_quirks(
  997. le16_to_cpu(dev->descriptor.idVendor),
  998. le16_to_cpu(dev->descriptor.idProduct));
  999. /* Analyze and pick initial alternate settings and endpoints. */
  1000. protocol = usblp_select_alts(usblp);
  1001. if (protocol < 0) {
  1002. dev_dbg(&intf->dev,
  1003. "incompatible printer-class device 0x%4.4X/0x%4.4X\n",
  1004. le16_to_cpu(dev->descriptor.idVendor),
  1005. le16_to_cpu(dev->descriptor.idProduct));
  1006. retval = -ENODEV;
  1007. goto abort;
  1008. }
  1009. /* Setup the selected alternate setting and endpoints. */
  1010. if (usblp_set_protocol(usblp, protocol) < 0) {
  1011. retval = -ENODEV; /* ->probe isn't ->ioctl */
  1012. goto abort;
  1013. }
  1014. /* Retrieve and store the device ID string. */
  1015. usblp_cache_device_id_string(usblp);
  1016. retval = device_create_file(&intf->dev, &dev_attr_ieee1284_id);
  1017. if (retval)
  1018. goto abort_intfdata;
  1019. #ifdef DEBUG
  1020. usblp_check_status(usblp, 0);
  1021. #endif
  1022. usb_set_intfdata(intf, usblp);
  1023. usblp->present = 1;
  1024. retval = usb_register_dev(intf, &usblp_class);
  1025. if (retval) {
  1026. dev_err(&intf->dev,
  1027. "usblp: Not able to get a minor (base %u, slice default): %d\n",
  1028. USBLP_MINOR_BASE, retval);
  1029. goto abort_intfdata;
  1030. }
  1031. usblp->minor = intf->minor;
  1032. dev_info(&intf->dev,
  1033. "usblp%d: USB %sdirectional printer dev %d if %d alt %d proto %d vid 0x%4.4X pid 0x%4.4X\n",
  1034. usblp->minor, usblp->bidir ? "Bi" : "Uni", dev->devnum,
  1035. usblp->ifnum,
  1036. usblp->protocol[usblp->current_protocol].alt_setting,
  1037. usblp->current_protocol,
  1038. le16_to_cpu(usblp->dev->descriptor.idVendor),
  1039. le16_to_cpu(usblp->dev->descriptor.idProduct));
  1040. return 0;
  1041. abort_intfdata:
  1042. usb_set_intfdata(intf, NULL);
  1043. device_remove_file(&intf->dev, &dev_attr_ieee1284_id);
  1044. abort:
  1045. kfree(usblp->readbuf);
  1046. kfree(usblp->statusbuf);
  1047. kfree(usblp->device_id_string);
  1048. usb_put_intf(usblp->intf);
  1049. kfree(usblp);
  1050. abort_ret:
  1051. return retval;
  1052. }
  1053. /*
  1054. * We are a "new" style driver with usb_device_id table,
  1055. * but our requirements are too intricate for simple match to handle.
  1056. *
  1057. * The "proto_bias" option may be used to specify the preferred protocol
  1058. * for all USB printers (1=USB_CLASS_PRINTER/1/1, 2=USB_CLASS_PRINTER/1/2,
  1059. * 3=USB_CLASS_PRINTER/1/3). If the device supports the preferred protocol,
  1060. * then we bind to it.
  1061. *
  1062. * The best interface for us is USB_CLASS_PRINTER/1/2, because it
  1063. * is compatible with a stream of characters. If we find it, we bind to it.
  1064. *
  1065. * Note that the people from hpoj.sourceforge.net need to be able to
  1066. * bind to USB_CLASS_PRINTER/1/3 (MLC/1284.4), so we provide them ioctls
  1067. * for this purpose.
  1068. *
  1069. * Failing USB_CLASS_PRINTER/1/2, we look for USB_CLASS_PRINTER/1/3,
  1070. * even though it's probably not stream-compatible, because this matches
  1071. * the behaviour of the old code.
  1072. *
  1073. * If nothing else, we bind to USB_CLASS_PRINTER/1/1
  1074. * - the unidirectional interface.
  1075. */
  1076. static int usblp_select_alts(struct usblp *usblp)
  1077. {
  1078. struct usb_interface *if_alt;
  1079. struct usb_host_interface *ifd;
  1080. struct usb_endpoint_descriptor *epwrite, *epread;
  1081. int p, i;
  1082. int res;
  1083. if_alt = usblp->intf;
  1084. for (p = 0; p < USBLP_MAX_PROTOCOLS; p++)
  1085. usblp->protocol[p].alt_setting = -1;
  1086. /* Find out what we have. */
  1087. for (i = 0; i < if_alt->num_altsetting; i++) {
  1088. ifd = &if_alt->altsetting[i];
  1089. if (ifd->desc.bInterfaceClass != USB_CLASS_PRINTER ||
  1090. ifd->desc.bInterfaceSubClass != 1)
  1091. if (!(usblp->quirks & USBLP_QUIRK_BAD_CLASS))
  1092. continue;
  1093. if (ifd->desc.bInterfaceProtocol < USBLP_FIRST_PROTOCOL ||
  1094. ifd->desc.bInterfaceProtocol > USBLP_LAST_PROTOCOL)
  1095. continue;
  1096. /* Look for the expected bulk endpoints. */
  1097. if (ifd->desc.bInterfaceProtocol > 1) {
  1098. res = usb_find_common_endpoints(ifd,
  1099. &epread, &epwrite, NULL, NULL);
  1100. } else {
  1101. epread = NULL;
  1102. res = usb_find_bulk_out_endpoint(ifd, &epwrite);
  1103. }
  1104. /* Ignore buggy hardware without the right endpoints. */
  1105. if (res)
  1106. continue;
  1107. /* Turn off reads for buggy bidirectional printers. */
  1108. if (usblp->quirks & USBLP_QUIRK_BIDIR) {
  1109. printk(KERN_INFO "usblp%d: Disabling reads from "
  1110. "problematic bidirectional printer\n",
  1111. usblp->minor);
  1112. epread = NULL;
  1113. }
  1114. usblp->protocol[ifd->desc.bInterfaceProtocol].alt_setting =
  1115. ifd->desc.bAlternateSetting;
  1116. usblp->protocol[ifd->desc.bInterfaceProtocol].epwrite = epwrite;
  1117. usblp->protocol[ifd->desc.bInterfaceProtocol].epread = epread;
  1118. }
  1119. /* If our requested protocol is supported, then use it. */
  1120. if (proto_bias >= USBLP_FIRST_PROTOCOL &&
  1121. proto_bias <= USBLP_LAST_PROTOCOL &&
  1122. usblp->protocol[proto_bias].alt_setting != -1)
  1123. return proto_bias;
  1124. /* Ordering is important here. */
  1125. if (usblp->protocol[2].alt_setting != -1)
  1126. return 2;
  1127. if (usblp->protocol[1].alt_setting != -1)
  1128. return 1;
  1129. if (usblp->protocol[3].alt_setting != -1)
  1130. return 3;
  1131. /* If nothing is available, then don't bind to this device. */
  1132. return -1;
  1133. }
  1134. static int usblp_set_protocol(struct usblp *usblp, int protocol)
  1135. {
  1136. int r, alts;
  1137. if (protocol < USBLP_FIRST_PROTOCOL || protocol > USBLP_LAST_PROTOCOL)
  1138. return -EINVAL;
  1139. alts = usblp->protocol[protocol].alt_setting;
  1140. if (alts < 0)
  1141. return -EINVAL;
  1142. r = usb_set_interface(usblp->dev, usblp->ifnum, alts);
  1143. if (r < 0) {
  1144. printk(KERN_ERR "usblp: can't set desired altsetting %d on interface %d\n",
  1145. alts, usblp->ifnum);
  1146. return r;
  1147. }
  1148. usblp->bidir = (usblp->protocol[protocol].epread != NULL);
  1149. usblp->current_protocol = protocol;
  1150. dev_dbg(&usblp->intf->dev, "usblp%d set protocol %d\n",
  1151. usblp->minor, protocol);
  1152. return 0;
  1153. }
  1154. /* Retrieves and caches device ID string.
  1155. * Returns length, including length bytes but not null terminator.
  1156. * On error, returns a negative errno value. */
  1157. static int usblp_cache_device_id_string(struct usblp *usblp)
  1158. {
  1159. int err, length;
  1160. err = usblp_get_id(usblp, 0, usblp->device_id_string, USBLP_DEVICE_ID_SIZE - 1);
  1161. if (err < 0) {
  1162. dev_dbg(&usblp->intf->dev,
  1163. "usblp%d: error = %d reading IEEE-1284 Device ID string\n",
  1164. usblp->minor, err);
  1165. usblp->device_id_string[0] = usblp->device_id_string[1] = '\0';
  1166. return -EIO;
  1167. }
  1168. /* First two bytes are length in big-endian.
  1169. * They count themselves, and we copy them into
  1170. * the user's buffer. */
  1171. length = be16_to_cpu(*((__be16 *)usblp->device_id_string));
  1172. if (length < 2)
  1173. length = 2;
  1174. else if (length >= USBLP_DEVICE_ID_SIZE)
  1175. length = USBLP_DEVICE_ID_SIZE - 1;
  1176. usblp->device_id_string[length] = '\0';
  1177. dev_dbg(&usblp->intf->dev, "usblp%d Device ID string [len=%d]=\"%s\"\n",
  1178. usblp->minor, length, &usblp->device_id_string[2]);
  1179. return length;
  1180. }
  1181. static void usblp_disconnect(struct usb_interface *intf)
  1182. {
  1183. struct usblp *usblp = usb_get_intfdata(intf);
  1184. usb_deregister_dev(intf, &usblp_class);
  1185. if (!usblp || !usblp->dev) {
  1186. dev_err(&intf->dev, "bogus disconnect\n");
  1187. BUG();
  1188. }
  1189. device_remove_file(&intf->dev, &dev_attr_ieee1284_id);
  1190. mutex_lock(&usblp_mutex);
  1191. mutex_lock(&usblp->mut);
  1192. usblp->present = 0;
  1193. wake_up(&usblp->wwait);
  1194. wake_up(&usblp->rwait);
  1195. usb_set_intfdata(intf, NULL);
  1196. usblp_unlink_urbs(usblp);
  1197. mutex_unlock(&usblp->mut);
  1198. if (!usblp->used)
  1199. usblp_cleanup(usblp);
  1200. mutex_unlock(&usblp_mutex);
  1201. }
  1202. static int usblp_suspend(struct usb_interface *intf, pm_message_t message)
  1203. {
  1204. struct usblp *usblp = usb_get_intfdata(intf);
  1205. usblp_unlink_urbs(usblp);
  1206. #if 0 /* XXX Do we want this? What if someone is reading, should we fail? */
  1207. /* not strictly necessary, but just in case */
  1208. wake_up(&usblp->wwait);
  1209. wake_up(&usblp->rwait);
  1210. #endif
  1211. return 0;
  1212. }
  1213. static int usblp_resume(struct usb_interface *intf)
  1214. {
  1215. struct usblp *usblp = usb_get_intfdata(intf);
  1216. int r;
  1217. r = handle_bidir(usblp);
  1218. return r;
  1219. }
  1220. static const struct usb_device_id usblp_ids[] = {
  1221. { USB_DEVICE_INFO(USB_CLASS_PRINTER, 1, 1) },
  1222. { USB_DEVICE_INFO(USB_CLASS_PRINTER, 1, 2) },
  1223. { USB_DEVICE_INFO(USB_CLASS_PRINTER, 1, 3) },
  1224. { USB_INTERFACE_INFO(USB_CLASS_PRINTER, 1, 1) },
  1225. { USB_INTERFACE_INFO(USB_CLASS_PRINTER, 1, 2) },
  1226. { USB_INTERFACE_INFO(USB_CLASS_PRINTER, 1, 3) },
  1227. { USB_DEVICE(0x04b8, 0x0202) }, /* Seiko Epson Receipt Printer M129C */
  1228. { } /* Terminating entry */
  1229. };
  1230. MODULE_DEVICE_TABLE(usb, usblp_ids);
  1231. static struct usb_driver usblp_driver = {
  1232. .name = "usblp",
  1233. .probe = usblp_probe,
  1234. .disconnect = usblp_disconnect,
  1235. .suspend = usblp_suspend,
  1236. .resume = usblp_resume,
  1237. .id_table = usblp_ids,
  1238. .supports_autosuspend = 1,
  1239. };
  1240. module_usb_driver(usblp_driver);
  1241. MODULE_AUTHOR(DRIVER_AUTHOR);
  1242. MODULE_DESCRIPTION(DRIVER_DESC);
  1243. module_param(proto_bias, int, S_IRUGO | S_IWUSR);
  1244. MODULE_PARM_DESC(proto_bias, "Favourite protocol number");
  1245. MODULE_LICENSE("GPL");