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;
51 SUBMIT_STATUS_URB = BIT(1),
52 ALLOC_DATA_IN_URB = BIT(2),
53 SUBMIT_DATA_IN_URB = BIT(3),
54 ALLOC_DATA_OUT_URB = BIT(4),
55 SUBMIT_DATA_OUT_URB = BIT(5),
56 ALLOC_CMD_URB = BIT(6),
57 SUBMIT_CMD_URB = BIT(7),
58 COMMAND_INFLIGHT = BIT(8),
59 DATA_IN_URB_INFLIGHT = BIT(9),
60 DATA_OUT_URB_INFLIGHT = BIT(10),
61 COMMAND_ABORTED = BIT(11),
62 IS_IN_WORK_LIST = BIT(12),
65 /* Overrides scsi_pointer */
70 struct urb *data_in_urb;
71 struct urb *data_out_urb;
74 /* I hate forward declarations, but I actually have a loop */
75 static int uas_submit_urbs(struct scsi_cmnd *cmnd,
76 struct uas_dev_info *devinfo);
77 static void uas_do_work(struct work_struct *work);
78 static int uas_try_complete(struct scsi_cmnd *cmnd, const char *caller);
79 static void uas_free_streams(struct uas_dev_info *devinfo);
80 static void uas_log_cmd_state(struct scsi_cmnd *cmnd, const char *prefix,
83 static void uas_do_work(struct work_struct *work)
85 struct uas_dev_info *devinfo =
86 container_of(work, struct uas_dev_info, work);
87 struct uas_cmd_info *cmdinfo;
88 struct scsi_cmnd *cmnd;
92 spin_lock_irqsave(&devinfo->lock, flags);
94 if (devinfo->resetting)
97 for (i = 0; i < devinfo->qdepth; i++) {
98 if (!devinfo->cmnd[i])
101 cmnd = devinfo->cmnd[i];
102 cmdinfo = (void *)&cmnd->SCp;
104 if (!(cmdinfo->state & IS_IN_WORK_LIST))
107 err = uas_submit_urbs(cmnd, cmnd->device->hostdata);
109 cmdinfo->state &= ~IS_IN_WORK_LIST;
111 schedule_work(&devinfo->work);
114 spin_unlock_irqrestore(&devinfo->lock, flags);
117 static void uas_add_work(struct uas_cmd_info *cmdinfo)
119 struct scsi_pointer *scp = (void *)cmdinfo;
120 struct scsi_cmnd *cmnd = container_of(scp, struct scsi_cmnd, SCp);
121 struct uas_dev_info *devinfo = cmnd->device->hostdata;
123 lockdep_assert_held(&devinfo->lock);
124 cmdinfo->state |= IS_IN_WORK_LIST;
125 schedule_work(&devinfo->work);
128 static void uas_zap_pending(struct uas_dev_info *devinfo, int result)
130 struct uas_cmd_info *cmdinfo;
131 struct scsi_cmnd *cmnd;
135 spin_lock_irqsave(&devinfo->lock, flags);
136 for (i = 0; i < devinfo->qdepth; i++) {
137 if (!devinfo->cmnd[i])
140 cmnd = devinfo->cmnd[i];
141 cmdinfo = (void *)&cmnd->SCp;
142 uas_log_cmd_state(cmnd, __func__, 0);
143 /* Sense urbs were killed, clear COMMAND_INFLIGHT manually */
144 cmdinfo->state &= ~COMMAND_INFLIGHT;
145 cmnd->result = result << 16;
146 err = uas_try_complete(cmnd, __func__);
149 spin_unlock_irqrestore(&devinfo->lock, flags);
152 static void uas_sense(struct urb *urb, struct scsi_cmnd *cmnd)
154 struct sense_iu *sense_iu = urb->transfer_buffer;
155 struct scsi_device *sdev = cmnd->device;
157 if (urb->actual_length > 16) {
158 unsigned len = be16_to_cpup(&sense_iu->len);
159 if (len + 16 != urb->actual_length) {
160 int newlen = min(len + 16, urb->actual_length) - 16;
163 sdev_printk(KERN_INFO, sdev, "%s: urb length %d "
164 "disagrees with IU sense data length %d, "
165 "using %d bytes of sense data\n", __func__,
166 urb->actual_length, len, newlen);
169 memcpy(cmnd->sense_buffer, sense_iu->sense, len);
172 cmnd->result = sense_iu->status;
175 static void uas_log_cmd_state(struct scsi_cmnd *cmnd, const char *prefix,
178 struct uas_cmd_info *ci = (void *)&cmnd->SCp;
179 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
181 scmd_printk(KERN_INFO, cmnd,
182 "%s %d uas-tag %d inflight:%s%s%s%s%s%s%s%s%s%s%s%s ",
183 prefix, status, cmdinfo->uas_tag,
184 (ci->state & SUBMIT_STATUS_URB) ? " s-st" : "",
185 (ci->state & ALLOC_DATA_IN_URB) ? " a-in" : "",
186 (ci->state & SUBMIT_DATA_IN_URB) ? " s-in" : "",
187 (ci->state & ALLOC_DATA_OUT_URB) ? " a-out" : "",
188 (ci->state & SUBMIT_DATA_OUT_URB) ? " s-out" : "",
189 (ci->state & ALLOC_CMD_URB) ? " a-cmd" : "",
190 (ci->state & SUBMIT_CMD_URB) ? " s-cmd" : "",
191 (ci->state & COMMAND_INFLIGHT) ? " CMD" : "",
192 (ci->state & DATA_IN_URB_INFLIGHT) ? " IN" : "",
193 (ci->state & DATA_OUT_URB_INFLIGHT) ? " OUT" : "",
194 (ci->state & COMMAND_ABORTED) ? " abort" : "",
195 (ci->state & IS_IN_WORK_LIST) ? " work" : "");
196 scsi_print_command(cmnd);
199 static void uas_free_unsubmitted_urbs(struct scsi_cmnd *cmnd)
201 struct uas_cmd_info *cmdinfo;
206 cmdinfo = (void *)&cmnd->SCp;
208 if (cmdinfo->state & SUBMIT_CMD_URB)
209 usb_free_urb(cmdinfo->cmd_urb);
211 /* data urbs may have never gotten their submit flag set */
212 if (!(cmdinfo->state & DATA_IN_URB_INFLIGHT))
213 usb_free_urb(cmdinfo->data_in_urb);
214 if (!(cmdinfo->state & DATA_OUT_URB_INFLIGHT))
215 usb_free_urb(cmdinfo->data_out_urb);
218 static int uas_try_complete(struct scsi_cmnd *cmnd, const char *caller)
220 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
221 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
223 lockdep_assert_held(&devinfo->lock);
224 if (cmdinfo->state & (COMMAND_INFLIGHT |
225 DATA_IN_URB_INFLIGHT |
226 DATA_OUT_URB_INFLIGHT |
229 devinfo->cmnd[cmdinfo->uas_tag - 1] = NULL;
230 uas_free_unsubmitted_urbs(cmnd);
231 cmnd->scsi_done(cmnd);
235 static void uas_xfer_data(struct urb *urb, struct scsi_cmnd *cmnd,
238 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
241 cmdinfo->state |= direction | SUBMIT_STATUS_URB;
242 err = uas_submit_urbs(cmnd, cmnd->device->hostdata);
244 uas_add_work(cmdinfo);
248 static bool uas_evaluate_response_iu(struct response_iu *riu, struct scsi_cmnd *cmnd)
250 u8 response_code = riu->response_code;
252 switch (response_code) {
253 case RC_INCORRECT_LUN:
254 cmnd->result = DID_BAD_TARGET << 16;
256 case RC_TMF_SUCCEEDED:
257 cmnd->result = DID_OK << 16;
259 case RC_TMF_NOT_SUPPORTED:
260 cmnd->result = DID_TARGET_FAILURE << 16;
263 uas_log_cmd_state(cmnd, "response iu", response_code);
264 cmnd->result = DID_ERROR << 16;
268 return response_code == RC_TMF_SUCCEEDED;
271 static void uas_stat_cmplt(struct urb *urb)
273 struct iu *iu = urb->transfer_buffer;
274 struct Scsi_Host *shost = urb->context;
275 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
276 struct urb *data_in_urb = NULL;
277 struct urb *data_out_urb = NULL;
278 struct scsi_cmnd *cmnd;
279 struct uas_cmd_info *cmdinfo;
282 int status = urb->status;
285 spin_lock_irqsave(&devinfo->lock, flags);
287 if (devinfo->resetting)
291 if (status != -ENOENT && status != -ECONNRESET && status != -ESHUTDOWN)
292 dev_err(&urb->dev->dev, "stat urb: status %d\n", status);
296 idx = be16_to_cpup(&iu->tag) - 1;
297 if (idx >= MAX_CMNDS || !devinfo->cmnd[idx]) {
298 dev_err(&urb->dev->dev,
299 "stat urb: no pending cmd for uas-tag %d\n", idx + 1);
303 cmnd = devinfo->cmnd[idx];
304 cmdinfo = (void *)&cmnd->SCp;
306 if (!(cmdinfo->state & COMMAND_INFLIGHT)) {
307 uas_log_cmd_state(cmnd, "unexpected status cmplt", 0);
313 uas_sense(urb, cmnd);
314 if (cmnd->result != 0) {
315 /* cancel data transfers on error */
316 data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
317 data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
319 cmdinfo->state &= ~COMMAND_INFLIGHT;
320 uas_try_complete(cmnd, __func__);
322 case IU_ID_READ_READY:
323 if (!cmdinfo->data_in_urb ||
324 (cmdinfo->state & DATA_IN_URB_INFLIGHT)) {
325 uas_log_cmd_state(cmnd, "unexpected read rdy", 0);
328 uas_xfer_data(urb, cmnd, SUBMIT_DATA_IN_URB);
330 case IU_ID_WRITE_READY:
331 if (!cmdinfo->data_out_urb ||
332 (cmdinfo->state & DATA_OUT_URB_INFLIGHT)) {
333 uas_log_cmd_state(cmnd, "unexpected write rdy", 0);
336 uas_xfer_data(urb, cmnd, SUBMIT_DATA_OUT_URB);
339 cmdinfo->state &= ~COMMAND_INFLIGHT;
340 success = uas_evaluate_response_iu((struct response_iu *)iu, cmnd);
342 /* Error, cancel data transfers */
343 data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
344 data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
346 uas_try_complete(cmnd, __func__);
349 uas_log_cmd_state(cmnd, "bogus IU", iu->iu_id);
353 spin_unlock_irqrestore(&devinfo->lock, flags);
355 /* Unlinking of data urbs must be done without holding the lock */
357 usb_unlink_urb(data_in_urb);
358 usb_put_urb(data_in_urb);
361 usb_unlink_urb(data_out_urb);
362 usb_put_urb(data_out_urb);
366 static void uas_data_cmplt(struct urb *urb)
368 struct scsi_cmnd *cmnd = urb->context;
369 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
370 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
371 struct scsi_data_buffer *sdb = &cmnd->sdb;
373 int status = urb->status;
375 spin_lock_irqsave(&devinfo->lock, flags);
377 if (cmdinfo->data_in_urb == urb) {
378 cmdinfo->state &= ~DATA_IN_URB_INFLIGHT;
379 cmdinfo->data_in_urb = NULL;
380 } else if (cmdinfo->data_out_urb == urb) {
381 cmdinfo->state &= ~DATA_OUT_URB_INFLIGHT;
382 cmdinfo->data_out_urb = NULL;
385 if (devinfo->resetting)
388 /* Data urbs should not complete before the cmd urb is submitted */
389 if (cmdinfo->state & SUBMIT_CMD_URB) {
390 uas_log_cmd_state(cmnd, "unexpected data cmplt", 0);
395 if (status != -ENOENT && status != -ECONNRESET && status != -ESHUTDOWN)
396 uas_log_cmd_state(cmnd, "data cmplt err", status);
397 /* error: no data transfered */
398 scsi_set_resid(cmnd, sdb->length);
400 scsi_set_resid(cmnd, sdb->length - urb->actual_length);
402 uas_try_complete(cmnd, __func__);
405 spin_unlock_irqrestore(&devinfo->lock, flags);
408 static void uas_cmd_cmplt(struct urb *urb)
411 dev_err(&urb->dev->dev, "cmd cmplt err %d\n", urb->status);
416 static struct urb *uas_alloc_data_urb(struct uas_dev_info *devinfo, gfp_t gfp,
417 struct scsi_cmnd *cmnd,
418 enum dma_data_direction dir)
420 struct usb_device *udev = devinfo->udev;
421 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
422 struct urb *urb = usb_alloc_urb(0, gfp);
423 struct scsi_data_buffer *sdb = &cmnd->sdb;
424 unsigned int pipe = (dir == DMA_FROM_DEVICE)
425 ? devinfo->data_in_pipe : devinfo->data_out_pipe;
429 usb_fill_bulk_urb(urb, udev, pipe, NULL, sdb->length,
430 uas_data_cmplt, cmnd);
431 if (devinfo->use_streams)
432 urb->stream_id = cmdinfo->uas_tag;
433 urb->num_sgs = udev->bus->sg_tablesize ? sdb->table.nents : 0;
434 urb->sg = sdb->table.sgl;
439 static struct urb *uas_alloc_sense_urb(struct uas_dev_info *devinfo, gfp_t gfp,
440 struct scsi_cmnd *cmnd)
442 struct usb_device *udev = devinfo->udev;
443 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
444 struct urb *urb = usb_alloc_urb(0, gfp);
450 iu = kzalloc(sizeof(*iu), gfp);
454 usb_fill_bulk_urb(urb, udev, devinfo->status_pipe, iu, sizeof(*iu),
455 uas_stat_cmplt, cmnd->device->host);
456 if (devinfo->use_streams)
457 urb->stream_id = cmdinfo->uas_tag;
458 urb->transfer_flags |= URB_FREE_BUFFER;
466 static struct urb *uas_alloc_cmd_urb(struct uas_dev_info *devinfo, gfp_t gfp,
467 struct scsi_cmnd *cmnd)
469 struct usb_device *udev = devinfo->udev;
470 struct scsi_device *sdev = cmnd->device;
471 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
472 struct urb *urb = usb_alloc_urb(0, gfp);
473 struct command_iu *iu;
479 len = cmnd->cmd_len - 16;
483 iu = kzalloc(sizeof(*iu) + len, gfp);
487 iu->iu_id = IU_ID_COMMAND;
488 iu->tag = cpu_to_be16(cmdinfo->uas_tag);
489 iu->prio_attr = UAS_SIMPLE_TAG;
491 int_to_scsilun(sdev->lun, &iu->lun);
492 memcpy(iu->cdb, cmnd->cmnd, cmnd->cmd_len);
494 usb_fill_bulk_urb(urb, udev, devinfo->cmd_pipe, iu, sizeof(*iu) + len,
495 uas_cmd_cmplt, NULL);
496 urb->transfer_flags |= URB_FREE_BUFFER;
505 * Why should I request the Status IU before sending the Command IU? Spec
506 * says to, but also says the device may receive them in any order. Seems
510 static struct urb *uas_submit_sense_urb(struct scsi_cmnd *cmnd, gfp_t gfp)
512 struct uas_dev_info *devinfo = cmnd->device->hostdata;
516 urb = uas_alloc_sense_urb(devinfo, gfp, cmnd);
519 usb_anchor_urb(urb, &devinfo->sense_urbs);
520 err = usb_submit_urb(urb, gfp);
522 usb_unanchor_urb(urb);
523 uas_log_cmd_state(cmnd, "sense submit err", err);
530 static int uas_submit_urbs(struct scsi_cmnd *cmnd,
531 struct uas_dev_info *devinfo)
533 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
537 lockdep_assert_held(&devinfo->lock);
538 if (cmdinfo->state & SUBMIT_STATUS_URB) {
539 urb = uas_submit_sense_urb(cmnd, GFP_ATOMIC);
541 return SCSI_MLQUEUE_DEVICE_BUSY;
542 cmdinfo->state &= ~SUBMIT_STATUS_URB;
545 if (cmdinfo->state & ALLOC_DATA_IN_URB) {
546 cmdinfo->data_in_urb = uas_alloc_data_urb(devinfo, GFP_ATOMIC,
547 cmnd, DMA_FROM_DEVICE);
548 if (!cmdinfo->data_in_urb)
549 return SCSI_MLQUEUE_DEVICE_BUSY;
550 cmdinfo->state &= ~ALLOC_DATA_IN_URB;
553 if (cmdinfo->state & SUBMIT_DATA_IN_URB) {
554 usb_anchor_urb(cmdinfo->data_in_urb, &devinfo->data_urbs);
555 err = usb_submit_urb(cmdinfo->data_in_urb, GFP_ATOMIC);
557 usb_unanchor_urb(cmdinfo->data_in_urb);
558 uas_log_cmd_state(cmnd, "data in submit err", err);
559 return SCSI_MLQUEUE_DEVICE_BUSY;
561 cmdinfo->state &= ~SUBMIT_DATA_IN_URB;
562 cmdinfo->state |= DATA_IN_URB_INFLIGHT;
565 if (cmdinfo->state & ALLOC_DATA_OUT_URB) {
566 cmdinfo->data_out_urb = uas_alloc_data_urb(devinfo, GFP_ATOMIC,
567 cmnd, DMA_TO_DEVICE);
568 if (!cmdinfo->data_out_urb)
569 return SCSI_MLQUEUE_DEVICE_BUSY;
570 cmdinfo->state &= ~ALLOC_DATA_OUT_URB;
573 if (cmdinfo->state & SUBMIT_DATA_OUT_URB) {
574 usb_anchor_urb(cmdinfo->data_out_urb, &devinfo->data_urbs);
575 err = usb_submit_urb(cmdinfo->data_out_urb, GFP_ATOMIC);
577 usb_unanchor_urb(cmdinfo->data_out_urb);
578 uas_log_cmd_state(cmnd, "data out submit err", err);
579 return SCSI_MLQUEUE_DEVICE_BUSY;
581 cmdinfo->state &= ~SUBMIT_DATA_OUT_URB;
582 cmdinfo->state |= DATA_OUT_URB_INFLIGHT;
585 if (cmdinfo->state & ALLOC_CMD_URB) {
586 cmdinfo->cmd_urb = uas_alloc_cmd_urb(devinfo, GFP_ATOMIC, cmnd);
587 if (!cmdinfo->cmd_urb)
588 return SCSI_MLQUEUE_DEVICE_BUSY;
589 cmdinfo->state &= ~ALLOC_CMD_URB;
592 if (cmdinfo->state & SUBMIT_CMD_URB) {
593 usb_anchor_urb(cmdinfo->cmd_urb, &devinfo->cmd_urbs);
594 err = usb_submit_urb(cmdinfo->cmd_urb, GFP_ATOMIC);
596 usb_unanchor_urb(cmdinfo->cmd_urb);
597 uas_log_cmd_state(cmnd, "cmd submit err", err);
598 return SCSI_MLQUEUE_DEVICE_BUSY;
600 cmdinfo->cmd_urb = NULL;
601 cmdinfo->state &= ~SUBMIT_CMD_URB;
602 cmdinfo->state |= COMMAND_INFLIGHT;
608 static int uas_queuecommand_lck(struct scsi_cmnd *cmnd,
609 void (*done)(struct scsi_cmnd *))
611 struct scsi_device *sdev = cmnd->device;
612 struct uas_dev_info *devinfo = sdev->hostdata;
613 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
617 BUILD_BUG_ON(sizeof(struct uas_cmd_info) > sizeof(struct scsi_pointer));
619 /* Re-check scsi_block_requests now that we've the host-lock */
620 if (cmnd->device->host->host_self_blocked)
621 return SCSI_MLQUEUE_DEVICE_BUSY;
623 if ((devinfo->flags & US_FL_NO_ATA_1X) &&
624 (cmnd->cmnd[0] == ATA_12 || cmnd->cmnd[0] == ATA_16)) {
625 memcpy(cmnd->sense_buffer, usb_stor_sense_invalidCDB,
626 sizeof(usb_stor_sense_invalidCDB));
627 cmnd->result = SAM_STAT_CHECK_CONDITION;
628 cmnd->scsi_done(cmnd);
632 spin_lock_irqsave(&devinfo->lock, flags);
634 if (devinfo->resetting) {
635 cmnd->result = DID_ERROR << 16;
636 cmnd->scsi_done(cmnd);
637 spin_unlock_irqrestore(&devinfo->lock, flags);
641 /* Find a free uas-tag */
642 for (idx = 0; idx < devinfo->qdepth; idx++) {
643 if (!devinfo->cmnd[idx])
646 if (idx == devinfo->qdepth) {
647 spin_unlock_irqrestore(&devinfo->lock, flags);
648 return SCSI_MLQUEUE_DEVICE_BUSY;
651 cmnd->scsi_done = done;
653 memset(cmdinfo, 0, sizeof(*cmdinfo));
654 cmdinfo->uas_tag = idx + 1; /* uas-tag == usb-stream-id, so 1 based */
655 cmdinfo->state = SUBMIT_STATUS_URB | ALLOC_CMD_URB | SUBMIT_CMD_URB;
657 switch (cmnd->sc_data_direction) {
658 case DMA_FROM_DEVICE:
659 cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
661 case DMA_BIDIRECTIONAL:
662 cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
665 cmdinfo->state |= ALLOC_DATA_OUT_URB | SUBMIT_DATA_OUT_URB;
670 if (!devinfo->use_streams)
671 cmdinfo->state &= ~(SUBMIT_DATA_IN_URB | SUBMIT_DATA_OUT_URB);
673 err = uas_submit_urbs(cmnd, devinfo);
675 /* If we did nothing, give up now */
676 if (cmdinfo->state & SUBMIT_STATUS_URB) {
677 spin_unlock_irqrestore(&devinfo->lock, flags);
678 return SCSI_MLQUEUE_DEVICE_BUSY;
680 uas_add_work(cmdinfo);
683 devinfo->cmnd[idx] = cmnd;
684 spin_unlock_irqrestore(&devinfo->lock, flags);
688 static DEF_SCSI_QCMD(uas_queuecommand)
691 * For now we do not support actually sending an abort to the device, so
692 * this eh always fails. Still we must define it to make sure that we've
693 * dropped all references to the cmnd in question once this function exits.
695 static int uas_eh_abort_handler(struct scsi_cmnd *cmnd)
697 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
698 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
699 struct urb *data_in_urb = NULL;
700 struct urb *data_out_urb = NULL;
703 spin_lock_irqsave(&devinfo->lock, flags);
705 uas_log_cmd_state(cmnd, __func__, 0);
707 /* Ensure that try_complete does not call scsi_done */
708 cmdinfo->state |= COMMAND_ABORTED;
710 /* Drop all refs to this cmnd, kill data urbs to break their ref */
711 devinfo->cmnd[cmdinfo->uas_tag - 1] = NULL;
712 if (cmdinfo->state & DATA_IN_URB_INFLIGHT)
713 data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
714 if (cmdinfo->state & DATA_OUT_URB_INFLIGHT)
715 data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
717 uas_free_unsubmitted_urbs(cmnd);
719 spin_unlock_irqrestore(&devinfo->lock, flags);
722 usb_kill_urb(data_in_urb);
723 usb_put_urb(data_in_urb);
726 usb_kill_urb(data_out_urb);
727 usb_put_urb(data_out_urb);
733 static int uas_eh_device_reset_handler(struct scsi_cmnd *cmnd)
735 struct scsi_device *sdev = cmnd->device;
736 struct uas_dev_info *devinfo = sdev->hostdata;
737 struct usb_device *udev = devinfo->udev;
741 err = usb_lock_device_for_reset(udev, devinfo->intf);
743 shost_printk(KERN_ERR, sdev->host,
744 "%s FAILED to get lock err %d\n", __func__, err);
748 shost_printk(KERN_INFO, sdev->host, "%s start\n", __func__);
750 spin_lock_irqsave(&devinfo->lock, flags);
751 devinfo->resetting = 1;
752 spin_unlock_irqrestore(&devinfo->lock, flags);
754 usb_kill_anchored_urbs(&devinfo->cmd_urbs);
755 usb_kill_anchored_urbs(&devinfo->sense_urbs);
756 usb_kill_anchored_urbs(&devinfo->data_urbs);
757 uas_zap_pending(devinfo, DID_RESET);
759 err = usb_reset_device(udev);
761 spin_lock_irqsave(&devinfo->lock, flags);
762 devinfo->resetting = 0;
763 spin_unlock_irqrestore(&devinfo->lock, flags);
765 usb_unlock_device(udev);
768 shost_printk(KERN_INFO, sdev->host, "%s FAILED err %d\n",
773 shost_printk(KERN_INFO, sdev->host, "%s success\n", __func__);
777 static int uas_target_alloc(struct scsi_target *starget)
779 struct uas_dev_info *devinfo = (struct uas_dev_info *)
780 dev_to_shost(starget->dev.parent)->hostdata;
782 if (devinfo->flags & US_FL_NO_REPORT_LUNS)
783 starget->no_report_luns = 1;
788 static int uas_slave_alloc(struct scsi_device *sdev)
790 struct uas_dev_info *devinfo =
791 (struct uas_dev_info *)sdev->host->hostdata;
793 sdev->hostdata = devinfo;
796 * USB has unusual DMA-alignment requirements: Although the
797 * starting address of each scatter-gather element doesn't matter,
798 * the length of each element except the last must be divisible
799 * by the Bulk maxpacket value. There's currently no way to
800 * express this by block-layer constraints, so we'll cop out
801 * and simply require addresses to be aligned at 512-byte
802 * boundaries. This is okay since most block I/O involves
803 * hardware sectors that are multiples of 512 bytes in length,
804 * and since host controllers up through USB 2.0 have maxpacket
805 * values no larger than 512.
807 * But it doesn't suffice for Wireless USB, where Bulk maxpacket
808 * values can be as large as 2048. To make that work properly
809 * will require changes to the block layer.
811 blk_queue_update_dma_alignment(sdev->request_queue, (512 - 1));
813 if (devinfo->flags & US_FL_MAX_SECTORS_64)
814 blk_queue_max_hw_sectors(sdev->request_queue, 64);
815 else if (devinfo->flags & US_FL_MAX_SECTORS_240)
816 blk_queue_max_hw_sectors(sdev->request_queue, 240);
821 static int uas_slave_configure(struct scsi_device *sdev)
823 struct uas_dev_info *devinfo = sdev->hostdata;
825 if (devinfo->flags & US_FL_NO_REPORT_OPCODES)
826 sdev->no_report_opcodes = 1;
828 /* A few buggy USB-ATA bridges don't understand FUA */
829 if (devinfo->flags & US_FL_BROKEN_FUA)
830 sdev->broken_fua = 1;
832 /* UAS also needs to support FL_ALWAYS_SYNC */
833 if (devinfo->flags & US_FL_ALWAYS_SYNC) {
834 sdev->skip_ms_page_3f = 1;
835 sdev->skip_ms_page_8 = 1;
836 sdev->wce_default_on = 1;
840 * Some disks return the total number of blocks in response
841 * to READ CAPACITY rather than the highest block number.
842 * If this device makes that mistake, tell the sd driver.
844 if (devinfo->flags & US_FL_FIX_CAPACITY)
845 sdev->fix_capacity = 1;
848 * Some devices don't like MODE SENSE with page=0x3f,
849 * which is the command used for checking if a device
850 * is write-protected. Now that we tell the sd driver
851 * to do a 192-byte transfer with this command the
852 * majority of devices work fine, but a few still can't
853 * handle it. The sd driver will simply assume those
854 * devices are write-enabled.
856 if (devinfo->flags & US_FL_NO_WP_DETECT)
857 sdev->skip_ms_page_3f = 1;
859 scsi_change_queue_depth(sdev, devinfo->qdepth - 2);
863 static struct scsi_host_template uas_host_template = {
864 .module = THIS_MODULE,
866 .queuecommand = uas_queuecommand,
867 .target_alloc = uas_target_alloc,
868 .slave_alloc = uas_slave_alloc,
869 .slave_configure = uas_slave_configure,
870 .eh_abort_handler = uas_eh_abort_handler,
871 .eh_device_reset_handler = uas_eh_device_reset_handler,
873 .sg_tablesize = SG_NONE,
874 .skip_settle_delay = 1,
875 .dma_boundary = PAGE_SIZE - 1,
878 #define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \
879 vendorName, productName, useProtocol, useTransport, \
880 initFunction, flags) \
881 { USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax), \
882 .driver_info = (flags) }
884 static struct usb_device_id uas_usb_ids[] = {
885 # include "unusual_uas.h"
886 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_BULK) },
887 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_UAS) },
890 MODULE_DEVICE_TABLE(usb, uas_usb_ids);
894 static int uas_switch_interface(struct usb_device *udev,
895 struct usb_interface *intf)
897 struct usb_host_interface *alt;
899 alt = uas_find_uas_alt_setting(intf);
903 return usb_set_interface(udev, alt->desc.bInterfaceNumber,
904 alt->desc.bAlternateSetting);
907 static int uas_configure_endpoints(struct uas_dev_info *devinfo)
909 struct usb_host_endpoint *eps[4] = { };
910 struct usb_device *udev = devinfo->udev;
913 r = uas_find_endpoints(devinfo->intf->cur_altsetting, eps);
917 devinfo->cmd_pipe = usb_sndbulkpipe(udev,
918 usb_endpoint_num(&eps[0]->desc));
919 devinfo->status_pipe = usb_rcvbulkpipe(udev,
920 usb_endpoint_num(&eps[1]->desc));
921 devinfo->data_in_pipe = usb_rcvbulkpipe(udev,
922 usb_endpoint_num(&eps[2]->desc));
923 devinfo->data_out_pipe = usb_sndbulkpipe(udev,
924 usb_endpoint_num(&eps[3]->desc));
926 if (udev->speed < USB_SPEED_SUPER) {
927 devinfo->qdepth = 32;
928 devinfo->use_streams = 0;
930 devinfo->qdepth = usb_alloc_streams(devinfo->intf, eps + 1,
931 3, MAX_CMNDS, GFP_NOIO);
932 if (devinfo->qdepth < 0)
933 return devinfo->qdepth;
934 devinfo->use_streams = 1;
940 static void uas_free_streams(struct uas_dev_info *devinfo)
942 struct usb_device *udev = devinfo->udev;
943 struct usb_host_endpoint *eps[3];
945 eps[0] = usb_pipe_endpoint(udev, devinfo->status_pipe);
946 eps[1] = usb_pipe_endpoint(udev, devinfo->data_in_pipe);
947 eps[2] = usb_pipe_endpoint(udev, devinfo->data_out_pipe);
948 usb_free_streams(devinfo->intf, eps, 3, GFP_NOIO);
951 static int uas_probe(struct usb_interface *intf, const struct usb_device_id *id)
953 int result = -ENOMEM;
954 struct Scsi_Host *shost = NULL;
955 struct uas_dev_info *devinfo;
956 struct usb_device *udev = interface_to_usbdev(intf);
957 unsigned long dev_flags;
959 if (!uas_use_uas_driver(intf, id, &dev_flags))
962 if (uas_switch_interface(udev, intf))
965 shost = scsi_host_alloc(&uas_host_template,
966 sizeof(struct uas_dev_info));
970 shost->max_cmd_len = 16 + 252;
972 shost->max_lun = 256;
973 shost->max_channel = 0;
974 shost->sg_tablesize = udev->bus->sg_tablesize;
976 devinfo = (struct uas_dev_info *)shost->hostdata;
977 devinfo->intf = intf;
978 devinfo->udev = udev;
979 devinfo->resetting = 0;
980 devinfo->shutdown = 0;
981 devinfo->flags = dev_flags;
982 init_usb_anchor(&devinfo->cmd_urbs);
983 init_usb_anchor(&devinfo->sense_urbs);
984 init_usb_anchor(&devinfo->data_urbs);
985 spin_lock_init(&devinfo->lock);
986 INIT_WORK(&devinfo->work, uas_do_work);
988 result = uas_configure_endpoints(devinfo);
993 * 1 tag is reserved for untagged commands +
994 * 1 tag to avoid off by one errors in some bridge firmwares
996 shost->can_queue = devinfo->qdepth - 2;
998 usb_set_intfdata(intf, shost);
999 result = scsi_add_host(shost, &intf->dev);
1003 scsi_scan_host(shost);
1007 uas_free_streams(devinfo);
1008 usb_set_intfdata(intf, NULL);
1010 usb_set_interface(udev, intf->altsetting[0].desc.bInterfaceNumber, 0);
1012 scsi_host_put(shost);
1016 static int uas_cmnd_list_empty(struct uas_dev_info *devinfo)
1018 unsigned long flags;
1021 spin_lock_irqsave(&devinfo->lock, flags);
1023 for (i = 0; i < devinfo->qdepth; i++) {
1024 if (devinfo->cmnd[i]) {
1025 r = 0; /* Not empty */
1030 spin_unlock_irqrestore(&devinfo->lock, flags);
1036 * Wait for any pending cmnds to complete, on usb-2 sense_urbs may temporarily
1037 * get empty while there still is more work to do due to sense-urbs completing
1038 * with a READ/WRITE_READY iu code, so keep waiting until the list gets empty.
1040 static int uas_wait_for_pending_cmnds(struct uas_dev_info *devinfo)
1042 unsigned long start_time;
1045 start_time = jiffies;
1047 flush_work(&devinfo->work);
1049 r = usb_wait_anchor_empty_timeout(&devinfo->sense_urbs, 5000);
1053 r = usb_wait_anchor_empty_timeout(&devinfo->data_urbs, 500);
1057 if (time_after(jiffies, start_time + 5 * HZ))
1059 } while (!uas_cmnd_list_empty(devinfo));
1064 static int uas_pre_reset(struct usb_interface *intf)
1066 struct Scsi_Host *shost = usb_get_intfdata(intf);
1067 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1068 unsigned long flags;
1070 if (devinfo->shutdown)
1073 /* Block new requests */
1074 spin_lock_irqsave(shost->host_lock, flags);
1075 scsi_block_requests(shost);
1076 spin_unlock_irqrestore(shost->host_lock, flags);
1078 if (uas_wait_for_pending_cmnds(devinfo) != 0) {
1079 shost_printk(KERN_ERR, shost, "%s: timed out\n", __func__);
1080 scsi_unblock_requests(shost);
1084 uas_free_streams(devinfo);
1089 static int uas_post_reset(struct usb_interface *intf)
1091 struct Scsi_Host *shost = usb_get_intfdata(intf);
1092 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1093 unsigned long flags;
1096 if (devinfo->shutdown)
1099 err = uas_configure_endpoints(devinfo);
1100 if (err && err != -ENODEV)
1101 shost_printk(KERN_ERR, shost,
1102 "%s: alloc streams error %d after reset",
1105 /* we must unblock the host in every case lest we deadlock */
1106 spin_lock_irqsave(shost->host_lock, flags);
1107 scsi_report_bus_reset(shost, 0);
1108 spin_unlock_irqrestore(shost->host_lock, flags);
1110 scsi_unblock_requests(shost);
1115 static int uas_suspend(struct usb_interface *intf, pm_message_t message)
1117 struct Scsi_Host *shost = usb_get_intfdata(intf);
1118 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1120 if (uas_wait_for_pending_cmnds(devinfo) != 0) {
1121 shost_printk(KERN_ERR, shost, "%s: timed out\n", __func__);
1128 static int uas_resume(struct usb_interface *intf)
1133 static int uas_reset_resume(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 err = uas_configure_endpoints(devinfo);
1142 shost_printk(KERN_ERR, shost,
1143 "%s: alloc streams error %d after reset",
1148 spin_lock_irqsave(shost->host_lock, flags);
1149 scsi_report_bus_reset(shost, 0);
1150 spin_unlock_irqrestore(shost->host_lock, flags);
1155 static void uas_disconnect(struct usb_interface *intf)
1157 struct Scsi_Host *shost = usb_get_intfdata(intf);
1158 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1159 unsigned long flags;
1161 spin_lock_irqsave(&devinfo->lock, flags);
1162 devinfo->resetting = 1;
1163 spin_unlock_irqrestore(&devinfo->lock, flags);
1165 cancel_work_sync(&devinfo->work);
1166 usb_kill_anchored_urbs(&devinfo->cmd_urbs);
1167 usb_kill_anchored_urbs(&devinfo->sense_urbs);
1168 usb_kill_anchored_urbs(&devinfo->data_urbs);
1169 uas_zap_pending(devinfo, DID_NO_CONNECT);
1171 scsi_remove_host(shost);
1172 uas_free_streams(devinfo);
1173 scsi_host_put(shost);
1177 * Put the device back in usb-storage mode on shutdown, as some BIOS-es
1178 * hang on reboot when the device is still in uas mode. Note the reset is
1179 * necessary as some devices won't revert to usb-storage mode without it.
1181 static void uas_shutdown(struct device *dev)
1183 struct usb_interface *intf = to_usb_interface(dev);
1184 struct usb_device *udev = interface_to_usbdev(intf);
1185 struct Scsi_Host *shost = usb_get_intfdata(intf);
1186 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1188 if (system_state != SYSTEM_RESTART)
1191 devinfo->shutdown = 1;
1192 uas_free_streams(devinfo);
1193 usb_set_interface(udev, intf->altsetting[0].desc.bInterfaceNumber, 0);
1194 usb_reset_device(udev);
1197 static struct usb_driver uas_driver = {
1200 .disconnect = uas_disconnect,
1201 .pre_reset = uas_pre_reset,
1202 .post_reset = uas_post_reset,
1203 .suspend = uas_suspend,
1204 .resume = uas_resume,
1205 .reset_resume = uas_reset_resume,
1206 .drvwrap.driver.shutdown = uas_shutdown,
1207 .id_table = uas_usb_ids,
1210 module_usb_driver(uas_driver);
1212 MODULE_LICENSE("GPL");
1214 "Hans de Goede <hdegoede@redhat.com>, Matthew Wilcox and Sarah Sharp");