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