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 struct usb_interface *intf;
37 struct usb_device *udev;
38 struct usb_anchor cmd_urbs;
39 struct usb_anchor sense_urbs;
40 struct usb_anchor data_urbs;
42 int qdepth, resetting;
43 unsigned cmd_pipe, status_pipe, data_in_pipe, data_out_pipe;
44 unsigned use_streams:1;
46 struct scsi_cmnd *cmnd[MAX_CMNDS];
48 struct work_struct work;
52 SUBMIT_STATUS_URB = (1 << 1),
53 ALLOC_DATA_IN_URB = (1 << 2),
54 SUBMIT_DATA_IN_URB = (1 << 3),
55 ALLOC_DATA_OUT_URB = (1 << 4),
56 SUBMIT_DATA_OUT_URB = (1 << 5),
57 ALLOC_CMD_URB = (1 << 6),
58 SUBMIT_CMD_URB = (1 << 7),
59 COMMAND_INFLIGHT = (1 << 8),
60 DATA_IN_URB_INFLIGHT = (1 << 9),
61 DATA_OUT_URB_INFLIGHT = (1 << 10),
62 COMMAND_ABORTED = (1 << 11),
63 IS_IN_WORK_LIST = (1 << 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, gfp_t gfp);
78 static void uas_do_work(struct work_struct *work);
79 static int uas_try_complete(struct scsi_cmnd *cmnd, const char *caller);
80 static void uas_free_streams(struct uas_dev_info *devinfo);
81 static void uas_log_cmd_state(struct scsi_cmnd *cmnd, const char *prefix,
84 static void uas_do_work(struct work_struct *work)
86 struct uas_dev_info *devinfo =
87 container_of(work, struct uas_dev_info, work);
88 struct uas_cmd_info *cmdinfo;
89 struct scsi_cmnd *cmnd;
93 spin_lock_irqsave(&devinfo->lock, flags);
95 if (devinfo->resetting)
98 for (i = 0; i < devinfo->qdepth; i++) {
99 if (!devinfo->cmnd[i])
102 cmnd = devinfo->cmnd[i];
103 cmdinfo = (void *)&cmnd->SCp;
105 if (!(cmdinfo->state & IS_IN_WORK_LIST))
108 err = uas_submit_urbs(cmnd, cmnd->device->hostdata, GFP_ATOMIC);
110 cmdinfo->state &= ~IS_IN_WORK_LIST;
112 schedule_work(&devinfo->work);
115 spin_unlock_irqrestore(&devinfo->lock, flags);
118 static void uas_add_work(struct uas_cmd_info *cmdinfo)
120 struct scsi_pointer *scp = (void *)cmdinfo;
121 struct scsi_cmnd *cmnd = container_of(scp, struct scsi_cmnd, SCp);
122 struct uas_dev_info *devinfo = cmnd->device->hostdata;
124 lockdep_assert_held(&devinfo->lock);
125 cmdinfo->state |= IS_IN_WORK_LIST;
126 schedule_work(&devinfo->work);
129 static void uas_zap_pending(struct uas_dev_info *devinfo, int result)
131 struct uas_cmd_info *cmdinfo;
132 struct scsi_cmnd *cmnd;
136 spin_lock_irqsave(&devinfo->lock, flags);
137 for (i = 0; i < devinfo->qdepth; i++) {
138 if (!devinfo->cmnd[i])
141 cmnd = devinfo->cmnd[i];
142 cmdinfo = (void *)&cmnd->SCp;
143 uas_log_cmd_state(cmnd, __func__, 0);
144 /* Sense urbs were killed, clear COMMAND_INFLIGHT manually */
145 cmdinfo->state &= ~COMMAND_INFLIGHT;
146 cmnd->result = result << 16;
147 err = uas_try_complete(cmnd, __func__);
150 spin_unlock_irqrestore(&devinfo->lock, flags);
153 static void uas_sense(struct urb *urb, struct scsi_cmnd *cmnd)
155 struct sense_iu *sense_iu = urb->transfer_buffer;
156 struct scsi_device *sdev = cmnd->device;
158 if (urb->actual_length > 16) {
159 unsigned len = be16_to_cpup(&sense_iu->len);
160 if (len + 16 != urb->actual_length) {
161 int newlen = min(len + 16, urb->actual_length) - 16;
164 sdev_printk(KERN_INFO, sdev, "%s: urb length %d "
165 "disagrees with IU sense data length %d, "
166 "using %d bytes of sense data\n", __func__,
167 urb->actual_length, len, newlen);
170 memcpy(cmnd->sense_buffer, sense_iu->sense, len);
173 cmnd->result = sense_iu->status;
177 * scsi-tags go from 0 - (nr_tags - 1), uas tags need to match stream-ids,
178 * which go from 1 - nr_streams. And we use 1 for untagged commands.
180 static int uas_get_tag(struct scsi_cmnd *cmnd)
184 if (blk_rq_tagged(cmnd->request))
185 tag = cmnd->request->tag + 2;
192 static void uas_log_cmd_state(struct scsi_cmnd *cmnd, const char *prefix,
195 struct uas_cmd_info *ci = (void *)&cmnd->SCp;
197 scmd_printk(KERN_INFO, cmnd,
198 "%s %d tag %d inflight:%s%s%s%s%s%s%s%s%s%s%s%s ",
199 prefix, status, uas_get_tag(cmnd),
200 (ci->state & SUBMIT_STATUS_URB) ? " s-st" : "",
201 (ci->state & ALLOC_DATA_IN_URB) ? " a-in" : "",
202 (ci->state & SUBMIT_DATA_IN_URB) ? " s-in" : "",
203 (ci->state & ALLOC_DATA_OUT_URB) ? " a-out" : "",
204 (ci->state & SUBMIT_DATA_OUT_URB) ? " s-out" : "",
205 (ci->state & ALLOC_CMD_URB) ? " a-cmd" : "",
206 (ci->state & SUBMIT_CMD_URB) ? " s-cmd" : "",
207 (ci->state & COMMAND_INFLIGHT) ? " CMD" : "",
208 (ci->state & DATA_IN_URB_INFLIGHT) ? " IN" : "",
209 (ci->state & DATA_OUT_URB_INFLIGHT) ? " OUT" : "",
210 (ci->state & COMMAND_ABORTED) ? " abort" : "",
211 (ci->state & IS_IN_WORK_LIST) ? " work" : "");
212 scsi_print_command(cmnd);
215 static void uas_free_unsubmitted_urbs(struct scsi_cmnd *cmnd)
217 struct uas_cmd_info *cmdinfo;
222 cmdinfo = (void *)&cmnd->SCp;
224 if (cmdinfo->state & SUBMIT_CMD_URB)
225 usb_free_urb(cmdinfo->cmd_urb);
227 /* data urbs may have never gotten their submit flag set */
228 if (!(cmdinfo->state & DATA_IN_URB_INFLIGHT))
229 usb_free_urb(cmdinfo->data_in_urb);
230 if (!(cmdinfo->state & DATA_OUT_URB_INFLIGHT))
231 usb_free_urb(cmdinfo->data_out_urb);
234 static int uas_try_complete(struct scsi_cmnd *cmnd, const char *caller)
236 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
237 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
239 lockdep_assert_held(&devinfo->lock);
240 if (cmdinfo->state & (COMMAND_INFLIGHT |
241 DATA_IN_URB_INFLIGHT |
242 DATA_OUT_URB_INFLIGHT |
245 devinfo->cmnd[uas_get_tag(cmnd) - 1] = NULL;
246 uas_free_unsubmitted_urbs(cmnd);
247 cmnd->scsi_done(cmnd);
251 static void uas_xfer_data(struct urb *urb, struct scsi_cmnd *cmnd,
254 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
257 cmdinfo->state |= direction | SUBMIT_STATUS_URB;
258 err = uas_submit_urbs(cmnd, cmnd->device->hostdata, GFP_ATOMIC);
260 uas_add_work(cmdinfo);
264 static void uas_stat_cmplt(struct urb *urb)
266 struct iu *iu = urb->transfer_buffer;
267 struct Scsi_Host *shost = urb->context;
268 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
269 struct urb *data_in_urb = NULL;
270 struct urb *data_out_urb = NULL;
271 struct scsi_cmnd *cmnd;
272 struct uas_cmd_info *cmdinfo;
276 spin_lock_irqsave(&devinfo->lock, flags);
278 if (devinfo->resetting)
282 if (urb->status != -ENOENT && urb->status != -ECONNRESET) {
283 dev_err(&urb->dev->dev, "stat urb: status %d\n",
289 idx = be16_to_cpup(&iu->tag) - 1;
290 if (idx >= MAX_CMNDS || !devinfo->cmnd[idx]) {
291 dev_err(&urb->dev->dev,
292 "stat urb: no pending cmd for tag %d\n", idx + 1);
296 cmnd = devinfo->cmnd[idx];
297 cmdinfo = (void *)&cmnd->SCp;
299 if (!(cmdinfo->state & COMMAND_INFLIGHT)) {
300 uas_log_cmd_state(cmnd, "unexpected status cmplt", 0);
306 uas_sense(urb, cmnd);
307 if (cmnd->result != 0) {
308 /* cancel data transfers on error */
309 data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
310 data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
312 cmdinfo->state &= ~COMMAND_INFLIGHT;
313 uas_try_complete(cmnd, __func__);
315 case IU_ID_READ_READY:
316 if (!cmdinfo->data_in_urb ||
317 (cmdinfo->state & DATA_IN_URB_INFLIGHT)) {
318 uas_log_cmd_state(cmnd, "unexpected read rdy", 0);
321 uas_xfer_data(urb, cmnd, SUBMIT_DATA_IN_URB);
323 case IU_ID_WRITE_READY:
324 if (!cmdinfo->data_out_urb ||
325 (cmdinfo->state & DATA_OUT_URB_INFLIGHT)) {
326 uas_log_cmd_state(cmnd, "unexpected write rdy", 0);
329 uas_xfer_data(urb, cmnd, SUBMIT_DATA_OUT_URB);
332 uas_log_cmd_state(cmnd, "unexpected response iu",
333 ((struct response_iu *)iu)->response_code);
334 /* Error, cancel data transfers */
335 data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
336 data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
337 cmdinfo->state &= ~COMMAND_INFLIGHT;
338 cmnd->result = DID_ERROR << 16;
339 uas_try_complete(cmnd, __func__);
342 uas_log_cmd_state(cmnd, "bogus IU", iu->iu_id);
346 spin_unlock_irqrestore(&devinfo->lock, flags);
348 /* Unlinking of data urbs must be done without holding the lock */
350 usb_unlink_urb(data_in_urb);
351 usb_put_urb(data_in_urb);
354 usb_unlink_urb(data_out_urb);
355 usb_put_urb(data_out_urb);
359 static void uas_data_cmplt(struct urb *urb)
361 struct scsi_cmnd *cmnd = urb->context;
362 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
363 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
364 struct scsi_data_buffer *sdb = NULL;
367 spin_lock_irqsave(&devinfo->lock, flags);
369 if (cmdinfo->data_in_urb == urb) {
371 cmdinfo->state &= ~DATA_IN_URB_INFLIGHT;
372 cmdinfo->data_in_urb = NULL;
373 } else if (cmdinfo->data_out_urb == urb) {
374 sdb = scsi_out(cmnd);
375 cmdinfo->state &= ~DATA_OUT_URB_INFLIGHT;
376 cmdinfo->data_out_urb = NULL;
383 if (devinfo->resetting)
386 /* Data urbs should not complete before the cmd urb is submitted */
387 if (cmdinfo->state & SUBMIT_CMD_URB) {
388 uas_log_cmd_state(cmnd, "unexpected data cmplt", 0);
393 if (urb->status != -ENOENT && urb->status != -ECONNRESET)
394 uas_log_cmd_state(cmnd, "data cmplt err", urb->status);
395 /* error: no data transfered */
396 sdb->resid = sdb->length;
398 sdb->resid = sdb->length - urb->actual_length;
400 uas_try_complete(cmnd, __func__);
403 spin_unlock_irqrestore(&devinfo->lock, flags);
406 static void uas_cmd_cmplt(struct urb *urb)
409 dev_err(&urb->dev->dev, "cmd cmplt err %d\n", urb->status);
414 static struct urb *uas_alloc_data_urb(struct uas_dev_info *devinfo, gfp_t gfp,
415 unsigned int pipe, u16 stream_id,
416 struct scsi_cmnd *cmnd,
417 enum dma_data_direction dir)
419 struct usb_device *udev = devinfo->udev;
420 struct urb *urb = usb_alloc_urb(0, gfp);
421 struct scsi_data_buffer *sdb = (dir == DMA_FROM_DEVICE)
422 ? scsi_in(cmnd) : scsi_out(cmnd);
426 usb_fill_bulk_urb(urb, udev, pipe, NULL, sdb->length,
427 uas_data_cmplt, cmnd);
428 urb->stream_id = stream_id;
429 urb->num_sgs = udev->bus->sg_tablesize ? sdb->table.nents : 0;
430 urb->sg = sdb->table.sgl;
435 static struct urb *uas_alloc_sense_urb(struct uas_dev_info *devinfo, gfp_t gfp,
436 struct Scsi_Host *shost, u16 stream_id)
438 struct usb_device *udev = devinfo->udev;
439 struct urb *urb = usb_alloc_urb(0, gfp);
445 iu = kzalloc(sizeof(*iu), gfp);
449 usb_fill_bulk_urb(urb, udev, devinfo->status_pipe, iu, sizeof(*iu),
450 uas_stat_cmplt, shost);
451 urb->stream_id = stream_id;
452 urb->transfer_flags |= URB_FREE_BUFFER;
460 static struct urb *uas_alloc_cmd_urb(struct uas_dev_info *devinfo, gfp_t gfp,
461 struct scsi_cmnd *cmnd)
463 struct usb_device *udev = devinfo->udev;
464 struct scsi_device *sdev = cmnd->device;
465 struct urb *urb = usb_alloc_urb(0, gfp);
466 struct command_iu *iu;
472 len = cmnd->cmd_len - 16;
476 iu = kzalloc(sizeof(*iu) + len, gfp);
480 iu->iu_id = IU_ID_COMMAND;
481 iu->tag = cpu_to_be16(uas_get_tag(cmnd));
482 iu->prio_attr = UAS_SIMPLE_TAG;
484 int_to_scsilun(sdev->lun, &iu->lun);
485 memcpy(iu->cdb, cmnd->cmnd, cmnd->cmd_len);
487 usb_fill_bulk_urb(urb, udev, devinfo->cmd_pipe, iu, sizeof(*iu) + len,
488 uas_cmd_cmplt, NULL);
489 urb->transfer_flags |= URB_FREE_BUFFER;
498 * Why should I request the Status IU before sending the Command IU? Spec
499 * says to, but also says the device may receive them in any order. Seems
503 static struct urb *uas_submit_sense_urb(struct scsi_cmnd *cmnd,
504 gfp_t gfp, unsigned int stream)
506 struct Scsi_Host *shost = cmnd->device->host;
507 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
511 urb = uas_alloc_sense_urb(devinfo, gfp, shost, stream);
514 usb_anchor_urb(urb, &devinfo->sense_urbs);
515 err = usb_submit_urb(urb, gfp);
517 usb_unanchor_urb(urb);
518 uas_log_cmd_state(cmnd, "sense submit err", err);
525 static int uas_submit_urbs(struct scsi_cmnd *cmnd,
526 struct uas_dev_info *devinfo, gfp_t gfp)
528 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
532 lockdep_assert_held(&devinfo->lock);
533 if (cmdinfo->state & SUBMIT_STATUS_URB) {
534 urb = uas_submit_sense_urb(cmnd, gfp, cmdinfo->stream);
536 return SCSI_MLQUEUE_DEVICE_BUSY;
537 cmdinfo->state &= ~SUBMIT_STATUS_URB;
540 if (cmdinfo->state & ALLOC_DATA_IN_URB) {
541 cmdinfo->data_in_urb = uas_alloc_data_urb(devinfo, gfp,
542 devinfo->data_in_pipe, cmdinfo->stream,
543 cmnd, DMA_FROM_DEVICE);
544 if (!cmdinfo->data_in_urb)
545 return SCSI_MLQUEUE_DEVICE_BUSY;
546 cmdinfo->state &= ~ALLOC_DATA_IN_URB;
549 if (cmdinfo->state & SUBMIT_DATA_IN_URB) {
550 usb_anchor_urb(cmdinfo->data_in_urb, &devinfo->data_urbs);
551 err = usb_submit_urb(cmdinfo->data_in_urb, gfp);
553 usb_unanchor_urb(cmdinfo->data_in_urb);
554 uas_log_cmd_state(cmnd, "data in submit err", err);
555 return SCSI_MLQUEUE_DEVICE_BUSY;
557 cmdinfo->state &= ~SUBMIT_DATA_IN_URB;
558 cmdinfo->state |= DATA_IN_URB_INFLIGHT;
561 if (cmdinfo->state & ALLOC_DATA_OUT_URB) {
562 cmdinfo->data_out_urb = uas_alloc_data_urb(devinfo, gfp,
563 devinfo->data_out_pipe, cmdinfo->stream,
564 cmnd, DMA_TO_DEVICE);
565 if (!cmdinfo->data_out_urb)
566 return SCSI_MLQUEUE_DEVICE_BUSY;
567 cmdinfo->state &= ~ALLOC_DATA_OUT_URB;
570 if (cmdinfo->state & SUBMIT_DATA_OUT_URB) {
571 usb_anchor_urb(cmdinfo->data_out_urb, &devinfo->data_urbs);
572 err = usb_submit_urb(cmdinfo->data_out_urb, gfp);
574 usb_unanchor_urb(cmdinfo->data_out_urb);
575 uas_log_cmd_state(cmnd, "data out submit err", err);
576 return SCSI_MLQUEUE_DEVICE_BUSY;
578 cmdinfo->state &= ~SUBMIT_DATA_OUT_URB;
579 cmdinfo->state |= DATA_OUT_URB_INFLIGHT;
582 if (cmdinfo->state & ALLOC_CMD_URB) {
583 cmdinfo->cmd_urb = uas_alloc_cmd_urb(devinfo, gfp, cmnd);
584 if (!cmdinfo->cmd_urb)
585 return SCSI_MLQUEUE_DEVICE_BUSY;
586 cmdinfo->state &= ~ALLOC_CMD_URB;
589 if (cmdinfo->state & SUBMIT_CMD_URB) {
590 usb_anchor_urb(cmdinfo->cmd_urb, &devinfo->cmd_urbs);
591 err = usb_submit_urb(cmdinfo->cmd_urb, gfp);
593 usb_unanchor_urb(cmdinfo->cmd_urb);
594 uas_log_cmd_state(cmnd, "cmd submit err", err);
595 return SCSI_MLQUEUE_DEVICE_BUSY;
597 cmdinfo->cmd_urb = NULL;
598 cmdinfo->state &= ~SUBMIT_CMD_URB;
599 cmdinfo->state |= COMMAND_INFLIGHT;
605 static int uas_queuecommand_lck(struct scsi_cmnd *cmnd,
606 void (*done)(struct scsi_cmnd *))
608 struct scsi_device *sdev = cmnd->device;
609 struct uas_dev_info *devinfo = sdev->hostdata;
610 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
615 BUILD_BUG_ON(sizeof(struct uas_cmd_info) > sizeof(struct scsi_pointer));
617 /* Re-check scsi_block_requests now that we've the host-lock */
618 if (cmnd->device->host->host_self_blocked)
619 return SCSI_MLQUEUE_DEVICE_BUSY;
621 if ((devinfo->flags & US_FL_NO_ATA_1X) &&
622 (cmnd->cmnd[0] == ATA_12 || cmnd->cmnd[0] == ATA_16)) {
623 memcpy(cmnd->sense_buffer, usb_stor_sense_invalidCDB,
624 sizeof(usb_stor_sense_invalidCDB));
625 cmnd->result = SAM_STAT_CHECK_CONDITION;
626 cmnd->scsi_done(cmnd);
630 spin_lock_irqsave(&devinfo->lock, flags);
632 if (devinfo->resetting) {
633 cmnd->result = DID_ERROR << 16;
634 cmnd->scsi_done(cmnd);
635 spin_unlock_irqrestore(&devinfo->lock, flags);
639 stream = uas_get_tag(cmnd);
640 if (devinfo->cmnd[stream - 1]) {
641 spin_unlock_irqrestore(&devinfo->lock, flags);
642 return SCSI_MLQUEUE_DEVICE_BUSY;
645 cmnd->scsi_done = done;
647 memset(cmdinfo, 0, sizeof(*cmdinfo));
648 cmdinfo->stream = stream;
649 cmdinfo->state = SUBMIT_STATUS_URB | ALLOC_CMD_URB | SUBMIT_CMD_URB;
651 switch (cmnd->sc_data_direction) {
652 case DMA_FROM_DEVICE:
653 cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
655 case DMA_BIDIRECTIONAL:
656 cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
658 cmdinfo->state |= ALLOC_DATA_OUT_URB | SUBMIT_DATA_OUT_URB;
663 if (!devinfo->use_streams) {
664 cmdinfo->state &= ~(SUBMIT_DATA_IN_URB | SUBMIT_DATA_OUT_URB);
668 err = uas_submit_urbs(cmnd, devinfo, GFP_ATOMIC);
670 /* If we did nothing, give up now */
671 if (cmdinfo->state & SUBMIT_STATUS_URB) {
672 spin_unlock_irqrestore(&devinfo->lock, flags);
673 return SCSI_MLQUEUE_DEVICE_BUSY;
675 uas_add_work(cmdinfo);
678 devinfo->cmnd[stream - 1] = cmnd;
679 spin_unlock_irqrestore(&devinfo->lock, flags);
683 static DEF_SCSI_QCMD(uas_queuecommand)
686 * For now we do not support actually sending an abort to the device, so
687 * this eh always fails. Still we must define it to make sure that we've
688 * dropped all references to the cmnd in question once this function exits.
690 static int uas_eh_abort_handler(struct scsi_cmnd *cmnd)
692 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
693 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
694 struct urb *data_in_urb = NULL;
695 struct urb *data_out_urb = NULL;
698 spin_lock_irqsave(&devinfo->lock, flags);
700 uas_log_cmd_state(cmnd, __func__, 0);
702 /* Ensure that try_complete does not call scsi_done */
703 cmdinfo->state |= COMMAND_ABORTED;
705 /* Drop all refs to this cmnd, kill data urbs to break their ref */
706 devinfo->cmnd[uas_get_tag(cmnd) - 1] = NULL;
707 if (cmdinfo->state & DATA_IN_URB_INFLIGHT)
708 data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
709 if (cmdinfo->state & DATA_OUT_URB_INFLIGHT)
710 data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
712 uas_free_unsubmitted_urbs(cmnd);
714 spin_unlock_irqrestore(&devinfo->lock, flags);
717 usb_kill_urb(data_in_urb);
718 usb_put_urb(data_in_urb);
721 usb_kill_urb(data_out_urb);
722 usb_put_urb(data_out_urb);
728 static int uas_eh_bus_reset_handler(struct scsi_cmnd *cmnd)
730 struct scsi_device *sdev = cmnd->device;
731 struct uas_dev_info *devinfo = sdev->hostdata;
732 struct usb_device *udev = devinfo->udev;
736 err = usb_lock_device_for_reset(udev, devinfo->intf);
738 shost_printk(KERN_ERR, sdev->host,
739 "%s FAILED to get lock err %d\n", __func__, err);
743 shost_printk(KERN_INFO, sdev->host, "%s start\n", __func__);
745 spin_lock_irqsave(&devinfo->lock, flags);
746 devinfo->resetting = 1;
747 spin_unlock_irqrestore(&devinfo->lock, flags);
749 usb_kill_anchored_urbs(&devinfo->cmd_urbs);
750 usb_kill_anchored_urbs(&devinfo->sense_urbs);
751 usb_kill_anchored_urbs(&devinfo->data_urbs);
752 uas_zap_pending(devinfo, DID_RESET);
754 err = usb_reset_device(udev);
756 spin_lock_irqsave(&devinfo->lock, flags);
757 devinfo->resetting = 0;
758 spin_unlock_irqrestore(&devinfo->lock, flags);
760 usb_unlock_device(udev);
763 shost_printk(KERN_INFO, sdev->host, "%s FAILED err %d\n",
768 shost_printk(KERN_INFO, sdev->host, "%s success\n", __func__);
772 static int uas_slave_alloc(struct scsi_device *sdev)
774 sdev->hostdata = (void *)sdev->host->hostdata;
776 /* USB has unusual DMA-alignment requirements: Although the
777 * starting address of each scatter-gather element doesn't matter,
778 * the length of each element except the last must be divisible
779 * by the Bulk maxpacket value. There's currently no way to
780 * express this by block-layer constraints, so we'll cop out
781 * and simply require addresses to be aligned at 512-byte
782 * boundaries. This is okay since most block I/O involves
783 * hardware sectors that are multiples of 512 bytes in length,
784 * and since host controllers up through USB 2.0 have maxpacket
785 * values no larger than 512.
787 * But it doesn't suffice for Wireless USB, where Bulk maxpacket
788 * values can be as large as 2048. To make that work properly
789 * will require changes to the block layer.
791 blk_queue_update_dma_alignment(sdev->request_queue, (512 - 1));
796 static int uas_slave_configure(struct scsi_device *sdev)
798 struct uas_dev_info *devinfo = sdev->hostdata;
800 if (devinfo->flags & US_FL_NO_REPORT_OPCODES)
801 sdev->no_report_opcodes = 1;
803 scsi_set_tag_type(sdev, MSG_ORDERED_TAG);
804 scsi_activate_tcq(sdev, devinfo->qdepth - 2);
808 static struct scsi_host_template uas_host_template = {
809 .module = THIS_MODULE,
811 .queuecommand = uas_queuecommand,
812 .slave_alloc = uas_slave_alloc,
813 .slave_configure = uas_slave_configure,
814 .eh_abort_handler = uas_eh_abort_handler,
815 .eh_bus_reset_handler = uas_eh_bus_reset_handler,
816 .can_queue = 65536, /* Is there a limit on the _host_ ? */
818 .sg_tablesize = SG_NONE,
819 .cmd_per_lun = 1, /* until we override it */
820 .skip_settle_delay = 1,
824 #define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \
825 vendorName, productName, useProtocol, useTransport, \
826 initFunction, flags) \
827 { USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax), \
828 .driver_info = (flags) }
830 static struct usb_device_id uas_usb_ids[] = {
831 # include "unusual_uas.h"
832 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_BULK) },
833 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_UAS) },
836 MODULE_DEVICE_TABLE(usb, uas_usb_ids);
840 static int uas_switch_interface(struct usb_device *udev,
841 struct usb_interface *intf)
845 alt = uas_find_uas_alt_setting(intf);
849 return usb_set_interface(udev,
850 intf->altsetting[0].desc.bInterfaceNumber, alt);
853 static int uas_configure_endpoints(struct uas_dev_info *devinfo)
855 struct usb_host_endpoint *eps[4] = { };
856 struct usb_device *udev = devinfo->udev;
859 r = uas_find_endpoints(devinfo->intf->cur_altsetting, eps);
863 devinfo->cmd_pipe = usb_sndbulkpipe(udev,
864 usb_endpoint_num(&eps[0]->desc));
865 devinfo->status_pipe = usb_rcvbulkpipe(udev,
866 usb_endpoint_num(&eps[1]->desc));
867 devinfo->data_in_pipe = usb_rcvbulkpipe(udev,
868 usb_endpoint_num(&eps[2]->desc));
869 devinfo->data_out_pipe = usb_sndbulkpipe(udev,
870 usb_endpoint_num(&eps[3]->desc));
872 if (udev->speed < USB_SPEED_SUPER) {
873 devinfo->qdepth = 32;
874 devinfo->use_streams = 0;
876 devinfo->qdepth = usb_alloc_streams(devinfo->intf, eps + 1,
877 3, MAX_CMNDS, GFP_NOIO);
878 if (devinfo->qdepth < 0)
879 return devinfo->qdepth;
880 devinfo->use_streams = 1;
886 static void uas_free_streams(struct uas_dev_info *devinfo)
888 struct usb_device *udev = devinfo->udev;
889 struct usb_host_endpoint *eps[3];
891 eps[0] = usb_pipe_endpoint(udev, devinfo->status_pipe);
892 eps[1] = usb_pipe_endpoint(udev, devinfo->data_in_pipe);
893 eps[2] = usb_pipe_endpoint(udev, devinfo->data_out_pipe);
894 usb_free_streams(devinfo->intf, eps, 3, GFP_NOIO);
897 static int uas_probe(struct usb_interface *intf, const struct usb_device_id *id)
899 int result = -ENOMEM;
900 struct Scsi_Host *shost = NULL;
901 struct uas_dev_info *devinfo;
902 struct usb_device *udev = interface_to_usbdev(intf);
904 if (!uas_use_uas_driver(intf, id))
907 if (uas_switch_interface(udev, intf))
910 shost = scsi_host_alloc(&uas_host_template,
911 sizeof(struct uas_dev_info));
915 shost->max_cmd_len = 16 + 252;
917 shost->max_lun = 256;
918 shost->max_channel = 0;
919 shost->sg_tablesize = udev->bus->sg_tablesize;
921 devinfo = (struct uas_dev_info *)shost->hostdata;
922 devinfo->intf = intf;
923 devinfo->udev = udev;
924 devinfo->resetting = 0;
925 devinfo->shutdown = 0;
926 devinfo->flags = id->driver_info;
927 usb_stor_adjust_quirks(udev, &devinfo->flags);
928 init_usb_anchor(&devinfo->cmd_urbs);
929 init_usb_anchor(&devinfo->sense_urbs);
930 init_usb_anchor(&devinfo->data_urbs);
931 spin_lock_init(&devinfo->lock);
932 INIT_WORK(&devinfo->work, uas_do_work);
934 result = uas_configure_endpoints(devinfo);
938 result = scsi_init_shared_tag_map(shost, devinfo->qdepth - 2);
942 usb_set_intfdata(intf, shost);
943 result = scsi_add_host(shost, &intf->dev);
947 scsi_scan_host(shost);
951 uas_free_streams(devinfo);
952 usb_set_intfdata(intf, NULL);
954 usb_set_interface(udev, intf->altsetting[0].desc.bInterfaceNumber, 0);
956 scsi_host_put(shost);
960 static int uas_cmnd_list_empty(struct uas_dev_info *devinfo)
965 spin_lock_irqsave(&devinfo->lock, flags);
967 for (i = 0; i < devinfo->qdepth; i++) {
968 if (devinfo->cmnd[i]) {
969 r = 0; /* Not empty */
974 spin_unlock_irqrestore(&devinfo->lock, flags);
980 * Wait for any pending cmnds to complete, on usb-2 sense_urbs may temporarily
981 * get empty while there still is more work to do due to sense-urbs completing
982 * with a READ/WRITE_READY iu code, so keep waiting until the list gets empty.
984 static int uas_wait_for_pending_cmnds(struct uas_dev_info *devinfo)
986 unsigned long start_time;
989 start_time = jiffies;
991 flush_work(&devinfo->work);
993 r = usb_wait_anchor_empty_timeout(&devinfo->sense_urbs, 5000);
997 r = usb_wait_anchor_empty_timeout(&devinfo->data_urbs, 500);
1001 if (time_after(jiffies, start_time + 5 * HZ))
1003 } while (!uas_cmnd_list_empty(devinfo));
1008 static int uas_pre_reset(struct usb_interface *intf)
1010 struct Scsi_Host *shost = usb_get_intfdata(intf);
1011 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1012 unsigned long flags;
1014 if (devinfo->shutdown)
1017 /* Block new requests */
1018 spin_lock_irqsave(shost->host_lock, flags);
1019 scsi_block_requests(shost);
1020 spin_unlock_irqrestore(shost->host_lock, flags);
1022 if (uas_wait_for_pending_cmnds(devinfo) != 0) {
1023 shost_printk(KERN_ERR, shost, "%s: timed out\n", __func__);
1024 scsi_unblock_requests(shost);
1028 uas_free_streams(devinfo);
1033 static int uas_post_reset(struct usb_interface *intf)
1035 struct Scsi_Host *shost = usb_get_intfdata(intf);
1036 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1037 unsigned long flags;
1040 if (devinfo->shutdown)
1043 err = uas_configure_endpoints(devinfo);
1045 shost_printk(KERN_ERR, shost,
1046 "%s: alloc streams error %d after reset",
1051 spin_lock_irqsave(shost->host_lock, flags);
1052 scsi_report_bus_reset(shost, 0);
1053 spin_unlock_irqrestore(shost->host_lock, flags);
1055 scsi_unblock_requests(shost);
1060 static int uas_suspend(struct usb_interface *intf, pm_message_t message)
1062 struct Scsi_Host *shost = usb_get_intfdata(intf);
1063 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1065 if (uas_wait_for_pending_cmnds(devinfo) != 0) {
1066 shost_printk(KERN_ERR, shost, "%s: timed out\n", __func__);
1073 static int uas_resume(struct usb_interface *intf)
1078 static int uas_reset_resume(struct usb_interface *intf)
1080 struct Scsi_Host *shost = usb_get_intfdata(intf);
1081 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1082 unsigned long flags;
1085 err = uas_configure_endpoints(devinfo);
1087 shost_printk(KERN_ERR, shost,
1088 "%s: alloc streams error %d after reset",
1093 spin_lock_irqsave(shost->host_lock, flags);
1094 scsi_report_bus_reset(shost, 0);
1095 spin_unlock_irqrestore(shost->host_lock, flags);
1100 static void uas_disconnect(struct usb_interface *intf)
1102 struct Scsi_Host *shost = usb_get_intfdata(intf);
1103 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1104 unsigned long flags;
1106 spin_lock_irqsave(&devinfo->lock, flags);
1107 devinfo->resetting = 1;
1108 spin_unlock_irqrestore(&devinfo->lock, flags);
1110 cancel_work_sync(&devinfo->work);
1111 usb_kill_anchored_urbs(&devinfo->cmd_urbs);
1112 usb_kill_anchored_urbs(&devinfo->sense_urbs);
1113 usb_kill_anchored_urbs(&devinfo->data_urbs);
1114 uas_zap_pending(devinfo, DID_NO_CONNECT);
1116 scsi_remove_host(shost);
1117 uas_free_streams(devinfo);
1118 scsi_host_put(shost);
1122 * Put the device back in usb-storage mode on shutdown, as some BIOS-es
1123 * hang on reboot when the device is still in uas mode. Note the reset is
1124 * necessary as some devices won't revert to usb-storage mode without it.
1126 static void uas_shutdown(struct device *dev)
1128 struct usb_interface *intf = to_usb_interface(dev);
1129 struct usb_device *udev = interface_to_usbdev(intf);
1130 struct Scsi_Host *shost = usb_get_intfdata(intf);
1131 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1133 if (system_state != SYSTEM_RESTART)
1136 devinfo->shutdown = 1;
1137 uas_free_streams(devinfo);
1138 usb_set_interface(udev, intf->altsetting[0].desc.bInterfaceNumber, 0);
1139 usb_reset_device(udev);
1142 static struct usb_driver uas_driver = {
1145 .disconnect = uas_disconnect,
1146 .pre_reset = uas_pre_reset,
1147 .post_reset = uas_post_reset,
1148 .suspend = uas_suspend,
1149 .resume = uas_resume,
1150 .reset_resume = uas_reset_resume,
1151 .drvwrap.driver.shutdown = uas_shutdown,
1152 .id_table = uas_usb_ids,
1155 module_usb_driver(uas_driver);
1157 MODULE_LICENSE("GPL");
1159 "Hans de Goede <hdegoede@redhat.com>, Matthew Wilcox and Sarah Sharp");