blob: 0b21ba757bba4a6dc0323dc1ae52d8972a52187d [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/* 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
Lucas De Marchi25985ed2011-03-30 22:57:33 -030072 * 20000514 Fix reporting of non-existent devices to SCSI layer (john)
Linus Torvalds1da177e2005-04-16 15:20:36 -070073 * 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
122#include <linux/module.h>
123#include <linux/kernel.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124#include <linux/signal.h>
125#include <linux/errno.h>
126#include <linux/random.h>
127#include <linux/poll.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128#include <linux/slab.h>
129#include <linux/spinlock.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130#include <linux/usb.h>
131#include <linux/proc_fs.h>
132
Arun Sharma600634972011-07-26 16:09:06 -0700133#include <linux/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134#include <linux/blkdev.h>
135#include "../../scsi/scsi.h"
136#include <scsi/scsi_host.h>
137
138#include "microtek.h"
139
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140#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
143/* Should we do debugging? */
144
145//#define MTS_DO_DEBUG
146
147/* USB layer driver interface */
148
149static int mts_usb_probe(struct usb_interface *intf,
150 const struct usb_device_id *id);
151static void mts_usb_disconnect(struct usb_interface *intf);
152
Németh Márton90521272010-01-10 15:34:36 +0100153static const struct usb_device_id mts_usb_ids[];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
155static struct usb_driver mts_usb_driver = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 .name = "microtekX6",
157 .probe = mts_usb_probe,
158 .disconnect = mts_usb_disconnect,
159 .id_table = mts_usb_ids,
160};
161
162
163/* Internal driver stuff */
164
165#define MTS_VERSION "0.4.3"
166#define MTS_NAME "microtek usb (rev " MTS_VERSION "): "
167
168#define MTS_WARNING(x...) \
169 printk( KERN_WARNING MTS_NAME x )
170#define MTS_ERROR(x...) \
171 printk( KERN_ERR MTS_NAME x )
172#define MTS_INT_ERROR(x...) \
173 MTS_ERROR(x)
174#define MTS_MESSAGE(x...) \
175 printk( KERN_INFO MTS_NAME x )
176
177#if defined MTS_DO_DEBUG
178
179#define MTS_DEBUG(x...) \
180 printk( KERN_DEBUG MTS_NAME x )
181
182#define MTS_DEBUG_GOT_HERE() \
Harvey Harrison96e12fc2008-04-04 14:28:01 -0700183 MTS_DEBUG("got to %s:%d (%s)\n", __FILE__, (int)__LINE__, __func__ )
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184#define MTS_DEBUG_INT() \
185 do { MTS_DEBUG_GOT_HERE(); \
186 MTS_DEBUG("transfer = 0x%x context = 0x%x\n",(int)transfer,(int)context ); \
Greg Kroah-Hartmanb44cd112007-07-18 10:58:02 -0700187 MTS_DEBUG("status = 0x%x data-length = 0x%x sent = 0x%x\n",transfer->status,(int)context->data_length, (int)transfer->actual_length ); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 mts_debug_dump(context->instance);\
189 } while(0)
190#else
191
192#define MTS_NUL_STATEMENT do { } while(0)
193
194#define MTS_DEBUG(x...) MTS_NUL_STATEMENT
195#define MTS_DEBUG_GOT_HERE() MTS_NUL_STATEMENT
196#define MTS_DEBUG_INT() MTS_NUL_STATEMENT
197
198#endif
199
200
201
202#define MTS_INT_INIT()\
203 struct mts_transfer_context* context = (struct mts_transfer_context*)transfer->context; \
204 MTS_DEBUG_INT();\
205
206#ifdef MTS_DO_DEBUG
207
208static inline void mts_debug_dump(struct mts_desc* desc) {
209 MTS_DEBUG("desc at 0x%x: toggle = %02x%02x\n",
210 (int)desc,
211 (int)desc->usb_dev->toggle[1],(int)desc->usb_dev->toggle[0]
212 );
213 MTS_DEBUG("ep_out=%x ep_response=%x ep_image=%x\n",
214 usb_sndbulkpipe(desc->usb_dev,desc->ep_out),
215 usb_rcvbulkpipe(desc->usb_dev,desc->ep_response),
216 usb_rcvbulkpipe(desc->usb_dev,desc->ep_image)
217 );
218}
219
220
Henrik Kretzschmar0eebe6a2006-09-25 17:00:58 -0700221static inline void mts_show_command(struct scsi_cmnd *srb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222{
223 char *what = NULL;
224
225 switch (srb->cmnd[0]) {
226 case TEST_UNIT_READY: what = "TEST_UNIT_READY"; break;
227 case REZERO_UNIT: what = "REZERO_UNIT"; break;
228 case REQUEST_SENSE: what = "REQUEST_SENSE"; break;
229 case FORMAT_UNIT: what = "FORMAT_UNIT"; break;
230 case READ_BLOCK_LIMITS: what = "READ_BLOCK_LIMITS"; break;
231 case REASSIGN_BLOCKS: what = "REASSIGN_BLOCKS"; break;
232 case READ_6: what = "READ_6"; break;
233 case WRITE_6: what = "WRITE_6"; break;
234 case SEEK_6: what = "SEEK_6"; break;
235 case READ_REVERSE: what = "READ_REVERSE"; break;
236 case WRITE_FILEMARKS: what = "WRITE_FILEMARKS"; break;
237 case SPACE: what = "SPACE"; break;
238 case INQUIRY: what = "INQUIRY"; break;
239 case RECOVER_BUFFERED_DATA: what = "RECOVER_BUFFERED_DATA"; break;
240 case MODE_SELECT: what = "MODE_SELECT"; break;
241 case RESERVE: what = "RESERVE"; break;
242 case RELEASE: what = "RELEASE"; break;
243 case COPY: what = "COPY"; break;
244 case ERASE: what = "ERASE"; break;
245 case MODE_SENSE: what = "MODE_SENSE"; break;
246 case START_STOP: what = "START_STOP"; break;
247 case RECEIVE_DIAGNOSTIC: what = "RECEIVE_DIAGNOSTIC"; break;
248 case SEND_DIAGNOSTIC: what = "SEND_DIAGNOSTIC"; break;
249 case ALLOW_MEDIUM_REMOVAL: what = "ALLOW_MEDIUM_REMOVAL"; break;
250 case SET_WINDOW: what = "SET_WINDOW"; break;
251 case READ_CAPACITY: what = "READ_CAPACITY"; break;
252 case READ_10: what = "READ_10"; break;
253 case WRITE_10: what = "WRITE_10"; break;
254 case SEEK_10: what = "SEEK_10"; break;
255 case WRITE_VERIFY: what = "WRITE_VERIFY"; break;
256 case VERIFY: what = "VERIFY"; break;
257 case SEARCH_HIGH: what = "SEARCH_HIGH"; break;
258 case SEARCH_EQUAL: what = "SEARCH_EQUAL"; break;
259 case SEARCH_LOW: what = "SEARCH_LOW"; break;
260 case SET_LIMITS: what = "SET_LIMITS"; break;
261 case READ_POSITION: what = "READ_POSITION"; break;
262 case SYNCHRONIZE_CACHE: what = "SYNCHRONIZE_CACHE"; break;
263 case LOCK_UNLOCK_CACHE: what = "LOCK_UNLOCK_CACHE"; break;
264 case READ_DEFECT_DATA: what = "READ_DEFECT_DATA"; break;
265 case MEDIUM_SCAN: what = "MEDIUM_SCAN"; break;
266 case COMPARE: what = "COMPARE"; break;
267 case COPY_VERIFY: what = "COPY_VERIFY"; break;
268 case WRITE_BUFFER: what = "WRITE_BUFFER"; break;
269 case READ_BUFFER: what = "READ_BUFFER"; break;
270 case UPDATE_BLOCK: what = "UPDATE_BLOCK"; break;
271 case READ_LONG: what = "READ_LONG"; break;
272 case WRITE_LONG: what = "WRITE_LONG"; break;
273 case CHANGE_DEFINITION: what = "CHANGE_DEFINITION"; break;
274 case WRITE_SAME: what = "WRITE_SAME"; break;
275 case READ_TOC: what = "READ_TOC"; break;
276 case LOG_SELECT: what = "LOG_SELECT"; break;
277 case LOG_SENSE: what = "LOG_SENSE"; break;
278 case MODE_SELECT_10: what = "MODE_SELECT_10"; break;
279 case MODE_SENSE_10: what = "MODE_SENSE_10"; break;
280 case MOVE_MEDIUM: what = "MOVE_MEDIUM"; break;
281 case READ_12: what = "READ_12"; break;
282 case WRITE_12: what = "WRITE_12"; break;
283 case WRITE_VERIFY_12: what = "WRITE_VERIFY_12"; break;
284 case SEARCH_HIGH_12: what = "SEARCH_HIGH_12"; break;
285 case SEARCH_EQUAL_12: what = "SEARCH_EQUAL_12"; break;
286 case SEARCH_LOW_12: what = "SEARCH_LOW_12"; break;
287 case READ_ELEMENT_STATUS: what = "READ_ELEMENT_STATUS"; break;
288 case SEND_VOLUME_TAG: what = "SEND_VOLUME_TAG"; break;
289 case WRITE_LONG_2: what = "WRITE_LONG_2"; break;
290 default:
291 MTS_DEBUG("can't decode command\n");
292 goto out;
293 break;
294 }
295 MTS_DEBUG( "Command %s (%d bytes)\n", what, srb->cmd_len);
296
297 out:
Andy Shevchenko78a629e2014-12-29 14:35:28 +0200298 MTS_DEBUG( " %10ph\n", srb->cmnd);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299}
300
301#else
302
Henrik Kretzschmar0eebe6a2006-09-25 17:00:58 -0700303static inline void mts_show_command(struct scsi_cmnd * dummy)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304{
305}
306
307static inline void mts_debug_dump(struct mts_desc* dummy)
308{
309}
310
311#endif
312
313static inline void mts_urb_abort(struct mts_desc* desc) {
314 MTS_DEBUG_GOT_HERE();
315 mts_debug_dump(desc);
316
317 usb_kill_urb( desc->urb );
318}
319
Oliver Neukum9142d592005-11-17 09:47:41 -0800320static int mts_slave_alloc (struct scsi_device *s)
321{
322 s->inquiry_len = 0x24;
323 return 0;
324}
325
326static int mts_slave_configure (struct scsi_device *s)
327{
328 blk_queue_dma_alignment(s->request_queue, (512 - 1));
329 return 0;
330}
331
Henrik Kretzschmar0eebe6a2006-09-25 17:00:58 -0700332static int mts_scsi_abort(struct scsi_cmnd *srb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333{
334 struct mts_desc* desc = (struct mts_desc*)(srb->device->host->hostdata[0]);
335
336 MTS_DEBUG_GOT_HERE();
337
338 mts_urb_abort(desc);
339
Hideaki YOSHIFUJI275cfdf2005-04-22 15:06:58 -0700340 return FAILED;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341}
342
Henrik Kretzschmar0eebe6a2006-09-25 17:00:58 -0700343static int mts_scsi_host_reset(struct scsi_cmnd *srb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344{
345 struct mts_desc* desc = (struct mts_desc*)(srb->device->host->hostdata[0]);
Alan Stern011b15d2008-11-04 11:29:27 -0500346 int result;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347
348 MTS_DEBUG_GOT_HERE();
349 mts_debug_dump(desc);
350
Alan Stern011b15d2008-11-04 11:29:27 -0500351 result = usb_lock_device_for_reset(desc->usb_dev, desc->usb_intf);
352 if (result == 0) {
353 result = usb_reset_device(desc->usb_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 usb_unlock_device(desc->usb_dev);
Alan Stern011b15d2008-11-04 11:29:27 -0500355 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356 return result ? FAILED : SUCCESS;
357}
358
Henrik Kretzschmar0eebe6a2006-09-25 17:00:58 -0700359static int
Jeff Garzikf2812332010-11-16 02:10:29 -0500360mts_scsi_queuecommand(struct Scsi_Host *shost, struct scsi_cmnd *srb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361
362static void mts_transfer_cleanup( struct urb *transfer );
David Howells7d12e782006-10-05 14:55:46 +0100363static void mts_do_sg(struct urb * transfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364
Jesper Juhl77933d72005-07-27 11:46:09 -0700365static inline
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366void mts_int_submit_urb (struct urb* transfer,
367 int pipe,
368 void* data,
369 unsigned length,
370 usb_complete_t callback )
371/* Interrupt context! */
372
373/* Holding transfer->context->lock! */
374{
375 int res;
376
377 MTS_INT_INIT();
378
379 usb_fill_bulk_urb(transfer,
380 context->instance->usb_dev,
381 pipe,
382 data,
383 length,
384 callback,
385 context
386 );
387
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 res = usb_submit_urb( transfer, GFP_ATOMIC );
389 if ( unlikely(res) ) {
390 MTS_INT_ERROR( "could not submit URB! Error was %d\n",(int)res );
391 context->srb->result = DID_ERROR << 16;
392 mts_transfer_cleanup(transfer);
393 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394}
395
396
397static void mts_transfer_cleanup( struct urb *transfer )
398/* Interrupt context! */
399{
400 MTS_INT_INIT();
401
402 if ( likely(context->final_callback != NULL) )
403 context->final_callback(context->srb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404}
405
David Howells7d12e782006-10-05 14:55:46 +0100406static void mts_transfer_done( struct urb *transfer )
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407{
408 MTS_INT_INIT();
409
410 context->srb->result &= MTS_SCSI_ERR_MASK;
Oliver Neukum9142d592005-11-17 09:47:41 -0800411 context->srb->result |= (unsigned)(*context->scsi_status)<<1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412
413 mts_transfer_cleanup(transfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414}
415
416
417static void mts_get_status( struct urb *transfer )
418/* Interrupt context! */
419{
420 MTS_INT_INIT();
421
422 mts_int_submit_urb(transfer,
423 usb_rcvbulkpipe(context->instance->usb_dev,
424 context->instance->ep_response),
Oliver Neukum9142d592005-11-17 09:47:41 -0800425 context->scsi_status,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 1,
427 mts_transfer_done );
428}
429
David Howells7d12e782006-10-05 14:55:46 +0100430static void mts_data_done( struct urb* transfer )
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431/* Interrupt context! */
432{
Greg Kroah-Hartmanb44cd112007-07-18 10:58:02 -0700433 int status = transfer->status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 MTS_INT_INIT();
435
436 if ( context->data_length != transfer->actual_length ) {
Boaz Harroshafd9a032007-07-12 16:11:24 +0300437 scsi_set_resid(context->srb, context->data_length -
438 transfer->actual_length);
Greg Kroah-Hartmanb44cd112007-07-18 10:58:02 -0700439 } else if ( unlikely(status) ) {
440 context->srb->result = (status == -ENOENT ? DID_ABORT : DID_ERROR)<<16;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 }
442
443 mts_get_status(transfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444}
445
446
David Howells7d12e782006-10-05 14:55:46 +0100447static void mts_command_done( struct urb *transfer )
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448/* Interrupt context! */
449{
Greg Kroah-Hartmanb44cd112007-07-18 10:58:02 -0700450 int status = transfer->status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451 MTS_INT_INIT();
452
Greg Kroah-Hartmanb44cd112007-07-18 10:58:02 -0700453 if ( unlikely(status) ) {
454 if (status == -ENOENT) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 /* We are being killed */
456 MTS_DEBUG_GOT_HERE();
457 context->srb->result = DID_ABORT<<16;
458 } else {
459 /* A genuine error has occurred */
460 MTS_DEBUG_GOT_HERE();
461
462 context->srb->result = DID_ERROR<<16;
463 }
464 mts_transfer_cleanup(transfer);
465
466 return;
467 }
468
469 if (context->srb->cmnd[0] == REQUEST_SENSE) {
470 mts_int_submit_urb(transfer,
471 context->data_pipe,
472 context->srb->sense_buffer,
473 context->data_length,
474 mts_data_done);
475 } else { if ( context->data ) {
476 mts_int_submit_urb(transfer,
477 context->data_pipe,
478 context->data,
479 context->data_length,
Boaz Harroshafd9a032007-07-12 16:11:24 +0300480 scsi_sg_count(context->srb) > 1 ?
481 mts_do_sg : mts_data_done);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 } else {
483 mts_get_status(transfer);
484 }
485 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486}
487
David Howells7d12e782006-10-05 14:55:46 +0100488static void mts_do_sg (struct urb* transfer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489{
490 struct scatterlist * sg;
Greg Kroah-Hartmanb44cd112007-07-18 10:58:02 -0700491 int status = transfer->status;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 MTS_INT_INIT();
493
Boaz Harroshafd9a032007-07-12 16:11:24 +0300494 MTS_DEBUG("Processing fragment %d of %d\n", context->fragment,
495 scsi_sg_count(context->srb));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496
Greg Kroah-Hartmanb44cd112007-07-18 10:58:02 -0700497 if (unlikely(status)) {
498 context->srb->result = (status == -ENOENT ? DID_ABORT : DID_ERROR)<<16;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 mts_transfer_cleanup(transfer);
500 }
501
Boaz Harroshafd9a032007-07-12 16:11:24 +0300502 sg = scsi_sglist(context->srb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503 context->fragment++;
504 mts_int_submit_urb(transfer,
505 context->data_pipe,
Jens Axboe45711f12007-10-22 21:19:53 +0200506 sg_virt(&sg[context->fragment]),
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507 sg[context->fragment].length,
Boaz Harroshafd9a032007-07-12 16:11:24 +0300508 context->fragment + 1 == scsi_sg_count(context->srb) ?
509 mts_data_done : mts_do_sg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510}
511
512static const u8 mts_read_image_sig[] = { 0x28, 00, 00, 00 };
513static const u8 mts_read_image_sig_len = 4;
514static const unsigned char mts_direction[256/8] = {
515 0x28, 0x81, 0x14, 0x14, 0x20, 0x01, 0x90, 0x77,
516 0x0C, 0x20, 0x00, 0x04, 0x00, 0x00, 0x00, 0x00,
517 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x01,
518 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
519};
520
521
522#define MTS_DIRECTION_IS_IN(x) ((mts_direction[x>>3] >> (x & 7)) & 1)
523
524static void
Henrik Kretzschmar0eebe6a2006-09-25 17:00:58 -0700525mts_build_transfer_context(struct scsi_cmnd *srb, struct mts_desc* desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526{
527 int pipe;
528 struct scatterlist * sg;
529
530 MTS_DEBUG_GOT_HERE();
531
532 desc->context.instance = desc;
533 desc->context.srb = srb;
534 desc->context.fragment = 0;
535
Boaz Harroshafd9a032007-07-12 16:11:24 +0300536 if (!scsi_bufflen(srb)) {
537 desc->context.data = NULL;
538 desc->context.data_length = 0;
539 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 } else {
Boaz Harroshafd9a032007-07-12 16:11:24 +0300541 sg = scsi_sglist(srb);
Jens Axboe45711f12007-10-22 21:19:53 +0200542 desc->context.data = sg_virt(&sg[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 desc->context.data_length = sg[0].length;
544 }
545
546
547 /* can't rely on srb->sc_data_direction */
548
549 /* Brutally ripped from usb-storage */
550
551 if ( !memcmp( srb->cmnd, mts_read_image_sig, mts_read_image_sig_len )
552) { pipe = usb_rcvbulkpipe(desc->usb_dev,desc->ep_image);
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300553 MTS_DEBUG( "transferring from desc->ep_image == %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 (int)desc->ep_image );
555 } else if ( MTS_DIRECTION_IS_IN(srb->cmnd[0]) ) {
556 pipe = usb_rcvbulkpipe(desc->usb_dev,desc->ep_response);
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300557 MTS_DEBUG( "transferring from desc->ep_response == %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 (int)desc->ep_response);
559 } else {
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300560 MTS_DEBUG("transferring to desc->ep_out == %d\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 (int)desc->ep_out);
562 pipe = usb_sndbulkpipe(desc->usb_dev,desc->ep_out);
563 }
564 desc->context.data_pipe = pipe;
565}
566
567
Henrik Kretzschmar0eebe6a2006-09-25 17:00:58 -0700568static int
Jeff Garzikf2812332010-11-16 02:10:29 -0500569mts_scsi_queuecommand_lck(struct scsi_cmnd *srb, mts_scsi_cmnd_callback callback)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570{
571 struct mts_desc* desc = (struct mts_desc*)(srb->device->host->hostdata[0]);
572 int err = 0;
573 int res;
574
575 MTS_DEBUG_GOT_HERE();
576 mts_show_command(srb);
577 mts_debug_dump(desc);
578
579 if ( srb->device->lun || srb->device->id || srb->device->channel ) {
580
581 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 );
582
583 MTS_DEBUG("this device doesn't exist\n");
584
585 srb->result = DID_BAD_TARGET << 16;
586
587 if(likely(callback != NULL))
588 callback(srb);
589
590 goto out;
591 }
592
593
594 usb_fill_bulk_urb(desc->urb,
595 desc->usb_dev,
596 usb_sndbulkpipe(desc->usb_dev,desc->ep_out),
597 srb->cmnd,
598 srb->cmd_len,
599 mts_command_done,
600 &desc->context
601 );
602
603
604 mts_build_transfer_context( srb, desc );
605 desc->context.final_callback = callback;
606
607 /* here we need ATOMIC as we are called with the iolock */
608 res=usb_submit_urb(desc->urb, GFP_ATOMIC);
609
610 if(unlikely(res)){
611 MTS_ERROR("error %d submitting URB\n",(int)res);
612 srb->result = DID_ERROR << 16;
613
614 if(likely(callback != NULL))
615 callback(srb);
616
617 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618out:
619 return err;
620}
621
Jeff Garzikf2812332010-11-16 02:10:29 -0500622static DEF_SCSI_QCMD(mts_scsi_queuecommand)
623
Christoph Hellwigd0be4a7d2005-10-31 18:31:40 +0100624static struct scsi_host_template mts_scsi_host_template = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 .module = THIS_MODULE,
626 .name = "microtekX6",
627 .proc_name = "microtekX6",
628 .queuecommand = mts_scsi_queuecommand,
629 .eh_abort_handler = mts_scsi_abort,
630 .eh_host_reset_handler = mts_scsi_host_reset,
631 .sg_tablesize = SG_ALL,
632 .can_queue = 1,
633 .this_id = -1,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 .use_clustering = 1,
635 .emulated = 1,
Oliver Neukum9142d592005-11-17 09:47:41 -0800636 .slave_alloc = mts_slave_alloc,
637 .slave_configure = mts_slave_configure,
638 .max_sectors= 256, /* 128 K */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639};
640
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641/* The entries of microtek_table must correspond, line-by-line to
642 the entries of mts_supported_products[]. */
643
Németh Márton90521272010-01-10 15:34:36 +0100644static const struct usb_device_id mts_usb_ids[] =
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645{
646 { USB_DEVICE(0x4ce, 0x0300) },
647 { USB_DEVICE(0x5da, 0x0094) },
648 { USB_DEVICE(0x5da, 0x0099) },
649 { USB_DEVICE(0x5da, 0x009a) },
650 { USB_DEVICE(0x5da, 0x00a0) },
651 { USB_DEVICE(0x5da, 0x00a3) },
652 { USB_DEVICE(0x5da, 0x80a3) },
653 { USB_DEVICE(0x5da, 0x80ac) },
654 { USB_DEVICE(0x5da, 0x00b6) },
655 { } /* Terminating entry */
656};
657
658MODULE_DEVICE_TABLE (usb, mts_usb_ids);
659
660
661static int mts_usb_probe(struct usb_interface *intf,
662 const struct usb_device_id *id)
663{
664 int i;
665 int ep_out = -1;
666 int ep_in_set[3]; /* this will break if we have more than three endpoints
667 which is why we check */
668 int *ep_in_current = ep_in_set;
669 int err_retval = -ENOMEM;
670
671 struct mts_desc * new_desc;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700672 struct usb_device *dev = interface_to_usbdev (intf);
673
674 /* the current altsetting on the interface we're probing */
675 struct usb_host_interface *altsetting;
676
677 MTS_DEBUG_GOT_HERE();
678 MTS_DEBUG( "usb-device descriptor at %x\n", (int)dev );
679
680 MTS_DEBUG( "product id = 0x%x, vendor id = 0x%x\n",
681 le16_to_cpu(dev->descriptor.idProduct),
682 le16_to_cpu(dev->descriptor.idVendor) );
683
684 MTS_DEBUG_GOT_HERE();
685
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 /* the current altsetting on the interface we're probing */
687 altsetting = intf->cur_altsetting;
688
689
690 /* Check if the config is sane */
691
692 if ( altsetting->desc.bNumEndpoints != MTS_EP_TOTAL ) {
693 MTS_WARNING( "expecting %d got %d endpoints! Bailing out.\n",
694 (int)MTS_EP_TOTAL, (int)altsetting->desc.bNumEndpoints );
695 return -ENODEV;
696 }
697
698 for( i = 0; i < altsetting->desc.bNumEndpoints; i++ ) {
699 if ((altsetting->endpoint[i].desc.bmAttributes &
700 USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK) {
701
702 MTS_WARNING( "can only deal with bulk endpoints; endpoint %d is not bulk.\n",
703 (int)altsetting->endpoint[i].desc.bEndpointAddress );
704 } else {
705 if (altsetting->endpoint[i].desc.bEndpointAddress &
706 USB_DIR_IN)
707 *ep_in_current++
708 = altsetting->endpoint[i].desc.bEndpointAddress &
709 USB_ENDPOINT_NUMBER_MASK;
710 else {
711 if ( ep_out != -1 ) {
712 MTS_WARNING( "can only deal with one output endpoints. Bailing out." );
713 return -ENODEV;
714 }
715
716 ep_out = altsetting->endpoint[i].desc.bEndpointAddress &
717 USB_ENDPOINT_NUMBER_MASK;
718 }
719 }
720
721 }
722
723
724 if ( ep_out == -1 ) {
725 MTS_WARNING( "couldn't find an output bulk endpoint. Bailing out.\n" );
726 return -ENODEV;
727 }
Oliver Neukum9142d592005-11-17 09:47:41 -0800728
729
Oliver Neukum61eded62005-10-24 22:37:20 +0200730 new_desc = kzalloc(sizeof(struct mts_desc), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 if (!new_desc)
732 goto out;
733
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 new_desc->urb = usb_alloc_urb(0, GFP_KERNEL);
735 if (!new_desc->urb)
736 goto out_kfree;
737
Oliver Neukum9142d592005-11-17 09:47:41 -0800738 new_desc->context.scsi_status = kmalloc(1, GFP_KERNEL);
739 if (!new_desc->context.scsi_status)
Mariusz Kozlowskia3b1f502006-11-17 11:53:23 +0100740 goto out_free_urb;
Oliver Neukum9142d592005-11-17 09:47:41 -0800741
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 new_desc->usb_dev = dev;
743 new_desc->usb_intf = intf;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744
745 /* endpoints */
746 new_desc->ep_out = ep_out;
747 new_desc->ep_response = ep_in_set[0];
748 new_desc->ep_image = ep_in_set[1];
749
750 if ( new_desc->ep_out != MTS_EP_OUT )
751 MTS_WARNING( "will this work? Command EP is not usually %d\n",
752 (int)new_desc->ep_out );
753
754 if ( new_desc->ep_response != MTS_EP_RESPONSE )
755 MTS_WARNING( "will this work? Response EP is not usually %d\n",
756 (int)new_desc->ep_response );
757
758 if ( new_desc->ep_image != MTS_EP_IMAGE )
759 MTS_WARNING( "will this work? Image data EP is not usually %d\n",
760 (int)new_desc->ep_image );
761
762 new_desc->host = scsi_host_alloc(&mts_scsi_host_template,
763 sizeof(new_desc));
764 if (!new_desc->host)
Mariusz Kozlowskia3b1f502006-11-17 11:53:23 +0100765 goto out_kfree2;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766
767 new_desc->host->hostdata[0] = (unsigned long)new_desc;
Oliver Neukum5cf19732007-11-12 14:08:43 +0100768 if (scsi_add_host(new_desc->host, &dev->dev)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 err_retval = -EIO;
Mariusz Kozlowskia3b1f502006-11-17 11:53:23 +0100770 goto out_host_put;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 }
772 scsi_scan_host(new_desc->host);
773
774 usb_set_intfdata(intf, new_desc);
775 return 0;
776
Mariusz Kozlowskia3b1f502006-11-17 11:53:23 +0100777 out_host_put:
778 scsi_host_put(new_desc->host);
Oliver Neukum9142d592005-11-17 09:47:41 -0800779 out_kfree2:
780 kfree(new_desc->context.scsi_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 out_free_urb:
782 usb_free_urb(new_desc->urb);
783 out_kfree:
784 kfree(new_desc);
785 out:
786 return err_retval;
787}
788
789static void mts_usb_disconnect (struct usb_interface *intf)
790{
791 struct mts_desc *desc = usb_get_intfdata(intf);
792
793 usb_set_intfdata(intf, NULL);
794
795 usb_kill_urb(desc->urb);
796 scsi_remove_host(desc->host);
797
798 scsi_host_put(desc->host);
799 usb_free_urb(desc->urb);
Oliver Neukum9142d592005-11-17 09:47:41 -0800800 kfree(desc->context.scsi_status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801 kfree(desc);
802}
803
Greg Kroah-Hartman65db4302011-11-18 09:34:02 -0800804module_usb_driver(mts_usb_driver);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805
806MODULE_AUTHOR( DRIVER_AUTHOR );
807MODULE_DESCRIPTION( DRIVER_DESC );
808MODULE_LICENSE("GPL");