1 /* Driver for USB Mass Storage compliant devices
3 * Current development and maintenance by:
4 * (c) 1999-2003 Matthew Dharm (mdharm-usb@one-eyed-alien.net)
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)
11 * (c) 1999 Michael Gee (michael@linuxspecific.com)
13 * usb_device_id support by Adam J. Richter (adam@yggdrasil.com):
14 * (c) 2000 Yggdrasil Computing, Inc.
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.
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.
27 * Also, for certain devices, the interrupt endpoint is used to convey
28 * status of a command.
30 * Please see http://www.one-eyed-alien.net/~mdharm/linux-usb for more
31 * information about this driver.
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
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.
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.
48 #ifdef CONFIG_USB_STORAGE_DEBUG
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>
62 #include <scsi/scsi.h>
63 #include <scsi/scsi_cmnd.h>
64 #include <scsi/scsi_device.h>
68 #include "transport.h"
71 #include "initializers.h"
73 #include "sierra_ms.h"
74 #include "option_ms.h"
76 /* Some informational data */
77 MODULE_AUTHOR("Matthew Dharm <mdharm-usb@one-eyed-alien.net>");
78 MODULE_DESCRIPTION("USB Mass Storage driver for Linux");
79 MODULE_LICENSE("GPL");
81 static unsigned int delay_use = 1;
82 module_param(delay_use, uint, S_IRUGO | S_IWUSR);
83 MODULE_PARM_DESC(delay_use, "seconds to delay before using a new device");
85 static char quirks[128];
86 module_param_string(quirks, quirks, sizeof(quirks), S_IRUGO | S_IWUSR);
87 MODULE_PARM_DESC(quirks, "supplemental list of device IDs and their quirks");
91 * The entries in this table correspond, line for line,
92 * with the entries in usb_storage_usb_ids[], defined in usual-tables.c.
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.
104 #define UNUSUAL_DEV(idVendor, idProduct, bcdDeviceMin, bcdDeviceMax, \
105 vendor_name, product_name, use_protocol, use_transport, \
106 init_function, Flags) \
108 .vendorName = vendor_name, \
109 .productName = product_name, \
110 .useProtocol = use_protocol, \
111 .useTransport = use_transport, \
112 .initFunction = init_function, \
115 #define COMPLIANT_DEV UNUSUAL_DEV
117 #define USUAL_DEV(use_protocol, use_transport, use_type) \
119 .useProtocol = use_protocol, \
120 .useTransport = use_transport, \
123 #define UNUSUAL_VENDOR_INTF(idVendor, cl, sc, pr, \
124 vendor_name, product_name, use_protocol, use_transport, \
125 init_function, Flags) \
127 .vendorName = vendor_name, \
128 .productName = product_name, \
129 .useProtocol = use_protocol, \
130 .useTransport = use_transport, \
131 .initFunction = init_function, \
134 static struct us_unusual_dev us_unusual_dev_list[] = {
135 # include "unusual_devs.h"
136 { } /* Terminating entry */
142 #undef UNUSUAL_VENDOR_INTF
145 #ifdef CONFIG_PM /* Minimal support for suspend and resume */
147 int usb_stor_suspend(struct usb_interface *iface, pm_message_t message)
149 struct us_data *us = usb_get_intfdata(iface);
151 /* Wait until no command is running */
152 mutex_lock(&us->dev_mutex);
154 US_DEBUGP("%s\n", __func__);
155 if (us->suspend_resume_hook)
156 (us->suspend_resume_hook)(us, US_SUSPEND);
158 /* When runtime PM is working, we'll set a flag to indicate
159 * whether we should autoresume when a SCSI request arrives. */
161 mutex_unlock(&us->dev_mutex);
164 EXPORT_SYMBOL_GPL(usb_stor_suspend);
166 int usb_stor_resume(struct usb_interface *iface)
168 struct us_data *us = usb_get_intfdata(iface);
170 mutex_lock(&us->dev_mutex);
172 US_DEBUGP("%s\n", __func__);
173 if (us->suspend_resume_hook)
174 (us->suspend_resume_hook)(us, US_RESUME);
176 mutex_unlock(&us->dev_mutex);
179 EXPORT_SYMBOL_GPL(usb_stor_resume);
181 int usb_stor_reset_resume(struct usb_interface *iface)
183 struct us_data *us = usb_get_intfdata(iface);
185 US_DEBUGP("%s\n", __func__);
187 /* Report the reset to the SCSI core */
188 usb_stor_report_bus_reset(us);
190 /* FIXME: Notify the subdrivers that they need to reinitialize
194 EXPORT_SYMBOL_GPL(usb_stor_reset_resume);
196 #endif /* CONFIG_PM */
199 * The next two routines get called just before and just after
200 * a USB port reset, whether from this driver or a different one.
203 int usb_stor_pre_reset(struct usb_interface *iface)
205 struct us_data *us = usb_get_intfdata(iface);
207 US_DEBUGP("%s\n", __func__);
209 /* Make sure no command runs during the reset */
210 mutex_lock(&us->dev_mutex);
213 EXPORT_SYMBOL_GPL(usb_stor_pre_reset);
215 int usb_stor_post_reset(struct usb_interface *iface)
217 struct us_data *us = usb_get_intfdata(iface);
219 US_DEBUGP("%s\n", __func__);
221 /* Report the reset to the SCSI core */
222 usb_stor_report_bus_reset(us);
224 /* FIXME: Notify the subdrivers that they need to reinitialize
227 mutex_unlock(&us->dev_mutex);
230 EXPORT_SYMBOL_GPL(usb_stor_post_reset);
233 * fill_inquiry_response takes an unsigned char array (which must
234 * be at least 36 characters) and populates the vendor name,
235 * product name, and revision fields. Then the array is copied
236 * into the SCSI command's response buffer (oddly enough
237 * called request_buffer). data_len contains the length of the
238 * data array, which again must be at least 36.
241 void fill_inquiry_response(struct us_data *us, unsigned char *data,
242 unsigned int data_len)
244 if (data_len<36) // You lose.
247 memset(data+8, ' ', 28);
248 if(data[0]&0x20) { /* USB device currently not connected. Return
249 peripheral qualifier 001b ("...however, the
250 physical device is not currently connected
251 to this logical unit") and leave vendor and
252 product identification empty. ("If the target
253 does store some of the INQUIRY data on the
254 device, it may return zeros or ASCII spaces
255 (20h) in those fields until the data is
256 available from the device."). */
258 u16 bcdDevice = le16_to_cpu(us->pusb_dev->descriptor.bcdDevice);
261 n = strlen(us->unusual_dev->vendorName);
262 memcpy(data+8, us->unusual_dev->vendorName, min(8, n));
263 n = strlen(us->unusual_dev->productName);
264 memcpy(data+16, us->unusual_dev->productName, min(16, n));
266 data[32] = 0x30 + ((bcdDevice>>12) & 0x0F);
267 data[33] = 0x30 + ((bcdDevice>>8) & 0x0F);
268 data[34] = 0x30 + ((bcdDevice>>4) & 0x0F);
269 data[35] = 0x30 + ((bcdDevice) & 0x0F);
272 usb_stor_set_xfer_buf(data, data_len, us->srb);
274 EXPORT_SYMBOL_GPL(fill_inquiry_response);
276 static int usb_stor_control_thread(void * __us)
278 struct us_data *us = (struct us_data *)__us;
279 struct Scsi_Host *host = us_to_host(us);
282 US_DEBUGP("*** thread sleeping.\n");
283 if (wait_for_completion_interruptible(&us->cmnd_ready))
286 US_DEBUGP("*** thread awakened.\n");
288 /* lock the device pointers */
289 mutex_lock(&(us->dev_mutex));
291 /* lock access to the state */
294 /* When we are called with no command pending, we're done */
295 if (us->srb == NULL) {
297 mutex_unlock(&us->dev_mutex);
298 US_DEBUGP("-- exiting\n");
302 /* has the command timed out *already* ? */
303 if (test_bit(US_FLIDX_TIMED_OUT, &us->dflags)) {
304 us->srb->result = DID_ABORT << 16;
310 /* reject the command if the direction indicator
313 if (us->srb->sc_data_direction == DMA_BIDIRECTIONAL) {
314 US_DEBUGP("UNKNOWN data direction\n");
315 us->srb->result = DID_ERROR << 16;
318 /* reject if target != 0 or if LUN is higher than
319 * the maximum known LUN
321 else if (us->srb->device->id &&
322 !(us->fflags & US_FL_SCM_MULT_TARG)) {
323 US_DEBUGP("Bad target number (%d:%d)\n",
324 us->srb->device->id, us->srb->device->lun);
325 us->srb->result = DID_BAD_TARGET << 16;
328 else if (us->srb->device->lun > us->max_lun) {
329 US_DEBUGP("Bad LUN (%d:%d)\n",
330 us->srb->device->id, us->srb->device->lun);
331 us->srb->result = DID_BAD_TARGET << 16;
334 /* Handle those devices which need us to fake
335 * their inquiry data */
336 else if ((us->srb->cmnd[0] == INQUIRY) &&
337 (us->fflags & US_FL_FIX_INQUIRY)) {
338 unsigned char data_ptr[36] = {
339 0x00, 0x80, 0x02, 0x02,
340 0x1F, 0x00, 0x00, 0x00};
342 US_DEBUGP("Faking INQUIRY command\n");
343 fill_inquiry_response(us, data_ptr, 36);
344 us->srb->result = SAM_STAT_GOOD;
347 /* we've got a command, let's do it! */
349 US_DEBUG(usb_stor_show_command(us->srb));
350 us->proto_handler(us->srb, us);
351 usb_mark_last_busy(us->pusb_dev);
354 /* lock access to the state */
357 /* indicate that the command is done */
358 if (us->srb->result != DID_ABORT << 16) {
359 US_DEBUGP("scsi cmd done, result=0x%x\n",
361 us->srb->scsi_done(us->srb);
364 US_DEBUGP("scsi command aborted\n");
367 /* If an abort request was received we need to signal that
368 * the abort has finished. The proper test for this is
369 * the TIMED_OUT flag, not srb->result == DID_ABORT, because
370 * the timeout might have occurred after the command had
371 * already completed with a different result code. */
372 if (test_bit(US_FLIDX_TIMED_OUT, &us->dflags)) {
373 complete(&(us->notify));
375 /* Allow USB transfers to resume */
376 clear_bit(US_FLIDX_ABORTING, &us->dflags);
377 clear_bit(US_FLIDX_TIMED_OUT, &us->dflags);
380 /* finished working on this command */
384 /* unlock the device pointers */
385 mutex_unlock(&us->dev_mutex);
388 /* Wait until we are told to stop */
390 set_current_state(TASK_INTERRUPTIBLE);
391 if (kthread_should_stop())
395 __set_current_state(TASK_RUNNING);
399 /***********************************************************************
400 * Device probing and disconnecting
401 ***********************************************************************/
403 /* Associate our private data with the USB device */
404 static int associate_dev(struct us_data *us, struct usb_interface *intf)
406 US_DEBUGP("-- %s\n", __func__);
408 /* Fill in the device-related fields */
409 us->pusb_dev = interface_to_usbdev(intf);
410 us->pusb_intf = intf;
411 us->ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
412 US_DEBUGP("Vendor: 0x%04x, Product: 0x%04x, Revision: 0x%04x\n",
413 le16_to_cpu(us->pusb_dev->descriptor.idVendor),
414 le16_to_cpu(us->pusb_dev->descriptor.idProduct),
415 le16_to_cpu(us->pusb_dev->descriptor.bcdDevice));
416 US_DEBUGP("Interface Subclass: 0x%02x, Protocol: 0x%02x\n",
417 intf->cur_altsetting->desc.bInterfaceSubClass,
418 intf->cur_altsetting->desc.bInterfaceProtocol);
420 /* Store our private data in the interface */
421 usb_set_intfdata(intf, us);
423 /* Allocate the control/setup and DMA-mapped buffers */
424 us->cr = kmalloc(sizeof(*us->cr), GFP_KERNEL);
426 US_DEBUGP("usb_ctrlrequest allocation failed\n");
430 us->iobuf = usb_alloc_coherent(us->pusb_dev, US_IOBUF_SIZE,
431 GFP_KERNEL, &us->iobuf_dma);
433 US_DEBUGP("I/O buffer allocation failed\n");
439 /* Works only for digits and letters, but small and fast */
440 #define TOLOWER(x) ((x) | 0x20)
442 /* Adjust device flags based on the "quirks=" module parameter */
443 static void adjust_quirks(struct us_data *us)
446 u16 vid = le16_to_cpu(us->pusb_dev->descriptor.idVendor);
447 u16 pid = le16_to_cpu(us->pusb_dev->descriptor.idProduct);
449 unsigned int mask = (US_FL_SANE_SENSE | US_FL_BAD_SENSE |
451 US_FL_CAPACITY_HEURISTICS | US_FL_IGNORE_DEVICE |
452 US_FL_NOT_LOCKABLE | US_FL_MAX_SECTORS_64 |
453 US_FL_CAPACITY_OK | US_FL_IGNORE_RESIDUE |
454 US_FL_SINGLE_LUN | US_FL_NO_WP_DETECT |
455 US_FL_NO_READ_DISC_INFO | US_FL_NO_READ_CAPACITY_16 |
456 US_FL_INITIAL_READ10 | US_FL_NO_REPORT_LUNS);
460 /* Each entry consists of VID:PID:flags */
461 if (vid == simple_strtoul(p, &p, 16) &&
463 pid == simple_strtoul(p+1, &p, 16) &&
467 /* Move forward to the next entry */
473 if (!*p) /* No match */
476 /* Collect the flags */
477 while (*++p && *p != ',') {
478 switch (TOLOWER(*p)) {
480 f |= US_FL_SANE_SENSE;
483 f |= US_FL_BAD_SENSE;
486 f |= US_FL_FIX_CAPACITY;
489 f |= US_FL_NO_READ_DISC_INFO;
492 f |= US_FL_NO_READ_CAPACITY_16;
495 f |= US_FL_CAPACITY_HEURISTICS;
498 f |= US_FL_IGNORE_DEVICE;
501 f |= US_FL_NO_REPORT_LUNS;
504 f |= US_FL_NOT_LOCKABLE;
507 f |= US_FL_MAX_SECTORS_64;
510 f |= US_FL_INITIAL_READ10;
513 f |= US_FL_CAPACITY_OK;
516 f |= US_FL_IGNORE_RESIDUE;
519 f |= US_FL_SINGLE_LUN;
522 f |= US_FL_NO_WP_DETECT;
524 /* Ignore unrecognized flag characters */
527 us->fflags = (us->fflags & ~mask) | f;
530 /* Get the unusual_devs entries and the string descriptors */
531 static int get_device_info(struct us_data *us, const struct usb_device_id *id,
532 struct us_unusual_dev *unusual_dev)
534 struct usb_device *dev = us->pusb_dev;
535 struct usb_interface_descriptor *idesc =
536 &us->pusb_intf->cur_altsetting->desc;
537 struct device *pdev = &us->pusb_intf->dev;
539 /* Store the entries */
540 us->unusual_dev = unusual_dev;
541 us->subclass = (unusual_dev->useProtocol == USB_SC_DEVICE) ?
542 idesc->bInterfaceSubClass :
543 unusual_dev->useProtocol;
544 us->protocol = (unusual_dev->useTransport == USB_PR_DEVICE) ?
545 idesc->bInterfaceProtocol :
546 unusual_dev->useTransport;
547 us->fflags = USB_US_ORIG_FLAGS(id->driver_info);
550 if (us->fflags & US_FL_IGNORE_DEVICE) {
551 dev_info(pdev, "device ignored\n");
556 * This flag is only needed when we're in high-speed, so let's
557 * disable it if we're in full-speed
559 if (dev->speed != USB_SPEED_HIGH)
560 us->fflags &= ~US_FL_GO_SLOW;
563 dev_info(pdev, "Quirks match for vid %04x pid %04x: %lx\n",
564 le16_to_cpu(dev->descriptor.idVendor),
565 le16_to_cpu(dev->descriptor.idProduct),
568 /* Log a message if a non-generic unusual_dev entry contains an
569 * unnecessary subclass or protocol override. This may stimulate
570 * reports from users that will help us remove unneeded entries
571 * from the unusual_devs.h table.
573 if (id->idVendor || id->idProduct) {
574 static const char *msgs[3] = {
575 "an unneeded SubClass entry",
576 "an unneeded Protocol entry",
577 "unneeded SubClass and Protocol entries"};
578 struct usb_device_descriptor *ddesc = &dev->descriptor;
581 if (unusual_dev->useProtocol != USB_SC_DEVICE &&
582 us->subclass == idesc->bInterfaceSubClass)
584 if (unusual_dev->useTransport != USB_PR_DEVICE &&
585 us->protocol == idesc->bInterfaceProtocol)
587 if (msg >= 0 && !(us->fflags & US_FL_NEED_OVERRIDE))
588 dev_notice(pdev, "This device "
589 "(%04x,%04x,%04x S %02x P %02x)"
590 " has %s in unusual_devs.h (kernel"
592 " Please send a copy of this message to "
593 "<linux-usb@vger.kernel.org> and "
594 "<usb-storage@lists.one-eyed-alien.net>\n",
595 le16_to_cpu(ddesc->idVendor),
596 le16_to_cpu(ddesc->idProduct),
597 le16_to_cpu(ddesc->bcdDevice),
598 idesc->bInterfaceSubClass,
599 idesc->bInterfaceProtocol,
607 /* Get the transport settings */
608 static void get_transport(struct us_data *us)
610 switch (us->protocol) {
612 us->transport_name = "Control/Bulk";
613 us->transport = usb_stor_CB_transport;
614 us->transport_reset = usb_stor_CB_reset;
619 us->transport_name = "Control/Bulk/Interrupt";
620 us->transport = usb_stor_CB_transport;
621 us->transport_reset = usb_stor_CB_reset;
626 us->transport_name = "Bulk";
627 us->transport = usb_stor_Bulk_transport;
628 us->transport_reset = usb_stor_Bulk_reset;
633 /* Get the protocol settings */
634 static void get_protocol(struct us_data *us)
636 switch (us->subclass) {
638 us->protocol_name = "Reduced Block Commands (RBC)";
639 us->proto_handler = usb_stor_transparent_scsi_command;
643 us->protocol_name = "8020i";
644 us->proto_handler = usb_stor_pad12_command;
649 us->protocol_name = "QIC-157";
650 us->proto_handler = usb_stor_pad12_command;
655 us->protocol_name = "8070i";
656 us->proto_handler = usb_stor_pad12_command;
661 us->protocol_name = "Transparent SCSI";
662 us->proto_handler = usb_stor_transparent_scsi_command;
666 us->protocol_name = "Uniform Floppy Interface (UFI)";
667 us->proto_handler = usb_stor_ufi_command;
672 /* Get the pipe settings */
673 static int get_pipes(struct us_data *us)
675 struct usb_host_interface *altsetting =
676 us->pusb_intf->cur_altsetting;
678 struct usb_endpoint_descriptor *ep;
679 struct usb_endpoint_descriptor *ep_in = NULL;
680 struct usb_endpoint_descriptor *ep_out = NULL;
681 struct usb_endpoint_descriptor *ep_int = NULL;
684 * Find the first endpoint of each type we need.
685 * We are expecting a minimum of 2 endpoints - in and out (bulk).
686 * An optional interrupt-in is OK (necessary for CBI protocol).
687 * We will ignore any others.
689 for (i = 0; i < altsetting->desc.bNumEndpoints; i++) {
690 ep = &altsetting->endpoint[i].desc;
692 if (usb_endpoint_xfer_bulk(ep)) {
693 if (usb_endpoint_dir_in(ep)) {
702 else if (usb_endpoint_is_int_in(ep)) {
708 if (!ep_in || !ep_out || (us->protocol == USB_PR_CBI && !ep_int)) {
709 US_DEBUGP("Endpoint sanity check failed! Rejecting dev.\n");
713 /* Calculate and store the pipe values */
714 us->send_ctrl_pipe = usb_sndctrlpipe(us->pusb_dev, 0);
715 us->recv_ctrl_pipe = usb_rcvctrlpipe(us->pusb_dev, 0);
716 us->send_bulk_pipe = usb_sndbulkpipe(us->pusb_dev,
717 usb_endpoint_num(ep_out));
718 us->recv_bulk_pipe = usb_rcvbulkpipe(us->pusb_dev,
719 usb_endpoint_num(ep_in));
721 us->recv_intr_pipe = usb_rcvintpipe(us->pusb_dev,
722 usb_endpoint_num(ep_int));
723 us->ep_bInterval = ep_int->bInterval;
728 /* Initialize all the dynamic resources we need */
729 static int usb_stor_acquire_resources(struct us_data *us)
732 struct task_struct *th;
734 us->current_urb = usb_alloc_urb(0, GFP_KERNEL);
735 if (!us->current_urb) {
736 US_DEBUGP("URB allocation failed\n");
740 /* Just before we start our control thread, initialize
741 * the device if it needs initialization */
742 if (us->unusual_dev->initFunction) {
743 p = us->unusual_dev->initFunction(us);
748 /* Start up our control thread */
749 th = kthread_run(usb_stor_control_thread, us, "usb-storage");
751 dev_warn(&us->pusb_intf->dev,
752 "Unable to start control thread\n");
760 /* Release all our dynamic resources */
761 static void usb_stor_release_resources(struct us_data *us)
763 US_DEBUGP("-- %s\n", __func__);
765 /* Tell the control thread to exit. The SCSI host must
766 * already have been removed and the DISCONNECTING flag set
767 * so that we won't accept any more commands.
769 US_DEBUGP("-- sending exit command to thread\n");
770 complete(&us->cmnd_ready);
772 kthread_stop(us->ctl_thread);
774 /* Call the destructor routine, if it exists */
775 if (us->extra_destructor) {
776 US_DEBUGP("-- calling extra_destructor()\n");
777 us->extra_destructor(us->extra);
780 /* Free the extra data and the URB */
782 usb_free_urb(us->current_urb);
785 /* Dissociate from the USB device */
786 static void dissociate_dev(struct us_data *us)
788 US_DEBUGP("-- %s\n", __func__);
790 /* Free the buffers */
792 usb_free_coherent(us->pusb_dev, US_IOBUF_SIZE, us->iobuf, us->iobuf_dma);
794 /* Remove our private data from the interface */
795 usb_set_intfdata(us->pusb_intf, NULL);
798 /* First stage of disconnect processing: stop SCSI scanning,
799 * remove the host, and stop accepting new commands
801 static void quiesce_and_remove_host(struct us_data *us)
803 struct Scsi_Host *host = us_to_host(us);
805 /* If the device is really gone, cut short reset delays */
806 if (us->pusb_dev->state == USB_STATE_NOTATTACHED) {
807 set_bit(US_FLIDX_DISCONNECTING, &us->dflags);
808 wake_up(&us->delay_wait);
811 /* Prevent SCSI scanning (if it hasn't started yet)
812 * or wait for the SCSI-scanning routine to stop.
814 cancel_delayed_work_sync(&us->scan_dwork);
816 /* Balance autopm calls if scanning was cancelled */
817 if (test_bit(US_FLIDX_SCAN_PENDING, &us->dflags))
818 usb_autopm_put_interface_no_suspend(us->pusb_intf);
820 /* Removing the host will perform an orderly shutdown: caches
821 * synchronized, disks spun down, etc.
823 scsi_remove_host(host);
825 /* Prevent any new commands from being accepted and cut short
829 set_bit(US_FLIDX_DISCONNECTING, &us->dflags);
831 wake_up(&us->delay_wait);
834 /* Second stage of disconnect processing: deallocate all resources */
835 static void release_everything(struct us_data *us)
837 usb_stor_release_resources(us);
840 /* Drop our reference to the host; the SCSI core will free it
841 * (and "us" along with it) when the refcount becomes 0. */
842 scsi_host_put(us_to_host(us));
845 /* Delayed-work routine to carry out SCSI-device scanning */
846 static void usb_stor_scan_dwork(struct work_struct *work)
848 struct us_data *us = container_of(work, struct us_data,
850 struct device *dev = &us->pusb_intf->dev;
852 dev_dbg(dev, "starting scan\n");
854 /* For bulk-only devices, determine the max LUN value */
855 if (us->protocol == USB_PR_BULK && !(us->fflags & US_FL_SINGLE_LUN)) {
856 mutex_lock(&us->dev_mutex);
857 us->max_lun = usb_stor_Bulk_max_lun(us);
858 mutex_unlock(&us->dev_mutex);
860 scsi_scan_host(us_to_host(us));
861 dev_dbg(dev, "scan complete\n");
863 /* Should we unbind if no devices were detected? */
865 usb_autopm_put_interface(us->pusb_intf);
866 clear_bit(US_FLIDX_SCAN_PENDING, &us->dflags);
869 static unsigned int usb_stor_sg_tablesize(struct usb_interface *intf)
871 struct usb_device *usb_dev = interface_to_usbdev(intf);
873 if (usb_dev->bus->sg_tablesize) {
874 return usb_dev->bus->sg_tablesize;
879 /* First part of general USB mass-storage probing */
880 int usb_stor_probe1(struct us_data **pus,
881 struct usb_interface *intf,
882 const struct usb_device_id *id,
883 struct us_unusual_dev *unusual_dev)
885 struct Scsi_Host *host;
889 US_DEBUGP("USB Mass Storage device detected\n");
892 * Ask the SCSI layer to allocate a host structure, with extra
893 * space at the end for our private us_data structure.
895 host = scsi_host_alloc(&usb_stor_host_template, sizeof(*us));
898 "Unable to allocate the scsi host\n");
903 * Allow 16-byte CDBs and thus > 2TB
905 host->max_cmd_len = 16;
906 host->sg_tablesize = usb_stor_sg_tablesize(intf);
907 *pus = us = host_to_us(host);
908 memset(us, 0, sizeof(struct us_data));
909 mutex_init(&(us->dev_mutex));
910 init_completion(&us->cmnd_ready);
911 init_completion(&(us->notify));
912 init_waitqueue_head(&us->delay_wait);
913 INIT_DELAYED_WORK(&us->scan_dwork, usb_stor_scan_dwork);
915 /* Associate the us_data structure with the USB device */
916 result = associate_dev(us, intf);
920 /* Get the unusual_devs entries and the descriptors */
921 result = get_device_info(us, id, unusual_dev);
925 /* Get standard transport and protocol settings */
929 /* Give the caller a chance to fill in specialized transport
930 * or protocol settings.
935 US_DEBUGP("storage_probe() failed\n");
936 release_everything(us);
939 EXPORT_SYMBOL_GPL(usb_stor_probe1);
941 /* Second part of general USB mass-storage probing */
942 int usb_stor_probe2(struct us_data *us)
945 struct device *dev = &us->pusb_intf->dev;
947 /* Make sure the transport and protocol have both been set */
948 if (!us->transport || !us->proto_handler) {
952 US_DEBUGP("Transport: %s\n", us->transport_name);
953 US_DEBUGP("Protocol: %s\n", us->protocol_name);
955 /* fix for single-lun devices */
956 if (us->fflags & US_FL_SINGLE_LUN)
959 /* Find the endpoints and calculate pipe values */
960 result = get_pipes(us);
965 * If the device returns invalid data for the first READ(10)
966 * command, indicate the command should be retried.
968 if (us->fflags & US_FL_INITIAL_READ10)
969 set_bit(US_FLIDX_REDO_READ10, &us->dflags);
971 /* Acquire all the other resources and add the host */
972 result = usb_stor_acquire_resources(us);
975 snprintf(us->scsi_name, sizeof(us->scsi_name), "usb-storage %s",
976 dev_name(&us->pusb_intf->dev));
977 result = scsi_add_host(us_to_host(us), dev);
980 "Unable to add the scsi host\n");
984 /* Submit the delayed_work for SCSI-device scanning */
985 usb_autopm_get_interface_no_resume(us->pusb_intf);
986 set_bit(US_FLIDX_SCAN_PENDING, &us->dflags);
989 dev_dbg(dev, "waiting for device to settle before scanning\n");
990 queue_delayed_work(system_freezable_wq, &us->scan_dwork,
994 /* We come here if there are any problems */
996 US_DEBUGP("storage_probe() failed\n");
997 release_everything(us);
1000 EXPORT_SYMBOL_GPL(usb_stor_probe2);
1002 /* Handle a USB mass-storage disconnect */
1003 void usb_stor_disconnect(struct usb_interface *intf)
1005 struct us_data *us = usb_get_intfdata(intf);
1007 US_DEBUGP("storage_disconnect() called\n");
1008 quiesce_and_remove_host(us);
1009 release_everything(us);
1011 EXPORT_SYMBOL_GPL(usb_stor_disconnect);
1013 /* The main probe routine for standard devices */
1014 static int storage_probe(struct usb_interface *intf,
1015 const struct usb_device_id *id)
1021 * If libusual is configured, let it decide whether a standard
1022 * device should be handled by usb-storage or by ub.
1023 * If the device isn't standard (is handled by a subdriver
1024 * module) then don't accept it.
1026 if (usb_usual_check_type(id, USB_US_TYPE_STOR) ||
1027 usb_usual_ignore_device(intf))
1031 * Call the general probe procedures.
1033 * The unusual_dev_list array is parallel to the usb_storage_usb_ids
1034 * table, so we use the index of the id entry to find the
1035 * corresponding unusual_devs entry.
1037 result = usb_stor_probe1(&us, intf, id,
1038 (id - usb_storage_usb_ids) + us_unusual_dev_list);
1042 /* No special transport or protocol settings in the main module */
1044 result = usb_stor_probe2(us);
1048 /***********************************************************************
1049 * Initialization and registration
1050 ***********************************************************************/
1052 static struct usb_driver usb_storage_driver = {
1053 .name = "usb-storage",
1054 .probe = storage_probe,
1055 .disconnect = usb_stor_disconnect,
1056 .suspend = usb_stor_suspend,
1057 .resume = usb_stor_resume,
1058 .reset_resume = usb_stor_reset_resume,
1059 .pre_reset = usb_stor_pre_reset,
1060 .post_reset = usb_stor_post_reset,
1061 .id_table = usb_storage_usb_ids,
1062 .supports_autosuspend = 1,
1067 static int __init usb_stor_init(void)
1071 pr_info("Initializing USB Mass Storage driver...\n");
1073 /* register the driver, return usb_register return code if error */
1074 retval = usb_register(&usb_storage_driver);
1076 pr_info("USB Mass Storage support registered.\n");
1077 usb_usual_set_present(USB_US_TYPE_STOR);
1082 static void __exit usb_stor_exit(void)
1084 US_DEBUGP("usb_stor_exit() called\n");
1086 /* Deregister the driver
1087 * This will cause disconnect() to be called for each
1090 US_DEBUGP("-- calling usb_deregister()\n");
1091 usb_deregister(&usb_storage_driver) ;
1093 usb_usual_clear_present(USB_US_TYPE_STOR);
1096 module_init(usb_stor_init);
1097 module_exit(usb_stor_exit);