1 // SPDX-License-Identifier: GPL-2.0
4 * Note that this is not the same as the USB Mass Storage driver
6 * Copyright Hans de Goede <hdegoede@redhat.com> for Red Hat, Inc. 2013 - 2016
7 * Copyright Matthew Wilcox for Intel Corp, 2010
8 * Copyright Sarah Sharp for Intel Corp, 2010
11 #include <linux/blkdev.h>
12 #include <linux/slab.h>
13 #include <linux/types.h>
14 #include <linux/module.h>
15 #include <linux/usb.h>
16 #include <linux/usb_usual.h>
17 #include <linux/usb/hcd.h>
18 #include <linux/usb/storage.h>
19 #include <linux/usb/uas.h>
21 #include <scsi/scsi.h>
22 #include <scsi/scsi_eh.h>
23 #include <scsi/scsi_dbg.h>
24 #include <scsi/scsi_cmnd.h>
25 #include <scsi/scsi_device.h>
26 #include <scsi/scsi_host.h>
27 #include <scsi/scsi_tcq.h>
29 #include "uas-detect.h"
35 struct usb_interface
*intf
;
36 struct usb_device
*udev
;
37 struct usb_anchor cmd_urbs
;
38 struct usb_anchor sense_urbs
;
39 struct usb_anchor data_urbs
;
41 int qdepth
, resetting
;
42 unsigned cmd_pipe
, status_pipe
, data_in_pipe
, data_out_pipe
;
43 unsigned use_streams
:1;
45 struct scsi_cmnd
*cmnd
[MAX_CMNDS
];
47 struct work_struct work
;
48 struct work_struct scan_work
; /* for async scanning */
52 SUBMIT_STATUS_URB
= BIT(1),
53 ALLOC_DATA_IN_URB
= BIT(2),
54 SUBMIT_DATA_IN_URB
= BIT(3),
55 ALLOC_DATA_OUT_URB
= BIT(4),
56 SUBMIT_DATA_OUT_URB
= BIT(5),
57 ALLOC_CMD_URB
= BIT(6),
58 SUBMIT_CMD_URB
= BIT(7),
59 COMMAND_INFLIGHT
= BIT(8),
60 DATA_IN_URB_INFLIGHT
= BIT(9),
61 DATA_OUT_URB_INFLIGHT
= BIT(10),
62 COMMAND_ABORTED
= BIT(11),
63 IS_IN_WORK_LIST
= BIT(12),
66 /* Overrides scsi_pointer */
71 struct urb
*data_in_urb
;
72 struct urb
*data_out_urb
;
75 /* I hate forward declarations, but I actually have a loop */
76 static int uas_submit_urbs(struct scsi_cmnd
*cmnd
,
77 struct uas_dev_info
*devinfo
);
78 static void uas_do_work(struct work_struct
*work
);
79 static int uas_try_complete(struct scsi_cmnd
*cmnd
, const char *caller
);
80 static void uas_free_streams(struct uas_dev_info
*devinfo
);
81 static void uas_log_cmd_state(struct scsi_cmnd
*cmnd
, const char *prefix
,
85 * This driver needs its own workqueue, as we need to control memory allocation.
87 * In the course of error handling and power management uas_wait_for_pending_cmnds()
88 * needs to flush pending work items. In these contexts we cannot allocate memory
89 * by doing block IO as we would deadlock. For the same reason we cannot wait
90 * for anything allocating memory not heeding these constraints.
92 * So we have to control all work items that can be on the workqueue we flush.
93 * Hence we cannot share a queue and need our own.
95 static struct workqueue_struct
*workqueue
;
97 static void uas_do_work(struct work_struct
*work
)
99 struct uas_dev_info
*devinfo
=
100 container_of(work
, struct uas_dev_info
, work
);
101 struct uas_cmd_info
*cmdinfo
;
102 struct scsi_cmnd
*cmnd
;
106 spin_lock_irqsave(&devinfo
->lock
, flags
);
108 if (devinfo
->resetting
)
111 for (i
= 0; i
< devinfo
->qdepth
; i
++) {
112 if (!devinfo
->cmnd
[i
])
115 cmnd
= devinfo
->cmnd
[i
];
116 cmdinfo
= (void *)&cmnd
->SCp
;
118 if (!(cmdinfo
->state
& IS_IN_WORK_LIST
))
121 err
= uas_submit_urbs(cmnd
, cmnd
->device
->hostdata
);
123 cmdinfo
->state
&= ~IS_IN_WORK_LIST
;
125 queue_work(workqueue
, &devinfo
->work
);
128 spin_unlock_irqrestore(&devinfo
->lock
, flags
);
131 static void uas_scan_work(struct work_struct
*work
)
133 struct uas_dev_info
*devinfo
=
134 container_of(work
, struct uas_dev_info
, scan_work
);
135 struct Scsi_Host
*shost
= usb_get_intfdata(devinfo
->intf
);
137 dev_dbg(&devinfo
->intf
->dev
, "starting scan\n");
138 scsi_scan_host(shost
);
139 dev_dbg(&devinfo
->intf
->dev
, "scan complete\n");
142 static void uas_add_work(struct uas_cmd_info
*cmdinfo
)
144 struct scsi_pointer
*scp
= (void *)cmdinfo
;
145 struct scsi_cmnd
*cmnd
= container_of(scp
, struct scsi_cmnd
, SCp
);
146 struct uas_dev_info
*devinfo
= cmnd
->device
->hostdata
;
148 lockdep_assert_held(&devinfo
->lock
);
149 cmdinfo
->state
|= IS_IN_WORK_LIST
;
150 queue_work(workqueue
, &devinfo
->work
);
153 static void uas_zap_pending(struct uas_dev_info
*devinfo
, int result
)
155 struct uas_cmd_info
*cmdinfo
;
156 struct scsi_cmnd
*cmnd
;
160 spin_lock_irqsave(&devinfo
->lock
, flags
);
161 for (i
= 0; i
< devinfo
->qdepth
; i
++) {
162 if (!devinfo
->cmnd
[i
])
165 cmnd
= devinfo
->cmnd
[i
];
166 cmdinfo
= (void *)&cmnd
->SCp
;
167 uas_log_cmd_state(cmnd
, __func__
, 0);
168 /* Sense urbs were killed, clear COMMAND_INFLIGHT manually */
169 cmdinfo
->state
&= ~COMMAND_INFLIGHT
;
170 cmnd
->result
= result
<< 16;
171 err
= uas_try_complete(cmnd
, __func__
);
174 spin_unlock_irqrestore(&devinfo
->lock
, flags
);
177 static void uas_sense(struct urb
*urb
, struct scsi_cmnd
*cmnd
)
179 struct sense_iu
*sense_iu
= urb
->transfer_buffer
;
180 struct scsi_device
*sdev
= cmnd
->device
;
182 if (urb
->actual_length
> 16) {
183 unsigned len
= be16_to_cpup(&sense_iu
->len
);
184 if (len
+ 16 != urb
->actual_length
) {
185 int newlen
= min(len
+ 16, urb
->actual_length
) - 16;
188 sdev_printk(KERN_INFO
, sdev
, "%s: urb length %d "
189 "disagrees with IU sense data length %d, "
190 "using %d bytes of sense data\n", __func__
,
191 urb
->actual_length
, len
, newlen
);
194 memcpy(cmnd
->sense_buffer
, sense_iu
->sense
, len
);
197 cmnd
->result
= sense_iu
->status
;
200 static void uas_log_cmd_state(struct scsi_cmnd
*cmnd
, const char *prefix
,
203 struct uas_cmd_info
*ci
= (void *)&cmnd
->SCp
;
204 struct uas_cmd_info
*cmdinfo
= (void *)&cmnd
->SCp
;
206 if (status
== -ENODEV
) /* too late */
209 scmd_printk(KERN_INFO
, cmnd
,
210 "%s %d uas-tag %d inflight:%s%s%s%s%s%s%s%s%s%s%s%s ",
211 prefix
, status
, cmdinfo
->uas_tag
,
212 (ci
->state
& SUBMIT_STATUS_URB
) ? " s-st" : "",
213 (ci
->state
& ALLOC_DATA_IN_URB
) ? " a-in" : "",
214 (ci
->state
& SUBMIT_DATA_IN_URB
) ? " s-in" : "",
215 (ci
->state
& ALLOC_DATA_OUT_URB
) ? " a-out" : "",
216 (ci
->state
& SUBMIT_DATA_OUT_URB
) ? " s-out" : "",
217 (ci
->state
& ALLOC_CMD_URB
) ? " a-cmd" : "",
218 (ci
->state
& SUBMIT_CMD_URB
) ? " s-cmd" : "",
219 (ci
->state
& COMMAND_INFLIGHT
) ? " CMD" : "",
220 (ci
->state
& DATA_IN_URB_INFLIGHT
) ? " IN" : "",
221 (ci
->state
& DATA_OUT_URB_INFLIGHT
) ? " OUT" : "",
222 (ci
->state
& COMMAND_ABORTED
) ? " abort" : "",
223 (ci
->state
& IS_IN_WORK_LIST
) ? " work" : "");
224 scsi_print_command(cmnd
);
227 static void uas_free_unsubmitted_urbs(struct scsi_cmnd
*cmnd
)
229 struct uas_cmd_info
*cmdinfo
;
234 cmdinfo
= (void *)&cmnd
->SCp
;
236 if (cmdinfo
->state
& SUBMIT_CMD_URB
)
237 usb_free_urb(cmdinfo
->cmd_urb
);
239 /* data urbs may have never gotten their submit flag set */
240 if (!(cmdinfo
->state
& DATA_IN_URB_INFLIGHT
))
241 usb_free_urb(cmdinfo
->data_in_urb
);
242 if (!(cmdinfo
->state
& DATA_OUT_URB_INFLIGHT
))
243 usb_free_urb(cmdinfo
->data_out_urb
);
246 static int uas_try_complete(struct scsi_cmnd
*cmnd
, const char *caller
)
248 struct uas_cmd_info
*cmdinfo
= (void *)&cmnd
->SCp
;
249 struct uas_dev_info
*devinfo
= (void *)cmnd
->device
->hostdata
;
251 lockdep_assert_held(&devinfo
->lock
);
252 if (cmdinfo
->state
& (COMMAND_INFLIGHT
|
253 DATA_IN_URB_INFLIGHT
|
254 DATA_OUT_URB_INFLIGHT
|
257 devinfo
->cmnd
[cmdinfo
->uas_tag
- 1] = NULL
;
258 uas_free_unsubmitted_urbs(cmnd
);
259 cmnd
->scsi_done(cmnd
);
263 static void uas_xfer_data(struct urb
*urb
, struct scsi_cmnd
*cmnd
,
266 struct uas_cmd_info
*cmdinfo
= (void *)&cmnd
->SCp
;
269 cmdinfo
->state
|= direction
| SUBMIT_STATUS_URB
;
270 err
= uas_submit_urbs(cmnd
, cmnd
->device
->hostdata
);
272 uas_add_work(cmdinfo
);
276 static bool uas_evaluate_response_iu(struct response_iu
*riu
, struct scsi_cmnd
*cmnd
)
278 u8 response_code
= riu
->response_code
;
280 switch (response_code
) {
281 case RC_INCORRECT_LUN
:
282 cmnd
->result
= DID_BAD_TARGET
<< 16;
284 case RC_TMF_SUCCEEDED
:
285 cmnd
->result
= DID_OK
<< 16;
287 case RC_TMF_NOT_SUPPORTED
:
288 cmnd
->result
= DID_TARGET_FAILURE
<< 16;
291 uas_log_cmd_state(cmnd
, "response iu", response_code
);
292 cmnd
->result
= DID_ERROR
<< 16;
296 return response_code
== RC_TMF_SUCCEEDED
;
299 static void uas_stat_cmplt(struct urb
*urb
)
301 struct iu
*iu
= urb
->transfer_buffer
;
302 struct Scsi_Host
*shost
= urb
->context
;
303 struct uas_dev_info
*devinfo
= (struct uas_dev_info
*)shost
->hostdata
;
304 struct urb
*data_in_urb
= NULL
;
305 struct urb
*data_out_urb
= NULL
;
306 struct scsi_cmnd
*cmnd
;
307 struct uas_cmd_info
*cmdinfo
;
310 int status
= urb
->status
;
313 spin_lock_irqsave(&devinfo
->lock
, flags
);
315 if (devinfo
->resetting
)
319 if (status
!= -ENOENT
&& status
!= -ECONNRESET
&& status
!= -ESHUTDOWN
)
320 dev_err(&urb
->dev
->dev
, "stat urb: status %d\n", status
);
324 idx
= be16_to_cpup(&iu
->tag
) - 1;
325 if (idx
>= MAX_CMNDS
|| !devinfo
->cmnd
[idx
]) {
326 dev_err(&urb
->dev
->dev
,
327 "stat urb: no pending cmd for uas-tag %d\n", idx
+ 1);
331 cmnd
= devinfo
->cmnd
[idx
];
332 cmdinfo
= (void *)&cmnd
->SCp
;
334 if (!(cmdinfo
->state
& COMMAND_INFLIGHT
)) {
335 uas_log_cmd_state(cmnd
, "unexpected status cmplt", 0);
341 uas_sense(urb
, cmnd
);
342 if (cmnd
->result
!= 0) {
343 /* cancel data transfers on error */
344 data_in_urb
= usb_get_urb(cmdinfo
->data_in_urb
);
345 data_out_urb
= usb_get_urb(cmdinfo
->data_out_urb
);
347 cmdinfo
->state
&= ~COMMAND_INFLIGHT
;
348 uas_try_complete(cmnd
, __func__
);
350 case IU_ID_READ_READY
:
351 if (!cmdinfo
->data_in_urb
||
352 (cmdinfo
->state
& DATA_IN_URB_INFLIGHT
)) {
353 uas_log_cmd_state(cmnd
, "unexpected read rdy", 0);
356 uas_xfer_data(urb
, cmnd
, SUBMIT_DATA_IN_URB
);
358 case IU_ID_WRITE_READY
:
359 if (!cmdinfo
->data_out_urb
||
360 (cmdinfo
->state
& DATA_OUT_URB_INFLIGHT
)) {
361 uas_log_cmd_state(cmnd
, "unexpected write rdy", 0);
364 uas_xfer_data(urb
, cmnd
, SUBMIT_DATA_OUT_URB
);
367 cmdinfo
->state
&= ~COMMAND_INFLIGHT
;
368 success
= uas_evaluate_response_iu((struct response_iu
*)iu
, cmnd
);
370 /* Error, cancel data transfers */
371 data_in_urb
= usb_get_urb(cmdinfo
->data_in_urb
);
372 data_out_urb
= usb_get_urb(cmdinfo
->data_out_urb
);
374 uas_try_complete(cmnd
, __func__
);
377 uas_log_cmd_state(cmnd
, "bogus IU", iu
->iu_id
);
381 spin_unlock_irqrestore(&devinfo
->lock
, flags
);
383 /* Unlinking of data urbs must be done without holding the lock */
385 usb_unlink_urb(data_in_urb
);
386 usb_put_urb(data_in_urb
);
389 usb_unlink_urb(data_out_urb
);
390 usb_put_urb(data_out_urb
);
394 static void uas_data_cmplt(struct urb
*urb
)
396 struct scsi_cmnd
*cmnd
= urb
->context
;
397 struct uas_cmd_info
*cmdinfo
= (void *)&cmnd
->SCp
;
398 struct uas_dev_info
*devinfo
= (void *)cmnd
->device
->hostdata
;
399 struct scsi_data_buffer
*sdb
= &cmnd
->sdb
;
401 int status
= urb
->status
;
403 spin_lock_irqsave(&devinfo
->lock
, flags
);
405 if (cmdinfo
->data_in_urb
== urb
) {
406 cmdinfo
->state
&= ~DATA_IN_URB_INFLIGHT
;
407 cmdinfo
->data_in_urb
= NULL
;
408 } else if (cmdinfo
->data_out_urb
== urb
) {
409 cmdinfo
->state
&= ~DATA_OUT_URB_INFLIGHT
;
410 cmdinfo
->data_out_urb
= NULL
;
413 if (devinfo
->resetting
)
416 /* Data urbs should not complete before the cmd urb is submitted */
417 if (cmdinfo
->state
& SUBMIT_CMD_URB
) {
418 uas_log_cmd_state(cmnd
, "unexpected data cmplt", 0);
423 if (status
!= -ENOENT
&& status
!= -ECONNRESET
&& status
!= -ESHUTDOWN
)
424 uas_log_cmd_state(cmnd
, "data cmplt err", status
);
425 /* error: no data transfered */
426 scsi_set_resid(cmnd
, sdb
->length
);
428 scsi_set_resid(cmnd
, sdb
->length
- urb
->actual_length
);
430 uas_try_complete(cmnd
, __func__
);
433 spin_unlock_irqrestore(&devinfo
->lock
, flags
);
436 static void uas_cmd_cmplt(struct urb
*urb
)
439 dev_err(&urb
->dev
->dev
, "cmd cmplt err %d\n", urb
->status
);
444 static struct urb
*uas_alloc_data_urb(struct uas_dev_info
*devinfo
, gfp_t gfp
,
445 struct scsi_cmnd
*cmnd
,
446 enum dma_data_direction dir
)
448 struct usb_device
*udev
= devinfo
->udev
;
449 struct uas_cmd_info
*cmdinfo
= (void *)&cmnd
->SCp
;
450 struct urb
*urb
= usb_alloc_urb(0, gfp
);
451 struct scsi_data_buffer
*sdb
= &cmnd
->sdb
;
452 unsigned int pipe
= (dir
== DMA_FROM_DEVICE
)
453 ? devinfo
->data_in_pipe
: devinfo
->data_out_pipe
;
457 usb_fill_bulk_urb(urb
, udev
, pipe
, NULL
, sdb
->length
,
458 uas_data_cmplt
, cmnd
);
459 if (devinfo
->use_streams
)
460 urb
->stream_id
= cmdinfo
->uas_tag
;
461 urb
->num_sgs
= udev
->bus
->sg_tablesize
? sdb
->table
.nents
: 0;
462 urb
->sg
= sdb
->table
.sgl
;
467 static struct urb
*uas_alloc_sense_urb(struct uas_dev_info
*devinfo
, gfp_t gfp
,
468 struct scsi_cmnd
*cmnd
)
470 struct usb_device
*udev
= devinfo
->udev
;
471 struct uas_cmd_info
*cmdinfo
= (void *)&cmnd
->SCp
;
472 struct urb
*urb
= usb_alloc_urb(0, gfp
);
478 iu
= kzalloc(sizeof(*iu
), gfp
);
482 usb_fill_bulk_urb(urb
, udev
, devinfo
->status_pipe
, iu
, sizeof(*iu
),
483 uas_stat_cmplt
, cmnd
->device
->host
);
484 if (devinfo
->use_streams
)
485 urb
->stream_id
= cmdinfo
->uas_tag
;
486 urb
->transfer_flags
|= URB_FREE_BUFFER
;
494 static struct urb
*uas_alloc_cmd_urb(struct uas_dev_info
*devinfo
, gfp_t gfp
,
495 struct scsi_cmnd
*cmnd
)
497 struct usb_device
*udev
= devinfo
->udev
;
498 struct scsi_device
*sdev
= cmnd
->device
;
499 struct uas_cmd_info
*cmdinfo
= (void *)&cmnd
->SCp
;
500 struct urb
*urb
= usb_alloc_urb(0, gfp
);
501 struct command_iu
*iu
;
507 len
= cmnd
->cmd_len
- 16;
511 iu
= kzalloc(sizeof(*iu
) + len
, gfp
);
515 iu
->iu_id
= IU_ID_COMMAND
;
516 iu
->tag
= cpu_to_be16(cmdinfo
->uas_tag
);
517 iu
->prio_attr
= UAS_SIMPLE_TAG
;
519 int_to_scsilun(sdev
->lun
, &iu
->lun
);
520 memcpy(iu
->cdb
, cmnd
->cmnd
, cmnd
->cmd_len
);
522 usb_fill_bulk_urb(urb
, udev
, devinfo
->cmd_pipe
, iu
, sizeof(*iu
) + len
,
523 uas_cmd_cmplt
, NULL
);
524 urb
->transfer_flags
|= URB_FREE_BUFFER
;
533 * Why should I request the Status IU before sending the Command IU? Spec
534 * says to, but also says the device may receive them in any order. Seems
538 static struct urb
*uas_submit_sense_urb(struct scsi_cmnd
*cmnd
, gfp_t gfp
)
540 struct uas_dev_info
*devinfo
= cmnd
->device
->hostdata
;
544 urb
= uas_alloc_sense_urb(devinfo
, gfp
, cmnd
);
547 usb_anchor_urb(urb
, &devinfo
->sense_urbs
);
548 err
= usb_submit_urb(urb
, gfp
);
550 usb_unanchor_urb(urb
);
551 uas_log_cmd_state(cmnd
, "sense submit err", err
);
558 static int uas_submit_urbs(struct scsi_cmnd
*cmnd
,
559 struct uas_dev_info
*devinfo
)
561 struct uas_cmd_info
*cmdinfo
= (void *)&cmnd
->SCp
;
565 lockdep_assert_held(&devinfo
->lock
);
566 if (cmdinfo
->state
& SUBMIT_STATUS_URB
) {
567 urb
= uas_submit_sense_urb(cmnd
, GFP_ATOMIC
);
569 return SCSI_MLQUEUE_DEVICE_BUSY
;
570 cmdinfo
->state
&= ~SUBMIT_STATUS_URB
;
573 if (cmdinfo
->state
& ALLOC_DATA_IN_URB
) {
574 cmdinfo
->data_in_urb
= uas_alloc_data_urb(devinfo
, GFP_ATOMIC
,
575 cmnd
, DMA_FROM_DEVICE
);
576 if (!cmdinfo
->data_in_urb
)
577 return SCSI_MLQUEUE_DEVICE_BUSY
;
578 cmdinfo
->state
&= ~ALLOC_DATA_IN_URB
;
581 if (cmdinfo
->state
& SUBMIT_DATA_IN_URB
) {
582 usb_anchor_urb(cmdinfo
->data_in_urb
, &devinfo
->data_urbs
);
583 err
= usb_submit_urb(cmdinfo
->data_in_urb
, GFP_ATOMIC
);
585 usb_unanchor_urb(cmdinfo
->data_in_urb
);
586 uas_log_cmd_state(cmnd
, "data in submit err", err
);
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_ATOMIC
,
595 cmnd
, DMA_TO_DEVICE
);
596 if (!cmdinfo
->data_out_urb
)
597 return SCSI_MLQUEUE_DEVICE_BUSY
;
598 cmdinfo
->state
&= ~ALLOC_DATA_OUT_URB
;
601 if (cmdinfo
->state
& SUBMIT_DATA_OUT_URB
) {
602 usb_anchor_urb(cmdinfo
->data_out_urb
, &devinfo
->data_urbs
);
603 err
= usb_submit_urb(cmdinfo
->data_out_urb
, GFP_ATOMIC
);
605 usb_unanchor_urb(cmdinfo
->data_out_urb
);
606 uas_log_cmd_state(cmnd
, "data out submit err", err
);
607 return SCSI_MLQUEUE_DEVICE_BUSY
;
609 cmdinfo
->state
&= ~SUBMIT_DATA_OUT_URB
;
610 cmdinfo
->state
|= DATA_OUT_URB_INFLIGHT
;
613 if (cmdinfo
->state
& ALLOC_CMD_URB
) {
614 cmdinfo
->cmd_urb
= uas_alloc_cmd_urb(devinfo
, GFP_ATOMIC
, cmnd
);
615 if (!cmdinfo
->cmd_urb
)
616 return SCSI_MLQUEUE_DEVICE_BUSY
;
617 cmdinfo
->state
&= ~ALLOC_CMD_URB
;
620 if (cmdinfo
->state
& SUBMIT_CMD_URB
) {
621 usb_anchor_urb(cmdinfo
->cmd_urb
, &devinfo
->cmd_urbs
);
622 err
= usb_submit_urb(cmdinfo
->cmd_urb
, GFP_ATOMIC
);
624 usb_unanchor_urb(cmdinfo
->cmd_urb
);
625 uas_log_cmd_state(cmnd
, "cmd submit err", err
);
626 return SCSI_MLQUEUE_DEVICE_BUSY
;
628 cmdinfo
->cmd_urb
= NULL
;
629 cmdinfo
->state
&= ~SUBMIT_CMD_URB
;
630 cmdinfo
->state
|= COMMAND_INFLIGHT
;
636 static int uas_queuecommand_lck(struct scsi_cmnd
*cmnd
,
637 void (*done
)(struct scsi_cmnd
*))
639 struct scsi_device
*sdev
= cmnd
->device
;
640 struct uas_dev_info
*devinfo
= sdev
->hostdata
;
641 struct uas_cmd_info
*cmdinfo
= (void *)&cmnd
->SCp
;
645 BUILD_BUG_ON(sizeof(struct uas_cmd_info
) > sizeof(struct scsi_pointer
));
647 /* Re-check scsi_block_requests now that we've the host-lock */
648 if (cmnd
->device
->host
->host_self_blocked
)
649 return SCSI_MLQUEUE_DEVICE_BUSY
;
651 if ((devinfo
->flags
& US_FL_NO_ATA_1X
) &&
652 (cmnd
->cmnd
[0] == ATA_12
|| cmnd
->cmnd
[0] == ATA_16
)) {
653 memcpy(cmnd
->sense_buffer
, usb_stor_sense_invalidCDB
,
654 sizeof(usb_stor_sense_invalidCDB
));
655 cmnd
->result
= SAM_STAT_CHECK_CONDITION
;
656 cmnd
->scsi_done(cmnd
);
660 spin_lock_irqsave(&devinfo
->lock
, flags
);
662 if (devinfo
->resetting
) {
663 cmnd
->result
= DID_ERROR
<< 16;
664 cmnd
->scsi_done(cmnd
);
668 /* Find a free uas-tag */
669 for (idx
= 0; idx
< devinfo
->qdepth
; idx
++) {
670 if (!devinfo
->cmnd
[idx
])
673 if (idx
== devinfo
->qdepth
) {
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
->uas_tag
= idx
+ 1; /* uas-tag == usb-stream-id, so 1 based */
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
;
692 cmdinfo
->state
|= ALLOC_DATA_OUT_URB
| SUBMIT_DATA_OUT_URB
;
697 if (!devinfo
->use_streams
)
698 cmdinfo
->state
&= ~(SUBMIT_DATA_IN_URB
| SUBMIT_DATA_OUT_URB
);
700 err
= uas_submit_urbs(cmnd
, devinfo
);
702 * in case of fatal errors the SCSI layer is peculiar
703 * a command that has finished is a success for the purpose
704 * of queueing, no matter how fatal the error
706 if (err
== -ENODEV
) {
707 cmnd
->result
= DID_ERROR
<< 16;
708 cmnd
->scsi_done(cmnd
);
712 /* If we did nothing, give up now */
713 if (cmdinfo
->state
& SUBMIT_STATUS_URB
) {
714 spin_unlock_irqrestore(&devinfo
->lock
, flags
);
715 return SCSI_MLQUEUE_DEVICE_BUSY
;
717 uas_add_work(cmdinfo
);
720 devinfo
->cmnd
[idx
] = cmnd
;
722 spin_unlock_irqrestore(&devinfo
->lock
, flags
);
726 static DEF_SCSI_QCMD(uas_queuecommand
)
729 * For now we do not support actually sending an abort to the device, so
730 * this eh always fails. Still we must define it to make sure that we've
731 * dropped all references to the cmnd in question once this function exits.
733 static int uas_eh_abort_handler(struct scsi_cmnd
*cmnd
)
735 struct uas_cmd_info
*cmdinfo
= (void *)&cmnd
->SCp
;
736 struct uas_dev_info
*devinfo
= (void *)cmnd
->device
->hostdata
;
737 struct urb
*data_in_urb
= NULL
;
738 struct urb
*data_out_urb
= NULL
;
741 spin_lock_irqsave(&devinfo
->lock
, flags
);
743 uas_log_cmd_state(cmnd
, __func__
, 0);
745 /* Ensure that try_complete does not call scsi_done */
746 cmdinfo
->state
|= COMMAND_ABORTED
;
748 /* Drop all refs to this cmnd, kill data urbs to break their ref */
749 devinfo
->cmnd
[cmdinfo
->uas_tag
- 1] = NULL
;
750 if (cmdinfo
->state
& DATA_IN_URB_INFLIGHT
)
751 data_in_urb
= usb_get_urb(cmdinfo
->data_in_urb
);
752 if (cmdinfo
->state
& DATA_OUT_URB_INFLIGHT
)
753 data_out_urb
= usb_get_urb(cmdinfo
->data_out_urb
);
755 uas_free_unsubmitted_urbs(cmnd
);
757 spin_unlock_irqrestore(&devinfo
->lock
, flags
);
760 usb_kill_urb(data_in_urb
);
761 usb_put_urb(data_in_urb
);
764 usb_kill_urb(data_out_urb
);
765 usb_put_urb(data_out_urb
);
771 static int uas_eh_device_reset_handler(struct scsi_cmnd
*cmnd
)
773 struct scsi_device
*sdev
= cmnd
->device
;
774 struct uas_dev_info
*devinfo
= sdev
->hostdata
;
775 struct usb_device
*udev
= devinfo
->udev
;
779 err
= usb_lock_device_for_reset(udev
, devinfo
->intf
);
781 shost_printk(KERN_ERR
, sdev
->host
,
782 "%s FAILED to get lock err %d\n", __func__
, err
);
786 shost_printk(KERN_INFO
, sdev
->host
, "%s start\n", __func__
);
788 spin_lock_irqsave(&devinfo
->lock
, flags
);
789 devinfo
->resetting
= 1;
790 spin_unlock_irqrestore(&devinfo
->lock
, flags
);
792 usb_kill_anchored_urbs(&devinfo
->cmd_urbs
);
793 usb_kill_anchored_urbs(&devinfo
->sense_urbs
);
794 usb_kill_anchored_urbs(&devinfo
->data_urbs
);
795 uas_zap_pending(devinfo
, DID_RESET
);
797 err
= usb_reset_device(udev
);
799 spin_lock_irqsave(&devinfo
->lock
, flags
);
800 devinfo
->resetting
= 0;
801 spin_unlock_irqrestore(&devinfo
->lock
, flags
);
803 usb_unlock_device(udev
);
806 shost_printk(KERN_INFO
, sdev
->host
, "%s FAILED err %d\n",
811 shost_printk(KERN_INFO
, sdev
->host
, "%s success\n", __func__
);
815 static int uas_target_alloc(struct scsi_target
*starget
)
817 struct uas_dev_info
*devinfo
= (struct uas_dev_info
*)
818 dev_to_shost(starget
->dev
.parent
)->hostdata
;
820 if (devinfo
->flags
& US_FL_NO_REPORT_LUNS
)
821 starget
->no_report_luns
= 1;
826 static int uas_slave_alloc(struct scsi_device
*sdev
)
828 struct uas_dev_info
*devinfo
=
829 (struct uas_dev_info
*)sdev
->host
->hostdata
;
831 sdev
->hostdata
= devinfo
;
834 * The protocol has no requirements on alignment in the strict sense.
835 * Controllers may or may not have alignment restrictions.
836 * As this is not exported, we use an extremely conservative guess.
838 blk_queue_update_dma_alignment(sdev
->request_queue
, (512 - 1));
840 if (devinfo
->flags
& US_FL_MAX_SECTORS_64
)
841 blk_queue_max_hw_sectors(sdev
->request_queue
, 64);
842 else if (devinfo
->flags
& US_FL_MAX_SECTORS_240
)
843 blk_queue_max_hw_sectors(sdev
->request_queue
, 240);
848 static int uas_slave_configure(struct scsi_device
*sdev
)
850 struct uas_dev_info
*devinfo
= sdev
->hostdata
;
852 if (devinfo
->flags
& US_FL_NO_REPORT_OPCODES
)
853 sdev
->no_report_opcodes
= 1;
855 /* A few buggy USB-ATA bridges don't understand FUA */
856 if (devinfo
->flags
& US_FL_BROKEN_FUA
)
857 sdev
->broken_fua
= 1;
859 /* UAS also needs to support FL_ALWAYS_SYNC */
860 if (devinfo
->flags
& US_FL_ALWAYS_SYNC
) {
861 sdev
->skip_ms_page_3f
= 1;
862 sdev
->skip_ms_page_8
= 1;
863 sdev
->wce_default_on
= 1;
866 /* Some disks cannot handle READ_CAPACITY_16 */
867 if (devinfo
->flags
& US_FL_NO_READ_CAPACITY_16
)
868 sdev
->no_read_capacity_16
= 1;
871 * Some disks return the total number of blocks in response
872 * to READ CAPACITY rather than the highest block number.
873 * If this device makes that mistake, tell the sd driver.
875 if (devinfo
->flags
& US_FL_FIX_CAPACITY
)
876 sdev
->fix_capacity
= 1;
879 * in some cases we have to guess
881 if (devinfo
->flags
& US_FL_CAPACITY_HEURISTICS
)
882 sdev
->guess_capacity
= 1;
885 * Some devices don't like MODE SENSE with page=0x3f,
886 * which is the command used for checking if a device
887 * is write-protected. Now that we tell the sd driver
888 * to do a 192-byte transfer with this command the
889 * majority of devices work fine, but a few still can't
890 * handle it. The sd driver will simply assume those
891 * devices are write-enabled.
893 if (devinfo
->flags
& US_FL_NO_WP_DETECT
)
894 sdev
->skip_ms_page_3f
= 1;
896 scsi_change_queue_depth(sdev
, devinfo
->qdepth
- 2);
900 static struct scsi_host_template uas_host_template
= {
901 .module
= THIS_MODULE
,
903 .queuecommand
= uas_queuecommand
,
904 .target_alloc
= uas_target_alloc
,
905 .slave_alloc
= uas_slave_alloc
,
906 .slave_configure
= uas_slave_configure
,
907 .eh_abort_handler
= uas_eh_abort_handler
,
908 .eh_device_reset_handler
= uas_eh_device_reset_handler
,
910 .sg_tablesize
= SG_NONE
,
911 .skip_settle_delay
= 1,
912 .dma_boundary
= PAGE_SIZE
- 1,
915 #define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \
916 vendorName, productName, useProtocol, useTransport, \
917 initFunction, flags) \
918 { USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax), \
919 .driver_info = (flags) }
921 static struct usb_device_id uas_usb_ids
[] = {
922 # include "unusual_uas.h"
923 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE
, USB_SC_SCSI
, USB_PR_BULK
) },
924 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE
, USB_SC_SCSI
, USB_PR_UAS
) },
927 MODULE_DEVICE_TABLE(usb
, uas_usb_ids
);
931 static int uas_switch_interface(struct usb_device
*udev
,
932 struct usb_interface
*intf
)
934 struct usb_host_interface
*alt
;
936 alt
= uas_find_uas_alt_setting(intf
);
940 return usb_set_interface(udev
, alt
->desc
.bInterfaceNumber
,
941 alt
->desc
.bAlternateSetting
);
944 static int uas_configure_endpoints(struct uas_dev_info
*devinfo
)
946 struct usb_host_endpoint
*eps
[4] = { };
947 struct usb_device
*udev
= devinfo
->udev
;
950 r
= uas_find_endpoints(devinfo
->intf
->cur_altsetting
, eps
);
954 devinfo
->cmd_pipe
= usb_sndbulkpipe(udev
,
955 usb_endpoint_num(&eps
[0]->desc
));
956 devinfo
->status_pipe
= usb_rcvbulkpipe(udev
,
957 usb_endpoint_num(&eps
[1]->desc
));
958 devinfo
->data_in_pipe
= usb_rcvbulkpipe(udev
,
959 usb_endpoint_num(&eps
[2]->desc
));
960 devinfo
->data_out_pipe
= usb_sndbulkpipe(udev
,
961 usb_endpoint_num(&eps
[3]->desc
));
963 if (udev
->speed
< USB_SPEED_SUPER
) {
964 devinfo
->qdepth
= 32;
965 devinfo
->use_streams
= 0;
967 devinfo
->qdepth
= usb_alloc_streams(devinfo
->intf
, eps
+ 1,
968 3, MAX_CMNDS
, GFP_NOIO
);
969 if (devinfo
->qdepth
< 0)
970 return devinfo
->qdepth
;
971 devinfo
->use_streams
= 1;
977 static void uas_free_streams(struct uas_dev_info
*devinfo
)
979 struct usb_device
*udev
= devinfo
->udev
;
980 struct usb_host_endpoint
*eps
[3];
982 eps
[0] = usb_pipe_endpoint(udev
, devinfo
->status_pipe
);
983 eps
[1] = usb_pipe_endpoint(udev
, devinfo
->data_in_pipe
);
984 eps
[2] = usb_pipe_endpoint(udev
, devinfo
->data_out_pipe
);
985 usb_free_streams(devinfo
->intf
, eps
, 3, GFP_NOIO
);
988 static int uas_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
990 int result
= -ENOMEM
;
991 struct Scsi_Host
*shost
= NULL
;
992 struct uas_dev_info
*devinfo
;
993 struct usb_device
*udev
= interface_to_usbdev(intf
);
994 unsigned long dev_flags
;
996 if (!uas_use_uas_driver(intf
, id
, &dev_flags
))
999 if (uas_switch_interface(udev
, intf
))
1002 shost
= scsi_host_alloc(&uas_host_template
,
1003 sizeof(struct uas_dev_info
));
1007 shost
->max_cmd_len
= 16 + 252;
1009 shost
->max_lun
= 256;
1010 shost
->max_channel
= 0;
1011 shost
->sg_tablesize
= udev
->bus
->sg_tablesize
;
1013 devinfo
= (struct uas_dev_info
*)shost
->hostdata
;
1014 devinfo
->intf
= intf
;
1015 devinfo
->udev
= udev
;
1016 devinfo
->resetting
= 0;
1017 devinfo
->shutdown
= 0;
1018 devinfo
->flags
= dev_flags
;
1019 init_usb_anchor(&devinfo
->cmd_urbs
);
1020 init_usb_anchor(&devinfo
->sense_urbs
);
1021 init_usb_anchor(&devinfo
->data_urbs
);
1022 spin_lock_init(&devinfo
->lock
);
1023 INIT_WORK(&devinfo
->work
, uas_do_work
);
1024 INIT_WORK(&devinfo
->scan_work
, uas_scan_work
);
1026 result
= uas_configure_endpoints(devinfo
);
1031 * 1 tag is reserved for untagged commands +
1032 * 1 tag to avoid off by one errors in some bridge firmwares
1034 shost
->can_queue
= devinfo
->qdepth
- 2;
1036 usb_set_intfdata(intf
, shost
);
1037 result
= scsi_add_host(shost
, &intf
->dev
);
1041 /* Submit the delayed_work for SCSI-device scanning */
1042 schedule_work(&devinfo
->scan_work
);
1047 uas_free_streams(devinfo
);
1048 usb_set_intfdata(intf
, NULL
);
1050 usb_set_interface(udev
, intf
->altsetting
[0].desc
.bInterfaceNumber
, 0);
1052 scsi_host_put(shost
);
1056 static int uas_cmnd_list_empty(struct uas_dev_info
*devinfo
)
1058 unsigned long flags
;
1061 spin_lock_irqsave(&devinfo
->lock
, flags
);
1063 for (i
= 0; i
< devinfo
->qdepth
; i
++) {
1064 if (devinfo
->cmnd
[i
]) {
1065 r
= 0; /* Not empty */
1070 spin_unlock_irqrestore(&devinfo
->lock
, flags
);
1076 * Wait for any pending cmnds to complete, on usb-2 sense_urbs may temporarily
1077 * get empty while there still is more work to do due to sense-urbs completing
1078 * with a READ/WRITE_READY iu code, so keep waiting until the list gets empty.
1080 static int uas_wait_for_pending_cmnds(struct uas_dev_info
*devinfo
)
1082 unsigned long start_time
;
1085 start_time
= jiffies
;
1087 flush_work(&devinfo
->work
);
1089 r
= usb_wait_anchor_empty_timeout(&devinfo
->sense_urbs
, 5000);
1093 r
= usb_wait_anchor_empty_timeout(&devinfo
->data_urbs
, 500);
1097 if (time_after(jiffies
, start_time
+ 5 * HZ
))
1099 } while (!uas_cmnd_list_empty(devinfo
));
1104 static int uas_pre_reset(struct usb_interface
*intf
)
1106 struct Scsi_Host
*shost
= usb_get_intfdata(intf
);
1107 struct uas_dev_info
*devinfo
= (struct uas_dev_info
*)shost
->hostdata
;
1108 unsigned long flags
;
1110 if (devinfo
->shutdown
)
1113 /* Block new requests */
1114 spin_lock_irqsave(shost
->host_lock
, flags
);
1115 scsi_block_requests(shost
);
1116 spin_unlock_irqrestore(shost
->host_lock
, flags
);
1118 if (uas_wait_for_pending_cmnds(devinfo
) != 0) {
1119 shost_printk(KERN_ERR
, shost
, "%s: timed out\n", __func__
);
1120 scsi_unblock_requests(shost
);
1124 uas_free_streams(devinfo
);
1129 static int uas_post_reset(struct usb_interface
*intf
)
1131 struct Scsi_Host
*shost
= usb_get_intfdata(intf
);
1132 struct uas_dev_info
*devinfo
= (struct uas_dev_info
*)shost
->hostdata
;
1133 unsigned long flags
;
1136 if (devinfo
->shutdown
)
1139 err
= uas_configure_endpoints(devinfo
);
1140 if (err
&& err
!= -ENODEV
)
1141 shost_printk(KERN_ERR
, shost
,
1142 "%s: alloc streams error %d after reset",
1145 /* we must unblock the host in every case lest we deadlock */
1146 spin_lock_irqsave(shost
->host_lock
, flags
);
1147 scsi_report_bus_reset(shost
, 0);
1148 spin_unlock_irqrestore(shost
->host_lock
, flags
);
1150 scsi_unblock_requests(shost
);
1155 static int uas_suspend(struct usb_interface
*intf
, pm_message_t message
)
1157 struct Scsi_Host
*shost
= usb_get_intfdata(intf
);
1158 struct uas_dev_info
*devinfo
= (struct uas_dev_info
*)shost
->hostdata
;
1160 if (uas_wait_for_pending_cmnds(devinfo
) != 0) {
1161 shost_printk(KERN_ERR
, shost
, "%s: timed out\n", __func__
);
1168 static int uas_resume(struct usb_interface
*intf
)
1173 static int uas_reset_resume(struct usb_interface
*intf
)
1175 struct Scsi_Host
*shost
= usb_get_intfdata(intf
);
1176 struct uas_dev_info
*devinfo
= (struct uas_dev_info
*)shost
->hostdata
;
1177 unsigned long flags
;
1180 err
= uas_configure_endpoints(devinfo
);
1182 shost_printk(KERN_ERR
, shost
,
1183 "%s: alloc streams error %d after reset",
1188 spin_lock_irqsave(shost
->host_lock
, flags
);
1189 scsi_report_bus_reset(shost
, 0);
1190 spin_unlock_irqrestore(shost
->host_lock
, flags
);
1195 static void uas_disconnect(struct usb_interface
*intf
)
1197 struct Scsi_Host
*shost
= usb_get_intfdata(intf
);
1198 struct uas_dev_info
*devinfo
= (struct uas_dev_info
*)shost
->hostdata
;
1199 unsigned long flags
;
1201 spin_lock_irqsave(&devinfo
->lock
, flags
);
1202 devinfo
->resetting
= 1;
1203 spin_unlock_irqrestore(&devinfo
->lock
, flags
);
1205 cancel_work_sync(&devinfo
->work
);
1206 usb_kill_anchored_urbs(&devinfo
->cmd_urbs
);
1207 usb_kill_anchored_urbs(&devinfo
->sense_urbs
);
1208 usb_kill_anchored_urbs(&devinfo
->data_urbs
);
1209 uas_zap_pending(devinfo
, DID_NO_CONNECT
);
1212 * Prevent SCSI scanning (if it hasn't started yet)
1213 * or wait for the SCSI-scanning routine to stop.
1215 cancel_work_sync(&devinfo
->scan_work
);
1217 scsi_remove_host(shost
);
1218 uas_free_streams(devinfo
);
1219 scsi_host_put(shost
);
1223 * Put the device back in usb-storage mode on shutdown, as some BIOS-es
1224 * hang on reboot when the device is still in uas mode. Note the reset is
1225 * necessary as some devices won't revert to usb-storage mode without it.
1227 static void uas_shutdown(struct device
*dev
)
1229 struct usb_interface
*intf
= to_usb_interface(dev
);
1230 struct usb_device
*udev
= interface_to_usbdev(intf
);
1231 struct Scsi_Host
*shost
= usb_get_intfdata(intf
);
1232 struct uas_dev_info
*devinfo
= (struct uas_dev_info
*)shost
->hostdata
;
1234 if (system_state
!= SYSTEM_RESTART
)
1237 devinfo
->shutdown
= 1;
1238 uas_free_streams(devinfo
);
1239 usb_set_interface(udev
, intf
->altsetting
[0].desc
.bInterfaceNumber
, 0);
1240 usb_reset_device(udev
);
1243 static struct usb_driver uas_driver
= {
1246 .disconnect
= uas_disconnect
,
1247 .pre_reset
= uas_pre_reset
,
1248 .post_reset
= uas_post_reset
,
1249 .suspend
= uas_suspend
,
1250 .resume
= uas_resume
,
1251 .reset_resume
= uas_reset_resume
,
1252 .drvwrap
.driver
.shutdown
= uas_shutdown
,
1253 .id_table
= uas_usb_ids
,
1256 static int __init
uas_init(void)
1260 workqueue
= alloc_workqueue("uas", WQ_MEM_RECLAIM
, 0);
1264 rv
= usb_register(&uas_driver
);
1266 destroy_workqueue(workqueue
);
1273 static void __exit
uas_exit(void)
1275 usb_deregister(&uas_driver
);
1276 destroy_workqueue(workqueue
);
1279 module_init(uas_init
);
1280 module_exit(uas_exit
);
1282 MODULE_LICENSE("GPL");
1283 MODULE_IMPORT_NS(USB_STORAGE
);
1285 "Hans de Goede <hdegoede@redhat.com>, Matthew Wilcox and Sarah Sharp");