mm-only debug patch...
[mmotm.git] / drivers / usb / storage / usb.c
blob1599d86154c471395f199a090c1bace80532e667
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)
10 * Initial work by:
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
36 * later version.
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
49 #define DEBUG
50 #endif
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>
66 #include "usb.h"
67 #include "scsiglue.h"
68 #include "transport.h"
69 #include "protocol.h"
70 #include "debug.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 = 5;
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 */
128 #undef UNUSUAL_DEV
129 #undef COMPLIANT_DEV
130 #undef USUAL_DEV
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);
150 return 0;
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);
165 return 0;
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
179 * the device */
180 return 0;
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);
199 return 0;
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
213 * the device */
215 mutex_unlock(&us->dev_mutex);
216 return 0;
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.
233 return;
235 if(data[0]&0x20) { /* USB device currently not connected. Return
236 peripheral qualifier 001b ("...however, the
237 physical device is not currently connected
238 to this logical unit") and leave vendor and
239 product identification empty. ("If the target
240 does store some of the INQUIRY data on the
241 device, it may return zeros or ASCII spaces
242 (20h) in those fields until the data is
243 available from the device."). */
244 memset(data+8,0,28);
245 } else {
246 u16 bcdDevice = le16_to_cpu(us->pusb_dev->descriptor.bcdDevice);
247 memcpy(data+8, us->unusual_dev->vendorName,
248 strlen(us->unusual_dev->vendorName) > 8 ? 8 :
249 strlen(us->unusual_dev->vendorName));
250 memcpy(data+16, us->unusual_dev->productName,
251 strlen(us->unusual_dev->productName) > 16 ? 16 :
252 strlen(us->unusual_dev->productName));
253 data[32] = 0x30 + ((bcdDevice>>12) & 0x0F);
254 data[33] = 0x30 + ((bcdDevice>>8) & 0x0F);
255 data[34] = 0x30 + ((bcdDevice>>4) & 0x0F);
256 data[35] = 0x30 + ((bcdDevice) & 0x0F);
259 usb_stor_set_xfer_buf(data, data_len, us->srb);
261 EXPORT_SYMBOL_GPL(fill_inquiry_response);
263 static int usb_stor_control_thread(void * __us)
265 struct us_data *us = (struct us_data *)__us;
266 struct Scsi_Host *host = us_to_host(us);
268 for(;;) {
269 US_DEBUGP("*** thread sleeping.\n");
270 if (wait_for_completion_interruptible(&us->cmnd_ready))
271 break;
273 US_DEBUGP("*** thread awakened.\n");
275 /* lock the device pointers */
276 mutex_lock(&(us->dev_mutex));
278 /* lock access to the state */
279 scsi_lock(host);
281 /* When we are called with no command pending, we're done */
282 if (us->srb == NULL) {
283 scsi_unlock(host);
284 mutex_unlock(&us->dev_mutex);
285 US_DEBUGP("-- exiting\n");
286 break;
289 /* has the command timed out *already* ? */
290 if (test_bit(US_FLIDX_TIMED_OUT, &us->dflags)) {
291 us->srb->result = DID_ABORT << 16;
292 goto SkipForAbort;
295 scsi_unlock(host);
297 /* reject the command if the direction indicator
298 * is UNKNOWN
300 if (us->srb->sc_data_direction == DMA_BIDIRECTIONAL) {
301 US_DEBUGP("UNKNOWN data direction\n");
302 us->srb->result = DID_ERROR << 16;
305 /* reject if target != 0 or if LUN is higher than
306 * the maximum known LUN
308 else if (us->srb->device->id &&
309 !(us->fflags & US_FL_SCM_MULT_TARG)) {
310 US_DEBUGP("Bad target number (%d:%d)\n",
311 us->srb->device->id, us->srb->device->lun);
312 us->srb->result = DID_BAD_TARGET << 16;
315 else if (us->srb->device->lun > us->max_lun) {
316 US_DEBUGP("Bad LUN (%d:%d)\n",
317 us->srb->device->id, us->srb->device->lun);
318 us->srb->result = DID_BAD_TARGET << 16;
321 /* Handle those devices which need us to fake
322 * their inquiry data */
323 else if ((us->srb->cmnd[0] == INQUIRY) &&
324 (us->fflags & US_FL_FIX_INQUIRY)) {
325 unsigned char data_ptr[36] = {
326 0x00, 0x80, 0x02, 0x02,
327 0x1F, 0x00, 0x00, 0x00};
329 US_DEBUGP("Faking INQUIRY command\n");
330 fill_inquiry_response(us, data_ptr, 36);
331 us->srb->result = SAM_STAT_GOOD;
334 /* we've got a command, let's do it! */
335 else {
336 US_DEBUG(usb_stor_show_command(us->srb));
337 us->proto_handler(us->srb, us);
340 /* lock access to the state */
341 scsi_lock(host);
343 /* indicate that the command is done */
344 if (us->srb->result != DID_ABORT << 16) {
345 US_DEBUGP("scsi cmd done, result=0x%x\n",
346 us->srb->result);
347 us->srb->scsi_done(us->srb);
348 } else {
349 SkipForAbort:
350 US_DEBUGP("scsi command aborted\n");
353 /* If an abort request was received we need to signal that
354 * the abort has finished. The proper test for this is
355 * the TIMED_OUT flag, not srb->result == DID_ABORT, because
356 * the timeout might have occurred after the command had
357 * already completed with a different result code. */
358 if (test_bit(US_FLIDX_TIMED_OUT, &us->dflags)) {
359 complete(&(us->notify));
361 /* Allow USB transfers to resume */
362 clear_bit(US_FLIDX_ABORTING, &us->dflags);
363 clear_bit(US_FLIDX_TIMED_OUT, &us->dflags);
366 /* finished working on this command */
367 us->srb = NULL;
368 scsi_unlock(host);
370 /* unlock the device pointers */
371 mutex_unlock(&us->dev_mutex);
372 } /* for (;;) */
374 /* Wait until we are told to stop */
375 for (;;) {
376 set_current_state(TASK_INTERRUPTIBLE);
377 if (kthread_should_stop())
378 break;
379 schedule();
381 __set_current_state(TASK_RUNNING);
382 return 0;
385 /***********************************************************************
386 * Device probing and disconnecting
387 ***********************************************************************/
389 /* Associate our private data with the USB device */
390 static int associate_dev(struct us_data *us, struct usb_interface *intf)
392 US_DEBUGP("-- %s\n", __func__);
394 /* Fill in the device-related fields */
395 us->pusb_dev = interface_to_usbdev(intf);
396 us->pusb_intf = intf;
397 us->ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
398 US_DEBUGP("Vendor: 0x%04x, Product: 0x%04x, Revision: 0x%04x\n",
399 le16_to_cpu(us->pusb_dev->descriptor.idVendor),
400 le16_to_cpu(us->pusb_dev->descriptor.idProduct),
401 le16_to_cpu(us->pusb_dev->descriptor.bcdDevice));
402 US_DEBUGP("Interface Subclass: 0x%02x, Protocol: 0x%02x\n",
403 intf->cur_altsetting->desc.bInterfaceSubClass,
404 intf->cur_altsetting->desc.bInterfaceProtocol);
406 /* Store our private data in the interface */
407 usb_set_intfdata(intf, us);
409 /* Allocate the device-related DMA-mapped buffers */
410 us->cr = usb_buffer_alloc(us->pusb_dev, sizeof(*us->cr),
411 GFP_KERNEL, &us->cr_dma);
412 if (!us->cr) {
413 US_DEBUGP("usb_ctrlrequest allocation failed\n");
414 return -ENOMEM;
417 us->iobuf = usb_buffer_alloc(us->pusb_dev, US_IOBUF_SIZE,
418 GFP_KERNEL, &us->iobuf_dma);
419 if (!us->iobuf) {
420 US_DEBUGP("I/O buffer allocation failed\n");
421 return -ENOMEM;
423 return 0;
426 /* Works only for digits and letters, but small and fast */
427 #define TOLOWER(x) ((x) | 0x20)
429 /* Adjust device flags based on the "quirks=" module parameter */
430 static void adjust_quirks(struct us_data *us)
432 char *p;
433 u16 vid = le16_to_cpu(us->pusb_dev->descriptor.idVendor);
434 u16 pid = le16_to_cpu(us->pusb_dev->descriptor.idProduct);
435 unsigned f = 0;
436 unsigned int mask = (US_FL_SANE_SENSE | US_FL_FIX_CAPACITY |
437 US_FL_CAPACITY_HEURISTICS | US_FL_IGNORE_DEVICE |
438 US_FL_NOT_LOCKABLE | US_FL_MAX_SECTORS_64 |
439 US_FL_CAPACITY_OK | US_FL_IGNORE_RESIDUE |
440 US_FL_SINGLE_LUN | US_FL_NO_WP_DETECT);
442 p = quirks;
443 while (*p) {
444 /* Each entry consists of VID:PID:flags */
445 if (vid == simple_strtoul(p, &p, 16) &&
446 *p == ':' &&
447 pid == simple_strtoul(p+1, &p, 16) &&
448 *p == ':')
449 break;
451 /* Move forward to the next entry */
452 while (*p) {
453 if (*p++ == ',')
454 break;
457 if (!*p) /* No match */
458 return;
460 /* Collect the flags */
461 while (*++p && *p != ',') {
462 switch (TOLOWER(*p)) {
463 case 'a':
464 f |= US_FL_SANE_SENSE;
465 break;
466 case 'c':
467 f |= US_FL_FIX_CAPACITY;
468 break;
469 case 'h':
470 f |= US_FL_CAPACITY_HEURISTICS;
471 break;
472 case 'i':
473 f |= US_FL_IGNORE_DEVICE;
474 break;
475 case 'l':
476 f |= US_FL_NOT_LOCKABLE;
477 break;
478 case 'm':
479 f |= US_FL_MAX_SECTORS_64;
480 break;
481 case 'o':
482 f |= US_FL_CAPACITY_OK;
483 break;
484 case 'r':
485 f |= US_FL_IGNORE_RESIDUE;
486 break;
487 case 's':
488 f |= US_FL_SINGLE_LUN;
489 break;
490 case 'w':
491 f |= US_FL_NO_WP_DETECT;
492 break;
493 /* Ignore unrecognized flag characters */
496 us->fflags = (us->fflags & ~mask) | f;
497 dev_info(&us->pusb_intf->dev, "Quirks match for "
498 "vid %04x pid %04x: %x\n",
499 vid, pid, f);
502 /* Get the unusual_devs entries and the string descriptors */
503 static int get_device_info(struct us_data *us, const struct usb_device_id *id,
504 struct us_unusual_dev *unusual_dev)
506 struct usb_device *dev = us->pusb_dev;
507 struct usb_interface_descriptor *idesc =
508 &us->pusb_intf->cur_altsetting->desc;
510 /* Store the entries */
511 us->unusual_dev = unusual_dev;
512 us->subclass = (unusual_dev->useProtocol == US_SC_DEVICE) ?
513 idesc->bInterfaceSubClass :
514 unusual_dev->useProtocol;
515 us->protocol = (unusual_dev->useTransport == US_PR_DEVICE) ?
516 idesc->bInterfaceProtocol :
517 unusual_dev->useTransport;
518 us->fflags = USB_US_ORIG_FLAGS(id->driver_info);
519 adjust_quirks(us);
521 if (us->fflags & US_FL_IGNORE_DEVICE) {
522 printk(KERN_INFO USB_STORAGE "device ignored\n");
523 return -ENODEV;
527 * This flag is only needed when we're in high-speed, so let's
528 * disable it if we're in full-speed
530 if (dev->speed != USB_SPEED_HIGH)
531 us->fflags &= ~US_FL_GO_SLOW;
533 /* Log a message if a non-generic unusual_dev entry contains an
534 * unnecessary subclass or protocol override. This may stimulate
535 * reports from users that will help us remove unneeded entries
536 * from the unusual_devs.h table.
538 if (id->idVendor || id->idProduct) {
539 static const char *msgs[3] = {
540 "an unneeded SubClass entry",
541 "an unneeded Protocol entry",
542 "unneeded SubClass and Protocol entries"};
543 struct usb_device_descriptor *ddesc = &dev->descriptor;
544 int msg = -1;
546 if (unusual_dev->useProtocol != US_SC_DEVICE &&
547 us->subclass == idesc->bInterfaceSubClass)
548 msg += 1;
549 if (unusual_dev->useTransport != US_PR_DEVICE &&
550 us->protocol == idesc->bInterfaceProtocol)
551 msg += 2;
552 if (msg >= 0 && !(us->fflags & US_FL_NEED_OVERRIDE))
553 printk(KERN_NOTICE USB_STORAGE "This device "
554 "(%04x,%04x,%04x S %02x P %02x)"
555 " has %s in unusual_devs.h (kernel"
556 " %s)\n"
557 " Please send a copy of this message to "
558 "<linux-usb@vger.kernel.org> and "
559 "<usb-storage@lists.one-eyed-alien.net>\n",
560 le16_to_cpu(ddesc->idVendor),
561 le16_to_cpu(ddesc->idProduct),
562 le16_to_cpu(ddesc->bcdDevice),
563 idesc->bInterfaceSubClass,
564 idesc->bInterfaceProtocol,
565 msgs[msg],
566 utsname()->release);
569 return 0;
572 /* Get the transport settings */
573 static void get_transport(struct us_data *us)
575 switch (us->protocol) {
576 case US_PR_CB:
577 us->transport_name = "Control/Bulk";
578 us->transport = usb_stor_CB_transport;
579 us->transport_reset = usb_stor_CB_reset;
580 us->max_lun = 7;
581 break;
583 case US_PR_CBI:
584 us->transport_name = "Control/Bulk/Interrupt";
585 us->transport = usb_stor_CB_transport;
586 us->transport_reset = usb_stor_CB_reset;
587 us->max_lun = 7;
588 break;
590 case US_PR_BULK:
591 us->transport_name = "Bulk";
592 us->transport = usb_stor_Bulk_transport;
593 us->transport_reset = usb_stor_Bulk_reset;
594 break;
598 /* Get the protocol settings */
599 static void get_protocol(struct us_data *us)
601 switch (us->subclass) {
602 case US_SC_RBC:
603 us->protocol_name = "Reduced Block Commands (RBC)";
604 us->proto_handler = usb_stor_transparent_scsi_command;
605 break;
607 case US_SC_8020:
608 us->protocol_name = "8020i";
609 us->proto_handler = usb_stor_pad12_command;
610 us->max_lun = 0;
611 break;
613 case US_SC_QIC:
614 us->protocol_name = "QIC-157";
615 us->proto_handler = usb_stor_pad12_command;
616 us->max_lun = 0;
617 break;
619 case US_SC_8070:
620 us->protocol_name = "8070i";
621 us->proto_handler = usb_stor_pad12_command;
622 us->max_lun = 0;
623 break;
625 case US_SC_SCSI:
626 us->protocol_name = "Transparent SCSI";
627 us->proto_handler = usb_stor_transparent_scsi_command;
628 break;
630 case US_SC_UFI:
631 us->protocol_name = "Uniform Floppy Interface (UFI)";
632 us->proto_handler = usb_stor_ufi_command;
633 break;
637 /* Get the pipe settings */
638 static int get_pipes(struct us_data *us)
640 struct usb_host_interface *altsetting =
641 us->pusb_intf->cur_altsetting;
642 int i;
643 struct usb_endpoint_descriptor *ep;
644 struct usb_endpoint_descriptor *ep_in = NULL;
645 struct usb_endpoint_descriptor *ep_out = NULL;
646 struct usb_endpoint_descriptor *ep_int = NULL;
649 * Find the first endpoint of each type we need.
650 * We are expecting a minimum of 2 endpoints - in and out (bulk).
651 * An optional interrupt-in is OK (necessary for CBI protocol).
652 * We will ignore any others.
654 for (i = 0; i < altsetting->desc.bNumEndpoints; i++) {
655 ep = &altsetting->endpoint[i].desc;
657 if (usb_endpoint_xfer_bulk(ep)) {
658 if (usb_endpoint_dir_in(ep)) {
659 if (!ep_in)
660 ep_in = ep;
661 } else {
662 if (!ep_out)
663 ep_out = ep;
667 else if (usb_endpoint_is_int_in(ep)) {
668 if (!ep_int)
669 ep_int = ep;
673 if (!ep_in || !ep_out || (us->protocol == US_PR_CBI && !ep_int)) {
674 US_DEBUGP("Endpoint sanity check failed! Rejecting dev.\n");
675 return -EIO;
678 /* Calculate and store the pipe values */
679 us->send_ctrl_pipe = usb_sndctrlpipe(us->pusb_dev, 0);
680 us->recv_ctrl_pipe = usb_rcvctrlpipe(us->pusb_dev, 0);
681 us->send_bulk_pipe = usb_sndbulkpipe(us->pusb_dev,
682 usb_endpoint_num(ep_out));
683 us->recv_bulk_pipe = usb_rcvbulkpipe(us->pusb_dev,
684 usb_endpoint_num(ep_in));
685 if (ep_int) {
686 us->recv_intr_pipe = usb_rcvintpipe(us->pusb_dev,
687 usb_endpoint_num(ep_int));
688 us->ep_bInterval = ep_int->bInterval;
690 return 0;
693 /* Initialize all the dynamic resources we need */
694 static int usb_stor_acquire_resources(struct us_data *us)
696 int p;
697 struct task_struct *th;
699 us->current_urb = usb_alloc_urb(0, GFP_KERNEL);
700 if (!us->current_urb) {
701 US_DEBUGP("URB allocation failed\n");
702 return -ENOMEM;
705 /* Just before we start our control thread, initialize
706 * the device if it needs initialization */
707 if (us->unusual_dev->initFunction) {
708 p = us->unusual_dev->initFunction(us);
709 if (p)
710 return p;
713 /* Start up our control thread */
714 th = kthread_run(usb_stor_control_thread, us, "usb-storage");
715 if (IS_ERR(th)) {
716 printk(KERN_WARNING USB_STORAGE
717 "Unable to start control thread\n");
718 return PTR_ERR(th);
720 us->ctl_thread = th;
722 return 0;
725 /* Release all our dynamic resources */
726 static void usb_stor_release_resources(struct us_data *us)
728 US_DEBUGP("-- %s\n", __func__);
730 /* Tell the control thread to exit. The SCSI host must
731 * already have been removed and the DISCONNECTING flag set
732 * so that we won't accept any more commands.
734 US_DEBUGP("-- sending exit command to thread\n");
735 complete(&us->cmnd_ready);
736 if (us->ctl_thread)
737 kthread_stop(us->ctl_thread);
739 /* Call the destructor routine, if it exists */
740 if (us->extra_destructor) {
741 US_DEBUGP("-- calling extra_destructor()\n");
742 us->extra_destructor(us->extra);
745 /* Free the extra data and the URB */
746 kfree(us->extra);
747 usb_free_urb(us->current_urb);
750 /* Dissociate from the USB device */
751 static void dissociate_dev(struct us_data *us)
753 US_DEBUGP("-- %s\n", __func__);
755 /* Free the device-related DMA-mapped buffers */
756 if (us->cr)
757 usb_buffer_free(us->pusb_dev, sizeof(*us->cr), us->cr,
758 us->cr_dma);
759 if (us->iobuf)
760 usb_buffer_free(us->pusb_dev, US_IOBUF_SIZE, us->iobuf,
761 us->iobuf_dma);
763 /* Remove our private data from the interface */
764 usb_set_intfdata(us->pusb_intf, NULL);
767 /* First stage of disconnect processing: stop SCSI scanning,
768 * remove the host, and stop accepting new commands
770 static void quiesce_and_remove_host(struct us_data *us)
772 struct Scsi_Host *host = us_to_host(us);
774 /* If the device is really gone, cut short reset delays */
775 if (us->pusb_dev->state == USB_STATE_NOTATTACHED)
776 set_bit(US_FLIDX_DISCONNECTING, &us->dflags);
778 /* Prevent SCSI-scanning (if it hasn't started yet)
779 * and wait for the SCSI-scanning thread to stop.
781 set_bit(US_FLIDX_DONT_SCAN, &us->dflags);
782 wake_up(&us->delay_wait);
783 wait_for_completion(&us->scanning_done);
785 /* Removing the host will perform an orderly shutdown: caches
786 * synchronized, disks spun down, etc.
788 scsi_remove_host(host);
790 /* Prevent any new commands from being accepted and cut short
791 * reset delays.
793 scsi_lock(host);
794 set_bit(US_FLIDX_DISCONNECTING, &us->dflags);
795 scsi_unlock(host);
796 wake_up(&us->delay_wait);
799 /* Second stage of disconnect processing: deallocate all resources */
800 static void release_everything(struct us_data *us)
802 usb_stor_release_resources(us);
803 dissociate_dev(us);
805 /* Drop our reference to the host; the SCSI core will free it
806 * (and "us" along with it) when the refcount becomes 0. */
807 scsi_host_put(us_to_host(us));
810 /* Thread to carry out delayed SCSI-device scanning */
811 static int usb_stor_scan_thread(void * __us)
813 struct us_data *us = (struct us_data *)__us;
815 dev_dbg(&us->pusb_intf->dev, "device found\n");
817 set_freezable();
818 /* Wait for the timeout to expire or for a disconnect */
819 if (delay_use > 0) {
820 dev_dbg(&us->pusb_intf->dev, "waiting for device to settle "
821 "before scanning\n");
822 wait_event_freezable_timeout(us->delay_wait,
823 test_bit(US_FLIDX_DONT_SCAN, &us->dflags),
824 delay_use * HZ);
827 /* If the device is still connected, perform the scanning */
828 if (!test_bit(US_FLIDX_DONT_SCAN, &us->dflags)) {
830 /* For bulk-only devices, determine the max LUN value */
831 if (us->protocol == US_PR_BULK &&
832 !(us->fflags & US_FL_SINGLE_LUN)) {
833 mutex_lock(&us->dev_mutex);
834 us->max_lun = usb_stor_Bulk_max_lun(us);
835 mutex_unlock(&us->dev_mutex);
837 scsi_scan_host(us_to_host(us));
838 dev_dbg(&us->pusb_intf->dev, "scan complete\n");
840 /* Should we unbind if no devices were detected? */
843 complete_and_exit(&us->scanning_done, 0);
846 static unsigned int usb_stor_sg_tablesize(struct usb_interface *intf)
848 struct usb_device *usb_dev = interface_to_usbdev(intf);
850 if (usb_dev->bus->sg_tablesize) {
851 return usb_dev->bus->sg_tablesize;
853 return SG_ALL;
856 /* First part of general USB mass-storage probing */
857 int usb_stor_probe1(struct us_data **pus,
858 struct usb_interface *intf,
859 const struct usb_device_id *id,
860 struct us_unusual_dev *unusual_dev)
862 struct Scsi_Host *host;
863 struct us_data *us;
864 int result;
866 US_DEBUGP("USB Mass Storage device detected\n");
869 * Ask the SCSI layer to allocate a host structure, with extra
870 * space at the end for our private us_data structure.
872 host = scsi_host_alloc(&usb_stor_host_template, sizeof(*us));
873 if (!host) {
874 printk(KERN_WARNING USB_STORAGE
875 "Unable to allocate the scsi host\n");
876 return -ENOMEM;
880 * Allow 16-byte CDBs and thus > 2TB
882 host->max_cmd_len = 16;
883 host->sg_tablesize = usb_stor_sg_tablesize(intf);
884 *pus = us = host_to_us(host);
885 memset(us, 0, sizeof(struct us_data));
886 mutex_init(&(us->dev_mutex));
887 init_completion(&us->cmnd_ready);
888 init_completion(&(us->notify));
889 init_waitqueue_head(&us->delay_wait);
890 init_completion(&us->scanning_done);
892 /* Associate the us_data structure with the USB device */
893 result = associate_dev(us, intf);
894 if (result)
895 goto BadDevice;
897 /* Get the unusual_devs entries and the descriptors */
898 result = get_device_info(us, id, unusual_dev);
899 if (result)
900 goto BadDevice;
902 /* Get standard transport and protocol settings */
903 get_transport(us);
904 get_protocol(us);
906 /* Give the caller a chance to fill in specialized transport
907 * or protocol settings.
909 return 0;
911 BadDevice:
912 US_DEBUGP("storage_probe() failed\n");
913 release_everything(us);
914 return result;
916 EXPORT_SYMBOL_GPL(usb_stor_probe1);
918 /* Second part of general USB mass-storage probing */
919 int usb_stor_probe2(struct us_data *us)
921 struct task_struct *th;
922 int result;
924 /* Make sure the transport and protocol have both been set */
925 if (!us->transport || !us->proto_handler) {
926 result = -ENXIO;
927 goto BadDevice;
929 US_DEBUGP("Transport: %s\n", us->transport_name);
930 US_DEBUGP("Protocol: %s\n", us->protocol_name);
932 /* fix for single-lun devices */
933 if (us->fflags & US_FL_SINGLE_LUN)
934 us->max_lun = 0;
936 /* Find the endpoints and calculate pipe values */
937 result = get_pipes(us);
938 if (result)
939 goto BadDevice;
941 /* Acquire all the other resources and add the host */
942 result = usb_stor_acquire_resources(us);
943 if (result)
944 goto BadDevice;
945 snprintf(us->scsi_name, sizeof(us->scsi_name), "usb-storage %s",
946 dev_name(&us->pusb_intf->dev));
947 result = scsi_add_host(us_to_host(us), &us->pusb_intf->dev);
948 if (result) {
949 printk(KERN_WARNING USB_STORAGE
950 "Unable to add the scsi host\n");
951 goto BadDevice;
954 /* Start up the thread for delayed SCSI-device scanning */
955 th = kthread_create(usb_stor_scan_thread, us, "usb-stor-scan");
956 if (IS_ERR(th)) {
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);
962 goto BadDevice;
965 wake_up_process(th);
967 return 0;
969 /* We come here if there are any problems */
970 BadDevice:
971 US_DEBUGP("storage_probe() failed\n");
972 release_everything(us);
973 return result;
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)
992 struct us_data *us;
993 int result;
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))
1003 return -ENXIO;
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);
1014 if (result)
1015 return result;
1017 /* No special transport or protocol settings in the main module */
1019 result = usb_stor_probe2(us);
1020 return result;
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,
1037 .soft_unbind = 1,
1040 static int __init usb_stor_init(void)
1042 int retval;
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);
1048 if (retval == 0) {
1049 printk(KERN_INFO "USB Mass Storage support registered.\n");
1050 usb_usual_set_present(USB_US_TYPE_STOR);
1052 return retval;
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
1061 * attached unit
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);