1 #include <linux/kernel.h>
2 #include <linux/errno.h>
3 #include <linux/init.h>
4 #include <linux/slab.h>
6 #include <linux/module.h>
7 #include <linux/moduleparam.h>
8 #include <linux/scatterlist.h>
9 #include <linux/mutex.h>
11 #include <linux/usb.h>
14 /*-------------------------------------------------------------------------*/
16 static int override_alt = -1;
17 module_param_named(alt, override_alt, int, 0644);
18 MODULE_PARM_DESC(alt, ">= 0 to override altsetting selection");
20 /*-------------------------------------------------------------------------*/
22 /* FIXME make these public somewhere; usbdevfs.h? */
23 struct usbtest_param {
25 unsigned test_num; /* 0..(TEST_CASES-1) */
32 struct timeval duration;
34 #define USBTEST_REQUEST _IOWR('U', 100, struct usbtest_param)
36 /*-------------------------------------------------------------------------*/
38 #define GENERIC /* let probe() bind using module params */
40 /* Some devices that can be used for testing will have "real" drivers.
41 * Entries for those need to be enabled here by hand, after disabling
44 //#define IBOT2 /* grab iBOT2 webcams */
45 //#define KEYSPAN_19Qi /* grab un-renumerated serial adapter */
47 /*-------------------------------------------------------------------------*/
51 u8 ep_in; /* bulk/intr source */
52 u8 ep_out; /* bulk/intr sink */
55 unsigned iso:1; /* try iso in/out */
59 /* this is accessed only through usbfs ioctl calls.
60 * one ioctl to issue a test ... one lock per device.
61 * tests create other threads if they need them.
62 * urbs and buffers are allocated dynamically,
63 * and data generated deterministically.
66 struct usb_interface *intf;
67 struct usbtest_info *info;
72 struct usb_endpoint_descriptor *iso_in, *iso_out;
79 static struct usb_device *testdev_to_usbdev(struct usbtest_dev *test)
81 return interface_to_usbdev(test->intf);
84 /* set up all urbs so they can be used with either bulk or interrupt */
85 #define INTERRUPT_RATE 1 /* msec/transfer */
87 #define ERROR(tdev, fmt, args...) \
88 dev_err(&(tdev)->intf->dev , fmt , ## args)
89 #define WARNING(tdev, fmt, args...) \
90 dev_warn(&(tdev)->intf->dev , fmt , ## args)
92 #define GUARD_BYTE 0xA5
94 /*-------------------------------------------------------------------------*/
97 get_endpoints(struct usbtest_dev *dev, struct usb_interface *intf)
100 struct usb_host_interface *alt;
101 struct usb_host_endpoint *in, *out;
102 struct usb_host_endpoint *iso_in, *iso_out;
103 struct usb_device *udev;
105 for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
109 iso_in = iso_out = NULL;
110 alt = intf->altsetting + tmp;
112 if (override_alt >= 0 &&
113 override_alt != alt->desc.bAlternateSetting)
116 /* take the first altsetting with in-bulk + out-bulk;
117 * ignore other endpoints and altsettings.
119 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
120 struct usb_host_endpoint *e;
122 e = alt->endpoint + ep;
123 switch (e->desc.bmAttributes) {
124 case USB_ENDPOINT_XFER_BULK:
126 case USB_ENDPOINT_XFER_ISOC:
133 if (usb_endpoint_dir_in(&e->desc)) {
142 if (usb_endpoint_dir_in(&e->desc)) {
150 if ((in && out) || iso_in || iso_out)
156 udev = testdev_to_usbdev(dev);
157 dev->info->alt = alt->desc.bAlternateSetting;
158 if (alt->desc.bAlternateSetting != 0) {
159 tmp = usb_set_interface(udev,
160 alt->desc.bInterfaceNumber,
161 alt->desc.bAlternateSetting);
167 dev->in_pipe = usb_rcvbulkpipe(udev,
168 in->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
169 dev->out_pipe = usb_sndbulkpipe(udev,
170 out->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
173 dev->iso_in = &iso_in->desc;
174 dev->in_iso_pipe = usb_rcvisocpipe(udev,
175 iso_in->desc.bEndpointAddress
176 & USB_ENDPOINT_NUMBER_MASK);
180 dev->iso_out = &iso_out->desc;
181 dev->out_iso_pipe = usb_sndisocpipe(udev,
182 iso_out->desc.bEndpointAddress
183 & USB_ENDPOINT_NUMBER_MASK);
188 /*-------------------------------------------------------------------------*/
190 /* Support for testing basic non-queued I/O streams.
192 * These just package urbs as requests that can be easily canceled.
193 * Each urb's data buffer is dynamically allocated; callers can fill
194 * them with non-zero test data (or test for it) when appropriate.
197 static void simple_callback(struct urb *urb)
199 complete(urb->context);
202 static struct urb *usbtest_alloc_urb(
203 struct usb_device *udev,
206 unsigned transfer_flags,
211 urb = usb_alloc_urb(0, GFP_KERNEL);
214 usb_fill_bulk_urb(urb, udev, pipe, NULL, bytes, simple_callback, NULL);
215 urb->interval = (udev->speed == USB_SPEED_HIGH)
216 ? (INTERRUPT_RATE << 3)
218 urb->transfer_flags = transfer_flags;
219 if (usb_pipein(pipe))
220 urb->transfer_flags |= URB_SHORT_NOT_OK;
222 if (urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)
223 urb->transfer_buffer = usb_alloc_coherent(udev, bytes + offset,
224 GFP_KERNEL, &urb->transfer_dma);
226 urb->transfer_buffer = kmalloc(bytes + offset, GFP_KERNEL);
228 if (!urb->transfer_buffer) {
233 /* To test unaligned transfers add an offset and fill the
234 unused memory with a guard value */
236 memset(urb->transfer_buffer, GUARD_BYTE, offset);
237 urb->transfer_buffer += offset;
238 if (urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)
239 urb->transfer_dma += offset;
242 /* For inbound transfers use guard byte so that test fails if
243 data not correctly copied */
244 memset(urb->transfer_buffer,
245 usb_pipein(urb->pipe) ? GUARD_BYTE : 0,
250 static struct urb *simple_alloc_urb(
251 struct usb_device *udev,
255 return usbtest_alloc_urb(udev, pipe, bytes, URB_NO_TRANSFER_DMA_MAP, 0);
258 static unsigned pattern;
259 static unsigned mod_pattern;
260 module_param_named(pattern, mod_pattern, uint, S_IRUGO | S_IWUSR);
261 MODULE_PARM_DESC(mod_pattern, "i/o pattern (0 == zeroes)");
263 static inline void simple_fill_buf(struct urb *urb)
266 u8 *buf = urb->transfer_buffer;
267 unsigned len = urb->transfer_buffer_length;
276 for (i = 0; i < len; i++)
277 *buf++ = (u8) (i % 63);
282 static inline unsigned long buffer_offset(void *buf)
284 return (unsigned long)buf & (ARCH_KMALLOC_MINALIGN - 1);
287 static int check_guard_bytes(struct usbtest_dev *tdev, struct urb *urb)
289 u8 *buf = urb->transfer_buffer;
290 u8 *guard = buf - buffer_offset(buf);
293 for (i = 0; guard < buf; i++, guard++) {
294 if (*guard != GUARD_BYTE) {
295 ERROR(tdev, "guard byte[%d] %d (not %d)\n",
296 i, *guard, GUARD_BYTE);
303 static int simple_check_buf(struct usbtest_dev *tdev, struct urb *urb)
307 u8 *buf = urb->transfer_buffer;
308 unsigned len = urb->actual_length;
310 int ret = check_guard_bytes(tdev, urb);
314 for (i = 0; i < len; i++, buf++) {
316 /* all-zeroes has no synchronization issues */
320 /* mod63 stays in sync with short-terminated transfers,
321 * or otherwise when host and gadget agree on how large
322 * each usb transfer request should be. resync is done
323 * with set_interface or set_config.
328 /* always fail unsupported patterns */
333 if (*buf == expected)
335 ERROR(tdev, "buf[%d] = %d (not %d)\n", i, *buf, expected);
341 static void simple_free_urb(struct urb *urb)
343 unsigned long offset = buffer_offset(urb->transfer_buffer);
345 if (urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)
348 urb->transfer_buffer_length + offset,
349 urb->transfer_buffer - offset,
350 urb->transfer_dma - offset);
352 kfree(urb->transfer_buffer - offset);
356 static int simple_io(
357 struct usbtest_dev *tdev,
365 struct usb_device *udev = urb->dev;
366 int max = urb->transfer_buffer_length;
367 struct completion completion;
370 urb->context = &completion;
371 while (retval == 0 && iterations-- > 0) {
372 init_completion(&completion);
373 if (usb_pipeout(urb->pipe)) {
374 simple_fill_buf(urb);
375 urb->transfer_flags |= URB_ZERO_PACKET;
377 retval = usb_submit_urb(urb, GFP_KERNEL);
381 /* NOTE: no timeouts; can't be broken out of by interrupt */
382 wait_for_completion(&completion);
383 retval = urb->status;
385 if (retval == 0 && usb_pipein(urb->pipe))
386 retval = simple_check_buf(tdev, urb);
389 int len = urb->transfer_buffer_length;
394 len = (vary < max) ? vary : max;
395 urb->transfer_buffer_length = len;
398 /* FIXME if endpoint halted, clear halt (and log) */
400 urb->transfer_buffer_length = max;
402 if (expected != retval)
404 "%s failed, iterations left %d, status %d (not %d)\n",
405 label, iterations, retval, expected);
410 /*-------------------------------------------------------------------------*/
412 /* We use scatterlist primitives to test queued I/O.
413 * Yes, this also tests the scatterlist primitives.
416 static void free_sglist(struct scatterlist *sg, int nents)
422 for (i = 0; i < nents; i++) {
423 if (!sg_page(&sg[i]))
425 kfree(sg_virt(&sg[i]));
430 static struct scatterlist *
431 alloc_sglist(int nents, int max, int vary)
433 struct scatterlist *sg;
440 sg = kmalloc_array(nents, sizeof *sg, GFP_KERNEL);
443 sg_init_table(sg, nents);
445 for (i = 0; i < nents; i++) {
449 buf = kzalloc(size, GFP_KERNEL);
455 /* kmalloc pages are always physically contiguous! */
456 sg_set_buf(&sg[i], buf, size);
463 for (j = 0; j < size; j++)
464 *buf++ = (u8) (j % 63);
472 size = (vary < max) ? vary : max;
479 static int perform_sglist(
480 struct usbtest_dev *tdev,
483 struct usb_sg_request *req,
484 struct scatterlist *sg,
488 struct usb_device *udev = testdev_to_usbdev(tdev);
491 while (retval == 0 && iterations-- > 0) {
492 retval = usb_sg_init(req, udev, pipe,
493 (udev->speed == USB_SPEED_HIGH)
494 ? (INTERRUPT_RATE << 3)
496 sg, nents, 0, GFP_KERNEL);
501 retval = req->status;
503 /* FIXME check resulting data pattern */
505 /* FIXME if endpoint halted, clear halt (and log) */
508 /* FIXME for unlink or fault handling tests, don't report
509 * failure if retval is as we expected ...
512 ERROR(tdev, "perform_sglist failed, "
513 "iterations left %d, status %d\n",
519 /*-------------------------------------------------------------------------*/
521 /* unqueued control message testing
523 * there's a nice set of device functional requirements in chapter 9 of the
524 * usb 2.0 spec, which we can apply to ANY device, even ones that don't use
525 * special test firmware.
527 * we know the device is configured (or suspended) by the time it's visible
528 * through usbfs. we can't change that, so we won't test enumeration (which
529 * worked 'well enough' to get here, this time), power management (ditto),
530 * or remote wakeup (which needs human interaction).
533 static unsigned realworld = 1;
534 module_param(realworld, uint, 0);
535 MODULE_PARM_DESC(realworld, "clear to demand stricter spec compliance");
537 static int get_altsetting(struct usbtest_dev *dev)
539 struct usb_interface *iface = dev->intf;
540 struct usb_device *udev = interface_to_usbdev(iface);
543 retval = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
544 USB_REQ_GET_INTERFACE, USB_DIR_IN|USB_RECIP_INTERFACE,
545 0, iface->altsetting[0].desc.bInterfaceNumber,
546 dev->buf, 1, USB_CTRL_GET_TIMEOUT);
558 static int set_altsetting(struct usbtest_dev *dev, int alternate)
560 struct usb_interface *iface = dev->intf;
561 struct usb_device *udev;
563 if (alternate < 0 || alternate >= 256)
566 udev = interface_to_usbdev(iface);
567 return usb_set_interface(udev,
568 iface->altsetting[0].desc.bInterfaceNumber,
572 static int is_good_config(struct usbtest_dev *tdev, int len)
574 struct usb_config_descriptor *config;
576 if (len < sizeof *config)
578 config = (struct usb_config_descriptor *) tdev->buf;
580 switch (config->bDescriptorType) {
582 case USB_DT_OTHER_SPEED_CONFIG:
583 if (config->bLength != 9) {
584 ERROR(tdev, "bogus config descriptor length\n");
587 /* this bit 'must be 1' but often isn't */
588 if (!realworld && !(config->bmAttributes & 0x80)) {
589 ERROR(tdev, "high bit of config attributes not set\n");
592 if (config->bmAttributes & 0x1f) { /* reserved == 0 */
593 ERROR(tdev, "reserved config bits set\n");
601 if (le16_to_cpu(config->wTotalLength) == len) /* read it all */
603 if (le16_to_cpu(config->wTotalLength) >= TBUF_SIZE) /* max partial read */
605 ERROR(tdev, "bogus config descriptor read size\n");
609 /* sanity test for standard requests working with usb_control_mesg() and some
610 * of the utility functions which use it.
612 * this doesn't test how endpoint halts behave or data toggles get set, since
613 * we won't do I/O to bulk/interrupt endpoints here (which is how to change
614 * halt or toggle). toggle testing is impractical without support from hcds.
616 * this avoids failing devices linux would normally work with, by not testing
617 * config/altsetting operations for devices that only support their defaults.
618 * such devices rarely support those needless operations.
620 * NOTE that since this is a sanity test, it's not examining boundary cases
621 * to see if usbcore, hcd, and device all behave right. such testing would
622 * involve varied read sizes and other operation sequences.
624 static int ch9_postconfig(struct usbtest_dev *dev)
626 struct usb_interface *iface = dev->intf;
627 struct usb_device *udev = interface_to_usbdev(iface);
630 /* [9.2.3] if there's more than one altsetting, we need to be able to
631 * set and get each one. mostly trusts the descriptors from usbcore.
633 for (i = 0; i < iface->num_altsetting; i++) {
635 /* 9.2.3 constrains the range here */
636 alt = iface->altsetting[i].desc.bAlternateSetting;
637 if (alt < 0 || alt >= iface->num_altsetting) {
639 "invalid alt [%d].bAltSetting = %d\n",
643 /* [real world] get/set unimplemented if there's only one */
644 if (realworld && iface->num_altsetting == 1)
647 /* [9.4.10] set_interface */
648 retval = set_altsetting(dev, alt);
650 dev_err(&iface->dev, "can't set_interface = %d, %d\n",
655 /* [9.4.4] get_interface always works */
656 retval = get_altsetting(dev);
658 dev_err(&iface->dev, "get alt should be %d, was %d\n",
660 return (retval < 0) ? retval : -EDOM;
665 /* [real world] get_config unimplemented if there's only one */
666 if (!realworld || udev->descriptor.bNumConfigurations != 1) {
667 int expected = udev->actconfig->desc.bConfigurationValue;
669 /* [9.4.2] get_configuration always works
670 * ... although some cheap devices (like one TI Hub I've got)
671 * won't return config descriptors except before set_config.
673 retval = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
674 USB_REQ_GET_CONFIGURATION,
675 USB_DIR_IN | USB_RECIP_DEVICE,
676 0, 0, dev->buf, 1, USB_CTRL_GET_TIMEOUT);
677 if (retval != 1 || dev->buf[0] != expected) {
678 dev_err(&iface->dev, "get config --> %d %d (1 %d)\n",
679 retval, dev->buf[0], expected);
680 return (retval < 0) ? retval : -EDOM;
684 /* there's always [9.4.3] a device descriptor [9.6.1] */
685 retval = usb_get_descriptor(udev, USB_DT_DEVICE, 0,
686 dev->buf, sizeof udev->descriptor);
687 if (retval != sizeof udev->descriptor) {
688 dev_err(&iface->dev, "dev descriptor --> %d\n", retval);
689 return (retval < 0) ? retval : -EDOM;
692 /* there's always [9.4.3] at least one config descriptor [9.6.3] */
693 for (i = 0; i < udev->descriptor.bNumConfigurations; i++) {
694 retval = usb_get_descriptor(udev, USB_DT_CONFIG, i,
695 dev->buf, TBUF_SIZE);
696 if (!is_good_config(dev, retval)) {
698 "config [%d] descriptor --> %d\n",
700 return (retval < 0) ? retval : -EDOM;
703 /* FIXME cross-checking udev->config[i] to make sure usbcore
704 * parsed it right (etc) would be good testing paranoia
708 /* and sometimes [9.2.6.6] speed dependent descriptors */
709 if (le16_to_cpu(udev->descriptor.bcdUSB) == 0x0200) {
710 struct usb_qualifier_descriptor *d = NULL;
712 /* device qualifier [9.6.2] */
713 retval = usb_get_descriptor(udev,
714 USB_DT_DEVICE_QUALIFIER, 0, dev->buf,
715 sizeof(struct usb_qualifier_descriptor));
716 if (retval == -EPIPE) {
717 if (udev->speed == USB_SPEED_HIGH) {
719 "hs dev qualifier --> %d\n",
721 return (retval < 0) ? retval : -EDOM;
723 /* usb2.0 but not high-speed capable; fine */
724 } else if (retval != sizeof(struct usb_qualifier_descriptor)) {
725 dev_err(&iface->dev, "dev qualifier --> %d\n", retval);
726 return (retval < 0) ? retval : -EDOM;
728 d = (struct usb_qualifier_descriptor *) dev->buf;
730 /* might not have [9.6.2] any other-speed configs [9.6.4] */
732 unsigned max = d->bNumConfigurations;
733 for (i = 0; i < max; i++) {
734 retval = usb_get_descriptor(udev,
735 USB_DT_OTHER_SPEED_CONFIG, i,
736 dev->buf, TBUF_SIZE);
737 if (!is_good_config(dev, retval)) {
739 "other speed config --> %d\n",
741 return (retval < 0) ? retval : -EDOM;
746 /* FIXME fetch strings from at least the device descriptor */
748 /* [9.4.5] get_status always works */
749 retval = usb_get_status(udev, USB_RECIP_DEVICE, 0, dev->buf);
751 dev_err(&iface->dev, "get dev status --> %d\n", retval);
755 /* FIXME configuration.bmAttributes says if we could try to set/clear
756 * the device's remote wakeup feature ... if we can, test that here
759 retval = usb_get_status(udev, USB_RECIP_INTERFACE,
760 iface->altsetting[0].desc.bInterfaceNumber, dev->buf);
762 dev_err(&iface->dev, "get interface status --> %d\n", retval);
765 /* FIXME get status for each endpoint in the interface */
770 /*-------------------------------------------------------------------------*/
772 /* use ch9 requests to test whether:
773 * (a) queues work for control, keeping N subtests queued and
774 * active (auto-resubmit) for M loops through the queue.
775 * (b) protocol stalls (control-only) will autorecover.
776 * it's not like bulk/intr; no halt clearing.
777 * (c) short control reads are reported and handled.
778 * (d) queues are always processed in-order
783 struct usbtest_dev *dev;
784 struct completion complete;
789 struct usbtest_param *param;
793 #define NUM_SUBCASES 15 /* how many test subcases here? */
796 struct usb_ctrlrequest setup;
801 static void ctrl_complete(struct urb *urb)
803 struct ctrl_ctx *ctx = urb->context;
804 struct usb_ctrlrequest *reqp;
805 struct subcase *subcase;
806 int status = urb->status;
808 reqp = (struct usb_ctrlrequest *)urb->setup_packet;
809 subcase = container_of(reqp, struct subcase, setup);
811 spin_lock(&ctx->lock);
815 /* queue must transfer and complete in fifo order, unless
816 * usb_unlink_urb() is used to unlink something not at the
817 * physical queue head (not tested).
819 if (subcase->number > 0) {
820 if ((subcase->number - ctx->last) != 1) {
822 "subcase %d completed out of order, last %d\n",
823 subcase->number, ctx->last);
825 ctx->last = subcase->number;
829 ctx->last = subcase->number;
831 /* succeed or fault in only one way? */
832 if (status == subcase->expected)
835 /* async unlink for cleanup? */
836 else if (status != -ECONNRESET) {
838 /* some faults are allowed, not required */
839 if (subcase->expected > 0 && (
840 ((status == -subcase->expected /* happened */
841 || status == 0)))) /* didn't */
843 /* sometimes more than one fault is allowed */
844 else if (subcase->number == 12 && status == -EPIPE)
847 ERROR(ctx->dev, "subtest %d error, status %d\n",
848 subcase->number, status);
851 /* unexpected status codes mean errors; ideally, in hardware */
854 if (ctx->status == 0) {
857 ctx->status = status;
858 ERROR(ctx->dev, "control queue %02x.%02x, err %d, "
859 "%d left, subcase %d, len %d/%d\n",
860 reqp->bRequestType, reqp->bRequest,
861 status, ctx->count, subcase->number,
863 urb->transfer_buffer_length);
865 /* FIXME this "unlink everything" exit route should
866 * be a separate test case.
869 /* unlink whatever's still pending */
870 for (i = 1; i < ctx->param->sglen; i++) {
871 struct urb *u = ctx->urb[
872 (i + subcase->number)
873 % ctx->param->sglen];
875 if (u == urb || !u->dev)
877 spin_unlock(&ctx->lock);
878 status = usb_unlink_urb(u);
879 spin_lock(&ctx->lock);
886 ERROR(ctx->dev, "urb unlink --> %d\n",
890 status = ctx->status;
894 /* resubmit if we need to, else mark this as done */
895 if ((status == 0) && (ctx->pending < ctx->count)) {
896 status = usb_submit_urb(urb, GFP_ATOMIC);
899 "can't resubmit ctrl %02x.%02x, err %d\n",
900 reqp->bRequestType, reqp->bRequest, status);
907 /* signal completion when nothing's queued */
908 if (ctx->pending == 0)
909 complete(&ctx->complete);
910 spin_unlock(&ctx->lock);
914 test_ctrl_queue(struct usbtest_dev *dev, struct usbtest_param *param)
916 struct usb_device *udev = testdev_to_usbdev(dev);
918 struct ctrl_ctx context;
921 if (param->sglen == 0 || param->iterations > UINT_MAX / param->sglen)
924 spin_lock_init(&context.lock);
926 init_completion(&context.complete);
927 context.count = param->sglen * param->iterations;
929 context.status = -ENOMEM;
930 context.param = param;
933 /* allocate and init the urbs we'll queue.
934 * as with bulk/intr sglists, sglen is the queue depth; it also
935 * controls which subtests run (more tests than sglen) or rerun.
937 urb = kcalloc(param->sglen, sizeof(struct urb *), GFP_KERNEL);
940 for (i = 0; i < param->sglen; i++) {
941 int pipe = usb_rcvctrlpipe(udev, 0);
944 struct usb_ctrlrequest req;
945 struct subcase *reqp;
947 /* sign of this variable means:
948 * -: tested code must return this (negative) error code
949 * +: tested code may return this (negative too) error code
953 /* requests here are mostly expected to succeed on any
954 * device, but some are chosen to trigger protocol stalls
957 memset(&req, 0, sizeof req);
958 req.bRequest = USB_REQ_GET_DESCRIPTOR;
959 req.bRequestType = USB_DIR_IN|USB_RECIP_DEVICE;
961 switch (i % NUM_SUBCASES) {
962 case 0: /* get device descriptor */
963 req.wValue = cpu_to_le16(USB_DT_DEVICE << 8);
964 len = sizeof(struct usb_device_descriptor);
966 case 1: /* get first config descriptor (only) */
967 req.wValue = cpu_to_le16((USB_DT_CONFIG << 8) | 0);
968 len = sizeof(struct usb_config_descriptor);
970 case 2: /* get altsetting (OFTEN STALLS) */
971 req.bRequest = USB_REQ_GET_INTERFACE;
972 req.bRequestType = USB_DIR_IN|USB_RECIP_INTERFACE;
973 /* index = 0 means first interface */
977 case 3: /* get interface status */
978 req.bRequest = USB_REQ_GET_STATUS;
979 req.bRequestType = USB_DIR_IN|USB_RECIP_INTERFACE;
983 case 4: /* get device status */
984 req.bRequest = USB_REQ_GET_STATUS;
985 req.bRequestType = USB_DIR_IN|USB_RECIP_DEVICE;
988 case 5: /* get device qualifier (MAY STALL) */
989 req.wValue = cpu_to_le16 (USB_DT_DEVICE_QUALIFIER << 8);
990 len = sizeof(struct usb_qualifier_descriptor);
991 if (udev->speed != USB_SPEED_HIGH)
994 case 6: /* get first config descriptor, plus interface */
995 req.wValue = cpu_to_le16((USB_DT_CONFIG << 8) | 0);
996 len = sizeof(struct usb_config_descriptor);
997 len += sizeof(struct usb_interface_descriptor);
999 case 7: /* get interface descriptor (ALWAYS STALLS) */
1000 req.wValue = cpu_to_le16 (USB_DT_INTERFACE << 8);
1001 /* interface == 0 */
1002 len = sizeof(struct usb_interface_descriptor);
1005 /* NOTE: two consecutive stalls in the queue here.
1006 * that tests fault recovery a bit more aggressively. */
1007 case 8: /* clear endpoint halt (MAY STALL) */
1008 req.bRequest = USB_REQ_CLEAR_FEATURE;
1009 req.bRequestType = USB_RECIP_ENDPOINT;
1010 /* wValue 0 == ep halt */
1011 /* wIndex 0 == ep0 (shouldn't halt!) */
1013 pipe = usb_sndctrlpipe(udev, 0);
1016 case 9: /* get endpoint status */
1017 req.bRequest = USB_REQ_GET_STATUS;
1018 req.bRequestType = USB_DIR_IN|USB_RECIP_ENDPOINT;
1022 case 10: /* trigger short read (EREMOTEIO) */
1023 req.wValue = cpu_to_le16((USB_DT_CONFIG << 8) | 0);
1025 expected = -EREMOTEIO;
1027 /* NOTE: two consecutive _different_ faults in the queue. */
1028 case 11: /* get endpoint descriptor (ALWAYS STALLS) */
1029 req.wValue = cpu_to_le16(USB_DT_ENDPOINT << 8);
1031 len = sizeof(struct usb_interface_descriptor);
1034 /* NOTE: sometimes even a third fault in the queue! */
1035 case 12: /* get string 0 descriptor (MAY STALL) */
1036 req.wValue = cpu_to_le16(USB_DT_STRING << 8);
1037 /* string == 0, for language IDs */
1038 len = sizeof(struct usb_interface_descriptor);
1039 /* may succeed when > 4 languages */
1040 expected = EREMOTEIO; /* or EPIPE, if no strings */
1042 case 13: /* short read, resembling case 10 */
1043 req.wValue = cpu_to_le16((USB_DT_CONFIG << 8) | 0);
1044 /* last data packet "should" be DATA1, not DATA0 */
1045 if (udev->speed == USB_SPEED_SUPER)
1048 len = 1024 - udev->descriptor.bMaxPacketSize0;
1049 expected = -EREMOTEIO;
1051 case 14: /* short read; try to fill the last packet */
1052 req.wValue = cpu_to_le16((USB_DT_DEVICE << 8) | 0);
1053 /* device descriptor size == 18 bytes */
1054 len = udev->descriptor.bMaxPacketSize0;
1055 if (udev->speed == USB_SPEED_SUPER)
1065 expected = -EREMOTEIO;
1068 ERROR(dev, "bogus number of ctrl queue testcases!\n");
1069 context.status = -EINVAL;
1072 req.wLength = cpu_to_le16(len);
1073 urb[i] = u = simple_alloc_urb(udev, pipe, len);
1077 reqp = kmalloc(sizeof *reqp, GFP_KERNEL);
1081 reqp->number = i % NUM_SUBCASES;
1082 reqp->expected = expected;
1083 u->setup_packet = (char *) &reqp->setup;
1085 u->context = &context;
1086 u->complete = ctrl_complete;
1089 /* queue the urbs */
1091 spin_lock_irq(&context.lock);
1092 for (i = 0; i < param->sglen; i++) {
1093 context.status = usb_submit_urb(urb[i], GFP_ATOMIC);
1094 if (context.status != 0) {
1095 ERROR(dev, "can't submit urb[%d], status %d\n",
1097 context.count = context.pending;
1102 spin_unlock_irq(&context.lock);
1104 /* FIXME set timer and time out; provide a disconnect hook */
1106 /* wait for the last one to complete */
1107 if (context.pending > 0)
1108 wait_for_completion(&context.complete);
1111 for (i = 0; i < param->sglen; i++) {
1115 kfree(urb[i]->setup_packet);
1116 simple_free_urb(urb[i]);
1119 return context.status;
1124 /*-------------------------------------------------------------------------*/
1126 static void unlink1_callback(struct urb *urb)
1128 int status = urb->status;
1130 /* we "know" -EPIPE (stall) never happens */
1132 status = usb_submit_urb(urb, GFP_ATOMIC);
1134 urb->status = status;
1135 complete(urb->context);
1139 static int unlink1(struct usbtest_dev *dev, int pipe, int size, int async)
1142 struct completion completion;
1145 init_completion(&completion);
1146 urb = simple_alloc_urb(testdev_to_usbdev(dev), pipe, size);
1149 urb->context = &completion;
1150 urb->complete = unlink1_callback;
1152 /* keep the endpoint busy. there are lots of hc/hcd-internal
1153 * states, and testing should get to all of them over time.
1155 * FIXME want additional tests for when endpoint is STALLing
1156 * due to errors, or is just NAKing requests.
1158 retval = usb_submit_urb(urb, GFP_KERNEL);
1160 dev_err(&dev->intf->dev, "submit fail %d\n", retval);
1164 /* unlinking that should always work. variable delay tests more
1165 * hcd states and code paths, even with little other system load.
1167 msleep(jiffies % (2 * INTERRUPT_RATE));
1169 while (!completion_done(&completion)) {
1170 retval = usb_unlink_urb(urb);
1175 /* we can't unlink urbs while they're completing
1176 * or if they've completed, and we haven't
1177 * resubmitted. "normal" drivers would prevent
1178 * resubmission, but since we're testing unlink
1181 ERROR(dev, "unlink retry\n");
1188 dev_err(&dev->intf->dev,
1189 "unlink fail %d\n", retval);
1198 wait_for_completion(&completion);
1199 retval = urb->status;
1200 simple_free_urb(urb);
1203 return (retval == -ECONNRESET) ? 0 : retval - 1000;
1205 return (retval == -ENOENT || retval == -EPERM) ?
1209 static int unlink_simple(struct usbtest_dev *dev, int pipe, int len)
1213 /* test sync and async paths */
1214 retval = unlink1(dev, pipe, len, 1);
1216 retval = unlink1(dev, pipe, len, 0);
1220 /*-------------------------------------------------------------------------*/
1223 struct completion complete;
1230 static void unlink_queued_callback(struct urb *urb)
1232 int status = urb->status;
1233 struct queued_ctx *ctx = urb->context;
1237 if (urb == ctx->urbs[ctx->num - 4] || urb == ctx->urbs[ctx->num - 2]) {
1238 if (status == -ECONNRESET)
1240 /* What error should we report if the URB completed normally? */
1243 ctx->status = status;
1246 if (atomic_dec_and_test(&ctx->pending))
1247 complete(&ctx->complete);
1250 static int unlink_queued(struct usbtest_dev *dev, int pipe, unsigned num,
1253 struct queued_ctx ctx;
1254 struct usb_device *udev = testdev_to_usbdev(dev);
1258 int retval = -ENOMEM;
1260 init_completion(&ctx.complete);
1261 atomic_set(&ctx.pending, 1); /* One more than the actual value */
1265 buf = usb_alloc_coherent(udev, size, GFP_KERNEL, &buf_dma);
1268 memset(buf, 0, size);
1270 /* Allocate and init the urbs we'll queue */
1271 ctx.urbs = kcalloc(num, sizeof(struct urb *), GFP_KERNEL);
1274 for (i = 0; i < num; i++) {
1275 ctx.urbs[i] = usb_alloc_urb(0, GFP_KERNEL);
1278 usb_fill_bulk_urb(ctx.urbs[i], udev, pipe, buf, size,
1279 unlink_queued_callback, &ctx);
1280 ctx.urbs[i]->transfer_dma = buf_dma;
1281 ctx.urbs[i]->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
1284 /* Submit all the URBs and then unlink URBs num - 4 and num - 2. */
1285 for (i = 0; i < num; i++) {
1286 atomic_inc(&ctx.pending);
1287 retval = usb_submit_urb(ctx.urbs[i], GFP_KERNEL);
1289 dev_err(&dev->intf->dev, "submit urbs[%d] fail %d\n",
1291 atomic_dec(&ctx.pending);
1292 ctx.status = retval;
1297 usb_unlink_urb(ctx.urbs[num - 4]);
1298 usb_unlink_urb(ctx.urbs[num - 2]);
1301 usb_unlink_urb(ctx.urbs[i]);
1304 if (atomic_dec_and_test(&ctx.pending)) /* The extra count */
1305 complete(&ctx.complete);
1306 wait_for_completion(&ctx.complete);
1307 retval = ctx.status;
1310 for (i = 0; i < num; i++)
1311 usb_free_urb(ctx.urbs[i]);
1314 usb_free_coherent(udev, size, buf, buf_dma);
1318 /*-------------------------------------------------------------------------*/
1320 static int verify_not_halted(struct usbtest_dev *tdev, int ep, struct urb *urb)
1325 /* shouldn't look or act halted */
1326 retval = usb_get_status(urb->dev, USB_RECIP_ENDPOINT, ep, &status);
1328 ERROR(tdev, "ep %02x couldn't get no-halt status, %d\n",
1333 ERROR(tdev, "ep %02x bogus status: %04x != 0\n", ep, status);
1336 retval = simple_io(tdev, urb, 1, 0, 0, __func__);
1342 static int verify_halted(struct usbtest_dev *tdev, int ep, struct urb *urb)
1347 /* should look and act halted */
1348 retval = usb_get_status(urb->dev, USB_RECIP_ENDPOINT, ep, &status);
1350 ERROR(tdev, "ep %02x couldn't get halt status, %d\n",
1355 ERROR(tdev, "ep %02x bogus status: %04x != 1\n", ep, status);
1358 retval = simple_io(tdev, urb, 1, 0, -EPIPE, __func__);
1359 if (retval != -EPIPE)
1361 retval = simple_io(tdev, urb, 1, 0, -EPIPE, "verify_still_halted");
1362 if (retval != -EPIPE)
1367 static int test_halt(struct usbtest_dev *tdev, int ep, struct urb *urb)
1371 /* shouldn't look or act halted now */
1372 retval = verify_not_halted(tdev, ep, urb);
1376 /* set halt (protocol test only), verify it worked */
1377 retval = usb_control_msg(urb->dev, usb_sndctrlpipe(urb->dev, 0),
1378 USB_REQ_SET_FEATURE, USB_RECIP_ENDPOINT,
1379 USB_ENDPOINT_HALT, ep,
1380 NULL, 0, USB_CTRL_SET_TIMEOUT);
1382 ERROR(tdev, "ep %02x couldn't set halt, %d\n", ep, retval);
1385 retval = verify_halted(tdev, ep, urb);
1389 /* clear halt (tests API + protocol), verify it worked */
1390 retval = usb_clear_halt(urb->dev, urb->pipe);
1392 ERROR(tdev, "ep %02x couldn't clear halt, %d\n", ep, retval);
1395 retval = verify_not_halted(tdev, ep, urb);
1399 /* NOTE: could also verify SET_INTERFACE clear halts ... */
1404 static int halt_simple(struct usbtest_dev *dev)
1409 struct usb_device *udev = testdev_to_usbdev(dev);
1411 if (udev->speed == USB_SPEED_SUPER)
1412 urb = simple_alloc_urb(udev, 0, 1024);
1414 urb = simple_alloc_urb(udev, 0, 512);
1419 ep = usb_pipeendpoint(dev->in_pipe) | USB_DIR_IN;
1420 urb->pipe = dev->in_pipe;
1421 retval = test_halt(dev, ep, urb);
1426 if (dev->out_pipe) {
1427 ep = usb_pipeendpoint(dev->out_pipe);
1428 urb->pipe = dev->out_pipe;
1429 retval = test_halt(dev, ep, urb);
1432 simple_free_urb(urb);
1436 /*-------------------------------------------------------------------------*/
1438 /* Control OUT tests use the vendor control requests from Intel's
1439 * USB 2.0 compliance test device: write a buffer, read it back.
1441 * Intel's spec only _requires_ that it work for one packet, which
1442 * is pretty weak. Some HCDs place limits here; most devices will
1443 * need to be able to handle more than one OUT data packet. We'll
1444 * try whatever we're told to try.
1446 static int ctrl_out(struct usbtest_dev *dev,
1447 unsigned count, unsigned length, unsigned vary, unsigned offset)
1453 struct usb_device *udev;
1455 if (length < 1 || length > 0xffff || vary >= length)
1458 buf = kmalloc(length + offset, GFP_KERNEL);
1463 udev = testdev_to_usbdev(dev);
1467 /* NOTE: hardware might well act differently if we pushed it
1468 * with lots back-to-back queued requests.
1470 for (i = 0; i < count; i++) {
1471 /* write patterned data */
1472 for (j = 0; j < len; j++)
1474 retval = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1475 0x5b, USB_DIR_OUT|USB_TYPE_VENDOR,
1476 0, 0, buf, len, USB_CTRL_SET_TIMEOUT);
1477 if (retval != len) {
1480 ERROR(dev, "ctrl_out, wlen %d (expected %d)\n",
1487 /* read it back -- assuming nothing intervened!! */
1488 retval = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
1489 0x5c, USB_DIR_IN|USB_TYPE_VENDOR,
1490 0, 0, buf, len, USB_CTRL_GET_TIMEOUT);
1491 if (retval != len) {
1494 ERROR(dev, "ctrl_out, rlen %d (expected %d)\n",
1501 /* fail if we can't verify */
1502 for (j = 0; j < len; j++) {
1503 if (buf[j] != (u8) (i + j)) {
1504 ERROR(dev, "ctrl_out, byte %d is %d not %d\n",
1505 j, buf[j], (u8) i + j);
1517 /* [real world] the "zero bytes IN" case isn't really used.
1518 * hardware can easily trip up in this weird case, since its
1519 * status stage is IN, not OUT like other ep0in transfers.
1522 len = realworld ? 1 : 0;
1526 ERROR(dev, "ctrl_out %s failed, code %d, count %d\n",
1529 kfree(buf - offset);
1533 /*-------------------------------------------------------------------------*/
1535 /* ISO tests ... mimics common usage
1536 * - buffer length is split into N packets (mostly maxpacket sized)
1537 * - multi-buffers according to sglen
1540 struct iso_context {
1544 struct completion done;
1546 unsigned long errors;
1547 unsigned long packet_count;
1548 struct usbtest_dev *dev;
1551 static void iso_callback(struct urb *urb)
1553 struct iso_context *ctx = urb->context;
1555 spin_lock(&ctx->lock);
1558 ctx->packet_count += urb->number_of_packets;
1559 if (urb->error_count > 0)
1560 ctx->errors += urb->error_count;
1561 else if (urb->status != 0)
1562 ctx->errors += urb->number_of_packets;
1563 else if (urb->actual_length != urb->transfer_buffer_length)
1565 else if (check_guard_bytes(ctx->dev, urb) != 0)
1568 if (urb->status == 0 && ctx->count > (ctx->pending - 1)
1569 && !ctx->submit_error) {
1570 int status = usb_submit_urb(urb, GFP_ATOMIC);
1575 dev_err(&ctx->dev->intf->dev,
1576 "iso resubmit err %d\n",
1579 case -ENODEV: /* disconnected */
1580 case -ESHUTDOWN: /* endpoint disabled */
1581 ctx->submit_error = 1;
1587 if (ctx->pending == 0) {
1589 dev_err(&ctx->dev->intf->dev,
1590 "iso test, %lu errors out of %lu\n",
1591 ctx->errors, ctx->packet_count);
1592 complete(&ctx->done);
1595 spin_unlock(&ctx->lock);
1598 static struct urb *iso_alloc_urb(
1599 struct usb_device *udev,
1601 struct usb_endpoint_descriptor *desc,
1607 unsigned i, maxp, packets;
1609 if (bytes < 0 || !desc)
1611 maxp = 0x7ff & usb_endpoint_maxp(desc);
1612 maxp *= 1 + (0x3 & (usb_endpoint_maxp(desc) >> 11));
1613 packets = DIV_ROUND_UP(bytes, maxp);
1615 urb = usb_alloc_urb(packets, GFP_KERNEL);
1621 urb->number_of_packets = packets;
1622 urb->transfer_buffer_length = bytes;
1623 urb->transfer_buffer = usb_alloc_coherent(udev, bytes + offset,
1625 &urb->transfer_dma);
1626 if (!urb->transfer_buffer) {
1631 memset(urb->transfer_buffer, GUARD_BYTE, offset);
1632 urb->transfer_buffer += offset;
1633 urb->transfer_dma += offset;
1635 /* For inbound transfers use guard byte so that test fails if
1636 data not correctly copied */
1637 memset(urb->transfer_buffer,
1638 usb_pipein(urb->pipe) ? GUARD_BYTE : 0,
1641 for (i = 0; i < packets; i++) {
1642 /* here, only the last packet will be short */
1643 urb->iso_frame_desc[i].length = min((unsigned) bytes, maxp);
1644 bytes -= urb->iso_frame_desc[i].length;
1646 urb->iso_frame_desc[i].offset = maxp * i;
1649 urb->complete = iso_callback;
1650 /* urb->context = SET BY CALLER */
1651 urb->interval = 1 << (desc->bInterval - 1);
1652 urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
1657 test_iso_queue(struct usbtest_dev *dev, struct usbtest_param *param,
1658 int pipe, struct usb_endpoint_descriptor *desc, unsigned offset)
1660 struct iso_context context;
1661 struct usb_device *udev;
1663 unsigned long packets = 0;
1665 struct urb *urbs[10]; /* FIXME no limit */
1667 if (param->sglen > 10)
1670 memset(&context, 0, sizeof context);
1671 context.count = param->iterations * param->sglen;
1673 init_completion(&context.done);
1674 spin_lock_init(&context.lock);
1676 memset(urbs, 0, sizeof urbs);
1677 udev = testdev_to_usbdev(dev);
1678 dev_info(&dev->intf->dev,
1679 "... iso period %d %sframes, wMaxPacket %04x\n",
1680 1 << (desc->bInterval - 1),
1681 (udev->speed == USB_SPEED_HIGH) ? "micro" : "",
1682 usb_endpoint_maxp(desc));
1684 for (i = 0; i < param->sglen; i++) {
1685 urbs[i] = iso_alloc_urb(udev, pipe, desc,
1686 param->length, offset);
1691 packets += urbs[i]->number_of_packets;
1692 urbs[i]->context = &context;
1694 packets *= param->iterations;
1695 dev_info(&dev->intf->dev,
1696 "... total %lu msec (%lu packets)\n",
1697 (packets * (1 << (desc->bInterval - 1)))
1698 / ((udev->speed == USB_SPEED_HIGH) ? 8 : 1),
1701 spin_lock_irq(&context.lock);
1702 for (i = 0; i < param->sglen; i++) {
1704 status = usb_submit_urb(urbs[i], GFP_ATOMIC);
1706 ERROR(dev, "submit iso[%d], error %d\n", i, status);
1708 spin_unlock_irq(&context.lock);
1712 simple_free_urb(urbs[i]);
1715 context.submit_error = 1;
1719 spin_unlock_irq(&context.lock);
1721 wait_for_completion(&context.done);
1723 for (i = 0; i < param->sglen; i++) {
1725 simple_free_urb(urbs[i]);
1728 * Isochronous transfers are expected to fail sometimes. As an
1729 * arbitrary limit, we will report an error if any submissions
1730 * fail or if the transfer failure rate is > 10%.
1734 else if (context.submit_error)
1736 else if (context.errors > context.packet_count / 10)
1741 for (i = 0; i < param->sglen; i++) {
1743 simple_free_urb(urbs[i]);
1748 static int test_unaligned_bulk(
1749 struct usbtest_dev *tdev,
1753 unsigned transfer_flags,
1757 struct urb *urb = usbtest_alloc_urb(
1758 testdev_to_usbdev(tdev), pipe, length, transfer_flags, 1);
1763 retval = simple_io(tdev, urb, iterations, 0, 0, label);
1764 simple_free_urb(urb);
1768 /*-------------------------------------------------------------------------*/
1770 /* We only have this one interface to user space, through usbfs.
1771 * User mode code can scan usbfs to find N different devices (maybe on
1772 * different busses) to use when testing, and allocate one thread per
1773 * test. So discovery is simplified, and we have no device naming issues.
1775 * Don't use these only as stress/load tests. Use them along with with
1776 * other USB bus activity: plugging, unplugging, mousing, mp3 playback,
1777 * video capture, and so on. Run different tests at different times, in
1778 * different sequences. Nothing here should interact with other devices,
1779 * except indirectly by consuming USB bandwidth and CPU resources for test
1780 * threads and request completion. But the only way to know that for sure
1781 * is to test when HC queues are in use by many devices.
1783 * WARNING: Because usbfs grabs udev->dev.sem before calling this ioctl(),
1784 * it locks out usbcore in certain code paths. Notably, if you disconnect
1785 * the device-under-test, khubd will wait block forever waiting for the
1786 * ioctl to complete ... so that usb_disconnect() can abort the pending
1787 * urbs and then call usbtest_disconnect(). To abort a test, you're best
1788 * off just killing the userspace task and waiting for it to exit.
1792 usbtest_ioctl(struct usb_interface *intf, unsigned int code, void *buf)
1794 struct usbtest_dev *dev = usb_get_intfdata(intf);
1795 struct usb_device *udev = testdev_to_usbdev(dev);
1796 struct usbtest_param *param = buf;
1797 int retval = -EOPNOTSUPP;
1799 struct scatterlist *sg;
1800 struct usb_sg_request req;
1801 struct timeval start;
1804 /* FIXME USBDEVFS_CONNECTINFO doesn't say how fast the device is. */
1806 pattern = mod_pattern;
1808 if (code != USBTEST_REQUEST)
1811 if (param->iterations <= 0)
1814 if (mutex_lock_interruptible(&dev->lock))
1815 return -ERESTARTSYS;
1817 /* FIXME: What if a system sleep starts while a test is running? */
1819 /* some devices, like ez-usb default devices, need a non-default
1820 * altsetting to have any active endpoints. some tests change
1821 * altsettings; force a default so most tests don't need to check.
1823 if (dev->info->alt >= 0) {
1826 if (intf->altsetting->desc.bInterfaceNumber) {
1827 mutex_unlock(&dev->lock);
1830 res = set_altsetting(dev, dev->info->alt);
1833 "set altsetting to %d failed, %d\n",
1834 dev->info->alt, res);
1835 mutex_unlock(&dev->lock);
1841 * Just a bunch of test cases that every HCD is expected to handle.
1843 * Some may need specific firmware, though it'd be good to have
1844 * one firmware image to handle all the test cases.
1846 * FIXME add more tests! cancel requests, verify the data, control
1847 * queueing, concurrent read+write threads, and so on.
1849 do_gettimeofday(&start);
1850 switch (param->test_num) {
1853 dev_info(&intf->dev, "TEST 0: NOP\n");
1857 /* Simple non-queued bulk I/O tests */
1859 if (dev->out_pipe == 0)
1861 dev_info(&intf->dev,
1862 "TEST 1: write %d bytes %u times\n",
1863 param->length, param->iterations);
1864 urb = simple_alloc_urb(udev, dev->out_pipe, param->length);
1869 /* FIRMWARE: bulk sink (maybe accepts short writes) */
1870 retval = simple_io(dev, urb, param->iterations, 0, 0, "test1");
1871 simple_free_urb(urb);
1874 if (dev->in_pipe == 0)
1876 dev_info(&intf->dev,
1877 "TEST 2: read %d bytes %u times\n",
1878 param->length, param->iterations);
1879 urb = simple_alloc_urb(udev, dev->in_pipe, param->length);
1884 /* FIRMWARE: bulk source (maybe generates short writes) */
1885 retval = simple_io(dev, urb, param->iterations, 0, 0, "test2");
1886 simple_free_urb(urb);
1889 if (dev->out_pipe == 0 || param->vary == 0)
1891 dev_info(&intf->dev,
1892 "TEST 3: write/%d 0..%d bytes %u times\n",
1893 param->vary, param->length, param->iterations);
1894 urb = simple_alloc_urb(udev, dev->out_pipe, param->length);
1899 /* FIRMWARE: bulk sink (maybe accepts short writes) */
1900 retval = simple_io(dev, urb, param->iterations, param->vary,
1902 simple_free_urb(urb);
1905 if (dev->in_pipe == 0 || param->vary == 0)
1907 dev_info(&intf->dev,
1908 "TEST 4: read/%d 0..%d bytes %u times\n",
1909 param->vary, param->length, param->iterations);
1910 urb = simple_alloc_urb(udev, dev->in_pipe, param->length);
1915 /* FIRMWARE: bulk source (maybe generates short writes) */
1916 retval = simple_io(dev, urb, param->iterations, param->vary,
1918 simple_free_urb(urb);
1921 /* Queued bulk I/O tests */
1923 if (dev->out_pipe == 0 || param->sglen == 0)
1925 dev_info(&intf->dev,
1926 "TEST 5: write %d sglists %d entries of %d bytes\n",
1928 param->sglen, param->length);
1929 sg = alloc_sglist(param->sglen, param->length, 0);
1934 /* FIRMWARE: bulk sink (maybe accepts short writes) */
1935 retval = perform_sglist(dev, param->iterations, dev->out_pipe,
1936 &req, sg, param->sglen);
1937 free_sglist(sg, param->sglen);
1941 if (dev->in_pipe == 0 || param->sglen == 0)
1943 dev_info(&intf->dev,
1944 "TEST 6: read %d sglists %d entries of %d bytes\n",
1946 param->sglen, param->length);
1947 sg = alloc_sglist(param->sglen, param->length, 0);
1952 /* FIRMWARE: bulk source (maybe generates short writes) */
1953 retval = perform_sglist(dev, param->iterations, dev->in_pipe,
1954 &req, sg, param->sglen);
1955 free_sglist(sg, param->sglen);
1958 if (dev->out_pipe == 0 || param->sglen == 0 || param->vary == 0)
1960 dev_info(&intf->dev,
1961 "TEST 7: write/%d %d sglists %d entries 0..%d bytes\n",
1962 param->vary, param->iterations,
1963 param->sglen, param->length);
1964 sg = alloc_sglist(param->sglen, param->length, param->vary);
1969 /* FIRMWARE: bulk sink (maybe accepts short writes) */
1970 retval = perform_sglist(dev, param->iterations, dev->out_pipe,
1971 &req, sg, param->sglen);
1972 free_sglist(sg, param->sglen);
1975 if (dev->in_pipe == 0 || param->sglen == 0 || param->vary == 0)
1977 dev_info(&intf->dev,
1978 "TEST 8: read/%d %d sglists %d entries 0..%d bytes\n",
1979 param->vary, param->iterations,
1980 param->sglen, param->length);
1981 sg = alloc_sglist(param->sglen, param->length, param->vary);
1986 /* FIRMWARE: bulk source (maybe generates short writes) */
1987 retval = perform_sglist(dev, param->iterations, dev->in_pipe,
1988 &req, sg, param->sglen);
1989 free_sglist(sg, param->sglen);
1992 /* non-queued sanity tests for control (chapter 9 subset) */
1995 dev_info(&intf->dev,
1996 "TEST 9: ch9 (subset) control tests, %d times\n",
1998 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1999 retval = ch9_postconfig(dev);
2001 dev_err(&intf->dev, "ch9 subset failed, "
2002 "iterations left %d\n", i);
2005 /* queued control messaging */
2008 dev_info(&intf->dev,
2009 "TEST 10: queue %d control calls, %d times\n",
2012 retval = test_ctrl_queue(dev, param);
2015 /* simple non-queued unlinks (ring with one urb) */
2017 if (dev->in_pipe == 0 || !param->length)
2020 dev_info(&intf->dev, "TEST 11: unlink %d reads of %d\n",
2021 param->iterations, param->length);
2022 for (i = param->iterations; retval == 0 && i--; /* NOP */)
2023 retval = unlink_simple(dev, dev->in_pipe,
2026 dev_err(&intf->dev, "unlink reads failed %d, "
2027 "iterations left %d\n", retval, i);
2030 if (dev->out_pipe == 0 || !param->length)
2033 dev_info(&intf->dev, "TEST 12: unlink %d writes of %d\n",
2034 param->iterations, param->length);
2035 for (i = param->iterations; retval == 0 && i--; /* NOP */)
2036 retval = unlink_simple(dev, dev->out_pipe,
2039 dev_err(&intf->dev, "unlink writes failed %d, "
2040 "iterations left %d\n", retval, i);
2045 if (dev->out_pipe == 0 && dev->in_pipe == 0)
2048 dev_info(&intf->dev, "TEST 13: set/clear %d halts\n",
2050 for (i = param->iterations; retval == 0 && i--; /* NOP */)
2051 retval = halt_simple(dev);
2054 ERROR(dev, "halts failed, iterations left %d\n", i);
2057 /* control write tests */
2059 if (!dev->info->ctrl_out)
2061 dev_info(&intf->dev, "TEST 14: %d ep0out, %d..%d vary %d\n",
2063 realworld ? 1 : 0, param->length,
2065 retval = ctrl_out(dev, param->iterations,
2066 param->length, param->vary, 0);
2069 /* iso write tests */
2071 if (dev->out_iso_pipe == 0 || param->sglen == 0)
2073 dev_info(&intf->dev,
2074 "TEST 15: write %d iso, %d entries of %d bytes\n",
2076 param->sglen, param->length);
2077 /* FIRMWARE: iso sink */
2078 retval = test_iso_queue(dev, param,
2079 dev->out_iso_pipe, dev->iso_out, 0);
2082 /* iso read tests */
2084 if (dev->in_iso_pipe == 0 || param->sglen == 0)
2086 dev_info(&intf->dev,
2087 "TEST 16: read %d iso, %d entries of %d bytes\n",
2089 param->sglen, param->length);
2090 /* FIRMWARE: iso source */
2091 retval = test_iso_queue(dev, param,
2092 dev->in_iso_pipe, dev->iso_in, 0);
2095 /* FIXME scatterlist cancel (needs helper thread) */
2097 /* Tests for bulk I/O using DMA mapping by core and odd address */
2099 if (dev->out_pipe == 0)
2101 dev_info(&intf->dev,
2102 "TEST 17: write odd addr %d bytes %u times core map\n",
2103 param->length, param->iterations);
2105 retval = test_unaligned_bulk(
2107 param->length, param->iterations,
2112 if (dev->in_pipe == 0)
2114 dev_info(&intf->dev,
2115 "TEST 18: read odd addr %d bytes %u times core map\n",
2116 param->length, param->iterations);
2118 retval = test_unaligned_bulk(
2120 param->length, param->iterations,
2124 /* Tests for bulk I/O using premapped coherent buffer and odd address */
2126 if (dev->out_pipe == 0)
2128 dev_info(&intf->dev,
2129 "TEST 19: write odd addr %d bytes %u times premapped\n",
2130 param->length, param->iterations);
2132 retval = test_unaligned_bulk(
2134 param->length, param->iterations,
2135 URB_NO_TRANSFER_DMA_MAP, "test19");
2139 if (dev->in_pipe == 0)
2141 dev_info(&intf->dev,
2142 "TEST 20: read odd addr %d bytes %u times premapped\n",
2143 param->length, param->iterations);
2145 retval = test_unaligned_bulk(
2147 param->length, param->iterations,
2148 URB_NO_TRANSFER_DMA_MAP, "test20");
2151 /* control write tests with unaligned buffer */
2153 if (!dev->info->ctrl_out)
2155 dev_info(&intf->dev,
2156 "TEST 21: %d ep0out odd addr, %d..%d vary %d\n",
2158 realworld ? 1 : 0, param->length,
2160 retval = ctrl_out(dev, param->iterations,
2161 param->length, param->vary, 1);
2164 /* unaligned iso tests */
2166 if (dev->out_iso_pipe == 0 || param->sglen == 0)
2168 dev_info(&intf->dev,
2169 "TEST 22: write %d iso odd, %d entries of %d bytes\n",
2171 param->sglen, param->length);
2172 retval = test_iso_queue(dev, param,
2173 dev->out_iso_pipe, dev->iso_out, 1);
2177 if (dev->in_iso_pipe == 0 || param->sglen == 0)
2179 dev_info(&intf->dev,
2180 "TEST 23: read %d iso odd, %d entries of %d bytes\n",
2182 param->sglen, param->length);
2183 retval = test_iso_queue(dev, param,
2184 dev->in_iso_pipe, dev->iso_in, 1);
2187 /* unlink URBs from a bulk-OUT queue */
2189 if (dev->out_pipe == 0 || !param->length || param->sglen < 4)
2192 dev_info(&intf->dev, "TEST 24: unlink from %d queues of "
2193 "%d %d-byte writes\n",
2194 param->iterations, param->sglen, param->length);
2195 for (i = param->iterations; retval == 0 && i > 0; --i) {
2196 retval = unlink_queued(dev, dev->out_pipe,
2197 param->sglen, param->length);
2200 "unlink queued writes failed %d, "
2201 "iterations left %d\n", retval, i);
2208 do_gettimeofday(¶m->duration);
2209 param->duration.tv_sec -= start.tv_sec;
2210 param->duration.tv_usec -= start.tv_usec;
2211 if (param->duration.tv_usec < 0) {
2212 param->duration.tv_usec += 1000 * 1000;
2213 param->duration.tv_sec -= 1;
2215 mutex_unlock(&dev->lock);
2219 /*-------------------------------------------------------------------------*/
2221 static unsigned force_interrupt;
2222 module_param(force_interrupt, uint, 0);
2223 MODULE_PARM_DESC(force_interrupt, "0 = test default; else interrupt");
2226 static unsigned short vendor;
2227 module_param(vendor, ushort, 0);
2228 MODULE_PARM_DESC(vendor, "vendor code (from usb-if)");
2230 static unsigned short product;
2231 module_param(product, ushort, 0);
2232 MODULE_PARM_DESC(product, "product code (from vendor)");
2236 usbtest_probe(struct usb_interface *intf, const struct usb_device_id *id)
2238 struct usb_device *udev;
2239 struct usbtest_dev *dev;
2240 struct usbtest_info *info;
2241 char *rtest, *wtest;
2242 char *irtest, *iwtest;
2244 udev = interface_to_usbdev(intf);
2247 /* specify devices by module parameters? */
2248 if (id->match_flags == 0) {
2249 /* vendor match required, product match optional */
2250 if (!vendor || le16_to_cpu(udev->descriptor.idVendor) != (u16)vendor)
2252 if (product && le16_to_cpu(udev->descriptor.idProduct) != (u16)product)
2254 dev_info(&intf->dev, "matched module params, "
2255 "vend=0x%04x prod=0x%04x\n",
2256 le16_to_cpu(udev->descriptor.idVendor),
2257 le16_to_cpu(udev->descriptor.idProduct));
2261 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
2264 info = (struct usbtest_info *) id->driver_info;
2266 mutex_init(&dev->lock);
2270 /* cacheline-aligned scratch for i/o */
2271 dev->buf = kmalloc(TBUF_SIZE, GFP_KERNEL);
2272 if (dev->buf == NULL) {
2277 /* NOTE this doesn't yet test the handful of difference that are
2278 * visible with high speed interrupts: bigger maxpacket (1K) and
2279 * "high bandwidth" modes (up to 3 packets/uframe).
2282 irtest = iwtest = "";
2283 if (force_interrupt || udev->speed == USB_SPEED_LOW) {
2285 dev->in_pipe = usb_rcvintpipe(udev, info->ep_in);
2289 dev->out_pipe = usb_sndintpipe(udev, info->ep_out);
2290 wtest = " intr-out";
2293 if (override_alt >= 0 || info->autoconf) {
2296 status = get_endpoints(dev, intf);
2298 WARNING(dev, "couldn't get endpoints, %d\n",
2304 /* may find bulk or ISO pipes */
2307 dev->in_pipe = usb_rcvbulkpipe(udev,
2310 dev->out_pipe = usb_sndbulkpipe(udev,
2316 wtest = " bulk-out";
2317 if (dev->in_iso_pipe)
2319 if (dev->out_iso_pipe)
2320 iwtest = " iso-out";
2323 usb_set_intfdata(intf, dev);
2324 dev_info(&intf->dev, "%s\n", info->name);
2325 dev_info(&intf->dev, "%s {control%s%s%s%s%s} tests%s\n",
2326 usb_speed_string(udev->speed),
2327 info->ctrl_out ? " in/out" : "",
2330 info->alt >= 0 ? " (+alt)" : "");
2334 static int usbtest_suspend(struct usb_interface *intf, pm_message_t message)
2339 static int usbtest_resume(struct usb_interface *intf)
2345 static void usbtest_disconnect(struct usb_interface *intf)
2347 struct usbtest_dev *dev = usb_get_intfdata(intf);
2349 usb_set_intfdata(intf, NULL);
2350 dev_dbg(&intf->dev, "disconnect\n");
2354 /* Basic testing only needs a device that can source or sink bulk traffic.
2355 * Any device can test control transfers (default with GENERIC binding).
2357 * Several entries work with the default EP0 implementation that's built
2358 * into EZ-USB chips. There's a default vendor ID which can be overridden
2359 * by (very) small config EEPROMS, but otherwise all these devices act
2360 * identically until firmware is loaded: only EP0 works. It turns out
2361 * to be easy to make other endpoints work, without modifying that EP0
2362 * behavior. For now, we expect that kind of firmware.
2365 /* an21xx or fx versions of ez-usb */
2366 static struct usbtest_info ez1_info = {
2367 .name = "EZ-USB device",
2373 /* fx2 version of ez-usb */
2374 static struct usbtest_info ez2_info = {
2375 .name = "FX2 device",
2381 /* ezusb family device with dedicated usb test firmware,
2383 static struct usbtest_info fw_info = {
2384 .name = "usb test device",
2388 .autoconf = 1, /* iso and ctrl_out need autoconf */
2390 .iso = 1, /* iso_ep's are #8 in/out */
2393 /* peripheral running Linux and 'zero.c' test firmware, or
2394 * its user-mode cousin. different versions of this use
2395 * different hardware with the same vendor/product codes.
2396 * host side MUST rely on the endpoint descriptors.
2398 static struct usbtest_info gz_info = {
2399 .name = "Linux gadget zero",
2406 static struct usbtest_info um_info = {
2407 .name = "Linux user mode test driver",
2412 static struct usbtest_info um2_info = {
2413 .name = "Linux user mode ISO test driver",
2420 /* this is a nice source of high speed bulk data;
2421 * uses an FX2, with firmware provided in the device
2423 static struct usbtest_info ibot2_info = {
2424 .name = "iBOT2 webcam",
2431 /* we can use any device to test control traffic */
2432 static struct usbtest_info generic_info = {
2433 .name = "Generic USB device",
2439 static const struct usb_device_id id_table[] = {
2441 /*-------------------------------------------------------------*/
2443 /* EZ-USB devices which download firmware to replace (or in our
2444 * case augment) the default device implementation.
2447 /* generic EZ-USB FX controller */
2448 { USB_DEVICE(0x0547, 0x2235),
2449 .driver_info = (unsigned long) &ez1_info,
2452 /* CY3671 development board with EZ-USB FX */
2453 { USB_DEVICE(0x0547, 0x0080),
2454 .driver_info = (unsigned long) &ez1_info,
2457 /* generic EZ-USB FX2 controller (or development board) */
2458 { USB_DEVICE(0x04b4, 0x8613),
2459 .driver_info = (unsigned long) &ez2_info,
2462 /* re-enumerated usb test device firmware */
2463 { USB_DEVICE(0xfff0, 0xfff0),
2464 .driver_info = (unsigned long) &fw_info,
2467 /* "Gadget Zero" firmware runs under Linux */
2468 { USB_DEVICE(0x0525, 0xa4a0),
2469 .driver_info = (unsigned long) &gz_info,
2472 /* so does a user-mode variant */
2473 { USB_DEVICE(0x0525, 0xa4a4),
2474 .driver_info = (unsigned long) &um_info,
2477 /* ... and a user-mode variant that talks iso */
2478 { USB_DEVICE(0x0525, 0xa4a3),
2479 .driver_info = (unsigned long) &um2_info,
2483 /* Keyspan 19qi uses an21xx (original EZ-USB) */
2484 /* this does not coexist with the real Keyspan 19qi driver! */
2485 { USB_DEVICE(0x06cd, 0x010b),
2486 .driver_info = (unsigned long) &ez1_info,
2490 /*-------------------------------------------------------------*/
2493 /* iBOT2 makes a nice source of high speed bulk-in data */
2494 /* this does not coexist with a real iBOT2 driver! */
2495 { USB_DEVICE(0x0b62, 0x0059),
2496 .driver_info = (unsigned long) &ibot2_info,
2500 /*-------------------------------------------------------------*/
2503 /* module params can specify devices to use for control tests */
2504 { .driver_info = (unsigned long) &generic_info, },
2507 /*-------------------------------------------------------------*/
2511 MODULE_DEVICE_TABLE(usb, id_table);
2513 static struct usb_driver usbtest_driver = {
2515 .id_table = id_table,
2516 .probe = usbtest_probe,
2517 .unlocked_ioctl = usbtest_ioctl,
2518 .disconnect = usbtest_disconnect,
2519 .suspend = usbtest_suspend,
2520 .resume = usbtest_resume,
2523 /*-------------------------------------------------------------------------*/
2525 static int __init usbtest_init(void)
2529 pr_debug("params: vend=0x%04x prod=0x%04x\n", vendor, product);
2531 return usb_register(&usbtest_driver);
2533 module_init(usbtest_init);
2535 static void __exit usbtest_exit(void)
2537 usb_deregister(&usbtest_driver);
2539 module_exit(usbtest_exit);
2541 MODULE_DESCRIPTION("USB Core/HCD Testing Driver");
2542 MODULE_LICENSE("GPL");