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                                 status = usb_unlink_urb (u);
 806                                 switch (status) {
 807                                 case -EINPROGRESS:
 808                                 case -EBUSY:
 809                                 case -EIDRM:
 810                                         continue;
 811                                 default:
 812                                         dbg ("urb unlink --> %d", status);
 813                                 }
 814                         }
 815                         status = ctx->status;
 816                 }
 817         }
 818
 819         /* resubmit if we need to, else mark this as done */
 820         if ((status == 0) && (ctx->pending < ctx->count)) {
 821                 if ((status = usb_submit_urb (urb, SLAB_ATOMIC)) != 0) {
 822                         dbg ("can't resubmit ctrl %02x.%02x, err %d",
 823                                 reqp->bRequestType, reqp->bRequest, status);
 824                         urb->dev = NULL;
 825                 } else
 826                         ctx->pending++;
 827         } else
 828                 urb->dev = NULL;
 829
 830         /* signal completion when nothing's queued */
 831         if (ctx->pending == 0)
 832                 complete (&ctx->complete);
 833         spin_unlock (&ctx->lock);
 834 }
 835
 836 static int
 837 test_ctrl_queue (struct usbtest_dev *dev, struct usbtest_param *param)
 838 {
 839         struct usb_device       *udev = testdev_to_usbdev (dev);
 840         struct urb              **urb;
 841         struct ctrl_ctx         context;
 842         int                     i;
 843
 844         spin_lock_init (&context.lock);
 845         context.dev = dev;
 846         init_completion (&context.complete);
 847         context.count = param->sglen * param->iterations;
 848         context.pending = 0;
 849         context.status = -ENOMEM;
 850         context.param = param;
 851         context.last = -1;
 852
 853         /* allocate and init the urbs we'll queue.
 854          * as with bulk/intr sglists, sglen is the queue depth; it also
 855          * controls which subtests run (more tests than sglen) or rerun.
 856          */
 857         urb = kcalloc(param->sglen, sizeof(struct urb *), SLAB_KERNEL);
 858         if (!urb)
 859                 return -ENOMEM;
 860         for (i = 0; i < param->sglen; i++) {
 861                 int                     pipe = usb_rcvctrlpipe (udev, 0);
 862                 unsigned                len;
 863                 struct urb              *u;
 864                 struct usb_ctrlrequest  req;
 865                 struct subcase          *reqp;
 866                 int                     expected = 0;
 867
 868                 /* requests here are mostly expected to succeed on any
 869                  * device, but some are chosen to trigger protocol stalls
 870                  * or short reads.
 871                  */
 872                 memset (&req, 0, sizeof req);
 873                 req.bRequest = USB_REQ_GET_DESCRIPTOR;
 874                 req.bRequestType = USB_DIR_IN|USB_RECIP_DEVICE;
 875
 876                 switch (i % NUM_SUBCASES) {
 877                 case 0:         // get device descriptor
 878                         req.wValue = cpu_to_le16 (USB_DT_DEVICE << 8);
 879                         len = sizeof (struct usb_device_descriptor);
 880                         break;
 881                 case 1:         // get first config descriptor (only)
 882                         req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
 883                         len = sizeof (struct usb_config_descriptor);
 884                         break;
 885                 case 2:         // get altsetting (OFTEN STALLS)
 886                         req.bRequest = USB_REQ_GET_INTERFACE;
 887                         req.bRequestType = USB_DIR_IN|USB_RECIP_INTERFACE;
 888                         // index = 0 means first interface
 889                         len = 1;
 890                         expected = EPIPE;
 891                         break;
 892                 case 3:         // get interface status
 893                         req.bRequest = USB_REQ_GET_STATUS;
 894                         req.bRequestType = USB_DIR_IN|USB_RECIP_INTERFACE;
 895                         // interface 0
 896                         len = 2;
 897                         break;
 898                 case 4:         // get device status
 899                         req.bRequest = USB_REQ_GET_STATUS;
 900                         req.bRequestType = USB_DIR_IN|USB_RECIP_DEVICE;
 901                         len = 2;
 902                         break;
 903                 case 5:         // get device qualifier (MAY STALL)
 904                         req.wValue = cpu_to_le16 (USB_DT_DEVICE_QUALIFIER << 8);
 905                         len = sizeof (struct usb_qualifier_descriptor);
 906                         if (udev->speed != USB_SPEED_HIGH)
 907                                 expected = EPIPE;
 908                         break;
 909                 case 6:         // get first config descriptor, plus interface
 910                         req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
 911                         len = sizeof (struct usb_config_descriptor);
 912                         len += sizeof (struct usb_interface_descriptor);
 913                         break;
 914                 case 7:         // get interface descriptor (ALWAYS STALLS)
 915                         req.wValue = cpu_to_le16 (USB_DT_INTERFACE << 8);
 916                         // interface == 0
 917                         len = sizeof (struct usb_interface_descriptor);
 918                         expected = EPIPE;
 919                         break;
 920                 // NOTE: two consecutive stalls in the queue here.
 921                 // that tests fault recovery a bit more aggressively.
 922                 case 8:         // clear endpoint halt (USUALLY STALLS)
 923                         req.bRequest = USB_REQ_CLEAR_FEATURE;
 924                         req.bRequestType = USB_RECIP_ENDPOINT;
 925                         // wValue 0 == ep halt
 926                         // wIndex 0 == ep0 (shouldn't halt!)
 927                         len = 0;
 928                         pipe = usb_sndctrlpipe (udev, 0);
 929                         expected = EPIPE;
 930                         break;
 931                 case 9:         // get endpoint status
 932                         req.bRequest = USB_REQ_GET_STATUS;
 933                         req.bRequestType = USB_DIR_IN|USB_RECIP_ENDPOINT;
 934                         // endpoint 0
 935                         len = 2;
 936                         break;
 937                 case 10:        // trigger short read (EREMOTEIO)
 938                         req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
 939                         len = 1024;
 940                         expected = -EREMOTEIO;
 941                         break;
 942                 // NOTE: two consecutive _different_ faults in the queue.
 943                 case 11:        // get endpoint descriptor (ALWAYS STALLS)
 944                         req.wValue = cpu_to_le16 (USB_DT_ENDPOINT << 8);
 945                         // endpoint == 0
 946                         len = sizeof (struct usb_interface_descriptor);
 947                         expected = EPIPE;
 948                         break;
 949                 // NOTE: sometimes even a third fault in the queue!
 950                 case 12:        // get string 0 descriptor (MAY STALL)
 951                         req.wValue = cpu_to_le16 (USB_DT_STRING << 8);
 952                         // string == 0, for language IDs
 953                         len = sizeof (struct usb_interface_descriptor);
 954                         // may succeed when > 4 languages
 955                         expected = EREMOTEIO;   // or EPIPE, if no strings
 956                         break;
 957                 case 13:        // short read, resembling case 10
 958                         req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
 959                         // last data packet "should" be DATA1, not DATA0
 960                         len = 1024 - udev->descriptor.bMaxPacketSize0;
 961                         expected = -EREMOTEIO;
 962                         break;
 963                 case 14:        // short read; try to fill the last packet
 964                         req.wValue = cpu_to_le16 ((USB_DT_DEVICE << 8) | 0);
 965                         // device descriptor size == 18 bytes
 966                         len = udev->descriptor.bMaxPacketSize0;
 967                         switch (len) {
 968                         case 8:         len = 24; break;
 969                         case 16:        len = 32; break;
 970                         }
 971                         expected = -EREMOTEIO;
 972                         break;
 973                 default:
 974                         err ("bogus number of ctrl queue testcases!");
 975                         context.status = -EINVAL;
 976                         goto cleanup;
 977                 }
 978                 req.wLength = cpu_to_le16 (len);
 979                 urb [i] = u = simple_alloc_urb (udev, pipe, len);
 980                 if (!u)
 981                         goto cleanup;
 982
 983                 reqp = usb_buffer_alloc (udev, sizeof *reqp, SLAB_KERNEL,
 984                                 &u->setup_dma);
 985                 if (!reqp)
 986                         goto cleanup;
 987                 reqp->setup = req;
 988                 reqp->number = i % NUM_SUBCASES;
 989                 reqp->expected = expected;
 990                 u->setup_packet = (char *) &reqp->setup;
 991                 u->transfer_flags |= URB_NO_SETUP_DMA_MAP;
 992
 993                 u->context = &context;
 994                 u->complete = ctrl_complete;
 995         }
 996
 997         /* queue the urbs */
 998         context.urb = urb;
 999         spin_lock_irq (&context.lock);
1000         for (i = 0; i < param->sglen; i++) {
1001                 context.status = usb_submit_urb (urb [i], SLAB_ATOMIC);
1002                 if (context.status != 0) {
1003                         dbg ("can't submit urb[%d], status %d",
1004                                         i, context.status);
1005                         context.count = context.pending;
1006                         break;
1007                 }
1008                 context.pending++;
1009         }
1010         spin_unlock_irq (&context.lock);
1011
1012         /* FIXME  set timer and time out; provide a disconnect hook */
1013
1014         /* wait for the last one to complete */
1015         if (context.pending > 0)
1016                 wait_for_completion (&context.complete);
1017
1018 cleanup:
1019         for (i = 0; i < param->sglen; i++) {
1020                 if (!urb [i])
1021                         continue;
1022                 urb [i]->dev = udev;
1023                 if (urb [i]->setup_packet)
1024                         usb_buffer_free (udev, sizeof (struct usb_ctrlrequest),
1025                                         urb [i]->setup_packet,
1026                                         urb [i]->setup_dma);
1027                 simple_free_urb (urb [i]);
1028         }
1029         kfree (urb);
1030         return context.status;
1031 }
1032 #undef NUM_SUBCASES
1033
1034
1035 /*-------------------------------------------------------------------------*/
1036
1037 static void unlink1_callback (struct urb *urb, struct pt_regs *regs)
1038 {
1039         int     status = urb->status;
1040
1041         // we "know" -EPIPE (stall) never happens
1042         if (!status)
1043                 status = usb_submit_urb (urb, SLAB_ATOMIC);
1044         if (status) {
1045                 urb->status = status;
1046                 complete ((struct completion *) urb->context);
1047         }
1048 }
1049
1050 static int unlink1 (struct usbtest_dev *dev, int pipe, int size, int async)
1051 {
1052         struct urb              *urb;
1053         struct completion       completion;
1054         int                     retval = 0;
1055
1056         init_completion (&completion);
1057         urb = simple_alloc_urb (testdev_to_usbdev (dev), pipe, size);
1058         if (!urb)
1059                 return -ENOMEM;
1060         urb->context = &completion;
1061         urb->complete = unlink1_callback;
1062
1063         /* keep the endpoint busy.  there are lots of hc/hcd-internal
1064          * states, and testing should get to all of them over time.
1065          *
1066          * FIXME want additional tests for when endpoint is STALLing
1067          * due to errors, or is just NAKing requests.
1068          */
1069         if ((retval = usb_submit_urb (urb, SLAB_KERNEL)) != 0) {
1070                 dev_dbg (&dev->intf->dev, "submit fail %d\n", retval);
1071                 return retval;
1072         }
1073
1074         /* unlinking that should always work.  variable delay tests more
1075          * hcd states and code paths, even with little other system load.
1076          */
1077         msleep (jiffies % (2 * INTERRUPT_RATE));
1078         if (async) {
1079 retry:
1080                 retval = usb_unlink_urb (urb);
1081                 if (retval == -EBUSY || retval == -EIDRM) {
1082                         /* we can't unlink urbs while they're completing.
1083                          * or if they've completed, and we haven't resubmitted.
1084                          * "normal" drivers would prevent resubmission, but
1085                          * since we're testing unlink paths, we can't.
1086                          */
1087                         dev_dbg (&dev->intf->dev, "unlink retry\n");
1088                         goto retry;
1089                 }
1090         } else
1091                 usb_kill_urb (urb);
1092         if (!(retval == 0 || retval == -EINPROGRESS)) {
1093                 dev_dbg (&dev->intf->dev, "unlink fail %d\n", retval);
1094                 return retval;
1095         }
1096
1097         wait_for_completion (&completion);
1098         retval = urb->status;
1099         simple_free_urb (urb);
1100
1101         if (async)
1102                 return (retval == -ECONNRESET) ? 0 : retval - 1000;
1103         else
1104                 return (retval == -ENOENT || retval == -EPERM) ?
1105                                 0 : retval - 2000;
1106 }
1107
1108 static int unlink_simple (struct usbtest_dev *dev, int pipe, int len)
1109 {
1110         int                     retval = 0;
1111
1112         /* test sync and async paths */
1113         retval = unlink1 (dev, pipe, len, 1);
1114         if (!retval)
1115                 retval = unlink1 (dev, pipe, len, 0);
1116         return retval;
1117 }
1118
1119 /*-------------------------------------------------------------------------*/
1120
1121 static int verify_not_halted (int ep, struct urb *urb)
1122 {
1123         int     retval;
1124         u16     status;
1125
1126         /* shouldn't look or act halted */
1127         retval = usb_get_status (urb->dev, USB_RECIP_ENDPOINT, ep, &status);
1128         if (retval < 0) {
1129                 dbg ("ep %02x couldn't get no-halt status, %d", ep, retval);
1130                 return retval;
1131         }
1132         if (status != 0) {
1133                 dbg ("ep %02x bogus status: %04x != 0", ep, status);
1134                 return -EINVAL;
1135         }
1136         retval = simple_io (urb, 1, 0, 0, __FUNCTION__);
1137         if (retval != 0)
1138                 return -EINVAL;
1139         return 0;
1140 }
1141
1142 static int verify_halted (int ep, struct urb *urb)
1143 {
1144         int     retval;
1145         u16     status;
1146
1147         /* should look and act halted */
1148         retval = usb_get_status (urb->dev, USB_RECIP_ENDPOINT, ep, &status);
1149         if (retval < 0) {
1150                 dbg ("ep %02x couldn't get halt status, %d", ep, retval);
1151                 return retval;
1152         }
1153         if (status != 1) {
1154                 dbg ("ep %02x bogus status: %04x != 1", ep, status);
1155                 return -EINVAL;
1156         }
1157         retval = simple_io (urb, 1, 0, -EPIPE, __FUNCTION__);
1158         if (retval != -EPIPE)
1159                 return -EINVAL;
1160         retval = simple_io (urb, 1, 0, -EPIPE, "verify_still_halted");
1161         if (retval != -EPIPE)
1162                 return -EINVAL;
1163         return 0;
1164 }
1165
1166 static int test_halt (int ep, struct urb *urb)
1167 {
1168         int     retval;
1169
1170         /* shouldn't look or act halted now */
1171         retval = verify_not_halted (ep, urb);
1172         if (retval < 0)
1173                 return retval;
1174
1175         /* set halt (protocol test only), verify it worked */
1176         retval = usb_control_msg (urb->dev, usb_sndctrlpipe (urb->dev, 0),
1177                         USB_REQ_SET_FEATURE, USB_RECIP_ENDPOINT,
1178                         USB_ENDPOINT_HALT, ep,
1179                         NULL, 0, USB_CTRL_SET_TIMEOUT);
1180         if (retval < 0) {
1181                 dbg ("ep %02x couldn't set halt, %d", ep, retval);
1182                 return retval;
1183         }
1184         retval = verify_halted (ep, urb);
1185         if (retval < 0)
1186                 return retval;
1187
1188         /* clear halt (tests API + protocol), verify it worked */
1189         retval = usb_clear_halt (urb->dev, urb->pipe);
1190         if (retval < 0) {
1191                 dbg ("ep %02x couldn't clear halt, %d", ep, retval);
1192                 return retval;
1193         }
1194         retval = verify_not_halted (ep, urb);
1195         if (retval < 0)
1196                 return retval;
1197
1198         /* NOTE:  could also verify SET_INTERFACE clear halts ... */
1199
1200         return 0;
1201 }
1202
1203 static int halt_simple (struct usbtest_dev *dev)
1204 {
1205         int             ep;
1206         int             retval = 0;
1207         struct urb      *urb;
1208
1209         urb = simple_alloc_urb (testdev_to_usbdev (dev), 0, 512);
1210         if (urb == NULL)
1211                 return -ENOMEM;
1212
1213         if (dev->in_pipe) {
1214                 ep = usb_pipeendpoint (dev->in_pipe) | USB_DIR_IN;
1215                 urb->pipe = dev->in_pipe;
1216                 retval = test_halt (ep, urb);
1217                 if (retval < 0)
1218                         goto done;
1219         }
1220
1221         if (dev->out_pipe) {
1222                 ep = usb_pipeendpoint (dev->out_pipe);
1223                 urb->pipe = dev->out_pipe;
1224                 retval = test_halt (ep, urb);
1225         }
1226 done:
1227         simple_free_urb (urb);
1228         return retval;
1229 }
1230
1231 /*-------------------------------------------------------------------------*/
1232
1233 /* Control OUT tests use the vendor control requests from Intel's
1234  * USB 2.0 compliance test device:  write a buffer, read it back.
1235  *
1236  * Intel's spec only _requires_ that it work for one packet, which
1237  * is pretty weak.   Some HCDs place limits here; most devices will
1238  * need to be able to handle more than one OUT data packet.  We'll
1239  * try whatever we're told to try.
1240  */
1241 static int ctrl_out (struct usbtest_dev *dev,
1242                 unsigned count, unsigned length, unsigned vary)
1243 {
1244         unsigned                i, j, len, retval;
1245         u8                      *buf;
1246         char                    *what = "?";
1247         struct usb_device       *udev;
1248
1249         if (length < 1 || length > 0xffff || vary >= length)
1250                 return -EINVAL;
1251
1252         buf = kmalloc(length, SLAB_KERNEL);
1253         if (!buf)
1254                 return -ENOMEM;
1255
1256         udev = testdev_to_usbdev (dev);
1257         len = length;
1258         retval = 0;
1259
1260         /* NOTE:  hardware might well act differently if we pushed it
1261          * with lots back-to-back queued requests.
1262          */
1263         for (i = 0; i < count; i++) {
1264                 /* write patterned data */
1265                 for (j = 0; j < len; j++)
1266                         buf [j] = i + j;
1267                 retval = usb_control_msg (udev, usb_sndctrlpipe (udev,0),
1268                                 0x5b, USB_DIR_OUT|USB_TYPE_VENDOR,
1269                                 0, 0, buf, len, USB_CTRL_SET_TIMEOUT);
1270                 if (retval != len) {
1271                         what = "write";
1272                         if (retval >= 0) {
1273                                 INFO(dev, "ctrl_out, wlen %d (expected %d)\n",
1274                                                 retval, len);
1275                                 retval = -EBADMSG;
1276                         }
1277                         break;
1278                 }
1279
1280                 /* read it back -- assuming nothing intervened!!  */
1281                 retval = usb_control_msg (udev, usb_rcvctrlpipe (udev,0),
1282                                 0x5c, USB_DIR_IN|USB_TYPE_VENDOR,
1283                                 0, 0, buf, len, USB_CTRL_GET_TIMEOUT);
1284                 if (retval != len) {
1285                         what = "read";
1286                         if (retval >= 0) {
1287                                 INFO(dev, "ctrl_out, rlen %d (expected %d)\n",
1288                                                 retval, len);
1289                                 retval = -EBADMSG;
1290                         }
1291                         break;
1292                 }
1293
1294                 /* fail if we can't verify */
1295                 for (j = 0; j < len; j++) {
1296                         if (buf [j] != (u8) (i + j)) {
1297                                 INFO (dev, "ctrl_out, byte %d is %d not %d\n",
1298                                         j, buf [j], (u8) i + j);
1299                                 retval = -EBADMSG;
1300                                 break;
1301                         }
1302                 }
1303                 if (retval < 0) {
1304                         what = "verify";
1305                         break;
1306                 }
1307
1308                 len += vary;
1309
1310                 /* [real world] the "zero bytes IN" case isn't really used.
1311                  * hardware can easily trip up in this wierd case, since its
1312                  * status stage is IN, not OUT like other ep0in transfers.
1313                  */
1314                 if (len > length)
1315                         len = realworld ? 1 : 0;
1316         }
1317
1318         if (retval < 0)
1319                 INFO (dev, "ctrl_out %s failed, code %d, count %d\n",
1320                         what, retval, i);
1321
1322         kfree (buf);
1323         return retval;
1324 }
1325
1326 /*-------------------------------------------------------------------------*/
1327
1328 /* ISO tests ... mimics common usage
1329  *  - buffer length is split into N packets (mostly maxpacket sized)
1330  *  - multi-buffers according to sglen
1331  */
1332
1333 struct iso_context {
1334         unsigned                count;
1335         unsigned                pending;
1336         spinlock_t              lock;
1337         struct completion       done;
1338         unsigned long           errors;
1339         struct usbtest_dev      *dev;
1340 };
1341
1342 static void iso_callback (struct urb *urb, struct pt_regs *regs)
1343 {
1344         struct iso_context      *ctx = urb->context;
1345
1346         spin_lock(&ctx->lock);
1347         ctx->count--;
1348
1349         if (urb->error_count > 0)
1350                 ctx->errors += urb->error_count;
1351
1352         if (urb->status == 0 && ctx->count > (ctx->pending - 1)) {
1353                 int status = usb_submit_urb (urb, GFP_ATOMIC);
1354                 switch (status) {
1355                 case 0:
1356                         goto done;
1357                 default:
1358                         dev_dbg (&ctx->dev->intf->dev,
1359                                         "iso resubmit err %d\n",
1360                                         status);
1361                         /* FALLTHROUGH */
1362                 case -ENODEV:                   /* disconnected */
1363                         break;
1364                 }
1365         }
1366         simple_free_urb (urb);
1367
1368         ctx->pending--;
1369         if (ctx->pending == 0) {
1370                 if (ctx->errors)
1371                         dev_dbg (&ctx->dev->intf->dev,
1372                                 "iso test, %lu errors\n",
1373                                 ctx->errors);
1374                 complete (&ctx->done);
1375         }
1376 done:
1377         spin_unlock(&ctx->lock);
1378 }
1379
1380 static struct urb *iso_alloc_urb (
1381         struct usb_device       *udev,
1382         int                     pipe,
1383         struct usb_endpoint_descriptor  *desc,
1384         long                    bytes
1385 )
1386 {
1387         struct urb              *urb;
1388         unsigned                i, maxp, packets;
1389
1390         if (bytes < 0 || !desc)
1391                 return NULL;
1392         maxp = 0x7ff & le16_to_cpu(desc->wMaxPacketSize);
1393         maxp *= 1 + (0x3 & (le16_to_cpu(desc->wMaxPacketSize) >> 11));
1394         packets = (bytes + maxp - 1) / maxp;
1395
1396         urb = usb_alloc_urb (packets, SLAB_KERNEL);
1397         if (!urb)
1398                 return urb;
1399         urb->dev = udev;
1400         urb->pipe = pipe;
1401
1402         urb->number_of_packets = packets;
1403         urb->transfer_buffer_length = bytes;
1404         urb->transfer_buffer = usb_buffer_alloc (udev, bytes, SLAB_KERNEL,
1405                         &urb->transfer_dma);
1406         if (!urb->transfer_buffer) {
1407                 usb_free_urb (urb);
1408                 return NULL;
1409         }
1410         memset (urb->transfer_buffer, 0, bytes);
1411         for (i = 0; i < packets; i++) {
1412                 /* here, only the last packet will be short */
1413                 urb->iso_frame_desc[i].length = min ((unsigned) bytes, maxp);
1414                 bytes -= urb->iso_frame_desc[i].length;
1415
1416                 urb->iso_frame_desc[i].offset = maxp * i;
1417         }
1418
1419         urb->complete = iso_callback;
1420         // urb->context = SET BY CALLER
1421         urb->interval = 1 << (desc->bInterval - 1);
1422         urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
1423         return urb;
1424 }
1425
1426 static int
1427 test_iso_queue (struct usbtest_dev *dev, struct usbtest_param *param,
1428                 int pipe, struct usb_endpoint_descriptor *desc)
1429 {
1430         struct iso_context      context;
1431         struct usb_device       *udev;
1432         unsigned                i;
1433         unsigned long           packets = 0;
1434         int                     status;
1435         struct urb              *urbs[10];      /* FIXME no limit */
1436
1437         if (param->sglen > 10)
1438                 return -EDOM;
1439
1440         context.count = param->iterations * param->sglen;
1441         context.pending = param->sglen;
1442         context.errors = 0;
1443         context.dev = dev;
1444         init_completion (&context.done);
1445         spin_lock_init (&context.lock);
1446
1447         memset (urbs, 0, sizeof urbs);
1448         udev = testdev_to_usbdev (dev);
1449         dev_dbg (&dev->intf->dev,
1450                 "... iso period %d %sframes, wMaxPacket %04x\n",
1451                 1 << (desc->bInterval - 1),
1452                 (udev->speed == USB_SPEED_HIGH) ? "micro" : "",
1453                 le16_to_cpu(desc->wMaxPacketSize));
1454
1455         for (i = 0; i < param->sglen; i++) {
1456                 urbs [i] = iso_alloc_urb (udev, pipe, desc,
1457                                 param->length);
1458                 if (!urbs [i]) {
1459                         status = -ENOMEM;
1460                         goto fail;
1461                 }
1462                 packets += urbs[i]->number_of_packets;
1463                 urbs [i]->context = &context;
1464         }
1465         packets *= param->iterations;
1466         dev_dbg (&dev->intf->dev,
1467                 "... total %lu msec (%lu packets)\n",
1468                 (packets * (1 << (desc->bInterval - 1)))
1469                         / ((udev->speed == USB_SPEED_HIGH) ? 8 : 1),
1470                 packets);
1471
1472         spin_lock_irq (&context.lock);
1473         for (i = 0; i < param->sglen; i++) {
1474                 status = usb_submit_urb (urbs [i], SLAB_ATOMIC);
1475                 if (status < 0) {
1476                         ERROR (dev, "submit iso[%d], error %d\n", i, status);
1477                         if (i == 0) {
1478                                 spin_unlock_irq (&context.lock);
1479                                 goto fail;
1480                         }
1481
1482                         simple_free_urb (urbs [i]);
1483                         context.pending--;
1484                 }
1485         }
1486         spin_unlock_irq (&context.lock);
1487
1488         wait_for_completion (&context.done);
1489         return 0;
1490
1491 fail:
1492         for (i = 0; i < param->sglen; i++) {
1493                 if (urbs [i])
1494                         simple_free_urb (urbs [i]);
1495         }
1496         return status;
1497 }
1498
1499 /*-------------------------------------------------------------------------*/
1500
1501 /* We only have this one interface to user space, through usbfs.
1502  * User mode code can scan usbfs to find N different devices (maybe on
1503  * different busses) to use when testing, and allocate one thread per
1504  * test.  So discovery is simplified, and we have no device naming issues.
1505  *
1506  * Don't use these only as stress/load tests.  Use them along with with
1507  * other USB bus activity:  plugging, unplugging, mousing, mp3 playback,
1508  * video capture, and so on.  Run different tests at different times, in
1509  * different sequences.  Nothing here should interact with other devices,
1510  * except indirectly by consuming USB bandwidth and CPU resources for test
1511  * threads and request completion.  But the only way to know that for sure
1512  * is to test when HC queues are in use by many devices.
1513  */
1514
1515 static int
1516 usbtest_ioctl (struct usb_interface *intf, unsigned int code, void *buf)
1517 {
1518         struct usbtest_dev      *dev = usb_get_intfdata (intf);
1519         struct usb_device       *udev = testdev_to_usbdev (dev);
1520         struct usbtest_param    *param = buf;
1521         int                     retval = -EOPNOTSUPP;
1522         struct urb              *urb;
1523         struct scatterlist      *sg;
1524         struct usb_sg_request   req;
1525         struct timeval          start;
1526         unsigned                i;
1527
1528         // FIXME USBDEVFS_CONNECTINFO doesn't say how fast the device is.
1529
1530         if (code != USBTEST_REQUEST)
1531                 return -EOPNOTSUPP;
1532
1533         if (param->iterations <= 0 || param->length < 0
1534                         || param->sglen < 0 || param->vary < 0)
1535                 return -EINVAL;
1536
1537         if (down_interruptible (&dev->sem))
1538                 return -ERESTARTSYS;
1539
1540         if (intf->dev.power.power_state.event != PM_EVENT_ON) {
1541                 up (&dev->sem);
1542                 return -EHOSTUNREACH;
1543         }
1544
1545         /* some devices, like ez-usb default devices, need a non-default
1546          * altsetting to have any active endpoints.  some tests change
1547          * altsettings; force a default so most tests don't need to check.
1548          */
1549         if (dev->info->alt >= 0) {
1550                 int     res;
1551
1552                 if (intf->altsetting->desc.bInterfaceNumber) {
1553                         up (&dev->sem);
1554                         return -ENODEV;
1555                 }
1556                 res = set_altsetting (dev, dev->info->alt);
1557                 if (res) {
1558                         dev_err (&intf->dev,
1559                                         "set altsetting to %d failed, %d\n",
1560                                         dev->info->alt, res);
1561                         up (&dev->sem);
1562                         return res;
1563                 }
1564         }
1565
1566         /*
1567          * Just a bunch of test cases that every HCD is expected to handle.
1568          *
1569          * Some may need specific firmware, though it'd be good to have
1570          * one firmware image to handle all the test cases.
1571          *
1572          * FIXME add more tests!  cancel requests, verify the data, control
1573          * queueing, concurrent read+write threads, and so on.
1574          */
1575         do_gettimeofday (&start);
1576         switch (param->test_num) {
1577
1578         case 0:
1579                 dev_dbg (&intf->dev, "TEST 0:  NOP\n");
1580                 retval = 0;
1581                 break;
1582
1583         /* Simple non-queued bulk I/O tests */
1584         case 1:
1585                 if (dev->out_pipe == 0)
1586                         break;
1587                 dev_dbg (&intf->dev,
1588                                 "TEST 1:  write %d bytes %u times\n",
1589                                 param->length, param->iterations);
1590                 urb = simple_alloc_urb (udev, dev->out_pipe, param->length);
1591                 if (!urb) {
1592                         retval = -ENOMEM;
1593                         break;
1594                 }
1595                 // FIRMWARE:  bulk sink (maybe accepts short writes)
1596                 retval = simple_io (urb, param->iterations, 0, 0, "test1");
1597                 simple_free_urb (urb);
1598                 break;
1599         case 2:
1600                 if (dev->in_pipe == 0)
1601                         break;
1602                 dev_dbg (&intf->dev,
1603                                 "TEST 2:  read %d bytes %u times\n",
1604                                 param->length, param->iterations);
1605                 urb = simple_alloc_urb (udev, dev->in_pipe, param->length);
1606                 if (!urb) {
1607                         retval = -ENOMEM;
1608                         break;
1609                 }
1610                 // FIRMWARE:  bulk source (maybe generates short writes)
1611                 retval = simple_io (urb, param->iterations, 0, 0, "test2");
1612                 simple_free_urb (urb);
1613                 break;
1614         case 3:
1615                 if (dev->out_pipe == 0 || param->vary == 0)
1616                         break;
1617                 dev_dbg (&intf->dev,
1618                                 "TEST 3:  write/%d 0..%d bytes %u times\n",
1619                                 param->vary, param->length, param->iterations);
1620                 urb = simple_alloc_urb (udev, dev->out_pipe, param->length);
1621                 if (!urb) {
1622                         retval = -ENOMEM;
1623                         break;
1624                 }
1625                 // FIRMWARE:  bulk sink (maybe accepts short writes)
1626                 retval = simple_io (urb, param->iterations, param->vary,
1627                                         0, "test3");
1628                 simple_free_urb (urb);
1629                 break;
1630         case 4:
1631                 if (dev->in_pipe == 0 || param->vary == 0)
1632                         break;
1633                 dev_dbg (&intf->dev,
1634                                 "TEST 4:  read/%d 0..%d bytes %u times\n",
1635                                 param->vary, param->length, param->iterations);
1636                 urb = simple_alloc_urb (udev, dev->in_pipe, param->length);
1637                 if (!urb) {
1638                         retval = -ENOMEM;
1639                         break;
1640                 }
1641                 // FIRMWARE:  bulk source (maybe generates short writes)
1642                 retval = simple_io (urb, param->iterations, param->vary,
1643                                         0, "test4");
1644                 simple_free_urb (urb);
1645                 break;
1646
1647         /* Queued bulk I/O tests */
1648         case 5:
1649                 if (dev->out_pipe == 0 || param->sglen == 0)
1650                         break;
1651                 dev_dbg (&intf->dev,
1652                         "TEST 5:  write %d sglists %d entries of %d bytes\n",
1653                                 param->iterations,
1654                                 param->sglen, param->length);
1655                 sg = alloc_sglist (param->sglen, param->length, 0);
1656                 if (!sg) {
1657                         retval = -ENOMEM;
1658                         break;
1659                 }
1660                 // FIRMWARE:  bulk sink (maybe accepts short writes)
1661                 retval = perform_sglist (udev, param->iterations, dev->out_pipe,
1662                                 &req, sg, param->sglen);
1663                 free_sglist (sg, param->sglen);
1664                 break;
1665
1666         case 6:
1667                 if (dev->in_pipe == 0 || param->sglen == 0)
1668                         break;
1669                 dev_dbg (&intf->dev,
1670                         "TEST 6:  read %d sglists %d entries of %d bytes\n",
1671                                 param->iterations,
1672                                 param->sglen, param->length);
1673                 sg = alloc_sglist (param->sglen, param->length, 0);
1674                 if (!sg) {
1675                         retval = -ENOMEM;
1676                         break;
1677                 }
1678                 // FIRMWARE:  bulk source (maybe generates short writes)
1679                 retval = perform_sglist (udev, param->iterations, dev->in_pipe,
1680                                 &req, sg, param->sglen);
1681                 free_sglist (sg, param->sglen);
1682                 break;
1683         case 7:
1684                 if (dev->out_pipe == 0 || param->sglen == 0 || param->vary == 0)
1685                         break;
1686                 dev_dbg (&intf->dev,
1687                         "TEST 7:  write/%d %d sglists %d entries 0..%d bytes\n",
1688                                 param->vary, param->iterations,
1689                                 param->sglen, param->length);
1690                 sg = alloc_sglist (param->sglen, param->length, param->vary);
1691                 if (!sg) {
1692                         retval = -ENOMEM;
1693                         break;
1694                 }
1695                 // FIRMWARE:  bulk sink (maybe accepts short writes)
1696                 retval = perform_sglist (udev, param->iterations, dev->out_pipe,
1697                                 &req, sg, param->sglen);
1698                 free_sglist (sg, param->sglen);
1699                 break;
1700         case 8:
1701                 if (dev->in_pipe == 0 || param->sglen == 0 || param->vary == 0)
1702                         break;
1703                 dev_dbg (&intf->dev,
1704                         "TEST 8:  read/%d %d sglists %d entries 0..%d bytes\n",
1705                                 param->vary, param->iterations,
1706                                 param->sglen, param->length);
1707                 sg = alloc_sglist (param->sglen, param->length, param->vary);
1708                 if (!sg) {
1709                         retval = -ENOMEM;
1710                         break;
1711                 }
1712                 // FIRMWARE:  bulk source (maybe generates short writes)
1713                 retval = perform_sglist (udev, param->iterations, dev->in_pipe,
1714                                 &req, sg, param->sglen);
1715                 free_sglist (sg, param->sglen);
1716                 break;
1717
1718         /* non-queued sanity tests for control (chapter 9 subset) */
1719         case 9:
1720                 retval = 0;
1721                 dev_dbg (&intf->dev,
1722                         "TEST 9:  ch9 (subset) control tests, %d times\n",
1723                                 param->iterations);
1724                 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1725                         retval = ch9_postconfig (dev);
1726                 if (retval)
1727                         dbg ("ch9 subset failed, iterations left %d", i);
1728                 break;
1729
1730         /* queued control messaging */
1731         case 10:
1732                 if (param->sglen == 0)
1733                         break;
1734                 retval = 0;
1735                 dev_dbg (&intf->dev,
1736                                 "TEST 10:  queue %d control calls, %d times\n",
1737                                 param->sglen,
1738                                 param->iterations);
1739                 retval = test_ctrl_queue (dev, param);
1740                 break;
1741
1742         /* simple non-queued unlinks (ring with one urb) */
1743         case 11:
1744                 if (dev->in_pipe == 0 || !param->length)
1745                         break;
1746                 retval = 0;
1747                 dev_dbg (&intf->dev, "TEST 11:  unlink %d reads of %d\n",
1748                                 param->iterations, param->length);
1749                 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1750                         retval = unlink_simple (dev, dev->in_pipe,
1751                                                 param->length);
1752                 if (retval)
1753                         dev_dbg (&intf->dev, "unlink reads failed %d, "
1754                                 "iterations left %d\n", retval, i);
1755                 break;
1756         case 12:
1757                 if (dev->out_pipe == 0 || !param->length)
1758                         break;
1759                 retval = 0;
1760                 dev_dbg (&intf->dev, "TEST 12:  unlink %d writes of %d\n",
1761                                 param->iterations, param->length);
1762                 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1763                         retval = unlink_simple (dev, dev->out_pipe,
1764                                                 param->length);
1765                 if (retval)
1766                         dev_dbg (&intf->dev, "unlink writes failed %d, "
1767                                 "iterations left %d\n", retval, i);
1768                 break;
1769
1770         /* ep halt tests */
1771         case 13:
1772                 if (dev->out_pipe == 0 && dev->in_pipe == 0)
1773                         break;
1774                 retval = 0;
1775                 dev_dbg (&intf->dev, "TEST 13:  set/clear %d halts\n",
1776                                 param->iterations);
1777                 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1778                         retval = halt_simple (dev);
1779
1780                 if (retval)
1781                         DBG (dev, "halts failed, iterations left %d\n", i);
1782                 break;
1783
1784         /* control write tests */
1785         case 14:
1786                 if (!dev->info->ctrl_out)
1787                         break;
1788                 dev_dbg (&intf->dev, "TEST 14:  %d ep0out, %d..%d vary %d\n",
1789                                 param->iterations,
1790                                 realworld ? 1 : 0, param->length,
1791                                 param->vary);
1792                 retval = ctrl_out (dev, param->iterations,
1793                                 param->length, param->vary);
1794                 break;
1795
1796         /* iso write tests */
1797         case 15:
1798                 if (dev->out_iso_pipe == 0 || param->sglen == 0)
1799                         break;
1800                 dev_dbg (&intf->dev,
1801                         "TEST 15:  write %d iso, %d entries of %d bytes\n",
1802                                 param->iterations,
1803                                 param->sglen, param->length);
1804                 // FIRMWARE:  iso sink
1805                 retval = test_iso_queue (dev, param,
1806                                 dev->out_iso_pipe, dev->iso_out);
1807                 break;
1808
1809         /* iso read tests */
1810         case 16:
1811                 if (dev->in_iso_pipe == 0 || param->sglen == 0)
1812                         break;
1813                 dev_dbg (&intf->dev,
1814                         "TEST 16:  read %d iso, %d entries of %d bytes\n",
1815                                 param->iterations,
1816                                 param->sglen, param->length);
1817                 // FIRMWARE:  iso source
1818                 retval = test_iso_queue (dev, param,
1819                                 dev->in_iso_pipe, dev->iso_in);
1820                 break;
1821
1822         // FIXME unlink from queue (ring with N urbs)
1823
1824         // FIXME scatterlist cancel (needs helper thread)
1825
1826         }
1827         do_gettimeofday (&param->duration);
1828         param->duration.tv_sec -= start.tv_sec;
1829         param->duration.tv_usec -= start.tv_usec;
1830         if (param->duration.tv_usec < 0) {
1831                 param->duration.tv_usec += 1000 * 1000;
1832                 param->duration.tv_sec -= 1;
1833         }
1834         up (&dev->sem);
1835         return retval;
1836 }
1837
1838 /*-------------------------------------------------------------------------*/
1839
1840 static unsigned force_interrupt = 0;
1841 module_param (force_interrupt, uint, 0);
1842 MODULE_PARM_DESC (force_interrupt, "0 = test default; else interrupt");
1843
1844 #ifdef  GENERIC
1845 static unsigned short vendor;
1846 module_param(vendor, ushort, 0);
1847 MODULE_PARM_DESC (vendor, "vendor code (from usb-if)");
1848
1849 static unsigned short product;
1850 module_param(product, ushort, 0);
1851 MODULE_PARM_DESC (product, "product code (from vendor)");
1852 #endif
1853
1854 static int
1855 usbtest_probe (struct usb_interface *intf, const struct usb_device_id *id)
1856 {
1857         struct usb_device       *udev;
1858         struct usbtest_dev      *dev;
1859         struct usbtest_info     *info;
1860         char                    *rtest, *wtest;
1861         char                    *irtest, *iwtest;
1862
1863         udev = interface_to_usbdev (intf);
1864
1865 #ifdef  GENERIC
1866         /* specify devices by module parameters? */
1867         if (id->match_flags == 0) {
1868                 /* vendor match required, product match optional */
1869                 if (!vendor || le16_to_cpu(udev->descriptor.idVendor) != (u16)vendor)
1870                         return -ENODEV;
1871                 if (product && le16_to_cpu(udev->descriptor.idProduct) != (u16)product)
1872                         return -ENODEV;
1873                 dbg ("matched module params, vend=0x%04x prod=0x%04x",
1874                                 le16_to_cpu(udev->descriptor.idVendor),
1875                                 le16_to_cpu(udev->descriptor.idProduct));
1876         }
1877 #endif
1878
1879         dev = kzalloc(sizeof(*dev), SLAB_KERNEL);
1880         if (!dev)
1881                 return -ENOMEM;
1882         info = (struct usbtest_info *) id->driver_info;
1883         dev->info = info;
1884         init_MUTEX (&dev->sem);
1885
1886         dev->intf = intf;
1887
1888         /* cacheline-aligned scratch for i/o */
1889         if ((dev->buf = kmalloc (TBUF_SIZE, SLAB_KERNEL)) == NULL) {
1890                 kfree (dev);
1891                 return -ENOMEM;
1892         }
1893
1894         /* NOTE this doesn't yet test the handful of difference that are
1895          * visible with high speed interrupts:  bigger maxpacket (1K) and
1896          * "high bandwidth" modes (up to 3 packets/uframe).
1897          */
1898         rtest = wtest = "";
1899         irtest = iwtest = "";
1900         if (force_interrupt || udev->speed == USB_SPEED_LOW) {
1901                 if (info->ep_in) {
1902                         dev->in_pipe = usb_rcvintpipe (udev, info->ep_in);
1903                         rtest = " intr-in";
1904                 }
1905                 if (info->ep_out) {
1906                         dev->out_pipe = usb_sndintpipe (udev, info->ep_out);
1907                         wtest = " intr-out";
1908                 }
1909         } else {
1910                 if (info->autoconf) {
1911                         int status;
1912
1913                         status = get_endpoints (dev, intf);
1914                         if (status < 0) {
1915                                 dbg ("couldn't get endpoints, %d\n", status);
1916                                 return status;
1917                         }
1918                         /* may find bulk or ISO pipes */
1919                 } else {
1920                         if (info->ep_in)
1921                                 dev->in_pipe = usb_rcvbulkpipe (udev,
1922                                                         info->ep_in);
1923                         if (info->ep_out)
1924                                 dev->out_pipe = usb_sndbulkpipe (udev,
1925                                                         info->ep_out);
1926                 }
1927                 if (dev->in_pipe)
1928                         rtest = " bulk-in";
1929                 if (dev->out_pipe)
1930                         wtest = " bulk-out";
1931                 if (dev->in_iso_pipe)
1932                         irtest = " iso-in";
1933                 if (dev->out_iso_pipe)
1934                         iwtest = " iso-out";
1935         }
1936
1937         usb_set_intfdata (intf, dev);
1938         dev_info (&intf->dev, "%s\n", info->name);
1939         dev_info (&intf->dev, "%s speed {control%s%s%s%s%s} tests%s\n",
1940                         ({ char *tmp;
1941                         switch (udev->speed) {
1942                         case USB_SPEED_LOW: tmp = "low"; break;
1943                         case USB_SPEED_FULL: tmp = "full"; break;
1944                         case USB_SPEED_HIGH: tmp = "high"; break;
1945                         default: tmp = "unknown"; break;
1946                         }; tmp; }),
1947                         info->ctrl_out ? " in/out" : "",
1948                         rtest, wtest,
1949                         irtest, iwtest,
1950                         info->alt >= 0 ? " (+alt)" : "");
1951         return 0;
1952 }
1953
1954 static int usbtest_suspend (struct usb_interface *intf, pm_message_t message)
1955 {
1956         return 0;
1957 }
1958
1959 static int usbtest_resume (struct usb_interface *intf)
1960 {
1961         return 0;
1962 }
1963
1964
1965 static void usbtest_disconnect (struct usb_interface *intf)
1966 {
1967         struct usbtest_dev      *dev = usb_get_intfdata (intf);
1968
1969         down (&dev->sem);
1970
1971         usb_set_intfdata (intf, NULL);
1972         dev_dbg (&intf->dev, "disconnect\n");
1973         kfree (dev);
1974 }
1975
1976 /* Basic testing only needs a device that can source or sink bulk traffic.
1977  * Any device can test control transfers (default with GENERIC binding).
1978  *
1979  * Several entries work with the default EP0 implementation that's built
1980  * into EZ-USB chips.  There's a default vendor ID which can be overridden
1981  * by (very) small config EEPROMS, but otherwise all these devices act
1982  * identically until firmware is loaded:  only EP0 works.  It turns out
1983  * to be easy to make other endpoints work, without modifying that EP0
1984  * behavior.  For now, we expect that kind of firmware.
1985  */
1986
1987 /* an21xx or fx versions of ez-usb */
1988 static struct usbtest_info ez1_info = {
1989         .name           = "EZ-USB device",
1990         .ep_in          = 2,
1991         .ep_out         = 2,
1992         .alt            = 1,
1993 };
1994
1995 /* fx2 version of ez-usb */
1996 static struct usbtest_info ez2_info = {
1997         .name           = "FX2 device",
1998         .ep_in          = 6,
1999         .ep_out         = 2,
2000         .alt            = 1,
2001 };
2002
2003 /* ezusb family device with dedicated usb test firmware,
2004  */
2005 static struct usbtest_info fw_info = {
2006         .name           = "usb test device",
2007         .ep_in          = 2,
2008         .ep_out         = 2,
2009         .alt            = 1,
2010         .autoconf       = 1,            // iso and ctrl_out need autoconf
2011         .ctrl_out       = 1,
2012         .iso            = 1,            // iso_ep's are #8 in/out
2013 };
2014
2015 /* peripheral running Linux and 'zero.c' test firmware, or
2016  * its user-mode cousin. different versions of this use
2017  * different hardware with the same vendor/product codes.
2018  * host side MUST rely on the endpoint descriptors.
2019  */
2020 static struct usbtest_info gz_info = {
2021         .name           = "Linux gadget zero",
2022         .autoconf       = 1,
2023         .ctrl_out       = 1,
2024         .alt            = 0,
2025 };
2026
2027 static struct usbtest_info um_info = {
2028         .name           = "Linux user mode test driver",
2029         .autoconf       = 1,
2030         .alt            = -1,
2031 };
2032
2033 static struct usbtest_info um2_info = {
2034         .name           = "Linux user mode ISO test driver",
2035         .autoconf       = 1,
2036         .iso            = 1,
2037         .alt            = -1,
2038 };
2039
2040 #ifdef IBOT2
2041 /* this is a nice source of high speed bulk data;
2042  * uses an FX2, with firmware provided in the device
2043  */
2044 static struct usbtest_info ibot2_info = {
2045         .name           = "iBOT2 webcam",
2046         .ep_in          = 2,
2047         .alt            = -1,
2048 };
2049 #endif
2050
2051 #ifdef GENERIC
2052 /* we can use any device to test control traffic */
2053 static struct usbtest_info generic_info = {
2054         .name           = "Generic USB device",
2055         .alt            = -1,
2056 };
2057 #endif
2058
2059 // FIXME remove this
2060 static struct usbtest_info hact_info = {
2061         .name           = "FX2/hact",
2062         //.ep_in                = 6,
2063         .ep_out         = 2,
2064         .alt            = -1,
2065 };
2066
2067
2068 static struct usb_device_id id_table [] = {
2069
2070         { USB_DEVICE (0x0547, 0x1002),
2071                 .driver_info = (unsigned long) &hact_info,
2072                 },
2073
2074         /*-------------------------------------------------------------*/
2075
2076         /* EZ-USB devices which download firmware to replace (or in our
2077          * case augment) the default device implementation.
2078          */
2079
2080         /* generic EZ-USB FX controller */
2081         { USB_DEVICE (0x0547, 0x2235),
2082                 .driver_info = (unsigned long) &ez1_info,
2083                 },
2084
2085         /* CY3671 development board with EZ-USB FX */
2086         { USB_DEVICE (0x0547, 0x0080),
2087                 .driver_info = (unsigned long) &ez1_info,
2088                 },
2089
2090         /* generic EZ-USB FX2 controller (or development board) */
2091         { USB_DEVICE (0x04b4, 0x8613),
2092                 .driver_info = (unsigned long) &ez2_info,
2093                 },
2094
2095         /* re-enumerated usb test device firmware */
2096         { USB_DEVICE (0xfff0, 0xfff0),
2097                 .driver_info = (unsigned long) &fw_info,
2098                 },
2099
2100         /* "Gadget Zero" firmware runs under Linux */
2101         { USB_DEVICE (0x0525, 0xa4a0),
2102                 .driver_info = (unsigned long) &gz_info,
2103                 },
2104
2105         /* so does a user-mode variant */
2106         { USB_DEVICE (0x0525, 0xa4a4),
2107                 .driver_info = (unsigned long) &um_info,
2108                 },
2109
2110         /* ... and a user-mode variant that talks iso */
2111         { USB_DEVICE (0x0525, 0xa4a3),
2112                 .driver_info = (unsigned long) &um2_info,
2113                 },
2114
2115 #ifdef KEYSPAN_19Qi
2116         /* Keyspan 19qi uses an21xx (original EZ-USB) */
2117         // this does not coexist with the real Keyspan 19qi driver!
2118         { USB_DEVICE (0x06cd, 0x010b),
2119                 .driver_info = (unsigned long) &ez1_info,
2120                 },
2121 #endif
2122
2123         /*-------------------------------------------------------------*/
2124
2125 #ifdef IBOT2
2126         /* iBOT2 makes a nice source of high speed bulk-in data */
2127         // this does not coexist with a real iBOT2 driver!
2128         { USB_DEVICE (0x0b62, 0x0059),
2129                 .driver_info = (unsigned long) &ibot2_info,
2130                 },
2131 #endif
2132
2133         /*-------------------------------------------------------------*/
2134
2135 #ifdef GENERIC
2136         /* module params can specify devices to use for control tests */
2137         { .driver_info = (unsigned long) &generic_info, },
2138 #endif
2139
2140         /*-------------------------------------------------------------*/
2141
2142         { }
2143 };
2144 MODULE_DEVICE_TABLE (usb, id_table);
2145
2146 static struct usb_driver usbtest_driver = {
2147         .name =         "usbtest",
2148         .id_table =     id_table,
2149         .probe =        usbtest_probe,
2150         .ioctl =        usbtest_ioctl,
2151         .disconnect =   usbtest_disconnect,
2152         .suspend =      usbtest_suspend,
2153         .resume =       usbtest_resume,
2154 };
2155
2156 /*-------------------------------------------------------------------------*/
2157
2158 static int __init usbtest_init (void)
2159 {
2160 #ifdef GENERIC
2161         if (vendor)
2162                 dbg ("params: vend=0x%04x prod=0x%04x", vendor, product);
2163 #endif
2164         return usb_register (&usbtest_driver);
2165 }
2166 module_init (usbtest_init);
2167
2168 static void __exit usbtest_exit (void)
2169 {
2170         usb_deregister (&usbtest_driver);
2171 }
2172 module_exit (usbtest_exit);
2173
2174 MODULE_DESCRIPTION ("USB Core/HCD Testing Driver");
2175 MODULE_LICENSE ("GPL");
2176