drivers/usb/misc/usbtest.c

   1 #include <linux/kernel.h>
   2 #include <linux/errno.h>
   3 #include <linux/init.h>
   4 #include <linux/slab.h>
   5 #include <linux/mm.h>
   6 #include <linux/module.h>
   7 #include <linux/moduleparam.h>
   8 #include <linux/scatterlist.h>
   9 #include <linux/mutex.h>
  10
  11 #include <linux/usb.h>
  12
  13
  14 /*-------------------------------------------------------------------------*/
  15
  16 // FIXME make these public somewhere; usbdevfs.h?
  17 //
  18 struct usbtest_param {
  19         // inputs
  20         unsigned                test_num;       /* 0..(TEST_CASES-1) */
  21         unsigned                iterations;
  22         unsigned                length;
  23         unsigned                vary;
  24         unsigned                sglen;
  25
  26         // outputs
  27         struct timeval          duration;
  28 };
  29 #define USBTEST_REQUEST _IOWR('U', 100, struct usbtest_param)
  30
  31 /*-------------------------------------------------------------------------*/
  32
  33 #define GENERIC         /* let probe() bind using module params */
  34
  35 /* Some devices that can be used for testing will have "real" drivers.
  36  * Entries for those need to be enabled here by hand, after disabling
  37  * that "real" driver.
  38  */
  39 //#define       IBOT2           /* grab iBOT2 webcams */
  40 //#define       KEYSPAN_19Qi    /* grab un-renumerated serial adapter */
  41
  42 /*-------------------------------------------------------------------------*/
  43
  44 struct usbtest_info {
  45         const char              *name;
  46         u8                      ep_in;          /* bulk/intr source */
  47         u8                      ep_out;         /* bulk/intr sink */
  48         unsigned                autoconf : 1;
  49         unsigned                ctrl_out : 1;
  50         unsigned                iso : 1;        /* try iso in/out */
  51         int                     alt;
  52 };
  53
  54 /* this is accessed only through usbfs ioctl calls.
  55  * one ioctl to issue a test ... one lock per device.
  56  * tests create other threads if they need them.
  57  * urbs and buffers are allocated dynamically,
  58  * and data generated deterministically.
  59  */
  60 struct usbtest_dev {
  61         struct usb_interface    *intf;
  62         struct usbtest_info     *info;
  63         int                     in_pipe;
  64         int                     out_pipe;
  65         int                     in_iso_pipe;
  66         int                     out_iso_pipe;
  67         struct usb_endpoint_descriptor  *iso_in, *iso_out;
  68         struct mutex            lock;
  69
  70 #define TBUF_SIZE       256
  71         u8                      *buf;
  72 };
  73
  74 static struct usb_device *testdev_to_usbdev (struct usbtest_dev *test)
  75 {
  76         return interface_to_usbdev (test->intf);
  77 }
  78
  79 /* set up all urbs so they can be used with either bulk or interrupt */
  80 #define INTERRUPT_RATE          1       /* msec/transfer */
  81
  82 #define xprintk(tdev,level,fmt,args...) \
  83         dev_printk(level ,  &(tdev)->intf->dev ,  fmt ,  ## args)
  84
  85 #ifdef DEBUG
  86 #define DBG(dev,fmt,args...) \
  87         xprintk(dev , KERN_DEBUG , fmt , ## args)
  88 #else
  89 #define DBG(dev,fmt,args...) \
  90         do { } while (0)
  91 #endif /* DEBUG */
  92
  93 #ifdef VERBOSE
  94 #define VDBG DBG
  95 #else
  96 #define VDBG(dev,fmt,args...) \
  97         do { } while (0)
  98 #endif  /* VERBOSE */
  99
 100 #define ERROR(dev,fmt,args...) \
 101         xprintk(dev , KERN_ERR , fmt , ## args)
 102 #define WARN(dev,fmt,args...) \
 103         xprintk(dev , KERN_WARNING , fmt , ## args)
 104 #define INFO(dev,fmt,args...) \
 105         xprintk(dev , KERN_INFO , fmt , ## args)
 106
 107 /*-------------------------------------------------------------------------*/
 108
 109 static int
 110 get_endpoints (struct usbtest_dev *dev, struct usb_interface *intf)
 111 {
 112         int                             tmp;
 113         struct usb_host_interface       *alt;
 114         struct usb_host_endpoint        *in, *out;
 115         struct usb_host_endpoint        *iso_in, *iso_out;
 116         struct usb_device               *udev;
 117
 118         for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
 119                 unsigned        ep;
 120
 121                 in = out = NULL;
 122                 iso_in = iso_out = NULL;
 123                 alt = intf->altsetting + tmp;
 124
 125                 /* take the first altsetting with in-bulk + out-bulk;
 126                  * ignore other endpoints and altsetttings.
 127                  */
 128                 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
 129                         struct usb_host_endpoint        *e;
 130
 131                         e = alt->endpoint + ep;
 132                         switch (e->desc.bmAttributes) {
 133                         case USB_ENDPOINT_XFER_BULK:
 134                                 break;
 135                         case USB_ENDPOINT_XFER_ISOC:
 136                                 if (dev->info->iso)
 137                                         goto try_iso;
 138                                 // FALLTHROUGH
 139                         default:
 140                                 continue;
 141                         }
 142                         if (usb_endpoint_dir_in(&e->desc)) {
 143                                 if (!in)
 144                                         in = e;
 145                         } else {
 146                                 if (!out)
 147                                         out = e;
 148                         }
 149                         continue;
 150 try_iso:
 151                         if (usb_endpoint_dir_in(&e->desc)) {
 152                                 if (!iso_in)
 153                                         iso_in = e;
 154                         } else {
 155                                 if (!iso_out)
 156                                         iso_out = e;
 157                         }
 158                 }
 159                 if ((in && out)  ||  (iso_in && iso_out))
 160                         goto found;
 161         }
 162         return -EINVAL;
 163
 164 found:
 165         udev = testdev_to_usbdev (dev);
 166         if (alt->desc.bAlternateSetting != 0) {
 167                 tmp = usb_set_interface (udev,
 168                                 alt->desc.bInterfaceNumber,
 169                                 alt->desc.bAlternateSetting);
 170                 if (tmp < 0)
 171                         return tmp;
 172         }
 173
 174         if (in) {
 175                 dev->in_pipe = usb_rcvbulkpipe (udev,
 176                         in->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
 177                 dev->out_pipe = usb_sndbulkpipe (udev,
 178                         out->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
 179         }
 180         if (iso_in) {
 181                 dev->iso_in = &iso_in->desc;
 182                 dev->in_iso_pipe = usb_rcvisocpipe (udev,
 183                                 iso_in->desc.bEndpointAddress
 184                                         & USB_ENDPOINT_NUMBER_MASK);
 185                 dev->iso_out = &iso_out->desc;
 186                 dev->out_iso_pipe = usb_sndisocpipe (udev,
 187                                 iso_out->desc.bEndpointAddress
 188                                         & USB_ENDPOINT_NUMBER_MASK);
 189         }
 190         return 0;
 191 }
 192
 193 /*-------------------------------------------------------------------------*/
 194
 195 /* Support for testing basic non-queued I/O streams.
 196  *
 197  * These just package urbs as requests that can be easily canceled.
 198  * Each urb's data buffer is dynamically allocated; callers can fill
 199  * them with non-zero test data (or test for it) when appropriate.
 200  */
 201
 202 static void simple_callback (struct urb *urb)
 203 {
 204         complete ((struct completion *) urb->context);
 205 }
 206
 207 static struct urb *simple_alloc_urb (
 208         struct usb_device       *udev,
 209         int                     pipe,
 210         unsigned long           bytes
 211 )
 212 {
 213         struct urb              *urb;
 214
 215         if (bytes < 0)
 216                 return NULL;
 217         urb = usb_alloc_urb (0, GFP_KERNEL);
 218         if (!urb)
 219                 return urb;
 220         usb_fill_bulk_urb (urb, udev, pipe, NULL, bytes, simple_callback, NULL);
 221         urb->interval = (udev->speed == USB_SPEED_HIGH)
 222                         ? (INTERRUPT_RATE << 3)
 223                         : INTERRUPT_RATE;
 224         urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
 225         if (usb_pipein (pipe))
 226                 urb->transfer_flags |= URB_SHORT_NOT_OK;
 227         urb->transfer_buffer = usb_buffer_alloc (udev, bytes, GFP_KERNEL,
 228                         &urb->transfer_dma);
 229         if (!urb->transfer_buffer) {
 230                 usb_free_urb (urb);
 231                 urb = NULL;
 232         } else
 233                 memset (urb->transfer_buffer, 0, bytes);
 234         return urb;
 235 }
 236
 237 static unsigned pattern = 0;
 238 module_param (pattern, uint, S_IRUGO);
 239 // MODULE_PARM_DESC (pattern, "i/o pattern (0 == zeroes)");
 240
 241 static inline void simple_fill_buf (struct urb *urb)
 242 {
 243         unsigned        i;
 244         u8              *buf = urb->transfer_buffer;
 245         unsigned        len = urb->transfer_buffer_length;
 246
 247         switch (pattern) {
 248         default:
 249                 // FALLTHROUGH
 250         case 0:
 251                 memset (buf, 0, len);
 252                 break;
 253         case 1:                 /* mod63 */
 254                 for (i = 0; i < len; i++)
 255                         *buf++ = (u8) (i % 63);
 256                 break;
 257         }
 258 }
 259
 260 static inline int simple_check_buf (struct urb *urb)
 261 {
 262         unsigned        i;
 263         u8              expected;
 264         u8              *buf = urb->transfer_buffer;
 265         unsigned        len = urb->actual_length;
 266
 267         for (i = 0; i < len; i++, buf++) {
 268                 switch (pattern) {
 269                 /* all-zeroes has no synchronization issues */
 270                 case 0:
 271                         expected = 0;
 272                         break;
 273                 /* mod63 stays in sync with short-terminated transfers,
 274                  * or otherwise when host and gadget agree on how large
 275                  * each usb transfer request should be.  resync is done
 276                  * with set_interface or set_config.
 277                  */
 278                 case 1:                 /* mod63 */
 279                         expected = i % 63;
 280                         break;
 281                 /* always fail unsupported patterns */
 282                 default:
 283                         expected = !*buf;
 284                         break;
 285                 }
 286                 if (*buf == expected)
 287                         continue;
 288                 dbg ("buf[%d] = %d (not %d)", i, *buf, expected);
 289                 return -EINVAL;
 290         }
 291         return 0;
 292 }
 293
 294 static void simple_free_urb (struct urb *urb)
 295 {
 296         usb_buffer_free (urb->dev, urb->transfer_buffer_length,
 297                         urb->transfer_buffer, urb->transfer_dma);
 298         usb_free_urb (urb);
 299 }
 300
 301 static int simple_io (
 302         struct urb              *urb,
 303         int                     iterations,
 304         int                     vary,
 305         int                     expected,
 306         const char              *label
 307 )
 308 {
 309         struct usb_device       *udev = urb->dev;
 310         int                     max = urb->transfer_buffer_length;
 311         struct completion       completion;
 312         int                     retval = 0;
 313
 314         urb->context = &completion;
 315         while (retval == 0 && iterations-- > 0) {
 316                 init_completion (&completion);
 317                 if (usb_pipeout (urb->pipe))
 318                         simple_fill_buf (urb);
 319                 if ((retval = usb_submit_urb (urb, GFP_KERNEL)) != 0)
 320                         break;
 321
 322                 /* NOTE:  no timeouts; can't be broken out of by interrupt */
 323                 wait_for_completion (&completion);
 324                 retval = urb->status;
 325                 urb->dev = udev;
 326                 if (retval == 0 && usb_pipein (urb->pipe))
 327                         retval = simple_check_buf (urb);
 328
 329                 if (vary) {
 330                         int     len = urb->transfer_buffer_length;
 331
 332                         len += vary;
 333                         len %= max;
 334                         if (len == 0)
 335                                 len = (vary < max) ? vary : max;
 336                         urb->transfer_buffer_length = len;
 337                 }
 338
 339                 /* FIXME if endpoint halted, clear halt (and log) */
 340         }
 341         urb->transfer_buffer_length = max;
 342
 343         if (expected != retval)
 344                 dev_dbg (&udev->dev,
 345                         "%s failed, iterations left %d, status %d (not %d)\n",
 346                                 label, iterations, retval, expected);
 347         return retval;
 348 }
 349
 350
 351 /*-------------------------------------------------------------------------*/
 352
 353 /* We use scatterlist primitives to test queued I/O.
 354  * Yes, this also tests the scatterlist primitives.
 355  */
 356
 357 static void free_sglist (struct scatterlist *sg, int nents)
 358 {
 359         unsigned                i;
 360
 361         if (!sg)
 362                 return;
 363         for (i = 0; i < nents; i++) {
 364                 if (!sg_page(&sg[i]))
 365                         continue;
 366                 kfree (sg_virt(&sg[i]));
 367         }
 368         kfree (sg);
 369 }
 370
 371 static struct scatterlist *
 372 alloc_sglist (int nents, int max, int vary)
 373 {
 374         struct scatterlist      *sg;
 375         unsigned                i;
 376         unsigned                size = max;
 377
 378         sg = kmalloc (nents * sizeof *sg, GFP_KERNEL);
 379         if (!sg)
 380                 return NULL;
 381
 382         for (i = 0; i < nents; i++) {
 383                 char            *buf;
 384                 unsigned        j;
 385
 386                 buf = kzalloc (size, GFP_KERNEL);
 387                 if (!buf) {
 388                         free_sglist (sg, i);
 389                         return NULL;
 390                 }
 391
 392                 /* kmalloc pages are always physically contiguous! */
 393                 sg_init_one(&sg[i], buf, size);
 394
 395                 switch (pattern) {
 396                 case 0:
 397                         /* already zeroed */
 398                         break;
 399                 case 1:
 400                         for (j = 0; j < size; j++)
 401                                 *buf++ = (u8) (j % 63);
 402                         break;
 403                 }
 404
 405                 if (vary) {
 406                         size += vary;
 407                         size %= max;
 408                         if (size == 0)
 409                                 size = (vary < max) ? vary : max;
 410                 }
 411         }
 412
 413         return sg;
 414 }
 415
 416 static int perform_sglist (
 417         struct usb_device       *udev,
 418         unsigned                iterations,
 419         int                     pipe,
 420         struct usb_sg_request   *req,
 421         struct scatterlist      *sg,
 422         int                     nents
 423 )
 424 {
 425         int                     retval = 0;
 426
 427         while (retval == 0 && iterations-- > 0) {
 428                 retval = usb_sg_init (req, udev, pipe,
 429                                 (udev->speed == USB_SPEED_HIGH)
 430                                         ? (INTERRUPT_RATE << 3)
 431                                         : INTERRUPT_RATE,
 432                                 sg, nents, 0, GFP_KERNEL);
 433
 434                 if (retval)
 435                         break;
 436                 usb_sg_wait (req);
 437                 retval = req->status;
 438
 439                 /* FIXME check resulting data pattern */
 440
 441                 /* FIXME if endpoint halted, clear halt (and log) */
 442         }
 443
 444         // FIXME for unlink or fault handling tests, don't report
 445         // failure if retval is as we expected ...
 446
 447         if (retval)
 448                 dbg ("perform_sglist failed, iterations left %d, status %d",
 449                                 iterations, retval);
 450         return retval;
 451 }
 452
 453
 454 /*-------------------------------------------------------------------------*/
 455
 456 /* unqueued control message testing
 457  *
 458  * there's a nice set of device functional requirements in chapter 9 of the
 459  * usb 2.0 spec, which we can apply to ANY device, even ones that don't use
 460  * special test firmware.
 461  *
 462  * we know the device is configured (or suspended) by the time it's visible
 463  * through usbfs.  we can't change that, so we won't test enumeration (which
 464  * worked 'well enough' to get here, this time), power management (ditto),
 465  * or remote wakeup (which needs human interaction).
 466  */
 467
 468 static unsigned realworld = 1;
 469 module_param (realworld, uint, 0);
 470 MODULE_PARM_DESC (realworld, "clear to demand stricter spec compliance");
 471
 472 static int get_altsetting (struct usbtest_dev *dev)
 473 {
 474         struct usb_interface    *iface = dev->intf;
 475         struct usb_device       *udev = interface_to_usbdev (iface);
 476         int                     retval;
 477
 478         retval = usb_control_msg (udev, usb_rcvctrlpipe (udev, 0),
 479                         USB_REQ_GET_INTERFACE, USB_DIR_IN|USB_RECIP_INTERFACE,
 480                         0, iface->altsetting [0].desc.bInterfaceNumber,
 481                         dev->buf, 1, USB_CTRL_GET_TIMEOUT);
 482         switch (retval) {
 483         case 1:
 484                 return dev->buf [0];
 485         case 0:
 486                 retval = -ERANGE;
 487                 // FALLTHROUGH
 488         default:
 489                 return retval;
 490         }
 491 }
 492
 493 static int set_altsetting (struct usbtest_dev *dev, int alternate)
 494 {
 495         struct usb_interface            *iface = dev->intf;
 496         struct usb_device               *udev;
 497
 498         if (alternate < 0 || alternate >= 256)
 499                 return -EINVAL;
 500
 501         udev = interface_to_usbdev (iface);
 502         return usb_set_interface (udev,
 503                         iface->altsetting [0].desc.bInterfaceNumber,
 504                         alternate);
 505 }
 506
 507 static int is_good_config (char *buf, int len)
 508 {
 509         struct usb_config_descriptor    *config;
 510
 511         if (len < sizeof *config)
 512                 return 0;
 513         config = (struct usb_config_descriptor *) buf;
 514
 515         switch (config->bDescriptorType) {
 516         case USB_DT_CONFIG:
 517         case USB_DT_OTHER_SPEED_CONFIG:
 518                 if (config->bLength != 9) {
 519                         dbg ("bogus config descriptor length");
 520                         return 0;
 521                 }
 522                 /* this bit 'must be 1' but often isn't */
 523                 if (!realworld && !(config->bmAttributes & 0x80)) {
 524                         dbg ("high bit of config attributes not set");
 525                         return 0;
 526                 }
 527                 if (config->bmAttributes & 0x1f) {      /* reserved == 0 */
 528                         dbg ("reserved config bits set");
 529                         return 0;
 530                 }
 531                 break;
 532         default:
 533                 return 0;
 534         }
 535
 536         if (le16_to_cpu(config->wTotalLength) == len)           /* read it all */
 537                 return 1;
 538         if (le16_to_cpu(config->wTotalLength) >= TBUF_SIZE)             /* max partial read */
 539                 return 1;
 540         dbg ("bogus config descriptor read size");
 541         return 0;
 542 }
 543
 544 /* sanity test for standard requests working with usb_control_mesg() and some
 545  * of the utility functions which use it.
 546  *
 547  * this doesn't test how endpoint halts behave or data toggles get set, since
 548  * we won't do I/O to bulk/interrupt endpoints here (which is how to change
 549  * halt or toggle).  toggle testing is impractical without support from hcds.
 550  *
 551  * this avoids failing devices linux would normally work with, by not testing
 552  * config/altsetting operations for devices that only support their defaults.
 553  * such devices rarely support those needless operations.
 554  *
 555  * NOTE that since this is a sanity test, it's not examining boundary cases
 556  * to see if usbcore, hcd, and device all behave right.  such testing would
 557  * involve varied read sizes and other operation sequences.
 558  */
 559 static int ch9_postconfig (struct usbtest_dev *dev)
 560 {
 561         struct usb_interface    *iface = dev->intf;
 562         struct usb_device       *udev = interface_to_usbdev (iface);
 563         int                     i, alt, retval;
 564
 565         /* [9.2.3] if there's more than one altsetting, we need to be able to
 566          * set and get each one.  mostly trusts the descriptors from usbcore.
 567          */
 568         for (i = 0; i < iface->num_altsetting; i++) {
 569
 570                 /* 9.2.3 constrains the range here */
 571                 alt = iface->altsetting [i].desc.bAlternateSetting;
 572                 if (alt < 0 || alt >= iface->num_altsetting) {
 573                         dev_dbg (&iface->dev,
 574                                         "invalid alt [%d].bAltSetting = %d\n",
 575                                         i, alt);
 576                 }
 577
 578                 /* [real world] get/set unimplemented if there's only one */
 579                 if (realworld && iface->num_altsetting == 1)
 580                         continue;
 581
 582                 /* [9.4.10] set_interface */
 583                 retval = set_altsetting (dev, alt);
 584                 if (retval) {
 585                         dev_dbg (&iface->dev, "can't set_interface = %d, %d\n",
 586                                         alt, retval);
 587                         return retval;
 588                 }
 589
 590                 /* [9.4.4] get_interface always works */
 591                 retval = get_altsetting (dev);
 592                 if (retval != alt) {
 593                         dev_dbg (&iface->dev, "get alt should be %d, was %d\n",
 594                                         alt, retval);
 595                         return (retval < 0) ? retval : -EDOM;
 596                 }
 597
 598         }
 599
 600         /* [real world] get_config unimplemented if there's only one */
 601         if (!realworld || udev->descriptor.bNumConfigurations != 1) {
 602                 int     expected = udev->actconfig->desc.bConfigurationValue;
 603
 604                 /* [9.4.2] get_configuration always works
 605                  * ... although some cheap devices (like one TI Hub I've got)
 606                  * won't return config descriptors except before set_config.
 607                  */
 608                 retval = usb_control_msg (udev, usb_rcvctrlpipe (udev, 0),
 609                                 USB_REQ_GET_CONFIGURATION,
 610                                 USB_DIR_IN | USB_RECIP_DEVICE,
 611                                 0, 0, dev->buf, 1, USB_CTRL_GET_TIMEOUT);
 612                 if (retval != 1 || dev->buf [0] != expected) {
 613                         dev_dbg (&iface->dev, "get config --> %d %d (1 %d)\n",
 614                                 retval, dev->buf[0], expected);
 615                         return (retval < 0) ? retval : -EDOM;
 616                 }
 617         }
 618
 619         /* there's always [9.4.3] a device descriptor [9.6.1] */
 620         retval = usb_get_descriptor (udev, USB_DT_DEVICE, 0,
 621                         dev->buf, sizeof udev->descriptor);
 622         if (retval != sizeof udev->descriptor) {
 623                 dev_dbg (&iface->dev, "dev descriptor --> %d\n", retval);
 624                 return (retval < 0) ? retval : -EDOM;
 625         }
 626
 627         /* there's always [9.4.3] at least one config descriptor [9.6.3] */
 628         for (i = 0; i < udev->descriptor.bNumConfigurations; i++) {
 629                 retval = usb_get_descriptor (udev, USB_DT_CONFIG, i,
 630                                 dev->buf, TBUF_SIZE);
 631                 if (!is_good_config (dev->buf, retval)) {
 632                         dev_dbg (&iface->dev,
 633                                         "config [%d] descriptor --> %d\n",
 634                                         i, retval);
 635                         return (retval < 0) ? retval : -EDOM;
 636                 }
 637
 638                 // FIXME cross-checking udev->config[i] to make sure usbcore
 639                 // parsed it right (etc) would be good testing paranoia
 640         }
 641
 642         /* and sometimes [9.2.6.6] speed dependent descriptors */
 643         if (le16_to_cpu(udev->descriptor.bcdUSB) == 0x0200) {
 644                 struct usb_qualifier_descriptor         *d = NULL;
 645
 646                 /* device qualifier [9.6.2] */
 647                 retval = usb_get_descriptor (udev,
 648                                 USB_DT_DEVICE_QUALIFIER, 0, dev->buf,
 649                                 sizeof (struct usb_qualifier_descriptor));
 650                 if (retval == -EPIPE) {
 651                         if (udev->speed == USB_SPEED_HIGH) {
 652                                 dev_dbg (&iface->dev,
 653                                                 "hs dev qualifier --> %d\n",
 654                                                 retval);
 655                                 return (retval < 0) ? retval : -EDOM;
 656                         }
 657                         /* usb2.0 but not high-speed capable; fine */
 658                 } else if (retval != sizeof (struct usb_qualifier_descriptor)) {
 659                         dev_dbg (&iface->dev, "dev qualifier --> %d\n", retval);
 660                         return (retval < 0) ? retval : -EDOM;
 661                 } else
 662                         d = (struct usb_qualifier_descriptor *) dev->buf;
 663
 664                 /* might not have [9.6.2] any other-speed configs [9.6.4] */
 665                 if (d) {
 666                         unsigned max = d->bNumConfigurations;
 667                         for (i = 0; i < max; i++) {
 668                                 retval = usb_get_descriptor (udev,
 669                                         USB_DT_OTHER_SPEED_CONFIG, i,
 670                                         dev->buf, TBUF_SIZE);
 671                                 if (!is_good_config (dev->buf, retval)) {
 672                                         dev_dbg (&iface->dev,
 673                                                 "other speed config --> %d\n",
 674                                                 retval);
 675                                         return (retval < 0) ? retval : -EDOM;
 676                                 }
 677                         }
 678                 }
 679         }
 680         // FIXME fetch strings from at least the device descriptor
 681
 682         /* [9.4.5] get_status always works */
 683         retval = usb_get_status (udev, USB_RECIP_DEVICE, 0, dev->buf);
 684         if (retval != 2) {
 685                 dev_dbg (&iface->dev, "get dev status --> %d\n", retval);
 686                 return (retval < 0) ? retval : -EDOM;
 687         }
 688
 689         // FIXME configuration.bmAttributes says if we could try to set/clear
 690         // the device's remote wakeup feature ... if we can, test that here
 691
 692         retval = usb_get_status (udev, USB_RECIP_INTERFACE,
 693                         iface->altsetting [0].desc.bInterfaceNumber, dev->buf);
 694         if (retval != 2) {
 695                 dev_dbg (&iface->dev, "get interface status --> %d\n", retval);
 696                 return (retval < 0) ? retval : -EDOM;
 697         }
 698         // FIXME get status for each endpoint in the interface
 699
 700         return 0;
 701 }
 702
 703 /*-------------------------------------------------------------------------*/
 704
 705 /* use ch9 requests to test whether:
 706  *   (a) queues work for control, keeping N subtests queued and
 707  *       active (auto-resubmit) for M loops through the queue.
 708  *   (b) protocol stalls (control-only) will autorecover.
 709  *       it's not like bulk/intr; no halt clearing.
 710  *   (c) short control reads are reported and handled.
 711  *   (d) queues are always processed in-order
 712  */
 713
 714 struct ctrl_ctx {
 715         spinlock_t              lock;
 716         struct usbtest_dev      *dev;
 717         struct completion       complete;
 718         unsigned                count;
 719         unsigned                pending;
 720         int                     status;
 721         struct urb              **urb;
 722         struct usbtest_param    *param;
 723         int                     last;
 724 };
 725
 726 #define NUM_SUBCASES    15              /* how many test subcases here? */
 727
 728 struct subcase {
 729         struct usb_ctrlrequest  setup;
 730         int                     number;
 731         int                     expected;
 732 };
 733
 734 static void ctrl_complete (struct urb *urb)
 735 {
 736         struct ctrl_ctx         *ctx = urb->context;
 737         struct usb_ctrlrequest  *reqp;
 738         struct subcase          *subcase;
 739         int                     status = urb->status;
 740
 741         reqp = (struct usb_ctrlrequest *)urb->setup_packet;
 742         subcase = container_of (reqp, struct subcase, setup);
 743
 744         spin_lock (&ctx->lock);
 745         ctx->count--;
 746         ctx->pending--;
 747
 748         /* queue must transfer and complete in fifo order, unless
 749          * usb_unlink_urb() is used to unlink something not at the
 750          * physical queue head (not tested).
 751          */
 752         if (subcase->number > 0) {
 753                 if ((subcase->number - ctx->last) != 1) {
 754                         dbg ("subcase %d completed out of order, last %d",
 755                                         subcase->number, ctx->last);
 756                         status = -EDOM;
 757                         ctx->last = subcase->number;
 758                         goto error;
 759                 }
 760         }
 761         ctx->last = subcase->number;
 762
 763         /* succeed or fault in only one way? */
 764         if (status == subcase->expected)
 765                 status = 0;
 766
 767         /* async unlink for cleanup? */
 768         else if (status != -ECONNRESET) {
 769
 770                 /* some faults are allowed, not required */
 771                 if (subcase->expected > 0 && (
 772                           ((status == -subcase->expected        /* happened */
 773                            || status == 0))))                   /* didn't */
 774                         status = 0;
 775                 /* sometimes more than one fault is allowed */
 776                 else if (subcase->number == 12 && status == -EPIPE)
 777                         status = 0;
 778                 else
 779                         dbg ("subtest %d error, status %d",
 780                                         subcase->number, status);
 781         }
 782
 783         /* unexpected status codes mean errors; ideally, in hardware */
 784         if (status) {
 785 error:
 786                 if (ctx->status == 0) {
 787                         int             i;
 788
 789                         ctx->status = status;
 790                         info ("control queue %02x.%02x, err %d, %d left",
 791                                         reqp->bRequestType, reqp->bRequest,
 792                                         status, ctx->count);
 793
 794                         /* FIXME this "unlink everything" exit route should
 795                          * be a separate test case.
 796                          */
 797
 798                         /* unlink whatever's still pending */
 799                         for (i = 1; i < ctx->param->sglen; i++) {
 800                                 struct urb      *u = ctx->urb [
 801         (i + subcase->number) % ctx->param->sglen];
 802
 803                                 if (u == urb || !u->dev)
 804                                         continue;
 805                                 spin_unlock(&ctx->lock);
 806                                 status = usb_unlink_urb (u);
 807                                 spin_lock(&ctx->lock);
 808                                 switch (status) {
 809                                 case -EINPROGRESS:
 810                                 case -EBUSY:
 811                                 case -EIDRM:
 812                                         continue;
 813                                 default:
 814                                         dbg ("urb unlink --> %d", status);
 815                                 }
 816                         }
 817                         status = ctx->status;
 818                 }
 819         }
 820
 821         /* resubmit if we need to, else mark this as done */
 822         if ((status == 0) && (ctx->pending < ctx->count)) {
 823                 if ((status = usb_submit_urb (urb, GFP_ATOMIC)) != 0) {
 824                         dbg ("can't resubmit ctrl %02x.%02x, err %d",
 825                                 reqp->bRequestType, reqp->bRequest, status);
 826                         urb->dev = NULL;
 827                 } else
 828                         ctx->pending++;
 829         } else
 830                 urb->dev = NULL;
 831
 832         /* signal completion when nothing's queued */
 833         if (ctx->pending == 0)
 834                 complete (&ctx->complete);
 835         spin_unlock (&ctx->lock);
 836 }
 837
 838 static int
 839 test_ctrl_queue (struct usbtest_dev *dev, struct usbtest_param *param)
 840 {
 841         struct usb_device       *udev = testdev_to_usbdev (dev);
 842         struct urb              **urb;
 843         struct ctrl_ctx         context;
 844         int                     i;
 845
 846         spin_lock_init (&context.lock);
 847         context.dev = dev;
 848         init_completion (&context.complete);
 849         context.count = param->sglen * param->iterations;
 850         context.pending = 0;
 851         context.status = -ENOMEM;
 852         context.param = param;
 853         context.last = -1;
 854
 855         /* allocate and init the urbs we'll queue.
 856          * as with bulk/intr sglists, sglen is the queue depth; it also
 857          * controls which subtests run (more tests than sglen) or rerun.
 858          */
 859         urb = kcalloc(param->sglen, sizeof(struct urb *), GFP_KERNEL);
 860         if (!urb)
 861                 return -ENOMEM;
 862         for (i = 0; i < param->sglen; i++) {
 863                 int                     pipe = usb_rcvctrlpipe (udev, 0);
 864                 unsigned                len;
 865                 struct urb              *u;
 866                 struct usb_ctrlrequest  req;
 867                 struct subcase          *reqp;
 868                 int                     expected = 0;
 869
 870                 /* requests here are mostly expected to succeed on any
 871                  * device, but some are chosen to trigger protocol stalls
 872                  * or short reads.
 873                  */
 874                 memset (&req, 0, sizeof req);
 875                 req.bRequest = USB_REQ_GET_DESCRIPTOR;
 876                 req.bRequestType = USB_DIR_IN|USB_RECIP_DEVICE;
 877
 878                 switch (i % NUM_SUBCASES) {
 879                 case 0:         // get device descriptor
 880                         req.wValue = cpu_to_le16 (USB_DT_DEVICE << 8);
 881                         len = sizeof (struct usb_device_descriptor);
 882                         break;
 883                 case 1:         // get first config descriptor (only)
 884                         req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
 885                         len = sizeof (struct usb_config_descriptor);
 886                         break;
 887                 case 2:         // get altsetting (OFTEN STALLS)
 888                         req.bRequest = USB_REQ_GET_INTERFACE;
 889                         req.bRequestType = USB_DIR_IN|USB_RECIP_INTERFACE;
 890                         // index = 0 means first interface
 891                         len = 1;
 892                         expected = EPIPE;
 893                         break;
 894                 case 3:         // get interface status
 895                         req.bRequest = USB_REQ_GET_STATUS;
 896                         req.bRequestType = USB_DIR_IN|USB_RECIP_INTERFACE;
 897                         // interface 0
 898                         len = 2;
 899                         break;
 900                 case 4:         // get device status
 901                         req.bRequest = USB_REQ_GET_STATUS;
 902                         req.bRequestType = USB_DIR_IN|USB_RECIP_DEVICE;
 903                         len = 2;
 904                         break;
 905                 case 5:         // get device qualifier (MAY STALL)
 906                         req.wValue = cpu_to_le16 (USB_DT_DEVICE_QUALIFIER << 8);
 907                         len = sizeof (struct usb_qualifier_descriptor);
 908                         if (udev->speed != USB_SPEED_HIGH)
 909                                 expected = EPIPE;
 910                         break;
 911                 case 6:         // get first config descriptor, plus interface
 912                         req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
 913                         len = sizeof (struct usb_config_descriptor);
 914                         len += sizeof (struct usb_interface_descriptor);
 915                         break;
 916                 case 7:         // get interface descriptor (ALWAYS STALLS)
 917                         req.wValue = cpu_to_le16 (USB_DT_INTERFACE << 8);
 918                         // interface == 0
 919                         len = sizeof (struct usb_interface_descriptor);
 920                         expected = EPIPE;
 921                         break;
 922                 // NOTE: two consecutive stalls in the queue here.
 923                 // that tests fault recovery a bit more aggressively.
 924                 case 8:         // clear endpoint halt (USUALLY STALLS)
 925                         req.bRequest = USB_REQ_CLEAR_FEATURE;
 926                         req.bRequestType = USB_RECIP_ENDPOINT;
 927                         // wValue 0 == ep halt
 928                         // wIndex 0 == ep0 (shouldn't halt!)
 929                         len = 0;
 930                         pipe = usb_sndctrlpipe (udev, 0);
 931                         expected = EPIPE;
 932                         break;
 933                 case 9:         // get endpoint status
 934                         req.bRequest = USB_REQ_GET_STATUS;
 935                         req.bRequestType = USB_DIR_IN|USB_RECIP_ENDPOINT;
 936                         // endpoint 0
 937                         len = 2;
 938                         break;
 939                 case 10:        // trigger short read (EREMOTEIO)
 940                         req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
 941                         len = 1024;
 942                         expected = -EREMOTEIO;
 943                         break;
 944                 // NOTE: two consecutive _different_ faults in the queue.
 945                 case 11:        // get endpoint descriptor (ALWAYS STALLS)
 946                         req.wValue = cpu_to_le16 (USB_DT_ENDPOINT << 8);
 947                         // endpoint == 0
 948                         len = sizeof (struct usb_interface_descriptor);
 949                         expected = EPIPE;
 950                         break;
 951                 // NOTE: sometimes even a third fault in the queue!
 952                 case 12:        // get string 0 descriptor (MAY STALL)
 953                         req.wValue = cpu_to_le16 (USB_DT_STRING << 8);
 954                         // string == 0, for language IDs
 955                         len = sizeof (struct usb_interface_descriptor);
 956                         // may succeed when > 4 languages
 957                         expected = EREMOTEIO;   // or EPIPE, if no strings
 958                         break;
 959                 case 13:        // short read, resembling case 10
 960                         req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
 961                         // last data packet "should" be DATA1, not DATA0
 962                         len = 1024 - udev->descriptor.bMaxPacketSize0;
 963                         expected = -EREMOTEIO;
 964                         break;
 965                 case 14:        // short read; try to fill the last packet
 966                         req.wValue = cpu_to_le16 ((USB_DT_DEVICE << 8) | 0);
 967                         // device descriptor size == 18 bytes
 968                         len = udev->descriptor.bMaxPacketSize0;
 969                         switch (len) {
 970                         case 8:         len = 24; break;
 971                         case 16:        len = 32; break;
 972                         }
 973                         expected = -EREMOTEIO;
 974                         break;
 975                 default:
 976                         err ("bogus number of ctrl queue testcases!");
 977                         context.status = -EINVAL;
 978                         goto cleanup;
 979                 }
 980                 req.wLength = cpu_to_le16 (len);
 981                 urb [i] = u = simple_alloc_urb (udev, pipe, len);
 982                 if (!u)
 983                         goto cleanup;
 984
 985                 reqp = usb_buffer_alloc (udev, sizeof *reqp, GFP_KERNEL,
 986                                 &u->setup_dma);
 987                 if (!reqp)
 988                         goto cleanup;
 989                 reqp->setup = req;
 990                 reqp->number = i % NUM_SUBCASES;
 991                 reqp->expected = expected;
 992                 u->setup_packet = (char *) &reqp->setup;
 993                 u->transfer_flags |= URB_NO_SETUP_DMA_MAP;
 994
 995                 u->context = &context;
 996                 u->complete = ctrl_complete;
 997         }
 998
 999         /* queue the urbs */
1000         context.urb = urb;
1001         spin_lock_irq (&context.lock);
1002         for (i = 0; i < param->sglen; i++) {
1003                 context.status = usb_submit_urb (urb [i], GFP_ATOMIC);
1004                 if (context.status != 0) {
1005                         dbg ("can't submit urb[%d], status %d",
1006                                         i, context.status);
1007                         context.count = context.pending;
1008                         break;
1009                 }
1010                 context.pending++;
1011         }
1012         spin_unlock_irq (&context.lock);
1013
1014         /* FIXME  set timer and time out; provide a disconnect hook */
1015
1016         /* wait for the last one to complete */
1017         if (context.pending > 0)
1018                 wait_for_completion (&context.complete);
1019
1020 cleanup:
1021         for (i = 0; i < param->sglen; i++) {
1022                 if (!urb [i])
1023                         continue;
1024                 urb [i]->dev = udev;
1025                 if (urb [i]->setup_packet)
1026                         usb_buffer_free (udev, sizeof (struct usb_ctrlrequest),
1027                                         urb [i]->setup_packet,
1028                                         urb [i]->setup_dma);
1029                 simple_free_urb (urb [i]);
1030         }
1031         kfree (urb);
1032         return context.status;
1033 }
1034 #undef NUM_SUBCASES
1035
1036
1037 /*-------------------------------------------------------------------------*/
1038
1039 static void unlink1_callback (struct urb *urb)
1040 {
1041         int     status = urb->status;
1042
1043         // we "know" -EPIPE (stall) never happens
1044         if (!status)
1045                 status = usb_submit_urb (urb, GFP_ATOMIC);
1046         if (status) {
1047                 urb->status = status;
1048                 complete ((struct completion *) urb->context);
1049         }
1050 }
1051
1052 static int unlink1 (struct usbtest_dev *dev, int pipe, int size, int async)
1053 {
1054         struct urb              *urb;
1055         struct completion       completion;
1056         int                     retval = 0;
1057
1058         init_completion (&completion);
1059         urb = simple_alloc_urb (testdev_to_usbdev (dev), pipe, size);
1060         if (!urb)
1061                 return -ENOMEM;
1062         urb->context = &completion;
1063         urb->complete = unlink1_callback;
1064
1065         /* keep the endpoint busy.  there are lots of hc/hcd-internal
1066          * states, and testing should get to all of them over time.
1067          *
1068          * FIXME want additional tests for when endpoint is STALLing
1069          * due to errors, or is just NAKing requests.
1070          */
1071         if ((retval = usb_submit_urb (urb, GFP_KERNEL)) != 0) {
1072                 dev_dbg (&dev->intf->dev, "submit fail %d\n", retval);
1073                 return retval;
1074         }
1075
1076         /* unlinking that should always work.  variable delay tests more
1077          * hcd states and code paths, even with little other system load.
1078          */
1079         msleep (jiffies % (2 * INTERRUPT_RATE));
1080         if (async) {
1081 retry:
1082                 retval = usb_unlink_urb (urb);
1083                 if (retval == -EBUSY || retval == -EIDRM) {
1084                         /* we can't unlink urbs while they're completing.
1085                          * or if they've completed, and we haven't resubmitted.
1086                          * "normal" drivers would prevent resubmission, but
1087                          * since we're testing unlink paths, we can't.
1088                          */
1089                         dev_dbg (&dev->intf->dev, "unlink retry\n");
1090                         goto retry;
1091                 }
1092         } else
1093                 usb_kill_urb (urb);
1094         if (!(retval == 0 || retval == -EINPROGRESS)) {
1095                 dev_dbg (&dev->intf->dev, "unlink fail %d\n", retval);
1096                 return retval;
1097         }
1098
1099         wait_for_completion (&completion);
1100         retval = urb->status;
1101         simple_free_urb (urb);
1102
1103         if (async)
1104                 return (retval == -ECONNRESET) ? 0 : retval - 1000;
1105         else
1106                 return (retval == -ENOENT || retval == -EPERM) ?
1107                                 0 : retval - 2000;
1108 }
1109
1110 static int unlink_simple (struct usbtest_dev *dev, int pipe, int len)
1111 {
1112         int                     retval = 0;
1113
1114         /* test sync and async paths */
1115         retval = unlink1 (dev, pipe, len, 1);
1116         if (!retval)
1117                 retval = unlink1 (dev, pipe, len, 0);
1118         return retval;
1119 }
1120
1121 /*-------------------------------------------------------------------------*/
1122
1123 static int verify_not_halted (int ep, struct urb *urb)
1124 {
1125         int     retval;
1126         u16     status;
1127
1128         /* shouldn't look or act halted */
1129         retval = usb_get_status (urb->dev, USB_RECIP_ENDPOINT, ep, &status);
1130         if (retval < 0) {
1131                 dbg ("ep %02x couldn't get no-halt status, %d", ep, retval);
1132                 return retval;
1133         }
1134         if (status != 0) {
1135                 dbg ("ep %02x bogus status: %04x != 0", ep, status);
1136                 return -EINVAL;
1137         }
1138         retval = simple_io (urb, 1, 0, 0, __FUNCTION__);
1139         if (retval != 0)
1140                 return -EINVAL;
1141         return 0;
1142 }
1143
1144 static int verify_halted (int ep, struct urb *urb)
1145 {
1146         int     retval;
1147         u16     status;
1148
1149         /* should look and act halted */
1150         retval = usb_get_status (urb->dev, USB_RECIP_ENDPOINT, ep, &status);
1151         if (retval < 0) {
1152                 dbg ("ep %02x couldn't get halt status, %d", ep, retval);
1153                 return retval;
1154         }
1155         le16_to_cpus(&status);
1156         if (status != 1) {
1157                 dbg ("ep %02x bogus status: %04x != 1", ep, status);
1158                 return -EINVAL;
1159         }
1160         retval = simple_io (urb, 1, 0, -EPIPE, __FUNCTION__);
1161         if (retval != -EPIPE)
1162                 return -EINVAL;
1163         retval = simple_io (urb, 1, 0, -EPIPE, "verify_still_halted");
1164         if (retval != -EPIPE)
1165                 return -EINVAL;
1166         return 0;
1167 }
1168
1169 static int test_halt (int ep, struct urb *urb)
1170 {
1171         int     retval;
1172
1173         /* shouldn't look or act halted now */
1174         retval = verify_not_halted (ep, urb);
1175         if (retval < 0)
1176                 return retval;
1177
1178         /* set halt (protocol test only), verify it worked */
1179         retval = usb_control_msg (urb->dev, usb_sndctrlpipe (urb->dev, 0),
1180                         USB_REQ_SET_FEATURE, USB_RECIP_ENDPOINT,
1181                         USB_ENDPOINT_HALT, ep,
1182                         NULL, 0, USB_CTRL_SET_TIMEOUT);
1183         if (retval < 0) {
1184                 dbg ("ep %02x couldn't set halt, %d", ep, retval);
1185                 return retval;
1186         }
1187         retval = verify_halted (ep, urb);
1188         if (retval < 0)
1189                 return retval;
1190
1191         /* clear halt (tests API + protocol), verify it worked */
1192         retval = usb_clear_halt (urb->dev, urb->pipe);
1193         if (retval < 0) {
1194                 dbg ("ep %02x couldn't clear halt, %d", ep, retval);
1195                 return retval;
1196         }
1197         retval = verify_not_halted (ep, urb);
1198         if (retval < 0)
1199                 return retval;
1200
1201         /* NOTE:  could also verify SET_INTERFACE clear halts ... */
1202
1203         return 0;
1204 }
1205
1206 static int halt_simple (struct usbtest_dev *dev)
1207 {
1208         int             ep;
1209         int             retval = 0;
1210         struct urb      *urb;
1211
1212         urb = simple_alloc_urb (testdev_to_usbdev (dev), 0, 512);
1213         if (urb == NULL)
1214                 return -ENOMEM;
1215
1216         if (dev->in_pipe) {
1217                 ep = usb_pipeendpoint (dev->in_pipe) | USB_DIR_IN;
1218                 urb->pipe = dev->in_pipe;
1219                 retval = test_halt (ep, urb);
1220                 if (retval < 0)
1221                         goto done;
1222         }
1223
1224         if (dev->out_pipe) {
1225                 ep = usb_pipeendpoint (dev->out_pipe);
1226                 urb->pipe = dev->out_pipe;
1227                 retval = test_halt (ep, urb);
1228         }
1229 done:
1230         simple_free_urb (urb);
1231         return retval;
1232 }
1233
1234 /*-------------------------------------------------------------------------*/
1235
1236 /* Control OUT tests use the vendor control requests from Intel's
1237  * USB 2.0 compliance test device:  write a buffer, read it back.
1238  *
1239  * Intel's spec only _requires_ that it work for one packet, which
1240  * is pretty weak.   Some HCDs place limits here; most devices will
1241  * need to be able to handle more than one OUT data packet.  We'll
1242  * try whatever we're told to try.
1243  */
1244 static int ctrl_out (struct usbtest_dev *dev,
1245                 unsigned count, unsigned length, unsigned vary)
1246 {
1247         unsigned                i, j, len;
1248         int                     retval;
1249         u8                      *buf;
1250         char                    *what = "?";
1251         struct usb_device       *udev;
1252
1253         if (length < 1 || length > 0xffff || vary >= length)
1254                 return -EINVAL;
1255
1256         buf = kmalloc(length, GFP_KERNEL);
1257         if (!buf)
1258                 return -ENOMEM;
1259
1260         udev = testdev_to_usbdev (dev);
1261         len = length;
1262         retval = 0;
1263
1264         /* NOTE:  hardware might well act differently if we pushed it
1265          * with lots back-to-back queued requests.
1266          */
1267         for (i = 0; i < count; i++) {
1268                 /* write patterned data */
1269                 for (j = 0; j < len; j++)
1270                         buf [j] = i + j;
1271                 retval = usb_control_msg (udev, usb_sndctrlpipe (udev,0),
1272                                 0x5b, USB_DIR_OUT|USB_TYPE_VENDOR,
1273                                 0, 0, buf, len, USB_CTRL_SET_TIMEOUT);
1274                 if (retval != len) {
1275                         what = "write";
1276                         if (retval >= 0) {
1277                                 INFO(dev, "ctrl_out, wlen %d (expected %d)\n",
1278                                                 retval, len);
1279                                 retval = -EBADMSG;
1280                         }
1281                         break;
1282                 }
1283
1284                 /* read it back -- assuming nothing intervened!!  */
1285                 retval = usb_control_msg (udev, usb_rcvctrlpipe (udev,0),
1286                                 0x5c, USB_DIR_IN|USB_TYPE_VENDOR,
1287                                 0, 0, buf, len, USB_CTRL_GET_TIMEOUT);
1288                 if (retval != len) {
1289                         what = "read";
1290                         if (retval >= 0) {
1291                                 INFO(dev, "ctrl_out, rlen %d (expected %d)\n",
1292                                                 retval, len);
1293                                 retval = -EBADMSG;
1294                         }
1295                         break;
1296                 }
1297
1298                 /* fail if we can't verify */
1299                 for (j = 0; j < len; j++) {
1300                         if (buf [j] != (u8) (i + j)) {
1301                                 INFO (dev, "ctrl_out, byte %d is %d not %d\n",
1302                                         j, buf [j], (u8) i + j);
1303                                 retval = -EBADMSG;
1304                                 break;
1305                         }
1306                 }
1307                 if (retval < 0) {
1308                         what = "verify";
1309                         break;
1310                 }
1311
1312                 len += vary;
1313
1314                 /* [real world] the "zero bytes IN" case isn't really used.
1315                  * hardware can easily trip up in this weird case, since its
1316                  * status stage is IN, not OUT like other ep0in transfers.
1317                  */
1318                 if (len > length)
1319                         len = realworld ? 1 : 0;
1320         }
1321
1322         if (retval < 0)
1323                 INFO (dev, "ctrl_out %s failed, code %d, count %d\n",
1324                         what, retval, i);
1325
1326         kfree (buf);
1327         return retval;
1328 }
1329
1330 /*-------------------------------------------------------------------------*/
1331
1332 /* ISO tests ... mimics common usage
1333  *  - buffer length is split into N packets (mostly maxpacket sized)
1334  *  - multi-buffers according to sglen
1335  */
1336
1337 struct iso_context {
1338         unsigned                count;
1339         unsigned                pending;
1340         spinlock_t              lock;
1341         struct completion       done;
1342         int                     submit_error;
1343         unsigned long           errors;
1344         unsigned long           packet_count;
1345         struct usbtest_dev      *dev;
1346 };
1347
1348 static void iso_callback (struct urb *urb)
1349 {
1350         struct iso_context      *ctx = urb->context;
1351
1352         spin_lock(&ctx->lock);
1353         ctx->count--;
1354
1355         ctx->packet_count += urb->number_of_packets;
1356         if (urb->error_count > 0)
1357                 ctx->errors += urb->error_count;
1358         else if (urb->status != 0)
1359                 ctx->errors += urb->number_of_packets;
1360
1361         if (urb->status == 0 && ctx->count > (ctx->pending - 1)
1362                         && !ctx->submit_error) {
1363                 int status = usb_submit_urb (urb, GFP_ATOMIC);
1364                 switch (status) {
1365                 case 0:
1366                         goto done;
1367                 default:
1368                         dev_dbg (&ctx->dev->intf->dev,
1369                                         "iso resubmit err %d\n",
1370                                         status);
1371                         /* FALLTHROUGH */
1372                 case -ENODEV:                   /* disconnected */
1373                 case -ESHUTDOWN:                /* endpoint disabled */
1374                         ctx->submit_error = 1;
1375                         break;
1376                 }
1377         }
1378         simple_free_urb (urb);
1379
1380         ctx->pending--;
1381         if (ctx->pending == 0) {
1382                 if (ctx->errors)
1383                         dev_dbg (&ctx->dev->intf->dev,
1384                                 "iso test, %lu errors out of %lu\n",
1385                                 ctx->errors, ctx->packet_count);
1386                 complete (&ctx->done);
1387         }
1388 done:
1389         spin_unlock(&ctx->lock);
1390 }
1391
1392 static struct urb *iso_alloc_urb (
1393         struct usb_device       *udev,
1394         int                     pipe,
1395         struct usb_endpoint_descriptor  *desc,
1396         long                    bytes
1397 )
1398 {
1399         struct urb              *urb;
1400         unsigned                i, maxp, packets;
1401
1402         if (bytes < 0 || !desc)
1403                 return NULL;
1404         maxp = 0x7ff & le16_to_cpu(desc->wMaxPacketSize);
1405         maxp *= 1 + (0x3 & (le16_to_cpu(desc->wMaxPacketSize) >> 11));
1406         packets = (bytes + maxp - 1) / maxp;
1407
1408         urb = usb_alloc_urb (packets, GFP_KERNEL);
1409         if (!urb)
1410                 return urb;
1411         urb->dev = udev;
1412         urb->pipe = pipe;
1413
1414         urb->number_of_packets = packets;
1415         urb->transfer_buffer_length = bytes;
1416         urb->transfer_buffer = usb_buffer_alloc (udev, bytes, GFP_KERNEL,
1417                         &urb->transfer_dma);
1418         if (!urb->transfer_buffer) {
1419                 usb_free_urb (urb);
1420                 return NULL;
1421         }
1422         memset (urb->transfer_buffer, 0, bytes);
1423         for (i = 0; i < packets; i++) {
1424                 /* here, only the last packet will be short */
1425                 urb->iso_frame_desc[i].length = min ((unsigned) bytes, maxp);
1426                 bytes -= urb->iso_frame_desc[i].length;
1427
1428                 urb->iso_frame_desc[i].offset = maxp * i;
1429         }
1430
1431         urb->complete = iso_callback;
1432         // urb->context = SET BY CALLER
1433         urb->interval = 1 << (desc->bInterval - 1);
1434         urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
1435         return urb;
1436 }
1437
1438 static int
1439 test_iso_queue (struct usbtest_dev *dev, struct usbtest_param *param,
1440                 int pipe, struct usb_endpoint_descriptor *desc)
1441 {
1442         struct iso_context      context;
1443         struct usb_device       *udev;
1444         unsigned                i;
1445         unsigned long           packets = 0;
1446         int                     status = 0;
1447         struct urb              *urbs[10];      /* FIXME no limit */
1448
1449         if (param->sglen > 10)
1450                 return -EDOM;
1451
1452         memset(&context, 0, sizeof context);
1453         context.count = param->iterations * param->sglen;
1454         context.dev = dev;
1455         init_completion (&context.done);
1456         spin_lock_init (&context.lock);
1457
1458         memset (urbs, 0, sizeof urbs);
1459         udev = testdev_to_usbdev (dev);
1460         dev_dbg (&dev->intf->dev,
1461                 "... iso period %d %sframes, wMaxPacket %04x\n",
1462                 1 << (desc->bInterval - 1),
1463                 (udev->speed == USB_SPEED_HIGH) ? "micro" : "",
1464                 le16_to_cpu(desc->wMaxPacketSize));
1465
1466         for (i = 0; i < param->sglen; i++) {
1467                 urbs [i] = iso_alloc_urb (udev, pipe, desc,
1468                                 param->length);
1469                 if (!urbs [i]) {
1470                         status = -ENOMEM;
1471                         goto fail;
1472                 }
1473                 packets += urbs[i]->number_of_packets;
1474                 urbs [i]->context = &context;
1475         }
1476         packets *= param->iterations;
1477         dev_dbg (&dev->intf->dev,
1478                 "... total %lu msec (%lu packets)\n",
1479                 (packets * (1 << (desc->bInterval - 1)))
1480                         / ((udev->speed == USB_SPEED_HIGH) ? 8 : 1),
1481                 packets);
1482
1483         spin_lock_irq (&context.lock);
1484         for (i = 0; i < param->sglen; i++) {
1485                 ++context.pending;
1486                 status = usb_submit_urb (urbs [i], GFP_ATOMIC);
1487                 if (status < 0) {
1488                         ERROR (dev, "submit iso[%d], error %d\n", i, status);
1489                         if (i == 0) {
1490                                 spin_unlock_irq (&context.lock);
1491                                 goto fail;
1492                         }
1493
1494                         simple_free_urb (urbs [i]);
1495                         context.pending--;
1496                         context.submit_error = 1;
1497                         break;
1498                 }
1499         }
1500         spin_unlock_irq (&context.lock);
1501
1502         wait_for_completion (&context.done);
1503
1504         /*
1505          * Isochronous transfers are expected to fail sometimes.  As an
1506          * arbitrary limit, we will report an error if any submissions
1507          * fail or if the transfer failure rate is > 10%.
1508          */
1509         if (status != 0)
1510                 ;
1511         else if (context.submit_error)
1512                 status = -EACCES;
1513         else if (context.errors > context.packet_count / 10)
1514                 status = -EIO;
1515         return status;
1516
1517 fail:
1518         for (i = 0; i < param->sglen; i++) {
1519                 if (urbs [i])
1520                         simple_free_urb (urbs [i]);
1521         }
1522         return status;
1523 }
1524
1525 /*-------------------------------------------------------------------------*/
1526
1527 /* We only have this one interface to user space, through usbfs.
1528  * User mode code can scan usbfs to find N different devices (maybe on
1529  * different busses) to use when testing, and allocate one thread per
1530  * test.  So discovery is simplified, and we have no device naming issues.
1531  *
1532  * Don't use these only as stress/load tests.  Use them along with with
1533  * other USB bus activity:  plugging, unplugging, mousing, mp3 playback,
1534  * video capture, and so on.  Run different tests at different times, in
1535  * different sequences.  Nothing here should interact with other devices,
1536  * except indirectly by consuming USB bandwidth and CPU resources for test
1537  * threads and request completion.  But the only way to know that for sure
1538  * is to test when HC queues are in use by many devices.
1539  */
1540
1541 static int
1542 usbtest_ioctl (struct usb_interface *intf, unsigned int code, void *buf)
1543 {
1544         struct usbtest_dev      *dev = usb_get_intfdata (intf);
1545         struct usb_device       *udev = testdev_to_usbdev (dev);
1546         struct usbtest_param    *param = buf;
1547         int                     retval = -EOPNOTSUPP;
1548         struct urb              *urb;
1549         struct scatterlist      *sg;
1550         struct usb_sg_request   req;
1551         struct timeval          start;
1552         unsigned                i;
1553
1554         // FIXME USBDEVFS_CONNECTINFO doesn't say how fast the device is.
1555
1556         if (code != USBTEST_REQUEST)
1557                 return -EOPNOTSUPP;
1558
1559         if (param->iterations <= 0 || param->length < 0
1560                         || param->sglen < 0 || param->vary < 0)
1561                 return -EINVAL;
1562
1563         if (mutex_lock_interruptible(&dev->lock))
1564                 return -ERESTARTSYS;
1565
1566         if (intf->dev.power.power_state.event != PM_EVENT_ON) {
1567                 mutex_unlock(&dev->lock);
1568                 return -EHOSTUNREACH;
1569         }
1570
1571         /* some devices, like ez-usb default devices, need a non-default
1572          * altsetting to have any active endpoints.  some tests change
1573          * altsettings; force a default so most tests don't need to check.
1574          */
1575         if (dev->info->alt >= 0) {
1576                 int     res;
1577
1578                 if (intf->altsetting->desc.bInterfaceNumber) {
1579                         mutex_unlock(&dev->lock);
1580                         return -ENODEV;
1581                 }
1582                 res = set_altsetting (dev, dev->info->alt);
1583                 if (res) {
1584                         dev_err (&intf->dev,
1585                                         "set altsetting to %d failed, %d\n",
1586                                         dev->info->alt, res);
1587                         mutex_unlock(&dev->lock);
1588                         return res;
1589                 }
1590         }
1591
1592         /*
1593          * Just a bunch of test cases that every HCD is expected to handle.
1594          *
1595          * Some may need specific firmware, though it'd be good to have
1596          * one firmware image to handle all the test cases.
1597          *
1598          * FIXME add more tests!  cancel requests, verify the data, control
1599          * queueing, concurrent read+write threads, and so on.
1600          */
1601         do_gettimeofday (&start);
1602         switch (param->test_num) {
1603
1604         case 0:
1605                 dev_dbg (&intf->dev, "TEST 0:  NOP\n");
1606                 retval = 0;
1607                 break;
1608
1609         /* Simple non-queued bulk I/O tests */
1610         case 1:
1611                 if (dev->out_pipe == 0)
1612                         break;
1613                 dev_dbg (&intf->dev,
1614                                 "TEST 1:  write %d bytes %u times\n",
1615                                 param->length, param->iterations);
1616                 urb = simple_alloc_urb (udev, dev->out_pipe, param->length);
1617                 if (!urb) {
1618                         retval = -ENOMEM;
1619                         break;
1620                 }
1621                 // FIRMWARE:  bulk sink (maybe accepts short writes)
1622                 retval = simple_io (urb, param->iterations, 0, 0, "test1");
1623                 simple_free_urb (urb);
1624                 break;
1625         case 2:
1626                 if (dev->in_pipe == 0)
1627                         break;
1628                 dev_dbg (&intf->dev,
1629                                 "TEST 2:  read %d bytes %u times\n",
1630                                 param->length, param->iterations);
1631                 urb = simple_alloc_urb (udev, dev->in_pipe, param->length);
1632                 if (!urb) {
1633                         retval = -ENOMEM;
1634                         break;
1635                 }
1636                 // FIRMWARE:  bulk source (maybe generates short writes)
1637                 retval = simple_io (urb, param->iterations, 0, 0, "test2");
1638                 simple_free_urb (urb);
1639                 break;
1640         case 3:
1641                 if (dev->out_pipe == 0 || param->vary == 0)
1642                         break;
1643                 dev_dbg (&intf->dev,
1644                                 "TEST 3:  write/%d 0..%d bytes %u times\n",
1645                                 param->vary, param->length, param->iterations);
1646                 urb = simple_alloc_urb (udev, dev->out_pipe, param->length);
1647                 if (!urb) {
1648                         retval = -ENOMEM;
1649                         break;
1650                 }
1651                 // FIRMWARE:  bulk sink (maybe accepts short writes)
1652                 retval = simple_io (urb, param->iterations, param->vary,
1653                                         0, "test3");
1654                 simple_free_urb (urb);
1655                 break;
1656         case 4:
1657                 if (dev->in_pipe == 0 || param->vary == 0)
1658                         break;
1659                 dev_dbg (&intf->dev,
1660                                 "TEST 4:  read/%d 0..%d bytes %u times\n",
1661                                 param->vary, param->length, param->iterations);
1662                 urb = simple_alloc_urb (udev, dev->in_pipe, param->length);
1663                 if (!urb) {
1664                         retval = -ENOMEM;
1665                         break;
1666                 }
1667                 // FIRMWARE:  bulk source (maybe generates short writes)
1668                 retval = simple_io (urb, param->iterations, param->vary,
1669                                         0, "test4");
1670                 simple_free_urb (urb);
1671                 break;
1672
1673         /* Queued bulk I/O tests */
1674         case 5:
1675                 if (dev->out_pipe == 0 || param->sglen == 0)
1676                         break;
1677                 dev_dbg (&intf->dev,
1678                         "TEST 5:  write %d sglists %d entries of %d bytes\n",
1679                                 param->iterations,
1680                                 param->sglen, param->length);
1681                 sg = alloc_sglist (param->sglen, param->length, 0);
1682                 if (!sg) {
1683                         retval = -ENOMEM;
1684                         break;
1685                 }
1686                 // FIRMWARE:  bulk sink (maybe accepts short writes)
1687                 retval = perform_sglist (udev, param->iterations, dev->out_pipe,
1688                                 &req, sg, param->sglen);
1689                 free_sglist (sg, param->sglen);
1690                 break;
1691
1692         case 6:
1693                 if (dev->in_pipe == 0 || param->sglen == 0)
1694                         break;
1695                 dev_dbg (&intf->dev,
1696                         "TEST 6:  read %d sglists %d entries of %d bytes\n",
1697                                 param->iterations,
1698                                 param->sglen, param->length);
1699                 sg = alloc_sglist (param->sglen, param->length, 0);
1700                 if (!sg) {
1701                         retval = -ENOMEM;
1702                         break;
1703                 }
1704                 // FIRMWARE:  bulk source (maybe generates short writes)
1705                 retval = perform_sglist (udev, param->iterations, dev->in_pipe,
1706                                 &req, sg, param->sglen);
1707                 free_sglist (sg, param->sglen);
1708                 break;
1709         case 7:
1710                 if (dev->out_pipe == 0 || param->sglen == 0 || param->vary == 0)
1711                         break;
1712                 dev_dbg (&intf->dev,
1713                         "TEST 7:  write/%d %d sglists %d entries 0..%d bytes\n",
1714                                 param->vary, param->iterations,
1715                                 param->sglen, param->length);
1716                 sg = alloc_sglist (param->sglen, param->length, param->vary);
1717                 if (!sg) {
1718                         retval = -ENOMEM;
1719                         break;
1720                 }
1721                 // FIRMWARE:  bulk sink (maybe accepts short writes)
1722                 retval = perform_sglist (udev, param->iterations, dev->out_pipe,
1723                                 &req, sg, param->sglen);
1724                 free_sglist (sg, param->sglen);
1725                 break;
1726         case 8:
1727                 if (dev->in_pipe == 0 || param->sglen == 0 || param->vary == 0)
1728                         break;
1729                 dev_dbg (&intf->dev,
1730                         "TEST 8:  read/%d %d sglists %d entries 0..%d bytes\n",
1731                                 param->vary, param->iterations,
1732                                 param->sglen, param->length);
1733                 sg = alloc_sglist (param->sglen, param->length, param->vary);
1734                 if (!sg) {
1735                         retval = -ENOMEM;
1736                         break;
1737                 }
1738                 // FIRMWARE:  bulk source (maybe generates short writes)
1739                 retval = perform_sglist (udev, param->iterations, dev->in_pipe,
1740                                 &req, sg, param->sglen);
1741                 free_sglist (sg, param->sglen);
1742                 break;
1743
1744         /* non-queued sanity tests for control (chapter 9 subset) */
1745         case 9:
1746                 retval = 0;
1747                 dev_dbg (&intf->dev,
1748                         "TEST 9:  ch9 (subset) control tests, %d times\n",
1749                                 param->iterations);
1750                 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1751                         retval = ch9_postconfig (dev);
1752                 if (retval)
1753                         dbg ("ch9 subset failed, iterations left %d", i);
1754                 break;
1755
1756         /* queued control messaging */
1757         case 10:
1758                 if (param->sglen == 0)
1759                         break;
1760                 retval = 0;
1761                 dev_dbg (&intf->dev,
1762                                 "TEST 10:  queue %d control calls, %d times\n",
1763                                 param->sglen,
1764                                 param->iterations);
1765                 retval = test_ctrl_queue (dev, param);
1766                 break;
1767
1768         /* simple non-queued unlinks (ring with one urb) */
1769         case 11:
1770                 if (dev->in_pipe == 0 || !param->length)
1771                         break;
1772                 retval = 0;
1773                 dev_dbg (&intf->dev, "TEST 11:  unlink %d reads of %d\n",
1774                                 param->iterations, param->length);
1775                 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1776                         retval = unlink_simple (dev, dev->in_pipe,
1777                                                 param->length);
1778                 if (retval)
1779                         dev_dbg (&intf->dev, "unlink reads failed %d, "
1780                                 "iterations left %d\n", retval, i);
1781                 break;
1782         case 12:
1783                 if (dev->out_pipe == 0 || !param->length)
1784                         break;
1785                 retval = 0;
1786                 dev_dbg (&intf->dev, "TEST 12:  unlink %d writes of %d\n",
1787                                 param->iterations, param->length);
1788                 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1789                         retval = unlink_simple (dev, dev->out_pipe,
1790                                                 param->length);
1791                 if (retval)
1792                         dev_dbg (&intf->dev, "unlink writes failed %d, "
1793                                 "iterations left %d\n", retval, i);
1794                 break;
1795
1796         /* ep halt tests */
1797         case 13:
1798                 if (dev->out_pipe == 0 && dev->in_pipe == 0)
1799                         break;
1800                 retval = 0;
1801                 dev_dbg (&intf->dev, "TEST 13:  set/clear %d halts\n",
1802                                 param->iterations);
1803                 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1804                         retval = halt_simple (dev);
1805
1806                 if (retval)
1807                         DBG (dev, "halts failed, iterations left %d\n", i);
1808                 break;
1809
1810         /* control write tests */
1811         case 14:
1812                 if (!dev->info->ctrl_out)
1813                         break;
1814                 dev_dbg (&intf->dev, "TEST 14:  %d ep0out, %d..%d vary %d\n",
1815                                 param->iterations,
1816                                 realworld ? 1 : 0, param->length,
1817                                 param->vary);
1818                 retval = ctrl_out (dev, param->iterations,
1819                                 param->length, param->vary);
1820                 break;
1821
1822         /* iso write tests */
1823         case 15:
1824                 if (dev->out_iso_pipe == 0 || param->sglen == 0)
1825                         break;
1826                 dev_dbg (&intf->dev,
1827                         "TEST 15:  write %d iso, %d entries of %d bytes\n",
1828                                 param->iterations,
1829                                 param->sglen, param->length);
1830                 // FIRMWARE:  iso sink
1831                 retval = test_iso_queue (dev, param,
1832                                 dev->out_iso_pipe, dev->iso_out);
1833                 break;
1834
1835         /* iso read tests */
1836         case 16:
1837                 if (dev->in_iso_pipe == 0 || param->sglen == 0)
1838                         break;
1839                 dev_dbg (&intf->dev,
1840                         "TEST 16:  read %d iso, %d entries of %d bytes\n",
1841                                 param->iterations,
1842                                 param->sglen, param->length);
1843                 // FIRMWARE:  iso source
1844                 retval = test_iso_queue (dev, param,
1845                                 dev->in_iso_pipe, dev->iso_in);
1846                 break;
1847
1848         // FIXME unlink from queue (ring with N urbs)
1849
1850         // FIXME scatterlist cancel (needs helper thread)
1851
1852         }
1853         do_gettimeofday (&param->duration);
1854         param->duration.tv_sec -= start.tv_sec;
1855         param->duration.tv_usec -= start.tv_usec;
1856         if (param->duration.tv_usec < 0) {
1857                 param->duration.tv_usec += 1000 * 1000;
1858                 param->duration.tv_sec -= 1;
1859         }
1860         mutex_unlock(&dev->lock);
1861         return retval;
1862 }
1863
1864 /*-------------------------------------------------------------------------*/
1865
1866 static unsigned force_interrupt = 0;
1867 module_param (force_interrupt, uint, 0);
1868 MODULE_PARM_DESC (force_interrupt, "0 = test default; else interrupt");
1869
1870 #ifdef  GENERIC
1871 static unsigned short vendor;
1872 module_param(vendor, ushort, 0);
1873 MODULE_PARM_DESC (vendor, "vendor code (from usb-if)");
1874
1875 static unsigned short product;
1876 module_param(product, ushort, 0);
1877 MODULE_PARM_DESC (product, "product code (from vendor)");
1878 #endif
1879
1880 static int
1881 usbtest_probe (struct usb_interface *intf, const struct usb_device_id *id)
1882 {
1883         struct usb_device       *udev;
1884         struct usbtest_dev      *dev;
1885         struct usbtest_info     *info;
1886         char                    *rtest, *wtest;
1887         char                    *irtest, *iwtest;
1888
1889         udev = interface_to_usbdev (intf);
1890
1891 #ifdef  GENERIC
1892         /* specify devices by module parameters? */
1893         if (id->match_flags == 0) {
1894                 /* vendor match required, product match optional */
1895                 if (!vendor || le16_to_cpu(udev->descriptor.idVendor) != (u16)vendor)
1896                         return -ENODEV;
1897                 if (product && le16_to_cpu(udev->descriptor.idProduct) != (u16)product)
1898                         return -ENODEV;
1899                 dbg ("matched module params, vend=0x%04x prod=0x%04x",
1900                                 le16_to_cpu(udev->descriptor.idVendor),
1901                                 le16_to_cpu(udev->descriptor.idProduct));
1902         }
1903 #endif
1904
1905         dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1906         if (!dev)
1907                 return -ENOMEM;
1908         info = (struct usbtest_info *) id->driver_info;
1909         dev->info = info;
1910         mutex_init(&dev->lock);
1911
1912         dev->intf = intf;
1913
1914         /* cacheline-aligned scratch for i/o */
1915         if ((dev->buf = kmalloc (TBUF_SIZE, GFP_KERNEL)) == NULL) {
1916                 kfree (dev);
1917                 return -ENOMEM;
1918         }
1919
1920         /* NOTE this doesn't yet test the handful of difference that are
1921          * visible with high speed interrupts:  bigger maxpacket (1K) and
1922          * "high bandwidth" modes (up to 3 packets/uframe).
1923          */
1924         rtest = wtest = "";
1925         irtest = iwtest = "";
1926         if (force_interrupt || udev->speed == USB_SPEED_LOW) {
1927                 if (info->ep_in) {
1928                         dev->in_pipe = usb_rcvintpipe (udev, info->ep_in);
1929                         rtest = " intr-in";
1930                 }
1931                 if (info->ep_out) {
1932                         dev->out_pipe = usb_sndintpipe (udev, info->ep_out);
1933                         wtest = " intr-out";
1934                 }
1935         } else {
1936                 if (info->autoconf) {
1937                         int status;
1938
1939                         status = get_endpoints (dev, intf);
1940                         if (status < 0) {
1941                                 dbg ("couldn't get endpoints, %d\n", status);
1942                                 return status;
1943                         }
1944                         /* may find bulk or ISO pipes */
1945                 } else {
1946                         if (info->ep_in)
1947                                 dev->in_pipe = usb_rcvbulkpipe (udev,
1948                                                         info->ep_in);
1949                         if (info->ep_out)
1950                                 dev->out_pipe = usb_sndbulkpipe (udev,
1951                                                         info->ep_out);
1952                 }
1953                 if (dev->in_pipe)
1954                         rtest = " bulk-in";
1955                 if (dev->out_pipe)
1956                         wtest = " bulk-out";
1957                 if (dev->in_iso_pipe)
1958                         irtest = " iso-in";
1959                 if (dev->out_iso_pipe)
1960                         iwtest = " iso-out";
1961         }
1962
1963         usb_set_intfdata (intf, dev);
1964         dev_info (&intf->dev, "%s\n", info->name);
1965         dev_info (&intf->dev, "%s speed {control%s%s%s%s%s} tests%s\n",
1966                         ({ char *tmp;
1967                         switch (udev->speed) {
1968                         case USB_SPEED_LOW: tmp = "low"; break;
1969                         case USB_SPEED_FULL: tmp = "full"; break;
1970                         case USB_SPEED_HIGH: tmp = "high"; break;
1971                         default: tmp = "unknown"; break;
1972                         }; tmp; }),
1973                         info->ctrl_out ? " in/out" : "",
1974                         rtest, wtest,
1975                         irtest, iwtest,
1976                         info->alt >= 0 ? " (+alt)" : "");
1977         return 0;
1978 }
1979
1980 static int usbtest_suspend (struct usb_interface *intf, pm_message_t message)
1981 {
1982         return 0;
1983 }
1984
1985 static int usbtest_resume (struct usb_interface *intf)
1986 {
1987         return 0;
1988 }
1989
1990
1991 static void usbtest_disconnect (struct usb_interface *intf)
1992 {
1993         struct usbtest_dev      *dev = usb_get_intfdata (intf);
1994
1995         usb_set_intfdata (intf, NULL);
1996         dev_dbg (&intf->dev, "disconnect\n");
1997         kfree (dev);
1998 }
1999
2000 /* Basic testing only needs a device that can source or sink bulk traffic.
2001  * Any device can test control transfers (default with GENERIC binding).
2002  *
2003  * Several entries work with the default EP0 implementation that's built
2004  * into EZ-USB chips.  There's a default vendor ID which can be overridden
2005  * by (very) small config EEPROMS, but otherwise all these devices act
2006  * identically until firmware is loaded:  only EP0 works.  It turns out
2007  * to be easy to make other endpoints work, without modifying that EP0
2008  * behavior.  For now, we expect that kind of firmware.
2009  */
2010
2011 /* an21xx or fx versions of ez-usb */
2012 static struct usbtest_info ez1_info = {
2013         .name           = "EZ-USB device",
2014         .ep_in          = 2,
2015         .ep_out         = 2,
2016         .alt            = 1,
2017 };
2018
2019 /* fx2 version of ez-usb */
2020 static struct usbtest_info ez2_info = {
2021         .name           = "FX2 device",
2022         .ep_in          = 6,
2023         .ep_out         = 2,
2024         .alt            = 1,
2025 };
2026
2027 /* ezusb family device with dedicated usb test firmware,
2028  */
2029 static struct usbtest_info fw_info = {
2030         .name           = "usb test device",
2031         .ep_in          = 2,
2032         .ep_out         = 2,
2033         .alt            = 1,
2034         .autoconf       = 1,            // iso and ctrl_out need autoconf
2035         .ctrl_out       = 1,
2036         .iso            = 1,            // iso_ep's are #8 in/out
2037 };
2038
2039 /* peripheral running Linux and 'zero.c' test firmware, or
2040  * its user-mode cousin. different versions of this use
2041  * different hardware with the same vendor/product codes.
2042  * host side MUST rely on the endpoint descriptors.
2043  */
2044 static struct usbtest_info gz_info = {
2045         .name           = "Linux gadget zero",
2046         .autoconf       = 1,
2047         .ctrl_out       = 1,
2048         .alt            = 0,
2049 };
2050
2051 static struct usbtest_info um_info = {
2052         .name           = "Linux user mode test driver",
2053         .autoconf       = 1,
2054         .alt            = -1,
2055 };
2056
2057 static struct usbtest_info um2_info = {
2058         .name           = "Linux user mode ISO test driver",
2059         .autoconf       = 1,
2060         .iso            = 1,
2061         .alt            = -1,
2062 };
2063
2064 #ifdef IBOT2
2065 /* this is a nice source of high speed bulk data;
2066  * uses an FX2, with firmware provided in the device
2067  */
2068 static struct usbtest_info ibot2_info = {
2069         .name           = "iBOT2 webcam",
2070         .ep_in          = 2,
2071         .alt            = -1,
2072 };
2073 #endif
2074
2075 #ifdef GENERIC
2076 /* we can use any device to test control traffic */
2077 static struct usbtest_info generic_info = {
2078         .name           = "Generic USB device",
2079         .alt            = -1,
2080 };
2081 #endif
2082
2083 // FIXME remove this
2084 static struct usbtest_info hact_info = {
2085         .name           = "FX2/hact",
2086         //.ep_in                = 6,
2087         .ep_out         = 2,
2088         .alt            = -1,
2089 };
2090
2091
2092 static struct usb_device_id id_table [] = {
2093
2094         { USB_DEVICE (0x0547, 0x1002),
2095                 .driver_info = (unsigned long) &hact_info,
2096                 },
2097
2098         /*-------------------------------------------------------------*/
2099
2100         /* EZ-USB devices which download firmware to replace (or in our
2101          * case augment) the default device implementation.
2102          */
2103
2104         /* generic EZ-USB FX controller */
2105         { USB_DEVICE (0x0547, 0x2235),
2106                 .driver_info = (unsigned long) &ez1_info,
2107                 },
2108
2109         /* CY3671 development board with EZ-USB FX */
2110         { USB_DEVICE (0x0547, 0x0080),
2111                 .driver_info = (unsigned long) &ez1_info,
2112                 },
2113
2114         /* generic EZ-USB FX2 controller (or development board) */
2115         { USB_DEVICE (0x04b4, 0x8613),
2116                 .driver_info = (unsigned long) &ez2_info,
2117                 },
2118
2119         /* re-enumerated usb test device firmware */
2120         { USB_DEVICE (0xfff0, 0xfff0),
2121                 .driver_info = (unsigned long) &fw_info,
2122                 },
2123
2124         /* "Gadget Zero" firmware runs under Linux */
2125         { USB_DEVICE (0x0525, 0xa4a0),
2126                 .driver_info = (unsigned long) &gz_info,
2127                 },
2128
2129         /* so does a user-mode variant */
2130         { USB_DEVICE (0x0525, 0xa4a4),
2131                 .driver_info = (unsigned long) &um_info,
2132                 },
2133
2134         /* ... and a user-mode variant that talks iso */
2135         { USB_DEVICE (0x0525, 0xa4a3),
2136                 .driver_info = (unsigned long) &um2_info,
2137                 },
2138
2139 #ifdef KEYSPAN_19Qi
2140         /* Keyspan 19qi uses an21xx (original EZ-USB) */
2141         // this does not coexist with the real Keyspan 19qi driver!
2142         { USB_DEVICE (0x06cd, 0x010b),
2143                 .driver_info = (unsigned long) &ez1_info,
2144                 },
2145 #endif
2146
2147         /*-------------------------------------------------------------*/
2148
2149 #ifdef IBOT2
2150         /* iBOT2 makes a nice source of high speed bulk-in data */
2151         // this does not coexist with a real iBOT2 driver!
2152         { USB_DEVICE (0x0b62, 0x0059),
2153                 .driver_info = (unsigned long) &ibot2_info,
2154                 },
2155 #endif
2156
2157         /*-------------------------------------------------------------*/
2158
2159 #ifdef GENERIC
2160         /* module params can specify devices to use for control tests */
2161         { .driver_info = (unsigned long) &generic_info, },
2162 #endif
2163
2164         /*-------------------------------------------------------------*/
2165
2166         { }
2167 };
2168 MODULE_DEVICE_TABLE (usb, id_table);
2169
2170 static struct usb_driver usbtest_driver = {
2171         .name =         "usbtest",
2172         .id_table =     id_table,
2173         .probe =        usbtest_probe,
2174         .ioctl =        usbtest_ioctl,
2175         .disconnect =   usbtest_disconnect,
2176         .suspend =      usbtest_suspend,
2177         .resume =       usbtest_resume,
2178 };
2179
2180 /*-------------------------------------------------------------------------*/
2181
2182 static int __init usbtest_init (void)
2183 {
2184 #ifdef GENERIC
2185         if (vendor)
2186                 dbg ("params: vend=0x%04x prod=0x%04x", vendor, product);
2187 #endif
2188         return usb_register (&usbtest_driver);
2189 }
2190 module_init (usbtest_init);
2191
2192 static void __exit usbtest_exit (void)
2193 {
2194         usb_deregister (&usbtest_driver);
2195 }
2196 module_exit (usbtest_exit);
2197
2198 MODULE_DESCRIPTION ("USB Core/HCD Testing Driver");
2199 MODULE_LICENSE ("GPL");
2200