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
= NULL
;
401 int status
= urb
->status
;
403 spin_lock_irqsave(&devinfo
->lock
, flags
);
405 if (cmdinfo
->data_in_urb
== urb
) {
407 cmdinfo
->state
&= ~DATA_IN_URB_INFLIGHT
;
408 cmdinfo
->data_in_urb
= NULL
;
409 } else if (cmdinfo
->data_out_urb
== urb
) {
410 sdb
= scsi_out(cmnd
);
411 cmdinfo
->state
&= ~DATA_OUT_URB_INFLIGHT
;
412 cmdinfo
->data_out_urb
= NULL
;
419 if (devinfo
->resetting
)
422 /* Data urbs should not complete before the cmd urb is submitted */
423 if (cmdinfo
->state
& SUBMIT_CMD_URB
) {
424 uas_log_cmd_state(cmnd
, "unexpected data cmplt", 0);
429 if (status
!= -ENOENT
&& status
!= -ECONNRESET
&& status
!= -ESHUTDOWN
)
430 uas_log_cmd_state(cmnd
, "data cmplt err", status
);
431 /* error: no data transfered */
432 sdb
->resid
= sdb
->length
;
434 sdb
->resid
= sdb
->length
- urb
->actual_length
;
436 uas_try_complete(cmnd
, __func__
);
439 spin_unlock_irqrestore(&devinfo
->lock
, flags
);
442 static void uas_cmd_cmplt(struct urb
*urb
)
445 dev_err(&urb
->dev
->dev
, "cmd cmplt err %d\n", urb
->status
);
450 static struct urb
*uas_alloc_data_urb(struct uas_dev_info
*devinfo
, gfp_t gfp
,
451 struct scsi_cmnd
*cmnd
,
452 enum dma_data_direction dir
)
454 struct usb_device
*udev
= devinfo
->udev
;
455 struct uas_cmd_info
*cmdinfo
= (void *)&cmnd
->SCp
;
456 struct urb
*urb
= usb_alloc_urb(0, gfp
);
457 struct scsi_data_buffer
*sdb
= (dir
== DMA_FROM_DEVICE
)
458 ? scsi_in(cmnd
) : scsi_out(cmnd
);
459 unsigned int pipe
= (dir
== DMA_FROM_DEVICE
)
460 ? devinfo
->data_in_pipe
: devinfo
->data_out_pipe
;
464 usb_fill_bulk_urb(urb
, udev
, pipe
, NULL
, sdb
->length
,
465 uas_data_cmplt
, cmnd
);
466 if (devinfo
->use_streams
)
467 urb
->stream_id
= cmdinfo
->uas_tag
;
468 urb
->num_sgs
= udev
->bus
->sg_tablesize
? sdb
->table
.nents
: 0;
469 urb
->sg
= sdb
->table
.sgl
;
474 static struct urb
*uas_alloc_sense_urb(struct uas_dev_info
*devinfo
, gfp_t gfp
,
475 struct scsi_cmnd
*cmnd
)
477 struct usb_device
*udev
= devinfo
->udev
;
478 struct uas_cmd_info
*cmdinfo
= (void *)&cmnd
->SCp
;
479 struct urb
*urb
= usb_alloc_urb(0, gfp
);
485 iu
= kzalloc(sizeof(*iu
), gfp
);
489 usb_fill_bulk_urb(urb
, udev
, devinfo
->status_pipe
, iu
, sizeof(*iu
),
490 uas_stat_cmplt
, cmnd
->device
->host
);
491 if (devinfo
->use_streams
)
492 urb
->stream_id
= cmdinfo
->uas_tag
;
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 uas_cmd_info
*cmdinfo
= (void *)&cmnd
->SCp
;
507 struct urb
*urb
= usb_alloc_urb(0, gfp
);
508 struct command_iu
*iu
;
514 len
= cmnd
->cmd_len
- 16;
518 iu
= kzalloc(sizeof(*iu
) + len
, gfp
);
522 iu
->iu_id
= IU_ID_COMMAND
;
523 iu
->tag
= cpu_to_be16(cmdinfo
->uas_tag
);
524 iu
->prio_attr
= UAS_SIMPLE_TAG
;
526 int_to_scsilun(sdev
->lun
, &iu
->lun
);
527 memcpy(iu
->cdb
, cmnd
->cmnd
, cmnd
->cmd_len
);
529 usb_fill_bulk_urb(urb
, udev
, devinfo
->cmd_pipe
, iu
, sizeof(*iu
) + len
,
530 uas_cmd_cmplt
, NULL
);
531 urb
->transfer_flags
|= URB_FREE_BUFFER
;
540 * Why should I request the Status IU before sending the Command IU? Spec
541 * says to, but also says the device may receive them in any order. Seems
545 static struct urb
*uas_submit_sense_urb(struct scsi_cmnd
*cmnd
, gfp_t gfp
)
547 struct uas_dev_info
*devinfo
= cmnd
->device
->hostdata
;
551 urb
= uas_alloc_sense_urb(devinfo
, gfp
, cmnd
);
554 usb_anchor_urb(urb
, &devinfo
->sense_urbs
);
555 err
= usb_submit_urb(urb
, gfp
);
557 usb_unanchor_urb(urb
);
558 uas_log_cmd_state(cmnd
, "sense submit err", err
);
565 static int uas_submit_urbs(struct scsi_cmnd
*cmnd
,
566 struct uas_dev_info
*devinfo
)
568 struct uas_cmd_info
*cmdinfo
= (void *)&cmnd
->SCp
;
572 lockdep_assert_held(&devinfo
->lock
);
573 if (cmdinfo
->state
& SUBMIT_STATUS_URB
) {
574 urb
= uas_submit_sense_urb(cmnd
, GFP_ATOMIC
);
576 return SCSI_MLQUEUE_DEVICE_BUSY
;
577 cmdinfo
->state
&= ~SUBMIT_STATUS_URB
;
580 if (cmdinfo
->state
& ALLOC_DATA_IN_URB
) {
581 cmdinfo
->data_in_urb
= uas_alloc_data_urb(devinfo
, GFP_ATOMIC
,
582 cmnd
, DMA_FROM_DEVICE
);
583 if (!cmdinfo
->data_in_urb
)
584 return SCSI_MLQUEUE_DEVICE_BUSY
;
585 cmdinfo
->state
&= ~ALLOC_DATA_IN_URB
;
588 if (cmdinfo
->state
& SUBMIT_DATA_IN_URB
) {
589 usb_anchor_urb(cmdinfo
->data_in_urb
, &devinfo
->data_urbs
);
590 err
= usb_submit_urb(cmdinfo
->data_in_urb
, GFP_ATOMIC
);
592 usb_unanchor_urb(cmdinfo
->data_in_urb
);
593 uas_log_cmd_state(cmnd
, "data in submit err", err
);
594 return SCSI_MLQUEUE_DEVICE_BUSY
;
596 cmdinfo
->state
&= ~SUBMIT_DATA_IN_URB
;
597 cmdinfo
->state
|= DATA_IN_URB_INFLIGHT
;
600 if (cmdinfo
->state
& ALLOC_DATA_OUT_URB
) {
601 cmdinfo
->data_out_urb
= uas_alloc_data_urb(devinfo
, GFP_ATOMIC
,
602 cmnd
, DMA_TO_DEVICE
);
603 if (!cmdinfo
->data_out_urb
)
604 return SCSI_MLQUEUE_DEVICE_BUSY
;
605 cmdinfo
->state
&= ~ALLOC_DATA_OUT_URB
;
608 if (cmdinfo
->state
& SUBMIT_DATA_OUT_URB
) {
609 usb_anchor_urb(cmdinfo
->data_out_urb
, &devinfo
->data_urbs
);
610 err
= usb_submit_urb(cmdinfo
->data_out_urb
, GFP_ATOMIC
);
612 usb_unanchor_urb(cmdinfo
->data_out_urb
);
613 uas_log_cmd_state(cmnd
, "data out submit err", err
);
614 return SCSI_MLQUEUE_DEVICE_BUSY
;
616 cmdinfo
->state
&= ~SUBMIT_DATA_OUT_URB
;
617 cmdinfo
->state
|= DATA_OUT_URB_INFLIGHT
;
620 if (cmdinfo
->state
& ALLOC_CMD_URB
) {
621 cmdinfo
->cmd_urb
= uas_alloc_cmd_urb(devinfo
, GFP_ATOMIC
, cmnd
);
622 if (!cmdinfo
->cmd_urb
)
623 return SCSI_MLQUEUE_DEVICE_BUSY
;
624 cmdinfo
->state
&= ~ALLOC_CMD_URB
;
627 if (cmdinfo
->state
& SUBMIT_CMD_URB
) {
628 usb_anchor_urb(cmdinfo
->cmd_urb
, &devinfo
->cmd_urbs
);
629 err
= usb_submit_urb(cmdinfo
->cmd_urb
, GFP_ATOMIC
);
631 usb_unanchor_urb(cmdinfo
->cmd_urb
);
632 uas_log_cmd_state(cmnd
, "cmd submit err", err
);
633 return SCSI_MLQUEUE_DEVICE_BUSY
;
635 cmdinfo
->cmd_urb
= NULL
;
636 cmdinfo
->state
&= ~SUBMIT_CMD_URB
;
637 cmdinfo
->state
|= COMMAND_INFLIGHT
;
643 static int uas_queuecommand_lck(struct scsi_cmnd
*cmnd
,
644 void (*done
)(struct scsi_cmnd
*))
646 struct scsi_device
*sdev
= cmnd
->device
;
647 struct uas_dev_info
*devinfo
= sdev
->hostdata
;
648 struct uas_cmd_info
*cmdinfo
= (void *)&cmnd
->SCp
;
652 BUILD_BUG_ON(sizeof(struct uas_cmd_info
) > sizeof(struct scsi_pointer
));
654 /* Re-check scsi_block_requests now that we've the host-lock */
655 if (cmnd
->device
->host
->host_self_blocked
)
656 return SCSI_MLQUEUE_DEVICE_BUSY
;
658 if ((devinfo
->flags
& US_FL_NO_ATA_1X
) &&
659 (cmnd
->cmnd
[0] == ATA_12
|| cmnd
->cmnd
[0] == ATA_16
)) {
660 memcpy(cmnd
->sense_buffer
, usb_stor_sense_invalidCDB
,
661 sizeof(usb_stor_sense_invalidCDB
));
662 cmnd
->result
= SAM_STAT_CHECK_CONDITION
;
663 cmnd
->scsi_done(cmnd
);
667 spin_lock_irqsave(&devinfo
->lock
, flags
);
669 if (devinfo
->resetting
) {
670 cmnd
->result
= DID_ERROR
<< 16;
671 cmnd
->scsi_done(cmnd
);
672 spin_unlock_irqrestore(&devinfo
->lock
, flags
);
676 /* Find a free uas-tag */
677 for (idx
= 0; idx
< devinfo
->qdepth
; idx
++) {
678 if (!devinfo
->cmnd
[idx
])
681 if (idx
== devinfo
->qdepth
) {
682 spin_unlock_irqrestore(&devinfo
->lock
, flags
);
683 return SCSI_MLQUEUE_DEVICE_BUSY
;
686 cmnd
->scsi_done
= done
;
688 memset(cmdinfo
, 0, sizeof(*cmdinfo
));
689 cmdinfo
->uas_tag
= idx
+ 1; /* uas-tag == usb-stream-id, so 1 based */
690 cmdinfo
->state
= SUBMIT_STATUS_URB
| ALLOC_CMD_URB
| SUBMIT_CMD_URB
;
692 switch (cmnd
->sc_data_direction
) {
693 case DMA_FROM_DEVICE
:
694 cmdinfo
->state
|= ALLOC_DATA_IN_URB
| SUBMIT_DATA_IN_URB
;
696 case DMA_BIDIRECTIONAL
:
697 cmdinfo
->state
|= ALLOC_DATA_IN_URB
| SUBMIT_DATA_IN_URB
;
700 cmdinfo
->state
|= ALLOC_DATA_OUT_URB
| SUBMIT_DATA_OUT_URB
;
705 if (!devinfo
->use_streams
)
706 cmdinfo
->state
&= ~(SUBMIT_DATA_IN_URB
| SUBMIT_DATA_OUT_URB
);
708 err
= uas_submit_urbs(cmnd
, devinfo
);
710 /* If we did nothing, give up now */
711 if (cmdinfo
->state
& SUBMIT_STATUS_URB
) {
712 spin_unlock_irqrestore(&devinfo
->lock
, flags
);
713 return SCSI_MLQUEUE_DEVICE_BUSY
;
715 uas_add_work(cmdinfo
);
718 devinfo
->cmnd
[idx
] = cmnd
;
719 spin_unlock_irqrestore(&devinfo
->lock
, flags
);
723 static DEF_SCSI_QCMD(uas_queuecommand
)
726 * For now we do not support actually sending an abort to the device, so
727 * this eh always fails. Still we must define it to make sure that we've
728 * dropped all references to the cmnd in question once this function exits.
730 static int uas_eh_abort_handler(struct scsi_cmnd
*cmnd
)
732 struct uas_cmd_info
*cmdinfo
= (void *)&cmnd
->SCp
;
733 struct uas_dev_info
*devinfo
= (void *)cmnd
->device
->hostdata
;
734 struct urb
*data_in_urb
= NULL
;
735 struct urb
*data_out_urb
= NULL
;
738 spin_lock_irqsave(&devinfo
->lock
, flags
);
740 uas_log_cmd_state(cmnd
, __func__
, 0);
742 /* Ensure that try_complete does not call scsi_done */
743 cmdinfo
->state
|= COMMAND_ABORTED
;
745 /* Drop all refs to this cmnd, kill data urbs to break their ref */
746 devinfo
->cmnd
[cmdinfo
->uas_tag
- 1] = NULL
;
747 if (cmdinfo
->state
& DATA_IN_URB_INFLIGHT
)
748 data_in_urb
= usb_get_urb(cmdinfo
->data_in_urb
);
749 if (cmdinfo
->state
& DATA_OUT_URB_INFLIGHT
)
750 data_out_urb
= usb_get_urb(cmdinfo
->data_out_urb
);
752 uas_free_unsubmitted_urbs(cmnd
);
754 spin_unlock_irqrestore(&devinfo
->lock
, flags
);
757 usb_kill_urb(data_in_urb
);
758 usb_put_urb(data_in_urb
);
761 usb_kill_urb(data_out_urb
);
762 usb_put_urb(data_out_urb
);
768 static int uas_eh_device_reset_handler(struct scsi_cmnd
*cmnd
)
770 struct scsi_device
*sdev
= cmnd
->device
;
771 struct uas_dev_info
*devinfo
= sdev
->hostdata
;
772 struct usb_device
*udev
= devinfo
->udev
;
776 err
= usb_lock_device_for_reset(udev
, devinfo
->intf
);
778 shost_printk(KERN_ERR
, sdev
->host
,
779 "%s FAILED to get lock err %d\n", __func__
, err
);
783 shost_printk(KERN_INFO
, sdev
->host
, "%s start\n", __func__
);
785 spin_lock_irqsave(&devinfo
->lock
, flags
);
786 devinfo
->resetting
= 1;
787 spin_unlock_irqrestore(&devinfo
->lock
, flags
);
789 usb_kill_anchored_urbs(&devinfo
->cmd_urbs
);
790 usb_kill_anchored_urbs(&devinfo
->sense_urbs
);
791 usb_kill_anchored_urbs(&devinfo
->data_urbs
);
792 uas_zap_pending(devinfo
, DID_RESET
);
794 err
= usb_reset_device(udev
);
796 spin_lock_irqsave(&devinfo
->lock
, flags
);
797 devinfo
->resetting
= 0;
798 spin_unlock_irqrestore(&devinfo
->lock
, flags
);
800 usb_unlock_device(udev
);
803 shost_printk(KERN_INFO
, sdev
->host
, "%s FAILED err %d\n",
808 shost_printk(KERN_INFO
, sdev
->host
, "%s success\n", __func__
);
812 static int uas_target_alloc(struct scsi_target
*starget
)
814 struct uas_dev_info
*devinfo
= (struct uas_dev_info
*)
815 dev_to_shost(starget
->dev
.parent
)->hostdata
;
817 if (devinfo
->flags
& US_FL_NO_REPORT_LUNS
)
818 starget
->no_report_luns
= 1;
823 static int uas_slave_alloc(struct scsi_device
*sdev
)
825 struct uas_dev_info
*devinfo
=
826 (struct uas_dev_info
*)sdev
->host
->hostdata
;
828 sdev
->hostdata
= devinfo
;
831 * The protocol has no requirements on alignment in the strict sense.
832 * Controllers may or may not have alignment restrictions.
833 * As this is not exported, we use an extremely conservative guess.
835 blk_queue_update_dma_alignment(sdev
->request_queue
, (512 - 1));
837 if (devinfo
->flags
& US_FL_MAX_SECTORS_64
)
838 blk_queue_max_hw_sectors(sdev
->request_queue
, 64);
839 else if (devinfo
->flags
& US_FL_MAX_SECTORS_240
)
840 blk_queue_max_hw_sectors(sdev
->request_queue
, 240);
845 static int uas_slave_configure(struct scsi_device
*sdev
)
847 struct uas_dev_info
*devinfo
= sdev
->hostdata
;
849 if (devinfo
->flags
& US_FL_NO_REPORT_OPCODES
)
850 sdev
->no_report_opcodes
= 1;
852 /* A few buggy USB-ATA bridges don't understand FUA */
853 if (devinfo
->flags
& US_FL_BROKEN_FUA
)
854 sdev
->broken_fua
= 1;
856 /* UAS also needs to support FL_ALWAYS_SYNC */
857 if (devinfo
->flags
& US_FL_ALWAYS_SYNC
) {
858 sdev
->skip_ms_page_3f
= 1;
859 sdev
->skip_ms_page_8
= 1;
860 sdev
->wce_default_on
= 1;
863 /* Some disks cannot handle READ_CAPACITY_16 */
864 if (devinfo
->flags
& US_FL_NO_READ_CAPACITY_16
)
865 sdev
->no_read_capacity_16
= 1;
868 * Some disks return the total number of blocks in response
869 * to READ CAPACITY rather than the highest block number.
870 * If this device makes that mistake, tell the sd driver.
872 if (devinfo
->flags
& US_FL_FIX_CAPACITY
)
873 sdev
->fix_capacity
= 1;
876 * in some cases we have to guess
878 if (devinfo
->flags
& US_FL_CAPACITY_HEURISTICS
)
879 sdev
->guess_capacity
= 1;
882 * Some devices don't like MODE SENSE with page=0x3f,
883 * which is the command used for checking if a device
884 * is write-protected. Now that we tell the sd driver
885 * to do a 192-byte transfer with this command the
886 * majority of devices work fine, but a few still can't
887 * handle it. The sd driver will simply assume those
888 * devices are write-enabled.
890 if (devinfo
->flags
& US_FL_NO_WP_DETECT
)
891 sdev
->skip_ms_page_3f
= 1;
893 scsi_change_queue_depth(sdev
, devinfo
->qdepth
- 2);
897 static struct scsi_host_template uas_host_template
= {
898 .module
= THIS_MODULE
,
900 .queuecommand
= uas_queuecommand
,
901 .target_alloc
= uas_target_alloc
,
902 .slave_alloc
= uas_slave_alloc
,
903 .slave_configure
= uas_slave_configure
,
904 .eh_abort_handler
= uas_eh_abort_handler
,
905 .eh_device_reset_handler
= uas_eh_device_reset_handler
,
907 .sg_tablesize
= SG_NONE
,
908 .skip_settle_delay
= 1,
911 #define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \
912 vendorName, productName, useProtocol, useTransport, \
913 initFunction, flags) \
914 { USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax), \
915 .driver_info = (flags) }
917 static struct usb_device_id uas_usb_ids
[] = {
918 # include "unusual_uas.h"
919 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE
, USB_SC_SCSI
, USB_PR_BULK
) },
920 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE
, USB_SC_SCSI
, USB_PR_UAS
) },
923 MODULE_DEVICE_TABLE(usb
, uas_usb_ids
);
927 static int uas_switch_interface(struct usb_device
*udev
,
928 struct usb_interface
*intf
)
930 struct usb_host_interface
*alt
;
932 alt
= uas_find_uas_alt_setting(intf
);
936 return usb_set_interface(udev
, alt
->desc
.bInterfaceNumber
,
937 alt
->desc
.bAlternateSetting
);
940 static int uas_configure_endpoints(struct uas_dev_info
*devinfo
)
942 struct usb_host_endpoint
*eps
[4] = { };
943 struct usb_device
*udev
= devinfo
->udev
;
946 r
= uas_find_endpoints(devinfo
->intf
->cur_altsetting
, eps
);
950 devinfo
->cmd_pipe
= usb_sndbulkpipe(udev
,
951 usb_endpoint_num(&eps
[0]->desc
));
952 devinfo
->status_pipe
= usb_rcvbulkpipe(udev
,
953 usb_endpoint_num(&eps
[1]->desc
));
954 devinfo
->data_in_pipe
= usb_rcvbulkpipe(udev
,
955 usb_endpoint_num(&eps
[2]->desc
));
956 devinfo
->data_out_pipe
= usb_sndbulkpipe(udev
,
957 usb_endpoint_num(&eps
[3]->desc
));
959 if (udev
->speed
< USB_SPEED_SUPER
) {
960 devinfo
->qdepth
= 32;
961 devinfo
->use_streams
= 0;
963 devinfo
->qdepth
= usb_alloc_streams(devinfo
->intf
, eps
+ 1,
964 3, MAX_CMNDS
, GFP_NOIO
);
965 if (devinfo
->qdepth
< 0)
966 return devinfo
->qdepth
;
967 devinfo
->use_streams
= 1;
973 static void uas_free_streams(struct uas_dev_info
*devinfo
)
975 struct usb_device
*udev
= devinfo
->udev
;
976 struct usb_host_endpoint
*eps
[3];
978 eps
[0] = usb_pipe_endpoint(udev
, devinfo
->status_pipe
);
979 eps
[1] = usb_pipe_endpoint(udev
, devinfo
->data_in_pipe
);
980 eps
[2] = usb_pipe_endpoint(udev
, devinfo
->data_out_pipe
);
981 usb_free_streams(devinfo
->intf
, eps
, 3, GFP_NOIO
);
984 static int uas_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
986 int result
= -ENOMEM
;
987 struct Scsi_Host
*shost
= NULL
;
988 struct uas_dev_info
*devinfo
;
989 struct usb_device
*udev
= interface_to_usbdev(intf
);
990 unsigned long dev_flags
;
992 if (!uas_use_uas_driver(intf
, id
, &dev_flags
))
995 if (uas_switch_interface(udev
, intf
))
998 shost
= scsi_host_alloc(&uas_host_template
,
999 sizeof(struct uas_dev_info
));
1003 shost
->max_cmd_len
= 16 + 252;
1005 shost
->max_lun
= 256;
1006 shost
->max_channel
= 0;
1007 shost
->sg_tablesize
= udev
->bus
->sg_tablesize
;
1009 devinfo
= (struct uas_dev_info
*)shost
->hostdata
;
1010 devinfo
->intf
= intf
;
1011 devinfo
->udev
= udev
;
1012 devinfo
->resetting
= 0;
1013 devinfo
->shutdown
= 0;
1014 devinfo
->flags
= dev_flags
;
1015 init_usb_anchor(&devinfo
->cmd_urbs
);
1016 init_usb_anchor(&devinfo
->sense_urbs
);
1017 init_usb_anchor(&devinfo
->data_urbs
);
1018 spin_lock_init(&devinfo
->lock
);
1019 INIT_WORK(&devinfo
->work
, uas_do_work
);
1020 INIT_WORK(&devinfo
->scan_work
, uas_scan_work
);
1022 result
= uas_configure_endpoints(devinfo
);
1027 * 1 tag is reserved for untagged commands +
1028 * 1 tag to avoid off by one errors in some bridge firmwares
1030 shost
->can_queue
= devinfo
->qdepth
- 2;
1032 usb_set_intfdata(intf
, shost
);
1033 result
= scsi_add_host(shost
, &intf
->dev
);
1037 /* Submit the delayed_work for SCSI-device scanning */
1038 schedule_work(&devinfo
->scan_work
);
1043 uas_free_streams(devinfo
);
1044 usb_set_intfdata(intf
, NULL
);
1046 usb_set_interface(udev
, intf
->altsetting
[0].desc
.bInterfaceNumber
, 0);
1048 scsi_host_put(shost
);
1052 static int uas_cmnd_list_empty(struct uas_dev_info
*devinfo
)
1054 unsigned long flags
;
1057 spin_lock_irqsave(&devinfo
->lock
, flags
);
1059 for (i
= 0; i
< devinfo
->qdepth
; i
++) {
1060 if (devinfo
->cmnd
[i
]) {
1061 r
= 0; /* Not empty */
1066 spin_unlock_irqrestore(&devinfo
->lock
, flags
);
1072 * Wait for any pending cmnds to complete, on usb-2 sense_urbs may temporarily
1073 * get empty while there still is more work to do due to sense-urbs completing
1074 * with a READ/WRITE_READY iu code, so keep waiting until the list gets empty.
1076 static int uas_wait_for_pending_cmnds(struct uas_dev_info
*devinfo
)
1078 unsigned long start_time
;
1081 start_time
= jiffies
;
1083 flush_work(&devinfo
->work
);
1085 r
= usb_wait_anchor_empty_timeout(&devinfo
->sense_urbs
, 5000);
1089 r
= usb_wait_anchor_empty_timeout(&devinfo
->data_urbs
, 500);
1093 if (time_after(jiffies
, start_time
+ 5 * HZ
))
1095 } while (!uas_cmnd_list_empty(devinfo
));
1100 static int uas_pre_reset(struct usb_interface
*intf
)
1102 struct Scsi_Host
*shost
= usb_get_intfdata(intf
);
1103 struct uas_dev_info
*devinfo
= (struct uas_dev_info
*)shost
->hostdata
;
1104 unsigned long flags
;
1106 if (devinfo
->shutdown
)
1109 /* Block new requests */
1110 spin_lock_irqsave(shost
->host_lock
, flags
);
1111 scsi_block_requests(shost
);
1112 spin_unlock_irqrestore(shost
->host_lock
, flags
);
1114 if (uas_wait_for_pending_cmnds(devinfo
) != 0) {
1115 shost_printk(KERN_ERR
, shost
, "%s: timed out\n", __func__
);
1116 scsi_unblock_requests(shost
);
1120 uas_free_streams(devinfo
);
1125 static int uas_post_reset(struct usb_interface
*intf
)
1127 struct Scsi_Host
*shost
= usb_get_intfdata(intf
);
1128 struct uas_dev_info
*devinfo
= (struct uas_dev_info
*)shost
->hostdata
;
1129 unsigned long flags
;
1132 if (devinfo
->shutdown
)
1135 err
= uas_configure_endpoints(devinfo
);
1136 if (err
&& err
!= -ENODEV
)
1137 shost_printk(KERN_ERR
, shost
,
1138 "%s: alloc streams error %d after reset",
1141 /* we must unblock the host in every case lest we deadlock */
1142 spin_lock_irqsave(shost
->host_lock
, flags
);
1143 scsi_report_bus_reset(shost
, 0);
1144 spin_unlock_irqrestore(shost
->host_lock
, flags
);
1146 scsi_unblock_requests(shost
);
1151 static int uas_suspend(struct usb_interface
*intf
, pm_message_t message
)
1153 struct Scsi_Host
*shost
= usb_get_intfdata(intf
);
1154 struct uas_dev_info
*devinfo
= (struct uas_dev_info
*)shost
->hostdata
;
1156 if (uas_wait_for_pending_cmnds(devinfo
) != 0) {
1157 shost_printk(KERN_ERR
, shost
, "%s: timed out\n", __func__
);
1164 static int uas_resume(struct usb_interface
*intf
)
1169 static int uas_reset_resume(struct usb_interface
*intf
)
1171 struct Scsi_Host
*shost
= usb_get_intfdata(intf
);
1172 struct uas_dev_info
*devinfo
= (struct uas_dev_info
*)shost
->hostdata
;
1173 unsigned long flags
;
1176 err
= uas_configure_endpoints(devinfo
);
1178 shost_printk(KERN_ERR
, shost
,
1179 "%s: alloc streams error %d after reset",
1184 spin_lock_irqsave(shost
->host_lock
, flags
);
1185 scsi_report_bus_reset(shost
, 0);
1186 spin_unlock_irqrestore(shost
->host_lock
, flags
);
1191 static void uas_disconnect(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 spin_lock_irqsave(&devinfo
->lock
, flags
);
1198 devinfo
->resetting
= 1;
1199 spin_unlock_irqrestore(&devinfo
->lock
, flags
);
1201 cancel_work_sync(&devinfo
->work
);
1202 usb_kill_anchored_urbs(&devinfo
->cmd_urbs
);
1203 usb_kill_anchored_urbs(&devinfo
->sense_urbs
);
1204 usb_kill_anchored_urbs(&devinfo
->data_urbs
);
1205 uas_zap_pending(devinfo
, DID_NO_CONNECT
);
1208 * Prevent SCSI scanning (if it hasn't started yet)
1209 * or wait for the SCSI-scanning routine to stop.
1211 cancel_work_sync(&devinfo
->scan_work
);
1213 scsi_remove_host(shost
);
1214 uas_free_streams(devinfo
);
1215 scsi_host_put(shost
);
1219 * Put the device back in usb-storage mode on shutdown, as some BIOS-es
1220 * hang on reboot when the device is still in uas mode. Note the reset is
1221 * necessary as some devices won't revert to usb-storage mode without it.
1223 static void uas_shutdown(struct device
*dev
)
1225 struct usb_interface
*intf
= to_usb_interface(dev
);
1226 struct usb_device
*udev
= interface_to_usbdev(intf
);
1227 struct Scsi_Host
*shost
= usb_get_intfdata(intf
);
1228 struct uas_dev_info
*devinfo
= (struct uas_dev_info
*)shost
->hostdata
;
1230 if (system_state
!= SYSTEM_RESTART
)
1233 devinfo
->shutdown
= 1;
1234 uas_free_streams(devinfo
);
1235 usb_set_interface(udev
, intf
->altsetting
[0].desc
.bInterfaceNumber
, 0);
1236 usb_reset_device(udev
);
1239 static struct usb_driver uas_driver
= {
1242 .disconnect
= uas_disconnect
,
1243 .pre_reset
= uas_pre_reset
,
1244 .post_reset
= uas_post_reset
,
1245 .suspend
= uas_suspend
,
1246 .resume
= uas_resume
,
1247 .reset_resume
= uas_reset_resume
,
1248 .drvwrap
.driver
.shutdown
= uas_shutdown
,
1249 .id_table
= uas_usb_ids
,
1252 static int __init
uas_init(void)
1256 workqueue
= alloc_workqueue("uas", WQ_MEM_RECLAIM
, 0);
1260 rv
= usb_register(&uas_driver
);
1262 destroy_workqueue(workqueue
);
1269 static void __exit
uas_exit(void)
1271 usb_deregister(&uas_driver
);
1272 destroy_workqueue(workqueue
);
1275 module_init(uas_init
);
1276 module_exit(uas_exit
);
1278 MODULE_LICENSE("GPL");
1280 "Hans de Goede <hdegoede@redhat.com>, Matthew Wilcox and Sarah Sharp");