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