1 /* Driver for USB Mass Storage compliant devices 2 * 3 * Current development and maintenance by: 4 * (c) 1999-2003 Matthew Dharm (mdharm-usb@one-eyed-alien.net) 5 * 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) 9 * 10 * Initial work by: 11 * (c) 1999 Michael Gee (michael@linuxspecific.com) 12 * 13 * usb_device_id support by Adam J. Richter (adam@yggdrasil.com): 14 * (c) 2000 Yggdrasil Computing, Inc. 15 * 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. 21 * 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. 26 * 27 * Also, for certain devices, the interrupt endpoint is used to convey 28 * status of a command. 29 * 30 * Please see http://www.one-eyed-alien.net/~mdharm/linux-usb for more 31 * information about this driver. 32 * 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. 37 * 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. 42 * 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. 46 */ 47 48 #ifdef CONFIG_USB_STORAGE_DEBUG 49 #define DEBUG 50 #endif 51 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> 61 62 #include <scsi/scsi.h> 63 #include <scsi/scsi_cmnd.h> 64 #include <scsi/scsi_device.h> 65 66 #include "usb.h" 67 #include "scsiglue.h" 68 #include "transport.h" 69 #include "protocol.h" 70 #include "debug.h" 71 #include "initializers.h" 72 73 #include "sierra_ms.h" 74 #include "option_ms.h" 75 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"); 80 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"); 84 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"); 88 89 90 /* 91 * The entries in this table correspond, line for line, 92 * with the entries in usb_storage_usb_ids[], defined in usual-tables.c. 93 */ 94 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. 102 */ 103 104 #define UNUSUAL_DEV(idVendor, idProduct, bcdDeviceMin, bcdDeviceMax, \ 105 vendor_name, product_name, use_protocol, use_transport, \ 106 init_function, Flags) \ 107 { \ 108 .vendorName = vendor_name, \ 109 .productName = product_name, \ 110 .useProtocol = use_protocol, \ 111 .useTransport = use_transport, \ 112 .initFunction = init_function, \ 113 } 114 115 #define COMPLIANT_DEV UNUSUAL_DEV 116 117 #define USUAL_DEV(use_protocol, use_transport, use_type) \ 118 { \ 119 .useProtocol = use_protocol, \ 120 .useTransport = use_transport, \ 121 } 122 123 static struct us_unusual_dev us_unusual_dev_list[] = { 124 # include "unusual_devs.h" 125 { } /* Terminating entry */ 126 }; 127 128 #undef UNUSUAL_DEV 129 #undef COMPLIANT_DEV 130 #undef USUAL_DEV 131 132 133 #ifdef CONFIG_PM /* Minimal support for suspend and resume */ 134 135 int usb_stor_suspend(struct usb_interface *iface, pm_message_t message) 136 { 137 struct us_data *us = usb_get_intfdata(iface); 138 139 /* Wait until no command is running */ 140 mutex_lock(&us->dev_mutex); 141 142 US_DEBUGP("%s\n", __func__); 143 if (us->suspend_resume_hook) 144 (us->suspend_resume_hook)(us, US_SUSPEND); 145 146 /* When runtime PM is working, we'll set a flag to indicate 147 * whether we should autoresume when a SCSI request arrives. */ 148 149 mutex_unlock(&us->dev_mutex); 150 return 0; 151 } 152 EXPORT_SYMBOL_GPL(usb_stor_suspend); 153 154 int usb_stor_resume(struct usb_interface *iface) 155 { 156 struct us_data *us = usb_get_intfdata(iface); 157 158 mutex_lock(&us->dev_mutex); 159 160 US_DEBUGP("%s\n", __func__); 161 if (us->suspend_resume_hook) 162 (us->suspend_resume_hook)(us, US_RESUME); 163 164 mutex_unlock(&us->dev_mutex); 165 return 0; 166 } 167 EXPORT_SYMBOL_GPL(usb_stor_resume); 168 169 int usb_stor_reset_resume(struct usb_interface *iface) 170 { 171 struct us_data *us = usb_get_intfdata(iface); 172 173 US_DEBUGP("%s\n", __func__); 174 175 /* Report the reset to the SCSI core */ 176 usb_stor_report_bus_reset(us); 177 178 /* FIXME: Notify the subdrivers that they need to reinitialize 179 * the device */ 180 return 0; 181 } 182 EXPORT_SYMBOL_GPL(usb_stor_reset_resume); 183 184 #endif /* CONFIG_PM */ 185 186 /* 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. 189 */ 190 191 int usb_stor_pre_reset(struct usb_interface *iface) 192 { 193 struct us_data *us = usb_get_intfdata(iface); 194 195 US_DEBUGP("%s\n", __func__); 196 197 /* Make sure no command runs during the reset */ 198 mutex_lock(&us->dev_mutex); 199 return 0; 200 } 201 EXPORT_SYMBOL_GPL(usb_stor_pre_reset); 202 203 int usb_stor_post_reset(struct usb_interface *iface) 204 { 205 struct us_data *us = usb_get_intfdata(iface); 206 207 US_DEBUGP("%s\n", __func__); 208 209 /* Report the reset to the SCSI core */ 210 usb_stor_report_bus_reset(us); 211 212 /* FIXME: Notify the subdrivers that they need to reinitialize 213 * the device */ 214 215 mutex_unlock(&us->dev_mutex); 216 return 0; 217 } 218 EXPORT_SYMBOL_GPL(usb_stor_post_reset); 219 220 /* 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. 227 */ 228 229 void fill_inquiry_response(struct us_data *us, unsigned char *data, 230 unsigned int data_len) 231 { 232 if (data_len<36) // You lose. 233 return; 234 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."). */ 245 } else { 246 u16 bcdDevice = le16_to_cpu(us->pusb_dev->descriptor.bcdDevice); 247 int n; 248 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)); 253 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); 258 } 259 260 usb_stor_set_xfer_buf(data, data_len, us->srb); 261 } 262 EXPORT_SYMBOL_GPL(fill_inquiry_response); 263 264 static int usb_stor_control_thread(void * __us) 265 { 266 struct us_data *us = (struct us_data *)__us; 267 struct Scsi_Host *host = us_to_host(us); 268 269 for(;;) { 270 US_DEBUGP("*** thread sleeping.\n"); 271 if (wait_for_completion_interruptible(&us->cmnd_ready)) 272 break; 273 274 US_DEBUGP("*** thread awakened.\n"); 275 276 /* lock the device pointers */ 277 mutex_lock(&(us->dev_mutex)); 278 279 /* lock access to the state */ 280 scsi_lock(host); 281 282 /* When we are called with no command pending, we're done */ 283 if (us->srb == NULL) { 284 scsi_unlock(host); 285 mutex_unlock(&us->dev_mutex); 286 US_DEBUGP("-- exiting\n"); 287 break; 288 } 289 290 /* has the command timed out *already* ? */ 291 if (test_bit(US_FLIDX_TIMED_OUT, &us->dflags)) { 292 us->srb->result = DID_ABORT << 16; 293 goto SkipForAbort; 294 } 295 296 scsi_unlock(host); 297 298 /* reject the command if the direction indicator 299 * is UNKNOWN 300 */ 301 if (us->srb->sc_data_direction == DMA_BIDIRECTIONAL) { 302 US_DEBUGP("UNKNOWN data direction\n"); 303 us->srb->result = DID_ERROR << 16; 304 } 305 306 /* reject if target != 0 or if LUN is higher than 307 * the maximum known LUN 308 */ 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; 314 } 315 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; 320 } 321 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}; 329 330 US_DEBUGP("Faking INQUIRY command\n"); 331 fill_inquiry_response(us, data_ptr, 36); 332 us->srb->result = SAM_STAT_GOOD; 333 } 334 335 /* we've got a command, let's do it! */ 336 else { 337 US_DEBUG(usb_stor_show_command(us->srb)); 338 us->proto_handler(us->srb, us); 339 usb_mark_last_busy(us->pusb_dev); 340 } 341 342 /* lock access to the state */ 343 scsi_lock(host); 344 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", 348 us->srb->result); 349 us->srb->scsi_done(us->srb); 350 } else { 351 SkipForAbort: 352 US_DEBUGP("scsi command aborted\n"); 353 } 354 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)); 362 363 /* Allow USB transfers to resume */ 364 clear_bit(US_FLIDX_ABORTING, &us->dflags); 365 clear_bit(US_FLIDX_TIMED_OUT, &us->dflags); 366 } 367 368 /* finished working on this command */ 369 us->srb = NULL; 370 scsi_unlock(host); 371 372 /* unlock the device pointers */ 373 mutex_unlock(&us->dev_mutex); 374 } /* for (;;) */ 375 376 /* Wait until we are told to stop */ 377 for (;;) { 378 set_current_state(TASK_INTERRUPTIBLE); 379 if (kthread_should_stop()) 380 break; 381 schedule(); 382 } 383 __set_current_state(TASK_RUNNING); 384 return 0; 385 } 386 387 /*********************************************************************** 388 * Device probing and disconnecting 389 ***********************************************************************/ 390 391 /* Associate our private data with the USB device */ 392 static int associate_dev(struct us_data *us, struct usb_interface *intf) 393 { 394 US_DEBUGP("-- %s\n", __func__); 395 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); 407 408 /* Store our private data in the interface */ 409 usb_set_intfdata(intf, us); 410 411 /* Allocate the control/setup and DMA-mapped buffers */ 412 us->cr = kmalloc(sizeof(*us->cr), GFP_KERNEL); 413 if (!us->cr) { 414 US_DEBUGP("usb_ctrlrequest allocation failed\n"); 415 return -ENOMEM; 416 } 417 418 us->iobuf = usb_alloc_coherent(us->pusb_dev, US_IOBUF_SIZE, 419 GFP_KERNEL, &us->iobuf_dma); 420 if (!us->iobuf) { 421 US_DEBUGP("I/O buffer allocation failed\n"); 422 return -ENOMEM; 423 } 424 return 0; 425 } 426 427 /* Works only for digits and letters, but small and fast */ 428 #define TOLOWER(x) ((x) | 0x20) 429 430 /* Adjust device flags based on the "quirks=" module parameter */ 431 static void adjust_quirks(struct us_data *us) 432 { 433 char *p; 434 u16 vid = le16_to_cpu(us->pusb_dev->descriptor.idVendor); 435 u16 pid = le16_to_cpu(us->pusb_dev->descriptor.idProduct); 436 unsigned f = 0; 437 unsigned int mask = (US_FL_SANE_SENSE | US_FL_BAD_SENSE | 438 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); 443 444 p = quirks; 445 while (*p) { 446 /* Each entry consists of VID:PID:flags */ 447 if (vid == simple_strtoul(p, &p, 16) && 448 *p == ':' && 449 pid == simple_strtoul(p+1, &p, 16) && 450 *p == ':') 451 break; 452 453 /* Move forward to the next entry */ 454 while (*p) { 455 if (*p++ == ',') 456 break; 457 } 458 } 459 if (!*p) /* No match */ 460 return; 461 462 /* Collect the flags */ 463 while (*++p && *p != ',') { 464 switch (TOLOWER(*p)) { 465 case 'a': 466 f |= US_FL_SANE_SENSE; 467 break; 468 case 'b': 469 f |= US_FL_BAD_SENSE; 470 break; 471 case 'c': 472 f |= US_FL_FIX_CAPACITY; 473 break; 474 case 'h': 475 f |= US_FL_CAPACITY_HEURISTICS; 476 break; 477 case 'i': 478 f |= US_FL_IGNORE_DEVICE; 479 break; 480 case 'l': 481 f |= US_FL_NOT_LOCKABLE; 482 break; 483 case 'm': 484 f |= US_FL_MAX_SECTORS_64; 485 break; 486 case 'o': 487 f |= US_FL_CAPACITY_OK; 488 break; 489 case 'r': 490 f |= US_FL_IGNORE_RESIDUE; 491 break; 492 case 's': 493 f |= US_FL_SINGLE_LUN; 494 break; 495 case 'w': 496 f |= US_FL_NO_WP_DETECT; 497 break; 498 /* Ignore unrecognized flag characters */ 499 } 500 } 501 us->fflags = (us->fflags & ~mask) | f; 502 } 503 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) 507 { 508 struct usb_device *dev = us->pusb_dev; 509 struct usb_interface_descriptor *idesc = 510 &us->pusb_intf->cur_altsetting->desc; 511 struct device *pdev = &us->pusb_intf->dev; 512 513 /* Store the entries */ 514 us->unusual_dev = unusual_dev; 515 us->subclass = (unusual_dev->useProtocol == USB_SC_DEVICE) ? 516 idesc->bInterfaceSubClass : 517 unusual_dev->useProtocol; 518 us->protocol = (unusual_dev->useTransport == USB_PR_DEVICE) ? 519 idesc->bInterfaceProtocol : 520 unusual_dev->useTransport; 521 us->fflags = USB_US_ORIG_FLAGS(id->driver_info); 522 adjust_quirks(us); 523 524 if (us->fflags & US_FL_IGNORE_DEVICE) { 525 dev_info(pdev, "device ignored\n"); 526 return -ENODEV; 527 } 528 529 /* 530 * This flag is only needed when we're in high-speed, so let's 531 * disable it if we're in full-speed 532 */ 533 if (dev->speed != USB_SPEED_HIGH) 534 us->fflags &= ~US_FL_GO_SLOW; 535 536 if (us->fflags) 537 dev_info(pdev, "Quirks match for vid %04x pid %04x: %lx\n", 538 le16_to_cpu(dev->descriptor.idVendor), 539 le16_to_cpu(dev->descriptor.idProduct), 540 us->fflags); 541 542 /* Log a message if a non-generic unusual_dev entry contains an 543 * unnecessary subclass or protocol override. This may stimulate 544 * reports from users that will help us remove unneeded entries 545 * from the unusual_devs.h table. 546 */ 547 if (id->idVendor || id->idProduct) { 548 static const char *msgs[3] = { 549 "an unneeded SubClass entry", 550 "an unneeded Protocol entry", 551 "unneeded SubClass and Protocol entries"}; 552 struct usb_device_descriptor *ddesc = &dev->descriptor; 553 int msg = -1; 554 555 if (unusual_dev->useProtocol != USB_SC_DEVICE && 556 us->subclass == idesc->bInterfaceSubClass) 557 msg += 1; 558 if (unusual_dev->useTransport != USB_PR_DEVICE && 559 us->protocol == idesc->bInterfaceProtocol) 560 msg += 2; 561 if (msg >= 0 && !(us->fflags & US_FL_NEED_OVERRIDE)) 562 dev_notice(pdev, "This device " 563 "(%04x,%04x,%04x S %02x P %02x)" 564 " has %s in unusual_devs.h (kernel" 565 " %s)\n" 566 " Please send a copy of this message to " 567 "<linux-usb@vger.kernel.org> and " 568 "<usb-storage@lists.one-eyed-alien.net>\n", 569 le16_to_cpu(ddesc->idVendor), 570 le16_to_cpu(ddesc->idProduct), 571 le16_to_cpu(ddesc->bcdDevice), 572 idesc->bInterfaceSubClass, 573 idesc->bInterfaceProtocol, 574 msgs[msg], 575 utsname()->release); 576 } 577 578 return 0; 579 } 580 581 /* Get the transport settings */ 582 static void get_transport(struct us_data *us) 583 { 584 switch (us->protocol) { 585 case USB_PR_CB: 586 us->transport_name = "Control/Bulk"; 587 us->transport = usb_stor_CB_transport; 588 us->transport_reset = usb_stor_CB_reset; 589 us->max_lun = 7; 590 break; 591 592 case USB_PR_CBI: 593 us->transport_name = "Control/Bulk/Interrupt"; 594 us->transport = usb_stor_CB_transport; 595 us->transport_reset = usb_stor_CB_reset; 596 us->max_lun = 7; 597 break; 598 599 case USB_PR_BULK: 600 us->transport_name = "Bulk"; 601 us->transport = usb_stor_Bulk_transport; 602 us->transport_reset = usb_stor_Bulk_reset; 603 break; 604 } 605 } 606 607 /* Get the protocol settings */ 608 static void get_protocol(struct us_data *us) 609 { 610 switch (us->subclass) { 611 case USB_SC_RBC: 612 us->protocol_name = "Reduced Block Commands (RBC)"; 613 us->proto_handler = usb_stor_transparent_scsi_command; 614 break; 615 616 case USB_SC_8020: 617 us->protocol_name = "8020i"; 618 us->proto_handler = usb_stor_pad12_command; 619 us->max_lun = 0; 620 break; 621 622 case USB_SC_QIC: 623 us->protocol_name = "QIC-157"; 624 us->proto_handler = usb_stor_pad12_command; 625 us->max_lun = 0; 626 break; 627 628 case USB_SC_8070: 629 us->protocol_name = "8070i"; 630 us->proto_handler = usb_stor_pad12_command; 631 us->max_lun = 0; 632 break; 633 634 case USB_SC_SCSI: 635 us->protocol_name = "Transparent SCSI"; 636 us->proto_handler = usb_stor_transparent_scsi_command; 637 break; 638 639 case USB_SC_UFI: 640 us->protocol_name = "Uniform Floppy Interface (UFI)"; 641 us->proto_handler = usb_stor_ufi_command; 642 break; 643 } 644 } 645 646 /* Get the pipe settings */ 647 static int get_pipes(struct us_data *us) 648 { 649 struct usb_host_interface *altsetting = 650 us->pusb_intf->cur_altsetting; 651 int i; 652 struct usb_endpoint_descriptor *ep; 653 struct usb_endpoint_descriptor *ep_in = NULL; 654 struct usb_endpoint_descriptor *ep_out = NULL; 655 struct usb_endpoint_descriptor *ep_int = NULL; 656 657 /* 658 * Find the first endpoint of each type we need. 659 * We are expecting a minimum of 2 endpoints - in and out (bulk). 660 * An optional interrupt-in is OK (necessary for CBI protocol). 661 * We will ignore any others. 662 */ 663 for (i = 0; i < altsetting->desc.bNumEndpoints; i++) { 664 ep = &altsetting->endpoint[i].desc; 665 666 if (usb_endpoint_xfer_bulk(ep)) { 667 if (usb_endpoint_dir_in(ep)) { 668 if (!ep_in) 669 ep_in = ep; 670 } else { 671 if (!ep_out) 672 ep_out = ep; 673 } 674 } 675 676 else if (usb_endpoint_is_int_in(ep)) { 677 if (!ep_int) 678 ep_int = ep; 679 } 680 } 681 682 if (!ep_in || !ep_out || (us->protocol == USB_PR_CBI && !ep_int)) { 683 US_DEBUGP("Endpoint sanity check failed! Rejecting dev.\n"); 684 return -EIO; 685 } 686 687 /* Calculate and store the pipe values */ 688 us->send_ctrl_pipe = usb_sndctrlpipe(us->pusb_dev, 0); 689 us->recv_ctrl_pipe = usb_rcvctrlpipe(us->pusb_dev, 0); 690 us->send_bulk_pipe = usb_sndbulkpipe(us->pusb_dev, 691 usb_endpoint_num(ep_out)); 692 us->recv_bulk_pipe = usb_rcvbulkpipe(us->pusb_dev, 693 usb_endpoint_num(ep_in)); 694 if (ep_int) { 695 us->recv_intr_pipe = usb_rcvintpipe(us->pusb_dev, 696 usb_endpoint_num(ep_int)); 697 us->ep_bInterval = ep_int->bInterval; 698 } 699 return 0; 700 } 701 702 /* Initialize all the dynamic resources we need */ 703 static int usb_stor_acquire_resources(struct us_data *us) 704 { 705 int p; 706 struct task_struct *th; 707 708 us->current_urb = usb_alloc_urb(0, GFP_KERNEL); 709 if (!us->current_urb) { 710 US_DEBUGP("URB allocation failed\n"); 711 return -ENOMEM; 712 } 713 714 /* Just before we start our control thread, initialize 715 * the device if it needs initialization */ 716 if (us->unusual_dev->initFunction) { 717 p = us->unusual_dev->initFunction(us); 718 if (p) 719 return p; 720 } 721 722 /* Start up our control thread */ 723 th = kthread_run(usb_stor_control_thread, us, "usb-storage"); 724 if (IS_ERR(th)) { 725 dev_warn(&us->pusb_intf->dev, 726 "Unable to start control thread\n"); 727 return PTR_ERR(th); 728 } 729 us->ctl_thread = th; 730 731 return 0; 732 } 733 734 /* Release all our dynamic resources */ 735 static void usb_stor_release_resources(struct us_data *us) 736 { 737 US_DEBUGP("-- %s\n", __func__); 738 739 /* Tell the control thread to exit. The SCSI host must 740 * already have been removed and the DISCONNECTING flag set 741 * so that we won't accept any more commands. 742 */ 743 US_DEBUGP("-- sending exit command to thread\n"); 744 complete(&us->cmnd_ready); 745 if (us->ctl_thread) 746 kthread_stop(us->ctl_thread); 747 748 /* Call the destructor routine, if it exists */ 749 if (us->extra_destructor) { 750 US_DEBUGP("-- calling extra_destructor()\n"); 751 us->extra_destructor(us->extra); 752 } 753 754 /* Free the extra data and the URB */ 755 kfree(us->extra); 756 usb_free_urb(us->current_urb); 757 } 758 759 /* Dissociate from the USB device */ 760 static void dissociate_dev(struct us_data *us) 761 { 762 US_DEBUGP("-- %s\n", __func__); 763 764 /* Free the buffers */ 765 kfree(us->cr); 766 usb_free_coherent(us->pusb_dev, US_IOBUF_SIZE, us->iobuf, us->iobuf_dma); 767 768 /* Remove our private data from the interface */ 769 usb_set_intfdata(us->pusb_intf, NULL); 770 } 771 772 /* First stage of disconnect processing: stop SCSI scanning, 773 * remove the host, and stop accepting new commands 774 */ 775 static void quiesce_and_remove_host(struct us_data *us) 776 { 777 struct Scsi_Host *host = us_to_host(us); 778 779 /* If the device is really gone, cut short reset delays */ 780 if (us->pusb_dev->state == USB_STATE_NOTATTACHED) 781 set_bit(US_FLIDX_DISCONNECTING, &us->dflags); 782 783 /* Prevent SCSI-scanning (if it hasn't started yet) 784 * and wait for the SCSI-scanning thread to stop. 785 */ 786 set_bit(US_FLIDX_DONT_SCAN, &us->dflags); 787 wake_up(&us->delay_wait); 788 wait_for_completion(&us->scanning_done); 789 790 /* Removing the host will perform an orderly shutdown: caches 791 * synchronized, disks spun down, etc. 792 */ 793 scsi_remove_host(host); 794 795 /* Prevent any new commands from being accepted and cut short 796 * reset delays. 797 */ 798 scsi_lock(host); 799 set_bit(US_FLIDX_DISCONNECTING, &us->dflags); 800 scsi_unlock(host); 801 wake_up(&us->delay_wait); 802 } 803 804 /* Second stage of disconnect processing: deallocate all resources */ 805 static void release_everything(struct us_data *us) 806 { 807 usb_stor_release_resources(us); 808 dissociate_dev(us); 809 810 /* Drop our reference to the host; the SCSI core will free it 811 * (and "us" along with it) when the refcount becomes 0. */ 812 scsi_host_put(us_to_host(us)); 813 } 814 815 /* Thread to carry out delayed SCSI-device scanning */ 816 static int usb_stor_scan_thread(void * __us) 817 { 818 struct us_data *us = (struct us_data *)__us; 819 struct device *dev = &us->pusb_intf->dev; 820 821 dev_dbg(dev, "device found\n"); 822 823 set_freezable(); 824 /* Wait for the timeout to expire or for a disconnect */ 825 if (delay_use > 0) { 826 dev_dbg(dev, "waiting for device to settle " 827 "before scanning\n"); 828 wait_event_freezable_timeout(us->delay_wait, 829 test_bit(US_FLIDX_DONT_SCAN, &us->dflags), 830 delay_use * HZ); 831 } 832 833 /* If the device is still connected, perform the scanning */ 834 if (!test_bit(US_FLIDX_DONT_SCAN, &us->dflags)) { 835 836 /* For bulk-only devices, determine the max LUN value */ 837 if (us->protocol == USB_PR_BULK && 838 !(us->fflags & US_FL_SINGLE_LUN)) { 839 mutex_lock(&us->dev_mutex); 840 us->max_lun = usb_stor_Bulk_max_lun(us); 841 mutex_unlock(&us->dev_mutex); 842 } 843 scsi_scan_host(us_to_host(us)); 844 dev_dbg(dev, "scan complete\n"); 845 846 /* Should we unbind if no devices were detected? */ 847 } 848 849 usb_autopm_put_interface(us->pusb_intf); 850 complete_and_exit(&us->scanning_done, 0); 851 } 852 853 static unsigned int usb_stor_sg_tablesize(struct usb_interface *intf) 854 { 855 struct usb_device *usb_dev = interface_to_usbdev(intf); 856 857 if (usb_dev->bus->sg_tablesize) { 858 return usb_dev->bus->sg_tablesize; 859 } 860 return SG_ALL; 861 } 862 863 /* First part of general USB mass-storage probing */ 864 int usb_stor_probe1(struct us_data **pus, 865 struct usb_interface *intf, 866 const struct usb_device_id *id, 867 struct us_unusual_dev *unusual_dev) 868 { 869 struct Scsi_Host *host; 870 struct us_data *us; 871 int result; 872 873 US_DEBUGP("USB Mass Storage device detected\n"); 874 875 /* 876 * Ask the SCSI layer to allocate a host structure, with extra 877 * space at the end for our private us_data structure. 878 */ 879 host = scsi_host_alloc(&usb_stor_host_template, sizeof(*us)); 880 if (!host) { 881 dev_warn(&intf->dev, 882 "Unable to allocate the scsi host\n"); 883 return -ENOMEM; 884 } 885 886 /* 887 * Allow 16-byte CDBs and thus > 2TB 888 */ 889 host->max_cmd_len = 16; 890 host->sg_tablesize = usb_stor_sg_tablesize(intf); 891 *pus = us = host_to_us(host); 892 memset(us, 0, sizeof(struct us_data)); 893 mutex_init(&(us->dev_mutex)); 894 init_completion(&us->cmnd_ready); 895 init_completion(&(us->notify)); 896 init_waitqueue_head(&us->delay_wait); 897 init_completion(&us->scanning_done); 898 899 /* Associate the us_data structure with the USB device */ 900 result = associate_dev(us, intf); 901 if (result) 902 goto BadDevice; 903 904 /* Get the unusual_devs entries and the descriptors */ 905 result = get_device_info(us, id, unusual_dev); 906 if (result) 907 goto BadDevice; 908 909 /* Get standard transport and protocol settings */ 910 get_transport(us); 911 get_protocol(us); 912 913 /* Give the caller a chance to fill in specialized transport 914 * or protocol settings. 915 */ 916 return 0; 917 918 BadDevice: 919 US_DEBUGP("storage_probe() failed\n"); 920 release_everything(us); 921 return result; 922 } 923 EXPORT_SYMBOL_GPL(usb_stor_probe1); 924 925 /* Second part of general USB mass-storage probing */ 926 int usb_stor_probe2(struct us_data *us) 927 { 928 struct task_struct *th; 929 int result; 930 struct device *dev = &us->pusb_intf->dev; 931 932 /* Make sure the transport and protocol have both been set */ 933 if (!us->transport || !us->proto_handler) { 934 result = -ENXIO; 935 goto BadDevice; 936 } 937 US_DEBUGP("Transport: %s\n", us->transport_name); 938 US_DEBUGP("Protocol: %s\n", us->protocol_name); 939 940 /* fix for single-lun devices */ 941 if (us->fflags & US_FL_SINGLE_LUN) 942 us->max_lun = 0; 943 944 /* Find the endpoints and calculate pipe values */ 945 result = get_pipes(us); 946 if (result) 947 goto BadDevice; 948 949 /* Acquire all the other resources and add the host */ 950 result = usb_stor_acquire_resources(us); 951 if (result) 952 goto BadDevice; 953 snprintf(us->scsi_name, sizeof(us->scsi_name), "usb-storage %s", 954 dev_name(&us->pusb_intf->dev)); 955 result = scsi_add_host(us_to_host(us), dev); 956 if (result) { 957 dev_warn(dev, 958 "Unable to add the scsi host\n"); 959 goto BadDevice; 960 } 961 962 /* Start up the thread for delayed SCSI-device scanning */ 963 th = kthread_create(usb_stor_scan_thread, us, "usb-stor-scan"); 964 if (IS_ERR(th)) { 965 dev_warn(dev, 966 "Unable to start the device-scanning thread\n"); 967 complete(&us->scanning_done); 968 quiesce_and_remove_host(us); 969 result = PTR_ERR(th); 970 goto BadDevice; 971 } 972 973 usb_autopm_get_interface_no_resume(us->pusb_intf); 974 wake_up_process(th); 975 976 return 0; 977 978 /* We come here if there are any problems */ 979 BadDevice: 980 US_DEBUGP("storage_probe() failed\n"); 981 release_everything(us); 982 return result; 983 } 984 EXPORT_SYMBOL_GPL(usb_stor_probe2); 985 986 /* Handle a USB mass-storage disconnect */ 987 void usb_stor_disconnect(struct usb_interface *intf) 988 { 989 struct us_data *us = usb_get_intfdata(intf); 990 991 US_DEBUGP("storage_disconnect() called\n"); 992 quiesce_and_remove_host(us); 993 release_everything(us); 994 } 995 EXPORT_SYMBOL_GPL(usb_stor_disconnect); 996 997 /* The main probe routine for standard devices */ 998 static int storage_probe(struct usb_interface *intf, 999 const struct usb_device_id *id) 1000 { 1001 struct us_data *us; 1002 int result; 1003 1004 /* 1005 * If libusual is configured, let it decide whether a standard 1006 * device should be handled by usb-storage or by ub. 1007 * If the device isn't standard (is handled by a subdriver 1008 * module) then don't accept it. 1009 */ 1010 if (usb_usual_check_type(id, USB_US_TYPE_STOR) || 1011 usb_usual_ignore_device(intf)) 1012 return -ENXIO; 1013 1014 /* 1015 * Call the general probe procedures. 1016 * 1017 * The unusual_dev_list array is parallel to the usb_storage_usb_ids 1018 * table, so we use the index of the id entry to find the 1019 * corresponding unusual_devs entry. 1020 */ 1021 result = usb_stor_probe1(&us, intf, id, 1022 (id - usb_storage_usb_ids) + us_unusual_dev_list); 1023 if (result) 1024 return result; 1025 1026 /* No special transport or protocol settings in the main module */ 1027 1028 result = usb_stor_probe2(us); 1029 return result; 1030 } 1031 1032 /*********************************************************************** 1033 * Initialization and registration 1034 ***********************************************************************/ 1035 1036 static struct usb_driver usb_storage_driver = { 1037 .name = "usb-storage", 1038 .probe = storage_probe, 1039 .disconnect = usb_stor_disconnect, 1040 .suspend = usb_stor_suspend, 1041 .resume = usb_stor_resume, 1042 .reset_resume = usb_stor_reset_resume, 1043 .pre_reset = usb_stor_pre_reset, 1044 .post_reset = usb_stor_post_reset, 1045 .id_table = usb_storage_usb_ids, 1046 .supports_autosuspend = 1, 1047 .soft_unbind = 1, 1048 }; 1049 1050 static int __init usb_stor_init(void) 1051 { 1052 int retval; 1053 1054 pr_info("Initializing USB Mass Storage driver...\n"); 1055 1056 /* register the driver, return usb_register return code if error */ 1057 retval = usb_register(&usb_storage_driver); 1058 if (retval == 0) { 1059 pr_info("USB Mass Storage support registered.\n"); 1060 usb_usual_set_present(USB_US_TYPE_STOR); 1061 } 1062 return retval; 1063 } 1064 1065 static void __exit usb_stor_exit(void) 1066 { 1067 US_DEBUGP("usb_stor_exit() called\n"); 1068 1069 /* Deregister the driver 1070 * This will cause disconnect() to be called for each 1071 * attached unit 1072 */ 1073 US_DEBUGP("-- calling usb_deregister()\n"); 1074 usb_deregister(&usb_storage_driver) ; 1075 1076 usb_usual_clear_present(USB_US_TYPE_STOR); 1077 } 1078 1079 module_init(usb_stor_init); 1080 module_exit(usb_stor_exit); 1081