USB: rename usb_buffer_alloc() and usb_buffer_free() users
[linux-2.6.git] / drivers / usb / storage / usb.c
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                 }
340
341                 /* lock access to the state */
342                 scsi_lock(host);
343
344                 /* indicate that the command is done */
345                 if (us->srb->result != DID_ABORT << 16) {
346                         US_DEBUGP("scsi cmd done, result=0x%x\n", 
347                                    us->srb->result);
348                         us->srb->scsi_done(us->srb);
349                 } else {
350 SkipForAbort:
351                         US_DEBUGP("scsi command aborted\n");
352                 }
353
354                 /* If an abort request was received we need to signal that
355                  * the abort has finished.  The proper test for this is
356                  * the TIMED_OUT flag, not srb->result == DID_ABORT, because
357                  * the timeout might have occurred after the command had
358                  * already completed with a different result code. */
359                 if (test_bit(US_FLIDX_TIMED_OUT, &us->dflags)) {
360                         complete(&(us->notify));
361
362                         /* Allow USB transfers to resume */
363                         clear_bit(US_FLIDX_ABORTING, &us->dflags);
364                         clear_bit(US_FLIDX_TIMED_OUT, &us->dflags);
365                 }
366
367                 /* finished working on this command */
368                 us->srb = NULL;
369                 scsi_unlock(host);
370
371                 /* unlock the device pointers */
372                 mutex_unlock(&us->dev_mutex);
373         } /* for (;;) */
374
375         /* Wait until we are told to stop */
376         for (;;) {
377                 set_current_state(TASK_INTERRUPTIBLE);
378                 if (kthread_should_stop())
379                         break;
380                 schedule();
381         }
382         __set_current_state(TASK_RUNNING);
383         return 0;
384 }       
385
386 /***********************************************************************
387  * Device probing and disconnecting
388  ***********************************************************************/
389
390 /* Associate our private data with the USB device */
391 static int associate_dev(struct us_data *us, struct usb_interface *intf)
392 {
393         US_DEBUGP("-- %s\n", __func__);
394
395         /* Fill in the device-related fields */
396         us->pusb_dev = interface_to_usbdev(intf);
397         us->pusb_intf = intf;
398         us->ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
399         US_DEBUGP("Vendor: 0x%04x, Product: 0x%04x, Revision: 0x%04x\n",
400                         le16_to_cpu(us->pusb_dev->descriptor.idVendor),
401                         le16_to_cpu(us->pusb_dev->descriptor.idProduct),
402                         le16_to_cpu(us->pusb_dev->descriptor.bcdDevice));
403         US_DEBUGP("Interface Subclass: 0x%02x, Protocol: 0x%02x\n",
404                         intf->cur_altsetting->desc.bInterfaceSubClass,
405                         intf->cur_altsetting->desc.bInterfaceProtocol);
406
407         /* Store our private data in the interface */
408         usb_set_intfdata(intf, us);
409
410         /* Allocate the control/setup and DMA-mapped buffers */
411         us->cr = kmalloc(sizeof(*us->cr), GFP_KERNEL);
412         if (!us->cr) {
413                 US_DEBUGP("usb_ctrlrequest allocation failed\n");
414                 return -ENOMEM;
415         }
416
417         us->iobuf = usb_alloc_coherent(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;
422         }
423         return 0;
424 }
425
426 /* Works only for digits and letters, but small and fast */
427 #define TOLOWER(x) ((x) | 0x20)
428
429 /* Adjust device flags based on the "quirks=" module parameter */
430 static void adjust_quirks(struct us_data *us)
431 {
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_BAD_SENSE |
437                         US_FL_FIX_CAPACITY |
438                         US_FL_CAPACITY_HEURISTICS | US_FL_IGNORE_DEVICE |
439                         US_FL_NOT_LOCKABLE | US_FL_MAX_SECTORS_64 |
440                         US_FL_CAPACITY_OK | US_FL_IGNORE_RESIDUE |
441                         US_FL_SINGLE_LUN | US_FL_NO_WP_DETECT);
442
443         p = quirks;
444         while (*p) {
445                 /* Each entry consists of VID:PID:flags */
446                 if (vid == simple_strtoul(p, &p, 16) &&
447                                 *p == ':' &&
448                                 pid == simple_strtoul(p+1, &p, 16) &&
449                                 *p == ':')
450                         break;
451
452                 /* Move forward to the next entry */
453                 while (*p) {
454                         if (*p++ == ',')
455                                 break;
456                 }
457         }
458         if (!*p)        /* No match */
459                 return;
460
461         /* Collect the flags */
462         while (*++p && *p != ',') {
463                 switch (TOLOWER(*p)) {
464                 case 'a':
465                         f |= US_FL_SANE_SENSE;
466                         break;
467                 case 'b':
468                         f |= US_FL_BAD_SENSE;
469                         break;
470                 case 'c':
471                         f |= US_FL_FIX_CAPACITY;
472                         break;
473                 case 'h':
474                         f |= US_FL_CAPACITY_HEURISTICS;
475                         break;
476                 case 'i':
477                         f |= US_FL_IGNORE_DEVICE;
478                         break;
479                 case 'l':
480                         f |= US_FL_NOT_LOCKABLE;
481                         break;
482                 case 'm':
483                         f |= US_FL_MAX_SECTORS_64;
484                         break;
485                 case 'o':
486                         f |= US_FL_CAPACITY_OK;
487                         break;
488                 case 'r':
489                         f |= US_FL_IGNORE_RESIDUE;
490                         break;
491                 case 's':
492                         f |= US_FL_SINGLE_LUN;
493                         break;
494                 case 'w':
495                         f |= US_FL_NO_WP_DETECT;
496                         break;
497                 /* Ignore unrecognized flag characters */
498                 }
499         }
500         us->fflags = (us->fflags & ~mask) | f;
501         dev_info(&us->pusb_intf->dev, "Quirks match for "
502                         "vid %04x pid %04x: %x\n",
503                         vid, pid, f);
504 }
505
506 /* Get the unusual_devs entries and the string descriptors */
507 static int get_device_info(struct us_data *us, const struct usb_device_id *id,
508                 struct us_unusual_dev *unusual_dev)
509 {
510         struct usb_device *dev = us->pusb_dev;
511         struct usb_interface_descriptor *idesc =
512                 &us->pusb_intf->cur_altsetting->desc;
513
514         /* Store the entries */
515         us->unusual_dev = unusual_dev;
516         us->subclass = (unusual_dev->useProtocol == US_SC_DEVICE) ?
517                         idesc->bInterfaceSubClass :
518                         unusual_dev->useProtocol;
519         us->protocol = (unusual_dev->useTransport == US_PR_DEVICE) ?
520                         idesc->bInterfaceProtocol :
521                         unusual_dev->useTransport;
522         us->fflags = USB_US_ORIG_FLAGS(id->driver_info);
523         adjust_quirks(us);
524
525         if (us->fflags & US_FL_IGNORE_DEVICE) {
526                 printk(KERN_INFO USB_STORAGE "device ignored\n");
527                 return -ENODEV;
528         }
529
530         /*
531          * This flag is only needed when we're in high-speed, so let's
532          * disable it if we're in full-speed
533          */
534         if (dev->speed != USB_SPEED_HIGH)
535                 us->fflags &= ~US_FL_GO_SLOW;
536
537         /* Log a message if a non-generic unusual_dev entry contains an
538          * unnecessary subclass or protocol override.  This may stimulate
539          * reports from users that will help us remove unneeded entries
540          * from the unusual_devs.h table.
541          */
542         if (id->idVendor || id->idProduct) {
543                 static const char *msgs[3] = {
544                         "an unneeded SubClass entry",
545                         "an unneeded Protocol entry",
546                         "unneeded SubClass and Protocol entries"};
547                 struct usb_device_descriptor *ddesc = &dev->descriptor;
548                 int msg = -1;
549
550                 if (unusual_dev->useProtocol != US_SC_DEVICE &&
551                         us->subclass == idesc->bInterfaceSubClass)
552                         msg += 1;
553                 if (unusual_dev->useTransport != US_PR_DEVICE &&
554                         us->protocol == idesc->bInterfaceProtocol)
555                         msg += 2;
556                 if (msg >= 0 && !(us->fflags & US_FL_NEED_OVERRIDE))
557                         printk(KERN_NOTICE USB_STORAGE "This device "
558                                 "(%04x,%04x,%04x S %02x P %02x)"
559                                 " has %s in unusual_devs.h (kernel"
560                                 " %s)\n"
561                                 "   Please send a copy of this message to "
562                                 "<linux-usb@vger.kernel.org> and "
563                                 "<usb-storage@lists.one-eyed-alien.net>\n",
564                                 le16_to_cpu(ddesc->idVendor),
565                                 le16_to_cpu(ddesc->idProduct),
566                                 le16_to_cpu(ddesc->bcdDevice),
567                                 idesc->bInterfaceSubClass,
568                                 idesc->bInterfaceProtocol,
569                                 msgs[msg],
570                                 utsname()->release);
571         }
572
573         return 0;
574 }
575
576 /* Get the transport settings */
577 static void get_transport(struct us_data *us)
578 {
579         switch (us->protocol) {
580         case US_PR_CB:
581                 us->transport_name = "Control/Bulk";
582                 us->transport = usb_stor_CB_transport;
583                 us->transport_reset = usb_stor_CB_reset;
584                 us->max_lun = 7;
585                 break;
586
587         case US_PR_CBI:
588                 us->transport_name = "Control/Bulk/Interrupt";
589                 us->transport = usb_stor_CB_transport;
590                 us->transport_reset = usb_stor_CB_reset;
591                 us->max_lun = 7;
592                 break;
593
594         case US_PR_BULK:
595                 us->transport_name = "Bulk";
596                 us->transport = usb_stor_Bulk_transport;
597                 us->transport_reset = usb_stor_Bulk_reset;
598                 break;
599         }
600 }
601
602 /* Get the protocol settings */
603 static void get_protocol(struct us_data *us)
604 {
605         switch (us->subclass) {
606         case US_SC_RBC:
607                 us->protocol_name = "Reduced Block Commands (RBC)";
608                 us->proto_handler = usb_stor_transparent_scsi_command;
609                 break;
610
611         case US_SC_8020:
612                 us->protocol_name = "8020i";
613                 us->proto_handler = usb_stor_pad12_command;
614                 us->max_lun = 0;
615                 break;
616
617         case US_SC_QIC:
618                 us->protocol_name = "QIC-157";
619                 us->proto_handler = usb_stor_pad12_command;
620                 us->max_lun = 0;
621                 break;
622
623         case US_SC_8070:
624                 us->protocol_name = "8070i";
625                 us->proto_handler = usb_stor_pad12_command;
626                 us->max_lun = 0;
627                 break;
628
629         case US_SC_SCSI:
630                 us->protocol_name = "Transparent SCSI";
631                 us->proto_handler = usb_stor_transparent_scsi_command;
632                 break;
633
634         case US_SC_UFI:
635                 us->protocol_name = "Uniform Floppy Interface (UFI)";
636                 us->proto_handler = usb_stor_ufi_command;
637                 break;
638         }
639 }
640
641 /* Get the pipe settings */
642 static int get_pipes(struct us_data *us)
643 {
644         struct usb_host_interface *altsetting =
645                 us->pusb_intf->cur_altsetting;
646         int i;
647         struct usb_endpoint_descriptor *ep;
648         struct usb_endpoint_descriptor *ep_in = NULL;
649         struct usb_endpoint_descriptor *ep_out = NULL;
650         struct usb_endpoint_descriptor *ep_int = NULL;
651
652         /*
653          * Find the first endpoint of each type we need.
654          * We are expecting a minimum of 2 endpoints - in and out (bulk).
655          * An optional interrupt-in is OK (necessary for CBI protocol).
656          * We will ignore any others.
657          */
658         for (i = 0; i < altsetting->desc.bNumEndpoints; i++) {
659                 ep = &altsetting->endpoint[i].desc;
660
661                 if (usb_endpoint_xfer_bulk(ep)) {
662                         if (usb_endpoint_dir_in(ep)) {
663                                 if (!ep_in)
664                                         ep_in = ep;
665                         } else {
666                                 if (!ep_out)
667                                         ep_out = ep;
668                         }
669                 }
670
671                 else if (usb_endpoint_is_int_in(ep)) {
672                         if (!ep_int)
673                                 ep_int = ep;
674                 }
675         }
676
677         if (!ep_in || !ep_out || (us->protocol == US_PR_CBI && !ep_int)) {
678                 US_DEBUGP("Endpoint sanity check failed! Rejecting dev.\n");
679                 return -EIO;
680         }
681
682         /* Calculate and store the pipe values */
683         us->send_ctrl_pipe = usb_sndctrlpipe(us->pusb_dev, 0);
684         us->recv_ctrl_pipe = usb_rcvctrlpipe(us->pusb_dev, 0);
685         us->send_bulk_pipe = usb_sndbulkpipe(us->pusb_dev,
686                 usb_endpoint_num(ep_out));
687         us->recv_bulk_pipe = usb_rcvbulkpipe(us->pusb_dev, 
688                 usb_endpoint_num(ep_in));
689         if (ep_int) {
690                 us->recv_intr_pipe = usb_rcvintpipe(us->pusb_dev,
691                         usb_endpoint_num(ep_int));
692                 us->ep_bInterval = ep_int->bInterval;
693         }
694         return 0;
695 }
696
697 /* Initialize all the dynamic resources we need */
698 static int usb_stor_acquire_resources(struct us_data *us)
699 {
700         int p;
701         struct task_struct *th;
702
703         us->current_urb = usb_alloc_urb(0, GFP_KERNEL);
704         if (!us->current_urb) {
705                 US_DEBUGP("URB allocation failed\n");
706                 return -ENOMEM;
707         }
708
709         /* Just before we start our control thread, initialize
710          * the device if it needs initialization */
711         if (us->unusual_dev->initFunction) {
712                 p = us->unusual_dev->initFunction(us);
713                 if (p)
714                         return p;
715         }
716
717         /* Start up our control thread */
718         th = kthread_run(usb_stor_control_thread, us, "usb-storage");
719         if (IS_ERR(th)) {
720                 printk(KERN_WARNING USB_STORAGE 
721                        "Unable to start control thread\n");
722                 return PTR_ERR(th);
723         }
724         us->ctl_thread = th;
725
726         return 0;
727 }
728
729 /* Release all our dynamic resources */
730 static void usb_stor_release_resources(struct us_data *us)
731 {
732         US_DEBUGP("-- %s\n", __func__);
733
734         /* Tell the control thread to exit.  The SCSI host must
735          * already have been removed and the DISCONNECTING flag set
736          * so that we won't accept any more commands.
737          */
738         US_DEBUGP("-- sending exit command to thread\n");
739         complete(&us->cmnd_ready);
740         if (us->ctl_thread)
741                 kthread_stop(us->ctl_thread);
742
743         /* Call the destructor routine, if it exists */
744         if (us->extra_destructor) {
745                 US_DEBUGP("-- calling extra_destructor()\n");
746                 us->extra_destructor(us->extra);
747         }
748
749         /* Free the extra data and the URB */
750         kfree(us->extra);
751         usb_free_urb(us->current_urb);
752 }
753
754 /* Dissociate from the USB device */
755 static void dissociate_dev(struct us_data *us)
756 {
757         US_DEBUGP("-- %s\n", __func__);
758
759         /* Free the buffers */
760         kfree(us->cr);
761         usb_free_coherent(us->pusb_dev, US_IOBUF_SIZE, us->iobuf, us->iobuf_dma);
762
763         /* Remove our private data from the interface */
764         usb_set_intfdata(us->pusb_intf, NULL);
765 }
766
767 /* First stage of disconnect processing: stop SCSI scanning,
768  * remove the host, and stop accepting new commands
769  */
770 static void quiesce_and_remove_host(struct us_data *us)
771 {
772         struct Scsi_Host *host = us_to_host(us);
773
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);
777
778         /* Prevent SCSI-scanning (if it hasn't started yet)
779          * and wait for the SCSI-scanning thread to stop.
780          */
781         set_bit(US_FLIDX_DONT_SCAN, &us->dflags);
782         wake_up(&us->delay_wait);
783         wait_for_completion(&us->scanning_done);
784
785         /* Removing the host will perform an orderly shutdown: caches
786          * synchronized, disks spun down, etc.
787          */
788         scsi_remove_host(host);
789
790         /* Prevent any new commands from being accepted and cut short
791          * reset delays.
792          */
793         scsi_lock(host);
794         set_bit(US_FLIDX_DISCONNECTING, &us->dflags);
795         scsi_unlock(host);
796         wake_up(&us->delay_wait);
797 }
798
799 /* Second stage of disconnect processing: deallocate all resources */
800 static void release_everything(struct us_data *us)
801 {
802         usb_stor_release_resources(us);
803         dissociate_dev(us);
804
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));
808 }
809
810 /* Thread to carry out delayed SCSI-device scanning */
811 static int usb_stor_scan_thread(void * __us)
812 {
813         struct us_data *us = (struct us_data *)__us;
814
815         dev_dbg(&us->pusb_intf->dev, "device found\n");
816
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);
825         }
826
827         /* If the device is still connected, perform the scanning */
828         if (!test_bit(US_FLIDX_DONT_SCAN, &us->dflags)) {
829
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);
836                 }
837                 scsi_scan_host(us_to_host(us));
838                 dev_dbg(&us->pusb_intf->dev, "scan complete\n");
839
840                 /* Should we unbind if no devices were detected? */
841         }
842
843         complete_and_exit(&us->scanning_done, 0);
844 }
845
846 static unsigned int usb_stor_sg_tablesize(struct usb_interface *intf)
847 {
848         struct usb_device *usb_dev = interface_to_usbdev(intf);
849
850         if (usb_dev->bus->sg_tablesize) {
851                 return usb_dev->bus->sg_tablesize;
852         }
853         return SG_ALL;
854 }
855
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)
861 {
862         struct Scsi_Host *host;
863         struct us_data *us;
864         int result;
865
866         US_DEBUGP("USB Mass Storage device detected\n");
867
868         /*
869          * Ask the SCSI layer to allocate a host structure, with extra
870          * space at the end for our private us_data structure.
871          */
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;
877         }
878
879         /*
880          * Allow 16-byte CDBs and thus > 2TB
881          */
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);
891
892         /* Associate the us_data structure with the USB device */
893         result = associate_dev(us, intf);
894         if (result)
895                 goto BadDevice;
896
897         /* Get the unusual_devs entries and the descriptors */
898         result = get_device_info(us, id, unusual_dev);
899         if (result)
900                 goto BadDevice;
901
902         /* Get standard transport and protocol settings */
903         get_transport(us);
904         get_protocol(us);
905
906         /* Give the caller a chance to fill in specialized transport
907          * or protocol settings.
908          */
909         return 0;
910
911 BadDevice:
912         US_DEBUGP("storage_probe() failed\n");
913         release_everything(us);
914         return result;
915 }
916 EXPORT_SYMBOL_GPL(usb_stor_probe1);
917
918 /* Second part of general USB mass-storage probing */
919 int usb_stor_probe2(struct us_data *us)
920 {
921         struct task_struct *th;
922         int result;
923
924         /* Make sure the transport and protocol have both been set */
925         if (!us->transport || !us->proto_handler) {
926                 result = -ENXIO;
927                 goto BadDevice;
928         }
929         US_DEBUGP("Transport: %s\n", us->transport_name);
930         US_DEBUGP("Protocol: %s\n", us->protocol_name);
931
932         /* fix for single-lun devices */
933         if (us->fflags & US_FL_SINGLE_LUN)
934                 us->max_lun = 0;
935
936         /* Find the endpoints and calculate pipe values */
937         result = get_pipes(us);
938         if (result)
939                 goto BadDevice;
940
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;
952         }
953
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;
963         }
964
965         wake_up_process(th);
966
967         return 0;
968
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;
974 }
975 EXPORT_SYMBOL_GPL(usb_stor_probe2);
976
977 /* Handle a USB mass-storage disconnect */
978 void usb_stor_disconnect(struct usb_interface *intf)
979 {
980         struct us_data *us = usb_get_intfdata(intf);
981
982         US_DEBUGP("storage_disconnect() called\n");
983         quiesce_and_remove_host(us);
984         release_everything(us);
985 }
986 EXPORT_SYMBOL_GPL(usb_stor_disconnect);
987
988 /* The main probe routine for standard devices */
989 static int storage_probe(struct usb_interface *intf,
990                          const struct usb_device_id *id)
991 {
992         struct us_data *us;
993         int result;
994
995         /*
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.
1000          */
1001         if (usb_usual_check_type(id, USB_US_TYPE_STOR) ||
1002                         usb_usual_ignore_device(intf))
1003                 return -ENXIO;
1004
1005         /*
1006          * Call the general probe procedures.
1007          *
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.
1011          */
1012         result = usb_stor_probe1(&us, intf, id,
1013                         (id - usb_storage_usb_ids) + us_unusual_dev_list);
1014         if (result)
1015                 return result;
1016
1017         /* No special transport or protocol settings in the main module */
1018
1019         result = usb_stor_probe2(us);
1020         return result;
1021 }
1022
1023 /***********************************************************************
1024  * Initialization and registration
1025  ***********************************************************************/
1026
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,
1038 };
1039
1040 static int __init usb_stor_init(void)
1041 {
1042         int retval;
1043
1044         printk(KERN_INFO "Initializing USB Mass Storage driver...\n");
1045
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);
1051         }
1052         return retval;
1053 }
1054
1055 static void __exit usb_stor_exit(void)
1056 {
1057         US_DEBUGP("usb_stor_exit() called\n");
1058
1059         /* Deregister the driver
1060          * This will cause disconnect() to be called for each
1061          * attached unit
1062          */
1063         US_DEBUGP("-- calling usb_deregister()\n");
1064         usb_deregister(&usb_storage_driver) ;
1065
1066         usb_usual_clear_present(USB_US_TYPE_STOR);
1067 }
1068
1069 module_init(usb_stor_init);
1070 module_exit(usb_stor_exit);