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 static struct us_unusual_dev us_unusual_dev_list
[] = {
124 # include "unusual_devs.h"
125 { } /* Terminating entry */
133 #ifdef CONFIG_PM /* Minimal support for suspend and resume */
135 int usb_stor_suspend(struct usb_interface
*iface
, pm_message_t message
)
137 struct us_data
*us
= usb_get_intfdata(iface
);
139 /* Wait until no command is running */
140 mutex_lock(&us
->dev_mutex
);
142 US_DEBUGP("%s\n", __func__
);
143 if (us
->suspend_resume_hook
)
144 (us
->suspend_resume_hook
)(us
, US_SUSPEND
);
146 /* When runtime PM is working, we'll set a flag to indicate
147 * whether we should autoresume when a SCSI request arrives. */
149 mutex_unlock(&us
->dev_mutex
);
152 EXPORT_SYMBOL_GPL(usb_stor_suspend
);
154 int usb_stor_resume(struct usb_interface
*iface
)
156 struct us_data
*us
= usb_get_intfdata(iface
);
158 mutex_lock(&us
->dev_mutex
);
160 US_DEBUGP("%s\n", __func__
);
161 if (us
->suspend_resume_hook
)
162 (us
->suspend_resume_hook
)(us
, US_RESUME
);
164 mutex_unlock(&us
->dev_mutex
);
167 EXPORT_SYMBOL_GPL(usb_stor_resume
);
169 int usb_stor_reset_resume(struct usb_interface
*iface
)
171 struct us_data
*us
= usb_get_intfdata(iface
);
173 US_DEBUGP("%s\n", __func__
);
175 /* Report the reset to the SCSI core */
176 usb_stor_report_bus_reset(us
);
178 /* FIXME: Notify the subdrivers that they need to reinitialize
182 EXPORT_SYMBOL_GPL(usb_stor_reset_resume
);
184 #endif /* CONFIG_PM */
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.
191 int usb_stor_pre_reset(struct usb_interface
*iface
)
193 struct us_data
*us
= usb_get_intfdata(iface
);
195 US_DEBUGP("%s\n", __func__
);
197 /* Make sure no command runs during the reset */
198 mutex_lock(&us
->dev_mutex
);
201 EXPORT_SYMBOL_GPL(usb_stor_pre_reset
);
203 int usb_stor_post_reset(struct usb_interface
*iface
)
205 struct us_data
*us
= usb_get_intfdata(iface
);
207 US_DEBUGP("%s\n", __func__
);
209 /* Report the reset to the SCSI core */
210 usb_stor_report_bus_reset(us
);
212 /* FIXME: Notify the subdrivers that they need to reinitialize
215 mutex_unlock(&us
->dev_mutex
);
218 EXPORT_SYMBOL_GPL(usb_stor_post_reset
);
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.
229 void fill_inquiry_response(struct us_data
*us
, unsigned char *data
,
230 unsigned int data_len
)
232 if (data_len
<36) // You lose.
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."). */
246 u16 bcdDevice
= le16_to_cpu(us
->pusb_dev
->descriptor
.bcdDevice
);
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
));
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);
260 usb_stor_set_xfer_buf(data
, data_len
, us
->srb
);
262 EXPORT_SYMBOL_GPL(fill_inquiry_response
);
264 static int usb_stor_control_thread(void * __us
)
266 struct us_data
*us
= (struct us_data
*)__us
;
267 struct Scsi_Host
*host
= us_to_host(us
);
270 US_DEBUGP("*** thread sleeping.\n");
271 if (wait_for_completion_interruptible(&us
->cmnd_ready
))
274 US_DEBUGP("*** thread awakened.\n");
276 /* lock the device pointers */
277 mutex_lock(&(us
->dev_mutex
));
279 /* lock access to the state */
282 /* When we are called with no command pending, we're done */
283 if (us
->srb
== NULL
) {
285 mutex_unlock(&us
->dev_mutex
);
286 US_DEBUGP("-- exiting\n");
290 /* has the command timed out *already* ? */
291 if (test_bit(US_FLIDX_TIMED_OUT
, &us
->dflags
)) {
292 us
->srb
->result
= DID_ABORT
<< 16;
298 /* reject the command if the direction indicator
301 if (us
->srb
->sc_data_direction
== DMA_BIDIRECTIONAL
) {
302 US_DEBUGP("UNKNOWN data direction\n");
303 us
->srb
->result
= DID_ERROR
<< 16;
306 /* reject if target != 0 or if LUN is higher than
307 * the maximum known LUN
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;
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;
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};
330 US_DEBUGP("Faking INQUIRY command\n");
331 fill_inquiry_response(us
, data_ptr
, 36);
332 us
->srb
->result
= SAM_STAT_GOOD
;
335 /* we've got a command, let's do it! */
337 US_DEBUG(usb_stor_show_command(us
->srb
));
338 us
->proto_handler(us
->srb
, us
);
339 usb_mark_last_busy(us
->pusb_dev
);
342 /* lock access to the state */
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",
349 us
->srb
->scsi_done(us
->srb
);
352 US_DEBUGP("scsi command aborted\n");
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
));
363 /* Allow USB transfers to resume */
364 clear_bit(US_FLIDX_ABORTING
, &us
->dflags
);
365 clear_bit(US_FLIDX_TIMED_OUT
, &us
->dflags
);
368 /* finished working on this command */
372 /* unlock the device pointers */
373 mutex_unlock(&us
->dev_mutex
);
376 /* Wait until we are told to stop */
378 set_current_state(TASK_INTERRUPTIBLE
);
379 if (kthread_should_stop())
383 __set_current_state(TASK_RUNNING
);
387 /***********************************************************************
388 * Device probing and disconnecting
389 ***********************************************************************/
391 /* Associate our private data with the USB device */
392 static int associate_dev(struct us_data
*us
, struct usb_interface
*intf
)
394 US_DEBUGP("-- %s\n", __func__
);
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
);
408 /* Store our private data in the interface */
409 usb_set_intfdata(intf
, us
);
411 /* Allocate the control/setup and DMA-mapped buffers */
412 us
->cr
= kmalloc(sizeof(*us
->cr
), GFP_KERNEL
);
414 US_DEBUGP("usb_ctrlrequest allocation failed\n");
418 us
->iobuf
= usb_alloc_coherent(us
->pusb_dev
, US_IOBUF_SIZE
,
419 GFP_KERNEL
, &us
->iobuf_dma
);
421 US_DEBUGP("I/O buffer allocation failed\n");
427 /* Works only for digits and letters, but small and fast */
428 #define TOLOWER(x) ((x) | 0x20)
430 /* Adjust device flags based on the "quirks=" module parameter */
431 static void adjust_quirks(struct us_data
*us
)
434 u16 vid
= le16_to_cpu(us
->pusb_dev
->descriptor
.idVendor
);
435 u16 pid
= le16_to_cpu(us
->pusb_dev
->descriptor
.idProduct
);
437 unsigned int mask
= (US_FL_SANE_SENSE
| US_FL_BAD_SENSE
|
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
);
448 /* Each entry consists of VID:PID:flags */
449 if (vid
== simple_strtoul(p
, &p
, 16) &&
451 pid
== simple_strtoul(p
+1, &p
, 16) &&
455 /* Move forward to the next entry */
461 if (!*p
) /* No match */
464 /* Collect the flags */
465 while (*++p
&& *p
!= ',') {
466 switch (TOLOWER(*p
)) {
468 f
|= US_FL_SANE_SENSE
;
471 f
|= US_FL_BAD_SENSE
;
474 f
|= US_FL_FIX_CAPACITY
;
477 f
|= US_FL_NO_READ_DISC_INFO
;
480 f
|= US_FL_NO_READ_CAPACITY_16
;
483 f
|= US_FL_CAPACITY_HEURISTICS
;
486 f
|= US_FL_IGNORE_DEVICE
;
489 f
|= US_FL_NOT_LOCKABLE
;
492 f
|= US_FL_MAX_SECTORS_64
;
495 f
|= US_FL_INITIAL_READ10
;
498 f
|= US_FL_CAPACITY_OK
;
501 f
|= US_FL_IGNORE_RESIDUE
;
504 f
|= US_FL_SINGLE_LUN
;
507 f
|= US_FL_NO_WP_DETECT
;
509 /* Ignore unrecognized flag characters */
512 us
->fflags
= (us
->fflags
& ~mask
) | f
;
515 /* Get the unusual_devs entries and the string descriptors */
516 static int get_device_info(struct us_data
*us
, const struct usb_device_id
*id
,
517 struct us_unusual_dev
*unusual_dev
)
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
;
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
);
535 if (us
->fflags
& US_FL_IGNORE_DEVICE
) {
536 dev_info(pdev
, "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
;
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
),
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.
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
;
566 if (unusual_dev
->useProtocol
!= USB_SC_DEVICE
&&
567 us
->subclass
== idesc
->bInterfaceSubClass
)
569 if (unusual_dev
->useTransport
!= USB_PR_DEVICE
&&
570 us
->protocol
== idesc
->bInterfaceProtocol
)
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"
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
,
592 /* Get the transport settings */
593 static void get_transport(struct us_data
*us
)
595 switch (us
->protocol
) {
597 us
->transport_name
= "Control/Bulk";
598 us
->transport
= usb_stor_CB_transport
;
599 us
->transport_reset
= usb_stor_CB_reset
;
604 us
->transport_name
= "Control/Bulk/Interrupt";
605 us
->transport
= usb_stor_CB_transport
;
606 us
->transport_reset
= usb_stor_CB_reset
;
611 us
->transport_name
= "Bulk";
612 us
->transport
= usb_stor_Bulk_transport
;
613 us
->transport_reset
= usb_stor_Bulk_reset
;
618 /* Get the protocol settings */
619 static void get_protocol(struct us_data
*us
)
621 switch (us
->subclass
) {
623 us
->protocol_name
= "Reduced Block Commands (RBC)";
624 us
->proto_handler
= usb_stor_transparent_scsi_command
;
628 us
->protocol_name
= "8020i";
629 us
->proto_handler
= usb_stor_pad12_command
;
634 us
->protocol_name
= "QIC-157";
635 us
->proto_handler
= usb_stor_pad12_command
;
640 us
->protocol_name
= "8070i";
641 us
->proto_handler
= usb_stor_pad12_command
;
646 us
->protocol_name
= "Transparent SCSI";
647 us
->proto_handler
= usb_stor_transparent_scsi_command
;
651 us
->protocol_name
= "Uniform Floppy Interface (UFI)";
652 us
->proto_handler
= usb_stor_ufi_command
;
657 /* Get the pipe settings */
658 static int get_pipes(struct us_data
*us
)
660 struct usb_host_interface
*altsetting
=
661 us
->pusb_intf
->cur_altsetting
;
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
;
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.
674 for (i
= 0; i
< altsetting
->desc
.bNumEndpoints
; i
++) {
675 ep
= &altsetting
->endpoint
[i
].desc
;
677 if (usb_endpoint_xfer_bulk(ep
)) {
678 if (usb_endpoint_dir_in(ep
)) {
687 else if (usb_endpoint_is_int_in(ep
)) {
693 if (!ep_in
|| !ep_out
|| (us
->protocol
== USB_PR_CBI
&& !ep_int
)) {
694 US_DEBUGP("Endpoint sanity check failed! Rejecting dev.\n");
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
));
706 us
->recv_intr_pipe
= usb_rcvintpipe(us
->pusb_dev
,
707 usb_endpoint_num(ep_int
));
708 us
->ep_bInterval
= ep_int
->bInterval
;
713 /* Initialize all the dynamic resources we need */
714 static int usb_stor_acquire_resources(struct us_data
*us
)
717 struct task_struct
*th
;
719 us
->current_urb
= usb_alloc_urb(0, GFP_KERNEL
);
720 if (!us
->current_urb
) {
721 US_DEBUGP("URB allocation failed\n");
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
);
733 /* Start up our control thread */
734 th
= kthread_run(usb_stor_control_thread
, us
, "usb-storage");
736 dev_warn(&us
->pusb_intf
->dev
,
737 "Unable to start control thread\n");
745 /* Release all our dynamic resources */
746 static void usb_stor_release_resources(struct us_data
*us
)
748 US_DEBUGP("-- %s\n", __func__
);
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.
754 US_DEBUGP("-- sending exit command to thread\n");
755 complete(&us
->cmnd_ready
);
757 kthread_stop(us
->ctl_thread
);
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
);
765 /* Free the extra data and the URB */
767 usb_free_urb(us
->current_urb
);
770 /* Dissociate from the USB device */
771 static void dissociate_dev(struct us_data
*us
)
773 US_DEBUGP("-- %s\n", __func__
);
775 /* Free the buffers */
777 usb_free_coherent(us
->pusb_dev
, US_IOBUF_SIZE
, us
->iobuf
, us
->iobuf_dma
);
779 /* Remove our private data from the interface */
780 usb_set_intfdata(us
->pusb_intf
, NULL
);
783 /* First stage of disconnect processing: stop SCSI scanning,
784 * remove the host, and stop accepting new commands
786 static void quiesce_and_remove_host(struct us_data
*us
)
788 struct Scsi_Host
*host
= us_to_host(us
);
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
);
794 /* Prevent SCSI-scanning (if it hasn't started yet)
795 * and wait for the SCSI-scanning thread to stop.
797 set_bit(US_FLIDX_DONT_SCAN
, &us
->dflags
);
798 wake_up(&us
->delay_wait
);
799 wait_for_completion(&us
->scanning_done
);
801 /* Removing the host will perform an orderly shutdown: caches
802 * synchronized, disks spun down, etc.
804 scsi_remove_host(host
);
806 /* Prevent any new commands from being accepted and cut short
810 set_bit(US_FLIDX_DISCONNECTING
, &us
->dflags
);
812 wake_up(&us
->delay_wait
);
815 /* Second stage of disconnect processing: deallocate all resources */
816 static void release_everything(struct us_data
*us
)
818 usb_stor_release_resources(us
);
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
));
826 /* Thread to carry out delayed SCSI-device scanning */
827 static int usb_stor_scan_thread(void * __us
)
829 struct us_data
*us
= (struct us_data
*)__us
;
830 struct device
*dev
= &us
->pusb_intf
->dev
;
832 dev_dbg(dev
, "device found\n");
835 /* Wait for the timeout to expire or for a disconnect */
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
),
844 /* If the device is still connected, perform the scanning */
845 if (!test_bit(US_FLIDX_DONT_SCAN
, &us
->dflags
)) {
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
);
854 scsi_scan_host(us_to_host(us
));
855 dev_dbg(dev
, "scan complete\n");
857 /* Should we unbind if no devices were detected? */
860 usb_autopm_put_interface(us
->pusb_intf
);
861 complete_and_exit(&us
->scanning_done
, 0);
864 static unsigned int usb_stor_sg_tablesize(struct usb_interface
*intf
)
866 struct usb_device
*usb_dev
= interface_to_usbdev(intf
);
868 if (usb_dev
->bus
->sg_tablesize
) {
869 return usb_dev
->bus
->sg_tablesize
;
874 /* First part of general USB mass-storage probing */
875 int 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
)
880 struct Scsi_Host
*host
;
884 US_DEBUGP("USB Mass Storage device detected\n");
887 * Ask the SCSI layer to allocate a host structure, with extra
888 * space at the end for our private us_data structure.
890 host
= scsi_host_alloc(&usb_stor_host_template
, sizeof(*us
));
893 "Unable to allocate the scsi host\n");
898 * Allow 16-byte CDBs and thus > 2TB
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
);
910 /* Associate the us_data structure with the USB device */
911 result
= associate_dev(us
, intf
);
915 /* Get the unusual_devs entries and the descriptors */
916 result
= get_device_info(us
, id
, unusual_dev
);
920 /* Get standard transport and protocol settings */
924 /* Give the caller a chance to fill in specialized transport
925 * or protocol settings.
930 US_DEBUGP("storage_probe() failed\n");
931 release_everything(us
);
934 EXPORT_SYMBOL_GPL(usb_stor_probe1
);
936 /* Second part of general USB mass-storage probing */
937 int usb_stor_probe2(struct us_data
*us
)
939 struct task_struct
*th
;
941 struct device
*dev
= &us
->pusb_intf
->dev
;
943 /* Make sure the transport and protocol have both been set */
944 if (!us
->transport
|| !us
->proto_handler
) {
948 US_DEBUGP("Transport: %s\n", us
->transport_name
);
949 US_DEBUGP("Protocol: %s\n", us
->protocol_name
);
951 /* fix for single-lun devices */
952 if (us
->fflags
& US_FL_SINGLE_LUN
)
955 /* Find the endpoints and calculate pipe values */
956 result
= get_pipes(us
);
961 * If the device returns invalid data for the first READ(10)
962 * command, indicate the command should be retried.
964 if (us
->fflags
& US_FL_INITIAL_READ10
)
965 set_bit(US_FLIDX_REDO_READ10
, &us
->dflags
);
967 /* Acquire all the other resources and add the host */
968 result
= usb_stor_acquire_resources(us
);
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
);
976 "Unable to add the scsi host\n");
980 /* Start up the thread for delayed SCSI-device scanning */
981 th
= kthread_create(usb_stor_scan_thread
, us
, "usb-stor-scan");
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
);
991 usb_autopm_get_interface_no_resume(us
->pusb_intf
);
996 /* We come here if there are any problems */
998 US_DEBUGP("storage_probe() failed\n");
999 release_everything(us
);
1002 EXPORT_SYMBOL_GPL(usb_stor_probe2
);
1004 /* Handle a USB mass-storage disconnect */
1005 void usb_stor_disconnect(struct usb_interface
*intf
)
1007 struct us_data
*us
= usb_get_intfdata(intf
);
1009 US_DEBUGP("storage_disconnect() called\n");
1010 quiesce_and_remove_host(us
);
1011 release_everything(us
);
1013 EXPORT_SYMBOL_GPL(usb_stor_disconnect
);
1015 /* The main probe routine for standard devices */
1016 static int storage_probe(struct usb_interface
*intf
,
1017 const struct usb_device_id
*id
)
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.
1028 if (usb_usual_check_type(id
, USB_US_TYPE_STOR
) ||
1029 usb_usual_ignore_device(intf
))
1033 * Call the general probe procedures.
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.
1039 result
= usb_stor_probe1(&us
, intf
, id
,
1040 (id
- usb_storage_usb_ids
) + us_unusual_dev_list
);
1044 /* No special transport or protocol settings in the main module */
1046 result
= usb_stor_probe2(us
);
1050 /***********************************************************************
1051 * Initialization and registration
1052 ***********************************************************************/
1054 static 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,
1068 static int __init
usb_stor_init(void)
1072 pr_info("Initializing USB Mass Storage driver...\n");
1074 /* register the driver, return usb_register return code if error */
1075 retval
= usb_register(&usb_storage_driver
);
1077 pr_info("USB Mass Storage support registered.\n");
1078 usb_usual_set_present(USB_US_TYPE_STOR
);
1083 static void __exit
usb_stor_exit(void)
1085 US_DEBUGP("usb_stor_exit() called\n");
1087 /* Deregister the driver
1088 * This will cause disconnect() to be called for each
1091 US_DEBUGP("-- calling usb_deregister()\n");
1092 usb_deregister(&usb_storage_driver
) ;
1094 usb_usual_clear_present(USB_US_TYPE_STOR
);
1097 module_init(usb_stor_init
);
1098 module_exit(usb_stor_exit
);