1 /* Driver for USB Mass Storage compliant devices
3 * $Id: usb.c,v 1.75 2002/04/22 03:39:43 mdharm Exp $
5 * Current development and maintenance by:
6 * (c) 1999-2003 Matthew Dharm (mdharm-usb@one-eyed-alien.net)
8 * Developed with the assistance of:
9 * (c) 2000 David L. Brown, Jr. (usb-storage@davidb.org)
10 * (c) 2003 Alan Stern (stern@rowland.harvard.edu)
13 * (c) 1999 Michael Gee (michael@linuxspecific.com)
15 * usb_device_id support by Adam J. Richter (adam@yggdrasil.com):
16 * (c) 2000 Yggdrasil Computing, Inc.
18 * This driver is based on the 'USB Mass Storage Class' document. This
19 * describes in detail the protocol used to communicate with such
20 * devices. Clearly, the designers had SCSI and ATAPI commands in
21 * mind when they created this document. The commands are all very
22 * similar to commands in the SCSI-II and ATAPI specifications.
24 * It is important to note that in a number of cases this class
25 * exhibits class-specific exemptions from the USB specification.
26 * Notably the usage of NAK, STALL and ACK differs from the norm, in
27 * that they are used to communicate wait, failed and OK on commands.
29 * Also, for certain devices, the interrupt endpoint is used to convey
30 * status of a command.
32 * Please see http://www.one-eyed-alien.net/~mdharm/linux-usb for more
33 * information about this driver.
35 * This program is free software; you can redistribute it and/or modify it
36 * under the terms of the GNU General Public License as published by the
37 * Free Software Foundation; either version 2, or (at your option) any
40 * This program is distributed in the hope that it will be useful, but
41 * WITHOUT ANY WARRANTY; without even the implied warranty of
42 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
43 * General Public License for more details.
45 * You should have received a copy of the GNU General Public License along
46 * with this program; if not, write to the Free Software Foundation, Inc.,
47 * 675 Mass Ave, Cambridge, MA 02139, USA.
50 #include <linux/sched.h>
51 #include <linux/errno.h>
52 #include <linux/freezer.h>
53 #include <linux/module.h>
54 #include <linux/init.h>
55 #include <linux/slab.h>
56 #include <linux/kthread.h>
57 #include <linux/mutex.h>
58 #include <linux/utsname.h>
60 #include <scsi/scsi.h>
61 #include <scsi/scsi_cmnd.h>
62 #include <scsi/scsi_device.h>
66 #include "transport.h"
69 #include "initializers.h"
71 #ifdef CONFIG_USB_STORAGE_USBAT
72 #include "shuttle_usbat.h"
74 #ifdef CONFIG_USB_STORAGE_SDDR09
77 #ifdef CONFIG_USB_STORAGE_SDDR55
80 #ifdef CONFIG_USB_STORAGE_DPCM
83 #ifdef CONFIG_USB_STORAGE_FREECOM
86 #ifdef CONFIG_USB_STORAGE_ISD200
89 #ifdef CONFIG_USB_STORAGE_DATAFAB
92 #ifdef CONFIG_USB_STORAGE_JUMPSHOT
95 #ifdef CONFIG_USB_STORAGE_ONETOUCH
98 #ifdef CONFIG_USB_STORAGE_ALAUDA
101 #ifdef CONFIG_USB_STORAGE_KARMA
105 /* Some informational data */
106 MODULE_AUTHOR("Matthew Dharm <mdharm-usb@one-eyed-alien.net>");
107 MODULE_DESCRIPTION("USB Mass Storage driver for Linux");
108 MODULE_LICENSE("GPL");
110 static unsigned int delay_use = 5;
111 module_param(delay_use, uint, S_IRUGO | S_IWUSR);
112 MODULE_PARM_DESC(delay_use, "seconds to delay before using a new device");
115 /* These are used to make sure the module doesn't unload before all the
116 * threads have exited.
118 static atomic_t total_threads = ATOMIC_INIT(0);
119 static DECLARE_COMPLETION(threads_gone);
123 * The entries in this table correspond, line for line,
124 * with the entries of us_unusual_dev_list[].
126 #ifndef CONFIG_USB_LIBUSUAL
128 #define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \
129 vendorName, productName,useProtocol, useTransport, \
130 initFunction, flags) \
131 { USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin,bcdDeviceMax), \
132 .driver_info = (flags)|(USB_US_TYPE_STOR<<24) }
134 #define USUAL_DEV(useProto, useTrans, useType) \
135 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, useProto, useTrans), \
136 .driver_info = (USB_US_TYPE_STOR<<24) }
138 static struct usb_device_id storage_usb_ids [] = {
140 # include "unusual_devs.h"
143 /* Terminating entry */
147 MODULE_DEVICE_TABLE (usb, storage_usb_ids);
148 #endif /* CONFIG_USB_LIBUSUAL */
150 /* This is the list of devices we recognize, along with their flag data */
152 /* The vendor name should be kept at eight characters or less, and
153 * the product name should be kept at 16 characters or less. If a device
154 * has the US_FL_FIX_INQUIRY flag, then the vendor and product names
155 * normally generated by a device thorugh the INQUIRY response will be
156 * taken from this list, and this is the reason for the above size
157 * restriction. However, if the flag is not present, then you
158 * are free to use as many characters as you like.
161 #define UNUSUAL_DEV(idVendor, idProduct, bcdDeviceMin, bcdDeviceMax, \
162 vendor_name, product_name, use_protocol, use_transport, \
163 init_function, Flags) \
165 .vendorName = vendor_name, \
166 .productName = product_name, \
167 .useProtocol = use_protocol, \
168 .useTransport = use_transport, \
169 .initFunction = init_function, \
172 #define USUAL_DEV(use_protocol, use_transport, use_type) \
174 .useProtocol = use_protocol, \
175 .useTransport = use_transport, \
178 static struct us_unusual_dev us_unusual_dev_list[] = {
179 # include "unusual_devs.h"
183 /* Terminating entry */
188 #ifdef CONFIG_PM /* Minimal support for suspend and resume */
190 static int storage_suspend(struct usb_interface *iface, pm_message_t message)
192 struct us_data *us = usb_get_intfdata(iface);
194 /* Wait until no command is running */
195 mutex_lock(&us->dev_mutex);
197 US_DEBUGP("%s\n", __FUNCTION__);
198 if (us->suspend_resume_hook)
199 (us->suspend_resume_hook)(us, US_SUSPEND);
201 /* When runtime PM is working, we'll set a flag to indicate
202 * whether we should autoresume when a SCSI request arrives. */
204 mutex_unlock(&us->dev_mutex);
208 static int storage_resume(struct usb_interface *iface)
210 struct us_data *us = usb_get_intfdata(iface);
212 mutex_lock(&us->dev_mutex);
214 US_DEBUGP("%s\n", __FUNCTION__);
215 if (us->suspend_resume_hook)
216 (us->suspend_resume_hook)(us, US_RESUME);
218 mutex_unlock(&us->dev_mutex);
222 static int storage_reset_resume(struct usb_interface *iface)
224 struct us_data *us = usb_get_intfdata(iface);
226 US_DEBUGP("%s\n", __FUNCTION__);
228 /* Report the reset to the SCSI core */
229 usb_stor_report_bus_reset(us);
231 /* FIXME: Notify the subdrivers that they need to reinitialize
236 #endif /* CONFIG_PM */
239 * The next two routines get called just before and just after
240 * a USB port reset, whether from this driver or a different one.
243 static int storage_pre_reset(struct usb_interface *iface)
245 struct us_data *us = usb_get_intfdata(iface);
247 US_DEBUGP("%s\n", __FUNCTION__);
249 /* Make sure no command runs during the reset */
250 mutex_lock(&us->dev_mutex);
254 static int storage_post_reset(struct usb_interface *iface)
256 struct us_data *us = usb_get_intfdata(iface);
258 US_DEBUGP("%s\n", __FUNCTION__);
260 /* Report the reset to the SCSI core */
261 usb_stor_report_bus_reset(us);
263 /* FIXME: Notify the subdrivers that they need to reinitialize
266 mutex_unlock(&us->dev_mutex);
271 * fill_inquiry_response takes an unsigned char array (which must
272 * be at least 36 characters) and populates the vendor name,
273 * product name, and revision fields. Then the array is copied
274 * into the SCSI command's response buffer (oddly enough
275 * called request_buffer). data_len contains the length of the
276 * data array, which again must be at least 36.
279 void fill_inquiry_response(struct us_data *us, unsigned char *data,
280 unsigned int data_len)
282 if (data_len<36) // You lose.
285 if(data[0]&0x20) { /* USB device currently not connected. Return
286 peripheral qualifier 001b ("...however, the
287 physical device is not currently connected
288 to this logical unit") and leave vendor and
289 product identification empty. ("If the target
290 does store some of the INQUIRY data on the
291 device, it may return zeros or ASCII spaces
292 (20h) in those fields until the data is
293 available from the device."). */
296 u16 bcdDevice = le16_to_cpu(us->pusb_dev->descriptor.bcdDevice);
297 memcpy(data+8, us->unusual_dev->vendorName,
298 strlen(us->unusual_dev->vendorName) > 8 ? 8 :
299 strlen(us->unusual_dev->vendorName));
300 memcpy(data+16, us->unusual_dev->productName,
301 strlen(us->unusual_dev->productName) > 16 ? 16 :
302 strlen(us->unusual_dev->productName));
303 data[32] = 0x30 + ((bcdDevice>>12) & 0x0F);
304 data[33] = 0x30 + ((bcdDevice>>8) & 0x0F);
305 data[34] = 0x30 + ((bcdDevice>>4) & 0x0F);
306 data[35] = 0x30 + ((bcdDevice) & 0x0F);
309 usb_stor_set_xfer_buf(data, data_len, us->srb);
312 static int usb_stor_control_thread(void * __us)
314 struct us_data *us = (struct us_data *)__us;
315 struct Scsi_Host *host = us_to_host(us);
317 current->flags |= PF_NOFREEZE;
320 US_DEBUGP("*** thread sleeping.\n");
321 if(down_interruptible(&us->sema))
324 US_DEBUGP("*** thread awakened.\n");
326 /* lock the device pointers */
327 mutex_lock(&(us->dev_mutex));
329 /* if the device has disconnected, we are free to exit */
330 if (test_bit(US_FLIDX_DISCONNECTING, &us->flags)) {
331 US_DEBUGP("-- exiting\n");
332 mutex_unlock(&us->dev_mutex);
336 /* lock access to the state */
339 /* has the command timed out *already* ? */
340 if (test_bit(US_FLIDX_TIMED_OUT, &us->flags)) {
341 us->srb->result = DID_ABORT << 16;
347 /* reject the command if the direction indicator
350 if (us->srb->sc_data_direction == DMA_BIDIRECTIONAL) {
351 US_DEBUGP("UNKNOWN data direction\n");
352 us->srb->result = DID_ERROR << 16;
355 /* reject if target != 0 or if LUN is higher than
356 * the maximum known LUN
358 else if (us->srb->device->id &&
359 !(us->flags & US_FL_SCM_MULT_TARG)) {
360 US_DEBUGP("Bad target number (%d:%d)\n",
361 us->srb->device->id, us->srb->device->lun);
362 us->srb->result = DID_BAD_TARGET << 16;
365 else if (us->srb->device->lun > us->max_lun) {
366 US_DEBUGP("Bad LUN (%d:%d)\n",
367 us->srb->device->id, us->srb->device->lun);
368 us->srb->result = DID_BAD_TARGET << 16;
371 /* Handle those devices which need us to fake
372 * their inquiry data */
373 else if ((us->srb->cmnd[0] == INQUIRY) &&
374 (us->flags & US_FL_FIX_INQUIRY)) {
375 unsigned char data_ptr[36] = {
376 0x00, 0x80, 0x02, 0x02,
377 0x1F, 0x00, 0x00, 0x00};
379 US_DEBUGP("Faking INQUIRY command\n");
380 fill_inquiry_response(us, data_ptr, 36);
381 us->srb->result = SAM_STAT_GOOD;
384 /* we've got a command, let's do it! */
386 US_DEBUG(usb_stor_show_command(us->srb));
387 us->proto_handler(us->srb, us);
390 /* lock access to the state */
393 /* did the command already complete because of a disconnect? */
395 ; /* nothing to do */
397 /* indicate that the command is done */
398 else if (us->srb->result != DID_ABORT << 16) {
399 US_DEBUGP("scsi cmd done, result=0x%x\n",
401 us->srb->scsi_done(us->srb);
404 US_DEBUGP("scsi command aborted\n");
407 /* If an abort request was received we need to signal that
408 * the abort has finished. The proper test for this is
409 * the TIMED_OUT flag, not srb->result == DID_ABORT, because
410 * the timeout might have occurred after the command had
411 * already completed with a different result code. */
412 if (test_bit(US_FLIDX_TIMED_OUT, &us->flags)) {
413 complete(&(us->notify));
415 /* Allow USB transfers to resume */
416 clear_bit(US_FLIDX_ABORTING, &us->flags);
417 clear_bit(US_FLIDX_TIMED_OUT, &us->flags);
420 /* finished working on this command */
424 /* unlock the device pointers */
425 mutex_unlock(&us->dev_mutex);
428 /* Wait until we are told to stop */
430 set_current_state(TASK_INTERRUPTIBLE);
431 if (kthread_should_stop())
435 __set_current_state(TASK_RUNNING);
439 /***********************************************************************
440 * Device probing and disconnecting
441 ***********************************************************************/
443 /* Associate our private data with the USB device */
444 static int associate_dev(struct us_data *us, struct usb_interface *intf)
446 US_DEBUGP("-- %s\n", __FUNCTION__);
448 /* Fill in the device-related fields */
449 us->pusb_dev = interface_to_usbdev(intf);
450 us->pusb_intf = intf;
451 us->ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
452 US_DEBUGP("Vendor: 0x%04x, Product: 0x%04x, Revision: 0x%04x\n",
453 le16_to_cpu(us->pusb_dev->descriptor.idVendor),
454 le16_to_cpu(us->pusb_dev->descriptor.idProduct),
455 le16_to_cpu(us->pusb_dev->descriptor.bcdDevice));
456 US_DEBUGP("Interface Subclass: 0x%02x, Protocol: 0x%02x\n",
457 intf->cur_altsetting->desc.bInterfaceSubClass,
458 intf->cur_altsetting->desc.bInterfaceProtocol);
460 /* Store our private data in the interface */
461 usb_set_intfdata(intf, us);
463 /* Allocate the device-related DMA-mapped buffers */
464 us->cr = usb_buffer_alloc(us->pusb_dev, sizeof(*us->cr),
465 GFP_KERNEL, &us->cr_dma);
467 US_DEBUGP("usb_ctrlrequest allocation failed\n");
471 us->iobuf = usb_buffer_alloc(us->pusb_dev, US_IOBUF_SIZE,
472 GFP_KERNEL, &us->iobuf_dma);
474 US_DEBUGP("I/O buffer allocation failed\n");
478 us->sensebuf = kmalloc(US_SENSE_SIZE, GFP_KERNEL);
480 US_DEBUGP("Sense buffer allocation failed\n");
486 /* Find an unusual_dev descriptor (always succeeds in the current code) */
487 static struct us_unusual_dev *find_unusual(const struct usb_device_id *id)
489 const int id_index = id - storage_usb_ids;
490 return &us_unusual_dev_list[id_index];
493 /* Get the unusual_devs entries and the string descriptors */
494 static int get_device_info(struct us_data *us, const struct usb_device_id *id)
496 struct usb_device *dev = us->pusb_dev;
497 struct usb_interface_descriptor *idesc =
498 &us->pusb_intf->cur_altsetting->desc;
499 struct us_unusual_dev *unusual_dev = find_unusual(id);
501 /* Store the entries */
502 us->unusual_dev = unusual_dev;
503 us->subclass = (unusual_dev->useProtocol == US_SC_DEVICE) ?
504 idesc->bInterfaceSubClass :
505 unusual_dev->useProtocol;
506 us->protocol = (unusual_dev->useTransport == US_PR_DEVICE) ?
507 idesc->bInterfaceProtocol :
508 unusual_dev->useTransport;
509 us->flags = USB_US_ORIG_FLAGS(id->driver_info);
511 if (us->flags & US_FL_IGNORE_DEVICE) {
512 printk(KERN_INFO USB_STORAGE "device ignored\n");
517 * This flag is only needed when we're in high-speed, so let's
518 * disable it if we're in full-speed
520 if (dev->speed != USB_SPEED_HIGH)
521 us->flags &= ~US_FL_GO_SLOW;
523 /* Log a message if a non-generic unusual_dev entry contains an
524 * unnecessary subclass or protocol override. This may stimulate
525 * reports from users that will help us remove unneeded entries
526 * from the unusual_devs.h table.
528 if (id->idVendor || id->idProduct) {
529 static const char *msgs[3] = {
530 "an unneeded SubClass entry",
531 "an unneeded Protocol entry",
532 "unneeded SubClass and Protocol entries"};
533 struct usb_device_descriptor *ddesc = &dev->descriptor;
536 if (unusual_dev->useProtocol != US_SC_DEVICE &&
537 us->subclass == idesc->bInterfaceSubClass)
539 if (unusual_dev->useTransport != US_PR_DEVICE &&
540 us->protocol == idesc->bInterfaceProtocol)
542 if (msg >= 0 && !(us->flags & US_FL_NEED_OVERRIDE))
543 printk(KERN_NOTICE USB_STORAGE "This device "
544 "(%04x,%04x,%04x S %02x P %02x)"
545 " has %s in unusual_devs.h (kernel"
547 " Please send a copy of this message to "
548 "<linux-usb-devel@lists.sourceforge.net>\n",
549 le16_to_cpu(ddesc->idVendor),
550 le16_to_cpu(ddesc->idProduct),
551 le16_to_cpu(ddesc->bcdDevice),
552 idesc->bInterfaceSubClass,
553 idesc->bInterfaceProtocol,
561 /* Get the transport settings */
562 static int get_transport(struct us_data *us)
564 switch (us->protocol) {
566 us->transport_name = "Control/Bulk";
567 us->transport = usb_stor_CB_transport;
568 us->transport_reset = usb_stor_CB_reset;
573 us->transport_name = "Control/Bulk/Interrupt";
574 us->transport = usb_stor_CBI_transport;
575 us->transport_reset = usb_stor_CB_reset;
580 us->transport_name = "Bulk";
581 us->transport = usb_stor_Bulk_transport;
582 us->transport_reset = usb_stor_Bulk_reset;
585 #ifdef CONFIG_USB_STORAGE_USBAT
587 us->transport_name = "Shuttle USBAT";
588 us->transport = usbat_transport;
589 us->transport_reset = usb_stor_CB_reset;
594 #ifdef CONFIG_USB_STORAGE_SDDR09
595 case US_PR_EUSB_SDDR09:
596 us->transport_name = "EUSB/SDDR09";
597 us->transport = sddr09_transport;
598 us->transport_reset = usb_stor_CB_reset;
603 #ifdef CONFIG_USB_STORAGE_SDDR55
605 us->transport_name = "SDDR55";
606 us->transport = sddr55_transport;
607 us->transport_reset = sddr55_reset;
612 #ifdef CONFIG_USB_STORAGE_DPCM
614 us->transport_name = "Control/Bulk-EUSB/SDDR09";
615 us->transport = dpcm_transport;
616 us->transport_reset = usb_stor_CB_reset;
621 #ifdef CONFIG_USB_STORAGE_FREECOM
623 us->transport_name = "Freecom";
624 us->transport = freecom_transport;
625 us->transport_reset = usb_stor_freecom_reset;
630 #ifdef CONFIG_USB_STORAGE_DATAFAB
632 us->transport_name = "Datafab Bulk-Only";
633 us->transport = datafab_transport;
634 us->transport_reset = usb_stor_Bulk_reset;
639 #ifdef CONFIG_USB_STORAGE_JUMPSHOT
641 us->transport_name = "Lexar Jumpshot Control/Bulk";
642 us->transport = jumpshot_transport;
643 us->transport_reset = usb_stor_Bulk_reset;
648 #ifdef CONFIG_USB_STORAGE_ALAUDA
650 us->transport_name = "Alauda Control/Bulk";
651 us->transport = alauda_transport;
652 us->transport_reset = usb_stor_Bulk_reset;
657 #ifdef CONFIG_USB_STORAGE_KARMA
659 us->transport_name = "Rio Karma/Bulk";
660 us->transport = rio_karma_transport;
661 us->transport_reset = usb_stor_Bulk_reset;
668 US_DEBUGP("Transport: %s\n", us->transport_name);
670 /* fix for single-lun devices */
671 if (us->flags & US_FL_SINGLE_LUN)
676 /* Get the protocol settings */
677 static int get_protocol(struct us_data *us)
679 switch (us->subclass) {
681 us->protocol_name = "Reduced Block Commands (RBC)";
682 us->proto_handler = usb_stor_transparent_scsi_command;
686 us->protocol_name = "8020i";
687 us->proto_handler = usb_stor_ATAPI_command;
692 us->protocol_name = "QIC-157";
693 us->proto_handler = usb_stor_qic157_command;
698 us->protocol_name = "8070i";
699 us->proto_handler = usb_stor_ATAPI_command;
704 us->protocol_name = "Transparent SCSI";
705 us->proto_handler = usb_stor_transparent_scsi_command;
709 us->protocol_name = "Uniform Floppy Interface (UFI)";
710 us->proto_handler = usb_stor_ufi_command;
713 #ifdef CONFIG_USB_STORAGE_ISD200
715 us->protocol_name = "ISD200 ATA/ATAPI";
716 us->proto_handler = isd200_ata_command;
723 US_DEBUGP("Protocol: %s\n", us->protocol_name);
727 /* Get the pipe settings */
728 static int get_pipes(struct us_data *us)
730 struct usb_host_interface *altsetting =
731 us->pusb_intf->cur_altsetting;
733 struct usb_endpoint_descriptor *ep;
734 struct usb_endpoint_descriptor *ep_in = NULL;
735 struct usb_endpoint_descriptor *ep_out = NULL;
736 struct usb_endpoint_descriptor *ep_int = NULL;
739 * Find the first endpoint of each type we need.
740 * We are expecting a minimum of 2 endpoints - in and out (bulk).
741 * An optional interrupt-in is OK (necessary for CBI protocol).
742 * We will ignore any others.
744 for (i = 0; i < altsetting->desc.bNumEndpoints; i++) {
745 ep = &altsetting->endpoint[i].desc;
747 if (usb_endpoint_xfer_bulk(ep)) {
748 if (usb_endpoint_dir_in(ep)) {
757 else if (usb_endpoint_is_int_in(ep)) {
763 if (!ep_in || !ep_out || (us->protocol == US_PR_CBI && !ep_int)) {
764 US_DEBUGP("Endpoint sanity check failed! Rejecting dev.\n");
768 /* Calculate and store the pipe values */
769 us->send_ctrl_pipe = usb_sndctrlpipe(us->pusb_dev, 0);
770 us->recv_ctrl_pipe = usb_rcvctrlpipe(us->pusb_dev, 0);
771 us->send_bulk_pipe = usb_sndbulkpipe(us->pusb_dev,
772 ep_out->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
773 us->recv_bulk_pipe = usb_rcvbulkpipe(us->pusb_dev,
774 ep_in->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
776 us->recv_intr_pipe = usb_rcvintpipe(us->pusb_dev,
777 ep_int->bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
778 us->ep_bInterval = ep_int->bInterval;
783 /* Initialize all the dynamic resources we need */
784 static int usb_stor_acquire_resources(struct us_data *us)
787 struct task_struct *th;
789 us->current_urb = usb_alloc_urb(0, GFP_KERNEL);
790 if (!us->current_urb) {
791 US_DEBUGP("URB allocation failed\n");
795 /* Just before we start our control thread, initialize
796 * the device if it needs initialization */
797 if (us->unusual_dev->initFunction) {
798 p = us->unusual_dev->initFunction(us);
803 /* Start up our control thread */
804 th = kthread_run(usb_stor_control_thread, us, "usb-storage");
806 printk(KERN_WARNING USB_STORAGE
807 "Unable to start control thread\n");
815 /* Release all our dynamic resources */
816 static void usb_stor_release_resources(struct us_data *us)
818 US_DEBUGP("-- %s\n", __FUNCTION__);
820 /* Tell the control thread to exit. The SCSI host must
821 * already have been removed so it won't try to queue
824 US_DEBUGP("-- sending exit command to thread\n");
825 set_bit(US_FLIDX_DISCONNECTING, &us->flags);
828 kthread_stop(us->ctl_thread);
830 /* Call the destructor routine, if it exists */
831 if (us->extra_destructor) {
832 US_DEBUGP("-- calling extra_destructor()\n");
833 us->extra_destructor(us->extra);
836 /* Free the extra data and the URB */
838 usb_free_urb(us->current_urb);
841 /* Dissociate from the USB device */
842 static void dissociate_dev(struct us_data *us)
844 US_DEBUGP("-- %s\n", __FUNCTION__);
848 /* Free the device-related DMA-mapped buffers */
850 usb_buffer_free(us->pusb_dev, sizeof(*us->cr), us->cr,
853 usb_buffer_free(us->pusb_dev, US_IOBUF_SIZE, us->iobuf,
856 /* Remove our private data from the interface */
857 usb_set_intfdata(us->pusb_intf, NULL);
860 /* First stage of disconnect processing: stop all commands and remove
862 static void quiesce_and_remove_host(struct us_data *us)
864 struct Scsi_Host *host = us_to_host(us);
866 /* Prevent new USB transfers, stop the current command, and
867 * interrupt a SCSI-scan or device-reset delay */
869 set_bit(US_FLIDX_DISCONNECTING, &us->flags);
871 usb_stor_stop_transport(us);
872 wake_up(&us->delay_wait);
874 /* It doesn't matter if the SCSI-scanning thread is still running.
875 * The thread will exit when it sees the DISCONNECTING flag. */
877 /* queuecommand won't accept any new commands and the control
878 * thread won't execute a previously-queued command. If there
879 * is such a command pending, complete it with an error. */
880 mutex_lock(&us->dev_mutex);
882 us->srb->result = DID_NO_CONNECT << 16;
884 us->srb->scsi_done(us->srb);
888 mutex_unlock(&us->dev_mutex);
890 /* Now we own no commands so it's safe to remove the SCSI host */
891 scsi_remove_host(host);
894 /* Second stage of disconnect processing: deallocate all resources */
895 static void release_everything(struct us_data *us)
897 usb_stor_release_resources(us);
900 /* Drop our reference to the host; the SCSI core will free it
901 * (and "us" along with it) when the refcount becomes 0. */
902 scsi_host_put(us_to_host(us));
905 /* Thread to carry out delayed SCSI-device scanning */
906 static int usb_stor_scan_thread(void * __us)
908 struct us_data *us = (struct us_data *)__us;
911 "usb-storage: device found at %d\n", us->pusb_dev->devnum);
913 /* Wait for the timeout to expire or for a disconnect */
915 printk(KERN_DEBUG "usb-storage: waiting for device "
916 "to settle before scanning\n");
918 wait_event_interruptible_timeout(us->delay_wait,
919 test_bit(US_FLIDX_DISCONNECTING, &us->flags),
925 /* If the device is still connected, perform the scanning */
926 if (!test_bit(US_FLIDX_DISCONNECTING, &us->flags)) {
928 /* For bulk-only devices, determine the max LUN value */
929 if (us->protocol == US_PR_BULK &&
930 !(us->flags & US_FL_SINGLE_LUN)) {
931 mutex_lock(&us->dev_mutex);
932 us->max_lun = usb_stor_Bulk_max_lun(us);
933 mutex_unlock(&us->dev_mutex);
935 scsi_scan_host(us_to_host(us));
936 printk(KERN_DEBUG "usb-storage: device scan complete\n");
938 /* Should we unbind if no devices were detected? */
941 scsi_host_put(us_to_host(us));
942 complete_and_exit(&threads_gone, 0);
946 /* Probe to see if we can drive a newly-connected USB device */
947 static int storage_probe(struct usb_interface *intf,
948 const struct usb_device_id *id)
950 struct Scsi_Host *host;
953 struct task_struct *th;
955 if (usb_usual_check_type(id, USB_US_TYPE_STOR))
958 US_DEBUGP("USB Mass Storage device detected\n");
961 * Ask the SCSI layer to allocate a host structure, with extra
962 * space at the end for our private us_data structure.
964 host = scsi_host_alloc(&usb_stor_host_template, sizeof(*us));
966 printk(KERN_WARNING USB_STORAGE
967 "Unable to allocate the scsi host\n");
971 us = host_to_us(host);
972 memset(us, 0, sizeof(struct us_data));
973 mutex_init(&(us->dev_mutex));
974 init_MUTEX_LOCKED(&(us->sema));
975 init_completion(&(us->notify));
976 init_waitqueue_head(&us->delay_wait);
978 /* Associate the us_data structure with the USB device */
979 result = associate_dev(us, intf);
984 * Get the unusual_devs entries and the descriptors
986 * id_index is calculated in the declaration to be the index number
987 * of the match from the usb_device_id table, so we can find the
988 * corresponding entry in the private table.
990 result = get_device_info(us, id);
994 /* Get the transport, protocol, and pipe settings */
995 result = get_transport(us);
998 result = get_protocol(us);
1001 result = get_pipes(us);
1005 /* Acquire all the other resources and add the host */
1006 result = usb_stor_acquire_resources(us);
1009 result = scsi_add_host(host, &intf->dev);
1011 printk(KERN_WARNING USB_STORAGE
1012 "Unable to add the scsi host\n");
1016 /* Start up the thread for delayed SCSI-device scanning */
1017 th = kthread_create(usb_stor_scan_thread, us, "usb-stor-scan");
1019 printk(KERN_WARNING USB_STORAGE
1020 "Unable to start the device-scanning thread\n");
1021 quiesce_and_remove_host(us);
1022 result = PTR_ERR(th);
1026 /* Take a reference to the host for the scanning thread and
1027 * count it among all the threads we have launched. Then
1029 scsi_host_get(us_to_host(us));
1030 atomic_inc(&total_threads);
1031 wake_up_process(th);
1035 /* We come here if there are any problems */
1037 US_DEBUGP("storage_probe() failed\n");
1038 release_everything(us);
1042 /* Handle a disconnect event from the USB core */
1043 static void storage_disconnect(struct usb_interface *intf)
1045 struct us_data *us = usb_get_intfdata(intf);
1047 US_DEBUGP("storage_disconnect() called\n");
1048 quiesce_and_remove_host(us);
1049 release_everything(us);
1052 /***********************************************************************
1053 * Initialization and registration
1054 ***********************************************************************/
1056 static struct usb_driver usb_storage_driver = {
1057 .name = "usb-storage",
1058 .probe = storage_probe,
1059 .disconnect = storage_disconnect,
1061 .suspend = storage_suspend,
1062 .resume = storage_resume,
1063 .reset_resume = storage_reset_resume,
1065 .pre_reset = storage_pre_reset,
1066 .post_reset = storage_post_reset,
1067 .id_table = storage_usb_ids,
1070 static int __init usb_stor_init(void)
1073 printk(KERN_INFO "Initializing USB Mass Storage driver...\n");
1075 /* register the driver, return usb_register return code if error */
1076 retval = usb_register(&usb_storage_driver);
1078 printk(KERN_INFO "USB Mass Storage support registered.\n");
1079 usb_usual_set_present(USB_US_TYPE_STOR);
1084 static void __exit usb_stor_exit(void)
1086 US_DEBUGP("usb_stor_exit() called\n");
1088 /* Deregister the driver
1089 * This will cause disconnect() to be called for each
1092 US_DEBUGP("-- calling usb_deregister()\n");
1093 usb_deregister(&usb_storage_driver) ;
1095 /* Don't return until all of our control and scanning threads
1096 * have exited. Since each thread signals threads_gone as its
1097 * last act, we have to call wait_for_completion the right number
1100 while (atomic_read(&total_threads) > 0) {
1101 wait_for_completion(&threads_gone);
1102 atomic_dec(&total_threads);
1105 usb_usual_clear_present(USB_US_TYPE_STOR);
1108 module_init(usb_stor_init);
1109 module_exit(usb_stor_exit);