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;
64 struct list_head inflight_list;
65 struct list_head dead_list;
69 SUBMIT_STATUS_URB = (1 << 1),
70 ALLOC_DATA_IN_URB = (1 << 2),
71 SUBMIT_DATA_IN_URB = (1 << 3),
72 ALLOC_DATA_OUT_URB = (1 << 4),
73 SUBMIT_DATA_OUT_URB = (1 << 5),
74 ALLOC_CMD_URB = (1 << 6),
75 SUBMIT_CMD_URB = (1 << 7),
76 COMMAND_INFLIGHT = (1 << 8),
77 DATA_IN_URB_INFLIGHT = (1 << 9),
78 DATA_OUT_URB_INFLIGHT = (1 << 10),
79 COMMAND_COMPLETED = (1 << 11),
80 COMMAND_ABORTED = (1 << 12),
81 IS_IN_WORK_LIST = (1 << 13),
84 /* Overrides scsi_pointer */
89 struct urb *data_in_urb;
90 struct urb *data_out_urb;
91 struct list_head list;
94 /* I hate forward declarations, but I actually have a loop */
95 static int uas_submit_urbs(struct scsi_cmnd *cmnd,
96 struct uas_dev_info *devinfo, gfp_t gfp);
97 static void uas_do_work(struct work_struct *work);
98 static int uas_try_complete(struct scsi_cmnd *cmnd, const char *caller);
99 static void uas_free_streams(struct uas_dev_info *devinfo);
100 static void uas_log_cmd_state(struct scsi_cmnd *cmnd, const char *caller);
102 static void uas_do_work(struct work_struct *work)
104 struct uas_dev_info *devinfo =
105 container_of(work, struct uas_dev_info, work);
106 struct uas_cmd_info *cmdinfo;
110 spin_lock_irqsave(&devinfo->lock, flags);
112 if (devinfo->resetting)
115 list_for_each_entry(cmdinfo, &devinfo->inflight_list, list) {
116 struct scsi_pointer *scp = (void *)cmdinfo;
117 struct scsi_cmnd *cmnd = container_of(scp, struct scsi_cmnd,
120 if (!(cmdinfo->state & IS_IN_WORK_LIST))
123 err = uas_submit_urbs(cmnd, cmnd->device->hostdata, GFP_ATOMIC);
125 cmdinfo->state &= ~IS_IN_WORK_LIST;
127 schedule_work(&devinfo->work);
130 spin_unlock_irqrestore(&devinfo->lock, flags);
133 static void uas_mark_cmd_dead(struct uas_dev_info *devinfo,
134 struct uas_cmd_info *cmdinfo,
135 int result, const char *caller)
137 struct scsi_pointer *scp = (void *)cmdinfo;
138 struct scsi_cmnd *cmnd = container_of(scp, struct scsi_cmnd, SCp);
140 uas_log_cmd_state(cmnd, caller);
141 lockdep_assert_held(&devinfo->lock);
142 WARN_ON_ONCE(cmdinfo->state & COMMAND_ABORTED);
143 cmdinfo->state |= COMMAND_ABORTED;
144 cmdinfo->state &= ~IS_IN_WORK_LIST;
145 cmnd->result = result << 16;
146 list_move_tail(&cmdinfo->list, &devinfo->dead_list);
149 static void uas_abort_inflight(struct uas_dev_info *devinfo, int result,
152 struct uas_cmd_info *cmdinfo;
153 struct uas_cmd_info *temp;
156 spin_lock_irqsave(&devinfo->lock, flags);
157 list_for_each_entry_safe(cmdinfo, temp, &devinfo->inflight_list, list)
158 uas_mark_cmd_dead(devinfo, cmdinfo, result, caller);
159 spin_unlock_irqrestore(&devinfo->lock, flags);
162 static void uas_add_work(struct uas_cmd_info *cmdinfo)
164 struct scsi_pointer *scp = (void *)cmdinfo;
165 struct scsi_cmnd *cmnd = container_of(scp, struct scsi_cmnd, SCp);
166 struct uas_dev_info *devinfo = cmnd->device->hostdata;
168 lockdep_assert_held(&devinfo->lock);
169 cmdinfo->state |= IS_IN_WORK_LIST;
170 schedule_work(&devinfo->work);
173 static void uas_zap_dead(struct uas_dev_info *devinfo)
175 struct uas_cmd_info *cmdinfo;
176 struct uas_cmd_info *temp;
179 spin_lock_irqsave(&devinfo->lock, flags);
180 list_for_each_entry_safe(cmdinfo, temp, &devinfo->dead_list, list) {
181 struct scsi_pointer *scp = (void *)cmdinfo;
182 struct scsi_cmnd *cmnd = container_of(scp, struct scsi_cmnd,
184 uas_log_cmd_state(cmnd, __func__);
185 WARN_ON_ONCE(!(cmdinfo->state & COMMAND_ABORTED));
186 /* all urbs are killed, clear inflight bits */
187 cmdinfo->state &= ~(COMMAND_INFLIGHT |
188 DATA_IN_URB_INFLIGHT |
189 DATA_OUT_URB_INFLIGHT);
190 uas_try_complete(cmnd, __func__);
192 spin_unlock_irqrestore(&devinfo->lock, flags);
195 static void uas_sense(struct urb *urb, struct scsi_cmnd *cmnd)
197 struct sense_iu *sense_iu = urb->transfer_buffer;
198 struct scsi_device *sdev = cmnd->device;
200 if (urb->actual_length > 16) {
201 unsigned len = be16_to_cpup(&sense_iu->len);
202 if (len + 16 != urb->actual_length) {
203 int newlen = min(len + 16, urb->actual_length) - 16;
206 sdev_printk(KERN_INFO, sdev, "%s: urb length %d "
207 "disagrees with IU sense data length %d, "
208 "using %d bytes of sense data\n", __func__,
209 urb->actual_length, len, newlen);
212 memcpy(cmnd->sense_buffer, sense_iu->sense, len);
215 cmnd->result = sense_iu->status;
218 static void uas_sense_old(struct urb *urb, struct scsi_cmnd *cmnd)
220 struct sense_iu_old *sense_iu = urb->transfer_buffer;
221 struct scsi_device *sdev = cmnd->device;
223 if (urb->actual_length > 8) {
224 unsigned len = be16_to_cpup(&sense_iu->len) - 2;
225 if (len + 8 != urb->actual_length) {
226 int newlen = min(len + 8, urb->actual_length) - 8;
229 sdev_printk(KERN_INFO, sdev, "%s: urb length %d "
230 "disagrees with IU sense data length %d, "
231 "using %d bytes of sense data\n", __func__,
232 urb->actual_length, len, newlen);
235 memcpy(cmnd->sense_buffer, sense_iu->sense, len);
238 cmnd->result = sense_iu->status;
242 * scsi-tags go from 0 - (nr_tags - 1), uas tags need to match stream-ids,
243 * which go from 1 - nr_streams. And we use 1 for untagged commands.
245 static int uas_get_tag(struct scsi_cmnd *cmnd)
249 if (blk_rq_tagged(cmnd->request))
250 tag = cmnd->request->tag + 2;
257 static void uas_log_cmd_state(struct scsi_cmnd *cmnd, const char *caller)
259 struct uas_cmd_info *ci = (void *)&cmnd->SCp;
261 scmd_printk(KERN_INFO, cmnd,
262 "%s %p tag %d, inflight:%s%s%s%s%s%s%s%s%s%s%s%s%s\n",
263 caller, cmnd, uas_get_tag(cmnd),
264 (ci->state & SUBMIT_STATUS_URB) ? " s-st" : "",
265 (ci->state & ALLOC_DATA_IN_URB) ? " a-in" : "",
266 (ci->state & SUBMIT_DATA_IN_URB) ? " s-in" : "",
267 (ci->state & ALLOC_DATA_OUT_URB) ? " a-out" : "",
268 (ci->state & SUBMIT_DATA_OUT_URB) ? " s-out" : "",
269 (ci->state & ALLOC_CMD_URB) ? " a-cmd" : "",
270 (ci->state & SUBMIT_CMD_URB) ? " s-cmd" : "",
271 (ci->state & COMMAND_INFLIGHT) ? " CMD" : "",
272 (ci->state & DATA_IN_URB_INFLIGHT) ? " IN" : "",
273 (ci->state & DATA_OUT_URB_INFLIGHT) ? " OUT" : "",
274 (ci->state & COMMAND_COMPLETED) ? " done" : "",
275 (ci->state & COMMAND_ABORTED) ? " abort" : "",
276 (ci->state & IS_IN_WORK_LIST) ? " work" : "");
279 static int uas_try_complete(struct scsi_cmnd *cmnd, const char *caller)
281 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
282 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
284 lockdep_assert_held(&devinfo->lock);
285 if (cmdinfo->state & (COMMAND_INFLIGHT |
286 DATA_IN_URB_INFLIGHT |
287 DATA_OUT_URB_INFLIGHT))
289 WARN_ON_ONCE(cmdinfo->state & COMMAND_COMPLETED);
290 cmdinfo->state |= COMMAND_COMPLETED;
291 if (cmdinfo->state & COMMAND_ABORTED)
292 scmd_printk(KERN_INFO, cmnd, "abort completed\n");
293 list_del(&cmdinfo->list);
294 devinfo->cmnd[uas_get_tag(cmnd) - 1] = NULL;
295 cmnd->scsi_done(cmnd);
299 static void uas_xfer_data(struct urb *urb, struct scsi_cmnd *cmnd,
302 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
305 cmdinfo->state |= direction | SUBMIT_STATUS_URB;
306 err = uas_submit_urbs(cmnd, cmnd->device->hostdata, GFP_ATOMIC);
308 uas_add_work(cmdinfo);
312 static void uas_stat_cmplt(struct urb *urb)
314 struct iu *iu = urb->transfer_buffer;
315 struct Scsi_Host *shost = urb->context;
316 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
317 struct urb *data_in_urb = NULL;
318 struct urb *data_out_urb = NULL;
319 struct scsi_cmnd *cmnd;
320 struct uas_cmd_info *cmdinfo;
324 spin_lock_irqsave(&devinfo->lock, flags);
326 if (devinfo->resetting)
330 if (urb->status == -ENOENT) {
331 dev_err(&urb->dev->dev, "stat urb: killed, stream %d\n",
334 dev_err(&urb->dev->dev, "stat urb: status %d\n",
340 idx = be16_to_cpup(&iu->tag) - 1;
341 if (idx >= MAX_CMNDS || !devinfo->cmnd[idx]) {
342 dev_err(&urb->dev->dev,
343 "stat urb: no pending cmd for tag %d\n", idx + 1);
347 cmnd = devinfo->cmnd[idx];
348 cmdinfo = (void *)&cmnd->SCp;
350 if (!(cmdinfo->state & COMMAND_INFLIGHT)) {
351 scmd_printk(KERN_ERR, cmnd, "unexpected status cmplt\n");
357 if (urb->actual_length < 16)
358 devinfo->uas_sense_old = 1;
359 if (devinfo->uas_sense_old)
360 uas_sense_old(urb, cmnd);
362 uas_sense(urb, cmnd);
363 if (cmnd->result != 0) {
364 /* cancel data transfers on error */
365 data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
366 data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
368 cmdinfo->state &= ~COMMAND_INFLIGHT;
369 uas_try_complete(cmnd, __func__);
371 case IU_ID_READ_READY:
372 if (!cmdinfo->data_in_urb ||
373 (cmdinfo->state & DATA_IN_URB_INFLIGHT)) {
374 scmd_printk(KERN_ERR, cmnd, "unexpected read rdy\n");
377 uas_xfer_data(urb, cmnd, SUBMIT_DATA_IN_URB);
379 case IU_ID_WRITE_READY:
380 if (!cmdinfo->data_out_urb ||
381 (cmdinfo->state & DATA_OUT_URB_INFLIGHT)) {
382 scmd_printk(KERN_ERR, cmnd, "unexpected write rdy\n");
385 uas_xfer_data(urb, cmnd, SUBMIT_DATA_OUT_URB);
388 scmd_printk(KERN_ERR, cmnd,
389 "Bogus IU (%d) received on status pipe\n", iu->iu_id);
393 spin_unlock_irqrestore(&devinfo->lock, flags);
395 /* Unlinking of data urbs must be done without holding the lock */
397 usb_unlink_urb(data_in_urb);
398 usb_put_urb(data_in_urb);
401 usb_unlink_urb(data_out_urb);
402 usb_put_urb(data_out_urb);
406 static void uas_data_cmplt(struct urb *urb)
408 struct scsi_cmnd *cmnd = urb->context;
409 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
410 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
411 struct scsi_data_buffer *sdb = NULL;
414 spin_lock_irqsave(&devinfo->lock, flags);
416 if (cmdinfo->data_in_urb == urb) {
418 cmdinfo->state &= ~DATA_IN_URB_INFLIGHT;
419 cmdinfo->data_in_urb = NULL;
420 } else if (cmdinfo->data_out_urb == urb) {
421 sdb = scsi_out(cmnd);
422 cmdinfo->state &= ~DATA_OUT_URB_INFLIGHT;
423 cmdinfo->data_out_urb = NULL;
430 if (devinfo->resetting)
433 /* Data urbs should not complete before the cmd urb is submitted */
434 if (cmdinfo->state & SUBMIT_CMD_URB) {
435 scmd_printk(KERN_ERR, cmnd, "unexpected data cmplt\n");
440 if (urb->status != -ECONNRESET) {
441 uas_log_cmd_state(cmnd, __func__);
442 scmd_printk(KERN_ERR, cmnd,
443 "data cmplt err %d stream %d\n",
444 urb->status, urb->stream_id);
446 /* error: no data transfered */
447 sdb->resid = sdb->length;
449 sdb->resid = sdb->length - urb->actual_length;
451 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;
680 BUILD_BUG_ON(sizeof(struct uas_cmd_info) > sizeof(struct scsi_pointer));
682 if ((devinfo->flags & US_FL_NO_ATA_1X) &&
683 (cmnd->cmnd[0] == ATA_12 || cmnd->cmnd[0] == ATA_16)) {
684 memcpy(cmnd->sense_buffer, usb_stor_sense_invalidCDB,
685 sizeof(usb_stor_sense_invalidCDB));
686 cmnd->result = SAM_STAT_CHECK_CONDITION;
687 cmnd->scsi_done(cmnd);
691 spin_lock_irqsave(&devinfo->lock, flags);
693 if (devinfo->resetting) {
694 cmnd->result = DID_ERROR << 16;
695 cmnd->scsi_done(cmnd);
696 spin_unlock_irqrestore(&devinfo->lock, flags);
700 stream = uas_get_tag(cmnd);
701 if (devinfo->cmnd[stream - 1]) {
702 spin_unlock_irqrestore(&devinfo->lock, flags);
703 return SCSI_MLQUEUE_DEVICE_BUSY;
706 cmnd->scsi_done = done;
708 memset(cmdinfo, 0, sizeof(*cmdinfo));
709 cmdinfo->stream = stream;
710 cmdinfo->state = SUBMIT_STATUS_URB | ALLOC_CMD_URB | SUBMIT_CMD_URB;
712 switch (cmnd->sc_data_direction) {
713 case DMA_FROM_DEVICE:
714 cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
716 case DMA_BIDIRECTIONAL:
717 cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
719 cmdinfo->state |= ALLOC_DATA_OUT_URB | SUBMIT_DATA_OUT_URB;
724 if (!devinfo->use_streams) {
725 cmdinfo->state &= ~(SUBMIT_DATA_IN_URB | SUBMIT_DATA_OUT_URB);
729 err = uas_submit_urbs(cmnd, devinfo, GFP_ATOMIC);
731 /* If we did nothing, give up now */
732 if (cmdinfo->state & SUBMIT_STATUS_URB) {
733 spin_unlock_irqrestore(&devinfo->lock, flags);
734 return SCSI_MLQUEUE_DEVICE_BUSY;
736 uas_add_work(cmdinfo);
739 devinfo->cmnd[stream - 1] = cmnd;
740 list_add_tail(&cmdinfo->list, &devinfo->inflight_list);
741 spin_unlock_irqrestore(&devinfo->lock, flags);
745 static DEF_SCSI_QCMD(uas_queuecommand)
747 static int uas_eh_bus_reset_handler(struct scsi_cmnd *cmnd)
749 struct scsi_device *sdev = cmnd->device;
750 struct uas_dev_info *devinfo = sdev->hostdata;
751 struct usb_device *udev = devinfo->udev;
755 err = usb_lock_device_for_reset(udev, devinfo->intf);
757 shost_printk(KERN_ERR, sdev->host,
758 "%s FAILED to get lock err %d\n", __func__, err);
762 shost_printk(KERN_INFO, sdev->host, "%s start\n", __func__);
764 spin_lock_irqsave(&devinfo->lock, flags);
765 devinfo->resetting = 1;
766 spin_unlock_irqrestore(&devinfo->lock, flags);
768 uas_abort_inflight(devinfo, DID_RESET, __func__);
769 usb_kill_anchored_urbs(&devinfo->cmd_urbs);
770 usb_kill_anchored_urbs(&devinfo->sense_urbs);
771 usb_kill_anchored_urbs(&devinfo->data_urbs);
772 uas_zap_dead(devinfo);
773 err = usb_reset_device(udev);
775 spin_lock_irqsave(&devinfo->lock, flags);
776 devinfo->resetting = 0;
777 spin_unlock_irqrestore(&devinfo->lock, flags);
779 usb_unlock_device(udev);
782 shost_printk(KERN_INFO, sdev->host, "%s FAILED\n", __func__);
786 shost_printk(KERN_INFO, sdev->host, "%s success\n", __func__);
790 static int uas_slave_alloc(struct scsi_device *sdev)
792 sdev->hostdata = (void *)sdev->host->hostdata;
794 /* USB has unusual DMA-alignment requirements: Although the
795 * starting address of each scatter-gather element doesn't matter,
796 * the length of each element except the last must be divisible
797 * by the Bulk maxpacket value. There's currently no way to
798 * express this by block-layer constraints, so we'll cop out
799 * and simply require addresses to be aligned at 512-byte
800 * boundaries. This is okay since most block I/O involves
801 * hardware sectors that are multiples of 512 bytes in length,
802 * and since host controllers up through USB 2.0 have maxpacket
803 * values no larger than 512.
805 * But it doesn't suffice for Wireless USB, where Bulk maxpacket
806 * values can be as large as 2048. To make that work properly
807 * will require changes to the block layer.
809 blk_queue_update_dma_alignment(sdev->request_queue, (512 - 1));
814 static int uas_slave_configure(struct scsi_device *sdev)
816 struct uas_dev_info *devinfo = sdev->hostdata;
818 if (devinfo->flags & US_FL_NO_REPORT_OPCODES)
819 sdev->no_report_opcodes = 1;
821 scsi_set_tag_type(sdev, MSG_ORDERED_TAG);
822 scsi_activate_tcq(sdev, devinfo->qdepth - 2);
826 static struct scsi_host_template uas_host_template = {
827 .module = THIS_MODULE,
829 .queuecommand = uas_queuecommand,
830 .slave_alloc = uas_slave_alloc,
831 .slave_configure = uas_slave_configure,
832 .eh_bus_reset_handler = uas_eh_bus_reset_handler,
833 .can_queue = 65536, /* Is there a limit on the _host_ ? */
835 .sg_tablesize = SG_NONE,
836 .cmd_per_lun = 1, /* until we override it */
837 .skip_settle_delay = 1,
841 #define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \
842 vendorName, productName, useProtocol, useTransport, \
843 initFunction, flags) \
844 { USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax), \
845 .driver_info = (flags) }
847 static struct usb_device_id uas_usb_ids[] = {
848 # include "unusual_uas.h"
849 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_BULK) },
850 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_UAS) },
851 /* 0xaa is a prototype device I happen to have access to */
852 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, 0xaa) },
855 MODULE_DEVICE_TABLE(usb, uas_usb_ids);
859 static int uas_switch_interface(struct usb_device *udev,
860 struct usb_interface *intf)
864 alt = uas_find_uas_alt_setting(intf);
868 return usb_set_interface(udev,
869 intf->altsetting[0].desc.bInterfaceNumber, alt);
872 static int uas_configure_endpoints(struct uas_dev_info *devinfo)
874 struct usb_host_endpoint *eps[4] = { };
875 struct usb_device *udev = devinfo->udev;
878 devinfo->uas_sense_old = 0;
880 r = uas_find_endpoints(devinfo->intf->cur_altsetting, eps);
884 devinfo->cmd_pipe = usb_sndbulkpipe(udev,
885 usb_endpoint_num(&eps[0]->desc));
886 devinfo->status_pipe = usb_rcvbulkpipe(udev,
887 usb_endpoint_num(&eps[1]->desc));
888 devinfo->data_in_pipe = usb_rcvbulkpipe(udev,
889 usb_endpoint_num(&eps[2]->desc));
890 devinfo->data_out_pipe = usb_sndbulkpipe(udev,
891 usb_endpoint_num(&eps[3]->desc));
893 if (udev->speed != USB_SPEED_SUPER) {
894 devinfo->qdepth = 32;
895 devinfo->use_streams = 0;
897 devinfo->qdepth = usb_alloc_streams(devinfo->intf, eps + 1,
898 3, MAX_CMNDS, GFP_NOIO);
899 if (devinfo->qdepth < 0)
900 return devinfo->qdepth;
901 devinfo->use_streams = 1;
907 static void uas_free_streams(struct uas_dev_info *devinfo)
909 struct usb_device *udev = devinfo->udev;
910 struct usb_host_endpoint *eps[3];
912 eps[0] = usb_pipe_endpoint(udev, devinfo->status_pipe);
913 eps[1] = usb_pipe_endpoint(udev, devinfo->data_in_pipe);
914 eps[2] = usb_pipe_endpoint(udev, devinfo->data_out_pipe);
915 usb_free_streams(devinfo->intf, eps, 3, GFP_NOIO);
918 static int uas_probe(struct usb_interface *intf, const struct usb_device_id *id)
920 int result = -ENOMEM;
921 struct Scsi_Host *shost = NULL;
922 struct uas_dev_info *devinfo;
923 struct usb_device *udev = interface_to_usbdev(intf);
925 if (!uas_use_uas_driver(intf, id))
928 if (uas_switch_interface(udev, intf))
931 shost = scsi_host_alloc(&uas_host_template,
932 sizeof(struct uas_dev_info));
936 shost->max_cmd_len = 16 + 252;
938 shost->max_lun = 256;
939 shost->max_channel = 0;
940 shost->sg_tablesize = udev->bus->sg_tablesize;
942 devinfo = (struct uas_dev_info *)shost->hostdata;
943 devinfo->intf = intf;
944 devinfo->udev = udev;
945 devinfo->resetting = 0;
946 devinfo->shutdown = 0;
947 devinfo->flags = id->driver_info;
948 usb_stor_adjust_quirks(udev, &devinfo->flags);
949 init_usb_anchor(&devinfo->cmd_urbs);
950 init_usb_anchor(&devinfo->sense_urbs);
951 init_usb_anchor(&devinfo->data_urbs);
952 spin_lock_init(&devinfo->lock);
953 INIT_WORK(&devinfo->work, uas_do_work);
954 INIT_LIST_HEAD(&devinfo->inflight_list);
955 INIT_LIST_HEAD(&devinfo->dead_list);
957 result = uas_configure_endpoints(devinfo);
961 result = scsi_init_shared_tag_map(shost, devinfo->qdepth - 2);
965 usb_set_intfdata(intf, shost);
966 result = scsi_add_host(shost, &intf->dev);
970 scsi_scan_host(shost);
974 uas_free_streams(devinfo);
975 usb_set_intfdata(intf, NULL);
977 usb_set_interface(udev, intf->altsetting[0].desc.bInterfaceNumber, 0);
979 scsi_host_put(shost);
983 static int uas_pre_reset(struct usb_interface *intf)
985 struct Scsi_Host *shost = usb_get_intfdata(intf);
986 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
989 if (devinfo->shutdown)
992 /* Block new requests */
993 spin_lock_irqsave(shost->host_lock, flags);
994 scsi_block_requests(shost);
995 spin_unlock_irqrestore(shost->host_lock, flags);
997 /* Wait for any pending requests to complete */
998 flush_work(&devinfo->work);
999 if (usb_wait_anchor_empty_timeout(&devinfo->sense_urbs, 5000) == 0) {
1000 shost_printk(KERN_ERR, shost, "%s: timed out\n", __func__);
1004 uas_free_streams(devinfo);
1009 static int uas_post_reset(struct usb_interface *intf)
1011 struct Scsi_Host *shost = usb_get_intfdata(intf);
1012 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1013 unsigned long flags;
1015 if (devinfo->shutdown)
1018 if (uas_configure_endpoints(devinfo) != 0) {
1019 shost_printk(KERN_ERR, shost,
1020 "%s: alloc streams error after reset", __func__);
1024 spin_lock_irqsave(shost->host_lock, flags);
1025 scsi_report_bus_reset(shost, 0);
1026 spin_unlock_irqrestore(shost->host_lock, flags);
1028 scsi_unblock_requests(shost);
1033 static int uas_suspend(struct usb_interface *intf, pm_message_t message)
1035 struct Scsi_Host *shost = usb_get_intfdata(intf);
1036 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1038 /* Wait for any pending requests to complete */
1039 flush_work(&devinfo->work);
1040 if (usb_wait_anchor_empty_timeout(&devinfo->sense_urbs, 5000) == 0) {
1041 shost_printk(KERN_ERR, shost, "%s: timed out\n", __func__);
1048 static int uas_resume(struct usb_interface *intf)
1053 static int uas_reset_resume(struct usb_interface *intf)
1055 struct Scsi_Host *shost = usb_get_intfdata(intf);
1056 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1057 unsigned long flags;
1059 if (uas_configure_endpoints(devinfo) != 0) {
1060 shost_printk(KERN_ERR, shost,
1061 "%s: alloc streams error after reset", __func__);
1065 spin_lock_irqsave(shost->host_lock, flags);
1066 scsi_report_bus_reset(shost, 0);
1067 spin_unlock_irqrestore(shost->host_lock, flags);
1072 static void uas_disconnect(struct usb_interface *intf)
1074 struct Scsi_Host *shost = usb_get_intfdata(intf);
1075 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1076 unsigned long flags;
1078 spin_lock_irqsave(&devinfo->lock, flags);
1079 devinfo->resetting = 1;
1080 spin_unlock_irqrestore(&devinfo->lock, flags);
1082 cancel_work_sync(&devinfo->work);
1083 uas_abort_inflight(devinfo, DID_NO_CONNECT, __func__);
1084 usb_kill_anchored_urbs(&devinfo->cmd_urbs);
1085 usb_kill_anchored_urbs(&devinfo->sense_urbs);
1086 usb_kill_anchored_urbs(&devinfo->data_urbs);
1087 uas_zap_dead(devinfo);
1088 scsi_remove_host(shost);
1089 uas_free_streams(devinfo);
1090 scsi_host_put(shost);
1094 * Put the device back in usb-storage mode on shutdown, as some BIOS-es
1095 * hang on reboot when the device is still in uas mode. Note the reset is
1096 * necessary as some devices won't revert to usb-storage mode without it.
1098 static void uas_shutdown(struct device *dev)
1100 struct usb_interface *intf = to_usb_interface(dev);
1101 struct usb_device *udev = interface_to_usbdev(intf);
1102 struct Scsi_Host *shost = usb_get_intfdata(intf);
1103 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1105 if (system_state != SYSTEM_RESTART)
1108 devinfo->shutdown = 1;
1109 uas_free_streams(devinfo);
1110 usb_set_interface(udev, intf->altsetting[0].desc.bInterfaceNumber, 0);
1111 usb_reset_device(udev);
1114 static struct usb_driver uas_driver = {
1117 .disconnect = uas_disconnect,
1118 .pre_reset = uas_pre_reset,
1119 .post_reset = uas_post_reset,
1120 .suspend = uas_suspend,
1121 .resume = uas_resume,
1122 .reset_resume = uas_reset_resume,
1123 .drvwrap.driver.shutdown = uas_shutdown,
1124 .id_table = uas_usb_ids,
1127 module_usb_driver(uas_driver);
1129 MODULE_LICENSE("GPL");
1131 "Hans de Goede <hdegoede@redhat.com>, Matthew Wilcox and Sarah Sharp");