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