Loading...
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 <vii@penguinpowered.com>
5 * (C) Copyright 2000 Oliver Neukum <Oliver.Neukum@lrz.uni-muenchen.de>
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
123#include <linux/module.h>
124#include <linux/kernel.h>
125#include <linux/signal.h>
126#include <linux/errno.h>
127#include <linux/random.h>
128#include <linux/poll.h>
129#include <linux/slab.h>
130#include <linux/spinlock.h>
131#include <linux/usb.h>
132#include <linux/proc_fs.h>
133#include <linux/atomic.h>
134#include <linux/blkdev.h>
135
136#include <scsi/scsi.h>
137#include <scsi/scsi_cmnd.h>
138#include <scsi/scsi_device.h>
139#include <scsi/scsi_eh.h>
140#include <scsi/scsi_host.h>
141#include <scsi/scsi_tcq.h>
142
143#include "microtek.h"
144
145#define DRIVER_AUTHOR "John Fremlin <vii@penguinpowered.com>, Oliver Neukum <Oliver.Neukum@lrz.uni-muenchen.de>"
146#define DRIVER_DESC "Microtek Scanmaker X6 USB scanner driver"
147
148/* Should we do debugging? */
149
150//#define MTS_DO_DEBUG
151
152/* USB layer driver interface */
153
154static int mts_usb_probe(struct usb_interface *intf,
155 const struct usb_device_id *id);
156static void mts_usb_disconnect(struct usb_interface *intf);
157
158static const struct usb_device_id mts_usb_ids[];
159
160static struct usb_driver mts_usb_driver = {
161 .name = "microtekX6",
162 .probe = mts_usb_probe,
163 .disconnect = mts_usb_disconnect,
164 .id_table = mts_usb_ids,
165};
166
167
168/* Internal driver stuff */
169
170#define MTS_VERSION "0.4.3"
171#define MTS_NAME "microtek usb (rev " MTS_VERSION "): "
172
173#define MTS_WARNING(x...) \
174 printk( KERN_WARNING MTS_NAME x )
175#define MTS_ERROR(x...) \
176 printk( KERN_ERR MTS_NAME x )
177#define MTS_INT_ERROR(x...) \
178 MTS_ERROR(x)
179#define MTS_MESSAGE(x...) \
180 printk( KERN_INFO MTS_NAME x )
181
182#if defined MTS_DO_DEBUG
183
184#define MTS_DEBUG(x...) \
185 printk( KERN_DEBUG MTS_NAME x )
186
187#define MTS_DEBUG_GOT_HERE() \
188 MTS_DEBUG("got to %s:%d (%s)\n", __FILE__, (int)__LINE__, __func__ )
189#define MTS_DEBUG_INT() \
190 do { MTS_DEBUG_GOT_HERE(); \
191 MTS_DEBUG("transfer = 0x%x context = 0x%x\n",(int)transfer,(int)context ); \
192 MTS_DEBUG("status = 0x%x data-length = 0x%x sent = 0x%x\n",transfer->status,(int)context->data_length, (int)transfer->actual_length ); \
193 mts_debug_dump(context->instance);\
194 } while(0)
195#else
196
197#define MTS_NUL_STATEMENT do { } while(0)
198
199#define MTS_DEBUG(x...) MTS_NUL_STATEMENT
200#define MTS_DEBUG_GOT_HERE() MTS_NUL_STATEMENT
201#define MTS_DEBUG_INT() MTS_NUL_STATEMENT
202
203#endif
204
205
206
207#define MTS_INT_INIT()\
208 struct mts_transfer_context* context = (struct mts_transfer_context*)transfer->context; \
209 MTS_DEBUG_INT();\
210
211#ifdef MTS_DO_DEBUG
212
213static inline void mts_debug_dump(struct mts_desc* desc) {
214 MTS_DEBUG("desc at 0x%x: toggle = %02x%02x\n",
215 (int)desc,
216 (int)desc->usb_dev->toggle[1],(int)desc->usb_dev->toggle[0]
217 );
218 MTS_DEBUG("ep_out=%x ep_response=%x ep_image=%x\n",
219 usb_sndbulkpipe(desc->usb_dev,desc->ep_out),
220 usb_rcvbulkpipe(desc->usb_dev,desc->ep_response),
221 usb_rcvbulkpipe(desc->usb_dev,desc->ep_image)
222 );
223}
224
225
226static inline void mts_show_command(struct scsi_cmnd *srb)
227{
228 char *what = NULL;
229
230 switch (srb->cmnd[0]) {
231 case TEST_UNIT_READY: what = "TEST_UNIT_READY"; break;
232 case REZERO_UNIT: what = "REZERO_UNIT"; break;
233 case REQUEST_SENSE: what = "REQUEST_SENSE"; break;
234 case FORMAT_UNIT: what = "FORMAT_UNIT"; break;
235 case READ_BLOCK_LIMITS: what = "READ_BLOCK_LIMITS"; break;
236 case REASSIGN_BLOCKS: what = "REASSIGN_BLOCKS"; break;
237 case READ_6: what = "READ_6"; break;
238 case WRITE_6: what = "WRITE_6"; break;
239 case SEEK_6: what = "SEEK_6"; break;
240 case READ_REVERSE: what = "READ_REVERSE"; break;
241 case WRITE_FILEMARKS: what = "WRITE_FILEMARKS"; break;
242 case SPACE: what = "SPACE"; break;
243 case INQUIRY: what = "INQUIRY"; break;
244 case RECOVER_BUFFERED_DATA: what = "RECOVER_BUFFERED_DATA"; break;
245 case MODE_SELECT: what = "MODE_SELECT"; break;
246 case RESERVE: what = "RESERVE"; break;
247 case RELEASE: what = "RELEASE"; break;
248 case COPY: what = "COPY"; break;
249 case ERASE: what = "ERASE"; break;
250 case MODE_SENSE: what = "MODE_SENSE"; break;
251 case START_STOP: what = "START_STOP"; break;
252 case RECEIVE_DIAGNOSTIC: what = "RECEIVE_DIAGNOSTIC"; break;
253 case SEND_DIAGNOSTIC: what = "SEND_DIAGNOSTIC"; break;
254 case ALLOW_MEDIUM_REMOVAL: what = "ALLOW_MEDIUM_REMOVAL"; break;
255 case SET_WINDOW: what = "SET_WINDOW"; break;
256 case READ_CAPACITY: what = "READ_CAPACITY"; break;
257 case READ_10: what = "READ_10"; break;
258 case WRITE_10: what = "WRITE_10"; break;
259 case SEEK_10: what = "SEEK_10"; break;
260 case WRITE_VERIFY: what = "WRITE_VERIFY"; break;
261 case VERIFY: what = "VERIFY"; break;
262 case SEARCH_HIGH: what = "SEARCH_HIGH"; break;
263 case SEARCH_EQUAL: what = "SEARCH_EQUAL"; break;
264 case SEARCH_LOW: what = "SEARCH_LOW"; break;
265 case SET_LIMITS: what = "SET_LIMITS"; break;
266 case READ_POSITION: what = "READ_POSITION"; break;
267 case SYNCHRONIZE_CACHE: what = "SYNCHRONIZE_CACHE"; break;
268 case LOCK_UNLOCK_CACHE: what = "LOCK_UNLOCK_CACHE"; break;
269 case READ_DEFECT_DATA: what = "READ_DEFECT_DATA"; break;
270 case MEDIUM_SCAN: what = "MEDIUM_SCAN"; break;
271 case COMPARE: what = "COMPARE"; break;
272 case COPY_VERIFY: what = "COPY_VERIFY"; break;
273 case WRITE_BUFFER: what = "WRITE_BUFFER"; break;
274 case READ_BUFFER: what = "READ_BUFFER"; break;
275 case UPDATE_BLOCK: what = "UPDATE_BLOCK"; break;
276 case READ_LONG: what = "READ_LONG"; break;
277 case WRITE_LONG: what = "WRITE_LONG"; break;
278 case CHANGE_DEFINITION: what = "CHANGE_DEFINITION"; break;
279 case WRITE_SAME: what = "WRITE_SAME"; break;
280 case READ_TOC: what = "READ_TOC"; break;
281 case LOG_SELECT: what = "LOG_SELECT"; break;
282 case LOG_SENSE: what = "LOG_SENSE"; break;
283 case MODE_SELECT_10: what = "MODE_SELECT_10"; break;
284 case MODE_SENSE_10: what = "MODE_SENSE_10"; break;
285 case MOVE_MEDIUM: what = "MOVE_MEDIUM"; break;
286 case READ_12: what = "READ_12"; break;
287 case WRITE_12: what = "WRITE_12"; break;
288 case WRITE_VERIFY_12: what = "WRITE_VERIFY_12"; break;
289 case SEARCH_HIGH_12: what = "SEARCH_HIGH_12"; break;
290 case SEARCH_EQUAL_12: what = "SEARCH_EQUAL_12"; break;
291 case SEARCH_LOW_12: what = "SEARCH_LOW_12"; break;
292 case READ_ELEMENT_STATUS: what = "READ_ELEMENT_STATUS"; break;
293 case SEND_VOLUME_TAG: what = "SEND_VOLUME_TAG"; break;
294 case WRITE_LONG_2: what = "WRITE_LONG_2"; break;
295 default:
296 MTS_DEBUG("can't decode command\n");
297 goto out;
298 break;
299 }
300 MTS_DEBUG( "Command %s (%d bytes)\n", what, srb->cmd_len);
301
302 out:
303 MTS_DEBUG( " %10ph\n", srb->cmnd);
304}
305
306#else
307
308static inline void mts_show_command(struct scsi_cmnd * dummy)
309{
310}
311
312static inline void mts_debug_dump(struct mts_desc* dummy)
313{
314}
315
316#endif
317
318static inline void mts_urb_abort(struct mts_desc* desc) {
319 MTS_DEBUG_GOT_HERE();
320 mts_debug_dump(desc);
321
322 usb_kill_urb( desc->urb );
323}
324
325static int mts_slave_alloc (struct scsi_device *s)
326{
327 s->inquiry_len = 0x24;
328 return 0;
329}
330
331static int mts_scsi_abort(struct scsi_cmnd *srb)
332{
333 struct mts_desc* desc = (struct mts_desc*)(srb->device->host->hostdata[0]);
334
335 MTS_DEBUG_GOT_HERE();
336
337 mts_urb_abort(desc);
338
339 return FAILED;
340}
341
342static int mts_scsi_host_reset(struct scsi_cmnd *srb)
343{
344 struct mts_desc* desc = (struct mts_desc*)(srb->device->host->hostdata[0]);
345 int result;
346
347 MTS_DEBUG_GOT_HERE();
348 mts_debug_dump(desc);
349
350 result = usb_lock_device_for_reset(desc->usb_dev, desc->usb_intf);
351 if (result == 0) {
352 result = usb_reset_device(desc->usb_dev);
353 usb_unlock_device(desc->usb_dev);
354 }
355 return result ? FAILED : SUCCESS;
356}
357
358static int
359mts_scsi_queuecommand(struct Scsi_Host *shost, struct scsi_cmnd *srb);
360
361static void mts_transfer_cleanup( struct urb *transfer );
362static void mts_do_sg(struct urb * transfer);
363
364static inline
365void mts_int_submit_urb (struct urb* transfer,
366 int pipe,
367 void* data,
368 unsigned length,
369 usb_complete_t callback )
370/* Interrupt context! */
371
372/* Holding transfer->context->lock! */
373{
374 int res;
375
376 MTS_INT_INIT();
377
378 usb_fill_bulk_urb(transfer,
379 context->instance->usb_dev,
380 pipe,
381 data,
382 length,
383 callback,
384 context
385 );
386
387 res = usb_submit_urb( transfer, GFP_ATOMIC );
388 if ( unlikely(res) ) {
389 MTS_INT_ERROR( "could not submit URB! Error was %d\n",(int)res );
390 set_host_byte(context->srb, DID_ERROR);
391 mts_transfer_cleanup(transfer);
392 }
393}
394
395
396static void mts_transfer_cleanup( struct urb *transfer )
397/* Interrupt context! */
398{
399 MTS_INT_INIT();
400
401 if ( likely(context->final_callback != NULL) )
402 context->final_callback(context->srb);
403}
404
405static void mts_transfer_done( struct urb *transfer )
406{
407 MTS_INT_INIT();
408
409 context->srb->result &= MTS_SCSI_ERR_MASK;
410 context->srb->result |= (unsigned)(*context->scsi_status)<<1;
411
412 mts_transfer_cleanup(transfer);
413}
414
415
416static void mts_get_status( struct urb *transfer )
417/* Interrupt context! */
418{
419 MTS_INT_INIT();
420
421 mts_int_submit_urb(transfer,
422 usb_rcvbulkpipe(context->instance->usb_dev,
423 context->instance->ep_response),
424 context->scsi_status,
425 1,
426 mts_transfer_done );
427}
428
429static void mts_data_done( struct urb* transfer )
430/* Interrupt context! */
431{
432 int status = transfer->status;
433 MTS_INT_INIT();
434
435 if ( context->data_length != transfer->actual_length ) {
436 scsi_set_resid(context->srb, context->data_length -
437 transfer->actual_length);
438 } else if ( unlikely(status) ) {
439 set_host_byte(context->srb, (status == -ENOENT ? DID_ABORT : DID_ERROR));
440 }
441
442 mts_get_status(transfer);
443}
444
445
446static void mts_command_done( struct urb *transfer )
447/* Interrupt context! */
448{
449 int status = transfer->status;
450 MTS_INT_INIT();
451
452 if ( unlikely(status) ) {
453 if (status == -ENOENT) {
454 /* We are being killed */
455 MTS_DEBUG_GOT_HERE();
456 set_host_byte(context->srb, DID_ABORT);
457 } else {
458 /* A genuine error has occurred */
459 MTS_DEBUG_GOT_HERE();
460
461 set_host_byte(context->srb, DID_ERROR);
462 }
463 mts_transfer_cleanup(transfer);
464
465 return;
466 }
467
468 if (context->srb->cmnd[0] == REQUEST_SENSE) {
469 mts_int_submit_urb(transfer,
470 context->data_pipe,
471 context->srb->sense_buffer,
472 context->data_length,
473 mts_data_done);
474 } else { if ( context->data ) {
475 mts_int_submit_urb(transfer,
476 context->data_pipe,
477 context->data,
478 context->data_length,
479 scsi_sg_count(context->srb) > 1 ?
480 mts_do_sg : mts_data_done);
481 } else {
482 mts_get_status(transfer);
483 }
484 }
485}
486
487static void mts_do_sg (struct urb* transfer)
488{
489 int status = transfer->status;
490 MTS_INT_INIT();
491
492 MTS_DEBUG("Processing fragment %d of %d\n", context->fragment,
493 scsi_sg_count(context->srb));
494
495 if (unlikely(status)) {
496 set_host_byte(context->srb, (status == -ENOENT ? DID_ABORT : DID_ERROR));
497 mts_transfer_cleanup(transfer);
498 }
499
500 context->curr_sg = sg_next(context->curr_sg);
501 mts_int_submit_urb(transfer,
502 context->data_pipe,
503 sg_virt(context->curr_sg),
504 context->curr_sg->length,
505 sg_is_last(context->curr_sg) ?
506 mts_data_done : mts_do_sg);
507}
508
509static const u8 mts_read_image_sig[] = { 0x28, 00, 00, 00 };
510static const u8 mts_read_image_sig_len = 4;
511static const unsigned char mts_direction[256/8] = {
512 0x28, 0x81, 0x14, 0x14, 0x20, 0x01, 0x90, 0x77,
513 0x0C, 0x20, 0x00, 0x04, 0x00, 0x00, 0x00, 0x00,
514 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x01,
515 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
516};
517
518
519#define MTS_DIRECTION_IS_IN(x) ((mts_direction[x>>3] >> (x & 7)) & 1)
520
521static void
522mts_build_transfer_context(struct scsi_cmnd *srb, struct mts_desc* desc)
523{
524 int pipe;
525
526 MTS_DEBUG_GOT_HERE();
527
528 desc->context.instance = desc;
529 desc->context.srb = srb;
530
531 if (!scsi_bufflen(srb)) {
532 desc->context.data = NULL;
533 desc->context.data_length = 0;
534 return;
535 } else {
536 desc->context.curr_sg = scsi_sglist(srb);
537 desc->context.data = sg_virt(desc->context.curr_sg);
538 desc->context.data_length = desc->context.curr_sg->length;
539 }
540
541
542 /* can't rely on srb->sc_data_direction */
543
544 /* Brutally ripped from usb-storage */
545
546 if ( !memcmp( srb->cmnd, mts_read_image_sig, mts_read_image_sig_len )
547) { pipe = usb_rcvbulkpipe(desc->usb_dev,desc->ep_image);
548 MTS_DEBUG( "transferring from desc->ep_image == %d\n",
549 (int)desc->ep_image );
550 } else if ( MTS_DIRECTION_IS_IN(srb->cmnd[0]) ) {
551 pipe = usb_rcvbulkpipe(desc->usb_dev,desc->ep_response);
552 MTS_DEBUG( "transferring from desc->ep_response == %d\n",
553 (int)desc->ep_response);
554 } else {
555 MTS_DEBUG("transferring to desc->ep_out == %d\n",
556 (int)desc->ep_out);
557 pipe = usb_sndbulkpipe(desc->usb_dev,desc->ep_out);
558 }
559 desc->context.data_pipe = pipe;
560}
561
562static int mts_scsi_queuecommand_lck(struct scsi_cmnd *srb)
563{
564 mts_scsi_cmnd_callback callback = scsi_done;
565 struct mts_desc* desc = (struct mts_desc*)(srb->device->host->hostdata[0]);
566 int res;
567
568 MTS_DEBUG_GOT_HERE();
569 mts_show_command(srb);
570 mts_debug_dump(desc);
571
572 if ( srb->device->lun || srb->device->id || srb->device->channel ) {
573
574 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 );
575
576 MTS_DEBUG("this device doesn't exist\n");
577
578 set_host_byte(srb, DID_BAD_TARGET);
579
580 if(likely(callback != NULL))
581 callback(srb);
582
583 goto out;
584 }
585
586
587 usb_fill_bulk_urb(desc->urb,
588 desc->usb_dev,
589 usb_sndbulkpipe(desc->usb_dev,desc->ep_out),
590 srb->cmnd,
591 srb->cmd_len,
592 mts_command_done,
593 &desc->context
594 );
595
596
597 mts_build_transfer_context( srb, desc );
598 desc->context.final_callback = callback;
599
600 /* here we need ATOMIC as we are called with the iolock */
601 res=usb_submit_urb(desc->urb, GFP_ATOMIC);
602
603 if(unlikely(res)){
604 MTS_ERROR("error %d submitting URB\n",(int)res);
605 set_host_byte(srb, DID_ERROR);
606
607 if(likely(callback != NULL))
608 callback(srb);
609
610 }
611out:
612 return 0;
613}
614
615static DEF_SCSI_QCMD(mts_scsi_queuecommand)
616
617static const struct scsi_host_template mts_scsi_host_template = {
618 .module = THIS_MODULE,
619 .name = "microtekX6",
620 .proc_name = "microtekX6",
621 .queuecommand = mts_scsi_queuecommand,
622 .eh_abort_handler = mts_scsi_abort,
623 .eh_host_reset_handler = mts_scsi_host_reset,
624 .sg_tablesize = SG_ALL,
625 .can_queue = 1,
626 .this_id = -1,
627 .emulated = 1,
628 .dma_alignment = 511,
629 .slave_alloc = mts_slave_alloc,
630 .max_sectors= 256, /* 128 K */
631};
632
633/* The entries of microtek_table must correspond, line-by-line to
634 the entries of mts_supported_products[]. */
635
636static const struct usb_device_id mts_usb_ids[] =
637{
638 { USB_DEVICE(0x4ce, 0x0300) },
639 { USB_DEVICE(0x5da, 0x0094) },
640 { USB_DEVICE(0x5da, 0x0099) },
641 { USB_DEVICE(0x5da, 0x009a) },
642 { USB_DEVICE(0x5da, 0x00a0) },
643 { USB_DEVICE(0x5da, 0x00a3) },
644 { USB_DEVICE(0x5da, 0x80a3) },
645 { USB_DEVICE(0x5da, 0x80ac) },
646 { USB_DEVICE(0x5da, 0x00b6) },
647 { } /* Terminating entry */
648};
649
650MODULE_DEVICE_TABLE (usb, mts_usb_ids);
651
652
653static int mts_usb_probe(struct usb_interface *intf,
654 const struct usb_device_id *id)
655{
656 int i;
657 int ep_out = -1;
658 int ep_in_set[3]; /* this will break if we have more than three endpoints
659 which is why we check */
660 int *ep_in_current = ep_in_set;
661 int err_retval = -ENOMEM;
662
663 struct mts_desc * new_desc;
664 struct usb_device *dev = interface_to_usbdev (intf);
665
666 /* the current altsetting on the interface we're probing */
667 struct usb_host_interface *altsetting;
668
669 MTS_DEBUG_GOT_HERE();
670 MTS_DEBUG( "usb-device descriptor at %x\n", (int)dev );
671
672 MTS_DEBUG( "product id = 0x%x, vendor id = 0x%x\n",
673 le16_to_cpu(dev->descriptor.idProduct),
674 le16_to_cpu(dev->descriptor.idVendor) );
675
676 MTS_DEBUG_GOT_HERE();
677
678 /* the current altsetting on the interface we're probing */
679 altsetting = intf->cur_altsetting;
680
681
682 /* Check if the config is sane */
683
684 if ( altsetting->desc.bNumEndpoints != MTS_EP_TOTAL ) {
685 MTS_WARNING( "expecting %d got %d endpoints! Bailing out.\n",
686 (int)MTS_EP_TOTAL, (int)altsetting->desc.bNumEndpoints );
687 return -ENODEV;
688 }
689
690 for( i = 0; i < altsetting->desc.bNumEndpoints; i++ ) {
691 if ((altsetting->endpoint[i].desc.bmAttributes &
692 USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK) {
693
694 MTS_WARNING( "can only deal with bulk endpoints; endpoint %d is not bulk.\n",
695 (int)altsetting->endpoint[i].desc.bEndpointAddress );
696 } else {
697 if (altsetting->endpoint[i].desc.bEndpointAddress &
698 USB_DIR_IN)
699 *ep_in_current++
700 = altsetting->endpoint[i].desc.bEndpointAddress &
701 USB_ENDPOINT_NUMBER_MASK;
702 else {
703 if ( ep_out != -1 ) {
704 MTS_WARNING( "can only deal with one output endpoints. Bailing out." );
705 return -ENODEV;
706 }
707
708 ep_out = altsetting->endpoint[i].desc.bEndpointAddress &
709 USB_ENDPOINT_NUMBER_MASK;
710 }
711 }
712
713 }
714
715 if (ep_in_current != &ep_in_set[2]) {
716 MTS_WARNING("couldn't find two input bulk endpoints. Bailing out.\n");
717 return -ENODEV;
718 }
719
720 if ( ep_out == -1 ) {
721 MTS_WARNING( "couldn't find an output bulk endpoint. Bailing out.\n" );
722 return -ENODEV;
723 }
724
725
726 new_desc = kzalloc(sizeof(struct mts_desc), GFP_KERNEL);
727 if (!new_desc)
728 goto out;
729
730 new_desc->urb = usb_alloc_urb(0, GFP_KERNEL);
731 if (!new_desc->urb)
732 goto out_kfree;
733
734 new_desc->context.scsi_status = kmalloc(1, GFP_KERNEL);
735 if (!new_desc->context.scsi_status)
736 goto out_free_urb;
737
738 new_desc->usb_dev = dev;
739 new_desc->usb_intf = intf;
740
741 /* endpoints */
742 new_desc->ep_out = ep_out;
743 new_desc->ep_response = ep_in_set[0];
744 new_desc->ep_image = ep_in_set[1];
745
746 if ( new_desc->ep_out != MTS_EP_OUT )
747 MTS_WARNING( "will this work? Command EP is not usually %d\n",
748 (int)new_desc->ep_out );
749
750 if ( new_desc->ep_response != MTS_EP_RESPONSE )
751 MTS_WARNING( "will this work? Response EP is not usually %d\n",
752 (int)new_desc->ep_response );
753
754 if ( new_desc->ep_image != MTS_EP_IMAGE )
755 MTS_WARNING( "will this work? Image data EP is not usually %d\n",
756 (int)new_desc->ep_image );
757
758 new_desc->host = scsi_host_alloc(&mts_scsi_host_template,
759 sizeof(new_desc));
760 if (!new_desc->host)
761 goto out_kfree2;
762
763 new_desc->host->hostdata[0] = (unsigned long)new_desc;
764 if (scsi_add_host(new_desc->host, &dev->dev)) {
765 err_retval = -EIO;
766 goto out_host_put;
767 }
768 scsi_scan_host(new_desc->host);
769
770 usb_set_intfdata(intf, new_desc);
771 return 0;
772
773 out_host_put:
774 scsi_host_put(new_desc->host);
775 out_kfree2:
776 kfree(new_desc->context.scsi_status);
777 out_free_urb:
778 usb_free_urb(new_desc->urb);
779 out_kfree:
780 kfree(new_desc);
781 out:
782 return err_retval;
783}
784
785static void mts_usb_disconnect (struct usb_interface *intf)
786{
787 struct mts_desc *desc = usb_get_intfdata(intf);
788
789 usb_set_intfdata(intf, NULL);
790
791 usb_kill_urb(desc->urb);
792 scsi_remove_host(desc->host);
793
794 scsi_host_put(desc->host);
795 usb_free_urb(desc->urb);
796 kfree(desc->context.scsi_status);
797 kfree(desc);
798}
799
800module_usb_driver(mts_usb_driver);
801
802MODULE_AUTHOR( DRIVER_AUTHOR );
803MODULE_DESCRIPTION( DRIVER_DESC );
804MODULE_LICENSE("GPL");
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 <vii@penguinpowered.com>
5 * (C) Copyright 2000 Oliver Neukum <Oliver.Neukum@lrz.uni-muenchen.de>
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
123#include <linux/module.h>
124#include <linux/kernel.h>
125#include <linux/signal.h>
126#include <linux/errno.h>
127#include <linux/random.h>
128#include <linux/poll.h>
129#include <linux/slab.h>
130#include <linux/spinlock.h>
131#include <linux/usb.h>
132#include <linux/proc_fs.h>
133
134#include <linux/atomic.h>
135#include <linux/blkdev.h>
136#include "../../scsi/scsi.h"
137#include <scsi/scsi_host.h>
138
139#include "microtek.h"
140
141#define DRIVER_AUTHOR "John Fremlin <vii@penguinpowered.com>, Oliver Neukum <Oliver.Neukum@lrz.uni-muenchen.de>"
142#define DRIVER_DESC "Microtek Scanmaker X6 USB scanner driver"
143
144/* Should we do debugging? */
145
146//#define MTS_DO_DEBUG
147
148/* USB layer driver interface */
149
150static int mts_usb_probe(struct usb_interface *intf,
151 const struct usb_device_id *id);
152static void mts_usb_disconnect(struct usb_interface *intf);
153
154static const struct usb_device_id mts_usb_ids[];
155
156static struct usb_driver mts_usb_driver = {
157 .name = "microtekX6",
158 .probe = mts_usb_probe,
159 .disconnect = mts_usb_disconnect,
160 .id_table = mts_usb_ids,
161};
162
163
164/* Internal driver stuff */
165
166#define MTS_VERSION "0.4.3"
167#define MTS_NAME "microtek usb (rev " MTS_VERSION "): "
168
169#define MTS_WARNING(x...) \
170 printk( KERN_WARNING MTS_NAME x )
171#define MTS_ERROR(x...) \
172 printk( KERN_ERR MTS_NAME x )
173#define MTS_INT_ERROR(x...) \
174 MTS_ERROR(x)
175#define MTS_MESSAGE(x...) \
176 printk( KERN_INFO MTS_NAME x )
177
178#if defined MTS_DO_DEBUG
179
180#define MTS_DEBUG(x...) \
181 printk( KERN_DEBUG MTS_NAME x )
182
183#define MTS_DEBUG_GOT_HERE() \
184 MTS_DEBUG("got to %s:%d (%s)\n", __FILE__, (int)__LINE__, __func__ )
185#define MTS_DEBUG_INT() \
186 do { MTS_DEBUG_GOT_HERE(); \
187 MTS_DEBUG("transfer = 0x%x context = 0x%x\n",(int)transfer,(int)context ); \
188 MTS_DEBUG("status = 0x%x data-length = 0x%x sent = 0x%x\n",transfer->status,(int)context->data_length, (int)transfer->actual_length ); \
189 mts_debug_dump(context->instance);\
190 } while(0)
191#else
192
193#define MTS_NUL_STATEMENT do { } while(0)
194
195#define MTS_DEBUG(x...) MTS_NUL_STATEMENT
196#define MTS_DEBUG_GOT_HERE() MTS_NUL_STATEMENT
197#define MTS_DEBUG_INT() MTS_NUL_STATEMENT
198
199#endif
200
201
202
203#define MTS_INT_INIT()\
204 struct mts_transfer_context* context = (struct mts_transfer_context*)transfer->context; \
205 MTS_DEBUG_INT();\
206
207#ifdef MTS_DO_DEBUG
208
209static inline void mts_debug_dump(struct mts_desc* desc) {
210 MTS_DEBUG("desc at 0x%x: toggle = %02x%02x\n",
211 (int)desc,
212 (int)desc->usb_dev->toggle[1],(int)desc->usb_dev->toggle[0]
213 );
214 MTS_DEBUG("ep_out=%x ep_response=%x ep_image=%x\n",
215 usb_sndbulkpipe(desc->usb_dev,desc->ep_out),
216 usb_rcvbulkpipe(desc->usb_dev,desc->ep_response),
217 usb_rcvbulkpipe(desc->usb_dev,desc->ep_image)
218 );
219}
220
221
222static inline void mts_show_command(struct scsi_cmnd *srb)
223{
224 char *what = NULL;
225
226 switch (srb->cmnd[0]) {
227 case TEST_UNIT_READY: what = "TEST_UNIT_READY"; break;
228 case REZERO_UNIT: what = "REZERO_UNIT"; break;
229 case REQUEST_SENSE: what = "REQUEST_SENSE"; break;
230 case FORMAT_UNIT: what = "FORMAT_UNIT"; break;
231 case READ_BLOCK_LIMITS: what = "READ_BLOCK_LIMITS"; break;
232 case REASSIGN_BLOCKS: what = "REASSIGN_BLOCKS"; break;
233 case READ_6: what = "READ_6"; break;
234 case WRITE_6: what = "WRITE_6"; break;
235 case SEEK_6: what = "SEEK_6"; break;
236 case READ_REVERSE: what = "READ_REVERSE"; break;
237 case WRITE_FILEMARKS: what = "WRITE_FILEMARKS"; break;
238 case SPACE: what = "SPACE"; break;
239 case INQUIRY: what = "INQUIRY"; break;
240 case RECOVER_BUFFERED_DATA: what = "RECOVER_BUFFERED_DATA"; break;
241 case MODE_SELECT: what = "MODE_SELECT"; break;
242 case RESERVE: what = "RESERVE"; break;
243 case RELEASE: what = "RELEASE"; break;
244 case COPY: what = "COPY"; break;
245 case ERASE: what = "ERASE"; break;
246 case MODE_SENSE: what = "MODE_SENSE"; break;
247 case START_STOP: what = "START_STOP"; break;
248 case RECEIVE_DIAGNOSTIC: what = "RECEIVE_DIAGNOSTIC"; break;
249 case SEND_DIAGNOSTIC: what = "SEND_DIAGNOSTIC"; break;
250 case ALLOW_MEDIUM_REMOVAL: what = "ALLOW_MEDIUM_REMOVAL"; break;
251 case SET_WINDOW: what = "SET_WINDOW"; break;
252 case READ_CAPACITY: what = "READ_CAPACITY"; break;
253 case READ_10: what = "READ_10"; break;
254 case WRITE_10: what = "WRITE_10"; break;
255 case SEEK_10: what = "SEEK_10"; break;
256 case WRITE_VERIFY: what = "WRITE_VERIFY"; break;
257 case VERIFY: what = "VERIFY"; break;
258 case SEARCH_HIGH: what = "SEARCH_HIGH"; break;
259 case SEARCH_EQUAL: what = "SEARCH_EQUAL"; break;
260 case SEARCH_LOW: what = "SEARCH_LOW"; break;
261 case SET_LIMITS: what = "SET_LIMITS"; break;
262 case READ_POSITION: what = "READ_POSITION"; break;
263 case SYNCHRONIZE_CACHE: what = "SYNCHRONIZE_CACHE"; break;
264 case LOCK_UNLOCK_CACHE: what = "LOCK_UNLOCK_CACHE"; break;
265 case READ_DEFECT_DATA: what = "READ_DEFECT_DATA"; break;
266 case MEDIUM_SCAN: what = "MEDIUM_SCAN"; break;
267 case COMPARE: what = "COMPARE"; break;
268 case COPY_VERIFY: what = "COPY_VERIFY"; break;
269 case WRITE_BUFFER: what = "WRITE_BUFFER"; break;
270 case READ_BUFFER: what = "READ_BUFFER"; break;
271 case UPDATE_BLOCK: what = "UPDATE_BLOCK"; break;
272 case READ_LONG: what = "READ_LONG"; break;
273 case WRITE_LONG: what = "WRITE_LONG"; break;
274 case CHANGE_DEFINITION: what = "CHANGE_DEFINITION"; break;
275 case WRITE_SAME: what = "WRITE_SAME"; break;
276 case READ_TOC: what = "READ_TOC"; break;
277 case LOG_SELECT: what = "LOG_SELECT"; break;
278 case LOG_SENSE: what = "LOG_SENSE"; break;
279 case MODE_SELECT_10: what = "MODE_SELECT_10"; break;
280 case MODE_SENSE_10: what = "MODE_SENSE_10"; break;
281 case MOVE_MEDIUM: what = "MOVE_MEDIUM"; break;
282 case READ_12: what = "READ_12"; break;
283 case WRITE_12: what = "WRITE_12"; break;
284 case WRITE_VERIFY_12: what = "WRITE_VERIFY_12"; break;
285 case SEARCH_HIGH_12: what = "SEARCH_HIGH_12"; break;
286 case SEARCH_EQUAL_12: what = "SEARCH_EQUAL_12"; break;
287 case SEARCH_LOW_12: what = "SEARCH_LOW_12"; break;
288 case READ_ELEMENT_STATUS: what = "READ_ELEMENT_STATUS"; break;
289 case SEND_VOLUME_TAG: what = "SEND_VOLUME_TAG"; break;
290 case WRITE_LONG_2: what = "WRITE_LONG_2"; break;
291 default:
292 MTS_DEBUG("can't decode command\n");
293 goto out;
294 break;
295 }
296 MTS_DEBUG( "Command %s (%d bytes)\n", what, srb->cmd_len);
297
298 out:
299 MTS_DEBUG( " %10ph\n", srb->cmnd);
300}
301
302#else
303
304static inline void mts_show_command(struct scsi_cmnd * dummy)
305{
306}
307
308static inline void mts_debug_dump(struct mts_desc* dummy)
309{
310}
311
312#endif
313
314static inline void mts_urb_abort(struct mts_desc* desc) {
315 MTS_DEBUG_GOT_HERE();
316 mts_debug_dump(desc);
317
318 usb_kill_urb( desc->urb );
319}
320
321static int mts_slave_alloc (struct scsi_device *s)
322{
323 s->inquiry_len = 0x24;
324 return 0;
325}
326
327static int mts_slave_configure (struct scsi_device *s)
328{
329 blk_queue_dma_alignment(s->request_queue, (512 - 1));
330 return 0;
331}
332
333static int mts_scsi_abort(struct scsi_cmnd *srb)
334{
335 struct mts_desc* desc = (struct mts_desc*)(srb->device->host->hostdata[0]);
336
337 MTS_DEBUG_GOT_HERE();
338
339 mts_urb_abort(desc);
340
341 return FAILED;
342}
343
344static int mts_scsi_host_reset(struct scsi_cmnd *srb)
345{
346 struct mts_desc* desc = (struct mts_desc*)(srb->device->host->hostdata[0]);
347 int result;
348
349 MTS_DEBUG_GOT_HERE();
350 mts_debug_dump(desc);
351
352 result = usb_lock_device_for_reset(desc->usb_dev, desc->usb_intf);
353 if (result == 0) {
354 result = usb_reset_device(desc->usb_dev);
355 usb_unlock_device(desc->usb_dev);
356 }
357 return result ? FAILED : SUCCESS;
358}
359
360static int
361mts_scsi_queuecommand(struct Scsi_Host *shost, struct scsi_cmnd *srb);
362
363static void mts_transfer_cleanup( struct urb *transfer );
364static void mts_do_sg(struct urb * transfer);
365
366static inline
367void mts_int_submit_urb (struct urb* transfer,
368 int pipe,
369 void* data,
370 unsigned length,
371 usb_complete_t callback )
372/* Interrupt context! */
373
374/* Holding transfer->context->lock! */
375{
376 int res;
377
378 MTS_INT_INIT();
379
380 usb_fill_bulk_urb(transfer,
381 context->instance->usb_dev,
382 pipe,
383 data,
384 length,
385 callback,
386 context
387 );
388
389 res = usb_submit_urb( transfer, GFP_ATOMIC );
390 if ( unlikely(res) ) {
391 MTS_INT_ERROR( "could not submit URB! Error was %d\n",(int)res );
392 context->srb->result = DID_ERROR << 16;
393 mts_transfer_cleanup(transfer);
394 }
395}
396
397
398static void mts_transfer_cleanup( struct urb *transfer )
399/* Interrupt context! */
400{
401 MTS_INT_INIT();
402
403 if ( likely(context->final_callback != NULL) )
404 context->final_callback(context->srb);
405}
406
407static void mts_transfer_done( struct urb *transfer )
408{
409 MTS_INT_INIT();
410
411 context->srb->result &= MTS_SCSI_ERR_MASK;
412 context->srb->result |= (unsigned)(*context->scsi_status)<<1;
413
414 mts_transfer_cleanup(transfer);
415}
416
417
418static void mts_get_status( struct urb *transfer )
419/* Interrupt context! */
420{
421 MTS_INT_INIT();
422
423 mts_int_submit_urb(transfer,
424 usb_rcvbulkpipe(context->instance->usb_dev,
425 context->instance->ep_response),
426 context->scsi_status,
427 1,
428 mts_transfer_done );
429}
430
431static void mts_data_done( struct urb* transfer )
432/* Interrupt context! */
433{
434 int status = transfer->status;
435 MTS_INT_INIT();
436
437 if ( context->data_length != transfer->actual_length ) {
438 scsi_set_resid(context->srb, context->data_length -
439 transfer->actual_length);
440 } else if ( unlikely(status) ) {
441 context->srb->result = (status == -ENOENT ? DID_ABORT : DID_ERROR)<<16;
442 }
443
444 mts_get_status(transfer);
445}
446
447
448static void mts_command_done( struct urb *transfer )
449/* Interrupt context! */
450{
451 int status = transfer->status;
452 MTS_INT_INIT();
453
454 if ( unlikely(status) ) {
455 if (status == -ENOENT) {
456 /* We are being killed */
457 MTS_DEBUG_GOT_HERE();
458 context->srb->result = DID_ABORT<<16;
459 } else {
460 /* A genuine error has occurred */
461 MTS_DEBUG_GOT_HERE();
462
463 context->srb->result = DID_ERROR<<16;
464 }
465 mts_transfer_cleanup(transfer);
466
467 return;
468 }
469
470 if (context->srb->cmnd[0] == REQUEST_SENSE) {
471 mts_int_submit_urb(transfer,
472 context->data_pipe,
473 context->srb->sense_buffer,
474 context->data_length,
475 mts_data_done);
476 } else { if ( context->data ) {
477 mts_int_submit_urb(transfer,
478 context->data_pipe,
479 context->data,
480 context->data_length,
481 scsi_sg_count(context->srb) > 1 ?
482 mts_do_sg : mts_data_done);
483 } else {
484 mts_get_status(transfer);
485 }
486 }
487}
488
489static void mts_do_sg (struct urb* transfer)
490{
491 int status = transfer->status;
492 MTS_INT_INIT();
493
494 MTS_DEBUG("Processing fragment %d of %d\n", context->fragment,
495 scsi_sg_count(context->srb));
496
497 if (unlikely(status)) {
498 context->srb->result = (status == -ENOENT ? DID_ABORT : DID_ERROR)<<16;
499 mts_transfer_cleanup(transfer);
500 }
501
502 context->curr_sg = sg_next(context->curr_sg);
503 mts_int_submit_urb(transfer,
504 context->data_pipe,
505 sg_virt(context->curr_sg),
506 context->curr_sg->length,
507 sg_is_last(context->curr_sg) ?
508 mts_data_done : mts_do_sg);
509}
510
511static const u8 mts_read_image_sig[] = { 0x28, 00, 00, 00 };
512static const u8 mts_read_image_sig_len = 4;
513static const unsigned char mts_direction[256/8] = {
514 0x28, 0x81, 0x14, 0x14, 0x20, 0x01, 0x90, 0x77,
515 0x0C, 0x20, 0x00, 0x04, 0x00, 0x00, 0x00, 0x00,
516 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x01,
517 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
518};
519
520
521#define MTS_DIRECTION_IS_IN(x) ((mts_direction[x>>3] >> (x & 7)) & 1)
522
523static void
524mts_build_transfer_context(struct scsi_cmnd *srb, struct mts_desc* desc)
525{
526 int pipe;
527
528 MTS_DEBUG_GOT_HERE();
529
530 desc->context.instance = desc;
531 desc->context.srb = srb;
532
533 if (!scsi_bufflen(srb)) {
534 desc->context.data = NULL;
535 desc->context.data_length = 0;
536 return;
537 } else {
538 desc->context.curr_sg = scsi_sglist(srb);
539 desc->context.data = sg_virt(desc->context.curr_sg);
540 desc->context.data_length = desc->context.curr_sg->length;
541 }
542
543
544 /* can't rely on srb->sc_data_direction */
545
546 /* Brutally ripped from usb-storage */
547
548 if ( !memcmp( srb->cmnd, mts_read_image_sig, mts_read_image_sig_len )
549) { pipe = usb_rcvbulkpipe(desc->usb_dev,desc->ep_image);
550 MTS_DEBUG( "transferring from desc->ep_image == %d\n",
551 (int)desc->ep_image );
552 } else if ( MTS_DIRECTION_IS_IN(srb->cmnd[0]) ) {
553 pipe = usb_rcvbulkpipe(desc->usb_dev,desc->ep_response);
554 MTS_DEBUG( "transferring from desc->ep_response == %d\n",
555 (int)desc->ep_response);
556 } else {
557 MTS_DEBUG("transferring to desc->ep_out == %d\n",
558 (int)desc->ep_out);
559 pipe = usb_sndbulkpipe(desc->usb_dev,desc->ep_out);
560 }
561 desc->context.data_pipe = pipe;
562}
563
564
565static int
566mts_scsi_queuecommand_lck(struct scsi_cmnd *srb, mts_scsi_cmnd_callback callback)
567{
568 struct mts_desc* desc = (struct mts_desc*)(srb->device->host->hostdata[0]);
569 int err = 0;
570 int res;
571
572 MTS_DEBUG_GOT_HERE();
573 mts_show_command(srb);
574 mts_debug_dump(desc);
575
576 if ( srb->device->lun || srb->device->id || srb->device->channel ) {
577
578 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 );
579
580 MTS_DEBUG("this device doesn't exist\n");
581
582 srb->result = DID_BAD_TARGET << 16;
583
584 if(likely(callback != NULL))
585 callback(srb);
586
587 goto out;
588 }
589
590
591 usb_fill_bulk_urb(desc->urb,
592 desc->usb_dev,
593 usb_sndbulkpipe(desc->usb_dev,desc->ep_out),
594 srb->cmnd,
595 srb->cmd_len,
596 mts_command_done,
597 &desc->context
598 );
599
600
601 mts_build_transfer_context( srb, desc );
602 desc->context.final_callback = callback;
603
604 /* here we need ATOMIC as we are called with the iolock */
605 res=usb_submit_urb(desc->urb, GFP_ATOMIC);
606
607 if(unlikely(res)){
608 MTS_ERROR("error %d submitting URB\n",(int)res);
609 srb->result = DID_ERROR << 16;
610
611 if(likely(callback != NULL))
612 callback(srb);
613
614 }
615out:
616 return err;
617}
618
619static DEF_SCSI_QCMD(mts_scsi_queuecommand)
620
621static struct scsi_host_template mts_scsi_host_template = {
622 .module = THIS_MODULE,
623 .name = "microtekX6",
624 .proc_name = "microtekX6",
625 .queuecommand = mts_scsi_queuecommand,
626 .eh_abort_handler = mts_scsi_abort,
627 .eh_host_reset_handler = mts_scsi_host_reset,
628 .sg_tablesize = SG_ALL,
629 .can_queue = 1,
630 .this_id = -1,
631 .emulated = 1,
632 .slave_alloc = mts_slave_alloc,
633 .slave_configure = mts_slave_configure,
634 .max_sectors= 256, /* 128 K */
635};
636
637/* The entries of microtek_table must correspond, line-by-line to
638 the entries of mts_supported_products[]. */
639
640static const struct usb_device_id mts_usb_ids[] =
641{
642 { USB_DEVICE(0x4ce, 0x0300) },
643 { USB_DEVICE(0x5da, 0x0094) },
644 { USB_DEVICE(0x5da, 0x0099) },
645 { USB_DEVICE(0x5da, 0x009a) },
646 { USB_DEVICE(0x5da, 0x00a0) },
647 { USB_DEVICE(0x5da, 0x00a3) },
648 { USB_DEVICE(0x5da, 0x80a3) },
649 { USB_DEVICE(0x5da, 0x80ac) },
650 { USB_DEVICE(0x5da, 0x00b6) },
651 { } /* Terminating entry */
652};
653
654MODULE_DEVICE_TABLE (usb, mts_usb_ids);
655
656
657static int mts_usb_probe(struct usb_interface *intf,
658 const struct usb_device_id *id)
659{
660 int i;
661 int ep_out = -1;
662 int ep_in_set[3]; /* this will break if we have more than three endpoints
663 which is why we check */
664 int *ep_in_current = ep_in_set;
665 int err_retval = -ENOMEM;
666
667 struct mts_desc * new_desc;
668 struct usb_device *dev = interface_to_usbdev (intf);
669
670 /* the current altsetting on the interface we're probing */
671 struct usb_host_interface *altsetting;
672
673 MTS_DEBUG_GOT_HERE();
674 MTS_DEBUG( "usb-device descriptor at %x\n", (int)dev );
675
676 MTS_DEBUG( "product id = 0x%x, vendor id = 0x%x\n",
677 le16_to_cpu(dev->descriptor.idProduct),
678 le16_to_cpu(dev->descriptor.idVendor) );
679
680 MTS_DEBUG_GOT_HERE();
681
682 /* the current altsetting on the interface we're probing */
683 altsetting = intf->cur_altsetting;
684
685
686 /* Check if the config is sane */
687
688 if ( altsetting->desc.bNumEndpoints != MTS_EP_TOTAL ) {
689 MTS_WARNING( "expecting %d got %d endpoints! Bailing out.\n",
690 (int)MTS_EP_TOTAL, (int)altsetting->desc.bNumEndpoints );
691 return -ENODEV;
692 }
693
694 for( i = 0; i < altsetting->desc.bNumEndpoints; i++ ) {
695 if ((altsetting->endpoint[i].desc.bmAttributes &
696 USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK) {
697
698 MTS_WARNING( "can only deal with bulk endpoints; endpoint %d is not bulk.\n",
699 (int)altsetting->endpoint[i].desc.bEndpointAddress );
700 } else {
701 if (altsetting->endpoint[i].desc.bEndpointAddress &
702 USB_DIR_IN)
703 *ep_in_current++
704 = altsetting->endpoint[i].desc.bEndpointAddress &
705 USB_ENDPOINT_NUMBER_MASK;
706 else {
707 if ( ep_out != -1 ) {
708 MTS_WARNING( "can only deal with one output endpoints. Bailing out." );
709 return -ENODEV;
710 }
711
712 ep_out = altsetting->endpoint[i].desc.bEndpointAddress &
713 USB_ENDPOINT_NUMBER_MASK;
714 }
715 }
716
717 }
718
719 if (ep_in_current != &ep_in_set[2]) {
720 MTS_WARNING("couldn't find two input bulk endpoints. Bailing out.\n");
721 return -ENODEV;
722 }
723
724 if ( ep_out == -1 ) {
725 MTS_WARNING( "couldn't find an output bulk endpoint. Bailing out.\n" );
726 return -ENODEV;
727 }
728
729
730 new_desc = kzalloc(sizeof(struct mts_desc), GFP_KERNEL);
731 if (!new_desc)
732 goto out;
733
734 new_desc->urb = usb_alloc_urb(0, GFP_KERNEL);
735 if (!new_desc->urb)
736 goto out_kfree;
737
738 new_desc->context.scsi_status = kmalloc(1, GFP_KERNEL);
739 if (!new_desc->context.scsi_status)
740 goto out_free_urb;
741
742 new_desc->usb_dev = dev;
743 new_desc->usb_intf = intf;
744
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)
765 goto out_kfree2;
766
767 new_desc->host->hostdata[0] = (unsigned long)new_desc;
768 if (scsi_add_host(new_desc->host, &dev->dev)) {
769 err_retval = -EIO;
770 goto out_host_put;
771 }
772 scsi_scan_host(new_desc->host);
773
774 usb_set_intfdata(intf, new_desc);
775 return 0;
776
777 out_host_put:
778 scsi_host_put(new_desc->host);
779 out_kfree2:
780 kfree(new_desc->context.scsi_status);
781 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);
800 kfree(desc->context.scsi_status);
801 kfree(desc);
802}
803
804module_usb_driver(mts_usb_driver);
805
806MODULE_AUTHOR( DRIVER_AUTHOR );
807MODULE_DESCRIPTION( DRIVER_DESC );
808MODULE_LICENSE("GPL");