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