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 #include <linux/sched.h>
49 #include <linux/errno.h>
50 #include <linux/freezer.h>
51 #include <linux/module.h>
52 #include <linux/init.h>
53 #include <linux/slab.h>
54 #include <linux/kthread.h>
55 #include <linux/mutex.h>
56 #include <linux/utsname.h>
58 #include <scsi/scsi.h>
59 #include <scsi/scsi_cmnd.h>
60 #include <scsi/scsi_device.h>
64 #include "transport.h"
67 #include "initializers.h"
69 #ifdef CONFIG_USB_STORAGE_FREECOM
72 #ifdef CONFIG_USB_STORAGE_DATAFAB
75 #ifdef CONFIG_USB_STORAGE_JUMPSHOT
78 #ifdef CONFIG_USB_STORAGE_ONETOUCH
81 #ifdef CONFIG_USB_STORAGE_ALAUDA
84 #ifdef CONFIG_USB_STORAGE_KARMA
87 #include "sierra_ms.h"
88 #include "option_ms.h"
90 /* Some informational data */
91 MODULE_AUTHOR("Matthew Dharm <mdharm-usb@one-eyed-alien.net>");
92 MODULE_DESCRIPTION("USB Mass Storage driver for Linux");
93 MODULE_LICENSE("GPL");
95 static unsigned int delay_use
= 5;
96 module_param(delay_use
, uint
, S_IRUGO
| S_IWUSR
);
97 MODULE_PARM_DESC(delay_use
, "seconds to delay before using a new device");
99 static char quirks
[128];
100 module_param_string(quirks
, quirks
, sizeof(quirks
), S_IRUGO
| S_IWUSR
);
101 MODULE_PARM_DESC(quirks
, "supplemental list of device IDs and their quirks");
105 * The entries in this table correspond, line for line,
106 * with the entries in usb_storage_usb_ids[], defined in usual-tables.c.
109 /* The vendor name should be kept at eight characters or less, and
110 * the product name should be kept at 16 characters or less. If a device
111 * has the US_FL_FIX_INQUIRY flag, then the vendor and product names
112 * normally generated by a device thorugh the INQUIRY response will be
113 * taken from this list, and this is the reason for the above size
114 * restriction. However, if the flag is not present, then you
115 * are free to use as many characters as you like.
118 #define UNUSUAL_DEV(idVendor, idProduct, bcdDeviceMin, bcdDeviceMax, \
119 vendor_name, product_name, use_protocol, use_transport, \
120 init_function, Flags) \
122 .vendorName = vendor_name, \
123 .productName = product_name, \
124 .useProtocol = use_protocol, \
125 .useTransport = use_transport, \
126 .initFunction = init_function, \
129 #define COMPLIANT_DEV UNUSUAL_DEV
131 #define USUAL_DEV(use_protocol, use_transport, use_type) \
133 .useProtocol = use_protocol, \
134 .useTransport = use_transport, \
137 static struct us_unusual_dev us_unusual_dev_list
[] = {
138 # include "unusual_devs.h"
139 { } /* Terminating entry */
147 #ifdef CONFIG_PM /* Minimal support for suspend and resume */
149 int usb_stor_suspend(struct usb_interface
*iface
, pm_message_t message
)
151 struct us_data
*us
= usb_get_intfdata(iface
);
153 /* Wait until no command is running */
154 mutex_lock(&us
->dev_mutex
);
156 US_DEBUGP("%s\n", __func__
);
157 if (us
->suspend_resume_hook
)
158 (us
->suspend_resume_hook
)(us
, US_SUSPEND
);
160 /* When runtime PM is working, we'll set a flag to indicate
161 * whether we should autoresume when a SCSI request arrives. */
163 mutex_unlock(&us
->dev_mutex
);
166 EXPORT_SYMBOL_GPL(usb_stor_suspend
);
168 int usb_stor_resume(struct usb_interface
*iface
)
170 struct us_data
*us
= usb_get_intfdata(iface
);
172 mutex_lock(&us
->dev_mutex
);
174 US_DEBUGP("%s\n", __func__
);
175 if (us
->suspend_resume_hook
)
176 (us
->suspend_resume_hook
)(us
, US_RESUME
);
178 mutex_unlock(&us
->dev_mutex
);
181 EXPORT_SYMBOL_GPL(usb_stor_resume
);
183 int usb_stor_reset_resume(struct usb_interface
*iface
)
185 struct us_data
*us
= usb_get_intfdata(iface
);
187 US_DEBUGP("%s\n", __func__
);
189 /* Report the reset to the SCSI core */
190 usb_stor_report_bus_reset(us
);
192 /* FIXME: Notify the subdrivers that they need to reinitialize
196 EXPORT_SYMBOL_GPL(usb_stor_reset_resume
);
198 #endif /* CONFIG_PM */
201 * The next two routines get called just before and just after
202 * a USB port reset, whether from this driver or a different one.
205 int usb_stor_pre_reset(struct usb_interface
*iface
)
207 struct us_data
*us
= usb_get_intfdata(iface
);
209 US_DEBUGP("%s\n", __func__
);
211 /* Make sure no command runs during the reset */
212 mutex_lock(&us
->dev_mutex
);
215 EXPORT_SYMBOL_GPL(usb_stor_pre_reset
);
217 int usb_stor_post_reset(struct usb_interface
*iface
)
219 struct us_data
*us
= usb_get_intfdata(iface
);
221 US_DEBUGP("%s\n", __func__
);
223 /* Report the reset to the SCSI core */
224 usb_stor_report_bus_reset(us
);
226 /* FIXME: Notify the subdrivers that they need to reinitialize
229 mutex_unlock(&us
->dev_mutex
);
232 EXPORT_SYMBOL_GPL(usb_stor_post_reset
);
235 * fill_inquiry_response takes an unsigned char array (which must
236 * be at least 36 characters) and populates the vendor name,
237 * product name, and revision fields. Then the array is copied
238 * into the SCSI command's response buffer (oddly enough
239 * called request_buffer). data_len contains the length of the
240 * data array, which again must be at least 36.
243 void fill_inquiry_response(struct us_data
*us
, unsigned char *data
,
244 unsigned int data_len
)
246 if (data_len
<36) // You lose.
249 if(data
[0]&0x20) { /* USB device currently not connected. Return
250 peripheral qualifier 001b ("...however, the
251 physical device is not currently connected
252 to this logical unit") and leave vendor and
253 product identification empty. ("If the target
254 does store some of the INQUIRY data on the
255 device, it may return zeros or ASCII spaces
256 (20h) in those fields until the data is
257 available from the device."). */
260 u16 bcdDevice
= le16_to_cpu(us
->pusb_dev
->descriptor
.bcdDevice
);
261 memcpy(data
+8, us
->unusual_dev
->vendorName
,
262 strlen(us
->unusual_dev
->vendorName
) > 8 ? 8 :
263 strlen(us
->unusual_dev
->vendorName
));
264 memcpy(data
+16, us
->unusual_dev
->productName
,
265 strlen(us
->unusual_dev
->productName
) > 16 ? 16 :
266 strlen(us
->unusual_dev
->productName
));
267 data
[32] = 0x30 + ((bcdDevice
>>12) & 0x0F);
268 data
[33] = 0x30 + ((bcdDevice
>>8) & 0x0F);
269 data
[34] = 0x30 + ((bcdDevice
>>4) & 0x0F);
270 data
[35] = 0x30 + ((bcdDevice
) & 0x0F);
273 usb_stor_set_xfer_buf(data
, data_len
, us
->srb
);
275 EXPORT_SYMBOL_GPL(fill_inquiry_response
);
277 static int usb_stor_control_thread(void * __us
)
279 struct us_data
*us
= (struct us_data
*)__us
;
280 struct Scsi_Host
*host
= us_to_host(us
);
283 US_DEBUGP("*** thread sleeping.\n");
284 if (wait_for_completion_interruptible(&us
->cmnd_ready
))
287 US_DEBUGP("*** thread awakened.\n");
289 /* lock the device pointers */
290 mutex_lock(&(us
->dev_mutex
));
292 /* lock access to the state */
295 /* When we are called with no command pending, we're done */
296 if (us
->srb
== NULL
) {
298 mutex_unlock(&us
->dev_mutex
);
299 US_DEBUGP("-- exiting\n");
303 /* has the command timed out *already* ? */
304 if (test_bit(US_FLIDX_TIMED_OUT
, &us
->dflags
)) {
305 us
->srb
->result
= DID_ABORT
<< 16;
311 /* reject the command if the direction indicator
314 if (us
->srb
->sc_data_direction
== DMA_BIDIRECTIONAL
) {
315 US_DEBUGP("UNKNOWN data direction\n");
316 us
->srb
->result
= DID_ERROR
<< 16;
319 /* reject if target != 0 or if LUN is higher than
320 * the maximum known LUN
322 else if (us
->srb
->device
->id
&&
323 !(us
->fflags
& US_FL_SCM_MULT_TARG
)) {
324 US_DEBUGP("Bad target number (%d:%d)\n",
325 us
->srb
->device
->id
, us
->srb
->device
->lun
);
326 us
->srb
->result
= DID_BAD_TARGET
<< 16;
329 else if (us
->srb
->device
->lun
> us
->max_lun
) {
330 US_DEBUGP("Bad LUN (%d:%d)\n",
331 us
->srb
->device
->id
, us
->srb
->device
->lun
);
332 us
->srb
->result
= DID_BAD_TARGET
<< 16;
335 /* Handle those devices which need us to fake
336 * their inquiry data */
337 else if ((us
->srb
->cmnd
[0] == INQUIRY
) &&
338 (us
->fflags
& US_FL_FIX_INQUIRY
)) {
339 unsigned char data_ptr
[36] = {
340 0x00, 0x80, 0x02, 0x02,
341 0x1F, 0x00, 0x00, 0x00};
343 US_DEBUGP("Faking INQUIRY command\n");
344 fill_inquiry_response(us
, data_ptr
, 36);
345 us
->srb
->result
= SAM_STAT_GOOD
;
348 /* we've got a command, let's do it! */
350 US_DEBUG(usb_stor_show_command(us
->srb
));
351 us
->proto_handler(us
->srb
, us
);
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 device-related DMA-mapped buffers */
424 us
->cr
= usb_buffer_alloc(us
->pusb_dev
, sizeof(*us
->cr
),
425 GFP_KERNEL
, &us
->cr_dma
);
427 US_DEBUGP("usb_ctrlrequest allocation failed\n");
431 us
->iobuf
= usb_buffer_alloc(us
->pusb_dev
, US_IOBUF_SIZE
,
432 GFP_KERNEL
, &us
->iobuf_dma
);
434 US_DEBUGP("I/O buffer allocation failed\n");
440 /* Works only for digits and letters, but small and fast */
441 #define TOLOWER(x) ((x) | 0x20)
443 /* Adjust device flags based on the "quirks=" module parameter */
444 static void adjust_quirks(struct us_data
*us
)
447 u16 vid
= le16_to_cpu(us
->pusb_dev
->descriptor
.idVendor
);
448 u16 pid
= le16_to_cpu(us
->pusb_dev
->descriptor
.idProduct
);
450 unsigned int mask
= (US_FL_SANE_SENSE
| US_FL_FIX_CAPACITY
|
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
);
458 /* Each entry consists of VID:PID:flags */
459 if (vid
== simple_strtoul(p
, &p
, 16) &&
461 pid
== simple_strtoul(p
+1, &p
, 16) &&
465 /* Move forward to the next entry */
471 if (!*p
) /* No match */
474 /* Collect the flags */
475 while (*++p
&& *p
!= ',') {
476 switch (TOLOWER(*p
)) {
478 f
|= US_FL_SANE_SENSE
;
481 f
|= US_FL_FIX_CAPACITY
;
484 f
|= US_FL_CAPACITY_HEURISTICS
;
487 f
|= US_FL_IGNORE_DEVICE
;
490 f
|= US_FL_NOT_LOCKABLE
;
493 f
|= US_FL_MAX_SECTORS_64
;
496 f
|= US_FL_CAPACITY_OK
;
499 f
|= US_FL_IGNORE_RESIDUE
;
502 f
|= US_FL_SINGLE_LUN
;
505 f
|= US_FL_NO_WP_DETECT
;
507 /* Ignore unrecognized flag characters */
510 us
->fflags
= (us
->fflags
& ~mask
) | f
;
511 dev_info(&us
->pusb_intf
->dev
, "Quirks match for "
512 "vid %04x pid %04x: %x\n",
516 /* Get the unusual_devs entries and the string descriptors */
517 static int get_device_info(struct us_data
*us
, const struct usb_device_id
*id
,
518 struct us_unusual_dev
*unusual_dev
)
520 struct usb_device
*dev
= us
->pusb_dev
;
521 struct usb_interface_descriptor
*idesc
=
522 &us
->pusb_intf
->cur_altsetting
->desc
;
524 /* Store the entries */
525 us
->unusual_dev
= unusual_dev
;
526 us
->subclass
= (unusual_dev
->useProtocol
== US_SC_DEVICE
) ?
527 idesc
->bInterfaceSubClass
:
528 unusual_dev
->useProtocol
;
529 us
->protocol
= (unusual_dev
->useTransport
== US_PR_DEVICE
) ?
530 idesc
->bInterfaceProtocol
:
531 unusual_dev
->useTransport
;
532 us
->fflags
= USB_US_ORIG_FLAGS(id
->driver_info
);
535 if (us
->fflags
& US_FL_IGNORE_DEVICE
) {
536 printk(KERN_INFO USB_STORAGE
"device ignored\n");
541 * This flag is only needed when we're in high-speed, so let's
542 * disable it if we're in full-speed
544 if (dev
->speed
!= USB_SPEED_HIGH
)
545 us
->fflags
&= ~US_FL_GO_SLOW
;
547 /* Log a message if a non-generic unusual_dev entry contains an
548 * unnecessary subclass or protocol override. This may stimulate
549 * reports from users that will help us remove unneeded entries
550 * from the unusual_devs.h table.
552 if (id
->idVendor
|| id
->idProduct
) {
553 static const char *msgs
[3] = {
554 "an unneeded SubClass entry",
555 "an unneeded Protocol entry",
556 "unneeded SubClass and Protocol entries"};
557 struct usb_device_descriptor
*ddesc
= &dev
->descriptor
;
560 if (unusual_dev
->useProtocol
!= US_SC_DEVICE
&&
561 us
->subclass
== idesc
->bInterfaceSubClass
)
563 if (unusual_dev
->useTransport
!= US_PR_DEVICE
&&
564 us
->protocol
== idesc
->bInterfaceProtocol
)
566 if (msg
>= 0 && !(us
->fflags
& US_FL_NEED_OVERRIDE
))
567 printk(KERN_NOTICE USB_STORAGE
"This device "
568 "(%04x,%04x,%04x S %02x P %02x)"
569 " has %s in unusual_devs.h (kernel"
571 " Please send a copy of this message to "
572 "<linux-usb@vger.kernel.org> and "
573 "<usb-storage@lists.one-eyed-alien.net>\n",
574 le16_to_cpu(ddesc
->idVendor
),
575 le16_to_cpu(ddesc
->idProduct
),
576 le16_to_cpu(ddesc
->bcdDevice
),
577 idesc
->bInterfaceSubClass
,
578 idesc
->bInterfaceProtocol
,
586 /* Get the transport settings */
587 static void get_transport(struct us_data
*us
)
589 switch (us
->protocol
) {
591 us
->transport_name
= "Control/Bulk";
592 us
->transport
= usb_stor_CB_transport
;
593 us
->transport_reset
= usb_stor_CB_reset
;
598 us
->transport_name
= "Control/Bulk/Interrupt";
599 us
->transport
= usb_stor_CB_transport
;
600 us
->transport_reset
= usb_stor_CB_reset
;
605 us
->transport_name
= "Bulk";
606 us
->transport
= usb_stor_Bulk_transport
;
607 us
->transport_reset
= usb_stor_Bulk_reset
;
610 #ifdef CONFIG_USB_STORAGE_FREECOM
612 us
->transport_name
= "Freecom";
613 us
->transport
= freecom_transport
;
614 us
->transport_reset
= usb_stor_freecom_reset
;
619 #ifdef CONFIG_USB_STORAGE_DATAFAB
621 us
->transport_name
= "Datafab Bulk-Only";
622 us
->transport
= datafab_transport
;
623 us
->transport_reset
= usb_stor_Bulk_reset
;
628 #ifdef CONFIG_USB_STORAGE_JUMPSHOT
630 us
->transport_name
= "Lexar Jumpshot Control/Bulk";
631 us
->transport
= jumpshot_transport
;
632 us
->transport_reset
= usb_stor_Bulk_reset
;
637 #ifdef CONFIG_USB_STORAGE_ALAUDA
639 us
->transport_name
= "Alauda Control/Bulk";
640 us
->transport
= alauda_transport
;
641 us
->transport_reset
= usb_stor_Bulk_reset
;
646 #ifdef CONFIG_USB_STORAGE_KARMA
648 us
->transport_name
= "Rio Karma/Bulk";
649 us
->transport
= rio_karma_transport
;
650 us
->transport_reset
= usb_stor_Bulk_reset
;
657 /* Get the protocol settings */
658 static void get_protocol(struct us_data
*us
)
660 switch (us
->subclass
) {
662 us
->protocol_name
= "Reduced Block Commands (RBC)";
663 us
->proto_handler
= usb_stor_transparent_scsi_command
;
667 us
->protocol_name
= "8020i";
668 us
->proto_handler
= usb_stor_pad12_command
;
673 us
->protocol_name
= "QIC-157";
674 us
->proto_handler
= usb_stor_pad12_command
;
679 us
->protocol_name
= "8070i";
680 us
->proto_handler
= usb_stor_pad12_command
;
685 us
->protocol_name
= "Transparent SCSI";
686 us
->proto_handler
= usb_stor_transparent_scsi_command
;
690 us
->protocol_name
= "Uniform Floppy Interface (UFI)";
691 us
->proto_handler
= usb_stor_ufi_command
;
696 /* Get the pipe settings */
697 static int get_pipes(struct us_data
*us
)
699 struct usb_host_interface
*altsetting
=
700 us
->pusb_intf
->cur_altsetting
;
702 struct usb_endpoint_descriptor
*ep
;
703 struct usb_endpoint_descriptor
*ep_in
= NULL
;
704 struct usb_endpoint_descriptor
*ep_out
= NULL
;
705 struct usb_endpoint_descriptor
*ep_int
= NULL
;
708 * Find the first endpoint of each type we need.
709 * We are expecting a minimum of 2 endpoints - in and out (bulk).
710 * An optional interrupt-in is OK (necessary for CBI protocol).
711 * We will ignore any others.
713 for (i
= 0; i
< altsetting
->desc
.bNumEndpoints
; i
++) {
714 ep
= &altsetting
->endpoint
[i
].desc
;
716 if (usb_endpoint_xfer_bulk(ep
)) {
717 if (usb_endpoint_dir_in(ep
)) {
726 else if (usb_endpoint_is_int_in(ep
)) {
732 if (!ep_in
|| !ep_out
|| (us
->protocol
== US_PR_CBI
&& !ep_int
)) {
733 US_DEBUGP("Endpoint sanity check failed! Rejecting dev.\n");
737 /* Calculate and store the pipe values */
738 us
->send_ctrl_pipe
= usb_sndctrlpipe(us
->pusb_dev
, 0);
739 us
->recv_ctrl_pipe
= usb_rcvctrlpipe(us
->pusb_dev
, 0);
740 us
->send_bulk_pipe
= usb_sndbulkpipe(us
->pusb_dev
,
741 usb_endpoint_num(ep_out
));
742 us
->recv_bulk_pipe
= usb_rcvbulkpipe(us
->pusb_dev
,
743 usb_endpoint_num(ep_in
));
745 us
->recv_intr_pipe
= usb_rcvintpipe(us
->pusb_dev
,
746 usb_endpoint_num(ep_int
));
747 us
->ep_bInterval
= ep_int
->bInterval
;
752 /* Initialize all the dynamic resources we need */
753 static int usb_stor_acquire_resources(struct us_data
*us
)
756 struct task_struct
*th
;
758 us
->current_urb
= usb_alloc_urb(0, GFP_KERNEL
);
759 if (!us
->current_urb
) {
760 US_DEBUGP("URB allocation failed\n");
764 /* Just before we start our control thread, initialize
765 * the device if it needs initialization */
766 if (us
->unusual_dev
->initFunction
) {
767 p
= us
->unusual_dev
->initFunction(us
);
772 /* Start up our control thread */
773 th
= kthread_run(usb_stor_control_thread
, us
, "usb-storage");
775 printk(KERN_WARNING USB_STORAGE
776 "Unable to start control thread\n");
784 /* Release all our dynamic resources */
785 static void usb_stor_release_resources(struct us_data
*us
)
787 US_DEBUGP("-- %s\n", __func__
);
789 /* Tell the control thread to exit. The SCSI host must
790 * already have been removed and the DISCONNECTING flag set
791 * so that we won't accept any more commands.
793 US_DEBUGP("-- sending exit command to thread\n");
794 complete(&us
->cmnd_ready
);
796 kthread_stop(us
->ctl_thread
);
798 /* Call the destructor routine, if it exists */
799 if (us
->extra_destructor
) {
800 US_DEBUGP("-- calling extra_destructor()\n");
801 us
->extra_destructor(us
->extra
);
804 /* Free the extra data and the URB */
806 usb_free_urb(us
->current_urb
);
809 /* Dissociate from the USB device */
810 static void dissociate_dev(struct us_data
*us
)
812 US_DEBUGP("-- %s\n", __func__
);
814 /* Free the device-related DMA-mapped buffers */
816 usb_buffer_free(us
->pusb_dev
, sizeof(*us
->cr
), us
->cr
,
819 usb_buffer_free(us
->pusb_dev
, US_IOBUF_SIZE
, us
->iobuf
,
822 /* Remove our private data from the interface */
823 usb_set_intfdata(us
->pusb_intf
, NULL
);
826 /* First stage of disconnect processing: stop SCSI scanning,
827 * remove the host, and stop accepting new commands
829 static void quiesce_and_remove_host(struct us_data
*us
)
831 struct Scsi_Host
*host
= us_to_host(us
);
833 /* If the device is really gone, cut short reset delays */
834 if (us
->pusb_dev
->state
== USB_STATE_NOTATTACHED
)
835 set_bit(US_FLIDX_DISCONNECTING
, &us
->dflags
);
837 /* Prevent SCSI-scanning (if it hasn't started yet)
838 * and wait for the SCSI-scanning thread to stop.
840 set_bit(US_FLIDX_DONT_SCAN
, &us
->dflags
);
841 wake_up(&us
->delay_wait
);
842 wait_for_completion(&us
->scanning_done
);
844 /* Removing the host will perform an orderly shutdown: caches
845 * synchronized, disks spun down, etc.
847 scsi_remove_host(host
);
849 /* Prevent any new commands from being accepted and cut short
853 set_bit(US_FLIDX_DISCONNECTING
, &us
->dflags
);
855 wake_up(&us
->delay_wait
);
858 /* Second stage of disconnect processing: deallocate all resources */
859 static void release_everything(struct us_data
*us
)
861 usb_stor_release_resources(us
);
864 /* Drop our reference to the host; the SCSI core will free it
865 * (and "us" along with it) when the refcount becomes 0. */
866 scsi_host_put(us_to_host(us
));
869 /* Thread to carry out delayed SCSI-device scanning */
870 static int usb_stor_scan_thread(void * __us
)
872 struct us_data
*us
= (struct us_data
*)__us
;
875 "usb-storage: device found at %d\n", us
->pusb_dev
->devnum
);
878 /* Wait for the timeout to expire or for a disconnect */
880 printk(KERN_DEBUG
"usb-storage: waiting for device "
881 "to settle before scanning\n");
882 wait_event_freezable_timeout(us
->delay_wait
,
883 test_bit(US_FLIDX_DONT_SCAN
, &us
->dflags
),
887 /* If the device is still connected, perform the scanning */
888 if (!test_bit(US_FLIDX_DONT_SCAN
, &us
->dflags
)) {
890 /* For bulk-only devices, determine the max LUN value */
891 if (us
->protocol
== US_PR_BULK
&&
892 !(us
->fflags
& US_FL_SINGLE_LUN
)) {
893 mutex_lock(&us
->dev_mutex
);
894 us
->max_lun
= usb_stor_Bulk_max_lun(us
);
895 mutex_unlock(&us
->dev_mutex
);
897 scsi_scan_host(us_to_host(us
));
898 printk(KERN_DEBUG
"usb-storage: device scan complete\n");
900 /* Should we unbind if no devices were detected? */
903 complete_and_exit(&us
->scanning_done
, 0);
907 /* First part of general USB mass-storage probing */
908 int usb_stor_probe1(struct us_data
**pus
,
909 struct usb_interface
*intf
,
910 const struct usb_device_id
*id
,
911 struct us_unusual_dev
*unusual_dev
)
913 struct Scsi_Host
*host
;
917 US_DEBUGP("USB Mass Storage device detected\n");
920 * Ask the SCSI layer to allocate a host structure, with extra
921 * space at the end for our private us_data structure.
923 host
= scsi_host_alloc(&usb_stor_host_template
, sizeof(*us
));
925 printk(KERN_WARNING USB_STORAGE
926 "Unable to allocate the scsi host\n");
931 * Allow 16-byte CDBs and thus > 2TB
933 host
->max_cmd_len
= 16;
934 *pus
= us
= host_to_us(host
);
935 memset(us
, 0, sizeof(struct us_data
));
936 mutex_init(&(us
->dev_mutex
));
937 init_completion(&us
->cmnd_ready
);
938 init_completion(&(us
->notify
));
939 init_waitqueue_head(&us
->delay_wait
);
940 init_completion(&us
->scanning_done
);
942 /* Associate the us_data structure with the USB device */
943 result
= associate_dev(us
, intf
);
947 /* Get the unusual_devs entries and the descriptors */
948 result
= get_device_info(us
, id
, unusual_dev
);
952 /* Get standard transport and protocol settings */
956 /* Give the caller a chance to fill in specialized transport
957 * or protocol settings.
962 US_DEBUGP("storage_probe() failed\n");
963 release_everything(us
);
966 EXPORT_SYMBOL_GPL(usb_stor_probe1
);
968 /* Second part of general USB mass-storage probing */
969 int usb_stor_probe2(struct us_data
*us
)
971 struct task_struct
*th
;
974 /* Make sure the transport and protocol have both been set */
975 if (!us
->transport
|| !us
->proto_handler
) {
979 US_DEBUGP("Transport: %s\n", us
->transport_name
);
980 US_DEBUGP("Protocol: %s\n", us
->protocol_name
);
982 /* fix for single-lun devices */
983 if (us
->fflags
& US_FL_SINGLE_LUN
)
986 /* Find the endpoints and calculate pipe values */
987 result
= get_pipes(us
);
991 /* Acquire all the other resources and add the host */
992 result
= usb_stor_acquire_resources(us
);
995 result
= scsi_add_host(us_to_host(us
), &us
->pusb_intf
->dev
);
997 printk(KERN_WARNING USB_STORAGE
998 "Unable to add the scsi host\n");
1002 /* Start up the thread for delayed SCSI-device scanning */
1003 th
= kthread_create(usb_stor_scan_thread
, us
, "usb-stor-scan");
1005 printk(KERN_WARNING USB_STORAGE
1006 "Unable to start the device-scanning thread\n");
1007 complete(&us
->scanning_done
);
1008 quiesce_and_remove_host(us
);
1009 result
= PTR_ERR(th
);
1013 wake_up_process(th
);
1017 /* We come here if there are any problems */
1019 US_DEBUGP("storage_probe() failed\n");
1020 release_everything(us
);
1023 EXPORT_SYMBOL_GPL(usb_stor_probe2
);
1025 /* Handle a USB mass-storage disconnect */
1026 void usb_stor_disconnect(struct usb_interface
*intf
)
1028 struct us_data
*us
= usb_get_intfdata(intf
);
1030 US_DEBUGP("storage_disconnect() called\n");
1031 quiesce_and_remove_host(us
);
1032 release_everything(us
);
1034 EXPORT_SYMBOL_GPL(usb_stor_disconnect
);
1036 /* The main probe routine for standard devices */
1037 static int storage_probe(struct usb_interface
*intf
,
1038 const struct usb_device_id
*id
)
1044 * If libusual is configured, let it decide whether a standard
1045 * device should be handled by usb-storage or by ub.
1046 * If the device isn't standard (is handled by a subdriver
1047 * module) then don't accept it.
1049 if (usb_usual_check_type(id
, USB_US_TYPE_STOR
) ||
1050 usb_usual_ignore_device(intf
))
1054 * Call the general probe procedures.
1056 * The unusual_dev_list array is parallel to the usb_storage_usb_ids
1057 * table, so we use the index of the id entry to find the
1058 * corresponding unusual_devs entry.
1060 result
= usb_stor_probe1(&us
, intf
, id
,
1061 (id
- usb_storage_usb_ids
) + us_unusual_dev_list
);
1065 /* No special transport or protocol settings in the main module */
1067 result
= usb_stor_probe2(us
);
1071 /***********************************************************************
1072 * Initialization and registration
1073 ***********************************************************************/
1075 static struct usb_driver usb_storage_driver
= {
1076 .name
= "usb-storage",
1077 .probe
= storage_probe
,
1078 .disconnect
= usb_stor_disconnect
,
1079 .suspend
= usb_stor_suspend
,
1080 .resume
= usb_stor_resume
,
1081 .reset_resume
= usb_stor_reset_resume
,
1082 .pre_reset
= usb_stor_pre_reset
,
1083 .post_reset
= usb_stor_post_reset
,
1084 .id_table
= usb_storage_usb_ids
,
1088 static int __init
usb_stor_init(void)
1092 printk(KERN_INFO
"Initializing USB Mass Storage driver...\n");
1094 /* register the driver, return usb_register return code if error */
1095 retval
= usb_register(&usb_storage_driver
);
1097 printk(KERN_INFO
"USB Mass Storage support registered.\n");
1098 usb_usual_set_present(USB_US_TYPE_STOR
);
1103 static void __exit
usb_stor_exit(void)
1105 US_DEBUGP("usb_stor_exit() called\n");
1107 /* Deregister the driver
1108 * This will cause disconnect() to be called for each
1111 US_DEBUGP("-- calling usb_deregister()\n");
1112 usb_deregister(&usb_storage_driver
) ;
1114 usb_usual_clear_present(USB_US_TYPE_STOR
);
1117 module_init(usb_stor_init
);
1118 module_exit(usb_stor_exit
);