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,
85 * This driver needs its own workqueue, as we need to control memory allocation.
87 * In the course of error handling and power management uas_wait_for_pending_cmnds()
88 * needs to flush pending work items. In these contexts we cannot allocate memory
89 * by doing block IO as we would deadlock. For the same reason we cannot wait
90 * for anything allocating memory not heeding these constraints.
92 * So we have to control all work items that can be on the workqueue we flush.
93 * Hence we cannot share a queue and need our own.
95 static struct workqueue_struct *workqueue;
97 static void uas_do_work(struct work_struct *work)
99 struct uas_dev_info *devinfo =
100 container_of(work, struct uas_dev_info, work);
101 struct uas_cmd_info *cmdinfo;
102 struct scsi_cmnd *cmnd;
106 spin_lock_irqsave(&devinfo->lock, flags);
108 if (devinfo->resetting)
111 for (i = 0; i < devinfo->qdepth; i++) {
112 if (!devinfo->cmnd[i])
115 cmnd = devinfo->cmnd[i];
116 cmdinfo = scsi_cmd_priv(cmnd);
118 if (!(cmdinfo->state & IS_IN_WORK_LIST))
121 err = uas_submit_urbs(cmnd, cmnd->device->hostdata);
123 cmdinfo->state &= ~IS_IN_WORK_LIST;
125 queue_work(workqueue, &devinfo->work);
128 spin_unlock_irqrestore(&devinfo->lock, flags);
131 static void uas_scan_work(struct work_struct *work)
133 struct uas_dev_info *devinfo =
134 container_of(work, struct uas_dev_info, scan_work);
135 struct Scsi_Host *shost = usb_get_intfdata(devinfo->intf);
137 dev_dbg(&devinfo->intf->dev, "starting scan\n");
138 scsi_scan_host(shost);
139 dev_dbg(&devinfo->intf->dev, "scan complete\n");
142 static void uas_add_work(struct scsi_cmnd *cmnd)
144 struct uas_cmd_info *cmdinfo = scsi_cmd_priv(cmnd);
145 struct uas_dev_info *devinfo = cmnd->device->hostdata;
147 lockdep_assert_held(&devinfo->lock);
148 cmdinfo->state |= IS_IN_WORK_LIST;
149 queue_work(workqueue, &devinfo->work);
152 static void uas_zap_pending(struct uas_dev_info *devinfo, int result)
154 struct uas_cmd_info *cmdinfo;
155 struct scsi_cmnd *cmnd;
159 spin_lock_irqsave(&devinfo->lock, flags);
160 for (i = 0; i < devinfo->qdepth; i++) {
161 if (!devinfo->cmnd[i])
164 cmnd = devinfo->cmnd[i];
165 cmdinfo = scsi_cmd_priv(cmnd);
166 uas_log_cmd_state(cmnd, __func__, 0);
167 /* Sense urbs were killed, clear COMMAND_INFLIGHT manually */
168 cmdinfo->state &= ~COMMAND_INFLIGHT;
169 cmnd->result = result << 16;
170 err = uas_try_complete(cmnd, __func__);
173 spin_unlock_irqrestore(&devinfo->lock, flags);
176 static void uas_sense(struct urb *urb, struct scsi_cmnd *cmnd)
178 struct sense_iu *sense_iu = urb->transfer_buffer;
179 struct scsi_device *sdev = cmnd->device;
181 if (urb->actual_length > 16) {
182 unsigned len = be16_to_cpup(&sense_iu->len);
183 if (len + 16 != urb->actual_length) {
184 int newlen = min(len + 16, urb->actual_length) - 16;
187 sdev_printk(KERN_INFO, sdev, "%s: urb length %d "
188 "disagrees with IU sense data length %d, "
189 "using %d bytes of sense data\n", __func__,
190 urb->actual_length, len, newlen);
193 memcpy(cmnd->sense_buffer, sense_iu->sense, len);
196 cmnd->result = sense_iu->status;
199 static void uas_log_cmd_state(struct scsi_cmnd *cmnd, const char *prefix,
202 struct uas_cmd_info *ci = scsi_cmd_priv(cmnd);
204 if (status == -ENODEV) /* too late */
207 scmd_printk(KERN_INFO, cmnd,
208 "%s %d uas-tag %d inflight:%s%s%s%s%s%s%s%s%s%s%s%s ",
209 prefix, status, ci->uas_tag,
210 (ci->state & SUBMIT_STATUS_URB) ? " s-st" : "",
211 (ci->state & ALLOC_DATA_IN_URB) ? " a-in" : "",
212 (ci->state & SUBMIT_DATA_IN_URB) ? " s-in" : "",
213 (ci->state & ALLOC_DATA_OUT_URB) ? " a-out" : "",
214 (ci->state & SUBMIT_DATA_OUT_URB) ? " s-out" : "",
215 (ci->state & ALLOC_CMD_URB) ? " a-cmd" : "",
216 (ci->state & SUBMIT_CMD_URB) ? " s-cmd" : "",
217 (ci->state & COMMAND_INFLIGHT) ? " CMD" : "",
218 (ci->state & DATA_IN_URB_INFLIGHT) ? " IN" : "",
219 (ci->state & DATA_OUT_URB_INFLIGHT) ? " OUT" : "",
220 (ci->state & COMMAND_ABORTED) ? " abort" : "",
221 (ci->state & IS_IN_WORK_LIST) ? " work" : "");
222 scsi_print_command(cmnd);
225 static void uas_free_unsubmitted_urbs(struct scsi_cmnd *cmnd)
227 struct uas_cmd_info *cmdinfo;
232 cmdinfo = scsi_cmd_priv(cmnd);
234 if (cmdinfo->state & SUBMIT_CMD_URB)
235 usb_free_urb(cmdinfo->cmd_urb);
237 /* data urbs may have never gotten their submit flag set */
238 if (!(cmdinfo->state & DATA_IN_URB_INFLIGHT))
239 usb_free_urb(cmdinfo->data_in_urb);
240 if (!(cmdinfo->state & DATA_OUT_URB_INFLIGHT))
241 usb_free_urb(cmdinfo->data_out_urb);
244 static int uas_try_complete(struct scsi_cmnd *cmnd, const char *caller)
246 struct uas_cmd_info *cmdinfo = scsi_cmd_priv(cmnd);
247 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
249 lockdep_assert_held(&devinfo->lock);
250 if (cmdinfo->state & (COMMAND_INFLIGHT |
251 DATA_IN_URB_INFLIGHT |
252 DATA_OUT_URB_INFLIGHT |
255 devinfo->cmnd[cmdinfo->uas_tag - 1] = NULL;
256 uas_free_unsubmitted_urbs(cmnd);
261 static void uas_xfer_data(struct urb *urb, struct scsi_cmnd *cmnd,
264 struct uas_cmd_info *cmdinfo = scsi_cmd_priv(cmnd);
267 cmdinfo->state |= direction | SUBMIT_STATUS_URB;
268 err = uas_submit_urbs(cmnd, cmnd->device->hostdata);
274 static bool uas_evaluate_response_iu(struct response_iu *riu, struct scsi_cmnd *cmnd)
276 u8 response_code = riu->response_code;
278 switch (response_code) {
279 case RC_INCORRECT_LUN:
280 set_host_byte(cmnd, DID_BAD_TARGET);
282 case RC_TMF_SUCCEEDED:
283 set_host_byte(cmnd, DID_OK);
285 case RC_TMF_NOT_SUPPORTED:
286 set_host_byte(cmnd, DID_BAD_TARGET);
289 uas_log_cmd_state(cmnd, "response iu", response_code);
290 set_host_byte(cmnd, DID_ERROR);
294 return response_code == RC_TMF_SUCCEEDED;
297 static void uas_stat_cmplt(struct urb *urb)
299 struct iu *iu = urb->transfer_buffer;
300 struct Scsi_Host *shost = urb->context;
301 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
302 struct urb *data_in_urb = NULL;
303 struct urb *data_out_urb = NULL;
304 struct scsi_cmnd *cmnd;
305 struct uas_cmd_info *cmdinfo;
308 int status = urb->status;
311 spin_lock_irqsave(&devinfo->lock, flags);
313 if (devinfo->resetting)
317 if (status != -ENOENT && status != -ECONNRESET && status != -ESHUTDOWN)
318 dev_err(&urb->dev->dev, "stat urb: status %d\n", status);
322 idx = be16_to_cpup(&iu->tag) - 1;
323 if (idx >= MAX_CMNDS || !devinfo->cmnd[idx]) {
324 dev_err(&urb->dev->dev,
325 "stat urb: no pending cmd for uas-tag %d\n", idx + 1);
329 cmnd = devinfo->cmnd[idx];
330 cmdinfo = scsi_cmd_priv(cmnd);
332 if (!(cmdinfo->state & COMMAND_INFLIGHT)) {
333 uas_log_cmd_state(cmnd, "unexpected status cmplt", 0);
339 uas_sense(urb, cmnd);
340 if (cmnd->result != 0) {
341 /* cancel data transfers on error */
342 data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
343 data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
345 cmdinfo->state &= ~COMMAND_INFLIGHT;
346 uas_try_complete(cmnd, __func__);
348 case IU_ID_READ_READY:
349 if (!cmdinfo->data_in_urb ||
350 (cmdinfo->state & DATA_IN_URB_INFLIGHT)) {
351 uas_log_cmd_state(cmnd, "unexpected read rdy", 0);
354 uas_xfer_data(urb, cmnd, SUBMIT_DATA_IN_URB);
356 case IU_ID_WRITE_READY:
357 if (!cmdinfo->data_out_urb ||
358 (cmdinfo->state & DATA_OUT_URB_INFLIGHT)) {
359 uas_log_cmd_state(cmnd, "unexpected write rdy", 0);
362 uas_xfer_data(urb, cmnd, SUBMIT_DATA_OUT_URB);
365 cmdinfo->state &= ~COMMAND_INFLIGHT;
366 success = uas_evaluate_response_iu((struct response_iu *)iu, cmnd);
368 /* Error, cancel data transfers */
369 data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
370 data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
372 uas_try_complete(cmnd, __func__);
375 uas_log_cmd_state(cmnd, "bogus IU", iu->iu_id);
379 spin_unlock_irqrestore(&devinfo->lock, flags);
381 /* Unlinking of data urbs must be done without holding the lock */
383 usb_unlink_urb(data_in_urb);
384 usb_put_urb(data_in_urb);
387 usb_unlink_urb(data_out_urb);
388 usb_put_urb(data_out_urb);
392 static void uas_data_cmplt(struct urb *urb)
394 struct scsi_cmnd *cmnd = urb->context;
395 struct uas_cmd_info *cmdinfo = scsi_cmd_priv(cmnd);
396 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
397 struct scsi_data_buffer *sdb = &cmnd->sdb;
399 int status = urb->status;
401 spin_lock_irqsave(&devinfo->lock, flags);
403 if (cmdinfo->data_in_urb == urb) {
404 cmdinfo->state &= ~DATA_IN_URB_INFLIGHT;
405 cmdinfo->data_in_urb = NULL;
406 } else if (cmdinfo->data_out_urb == urb) {
407 cmdinfo->state &= ~DATA_OUT_URB_INFLIGHT;
408 cmdinfo->data_out_urb = NULL;
411 if (devinfo->resetting)
414 /* Data urbs should not complete before the cmd urb is submitted */
415 if (cmdinfo->state & SUBMIT_CMD_URB) {
416 uas_log_cmd_state(cmnd, "unexpected data cmplt", 0);
421 if (status != -ENOENT && status != -ECONNRESET && status != -ESHUTDOWN)
422 uas_log_cmd_state(cmnd, "data cmplt err", status);
423 /* error: no data transfered */
424 scsi_set_resid(cmnd, sdb->length);
426 scsi_set_resid(cmnd, sdb->length - urb->actual_length);
428 uas_try_complete(cmnd, __func__);
431 spin_unlock_irqrestore(&devinfo->lock, flags);
434 static void uas_cmd_cmplt(struct urb *urb)
437 dev_err(&urb->dev->dev, "cmd cmplt err %d\n", urb->status);
442 static struct urb *uas_alloc_data_urb(struct uas_dev_info *devinfo, gfp_t gfp,
443 struct scsi_cmnd *cmnd,
444 enum dma_data_direction dir)
446 struct usb_device *udev = devinfo->udev;
447 struct uas_cmd_info *cmdinfo = scsi_cmd_priv(cmnd);
448 struct urb *urb = usb_alloc_urb(0, gfp);
449 struct scsi_data_buffer *sdb = &cmnd->sdb;
450 unsigned int pipe = (dir == DMA_FROM_DEVICE)
451 ? devinfo->data_in_pipe : devinfo->data_out_pipe;
455 usb_fill_bulk_urb(urb, udev, pipe, NULL, sdb->length,
456 uas_data_cmplt, cmnd);
457 if (devinfo->use_streams)
458 urb->stream_id = cmdinfo->uas_tag;
459 urb->num_sgs = udev->bus->sg_tablesize ? sdb->table.nents : 0;
460 urb->sg = sdb->table.sgl;
465 static struct urb *uas_alloc_sense_urb(struct uas_dev_info *devinfo, gfp_t gfp,
466 struct scsi_cmnd *cmnd)
468 struct usb_device *udev = devinfo->udev;
469 struct uas_cmd_info *cmdinfo = scsi_cmd_priv(cmnd);
470 struct urb *urb = usb_alloc_urb(0, gfp);
476 iu = kzalloc(sizeof(*iu), gfp);
480 usb_fill_bulk_urb(urb, udev, devinfo->status_pipe, iu, sizeof(*iu),
481 uas_stat_cmplt, cmnd->device->host);
482 if (devinfo->use_streams)
483 urb->stream_id = cmdinfo->uas_tag;
484 urb->transfer_flags |= URB_FREE_BUFFER;
492 static struct urb *uas_alloc_cmd_urb(struct uas_dev_info *devinfo, gfp_t gfp,
493 struct scsi_cmnd *cmnd)
495 struct usb_device *udev = devinfo->udev;
496 struct scsi_device *sdev = cmnd->device;
497 struct uas_cmd_info *cmdinfo = scsi_cmd_priv(cmnd);
498 struct urb *urb = usb_alloc_urb(0, gfp);
499 struct command_iu *iu;
505 len = cmnd->cmd_len - 16;
509 iu = kzalloc(sizeof(*iu) + len, gfp);
513 iu->iu_id = IU_ID_COMMAND;
514 iu->tag = cpu_to_be16(cmdinfo->uas_tag);
515 iu->prio_attr = UAS_SIMPLE_TAG;
517 int_to_scsilun(sdev->lun, &iu->lun);
518 memcpy(iu->cdb, cmnd->cmnd, cmnd->cmd_len);
520 usb_fill_bulk_urb(urb, udev, devinfo->cmd_pipe, iu, sizeof(*iu) + len,
521 uas_cmd_cmplt, NULL);
522 urb->transfer_flags |= URB_FREE_BUFFER;
531 * Why should I request the Status IU before sending the Command IU? Spec
532 * says to, but also says the device may receive them in any order. Seems
536 static struct urb *uas_submit_sense_urb(struct scsi_cmnd *cmnd, gfp_t gfp)
538 struct uas_dev_info *devinfo = cmnd->device->hostdata;
542 urb = uas_alloc_sense_urb(devinfo, gfp, cmnd);
545 usb_anchor_urb(urb, &devinfo->sense_urbs);
546 err = usb_submit_urb(urb, gfp);
548 usb_unanchor_urb(urb);
549 uas_log_cmd_state(cmnd, "sense submit err", err);
556 static int uas_submit_urbs(struct scsi_cmnd *cmnd,
557 struct uas_dev_info *devinfo)
559 struct uas_cmd_info *cmdinfo = scsi_cmd_priv(cmnd);
563 lockdep_assert_held(&devinfo->lock);
564 if (cmdinfo->state & SUBMIT_STATUS_URB) {
565 urb = uas_submit_sense_urb(cmnd, GFP_ATOMIC);
567 return SCSI_MLQUEUE_DEVICE_BUSY;
568 cmdinfo->state &= ~SUBMIT_STATUS_URB;
571 if (cmdinfo->state & ALLOC_DATA_IN_URB) {
572 cmdinfo->data_in_urb = uas_alloc_data_urb(devinfo, GFP_ATOMIC,
573 cmnd, DMA_FROM_DEVICE);
574 if (!cmdinfo->data_in_urb)
575 return SCSI_MLQUEUE_DEVICE_BUSY;
576 cmdinfo->state &= ~ALLOC_DATA_IN_URB;
579 if (cmdinfo->state & SUBMIT_DATA_IN_URB) {
580 usb_anchor_urb(cmdinfo->data_in_urb, &devinfo->data_urbs);
581 err = usb_submit_urb(cmdinfo->data_in_urb, GFP_ATOMIC);
583 usb_unanchor_urb(cmdinfo->data_in_urb);
584 uas_log_cmd_state(cmnd, "data in submit err", err);
585 return SCSI_MLQUEUE_DEVICE_BUSY;
587 cmdinfo->state &= ~SUBMIT_DATA_IN_URB;
588 cmdinfo->state |= DATA_IN_URB_INFLIGHT;
591 if (cmdinfo->state & ALLOC_DATA_OUT_URB) {
592 cmdinfo->data_out_urb = uas_alloc_data_urb(devinfo, GFP_ATOMIC,
593 cmnd, DMA_TO_DEVICE);
594 if (!cmdinfo->data_out_urb)
595 return SCSI_MLQUEUE_DEVICE_BUSY;
596 cmdinfo->state &= ~ALLOC_DATA_OUT_URB;
599 if (cmdinfo->state & SUBMIT_DATA_OUT_URB) {
600 usb_anchor_urb(cmdinfo->data_out_urb, &devinfo->data_urbs);
601 err = usb_submit_urb(cmdinfo->data_out_urb, GFP_ATOMIC);
603 usb_unanchor_urb(cmdinfo->data_out_urb);
604 uas_log_cmd_state(cmnd, "data out submit err", err);
605 return SCSI_MLQUEUE_DEVICE_BUSY;
607 cmdinfo->state &= ~SUBMIT_DATA_OUT_URB;
608 cmdinfo->state |= DATA_OUT_URB_INFLIGHT;
611 if (cmdinfo->state & ALLOC_CMD_URB) {
612 cmdinfo->cmd_urb = uas_alloc_cmd_urb(devinfo, GFP_ATOMIC, cmnd);
613 if (!cmdinfo->cmd_urb)
614 return SCSI_MLQUEUE_DEVICE_BUSY;
615 cmdinfo->state &= ~ALLOC_CMD_URB;
618 if (cmdinfo->state & SUBMIT_CMD_URB) {
619 usb_anchor_urb(cmdinfo->cmd_urb, &devinfo->cmd_urbs);
620 err = usb_submit_urb(cmdinfo->cmd_urb, GFP_ATOMIC);
622 usb_unanchor_urb(cmdinfo->cmd_urb);
623 uas_log_cmd_state(cmnd, "cmd submit err", err);
624 return SCSI_MLQUEUE_DEVICE_BUSY;
626 cmdinfo->cmd_urb = NULL;
627 cmdinfo->state &= ~SUBMIT_CMD_URB;
628 cmdinfo->state |= COMMAND_INFLIGHT;
634 static int uas_queuecommand_lck(struct scsi_cmnd *cmnd)
636 struct scsi_device *sdev = cmnd->device;
637 struct uas_dev_info *devinfo = sdev->hostdata;
638 struct uas_cmd_info *cmdinfo = scsi_cmd_priv(cmnd);
642 /* Re-check scsi_block_requests now that we've the host-lock */
643 if (cmnd->device->host->host_self_blocked)
644 return SCSI_MLQUEUE_DEVICE_BUSY;
646 if ((devinfo->flags & US_FL_NO_ATA_1X) &&
647 (cmnd->cmnd[0] == ATA_12 || cmnd->cmnd[0] == ATA_16)) {
648 memcpy(cmnd->sense_buffer, usb_stor_sense_invalidCDB,
649 sizeof(usb_stor_sense_invalidCDB));
650 cmnd->result = SAM_STAT_CHECK_CONDITION;
655 spin_lock_irqsave(&devinfo->lock, flags);
657 if (devinfo->resetting) {
658 set_host_byte(cmnd, DID_ERROR);
663 /* Find a free uas-tag */
664 for (idx = 0; idx < devinfo->qdepth; idx++) {
665 if (!devinfo->cmnd[idx])
668 if (idx == devinfo->qdepth) {
669 spin_unlock_irqrestore(&devinfo->lock, flags);
670 return SCSI_MLQUEUE_DEVICE_BUSY;
673 memset(cmdinfo, 0, sizeof(*cmdinfo));
674 cmdinfo->uas_tag = idx + 1; /* uas-tag == usb-stream-id, so 1 based */
675 cmdinfo->state = SUBMIT_STATUS_URB | ALLOC_CMD_URB | SUBMIT_CMD_URB;
677 switch (cmnd->sc_data_direction) {
678 case DMA_FROM_DEVICE:
679 cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
681 case DMA_BIDIRECTIONAL:
682 cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
685 cmdinfo->state |= ALLOC_DATA_OUT_URB | SUBMIT_DATA_OUT_URB;
691 if (!devinfo->use_streams)
692 cmdinfo->state &= ~(SUBMIT_DATA_IN_URB | SUBMIT_DATA_OUT_URB);
694 err = uas_submit_urbs(cmnd, devinfo);
696 * in case of fatal errors the SCSI layer is peculiar
697 * a command that has finished is a success for the purpose
698 * of queueing, no matter how fatal the error
700 if (err == -ENODEV) {
701 set_host_byte(cmnd, DID_ERROR);
706 /* If we did nothing, give up now */
707 if (cmdinfo->state & SUBMIT_STATUS_URB) {
708 spin_unlock_irqrestore(&devinfo->lock, flags);
709 return SCSI_MLQUEUE_DEVICE_BUSY;
714 devinfo->cmnd[idx] = cmnd;
716 spin_unlock_irqrestore(&devinfo->lock, flags);
720 static DEF_SCSI_QCMD(uas_queuecommand)
723 * For now we do not support actually sending an abort to the device, so
724 * this eh always fails. Still we must define it to make sure that we've
725 * dropped all references to the cmnd in question once this function exits.
727 static int uas_eh_abort_handler(struct scsi_cmnd *cmnd)
729 struct uas_cmd_info *cmdinfo = scsi_cmd_priv(cmnd);
730 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
731 struct urb *data_in_urb = NULL;
732 struct urb *data_out_urb = NULL;
735 spin_lock_irqsave(&devinfo->lock, flags);
737 uas_log_cmd_state(cmnd, __func__, 0);
739 /* Ensure that try_complete does not call scsi_done */
740 cmdinfo->state |= COMMAND_ABORTED;
742 /* Drop all refs to this cmnd, kill data urbs to break their ref */
743 devinfo->cmnd[cmdinfo->uas_tag - 1] = NULL;
744 if (cmdinfo->state & DATA_IN_URB_INFLIGHT)
745 data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
746 if (cmdinfo->state & DATA_OUT_URB_INFLIGHT)
747 data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
749 uas_free_unsubmitted_urbs(cmnd);
751 spin_unlock_irqrestore(&devinfo->lock, flags);
754 usb_kill_urb(data_in_urb);
755 usb_put_urb(data_in_urb);
758 usb_kill_urb(data_out_urb);
759 usb_put_urb(data_out_urb);
765 static int uas_eh_device_reset_handler(struct scsi_cmnd *cmnd)
767 struct scsi_device *sdev = cmnd->device;
768 struct uas_dev_info *devinfo = sdev->hostdata;
769 struct usb_device *udev = devinfo->udev;
773 err = usb_lock_device_for_reset(udev, devinfo->intf);
775 shost_printk(KERN_ERR, sdev->host,
776 "%s FAILED to get lock err %d\n", __func__, err);
780 shost_printk(KERN_INFO, sdev->host, "%s start\n", __func__);
782 spin_lock_irqsave(&devinfo->lock, flags);
783 devinfo->resetting = 1;
784 spin_unlock_irqrestore(&devinfo->lock, flags);
786 usb_kill_anchored_urbs(&devinfo->cmd_urbs);
787 usb_kill_anchored_urbs(&devinfo->sense_urbs);
788 usb_kill_anchored_urbs(&devinfo->data_urbs);
789 uas_zap_pending(devinfo, DID_RESET);
791 err = usb_reset_device(udev);
793 spin_lock_irqsave(&devinfo->lock, flags);
794 devinfo->resetting = 0;
795 spin_unlock_irqrestore(&devinfo->lock, flags);
797 usb_unlock_device(udev);
800 shost_printk(KERN_INFO, sdev->host, "%s FAILED err %d\n",
805 shost_printk(KERN_INFO, sdev->host, "%s success\n", __func__);
809 static int uas_target_alloc(struct scsi_target *starget)
811 struct uas_dev_info *devinfo = (struct uas_dev_info *)
812 dev_to_shost(starget->dev.parent)->hostdata;
814 if (devinfo->flags & US_FL_NO_REPORT_LUNS)
815 starget->no_report_luns = 1;
820 static int uas_slave_alloc(struct scsi_device *sdev)
822 struct uas_dev_info *devinfo =
823 (struct uas_dev_info *)sdev->host->hostdata;
825 sdev->hostdata = devinfo;
828 * The protocol has no requirements on alignment in the strict sense.
829 * Controllers may or may not have alignment restrictions.
830 * As this is not exported, we use an extremely conservative guess.
832 blk_queue_update_dma_alignment(sdev->request_queue, (512 - 1));
834 if (devinfo->flags & US_FL_MAX_SECTORS_64)
835 blk_queue_max_hw_sectors(sdev->request_queue, 64);
836 else if (devinfo->flags & US_FL_MAX_SECTORS_240)
837 blk_queue_max_hw_sectors(sdev->request_queue, 240);
842 static int uas_slave_configure(struct scsi_device *sdev)
844 struct uas_dev_info *devinfo = sdev->hostdata;
846 if (devinfo->flags & US_FL_NO_REPORT_OPCODES)
847 sdev->no_report_opcodes = 1;
849 /* A few buggy USB-ATA bridges don't understand FUA */
850 if (devinfo->flags & US_FL_BROKEN_FUA)
851 sdev->broken_fua = 1;
853 /* UAS also needs to support FL_ALWAYS_SYNC */
854 if (devinfo->flags & US_FL_ALWAYS_SYNC) {
855 sdev->skip_ms_page_3f = 1;
856 sdev->skip_ms_page_8 = 1;
857 sdev->wce_default_on = 1;
860 /* Some disks cannot handle READ_CAPACITY_16 */
861 if (devinfo->flags & US_FL_NO_READ_CAPACITY_16)
862 sdev->no_read_capacity_16 = 1;
864 /* Some disks cannot handle WRITE_SAME */
865 if (devinfo->flags & US_FL_NO_SAME)
866 sdev->no_write_same = 1;
868 * Some disks return the total number of blocks in response
869 * to READ CAPACITY rather than the highest block number.
870 * If this device makes that mistake, tell the sd driver.
872 if (devinfo->flags & US_FL_FIX_CAPACITY)
873 sdev->fix_capacity = 1;
876 * in some cases we have to guess
878 if (devinfo->flags & US_FL_CAPACITY_HEURISTICS)
879 sdev->guess_capacity = 1;
882 * Some devices report generic values until the media has been
883 * accessed. Force a READ(10) prior to querying device
886 sdev->read_before_ms = 1;
889 * Some devices don't like MODE SENSE with page=0x3f,
890 * which is the command used for checking if a device
891 * is write-protected. Now that we tell the sd driver
892 * to do a 192-byte transfer with this command the
893 * majority of devices work fine, but a few still can't
894 * handle it. The sd driver will simply assume those
895 * devices are write-enabled.
897 if (devinfo->flags & US_FL_NO_WP_DETECT)
898 sdev->skip_ms_page_3f = 1;
900 scsi_change_queue_depth(sdev, devinfo->qdepth - 2);
904 static const struct scsi_host_template uas_host_template = {
905 .module = THIS_MODULE,
907 .queuecommand = uas_queuecommand,
908 .target_alloc = uas_target_alloc,
909 .slave_alloc = uas_slave_alloc,
910 .slave_configure = uas_slave_configure,
911 .eh_abort_handler = uas_eh_abort_handler,
912 .eh_device_reset_handler = uas_eh_device_reset_handler,
914 .skip_settle_delay = 1,
915 .dma_boundary = PAGE_SIZE - 1,
916 .cmd_size = sizeof(struct uas_cmd_info),
919 #define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \
920 vendorName, productName, useProtocol, useTransport, \
921 initFunction, flags) \
922 { USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax), \
923 .driver_info = (flags) }
925 static struct usb_device_id uas_usb_ids[] = {
926 # include "unusual_uas.h"
927 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_BULK) },
928 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_UAS) },
931 MODULE_DEVICE_TABLE(usb, uas_usb_ids);
935 static int uas_switch_interface(struct usb_device *udev,
936 struct usb_interface *intf)
938 struct usb_host_interface *alt;
940 alt = uas_find_uas_alt_setting(intf);
944 return usb_set_interface(udev, alt->desc.bInterfaceNumber,
945 alt->desc.bAlternateSetting);
948 static int uas_configure_endpoints(struct uas_dev_info *devinfo)
950 struct usb_host_endpoint *eps[4] = { };
951 struct usb_device *udev = devinfo->udev;
954 r = uas_find_endpoints(devinfo->intf->cur_altsetting, eps);
958 devinfo->cmd_pipe = usb_sndbulkpipe(udev,
959 usb_endpoint_num(&eps[0]->desc));
960 devinfo->status_pipe = usb_rcvbulkpipe(udev,
961 usb_endpoint_num(&eps[1]->desc));
962 devinfo->data_in_pipe = usb_rcvbulkpipe(udev,
963 usb_endpoint_num(&eps[2]->desc));
964 devinfo->data_out_pipe = usb_sndbulkpipe(udev,
965 usb_endpoint_num(&eps[3]->desc));
967 if (udev->speed < USB_SPEED_SUPER) {
968 devinfo->qdepth = 32;
969 devinfo->use_streams = 0;
971 devinfo->qdepth = usb_alloc_streams(devinfo->intf, eps + 1,
972 3, MAX_CMNDS, GFP_NOIO);
973 if (devinfo->qdepth < 0)
974 return devinfo->qdepth;
975 devinfo->use_streams = 1;
981 static void uas_free_streams(struct uas_dev_info *devinfo)
983 struct usb_device *udev = devinfo->udev;
984 struct usb_host_endpoint *eps[3];
986 eps[0] = usb_pipe_endpoint(udev, devinfo->status_pipe);
987 eps[1] = usb_pipe_endpoint(udev, devinfo->data_in_pipe);
988 eps[2] = usb_pipe_endpoint(udev, devinfo->data_out_pipe);
989 usb_free_streams(devinfo->intf, eps, 3, GFP_NOIO);
992 static int uas_probe(struct usb_interface *intf, const struct usb_device_id *id)
994 int result = -ENOMEM;
995 struct Scsi_Host *shost = NULL;
996 struct uas_dev_info *devinfo;
997 struct usb_device *udev = interface_to_usbdev(intf);
1000 if (!uas_use_uas_driver(intf, id, &dev_flags))
1003 if (uas_switch_interface(udev, intf))
1006 shost = scsi_host_alloc(&uas_host_template,
1007 sizeof(struct uas_dev_info));
1011 shost->max_cmd_len = 16 + 252;
1013 shost->max_lun = 256;
1014 shost->max_channel = 0;
1015 shost->sg_tablesize = udev->bus->sg_tablesize;
1017 devinfo = (struct uas_dev_info *)shost->hostdata;
1018 devinfo->intf = intf;
1019 devinfo->udev = udev;
1020 devinfo->resetting = 0;
1021 devinfo->shutdown = 0;
1022 devinfo->flags = dev_flags;
1023 init_usb_anchor(&devinfo->cmd_urbs);
1024 init_usb_anchor(&devinfo->sense_urbs);
1025 init_usb_anchor(&devinfo->data_urbs);
1026 spin_lock_init(&devinfo->lock);
1027 INIT_WORK(&devinfo->work, uas_do_work);
1028 INIT_WORK(&devinfo->scan_work, uas_scan_work);
1030 result = uas_configure_endpoints(devinfo);
1035 * 1 tag is reserved for untagged commands +
1036 * 1 tag to avoid off by one errors in some bridge firmwares
1038 shost->can_queue = devinfo->qdepth - 2;
1040 usb_set_intfdata(intf, shost);
1041 result = scsi_add_host(shost, &intf->dev);
1045 /* Submit the delayed_work for SCSI-device scanning */
1046 schedule_work(&devinfo->scan_work);
1051 uas_free_streams(devinfo);
1052 usb_set_intfdata(intf, NULL);
1054 usb_set_interface(udev, intf->altsetting[0].desc.bInterfaceNumber, 0);
1056 scsi_host_put(shost);
1060 static int uas_cmnd_list_empty(struct uas_dev_info *devinfo)
1062 unsigned long flags;
1065 spin_lock_irqsave(&devinfo->lock, flags);
1067 for (i = 0; i < devinfo->qdepth; i++) {
1068 if (devinfo->cmnd[i]) {
1069 r = 0; /* Not empty */
1074 spin_unlock_irqrestore(&devinfo->lock, flags);
1080 * Wait for any pending cmnds to complete, on usb-2 sense_urbs may temporarily
1081 * get empty while there still is more work to do due to sense-urbs completing
1082 * with a READ/WRITE_READY iu code, so keep waiting until the list gets empty.
1084 static int uas_wait_for_pending_cmnds(struct uas_dev_info *devinfo)
1086 unsigned long start_time;
1089 start_time = jiffies;
1091 flush_work(&devinfo->work);
1093 r = usb_wait_anchor_empty_timeout(&devinfo->sense_urbs, 5000);
1097 r = usb_wait_anchor_empty_timeout(&devinfo->data_urbs, 500);
1101 if (time_after(jiffies, start_time + 5 * HZ))
1103 } while (!uas_cmnd_list_empty(devinfo));
1108 static int uas_pre_reset(struct usb_interface *intf)
1110 struct Scsi_Host *shost = usb_get_intfdata(intf);
1111 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1112 unsigned long flags;
1114 if (devinfo->shutdown)
1117 /* Block new requests */
1118 spin_lock_irqsave(shost->host_lock, flags);
1119 scsi_block_requests(shost);
1120 spin_unlock_irqrestore(shost->host_lock, flags);
1122 if (uas_wait_for_pending_cmnds(devinfo) != 0) {
1123 shost_printk(KERN_ERR, shost, "%s: timed out\n", __func__);
1124 scsi_unblock_requests(shost);
1128 uas_free_streams(devinfo);
1133 static int uas_post_reset(struct usb_interface *intf)
1135 struct Scsi_Host *shost = usb_get_intfdata(intf);
1136 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1137 unsigned long flags;
1140 if (devinfo->shutdown)
1143 err = uas_configure_endpoints(devinfo);
1144 if (err && err != -ENODEV)
1145 shost_printk(KERN_ERR, shost,
1146 "%s: alloc streams error %d after reset",
1149 /* we must unblock the host in every case lest we deadlock */
1150 spin_lock_irqsave(shost->host_lock, flags);
1151 scsi_report_bus_reset(shost, 0);
1152 spin_unlock_irqrestore(shost->host_lock, flags);
1154 scsi_unblock_requests(shost);
1159 static int uas_suspend(struct usb_interface *intf, pm_message_t message)
1161 struct Scsi_Host *shost = usb_get_intfdata(intf);
1162 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1164 if (uas_wait_for_pending_cmnds(devinfo) != 0) {
1165 shost_printk(KERN_ERR, shost, "%s: timed out\n", __func__);
1172 static int uas_resume(struct usb_interface *intf)
1177 static int uas_reset_resume(struct usb_interface *intf)
1179 struct Scsi_Host *shost = usb_get_intfdata(intf);
1180 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1181 unsigned long flags;
1184 err = uas_configure_endpoints(devinfo);
1186 shost_printk(KERN_ERR, shost,
1187 "%s: alloc streams error %d after reset",
1192 spin_lock_irqsave(shost->host_lock, flags);
1193 scsi_report_bus_reset(shost, 0);
1194 spin_unlock_irqrestore(shost->host_lock, flags);
1199 static void uas_disconnect(struct usb_interface *intf)
1201 struct Scsi_Host *shost = usb_get_intfdata(intf);
1202 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1203 unsigned long flags;
1205 spin_lock_irqsave(&devinfo->lock, flags);
1206 devinfo->resetting = 1;
1207 spin_unlock_irqrestore(&devinfo->lock, flags);
1209 cancel_work_sync(&devinfo->work);
1210 usb_kill_anchored_urbs(&devinfo->cmd_urbs);
1211 usb_kill_anchored_urbs(&devinfo->sense_urbs);
1212 usb_kill_anchored_urbs(&devinfo->data_urbs);
1213 uas_zap_pending(devinfo, DID_NO_CONNECT);
1216 * Prevent SCSI scanning (if it hasn't started yet)
1217 * or wait for the SCSI-scanning routine to stop.
1219 cancel_work_sync(&devinfo->scan_work);
1221 scsi_remove_host(shost);
1222 uas_free_streams(devinfo);
1223 scsi_host_put(shost);
1227 * Put the device back in usb-storage mode on shutdown, as some BIOS-es
1228 * hang on reboot when the device is still in uas mode. Note the reset is
1229 * necessary as some devices won't revert to usb-storage mode without it.
1231 static void uas_shutdown(struct device *dev)
1233 struct usb_interface *intf = to_usb_interface(dev);
1234 struct usb_device *udev = interface_to_usbdev(intf);
1235 struct Scsi_Host *shost = usb_get_intfdata(intf);
1236 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1238 if (system_state != SYSTEM_RESTART)
1241 devinfo->shutdown = 1;
1242 uas_free_streams(devinfo);
1243 usb_set_interface(udev, intf->altsetting[0].desc.bInterfaceNumber, 0);
1244 usb_reset_device(udev);
1247 static struct usb_driver uas_driver = {
1250 .disconnect = uas_disconnect,
1251 .pre_reset = uas_pre_reset,
1252 .post_reset = uas_post_reset,
1253 .suspend = uas_suspend,
1254 .resume = uas_resume,
1255 .reset_resume = uas_reset_resume,
1256 .drvwrap.driver.shutdown = uas_shutdown,
1257 .id_table = uas_usb_ids,
1260 static int __init uas_init(void)
1264 workqueue = alloc_workqueue("uas", WQ_MEM_RECLAIM, 0);
1268 rv = usb_register(&uas_driver);
1270 destroy_workqueue(workqueue);
1277 static void __exit uas_exit(void)
1279 usb_deregister(&uas_driver);
1280 destroy_workqueue(workqueue);
1283 module_init(uas_init);
1284 module_exit(uas_exit);
1286 MODULE_LICENSE("GPL");
1287 MODULE_IMPORT_NS(USB_STORAGE);
1289 "Hans de Goede <hdegoede@redhat.com>, Matthew Wilcox and Sarah Sharp");