blob: 5eb895b19c5584fe44f5befab26e1ae84efb56e3 [file] [log] [blame]
Greg Kroah-Hartman5fd54ac2017-11-03 11:28:30 +01001// SPDX-License-Identifier: GPL-2.0+
Felipe Balbif0183a32016-04-18 13:09:11 +03002/*
3 * Driver for USB Mass Storage compliant devices
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07005 * Current development and maintenance by:
6 * (c) 1999-2002 Matthew Dharm (mdharm-usb@one-eyed-alien.net)
7 *
8 * Developed with the assistance of:
9 * (c) 2000 David L. Brown, Jr. (usb-storage@davidb.org)
10 * (c) 2000 Stephen J. Gowdy (SGowdy@lbl.gov)
11 * (c) 2002 Alan Stern <stern@rowland.org>
12 *
13 * Initial work by:
14 * (c) 1999 Michael Gee (michael@linuxspecific.com)
15 *
16 * This driver is based on the 'USB Mass Storage Class' document. This
17 * describes in detail the protocol used to communicate with such
18 * devices. Clearly, the designers had SCSI and ATAPI commands in
19 * mind when they created this document. The commands are all very
20 * similar to commands in the SCSI-II and ATAPI specifications.
21 *
22 * It is important to note that in a number of cases this class
23 * exhibits class-specific exemptions from the USB specification.
24 * Notably the usage of NAK, STALL and ACK differs from the norm, in
25 * that they are used to communicate wait, failed and OK on commands.
26 *
27 * Also, for certain devices, the interrupt endpoint is used to convey
28 * status of a command.
Linus Torvalds1da177e2005-04-16 15:20:36 -070029 */
30
Linus Torvalds1da177e2005-04-16 15:20:36 -070031#include <linux/sched.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090032#include <linux/gfp.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070033#include <linux/errno.h>
Paul Gortmakerf940fcd2011-05-27 09:56:31 -040034#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070035
Oliver Neukum5d398772009-12-18 12:14:21 +010036#include <linux/usb/quirks.h>
37
Linus Torvalds1da177e2005-04-16 15:20:36 -070038#include <scsi/scsi.h>
Boaz Harroshdff6de72007-09-10 22:36:31 +030039#include <scsi/scsi_eh.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070040#include <scsi/scsi_device.h>
41
42#include "usb.h"
43#include "transport.h"
44#include "protocol.h"
45#include "scsiglue.h"
46#include "debug.h"
47
Alan Stern25ff1c32008-12-15 12:43:41 -050048#include <linux/blkdev.h>
49#include "../../scsi/sd.h"
50
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
52/***********************************************************************
53 * Data transfer routines
54 ***********************************************************************/
55
56/*
57 * This is subtle, so pay attention:
58 * ---------------------------------
59 * We're very concerned about races with a command abort. Hanging this code
60 * is a sure fire way to hang the kernel. (Note that this discussion applies
61 * only to transactions resulting from a scsi queued-command, since only
62 * these transactions are subject to a scsi abort. Other transactions, such
63 * as those occurring during device-specific initialization, must be handled
64 * by a separate code path.)
65 *
66 * The abort function (usb_storage_command_abort() in scsiglue.c) first
Alan Stern7e4d6c32008-05-01 15:35:18 -040067 * sets the machine state and the ABORTING bit in us->dflags to prevent
Linus Torvalds1da177e2005-04-16 15:20:36 -070068 * new URBs from being submitted. It then calls usb_stor_stop_transport()
Alan Stern7e4d6c32008-05-01 15:35:18 -040069 * below, which atomically tests-and-clears the URB_ACTIVE bit in us->dflags
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 * to see if the current_urb needs to be stopped. Likewise, the SG_ACTIVE
71 * bit is tested to see if the current_sg scatter-gather request needs to be
72 * stopped. The timeout callback routine does much the same thing.
73 *
Alan Stern7e4d6c32008-05-01 15:35:18 -040074 * When a disconnect occurs, the DISCONNECTING bit in us->dflags is set to
Linus Torvalds1da177e2005-04-16 15:20:36 -070075 * prevent new URBs from being submitted, and usb_stor_stop_transport() is
76 * called to stop any ongoing requests.
77 *
78 * The submit function first verifies that the submitting is allowed
79 * (neither ABORTING nor DISCONNECTING bits are set) and that the submit
80 * completes without errors, and only then sets the URB_ACTIVE bit. This
81 * prevents the stop_transport() function from trying to cancel the URB
82 * while the submit call is underway. Next, the submit function must test
83 * the flags to see if an abort or disconnect occurred during the submission
84 * or before the URB_ACTIVE bit was set. If so, it's essential to cancel
85 * the URB if it hasn't been cancelled already (i.e., if the URB_ACTIVE bit
86 * is still set). Either way, the function must then wait for the URB to
Alan Sternb375a042005-07-29 16:11:07 -040087 * finish. Note that the URB can still be in progress even after a call to
88 * usb_unlink_urb() returns.
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 *
90 * The idea is that (1) once the ABORTING or DISCONNECTING bit is set,
91 * either the stop_transport() function or the submitting function
92 * is guaranteed to call usb_unlink_urb() for an active URB,
93 * and (2) test_and_clear_bit() prevents usb_unlink_urb() from being
94 * called more than once or from being called during usb_submit_urb().
95 */
96
Felipe Balbif0183a32016-04-18 13:09:11 +030097/*
98 * This is the completion handler which will wake us up when an URB
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 * completes.
100 */
David Howells7d12e782006-10-05 14:55:46 +0100101static void usb_stor_blocking_completion(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102{
Ming Leicdc97792008-02-24 18:41:47 +0800103 struct completion *urb_done_ptr = urb->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
105 complete(urb_done_ptr);
106}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107
Felipe Balbif0183a32016-04-18 13:09:11 +0300108/*
109 * This is the common part of the URB message submission code
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 *
111 * All URBs from the usb-storage driver involved in handling a queued scsi
112 * command _must_ pass through this function (or something like it) for the
113 * abort mechanisms to work properly.
114 */
115static int usb_stor_msg_common(struct us_data *us, int timeout)
116{
117 struct completion urb_done;
Franck Bui-Huu3428cc42006-05-24 16:57:28 +0200118 long timeleft;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119 int status;
120
Alan Stern543f7812008-05-08 11:55:59 -0400121 /* don't submit URBs during abort processing */
122 if (test_bit(US_FLIDX_ABORTING, &us->dflags))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123 return -EIO;
124
125 /* set up data structures for the wakeup system */
126 init_completion(&urb_done);
127
128 /* fill the common fields in the URB */
129 us->current_urb->context = &urb_done;
Bob Copelandc222fb22010-07-12 11:18:18 -0400130 us->current_urb->transfer_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131
Felipe Balbif0183a32016-04-18 13:09:11 +0300132 /*
133 * we assume that if transfer_buffer isn't us->iobuf then it
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134 * hasn't been mapped for DMA. Yes, this is clunky, but it's
135 * easier than always having the caller tell us whether the
Felipe Balbif0183a32016-04-18 13:09:11 +0300136 * transfer buffer has already been mapped.
137 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138 if (us->current_urb->transfer_buffer == us->iobuf)
139 us->current_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
140 us->current_urb->transfer_dma = us->iobuf_dma;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
142 /* submit the URB */
143 status = usb_submit_urb(us->current_urb, GFP_NOIO);
144 if (status) {
145 /* something went wrong */
146 return status;
147 }
148
Felipe Balbif0183a32016-04-18 13:09:11 +0300149 /*
150 * since the URB has been submitted successfully, it's now okay
151 * to cancel it
152 */
Alan Stern7e4d6c32008-05-01 15:35:18 -0400153 set_bit(US_FLIDX_URB_ACTIVE, &us->dflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154
Alan Stern543f7812008-05-08 11:55:59 -0400155 /* did an abort occur during the submission? */
156 if (test_bit(US_FLIDX_ABORTING, &us->dflags)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
158 /* cancel the URB, if it hasn't been cancelled already */
Alan Stern7e4d6c32008-05-01 15:35:18 -0400159 if (test_and_clear_bit(US_FLIDX_URB_ACTIVE, &us->dflags)) {
Joe Perches191648d2013-04-19 11:44:00 -0700160 usb_stor_dbg(us, "-- cancelling URB\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 usb_unlink_urb(us->current_urb);
162 }
163 }
164
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 /* wait for the completion of the URB */
Franck Bui-Huu3428cc42006-05-24 16:57:28 +0200166 timeleft = wait_for_completion_interruptible_timeout(
167 &urb_done, timeout ? : MAX_SCHEDULE_TIMEOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168
Alan Stern7e4d6c32008-05-01 15:35:18 -0400169 clear_bit(US_FLIDX_URB_ACTIVE, &us->dflags);
Franck Bui-Huu3428cc42006-05-24 16:57:28 +0200170
171 if (timeleft <= 0) {
Joe Perches191648d2013-04-19 11:44:00 -0700172 usb_stor_dbg(us, "%s -- cancelling URB\n",
173 timeleft == 0 ? "Timeout" : "Signal");
Alan Sternd6b7d3b2006-07-10 04:44:47 -0700174 usb_kill_urb(us->current_urb);
Franck Bui-Huu3428cc42006-05-24 16:57:28 +0200175 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
177 /* return the URB status */
178 return us->current_urb->status;
179}
180
181/*
182 * Transfer one control message, with timeouts, and allowing early
183 * termination. Return codes are usual -Exxx, *not* USB_STOR_XFER_xxx.
184 */
185int usb_stor_control_msg(struct us_data *us, unsigned int pipe,
186 u8 request, u8 requesttype, u16 value, u16 index,
187 void *data, u16 size, int timeout)
188{
189 int status;
190
Joe Perches191648d2013-04-19 11:44:00 -0700191 usb_stor_dbg(us, "rq=%02x rqtype=%02x value=%04x index=%02x len=%u\n",
192 request, requesttype, value, index, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193
194 /* fill in the devrequest structure */
195 us->cr->bRequestType = requesttype;
196 us->cr->bRequest = request;
197 us->cr->wValue = cpu_to_le16(value);
198 us->cr->wIndex = cpu_to_le16(index);
199 us->cr->wLength = cpu_to_le16(size);
200
201 /* fill and submit the URB */
202 usb_fill_control_urb(us->current_urb, us->pusb_dev, pipe,
203 (unsigned char*) us->cr, data, size,
204 usb_stor_blocking_completion, NULL);
205 status = usb_stor_msg_common(us, timeout);
206
207 /* return the actual length of the data transferred if no error */
208 if (status == 0)
209 status = us->current_urb->actual_length;
210 return status;
211}
Alan Sterne6e244b2009-02-12 14:47:44 -0500212EXPORT_SYMBOL_GPL(usb_stor_control_msg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213
Felipe Balbif0183a32016-04-18 13:09:11 +0300214/*
215 * This is a version of usb_clear_halt() that allows early termination and
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216 * doesn't read the status from the device -- this is because some devices
217 * crash their internal firmware when the status is requested after a halt.
218 *
219 * A definitive list of these 'bad' devices is too difficult to maintain or
220 * make complete enough to be useful. This problem was first observed on the
221 * Hagiwara FlashGate DUAL unit. However, bus traces reveal that neither
222 * MacOS nor Windows checks the status after clearing a halt.
223 *
224 * Since many vendors in this space limit their testing to interoperability
225 * with these two OSes, specification violations like this one are common.
226 */
227int usb_stor_clear_halt(struct us_data *us, unsigned int pipe)
228{
229 int result;
230 int endp = usb_pipeendpoint(pipe);
231
232 if (usb_pipein (pipe))
233 endp |= USB_DIR_IN;
234
235 result = usb_stor_control_msg(us, us->send_ctrl_pipe,
236 USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT,
237 USB_ENDPOINT_HALT, endp,
238 NULL, 0, 3*HZ);
239
Matthew Dharm5203ad42005-06-06 17:19:29 -0700240 if (result >= 0)
David Vrabel3444b262009-04-08 17:36:28 +0000241 usb_reset_endpoint(us->pusb_dev, endp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242
Joe Perches191648d2013-04-19 11:44:00 -0700243 usb_stor_dbg(us, "result = %d\n", result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 return result;
245}
Alan Sterne6e244b2009-02-12 14:47:44 -0500246EXPORT_SYMBOL_GPL(usb_stor_clear_halt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
248
249/*
250 * Interpret the results of a URB transfer
251 *
252 * This function prints appropriate debugging messages, clears halts on
253 * non-control endpoints, and translates the status to the corresponding
254 * USB_STOR_XFER_xxx return code.
255 */
256static int interpret_urb_result(struct us_data *us, unsigned int pipe,
257 unsigned int length, int result, unsigned int partial)
258{
Joe Perches191648d2013-04-19 11:44:00 -0700259 usb_stor_dbg(us, "Status code %d; transferred %u/%u\n",
260 result, partial, length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 switch (result) {
262
263 /* no error code; did we send all the data? */
264 case 0:
265 if (partial != length) {
Joe Perches191648d2013-04-19 11:44:00 -0700266 usb_stor_dbg(us, "-- short transfer\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 return USB_STOR_XFER_SHORT;
268 }
269
Joe Perches191648d2013-04-19 11:44:00 -0700270 usb_stor_dbg(us, "-- transfer complete\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271 return USB_STOR_XFER_GOOD;
272
273 /* stalled */
274 case -EPIPE:
Felipe Balbif0183a32016-04-18 13:09:11 +0300275 /*
276 * for control endpoints, (used by CB[I]) a stall indicates
277 * a failed command
278 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279 if (usb_pipecontrol(pipe)) {
Joe Perches191648d2013-04-19 11:44:00 -0700280 usb_stor_dbg(us, "-- stall on control pipe\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281 return USB_STOR_XFER_STALLED;
282 }
283
284 /* for other sorts of endpoint, clear the stall */
Joe Perches191648d2013-04-19 11:44:00 -0700285 usb_stor_dbg(us, "clearing endpoint halt for pipe 0x%x\n",
286 pipe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 if (usb_stor_clear_halt(us, pipe) < 0)
288 return USB_STOR_XFER_ERROR;
289 return USB_STOR_XFER_STALLED;
290
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291 /* babble - the device tried to send more than we wanted to read */
292 case -EOVERFLOW:
Joe Perches191648d2013-04-19 11:44:00 -0700293 usb_stor_dbg(us, "-- babble\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 return USB_STOR_XFER_LONG;
295
296 /* the transfer was cancelled by abort, disconnect, or timeout */
297 case -ECONNRESET:
Joe Perches191648d2013-04-19 11:44:00 -0700298 usb_stor_dbg(us, "-- transfer cancelled\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299 return USB_STOR_XFER_ERROR;
300
301 /* short scatter-gather read transfer */
302 case -EREMOTEIO:
Joe Perches191648d2013-04-19 11:44:00 -0700303 usb_stor_dbg(us, "-- short read transfer\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 return USB_STOR_XFER_SHORT;
305
306 /* abort or disconnect in progress */
307 case -EIO:
Joe Perches191648d2013-04-19 11:44:00 -0700308 usb_stor_dbg(us, "-- abort or disconnect in progress\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309 return USB_STOR_XFER_ERROR;
310
311 /* the catch-all error case */
312 default:
Joe Perches191648d2013-04-19 11:44:00 -0700313 usb_stor_dbg(us, "-- unknown error\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314 return USB_STOR_XFER_ERROR;
315 }
316}
317
318/*
319 * Transfer one control message, without timeouts, but allowing early
320 * termination. Return codes are USB_STOR_XFER_xxx.
321 */
322int usb_stor_ctrl_transfer(struct us_data *us, unsigned int pipe,
323 u8 request, u8 requesttype, u16 value, u16 index,
324 void *data, u16 size)
325{
326 int result;
327
Joe Perches191648d2013-04-19 11:44:00 -0700328 usb_stor_dbg(us, "rq=%02x rqtype=%02x value=%04x index=%02x len=%u\n",
329 request, requesttype, value, index, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330
331 /* fill in the devrequest structure */
332 us->cr->bRequestType = requesttype;
333 us->cr->bRequest = request;
334 us->cr->wValue = cpu_to_le16(value);
335 us->cr->wIndex = cpu_to_le16(index);
336 us->cr->wLength = cpu_to_le16(size);
337
338 /* fill and submit the URB */
339 usb_fill_control_urb(us->current_urb, us->pusb_dev, pipe,
340 (unsigned char*) us->cr, data, size,
341 usb_stor_blocking_completion, NULL);
342 result = usb_stor_msg_common(us, 0);
343
344 return interpret_urb_result(us, pipe, size, result,
345 us->current_urb->actual_length);
346}
Alan Sterne6e244b2009-02-12 14:47:44 -0500347EXPORT_SYMBOL_GPL(usb_stor_ctrl_transfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348
349/*
350 * Receive one interrupt buffer, without timeouts, but allowing early
351 * termination. Return codes are USB_STOR_XFER_xxx.
352 *
353 * This routine always uses us->recv_intr_pipe as the pipe and
354 * us->ep_bInterval as the interrupt interval.
355 */
356static int usb_stor_intr_transfer(struct us_data *us, void *buf,
357 unsigned int length)
358{
359 int result;
360 unsigned int pipe = us->recv_intr_pipe;
361 unsigned int maxp;
362
Joe Perches191648d2013-04-19 11:44:00 -0700363 usb_stor_dbg(us, "xfer %u bytes\n", length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364
365 /* calculate the max packet size */
366 maxp = usb_maxpacket(us->pusb_dev, pipe, usb_pipeout(pipe));
367 if (maxp > length)
368 maxp = length;
369
370 /* fill and submit the URB */
371 usb_fill_int_urb(us->current_urb, us->pusb_dev, pipe, buf,
372 maxp, usb_stor_blocking_completion, NULL,
373 us->ep_bInterval);
374 result = usb_stor_msg_common(us, 0);
375
376 return interpret_urb_result(us, pipe, length, result,
377 us->current_urb->actual_length);
378}
379
380/*
381 * Transfer one buffer via bulk pipe, without timeouts, but allowing early
382 * termination. Return codes are USB_STOR_XFER_xxx. If the bulk pipe
383 * stalls during the transfer, the halt is automatically cleared.
384 */
385int usb_stor_bulk_transfer_buf(struct us_data *us, unsigned int pipe,
386 void *buf, unsigned int length, unsigned int *act_len)
387{
388 int result;
389
Joe Perches191648d2013-04-19 11:44:00 -0700390 usb_stor_dbg(us, "xfer %u bytes\n", length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391
392 /* fill and submit the URB */
393 usb_fill_bulk_urb(us->current_urb, us->pusb_dev, pipe, buf, length,
394 usb_stor_blocking_completion, NULL);
395 result = usb_stor_msg_common(us, 0);
396
397 /* store the actual length of the data transferred */
398 if (act_len)
399 *act_len = us->current_urb->actual_length;
400 return interpret_urb_result(us, pipe, length, result,
401 us->current_urb->actual_length);
402}
Alan Sterne6e244b2009-02-12 14:47:44 -0500403EXPORT_SYMBOL_GPL(usb_stor_bulk_transfer_buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404
405/*
406 * Transfer a scatter-gather list via bulk transfer
407 *
408 * This function does basically the same thing as usb_stor_bulk_transfer_buf()
409 * above, but it uses the usbcore scatter-gather library.
410 */
411static int usb_stor_bulk_transfer_sglist(struct us_data *us, unsigned int pipe,
412 struct scatterlist *sg, int num_sg, unsigned int length,
413 unsigned int *act_len)
414{
415 int result;
416
Alan Stern543f7812008-05-08 11:55:59 -0400417 /* don't submit s-g requests during abort processing */
418 if (test_bit(US_FLIDX_ABORTING, &us->dflags))
Lukas Bulwahn6a6516c2020-11-12 20:12:55 +0100419 goto usb_stor_xfer_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420
421 /* initialize the scatter-gather request block */
Joe Perches191648d2013-04-19 11:44:00 -0700422 usb_stor_dbg(us, "xfer %u bytes, %d entries\n", length, num_sg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 result = usb_sg_init(&us->current_sg, us->pusb_dev, pipe, 0,
Christoph Lameter55acbda2006-12-06 20:33:13 -0800424 sg, num_sg, length, GFP_NOIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 if (result) {
Joe Perches191648d2013-04-19 11:44:00 -0700426 usb_stor_dbg(us, "usb_sg_init returned %d\n", result);
Lukas Bulwahn6a6516c2020-11-12 20:12:55 +0100427 goto usb_stor_xfer_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 }
429
Felipe Balbif0183a32016-04-18 13:09:11 +0300430 /*
431 * since the block has been initialized successfully, it's now
432 * okay to cancel it
433 */
Alan Stern7e4d6c32008-05-01 15:35:18 -0400434 set_bit(US_FLIDX_SG_ACTIVE, &us->dflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435
Alan Stern543f7812008-05-08 11:55:59 -0400436 /* did an abort occur during the submission? */
437 if (test_bit(US_FLIDX_ABORTING, &us->dflags)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438
439 /* cancel the request, if it hasn't been cancelled already */
Alan Stern7e4d6c32008-05-01 15:35:18 -0400440 if (test_and_clear_bit(US_FLIDX_SG_ACTIVE, &us->dflags)) {
Joe Perches191648d2013-04-19 11:44:00 -0700441 usb_stor_dbg(us, "-- cancelling sg request\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442 usb_sg_cancel(&us->current_sg);
443 }
444 }
445
446 /* wait for the completion of the transfer */
447 usb_sg_wait(&us->current_sg);
Alan Stern7e4d6c32008-05-01 15:35:18 -0400448 clear_bit(US_FLIDX_SG_ACTIVE, &us->dflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449
450 result = us->current_sg.status;
451 if (act_len)
452 *act_len = us->current_sg.bytes;
453 return interpret_urb_result(us, pipe, length, result,
454 us->current_sg.bytes);
Lukas Bulwahn6a6516c2020-11-12 20:12:55 +0100455
456usb_stor_xfer_error:
457 if (act_len)
458 *act_len = 0;
459 return USB_STOR_XFER_ERROR;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700460}
461
462/*
Boaz Harrosh6d416e62007-09-10 18:01:08 +0300463 * Common used function. Transfer a complete command
464 * via usb_stor_bulk_transfer_sglist() above. Set cmnd resid
465 */
466int usb_stor_bulk_srb(struct us_data* us, unsigned int pipe,
467 struct scsi_cmnd* srb)
468{
469 unsigned int partial;
470 int result = usb_stor_bulk_transfer_sglist(us, pipe, scsi_sglist(srb),
471 scsi_sg_count(srb), scsi_bufflen(srb),
472 &partial);
473
474 scsi_set_resid(srb, scsi_bufflen(srb) - partial);
475 return result;
476}
Alan Sterne6e244b2009-02-12 14:47:44 -0500477EXPORT_SYMBOL_GPL(usb_stor_bulk_srb);
Boaz Harrosh6d416e62007-09-10 18:01:08 +0300478
479/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480 * Transfer an entire SCSI command's worth of data payload over the bulk
481 * pipe.
482 *
483 * Note that this uses usb_stor_bulk_transfer_buf() and
484 * usb_stor_bulk_transfer_sglist() to achieve its goals --
485 * this function simply determines whether we're going to use
486 * scatter-gather or not, and acts appropriately.
487 */
488int usb_stor_bulk_transfer_sg(struct us_data* us, unsigned int pipe,
489 void *buf, unsigned int length_left, int use_sg, int *residual)
490{
491 int result;
492 unsigned int partial;
493
494 /* are we scatter-gathering? */
495 if (use_sg) {
496 /* use the usb core scatter-gather primitives */
497 result = usb_stor_bulk_transfer_sglist(us, pipe,
498 (struct scatterlist *) buf, use_sg,
499 length_left, &partial);
500 length_left -= partial;
501 } else {
502 /* no scatter-gather, just make the request */
503 result = usb_stor_bulk_transfer_buf(us, pipe, buf,
504 length_left, &partial);
505 length_left -= partial;
506 }
507
508 /* store the residual and return the error code */
509 if (residual)
510 *residual = length_left;
511 return result;
512}
Alan Sterne6e244b2009-02-12 14:47:44 -0500513EXPORT_SYMBOL_GPL(usb_stor_bulk_transfer_sg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514
515/***********************************************************************
516 * Transport routines
517 ***********************************************************************/
518
Felipe Balbif0183a32016-04-18 13:09:11 +0300519/*
520 * There are so many devices that report the capacity incorrectly,
Alan Stern25ff1c32008-12-15 12:43:41 -0500521 * this routine was written to counteract some of the resulting
522 * problems.
523 */
524static void last_sector_hacks(struct us_data *us, struct scsi_cmnd *srb)
525{
526 struct gendisk *disk;
527 struct scsi_disk *sdkp;
528 u32 sector;
529
530 /* To Report "Medium Error: Record Not Found */
531 static unsigned char record_not_found[18] = {
532 [0] = 0x70, /* current error */
533 [2] = MEDIUM_ERROR, /* = 0x03 */
534 [7] = 0x0a, /* additional length */
535 [12] = 0x14 /* Record Not Found */
536 };
537
Felipe Balbif0183a32016-04-18 13:09:11 +0300538 /*
539 * If last-sector problems can't occur, whether because the
Alan Stern25ff1c32008-12-15 12:43:41 -0500540 * capacity was already decremented or because the device is
541 * known to report the correct capacity, then we don't need
542 * to do anything.
543 */
544 if (!us->use_last_sector_hacks)
545 return;
546
547 /* Was this command a READ(10) or a WRITE(10)? */
548 if (srb->cmnd[0] != READ_10 && srb->cmnd[0] != WRITE_10)
549 goto done;
550
551 /* Did this command access the last sector? */
552 sector = (srb->cmnd[2] << 24) | (srb->cmnd[3] << 16) |
553 (srb->cmnd[4] << 8) | (srb->cmnd[5]);
554 disk = srb->request->rq_disk;
555 if (!disk)
556 goto done;
557 sdkp = scsi_disk(disk);
558 if (!sdkp)
559 goto done;
560 if (sector + 1 != sdkp->capacity)
561 goto done;
562
563 if (srb->result == SAM_STAT_GOOD && scsi_get_resid(srb) == 0) {
564
Felipe Balbif0183a32016-04-18 13:09:11 +0300565 /*
566 * The command succeeded. We know this device doesn't
Alan Stern0d020aa2009-02-02 09:51:01 -0500567 * have the last-sector bug, so stop checking it.
Alan Stern25ff1c32008-12-15 12:43:41 -0500568 */
Alan Stern0d020aa2009-02-02 09:51:01 -0500569 us->use_last_sector_hacks = 0;
Alan Stern25ff1c32008-12-15 12:43:41 -0500570
571 } else {
Felipe Balbif0183a32016-04-18 13:09:11 +0300572 /*
573 * The command failed. Allow up to 3 retries in case this
Alan Stern25ff1c32008-12-15 12:43:41 -0500574 * is some normal sort of failure. After that, assume the
575 * capacity is wrong and we're trying to access the sector
576 * beyond the end. Replace the result code and sense data
577 * with values that will cause the SCSI core to fail the
578 * command immediately, instead of going into an infinite
579 * (or even just a very long) retry loop.
580 */
581 if (++us->last_sector_retries < 3)
582 return;
583 srb->result = SAM_STAT_CHECK_CONDITION;
584 memcpy(srb->sense_buffer, record_not_found,
585 sizeof(record_not_found));
Alan Stern25ff1c32008-12-15 12:43:41 -0500586 }
587
588 done:
Felipe Balbif0183a32016-04-18 13:09:11 +0300589 /*
590 * Don't reset the retry counter for TEST UNIT READY commands,
Alan Stern25ff1c32008-12-15 12:43:41 -0500591 * because they get issued after device resets which might be
592 * caused by a failed last-sector access.
593 */
594 if (srb->cmnd[0] != TEST_UNIT_READY)
595 us->last_sector_retries = 0;
596}
597
Felipe Balbif0183a32016-04-18 13:09:11 +0300598/*
599 * Invoke the transport and basic error-handling/recovery methods
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 *
601 * This is used by the protocol layers to actually send the message to
602 * the device and receive the response.
603 */
604void usb_stor_invoke_transport(struct scsi_cmnd *srb, struct us_data *us)
605{
606 int need_auto_sense;
607 int result;
608
609 /* send the command to the transport layer */
Boaz Harrosh6d416e62007-09-10 18:01:08 +0300610 scsi_set_resid(srb, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 result = us->transport(srb, us);
612
Felipe Balbif0183a32016-04-18 13:09:11 +0300613 /*
614 * if the command gets aborted by the higher layers, we need to
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 * short-circuit all other processing
616 */
Alan Stern7e4d6c32008-05-01 15:35:18 -0400617 if (test_bit(US_FLIDX_TIMED_OUT, &us->dflags)) {
Joe Perches191648d2013-04-19 11:44:00 -0700618 usb_stor_dbg(us, "-- command was aborted\n");
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700619 srb->result = DID_ABORT << 16;
620 goto Handle_Errors;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 }
622
623 /* if there is a transport error, reset and don't auto-sense */
624 if (result == USB_STOR_TRANSPORT_ERROR) {
Joe Perches191648d2013-04-19 11:44:00 -0700625 usb_stor_dbg(us, "-- transport indicates error, resetting\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 srb->result = DID_ERROR << 16;
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700627 goto Handle_Errors;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700628 }
629
630 /* if the transport provided its own sense data, don't auto-sense */
631 if (result == USB_STOR_TRANSPORT_NO_SENSE) {
632 srb->result = SAM_STAT_CHECK_CONDITION;
Alan Stern25ff1c32008-12-15 12:43:41 -0500633 last_sector_hacks(us, srb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 return;
635 }
636
637 srb->result = SAM_STAT_GOOD;
638
Felipe Balbif0183a32016-04-18 13:09:11 +0300639 /*
640 * Determine if we need to auto-sense
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 *
642 * I normally don't use a flag like this, but it's almost impossible
643 * to understand what's going on here if I don't.
644 */
645 need_auto_sense = 0;
646
647 /*
648 * If we're running the CB transport, which is incapable
649 * of determining status on its own, we will auto-sense
650 * unless the operation involved a data-in transfer. Devices
651 * can signal most data-in errors by stalling the bulk-in pipe.
652 */
Michal Nazarewicz8fa7fd72010-10-07 13:05:21 +0200653 if ((us->protocol == USB_PR_CB || us->protocol == USB_PR_DPCM_USB) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 srb->sc_data_direction != DMA_FROM_DEVICE) {
Joe Perches191648d2013-04-19 11:44:00 -0700655 usb_stor_dbg(us, "-- CB transport device requiring auto-sense\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 need_auto_sense = 1;
657 }
658
659 /*
660 * If we have a failure, we're going to do a REQUEST_SENSE
661 * automatically. Note that we differentiate between a command
662 * "failure" and an "error" in the transport mechanism.
663 */
664 if (result == USB_STOR_TRANSPORT_FAILED) {
Joe Perches191648d2013-04-19 11:44:00 -0700665 usb_stor_dbg(us, "-- transport indicates command failure\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 need_auto_sense = 1;
667 }
668
669 /*
Ben Efros1537e0a2008-11-18 13:31:13 -0800670 * Determine if this device is SAT by seeing if the
671 * command executed successfully. Otherwise we'll have
672 * to wait for at least one CHECK_CONDITION to determine
673 * SANE_SENSE support
674 */
Alan Sterna0bb1082009-12-07 16:39:16 -0500675 if (unlikely((srb->cmnd[0] == ATA_16 || srb->cmnd[0] == ATA_12) &&
Ben Efros1537e0a2008-11-18 13:31:13 -0800676 result == USB_STOR_TRANSPORT_GOOD &&
677 !(us->fflags & US_FL_SANE_SENSE) &&
Alan Sterna0bb1082009-12-07 16:39:16 -0500678 !(us->fflags & US_FL_BAD_SENSE) &&
679 !(srb->cmnd[2] & 0x20))) {
Joe Perches191648d2013-04-19 11:44:00 -0700680 usb_stor_dbg(us, "-- SAT supported, increasing auto-sense\n");
Ben Efros1537e0a2008-11-18 13:31:13 -0800681 us->fflags |= US_FL_SANE_SENSE;
682 }
683
684 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685 * A short transfer on a command where we don't expect it
686 * is unusual, but it doesn't mean we need to auto-sense.
687 */
Boaz Harrosh6d416e62007-09-10 18:01:08 +0300688 if ((scsi_get_resid(srb) > 0) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689 !((srb->cmnd[0] == REQUEST_SENSE) ||
690 (srb->cmnd[0] == INQUIRY) ||
691 (srb->cmnd[0] == MODE_SENSE) ||
692 (srb->cmnd[0] == LOG_SENSE) ||
693 (srb->cmnd[0] == MODE_SENSE_10))) {
Joe Perches191648d2013-04-19 11:44:00 -0700694 usb_stor_dbg(us, "-- unexpectedly short transfer\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 }
696
697 /* Now, if we need to do the auto-sense, let's do it */
698 if (need_auto_sense) {
699 int temp_result;
Boaz Harroshdff6de72007-09-10 22:36:31 +0300700 struct scsi_eh_save ses;
Ben Efros1537e0a2008-11-18 13:31:13 -0800701 int sense_size = US_SENSE_SIZE;
Luben Tuikove16da02f2010-11-11 15:43:11 -0800702 struct scsi_sense_hdr sshdr;
703 const u8 *scdd;
704 u8 fm_ili;
Ben Efros1537e0a2008-11-18 13:31:13 -0800705
706 /* device supports and needs bigger sense buffer */
707 if (us->fflags & US_FL_SANE_SENSE)
708 sense_size = ~0;
Benjamin Herrenschmidtb8430e12009-10-13 15:53:47 +1100709Retry_Sense:
Joe Perches191648d2013-04-19 11:44:00 -0700710 usb_stor_dbg(us, "Issuing auto-REQUEST_SENSE\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711
Ben Efros1537e0a2008-11-18 13:31:13 -0800712 scsi_eh_prep_cmnd(srb, &ses, NULL, 0, sense_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713
714 /* FIXME: we must do the protocol translation here */
Michal Nazarewicz8fa7fd72010-10-07 13:05:21 +0200715 if (us->subclass == USB_SC_RBC || us->subclass == USB_SC_SCSI ||
716 us->subclass == USB_SC_CYP_ATACB)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717 srb->cmd_len = 6;
718 else
719 srb->cmd_len = 12;
720
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721 /* issue the auto-sense command */
Boaz Harrosh6d416e62007-09-10 18:01:08 +0300722 scsi_set_resid(srb, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 temp_result = us->transport(us->srb, us);
724
725 /* let's clean up right away */
Boaz Harroshdff6de72007-09-10 22:36:31 +0300726 scsi_eh_restore_cmnd(srb, &ses);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727
Alan Stern7e4d6c32008-05-01 15:35:18 -0400728 if (test_bit(US_FLIDX_TIMED_OUT, &us->dflags)) {
Joe Perches191648d2013-04-19 11:44:00 -0700729 usb_stor_dbg(us, "-- auto-sense aborted\n");
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700730 srb->result = DID_ABORT << 16;
Alan Sterna0bb1082009-12-07 16:39:16 -0500731
732 /* If SANE_SENSE caused this problem, disable it */
733 if (sense_size != US_SENSE_SIZE) {
734 us->fflags &= ~US_FL_SANE_SENSE;
735 us->fflags |= US_FL_BAD_SENSE;
736 }
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700737 goto Handle_Errors;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 }
Benjamin Herrenschmidtb8430e12009-10-13 15:53:47 +1100739
Felipe Balbif0183a32016-04-18 13:09:11 +0300740 /*
741 * Some devices claim to support larger sense but fail when
Benjamin Herrenschmidtb8430e12009-10-13 15:53:47 +1100742 * trying to request it. When a transport failure happens
743 * using US_FS_SANE_SENSE, we always retry with a standard
744 * (small) sense request. This fixes some USB GSM modems
745 */
746 if (temp_result == USB_STOR_TRANSPORT_FAILED &&
Alan Sterna0bb1082009-12-07 16:39:16 -0500747 sense_size != US_SENSE_SIZE) {
Joe Perches191648d2013-04-19 11:44:00 -0700748 usb_stor_dbg(us, "-- auto-sense failure, retry small sense\n");
Benjamin Herrenschmidtb8430e12009-10-13 15:53:47 +1100749 sense_size = US_SENSE_SIZE;
Alan Sterna0bb1082009-12-07 16:39:16 -0500750 us->fflags &= ~US_FL_SANE_SENSE;
751 us->fflags |= US_FL_BAD_SENSE;
Benjamin Herrenschmidtb8430e12009-10-13 15:53:47 +1100752 goto Retry_Sense;
753 }
754
755 /* Other failures */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 if (temp_result != USB_STOR_TRANSPORT_GOOD) {
Joe Perches191648d2013-04-19 11:44:00 -0700757 usb_stor_dbg(us, "-- auto-sense failure\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758
Felipe Balbif0183a32016-04-18 13:09:11 +0300759 /*
760 * we skip the reset if this happens to be a
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 * multi-target device, since failure of an
762 * auto-sense is perfectly valid
763 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764 srb->result = DID_ERROR << 16;
Alan Stern7e4d6c32008-05-01 15:35:18 -0400765 if (!(us->fflags & US_FL_SCM_MULT_TARG))
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700766 goto Handle_Errors;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 return;
768 }
769
Felipe Balbif0183a32016-04-18 13:09:11 +0300770 /*
771 * If the sense data returned is larger than 18-bytes then we
Ben Efros1537e0a2008-11-18 13:31:13 -0800772 * assume this device supports requesting more in the future.
773 * The response code must be 70h through 73h inclusive.
774 */
775 if (srb->sense_buffer[7] > (US_SENSE_SIZE - 8) &&
776 !(us->fflags & US_FL_SANE_SENSE) &&
Alan Sterna0bb1082009-12-07 16:39:16 -0500777 !(us->fflags & US_FL_BAD_SENSE) &&
Ben Efros1537e0a2008-11-18 13:31:13 -0800778 (srb->sense_buffer[0] & 0x7C) == 0x70) {
Joe Perches191648d2013-04-19 11:44:00 -0700779 usb_stor_dbg(us, "-- SANE_SENSE support enabled\n");
Ben Efros1537e0a2008-11-18 13:31:13 -0800780 us->fflags |= US_FL_SANE_SENSE;
781
Felipe Balbif0183a32016-04-18 13:09:11 +0300782 /*
783 * Indicate to the user that we truncated their sense
Ben Efros1537e0a2008-11-18 13:31:13 -0800784 * because we didn't know it supported larger sense.
785 */
Joe Perches191648d2013-04-19 11:44:00 -0700786 usb_stor_dbg(us, "-- Sense data truncated to %i from %i\n",
787 US_SENSE_SIZE,
788 srb->sense_buffer[7] + 8);
Ben Efros1537e0a2008-11-18 13:31:13 -0800789 srb->sense_buffer[7] = (US_SENSE_SIZE - 8);
790 }
791
Luben Tuikove16da02f2010-11-11 15:43:11 -0800792 scsi_normalize_sense(srb->sense_buffer, SCSI_SENSE_BUFFERSIZE,
793 &sshdr);
794
Joe Perches191648d2013-04-19 11:44:00 -0700795 usb_stor_dbg(us, "-- Result from auto-sense is %d\n",
796 temp_result);
797 usb_stor_dbg(us, "-- code: 0x%x, key: 0x%x, ASC: 0x%x, ASCQ: 0x%x\n",
798 sshdr.response_code, sshdr.sense_key,
799 sshdr.asc, sshdr.ascq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800#ifdef CONFIG_USB_STORAGE_DEBUG
Joe Perches191648d2013-04-19 11:44:00 -0700801 usb_stor_show_sense(us, sshdr.sense_key, sshdr.asc, sshdr.ascq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802#endif
803
804 /* set the result so the higher layers expect this data */
805 srb->result = SAM_STAT_CHECK_CONDITION;
806
Luben Tuikove16da02f2010-11-11 15:43:11 -0800807 scdd = scsi_sense_desc_find(srb->sense_buffer,
808 SCSI_SENSE_BUFFERSIZE, 4);
809 fm_ili = (scdd ? scdd[3] : srb->sense_buffer[2]) & 0xA0;
810
Felipe Balbif0183a32016-04-18 13:09:11 +0300811 /*
812 * We often get empty sense data. This could indicate that
Alan Sternf1a07432009-10-06 14:07:57 -0400813 * everything worked or that there was an unspecified
814 * problem. We have to decide which.
815 */
Luben Tuikove16da02f2010-11-11 15:43:11 -0800816 if (sshdr.sense_key == 0 && sshdr.asc == 0 && sshdr.ascq == 0 &&
817 fm_ili == 0) {
Felipe Balbif0183a32016-04-18 13:09:11 +0300818 /*
819 * If things are really okay, then let's show that.
Alan Sternf1a07432009-10-06 14:07:57 -0400820 * Zero out the sense buffer so the higher layers
821 * won't realize we did an unsolicited auto-sense.
822 */
823 if (result == USB_STOR_TRANSPORT_GOOD) {
824 srb->result = SAM_STAT_GOOD;
825 srb->sense_buffer[0] = 0x0;
Alan Sterna4fd4a72017-09-21 16:02:05 -0400826 }
827
828 /*
829 * ATA-passthru commands use sense data to report
830 * the command completion status, and often devices
831 * return Check Condition status when nothing is
832 * wrong.
833 */
834 else if (srb->cmnd[0] == ATA_16 ||
835 srb->cmnd[0] == ATA_12) {
836 /* leave the data alone */
837 }
Alan Sternf1a07432009-10-06 14:07:57 -0400838
Felipe Balbif0183a32016-04-18 13:09:11 +0300839 /*
840 * If there was a problem, report an unspecified
Alan Sternf1a07432009-10-06 14:07:57 -0400841 * hardware error to prevent the higher layers from
842 * entering an infinite retry loop.
843 */
Alan Sterna4fd4a72017-09-21 16:02:05 -0400844 else {
Alan Sternf1a07432009-10-06 14:07:57 -0400845 srb->result = DID_ERROR << 16;
Luben Tuikove16da02f2010-11-11 15:43:11 -0800846 if ((sshdr.response_code & 0x72) == 0x72)
847 srb->sense_buffer[1] = HARDWARE_ERROR;
848 else
849 srb->sense_buffer[2] = HARDWARE_ERROR;
Alan Sternf1a07432009-10-06 14:07:57 -0400850 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851 }
852 }
853
Alan Stern21c13a42011-06-07 11:35:52 -0400854 /*
855 * Some devices don't work or return incorrect data the first
856 * time they get a READ(10) command, or for the first READ(10)
857 * after a media change. If the INITIAL_READ10 flag is set,
858 * keep track of whether READ(10) commands succeed. If the
859 * previous one succeeded and this one failed, set the REDO_READ10
860 * flag to force a retry.
861 */
862 if (unlikely((us->fflags & US_FL_INITIAL_READ10) &&
863 srb->cmnd[0] == READ_10)) {
864 if (srb->result == SAM_STAT_GOOD) {
865 set_bit(US_FLIDX_READ10_WORKED, &us->dflags);
866 } else if (test_bit(US_FLIDX_READ10_WORKED, &us->dflags)) {
867 clear_bit(US_FLIDX_READ10_WORKED, &us->dflags);
868 set_bit(US_FLIDX_REDO_READ10, &us->dflags);
869 }
870
871 /*
872 * Next, if the REDO_READ10 flag is set, return a result
873 * code that will cause the SCSI core to retry the READ(10)
874 * command immediately.
875 */
876 if (test_bit(US_FLIDX_REDO_READ10, &us->dflags)) {
877 clear_bit(US_FLIDX_REDO_READ10, &us->dflags);
878 srb->result = DID_IMM_RETRY << 16;
879 srb->sense_buffer[0] = 0;
880 }
881 }
882
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883 /* Did we transfer less than the minimum amount required? */
Alan Stern8bfa2472008-09-02 10:12:11 -0400884 if ((srb->result == SAM_STAT_GOOD || srb->sense_buffer[2] == 0) &&
Boaz Harrosh6d416e62007-09-10 18:01:08 +0300885 scsi_bufflen(srb) - scsi_get_resid(srb) < srb->underflow)
Martin K. Petersen1c9fbaf2009-01-04 03:14:11 -0500886 srb->result = DID_ERROR << 16;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887
Alan Stern25ff1c32008-12-15 12:43:41 -0500888 last_sector_hacks(us, srb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 return;
890
Felipe Balbif0183a32016-04-18 13:09:11 +0300891 /*
892 * Error and abort processing: try to resynchronize with the device
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700893 * by issuing a port reset. If that fails, try a class-specific
Felipe Balbif0183a32016-04-18 13:09:11 +0300894 * device reset.
895 */
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700896 Handle_Errors:
897
Felipe Balbif0183a32016-04-18 13:09:11 +0300898 /*
899 * Set the RESETTING bit, and clear the ABORTING bit so that
900 * the reset may proceed.
901 */
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700902 scsi_lock(us_to_host(us));
Alan Stern7e4d6c32008-05-01 15:35:18 -0400903 set_bit(US_FLIDX_RESETTING, &us->dflags);
904 clear_bit(US_FLIDX_ABORTING, &us->dflags);
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700905 scsi_unlock(us_to_host(us));
906
Felipe Balbif0183a32016-04-18 13:09:11 +0300907 /*
908 * We must release the device lock because the pre_reset routine
909 * will want to acquire it.
910 */
Alan Stern47104b02006-06-01 13:52:56 -0400911 mutex_unlock(&us->dev_mutex);
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700912 result = usb_stor_port_reset(us);
Alan Stern47104b02006-06-01 13:52:56 -0400913 mutex_lock(&us->dev_mutex);
914
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700915 if (result < 0) {
916 scsi_lock(us_to_host(us));
917 usb_stor_report_device_reset(us);
918 scsi_unlock(us_to_host(us));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919 us->transport_reset(us);
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700920 }
Alan Stern7e4d6c32008-05-01 15:35:18 -0400921 clear_bit(US_FLIDX_RESETTING, &us->dflags);
Alan Stern25ff1c32008-12-15 12:43:41 -0500922 last_sector_hacks(us, srb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923}
924
925/* Stop the current URB transfer */
926void usb_stor_stop_transport(struct us_data *us)
927{
Felipe Balbif0183a32016-04-18 13:09:11 +0300928 /*
929 * If the state machine is blocked waiting for an URB,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700930 * let's wake it up. The test_and_clear_bit() call
931 * guarantees that if a URB has just been submitted,
Felipe Balbif0183a32016-04-18 13:09:11 +0300932 * it won't be cancelled more than once.
933 */
Alan Stern7e4d6c32008-05-01 15:35:18 -0400934 if (test_and_clear_bit(US_FLIDX_URB_ACTIVE, &us->dflags)) {
Joe Perches191648d2013-04-19 11:44:00 -0700935 usb_stor_dbg(us, "-- cancelling URB\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936 usb_unlink_urb(us->current_urb);
937 }
938
939 /* If we are waiting for a scatter-gather operation, cancel it. */
Alan Stern7e4d6c32008-05-01 15:35:18 -0400940 if (test_and_clear_bit(US_FLIDX_SG_ACTIVE, &us->dflags)) {
Joe Perches191648d2013-04-19 11:44:00 -0700941 usb_stor_dbg(us, "-- cancelling sg request\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942 usb_sg_cancel(&us->current_sg);
943 }
944}
945
946/*
Alan Stern64648a92008-11-20 14:20:03 -0500947 * Control/Bulk and Control/Bulk/Interrupt transport
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948 */
949
Alan Stern64648a92008-11-20 14:20:03 -0500950int usb_stor_CB_transport(struct scsi_cmnd *srb, struct us_data *us)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951{
Boaz Harrosh6d416e62007-09-10 18:01:08 +0300952 unsigned int transfer_length = scsi_bufflen(srb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953 unsigned int pipe = 0;
954 int result;
955
956 /* COMMAND STAGE */
957 /* let's send the command via the control pipe */
Petr Vandrovec2ce9d222016-11-10 13:57:14 -0800958 /*
959 * Command is sometime (f.e. after scsi_eh_prep_cmnd) on the stack.
960 * Stack may be vmallocated. So no DMA for us. Make a copy.
961 */
962 memcpy(us->iobuf, srb->cmnd, srb->cmd_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963 result = usb_stor_ctrl_transfer(us, us->send_ctrl_pipe,
964 US_CBI_ADSC,
965 USB_TYPE_CLASS | USB_RECIP_INTERFACE, 0,
Petr Vandrovec2ce9d222016-11-10 13:57:14 -0800966 us->ifnum, us->iobuf, srb->cmd_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700967
968 /* check the return code for the command */
Joe Perches191648d2013-04-19 11:44:00 -0700969 usb_stor_dbg(us, "Call to usb_stor_ctrl_transfer() returned %d\n",
970 result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971
972 /* if we stalled the command, it means command failed */
973 if (result == USB_STOR_XFER_STALLED) {
974 return USB_STOR_TRANSPORT_FAILED;
975 }
976
977 /* Uh oh... serious problem here */
978 if (result != USB_STOR_XFER_GOOD) {
979 return USB_STOR_TRANSPORT_ERROR;
980 }
981
982 /* DATA STAGE */
983 /* transfer the data payload for this command, if one exists*/
984 if (transfer_length) {
985 pipe = srb->sc_data_direction == DMA_FROM_DEVICE ?
986 us->recv_bulk_pipe : us->send_bulk_pipe;
Boaz Harrosh6d416e62007-09-10 18:01:08 +0300987 result = usb_stor_bulk_srb(us, pipe, srb);
Joe Perches191648d2013-04-19 11:44:00 -0700988 usb_stor_dbg(us, "CBI data stage result is 0x%x\n", result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700989
990 /* if we stalled the data transfer it means command failed */
991 if (result == USB_STOR_XFER_STALLED)
992 return USB_STOR_TRANSPORT_FAILED;
993 if (result > USB_STOR_XFER_STALLED)
994 return USB_STOR_TRANSPORT_ERROR;
995 }
996
997 /* STATUS STAGE */
Alan Stern64648a92008-11-20 14:20:03 -0500998
Felipe Balbif0183a32016-04-18 13:09:11 +0300999 /*
1000 * NOTE: CB does not have a status stage. Silly, I know. So
Alan Stern64648a92008-11-20 14:20:03 -05001001 * we have to catch this at a higher level.
1002 */
Michal Nazarewicz8fa7fd72010-10-07 13:05:21 +02001003 if (us->protocol != USB_PR_CBI)
Alan Stern64648a92008-11-20 14:20:03 -05001004 return USB_STOR_TRANSPORT_GOOD;
1005
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006 result = usb_stor_intr_transfer(us, us->iobuf, 2);
Joe Perches191648d2013-04-19 11:44:00 -07001007 usb_stor_dbg(us, "Got interrupt data (0x%x, 0x%x)\n",
1008 us->iobuf[0], us->iobuf[1]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009 if (result != USB_STOR_XFER_GOOD)
1010 return USB_STOR_TRANSPORT_ERROR;
1011
Felipe Balbif0183a32016-04-18 13:09:11 +03001012 /*
1013 * UFI gives us ASC and ASCQ, like a request sense
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014 *
1015 * REQUEST_SENSE and INQUIRY don't affect the sense data on UFI
1016 * devices, so we ignore the information for those commands. Note
1017 * that this means we could be ignoring a real error on these
1018 * commands, but that can't be helped.
1019 */
Michal Nazarewicz8fa7fd72010-10-07 13:05:21 +02001020 if (us->subclass == USB_SC_UFI) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021 if (srb->cmnd[0] == REQUEST_SENSE ||
1022 srb->cmnd[0] == INQUIRY)
1023 return USB_STOR_TRANSPORT_GOOD;
1024 if (us->iobuf[0])
1025 goto Failed;
1026 return USB_STOR_TRANSPORT_GOOD;
1027 }
1028
Felipe Balbif0183a32016-04-18 13:09:11 +03001029 /*
1030 * If not UFI, we interpret the data as a result code
Linus Torvalds1da177e2005-04-16 15:20:36 -07001031 * The first byte should always be a 0x0.
1032 *
1033 * Some bogus devices don't follow that rule. They stuff the ASC
1034 * into the first byte -- so if it's non-zero, call it a failure.
1035 */
1036 if (us->iobuf[0]) {
Joe Perches191648d2013-04-19 11:44:00 -07001037 usb_stor_dbg(us, "CBI IRQ data showed reserved bType 0x%x\n",
1038 us->iobuf[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039 goto Failed;
1040
1041 }
1042
1043 /* The second byte & 0x0F should be 0x0 for good, otherwise error */
1044 switch (us->iobuf[1] & 0x0F) {
1045 case 0x00:
1046 return USB_STOR_TRANSPORT_GOOD;
1047 case 0x01:
1048 goto Failed;
1049 }
1050 return USB_STOR_TRANSPORT_ERROR;
1051
Felipe Balbif0183a32016-04-18 13:09:11 +03001052 /*
1053 * the CBI spec requires that the bulk pipe must be cleared
Linus Torvalds1da177e2005-04-16 15:20:36 -07001054 * following any data-in/out command failure (section 2.4.3.1.3)
1055 */
1056 Failed:
1057 if (pipe)
1058 usb_stor_clear_halt(us, pipe);
1059 return USB_STOR_TRANSPORT_FAILED;
1060}
Alan Sterne6e244b2009-02-12 14:47:44 -05001061EXPORT_SYMBOL_GPL(usb_stor_CB_transport);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062
1063/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064 * Bulk only transport
1065 */
1066
1067/* Determine what the maximum LUN supported is */
1068int usb_stor_Bulk_max_lun(struct us_data *us)
1069{
1070 int result;
1071
1072 /* issue the command */
Alan Sternb876aef2005-10-23 19:38:56 -07001073 us->iobuf[0] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001074 result = usb_stor_control_msg(us, us->recv_ctrl_pipe,
1075 US_BULK_GET_MAX_LUN,
1076 USB_DIR_IN | USB_TYPE_CLASS |
1077 USB_RECIP_INTERFACE,
Giacomo Lozito7a777912009-07-13 23:23:33 +02001078 0, us->ifnum, us->iobuf, 1, 10*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079
Joe Perches191648d2013-04-19 11:44:00 -07001080 usb_stor_dbg(us, "GetMaxLUN command result is %d, data is %d\n",
1081 result, us->iobuf[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001082
Mark Knibbs55dc68c2014-11-04 13:00:22 +00001083 /*
1084 * If we have a successful request, return the result if valid. The
1085 * CBW LUN field is 4 bits wide, so the value reported by the device
1086 * should fit into that.
1087 */
1088 if (result > 0) {
1089 if (us->iobuf[0] < 16) {
1090 return us->iobuf[0];
1091 } else {
1092 dev_info(&us->pusb_intf->dev,
1093 "Max LUN %d is not valid, using 0 instead",
1094 us->iobuf[0]);
1095 }
1096 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098 /*
1099 * Some devices don't like GetMaxLUN. They may STALL the control
1100 * pipe, they may return a zero-length result, they may do nothing at
1101 * all and timeout, or they may fail in even more bizarrely creative
1102 * ways. In these cases the best approach is to use the default
1103 * value: only one LUN.
1104 */
1105 return 0;
1106}
1107
1108int usb_stor_Bulk_transport(struct scsi_cmnd *srb, struct us_data *us)
1109{
1110 struct bulk_cb_wrap *bcb = (struct bulk_cb_wrap *) us->iobuf;
1111 struct bulk_cs_wrap *bcs = (struct bulk_cs_wrap *) us->iobuf;
Boaz Harrosh6d416e62007-09-10 18:01:08 +03001112 unsigned int transfer_length = scsi_bufflen(srb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001113 unsigned int residue;
1114 int result;
1115 int fake_sense = 0;
1116 unsigned int cswlen;
1117 unsigned int cbwlen = US_BULK_CB_WRAP_LEN;
1118
1119 /* Take care of BULK32 devices; set extra byte to 0 */
Alan Stern7e4d6c32008-05-01 15:35:18 -04001120 if (unlikely(us->fflags & US_FL_BULK32)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121 cbwlen = 32;
1122 us->iobuf[31] = 0;
1123 }
1124
1125 /* set up the command wrapper */
1126 bcb->Signature = cpu_to_le32(US_BULK_CB_SIGN);
1127 bcb->DataTransferLength = cpu_to_le32(transfer_length);
Sebastian Andrzej Siewiorb8db6d62012-02-25 18:28:10 +01001128 bcb->Flags = srb->sc_data_direction == DMA_FROM_DEVICE ?
1129 US_BULK_FLAG_IN : 0;
Matthew Dharm0f64e072005-07-28 14:43:08 -07001130 bcb->Tag = ++us->tag;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001131 bcb->Lun = srb->device->lun;
Alan Stern7e4d6c32008-05-01 15:35:18 -04001132 if (us->fflags & US_FL_SCM_MULT_TARG)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133 bcb->Lun |= srb->device->id << 4;
1134 bcb->Length = srb->cmd_len;
1135
1136 /* copy the command payload */
1137 memset(bcb->CDB, 0, sizeof(bcb->CDB));
1138 memcpy(bcb->CDB, srb->cmnd, bcb->Length);
1139
1140 /* send it to out endpoint */
Joe Perches191648d2013-04-19 11:44:00 -07001141 usb_stor_dbg(us, "Bulk Command S 0x%x T 0x%x L %d F %d Trg %d LUN %d CL %d\n",
1142 le32_to_cpu(bcb->Signature), bcb->Tag,
1143 le32_to_cpu(bcb->DataTransferLength), bcb->Flags,
1144 (bcb->Lun >> 4), (bcb->Lun & 0x0F),
1145 bcb->Length);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146 result = usb_stor_bulk_transfer_buf(us, us->send_bulk_pipe,
1147 bcb, cbwlen, NULL);
Joe Perches191648d2013-04-19 11:44:00 -07001148 usb_stor_dbg(us, "Bulk command transfer result=%d\n", result);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001149 if (result != USB_STOR_XFER_GOOD)
1150 return USB_STOR_TRANSPORT_ERROR;
1151
1152 /* DATA STAGE */
1153 /* send/receive data payload, if there is any */
1154
Felipe Balbif0183a32016-04-18 13:09:11 +03001155 /*
1156 * Some USB-IDE converter chips need a 100us delay between the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157 * command phase and the data phase. Some devices need a little
Felipe Balbif0183a32016-04-18 13:09:11 +03001158 * more than that, probably because of clock rate inaccuracies.
1159 */
Alan Stern7e4d6c32008-05-01 15:35:18 -04001160 if (unlikely(us->fflags & US_FL_GO_SLOW))
Sunny Kumare616b392015-07-07 12:27:03 +05301161 usleep_range(125, 150);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162
1163 if (transfer_length) {
1164 unsigned int pipe = srb->sc_data_direction == DMA_FROM_DEVICE ?
1165 us->recv_bulk_pipe : us->send_bulk_pipe;
Boaz Harrosh6d416e62007-09-10 18:01:08 +03001166 result = usb_stor_bulk_srb(us, pipe, srb);
Joe Perches191648d2013-04-19 11:44:00 -07001167 usb_stor_dbg(us, "Bulk data transfer result 0x%x\n", result);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001168 if (result == USB_STOR_XFER_ERROR)
1169 return USB_STOR_TRANSPORT_ERROR;
1170
Felipe Balbif0183a32016-04-18 13:09:11 +03001171 /*
1172 * If the device tried to send back more data than the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001173 * amount requested, the spec requires us to transfer
1174 * the CSW anyway. Since there's no point retrying the
1175 * the command, we'll return fake sense data indicating
1176 * Illegal Request, Invalid Field in CDB.
1177 */
1178 if (result == USB_STOR_XFER_LONG)
1179 fake_sense = 1;
Alan Stern93c9bf42014-10-31 14:49:47 -04001180
1181 /*
1182 * Sometimes a device will mistakenly skip the data phase
1183 * and go directly to the status phase without sending a
1184 * zero-length packet. If we get a 13-byte response here,
1185 * check whether it really is a CSW.
1186 */
1187 if (result == USB_STOR_XFER_SHORT &&
1188 srb->sc_data_direction == DMA_FROM_DEVICE &&
1189 transfer_length - scsi_get_resid(srb) ==
1190 US_BULK_CS_WRAP_LEN) {
1191 struct scatterlist *sg = NULL;
1192 unsigned int offset = 0;
1193
1194 if (usb_stor_access_xfer_buf((unsigned char *) bcs,
1195 US_BULK_CS_WRAP_LEN, srb, &sg,
1196 &offset, FROM_XFER_BUF) ==
1197 US_BULK_CS_WRAP_LEN &&
1198 bcs->Signature ==
1199 cpu_to_le32(US_BULK_CS_SIGN)) {
1200 usb_stor_dbg(us, "Device skipped data phase\n");
1201 scsi_set_resid(srb, transfer_length);
1202 goto skipped_data_phase;
1203 }
1204 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205 }
1206
Felipe Balbif0183a32016-04-18 13:09:11 +03001207 /*
1208 * See flow chart on pg 15 of the Bulk Only Transport spec for
Linus Torvalds1da177e2005-04-16 15:20:36 -07001209 * an explanation of how this code works.
1210 */
1211
1212 /* get CSW for device status */
Joe Perches191648d2013-04-19 11:44:00 -07001213 usb_stor_dbg(us, "Attempting to get CSW...\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001214 result = usb_stor_bulk_transfer_buf(us, us->recv_bulk_pipe,
1215 bcs, US_BULK_CS_WRAP_LEN, &cswlen);
1216
Felipe Balbif0183a32016-04-18 13:09:11 +03001217 /*
1218 * Some broken devices add unnecessary zero-length packets to the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001219 * end of their data transfers. Such packets show up as 0-length
1220 * CSWs. If we encounter such a thing, try to read the CSW again.
1221 */
1222 if (result == USB_STOR_XFER_SHORT && cswlen == 0) {
Joe Perches191648d2013-04-19 11:44:00 -07001223 usb_stor_dbg(us, "Received 0-length CSW; retrying...\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224 result = usb_stor_bulk_transfer_buf(us, us->recv_bulk_pipe,
1225 bcs, US_BULK_CS_WRAP_LEN, &cswlen);
1226 }
1227
1228 /* did the attempt to read the CSW fail? */
1229 if (result == USB_STOR_XFER_STALLED) {
1230
1231 /* get the status again */
Joe Perches191648d2013-04-19 11:44:00 -07001232 usb_stor_dbg(us, "Attempting to get CSW (2nd try)...\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233 result = usb_stor_bulk_transfer_buf(us, us->recv_bulk_pipe,
1234 bcs, US_BULK_CS_WRAP_LEN, NULL);
1235 }
1236
1237 /* if we still have a failure at this point, we're in trouble */
Joe Perches191648d2013-04-19 11:44:00 -07001238 usb_stor_dbg(us, "Bulk status result = %d\n", result);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239 if (result != USB_STOR_XFER_GOOD)
1240 return USB_STOR_TRANSPORT_ERROR;
1241
Alan Stern93c9bf42014-10-31 14:49:47 -04001242 skipped_data_phase:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243 /* check bulk status */
1244 residue = le32_to_cpu(bcs->Residue);
Joe Perches191648d2013-04-19 11:44:00 -07001245 usb_stor_dbg(us, "Bulk Status S 0x%x T 0x%x R %u Stat 0x%x\n",
1246 le32_to_cpu(bcs->Signature), bcs->Tag,
1247 residue, bcs->Status);
Alan Stern7e4d6c32008-05-01 15:35:18 -04001248 if (!(bcs->Tag == us->tag || (us->fflags & US_FL_BULK_IGNORE_TAG)) ||
Constantin Baranovcc36bdd2008-03-16 20:04:23 +00001249 bcs->Status > US_BULK_STAT_PHASE) {
Joe Perches191648d2013-04-19 11:44:00 -07001250 usb_stor_dbg(us, "Bulk logical error\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001251 return USB_STOR_TRANSPORT_ERROR;
1252 }
1253
Felipe Balbif0183a32016-04-18 13:09:11 +03001254 /*
1255 * Some broken devices report odd signatures, so we do not check them
Linus Torvalds1da177e2005-04-16 15:20:36 -07001256 * for validity against the spec. We store the first one we see,
1257 * and check subsequent transfers for validity against this signature.
1258 */
1259 if (!us->bcs_signature) {
1260 us->bcs_signature = bcs->Signature;
1261 if (us->bcs_signature != cpu_to_le32(US_BULK_CS_SIGN))
Joe Perches191648d2013-04-19 11:44:00 -07001262 usb_stor_dbg(us, "Learnt BCS signature 0x%08X\n",
1263 le32_to_cpu(us->bcs_signature));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001264 } else if (bcs->Signature != us->bcs_signature) {
Joe Perches191648d2013-04-19 11:44:00 -07001265 usb_stor_dbg(us, "Signature mismatch: got %08X, expecting %08X\n",
1266 le32_to_cpu(bcs->Signature),
1267 le32_to_cpu(us->bcs_signature));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268 return USB_STOR_TRANSPORT_ERROR;
1269 }
1270
Felipe Balbif0183a32016-04-18 13:09:11 +03001271 /*
1272 * try to compute the actual residue, based on how much data
1273 * was really transferred and what the device tells us
1274 */
Alan Stern59f4ff22008-07-29 11:58:06 -04001275 if (residue && !(us->fflags & US_FL_IGNORE_RESIDUE)) {
1276
Felipe Balbif0183a32016-04-18 13:09:11 +03001277 /*
1278 * Heuristically detect devices that generate bogus residues
Alan Stern59f4ff22008-07-29 11:58:06 -04001279 * by seeing what happens with INQUIRY and READ CAPACITY
1280 * commands.
1281 */
1282 if (bcs->Status == US_BULK_STAT_OK &&
1283 scsi_get_resid(srb) == 0 &&
1284 ((srb->cmnd[0] == INQUIRY &&
1285 transfer_length == 36) ||
1286 (srb->cmnd[0] == READ_CAPACITY &&
1287 transfer_length == 8))) {
1288 us->fflags |= US_FL_IGNORE_RESIDUE;
1289
1290 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291 residue = min(residue, transfer_length);
Damien Le Moal9237f042019-10-30 18:08:47 +09001292 scsi_set_resid(srb, max(scsi_get_resid(srb), residue));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001293 }
1294 }
1295
1296 /* based on the status code, we report good or bad */
1297 switch (bcs->Status) {
1298 case US_BULK_STAT_OK:
1299 /* device babbled -- return fake sense data */
1300 if (fake_sense) {
1301 memcpy(srb->sense_buffer,
1302 usb_stor_sense_invalidCDB,
1303 sizeof(usb_stor_sense_invalidCDB));
1304 return USB_STOR_TRANSPORT_NO_SENSE;
1305 }
1306
1307 /* command good -- note that data could be short */
1308 return USB_STOR_TRANSPORT_GOOD;
1309
1310 case US_BULK_STAT_FAIL:
1311 /* command failed */
1312 return USB_STOR_TRANSPORT_FAILED;
1313
1314 case US_BULK_STAT_PHASE:
Felipe Balbif0183a32016-04-18 13:09:11 +03001315 /*
1316 * phase error -- note that a transport reset will be
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317 * invoked by the invoke_transport() function
1318 */
1319 return USB_STOR_TRANSPORT_ERROR;
1320 }
1321
1322 /* we should never get here, but if we do, we're in trouble */
1323 return USB_STOR_TRANSPORT_ERROR;
1324}
Alan Sterne6e244b2009-02-12 14:47:44 -05001325EXPORT_SYMBOL_GPL(usb_stor_Bulk_transport);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326
1327/***********************************************************************
1328 * Reset routines
1329 ***********************************************************************/
1330
Felipe Balbif0183a32016-04-18 13:09:11 +03001331/*
1332 * This is the common part of the device reset code.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 *
1334 * It's handy that every transport mechanism uses the control endpoint for
1335 * resets.
1336 *
Matthew Dharm5203ad42005-06-06 17:19:29 -07001337 * Basically, we send a reset with a 5-second timeout, so we don't get
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338 * jammed attempting to do the reset.
1339 */
1340static int usb_stor_reset_common(struct us_data *us,
1341 u8 request, u8 requesttype,
1342 u16 value, u16 index, void *data, u16 size)
1343{
1344 int result;
1345 int result2;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346
Alan Stern7e4d6c32008-05-01 15:35:18 -04001347 if (test_bit(US_FLIDX_DISCONNECTING, &us->dflags)) {
Joe Perches191648d2013-04-19 11:44:00 -07001348 usb_stor_dbg(us, "No reset during disconnect\n");
Matthew Dharm4d07ef72005-06-06 17:21:41 -07001349 return -EIO;
1350 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001351
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352 result = usb_stor_control_msg(us, us->send_ctrl_pipe,
1353 request, requesttype, value, index, data, size,
Matthew Dharm5203ad42005-06-06 17:19:29 -07001354 5*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 if (result < 0) {
Joe Perches191648d2013-04-19 11:44:00 -07001356 usb_stor_dbg(us, "Soft reset failed: %d\n", result);
Matthew Dharm4d07ef72005-06-06 17:21:41 -07001357 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001358 }
1359
Felipe Balbif0183a32016-04-18 13:09:11 +03001360 /*
1361 * Give the device some time to recover from the reset,
1362 * but don't delay disconnect processing.
1363 */
Alan Stern7e4d6c32008-05-01 15:35:18 -04001364 wait_event_interruptible_timeout(us->delay_wait,
1365 test_bit(US_FLIDX_DISCONNECTING, &us->dflags),
1366 HZ*6);
1367 if (test_bit(US_FLIDX_DISCONNECTING, &us->dflags)) {
Joe Perches191648d2013-04-19 11:44:00 -07001368 usb_stor_dbg(us, "Reset interrupted by disconnect\n");
Matthew Dharm4d07ef72005-06-06 17:21:41 -07001369 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370 }
1371
Joe Perches191648d2013-04-19 11:44:00 -07001372 usb_stor_dbg(us, "Soft reset: clearing bulk-in endpoint halt\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 result = usb_stor_clear_halt(us, us->recv_bulk_pipe);
1374
Joe Perches191648d2013-04-19 11:44:00 -07001375 usb_stor_dbg(us, "Soft reset: clearing bulk-out endpoint halt\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376 result2 = usb_stor_clear_halt(us, us->send_bulk_pipe);
1377
Matthew Dharm5203ad42005-06-06 17:19:29 -07001378 /* return a result code based on the result of the clear-halts */
1379 if (result >= 0)
1380 result = result2;
Matthew Dharm4d07ef72005-06-06 17:21:41 -07001381 if (result < 0)
Joe Perches191648d2013-04-19 11:44:00 -07001382 usb_stor_dbg(us, "Soft reset failed\n");
Matthew Dharm4d07ef72005-06-06 17:21:41 -07001383 else
Joe Perches191648d2013-04-19 11:44:00 -07001384 usb_stor_dbg(us, "Soft reset done\n");
Matthew Dharm4d07ef72005-06-06 17:21:41 -07001385 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386}
1387
Felipe Balbif0183a32016-04-18 13:09:11 +03001388/* This issues a CB[I] Reset to the device in question */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389#define CB_RESET_CMD_SIZE 12
1390
1391int usb_stor_CB_reset(struct us_data *us)
1392{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393 memset(us->iobuf, 0xFF, CB_RESET_CMD_SIZE);
1394 us->iobuf[0] = SEND_DIAGNOSTIC;
1395 us->iobuf[1] = 4;
1396 return usb_stor_reset_common(us, US_CBI_ADSC,
1397 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
1398 0, us->ifnum, us->iobuf, CB_RESET_CMD_SIZE);
1399}
Alan Sterne6e244b2009-02-12 14:47:44 -05001400EXPORT_SYMBOL_GPL(usb_stor_CB_reset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401
Felipe Balbif0183a32016-04-18 13:09:11 +03001402/*
1403 * This issues a Bulk-only Reset to the device in question, including
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404 * clearing the subsequent endpoint halts that may occur.
1405 */
1406int usb_stor_Bulk_reset(struct us_data *us)
1407{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408 return usb_stor_reset_common(us, US_BULK_RESET_REQUEST,
1409 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
1410 0, us->ifnum, NULL, 0);
1411}
Alan Sterne6e244b2009-02-12 14:47:44 -05001412EXPORT_SYMBOL_GPL(usb_stor_Bulk_reset);
Matthew Dharm4d07ef72005-06-06 17:21:41 -07001413
Felipe Balbif0183a32016-04-18 13:09:11 +03001414/*
1415 * Issue a USB port reset to the device. The caller must not hold
Alan Stern47104b02006-06-01 13:52:56 -04001416 * us->dev_mutex.
1417 */
Matthew Dharm4d07ef72005-06-06 17:21:41 -07001418int usb_stor_port_reset(struct us_data *us)
1419{
Alan Stern011b15d2008-11-04 11:29:27 -05001420 int result;
Matthew Dharm4d07ef72005-06-06 17:21:41 -07001421
Oliver Neukum5d398772009-12-18 12:14:21 +01001422 /*for these devices we must use the class specific method */
Lan Tianyu7fda9532012-08-17 16:44:56 +08001423 if (us->pusb_dev->quirks & USB_QUIRK_RESET)
Oliver Neukum5d398772009-12-18 12:14:21 +01001424 return -EPERM;
1425
Alan Stern011b15d2008-11-04 11:29:27 -05001426 result = usb_lock_device_for_reset(us->pusb_dev, us->pusb_intf);
Alan Stern47104b02006-06-01 13:52:56 -04001427 if (result < 0)
Joe Perches191648d2013-04-19 11:44:00 -07001428 usb_stor_dbg(us, "unable to lock device for reset: %d\n",
1429 result);
Alan Stern47104b02006-06-01 13:52:56 -04001430 else {
1431 /* Were we disconnected while waiting for the lock? */
Alan Stern7e4d6c32008-05-01 15:35:18 -04001432 if (test_bit(US_FLIDX_DISCONNECTING, &us->dflags)) {
Alan Stern47104b02006-06-01 13:52:56 -04001433 result = -EIO;
Joe Perches191648d2013-04-19 11:44:00 -07001434 usb_stor_dbg(us, "No reset during disconnect\n");
Matthew Dharm4d07ef72005-06-06 17:21:41 -07001435 } else {
Ming Lei742120c2008-06-18 22:00:29 +08001436 result = usb_reset_device(us->pusb_dev);
Joe Perches191648d2013-04-19 11:44:00 -07001437 usb_stor_dbg(us, "usb_reset_device returns %d\n",
1438 result);
Matthew Dharm4d07ef72005-06-06 17:21:41 -07001439 }
Alan Stern011b15d2008-11-04 11:29:27 -05001440 usb_unlock_device(us->pusb_dev);
Matthew Dharm4d07ef72005-06-06 17:21:41 -07001441 }
1442 return result;
1443}