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 = (void *)&cmnd->SCp;
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 uas_cmd_info *cmdinfo)
144 struct scsi_pointer *scp = (void *)cmdinfo;
145 struct scsi_cmnd *cmnd = container_of(scp, struct scsi_cmnd, SCp);
146 struct uas_dev_info *devinfo = cmnd->device->hostdata;
148 lockdep_assert_held(&devinfo->lock);
149 cmdinfo->state |= IS_IN_WORK_LIST;
150 queue_work(workqueue, &devinfo->work);
153 static void uas_zap_pending(struct uas_dev_info *devinfo, int result)
155 struct uas_cmd_info *cmdinfo;
156 struct scsi_cmnd *cmnd;
160 spin_lock_irqsave(&devinfo->lock, flags);
161 for (i = 0; i < devinfo->qdepth; i++) {
162 if (!devinfo->cmnd[i])
165 cmnd = devinfo->cmnd[i];
166 cmdinfo = (void *)&cmnd->SCp;
167 uas_log_cmd_state(cmnd, __func__, 0);
168 /* Sense urbs were killed, clear COMMAND_INFLIGHT manually */
169 cmdinfo->state &= ~COMMAND_INFLIGHT;
170 cmnd->result = result << 16;
171 err = uas_try_complete(cmnd, __func__);
174 spin_unlock_irqrestore(&devinfo->lock, flags);
177 static void uas_sense(struct urb *urb, struct scsi_cmnd *cmnd)
179 struct sense_iu *sense_iu = urb->transfer_buffer;
180 struct scsi_device *sdev = cmnd->device;
182 if (urb->actual_length > 16) {
183 unsigned len = be16_to_cpup(&sense_iu->len);
184 if (len + 16 != urb->actual_length) {
185 int newlen = min(len + 16, urb->actual_length) - 16;
188 sdev_printk(KERN_INFO, sdev, "%s: urb length %d "
189 "disagrees with IU sense data length %d, "
190 "using %d bytes of sense data\n", __func__,
191 urb->actual_length, len, newlen);
194 memcpy(cmnd->sense_buffer, sense_iu->sense, len);
197 cmnd->result = sense_iu->status;
200 static void uas_log_cmd_state(struct scsi_cmnd *cmnd, const char *prefix,
203 struct uas_cmd_info *ci = (void *)&cmnd->SCp;
204 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
206 if (status == -ENODEV) /* too late */
209 scmd_printk(KERN_INFO, cmnd,
210 "%s %d uas-tag %d inflight:%s%s%s%s%s%s%s%s%s%s%s%s ",
211 prefix, status, cmdinfo->uas_tag,
212 (ci->state & SUBMIT_STATUS_URB) ? " s-st" : "",
213 (ci->state & ALLOC_DATA_IN_URB) ? " a-in" : "",
214 (ci->state & SUBMIT_DATA_IN_URB) ? " s-in" : "",
215 (ci->state & ALLOC_DATA_OUT_URB) ? " a-out" : "",
216 (ci->state & SUBMIT_DATA_OUT_URB) ? " s-out" : "",
217 (ci->state & ALLOC_CMD_URB) ? " a-cmd" : "",
218 (ci->state & SUBMIT_CMD_URB) ? " s-cmd" : "",
219 (ci->state & COMMAND_INFLIGHT) ? " CMD" : "",
220 (ci->state & DATA_IN_URB_INFLIGHT) ? " IN" : "",
221 (ci->state & DATA_OUT_URB_INFLIGHT) ? " OUT" : "",
222 (ci->state & COMMAND_ABORTED) ? " abort" : "",
223 (ci->state & IS_IN_WORK_LIST) ? " work" : "");
224 scsi_print_command(cmnd);
227 static void uas_free_unsubmitted_urbs(struct scsi_cmnd *cmnd)
229 struct uas_cmd_info *cmdinfo;
234 cmdinfo = (void *)&cmnd->SCp;
236 if (cmdinfo->state & SUBMIT_CMD_URB)
237 usb_free_urb(cmdinfo->cmd_urb);
239 /* data urbs may have never gotten their submit flag set */
240 if (!(cmdinfo->state & DATA_IN_URB_INFLIGHT))
241 usb_free_urb(cmdinfo->data_in_urb);
242 if (!(cmdinfo->state & DATA_OUT_URB_INFLIGHT))
243 usb_free_urb(cmdinfo->data_out_urb);
246 static int uas_try_complete(struct scsi_cmnd *cmnd, const char *caller)
248 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
249 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
251 lockdep_assert_held(&devinfo->lock);
252 if (cmdinfo->state & (COMMAND_INFLIGHT |
253 DATA_IN_URB_INFLIGHT |
254 DATA_OUT_URB_INFLIGHT |
257 devinfo->cmnd[cmdinfo->uas_tag - 1] = NULL;
258 uas_free_unsubmitted_urbs(cmnd);
259 cmnd->scsi_done(cmnd);
263 static void uas_xfer_data(struct urb *urb, struct scsi_cmnd *cmnd,
266 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
269 cmdinfo->state |= direction | SUBMIT_STATUS_URB;
270 err = uas_submit_urbs(cmnd, cmnd->device->hostdata);
272 uas_add_work(cmdinfo);
276 static bool uas_evaluate_response_iu(struct response_iu *riu, struct scsi_cmnd *cmnd)
278 u8 response_code = riu->response_code;
280 switch (response_code) {
281 case RC_INCORRECT_LUN:
282 set_host_byte(cmnd, DID_BAD_TARGET);
284 case RC_TMF_SUCCEEDED:
285 set_host_byte(cmnd, DID_OK);
287 case RC_TMF_NOT_SUPPORTED:
288 set_host_byte(cmnd, DID_TARGET_FAILURE);
291 uas_log_cmd_state(cmnd, "response iu", response_code);
292 set_host_byte(cmnd, DID_ERROR);
296 return response_code == RC_TMF_SUCCEEDED;
299 static void uas_stat_cmplt(struct urb *urb)
301 struct iu *iu = urb->transfer_buffer;
302 struct Scsi_Host *shost = urb->context;
303 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
304 struct urb *data_in_urb = NULL;
305 struct urb *data_out_urb = NULL;
306 struct scsi_cmnd *cmnd;
307 struct uas_cmd_info *cmdinfo;
310 int status = urb->status;
313 spin_lock_irqsave(&devinfo->lock, flags);
315 if (devinfo->resetting)
319 if (status != -ENOENT && status != -ECONNRESET && status != -ESHUTDOWN)
320 dev_err(&urb->dev->dev, "stat urb: status %d\n", status);
324 idx = be16_to_cpup(&iu->tag) - 1;
325 if (idx >= MAX_CMNDS || !devinfo->cmnd[idx]) {
326 dev_err(&urb->dev->dev,
327 "stat urb: no pending cmd for uas-tag %d\n", idx + 1);
331 cmnd = devinfo->cmnd[idx];
332 cmdinfo = (void *)&cmnd->SCp;
334 if (!(cmdinfo->state & COMMAND_INFLIGHT)) {
335 uas_log_cmd_state(cmnd, "unexpected status cmplt", 0);
341 uas_sense(urb, cmnd);
342 if (cmnd->result != 0) {
343 /* cancel data transfers on error */
344 data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
345 data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
347 cmdinfo->state &= ~COMMAND_INFLIGHT;
348 uas_try_complete(cmnd, __func__);
350 case IU_ID_READ_READY:
351 if (!cmdinfo->data_in_urb ||
352 (cmdinfo->state & DATA_IN_URB_INFLIGHT)) {
353 uas_log_cmd_state(cmnd, "unexpected read rdy", 0);
356 uas_xfer_data(urb, cmnd, SUBMIT_DATA_IN_URB);
358 case IU_ID_WRITE_READY:
359 if (!cmdinfo->data_out_urb ||
360 (cmdinfo->state & DATA_OUT_URB_INFLIGHT)) {
361 uas_log_cmd_state(cmnd, "unexpected write rdy", 0);
364 uas_xfer_data(urb, cmnd, SUBMIT_DATA_OUT_URB);
367 cmdinfo->state &= ~COMMAND_INFLIGHT;
368 success = uas_evaluate_response_iu((struct response_iu *)iu, cmnd);
370 /* Error, cancel data transfers */
371 data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
372 data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
374 uas_try_complete(cmnd, __func__);
377 uas_log_cmd_state(cmnd, "bogus IU", iu->iu_id);
381 spin_unlock_irqrestore(&devinfo->lock, flags);
383 /* Unlinking of data urbs must be done without holding the lock */
385 usb_unlink_urb(data_in_urb);
386 usb_put_urb(data_in_urb);
389 usb_unlink_urb(data_out_urb);
390 usb_put_urb(data_out_urb);
394 static void uas_data_cmplt(struct urb *urb)
396 struct scsi_cmnd *cmnd = urb->context;
397 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
398 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
399 struct scsi_data_buffer *sdb = &cmnd->sdb;
401 int status = urb->status;
403 spin_lock_irqsave(&devinfo->lock, flags);
405 if (cmdinfo->data_in_urb == urb) {
406 cmdinfo->state &= ~DATA_IN_URB_INFLIGHT;
407 cmdinfo->data_in_urb = NULL;
408 } else if (cmdinfo->data_out_urb == urb) {
409 cmdinfo->state &= ~DATA_OUT_URB_INFLIGHT;
410 cmdinfo->data_out_urb = NULL;
413 if (devinfo->resetting)
416 /* Data urbs should not complete before the cmd urb is submitted */
417 if (cmdinfo->state & SUBMIT_CMD_URB) {
418 uas_log_cmd_state(cmnd, "unexpected data cmplt", 0);
423 if (status != -ENOENT && status != -ECONNRESET && status != -ESHUTDOWN)
424 uas_log_cmd_state(cmnd, "data cmplt err", status);
425 /* error: no data transfered */
426 scsi_set_resid(cmnd, sdb->length);
428 scsi_set_resid(cmnd, sdb->length - urb->actual_length);
430 uas_try_complete(cmnd, __func__);
433 spin_unlock_irqrestore(&devinfo->lock, flags);
436 static void uas_cmd_cmplt(struct urb *urb)
439 dev_err(&urb->dev->dev, "cmd cmplt err %d\n", urb->status);
444 static struct urb *uas_alloc_data_urb(struct uas_dev_info *devinfo, gfp_t gfp,
445 struct scsi_cmnd *cmnd,
446 enum dma_data_direction dir)
448 struct usb_device *udev = devinfo->udev;
449 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
450 struct urb *urb = usb_alloc_urb(0, gfp);
451 struct scsi_data_buffer *sdb = &cmnd->sdb;
452 unsigned int pipe = (dir == DMA_FROM_DEVICE)
453 ? devinfo->data_in_pipe : devinfo->data_out_pipe;
457 usb_fill_bulk_urb(urb, udev, pipe, NULL, sdb->length,
458 uas_data_cmplt, cmnd);
459 if (devinfo->use_streams)
460 urb->stream_id = cmdinfo->uas_tag;
461 urb->num_sgs = udev->bus->sg_tablesize ? sdb->table.nents : 0;
462 urb->sg = sdb->table.sgl;
467 static struct urb *uas_alloc_sense_urb(struct uas_dev_info *devinfo, gfp_t gfp,
468 struct scsi_cmnd *cmnd)
470 struct usb_device *udev = devinfo->udev;
471 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
472 struct urb *urb = usb_alloc_urb(0, gfp);
478 iu = kzalloc(sizeof(*iu), gfp);
482 usb_fill_bulk_urb(urb, udev, devinfo->status_pipe, iu, sizeof(*iu),
483 uas_stat_cmplt, cmnd->device->host);
484 if (devinfo->use_streams)
485 urb->stream_id = cmdinfo->uas_tag;
486 urb->transfer_flags |= URB_FREE_BUFFER;
494 static struct urb *uas_alloc_cmd_urb(struct uas_dev_info *devinfo, gfp_t gfp,
495 struct scsi_cmnd *cmnd)
497 struct usb_device *udev = devinfo->udev;
498 struct scsi_device *sdev = cmnd->device;
499 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
500 struct urb *urb = usb_alloc_urb(0, gfp);
501 struct command_iu *iu;
507 len = cmnd->cmd_len - 16;
511 iu = kzalloc(sizeof(*iu) + len, gfp);
515 iu->iu_id = IU_ID_COMMAND;
516 iu->tag = cpu_to_be16(cmdinfo->uas_tag);
517 iu->prio_attr = UAS_SIMPLE_TAG;
519 int_to_scsilun(sdev->lun, &iu->lun);
520 memcpy(iu->cdb, cmnd->cmnd, cmnd->cmd_len);
522 usb_fill_bulk_urb(urb, udev, devinfo->cmd_pipe, iu, sizeof(*iu) + len,
523 uas_cmd_cmplt, NULL);
524 urb->transfer_flags |= URB_FREE_BUFFER;
533 * Why should I request the Status IU before sending the Command IU? Spec
534 * says to, but also says the device may receive them in any order. Seems
538 static struct urb *uas_submit_sense_urb(struct scsi_cmnd *cmnd, gfp_t gfp)
540 struct uas_dev_info *devinfo = cmnd->device->hostdata;
544 urb = uas_alloc_sense_urb(devinfo, gfp, cmnd);
547 usb_anchor_urb(urb, &devinfo->sense_urbs);
548 err = usb_submit_urb(urb, gfp);
550 usb_unanchor_urb(urb);
551 uas_log_cmd_state(cmnd, "sense submit err", err);
558 static int uas_submit_urbs(struct scsi_cmnd *cmnd,
559 struct uas_dev_info *devinfo)
561 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
565 lockdep_assert_held(&devinfo->lock);
566 if (cmdinfo->state & SUBMIT_STATUS_URB) {
567 urb = uas_submit_sense_urb(cmnd, GFP_ATOMIC);
569 return SCSI_MLQUEUE_DEVICE_BUSY;
570 cmdinfo->state &= ~SUBMIT_STATUS_URB;
573 if (cmdinfo->state & ALLOC_DATA_IN_URB) {
574 cmdinfo->data_in_urb = uas_alloc_data_urb(devinfo, GFP_ATOMIC,
575 cmnd, DMA_FROM_DEVICE);
576 if (!cmdinfo->data_in_urb)
577 return SCSI_MLQUEUE_DEVICE_BUSY;
578 cmdinfo->state &= ~ALLOC_DATA_IN_URB;
581 if (cmdinfo->state & SUBMIT_DATA_IN_URB) {
582 usb_anchor_urb(cmdinfo->data_in_urb, &devinfo->data_urbs);
583 err = usb_submit_urb(cmdinfo->data_in_urb, GFP_ATOMIC);
585 usb_unanchor_urb(cmdinfo->data_in_urb);
586 uas_log_cmd_state(cmnd, "data in submit err", err);
587 return SCSI_MLQUEUE_DEVICE_BUSY;
589 cmdinfo->state &= ~SUBMIT_DATA_IN_URB;
590 cmdinfo->state |= DATA_IN_URB_INFLIGHT;
593 if (cmdinfo->state & ALLOC_DATA_OUT_URB) {
594 cmdinfo->data_out_urb = uas_alloc_data_urb(devinfo, GFP_ATOMIC,
595 cmnd, DMA_TO_DEVICE);
596 if (!cmdinfo->data_out_urb)
597 return SCSI_MLQUEUE_DEVICE_BUSY;
598 cmdinfo->state &= ~ALLOC_DATA_OUT_URB;
601 if (cmdinfo->state & SUBMIT_DATA_OUT_URB) {
602 usb_anchor_urb(cmdinfo->data_out_urb, &devinfo->data_urbs);
603 err = usb_submit_urb(cmdinfo->data_out_urb, GFP_ATOMIC);
605 usb_unanchor_urb(cmdinfo->data_out_urb);
606 uas_log_cmd_state(cmnd, "data out submit err", err);
607 return SCSI_MLQUEUE_DEVICE_BUSY;
609 cmdinfo->state &= ~SUBMIT_DATA_OUT_URB;
610 cmdinfo->state |= DATA_OUT_URB_INFLIGHT;
613 if (cmdinfo->state & ALLOC_CMD_URB) {
614 cmdinfo->cmd_urb = uas_alloc_cmd_urb(devinfo, GFP_ATOMIC, cmnd);
615 if (!cmdinfo->cmd_urb)
616 return SCSI_MLQUEUE_DEVICE_BUSY;
617 cmdinfo->state &= ~ALLOC_CMD_URB;
620 if (cmdinfo->state & SUBMIT_CMD_URB) {
621 usb_anchor_urb(cmdinfo->cmd_urb, &devinfo->cmd_urbs);
622 err = usb_submit_urb(cmdinfo->cmd_urb, GFP_ATOMIC);
624 usb_unanchor_urb(cmdinfo->cmd_urb);
625 uas_log_cmd_state(cmnd, "cmd submit err", err);
626 return SCSI_MLQUEUE_DEVICE_BUSY;
628 cmdinfo->cmd_urb = NULL;
629 cmdinfo->state &= ~SUBMIT_CMD_URB;
630 cmdinfo->state |= COMMAND_INFLIGHT;
636 static int uas_queuecommand_lck(struct scsi_cmnd *cmnd,
637 void (*done)(struct scsi_cmnd *))
639 struct scsi_device *sdev = cmnd->device;
640 struct uas_dev_info *devinfo = sdev->hostdata;
641 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
645 BUILD_BUG_ON(sizeof(struct uas_cmd_info) > sizeof(struct scsi_pointer));
647 /* Re-check scsi_block_requests now that we've the host-lock */
648 if (cmnd->device->host->host_self_blocked)
649 return SCSI_MLQUEUE_DEVICE_BUSY;
651 if ((devinfo->flags & US_FL_NO_ATA_1X) &&
652 (cmnd->cmnd[0] == ATA_12 || cmnd->cmnd[0] == ATA_16)) {
653 memcpy(cmnd->sense_buffer, usb_stor_sense_invalidCDB,
654 sizeof(usb_stor_sense_invalidCDB));
655 cmnd->result = SAM_STAT_CHECK_CONDITION;
656 cmnd->scsi_done(cmnd);
660 spin_lock_irqsave(&devinfo->lock, flags);
662 if (devinfo->resetting) {
663 set_host_byte(cmnd, DID_ERROR);
664 cmnd->scsi_done(cmnd);
668 /* Find a free uas-tag */
669 for (idx = 0; idx < devinfo->qdepth; idx++) {
670 if (!devinfo->cmnd[idx])
673 if (idx == devinfo->qdepth) {
674 spin_unlock_irqrestore(&devinfo->lock, flags);
675 return SCSI_MLQUEUE_DEVICE_BUSY;
678 cmnd->scsi_done = done;
680 memset(cmdinfo, 0, sizeof(*cmdinfo));
681 cmdinfo->uas_tag = idx + 1; /* uas-tag == usb-stream-id, so 1 based */
682 cmdinfo->state = SUBMIT_STATUS_URB | ALLOC_CMD_URB | SUBMIT_CMD_URB;
684 switch (cmnd->sc_data_direction) {
685 case DMA_FROM_DEVICE:
686 cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
688 case DMA_BIDIRECTIONAL:
689 cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
692 cmdinfo->state |= ALLOC_DATA_OUT_URB | SUBMIT_DATA_OUT_URB;
698 if (!devinfo->use_streams)
699 cmdinfo->state &= ~(SUBMIT_DATA_IN_URB | SUBMIT_DATA_OUT_URB);
701 err = uas_submit_urbs(cmnd, devinfo);
703 * in case of fatal errors the SCSI layer is peculiar
704 * a command that has finished is a success for the purpose
705 * of queueing, no matter how fatal the error
707 if (err == -ENODEV) {
708 set_host_byte(cmnd, DID_ERROR);
709 cmnd->scsi_done(cmnd);
713 /* If we did nothing, give up now */
714 if (cmdinfo->state & SUBMIT_STATUS_URB) {
715 spin_unlock_irqrestore(&devinfo->lock, flags);
716 return SCSI_MLQUEUE_DEVICE_BUSY;
718 uas_add_work(cmdinfo);
721 devinfo->cmnd[idx] = cmnd;
723 spin_unlock_irqrestore(&devinfo->lock, flags);
727 static DEF_SCSI_QCMD(uas_queuecommand)
730 * For now we do not support actually sending an abort to the device, so
731 * this eh always fails. Still we must define it to make sure that we've
732 * dropped all references to the cmnd in question once this function exits.
734 static int uas_eh_abort_handler(struct scsi_cmnd *cmnd)
736 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
737 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
738 struct urb *data_in_urb = NULL;
739 struct urb *data_out_urb = NULL;
742 spin_lock_irqsave(&devinfo->lock, flags);
744 uas_log_cmd_state(cmnd, __func__, 0);
746 /* Ensure that try_complete does not call scsi_done */
747 cmdinfo->state |= COMMAND_ABORTED;
749 /* Drop all refs to this cmnd, kill data urbs to break their ref */
750 devinfo->cmnd[cmdinfo->uas_tag - 1] = NULL;
751 if (cmdinfo->state & DATA_IN_URB_INFLIGHT)
752 data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
753 if (cmdinfo->state & DATA_OUT_URB_INFLIGHT)
754 data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
756 uas_free_unsubmitted_urbs(cmnd);
758 spin_unlock_irqrestore(&devinfo->lock, flags);
761 usb_kill_urb(data_in_urb);
762 usb_put_urb(data_in_urb);
765 usb_kill_urb(data_out_urb);
766 usb_put_urb(data_out_urb);
772 static int uas_eh_device_reset_handler(struct scsi_cmnd *cmnd)
774 struct scsi_device *sdev = cmnd->device;
775 struct uas_dev_info *devinfo = sdev->hostdata;
776 struct usb_device *udev = devinfo->udev;
780 err = usb_lock_device_for_reset(udev, devinfo->intf);
782 shost_printk(KERN_ERR, sdev->host,
783 "%s FAILED to get lock err %d\n", __func__, err);
787 shost_printk(KERN_INFO, sdev->host, "%s start\n", __func__);
789 spin_lock_irqsave(&devinfo->lock, flags);
790 devinfo->resetting = 1;
791 spin_unlock_irqrestore(&devinfo->lock, flags);
793 usb_kill_anchored_urbs(&devinfo->cmd_urbs);
794 usb_kill_anchored_urbs(&devinfo->sense_urbs);
795 usb_kill_anchored_urbs(&devinfo->data_urbs);
796 uas_zap_pending(devinfo, DID_RESET);
798 err = usb_reset_device(udev);
800 spin_lock_irqsave(&devinfo->lock, flags);
801 devinfo->resetting = 0;
802 spin_unlock_irqrestore(&devinfo->lock, flags);
804 usb_unlock_device(udev);
807 shost_printk(KERN_INFO, sdev->host, "%s FAILED err %d\n",
812 shost_printk(KERN_INFO, sdev->host, "%s success\n", __func__);
816 static int uas_target_alloc(struct scsi_target *starget)
818 struct uas_dev_info *devinfo = (struct uas_dev_info *)
819 dev_to_shost(starget->dev.parent)->hostdata;
821 if (devinfo->flags & US_FL_NO_REPORT_LUNS)
822 starget->no_report_luns = 1;
827 static int uas_slave_alloc(struct scsi_device *sdev)
829 struct uas_dev_info *devinfo =
830 (struct uas_dev_info *)sdev->host->hostdata;
832 sdev->hostdata = devinfo;
835 * The protocol has no requirements on alignment in the strict sense.
836 * Controllers may or may not have alignment restrictions.
837 * As this is not exported, we use an extremely conservative guess.
839 blk_queue_update_dma_alignment(sdev->request_queue, (512 - 1));
844 static int uas_slave_configure(struct scsi_device *sdev)
846 struct uas_dev_info *devinfo = sdev->hostdata;
847 struct device *dev = sdev->host->dma_dev;
849 if (devinfo->flags & US_FL_MAX_SECTORS_64)
850 blk_queue_max_hw_sectors(sdev->request_queue, 64);
851 else if (devinfo->flags & US_FL_MAX_SECTORS_240)
852 blk_queue_max_hw_sectors(sdev->request_queue, 240);
853 else if (devinfo->udev->speed >= USB_SPEED_SUPER)
854 blk_queue_max_hw_sectors(sdev->request_queue, 2048);
856 blk_queue_max_hw_sectors(sdev->request_queue,
857 min_t(size_t, queue_max_hw_sectors(sdev->request_queue),
858 dma_max_mapping_size(dev) >> SECTOR_SHIFT));
860 if (devinfo->flags & US_FL_NO_REPORT_OPCODES)
861 sdev->no_report_opcodes = 1;
863 /* A few buggy USB-ATA bridges don't understand FUA */
864 if (devinfo->flags & US_FL_BROKEN_FUA)
865 sdev->broken_fua = 1;
867 /* UAS also needs to support FL_ALWAYS_SYNC */
868 if (devinfo->flags & US_FL_ALWAYS_SYNC) {
869 sdev->skip_ms_page_3f = 1;
870 sdev->skip_ms_page_8 = 1;
871 sdev->wce_default_on = 1;
874 /* Some disks cannot handle READ_CAPACITY_16 */
875 if (devinfo->flags & US_FL_NO_READ_CAPACITY_16)
876 sdev->no_read_capacity_16 = 1;
879 * Some disks return the total number of blocks in response
880 * to READ CAPACITY rather than the highest block number.
881 * If this device makes that mistake, tell the sd driver.
883 if (devinfo->flags & US_FL_FIX_CAPACITY)
884 sdev->fix_capacity = 1;
887 * in some cases we have to guess
889 if (devinfo->flags & US_FL_CAPACITY_HEURISTICS)
890 sdev->guess_capacity = 1;
893 * Some devices don't like MODE SENSE with page=0x3f,
894 * which is the command used for checking if a device
895 * is write-protected. Now that we tell the sd driver
896 * to do a 192-byte transfer with this command the
897 * majority of devices work fine, but a few still can't
898 * handle it. The sd driver will simply assume those
899 * devices are write-enabled.
901 if (devinfo->flags & US_FL_NO_WP_DETECT)
902 sdev->skip_ms_page_3f = 1;
904 scsi_change_queue_depth(sdev, devinfo->qdepth - 2);
908 static struct scsi_host_template uas_host_template = {
909 .module = THIS_MODULE,
911 .queuecommand = uas_queuecommand,
912 .target_alloc = uas_target_alloc,
913 .slave_alloc = uas_slave_alloc,
914 .slave_configure = uas_slave_configure,
915 .eh_abort_handler = uas_eh_abort_handler,
916 .eh_device_reset_handler = uas_eh_device_reset_handler,
918 .skip_settle_delay = 1,
919 .dma_boundary = PAGE_SIZE - 1,
922 #define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \
923 vendorName, productName, useProtocol, useTransport, \
924 initFunction, flags) \
925 { USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax), \
926 .driver_info = (flags) }
928 static struct usb_device_id uas_usb_ids[] = {
929 # include "unusual_uas.h"
930 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_BULK) },
931 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_UAS) },
934 MODULE_DEVICE_TABLE(usb, uas_usb_ids);
938 static int uas_switch_interface(struct usb_device *udev,
939 struct usb_interface *intf)
941 struct usb_host_interface *alt;
943 alt = uas_find_uas_alt_setting(intf);
947 return usb_set_interface(udev, alt->desc.bInterfaceNumber,
948 alt->desc.bAlternateSetting);
951 static int uas_configure_endpoints(struct uas_dev_info *devinfo)
953 struct usb_host_endpoint *eps[4] = { };
954 struct usb_device *udev = devinfo->udev;
957 r = uas_find_endpoints(devinfo->intf->cur_altsetting, eps);
961 devinfo->cmd_pipe = usb_sndbulkpipe(udev,
962 usb_endpoint_num(&eps[0]->desc));
963 devinfo->status_pipe = usb_rcvbulkpipe(udev,
964 usb_endpoint_num(&eps[1]->desc));
965 devinfo->data_in_pipe = usb_rcvbulkpipe(udev,
966 usb_endpoint_num(&eps[2]->desc));
967 devinfo->data_out_pipe = usb_sndbulkpipe(udev,
968 usb_endpoint_num(&eps[3]->desc));
970 if (udev->speed < USB_SPEED_SUPER) {
971 devinfo->qdepth = 32;
972 devinfo->use_streams = 0;
974 devinfo->qdepth = usb_alloc_streams(devinfo->intf, eps + 1,
975 3, MAX_CMNDS, GFP_NOIO);
976 if (devinfo->qdepth < 0)
977 return devinfo->qdepth;
978 devinfo->use_streams = 1;
984 static void uas_free_streams(struct uas_dev_info *devinfo)
986 struct usb_device *udev = devinfo->udev;
987 struct usb_host_endpoint *eps[3];
989 eps[0] = usb_pipe_endpoint(udev, devinfo->status_pipe);
990 eps[1] = usb_pipe_endpoint(udev, devinfo->data_in_pipe);
991 eps[2] = usb_pipe_endpoint(udev, devinfo->data_out_pipe);
992 usb_free_streams(devinfo->intf, eps, 3, GFP_NOIO);
995 static int uas_probe(struct usb_interface *intf, const struct usb_device_id *id)
997 int result = -ENOMEM;
998 struct Scsi_Host *shost = NULL;
999 struct uas_dev_info *devinfo;
1000 struct usb_device *udev = interface_to_usbdev(intf);
1001 unsigned long dev_flags;
1003 if (!uas_use_uas_driver(intf, id, &dev_flags))
1006 if (uas_switch_interface(udev, intf))
1009 shost = scsi_host_alloc(&uas_host_template,
1010 sizeof(struct uas_dev_info));
1014 shost->max_cmd_len = 16 + 252;
1016 shost->max_lun = 256;
1017 shost->max_channel = 0;
1018 shost->sg_tablesize = udev->bus->sg_tablesize;
1020 devinfo = (struct uas_dev_info *)shost->hostdata;
1021 devinfo->intf = intf;
1022 devinfo->udev = udev;
1023 devinfo->resetting = 0;
1024 devinfo->shutdown = 0;
1025 devinfo->flags = dev_flags;
1026 init_usb_anchor(&devinfo->cmd_urbs);
1027 init_usb_anchor(&devinfo->sense_urbs);
1028 init_usb_anchor(&devinfo->data_urbs);
1029 spin_lock_init(&devinfo->lock);
1030 INIT_WORK(&devinfo->work, uas_do_work);
1031 INIT_WORK(&devinfo->scan_work, uas_scan_work);
1033 result = uas_configure_endpoints(devinfo);
1038 * 1 tag is reserved for untagged commands +
1039 * 1 tag to avoid off by one errors in some bridge firmwares
1041 shost->can_queue = devinfo->qdepth - 2;
1043 usb_set_intfdata(intf, shost);
1044 result = scsi_add_host_with_dma(shost, &intf->dev, udev->bus->sysdev);
1048 /* Submit the delayed_work for SCSI-device scanning */
1049 schedule_work(&devinfo->scan_work);
1054 uas_free_streams(devinfo);
1055 usb_set_intfdata(intf, NULL);
1057 usb_set_interface(udev, intf->altsetting[0].desc.bInterfaceNumber, 0);
1059 scsi_host_put(shost);
1063 static int uas_cmnd_list_empty(struct uas_dev_info *devinfo)
1065 unsigned long flags;
1068 spin_lock_irqsave(&devinfo->lock, flags);
1070 for (i = 0; i < devinfo->qdepth; i++) {
1071 if (devinfo->cmnd[i]) {
1072 r = 0; /* Not empty */
1077 spin_unlock_irqrestore(&devinfo->lock, flags);
1083 * Wait for any pending cmnds to complete, on usb-2 sense_urbs may temporarily
1084 * get empty while there still is more work to do due to sense-urbs completing
1085 * with a READ/WRITE_READY iu code, so keep waiting until the list gets empty.
1087 static int uas_wait_for_pending_cmnds(struct uas_dev_info *devinfo)
1089 unsigned long start_time;
1092 start_time = jiffies;
1094 flush_work(&devinfo->work);
1096 r = usb_wait_anchor_empty_timeout(&devinfo->sense_urbs, 5000);
1100 r = usb_wait_anchor_empty_timeout(&devinfo->data_urbs, 500);
1104 if (time_after(jiffies, start_time + 5 * HZ))
1106 } while (!uas_cmnd_list_empty(devinfo));
1111 static int uas_pre_reset(struct usb_interface *intf)
1113 struct Scsi_Host *shost = usb_get_intfdata(intf);
1114 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1115 unsigned long flags;
1117 if (devinfo->shutdown)
1120 /* Block new requests */
1121 spin_lock_irqsave(shost->host_lock, flags);
1122 scsi_block_requests(shost);
1123 spin_unlock_irqrestore(shost->host_lock, flags);
1125 if (uas_wait_for_pending_cmnds(devinfo) != 0) {
1126 shost_printk(KERN_ERR, shost, "%s: timed out\n", __func__);
1127 scsi_unblock_requests(shost);
1131 uas_free_streams(devinfo);
1136 static int uas_post_reset(struct usb_interface *intf)
1138 struct Scsi_Host *shost = usb_get_intfdata(intf);
1139 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1140 unsigned long flags;
1143 if (devinfo->shutdown)
1146 err = uas_configure_endpoints(devinfo);
1147 if (err && err != -ENODEV)
1148 shost_printk(KERN_ERR, shost,
1149 "%s: alloc streams error %d after reset",
1152 /* we must unblock the host in every case lest we deadlock */
1153 spin_lock_irqsave(shost->host_lock, flags);
1154 scsi_report_bus_reset(shost, 0);
1155 spin_unlock_irqrestore(shost->host_lock, flags);
1157 scsi_unblock_requests(shost);
1162 static int uas_suspend(struct usb_interface *intf, pm_message_t message)
1164 struct Scsi_Host *shost = usb_get_intfdata(intf);
1165 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1167 if (uas_wait_for_pending_cmnds(devinfo) != 0) {
1168 shost_printk(KERN_ERR, shost, "%s: timed out\n", __func__);
1175 static int uas_resume(struct usb_interface *intf)
1180 static int uas_reset_resume(struct usb_interface *intf)
1182 struct Scsi_Host *shost = usb_get_intfdata(intf);
1183 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1184 unsigned long flags;
1187 err = uas_configure_endpoints(devinfo);
1189 shost_printk(KERN_ERR, shost,
1190 "%s: alloc streams error %d after reset",
1195 spin_lock_irqsave(shost->host_lock, flags);
1196 scsi_report_bus_reset(shost, 0);
1197 spin_unlock_irqrestore(shost->host_lock, flags);
1202 static void uas_disconnect(struct usb_interface *intf)
1204 struct Scsi_Host *shost = usb_get_intfdata(intf);
1205 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1206 unsigned long flags;
1208 spin_lock_irqsave(&devinfo->lock, flags);
1209 devinfo->resetting = 1;
1210 spin_unlock_irqrestore(&devinfo->lock, flags);
1212 cancel_work_sync(&devinfo->work);
1213 usb_kill_anchored_urbs(&devinfo->cmd_urbs);
1214 usb_kill_anchored_urbs(&devinfo->sense_urbs);
1215 usb_kill_anchored_urbs(&devinfo->data_urbs);
1216 uas_zap_pending(devinfo, DID_NO_CONNECT);
1219 * Prevent SCSI scanning (if it hasn't started yet)
1220 * or wait for the SCSI-scanning routine to stop.
1222 cancel_work_sync(&devinfo->scan_work);
1224 scsi_remove_host(shost);
1225 uas_free_streams(devinfo);
1226 scsi_host_put(shost);
1230 * Put the device back in usb-storage mode on shutdown, as some BIOS-es
1231 * hang on reboot when the device is still in uas mode. Note the reset is
1232 * necessary as some devices won't revert to usb-storage mode without it.
1234 static void uas_shutdown(struct device *dev)
1236 struct usb_interface *intf = to_usb_interface(dev);
1237 struct usb_device *udev = interface_to_usbdev(intf);
1238 struct Scsi_Host *shost = usb_get_intfdata(intf);
1239 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1241 if (system_state != SYSTEM_RESTART)
1244 devinfo->shutdown = 1;
1245 uas_free_streams(devinfo);
1246 usb_set_interface(udev, intf->altsetting[0].desc.bInterfaceNumber, 0);
1247 usb_reset_device(udev);
1250 static struct usb_driver uas_driver = {
1253 .disconnect = uas_disconnect,
1254 .pre_reset = uas_pre_reset,
1255 .post_reset = uas_post_reset,
1256 .suspend = uas_suspend,
1257 .resume = uas_resume,
1258 .reset_resume = uas_reset_resume,
1259 .drvwrap.driver.shutdown = uas_shutdown,
1260 .id_table = uas_usb_ids,
1263 static int __init uas_init(void)
1267 workqueue = alloc_workqueue("uas", WQ_MEM_RECLAIM, 0);
1271 rv = usb_register(&uas_driver);
1273 destroy_workqueue(workqueue);
1280 static void __exit uas_exit(void)
1282 usb_deregister(&uas_driver);
1283 destroy_workqueue(workqueue);
1286 module_init(uas_init);
1287 module_exit(uas_exit);
1289 MODULE_LICENSE("GPL");
1290 MODULE_IMPORT_NS(USB_STORAGE);
1292 "Hans de Goede <hdegoede@redhat.com>, Matthew Wilcox and Sarah Sharp");