drivers/usb/misc/usbtest.c

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