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