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