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

source code of linux/drivers/usb/storage/usb.c