1 /* Driver for Microtek Scanmaker X6 USB scanner, and possibly others. 2 * 3 * (C) Copyright 2000 John Fremlin <vii@penguinpowered.com> 4 * (C) Copyright 2000 Oliver Neukum <Oliver.Neukum@lrz.uni-muenchen.de> 5 * 6 * Parts shamelessly stolen from usb-storage and copyright by their 7 * authors. Thanks to Matt Dharm for giving us permission! 8 * 9 * This driver implements a SCSI host controller driver and a USB 10 * device driver. To avoid confusion, all the USB related stuff is 11 * prefixed by mts_usb_ and all the SCSI stuff by mts_scsi_. 12 * 13 * Microtek (www.microtek.com) did not release the specifications for 14 * their USB protocol to us, so we had to reverse engineer them. We 15 * don't know for which models they are valid. 16 * 17 * The X6 USB has three bulk endpoints, one output (0x1) down which 18 * commands and outgoing data are sent, and two input: 0x82 from which 19 * normal data is read from the scanner (in packets of maximum 32 20 * bytes) and from which the status byte is read, and 0x83 from which 21 * the results of a scan (or preview) are read in up to 64 * 1024 byte 22 * chunks by the Windows driver. We don't know how much it is possible 23 * to read at a time from 0x83. 24 * 25 * It seems possible to read (with URB transfers) everything from 0x82 26 * in one go, without bothering to read in 32 byte chunks. 27 * 28 * There seems to be an optimisation of a further READ implicit if 29 * you simply read from 0x83. 30 * 31 * Guessed protocol: 32 * 33 * Send raw SCSI command to EP 0x1 34 * 35 * If there is data to receive: 36 * If the command was READ datatype=image: 37 * Read a lot of data from EP 0x83 38 * Else: 39 * Read data from EP 0x82 40 * Else: 41 * If there is data to transmit: 42 * Write it to EP 0x1 43 * 44 * Read status byte from EP 0x82 45 * 46 * References: 47 * 48 * The SCSI command set for the scanner is available from 49 * ftp://ftp.microtek.com/microtek/devpack/ 50 * 51 * Microtek NV sent us a more up to date version of the document. If 52 * you want it, just send mail. 53 * 54 * Status: 55 * 56 * Untested with multiple scanners. 57 * Untested on SMP. 58 * Untested on a bigendian machine. 59 * 60 * History: 61 * 62 * 20000417 starting history 63 * 20000417 fixed load oops 64 * 20000417 fixed unload oops 65 * 20000419 fixed READ IMAGE detection 66 * 20000424 started conversion to use URBs 67 * 20000502 handled short transfers as errors 68 * 20000513 rename and organisation of functions (john) 69 * 20000513 added IDs for all products supported by Windows driver (john) 70 * 20000514 Rewrote mts_scsi_queuecommand to use URBs (john) 71 * 20000514 Version 0.0.8j 72 * 20000514 Fix reporting of non-existant 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/sched.h> 125 #include <linux/signal.h> 126 #include <linux/errno.h> 127 #include <linux/random.h> 128 #include <linux/poll.h> 129 #include <linux/init.h> 130 #include <linux/slab.h> 131 #include <linux/spinlock.h> 132 #include <linux/smp_lock.h> 133 #include <linux/usb.h> 134 #include <linux/proc_fs.h> 135 136 #include <asm/atomic.h> 137 #include <linux/blkdev.h> 138 #include "../../scsi/scsi.h" 139 #include <scsi/scsi_host.h> 140 141 #include "microtek.h" 142 143 /* 144 * Version Information 145 */ 146 #define DRIVER_VERSION "v0.4.3" 147 #define DRIVER_AUTHOR "John Fremlin <vii@penguinpowered.com>, Oliver Neukum <Oliver.Neukum@lrz.uni-muenchen.de>" 148 #define DRIVER_DESC "Microtek Scanmaker X6 USB scanner driver" 149 150 /* Should we do debugging? */ 151 152 //#define MTS_DO_DEBUG 153 154 /* USB layer driver interface */ 155 156 static int mts_usb_probe(struct usb_interface *intf, 157 const struct usb_device_id *id); 158 static void mts_usb_disconnect(struct usb_interface *intf); 159 160 static struct usb_device_id mts_usb_ids []; 161 162 static struct usb_driver mts_usb_driver = { 163 .owner = THIS_MODULE, 164 .name = "microtekX6", 165 .probe = mts_usb_probe, 166 .disconnect = mts_usb_disconnect, 167 .id_table = mts_usb_ids, 168 }; 169 170 171 /* Internal driver stuff */ 172 173 #define MTS_VERSION "0.4.3" 174 #define MTS_NAME "microtek usb (rev " MTS_VERSION "): " 175 176 #define MTS_WARNING(x...) \ 177 printk( KERN_WARNING MTS_NAME x ) 178 #define MTS_ERROR(x...) \ 179 printk( KERN_ERR MTS_NAME x ) 180 #define MTS_INT_ERROR(x...) \ 181 MTS_ERROR(x) 182 #define MTS_MESSAGE(x...) \ 183 printk( KERN_INFO MTS_NAME x ) 184 185 #if defined MTS_DO_DEBUG 186 187 #define MTS_DEBUG(x...) \ 188 printk( KERN_DEBUG MTS_NAME x ) 189 190 #define MTS_DEBUG_GOT_HERE() \ 191 MTS_DEBUG("got to %s:%d (%s)\n", __FILE__, (int)__LINE__, __PRETTY_FUNCTION__ ) 192 #define MTS_DEBUG_INT() \ 193 do { MTS_DEBUG_GOT_HERE(); \ 194 MTS_DEBUG("transfer = 0x%x context = 0x%x\n",(int)transfer,(int)context ); \ 195 MTS_DEBUG("status = 0x%x data-length = 0x%x sent = 0x%x\n",(int)transfer->status,(int)context->data_length, (int)transfer->actual_length ); \ 196 mts_debug_dump(context->instance);\ 197 } while(0) 198 #else 199 200 #define MTS_NUL_STATEMENT do { } while(0) 201 202 #define MTS_DEBUG(x...) MTS_NUL_STATEMENT 203 #define MTS_DEBUG_GOT_HERE() MTS_NUL_STATEMENT 204 #define MTS_DEBUG_INT() MTS_NUL_STATEMENT 205 206 #endif 207 208 209 210 #define MTS_INT_INIT()\ 211 struct mts_transfer_context* context = (struct mts_transfer_context*)transfer->context; \ 212 MTS_DEBUG_INT();\ 213 214 #ifdef MTS_DO_DEBUG 215 216 static inline void mts_debug_dump(struct mts_desc* desc) { 217 MTS_DEBUG("desc at 0x%x: toggle = %02x%02x\n", 218 (int)desc, 219 (int)desc->usb_dev->toggle[1],(int)desc->usb_dev->toggle[0] 220 ); 221 MTS_DEBUG("ep_out=%x ep_response=%x ep_image=%x\n", 222 usb_sndbulkpipe(desc->usb_dev,desc->ep_out), 223 usb_rcvbulkpipe(desc->usb_dev,desc->ep_response), 224 usb_rcvbulkpipe(desc->usb_dev,desc->ep_image) 225 ); 226 } 227 228 229 static inline void mts_show_command(Scsi_Cmnd *srb) 230 { 231 char *what = NULL; 232 233 switch (srb->cmnd[0]) { 234 case TEST_UNIT_READY: what = "TEST_UNIT_READY"; break; 235 case REZERO_UNIT: what = "REZERO_UNIT"; break; 236 case REQUEST_SENSE: what = "REQUEST_SENSE"; break; 237 case FORMAT_UNIT: what = "FORMAT_UNIT"; break; 238 case READ_BLOCK_LIMITS: what = "READ_BLOCK_LIMITS"; break; 239 case REASSIGN_BLOCKS: what = "REASSIGN_BLOCKS"; break; 240 case READ_6: what = "READ_6"; break; 241 case WRITE_6: what = "WRITE_6"; break; 242 case SEEK_6: what = "SEEK_6"; break; 243 case READ_REVERSE: what = "READ_REVERSE"; break; 244 case WRITE_FILEMARKS: what = "WRITE_FILEMARKS"; break; 245 case SPACE: what = "SPACE"; break; 246 case INQUIRY: what = "INQUIRY"; break; 247 case RECOVER_BUFFERED_DATA: what = "RECOVER_BUFFERED_DATA"; break; 248 case MODE_SELECT: what = "MODE_SELECT"; break; 249 case RESERVE: what = "RESERVE"; break; 250 case RELEASE: what = "RELEASE"; break; 251 case COPY: what = "COPY"; break; 252 case ERASE: what = "ERASE"; break; 253 case MODE_SENSE: what = "MODE_SENSE"; break; 254 case START_STOP: what = "START_STOP"; break; 255 case RECEIVE_DIAGNOSTIC: what = "RECEIVE_DIAGNOSTIC"; break; 256 case SEND_DIAGNOSTIC: what = "SEND_DIAGNOSTIC"; break; 257 case ALLOW_MEDIUM_REMOVAL: what = "ALLOW_MEDIUM_REMOVAL"; break; 258 case SET_WINDOW: what = "SET_WINDOW"; break; 259 case READ_CAPACITY: what = "READ_CAPACITY"; break; 260 case READ_10: what = "READ_10"; break; 261 case WRITE_10: what = "WRITE_10"; break; 262 case SEEK_10: what = "SEEK_10"; break; 263 case WRITE_VERIFY: what = "WRITE_VERIFY"; break; 264 case VERIFY: what = "VERIFY"; break; 265 case SEARCH_HIGH: what = "SEARCH_HIGH"; break; 266 case SEARCH_EQUAL: what = "SEARCH_EQUAL"; break; 267 case SEARCH_LOW: what = "SEARCH_LOW"; break; 268 case SET_LIMITS: what = "SET_LIMITS"; break; 269 case READ_POSITION: what = "READ_POSITION"; break; 270 case SYNCHRONIZE_CACHE: what = "SYNCHRONIZE_CACHE"; break; 271 case LOCK_UNLOCK_CACHE: what = "LOCK_UNLOCK_CACHE"; break; 272 case READ_DEFECT_DATA: what = "READ_DEFECT_DATA"; break; 273 case MEDIUM_SCAN: what = "MEDIUM_SCAN"; break; 274 case COMPARE: what = "COMPARE"; break; 275 case COPY_VERIFY: what = "COPY_VERIFY"; break; 276 case WRITE_BUFFER: what = "WRITE_BUFFER"; break; 277 case READ_BUFFER: what = "READ_BUFFER"; break; 278 case UPDATE_BLOCK: what = "UPDATE_BLOCK"; break; 279 case READ_LONG: what = "READ_LONG"; break; 280 case WRITE_LONG: what = "WRITE_LONG"; break; 281 case CHANGE_DEFINITION: what = "CHANGE_DEFINITION"; break; 282 case WRITE_SAME: what = "WRITE_SAME"; break; 283 case READ_TOC: what = "READ_TOC"; break; 284 case LOG_SELECT: what = "LOG_SELECT"; break; 285 case LOG_SENSE: what = "LOG_SENSE"; break; 286 case MODE_SELECT_10: what = "MODE_SELECT_10"; break; 287 case MODE_SENSE_10: what = "MODE_SENSE_10"; break; 288 case MOVE_MEDIUM: what = "MOVE_MEDIUM"; break; 289 case READ_12: what = "READ_12"; break; 290 case WRITE_12: what = "WRITE_12"; break; 291 case WRITE_VERIFY_12: what = "WRITE_VERIFY_12"; break; 292 case SEARCH_HIGH_12: what = "SEARCH_HIGH_12"; break; 293 case SEARCH_EQUAL_12: what = "SEARCH_EQUAL_12"; break; 294 case SEARCH_LOW_12: what = "SEARCH_LOW_12"; break; 295 case READ_ELEMENT_STATUS: what = "READ_ELEMENT_STATUS"; break; 296 case SEND_VOLUME_TAG: what = "SEND_VOLUME_TAG"; break; 297 case WRITE_LONG_2: what = "WRITE_LONG_2"; break; 298 default: 299 MTS_DEBUG("can't decode command\n"); 300 goto out; 301 break; 302 } 303 MTS_DEBUG( "Command %s (%d bytes)\n", what, srb->cmd_len); 304 305 out: 306 MTS_DEBUG( " %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x\n", 307 srb->cmnd[0], srb->cmnd[1], srb->cmnd[2], srb->cmnd[3], srb->cmnd[4], srb->cmnd[5], 308 srb->cmnd[6], srb->cmnd[7], srb->cmnd[8], srb->cmnd[9]); 309 } 310 311 #else 312 313 static inline void mts_show_command(Scsi_Cmnd * dummy) 314 { 315 } 316 317 static inline void mts_debug_dump(struct mts_desc* dummy) 318 { 319 } 320 321 #endif 322 323 static inline void mts_urb_abort(struct mts_desc* desc) { 324 MTS_DEBUG_GOT_HERE(); 325 mts_debug_dump(desc); 326 327 usb_kill_urb( desc->urb ); 328 } 329 330 static int mts_scsi_abort (Scsi_Cmnd *srb) 331 { 332 struct mts_desc* desc = (struct mts_desc*)(srb->device->host->hostdata[0]); 333 334 MTS_DEBUG_GOT_HERE(); 335 336 mts_urb_abort(desc); 337 338 return FAILED; 339 } 340 341 static int mts_scsi_host_reset (Scsi_Cmnd *srb) 342 { 343 struct mts_desc* desc = (struct mts_desc*)(srb->device->host->hostdata[0]); 344 int result, rc; 345 346 MTS_DEBUG_GOT_HERE(); 347 mts_debug_dump(desc); 348 349 rc = usb_lock_device_for_reset(desc->usb_dev, desc->usb_intf); 350 if (rc < 0) 351 return FAILED; 352 result = usb_reset_device(desc->usb_dev);; 353 if (rc) 354 usb_unlock_device(desc->usb_dev); 355 return result ? FAILED : SUCCESS; 356 } 357 358 static 359 int mts_scsi_queuecommand (Scsi_Cmnd *srb, mts_scsi_cmnd_callback callback ); 360 361 static void mts_transfer_cleanup( struct urb *transfer ); 362 static void mts_do_sg(struct urb * transfer, struct pt_regs *regs); 363 364 static inline 365 void 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 transfer->status = 0; 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 return; 396 } 397 398 399 static void mts_transfer_cleanup( struct urb *transfer ) 400 /* Interrupt context! */ 401 { 402 MTS_INT_INIT(); 403 404 if ( likely(context->final_callback != NULL) ) 405 context->final_callback(context->srb); 406 407 } 408 409 static void mts_transfer_done( struct urb *transfer, struct pt_regs *regs ) 410 { 411 MTS_INT_INIT(); 412 413 context->srb->result &= MTS_SCSI_ERR_MASK; 414 context->srb->result |= (unsigned)context->status<<1; 415 416 mts_transfer_cleanup(transfer); 417 418 return; 419 } 420 421 422 static void mts_get_status( struct urb *transfer ) 423 /* Interrupt context! */ 424 { 425 MTS_INT_INIT(); 426 427 mts_int_submit_urb(transfer, 428 usb_rcvbulkpipe(context->instance->usb_dev, 429 context->instance->ep_response), 430 &context->status, 431 1, 432 mts_transfer_done ); 433 } 434 435 static void mts_data_done( struct urb* transfer, struct pt_regs *regs ) 436 /* Interrupt context! */ 437 { 438 MTS_INT_INIT(); 439 440 if ( context->data_length != transfer->actual_length ) { 441 context->srb->resid = context->data_length - transfer->actual_length; 442 } else if ( unlikely(transfer->status) ) { 443 context->srb->result = (transfer->status == -ENOENT ? DID_ABORT : DID_ERROR)<<16; 444 } 445 446 mts_get_status(transfer); 447 448 return; 449 } 450 451 452 static void mts_command_done( struct urb *transfer, struct pt_regs *regs ) 453 /* Interrupt context! */ 454 { 455 MTS_INT_INIT(); 456 457 if ( unlikely(transfer->status) ) { 458 if (transfer->status == -ENOENT) { 459 /* We are being killed */ 460 MTS_DEBUG_GOT_HERE(); 461 context->srb->result = DID_ABORT<<16; 462 } else { 463 /* A genuine error has occurred */ 464 MTS_DEBUG_GOT_HERE(); 465 466 context->srb->result = DID_ERROR<<16; 467 } 468 mts_transfer_cleanup(transfer); 469 470 return; 471 } 472 473 if (context->srb->cmnd[0] == REQUEST_SENSE) { 474 mts_int_submit_urb(transfer, 475 context->data_pipe, 476 context->srb->sense_buffer, 477 context->data_length, 478 mts_data_done); 479 } else { if ( context->data ) { 480 mts_int_submit_urb(transfer, 481 context->data_pipe, 482 context->data, 483 context->data_length, 484 context->srb->use_sg ? mts_do_sg : mts_data_done); 485 } else { 486 mts_get_status(transfer); 487 } 488 } 489 490 return; 491 } 492 493 static void mts_do_sg (struct urb* transfer, struct pt_regs *regs) 494 { 495 struct scatterlist * sg; 496 MTS_INT_INIT(); 497 498 MTS_DEBUG("Processing fragment %d of %d\n", context->fragment,context->srb->use_sg); 499 500 if (unlikely(transfer->status)) { 501 context->srb->result = (transfer->status == -ENOENT ? DID_ABORT : DID_ERROR)<<16; 502 mts_transfer_cleanup(transfer); 503 } 504 505 sg = context->srb->buffer; 506 context->fragment++; 507 mts_int_submit_urb(transfer, 508 context->data_pipe, 509 page_address(sg[context->fragment].page) + 510 sg[context->fragment].offset, 511 sg[context->fragment].length, 512 context->fragment + 1 == context->srb->use_sg ? mts_data_done : mts_do_sg); 513 return; 514 } 515 516 static const u8 mts_read_image_sig[] = { 0x28, 00, 00, 00 }; 517 static const u8 mts_read_image_sig_len = 4; 518 static const unsigned char mts_direction[256/8] = { 519 0x28, 0x81, 0x14, 0x14, 0x20, 0x01, 0x90, 0x77, 520 0x0C, 0x20, 0x00, 0x04, 0x00, 0x00, 0x00, 0x00, 521 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x01, 522 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 523 }; 524 525 526 #define MTS_DIRECTION_IS_IN(x) ((mts_direction[x>>3] >> (x & 7)) & 1) 527 528 static void 529 mts_build_transfer_context( Scsi_Cmnd *srb, struct mts_desc* desc ) 530 { 531 int pipe; 532 struct scatterlist * sg; 533 534 MTS_DEBUG_GOT_HERE(); 535 536 desc->context.instance = desc; 537 desc->context.srb = srb; 538 desc->context.fragment = 0; 539 540 if (!srb->use_sg) { 541 if ( !srb->bufflen ){ 542 desc->context.data = NULL; 543 desc->context.data_length = 0; 544 return; 545 } else { 546 desc->context.data = srb->buffer; 547 desc->context.data_length = srb->bufflen; 548 MTS_DEBUG("length = %d or %d\n", 549 srb->request_bufflen, srb->bufflen); 550 } 551 } else { 552 MTS_DEBUG("Using scatter/gather\n"); 553 sg = srb->buffer; 554 desc->context.data = page_address(sg[0].page) + sg[0].offset; 555 desc->context.data_length = sg[0].length; 556 } 557 558 559 /* can't rely on srb->sc_data_direction */ 560 561 /* Brutally ripped from usb-storage */ 562 563 if ( !memcmp( srb->cmnd, mts_read_image_sig, mts_read_image_sig_len ) 564 ) { pipe = usb_rcvbulkpipe(desc->usb_dev,desc->ep_image); 565 MTS_DEBUG( "transfering from desc->ep_image == %d\n", 566 (int)desc->ep_image ); 567 } else if ( MTS_DIRECTION_IS_IN(srb->cmnd[0]) ) { 568 pipe = usb_rcvbulkpipe(desc->usb_dev,desc->ep_response); 569 MTS_DEBUG( "transfering from desc->ep_response == %d\n", 570 (int)desc->ep_response); 571 } else { 572 MTS_DEBUG("transfering to desc->ep_out == %d\n", 573 (int)desc->ep_out); 574 pipe = usb_sndbulkpipe(desc->usb_dev,desc->ep_out); 575 } 576 desc->context.data_pipe = pipe; 577 } 578 579 580 static 581 int mts_scsi_queuecommand( Scsi_Cmnd *srb, mts_scsi_cmnd_callback callback ) 582 { 583 struct mts_desc* desc = (struct mts_desc*)(srb->device->host->hostdata[0]); 584 int err = 0; 585 int res; 586 587 MTS_DEBUG_GOT_HERE(); 588 mts_show_command(srb); 589 mts_debug_dump(desc); 590 591 if ( srb->device->lun || srb->device->id || srb->device->channel ) { 592 593 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 ); 594 595 MTS_DEBUG("this device doesn't exist\n"); 596 597 srb->result = DID_BAD_TARGET << 16; 598 599 if(likely(callback != NULL)) 600 callback(srb); 601 602 goto out; 603 } 604 605 606 usb_fill_bulk_urb(desc->urb, 607 desc->usb_dev, 608 usb_sndbulkpipe(desc->usb_dev,desc->ep_out), 609 srb->cmnd, 610 srb->cmd_len, 611 mts_command_done, 612 &desc->context 613 ); 614 615 616 mts_build_transfer_context( srb, desc ); 617 desc->context.final_callback = callback; 618 619 /* here we need ATOMIC as we are called with the iolock */ 620 res=usb_submit_urb(desc->urb, GFP_ATOMIC); 621 622 if(unlikely(res)){ 623 MTS_ERROR("error %d submitting URB\n",(int)res); 624 srb->result = DID_ERROR << 16; 625 626 if(likely(callback != NULL)) 627 callback(srb); 628 629 } 630 631 out: 632 return err; 633 } 634 635 static Scsi_Host_Template mts_scsi_host_template = { 636 .module = THIS_MODULE, 637 .name = "microtekX6", 638 .proc_name = "microtekX6", 639 .queuecommand = mts_scsi_queuecommand, 640 .eh_abort_handler = mts_scsi_abort, 641 .eh_host_reset_handler = mts_scsi_host_reset, 642 .sg_tablesize = SG_ALL, 643 .can_queue = 1, 644 .this_id = -1, 645 .cmd_per_lun = 1, 646 .use_clustering = 1, 647 .emulated = 1, 648 }; 649 650 struct vendor_product 651 { 652 char* name; 653 enum 654 { 655 mts_sup_unknown=0, 656 mts_sup_alpha, 657 mts_sup_full 658 } 659 support_status; 660 } ; 661 662 663 /* These are taken from the msmUSB.inf file on the Windows driver CD */ 664 const static struct vendor_product mts_supported_products[] = 665 { 666 { "Phantom 336CX", mts_sup_unknown}, 667 { "Phantom 336CX", mts_sup_unknown}, 668 { "Scanmaker X6", mts_sup_alpha}, 669 { "Phantom C6", mts_sup_unknown}, 670 { "Phantom 336CX", mts_sup_unknown}, 671 { "ScanMaker V6USL", mts_sup_unknown}, 672 { "ScanMaker V6USL", mts_sup_unknown}, 673 { "Scanmaker V6UL", mts_sup_unknown}, 674 { "Scanmaker V6UPL", mts_sup_alpha}, 675 }; 676 677 /* The entries of microtek_table must correspond, line-by-line to 678 the entries of mts_supported_products[]. */ 679 680 static struct usb_device_id mts_usb_ids [] = 681 { 682 { USB_DEVICE(0x4ce, 0x0300) }, 683 { USB_DEVICE(0x5da, 0x0094) }, 684 { USB_DEVICE(0x5da, 0x0099) }, 685 { USB_DEVICE(0x5da, 0x009a) }, 686 { USB_DEVICE(0x5da, 0x00a0) }, 687 { USB_DEVICE(0x5da, 0x00a3) }, 688 { USB_DEVICE(0x5da, 0x80a3) }, 689 { USB_DEVICE(0x5da, 0x80ac) }, 690 { USB_DEVICE(0x5da, 0x00b6) }, 691 { } /* Terminating entry */ 692 }; 693 694 MODULE_DEVICE_TABLE (usb, mts_usb_ids); 695 696 697 static int mts_usb_probe(struct usb_interface *intf, 698 const struct usb_device_id *id) 699 { 700 int i; 701 int ep_out = -1; 702 int ep_in_set[3]; /* this will break if we have more than three endpoints 703 which is why we check */ 704 int *ep_in_current = ep_in_set; 705 int err_retval = -ENOMEM; 706 707 struct mts_desc * new_desc; 708 struct vendor_product const* p; 709 struct usb_device *dev = interface_to_usbdev (intf); 710 711 /* the current altsetting on the interface we're probing */ 712 struct usb_host_interface *altsetting; 713 714 MTS_DEBUG_GOT_HERE(); 715 MTS_DEBUG( "usb-device descriptor at %x\n", (int)dev ); 716 717 MTS_DEBUG( "product id = 0x%x, vendor id = 0x%x\n", 718 le16_to_cpu(dev->descriptor.idProduct), 719 le16_to_cpu(dev->descriptor.idVendor) ); 720 721 MTS_DEBUG_GOT_HERE(); 722 723 p = &mts_supported_products[id - mts_usb_ids]; 724 725 MTS_DEBUG_GOT_HERE(); 726 727 MTS_DEBUG( "found model %s\n", p->name ); 728 if ( p->support_status != mts_sup_full ) 729 MTS_MESSAGE( "model %s is not known to be fully supported, reports welcome!\n", 730 p->name ); 731 732 /* the current altsetting on the interface we're probing */ 733 altsetting = intf->cur_altsetting; 734 735 736 /* Check if the config is sane */ 737 738 if ( altsetting->desc.bNumEndpoints != MTS_EP_TOTAL ) { 739 MTS_WARNING( "expecting %d got %d endpoints! Bailing out.\n", 740 (int)MTS_EP_TOTAL, (int)altsetting->desc.bNumEndpoints ); 741 return -ENODEV; 742 } 743 744 for( i = 0; i < altsetting->desc.bNumEndpoints; i++ ) { 745 if ((altsetting->endpoint[i].desc.bmAttributes & 746 USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK) { 747 748 MTS_WARNING( "can only deal with bulk endpoints; endpoint %d is not bulk.\n", 749 (int)altsetting->endpoint[i].desc.bEndpointAddress ); 750 } else { 751 if (altsetting->endpoint[i].desc.bEndpointAddress & 752 USB_DIR_IN) 753 *ep_in_current++ 754 = altsetting->endpoint[i].desc.bEndpointAddress & 755 USB_ENDPOINT_NUMBER_MASK; 756 else { 757 if ( ep_out != -1 ) { 758 MTS_WARNING( "can only deal with one output endpoints. Bailing out." ); 759 return -ENODEV; 760 } 761 762 ep_out = altsetting->endpoint[i].desc.bEndpointAddress & 763 USB_ENDPOINT_NUMBER_MASK; 764 } 765 } 766 767 } 768 769 770 if ( ep_out == -1 ) { 771 MTS_WARNING( "couldn't find an output bulk endpoint. Bailing out.\n" ); 772 return -ENODEV; 773 } 774 775 776 new_desc = kmalloc(sizeof(struct mts_desc), GFP_KERNEL); 777 if (!new_desc) 778 goto out; 779 780 memset(new_desc, 0, sizeof(*new_desc)); 781 new_desc->urb = usb_alloc_urb(0, GFP_KERNEL); 782 if (!new_desc->urb) 783 goto out_kfree; 784 785 new_desc->usb_dev = dev; 786 new_desc->usb_intf = intf; 787 init_MUTEX(&new_desc->lock); 788 789 /* endpoints */ 790 new_desc->ep_out = ep_out; 791 new_desc->ep_response = ep_in_set[0]; 792 new_desc->ep_image = ep_in_set[1]; 793 794 if ( new_desc->ep_out != MTS_EP_OUT ) 795 MTS_WARNING( "will this work? Command EP is not usually %d\n", 796 (int)new_desc->ep_out ); 797 798 if ( new_desc->ep_response != MTS_EP_RESPONSE ) 799 MTS_WARNING( "will this work? Response EP is not usually %d\n", 800 (int)new_desc->ep_response ); 801 802 if ( new_desc->ep_image != MTS_EP_IMAGE ) 803 MTS_WARNING( "will this work? Image data EP is not usually %d\n", 804 (int)new_desc->ep_image ); 805 806 new_desc->host = scsi_host_alloc(&mts_scsi_host_template, 807 sizeof(new_desc)); 808 if (!new_desc->host) 809 goto out_free_urb; 810 811 new_desc->host->hostdata[0] = (unsigned long)new_desc; 812 if (scsi_add_host(new_desc->host, NULL)) { 813 err_retval = -EIO; 814 goto out_free_urb; 815 } 816 scsi_scan_host(new_desc->host); 817 818 usb_set_intfdata(intf, new_desc); 819 return 0; 820 821 out_free_urb: 822 usb_free_urb(new_desc->urb); 823 out_kfree: 824 kfree(new_desc); 825 out: 826 return err_retval; 827 } 828 829 static void mts_usb_disconnect (struct usb_interface *intf) 830 { 831 struct mts_desc *desc = usb_get_intfdata(intf); 832 833 usb_set_intfdata(intf, NULL); 834 835 usb_kill_urb(desc->urb); 836 scsi_remove_host(desc->host); 837 838 scsi_host_put(desc->host); 839 usb_free_urb(desc->urb); 840 kfree(desc); 841 } 842 843 844 static int __init microtek_drv_init(void) 845 { 846 return usb_register(&mts_usb_driver); 847 } 848 849 static void __exit microtek_drv_exit(void) 850 { 851 usb_deregister(&mts_usb_driver); 852 } 853 854 module_init(microtek_drv_init); 855 module_exit(microtek_drv_exit); 856 857 MODULE_AUTHOR( DRIVER_AUTHOR ); 858 MODULE_DESCRIPTION( DRIVER_DESC ); 859 MODULE_LICENSE("GPL"); 860 861 862