drivers/usb/storage/uas.c

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