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