Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * USB Attached SCSI
4 * Note that this is not the same as the USB Mass Storage driver
5 *
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
9 */
10
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>
20
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>
28
29#include "uas-detect.h"
30#include "scsiglue.h"
31
32#define MAX_CMNDS 256
33
34struct uas_dev_info {
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;
40 unsigned long flags;
41 int qdepth, resetting;
42 unsigned cmd_pipe, status_pipe, data_in_pipe, data_out_pipe;
43 unsigned use_streams:1;
44 unsigned shutdown:1;
45 struct scsi_cmnd *cmnd[MAX_CMNDS];
46 spinlock_t lock;
47 struct work_struct work;
48 struct work_struct scan_work; /* for async scanning */
49};
50
51enum {
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),
64};
65
66/* Overrides scsi_pointer */
67struct uas_cmd_info {
68 unsigned int state;
69 unsigned int uas_tag;
70 struct urb *cmd_urb;
71 struct urb *data_in_urb;
72 struct urb *data_out_urb;
73};
74
75/* I hate forward declarations, but I actually have a loop */
76static int uas_submit_urbs(struct scsi_cmnd *cmnd,
77 struct uas_dev_info *devinfo);
78static void uas_do_work(struct work_struct *work);
79static int uas_try_complete(struct scsi_cmnd *cmnd, const char *caller);
80static void uas_free_streams(struct uas_dev_info *devinfo);
81static void uas_log_cmd_state(struct scsi_cmnd *cmnd, const char *prefix,
82 int status);
83
84/*
85 * This driver needs its own workqueue, as we need to control memory allocation.
86 *
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.
91 *
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.
94 */
95static struct workqueue_struct *workqueue;
96
97static void uas_do_work(struct work_struct *work)
98{
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;
103 unsigned long flags;
104 int i, err;
105
106 spin_lock_irqsave(&devinfo->lock, flags);
107
108 if (devinfo->resetting)
109 goto out;
110
111 for (i = 0; i < devinfo->qdepth; i++) {
112 if (!devinfo->cmnd[i])
113 continue;
114
115 cmnd = devinfo->cmnd[i];
116 cmdinfo = (void *)&cmnd->SCp;
117
118 if (!(cmdinfo->state & IS_IN_WORK_LIST))
119 continue;
120
121 err = uas_submit_urbs(cmnd, cmnd->device->hostdata);
122 if (!err)
123 cmdinfo->state &= ~IS_IN_WORK_LIST;
124 else
125 queue_work(workqueue, &devinfo->work);
126 }
127out:
128 spin_unlock_irqrestore(&devinfo->lock, flags);
129}
130
131static void uas_scan_work(struct work_struct *work)
132{
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);
136
137 dev_dbg(&devinfo->intf->dev, "starting scan\n");
138 scsi_scan_host(shost);
139 dev_dbg(&devinfo->intf->dev, "scan complete\n");
140}
141
142static void uas_add_work(struct uas_cmd_info *cmdinfo)
143{
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;
147
148 lockdep_assert_held(&devinfo->lock);
149 cmdinfo->state |= IS_IN_WORK_LIST;
150 queue_work(workqueue, &devinfo->work);
151}
152
153static void uas_zap_pending(struct uas_dev_info *devinfo, int result)
154{
155 struct uas_cmd_info *cmdinfo;
156 struct scsi_cmnd *cmnd;
157 unsigned long flags;
158 int i, err;
159
160 spin_lock_irqsave(&devinfo->lock, flags);
161 for (i = 0; i < devinfo->qdepth; i++) {
162 if (!devinfo->cmnd[i])
163 continue;
164
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__);
172 WARN_ON(err != 0);
173 }
174 spin_unlock_irqrestore(&devinfo->lock, flags);
175}
176
177static void uas_sense(struct urb *urb, struct scsi_cmnd *cmnd)
178{
179 struct sense_iu *sense_iu = urb->transfer_buffer;
180 struct scsi_device *sdev = cmnd->device;
181
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;
186 if (newlen < 0)
187 newlen = 0;
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);
192 len = newlen;
193 }
194 memcpy(cmnd->sense_buffer, sense_iu->sense, len);
195 }
196
197 cmnd->result = sense_iu->status;
198}
199
200static void uas_log_cmd_state(struct scsi_cmnd *cmnd, const char *prefix,
201 int status)
202{
203 struct uas_cmd_info *ci = (void *)&cmnd->SCp;
204 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
205
206 if (status == -ENODEV) /* too late */
207 return;
208
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);
225}
226
227static void uas_free_unsubmitted_urbs(struct scsi_cmnd *cmnd)
228{
229 struct uas_cmd_info *cmdinfo;
230
231 if (!cmnd)
232 return;
233
234 cmdinfo = (void *)&cmnd->SCp;
235
236 if (cmdinfo->state & SUBMIT_CMD_URB)
237 usb_free_urb(cmdinfo->cmd_urb);
238
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);
244}
245
246static int uas_try_complete(struct scsi_cmnd *cmnd, const char *caller)
247{
248 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
249 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
250
251 lockdep_assert_held(&devinfo->lock);
252 if (cmdinfo->state & (COMMAND_INFLIGHT |
253 DATA_IN_URB_INFLIGHT |
254 DATA_OUT_URB_INFLIGHT |
255 COMMAND_ABORTED))
256 return -EBUSY;
257 devinfo->cmnd[cmdinfo->uas_tag - 1] = NULL;
258 uas_free_unsubmitted_urbs(cmnd);
259 cmnd->scsi_done(cmnd);
260 return 0;
261}
262
263static void uas_xfer_data(struct urb *urb, struct scsi_cmnd *cmnd,
264 unsigned direction)
265{
266 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
267 int err;
268
269 cmdinfo->state |= direction | SUBMIT_STATUS_URB;
270 err = uas_submit_urbs(cmnd, cmnd->device->hostdata);
271 if (err) {
272 uas_add_work(cmdinfo);
273 }
274}
275
276static bool uas_evaluate_response_iu(struct response_iu *riu, struct scsi_cmnd *cmnd)
277{
278 u8 response_code = riu->response_code;
279
280 switch (response_code) {
281 case RC_INCORRECT_LUN:
282 cmnd->result = DID_BAD_TARGET << 16;
283 break;
284 case RC_TMF_SUCCEEDED:
285 cmnd->result = DID_OK << 16;
286 break;
287 case RC_TMF_NOT_SUPPORTED:
288 cmnd->result = DID_TARGET_FAILURE << 16;
289 break;
290 default:
291 uas_log_cmd_state(cmnd, "response iu", response_code);
292 cmnd->result = DID_ERROR << 16;
293 break;
294 }
295
296 return response_code == RC_TMF_SUCCEEDED;
297}
298
299static void uas_stat_cmplt(struct urb *urb)
300{
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;
308 unsigned long flags;
309 unsigned int idx;
310 int status = urb->status;
311 bool success;
312
313 spin_lock_irqsave(&devinfo->lock, flags);
314
315 if (devinfo->resetting)
316 goto out;
317
318 if (status) {
319 if (status != -ENOENT && status != -ECONNRESET && status != -ESHUTDOWN)
320 dev_err(&urb->dev->dev, "stat urb: status %d\n", status);
321 goto out;
322 }
323
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);
328 goto out;
329 }
330
331 cmnd = devinfo->cmnd[idx];
332 cmdinfo = (void *)&cmnd->SCp;
333
334 if (!(cmdinfo->state & COMMAND_INFLIGHT)) {
335 uas_log_cmd_state(cmnd, "unexpected status cmplt", 0);
336 goto out;
337 }
338
339 switch (iu->iu_id) {
340 case IU_ID_STATUS:
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);
346 }
347 cmdinfo->state &= ~COMMAND_INFLIGHT;
348 uas_try_complete(cmnd, __func__);
349 break;
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);
354 break;
355 }
356 uas_xfer_data(urb, cmnd, SUBMIT_DATA_IN_URB);
357 break;
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);
362 break;
363 }
364 uas_xfer_data(urb, cmnd, SUBMIT_DATA_OUT_URB);
365 break;
366 case IU_ID_RESPONSE:
367 cmdinfo->state &= ~COMMAND_INFLIGHT;
368 success = uas_evaluate_response_iu((struct response_iu *)iu, cmnd);
369 if (!success) {
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);
373 }
374 uas_try_complete(cmnd, __func__);
375 break;
376 default:
377 uas_log_cmd_state(cmnd, "bogus IU", iu->iu_id);
378 }
379out:
380 usb_free_urb(urb);
381 spin_unlock_irqrestore(&devinfo->lock, flags);
382
383 /* Unlinking of data urbs must be done without holding the lock */
384 if (data_in_urb) {
385 usb_unlink_urb(data_in_urb);
386 usb_put_urb(data_in_urb);
387 }
388 if (data_out_urb) {
389 usb_unlink_urb(data_out_urb);
390 usb_put_urb(data_out_urb);
391 }
392}
393
394static void uas_data_cmplt(struct urb *urb)
395{
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;
400 unsigned long flags;
401 int status = urb->status;
402
403 spin_lock_irqsave(&devinfo->lock, flags);
404
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;
411 }
412
413 if (devinfo->resetting)
414 goto out;
415
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);
419 goto out;
420 }
421
422 if (status) {
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);
427 } else {
428 scsi_set_resid(cmnd, sdb->length - urb->actual_length);
429 }
430 uas_try_complete(cmnd, __func__);
431out:
432 usb_free_urb(urb);
433 spin_unlock_irqrestore(&devinfo->lock, flags);
434}
435
436static void uas_cmd_cmplt(struct urb *urb)
437{
438 if (urb->status)
439 dev_err(&urb->dev->dev, "cmd cmplt err %d\n", urb->status);
440
441 usb_free_urb(urb);
442}
443
444static 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)
447{
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;
454
455 if (!urb)
456 goto out;
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;
463 out:
464 return urb;
465}
466
467static struct urb *uas_alloc_sense_urb(struct uas_dev_info *devinfo, gfp_t gfp,
468 struct scsi_cmnd *cmnd)
469{
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);
473 struct sense_iu *iu;
474
475 if (!urb)
476 goto out;
477
478 iu = kzalloc(sizeof(*iu), gfp);
479 if (!iu)
480 goto free;
481
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;
487 out:
488 return urb;
489 free:
490 usb_free_urb(urb);
491 return NULL;
492}
493
494static struct urb *uas_alloc_cmd_urb(struct uas_dev_info *devinfo, gfp_t gfp,
495 struct scsi_cmnd *cmnd)
496{
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;
502 int len;
503
504 if (!urb)
505 goto out;
506
507 len = cmnd->cmd_len - 16;
508 if (len < 0)
509 len = 0;
510 len = ALIGN(len, 4);
511 iu = kzalloc(sizeof(*iu) + len, gfp);
512 if (!iu)
513 goto free;
514
515 iu->iu_id = IU_ID_COMMAND;
516 iu->tag = cpu_to_be16(cmdinfo->uas_tag);
517 iu->prio_attr = UAS_SIMPLE_TAG;
518 iu->len = len;
519 int_to_scsilun(sdev->lun, &iu->lun);
520 memcpy(iu->cdb, cmnd->cmnd, cmnd->cmd_len);
521
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;
525 out:
526 return urb;
527 free:
528 usb_free_urb(urb);
529 return NULL;
530}
531
532/*
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
535 * daft to me.
536 */
537
538static struct urb *uas_submit_sense_urb(struct scsi_cmnd *cmnd, gfp_t gfp)
539{
540 struct uas_dev_info *devinfo = cmnd->device->hostdata;
541 struct urb *urb;
542 int err;
543
544 urb = uas_alloc_sense_urb(devinfo, gfp, cmnd);
545 if (!urb)
546 return NULL;
547 usb_anchor_urb(urb, &devinfo->sense_urbs);
548 err = usb_submit_urb(urb, gfp);
549 if (err) {
550 usb_unanchor_urb(urb);
551 uas_log_cmd_state(cmnd, "sense submit err", err);
552 usb_free_urb(urb);
553 return NULL;
554 }
555 return urb;
556}
557
558static int uas_submit_urbs(struct scsi_cmnd *cmnd,
559 struct uas_dev_info *devinfo)
560{
561 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
562 struct urb *urb;
563 int err;
564
565 lockdep_assert_held(&devinfo->lock);
566 if (cmdinfo->state & SUBMIT_STATUS_URB) {
567 urb = uas_submit_sense_urb(cmnd, GFP_ATOMIC);
568 if (!urb)
569 return SCSI_MLQUEUE_DEVICE_BUSY;
570 cmdinfo->state &= ~SUBMIT_STATUS_URB;
571 }
572
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;
579 }
580
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);
584 if (err) {
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;
588 }
589 cmdinfo->state &= ~SUBMIT_DATA_IN_URB;
590 cmdinfo->state |= DATA_IN_URB_INFLIGHT;
591 }
592
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;
599 }
600
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);
604 if (err) {
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;
608 }
609 cmdinfo->state &= ~SUBMIT_DATA_OUT_URB;
610 cmdinfo->state |= DATA_OUT_URB_INFLIGHT;
611 }
612
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;
618 }
619
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);
623 if (err) {
624 usb_unanchor_urb(cmdinfo->cmd_urb);
625 uas_log_cmd_state(cmnd, "cmd submit err", err);
626 return SCSI_MLQUEUE_DEVICE_BUSY;
627 }
628 cmdinfo->cmd_urb = NULL;
629 cmdinfo->state &= ~SUBMIT_CMD_URB;
630 cmdinfo->state |= COMMAND_INFLIGHT;
631 }
632
633 return 0;
634}
635
636static int uas_queuecommand_lck(struct scsi_cmnd *cmnd,
637 void (*done)(struct scsi_cmnd *))
638{
639 struct scsi_device *sdev = cmnd->device;
640 struct uas_dev_info *devinfo = sdev->hostdata;
641 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
642 unsigned long flags;
643 int idx, err;
644
645 BUILD_BUG_ON(sizeof(struct uas_cmd_info) > sizeof(struct scsi_pointer));
646
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;
650
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);
657 return 0;
658 }
659
660 spin_lock_irqsave(&devinfo->lock, flags);
661
662 if (devinfo->resetting) {
663 cmnd->result = DID_ERROR << 16;
664 cmnd->scsi_done(cmnd);
665 goto zombie;
666 }
667
668 /* Find a free uas-tag */
669 for (idx = 0; idx < devinfo->qdepth; idx++) {
670 if (!devinfo->cmnd[idx])
671 break;
672 }
673 if (idx == devinfo->qdepth) {
674 spin_unlock_irqrestore(&devinfo->lock, flags);
675 return SCSI_MLQUEUE_DEVICE_BUSY;
676 }
677
678 cmnd->scsi_done = done;
679
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;
683
684 switch (cmnd->sc_data_direction) {
685 case DMA_FROM_DEVICE:
686 cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
687 break;
688 case DMA_BIDIRECTIONAL:
689 cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
690 fallthrough;
691 case DMA_TO_DEVICE:
692 cmdinfo->state |= ALLOC_DATA_OUT_URB | SUBMIT_DATA_OUT_URB;
693 case DMA_NONE:
694 break;
695 }
696
697 if (!devinfo->use_streams)
698 cmdinfo->state &= ~(SUBMIT_DATA_IN_URB | SUBMIT_DATA_OUT_URB);
699
700 err = uas_submit_urbs(cmnd, devinfo);
701 /*
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
705 */
706 if (err == -ENODEV) {
707 cmnd->result = DID_ERROR << 16;
708 cmnd->scsi_done(cmnd);
709 goto zombie;
710 }
711 if (err) {
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;
716 }
717 uas_add_work(cmdinfo);
718 }
719
720 devinfo->cmnd[idx] = cmnd;
721zombie:
722 spin_unlock_irqrestore(&devinfo->lock, flags);
723 return 0;
724}
725
726static DEF_SCSI_QCMD(uas_queuecommand)
727
728/*
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.
732 */
733static int uas_eh_abort_handler(struct scsi_cmnd *cmnd)
734{
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;
739 unsigned long flags;
740
741 spin_lock_irqsave(&devinfo->lock, flags);
742
743 uas_log_cmd_state(cmnd, __func__, 0);
744
745 /* Ensure that try_complete does not call scsi_done */
746 cmdinfo->state |= COMMAND_ABORTED;
747
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);
754
755 uas_free_unsubmitted_urbs(cmnd);
756
757 spin_unlock_irqrestore(&devinfo->lock, flags);
758
759 if (data_in_urb) {
760 usb_kill_urb(data_in_urb);
761 usb_put_urb(data_in_urb);
762 }
763 if (data_out_urb) {
764 usb_kill_urb(data_out_urb);
765 usb_put_urb(data_out_urb);
766 }
767
768 return FAILED;
769}
770
771static int uas_eh_device_reset_handler(struct scsi_cmnd *cmnd)
772{
773 struct scsi_device *sdev = cmnd->device;
774 struct uas_dev_info *devinfo = sdev->hostdata;
775 struct usb_device *udev = devinfo->udev;
776 unsigned long flags;
777 int err;
778
779 err = usb_lock_device_for_reset(udev, devinfo->intf);
780 if (err) {
781 shost_printk(KERN_ERR, sdev->host,
782 "%s FAILED to get lock err %d\n", __func__, err);
783 return FAILED;
784 }
785
786 shost_printk(KERN_INFO, sdev->host, "%s start\n", __func__);
787
788 spin_lock_irqsave(&devinfo->lock, flags);
789 devinfo->resetting = 1;
790 spin_unlock_irqrestore(&devinfo->lock, flags);
791
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);
796
797 err = usb_reset_device(udev);
798
799 spin_lock_irqsave(&devinfo->lock, flags);
800 devinfo->resetting = 0;
801 spin_unlock_irqrestore(&devinfo->lock, flags);
802
803 usb_unlock_device(udev);
804
805 if (err) {
806 shost_printk(KERN_INFO, sdev->host, "%s FAILED err %d\n",
807 __func__, err);
808 return FAILED;
809 }
810
811 shost_printk(KERN_INFO, sdev->host, "%s success\n", __func__);
812 return SUCCESS;
813}
814
815static int uas_target_alloc(struct scsi_target *starget)
816{
817 struct uas_dev_info *devinfo = (struct uas_dev_info *)
818 dev_to_shost(starget->dev.parent)->hostdata;
819
820 if (devinfo->flags & US_FL_NO_REPORT_LUNS)
821 starget->no_report_luns = 1;
822
823 return 0;
824}
825
826static int uas_slave_alloc(struct scsi_device *sdev)
827{
828 struct uas_dev_info *devinfo =
829 (struct uas_dev_info *)sdev->host->hostdata;
830
831 sdev->hostdata = devinfo;
832
833 /*
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.
837 */
838 blk_queue_update_dma_alignment(sdev->request_queue, (512 - 1));
839
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);
844
845 return 0;
846}
847
848static int uas_slave_configure(struct scsi_device *sdev)
849{
850 struct uas_dev_info *devinfo = sdev->hostdata;
851
852 if (devinfo->flags & US_FL_NO_REPORT_OPCODES)
853 sdev->no_report_opcodes = 1;
854
855 /* A few buggy USB-ATA bridges don't understand FUA */
856 if (devinfo->flags & US_FL_BROKEN_FUA)
857 sdev->broken_fua = 1;
858
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;
864 }
865
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;
869
870 /*
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.
874 */
875 if (devinfo->flags & US_FL_FIX_CAPACITY)
876 sdev->fix_capacity = 1;
877
878 /*
879 * in some cases we have to guess
880 */
881 if (devinfo->flags & US_FL_CAPACITY_HEURISTICS)
882 sdev->guess_capacity = 1;
883
884 /*
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.
892 */
893 if (devinfo->flags & US_FL_NO_WP_DETECT)
894 sdev->skip_ms_page_3f = 1;
895
896 scsi_change_queue_depth(sdev, devinfo->qdepth - 2);
897 return 0;
898}
899
900static struct scsi_host_template uas_host_template = {
901 .module = THIS_MODULE,
902 .name = "uas",
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,
909 .this_id = -1,
910 .skip_settle_delay = 1,
911 .dma_boundary = PAGE_SIZE - 1,
912};
913
914#define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \
915 vendorName, productName, useProtocol, useTransport, \
916 initFunction, flags) \
917{ USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax), \
918 .driver_info = (flags) }
919
920static struct usb_device_id uas_usb_ids[] = {
921# include "unusual_uas.h"
922 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_BULK) },
923 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_UAS) },
924 { }
925};
926MODULE_DEVICE_TABLE(usb, uas_usb_ids);
927
928#undef UNUSUAL_DEV
929
930static int uas_switch_interface(struct usb_device *udev,
931 struct usb_interface *intf)
932{
933 struct usb_host_interface *alt;
934
935 alt = uas_find_uas_alt_setting(intf);
936 if (!alt)
937 return -ENODEV;
938
939 return usb_set_interface(udev, alt->desc.bInterfaceNumber,
940 alt->desc.bAlternateSetting);
941}
942
943static int uas_configure_endpoints(struct uas_dev_info *devinfo)
944{
945 struct usb_host_endpoint *eps[4] = { };
946 struct usb_device *udev = devinfo->udev;
947 int r;
948
949 r = uas_find_endpoints(devinfo->intf->cur_altsetting, eps);
950 if (r)
951 return r;
952
953 devinfo->cmd_pipe = usb_sndbulkpipe(udev,
954 usb_endpoint_num(&eps[0]->desc));
955 devinfo->status_pipe = usb_rcvbulkpipe(udev,
956 usb_endpoint_num(&eps[1]->desc));
957 devinfo->data_in_pipe = usb_rcvbulkpipe(udev,
958 usb_endpoint_num(&eps[2]->desc));
959 devinfo->data_out_pipe = usb_sndbulkpipe(udev,
960 usb_endpoint_num(&eps[3]->desc));
961
962 if (udev->speed < USB_SPEED_SUPER) {
963 devinfo->qdepth = 32;
964 devinfo->use_streams = 0;
965 } else {
966 devinfo->qdepth = usb_alloc_streams(devinfo->intf, eps + 1,
967 3, MAX_CMNDS, GFP_NOIO);
968 if (devinfo->qdepth < 0)
969 return devinfo->qdepth;
970 devinfo->use_streams = 1;
971 }
972
973 return 0;
974}
975
976static void uas_free_streams(struct uas_dev_info *devinfo)
977{
978 struct usb_device *udev = devinfo->udev;
979 struct usb_host_endpoint *eps[3];
980
981 eps[0] = usb_pipe_endpoint(udev, devinfo->status_pipe);
982 eps[1] = usb_pipe_endpoint(udev, devinfo->data_in_pipe);
983 eps[2] = usb_pipe_endpoint(udev, devinfo->data_out_pipe);
984 usb_free_streams(devinfo->intf, eps, 3, GFP_NOIO);
985}
986
987static int uas_probe(struct usb_interface *intf, const struct usb_device_id *id)
988{
989 int result = -ENOMEM;
990 struct Scsi_Host *shost = NULL;
991 struct uas_dev_info *devinfo;
992 struct usb_device *udev = interface_to_usbdev(intf);
993 unsigned long dev_flags;
994
995 if (!uas_use_uas_driver(intf, id, &dev_flags))
996 return -ENODEV;
997
998 if (uas_switch_interface(udev, intf))
999 return -ENODEV;
1000
1001 shost = scsi_host_alloc(&uas_host_template,
1002 sizeof(struct uas_dev_info));
1003 if (!shost)
1004 goto set_alt0;
1005
1006 shost->max_cmd_len = 16 + 252;
1007 shost->max_id = 1;
1008 shost->max_lun = 256;
1009 shost->max_channel = 0;
1010 shost->sg_tablesize = udev->bus->sg_tablesize;
1011
1012 devinfo = (struct uas_dev_info *)shost->hostdata;
1013 devinfo->intf = intf;
1014 devinfo->udev = udev;
1015 devinfo->resetting = 0;
1016 devinfo->shutdown = 0;
1017 devinfo->flags = dev_flags;
1018 init_usb_anchor(&devinfo->cmd_urbs);
1019 init_usb_anchor(&devinfo->sense_urbs);
1020 init_usb_anchor(&devinfo->data_urbs);
1021 spin_lock_init(&devinfo->lock);
1022 INIT_WORK(&devinfo->work, uas_do_work);
1023 INIT_WORK(&devinfo->scan_work, uas_scan_work);
1024
1025 result = uas_configure_endpoints(devinfo);
1026 if (result)
1027 goto set_alt0;
1028
1029 /*
1030 * 1 tag is reserved for untagged commands +
1031 * 1 tag to avoid off by one errors in some bridge firmwares
1032 */
1033 shost->can_queue = devinfo->qdepth - 2;
1034
1035 usb_set_intfdata(intf, shost);
1036 result = scsi_add_host(shost, &intf->dev);
1037 if (result)
1038 goto free_streams;
1039
1040 /* Submit the delayed_work for SCSI-device scanning */
1041 schedule_work(&devinfo->scan_work);
1042
1043 return result;
1044
1045free_streams:
1046 uas_free_streams(devinfo);
1047 usb_set_intfdata(intf, NULL);
1048set_alt0:
1049 usb_set_interface(udev, intf->altsetting[0].desc.bInterfaceNumber, 0);
1050 if (shost)
1051 scsi_host_put(shost);
1052 return result;
1053}
1054
1055static int uas_cmnd_list_empty(struct uas_dev_info *devinfo)
1056{
1057 unsigned long flags;
1058 int i, r = 1;
1059
1060 spin_lock_irqsave(&devinfo->lock, flags);
1061
1062 for (i = 0; i < devinfo->qdepth; i++) {
1063 if (devinfo->cmnd[i]) {
1064 r = 0; /* Not empty */
1065 break;
1066 }
1067 }
1068
1069 spin_unlock_irqrestore(&devinfo->lock, flags);
1070
1071 return r;
1072}
1073
1074/*
1075 * Wait for any pending cmnds to complete, on usb-2 sense_urbs may temporarily
1076 * get empty while there still is more work to do due to sense-urbs completing
1077 * with a READ/WRITE_READY iu code, so keep waiting until the list gets empty.
1078 */
1079static int uas_wait_for_pending_cmnds(struct uas_dev_info *devinfo)
1080{
1081 unsigned long start_time;
1082 int r;
1083
1084 start_time = jiffies;
1085 do {
1086 flush_work(&devinfo->work);
1087
1088 r = usb_wait_anchor_empty_timeout(&devinfo->sense_urbs, 5000);
1089 if (r == 0)
1090 return -ETIME;
1091
1092 r = usb_wait_anchor_empty_timeout(&devinfo->data_urbs, 500);
1093 if (r == 0)
1094 return -ETIME;
1095
1096 if (time_after(jiffies, start_time + 5 * HZ))
1097 return -ETIME;
1098 } while (!uas_cmnd_list_empty(devinfo));
1099
1100 return 0;
1101}
1102
1103static int uas_pre_reset(struct usb_interface *intf)
1104{
1105 struct Scsi_Host *shost = usb_get_intfdata(intf);
1106 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1107 unsigned long flags;
1108
1109 if (devinfo->shutdown)
1110 return 0;
1111
1112 /* Block new requests */
1113 spin_lock_irqsave(shost->host_lock, flags);
1114 scsi_block_requests(shost);
1115 spin_unlock_irqrestore(shost->host_lock, flags);
1116
1117 if (uas_wait_for_pending_cmnds(devinfo) != 0) {
1118 shost_printk(KERN_ERR, shost, "%s: timed out\n", __func__);
1119 scsi_unblock_requests(shost);
1120 return 1;
1121 }
1122
1123 uas_free_streams(devinfo);
1124
1125 return 0;
1126}
1127
1128static int uas_post_reset(struct usb_interface *intf)
1129{
1130 struct Scsi_Host *shost = usb_get_intfdata(intf);
1131 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1132 unsigned long flags;
1133 int err;
1134
1135 if (devinfo->shutdown)
1136 return 0;
1137
1138 err = uas_configure_endpoints(devinfo);
1139 if (err && err != -ENODEV)
1140 shost_printk(KERN_ERR, shost,
1141 "%s: alloc streams error %d after reset",
1142 __func__, err);
1143
1144 /* we must unblock the host in every case lest we deadlock */
1145 spin_lock_irqsave(shost->host_lock, flags);
1146 scsi_report_bus_reset(shost, 0);
1147 spin_unlock_irqrestore(shost->host_lock, flags);
1148
1149 scsi_unblock_requests(shost);
1150
1151 return err ? 1 : 0;
1152}
1153
1154static int uas_suspend(struct usb_interface *intf, pm_message_t message)
1155{
1156 struct Scsi_Host *shost = usb_get_intfdata(intf);
1157 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1158
1159 if (uas_wait_for_pending_cmnds(devinfo) != 0) {
1160 shost_printk(KERN_ERR, shost, "%s: timed out\n", __func__);
1161 return -ETIME;
1162 }
1163
1164 return 0;
1165}
1166
1167static int uas_resume(struct usb_interface *intf)
1168{
1169 return 0;
1170}
1171
1172static int uas_reset_resume(struct usb_interface *intf)
1173{
1174 struct Scsi_Host *shost = usb_get_intfdata(intf);
1175 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1176 unsigned long flags;
1177 int err;
1178
1179 err = uas_configure_endpoints(devinfo);
1180 if (err) {
1181 shost_printk(KERN_ERR, shost,
1182 "%s: alloc streams error %d after reset",
1183 __func__, err);
1184 return -EIO;
1185 }
1186
1187 spin_lock_irqsave(shost->host_lock, flags);
1188 scsi_report_bus_reset(shost, 0);
1189 spin_unlock_irqrestore(shost->host_lock, flags);
1190
1191 return 0;
1192}
1193
1194static void uas_disconnect(struct usb_interface *intf)
1195{
1196 struct Scsi_Host *shost = usb_get_intfdata(intf);
1197 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1198 unsigned long flags;
1199
1200 spin_lock_irqsave(&devinfo->lock, flags);
1201 devinfo->resetting = 1;
1202 spin_unlock_irqrestore(&devinfo->lock, flags);
1203
1204 cancel_work_sync(&devinfo->work);
1205 usb_kill_anchored_urbs(&devinfo->cmd_urbs);
1206 usb_kill_anchored_urbs(&devinfo->sense_urbs);
1207 usb_kill_anchored_urbs(&devinfo->data_urbs);
1208 uas_zap_pending(devinfo, DID_NO_CONNECT);
1209
1210 /*
1211 * Prevent SCSI scanning (if it hasn't started yet)
1212 * or wait for the SCSI-scanning routine to stop.
1213 */
1214 cancel_work_sync(&devinfo->scan_work);
1215
1216 scsi_remove_host(shost);
1217 uas_free_streams(devinfo);
1218 scsi_host_put(shost);
1219}
1220
1221/*
1222 * Put the device back in usb-storage mode on shutdown, as some BIOS-es
1223 * hang on reboot when the device is still in uas mode. Note the reset is
1224 * necessary as some devices won't revert to usb-storage mode without it.
1225 */
1226static void uas_shutdown(struct device *dev)
1227{
1228 struct usb_interface *intf = to_usb_interface(dev);
1229 struct usb_device *udev = interface_to_usbdev(intf);
1230 struct Scsi_Host *shost = usb_get_intfdata(intf);
1231 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1232
1233 if (system_state != SYSTEM_RESTART)
1234 return;
1235
1236 devinfo->shutdown = 1;
1237 uas_free_streams(devinfo);
1238 usb_set_interface(udev, intf->altsetting[0].desc.bInterfaceNumber, 0);
1239 usb_reset_device(udev);
1240}
1241
1242static struct usb_driver uas_driver = {
1243 .name = "uas",
1244 .probe = uas_probe,
1245 .disconnect = uas_disconnect,
1246 .pre_reset = uas_pre_reset,
1247 .post_reset = uas_post_reset,
1248 .suspend = uas_suspend,
1249 .resume = uas_resume,
1250 .reset_resume = uas_reset_resume,
1251 .drvwrap.driver.shutdown = uas_shutdown,
1252 .id_table = uas_usb_ids,
1253};
1254
1255static int __init uas_init(void)
1256{
1257 int rv;
1258
1259 workqueue = alloc_workqueue("uas", WQ_MEM_RECLAIM, 0);
1260 if (!workqueue)
1261 return -ENOMEM;
1262
1263 rv = usb_register(&uas_driver);
1264 if (rv) {
1265 destroy_workqueue(workqueue);
1266 return -ENOMEM;
1267 }
1268
1269 return 0;
1270}
1271
1272static void __exit uas_exit(void)
1273{
1274 usb_deregister(&uas_driver);
1275 destroy_workqueue(workqueue);
1276}
1277
1278module_init(uas_init);
1279module_exit(uas_exit);
1280
1281MODULE_LICENSE("GPL");
1282MODULE_IMPORT_NS(USB_STORAGE);
1283MODULE_AUTHOR(
1284 "Hans de Goede <hdegoede@redhat.com>, Matthew Wilcox and Sarah Sharp");
1/*
2 * USB Attached SCSI
3 * Note that this is not the same as the USB Mass Storage driver
4 *
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
8 *
9 * Distributed under the terms of the GNU GPL, version two.
10 */
11
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>
21
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>
29
30#include "uas-detect.h"
31#include "scsiglue.h"
32
33#define MAX_CMNDS 256
34
35struct uas_dev_info {
36 struct usb_interface *intf;
37 struct usb_device *udev;
38 struct usb_anchor cmd_urbs;
39 struct usb_anchor sense_urbs;
40 struct usb_anchor data_urbs;
41 unsigned long flags;
42 int qdepth, resetting;
43 unsigned cmd_pipe, status_pipe, data_in_pipe, data_out_pipe;
44 unsigned use_streams:1;
45 unsigned shutdown:1;
46 struct scsi_cmnd *cmnd[MAX_CMNDS];
47 spinlock_t lock;
48 struct work_struct work;
49};
50
51enum {
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),
64};
65
66/* Overrides scsi_pointer */
67struct uas_cmd_info {
68 unsigned int state;
69 unsigned int uas_tag;
70 struct urb *cmd_urb;
71 struct urb *data_in_urb;
72 struct urb *data_out_urb;
73};
74
75/* I hate forward declarations, but I actually have a loop */
76static int uas_submit_urbs(struct scsi_cmnd *cmnd,
77 struct uas_dev_info *devinfo);
78static void uas_do_work(struct work_struct *work);
79static int uas_try_complete(struct scsi_cmnd *cmnd, const char *caller);
80static void uas_free_streams(struct uas_dev_info *devinfo);
81static void uas_log_cmd_state(struct scsi_cmnd *cmnd, const char *prefix,
82 int status);
83
84static void uas_do_work(struct work_struct *work)
85{
86 struct uas_dev_info *devinfo =
87 container_of(work, struct uas_dev_info, work);
88 struct uas_cmd_info *cmdinfo;
89 struct scsi_cmnd *cmnd;
90 unsigned long flags;
91 int i, err;
92
93 spin_lock_irqsave(&devinfo->lock, flags);
94
95 if (devinfo->resetting)
96 goto out;
97
98 for (i = 0; i < devinfo->qdepth; i++) {
99 if (!devinfo->cmnd[i])
100 continue;
101
102 cmnd = devinfo->cmnd[i];
103 cmdinfo = (void *)&cmnd->SCp;
104
105 if (!(cmdinfo->state & IS_IN_WORK_LIST))
106 continue;
107
108 err = uas_submit_urbs(cmnd, cmnd->device->hostdata);
109 if (!err)
110 cmdinfo->state &= ~IS_IN_WORK_LIST;
111 else
112 schedule_work(&devinfo->work);
113 }
114out:
115 spin_unlock_irqrestore(&devinfo->lock, flags);
116}
117
118static void uas_add_work(struct uas_cmd_info *cmdinfo)
119{
120 struct scsi_pointer *scp = (void *)cmdinfo;
121 struct scsi_cmnd *cmnd = container_of(scp, struct scsi_cmnd, SCp);
122 struct uas_dev_info *devinfo = cmnd->device->hostdata;
123
124 lockdep_assert_held(&devinfo->lock);
125 cmdinfo->state |= IS_IN_WORK_LIST;
126 schedule_work(&devinfo->work);
127}
128
129static void uas_zap_pending(struct uas_dev_info *devinfo, int result)
130{
131 struct uas_cmd_info *cmdinfo;
132 struct scsi_cmnd *cmnd;
133 unsigned long flags;
134 int i, err;
135
136 spin_lock_irqsave(&devinfo->lock, flags);
137 for (i = 0; i < devinfo->qdepth; i++) {
138 if (!devinfo->cmnd[i])
139 continue;
140
141 cmnd = devinfo->cmnd[i];
142 cmdinfo = (void *)&cmnd->SCp;
143 uas_log_cmd_state(cmnd, __func__, 0);
144 /* Sense urbs were killed, clear COMMAND_INFLIGHT manually */
145 cmdinfo->state &= ~COMMAND_INFLIGHT;
146 cmnd->result = result << 16;
147 err = uas_try_complete(cmnd, __func__);
148 WARN_ON(err != 0);
149 }
150 spin_unlock_irqrestore(&devinfo->lock, flags);
151}
152
153static void uas_sense(struct urb *urb, struct scsi_cmnd *cmnd)
154{
155 struct sense_iu *sense_iu = urb->transfer_buffer;
156 struct scsi_device *sdev = cmnd->device;
157
158 if (urb->actual_length > 16) {
159 unsigned len = be16_to_cpup(&sense_iu->len);
160 if (len + 16 != urb->actual_length) {
161 int newlen = min(len + 16, urb->actual_length) - 16;
162 if (newlen < 0)
163 newlen = 0;
164 sdev_printk(KERN_INFO, sdev, "%s: urb length %d "
165 "disagrees with IU sense data length %d, "
166 "using %d bytes of sense data\n", __func__,
167 urb->actual_length, len, newlen);
168 len = newlen;
169 }
170 memcpy(cmnd->sense_buffer, sense_iu->sense, len);
171 }
172
173 cmnd->result = sense_iu->status;
174}
175
176static void uas_log_cmd_state(struct scsi_cmnd *cmnd, const char *prefix,
177 int status)
178{
179 struct uas_cmd_info *ci = (void *)&cmnd->SCp;
180 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
181
182 scmd_printk(KERN_INFO, cmnd,
183 "%s %d uas-tag %d inflight:%s%s%s%s%s%s%s%s%s%s%s%s ",
184 prefix, status, cmdinfo->uas_tag,
185 (ci->state & SUBMIT_STATUS_URB) ? " s-st" : "",
186 (ci->state & ALLOC_DATA_IN_URB) ? " a-in" : "",
187 (ci->state & SUBMIT_DATA_IN_URB) ? " s-in" : "",
188 (ci->state & ALLOC_DATA_OUT_URB) ? " a-out" : "",
189 (ci->state & SUBMIT_DATA_OUT_URB) ? " s-out" : "",
190 (ci->state & ALLOC_CMD_URB) ? " a-cmd" : "",
191 (ci->state & SUBMIT_CMD_URB) ? " s-cmd" : "",
192 (ci->state & COMMAND_INFLIGHT) ? " CMD" : "",
193 (ci->state & DATA_IN_URB_INFLIGHT) ? " IN" : "",
194 (ci->state & DATA_OUT_URB_INFLIGHT) ? " OUT" : "",
195 (ci->state & COMMAND_ABORTED) ? " abort" : "",
196 (ci->state & IS_IN_WORK_LIST) ? " work" : "");
197 scsi_print_command(cmnd);
198}
199
200static void uas_free_unsubmitted_urbs(struct scsi_cmnd *cmnd)
201{
202 struct uas_cmd_info *cmdinfo;
203
204 if (!cmnd)
205 return;
206
207 cmdinfo = (void *)&cmnd->SCp;
208
209 if (cmdinfo->state & SUBMIT_CMD_URB)
210 usb_free_urb(cmdinfo->cmd_urb);
211
212 /* data urbs may have never gotten their submit flag set */
213 if (!(cmdinfo->state & DATA_IN_URB_INFLIGHT))
214 usb_free_urb(cmdinfo->data_in_urb);
215 if (!(cmdinfo->state & DATA_OUT_URB_INFLIGHT))
216 usb_free_urb(cmdinfo->data_out_urb);
217}
218
219static int uas_try_complete(struct scsi_cmnd *cmnd, const char *caller)
220{
221 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
222 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
223
224 lockdep_assert_held(&devinfo->lock);
225 if (cmdinfo->state & (COMMAND_INFLIGHT |
226 DATA_IN_URB_INFLIGHT |
227 DATA_OUT_URB_INFLIGHT |
228 COMMAND_ABORTED))
229 return -EBUSY;
230 devinfo->cmnd[cmdinfo->uas_tag - 1] = NULL;
231 uas_free_unsubmitted_urbs(cmnd);
232 cmnd->scsi_done(cmnd);
233 return 0;
234}
235
236static void uas_xfer_data(struct urb *urb, struct scsi_cmnd *cmnd,
237 unsigned direction)
238{
239 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
240 int err;
241
242 cmdinfo->state |= direction | SUBMIT_STATUS_URB;
243 err = uas_submit_urbs(cmnd, cmnd->device->hostdata);
244 if (err) {
245 uas_add_work(cmdinfo);
246 }
247}
248
249static bool uas_evaluate_response_iu(struct response_iu *riu, struct scsi_cmnd *cmnd)
250{
251 u8 response_code = riu->response_code;
252
253 switch (response_code) {
254 case RC_INCORRECT_LUN:
255 cmnd->result = DID_BAD_TARGET << 16;
256 break;
257 case RC_TMF_SUCCEEDED:
258 cmnd->result = DID_OK << 16;
259 break;
260 case RC_TMF_NOT_SUPPORTED:
261 cmnd->result = DID_TARGET_FAILURE << 16;
262 break;
263 default:
264 uas_log_cmd_state(cmnd, "response iu", response_code);
265 cmnd->result = DID_ERROR << 16;
266 break;
267 }
268
269 return response_code == RC_TMF_SUCCEEDED;
270}
271
272static void uas_stat_cmplt(struct urb *urb)
273{
274 struct iu *iu = urb->transfer_buffer;
275 struct Scsi_Host *shost = urb->context;
276 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
277 struct urb *data_in_urb = NULL;
278 struct urb *data_out_urb = NULL;
279 struct scsi_cmnd *cmnd;
280 struct uas_cmd_info *cmdinfo;
281 unsigned long flags;
282 unsigned int idx;
283 int status = urb->status;
284 bool success;
285
286 spin_lock_irqsave(&devinfo->lock, flags);
287
288 if (devinfo->resetting)
289 goto out;
290
291 if (status) {
292 if (status != -ENOENT && status != -ECONNRESET && status != -ESHUTDOWN)
293 dev_err(&urb->dev->dev, "stat urb: status %d\n", status);
294 goto out;
295 }
296
297 idx = be16_to_cpup(&iu->tag) - 1;
298 if (idx >= MAX_CMNDS || !devinfo->cmnd[idx]) {
299 dev_err(&urb->dev->dev,
300 "stat urb: no pending cmd for uas-tag %d\n", idx + 1);
301 goto out;
302 }
303
304 cmnd = devinfo->cmnd[idx];
305 cmdinfo = (void *)&cmnd->SCp;
306
307 if (!(cmdinfo->state & COMMAND_INFLIGHT)) {
308 uas_log_cmd_state(cmnd, "unexpected status cmplt", 0);
309 goto out;
310 }
311
312 switch (iu->iu_id) {
313 case IU_ID_STATUS:
314 uas_sense(urb, cmnd);
315 if (cmnd->result != 0) {
316 /* cancel data transfers on error */
317 data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
318 data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
319 }
320 cmdinfo->state &= ~COMMAND_INFLIGHT;
321 uas_try_complete(cmnd, __func__);
322 break;
323 case IU_ID_READ_READY:
324 if (!cmdinfo->data_in_urb ||
325 (cmdinfo->state & DATA_IN_URB_INFLIGHT)) {
326 uas_log_cmd_state(cmnd, "unexpected read rdy", 0);
327 break;
328 }
329 uas_xfer_data(urb, cmnd, SUBMIT_DATA_IN_URB);
330 break;
331 case IU_ID_WRITE_READY:
332 if (!cmdinfo->data_out_urb ||
333 (cmdinfo->state & DATA_OUT_URB_INFLIGHT)) {
334 uas_log_cmd_state(cmnd, "unexpected write rdy", 0);
335 break;
336 }
337 uas_xfer_data(urb, cmnd, SUBMIT_DATA_OUT_URB);
338 break;
339 case IU_ID_RESPONSE:
340 cmdinfo->state &= ~COMMAND_INFLIGHT;
341 success = uas_evaluate_response_iu((struct response_iu *)iu, cmnd);
342 if (!success) {
343 /* Error, cancel data transfers */
344 data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
345 data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
346 }
347 uas_try_complete(cmnd, __func__);
348 break;
349 default:
350 uas_log_cmd_state(cmnd, "bogus IU", iu->iu_id);
351 }
352out:
353 usb_free_urb(urb);
354 spin_unlock_irqrestore(&devinfo->lock, flags);
355
356 /* Unlinking of data urbs must be done without holding the lock */
357 if (data_in_urb) {
358 usb_unlink_urb(data_in_urb);
359 usb_put_urb(data_in_urb);
360 }
361 if (data_out_urb) {
362 usb_unlink_urb(data_out_urb);
363 usb_put_urb(data_out_urb);
364 }
365}
366
367static void uas_data_cmplt(struct urb *urb)
368{
369 struct scsi_cmnd *cmnd = urb->context;
370 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
371 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
372 struct scsi_data_buffer *sdb = NULL;
373 unsigned long flags;
374 int status = urb->status;
375
376 spin_lock_irqsave(&devinfo->lock, flags);
377
378 if (cmdinfo->data_in_urb == urb) {
379 sdb = scsi_in(cmnd);
380 cmdinfo->state &= ~DATA_IN_URB_INFLIGHT;
381 cmdinfo->data_in_urb = NULL;
382 } else if (cmdinfo->data_out_urb == urb) {
383 sdb = scsi_out(cmnd);
384 cmdinfo->state &= ~DATA_OUT_URB_INFLIGHT;
385 cmdinfo->data_out_urb = NULL;
386 }
387 if (sdb == NULL) {
388 WARN_ON_ONCE(1);
389 goto out;
390 }
391
392 if (devinfo->resetting)
393 goto out;
394
395 /* Data urbs should not complete before the cmd urb is submitted */
396 if (cmdinfo->state & SUBMIT_CMD_URB) {
397 uas_log_cmd_state(cmnd, "unexpected data cmplt", 0);
398 goto out;
399 }
400
401 if (status) {
402 if (status != -ENOENT && status != -ECONNRESET && status != -ESHUTDOWN)
403 uas_log_cmd_state(cmnd, "data cmplt err", status);
404 /* error: no data transfered */
405 sdb->resid = sdb->length;
406 } else {
407 sdb->resid = sdb->length - urb->actual_length;
408 }
409 uas_try_complete(cmnd, __func__);
410out:
411 usb_free_urb(urb);
412 spin_unlock_irqrestore(&devinfo->lock, flags);
413}
414
415static void uas_cmd_cmplt(struct urb *urb)
416{
417 if (urb->status)
418 dev_err(&urb->dev->dev, "cmd cmplt err %d\n", urb->status);
419
420 usb_free_urb(urb);
421}
422
423static struct urb *uas_alloc_data_urb(struct uas_dev_info *devinfo, gfp_t gfp,
424 struct scsi_cmnd *cmnd,
425 enum dma_data_direction dir)
426{
427 struct usb_device *udev = devinfo->udev;
428 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
429 struct urb *urb = usb_alloc_urb(0, gfp);
430 struct scsi_data_buffer *sdb = (dir == DMA_FROM_DEVICE)
431 ? scsi_in(cmnd) : scsi_out(cmnd);
432 unsigned int pipe = (dir == DMA_FROM_DEVICE)
433 ? devinfo->data_in_pipe : devinfo->data_out_pipe;
434
435 if (!urb)
436 goto out;
437 usb_fill_bulk_urb(urb, udev, pipe, NULL, sdb->length,
438 uas_data_cmplt, cmnd);
439 if (devinfo->use_streams)
440 urb->stream_id = cmdinfo->uas_tag;
441 urb->num_sgs = udev->bus->sg_tablesize ? sdb->table.nents : 0;
442 urb->sg = sdb->table.sgl;
443 out:
444 return urb;
445}
446
447static struct urb *uas_alloc_sense_urb(struct uas_dev_info *devinfo, gfp_t gfp,
448 struct scsi_cmnd *cmnd)
449{
450 struct usb_device *udev = devinfo->udev;
451 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
452 struct urb *urb = usb_alloc_urb(0, gfp);
453 struct sense_iu *iu;
454
455 if (!urb)
456 goto out;
457
458 iu = kzalloc(sizeof(*iu), gfp);
459 if (!iu)
460 goto free;
461
462 usb_fill_bulk_urb(urb, udev, devinfo->status_pipe, iu, sizeof(*iu),
463 uas_stat_cmplt, cmnd->device->host);
464 if (devinfo->use_streams)
465 urb->stream_id = cmdinfo->uas_tag;
466 urb->transfer_flags |= URB_FREE_BUFFER;
467 out:
468 return urb;
469 free:
470 usb_free_urb(urb);
471 return NULL;
472}
473
474static struct urb *uas_alloc_cmd_urb(struct uas_dev_info *devinfo, gfp_t gfp,
475 struct scsi_cmnd *cmnd)
476{
477 struct usb_device *udev = devinfo->udev;
478 struct scsi_device *sdev = cmnd->device;
479 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
480 struct urb *urb = usb_alloc_urb(0, gfp);
481 struct command_iu *iu;
482 int len;
483
484 if (!urb)
485 goto out;
486
487 len = cmnd->cmd_len - 16;
488 if (len < 0)
489 len = 0;
490 len = ALIGN(len, 4);
491 iu = kzalloc(sizeof(*iu) + len, gfp);
492 if (!iu)
493 goto free;
494
495 iu->iu_id = IU_ID_COMMAND;
496 iu->tag = cpu_to_be16(cmdinfo->uas_tag);
497 iu->prio_attr = UAS_SIMPLE_TAG;
498 iu->len = len;
499 int_to_scsilun(sdev->lun, &iu->lun);
500 memcpy(iu->cdb, cmnd->cmnd, cmnd->cmd_len);
501
502 usb_fill_bulk_urb(urb, udev, devinfo->cmd_pipe, iu, sizeof(*iu) + len,
503 uas_cmd_cmplt, NULL);
504 urb->transfer_flags |= URB_FREE_BUFFER;
505 out:
506 return urb;
507 free:
508 usb_free_urb(urb);
509 return NULL;
510}
511
512/*
513 * Why should I request the Status IU before sending the Command IU? Spec
514 * says to, but also says the device may receive them in any order. Seems
515 * daft to me.
516 */
517
518static struct urb *uas_submit_sense_urb(struct scsi_cmnd *cmnd, gfp_t gfp)
519{
520 struct uas_dev_info *devinfo = cmnd->device->hostdata;
521 struct urb *urb;
522 int err;
523
524 urb = uas_alloc_sense_urb(devinfo, gfp, cmnd);
525 if (!urb)
526 return NULL;
527 usb_anchor_urb(urb, &devinfo->sense_urbs);
528 err = usb_submit_urb(urb, gfp);
529 if (err) {
530 usb_unanchor_urb(urb);
531 uas_log_cmd_state(cmnd, "sense submit err", err);
532 usb_free_urb(urb);
533 return NULL;
534 }
535 return urb;
536}
537
538static int uas_submit_urbs(struct scsi_cmnd *cmnd,
539 struct uas_dev_info *devinfo)
540{
541 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
542 struct urb *urb;
543 int err;
544
545 lockdep_assert_held(&devinfo->lock);
546 if (cmdinfo->state & SUBMIT_STATUS_URB) {
547 urb = uas_submit_sense_urb(cmnd, GFP_ATOMIC);
548 if (!urb)
549 return SCSI_MLQUEUE_DEVICE_BUSY;
550 cmdinfo->state &= ~SUBMIT_STATUS_URB;
551 }
552
553 if (cmdinfo->state & ALLOC_DATA_IN_URB) {
554 cmdinfo->data_in_urb = uas_alloc_data_urb(devinfo, GFP_ATOMIC,
555 cmnd, DMA_FROM_DEVICE);
556 if (!cmdinfo->data_in_urb)
557 return SCSI_MLQUEUE_DEVICE_BUSY;
558 cmdinfo->state &= ~ALLOC_DATA_IN_URB;
559 }
560
561 if (cmdinfo->state & SUBMIT_DATA_IN_URB) {
562 usb_anchor_urb(cmdinfo->data_in_urb, &devinfo->data_urbs);
563 err = usb_submit_urb(cmdinfo->data_in_urb, GFP_ATOMIC);
564 if (err) {
565 usb_unanchor_urb(cmdinfo->data_in_urb);
566 uas_log_cmd_state(cmnd, "data in submit err", err);
567 return SCSI_MLQUEUE_DEVICE_BUSY;
568 }
569 cmdinfo->state &= ~SUBMIT_DATA_IN_URB;
570 cmdinfo->state |= DATA_IN_URB_INFLIGHT;
571 }
572
573 if (cmdinfo->state & ALLOC_DATA_OUT_URB) {
574 cmdinfo->data_out_urb = uas_alloc_data_urb(devinfo, GFP_ATOMIC,
575 cmnd, DMA_TO_DEVICE);
576 if (!cmdinfo->data_out_urb)
577 return SCSI_MLQUEUE_DEVICE_BUSY;
578 cmdinfo->state &= ~ALLOC_DATA_OUT_URB;
579 }
580
581 if (cmdinfo->state & SUBMIT_DATA_OUT_URB) {
582 usb_anchor_urb(cmdinfo->data_out_urb, &devinfo->data_urbs);
583 err = usb_submit_urb(cmdinfo->data_out_urb, GFP_ATOMIC);
584 if (err) {
585 usb_unanchor_urb(cmdinfo->data_out_urb);
586 uas_log_cmd_state(cmnd, "data out submit err", err);
587 return SCSI_MLQUEUE_DEVICE_BUSY;
588 }
589 cmdinfo->state &= ~SUBMIT_DATA_OUT_URB;
590 cmdinfo->state |= DATA_OUT_URB_INFLIGHT;
591 }
592
593 if (cmdinfo->state & ALLOC_CMD_URB) {
594 cmdinfo->cmd_urb = uas_alloc_cmd_urb(devinfo, GFP_ATOMIC, cmnd);
595 if (!cmdinfo->cmd_urb)
596 return SCSI_MLQUEUE_DEVICE_BUSY;
597 cmdinfo->state &= ~ALLOC_CMD_URB;
598 }
599
600 if (cmdinfo->state & SUBMIT_CMD_URB) {
601 usb_anchor_urb(cmdinfo->cmd_urb, &devinfo->cmd_urbs);
602 err = usb_submit_urb(cmdinfo->cmd_urb, GFP_ATOMIC);
603 if (err) {
604 usb_unanchor_urb(cmdinfo->cmd_urb);
605 uas_log_cmd_state(cmnd, "cmd submit err", err);
606 return SCSI_MLQUEUE_DEVICE_BUSY;
607 }
608 cmdinfo->cmd_urb = NULL;
609 cmdinfo->state &= ~SUBMIT_CMD_URB;
610 cmdinfo->state |= COMMAND_INFLIGHT;
611 }
612
613 return 0;
614}
615
616static int uas_queuecommand_lck(struct scsi_cmnd *cmnd,
617 void (*done)(struct scsi_cmnd *))
618{
619 struct scsi_device *sdev = cmnd->device;
620 struct uas_dev_info *devinfo = sdev->hostdata;
621 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
622 unsigned long flags;
623 int idx, err;
624
625 BUILD_BUG_ON(sizeof(struct uas_cmd_info) > sizeof(struct scsi_pointer));
626
627 /* Re-check scsi_block_requests now that we've the host-lock */
628 if (cmnd->device->host->host_self_blocked)
629 return SCSI_MLQUEUE_DEVICE_BUSY;
630
631 if ((devinfo->flags & US_FL_NO_ATA_1X) &&
632 (cmnd->cmnd[0] == ATA_12 || cmnd->cmnd[0] == ATA_16)) {
633 memcpy(cmnd->sense_buffer, usb_stor_sense_invalidCDB,
634 sizeof(usb_stor_sense_invalidCDB));
635 cmnd->result = SAM_STAT_CHECK_CONDITION;
636 cmnd->scsi_done(cmnd);
637 return 0;
638 }
639
640 spin_lock_irqsave(&devinfo->lock, flags);
641
642 if (devinfo->resetting) {
643 cmnd->result = DID_ERROR << 16;
644 cmnd->scsi_done(cmnd);
645 spin_unlock_irqrestore(&devinfo->lock, flags);
646 return 0;
647 }
648
649 /* Find a free uas-tag */
650 for (idx = 0; idx < devinfo->qdepth; idx++) {
651 if (!devinfo->cmnd[idx])
652 break;
653 }
654 if (idx == devinfo->qdepth) {
655 spin_unlock_irqrestore(&devinfo->lock, flags);
656 return SCSI_MLQUEUE_DEVICE_BUSY;
657 }
658
659 cmnd->scsi_done = done;
660
661 memset(cmdinfo, 0, sizeof(*cmdinfo));
662 cmdinfo->uas_tag = idx + 1; /* uas-tag == usb-stream-id, so 1 based */
663 cmdinfo->state = SUBMIT_STATUS_URB | ALLOC_CMD_URB | SUBMIT_CMD_URB;
664
665 switch (cmnd->sc_data_direction) {
666 case DMA_FROM_DEVICE:
667 cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
668 break;
669 case DMA_BIDIRECTIONAL:
670 cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
671 case DMA_TO_DEVICE:
672 cmdinfo->state |= ALLOC_DATA_OUT_URB | SUBMIT_DATA_OUT_URB;
673 case DMA_NONE:
674 break;
675 }
676
677 if (!devinfo->use_streams)
678 cmdinfo->state &= ~(SUBMIT_DATA_IN_URB | SUBMIT_DATA_OUT_URB);
679
680 err = uas_submit_urbs(cmnd, devinfo);
681 if (err) {
682 /* If we did nothing, give up now */
683 if (cmdinfo->state & SUBMIT_STATUS_URB) {
684 spin_unlock_irqrestore(&devinfo->lock, flags);
685 return SCSI_MLQUEUE_DEVICE_BUSY;
686 }
687 uas_add_work(cmdinfo);
688 }
689
690 devinfo->cmnd[idx] = cmnd;
691 spin_unlock_irqrestore(&devinfo->lock, flags);
692 return 0;
693}
694
695static DEF_SCSI_QCMD(uas_queuecommand)
696
697/*
698 * For now we do not support actually sending an abort to the device, so
699 * this eh always fails. Still we must define it to make sure that we've
700 * dropped all references to the cmnd in question once this function exits.
701 */
702static int uas_eh_abort_handler(struct scsi_cmnd *cmnd)
703{
704 struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
705 struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
706 struct urb *data_in_urb = NULL;
707 struct urb *data_out_urb = NULL;
708 unsigned long flags;
709
710 spin_lock_irqsave(&devinfo->lock, flags);
711
712 uas_log_cmd_state(cmnd, __func__, 0);
713
714 /* Ensure that try_complete does not call scsi_done */
715 cmdinfo->state |= COMMAND_ABORTED;
716
717 /* Drop all refs to this cmnd, kill data urbs to break their ref */
718 devinfo->cmnd[cmdinfo->uas_tag - 1] = NULL;
719 if (cmdinfo->state & DATA_IN_URB_INFLIGHT)
720 data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
721 if (cmdinfo->state & DATA_OUT_URB_INFLIGHT)
722 data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
723
724 uas_free_unsubmitted_urbs(cmnd);
725
726 spin_unlock_irqrestore(&devinfo->lock, flags);
727
728 if (data_in_urb) {
729 usb_kill_urb(data_in_urb);
730 usb_put_urb(data_in_urb);
731 }
732 if (data_out_urb) {
733 usb_kill_urb(data_out_urb);
734 usb_put_urb(data_out_urb);
735 }
736
737 return FAILED;
738}
739
740static int uas_eh_bus_reset_handler(struct scsi_cmnd *cmnd)
741{
742 struct scsi_device *sdev = cmnd->device;
743 struct uas_dev_info *devinfo = sdev->hostdata;
744 struct usb_device *udev = devinfo->udev;
745 unsigned long flags;
746 int err;
747
748 err = usb_lock_device_for_reset(udev, devinfo->intf);
749 if (err) {
750 shost_printk(KERN_ERR, sdev->host,
751 "%s FAILED to get lock err %d\n", __func__, err);
752 return FAILED;
753 }
754
755 shost_printk(KERN_INFO, sdev->host, "%s start\n", __func__);
756
757 spin_lock_irqsave(&devinfo->lock, flags);
758 devinfo->resetting = 1;
759 spin_unlock_irqrestore(&devinfo->lock, flags);
760
761 usb_kill_anchored_urbs(&devinfo->cmd_urbs);
762 usb_kill_anchored_urbs(&devinfo->sense_urbs);
763 usb_kill_anchored_urbs(&devinfo->data_urbs);
764 uas_zap_pending(devinfo, DID_RESET);
765
766 err = usb_reset_device(udev);
767
768 spin_lock_irqsave(&devinfo->lock, flags);
769 devinfo->resetting = 0;
770 spin_unlock_irqrestore(&devinfo->lock, flags);
771
772 usb_unlock_device(udev);
773
774 if (err) {
775 shost_printk(KERN_INFO, sdev->host, "%s FAILED err %d\n",
776 __func__, err);
777 return FAILED;
778 }
779
780 shost_printk(KERN_INFO, sdev->host, "%s success\n", __func__);
781 return SUCCESS;
782}
783
784static int uas_target_alloc(struct scsi_target *starget)
785{
786 struct uas_dev_info *devinfo = (struct uas_dev_info *)
787 dev_to_shost(starget->dev.parent)->hostdata;
788
789 if (devinfo->flags & US_FL_NO_REPORT_LUNS)
790 starget->no_report_luns = 1;
791
792 return 0;
793}
794
795static int uas_slave_alloc(struct scsi_device *sdev)
796{
797 struct uas_dev_info *devinfo =
798 (struct uas_dev_info *)sdev->host->hostdata;
799
800 sdev->hostdata = devinfo;
801
802 /*
803 * USB has unusual DMA-alignment requirements: Although the
804 * starting address of each scatter-gather element doesn't matter,
805 * the length of each element except the last must be divisible
806 * by the Bulk maxpacket value. There's currently no way to
807 * express this by block-layer constraints, so we'll cop out
808 * and simply require addresses to be aligned at 512-byte
809 * boundaries. This is okay since most block I/O involves
810 * hardware sectors that are multiples of 512 bytes in length,
811 * and since host controllers up through USB 2.0 have maxpacket
812 * values no larger than 512.
813 *
814 * But it doesn't suffice for Wireless USB, where Bulk maxpacket
815 * values can be as large as 2048. To make that work properly
816 * will require changes to the block layer.
817 */
818 blk_queue_update_dma_alignment(sdev->request_queue, (512 - 1));
819
820 if (devinfo->flags & US_FL_MAX_SECTORS_64)
821 blk_queue_max_hw_sectors(sdev->request_queue, 64);
822 else if (devinfo->flags & US_FL_MAX_SECTORS_240)
823 blk_queue_max_hw_sectors(sdev->request_queue, 240);
824
825 return 0;
826}
827
828static int uas_slave_configure(struct scsi_device *sdev)
829{
830 struct uas_dev_info *devinfo = sdev->hostdata;
831
832 if (devinfo->flags & US_FL_NO_REPORT_OPCODES)
833 sdev->no_report_opcodes = 1;
834
835 /* A few buggy USB-ATA bridges don't understand FUA */
836 if (devinfo->flags & US_FL_BROKEN_FUA)
837 sdev->broken_fua = 1;
838
839 scsi_change_queue_depth(sdev, devinfo->qdepth - 2);
840 return 0;
841}
842
843static struct scsi_host_template uas_host_template = {
844 .module = THIS_MODULE,
845 .name = "uas",
846 .queuecommand = uas_queuecommand,
847 .target_alloc = uas_target_alloc,
848 .slave_alloc = uas_slave_alloc,
849 .slave_configure = uas_slave_configure,
850 .eh_abort_handler = uas_eh_abort_handler,
851 .eh_bus_reset_handler = uas_eh_bus_reset_handler,
852 .this_id = -1,
853 .sg_tablesize = SG_NONE,
854 .skip_settle_delay = 1,
855};
856
857#define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \
858 vendorName, productName, useProtocol, useTransport, \
859 initFunction, flags) \
860{ USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax), \
861 .driver_info = (flags) }
862
863static struct usb_device_id uas_usb_ids[] = {
864# include "unusual_uas.h"
865 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_BULK) },
866 { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_UAS) },
867 { }
868};
869MODULE_DEVICE_TABLE(usb, uas_usb_ids);
870
871#undef UNUSUAL_DEV
872
873static int uas_switch_interface(struct usb_device *udev,
874 struct usb_interface *intf)
875{
876 int alt;
877
878 alt = uas_find_uas_alt_setting(intf);
879 if (alt < 0)
880 return alt;
881
882 return usb_set_interface(udev,
883 intf->altsetting[0].desc.bInterfaceNumber, alt);
884}
885
886static int uas_configure_endpoints(struct uas_dev_info *devinfo)
887{
888 struct usb_host_endpoint *eps[4] = { };
889 struct usb_device *udev = devinfo->udev;
890 int r;
891
892 r = uas_find_endpoints(devinfo->intf->cur_altsetting, eps);
893 if (r)
894 return r;
895
896 devinfo->cmd_pipe = usb_sndbulkpipe(udev,
897 usb_endpoint_num(&eps[0]->desc));
898 devinfo->status_pipe = usb_rcvbulkpipe(udev,
899 usb_endpoint_num(&eps[1]->desc));
900 devinfo->data_in_pipe = usb_rcvbulkpipe(udev,
901 usb_endpoint_num(&eps[2]->desc));
902 devinfo->data_out_pipe = usb_sndbulkpipe(udev,
903 usb_endpoint_num(&eps[3]->desc));
904
905 if (udev->speed < USB_SPEED_SUPER) {
906 devinfo->qdepth = 32;
907 devinfo->use_streams = 0;
908 } else {
909 devinfo->qdepth = usb_alloc_streams(devinfo->intf, eps + 1,
910 3, MAX_CMNDS, GFP_NOIO);
911 if (devinfo->qdepth < 0)
912 return devinfo->qdepth;
913 devinfo->use_streams = 1;
914 }
915
916 return 0;
917}
918
919static void uas_free_streams(struct uas_dev_info *devinfo)
920{
921 struct usb_device *udev = devinfo->udev;
922 struct usb_host_endpoint *eps[3];
923
924 eps[0] = usb_pipe_endpoint(udev, devinfo->status_pipe);
925 eps[1] = usb_pipe_endpoint(udev, devinfo->data_in_pipe);
926 eps[2] = usb_pipe_endpoint(udev, devinfo->data_out_pipe);
927 usb_free_streams(devinfo->intf, eps, 3, GFP_NOIO);
928}
929
930static int uas_probe(struct usb_interface *intf, const struct usb_device_id *id)
931{
932 int result = -ENOMEM;
933 struct Scsi_Host *shost = NULL;
934 struct uas_dev_info *devinfo;
935 struct usb_device *udev = interface_to_usbdev(intf);
936 unsigned long dev_flags;
937
938 if (!uas_use_uas_driver(intf, id, &dev_flags))
939 return -ENODEV;
940
941 if (uas_switch_interface(udev, intf))
942 return -ENODEV;
943
944 shost = scsi_host_alloc(&uas_host_template,
945 sizeof(struct uas_dev_info));
946 if (!shost)
947 goto set_alt0;
948
949 shost->max_cmd_len = 16 + 252;
950 shost->max_id = 1;
951 shost->max_lun = 256;
952 shost->max_channel = 0;
953 shost->sg_tablesize = udev->bus->sg_tablesize;
954
955 devinfo = (struct uas_dev_info *)shost->hostdata;
956 devinfo->intf = intf;
957 devinfo->udev = udev;
958 devinfo->resetting = 0;
959 devinfo->shutdown = 0;
960 devinfo->flags = dev_flags;
961 init_usb_anchor(&devinfo->cmd_urbs);
962 init_usb_anchor(&devinfo->sense_urbs);
963 init_usb_anchor(&devinfo->data_urbs);
964 spin_lock_init(&devinfo->lock);
965 INIT_WORK(&devinfo->work, uas_do_work);
966
967 result = uas_configure_endpoints(devinfo);
968 if (result)
969 goto set_alt0;
970
971 /*
972 * 1 tag is reserved for untagged commands +
973 * 1 tag to avoid off by one errors in some bridge firmwares
974 */
975 shost->can_queue = devinfo->qdepth - 2;
976
977 usb_set_intfdata(intf, shost);
978 result = scsi_add_host(shost, &intf->dev);
979 if (result)
980 goto free_streams;
981
982 scsi_scan_host(shost);
983 return result;
984
985free_streams:
986 uas_free_streams(devinfo);
987 usb_set_intfdata(intf, NULL);
988set_alt0:
989 usb_set_interface(udev, intf->altsetting[0].desc.bInterfaceNumber, 0);
990 if (shost)
991 scsi_host_put(shost);
992 return result;
993}
994
995static int uas_cmnd_list_empty(struct uas_dev_info *devinfo)
996{
997 unsigned long flags;
998 int i, r = 1;
999
1000 spin_lock_irqsave(&devinfo->lock, flags);
1001
1002 for (i = 0; i < devinfo->qdepth; i++) {
1003 if (devinfo->cmnd[i]) {
1004 r = 0; /* Not empty */
1005 break;
1006 }
1007 }
1008
1009 spin_unlock_irqrestore(&devinfo->lock, flags);
1010
1011 return r;
1012}
1013
1014/*
1015 * Wait for any pending cmnds to complete, on usb-2 sense_urbs may temporarily
1016 * get empty while there still is more work to do due to sense-urbs completing
1017 * with a READ/WRITE_READY iu code, so keep waiting until the list gets empty.
1018 */
1019static int uas_wait_for_pending_cmnds(struct uas_dev_info *devinfo)
1020{
1021 unsigned long start_time;
1022 int r;
1023
1024 start_time = jiffies;
1025 do {
1026 flush_work(&devinfo->work);
1027
1028 r = usb_wait_anchor_empty_timeout(&devinfo->sense_urbs, 5000);
1029 if (r == 0)
1030 return -ETIME;
1031
1032 r = usb_wait_anchor_empty_timeout(&devinfo->data_urbs, 500);
1033 if (r == 0)
1034 return -ETIME;
1035
1036 if (time_after(jiffies, start_time + 5 * HZ))
1037 return -ETIME;
1038 } while (!uas_cmnd_list_empty(devinfo));
1039
1040 return 0;
1041}
1042
1043static int uas_pre_reset(struct usb_interface *intf)
1044{
1045 struct Scsi_Host *shost = usb_get_intfdata(intf);
1046 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1047 unsigned long flags;
1048
1049 if (devinfo->shutdown)
1050 return 0;
1051
1052 /* Block new requests */
1053 spin_lock_irqsave(shost->host_lock, flags);
1054 scsi_block_requests(shost);
1055 spin_unlock_irqrestore(shost->host_lock, flags);
1056
1057 if (uas_wait_for_pending_cmnds(devinfo) != 0) {
1058 shost_printk(KERN_ERR, shost, "%s: timed out\n", __func__);
1059 scsi_unblock_requests(shost);
1060 return 1;
1061 }
1062
1063 uas_free_streams(devinfo);
1064
1065 return 0;
1066}
1067
1068static int uas_post_reset(struct usb_interface *intf)
1069{
1070 struct Scsi_Host *shost = usb_get_intfdata(intf);
1071 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1072 unsigned long flags;
1073 int err;
1074
1075 if (devinfo->shutdown)
1076 return 0;
1077
1078 err = uas_configure_endpoints(devinfo);
1079 if (err) {
1080 shost_printk(KERN_ERR, shost,
1081 "%s: alloc streams error %d after reset",
1082 __func__, err);
1083 return 1;
1084 }
1085
1086 spin_lock_irqsave(shost->host_lock, flags);
1087 scsi_report_bus_reset(shost, 0);
1088 spin_unlock_irqrestore(shost->host_lock, flags);
1089
1090 scsi_unblock_requests(shost);
1091
1092 return 0;
1093}
1094
1095static int uas_suspend(struct usb_interface *intf, pm_message_t message)
1096{
1097 struct Scsi_Host *shost = usb_get_intfdata(intf);
1098 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1099
1100 if (uas_wait_for_pending_cmnds(devinfo) != 0) {
1101 shost_printk(KERN_ERR, shost, "%s: timed out\n", __func__);
1102 return -ETIME;
1103 }
1104
1105 return 0;
1106}
1107
1108static int uas_resume(struct usb_interface *intf)
1109{
1110 return 0;
1111}
1112
1113static int uas_reset_resume(struct usb_interface *intf)
1114{
1115 struct Scsi_Host *shost = usb_get_intfdata(intf);
1116 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1117 unsigned long flags;
1118 int err;
1119
1120 err = uas_configure_endpoints(devinfo);
1121 if (err) {
1122 shost_printk(KERN_ERR, shost,
1123 "%s: alloc streams error %d after reset",
1124 __func__, err);
1125 return -EIO;
1126 }
1127
1128 spin_lock_irqsave(shost->host_lock, flags);
1129 scsi_report_bus_reset(shost, 0);
1130 spin_unlock_irqrestore(shost->host_lock, flags);
1131
1132 return 0;
1133}
1134
1135static void uas_disconnect(struct usb_interface *intf)
1136{
1137 struct Scsi_Host *shost = usb_get_intfdata(intf);
1138 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1139 unsigned long flags;
1140
1141 spin_lock_irqsave(&devinfo->lock, flags);
1142 devinfo->resetting = 1;
1143 spin_unlock_irqrestore(&devinfo->lock, flags);
1144
1145 cancel_work_sync(&devinfo->work);
1146 usb_kill_anchored_urbs(&devinfo->cmd_urbs);
1147 usb_kill_anchored_urbs(&devinfo->sense_urbs);
1148 usb_kill_anchored_urbs(&devinfo->data_urbs);
1149 uas_zap_pending(devinfo, DID_NO_CONNECT);
1150
1151 scsi_remove_host(shost);
1152 uas_free_streams(devinfo);
1153 scsi_host_put(shost);
1154}
1155
1156/*
1157 * Put the device back in usb-storage mode on shutdown, as some BIOS-es
1158 * hang on reboot when the device is still in uas mode. Note the reset is
1159 * necessary as some devices won't revert to usb-storage mode without it.
1160 */
1161static void uas_shutdown(struct device *dev)
1162{
1163 struct usb_interface *intf = to_usb_interface(dev);
1164 struct usb_device *udev = interface_to_usbdev(intf);
1165 struct Scsi_Host *shost = usb_get_intfdata(intf);
1166 struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1167
1168 if (system_state != SYSTEM_RESTART)
1169 return;
1170
1171 devinfo->shutdown = 1;
1172 uas_free_streams(devinfo);
1173 usb_set_interface(udev, intf->altsetting[0].desc.bInterfaceNumber, 0);
1174 usb_reset_device(udev);
1175}
1176
1177static struct usb_driver uas_driver = {
1178 .name = "uas",
1179 .probe = uas_probe,
1180 .disconnect = uas_disconnect,
1181 .pre_reset = uas_pre_reset,
1182 .post_reset = uas_post_reset,
1183 .suspend = uas_suspend,
1184 .resume = uas_resume,
1185 .reset_resume = uas_reset_resume,
1186 .drvwrap.driver.shutdown = uas_shutdown,
1187 .id_table = uas_usb_ids,
1188};
1189
1190module_usb_driver(uas_driver);
1191
1192MODULE_LICENSE("GPL");
1193MODULE_AUTHOR(
1194 "Hans de Goede <hdegoede@redhat.com>, Matthew Wilcox and Sarah Sharp");