import PULS_20160108
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / usb / storage / transport.c
1 /* Driver for USB Mass Storage compliant devices
2 *
3 * Current development and maintenance by:
4 * (c) 1999-2002 Matthew Dharm (mdharm-usb@one-eyed-alien.net)
5 *
6 * Developed with the assistance of:
7 * (c) 2000 David L. Brown, Jr. (usb-storage@davidb.org)
8 * (c) 2000 Stephen J. Gowdy (SGowdy@lbl.gov)
9 * (c) 2002 Alan Stern <stern@rowland.org>
10 *
11 * Initial work by:
12 * (c) 1999 Michael Gee (michael@linuxspecific.com)
13 *
14 * This driver is based on the 'USB Mass Storage Class' document. This
15 * describes in detail the protocol used to communicate with such
16 * devices. Clearly, the designers had SCSI and ATAPI commands in
17 * mind when they created this document. The commands are all very
18 * similar to commands in the SCSI-II and ATAPI specifications.
19 *
20 * It is important to note that in a number of cases this class
21 * exhibits class-specific exemptions from the USB specification.
22 * Notably the usage of NAK, STALL and ACK differs from the norm, in
23 * that they are used to communicate wait, failed and OK on commands.
24 *
25 * Also, for certain devices, the interrupt endpoint is used to convey
26 * status of a command.
27 *
28 * Please see http://www.one-eyed-alien.net/~mdharm/linux-usb for more
29 * information about this driver.
30 *
31 * This program is free software; you can redistribute it and/or modify it
32 * under the terms of the GNU General Public License as published by the
33 * Free Software Foundation; either version 2, or (at your option) any
34 * later version.
35 *
36 * This program is distributed in the hope that it will be useful, but
37 * WITHOUT ANY WARRANTY; without even the implied warranty of
38 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
39 * General Public License for more details.
40 *
41 * You should have received a copy of the GNU General Public License along
42 * with this program; if not, write to the Free Software Foundation, Inc.,
43 * 675 Mass Ave, Cambridge, MA 02139, USA.
44 */
45
46 #include <linux/sched.h>
47 #include <linux/gfp.h>
48 #include <linux/errno.h>
49 #include <linux/export.h>
50
51 #include <linux/usb/quirks.h>
52
53 #include <scsi/scsi.h>
54 #include <scsi/scsi_eh.h>
55 #include <scsi/scsi_device.h>
56
57 #include "usb.h"
58 #include "transport.h"
59 #include "protocol.h"
60 #include "scsiglue.h"
61 #include "debug.h"
62
63 #include <linux/blkdev.h>
64 #include "../../scsi/sd.h"
65
66
67 /***********************************************************************
68 * Data transfer routines
69 ***********************************************************************/
70
71 /*
72 * This is subtle, so pay attention:
73 * ---------------------------------
74 * We're very concerned about races with a command abort. Hanging this code
75 * is a sure fire way to hang the kernel. (Note that this discussion applies
76 * only to transactions resulting from a scsi queued-command, since only
77 * these transactions are subject to a scsi abort. Other transactions, such
78 * as those occurring during device-specific initialization, must be handled
79 * by a separate code path.)
80 *
81 * The abort function (usb_storage_command_abort() in scsiglue.c) first
82 * sets the machine state and the ABORTING bit in us->dflags to prevent
83 * new URBs from being submitted. It then calls usb_stor_stop_transport()
84 * below, which atomically tests-and-clears the URB_ACTIVE bit in us->dflags
85 * to see if the current_urb needs to be stopped. Likewise, the SG_ACTIVE
86 * bit is tested to see if the current_sg scatter-gather request needs to be
87 * stopped. The timeout callback routine does much the same thing.
88 *
89 * When a disconnect occurs, the DISCONNECTING bit in us->dflags is set to
90 * prevent new URBs from being submitted, and usb_stor_stop_transport() is
91 * called to stop any ongoing requests.
92 *
93 * The submit function first verifies that the submitting is allowed
94 * (neither ABORTING nor DISCONNECTING bits are set) and that the submit
95 * completes without errors, and only then sets the URB_ACTIVE bit. This
96 * prevents the stop_transport() function from trying to cancel the URB
97 * while the submit call is underway. Next, the submit function must test
98 * the flags to see if an abort or disconnect occurred during the submission
99 * or before the URB_ACTIVE bit was set. If so, it's essential to cancel
100 * the URB if it hasn't been cancelled already (i.e., if the URB_ACTIVE bit
101 * is still set). Either way, the function must then wait for the URB to
102 * finish. Note that the URB can still be in progress even after a call to
103 * usb_unlink_urb() returns.
104 *
105 * The idea is that (1) once the ABORTING or DISCONNECTING bit is set,
106 * either the stop_transport() function or the submitting function
107 * is guaranteed to call usb_unlink_urb() for an active URB,
108 * and (2) test_and_clear_bit() prevents usb_unlink_urb() from being
109 * called more than once or from being called during usb_submit_urb().
110 */
111
112 /* This is the completion handler which will wake us up when an URB
113 * completes.
114 */
115 static void usb_stor_blocking_completion(struct urb *urb)
116 {
117 struct completion *urb_done_ptr = urb->context;
118
119 complete(urb_done_ptr);
120 }
121
122 /* This is the common part of the URB message submission code
123 *
124 * All URBs from the usb-storage driver involved in handling a queued scsi
125 * command _must_ pass through this function (or something like it) for the
126 * abort mechanisms to work properly.
127 */
128 static int usb_stor_msg_common(struct us_data *us, int timeout)
129 {
130 struct completion urb_done;
131 long timeleft;
132 int status;
133
134 /* don't submit URBs during abort processing */
135 if (test_bit(US_FLIDX_ABORTING, &us->dflags))
136 return -EIO;
137
138 /* set up data structures for the wakeup system */
139 init_completion(&urb_done);
140
141 /* fill the common fields in the URB */
142 us->current_urb->context = &urb_done;
143 us->current_urb->transfer_flags = 0;
144
145 /* we assume that if transfer_buffer isn't us->iobuf then it
146 * hasn't been mapped for DMA. Yes, this is clunky, but it's
147 * easier than always having the caller tell us whether the
148 * transfer buffer has already been mapped. */
149 if (us->current_urb->transfer_buffer == us->iobuf)
150 us->current_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
151 //Added for Rx DMA mode1, ReqMode1 enable
152 us->current_urb->transfer_flags |= URB_RX_REQ_MODE0_ENABLE;
153 //Added for Rx DMA mode1, ReqMode1 enable
154 us->current_urb->transfer_dma = us->iobuf_dma;
155
156 /* submit the URB */
157 status = usb_submit_urb(us->current_urb, GFP_NOIO);
158 if (status) {
159 /* something went wrong */
160 return status;
161 }
162
163 /* since the URB has been submitted successfully, it's now okay
164 * to cancel it */
165 set_bit(US_FLIDX_URB_ACTIVE, &us->dflags);
166
167 /* did an abort occur during the submission? */
168 if (test_bit(US_FLIDX_ABORTING, &us->dflags)) {
169
170 /* cancel the URB, if it hasn't been cancelled already */
171 if (test_and_clear_bit(US_FLIDX_URB_ACTIVE, &us->dflags)) {
172 usb_stor_dbg(us, "-- cancelling URB\n");
173 usb_unlink_urb(us->current_urb);
174 }
175 }
176
177 /* wait for the completion of the URB */
178 timeleft = wait_for_completion_interruptible_timeout(
179 &urb_done, timeout ? : MAX_SCHEDULE_TIMEOUT);
180
181 clear_bit(US_FLIDX_URB_ACTIVE, &us->dflags);
182
183 if (timeleft <= 0) {
184 usb_stor_dbg(us, "%s -- cancelling URB\n",
185 timeleft == 0 ? "Timeout" : "Signal");
186 usb_kill_urb(us->current_urb);
187 }
188
189 /* return the URB status */
190 return us->current_urb->status;
191 }
192
193 /*
194 * Transfer one control message, with timeouts, and allowing early
195 * termination. Return codes are usual -Exxx, *not* USB_STOR_XFER_xxx.
196 */
197 int usb_stor_control_msg(struct us_data *us, unsigned int pipe,
198 u8 request, u8 requesttype, u16 value, u16 index,
199 void *data, u16 size, int timeout)
200 {
201 int status;
202
203 usb_stor_dbg(us, "rq=%02x rqtype=%02x value=%04x index=%02x len=%u\n",
204 request, requesttype, value, index, size);
205
206 /* fill in the devrequest structure */
207 us->cr->bRequestType = requesttype;
208 us->cr->bRequest = request;
209 us->cr->wValue = cpu_to_le16(value);
210 us->cr->wIndex = cpu_to_le16(index);
211 us->cr->wLength = cpu_to_le16(size);
212
213 /* fill and submit the URB */
214 usb_fill_control_urb(us->current_urb, us->pusb_dev, pipe,
215 (unsigned char*) us->cr, data, size,
216 usb_stor_blocking_completion, NULL);
217 status = usb_stor_msg_common(us, timeout);
218
219 /* return the actual length of the data transferred if no error */
220 if (status == 0)
221 status = us->current_urb->actual_length;
222 return status;
223 }
224 EXPORT_SYMBOL_GPL(usb_stor_control_msg);
225
226 /* This is a version of usb_clear_halt() that allows early termination and
227 * doesn't read the status from the device -- this is because some devices
228 * crash their internal firmware when the status is requested after a halt.
229 *
230 * A definitive list of these 'bad' devices is too difficult to maintain or
231 * make complete enough to be useful. This problem was first observed on the
232 * Hagiwara FlashGate DUAL unit. However, bus traces reveal that neither
233 * MacOS nor Windows checks the status after clearing a halt.
234 *
235 * Since many vendors in this space limit their testing to interoperability
236 * with these two OSes, specification violations like this one are common.
237 */
238 int usb_stor_clear_halt(struct us_data *us, unsigned int pipe)
239 {
240 int result;
241 int endp = usb_pipeendpoint(pipe);
242
243 if (usb_pipein (pipe))
244 endp |= USB_DIR_IN;
245
246 result = usb_stor_control_msg(us, us->send_ctrl_pipe,
247 USB_REQ_CLEAR_FEATURE, USB_RECIP_ENDPOINT,
248 USB_ENDPOINT_HALT, endp,
249 NULL, 0, 3*HZ);
250
251 if (result >= 0)
252 usb_reset_endpoint(us->pusb_dev, endp);
253
254 usb_stor_dbg(us, "result = %d\n", result);
255 return result;
256 }
257 EXPORT_SYMBOL_GPL(usb_stor_clear_halt);
258
259
260 /*
261 * Interpret the results of a URB transfer
262 *
263 * This function prints appropriate debugging messages, clears halts on
264 * non-control endpoints, and translates the status to the corresponding
265 * USB_STOR_XFER_xxx return code.
266 */
267 static int interpret_urb_result(struct us_data *us, unsigned int pipe,
268 unsigned int length, int result, unsigned int partial)
269 {
270 usb_stor_dbg(us, "Status code %d; transferred %u/%u\n",
271 result, partial, length);
272 switch (result) {
273
274 /* no error code; did we send all the data? */
275 case 0:
276 if (partial != length) {
277 usb_stor_dbg(us, "-- short transfer\n");
278 return USB_STOR_XFER_SHORT;
279 }
280
281 usb_stor_dbg(us, "-- transfer complete\n");
282 return USB_STOR_XFER_GOOD;
283
284 /* stalled */
285 case -EPIPE:
286 /* for control endpoints, (used by CB[I]) a stall indicates
287 * a failed command */
288 if (usb_pipecontrol(pipe)) {
289 usb_stor_dbg(us, "-- stall on control pipe\n");
290 return USB_STOR_XFER_STALLED;
291 }
292
293 /* for other sorts of endpoint, clear the stall */
294 usb_stor_dbg(us, "clearing endpoint halt for pipe 0x%x\n",
295 pipe);
296 if (usb_stor_clear_halt(us, pipe) < 0)
297 return USB_STOR_XFER_ERROR;
298 return USB_STOR_XFER_STALLED;
299
300 /* babble - the device tried to send more than we wanted to read */
301 case -EOVERFLOW:
302 usb_stor_dbg(us, "-- babble\n");
303 return USB_STOR_XFER_LONG;
304
305 /* the transfer was cancelled by abort, disconnect, or timeout */
306 case -ECONNRESET:
307 usb_stor_dbg(us, "-- transfer cancelled\n");
308 return USB_STOR_XFER_ERROR;
309
310 /* short scatter-gather read transfer */
311 case -EREMOTEIO:
312 usb_stor_dbg(us, "-- short read transfer\n");
313 return USB_STOR_XFER_SHORT;
314
315 /* abort or disconnect in progress */
316 case -EIO:
317 usb_stor_dbg(us, "-- abort or disconnect in progress\n");
318 return USB_STOR_XFER_ERROR;
319
320 /* the catch-all error case */
321 default:
322 usb_stor_dbg(us, "-- unknown error\n");
323 return USB_STOR_XFER_ERROR;
324 }
325 }
326
327 /*
328 * Transfer one control message, without timeouts, but allowing early
329 * termination. Return codes are USB_STOR_XFER_xxx.
330 */
331 int usb_stor_ctrl_transfer(struct us_data *us, unsigned int pipe,
332 u8 request, u8 requesttype, u16 value, u16 index,
333 void *data, u16 size)
334 {
335 int result;
336
337 usb_stor_dbg(us, "rq=%02x rqtype=%02x value=%04x index=%02x len=%u\n",
338 request, requesttype, value, index, size);
339
340 /* fill in the devrequest structure */
341 us->cr->bRequestType = requesttype;
342 us->cr->bRequest = request;
343 us->cr->wValue = cpu_to_le16(value);
344 us->cr->wIndex = cpu_to_le16(index);
345 us->cr->wLength = cpu_to_le16(size);
346
347 /* fill and submit the URB */
348 usb_fill_control_urb(us->current_urb, us->pusb_dev, pipe,
349 (unsigned char*) us->cr, data, size,
350 usb_stor_blocking_completion, NULL);
351 result = usb_stor_msg_common(us, 0);
352
353 return interpret_urb_result(us, pipe, size, result,
354 us->current_urb->actual_length);
355 }
356 EXPORT_SYMBOL_GPL(usb_stor_ctrl_transfer);
357
358 /*
359 * Receive one interrupt buffer, without timeouts, but allowing early
360 * termination. Return codes are USB_STOR_XFER_xxx.
361 *
362 * This routine always uses us->recv_intr_pipe as the pipe and
363 * us->ep_bInterval as the interrupt interval.
364 */
365 static int usb_stor_intr_transfer(struct us_data *us, void *buf,
366 unsigned int length)
367 {
368 int result;
369 unsigned int pipe = us->recv_intr_pipe;
370 unsigned int maxp;
371
372 usb_stor_dbg(us, "xfer %u bytes\n", length);
373
374 /* calculate the max packet size */
375 maxp = usb_maxpacket(us->pusb_dev, pipe, usb_pipeout(pipe));
376 if (maxp > length)
377 maxp = length;
378
379 /* fill and submit the URB */
380 usb_fill_int_urb(us->current_urb, us->pusb_dev, pipe, buf,
381 maxp, usb_stor_blocking_completion, NULL,
382 us->ep_bInterval);
383 result = usb_stor_msg_common(us, 0);
384
385 return interpret_urb_result(us, pipe, length, result,
386 us->current_urb->actual_length);
387 }
388
389 /*
390 * Transfer one buffer via bulk pipe, without timeouts, but allowing early
391 * termination. Return codes are USB_STOR_XFER_xxx. If the bulk pipe
392 * stalls during the transfer, the halt is automatically cleared.
393 */
394 int usb_stor_bulk_transfer_buf(struct us_data *us, unsigned int pipe,
395 void *buf, unsigned int length, unsigned int *act_len)
396 {
397 int result;
398
399 usb_stor_dbg(us, "xfer %u bytes\n", length);
400
401 /* fill and submit the URB */
402 usb_fill_bulk_urb(us->current_urb, us->pusb_dev, pipe, buf, length,
403 usb_stor_blocking_completion, NULL);
404 result = usb_stor_msg_common(us, 0);
405
406 /* store the actual length of the data transferred */
407 if (act_len)
408 *act_len = us->current_urb->actual_length;
409 return interpret_urb_result(us, pipe, length, result,
410 us->current_urb->actual_length);
411 }
412 EXPORT_SYMBOL_GPL(usb_stor_bulk_transfer_buf);
413
414 /*
415 * Transfer a scatter-gather list via bulk transfer
416 *
417 * This function does basically the same thing as usb_stor_bulk_transfer_buf()
418 * above, but it uses the usbcore scatter-gather library.
419 */
420 static int usb_stor_bulk_transfer_sglist(struct us_data *us, unsigned int pipe,
421 struct scatterlist *sg, int num_sg, unsigned int length,
422 unsigned int *act_len)
423 {
424 int result;
425
426 /* don't submit s-g requests during abort processing */
427 if (test_bit(US_FLIDX_ABORTING, &us->dflags))
428 return USB_STOR_XFER_ERROR;
429
430 /* initialize the scatter-gather request block */
431 usb_stor_dbg(us, "xfer %u bytes, %d entries\n", length, num_sg);
432 result = usb_sg_init(&us->current_sg, us->pusb_dev, pipe, 0,
433 sg, num_sg, length, GFP_NOIO);
434 if (result) {
435 usb_stor_dbg(us, "usb_sg_init returned %d\n", result);
436 return USB_STOR_XFER_ERROR;
437 }
438
439 /* since the block has been initialized successfully, it's now
440 * okay to cancel it */
441 set_bit(US_FLIDX_SG_ACTIVE, &us->dflags);
442
443 /* did an abort occur during the submission? */
444 if (test_bit(US_FLIDX_ABORTING, &us->dflags)) {
445
446 /* cancel the request, if it hasn't been cancelled already */
447 if (test_and_clear_bit(US_FLIDX_SG_ACTIVE, &us->dflags)) {
448 usb_stor_dbg(us, "-- cancelling sg request\n");
449 usb_sg_cancel(&us->current_sg);
450 }
451 }
452
453 /* wait for the completion of the transfer */
454 usb_sg_wait(&us->current_sg);
455 clear_bit(US_FLIDX_SG_ACTIVE, &us->dflags);
456
457 result = us->current_sg.status;
458 if (act_len)
459 *act_len = us->current_sg.bytes;
460 return interpret_urb_result(us, pipe, length, result,
461 us->current_sg.bytes);
462 }
463
464 /*
465 * Common used function. Transfer a complete command
466 * via usb_stor_bulk_transfer_sglist() above. Set cmnd resid
467 */
468 int usb_stor_bulk_srb(struct us_data* us, unsigned int pipe,
469 struct scsi_cmnd* srb)
470 {
471 unsigned int partial;
472 int result = usb_stor_bulk_transfer_sglist(us, pipe, scsi_sglist(srb),
473 scsi_sg_count(srb), scsi_bufflen(srb),
474 &partial);
475
476 scsi_set_resid(srb, scsi_bufflen(srb) - partial);
477 return result;
478 }
479 EXPORT_SYMBOL_GPL(usb_stor_bulk_srb);
480
481 /*
482 * Transfer an entire SCSI command's worth of data payload over the bulk
483 * pipe.
484 *
485 * Note that this uses usb_stor_bulk_transfer_buf() and
486 * usb_stor_bulk_transfer_sglist() to achieve its goals --
487 * this function simply determines whether we're going to use
488 * scatter-gather or not, and acts appropriately.
489 */
490 int usb_stor_bulk_transfer_sg(struct us_data* us, unsigned int pipe,
491 void *buf, unsigned int length_left, int use_sg, int *residual)
492 {
493 int result;
494 unsigned int partial;
495
496 /* are we scatter-gathering? */
497 if (use_sg) {
498 /* use the usb core scatter-gather primitives */
499 result = usb_stor_bulk_transfer_sglist(us, pipe,
500 (struct scatterlist *) buf, use_sg,
501 length_left, &partial);
502 length_left -= partial;
503 } else {
504 /* no scatter-gather, just make the request */
505 result = usb_stor_bulk_transfer_buf(us, pipe, buf,
506 length_left, &partial);
507 length_left -= partial;
508 }
509
510 /* store the residual and return the error code */
511 if (residual)
512 *residual = length_left;
513 return result;
514 }
515 EXPORT_SYMBOL_GPL(usb_stor_bulk_transfer_sg);
516
517 /***********************************************************************
518 * Transport routines
519 ***********************************************************************/
520
521 /* There are so many devices that report the capacity incorrectly,
522 * this routine was written to counteract some of the resulting
523 * problems.
524 */
525 static void last_sector_hacks(struct us_data *us, struct scsi_cmnd *srb)
526 {
527 struct gendisk *disk;
528 struct scsi_disk *sdkp;
529 u32 sector;
530
531 /* To Report "Medium Error: Record Not Found */
532 static unsigned char record_not_found[18] = {
533 [0] = 0x70, /* current error */
534 [2] = MEDIUM_ERROR, /* = 0x03 */
535 [7] = 0x0a, /* additional length */
536 [12] = 0x14 /* Record Not Found */
537 };
538
539 /* If last-sector problems can't occur, whether because the
540 * 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
565 /* The command succeeded. We know this device doesn't
566 * have the last-sector bug, so stop checking it.
567 */
568 us->use_last_sector_hacks = 0;
569
570 } else {
571 /* The command failed. Allow up to 3 retries in case this
572 * is some normal sort of failure. After that, assume the
573 * capacity is wrong and we're trying to access the sector
574 * beyond the end. Replace the result code and sense data
575 * with values that will cause the SCSI core to fail the
576 * command immediately, instead of going into an infinite
577 * (or even just a very long) retry loop.
578 */
579 if (++us->last_sector_retries < 3)
580 return;
581 srb->result = SAM_STAT_CHECK_CONDITION;
582 memcpy(srb->sense_buffer, record_not_found,
583 sizeof(record_not_found));
584 }
585
586 done:
587 /* Don't reset the retry counter for TEST UNIT READY commands,
588 * because they get issued after device resets which might be
589 * caused by a failed last-sector access.
590 */
591 if (srb->cmnd[0] != TEST_UNIT_READY)
592 us->last_sector_retries = 0;
593 }
594
595 /* Invoke the transport and basic error-handling/recovery methods
596 *
597 * This is used by the protocol layers to actually send the message to
598 * the device and receive the response.
599 */
600 void usb_stor_invoke_transport(struct scsi_cmnd *srb, struct us_data *us)
601 {
602 int need_auto_sense;
603 int result;
604
605 /* send the command to the transport layer */
606 scsi_set_resid(srb, 0);
607 result = us->transport(srb, us);
608
609 /* if the command gets aborted by the higher layers, we need to
610 * short-circuit all other processing
611 */
612 if (test_bit(US_FLIDX_TIMED_OUT, &us->dflags)) {
613 usb_stor_dbg(us, "-- command was aborted\n");
614 srb->result = DID_ABORT << 16;
615 goto Handle_Errors;
616 }
617
618 /* if there is a transport error, reset and don't auto-sense */
619 if (result == USB_STOR_TRANSPORT_ERROR) {
620 usb_stor_dbg(us, "-- transport indicates error, resetting\n");
621 srb->result = DID_ERROR << 16;
622 goto Handle_Errors;
623 }
624
625 /* if the transport provided its own sense data, don't auto-sense */
626 if (result == USB_STOR_TRANSPORT_NO_SENSE) {
627 srb->result = SAM_STAT_CHECK_CONDITION;
628 last_sector_hacks(us, srb);
629 return;
630 }
631
632 srb->result = SAM_STAT_GOOD;
633
634 /* Determine if we need to auto-sense
635 *
636 * I normally don't use a flag like this, but it's almost impossible
637 * to understand what's going on here if I don't.
638 */
639 need_auto_sense = 0;
640
641 /*
642 * If we're running the CB transport, which is incapable
643 * of determining status on its own, we will auto-sense
644 * unless the operation involved a data-in transfer. Devices
645 * can signal most data-in errors by stalling the bulk-in pipe.
646 */
647 if ((us->protocol == USB_PR_CB || us->protocol == USB_PR_DPCM_USB) &&
648 srb->sc_data_direction != DMA_FROM_DEVICE) {
649 usb_stor_dbg(us, "-- CB transport device requiring auto-sense\n");
650 need_auto_sense = 1;
651 }
652
653 /*
654 * If we have a failure, we're going to do a REQUEST_SENSE
655 * automatically. Note that we differentiate between a command
656 * "failure" and an "error" in the transport mechanism.
657 */
658 if (result == USB_STOR_TRANSPORT_FAILED) {
659 usb_stor_dbg(us, "-- transport indicates command failure\n");
660 need_auto_sense = 1;
661 }
662
663 /*
664 * Determine if this device is SAT by seeing if the
665 * command executed successfully. Otherwise we'll have
666 * to wait for at least one CHECK_CONDITION to determine
667 * SANE_SENSE support
668 */
669 if (unlikely((srb->cmnd[0] == ATA_16 || srb->cmnd[0] == ATA_12) &&
670 result == USB_STOR_TRANSPORT_GOOD &&
671 !(us->fflags & US_FL_SANE_SENSE) &&
672 !(us->fflags & US_FL_BAD_SENSE) &&
673 !(srb->cmnd[2] & 0x20))) {
674 usb_stor_dbg(us, "-- SAT supported, increasing auto-sense\n");
675 us->fflags |= US_FL_SANE_SENSE;
676 }
677
678 /*
679 * A short transfer on a command where we don't expect it
680 * is unusual, but it doesn't mean we need to auto-sense.
681 */
682 if ((scsi_get_resid(srb) > 0) &&
683 !((srb->cmnd[0] == REQUEST_SENSE) ||
684 (srb->cmnd[0] == INQUIRY) ||
685 (srb->cmnd[0] == MODE_SENSE) ||
686 (srb->cmnd[0] == LOG_SENSE) ||
687 (srb->cmnd[0] == MODE_SENSE_10))) {
688 usb_stor_dbg(us, "-- unexpectedly short transfer\n");
689 }
690
691 /* Now, if we need to do the auto-sense, let's do it */
692 if (need_auto_sense) {
693 int temp_result;
694 struct scsi_eh_save ses;
695 int sense_size = US_SENSE_SIZE;
696 struct scsi_sense_hdr sshdr;
697 const u8 *scdd;
698 u8 fm_ili;
699
700 /* device supports and needs bigger sense buffer */
701 if (us->fflags & US_FL_SANE_SENSE)
702 sense_size = ~0;
703 Retry_Sense:
704 usb_stor_dbg(us, "Issuing auto-REQUEST_SENSE\n");
705
706 scsi_eh_prep_cmnd(srb, &ses, NULL, 0, sense_size);
707
708 /* FIXME: we must do the protocol translation here */
709 if (us->subclass == USB_SC_RBC || us->subclass == USB_SC_SCSI ||
710 us->subclass == USB_SC_CYP_ATACB)
711 srb->cmd_len = 6;
712 else
713 srb->cmd_len = 12;
714
715 /* issue the auto-sense command */
716 scsi_set_resid(srb, 0);
717 temp_result = us->transport(us->srb, us);
718
719 /* let's clean up right away */
720 scsi_eh_restore_cmnd(srb, &ses);
721
722 if (test_bit(US_FLIDX_TIMED_OUT, &us->dflags)) {
723 usb_stor_dbg(us, "-- auto-sense aborted\n");
724 srb->result = DID_ABORT << 16;
725
726 /* If SANE_SENSE caused this problem, disable it */
727 if (sense_size != US_SENSE_SIZE) {
728 us->fflags &= ~US_FL_SANE_SENSE;
729 us->fflags |= US_FL_BAD_SENSE;
730 }
731 goto Handle_Errors;
732 }
733
734 /* Some devices claim to support larger sense but fail when
735 * trying to request it. When a transport failure happens
736 * using US_FS_SANE_SENSE, we always retry with a standard
737 * (small) sense request. This fixes some USB GSM modems
738 */
739 if (temp_result == USB_STOR_TRANSPORT_FAILED &&
740 sense_size != US_SENSE_SIZE) {
741 usb_stor_dbg(us, "-- auto-sense failure, retry small sense\n");
742 sense_size = US_SENSE_SIZE;
743 us->fflags &= ~US_FL_SANE_SENSE;
744 us->fflags |= US_FL_BAD_SENSE;
745 goto Retry_Sense;
746 }
747
748 /* Other failures */
749 if (temp_result != USB_STOR_TRANSPORT_GOOD) {
750 usb_stor_dbg(us, "-- auto-sense failure\n");
751
752 /* we skip the reset if this happens to be a
753 * multi-target device, since failure of an
754 * auto-sense is perfectly valid
755 */
756 srb->result = DID_ERROR << 16;
757 if (!(us->fflags & US_FL_SCM_MULT_TARG))
758 goto Handle_Errors;
759 return;
760 }
761
762 /* If the sense data returned is larger than 18-bytes then we
763 * assume this device supports requesting more in the future.
764 * The response code must be 70h through 73h inclusive.
765 */
766 if (srb->sense_buffer[7] > (US_SENSE_SIZE - 8) &&
767 !(us->fflags & US_FL_SANE_SENSE) &&
768 !(us->fflags & US_FL_BAD_SENSE) &&
769 (srb->sense_buffer[0] & 0x7C) == 0x70) {
770 usb_stor_dbg(us, "-- SANE_SENSE support enabled\n");
771 us->fflags |= US_FL_SANE_SENSE;
772
773 /* Indicate to the user that we truncated their sense
774 * because we didn't know it supported larger sense.
775 */
776 usb_stor_dbg(us, "-- Sense data truncated to %i from %i\n",
777 US_SENSE_SIZE,
778 srb->sense_buffer[7] + 8);
779 srb->sense_buffer[7] = (US_SENSE_SIZE - 8);
780 }
781
782 scsi_normalize_sense(srb->sense_buffer, SCSI_SENSE_BUFFERSIZE,
783 &sshdr);
784
785 usb_stor_dbg(us, "-- Result from auto-sense is %d\n",
786 temp_result);
787 usb_stor_dbg(us, "-- code: 0x%x, key: 0x%x, ASC: 0x%x, ASCQ: 0x%x\n",
788 sshdr.response_code, sshdr.sense_key,
789 sshdr.asc, sshdr.ascq);
790 #ifdef CONFIG_USB_STORAGE_DEBUG
791 usb_stor_show_sense(us, sshdr.sense_key, sshdr.asc, sshdr.ascq);
792 #endif
793
794 /* set the result so the higher layers expect this data */
795 srb->result = SAM_STAT_CHECK_CONDITION;
796
797 scdd = scsi_sense_desc_find(srb->sense_buffer,
798 SCSI_SENSE_BUFFERSIZE, 4);
799 fm_ili = (scdd ? scdd[3] : srb->sense_buffer[2]) & 0xA0;
800
801 /* We often get empty sense data. This could indicate that
802 * everything worked or that there was an unspecified
803 * problem. We have to decide which.
804 */
805 if (sshdr.sense_key == 0 && sshdr.asc == 0 && sshdr.ascq == 0 &&
806 fm_ili == 0) {
807 /* If things are really okay, then let's show that.
808 * Zero out the sense buffer so the higher layers
809 * won't realize we did an unsolicited auto-sense.
810 */
811 if (result == USB_STOR_TRANSPORT_GOOD) {
812 srb->result = SAM_STAT_GOOD;
813 srb->sense_buffer[0] = 0x0;
814
815 /* If there was a problem, report an unspecified
816 * hardware error to prevent the higher layers from
817 * entering an infinite retry loop.
818 */
819 } else {
820 srb->result = DID_ERROR << 16;
821 if ((sshdr.response_code & 0x72) == 0x72)
822 srb->sense_buffer[1] = HARDWARE_ERROR;
823 else
824 srb->sense_buffer[2] = HARDWARE_ERROR;
825 }
826 }
827 }
828
829 /*
830 * Some devices don't work or return incorrect data the first
831 * time they get a READ(10) command, or for the first READ(10)
832 * after a media change. If the INITIAL_READ10 flag is set,
833 * keep track of whether READ(10) commands succeed. If the
834 * previous one succeeded and this one failed, set the REDO_READ10
835 * flag to force a retry.
836 */
837 if (unlikely((us->fflags & US_FL_INITIAL_READ10) &&
838 srb->cmnd[0] == READ_10)) {
839 if (srb->result == SAM_STAT_GOOD) {
840 set_bit(US_FLIDX_READ10_WORKED, &us->dflags);
841 } else if (test_bit(US_FLIDX_READ10_WORKED, &us->dflags)) {
842 clear_bit(US_FLIDX_READ10_WORKED, &us->dflags);
843 set_bit(US_FLIDX_REDO_READ10, &us->dflags);
844 }
845
846 /*
847 * Next, if the REDO_READ10 flag is set, return a result
848 * code that will cause the SCSI core to retry the READ(10)
849 * command immediately.
850 */
851 if (test_bit(US_FLIDX_REDO_READ10, &us->dflags)) {
852 clear_bit(US_FLIDX_REDO_READ10, &us->dflags);
853 srb->result = DID_IMM_RETRY << 16;
854 srb->sense_buffer[0] = 0;
855 }
856 }
857
858 /* Did we transfer less than the minimum amount required? */
859 if ((srb->result == SAM_STAT_GOOD || srb->sense_buffer[2] == 0) &&
860 scsi_bufflen(srb) - scsi_get_resid(srb) < srb->underflow)
861 srb->result = DID_ERROR << 16;
862
863 last_sector_hacks(us, srb);
864 return;
865
866 /* Error and abort processing: try to resynchronize with the device
867 * by issuing a port reset. If that fails, try a class-specific
868 * device reset. */
869 Handle_Errors:
870
871 /* Set the RESETTING bit, and clear the ABORTING bit so that
872 * the reset may proceed. */
873 scsi_lock(us_to_host(us));
874 set_bit(US_FLIDX_RESETTING, &us->dflags);
875 clear_bit(US_FLIDX_ABORTING, &us->dflags);
876 scsi_unlock(us_to_host(us));
877
878 /* We must release the device lock because the pre_reset routine
879 * will want to acquire it. */
880 mutex_unlock(&us->dev_mutex);
881 result = usb_stor_port_reset(us);
882 mutex_lock(&us->dev_mutex);
883
884 if (result < 0) {
885 scsi_lock(us_to_host(us));
886 usb_stor_report_device_reset(us);
887 scsi_unlock(us_to_host(us));
888 us->transport_reset(us);
889 }
890 clear_bit(US_FLIDX_RESETTING, &us->dflags);
891 last_sector_hacks(us, srb);
892 }
893
894 /* Stop the current URB transfer */
895 void usb_stor_stop_transport(struct us_data *us)
896 {
897 /* If the state machine is blocked waiting for an URB,
898 * let's wake it up. The test_and_clear_bit() call
899 * guarantees that if a URB has just been submitted,
900 * it won't be cancelled more than once. */
901 if (test_and_clear_bit(US_FLIDX_URB_ACTIVE, &us->dflags)) {
902 usb_stor_dbg(us, "-- cancelling URB\n");
903 usb_unlink_urb(us->current_urb);
904 }
905
906 /* If we are waiting for a scatter-gather operation, cancel it. */
907 if (test_and_clear_bit(US_FLIDX_SG_ACTIVE, &us->dflags)) {
908 usb_stor_dbg(us, "-- cancelling sg request\n");
909 usb_sg_cancel(&us->current_sg);
910 }
911 }
912
913 /*
914 * Control/Bulk and Control/Bulk/Interrupt transport
915 */
916
917 int usb_stor_CB_transport(struct scsi_cmnd *srb, struct us_data *us)
918 {
919 unsigned int transfer_length = scsi_bufflen(srb);
920 unsigned int pipe = 0;
921 int result;
922
923 /* COMMAND STAGE */
924 /* let's send the command via the control pipe */
925 result = usb_stor_ctrl_transfer(us, us->send_ctrl_pipe,
926 US_CBI_ADSC,
927 USB_TYPE_CLASS | USB_RECIP_INTERFACE, 0,
928 us->ifnum, srb->cmnd, srb->cmd_len);
929
930 /* check the return code for the command */
931 usb_stor_dbg(us, "Call to usb_stor_ctrl_transfer() returned %d\n",
932 result);
933
934 /* if we stalled the command, it means command failed */
935 if (result == USB_STOR_XFER_STALLED) {
936 return USB_STOR_TRANSPORT_FAILED;
937 }
938
939 /* Uh oh... serious problem here */
940 if (result != USB_STOR_XFER_GOOD) {
941 return USB_STOR_TRANSPORT_ERROR;
942 }
943
944 /* DATA STAGE */
945 /* transfer the data payload for this command, if one exists*/
946 if (transfer_length) {
947 pipe = srb->sc_data_direction == DMA_FROM_DEVICE ?
948 us->recv_bulk_pipe : us->send_bulk_pipe;
949 result = usb_stor_bulk_srb(us, pipe, srb);
950 usb_stor_dbg(us, "CBI data stage result is 0x%x\n", result);
951
952 /* if we stalled the data transfer it means command failed */
953 if (result == USB_STOR_XFER_STALLED)
954 return USB_STOR_TRANSPORT_FAILED;
955 if (result > USB_STOR_XFER_STALLED)
956 return USB_STOR_TRANSPORT_ERROR;
957 }
958
959 /* STATUS STAGE */
960
961 /* NOTE: CB does not have a status stage. Silly, I know. So
962 * we have to catch this at a higher level.
963 */
964 if (us->protocol != USB_PR_CBI)
965 return USB_STOR_TRANSPORT_GOOD;
966
967 result = usb_stor_intr_transfer(us, us->iobuf, 2);
968 usb_stor_dbg(us, "Got interrupt data (0x%x, 0x%x)\n",
969 us->iobuf[0], us->iobuf[1]);
970 if (result != USB_STOR_XFER_GOOD)
971 return USB_STOR_TRANSPORT_ERROR;
972
973 /* UFI gives us ASC and ASCQ, like a request sense
974 *
975 * REQUEST_SENSE and INQUIRY don't affect the sense data on UFI
976 * devices, so we ignore the information for those commands. Note
977 * that this means we could be ignoring a real error on these
978 * commands, but that can't be helped.
979 */
980 if (us->subclass == USB_SC_UFI) {
981 if (srb->cmnd[0] == REQUEST_SENSE ||
982 srb->cmnd[0] == INQUIRY)
983 return USB_STOR_TRANSPORT_GOOD;
984 if (us->iobuf[0])
985 goto Failed;
986 return USB_STOR_TRANSPORT_GOOD;
987 }
988
989 /* If not UFI, we interpret the data as a result code
990 * The first byte should always be a 0x0.
991 *
992 * Some bogus devices don't follow that rule. They stuff the ASC
993 * into the first byte -- so if it's non-zero, call it a failure.
994 */
995 if (us->iobuf[0]) {
996 usb_stor_dbg(us, "CBI IRQ data showed reserved bType 0x%x\n",
997 us->iobuf[0]);
998 goto Failed;
999
1000 }
1001
1002 /* The second byte & 0x0F should be 0x0 for good, otherwise error */
1003 switch (us->iobuf[1] & 0x0F) {
1004 case 0x00:
1005 return USB_STOR_TRANSPORT_GOOD;
1006 case 0x01:
1007 goto Failed;
1008 }
1009 return USB_STOR_TRANSPORT_ERROR;
1010
1011 /* the CBI spec requires that the bulk pipe must be cleared
1012 * following any data-in/out command failure (section 2.4.3.1.3)
1013 */
1014 Failed:
1015 if (pipe)
1016 usb_stor_clear_halt(us, pipe);
1017 return USB_STOR_TRANSPORT_FAILED;
1018 }
1019 EXPORT_SYMBOL_GPL(usb_stor_CB_transport);
1020
1021 /*
1022 * Bulk only transport
1023 */
1024
1025 /* Determine what the maximum LUN supported is */
1026 int usb_stor_Bulk_max_lun(struct us_data *us)
1027 {
1028 int result;
1029
1030 /* issue the command */
1031 us->iobuf[0] = 0;
1032 result = usb_stor_control_msg(us, us->recv_ctrl_pipe,
1033 US_BULK_GET_MAX_LUN,
1034 USB_DIR_IN | USB_TYPE_CLASS |
1035 USB_RECIP_INTERFACE,
1036 0, us->ifnum, us->iobuf, 1, 10*HZ);
1037
1038 usb_stor_dbg(us, "GetMaxLUN command result is %d, data is %d\n",
1039 result, us->iobuf[0]);
1040
1041 /* if we have a successful request, return the result */
1042 if (result > 0)
1043 return us->iobuf[0];
1044
1045 /*
1046 * Some devices don't like GetMaxLUN. They may STALL the control
1047 * pipe, they may return a zero-length result, they may do nothing at
1048 * all and timeout, or they may fail in even more bizarrely creative
1049 * ways. In these cases the best approach is to use the default
1050 * value: only one LUN.
1051 */
1052 return 0;
1053 }
1054
1055 int usb_stor_Bulk_transport(struct scsi_cmnd *srb, struct us_data *us)
1056 {
1057 struct bulk_cb_wrap *bcb = (struct bulk_cb_wrap *) us->iobuf;
1058 struct bulk_cs_wrap *bcs = (struct bulk_cs_wrap *) us->iobuf;
1059 unsigned int transfer_length = scsi_bufflen(srb);
1060 unsigned int residue;
1061 int result;
1062 int fake_sense = 0;
1063 unsigned int cswlen;
1064 unsigned int cbwlen = US_BULK_CB_WRAP_LEN;
1065
1066 /* Take care of BULK32 devices; set extra byte to 0 */
1067 if (unlikely(us->fflags & US_FL_BULK32)) {
1068 cbwlen = 32;
1069 us->iobuf[31] = 0;
1070 }
1071
1072 /* set up the command wrapper */
1073 bcb->Signature = cpu_to_le32(US_BULK_CB_SIGN);
1074 bcb->DataTransferLength = cpu_to_le32(transfer_length);
1075 bcb->Flags = srb->sc_data_direction == DMA_FROM_DEVICE ?
1076 US_BULK_FLAG_IN : 0;
1077 bcb->Tag = ++us->tag;
1078 bcb->Lun = srb->device->lun;
1079 if (us->fflags & US_FL_SCM_MULT_TARG)
1080 bcb->Lun |= srb->device->id << 4;
1081 bcb->Length = srb->cmd_len;
1082
1083 /* copy the command payload */
1084 memset(bcb->CDB, 0, sizeof(bcb->CDB));
1085 memcpy(bcb->CDB, srb->cmnd, bcb->Length);
1086
1087 /* send it to out endpoint */
1088 usb_stor_dbg(us, "Bulk Command S 0x%x T 0x%x L %d F %d Trg %d LUN %d CL %d\n",
1089 le32_to_cpu(bcb->Signature), bcb->Tag,
1090 le32_to_cpu(bcb->DataTransferLength), bcb->Flags,
1091 (bcb->Lun >> 4), (bcb->Lun & 0x0F),
1092 bcb->Length);
1093 result = usb_stor_bulk_transfer_buf(us, us->send_bulk_pipe,
1094 bcb, cbwlen, NULL);
1095 usb_stor_dbg(us, "Bulk command transfer result=%d\n", result);
1096 if (result != USB_STOR_XFER_GOOD)
1097 return USB_STOR_TRANSPORT_ERROR;
1098
1099 /* DATA STAGE */
1100 /* send/receive data payload, if there is any */
1101
1102 /* Some USB-IDE converter chips need a 100us delay between the
1103 * command phase and the data phase. Some devices need a little
1104 * more than that, probably because of clock rate inaccuracies. */
1105 if (unlikely(us->fflags & US_FL_GO_SLOW))
1106 udelay(125);
1107
1108 if (transfer_length) {
1109 unsigned int pipe = srb->sc_data_direction == DMA_FROM_DEVICE ?
1110 us->recv_bulk_pipe : us->send_bulk_pipe;
1111 result = usb_stor_bulk_srb(us, pipe, srb);
1112 usb_stor_dbg(us, "Bulk data transfer result 0x%x\n", result);
1113 if (result == USB_STOR_XFER_ERROR)
1114 return USB_STOR_TRANSPORT_ERROR;
1115
1116 /* If the device tried to send back more data than the
1117 * amount requested, the spec requires us to transfer
1118 * the CSW anyway. Since there's no point retrying the
1119 * the command, we'll return fake sense data indicating
1120 * Illegal Request, Invalid Field in CDB.
1121 */
1122 if (result == USB_STOR_XFER_LONG)
1123 fake_sense = 1;
1124 }
1125
1126 /* See flow chart on pg 15 of the Bulk Only Transport spec for
1127 * an explanation of how this code works.
1128 */
1129
1130 /* get CSW for device status */
1131 usb_stor_dbg(us, "Attempting to get CSW...\n");
1132 result = usb_stor_bulk_transfer_buf(us, us->recv_bulk_pipe,
1133 bcs, US_BULK_CS_WRAP_LEN, &cswlen);
1134
1135 /* Some broken devices add unnecessary zero-length packets to the
1136 * end of their data transfers. Such packets show up as 0-length
1137 * CSWs. If we encounter such a thing, try to read the CSW again.
1138 */
1139 if (result == USB_STOR_XFER_SHORT && cswlen == 0) {
1140 usb_stor_dbg(us, "Received 0-length CSW; retrying...\n");
1141 result = usb_stor_bulk_transfer_buf(us, us->recv_bulk_pipe,
1142 bcs, US_BULK_CS_WRAP_LEN, &cswlen);
1143 }
1144
1145 /* did the attempt to read the CSW fail? */
1146 if (result == USB_STOR_XFER_STALLED) {
1147
1148 /* get the status again */
1149 usb_stor_dbg(us, "Attempting to get CSW (2nd try)...\n");
1150 result = usb_stor_bulk_transfer_buf(us, us->recv_bulk_pipe,
1151 bcs, US_BULK_CS_WRAP_LEN, NULL);
1152 }
1153
1154 /* if we still have a failure at this point, we're in trouble */
1155 usb_stor_dbg(us, "Bulk status result = %d\n", result);
1156 if (result != USB_STOR_XFER_GOOD)
1157 return USB_STOR_TRANSPORT_ERROR;
1158
1159 /* check bulk status */
1160 residue = le32_to_cpu(bcs->Residue);
1161 usb_stor_dbg(us, "Bulk Status S 0x%x T 0x%x R %u Stat 0x%x\n",
1162 le32_to_cpu(bcs->Signature), bcs->Tag,
1163 residue, bcs->Status);
1164 if (!(bcs->Tag == us->tag || (us->fflags & US_FL_BULK_IGNORE_TAG)) ||
1165 bcs->Status > US_BULK_STAT_PHASE) {
1166 usb_stor_dbg(us, "Bulk logical error\n");
1167 return USB_STOR_TRANSPORT_ERROR;
1168 }
1169
1170 /* Some broken devices report odd signatures, so we do not check them
1171 * for validity against the spec. We store the first one we see,
1172 * and check subsequent transfers for validity against this signature.
1173 */
1174 if (!us->bcs_signature) {
1175 us->bcs_signature = bcs->Signature;
1176 if (us->bcs_signature != cpu_to_le32(US_BULK_CS_SIGN))
1177 usb_stor_dbg(us, "Learnt BCS signature 0x%08X\n",
1178 le32_to_cpu(us->bcs_signature));
1179 } else if (bcs->Signature != us->bcs_signature) {
1180 usb_stor_dbg(us, "Signature mismatch: got %08X, expecting %08X\n",
1181 le32_to_cpu(bcs->Signature),
1182 le32_to_cpu(us->bcs_signature));
1183 return USB_STOR_TRANSPORT_ERROR;
1184 }
1185
1186 /* try to compute the actual residue, based on how much data
1187 * was really transferred and what the device tells us */
1188 if (residue && !(us->fflags & US_FL_IGNORE_RESIDUE)) {
1189
1190 /* Heuristically detect devices that generate bogus residues
1191 * by seeing what happens with INQUIRY and READ CAPACITY
1192 * commands.
1193 */
1194 if (bcs->Status == US_BULK_STAT_OK &&
1195 scsi_get_resid(srb) == 0 &&
1196 ((srb->cmnd[0] == INQUIRY &&
1197 transfer_length == 36) ||
1198 (srb->cmnd[0] == READ_CAPACITY &&
1199 transfer_length == 8))) {
1200 us->fflags |= US_FL_IGNORE_RESIDUE;
1201
1202 } else {
1203 residue = min(residue, transfer_length);
1204 scsi_set_resid(srb, max(scsi_get_resid(srb),
1205 (int) residue));
1206 }
1207 }
1208
1209 /* based on the status code, we report good or bad */
1210 switch (bcs->Status) {
1211 case US_BULK_STAT_OK:
1212 /* device babbled -- return fake sense data */
1213 if (fake_sense) {
1214 memcpy(srb->sense_buffer,
1215 usb_stor_sense_invalidCDB,
1216 sizeof(usb_stor_sense_invalidCDB));
1217 return USB_STOR_TRANSPORT_NO_SENSE;
1218 }
1219
1220 /* command good -- note that data could be short */
1221 return USB_STOR_TRANSPORT_GOOD;
1222
1223 case US_BULK_STAT_FAIL:
1224 /* command failed */
1225 return USB_STOR_TRANSPORT_FAILED;
1226
1227 case US_BULK_STAT_PHASE:
1228 /* phase error -- note that a transport reset will be
1229 * invoked by the invoke_transport() function
1230 */
1231 return USB_STOR_TRANSPORT_ERROR;
1232 }
1233
1234 /* we should never get here, but if we do, we're in trouble */
1235 return USB_STOR_TRANSPORT_ERROR;
1236 }
1237 EXPORT_SYMBOL_GPL(usb_stor_Bulk_transport);
1238
1239 /***********************************************************************
1240 * Reset routines
1241 ***********************************************************************/
1242
1243 /* This is the common part of the device reset code.
1244 *
1245 * It's handy that every transport mechanism uses the control endpoint for
1246 * resets.
1247 *
1248 * Basically, we send a reset with a 5-second timeout, so we don't get
1249 * jammed attempting to do the reset.
1250 */
1251 static int usb_stor_reset_common(struct us_data *us,
1252 u8 request, u8 requesttype,
1253 u16 value, u16 index, void *data, u16 size)
1254 {
1255 int result;
1256 int result2;
1257
1258 if (test_bit(US_FLIDX_DISCONNECTING, &us->dflags)) {
1259 usb_stor_dbg(us, "No reset during disconnect\n");
1260 return -EIO;
1261 }
1262
1263 result = usb_stor_control_msg(us, us->send_ctrl_pipe,
1264 request, requesttype, value, index, data, size,
1265 5*HZ);
1266 if (result < 0) {
1267 usb_stor_dbg(us, "Soft reset failed: %d\n", result);
1268 return result;
1269 }
1270
1271 /* Give the device some time to recover from the reset,
1272 * but don't delay disconnect processing. */
1273 wait_event_interruptible_timeout(us->delay_wait,
1274 test_bit(US_FLIDX_DISCONNECTING, &us->dflags),
1275 HZ*6);
1276 if (test_bit(US_FLIDX_DISCONNECTING, &us->dflags)) {
1277 usb_stor_dbg(us, "Reset interrupted by disconnect\n");
1278 return -EIO;
1279 }
1280
1281 usb_stor_dbg(us, "Soft reset: clearing bulk-in endpoint halt\n");
1282 result = usb_stor_clear_halt(us, us->recv_bulk_pipe);
1283
1284 usb_stor_dbg(us, "Soft reset: clearing bulk-out endpoint halt\n");
1285 result2 = usb_stor_clear_halt(us, us->send_bulk_pipe);
1286
1287 /* return a result code based on the result of the clear-halts */
1288 if (result >= 0)
1289 result = result2;
1290 if (result < 0)
1291 usb_stor_dbg(us, "Soft reset failed\n");
1292 else
1293 usb_stor_dbg(us, "Soft reset done\n");
1294 return result;
1295 }
1296
1297 /* This issues a CB[I] Reset to the device in question
1298 */
1299 #define CB_RESET_CMD_SIZE 12
1300
1301 int usb_stor_CB_reset(struct us_data *us)
1302 {
1303 memset(us->iobuf, 0xFF, CB_RESET_CMD_SIZE);
1304 us->iobuf[0] = SEND_DIAGNOSTIC;
1305 us->iobuf[1] = 4;
1306 return usb_stor_reset_common(us, US_CBI_ADSC,
1307 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
1308 0, us->ifnum, us->iobuf, CB_RESET_CMD_SIZE);
1309 }
1310 EXPORT_SYMBOL_GPL(usb_stor_CB_reset);
1311
1312 /* This issues a Bulk-only Reset to the device in question, including
1313 * clearing the subsequent endpoint halts that may occur.
1314 */
1315 int usb_stor_Bulk_reset(struct us_data *us)
1316 {
1317 return usb_stor_reset_common(us, US_BULK_RESET_REQUEST,
1318 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
1319 0, us->ifnum, NULL, 0);
1320 }
1321 EXPORT_SYMBOL_GPL(usb_stor_Bulk_reset);
1322
1323 /* Issue a USB port reset to the device. The caller must not hold
1324 * us->dev_mutex.
1325 */
1326 int usb_stor_port_reset(struct us_data *us)
1327 {
1328 int result;
1329
1330 /*for these devices we must use the class specific method */
1331 if (us->pusb_dev->quirks & USB_QUIRK_RESET)
1332 return -EPERM;
1333
1334 result = usb_lock_device_for_reset(us->pusb_dev, us->pusb_intf);
1335 if (result < 0)
1336 usb_stor_dbg(us, "unable to lock device for reset: %d\n",
1337 result);
1338 else {
1339 /* Were we disconnected while waiting for the lock? */
1340 if (test_bit(US_FLIDX_DISCONNECTING, &us->dflags)) {
1341 result = -EIO;
1342 usb_stor_dbg(us, "No reset during disconnect\n");
1343 } else {
1344 result = usb_reset_device(us->pusb_dev);
1345 usb_stor_dbg(us, "usb_reset_device returns %d\n",
1346 result);
1347 }
1348 usb_unlock_device(us->pusb_dev);
1349 }
1350 return result;
1351 }