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 Matthew Wilcox for Intel Corp, 2010
   6  * Copyright Sarah Sharp for Intel Corp, 2010
   7  *
   8  * Distributed under the terms of the GNU GPL, version two.
   9  */
  10
  11 #include <linux/blkdev.h>
  12 #include <linux/slab.h>
  13 #include <linux/types.h>
  14 #include <linux/usb.h>
  15 #include <linux/usb/storage.h>
  16
  17 #include <scsi/scsi.h>
  18 #include <scsi/scsi_dbg.h>
  19 #include <scsi/scsi_cmnd.h>
  20 #include <scsi/scsi_device.h>
  21 #include <scsi/scsi_host.h>
  22 #include <scsi/scsi_tcq.h>
  23
  24 /* Common header for all IUs */
  25 struct iu {
  26         __u8 iu_id;
  27         __u8 rsvd1;
  28         __be16 tag;
  29 };
  30
  31 enum {
  32         IU_ID_COMMAND           = 0x01,
  33         IU_ID_STATUS            = 0x03,
  34         IU_ID_RESPONSE          = 0x04,
  35         IU_ID_TASK_MGMT         = 0x05,
  36         IU_ID_READ_READY        = 0x06,
  37         IU_ID_WRITE_READY       = 0x07,
  38 };
  39
  40 struct command_iu {
  41         __u8 iu_id;
  42         __u8 rsvd1;
  43         __be16 tag;
  44         __u8 prio_attr;
  45         __u8 rsvd5;
  46         __u8 len;
  47         __u8 rsvd7;
  48         struct scsi_lun lun;
  49         __u8 cdb[16];   /* XXX: Overflow-checking tools may misunderstand */
  50 };
  51
  52 /*
  53  * Also used for the Read Ready and Write Ready IUs since they have the
  54  * same first four bytes
  55  */
  56 struct sense_iu {
  57         __u8 iu_id;
  58         __u8 rsvd1;
  59         __be16 tag;
  60         __be16 status_qual;
  61         __u8 status;
  62         __u8 rsvd7[7];
  63         __be16 len;
  64         __u8 sense[SCSI_SENSE_BUFFERSIZE];
  65 };
  66
  67 /*
  68  * The r00-r01c specs define this version of the SENSE IU data structure.
  69  * It's still in use by several different firmware releases.
  70  */
  71 struct sense_iu_old {
  72         __u8 iu_id;
  73         __u8 rsvd1;
  74         __be16 tag;
  75         __be16 len;
  76         __u8 status;
  77         __u8 service_response;
  78         __u8 sense[SCSI_SENSE_BUFFERSIZE];
  79 };
  80
  81 enum {
  82         CMD_PIPE_ID             = 1,
  83         STATUS_PIPE_ID          = 2,
  84         DATA_IN_PIPE_ID         = 3,
  85         DATA_OUT_PIPE_ID        = 4,
  86
  87         UAS_SIMPLE_TAG          = 0,
  88         UAS_HEAD_TAG            = 1,
  89         UAS_ORDERED_TAG         = 2,
  90         UAS_ACA                 = 4,
  91 };
  92
  93 struct uas_dev_info {
  94         struct usb_interface *intf;
  95         struct usb_device *udev;
  96         int qdepth;
  97         unsigned cmd_pipe, status_pipe, data_in_pipe, data_out_pipe;
  98         unsigned use_streams:1;
  99         unsigned uas_sense_old:1;
 100 };
 101
 102 enum {
 103         ALLOC_STATUS_URB        = (1 << 0),
 104         SUBMIT_STATUS_URB       = (1 << 1),
 105         ALLOC_DATA_IN_URB       = (1 << 2),
 106         SUBMIT_DATA_IN_URB      = (1 << 3),
 107         ALLOC_DATA_OUT_URB      = (1 << 4),
 108         SUBMIT_DATA_OUT_URB     = (1 << 5),
 109         ALLOC_CMD_URB           = (1 << 6),
 110         SUBMIT_CMD_URB          = (1 << 7),
 111 };
 112
 113 /* Overrides scsi_pointer */
 114 struct uas_cmd_info {
 115         unsigned int state;
 116         unsigned int stream;
 117         struct urb *cmd_urb;
 118         struct urb *status_urb;
 119         struct urb *data_in_urb;
 120         struct urb *data_out_urb;
 121         struct list_head list;
 122 };
 123
 124 /* I hate forward declarations, but I actually have a loop */
 125 static int uas_submit_urbs(struct scsi_cmnd *cmnd,
 126                                 struct uas_dev_info *devinfo, gfp_t gfp);
 127
 128 static DEFINE_SPINLOCK(uas_work_lock);
 129 static LIST_HEAD(uas_work_list);
 130
 131 static void uas_do_work(struct work_struct *work)
 132 {
 133         struct uas_cmd_info *cmdinfo;
 134         struct list_head list;
 135
 136         spin_lock_irq(&uas_work_lock);
 137         list_replace_init(&uas_work_list, &list);
 138         spin_unlock_irq(&uas_work_lock);
 139
 140         list_for_each_entry(cmdinfo, &list, list) {
 141                 struct scsi_pointer *scp = (void *)cmdinfo;
 142                 struct scsi_cmnd *cmnd = container_of(scp,
 143                                                         struct scsi_cmnd, SCp);
 144                 uas_submit_urbs(cmnd, cmnd->device->hostdata, GFP_KERNEL);
 145         }
 146 }
 147
 148 static DECLARE_WORK(uas_work, uas_do_work);
 149
 150 static void uas_sense(struct urb *urb, struct scsi_cmnd *cmnd)
 151 {
 152         struct sense_iu *sense_iu = urb->transfer_buffer;
 153         struct scsi_device *sdev = cmnd->device;
 154
 155         if (urb->actual_length > 16) {
 156                 unsigned len = be16_to_cpup(&sense_iu->len);
 157                 if (len + 16 != urb->actual_length) {
 158                         int newlen = min(len + 16, urb->actual_length) - 16;
 159                         if (newlen < 0)
 160                                 newlen = 0;
 161                         sdev_printk(KERN_INFO, sdev, "%s: urb length %d "
 162                                 "disagrees with IU sense data length %d, "
 163                                 "using %d bytes of sense data\n", __func__,
 164                                         urb->actual_length, len, newlen);
 165                         len = newlen;
 166                 }
 167                 memcpy(cmnd->sense_buffer, sense_iu->sense, len);
 168         }
 169
 170         cmnd->result = sense_iu->status;
 171         if (sdev->current_cmnd)
 172                 sdev->current_cmnd = NULL;
 173         cmnd->scsi_done(cmnd);
 174         usb_free_urb(urb);
 175 }
 176
 177 static void uas_sense_old(struct urb *urb, struct scsi_cmnd *cmnd)
 178 {
 179         struct sense_iu_old *sense_iu = urb->transfer_buffer;
 180         struct scsi_device *sdev = cmnd->device;
 181
 182         if (urb->actual_length > 8) {
 183                 unsigned len = be16_to_cpup(&sense_iu->len) - 2;
 184                 if (len + 8 != urb->actual_length) {
 185                         int newlen = min(len + 8, urb->actual_length) - 8;
 186                         if (newlen < 0)
 187                                 newlen = 0;
 188                         sdev_printk(KERN_INFO, sdev, "%s: urb length %d "
 189                                 "disagrees with IU sense data length %d, "
 190                                 "using %d bytes of sense data\n", __func__,
 191                                         urb->actual_length, len, newlen);
 192                         len = newlen;
 193                 }
 194                 memcpy(cmnd->sense_buffer, sense_iu->sense, len);
 195         }
 196
 197         cmnd->result = sense_iu->status;
 198         if (sdev->current_cmnd)
 199                 sdev->current_cmnd = NULL;
 200         cmnd->scsi_done(cmnd);
 201         usb_free_urb(urb);
 202 }
 203
 204 static void uas_xfer_data(struct urb *urb, struct scsi_cmnd *cmnd,
 205                                                         unsigned direction)
 206 {
 207         struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
 208         int err;
 209
 210         cmdinfo->state = direction | SUBMIT_STATUS_URB;
 211         err = uas_submit_urbs(cmnd, cmnd->device->hostdata, GFP_ATOMIC);
 212         if (err) {
 213                 spin_lock(&uas_work_lock);
 214                 list_add_tail(&cmdinfo->list, &uas_work_list);
 215                 spin_unlock(&uas_work_lock);
 216                 schedule_work(&uas_work);
 217         }
 218 }
 219
 220 static void uas_stat_cmplt(struct urb *urb)
 221 {
 222         struct iu *iu = urb->transfer_buffer;
 223         struct scsi_device *sdev = urb->context;
 224         struct uas_dev_info *devinfo = sdev->hostdata;
 225         struct scsi_cmnd *cmnd;
 226         u16 tag;
 227
 228         if (urb->status) {
 229                 dev_err(&urb->dev->dev, "URB BAD STATUS %d\n", urb->status);
 230                 usb_free_urb(urb);
 231                 return;
 232         }
 233
 234         tag = be16_to_cpup(&iu->tag) - 1;
 235         if (sdev->current_cmnd)
 236                 cmnd = sdev->current_cmnd;
 237         else
 238                 cmnd = scsi_find_tag(sdev, tag);
 239         if (!cmnd)
 240                 return;
 241
 242         switch (iu->iu_id) {
 243         case IU_ID_STATUS:
 244                 if (urb->actual_length < 16)
 245                         devinfo->uas_sense_old = 1;
 246                 if (devinfo->uas_sense_old)
 247                         uas_sense_old(urb, cmnd);
 248                 else
 249                         uas_sense(urb, cmnd);
 250                 break;
 251         case IU_ID_READ_READY:
 252                 uas_xfer_data(urb, cmnd, SUBMIT_DATA_IN_URB);
 253                 break;
 254         case IU_ID_WRITE_READY:
 255                 uas_xfer_data(urb, cmnd, SUBMIT_DATA_OUT_URB);
 256                 break;
 257         default:
 258                 scmd_printk(KERN_ERR, cmnd,
 259                         "Bogus IU (%d) received on status pipe\n", iu->iu_id);
 260         }
 261 }
 262
 263 static void uas_data_cmplt(struct urb *urb)
 264 {
 265         struct scsi_data_buffer *sdb = urb->context;
 266         sdb->resid = sdb->length - urb->actual_length;
 267         usb_free_urb(urb);
 268 }
 269
 270 static struct urb *uas_alloc_data_urb(struct uas_dev_info *devinfo, gfp_t gfp,
 271                                 unsigned int pipe, u16 stream_id,
 272                                 struct scsi_data_buffer *sdb,
 273                                 enum dma_data_direction dir)
 274 {
 275         struct usb_device *udev = devinfo->udev;
 276         struct urb *urb = usb_alloc_urb(0, gfp);
 277
 278         if (!urb)
 279                 goto out;
 280         usb_fill_bulk_urb(urb, udev, pipe, NULL, sdb->length, uas_data_cmplt,
 281                                                                         sdb);
 282         if (devinfo->use_streams)
 283                 urb->stream_id = stream_id;
 284         urb->num_sgs = udev->bus->sg_tablesize ? sdb->table.nents : 0;
 285         urb->sg = sdb->table.sgl;
 286  out:
 287         return urb;
 288 }
 289
 290 static struct urb *uas_alloc_sense_urb(struct uas_dev_info *devinfo, gfp_t gfp,
 291                                         struct scsi_cmnd *cmnd, u16 stream_id)
 292 {
 293         struct usb_device *udev = devinfo->udev;
 294         struct urb *urb = usb_alloc_urb(0, gfp);
 295         struct sense_iu *iu;
 296
 297         if (!urb)
 298                 goto out;
 299
 300         iu = kzalloc(sizeof(*iu), gfp);
 301         if (!iu)
 302                 goto free;
 303
 304         usb_fill_bulk_urb(urb, udev, devinfo->status_pipe, iu, sizeof(*iu),
 305                                                 uas_stat_cmplt, cmnd->device);
 306         urb->stream_id = stream_id;
 307         urb->transfer_flags |= URB_FREE_BUFFER;
 308  out:
 309         return urb;
 310  free:
 311         usb_free_urb(urb);
 312         return NULL;
 313 }
 314
 315 static struct urb *uas_alloc_cmd_urb(struct uas_dev_info *devinfo, gfp_t gfp,
 316                                         struct scsi_cmnd *cmnd, u16 stream_id)
 317 {
 318         struct usb_device *udev = devinfo->udev;
 319         struct scsi_device *sdev = cmnd->device;
 320         struct urb *urb = usb_alloc_urb(0, gfp);
 321         struct command_iu *iu;
 322         int len;
 323
 324         if (!urb)
 325                 goto out;
 326
 327         len = cmnd->cmd_len - 16;
 328         if (len < 0)
 329                 len = 0;
 330         len = ALIGN(len, 4);
 331         iu = kzalloc(sizeof(*iu) + len, gfp);
 332         if (!iu)
 333                 goto free;
 334
 335         iu->iu_id = IU_ID_COMMAND;
 336         iu->tag = cpu_to_be16(stream_id);
 337         if (sdev->ordered_tags && (cmnd->request->cmd_flags & REQ_HARDBARRIER))
 338                 iu->prio_attr = UAS_ORDERED_TAG;
 339         else
 340                 iu->prio_attr = UAS_SIMPLE_TAG;
 341         iu->len = len;
 342         int_to_scsilun(sdev->lun, &iu->lun);
 343         memcpy(iu->cdb, cmnd->cmnd, cmnd->cmd_len);
 344
 345         usb_fill_bulk_urb(urb, udev, devinfo->cmd_pipe, iu, sizeof(*iu) + len,
 346                                                         usb_free_urb, NULL);
 347         urb->transfer_flags |= URB_FREE_BUFFER;
 348  out:
 349         return urb;
 350  free:
 351         usb_free_urb(urb);
 352         return NULL;
 353 }
 354
 355 /*
 356  * Why should I request the Status IU before sending the Command IU?  Spec
 357  * says to, but also says the device may receive them in any order.  Seems
 358  * daft to me.
 359  */
 360
 361 static int uas_submit_urbs(struct scsi_cmnd *cmnd,
 362                                         struct uas_dev_info *devinfo, gfp_t gfp)
 363 {
 364         struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
 365
 366         if (cmdinfo->state & ALLOC_STATUS_URB) {
 367                 cmdinfo->status_urb = uas_alloc_sense_urb(devinfo, gfp, cmnd,
 368                                                           cmdinfo->stream);
 369                 if (!cmdinfo->status_urb)
 370                         return SCSI_MLQUEUE_DEVICE_BUSY;
 371                 cmdinfo->state &= ~ALLOC_STATUS_URB;
 372         }
 373
 374         if (cmdinfo->state & SUBMIT_STATUS_URB) {
 375                 if (usb_submit_urb(cmdinfo->status_urb, gfp)) {
 376                         scmd_printk(KERN_INFO, cmnd,
 377                                         "sense urb submission failure\n");
 378                         return SCSI_MLQUEUE_DEVICE_BUSY;
 379                 }
 380                 cmdinfo->state &= ~SUBMIT_STATUS_URB;
 381         }
 382
 383         if (cmdinfo->state & ALLOC_DATA_IN_URB) {
 384                 cmdinfo->data_in_urb = uas_alloc_data_urb(devinfo, gfp,
 385                                         devinfo->data_in_pipe, cmdinfo->stream,
 386                                         scsi_in(cmnd), DMA_FROM_DEVICE);
 387                 if (!cmdinfo->data_in_urb)
 388                         return SCSI_MLQUEUE_DEVICE_BUSY;
 389                 cmdinfo->state &= ~ALLOC_DATA_IN_URB;
 390         }
 391
 392         if (cmdinfo->state & SUBMIT_DATA_IN_URB) {
 393                 if (usb_submit_urb(cmdinfo->data_in_urb, gfp)) {
 394                         scmd_printk(KERN_INFO, cmnd,
 395                                         "data in urb submission failure\n");
 396                         return SCSI_MLQUEUE_DEVICE_BUSY;
 397                 }
 398                 cmdinfo->state &= ~SUBMIT_DATA_IN_URB;
 399         }
 400
 401         if (cmdinfo->state & ALLOC_DATA_OUT_URB) {
 402                 cmdinfo->data_out_urb = uas_alloc_data_urb(devinfo, gfp,
 403                                         devinfo->data_out_pipe, cmdinfo->stream,
 404                                         scsi_out(cmnd), DMA_TO_DEVICE);
 405                 if (!cmdinfo->data_out_urb)
 406                         return SCSI_MLQUEUE_DEVICE_BUSY;
 407                 cmdinfo->state &= ~ALLOC_DATA_OUT_URB;
 408         }
 409
 410         if (cmdinfo->state & SUBMIT_DATA_OUT_URB) {
 411                 if (usb_submit_urb(cmdinfo->data_out_urb, gfp)) {
 412                         scmd_printk(KERN_INFO, cmnd,
 413                                         "data out urb submission failure\n");
 414                         return SCSI_MLQUEUE_DEVICE_BUSY;
 415                 }
 416                 cmdinfo->state &= ~SUBMIT_DATA_OUT_URB;
 417         }
 418
 419         if (cmdinfo->state & ALLOC_CMD_URB) {
 420                 cmdinfo->cmd_urb = uas_alloc_cmd_urb(devinfo, gfp, cmnd,
 421                                                         cmdinfo->stream);
 422                 if (!cmdinfo->cmd_urb)
 423                         return SCSI_MLQUEUE_DEVICE_BUSY;
 424                 cmdinfo->state &= ~ALLOC_CMD_URB;
 425         }
 426
 427         if (cmdinfo->state & SUBMIT_CMD_URB) {
 428                 if (usb_submit_urb(cmdinfo->cmd_urb, gfp)) {
 429                         scmd_printk(KERN_INFO, cmnd,
 430                                         "cmd urb submission failure\n");
 431                         return SCSI_MLQUEUE_DEVICE_BUSY;
 432                 }
 433                 cmdinfo->state &= ~SUBMIT_CMD_URB;
 434         }
 435
 436         return 0;
 437 }
 438
 439 static int uas_queuecommand(struct scsi_cmnd *cmnd,
 440                                         void (*done)(struct scsi_cmnd *))
 441 {
 442         struct scsi_device *sdev = cmnd->device;
 443         struct uas_dev_info *devinfo = sdev->hostdata;
 444         struct uas_cmd_info *cmdinfo = (void *)&cmnd->SCp;
 445         int err;
 446
 447         BUILD_BUG_ON(sizeof(struct uas_cmd_info) > sizeof(struct scsi_pointer));
 448
 449         if (!cmdinfo->status_urb && sdev->current_cmnd)
 450                 return SCSI_MLQUEUE_DEVICE_BUSY;
 451
 452         if (blk_rq_tagged(cmnd->request)) {
 453                 cmdinfo->stream = cmnd->request->tag + 1;
 454         } else {
 455                 sdev->current_cmnd = cmnd;
 456                 cmdinfo->stream = 1;
 457         }
 458
 459         cmnd->scsi_done = done;
 460
 461         cmdinfo->state = ALLOC_STATUS_URB | SUBMIT_STATUS_URB |
 462                         ALLOC_CMD_URB | SUBMIT_CMD_URB;
 463
 464         switch (cmnd->sc_data_direction) {
 465         case DMA_FROM_DEVICE:
 466                 cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
 467                 break;
 468         case DMA_BIDIRECTIONAL:
 469                 cmdinfo->state |= ALLOC_DATA_IN_URB | SUBMIT_DATA_IN_URB;
 470         case DMA_TO_DEVICE:
 471                 cmdinfo->state |= ALLOC_DATA_OUT_URB | SUBMIT_DATA_OUT_URB;
 472         case DMA_NONE:
 473                 break;
 474         }
 475
 476         if (!devinfo->use_streams) {
 477                 cmdinfo->state &= ~(SUBMIT_DATA_IN_URB | SUBMIT_DATA_OUT_URB);
 478                 cmdinfo->stream = 0;
 479         }
 480
 481         err = uas_submit_urbs(cmnd, devinfo, GFP_ATOMIC);
 482         if (err) {
 483                 /* If we did nothing, give up now */
 484                 if (cmdinfo->state & SUBMIT_STATUS_URB) {
 485                         usb_free_urb(cmdinfo->status_urb);
 486                         return SCSI_MLQUEUE_DEVICE_BUSY;
 487                 }
 488                 spin_lock(&uas_work_lock);
 489                 list_add_tail(&cmdinfo->list, &uas_work_list);
 490                 spin_unlock(&uas_work_lock);
 491                 schedule_work(&uas_work);
 492         }
 493
 494         return 0;
 495 }
 496
 497 static int uas_eh_abort_handler(struct scsi_cmnd *cmnd)
 498 {
 499         struct scsi_device *sdev = cmnd->device;
 500         sdev_printk(KERN_INFO, sdev, "%s tag %d\n", __func__,
 501                                                         cmnd->request->tag);
 502
 503 /* XXX: Send ABORT TASK Task Management command */
 504         return FAILED;
 505 }
 506
 507 static int uas_eh_device_reset_handler(struct scsi_cmnd *cmnd)
 508 {
 509         struct scsi_device *sdev = cmnd->device;
 510         sdev_printk(KERN_INFO, sdev, "%s tag %d\n", __func__,
 511                                                         cmnd->request->tag);
 512
 513 /* XXX: Send LOGICAL UNIT RESET Task Management command */
 514         return FAILED;
 515 }
 516
 517 static int uas_eh_target_reset_handler(struct scsi_cmnd *cmnd)
 518 {
 519         struct scsi_device *sdev = cmnd->device;
 520         sdev_printk(KERN_INFO, sdev, "%s tag %d\n", __func__,
 521                                                         cmnd->request->tag);
 522
 523 /* XXX: Can we reset just the one USB interface?
 524  * Would calling usb_set_interface() have the right effect?
 525  */
 526         return FAILED;
 527 }
 528
 529 static int uas_eh_bus_reset_handler(struct scsi_cmnd *cmnd)
 530 {
 531         struct scsi_device *sdev = cmnd->device;
 532         struct uas_dev_info *devinfo = sdev->hostdata;
 533         struct usb_device *udev = devinfo->udev;
 534
 535         sdev_printk(KERN_INFO, sdev, "%s tag %d\n", __func__,
 536                                                         cmnd->request->tag);
 537
 538         if (usb_reset_device(udev))
 539                 return SUCCESS;
 540
 541         return FAILED;
 542 }
 543
 544 static int uas_slave_alloc(struct scsi_device *sdev)
 545 {
 546         sdev->hostdata = (void *)sdev->host->hostdata[0];
 547         return 0;
 548 }
 549
 550 static int uas_slave_configure(struct scsi_device *sdev)
 551 {
 552         struct uas_dev_info *devinfo = sdev->hostdata;
 553         scsi_set_tag_type(sdev, MSG_ORDERED_TAG);
 554         scsi_activate_tcq(sdev, devinfo->qdepth - 1);
 555         return 0;
 556 }
 557
 558 static struct scsi_host_template uas_host_template = {
 559         .module = THIS_MODULE,
 560         .name = "uas",
 561         .queuecommand = uas_queuecommand,
 562         .slave_alloc = uas_slave_alloc,
 563         .slave_configure = uas_slave_configure,
 564         .eh_abort_handler = uas_eh_abort_handler,
 565         .eh_device_reset_handler = uas_eh_device_reset_handler,
 566         .eh_target_reset_handler = uas_eh_target_reset_handler,
 567         .eh_bus_reset_handler = uas_eh_bus_reset_handler,
 568         .can_queue = 65536,     /* Is there a limit on the _host_ ? */
 569         .this_id = -1,
 570         .sg_tablesize = SG_NONE,
 571         .cmd_per_lun = 1,       /* until we override it */
 572         .skip_settle_delay = 1,
 573         .ordered_tag = 1,
 574 };
 575
 576 static struct usb_device_id uas_usb_ids[] = {
 577         { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_BULK) },
 578         { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, USB_PR_UAS) },
 579         /* 0xaa is a prototype device I happen to have access to */
 580         { USB_INTERFACE_INFO(USB_CLASS_MASS_STORAGE, USB_SC_SCSI, 0xaa) },
 581         { }
 582 };
 583 MODULE_DEVICE_TABLE(usb, uas_usb_ids);
 584
 585 static int uas_is_interface(struct usb_host_interface *intf)
 586 {
 587         return (intf->desc.bInterfaceClass == USB_CLASS_MASS_STORAGE &&
 588                 intf->desc.bInterfaceSubClass == USB_SC_SCSI &&
 589                 intf->desc.bInterfaceProtocol == USB_PR_UAS);
 590 }
 591
 592 static int uas_switch_interface(struct usb_device *udev,
 593                                                 struct usb_interface *intf)
 594 {
 595         int i;
 596
 597         if (uas_is_interface(intf->cur_altsetting))
 598                 return 0;
 599
 600         for (i = 0; i < intf->num_altsetting; i++) {
 601                 struct usb_host_interface *alt = &intf->altsetting[i];
 602                 if (alt == intf->cur_altsetting)
 603                         continue;
 604                 if (uas_is_interface(alt))
 605                         return usb_set_interface(udev,
 606                                                 alt->desc.bInterfaceNumber,
 607                                                 alt->desc.bAlternateSetting);
 608         }
 609
 610         return -ENODEV;
 611 }
 612
 613 static void uas_configure_endpoints(struct uas_dev_info *devinfo)
 614 {
 615         struct usb_host_endpoint *eps[4] = { };
 616         struct usb_interface *intf = devinfo->intf;
 617         struct usb_device *udev = devinfo->udev;
 618         struct usb_host_endpoint *endpoint = intf->cur_altsetting->endpoint;
 619         unsigned i, n_endpoints = intf->cur_altsetting->desc.bNumEndpoints;
 620
 621         devinfo->uas_sense_old = 0;
 622
 623         for (i = 0; i < n_endpoints; i++) {
 624                 unsigned char *extra = endpoint[i].extra;
 625                 int len = endpoint[i].extralen;
 626                 while (len > 1) {
 627                         if (extra[1] == USB_DT_PIPE_USAGE) {
 628                                 unsigned pipe_id = extra[2];
 629                                 if (pipe_id > 0 && pipe_id < 5)
 630                                         eps[pipe_id - 1] = &endpoint[i];
 631                                 break;
 632                         }
 633                         len -= extra[0];
 634                         extra += extra[0];
 635                 }
 636         }
 637
 638         /*
 639          * Assume that if we didn't find a control pipe descriptor, we're
 640          * using a device with old firmware that happens to be set up like
 641          * this.
 642          */
 643         if (!eps[0]) {
 644                 devinfo->cmd_pipe = usb_sndbulkpipe(udev, 1);
 645                 devinfo->status_pipe = usb_rcvbulkpipe(udev, 1);
 646                 devinfo->data_in_pipe = usb_rcvbulkpipe(udev, 2);
 647                 devinfo->data_out_pipe = usb_sndbulkpipe(udev, 2);
 648
 649                 eps[1] = usb_pipe_endpoint(udev, devinfo->status_pipe);
 650                 eps[2] = usb_pipe_endpoint(udev, devinfo->data_in_pipe);
 651                 eps[3] = usb_pipe_endpoint(udev, devinfo->data_out_pipe);
 652         } else {
 653                 devinfo->cmd_pipe = usb_sndbulkpipe(udev,
 654                                                 eps[0]->desc.bEndpointAddress);
 655                 devinfo->status_pipe = usb_rcvbulkpipe(udev,
 656                                                 eps[1]->desc.bEndpointAddress);
 657                 devinfo->data_in_pipe = usb_rcvbulkpipe(udev,
 658                                                 eps[2]->desc.bEndpointAddress);
 659                 devinfo->data_out_pipe = usb_sndbulkpipe(udev,
 660                                                 eps[3]->desc.bEndpointAddress);
 661         }
 662
 663         devinfo->qdepth = usb_alloc_streams(devinfo->intf, eps + 1, 3, 256,
 664                                                                 GFP_KERNEL);
 665         if (devinfo->qdepth < 0) {
 666                 devinfo->qdepth = 256;
 667                 devinfo->use_streams = 0;
 668         } else {
 669                 devinfo->use_streams = 1;
 670         }
 671 }
 672
 673 /*
 674  * XXX: What I'd like to do here is register a SCSI host for each USB host in
 675  * the system.  Follow usb-storage's design of registering a SCSI host for
 676  * each USB device for the moment.  Can implement this by walking up the
 677  * USB hierarchy until we find a USB host.
 678  */
 679 static int uas_probe(struct usb_interface *intf, const struct usb_device_id *id)
 680 {
 681         int result;
 682         struct Scsi_Host *shost;
 683         struct uas_dev_info *devinfo;
 684         struct usb_device *udev = interface_to_usbdev(intf);
 685
 686         if (uas_switch_interface(udev, intf))
 687                 return -ENODEV;
 688
 689         devinfo = kmalloc(sizeof(struct uas_dev_info), GFP_KERNEL);
 690         if (!devinfo)
 691                 return -ENOMEM;
 692
 693         result = -ENOMEM;
 694         shost = scsi_host_alloc(&uas_host_template, sizeof(void *));
 695         if (!shost)
 696                 goto free;
 697
 698         shost->max_cmd_len = 16 + 252;
 699         shost->max_id = 1;
 700         shost->sg_tablesize = udev->bus->sg_tablesize;
 701
 702         result = scsi_add_host(shost, &intf->dev);
 703         if (result)
 704                 goto free;
 705         shost->hostdata[0] = (unsigned long)devinfo;
 706
 707         devinfo->intf = intf;
 708         devinfo->udev = udev;
 709         uas_configure_endpoints(devinfo);
 710
 711         scsi_scan_host(shost);
 712         usb_set_intfdata(intf, shost);
 713         return result;
 714  free:
 715         kfree(devinfo);
 716         if (shost)
 717                 scsi_host_put(shost);
 718         return result;
 719 }
 720
 721 static int uas_pre_reset(struct usb_interface *intf)
 722 {
 723 /* XXX: Need to return 1 if it's not our device in error handling */
 724         return 0;
 725 }
 726
 727 static int uas_post_reset(struct usb_interface *intf)
 728 {
 729 /* XXX: Need to return 1 if it's not our device in error handling */
 730         return 0;
 731 }
 732
 733 static void uas_disconnect(struct usb_interface *intf)
 734 {
 735         struct usb_device *udev = interface_to_usbdev(intf);
 736         struct usb_host_endpoint *eps[3];
 737         struct Scsi_Host *shost = usb_get_intfdata(intf);
 738         struct uas_dev_info *devinfo = (void *)shost->hostdata[0];
 739
 740         scsi_remove_host(shost);
 741
 742         eps[0] = usb_pipe_endpoint(udev, devinfo->status_pipe);
 743         eps[1] = usb_pipe_endpoint(udev, devinfo->data_in_pipe);
 744         eps[2] = usb_pipe_endpoint(udev, devinfo->data_out_pipe);
 745         usb_free_streams(intf, eps, 3, GFP_KERNEL);
 746
 747         kfree(devinfo);
 748 }
 749
 750 /*
 751  * XXX: Should this plug into libusual so we can auto-upgrade devices from
 752  * Bulk-Only to UAS?
 753  */
 754 static struct usb_driver uas_driver = {
 755         .name = "uas",
 756         .probe = uas_probe,
 757         .disconnect = uas_disconnect,
 758         .pre_reset = uas_pre_reset,
 759         .post_reset = uas_post_reset,
 760         .id_table = uas_usb_ids,
 761 };
 762
 763 static int uas_init(void)
 764 {
 765         return usb_register(&uas_driver);
 766 }
 767
 768 static void uas_exit(void)
 769 {
 770         usb_deregister(&uas_driver);
 771 }
 772
 773 module_init(uas_init);
 774 module_exit(uas_exit);
 775
 776 MODULE_LICENSE("GPL");
 777 MODULE_AUTHOR("Matthew Wilcox and Sarah Sharp");