usblp.c 39 KB

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