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