Version:  2.0.40 2.2.26 2.4.37 3.12 3.13 3.14 3.15 3.16 3.17 3.18 3.19 4.0 4.1 4.2 4.3 4.4 4.5 4.6 4.7 4.8 4.9

Linux/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 (mdharm-usb@one-eyed-alien.net)
  6  *
  7  * Developed with the assistance of:
  8  *   (c) 2000 David L. Brown, Jr. (usb-storage@davidb.org)
  9  *   (c) 2003-2009 Alan Stern (stern@rowland.harvard.edu)
 10  *
 11  * Initial work by:
 12  *   (c) 1999 Michael Gee (michael@linuxspecific.com)
 13  *
 14  * usb_device_id support by Adam J. Richter (adam@yggdrasil.com):
 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 <mdharm-usb@one-eyed-alien.net>");
 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                         US_FL_ALWAYS_SYNC);
503 
504         p = quirks;
505         while (*p) {
506                 /* Each entry consists of VID:PID:flags */
507                 if (vid == simple_strtoul(p, &p, 16) &&
508                                 *p == ':' &&
509                                 pid == simple_strtoul(p+1, &p, 16) &&
510                                 *p == ':')
511                         break;
512 
513                 /* Move forward to the next entry */
514                 while (*p) {
515                         if (*p++ == ',')
516                                 break;
517                 }
518         }
519         if (!*p)        /* No match */
520                 return;
521 
522         /* Collect the flags */
523         while (*++p && *p != ',') {
524                 switch (TOLOWER(*p)) {
525                 case 'a':
526                         f |= US_FL_SANE_SENSE;
527                         break;
528                 case 'b':
529                         f |= US_FL_BAD_SENSE;
530                         break;
531                 case 'c':
532                         f |= US_FL_FIX_CAPACITY;
533                         break;
534                 case 'd':
535                         f |= US_FL_NO_READ_DISC_INFO;
536                         break;
537                 case 'e':
538                         f |= US_FL_NO_READ_CAPACITY_16;
539                         break;
540                 case 'f':
541                         f |= US_FL_NO_REPORT_OPCODES;
542                         break;
543                 case 'g':
544                         f |= US_FL_MAX_SECTORS_240;
545                         break;
546                 case 'h':
547                         f |= US_FL_CAPACITY_HEURISTICS;
548                         break;
549                 case 'i':
550                         f |= US_FL_IGNORE_DEVICE;
551                         break;
552                 case 'j':
553                         f |= US_FL_NO_REPORT_LUNS;
554                         break;
555                 case 'l':
556                         f |= US_FL_NOT_LOCKABLE;
557                         break;
558                 case 'm':
559                         f |= US_FL_MAX_SECTORS_64;
560                         break;
561                 case 'n':
562                         f |= US_FL_INITIAL_READ10;
563                         break;
564                 case 'o':
565                         f |= US_FL_CAPACITY_OK;
566                         break;
567                 case 'p':
568                         f |= US_FL_WRITE_CACHE;
569                         break;
570                 case 'r':
571                         f |= US_FL_IGNORE_RESIDUE;
572                         break;
573                 case 's':
574                         f |= US_FL_SINGLE_LUN;
575                         break;
576                 case 't':
577                         f |= US_FL_NO_ATA_1X;
578                         break;
579                 case 'u':
580                         f |= US_FL_IGNORE_UAS;
581                         break;
582                 case 'w':
583                         f |= US_FL_NO_WP_DETECT;
584                         break;
585                 case 'y':
586                         f |= US_FL_ALWAYS_SYNC;
587                         break;
588                 /* Ignore unrecognized flag characters */
589                 }
590         }
591         *fflags = (*fflags & ~mask) | f;
592 }
593 EXPORT_SYMBOL_GPL(usb_stor_adjust_quirks);
594 
595 /* Get the unusual_devs entries and the string descriptors */
596 static int get_device_info(struct us_data *us, const struct usb_device_id *id,
597                 struct us_unusual_dev *unusual_dev)
598 {
599         struct usb_device *dev = us->pusb_dev;
600         struct usb_interface_descriptor *idesc =
601                 &us->pusb_intf->cur_altsetting->desc;
602         struct device *pdev = &us->pusb_intf->dev;
603 
604         /* Store the entries */
605         us->unusual_dev = unusual_dev;
606         us->subclass = (unusual_dev->useProtocol == USB_SC_DEVICE) ?
607                         idesc->bInterfaceSubClass :
608                         unusual_dev->useProtocol;
609         us->protocol = (unusual_dev->useTransport == USB_PR_DEVICE) ?
610                         idesc->bInterfaceProtocol :
611                         unusual_dev->useTransport;
612         us->fflags = id->driver_info;
613         usb_stor_adjust_quirks(us->pusb_dev, &us->fflags);
614 
615         if (us->fflags & US_FL_IGNORE_DEVICE) {
616                 dev_info(pdev, "device ignored\n");
617                 return -ENODEV;
618         }
619 
620         /*
621          * This flag is only needed when we're in high-speed, so let's
622          * disable it if we're in full-speed
623          */
624         if (dev->speed != USB_SPEED_HIGH)
625                 us->fflags &= ~US_FL_GO_SLOW;
626 
627         if (us->fflags)
628                 dev_info(pdev, "Quirks match for vid %04x pid %04x: %lx\n",
629                                 le16_to_cpu(dev->descriptor.idVendor),
630                                 le16_to_cpu(dev->descriptor.idProduct),
631                                 us->fflags);
632 
633         /*
634          * Log a message if a non-generic unusual_dev entry contains an
635          * unnecessary subclass or protocol override.  This may stimulate
636          * reports from users that will help us remove unneeded entries
637          * from the unusual_devs.h table.
638          */
639         if (id->idVendor || id->idProduct) {
640                 static const char *msgs[3] = {
641                         "an unneeded SubClass entry",
642                         "an unneeded Protocol entry",
643                         "unneeded SubClass and Protocol entries"};
644                 struct usb_device_descriptor *ddesc = &dev->descriptor;
645                 int msg = -1;
646 
647                 if (unusual_dev->useProtocol != USB_SC_DEVICE &&
648                         us->subclass == idesc->bInterfaceSubClass)
649                         msg += 1;
650                 if (unusual_dev->useTransport != USB_PR_DEVICE &&
651                         us->protocol == idesc->bInterfaceProtocol)
652                         msg += 2;
653                 if (msg >= 0 && !(us->fflags & US_FL_NEED_OVERRIDE))
654                         dev_notice(pdev, "This device "
655                                         "(%04x,%04x,%04x S %02x P %02x)"
656                                         " has %s in unusual_devs.h (kernel"
657                                         " %s)\n"
658                                         "   Please send a copy of this message to "
659                                         "<linux-usb@vger.kernel.org> and "
660                                         "<usb-storage@lists.one-eyed-alien.net>\n",
661                                         le16_to_cpu(ddesc->idVendor),
662                                         le16_to_cpu(ddesc->idProduct),
663                                         le16_to_cpu(ddesc->bcdDevice),
664                                         idesc->bInterfaceSubClass,
665                                         idesc->bInterfaceProtocol,
666                                         msgs[msg],
667                                         utsname()->release);
668         }
669 
670         return 0;
671 }
672 
673 /* Get the transport settings */
674 static void get_transport(struct us_data *us)
675 {
676         switch (us->protocol) {
677         case USB_PR_CB:
678                 us->transport_name = "Control/Bulk";
679                 us->transport = usb_stor_CB_transport;
680                 us->transport_reset = usb_stor_CB_reset;
681                 us->max_lun = 7;
682                 break;
683 
684         case USB_PR_CBI:
685                 us->transport_name = "Control/Bulk/Interrupt";
686                 us->transport = usb_stor_CB_transport;
687                 us->transport_reset = usb_stor_CB_reset;
688                 us->max_lun = 7;
689                 break;
690 
691         case USB_PR_BULK:
692                 us->transport_name = "Bulk";
693                 us->transport = usb_stor_Bulk_transport;
694                 us->transport_reset = usb_stor_Bulk_reset;
695                 break;
696         }
697 }
698 
699 /* Get the protocol settings */
700 static void get_protocol(struct us_data *us)
701 {
702         switch (us->subclass) {
703         case USB_SC_RBC:
704                 us->protocol_name = "Reduced Block Commands (RBC)";
705                 us->proto_handler = usb_stor_transparent_scsi_command;
706                 break;
707 
708         case USB_SC_8020:
709                 us->protocol_name = "8020i";
710                 us->proto_handler = usb_stor_pad12_command;
711                 us->max_lun = 0;
712                 break;
713 
714         case USB_SC_QIC:
715                 us->protocol_name = "QIC-157";
716                 us->proto_handler = usb_stor_pad12_command;
717                 us->max_lun = 0;
718                 break;
719 
720         case USB_SC_8070:
721                 us->protocol_name = "8070i";
722                 us->proto_handler = usb_stor_pad12_command;
723                 us->max_lun = 0;
724                 break;
725 
726         case USB_SC_SCSI:
727                 us->protocol_name = "Transparent SCSI";
728                 us->proto_handler = usb_stor_transparent_scsi_command;
729                 break;
730 
731         case USB_SC_UFI:
732                 us->protocol_name = "Uniform Floppy Interface (UFI)";
733                 us->proto_handler = usb_stor_ufi_command;
734                 break;
735         }
736 }
737 
738 /* Get the pipe settings */
739 static int get_pipes(struct us_data *us)
740 {
741         struct usb_host_interface *altsetting =
742                 us->pusb_intf->cur_altsetting;
743         int i;
744         struct usb_endpoint_descriptor *ep;
745         struct usb_endpoint_descriptor *ep_in = NULL;
746         struct usb_endpoint_descriptor *ep_out = NULL;
747         struct usb_endpoint_descriptor *ep_int = NULL;
748 
749         /*
750          * Find the first endpoint of each type we need.
751          * We are expecting a minimum of 2 endpoints - in and out (bulk).
752          * An optional interrupt-in is OK (necessary for CBI protocol).
753          * We will ignore any others.
754          */
755         for (i = 0; i < altsetting->desc.bNumEndpoints; i++) {
756                 ep = &altsetting->endpoint[i].desc;
757 
758                 if (usb_endpoint_xfer_bulk(ep)) {
759                         if (usb_endpoint_dir_in(ep)) {
760                                 if (!ep_in)
761                                         ep_in = ep;
762                         } else {
763                                 if (!ep_out)
764                                         ep_out = ep;
765                         }
766                 }
767 
768                 else if (usb_endpoint_is_int_in(ep)) {
769                         if (!ep_int)
770                                 ep_int = ep;
771                 }
772         }
773 
774         if (!ep_in || !ep_out || (us->protocol == USB_PR_CBI && !ep_int)) {
775                 usb_stor_dbg(us, "Endpoint sanity check failed! Rejecting dev.\n");
776                 return -EIO;
777         }
778 
779         /* Calculate and store the pipe values */
780         us->send_ctrl_pipe = usb_sndctrlpipe(us->pusb_dev, 0);
781         us->recv_ctrl_pipe = usb_rcvctrlpipe(us->pusb_dev, 0);
782         us->send_bulk_pipe = usb_sndbulkpipe(us->pusb_dev,
783                 usb_endpoint_num(ep_out));
784         us->recv_bulk_pipe = usb_rcvbulkpipe(us->pusb_dev,
785                 usb_endpoint_num(ep_in));
786         if (ep_int) {
787                 us->recv_intr_pipe = usb_rcvintpipe(us->pusb_dev,
788                         usb_endpoint_num(ep_int));
789                 us->ep_bInterval = ep_int->bInterval;
790         }
791         return 0;
792 }
793 
794 /* Initialize all the dynamic resources we need */
795 static int usb_stor_acquire_resources(struct us_data *us)
796 {
797         int p;
798         struct task_struct *th;
799 
800         us->current_urb = usb_alloc_urb(0, GFP_KERNEL);
801         if (!us->current_urb)
802                 return -ENOMEM;
803 
804         /*
805          * Just before we start our control thread, initialize
806          * the device if it needs initialization
807          */
808         if (us->unusual_dev->initFunction) {
809                 p = us->unusual_dev->initFunction(us);
810                 if (p)
811                         return p;
812         }
813 
814         /* Start up our control thread */
815         th = kthread_run(usb_stor_control_thread, us, "usb-storage");
816         if (IS_ERR(th)) {
817                 dev_warn(&us->pusb_intf->dev,
818                                 "Unable to start control thread\n");
819                 return PTR_ERR(th);
820         }
821         us->ctl_thread = th;
822 
823         return 0;
824 }
825 
826 /* Release all our dynamic resources */
827 static void usb_stor_release_resources(struct us_data *us)
828 {
829         /*
830          * Tell the control thread to exit.  The SCSI host must
831          * already have been removed and the DISCONNECTING flag set
832          * so that we won't accept any more commands.
833          */
834         usb_stor_dbg(us, "-- sending exit command to thread\n");
835         complete(&us->cmnd_ready);
836         if (us->ctl_thread)
837                 kthread_stop(us->ctl_thread);
838 
839         /* Call the destructor routine, if it exists */
840         if (us->extra_destructor) {
841                 usb_stor_dbg(us, "-- calling extra_destructor()\n");
842                 us->extra_destructor(us->extra);
843         }
844 
845         /* Free the extra data and the URB */
846         kfree(us->extra);
847         usb_free_urb(us->current_urb);
848 }
849 
850 /* Dissociate from the USB device */
851 static void dissociate_dev(struct us_data *us)
852 {
853         /* Free the buffers */
854         kfree(us->cr);
855         usb_free_coherent(us->pusb_dev, US_IOBUF_SIZE, us->iobuf, us->iobuf_dma);
856 
857         /* Remove our private data from the interface */
858         usb_set_intfdata(us->pusb_intf, NULL);
859 }
860 
861 /*
862  * First stage of disconnect processing: stop SCSI scanning,
863  * remove the host, and stop accepting new commands
864  */
865 static void quiesce_and_remove_host(struct us_data *us)
866 {
867         struct Scsi_Host *host = us_to_host(us);
868 
869         /* If the device is really gone, cut short reset delays */
870         if (us->pusb_dev->state == USB_STATE_NOTATTACHED) {
871                 set_bit(US_FLIDX_DISCONNECTING, &us->dflags);
872                 wake_up(&us->delay_wait);
873         }
874 
875         /*
876          * Prevent SCSI scanning (if it hasn't started yet)
877          * or wait for the SCSI-scanning routine to stop.
878          */
879         cancel_delayed_work_sync(&us->scan_dwork);
880 
881         /* Balance autopm calls if scanning was cancelled */
882         if (test_bit(US_FLIDX_SCAN_PENDING, &us->dflags))
883                 usb_autopm_put_interface_no_suspend(us->pusb_intf);
884 
885         /*
886          * Removing the host will perform an orderly shutdown: caches
887          * synchronized, disks spun down, etc.
888          */
889         scsi_remove_host(host);
890 
891         /*
892          * Prevent any new commands from being accepted and cut short
893          * reset delays.
894          */
895         scsi_lock(host);
896         set_bit(US_FLIDX_DISCONNECTING, &us->dflags);
897         scsi_unlock(host);
898         wake_up(&us->delay_wait);
899 }
900 
901 /* Second stage of disconnect processing: deallocate all resources */
902 static void release_everything(struct us_data *us)
903 {
904         usb_stor_release_resources(us);
905         dissociate_dev(us);
906 
907         /*
908          * Drop our reference to the host; the SCSI core will free it
909          * (and "us" along with it) when the refcount becomes 0.
910          */
911         scsi_host_put(us_to_host(us));
912 }
913 
914 /* Delayed-work routine to carry out SCSI-device scanning */
915 static void usb_stor_scan_dwork(struct work_struct *work)
916 {
917         struct us_data *us = container_of(work, struct us_data,
918                         scan_dwork.work);
919         struct device *dev = &us->pusb_intf->dev;
920 
921         dev_dbg(dev, "starting scan\n");
922 
923         /* For bulk-only devices, determine the max LUN value */
924         if (us->protocol == USB_PR_BULK &&
925             !(us->fflags & US_FL_SINGLE_LUN) &&
926             !(us->fflags & US_FL_SCM_MULT_TARG)) {
927                 mutex_lock(&us->dev_mutex);
928                 us->max_lun = usb_stor_Bulk_max_lun(us);
929                 /*
930                  * Allow proper scanning of devices that present more than 8 LUNs
931                  * While not affecting other devices that may need the previous
932                  * behavior
933                  */
934                 if (us->max_lun >= 8)
935                         us_to_host(us)->max_lun = us->max_lun+1;
936                 mutex_unlock(&us->dev_mutex);
937         }
938         scsi_scan_host(us_to_host(us));
939         dev_dbg(dev, "scan complete\n");
940 
941         /* Should we unbind if no devices were detected? */
942 
943         usb_autopm_put_interface(us->pusb_intf);
944         clear_bit(US_FLIDX_SCAN_PENDING, &us->dflags);
945 }
946 
947 static unsigned int usb_stor_sg_tablesize(struct usb_interface *intf)
948 {
949         struct usb_device *usb_dev = interface_to_usbdev(intf);
950 
951         if (usb_dev->bus->sg_tablesize) {
952                 return usb_dev->bus->sg_tablesize;
953         }
954         return SG_ALL;
955 }
956 
957 /* First part of general USB mass-storage probing */
958 int usb_stor_probe1(struct us_data **pus,
959                 struct usb_interface *intf,
960                 const struct usb_device_id *id,
961                 struct us_unusual_dev *unusual_dev,
962                 struct scsi_host_template *sht)
963 {
964         struct Scsi_Host *host;
965         struct us_data *us;
966         int result;
967 
968         dev_info(&intf->dev, "USB Mass Storage device detected\n");
969 
970         /*
971          * Ask the SCSI layer to allocate a host structure, with extra
972          * space at the end for our private us_data structure.
973          */
974         host = scsi_host_alloc(sht, sizeof(*us));
975         if (!host) {
976                 dev_warn(&intf->dev, "Unable to allocate the scsi host\n");
977                 return -ENOMEM;
978         }
979 
980         /*
981          * Allow 16-byte CDBs and thus > 2TB
982          */
983         host->max_cmd_len = 16;
984         host->sg_tablesize = usb_stor_sg_tablesize(intf);
985         *pus = us = host_to_us(host);
986         mutex_init(&(us->dev_mutex));
987         us_set_lock_class(&us->dev_mutex, intf);
988         init_completion(&us->cmnd_ready);
989         init_completion(&(us->notify));
990         init_waitqueue_head(&us->delay_wait);
991         INIT_DELAYED_WORK(&us->scan_dwork, usb_stor_scan_dwork);
992 
993         /* Associate the us_data structure with the USB device */
994         result = associate_dev(us, intf);
995         if (result)
996                 goto BadDevice;
997 
998         /* Get the unusual_devs entries and the descriptors */
999         result = get_device_info(us, id, unusual_dev);
1000         if (result)
1001                 goto BadDevice;
1002 
1003         /* Get standard transport and protocol settings */
1004         get_transport(us);
1005         get_protocol(us);
1006 
1007         /*
1008          * Give the caller a chance to fill in specialized transport
1009          * or protocol settings.
1010          */
1011         return 0;
1012 
1013 BadDevice:
1014         usb_stor_dbg(us, "storage_probe() failed\n");
1015         release_everything(us);
1016         return result;
1017 }
1018 EXPORT_SYMBOL_GPL(usb_stor_probe1);
1019 
1020 /* Second part of general USB mass-storage probing */
1021 int usb_stor_probe2(struct us_data *us)
1022 {
1023         int result;
1024         struct device *dev = &us->pusb_intf->dev;
1025 
1026         /* Make sure the transport and protocol have both been set */
1027         if (!us->transport || !us->proto_handler) {
1028                 result = -ENXIO;
1029                 goto BadDevice;
1030         }
1031         usb_stor_dbg(us, "Transport: %s\n", us->transport_name);
1032         usb_stor_dbg(us, "Protocol: %s\n", us->protocol_name);
1033 
1034         if (us->fflags & US_FL_SCM_MULT_TARG) {
1035                 /*
1036                  * SCM eUSCSI bridge devices can have different numbers
1037                  * of LUNs on different targets; allow all to be probed.
1038                  */
1039                 us->max_lun = 7;
1040                 /* The eUSCSI itself has ID 7, so avoid scanning that */
1041                 us_to_host(us)->this_id = 7;
1042                 /* max_id is 8 initially, so no need to set it here */
1043         } else {
1044                 /* In the normal case there is only a single target */
1045                 us_to_host(us)->max_id = 1;
1046                 /*
1047                  * Like Windows, we won't store the LUN bits in CDB[1] for
1048                  * SCSI-2 devices using the Bulk-Only transport (even though
1049                  * this violates the SCSI spec).
1050                  */
1051                 if (us->transport == usb_stor_Bulk_transport)
1052                         us_to_host(us)->no_scsi2_lun_in_cdb = 1;
1053         }
1054 
1055         /* fix for single-lun devices */
1056         if (us->fflags & US_FL_SINGLE_LUN)
1057                 us->max_lun = 0;
1058 
1059         /* Find the endpoints and calculate pipe values */
1060         result = get_pipes(us);
1061         if (result)
1062                 goto BadDevice;
1063 
1064         /*
1065          * If the device returns invalid data for the first READ(10)
1066          * command, indicate the command should be retried.
1067          */
1068         if (us->fflags & US_FL_INITIAL_READ10)
1069                 set_bit(US_FLIDX_REDO_READ10, &us->dflags);
1070 
1071         /* Acquire all the other resources and add the host */
1072         result = usb_stor_acquire_resources(us);
1073         if (result)
1074                 goto BadDevice;
1075         usb_autopm_get_interface_no_resume(us->pusb_intf);
1076         snprintf(us->scsi_name, sizeof(us->scsi_name), "usb-storage %s",
1077                                         dev_name(&us->pusb_intf->dev));
1078         result = scsi_add_host(us_to_host(us), dev);
1079         if (result) {
1080                 dev_warn(dev,
1081                                 "Unable to add the scsi host\n");
1082                 goto HostAddErr;
1083         }
1084 
1085         /* Submit the delayed_work for SCSI-device scanning */
1086         set_bit(US_FLIDX_SCAN_PENDING, &us->dflags);
1087 
1088         if (delay_use > 0)
1089                 dev_dbg(dev, "waiting for device to settle before scanning\n");
1090         queue_delayed_work(system_freezable_wq, &us->scan_dwork,
1091                         delay_use * HZ);
1092         return 0;
1093 
1094         /* We come here if there are any problems */
1095 HostAddErr:
1096         usb_autopm_put_interface_no_suspend(us->pusb_intf);
1097 BadDevice:
1098         usb_stor_dbg(us, "storage_probe() failed\n");
1099         release_everything(us);
1100         return result;
1101 }
1102 EXPORT_SYMBOL_GPL(usb_stor_probe2);
1103 
1104 /* Handle a USB mass-storage disconnect */
1105 void usb_stor_disconnect(struct usb_interface *intf)
1106 {
1107         struct us_data *us = usb_get_intfdata(intf);
1108 
1109         quiesce_and_remove_host(us);
1110         release_everything(us);
1111 }
1112 EXPORT_SYMBOL_GPL(usb_stor_disconnect);
1113 
1114 static struct scsi_host_template usb_stor_host_template;
1115 
1116 /* The main probe routine for standard devices */
1117 static int storage_probe(struct usb_interface *intf,
1118                          const struct usb_device_id *id)
1119 {
1120         struct us_unusual_dev *unusual_dev;
1121         struct us_data *us;
1122         int result;
1123         int size;
1124 
1125         /* If uas is enabled and this device can do uas then ignore it. */
1126 #if IS_ENABLED(CONFIG_USB_UAS)
1127         if (uas_use_uas_driver(intf, id, NULL))
1128                 return -ENXIO;
1129 #endif
1130 
1131         /*
1132          * If the device isn't standard (is handled by a subdriver
1133          * module) then don't accept it.
1134          */
1135         if (usb_usual_ignore_device(intf))
1136                 return -ENXIO;
1137 
1138         /*
1139          * Call the general probe procedures.
1140          *
1141          * The unusual_dev_list array is parallel to the usb_storage_usb_ids
1142          * table, so we use the index of the id entry to find the
1143          * corresponding unusual_devs entry.
1144          */
1145 
1146         size = ARRAY_SIZE(us_unusual_dev_list);
1147         if (id >= usb_storage_usb_ids && id < usb_storage_usb_ids + size) {
1148                 unusual_dev = (id - usb_storage_usb_ids) + us_unusual_dev_list;
1149         } else {
1150                 unusual_dev = &for_dynamic_ids;
1151 
1152                 dev_dbg(&intf->dev, "Use Bulk-Only transport with the Transparent SCSI protocol for dynamic id: 0x%04x 0x%04x\n",
1153                         id->idVendor, id->idProduct);
1154         }
1155 
1156         result = usb_stor_probe1(&us, intf, id, unusual_dev,
1157                                  &usb_stor_host_template);
1158         if (result)
1159                 return result;
1160 
1161         /* No special transport or protocol settings in the main module */
1162 
1163         result = usb_stor_probe2(us);
1164         return result;
1165 }
1166 
1167 static struct usb_driver usb_storage_driver = {
1168         .name =         DRV_NAME,
1169         .probe =        storage_probe,
1170         .disconnect =   usb_stor_disconnect,
1171         .suspend =      usb_stor_suspend,
1172         .resume =       usb_stor_resume,
1173         .reset_resume = usb_stor_reset_resume,
1174         .pre_reset =    usb_stor_pre_reset,
1175         .post_reset =   usb_stor_post_reset,
1176         .id_table =     usb_storage_usb_ids,
1177         .supports_autosuspend = 1,
1178         .soft_unbind =  1,
1179 };
1180 
1181 module_usb_stor_driver(usb_storage_driver, usb_stor_host_template, DRV_NAME);
1182 

This page was automatically generated by LXR 0.3.1 (source).  •  Linux is a registered trademark of Linus Torvalds  •  Contact us