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 - 2016
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 struct response_iu response;
58 unsigned cmd_pipe, status_pipe, data_in_pipe, data_out_pipe;
59 unsigned use_streams:1;
60 unsigned uas_sense_old:1;
61 unsigned running_task:1;
63 struct scsi_cmnd *cmnd;
65 struct work_struct work;
66 struct list_head inflight_list;
67 struct list_head dead_list;
71 SUBMIT_STATUS_URB = (1 << 1),
72 ALLOC_DATA_IN_URB = (1 << 2),
73 SUBMIT_DATA_IN_URB = (1 << 3),
74 ALLOC_DATA_OUT_URB = (1 << 4),
75 SUBMIT_DATA_OUT_URB = (1 << 5),
76 ALLOC_CMD_URB = (1 << 6),
77 SUBMIT_CMD_URB = (1 << 7),
78 COMMAND_INFLIGHT = (1 << 8),
79 DATA_IN_URB_INFLIGHT = (1 << 9),
80 DATA_OUT_URB_INFLIGHT = (1 << 10),
81 COMMAND_COMPLETED = (1 << 11),
82 COMMAND_ABORTED = (1 << 12),
83 UNLINK_DATA_URBS = (1 << 13),
84 IS_IN_WORK_LIST = (1 << 14),
87 /* Overrides scsi_pointer */
92 struct urb *data_in_urb;
93 struct urb *data_out_urb;
94 struct list_head list;
97 /* I hate forward declarations, but I actually have a loop */
98 static int uas_submit_urbs(struct scsi_cmnd *cmnd,
99 struct uas_dev_info *devinfo, gfp_t gfp);
100 static void uas_do_work(struct work_struct *work);
101 static int uas_try_complete(struct scsi_cmnd *cmnd, const char *caller);
102 static void uas_free_streams(struct uas_dev_info *devinfo);
103 static void uas_log_cmd_state(struct scsi_cmnd *cmnd, const char *caller);
105 /* Must be called with devinfo->lock held, will temporary unlock the lock */
106 static void uas_unlink_data_urbs(struct uas_dev_info *devinfo,
107 struct uas_cmd_info *cmdinfo,
108 unsigned long *lock_flags)
111 * The UNLINK_DATA_URBS flag makes sure uas_try_complete
112 * (called by urb completion) doesn't release cmdinfo
115 cmdinfo->state |= UNLINK_DATA_URBS;
116 spin_unlock_irqrestore(&devinfo->lock, *lock_flags);
118 if (cmdinfo->data_in_urb)
119 usb_unlink_urb(cmdinfo->data_in_urb);
120 if (cmdinfo->data_out_urb)
121 usb_unlink_urb(cmdinfo->data_out_urb);
123 spin_lock_irqsave(&devinfo->lock, *lock_flags);
124 cmdinfo->state &= ~UNLINK_DATA_URBS;
127 static void uas_do_work(struct work_struct *work)
129 struct uas_dev_info *devinfo =
130 container_of(work, struct uas_dev_info, work);
131 struct uas_cmd_info *cmdinfo;
135 spin_lock_irqsave(&devinfo->lock, flags);
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);
150 spin_unlock_irqrestore(&devinfo->lock, flags);
153 static void uas_mark_cmd_dead(struct uas_dev_info *devinfo,
154 struct uas_cmd_info *cmdinfo,
155 int result, const char *caller)
157 struct scsi_pointer *scp = (void *)cmdinfo;
158 struct scsi_cmnd *cmnd = container_of(scp, struct scsi_cmnd, SCp);
160 uas_log_cmd_state(cmnd, caller);
161 lockdep_assert_held(&devinfo->lock);
162 WARN_ON_ONCE(cmdinfo->state & COMMAND_ABORTED);
163 cmdinfo->state |= COMMAND_ABORTED;
164 cmdinfo->state &= ~IS_IN_WORK_LIST;
165 cmnd->result = result << 16;
166 list_move_tail(&cmdinfo->list, &devinfo->dead_list);
169 static void uas_abort_inflight(struct uas_dev_info *devinfo, int result,
172 struct uas_cmd_info *cmdinfo;
173 struct uas_cmd_info *temp;
176 spin_lock_irqsave(&devinfo->lock, flags);
177 list_for_each_entry_safe(cmdinfo, temp, &devinfo->inflight_list, list)
178 uas_mark_cmd_dead(devinfo, cmdinfo, result, caller);
179 spin_unlock_irqrestore(&devinfo->lock, flags);
182 static void uas_add_work(struct uas_cmd_info *cmdinfo)
184 struct scsi_pointer *scp = (void *)cmdinfo;
185 struct scsi_cmnd *cmnd = container_of(scp, struct scsi_cmnd, SCp);
186 struct uas_dev_info *devinfo = cmnd->device->hostdata;
188 lockdep_assert_held(&devinfo->lock);
189 cmdinfo->state |= IS_IN_WORK_LIST;
190 schedule_work(&devinfo->work);
193 static void uas_zap_dead(struct uas_dev_info *devinfo)
195 struct uas_cmd_info *cmdinfo;
196 struct uas_cmd_info *temp;
199 spin_lock_irqsave(&devinfo->lock, flags);
200 list_for_each_entry_safe(cmdinfo, temp, &devinfo->dead_list, list) {
201 struct scsi_pointer *scp = (void *)cmdinfo;
202 struct scsi_cmnd *cmnd = container_of(scp, struct scsi_cmnd,
204 uas_log_cmd_state(cmnd, __func__);
205 WARN_ON_ONCE(!(cmdinfo->state & COMMAND_ABORTED));
206 /* all urbs are killed, clear inflight bits */
207 cmdinfo->state &= ~(COMMAND_INFLIGHT |
208 DATA_IN_URB_INFLIGHT |
209 DATA_OUT_URB_INFLIGHT);
210 uas_try_complete(cmnd, __func__);
212 devinfo->running_task = 0;
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;
262 static void uas_log_cmd_state(struct scsi_cmnd *cmnd, const char *caller)
264 struct uas_cmd_info *ci = (void *)&cmnd->SCp;
266 scmd_printk(KERN_INFO, cmnd, "%s %p tag %d, inflight:"
267 "%s%s%s%s%s%s%s%s%s%s%s%s%s%s\n",
268 caller, cmnd, cmnd->request->tag,
269 (ci->state & SUBMIT_STATUS_URB) ? " s-st" : "",
270 (ci->state & ALLOC_DATA_IN_URB) ? " a-in" : "",
271 (ci->state & SUBMIT_DATA_IN_URB) ? " s-in" : "",
272 (ci->state & ALLOC_DATA_OUT_URB) ? " a-out" : "",
273 (ci->state & SUBMIT_DATA_OUT_URB) ? " s-out" : "",
274 (ci->state & ALLOC_CMD_URB) ? " a-cmd" : "",
275 (ci->state & SUBMIT_CMD_URB) ? " s-cmd" : "",
276 (ci->state & COMMAND_INFLIGHT) ? " CMD" : "",
277 (ci->state & DATA_IN_URB_INFLIGHT) ? " IN" : "",
278 (ci->state & DATA_OUT_URB_INFLIGHT) ? " OUT" : "",
279 (ci->state & COMMAND_COMPLETED) ? " done" : "",
280 (ci->state & COMMAND_ABORTED) ? " abort" : "",
281 (ci->state & UNLINK_DATA_URBS) ? " unlink": "",
282 (ci->state & IS_IN_WORK_LIST) ? " work" : "");
285 static int uas_try_complete(struct scsi_cmnd *cmnd, const char *caller)
287 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
288 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
290 lockdep_assert_held(&devinfo->lock);
291 if (cmdinfo->state & (COMMAND_INFLIGHT |
292 DATA_IN_URB_INFLIGHT |
293 DATA_OUT_URB_INFLIGHT |
296 WARN_ON_ONCE(cmdinfo->state & COMMAND_COMPLETED);
297 cmdinfo->state |= COMMAND_COMPLETED;
298 usb_free_urb(cmdinfo->data_in_urb);
299 usb_free_urb(cmdinfo->data_out_urb);
300 if (cmdinfo->state & COMMAND_ABORTED)
301 scmd_printk(KERN_INFO, cmnd, "abort completed\n");
302 list_del(&cmdinfo->list);
303 cmnd->scsi_done(cmnd);
307 static void uas_xfer_data(struct urb *urb, struct scsi_cmnd *cmnd,
310 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
313 cmdinfo->state |= direction | SUBMIT_STATUS_URB;
314 err = uas_submit_urbs(cmnd, cmnd->device->hostdata, GFP_ATOMIC);
316 uas_add_work(cmdinfo);
320 static void uas_stat_cmplt(struct urb *urb)
322 struct iu *iu = urb->transfer_buffer;
323 struct Scsi_Host *shost = urb->context;
324 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
325 struct scsi_cmnd *cmnd;
326 struct uas_cmd_info *cmdinfo;
331 if (urb->status == -ENOENT) {
332 dev_err(&urb->dev->dev, "stat urb: killed, stream %d\n",
335 dev_err(&urb->dev->dev, "stat urb: status %d\n",
342 if (devinfo->resetting) {
347 spin_lock_irqsave(&devinfo->lock, flags);
348 tag = be16_to_cpup(&iu->tag) - 1;
350 cmnd = devinfo->cmnd;
352 cmnd = scsi_host_find_tag(shost, tag - 1);
355 if (iu->iu_id == IU_ID_RESPONSE) {
356 if (!devinfo->running_task)
357 dev_warn(&urb->dev->dev,
358 "stat urb: recv unexpected response iu\n");
359 /* store results for uas_eh_task_mgmt() */
360 memcpy(&devinfo->response, iu, sizeof(devinfo->response));
363 spin_unlock_irqrestore(&devinfo->lock, flags);
367 cmdinfo = (void *)&cmnd->SCp;
370 if (devinfo->cmnd == cmnd)
371 devinfo->cmnd = NULL;
373 if (urb->actual_length < 16)
374 devinfo->uas_sense_old = 1;
375 if (devinfo->uas_sense_old)
376 uas_sense_old(urb, cmnd);
378 uas_sense(urb, cmnd);
379 if (cmnd->result != 0) {
380 /* cancel data transfers on error */
381 uas_unlink_data_urbs(devinfo, cmdinfo, &flags);
383 cmdinfo->state &= ~COMMAND_INFLIGHT;
384 uas_try_complete(cmnd, __func__);
386 case IU_ID_READ_READY:
387 if (!cmdinfo->data_in_urb ||
388 (cmdinfo->state & DATA_IN_URB_INFLIGHT)) {
389 scmd_printk(KERN_ERR, cmnd, "unexpected read rdy\n");
392 uas_xfer_data(urb, cmnd, SUBMIT_DATA_IN_URB);
394 case IU_ID_WRITE_READY:
395 if (!cmdinfo->data_out_urb ||
396 (cmdinfo->state & DATA_OUT_URB_INFLIGHT)) {
397 scmd_printk(KERN_ERR, cmnd, "unexpected write rdy\n");
400 uas_xfer_data(urb, cmnd, SUBMIT_DATA_OUT_URB);
403 scmd_printk(KERN_ERR, cmnd,
404 "Bogus IU (%d) received on status pipe\n", iu->iu_id);
407 spin_unlock_irqrestore(&devinfo->lock, flags);
410 static void uas_data_cmplt(struct urb *urb)
412 struct scsi_cmnd *cmnd = urb->context;
413 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
414 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
415 struct scsi_data_buffer *sdb = NULL;
418 spin_lock_irqsave(&devinfo->lock, flags);
419 if (cmdinfo->data_in_urb == urb) {
421 cmdinfo->state &= ~DATA_IN_URB_INFLIGHT;
422 } else if (cmdinfo->data_out_urb == urb) {
423 sdb = scsi_out(cmnd);
424 cmdinfo->state &= ~DATA_OUT_URB_INFLIGHT;
428 } else if (urb->status) {
429 if (urb->status != -ECONNRESET) {
430 uas_log_cmd_state(cmnd, __func__);
431 scmd_printk(KERN_ERR, cmnd,
432 "data cmplt err %d stream %d\n",
433 urb->status, urb->stream_id);
435 /* error: no data transfered */
436 sdb->resid = sdb->length;
438 sdb->resid = sdb->length - urb->actual_length;
440 uas_try_complete(cmnd, __func__);
441 spin_unlock_irqrestore(&devinfo->lock, flags);
444 static void uas_cmd_cmplt(struct urb *urb)
446 struct scsi_cmnd *cmnd = urb->context;
449 uas_log_cmd_state(cmnd, __func__);
450 scmd_printk(KERN_ERR, cmnd, "cmd cmplt err %d\n", urb->status);
455 static struct urb *uas_alloc_data_urb(struct uas_dev_info *devinfo, gfp_t gfp,
456 unsigned int pipe, u16 stream_id,
457 struct scsi_cmnd *cmnd,
458 enum dma_data_direction dir)
460 struct usb_device *udev = devinfo->udev;
461 struct urb *urb = usb_alloc_urb(0, gfp);
462 struct scsi_data_buffer *sdb = (dir == DMA_FROM_DEVICE)
463 ? scsi_in(cmnd) : scsi_out(cmnd);
467 usb_fill_bulk_urb(urb, udev, pipe, NULL, sdb->length,
468 uas_data_cmplt, cmnd);
469 urb->stream_id = stream_id;
470 urb->num_sgs = udev->bus->sg_tablesize ? sdb->table.nents : 0;
471 urb->sg = sdb->table.sgl;
476 static struct urb *uas_alloc_sense_urb(struct uas_dev_info *devinfo, gfp_t gfp,
477 struct Scsi_Host *shost, u16 stream_id)
479 struct usb_device *udev = devinfo->udev;
480 struct urb *urb = usb_alloc_urb(0, gfp);
486 iu = kzalloc(sizeof(*iu), gfp);
490 usb_fill_bulk_urb(urb, udev, devinfo->status_pipe, iu, sizeof(*iu),
491 uas_stat_cmplt, shost);
492 urb->stream_id = stream_id;
493 urb->transfer_flags |= URB_FREE_BUFFER;
501 static struct urb *uas_alloc_cmd_urb(struct uas_dev_info *devinfo, gfp_t gfp,
502 struct scsi_cmnd *cmnd)
504 struct usb_device *udev = devinfo->udev;
505 struct scsi_device *sdev = cmnd->device;
506 struct urb *urb = usb_alloc_urb(0, gfp);
507 struct command_iu *iu;
513 len = cmnd->cmd_len - 16;
517 iu = kzalloc(sizeof(*iu) + len, gfp);
521 iu->iu_id = IU_ID_COMMAND;
522 if (blk_rq_tagged(cmnd->request))
523 iu->tag = cpu_to_be16(cmnd->request->tag + 2);
525 iu->tag = cpu_to_be16(1);
526 iu->prio_attr = UAS_SIMPLE_TAG;
528 int_to_scsilun(sdev->lun, &iu->lun);
529 memcpy(iu->cdb, cmnd->cmnd, cmnd->cmd_len);
531 usb_fill_bulk_urb(urb, udev, devinfo->cmd_pipe, iu, sizeof(*iu) + len,
532 uas_cmd_cmplt, cmnd);
533 urb->transfer_flags |= URB_FREE_BUFFER;
541 static int uas_submit_task_urb(struct scsi_cmnd *cmnd, gfp_t gfp,
542 u8 function, u16 stream_id)
544 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
545 struct usb_device *udev = devinfo->udev;
546 struct urb *urb = usb_alloc_urb(0, gfp);
547 struct task_mgmt_iu *iu;
553 iu = kzalloc(sizeof(*iu), gfp);
557 iu->iu_id = IU_ID_TASK_MGMT;
558 iu->tag = cpu_to_be16(stream_id);
559 int_to_scsilun(cmnd->device->lun, &iu->lun);
561 iu->function = function;
564 if (blk_rq_tagged(cmnd->request))
565 iu->task_tag = cpu_to_be16(cmnd->request->tag + 2);
567 iu->task_tag = cpu_to_be16(1);
571 usb_fill_bulk_urb(urb, udev, devinfo->cmd_pipe, iu, sizeof(*iu),
572 uas_cmd_cmplt, cmnd);
573 urb->transfer_flags |= URB_FREE_BUFFER;
575 usb_anchor_urb(urb, &devinfo->cmd_urbs);
576 err = usb_submit_urb(urb, gfp);
578 usb_unanchor_urb(urb);
579 uas_log_cmd_state(cmnd, __func__);
580 scmd_printk(KERN_ERR, cmnd, "task submission err %d\n", err);
592 * Why should I request the Status IU before sending the Command IU? Spec
593 * says to, but also says the device may receive them in any order. Seems
597 static struct urb *uas_submit_sense_urb(struct scsi_cmnd *cmnd,
598 gfp_t gfp, unsigned int stream)
600 struct Scsi_Host *shost = cmnd->device->host;
601 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
605 urb = uas_alloc_sense_urb(devinfo, gfp, shost, stream);
608 usb_anchor_urb(urb, &devinfo->sense_urbs);
609 err = usb_submit_urb(urb, gfp);
611 usb_unanchor_urb(urb);
612 uas_log_cmd_state(cmnd, __func__);
613 shost_printk(KERN_INFO, shost,
614 "sense urb submission error %d stream %d\n",
622 static int uas_submit_urbs(struct scsi_cmnd *cmnd,
623 struct uas_dev_info *devinfo, gfp_t gfp)
625 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
629 lockdep_assert_held(&devinfo->lock);
630 if (cmdinfo->state & SUBMIT_STATUS_URB) {
631 urb = uas_submit_sense_urb(cmnd, gfp, cmdinfo->stream);
633 return SCSI_MLQUEUE_DEVICE_BUSY;
634 cmdinfo->state &= ~SUBMIT_STATUS_URB;
637 if (cmdinfo->state & ALLOC_DATA_IN_URB) {
638 cmdinfo->data_in_urb = uas_alloc_data_urb(devinfo, gfp,
639 devinfo->data_in_pipe, cmdinfo->stream,
640 cmnd, DMA_FROM_DEVICE);
641 if (!cmdinfo->data_in_urb)
642 return SCSI_MLQUEUE_DEVICE_BUSY;
643 cmdinfo->state &= ~ALLOC_DATA_IN_URB;
646 if (cmdinfo->state & SUBMIT_DATA_IN_URB) {
647 usb_anchor_urb(cmdinfo->data_in_urb, &devinfo->data_urbs);
648 err = usb_submit_urb(cmdinfo->data_in_urb, gfp);
650 usb_unanchor_urb(cmdinfo->data_in_urb);
651 uas_log_cmd_state(cmnd, __func__);
652 scmd_printk(KERN_INFO, cmnd,
653 "data in urb submission error %d stream %d\n",
654 err, cmdinfo->data_in_urb->stream_id);
655 return SCSI_MLQUEUE_DEVICE_BUSY;
657 cmdinfo->state &= ~SUBMIT_DATA_IN_URB;
658 cmdinfo->state |= DATA_IN_URB_INFLIGHT;
661 if (cmdinfo->state & ALLOC_DATA_OUT_URB) {
662 cmdinfo->data_out_urb = uas_alloc_data_urb(devinfo, gfp,
663 devinfo->data_out_pipe, cmdinfo->stream,
664 cmnd, DMA_TO_DEVICE);
665 if (!cmdinfo->data_out_urb)
666 return SCSI_MLQUEUE_DEVICE_BUSY;
667 cmdinfo->state &= ~ALLOC_DATA_OUT_URB;
670 if (cmdinfo->state & SUBMIT_DATA_OUT_URB) {
671 usb_anchor_urb(cmdinfo->data_out_urb, &devinfo->data_urbs);
672 err = usb_submit_urb(cmdinfo->data_out_urb, gfp);
674 usb_unanchor_urb(cmdinfo->data_out_urb);
675 uas_log_cmd_state(cmnd, __func__);
676 scmd_printk(KERN_INFO, cmnd,
677 "data out urb submission error %d stream %d\n",
678 err, cmdinfo->data_out_urb->stream_id);
679 return SCSI_MLQUEUE_DEVICE_BUSY;
681 cmdinfo->state &= ~SUBMIT_DATA_OUT_URB;
682 cmdinfo->state |= DATA_OUT_URB_INFLIGHT;
685 if (cmdinfo->state & ALLOC_CMD_URB) {
686 cmdinfo->cmd_urb = uas_alloc_cmd_urb(devinfo, gfp, cmnd);
687 if (!cmdinfo->cmd_urb)
688 return SCSI_MLQUEUE_DEVICE_BUSY;
689 cmdinfo->state &= ~ALLOC_CMD_URB;
692 if (cmdinfo->state & SUBMIT_CMD_URB) {
693 usb_anchor_urb(cmdinfo->cmd_urb, &devinfo->cmd_urbs);
694 err = usb_submit_urb(cmdinfo->cmd_urb, gfp);
696 usb_unanchor_urb(cmdinfo->cmd_urb);
697 uas_log_cmd_state(cmnd, __func__);
698 scmd_printk(KERN_INFO, cmnd,
699 "cmd urb submission error %d\n", err);
700 return SCSI_MLQUEUE_DEVICE_BUSY;
702 cmdinfo->cmd_urb = NULL;
703 cmdinfo->state &= ~SUBMIT_CMD_URB;
704 cmdinfo->state |= COMMAND_INFLIGHT;
710 static int uas_queuecommand_lck(struct scsi_cmnd *cmnd,
711 void (*done)(struct scsi_cmnd *))
713 struct scsi_device *sdev = cmnd->device;
714 struct uas_dev_info *devinfo = sdev->hostdata;
715 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
719 BUILD_BUG_ON(sizeof(struct uas_cmd_info) > sizeof(struct scsi_pointer));
721 if ((devinfo->flags & US_FL_NO_ATA_1X) &&
722 (cmnd->cmnd[0] == ATA_12 || cmnd->cmnd[0] == ATA_16)) {
723 memcpy(cmnd->sense_buffer, usb_stor_sense_invalidCDB,
724 sizeof(usb_stor_sense_invalidCDB));
725 cmnd->result = SAM_STAT_CHECK_CONDITION;
726 cmnd->scsi_done(cmnd);
730 spin_lock_irqsave(&devinfo->lock, flags);
732 if (devinfo->resetting) {
733 cmnd->result = DID_ERROR << 16;
734 cmnd->scsi_done(cmnd);
735 spin_unlock_irqrestore(&devinfo->lock, flags);
740 spin_unlock_irqrestore(&devinfo->lock, flags);
741 return SCSI_MLQUEUE_DEVICE_BUSY;
744 memset(cmdinfo, 0, sizeof(*cmdinfo));
746 if (blk_rq_tagged(cmnd->request)) {
747 cmdinfo->stream = cmnd->request->tag + 2;
749 devinfo->cmnd = cmnd;
753 cmnd->scsi_done = done;
755 cmdinfo->state = SUBMIT_STATUS_URB |
756 ALLOC_CMD_URB | SUBMIT_CMD_URB;
758 switch (cmnd->sc_data_direction) {
759 case DMA_FROM_DEVICE:
760 cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
762 case DMA_BIDIRECTIONAL:
763 cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
765 cmdinfo->state |= ALLOC_DATA_OUT_URB | SUBMIT_DATA_OUT_URB;
770 if (!devinfo->use_streams) {
771 cmdinfo->state &= ~(SUBMIT_DATA_IN_URB | SUBMIT_DATA_OUT_URB);
775 err = uas_submit_urbs(cmnd, devinfo, GFP_ATOMIC);
777 /* If we did nothing, give up now */
778 if (cmdinfo->state & SUBMIT_STATUS_URB) {
779 spin_unlock_irqrestore(&devinfo->lock, flags);
780 return SCSI_MLQUEUE_DEVICE_BUSY;
782 uas_add_work(cmdinfo);
785 list_add_tail(&cmdinfo->list, &devinfo->inflight_list);
786 spin_unlock_irqrestore(&devinfo->lock, flags);
790 static DEF_SCSI_QCMD(uas_queuecommand)
792 static int uas_eh_task_mgmt(struct scsi_cmnd *cmnd,
793 const char *fname, u8 function)
795 struct Scsi_Host *shost = cmnd->device->host;
796 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
797 u16 tag = devinfo->qdepth;
799 struct urb *sense_urb;
800 int result = SUCCESS;
802 spin_lock_irqsave(&devinfo->lock, flags);
804 if (devinfo->resetting) {
805 spin_unlock_irqrestore(&devinfo->lock, flags);
809 if (devinfo->running_task) {
810 shost_printk(KERN_INFO, shost,
811 "%s: %s: error already running a task\n",
813 spin_unlock_irqrestore(&devinfo->lock, flags);
817 devinfo->running_task = 1;
818 memset(&devinfo->response, 0, sizeof(devinfo->response));
819 sense_urb = uas_submit_sense_urb(cmnd, GFP_ATOMIC,
820 devinfo->use_streams ? tag : 0);
822 shost_printk(KERN_INFO, shost,
823 "%s: %s: submit sense urb failed\n",
825 devinfo->running_task = 0;
826 spin_unlock_irqrestore(&devinfo->lock, flags);
829 if (uas_submit_task_urb(cmnd, GFP_ATOMIC, function, tag)) {
830 shost_printk(KERN_INFO, shost,
831 "%s: %s: submit task mgmt urb failed\n",
833 devinfo->running_task = 0;
834 spin_unlock_irqrestore(&devinfo->lock, flags);
835 usb_kill_urb(sense_urb);
838 spin_unlock_irqrestore(&devinfo->lock, flags);
840 if (usb_wait_anchor_empty_timeout(&devinfo->sense_urbs, 3000) == 0) {
842 * Note we deliberately do not clear running_task here. If we
843 * allow new tasks to be submitted, there is no way to figure
844 * out if a received response_iu is for the failed task or for
845 * the new one. A bus-reset will eventually clear running_task.
847 shost_printk(KERN_INFO, shost,
848 "%s: %s timed out\n", __func__, fname);
852 spin_lock_irqsave(&devinfo->lock, flags);
853 devinfo->running_task = 0;
854 if (be16_to_cpu(devinfo->response.tag) != tag) {
855 shost_printk(KERN_INFO, shost,
856 "%s: %s failed (wrong tag %d/%d)\n", __func__,
857 fname, be16_to_cpu(devinfo->response.tag), tag);
859 } else if (devinfo->response.response_code != RC_TMF_COMPLETE) {
860 shost_printk(KERN_INFO, shost,
861 "%s: %s failed (rc 0x%x)\n", __func__,
862 fname, devinfo->response.response_code);
865 spin_unlock_irqrestore(&devinfo->lock, flags);
870 static int uas_eh_abort_handler(struct scsi_cmnd *cmnd)
872 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
873 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
877 spin_lock_irqsave(&devinfo->lock, flags);
879 if (devinfo->resetting) {
880 spin_unlock_irqrestore(&devinfo->lock, flags);
884 uas_mark_cmd_dead(devinfo, cmdinfo, DID_ABORT, __func__);
885 if (cmdinfo->state & COMMAND_INFLIGHT) {
886 spin_unlock_irqrestore(&devinfo->lock, flags);
887 ret = uas_eh_task_mgmt(cmnd, "ABORT TASK", TMF_ABORT_TASK);
889 uas_unlink_data_urbs(devinfo, cmdinfo, &flags);
890 uas_try_complete(cmnd, __func__);
891 spin_unlock_irqrestore(&devinfo->lock, flags);
897 static int uas_eh_device_reset_handler(struct scsi_cmnd *cmnd)
899 sdev_printk(KERN_INFO, cmnd->device, "%s\n", __func__);
900 return uas_eh_task_mgmt(cmnd, "LOGICAL UNIT RESET",
901 TMF_LOGICAL_UNIT_RESET);
904 static int uas_eh_bus_reset_handler(struct scsi_cmnd *cmnd)
906 struct scsi_device *sdev = cmnd->device;
907 struct uas_dev_info *devinfo = sdev->hostdata;
908 struct usb_device *udev = devinfo->udev;
911 err = usb_lock_device_for_reset(udev, devinfo->intf);
913 shost_printk(KERN_ERR, sdev->host,
914 "%s FAILED to get lock err %d\n", __func__, err);
918 shost_printk(KERN_INFO, sdev->host, "%s start\n", __func__);
919 devinfo->resetting = 1;
920 uas_abort_inflight(devinfo, DID_RESET, __func__);
921 usb_kill_anchored_urbs(&devinfo->cmd_urbs);
922 usb_kill_anchored_urbs(&devinfo->sense_urbs);
923 usb_kill_anchored_urbs(&devinfo->data_urbs);
924 uas_zap_dead(devinfo);
925 err = usb_reset_device(udev);
926 devinfo->resetting = 0;
928 usb_unlock_device(udev);
931 shost_printk(KERN_INFO, sdev->host, "%s FAILED err %d\n",
936 shost_printk(KERN_INFO, sdev->host, "%s success\n", __func__);
940 static int uas_target_alloc(struct scsi_target *starget)
942 struct uas_dev_info *devinfo = (struct uas_dev_info *)
943 dev_to_shost(starget->dev.parent)->hostdata;
945 if (devinfo->flags & US_FL_NO_REPORT_LUNS)
946 starget->no_report_luns = 1;
951 static int uas_slave_alloc(struct scsi_device *sdev)
953 struct uas_dev_info *devinfo =
954 (struct uas_dev_info *)sdev->host->hostdata;
956 sdev->hostdata = devinfo;
958 /* USB has unusual DMA-alignment requirements: Although the
959 * starting address of each scatter-gather element doesn't matter,
960 * the length of each element except the last must be divisible
961 * by the Bulk maxpacket value. There's currently no way to
962 * express this by block-layer constraints, so we'll cop out
963 * and simply require addresses to be aligned at 512-byte
964 * boundaries. This is okay since most block I/O involves
965 * hardware sectors that are multiples of 512 bytes in length,
966 * and since host controllers up through USB 2.0 have maxpacket
967 * values no larger than 512.
969 * But it doesn't suffice for Wireless USB, where Bulk maxpacket
970 * values can be as large as 2048. To make that work properly
971 * will require changes to the block layer.
973 blk_queue_update_dma_alignment(sdev->request_queue, (512 - 1));
975 if (devinfo->flags & US_FL_MAX_SECTORS_64)
976 blk_queue_max_hw_sectors(sdev->request_queue, 64);
977 else if (devinfo->flags & US_FL_MAX_SECTORS_240)
978 blk_queue_max_hw_sectors(sdev->request_queue, 240);
983 static int uas_slave_configure(struct scsi_device *sdev)
985 struct uas_dev_info *devinfo = sdev->hostdata;
987 if (devinfo->flags & US_FL_NO_REPORT_OPCODES)
988 sdev->no_report_opcodes = 1;
990 /* A few buggy USB-ATA bridges don't understand FUA */
991 if (devinfo->flags & US_FL_BROKEN_FUA)
992 sdev->broken_fua = 1;
994 /* Some disks cannot handle READ_CAPACITY_16 */
995 if (devinfo->flags & US_FL_NO_READ_CAPACITY_16)
996 sdev->no_read_capacity_16 = 1;
999 * Some disks return the total number of blocks in response
1000 * to READ CAPACITY rather than the highest block number.
1001 * If this device makes that mistake, tell the sd driver.
1003 if (devinfo->flags & US_FL_FIX_CAPACITY)
1004 sdev->fix_capacity = 1;
1007 * in some cases we have to guess
1009 if (devinfo->flags & US_FL_CAPACITY_HEURISTICS)
1010 sdev->guess_capacity = 1;
1013 * Some devices don't like MODE SENSE with page=0x3f,
1014 * which is the command used for checking if a device
1015 * is write-protected. Now that we tell the sd driver
1016 * to do a 192-byte transfer with this command the
1017 * majority of devices work fine, but a few still can't
1018 * handle it. The sd driver will simply assume those
1019 * devices are write-enabled.
1021 if (devinfo->flags & US_FL_NO_WP_DETECT)
1022 sdev->skip_ms_page_3f = 1;
1024 scsi_set_tag_type(sdev, MSG_ORDERED_TAG);
1025 scsi_activate_tcq(sdev, devinfo->qdepth - 2);
1029 static struct scsi_host_template uas_host_template = {
1030 .module = THIS_MODULE,
1032 .queuecommand = uas_queuecommand,
1033 .target_alloc = uas_target_alloc,
1034 .slave_alloc = uas_slave_alloc,
1035 .slave_configure = uas_slave_configure,
1036 .eh_abort_handler = uas_eh_abort_handler,
1037 .eh_device_reset_handler = uas_eh_device_reset_handler,
1038 .eh_bus_reset_handler = uas_eh_bus_reset_handler,
1039 .can_queue = MAX_CMNDS,
1041 .sg_tablesize = SG_NONE,
1042 .cmd_per_lun = 1, /* until we override it */
1043 .skip_settle_delay = 1,
1047 #define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \
1048 vendorName, productName, useProtocol, useTransport, \
1049 initFunction, flags) \
1050 { USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax), \
1051 .driver_info = (flags) }
1053 static struct usb_device_id uas_usb_ids[] = {
1054 # include "unusual_uas.h"
1055 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_BULK) },
1056 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_UAS) },
1057 /* 0xaa is a prototype device I happen to have access to */
1058 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, 0xaa) },
1061 MODULE_DEVICE_TABLE(usb, uas_usb_ids);
1065 static int uas_switch_interface(struct usb_device *udev,
1066 struct usb_interface *intf)
1068 struct usb_host_interface *alt;
1070 alt = uas_find_uas_alt_setting(intf);
1074 return usb_set_interface(udev, alt->desc.bInterfaceNumber,
1075 alt->desc.bAlternateSetting);
1078 static int uas_configure_endpoints(struct uas_dev_info *devinfo)
1080 struct usb_host_endpoint *eps[4] = { };
1081 struct usb_device *udev = devinfo->udev;
1084 devinfo->uas_sense_old = 0;
1085 devinfo->cmnd = NULL;
1087 r = uas_find_endpoints(devinfo->intf->cur_altsetting, eps);
1091 devinfo->cmd_pipe = usb_sndbulkpipe(udev,
1092 usb_endpoint_num(&eps[0]->desc));
1093 devinfo->status_pipe = usb_rcvbulkpipe(udev,
1094 usb_endpoint_num(&eps[1]->desc));
1095 devinfo->data_in_pipe = usb_rcvbulkpipe(udev,
1096 usb_endpoint_num(&eps[2]->desc));
1097 devinfo->data_out_pipe = usb_sndbulkpipe(udev,
1098 usb_endpoint_num(&eps[3]->desc));
1100 if (udev->speed != USB_SPEED_SUPER) {
1101 devinfo->qdepth = 32;
1102 devinfo->use_streams = 0;
1104 devinfo->qdepth = usb_alloc_streams(devinfo->intf, eps + 1,
1105 3, MAX_CMNDS, GFP_NOIO);
1106 if (devinfo->qdepth < 0)
1107 return devinfo->qdepth;
1108 devinfo->use_streams = 1;
1114 static void uas_free_streams(struct uas_dev_info *devinfo)
1116 struct usb_device *udev = devinfo->udev;
1117 struct usb_host_endpoint *eps[3];
1119 eps[0] = usb_pipe_endpoint(udev, devinfo->status_pipe);
1120 eps[1] = usb_pipe_endpoint(udev, devinfo->data_in_pipe);
1121 eps[2] = usb_pipe_endpoint(udev, devinfo->data_out_pipe);
1122 usb_free_streams(devinfo->intf, eps, 3, GFP_NOIO);
1125 static int uas_probe(struct usb_interface *intf, const struct usb_device_id *id)
1127 int result = -ENOMEM;
1128 struct Scsi_Host *shost = NULL;
1129 struct uas_dev_info *devinfo;
1130 struct usb_device *udev = interface_to_usbdev(intf);
1131 unsigned long dev_flags;
1133 if (!uas_use_uas_driver(intf, id, &dev_flags))
1136 if (uas_switch_interface(udev, intf))
1139 shost = scsi_host_alloc(&uas_host_template,
1140 sizeof(struct uas_dev_info));
1144 shost->max_cmd_len = 16 + 252;
1146 shost->max_lun = 256;
1147 shost->max_channel = 0;
1148 shost->sg_tablesize = udev->bus->sg_tablesize;
1150 devinfo = (struct uas_dev_info *)shost->hostdata;
1151 devinfo->intf = intf;
1152 devinfo->udev = udev;
1153 devinfo->resetting = 0;
1154 devinfo->running_task = 0;
1155 devinfo->shutdown = 0;
1156 devinfo->flags = dev_flags;
1157 init_usb_anchor(&devinfo->cmd_urbs);
1158 init_usb_anchor(&devinfo->sense_urbs);
1159 init_usb_anchor(&devinfo->data_urbs);
1160 spin_lock_init(&devinfo->lock);
1161 INIT_WORK(&devinfo->work, uas_do_work);
1162 INIT_LIST_HEAD(&devinfo->inflight_list);
1163 INIT_LIST_HEAD(&devinfo->dead_list);
1165 result = uas_configure_endpoints(devinfo);
1169 result = scsi_init_shared_tag_map(shost, devinfo->qdepth - 2);
1173 usb_set_intfdata(intf, shost);
1174 result = scsi_add_host(shost, &intf->dev);
1178 scsi_scan_host(shost);
1182 uas_free_streams(devinfo);
1183 usb_set_intfdata(intf, NULL);
1185 usb_set_interface(udev, intf->altsetting[0].desc.bInterfaceNumber, 0);
1187 scsi_host_put(shost);
1191 static int uas_pre_reset(struct usb_interface *intf)
1193 struct Scsi_Host *shost = usb_get_intfdata(intf);
1194 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1195 unsigned long flags;
1197 if (devinfo->shutdown)
1200 /* Block new requests */
1201 spin_lock_irqsave(shost->host_lock, flags);
1202 scsi_block_requests(shost);
1203 spin_unlock_irqrestore(shost->host_lock, flags);
1205 /* Wait for any pending requests to complete */
1206 flush_work(&devinfo->work);
1207 if (usb_wait_anchor_empty_timeout(&devinfo->sense_urbs, 5000) == 0) {
1208 shost_printk(KERN_ERR, shost, "%s: timed out\n", __func__);
1212 uas_free_streams(devinfo);
1217 static int uas_post_reset(struct usb_interface *intf)
1219 struct Scsi_Host *shost = usb_get_intfdata(intf);
1220 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1221 unsigned long flags;
1224 if (devinfo->shutdown)
1227 err = uas_configure_endpoints(devinfo);
1228 if (err && err != -ENODEV)
1229 shost_printk(KERN_ERR, shost,
1230 "%s: alloc streams error %d after reset",
1233 /* we must unblock the host in every case lest we deadlock */
1234 spin_lock_irqsave(shost->host_lock, flags);
1235 scsi_report_bus_reset(shost, 0);
1236 spin_unlock_irqrestore(shost->host_lock, flags);
1238 scsi_unblock_requests(shost);
1243 static int uas_suspend(struct usb_interface *intf, pm_message_t message)
1245 struct Scsi_Host *shost = usb_get_intfdata(intf);
1246 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1248 /* Wait for any pending requests to complete */
1249 flush_work(&devinfo->work);
1250 if (usb_wait_anchor_empty_timeout(&devinfo->sense_urbs, 5000) == 0) {
1251 shost_printk(KERN_ERR, shost, "%s: timed out\n", __func__);
1258 static int uas_resume(struct usb_interface *intf)
1263 static int uas_reset_resume(struct usb_interface *intf)
1265 struct Scsi_Host *shost = usb_get_intfdata(intf);
1266 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1267 unsigned long flags;
1270 err = uas_configure_endpoints(devinfo);
1272 shost_printk(KERN_ERR, shost,
1273 "%s: alloc streams error %d after reset",
1278 spin_lock_irqsave(shost->host_lock, flags);
1279 scsi_report_bus_reset(shost, 0);
1280 spin_unlock_irqrestore(shost->host_lock, flags);
1285 static void uas_disconnect(struct usb_interface *intf)
1287 struct Scsi_Host *shost = usb_get_intfdata(intf);
1288 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1290 devinfo->resetting = 1;
1291 cancel_work_sync(&devinfo->work);
1292 uas_abort_inflight(devinfo, DID_NO_CONNECT, __func__);
1293 usb_kill_anchored_urbs(&devinfo->cmd_urbs);
1294 usb_kill_anchored_urbs(&devinfo->sense_urbs);
1295 usb_kill_anchored_urbs(&devinfo->data_urbs);
1296 uas_zap_dead(devinfo);
1297 scsi_remove_host(shost);
1298 uas_free_streams(devinfo);
1299 scsi_host_put(shost);
1303 * Put the device back in usb-storage mode on shutdown, as some BIOS-es
1304 * hang on reboot when the device is still in uas mode. Note the reset is
1305 * necessary as some devices won't revert to usb-storage mode without it.
1307 static void uas_shutdown(struct device *dev)
1309 struct usb_interface *intf = to_usb_interface(dev);
1310 struct usb_device *udev = interface_to_usbdev(intf);
1311 struct Scsi_Host *shost = usb_get_intfdata(intf);
1312 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1314 if (system_state != SYSTEM_RESTART)
1317 devinfo->shutdown = 1;
1318 uas_free_streams(devinfo);
1319 usb_set_interface(udev, intf->altsetting[0].desc.bInterfaceNumber, 0);
1320 usb_reset_device(udev);
1323 static struct usb_driver uas_driver = {
1326 .disconnect = uas_disconnect,
1327 .pre_reset = uas_pre_reset,
1328 .post_reset = uas_post_reset,
1329 .suspend = uas_suspend,
1330 .resume = uas_resume,
1331 .reset_resume = uas_reset_resume,
1332 .drvwrap.driver.shutdown = uas_shutdown,
1333 .id_table = uas_usb_ids,
1336 module_usb_driver(uas_driver);
1338 MODULE_LICENSE("GPL");
1340 "Hans de Goede <hdegoede@redhat.com>, Matthew Wilcox and Sarah Sharp");