OSDN Git Service

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