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