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