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 #ifdef CONFIG_USB_STORAGE_DEBUG
54 #include <linux/sched.h>
55 #include <linux/errno.h>
56 #include <linux/freezer.h>
57 #include <linux/module.h>
58 #include <linux/init.h>
59 #include <linux/slab.h>
60 #include <linux/kthread.h>
61 #include <linux/mutex.h>
62 #include <linux/utsname.h>
64 #include <scsi/scsi.h>
65 #include <scsi/scsi_cmnd.h>
66 #include <scsi/scsi_device.h>
70 #include "transport.h"
73 #include "initializers.h"
75 #ifdef CONFIG_USB_STORAGE_USBAT
76 #include "shuttle_usbat.h"
78 #ifdef CONFIG_USB_STORAGE_SDDR09
81 #ifdef CONFIG_USB_STORAGE_SDDR55
84 #ifdef CONFIG_USB_STORAGE_DPCM
87 #ifdef CONFIG_USB_STORAGE_FREECOM
90 #ifdef CONFIG_USB_STORAGE_ISD200
93 #ifdef CONFIG_USB_STORAGE_DATAFAB
96 #ifdef CONFIG_USB_STORAGE_JUMPSHOT
99 #ifdef CONFIG_USB_STORAGE_ONETOUCH
100 #include "onetouch.h"
102 #ifdef CONFIG_USB_STORAGE_ALAUDA
105 #ifdef CONFIG_USB_STORAGE_KARMA
108 #include "sierra_ms.h"
109 #include "option_ms.h"
111 /* Some informational data */
112 MODULE_AUTHOR("Matthew Dharm <mdharm-usb@one-eyed-alien.net>");
113 MODULE_DESCRIPTION("USB Mass Storage driver for Linux");
114 MODULE_LICENSE("GPL");
116 static unsigned int delay_use
= 2;
117 module_param(delay_use
, uint
, S_IRUGO
| S_IWUSR
);
118 MODULE_PARM_DESC(delay_use
, "seconds to delay before using a new device");
120 static char quirks
[128];
121 module_param_string(quirks
, quirks
, sizeof(quirks
), S_IRUGO
| S_IWUSR
);
122 MODULE_PARM_DESC(quirks
, "supplemental list of device IDs and their quirks");
126 * The entries in this table correspond, line for line,
127 * with the entries of us_unusual_dev_list[].
129 #ifndef CONFIG_USB_LIBUSUAL
131 #define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \
132 vendorName, productName,useProtocol, useTransport, \
133 initFunction, flags) \
134 { USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin,bcdDeviceMax), \
135 .driver_info = (flags)|(USB_US_TYPE_STOR<<24) }
137 #define COMPLIANT_DEV UNUSUAL_DEV
139 #define USUAL_DEV(useProto, useTrans, useType) \
140 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, useProto, useTrans), \
141 .driver_info = (USB_US_TYPE_STOR<<24) }
143 static struct usb_device_id storage_usb_ids
[] = {
145 # include "unusual_devs.h"
149 /* Terminating entry */
153 MODULE_DEVICE_TABLE (usb
, storage_usb_ids
);
154 #endif /* CONFIG_USB_LIBUSUAL */
156 /* This is the list of devices we recognize, along with their flag data */
158 /* The vendor name should be kept at eight characters or less, and
159 * the product name should be kept at 16 characters or less. If a device
160 * has the US_FL_FIX_INQUIRY flag, then the vendor and product names
161 * normally generated by a device thorugh the INQUIRY response will be
162 * taken from this list, and this is the reason for the above size
163 * restriction. However, if the flag is not present, then you
164 * are free to use as many characters as you like.
167 #define UNUSUAL_DEV(idVendor, idProduct, bcdDeviceMin, bcdDeviceMax, \
168 vendor_name, product_name, use_protocol, use_transport, \
169 init_function, Flags) \
171 .vendorName = vendor_name, \
172 .productName = product_name, \
173 .useProtocol = use_protocol, \
174 .useTransport = use_transport, \
175 .initFunction = init_function, \
178 #define COMPLIANT_DEV UNUSUAL_DEV
180 #define USUAL_DEV(use_protocol, use_transport, use_type) \
182 .useProtocol = use_protocol, \
183 .useTransport = use_transport, \
186 static struct us_unusual_dev us_unusual_dev_list
[] = {
187 # include "unusual_devs.h"
189 # undef COMPLIANT_DEV
192 /* Terminating entry */
197 #ifdef CONFIG_PM /* Minimal support for suspend and resume */
199 static int storage_suspend(struct usb_interface
*iface
, pm_message_t message
)
201 struct us_data
*us
= usb_get_intfdata(iface
);
203 /* Wait until no command is running */
204 mutex_lock(&us
->dev_mutex
);
206 US_DEBUGP("%s\n", __FUNCTION__
);
207 if (us
->suspend_resume_hook
)
208 (us
->suspend_resume_hook
)(us
, US_SUSPEND
);
210 /* When runtime PM is working, we'll set a flag to indicate
211 * whether we should autoresume when a SCSI request arrives. */
213 mutex_unlock(&us
->dev_mutex
);
217 static int storage_resume(struct usb_interface
*iface
)
219 struct us_data
*us
= usb_get_intfdata(iface
);
221 mutex_lock(&us
->dev_mutex
);
223 US_DEBUGP("%s\n", __FUNCTION__
);
224 if (us
->suspend_resume_hook
)
225 (us
->suspend_resume_hook
)(us
, US_RESUME
);
227 mutex_unlock(&us
->dev_mutex
);
231 static int storage_reset_resume(struct usb_interface
*iface
)
233 struct us_data
*us
= usb_get_intfdata(iface
);
235 US_DEBUGP("%s\n", __FUNCTION__
);
237 /* Report the reset to the SCSI core */
238 usb_stor_report_bus_reset(us
);
240 /* FIXME: Notify the subdrivers that they need to reinitialize
245 #endif /* CONFIG_PM */
248 * The next two routines get called just before and just after
249 * a USB port reset, whether from this driver or a different one.
252 static int storage_pre_reset(struct usb_interface
*iface
)
254 struct us_data
*us
= usb_get_intfdata(iface
);
256 US_DEBUGP("%s\n", __FUNCTION__
);
258 /* Make sure no command runs during the reset */
259 mutex_lock(&us
->dev_mutex
);
263 static int storage_post_reset(struct usb_interface
*iface
)
265 struct us_data
*us
= usb_get_intfdata(iface
);
267 US_DEBUGP("%s\n", __FUNCTION__
);
269 /* Report the reset to the SCSI core */
270 usb_stor_report_bus_reset(us
);
272 /* FIXME: Notify the subdrivers that they need to reinitialize
275 mutex_unlock(&us
->dev_mutex
);
280 * fill_inquiry_response takes an unsigned char array (which must
281 * be at least 36 characters) and populates the vendor name,
282 * product name, and revision fields. Then the array is copied
283 * into the SCSI command's response buffer (oddly enough
284 * called request_buffer). data_len contains the length of the
285 * data array, which again must be at least 36.
288 void fill_inquiry_response(struct us_data
*us
, unsigned char *data
,
289 unsigned int data_len
)
291 if (data_len
<36) // You lose.
294 memset(data
+8, ' ', 28);
295 if(data
[0]&0x20) { /* USB device currently not connected. Return
296 peripheral qualifier 001b ("...however, the
297 physical device is not currently connected
298 to this logical unit") and leave vendor and
299 product identification empty. ("If the target
300 does store some of the INQUIRY data on the
301 device, it may return zeros or ASCII spaces
302 (20h) in those fields until the data is
303 available from the device."). */
305 u16 bcdDevice
= le16_to_cpu(us
->pusb_dev
->descriptor
.bcdDevice
);
308 n
= strlen(us
->unusual_dev
->vendorName
);
309 memcpy(data
+8, us
->unusual_dev
->vendorName
, min(8, n
));
310 n
= strlen(us
->unusual_dev
->productName
);
311 memcpy(data
+16, us
->unusual_dev
->productName
, min(16, n
));
313 data
[32] = 0x30 + ((bcdDevice
>>12) & 0x0F);
314 data
[33] = 0x30 + ((bcdDevice
>>8) & 0x0F);
315 data
[34] = 0x30 + ((bcdDevice
>>4) & 0x0F);
316 data
[35] = 0x30 + ((bcdDevice
) & 0x0F);
319 usb_stor_set_xfer_buf(data
, data_len
, us
->srb
);
322 static int usb_stor_control_thread(void * __us
)
324 struct us_data
*us
= (struct us_data
*)__us
;
325 struct Scsi_Host
*host
= us_to_host(us
);
327 current
->flags
|= PF_NOFREEZE
;
330 US_DEBUGP("*** thread sleeping.\n");
331 if (wait_for_completion_interruptible(&us
->cmnd_ready
))
334 US_DEBUGP("*** thread awakened.\n");
336 /* lock the device pointers */
337 mutex_lock(&(us
->dev_mutex
));
339 /* lock access to the state */
342 /* When we are called with no command pending, we're done */
343 if (us
->srb
== NULL
) {
345 mutex_unlock(&us
->dev_mutex
);
346 US_DEBUGP("-- exiting\n");
350 /* has the command timed out *already* ? */
351 if (test_bit(US_FLIDX_TIMED_OUT
, &us
->dflags
)) {
352 us
->srb
->result
= DID_ABORT
<< 16;
358 /* reject the command if the direction indicator
361 if (us
->srb
->sc_data_direction
== DMA_BIDIRECTIONAL
) {
362 US_DEBUGP("UNKNOWN data direction\n");
363 us
->srb
->result
= DID_ERROR
<< 16;
366 /* reject if target != 0 or if LUN is higher than
367 * the maximum known LUN
369 else if (us
->srb
->device
->id
&&
370 !(us
->fflags
& US_FL_SCM_MULT_TARG
)) {
371 US_DEBUGP("Bad target number (%d:%d)\n",
372 us
->srb
->device
->id
, us
->srb
->device
->lun
);
373 us
->srb
->result
= DID_BAD_TARGET
<< 16;
376 else if (us
->srb
->device
->lun
> us
->max_lun
) {
377 US_DEBUGP("Bad LUN (%d:%d)\n",
378 us
->srb
->device
->id
, us
->srb
->device
->lun
);
379 us
->srb
->result
= DID_BAD_TARGET
<< 16;
382 /* Handle those devices which need us to fake
383 * their inquiry data */
384 else if ((us
->srb
->cmnd
[0] == INQUIRY
) &&
385 (us
->fflags
& US_FL_FIX_INQUIRY
)) {
386 unsigned char data_ptr
[36] = {
387 0x00, 0x80, 0x02, 0x02,
388 0x1F, 0x00, 0x00, 0x00};
390 US_DEBUGP("Faking INQUIRY command\n");
391 fill_inquiry_response(us
, data_ptr
, 36);
392 us
->srb
->result
= SAM_STAT_GOOD
;
395 /* we've got a command, let's do it! */
397 US_DEBUG(usb_stor_show_command(us
->srb
));
398 us
->proto_handler(us
->srb
, us
);
401 /* lock access to the state */
404 /* indicate that the command is done */
405 if (us
->srb
->result
!= DID_ABORT
<< 16) {
406 US_DEBUGP("scsi cmd done, result=0x%x\n",
408 us
->srb
->scsi_done(us
->srb
);
411 US_DEBUGP("scsi command aborted\n");
414 /* If an abort request was received we need to signal that
415 * the abort has finished. The proper test for this is
416 * the TIMED_OUT flag, not srb->result == DID_ABORT, because
417 * the timeout might have occurred after the command had
418 * already completed with a different result code. */
419 if (test_bit(US_FLIDX_TIMED_OUT
, &us
->dflags
)) {
420 complete(&(us
->notify
));
422 /* Allow USB transfers to resume */
423 clear_bit(US_FLIDX_ABORTING
, &us
->dflags
);
424 clear_bit(US_FLIDX_TIMED_OUT
, &us
->dflags
);
427 /* finished working on this command */
431 /* unlock the device pointers */
432 mutex_unlock(&us
->dev_mutex
);
435 /* Wait until we are told to stop */
437 set_current_state(TASK_INTERRUPTIBLE
);
438 if (kthread_should_stop())
442 __set_current_state(TASK_RUNNING
);
446 /***********************************************************************
447 * Device probing and disconnecting
448 ***********************************************************************/
450 /* Associate our private data with the USB device */
451 static int associate_dev(struct us_data
*us
, struct usb_interface
*intf
)
453 US_DEBUGP("-- %s\n", __FUNCTION__
);
455 /* Fill in the device-related fields */
456 us
->pusb_dev
= interface_to_usbdev(intf
);
457 us
->pusb_intf
= intf
;
458 us
->ifnum
= intf
->cur_altsetting
->desc
.bInterfaceNumber
;
459 US_DEBUGP("Vendor: 0x%04x, Product: 0x%04x, Revision: 0x%04x\n",
460 le16_to_cpu(us
->pusb_dev
->descriptor
.idVendor
),
461 le16_to_cpu(us
->pusb_dev
->descriptor
.idProduct
),
462 le16_to_cpu(us
->pusb_dev
->descriptor
.bcdDevice
));
463 US_DEBUGP("Interface Subclass: 0x%02x, Protocol: 0x%02x\n",
464 intf
->cur_altsetting
->desc
.bInterfaceSubClass
,
465 intf
->cur_altsetting
->desc
.bInterfaceProtocol
);
467 /* Store our private data in the interface */
468 usb_set_intfdata(intf
, us
);
470 /* Allocate the device-related DMA-mapped buffers */
471 us
->cr
= usb_buffer_alloc(us
->pusb_dev
, sizeof(*us
->cr
),
472 GFP_KERNEL
, &us
->cr_dma
);
474 US_DEBUGP("usb_ctrlrequest allocation failed\n");
478 us
->iobuf
= usb_buffer_alloc(us
->pusb_dev
, US_IOBUF_SIZE
,
479 GFP_KERNEL
, &us
->iobuf_dma
);
481 US_DEBUGP("I/O buffer allocation failed\n");
487 /* Works only for digits and letters, but small and fast */
488 #define TOLOWER(x) ((x) | 0x20)
490 /* Adjust device flags based on the "quirks=" module parameter */
491 static void adjust_quirks(struct us_data
*us
)
494 u16 vid
= le16_to_cpu(us
->pusb_dev
->descriptor
.idVendor
);
495 u16 pid
= le16_to_cpu(us
->pusb_dev
->descriptor
.idProduct
);
497 unsigned int mask
= (US_FL_SANE_SENSE
| US_FL_BAD_SENSE
|
499 US_FL_CAPACITY_HEURISTICS
| US_FL_IGNORE_DEVICE
|
500 US_FL_NOT_LOCKABLE
| US_FL_MAX_SECTORS_64
|
501 US_FL_CAPACITY_OK
| US_FL_IGNORE_RESIDUE
|
502 US_FL_SINGLE_LUN
| US_FL_NO_WP_DETECT
);
506 /* Each entry consists of VID:PID:flags */
507 if (vid
== simple_strtoul(p
, &p
, 16) &&
509 pid
== simple_strtoul(p
+1, &p
, 16) &&
513 /* Move forward to the next entry */
519 if (!*p
) /* No match */
522 /* Collect the flags */
523 while (*++p
&& *p
!= ',') {
524 switch (TOLOWER(*p
)) {
526 f
|= US_FL_SANE_SENSE
;
529 f
|= US_FL_BAD_SENSE
;
532 f
|= US_FL_FIX_CAPACITY
;
535 f
|= US_FL_CAPACITY_HEURISTICS
;
538 f
|= US_FL_IGNORE_DEVICE
;
541 f
|= US_FL_NOT_LOCKABLE
;
544 f
|= US_FL_MAX_SECTORS_64
;
547 f
|= US_FL_CAPACITY_OK
;
550 f
|= US_FL_IGNORE_RESIDUE
;
553 f
|= US_FL_SINGLE_LUN
;
556 f
|= US_FL_NO_WP_DETECT
;
558 /* Ignore unrecognized flag characters */
561 us
->fflags
= (us
->fflags
& ~mask
) | f
;
564 /* Find an unusual_dev descriptor (always succeeds in the current code) */
565 static struct us_unusual_dev
*find_unusual(const struct usb_device_id
*id
)
567 const int id_index
= id
- storage_usb_ids
;
568 return &us_unusual_dev_list
[id_index
];
571 /* Get the unusual_devs entries and the string descriptors */
572 static int get_device_info(struct us_data
*us
, const struct usb_device_id
*id
)
574 struct usb_device
*dev
= us
->pusb_dev
;
575 struct usb_interface_descriptor
*idesc
=
576 &us
->pusb_intf
->cur_altsetting
->desc
;
577 struct us_unusual_dev
*unusual_dev
= find_unusual(id
);
579 /* Store the entries */
580 us
->unusual_dev
= unusual_dev
;
581 us
->subclass
= (unusual_dev
->useProtocol
== US_SC_DEVICE
) ?
582 idesc
->bInterfaceSubClass
:
583 unusual_dev
->useProtocol
;
584 us
->protocol
= (unusual_dev
->useTransport
== US_PR_DEVICE
) ?
585 idesc
->bInterfaceProtocol
:
586 unusual_dev
->useTransport
;
587 us
->fflags
= USB_US_ORIG_FLAGS(id
->driver_info
);
590 if (us
->fflags
& US_FL_IGNORE_DEVICE
) {
591 printk(KERN_INFO USB_STORAGE
"device ignored\n");
596 * This flag is only needed when we're in high-speed, so let's
597 * disable it if we're in full-speed
599 if (dev
->speed
!= USB_SPEED_HIGH
)
600 us
->fflags
&= ~US_FL_GO_SLOW
;
603 printk(KERN_INFO USB_STORAGE
"Quirks match for vid %04x pid %04x: %lx\n",
604 le16_to_cpu(dev
->descriptor
.idVendor
),
605 le16_to_cpu(dev
->descriptor
.idProduct
),
608 /* Log a message if a non-generic unusual_dev entry contains an
609 * unnecessary subclass or protocol override. This may stimulate
610 * reports from users that will help us remove unneeded entries
611 * from the unusual_devs.h table.
613 if (id
->idVendor
|| id
->idProduct
) {
614 static const char *msgs
[3] = {
615 "an unneeded SubClass entry",
616 "an unneeded Protocol entry",
617 "unneeded SubClass and Protocol entries"};
618 struct usb_device_descriptor
*ddesc
= &dev
->descriptor
;
621 if (unusual_dev
->useProtocol
!= US_SC_DEVICE
&&
622 us
->subclass
== idesc
->bInterfaceSubClass
)
624 if (unusual_dev
->useTransport
!= US_PR_DEVICE
&&
625 us
->protocol
== idesc
->bInterfaceProtocol
)
627 if (msg
>= 0 && !(us
->fflags
& US_FL_NEED_OVERRIDE
))
628 printk(KERN_NOTICE USB_STORAGE
"This device "
629 "(%04x,%04x,%04x S %02x P %02x)"
630 " has %s in unusual_devs.h (kernel"
632 " Please send a copy of this message to "
633 "<linux-usb-devel@lists.sourceforge.net>\n",
634 le16_to_cpu(ddesc
->idVendor
),
635 le16_to_cpu(ddesc
->idProduct
),
636 le16_to_cpu(ddesc
->bcdDevice
),
637 idesc
->bInterfaceSubClass
,
638 idesc
->bInterfaceProtocol
,
646 /* Get the transport settings */
647 static int get_transport(struct us_data
*us
)
649 switch (us
->protocol
) {
651 us
->transport_name
= "Control/Bulk";
652 us
->transport
= usb_stor_CB_transport
;
653 us
->transport_reset
= usb_stor_CB_reset
;
658 us
->transport_name
= "Control/Bulk/Interrupt";
659 us
->transport
= usb_stor_CB_transport
;
660 us
->transport_reset
= usb_stor_CB_reset
;
665 us
->transport_name
= "Bulk";
666 us
->transport
= usb_stor_Bulk_transport
;
667 us
->transport_reset
= usb_stor_Bulk_reset
;
670 #ifdef CONFIG_USB_STORAGE_USBAT
672 us
->transport_name
= "Shuttle USBAT";
673 us
->transport
= usbat_transport
;
674 us
->transport_reset
= usb_stor_CB_reset
;
679 #ifdef CONFIG_USB_STORAGE_SDDR09
680 case US_PR_EUSB_SDDR09
:
681 us
->transport_name
= "EUSB/SDDR09";
682 us
->transport
= sddr09_transport
;
683 us
->transport_reset
= usb_stor_CB_reset
;
688 #ifdef CONFIG_USB_STORAGE_SDDR55
690 us
->transport_name
= "SDDR55";
691 us
->transport
= sddr55_transport
;
692 us
->transport_reset
= sddr55_reset
;
697 #ifdef CONFIG_USB_STORAGE_DPCM
699 us
->transport_name
= "Control/Bulk-EUSB/SDDR09";
700 us
->transport
= dpcm_transport
;
701 us
->transport_reset
= usb_stor_CB_reset
;
706 #ifdef CONFIG_USB_STORAGE_FREECOM
708 us
->transport_name
= "Freecom";
709 us
->transport
= freecom_transport
;
710 us
->transport_reset
= usb_stor_freecom_reset
;
715 #ifdef CONFIG_USB_STORAGE_DATAFAB
717 us
->transport_name
= "Datafab Bulk-Only";
718 us
->transport
= datafab_transport
;
719 us
->transport_reset
= usb_stor_Bulk_reset
;
724 #ifdef CONFIG_USB_STORAGE_JUMPSHOT
726 us
->transport_name
= "Lexar Jumpshot Control/Bulk";
727 us
->transport
= jumpshot_transport
;
728 us
->transport_reset
= usb_stor_Bulk_reset
;
733 #ifdef CONFIG_USB_STORAGE_ALAUDA
735 us
->transport_name
= "Alauda Control/Bulk";
736 us
->transport
= alauda_transport
;
737 us
->transport_reset
= usb_stor_Bulk_reset
;
742 #ifdef CONFIG_USB_STORAGE_KARMA
744 us
->transport_name
= "Rio Karma/Bulk";
745 us
->transport
= rio_karma_transport
;
746 us
->transport_reset
= usb_stor_Bulk_reset
;
753 US_DEBUGP("Transport: %s\n", us
->transport_name
);
755 /* fix for single-lun devices */
756 if (us
->fflags
& US_FL_SINGLE_LUN
)
761 /* Get the protocol settings */
762 static int get_protocol(struct us_data
*us
)
764 switch (us
->subclass
) {
766 us
->protocol_name
= "Reduced Block Commands (RBC)";
767 us
->proto_handler
= usb_stor_transparent_scsi_command
;
771 us
->protocol_name
= "8020i";
772 us
->proto_handler
= usb_stor_ATAPI_command
;
777 us
->protocol_name
= "QIC-157";
778 us
->proto_handler
= usb_stor_qic157_command
;
783 us
->protocol_name
= "8070i";
784 us
->proto_handler
= usb_stor_ATAPI_command
;
789 us
->protocol_name
= "Transparent SCSI";
790 us
->proto_handler
= usb_stor_transparent_scsi_command
;
794 us
->protocol_name
= "Uniform Floppy Interface (UFI)";
795 us
->proto_handler
= usb_stor_ufi_command
;
798 #ifdef CONFIG_USB_STORAGE_ISD200
800 us
->protocol_name
= "ISD200 ATA/ATAPI";
801 us
->proto_handler
= isd200_ata_command
;
808 US_DEBUGP("Protocol: %s\n", us
->protocol_name
);
812 /* Get the pipe settings */
813 static int get_pipes(struct us_data
*us
)
815 struct usb_host_interface
*altsetting
=
816 us
->pusb_intf
->cur_altsetting
;
818 struct usb_endpoint_descriptor
*ep
;
819 struct usb_endpoint_descriptor
*ep_in
= NULL
;
820 struct usb_endpoint_descriptor
*ep_out
= NULL
;
821 struct usb_endpoint_descriptor
*ep_int
= NULL
;
824 * Find the first endpoint of each type we need.
825 * We are expecting a minimum of 2 endpoints - in and out (bulk).
826 * An optional interrupt-in is OK (necessary for CBI protocol).
827 * We will ignore any others.
829 for (i
= 0; i
< altsetting
->desc
.bNumEndpoints
; i
++) {
830 ep
= &altsetting
->endpoint
[i
].desc
;
832 if (usb_endpoint_xfer_bulk(ep
)) {
833 if (usb_endpoint_dir_in(ep
)) {
842 else if (usb_endpoint_is_int_in(ep
)) {
848 if (!ep_in
|| !ep_out
|| (us
->protocol
== US_PR_CBI
&& !ep_int
)) {
849 US_DEBUGP("Endpoint sanity check failed! Rejecting dev.\n");
853 /* Calculate and store the pipe values */
854 us
->send_ctrl_pipe
= usb_sndctrlpipe(us
->pusb_dev
, 0);
855 us
->recv_ctrl_pipe
= usb_rcvctrlpipe(us
->pusb_dev
, 0);
856 us
->send_bulk_pipe
= usb_sndbulkpipe(us
->pusb_dev
,
857 ep_out
->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
);
858 us
->recv_bulk_pipe
= usb_rcvbulkpipe(us
->pusb_dev
,
859 ep_in
->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
);
861 us
->recv_intr_pipe
= usb_rcvintpipe(us
->pusb_dev
,
862 ep_int
->bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
);
863 us
->ep_bInterval
= ep_int
->bInterval
;
868 /* Initialize all the dynamic resources we need */
869 static int usb_stor_acquire_resources(struct us_data
*us
)
872 struct task_struct
*th
;
874 us
->current_urb
= usb_alloc_urb(0, GFP_KERNEL
);
875 if (!us
->current_urb
) {
876 US_DEBUGP("URB allocation failed\n");
880 /* Just before we start our control thread, initialize
881 * the device if it needs initialization */
882 if (us
->unusual_dev
->initFunction
) {
883 p
= us
->unusual_dev
->initFunction(us
);
888 /* Start up our control thread */
889 th
= kthread_run(usb_stor_control_thread
, us
, "usb-storage");
891 printk(KERN_WARNING USB_STORAGE
892 "Unable to start control thread\n");
900 /* Release all our dynamic resources */
901 static void usb_stor_release_resources(struct us_data
*us
)
903 US_DEBUGP("-- %s\n", __FUNCTION__
);
905 /* Tell the control thread to exit. The SCSI host must
906 * already have been removed and the DISCONNECTING flag set
907 * so that we won't accept any more commands.
909 US_DEBUGP("-- sending exit command to thread\n");
910 complete(&us
->cmnd_ready
);
912 kthread_stop(us
->ctl_thread
);
914 /* Call the destructor routine, if it exists */
915 if (us
->extra_destructor
) {
916 US_DEBUGP("-- calling extra_destructor()\n");
917 us
->extra_destructor(us
->extra
);
920 /* Free the extra data and the URB */
922 usb_free_urb(us
->current_urb
);
925 /* Dissociate from the USB device */
926 static void dissociate_dev(struct us_data
*us
)
928 US_DEBUGP("-- %s\n", __FUNCTION__
);
930 /* Free the device-related DMA-mapped buffers */
932 usb_buffer_free(us
->pusb_dev
, sizeof(*us
->cr
), us
->cr
,
935 usb_buffer_free(us
->pusb_dev
, US_IOBUF_SIZE
, us
->iobuf
,
938 /* Remove our private data from the interface */
939 usb_set_intfdata(us
->pusb_intf
, NULL
);
942 /* First stage of disconnect processing: stop SCSI scanning,
943 * remove the host, and stop accepting new commands
945 static void quiesce_and_remove_host(struct us_data
*us
)
947 struct Scsi_Host
*host
= us_to_host(us
);
949 /* If the device is really gone, cut short reset delays */
950 if (us
->pusb_dev
->state
== USB_STATE_NOTATTACHED
)
951 set_bit(US_FLIDX_DISCONNECTING
, &us
->dflags
);
953 /* Prevent SCSI-scanning (if it hasn't started yet)
954 * and wait for the SCSI-scanning thread to stop.
956 set_bit(US_FLIDX_DONT_SCAN
, &us
->dflags
);
957 wake_up(&us
->delay_wait
);
958 wait_for_completion(&us
->scanning_done
);
960 /* Removing the host will perform an orderly shutdown: caches
961 * synchronized, disks spun down, etc.
963 scsi_remove_host(host
);
965 /* Prevent any new commands from being accepted and cut short
969 set_bit(US_FLIDX_DISCONNECTING
, &us
->dflags
);
971 wake_up(&us
->delay_wait
);
974 /* Second stage of disconnect processing: deallocate all resources */
975 static void release_everything(struct us_data
*us
)
977 usb_stor_release_resources(us
);
980 /* Drop our reference to the host; the SCSI core will free it
981 * (and "us" along with it) when the refcount becomes 0. */
982 scsi_host_put(us_to_host(us
));
985 /* Thread to carry out delayed SCSI-device scanning */
986 static int usb_stor_scan_thread(void * __us
)
988 struct us_data
*us
= (struct us_data
*)__us
;
990 dev_dbg(&us
->pusb_intf
->dev
, "device found\n");
993 /* Wait for the timeout to expire or for a disconnect */
995 dev_dbg(&us
->pusb_intf
->dev
, "waiting for device to settle "
996 "before scanning\n");
998 wait_event_interruptible_timeout(us
->delay_wait
,
999 test_bit(US_FLIDX_DONT_SCAN
, &us
->dflags
),
1001 if (try_to_freeze())
1005 /* If the device is still connected, perform the scanning */
1006 if (!test_bit(US_FLIDX_DONT_SCAN
, &us
->dflags
)) {
1008 /* For bulk-only devices, determine the max LUN value */
1009 if (us
->protocol
== US_PR_BULK
&&
1010 !(us
->fflags
& US_FL_SINGLE_LUN
)) {
1011 mutex_lock(&us
->dev_mutex
);
1012 us
->max_lun
= usb_stor_Bulk_max_lun(us
);
1013 mutex_unlock(&us
->dev_mutex
);
1015 scsi_scan_host(us_to_host(us
));
1016 dev_dbg(&us
->pusb_intf
->dev
, "scan complete\n");
1018 /* Should we unbind if no devices were detected? */
1021 complete_and_exit(&us
->scanning_done
, 0);
1025 /* Probe to see if we can drive a newly-connected USB device */
1026 static int storage_probe(struct usb_interface
*intf
,
1027 const struct usb_device_id
*id
)
1029 struct Scsi_Host
*host
;
1032 struct task_struct
*th
;
1034 if (usb_usual_check_type(id
, USB_US_TYPE_STOR
))
1037 US_DEBUGP("USB Mass Storage device detected\n");
1040 * Ask the SCSI layer to allocate a host structure, with extra
1041 * space at the end for our private us_data structure.
1043 host
= scsi_host_alloc(&usb_stor_host_template
, sizeof(*us
));
1045 printk(KERN_WARNING USB_STORAGE
1046 "Unable to allocate the scsi host\n");
1051 * Allow 16-byte CDBs and thus > 2TB
1053 host
->max_cmd_len
= 16;
1054 us
= host_to_us(host
);
1055 memset(us
, 0, sizeof(struct us_data
));
1056 mutex_init(&(us
->dev_mutex
));
1057 init_completion(&us
->cmnd_ready
);
1058 init_completion(&(us
->notify
));
1059 init_waitqueue_head(&us
->delay_wait
);
1060 init_completion(&us
->scanning_done
);
1062 /* Associate the us_data structure with the USB device */
1063 result
= associate_dev(us
, intf
);
1068 if (us
->pusb_dev
->actconfig
->desc
.bNumInterfaces
> 1) // patch for U2EC
1070 printk("We only support single-interface storage device!\n");
1077 * Get the unusual_devs entries and the descriptors
1079 * id_index is calculated in the declaration to be the index number
1080 * of the match from the usb_device_id table, so we can find the
1081 * corresponding entry in the private table.
1083 result
= get_device_info(us
, id
);
1087 /* Get the transport, protocol, and pipe settings */
1088 result
= get_transport(us
);
1091 result
= get_protocol(us
);
1094 result
= get_pipes(us
);
1098 /* Acquire all the other resources and add the host */
1099 result
= usb_stor_acquire_resources(us
);
1102 result
= scsi_add_host(host
, &intf
->dev
);
1104 printk(KERN_WARNING USB_STORAGE
1105 "Unable to add the scsi host\n");
1109 /* Start up the thread for delayed SCSI-device scanning */
1110 th
= kthread_create(usb_stor_scan_thread
, us
, "usb-stor-scan");
1112 printk(KERN_WARNING USB_STORAGE
1113 "Unable to start the device-scanning thread\n");
1114 complete(&us
->scanning_done
);
1115 quiesce_and_remove_host(us
);
1116 result
= PTR_ERR(th
);
1120 wake_up_process(th
);
1124 /* We come here if there are any problems */
1126 US_DEBUGP("storage_probe() failed\n");
1127 release_everything(us
);
1131 /* Handle a disconnect event from the USB core */
1132 static void storage_disconnect(struct usb_interface
*intf
)
1134 struct us_data
*us
= usb_get_intfdata(intf
);
1136 US_DEBUGP("storage_disconnect() called\n");
1137 quiesce_and_remove_host(us
);
1138 release_everything(us
);
1141 /***********************************************************************
1142 * Initialization and registration
1143 ***********************************************************************/
1145 static struct usb_driver usb_storage_driver
= {
1146 .name
= "usb-storage",
1147 .probe
= storage_probe
,
1148 .disconnect
= storage_disconnect
,
1150 .suspend
= storage_suspend
,
1151 .resume
= storage_resume
,
1152 .reset_resume
= storage_reset_resume
,
1154 .pre_reset
= storage_pre_reset
,
1155 .post_reset
= storage_post_reset
,
1156 .id_table
= storage_usb_ids
,
1160 static int __init
usb_stor_init(void)
1164 printk(KERN_INFO
"Initializing USB Mass Storage driver...\n");
1166 /* register the driver, return usb_register return code if error */
1167 retval
= usb_register(&usb_storage_driver
);
1169 printk(KERN_INFO
"USB Mass Storage support registered.\n");
1170 usb_usual_set_present(USB_US_TYPE_STOR
);
1175 static void __exit
usb_stor_exit(void)
1177 US_DEBUGP("usb_stor_exit() called\n");
1179 /* Deregister the driver
1180 * This will cause disconnect() to be called for each
1183 US_DEBUGP("-- calling usb_deregister()\n");
1184 usb_deregister(&usb_storage_driver
) ;
1186 usb_usual_clear_present(USB_US_TYPE_STOR
);
1189 module_init(usb_stor_init
);
1190 module_exit(usb_stor_exit
);