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"
34 * The r00-r01c specs define this version of the SENSE IU data structure.
35 * It's still in use by several different firmware releases.
43 __u8 service_response;
44 __u8 sense[SCSI_SENSE_BUFFERSIZE];
48 struct usb_interface *intf;
49 struct usb_device *udev;
50 struct usb_anchor cmd_urbs;
51 struct usb_anchor sense_urbs;
52 struct usb_anchor data_urbs;
54 int qdepth, resetting;
55 unsigned cmd_pipe, status_pipe, data_in_pipe, data_out_pipe;
56 unsigned use_streams:1;
57 unsigned uas_sense_old:1;
59 struct scsi_cmnd *cmnd;
61 struct work_struct work;
62 struct list_head inflight_list;
63 struct list_head dead_list;
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_COMPLETED = (1 << 11),
78 COMMAND_ABORTED = (1 << 12),
79 UNLINK_DATA_URBS = (1 << 13),
80 IS_IN_WORK_LIST = (1 << 14),
83 /* Overrides scsi_pointer */
88 struct urb *data_in_urb;
89 struct urb *data_out_urb;
90 struct list_head list;
93 /* I hate forward declarations, but I actually have a loop */
94 static int uas_submit_urbs(struct scsi_cmnd *cmnd,
95 struct uas_dev_info *devinfo, gfp_t gfp);
96 static void uas_do_work(struct work_struct *work);
97 static int uas_try_complete(struct scsi_cmnd *cmnd, const char *caller);
98 static void uas_free_streams(struct uas_dev_info *devinfo);
99 static void uas_log_cmd_state(struct scsi_cmnd *cmnd, const char *caller);
101 /* Must be called with devinfo->lock held, will temporary unlock the lock */
102 static void uas_unlink_data_urbs(struct uas_dev_info *devinfo,
103 struct uas_cmd_info *cmdinfo,
104 unsigned long *lock_flags)
107 * The UNLINK_DATA_URBS flag makes sure uas_try_complete
108 * (called by urb completion) doesn't release cmdinfo
111 cmdinfo->state |= UNLINK_DATA_URBS;
112 spin_unlock_irqrestore(&devinfo->lock, *lock_flags);
114 if (cmdinfo->data_in_urb)
115 usb_unlink_urb(cmdinfo->data_in_urb);
116 if (cmdinfo->data_out_urb)
117 usb_unlink_urb(cmdinfo->data_out_urb);
119 spin_lock_irqsave(&devinfo->lock, *lock_flags);
120 cmdinfo->state &= ~UNLINK_DATA_URBS;
123 static void uas_do_work(struct work_struct *work)
125 struct uas_dev_info *devinfo =
126 container_of(work, struct uas_dev_info, work);
127 struct uas_cmd_info *cmdinfo;
131 spin_lock_irqsave(&devinfo->lock, flags);
133 if (devinfo->resetting)
136 list_for_each_entry(cmdinfo, &devinfo->inflight_list, list) {
137 struct scsi_pointer *scp = (void *)cmdinfo;
138 struct scsi_cmnd *cmnd = container_of(scp, struct scsi_cmnd,
141 if (!(cmdinfo->state & IS_IN_WORK_LIST))
144 err = uas_submit_urbs(cmnd, cmnd->device->hostdata, GFP_ATOMIC);
146 cmdinfo->state &= ~IS_IN_WORK_LIST;
148 schedule_work(&devinfo->work);
151 spin_unlock_irqrestore(&devinfo->lock, flags);
154 static void uas_mark_cmd_dead(struct uas_dev_info *devinfo,
155 struct uas_cmd_info *cmdinfo,
156 int result, const char *caller)
158 struct scsi_pointer *scp = (void *)cmdinfo;
159 struct scsi_cmnd *cmnd = container_of(scp, struct scsi_cmnd, SCp);
161 uas_log_cmd_state(cmnd, caller);
162 lockdep_assert_held(&devinfo->lock);
163 WARN_ON_ONCE(cmdinfo->state & COMMAND_ABORTED);
164 cmdinfo->state |= COMMAND_ABORTED;
165 cmdinfo->state &= ~IS_IN_WORK_LIST;
166 cmnd->result = result << 16;
167 list_move_tail(&cmdinfo->list, &devinfo->dead_list);
170 static void uas_abort_inflight(struct uas_dev_info *devinfo, int result,
173 struct uas_cmd_info *cmdinfo;
174 struct uas_cmd_info *temp;
177 spin_lock_irqsave(&devinfo->lock, flags);
178 list_for_each_entry_safe(cmdinfo, temp, &devinfo->inflight_list, list)
179 uas_mark_cmd_dead(devinfo, cmdinfo, result, caller);
180 spin_unlock_irqrestore(&devinfo->lock, flags);
183 static void uas_add_work(struct uas_cmd_info *cmdinfo)
185 struct scsi_pointer *scp = (void *)cmdinfo;
186 struct scsi_cmnd *cmnd = container_of(scp, struct scsi_cmnd, SCp);
187 struct uas_dev_info *devinfo = cmnd->device->hostdata;
189 lockdep_assert_held(&devinfo->lock);
190 cmdinfo->state |= IS_IN_WORK_LIST;
191 schedule_work(&devinfo->work);
194 static void uas_zap_dead(struct uas_dev_info *devinfo)
196 struct uas_cmd_info *cmdinfo;
197 struct uas_cmd_info *temp;
200 spin_lock_irqsave(&devinfo->lock, flags);
201 list_for_each_entry_safe(cmdinfo, temp, &devinfo->dead_list, list) {
202 struct scsi_pointer *scp = (void *)cmdinfo;
203 struct scsi_cmnd *cmnd = container_of(scp, struct scsi_cmnd,
205 uas_log_cmd_state(cmnd, __func__);
206 WARN_ON_ONCE(!(cmdinfo->state & COMMAND_ABORTED));
207 /* all urbs are killed, clear inflight bits */
208 cmdinfo->state &= ~(COMMAND_INFLIGHT |
209 DATA_IN_URB_INFLIGHT |
210 DATA_OUT_URB_INFLIGHT);
211 uas_try_complete(cmnd, __func__);
213 spin_unlock_irqrestore(&devinfo->lock, flags);
216 static void uas_sense(struct urb *urb, struct scsi_cmnd *cmnd)
218 struct sense_iu *sense_iu = urb->transfer_buffer;
219 struct scsi_device *sdev = cmnd->device;
221 if (urb->actual_length > 16) {
222 unsigned len = be16_to_cpup(&sense_iu->len);
223 if (len + 16 != urb->actual_length) {
224 int newlen = min(len + 16, urb->actual_length) - 16;
227 sdev_printk(KERN_INFO, sdev, "%s: urb length %d "
228 "disagrees with IU sense data length %d, "
229 "using %d bytes of sense data\n", __func__,
230 urb->actual_length, len, newlen);
233 memcpy(cmnd->sense_buffer, sense_iu->sense, len);
236 cmnd->result = sense_iu->status;
239 static void uas_sense_old(struct urb *urb, struct scsi_cmnd *cmnd)
241 struct sense_iu_old *sense_iu = urb->transfer_buffer;
242 struct scsi_device *sdev = cmnd->device;
244 if (urb->actual_length > 8) {
245 unsigned len = be16_to_cpup(&sense_iu->len) - 2;
246 if (len + 8 != urb->actual_length) {
247 int newlen = min(len + 8, urb->actual_length) - 8;
250 sdev_printk(KERN_INFO, sdev, "%s: urb length %d "
251 "disagrees with IU sense data length %d, "
252 "using %d bytes of sense data\n", __func__,
253 urb->actual_length, len, newlen);
256 memcpy(cmnd->sense_buffer, sense_iu->sense, len);
259 cmnd->result = sense_iu->status;
263 * scsi-tags go from 0 - (nr_tags - 1), uas tags need to match stream-ids,
264 * which go from 1 - nr_streams. And we use 1 for untagged commands.
266 static int uas_get_tag(struct scsi_cmnd *cmnd)
270 if (blk_rq_tagged(cmnd->request))
271 tag = cmnd->request->tag + 2;
278 static void uas_log_cmd_state(struct scsi_cmnd *cmnd, const char *caller)
280 struct uas_cmd_info *ci = (void *)&cmnd->SCp;
282 scmd_printk(KERN_INFO, cmnd, "%s %p tag %d, inflight:"
283 "%s%s%s%s%s%s%s%s%s%s%s%s%s%s\n",
284 caller, cmnd, uas_get_tag(cmnd),
285 (ci->state & SUBMIT_STATUS_URB) ? " s-st" : "",
286 (ci->state & ALLOC_DATA_IN_URB) ? " a-in" : "",
287 (ci->state & SUBMIT_DATA_IN_URB) ? " s-in" : "",
288 (ci->state & ALLOC_DATA_OUT_URB) ? " a-out" : "",
289 (ci->state & SUBMIT_DATA_OUT_URB) ? " s-out" : "",
290 (ci->state & ALLOC_CMD_URB) ? " a-cmd" : "",
291 (ci->state & SUBMIT_CMD_URB) ? " s-cmd" : "",
292 (ci->state & COMMAND_INFLIGHT) ? " CMD" : "",
293 (ci->state & DATA_IN_URB_INFLIGHT) ? " IN" : "",
294 (ci->state & DATA_OUT_URB_INFLIGHT) ? " OUT" : "",
295 (ci->state & COMMAND_COMPLETED) ? " done" : "",
296 (ci->state & COMMAND_ABORTED) ? " abort" : "",
297 (ci->state & UNLINK_DATA_URBS) ? " unlink": "",
298 (ci->state & IS_IN_WORK_LIST) ? " work" : "");
301 static int uas_try_complete(struct scsi_cmnd *cmnd, const char *caller)
303 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
304 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
306 lockdep_assert_held(&devinfo->lock);
307 if (cmdinfo->state & (COMMAND_INFLIGHT |
308 DATA_IN_URB_INFLIGHT |
309 DATA_OUT_URB_INFLIGHT |
312 WARN_ON_ONCE(cmdinfo->state & COMMAND_COMPLETED);
313 cmdinfo->state |= COMMAND_COMPLETED;
314 usb_free_urb(cmdinfo->data_in_urb);
315 usb_free_urb(cmdinfo->data_out_urb);
316 if (cmdinfo->state & COMMAND_ABORTED)
317 scmd_printk(KERN_INFO, cmnd, "abort completed\n");
318 list_del(&cmdinfo->list);
319 cmnd->scsi_done(cmnd);
323 static void uas_xfer_data(struct urb *urb, struct scsi_cmnd *cmnd,
326 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
329 cmdinfo->state |= direction | SUBMIT_STATUS_URB;
330 err = uas_submit_urbs(cmnd, cmnd->device->hostdata, GFP_ATOMIC);
332 uas_add_work(cmdinfo);
336 static void uas_stat_cmplt(struct urb *urb)
338 struct iu *iu = urb->transfer_buffer;
339 struct Scsi_Host *shost = urb->context;
340 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
341 struct scsi_cmnd *cmnd;
342 struct uas_cmd_info *cmdinfo;
346 spin_lock_irqsave(&devinfo->lock, flags);
348 if (devinfo->resetting)
352 if (urb->status == -ENOENT) {
353 dev_err(&urb->dev->dev, "stat urb: killed, stream %d\n",
356 dev_err(&urb->dev->dev, "stat urb: status %d\n",
362 tag = be16_to_cpup(&iu->tag) - 1;
364 cmnd = devinfo->cmnd;
366 cmnd = scsi_host_find_tag(shost, tag - 1);
371 cmdinfo = (void *)&cmnd->SCp;
374 if (devinfo->cmnd == cmnd)
375 devinfo->cmnd = NULL;
377 if (urb->actual_length < 16)
378 devinfo->uas_sense_old = 1;
379 if (devinfo->uas_sense_old)
380 uas_sense_old(urb, cmnd);
382 uas_sense(urb, cmnd);
383 if (cmnd->result != 0) {
384 /* cancel data transfers on error */
385 uas_unlink_data_urbs(devinfo, cmdinfo, &flags);
387 cmdinfo->state &= ~COMMAND_INFLIGHT;
388 uas_try_complete(cmnd, __func__);
390 case IU_ID_READ_READY:
391 if (!cmdinfo->data_in_urb ||
392 (cmdinfo->state & DATA_IN_URB_INFLIGHT)) {
393 scmd_printk(KERN_ERR, cmnd, "unexpected read rdy\n");
396 uas_xfer_data(urb, cmnd, SUBMIT_DATA_IN_URB);
398 case IU_ID_WRITE_READY:
399 if (!cmdinfo->data_out_urb ||
400 (cmdinfo->state & DATA_OUT_URB_INFLIGHT)) {
401 scmd_printk(KERN_ERR, cmnd, "unexpected write rdy\n");
404 uas_xfer_data(urb, cmnd, SUBMIT_DATA_OUT_URB);
407 scmd_printk(KERN_ERR, cmnd,
408 "Bogus IU (%d) received on status pipe\n", iu->iu_id);
412 spin_unlock_irqrestore(&devinfo->lock, flags);
415 static void uas_data_cmplt(struct urb *urb)
417 struct scsi_cmnd *cmnd = urb->context;
418 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
419 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
420 struct scsi_data_buffer *sdb = NULL;
423 spin_lock_irqsave(&devinfo->lock, flags);
425 if (cmdinfo->data_in_urb == urb) {
427 cmdinfo->state &= ~DATA_IN_URB_INFLIGHT;
428 } else if (cmdinfo->data_out_urb == urb) {
429 sdb = scsi_out(cmnd);
430 cmdinfo->state &= ~DATA_OUT_URB_INFLIGHT;
437 if (devinfo->resetting)
441 if (urb->status != -ECONNRESET) {
442 uas_log_cmd_state(cmnd, __func__);
443 scmd_printk(KERN_ERR, cmnd,
444 "data cmplt err %d stream %d\n",
445 urb->status, urb->stream_id);
447 /* error: no data transfered */
448 sdb->resid = sdb->length;
450 sdb->resid = sdb->length - urb->actual_length;
452 uas_try_complete(cmnd, __func__);
454 spin_unlock_irqrestore(&devinfo->lock, flags);
457 static void uas_cmd_cmplt(struct urb *urb)
459 struct scsi_cmnd *cmnd = urb->context;
462 uas_log_cmd_state(cmnd, __func__);
463 scmd_printk(KERN_ERR, cmnd, "cmd cmplt err %d\n", urb->status);
468 static struct urb *uas_alloc_data_urb(struct uas_dev_info *devinfo, gfp_t gfp,
469 unsigned int pipe, u16 stream_id,
470 struct scsi_cmnd *cmnd,
471 enum dma_data_direction dir)
473 struct usb_device *udev = devinfo->udev;
474 struct urb *urb = usb_alloc_urb(0, gfp);
475 struct scsi_data_buffer *sdb = (dir == DMA_FROM_DEVICE)
476 ? scsi_in(cmnd) : scsi_out(cmnd);
480 usb_fill_bulk_urb(urb, udev, pipe, NULL, sdb->length,
481 uas_data_cmplt, cmnd);
482 urb->stream_id = stream_id;
483 urb->num_sgs = udev->bus->sg_tablesize ? sdb->table.nents : 0;
484 urb->sg = sdb->table.sgl;
489 static struct urb *uas_alloc_sense_urb(struct uas_dev_info *devinfo, gfp_t gfp,
490 struct Scsi_Host *shost, u16 stream_id)
492 struct usb_device *udev = devinfo->udev;
493 struct urb *urb = usb_alloc_urb(0, gfp);
499 iu = kzalloc(sizeof(*iu), gfp);
503 usb_fill_bulk_urb(urb, udev, devinfo->status_pipe, iu, sizeof(*iu),
504 uas_stat_cmplt, shost);
505 urb->stream_id = stream_id;
506 urb->transfer_flags |= URB_FREE_BUFFER;
514 static struct urb *uas_alloc_cmd_urb(struct uas_dev_info *devinfo, gfp_t gfp,
515 struct scsi_cmnd *cmnd)
517 struct usb_device *udev = devinfo->udev;
518 struct scsi_device *sdev = cmnd->device;
519 struct urb *urb = usb_alloc_urb(0, gfp);
520 struct command_iu *iu;
526 len = cmnd->cmd_len - 16;
530 iu = kzalloc(sizeof(*iu) + len, gfp);
534 iu->iu_id = IU_ID_COMMAND;
535 iu->tag = cpu_to_be16(uas_get_tag(cmnd));
536 iu->prio_attr = UAS_SIMPLE_TAG;
538 int_to_scsilun(sdev->lun, &iu->lun);
539 memcpy(iu->cdb, cmnd->cmnd, cmnd->cmd_len);
541 usb_fill_bulk_urb(urb, udev, devinfo->cmd_pipe, iu, sizeof(*iu) + len,
542 uas_cmd_cmplt, cmnd);
543 urb->transfer_flags |= URB_FREE_BUFFER;
552 * Why should I request the Status IU before sending the Command IU? Spec
553 * says to, but also says the device may receive them in any order. Seems
557 static struct urb *uas_submit_sense_urb(struct scsi_cmnd *cmnd,
558 gfp_t gfp, unsigned int stream)
560 struct Scsi_Host *shost = cmnd->device->host;
561 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
565 urb = uas_alloc_sense_urb(devinfo, gfp, shost, stream);
568 usb_anchor_urb(urb, &devinfo->sense_urbs);
569 err = usb_submit_urb(urb, gfp);
571 usb_unanchor_urb(urb);
572 uas_log_cmd_state(cmnd, __func__);
573 shost_printk(KERN_INFO, shost,
574 "sense urb submission error %d stream %d\n",
582 static int uas_submit_urbs(struct scsi_cmnd *cmnd,
583 struct uas_dev_info *devinfo, gfp_t gfp)
585 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
589 lockdep_assert_held(&devinfo->lock);
590 if (cmdinfo->state & SUBMIT_STATUS_URB) {
591 urb = uas_submit_sense_urb(cmnd, gfp, cmdinfo->stream);
593 return SCSI_MLQUEUE_DEVICE_BUSY;
594 cmdinfo->state &= ~SUBMIT_STATUS_URB;
597 if (cmdinfo->state & ALLOC_DATA_IN_URB) {
598 cmdinfo->data_in_urb = uas_alloc_data_urb(devinfo, gfp,
599 devinfo->data_in_pipe, cmdinfo->stream,
600 cmnd, DMA_FROM_DEVICE);
601 if (!cmdinfo->data_in_urb)
602 return SCSI_MLQUEUE_DEVICE_BUSY;
603 cmdinfo->state &= ~ALLOC_DATA_IN_URB;
606 if (cmdinfo->state & SUBMIT_DATA_IN_URB) {
607 usb_anchor_urb(cmdinfo->data_in_urb, &devinfo->data_urbs);
608 err = usb_submit_urb(cmdinfo->data_in_urb, gfp);
610 usb_unanchor_urb(cmdinfo->data_in_urb);
611 uas_log_cmd_state(cmnd, __func__);
612 scmd_printk(KERN_INFO, cmnd,
613 "data in urb submission error %d stream %d\n",
614 err, cmdinfo->data_in_urb->stream_id);
615 return SCSI_MLQUEUE_DEVICE_BUSY;
617 cmdinfo->state &= ~SUBMIT_DATA_IN_URB;
618 cmdinfo->state |= DATA_IN_URB_INFLIGHT;
621 if (cmdinfo->state & ALLOC_DATA_OUT_URB) {
622 cmdinfo->data_out_urb = uas_alloc_data_urb(devinfo, gfp,
623 devinfo->data_out_pipe, cmdinfo->stream,
624 cmnd, DMA_TO_DEVICE);
625 if (!cmdinfo->data_out_urb)
626 return SCSI_MLQUEUE_DEVICE_BUSY;
627 cmdinfo->state &= ~ALLOC_DATA_OUT_URB;
630 if (cmdinfo->state & SUBMIT_DATA_OUT_URB) {
631 usb_anchor_urb(cmdinfo->data_out_urb, &devinfo->data_urbs);
632 err = usb_submit_urb(cmdinfo->data_out_urb, gfp);
634 usb_unanchor_urb(cmdinfo->data_out_urb);
635 uas_log_cmd_state(cmnd, __func__);
636 scmd_printk(KERN_INFO, cmnd,
637 "data out urb submission error %d stream %d\n",
638 err, cmdinfo->data_out_urb->stream_id);
639 return SCSI_MLQUEUE_DEVICE_BUSY;
641 cmdinfo->state &= ~SUBMIT_DATA_OUT_URB;
642 cmdinfo->state |= DATA_OUT_URB_INFLIGHT;
645 if (cmdinfo->state & ALLOC_CMD_URB) {
646 cmdinfo->cmd_urb = uas_alloc_cmd_urb(devinfo, gfp, cmnd);
647 if (!cmdinfo->cmd_urb)
648 return SCSI_MLQUEUE_DEVICE_BUSY;
649 cmdinfo->state &= ~ALLOC_CMD_URB;
652 if (cmdinfo->state & SUBMIT_CMD_URB) {
653 usb_anchor_urb(cmdinfo->cmd_urb, &devinfo->cmd_urbs);
654 err = usb_submit_urb(cmdinfo->cmd_urb, gfp);
656 usb_unanchor_urb(cmdinfo->cmd_urb);
657 uas_log_cmd_state(cmnd, __func__);
658 scmd_printk(KERN_INFO, cmnd,
659 "cmd urb submission error %d\n", err);
660 return SCSI_MLQUEUE_DEVICE_BUSY;
662 cmdinfo->cmd_urb = NULL;
663 cmdinfo->state &= ~SUBMIT_CMD_URB;
664 cmdinfo->state |= COMMAND_INFLIGHT;
670 static int uas_queuecommand_lck(struct scsi_cmnd *cmnd,
671 void (*done)(struct scsi_cmnd *))
673 struct scsi_device *sdev = cmnd->device;
674 struct uas_dev_info *devinfo = sdev->hostdata;
675 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
679 BUILD_BUG_ON(sizeof(struct uas_cmd_info) > sizeof(struct scsi_pointer));
681 if ((devinfo->flags & US_FL_NO_ATA_1X) &&
682 (cmnd->cmnd[0] == ATA_12 || cmnd->cmnd[0] == ATA_16)) {
683 memcpy(cmnd->sense_buffer, usb_stor_sense_invalidCDB,
684 sizeof(usb_stor_sense_invalidCDB));
685 cmnd->result = SAM_STAT_CHECK_CONDITION;
686 cmnd->scsi_done(cmnd);
690 spin_lock_irqsave(&devinfo->lock, flags);
692 if (devinfo->resetting) {
693 cmnd->result = DID_ERROR << 16;
694 cmnd->scsi_done(cmnd);
695 spin_unlock_irqrestore(&devinfo->lock, flags);
700 spin_unlock_irqrestore(&devinfo->lock, flags);
701 return SCSI_MLQUEUE_DEVICE_BUSY;
704 memset(cmdinfo, 0, sizeof(*cmdinfo));
706 if (!blk_rq_tagged(cmnd->request))
707 devinfo->cmnd = cmnd;
709 cmnd->scsi_done = done;
711 cmdinfo->stream = uas_get_tag(cmnd);
712 cmdinfo->state = SUBMIT_STATUS_URB | ALLOC_CMD_URB | SUBMIT_CMD_URB;
714 switch (cmnd->sc_data_direction) {
715 case DMA_FROM_DEVICE:
716 cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
718 case DMA_BIDIRECTIONAL:
719 cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
721 cmdinfo->state |= ALLOC_DATA_OUT_URB | SUBMIT_DATA_OUT_URB;
726 if (!devinfo->use_streams) {
727 cmdinfo->state &= ~(SUBMIT_DATA_IN_URB | SUBMIT_DATA_OUT_URB);
731 err = uas_submit_urbs(cmnd, devinfo, GFP_ATOMIC);
733 /* If we did nothing, give up now */
734 if (cmdinfo->state & SUBMIT_STATUS_URB) {
735 spin_unlock_irqrestore(&devinfo->lock, flags);
736 return SCSI_MLQUEUE_DEVICE_BUSY;
738 uas_add_work(cmdinfo);
741 list_add_tail(&cmdinfo->list, &devinfo->inflight_list);
742 spin_unlock_irqrestore(&devinfo->lock, flags);
746 static DEF_SCSI_QCMD(uas_queuecommand)
748 static int uas_eh_bus_reset_handler(struct scsi_cmnd *cmnd)
750 struct scsi_device *sdev = cmnd->device;
751 struct uas_dev_info *devinfo = sdev->hostdata;
752 struct usb_device *udev = devinfo->udev;
756 err = usb_lock_device_for_reset(udev, devinfo->intf);
758 shost_printk(KERN_ERR, sdev->host,
759 "%s FAILED to get lock err %d\n", __func__, err);
763 shost_printk(KERN_INFO, sdev->host, "%s start\n", __func__);
765 spin_lock_irqsave(&devinfo->lock, flags);
766 devinfo->resetting = 1;
767 spin_unlock_irqrestore(&devinfo->lock, flags);
769 uas_abort_inflight(devinfo, DID_RESET, __func__);
770 usb_kill_anchored_urbs(&devinfo->cmd_urbs);
771 usb_kill_anchored_urbs(&devinfo->sense_urbs);
772 usb_kill_anchored_urbs(&devinfo->data_urbs);
773 uas_zap_dead(devinfo);
774 err = usb_reset_device(udev);
776 spin_lock_irqsave(&devinfo->lock, flags);
777 devinfo->resetting = 0;
778 spin_unlock_irqrestore(&devinfo->lock, flags);
780 usb_unlock_device(udev);
783 shost_printk(KERN_INFO, sdev->host, "%s FAILED\n", __func__);
787 shost_printk(KERN_INFO, sdev->host, "%s success\n", __func__);
791 static int uas_slave_alloc(struct scsi_device *sdev)
793 sdev->hostdata = (void *)sdev->host->hostdata;
795 /* USB has unusual DMA-alignment requirements: Although the
796 * starting address of each scatter-gather element doesn't matter,
797 * the length of each element except the last must be divisible
798 * by the Bulk maxpacket value. There's currently no way to
799 * express this by block-layer constraints, so we'll cop out
800 * and simply require addresses to be aligned at 512-byte
801 * boundaries. This is okay since most block I/O involves
802 * hardware sectors that are multiples of 512 bytes in length,
803 * and since host controllers up through USB 2.0 have maxpacket
804 * values no larger than 512.
806 * But it doesn't suffice for Wireless USB, where Bulk maxpacket
807 * values can be as large as 2048. To make that work properly
808 * will require changes to the block layer.
810 blk_queue_update_dma_alignment(sdev->request_queue, (512 - 1));
815 static int uas_slave_configure(struct scsi_device *sdev)
817 struct uas_dev_info *devinfo = sdev->hostdata;
819 if (devinfo->flags & US_FL_NO_REPORT_OPCODES)
820 sdev->no_report_opcodes = 1;
822 scsi_set_tag_type(sdev, MSG_ORDERED_TAG);
823 scsi_activate_tcq(sdev, devinfo->qdepth - 2);
827 static struct scsi_host_template uas_host_template = {
828 .module = THIS_MODULE,
830 .queuecommand = uas_queuecommand,
831 .slave_alloc = uas_slave_alloc,
832 .slave_configure = uas_slave_configure,
833 .eh_bus_reset_handler = uas_eh_bus_reset_handler,
834 .can_queue = 65536, /* Is there a limit on the _host_ ? */
836 .sg_tablesize = SG_NONE,
837 .cmd_per_lun = 1, /* until we override it */
838 .skip_settle_delay = 1,
842 #define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \
843 vendorName, productName, useProtocol, useTransport, \
844 initFunction, flags) \
845 { USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax), \
846 .driver_info = (flags) }
848 static struct usb_device_id uas_usb_ids[] = {
849 # include "unusual_uas.h"
850 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_BULK) },
851 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_UAS) },
852 /* 0xaa is a prototype device I happen to have access to */
853 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, 0xaa) },
856 MODULE_DEVICE_TABLE(usb, uas_usb_ids);
860 static int uas_switch_interface(struct usb_device *udev,
861 struct usb_interface *intf)
865 alt = uas_find_uas_alt_setting(intf);
869 return usb_set_interface(udev,
870 intf->altsetting[0].desc.bInterfaceNumber, alt);
873 static int uas_configure_endpoints(struct uas_dev_info *devinfo)
875 struct usb_host_endpoint *eps[4] = { };
876 struct usb_device *udev = devinfo->udev;
879 devinfo->uas_sense_old = 0;
880 devinfo->cmnd = NULL;
882 r = uas_find_endpoints(devinfo->intf->cur_altsetting, eps);
886 devinfo->cmd_pipe = usb_sndbulkpipe(udev,
887 usb_endpoint_num(&eps[0]->desc));
888 devinfo->status_pipe = usb_rcvbulkpipe(udev,
889 usb_endpoint_num(&eps[1]->desc));
890 devinfo->data_in_pipe = usb_rcvbulkpipe(udev,
891 usb_endpoint_num(&eps[2]->desc));
892 devinfo->data_out_pipe = usb_sndbulkpipe(udev,
893 usb_endpoint_num(&eps[3]->desc));
895 if (udev->speed != USB_SPEED_SUPER) {
896 devinfo->qdepth = 32;
897 devinfo->use_streams = 0;
899 devinfo->qdepth = usb_alloc_streams(devinfo->intf, eps + 1,
901 if (devinfo->qdepth < 0)
902 return devinfo->qdepth;
903 devinfo->use_streams = 1;
909 static void uas_free_streams(struct uas_dev_info *devinfo)
911 struct usb_device *udev = devinfo->udev;
912 struct usb_host_endpoint *eps[3];
914 eps[0] = usb_pipe_endpoint(udev, devinfo->status_pipe);
915 eps[1] = usb_pipe_endpoint(udev, devinfo->data_in_pipe);
916 eps[2] = usb_pipe_endpoint(udev, devinfo->data_out_pipe);
917 usb_free_streams(devinfo->intf, eps, 3, GFP_NOIO);
920 static int uas_probe(struct usb_interface *intf, const struct usb_device_id *id)
922 int result = -ENOMEM;
923 struct Scsi_Host *shost = NULL;
924 struct uas_dev_info *devinfo;
925 struct usb_device *udev = interface_to_usbdev(intf);
927 if (!uas_use_uas_driver(intf, id))
930 if (uas_switch_interface(udev, intf))
933 shost = scsi_host_alloc(&uas_host_template,
934 sizeof(struct uas_dev_info));
938 shost->max_cmd_len = 16 + 252;
940 shost->max_lun = 256;
941 shost->max_channel = 0;
942 shost->sg_tablesize = udev->bus->sg_tablesize;
944 devinfo = (struct uas_dev_info *)shost->hostdata;
945 devinfo->intf = intf;
946 devinfo->udev = udev;
947 devinfo->resetting = 0;
948 devinfo->shutdown = 0;
949 devinfo->flags = id->driver_info;
950 usb_stor_adjust_quirks(udev, &devinfo->flags);
951 init_usb_anchor(&devinfo->cmd_urbs);
952 init_usb_anchor(&devinfo->sense_urbs);
953 init_usb_anchor(&devinfo->data_urbs);
954 spin_lock_init(&devinfo->lock);
955 INIT_WORK(&devinfo->work, uas_do_work);
956 INIT_LIST_HEAD(&devinfo->inflight_list);
957 INIT_LIST_HEAD(&devinfo->dead_list);
959 result = uas_configure_endpoints(devinfo);
963 result = scsi_init_shared_tag_map(shost, devinfo->qdepth - 2);
967 usb_set_intfdata(intf, shost);
968 result = scsi_add_host(shost, &intf->dev);
972 scsi_scan_host(shost);
976 uas_free_streams(devinfo);
977 usb_set_intfdata(intf, NULL);
979 usb_set_interface(udev, intf->altsetting[0].desc.bInterfaceNumber, 0);
981 scsi_host_put(shost);
985 static int uas_pre_reset(struct usb_interface *intf)
987 struct Scsi_Host *shost = usb_get_intfdata(intf);
988 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
991 if (devinfo->shutdown)
994 /* Block new requests */
995 spin_lock_irqsave(shost->host_lock, flags);
996 scsi_block_requests(shost);
997 spin_unlock_irqrestore(shost->host_lock, flags);
999 /* Wait for any pending requests to complete */
1000 flush_work(&devinfo->work);
1001 if (usb_wait_anchor_empty_timeout(&devinfo->sense_urbs, 5000) == 0) {
1002 shost_printk(KERN_ERR, shost, "%s: timed out\n", __func__);
1006 uas_free_streams(devinfo);
1011 static int uas_post_reset(struct usb_interface *intf)
1013 struct Scsi_Host *shost = usb_get_intfdata(intf);
1014 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1015 unsigned long flags;
1017 if (devinfo->shutdown)
1020 if (uas_configure_endpoints(devinfo) != 0) {
1021 shost_printk(KERN_ERR, shost,
1022 "%s: alloc streams error after reset", __func__);
1026 spin_lock_irqsave(shost->host_lock, flags);
1027 scsi_report_bus_reset(shost, 0);
1028 spin_unlock_irqrestore(shost->host_lock, flags);
1030 scsi_unblock_requests(shost);
1035 static int uas_suspend(struct usb_interface *intf, pm_message_t message)
1037 struct Scsi_Host *shost = usb_get_intfdata(intf);
1038 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1040 /* Wait for any pending requests to complete */
1041 flush_work(&devinfo->work);
1042 if (usb_wait_anchor_empty_timeout(&devinfo->sense_urbs, 5000) == 0) {
1043 shost_printk(KERN_ERR, shost, "%s: timed out\n", __func__);
1050 static int uas_resume(struct usb_interface *intf)
1055 static int uas_reset_resume(struct usb_interface *intf)
1057 struct Scsi_Host *shost = usb_get_intfdata(intf);
1058 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1059 unsigned long flags;
1061 if (uas_configure_endpoints(devinfo) != 0) {
1062 shost_printk(KERN_ERR, shost,
1063 "%s: alloc streams error after reset", __func__);
1067 spin_lock_irqsave(shost->host_lock, flags);
1068 scsi_report_bus_reset(shost, 0);
1069 spin_unlock_irqrestore(shost->host_lock, flags);
1074 static void uas_disconnect(struct usb_interface *intf)
1076 struct Scsi_Host *shost = usb_get_intfdata(intf);
1077 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1078 unsigned long flags;
1080 spin_lock_irqsave(&devinfo->lock, flags);
1081 devinfo->resetting = 1;
1082 spin_unlock_irqrestore(&devinfo->lock, flags);
1084 cancel_work_sync(&devinfo->work);
1085 uas_abort_inflight(devinfo, DID_NO_CONNECT, __func__);
1086 usb_kill_anchored_urbs(&devinfo->cmd_urbs);
1087 usb_kill_anchored_urbs(&devinfo->sense_urbs);
1088 usb_kill_anchored_urbs(&devinfo->data_urbs);
1089 uas_zap_dead(devinfo);
1090 scsi_remove_host(shost);
1091 uas_free_streams(devinfo);
1092 scsi_host_put(shost);
1096 * Put the device back in usb-storage mode on shutdown, as some BIOS-es
1097 * hang on reboot when the device is still in uas mode. Note the reset is
1098 * necessary as some devices won't revert to usb-storage mode without it.
1100 static void uas_shutdown(struct device *dev)
1102 struct usb_interface *intf = to_usb_interface(dev);
1103 struct usb_device *udev = interface_to_usbdev(intf);
1104 struct Scsi_Host *shost = usb_get_intfdata(intf);
1105 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1107 if (system_state != SYSTEM_RESTART)
1110 devinfo->shutdown = 1;
1111 uas_free_streams(devinfo);
1112 usb_set_interface(udev, intf->altsetting[0].desc.bInterfaceNumber, 0);
1113 usb_reset_device(udev);
1116 static struct usb_driver uas_driver = {
1119 .disconnect = uas_disconnect,
1120 .pre_reset = uas_pre_reset,
1121 .post_reset = uas_post_reset,
1122 .suspend = uas_suspend,
1123 .resume = uas_resume,
1124 .reset_resume = uas_reset_resume,
1125 .drvwrap.driver.shutdown = uas_shutdown,
1126 .id_table = uas_usb_ids,
1129 module_usb_driver(uas_driver);
1131 MODULE_LICENSE("GPL");
1133 "Hans de Goede <hdegoede@redhat.com>, Matthew Wilcox and Sarah Sharp");