blob: ffd086733421316bed0d3c0cf56aa20134fb54f5 [file] [log] [blame]
Felipe Balbif0183a32016-04-18 13:09:11 +03001/*
2 * Driver for USB Mass Storage compliant devices
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 * Current development and maintenance by:
5 * (c) 1999-2002 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)
9 * (c) 2000 Stephen J. Gowdy (SGowdy@lbl.gov)
10 * (c) 2002 Alan Stern <stern@rowland.org>
11 *
12 * Initial work by:
13 * (c) 1999 Michael Gee (michael@linuxspecific.com)
14 *
15 * This driver is based on the 'USB Mass Storage Class' document. This
16 * describes in detail the protocol used to communicate with such
17 * devices. Clearly, the designers had SCSI and ATAPI commands in
18 * mind when they created this document. The commands are all very
19 * similar to commands in the SCSI-II and ATAPI specifications.
20 *
21 * It is important to note that in a number of cases this class
22 * exhibits class-specific exemptions from the USB specification.
23 * Notably the usage of NAK, STALL and ACK differs from the norm, in
24 * that they are used to communicate wait, failed and OK on commands.
25 *
26 * Also, for certain devices, the interrupt endpoint is used to convey
27 * status of a command.
28 *
29 * Please see http://www.one-eyed-alien.net/~mdharm/linux-usb for more
30 * information about this driver.
31 *
32 * This program is free software; you can redistribute it and/or modify it
33 * under the terms of the GNU General Public License as published by the
34 * Free Software Foundation; either version 2, or (at your option) any
35 * later version.
36 *
37 * This program is distributed in the hope that it will be useful, but
38 * WITHOUT ANY WARRANTY; without even the implied warranty of
39 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
40 * General Public License for more details.
41 *
42 * You should have received a copy of the GNU General Public License along
43 * with this program; if not, write to the Free Software Foundation, Inc.,
44 * 675 Mass Ave, Cambridge, MA 02139, USA.
45 */
46
Linus Torvalds1da177e2005-04-16 15:20:36 -070047#include <linux/sched.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090048#include <linux/gfp.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070049#include <linux/errno.h>
Paul Gortmakerf940fcd2011-05-27 09:56:31 -040050#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
Oliver Neukum5d398772009-12-18 12:14:21 +010052#include <linux/usb/quirks.h>
53
Linus Torvalds1da177e2005-04-16 15:20:36 -070054#include <scsi/scsi.h>
Boaz Harroshdff6de72007-09-10 22:36:31 +030055#include <scsi/scsi_eh.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070056#include <scsi/scsi_device.h>
57
58#include "usb.h"
59#include "transport.h"
60#include "protocol.h"
61#include "scsiglue.h"
62#include "debug.h"
63
Alan Stern25ff1c32008-12-15 12:43:41 -050064#include <linux/blkdev.h>
65#include "../../scsi/sd.h"
66
Linus Torvalds1da177e2005-04-16 15:20:36 -070067
68/***********************************************************************
69 * Data transfer routines
70 ***********************************************************************/
71
72/*
73 * This is subtle, so pay attention:
74 * ---------------------------------
75 * We're very concerned about races with a command abort. Hanging this code
76 * is a sure fire way to hang the kernel. (Note that this discussion applies
77 * only to transactions resulting from a scsi queued-command, since only
78 * these transactions are subject to a scsi abort. Other transactions, such
79 * as those occurring during device-specific initialization, must be handled
80 * by a separate code path.)
81 *
82 * The abort function (usb_storage_command_abort() in scsiglue.c) first
Alan Stern7e4d6c32008-05-01 15:35:18 -040083 * sets the machine state and the ABORTING bit in us->dflags to prevent
Linus Torvalds1da177e2005-04-16 15:20:36 -070084 * new URBs from being submitted. It then calls usb_stor_stop_transport()
Alan Stern7e4d6c32008-05-01 15:35:18 -040085 * below, which atomically tests-and-clears the URB_ACTIVE bit in us->dflags
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 * to see if the current_urb needs to be stopped. Likewise, the SG_ACTIVE
87 * bit is tested to see if the current_sg scatter-gather request needs to be
88 * stopped. The timeout callback routine does much the same thing.
89 *
Alan Stern7e4d6c32008-05-01 15:35:18 -040090 * When a disconnect occurs, the DISCONNECTING bit in us->dflags is set to
Linus Torvalds1da177e2005-04-16 15:20:36 -070091 * prevent new URBs from being submitted, and usb_stor_stop_transport() is
92 * called to stop any ongoing requests.
93 *
94 * The submit function first verifies that the submitting is allowed
95 * (neither ABORTING nor DISCONNECTING bits are set) and that the submit
96 * completes without errors, and only then sets the URB_ACTIVE bit. This
97 * prevents the stop_transport() function from trying to cancel the URB
98 * while the submit call is underway. Next, the submit function must test
99 * the flags to see if an abort or disconnect occurred during the submission
100 * or before the URB_ACTIVE bit was set. If so, it's essential to cancel
101 * the URB if it hasn't been cancelled already (i.e., if the URB_ACTIVE bit
102 * is still set). Either way, the function must then wait for the URB to
Alan Sternb375a042005-07-29 16:11:07 -0400103 * finish. Note that the URB can still be in progress even after a call to
104 * usb_unlink_urb() returns.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 *
106 * The idea is that (1) once the ABORTING or DISCONNECTING bit is set,
107 * either the stop_transport() function or the submitting function
108 * is guaranteed to call usb_unlink_urb() for an active URB,
109 * and (2) test_and_clear_bit() prevents usb_unlink_urb() from being
110 * called more than once or from being called during usb_submit_urb().
111 */
112
Felipe Balbif0183a32016-04-18 13:09:11 +0300113/*
114 * This is the completion handler which will wake us up when an URB
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115 * completes.
116 */
David Howells7d12e782006-10-05 14:55:46 +0100117static void usb_stor_blocking_completion(struct urb *urb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118{
Ming Leicdc97792008-02-24 18:41:47 +0800119 struct completion *urb_done_ptr = urb->context;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
121 complete(urb_done_ptr);
122}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123
Felipe Balbif0183a32016-04-18 13:09:11 +0300124/*
125 * This is the common part of the URB message submission code
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 *
127 * All URBs from the usb-storage driver involved in handling a queued scsi
128 * command _must_ pass through this function (or something like it) for the
129 * abort mechanisms to work properly.
130 */
131static int usb_stor_msg_common(struct us_data *us, int timeout)
132{
133 struct completion urb_done;
Franck Bui-Huu3428cc42006-05-24 16:57:28 +0200134 long timeleft;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 int status;
136
Alan Stern543f7812008-05-08 11:55:59 -0400137 /* don't submit URBs during abort processing */
138 if (test_bit(US_FLIDX_ABORTING, &us->dflags))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 return -EIO;
140
141 /* set up data structures for the wakeup system */
142 init_completion(&urb_done);
143
144 /* fill the common fields in the URB */
145 us->current_urb->context = &urb_done;
Bob Copelandc222fb22010-07-12 11:18:18 -0400146 us->current_urb->transfer_flags = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147
Felipe Balbif0183a32016-04-18 13:09:11 +0300148 /*
149 * we assume that if transfer_buffer isn't us->iobuf then it
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 * hasn't been mapped for DMA. Yes, this is clunky, but it's
151 * easier than always having the caller tell us whether the
Felipe Balbif0183a32016-04-18 13:09:11 +0300152 * transfer buffer has already been mapped.
153 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 if (us->current_urb->transfer_buffer == us->iobuf)
155 us->current_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
156 us->current_urb->transfer_dma = us->iobuf_dma;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157
158 /* submit the URB */
159 status = usb_submit_urb(us->current_urb, GFP_NOIO);
160 if (status) {
161 /* something went wrong */
162 return status;
163 }
164
Felipe Balbif0183a32016-04-18 13:09:11 +0300165 /*
166 * since the URB has been submitted successfully, it's now okay
167 * to cancel it
168 */
Alan Stern7e4d6c32008-05-01 15:35:18 -0400169 set_bit(US_FLIDX_URB_ACTIVE, &us->dflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170
Alan Stern543f7812008-05-08 11:55:59 -0400171 /* did an abort occur during the submission? */
172 if (test_bit(US_FLIDX_ABORTING, &us->dflags)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173
174 /* cancel the URB, if it hasn't been cancelled already */
Alan Stern7e4d6c32008-05-01 15:35:18 -0400175 if (test_and_clear_bit(US_FLIDX_URB_ACTIVE, &us->dflags)) {
Joe Perches191648d2013-04-19 11:44:00 -0700176 usb_stor_dbg(us, "-- cancelling URB\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700177 usb_unlink_urb(us->current_urb);
178 }
179 }
180
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 /* wait for the completion of the URB */
Franck Bui-Huu3428cc42006-05-24 16:57:28 +0200182 timeleft = wait_for_completion_interruptible_timeout(
183 &urb_done, timeout ? : MAX_SCHEDULE_TIMEOUT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184
Alan Stern7e4d6c32008-05-01 15:35:18 -0400185 clear_bit(US_FLIDX_URB_ACTIVE, &us->dflags);
Franck Bui-Huu3428cc42006-05-24 16:57:28 +0200186
187 if (timeleft <= 0) {
Joe Perches191648d2013-04-19 11:44:00 -0700188 usb_stor_dbg(us, "%s -- cancelling URB\n",
189 timeleft == 0 ? "Timeout" : "Signal");
Alan Sternd6b7d3b2006-07-10 04:44:47 -0700190 usb_kill_urb(us->current_urb);
Franck Bui-Huu3428cc42006-05-24 16:57:28 +0200191 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192
193 /* return the URB status */
194 return us->current_urb->status;
195}
196
197/*
198 * Transfer one control message, with timeouts, and allowing early
199 * termination. Return codes are usual -Exxx, *not* USB_STOR_XFER_xxx.
200 */
201int usb_stor_control_msg(struct us_data *us, unsigned int pipe,
202 u8 request, u8 requesttype, u16 value, u16 index,
203 void *data, u16 size, int timeout)
204{
205 int status;
206
Joe Perches191648d2013-04-19 11:44:00 -0700207 usb_stor_dbg(us, "rq=%02x rqtype=%02x value=%04x index=%02x len=%u\n",
208 request, requesttype, value, index, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209
210 /* fill in the devrequest structure */
211 us->cr->bRequestType = requesttype;
212 us->cr->bRequest = request;
213 us->cr->wValue = cpu_to_le16(value);
214 us->cr->wIndex = cpu_to_le16(index);
215 us->cr->wLength = cpu_to_le16(size);
216
217 /* fill and submit the URB */
218 usb_fill_control_urb(us->current_urb, us->pusb_dev, pipe,
219 (unsigned char*) us->cr, data, size,
220 usb_stor_blocking_completion, NULL);
221 status = usb_stor_msg_common(us, timeout);
222
223 /* return the actual length of the data transferred if no error */
224 if (status == 0)
225 status = us->current_urb->actual_length;
226 return status;
227}
Alan Sterne6e244b2009-02-12 14:47:44 -0500228EXPORT_SYMBOL_GPL(usb_stor_control_msg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229
Felipe Balbif0183a32016-04-18 13:09:11 +0300230/*
231 * This is a version of usb_clear_halt() that allows early termination and
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 * doesn't read the status from the device -- this is because some devices
233 * crash their internal firmware when the status is requested after a halt.
234 *
235 * A definitive list of these 'bad' devices is too difficult to maintain or
236 * make complete enough to be useful. This problem was first observed on the
237 * Hagiwara FlashGate DUAL unit. However, bus traces reveal that neither
238 * MacOS nor Windows checks the status after clearing a halt.
239 *
240 * Since many vendors in this space limit their testing to interoperability
241 * with these two OSes, specification violations like this one are common.
242 */
243int usb_stor_clear_halt(struct us_data *us, unsigned int pipe)
244{
245 int result;
246 int endp = usb_pipeendpoint(pipe);
247
248 if (usb_pipein (pipe))
249 endp |= USB_DIR_IN;
250
251 result = usb_stor_control_msg(us, us->send_ctrl_pipe,
252 USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT,
253 USB_ENDPOINT_HALT, endp,
254 NULL, 0, 3*HZ);
255
Matthew Dharm5203ad42005-06-06 17:19:29 -0700256 if (result >= 0)
David Vrabel3444b262009-04-08 17:36:28 +0000257 usb_reset_endpoint(us->pusb_dev, endp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258
Joe Perches191648d2013-04-19 11:44:00 -0700259 usb_stor_dbg(us, "result = %d\n", result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 return result;
261}
Alan Sterne6e244b2009-02-12 14:47:44 -0500262EXPORT_SYMBOL_GPL(usb_stor_clear_halt);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263
264
265/*
266 * Interpret the results of a URB transfer
267 *
268 * This function prints appropriate debugging messages, clears halts on
269 * non-control endpoints, and translates the status to the corresponding
270 * USB_STOR_XFER_xxx return code.
271 */
272static int interpret_urb_result(struct us_data *us, unsigned int pipe,
273 unsigned int length, int result, unsigned int partial)
274{
Joe Perches191648d2013-04-19 11:44:00 -0700275 usb_stor_dbg(us, "Status code %d; transferred %u/%u\n",
276 result, partial, length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 switch (result) {
278
279 /* no error code; did we send all the data? */
280 case 0:
281 if (partial != length) {
Joe Perches191648d2013-04-19 11:44:00 -0700282 usb_stor_dbg(us, "-- short transfer\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283 return USB_STOR_XFER_SHORT;
284 }
285
Joe Perches191648d2013-04-19 11:44:00 -0700286 usb_stor_dbg(us, "-- transfer complete\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 return USB_STOR_XFER_GOOD;
288
289 /* stalled */
290 case -EPIPE:
Felipe Balbif0183a32016-04-18 13:09:11 +0300291 /*
292 * for control endpoints, (used by CB[I]) a stall indicates
293 * a failed command
294 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295 if (usb_pipecontrol(pipe)) {
Joe Perches191648d2013-04-19 11:44:00 -0700296 usb_stor_dbg(us, "-- stall on control pipe\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297 return USB_STOR_XFER_STALLED;
298 }
299
300 /* for other sorts of endpoint, clear the stall */
Joe Perches191648d2013-04-19 11:44:00 -0700301 usb_stor_dbg(us, "clearing endpoint halt for pipe 0x%x\n",
302 pipe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 if (usb_stor_clear_halt(us, pipe) < 0)
304 return USB_STOR_XFER_ERROR;
305 return USB_STOR_XFER_STALLED;
306
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307 /* babble - the device tried to send more than we wanted to read */
308 case -EOVERFLOW:
Joe Perches191648d2013-04-19 11:44:00 -0700309 usb_stor_dbg(us, "-- babble\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310 return USB_STOR_XFER_LONG;
311
312 /* the transfer was cancelled by abort, disconnect, or timeout */
313 case -ECONNRESET:
Joe Perches191648d2013-04-19 11:44:00 -0700314 usb_stor_dbg(us, "-- transfer cancelled\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 return USB_STOR_XFER_ERROR;
316
317 /* short scatter-gather read transfer */
318 case -EREMOTEIO:
Joe Perches191648d2013-04-19 11:44:00 -0700319 usb_stor_dbg(us, "-- short read transfer\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320 return USB_STOR_XFER_SHORT;
321
322 /* abort or disconnect in progress */
323 case -EIO:
Joe Perches191648d2013-04-19 11:44:00 -0700324 usb_stor_dbg(us, "-- abort or disconnect in progress\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325 return USB_STOR_XFER_ERROR;
326
327 /* the catch-all error case */
328 default:
Joe Perches191648d2013-04-19 11:44:00 -0700329 usb_stor_dbg(us, "-- unknown error\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330 return USB_STOR_XFER_ERROR;
331 }
332}
333
334/*
335 * Transfer one control message, without timeouts, but allowing early
336 * termination. Return codes are USB_STOR_XFER_xxx.
337 */
338int usb_stor_ctrl_transfer(struct us_data *us, unsigned int pipe,
339 u8 request, u8 requesttype, u16 value, u16 index,
340 void *data, u16 size)
341{
342 int result;
343
Joe Perches191648d2013-04-19 11:44:00 -0700344 usb_stor_dbg(us, "rq=%02x rqtype=%02x value=%04x index=%02x len=%u\n",
345 request, requesttype, value, index, size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700346
347 /* fill in the devrequest structure */
348 us->cr->bRequestType = requesttype;
349 us->cr->bRequest = request;
350 us->cr->wValue = cpu_to_le16(value);
351 us->cr->wIndex = cpu_to_le16(index);
352 us->cr->wLength = cpu_to_le16(size);
353
354 /* fill and submit the URB */
355 usb_fill_control_urb(us->current_urb, us->pusb_dev, pipe,
356 (unsigned char*) us->cr, data, size,
357 usb_stor_blocking_completion, NULL);
358 result = usb_stor_msg_common(us, 0);
359
360 return interpret_urb_result(us, pipe, size, result,
361 us->current_urb->actual_length);
362}
Alan Sterne6e244b2009-02-12 14:47:44 -0500363EXPORT_SYMBOL_GPL(usb_stor_ctrl_transfer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364
365/*
366 * Receive one interrupt buffer, without timeouts, but allowing early
367 * termination. Return codes are USB_STOR_XFER_xxx.
368 *
369 * This routine always uses us->recv_intr_pipe as the pipe and
370 * us->ep_bInterval as the interrupt interval.
371 */
372static int usb_stor_intr_transfer(struct us_data *us, void *buf,
373 unsigned int length)
374{
375 int result;
376 unsigned int pipe = us->recv_intr_pipe;
377 unsigned int maxp;
378
Joe Perches191648d2013-04-19 11:44:00 -0700379 usb_stor_dbg(us, "xfer %u bytes\n", length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380
381 /* calculate the max packet size */
382 maxp = usb_maxpacket(us->pusb_dev, pipe, usb_pipeout(pipe));
383 if (maxp > length)
384 maxp = length;
385
386 /* fill and submit the URB */
387 usb_fill_int_urb(us->current_urb, us->pusb_dev, pipe, buf,
388 maxp, usb_stor_blocking_completion, NULL,
389 us->ep_bInterval);
390 result = usb_stor_msg_common(us, 0);
391
392 return interpret_urb_result(us, pipe, length, result,
393 us->current_urb->actual_length);
394}
395
396/*
397 * Transfer one buffer via bulk pipe, without timeouts, but allowing early
398 * termination. Return codes are USB_STOR_XFER_xxx. If the bulk pipe
399 * stalls during the transfer, the halt is automatically cleared.
400 */
401int usb_stor_bulk_transfer_buf(struct us_data *us, unsigned int pipe,
402 void *buf, unsigned int length, unsigned int *act_len)
403{
404 int result;
405
Joe Perches191648d2013-04-19 11:44:00 -0700406 usb_stor_dbg(us, "xfer %u bytes\n", length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407
408 /* fill and submit the URB */
409 usb_fill_bulk_urb(us->current_urb, us->pusb_dev, pipe, buf, length,
410 usb_stor_blocking_completion, NULL);
411 result = usb_stor_msg_common(us, 0);
412
413 /* store the actual length of the data transferred */
414 if (act_len)
415 *act_len = us->current_urb->actual_length;
416 return interpret_urb_result(us, pipe, length, result,
417 us->current_urb->actual_length);
418}
Alan Sterne6e244b2009-02-12 14:47:44 -0500419EXPORT_SYMBOL_GPL(usb_stor_bulk_transfer_buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420
421/*
422 * Transfer a scatter-gather list via bulk transfer
423 *
424 * This function does basically the same thing as usb_stor_bulk_transfer_buf()
425 * above, but it uses the usbcore scatter-gather library.
426 */
427static int usb_stor_bulk_transfer_sglist(struct us_data *us, unsigned int pipe,
428 struct scatterlist *sg, int num_sg, unsigned int length,
429 unsigned int *act_len)
430{
431 int result;
432
Alan Stern543f7812008-05-08 11:55:59 -0400433 /* don't submit s-g requests during abort processing */
434 if (test_bit(US_FLIDX_ABORTING, &us->dflags))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435 return USB_STOR_XFER_ERROR;
436
437 /* initialize the scatter-gather request block */
Joe Perches191648d2013-04-19 11:44:00 -0700438 usb_stor_dbg(us, "xfer %u bytes, %d entries\n", length, num_sg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439 result = usb_sg_init(&us->current_sg, us->pusb_dev, pipe, 0,
Christoph Lameter55acbda2006-12-06 20:33:13 -0800440 sg, num_sg, length, GFP_NOIO);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 if (result) {
Joe Perches191648d2013-04-19 11:44:00 -0700442 usb_stor_dbg(us, "usb_sg_init returned %d\n", result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 return USB_STOR_XFER_ERROR;
444 }
445
Felipe Balbif0183a32016-04-18 13:09:11 +0300446 /*
447 * since the block has been initialized successfully, it's now
448 * okay to cancel it
449 */
Alan Stern7e4d6c32008-05-01 15:35:18 -0400450 set_bit(US_FLIDX_SG_ACTIVE, &us->dflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700451
Alan Stern543f7812008-05-08 11:55:59 -0400452 /* did an abort occur during the submission? */
453 if (test_bit(US_FLIDX_ABORTING, &us->dflags)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454
455 /* cancel the request, if it hasn't been cancelled already */
Alan Stern7e4d6c32008-05-01 15:35:18 -0400456 if (test_and_clear_bit(US_FLIDX_SG_ACTIVE, &us->dflags)) {
Joe Perches191648d2013-04-19 11:44:00 -0700457 usb_stor_dbg(us, "-- cancelling sg request\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 usb_sg_cancel(&us->current_sg);
459 }
460 }
461
462 /* wait for the completion of the transfer */
463 usb_sg_wait(&us->current_sg);
Alan Stern7e4d6c32008-05-01 15:35:18 -0400464 clear_bit(US_FLIDX_SG_ACTIVE, &us->dflags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465
466 result = us->current_sg.status;
467 if (act_len)
468 *act_len = us->current_sg.bytes;
469 return interpret_urb_result(us, pipe, length, result,
470 us->current_sg.bytes);
471}
472
473/*
Boaz Harrosh6d416e62007-09-10 18:01:08 +0300474 * Common used function. Transfer a complete command
475 * via usb_stor_bulk_transfer_sglist() above. Set cmnd resid
476 */
477int usb_stor_bulk_srb(struct us_data* us, unsigned int pipe,
478 struct scsi_cmnd* srb)
479{
480 unsigned int partial;
481 int result = usb_stor_bulk_transfer_sglist(us, pipe, scsi_sglist(srb),
482 scsi_sg_count(srb), scsi_bufflen(srb),
483 &partial);
484
485 scsi_set_resid(srb, scsi_bufflen(srb) - partial);
486 return result;
487}
Alan Sterne6e244b2009-02-12 14:47:44 -0500488EXPORT_SYMBOL_GPL(usb_stor_bulk_srb);
Boaz Harrosh6d416e62007-09-10 18:01:08 +0300489
490/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 * Transfer an entire SCSI command's worth of data payload over the bulk
492 * pipe.
493 *
494 * Note that this uses usb_stor_bulk_transfer_buf() and
495 * usb_stor_bulk_transfer_sglist() to achieve its goals --
496 * this function simply determines whether we're going to use
497 * scatter-gather or not, and acts appropriately.
498 */
499int usb_stor_bulk_transfer_sg(struct us_data* us, unsigned int pipe,
500 void *buf, unsigned int length_left, int use_sg, int *residual)
501{
502 int result;
503 unsigned int partial;
504
505 /* are we scatter-gathering? */
506 if (use_sg) {
507 /* use the usb core scatter-gather primitives */
508 result = usb_stor_bulk_transfer_sglist(us, pipe,
509 (struct scatterlist *) buf, use_sg,
510 length_left, &partial);
511 length_left -= partial;
512 } else {
513 /* no scatter-gather, just make the request */
514 result = usb_stor_bulk_transfer_buf(us, pipe, buf,
515 length_left, &partial);
516 length_left -= partial;
517 }
518
519 /* store the residual and return the error code */
520 if (residual)
521 *residual = length_left;
522 return result;
523}
Alan Sterne6e244b2009-02-12 14:47:44 -0500524EXPORT_SYMBOL_GPL(usb_stor_bulk_transfer_sg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525
526/***********************************************************************
527 * Transport routines
528 ***********************************************************************/
529
Felipe Balbif0183a32016-04-18 13:09:11 +0300530/*
531 * There are so many devices that report the capacity incorrectly,
Alan Stern25ff1c32008-12-15 12:43:41 -0500532 * this routine was written to counteract some of the resulting
533 * problems.
534 */
535static void last_sector_hacks(struct us_data *us, struct scsi_cmnd *srb)
536{
537 struct gendisk *disk;
538 struct scsi_disk *sdkp;
539 u32 sector;
540
541 /* To Report "Medium Error: Record Not Found */
542 static unsigned char record_not_found[18] = {
543 [0] = 0x70, /* current error */
544 [2] = MEDIUM_ERROR, /* = 0x03 */
545 [7] = 0x0a, /* additional length */
546 [12] = 0x14 /* Record Not Found */
547 };
548
Felipe Balbif0183a32016-04-18 13:09:11 +0300549 /*
550 * If last-sector problems can't occur, whether because the
Alan Stern25ff1c32008-12-15 12:43:41 -0500551 * capacity was already decremented or because the device is
552 * known to report the correct capacity, then we don't need
553 * to do anything.
554 */
555 if (!us->use_last_sector_hacks)
556 return;
557
558 /* Was this command a READ(10) or a WRITE(10)? */
559 if (srb->cmnd[0] != READ_10 && srb->cmnd[0] != WRITE_10)
560 goto done;
561
562 /* Did this command access the last sector? */
563 sector = (srb->cmnd[2] << 24) | (srb->cmnd[3] << 16) |
564 (srb->cmnd[4] << 8) | (srb->cmnd[5]);
565 disk = srb->request->rq_disk;
566 if (!disk)
567 goto done;
568 sdkp = scsi_disk(disk);
569 if (!sdkp)
570 goto done;
571 if (sector + 1 != sdkp->capacity)
572 goto done;
573
574 if (srb->result == SAM_STAT_GOOD && scsi_get_resid(srb) == 0) {
575
Felipe Balbif0183a32016-04-18 13:09:11 +0300576 /*
577 * The command succeeded. We know this device doesn't
Alan Stern0d020aa2009-02-02 09:51:01 -0500578 * have the last-sector bug, so stop checking it.
Alan Stern25ff1c32008-12-15 12:43:41 -0500579 */
Alan Stern0d020aa2009-02-02 09:51:01 -0500580 us->use_last_sector_hacks = 0;
Alan Stern25ff1c32008-12-15 12:43:41 -0500581
582 } else {
Felipe Balbif0183a32016-04-18 13:09:11 +0300583 /*
584 * The command failed. Allow up to 3 retries in case this
Alan Stern25ff1c32008-12-15 12:43:41 -0500585 * is some normal sort of failure. After that, assume the
586 * capacity is wrong and we're trying to access the sector
587 * beyond the end. Replace the result code and sense data
588 * with values that will cause the SCSI core to fail the
589 * command immediately, instead of going into an infinite
590 * (or even just a very long) retry loop.
591 */
592 if (++us->last_sector_retries < 3)
593 return;
594 srb->result = SAM_STAT_CHECK_CONDITION;
595 memcpy(srb->sense_buffer, record_not_found,
596 sizeof(record_not_found));
Alan Stern25ff1c32008-12-15 12:43:41 -0500597 }
598
599 done:
Felipe Balbif0183a32016-04-18 13:09:11 +0300600 /*
601 * Don't reset the retry counter for TEST UNIT READY commands,
Alan Stern25ff1c32008-12-15 12:43:41 -0500602 * because they get issued after device resets which might be
603 * caused by a failed last-sector access.
604 */
605 if (srb->cmnd[0] != TEST_UNIT_READY)
606 us->last_sector_retries = 0;
607}
608
Felipe Balbif0183a32016-04-18 13:09:11 +0300609/*
610 * Invoke the transport and basic error-handling/recovery methods
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 *
612 * This is used by the protocol layers to actually send the message to
613 * the device and receive the response.
614 */
615void usb_stor_invoke_transport(struct scsi_cmnd *srb, struct us_data *us)
616{
617 int need_auto_sense;
618 int result;
619
620 /* send the command to the transport layer */
Boaz Harrosh6d416e62007-09-10 18:01:08 +0300621 scsi_set_resid(srb, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622 result = us->transport(srb, us);
623
Felipe Balbif0183a32016-04-18 13:09:11 +0300624 /*
625 * if the command gets aborted by the higher layers, we need to
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 * short-circuit all other processing
627 */
Alan Stern7e4d6c32008-05-01 15:35:18 -0400628 if (test_bit(US_FLIDX_TIMED_OUT, &us->dflags)) {
Joe Perches191648d2013-04-19 11:44:00 -0700629 usb_stor_dbg(us, "-- command was aborted\n");
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700630 srb->result = DID_ABORT << 16;
631 goto Handle_Errors;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700632 }
633
634 /* if there is a transport error, reset and don't auto-sense */
635 if (result == USB_STOR_TRANSPORT_ERROR) {
Joe Perches191648d2013-04-19 11:44:00 -0700636 usb_stor_dbg(us, "-- transport indicates error, resetting\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700637 srb->result = DID_ERROR << 16;
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700638 goto Handle_Errors;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700639 }
640
641 /* if the transport provided its own sense data, don't auto-sense */
642 if (result == USB_STOR_TRANSPORT_NO_SENSE) {
643 srb->result = SAM_STAT_CHECK_CONDITION;
Alan Stern25ff1c32008-12-15 12:43:41 -0500644 last_sector_hacks(us, srb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700645 return;
646 }
647
648 srb->result = SAM_STAT_GOOD;
649
Felipe Balbif0183a32016-04-18 13:09:11 +0300650 /*
651 * Determine if we need to auto-sense
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 *
653 * I normally don't use a flag like this, but it's almost impossible
654 * to understand what's going on here if I don't.
655 */
656 need_auto_sense = 0;
657
658 /*
659 * If we're running the CB transport, which is incapable
660 * of determining status on its own, we will auto-sense
661 * unless the operation involved a data-in transfer. Devices
662 * can signal most data-in errors by stalling the bulk-in pipe.
663 */
Michal Nazarewicz8fa7fd72010-10-07 13:05:21 +0200664 if ((us->protocol == USB_PR_CB || us->protocol == USB_PR_DPCM_USB) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665 srb->sc_data_direction != DMA_FROM_DEVICE) {
Joe Perches191648d2013-04-19 11:44:00 -0700666 usb_stor_dbg(us, "-- CB transport device requiring auto-sense\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 need_auto_sense = 1;
668 }
669
670 /*
671 * If we have a failure, we're going to do a REQUEST_SENSE
672 * automatically. Note that we differentiate between a command
673 * "failure" and an "error" in the transport mechanism.
674 */
675 if (result == USB_STOR_TRANSPORT_FAILED) {
Joe Perches191648d2013-04-19 11:44:00 -0700676 usb_stor_dbg(us, "-- transport indicates command failure\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 need_auto_sense = 1;
678 }
679
680 /*
Ben Efros1537e0a2008-11-18 13:31:13 -0800681 * Determine if this device is SAT by seeing if the
682 * command executed successfully. Otherwise we'll have
683 * to wait for at least one CHECK_CONDITION to determine
684 * SANE_SENSE support
685 */
Alan Sterna0bb1082009-12-07 16:39:16 -0500686 if (unlikely((srb->cmnd[0] == ATA_16 || srb->cmnd[0] == ATA_12) &&
Ben Efros1537e0a2008-11-18 13:31:13 -0800687 result == USB_STOR_TRANSPORT_GOOD &&
688 !(us->fflags & US_FL_SANE_SENSE) &&
Alan Sterna0bb1082009-12-07 16:39:16 -0500689 !(us->fflags & US_FL_BAD_SENSE) &&
690 !(srb->cmnd[2] & 0x20))) {
Joe Perches191648d2013-04-19 11:44:00 -0700691 usb_stor_dbg(us, "-- SAT supported, increasing auto-sense\n");
Ben Efros1537e0a2008-11-18 13:31:13 -0800692 us->fflags |= US_FL_SANE_SENSE;
693 }
694
695 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696 * A short transfer on a command where we don't expect it
697 * is unusual, but it doesn't mean we need to auto-sense.
698 */
Boaz Harrosh6d416e62007-09-10 18:01:08 +0300699 if ((scsi_get_resid(srb) > 0) &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700700 !((srb->cmnd[0] == REQUEST_SENSE) ||
701 (srb->cmnd[0] == INQUIRY) ||
702 (srb->cmnd[0] == MODE_SENSE) ||
703 (srb->cmnd[0] == LOG_SENSE) ||
704 (srb->cmnd[0] == MODE_SENSE_10))) {
Joe Perches191648d2013-04-19 11:44:00 -0700705 usb_stor_dbg(us, "-- unexpectedly short transfer\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706 }
707
708 /* Now, if we need to do the auto-sense, let's do it */
709 if (need_auto_sense) {
710 int temp_result;
Boaz Harroshdff6de72007-09-10 22:36:31 +0300711 struct scsi_eh_save ses;
Ben Efros1537e0a2008-11-18 13:31:13 -0800712 int sense_size = US_SENSE_SIZE;
Luben Tuikove16da022010-11-11 15:43:11 -0800713 struct scsi_sense_hdr sshdr;
714 const u8 *scdd;
715 u8 fm_ili;
Ben Efros1537e0a2008-11-18 13:31:13 -0800716
717 /* device supports and needs bigger sense buffer */
718 if (us->fflags & US_FL_SANE_SENSE)
719 sense_size = ~0;
Benjamin Herrenschmidtb8430e12009-10-13 15:53:47 +1100720Retry_Sense:
Joe Perches191648d2013-04-19 11:44:00 -0700721 usb_stor_dbg(us, "Issuing auto-REQUEST_SENSE\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722
Ben Efros1537e0a2008-11-18 13:31:13 -0800723 scsi_eh_prep_cmnd(srb, &ses, NULL, 0, sense_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724
725 /* FIXME: we must do the protocol translation here */
Michal Nazarewicz8fa7fd72010-10-07 13:05:21 +0200726 if (us->subclass == USB_SC_RBC || us->subclass == USB_SC_SCSI ||
727 us->subclass == USB_SC_CYP_ATACB)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700728 srb->cmd_len = 6;
729 else
730 srb->cmd_len = 12;
731
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732 /* issue the auto-sense command */
Boaz Harrosh6d416e62007-09-10 18:01:08 +0300733 scsi_set_resid(srb, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 temp_result = us->transport(us->srb, us);
735
736 /* let's clean up right away */
Boaz Harroshdff6de72007-09-10 22:36:31 +0300737 scsi_eh_restore_cmnd(srb, &ses);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738
Alan Stern7e4d6c32008-05-01 15:35:18 -0400739 if (test_bit(US_FLIDX_TIMED_OUT, &us->dflags)) {
Joe Perches191648d2013-04-19 11:44:00 -0700740 usb_stor_dbg(us, "-- auto-sense aborted\n");
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700741 srb->result = DID_ABORT << 16;
Alan Sterna0bb1082009-12-07 16:39:16 -0500742
743 /* If SANE_SENSE caused this problem, disable it */
744 if (sense_size != US_SENSE_SIZE) {
745 us->fflags &= ~US_FL_SANE_SENSE;
746 us->fflags |= US_FL_BAD_SENSE;
747 }
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700748 goto Handle_Errors;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 }
Benjamin Herrenschmidtb8430e12009-10-13 15:53:47 +1100750
Felipe Balbif0183a32016-04-18 13:09:11 +0300751 /*
752 * Some devices claim to support larger sense but fail when
Benjamin Herrenschmidtb8430e12009-10-13 15:53:47 +1100753 * trying to request it. When a transport failure happens
754 * using US_FS_SANE_SENSE, we always retry with a standard
755 * (small) sense request. This fixes some USB GSM modems
756 */
757 if (temp_result == USB_STOR_TRANSPORT_FAILED &&
Alan Sterna0bb1082009-12-07 16:39:16 -0500758 sense_size != US_SENSE_SIZE) {
Joe Perches191648d2013-04-19 11:44:00 -0700759 usb_stor_dbg(us, "-- auto-sense failure, retry small sense\n");
Benjamin Herrenschmidtb8430e12009-10-13 15:53:47 +1100760 sense_size = US_SENSE_SIZE;
Alan Sterna0bb1082009-12-07 16:39:16 -0500761 us->fflags &= ~US_FL_SANE_SENSE;
762 us->fflags |= US_FL_BAD_SENSE;
Benjamin Herrenschmidtb8430e12009-10-13 15:53:47 +1100763 goto Retry_Sense;
764 }
765
766 /* Other failures */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767 if (temp_result != USB_STOR_TRANSPORT_GOOD) {
Joe Perches191648d2013-04-19 11:44:00 -0700768 usb_stor_dbg(us, "-- auto-sense failure\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769
Felipe Balbif0183a32016-04-18 13:09:11 +0300770 /*
771 * we skip the reset if this happens to be a
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772 * multi-target device, since failure of an
773 * auto-sense is perfectly valid
774 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775 srb->result = DID_ERROR << 16;
Alan Stern7e4d6c32008-05-01 15:35:18 -0400776 if (!(us->fflags & US_FL_SCM_MULT_TARG))
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700777 goto Handle_Errors;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 return;
779 }
780
Felipe Balbif0183a32016-04-18 13:09:11 +0300781 /*
782 * If the sense data returned is larger than 18-bytes then we
Ben Efros1537e0a2008-11-18 13:31:13 -0800783 * assume this device supports requesting more in the future.
784 * The response code must be 70h through 73h inclusive.
785 */
786 if (srb->sense_buffer[7] > (US_SENSE_SIZE - 8) &&
787 !(us->fflags & US_FL_SANE_SENSE) &&
Alan Sterna0bb1082009-12-07 16:39:16 -0500788 !(us->fflags & US_FL_BAD_SENSE) &&
Ben Efros1537e0a2008-11-18 13:31:13 -0800789 (srb->sense_buffer[0] & 0x7C) == 0x70) {
Joe Perches191648d2013-04-19 11:44:00 -0700790 usb_stor_dbg(us, "-- SANE_SENSE support enabled\n");
Ben Efros1537e0a2008-11-18 13:31:13 -0800791 us->fflags |= US_FL_SANE_SENSE;
792
Felipe Balbif0183a32016-04-18 13:09:11 +0300793 /*
794 * Indicate to the user that we truncated their sense
Ben Efros1537e0a2008-11-18 13:31:13 -0800795 * because we didn't know it supported larger sense.
796 */
Joe Perches191648d2013-04-19 11:44:00 -0700797 usb_stor_dbg(us, "-- Sense data truncated to %i from %i\n",
798 US_SENSE_SIZE,
799 srb->sense_buffer[7] + 8);
Ben Efros1537e0a2008-11-18 13:31:13 -0800800 srb->sense_buffer[7] = (US_SENSE_SIZE - 8);
801 }
802
Luben Tuikove16da022010-11-11 15:43:11 -0800803 scsi_normalize_sense(srb->sense_buffer, SCSI_SENSE_BUFFERSIZE,
804 &sshdr);
805
Joe Perches191648d2013-04-19 11:44:00 -0700806 usb_stor_dbg(us, "-- Result from auto-sense is %d\n",
807 temp_result);
808 usb_stor_dbg(us, "-- code: 0x%x, key: 0x%x, ASC: 0x%x, ASCQ: 0x%x\n",
809 sshdr.response_code, sshdr.sense_key,
810 sshdr.asc, sshdr.ascq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811#ifdef CONFIG_USB_STORAGE_DEBUG
Joe Perches191648d2013-04-19 11:44:00 -0700812 usb_stor_show_sense(us, sshdr.sense_key, sshdr.asc, sshdr.ascq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813#endif
814
815 /* set the result so the higher layers expect this data */
816 srb->result = SAM_STAT_CHECK_CONDITION;
817
Luben Tuikove16da022010-11-11 15:43:11 -0800818 scdd = scsi_sense_desc_find(srb->sense_buffer,
819 SCSI_SENSE_BUFFERSIZE, 4);
820 fm_ili = (scdd ? scdd[3] : srb->sense_buffer[2]) & 0xA0;
821
Felipe Balbif0183a32016-04-18 13:09:11 +0300822 /*
823 * We often get empty sense data. This could indicate that
Alan Sternf1a07432009-10-06 14:07:57 -0400824 * everything worked or that there was an unspecified
825 * problem. We have to decide which.
826 */
Luben Tuikove16da022010-11-11 15:43:11 -0800827 if (sshdr.sense_key == 0 && sshdr.asc == 0 && sshdr.ascq == 0 &&
828 fm_ili == 0) {
Felipe Balbif0183a32016-04-18 13:09:11 +0300829 /*
830 * If things are really okay, then let's show that.
Alan Sternf1a07432009-10-06 14:07:57 -0400831 * Zero out the sense buffer so the higher layers
832 * won't realize we did an unsolicited auto-sense.
833 */
834 if (result == USB_STOR_TRANSPORT_GOOD) {
835 srb->result = SAM_STAT_GOOD;
836 srb->sense_buffer[0] = 0x0;
837
Felipe Balbif0183a32016-04-18 13:09:11 +0300838 /*
839 * If there was a problem, report an unspecified
Alan Sternf1a07432009-10-06 14:07:57 -0400840 * hardware error to prevent the higher layers from
841 * entering an infinite retry loop.
842 */
843 } else {
844 srb->result = DID_ERROR << 16;
Luben Tuikove16da022010-11-11 15:43:11 -0800845 if ((sshdr.response_code & 0x72) == 0x72)
846 srb->sense_buffer[1] = HARDWARE_ERROR;
847 else
848 srb->sense_buffer[2] = HARDWARE_ERROR;
Alan Sternf1a07432009-10-06 14:07:57 -0400849 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 }
851 }
852
Alan Stern21c13a42011-06-07 11:35:52 -0400853 /*
854 * Some devices don't work or return incorrect data the first
855 * time they get a READ(10) command, or for the first READ(10)
856 * after a media change. If the INITIAL_READ10 flag is set,
857 * keep track of whether READ(10) commands succeed. If the
858 * previous one succeeded and this one failed, set the REDO_READ10
859 * flag to force a retry.
860 */
861 if (unlikely((us->fflags & US_FL_INITIAL_READ10) &&
862 srb->cmnd[0] == READ_10)) {
863 if (srb->result == SAM_STAT_GOOD) {
864 set_bit(US_FLIDX_READ10_WORKED, &us->dflags);
865 } else if (test_bit(US_FLIDX_READ10_WORKED, &us->dflags)) {
866 clear_bit(US_FLIDX_READ10_WORKED, &us->dflags);
867 set_bit(US_FLIDX_REDO_READ10, &us->dflags);
868 }
869
870 /*
871 * Next, if the REDO_READ10 flag is set, return a result
872 * code that will cause the SCSI core to retry the READ(10)
873 * command immediately.
874 */
875 if (test_bit(US_FLIDX_REDO_READ10, &us->dflags)) {
876 clear_bit(US_FLIDX_REDO_READ10, &us->dflags);
877 srb->result = DID_IMM_RETRY << 16;
878 srb->sense_buffer[0] = 0;
879 }
880 }
881
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882 /* Did we transfer less than the minimum amount required? */
Alan Stern8bfa2472008-09-02 10:12:11 -0400883 if ((srb->result == SAM_STAT_GOOD || srb->sense_buffer[2] == 0) &&
Boaz Harrosh6d416e62007-09-10 18:01:08 +0300884 scsi_bufflen(srb) - scsi_get_resid(srb) < srb->underflow)
Martin K. Petersen1c9fbaf2009-01-04 03:14:11 -0500885 srb->result = DID_ERROR << 16;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886
Alan Stern25ff1c32008-12-15 12:43:41 -0500887 last_sector_hacks(us, srb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 return;
889
Felipe Balbif0183a32016-04-18 13:09:11 +0300890 /*
891 * Error and abort processing: try to resynchronize with the device
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700892 * by issuing a port reset. If that fails, try a class-specific
Felipe Balbif0183a32016-04-18 13:09:11 +0300893 * device reset.
894 */
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700895 Handle_Errors:
896
Felipe Balbif0183a32016-04-18 13:09:11 +0300897 /*
898 * Set the RESETTING bit, and clear the ABORTING bit so that
899 * the reset may proceed.
900 */
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700901 scsi_lock(us_to_host(us));
Alan Stern7e4d6c32008-05-01 15:35:18 -0400902 set_bit(US_FLIDX_RESETTING, &us->dflags);
903 clear_bit(US_FLIDX_ABORTING, &us->dflags);
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700904 scsi_unlock(us_to_host(us));
905
Felipe Balbif0183a32016-04-18 13:09:11 +0300906 /*
907 * We must release the device lock because the pre_reset routine
908 * will want to acquire it.
909 */
Alan Stern47104b02006-06-01 13:52:56 -0400910 mutex_unlock(&us->dev_mutex);
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700911 result = usb_stor_port_reset(us);
Alan Stern47104b02006-06-01 13:52:56 -0400912 mutex_lock(&us->dev_mutex);
913
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700914 if (result < 0) {
915 scsi_lock(us_to_host(us));
916 usb_stor_report_device_reset(us);
917 scsi_unlock(us_to_host(us));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918 us->transport_reset(us);
Matthew Dharm4d07ef72005-06-06 17:21:41 -0700919 }
Alan Stern7e4d6c32008-05-01 15:35:18 -0400920 clear_bit(US_FLIDX_RESETTING, &us->dflags);
Alan Stern25ff1c32008-12-15 12:43:41 -0500921 last_sector_hacks(us, srb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922}
923
924/* Stop the current URB transfer */
925void usb_stor_stop_transport(struct us_data *us)
926{
Felipe Balbif0183a32016-04-18 13:09:11 +0300927 /*
928 * If the state machine is blocked waiting for an URB,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 * let's wake it up. The test_and_clear_bit() call
930 * guarantees that if a URB has just been submitted,
Felipe Balbif0183a32016-04-18 13:09:11 +0300931 * it won't be cancelled more than once.
932 */
Alan Stern7e4d6c32008-05-01 15:35:18 -0400933 if (test_and_clear_bit(US_FLIDX_URB_ACTIVE, &us->dflags)) {
Joe Perches191648d2013-04-19 11:44:00 -0700934 usb_stor_dbg(us, "-- cancelling URB\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935 usb_unlink_urb(us->current_urb);
936 }
937
938 /* If we are waiting for a scatter-gather operation, cancel it. */
Alan Stern7e4d6c32008-05-01 15:35:18 -0400939 if (test_and_clear_bit(US_FLIDX_SG_ACTIVE, &us->dflags)) {
Joe Perches191648d2013-04-19 11:44:00 -0700940 usb_stor_dbg(us, "-- cancelling sg request\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941 usb_sg_cancel(&us->current_sg);
942 }
943}
944
945/*
Alan Stern64648a92008-11-20 14:20:03 -0500946 * Control/Bulk and Control/Bulk/Interrupt transport
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947 */
948
Alan Stern64648a92008-11-20 14:20:03 -0500949int usb_stor_CB_transport(struct scsi_cmnd *srb, struct us_data *us)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950{
Boaz Harrosh6d416e62007-09-10 18:01:08 +0300951 unsigned int transfer_length = scsi_bufflen(srb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952 unsigned int pipe = 0;
953 int result;
954
955 /* COMMAND STAGE */
956 /* let's send the command via the control pipe */
957 result = usb_stor_ctrl_transfer(us, us->send_ctrl_pipe,
958 US_CBI_ADSC,
959 USB_TYPE_CLASS | USB_RECIP_INTERFACE, 0,
960 us->ifnum, srb->cmnd, srb->cmd_len);
961
962 /* check the return code for the command */
Joe Perches191648d2013-04-19 11:44:00 -0700963 usb_stor_dbg(us, "Call to usb_stor_ctrl_transfer() returned %d\n",
964 result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700965
966 /* if we stalled the command, it means command failed */
967 if (result == USB_STOR_XFER_STALLED) {
968 return USB_STOR_TRANSPORT_FAILED;
969 }
970
971 /* Uh oh... serious problem here */
972 if (result != USB_STOR_XFER_GOOD) {
973 return USB_STOR_TRANSPORT_ERROR;
974 }
975
976 /* DATA STAGE */
977 /* transfer the data payload for this command, if one exists*/
978 if (transfer_length) {
979 pipe = srb->sc_data_direction == DMA_FROM_DEVICE ?
980 us->recv_bulk_pipe : us->send_bulk_pipe;
Boaz Harrosh6d416e62007-09-10 18:01:08 +0300981 result = usb_stor_bulk_srb(us, pipe, srb);
Joe Perches191648d2013-04-19 11:44:00 -0700982 usb_stor_dbg(us, "CBI data stage result is 0x%x\n", result);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983
984 /* if we stalled the data transfer it means command failed */
985 if (result == USB_STOR_XFER_STALLED)
986 return USB_STOR_TRANSPORT_FAILED;
987 if (result > USB_STOR_XFER_STALLED)
988 return USB_STOR_TRANSPORT_ERROR;
989 }
990
991 /* STATUS STAGE */
Alan Stern64648a92008-11-20 14:20:03 -0500992
Felipe Balbif0183a32016-04-18 13:09:11 +0300993 /*
994 * NOTE: CB does not have a status stage. Silly, I know. So
Alan Stern64648a92008-11-20 14:20:03 -0500995 * we have to catch this at a higher level.
996 */
Michal Nazarewicz8fa7fd72010-10-07 13:05:21 +0200997 if (us->protocol != USB_PR_CBI)
Alan Stern64648a92008-11-20 14:20:03 -0500998 return USB_STOR_TRANSPORT_GOOD;
999
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000 result = usb_stor_intr_transfer(us, us->iobuf, 2);
Joe Perches191648d2013-04-19 11:44:00 -07001001 usb_stor_dbg(us, "Got interrupt data (0x%x, 0x%x)\n",
1002 us->iobuf[0], us->iobuf[1]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001003 if (result != USB_STOR_XFER_GOOD)
1004 return USB_STOR_TRANSPORT_ERROR;
1005
Felipe Balbif0183a32016-04-18 13:09:11 +03001006 /*
1007 * UFI gives us ASC and ASCQ, like a request sense
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008 *
1009 * REQUEST_SENSE and INQUIRY don't affect the sense data on UFI
1010 * devices, so we ignore the information for those commands. Note
1011 * that this means we could be ignoring a real error on these
1012 * commands, but that can't be helped.
1013 */
Michal Nazarewicz8fa7fd72010-10-07 13:05:21 +02001014 if (us->subclass == USB_SC_UFI) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001015 if (srb->cmnd[0] == REQUEST_SENSE ||
1016 srb->cmnd[0] == INQUIRY)
1017 return USB_STOR_TRANSPORT_GOOD;
1018 if (us->iobuf[0])
1019 goto Failed;
1020 return USB_STOR_TRANSPORT_GOOD;
1021 }
1022
Felipe Balbif0183a32016-04-18 13:09:11 +03001023 /*
1024 * If not UFI, we interpret the data as a result code
Linus Torvalds1da177e2005-04-16 15:20:36 -07001025 * The first byte should always be a 0x0.
1026 *
1027 * Some bogus devices don't follow that rule. They stuff the ASC
1028 * into the first byte -- so if it's non-zero, call it a failure.
1029 */
1030 if (us->iobuf[0]) {
Joe Perches191648d2013-04-19 11:44:00 -07001031 usb_stor_dbg(us, "CBI IRQ data showed reserved bType 0x%x\n",
1032 us->iobuf[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001033 goto Failed;
1034
1035 }
1036
1037 /* The second byte & 0x0F should be 0x0 for good, otherwise error */
1038 switch (us->iobuf[1] & 0x0F) {
1039 case 0x00:
1040 return USB_STOR_TRANSPORT_GOOD;
1041 case 0x01:
1042 goto Failed;
1043 }
1044 return USB_STOR_TRANSPORT_ERROR;
1045
Felipe Balbif0183a32016-04-18 13:09:11 +03001046 /*
1047 * the CBI spec requires that the bulk pipe must be cleared
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048 * following any data-in/out command failure (section 2.4.3.1.3)
1049 */
1050 Failed:
1051 if (pipe)
1052 usb_stor_clear_halt(us, pipe);
1053 return USB_STOR_TRANSPORT_FAILED;
1054}
Alan Sterne6e244b2009-02-12 14:47:44 -05001055EXPORT_SYMBOL_GPL(usb_stor_CB_transport);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001056
1057/*
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058 * Bulk only transport
1059 */
1060
1061/* Determine what the maximum LUN supported is */
1062int usb_stor_Bulk_max_lun(struct us_data *us)
1063{
1064 int result;
1065
1066 /* issue the command */
Alan Sternb876aef2005-10-23 19:38:56 -07001067 us->iobuf[0] = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001068 result = usb_stor_control_msg(us, us->recv_ctrl_pipe,
1069 US_BULK_GET_MAX_LUN,
1070 USB_DIR_IN | USB_TYPE_CLASS |
1071 USB_RECIP_INTERFACE,
Giacomo Lozito7a777912009-07-13 23:23:33 +02001072 0, us->ifnum, us->iobuf, 1, 10*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001073
Joe Perches191648d2013-04-19 11:44:00 -07001074 usb_stor_dbg(us, "GetMaxLUN command result is %d, data is %d\n",
1075 result, us->iobuf[0]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001076
Mark Knibbs55dc68c2014-11-04 13:00:22 +00001077 /*
1078 * If we have a successful request, return the result if valid. The
1079 * CBW LUN field is 4 bits wide, so the value reported by the device
1080 * should fit into that.
1081 */
1082 if (result > 0) {
1083 if (us->iobuf[0] < 16) {
1084 return us->iobuf[0];
1085 } else {
1086 dev_info(&us->pusb_intf->dev,
1087 "Max LUN %d is not valid, using 0 instead",
1088 us->iobuf[0]);
1089 }
1090 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091
Linus Torvalds1da177e2005-04-16 15:20:36 -07001092 /*
1093 * Some devices don't like GetMaxLUN. They may STALL the control
1094 * pipe, they may return a zero-length result, they may do nothing at
1095 * all and timeout, or they may fail in even more bizarrely creative
1096 * ways. In these cases the best approach is to use the default
1097 * value: only one LUN.
1098 */
1099 return 0;
1100}
1101
1102int usb_stor_Bulk_transport(struct scsi_cmnd *srb, struct us_data *us)
1103{
1104 struct bulk_cb_wrap *bcb = (struct bulk_cb_wrap *) us->iobuf;
1105 struct bulk_cs_wrap *bcs = (struct bulk_cs_wrap *) us->iobuf;
Boaz Harrosh6d416e62007-09-10 18:01:08 +03001106 unsigned int transfer_length = scsi_bufflen(srb);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001107 unsigned int residue;
1108 int result;
1109 int fake_sense = 0;
1110 unsigned int cswlen;
1111 unsigned int cbwlen = US_BULK_CB_WRAP_LEN;
1112
1113 /* Take care of BULK32 devices; set extra byte to 0 */
Alan Stern7e4d6c32008-05-01 15:35:18 -04001114 if (unlikely(us->fflags & US_FL_BULK32)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001115 cbwlen = 32;
1116 us->iobuf[31] = 0;
1117 }
1118
1119 /* set up the command wrapper */
1120 bcb->Signature = cpu_to_le32(US_BULK_CB_SIGN);
1121 bcb->DataTransferLength = cpu_to_le32(transfer_length);
Sebastian Andrzej Siewiorb8db6d62012-02-25 18:28:10 +01001122 bcb->Flags = srb->sc_data_direction == DMA_FROM_DEVICE ?
1123 US_BULK_FLAG_IN : 0;
Matthew Dharm0f64e072005-07-28 14:43:08 -07001124 bcb->Tag = ++us->tag;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001125 bcb->Lun = srb->device->lun;
Alan Stern7e4d6c32008-05-01 15:35:18 -04001126 if (us->fflags & US_FL_SCM_MULT_TARG)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001127 bcb->Lun |= srb->device->id << 4;
1128 bcb->Length = srb->cmd_len;
1129
1130 /* copy the command payload */
1131 memset(bcb->CDB, 0, sizeof(bcb->CDB));
1132 memcpy(bcb->CDB, srb->cmnd, bcb->Length);
1133
1134 /* send it to out endpoint */
Joe Perches191648d2013-04-19 11:44:00 -07001135 usb_stor_dbg(us, "Bulk Command S 0x%x T 0x%x L %d F %d Trg %d LUN %d CL %d\n",
1136 le32_to_cpu(bcb->Signature), bcb->Tag,
1137 le32_to_cpu(bcb->DataTransferLength), bcb->Flags,
1138 (bcb->Lun >> 4), (bcb->Lun & 0x0F),
1139 bcb->Length);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140 result = usb_stor_bulk_transfer_buf(us, us->send_bulk_pipe,
1141 bcb, cbwlen, NULL);
Joe Perches191648d2013-04-19 11:44:00 -07001142 usb_stor_dbg(us, "Bulk command transfer result=%d\n", result);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001143 if (result != USB_STOR_XFER_GOOD)
1144 return USB_STOR_TRANSPORT_ERROR;
1145
1146 /* DATA STAGE */
1147 /* send/receive data payload, if there is any */
1148
Felipe Balbif0183a32016-04-18 13:09:11 +03001149 /*
1150 * Some USB-IDE converter chips need a 100us delay between the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151 * command phase and the data phase. Some devices need a little
Felipe Balbif0183a32016-04-18 13:09:11 +03001152 * more than that, probably because of clock rate inaccuracies.
1153 */
Alan Stern7e4d6c32008-05-01 15:35:18 -04001154 if (unlikely(us->fflags & US_FL_GO_SLOW))
Sunny Kumare616b392015-07-07 12:27:03 +05301155 usleep_range(125, 150);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156
1157 if (transfer_length) {
1158 unsigned int pipe = srb->sc_data_direction == DMA_FROM_DEVICE ?
1159 us->recv_bulk_pipe : us->send_bulk_pipe;
Boaz Harrosh6d416e62007-09-10 18:01:08 +03001160 result = usb_stor_bulk_srb(us, pipe, srb);
Joe Perches191648d2013-04-19 11:44:00 -07001161 usb_stor_dbg(us, "Bulk data transfer result 0x%x\n", result);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001162 if (result == USB_STOR_XFER_ERROR)
1163 return USB_STOR_TRANSPORT_ERROR;
1164
Felipe Balbif0183a32016-04-18 13:09:11 +03001165 /*
1166 * If the device tried to send back more data than the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167 * amount requested, the spec requires us to transfer
1168 * the CSW anyway. Since there's no point retrying the
1169 * the command, we'll return fake sense data indicating
1170 * Illegal Request, Invalid Field in CDB.
1171 */
1172 if (result == USB_STOR_XFER_LONG)
1173 fake_sense = 1;
Alan Stern93c9bf42014-10-31 14:49:47 -04001174
1175 /*
1176 * Sometimes a device will mistakenly skip the data phase
1177 * and go directly to the status phase without sending a
1178 * zero-length packet. If we get a 13-byte response here,
1179 * check whether it really is a CSW.
1180 */
1181 if (result == USB_STOR_XFER_SHORT &&
1182 srb->sc_data_direction == DMA_FROM_DEVICE &&
1183 transfer_length - scsi_get_resid(srb) ==
1184 US_BULK_CS_WRAP_LEN) {
1185 struct scatterlist *sg = NULL;
1186 unsigned int offset = 0;
1187
1188 if (usb_stor_access_xfer_buf((unsigned char *) bcs,
1189 US_BULK_CS_WRAP_LEN, srb, &sg,
1190 &offset, FROM_XFER_BUF) ==
1191 US_BULK_CS_WRAP_LEN &&
1192 bcs->Signature ==
1193 cpu_to_le32(US_BULK_CS_SIGN)) {
1194 usb_stor_dbg(us, "Device skipped data phase\n");
1195 scsi_set_resid(srb, transfer_length);
1196 goto skipped_data_phase;
1197 }
1198 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199 }
1200
Felipe Balbif0183a32016-04-18 13:09:11 +03001201 /*
1202 * See flow chart on pg 15 of the Bulk Only Transport spec for
Linus Torvalds1da177e2005-04-16 15:20:36 -07001203 * an explanation of how this code works.
1204 */
1205
1206 /* get CSW for device status */
Joe Perches191648d2013-04-19 11:44:00 -07001207 usb_stor_dbg(us, "Attempting to get CSW...\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208 result = usb_stor_bulk_transfer_buf(us, us->recv_bulk_pipe,
1209 bcs, US_BULK_CS_WRAP_LEN, &cswlen);
1210
Felipe Balbif0183a32016-04-18 13:09:11 +03001211 /*
1212 * Some broken devices add unnecessary zero-length packets to the
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213 * end of their data transfers. Such packets show up as 0-length
1214 * CSWs. If we encounter such a thing, try to read the CSW again.
1215 */
1216 if (result == USB_STOR_XFER_SHORT && cswlen == 0) {
Joe Perches191648d2013-04-19 11:44:00 -07001217 usb_stor_dbg(us, "Received 0-length CSW; retrying...\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218 result = usb_stor_bulk_transfer_buf(us, us->recv_bulk_pipe,
1219 bcs, US_BULK_CS_WRAP_LEN, &cswlen);
1220 }
1221
1222 /* did the attempt to read the CSW fail? */
1223 if (result == USB_STOR_XFER_STALLED) {
1224
1225 /* get the status again */
Joe Perches191648d2013-04-19 11:44:00 -07001226 usb_stor_dbg(us, "Attempting to get CSW (2nd try)...\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227 result = usb_stor_bulk_transfer_buf(us, us->recv_bulk_pipe,
1228 bcs, US_BULK_CS_WRAP_LEN, NULL);
1229 }
1230
1231 /* if we still have a failure at this point, we're in trouble */
Joe Perches191648d2013-04-19 11:44:00 -07001232 usb_stor_dbg(us, "Bulk status result = %d\n", result);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001233 if (result != USB_STOR_XFER_GOOD)
1234 return USB_STOR_TRANSPORT_ERROR;
1235
Alan Stern93c9bf42014-10-31 14:49:47 -04001236 skipped_data_phase:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237 /* check bulk status */
1238 residue = le32_to_cpu(bcs->Residue);
Joe Perches191648d2013-04-19 11:44:00 -07001239 usb_stor_dbg(us, "Bulk Status S 0x%x T 0x%x R %u Stat 0x%x\n",
1240 le32_to_cpu(bcs->Signature), bcs->Tag,
1241 residue, bcs->Status);
Alan Stern7e4d6c32008-05-01 15:35:18 -04001242 if (!(bcs->Tag == us->tag || (us->fflags & US_FL_BULK_IGNORE_TAG)) ||
Constantin Baranovcc36bdd2008-03-16 20:04:23 +00001243 bcs->Status > US_BULK_STAT_PHASE) {
Joe Perches191648d2013-04-19 11:44:00 -07001244 usb_stor_dbg(us, "Bulk logical error\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245 return USB_STOR_TRANSPORT_ERROR;
1246 }
1247
Felipe Balbif0183a32016-04-18 13:09:11 +03001248 /*
1249 * Some broken devices report odd signatures, so we do not check them
Linus Torvalds1da177e2005-04-16 15:20:36 -07001250 * for validity against the spec. We store the first one we see,
1251 * and check subsequent transfers for validity against this signature.
1252 */
1253 if (!us->bcs_signature) {
1254 us->bcs_signature = bcs->Signature;
1255 if (us->bcs_signature != cpu_to_le32(US_BULK_CS_SIGN))
Joe Perches191648d2013-04-19 11:44:00 -07001256 usb_stor_dbg(us, "Learnt BCS signature 0x%08X\n",
1257 le32_to_cpu(us->bcs_signature));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001258 } else if (bcs->Signature != us->bcs_signature) {
Joe Perches191648d2013-04-19 11:44:00 -07001259 usb_stor_dbg(us, "Signature mismatch: got %08X, expecting %08X\n",
1260 le32_to_cpu(bcs->Signature),
1261 le32_to_cpu(us->bcs_signature));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262 return USB_STOR_TRANSPORT_ERROR;
1263 }
1264
Felipe Balbif0183a32016-04-18 13:09:11 +03001265 /*
1266 * try to compute the actual residue, based on how much data
1267 * was really transferred and what the device tells us
1268 */
Alan Stern59f4ff22008-07-29 11:58:06 -04001269 if (residue && !(us->fflags & US_FL_IGNORE_RESIDUE)) {
1270
Felipe Balbif0183a32016-04-18 13:09:11 +03001271 /*
1272 * Heuristically detect devices that generate bogus residues
Alan Stern59f4ff22008-07-29 11:58:06 -04001273 * by seeing what happens with INQUIRY and READ CAPACITY
1274 * commands.
1275 */
1276 if (bcs->Status == US_BULK_STAT_OK &&
1277 scsi_get_resid(srb) == 0 &&
1278 ((srb->cmnd[0] == INQUIRY &&
1279 transfer_length == 36) ||
1280 (srb->cmnd[0] == READ_CAPACITY &&
1281 transfer_length == 8))) {
1282 us->fflags |= US_FL_IGNORE_RESIDUE;
1283
1284 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001285 residue = min(residue, transfer_length);
Boaz Harrosh6d416e62007-09-10 18:01:08 +03001286 scsi_set_resid(srb, max(scsi_get_resid(srb),
1287 (int) residue));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288 }
1289 }
1290
1291 /* based on the status code, we report good or bad */
1292 switch (bcs->Status) {
1293 case US_BULK_STAT_OK:
1294 /* device babbled -- return fake sense data */
1295 if (fake_sense) {
1296 memcpy(srb->sense_buffer,
1297 usb_stor_sense_invalidCDB,
1298 sizeof(usb_stor_sense_invalidCDB));
1299 return USB_STOR_TRANSPORT_NO_SENSE;
1300 }
1301
1302 /* command good -- note that data could be short */
1303 return USB_STOR_TRANSPORT_GOOD;
1304
1305 case US_BULK_STAT_FAIL:
1306 /* command failed */
1307 return USB_STOR_TRANSPORT_FAILED;
1308
1309 case US_BULK_STAT_PHASE:
Felipe Balbif0183a32016-04-18 13:09:11 +03001310 /*
1311 * phase error -- note that a transport reset will be
Linus Torvalds1da177e2005-04-16 15:20:36 -07001312 * invoked by the invoke_transport() function
1313 */
1314 return USB_STOR_TRANSPORT_ERROR;
1315 }
1316
1317 /* we should never get here, but if we do, we're in trouble */
1318 return USB_STOR_TRANSPORT_ERROR;
1319}
Alan Sterne6e244b2009-02-12 14:47:44 -05001320EXPORT_SYMBOL_GPL(usb_stor_Bulk_transport);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321
1322/***********************************************************************
1323 * Reset routines
1324 ***********************************************************************/
1325
Felipe Balbif0183a32016-04-18 13:09:11 +03001326/*
1327 * This is the common part of the device reset code.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001328 *
1329 * It's handy that every transport mechanism uses the control endpoint for
1330 * resets.
1331 *
Matthew Dharm5203ad42005-06-06 17:19:29 -07001332 * Basically, we send a reset with a 5-second timeout, so we don't get
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 * jammed attempting to do the reset.
1334 */
1335static int usb_stor_reset_common(struct us_data *us,
1336 u8 request, u8 requesttype,
1337 u16 value, u16 index, void *data, u16 size)
1338{
1339 int result;
1340 int result2;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341
Alan Stern7e4d6c32008-05-01 15:35:18 -04001342 if (test_bit(US_FLIDX_DISCONNECTING, &us->dflags)) {
Joe Perches191648d2013-04-19 11:44:00 -07001343 usb_stor_dbg(us, "No reset during disconnect\n");
Matthew Dharm4d07ef72005-06-06 17:21:41 -07001344 return -EIO;
1345 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347 result = usb_stor_control_msg(us, us->send_ctrl_pipe,
1348 request, requesttype, value, index, data, size,
Matthew Dharm5203ad42005-06-06 17:19:29 -07001349 5*HZ);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350 if (result < 0) {
Joe Perches191648d2013-04-19 11:44:00 -07001351 usb_stor_dbg(us, "Soft reset failed: %d\n", result);
Matthew Dharm4d07ef72005-06-06 17:21:41 -07001352 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353 }
1354
Felipe Balbif0183a32016-04-18 13:09:11 +03001355 /*
1356 * Give the device some time to recover from the reset,
1357 * but don't delay disconnect processing.
1358 */
Alan Stern7e4d6c32008-05-01 15:35:18 -04001359 wait_event_interruptible_timeout(us->delay_wait,
1360 test_bit(US_FLIDX_DISCONNECTING, &us->dflags),
1361 HZ*6);
1362 if (test_bit(US_FLIDX_DISCONNECTING, &us->dflags)) {
Joe Perches191648d2013-04-19 11:44:00 -07001363 usb_stor_dbg(us, "Reset interrupted by disconnect\n");
Matthew Dharm4d07ef72005-06-06 17:21:41 -07001364 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365 }
1366
Joe Perches191648d2013-04-19 11:44:00 -07001367 usb_stor_dbg(us, "Soft reset: clearing bulk-in endpoint halt\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368 result = usb_stor_clear_halt(us, us->recv_bulk_pipe);
1369
Joe Perches191648d2013-04-19 11:44:00 -07001370 usb_stor_dbg(us, "Soft reset: clearing bulk-out endpoint halt\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371 result2 = usb_stor_clear_halt(us, us->send_bulk_pipe);
1372
Matthew Dharm5203ad42005-06-06 17:19:29 -07001373 /* return a result code based on the result of the clear-halts */
1374 if (result >= 0)
1375 result = result2;
Matthew Dharm4d07ef72005-06-06 17:21:41 -07001376 if (result < 0)
Joe Perches191648d2013-04-19 11:44:00 -07001377 usb_stor_dbg(us, "Soft reset failed\n");
Matthew Dharm4d07ef72005-06-06 17:21:41 -07001378 else
Joe Perches191648d2013-04-19 11:44:00 -07001379 usb_stor_dbg(us, "Soft reset done\n");
Matthew Dharm4d07ef72005-06-06 17:21:41 -07001380 return result;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381}
1382
Felipe Balbif0183a32016-04-18 13:09:11 +03001383/* This issues a CB[I] Reset to the device in question */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001384#define CB_RESET_CMD_SIZE 12
1385
1386int usb_stor_CB_reset(struct us_data *us)
1387{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388 memset(us->iobuf, 0xFF, CB_RESET_CMD_SIZE);
1389 us->iobuf[0] = SEND_DIAGNOSTIC;
1390 us->iobuf[1] = 4;
1391 return usb_stor_reset_common(us, US_CBI_ADSC,
1392 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
1393 0, us->ifnum, us->iobuf, CB_RESET_CMD_SIZE);
1394}
Alan Sterne6e244b2009-02-12 14:47:44 -05001395EXPORT_SYMBOL_GPL(usb_stor_CB_reset);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396
Felipe Balbif0183a32016-04-18 13:09:11 +03001397/*
1398 * This issues a Bulk-only Reset to the device in question, including
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399 * clearing the subsequent endpoint halts that may occur.
1400 */
1401int usb_stor_Bulk_reset(struct us_data *us)
1402{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 return usb_stor_reset_common(us, US_BULK_RESET_REQUEST,
1404 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
1405 0, us->ifnum, NULL, 0);
1406}
Alan Sterne6e244b2009-02-12 14:47:44 -05001407EXPORT_SYMBOL_GPL(usb_stor_Bulk_reset);
Matthew Dharm4d07ef72005-06-06 17:21:41 -07001408
Felipe Balbif0183a32016-04-18 13:09:11 +03001409/*
1410 * Issue a USB port reset to the device. The caller must not hold
Alan Stern47104b02006-06-01 13:52:56 -04001411 * us->dev_mutex.
1412 */
Matthew Dharm4d07ef72005-06-06 17:21:41 -07001413int usb_stor_port_reset(struct us_data *us)
1414{
Alan Stern011b15d2008-11-04 11:29:27 -05001415 int result;
Matthew Dharm4d07ef72005-06-06 17:21:41 -07001416
Oliver Neukum5d398772009-12-18 12:14:21 +01001417 /*for these devices we must use the class specific method */
Lan Tianyu7fda9532012-08-17 16:44:56 +08001418 if (us->pusb_dev->quirks & USB_QUIRK_RESET)
Oliver Neukum5d398772009-12-18 12:14:21 +01001419 return -EPERM;
1420
Alan Stern011b15d2008-11-04 11:29:27 -05001421 result = usb_lock_device_for_reset(us->pusb_dev, us->pusb_intf);
Alan Stern47104b02006-06-01 13:52:56 -04001422 if (result < 0)
Joe Perches191648d2013-04-19 11:44:00 -07001423 usb_stor_dbg(us, "unable to lock device for reset: %d\n",
1424 result);
Alan Stern47104b02006-06-01 13:52:56 -04001425 else {
1426 /* Were we disconnected while waiting for the lock? */
Alan Stern7e4d6c32008-05-01 15:35:18 -04001427 if (test_bit(US_FLIDX_DISCONNECTING, &us->dflags)) {
Alan Stern47104b02006-06-01 13:52:56 -04001428 result = -EIO;
Joe Perches191648d2013-04-19 11:44:00 -07001429 usb_stor_dbg(us, "No reset during disconnect\n");
Matthew Dharm4d07ef72005-06-06 17:21:41 -07001430 } else {
Ming Lei742120c2008-06-18 22:00:29 +08001431 result = usb_reset_device(us->pusb_dev);
Joe Perches191648d2013-04-19 11:44:00 -07001432 usb_stor_dbg(us, "usb_reset_device returns %d\n",
1433 result);
Matthew Dharm4d07ef72005-06-06 17:21:41 -07001434 }
Alan Stern011b15d2008-11-04 11:29:27 -05001435 usb_unlock_device(us->pusb_dev);
Matthew Dharm4d07ef72005-06-06 17:21:41 -07001436 }
1437 return result;
1438}