ARC: [plat-eznps] spinlock aware for MTM
[linux/fpc-iii.git] / drivers / usb / storage / transport.c
blob1a59f335b063e7e79f8ece2173f2f03574ce3a5b
1 /*
2 * Driver for USB Mass Storage compliant devices
4 * Current development and maintenance by:
5 * (c) 1999-2002 Matthew Dharm (mdharm-usb@one-eyed-alien.net)
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>
12 * Initial work by:
13 * (c) 1999 Michael Gee (michael@linuxspecific.com)
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.
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.
26 * Also, for certain devices, the interrupt endpoint is used to convey
27 * status of a command.
29 * Please see http://www.one-eyed-alien.net/~mdharm/linux-usb for more
30 * information about this driver.
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.
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.
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.
47 #include <linux/sched.h>
48 #include <linux/gfp.h>
49 #include <linux/errno.h>
50 #include <linux/export.h>
52 #include <linux/usb/quirks.h>
54 #include <scsi/scsi.h>
55 #include <scsi/scsi_eh.h>
56 #include <scsi/scsi_device.h>
58 #include "usb.h"
59 #include "transport.h"
60 #include "protocol.h"
61 #include "scsiglue.h"
62 #include "debug.h"
64 #include <linux/blkdev.h>
65 #include "../../scsi/sd.h"
68 /***********************************************************************
69 * Data transfer routines
70 ***********************************************************************/
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.)
82 * The abort function (usb_storage_command_abort() in scsiglue.c) first
83 * sets the machine state and the ABORTING bit in us->dflags to prevent
84 * new URBs from being submitted. It then calls usb_stor_stop_transport()
85 * below, which atomically tests-and-clears the URB_ACTIVE bit in us->dflags
86 * 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.
90 * When a disconnect occurs, the DISCONNECTING bit in us->dflags is set to
91 * prevent new URBs from being submitted, and usb_stor_stop_transport() is
92 * called to stop any ongoing requests.
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
103 * finish. Note that the URB can still be in progress even after a call to
104 * usb_unlink_urb() returns.
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().
114 * This is the completion handler which will wake us up when an URB
115 * completes.
117 static void usb_stor_blocking_completion(struct urb *urb)
119 struct completion *urb_done_ptr = urb->context;
121 complete(urb_done_ptr);
125 * This is the common part of the URB message submission code
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.
131 static int usb_stor_msg_common(struct us_data *us, int timeout)
133 struct completion urb_done;
134 long timeleft;
135 int status;
137 /* don't submit URBs during abort processing */
138 if (test_bit(US_FLIDX_ABORTING, &us->dflags))
139 return -EIO;
141 /* set up data structures for the wakeup system */
142 init_completion(&urb_done);
144 /* fill the common fields in the URB */
145 us->current_urb->context = &urb_done;
146 us->current_urb->transfer_flags = 0;
149 * we assume that if transfer_buffer isn't us->iobuf then it
150 * hasn't been mapped for DMA. Yes, this is clunky, but it's
151 * easier than always having the caller tell us whether the
152 * transfer buffer has already been mapped.
154 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;
158 /* submit the URB */
159 status = usb_submit_urb(us->current_urb, GFP_NOIO);
160 if (status) {
161 /* something went wrong */
162 return status;
166 * since the URB has been submitted successfully, it's now okay
167 * to cancel it
169 set_bit(US_FLIDX_URB_ACTIVE, &us->dflags);
171 /* did an abort occur during the submission? */
172 if (test_bit(US_FLIDX_ABORTING, &us->dflags)) {
174 /* cancel the URB, if it hasn't been cancelled already */
175 if (test_and_clear_bit(US_FLIDX_URB_ACTIVE, &us->dflags)) {
176 usb_stor_dbg(us, "-- cancelling URB\n");
177 usb_unlink_urb(us->current_urb);
181 /* wait for the completion of the URB */
182 timeleft = wait_for_completion_interruptible_timeout(
183 &urb_done, timeout ? : MAX_SCHEDULE_TIMEOUT);
185 clear_bit(US_FLIDX_URB_ACTIVE, &us->dflags);
187 if (timeleft <= 0) {
188 usb_stor_dbg(us, "%s -- cancelling URB\n",
189 timeleft == 0 ? "Timeout" : "Signal");
190 usb_kill_urb(us->current_urb);
193 /* return the URB status */
194 return us->current_urb->status;
198 * Transfer one control message, with timeouts, and allowing early
199 * termination. Return codes are usual -Exxx, *not* USB_STOR_XFER_xxx.
201 int 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)
205 int status;
207 usb_stor_dbg(us, "rq=%02x rqtype=%02x value=%04x index=%02x len=%u\n",
208 request, requesttype, value, index, size);
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);
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);
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;
228 EXPORT_SYMBOL_GPL(usb_stor_control_msg);
231 * This is a version of usb_clear_halt() that allows early termination and
232 * 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.
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.
240 * Since many vendors in this space limit their testing to interoperability
241 * with these two OSes, specification violations like this one are common.
243 int usb_stor_clear_halt(struct us_data *us, unsigned int pipe)
245 int result;
246 int endp = usb_pipeendpoint(pipe);
248 if (usb_pipein (pipe))
249 endp |= USB_DIR_IN;
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);
256 if (result >= 0)
257 usb_reset_endpoint(us->pusb_dev, endp);
259 usb_stor_dbg(us, "result = %d\n", result);
260 return result;
262 EXPORT_SYMBOL_GPL(usb_stor_clear_halt);
266 * Interpret the results of a URB transfer
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.
272 static int interpret_urb_result(struct us_data *us, unsigned int pipe,
273 unsigned int length, int result, unsigned int partial)
275 usb_stor_dbg(us, "Status code %d; transferred %u/%u\n",
276 result, partial, length);
277 switch (result) {
279 /* no error code; did we send all the data? */
280 case 0:
281 if (partial != length) {
282 usb_stor_dbg(us, "-- short transfer\n");
283 return USB_STOR_XFER_SHORT;
286 usb_stor_dbg(us, "-- transfer complete\n");
287 return USB_STOR_XFER_GOOD;
289 /* stalled */
290 case -EPIPE:
292 * for control endpoints, (used by CB[I]) a stall indicates
293 * a failed command
295 if (usb_pipecontrol(pipe)) {
296 usb_stor_dbg(us, "-- stall on control pipe\n");
297 return USB_STOR_XFER_STALLED;
300 /* for other sorts of endpoint, clear the stall */
301 usb_stor_dbg(us, "clearing endpoint halt for pipe 0x%x\n",
302 pipe);
303 if (usb_stor_clear_halt(us, pipe) < 0)
304 return USB_STOR_XFER_ERROR;
305 return USB_STOR_XFER_STALLED;
307 /* babble - the device tried to send more than we wanted to read */
308 case -EOVERFLOW:
309 usb_stor_dbg(us, "-- babble\n");
310 return USB_STOR_XFER_LONG;
312 /* the transfer was cancelled by abort, disconnect, or timeout */
313 case -ECONNRESET:
314 usb_stor_dbg(us, "-- transfer cancelled\n");
315 return USB_STOR_XFER_ERROR;
317 /* short scatter-gather read transfer */
318 case -EREMOTEIO:
319 usb_stor_dbg(us, "-- short read transfer\n");
320 return USB_STOR_XFER_SHORT;
322 /* abort or disconnect in progress */
323 case -EIO:
324 usb_stor_dbg(us, "-- abort or disconnect in progress\n");
325 return USB_STOR_XFER_ERROR;
327 /* the catch-all error case */
328 default:
329 usb_stor_dbg(us, "-- unknown error\n");
330 return USB_STOR_XFER_ERROR;
335 * Transfer one control message, without timeouts, but allowing early
336 * termination. Return codes are USB_STOR_XFER_xxx.
338 int 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)
342 int result;
344 usb_stor_dbg(us, "rq=%02x rqtype=%02x value=%04x index=%02x len=%u\n",
345 request, requesttype, value, index, size);
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);
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);
360 return interpret_urb_result(us, pipe, size, result,
361 us->current_urb->actual_length);
363 EXPORT_SYMBOL_GPL(usb_stor_ctrl_transfer);
366 * Receive one interrupt buffer, without timeouts, but allowing early
367 * termination. Return codes are USB_STOR_XFER_xxx.
369 * This routine always uses us->recv_intr_pipe as the pipe and
370 * us->ep_bInterval as the interrupt interval.
372 static int usb_stor_intr_transfer(struct us_data *us, void *buf,
373 unsigned int length)
375 int result;
376 unsigned int pipe = us->recv_intr_pipe;
377 unsigned int maxp;
379 usb_stor_dbg(us, "xfer %u bytes\n", length);
381 /* calculate the max packet size */
382 maxp = usb_maxpacket(us->pusb_dev, pipe, usb_pipeout(pipe));
383 if (maxp > length)
384 maxp = length;
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);
392 return interpret_urb_result(us, pipe, length, result,
393 us->current_urb->actual_length);
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.
401 int usb_stor_bulk_transfer_buf(struct us_data *us, unsigned int pipe,
402 void *buf, unsigned int length, unsigned int *act_len)
404 int result;
406 usb_stor_dbg(us, "xfer %u bytes\n", length);
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);
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);
419 EXPORT_SYMBOL_GPL(usb_stor_bulk_transfer_buf);
422 * Transfer a scatter-gather list via bulk transfer
424 * This function does basically the same thing as usb_stor_bulk_transfer_buf()
425 * above, but it uses the usbcore scatter-gather library.
427 static 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)
431 int result;
433 /* don't submit s-g requests during abort processing */
434 if (test_bit(US_FLIDX_ABORTING, &us->dflags))
435 return USB_STOR_XFER_ERROR;
437 /* initialize the scatter-gather request block */
438 usb_stor_dbg(us, "xfer %u bytes, %d entries\n", length, num_sg);
439 result = usb_sg_init(&us->current_sg, us->pusb_dev, pipe, 0,
440 sg, num_sg, length, GFP_NOIO);
441 if (result) {
442 usb_stor_dbg(us, "usb_sg_init returned %d\n", result);
443 return USB_STOR_XFER_ERROR;
447 * since the block has been initialized successfully, it's now
448 * okay to cancel it
450 set_bit(US_FLIDX_SG_ACTIVE, &us->dflags);
452 /* did an abort occur during the submission? */
453 if (test_bit(US_FLIDX_ABORTING, &us->dflags)) {
455 /* cancel the request, if it hasn't been cancelled already */
456 if (test_and_clear_bit(US_FLIDX_SG_ACTIVE, &us->dflags)) {
457 usb_stor_dbg(us, "-- cancelling sg request\n");
458 usb_sg_cancel(&us->current_sg);
462 /* wait for the completion of the transfer */
463 usb_sg_wait(&us->current_sg);
464 clear_bit(US_FLIDX_SG_ACTIVE, &us->dflags);
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);
474 * Common used function. Transfer a complete command
475 * via usb_stor_bulk_transfer_sglist() above. Set cmnd resid
477 int usb_stor_bulk_srb(struct us_data* us, unsigned int pipe,
478 struct scsi_cmnd* srb)
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);
485 scsi_set_resid(srb, scsi_bufflen(srb) - partial);
486 return result;
488 EXPORT_SYMBOL_GPL(usb_stor_bulk_srb);
491 * Transfer an entire SCSI command's worth of data payload over the bulk
492 * pipe.
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.
499 int usb_stor_bulk_transfer_sg(struct us_data* us, unsigned int pipe,
500 void *buf, unsigned int length_left, int use_sg, int *residual)
502 int result;
503 unsigned int partial;
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;
519 /* store the residual and return the error code */
520 if (residual)
521 *residual = length_left;
522 return result;
524 EXPORT_SYMBOL_GPL(usb_stor_bulk_transfer_sg);
526 /***********************************************************************
527 * Transport routines
528 ***********************************************************************/
531 * There are so many devices that report the capacity incorrectly,
532 * this routine was written to counteract some of the resulting
533 * problems.
535 static void last_sector_hacks(struct us_data *us, struct scsi_cmnd *srb)
537 struct gendisk *disk;
538 struct scsi_disk *sdkp;
539 u32 sector;
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 */
550 * If last-sector problems can't occur, whether because the
551 * 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.
555 if (!us->use_last_sector_hacks)
556 return;
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;
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;
574 if (srb->result == SAM_STAT_GOOD && scsi_get_resid(srb) == 0) {
577 * The command succeeded. We know this device doesn't
578 * have the last-sector bug, so stop checking it.
580 us->use_last_sector_hacks = 0;
582 } else {
584 * The command failed. Allow up to 3 retries in case this
585 * 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.
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));
599 done:
601 * Don't reset the retry counter for TEST UNIT READY commands,
602 * because they get issued after device resets which might be
603 * caused by a failed last-sector access.
605 if (srb->cmnd[0] != TEST_UNIT_READY)
606 us->last_sector_retries = 0;
610 * Invoke the transport and basic error-handling/recovery methods
612 * This is used by the protocol layers to actually send the message to
613 * the device and receive the response.
615 void usb_stor_invoke_transport(struct scsi_cmnd *srb, struct us_data *us)
617 int need_auto_sense;
618 int result;
620 /* send the command to the transport layer */
621 scsi_set_resid(srb, 0);
622 result = us->transport(srb, us);
625 * if the command gets aborted by the higher layers, we need to
626 * short-circuit all other processing
628 if (test_bit(US_FLIDX_TIMED_OUT, &us->dflags)) {
629 usb_stor_dbg(us, "-- command was aborted\n");
630 srb->result = DID_ABORT << 16;
631 goto Handle_Errors;
634 /* if there is a transport error, reset and don't auto-sense */
635 if (result == USB_STOR_TRANSPORT_ERROR) {
636 usb_stor_dbg(us, "-- transport indicates error, resetting\n");
637 srb->result = DID_ERROR << 16;
638 goto Handle_Errors;
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;
644 last_sector_hacks(us, srb);
645 return;
648 srb->result = SAM_STAT_GOOD;
651 * Determine if we need to auto-sense
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.
656 need_auto_sense = 0;
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.
664 if ((us->protocol == USB_PR_CB || us->protocol == USB_PR_DPCM_USB) &&
665 srb->sc_data_direction != DMA_FROM_DEVICE) {
666 usb_stor_dbg(us, "-- CB transport device requiring auto-sense\n");
667 need_auto_sense = 1;
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.
675 if (result == USB_STOR_TRANSPORT_FAILED) {
676 usb_stor_dbg(us, "-- transport indicates command failure\n");
677 need_auto_sense = 1;
681 * 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
686 if (unlikely((srb->cmnd[0] == ATA_16 || srb->cmnd[0] == ATA_12) &&
687 result == USB_STOR_TRANSPORT_GOOD &&
688 !(us->fflags & US_FL_SANE_SENSE) &&
689 !(us->fflags & US_FL_BAD_SENSE) &&
690 !(srb->cmnd[2] & 0x20))) {
691 usb_stor_dbg(us, "-- SAT supported, increasing auto-sense\n");
692 us->fflags |= US_FL_SANE_SENSE;
696 * 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.
699 if ((scsi_get_resid(srb) > 0) &&
700 !((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))) {
705 usb_stor_dbg(us, "-- unexpectedly short transfer\n");
708 /* Now, if we need to do the auto-sense, let's do it */
709 if (need_auto_sense) {
710 int temp_result;
711 struct scsi_eh_save ses;
712 int sense_size = US_SENSE_SIZE;
713 struct scsi_sense_hdr sshdr;
714 const u8 *scdd;
715 u8 fm_ili;
717 /* device supports and needs bigger sense buffer */
718 if (us->fflags & US_FL_SANE_SENSE)
719 sense_size = ~0;
720 Retry_Sense:
721 usb_stor_dbg(us, "Issuing auto-REQUEST_SENSE\n");
723 scsi_eh_prep_cmnd(srb, &ses, NULL, 0, sense_size);
725 /* FIXME: we must do the protocol translation here */
726 if (us->subclass == USB_SC_RBC || us->subclass == USB_SC_SCSI ||
727 us->subclass == USB_SC_CYP_ATACB)
728 srb->cmd_len = 6;
729 else
730 srb->cmd_len = 12;
732 /* issue the auto-sense command */
733 scsi_set_resid(srb, 0);
734 temp_result = us->transport(us->srb, us);
736 /* let's clean up right away */
737 scsi_eh_restore_cmnd(srb, &ses);
739 if (test_bit(US_FLIDX_TIMED_OUT, &us->dflags)) {
740 usb_stor_dbg(us, "-- auto-sense aborted\n");
741 srb->result = DID_ABORT << 16;
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;
748 goto Handle_Errors;
752 * Some devices claim to support larger sense but fail when
753 * 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
757 if (temp_result == USB_STOR_TRANSPORT_FAILED &&
758 sense_size != US_SENSE_SIZE) {
759 usb_stor_dbg(us, "-- auto-sense failure, retry small sense\n");
760 sense_size = US_SENSE_SIZE;
761 us->fflags &= ~US_FL_SANE_SENSE;
762 us->fflags |= US_FL_BAD_SENSE;
763 goto Retry_Sense;
766 /* Other failures */
767 if (temp_result != USB_STOR_TRANSPORT_GOOD) {
768 usb_stor_dbg(us, "-- auto-sense failure\n");
771 * we skip the reset if this happens to be a
772 * multi-target device, since failure of an
773 * auto-sense is perfectly valid
775 srb->result = DID_ERROR << 16;
776 if (!(us->fflags & US_FL_SCM_MULT_TARG))
777 goto Handle_Errors;
778 return;
782 * If the sense data returned is larger than 18-bytes then we
783 * assume this device supports requesting more in the future.
784 * The response code must be 70h through 73h inclusive.
786 if (srb->sense_buffer[7] > (US_SENSE_SIZE - 8) &&
787 !(us->fflags & US_FL_SANE_SENSE) &&
788 !(us->fflags & US_FL_BAD_SENSE) &&
789 (srb->sense_buffer[0] & 0x7C) == 0x70) {
790 usb_stor_dbg(us, "-- SANE_SENSE support enabled\n");
791 us->fflags |= US_FL_SANE_SENSE;
794 * Indicate to the user that we truncated their sense
795 * because we didn't know it supported larger sense.
797 usb_stor_dbg(us, "-- Sense data truncated to %i from %i\n",
798 US_SENSE_SIZE,
799 srb->sense_buffer[7] + 8);
800 srb->sense_buffer[7] = (US_SENSE_SIZE - 8);
803 scsi_normalize_sense(srb->sense_buffer, SCSI_SENSE_BUFFERSIZE,
804 &sshdr);
806 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);
811 #ifdef CONFIG_USB_STORAGE_DEBUG
812 usb_stor_show_sense(us, sshdr.sense_key, sshdr.asc, sshdr.ascq);
813 #endif
815 /* set the result so the higher layers expect this data */
816 srb->result = SAM_STAT_CHECK_CONDITION;
818 scdd = scsi_sense_desc_find(srb->sense_buffer,
819 SCSI_SENSE_BUFFERSIZE, 4);
820 fm_ili = (scdd ? scdd[3] : srb->sense_buffer[2]) & 0xA0;
823 * We often get empty sense data. This could indicate that
824 * everything worked or that there was an unspecified
825 * problem. We have to decide which.
827 if (sshdr.sense_key == 0 && sshdr.asc == 0 && sshdr.ascq == 0 &&
828 fm_ili == 0) {
830 * If things are really okay, then let's show that.
831 * Zero out the sense buffer so the higher layers
832 * won't realize we did an unsolicited auto-sense.
834 if (result == USB_STOR_TRANSPORT_GOOD) {
835 srb->result = SAM_STAT_GOOD;
836 srb->sense_buffer[0] = 0x0;
839 * If there was a problem, report an unspecified
840 * hardware error to prevent the higher layers from
841 * entering an infinite retry loop.
843 } else {
844 srb->result = DID_ERROR << 16;
845 if ((sshdr.response_code & 0x72) == 0x72)
846 srb->sense_buffer[1] = HARDWARE_ERROR;
847 else
848 srb->sense_buffer[2] = HARDWARE_ERROR;
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.
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);
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.
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;
882 /* Did we transfer less than the minimum amount required? */
883 if ((srb->result == SAM_STAT_GOOD || srb->sense_buffer[2] == 0) &&
884 scsi_bufflen(srb) - scsi_get_resid(srb) < srb->underflow)
885 srb->result = DID_ERROR << 16;
887 last_sector_hacks(us, srb);
888 return;
891 * Error and abort processing: try to resynchronize with the device
892 * by issuing a port reset. If that fails, try a class-specific
893 * device reset.
895 Handle_Errors:
898 * Set the RESETTING bit, and clear the ABORTING bit so that
899 * the reset may proceed.
901 scsi_lock(us_to_host(us));
902 set_bit(US_FLIDX_RESETTING, &us->dflags);
903 clear_bit(US_FLIDX_ABORTING, &us->dflags);
904 scsi_unlock(us_to_host(us));
907 * We must release the device lock because the pre_reset routine
908 * will want to acquire it.
910 mutex_unlock(&us->dev_mutex);
911 result = usb_stor_port_reset(us);
912 mutex_lock(&us->dev_mutex);
914 if (result < 0) {
915 scsi_lock(us_to_host(us));
916 usb_stor_report_device_reset(us);
917 scsi_unlock(us_to_host(us));
918 us->transport_reset(us);
920 clear_bit(US_FLIDX_RESETTING, &us->dflags);
921 last_sector_hacks(us, srb);
924 /* Stop the current URB transfer */
925 void usb_stor_stop_transport(struct us_data *us)
928 * If the state machine is blocked waiting for an URB,
929 * let's wake it up. The test_and_clear_bit() call
930 * guarantees that if a URB has just been submitted,
931 * it won't be cancelled more than once.
933 if (test_and_clear_bit(US_FLIDX_URB_ACTIVE, &us->dflags)) {
934 usb_stor_dbg(us, "-- cancelling URB\n");
935 usb_unlink_urb(us->current_urb);
938 /* If we are waiting for a scatter-gather operation, cancel it. */
939 if (test_and_clear_bit(US_FLIDX_SG_ACTIVE, &us->dflags)) {
940 usb_stor_dbg(us, "-- cancelling sg request\n");
941 usb_sg_cancel(&us->current_sg);
946 * Control/Bulk and Control/Bulk/Interrupt transport
949 int usb_stor_CB_transport(struct scsi_cmnd *srb, struct us_data *us)
951 unsigned int transfer_length = scsi_bufflen(srb);
952 unsigned int pipe = 0;
953 int result;
955 /* COMMAND STAGE */
956 /* let's send the command via the control pipe */
958 * Command is sometime (f.e. after scsi_eh_prep_cmnd) on the stack.
959 * Stack may be vmallocated. So no DMA for us. Make a copy.
961 memcpy(us->iobuf, srb->cmnd, srb->cmd_len);
962 result = usb_stor_ctrl_transfer(us, us->send_ctrl_pipe,
963 US_CBI_ADSC,
964 USB_TYPE_CLASS | USB_RECIP_INTERFACE, 0,
965 us->ifnum, us->iobuf, srb->cmd_len);
967 /* check the return code for the command */
968 usb_stor_dbg(us, "Call to usb_stor_ctrl_transfer() returned %d\n",
969 result);
971 /* if we stalled the command, it means command failed */
972 if (result == USB_STOR_XFER_STALLED) {
973 return USB_STOR_TRANSPORT_FAILED;
976 /* Uh oh... serious problem here */
977 if (result != USB_STOR_XFER_GOOD) {
978 return USB_STOR_TRANSPORT_ERROR;
981 /* DATA STAGE */
982 /* transfer the data payload for this command, if one exists*/
983 if (transfer_length) {
984 pipe = srb->sc_data_direction == DMA_FROM_DEVICE ?
985 us->recv_bulk_pipe : us->send_bulk_pipe;
986 result = usb_stor_bulk_srb(us, pipe, srb);
987 usb_stor_dbg(us, "CBI data stage result is 0x%x\n", result);
989 /* if we stalled the data transfer it means command failed */
990 if (result == USB_STOR_XFER_STALLED)
991 return USB_STOR_TRANSPORT_FAILED;
992 if (result > USB_STOR_XFER_STALLED)
993 return USB_STOR_TRANSPORT_ERROR;
996 /* STATUS STAGE */
999 * NOTE: CB does not have a status stage. Silly, I know. So
1000 * we have to catch this at a higher level.
1002 if (us->protocol != USB_PR_CBI)
1003 return USB_STOR_TRANSPORT_GOOD;
1005 result = usb_stor_intr_transfer(us, us->iobuf, 2);
1006 usb_stor_dbg(us, "Got interrupt data (0x%x, 0x%x)\n",
1007 us->iobuf[0], us->iobuf[1]);
1008 if (result != USB_STOR_XFER_GOOD)
1009 return USB_STOR_TRANSPORT_ERROR;
1012 * UFI gives us ASC and ASCQ, like a request sense
1014 * REQUEST_SENSE and INQUIRY don't affect the sense data on UFI
1015 * devices, so we ignore the information for those commands. Note
1016 * that this means we could be ignoring a real error on these
1017 * commands, but that can't be helped.
1019 if (us->subclass == USB_SC_UFI) {
1020 if (srb->cmnd[0] == REQUEST_SENSE ||
1021 srb->cmnd[0] == INQUIRY)
1022 return USB_STOR_TRANSPORT_GOOD;
1023 if (us->iobuf[0])
1024 goto Failed;
1025 return USB_STOR_TRANSPORT_GOOD;
1029 * If not UFI, we interpret the data as a result code
1030 * The first byte should always be a 0x0.
1032 * Some bogus devices don't follow that rule. They stuff the ASC
1033 * into the first byte -- so if it's non-zero, call it a failure.
1035 if (us->iobuf[0]) {
1036 usb_stor_dbg(us, "CBI IRQ data showed reserved bType 0x%x\n",
1037 us->iobuf[0]);
1038 goto Failed;
1042 /* The second byte & 0x0F should be 0x0 for good, otherwise error */
1043 switch (us->iobuf[1] & 0x0F) {
1044 case 0x00:
1045 return USB_STOR_TRANSPORT_GOOD;
1046 case 0x01:
1047 goto Failed;
1049 return USB_STOR_TRANSPORT_ERROR;
1052 * the CBI spec requires that the bulk pipe must be cleared
1053 * following any data-in/out command failure (section 2.4.3.1.3)
1055 Failed:
1056 if (pipe)
1057 usb_stor_clear_halt(us, pipe);
1058 return USB_STOR_TRANSPORT_FAILED;
1060 EXPORT_SYMBOL_GPL(usb_stor_CB_transport);
1063 * Bulk only transport
1066 /* Determine what the maximum LUN supported is */
1067 int usb_stor_Bulk_max_lun(struct us_data *us)
1069 int result;
1071 /* issue the command */
1072 us->iobuf[0] = 0;
1073 result = usb_stor_control_msg(us, us->recv_ctrl_pipe,
1074 US_BULK_GET_MAX_LUN,
1075 USB_DIR_IN | USB_TYPE_CLASS |
1076 USB_RECIP_INTERFACE,
1077 0, us->ifnum, us->iobuf, 1, 10*HZ);
1079 usb_stor_dbg(us, "GetMaxLUN command result is %d, data is %d\n",
1080 result, us->iobuf[0]);
1083 * If we have a successful request, return the result if valid. The
1084 * CBW LUN field is 4 bits wide, so the value reported by the device
1085 * should fit into that.
1087 if (result > 0) {
1088 if (us->iobuf[0] < 16) {
1089 return us->iobuf[0];
1090 } else {
1091 dev_info(&us->pusb_intf->dev,
1092 "Max LUN %d is not valid, using 0 instead",
1093 us->iobuf[0]);
1098 * Some devices don't like GetMaxLUN. They may STALL the control
1099 * pipe, they may return a zero-length result, they may do nothing at
1100 * all and timeout, or they may fail in even more bizarrely creative
1101 * ways. In these cases the best approach is to use the default
1102 * value: only one LUN.
1104 return 0;
1107 int usb_stor_Bulk_transport(struct scsi_cmnd *srb, struct us_data *us)
1109 struct bulk_cb_wrap *bcb = (struct bulk_cb_wrap *) us->iobuf;
1110 struct bulk_cs_wrap *bcs = (struct bulk_cs_wrap *) us->iobuf;
1111 unsigned int transfer_length = scsi_bufflen(srb);
1112 unsigned int residue;
1113 int result;
1114 int fake_sense = 0;
1115 unsigned int cswlen;
1116 unsigned int cbwlen = US_BULK_CB_WRAP_LEN;
1118 /* Take care of BULK32 devices; set extra byte to 0 */
1119 if (unlikely(us->fflags & US_FL_BULK32)) {
1120 cbwlen = 32;
1121 us->iobuf[31] = 0;
1124 /* set up the command wrapper */
1125 bcb->Signature = cpu_to_le32(US_BULK_CB_SIGN);
1126 bcb->DataTransferLength = cpu_to_le32(transfer_length);
1127 bcb->Flags = srb->sc_data_direction == DMA_FROM_DEVICE ?
1128 US_BULK_FLAG_IN : 0;
1129 bcb->Tag = ++us->tag;
1130 bcb->Lun = srb->device->lun;
1131 if (us->fflags & US_FL_SCM_MULT_TARG)
1132 bcb->Lun |= srb->device->id << 4;
1133 bcb->Length = srb->cmd_len;
1135 /* copy the command payload */
1136 memset(bcb->CDB, 0, sizeof(bcb->CDB));
1137 memcpy(bcb->CDB, srb->cmnd, bcb->Length);
1139 /* send it to out endpoint */
1140 usb_stor_dbg(us, "Bulk Command S 0x%x T 0x%x L %d F %d Trg %d LUN %d CL %d\n",
1141 le32_to_cpu(bcb->Signature), bcb->Tag,
1142 le32_to_cpu(bcb->DataTransferLength), bcb->Flags,
1143 (bcb->Lun >> 4), (bcb->Lun & 0x0F),
1144 bcb->Length);
1145 result = usb_stor_bulk_transfer_buf(us, us->send_bulk_pipe,
1146 bcb, cbwlen, NULL);
1147 usb_stor_dbg(us, "Bulk command transfer result=%d\n", result);
1148 if (result != USB_STOR_XFER_GOOD)
1149 return USB_STOR_TRANSPORT_ERROR;
1151 /* DATA STAGE */
1152 /* send/receive data payload, if there is any */
1155 * Some USB-IDE converter chips need a 100us delay between the
1156 * command phase and the data phase. Some devices need a little
1157 * more than that, probably because of clock rate inaccuracies.
1159 if (unlikely(us->fflags & US_FL_GO_SLOW))
1160 usleep_range(125, 150);
1162 if (transfer_length) {
1163 unsigned int pipe = srb->sc_data_direction == DMA_FROM_DEVICE ?
1164 us->recv_bulk_pipe : us->send_bulk_pipe;
1165 result = usb_stor_bulk_srb(us, pipe, srb);
1166 usb_stor_dbg(us, "Bulk data transfer result 0x%x\n", result);
1167 if (result == USB_STOR_XFER_ERROR)
1168 return USB_STOR_TRANSPORT_ERROR;
1171 * If the device tried to send back more data than the
1172 * amount requested, the spec requires us to transfer
1173 * the CSW anyway. Since there's no point retrying the
1174 * the command, we'll return fake sense data indicating
1175 * Illegal Request, Invalid Field in CDB.
1177 if (result == USB_STOR_XFER_LONG)
1178 fake_sense = 1;
1181 * Sometimes a device will mistakenly skip the data phase
1182 * and go directly to the status phase without sending a
1183 * zero-length packet. If we get a 13-byte response here,
1184 * check whether it really is a CSW.
1186 if (result == USB_STOR_XFER_SHORT &&
1187 srb->sc_data_direction == DMA_FROM_DEVICE &&
1188 transfer_length - scsi_get_resid(srb) ==
1189 US_BULK_CS_WRAP_LEN) {
1190 struct scatterlist *sg = NULL;
1191 unsigned int offset = 0;
1193 if (usb_stor_access_xfer_buf((unsigned char *) bcs,
1194 US_BULK_CS_WRAP_LEN, srb, &sg,
1195 &offset, FROM_XFER_BUF) ==
1196 US_BULK_CS_WRAP_LEN &&
1197 bcs->Signature ==
1198 cpu_to_le32(US_BULK_CS_SIGN)) {
1199 usb_stor_dbg(us, "Device skipped data phase\n");
1200 scsi_set_resid(srb, transfer_length);
1201 goto skipped_data_phase;
1207 * See flow chart on pg 15 of the Bulk Only Transport spec for
1208 * an explanation of how this code works.
1211 /* get CSW for device status */
1212 usb_stor_dbg(us, "Attempting to get CSW...\n");
1213 result = usb_stor_bulk_transfer_buf(us, us->recv_bulk_pipe,
1214 bcs, US_BULK_CS_WRAP_LEN, &cswlen);
1217 * Some broken devices add unnecessary zero-length packets to the
1218 * end of their data transfers. Such packets show up as 0-length
1219 * CSWs. If we encounter such a thing, try to read the CSW again.
1221 if (result == USB_STOR_XFER_SHORT && cswlen == 0) {
1222 usb_stor_dbg(us, "Received 0-length CSW; retrying...\n");
1223 result = usb_stor_bulk_transfer_buf(us, us->recv_bulk_pipe,
1224 bcs, US_BULK_CS_WRAP_LEN, &cswlen);
1227 /* did the attempt to read the CSW fail? */
1228 if (result == USB_STOR_XFER_STALLED) {
1230 /* get the status again */
1231 usb_stor_dbg(us, "Attempting to get CSW (2nd try)...\n");
1232 result = usb_stor_bulk_transfer_buf(us, us->recv_bulk_pipe,
1233 bcs, US_BULK_CS_WRAP_LEN, NULL);
1236 /* if we still have a failure at this point, we're in trouble */
1237 usb_stor_dbg(us, "Bulk status result = %d\n", result);
1238 if (result != USB_STOR_XFER_GOOD)
1239 return USB_STOR_TRANSPORT_ERROR;
1241 skipped_data_phase:
1242 /* check bulk status */
1243 residue = le32_to_cpu(bcs->Residue);
1244 usb_stor_dbg(us, "Bulk Status S 0x%x T 0x%x R %u Stat 0x%x\n",
1245 le32_to_cpu(bcs->Signature), bcs->Tag,
1246 residue, bcs->Status);
1247 if (!(bcs->Tag == us->tag || (us->fflags & US_FL_BULK_IGNORE_TAG)) ||
1248 bcs->Status > US_BULK_STAT_PHASE) {
1249 usb_stor_dbg(us, "Bulk logical error\n");
1250 return USB_STOR_TRANSPORT_ERROR;
1254 * Some broken devices report odd signatures, so we do not check them
1255 * for validity against the spec. We store the first one we see,
1256 * and check subsequent transfers for validity against this signature.
1258 if (!us->bcs_signature) {
1259 us->bcs_signature = bcs->Signature;
1260 if (us->bcs_signature != cpu_to_le32(US_BULK_CS_SIGN))
1261 usb_stor_dbg(us, "Learnt BCS signature 0x%08X\n",
1262 le32_to_cpu(us->bcs_signature));
1263 } else if (bcs->Signature != us->bcs_signature) {
1264 usb_stor_dbg(us, "Signature mismatch: got %08X, expecting %08X\n",
1265 le32_to_cpu(bcs->Signature),
1266 le32_to_cpu(us->bcs_signature));
1267 return USB_STOR_TRANSPORT_ERROR;
1271 * try to compute the actual residue, based on how much data
1272 * was really transferred and what the device tells us
1274 if (residue && !(us->fflags & US_FL_IGNORE_RESIDUE)) {
1277 * Heuristically detect devices that generate bogus residues
1278 * by seeing what happens with INQUIRY and READ CAPACITY
1279 * commands.
1281 if (bcs->Status == US_BULK_STAT_OK &&
1282 scsi_get_resid(srb) == 0 &&
1283 ((srb->cmnd[0] == INQUIRY &&
1284 transfer_length == 36) ||
1285 (srb->cmnd[0] == READ_CAPACITY &&
1286 transfer_length == 8))) {
1287 us->fflags |= US_FL_IGNORE_RESIDUE;
1289 } else {
1290 residue = min(residue, transfer_length);
1291 scsi_set_resid(srb, max(scsi_get_resid(srb),
1292 (int) residue));
1296 /* based on the status code, we report good or bad */
1297 switch (bcs->Status) {
1298 case US_BULK_STAT_OK:
1299 /* device babbled -- return fake sense data */
1300 if (fake_sense) {
1301 memcpy(srb->sense_buffer,
1302 usb_stor_sense_invalidCDB,
1303 sizeof(usb_stor_sense_invalidCDB));
1304 return USB_STOR_TRANSPORT_NO_SENSE;
1307 /* command good -- note that data could be short */
1308 return USB_STOR_TRANSPORT_GOOD;
1310 case US_BULK_STAT_FAIL:
1311 /* command failed */
1312 return USB_STOR_TRANSPORT_FAILED;
1314 case US_BULK_STAT_PHASE:
1316 * phase error -- note that a transport reset will be
1317 * invoked by the invoke_transport() function
1319 return USB_STOR_TRANSPORT_ERROR;
1322 /* we should never get here, but if we do, we're in trouble */
1323 return USB_STOR_TRANSPORT_ERROR;
1325 EXPORT_SYMBOL_GPL(usb_stor_Bulk_transport);
1327 /***********************************************************************
1328 * Reset routines
1329 ***********************************************************************/
1332 * This is the common part of the device reset code.
1334 * It's handy that every transport mechanism uses the control endpoint for
1335 * resets.
1337 * Basically, we send a reset with a 5-second timeout, so we don't get
1338 * jammed attempting to do the reset.
1340 static int usb_stor_reset_common(struct us_data *us,
1341 u8 request, u8 requesttype,
1342 u16 value, u16 index, void *data, u16 size)
1344 int result;
1345 int result2;
1347 if (test_bit(US_FLIDX_DISCONNECTING, &us->dflags)) {
1348 usb_stor_dbg(us, "No reset during disconnect\n");
1349 return -EIO;
1352 result = usb_stor_control_msg(us, us->send_ctrl_pipe,
1353 request, requesttype, value, index, data, size,
1354 5*HZ);
1355 if (result < 0) {
1356 usb_stor_dbg(us, "Soft reset failed: %d\n", result);
1357 return result;
1361 * Give the device some time to recover from the reset,
1362 * but don't delay disconnect processing.
1364 wait_event_interruptible_timeout(us->delay_wait,
1365 test_bit(US_FLIDX_DISCONNECTING, &us->dflags),
1366 HZ*6);
1367 if (test_bit(US_FLIDX_DISCONNECTING, &us->dflags)) {
1368 usb_stor_dbg(us, "Reset interrupted by disconnect\n");
1369 return -EIO;
1372 usb_stor_dbg(us, "Soft reset: clearing bulk-in endpoint halt\n");
1373 result = usb_stor_clear_halt(us, us->recv_bulk_pipe);
1375 usb_stor_dbg(us, "Soft reset: clearing bulk-out endpoint halt\n");
1376 result2 = usb_stor_clear_halt(us, us->send_bulk_pipe);
1378 /* return a result code based on the result of the clear-halts */
1379 if (result >= 0)
1380 result = result2;
1381 if (result < 0)
1382 usb_stor_dbg(us, "Soft reset failed\n");
1383 else
1384 usb_stor_dbg(us, "Soft reset done\n");
1385 return result;
1388 /* This issues a CB[I] Reset to the device in question */
1389 #define CB_RESET_CMD_SIZE 12
1391 int usb_stor_CB_reset(struct us_data *us)
1393 memset(us->iobuf, 0xFF, CB_RESET_CMD_SIZE);
1394 us->iobuf[0] = SEND_DIAGNOSTIC;
1395 us->iobuf[1] = 4;
1396 return usb_stor_reset_common(us, US_CBI_ADSC,
1397 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
1398 0, us->ifnum, us->iobuf, CB_RESET_CMD_SIZE);
1400 EXPORT_SYMBOL_GPL(usb_stor_CB_reset);
1403 * This issues a Bulk-only Reset to the device in question, including
1404 * clearing the subsequent endpoint halts that may occur.
1406 int usb_stor_Bulk_reset(struct us_data *us)
1408 return usb_stor_reset_common(us, US_BULK_RESET_REQUEST,
1409 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
1410 0, us->ifnum, NULL, 0);
1412 EXPORT_SYMBOL_GPL(usb_stor_Bulk_reset);
1415 * Issue a USB port reset to the device. The caller must not hold
1416 * us->dev_mutex.
1418 int usb_stor_port_reset(struct us_data *us)
1420 int result;
1422 /*for these devices we must use the class specific method */
1423 if (us->pusb_dev->quirks & USB_QUIRK_RESET)
1424 return -EPERM;
1426 result = usb_lock_device_for_reset(us->pusb_dev, us->pusb_intf);
1427 if (result < 0)
1428 usb_stor_dbg(us, "unable to lock device for reset: %d\n",
1429 result);
1430 else {
1431 /* Were we disconnected while waiting for the lock? */
1432 if (test_bit(US_FLIDX_DISCONNECTING, &us->dflags)) {
1433 result = -EIO;
1434 usb_stor_dbg(us, "No reset during disconnect\n");
1435 } else {
1436 result = usb_reset_device(us->pusb_dev);
1437 usb_stor_dbg(us, "usb_reset_device returns %d\n",
1438 result);
1440 usb_unlock_device(us->pusb_dev);
1442 return result;