drivers/usb/image/microtek.c

   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_slave_alloc (struct scsi_device *s)
 331 {
 332         s->inquiry_len = 0x24;
 333         return 0;
 334 }
 335
 336 static int mts_slave_configure (struct scsi_device *s)
 337 {
 338         blk_queue_dma_alignment(s->request_queue, (512 - 1));
 339         return 0;
 340 }
 341
 342 static int mts_scsi_abort (Scsi_Cmnd *srb)
 343 {
 344         struct mts_desc* desc = (struct mts_desc*)(srb->device->host->hostdata[0]);
 345
 346         MTS_DEBUG_GOT_HERE();
 347
 348         mts_urb_abort(desc);
 349
 350         return FAILED;
 351 }
 352
 353 static int mts_scsi_host_reset (Scsi_Cmnd *srb)
 354 {
 355         struct mts_desc* desc = (struct mts_desc*)(srb->device->host->hostdata[0]);
 356         int result, rc;
 357
 358         MTS_DEBUG_GOT_HERE();
 359         mts_debug_dump(desc);
 360
 361         rc = usb_lock_device_for_reset(desc->usb_dev, desc->usb_intf);
 362         if (rc < 0)
 363                 return FAILED;
 364         result = usb_reset_device(desc->usb_dev);;
 365         if (rc)
 366                 usb_unlock_device(desc->usb_dev);
 367         return result ? FAILED : SUCCESS;
 368 }
 369
 370 static
 371 int mts_scsi_queuecommand (Scsi_Cmnd *srb, mts_scsi_cmnd_callback callback );
 372
 373 static void mts_transfer_cleanup( struct urb *transfer );
 374 static void mts_do_sg(struct urb * transfer, struct pt_regs *regs);
 375
 376 static inline
 377 void mts_int_submit_urb (struct urb* transfer,
 378                         int pipe,
 379                         void* data,
 380                         unsigned length,
 381                         usb_complete_t callback )
 382 /* Interrupt context! */
 383
 384 /* Holding transfer->context->lock! */
 385 {
 386         int res;
 387
 388         MTS_INT_INIT();
 389
 390         usb_fill_bulk_urb(transfer,
 391                       context->instance->usb_dev,
 392                       pipe,
 393                       data,
 394                       length,
 395                       callback,
 396                       context
 397                 );
 398
 399         transfer->status = 0;
 400
 401         res = usb_submit_urb( transfer, GFP_ATOMIC );
 402         if ( unlikely(res) ) {
 403                 MTS_INT_ERROR( "could not submit URB! Error was %d\n",(int)res );
 404                 context->srb->result = DID_ERROR << 16;
 405                 mts_transfer_cleanup(transfer);
 406         }
 407         return;
 408 }
 409
 410
 411 static void mts_transfer_cleanup( struct urb *transfer )
 412 /* Interrupt context! */
 413 {
 414         MTS_INT_INIT();
 415
 416         if ( likely(context->final_callback != NULL) )
 417                 context->final_callback(context->srb);
 418
 419 }
 420
 421 static void mts_transfer_done( struct urb *transfer, struct pt_regs *regs )
 422 {
 423         MTS_INT_INIT();
 424
 425         context->srb->result &= MTS_SCSI_ERR_MASK;
 426         context->srb->result |= (unsigned)(*context->scsi_status)<<1;
 427
 428         mts_transfer_cleanup(transfer);
 429
 430         return;
 431 }
 432
 433
 434 static void mts_get_status( struct urb *transfer )
 435 /* Interrupt context! */
 436 {
 437         MTS_INT_INIT();
 438
 439         mts_int_submit_urb(transfer,
 440                            usb_rcvbulkpipe(context->instance->usb_dev,
 441                                            context->instance->ep_response),
 442                            context->scsi_status,
 443                            1,
 444                            mts_transfer_done );
 445 }
 446
 447 static void mts_data_done( struct urb* transfer, struct pt_regs *regs )
 448 /* Interrupt context! */
 449 {
 450         MTS_INT_INIT();
 451
 452         if ( context->data_length != transfer->actual_length ) {
 453                 context->srb->resid = context->data_length - transfer->actual_length;
 454         } else if ( unlikely(transfer->status) ) {
 455                 context->srb->result = (transfer->status == -ENOENT ? DID_ABORT : DID_ERROR)<<16;
 456         }
 457
 458         mts_get_status(transfer);
 459
 460         return;
 461 }
 462
 463
 464 static void mts_command_done( struct urb *transfer, struct pt_regs *regs )
 465 /* Interrupt context! */
 466 {
 467         MTS_INT_INIT();
 468
 469         if ( unlikely(transfer->status) ) {
 470                 if (transfer->status == -ENOENT) {
 471                         /* We are being killed */
 472                         MTS_DEBUG_GOT_HERE();
 473                         context->srb->result = DID_ABORT<<16;
 474                 } else {
 475                         /* A genuine error has occurred */
 476                         MTS_DEBUG_GOT_HERE();
 477
 478                         context->srb->result = DID_ERROR<<16;
 479                 }
 480                 mts_transfer_cleanup(transfer);
 481
 482                 return;
 483         }
 484
 485         if (context->srb->cmnd[0] == REQUEST_SENSE) {
 486                 mts_int_submit_urb(transfer,
 487                                    context->data_pipe,
 488                                    context->srb->sense_buffer,
 489                                    context->data_length,
 490                                    mts_data_done);
 491         } else { if ( context->data ) {
 492                         mts_int_submit_urb(transfer,
 493                                            context->data_pipe,
 494                                            context->data,
 495                                            context->data_length,
 496                                            context->srb->use_sg > 1 ? mts_do_sg : mts_data_done);
 497                 } else {
 498                         mts_get_status(transfer);
 499                 }
 500         }
 501
 502         return;
 503 }
 504
 505 static void mts_do_sg (struct urb* transfer, struct pt_regs *regs)
 506 {
 507         struct scatterlist * sg;
 508         MTS_INT_INIT();
 509
 510         MTS_DEBUG("Processing fragment %d of %d\n", context->fragment,context->srb->use_sg);
 511
 512         if (unlikely(transfer->status)) {
 513                 context->srb->result = (transfer->status == -ENOENT ? DID_ABORT : DID_ERROR)<<16;
 514                 mts_transfer_cleanup(transfer);
 515         }
 516
 517         sg = context->srb->buffer;
 518         context->fragment++;
 519         mts_int_submit_urb(transfer,
 520                            context->data_pipe,
 521                            page_address(sg[context->fragment].page) +
 522                            sg[context->fragment].offset,
 523                            sg[context->fragment].length,
 524                            context->fragment + 1 == context->srb->use_sg ? mts_data_done : mts_do_sg);
 525         return;
 526 }
 527
 528 static const u8 mts_read_image_sig[] = { 0x28, 00, 00, 00 };
 529 static const u8 mts_read_image_sig_len = 4;
 530 static const unsigned char mts_direction[256/8] = {
 531         0x28, 0x81, 0x14, 0x14, 0x20, 0x01, 0x90, 0x77,
 532         0x0C, 0x20, 0x00, 0x04, 0x00, 0x00, 0x00, 0x00,
 533         0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x01,
 534         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
 535 };
 536
 537
 538 #define MTS_DIRECTION_IS_IN(x) ((mts_direction[x>>3] >> (x & 7)) & 1)
 539
 540 static void
 541 mts_build_transfer_context( Scsi_Cmnd *srb, struct mts_desc* desc )
 542 {
 543         int pipe;
 544         struct scatterlist * sg;
 545
 546         MTS_DEBUG_GOT_HERE();
 547
 548         desc->context.instance = desc;
 549         desc->context.srb = srb;
 550         desc->context.fragment = 0;
 551
 552         if (!srb->use_sg) {
 553                 if ( !srb->bufflen ){
 554                         desc->context.data = NULL;
 555                         desc->context.data_length = 0;
 556                         return;
 557                 } else {
 558                         desc->context.data = srb->buffer;
 559                         desc->context.data_length = srb->bufflen;
 560                         MTS_DEBUG("length = %d or %d\n",
 561                                   srb->request_bufflen, srb->bufflen);
 562                 }
 563         } else {
 564                 MTS_DEBUG("Using scatter/gather\n");
 565                 sg = srb->buffer;
 566                 desc->context.data = page_address(sg[0].page) + sg[0].offset;
 567                 desc->context.data_length = sg[0].length;
 568         }
 569
 570
 571         /* can't rely on srb->sc_data_direction */
 572
 573         /* Brutally ripped from usb-storage */
 574
 575         if ( !memcmp( srb->cmnd, mts_read_image_sig, mts_read_image_sig_len )
 576 ) {             pipe = usb_rcvbulkpipe(desc->usb_dev,desc->ep_image);
 577                 MTS_DEBUG( "transfering from desc->ep_image == %d\n",
 578                            (int)desc->ep_image );
 579         } else if ( MTS_DIRECTION_IS_IN(srb->cmnd[0]) ) {
 580                         pipe = usb_rcvbulkpipe(desc->usb_dev,desc->ep_response);
 581                         MTS_DEBUG( "transfering from desc->ep_response == %d\n",
 582                                    (int)desc->ep_response);
 583         } else {
 584                 MTS_DEBUG("transfering to desc->ep_out == %d\n",
 585                           (int)desc->ep_out);
 586                 pipe = usb_sndbulkpipe(desc->usb_dev,desc->ep_out);
 587         }
 588         desc->context.data_pipe = pipe;
 589 }
 590
 591
 592 static
 593 int mts_scsi_queuecommand( Scsi_Cmnd *srb, mts_scsi_cmnd_callback callback )
 594 {
 595         struct mts_desc* desc = (struct mts_desc*)(srb->device->host->hostdata[0]);
 596         int err = 0;
 597         int res;
 598
 599         MTS_DEBUG_GOT_HERE();
 600         mts_show_command(srb);
 601         mts_debug_dump(desc);
 602
 603         if ( srb->device->lun || srb->device->id || srb->device->channel ) {
 604
 605                 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 );
 606
 607                 MTS_DEBUG("this device doesn't exist\n");
 608
 609                 srb->result = DID_BAD_TARGET << 16;
 610
 611                 if(likely(callback != NULL))
 612                         callback(srb);
 613
 614                 goto out;
 615         }
 616
 617
 618         usb_fill_bulk_urb(desc->urb,
 619                       desc->usb_dev,
 620                       usb_sndbulkpipe(desc->usb_dev,desc->ep_out),
 621                       srb->cmnd,
 622                       srb->cmd_len,
 623                       mts_command_done,
 624                       &desc->context
 625                       );
 626
 627
 628         mts_build_transfer_context( srb, desc );
 629         desc->context.final_callback = callback;
 630
 631         /* here we need ATOMIC as we are called with the iolock */
 632         res=usb_submit_urb(desc->urb, GFP_ATOMIC);
 633
 634         if(unlikely(res)){
 635                 MTS_ERROR("error %d submitting URB\n",(int)res);
 636                 srb->result = DID_ERROR << 16;
 637
 638                 if(likely(callback != NULL))
 639                         callback(srb);
 640
 641         }
 642 out:
 643         return err;
 644 }
 645
 646 static struct scsi_host_template mts_scsi_host_template = {
 647         .module                 = THIS_MODULE,
 648         .name                   = "microtekX6",
 649         .proc_name              = "microtekX6",
 650         .queuecommand           = mts_scsi_queuecommand,
 651         .eh_abort_handler       = mts_scsi_abort,
 652         .eh_host_reset_handler  = mts_scsi_host_reset,
 653         .sg_tablesize =         SG_ALL,
 654         .can_queue =            1,
 655         .this_id =              -1,
 656         .cmd_per_lun =          1,
 657         .use_clustering =       1,
 658         .emulated =             1,
 659         .slave_alloc =          mts_slave_alloc,
 660         .slave_configure =      mts_slave_configure,
 661         .max_sectors=           256, /* 128 K */
 662 };
 663
 664 struct vendor_product
 665 {
 666         char* name;
 667         enum
 668         {
 669                 mts_sup_unknown=0,
 670                 mts_sup_alpha,
 671                 mts_sup_full
 672         }
 673         support_status;
 674 } ;
 675
 676
 677 /* These are taken from the msmUSB.inf file on the Windows driver CD */
 678 const static struct vendor_product mts_supported_products[] =
 679 {
 680         { "Phantom 336CX",      mts_sup_unknown},
 681         { "Phantom 336CX",      mts_sup_unknown},
 682         { "Scanmaker X6",       mts_sup_alpha},
 683         { "Phantom C6",         mts_sup_unknown},
 684         { "Phantom 336CX",      mts_sup_unknown},
 685         { "ScanMaker V6USL",    mts_sup_unknown},
 686         { "ScanMaker V6USL",    mts_sup_unknown},
 687         { "Scanmaker V6UL",     mts_sup_unknown},
 688         { "Scanmaker V6UPL",    mts_sup_alpha},
 689 };
 690
 691 /* The entries of microtek_table must correspond, line-by-line to
 692    the entries of mts_supported_products[]. */
 693
 694 static struct usb_device_id mts_usb_ids [] =
 695 {
 696         { USB_DEVICE(0x4ce, 0x0300) },
 697         { USB_DEVICE(0x5da, 0x0094) },
 698         { USB_DEVICE(0x5da, 0x0099) },
 699         { USB_DEVICE(0x5da, 0x009a) },
 700         { USB_DEVICE(0x5da, 0x00a0) },
 701         { USB_DEVICE(0x5da, 0x00a3) },
 702         { USB_DEVICE(0x5da, 0x80a3) },
 703         { USB_DEVICE(0x5da, 0x80ac) },
 704         { USB_DEVICE(0x5da, 0x00b6) },
 705         { }                                             /* Terminating entry */
 706 };
 707
 708 MODULE_DEVICE_TABLE (usb, mts_usb_ids);
 709
 710
 711 static int mts_usb_probe(struct usb_interface *intf,
 712                          const struct usb_device_id *id)
 713 {
 714         int i;
 715         int ep_out = -1;
 716         int ep_in_set[3]; /* this will break if we have more than three endpoints
 717                            which is why we check */
 718         int *ep_in_current = ep_in_set;
 719         int err_retval = -ENOMEM;
 720
 721         struct mts_desc * new_desc;
 722         struct vendor_product const* p;
 723         struct usb_device *dev = interface_to_usbdev (intf);
 724
 725         /* the current altsetting on the interface we're probing */
 726         struct usb_host_interface *altsetting;
 727
 728         MTS_DEBUG_GOT_HERE();
 729         MTS_DEBUG( "usb-device descriptor at %x\n", (int)dev );
 730
 731         MTS_DEBUG( "product id = 0x%x, vendor id = 0x%x\n",
 732                    le16_to_cpu(dev->descriptor.idProduct),
 733                    le16_to_cpu(dev->descriptor.idVendor) );
 734
 735         MTS_DEBUG_GOT_HERE();
 736
 737         p = &mts_supported_products[id - mts_usb_ids];
 738
 739         MTS_DEBUG_GOT_HERE();
 740
 741         MTS_DEBUG( "found model %s\n", p->name );
 742         if ( p->support_status != mts_sup_full )
 743                 MTS_MESSAGE( "model %s is not known to be fully supported, reports welcome!\n",
 744                              p->name );
 745
 746         /* the current altsetting on the interface we're probing */
 747         altsetting = intf->cur_altsetting;
 748
 749
 750         /* Check if the config is sane */
 751
 752         if ( altsetting->desc.bNumEndpoints != MTS_EP_TOTAL ) {
 753                 MTS_WARNING( "expecting %d got %d endpoints! Bailing out.\n",
 754                              (int)MTS_EP_TOTAL, (int)altsetting->desc.bNumEndpoints );
 755                 return -ENODEV;
 756         }
 757
 758         for( i = 0; i < altsetting->desc.bNumEndpoints; i++ ) {
 759                 if ((altsetting->endpoint[i].desc.bmAttributes &
 760                      USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK) {
 761
 762                         MTS_WARNING( "can only deal with bulk endpoints; endpoint %d is not bulk.\n",
 763                              (int)altsetting->endpoint[i].desc.bEndpointAddress );
 764                 } else {
 765                         if (altsetting->endpoint[i].desc.bEndpointAddress &
 766                             USB_DIR_IN)
 767                                 *ep_in_current++
 768                                         = altsetting->endpoint[i].desc.bEndpointAddress &
 769                                         USB_ENDPOINT_NUMBER_MASK;
 770                         else {
 771                                 if ( ep_out != -1 ) {
 772                                         MTS_WARNING( "can only deal with one output endpoints. Bailing out." );
 773                                         return -ENODEV;
 774                                 }
 775
 776                                 ep_out = altsetting->endpoint[i].desc.bEndpointAddress &
 777                                         USB_ENDPOINT_NUMBER_MASK;
 778                         }
 779                 }
 780
 781         }
 782
 783
 784         if ( ep_out == -1 ) {
 785                 MTS_WARNING( "couldn't find an output bulk endpoint. Bailing out.\n" );
 786                 return -ENODEV;
 787         }
 788
 789
 790         new_desc = kzalloc(sizeof(struct mts_desc), GFP_KERNEL);
 791         if (!new_desc)
 792                 goto out;
 793
 794         new_desc->urb = usb_alloc_urb(0, GFP_KERNEL);
 795         if (!new_desc->urb)
 796                 goto out_kfree;
 797
 798         new_desc->context.scsi_status = kmalloc(1, GFP_KERNEL);
 799         if (!new_desc->context.scsi_status)
 800                 goto out_kfree2;
 801
 802         new_desc->usb_dev = dev;
 803         new_desc->usb_intf = intf;
 804         init_MUTEX(&new_desc->lock);
 805
 806         /* endpoints */
 807         new_desc->ep_out = ep_out;
 808         new_desc->ep_response = ep_in_set[0];
 809         new_desc->ep_image = ep_in_set[1];
 810
 811         if ( new_desc->ep_out != MTS_EP_OUT )
 812                 MTS_WARNING( "will this work? Command EP is not usually %d\n",
 813                              (int)new_desc->ep_out );
 814
 815         if ( new_desc->ep_response != MTS_EP_RESPONSE )
 816                 MTS_WARNING( "will this work? Response EP is not usually %d\n",
 817                              (int)new_desc->ep_response );
 818
 819         if ( new_desc->ep_image != MTS_EP_IMAGE )
 820                 MTS_WARNING( "will this work? Image data EP is not usually %d\n",
 821                              (int)new_desc->ep_image );
 822
 823         new_desc->host = scsi_host_alloc(&mts_scsi_host_template,
 824                         sizeof(new_desc));
 825         if (!new_desc->host)
 826                 goto out_free_urb;
 827
 828         new_desc->host->hostdata[0] = (unsigned long)new_desc;
 829         if (scsi_add_host(new_desc->host, NULL)) {
 830                 err_retval = -EIO;
 831                 goto out_free_urb;
 832         }
 833         scsi_scan_host(new_desc->host);
 834
 835         usb_set_intfdata(intf, new_desc);
 836         return 0;
 837
 838  out_kfree2:
 839         kfree(new_desc->context.scsi_status);
 840  out_free_urb:
 841         usb_free_urb(new_desc->urb);
 842  out_kfree:
 843         kfree(new_desc);
 844  out:
 845         return err_retval;
 846 }
 847
 848 static void mts_usb_disconnect (struct usb_interface *intf)
 849 {
 850         struct mts_desc *desc = usb_get_intfdata(intf);
 851
 852         usb_set_intfdata(intf, NULL);
 853
 854         usb_kill_urb(desc->urb);
 855         scsi_remove_host(desc->host);
 856
 857         scsi_host_put(desc->host);
 858         usb_free_urb(desc->urb);
 859         kfree(desc->context.scsi_status);
 860         kfree(desc);
 861 }
 862
 863
 864 static int __init microtek_drv_init(void)
 865 {
 866         return usb_register(&mts_usb_driver);
 867 }
 868
 869 static void __exit microtek_drv_exit(void)
 870 {
 871         usb_deregister(&mts_usb_driver);
 872 }
 873
 874 module_init(microtek_drv_init);
 875 module_exit(microtek_drv_exit);
 876
 877 MODULE_AUTHOR( DRIVER_AUTHOR );
 878 MODULE_DESCRIPTION( DRIVER_DESC );
 879 MODULE_LICENSE("GPL");