drivers/usb/misc/usbtest.c

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