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