drivers/usb/storage/usb.c

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