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 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 <vii@penguinpowered.com>, Oliver Neukum <Oliver.Neukum@lrz.uni-muenchen.de>" 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 153 static int mts_usb_probe(struct usb_interface *intf, 154 const struct usb_device_id *id); 155 static void mts_usb_disconnect(struct usb_interface *intf); 156 157 static const struct usb_device_id mts_usb_ids[]; 158 159 static 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 #define MTS_WARNING(x...) \ 173 printk( KERN_WARNING MTS_NAME x ) 174 #define MTS_ERROR(x...) \ 175 printk( KERN_ERR MTS_NAME x ) 176 #define MTS_INT_ERROR(x...) \ 177 MTS_ERROR(x) 178 #define MTS_MESSAGE(x...) \ 179 printk( KERN_INFO MTS_NAME x ) 180 181 #if defined MTS_DO_DEBUG 182 183 #define MTS_DEBUG(x...) \ 184 printk( KERN_DEBUG MTS_NAME x ) 185 186 #define MTS_DEBUG_INT() \ 187 do { 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_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_dump(desc); 315 316 usb_kill_urb( desc->urb ); 317 } 318 319 static int mts_sdev_init (struct scsi_device *s) 320 { 321 s->inquiry_len = 0x24; 322 return 0; 323 } 324 325 static int mts_scsi_abort(struct scsi_cmnd *srb) 326 { 327 struct mts_desc* desc = (struct mts_desc*)(srb->device->host->hostdata[0]); 328 329 mts_urb_abort(desc); 330 331 return FAILED; 332 } 333 334 static int mts_scsi_host_reset(struct scsi_cmnd *srb) 335 { 336 struct mts_desc* desc = (struct mts_desc*)(srb->device->host->hostdata[0]); 337 int result; 338 339 mts_debug_dump(desc); 340 341 result = usb_lock_device_for_reset(desc->usb_dev, desc->usb_intf); 342 if (result == 0) { 343 result = usb_reset_device(desc->usb_dev); 344 usb_unlock_device(desc->usb_dev); 345 } 346 return result ? FAILED : SUCCESS; 347 } 348 349 static enum scsi_qc_status mts_scsi_queuecommand(struct Scsi_Host *shost, 350 struct scsi_cmnd *srb); 351 352 static void mts_transfer_cleanup( struct urb *transfer ); 353 static void mts_do_sg(struct urb * transfer); 354 355 static inline 356 void mts_int_submit_urb (struct urb* transfer, 357 int pipe, 358 void* data, 359 unsigned length, 360 usb_complete_t callback ) 361 /* Interrupt context! */ 362 363 /* Holding transfer->context->lock! */ 364 { 365 int res; 366 367 MTS_INT_INIT(); 368 369 usb_fill_bulk_urb(transfer, 370 context->instance->usb_dev, 371 pipe, 372 data, 373 length, 374 callback, 375 context 376 ); 377 378 res = usb_submit_urb( transfer, GFP_ATOMIC ); 379 if ( unlikely(res) ) { 380 MTS_INT_ERROR( "could not submit URB! Error was %d\n",(int)res ); 381 set_host_byte(context->srb, DID_ERROR); 382 mts_transfer_cleanup(transfer); 383 } 384 } 385 386 387 static void mts_transfer_cleanup( struct urb *transfer ) 388 /* Interrupt context! */ 389 { 390 MTS_INT_INIT(); 391 392 if ( likely(context->final_callback != NULL) ) 393 context->final_callback(context->srb); 394 } 395 396 static void mts_transfer_done( struct urb *transfer ) 397 { 398 MTS_INT_INIT(); 399 400 context->srb->result &= MTS_SCSI_ERR_MASK; 401 context->srb->result |= (unsigned)(*context->scsi_status)<<1; 402 403 mts_transfer_cleanup(transfer); 404 } 405 406 407 static void mts_get_status( struct urb *transfer ) 408 /* Interrupt context! */ 409 { 410 MTS_INT_INIT(); 411 412 mts_int_submit_urb(transfer, 413 usb_rcvbulkpipe(context->instance->usb_dev, 414 context->instance->ep_response), 415 context->scsi_status, 416 1, 417 mts_transfer_done ); 418 } 419 420 static void mts_data_done( struct urb* transfer ) 421 /* Interrupt context! */ 422 { 423 int status = transfer->status; 424 MTS_INT_INIT(); 425 426 if ( context->data_length != transfer->actual_length ) { 427 scsi_set_resid(context->srb, context->data_length - 428 transfer->actual_length); 429 } else if ( unlikely(status) ) { 430 set_host_byte(context->srb, (status == -ENOENT ? DID_ABORT : DID_ERROR)); 431 } 432 433 mts_get_status(transfer); 434 } 435 436 437 static void mts_command_done( struct urb *transfer ) 438 /* Interrupt context! */ 439 { 440 int status = transfer->status; 441 MTS_INT_INIT(); 442 443 if ( unlikely(status) ) { 444 if (status == -ENOENT) { 445 /* We are being killed */ 446 set_host_byte(context->srb, DID_ABORT); 447 } else { 448 /* A genuine error has occurred */ 449 set_host_byte(context->srb, DID_ERROR); 450 } 451 mts_transfer_cleanup(transfer); 452 453 return; 454 } 455 456 if (context->srb->cmnd[0] == REQUEST_SENSE) { 457 mts_int_submit_urb(transfer, 458 context->data_pipe, 459 context->srb->sense_buffer, 460 context->data_length, 461 mts_data_done); 462 } else { if ( context->data ) { 463 mts_int_submit_urb(transfer, 464 context->data_pipe, 465 context->data, 466 context->data_length, 467 scsi_sg_count(context->srb) > 1 ? 468 mts_do_sg : mts_data_done); 469 } else { 470 mts_get_status(transfer); 471 } 472 } 473 } 474 475 static void mts_do_sg (struct urb* transfer) 476 { 477 int status = transfer->status; 478 MTS_INT_INIT(); 479 480 MTS_DEBUG("Processing fragment %d of %d\n", context->fragment, 481 scsi_sg_count(context->srb)); 482 483 if (unlikely(status)) { 484 set_host_byte(context->srb, (status == -ENOENT ? DID_ABORT : DID_ERROR)); 485 mts_transfer_cleanup(transfer); 486 } 487 488 context->curr_sg = sg_next(context->curr_sg); 489 mts_int_submit_urb(transfer, 490 context->data_pipe, 491 sg_virt(context->curr_sg), 492 context->curr_sg->length, 493 sg_is_last(context->curr_sg) ? 494 mts_data_done : mts_do_sg); 495 } 496 497 static const u8 mts_read_image_sig[] = { 0x28, 00, 00, 00 }; 498 static const u8 mts_read_image_sig_len = 4; 499 static const unsigned char mts_direction[256/8] = { 500 0x28, 0x81, 0x14, 0x14, 0x20, 0x01, 0x90, 0x77, 501 0x0C, 0x20, 0x00, 0x04, 0x00, 0x00, 0x00, 0x00, 502 0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x01, 503 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00 504 }; 505 506 507 #define MTS_DIRECTION_IS_IN(x) ((mts_direction[x>>3] >> (x & 7)) & 1) 508 509 static void 510 mts_build_transfer_context(struct scsi_cmnd *srb, struct mts_desc* desc) 511 { 512 int pipe; 513 514 desc->context.instance = desc; 515 desc->context.srb = srb; 516 517 if (!scsi_bufflen(srb)) { 518 desc->context.data = NULL; 519 desc->context.data_length = 0; 520 return; 521 } else { 522 desc->context.curr_sg = scsi_sglist(srb); 523 desc->context.data = sg_virt(desc->context.curr_sg); 524 desc->context.data_length = desc->context.curr_sg->length; 525 } 526 527 528 /* can't rely on srb->sc_data_direction */ 529 530 /* Brutally ripped from usb-storage */ 531 532 if ( !memcmp( srb->cmnd, mts_read_image_sig, mts_read_image_sig_len ) 533 ) { pipe = usb_rcvbulkpipe(desc->usb_dev,desc->ep_image); 534 MTS_DEBUG( "transferring from desc->ep_image == %d\n", 535 (int)desc->ep_image ); 536 } else if ( MTS_DIRECTION_IS_IN(srb->cmnd[0]) ) { 537 pipe = usb_rcvbulkpipe(desc->usb_dev,desc->ep_response); 538 MTS_DEBUG( "transferring from desc->ep_response == %d\n", 539 (int)desc->ep_response); 540 } else { 541 MTS_DEBUG("transferring to desc->ep_out == %d\n", 542 (int)desc->ep_out); 543 pipe = usb_sndbulkpipe(desc->usb_dev,desc->ep_out); 544 } 545 desc->context.data_pipe = pipe; 546 } 547 548 static enum scsi_qc_status mts_scsi_queuecommand_lck(struct scsi_cmnd *srb) 549 { 550 mts_scsi_cmnd_callback callback = scsi_done; 551 struct mts_desc* desc = (struct mts_desc*)(srb->device->host->hostdata[0]); 552 int res; 553 554 mts_show_command(srb); 555 mts_debug_dump(desc); 556 557 if ( srb->device->lun || srb->device->id || srb->device->channel ) { 558 559 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 ); 560 561 MTS_DEBUG("this device doesn't exist\n"); 562 563 set_host_byte(srb, DID_BAD_TARGET); 564 565 if(likely(callback != NULL)) 566 callback(srb); 567 568 goto out; 569 } 570 571 572 usb_fill_bulk_urb(desc->urb, 573 desc->usb_dev, 574 usb_sndbulkpipe(desc->usb_dev,desc->ep_out), 575 srb->cmnd, 576 srb->cmd_len, 577 mts_command_done, 578 &desc->context 579 ); 580 581 582 mts_build_transfer_context( srb, desc ); 583 desc->context.final_callback = callback; 584 585 /* here we need ATOMIC as we are called with the iolock */ 586 res=usb_submit_urb(desc->urb, GFP_ATOMIC); 587 588 if(unlikely(res)){ 589 MTS_ERROR("error %d submitting URB\n",(int)res); 590 set_host_byte(srb, DID_ERROR); 591 592 if(likely(callback != NULL)) 593 callback(srb); 594 595 } 596 out: 597 return 0; 598 } 599 600 static DEF_SCSI_QCMD(mts_scsi_queuecommand) 601 602 static const struct scsi_host_template mts_scsi_host_template = { 603 .module = THIS_MODULE, 604 .name = "microtekX6", 605 .proc_name = "microtekX6", 606 .queuecommand = mts_scsi_queuecommand, 607 .eh_abort_handler = mts_scsi_abort, 608 .eh_host_reset_handler = mts_scsi_host_reset, 609 .sg_tablesize = SG_ALL, 610 .can_queue = 1, 611 .this_id = -1, 612 .emulated = 1, 613 .dma_alignment = 511, 614 .sdev_init = mts_sdev_init, 615 .max_sectors= 256, /* 128 K */ 616 }; 617 618 /* The entries of microtek_table must correspond, line-by-line to 619 the entries of mts_supported_products[]. */ 620 621 static const struct usb_device_id mts_usb_ids[] = 622 { 623 { USB_DEVICE(0x4ce, 0x0300) }, 624 { USB_DEVICE(0x5da, 0x0094) }, 625 { USB_DEVICE(0x5da, 0x0099) }, 626 { USB_DEVICE(0x5da, 0x009a) }, 627 { USB_DEVICE(0x5da, 0x00a0) }, 628 { USB_DEVICE(0x5da, 0x00a3) }, 629 { USB_DEVICE(0x5da, 0x80a3) }, 630 { USB_DEVICE(0x5da, 0x80ac) }, 631 { USB_DEVICE(0x5da, 0x00b6) }, 632 { } /* Terminating entry */ 633 }; 634 635 MODULE_DEVICE_TABLE (usb, mts_usb_ids); 636 637 638 static int mts_usb_probe(struct usb_interface *intf, 639 const struct usb_device_id *id) 640 { 641 int i; 642 int ep_out = -1; 643 int ep_in_set[3]; /* this will break if we have more than three endpoints 644 which is why we check */ 645 int *ep_in_current = ep_in_set; 646 int err_retval = -ENOMEM; 647 648 struct mts_desc * new_desc; 649 struct usb_device *dev = interface_to_usbdev (intf); 650 651 /* the current altsetting on the interface we're probing */ 652 struct usb_host_interface *altsetting; 653 654 MTS_DEBUG( "usb-device descriptor at %x\n", (int)dev ); 655 656 MTS_DEBUG( "product id = 0x%x, vendor id = 0x%x\n", 657 le16_to_cpu(dev->descriptor.idProduct), 658 le16_to_cpu(dev->descriptor.idVendor) ); 659 660 /* the current altsetting on the interface we're probing */ 661 altsetting = intf->cur_altsetting; 662 663 /* Check if the config is sane */ 664 665 if ( altsetting->desc.bNumEndpoints != MTS_EP_TOTAL ) { 666 MTS_WARNING( "expecting %d got %d endpoints! Bailing out.\n", 667 (int)MTS_EP_TOTAL, (int)altsetting->desc.bNumEndpoints ); 668 return -ENODEV; 669 } 670 671 for( i = 0; i < altsetting->desc.bNumEndpoints; i++ ) { 672 if (usb_endpoint_is_bulk_in(&altsetting->endpoint[i].desc)) { 673 *ep_in_current++ = usb_endpoint_num(&altsetting->endpoint[i].desc); 674 } else if (usb_endpoint_is_bulk_out(&altsetting->endpoint[i].desc)) { 675 if (ep_out == -1) { 676 ep_out = usb_endpoint_num(&altsetting->endpoint[i].desc); 677 } else { 678 MTS_WARNING( "can only deal with bulk endpoints; endpoint %d is not bulk.\n", 679 usb_endpoint_num(&altsetting->endpoint[i].desc)); 680 return -ENODEV; 681 } 682 } else { 683 MTS_WARNING( "can only deal with bulk endpoints; endpoint %d is not bulk.\n", 684 (int)altsetting->endpoint[i].desc.bEndpointAddress ); 685 } 686 } 687 688 if (ep_in_current != &ep_in_set[2]) { 689 MTS_WARNING("couldn't find two input bulk endpoints. Bailing out.\n"); 690 return -ENODEV; 691 } 692 693 if ( ep_out == -1 ) { 694 MTS_WARNING( "couldn't find an output bulk endpoint. Bailing out.\n" ); 695 return -ENODEV; 696 } 697 698 699 new_desc = kzalloc_obj(struct mts_desc); 700 if (!new_desc) 701 goto out; 702 703 new_desc->urb = usb_alloc_urb(0, GFP_KERNEL); 704 if (!new_desc->urb) 705 goto out_kfree; 706 707 new_desc->context.scsi_status = kmalloc(1, GFP_KERNEL); 708 if (!new_desc->context.scsi_status) 709 goto out_free_urb; 710 711 new_desc->usb_dev = dev; 712 new_desc->usb_intf = intf; 713 714 /* endpoints */ 715 new_desc->ep_out = ep_out; 716 new_desc->ep_response = ep_in_set[0]; 717 new_desc->ep_image = ep_in_set[1]; 718 719 if ( new_desc->ep_out != MTS_EP_OUT ) 720 MTS_WARNING( "will this work? Command EP is not usually %d\n", 721 (int)new_desc->ep_out ); 722 723 if ( new_desc->ep_response != MTS_EP_RESPONSE ) 724 MTS_WARNING( "will this work? Response EP is not usually %d\n", 725 (int)new_desc->ep_response ); 726 727 if ( new_desc->ep_image != MTS_EP_IMAGE ) 728 MTS_WARNING( "will this work? Image data EP is not usually %d\n", 729 (int)new_desc->ep_image ); 730 731 new_desc->host = scsi_host_alloc(&mts_scsi_host_template, 732 sizeof(new_desc)); 733 if (!new_desc->host) 734 goto out_kfree2; 735 736 new_desc->host->hostdata[0] = (unsigned long)new_desc; 737 if (scsi_add_host(new_desc->host, &dev->dev)) { 738 err_retval = -EIO; 739 goto out_host_put; 740 } 741 scsi_scan_host(new_desc->host); 742 743 usb_set_intfdata(intf, new_desc); 744 return 0; 745 746 out_host_put: 747 scsi_host_put(new_desc->host); 748 out_kfree2: 749 kfree(new_desc->context.scsi_status); 750 out_free_urb: 751 usb_free_urb(new_desc->urb); 752 out_kfree: 753 kfree(new_desc); 754 out: 755 return err_retval; 756 } 757 758 static void mts_usb_disconnect (struct usb_interface *intf) 759 { 760 struct mts_desc *desc = usb_get_intfdata(intf); 761 762 usb_set_intfdata(intf, NULL); 763 764 usb_kill_urb(desc->urb); 765 scsi_remove_host(desc->host); 766 767 scsi_host_put(desc->host); 768 usb_free_urb(desc->urb); 769 kfree(desc->context.scsi_status); 770 kfree(desc); 771 } 772 773 module_usb_driver(mts_usb_driver); 774 775 MODULE_AUTHOR( DRIVER_AUTHOR ); 776 MODULE_DESCRIPTION( DRIVER_DESC ); 777 MODULE_LICENSE("GPL"); 778