drivers/usb/storage/usb.c

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