1 // SPDX-License-Identifier: GPL-2.0
4 * Note that this is not the same as the USB Mass Storage driver
6 * Copyright Hans de Goede <hdegoede@redhat.com> for Red Hat, Inc. 2013 - 2016
7 * Copyright Matthew Wilcox for Intel Corp, 2010
8 * Copyright Sarah Sharp for Intel Corp, 2010
11 #include <linux/blkdev.h>
12 #include <linux/slab.h>
13 #include <linux/types.h>
14 #include <linux/module.h>
15 #include <linux/usb.h>
16 #include <linux/usb_usual.h>
17 #include <linux/usb/hcd.h>
18 #include <linux/usb/storage.h>
19 #include <linux/usb/uas.h>
21 #include <scsi/scsi.h>
22 #include <scsi/scsi_eh.h>
23 #include <scsi/scsi_dbg.h>
24 #include <scsi/scsi_cmnd.h>
25 #include <scsi/scsi_device.h>
26 #include <scsi/scsi_host.h>
27 #include <scsi/scsi_tcq.h>
29 #include "uas-detect.h"
35 struct usb_interface *intf;
36 struct usb_device *udev;
37 struct usb_anchor cmd_urbs;
38 struct usb_anchor sense_urbs;
39 struct usb_anchor data_urbs;
41 int qdepth, resetting;
42 unsigned cmd_pipe, status_pipe, data_in_pipe, data_out_pipe;
43 unsigned use_streams:1;
45 struct scsi_cmnd *cmnd[MAX_CMNDS];
47 struct work_struct work;
48 struct work_struct scan_work; /* for async scanning */
52 SUBMIT_STATUS_URB = BIT(1),
53 ALLOC_DATA_IN_URB = BIT(2),
54 SUBMIT_DATA_IN_URB = BIT(3),
55 ALLOC_DATA_OUT_URB = BIT(4),
56 SUBMIT_DATA_OUT_URB = BIT(5),
57 ALLOC_CMD_URB = BIT(6),
58 SUBMIT_CMD_URB = BIT(7),
59 COMMAND_INFLIGHT = BIT(8),
60 DATA_IN_URB_INFLIGHT = BIT(9),
61 DATA_OUT_URB_INFLIGHT = BIT(10),
62 COMMAND_ABORTED = BIT(11),
63 IS_IN_WORK_LIST = BIT(12),
66 /* Overrides scsi_pointer */
71 struct urb *data_in_urb;
72 struct urb *data_out_urb;
75 /* I hate forward declarations, but I actually have a loop */
76 static int uas_submit_urbs(struct scsi_cmnd *cmnd,
77 struct uas_dev_info *devinfo);
78 static void uas_do_work(struct work_struct *work);
79 static int uas_try_complete(struct scsi_cmnd *cmnd, const char *caller);
80 static void uas_free_streams(struct uas_dev_info *devinfo);
81 static void uas_log_cmd_state(struct scsi_cmnd *cmnd, const char *prefix,
84 static void uas_do_work(struct work_struct *work)
86 struct uas_dev_info *devinfo =
87 container_of(work, struct uas_dev_info, work);
88 struct uas_cmd_info *cmdinfo;
89 struct scsi_cmnd *cmnd;
93 spin_lock_irqsave(&devinfo->lock, flags);
95 if (devinfo->resetting)
98 for (i = 0; i < devinfo->qdepth; i++) {
99 if (!devinfo->cmnd[i])
102 cmnd = devinfo->cmnd[i];
103 cmdinfo = (void *)&cmnd->SCp;
105 if (!(cmdinfo->state & IS_IN_WORK_LIST))
108 err = uas_submit_urbs(cmnd, cmnd->device->hostdata);
110 cmdinfo->state &= ~IS_IN_WORK_LIST;
112 schedule_work(&devinfo->work);
115 spin_unlock_irqrestore(&devinfo->lock, flags);
118 static void uas_scan_work(struct work_struct *work)
120 struct uas_dev_info *devinfo =
121 container_of(work, struct uas_dev_info, scan_work);
122 struct Scsi_Host *shost = usb_get_intfdata(devinfo->intf);
124 dev_dbg(&devinfo->intf->dev, "starting scan\n");
125 scsi_scan_host(shost);
126 dev_dbg(&devinfo->intf->dev, "scan complete\n");
129 static void uas_add_work(struct uas_cmd_info *cmdinfo)
131 struct scsi_pointer *scp = (void *)cmdinfo;
132 struct scsi_cmnd *cmnd = container_of(scp, struct scsi_cmnd, SCp);
133 struct uas_dev_info *devinfo = cmnd->device->hostdata;
135 lockdep_assert_held(&devinfo->lock);
136 cmdinfo->state |= IS_IN_WORK_LIST;
137 schedule_work(&devinfo->work);
140 static void uas_zap_pending(struct uas_dev_info *devinfo, int result)
142 struct uas_cmd_info *cmdinfo;
143 struct scsi_cmnd *cmnd;
147 spin_lock_irqsave(&devinfo->lock, flags);
148 for (i = 0; i < devinfo->qdepth; i++) {
149 if (!devinfo->cmnd[i])
152 cmnd = devinfo->cmnd[i];
153 cmdinfo = (void *)&cmnd->SCp;
154 uas_log_cmd_state(cmnd, __func__, 0);
155 /* Sense urbs were killed, clear COMMAND_INFLIGHT manually */
156 cmdinfo->state &= ~COMMAND_INFLIGHT;
157 cmnd->result = result << 16;
158 err = uas_try_complete(cmnd, __func__);
161 spin_unlock_irqrestore(&devinfo->lock, flags);
164 static void uas_sense(struct urb *urb, struct scsi_cmnd *cmnd)
166 struct sense_iu *sense_iu = urb->transfer_buffer;
167 struct scsi_device *sdev = cmnd->device;
169 if (urb->actual_length > 16) {
170 unsigned len = be16_to_cpup(&sense_iu->len);
171 if (len + 16 != urb->actual_length) {
172 int newlen = min(len + 16, urb->actual_length) - 16;
175 sdev_printk(KERN_INFO, sdev, "%s: urb length %d "
176 "disagrees with IU sense data length %d, "
177 "using %d bytes of sense data\n", __func__,
178 urb->actual_length, len, newlen);
181 memcpy(cmnd->sense_buffer, sense_iu->sense, len);
184 cmnd->result = sense_iu->status;
187 static void uas_log_cmd_state(struct scsi_cmnd *cmnd, const char *prefix,
190 struct uas_cmd_info *ci = (void *)&cmnd->SCp;
191 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
193 scmd_printk(KERN_INFO, cmnd,
194 "%s %d uas-tag %d inflight:%s%s%s%s%s%s%s%s%s%s%s%s ",
195 prefix, status, cmdinfo->uas_tag,
196 (ci->state & SUBMIT_STATUS_URB) ? " s-st" : "",
197 (ci->state & ALLOC_DATA_IN_URB) ? " a-in" : "",
198 (ci->state & SUBMIT_DATA_IN_URB) ? " s-in" : "",
199 (ci->state & ALLOC_DATA_OUT_URB) ? " a-out" : "",
200 (ci->state & SUBMIT_DATA_OUT_URB) ? " s-out" : "",
201 (ci->state & ALLOC_CMD_URB) ? " a-cmd" : "",
202 (ci->state & SUBMIT_CMD_URB) ? " s-cmd" : "",
203 (ci->state & COMMAND_INFLIGHT) ? " CMD" : "",
204 (ci->state & DATA_IN_URB_INFLIGHT) ? " IN" : "",
205 (ci->state & DATA_OUT_URB_INFLIGHT) ? " OUT" : "",
206 (ci->state & COMMAND_ABORTED) ? " abort" : "",
207 (ci->state & IS_IN_WORK_LIST) ? " work" : "");
208 scsi_print_command(cmnd);
211 static void uas_free_unsubmitted_urbs(struct scsi_cmnd *cmnd)
213 struct uas_cmd_info *cmdinfo;
218 cmdinfo = (void *)&cmnd->SCp;
220 if (cmdinfo->state & SUBMIT_CMD_URB)
221 usb_free_urb(cmdinfo->cmd_urb);
223 /* data urbs may have never gotten their submit flag set */
224 if (!(cmdinfo->state & DATA_IN_URB_INFLIGHT))
225 usb_free_urb(cmdinfo->data_in_urb);
226 if (!(cmdinfo->state & DATA_OUT_URB_INFLIGHT))
227 usb_free_urb(cmdinfo->data_out_urb);
230 static int uas_try_complete(struct scsi_cmnd *cmnd, const char *caller)
232 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
233 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
235 lockdep_assert_held(&devinfo->lock);
236 if (cmdinfo->state & (COMMAND_INFLIGHT |
237 DATA_IN_URB_INFLIGHT |
238 DATA_OUT_URB_INFLIGHT |
241 devinfo->cmnd[cmdinfo->uas_tag - 1] = NULL;
242 uas_free_unsubmitted_urbs(cmnd);
243 cmnd->scsi_done(cmnd);
247 static void uas_xfer_data(struct urb *urb, struct scsi_cmnd *cmnd,
250 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
253 cmdinfo->state |= direction | SUBMIT_STATUS_URB;
254 err = uas_submit_urbs(cmnd, cmnd->device->hostdata);
256 uas_add_work(cmdinfo);
260 static bool uas_evaluate_response_iu(struct response_iu *riu, struct scsi_cmnd *cmnd)
262 u8 response_code = riu->response_code;
264 switch (response_code) {
265 case RC_INCORRECT_LUN:
266 cmnd->result = DID_BAD_TARGET << 16;
268 case RC_TMF_SUCCEEDED:
269 cmnd->result = DID_OK << 16;
271 case RC_TMF_NOT_SUPPORTED:
272 cmnd->result = DID_TARGET_FAILURE << 16;
275 uas_log_cmd_state(cmnd, "response iu", response_code);
276 cmnd->result = DID_ERROR << 16;
280 return response_code == RC_TMF_SUCCEEDED;
283 static void uas_stat_cmplt(struct urb *urb)
285 struct iu *iu = urb->transfer_buffer;
286 struct Scsi_Host *shost = urb->context;
287 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
288 struct urb *data_in_urb = NULL;
289 struct urb *data_out_urb = NULL;
290 struct scsi_cmnd *cmnd;
291 struct uas_cmd_info *cmdinfo;
294 int status = urb->status;
297 spin_lock_irqsave(&devinfo->lock, flags);
299 if (devinfo->resetting)
303 if (status != -ENOENT && status != -ECONNRESET && status != -ESHUTDOWN)
304 dev_err(&urb->dev->dev, "stat urb: status %d\n", status);
308 idx = be16_to_cpup(&iu->tag) - 1;
309 if (idx >= MAX_CMNDS || !devinfo->cmnd[idx]) {
310 dev_err(&urb->dev->dev,
311 "stat urb: no pending cmd for uas-tag %d\n", idx + 1);
315 cmnd = devinfo->cmnd[idx];
316 cmdinfo = (void *)&cmnd->SCp;
318 if (!(cmdinfo->state & COMMAND_INFLIGHT)) {
319 uas_log_cmd_state(cmnd, "unexpected status cmplt", 0);
325 uas_sense(urb, cmnd);
326 if (cmnd->result != 0) {
327 /* cancel data transfers on error */
328 data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
329 data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
331 cmdinfo->state &= ~COMMAND_INFLIGHT;
332 uas_try_complete(cmnd, __func__);
334 case IU_ID_READ_READY:
335 if (!cmdinfo->data_in_urb ||
336 (cmdinfo->state & DATA_IN_URB_INFLIGHT)) {
337 uas_log_cmd_state(cmnd, "unexpected read rdy", 0);
340 uas_xfer_data(urb, cmnd, SUBMIT_DATA_IN_URB);
342 case IU_ID_WRITE_READY:
343 if (!cmdinfo->data_out_urb ||
344 (cmdinfo->state & DATA_OUT_URB_INFLIGHT)) {
345 uas_log_cmd_state(cmnd, "unexpected write rdy", 0);
348 uas_xfer_data(urb, cmnd, SUBMIT_DATA_OUT_URB);
351 cmdinfo->state &= ~COMMAND_INFLIGHT;
352 success = uas_evaluate_response_iu((struct response_iu *)iu, cmnd);
354 /* Error, cancel data transfers */
355 data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
356 data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
358 uas_try_complete(cmnd, __func__);
361 uas_log_cmd_state(cmnd, "bogus IU", iu->iu_id);
365 spin_unlock_irqrestore(&devinfo->lock, flags);
367 /* Unlinking of data urbs must be done without holding the lock */
369 usb_unlink_urb(data_in_urb);
370 usb_put_urb(data_in_urb);
373 usb_unlink_urb(data_out_urb);
374 usb_put_urb(data_out_urb);
378 static void uas_data_cmplt(struct urb *urb)
380 struct scsi_cmnd *cmnd = urb->context;
381 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
382 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
383 struct scsi_data_buffer *sdb = &cmnd->sdb;
385 int status = urb->status;
387 spin_lock_irqsave(&devinfo->lock, flags);
389 if (cmdinfo->data_in_urb == urb) {
390 cmdinfo->state &= ~DATA_IN_URB_INFLIGHT;
391 cmdinfo->data_in_urb = NULL;
392 } else if (cmdinfo->data_out_urb == urb) {
393 cmdinfo->state &= ~DATA_OUT_URB_INFLIGHT;
394 cmdinfo->data_out_urb = NULL;
397 if (devinfo->resetting)
400 /* Data urbs should not complete before the cmd urb is submitted */
401 if (cmdinfo->state & SUBMIT_CMD_URB) {
402 uas_log_cmd_state(cmnd, "unexpected data cmplt", 0);
407 if (status != -ENOENT && status != -ECONNRESET && status != -ESHUTDOWN)
408 uas_log_cmd_state(cmnd, "data cmplt err", status);
409 /* error: no data transfered */
410 scsi_set_resid(cmnd, sdb->length);
412 scsi_set_resid(cmnd, sdb->length - urb->actual_length);
414 uas_try_complete(cmnd, __func__);
417 spin_unlock_irqrestore(&devinfo->lock, flags);
420 static void uas_cmd_cmplt(struct urb *urb)
423 dev_err(&urb->dev->dev, "cmd cmplt err %d\n", urb->status);
428 static struct urb *uas_alloc_data_urb(struct uas_dev_info *devinfo, gfp_t gfp,
429 struct scsi_cmnd *cmnd,
430 enum dma_data_direction dir)
432 struct usb_device *udev = devinfo->udev;
433 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
434 struct urb *urb = usb_alloc_urb(0, gfp);
435 struct scsi_data_buffer *sdb = &cmnd->sdb;
436 unsigned int pipe = (dir == DMA_FROM_DEVICE)
437 ? devinfo->data_in_pipe : devinfo->data_out_pipe;
441 usb_fill_bulk_urb(urb, udev, pipe, NULL, sdb->length,
442 uas_data_cmplt, cmnd);
443 if (devinfo->use_streams)
444 urb->stream_id = cmdinfo->uas_tag;
445 urb->num_sgs = udev->bus->sg_tablesize ? sdb->table.nents : 0;
446 urb->sg = sdb->table.sgl;
451 static struct urb *uas_alloc_sense_urb(struct uas_dev_info *devinfo, gfp_t gfp,
452 struct scsi_cmnd *cmnd)
454 struct usb_device *udev = devinfo->udev;
455 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
456 struct urb *urb = usb_alloc_urb(0, gfp);
462 iu = kzalloc(sizeof(*iu), gfp);
466 usb_fill_bulk_urb(urb, udev, devinfo->status_pipe, iu, sizeof(*iu),
467 uas_stat_cmplt, cmnd->device->host);
468 if (devinfo->use_streams)
469 urb->stream_id = cmdinfo->uas_tag;
470 urb->transfer_flags |= URB_FREE_BUFFER;
478 static struct urb *uas_alloc_cmd_urb(struct uas_dev_info *devinfo, gfp_t gfp,
479 struct scsi_cmnd *cmnd)
481 struct usb_device *udev = devinfo->udev;
482 struct scsi_device *sdev = cmnd->device;
483 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
484 struct urb *urb = usb_alloc_urb(0, gfp);
485 struct command_iu *iu;
491 len = cmnd->cmd_len - 16;
495 iu = kzalloc(sizeof(*iu) + len, gfp);
499 iu->iu_id = IU_ID_COMMAND;
500 iu->tag = cpu_to_be16(cmdinfo->uas_tag);
501 iu->prio_attr = UAS_SIMPLE_TAG;
503 int_to_scsilun(sdev->lun, &iu->lun);
504 memcpy(iu->cdb, cmnd->cmnd, cmnd->cmd_len);
506 usb_fill_bulk_urb(urb, udev, devinfo->cmd_pipe, iu, sizeof(*iu) + len,
507 uas_cmd_cmplt, NULL);
508 urb->transfer_flags |= URB_FREE_BUFFER;
517 * Why should I request the Status IU before sending the Command IU? Spec
518 * says to, but also says the device may receive them in any order. Seems
522 static struct urb *uas_submit_sense_urb(struct scsi_cmnd *cmnd, gfp_t gfp)
524 struct uas_dev_info *devinfo = cmnd->device->hostdata;
528 urb = uas_alloc_sense_urb(devinfo, gfp, cmnd);
531 usb_anchor_urb(urb, &devinfo->sense_urbs);
532 err = usb_submit_urb(urb, gfp);
534 usb_unanchor_urb(urb);
535 uas_log_cmd_state(cmnd, "sense submit err", err);
542 static int uas_submit_urbs(struct scsi_cmnd *cmnd,
543 struct uas_dev_info *devinfo)
545 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
549 lockdep_assert_held(&devinfo->lock);
550 if (cmdinfo->state & SUBMIT_STATUS_URB) {
551 urb = uas_submit_sense_urb(cmnd, GFP_ATOMIC);
553 return SCSI_MLQUEUE_DEVICE_BUSY;
554 cmdinfo->state &= ~SUBMIT_STATUS_URB;
557 if (cmdinfo->state & ALLOC_DATA_IN_URB) {
558 cmdinfo->data_in_urb = uas_alloc_data_urb(devinfo, GFP_ATOMIC,
559 cmnd, DMA_FROM_DEVICE);
560 if (!cmdinfo->data_in_urb)
561 return SCSI_MLQUEUE_DEVICE_BUSY;
562 cmdinfo->state &= ~ALLOC_DATA_IN_URB;
565 if (cmdinfo->state & SUBMIT_DATA_IN_URB) {
566 usb_anchor_urb(cmdinfo->data_in_urb, &devinfo->data_urbs);
567 err = usb_submit_urb(cmdinfo->data_in_urb, GFP_ATOMIC);
569 usb_unanchor_urb(cmdinfo->data_in_urb);
570 uas_log_cmd_state(cmnd, "data in submit err", err);
571 return SCSI_MLQUEUE_DEVICE_BUSY;
573 cmdinfo->state &= ~SUBMIT_DATA_IN_URB;
574 cmdinfo->state |= DATA_IN_URB_INFLIGHT;
577 if (cmdinfo->state & ALLOC_DATA_OUT_URB) {
578 cmdinfo->data_out_urb = uas_alloc_data_urb(devinfo, GFP_ATOMIC,
579 cmnd, DMA_TO_DEVICE);
580 if (!cmdinfo->data_out_urb)
581 return SCSI_MLQUEUE_DEVICE_BUSY;
582 cmdinfo->state &= ~ALLOC_DATA_OUT_URB;
585 if (cmdinfo->state & SUBMIT_DATA_OUT_URB) {
586 usb_anchor_urb(cmdinfo->data_out_urb, &devinfo->data_urbs);
587 err = usb_submit_urb(cmdinfo->data_out_urb, GFP_ATOMIC);
589 usb_unanchor_urb(cmdinfo->data_out_urb);
590 uas_log_cmd_state(cmnd, "data out submit err", err);
591 return SCSI_MLQUEUE_DEVICE_BUSY;
593 cmdinfo->state &= ~SUBMIT_DATA_OUT_URB;
594 cmdinfo->state |= DATA_OUT_URB_INFLIGHT;
597 if (cmdinfo->state & ALLOC_CMD_URB) {
598 cmdinfo->cmd_urb = uas_alloc_cmd_urb(devinfo, GFP_ATOMIC, cmnd);
599 if (!cmdinfo->cmd_urb)
600 return SCSI_MLQUEUE_DEVICE_BUSY;
601 cmdinfo->state &= ~ALLOC_CMD_URB;
604 if (cmdinfo->state & SUBMIT_CMD_URB) {
605 usb_anchor_urb(cmdinfo->cmd_urb, &devinfo->cmd_urbs);
606 err = usb_submit_urb(cmdinfo->cmd_urb, GFP_ATOMIC);
608 usb_unanchor_urb(cmdinfo->cmd_urb);
609 uas_log_cmd_state(cmnd, "cmd submit err", err);
610 return SCSI_MLQUEUE_DEVICE_BUSY;
612 cmdinfo->cmd_urb = NULL;
613 cmdinfo->state &= ~SUBMIT_CMD_URB;
614 cmdinfo->state |= COMMAND_INFLIGHT;
620 static int uas_queuecommand_lck(struct scsi_cmnd *cmnd,
621 void (*done)(struct scsi_cmnd *))
623 struct scsi_device *sdev = cmnd->device;
624 struct uas_dev_info *devinfo = sdev->hostdata;
625 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
629 BUILD_BUG_ON(sizeof(struct uas_cmd_info) > sizeof(struct scsi_pointer));
631 /* Re-check scsi_block_requests now that we've the host-lock */
632 if (cmnd->device->host->host_self_blocked)
633 return SCSI_MLQUEUE_DEVICE_BUSY;
635 if ((devinfo->flags & US_FL_NO_ATA_1X) &&
636 (cmnd->cmnd[0] == ATA_12 || cmnd->cmnd[0] == ATA_16)) {
637 memcpy(cmnd->sense_buffer, usb_stor_sense_invalidCDB,
638 sizeof(usb_stor_sense_invalidCDB));
639 cmnd->result = SAM_STAT_CHECK_CONDITION;
640 cmnd->scsi_done(cmnd);
644 spin_lock_irqsave(&devinfo->lock, flags);
646 if (devinfo->resetting) {
647 cmnd->result = DID_ERROR << 16;
648 cmnd->scsi_done(cmnd);
649 spin_unlock_irqrestore(&devinfo->lock, flags);
653 /* Find a free uas-tag */
654 for (idx = 0; idx < devinfo->qdepth; idx++) {
655 if (!devinfo->cmnd[idx])
658 if (idx == devinfo->qdepth) {
659 spin_unlock_irqrestore(&devinfo->lock, flags);
660 return SCSI_MLQUEUE_DEVICE_BUSY;
663 cmnd->scsi_done = done;
665 memset(cmdinfo, 0, sizeof(*cmdinfo));
666 cmdinfo->uas_tag = idx + 1; /* uas-tag == usb-stream-id, so 1 based */
667 cmdinfo->state = SUBMIT_STATUS_URB | ALLOC_CMD_URB | SUBMIT_CMD_URB;
669 switch (cmnd->sc_data_direction) {
670 case DMA_FROM_DEVICE:
671 cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
673 case DMA_BIDIRECTIONAL:
674 cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
677 cmdinfo->state |= ALLOC_DATA_OUT_URB | SUBMIT_DATA_OUT_URB;
682 if (!devinfo->use_streams)
683 cmdinfo->state &= ~(SUBMIT_DATA_IN_URB | SUBMIT_DATA_OUT_URB);
685 err = uas_submit_urbs(cmnd, devinfo);
687 /* If we did nothing, give up now */
688 if (cmdinfo->state & SUBMIT_STATUS_URB) {
689 spin_unlock_irqrestore(&devinfo->lock, flags);
690 return SCSI_MLQUEUE_DEVICE_BUSY;
692 uas_add_work(cmdinfo);
695 devinfo->cmnd[idx] = cmnd;
696 spin_unlock_irqrestore(&devinfo->lock, flags);
700 static DEF_SCSI_QCMD(uas_queuecommand)
703 * For now we do not support actually sending an abort to the device, so
704 * this eh always fails. Still we must define it to make sure that we've
705 * dropped all references to the cmnd in question once this function exits.
707 static int uas_eh_abort_handler(struct scsi_cmnd *cmnd)
709 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
710 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
711 struct urb *data_in_urb = NULL;
712 struct urb *data_out_urb = NULL;
715 spin_lock_irqsave(&devinfo->lock, flags);
717 uas_log_cmd_state(cmnd, __func__, 0);
719 /* Ensure that try_complete does not call scsi_done */
720 cmdinfo->state |= COMMAND_ABORTED;
722 /* Drop all refs to this cmnd, kill data urbs to break their ref */
723 devinfo->cmnd[cmdinfo->uas_tag - 1] = NULL;
724 if (cmdinfo->state & DATA_IN_URB_INFLIGHT)
725 data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
726 if (cmdinfo->state & DATA_OUT_URB_INFLIGHT)
727 data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
729 uas_free_unsubmitted_urbs(cmnd);
731 spin_unlock_irqrestore(&devinfo->lock, flags);
734 usb_kill_urb(data_in_urb);
735 usb_put_urb(data_in_urb);
738 usb_kill_urb(data_out_urb);
739 usb_put_urb(data_out_urb);
745 static int uas_eh_device_reset_handler(struct scsi_cmnd *cmnd)
747 struct scsi_device *sdev = cmnd->device;
748 struct uas_dev_info *devinfo = sdev->hostdata;
749 struct usb_device *udev = devinfo->udev;
753 err = usb_lock_device_for_reset(udev, devinfo->intf);
755 shost_printk(KERN_ERR, sdev->host,
756 "%s FAILED to get lock err %d\n", __func__, err);
760 shost_printk(KERN_INFO, sdev->host, "%s start\n", __func__);
762 spin_lock_irqsave(&devinfo->lock, flags);
763 devinfo->resetting = 1;
764 spin_unlock_irqrestore(&devinfo->lock, flags);
766 usb_kill_anchored_urbs(&devinfo->cmd_urbs);
767 usb_kill_anchored_urbs(&devinfo->sense_urbs);
768 usb_kill_anchored_urbs(&devinfo->data_urbs);
769 uas_zap_pending(devinfo, DID_RESET);
771 err = usb_reset_device(udev);
773 spin_lock_irqsave(&devinfo->lock, flags);
774 devinfo->resetting = 0;
775 spin_unlock_irqrestore(&devinfo->lock, flags);
777 usb_unlock_device(udev);
780 shost_printk(KERN_INFO, sdev->host, "%s FAILED err %d\n",
785 shost_printk(KERN_INFO, sdev->host, "%s success\n", __func__);
789 static int uas_target_alloc(struct scsi_target *starget)
791 struct uas_dev_info *devinfo = (struct uas_dev_info *)
792 dev_to_shost(starget->dev.parent)->hostdata;
794 if (devinfo->flags & US_FL_NO_REPORT_LUNS)
795 starget->no_report_luns = 1;
800 static int uas_slave_alloc(struct scsi_device *sdev)
802 struct uas_dev_info *devinfo =
803 (struct uas_dev_info *)sdev->host->hostdata;
805 sdev->hostdata = devinfo;
808 * The protocol has no requirements on alignment in the strict sense.
809 * Controllers may or may not have alignment restrictions.
810 * As this is not exported, we use an extremely conservative guess.
812 blk_queue_update_dma_alignment(sdev->request_queue, (512 - 1));
814 if (devinfo->flags & US_FL_MAX_SECTORS_64)
815 blk_queue_max_hw_sectors(sdev->request_queue, 64);
816 else if (devinfo->flags & US_FL_MAX_SECTORS_240)
817 blk_queue_max_hw_sectors(sdev->request_queue, 240);
822 static int uas_slave_configure(struct scsi_device *sdev)
824 struct uas_dev_info *devinfo = sdev->hostdata;
826 if (devinfo->flags & US_FL_NO_REPORT_OPCODES)
827 sdev->no_report_opcodes = 1;
829 /* A few buggy USB-ATA bridges don't understand FUA */
830 if (devinfo->flags & US_FL_BROKEN_FUA)
831 sdev->broken_fua = 1;
833 /* UAS also needs to support FL_ALWAYS_SYNC */
834 if (devinfo->flags & US_FL_ALWAYS_SYNC) {
835 sdev->skip_ms_page_3f = 1;
836 sdev->skip_ms_page_8 = 1;
837 sdev->wce_default_on = 1;
840 /* Some disks cannot handle READ_CAPACITY_16 */
841 if (devinfo->flags & US_FL_NO_READ_CAPACITY_16)
842 sdev->no_read_capacity_16 = 1;
845 * Some disks return the total number of blocks in response
846 * to READ CAPACITY rather than the highest block number.
847 * If this device makes that mistake, tell the sd driver.
849 if (devinfo->flags & US_FL_FIX_CAPACITY)
850 sdev->fix_capacity = 1;
853 * in some cases we have to guess
855 if (devinfo->flags & US_FL_CAPACITY_HEURISTICS)
856 sdev->guess_capacity = 1;
859 * Some devices don't like MODE SENSE with page=0x3f,
860 * which is the command used for checking if a device
861 * is write-protected. Now that we tell the sd driver
862 * to do a 192-byte transfer with this command the
863 * majority of devices work fine, but a few still can't
864 * handle it. The sd driver will simply assume those
865 * devices are write-enabled.
867 if (devinfo->flags & US_FL_NO_WP_DETECT)
868 sdev->skip_ms_page_3f = 1;
870 scsi_change_queue_depth(sdev, devinfo->qdepth - 2);
874 static struct scsi_host_template uas_host_template = {
875 .module = THIS_MODULE,
877 .queuecommand = uas_queuecommand,
878 .target_alloc = uas_target_alloc,
879 .slave_alloc = uas_slave_alloc,
880 .slave_configure = uas_slave_configure,
881 .eh_abort_handler = uas_eh_abort_handler,
882 .eh_device_reset_handler = uas_eh_device_reset_handler,
884 .skip_settle_delay = 1,
885 .dma_boundary = PAGE_SIZE - 1,
888 #define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \
889 vendorName, productName, useProtocol, useTransport, \
890 initFunction, flags) \
891 { USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax), \
892 .driver_info = (flags) }
894 static struct usb_device_id uas_usb_ids[] = {
895 # include "unusual_uas.h"
896 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_BULK) },
897 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_UAS) },
900 MODULE_DEVICE_TABLE(usb, uas_usb_ids);
904 static int uas_switch_interface(struct usb_device *udev,
905 struct usb_interface *intf)
907 struct usb_host_interface *alt;
909 alt = uas_find_uas_alt_setting(intf);
913 return usb_set_interface(udev, alt->desc.bInterfaceNumber,
914 alt->desc.bAlternateSetting);
917 static int uas_configure_endpoints(struct uas_dev_info *devinfo)
919 struct usb_host_endpoint *eps[4] = { };
920 struct usb_device *udev = devinfo->udev;
923 r = uas_find_endpoints(devinfo->intf->cur_altsetting, eps);
927 devinfo->cmd_pipe = usb_sndbulkpipe(udev,
928 usb_endpoint_num(&eps[0]->desc));
929 devinfo->status_pipe = usb_rcvbulkpipe(udev,
930 usb_endpoint_num(&eps[1]->desc));
931 devinfo->data_in_pipe = usb_rcvbulkpipe(udev,
932 usb_endpoint_num(&eps[2]->desc));
933 devinfo->data_out_pipe = usb_sndbulkpipe(udev,
934 usb_endpoint_num(&eps[3]->desc));
936 if (udev->speed < USB_SPEED_SUPER) {
937 devinfo->qdepth = 32;
938 devinfo->use_streams = 0;
940 devinfo->qdepth = usb_alloc_streams(devinfo->intf, eps + 1,
941 3, MAX_CMNDS, GFP_NOIO);
942 if (devinfo->qdepth < 0)
943 return devinfo->qdepth;
944 devinfo->use_streams = 1;
950 static void uas_free_streams(struct uas_dev_info *devinfo)
952 struct usb_device *udev = devinfo->udev;
953 struct usb_host_endpoint *eps[3];
955 eps[0] = usb_pipe_endpoint(udev, devinfo->status_pipe);
956 eps[1] = usb_pipe_endpoint(udev, devinfo->data_in_pipe);
957 eps[2] = usb_pipe_endpoint(udev, devinfo->data_out_pipe);
958 usb_free_streams(devinfo->intf, eps, 3, GFP_NOIO);
961 static int uas_probe(struct usb_interface *intf, const struct usb_device_id *id)
963 int result = -ENOMEM;
964 struct Scsi_Host *shost = NULL;
965 struct uas_dev_info *devinfo;
966 struct usb_device *udev = interface_to_usbdev(intf);
967 unsigned long dev_flags;
969 if (!uas_use_uas_driver(intf, id, &dev_flags))
972 if (uas_switch_interface(udev, intf))
975 shost = scsi_host_alloc(&uas_host_template,
976 sizeof(struct uas_dev_info));
980 shost->max_cmd_len = 16 + 252;
982 shost->max_lun = 256;
983 shost->max_channel = 0;
984 shost->sg_tablesize = udev->bus->sg_tablesize;
986 devinfo = (struct uas_dev_info *)shost->hostdata;
987 devinfo->intf = intf;
988 devinfo->udev = udev;
989 devinfo->resetting = 0;
990 devinfo->shutdown = 0;
991 devinfo->flags = dev_flags;
992 init_usb_anchor(&devinfo->cmd_urbs);
993 init_usb_anchor(&devinfo->sense_urbs);
994 init_usb_anchor(&devinfo->data_urbs);
995 spin_lock_init(&devinfo->lock);
996 INIT_WORK(&devinfo->work, uas_do_work);
997 INIT_WORK(&devinfo->scan_work, uas_scan_work);
999 result = uas_configure_endpoints(devinfo);
1004 * 1 tag is reserved for untagged commands +
1005 * 1 tag to avoid off by one errors in some bridge firmwares
1007 shost->can_queue = devinfo->qdepth - 2;
1009 usb_set_intfdata(intf, shost);
1010 result = scsi_add_host(shost, &intf->dev);
1014 /* Submit the delayed_work for SCSI-device scanning */
1015 schedule_work(&devinfo->scan_work);
1020 uas_free_streams(devinfo);
1021 usb_set_intfdata(intf, NULL);
1023 usb_set_interface(udev, intf->altsetting[0].desc.bInterfaceNumber, 0);
1025 scsi_host_put(shost);
1029 static int uas_cmnd_list_empty(struct uas_dev_info *devinfo)
1031 unsigned long flags;
1034 spin_lock_irqsave(&devinfo->lock, flags);
1036 for (i = 0; i < devinfo->qdepth; i++) {
1037 if (devinfo->cmnd[i]) {
1038 r = 0; /* Not empty */
1043 spin_unlock_irqrestore(&devinfo->lock, flags);
1049 * Wait for any pending cmnds to complete, on usb-2 sense_urbs may temporarily
1050 * get empty while there still is more work to do due to sense-urbs completing
1051 * with a READ/WRITE_READY iu code, so keep waiting until the list gets empty.
1053 static int uas_wait_for_pending_cmnds(struct uas_dev_info *devinfo)
1055 unsigned long start_time;
1058 start_time = jiffies;
1060 flush_work(&devinfo->work);
1062 r = usb_wait_anchor_empty_timeout(&devinfo->sense_urbs, 5000);
1066 r = usb_wait_anchor_empty_timeout(&devinfo->data_urbs, 500);
1070 if (time_after(jiffies, start_time + 5 * HZ))
1072 } while (!uas_cmnd_list_empty(devinfo));
1077 static int uas_pre_reset(struct usb_interface *intf)
1079 struct Scsi_Host *shost = usb_get_intfdata(intf);
1080 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1081 unsigned long flags;
1083 if (devinfo->shutdown)
1086 /* Block new requests */
1087 spin_lock_irqsave(shost->host_lock, flags);
1088 scsi_block_requests(shost);
1089 spin_unlock_irqrestore(shost->host_lock, flags);
1091 if (uas_wait_for_pending_cmnds(devinfo) != 0) {
1092 shost_printk(KERN_ERR, shost, "%s: timed out\n", __func__);
1093 scsi_unblock_requests(shost);
1097 uas_free_streams(devinfo);
1102 static int uas_post_reset(struct usb_interface *intf)
1104 struct Scsi_Host *shost = usb_get_intfdata(intf);
1105 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1106 unsigned long flags;
1109 if (devinfo->shutdown)
1112 err = uas_configure_endpoints(devinfo);
1113 if (err && err != -ENODEV)
1114 shost_printk(KERN_ERR, shost,
1115 "%s: alloc streams error %d after reset",
1118 /* we must unblock the host in every case lest we deadlock */
1119 spin_lock_irqsave(shost->host_lock, flags);
1120 scsi_report_bus_reset(shost, 0);
1121 spin_unlock_irqrestore(shost->host_lock, flags);
1123 scsi_unblock_requests(shost);
1128 static int uas_suspend(struct usb_interface *intf, pm_message_t message)
1130 struct Scsi_Host *shost = usb_get_intfdata(intf);
1131 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1133 if (uas_wait_for_pending_cmnds(devinfo) != 0) {
1134 shost_printk(KERN_ERR, shost, "%s: timed out\n", __func__);
1141 static int uas_resume(struct usb_interface *intf)
1146 static int uas_reset_resume(struct usb_interface *intf)
1148 struct Scsi_Host *shost = usb_get_intfdata(intf);
1149 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1150 unsigned long flags;
1153 err = uas_configure_endpoints(devinfo);
1155 shost_printk(KERN_ERR, shost,
1156 "%s: alloc streams error %d after reset",
1161 spin_lock_irqsave(shost->host_lock, flags);
1162 scsi_report_bus_reset(shost, 0);
1163 spin_unlock_irqrestore(shost->host_lock, flags);
1168 static void uas_disconnect(struct usb_interface *intf)
1170 struct Scsi_Host *shost = usb_get_intfdata(intf);
1171 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1172 unsigned long flags;
1174 spin_lock_irqsave(&devinfo->lock, flags);
1175 devinfo->resetting = 1;
1176 spin_unlock_irqrestore(&devinfo->lock, flags);
1178 cancel_work_sync(&devinfo->work);
1179 usb_kill_anchored_urbs(&devinfo->cmd_urbs);
1180 usb_kill_anchored_urbs(&devinfo->sense_urbs);
1181 usb_kill_anchored_urbs(&devinfo->data_urbs);
1182 uas_zap_pending(devinfo, DID_NO_CONNECT);
1185 * Prevent SCSI scanning (if it hasn't started yet)
1186 * or wait for the SCSI-scanning routine to stop.
1188 cancel_work_sync(&devinfo->scan_work);
1190 scsi_remove_host(shost);
1191 uas_free_streams(devinfo);
1192 scsi_host_put(shost);
1196 * Put the device back in usb-storage mode on shutdown, as some BIOS-es
1197 * hang on reboot when the device is still in uas mode. Note the reset is
1198 * necessary as some devices won't revert to usb-storage mode without it.
1200 static void uas_shutdown(struct device *dev)
1202 struct usb_interface *intf = to_usb_interface(dev);
1203 struct usb_device *udev = interface_to_usbdev(intf);
1204 struct Scsi_Host *shost = usb_get_intfdata(intf);
1205 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1207 if (system_state != SYSTEM_RESTART)
1210 devinfo->shutdown = 1;
1211 uas_free_streams(devinfo);
1212 usb_set_interface(udev, intf->altsetting[0].desc.bInterfaceNumber, 0);
1213 usb_reset_device(udev);
1216 static struct usb_driver uas_driver = {
1219 .disconnect = uas_disconnect,
1220 .pre_reset = uas_pre_reset,
1221 .post_reset = uas_post_reset,
1222 .suspend = uas_suspend,
1223 .resume = uas_resume,
1224 .reset_resume = uas_reset_resume,
1225 .drvwrap.driver.shutdown = uas_shutdown,
1226 .id_table = uas_usb_ids,
1229 module_usb_driver(uas_driver);
1231 MODULE_LICENSE("GPL");
1232 MODULE_IMPORT_NS(USB_STORAGE);
1234 "Hans de Goede <hdegoede@redhat.com>, Matthew Wilcox and Sarah Sharp");