blob: 06615934fed1cc537694b03d023b613c95aea9f1 [file] [log] [blame]
Felipe Balbif0183a32016-04-18 13:09:11 +03001/*
2 * Driver for USB Mass Storage compliant devices
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 * Current development and maintenance by:
5 * (c) 1999-2003 Matthew Dharm (mdharm-usb@one-eyed-alien.net)
6 *
7 * Developed with the assistance of:
8 * (c) 2000 David L. Brown, Jr. (usb-storage@davidb.org)
Alan Sterne6e244b2009-02-12 14:47:44 -05009 * (c) 2003-2009 Alan Stern (stern@rowland.harvard.edu)
Linus Torvalds1da177e2005-04-16 15:20:36 -070010 *
11 * Initial work by:
12 * (c) 1999 Michael Gee (michael@linuxspecific.com)
13 *
14 * usb_device_id support by Adam J. Richter (adam@yggdrasil.com):
15 * (c) 2000 Yggdrasil Computing, Inc.
16 *
17 * This driver is based on the 'USB Mass Storage Class' document. This
18 * describes in detail the protocol used to communicate with such
19 * devices. Clearly, the designers had SCSI and ATAPI commands in
20 * mind when they created this document. The commands are all very
21 * similar to commands in the SCSI-II and ATAPI specifications.
22 *
23 * It is important to note that in a number of cases this class
24 * exhibits class-specific exemptions from the USB specification.
25 * Notably the usage of NAK, STALL and ACK differs from the norm, in
26 * that they are used to communicate wait, failed and OK on commands.
27 *
28 * Also, for certain devices, the interrupt endpoint is used to convey
29 * status of a command.
30 *
31 * Please see http://www.one-eyed-alien.net/~mdharm/linux-usb for more
32 * information about this driver.
33 *
34 * This program is free software; you can redistribute it and/or modify it
35 * under the terms of the GNU General Public License as published by the
36 * Free Software Foundation; either version 2, or (at your option) any
37 * later version.
38 *
39 * This program is distributed in the hope that it will be useful, but
40 * WITHOUT ANY WARRANTY; without even the implied warranty of
41 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
42 * General Public License for more details.
43 *
44 * You should have received a copy of the GNU General Public License along
45 * with this program; if not, write to the Free Software Foundation, Inc.,
46 * 675 Mass Ave, Cambridge, MA 02139, USA.
47 */
48
Matthew Wilcox9eb66f72009-09-24 16:19:49 -060049#ifdef CONFIG_USB_STORAGE_DEBUG
50#define DEBUG
51#endif
52
Linus Torvalds1da177e2005-04-16 15:20:36 -070053#include <linux/sched.h>
54#include <linux/errno.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070055#include <linux/module.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070056#include <linux/slab.h>
Alan Stern3f13e662005-10-23 19:43:36 -070057#include <linux/kthread.h>
Arjan van de Ven4186ecf2006-01-11 15:55:29 +010058#include <linux/mutex.h>
Sam Ravnborg00f8b0c12007-03-05 00:30:55 -080059#include <linux/utsname.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
61#include <scsi/scsi.h>
62#include <scsi/scsi_cmnd.h>
63#include <scsi/scsi_device.h>
64
65#include "usb.h"
66#include "scsiglue.h"
67#include "transport.h"
68#include "protocol.h"
69#include "debug.h"
70#include "initializers.h"
71
Kevin Lloyd32fe5e32008-07-10 14:14:57 -070072#include "sierra_ms.h"
Dan Williams281b0642008-12-14 12:39:22 -050073#include "option_ms.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070074
Hans de Goede5bfd5b52013-10-21 09:40:48 +010075#if IS_ENABLED(CONFIG_USB_UAS)
76#include "uas-detect.h"
77#endif
78
Akinobu Mitaaa519be2015-05-06 18:24:21 +090079#define DRV_NAME "usb-storage"
80
Linus Torvalds1da177e2005-04-16 15:20:36 -070081/* Some informational data */
82MODULE_AUTHOR("Matthew Dharm <mdharm-usb@one-eyed-alien.net>");
83MODULE_DESCRIPTION("USB Mass Storage driver for Linux");
84MODULE_LICENSE("GPL");
85
Linus Torvaldsa4a47bc2010-02-26 10:03:22 -080086static unsigned int delay_use = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -070087module_param(delay_use, uint, S_IRUGO | S_IWUSR);
88MODULE_PARM_DESC(delay_use, "seconds to delay before using a new device");
89
Alan Sternc838ea42008-12-15 10:40:06 -050090static char quirks[128];
91module_param_string(quirks, quirks, sizeof(quirks), S_IRUGO | S_IWUSR);
Alan Sternd4f373e2008-11-10 14:07:45 -050092MODULE_PARM_DESC(quirks, "supplemental list of device IDs and their quirks");
93
Linus Torvalds1da177e2005-04-16 15:20:36 -070094
Pete Zaitceva00828e2005-10-22 20:15:09 -070095/*
96 * The entries in this table correspond, line for line,
Alan Sterne6e244b2009-02-12 14:47:44 -050097 * with the entries in usb_storage_usb_ids[], defined in usual-tables.c.
Linus Torvalds1da177e2005-04-16 15:20:36 -070098 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070099
Felipe Balbif0183a32016-04-18 13:09:11 +0300100/*
101 *The vendor name should be kept at eight characters or less, and
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 * the product name should be kept at 16 characters or less. If a device
103 * has the US_FL_FIX_INQUIRY flag, then the vendor and product names
Mickael Maisona6cd2442014-09-18 11:25:04 +0200104 * normally generated by a device through the INQUIRY response will be
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 * taken from this list, and this is the reason for the above size
106 * restriction. However, if the flag is not present, then you
107 * are free to use as many characters as you like.
108 */
109
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110#define UNUSUAL_DEV(idVendor, idProduct, bcdDeviceMin, bcdDeviceMax, \
111 vendor_name, product_name, use_protocol, use_transport, \
112 init_function, Flags) \
113{ \
114 .vendorName = vendor_name, \
115 .productName = product_name, \
116 .useProtocol = use_protocol, \
117 .useTransport = use_transport, \
118 .initFunction = init_function, \
Pete Zaitceva00828e2005-10-22 20:15:09 -0700119}
120
Alan Stern25ff1c32008-12-15 12:43:41 -0500121#define COMPLIANT_DEV UNUSUAL_DEV
122
Sebastian Andrzej Siewiorf61870e2012-08-28 22:37:13 +0200123#define USUAL_DEV(use_protocol, use_transport) \
Pete Zaitceva00828e2005-10-22 20:15:09 -0700124{ \
125 .useProtocol = use_protocol, \
126 .useTransport = use_transport, \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127}
128
fangxiaozhi07c7be32013-02-04 15:14:46 +0800129#define UNUSUAL_VENDOR_INTF(idVendor, cl, sc, pr, \
130 vendor_name, product_name, use_protocol, use_transport, \
131 init_function, Flags) \
132{ \
133 .vendorName = vendor_name, \
134 .productName = product_name, \
135 .useProtocol = use_protocol, \
136 .useTransport = use_transport, \
137 .initFunction = init_function, \
138}
139
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140static struct us_unusual_dev us_unusual_dev_list[] = {
Jeffrin Josea1631062012-05-17 00:33:36 +0530141# include "unusual_devs.h"
Alan Sterne6e244b2009-02-12 14:47:44 -0500142 { } /* Terminating entry */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143};
144
Huajun Lifd7ff362012-01-14 10:16:40 +0800145static struct us_unusual_dev for_dynamic_ids =
Sebastian Andrzej Siewiorf61870e2012-08-28 22:37:13 +0200146 USUAL_DEV(USB_SC_SCSI, USB_PR_BULK);
Huajun Lifd7ff362012-01-14 10:16:40 +0800147
Alan Sterne6e244b2009-02-12 14:47:44 -0500148#undef UNUSUAL_DEV
149#undef COMPLIANT_DEV
150#undef USUAL_DEV
fangxiaozhi07c7be32013-02-04 15:14:46 +0800151#undef UNUSUAL_VENDOR_INTF
Alan Sterne6e244b2009-02-12 14:47:44 -0500152
Ming Leic825bab2012-03-19 15:20:57 +0800153#ifdef CONFIG_LOCKDEP
154
155static struct lock_class_key us_interface_key[USB_MAXINTERFACES];
156
157static void us_set_lock_class(struct mutex *mutex,
158 struct usb_interface *intf)
159{
160 struct usb_device *udev = interface_to_usbdev(intf);
161 struct usb_host_config *config = udev->actconfig;
162 int i;
163
164 for (i = 0; i < config->desc.bNumInterfaces; i++) {
165 if (config->interface[i] == intf)
166 break;
167 }
168
169 BUG_ON(i == config->desc.bNumInterfaces);
170
171 lockdep_set_class(mutex, &us_interface_key[i]);
172}
173
174#else
175
176static void us_set_lock_class(struct mutex *mutex,
177 struct usb_interface *intf)
178{
179}
180
181#endif
Alan Sternce2596d2005-10-23 19:41:39 -0700182
183#ifdef CONFIG_PM /* Minimal support for suspend and resume */
184
Alan Sterne6e244b2009-02-12 14:47:44 -0500185int usb_stor_suspend(struct usb_interface *iface, pm_message_t message)
Alan Sternce2596d2005-10-23 19:41:39 -0700186{
187 struct us_data *us = usb_get_intfdata(iface);
188
189 /* Wait until no command is running */
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100190 mutex_lock(&us->dev_mutex);
Alan Sternce2596d2005-10-23 19:41:39 -0700191
Matthew Dharm7931e1c2005-12-04 21:56:51 -0800192 if (us->suspend_resume_hook)
193 (us->suspend_resume_hook)(us, US_SUSPEND);
Alan Sternce2596d2005-10-23 19:41:39 -0700194
Felipe Balbif0183a32016-04-18 13:09:11 +0300195 /*
196 * When runtime PM is working, we'll set a flag to indicate
197 * whether we should autoresume when a SCSI request arrives.
198 */
Greg Kroah-Hartmand5268752007-09-13 06:01:24 -0700199
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100200 mutex_unlock(&us->dev_mutex);
Alan Sternce2596d2005-10-23 19:41:39 -0700201 return 0;
202}
Alan Sterne6e244b2009-02-12 14:47:44 -0500203EXPORT_SYMBOL_GPL(usb_stor_suspend);
Alan Sternce2596d2005-10-23 19:41:39 -0700204
Alan Sterne6e244b2009-02-12 14:47:44 -0500205int usb_stor_resume(struct usb_interface *iface)
Alan Sternce2596d2005-10-23 19:41:39 -0700206{
207 struct us_data *us = usb_get_intfdata(iface);
208
Greg Kroah-Hartmand5268752007-09-13 06:01:24 -0700209 mutex_lock(&us->dev_mutex);
Alan Stern8dfe4b12007-07-06 14:24:27 -0400210
Matthew Dharm7931e1c2005-12-04 21:56:51 -0800211 if (us->suspend_resume_hook)
212 (us->suspend_resume_hook)(us, US_RESUME);
Alan Sternce2596d2005-10-23 19:41:39 -0700213
Greg Kroah-Hartmand5268752007-09-13 06:01:24 -0700214 mutex_unlock(&us->dev_mutex);
Alan Sternce2596d2005-10-23 19:41:39 -0700215 return 0;
216}
Alan Sterne6e244b2009-02-12 14:47:44 -0500217EXPORT_SYMBOL_GPL(usb_stor_resume);
Alan Sternce2596d2005-10-23 19:41:39 -0700218
Alan Sterne6e244b2009-02-12 14:47:44 -0500219int usb_stor_reset_resume(struct usb_interface *iface)
Alan Sternf07600c2007-05-30 15:38:16 -0400220{
221 struct us_data *us = usb_get_intfdata(iface);
222
Alan Sternf07600c2007-05-30 15:38:16 -0400223 /* Report the reset to the SCSI core */
224 usb_stor_report_bus_reset(us);
225
Felipe Balbif0183a32016-04-18 13:09:11 +0300226 /*
227 * FIXME: Notify the subdrivers that they need to reinitialize
228 * the device
229 */
Alan Sternf07600c2007-05-30 15:38:16 -0400230 return 0;
231}
Alan Sterne6e244b2009-02-12 14:47:44 -0500232EXPORT_SYMBOL_GPL(usb_stor_reset_resume);
Alan Sternf07600c2007-05-30 15:38:16 -0400233
Alan Sternce2596d2005-10-23 19:41:39 -0700234#endif /* CONFIG_PM */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235
236/*
Alan Stern47104b02006-06-01 13:52:56 -0400237 * The next two routines get called just before and just after
238 * a USB port reset, whether from this driver or a different one.
239 */
240
Alan Sterne6e244b2009-02-12 14:47:44 -0500241int usb_stor_pre_reset(struct usb_interface *iface)
Alan Stern47104b02006-06-01 13:52:56 -0400242{
243 struct us_data *us = usb_get_intfdata(iface);
244
Alan Stern47104b02006-06-01 13:52:56 -0400245 /* Make sure no command runs during the reset */
246 mutex_lock(&us->dev_mutex);
Alan Sternf07600c2007-05-30 15:38:16 -0400247 return 0;
Alan Stern47104b02006-06-01 13:52:56 -0400248}
Alan Sterne6e244b2009-02-12 14:47:44 -0500249EXPORT_SYMBOL_GPL(usb_stor_pre_reset);
Alan Stern47104b02006-06-01 13:52:56 -0400250
Alan Sterne6e244b2009-02-12 14:47:44 -0500251int usb_stor_post_reset(struct usb_interface *iface)
Alan Stern47104b02006-06-01 13:52:56 -0400252{
253 struct us_data *us = usb_get_intfdata(iface);
254
Alan Stern47104b02006-06-01 13:52:56 -0400255 /* Report the reset to the SCSI core */
Alan Stern47104b02006-06-01 13:52:56 -0400256 usb_stor_report_bus_reset(us);
Alan Stern47104b02006-06-01 13:52:56 -0400257
Felipe Balbif0183a32016-04-18 13:09:11 +0300258 /*
259 * FIXME: Notify the subdrivers that they need to reinitialize
260 * the device
261 */
Alan Stern0458d5b2007-05-04 11:52:20 -0400262
Alan Sternf07600c2007-05-30 15:38:16 -0400263 mutex_unlock(&us->dev_mutex);
264 return 0;
Alan Stern47104b02006-06-01 13:52:56 -0400265}
Alan Sterne6e244b2009-02-12 14:47:44 -0500266EXPORT_SYMBOL_GPL(usb_stor_post_reset);
Alan Stern47104b02006-06-01 13:52:56 -0400267
268/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 * fill_inquiry_response takes an unsigned char array (which must
270 * be at least 36 characters) and populates the vendor name,
271 * product name, and revision fields. Then the array is copied
272 * into the SCSI command's response buffer (oddly enough
273 * called request_buffer). data_len contains the length of the
274 * data array, which again must be at least 36.
275 */
276
277void fill_inquiry_response(struct us_data *us, unsigned char *data,
278 unsigned int data_len)
279{
Jeffrin Josea1631062012-05-17 00:33:36 +0530280 if (data_len < 36) /* You lose. */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 return;
282
Alan Sternf3f6faa2009-12-07 16:47:43 -0500283 memset(data+8, ' ', 28);
Felipe Balbif0183a32016-04-18 13:09:11 +0300284 if (data[0]&0x20) { /*
285 * USB device currently not connected. Return
286 * peripheral qualifier 001b ("...however, the
287 * physical device is not currently connected
288 * to this logical unit") and leave vendor and
289 * product identification empty. ("If the target
290 * does store some of the INQUIRY data on the
291 * device, it may return zeros or ASCII spaces
292 * (20h) in those fields until the data is
293 * available from the device.").
294 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 } else {
296 u16 bcdDevice = le16_to_cpu(us->pusb_dev->descriptor.bcdDevice);
Alan Sternf3f6faa2009-12-07 16:47:43 -0500297 int n;
298
299 n = strlen(us->unusual_dev->vendorName);
300 memcpy(data+8, us->unusual_dev->vendorName, min(8, n));
301 n = strlen(us->unusual_dev->productName);
302 memcpy(data+16, us->unusual_dev->productName, min(16, n));
303
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 data[32] = 0x30 + ((bcdDevice>>12) & 0x0F);
305 data[33] = 0x30 + ((bcdDevice>>8) & 0x0F);
306 data[34] = 0x30 + ((bcdDevice>>4) & 0x0F);
307 data[35] = 0x30 + ((bcdDevice) & 0x0F);
308 }
309
310 usb_stor_set_xfer_buf(data, data_len, us->srb);
311}
Alan Sterne6e244b2009-02-12 14:47:44 -0500312EXPORT_SYMBOL_GPL(fill_inquiry_response);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313
314static int usb_stor_control_thread(void * __us)
315{
316 struct us_data *us = (struct us_data *)__us;
317 struct Scsi_Host *host = us_to_host(us);
318
Jeffrin Josedb2c8622012-05-17 00:34:28 +0530319 for (;;) {
Joe Perches191648d2013-04-19 11:44:00 -0700320 usb_stor_dbg(us, "*** thread sleeping\n");
Alan Stern7119e3c2008-05-01 15:36:13 -0400321 if (wait_for_completion_interruptible(&us->cmnd_ready))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 break;
Alan Stern7119e3c2008-05-01 15:36:13 -0400323
Joe Perches191648d2013-04-19 11:44:00 -0700324 usb_stor_dbg(us, "*** thread awakened\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325
326 /* lock the device pointers */
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100327 mutex_lock(&(us->dev_mutex));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328
Linus Torvalds1da177e2005-04-16 15:20:36 -0700329 /* lock access to the state */
330 scsi_lock(host);
331
Alan Stern543f7812008-05-08 11:55:59 -0400332 /* When we are called with no command pending, we're done */
333 if (us->srb == NULL) {
334 scsi_unlock(host);
335 mutex_unlock(&us->dev_mutex);
Joe Perches191648d2013-04-19 11:44:00 -0700336 usb_stor_dbg(us, "-- exiting\n");
Alan Stern543f7812008-05-08 11:55:59 -0400337 break;
338 }
339
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340 /* has the command timed out *already* ? */
Alan Stern7e4d6c32008-05-01 15:35:18 -0400341 if (test_bit(US_FLIDX_TIMED_OUT, &us->dflags)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 us->srb->result = DID_ABORT << 16;
343 goto SkipForAbort;
344 }
345
346 scsi_unlock(host);
347
Felipe Balbif0183a32016-04-18 13:09:11 +0300348 /*
349 * reject the command if the direction indicator
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 * is UNKNOWN
351 */
352 if (us->srb->sc_data_direction == DMA_BIDIRECTIONAL) {
Joe Perches191648d2013-04-19 11:44:00 -0700353 usb_stor_dbg(us, "UNKNOWN data direction\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 us->srb->result = DID_ERROR << 16;
355 }
356
Felipe Balbif0183a32016-04-18 13:09:11 +0300357 /*
358 * reject if target != 0 or if LUN is higher than
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 * the maximum known LUN
360 */
Jeffrin Josea1631062012-05-17 00:33:36 +0530361 else if (us->srb->device->id &&
Alan Stern7e4d6c32008-05-01 15:35:18 -0400362 !(us->fflags & US_FL_SCM_MULT_TARG)) {
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200363 usb_stor_dbg(us, "Bad target number (%d:%llu)\n",
364 us->srb->device->id,
365 us->srb->device->lun);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 us->srb->result = DID_BAD_TARGET << 16;
367 }
368
369 else if (us->srb->device->lun > us->max_lun) {
Hannes Reinecke9cb78c12014-06-25 15:27:36 +0200370 usb_stor_dbg(us, "Bad LUN (%d:%llu)\n",
371 us->srb->device->id,
372 us->srb->device->lun);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373 us->srb->result = DID_BAD_TARGET << 16;
374 }
375
Felipe Balbif0183a32016-04-18 13:09:11 +0300376 /*
377 * Handle those devices which need us to fake
378 * their inquiry data
379 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380 else if ((us->srb->cmnd[0] == INQUIRY) &&
Alan Stern7e4d6c32008-05-01 15:35:18 -0400381 (us->fflags & US_FL_FIX_INQUIRY)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700382 unsigned char data_ptr[36] = {
383 0x00, 0x80, 0x02, 0x02,
384 0x1F, 0x00, 0x00, 0x00};
385
Joe Perches191648d2013-04-19 11:44:00 -0700386 usb_stor_dbg(us, "Faking INQUIRY command\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 fill_inquiry_response(us, data_ptr, 36);
388 us->srb->result = SAM_STAT_GOOD;
389 }
390
391 /* we've got a command, let's do it! */
392 else {
Joe Perches191648d2013-04-19 11:44:00 -0700393 US_DEBUG(usb_stor_show_command(us, us->srb));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394 us->proto_handler(us->srb, us);
Alan Sternf2839252010-07-28 17:12:39 -0400395 usb_mark_last_busy(us->pusb_dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 }
397
398 /* lock access to the state */
399 scsi_lock(host);
400
401 /* indicate that the command is done */
Alan Stern543f7812008-05-08 11:55:59 -0400402 if (us->srb->result != DID_ABORT << 16) {
Joe Perches191648d2013-04-19 11:44:00 -0700403 usb_stor_dbg(us, "scsi cmd done, result=0x%x\n",
404 us->srb->result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 us->srb->scsi_done(us->srb);
406 } else {
407SkipForAbort:
Joe Perches191648d2013-04-19 11:44:00 -0700408 usb_stor_dbg(us, "scsi command aborted\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 }
410
Felipe Balbif0183a32016-04-18 13:09:11 +0300411 /*
412 * If an abort request was received we need to signal that
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413 * the abort has finished. The proper test for this is
414 * the TIMED_OUT flag, not srb->result == DID_ABORT, because
Matthew Dharm226173e2005-08-25 20:03:50 -0700415 * the timeout might have occurred after the command had
Felipe Balbif0183a32016-04-18 13:09:11 +0300416 * already completed with a different result code.
417 */
Alan Stern7e4d6c32008-05-01 15:35:18 -0400418 if (test_bit(US_FLIDX_TIMED_OUT, &us->dflags)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 complete(&(us->notify));
420
Matthew Dharm226173e2005-08-25 20:03:50 -0700421 /* Allow USB transfers to resume */
Alan Stern7e4d6c32008-05-01 15:35:18 -0400422 clear_bit(US_FLIDX_ABORTING, &us->dflags);
423 clear_bit(US_FLIDX_TIMED_OUT, &us->dflags);
Matthew Dharm226173e2005-08-25 20:03:50 -0700424 }
425
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426 /* finished working on this command */
427 us->srb = NULL;
428 scsi_unlock(host);
429
430 /* unlock the device pointers */
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100431 mutex_unlock(&us->dev_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432 } /* for (;;) */
433
Alan Sterned76cac2007-06-07 17:12:25 -0400434 /* Wait until we are told to stop */
435 for (;;) {
436 set_current_state(TASK_INTERRUPTIBLE);
437 if (kthread_should_stop())
438 break;
439 schedule();
440 }
441 __set_current_state(TASK_RUNNING);
442 return 0;
Jeffrin Josea1631062012-05-17 00:33:36 +0530443}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444
445/***********************************************************************
446 * Device probing and disconnecting
447 ***********************************************************************/
448
449/* Associate our private data with the USB device */
450static int associate_dev(struct us_data *us, struct usb_interface *intf)
451{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 /* Fill in the device-related fields */
453 us->pusb_dev = interface_to_usbdev(intf);
454 us->pusb_intf = intf;
455 us->ifnum = intf->cur_altsetting->desc.bInterfaceNumber;
Joe Perches191648d2013-04-19 11:44:00 -0700456 usb_stor_dbg(us, "Vendor: 0x%04x, Product: 0x%04x, Revision: 0x%04x\n",
457 le16_to_cpu(us->pusb_dev->descriptor.idVendor),
458 le16_to_cpu(us->pusb_dev->descriptor.idProduct),
459 le16_to_cpu(us->pusb_dev->descriptor.bcdDevice));
460 usb_stor_dbg(us, "Interface Subclass: 0x%02x, Protocol: 0x%02x\n",
461 intf->cur_altsetting->desc.bInterfaceSubClass,
462 intf->cur_altsetting->desc.bInterfaceProtocol);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463
464 /* Store our private data in the interface */
465 usb_set_intfdata(intf, us);
466
Alan Stern0ede76f2010-03-05 15:10:17 -0500467 /* Allocate the control/setup and DMA-mapped buffers */
468 us->cr = kmalloc(sizeof(*us->cr), GFP_KERNEL);
Joe Perches191648d2013-04-19 11:44:00 -0700469 if (!us->cr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700471
Daniel Mack997ea582010-04-12 13:17:25 +0200472 us->iobuf = usb_alloc_coherent(us->pusb_dev, US_IOBUF_SIZE,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 GFP_KERNEL, &us->iobuf_dma);
474 if (!us->iobuf) {
Joe Perches191648d2013-04-19 11:44:00 -0700475 usb_stor_dbg(us, "I/O buffer allocation failed\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476 return -ENOMEM;
477 }
478 return 0;
479}
480
Alan Sternc838ea42008-12-15 10:40:06 -0500481/* Works only for digits and letters, but small and fast */
482#define TOLOWER(x) ((x) | 0x20)
483
Alan Sternd4f373e2008-11-10 14:07:45 -0500484/* Adjust device flags based on the "quirks=" module parameter */
Hans de Goeded24d4812013-11-16 12:09:39 +0100485void usb_stor_adjust_quirks(struct usb_device *udev, unsigned long *fflags)
Alan Sternd4f373e2008-11-10 14:07:45 -0500486{
Alan Sternc838ea42008-12-15 10:40:06 -0500487 char *p;
Hans de Goeded24d4812013-11-16 12:09:39 +0100488 u16 vid = le16_to_cpu(udev->descriptor.idVendor);
489 u16 pid = le16_to_cpu(udev->descriptor.idProduct);
Alan Sternc838ea42008-12-15 10:40:06 -0500490 unsigned f = 0;
Alan Sterna91b5932009-12-22 23:16:32 -0500491 unsigned int mask = (US_FL_SANE_SENSE | US_FL_BAD_SENSE |
Hans de Goeded24d4812013-11-16 12:09:39 +0100492 US_FL_FIX_CAPACITY | US_FL_IGNORE_UAS |
Alan Sternc838ea42008-12-15 10:40:06 -0500493 US_FL_CAPACITY_HEURISTICS | US_FL_IGNORE_DEVICE |
Alan Sternd4f373e2008-11-10 14:07:45 -0500494 US_FL_NOT_LOCKABLE | US_FL_MAX_SECTORS_64 |
Alan Sternc838ea42008-12-15 10:40:06 -0500495 US_FL_CAPACITY_OK | US_FL_IGNORE_RESIDUE |
Karl Relton51169012011-05-18 21:42:34 +0100496 US_FL_SINGLE_LUN | US_FL_NO_WP_DETECT |
Alan Stern21c13a42011-06-07 11:35:52 -0400497 US_FL_NO_READ_DISC_INFO | US_FL_NO_READ_CAPACITY_16 |
Hans de Goede59307852014-09-15 16:04:12 +0200498 US_FL_INITIAL_READ10 | US_FL_WRITE_CACHE |
Hans de Goedeee136af2015-04-21 11:20:31 +0200499 US_FL_NO_ATA_1X | US_FL_NO_REPORT_OPCODES |
Oliver Neukum050bc4e2016-09-12 15:19:41 +0200500 US_FL_MAX_SECTORS_240 | US_FL_NO_REPORT_LUNS |
501 US_FL_ALWAYS_SYNC);
Alan Sternd4f373e2008-11-10 14:07:45 -0500502
Alan Sternc838ea42008-12-15 10:40:06 -0500503 p = quirks;
504 while (*p) {
505 /* Each entry consists of VID:PID:flags */
506 if (vid == simple_strtoul(p, &p, 16) &&
507 *p == ':' &&
508 pid == simple_strtoul(p+1, &p, 16) &&
509 *p == ':')
Alan Sternd4f373e2008-11-10 14:07:45 -0500510 break;
Alan Sternc838ea42008-12-15 10:40:06 -0500511
512 /* Move forward to the next entry */
513 while (*p) {
514 if (*p++ == ',')
515 break;
Alan Sternd4f373e2008-11-10 14:07:45 -0500516 }
517 }
Alan Sternc838ea42008-12-15 10:40:06 -0500518 if (!*p) /* No match */
519 return;
520
521 /* Collect the flags */
522 while (*++p && *p != ',') {
523 switch (TOLOWER(*p)) {
524 case 'a':
525 f |= US_FL_SANE_SENSE;
526 break;
Alan Sterna0bb1082009-12-07 16:39:16 -0500527 case 'b':
528 f |= US_FL_BAD_SENSE;
529 break;
Alan Sternc838ea42008-12-15 10:40:06 -0500530 case 'c':
531 f |= US_FL_FIX_CAPACITY;
532 break;
Karl Relton51169012011-05-18 21:42:34 +0100533 case 'd':
534 f |= US_FL_NO_READ_DISC_INFO;
535 break;
536 case 'e':
537 f |= US_FL_NO_READ_CAPACITY_16;
538 break;
Hans de Goede734016b2014-09-16 18:36:52 +0200539 case 'f':
540 f |= US_FL_NO_REPORT_OPCODES;
541 break;
Hans de Goedeee136af2015-04-21 11:20:31 +0200542 case 'g':
543 f |= US_FL_MAX_SECTORS_240;
544 break;
Alan Sternc838ea42008-12-15 10:40:06 -0500545 case 'h':
546 f |= US_FL_CAPACITY_HEURISTICS;
547 break;
548 case 'i':
549 f |= US_FL_IGNORE_DEVICE;
550 break;
Hans de Goede13630742016-04-12 12:27:09 +0200551 case 'j':
552 f |= US_FL_NO_REPORT_LUNS;
553 break;
Alan Sternc838ea42008-12-15 10:40:06 -0500554 case 'l':
555 f |= US_FL_NOT_LOCKABLE;
556 break;
557 case 'm':
558 f |= US_FL_MAX_SECTORS_64;
559 break;
Alan Stern21c13a42011-06-07 11:35:52 -0400560 case 'n':
561 f |= US_FL_INITIAL_READ10;
562 break;
Alan Sternc838ea42008-12-15 10:40:06 -0500563 case 'o':
564 f |= US_FL_CAPACITY_OK;
565 break;
Namjae Jeoneaa05df2012-07-07 23:05:28 -0400566 case 'p':
567 f |= US_FL_WRITE_CACHE;
568 break;
Alan Sternc838ea42008-12-15 10:40:06 -0500569 case 'r':
570 f |= US_FL_IGNORE_RESIDUE;
571 break;
572 case 's':
573 f |= US_FL_SINGLE_LUN;
574 break;
Hans de Goede59307852014-09-15 16:04:12 +0200575 case 't':
576 f |= US_FL_NO_ATA_1X;
577 break;
Hans de Goeded24d4812013-11-16 12:09:39 +0100578 case 'u':
579 f |= US_FL_IGNORE_UAS;
580 break;
Alan Sternc838ea42008-12-15 10:40:06 -0500581 case 'w':
582 f |= US_FL_NO_WP_DETECT;
583 break;
Oliver Neukum050bc4e2016-09-12 15:19:41 +0200584 case 'y':
585 f |= US_FL_ALWAYS_SYNC;
586 break;
Alan Sternc838ea42008-12-15 10:40:06 -0500587 /* Ignore unrecognized flag characters */
588 }
589 }
Hans de Goeded24d4812013-11-16 12:09:39 +0100590 *fflags = (*fflags & ~mask) | f;
Alan Sternd4f373e2008-11-10 14:07:45 -0500591}
Hans de Goeded24d4812013-11-16 12:09:39 +0100592EXPORT_SYMBOL_GPL(usb_stor_adjust_quirks);
Alan Sternd4f373e2008-11-10 14:07:45 -0500593
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594/* Get the unusual_devs entries and the string descriptors */
Alan Sterne6e244b2009-02-12 14:47:44 -0500595static int get_device_info(struct us_data *us, const struct usb_device_id *id,
596 struct us_unusual_dev *unusual_dev)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597{
598 struct usb_device *dev = us->pusb_dev;
599 struct usb_interface_descriptor *idesc =
600 &us->pusb_intf->cur_altsetting->desc;
Felipe Contrerascbd3af52010-05-16 23:31:06 +0300601 struct device *pdev = &us->pusb_intf->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602
603 /* Store the entries */
604 us->unusual_dev = unusual_dev;
Michal Nazarewicz8fa7fd72010-10-07 13:05:21 +0200605 us->subclass = (unusual_dev->useProtocol == USB_SC_DEVICE) ?
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 idesc->bInterfaceSubClass :
607 unusual_dev->useProtocol;
Michal Nazarewicz8fa7fd72010-10-07 13:05:21 +0200608 us->protocol = (unusual_dev->useTransport == USB_PR_DEVICE) ?
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 idesc->bInterfaceProtocol :
610 unusual_dev->useTransport;
Sebastian Andrzej Siewiorf61870e2012-08-28 22:37:13 +0200611 us->fflags = id->driver_info;
Hans de Goeded24d4812013-11-16 12:09:39 +0100612 usb_stor_adjust_quirks(us->pusb_dev, &us->fflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613
Alan Stern7e4d6c32008-05-01 15:35:18 -0400614 if (us->fflags & US_FL_IGNORE_DEVICE) {
Felipe Contrerascbd3af52010-05-16 23:31:06 +0300615 dev_info(pdev, "device ignored\n");
Daniel Drake3c332422006-07-26 13:59:23 +0100616 return -ENODEV;
617 }
618
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 /*
620 * This flag is only needed when we're in high-speed, so let's
621 * disable it if we're in full-speed
622 */
623 if (dev->speed != USB_SPEED_HIGH)
Alan Stern7e4d6c32008-05-01 15:35:18 -0400624 us->fflags &= ~US_FL_GO_SLOW;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625
Felipe Contreras39f2f082010-05-16 23:31:07 +0300626 if (us->fflags)
627 dev_info(pdev, "Quirks match for vid %04x pid %04x: %lx\n",
628 le16_to_cpu(dev->descriptor.idVendor),
629 le16_to_cpu(dev->descriptor.idProduct),
630 us->fflags);
631
Felipe Balbif0183a32016-04-18 13:09:11 +0300632 /*
633 * Log a message if a non-generic unusual_dev entry contains an
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 * unnecessary subclass or protocol override. This may stimulate
635 * reports from users that will help us remove unneeded entries
636 * from the unusual_devs.h table.
637 */
638 if (id->idVendor || id->idProduct) {
Arjan van de Ven4c4c9432005-11-29 09:43:42 +0100639 static const char *msgs[3] = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 "an unneeded SubClass entry",
641 "an unneeded Protocol entry",
642 "unneeded SubClass and Protocol entries"};
643 struct usb_device_descriptor *ddesc = &dev->descriptor;
644 int msg = -1;
645
Michal Nazarewicz8fa7fd72010-10-07 13:05:21 +0200646 if (unusual_dev->useProtocol != USB_SC_DEVICE &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647 us->subclass == idesc->bInterfaceSubClass)
648 msg += 1;
Michal Nazarewicz8fa7fd72010-10-07 13:05:21 +0200649 if (unusual_dev->useTransport != USB_PR_DEVICE &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 us->protocol == idesc->bInterfaceProtocol)
651 msg += 2;
Alan Stern7e4d6c32008-05-01 15:35:18 -0400652 if (msg >= 0 && !(us->fflags & US_FL_NEED_OVERRIDE))
Felipe Contrerascbd3af52010-05-16 23:31:06 +0300653 dev_notice(pdev, "This device "
654 "(%04x,%04x,%04x S %02x P %02x)"
655 " has %s in unusual_devs.h (kernel"
656 " %s)\n"
657 " Please send a copy of this message to "
658 "<linux-usb@vger.kernel.org> and "
659 "<usb-storage@lists.one-eyed-alien.net>\n",
660 le16_to_cpu(ddesc->idVendor),
661 le16_to_cpu(ddesc->idProduct),
662 le16_to_cpu(ddesc->bcdDevice),
663 idesc->bInterfaceSubClass,
664 idesc->bInterfaceProtocol,
665 msgs[msg],
666 utsname()->release);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 }
Daniel Drake3c332422006-07-26 13:59:23 +0100668
669 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670}
671
672/* Get the transport settings */
Alan Sterne6e244b2009-02-12 14:47:44 -0500673static void get_transport(struct us_data *us)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674{
675 switch (us->protocol) {
Michal Nazarewicz8fa7fd72010-10-07 13:05:21 +0200676 case USB_PR_CB:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 us->transport_name = "Control/Bulk";
678 us->transport = usb_stor_CB_transport;
679 us->transport_reset = usb_stor_CB_reset;
680 us->max_lun = 7;
681 break;
682
Michal Nazarewicz8fa7fd72010-10-07 13:05:21 +0200683 case USB_PR_CBI:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 us->transport_name = "Control/Bulk/Interrupt";
Alan Stern64648a92008-11-20 14:20:03 -0500685 us->transport = usb_stor_CB_transport;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 us->transport_reset = usb_stor_CB_reset;
687 us->max_lun = 7;
688 break;
689
Michal Nazarewicz8fa7fd72010-10-07 13:05:21 +0200690 case USB_PR_BULK:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 us->transport_name = "Bulk";
692 us->transport = usb_stor_Bulk_transport;
693 us->transport_reset = usb_stor_Bulk_reset;
694 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696}
697
698/* Get the protocol settings */
Alan Sterne6e244b2009-02-12 14:47:44 -0500699static void get_protocol(struct us_data *us)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700{
701 switch (us->subclass) {
Michal Nazarewicz8fa7fd72010-10-07 13:05:21 +0200702 case USB_SC_RBC:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703 us->protocol_name = "Reduced Block Commands (RBC)";
704 us->proto_handler = usb_stor_transparent_scsi_command;
705 break;
706
Michal Nazarewicz8fa7fd72010-10-07 13:05:21 +0200707 case USB_SC_8020:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708 us->protocol_name = "8020i";
Alan Stern3dae5342008-11-20 14:22:18 -0500709 us->proto_handler = usb_stor_pad12_command;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700710 us->max_lun = 0;
711 break;
712
Michal Nazarewicz8fa7fd72010-10-07 13:05:21 +0200713 case USB_SC_QIC:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714 us->protocol_name = "QIC-157";
Alan Stern3dae5342008-11-20 14:22:18 -0500715 us->proto_handler = usb_stor_pad12_command;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716 us->max_lun = 0;
717 break;
718
Michal Nazarewicz8fa7fd72010-10-07 13:05:21 +0200719 case USB_SC_8070:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700720 us->protocol_name = "8070i";
Alan Stern3dae5342008-11-20 14:22:18 -0500721 us->proto_handler = usb_stor_pad12_command;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 us->max_lun = 0;
723 break;
724
Michal Nazarewicz8fa7fd72010-10-07 13:05:21 +0200725 case USB_SC_SCSI:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 us->protocol_name = "Transparent SCSI";
727 us->proto_handler = usb_stor_transparent_scsi_command;
728 break;
729
Michal Nazarewicz8fa7fd72010-10-07 13:05:21 +0200730 case USB_SC_UFI:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 us->protocol_name = "Uniform Floppy Interface (UFI)";
732 us->proto_handler = usb_stor_ufi_command;
733 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735}
736
737/* Get the pipe settings */
738static int get_pipes(struct us_data *us)
739{
Johan Hovold80070a42017-03-17 11:35:49 +0100740 struct usb_host_interface *alt = us->pusb_intf->cur_altsetting;
741 struct usb_endpoint_descriptor *ep_in;
742 struct usb_endpoint_descriptor *ep_out;
743 struct usb_endpoint_descriptor *ep_int;
744 int res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745
746 /*
Alan Stern1096f782007-01-22 11:58:34 -0500747 * Find the first endpoint of each type we need.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 * We are expecting a minimum of 2 endpoints - in and out (bulk).
Alan Stern1096f782007-01-22 11:58:34 -0500749 * An optional interrupt-in is OK (necessary for CBI protocol).
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 * We will ignore any others.
751 */
Johan Hovold80070a42017-03-17 11:35:49 +0100752 res = usb_find_common_endpoints(alt, &ep_in, &ep_out, NULL, NULL);
753 if (res) {
754 usb_stor_dbg(us, "bulk endpoints not found\n");
755 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 }
757
Johan Hovold80070a42017-03-17 11:35:49 +0100758 res = usb_find_int_in_endpoint(alt, &ep_int);
759 if (res && us->protocol == USB_PR_CBI) {
760 usb_stor_dbg(us, "interrupt endpoint not found\n");
761 return res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762 }
763
764 /* Calculate and store the pipe values */
765 us->send_ctrl_pipe = usb_sndctrlpipe(us->pusb_dev, 0);
766 us->recv_ctrl_pipe = usb_rcvctrlpipe(us->pusb_dev, 0);
767 us->send_bulk_pipe = usb_sndbulkpipe(us->pusb_dev,
Julia Lawall2e0fe702008-12-29 11:22:14 +0100768 usb_endpoint_num(ep_out));
Jeffrin Josea1631062012-05-17 00:33:36 +0530769 us->recv_bulk_pipe = usb_rcvbulkpipe(us->pusb_dev,
Julia Lawall2e0fe702008-12-29 11:22:14 +0100770 usb_endpoint_num(ep_in));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771 if (ep_int) {
772 us->recv_intr_pipe = usb_rcvintpipe(us->pusb_dev,
Julia Lawall2e0fe702008-12-29 11:22:14 +0100773 usb_endpoint_num(ep_int));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 us->ep_bInterval = ep_int->bInterval;
775 }
776 return 0;
777}
778
779/* Initialize all the dynamic resources we need */
780static int usb_stor_acquire_resources(struct us_data *us)
781{
782 int p;
Alan Stern3f13e662005-10-23 19:43:36 -0700783 struct task_struct *th;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784
785 us->current_urb = usb_alloc_urb(0, GFP_KERNEL);
Wolfram Sang792f94f2016-08-11 23:14:46 +0200786 if (!us->current_urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788
Felipe Balbif0183a32016-04-18 13:09:11 +0300789 /*
790 * Just before we start our control thread, initialize
791 * the device if it needs initialization
792 */
Alan Sternb876aef2005-10-23 19:38:56 -0700793 if (us->unusual_dev->initFunction) {
794 p = us->unusual_dev->initFunction(us);
795 if (p)
796 return p;
797 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798
799 /* Start up our control thread */
Alan Sterned76cac2007-06-07 17:12:25 -0400800 th = kthread_run(usb_stor_control_thread, us, "usb-storage");
Alan Stern3f13e662005-10-23 19:43:36 -0700801 if (IS_ERR(th)) {
Felipe Contrerascbd3af52010-05-16 23:31:06 +0300802 dev_warn(&us->pusb_intf->dev,
803 "Unable to start control thread\n");
Alan Stern3f13e662005-10-23 19:43:36 -0700804 return PTR_ERR(th);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805 }
Alan Sterned76cac2007-06-07 17:12:25 -0400806 us->ctl_thread = th;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807
808 return 0;
809}
810
811/* Release all our dynamic resources */
812static void usb_stor_release_resources(struct us_data *us)
813{
Felipe Balbif0183a32016-04-18 13:09:11 +0300814 /*
815 * Tell the control thread to exit. The SCSI host must
Alan Stern543f7812008-05-08 11:55:59 -0400816 * already have been removed and the DISCONNECTING flag set
817 * so that we won't accept any more commands.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700818 */
Joe Perches191648d2013-04-19 11:44:00 -0700819 usb_stor_dbg(us, "-- sending exit command to thread\n");
Alan Stern7119e3c2008-05-01 15:36:13 -0400820 complete(&us->cmnd_ready);
Alan Sterned76cac2007-06-07 17:12:25 -0400821 if (us->ctl_thread)
822 kthread_stop(us->ctl_thread);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823
824 /* Call the destructor routine, if it exists */
825 if (us->extra_destructor) {
Joe Perches191648d2013-04-19 11:44:00 -0700826 usb_stor_dbg(us, "-- calling extra_destructor()\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827 us->extra_destructor(us->extra);
828 }
829
830 /* Free the extra data and the URB */
831 kfree(us->extra);
832 usb_free_urb(us->current_urb);
833}
834
835/* Dissociate from the USB device */
836static void dissociate_dev(struct us_data *us)
837{
Alan Stern0ede76f2010-03-05 15:10:17 -0500838 /* Free the buffers */
839 kfree(us->cr);
Daniel Mack997ea582010-04-12 13:17:25 +0200840 usb_free_coherent(us->pusb_dev, US_IOBUF_SIZE, us->iobuf, us->iobuf_dma);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841
842 /* Remove our private data from the interface */
843 usb_set_intfdata(us->pusb_intf, NULL);
844}
845
Felipe Balbif0183a32016-04-18 13:09:11 +0300846/*
847 * First stage of disconnect processing: stop SCSI scanning,
Alan Stern543f7812008-05-08 11:55:59 -0400848 * remove the host, and stop accepting new commands
849 */
Matthew Dharm77f46322005-07-28 14:44:29 -0700850static void quiesce_and_remove_host(struct us_data *us)
851{
Alan Sterneecd11e2006-06-19 14:50:15 -0400852 struct Scsi_Host *host = us_to_host(us);
853
Alan Stern543f7812008-05-08 11:55:59 -0400854 /* If the device is really gone, cut short reset delays */
Alan Sternbb94a402012-02-21 13:16:32 -0500855 if (us->pusb_dev->state == USB_STATE_NOTATTACHED) {
Alan Stern543f7812008-05-08 11:55:59 -0400856 set_bit(US_FLIDX_DISCONNECTING, &us->dflags);
Alan Sternbb94a402012-02-21 13:16:32 -0500857 wake_up(&us->delay_wait);
858 }
Alan Stern543f7812008-05-08 11:55:59 -0400859
Felipe Balbif0183a32016-04-18 13:09:11 +0300860 /*
861 * Prevent SCSI scanning (if it hasn't started yet)
Alan Sternbb94a402012-02-21 13:16:32 -0500862 * or wait for the SCSI-scanning routine to stop.
Alan Stern543f7812008-05-08 11:55:59 -0400863 */
Alan Sternbb94a402012-02-21 13:16:32 -0500864 cancel_delayed_work_sync(&us->scan_dwork);
865
866 /* Balance autopm calls if scanning was cancelled */
867 if (test_bit(US_FLIDX_SCAN_PENDING, &us->dflags))
868 usb_autopm_put_interface_no_suspend(us->pusb_intf);
Alan Stern543f7812008-05-08 11:55:59 -0400869
Felipe Balbif0183a32016-04-18 13:09:11 +0300870 /*
871 * Removing the host will perform an orderly shutdown: caches
Alan Stern543f7812008-05-08 11:55:59 -0400872 * synchronized, disks spun down, etc.
873 */
874 scsi_remove_host(host);
875
Felipe Balbif0183a32016-04-18 13:09:11 +0300876 /*
877 * Prevent any new commands from being accepted and cut short
Alan Stern543f7812008-05-08 11:55:59 -0400878 * reset delays.
879 */
Alan Sterneecd11e2006-06-19 14:50:15 -0400880 scsi_lock(host);
Alan Stern7e4d6c32008-05-01 15:35:18 -0400881 set_bit(US_FLIDX_DISCONNECTING, &us->dflags);
Alan Sterneecd11e2006-06-19 14:50:15 -0400882 scsi_unlock(host);
Matthew Dharm77f46322005-07-28 14:44:29 -0700883 wake_up(&us->delay_wait);
Matthew Dharm77f46322005-07-28 14:44:29 -0700884}
885
886/* Second stage of disconnect processing: deallocate all resources */
887static void release_everything(struct us_data *us)
888{
889 usb_stor_release_resources(us);
890 dissociate_dev(us);
891
Felipe Balbif0183a32016-04-18 13:09:11 +0300892 /*
893 * Drop our reference to the host; the SCSI core will free it
894 * (and "us" along with it) when the refcount becomes 0.
895 */
Matthew Dharm77f46322005-07-28 14:44:29 -0700896 scsi_host_put(us_to_host(us));
897}
898
Alan Sternbb94a402012-02-21 13:16:32 -0500899/* Delayed-work routine to carry out SCSI-device scanning */
900static void usb_stor_scan_dwork(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700901{
Alan Sternbb94a402012-02-21 13:16:32 -0500902 struct us_data *us = container_of(work, struct us_data,
903 scan_dwork.work);
Felipe Contrerascbd3af52010-05-16 23:31:06 +0300904 struct device *dev = &us->pusb_intf->dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905
Alan Sternbb94a402012-02-21 13:16:32 -0500906 dev_dbg(dev, "starting scan\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907
Alan Sternbb94a402012-02-21 13:16:32 -0500908 /* For bulk-only devices, determine the max LUN value */
Mark Knibbs646a3842014-11-08 21:39:55 +0000909 if (us->protocol == USB_PR_BULK &&
910 !(us->fflags & US_FL_SINGLE_LUN) &&
911 !(us->fflags & US_FL_SCM_MULT_TARG)) {
Alan Sternbb94a402012-02-21 13:16:32 -0500912 mutex_lock(&us->dev_mutex);
913 us->max_lun = usb_stor_Bulk_max_lun(us);
Oliver Neukumec371322015-02-10 09:27:59 +0100914 /*
915 * Allow proper scanning of devices that present more than 8 LUNs
Felipe Balbif0183a32016-04-18 13:09:11 +0300916 * While not affecting other devices that may need the previous
917 * behavior
Oliver Neukumec371322015-02-10 09:27:59 +0100918 */
919 if (us->max_lun >= 8)
920 us_to_host(us)->max_lun = us->max_lun+1;
Alan Sternbb94a402012-02-21 13:16:32 -0500921 mutex_unlock(&us->dev_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922 }
Alan Sternbb94a402012-02-21 13:16:32 -0500923 scsi_scan_host(us_to_host(us));
924 dev_dbg(dev, "scan complete\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925
Alan Sternbb94a402012-02-21 13:16:32 -0500926 /* Should we unbind if no devices were detected? */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700927
Alan Sternf2839252010-07-28 17:12:39 -0400928 usb_autopm_put_interface(us->pusb_intf);
Alan Sternbb94a402012-02-21 13:16:32 -0500929 clear_bit(US_FLIDX_SCAN_PENDING, &us->dflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930}
931
David Vrabel4c1bd3d2009-08-24 14:44:30 +0100932static unsigned int usb_stor_sg_tablesize(struct usb_interface *intf)
933{
934 struct usb_device *usb_dev = interface_to_usbdev(intf);
935
936 if (usb_dev->bus->sg_tablesize) {
937 return usb_dev->bus->sg_tablesize;
938 }
939 return SG_ALL;
940}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941
Alan Sterne6e244b2009-02-12 14:47:44 -0500942/* First part of general USB mass-storage probing */
943int usb_stor_probe1(struct us_data **pus,
944 struct usb_interface *intf,
945 const struct usb_device_id *id,
Akinobu Mitaaa519be2015-05-06 18:24:21 +0900946 struct us_unusual_dev *unusual_dev,
947 struct scsi_host_template *sht)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948{
949 struct Scsi_Host *host;
950 struct us_data *us;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951 int result;
Pete Zaitceva00828e2005-10-22 20:15:09 -0700952
Joe Perches191648d2013-04-19 11:44:00 -0700953 dev_info(&intf->dev, "USB Mass Storage device detected\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954
955 /*
956 * Ask the SCSI layer to allocate a host structure, with extra
957 * space at the end for our private us_data structure.
958 */
Akinobu Mitaaa519be2015-05-06 18:24:21 +0900959 host = scsi_host_alloc(sht, sizeof(*us));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 if (!host) {
Joe Perches191648d2013-04-19 11:44:00 -0700961 dev_warn(&intf->dev, "Unable to allocate the scsi host\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 return -ENOMEM;
963 }
964
Richard Sharpe17f060222007-10-10 10:56:28 -0700965 /*
966 * Allow 16-byte CDBs and thus > 2TB
967 */
968 host->max_cmd_len = 16;
David Vrabel4c1bd3d2009-08-24 14:44:30 +0100969 host->sg_tablesize = usb_stor_sg_tablesize(intf);
Alan Sterne6e244b2009-02-12 14:47:44 -0500970 *pus = us = host_to_us(host);
Arjan van de Ven4186ecf2006-01-11 15:55:29 +0100971 mutex_init(&(us->dev_mutex));
Ming Leic825bab2012-03-19 15:20:57 +0800972 us_set_lock_class(&us->dev_mutex, intf);
Alan Stern7119e3c2008-05-01 15:36:13 -0400973 init_completion(&us->cmnd_ready);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974 init_completion(&(us->notify));
975 init_waitqueue_head(&us->delay_wait);
Alan Sternbb94a402012-02-21 13:16:32 -0500976 INIT_DELAYED_WORK(&us->scan_dwork, usb_stor_scan_dwork);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700977
978 /* Associate the us_data structure with the USB device */
979 result = associate_dev(us, intf);
980 if (result)
981 goto BadDevice;
982
Alan Sterne6e244b2009-02-12 14:47:44 -0500983 /* Get the unusual_devs entries and the descriptors */
984 result = get_device_info(us, id, unusual_dev);
Daniel Drake3c332422006-07-26 13:59:23 +0100985 if (result)
986 goto BadDevice;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987
Alan Sterne6e244b2009-02-12 14:47:44 -0500988 /* Get standard transport and protocol settings */
989 get_transport(us);
990 get_protocol(us);
991
Felipe Balbif0183a32016-04-18 13:09:11 +0300992 /*
993 * Give the caller a chance to fill in specialized transport
Alan Sterne6e244b2009-02-12 14:47:44 -0500994 * or protocol settings.
995 */
996 return 0;
997
998BadDevice:
Joe Perches191648d2013-04-19 11:44:00 -0700999 usb_stor_dbg(us, "storage_probe() failed\n");
Alan Sterne6e244b2009-02-12 14:47:44 -05001000 release_everything(us);
1001 return result;
1002}
1003EXPORT_SYMBOL_GPL(usb_stor_probe1);
1004
1005/* Second part of general USB mass-storage probing */
1006int usb_stor_probe2(struct us_data *us)
1007{
Alan Sterne6e244b2009-02-12 14:47:44 -05001008 int result;
Felipe Contrerascbd3af52010-05-16 23:31:06 +03001009 struct device *dev = &us->pusb_intf->dev;
Alan Sterne6e244b2009-02-12 14:47:44 -05001010
1011 /* Make sure the transport and protocol have both been set */
1012 if (!us->transport || !us->proto_handler) {
1013 result = -ENXIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014 goto BadDevice;
Alan Sterne6e244b2009-02-12 14:47:44 -05001015 }
Joe Perches191648d2013-04-19 11:44:00 -07001016 usb_stor_dbg(us, "Transport: %s\n", us->transport_name);
1017 usb_stor_dbg(us, "Protocol: %s\n", us->protocol_name);
Alan Sterne6e244b2009-02-12 14:47:44 -05001018
Mark Knibbs646a3842014-11-08 21:39:55 +00001019 if (us->fflags & US_FL_SCM_MULT_TARG) {
1020 /*
1021 * SCM eUSCSI bridge devices can have different numbers
1022 * of LUNs on different targets; allow all to be probed.
1023 */
1024 us->max_lun = 7;
1025 /* The eUSCSI itself has ID 7, so avoid scanning that */
1026 us_to_host(us)->this_id = 7;
1027 /* max_id is 8 initially, so no need to set it here */
1028 } else {
1029 /* In the normal case there is only a single target */
1030 us_to_host(us)->max_id = 1;
1031 /*
1032 * Like Windows, we won't store the LUN bits in CDB[1] for
1033 * SCSI-2 devices using the Bulk-Only transport (even though
1034 * this violates the SCSI spec).
1035 */
1036 if (us->transport == usb_stor_Bulk_transport)
1037 us_to_host(us)->no_scsi2_lun_in_cdb = 1;
1038 }
1039
Alan Sterne6e244b2009-02-12 14:47:44 -05001040 /* fix for single-lun devices */
1041 if (us->fflags & US_FL_SINGLE_LUN)
1042 us->max_lun = 0;
1043
1044 /* Find the endpoints and calculate pipe values */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001045 result = get_pipes(us);
1046 if (result)
1047 goto BadDevice;
1048
Alan Stern21c13a42011-06-07 11:35:52 -04001049 /*
1050 * If the device returns invalid data for the first READ(10)
1051 * command, indicate the command should be retried.
1052 */
1053 if (us->fflags & US_FL_INITIAL_READ10)
1054 set_bit(US_FLIDX_REDO_READ10, &us->dflags);
1055
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056 /* Acquire all the other resources and add the host */
1057 result = usb_stor_acquire_resources(us);
1058 if (result)
1059 goto BadDevice;
Heiner Kallweita0947602016-08-03 21:46:47 +02001060 usb_autopm_get_interface_no_resume(us->pusb_intf);
Matthew Wilcox00fa43e2009-09-24 16:19:11 -06001061 snprintf(us->scsi_name, sizeof(us->scsi_name), "usb-storage %s",
1062 dev_name(&us->pusb_intf->dev));
Felipe Contrerascbd3af52010-05-16 23:31:06 +03001063 result = scsi_add_host(us_to_host(us), dev);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064 if (result) {
Felipe Contrerascbd3af52010-05-16 23:31:06 +03001065 dev_warn(dev,
1066 "Unable to add the scsi host\n");
Heiner Kallweita0947602016-08-03 21:46:47 +02001067 goto HostAddErr;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068 }
1069
Alan Sternbb94a402012-02-21 13:16:32 -05001070 /* Submit the delayed_work for SCSI-device scanning */
Alan Sternbb94a402012-02-21 13:16:32 -05001071 set_bit(US_FLIDX_SCAN_PENDING, &us->dflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072
Alan Sternbb94a402012-02-21 13:16:32 -05001073 if (delay_use > 0)
1074 dev_dbg(dev, "waiting for device to settle before scanning\n");
1075 queue_delayed_work(system_freezable_wq, &us->scan_dwork,
1076 delay_use * HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001077 return 0;
1078
1079 /* We come here if there are any problems */
Heiner Kallweita0947602016-08-03 21:46:47 +02001080HostAddErr:
1081 usb_autopm_put_interface_no_suspend(us->pusb_intf);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082BadDevice:
Joe Perches191648d2013-04-19 11:44:00 -07001083 usb_stor_dbg(us, "storage_probe() failed\n");
Matthew Dharm77f46322005-07-28 14:44:29 -07001084 release_everything(us);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001085 return result;
1086}
Alan Sterne6e244b2009-02-12 14:47:44 -05001087EXPORT_SYMBOL_GPL(usb_stor_probe2);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088
Alan Sterne6e244b2009-02-12 14:47:44 -05001089/* Handle a USB mass-storage disconnect */
1090void usb_stor_disconnect(struct usb_interface *intf)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091{
1092 struct us_data *us = usb_get_intfdata(intf);
1093
Matthew Dharm77f46322005-07-28 14:44:29 -07001094 quiesce_and_remove_host(us);
1095 release_everything(us);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096}
Alan Sterne6e244b2009-02-12 14:47:44 -05001097EXPORT_SYMBOL_GPL(usb_stor_disconnect);
1098
Akinobu Mitaaa519be2015-05-06 18:24:21 +09001099static struct scsi_host_template usb_stor_host_template;
1100
Alan Sterne6e244b2009-02-12 14:47:44 -05001101/* The main probe routine for standard devices */
1102static int storage_probe(struct usb_interface *intf,
1103 const struct usb_device_id *id)
1104{
Huajun Lifd7ff362012-01-14 10:16:40 +08001105 struct us_unusual_dev *unusual_dev;
Alan Sterne6e244b2009-02-12 14:47:44 -05001106 struct us_data *us;
1107 int result;
Huajun Lifd7ff362012-01-14 10:16:40 +08001108 int size;
Alan Sterne6e244b2009-02-12 14:47:44 -05001109
Hans de Goede5bfd5b52013-10-21 09:40:48 +01001110 /* If uas is enabled and this device can do uas then ignore it. */
1111#if IS_ENABLED(CONFIG_USB_UAS)
Hans de Goedea5011d42015-04-21 11:20:30 +02001112 if (uas_use_uas_driver(intf, id, NULL))
Hans de Goede5bfd5b52013-10-21 09:40:48 +01001113 return -ENXIO;
1114#endif
1115
Alan Sterne6e244b2009-02-12 14:47:44 -05001116 /*
Alan Sterne6e244b2009-02-12 14:47:44 -05001117 * If the device isn't standard (is handled by a subdriver
1118 * module) then don't accept it.
1119 */
Sebastian Andrzej Siewiorf61870e2012-08-28 22:37:13 +02001120 if (usb_usual_ignore_device(intf))
Alan Sterne6e244b2009-02-12 14:47:44 -05001121 return -ENXIO;
1122
1123 /*
1124 * Call the general probe procedures.
1125 *
1126 * The unusual_dev_list array is parallel to the usb_storage_usb_ids
1127 * table, so we use the index of the id entry to find the
1128 * corresponding unusual_devs entry.
1129 */
Huajun Lifd7ff362012-01-14 10:16:40 +08001130
1131 size = ARRAY_SIZE(us_unusual_dev_list);
1132 if (id >= usb_storage_usb_ids && id < usb_storage_usb_ids + size) {
1133 unusual_dev = (id - usb_storage_usb_ids) + us_unusual_dev_list;
1134 } else {
1135 unusual_dev = &for_dynamic_ids;
1136
Joe Perches191648d2013-04-19 11:44:00 -07001137 dev_dbg(&intf->dev, "Use Bulk-Only transport with the Transparent SCSI protocol for dynamic id: 0x%04x 0x%04x\n",
Huajun Lifd7ff362012-01-14 10:16:40 +08001138 id->idVendor, id->idProduct);
1139 }
1140
Akinobu Mitaaa519be2015-05-06 18:24:21 +09001141 result = usb_stor_probe1(&us, intf, id, unusual_dev,
1142 &usb_stor_host_template);
Alan Sterne6e244b2009-02-12 14:47:44 -05001143 if (result)
1144 return result;
1145
1146 /* No special transport or protocol settings in the main module */
1147
1148 result = usb_stor_probe2(us);
1149 return result;
1150}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151
Alan Sternce2596d2005-10-23 19:41:39 -07001152static struct usb_driver usb_storage_driver = {
Akinobu Mitaaa519be2015-05-06 18:24:21 +09001153 .name = DRV_NAME,
Alan Sternce2596d2005-10-23 19:41:39 -07001154 .probe = storage_probe,
Alan Sterne6e244b2009-02-12 14:47:44 -05001155 .disconnect = usb_stor_disconnect,
1156 .suspend = usb_stor_suspend,
1157 .resume = usb_stor_resume,
1158 .reset_resume = usb_stor_reset_resume,
1159 .pre_reset = usb_stor_pre_reset,
1160 .post_reset = usb_stor_post_reset,
1161 .id_table = usb_storage_usb_ids,
Alan Sternf2839252010-07-28 17:12:39 -04001162 .supports_autosuspend = 1,
Alan Stern543f7812008-05-08 11:55:59 -04001163 .soft_unbind = 1,
Alan Sternce2596d2005-10-23 19:41:39 -07001164};
1165
Akinobu Mitaaa519be2015-05-06 18:24:21 +09001166module_usb_stor_driver(usb_storage_driver, usb_stor_host_template, DRV_NAME);