microtek.c 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810
  1. // SPDX-License-Identifier: GPL-2.0
  2. /* Driver for Microtek Scanmaker X6 USB scanner, and possibly others.
  3. *
  4. * (C) Copyright 2000 John Fremlin <[email protected]>
  5. * (C) Copyright 2000 Oliver Neukum <[email protected]>
  6. *
  7. * Parts shamelessly stolen from usb-storage and copyright by their
  8. * authors. Thanks to Matt Dharm for giving us permission!
  9. *
  10. * This driver implements a SCSI host controller driver and a USB
  11. * device driver. To avoid confusion, all the USB related stuff is
  12. * prefixed by mts_usb_ and all the SCSI stuff by mts_scsi_.
  13. *
  14. * Microtek (www.microtek.com) did not release the specifications for
  15. * their USB protocol to us, so we had to reverse engineer them. We
  16. * don't know for which models they are valid.
  17. *
  18. * The X6 USB has three bulk endpoints, one output (0x1) down which
  19. * commands and outgoing data are sent, and two input: 0x82 from which
  20. * normal data is read from the scanner (in packets of maximum 32
  21. * bytes) and from which the status byte is read, and 0x83 from which
  22. * the results of a scan (or preview) are read in up to 64 * 1024 byte
  23. * chunks by the Windows driver. We don't know how much it is possible
  24. * to read at a time from 0x83.
  25. *
  26. * It seems possible to read (with URB transfers) everything from 0x82
  27. * in one go, without bothering to read in 32 byte chunks.
  28. *
  29. * There seems to be an optimisation of a further READ implicit if
  30. * you simply read from 0x83.
  31. *
  32. * Guessed protocol:
  33. *
  34. * Send raw SCSI command to EP 0x1
  35. *
  36. * If there is data to receive:
  37. * If the command was READ datatype=image:
  38. * Read a lot of data from EP 0x83
  39. * Else:
  40. * Read data from EP 0x82
  41. * Else:
  42. * If there is data to transmit:
  43. * Write it to EP 0x1
  44. *
  45. * Read status byte from EP 0x82
  46. *
  47. * References:
  48. *
  49. * The SCSI command set for the scanner is available from
  50. * ftp://ftp.microtek.com/microtek/devpack/
  51. *
  52. * Microtek NV sent us a more up to date version of the document. If
  53. * you want it, just send mail.
  54. *
  55. * Status:
  56. *
  57. * Untested with multiple scanners.
  58. * Untested on SMP.
  59. * Untested on a bigendian machine.
  60. *
  61. * History:
  62. *
  63. * 20000417 starting history
  64. * 20000417 fixed load oops
  65. * 20000417 fixed unload oops
  66. * 20000419 fixed READ IMAGE detection
  67. * 20000424 started conversion to use URBs
  68. * 20000502 handled short transfers as errors
  69. * 20000513 rename and organisation of functions (john)
  70. * 20000513 added IDs for all products supported by Windows driver (john)
  71. * 20000514 Rewrote mts_scsi_queuecommand to use URBs (john)
  72. * 20000514 Version 0.0.8j
  73. * 20000514 Fix reporting of non-existent devices to SCSI layer (john)
  74. * 20000514 Added MTS_DEBUG_INT (john)
  75. * 20000514 Changed "usb-microtek" to "microtek" for consistency (john)
  76. * 20000514 Stupid bug fixes (john)
  77. * 20000514 Version 0.0.9j
  78. * 20000515 Put transfer context and URB in mts_desc (john)
  79. * 20000515 Added prelim turn off debugging support (john)
  80. * 20000515 Version 0.0.10j
  81. * 20000515 Fixed up URB allocation (clear URB on alloc) (john)
  82. * 20000515 Version 0.0.11j
  83. * 20000516 Removed unnecessary spinlock in mts_transfer_context (john)
  84. * 20000516 Removed unnecessary up on instance lock in mts_remove_nolock (john)
  85. * 20000516 Implemented (badly) scsi_abort (john)
  86. * 20000516 Version 0.0.12j
  87. * 20000517 Hopefully removed mts_remove_nolock quasideadlock (john)
  88. * 20000517 Added mts_debug_dump to print ll USB info (john)
  89. * 20000518 Tweaks and documentation updates (john)
  90. * 20000518 Version 0.0.13j
  91. * 20000518 Cleaned up abort handling (john)
  92. * 20000523 Removed scsi_command and various scsi_..._resets (john)
  93. * 20000523 Added unlink URB on scsi_abort, now OHCI supports it (john)
  94. * 20000523 Fixed last tiresome compile warning (john)
  95. * 20000523 Version 0.0.14j (though version 0.1 has come out?)
  96. * 20000602 Added primitive reset
  97. * 20000602 Version 0.2.0
  98. * 20000603 various cosmetic changes
  99. * 20000603 Version 0.2.1
  100. * 20000620 minor cosmetic changes
  101. * 20000620 Version 0.2.2
  102. * 20000822 Hopefully fixed deadlock in mts_remove_nolock()
  103. * 20000822 Fixed minor race in mts_transfer_cleanup()
  104. * 20000822 Fixed deadlock on submission error in queuecommand
  105. * 20000822 Version 0.2.3
  106. * 20000913 Reduced module size if debugging is off
  107. * 20000913 Version 0.2.4
  108. * 20010210 New abort logic
  109. * 20010210 Version 0.3.0
  110. * 20010217 Merged scatter/gather
  111. * 20010218 Version 0.4.0
  112. * 20010218 Cosmetic fixes
  113. * 20010218 Version 0.4.1
  114. * 20010306 Abort while using scatter/gather
  115. * 20010306 Version 0.4.2
  116. * 20010311 Remove all timeouts and tidy up generally (john)
  117. * 20010320 check return value of scsi_register()
  118. * 20010320 Version 0.4.3
  119. * 20010408 Identify version on module load.
  120. * 20011003 Fix multiple requests
  121. */
  122. #include <linux/module.h>
  123. #include <linux/kernel.h>
  124. #include <linux/signal.h>
  125. #include <linux/errno.h>
  126. #include <linux/random.h>
  127. #include <linux/poll.h>
  128. #include <linux/slab.h>
  129. #include <linux/spinlock.h>
  130. #include <linux/usb.h>
  131. #include <linux/proc_fs.h>
  132. #include <linux/atomic.h>
  133. #include <linux/blkdev.h>
  134. #include <scsi/scsi.h>
  135. #include <scsi/scsi_cmnd.h>
  136. #include <scsi/scsi_device.h>
  137. #include <scsi/scsi_eh.h>
  138. #include <scsi/scsi_host.h>
  139. #include <scsi/scsi_tcq.h>
  140. #include "microtek.h"
  141. #define DRIVER_AUTHOR "John Fremlin <[email protected]>, Oliver Neukum <[email protected]>"
  142. #define DRIVER_DESC "Microtek Scanmaker X6 USB scanner driver"
  143. /* Should we do debugging? */
  144. //#define MTS_DO_DEBUG
  145. /* USB layer driver interface */
  146. static int mts_usb_probe(struct usb_interface *intf,
  147. const struct usb_device_id *id);
  148. static void mts_usb_disconnect(struct usb_interface *intf);
  149. static const struct usb_device_id mts_usb_ids[];
  150. static struct usb_driver mts_usb_driver = {
  151. .name = "microtekX6",
  152. .probe = mts_usb_probe,
  153. .disconnect = mts_usb_disconnect,
  154. .id_table = mts_usb_ids,
  155. };
  156. /* Internal driver stuff */
  157. #define MTS_VERSION "0.4.3"
  158. #define MTS_NAME "microtek usb (rev " MTS_VERSION "): "
  159. #define MTS_WARNING(x...) \
  160. printk( KERN_WARNING MTS_NAME x )
  161. #define MTS_ERROR(x...) \
  162. printk( KERN_ERR MTS_NAME x )
  163. #define MTS_INT_ERROR(x...) \
  164. MTS_ERROR(x)
  165. #define MTS_MESSAGE(x...) \
  166. printk( KERN_INFO MTS_NAME x )
  167. #if defined MTS_DO_DEBUG
  168. #define MTS_DEBUG(x...) \
  169. printk( KERN_DEBUG MTS_NAME x )
  170. #define MTS_DEBUG_GOT_HERE() \
  171. MTS_DEBUG("got to %s:%d (%s)\n", __FILE__, (int)__LINE__, __func__ )
  172. #define MTS_DEBUG_INT() \
  173. do { MTS_DEBUG_GOT_HERE(); \
  174. MTS_DEBUG("transfer = 0x%x context = 0x%x\n",(int)transfer,(int)context ); \
  175. MTS_DEBUG("status = 0x%x data-length = 0x%x sent = 0x%x\n",transfer->status,(int)context->data_length, (int)transfer->actual_length ); \
  176. mts_debug_dump(context->instance);\
  177. } while(0)
  178. #else
  179. #define MTS_NUL_STATEMENT do { } while(0)
  180. #define MTS_DEBUG(x...) MTS_NUL_STATEMENT
  181. #define MTS_DEBUG_GOT_HERE() MTS_NUL_STATEMENT
  182. #define MTS_DEBUG_INT() MTS_NUL_STATEMENT
  183. #endif
  184. #define MTS_INT_INIT()\
  185. struct mts_transfer_context* context = (struct mts_transfer_context*)transfer->context; \
  186. MTS_DEBUG_INT();\
  187. #ifdef MTS_DO_DEBUG
  188. static inline void mts_debug_dump(struct mts_desc* desc) {
  189. MTS_DEBUG("desc at 0x%x: toggle = %02x%02x\n",
  190. (int)desc,
  191. (int)desc->usb_dev->toggle[1],(int)desc->usb_dev->toggle[0]
  192. );
  193. MTS_DEBUG("ep_out=%x ep_response=%x ep_image=%x\n",
  194. usb_sndbulkpipe(desc->usb_dev,desc->ep_out),
  195. usb_rcvbulkpipe(desc->usb_dev,desc->ep_response),
  196. usb_rcvbulkpipe(desc->usb_dev,desc->ep_image)
  197. );
  198. }
  199. static inline void mts_show_command(struct scsi_cmnd *srb)
  200. {
  201. char *what = NULL;
  202. switch (srb->cmnd[0]) {
  203. case TEST_UNIT_READY: what = "TEST_UNIT_READY"; break;
  204. case REZERO_UNIT: what = "REZERO_UNIT"; break;
  205. case REQUEST_SENSE: what = "REQUEST_SENSE"; break;
  206. case FORMAT_UNIT: what = "FORMAT_UNIT"; break;
  207. case READ_BLOCK_LIMITS: what = "READ_BLOCK_LIMITS"; break;
  208. case REASSIGN_BLOCKS: what = "REASSIGN_BLOCKS"; break;
  209. case READ_6: what = "READ_6"; break;
  210. case WRITE_6: what = "WRITE_6"; break;
  211. case SEEK_6: what = "SEEK_6"; break;
  212. case READ_REVERSE: what = "READ_REVERSE"; break;
  213. case WRITE_FILEMARKS: what = "WRITE_FILEMARKS"; break;
  214. case SPACE: what = "SPACE"; break;
  215. case INQUIRY: what = "INQUIRY"; break;
  216. case RECOVER_BUFFERED_DATA: what = "RECOVER_BUFFERED_DATA"; break;
  217. case MODE_SELECT: what = "MODE_SELECT"; break;
  218. case RESERVE: what = "RESERVE"; break;
  219. case RELEASE: what = "RELEASE"; break;
  220. case COPY: what = "COPY"; break;
  221. case ERASE: what = "ERASE"; break;
  222. case MODE_SENSE: what = "MODE_SENSE"; break;
  223. case START_STOP: what = "START_STOP"; break;
  224. case RECEIVE_DIAGNOSTIC: what = "RECEIVE_DIAGNOSTIC"; break;
  225. case SEND_DIAGNOSTIC: what = "SEND_DIAGNOSTIC"; break;
  226. case ALLOW_MEDIUM_REMOVAL: what = "ALLOW_MEDIUM_REMOVAL"; break;
  227. case SET_WINDOW: what = "SET_WINDOW"; break;
  228. case READ_CAPACITY: what = "READ_CAPACITY"; break;
  229. case READ_10: what = "READ_10"; break;
  230. case WRITE_10: what = "WRITE_10"; break;
  231. case SEEK_10: what = "SEEK_10"; break;
  232. case WRITE_VERIFY: what = "WRITE_VERIFY"; break;
  233. case VERIFY: what = "VERIFY"; break;
  234. case SEARCH_HIGH: what = "SEARCH_HIGH"; break;
  235. case SEARCH_EQUAL: what = "SEARCH_EQUAL"; break;
  236. case SEARCH_LOW: what = "SEARCH_LOW"; break;
  237. case SET_LIMITS: what = "SET_LIMITS"; break;
  238. case READ_POSITION: what = "READ_POSITION"; break;
  239. case SYNCHRONIZE_CACHE: what = "SYNCHRONIZE_CACHE"; break;
  240. case LOCK_UNLOCK_CACHE: what = "LOCK_UNLOCK_CACHE"; break;
  241. case READ_DEFECT_DATA: what = "READ_DEFECT_DATA"; break;
  242. case MEDIUM_SCAN: what = "MEDIUM_SCAN"; break;
  243. case COMPARE: what = "COMPARE"; break;
  244. case COPY_VERIFY: what = "COPY_VERIFY"; break;
  245. case WRITE_BUFFER: what = "WRITE_BUFFER"; break;
  246. case READ_BUFFER: what = "READ_BUFFER"; break;
  247. case UPDATE_BLOCK: what = "UPDATE_BLOCK"; break;
  248. case READ_LONG: what = "READ_LONG"; break;
  249. case WRITE_LONG: what = "WRITE_LONG"; break;
  250. case CHANGE_DEFINITION: what = "CHANGE_DEFINITION"; break;
  251. case WRITE_SAME: what = "WRITE_SAME"; break;
  252. case READ_TOC: what = "READ_TOC"; break;
  253. case LOG_SELECT: what = "LOG_SELECT"; break;
  254. case LOG_SENSE: what = "LOG_SENSE"; break;
  255. case MODE_SELECT_10: what = "MODE_SELECT_10"; break;
  256. case MODE_SENSE_10: what = "MODE_SENSE_10"; break;
  257. case MOVE_MEDIUM: what = "MOVE_MEDIUM"; break;
  258. case READ_12: what = "READ_12"; break;
  259. case WRITE_12: what = "WRITE_12"; break;
  260. case WRITE_VERIFY_12: what = "WRITE_VERIFY_12"; break;
  261. case SEARCH_HIGH_12: what = "SEARCH_HIGH_12"; break;
  262. case SEARCH_EQUAL_12: what = "SEARCH_EQUAL_12"; break;
  263. case SEARCH_LOW_12: what = "SEARCH_LOW_12"; break;
  264. case READ_ELEMENT_STATUS: what = "READ_ELEMENT_STATUS"; break;
  265. case SEND_VOLUME_TAG: what = "SEND_VOLUME_TAG"; break;
  266. case WRITE_LONG_2: what = "WRITE_LONG_2"; break;
  267. default:
  268. MTS_DEBUG("can't decode command\n");
  269. goto out;
  270. break;
  271. }
  272. MTS_DEBUG( "Command %s (%d bytes)\n", what, srb->cmd_len);
  273. out:
  274. MTS_DEBUG( " %10ph\n", srb->cmnd);
  275. }
  276. #else
  277. static inline void mts_show_command(struct scsi_cmnd * dummy)
  278. {
  279. }
  280. static inline void mts_debug_dump(struct mts_desc* dummy)
  281. {
  282. }
  283. #endif
  284. static inline void mts_urb_abort(struct mts_desc* desc) {
  285. MTS_DEBUG_GOT_HERE();
  286. mts_debug_dump(desc);
  287. usb_kill_urb( desc->urb );
  288. }
  289. static int mts_slave_alloc (struct scsi_device *s)
  290. {
  291. s->inquiry_len = 0x24;
  292. return 0;
  293. }
  294. static int mts_slave_configure (struct scsi_device *s)
  295. {
  296. blk_queue_dma_alignment(s->request_queue, (512 - 1));
  297. return 0;
  298. }
  299. static int mts_scsi_abort(struct scsi_cmnd *srb)
  300. {
  301. struct mts_desc* desc = (struct mts_desc*)(srb->device->host->hostdata[0]);
  302. MTS_DEBUG_GOT_HERE();
  303. mts_urb_abort(desc);
  304. return FAILED;
  305. }
  306. static int mts_scsi_host_reset(struct scsi_cmnd *srb)
  307. {
  308. struct mts_desc* desc = (struct mts_desc*)(srb->device->host->hostdata[0]);
  309. int result;
  310. MTS_DEBUG_GOT_HERE();
  311. mts_debug_dump(desc);
  312. result = usb_lock_device_for_reset(desc->usb_dev, desc->usb_intf);
  313. if (result == 0) {
  314. result = usb_reset_device(desc->usb_dev);
  315. usb_unlock_device(desc->usb_dev);
  316. }
  317. return result ? FAILED : SUCCESS;
  318. }
  319. static int
  320. mts_scsi_queuecommand(struct Scsi_Host *shost, struct scsi_cmnd *srb);
  321. static void mts_transfer_cleanup( struct urb *transfer );
  322. static void mts_do_sg(struct urb * transfer);
  323. static inline
  324. void mts_int_submit_urb (struct urb* transfer,
  325. int pipe,
  326. void* data,
  327. unsigned length,
  328. usb_complete_t callback )
  329. /* Interrupt context! */
  330. /* Holding transfer->context->lock! */
  331. {
  332. int res;
  333. MTS_INT_INIT();
  334. usb_fill_bulk_urb(transfer,
  335. context->instance->usb_dev,
  336. pipe,
  337. data,
  338. length,
  339. callback,
  340. context
  341. );
  342. res = usb_submit_urb( transfer, GFP_ATOMIC );
  343. if ( unlikely(res) ) {
  344. MTS_INT_ERROR( "could not submit URB! Error was %d\n",(int)res );
  345. set_host_byte(context->srb, DID_ERROR);
  346. mts_transfer_cleanup(transfer);
  347. }
  348. }
  349. static void mts_transfer_cleanup( struct urb *transfer )
  350. /* Interrupt context! */
  351. {
  352. MTS_INT_INIT();
  353. if ( likely(context->final_callback != NULL) )
  354. context->final_callback(context->srb);
  355. }
  356. static void mts_transfer_done( struct urb *transfer )
  357. {
  358. MTS_INT_INIT();
  359. context->srb->result &= MTS_SCSI_ERR_MASK;
  360. context->srb->result |= (unsigned)(*context->scsi_status)<<1;
  361. mts_transfer_cleanup(transfer);
  362. }
  363. static void mts_get_status( struct urb *transfer )
  364. /* Interrupt context! */
  365. {
  366. MTS_INT_INIT();
  367. mts_int_submit_urb(transfer,
  368. usb_rcvbulkpipe(context->instance->usb_dev,
  369. context->instance->ep_response),
  370. context->scsi_status,
  371. 1,
  372. mts_transfer_done );
  373. }
  374. static void mts_data_done( struct urb* transfer )
  375. /* Interrupt context! */
  376. {
  377. int status = transfer->status;
  378. MTS_INT_INIT();
  379. if ( context->data_length != transfer->actual_length ) {
  380. scsi_set_resid(context->srb, context->data_length -
  381. transfer->actual_length);
  382. } else if ( unlikely(status) ) {
  383. set_host_byte(context->srb, (status == -ENOENT ? DID_ABORT : DID_ERROR));
  384. }
  385. mts_get_status(transfer);
  386. }
  387. static void mts_command_done( struct urb *transfer )
  388. /* Interrupt context! */
  389. {
  390. int status = transfer->status;
  391. MTS_INT_INIT();
  392. if ( unlikely(status) ) {
  393. if (status == -ENOENT) {
  394. /* We are being killed */
  395. MTS_DEBUG_GOT_HERE();
  396. set_host_byte(context->srb, DID_ABORT);
  397. } else {
  398. /* A genuine error has occurred */
  399. MTS_DEBUG_GOT_HERE();
  400. set_host_byte(context->srb, DID_ERROR);
  401. }
  402. mts_transfer_cleanup(transfer);
  403. return;
  404. }
  405. if (context->srb->cmnd[0] == REQUEST_SENSE) {
  406. mts_int_submit_urb(transfer,
  407. context->data_pipe,
  408. context->srb->sense_buffer,
  409. context->data_length,
  410. mts_data_done);
  411. } else { if ( context->data ) {
  412. mts_int_submit_urb(transfer,
  413. context->data_pipe,
  414. context->data,
  415. context->data_length,
  416. scsi_sg_count(context->srb) > 1 ?
  417. mts_do_sg : mts_data_done);
  418. } else {
  419. mts_get_status(transfer);
  420. }
  421. }
  422. }
  423. static void mts_do_sg (struct urb* transfer)
  424. {
  425. int status = transfer->status;
  426. MTS_INT_INIT();
  427. MTS_DEBUG("Processing fragment %d of %d\n", context->fragment,
  428. scsi_sg_count(context->srb));
  429. if (unlikely(status)) {
  430. set_host_byte(context->srb, (status == -ENOENT ? DID_ABORT : DID_ERROR));
  431. mts_transfer_cleanup(transfer);
  432. }
  433. context->curr_sg = sg_next(context->curr_sg);
  434. mts_int_submit_urb(transfer,
  435. context->data_pipe,
  436. sg_virt(context->curr_sg),
  437. context->curr_sg->length,
  438. sg_is_last(context->curr_sg) ?
  439. mts_data_done : mts_do_sg);
  440. }
  441. static const u8 mts_read_image_sig[] = { 0x28, 00, 00, 00 };
  442. static const u8 mts_read_image_sig_len = 4;
  443. static const unsigned char mts_direction[256/8] = {
  444. 0x28, 0x81, 0x14, 0x14, 0x20, 0x01, 0x90, 0x77,
  445. 0x0C, 0x20, 0x00, 0x04, 0x00, 0x00, 0x00, 0x00,
  446. 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x01,
  447. 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
  448. };
  449. #define MTS_DIRECTION_IS_IN(x) ((mts_direction[x>>3] >> (x & 7)) & 1)
  450. static void
  451. mts_build_transfer_context(struct scsi_cmnd *srb, struct mts_desc* desc)
  452. {
  453. int pipe;
  454. MTS_DEBUG_GOT_HERE();
  455. desc->context.instance = desc;
  456. desc->context.srb = srb;
  457. if (!scsi_bufflen(srb)) {
  458. desc->context.data = NULL;
  459. desc->context.data_length = 0;
  460. return;
  461. } else {
  462. desc->context.curr_sg = scsi_sglist(srb);
  463. desc->context.data = sg_virt(desc->context.curr_sg);
  464. desc->context.data_length = desc->context.curr_sg->length;
  465. }
  466. /* can't rely on srb->sc_data_direction */
  467. /* Brutally ripped from usb-storage */
  468. if ( !memcmp( srb->cmnd, mts_read_image_sig, mts_read_image_sig_len )
  469. ) { pipe = usb_rcvbulkpipe(desc->usb_dev,desc->ep_image);
  470. MTS_DEBUG( "transferring from desc->ep_image == %d\n",
  471. (int)desc->ep_image );
  472. } else if ( MTS_DIRECTION_IS_IN(srb->cmnd[0]) ) {
  473. pipe = usb_rcvbulkpipe(desc->usb_dev,desc->ep_response);
  474. MTS_DEBUG( "transferring from desc->ep_response == %d\n",
  475. (int)desc->ep_response);
  476. } else {
  477. MTS_DEBUG("transferring to desc->ep_out == %d\n",
  478. (int)desc->ep_out);
  479. pipe = usb_sndbulkpipe(desc->usb_dev,desc->ep_out);
  480. }
  481. desc->context.data_pipe = pipe;
  482. }
  483. static int mts_scsi_queuecommand_lck(struct scsi_cmnd *srb)
  484. {
  485. mts_scsi_cmnd_callback callback = scsi_done;
  486. struct mts_desc* desc = (struct mts_desc*)(srb->device->host->hostdata[0]);
  487. int res;
  488. MTS_DEBUG_GOT_HERE();
  489. mts_show_command(srb);
  490. mts_debug_dump(desc);
  491. if ( srb->device->lun || srb->device->id || srb->device->channel ) {
  492. MTS_DEBUG("Command to LUN=%d ID=%d CHANNEL=%d from SCSI layer\n",(int)srb->device->lun,(int)srb->device->id, (int)srb->device->channel );
  493. MTS_DEBUG("this device doesn't exist\n");
  494. set_host_byte(srb, DID_BAD_TARGET);
  495. if(likely(callback != NULL))
  496. callback(srb);
  497. goto out;
  498. }
  499. usb_fill_bulk_urb(desc->urb,
  500. desc->usb_dev,
  501. usb_sndbulkpipe(desc->usb_dev,desc->ep_out),
  502. srb->cmnd,
  503. srb->cmd_len,
  504. mts_command_done,
  505. &desc->context
  506. );
  507. mts_build_transfer_context( srb, desc );
  508. desc->context.final_callback = callback;
  509. /* here we need ATOMIC as we are called with the iolock */
  510. res=usb_submit_urb(desc->urb, GFP_ATOMIC);
  511. if(unlikely(res)){
  512. MTS_ERROR("error %d submitting URB\n",(int)res);
  513. set_host_byte(srb, DID_ERROR);
  514. if(likely(callback != NULL))
  515. callback(srb);
  516. }
  517. out:
  518. return 0;
  519. }
  520. static DEF_SCSI_QCMD(mts_scsi_queuecommand)
  521. static struct scsi_host_template mts_scsi_host_template = {
  522. .module = THIS_MODULE,
  523. .name = "microtekX6",
  524. .proc_name = "microtekX6",
  525. .queuecommand = mts_scsi_queuecommand,
  526. .eh_abort_handler = mts_scsi_abort,
  527. .eh_host_reset_handler = mts_scsi_host_reset,
  528. .sg_tablesize = SG_ALL,
  529. .can_queue = 1,
  530. .this_id = -1,
  531. .emulated = 1,
  532. .slave_alloc = mts_slave_alloc,
  533. .slave_configure = mts_slave_configure,
  534. .max_sectors= 256, /* 128 K */
  535. };
  536. /* The entries of microtek_table must correspond, line-by-line to
  537. the entries of mts_supported_products[]. */
  538. static const struct usb_device_id mts_usb_ids[] =
  539. {
  540. { USB_DEVICE(0x4ce, 0x0300) },
  541. { USB_DEVICE(0x5da, 0x0094) },
  542. { USB_DEVICE(0x5da, 0x0099) },
  543. { USB_DEVICE(0x5da, 0x009a) },
  544. { USB_DEVICE(0x5da, 0x00a0) },
  545. { USB_DEVICE(0x5da, 0x00a3) },
  546. { USB_DEVICE(0x5da, 0x80a3) },
  547. { USB_DEVICE(0x5da, 0x80ac) },
  548. { USB_DEVICE(0x5da, 0x00b6) },
  549. { } /* Terminating entry */
  550. };
  551. MODULE_DEVICE_TABLE (usb, mts_usb_ids);
  552. static int mts_usb_probe(struct usb_interface *intf,
  553. const struct usb_device_id *id)
  554. {
  555. int i;
  556. int ep_out = -1;
  557. int ep_in_set[3]; /* this will break if we have more than three endpoints
  558. which is why we check */
  559. int *ep_in_current = ep_in_set;
  560. int err_retval = -ENOMEM;
  561. struct mts_desc * new_desc;
  562. struct usb_device *dev = interface_to_usbdev (intf);
  563. /* the current altsetting on the interface we're probing */
  564. struct usb_host_interface *altsetting;
  565. MTS_DEBUG_GOT_HERE();
  566. MTS_DEBUG( "usb-device descriptor at %x\n", (int)dev );
  567. MTS_DEBUG( "product id = 0x%x, vendor id = 0x%x\n",
  568. le16_to_cpu(dev->descriptor.idProduct),
  569. le16_to_cpu(dev->descriptor.idVendor) );
  570. MTS_DEBUG_GOT_HERE();
  571. /* the current altsetting on the interface we're probing */
  572. altsetting = intf->cur_altsetting;
  573. /* Check if the config is sane */
  574. if ( altsetting->desc.bNumEndpoints != MTS_EP_TOTAL ) {
  575. MTS_WARNING( "expecting %d got %d endpoints! Bailing out.\n",
  576. (int)MTS_EP_TOTAL, (int)altsetting->desc.bNumEndpoints );
  577. return -ENODEV;
  578. }
  579. for( i = 0; i < altsetting->desc.bNumEndpoints; i++ ) {
  580. if ((altsetting->endpoint[i].desc.bmAttributes &
  581. USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK) {
  582. MTS_WARNING( "can only deal with bulk endpoints; endpoint %d is not bulk.\n",
  583. (int)altsetting->endpoint[i].desc.bEndpointAddress );
  584. } else {
  585. if (altsetting->endpoint[i].desc.bEndpointAddress &
  586. USB_DIR_IN)
  587. *ep_in_current++
  588. = altsetting->endpoint[i].desc.bEndpointAddress &
  589. USB_ENDPOINT_NUMBER_MASK;
  590. else {
  591. if ( ep_out != -1 ) {
  592. MTS_WARNING( "can only deal with one output endpoints. Bailing out." );
  593. return -ENODEV;
  594. }
  595. ep_out = altsetting->endpoint[i].desc.bEndpointAddress &
  596. USB_ENDPOINT_NUMBER_MASK;
  597. }
  598. }
  599. }
  600. if (ep_in_current != &ep_in_set[2]) {
  601. MTS_WARNING("couldn't find two input bulk endpoints. Bailing out.\n");
  602. return -ENODEV;
  603. }
  604. if ( ep_out == -1 ) {
  605. MTS_WARNING( "couldn't find an output bulk endpoint. Bailing out.\n" );
  606. return -ENODEV;
  607. }
  608. new_desc = kzalloc(sizeof(struct mts_desc), GFP_KERNEL);
  609. if (!new_desc)
  610. goto out;
  611. new_desc->urb = usb_alloc_urb(0, GFP_KERNEL);
  612. if (!new_desc->urb)
  613. goto out_kfree;
  614. new_desc->context.scsi_status = kmalloc(1, GFP_KERNEL);
  615. if (!new_desc->context.scsi_status)
  616. goto out_free_urb;
  617. new_desc->usb_dev = dev;
  618. new_desc->usb_intf = intf;
  619. /* endpoints */
  620. new_desc->ep_out = ep_out;
  621. new_desc->ep_response = ep_in_set[0];
  622. new_desc->ep_image = ep_in_set[1];
  623. if ( new_desc->ep_out != MTS_EP_OUT )
  624. MTS_WARNING( "will this work? Command EP is not usually %d\n",
  625. (int)new_desc->ep_out );
  626. if ( new_desc->ep_response != MTS_EP_RESPONSE )
  627. MTS_WARNING( "will this work? Response EP is not usually %d\n",
  628. (int)new_desc->ep_response );
  629. if ( new_desc->ep_image != MTS_EP_IMAGE )
  630. MTS_WARNING( "will this work? Image data EP is not usually %d\n",
  631. (int)new_desc->ep_image );
  632. new_desc->host = scsi_host_alloc(&mts_scsi_host_template,
  633. sizeof(new_desc));
  634. if (!new_desc->host)
  635. goto out_kfree2;
  636. new_desc->host->hostdata[0] = (unsigned long)new_desc;
  637. if (scsi_add_host(new_desc->host, &dev->dev)) {
  638. err_retval = -EIO;
  639. goto out_host_put;
  640. }
  641. scsi_scan_host(new_desc->host);
  642. usb_set_intfdata(intf, new_desc);
  643. return 0;
  644. out_host_put:
  645. scsi_host_put(new_desc->host);
  646. out_kfree2:
  647. kfree(new_desc->context.scsi_status);
  648. out_free_urb:
  649. usb_free_urb(new_desc->urb);
  650. out_kfree:
  651. kfree(new_desc);
  652. out:
  653. return err_retval;
  654. }
  655. static void mts_usb_disconnect (struct usb_interface *intf)
  656. {
  657. struct mts_desc *desc = usb_get_intfdata(intf);
  658. usb_set_intfdata(intf, NULL);
  659. usb_kill_urb(desc->urb);
  660. scsi_remove_host(desc->host);
  661. scsi_host_put(desc->host);
  662. usb_free_urb(desc->urb);
  663. kfree(desc->context.scsi_status);
  664. kfree(desc);
  665. }
  666. module_usb_driver(mts_usb_driver);
  667. MODULE_AUTHOR( DRIVER_AUTHOR );
  668. MODULE_DESCRIPTION( DRIVER_DESC );
  669. MODULE_LICENSE("GPL");