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