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/signal.h>
 125 #include <linux/errno.h>
 126 #include <linux/random.h>
 127 #include <linux/poll.h>
 128 #include <linux/init.h>
 129 #include <linux/slab.h>
 130 #include <linux/spinlock.h>
 131 #include <linux/usb.h>
 132 #include <linux/proc_fs.h>
 133
 134 #include <asm/atomic.h>
 135 #include <linux/blkdev.h>
 136 #include "../../scsi/scsi.h"
 137 #include <scsi/scsi_host.h>
 138
 139 #include "microtek.h"
 140
 141 /*
 142  * Version Information
 143  */
 144 #define DRIVER_VERSION "v0.4.3"
 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 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_GOT_HERE() \
 188         MTS_DEBUG("got to %s:%d (%s)\n", __FILE__, (int)__LINE__, __PRETTY_FUNCTION__ )
 189 #define MTS_DEBUG_INT() \
 190         do { MTS_DEBUG_GOT_HERE(); \
 191              MTS_DEBUG("transfer = 0x%x context = 0x%x\n",(int)transfer,(int)context ); \
 192              MTS_DEBUG("status = 0x%x data-length = 0x%x sent = 0x%x\n",transfer->status,(int)context->data_length, (int)transfer->actual_length ); \
 193              mts_debug_dump(context->instance);\
 194            } while(0)
 195 #else
 196
 197 #define MTS_NUL_STATEMENT do { } while(0)
 198
 199 #define MTS_DEBUG(x...) MTS_NUL_STATEMENT
 200 #define MTS_DEBUG_GOT_HERE() MTS_NUL_STATEMENT
 201 #define MTS_DEBUG_INT() MTS_NUL_STATEMENT
 202
 203 #endif
 204
 205
 206
 207 #define MTS_INT_INIT()\
 208         struct mts_transfer_context* context = (struct mts_transfer_context*)transfer->context; \
 209         MTS_DEBUG_INT();\
 210
 211 #ifdef MTS_DO_DEBUG
 212
 213 static inline void mts_debug_dump(struct mts_desc* desc) {
 214         MTS_DEBUG("desc at 0x%x: toggle = %02x%02x\n",
 215                   (int)desc,
 216                   (int)desc->usb_dev->toggle[1],(int)desc->usb_dev->toggle[0]
 217                 );
 218         MTS_DEBUG("ep_out=%x ep_response=%x ep_image=%x\n",
 219                   usb_sndbulkpipe(desc->usb_dev,desc->ep_out),
 220                   usb_rcvbulkpipe(desc->usb_dev,desc->ep_response),
 221                   usb_rcvbulkpipe(desc->usb_dev,desc->ep_image)
 222                 );
 223 }
 224
 225
 226 static inline void mts_show_command(struct scsi_cmnd *srb)
 227 {
 228         char *what = NULL;
 229
 230         switch (srb->cmnd[0]) {
 231         case TEST_UNIT_READY: what = "TEST_UNIT_READY"; break;
 232         case REZERO_UNIT: what = "REZERO_UNIT"; break;
 233         case REQUEST_SENSE: what = "REQUEST_SENSE"; break;
 234         case FORMAT_UNIT: what = "FORMAT_UNIT"; break;
 235         case READ_BLOCK_LIMITS: what = "READ_BLOCK_LIMITS"; break;
 236         case REASSIGN_BLOCKS: what = "REASSIGN_BLOCKS"; break;
 237         case READ_6: what = "READ_6"; break;
 238         case WRITE_6: what = "WRITE_6"; break;
 239         case SEEK_6: what = "SEEK_6"; break;
 240         case READ_REVERSE: what = "READ_REVERSE"; break;
 241         case WRITE_FILEMARKS: what = "WRITE_FILEMARKS"; break;
 242         case SPACE: what = "SPACE"; break;
 243         case INQUIRY: what = "INQUIRY"; break;
 244         case RECOVER_BUFFERED_DATA: what = "RECOVER_BUFFERED_DATA"; break;
 245         case MODE_SELECT: what = "MODE_SELECT"; break;
 246         case RESERVE: what = "RESERVE"; break;
 247         case RELEASE: what = "RELEASE"; break;
 248         case COPY: what = "COPY"; break;
 249         case ERASE: what = "ERASE"; break;
 250         case MODE_SENSE: what = "MODE_SENSE"; break;
 251         case START_STOP: what = "START_STOP"; break;
 252         case RECEIVE_DIAGNOSTIC: what = "RECEIVE_DIAGNOSTIC"; break;
 253         case SEND_DIAGNOSTIC: what = "SEND_DIAGNOSTIC"; break;
 254         case ALLOW_MEDIUM_REMOVAL: what = "ALLOW_MEDIUM_REMOVAL"; break;
 255         case SET_WINDOW: what = "SET_WINDOW"; break;
 256         case READ_CAPACITY: what = "READ_CAPACITY"; break;
 257         case READ_10: what = "READ_10"; break;
 258         case WRITE_10: what = "WRITE_10"; break;
 259         case SEEK_10: what = "SEEK_10"; break;
 260         case WRITE_VERIFY: what = "WRITE_VERIFY"; break;
 261         case VERIFY: what = "VERIFY"; break;
 262         case SEARCH_HIGH: what = "SEARCH_HIGH"; break;
 263         case SEARCH_EQUAL: what = "SEARCH_EQUAL"; break;
 264         case SEARCH_LOW: what = "SEARCH_LOW"; break;
 265         case SET_LIMITS: what = "SET_LIMITS"; break;
 266         case READ_POSITION: what = "READ_POSITION"; break;
 267         case SYNCHRONIZE_CACHE: what = "SYNCHRONIZE_CACHE"; break;
 268         case LOCK_UNLOCK_CACHE: what = "LOCK_UNLOCK_CACHE"; break;
 269         case READ_DEFECT_DATA: what = "READ_DEFECT_DATA"; break;
 270         case MEDIUM_SCAN: what = "MEDIUM_SCAN"; break;
 271         case COMPARE: what = "COMPARE"; break;
 272         case COPY_VERIFY: what = "COPY_VERIFY"; break;
 273         case WRITE_BUFFER: what = "WRITE_BUFFER"; break;
 274         case READ_BUFFER: what = "READ_BUFFER"; break;
 275         case UPDATE_BLOCK: what = "UPDATE_BLOCK"; break;
 276         case READ_LONG: what = "READ_LONG"; break;
 277         case WRITE_LONG: what = "WRITE_LONG"; break;
 278         case CHANGE_DEFINITION: what = "CHANGE_DEFINITION"; break;
 279         case WRITE_SAME: what = "WRITE_SAME"; break;
 280         case READ_TOC: what = "READ_TOC"; break;
 281         case LOG_SELECT: what = "LOG_SELECT"; break;
 282         case LOG_SENSE: what = "LOG_SENSE"; break;
 283         case MODE_SELECT_10: what = "MODE_SELECT_10"; break;
 284         case MODE_SENSE_10: what = "MODE_SENSE_10"; break;
 285         case MOVE_MEDIUM: what = "MOVE_MEDIUM"; break;
 286         case READ_12: what = "READ_12"; break;
 287         case WRITE_12: what = "WRITE_12"; break;
 288         case WRITE_VERIFY_12: what = "WRITE_VERIFY_12"; break;
 289         case SEARCH_HIGH_12: what = "SEARCH_HIGH_12"; break;
 290         case SEARCH_EQUAL_12: what = "SEARCH_EQUAL_12"; break;
 291         case SEARCH_LOW_12: what = "SEARCH_LOW_12"; break;
 292         case READ_ELEMENT_STATUS: what = "READ_ELEMENT_STATUS"; break;
 293         case SEND_VOLUME_TAG: what = "SEND_VOLUME_TAG"; break;
 294         case WRITE_LONG_2: what = "WRITE_LONG_2"; break;
 295         default:
 296                 MTS_DEBUG("can't decode command\n");
 297                 goto out;
 298                 break;
 299         }
 300         MTS_DEBUG( "Command %s (%d bytes)\n", what, srb->cmd_len);
 301
 302  out:
 303         MTS_DEBUG( "  %02x %02x %02x %02x %02x %02x %02x %02x %02x %02x\n",
 304                srb->cmnd[0], srb->cmnd[1], srb->cmnd[2], srb->cmnd[3], srb->cmnd[4], srb->cmnd[5],
 305                srb->cmnd[6], srb->cmnd[7], srb->cmnd[8], srb->cmnd[9]);
 306 }
 307
 308 #else
 309
 310 static inline void mts_show_command(struct scsi_cmnd * dummy)
 311 {
 312 }
 313
 314 static inline void mts_debug_dump(struct mts_desc* dummy)
 315 {
 316 }
 317
 318 #endif
 319
 320 static inline void mts_urb_abort(struct mts_desc* desc) {
 321         MTS_DEBUG_GOT_HERE();
 322         mts_debug_dump(desc);
 323
 324         usb_kill_urb( desc->urb );
 325 }
 326
 327 static int mts_slave_alloc (struct scsi_device *s)
 328 {
 329         s->inquiry_len = 0x24;
 330         return 0;
 331 }
 332
 333 static int mts_slave_configure (struct scsi_device *s)
 334 {
 335         blk_queue_dma_alignment(s->request_queue, (512 - 1));
 336         return 0;
 337 }
 338
 339 static int mts_scsi_abort(struct scsi_cmnd *srb)
 340 {
 341         struct mts_desc* desc = (struct mts_desc*)(srb->device->host->hostdata[0]);
 342
 343         MTS_DEBUG_GOT_HERE();
 344
 345         mts_urb_abort(desc);
 346
 347         return FAILED;
 348 }
 349
 350 static int mts_scsi_host_reset(struct scsi_cmnd *srb)
 351 {
 352         struct mts_desc* desc = (struct mts_desc*)(srb->device->host->hostdata[0]);
 353         int result, rc;
 354
 355         MTS_DEBUG_GOT_HERE();
 356         mts_debug_dump(desc);
 357
 358         rc = usb_lock_device_for_reset(desc->usb_dev, desc->usb_intf);
 359         if (rc < 0)
 360                 return FAILED;
 361         result = usb_reset_device(desc->usb_dev);
 362         if (rc)
 363                 usb_unlock_device(desc->usb_dev);
 364         return result ? FAILED : SUCCESS;
 365 }
 366
 367 static int
 368 mts_scsi_queuecommand(struct scsi_cmnd *srb, mts_scsi_cmnd_callback callback);
 369
 370 static void mts_transfer_cleanup( struct urb *transfer );
 371 static void mts_do_sg(struct urb * transfer);
 372
 373 static inline
 374 void mts_int_submit_urb (struct urb* transfer,
 375                         int pipe,
 376                         void* data,
 377                         unsigned length,
 378                         usb_complete_t callback )
 379 /* Interrupt context! */
 380
 381 /* Holding transfer->context->lock! */
 382 {
 383         int res;
 384
 385         MTS_INT_INIT();
 386
 387         usb_fill_bulk_urb(transfer,
 388                       context->instance->usb_dev,
 389                       pipe,
 390                       data,
 391                       length,
 392                       callback,
 393                       context
 394                 );
 395
 396         res = usb_submit_urb( transfer, GFP_ATOMIC );
 397         if ( unlikely(res) ) {
 398                 MTS_INT_ERROR( "could not submit URB! Error was %d\n",(int)res );
 399                 context->srb->result = DID_ERROR << 16;
 400                 mts_transfer_cleanup(transfer);
 401         }
 402         return;
 403 }
 404
 405
 406 static void mts_transfer_cleanup( struct urb *transfer )
 407 /* Interrupt context! */
 408 {
 409         MTS_INT_INIT();
 410
 411         if ( likely(context->final_callback != NULL) )
 412                 context->final_callback(context->srb);
 413
 414 }
 415
 416 static void mts_transfer_done( struct urb *transfer )
 417 {
 418         MTS_INT_INIT();
 419
 420         context->srb->result &= MTS_SCSI_ERR_MASK;
 421         context->srb->result |= (unsigned)(*context->scsi_status)<<1;
 422
 423         mts_transfer_cleanup(transfer);
 424
 425         return;
 426 }
 427
 428
 429 static void mts_get_status( struct urb *transfer )
 430 /* Interrupt context! */
 431 {
 432         MTS_INT_INIT();
 433
 434         mts_int_submit_urb(transfer,
 435                            usb_rcvbulkpipe(context->instance->usb_dev,
 436                                            context->instance->ep_response),
 437                            context->scsi_status,
 438                            1,
 439                            mts_transfer_done );
 440 }
 441
 442 static void mts_data_done( struct urb* transfer )
 443 /* Interrupt context! */
 444 {
 445         int status = transfer->status;
 446         MTS_INT_INIT();
 447
 448         if ( context->data_length != transfer->actual_length ) {
 449                 context->srb->resid = context->data_length - transfer->actual_length;
 450         } else if ( unlikely(status) ) {
 451                 context->srb->result = (status == -ENOENT ? DID_ABORT : DID_ERROR)<<16;
 452         }
 453
 454         mts_get_status(transfer);
 455
 456         return;
 457 }
 458
 459
 460 static void mts_command_done( struct urb *transfer )
 461 /* Interrupt context! */
 462 {
 463         int status = transfer->status;
 464         MTS_INT_INIT();
 465
 466         if ( unlikely(status) ) {
 467                 if (status == -ENOENT) {
 468                         /* We are being killed */
 469                         MTS_DEBUG_GOT_HERE();
 470                         context->srb->result = DID_ABORT<<16;
 471                 } else {
 472                         /* A genuine error has occurred */
 473                         MTS_DEBUG_GOT_HERE();
 474
 475                         context->srb->result = DID_ERROR<<16;
 476                 }
 477                 mts_transfer_cleanup(transfer);
 478
 479                 return;
 480         }
 481
 482         if (context->srb->cmnd[0] == REQUEST_SENSE) {
 483                 mts_int_submit_urb(transfer,
 484                                    context->data_pipe,
 485                                    context->srb->sense_buffer,
 486                                    context->data_length,
 487                                    mts_data_done);
 488         } else { if ( context->data ) {
 489                         mts_int_submit_urb(transfer,
 490                                            context->data_pipe,
 491                                            context->data,
 492                                            context->data_length,
 493                                            context->srb->use_sg > 1 ? mts_do_sg : mts_data_done);
 494                 } else {
 495                         mts_get_status(transfer);
 496                 }
 497         }
 498
 499         return;
 500 }
 501
 502 static void mts_do_sg (struct urb* transfer)
 503 {
 504         struct scatterlist * sg;
 505         int status = transfer->status;
 506         MTS_INT_INIT();
 507
 508         MTS_DEBUG("Processing fragment %d of %d\n", context->fragment,context->srb->use_sg);
 509
 510         if (unlikely(status)) {
 511                 context->srb->result = (status == -ENOENT ? DID_ABORT : DID_ERROR)<<16;
 512                 mts_transfer_cleanup(transfer);
 513         }
 514
 515         sg = context->srb->request_buffer;
 516         context->fragment++;
 517         mts_int_submit_urb(transfer,
 518                            context->data_pipe,
 519                            page_address(sg[context->fragment].page) +
 520                            sg[context->fragment].offset,
 521                            sg[context->fragment].length,
 522                            context->fragment + 1 == context->srb->use_sg ? mts_data_done : mts_do_sg);
 523         return;
 524 }
 525
 526 static const u8 mts_read_image_sig[] = { 0x28, 00, 00, 00 };
 527 static const u8 mts_read_image_sig_len = 4;
 528 static const unsigned char mts_direction[256/8] = {
 529         0x28, 0x81, 0x14, 0x14, 0x20, 0x01, 0x90, 0x77,
 530         0x0C, 0x20, 0x00, 0x04, 0x00, 0x00, 0x00, 0x00,
 531         0x00, 0x00, 0x00, 0x00, 0x00, 0x01, 0x00, 0x01,
 532         0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
 533 };
 534
 535
 536 #define MTS_DIRECTION_IS_IN(x) ((mts_direction[x>>3] >> (x & 7)) & 1)
 537
 538 static void
 539 mts_build_transfer_context(struct scsi_cmnd *srb, struct mts_desc* desc)
 540 {
 541         int pipe;
 542         struct scatterlist * sg;
 543
 544         MTS_DEBUG_GOT_HERE();
 545
 546         desc->context.instance = desc;
 547         desc->context.srb = srb;
 548         desc->context.fragment = 0;
 549
 550         if (!srb->use_sg) {
 551                 if ( !srb->request_bufflen ){
 552                         desc->context.data = NULL;
 553                         desc->context.data_length = 0;
 554                         return;
 555                 } else {
 556                         desc->context.data = srb->request_buffer;
 557                         desc->context.data_length = srb->request_bufflen;
 558                         MTS_DEBUG("length = %d or %d\n",
 559                                   srb->request_bufflen, srb->bufflen);
 560                 }
 561         } else {
 562                 MTS_DEBUG("Using scatter/gather\n");
 563                 sg = srb->request_buffer;
 564                 desc->context.data = page_address(sg[0].page) + sg[0].offset;
 565                 desc->context.data_length = sg[0].length;
 566         }
 567
 568
 569         /* can't rely on srb->sc_data_direction */
 570
 571         /* Brutally ripped from usb-storage */
 572
 573         if ( !memcmp( srb->cmnd, mts_read_image_sig, mts_read_image_sig_len )
 574 ) {             pipe = usb_rcvbulkpipe(desc->usb_dev,desc->ep_image);
 575                 MTS_DEBUG( "transfering from desc->ep_image == %d\n",
 576                            (int)desc->ep_image );
 577         } else if ( MTS_DIRECTION_IS_IN(srb->cmnd[0]) ) {
 578                         pipe = usb_rcvbulkpipe(desc->usb_dev,desc->ep_response);
 579                         MTS_DEBUG( "transfering from desc->ep_response == %d\n",
 580                                    (int)desc->ep_response);
 581         } else {
 582                 MTS_DEBUG("transfering to desc->ep_out == %d\n",
 583                           (int)desc->ep_out);
 584                 pipe = usb_sndbulkpipe(desc->usb_dev,desc->ep_out);
 585         }
 586         desc->context.data_pipe = pipe;
 587 }
 588
 589
 590 static int
 591 mts_scsi_queuecommand(struct scsi_cmnd *srb, mts_scsi_cmnd_callback callback)
 592 {
 593         struct mts_desc* desc = (struct mts_desc*)(srb->device->host->hostdata[0]);
 594         int err = 0;
 595         int res;
 596
 597         MTS_DEBUG_GOT_HERE();
 598         mts_show_command(srb);
 599         mts_debug_dump(desc);
 600
 601         if ( srb->device->lun || srb->device->id || srb->device->channel ) {
 602
 603                 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 );
 604
 605                 MTS_DEBUG("this device doesn't exist\n");
 606
 607                 srb->result = DID_BAD_TARGET << 16;
 608
 609                 if(likely(callback != NULL))
 610                         callback(srb);
 611
 612                 goto out;
 613         }
 614
 615
 616         usb_fill_bulk_urb(desc->urb,
 617                       desc->usb_dev,
 618                       usb_sndbulkpipe(desc->usb_dev,desc->ep_out),
 619                       srb->cmnd,
 620                       srb->cmd_len,
 621                       mts_command_done,
 622                       &desc->context
 623                       );
 624
 625
 626         mts_build_transfer_context( srb, desc );
 627         desc->context.final_callback = callback;
 628
 629         /* here we need ATOMIC as we are called with the iolock */
 630         res=usb_submit_urb(desc->urb, GFP_ATOMIC);
 631
 632         if(unlikely(res)){
 633                 MTS_ERROR("error %d submitting URB\n",(int)res);
 634                 srb->result = DID_ERROR << 16;
 635
 636                 if(likely(callback != NULL))
 637                         callback(srb);
 638
 639         }
 640 out:
 641         return err;
 642 }
 643
 644 static struct scsi_host_template mts_scsi_host_template = {
 645         .module                 = THIS_MODULE,
 646         .name                   = "microtekX6",
 647         .proc_name              = "microtekX6",
 648         .queuecommand           = mts_scsi_queuecommand,
 649         .eh_abort_handler       = mts_scsi_abort,
 650         .eh_host_reset_handler  = mts_scsi_host_reset,
 651         .sg_tablesize =         SG_ALL,
 652         .can_queue =            1,
 653         .this_id =              -1,
 654         .cmd_per_lun =          1,
 655         .use_clustering =       1,
 656         .emulated =             1,
 657         .slave_alloc =          mts_slave_alloc,
 658         .slave_configure =      mts_slave_configure,
 659         .max_sectors=           256, /* 128 K */
 660 };
 661
 662 struct vendor_product
 663 {
 664         char* name;
 665         enum
 666         {
 667                 mts_sup_unknown=0,
 668                 mts_sup_alpha,
 669                 mts_sup_full
 670         }
 671         support_status;
 672 } ;
 673
 674
 675 /* These are taken from the msmUSB.inf file on the Windows driver CD */
 676 static const struct vendor_product mts_supported_products[] =
 677 {
 678         { "Phantom 336CX",      mts_sup_unknown},
 679         { "Phantom 336CX",      mts_sup_unknown},
 680         { "Scanmaker X6",       mts_sup_alpha},
 681         { "Phantom C6",         mts_sup_unknown},
 682         { "Phantom 336CX",      mts_sup_unknown},
 683         { "ScanMaker V6USL",    mts_sup_unknown},
 684         { "ScanMaker V6USL",    mts_sup_unknown},
 685         { "Scanmaker V6UL",     mts_sup_unknown},
 686         { "Scanmaker V6UPL",    mts_sup_alpha},
 687 };
 688
 689 /* The entries of microtek_table must correspond, line-by-line to
 690    the entries of mts_supported_products[]. */
 691
 692 static struct usb_device_id mts_usb_ids [] =
 693 {
 694         { USB_DEVICE(0x4ce, 0x0300) },
 695         { USB_DEVICE(0x5da, 0x0094) },
 696         { USB_DEVICE(0x5da, 0x0099) },
 697         { USB_DEVICE(0x5da, 0x009a) },
 698         { USB_DEVICE(0x5da, 0x00a0) },
 699         { USB_DEVICE(0x5da, 0x00a3) },
 700         { USB_DEVICE(0x5da, 0x80a3) },
 701         { USB_DEVICE(0x5da, 0x80ac) },
 702         { USB_DEVICE(0x5da, 0x00b6) },
 703         { }                                             /* Terminating entry */
 704 };
 705
 706 MODULE_DEVICE_TABLE (usb, mts_usb_ids);
 707
 708
 709 static int mts_usb_probe(struct usb_interface *intf,
 710                          const struct usb_device_id *id)
 711 {
 712         int i;
 713         int ep_out = -1;
 714         int ep_in_set[3]; /* this will break if we have more than three endpoints
 715                            which is why we check */
 716         int *ep_in_current = ep_in_set;
 717         int err_retval = -ENOMEM;
 718
 719         struct mts_desc * new_desc;
 720         struct vendor_product const* p;
 721         struct usb_device *dev = interface_to_usbdev (intf);
 722
 723         /* the current altsetting on the interface we're probing */
 724         struct usb_host_interface *altsetting;
 725
 726         MTS_DEBUG_GOT_HERE();
 727         MTS_DEBUG( "usb-device descriptor at %x\n", (int)dev );
 728
 729         MTS_DEBUG( "product id = 0x%x, vendor id = 0x%x\n",
 730                    le16_to_cpu(dev->descriptor.idProduct),
 731                    le16_to_cpu(dev->descriptor.idVendor) );
 732
 733         MTS_DEBUG_GOT_HERE();
 734
 735         p = &mts_supported_products[id - mts_usb_ids];
 736
 737         MTS_DEBUG_GOT_HERE();
 738
 739         MTS_DEBUG( "found model %s\n", p->name );
 740         if ( p->support_status != mts_sup_full )
 741                 MTS_MESSAGE( "model %s is not known to be fully supported, reports welcome!\n",
 742                              p->name );
 743
 744         /* the current altsetting on the interface we're probing */
 745         altsetting = intf->cur_altsetting;
 746
 747
 748         /* Check if the config is sane */
 749
 750         if ( altsetting->desc.bNumEndpoints != MTS_EP_TOTAL ) {
 751                 MTS_WARNING( "expecting %d got %d endpoints! Bailing out.\n",
 752                              (int)MTS_EP_TOTAL, (int)altsetting->desc.bNumEndpoints );
 753                 return -ENODEV;
 754         }
 755
 756         for( i = 0; i < altsetting->desc.bNumEndpoints; i++ ) {
 757                 if ((altsetting->endpoint[i].desc.bmAttributes &
 758                      USB_ENDPOINT_XFERTYPE_MASK) != USB_ENDPOINT_XFER_BULK) {
 759
 760                         MTS_WARNING( "can only deal with bulk endpoints; endpoint %d is not bulk.\n",
 761                              (int)altsetting->endpoint[i].desc.bEndpointAddress );
 762                 } else {
 763                         if (altsetting->endpoint[i].desc.bEndpointAddress &
 764                             USB_DIR_IN)
 765                                 *ep_in_current++
 766                                         = altsetting->endpoint[i].desc.bEndpointAddress &
 767                                         USB_ENDPOINT_NUMBER_MASK;
 768                         else {
 769                                 if ( ep_out != -1 ) {
 770                                         MTS_WARNING( "can only deal with one output endpoints. Bailing out." );
 771                                         return -ENODEV;
 772                                 }
 773
 774                                 ep_out = altsetting->endpoint[i].desc.bEndpointAddress &
 775                                         USB_ENDPOINT_NUMBER_MASK;
 776                         }
 777                 }
 778
 779         }
 780
 781
 782         if ( ep_out == -1 ) {
 783                 MTS_WARNING( "couldn't find an output bulk endpoint. Bailing out.\n" );
 784                 return -ENODEV;
 785         }
 786
 787
 788         new_desc = kzalloc(sizeof(struct mts_desc), GFP_KERNEL);
 789         if (!new_desc)
 790                 goto out;
 791
 792         new_desc->urb = usb_alloc_urb(0, GFP_KERNEL);
 793         if (!new_desc->urb)
 794                 goto out_kfree;
 795
 796         new_desc->context.scsi_status = kmalloc(1, GFP_KERNEL);
 797         if (!new_desc->context.scsi_status)
 798                 goto out_free_urb;
 799
 800         new_desc->usb_dev = dev;
 801         new_desc->usb_intf = intf;
 802         init_MUTEX(&new_desc->lock);
 803
 804         /* endpoints */
 805         new_desc->ep_out = ep_out;
 806         new_desc->ep_response = ep_in_set[0];
 807         new_desc->ep_image = ep_in_set[1];
 808
 809         if ( new_desc->ep_out != MTS_EP_OUT )
 810                 MTS_WARNING( "will this work? Command EP is not usually %d\n",
 811                              (int)new_desc->ep_out );
 812
 813         if ( new_desc->ep_response != MTS_EP_RESPONSE )
 814                 MTS_WARNING( "will this work? Response EP is not usually %d\n",
 815                              (int)new_desc->ep_response );
 816
 817         if ( new_desc->ep_image != MTS_EP_IMAGE )
 818                 MTS_WARNING( "will this work? Image data EP is not usually %d\n",
 819                              (int)new_desc->ep_image );
 820
 821         new_desc->host = scsi_host_alloc(&mts_scsi_host_template,
 822                         sizeof(new_desc));
 823         if (!new_desc->host)
 824                 goto out_kfree2;
 825
 826         new_desc->host->hostdata[0] = (unsigned long)new_desc;
 827         if (scsi_add_host(new_desc->host, NULL)) {
 828                 err_retval = -EIO;
 829                 goto out_host_put;
 830         }
 831         scsi_scan_host(new_desc->host);
 832
 833         usb_set_intfdata(intf, new_desc);
 834         return 0;
 835
 836  out_host_put:
 837         scsi_host_put(new_desc->host);
 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");