drivers/usb/storage/usb.c

   1 /* Driver for USB Mass Storage compliant devices
   2  *
   3  * $Id: usb.c,v 1.75 2002/04/22 03:39:43 mdharm Exp $
   4  *
   5  * Current development and maintenance by:
   6  *   (c) 1999-2003 Matthew Dharm (mdharm-usb@one-eyed-alien.net)
   7  *
   8  * Developed with the assistance of:
   9  *   (c) 2000 David L. Brown, Jr. (usb-storage@davidb.org)
  10  *   (c) 2003 Alan Stern (stern@rowland.harvard.edu)
  11  *
  12  * Initial work by:
  13  *   (c) 1999 Michael Gee (michael@linuxspecific.com)
  14  *
  15  * usb_device_id support by Adam J. Richter (adam@yggdrasil.com):
  16  *   (c) 2000 Yggdrasil Computing, Inc.
  17  *
  18  * This driver is based on the 'USB Mass Storage Class' document. This
  19  * describes in detail the protocol used to communicate with such
  20  * devices.  Clearly, the designers had SCSI and ATAPI commands in
  21  * mind when they created this document.  The commands are all very
  22  * similar to commands in the SCSI-II and ATAPI specifications.
  23  *
  24  * It is important to note that in a number of cases this class
  25  * exhibits class-specific exemptions from the USB specification.
  26  * Notably the usage of NAK, STALL and ACK differs from the norm, in
  27  * that they are used to communicate wait, failed and OK on commands.
  28  *
  29  * Also, for certain devices, the interrupt endpoint is used to convey
  30  * status of a command.
  31  *
  32  * Please see http://www.one-eyed-alien.net/~mdharm/linux-usb for more
  33  * information about this driver.
  34  *
  35  * This program is free software; you can redistribute it and/or modify it
  36  * under the terms of the GNU General Public License as published by the
  37  * Free Software Foundation; either version 2, or (at your option) any
  38  * later version.
  39  *
  40  * This program is distributed in the hope that it will be useful, but
  41  * WITHOUT ANY WARRANTY; without even the implied warranty of
  42  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  43  * General Public License for more details.
  44  *
  45  * You should have received a copy of the GNU General Public License along
  46  * with this program; if not, write to the Free Software Foundation, Inc.,
  47  * 675 Mass Ave, Cambridge, MA 02139, USA.
  48  */
  49
  50 #include <linux/sched.h>
  51 #include <linux/errno.h>
  52 #include <linux/freezer.h>
  53 #include <linux/module.h>
  54 #include <linux/init.h>
  55 #include <linux/slab.h>
  56 #include <linux/kthread.h>
  57 #include <linux/mutex.h>
  58 #include <linux/utsname.h>
  59
  60 #include <scsi/scsi.h>
  61 #include <scsi/scsi_cmnd.h>
  62 #include <scsi/scsi_device.h>
  63
  64 #include "usb.h"
  65 #include "scsiglue.h"
  66 #include "transport.h"
  67 #include "protocol.h"
  68 #include "debug.h"
  69 #include "initializers.h"
  70
  71 #ifdef CONFIG_USB_STORAGE_USBAT
  72 #include "shuttle_usbat.h"
  73 #endif
  74 #ifdef CONFIG_USB_STORAGE_SDDR09
  75 #include "sddr09.h"
  76 #endif
  77 #ifdef CONFIG_USB_STORAGE_SDDR55
  78 #include "sddr55.h"
  79 #endif
  80 #ifdef CONFIG_USB_STORAGE_DPCM
  81 #include "dpcm.h"
  82 #endif
  83 #ifdef CONFIG_USB_STORAGE_FREECOM
  84 #include "freecom.h"
  85 #endif
  86 #ifdef CONFIG_USB_STORAGE_ISD200
  87 #include "isd200.h"
  88 #endif
  89 #ifdef CONFIG_USB_STORAGE_DATAFAB
  90 #include "datafab.h"
  91 #endif
  92 #ifdef CONFIG_USB_STORAGE_JUMPSHOT
  93 #include "jumpshot.h"
  94 #endif
  95 #ifdef CONFIG_USB_STORAGE_ONETOUCH
  96 #include "onetouch.h"
  97 #endif
  98 #ifdef CONFIG_USB_STORAGE_ALAUDA
  99 #include "alauda.h"
 100 #endif
 101 #ifdef CONFIG_USB_STORAGE_KARMA
 102 #include "karma.h"
 103 #endif
 104
 105 /* Some informational data */
 106 MODULE_AUTHOR("Matthew Dharm <mdharm-usb@one-eyed-alien.net>");
 107 MODULE_DESCRIPTION("USB Mass Storage driver for Linux");
 108 MODULE_LICENSE("GPL");
 109
 110 static unsigned int delay_use = 5;
 111 module_param(delay_use, uint, S_IRUGO | S_IWUSR);
 112 MODULE_PARM_DESC(delay_use, "seconds to delay before using a new device");
 113
 114
 115 /* These are used to make sure the module doesn't unload before all the
 116  * threads have exited.
 117  */
 118 static atomic_t total_threads = ATOMIC_INIT(0);
 119 static DECLARE_COMPLETION(threads_gone);
 120
 121
 122 /*
 123  * The entries in this table correspond, line for line,
 124  * with the entries of us_unusual_dev_list[].
 125  */
 126 #ifndef CONFIG_USB_LIBUSUAL
 127
 128 #define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \
 129                     vendorName, productName,useProtocol, useTransport, \
 130                     initFunction, flags) \
 131 { USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin,bcdDeviceMax), \
 132   .driver_info = (flags)|(USB_US_TYPE_STOR<<24) }
 133
 134 #define USUAL_DEV(useProto, useTrans, useType) \
 135 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, useProto, useTrans), \
 136   .driver_info = (USB_US_TYPE_STOR<<24) }
 137
 138 static struct usb_device_id storage_usb_ids [] = {
 139
 140 #       include "unusual_devs.h"
 141 #undef UNUSUAL_DEV
 142 #undef USUAL_DEV
 143         /* Terminating entry */
 144         { }
 145 };
 146
 147 MODULE_DEVICE_TABLE (usb, storage_usb_ids);
 148 #endif /* CONFIG_USB_LIBUSUAL */
 149
 150 /* This is the list of devices we recognize, along with their flag data */
 151
 152 /* The vendor name should be kept at eight characters or less, and
 153  * the product name should be kept at 16 characters or less. If a device
 154  * has the US_FL_FIX_INQUIRY flag, then the vendor and product names
 155  * normally generated by a device thorugh the INQUIRY response will be
 156  * taken from this list, and this is the reason for the above size
 157  * restriction. However, if the flag is not present, then you
 158  * are free to use as many characters as you like.
 159  */
 160
 161 #define UNUSUAL_DEV(idVendor, idProduct, bcdDeviceMin, bcdDeviceMax, \
 162                     vendor_name, product_name, use_protocol, use_transport, \
 163                     init_function, Flags) \
 164 { \
 165         .vendorName = vendor_name,      \
 166         .productName = product_name,    \
 167         .useProtocol = use_protocol,    \
 168         .useTransport = use_transport,  \
 169         .initFunction = init_function,  \
 170 }
 171
 172 #define USUAL_DEV(use_protocol, use_transport, use_type) \
 173 { \
 174         .useProtocol = use_protocol,    \
 175         .useTransport = use_transport,  \
 176 }
 177
 178 static struct us_unusual_dev us_unusual_dev_list[] = {
 179 #       include "unusual_devs.h"
 180 #       undef UNUSUAL_DEV
 181 #       undef USUAL_DEV
 182
 183         /* Terminating entry */
 184         { NULL }
 185 };
 186
 187
 188 #ifdef CONFIG_PM        /* Minimal support for suspend and resume */
 189
 190 static int storage_suspend(struct usb_interface *iface, pm_message_t message)
 191 {
 192         struct us_data *us = usb_get_intfdata(iface);
 193
 194         /* Wait until no command is running */
 195         mutex_lock(&us->dev_mutex);
 196
 197         US_DEBUGP("%s\n", __FUNCTION__);
 198         if (us->suspend_resume_hook)
 199                 (us->suspend_resume_hook)(us, US_SUSPEND);
 200
 201         /* When runtime PM is working, we'll set a flag to indicate
 202          * whether we should autoresume when a SCSI request arrives. */
 203
 204         mutex_unlock(&us->dev_mutex);
 205         return 0;
 206 }
 207
 208 static int storage_resume(struct usb_interface *iface)
 209 {
 210         struct us_data *us = usb_get_intfdata(iface);
 211
 212         mutex_lock(&us->dev_mutex);
 213
 214         US_DEBUGP("%s\n", __FUNCTION__);
 215         if (us->suspend_resume_hook)
 216                 (us->suspend_resume_hook)(us, US_RESUME);
 217
 218         mutex_unlock(&us->dev_mutex);
 219         return 0;
 220 }
 221
 222 #endif /* CONFIG_PM */
 223
 224 /*
 225  * The next two routines get called just before and just after
 226  * a USB port reset, whether from this driver or a different one.
 227  */
 228
 229 static void storage_pre_reset(struct usb_interface *iface)
 230 {
 231         struct us_data *us = usb_get_intfdata(iface);
 232
 233         US_DEBUGP("%s\n", __FUNCTION__);
 234
 235         /* Make sure no command runs during the reset */
 236         mutex_lock(&us->dev_mutex);
 237 }
 238
 239 static void storage_post_reset(struct usb_interface *iface, int reset_resume)
 240 {
 241         struct us_data *us = usb_get_intfdata(iface);
 242
 243         US_DEBUGP("%s\n", __FUNCTION__);
 244
 245         /* Report the reset to the SCSI core */
 246         scsi_lock(us_to_host(us));
 247         usb_stor_report_bus_reset(us);
 248         scsi_unlock(us_to_host(us));
 249
 250         /* FIXME: Notify the subdrivers that they need to reinitialize
 251          * the device */
 252
 253         /* If this is a reset-resume then the pre_reset routine wasn't
 254          * called, so we don't need to unlock the mutex. */
 255         if (!reset_resume)
 256                 mutex_unlock(&us->dev_mutex);
 257 }
 258
 259 /*
 260  * fill_inquiry_response takes an unsigned char array (which must
 261  * be at least 36 characters) and populates the vendor name,
 262  * product name, and revision fields. Then the array is copied
 263  * into the SCSI command's response buffer (oddly enough
 264  * called request_buffer). data_len contains the length of the
 265  * data array, which again must be at least 36.
 266  */
 267
 268 void fill_inquiry_response(struct us_data *us, unsigned char *data,
 269                 unsigned int data_len)
 270 {
 271         if (data_len<36) // You lose.
 272                 return;
 273
 274         if(data[0]&0x20) { /* USB device currently not connected. Return
 275                               peripheral qualifier 001b ("...however, the
 276                               physical device is not currently connected
 277                               to this logical unit") and leave vendor and
 278                               product identification empty. ("If the target
 279                               does store some of the INQUIRY data on the
 280                               device, it may return zeros or ASCII spaces
 281                               (20h) in those fields until the data is
 282                               available from the device."). */
 283                 memset(data+8,0,28);
 284         } else {
 285                 u16 bcdDevice = le16_to_cpu(us->pusb_dev->descriptor.bcdDevice);
 286                 memcpy(data+8, us->unusual_dev->vendorName,
 287                         strlen(us->unusual_dev->vendorName) > 8 ? 8 :
 288                         strlen(us->unusual_dev->vendorName));
 289                 memcpy(data+16, us->unusual_dev->productName,
 290                         strlen(us->unusual_dev->productName) > 16 ? 16 :
 291                         strlen(us->unusual_dev->productName));
 292                 data[32] = 0x30 + ((bcdDevice>>12) & 0x0F);
 293                 data[33] = 0x30 + ((bcdDevice>>8) & 0x0F);
 294                 data[34] = 0x30 + ((bcdDevice>>4) & 0x0F);
 295                 data[35] = 0x30 + ((bcdDevice) & 0x0F);
 296         }
 297
 298         usb_stor_set_xfer_buf(data, data_len, us->srb);
 299 }
 300
 301 static int usb_stor_control_thread(void * __us)
 302 {
 303         struct us_data *us = (struct us_data *)__us;
 304         struct Scsi_Host *host = us_to_host(us);
 305
 306         current->flags |= PF_NOFREEZE;
 307
 308         for(;;) {
 309                 US_DEBUGP("*** thread sleeping.\n");
 310                 if(down_interruptible(&us->sema))
 311                         break;
 312
 313                 US_DEBUGP("*** thread awakened.\n");
 314
 315                 /* lock the device pointers */
 316                 mutex_lock(&(us->dev_mutex));
 317
 318                 /* if the device has disconnected, we are free to exit */
 319                 if (test_bit(US_FLIDX_DISCONNECTING, &us->flags)) {
 320                         US_DEBUGP("-- exiting\n");
 321                         mutex_unlock(&us->dev_mutex);
 322                         break;
 323                 }
 324
 325                 /* lock access to the state */
 326                 scsi_lock(host);
 327
 328                 /* has the command timed out *already* ? */
 329                 if (test_bit(US_FLIDX_TIMED_OUT, &us->flags)) {
 330                         us->srb->result = DID_ABORT << 16;
 331                         goto SkipForAbort;
 332                 }
 333
 334                 scsi_unlock(host);
 335
 336                 /* reject the command if the direction indicator
 337                  * is UNKNOWN
 338                  */
 339                 if (us->srb->sc_data_direction == DMA_BIDIRECTIONAL) {
 340                         US_DEBUGP("UNKNOWN data direction\n");
 341                         us->srb->result = DID_ERROR << 16;
 342                 }
 343
 344                 /* reject if target != 0 or if LUN is higher than
 345                  * the maximum known LUN
 346                  */
 347                 else if (us->srb->device->id &&
 348                                 !(us->flags & US_FL_SCM_MULT_TARG)) {
 349                         US_DEBUGP("Bad target number (%d:%d)\n",
 350                                   us->srb->device->id, us->srb->device->lun);
 351                         us->srb->result = DID_BAD_TARGET << 16;
 352                 }
 353
 354                 else if (us->srb->device->lun > us->max_lun) {
 355                         US_DEBUGP("Bad LUN (%d:%d)\n",
 356                                   us->srb->device->id, us->srb->device->lun);
 357                         us->srb->result = DID_BAD_TARGET << 16;
 358                 }
 359
 360                 /* Handle those devices which need us to fake
 361                  * their inquiry data */
 362                 else if ((us->srb->cmnd[0] == INQUIRY) &&
 363                             (us->flags & US_FL_FIX_INQUIRY)) {
 364                         unsigned char data_ptr[36] = {
 365                             0x00, 0x80, 0x02, 0x02,
 366                             0x1F, 0x00, 0x00, 0x00};
 367
 368                         US_DEBUGP("Faking INQUIRY command\n");
 369                         fill_inquiry_response(us, data_ptr, 36);
 370                         us->srb->result = SAM_STAT_GOOD;
 371                 }
 372
 373                 /* we've got a command, let's do it! */
 374                 else {
 375                         US_DEBUG(usb_stor_show_command(us->srb));
 376                         us->proto_handler(us->srb, us);
 377                 }
 378
 379                 /* lock access to the state */
 380                 scsi_lock(host);
 381
 382                 /* did the command already complete because of a disconnect? */
 383                 if (!us->srb)
 384                         ;               /* nothing to do */
 385
 386                 /* indicate that the command is done */
 387                 else if (us->srb->result != DID_ABORT << 16) {
 388                         US_DEBUGP("scsi cmd done, result=0x%x\n",
 389                                    us->srb->result);
 390                         us->srb->scsi_done(us->srb);
 391                 } else {
 392 SkipForAbort:
 393                         US_DEBUGP("scsi command aborted\n");
 394                 }
 395
 396                 /* If an abort request was received we need to signal that
 397                  * the abort has finished.  The proper test for this is
 398                  * the TIMED_OUT flag, not srb->result == DID_ABORT, because
 399                  * the timeout might have occurred after the command had
 400                  * already completed with a different result code. */
 401                 if (test_bit(US_FLIDX_TIMED_OUT, &us->flags)) {
 402                         complete(&(us->notify));
 403
 404                         /* Allow USB transfers to resume */
 405                         clear_bit(US_FLIDX_ABORTING, &us->flags);
 406                         clear_bit(US_FLIDX_TIMED_OUT, &us->flags);
 407                 }
 408
 409                 /* finished working on this command */
 410                 us->srb = NULL;
 411                 scsi_unlock(host);
 412
 413                 /* unlock the device pointers */
 414                 mutex_unlock(&us->dev_mutex);
 415         } /* for (;;) */
 416
 417         scsi_host_put(host);
 418
 419         /* notify the exit routine that we're actually exiting now
 420          *
 421          * complete()/wait_for_completion() is similar to up()/down(),
 422          * except that complete() is safe in the case where the structure
 423          * is getting deleted in a parallel mode of execution (i.e. just
 424          * after the down() -- that's necessary for the thread-shutdown
 425          * case.
 426          *
 427          * complete_and_exit() goes even further than this -- it is safe in
 428          * the case that the thread of the caller is going away (not just
 429          * the structure) -- this is necessary for the module-remove case.
 430          * This is important in preemption kernels, which transfer the flow
 431          * of execution immediately upon a complete().
 432          */
 433         complete_and_exit(&threads_gone, 0);
 434 }
 435
 436 /***********************************************************************
 437  * Device probing and disconnecting
 438  ***********************************************************************/
 439
 440 /* Associate our private data with the USB device */
 441 static int associate_dev(struct us_data *us, struct usb_interface *intf)
 442 {
 443         US_DEBUGP("-- %s\n", __FUNCTION__);
 444
 445         /* Fill in the device-related fields */
 446         us->pusb_dev = interface_to_usbdev(intf);
 447         us->pusb_intf = intf;
 448         us->ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
 449         US_DEBUGP("Vendor: 0x%04x, Product: 0x%04x, Revision: 0x%04x\n",
 450                         le16_to_cpu(us->pusb_dev->descriptor.idVendor),
 451                         le16_to_cpu(us->pusb_dev->descriptor.idProduct),
 452                         le16_to_cpu(us->pusb_dev->descriptor.bcdDevice));
 453         US_DEBUGP("Interface Subclass: 0x%02x, Protocol: 0x%02x\n",
 454                         intf->cur_altsetting->desc.bInterfaceSubClass,
 455                         intf->cur_altsetting->desc.bInterfaceProtocol);
 456
 457         /* Store our private data in the interface */
 458         usb_set_intfdata(intf, us);
 459
 460         /* Allocate the device-related DMA-mapped buffers */
 461         us->cr = usb_buffer_alloc(us->pusb_dev, sizeof(*us->cr),
 462                         GFP_KERNEL, &us->cr_dma);
 463         if (!us->cr) {
 464                 US_DEBUGP("usb_ctrlrequest allocation failed\n");
 465                 return -ENOMEM;
 466         }
 467
 468         us->iobuf = usb_buffer_alloc(us->pusb_dev, US_IOBUF_SIZE,
 469                         GFP_KERNEL, &us->iobuf_dma);
 470         if (!us->iobuf) {
 471                 US_DEBUGP("I/O buffer allocation failed\n");
 472                 return -ENOMEM;
 473         }
 474
 475         us->sensebuf = kmalloc(US_SENSE_SIZE, GFP_KERNEL);
 476         if (!us->sensebuf) {
 477                 US_DEBUGP("Sense buffer allocation failed\n");
 478                 return -ENOMEM;
 479         }
 480         return 0;
 481 }
 482
 483 /* Find an unusual_dev descriptor (always succeeds in the current code) */
 484 static struct us_unusual_dev *find_unusual(const struct usb_device_id *id)
 485 {
 486         const int id_index = id - storage_usb_ids;
 487         return &us_unusual_dev_list[id_index];
 488 }
 489
 490 /* Get the unusual_devs entries and the string descriptors */
 491 static int get_device_info(struct us_data *us, const struct usb_device_id *id)
 492 {
 493         struct usb_device *dev = us->pusb_dev;
 494         struct usb_interface_descriptor *idesc =
 495                 &us->pusb_intf->cur_altsetting->desc;
 496         struct us_unusual_dev *unusual_dev = find_unusual(id);
 497
 498         /* Store the entries */
 499         us->unusual_dev = unusual_dev;
 500         us->subclass = (unusual_dev->useProtocol == US_SC_DEVICE) ?
 501                         idesc->bInterfaceSubClass :
 502                         unusual_dev->useProtocol;
 503         us->protocol = (unusual_dev->useTransport == US_PR_DEVICE) ?
 504                         idesc->bInterfaceProtocol :
 505                         unusual_dev->useTransport;
 506         us->flags = USB_US_ORIG_FLAGS(id->driver_info);
 507
 508         if (us->flags & US_FL_IGNORE_DEVICE) {
 509                 printk(KERN_INFO USB_STORAGE "device ignored\n");
 510                 return -ENODEV;
 511         }
 512
 513         /*
 514          * This flag is only needed when we're in high-speed, so let's
 515          * disable it if we're in full-speed
 516          */
 517         if (dev->speed != USB_SPEED_HIGH)
 518                 us->flags &= ~US_FL_GO_SLOW;
 519
 520         /* Log a message if a non-generic unusual_dev entry contains an
 521          * unnecessary subclass or protocol override.  This may stimulate
 522          * reports from users that will help us remove unneeded entries
 523          * from the unusual_devs.h table.
 524          */
 525         if (id->idVendor || id->idProduct) {
 526                 static const char *msgs[3] = {
 527                         "an unneeded SubClass entry",
 528                         "an unneeded Protocol entry",
 529                         "unneeded SubClass and Protocol entries"};
 530                 struct usb_device_descriptor *ddesc = &dev->descriptor;
 531                 int msg = -1;
 532
 533                 if (unusual_dev->useProtocol != US_SC_DEVICE &&
 534                         us->subclass == idesc->bInterfaceSubClass)
 535                         msg += 1;
 536                 if (unusual_dev->useTransport != US_PR_DEVICE &&
 537                         us->protocol == idesc->bInterfaceProtocol)
 538                         msg += 2;
 539                 if (msg >= 0 && !(us->flags & US_FL_NEED_OVERRIDE))
 540                         printk(KERN_NOTICE USB_STORAGE "This device "
 541                                 "(%04x,%04x,%04x S %02x P %02x)"
 542                                 " has %s in unusual_devs.h (kernel"
 543                                 " %s)\n"
 544                                 "   Please send a copy of this message to "
 545                                 "<linux-usb-devel@lists.sourceforge.net>\n",
 546                                 le16_to_cpu(ddesc->idVendor),
 547                                 le16_to_cpu(ddesc->idProduct),
 548                                 le16_to_cpu(ddesc->bcdDevice),
 549                                 idesc->bInterfaceSubClass,
 550                                 idesc->bInterfaceProtocol,
 551                                 msgs[msg],
 552                                 utsname()->release);
 553         }
 554
 555         return 0;
 556 }
 557
 558 /* Get the transport settings */
 559 static int get_transport(struct us_data *us)
 560 {
 561         switch (us->protocol) {
 562         case US_PR_CB:
 563                 us->transport_name = "Control/Bulk";
 564                 us->transport = usb_stor_CB_transport;
 565                 us->transport_reset = usb_stor_CB_reset;
 566                 us->max_lun = 7;
 567                 break;
 568
 569         case US_PR_CBI:
 570                 us->transport_name = "Control/Bulk/Interrupt";
 571                 us->transport = usb_stor_CBI_transport;
 572                 us->transport_reset = usb_stor_CB_reset;
 573                 us->max_lun = 7;
 574                 break;
 575
 576         case US_PR_BULK:
 577                 us->transport_name = "Bulk";
 578                 us->transport = usb_stor_Bulk_transport;
 579                 us->transport_reset = usb_stor_Bulk_reset;
 580                 break;
 581
 582 #ifdef CONFIG_USB_STORAGE_USBAT
 583         case US_PR_USBAT:
 584                 us->transport_name = "Shuttle USBAT";
 585                 us->transport = usbat_transport;
 586                 us->transport_reset = usb_stor_CB_reset;
 587                 us->max_lun = 1;
 588                 break;
 589 #endif
 590
 591 #ifdef CONFIG_USB_STORAGE_SDDR09
 592         case US_PR_EUSB_SDDR09:
 593                 us->transport_name = "EUSB/SDDR09";
 594                 us->transport = sddr09_transport;
 595                 us->transport_reset = usb_stor_CB_reset;
 596                 us->max_lun = 0;
 597                 break;
 598 #endif
 599
 600 #ifdef CONFIG_USB_STORAGE_SDDR55
 601         case US_PR_SDDR55:
 602                 us->transport_name = "SDDR55";
 603                 us->transport = sddr55_transport;
 604                 us->transport_reset = sddr55_reset;
 605                 us->max_lun = 0;
 606                 break;
 607 #endif
 608
 609 #ifdef CONFIG_USB_STORAGE_DPCM
 610         case US_PR_DPCM_USB:
 611                 us->transport_name = "Control/Bulk-EUSB/SDDR09";
 612                 us->transport = dpcm_transport;
 613                 us->transport_reset = usb_stor_CB_reset;
 614                 us->max_lun = 1;
 615                 break;
 616 #endif
 617
 618 #ifdef CONFIG_USB_STORAGE_FREECOM
 619         case US_PR_FREECOM:
 620                 us->transport_name = "Freecom";
 621                 us->transport = freecom_transport;
 622                 us->transport_reset = usb_stor_freecom_reset;
 623                 us->max_lun = 0;
 624                 break;
 625 #endif
 626
 627 #ifdef CONFIG_USB_STORAGE_DATAFAB
 628         case US_PR_DATAFAB:
 629                 us->transport_name  = "Datafab Bulk-Only";
 630                 us->transport = datafab_transport;
 631                 us->transport_reset = usb_stor_Bulk_reset;
 632                 us->max_lun = 1;
 633                 break;
 634 #endif
 635
 636 #ifdef CONFIG_USB_STORAGE_JUMPSHOT
 637         case US_PR_JUMPSHOT:
 638                 us->transport_name  = "Lexar Jumpshot Control/Bulk";
 639                 us->transport = jumpshot_transport;
 640                 us->transport_reset = usb_stor_Bulk_reset;
 641                 us->max_lun = 1;
 642                 break;
 643 #endif
 644
 645 #ifdef CONFIG_USB_STORAGE_ALAUDA
 646         case US_PR_ALAUDA:
 647                 us->transport_name  = "Alauda Control/Bulk";
 648                 us->transport = alauda_transport;
 649                 us->transport_reset = usb_stor_Bulk_reset;
 650                 us->max_lun = 1;
 651                 break;
 652 #endif
 653
 654 #ifdef CONFIG_USB_STORAGE_KARMA
 655         case US_PR_KARMA:
 656                 us->transport_name = "Rio Karma/Bulk";
 657                 us->transport = rio_karma_transport;
 658                 us->transport_reset = usb_stor_Bulk_reset;
 659                 break;
 660 #endif
 661
 662         default:
 663                 return -EIO;
 664         }
 665         US_DEBUGP("Transport: %s\n", us->transport_name);
 666
 667         /* fix for single-lun devices */
 668         if (us->flags & US_FL_SINGLE_LUN)
 669                 us->max_lun = 0;
 670         return 0;
 671 }
 672
 673 /* Get the protocol settings */
 674 static int get_protocol(struct us_data *us)
 675 {
 676         switch (us->subclass) {
 677         case US_SC_RBC:
 678                 us->protocol_name = "Reduced Block Commands (RBC)";
 679                 us->proto_handler = usb_stor_transparent_scsi_command;
 680                 break;
 681
 682         case US_SC_8020:
 683                 us->protocol_name = "8020i";
 684                 us->proto_handler = usb_stor_ATAPI_command;
 685                 us->max_lun = 0;
 686                 break;
 687
 688         case US_SC_QIC:
 689                 us->protocol_name = "QIC-157";
 690                 us->proto_handler = usb_stor_qic157_command;
 691                 us->max_lun = 0;
 692                 break;
 693
 694         case US_SC_8070:
 695                 us->protocol_name = "8070i";
 696                 us->proto_handler = usb_stor_ATAPI_command;
 697                 us->max_lun = 0;
 698                 break;
 699
 700         case US_SC_SCSI:
 701                 us->protocol_name = "Transparent SCSI";
 702                 us->proto_handler = usb_stor_transparent_scsi_command;
 703                 break;
 704
 705         case US_SC_UFI:
 706                 us->protocol_name = "Uniform Floppy Interface (UFI)";
 707                 us->proto_handler = usb_stor_ufi_command;
 708                 break;
 709
 710 #ifdef CONFIG_USB_STORAGE_ISD200
 711         case US_SC_ISD200:
 712                 us->protocol_name = "ISD200 ATA/ATAPI";
 713                 us->proto_handler = isd200_ata_command;
 714                 break;
 715 #endif
 716
 717         default:
 718                 return -EIO;
 719         }
 720         US_DEBUGP("Protocol: %s\n", us->protocol_name);
 721         return 0;
 722 }
 723
 724 /* Get the pipe settings */
 725 static int get_pipes(struct us_data *us)
 726 {
 727         struct usb_host_interface *altsetting =
 728                 us->pusb_intf->cur_altsetting;
 729         int i;
 730         struct usb_endpoint_descriptor *ep;
 731         struct usb_endpoint_descriptor *ep_in = NULL;
 732         struct usb_endpoint_descriptor *ep_out = NULL;
 733         struct usb_endpoint_descriptor *ep_int = NULL;
 734
 735         /*
 736          * Find the first endpoint of each type we need.
 737          * We are expecting a minimum of 2 endpoints - in and out (bulk).
 738          * An optional interrupt-in is OK (necessary for CBI protocol).
 739          * We will ignore any others.
 740          */
 741         for (i = 0; i < altsetting->desc.bNumEndpoints; i++) {
 742                 ep = &altsetting->endpoint[i].desc;
 743
 744                 if (usb_endpoint_xfer_bulk(ep)) {
 745                         if (usb_endpoint_dir_in(ep)) {
 746                                 if (!ep_in)
 747                                         ep_in = ep;
 748                         } else {
 749                                 if (!ep_out)
 750                                         ep_out = ep;
 751                         }
 752                 }
 753
 754                 else if (usb_endpoint_is_int_in(ep)) {
 755                         if (!ep_int)
 756                                 ep_int = ep;
 757                 }
 758         }
 759
 760         if (!ep_in || !ep_out || (us->protocol == US_PR_CBI && !ep_int)) {
 761                 US_DEBUGP("Endpoint sanity check failed! Rejecting dev.\n");
 762                 return -EIO;
 763         }
 764
 765         /* Calculate and store the pipe values */
 766         us->send_ctrl_pipe = usb_sndctrlpipe(us->pusb_dev, 0);
 767         us->recv_ctrl_pipe = usb_rcvctrlpipe(us->pusb_dev, 0);
 768         us->send_bulk_pipe = usb_sndbulkpipe(us->pusb_dev,
 769                 ep_out->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
 770         us->recv_bulk_pipe = usb_rcvbulkpipe(us->pusb_dev,
 771                 ep_in->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
 772         if (ep_int) {
 773                 us->recv_intr_pipe = usb_rcvintpipe(us->pusb_dev,
 774                         ep_int->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
 775                 us->ep_bInterval = ep_int->bInterval;
 776         }
 777         return 0;
 778 }
 779
 780 /* Initialize all the dynamic resources we need */
 781 static int usb_stor_acquire_resources(struct us_data *us)
 782 {
 783         int p;
 784         struct task_struct *th;
 785
 786         us->current_urb = usb_alloc_urb(0, GFP_KERNEL);
 787         if (!us->current_urb) {
 788                 US_DEBUGP("URB allocation failed\n");
 789                 return -ENOMEM;
 790         }
 791
 792         /* Just before we start our control thread, initialize
 793          * the device if it needs initialization */
 794         if (us->unusual_dev->initFunction) {
 795                 p = us->unusual_dev->initFunction(us);
 796                 if (p)
 797                         return p;
 798         }
 799
 800         /* Start up our control thread */
 801         th = kthread_create(usb_stor_control_thread, us, "usb-storage");
 802         if (IS_ERR(th)) {
 803                 printk(KERN_WARNING USB_STORAGE
 804                        "Unable to start control thread\n");
 805                 return PTR_ERR(th);
 806         }
 807
 808         /* Take a reference to the host for the control thread and
 809          * count it among all the threads we have launched.  Then
 810          * start it up. */
 811         scsi_host_get(us_to_host(us));
 812         atomic_inc(&total_threads);
 813         wake_up_process(th);
 814
 815         return 0;
 816 }
 817
 818 /* Release all our dynamic resources */
 819 static void usb_stor_release_resources(struct us_data *us)
 820 {
 821         US_DEBUGP("-- %s\n", __FUNCTION__);
 822
 823         /* Tell the control thread to exit.  The SCSI host must
 824          * already have been removed so it won't try to queue
 825          * any more commands.
 826          */
 827         US_DEBUGP("-- sending exit command to thread\n");
 828         set_bit(US_FLIDX_DISCONNECTING, &us->flags);
 829         up(&us->sema);
 830
 831         /* Call the destructor routine, if it exists */
 832         if (us->extra_destructor) {
 833                 US_DEBUGP("-- calling extra_destructor()\n");
 834                 us->extra_destructor(us->extra);
 835         }
 836
 837         /* Free the extra data and the URB */
 838         kfree(us->extra);
 839         usb_free_urb(us->current_urb);
 840 }
 841
 842 /* Dissociate from the USB device */
 843 static void dissociate_dev(struct us_data *us)
 844 {
 845         US_DEBUGP("-- %s\n", __FUNCTION__);
 846
 847         kfree(us->sensebuf);
 848
 849         /* Free the device-related DMA-mapped buffers */
 850         if (us->cr)
 851                 usb_buffer_free(us->pusb_dev, sizeof(*us->cr), us->cr,
 852                                 us->cr_dma);
 853         if (us->iobuf)
 854                 usb_buffer_free(us->pusb_dev, US_IOBUF_SIZE, us->iobuf,
 855                                 us->iobuf_dma);
 856
 857         /* Remove our private data from the interface */
 858         usb_set_intfdata(us->pusb_intf, NULL);
 859 }
 860
 861 /* First stage of disconnect processing: stop all commands and remove
 862  * the host */
 863 static void quiesce_and_remove_host(struct us_data *us)
 864 {
 865         struct Scsi_Host *host = us_to_host(us);
 866
 867         /* Prevent new USB transfers, stop the current command, and
 868          * interrupt a SCSI-scan or device-reset delay */
 869         scsi_lock(host);
 870         set_bit(US_FLIDX_DISCONNECTING, &us->flags);
 871         scsi_unlock(host);
 872         usb_stor_stop_transport(us);
 873         wake_up(&us->delay_wait);
 874
 875         /* It doesn't matter if the SCSI-scanning thread is still running.
 876          * The thread will exit when it sees the DISCONNECTING flag. */
 877
 878         /* queuecommand won't accept any new commands and the control
 879          * thread won't execute a previously-queued command.  If there
 880          * is such a command pending, complete it with an error. */
 881         mutex_lock(&us->dev_mutex);
 882         if (us->srb) {
 883                 us->srb->result = DID_NO_CONNECT << 16;
 884                 scsi_lock(host);
 885                 us->srb->scsi_done(us->srb);
 886                 us->srb = NULL;
 887                 scsi_unlock(host);
 888         }
 889         mutex_unlock(&us->dev_mutex);
 890
 891         /* Now we own no commands so it's safe to remove the SCSI host */
 892         scsi_remove_host(host);
 893 }
 894
 895 /* Second stage of disconnect processing: deallocate all resources */
 896 static void release_everything(struct us_data *us)
 897 {
 898         usb_stor_release_resources(us);
 899         dissociate_dev(us);
 900
 901         /* Drop our reference to the host; the SCSI core will free it
 902          * (and "us" along with it) when the refcount becomes 0. */
 903         scsi_host_put(us_to_host(us));
 904 }
 905
 906 /* Thread to carry out delayed SCSI-device scanning */
 907 static int usb_stor_scan_thread(void * __us)
 908 {
 909         struct us_data *us = (struct us_data *)__us;
 910
 911         printk(KERN_DEBUG
 912                 "usb-storage: device found at %d\n", us->pusb_dev->devnum);
 913
 914         /* Wait for the timeout to expire or for a disconnect */
 915         if (delay_use > 0) {
 916                 printk(KERN_DEBUG "usb-storage: waiting for device "
 917                                 "to settle before scanning\n");
 918 retry:
 919                 wait_event_interruptible_timeout(us->delay_wait,
 920                                 test_bit(US_FLIDX_DISCONNECTING, &us->flags),
 921                                 delay_use * HZ);
 922                 if (try_to_freeze())
 923                         goto retry;
 924         }
 925
 926         /* If the device is still connected, perform the scanning */
 927         if (!test_bit(US_FLIDX_DISCONNECTING, &us->flags)) {
 928
 929                 /* For bulk-only devices, determine the max LUN value */
 930                 if (us->protocol == US_PR_BULK &&
 931                                 !(us->flags & US_FL_SINGLE_LUN)) {
 932                         mutex_lock(&us->dev_mutex);
 933                         us->max_lun = usb_stor_Bulk_max_lun(us);
 934                         mutex_unlock(&us->dev_mutex);
 935                 }
 936                 scsi_scan_host(us_to_host(us));
 937                 printk(KERN_DEBUG "usb-storage: device scan complete\n");
 938
 939                 /* Should we unbind if no devices were detected? */
 940         }
 941
 942         scsi_host_put(us_to_host(us));
 943         complete_and_exit(&threads_gone, 0);
 944 }
 945
 946
 947 /* Probe to see if we can drive a newly-connected USB device */
 948 static int storage_probe(struct usb_interface *intf,
 949                          const struct usb_device_id *id)
 950 {
 951         struct Scsi_Host *host;
 952         struct us_data *us;
 953         int result;
 954         struct task_struct *th;
 955
 956         if (usb_usual_check_type(id, USB_US_TYPE_STOR))
 957                 return -ENXIO;
 958
 959         US_DEBUGP("USB Mass Storage device detected\n");
 960
 961         /*
 962          * Ask the SCSI layer to allocate a host structure, with extra
 963          * space at the end for our private us_data structure.
 964          */
 965         host = scsi_host_alloc(&usb_stor_host_template, sizeof(*us));
 966         if (!host) {
 967                 printk(KERN_WARNING USB_STORAGE
 968                         "Unable to allocate the scsi host\n");
 969                 return -ENOMEM;
 970         }
 971
 972         us = host_to_us(host);
 973         memset(us, 0, sizeof(struct us_data));
 974         mutex_init(&(us->dev_mutex));
 975         init_MUTEX_LOCKED(&(us->sema));
 976         init_completion(&(us->notify));
 977         init_waitqueue_head(&us->delay_wait);
 978
 979         /* Associate the us_data structure with the USB device */
 980         result = associate_dev(us, intf);
 981         if (result)
 982                 goto BadDevice;
 983
 984         /*
 985          * Get the unusual_devs entries and the descriptors
 986          *
 987          * id_index is calculated in the declaration to be the index number
 988          * of the match from the usb_device_id table, so we can find the
 989          * corresponding entry in the private table.
 990          */
 991         result = get_device_info(us, id);
 992         if (result)
 993                 goto BadDevice;
 994
 995         /* Get the transport, protocol, and pipe settings */
 996         result = get_transport(us);
 997         if (result)
 998                 goto BadDevice;
 999         result = get_protocol(us);
1000         if (result)
1001                 goto BadDevice;
1002         result = get_pipes(us);
1003         if (result)
1004                 goto BadDevice;
1005
1006         /* Acquire all the other resources and add the host */
1007         result = usb_stor_acquire_resources(us);
1008         if (result)
1009                 goto BadDevice;
1010         result = scsi_add_host(host, &intf->dev);
1011         if (result) {
1012                 printk(KERN_WARNING USB_STORAGE
1013                         "Unable to add the scsi host\n");
1014                 goto BadDevice;
1015         }
1016
1017         /* Start up the thread for delayed SCSI-device scanning */
1018         th = kthread_create(usb_stor_scan_thread, us, "usb-stor-scan");
1019         if (IS_ERR(th)) {
1020                 printk(KERN_WARNING USB_STORAGE
1021                        "Unable to start the device-scanning thread\n");
1022                 quiesce_and_remove_host(us);
1023                 result = PTR_ERR(th);
1024                 goto BadDevice;
1025         }
1026
1027         /* Take a reference to the host for the scanning thread and
1028          * count it among all the threads we have launched.  Then
1029          * start it up. */
1030         scsi_host_get(us_to_host(us));
1031         atomic_inc(&total_threads);
1032         wake_up_process(th);
1033
1034         return 0;
1035
1036         /* We come here if there are any problems */
1037 BadDevice:
1038         US_DEBUGP("storage_probe() failed\n");
1039         release_everything(us);
1040         return result;
1041 }
1042
1043 /* Handle a disconnect event from the USB core */
1044 static void storage_disconnect(struct usb_interface *intf)
1045 {
1046         struct us_data *us = usb_get_intfdata(intf);
1047
1048         US_DEBUGP("storage_disconnect() called\n");
1049         quiesce_and_remove_host(us);
1050         release_everything(us);
1051 }
1052
1053 /***********************************************************************
1054  * Initialization and registration
1055  ***********************************************************************/
1056
1057 static struct usb_driver usb_storage_driver = {
1058         .name =         "usb-storage",
1059         .probe =        storage_probe,
1060         .disconnect =   storage_disconnect,
1061 #ifdef CONFIG_PM
1062         .suspend =      storage_suspend,
1063         .resume =       storage_resume,
1064 #endif
1065         .pre_reset =    storage_pre_reset,
1066         .post_reset =   storage_post_reset,
1067         .id_table =     storage_usb_ids,
1068 };
1069
1070 static int __init usb_stor_init(void)
1071 {
1072         int retval;
1073         printk(KERN_INFO "Initializing USB Mass Storage driver...\n");
1074
1075         /* register the driver, return usb_register return code if error */
1076         retval = usb_register(&usb_storage_driver);
1077         if (retval == 0) {
1078                 printk(KERN_INFO "USB Mass Storage support registered.\n");
1079                 usb_usual_set_present(USB_US_TYPE_STOR);
1080         }
1081         return retval;
1082 }
1083
1084 static void __exit usb_stor_exit(void)
1085 {
1086         US_DEBUGP("usb_stor_exit() called\n");
1087
1088         /* Deregister the driver
1089          * This will cause disconnect() to be called for each
1090          * attached unit
1091          */
1092         US_DEBUGP("-- calling usb_deregister()\n");
1093         usb_deregister(&usb_storage_driver) ;
1094
1095         /* Don't return until all of our control and scanning threads
1096          * have exited.  Since each thread signals threads_gone as its
1097          * last act, we have to call wait_for_completion the right number
1098          * of times.
1099          */
1100         while (atomic_read(&total_threads) > 0) {
1101                 wait_for_completion(&threads_gone);
1102                 atomic_dec(&total_threads);
1103         }
1104
1105         usb_usual_clear_present(USB_US_TYPE_STOR);
1106 }
1107
1108 module_init(usb_stor_init);
1109 module_exit(usb_stor_exit);