b27fe21d866d2eb47563e7f9eb524fbd85fe16f2
[firefly-linux-kernel-4.4.55.git] / drivers / usb / storage / uas.c
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 - 2014
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
35 struct 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
51 enum {
52         SUBMIT_STATUS_URB       = (1 << 1),
53         ALLOC_DATA_IN_URB       = (1 << 2),
54         SUBMIT_DATA_IN_URB      = (1 << 3),
55         ALLOC_DATA_OUT_URB      = (1 << 4),
56         SUBMIT_DATA_OUT_URB     = (1 << 5),
57         ALLOC_CMD_URB           = (1 << 6),
58         SUBMIT_CMD_URB          = (1 << 7),
59         COMMAND_INFLIGHT        = (1 << 8),
60         DATA_IN_URB_INFLIGHT    = (1 << 9),
61         DATA_OUT_URB_INFLIGHT   = (1 << 10),
62         COMMAND_ABORTED         = (1 << 11),
63         IS_IN_WORK_LIST         = (1 << 12),
64 };
65
66 /* Overrides scsi_pointer */
67 struct uas_cmd_info {
68         unsigned int state;
69         unsigned int stream;
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 */
76 static int uas_submit_urbs(struct scsi_cmnd *cmnd,
77                                 struct uas_dev_info *devinfo, gfp_t gfp);
78 static void uas_do_work(struct work_struct *work);
79 static int uas_try_complete(struct scsi_cmnd *cmnd, const char *caller);
80 static void uas_free_streams(struct uas_dev_info *devinfo);
81 static void uas_log_cmd_state(struct scsi_cmnd *cmnd, const char *prefix,
82                                 int status);
83
84 static 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, GFP_ATOMIC);
109                 if (!err)
110                         cmdinfo->state &= ~IS_IN_WORK_LIST;
111                 else
112                         schedule_work(&devinfo->work);
113         }
114 out:
115         spin_unlock_irqrestore(&devinfo->lock, flags);
116 }
117
118 static 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
129 static 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
153 static 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
176 /*
177  * scsi-tags go from 0 - (nr_tags - 1), uas tags need to match stream-ids,
178  * which go from 1 - nr_streams. And we use 1 for untagged commands.
179  */
180 static int uas_get_tag(struct scsi_cmnd *cmnd)
181 {
182         int tag;
183
184         if (blk_rq_tagged(cmnd->request))
185                 tag = cmnd->request->tag + 2;
186         else
187                 tag = 1;
188
189         return tag;
190 }
191
192 static void uas_log_cmd_state(struct scsi_cmnd *cmnd, const char *prefix,
193                               int status)
194 {
195         struct uas_cmd_info *ci = (void *)&cmnd->SCp;
196
197         scmd_printk(KERN_INFO, cmnd,
198                     "%s %d tag %d inflight:%s%s%s%s%s%s%s%s%s%s%s%s ",
199                     prefix, status, uas_get_tag(cmnd),
200                     (ci->state & SUBMIT_STATUS_URB)     ? " s-st"  : "",
201                     (ci->state & ALLOC_DATA_IN_URB)     ? " a-in"  : "",
202                     (ci->state & SUBMIT_DATA_IN_URB)    ? " s-in"  : "",
203                     (ci->state & ALLOC_DATA_OUT_URB)    ? " a-out" : "",
204                     (ci->state & SUBMIT_DATA_OUT_URB)   ? " s-out" : "",
205                     (ci->state & ALLOC_CMD_URB)         ? " a-cmd" : "",
206                     (ci->state & SUBMIT_CMD_URB)        ? " s-cmd" : "",
207                     (ci->state & COMMAND_INFLIGHT)      ? " CMD"   : "",
208                     (ci->state & DATA_IN_URB_INFLIGHT)  ? " IN"    : "",
209                     (ci->state & DATA_OUT_URB_INFLIGHT) ? " OUT"   : "",
210                     (ci->state & COMMAND_ABORTED)       ? " abort" : "",
211                     (ci->state & IS_IN_WORK_LIST)       ? " work"  : "");
212         scsi_print_command(cmnd);
213 }
214
215 static void uas_free_unsubmitted_urbs(struct scsi_cmnd *cmnd)
216 {
217         struct uas_cmd_info *cmdinfo;
218
219         if (!cmnd)
220                 return;
221
222         cmdinfo = (void *)&cmnd->SCp;
223
224         if (cmdinfo->state & SUBMIT_CMD_URB)
225                 usb_free_urb(cmdinfo->cmd_urb);
226
227         /* data urbs may have never gotten their submit flag set */
228         if (!(cmdinfo->state & DATA_IN_URB_INFLIGHT))
229                 usb_free_urb(cmdinfo->data_in_urb);
230         if (!(cmdinfo->state & DATA_OUT_URB_INFLIGHT))
231                 usb_free_urb(cmdinfo->data_out_urb);
232 }
233
234 static int uas_try_complete(struct scsi_cmnd *cmnd, const char *caller)
235 {
236         struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
237         struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
238
239         lockdep_assert_held(&devinfo->lock);
240         if (cmdinfo->state & (COMMAND_INFLIGHT |
241                               DATA_IN_URB_INFLIGHT |
242                               DATA_OUT_URB_INFLIGHT |
243                               COMMAND_ABORTED))
244                 return -EBUSY;
245         devinfo->cmnd[uas_get_tag(cmnd) - 1] = NULL;
246         uas_free_unsubmitted_urbs(cmnd);
247         cmnd->scsi_done(cmnd);
248         return 0;
249 }
250
251 static void uas_xfer_data(struct urb *urb, struct scsi_cmnd *cmnd,
252                           unsigned direction)
253 {
254         struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
255         int err;
256
257         cmdinfo->state |= direction | SUBMIT_STATUS_URB;
258         err = uas_submit_urbs(cmnd, cmnd->device->hostdata, GFP_ATOMIC);
259         if (err) {
260                 uas_add_work(cmdinfo);
261         }
262 }
263
264 static void uas_stat_cmplt(struct urb *urb)
265 {
266         struct iu *iu = urb->transfer_buffer;
267         struct Scsi_Host *shost = urb->context;
268         struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
269         struct urb *data_in_urb = NULL;
270         struct urb *data_out_urb = NULL;
271         struct scsi_cmnd *cmnd;
272         struct uas_cmd_info *cmdinfo;
273         unsigned long flags;
274         unsigned int idx;
275
276         spin_lock_irqsave(&devinfo->lock, flags);
277
278         if (devinfo->resetting)
279                 goto out;
280
281         if (urb->status) {
282                 if (urb->status != -ENOENT && urb->status != -ECONNRESET) {
283                         dev_err(&urb->dev->dev, "stat urb: status %d\n",
284                                 urb->status);
285                 }
286                 goto out;
287         }
288
289         idx = be16_to_cpup(&iu->tag) - 1;
290         if (idx >= MAX_CMNDS || !devinfo->cmnd[idx]) {
291                 dev_err(&urb->dev->dev,
292                         "stat urb: no pending cmd for tag %d\n", idx + 1);
293                 goto out;
294         }
295
296         cmnd = devinfo->cmnd[idx];
297         cmdinfo = (void *)&cmnd->SCp;
298
299         if (!(cmdinfo->state & COMMAND_INFLIGHT)) {
300                 uas_log_cmd_state(cmnd, "unexpected status cmplt", 0);
301                 goto out;
302         }
303
304         switch (iu->iu_id) {
305         case IU_ID_STATUS:
306                 uas_sense(urb, cmnd);
307                 if (cmnd->result != 0) {
308                         /* cancel data transfers on error */
309                         data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
310                         data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
311                 }
312                 cmdinfo->state &= ~COMMAND_INFLIGHT;
313                 uas_try_complete(cmnd, __func__);
314                 break;
315         case IU_ID_READ_READY:
316                 if (!cmdinfo->data_in_urb ||
317                                 (cmdinfo->state & DATA_IN_URB_INFLIGHT)) {
318                         uas_log_cmd_state(cmnd, "unexpected read rdy", 0);
319                         break;
320                 }
321                 uas_xfer_data(urb, cmnd, SUBMIT_DATA_IN_URB);
322                 break;
323         case IU_ID_WRITE_READY:
324                 if (!cmdinfo->data_out_urb ||
325                                 (cmdinfo->state & DATA_OUT_URB_INFLIGHT)) {
326                         uas_log_cmd_state(cmnd, "unexpected write rdy", 0);
327                         break;
328                 }
329                 uas_xfer_data(urb, cmnd, SUBMIT_DATA_OUT_URB);
330                 break;
331         case IU_ID_RESPONSE:
332                 uas_log_cmd_state(cmnd, "unexpected response iu",
333                                   ((struct response_iu *)iu)->response_code);
334                 /* Error, cancel data transfers */
335                 data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
336                 data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
337                 cmdinfo->state &= ~COMMAND_INFLIGHT;
338                 cmnd->result = DID_ERROR << 16;
339                 uas_try_complete(cmnd, __func__);
340                 break;
341         default:
342                 uas_log_cmd_state(cmnd, "bogus IU", iu->iu_id);
343         }
344 out:
345         usb_free_urb(urb);
346         spin_unlock_irqrestore(&devinfo->lock, flags);
347
348         /* Unlinking of data urbs must be done without holding the lock */
349         if (data_in_urb) {
350                 usb_unlink_urb(data_in_urb);
351                 usb_put_urb(data_in_urb);
352         }
353         if (data_out_urb) {
354                 usb_unlink_urb(data_out_urb);
355                 usb_put_urb(data_out_urb);
356         }
357 }
358
359 static void uas_data_cmplt(struct urb *urb)
360 {
361         struct scsi_cmnd *cmnd = urb->context;
362         struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
363         struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
364         struct scsi_data_buffer *sdb = NULL;
365         unsigned long flags;
366
367         spin_lock_irqsave(&devinfo->lock, flags);
368
369         if (cmdinfo->data_in_urb == urb) {
370                 sdb = scsi_in(cmnd);
371                 cmdinfo->state &= ~DATA_IN_URB_INFLIGHT;
372                 cmdinfo->data_in_urb = NULL;
373         } else if (cmdinfo->data_out_urb == urb) {
374                 sdb = scsi_out(cmnd);
375                 cmdinfo->state &= ~DATA_OUT_URB_INFLIGHT;
376                 cmdinfo->data_out_urb = NULL;
377         }
378         if (sdb == NULL) {
379                 WARN_ON_ONCE(1);
380                 goto out;
381         }
382
383         if (devinfo->resetting)
384                 goto out;
385
386         /* Data urbs should not complete before the cmd urb is submitted */
387         if (cmdinfo->state & SUBMIT_CMD_URB) {
388                 uas_log_cmd_state(cmnd, "unexpected data cmplt", 0);
389                 goto out;
390         }
391
392         if (urb->status) {
393                 if (urb->status != -ENOENT && urb->status != -ECONNRESET)
394                         uas_log_cmd_state(cmnd, "data cmplt err", urb->status);
395                 /* error: no data transfered */
396                 sdb->resid = sdb->length;
397         } else {
398                 sdb->resid = sdb->length - urb->actual_length;
399         }
400         uas_try_complete(cmnd, __func__);
401 out:
402         usb_free_urb(urb);
403         spin_unlock_irqrestore(&devinfo->lock, flags);
404 }
405
406 static void uas_cmd_cmplt(struct urb *urb)
407 {
408         if (urb->status)
409                 dev_err(&urb->dev->dev, "cmd cmplt err %d\n", urb->status);
410
411         usb_free_urb(urb);
412 }
413
414 static struct urb *uas_alloc_data_urb(struct uas_dev_info *devinfo, gfp_t gfp,
415                                       unsigned int pipe, u16 stream_id,
416                                       struct scsi_cmnd *cmnd,
417                                       enum dma_data_direction dir)
418 {
419         struct usb_device *udev = devinfo->udev;
420         struct urb *urb = usb_alloc_urb(0, gfp);
421         struct scsi_data_buffer *sdb = (dir == DMA_FROM_DEVICE)
422                 ? scsi_in(cmnd) : scsi_out(cmnd);
423
424         if (!urb)
425                 goto out;
426         usb_fill_bulk_urb(urb, udev, pipe, NULL, sdb->length,
427                           uas_data_cmplt, cmnd);
428         urb->stream_id = stream_id;
429         urb->num_sgs = udev->bus->sg_tablesize ? sdb->table.nents : 0;
430         urb->sg = sdb->table.sgl;
431  out:
432         return urb;
433 }
434
435 static struct urb *uas_alloc_sense_urb(struct uas_dev_info *devinfo, gfp_t gfp,
436                                        struct Scsi_Host *shost, u16 stream_id)
437 {
438         struct usb_device *udev = devinfo->udev;
439         struct urb *urb = usb_alloc_urb(0, gfp);
440         struct sense_iu *iu;
441
442         if (!urb)
443                 goto out;
444
445         iu = kzalloc(sizeof(*iu), gfp);
446         if (!iu)
447                 goto free;
448
449         usb_fill_bulk_urb(urb, udev, devinfo->status_pipe, iu, sizeof(*iu),
450                                                 uas_stat_cmplt, shost);
451         urb->stream_id = stream_id;
452         urb->transfer_flags |= URB_FREE_BUFFER;
453  out:
454         return urb;
455  free:
456         usb_free_urb(urb);
457         return NULL;
458 }
459
460 static struct urb *uas_alloc_cmd_urb(struct uas_dev_info *devinfo, gfp_t gfp,
461                                         struct scsi_cmnd *cmnd)
462 {
463         struct usb_device *udev = devinfo->udev;
464         struct scsi_device *sdev = cmnd->device;
465         struct urb *urb = usb_alloc_urb(0, gfp);
466         struct command_iu *iu;
467         int len;
468
469         if (!urb)
470                 goto out;
471
472         len = cmnd->cmd_len - 16;
473         if (len < 0)
474                 len = 0;
475         len = ALIGN(len, 4);
476         iu = kzalloc(sizeof(*iu) + len, gfp);
477         if (!iu)
478                 goto free;
479
480         iu->iu_id = IU_ID_COMMAND;
481         iu->tag = cpu_to_be16(uas_get_tag(cmnd));
482         iu->prio_attr = UAS_SIMPLE_TAG;
483         iu->len = len;
484         int_to_scsilun(sdev->lun, &iu->lun);
485         memcpy(iu->cdb, cmnd->cmnd, cmnd->cmd_len);
486
487         usb_fill_bulk_urb(urb, udev, devinfo->cmd_pipe, iu, sizeof(*iu) + len,
488                                                         uas_cmd_cmplt, NULL);
489         urb->transfer_flags |= URB_FREE_BUFFER;
490  out:
491         return urb;
492  free:
493         usb_free_urb(urb);
494         return NULL;
495 }
496
497 /*
498  * Why should I request the Status IU before sending the Command IU?  Spec
499  * says to, but also says the device may receive them in any order.  Seems
500  * daft to me.
501  */
502
503 static struct urb *uas_submit_sense_urb(struct scsi_cmnd *cmnd,
504                                         gfp_t gfp, unsigned int stream)
505 {
506         struct Scsi_Host *shost = cmnd->device->host;
507         struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
508         struct urb *urb;
509         int err;
510
511         urb = uas_alloc_sense_urb(devinfo, gfp, shost, stream);
512         if (!urb)
513                 return NULL;
514         usb_anchor_urb(urb, &devinfo->sense_urbs);
515         err = usb_submit_urb(urb, gfp);
516         if (err) {
517                 usb_unanchor_urb(urb);
518                 uas_log_cmd_state(cmnd, "sense submit err", err);
519                 usb_free_urb(urb);
520                 return NULL;
521         }
522         return urb;
523 }
524
525 static int uas_submit_urbs(struct scsi_cmnd *cmnd,
526                            struct uas_dev_info *devinfo, gfp_t gfp)
527 {
528         struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
529         struct urb *urb;
530         int err;
531
532         lockdep_assert_held(&devinfo->lock);
533         if (cmdinfo->state & SUBMIT_STATUS_URB) {
534                 urb = uas_submit_sense_urb(cmnd, gfp, cmdinfo->stream);
535                 if (!urb)
536                         return SCSI_MLQUEUE_DEVICE_BUSY;
537                 cmdinfo->state &= ~SUBMIT_STATUS_URB;
538         }
539
540         if (cmdinfo->state & ALLOC_DATA_IN_URB) {
541                 cmdinfo->data_in_urb = uas_alloc_data_urb(devinfo, gfp,
542                                         devinfo->data_in_pipe, cmdinfo->stream,
543                                         cmnd, DMA_FROM_DEVICE);
544                 if (!cmdinfo->data_in_urb)
545                         return SCSI_MLQUEUE_DEVICE_BUSY;
546                 cmdinfo->state &= ~ALLOC_DATA_IN_URB;
547         }
548
549         if (cmdinfo->state & SUBMIT_DATA_IN_URB) {
550                 usb_anchor_urb(cmdinfo->data_in_urb, &devinfo->data_urbs);
551                 err = usb_submit_urb(cmdinfo->data_in_urb, gfp);
552                 if (err) {
553                         usb_unanchor_urb(cmdinfo->data_in_urb);
554                         uas_log_cmd_state(cmnd, "data in submit err", err);
555                         return SCSI_MLQUEUE_DEVICE_BUSY;
556                 }
557                 cmdinfo->state &= ~SUBMIT_DATA_IN_URB;
558                 cmdinfo->state |= DATA_IN_URB_INFLIGHT;
559         }
560
561         if (cmdinfo->state & ALLOC_DATA_OUT_URB) {
562                 cmdinfo->data_out_urb = uas_alloc_data_urb(devinfo, gfp,
563                                         devinfo->data_out_pipe, cmdinfo->stream,
564                                         cmnd, DMA_TO_DEVICE);
565                 if (!cmdinfo->data_out_urb)
566                         return SCSI_MLQUEUE_DEVICE_BUSY;
567                 cmdinfo->state &= ~ALLOC_DATA_OUT_URB;
568         }
569
570         if (cmdinfo->state & SUBMIT_DATA_OUT_URB) {
571                 usb_anchor_urb(cmdinfo->data_out_urb, &devinfo->data_urbs);
572                 err = usb_submit_urb(cmdinfo->data_out_urb, gfp);
573                 if (err) {
574                         usb_unanchor_urb(cmdinfo->data_out_urb);
575                         uas_log_cmd_state(cmnd, "data out submit err", err);
576                         return SCSI_MLQUEUE_DEVICE_BUSY;
577                 }
578                 cmdinfo->state &= ~SUBMIT_DATA_OUT_URB;
579                 cmdinfo->state |= DATA_OUT_URB_INFLIGHT;
580         }
581
582         if (cmdinfo->state & ALLOC_CMD_URB) {
583                 cmdinfo->cmd_urb = uas_alloc_cmd_urb(devinfo, gfp, cmnd);
584                 if (!cmdinfo->cmd_urb)
585                         return SCSI_MLQUEUE_DEVICE_BUSY;
586                 cmdinfo->state &= ~ALLOC_CMD_URB;
587         }
588
589         if (cmdinfo->state & SUBMIT_CMD_URB) {
590                 usb_anchor_urb(cmdinfo->cmd_urb, &devinfo->cmd_urbs);
591                 err = usb_submit_urb(cmdinfo->cmd_urb, gfp);
592                 if (err) {
593                         usb_unanchor_urb(cmdinfo->cmd_urb);
594                         uas_log_cmd_state(cmnd, "cmd submit err", err);
595                         return SCSI_MLQUEUE_DEVICE_BUSY;
596                 }
597                 cmdinfo->cmd_urb = NULL;
598                 cmdinfo->state &= ~SUBMIT_CMD_URB;
599                 cmdinfo->state |= COMMAND_INFLIGHT;
600         }
601
602         return 0;
603 }
604
605 static int uas_queuecommand_lck(struct scsi_cmnd *cmnd,
606                                         void (*done)(struct scsi_cmnd *))
607 {
608         struct scsi_device *sdev = cmnd->device;
609         struct uas_dev_info *devinfo = sdev->hostdata;
610         struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
611         unsigned long flags;
612         unsigned int stream;
613         int err;
614
615         BUILD_BUG_ON(sizeof(struct uas_cmd_info) > sizeof(struct scsi_pointer));
616
617         /* Re-check scsi_block_requests now that we've the host-lock */
618         if (cmnd->device->host->host_self_blocked)
619                 return SCSI_MLQUEUE_DEVICE_BUSY;
620
621         if ((devinfo->flags & US_FL_NO_ATA_1X) &&
622                         (cmnd->cmnd[0] == ATA_12 || cmnd->cmnd[0] == ATA_16)) {
623                 memcpy(cmnd->sense_buffer, usb_stor_sense_invalidCDB,
624                        sizeof(usb_stor_sense_invalidCDB));
625                 cmnd->result = SAM_STAT_CHECK_CONDITION;
626                 cmnd->scsi_done(cmnd);
627                 return 0;
628         }
629
630         spin_lock_irqsave(&devinfo->lock, flags);
631
632         if (devinfo->resetting) {
633                 cmnd->result = DID_ERROR << 16;
634                 cmnd->scsi_done(cmnd);
635                 spin_unlock_irqrestore(&devinfo->lock, flags);
636                 return 0;
637         }
638
639         stream = uas_get_tag(cmnd);
640         if (devinfo->cmnd[stream - 1]) {
641                 spin_unlock_irqrestore(&devinfo->lock, flags);
642                 return SCSI_MLQUEUE_DEVICE_BUSY;
643         }
644
645         cmnd->scsi_done = done;
646
647         memset(cmdinfo, 0, sizeof(*cmdinfo));
648         cmdinfo->stream = stream;
649         cmdinfo->state = SUBMIT_STATUS_URB | ALLOC_CMD_URB | SUBMIT_CMD_URB;
650
651         switch (cmnd->sc_data_direction) {
652         case DMA_FROM_DEVICE:
653                 cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
654                 break;
655         case DMA_BIDIRECTIONAL:
656                 cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
657         case DMA_TO_DEVICE:
658                 cmdinfo->state |= ALLOC_DATA_OUT_URB | SUBMIT_DATA_OUT_URB;
659         case DMA_NONE:
660                 break;
661         }
662
663         if (!devinfo->use_streams) {
664                 cmdinfo->state &= ~(SUBMIT_DATA_IN_URB | SUBMIT_DATA_OUT_URB);
665                 cmdinfo->stream = 0;
666         }
667
668         err = uas_submit_urbs(cmnd, devinfo, GFP_ATOMIC);
669         if (err) {
670                 /* If we did nothing, give up now */
671                 if (cmdinfo->state & SUBMIT_STATUS_URB) {
672                         spin_unlock_irqrestore(&devinfo->lock, flags);
673                         return SCSI_MLQUEUE_DEVICE_BUSY;
674                 }
675                 uas_add_work(cmdinfo);
676         }
677
678         devinfo->cmnd[stream - 1] = cmnd;
679         spin_unlock_irqrestore(&devinfo->lock, flags);
680         return 0;
681 }
682
683 static DEF_SCSI_QCMD(uas_queuecommand)
684
685 /*
686  * For now we do not support actually sending an abort to the device, so
687  * this eh always fails. Still we must define it to make sure that we've
688  * dropped all references to the cmnd in question once this function exits.
689  */
690 static int uas_eh_abort_handler(struct scsi_cmnd *cmnd)
691 {
692         struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
693         struct uas_dev_info *devinfo = (void *)cmnd->device->hostdata;
694         struct urb *data_in_urb = NULL;
695         struct urb *data_out_urb = NULL;
696         unsigned long flags;
697
698         spin_lock_irqsave(&devinfo->lock, flags);
699
700         uas_log_cmd_state(cmnd, __func__, 0);
701
702         /* Ensure that try_complete does not call scsi_done */
703         cmdinfo->state |= COMMAND_ABORTED;
704
705         /* Drop all refs to this cmnd, kill data urbs to break their ref */
706         devinfo->cmnd[uas_get_tag(cmnd) - 1] = NULL;
707         if (cmdinfo->state & DATA_IN_URB_INFLIGHT)
708                 data_in_urb = usb_get_urb(cmdinfo->data_in_urb);
709         if (cmdinfo->state & DATA_OUT_URB_INFLIGHT)
710                 data_out_urb = usb_get_urb(cmdinfo->data_out_urb);
711
712         uas_free_unsubmitted_urbs(cmnd);
713
714         spin_unlock_irqrestore(&devinfo->lock, flags);
715
716         if (data_in_urb) {
717                 usb_kill_urb(data_in_urb);
718                 usb_put_urb(data_in_urb);
719         }
720         if (data_out_urb) {
721                 usb_kill_urb(data_out_urb);
722                 usb_put_urb(data_out_urb);
723         }
724
725         return FAILED;
726 }
727
728 static int uas_eh_bus_reset_handler(struct scsi_cmnd *cmnd)
729 {
730         struct scsi_device *sdev = cmnd->device;
731         struct uas_dev_info *devinfo = sdev->hostdata;
732         struct usb_device *udev = devinfo->udev;
733         unsigned long flags;
734         int err;
735
736         err = usb_lock_device_for_reset(udev, devinfo->intf);
737         if (err) {
738                 shost_printk(KERN_ERR, sdev->host,
739                              "%s FAILED to get lock err %d\n", __func__, err);
740                 return FAILED;
741         }
742
743         shost_printk(KERN_INFO, sdev->host, "%s start\n", __func__);
744
745         spin_lock_irqsave(&devinfo->lock, flags);
746         devinfo->resetting = 1;
747         spin_unlock_irqrestore(&devinfo->lock, flags);
748
749         usb_kill_anchored_urbs(&devinfo->cmd_urbs);
750         usb_kill_anchored_urbs(&devinfo->sense_urbs);
751         usb_kill_anchored_urbs(&devinfo->data_urbs);
752         uas_zap_pending(devinfo, DID_RESET);
753
754         err = usb_reset_device(udev);
755
756         spin_lock_irqsave(&devinfo->lock, flags);
757         devinfo->resetting = 0;
758         spin_unlock_irqrestore(&devinfo->lock, flags);
759
760         usb_unlock_device(udev);
761
762         if (err) {
763                 shost_printk(KERN_INFO, sdev->host, "%s FAILED err %d\n",
764                              __func__, err);
765                 return FAILED;
766         }
767
768         shost_printk(KERN_INFO, sdev->host, "%s success\n", __func__);
769         return SUCCESS;
770 }
771
772 static int uas_slave_alloc(struct scsi_device *sdev)
773 {
774         sdev->hostdata = (void *)sdev->host->hostdata;
775
776         /* USB has unusual DMA-alignment requirements: Although the
777          * starting address of each scatter-gather element doesn't matter,
778          * the length of each element except the last must be divisible
779          * by the Bulk maxpacket value.  There's currently no way to
780          * express this by block-layer constraints, so we'll cop out
781          * and simply require addresses to be aligned at 512-byte
782          * boundaries.  This is okay since most block I/O involves
783          * hardware sectors that are multiples of 512 bytes in length,
784          * and since host controllers up through USB 2.0 have maxpacket
785          * values no larger than 512.
786          *
787          * But it doesn't suffice for Wireless USB, where Bulk maxpacket
788          * values can be as large as 2048.  To make that work properly
789          * will require changes to the block layer.
790          */
791         blk_queue_update_dma_alignment(sdev->request_queue, (512 - 1));
792
793         return 0;
794 }
795
796 static int uas_slave_configure(struct scsi_device *sdev)
797 {
798         struct uas_dev_info *devinfo = sdev->hostdata;
799
800         if (devinfo->flags & US_FL_NO_REPORT_OPCODES)
801                 sdev->no_report_opcodes = 1;
802
803         scsi_set_tag_type(sdev, MSG_ORDERED_TAG);
804         scsi_activate_tcq(sdev, devinfo->qdepth - 2);
805         return 0;
806 }
807
808 static struct scsi_host_template uas_host_template = {
809         .module = THIS_MODULE,
810         .name = "uas",
811         .queuecommand = uas_queuecommand,
812         .slave_alloc = uas_slave_alloc,
813         .slave_configure = uas_slave_configure,
814         .eh_abort_handler = uas_eh_abort_handler,
815         .eh_bus_reset_handler = uas_eh_bus_reset_handler,
816         .can_queue = 65536,     /* Is there a limit on the _host_ ? */
817         .this_id = -1,
818         .sg_tablesize = SG_NONE,
819         .cmd_per_lun = 1,       /* until we override it */
820         .skip_settle_delay = 1,
821         .ordered_tag = 1,
822 };
823
824 #define UNUSUAL_DEV(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax, \
825                     vendorName, productName, useProtocol, useTransport, \
826                     initFunction, flags) \
827 { USB_DEVICE_VER(id_vendor, id_product, bcdDeviceMin, bcdDeviceMax), \
828         .driver_info = (flags) }
829
830 static struct usb_device_id uas_usb_ids[] = {
831 #       include "unusual_uas.h"
832         { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_BULK) },
833         { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_UAS) },
834         { }
835 };
836 MODULE_DEVICE_TABLE(usb, uas_usb_ids);
837
838 #undef UNUSUAL_DEV
839
840 static int uas_switch_interface(struct usb_device *udev,
841                                 struct usb_interface *intf)
842 {
843         int alt;
844
845         alt = uas_find_uas_alt_setting(intf);
846         if (alt < 0)
847                 return alt;
848
849         return usb_set_interface(udev,
850                         intf->altsetting[0].desc.bInterfaceNumber, alt);
851 }
852
853 static int uas_configure_endpoints(struct uas_dev_info *devinfo)
854 {
855         struct usb_host_endpoint *eps[4] = { };
856         struct usb_device *udev = devinfo->udev;
857         int r;
858
859         r = uas_find_endpoints(devinfo->intf->cur_altsetting, eps);
860         if (r)
861                 return r;
862
863         devinfo->cmd_pipe = usb_sndbulkpipe(udev,
864                                             usb_endpoint_num(&eps[0]->desc));
865         devinfo->status_pipe = usb_rcvbulkpipe(udev,
866                                             usb_endpoint_num(&eps[1]->desc));
867         devinfo->data_in_pipe = usb_rcvbulkpipe(udev,
868                                             usb_endpoint_num(&eps[2]->desc));
869         devinfo->data_out_pipe = usb_sndbulkpipe(udev,
870                                             usb_endpoint_num(&eps[3]->desc));
871
872         if (udev->speed < USB_SPEED_SUPER) {
873                 devinfo->qdepth = 32;
874                 devinfo->use_streams = 0;
875         } else {
876                 devinfo->qdepth = usb_alloc_streams(devinfo->intf, eps + 1,
877                                                     3, MAX_CMNDS, GFP_NOIO);
878                 if (devinfo->qdepth < 0)
879                         return devinfo->qdepth;
880                 devinfo->use_streams = 1;
881         }
882
883         return 0;
884 }
885
886 static void uas_free_streams(struct uas_dev_info *devinfo)
887 {
888         struct usb_device *udev = devinfo->udev;
889         struct usb_host_endpoint *eps[3];
890
891         eps[0] = usb_pipe_endpoint(udev, devinfo->status_pipe);
892         eps[1] = usb_pipe_endpoint(udev, devinfo->data_in_pipe);
893         eps[2] = usb_pipe_endpoint(udev, devinfo->data_out_pipe);
894         usb_free_streams(devinfo->intf, eps, 3, GFP_NOIO);
895 }
896
897 static int uas_probe(struct usb_interface *intf, const struct usb_device_id *id)
898 {
899         int result = -ENOMEM;
900         struct Scsi_Host *shost = NULL;
901         struct uas_dev_info *devinfo;
902         struct usb_device *udev = interface_to_usbdev(intf);
903
904         if (!uas_use_uas_driver(intf, id))
905                 return -ENODEV;
906
907         if (uas_switch_interface(udev, intf))
908                 return -ENODEV;
909
910         shost = scsi_host_alloc(&uas_host_template,
911                                 sizeof(struct uas_dev_info));
912         if (!shost)
913                 goto set_alt0;
914
915         shost->max_cmd_len = 16 + 252;
916         shost->max_id = 1;
917         shost->max_lun = 256;
918         shost->max_channel = 0;
919         shost->sg_tablesize = udev->bus->sg_tablesize;
920
921         devinfo = (struct uas_dev_info *)shost->hostdata;
922         devinfo->intf = intf;
923         devinfo->udev = udev;
924         devinfo->resetting = 0;
925         devinfo->shutdown = 0;
926         devinfo->flags = id->driver_info;
927         usb_stor_adjust_quirks(udev, &devinfo->flags);
928         init_usb_anchor(&devinfo->cmd_urbs);
929         init_usb_anchor(&devinfo->sense_urbs);
930         init_usb_anchor(&devinfo->data_urbs);
931         spin_lock_init(&devinfo->lock);
932         INIT_WORK(&devinfo->work, uas_do_work);
933
934         result = uas_configure_endpoints(devinfo);
935         if (result)
936                 goto set_alt0;
937
938         result = scsi_init_shared_tag_map(shost, devinfo->qdepth - 2);
939         if (result)
940                 goto free_streams;
941
942         usb_set_intfdata(intf, shost);
943         result = scsi_add_host(shost, &intf->dev);
944         if (result)
945                 goto free_streams;
946
947         scsi_scan_host(shost);
948         return result;
949
950 free_streams:
951         uas_free_streams(devinfo);
952         usb_set_intfdata(intf, NULL);
953 set_alt0:
954         usb_set_interface(udev, intf->altsetting[0].desc.bInterfaceNumber, 0);
955         if (shost)
956                 scsi_host_put(shost);
957         return result;
958 }
959
960 static int uas_cmnd_list_empty(struct uas_dev_info *devinfo)
961 {
962         unsigned long flags;
963         int i, r = 1;
964
965         spin_lock_irqsave(&devinfo->lock, flags);
966
967         for (i = 0; i < devinfo->qdepth; i++) {
968                 if (devinfo->cmnd[i]) {
969                         r = 0; /* Not empty */
970                         break;
971                 }
972         }
973
974         spin_unlock_irqrestore(&devinfo->lock, flags);
975
976         return r;
977 }
978
979 /*
980  * Wait for any pending cmnds to complete, on usb-2 sense_urbs may temporarily
981  * get empty while there still is more work to do due to sense-urbs completing
982  * with a READ/WRITE_READY iu code, so keep waiting until the list gets empty.
983  */
984 static int uas_wait_for_pending_cmnds(struct uas_dev_info *devinfo)
985 {
986         unsigned long start_time;
987         int r;
988
989         start_time = jiffies;
990         do {
991                 flush_work(&devinfo->work);
992
993                 r = usb_wait_anchor_empty_timeout(&devinfo->sense_urbs, 5000);
994                 if (r == 0)
995                         return -ETIME;
996
997                 r = usb_wait_anchor_empty_timeout(&devinfo->data_urbs, 500);
998                 if (r == 0)
999                         return -ETIME;
1000
1001                 if (time_after(jiffies, start_time + 5 * HZ))
1002                         return -ETIME;
1003         } while (!uas_cmnd_list_empty(devinfo));
1004
1005         return 0;
1006 }
1007
1008 static int uas_pre_reset(struct usb_interface *intf)
1009 {
1010         struct Scsi_Host *shost = usb_get_intfdata(intf);
1011         struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1012         unsigned long flags;
1013
1014         if (devinfo->shutdown)
1015                 return 0;
1016
1017         /* Block new requests */
1018         spin_lock_irqsave(shost->host_lock, flags);
1019         scsi_block_requests(shost);
1020         spin_unlock_irqrestore(shost->host_lock, flags);
1021
1022         if (uas_wait_for_pending_cmnds(devinfo) != 0) {
1023                 shost_printk(KERN_ERR, shost, "%s: timed out\n", __func__);
1024                 scsi_unblock_requests(shost);
1025                 return 1;
1026         }
1027
1028         uas_free_streams(devinfo);
1029
1030         return 0;
1031 }
1032
1033 static int uas_post_reset(struct usb_interface *intf)
1034 {
1035         struct Scsi_Host *shost = usb_get_intfdata(intf);
1036         struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1037         unsigned long flags;
1038         int err;
1039
1040         if (devinfo->shutdown)
1041                 return 0;
1042
1043         err = uas_configure_endpoints(devinfo);
1044         if (err) {
1045                 shost_printk(KERN_ERR, shost,
1046                              "%s: alloc streams error %d after reset",
1047                              __func__, err);
1048                 return 1;
1049         }
1050
1051         spin_lock_irqsave(shost->host_lock, flags);
1052         scsi_report_bus_reset(shost, 0);
1053         spin_unlock_irqrestore(shost->host_lock, flags);
1054
1055         scsi_unblock_requests(shost);
1056
1057         return 0;
1058 }
1059
1060 static int uas_suspend(struct usb_interface *intf, pm_message_t message)
1061 {
1062         struct Scsi_Host *shost = usb_get_intfdata(intf);
1063         struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1064
1065         if (uas_wait_for_pending_cmnds(devinfo) != 0) {
1066                 shost_printk(KERN_ERR, shost, "%s: timed out\n", __func__);
1067                 return -ETIME;
1068         }
1069
1070         return 0;
1071 }
1072
1073 static int uas_resume(struct usb_interface *intf)
1074 {
1075         return 0;
1076 }
1077
1078 static int uas_reset_resume(struct usb_interface *intf)
1079 {
1080         struct Scsi_Host *shost = usb_get_intfdata(intf);
1081         struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1082         unsigned long flags;
1083         int err;
1084
1085         err = uas_configure_endpoints(devinfo);
1086         if (err) {
1087                 shost_printk(KERN_ERR, shost,
1088                              "%s: alloc streams error %d after reset",
1089                              __func__, err);
1090                 return -EIO;
1091         }
1092
1093         spin_lock_irqsave(shost->host_lock, flags);
1094         scsi_report_bus_reset(shost, 0);
1095         spin_unlock_irqrestore(shost->host_lock, flags);
1096
1097         return 0;
1098 }
1099
1100 static void uas_disconnect(struct usb_interface *intf)
1101 {
1102         struct Scsi_Host *shost = usb_get_intfdata(intf);
1103         struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1104         unsigned long flags;
1105
1106         spin_lock_irqsave(&devinfo->lock, flags);
1107         devinfo->resetting = 1;
1108         spin_unlock_irqrestore(&devinfo->lock, flags);
1109
1110         cancel_work_sync(&devinfo->work);
1111         usb_kill_anchored_urbs(&devinfo->cmd_urbs);
1112         usb_kill_anchored_urbs(&devinfo->sense_urbs);
1113         usb_kill_anchored_urbs(&devinfo->data_urbs);
1114         uas_zap_pending(devinfo, DID_NO_CONNECT);
1115
1116         scsi_remove_host(shost);
1117         uas_free_streams(devinfo);
1118         scsi_host_put(shost);
1119 }
1120
1121 /*
1122  * Put the device back in usb-storage mode on shutdown, as some BIOS-es
1123  * hang on reboot when the device is still in uas mode. Note the reset is
1124  * necessary as some devices won't revert to usb-storage mode without it.
1125  */
1126 static void uas_shutdown(struct device *dev)
1127 {
1128         struct usb_interface *intf = to_usb_interface(dev);
1129         struct usb_device *udev = interface_to_usbdev(intf);
1130         struct Scsi_Host *shost = usb_get_intfdata(intf);
1131         struct uas_dev_info *devinfo = (struct uas_dev_info *)shost->hostdata;
1132
1133         if (system_state != SYSTEM_RESTART)
1134                 return;
1135
1136         devinfo->shutdown = 1;
1137         uas_free_streams(devinfo);
1138         usb_set_interface(udev, intf->altsetting[0].desc.bInterfaceNumber, 0);
1139         usb_reset_device(udev);
1140 }
1141
1142 static struct usb_driver uas_driver = {
1143         .name = "uas",
1144         .probe = uas_probe,
1145         .disconnect = uas_disconnect,
1146         .pre_reset = uas_pre_reset,
1147         .post_reset = uas_post_reset,
1148         .suspend = uas_suspend,
1149         .resume = uas_resume,
1150         .reset_resume = uas_reset_resume,
1151         .drvwrap.driver.shutdown = uas_shutdown,
1152         .id_table = uas_usb_ids,
1153 };
1154
1155 module_usb_driver(uas_driver);
1156
1157 MODULE_LICENSE("GPL");
1158 MODULE_AUTHOR(
1159         "Hans de Goede <hdegoede@redhat.com>, Matthew Wilcox and Sarah Sharp");