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_COMPLETED = (1 << 11),
78 COMMAND_ABORTED = (1 << 12),
79 IS_IN_WORK_LIST = (1 << 13),
82 /* Overrides scsi_pointer */
87 struct urb *data_in_urb;
88 struct urb *data_out_urb;
91 /* I hate forward declarations, but I actually have a loop */
92 static int uas_submit_urbs(struct scsi_cmnd *cmnd,
93 struct uas_dev_info *devinfo, gfp_t gfp);
94 static void uas_do_work(struct work_struct *work);
95 static int uas_try_complete(struct scsi_cmnd *cmnd, const char *caller);
96 static void uas_free_streams(struct uas_dev_info *devinfo);
97 static void uas_log_cmd_state(struct scsi_cmnd *cmnd, const char *caller);
99 static void uas_do_work(struct work_struct *work)
101 struct uas_dev_info *devinfo =
102 container_of(work, struct uas_dev_info, work);
103 struct uas_cmd_info *cmdinfo;
104 struct scsi_cmnd *cmnd;
108 spin_lock_irqsave(&devinfo->lock, flags);
110 if (devinfo->resetting)
113 for (i = 0; i < devinfo->qdepth; i++) {
114 if (!devinfo->cmnd[i])
117 cmnd = devinfo->cmnd[i];
118 cmdinfo = (void *)&cmnd->SCp;
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_add_work(struct uas_cmd_info *cmdinfo)
135 struct scsi_pointer *scp = (void *)cmdinfo;
136 struct scsi_cmnd *cmnd = container_of(scp, struct scsi_cmnd, SCp);
137 struct uas_dev_info *devinfo = cmnd->device->hostdata;
139 lockdep_assert_held(&devinfo->lock);
140 cmdinfo->state |= IS_IN_WORK_LIST;
141 schedule_work(&devinfo->work);
144 static void uas_zap_pending(struct uas_dev_info *devinfo, int result)
146 struct uas_cmd_info *cmdinfo;
147 struct scsi_cmnd *cmnd;
151 spin_lock_irqsave(&devinfo->lock, flags);
152 for (i = 0; i < devinfo->qdepth; i++) {
153 if (!devinfo->cmnd[i])
156 cmnd = devinfo->cmnd[i];
157 cmdinfo = (void *)&cmnd->SCp;
158 uas_log_cmd_state(cmnd, __func__);
159 /* Sense urbs were killed, clear COMMAND_INFLIGHT manually */
160 cmdinfo->state &= ~COMMAND_INFLIGHT;
161 cmnd->result = result << 16;
162 err = uas_try_complete(cmnd, __func__);
165 spin_unlock_irqrestore(&devinfo->lock, flags);
168 static void uas_sense(struct urb *urb, struct scsi_cmnd *cmnd)
170 struct sense_iu *sense_iu = urb->transfer_buffer;
171 struct scsi_device *sdev = cmnd->device;
173 if (urb->actual_length > 16) {
174 unsigned len = be16_to_cpup(&sense_iu->len);
175 if (len + 16 != urb->actual_length) {
176 int newlen = min(len + 16, urb->actual_length) - 16;
179 sdev_printk(KERN_INFO, sdev, "%s: urb length %d "
180 "disagrees with IU sense data length %d, "
181 "using %d bytes of sense data\n", __func__,
182 urb->actual_length, len, newlen);
185 memcpy(cmnd->sense_buffer, sense_iu->sense, len);
188 cmnd->result = sense_iu->status;
191 static void uas_sense_old(struct urb *urb, struct scsi_cmnd *cmnd)
193 struct sense_iu_old *sense_iu = urb->transfer_buffer;
194 struct scsi_device *sdev = cmnd->device;
196 if (urb->actual_length > 8) {
197 unsigned len = be16_to_cpup(&sense_iu->len) - 2;
198 if (len + 8 != urb->actual_length) {
199 int newlen = min(len + 8, urb->actual_length) - 8;
202 sdev_printk(KERN_INFO, sdev, "%s: urb length %d "
203 "disagrees with IU sense data length %d, "
204 "using %d bytes of sense data\n", __func__,
205 urb->actual_length, len, newlen);
208 memcpy(cmnd->sense_buffer, sense_iu->sense, len);
211 cmnd->result = sense_iu->status;
215 * scsi-tags go from 0 - (nr_tags - 1), uas tags need to match stream-ids,
216 * which go from 1 - nr_streams. And we use 1 for untagged commands.
218 static int uas_get_tag(struct scsi_cmnd *cmnd)
222 if (blk_rq_tagged(cmnd->request))
223 tag = cmnd->request->tag + 2;
230 static void uas_log_cmd_state(struct scsi_cmnd *cmnd, const char *caller)
232 struct uas_cmd_info *ci = (void *)&cmnd->SCp;
234 scmd_printk(KERN_INFO, cmnd,
235 "%s %p tag %d, inflight:%s%s%s%s%s%s%s%s%s%s%s%s%s\n",
236 caller, cmnd, uas_get_tag(cmnd),
237 (ci->state & SUBMIT_STATUS_URB) ? " s-st" : "",
238 (ci->state & ALLOC_DATA_IN_URB) ? " a-in" : "",
239 (ci->state & SUBMIT_DATA_IN_URB) ? " s-in" : "",
240 (ci->state & ALLOC_DATA_OUT_URB) ? " a-out" : "",
241 (ci->state & SUBMIT_DATA_OUT_URB) ? " s-out" : "",
242 (ci->state & ALLOC_CMD_URB) ? " a-cmd" : "",
243 (ci->state & SUBMIT_CMD_URB) ? " s-cmd" : "",
244 (ci->state & COMMAND_INFLIGHT) ? " CMD" : "",
245 (ci->state & DATA_IN_URB_INFLIGHT) ? " IN" : "",
246 (ci->state & DATA_OUT_URB_INFLIGHT) ? " OUT" : "",
247 (ci->state & COMMAND_COMPLETED) ? " done" : "",
248 (ci->state & COMMAND_ABORTED) ? " abort" : "",
249 (ci->state & IS_IN_WORK_LIST) ? " work" : "");
252 static int uas_try_complete(struct scsi_cmnd *cmnd, const char *caller)
254 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
255 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
257 lockdep_assert_held(&devinfo->lock);
258 if (cmdinfo->state & (COMMAND_INFLIGHT |
259 DATA_IN_URB_INFLIGHT |
260 DATA_OUT_URB_INFLIGHT))
262 WARN_ON_ONCE(cmdinfo->state & COMMAND_COMPLETED);
263 cmdinfo->state |= COMMAND_COMPLETED;
264 if (cmdinfo->state & COMMAND_ABORTED)
265 scmd_printk(KERN_INFO, cmnd, "abort completed\n");
266 devinfo->cmnd[uas_get_tag(cmnd) - 1] = NULL;
267 cmnd->scsi_done(cmnd);
271 static void uas_xfer_data(struct urb *urb, struct scsi_cmnd *cmnd,
274 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
277 cmdinfo->state |= direction | SUBMIT_STATUS_URB;
278 err = uas_submit_urbs(cmnd, cmnd->device->hostdata, GFP_ATOMIC);
280 uas_add_work(cmdinfo);
284 static void uas_stat_cmplt(struct urb *urb)
286 struct iu *iu = urb->transfer_buffer;
287 struct Scsi_Host *shost = urb->context;
288 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
289 struct urb *data_in_urb = NULL;
290 struct urb *data_out_urb = NULL;
291 struct scsi_cmnd *cmnd;
292 struct uas_cmd_info *cmdinfo;
296 spin_lock_irqsave(&devinfo->lock, flags);
298 if (devinfo->resetting)
302 if (urb->status == -ENOENT) {
303 dev_err(&urb->dev->dev, "stat urb: killed, stream %d\n",
306 dev_err(&urb->dev->dev, "stat urb: status %d\n",
312 idx = be16_to_cpup(&iu->tag) - 1;
313 if (idx >= MAX_CMNDS || !devinfo->cmnd[idx]) {
314 dev_err(&urb->dev->dev,
315 "stat urb: no pending cmd for tag %d\n", idx + 1);
319 cmnd = devinfo->cmnd[idx];
320 cmdinfo = (void *)&cmnd->SCp;
322 if (!(cmdinfo->state & COMMAND_INFLIGHT)) {
323 scmd_printk(KERN_ERR, cmnd, "unexpected status cmplt\n");
329 if (urb->actual_length < 16)
330 devinfo->uas_sense_old = 1;
331 if (devinfo->uas_sense_old)
332 uas_sense_old(urb, cmnd);
334 uas_sense(urb, cmnd);
335 if (cmnd->result != 0) {
336 /* cancel data transfers on error */
337 data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
338 data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
340 cmdinfo->state &= ~COMMAND_INFLIGHT;
341 uas_try_complete(cmnd, __func__);
343 case IU_ID_READ_READY:
344 if (!cmdinfo->data_in_urb ||
345 (cmdinfo->state & DATA_IN_URB_INFLIGHT)) {
346 scmd_printk(KERN_ERR, cmnd, "unexpected read rdy\n");
349 uas_xfer_data(urb, cmnd, SUBMIT_DATA_IN_URB);
351 case IU_ID_WRITE_READY:
352 if (!cmdinfo->data_out_urb ||
353 (cmdinfo->state & DATA_OUT_URB_INFLIGHT)) {
354 scmd_printk(KERN_ERR, cmnd, "unexpected write rdy\n");
357 uas_xfer_data(urb, cmnd, SUBMIT_DATA_OUT_URB);
360 scmd_printk(KERN_ERR, cmnd,
361 "Bogus IU (%d) received on status pipe\n", iu->iu_id);
365 spin_unlock_irqrestore(&devinfo->lock, flags);
367 /* Unlinking of data urbs must be done without holding the lock */
369 usb_unlink_urb(data_in_urb);
370 usb_put_urb(data_in_urb);
373 usb_unlink_urb(data_out_urb);
374 usb_put_urb(data_out_urb);
378 static void uas_data_cmplt(struct urb *urb)
380 struct scsi_cmnd *cmnd = urb->context;
381 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
382 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
383 struct scsi_data_buffer *sdb = NULL;
386 spin_lock_irqsave(&devinfo->lock, flags);
388 if (cmdinfo->data_in_urb == urb) {
390 cmdinfo->state &= ~DATA_IN_URB_INFLIGHT;
391 cmdinfo->data_in_urb = NULL;
392 } else if (cmdinfo->data_out_urb == urb) {
393 sdb = scsi_out(cmnd);
394 cmdinfo->state &= ~DATA_OUT_URB_INFLIGHT;
395 cmdinfo->data_out_urb = NULL;
402 if (devinfo->resetting)
405 /* Data urbs should not complete before the cmd urb is submitted */
406 if (cmdinfo->state & SUBMIT_CMD_URB) {
407 scmd_printk(KERN_ERR, cmnd, "unexpected data cmplt\n");
412 if (urb->status != -ECONNRESET) {
413 uas_log_cmd_state(cmnd, __func__);
414 scmd_printk(KERN_ERR, cmnd,
415 "data cmplt err %d stream %d\n",
416 urb->status, urb->stream_id);
418 /* error: no data transfered */
419 sdb->resid = sdb->length;
421 sdb->resid = sdb->length - urb->actual_length;
423 uas_try_complete(cmnd, __func__);
426 spin_unlock_irqrestore(&devinfo->lock, flags);
429 static void uas_cmd_cmplt(struct urb *urb)
431 struct scsi_cmnd *cmnd = urb->context;
434 uas_log_cmd_state(cmnd, __func__);
435 scmd_printk(KERN_ERR, cmnd, "cmd cmplt err %d\n", urb->status);
440 static struct urb *uas_alloc_data_urb(struct uas_dev_info *devinfo, gfp_t gfp,
441 unsigned int pipe, u16 stream_id,
442 struct scsi_cmnd *cmnd,
443 enum dma_data_direction dir)
445 struct usb_device *udev = devinfo->udev;
446 struct urb *urb = usb_alloc_urb(0, gfp);
447 struct scsi_data_buffer *sdb = (dir == DMA_FROM_DEVICE)
448 ? scsi_in(cmnd) : scsi_out(cmnd);
452 usb_fill_bulk_urb(urb, udev, pipe, NULL, sdb->length,
453 uas_data_cmplt, cmnd);
454 urb->stream_id = stream_id;
455 urb->num_sgs = udev->bus->sg_tablesize ? sdb->table.nents : 0;
456 urb->sg = sdb->table.sgl;
461 static struct urb *uas_alloc_sense_urb(struct uas_dev_info *devinfo, gfp_t gfp,
462 struct Scsi_Host *shost, u16 stream_id)
464 struct usb_device *udev = devinfo->udev;
465 struct urb *urb = usb_alloc_urb(0, gfp);
471 iu = kzalloc(sizeof(*iu), gfp);
475 usb_fill_bulk_urb(urb, udev, devinfo->status_pipe, iu, sizeof(*iu),
476 uas_stat_cmplt, shost);
477 urb->stream_id = stream_id;
478 urb->transfer_flags |= URB_FREE_BUFFER;
486 static struct urb *uas_alloc_cmd_urb(struct uas_dev_info *devinfo, gfp_t gfp,
487 struct scsi_cmnd *cmnd)
489 struct usb_device *udev = devinfo->udev;
490 struct scsi_device *sdev = cmnd->device;
491 struct urb *urb = usb_alloc_urb(0, gfp);
492 struct command_iu *iu;
498 len = cmnd->cmd_len - 16;
502 iu = kzalloc(sizeof(*iu) + len, gfp);
506 iu->iu_id = IU_ID_COMMAND;
507 iu->tag = cpu_to_be16(uas_get_tag(cmnd));
508 iu->prio_attr = UAS_SIMPLE_TAG;
510 int_to_scsilun(sdev->lun, &iu->lun);
511 memcpy(iu->cdb, cmnd->cmnd, cmnd->cmd_len);
513 usb_fill_bulk_urb(urb, udev, devinfo->cmd_pipe, iu, sizeof(*iu) + len,
514 uas_cmd_cmplt, cmnd);
515 urb->transfer_flags |= URB_FREE_BUFFER;
524 * Why should I request the Status IU before sending the Command IU? Spec
525 * says to, but also says the device may receive them in any order. Seems
529 static struct urb *uas_submit_sense_urb(struct scsi_cmnd *cmnd,
530 gfp_t gfp, unsigned int stream)
532 struct Scsi_Host *shost = cmnd->device->host;
533 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
537 urb = uas_alloc_sense_urb(devinfo, gfp, shost, stream);
540 usb_anchor_urb(urb, &devinfo->sense_urbs);
541 err = usb_submit_urb(urb, gfp);
543 usb_unanchor_urb(urb);
544 uas_log_cmd_state(cmnd, __func__);
545 shost_printk(KERN_INFO, shost,
546 "sense urb submission error %d stream %d\n",
554 static int uas_submit_urbs(struct scsi_cmnd *cmnd,
555 struct uas_dev_info *devinfo, gfp_t gfp)
557 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
561 lockdep_assert_held(&devinfo->lock);
562 if (cmdinfo->state & SUBMIT_STATUS_URB) {
563 urb = uas_submit_sense_urb(cmnd, gfp, cmdinfo->stream);
565 return SCSI_MLQUEUE_DEVICE_BUSY;
566 cmdinfo->state &= ~SUBMIT_STATUS_URB;
569 if (cmdinfo->state & ALLOC_DATA_IN_URB) {
570 cmdinfo->data_in_urb = uas_alloc_data_urb(devinfo, gfp,
571 devinfo->data_in_pipe, cmdinfo->stream,
572 cmnd, DMA_FROM_DEVICE);
573 if (!cmdinfo->data_in_urb)
574 return SCSI_MLQUEUE_DEVICE_BUSY;
575 cmdinfo->state &= ~ALLOC_DATA_IN_URB;
578 if (cmdinfo->state & SUBMIT_DATA_IN_URB) {
579 usb_anchor_urb(cmdinfo->data_in_urb, &devinfo->data_urbs);
580 err = usb_submit_urb(cmdinfo->data_in_urb, gfp);
582 usb_unanchor_urb(cmdinfo->data_in_urb);
583 uas_log_cmd_state(cmnd, __func__);
584 scmd_printk(KERN_INFO, cmnd,
585 "data in urb submission error %d stream %d\n",
586 err, cmdinfo->data_in_urb->stream_id);
587 return SCSI_MLQUEUE_DEVICE_BUSY;
589 cmdinfo->state &= ~SUBMIT_DATA_IN_URB;
590 cmdinfo->state |= DATA_IN_URB_INFLIGHT;
593 if (cmdinfo->state & ALLOC_DATA_OUT_URB) {
594 cmdinfo->data_out_urb = uas_alloc_data_urb(devinfo, gfp,
595 devinfo->data_out_pipe, cmdinfo->stream,
596 cmnd, DMA_TO_DEVICE);
597 if (!cmdinfo->data_out_urb)
598 return SCSI_MLQUEUE_DEVICE_BUSY;
599 cmdinfo->state &= ~ALLOC_DATA_OUT_URB;
602 if (cmdinfo->state & SUBMIT_DATA_OUT_URB) {
603 usb_anchor_urb(cmdinfo->data_out_urb, &devinfo->data_urbs);
604 err = usb_submit_urb(cmdinfo->data_out_urb, gfp);
606 usb_unanchor_urb(cmdinfo->data_out_urb);
607 uas_log_cmd_state(cmnd, __func__);
608 scmd_printk(KERN_INFO, cmnd,
609 "data out urb submission error %d stream %d\n",
610 err, cmdinfo->data_out_urb->stream_id);
611 return SCSI_MLQUEUE_DEVICE_BUSY;
613 cmdinfo->state &= ~SUBMIT_DATA_OUT_URB;
614 cmdinfo->state |= DATA_OUT_URB_INFLIGHT;
617 if (cmdinfo->state & ALLOC_CMD_URB) {
618 cmdinfo->cmd_urb = uas_alloc_cmd_urb(devinfo, gfp, cmnd);
619 if (!cmdinfo->cmd_urb)
620 return SCSI_MLQUEUE_DEVICE_BUSY;
621 cmdinfo->state &= ~ALLOC_CMD_URB;
624 if (cmdinfo->state & SUBMIT_CMD_URB) {
625 usb_anchor_urb(cmdinfo->cmd_urb, &devinfo->cmd_urbs);
626 err = usb_submit_urb(cmdinfo->cmd_urb, gfp);
628 usb_unanchor_urb(cmdinfo->cmd_urb);
629 uas_log_cmd_state(cmnd, __func__);
630 scmd_printk(KERN_INFO, cmnd,
631 "cmd urb submission error %d\n", err);
632 return SCSI_MLQUEUE_DEVICE_BUSY;
634 cmdinfo->cmd_urb = NULL;
635 cmdinfo->state &= ~SUBMIT_CMD_URB;
636 cmdinfo->state |= COMMAND_INFLIGHT;
642 static int uas_queuecommand_lck(struct scsi_cmnd *cmnd,
643 void (*done)(struct scsi_cmnd *))
645 struct scsi_device *sdev = cmnd->device;
646 struct uas_dev_info *devinfo = sdev->hostdata;
647 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
652 BUILD_BUG_ON(sizeof(struct uas_cmd_info) > sizeof(struct scsi_pointer));
654 if ((devinfo->flags & US_FL_NO_ATA_1X) &&
655 (cmnd->cmnd[0] == ATA_12 || cmnd->cmnd[0] == ATA_16)) {
656 memcpy(cmnd->sense_buffer, usb_stor_sense_invalidCDB,
657 sizeof(usb_stor_sense_invalidCDB));
658 cmnd->result = SAM_STAT_CHECK_CONDITION;
659 cmnd->scsi_done(cmnd);
663 spin_lock_irqsave(&devinfo->lock, flags);
665 if (devinfo->resetting) {
666 cmnd->result = DID_ERROR << 16;
667 cmnd->scsi_done(cmnd);
668 spin_unlock_irqrestore(&devinfo->lock, flags);
672 stream = uas_get_tag(cmnd);
673 if (devinfo->cmnd[stream - 1]) {
674 spin_unlock_irqrestore(&devinfo->lock, flags);
675 return SCSI_MLQUEUE_DEVICE_BUSY;
678 cmnd->scsi_done = done;
680 memset(cmdinfo, 0, sizeof(*cmdinfo));
681 cmdinfo->stream = stream;
682 cmdinfo->state = SUBMIT_STATUS_URB | ALLOC_CMD_URB | SUBMIT_CMD_URB;
684 switch (cmnd->sc_data_direction) {
685 case DMA_FROM_DEVICE:
686 cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
688 case DMA_BIDIRECTIONAL:
689 cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
691 cmdinfo->state |= ALLOC_DATA_OUT_URB | SUBMIT_DATA_OUT_URB;
696 if (!devinfo->use_streams) {
697 cmdinfo->state &= ~(SUBMIT_DATA_IN_URB | SUBMIT_DATA_OUT_URB);
701 err = uas_submit_urbs(cmnd, devinfo, GFP_ATOMIC);
703 /* If we did nothing, give up now */
704 if (cmdinfo->state & SUBMIT_STATUS_URB) {
705 spin_unlock_irqrestore(&devinfo->lock, flags);
706 return SCSI_MLQUEUE_DEVICE_BUSY;
708 uas_add_work(cmdinfo);
711 devinfo->cmnd[stream - 1] = cmnd;
712 spin_unlock_irqrestore(&devinfo->lock, flags);
716 static DEF_SCSI_QCMD(uas_queuecommand)
718 static int uas_eh_bus_reset_handler(struct scsi_cmnd *cmnd)
720 struct scsi_device *sdev = cmnd->device;
721 struct uas_dev_info *devinfo = sdev->hostdata;
722 struct usb_device *udev = devinfo->udev;
726 err = usb_lock_device_for_reset(udev, devinfo->intf);
728 shost_printk(KERN_ERR, sdev->host,
729 "%s FAILED to get lock err %d\n", __func__, err);
733 shost_printk(KERN_INFO, sdev->host, "%s start\n", __func__);
735 spin_lock_irqsave(&devinfo->lock, flags);
736 devinfo->resetting = 1;
737 spin_unlock_irqrestore(&devinfo->lock, flags);
739 usb_kill_anchored_urbs(&devinfo->cmd_urbs);
740 usb_kill_anchored_urbs(&devinfo->sense_urbs);
741 usb_kill_anchored_urbs(&devinfo->data_urbs);
742 uas_zap_pending(devinfo, DID_RESET);
744 err = usb_reset_device(udev);
746 spin_lock_irqsave(&devinfo->lock, flags);
747 devinfo->resetting = 0;
748 spin_unlock_irqrestore(&devinfo->lock, flags);
750 usb_unlock_device(udev);
753 shost_printk(KERN_INFO, sdev->host, "%s FAILED\n", __func__);
757 shost_printk(KERN_INFO, sdev->host, "%s success\n", __func__);
761 static int uas_slave_alloc(struct scsi_device *sdev)
763 sdev->hostdata = (void *)sdev->host->hostdata;
765 /* USB has unusual DMA-alignment requirements: Although the
766 * starting address of each scatter-gather element doesn't matter,
767 * the length of each element except the last must be divisible
768 * by the Bulk maxpacket value. There's currently no way to
769 * express this by block-layer constraints, so we'll cop out
770 * and simply require addresses to be aligned at 512-byte
771 * boundaries. This is okay since most block I/O involves
772 * hardware sectors that are multiples of 512 bytes in length,
773 * and since host controllers up through USB 2.0 have maxpacket
774 * values no larger than 512.
776 * But it doesn't suffice for Wireless USB, where Bulk maxpacket
777 * values can be as large as 2048. To make that work properly
778 * will require changes to the block layer.
780 blk_queue_update_dma_alignment(sdev->request_queue, (512 - 1));
785 static int uas_slave_configure(struct scsi_device *sdev)
787 struct uas_dev_info *devinfo = sdev->hostdata;
789 if (devinfo->flags & US_FL_NO_REPORT_OPCODES)
790 sdev->no_report_opcodes = 1;
792 scsi_set_tag_type(sdev, MSG_ORDERED_TAG);
793 scsi_activate_tcq(sdev, devinfo->qdepth - 2);
797 static struct scsi_host_template uas_host_template = {
798 .module = THIS_MODULE,
800 .queuecommand = uas_queuecommand,
801 .slave_alloc = uas_slave_alloc,
802 .slave_configure = uas_slave_configure,
803 .eh_bus_reset_handler = uas_eh_bus_reset_handler,
804 .can_queue = 65536, /* Is there a limit on the _host_ ? */
806 .sg_tablesize = SG_NONE,
807 .cmd_per_lun = 1, /* until we override it */
808 .skip_settle_delay = 1,
812 #define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \
813 vendorName, productName, useProtocol, useTransport, \
814 initFunction, flags) \
815 { USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax), \
816 .driver_info = (flags) }
818 static struct usb_device_id uas_usb_ids[] = {
819 # include "unusual_uas.h"
820 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_BULK) },
821 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_UAS) },
822 /* 0xaa is a prototype device I happen to have access to */
823 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, 0xaa) },
826 MODULE_DEVICE_TABLE(usb, uas_usb_ids);
830 static int uas_switch_interface(struct usb_device *udev,
831 struct usb_interface *intf)
835 alt = uas_find_uas_alt_setting(intf);
839 return usb_set_interface(udev,
840 intf->altsetting[0].desc.bInterfaceNumber, alt);
843 static int uas_configure_endpoints(struct uas_dev_info *devinfo)
845 struct usb_host_endpoint *eps[4] = { };
846 struct usb_device *udev = devinfo->udev;
849 devinfo->uas_sense_old = 0;
851 r = uas_find_endpoints(devinfo->intf->cur_altsetting, eps);
855 devinfo->cmd_pipe = usb_sndbulkpipe(udev,
856 usb_endpoint_num(&eps[0]->desc));
857 devinfo->status_pipe = usb_rcvbulkpipe(udev,
858 usb_endpoint_num(&eps[1]->desc));
859 devinfo->data_in_pipe = usb_rcvbulkpipe(udev,
860 usb_endpoint_num(&eps[2]->desc));
861 devinfo->data_out_pipe = usb_sndbulkpipe(udev,
862 usb_endpoint_num(&eps[3]->desc));
864 if (udev->speed != USB_SPEED_SUPER) {
865 devinfo->qdepth = 32;
866 devinfo->use_streams = 0;
868 devinfo->qdepth = usb_alloc_streams(devinfo->intf, eps + 1,
869 3, MAX_CMNDS, GFP_NOIO);
870 if (devinfo->qdepth < 0)
871 return devinfo->qdepth;
872 devinfo->use_streams = 1;
878 static void uas_free_streams(struct uas_dev_info *devinfo)
880 struct usb_device *udev = devinfo->udev;
881 struct usb_host_endpoint *eps[3];
883 eps[0] = usb_pipe_endpoint(udev, devinfo->status_pipe);
884 eps[1] = usb_pipe_endpoint(udev, devinfo->data_in_pipe);
885 eps[2] = usb_pipe_endpoint(udev, devinfo->data_out_pipe);
886 usb_free_streams(devinfo->intf, eps, 3, GFP_NOIO);
889 static int uas_probe(struct usb_interface *intf, const struct usb_device_id *id)
891 int result = -ENOMEM;
892 struct Scsi_Host *shost = NULL;
893 struct uas_dev_info *devinfo;
894 struct usb_device *udev = interface_to_usbdev(intf);
896 if (!uas_use_uas_driver(intf, id))
899 if (uas_switch_interface(udev, intf))
902 shost = scsi_host_alloc(&uas_host_template,
903 sizeof(struct uas_dev_info));
907 shost->max_cmd_len = 16 + 252;
909 shost->max_lun = 256;
910 shost->max_channel = 0;
911 shost->sg_tablesize = udev->bus->sg_tablesize;
913 devinfo = (struct uas_dev_info *)shost->hostdata;
914 devinfo->intf = intf;
915 devinfo->udev = udev;
916 devinfo->resetting = 0;
917 devinfo->shutdown = 0;
918 devinfo->flags = id->driver_info;
919 usb_stor_adjust_quirks(udev, &devinfo->flags);
920 init_usb_anchor(&devinfo->cmd_urbs);
921 init_usb_anchor(&devinfo->sense_urbs);
922 init_usb_anchor(&devinfo->data_urbs);
923 spin_lock_init(&devinfo->lock);
924 INIT_WORK(&devinfo->work, uas_do_work);
926 result = uas_configure_endpoints(devinfo);
930 result = scsi_init_shared_tag_map(shost, devinfo->qdepth - 2);
934 usb_set_intfdata(intf, shost);
935 result = scsi_add_host(shost, &intf->dev);
939 scsi_scan_host(shost);
943 uas_free_streams(devinfo);
944 usb_set_intfdata(intf, NULL);
946 usb_set_interface(udev, intf->altsetting[0].desc.bInterfaceNumber, 0);
948 scsi_host_put(shost);
952 static int uas_pre_reset(struct usb_interface *intf)
954 struct Scsi_Host *shost = usb_get_intfdata(intf);
955 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
958 if (devinfo->shutdown)
961 /* Block new requests */
962 spin_lock_irqsave(shost->host_lock, flags);
963 scsi_block_requests(shost);
964 spin_unlock_irqrestore(shost->host_lock, flags);
966 /* Wait for any pending requests to complete */
967 flush_work(&devinfo->work);
968 if (usb_wait_anchor_empty_timeout(&devinfo->sense_urbs, 5000) == 0) {
969 shost_printk(KERN_ERR, shost, "%s: timed out\n", __func__);
973 uas_free_streams(devinfo);
978 static int uas_post_reset(struct usb_interface *intf)
980 struct Scsi_Host *shost = usb_get_intfdata(intf);
981 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
984 if (devinfo->shutdown)
987 if (uas_configure_endpoints(devinfo) != 0) {
988 shost_printk(KERN_ERR, shost,
989 "%s: alloc streams error after reset", __func__);
993 spin_lock_irqsave(shost->host_lock, flags);
994 scsi_report_bus_reset(shost, 0);
995 spin_unlock_irqrestore(shost->host_lock, flags);
997 scsi_unblock_requests(shost);
1002 static int uas_suspend(struct usb_interface *intf, pm_message_t message)
1004 struct Scsi_Host *shost = usb_get_intfdata(intf);
1005 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1007 /* Wait for any pending requests to complete */
1008 flush_work(&devinfo->work);
1009 if (usb_wait_anchor_empty_timeout(&devinfo->sense_urbs, 5000) == 0) {
1010 shost_printk(KERN_ERR, shost, "%s: timed out\n", __func__);
1017 static int uas_resume(struct usb_interface *intf)
1022 static int uas_reset_resume(struct usb_interface *intf)
1024 struct Scsi_Host *shost = usb_get_intfdata(intf);
1025 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1026 unsigned long flags;
1028 if (uas_configure_endpoints(devinfo) != 0) {
1029 shost_printk(KERN_ERR, shost,
1030 "%s: alloc streams error after reset", __func__);
1034 spin_lock_irqsave(shost->host_lock, flags);
1035 scsi_report_bus_reset(shost, 0);
1036 spin_unlock_irqrestore(shost->host_lock, flags);
1041 static void uas_disconnect(struct usb_interface *intf)
1043 struct Scsi_Host *shost = usb_get_intfdata(intf);
1044 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1045 unsigned long flags;
1047 spin_lock_irqsave(&devinfo->lock, flags);
1048 devinfo->resetting = 1;
1049 spin_unlock_irqrestore(&devinfo->lock, flags);
1051 cancel_work_sync(&devinfo->work);
1052 usb_kill_anchored_urbs(&devinfo->cmd_urbs);
1053 usb_kill_anchored_urbs(&devinfo->sense_urbs);
1054 usb_kill_anchored_urbs(&devinfo->data_urbs);
1055 uas_zap_pending(devinfo, DID_NO_CONNECT);
1057 scsi_remove_host(shost);
1058 uas_free_streams(devinfo);
1059 scsi_host_put(shost);
1063 * Put the device back in usb-storage mode on shutdown, as some BIOS-es
1064 * hang on reboot when the device is still in uas mode. Note the reset is
1065 * necessary as some devices won't revert to usb-storage mode without it.
1067 static void uas_shutdown(struct device *dev)
1069 struct usb_interface *intf = to_usb_interface(dev);
1070 struct usb_device *udev = interface_to_usbdev(intf);
1071 struct Scsi_Host *shost = usb_get_intfdata(intf);
1072 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1074 if (system_state != SYSTEM_RESTART)
1077 devinfo->shutdown = 1;
1078 uas_free_streams(devinfo);
1079 usb_set_interface(udev, intf->altsetting[0].desc.bInterfaceNumber, 0);
1080 usb_reset_device(udev);
1083 static struct usb_driver uas_driver = {
1086 .disconnect = uas_disconnect,
1087 .pre_reset = uas_pre_reset,
1088 .post_reset = uas_post_reset,
1089 .suspend = uas_suspend,
1090 .resume = uas_resume,
1091 .reset_resume = uas_reset_resume,
1092 .drvwrap.driver.shutdown = uas_shutdown,
1093 .id_table = uas_usb_ids,
1096 module_usb_driver(uas_driver);
1098 MODULE_LICENSE("GPL");
1100 "Hans de Goede <hdegoede@redhat.com>, Matthew Wilcox and Sarah Sharp");