microtek.c 23 KB

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