]>
Commit | Line | Data |
---|---|---|
f0183a33 FB |
1 | /* |
2 | * Driver for USB Mass Storage compliant devices | |
1da177e4 LT |
3 | * |
4 | * 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) | |
e6e244b6 | 9 | * (c) 2003-2009 Alan Stern (stern@rowland.harvard.edu) |
1da177e4 LT |
10 | * |
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 | ||
9eb66f71 MW |
49 | #ifdef CONFIG_USB_STORAGE_DEBUG |
50 | #define DEBUG | |
51 | #endif | |
52 | ||
1da177e4 LT |
53 | #include <linux/sched.h> |
54 | #include <linux/errno.h> | |
1da177e4 | 55 | #include <linux/module.h> |
1da177e4 | 56 | #include <linux/slab.h> |
3f13e66e | 57 | #include <linux/kthread.h> |
4186ecf8 | 58 | #include <linux/mutex.h> |
00f8b0c1 | 59 | #include <linux/utsname.h> |
1da177e4 LT |
60 | |
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 | ||
32fe5e39 | 72 | #include "sierra_ms.h" |
281b064f | 73 | #include "option_ms.h" |
1da177e4 | 74 | |
5bfd5b5d HG |
75 | #if IS_ENABLED(CONFIG_USB_UAS) |
76 | #include "uas-detect.h" | |
77 | #endif | |
78 | ||
aa519be3 AM |
79 | #define DRV_NAME "usb-storage" |
80 | ||
1da177e4 LT |
81 | /* Some informational data */ |
82 | MODULE_AUTHOR("Matthew Dharm <mdharm-usb@one-eyed-alien.net>"); | |
83 | MODULE_DESCRIPTION("USB Mass Storage driver for Linux"); | |
84 | MODULE_LICENSE("GPL"); | |
85 | ||
a4a47bc0 | 86 | static unsigned int delay_use = 1; |
1da177e4 LT |
87 | module_param(delay_use, uint, S_IRUGO | S_IWUSR); |
88 | MODULE_PARM_DESC(delay_use, "seconds to delay before using a new device"); | |
89 | ||
c838ea46 AS |
90 | static char quirks[128]; |
91 | module_param_string(quirks, quirks, sizeof(quirks), S_IRUGO | S_IWUSR); | |
d4f373e5 AS |
92 | MODULE_PARM_DESC(quirks, "supplemental list of device IDs and their quirks"); |
93 | ||
1da177e4 | 94 | |
a00828e9 PZ |
95 | /* |
96 | * The entries in this table correspond, line for line, | |
e6e244b6 | 97 | * with the entries in usb_storage_usb_ids[], defined in usual-tables.c. |
1da177e4 | 98 | */ |
1da177e4 | 99 | |
f0183a33 FB |
100 | /* |
101 | *The vendor name should be kept at eight characters or less, and | |
1da177e4 LT |
102 | * 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 | |
a6cd244b | 104 | * normally generated by a device through the INQUIRY response will be |
1da177e4 LT |
105 | * 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 | ||
1da177e4 LT |
110 | #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, \ | |
a00828e9 PZ |
119 | } |
120 | ||
25ff1c31 AS |
121 | #define COMPLIANT_DEV UNUSUAL_DEV |
122 | ||
f61870ee | 123 | #define USUAL_DEV(use_protocol, use_transport) \ |
a00828e9 PZ |
124 | { \ |
125 | .useProtocol = use_protocol, \ | |
126 | .useTransport = use_transport, \ | |
1da177e4 LT |
127 | } |
128 | ||
07c7be3d | 129 | #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 | ||
1da177e4 | 140 | static struct us_unusual_dev us_unusual_dev_list[] = { |
a1631062 | 141 | # include "unusual_devs.h" |
e6e244b6 | 142 | { } /* Terminating entry */ |
1da177e4 LT |
143 | }; |
144 | ||
fd7ff36d | 145 | static struct us_unusual_dev for_dynamic_ids = |
f61870ee | 146 | USUAL_DEV(USB_SC_SCSI, USB_PR_BULK); |
fd7ff36d | 147 | |
e6e244b6 AS |
148 | #undef UNUSUAL_DEV |
149 | #undef COMPLIANT_DEV | |
150 | #undef USUAL_DEV | |
07c7be3d | 151 | #undef UNUSUAL_VENDOR_INTF |
e6e244b6 | 152 | |
c825bab0 ML |
153 | #ifdef CONFIG_LOCKDEP |
154 | ||
155 | static struct lock_class_key us_interface_key[USB_MAXINTERFACES]; | |
156 | ||
157 | static 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 | ||
176 | static void us_set_lock_class(struct mutex *mutex, | |
177 | struct usb_interface *intf) | |
178 | { | |
179 | } | |
180 | ||
181 | #endif | |
ce2596df AS |
182 | |
183 | #ifdef CONFIG_PM /* Minimal support for suspend and resume */ | |
184 | ||
e6e244b6 | 185 | int usb_stor_suspend(struct usb_interface *iface, pm_message_t message) |
ce2596df AS |
186 | { |
187 | struct us_data *us = usb_get_intfdata(iface); | |
188 | ||
189 | /* Wait until no command is running */ | |
4186ecf8 | 190 | mutex_lock(&us->dev_mutex); |
ce2596df | 191 | |
7931e1c6 MD |
192 | if (us->suspend_resume_hook) |
193 | (us->suspend_resume_hook)(us, US_SUSPEND); | |
ce2596df | 194 | |
f0183a33 FB |
195 | /* |
196 | * When runtime PM is working, we'll set a flag to indicate | |
197 | * whether we should autoresume when a SCSI request arrives. | |
198 | */ | |
d526875d | 199 | |
4186ecf8 | 200 | mutex_unlock(&us->dev_mutex); |
ce2596df AS |
201 | return 0; |
202 | } | |
e6e244b6 | 203 | EXPORT_SYMBOL_GPL(usb_stor_suspend); |
ce2596df | 204 | |
e6e244b6 | 205 | int usb_stor_resume(struct usb_interface *iface) |
ce2596df AS |
206 | { |
207 | struct us_data *us = usb_get_intfdata(iface); | |
208 | ||
d526875d | 209 | mutex_lock(&us->dev_mutex); |
8dfe4b14 | 210 | |
7931e1c6 MD |
211 | if (us->suspend_resume_hook) |
212 | (us->suspend_resume_hook)(us, US_RESUME); | |
ce2596df | 213 | |
d526875d | 214 | mutex_unlock(&us->dev_mutex); |
ce2596df AS |
215 | return 0; |
216 | } | |
e6e244b6 | 217 | EXPORT_SYMBOL_GPL(usb_stor_resume); |
ce2596df | 218 | |
e6e244b6 | 219 | int usb_stor_reset_resume(struct usb_interface *iface) |
f07600cf AS |
220 | { |
221 | struct us_data *us = usb_get_intfdata(iface); | |
222 | ||
f07600cf AS |
223 | /* Report the reset to the SCSI core */ |
224 | usb_stor_report_bus_reset(us); | |
225 | ||
f0183a33 FB |
226 | /* |
227 | * FIXME: Notify the subdrivers that they need to reinitialize | |
228 | * the device | |
229 | */ | |
f07600cf AS |
230 | return 0; |
231 | } | |
e6e244b6 | 232 | EXPORT_SYMBOL_GPL(usb_stor_reset_resume); |
f07600cf | 233 | |
ce2596df | 234 | #endif /* CONFIG_PM */ |
1da177e4 | 235 | |
47104b0d AS |
236 | /* |
237 | * 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 | ||
e6e244b6 | 241 | int usb_stor_pre_reset(struct usb_interface *iface) |
47104b0d AS |
242 | { |
243 | struct us_data *us = usb_get_intfdata(iface); | |
244 | ||
47104b0d AS |
245 | /* Make sure no command runs during the reset */ |
246 | mutex_lock(&us->dev_mutex); | |
f07600cf | 247 | return 0; |
47104b0d | 248 | } |
e6e244b6 | 249 | EXPORT_SYMBOL_GPL(usb_stor_pre_reset); |
47104b0d | 250 | |
e6e244b6 | 251 | int usb_stor_post_reset(struct usb_interface *iface) |
47104b0d AS |
252 | { |
253 | struct us_data *us = usb_get_intfdata(iface); | |
254 | ||
47104b0d | 255 | /* Report the reset to the SCSI core */ |
47104b0d | 256 | usb_stor_report_bus_reset(us); |
47104b0d | 257 | |
f0183a33 FB |
258 | /* |
259 | * FIXME: Notify the subdrivers that they need to reinitialize | |
260 | * the device | |
261 | */ | |
0458d5b4 | 262 | |
f07600cf AS |
263 | mutex_unlock(&us->dev_mutex); |
264 | return 0; | |
47104b0d | 265 | } |
e6e244b6 | 266 | EXPORT_SYMBOL_GPL(usb_stor_post_reset); |
47104b0d | 267 | |
1da177e4 LT |
268 | /* |
269 | * 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 | ||
277 | void fill_inquiry_response(struct us_data *us, unsigned char *data, | |
278 | unsigned int data_len) | |
279 | { | |
a1631062 | 280 | if (data_len < 36) /* You lose. */ |
1da177e4 LT |
281 | return; |
282 | ||
f3f6faa9 | 283 | memset(data+8, ' ', 28); |
f0183a33 FB |
284 | 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 | */ | |
1da177e4 LT |
295 | } else { |
296 | u16 bcdDevice = le16_to_cpu(us->pusb_dev->descriptor.bcdDevice); | |
f3f6faa9 AS |
297 | 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 | ||
1da177e4 LT |
304 | 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 | } | |
e6e244b6 | 312 | EXPORT_SYMBOL_GPL(fill_inquiry_response); |
1da177e4 LT |
313 | |
314 | static 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); | |
8b52291a | 318 | struct scsi_cmnd *srb; |
1da177e4 | 319 | |
db2c8624 | 320 | for (;;) { |
191648d0 | 321 | usb_stor_dbg(us, "*** thread sleeping\n"); |
7119e3c3 | 322 | if (wait_for_completion_interruptible(&us->cmnd_ready)) |
1da177e4 | 323 | break; |
7119e3c3 | 324 | |
191648d0 | 325 | usb_stor_dbg(us, "*** thread awakened\n"); |
1da177e4 LT |
326 | |
327 | /* lock the device pointers */ | |
4186ecf8 | 328 | mutex_lock(&(us->dev_mutex)); |
1da177e4 | 329 | |
543f7810 AS |
330 | /* lock access to the state */ |
331 | scsi_lock(host); | |
332 | ||
333 | /* When we are called with no command pending, we're done */ | |
8b52291a | 334 | srb = us->srb; |
543f7810 AS |
335 | if (us->srb == NULL) { |
336 | scsi_unlock(host); | |
4186ecf8 | 337 | mutex_unlock(&us->dev_mutex); |
191648d0 | 338 | usb_stor_dbg(us, "-- exiting\n"); |
1da177e4 LT |
339 | break; |
340 | } | |
341 | ||
1da177e4 | 342 | /* has the command timed out *already* ? */ |
7e4d6c38 | 343 | if (test_bit(US_FLIDX_TIMED_OUT, &us->dflags)) { |
1da177e4 LT |
344 | us->srb->result = DID_ABORT << 16; |
345 | goto SkipForAbort; | |
346 | } | |
347 | ||
348 | scsi_unlock(host); | |
349 | ||
f0183a33 FB |
350 | /* |
351 | * reject the command if the direction indicator | |
1da177e4 LT |
352 | * is UNKNOWN |
353 | */ | |
354 | if (us->srb->sc_data_direction == DMA_BIDIRECTIONAL) { | |
191648d0 | 355 | usb_stor_dbg(us, "UNKNOWN data direction\n"); |
1da177e4 LT |
356 | us->srb->result = DID_ERROR << 16; |
357 | } | |
358 | ||
f0183a33 FB |
359 | /* |
360 | * reject if target != 0 or if LUN is higher than | |
1da177e4 LT |
361 | * the maximum known LUN |
362 | */ | |
a1631062 | 363 | else if (us->srb->device->id && |
7e4d6c38 | 364 | !(us->fflags & US_FL_SCM_MULT_TARG)) { |
9cb78c16 HR |
365 | usb_stor_dbg(us, "Bad target number (%d:%llu)\n", |
366 | us->srb->device->id, | |
367 | us->srb->device->lun); | |
1da177e4 LT |
368 | us->srb->result = DID_BAD_TARGET << 16; |
369 | } | |
370 | ||
371 | else if (us->srb->device->lun > us->max_lun) { | |
9cb78c16 HR |
372 | usb_stor_dbg(us, "Bad LUN (%d:%llu)\n", |
373 | us->srb->device->id, | |
374 | us->srb->device->lun); | |
1da177e4 LT |
375 | us->srb->result = DID_BAD_TARGET << 16; |
376 | } | |
377 | ||
f0183a33 FB |
378 | /* |
379 | * Handle those devices which need us to fake | |
380 | * their inquiry data | |
381 | */ | |
1da177e4 | 382 | else if ((us->srb->cmnd[0] == INQUIRY) && |
7e4d6c38 | 383 | (us->fflags & US_FL_FIX_INQUIRY)) { |
1da177e4 LT |
384 | unsigned char data_ptr[36] = { |
385 | 0x00, 0x80, 0x02, 0x02, | |
386 | 0x1F, 0x00, 0x00, 0x00}; | |
387 | ||
191648d0 | 388 | usb_stor_dbg(us, "Faking INQUIRY command\n"); |
1da177e4 LT |
389 | fill_inquiry_response(us, data_ptr, 36); |
390 | us->srb->result = SAM_STAT_GOOD; | |
391 | } | |
392 | ||
393 | /* we've got a command, let's do it! */ | |
394 | else { | |
191648d0 | 395 | US_DEBUG(usb_stor_show_command(us, us->srb)); |
1da177e4 | 396 | us->proto_handler(us->srb, us); |
f283925f | 397 | usb_mark_last_busy(us->pusb_dev); |
1da177e4 LT |
398 | } |
399 | ||
400 | /* lock access to the state */ | |
401 | scsi_lock(host); | |
402 | ||
8b52291a AS |
403 | /* was the command aborted? */ |
404 | if (us->srb->result == DID_ABORT << 16) { | |
1da177e4 | 405 | SkipForAbort: |
191648d0 | 406 | usb_stor_dbg(us, "scsi command aborted\n"); |
8b52291a | 407 | srb = NULL; /* Don't call srb->scsi_done() */ |
1da177e4 LT |
408 | } |
409 | ||
f0183a33 FB |
410 | /* |
411 | * If an abort request was received we need to signal that | |
1da177e4 LT |
412 | * the abort has finished. The proper test for this is |
413 | * the TIMED_OUT flag, not srb->result == DID_ABORT, because | |
226173ed | 414 | * the timeout might have occurred after the command had |
f0183a33 FB |
415 | * already completed with a different result code. |
416 | */ | |
7e4d6c38 | 417 | if (test_bit(US_FLIDX_TIMED_OUT, &us->dflags)) { |
1da177e4 LT |
418 | complete(&(us->notify)); |
419 | ||
226173ed | 420 | /* Allow USB transfers to resume */ |
7e4d6c38 AS |
421 | clear_bit(US_FLIDX_ABORTING, &us->dflags); |
422 | clear_bit(US_FLIDX_TIMED_OUT, &us->dflags); | |
226173ed MD |
423 | } |
424 | ||
1da177e4 LT |
425 | /* finished working on this command */ |
426 | us->srb = NULL; | |
427 | scsi_unlock(host); | |
428 | ||
429 | /* unlock the device pointers */ | |
4186ecf8 | 430 | mutex_unlock(&us->dev_mutex); |
8b52291a AS |
431 | |
432 | /* now that the locks are released, notify the SCSI core */ | |
433 | if (srb) { | |
434 | usb_stor_dbg(us, "scsi cmd done, result=0x%x\n", | |
435 | srb->result); | |
436 | srb->scsi_done(srb); | |
437 | } | |
1da177e4 LT |
438 | } /* for (;;) */ |
439 | ||
ed76cacb AS |
440 | /* Wait until we are told to stop */ |
441 | for (;;) { | |
442 | set_current_state(TASK_INTERRUPTIBLE); | |
443 | if (kthread_should_stop()) | |
444 | break; | |
445 | schedule(); | |
446 | } | |
447 | __set_current_state(TASK_RUNNING); | |
448 | return 0; | |
a1631062 | 449 | } |
1da177e4 LT |
450 | |
451 | /*********************************************************************** | |
452 | * Device probing and disconnecting | |
453 | ***********************************************************************/ | |
454 | ||
455 | /* Associate our private data with the USB device */ | |
456 | static int associate_dev(struct us_data *us, struct usb_interface *intf) | |
457 | { | |
1da177e4 LT |
458 | /* Fill in the device-related fields */ |
459 | us->pusb_dev = interface_to_usbdev(intf); | |
460 | us->pusb_intf = intf; | |
461 | us->ifnum = intf->cur_altsetting->desc.bInterfaceNumber; | |
191648d0 JP |
462 | usb_stor_dbg(us, "Vendor: 0x%04x, Product: 0x%04x, Revision: 0x%04x\n", |
463 | le16_to_cpu(us->pusb_dev->descriptor.idVendor), | |
464 | le16_to_cpu(us->pusb_dev->descriptor.idProduct), | |
465 | le16_to_cpu(us->pusb_dev->descriptor.bcdDevice)); | |
466 | usb_stor_dbg(us, "Interface Subclass: 0x%02x, Protocol: 0x%02x\n", | |
467 | intf->cur_altsetting->desc.bInterfaceSubClass, | |
468 | intf->cur_altsetting->desc.bInterfaceProtocol); | |
1da177e4 LT |
469 | |
470 | /* Store our private data in the interface */ | |
471 | usb_set_intfdata(intf, us); | |
472 | ||
0ede76fc AS |
473 | /* Allocate the control/setup and DMA-mapped buffers */ |
474 | us->cr = kmalloc(sizeof(*us->cr), GFP_KERNEL); | |
191648d0 | 475 | if (!us->cr) |
1da177e4 | 476 | return -ENOMEM; |
1da177e4 | 477 | |
997ea58e | 478 | us->iobuf = usb_alloc_coherent(us->pusb_dev, US_IOBUF_SIZE, |
1da177e4 LT |
479 | GFP_KERNEL, &us->iobuf_dma); |
480 | if (!us->iobuf) { | |
191648d0 | 481 | usb_stor_dbg(us, "I/O buffer allocation failed\n"); |
1da177e4 LT |
482 | return -ENOMEM; |
483 | } | |
484 | return 0; | |
485 | } | |
486 | ||
c838ea46 AS |
487 | /* Works only for digits and letters, but small and fast */ |
488 | #define TOLOWER(x) ((x) | 0x20) | |
489 | ||
d4f373e5 | 490 | /* Adjust device flags based on the "quirks=" module parameter */ |
d24d481b | 491 | void usb_stor_adjust_quirks(struct usb_device *udev, unsigned long *fflags) |
d4f373e5 | 492 | { |
c838ea46 | 493 | char *p; |
d24d481b HG |
494 | u16 vid = le16_to_cpu(udev->descriptor.idVendor); |
495 | u16 pid = le16_to_cpu(udev->descriptor.idProduct); | |
c838ea46 | 496 | unsigned f = 0; |
a91b593e | 497 | unsigned int mask = (US_FL_SANE_SENSE | US_FL_BAD_SENSE | |
d24d481b | 498 | US_FL_FIX_CAPACITY | US_FL_IGNORE_UAS | |
c838ea46 | 499 | US_FL_CAPACITY_HEURISTICS | US_FL_IGNORE_DEVICE | |
d4f373e5 | 500 | US_FL_NOT_LOCKABLE | US_FL_MAX_SECTORS_64 | |
c838ea46 | 501 | US_FL_CAPACITY_OK | US_FL_IGNORE_RESIDUE | |
5116901d | 502 | US_FL_SINGLE_LUN | US_FL_NO_WP_DETECT | |
21c13a4f | 503 | US_FL_NO_READ_DISC_INFO | US_FL_NO_READ_CAPACITY_16 | |
59307852 | 504 | US_FL_INITIAL_READ10 | US_FL_WRITE_CACHE | |
ee136af4 | 505 | US_FL_NO_ATA_1X | US_FL_NO_REPORT_OPCODES | |
050bc4e8 ON |
506 | US_FL_MAX_SECTORS_240 | US_FL_NO_REPORT_LUNS | |
507 | US_FL_ALWAYS_SYNC); | |
c838ea46 AS |
508 | |
509 | p = quirks; | |
510 | while (*p) { | |
511 | /* Each entry consists of VID:PID:flags */ | |
512 | if (vid == simple_strtoul(p, &p, 16) && | |
513 | *p == ':' && | |
514 | pid == simple_strtoul(p+1, &p, 16) && | |
515 | *p == ':') | |
d4f373e5 | 516 | break; |
c838ea46 AS |
517 | |
518 | /* Move forward to the next entry */ | |
519 | while (*p) { | |
520 | if (*p++ == ',') | |
521 | break; | |
d4f373e5 AS |
522 | } |
523 | } | |
c838ea46 AS |
524 | if (!*p) /* No match */ |
525 | return; | |
526 | ||
527 | /* Collect the flags */ | |
528 | while (*++p && *p != ',') { | |
529 | switch (TOLOWER(*p)) { | |
530 | case 'a': | |
531 | f |= US_FL_SANE_SENSE; | |
532 | break; | |
a0bb1081 AS |
533 | case 'b': |
534 | f |= US_FL_BAD_SENSE; | |
535 | break; | |
c838ea46 AS |
536 | case 'c': |
537 | f |= US_FL_FIX_CAPACITY; | |
538 | break; | |
5116901d KR |
539 | case 'd': |
540 | f |= US_FL_NO_READ_DISC_INFO; | |
541 | break; | |
542 | case 'e': | |
543 | f |= US_FL_NO_READ_CAPACITY_16; | |
544 | break; | |
734016b0 HG |
545 | case 'f': |
546 | f |= US_FL_NO_REPORT_OPCODES; | |
547 | break; | |
ee136af4 HG |
548 | case 'g': |
549 | f |= US_FL_MAX_SECTORS_240; | |
550 | break; | |
c838ea46 AS |
551 | case 'h': |
552 | f |= US_FL_CAPACITY_HEURISTICS; | |
553 | break; | |
554 | case 'i': | |
555 | f |= US_FL_IGNORE_DEVICE; | |
556 | break; | |
13630746 HG |
557 | case 'j': |
558 | f |= US_FL_NO_REPORT_LUNS; | |
559 | break; | |
c838ea46 AS |
560 | case 'l': |
561 | f |= US_FL_NOT_LOCKABLE; | |
562 | break; | |
563 | case 'm': | |
564 | f |= US_FL_MAX_SECTORS_64; | |
565 | break; | |
21c13a4f AS |
566 | case 'n': |
567 | f |= US_FL_INITIAL_READ10; | |
568 | break; | |
c838ea46 AS |
569 | case 'o': |
570 | f |= US_FL_CAPACITY_OK; | |
571 | break; | |
eaa05dfc NJ |
572 | case 'p': |
573 | f |= US_FL_WRITE_CACHE; | |
574 | break; | |
c838ea46 AS |
575 | case 'r': |
576 | f |= US_FL_IGNORE_RESIDUE; | |
577 | break; | |
578 | case 's': | |
579 | f |= US_FL_SINGLE_LUN; | |
580 | break; | |
59307852 HG |
581 | case 't': |
582 | f |= US_FL_NO_ATA_1X; | |
583 | break; | |
d24d481b HG |
584 | case 'u': |
585 | f |= US_FL_IGNORE_UAS; | |
586 | break; | |
c838ea46 AS |
587 | case 'w': |
588 | f |= US_FL_NO_WP_DETECT; | |
589 | break; | |
050bc4e8 ON |
590 | case 'y': |
591 | f |= US_FL_ALWAYS_SYNC; | |
592 | break; | |
c838ea46 AS |
593 | /* Ignore unrecognized flag characters */ |
594 | } | |
595 | } | |
d24d481b | 596 | *fflags = (*fflags & ~mask) | f; |
d4f373e5 | 597 | } |
d24d481b | 598 | EXPORT_SYMBOL_GPL(usb_stor_adjust_quirks); |
d4f373e5 | 599 | |
1da177e4 | 600 | /* Get the unusual_devs entries and the string descriptors */ |
e6e244b6 AS |
601 | static int get_device_info(struct us_data *us, const struct usb_device_id *id, |
602 | struct us_unusual_dev *unusual_dev) | |
1da177e4 LT |
603 | { |
604 | struct usb_device *dev = us->pusb_dev; | |
605 | struct usb_interface_descriptor *idesc = | |
606 | &us->pusb_intf->cur_altsetting->desc; | |
cbd3af54 | 607 | struct device *pdev = &us->pusb_intf->dev; |
1da177e4 LT |
608 | |
609 | /* Store the entries */ | |
610 | us->unusual_dev = unusual_dev; | |
8fa7fd74 | 611 | us->subclass = (unusual_dev->useProtocol == USB_SC_DEVICE) ? |
1da177e4 LT |
612 | idesc->bInterfaceSubClass : |
613 | unusual_dev->useProtocol; | |
8fa7fd74 | 614 | us->protocol = (unusual_dev->useTransport == USB_PR_DEVICE) ? |
1da177e4 LT |
615 | idesc->bInterfaceProtocol : |
616 | unusual_dev->useTransport; | |
f61870ee | 617 | us->fflags = id->driver_info; |
d24d481b | 618 | usb_stor_adjust_quirks(us->pusb_dev, &us->fflags); |
1da177e4 | 619 | |
7e4d6c38 | 620 | if (us->fflags & US_FL_IGNORE_DEVICE) { |
cbd3af54 | 621 | dev_info(pdev, "device ignored\n"); |
3c332422 DD |
622 | return -ENODEV; |
623 | } | |
624 | ||
1da177e4 LT |
625 | /* |
626 | * This flag is only needed when we're in high-speed, so let's | |
627 | * disable it if we're in full-speed | |
628 | */ | |
629 | if (dev->speed != USB_SPEED_HIGH) | |
7e4d6c38 | 630 | us->fflags &= ~US_FL_GO_SLOW; |
1da177e4 | 631 | |
39f2f080 FC |
632 | if (us->fflags) |
633 | dev_info(pdev, "Quirks match for vid %04x pid %04x: %lx\n", | |
634 | le16_to_cpu(dev->descriptor.idVendor), | |
635 | le16_to_cpu(dev->descriptor.idProduct), | |
636 | us->fflags); | |
637 | ||
f0183a33 FB |
638 | /* |
639 | * Log a message if a non-generic unusual_dev entry contains an | |
1da177e4 LT |
640 | * unnecessary subclass or protocol override. This may stimulate |
641 | * reports from users that will help us remove unneeded entries | |
642 | * from the unusual_devs.h table. | |
643 | */ | |
644 | if (id->idVendor || id->idProduct) { | |
4c4c9432 | 645 | static const char *msgs[3] = { |
1da177e4 LT |
646 | "an unneeded SubClass entry", |
647 | "an unneeded Protocol entry", | |
648 | "unneeded SubClass and Protocol entries"}; | |
649 | struct usb_device_descriptor *ddesc = &dev->descriptor; | |
650 | int msg = -1; | |
651 | ||
8fa7fd74 | 652 | if (unusual_dev->useProtocol != USB_SC_DEVICE && |
1da177e4 LT |
653 | us->subclass == idesc->bInterfaceSubClass) |
654 | msg += 1; | |
8fa7fd74 | 655 | if (unusual_dev->useTransport != USB_PR_DEVICE && |
1da177e4 LT |
656 | us->protocol == idesc->bInterfaceProtocol) |
657 | msg += 2; | |
7e4d6c38 | 658 | if (msg >= 0 && !(us->fflags & US_FL_NEED_OVERRIDE)) |
cbd3af54 FC |
659 | dev_notice(pdev, "This device " |
660 | "(%04x,%04x,%04x S %02x P %02x)" | |
661 | " has %s in unusual_devs.h (kernel" | |
662 | " %s)\n" | |
663 | " Please send a copy of this message to " | |
664 | "<linux-usb@vger.kernel.org> and " | |
665 | "<usb-storage@lists.one-eyed-alien.net>\n", | |
666 | le16_to_cpu(ddesc->idVendor), | |
667 | le16_to_cpu(ddesc->idProduct), | |
668 | le16_to_cpu(ddesc->bcdDevice), | |
669 | idesc->bInterfaceSubClass, | |
670 | idesc->bInterfaceProtocol, | |
671 | msgs[msg], | |
672 | utsname()->release); | |
1da177e4 | 673 | } |
3c332422 DD |
674 | |
675 | return 0; | |
1da177e4 LT |
676 | } |
677 | ||
678 | /* Get the transport settings */ | |
e6e244b6 | 679 | static void get_transport(struct us_data *us) |
1da177e4 LT |
680 | { |
681 | switch (us->protocol) { | |
8fa7fd74 | 682 | case USB_PR_CB: |
1da177e4 LT |
683 | us->transport_name = "Control/Bulk"; |
684 | us->transport = usb_stor_CB_transport; | |
685 | us->transport_reset = usb_stor_CB_reset; | |
686 | us->max_lun = 7; | |
687 | break; | |
688 | ||
8fa7fd74 | 689 | case USB_PR_CBI: |
1da177e4 | 690 | us->transport_name = "Control/Bulk/Interrupt"; |
64648a9d | 691 | us->transport = usb_stor_CB_transport; |
1da177e4 LT |
692 | us->transport_reset = usb_stor_CB_reset; |
693 | us->max_lun = 7; | |
694 | break; | |
695 | ||
8fa7fd74 | 696 | case USB_PR_BULK: |
1da177e4 LT |
697 | us->transport_name = "Bulk"; |
698 | us->transport = usb_stor_Bulk_transport; | |
699 | us->transport_reset = usb_stor_Bulk_reset; | |
700 | break; | |
1da177e4 | 701 | } |
1da177e4 LT |
702 | } |
703 | ||
704 | /* Get the protocol settings */ | |
e6e244b6 | 705 | static void get_protocol(struct us_data *us) |
1da177e4 LT |
706 | { |
707 | switch (us->subclass) { | |
8fa7fd74 | 708 | case USB_SC_RBC: |
1da177e4 LT |
709 | us->protocol_name = "Reduced Block Commands (RBC)"; |
710 | us->proto_handler = usb_stor_transparent_scsi_command; | |
711 | break; | |
712 | ||
8fa7fd74 | 713 | case USB_SC_8020: |
1da177e4 | 714 | us->protocol_name = "8020i"; |
3dae5345 | 715 | us->proto_handler = usb_stor_pad12_command; |
1da177e4 LT |
716 | us->max_lun = 0; |
717 | break; | |
718 | ||
8fa7fd74 | 719 | case USB_SC_QIC: |
1da177e4 | 720 | us->protocol_name = "QIC-157"; |
3dae5345 | 721 | us->proto_handler = usb_stor_pad12_command; |
1da177e4 LT |
722 | us->max_lun = 0; |
723 | break; | |
724 | ||
8fa7fd74 | 725 | case USB_SC_8070: |
1da177e4 | 726 | us->protocol_name = "8070i"; |
3dae5345 | 727 | us->proto_handler = usb_stor_pad12_command; |
1da177e4 LT |
728 | us->max_lun = 0; |
729 | break; | |
730 | ||
8fa7fd74 | 731 | case USB_SC_SCSI: |
1da177e4 LT |
732 | us->protocol_name = "Transparent SCSI"; |
733 | us->proto_handler = usb_stor_transparent_scsi_command; | |
734 | break; | |
735 | ||
8fa7fd74 | 736 | case USB_SC_UFI: |
1da177e4 LT |
737 | us->protocol_name = "Uniform Floppy Interface (UFI)"; |
738 | us->proto_handler = usb_stor_ufi_command; | |
739 | break; | |
1da177e4 | 740 | } |
1da177e4 LT |
741 | } |
742 | ||
743 | /* Get the pipe settings */ | |
744 | static int get_pipes(struct us_data *us) | |
745 | { | |
80070a40 JH |
746 | struct usb_host_interface *alt = us->pusb_intf->cur_altsetting; |
747 | struct usb_endpoint_descriptor *ep_in; | |
748 | struct usb_endpoint_descriptor *ep_out; | |
749 | struct usb_endpoint_descriptor *ep_int; | |
750 | int res; | |
1da177e4 LT |
751 | |
752 | /* | |
1096f780 | 753 | * Find the first endpoint of each type we need. |
1da177e4 | 754 | * We are expecting a minimum of 2 endpoints - in and out (bulk). |
1096f780 | 755 | * An optional interrupt-in is OK (necessary for CBI protocol). |
1da177e4 LT |
756 | * We will ignore any others. |
757 | */ | |
80070a40 JH |
758 | res = usb_find_common_endpoints(alt, &ep_in, &ep_out, NULL, NULL); |
759 | if (res) { | |
760 | usb_stor_dbg(us, "bulk endpoints not found\n"); | |
761 | return res; | |
1da177e4 LT |
762 | } |
763 | ||
80070a40 JH |
764 | res = usb_find_int_in_endpoint(alt, &ep_int); |
765 | if (res && us->protocol == USB_PR_CBI) { | |
766 | usb_stor_dbg(us, "interrupt endpoint not found\n"); | |
767 | return res; | |
1da177e4 LT |
768 | } |
769 | ||
770 | /* Calculate and store the pipe values */ | |
771 | us->send_ctrl_pipe = usb_sndctrlpipe(us->pusb_dev, 0); | |
772 | us->recv_ctrl_pipe = usb_rcvctrlpipe(us->pusb_dev, 0); | |
773 | us->send_bulk_pipe = usb_sndbulkpipe(us->pusb_dev, | |
2e0fe709 | 774 | usb_endpoint_num(ep_out)); |
a1631062 | 775 | us->recv_bulk_pipe = usb_rcvbulkpipe(us->pusb_dev, |
2e0fe709 | 776 | usb_endpoint_num(ep_in)); |
1da177e4 LT |
777 | if (ep_int) { |
778 | us->recv_intr_pipe = usb_rcvintpipe(us->pusb_dev, | |
2e0fe709 | 779 | usb_endpoint_num(ep_int)); |
1da177e4 LT |
780 | us->ep_bInterval = ep_int->bInterval; |
781 | } | |
782 | return 0; | |
783 | } | |
784 | ||
785 | /* Initialize all the dynamic resources we need */ | |
786 | static int usb_stor_acquire_resources(struct us_data *us) | |
787 | { | |
788 | int p; | |
3f13e66e | 789 | struct task_struct *th; |
1da177e4 LT |
790 | |
791 | us->current_urb = usb_alloc_urb(0, GFP_KERNEL); | |
792f94f5 | 792 | if (!us->current_urb) |
1da177e4 | 793 | return -ENOMEM; |
1da177e4 | 794 | |
f0183a33 FB |
795 | /* |
796 | * Just before we start our control thread, initialize | |
797 | * the device if it needs initialization | |
798 | */ | |
b876aef7 AS |
799 | if (us->unusual_dev->initFunction) { |
800 | p = us->unusual_dev->initFunction(us); | |
801 | if (p) | |
802 | return p; | |
803 | } | |
1da177e4 LT |
804 | |
805 | /* Start up our control thread */ | |
ed76cacb | 806 | th = kthread_run(usb_stor_control_thread, us, "usb-storage"); |
3f13e66e | 807 | if (IS_ERR(th)) { |
cbd3af54 FC |
808 | dev_warn(&us->pusb_intf->dev, |
809 | "Unable to start control thread\n"); | |
3f13e66e | 810 | return PTR_ERR(th); |
1da177e4 | 811 | } |
ed76cacb | 812 | us->ctl_thread = th; |
1da177e4 LT |
813 | |
814 | return 0; | |
815 | } | |
816 | ||
817 | /* Release all our dynamic resources */ | |
818 | static void usb_stor_release_resources(struct us_data *us) | |
819 | { | |
f0183a33 FB |
820 | /* |
821 | * Tell the control thread to exit. The SCSI host must | |
543f7810 AS |
822 | * already have been removed and the DISCONNECTING flag set |
823 | * so that we won't accept any more commands. | |
1da177e4 | 824 | */ |
191648d0 | 825 | usb_stor_dbg(us, "-- sending exit command to thread\n"); |
7119e3c3 | 826 | complete(&us->cmnd_ready); |
ed76cacb AS |
827 | if (us->ctl_thread) |
828 | kthread_stop(us->ctl_thread); | |
1da177e4 LT |
829 | |
830 | /* Call the destructor routine, if it exists */ | |
831 | if (us->extra_destructor) { | |
191648d0 | 832 | usb_stor_dbg(us, "-- calling extra_destructor()\n"); |
1da177e4 LT |
833 | us->extra_destructor(us->extra); |
834 | } | |
835 | ||
836 | /* Free the extra data and the URB */ | |
837 | kfree(us->extra); | |
838 | usb_free_urb(us->current_urb); | |
839 | } | |
840 | ||
841 | /* Dissociate from the USB device */ | |
842 | static void dissociate_dev(struct us_data *us) | |
843 | { | |
0ede76fc AS |
844 | /* Free the buffers */ |
845 | kfree(us->cr); | |
997ea58e | 846 | usb_free_coherent(us->pusb_dev, US_IOBUF_SIZE, us->iobuf, us->iobuf_dma); |
1da177e4 LT |
847 | |
848 | /* Remove our private data from the interface */ | |
849 | usb_set_intfdata(us->pusb_intf, NULL); | |
850 | } | |
851 | ||
f0183a33 FB |
852 | /* |
853 | * First stage of disconnect processing: stop SCSI scanning, | |
543f7810 AS |
854 | * remove the host, and stop accepting new commands |
855 | */ | |
77f46328 MD |
856 | static void quiesce_and_remove_host(struct us_data *us) |
857 | { | |
eecd11ed AS |
858 | struct Scsi_Host *host = us_to_host(us); |
859 | ||
543f7810 | 860 | /* If the device is really gone, cut short reset delays */ |
bb94a406 | 861 | if (us->pusb_dev->state == USB_STATE_NOTATTACHED) { |
543f7810 | 862 | set_bit(US_FLIDX_DISCONNECTING, &us->dflags); |
bb94a406 AS |
863 | wake_up(&us->delay_wait); |
864 | } | |
77f46328 | 865 | |
f0183a33 FB |
866 | /* |
867 | * Prevent SCSI scanning (if it hasn't started yet) | |
bb94a406 | 868 | * or wait for the SCSI-scanning routine to stop. |
543f7810 | 869 | */ |
bb94a406 AS |
870 | cancel_delayed_work_sync(&us->scan_dwork); |
871 | ||
872 | /* Balance autopm calls if scanning was cancelled */ | |
873 | if (test_bit(US_FLIDX_SCAN_PENDING, &us->dflags)) | |
874 | usb_autopm_put_interface_no_suspend(us->pusb_intf); | |
26186ba7 | 875 | |
f0183a33 FB |
876 | /* |
877 | * Removing the host will perform an orderly shutdown: caches | |
543f7810 AS |
878 | * synchronized, disks spun down, etc. |
879 | */ | |
eecd11ed | 880 | scsi_remove_host(host); |
2f67cd5b | 881 | |
f0183a33 FB |
882 | /* |
883 | * Prevent any new commands from being accepted and cut short | |
543f7810 AS |
884 | * reset delays. |
885 | */ | |
886 | scsi_lock(host); | |
887 | set_bit(US_FLIDX_DISCONNECTING, &us->dflags); | |
888 | scsi_unlock(host); | |
889 | wake_up(&us->delay_wait); | |
77f46328 MD |
890 | } |
891 | ||
892 | /* Second stage of disconnect processing: deallocate all resources */ | |
893 | static void release_everything(struct us_data *us) | |
894 | { | |
895 | usb_stor_release_resources(us); | |
896 | dissociate_dev(us); | |
897 | ||
f0183a33 FB |
898 | /* |
899 | * Drop our reference to the host; the SCSI core will free it | |
900 | * (and "us" along with it) when the refcount becomes 0. | |
901 | */ | |
77f46328 MD |
902 | scsi_host_put(us_to_host(us)); |
903 | } | |
904 | ||
bb94a406 AS |
905 | /* Delayed-work routine to carry out SCSI-device scanning */ |
906 | static void usb_stor_scan_dwork(struct work_struct *work) | |
1da177e4 | 907 | { |
bb94a406 AS |
908 | struct us_data *us = container_of(work, struct us_data, |
909 | scan_dwork.work); | |
cbd3af54 | 910 | struct device *dev = &us->pusb_intf->dev; |
1da177e4 | 911 | |
bb94a406 | 912 | dev_dbg(dev, "starting scan\n"); |
ec012476 | 913 | |
bb94a406 | 914 | /* For bulk-only devices, determine the max LUN value */ |
646a3843 MK |
915 | if (us->protocol == USB_PR_BULK && |
916 | !(us->fflags & US_FL_SINGLE_LUN) && | |
917 | !(us->fflags & US_FL_SCM_MULT_TARG)) { | |
bb94a406 AS |
918 | mutex_lock(&us->dev_mutex); |
919 | us->max_lun = usb_stor_Bulk_max_lun(us); | |
ec371326 ON |
920 | /* |
921 | * Allow proper scanning of devices that present more than 8 LUNs | |
f0183a33 FB |
922 | * While not affecting other devices that may need the previous |
923 | * behavior | |
ec371326 ON |
924 | */ |
925 | if (us->max_lun >= 8) | |
926 | us_to_host(us)->max_lun = us->max_lun+1; | |
bb94a406 | 927 | mutex_unlock(&us->dev_mutex); |
1da177e4 | 928 | } |
bb94a406 AS |
929 | scsi_scan_host(us_to_host(us)); |
930 | dev_dbg(dev, "scan complete\n"); | |
1da177e4 | 931 | |
bb94a406 | 932 | /* Should we unbind if no devices were detected? */ |
1da177e4 | 933 | |
f283925f | 934 | usb_autopm_put_interface(us->pusb_intf); |
bb94a406 | 935 | clear_bit(US_FLIDX_SCAN_PENDING, &us->dflags); |
1da177e4 LT |
936 | } |
937 | ||
4c1bd3d7 DV |
938 | static unsigned int usb_stor_sg_tablesize(struct usb_interface *intf) |
939 | { | |
940 | struct usb_device *usb_dev = interface_to_usbdev(intf); | |
941 | ||
942 | if (usb_dev->bus->sg_tablesize) { | |
943 | return usb_dev->bus->sg_tablesize; | |
944 | } | |
945 | return SG_ALL; | |
946 | } | |
1da177e4 | 947 | |
e6e244b6 AS |
948 | /* First part of general USB mass-storage probing */ |
949 | int usb_stor_probe1(struct us_data **pus, | |
950 | struct usb_interface *intf, | |
951 | const struct usb_device_id *id, | |
aa519be3 AM |
952 | struct us_unusual_dev *unusual_dev, |
953 | struct scsi_host_template *sht) | |
1da177e4 LT |
954 | { |
955 | struct Scsi_Host *host; | |
956 | struct us_data *us; | |
1da177e4 | 957 | int result; |
a00828e9 | 958 | |
191648d0 | 959 | dev_info(&intf->dev, "USB Mass Storage device detected\n"); |
1da177e4 LT |
960 | |
961 | /* | |
962 | * Ask the SCSI layer to allocate a host structure, with extra | |
963 | * space at the end for our private us_data structure. | |
964 | */ | |
aa519be3 | 965 | host = scsi_host_alloc(sht, sizeof(*us)); |
1da177e4 | 966 | if (!host) { |
191648d0 | 967 | dev_warn(&intf->dev, "Unable to allocate the scsi host\n"); |
1da177e4 LT |
968 | return -ENOMEM; |
969 | } | |
970 | ||
17f06022 RS |
971 | /* |
972 | * Allow 16-byte CDBs and thus > 2TB | |
973 | */ | |
974 | host->max_cmd_len = 16; | |
4c1bd3d7 | 975 | host->sg_tablesize = usb_stor_sg_tablesize(intf); |
e6e244b6 | 976 | *pus = us = host_to_us(host); |
4186ecf8 | 977 | mutex_init(&(us->dev_mutex)); |
c825bab0 | 978 | us_set_lock_class(&us->dev_mutex, intf); |
7119e3c3 | 979 | init_completion(&us->cmnd_ready); |
1da177e4 LT |
980 | init_completion(&(us->notify)); |
981 | init_waitqueue_head(&us->delay_wait); | |
bb94a406 | 982 | INIT_DELAYED_WORK(&us->scan_dwork, usb_stor_scan_dwork); |
1da177e4 LT |
983 | |
984 | /* Associate the us_data structure with the USB device */ | |
985 | result = associate_dev(us, intf); | |
986 | if (result) | |
987 | goto BadDevice; | |
988 | ||
e6e244b6 AS |
989 | /* Get the unusual_devs entries and the descriptors */ |
990 | result = get_device_info(us, id, unusual_dev); | |
3c332422 DD |
991 | if (result) |
992 | goto BadDevice; | |
1da177e4 | 993 | |
e6e244b6 AS |
994 | /* Get standard transport and protocol settings */ |
995 | get_transport(us); | |
996 | get_protocol(us); | |
997 | ||
f0183a33 FB |
998 | /* |
999 | * Give the caller a chance to fill in specialized transport | |
e6e244b6 AS |
1000 | * or protocol settings. |
1001 | */ | |
1002 | return 0; | |
1003 | ||
1004 | BadDevice: | |
191648d0 | 1005 | usb_stor_dbg(us, "storage_probe() failed\n"); |
e6e244b6 AS |
1006 | release_everything(us); |
1007 | return result; | |
1008 | } | |
1009 | EXPORT_SYMBOL_GPL(usb_stor_probe1); | |
1010 | ||
1011 | /* Second part of general USB mass-storage probing */ | |
1012 | int usb_stor_probe2(struct us_data *us) | |
1013 | { | |
e6e244b6 | 1014 | int result; |
cbd3af54 | 1015 | struct device *dev = &us->pusb_intf->dev; |
e6e244b6 AS |
1016 | |
1017 | /* Make sure the transport and protocol have both been set */ | |
1018 | if (!us->transport || !us->proto_handler) { | |
1019 | result = -ENXIO; | |
1da177e4 | 1020 | goto BadDevice; |
e6e244b6 | 1021 | } |
191648d0 JP |
1022 | usb_stor_dbg(us, "Transport: %s\n", us->transport_name); |
1023 | usb_stor_dbg(us, "Protocol: %s\n", us->protocol_name); | |
e6e244b6 | 1024 | |
646a3843 MK |
1025 | if (us->fflags & US_FL_SCM_MULT_TARG) { |
1026 | /* | |
1027 | * SCM eUSCSI bridge devices can have different numbers | |
1028 | * of LUNs on different targets; allow all to be probed. | |
1029 | */ | |
1030 | us->max_lun = 7; | |
1031 | /* The eUSCSI itself has ID 7, so avoid scanning that */ | |
1032 | us_to_host(us)->this_id = 7; | |
1033 | /* max_id is 8 initially, so no need to set it here */ | |
1034 | } else { | |
1035 | /* In the normal case there is only a single target */ | |
1036 | us_to_host(us)->max_id = 1; | |
1037 | /* | |
1038 | * Like Windows, we won't store the LUN bits in CDB[1] for | |
1039 | * SCSI-2 devices using the Bulk-Only transport (even though | |
1040 | * this violates the SCSI spec). | |
1041 | */ | |
1042 | if (us->transport == usb_stor_Bulk_transport) | |
1043 | us_to_host(us)->no_scsi2_lun_in_cdb = 1; | |
1044 | } | |
1045 | ||
e6e244b6 AS |
1046 | /* fix for single-lun devices */ |
1047 | if (us->fflags & US_FL_SINGLE_LUN) | |
1048 | us->max_lun = 0; | |
1049 | ||
1050 | /* Find the endpoints and calculate pipe values */ | |
1da177e4 LT |
1051 | result = get_pipes(us); |
1052 | if (result) | |
1053 | goto BadDevice; | |
1054 | ||
21c13a4f AS |
1055 | /* |
1056 | * If the device returns invalid data for the first READ(10) | |
1057 | * command, indicate the command should be retried. | |
1058 | */ | |
1059 | if (us->fflags & US_FL_INITIAL_READ10) | |
1060 | set_bit(US_FLIDX_REDO_READ10, &us->dflags); | |
1061 | ||
1da177e4 LT |
1062 | /* Acquire all the other resources and add the host */ |
1063 | result = usb_stor_acquire_resources(us); | |
1064 | if (result) | |
1065 | goto BadDevice; | |
a094760b | 1066 | usb_autopm_get_interface_no_resume(us->pusb_intf); |
00fa43ef MW |
1067 | snprintf(us->scsi_name, sizeof(us->scsi_name), "usb-storage %s", |
1068 | dev_name(&us->pusb_intf->dev)); | |
cbd3af54 | 1069 | result = scsi_add_host(us_to_host(us), dev); |
1da177e4 | 1070 | if (result) { |
cbd3af54 FC |
1071 | dev_warn(dev, |
1072 | "Unable to add the scsi host\n"); | |
a094760b | 1073 | goto HostAddErr; |
1da177e4 LT |
1074 | } |
1075 | ||
bb94a406 | 1076 | /* Submit the delayed_work for SCSI-device scanning */ |
bb94a406 | 1077 | set_bit(US_FLIDX_SCAN_PENDING, &us->dflags); |
1da177e4 | 1078 | |
bb94a406 AS |
1079 | if (delay_use > 0) |
1080 | dev_dbg(dev, "waiting for device to settle before scanning\n"); | |
1081 | queue_delayed_work(system_freezable_wq, &us->scan_dwork, | |
1082 | delay_use * HZ); | |
1da177e4 LT |
1083 | return 0; |
1084 | ||
1085 | /* We come here if there are any problems */ | |
a094760b HK |
1086 | HostAddErr: |
1087 | usb_autopm_put_interface_no_suspend(us->pusb_intf); | |
1da177e4 | 1088 | BadDevice: |
191648d0 | 1089 | usb_stor_dbg(us, "storage_probe() failed\n"); |
77f46328 | 1090 | release_everything(us); |
1da177e4 LT |
1091 | return result; |
1092 | } | |
e6e244b6 | 1093 | EXPORT_SYMBOL_GPL(usb_stor_probe2); |
1da177e4 | 1094 | |
e6e244b6 AS |
1095 | /* Handle a USB mass-storage disconnect */ |
1096 | void usb_stor_disconnect(struct usb_interface *intf) | |
1da177e4 LT |
1097 | { |
1098 | struct us_data *us = usb_get_intfdata(intf); | |
1099 | ||
77f46328 MD |
1100 | quiesce_and_remove_host(us); |
1101 | release_everything(us); | |
1da177e4 | 1102 | } |
e6e244b6 AS |
1103 | EXPORT_SYMBOL_GPL(usb_stor_disconnect); |
1104 | ||
aa519be3 AM |
1105 | static struct scsi_host_template usb_stor_host_template; |
1106 | ||
e6e244b6 AS |
1107 | /* The main probe routine for standard devices */ |
1108 | static int storage_probe(struct usb_interface *intf, | |
1109 | const struct usb_device_id *id) | |
1110 | { | |
fd7ff36d | 1111 | struct us_unusual_dev *unusual_dev; |
e6e244b6 AS |
1112 | struct us_data *us; |
1113 | int result; | |
fd7ff36d | 1114 | int size; |
e6e244b6 | 1115 | |
5bfd5b5d HG |
1116 | /* If uas is enabled and this device can do uas then ignore it. */ |
1117 | #if IS_ENABLED(CONFIG_USB_UAS) | |
a5011d44 | 1118 | if (uas_use_uas_driver(intf, id, NULL)) |
5bfd5b5d HG |
1119 | return -ENXIO; |
1120 | #endif | |
1121 | ||
e6e244b6 | 1122 | /* |
e6e244b6 AS |
1123 | * If the device isn't standard (is handled by a subdriver |
1124 | * module) then don't accept it. | |
1125 | */ | |
f61870ee | 1126 | if (usb_usual_ignore_device(intf)) |
e6e244b6 AS |
1127 | return -ENXIO; |
1128 | ||
1129 | /* | |
1130 | * Call the general probe procedures. | |
1131 | * | |
1132 | * The unusual_dev_list array is parallel to the usb_storage_usb_ids | |
1133 | * table, so we use the index of the id entry to find the | |
1134 | * corresponding unusual_devs entry. | |
1135 | */ | |
fd7ff36d HL |
1136 | |
1137 | size = ARRAY_SIZE(us_unusual_dev_list); | |
1138 | if (id >= usb_storage_usb_ids && id < usb_storage_usb_ids + size) { | |
1139 | unusual_dev = (id - usb_storage_usb_ids) + us_unusual_dev_list; | |
1140 | } else { | |
1141 | unusual_dev = &for_dynamic_ids; | |
1142 | ||
191648d0 | 1143 | dev_dbg(&intf->dev, "Use Bulk-Only transport with the Transparent SCSI protocol for dynamic id: 0x%04x 0x%04x\n", |
fd7ff36d HL |
1144 | id->idVendor, id->idProduct); |
1145 | } | |
1146 | ||
aa519be3 AM |
1147 | result = usb_stor_probe1(&us, intf, id, unusual_dev, |
1148 | &usb_stor_host_template); | |
e6e244b6 AS |
1149 | if (result) |
1150 | return result; | |
1151 | ||
1152 | /* No special transport or protocol settings in the main module */ | |
1153 | ||
1154 | result = usb_stor_probe2(us); | |
1155 | return result; | |
1156 | } | |
1da177e4 | 1157 | |
ce2596df | 1158 | static struct usb_driver usb_storage_driver = { |
aa519be3 | 1159 | .name = DRV_NAME, |
ce2596df | 1160 | .probe = storage_probe, |
e6e244b6 AS |
1161 | .disconnect = usb_stor_disconnect, |
1162 | .suspend = usb_stor_suspend, | |
1163 | .resume = usb_stor_resume, | |
1164 | .reset_resume = usb_stor_reset_resume, | |
1165 | .pre_reset = usb_stor_pre_reset, | |
1166 | .post_reset = usb_stor_post_reset, | |
1167 | .id_table = usb_storage_usb_ids, | |
f283925f | 1168 | .supports_autosuspend = 1, |
543f7810 | 1169 | .soft_unbind = 1, |
ce2596df AS |
1170 | }; |
1171 | ||
aa519be3 | 1172 | module_usb_stor_driver(usb_storage_driver, usb_stor_host_template, DRV_NAME); |