projects/linux·blob master · refs

769 lines · 22.1 KiB

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