drivers/usb/misc/usbtest.c

   1 #include <linux/config.h>
   2 #include <linux/kernel.h>
   3 #include <linux/errno.h>
   4 #include <linux/init.h>
   5 #include <linux/slab.h>
   6 #include <linux/mm.h>
   7 #include <linux/module.h>
   8 #include <linux/moduleparam.h>
   9 #include <linux/scatterlist.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 semaphore        sem;
  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 (e->desc.bEndpointAddress & USB_DIR_IN) {
 143                                 if (!in)
 144                                         in = e;
 145                         } else {
 146                                 if (!out)
 147                                         out = e;
 148                         }
 149                         continue;
 150 try_iso:
 151                         if (e->desc.bEndpointAddress & USB_DIR_IN) {
 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, struct pt_regs *regs)
 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, SLAB_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, SLAB_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, SLAB_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 [i].page)
 365                         continue;
 366                 kfree (page_address (sg [i].page) + sg [i].offset);
 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, SLAB_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, SLAB_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, SLAB_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, struct pt_regs *regs)
 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                           ((urb->status == -subcase->expected   /* happened */
 773                            || urb->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, SLAB_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 *), SLAB_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, SLAB_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], SLAB_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, struct pt_regs *regs)
1040 {
1041         int     status = urb->status;
1042
1043         // we "know" -EPIPE (stall) never happens
1044         if (!status)
1045                 status = usb_submit_urb (urb, SLAB_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, SLAB_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         if (status != 1) {
1156                 dbg ("ep %02x bogus status: %04x != 1", ep, status);
1157                 return -EINVAL;
1158         }
1159         retval = simple_io (urb, 1, 0, -EPIPE, __FUNCTION__);
1160         if (retval != -EPIPE)
1161                 return -EINVAL;
1162         retval = simple_io (urb, 1, 0, -EPIPE, "verify_still_halted");
1163         if (retval != -EPIPE)
1164                 return -EINVAL;
1165         return 0;
1166 }
1167
1168 static int test_halt (int ep, struct urb *urb)
1169 {
1170         int     retval;
1171
1172         /* shouldn't look or act halted now */
1173         retval = verify_not_halted (ep, urb);
1174         if (retval < 0)
1175                 return retval;
1176
1177         /* set halt (protocol test only), verify it worked */
1178         retval = usb_control_msg (urb->dev, usb_sndctrlpipe (urb->dev, 0),
1179                         USB_REQ_SET_FEATURE, USB_RECIP_ENDPOINT,
1180                         USB_ENDPOINT_HALT, ep,
1181                         NULL, 0, USB_CTRL_SET_TIMEOUT);
1182         if (retval < 0) {
1183                 dbg ("ep %02x couldn't set halt, %d", ep, retval);
1184                 return retval;
1185         }
1186         retval = verify_halted (ep, urb);
1187         if (retval < 0)
1188                 return retval;
1189
1190         /* clear halt (tests API + protocol), verify it worked */
1191         retval = usb_clear_halt (urb->dev, urb->pipe);
1192         if (retval < 0) {
1193                 dbg ("ep %02x couldn't clear halt, %d", ep, retval);
1194                 return retval;
1195         }
1196         retval = verify_not_halted (ep, urb);
1197         if (retval < 0)
1198                 return retval;
1199
1200         /* NOTE:  could also verify SET_INTERFACE clear halts ... */
1201
1202         return 0;
1203 }
1204
1205 static int halt_simple (struct usbtest_dev *dev)
1206 {
1207         int             ep;
1208         int             retval = 0;
1209         struct urb      *urb;
1210
1211         urb = simple_alloc_urb (testdev_to_usbdev (dev), 0, 512);
1212         if (urb == NULL)
1213                 return -ENOMEM;
1214
1215         if (dev->in_pipe) {
1216                 ep = usb_pipeendpoint (dev->in_pipe) | USB_DIR_IN;
1217                 urb->pipe = dev->in_pipe;
1218                 retval = test_halt (ep, urb);
1219                 if (retval < 0)
1220                         goto done;
1221         }
1222
1223         if (dev->out_pipe) {
1224                 ep = usb_pipeendpoint (dev->out_pipe);
1225                 urb->pipe = dev->out_pipe;
1226                 retval = test_halt (ep, urb);
1227         }
1228 done:
1229         simple_free_urb (urb);
1230         return retval;
1231 }
1232
1233 /*-------------------------------------------------------------------------*/
1234
1235 /* Control OUT tests use the vendor control requests from Intel's
1236  * USB 2.0 compliance test device:  write a buffer, read it back.
1237  *
1238  * Intel's spec only _requires_ that it work for one packet, which
1239  * is pretty weak.   Some HCDs place limits here; most devices will
1240  * need to be able to handle more than one OUT data packet.  We'll
1241  * try whatever we're told to try.
1242  */
1243 static int ctrl_out (struct usbtest_dev *dev,
1244                 unsigned count, unsigned length, unsigned vary)
1245 {
1246         unsigned                i, j, len, retval;
1247         u8                      *buf;
1248         char                    *what = "?";
1249         struct usb_device       *udev;
1250
1251         if (length < 1 || length > 0xffff || vary >= length)
1252                 return -EINVAL;
1253
1254         buf = kmalloc(length, SLAB_KERNEL);
1255         if (!buf)
1256                 return -ENOMEM;
1257
1258         udev = testdev_to_usbdev (dev);
1259         len = length;
1260         retval = 0;
1261
1262         /* NOTE:  hardware might well act differently if we pushed it
1263          * with lots back-to-back queued requests.
1264          */
1265         for (i = 0; i < count; i++) {
1266                 /* write patterned data */
1267                 for (j = 0; j < len; j++)
1268                         buf [j] = i + j;
1269                 retval = usb_control_msg (udev, usb_sndctrlpipe (udev,0),
1270                                 0x5b, USB_DIR_OUT|USB_TYPE_VENDOR,
1271                                 0, 0, buf, len, USB_CTRL_SET_TIMEOUT);
1272                 if (retval != len) {
1273                         what = "write";
1274                         if (retval >= 0) {
1275                                 INFO(dev, "ctrl_out, wlen %d (expected %d)\n",
1276                                                 retval, len);
1277                                 retval = -EBADMSG;
1278                         }
1279                         break;
1280                 }
1281
1282                 /* read it back -- assuming nothing intervened!!  */
1283                 retval = usb_control_msg (udev, usb_rcvctrlpipe (udev,0),
1284                                 0x5c, USB_DIR_IN|USB_TYPE_VENDOR,
1285                                 0, 0, buf, len, USB_CTRL_GET_TIMEOUT);
1286                 if (retval != len) {
1287                         what = "read";
1288                         if (retval >= 0) {
1289                                 INFO(dev, "ctrl_out, rlen %d (expected %d)\n",
1290                                                 retval, len);
1291                                 retval = -EBADMSG;
1292                         }
1293                         break;
1294                 }
1295
1296                 /* fail if we can't verify */
1297                 for (j = 0; j < len; j++) {
1298                         if (buf [j] != (u8) (i + j)) {
1299                                 INFO (dev, "ctrl_out, byte %d is %d not %d\n",
1300                                         j, buf [j], (u8) i + j);
1301                                 retval = -EBADMSG;
1302                                 break;
1303                         }
1304                 }
1305                 if (retval < 0) {
1306                         what = "verify";
1307                         break;
1308                 }
1309
1310                 len += vary;
1311
1312                 /* [real world] the "zero bytes IN" case isn't really used.
1313                  * hardware can easily trip up in this wierd case, since its
1314                  * status stage is IN, not OUT like other ep0in transfers.
1315                  */
1316                 if (len > length)
1317                         len = realworld ? 1 : 0;
1318         }
1319
1320         if (retval < 0)
1321                 INFO (dev, "ctrl_out %s failed, code %d, count %d\n",
1322                         what, retval, i);
1323
1324         kfree (buf);
1325         return retval;
1326 }
1327
1328 /*-------------------------------------------------------------------------*/
1329
1330 /* ISO tests ... mimics common usage
1331  *  - buffer length is split into N packets (mostly maxpacket sized)
1332  *  - multi-buffers according to sglen
1333  */
1334
1335 struct iso_context {
1336         unsigned                count;
1337         unsigned                pending;
1338         spinlock_t              lock;
1339         struct completion       done;
1340         unsigned long           errors;
1341         struct usbtest_dev      *dev;
1342 };
1343
1344 static void iso_callback (struct urb *urb, struct pt_regs *regs)
1345 {
1346         struct iso_context      *ctx = urb->context;
1347
1348         spin_lock(&ctx->lock);
1349         ctx->count--;
1350
1351         if (urb->error_count > 0)
1352                 ctx->errors += urb->error_count;
1353
1354         if (urb->status == 0 && ctx->count > (ctx->pending - 1)) {
1355                 int status = usb_submit_urb (urb, GFP_ATOMIC);
1356                 switch (status) {
1357                 case 0:
1358                         goto done;
1359                 default:
1360                         dev_dbg (&ctx->dev->intf->dev,
1361                                         "iso resubmit err %d\n",
1362                                         status);
1363                         /* FALLTHROUGH */
1364                 case -ENODEV:                   /* disconnected */
1365                         break;
1366                 }
1367         }
1368         simple_free_urb (urb);
1369
1370         ctx->pending--;
1371         if (ctx->pending == 0) {
1372                 if (ctx->errors)
1373                         dev_dbg (&ctx->dev->intf->dev,
1374                                 "iso test, %lu errors\n",
1375                                 ctx->errors);
1376                 complete (&ctx->done);
1377         }
1378 done:
1379         spin_unlock(&ctx->lock);
1380 }
1381
1382 static struct urb *iso_alloc_urb (
1383         struct usb_device       *udev,
1384         int                     pipe,
1385         struct usb_endpoint_descriptor  *desc,
1386         long                    bytes
1387 )
1388 {
1389         struct urb              *urb;
1390         unsigned                i, maxp, packets;
1391
1392         if (bytes < 0 || !desc)
1393                 return NULL;
1394         maxp = 0x7ff & le16_to_cpu(desc->wMaxPacketSize);
1395         maxp *= 1 + (0x3 & (le16_to_cpu(desc->wMaxPacketSize) >> 11));
1396         packets = (bytes + maxp - 1) / maxp;
1397
1398         urb = usb_alloc_urb (packets, SLAB_KERNEL);
1399         if (!urb)
1400                 return urb;
1401         urb->dev = udev;
1402         urb->pipe = pipe;
1403
1404         urb->number_of_packets = packets;
1405         urb->transfer_buffer_length = bytes;
1406         urb->transfer_buffer = usb_buffer_alloc (udev, bytes, SLAB_KERNEL,
1407                         &urb->transfer_dma);
1408         if (!urb->transfer_buffer) {
1409                 usb_free_urb (urb);
1410                 return NULL;
1411         }
1412         memset (urb->transfer_buffer, 0, bytes);
1413         for (i = 0; i < packets; i++) {
1414                 /* here, only the last packet will be short */
1415                 urb->iso_frame_desc[i].length = min ((unsigned) bytes, maxp);
1416                 bytes -= urb->iso_frame_desc[i].length;
1417
1418                 urb->iso_frame_desc[i].offset = maxp * i;
1419         }
1420
1421         urb->complete = iso_callback;
1422         // urb->context = SET BY CALLER
1423         urb->interval = 1 << (desc->bInterval - 1);
1424         urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
1425         return urb;
1426 }
1427
1428 static int
1429 test_iso_queue (struct usbtest_dev *dev, struct usbtest_param *param,
1430                 int pipe, struct usb_endpoint_descriptor *desc)
1431 {
1432         struct iso_context      context;
1433         struct usb_device       *udev;
1434         unsigned                i;
1435         unsigned long           packets = 0;
1436         int                     status;
1437         struct urb              *urbs[10];      /* FIXME no limit */
1438
1439         if (param->sglen > 10)
1440                 return -EDOM;
1441
1442         context.count = param->iterations * param->sglen;
1443         context.pending = param->sglen;
1444         context.errors = 0;
1445         context.dev = dev;
1446         init_completion (&context.done);
1447         spin_lock_init (&context.lock);
1448
1449         memset (urbs, 0, sizeof urbs);
1450         udev = testdev_to_usbdev (dev);
1451         dev_dbg (&dev->intf->dev,
1452                 "... iso period %d %sframes, wMaxPacket %04x\n",
1453                 1 << (desc->bInterval - 1),
1454                 (udev->speed == USB_SPEED_HIGH) ? "micro" : "",
1455                 le16_to_cpu(desc->wMaxPacketSize));
1456
1457         for (i = 0; i < param->sglen; i++) {
1458                 urbs [i] = iso_alloc_urb (udev, pipe, desc,
1459                                 param->length);
1460                 if (!urbs [i]) {
1461                         status = -ENOMEM;
1462                         goto fail;
1463                 }
1464                 packets += urbs[i]->number_of_packets;
1465                 urbs [i]->context = &context;
1466         }
1467         packets *= param->iterations;
1468         dev_dbg (&dev->intf->dev,
1469                 "... total %lu msec (%lu packets)\n",
1470                 (packets * (1 << (desc->bInterval - 1)))
1471                         / ((udev->speed == USB_SPEED_HIGH) ? 8 : 1),
1472                 packets);
1473
1474         spin_lock_irq (&context.lock);
1475         for (i = 0; i < param->sglen; i++) {
1476                 status = usb_submit_urb (urbs [i], SLAB_ATOMIC);
1477                 if (status < 0) {
1478                         ERROR (dev, "submit iso[%d], error %d\n", i, status);
1479                         if (i == 0) {
1480                                 spin_unlock_irq (&context.lock);
1481                                 goto fail;
1482                         }
1483
1484                         simple_free_urb (urbs [i]);
1485                         context.pending--;
1486                 }
1487         }
1488         spin_unlock_irq (&context.lock);
1489
1490         wait_for_completion (&context.done);
1491         return 0;
1492
1493 fail:
1494         for (i = 0; i < param->sglen; i++) {
1495                 if (urbs [i])
1496                         simple_free_urb (urbs [i]);
1497         }
1498         return status;
1499 }
1500
1501 /*-------------------------------------------------------------------------*/
1502
1503 /* We only have this one interface to user space, through usbfs.
1504  * User mode code can scan usbfs to find N different devices (maybe on
1505  * different busses) to use when testing, and allocate one thread per
1506  * test.  So discovery is simplified, and we have no device naming issues.
1507  *
1508  * Don't use these only as stress/load tests.  Use them along with with
1509  * other USB bus activity:  plugging, unplugging, mousing, mp3 playback,
1510  * video capture, and so on.  Run different tests at different times, in
1511  * different sequences.  Nothing here should interact with other devices,
1512  * except indirectly by consuming USB bandwidth and CPU resources for test
1513  * threads and request completion.  But the only way to know that for sure
1514  * is to test when HC queues are in use by many devices.
1515  */
1516
1517 static int
1518 usbtest_ioctl (struct usb_interface *intf, unsigned int code, void *buf)
1519 {
1520         struct usbtest_dev      *dev = usb_get_intfdata (intf);
1521         struct usb_device       *udev = testdev_to_usbdev (dev);
1522         struct usbtest_param    *param = buf;
1523         int                     retval = -EOPNOTSUPP;
1524         struct urb              *urb;
1525         struct scatterlist      *sg;
1526         struct usb_sg_request   req;
1527         struct timeval          start;
1528         unsigned                i;
1529
1530         // FIXME USBDEVFS_CONNECTINFO doesn't say how fast the device is.
1531
1532         if (code != USBTEST_REQUEST)
1533                 return -EOPNOTSUPP;
1534
1535         if (param->iterations <= 0 || param->length < 0
1536                         || param->sglen < 0 || param->vary < 0)
1537                 return -EINVAL;
1538
1539         if (down_interruptible (&dev->sem))
1540                 return -ERESTARTSYS;
1541
1542         if (intf->dev.power.power_state.event != PM_EVENT_ON) {
1543                 up (&dev->sem);
1544                 return -EHOSTUNREACH;
1545         }
1546
1547         /* some devices, like ez-usb default devices, need a non-default
1548          * altsetting to have any active endpoints.  some tests change
1549          * altsettings; force a default so most tests don't need to check.
1550          */
1551         if (dev->info->alt >= 0) {
1552                 int     res;
1553
1554                 if (intf->altsetting->desc.bInterfaceNumber) {
1555                         up (&dev->sem);
1556                         return -ENODEV;
1557                 }
1558                 res = set_altsetting (dev, dev->info->alt);
1559                 if (res) {
1560                         dev_err (&intf->dev,
1561                                         "set altsetting to %d failed, %d\n",
1562                                         dev->info->alt, res);
1563                         up (&dev->sem);
1564                         return res;
1565                 }
1566         }
1567
1568         /*
1569          * Just a bunch of test cases that every HCD is expected to handle.
1570          *
1571          * Some may need specific firmware, though it'd be good to have
1572          * one firmware image to handle all the test cases.
1573          *
1574          * FIXME add more tests!  cancel requests, verify the data, control
1575          * queueing, concurrent read+write threads, and so on.
1576          */
1577         do_gettimeofday (&start);
1578         switch (param->test_num) {
1579
1580         case 0:
1581                 dev_dbg (&intf->dev, "TEST 0:  NOP\n");
1582                 retval = 0;
1583                 break;
1584
1585         /* Simple non-queued bulk I/O tests */
1586         case 1:
1587                 if (dev->out_pipe == 0)
1588                         break;
1589                 dev_dbg (&intf->dev,
1590                                 "TEST 1:  write %d bytes %u times\n",
1591                                 param->length, param->iterations);
1592                 urb = simple_alloc_urb (udev, dev->out_pipe, param->length);
1593                 if (!urb) {
1594                         retval = -ENOMEM;
1595                         break;
1596                 }
1597                 // FIRMWARE:  bulk sink (maybe accepts short writes)
1598                 retval = simple_io (urb, param->iterations, 0, 0, "test1");
1599                 simple_free_urb (urb);
1600                 break;
1601         case 2:
1602                 if (dev->in_pipe == 0)
1603                         break;
1604                 dev_dbg (&intf->dev,
1605                                 "TEST 2:  read %d bytes %u times\n",
1606                                 param->length, param->iterations);
1607                 urb = simple_alloc_urb (udev, dev->in_pipe, param->length);
1608                 if (!urb) {
1609                         retval = -ENOMEM;
1610                         break;
1611                 }
1612                 // FIRMWARE:  bulk source (maybe generates short writes)
1613                 retval = simple_io (urb, param->iterations, 0, 0, "test2");
1614                 simple_free_urb (urb);
1615                 break;
1616         case 3:
1617                 if (dev->out_pipe == 0 || param->vary == 0)
1618                         break;
1619                 dev_dbg (&intf->dev,
1620                                 "TEST 3:  write/%d 0..%d bytes %u times\n",
1621                                 param->vary, param->length, param->iterations);
1622                 urb = simple_alloc_urb (udev, dev->out_pipe, param->length);
1623                 if (!urb) {
1624                         retval = -ENOMEM;
1625                         break;
1626                 }
1627                 // FIRMWARE:  bulk sink (maybe accepts short writes)
1628                 retval = simple_io (urb, param->iterations, param->vary,
1629                                         0, "test3");
1630                 simple_free_urb (urb);
1631                 break;
1632         case 4:
1633                 if (dev->in_pipe == 0 || param->vary == 0)
1634                         break;
1635                 dev_dbg (&intf->dev,
1636                                 "TEST 4:  read/%d 0..%d bytes %u times\n",
1637                                 param->vary, param->length, param->iterations);
1638                 urb = simple_alloc_urb (udev, dev->in_pipe, param->length);
1639                 if (!urb) {
1640                         retval = -ENOMEM;
1641                         break;
1642                 }
1643                 // FIRMWARE:  bulk source (maybe generates short writes)
1644                 retval = simple_io (urb, param->iterations, param->vary,
1645                                         0, "test4");
1646                 simple_free_urb (urb);
1647                 break;
1648
1649         /* Queued bulk I/O tests */
1650         case 5:
1651                 if (dev->out_pipe == 0 || param->sglen == 0)
1652                         break;
1653                 dev_dbg (&intf->dev,
1654                         "TEST 5:  write %d sglists %d entries of %d bytes\n",
1655                                 param->iterations,
1656                                 param->sglen, param->length);
1657                 sg = alloc_sglist (param->sglen, param->length, 0);
1658                 if (!sg) {
1659                         retval = -ENOMEM;
1660                         break;
1661                 }
1662                 // FIRMWARE:  bulk sink (maybe accepts short writes)
1663                 retval = perform_sglist (udev, param->iterations, dev->out_pipe,
1664                                 &req, sg, param->sglen);
1665                 free_sglist (sg, param->sglen);
1666                 break;
1667
1668         case 6:
1669                 if (dev->in_pipe == 0 || param->sglen == 0)
1670                         break;
1671                 dev_dbg (&intf->dev,
1672                         "TEST 6:  read %d sglists %d entries of %d bytes\n",
1673                                 param->iterations,
1674                                 param->sglen, param->length);
1675                 sg = alloc_sglist (param->sglen, param->length, 0);
1676                 if (!sg) {
1677                         retval = -ENOMEM;
1678                         break;
1679                 }
1680                 // FIRMWARE:  bulk source (maybe generates short writes)
1681                 retval = perform_sglist (udev, param->iterations, dev->in_pipe,
1682                                 &req, sg, param->sglen);
1683                 free_sglist (sg, param->sglen);
1684                 break;
1685         case 7:
1686                 if (dev->out_pipe == 0 || param->sglen == 0 || param->vary == 0)
1687                         break;
1688                 dev_dbg (&intf->dev,
1689                         "TEST 7:  write/%d %d sglists %d entries 0..%d bytes\n",
1690                                 param->vary, param->iterations,
1691                                 param->sglen, param->length);
1692                 sg = alloc_sglist (param->sglen, param->length, param->vary);
1693                 if (!sg) {
1694                         retval = -ENOMEM;
1695                         break;
1696                 }
1697                 // FIRMWARE:  bulk sink (maybe accepts short writes)
1698                 retval = perform_sglist (udev, param->iterations, dev->out_pipe,
1699                                 &req, sg, param->sglen);
1700                 free_sglist (sg, param->sglen);
1701                 break;
1702         case 8:
1703                 if (dev->in_pipe == 0 || param->sglen == 0 || param->vary == 0)
1704                         break;
1705                 dev_dbg (&intf->dev,
1706                         "TEST 8:  read/%d %d sglists %d entries 0..%d bytes\n",
1707                                 param->vary, param->iterations,
1708                                 param->sglen, param->length);
1709                 sg = alloc_sglist (param->sglen, param->length, param->vary);
1710                 if (!sg) {
1711                         retval = -ENOMEM;
1712                         break;
1713                 }
1714                 // FIRMWARE:  bulk source (maybe generates short writes)
1715                 retval = perform_sglist (udev, param->iterations, dev->in_pipe,
1716                                 &req, sg, param->sglen);
1717                 free_sglist (sg, param->sglen);
1718                 break;
1719
1720         /* non-queued sanity tests for control (chapter 9 subset) */
1721         case 9:
1722                 retval = 0;
1723                 dev_dbg (&intf->dev,
1724                         "TEST 9:  ch9 (subset) control tests, %d times\n",
1725                                 param->iterations);
1726                 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1727                         retval = ch9_postconfig (dev);
1728                 if (retval)
1729                         dbg ("ch9 subset failed, iterations left %d", i);
1730                 break;
1731
1732         /* queued control messaging */
1733         case 10:
1734                 if (param->sglen == 0)
1735                         break;
1736                 retval = 0;
1737                 dev_dbg (&intf->dev,
1738                                 "TEST 10:  queue %d control calls, %d times\n",
1739                                 param->sglen,
1740                                 param->iterations);
1741                 retval = test_ctrl_queue (dev, param);
1742                 break;
1743
1744         /* simple non-queued unlinks (ring with one urb) */
1745         case 11:
1746                 if (dev->in_pipe == 0 || !param->length)
1747                         break;
1748                 retval = 0;
1749                 dev_dbg (&intf->dev, "TEST 11:  unlink %d reads of %d\n",
1750                                 param->iterations, param->length);
1751                 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1752                         retval = unlink_simple (dev, dev->in_pipe,
1753                                                 param->length);
1754                 if (retval)
1755                         dev_dbg (&intf->dev, "unlink reads failed %d, "
1756                                 "iterations left %d\n", retval, i);
1757                 break;
1758         case 12:
1759                 if (dev->out_pipe == 0 || !param->length)
1760                         break;
1761                 retval = 0;
1762                 dev_dbg (&intf->dev, "TEST 12:  unlink %d writes of %d\n",
1763                                 param->iterations, param->length);
1764                 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1765                         retval = unlink_simple (dev, dev->out_pipe,
1766                                                 param->length);
1767                 if (retval)
1768                         dev_dbg (&intf->dev, "unlink writes failed %d, "
1769                                 "iterations left %d\n", retval, i);
1770                 break;
1771
1772         /* ep halt tests */
1773         case 13:
1774                 if (dev->out_pipe == 0 && dev->in_pipe == 0)
1775                         break;
1776                 retval = 0;
1777                 dev_dbg (&intf->dev, "TEST 13:  set/clear %d halts\n",
1778                                 param->iterations);
1779                 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1780                         retval = halt_simple (dev);
1781
1782                 if (retval)
1783                         DBG (dev, "halts failed, iterations left %d\n", i);
1784                 break;
1785
1786         /* control write tests */
1787         case 14:
1788                 if (!dev->info->ctrl_out)
1789                         break;
1790                 dev_dbg (&intf->dev, "TEST 14:  %d ep0out, %d..%d vary %d\n",
1791                                 param->iterations,
1792                                 realworld ? 1 : 0, param->length,
1793                                 param->vary);
1794                 retval = ctrl_out (dev, param->iterations,
1795                                 param->length, param->vary);
1796                 break;
1797
1798         /* iso write tests */
1799         case 15:
1800                 if (dev->out_iso_pipe == 0 || param->sglen == 0)
1801                         break;
1802                 dev_dbg (&intf->dev,
1803                         "TEST 15:  write %d iso, %d entries of %d bytes\n",
1804                                 param->iterations,
1805                                 param->sglen, param->length);
1806                 // FIRMWARE:  iso sink
1807                 retval = test_iso_queue (dev, param,
1808                                 dev->out_iso_pipe, dev->iso_out);
1809                 break;
1810
1811         /* iso read tests */
1812         case 16:
1813                 if (dev->in_iso_pipe == 0 || param->sglen == 0)
1814                         break;
1815                 dev_dbg (&intf->dev,
1816                         "TEST 16:  read %d iso, %d entries of %d bytes\n",
1817                                 param->iterations,
1818                                 param->sglen, param->length);
1819                 // FIRMWARE:  iso source
1820                 retval = test_iso_queue (dev, param,
1821                                 dev->in_iso_pipe, dev->iso_in);
1822                 break;
1823
1824         // FIXME unlink from queue (ring with N urbs)
1825
1826         // FIXME scatterlist cancel (needs helper thread)
1827
1828         }
1829         do_gettimeofday (&param->duration);
1830         param->duration.tv_sec -= start.tv_sec;
1831         param->duration.tv_usec -= start.tv_usec;
1832         if (param->duration.tv_usec < 0) {
1833                 param->duration.tv_usec += 1000 * 1000;
1834                 param->duration.tv_sec -= 1;
1835         }
1836         up (&dev->sem);
1837         return retval;
1838 }
1839
1840 /*-------------------------------------------------------------------------*/
1841
1842 static unsigned force_interrupt = 0;
1843 module_param (force_interrupt, uint, 0);
1844 MODULE_PARM_DESC (force_interrupt, "0 = test default; else interrupt");
1845
1846 #ifdef  GENERIC
1847 static unsigned short vendor;
1848 module_param(vendor, ushort, 0);
1849 MODULE_PARM_DESC (vendor, "vendor code (from usb-if)");
1850
1851 static unsigned short product;
1852 module_param(product, ushort, 0);
1853 MODULE_PARM_DESC (product, "product code (from vendor)");
1854 #endif
1855
1856 static int
1857 usbtest_probe (struct usb_interface *intf, const struct usb_device_id *id)
1858 {
1859         struct usb_device       *udev;
1860         struct usbtest_dev      *dev;
1861         struct usbtest_info     *info;
1862         char                    *rtest, *wtest;
1863         char                    *irtest, *iwtest;
1864
1865         udev = interface_to_usbdev (intf);
1866
1867 #ifdef  GENERIC
1868         /* specify devices by module parameters? */
1869         if (id->match_flags == 0) {
1870                 /* vendor match required, product match optional */
1871                 if (!vendor || le16_to_cpu(udev->descriptor.idVendor) != (u16)vendor)
1872                         return -ENODEV;
1873                 if (product && le16_to_cpu(udev->descriptor.idProduct) != (u16)product)
1874                         return -ENODEV;
1875                 dbg ("matched module params, vend=0x%04x prod=0x%04x",
1876                                 le16_to_cpu(udev->descriptor.idVendor),
1877                                 le16_to_cpu(udev->descriptor.idProduct));
1878         }
1879 #endif
1880
1881         dev = kzalloc(sizeof(*dev), SLAB_KERNEL);
1882         if (!dev)
1883                 return -ENOMEM;
1884         info = (struct usbtest_info *) id->driver_info;
1885         dev->info = info;
1886         init_MUTEX (&dev->sem);
1887
1888         dev->intf = intf;
1889
1890         /* cacheline-aligned scratch for i/o */
1891         if ((dev->buf = kmalloc (TBUF_SIZE, SLAB_KERNEL)) == NULL) {
1892                 kfree (dev);
1893                 return -ENOMEM;
1894         }
1895
1896         /* NOTE this doesn't yet test the handful of difference that are
1897          * visible with high speed interrupts:  bigger maxpacket (1K) and
1898          * "high bandwidth" modes (up to 3 packets/uframe).
1899          */
1900         rtest = wtest = "";
1901         irtest = iwtest = "";
1902         if (force_interrupt || udev->speed == USB_SPEED_LOW) {
1903                 if (info->ep_in) {
1904                         dev->in_pipe = usb_rcvintpipe (udev, info->ep_in);
1905                         rtest = " intr-in";
1906                 }
1907                 if (info->ep_out) {
1908                         dev->out_pipe = usb_sndintpipe (udev, info->ep_out);
1909                         wtest = " intr-out";
1910                 }
1911         } else {
1912                 if (info->autoconf) {
1913                         int status;
1914
1915                         status = get_endpoints (dev, intf);
1916                         if (status < 0) {
1917                                 dbg ("couldn't get endpoints, %d\n", status);
1918                                 return status;
1919                         }
1920                         /* may find bulk or ISO pipes */
1921                 } else {
1922                         if (info->ep_in)
1923                                 dev->in_pipe = usb_rcvbulkpipe (udev,
1924                                                         info->ep_in);
1925                         if (info->ep_out)
1926                                 dev->out_pipe = usb_sndbulkpipe (udev,
1927                                                         info->ep_out);
1928                 }
1929                 if (dev->in_pipe)
1930                         rtest = " bulk-in";
1931                 if (dev->out_pipe)
1932                         wtest = " bulk-out";
1933                 if (dev->in_iso_pipe)
1934                         irtest = " iso-in";
1935                 if (dev->out_iso_pipe)
1936                         iwtest = " iso-out";
1937         }
1938
1939         usb_set_intfdata (intf, dev);
1940         dev_info (&intf->dev, "%s\n", info->name);
1941         dev_info (&intf->dev, "%s speed {control%s%s%s%s%s} tests%s\n",
1942                         ({ char *tmp;
1943                         switch (udev->speed) {
1944                         case USB_SPEED_LOW: tmp = "low"; break;
1945                         case USB_SPEED_FULL: tmp = "full"; break;
1946                         case USB_SPEED_HIGH: tmp = "high"; break;
1947                         default: tmp = "unknown"; break;
1948                         }; tmp; }),
1949                         info->ctrl_out ? " in/out" : "",
1950                         rtest, wtest,
1951                         irtest, iwtest,
1952                         info->alt >= 0 ? " (+alt)" : "");
1953         return 0;
1954 }
1955
1956 static int usbtest_suspend (struct usb_interface *intf, pm_message_t message)
1957 {
1958         return 0;
1959 }
1960
1961 static int usbtest_resume (struct usb_interface *intf)
1962 {
1963         return 0;
1964 }
1965
1966
1967 static void usbtest_disconnect (struct usb_interface *intf)
1968 {
1969         struct usbtest_dev      *dev = usb_get_intfdata (intf);
1970
1971         down (&dev->sem);
1972
1973         usb_set_intfdata (intf, NULL);
1974         dev_dbg (&intf->dev, "disconnect\n");
1975         kfree (dev);
1976 }
1977
1978 /* Basic testing only needs a device that can source or sink bulk traffic.
1979  * Any device can test control transfers (default with GENERIC binding).
1980  *
1981  * Several entries work with the default EP0 implementation that's built
1982  * into EZ-USB chips.  There's a default vendor ID which can be overridden
1983  * by (very) small config EEPROMS, but otherwise all these devices act
1984  * identically until firmware is loaded:  only EP0 works.  It turns out
1985  * to be easy to make other endpoints work, without modifying that EP0
1986  * behavior.  For now, we expect that kind of firmware.
1987  */
1988
1989 /* an21xx or fx versions of ez-usb */
1990 static struct usbtest_info ez1_info = {
1991         .name           = "EZ-USB device",
1992         .ep_in          = 2,
1993         .ep_out         = 2,
1994         .alt            = 1,
1995 };
1996
1997 /* fx2 version of ez-usb */
1998 static struct usbtest_info ez2_info = {
1999         .name           = "FX2 device",
2000         .ep_in          = 6,
2001         .ep_out         = 2,
2002         .alt            = 1,
2003 };
2004
2005 /* ezusb family device with dedicated usb test firmware,
2006  */
2007 static struct usbtest_info fw_info = {
2008         .name           = "usb test device",
2009         .ep_in          = 2,
2010         .ep_out         = 2,
2011         .alt            = 1,
2012         .autoconf       = 1,            // iso and ctrl_out need autoconf
2013         .ctrl_out       = 1,
2014         .iso            = 1,            // iso_ep's are #8 in/out
2015 };
2016
2017 /* peripheral running Linux and 'zero.c' test firmware, or
2018  * its user-mode cousin. different versions of this use
2019  * different hardware with the same vendor/product codes.
2020  * host side MUST rely on the endpoint descriptors.
2021  */
2022 static struct usbtest_info gz_info = {
2023         .name           = "Linux gadget zero",
2024         .autoconf       = 1,
2025         .ctrl_out       = 1,
2026         .alt            = 0,
2027 };
2028
2029 static struct usbtest_info um_info = {
2030         .name           = "Linux user mode test driver",
2031         .autoconf       = 1,
2032         .alt            = -1,
2033 };
2034
2035 static struct usbtest_info um2_info = {
2036         .name           = "Linux user mode ISO test driver",
2037         .autoconf       = 1,
2038         .iso            = 1,
2039         .alt            = -1,
2040 };
2041
2042 #ifdef IBOT2
2043 /* this is a nice source of high speed bulk data;
2044  * uses an FX2, with firmware provided in the device
2045  */
2046 static struct usbtest_info ibot2_info = {
2047         .name           = "iBOT2 webcam",
2048         .ep_in          = 2,
2049         .alt            = -1,
2050 };
2051 #endif
2052
2053 #ifdef GENERIC
2054 /* we can use any device to test control traffic */
2055 static struct usbtest_info generic_info = {
2056         .name           = "Generic USB device",
2057         .alt            = -1,
2058 };
2059 #endif
2060
2061 // FIXME remove this
2062 static struct usbtest_info hact_info = {
2063         .name           = "FX2/hact",
2064         //.ep_in                = 6,
2065         .ep_out         = 2,
2066         .alt            = -1,
2067 };
2068
2069
2070 static struct usb_device_id id_table [] = {
2071
2072         { USB_DEVICE (0x0547, 0x1002),
2073                 .driver_info = (unsigned long) &hact_info,
2074                 },
2075
2076         /*-------------------------------------------------------------*/
2077
2078         /* EZ-USB devices which download firmware to replace (or in our
2079          * case augment) the default device implementation.
2080          */
2081
2082         /* generic EZ-USB FX controller */
2083         { USB_DEVICE (0x0547, 0x2235),
2084                 .driver_info = (unsigned long) &ez1_info,
2085                 },
2086
2087         /* CY3671 development board with EZ-USB FX */
2088         { USB_DEVICE (0x0547, 0x0080),
2089                 .driver_info = (unsigned long) &ez1_info,
2090                 },
2091
2092         /* generic EZ-USB FX2 controller (or development board) */
2093         { USB_DEVICE (0x04b4, 0x8613),
2094                 .driver_info = (unsigned long) &ez2_info,
2095                 },
2096
2097         /* re-enumerated usb test device firmware */
2098         { USB_DEVICE (0xfff0, 0xfff0),
2099                 .driver_info = (unsigned long) &fw_info,
2100                 },
2101
2102         /* "Gadget Zero" firmware runs under Linux */
2103         { USB_DEVICE (0x0525, 0xa4a0),
2104                 .driver_info = (unsigned long) &gz_info,
2105                 },
2106
2107         /* so does a user-mode variant */
2108         { USB_DEVICE (0x0525, 0xa4a4),
2109                 .driver_info = (unsigned long) &um_info,
2110                 },
2111
2112         /* ... and a user-mode variant that talks iso */
2113         { USB_DEVICE (0x0525, 0xa4a3),
2114                 .driver_info = (unsigned long) &um2_info,
2115                 },
2116
2117 #ifdef KEYSPAN_19Qi
2118         /* Keyspan 19qi uses an21xx (original EZ-USB) */
2119         // this does not coexist with the real Keyspan 19qi driver!
2120         { USB_DEVICE (0x06cd, 0x010b),
2121                 .driver_info = (unsigned long) &ez1_info,
2122                 },
2123 #endif
2124
2125         /*-------------------------------------------------------------*/
2126
2127 #ifdef IBOT2
2128         /* iBOT2 makes a nice source of high speed bulk-in data */
2129         // this does not coexist with a real iBOT2 driver!
2130         { USB_DEVICE (0x0b62, 0x0059),
2131                 .driver_info = (unsigned long) &ibot2_info,
2132                 },
2133 #endif
2134
2135         /*-------------------------------------------------------------*/
2136
2137 #ifdef GENERIC
2138         /* module params can specify devices to use for control tests */
2139         { .driver_info = (unsigned long) &generic_info, },
2140 #endif
2141
2142         /*-------------------------------------------------------------*/
2143
2144         { }
2145 };
2146 MODULE_DEVICE_TABLE (usb, id_table);
2147
2148 static struct usb_driver usbtest_driver = {
2149         .name =         "usbtest",
2150         .id_table =     id_table,
2151         .probe =        usbtest_probe,
2152         .ioctl =        usbtest_ioctl,
2153         .disconnect =   usbtest_disconnect,
2154         .suspend =      usbtest_suspend,
2155         .resume =       usbtest_resume,
2156 };
2157
2158 /*-------------------------------------------------------------------------*/
2159
2160 static int __init usbtest_init (void)
2161 {
2162 #ifdef GENERIC
2163         if (vendor)
2164                 dbg ("params: vend=0x%04x prod=0x%04x", vendor, product);
2165 #endif
2166         return usb_register (&usbtest_driver);
2167 }
2168 module_init (usbtest_init);
2169
2170 static void __exit usbtest_exit (void)
2171 {
2172         usb_deregister (&usbtest_driver);
2173 }
2174 module_exit (usbtest_exit);
2175
2176 MODULE_DESCRIPTION ("USB Core/HCD Testing Driver");
2177 MODULE_LICENSE ("GPL");
2178