3 * Note that this is not the same as the USB Mass Storage driver
5 * Copyright Hans de Goede <hdegoede@redhat.com> for Red Hat, Inc. 2013 - 2014
6 * Copyright Matthew Wilcox for Intel Corp, 2010
7 * Copyright Sarah Sharp for Intel Corp, 2010
9 * Distributed under the terms of the GNU GPL, version two.
12 #include <linux/blkdev.h>
13 #include <linux/slab.h>
14 #include <linux/types.h>
15 #include <linux/module.h>
16 #include <linux/usb.h>
17 #include <linux/usb_usual.h>
18 #include <linux/usb/hcd.h>
19 #include <linux/usb/storage.h>
20 #include <linux/usb/uas.h>
22 #include <scsi/scsi.h>
23 #include <scsi/scsi_eh.h>
24 #include <scsi/scsi_dbg.h>
25 #include <scsi/scsi_cmnd.h>
26 #include <scsi/scsi_device.h>
27 #include <scsi/scsi_host.h>
28 #include <scsi/scsi_tcq.h>
30 #include "uas-detect.h"
36 * The r00-r01c specs define this version of the SENSE IU data structure.
37 * It's still in use by several different firmware releases.
45 __u8 service_response;
46 __u8 sense[SCSI_SENSE_BUFFERSIZE];
50 struct usb_interface *intf;
51 struct usb_device *udev;
52 struct usb_anchor cmd_urbs;
53 struct usb_anchor sense_urbs;
54 struct usb_anchor data_urbs;
56 int qdepth, resetting;
57 unsigned cmd_pipe, status_pipe, data_in_pipe, data_out_pipe;
58 unsigned use_streams:1;
59 unsigned uas_sense_old:1;
61 struct scsi_cmnd *cmnd[MAX_CMNDS];
63 struct work_struct work;
67 SUBMIT_STATUS_URB = (1 << 1),
68 ALLOC_DATA_IN_URB = (1 << 2),
69 SUBMIT_DATA_IN_URB = (1 << 3),
70 ALLOC_DATA_OUT_URB = (1 << 4),
71 SUBMIT_DATA_OUT_URB = (1 << 5),
72 ALLOC_CMD_URB = (1 << 6),
73 SUBMIT_CMD_URB = (1 << 7),
74 COMMAND_INFLIGHT = (1 << 8),
75 DATA_IN_URB_INFLIGHT = (1 << 9),
76 DATA_OUT_URB_INFLIGHT = (1 << 10),
77 COMMAND_ABORTED = (1 << 11),
78 IS_IN_WORK_LIST = (1 << 12),
81 /* Overrides scsi_pointer */
86 struct urb *data_in_urb;
87 struct urb *data_out_urb;
90 /* I hate forward declarations, but I actually have a loop */
91 static int uas_submit_urbs(struct scsi_cmnd *cmnd,
92 struct uas_dev_info *devinfo, gfp_t gfp);
93 static void uas_do_work(struct work_struct *work);
94 static int uas_try_complete(struct scsi_cmnd *cmnd, const char *caller);
95 static void uas_free_streams(struct uas_dev_info *devinfo);
96 static void uas_log_cmd_state(struct scsi_cmnd *cmnd, const char *caller);
98 static void uas_do_work(struct work_struct *work)
100 struct uas_dev_info *devinfo =
101 container_of(work, struct uas_dev_info, work);
102 struct uas_cmd_info *cmdinfo;
103 struct scsi_cmnd *cmnd;
107 spin_lock_irqsave(&devinfo->lock, flags);
109 if (devinfo->resetting)
112 for (i = 0; i < devinfo->qdepth; i++) {
113 if (!devinfo->cmnd[i])
116 cmnd = devinfo->cmnd[i];
117 cmdinfo = (void *)&cmnd->SCp;
119 if (!(cmdinfo->state & IS_IN_WORK_LIST))
122 err = uas_submit_urbs(cmnd, cmnd->device->hostdata, GFP_ATOMIC);
124 cmdinfo->state &= ~IS_IN_WORK_LIST;
126 schedule_work(&devinfo->work);
129 spin_unlock_irqrestore(&devinfo->lock, flags);
132 static void uas_add_work(struct uas_cmd_info *cmdinfo)
134 struct scsi_pointer *scp = (void *)cmdinfo;
135 struct scsi_cmnd *cmnd = container_of(scp, struct scsi_cmnd, SCp);
136 struct uas_dev_info *devinfo = cmnd->device->hostdata;
138 lockdep_assert_held(&devinfo->lock);
139 cmdinfo->state |= IS_IN_WORK_LIST;
140 schedule_work(&devinfo->work);
143 static void uas_zap_pending(struct uas_dev_info *devinfo, int result)
145 struct uas_cmd_info *cmdinfo;
146 struct scsi_cmnd *cmnd;
150 spin_lock_irqsave(&devinfo->lock, flags);
151 for (i = 0; i < devinfo->qdepth; i++) {
152 if (!devinfo->cmnd[i])
155 cmnd = devinfo->cmnd[i];
156 cmdinfo = (void *)&cmnd->SCp;
157 uas_log_cmd_state(cmnd, __func__);
158 /* Sense urbs were killed, clear COMMAND_INFLIGHT manually */
159 cmdinfo->state &= ~COMMAND_INFLIGHT;
160 cmnd->result = result << 16;
161 err = uas_try_complete(cmnd, __func__);
164 spin_unlock_irqrestore(&devinfo->lock, flags);
167 static void uas_sense(struct urb *urb, struct scsi_cmnd *cmnd)
169 struct sense_iu *sense_iu = urb->transfer_buffer;
170 struct scsi_device *sdev = cmnd->device;
172 if (urb->actual_length > 16) {
173 unsigned len = be16_to_cpup(&sense_iu->len);
174 if (len + 16 != urb->actual_length) {
175 int newlen = min(len + 16, urb->actual_length) - 16;
178 sdev_printk(KERN_INFO, sdev, "%s: urb length %d "
179 "disagrees with IU sense data length %d, "
180 "using %d bytes of sense data\n", __func__,
181 urb->actual_length, len, newlen);
184 memcpy(cmnd->sense_buffer, sense_iu->sense, len);
187 cmnd->result = sense_iu->status;
190 static void uas_sense_old(struct urb *urb, struct scsi_cmnd *cmnd)
192 struct sense_iu_old *sense_iu = urb->transfer_buffer;
193 struct scsi_device *sdev = cmnd->device;
195 if (urb->actual_length > 8) {
196 unsigned len = be16_to_cpup(&sense_iu->len) - 2;
197 if (len + 8 != urb->actual_length) {
198 int newlen = min(len + 8, urb->actual_length) - 8;
201 sdev_printk(KERN_INFO, sdev, "%s: urb length %d "
202 "disagrees with IU sense data length %d, "
203 "using %d bytes of sense data\n", __func__,
204 urb->actual_length, len, newlen);
207 memcpy(cmnd->sense_buffer, sense_iu->sense, len);
210 cmnd->result = sense_iu->status;
214 * scsi-tags go from 0 - (nr_tags - 1), uas tags need to match stream-ids,
215 * which go from 1 - nr_streams. And we use 1 for untagged commands.
217 static int uas_get_tag(struct scsi_cmnd *cmnd)
221 if (blk_rq_tagged(cmnd->request))
222 tag = cmnd->request->tag + 2;
229 static void uas_log_cmd_state(struct scsi_cmnd *cmnd, const char *caller)
231 struct uas_cmd_info *ci = (void *)&cmnd->SCp;
233 scmd_printk(KERN_INFO, cmnd,
234 "%s tag %d inflight:%s%s%s%s%s%s%s%s%s%s%s%s ",
235 caller, uas_get_tag(cmnd),
236 (ci->state & SUBMIT_STATUS_URB) ? " s-st" : "",
237 (ci->state & ALLOC_DATA_IN_URB) ? " a-in" : "",
238 (ci->state & SUBMIT_DATA_IN_URB) ? " s-in" : "",
239 (ci->state & ALLOC_DATA_OUT_URB) ? " a-out" : "",
240 (ci->state & SUBMIT_DATA_OUT_URB) ? " s-out" : "",
241 (ci->state & ALLOC_CMD_URB) ? " a-cmd" : "",
242 (ci->state & SUBMIT_CMD_URB) ? " s-cmd" : "",
243 (ci->state & COMMAND_INFLIGHT) ? " CMD" : "",
244 (ci->state & DATA_IN_URB_INFLIGHT) ? " IN" : "",
245 (ci->state & DATA_OUT_URB_INFLIGHT) ? " OUT" : "",
246 (ci->state & COMMAND_ABORTED) ? " abort" : "",
247 (ci->state & IS_IN_WORK_LIST) ? " work" : "");
248 scsi_print_command(cmnd);
251 static void uas_free_unsubmitted_urbs(struct scsi_cmnd *cmnd)
253 struct uas_cmd_info *cmdinfo;
258 cmdinfo = (void *)&cmnd->SCp;
260 if (cmdinfo->state & SUBMIT_CMD_URB)
261 usb_free_urb(cmdinfo->cmd_urb);
263 /* data urbs may have never gotten their submit flag set */
264 if (!(cmdinfo->state & DATA_IN_URB_INFLIGHT))
265 usb_free_urb(cmdinfo->data_in_urb);
266 if (!(cmdinfo->state & DATA_OUT_URB_INFLIGHT))
267 usb_free_urb(cmdinfo->data_out_urb);
270 static int uas_try_complete(struct scsi_cmnd *cmnd, const char *caller)
272 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
273 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
275 lockdep_assert_held(&devinfo->lock);
276 if (cmdinfo->state & (COMMAND_INFLIGHT |
277 DATA_IN_URB_INFLIGHT |
278 DATA_OUT_URB_INFLIGHT |
281 devinfo->cmnd[uas_get_tag(cmnd) - 1] = NULL;
282 uas_free_unsubmitted_urbs(cmnd);
283 cmnd->scsi_done(cmnd);
287 static void uas_xfer_data(struct urb *urb, struct scsi_cmnd *cmnd,
290 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
293 cmdinfo->state |= direction | SUBMIT_STATUS_URB;
294 err = uas_submit_urbs(cmnd, cmnd->device->hostdata, GFP_ATOMIC);
296 uas_add_work(cmdinfo);
300 static void uas_stat_cmplt(struct urb *urb)
302 struct iu *iu = urb->transfer_buffer;
303 struct Scsi_Host *shost = urb->context;
304 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
305 struct urb *data_in_urb = NULL;
306 struct urb *data_out_urb = NULL;
307 struct scsi_cmnd *cmnd;
308 struct uas_cmd_info *cmdinfo;
312 spin_lock_irqsave(&devinfo->lock, flags);
314 if (devinfo->resetting)
318 if (urb->status != -ENOENT && urb->status != -ECONNRESET) {
319 dev_err(&urb->dev->dev, "stat urb: status %d\n",
325 idx = be16_to_cpup(&iu->tag) - 1;
326 if (idx >= MAX_CMNDS || !devinfo->cmnd[idx]) {
327 dev_err(&urb->dev->dev,
328 "stat urb: no pending cmd for tag %d\n", idx + 1);
332 cmnd = devinfo->cmnd[idx];
333 cmdinfo = (void *)&cmnd->SCp;
335 if (!(cmdinfo->state & COMMAND_INFLIGHT)) {
336 scmd_printk(KERN_ERR, cmnd, "unexpected status cmplt\n");
342 if (urb->actual_length < 16)
343 devinfo->uas_sense_old = 1;
344 if (devinfo->uas_sense_old)
345 uas_sense_old(urb, cmnd);
347 uas_sense(urb, cmnd);
348 if (cmnd->result != 0) {
349 /* cancel data transfers on error */
350 data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
351 data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
353 cmdinfo->state &= ~COMMAND_INFLIGHT;
354 uas_try_complete(cmnd, __func__);
356 case IU_ID_READ_READY:
357 if (!cmdinfo->data_in_urb ||
358 (cmdinfo->state & DATA_IN_URB_INFLIGHT)) {
359 scmd_printk(KERN_ERR, cmnd, "unexpected read rdy\n");
362 uas_xfer_data(urb, cmnd, SUBMIT_DATA_IN_URB);
364 case IU_ID_WRITE_READY:
365 if (!cmdinfo->data_out_urb ||
366 (cmdinfo->state & DATA_OUT_URB_INFLIGHT)) {
367 scmd_printk(KERN_ERR, cmnd, "unexpected write rdy\n");
370 uas_xfer_data(urb, cmnd, SUBMIT_DATA_OUT_URB);
373 scmd_printk(KERN_ERR, cmnd,
374 "Bogus IU (%d) received on status pipe\n", iu->iu_id);
378 spin_unlock_irqrestore(&devinfo->lock, flags);
380 /* Unlinking of data urbs must be done without holding the lock */
382 usb_unlink_urb(data_in_urb);
383 usb_put_urb(data_in_urb);
386 usb_unlink_urb(data_out_urb);
387 usb_put_urb(data_out_urb);
391 static void uas_data_cmplt(struct urb *urb)
393 struct scsi_cmnd *cmnd = urb->context;
394 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
395 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
396 struct scsi_data_buffer *sdb = NULL;
399 spin_lock_irqsave(&devinfo->lock, flags);
401 if (cmdinfo->data_in_urb == urb) {
403 cmdinfo->state &= ~DATA_IN_URB_INFLIGHT;
404 cmdinfo->data_in_urb = NULL;
405 } else if (cmdinfo->data_out_urb == urb) {
406 sdb = scsi_out(cmnd);
407 cmdinfo->state &= ~DATA_OUT_URB_INFLIGHT;
408 cmdinfo->data_out_urb = NULL;
415 if (devinfo->resetting)
418 /* Data urbs should not complete before the cmd urb is submitted */
419 if (cmdinfo->state & SUBMIT_CMD_URB) {
420 scmd_printk(KERN_ERR, cmnd, "unexpected data cmplt\n");
425 if (urb->status != -ENOENT && urb->status != -ECONNRESET) {
426 uas_log_cmd_state(cmnd, __func__);
427 scmd_printk(KERN_ERR, cmnd,
428 "data cmplt err %d stream %d\n",
429 urb->status, urb->stream_id);
431 /* error: no data transfered */
432 sdb->resid = sdb->length;
434 sdb->resid = sdb->length - urb->actual_length;
436 uas_try_complete(cmnd, __func__);
439 spin_unlock_irqrestore(&devinfo->lock, flags);
442 static void uas_cmd_cmplt(struct urb *urb)
445 dev_err(&urb->dev->dev, "cmd cmplt err %d\n", urb->status);
450 static struct urb *uas_alloc_data_urb(struct uas_dev_info *devinfo, gfp_t gfp,
451 unsigned int pipe, u16 stream_id,
452 struct scsi_cmnd *cmnd,
453 enum dma_data_direction dir)
455 struct usb_device *udev = devinfo->udev;
456 struct urb *urb = usb_alloc_urb(0, gfp);
457 struct scsi_data_buffer *sdb = (dir == DMA_FROM_DEVICE)
458 ? scsi_in(cmnd) : scsi_out(cmnd);
462 usb_fill_bulk_urb(urb, udev, pipe, NULL, sdb->length,
463 uas_data_cmplt, cmnd);
464 urb->stream_id = stream_id;
465 urb->num_sgs = udev->bus->sg_tablesize ? sdb->table.nents : 0;
466 urb->sg = sdb->table.sgl;
471 static struct urb *uas_alloc_sense_urb(struct uas_dev_info *devinfo, gfp_t gfp,
472 struct Scsi_Host *shost, u16 stream_id)
474 struct usb_device *udev = devinfo->udev;
475 struct urb *urb = usb_alloc_urb(0, gfp);
481 iu = kzalloc(sizeof(*iu), gfp);
485 usb_fill_bulk_urb(urb, udev, devinfo->status_pipe, iu, sizeof(*iu),
486 uas_stat_cmplt, shost);
487 urb->stream_id = stream_id;
488 urb->transfer_flags |= URB_FREE_BUFFER;
496 static struct urb *uas_alloc_cmd_urb(struct uas_dev_info *devinfo, gfp_t gfp,
497 struct scsi_cmnd *cmnd)
499 struct usb_device *udev = devinfo->udev;
500 struct scsi_device *sdev = cmnd->device;
501 struct urb *urb = usb_alloc_urb(0, gfp);
502 struct command_iu *iu;
508 len = cmnd->cmd_len - 16;
512 iu = kzalloc(sizeof(*iu) + len, gfp);
516 iu->iu_id = IU_ID_COMMAND;
517 iu->tag = cpu_to_be16(uas_get_tag(cmnd));
518 iu->prio_attr = UAS_SIMPLE_TAG;
520 int_to_scsilun(sdev->lun, &iu->lun);
521 memcpy(iu->cdb, cmnd->cmnd, cmnd->cmd_len);
523 usb_fill_bulk_urb(urb, udev, devinfo->cmd_pipe, iu, sizeof(*iu) + len,
524 uas_cmd_cmplt, NULL);
525 urb->transfer_flags |= URB_FREE_BUFFER;
534 * Why should I request the Status IU before sending the Command IU? Spec
535 * says to, but also says the device may receive them in any order. Seems
539 static struct urb *uas_submit_sense_urb(struct scsi_cmnd *cmnd,
540 gfp_t gfp, unsigned int stream)
542 struct Scsi_Host *shost = cmnd->device->host;
543 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
547 urb = uas_alloc_sense_urb(devinfo, gfp, shost, stream);
550 usb_anchor_urb(urb, &devinfo->sense_urbs);
551 err = usb_submit_urb(urb, gfp);
553 usb_unanchor_urb(urb);
554 uas_log_cmd_state(cmnd, __func__);
555 shost_printk(KERN_INFO, shost,
556 "sense urb submission error %d stream %d\n",
564 static int uas_submit_urbs(struct scsi_cmnd *cmnd,
565 struct uas_dev_info *devinfo, gfp_t gfp)
567 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
571 lockdep_assert_held(&devinfo->lock);
572 if (cmdinfo->state & SUBMIT_STATUS_URB) {
573 urb = uas_submit_sense_urb(cmnd, gfp, cmdinfo->stream);
575 return SCSI_MLQUEUE_DEVICE_BUSY;
576 cmdinfo->state &= ~SUBMIT_STATUS_URB;
579 if (cmdinfo->state & ALLOC_DATA_IN_URB) {
580 cmdinfo->data_in_urb = uas_alloc_data_urb(devinfo, gfp,
581 devinfo->data_in_pipe, cmdinfo->stream,
582 cmnd, DMA_FROM_DEVICE);
583 if (!cmdinfo->data_in_urb)
584 return SCSI_MLQUEUE_DEVICE_BUSY;
585 cmdinfo->state &= ~ALLOC_DATA_IN_URB;
588 if (cmdinfo->state & SUBMIT_DATA_IN_URB) {
589 usb_anchor_urb(cmdinfo->data_in_urb, &devinfo->data_urbs);
590 err = usb_submit_urb(cmdinfo->data_in_urb, gfp);
592 usb_unanchor_urb(cmdinfo->data_in_urb);
593 uas_log_cmd_state(cmnd, __func__);
594 scmd_printk(KERN_INFO, cmnd,
595 "data in urb submission error %d stream %d\n",
596 err, cmdinfo->data_in_urb->stream_id);
597 return SCSI_MLQUEUE_DEVICE_BUSY;
599 cmdinfo->state &= ~SUBMIT_DATA_IN_URB;
600 cmdinfo->state |= DATA_IN_URB_INFLIGHT;
603 if (cmdinfo->state & ALLOC_DATA_OUT_URB) {
604 cmdinfo->data_out_urb = uas_alloc_data_urb(devinfo, gfp,
605 devinfo->data_out_pipe, cmdinfo->stream,
606 cmnd, DMA_TO_DEVICE);
607 if (!cmdinfo->data_out_urb)
608 return SCSI_MLQUEUE_DEVICE_BUSY;
609 cmdinfo->state &= ~ALLOC_DATA_OUT_URB;
612 if (cmdinfo->state & SUBMIT_DATA_OUT_URB) {
613 usb_anchor_urb(cmdinfo->data_out_urb, &devinfo->data_urbs);
614 err = usb_submit_urb(cmdinfo->data_out_urb, gfp);
616 usb_unanchor_urb(cmdinfo->data_out_urb);
617 uas_log_cmd_state(cmnd, __func__);
618 scmd_printk(KERN_INFO, cmnd,
619 "data out urb submission error %d stream %d\n",
620 err, cmdinfo->data_out_urb->stream_id);
621 return SCSI_MLQUEUE_DEVICE_BUSY;
623 cmdinfo->state &= ~SUBMIT_DATA_OUT_URB;
624 cmdinfo->state |= DATA_OUT_URB_INFLIGHT;
627 if (cmdinfo->state & ALLOC_CMD_URB) {
628 cmdinfo->cmd_urb = uas_alloc_cmd_urb(devinfo, gfp, cmnd);
629 if (!cmdinfo->cmd_urb)
630 return SCSI_MLQUEUE_DEVICE_BUSY;
631 cmdinfo->state &= ~ALLOC_CMD_URB;
634 if (cmdinfo->state & SUBMIT_CMD_URB) {
635 usb_anchor_urb(cmdinfo->cmd_urb, &devinfo->cmd_urbs);
636 err = usb_submit_urb(cmdinfo->cmd_urb, gfp);
638 usb_unanchor_urb(cmdinfo->cmd_urb);
639 uas_log_cmd_state(cmnd, __func__);
640 scmd_printk(KERN_INFO, cmnd,
641 "cmd urb submission error %d\n", err);
642 return SCSI_MLQUEUE_DEVICE_BUSY;
644 cmdinfo->cmd_urb = NULL;
645 cmdinfo->state &= ~SUBMIT_CMD_URB;
646 cmdinfo->state |= COMMAND_INFLIGHT;
652 static int uas_queuecommand_lck(struct scsi_cmnd *cmnd,
653 void (*done)(struct scsi_cmnd *))
655 struct scsi_device *sdev = cmnd->device;
656 struct uas_dev_info *devinfo = sdev->hostdata;
657 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
662 BUILD_BUG_ON(sizeof(struct uas_cmd_info) > sizeof(struct scsi_pointer));
664 /* Re-check scsi_block_requests now that we've the host-lock */
665 if (cmnd->device->host->host_self_blocked)
666 return SCSI_MLQUEUE_DEVICE_BUSY;
668 if ((devinfo->flags & US_FL_NO_ATA_1X) &&
669 (cmnd->cmnd[0] == ATA_12 || cmnd->cmnd[0] == ATA_16)) {
670 memcpy(cmnd->sense_buffer, usb_stor_sense_invalidCDB,
671 sizeof(usb_stor_sense_invalidCDB));
672 cmnd->result = SAM_STAT_CHECK_CONDITION;
673 cmnd->scsi_done(cmnd);
677 spin_lock_irqsave(&devinfo->lock, flags);
679 if (devinfo->resetting) {
680 cmnd->result = DID_ERROR << 16;
681 cmnd->scsi_done(cmnd);
682 spin_unlock_irqrestore(&devinfo->lock, flags);
686 stream = uas_get_tag(cmnd);
687 if (devinfo->cmnd[stream - 1]) {
688 spin_unlock_irqrestore(&devinfo->lock, flags);
689 return SCSI_MLQUEUE_DEVICE_BUSY;
692 cmnd->scsi_done = done;
694 memset(cmdinfo, 0, sizeof(*cmdinfo));
695 cmdinfo->stream = stream;
696 cmdinfo->state = SUBMIT_STATUS_URB | ALLOC_CMD_URB | SUBMIT_CMD_URB;
698 switch (cmnd->sc_data_direction) {
699 case DMA_FROM_DEVICE:
700 cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
702 case DMA_BIDIRECTIONAL:
703 cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
705 cmdinfo->state |= ALLOC_DATA_OUT_URB | SUBMIT_DATA_OUT_URB;
710 if (!devinfo->use_streams) {
711 cmdinfo->state &= ~(SUBMIT_DATA_IN_URB | SUBMIT_DATA_OUT_URB);
715 err = uas_submit_urbs(cmnd, devinfo, GFP_ATOMIC);
717 /* If we did nothing, give up now */
718 if (cmdinfo->state & SUBMIT_STATUS_URB) {
719 spin_unlock_irqrestore(&devinfo->lock, flags);
720 return SCSI_MLQUEUE_DEVICE_BUSY;
722 uas_add_work(cmdinfo);
725 devinfo->cmnd[stream - 1] = cmnd;
726 spin_unlock_irqrestore(&devinfo->lock, flags);
730 static DEF_SCSI_QCMD(uas_queuecommand)
733 * For now we do not support actually sending an abort to the device, so
734 * this eh always fails. Still we must define it to make sure that we've
735 * dropped all references to the cmnd in question once this function exits.
737 static int uas_eh_abort_handler(struct scsi_cmnd *cmnd)
739 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
740 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
741 struct urb *data_in_urb = NULL;
742 struct urb *data_out_urb = NULL;
745 spin_lock_irqsave(&devinfo->lock, flags);
747 uas_log_cmd_state(cmnd, __func__);
749 /* Ensure that try_complete does not call scsi_done */
750 cmdinfo->state |= COMMAND_ABORTED;
752 /* Drop all refs to this cmnd, kill data urbs to break their ref */
753 devinfo->cmnd[uas_get_tag(cmnd) - 1] = NULL;
754 if (cmdinfo->state & DATA_IN_URB_INFLIGHT)
755 data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
756 if (cmdinfo->state & DATA_OUT_URB_INFLIGHT)
757 data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
759 uas_free_unsubmitted_urbs(cmnd);
761 spin_unlock_irqrestore(&devinfo->lock, flags);
764 usb_kill_urb(data_in_urb);
765 usb_put_urb(data_in_urb);
768 usb_kill_urb(data_out_urb);
769 usb_put_urb(data_out_urb);
775 static int uas_eh_bus_reset_handler(struct scsi_cmnd *cmnd)
777 struct scsi_device *sdev = cmnd->device;
778 struct uas_dev_info *devinfo = sdev->hostdata;
779 struct usb_device *udev = devinfo->udev;
783 err = usb_lock_device_for_reset(udev, devinfo->intf);
785 shost_printk(KERN_ERR, sdev->host,
786 "%s FAILED to get lock err %d\n", __func__, err);
790 shost_printk(KERN_INFO, sdev->host, "%s start\n", __func__);
792 spin_lock_irqsave(&devinfo->lock, flags);
793 devinfo->resetting = 1;
794 spin_unlock_irqrestore(&devinfo->lock, flags);
796 usb_kill_anchored_urbs(&devinfo->cmd_urbs);
797 usb_kill_anchored_urbs(&devinfo->sense_urbs);
798 usb_kill_anchored_urbs(&devinfo->data_urbs);
799 uas_zap_pending(devinfo, DID_RESET);
801 err = usb_reset_device(udev);
803 spin_lock_irqsave(&devinfo->lock, flags);
804 devinfo->resetting = 0;
805 spin_unlock_irqrestore(&devinfo->lock, flags);
807 usb_unlock_device(udev);
810 shost_printk(KERN_INFO, sdev->host, "%s FAILED\n", __func__);
814 shost_printk(KERN_INFO, sdev->host, "%s success\n", __func__);
818 static int uas_slave_alloc(struct scsi_device *sdev)
820 sdev->hostdata = (void *)sdev->host->hostdata;
822 /* USB has unusual DMA-alignment requirements: Although the
823 * starting address of each scatter-gather element doesn't matter,
824 * the length of each element except the last must be divisible
825 * by the Bulk maxpacket value. There's currently no way to
826 * express this by block-layer constraints, so we'll cop out
827 * and simply require addresses to be aligned at 512-byte
828 * boundaries. This is okay since most block I/O involves
829 * hardware sectors that are multiples of 512 bytes in length,
830 * and since host controllers up through USB 2.0 have maxpacket
831 * values no larger than 512.
833 * But it doesn't suffice for Wireless USB, where Bulk maxpacket
834 * values can be as large as 2048. To make that work properly
835 * will require changes to the block layer.
837 blk_queue_update_dma_alignment(sdev->request_queue, (512 - 1));
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 scsi_set_tag_type(sdev, MSG_ORDERED_TAG);
850 scsi_activate_tcq(sdev, devinfo->qdepth - 2);
854 static struct scsi_host_template uas_host_template = {
855 .module = THIS_MODULE,
857 .queuecommand = uas_queuecommand,
858 .slave_alloc = uas_slave_alloc,
859 .slave_configure = uas_slave_configure,
860 .eh_abort_handler = uas_eh_abort_handler,
861 .eh_bus_reset_handler = uas_eh_bus_reset_handler,
862 .can_queue = 65536, /* Is there a limit on the _host_ ? */
864 .sg_tablesize = SG_NONE,
865 .cmd_per_lun = 1, /* until we override it */
866 .skip_settle_delay = 1,
870 #define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \
871 vendorName, productName, useProtocol, useTransport, \
872 initFunction, flags) \
873 { USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax), \
874 .driver_info = (flags) }
876 static struct usb_device_id uas_usb_ids[] = {
877 # include "unusual_uas.h"
878 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_BULK) },
879 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_UAS) },
880 /* 0xaa is a prototype device I happen to have access to */
881 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, 0xaa) },
884 MODULE_DEVICE_TABLE(usb, uas_usb_ids);
888 static int uas_switch_interface(struct usb_device *udev,
889 struct usb_interface *intf)
893 alt = uas_find_uas_alt_setting(intf);
897 return usb_set_interface(udev,
898 intf->altsetting[0].desc.bInterfaceNumber, alt);
901 static int uas_configure_endpoints(struct uas_dev_info *devinfo)
903 struct usb_host_endpoint *eps[4] = { };
904 struct usb_device *udev = devinfo->udev;
907 devinfo->uas_sense_old = 0;
909 r = uas_find_endpoints(devinfo->intf->cur_altsetting, eps);
913 devinfo->cmd_pipe = usb_sndbulkpipe(udev,
914 usb_endpoint_num(&eps[0]->desc));
915 devinfo->status_pipe = usb_rcvbulkpipe(udev,
916 usb_endpoint_num(&eps[1]->desc));
917 devinfo->data_in_pipe = usb_rcvbulkpipe(udev,
918 usb_endpoint_num(&eps[2]->desc));
919 devinfo->data_out_pipe = usb_sndbulkpipe(udev,
920 usb_endpoint_num(&eps[3]->desc));
922 if (udev->speed < USB_SPEED_SUPER) {
923 devinfo->qdepth = 32;
924 devinfo->use_streams = 0;
926 devinfo->qdepth = usb_alloc_streams(devinfo->intf, eps + 1,
927 3, MAX_CMNDS, GFP_NOIO);
928 if (devinfo->qdepth < 0)
929 return devinfo->qdepth;
930 devinfo->use_streams = 1;
936 static void uas_free_streams(struct uas_dev_info *devinfo)
938 struct usb_device *udev = devinfo->udev;
939 struct usb_host_endpoint *eps[3];
941 eps[0] = usb_pipe_endpoint(udev, devinfo->status_pipe);
942 eps[1] = usb_pipe_endpoint(udev, devinfo->data_in_pipe);
943 eps[2] = usb_pipe_endpoint(udev, devinfo->data_out_pipe);
944 usb_free_streams(devinfo->intf, eps, 3, GFP_NOIO);
947 static int uas_probe(struct usb_interface *intf, const struct usb_device_id *id)
949 int result = -ENOMEM;
950 struct Scsi_Host *shost = NULL;
951 struct uas_dev_info *devinfo;
952 struct usb_device *udev = interface_to_usbdev(intf);
954 if (!uas_use_uas_driver(intf, id))
957 if (uas_switch_interface(udev, intf))
960 shost = scsi_host_alloc(&uas_host_template,
961 sizeof(struct uas_dev_info));
965 shost->max_cmd_len = 16 + 252;
967 shost->max_lun = 256;
968 shost->max_channel = 0;
969 shost->sg_tablesize = udev->bus->sg_tablesize;
971 devinfo = (struct uas_dev_info *)shost->hostdata;
972 devinfo->intf = intf;
973 devinfo->udev = udev;
974 devinfo->resetting = 0;
975 devinfo->shutdown = 0;
976 devinfo->flags = id->driver_info;
977 usb_stor_adjust_quirks(udev, &devinfo->flags);
978 init_usb_anchor(&devinfo->cmd_urbs);
979 init_usb_anchor(&devinfo->sense_urbs);
980 init_usb_anchor(&devinfo->data_urbs);
981 spin_lock_init(&devinfo->lock);
982 INIT_WORK(&devinfo->work, uas_do_work);
984 result = uas_configure_endpoints(devinfo);
988 result = scsi_init_shared_tag_map(shost, devinfo->qdepth - 2);
992 usb_set_intfdata(intf, shost);
993 result = scsi_add_host(shost, &intf->dev);
997 scsi_scan_host(shost);
1001 uas_free_streams(devinfo);
1002 usb_set_intfdata(intf, NULL);
1004 usb_set_interface(udev, intf->altsetting[0].desc.bInterfaceNumber, 0);
1006 scsi_host_put(shost);
1010 static int uas_cmnd_list_empty(struct uas_dev_info *devinfo)
1012 unsigned long flags;
1015 spin_lock_irqsave(&devinfo->lock, flags);
1017 for (i = 0; i < devinfo->qdepth; i++) {
1018 if (devinfo->cmnd[i]) {
1019 r = 0; /* Not empty */
1024 spin_unlock_irqrestore(&devinfo->lock, flags);
1030 * Wait for any pending cmnds to complete, on usb-2 sense_urbs may temporarily
1031 * get empty while there still is more work to do due to sense-urbs completing
1032 * with a READ/WRITE_READY iu code, so keep waiting until the list gets empty.
1034 static int uas_wait_for_pending_cmnds(struct uas_dev_info *devinfo)
1036 unsigned long start_time;
1039 start_time = jiffies;
1041 flush_work(&devinfo->work);
1043 r = usb_wait_anchor_empty_timeout(&devinfo->sense_urbs, 5000);
1047 r = usb_wait_anchor_empty_timeout(&devinfo->data_urbs, 500);
1051 if (time_after(jiffies, start_time + 5 * HZ))
1053 } while (!uas_cmnd_list_empty(devinfo));
1058 static int uas_pre_reset(struct usb_interface *intf)
1060 struct Scsi_Host *shost = usb_get_intfdata(intf);
1061 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1062 unsigned long flags;
1064 if (devinfo->shutdown)
1067 /* Block new requests */
1068 spin_lock_irqsave(shost->host_lock, flags);
1069 scsi_block_requests(shost);
1070 spin_unlock_irqrestore(shost->host_lock, flags);
1072 if (uas_wait_for_pending_cmnds(devinfo) != 0) {
1073 shost_printk(KERN_ERR, shost, "%s: timed out\n", __func__);
1074 scsi_unblock_requests(shost);
1078 uas_free_streams(devinfo);
1083 static int uas_post_reset(struct usb_interface *intf)
1085 struct Scsi_Host *shost = usb_get_intfdata(intf);
1086 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1087 unsigned long flags;
1089 if (devinfo->shutdown)
1092 if (uas_configure_endpoints(devinfo) != 0) {
1093 shost_printk(KERN_ERR, shost,
1094 "%s: alloc streams error after reset", __func__);
1098 spin_lock_irqsave(shost->host_lock, flags);
1099 scsi_report_bus_reset(shost, 0);
1100 spin_unlock_irqrestore(shost->host_lock, flags);
1102 scsi_unblock_requests(shost);
1107 static int uas_suspend(struct usb_interface *intf, pm_message_t message)
1109 struct Scsi_Host *shost = usb_get_intfdata(intf);
1110 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1112 if (uas_wait_for_pending_cmnds(devinfo) != 0) {
1113 shost_printk(KERN_ERR, shost, "%s: timed out\n", __func__);
1120 static int uas_resume(struct usb_interface *intf)
1125 static int uas_reset_resume(struct usb_interface *intf)
1127 struct Scsi_Host *shost = usb_get_intfdata(intf);
1128 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1129 unsigned long flags;
1131 if (uas_configure_endpoints(devinfo) != 0) {
1132 shost_printk(KERN_ERR, shost,
1133 "%s: alloc streams error after reset", __func__);
1137 spin_lock_irqsave(shost->host_lock, flags);
1138 scsi_report_bus_reset(shost, 0);
1139 spin_unlock_irqrestore(shost->host_lock, flags);
1144 static void uas_disconnect(struct usb_interface *intf)
1146 struct Scsi_Host *shost = usb_get_intfdata(intf);
1147 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1148 unsigned long flags;
1150 spin_lock_irqsave(&devinfo->lock, flags);
1151 devinfo->resetting = 1;
1152 spin_unlock_irqrestore(&devinfo->lock, flags);
1154 cancel_work_sync(&devinfo->work);
1155 usb_kill_anchored_urbs(&devinfo->cmd_urbs);
1156 usb_kill_anchored_urbs(&devinfo->sense_urbs);
1157 usb_kill_anchored_urbs(&devinfo->data_urbs);
1158 uas_zap_pending(devinfo, DID_NO_CONNECT);
1160 scsi_remove_host(shost);
1161 uas_free_streams(devinfo);
1162 scsi_host_put(shost);
1166 * Put the device back in usb-storage mode on shutdown, as some BIOS-es
1167 * hang on reboot when the device is still in uas mode. Note the reset is
1168 * necessary as some devices won't revert to usb-storage mode without it.
1170 static void uas_shutdown(struct device *dev)
1172 struct usb_interface *intf = to_usb_interface(dev);
1173 struct usb_device *udev = interface_to_usbdev(intf);
1174 struct Scsi_Host *shost = usb_get_intfdata(intf);
1175 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1177 if (system_state != SYSTEM_RESTART)
1180 devinfo->shutdown = 1;
1181 uas_free_streams(devinfo);
1182 usb_set_interface(udev, intf->altsetting[0].desc.bInterfaceNumber, 0);
1183 usb_reset_device(udev);
1186 static struct usb_driver uas_driver = {
1189 .disconnect = uas_disconnect,
1190 .pre_reset = uas_pre_reset,
1191 .post_reset = uas_post_reset,
1192 .suspend = uas_suspend,
1193 .resume = uas_resume,
1194 .reset_resume = uas_reset_resume,
1195 .drvwrap.driver.shutdown = uas_shutdown,
1196 .id_table = uas_usb_ids,
1199 module_usb_driver(uas_driver);
1201 MODULE_LICENSE("GPL");
1203 "Hans de Goede <hdegoede@redhat.com>, Matthew Wilcox and Sarah Sharp");