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_ONETOUCH
72 #ifdef CONFIG_USB_STORAGE_KARMA
75 #include "sierra_ms.h"
76 #include "option_ms.h"
78 /* Some informational data */
79 MODULE_AUTHOR("Matthew Dharm <mdharm-usb@one-eyed-alien.net>");
80 MODULE_DESCRIPTION("USB Mass Storage driver for Linux");
81 MODULE_LICENSE("GPL");
83 static unsigned int delay_use
= 5;
84 module_param(delay_use
, uint
, S_IRUGO
| S_IWUSR
);
85 MODULE_PARM_DESC(delay_use
, "seconds to delay before using a new device");
87 static char quirks
[128];
88 module_param_string(quirks
, quirks
, sizeof(quirks
), S_IRUGO
| S_IWUSR
);
89 MODULE_PARM_DESC(quirks
, "supplemental list of device IDs and their quirks");
93 * The entries in this table correspond, line for line,
94 * with the entries in usb_storage_usb_ids[], defined in usual-tables.c.
97 /* The vendor name should be kept at eight characters or less, and
98 * the product name should be kept at 16 characters or less. If a device
99 * has the US_FL_FIX_INQUIRY flag, then the vendor and product names
100 * normally generated by a device thorugh the INQUIRY response will be
101 * taken from this list, and this is the reason for the above size
102 * restriction. However, if the flag is not present, then you
103 * are free to use as many characters as you like.
106 #define UNUSUAL_DEV(idVendor, idProduct, bcdDeviceMin, bcdDeviceMax, \
107 vendor_name, product_name, use_protocol, use_transport, \
108 init_function, Flags) \
110 .vendorName = vendor_name, \
111 .productName = product_name, \
112 .useProtocol = use_protocol, \
113 .useTransport = use_transport, \
114 .initFunction = init_function, \
117 #define COMPLIANT_DEV UNUSUAL_DEV
119 #define USUAL_DEV(use_protocol, use_transport, use_type) \
121 .useProtocol = use_protocol, \
122 .useTransport = use_transport, \
125 static struct us_unusual_dev us_unusual_dev_list
[] = {
126 # include "unusual_devs.h"
127 { } /* Terminating entry */
135 #ifdef CONFIG_PM /* Minimal support for suspend and resume */
137 int usb_stor_suspend(struct usb_interface
*iface
, pm_message_t message
)
139 struct us_data
*us
= usb_get_intfdata(iface
);
141 /* Wait until no command is running */
142 mutex_lock(&us
->dev_mutex
);
144 US_DEBUGP("%s\n", __func__
);
145 if (us
->suspend_resume_hook
)
146 (us
->suspend_resume_hook
)(us
, US_SUSPEND
);
148 /* When runtime PM is working, we'll set a flag to indicate
149 * whether we should autoresume when a SCSI request arrives. */
151 mutex_unlock(&us
->dev_mutex
);
154 EXPORT_SYMBOL_GPL(usb_stor_suspend
);
156 int usb_stor_resume(struct usb_interface
*iface
)
158 struct us_data
*us
= usb_get_intfdata(iface
);
160 mutex_lock(&us
->dev_mutex
);
162 US_DEBUGP("%s\n", __func__
);
163 if (us
->suspend_resume_hook
)
164 (us
->suspend_resume_hook
)(us
, US_RESUME
);
166 mutex_unlock(&us
->dev_mutex
);
169 EXPORT_SYMBOL_GPL(usb_stor_resume
);
171 int usb_stor_reset_resume(struct usb_interface
*iface
)
173 struct us_data
*us
= usb_get_intfdata(iface
);
175 US_DEBUGP("%s\n", __func__
);
177 /* Report the reset to the SCSI core */
178 usb_stor_report_bus_reset(us
);
180 /* FIXME: Notify the subdrivers that they need to reinitialize
184 EXPORT_SYMBOL_GPL(usb_stor_reset_resume
);
186 #endif /* CONFIG_PM */
189 * The next two routines get called just before and just after
190 * a USB port reset, whether from this driver or a different one.
193 int usb_stor_pre_reset(struct usb_interface
*iface
)
195 struct us_data
*us
= usb_get_intfdata(iface
);
197 US_DEBUGP("%s\n", __func__
);
199 /* Make sure no command runs during the reset */
200 mutex_lock(&us
->dev_mutex
);
203 EXPORT_SYMBOL_GPL(usb_stor_pre_reset
);
205 int usb_stor_post_reset(struct usb_interface
*iface
)
207 struct us_data
*us
= usb_get_intfdata(iface
);
209 US_DEBUGP("%s\n", __func__
);
211 /* Report the reset to the SCSI core */
212 usb_stor_report_bus_reset(us
);
214 /* FIXME: Notify the subdrivers that they need to reinitialize
217 mutex_unlock(&us
->dev_mutex
);
220 EXPORT_SYMBOL_GPL(usb_stor_post_reset
);
223 * fill_inquiry_response takes an unsigned char array (which must
224 * be at least 36 characters) and populates the vendor name,
225 * product name, and revision fields. Then the array is copied
226 * into the SCSI command's response buffer (oddly enough
227 * called request_buffer). data_len contains the length of the
228 * data array, which again must be at least 36.
231 void fill_inquiry_response(struct us_data
*us
, unsigned char *data
,
232 unsigned int data_len
)
234 if (data_len
<36) // You lose.
237 if(data
[0]&0x20) { /* USB device currently not connected. Return
238 peripheral qualifier 001b ("...however, the
239 physical device is not currently connected
240 to this logical unit") and leave vendor and
241 product identification empty. ("If the target
242 does store some of the INQUIRY data on the
243 device, it may return zeros or ASCII spaces
244 (20h) in those fields until the data is
245 available from the device."). */
248 u16 bcdDevice
= le16_to_cpu(us
->pusb_dev
->descriptor
.bcdDevice
);
249 memcpy(data
+8, us
->unusual_dev
->vendorName
,
250 strlen(us
->unusual_dev
->vendorName
) > 8 ? 8 :
251 strlen(us
->unusual_dev
->vendorName
));
252 memcpy(data
+16, us
->unusual_dev
->productName
,
253 strlen(us
->unusual_dev
->productName
) > 16 ? 16 :
254 strlen(us
->unusual_dev
->productName
));
255 data
[32] = 0x30 + ((bcdDevice
>>12) & 0x0F);
256 data
[33] = 0x30 + ((bcdDevice
>>8) & 0x0F);
257 data
[34] = 0x30 + ((bcdDevice
>>4) & 0x0F);
258 data
[35] = 0x30 + ((bcdDevice
) & 0x0F);
261 usb_stor_set_xfer_buf(data
, data_len
, us
->srb
);
263 EXPORT_SYMBOL_GPL(fill_inquiry_response
);
265 static int usb_stor_control_thread(void * __us
)
267 struct us_data
*us
= (struct us_data
*)__us
;
268 struct Scsi_Host
*host
= us_to_host(us
);
271 US_DEBUGP("*** thread sleeping.\n");
272 if (wait_for_completion_interruptible(&us
->cmnd_ready
))
275 US_DEBUGP("*** thread awakened.\n");
277 /* lock the device pointers */
278 mutex_lock(&(us
->dev_mutex
));
280 /* lock access to the state */
283 /* When we are called with no command pending, we're done */
284 if (us
->srb
== NULL
) {
286 mutex_unlock(&us
->dev_mutex
);
287 US_DEBUGP("-- exiting\n");
291 /* has the command timed out *already* ? */
292 if (test_bit(US_FLIDX_TIMED_OUT
, &us
->dflags
)) {
293 us
->srb
->result
= DID_ABORT
<< 16;
299 /* reject the command if the direction indicator
302 if (us
->srb
->sc_data_direction
== DMA_BIDIRECTIONAL
) {
303 US_DEBUGP("UNKNOWN data direction\n");
304 us
->srb
->result
= DID_ERROR
<< 16;
307 /* reject if target != 0 or if LUN is higher than
308 * the maximum known LUN
310 else if (us
->srb
->device
->id
&&
311 !(us
->fflags
& US_FL_SCM_MULT_TARG
)) {
312 US_DEBUGP("Bad target number (%d:%d)\n",
313 us
->srb
->device
->id
, us
->srb
->device
->lun
);
314 us
->srb
->result
= DID_BAD_TARGET
<< 16;
317 else if (us
->srb
->device
->lun
> us
->max_lun
) {
318 US_DEBUGP("Bad LUN (%d:%d)\n",
319 us
->srb
->device
->id
, us
->srb
->device
->lun
);
320 us
->srb
->result
= DID_BAD_TARGET
<< 16;
323 /* Handle those devices which need us to fake
324 * their inquiry data */
325 else if ((us
->srb
->cmnd
[0] == INQUIRY
) &&
326 (us
->fflags
& US_FL_FIX_INQUIRY
)) {
327 unsigned char data_ptr
[36] = {
328 0x00, 0x80, 0x02, 0x02,
329 0x1F, 0x00, 0x00, 0x00};
331 US_DEBUGP("Faking INQUIRY command\n");
332 fill_inquiry_response(us
, data_ptr
, 36);
333 us
->srb
->result
= SAM_STAT_GOOD
;
336 /* we've got a command, let's do it! */
338 US_DEBUG(usb_stor_show_command(us
->srb
));
339 us
->proto_handler(us
->srb
, us
);
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 device-related DMA-mapped buffers */
412 us
->cr
= usb_buffer_alloc(us
->pusb_dev
, sizeof(*us
->cr
),
413 GFP_KERNEL
, &us
->cr_dma
);
415 US_DEBUGP("usb_ctrlrequest allocation failed\n");
419 us
->iobuf
= usb_buffer_alloc(us
->pusb_dev
, US_IOBUF_SIZE
,
420 GFP_KERNEL
, &us
->iobuf_dma
);
422 US_DEBUGP("I/O buffer allocation failed\n");
428 /* Works only for digits and letters, but small and fast */
429 #define TOLOWER(x) ((x) | 0x20)
431 /* Adjust device flags based on the "quirks=" module parameter */
432 static void adjust_quirks(struct us_data
*us
)
435 u16 vid
= le16_to_cpu(us
->pusb_dev
->descriptor
.idVendor
);
436 u16 pid
= le16_to_cpu(us
->pusb_dev
->descriptor
.idProduct
);
438 unsigned int mask
= (US_FL_SANE_SENSE
| US_FL_FIX_CAPACITY
|
439 US_FL_CAPACITY_HEURISTICS
| US_FL_IGNORE_DEVICE
|
440 US_FL_NOT_LOCKABLE
| US_FL_MAX_SECTORS_64
|
441 US_FL_CAPACITY_OK
| US_FL_IGNORE_RESIDUE
|
442 US_FL_SINGLE_LUN
| US_FL_NO_WP_DETECT
);
446 /* Each entry consists of VID:PID:flags */
447 if (vid
== simple_strtoul(p
, &p
, 16) &&
449 pid
== simple_strtoul(p
+1, &p
, 16) &&
453 /* Move forward to the next entry */
459 if (!*p
) /* No match */
462 /* Collect the flags */
463 while (*++p
&& *p
!= ',') {
464 switch (TOLOWER(*p
)) {
466 f
|= US_FL_SANE_SENSE
;
469 f
|= US_FL_FIX_CAPACITY
;
472 f
|= US_FL_CAPACITY_HEURISTICS
;
475 f
|= US_FL_IGNORE_DEVICE
;
478 f
|= US_FL_NOT_LOCKABLE
;
481 f
|= US_FL_MAX_SECTORS_64
;
484 f
|= US_FL_CAPACITY_OK
;
487 f
|= US_FL_IGNORE_RESIDUE
;
490 f
|= US_FL_SINGLE_LUN
;
493 f
|= US_FL_NO_WP_DETECT
;
495 /* Ignore unrecognized flag characters */
498 us
->fflags
= (us
->fflags
& ~mask
) | f
;
499 dev_info(&us
->pusb_intf
->dev
, "Quirks match for "
500 "vid %04x pid %04x: %x\n",
504 /* Get the unusual_devs entries and the string descriptors */
505 static int get_device_info(struct us_data
*us
, const struct usb_device_id
*id
,
506 struct us_unusual_dev
*unusual_dev
)
508 struct usb_device
*dev
= us
->pusb_dev
;
509 struct usb_interface_descriptor
*idesc
=
510 &us
->pusb_intf
->cur_altsetting
->desc
;
512 /* Store the entries */
513 us
->unusual_dev
= unusual_dev
;
514 us
->subclass
= (unusual_dev
->useProtocol
== US_SC_DEVICE
) ?
515 idesc
->bInterfaceSubClass
:
516 unusual_dev
->useProtocol
;
517 us
->protocol
= (unusual_dev
->useTransport
== US_PR_DEVICE
) ?
518 idesc
->bInterfaceProtocol
:
519 unusual_dev
->useTransport
;
520 us
->fflags
= USB_US_ORIG_FLAGS(id
->driver_info
);
523 if (us
->fflags
& US_FL_IGNORE_DEVICE
) {
524 printk(KERN_INFO USB_STORAGE
"device ignored\n");
529 * This flag is only needed when we're in high-speed, so let's
530 * disable it if we're in full-speed
532 if (dev
->speed
!= USB_SPEED_HIGH
)
533 us
->fflags
&= ~US_FL_GO_SLOW
;
535 /* Log a message if a non-generic unusual_dev entry contains an
536 * unnecessary subclass or protocol override. This may stimulate
537 * reports from users that will help us remove unneeded entries
538 * from the unusual_devs.h table.
540 if (id
->idVendor
|| id
->idProduct
) {
541 static const char *msgs
[3] = {
542 "an unneeded SubClass entry",
543 "an unneeded Protocol entry",
544 "unneeded SubClass and Protocol entries"};
545 struct usb_device_descriptor
*ddesc
= &dev
->descriptor
;
548 if (unusual_dev
->useProtocol
!= US_SC_DEVICE
&&
549 us
->subclass
== idesc
->bInterfaceSubClass
)
551 if (unusual_dev
->useTransport
!= US_PR_DEVICE
&&
552 us
->protocol
== idesc
->bInterfaceProtocol
)
554 if (msg
>= 0 && !(us
->fflags
& US_FL_NEED_OVERRIDE
))
555 printk(KERN_NOTICE USB_STORAGE
"This device "
556 "(%04x,%04x,%04x S %02x P %02x)"
557 " has %s in unusual_devs.h (kernel"
559 " Please send a copy of this message to "
560 "<linux-usb@vger.kernel.org> and "
561 "<usb-storage@lists.one-eyed-alien.net>\n",
562 le16_to_cpu(ddesc
->idVendor
),
563 le16_to_cpu(ddesc
->idProduct
),
564 le16_to_cpu(ddesc
->bcdDevice
),
565 idesc
->bInterfaceSubClass
,
566 idesc
->bInterfaceProtocol
,
574 /* Get the transport settings */
575 static void get_transport(struct us_data
*us
)
577 switch (us
->protocol
) {
579 us
->transport_name
= "Control/Bulk";
580 us
->transport
= usb_stor_CB_transport
;
581 us
->transport_reset
= usb_stor_CB_reset
;
586 us
->transport_name
= "Control/Bulk/Interrupt";
587 us
->transport
= usb_stor_CB_transport
;
588 us
->transport_reset
= usb_stor_CB_reset
;
593 us
->transport_name
= "Bulk";
594 us
->transport
= usb_stor_Bulk_transport
;
595 us
->transport_reset
= usb_stor_Bulk_reset
;
598 #ifdef CONFIG_USB_STORAGE_KARMA
600 us
->transport_name
= "Rio Karma/Bulk";
601 us
->transport
= rio_karma_transport
;
602 us
->transport_reset
= usb_stor_Bulk_reset
;
609 /* Get the protocol settings */
610 static void get_protocol(struct us_data
*us
)
612 switch (us
->subclass
) {
614 us
->protocol_name
= "Reduced Block Commands (RBC)";
615 us
->proto_handler
= usb_stor_transparent_scsi_command
;
619 us
->protocol_name
= "8020i";
620 us
->proto_handler
= usb_stor_pad12_command
;
625 us
->protocol_name
= "QIC-157";
626 us
->proto_handler
= usb_stor_pad12_command
;
631 us
->protocol_name
= "8070i";
632 us
->proto_handler
= usb_stor_pad12_command
;
637 us
->protocol_name
= "Transparent SCSI";
638 us
->proto_handler
= usb_stor_transparent_scsi_command
;
642 us
->protocol_name
= "Uniform Floppy Interface (UFI)";
643 us
->proto_handler
= usb_stor_ufi_command
;
648 /* Get the pipe settings */
649 static int get_pipes(struct us_data
*us
)
651 struct usb_host_interface
*altsetting
=
652 us
->pusb_intf
->cur_altsetting
;
654 struct usb_endpoint_descriptor
*ep
;
655 struct usb_endpoint_descriptor
*ep_in
= NULL
;
656 struct usb_endpoint_descriptor
*ep_out
= NULL
;
657 struct usb_endpoint_descriptor
*ep_int
= NULL
;
660 * Find the first endpoint of each type we need.
661 * We are expecting a minimum of 2 endpoints - in and out (bulk).
662 * An optional interrupt-in is OK (necessary for CBI protocol).
663 * We will ignore any others.
665 for (i
= 0; i
< altsetting
->desc
.bNumEndpoints
; i
++) {
666 ep
= &altsetting
->endpoint
[i
].desc
;
668 if (usb_endpoint_xfer_bulk(ep
)) {
669 if (usb_endpoint_dir_in(ep
)) {
678 else if (usb_endpoint_is_int_in(ep
)) {
684 if (!ep_in
|| !ep_out
|| (us
->protocol
== US_PR_CBI
&& !ep_int
)) {
685 US_DEBUGP("Endpoint sanity check failed! Rejecting dev.\n");
689 /* Calculate and store the pipe values */
690 us
->send_ctrl_pipe
= usb_sndctrlpipe(us
->pusb_dev
, 0);
691 us
->recv_ctrl_pipe
= usb_rcvctrlpipe(us
->pusb_dev
, 0);
692 us
->send_bulk_pipe
= usb_sndbulkpipe(us
->pusb_dev
,
693 usb_endpoint_num(ep_out
));
694 us
->recv_bulk_pipe
= usb_rcvbulkpipe(us
->pusb_dev
,
695 usb_endpoint_num(ep_in
));
697 us
->recv_intr_pipe
= usb_rcvintpipe(us
->pusb_dev
,
698 usb_endpoint_num(ep_int
));
699 us
->ep_bInterval
= ep_int
->bInterval
;
704 /* Initialize all the dynamic resources we need */
705 static int usb_stor_acquire_resources(struct us_data
*us
)
708 struct task_struct
*th
;
710 us
->current_urb
= usb_alloc_urb(0, GFP_KERNEL
);
711 if (!us
->current_urb
) {
712 US_DEBUGP("URB allocation failed\n");
716 /* Just before we start our control thread, initialize
717 * the device if it needs initialization */
718 if (us
->unusual_dev
->initFunction
) {
719 p
= us
->unusual_dev
->initFunction(us
);
724 /* Start up our control thread */
725 th
= kthread_run(usb_stor_control_thread
, us
, "usb-storage");
727 printk(KERN_WARNING USB_STORAGE
728 "Unable to start control thread\n");
736 /* Release all our dynamic resources */
737 static void usb_stor_release_resources(struct us_data
*us
)
739 US_DEBUGP("-- %s\n", __func__
);
741 /* Tell the control thread to exit. The SCSI host must
742 * already have been removed and the DISCONNECTING flag set
743 * so that we won't accept any more commands.
745 US_DEBUGP("-- sending exit command to thread\n");
746 complete(&us
->cmnd_ready
);
748 kthread_stop(us
->ctl_thread
);
750 /* Call the destructor routine, if it exists */
751 if (us
->extra_destructor
) {
752 US_DEBUGP("-- calling extra_destructor()\n");
753 us
->extra_destructor(us
->extra
);
756 /* Free the extra data and the URB */
758 usb_free_urb(us
->current_urb
);
761 /* Dissociate from the USB device */
762 static void dissociate_dev(struct us_data
*us
)
764 US_DEBUGP("-- %s\n", __func__
);
766 /* Free the device-related DMA-mapped buffers */
768 usb_buffer_free(us
->pusb_dev
, sizeof(*us
->cr
), us
->cr
,
771 usb_buffer_free(us
->pusb_dev
, US_IOBUF_SIZE
, us
->iobuf
,
774 /* Remove our private data from the interface */
775 usb_set_intfdata(us
->pusb_intf
, NULL
);
778 /* First stage of disconnect processing: stop SCSI scanning,
779 * remove the host, and stop accepting new commands
781 static void quiesce_and_remove_host(struct us_data
*us
)
783 struct Scsi_Host
*host
= us_to_host(us
);
785 /* If the device is really gone, cut short reset delays */
786 if (us
->pusb_dev
->state
== USB_STATE_NOTATTACHED
)
787 set_bit(US_FLIDX_DISCONNECTING
, &us
->dflags
);
789 /* Prevent SCSI-scanning (if it hasn't started yet)
790 * and wait for the SCSI-scanning thread to stop.
792 set_bit(US_FLIDX_DONT_SCAN
, &us
->dflags
);
793 wake_up(&us
->delay_wait
);
794 wait_for_completion(&us
->scanning_done
);
796 /* Removing the host will perform an orderly shutdown: caches
797 * synchronized, disks spun down, etc.
799 scsi_remove_host(host
);
801 /* Prevent any new commands from being accepted and cut short
805 set_bit(US_FLIDX_DISCONNECTING
, &us
->dflags
);
807 wake_up(&us
->delay_wait
);
810 /* Second stage of disconnect processing: deallocate all resources */
811 static void release_everything(struct us_data
*us
)
813 usb_stor_release_resources(us
);
816 /* Drop our reference to the host; the SCSI core will free it
817 * (and "us" along with it) when the refcount becomes 0. */
818 scsi_host_put(us_to_host(us
));
821 /* Thread to carry out delayed SCSI-device scanning */
822 static int usb_stor_scan_thread(void * __us
)
824 struct us_data
*us
= (struct us_data
*)__us
;
827 "usb-storage: device found at %d\n", us
->pusb_dev
->devnum
);
830 /* Wait for the timeout to expire or for a disconnect */
832 printk(KERN_DEBUG
"usb-storage: waiting for device "
833 "to settle before scanning\n");
834 wait_event_freezable_timeout(us
->delay_wait
,
835 test_bit(US_FLIDX_DONT_SCAN
, &us
->dflags
),
839 /* If the device is still connected, perform the scanning */
840 if (!test_bit(US_FLIDX_DONT_SCAN
, &us
->dflags
)) {
842 /* For bulk-only devices, determine the max LUN value */
843 if (us
->protocol
== US_PR_BULK
&&
844 !(us
->fflags
& US_FL_SINGLE_LUN
)) {
845 mutex_lock(&us
->dev_mutex
);
846 us
->max_lun
= usb_stor_Bulk_max_lun(us
);
847 mutex_unlock(&us
->dev_mutex
);
849 scsi_scan_host(us_to_host(us
));
850 printk(KERN_DEBUG
"usb-storage: device scan complete\n");
852 /* Should we unbind if no devices were detected? */
855 complete_and_exit(&us
->scanning_done
, 0);
859 /* First part of general USB mass-storage probing */
860 int usb_stor_probe1(struct us_data
**pus
,
861 struct usb_interface
*intf
,
862 const struct usb_device_id
*id
,
863 struct us_unusual_dev
*unusual_dev
)
865 struct Scsi_Host
*host
;
869 US_DEBUGP("USB Mass Storage device detected\n");
872 * Ask the SCSI layer to allocate a host structure, with extra
873 * space at the end for our private us_data structure.
875 host
= scsi_host_alloc(&usb_stor_host_template
, sizeof(*us
));
877 printk(KERN_WARNING USB_STORAGE
878 "Unable to allocate the scsi host\n");
883 * Allow 16-byte CDBs and thus > 2TB
885 host
->max_cmd_len
= 16;
886 *pus
= us
= host_to_us(host
);
887 memset(us
, 0, sizeof(struct us_data
));
888 mutex_init(&(us
->dev_mutex
));
889 init_completion(&us
->cmnd_ready
);
890 init_completion(&(us
->notify
));
891 init_waitqueue_head(&us
->delay_wait
);
892 init_completion(&us
->scanning_done
);
894 /* Associate the us_data structure with the USB device */
895 result
= associate_dev(us
, intf
);
899 /* Get the unusual_devs entries and the descriptors */
900 result
= get_device_info(us
, id
, unusual_dev
);
904 /* Get standard transport and protocol settings */
908 /* Give the caller a chance to fill in specialized transport
909 * or protocol settings.
914 US_DEBUGP("storage_probe() failed\n");
915 release_everything(us
);
918 EXPORT_SYMBOL_GPL(usb_stor_probe1
);
920 /* Second part of general USB mass-storage probing */
921 int usb_stor_probe2(struct us_data
*us
)
923 struct task_struct
*th
;
926 /* Make sure the transport and protocol have both been set */
927 if (!us
->transport
|| !us
->proto_handler
) {
931 US_DEBUGP("Transport: %s\n", us
->transport_name
);
932 US_DEBUGP("Protocol: %s\n", us
->protocol_name
);
934 /* fix for single-lun devices */
935 if (us
->fflags
& US_FL_SINGLE_LUN
)
938 /* Find the endpoints and calculate pipe values */
939 result
= get_pipes(us
);
943 /* Acquire all the other resources and add the host */
944 result
= usb_stor_acquire_resources(us
);
947 result
= scsi_add_host(us_to_host(us
), &us
->pusb_intf
->dev
);
949 printk(KERN_WARNING USB_STORAGE
950 "Unable to add the scsi host\n");
954 /* Start up the thread for delayed SCSI-device scanning */
955 th
= kthread_create(usb_stor_scan_thread
, us
, "usb-stor-scan");
957 printk(KERN_WARNING USB_STORAGE
958 "Unable to start the device-scanning thread\n");
959 complete(&us
->scanning_done
);
960 quiesce_and_remove_host(us
);
961 result
= PTR_ERR(th
);
969 /* We come here if there are any problems */
971 US_DEBUGP("storage_probe() failed\n");
972 release_everything(us
);
975 EXPORT_SYMBOL_GPL(usb_stor_probe2
);
977 /* Handle a USB mass-storage disconnect */
978 void usb_stor_disconnect(struct usb_interface
*intf
)
980 struct us_data
*us
= usb_get_intfdata(intf
);
982 US_DEBUGP("storage_disconnect() called\n");
983 quiesce_and_remove_host(us
);
984 release_everything(us
);
986 EXPORT_SYMBOL_GPL(usb_stor_disconnect
);
988 /* The main probe routine for standard devices */
989 static int storage_probe(struct usb_interface
*intf
,
990 const struct usb_device_id
*id
)
996 * If libusual is configured, let it decide whether a standard
997 * device should be handled by usb-storage or by ub.
998 * If the device isn't standard (is handled by a subdriver
999 * module) then don't accept it.
1001 if (usb_usual_check_type(id
, USB_US_TYPE_STOR
) ||
1002 usb_usual_ignore_device(intf
))
1006 * Call the general probe procedures.
1008 * The unusual_dev_list array is parallel to the usb_storage_usb_ids
1009 * table, so we use the index of the id entry to find the
1010 * corresponding unusual_devs entry.
1012 result
= usb_stor_probe1(&us
, intf
, id
,
1013 (id
- usb_storage_usb_ids
) + us_unusual_dev_list
);
1017 /* No special transport or protocol settings in the main module */
1019 result
= usb_stor_probe2(us
);
1023 /***********************************************************************
1024 * Initialization and registration
1025 ***********************************************************************/
1027 static struct usb_driver usb_storage_driver
= {
1028 .name
= "usb-storage",
1029 .probe
= storage_probe
,
1030 .disconnect
= usb_stor_disconnect
,
1031 .suspend
= usb_stor_suspend
,
1032 .resume
= usb_stor_resume
,
1033 .reset_resume
= usb_stor_reset_resume
,
1034 .pre_reset
= usb_stor_pre_reset
,
1035 .post_reset
= usb_stor_post_reset
,
1036 .id_table
= usb_storage_usb_ids
,
1040 static int __init
usb_stor_init(void)
1044 printk(KERN_INFO
"Initializing USB Mass Storage driver...\n");
1046 /* register the driver, return usb_register return code if error */
1047 retval
= usb_register(&usb_storage_driver
);
1049 printk(KERN_INFO
"USB Mass Storage support registered.\n");
1050 usb_usual_set_present(USB_US_TYPE_STOR
);
1055 static void __exit
usb_stor_exit(void)
1057 US_DEBUGP("usb_stor_exit() called\n");
1059 /* Deregister the driver
1060 * This will cause disconnect() to be called for each
1063 US_DEBUGP("-- calling usb_deregister()\n");
1064 usb_deregister(&usb_storage_driver
) ;
1066 usb_usual_clear_present(USB_US_TYPE_STOR
);
1069 module_init(usb_stor_init
);
1070 module_exit(usb_stor_exit
);