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>
10 #include <linux/timer.h>
11 #include <linux/usb.h>
13 #define SIMPLE_IO_TIMEOUT 10000 /* in milliseconds */
15 /*-------------------------------------------------------------------------*/
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");
21 /*-------------------------------------------------------------------------*/
23 /* FIXME make these public somewhere; usbdevfs.h? */
24 struct usbtest_param {
26 unsigned test_num; /* 0..(TEST_CASES-1) */
33 struct timeval duration;
35 #define USBTEST_REQUEST _IOWR('U', 100, struct usbtest_param)
37 /*-------------------------------------------------------------------------*/
39 #define GENERIC /* let probe() bind using module params */
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
45 //#define IBOT2 /* grab iBOT2 webcams */
46 //#define KEYSPAN_19Qi /* grab un-renumerated serial adapter */
48 /*-------------------------------------------------------------------------*/
52 u8 ep_in; /* bulk/intr source */
53 u8 ep_out; /* bulk/intr sink */
56 unsigned iso:1; /* try iso in/out */
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.
67 struct usb_interface *intf;
68 struct usbtest_info *info;
73 struct usb_endpoint_descriptor *iso_in, *iso_out;
80 static struct usb_device *testdev_to_usbdev(struct usbtest_dev *test)
82 return interface_to_usbdev(test->intf);
85 /* set up all urbs so they can be used with either bulk or interrupt */
86 #define INTERRUPT_RATE 1 /* msec/transfer */
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)
93 #define GUARD_BYTE 0xA5
95 /*-------------------------------------------------------------------------*/
98 get_endpoints(struct usbtest_dev *dev, struct usb_interface *intf)
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;
106 for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
110 iso_in = iso_out = NULL;
111 alt = intf->altsetting + tmp;
113 if (override_alt >= 0 &&
114 override_alt != alt->desc.bAlternateSetting)
117 /* take the first altsetting with in-bulk + out-bulk;
118 * ignore other endpoints and altsettings.
120 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
121 struct usb_host_endpoint *e;
123 e = alt->endpoint + ep;
124 switch (e->desc.bmAttributes) {
125 case USB_ENDPOINT_XFER_BULK:
127 case USB_ENDPOINT_XFER_ISOC:
134 if (usb_endpoint_dir_in(&e->desc)) {
143 if (usb_endpoint_dir_in(&e->desc)) {
151 if ((in && out) || iso_in || iso_out)
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);
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);
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);
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);
189 /*-------------------------------------------------------------------------*/
191 /* Support for testing basic non-queued I/O streams.
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.
198 static void simple_callback(struct urb *urb)
200 complete(urb->context);
203 static struct urb *usbtest_alloc_urb(
204 struct usb_device *udev,
207 unsigned transfer_flags,
212 urb = usb_alloc_urb(0, GFP_KERNEL);
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)
219 urb->transfer_flags = transfer_flags;
220 if (usb_pipein(pipe))
221 urb->transfer_flags |= URB_SHORT_NOT_OK;
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);
227 urb->transfer_buffer = kmalloc(bytes + offset, GFP_KERNEL);
229 if (!urb->transfer_buffer) {
234 /* To test unaligned transfers add an offset and fill the
235 unused memory with a guard value */
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;
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,
251 static struct urb *simple_alloc_urb(
252 struct usb_device *udev,
256 return usbtest_alloc_urb(udev, pipe, bytes, URB_NO_TRANSFER_DMA_MAP, 0);
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)");
264 static inline void simple_fill_buf(struct urb *urb)
267 u8 *buf = urb->transfer_buffer;
268 unsigned len = urb->transfer_buffer_length;
277 for (i = 0; i < len; i++)
278 *buf++ = (u8) (i % 63);
283 static inline unsigned long buffer_offset(void *buf)
285 return (unsigned long)buf & (ARCH_KMALLOC_MINALIGN - 1);
288 static int check_guard_bytes(struct usbtest_dev *tdev, struct urb *urb)
290 u8 *buf = urb->transfer_buffer;
291 u8 *guard = buf - buffer_offset(buf);
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);
304 static int simple_check_buf(struct usbtest_dev *tdev, struct urb *urb)
308 u8 *buf = urb->transfer_buffer;
309 unsigned len = urb->actual_length;
311 int ret = check_guard_bytes(tdev, urb);
315 for (i = 0; i < len; i++, buf++) {
317 /* all-zeroes has no synchronization issues */
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.
329 /* always fail unsupported patterns */
334 if (*buf == expected)
336 ERROR(tdev, "buf[%d] = %d (not %d)\n", i, *buf, expected);
342 static void simple_free_urb(struct urb *urb)
344 unsigned long offset = buffer_offset(urb->transfer_buffer);
346 if (urb->transfer_flags & URB_NO_TRANSFER_DMA_MAP)
349 urb->transfer_buffer_length + offset,
350 urb->transfer_buffer - offset,
351 urb->transfer_dma - offset);
353 kfree(urb->transfer_buffer - offset);
357 static int simple_io(
358 struct usbtest_dev *tdev,
366 struct usb_device *udev = urb->dev;
367 int max = urb->transfer_buffer_length;
368 struct completion completion;
370 unsigned long expire;
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;
379 retval = usb_submit_urb(urb, GFP_KERNEL);
383 expire = msecs_to_jiffies(SIMPLE_IO_TIMEOUT);
384 if (!wait_for_completion_timeout(&completion, expire)) {
386 retval = (urb->status == -ENOENT ?
387 -ETIMEDOUT : urb->status);
389 retval = urb->status;
393 if (retval == 0 && usb_pipein(urb->pipe))
394 retval = simple_check_buf(tdev, urb);
397 int len = urb->transfer_buffer_length;
402 len = (vary < max) ? vary : max;
403 urb->transfer_buffer_length = len;
406 /* FIXME if endpoint halted, clear halt (and log) */
408 urb->transfer_buffer_length = max;
410 if (expected != retval)
412 "%s failed, iterations left %d, status %d (not %d)\n",
413 label, iterations, retval, expected);
418 /*-------------------------------------------------------------------------*/
420 /* We use scatterlist primitives to test queued I/O.
421 * Yes, this also tests the scatterlist primitives.
424 static void free_sglist(struct scatterlist *sg, int nents)
430 for (i = 0; i < nents; i++) {
431 if (!sg_page(&sg[i]))
433 kfree(sg_virt(&sg[i]));
438 static struct scatterlist *
439 alloc_sglist(int nents, int max, int vary)
441 struct scatterlist *sg;
448 sg = kmalloc_array(nents, sizeof *sg, GFP_KERNEL);
451 sg_init_table(sg, nents);
453 for (i = 0; i < nents; i++) {
457 buf = kzalloc(size, GFP_KERNEL);
463 /* kmalloc pages are always physically contiguous! */
464 sg_set_buf(&sg[i], buf, size);
471 for (j = 0; j < size; j++)
472 *buf++ = (u8) (j % 63);
480 size = (vary < max) ? vary : max;
487 static void sg_timeout(unsigned long _req)
489 struct usb_sg_request *req = (struct usb_sg_request *) _req;
491 req->status = -ETIMEDOUT;
495 static int perform_sglist(
496 struct usbtest_dev *tdev,
499 struct usb_sg_request *req,
500 struct scatterlist *sg,
504 struct usb_device *udev = testdev_to_usbdev(tdev);
506 struct timer_list sg_timer;
508 setup_timer_on_stack(&sg_timer, sg_timeout, (unsigned long) req);
510 while (retval == 0 && iterations-- > 0) {
511 retval = usb_sg_init(req, udev, pipe,
512 (udev->speed == USB_SPEED_HIGH)
513 ? (INTERRUPT_RATE << 3)
515 sg, nents, 0, GFP_KERNEL);
519 mod_timer(&sg_timer, jiffies +
520 msecs_to_jiffies(SIMPLE_IO_TIMEOUT));
522 del_timer_sync(&sg_timer);
523 retval = req->status;
525 /* FIXME check resulting data pattern */
527 /* FIXME if endpoint halted, clear halt (and log) */
530 /* FIXME for unlink or fault handling tests, don't report
531 * failure if retval is as we expected ...
534 ERROR(tdev, "perform_sglist failed, "
535 "iterations left %d, status %d\n",
541 /*-------------------------------------------------------------------------*/
543 /* unqueued control message testing
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.
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).
555 static unsigned realworld = 1;
556 module_param(realworld, uint, 0);
557 MODULE_PARM_DESC(realworld, "clear to demand stricter spec compliance");
559 static int get_altsetting(struct usbtest_dev *dev)
561 struct usb_interface *iface = dev->intf;
562 struct usb_device *udev = interface_to_usbdev(iface);
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);
580 static int set_altsetting(struct usbtest_dev *dev, int alternate)
582 struct usb_interface *iface = dev->intf;
583 struct usb_device *udev;
585 if (alternate < 0 || alternate >= 256)
588 udev = interface_to_usbdev(iface);
589 return usb_set_interface(udev,
590 iface->altsetting[0].desc.bInterfaceNumber,
594 static int is_good_config(struct usbtest_dev *tdev, int len)
596 struct usb_config_descriptor *config;
598 if (len < sizeof *config)
600 config = (struct usb_config_descriptor *) tdev->buf;
602 switch (config->bDescriptorType) {
604 case USB_DT_OTHER_SPEED_CONFIG:
605 if (config->bLength != 9) {
606 ERROR(tdev, "bogus config descriptor length\n");
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");
614 if (config->bmAttributes & 0x1f) { /* reserved == 0 */
615 ERROR(tdev, "reserved config bits set\n");
623 if (le16_to_cpu(config->wTotalLength) == len) /* read it all */
625 if (le16_to_cpu(config->wTotalLength) >= TBUF_SIZE) /* max partial read */
627 ERROR(tdev, "bogus config descriptor read size\n");
631 /* sanity test for standard requests working with usb_control_mesg() and some
632 * of the utility functions which use it.
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.
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.
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.
646 static int ch9_postconfig(struct usbtest_dev *dev)
648 struct usb_interface *iface = dev->intf;
649 struct usb_device *udev = interface_to_usbdev(iface);
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.
655 for (i = 0; i < iface->num_altsetting; i++) {
657 /* 9.2.3 constrains the range here */
658 alt = iface->altsetting[i].desc.bAlternateSetting;
659 if (alt < 0 || alt >= iface->num_altsetting) {
661 "invalid alt [%d].bAltSetting = %d\n",
665 /* [real world] get/set unimplemented if there's only one */
666 if (realworld && iface->num_altsetting == 1)
669 /* [9.4.10] set_interface */
670 retval = set_altsetting(dev, alt);
672 dev_err(&iface->dev, "can't set_interface = %d, %d\n",
677 /* [9.4.4] get_interface always works */
678 retval = get_altsetting(dev);
680 dev_err(&iface->dev, "get alt should be %d, was %d\n",
682 return (retval < 0) ? retval : -EDOM;
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;
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.
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;
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;
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)) {
720 "config [%d] descriptor --> %d\n",
722 return (retval < 0) ? retval : -EDOM;
725 /* FIXME cross-checking udev->config[i] to make sure usbcore
726 * parsed it right (etc) would be good testing paranoia
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;
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) {
741 "hs dev qualifier --> %d\n",
743 return (retval < 0) ? retval : -EDOM;
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;
750 d = (struct usb_qualifier_descriptor *) dev->buf;
752 /* might not have [9.6.2] any other-speed configs [9.6.4] */
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)) {
761 "other speed config --> %d\n",
763 return (retval < 0) ? retval : -EDOM;
768 /* FIXME fetch strings from at least the device descriptor */
770 /* [9.4.5] get_status always works */
771 retval = usb_get_status(udev, USB_RECIP_DEVICE, 0, dev->buf);
773 dev_err(&iface->dev, "get dev status --> %d\n", retval);
774 return (retval < 0) ? retval : -EDOM;
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
781 retval = usb_get_status(udev, USB_RECIP_INTERFACE,
782 iface->altsetting[0].desc.bInterfaceNumber, dev->buf);
784 dev_err(&iface->dev, "get interface status --> %d\n", retval);
785 return (retval < 0) ? retval : -EDOM;
787 /* FIXME get status for each endpoint in the interface */
792 /*-------------------------------------------------------------------------*/
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
805 struct usbtest_dev *dev;
806 struct completion complete;
811 struct usbtest_param *param;
815 #define NUM_SUBCASES 15 /* how many test subcases here? */
818 struct usb_ctrlrequest setup;
823 static void ctrl_complete(struct urb *urb)
825 struct ctrl_ctx *ctx = urb->context;
826 struct usb_ctrlrequest *reqp;
827 struct subcase *subcase;
828 int status = urb->status;
830 reqp = (struct usb_ctrlrequest *)urb->setup_packet;
831 subcase = container_of(reqp, struct subcase, setup);
833 spin_lock(&ctx->lock);
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).
841 if (subcase->number > 0) {
842 if ((subcase->number - ctx->last) != 1) {
844 "subcase %d completed out of order, last %d\n",
845 subcase->number, ctx->last);
847 ctx->last = subcase->number;
851 ctx->last = subcase->number;
853 /* succeed or fault in only one way? */
854 if (status == subcase->expected)
857 /* async unlink for cleanup? */
858 else if (status != -ECONNRESET) {
860 /* some faults are allowed, not required */
861 if (subcase->expected > 0 && (
862 ((status == -subcase->expected /* happened */
863 || status == 0)))) /* didn't */
865 /* sometimes more than one fault is allowed */
866 else if (subcase->number == 12 && status == -EPIPE)
869 ERROR(ctx->dev, "subtest %d error, status %d\n",
870 subcase->number, status);
873 /* unexpected status codes mean errors; ideally, in hardware */
876 if (ctx->status == 0) {
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,
885 urb->transfer_buffer_length);
887 /* FIXME this "unlink everything" exit route should
888 * be a separate test case.
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];
897 if (u == urb || !u->dev)
899 spin_unlock(&ctx->lock);
900 status = usb_unlink_urb(u);
901 spin_lock(&ctx->lock);
908 ERROR(ctx->dev, "urb unlink --> %d\n",
912 status = ctx->status;
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);
921 "can't resubmit ctrl %02x.%02x, err %d\n",
922 reqp->bRequestType, reqp->bRequest, status);
929 /* signal completion when nothing's queued */
930 if (ctx->pending == 0)
931 complete(&ctx->complete);
932 spin_unlock(&ctx->lock);
936 test_ctrl_queue(struct usbtest_dev *dev, struct usbtest_param *param)
938 struct usb_device *udev = testdev_to_usbdev(dev);
940 struct ctrl_ctx context;
943 if (param->sglen == 0 || param->iterations > UINT_MAX / param->sglen)
946 spin_lock_init(&context.lock);
948 init_completion(&context.complete);
949 context.count = param->sglen * param->iterations;
951 context.status = -ENOMEM;
952 context.param = param;
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.
959 urb = kcalloc(param->sglen, sizeof(struct urb *), GFP_KERNEL);
962 for (i = 0; i < param->sglen; i++) {
963 int pipe = usb_rcvctrlpipe(udev, 0);
966 struct usb_ctrlrequest req;
967 struct subcase *reqp;
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
975 /* requests here are mostly expected to succeed on any
976 * device, but some are chosen to trigger protocol stalls
979 memset(&req, 0, sizeof req);
980 req.bRequest = USB_REQ_GET_DESCRIPTOR;
981 req.bRequestType = USB_DIR_IN|USB_RECIP_DEVICE;
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);
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);
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 */
999 case 3: /* get interface status */
1000 req.bRequest = USB_REQ_GET_STATUS;
1001 req.bRequestType = USB_DIR_IN|USB_RECIP_INTERFACE;
1005 case 4: /* get device status */
1006 req.bRequest = USB_REQ_GET_STATUS;
1007 req.bRequestType = USB_DIR_IN|USB_RECIP_DEVICE;
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)
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);
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);
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!) */
1035 pipe = usb_sndctrlpipe(udev, 0);
1038 case 9: /* get endpoint status */
1039 req.bRequest = USB_REQ_GET_STATUS;
1040 req.bRequestType = USB_DIR_IN|USB_RECIP_ENDPOINT;
1044 case 10: /* trigger short read (EREMOTEIO) */
1045 req.wValue = cpu_to_le16((USB_DT_CONFIG << 8) | 0);
1047 expected = -EREMOTEIO;
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);
1053 len = sizeof(struct usb_interface_descriptor);
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 */
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)
1070 len = 1024 - udev->descriptor.bMaxPacketSize0;
1071 expected = -EREMOTEIO;
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)
1087 expected = -EREMOTEIO;
1090 ERROR(dev, "bogus number of ctrl queue testcases!\n");
1091 context.status = -EINVAL;
1094 req.wLength = cpu_to_le16(len);
1095 urb[i] = u = simple_alloc_urb(udev, pipe, len);
1099 reqp = kmalloc(sizeof *reqp, GFP_KERNEL);
1103 reqp->number = i % NUM_SUBCASES;
1104 reqp->expected = expected;
1105 u->setup_packet = (char *) &reqp->setup;
1107 u->context = &context;
1108 u->complete = ctrl_complete;
1111 /* queue the urbs */
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",
1119 context.count = context.pending;
1124 spin_unlock_irq(&context.lock);
1126 /* FIXME set timer and time out; provide a disconnect hook */
1128 /* wait for the last one to complete */
1129 if (context.pending > 0)
1130 wait_for_completion(&context.complete);
1133 for (i = 0; i < param->sglen; i++) {
1137 kfree(urb[i]->setup_packet);
1138 simple_free_urb(urb[i]);
1141 return context.status;
1146 /*-------------------------------------------------------------------------*/
1148 static void unlink1_callback(struct urb *urb)
1150 int status = urb->status;
1152 /* we "know" -EPIPE (stall) never happens */
1154 status = usb_submit_urb(urb, GFP_ATOMIC);
1156 urb->status = status;
1157 complete(urb->context);
1161 static int unlink1(struct usbtest_dev *dev, int pipe, int size, int async)
1164 struct completion completion;
1167 init_completion(&completion);
1168 urb = simple_alloc_urb(testdev_to_usbdev(dev), pipe, size);
1171 urb->context = &completion;
1172 urb->complete = unlink1_callback;
1174 if (usb_pipeout(urb->pipe)) {
1175 simple_fill_buf(urb);
1176 urb->transfer_flags |= URB_ZERO_PACKET;
1179 /* keep the endpoint busy. there are lots of hc/hcd-internal
1180 * states, and testing should get to all of them over time.
1182 * FIXME want additional tests for when endpoint is STALLing
1183 * due to errors, or is just NAKing requests.
1185 retval = usb_submit_urb(urb, GFP_KERNEL);
1187 dev_err(&dev->intf->dev, "submit fail %d\n", retval);
1191 /* unlinking that should always work. variable delay tests more
1192 * hcd states and code paths, even with little other system load.
1194 msleep(jiffies % (2 * INTERRUPT_RATE));
1196 while (!completion_done(&completion)) {
1197 retval = usb_unlink_urb(urb);
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
1208 ERROR(dev, "unlink retry\n");
1215 dev_err(&dev->intf->dev,
1216 "unlink fail %d\n", retval);
1225 wait_for_completion(&completion);
1226 retval = urb->status;
1227 simple_free_urb(urb);
1230 return (retval == -ECONNRESET) ? 0 : retval - 1000;
1232 return (retval == -ENOENT || retval == -EPERM) ?
1236 static int unlink_simple(struct usbtest_dev *dev, int pipe, int len)
1240 /* test sync and async paths */
1241 retval = unlink1(dev, pipe, len, 1);
1243 retval = unlink1(dev, pipe, len, 0);
1247 /*-------------------------------------------------------------------------*/
1250 struct completion complete;
1257 static void unlink_queued_callback(struct urb *urb)
1259 int status = urb->status;
1260 struct queued_ctx *ctx = urb->context;
1264 if (urb == ctx->urbs[ctx->num - 4] || urb == ctx->urbs[ctx->num - 2]) {
1265 if (status == -ECONNRESET)
1267 /* What error should we report if the URB completed normally? */
1270 ctx->status = status;
1273 if (atomic_dec_and_test(&ctx->pending))
1274 complete(&ctx->complete);
1277 static int unlink_queued(struct usbtest_dev *dev, int pipe, unsigned num,
1280 struct queued_ctx ctx;
1281 struct usb_device *udev = testdev_to_usbdev(dev);
1285 int retval = -ENOMEM;
1287 init_completion(&ctx.complete);
1288 atomic_set(&ctx.pending, 1); /* One more than the actual value */
1292 buf = usb_alloc_coherent(udev, size, GFP_KERNEL, &buf_dma);
1295 memset(buf, 0, size);
1297 /* Allocate and init the urbs we'll queue */
1298 ctx.urbs = kcalloc(num, sizeof(struct urb *), GFP_KERNEL);
1301 for (i = 0; i < num; i++) {
1302 ctx.urbs[i] = usb_alloc_urb(0, GFP_KERNEL);
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;
1310 if (usb_pipeout(ctx.urbs[i]->pipe)) {
1311 simple_fill_buf(ctx.urbs[i]);
1312 ctx.urbs[i]->transfer_flags |= URB_ZERO_PACKET;
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);
1321 dev_err(&dev->intf->dev, "submit urbs[%d] fail %d\n",
1323 atomic_dec(&ctx.pending);
1324 ctx.status = retval;
1329 usb_unlink_urb(ctx.urbs[num - 4]);
1330 usb_unlink_urb(ctx.urbs[num - 2]);
1333 usb_unlink_urb(ctx.urbs[i]);
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;
1342 for (i = 0; i < num; i++)
1343 usb_free_urb(ctx.urbs[i]);
1346 usb_free_coherent(udev, size, buf, buf_dma);
1350 /*-------------------------------------------------------------------------*/
1352 static int verify_not_halted(struct usbtest_dev *tdev, int ep, struct urb *urb)
1357 /* shouldn't look or act halted */
1358 retval = usb_get_status(urb->dev, USB_RECIP_ENDPOINT, ep, &status);
1360 ERROR(tdev, "ep %02x couldn't get no-halt status, %d\n",
1365 ERROR(tdev, "ep %02x bogus status: %04x != 0\n", ep, status);
1368 retval = simple_io(tdev, urb, 1, 0, 0, __func__);
1374 static int verify_halted(struct usbtest_dev *tdev, int ep, struct urb *urb)
1379 /* should look and act halted */
1380 retval = usb_get_status(urb->dev, USB_RECIP_ENDPOINT, ep, &status);
1382 ERROR(tdev, "ep %02x couldn't get halt status, %d\n",
1386 le16_to_cpus(&status);
1388 ERROR(tdev, "ep %02x bogus status: %04x != 1\n", ep, status);
1391 retval = simple_io(tdev, urb, 1, 0, -EPIPE, __func__);
1392 if (retval != -EPIPE)
1394 retval = simple_io(tdev, urb, 1, 0, -EPIPE, "verify_still_halted");
1395 if (retval != -EPIPE)
1400 static int test_halt(struct usbtest_dev *tdev, int ep, struct urb *urb)
1404 /* shouldn't look or act halted now */
1405 retval = verify_not_halted(tdev, ep, urb);
1409 /* set halt (protocol test only), verify it worked */
1410 retval = usb_control_msg(urb->dev, usb_sndctrlpipe(urb->dev, 0),
1411 USB_REQ_SET_FEATURE, USB_RECIP_ENDPOINT,
1412 USB_ENDPOINT_HALT, ep,
1413 NULL, 0, USB_CTRL_SET_TIMEOUT);
1415 ERROR(tdev, "ep %02x couldn't set halt, %d\n", ep, retval);
1418 retval = verify_halted(tdev, ep, urb);
1422 /* clear halt (tests API + protocol), verify it worked */
1423 retval = usb_clear_halt(urb->dev, urb->pipe);
1425 ERROR(tdev, "ep %02x couldn't clear halt, %d\n", ep, retval);
1428 retval = verify_not_halted(tdev, ep, urb);
1432 /* NOTE: could also verify SET_INTERFACE clear halts ... */
1437 static int halt_simple(struct usbtest_dev *dev)
1442 struct usb_device *udev = testdev_to_usbdev(dev);
1444 if (udev->speed == USB_SPEED_SUPER)
1445 urb = simple_alloc_urb(udev, 0, 1024);
1447 urb = simple_alloc_urb(udev, 0, 512);
1452 ep = usb_pipeendpoint(dev->in_pipe) | USB_DIR_IN;
1453 urb->pipe = dev->in_pipe;
1454 retval = test_halt(dev, ep, urb);
1459 if (dev->out_pipe) {
1460 ep = usb_pipeendpoint(dev->out_pipe);
1461 urb->pipe = dev->out_pipe;
1462 retval = test_halt(dev, ep, urb);
1465 simple_free_urb(urb);
1469 /*-------------------------------------------------------------------------*/
1471 /* Control OUT tests use the vendor control requests from Intel's
1472 * USB 2.0 compliance test device: write a buffer, read it back.
1474 * Intel's spec only _requires_ that it work for one packet, which
1475 * is pretty weak. Some HCDs place limits here; most devices will
1476 * need to be able to handle more than one OUT data packet. We'll
1477 * try whatever we're told to try.
1479 static int ctrl_out(struct usbtest_dev *dev,
1480 unsigned count, unsigned length, unsigned vary, unsigned offset)
1486 struct usb_device *udev;
1488 if (length < 1 || length > 0xffff || vary >= length)
1491 buf = kmalloc(length + offset, GFP_KERNEL);
1496 udev = testdev_to_usbdev(dev);
1500 /* NOTE: hardware might well act differently if we pushed it
1501 * with lots back-to-back queued requests.
1503 for (i = 0; i < count; i++) {
1504 /* write patterned data */
1505 for (j = 0; j < len; j++)
1507 retval = usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
1508 0x5b, USB_DIR_OUT|USB_TYPE_VENDOR,
1509 0, 0, buf, len, USB_CTRL_SET_TIMEOUT);
1510 if (retval != len) {
1513 ERROR(dev, "ctrl_out, wlen %d (expected %d)\n",
1520 /* read it back -- assuming nothing intervened!! */
1521 retval = usb_control_msg(udev, usb_rcvctrlpipe(udev, 0),
1522 0x5c, USB_DIR_IN|USB_TYPE_VENDOR,
1523 0, 0, buf, len, USB_CTRL_GET_TIMEOUT);
1524 if (retval != len) {
1527 ERROR(dev, "ctrl_out, rlen %d (expected %d)\n",
1534 /* fail if we can't verify */
1535 for (j = 0; j < len; j++) {
1536 if (buf[j] != (u8) (i + j)) {
1537 ERROR(dev, "ctrl_out, byte %d is %d not %d\n",
1538 j, buf[j], (u8) i + j);
1550 /* [real world] the "zero bytes IN" case isn't really used.
1551 * hardware can easily trip up in this weird case, since its
1552 * status stage is IN, not OUT like other ep0in transfers.
1555 len = realworld ? 1 : 0;
1559 ERROR(dev, "ctrl_out %s failed, code %d, count %d\n",
1562 kfree(buf - offset);
1566 /*-------------------------------------------------------------------------*/
1568 /* ISO tests ... mimics common usage
1569 * - buffer length is split into N packets (mostly maxpacket sized)
1570 * - multi-buffers according to sglen
1573 struct iso_context {
1577 struct completion done;
1579 unsigned long errors;
1580 unsigned long packet_count;
1581 struct usbtest_dev *dev;
1584 static void iso_callback(struct urb *urb)
1586 struct iso_context *ctx = urb->context;
1588 spin_lock(&ctx->lock);
1591 ctx->packet_count += urb->number_of_packets;
1592 if (urb->error_count > 0)
1593 ctx->errors += urb->error_count;
1594 else if (urb->status != 0)
1595 ctx->errors += urb->number_of_packets;
1596 else if (urb->actual_length != urb->transfer_buffer_length)
1598 else if (check_guard_bytes(ctx->dev, urb) != 0)
1601 if (urb->status == 0 && ctx->count > (ctx->pending - 1)
1602 && !ctx->submit_error) {
1603 int status = usb_submit_urb(urb, GFP_ATOMIC);
1608 dev_err(&ctx->dev->intf->dev,
1609 "iso resubmit err %d\n",
1612 case -ENODEV: /* disconnected */
1613 case -ESHUTDOWN: /* endpoint disabled */
1614 ctx->submit_error = 1;
1620 if (ctx->pending == 0) {
1622 dev_err(&ctx->dev->intf->dev,
1623 "iso test, %lu errors out of %lu\n",
1624 ctx->errors, ctx->packet_count);
1625 complete(&ctx->done);
1628 spin_unlock(&ctx->lock);
1631 static struct urb *iso_alloc_urb(
1632 struct usb_device *udev,
1634 struct usb_endpoint_descriptor *desc,
1640 unsigned i, maxp, packets;
1642 if (bytes < 0 || !desc)
1644 maxp = 0x7ff & usb_endpoint_maxp(desc);
1645 maxp *= 1 + (0x3 & (usb_endpoint_maxp(desc) >> 11));
1646 packets = DIV_ROUND_UP(bytes, maxp);
1648 urb = usb_alloc_urb(packets, GFP_KERNEL);
1654 urb->number_of_packets = packets;
1655 urb->transfer_buffer_length = bytes;
1656 urb->transfer_buffer = usb_alloc_coherent(udev, bytes + offset,
1658 &urb->transfer_dma);
1659 if (!urb->transfer_buffer) {
1664 memset(urb->transfer_buffer, GUARD_BYTE, offset);
1665 urb->transfer_buffer += offset;
1666 urb->transfer_dma += offset;
1668 /* For inbound transfers use guard byte so that test fails if
1669 data not correctly copied */
1670 memset(urb->transfer_buffer,
1671 usb_pipein(urb->pipe) ? GUARD_BYTE : 0,
1674 for (i = 0; i < packets; i++) {
1675 /* here, only the last packet will be short */
1676 urb->iso_frame_desc[i].length = min((unsigned) bytes, maxp);
1677 bytes -= urb->iso_frame_desc[i].length;
1679 urb->iso_frame_desc[i].offset = maxp * i;
1682 urb->complete = iso_callback;
1683 /* urb->context = SET BY CALLER */
1684 urb->interval = 1 << (desc->bInterval - 1);
1685 urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
1690 test_iso_queue(struct usbtest_dev *dev, struct usbtest_param *param,
1691 int pipe, struct usb_endpoint_descriptor *desc, unsigned offset)
1693 struct iso_context context;
1694 struct usb_device *udev;
1696 unsigned long packets = 0;
1698 struct urb *urbs[10]; /* FIXME no limit */
1700 if (param->sglen > 10)
1703 memset(&context, 0, sizeof context);
1704 context.count = param->iterations * param->sglen;
1706 init_completion(&context.done);
1707 spin_lock_init(&context.lock);
1709 memset(urbs, 0, sizeof urbs);
1710 udev = testdev_to_usbdev(dev);
1711 dev_info(&dev->intf->dev,
1712 "... iso period %d %sframes, wMaxPacket %04x\n",
1713 1 << (desc->bInterval - 1),
1714 (udev->speed == USB_SPEED_HIGH) ? "micro" : "",
1715 usb_endpoint_maxp(desc));
1717 for (i = 0; i < param->sglen; i++) {
1718 urbs[i] = iso_alloc_urb(udev, pipe, desc,
1719 param->length, offset);
1724 packets += urbs[i]->number_of_packets;
1725 urbs[i]->context = &context;
1727 packets *= param->iterations;
1728 dev_info(&dev->intf->dev,
1729 "... total %lu msec (%lu packets)\n",
1730 (packets * (1 << (desc->bInterval - 1)))
1731 / ((udev->speed == USB_SPEED_HIGH) ? 8 : 1),
1734 spin_lock_irq(&context.lock);
1735 for (i = 0; i < param->sglen; i++) {
1737 status = usb_submit_urb(urbs[i], GFP_ATOMIC);
1739 ERROR(dev, "submit iso[%d], error %d\n", i, status);
1741 spin_unlock_irq(&context.lock);
1745 simple_free_urb(urbs[i]);
1748 context.submit_error = 1;
1752 spin_unlock_irq(&context.lock);
1754 wait_for_completion(&context.done);
1756 for (i = 0; i < param->sglen; i++) {
1758 simple_free_urb(urbs[i]);
1761 * Isochronous transfers are expected to fail sometimes. As an
1762 * arbitrary limit, we will report an error if any submissions
1763 * fail or if the transfer failure rate is > 10%.
1767 else if (context.submit_error)
1769 else if (context.errors > context.packet_count / 10)
1774 for (i = 0; i < param->sglen; i++) {
1776 simple_free_urb(urbs[i]);
1781 static int test_unaligned_bulk(
1782 struct usbtest_dev *tdev,
1786 unsigned transfer_flags,
1790 struct urb *urb = usbtest_alloc_urb(
1791 testdev_to_usbdev(tdev), pipe, length, transfer_flags, 1);
1796 retval = simple_io(tdev, urb, iterations, 0, 0, label);
1797 simple_free_urb(urb);
1801 /*-------------------------------------------------------------------------*/
1803 /* We only have this one interface to user space, through usbfs.
1804 * User mode code can scan usbfs to find N different devices (maybe on
1805 * different busses) to use when testing, and allocate one thread per
1806 * test. So discovery is simplified, and we have no device naming issues.
1808 * Don't use these only as stress/load tests. Use them along with with
1809 * other USB bus activity: plugging, unplugging, mousing, mp3 playback,
1810 * video capture, and so on. Run different tests at different times, in
1811 * different sequences. Nothing here should interact with other devices,
1812 * except indirectly by consuming USB bandwidth and CPU resources for test
1813 * threads and request completion. But the only way to know that for sure
1814 * is to test when HC queues are in use by many devices.
1816 * WARNING: Because usbfs grabs udev->dev.sem before calling this ioctl(),
1817 * it locks out usbcore in certain code paths. Notably, if you disconnect
1818 * the device-under-test, khubd will wait block forever waiting for the
1819 * ioctl to complete ... so that usb_disconnect() can abort the pending
1820 * urbs and then call usbtest_disconnect(). To abort a test, you're best
1821 * off just killing the userspace task and waiting for it to exit.
1825 usbtest_ioctl(struct usb_interface *intf, unsigned int code, void *buf)
1827 struct usbtest_dev *dev = usb_get_intfdata(intf);
1828 struct usb_device *udev = testdev_to_usbdev(dev);
1829 struct usbtest_param *param = buf;
1830 int retval = -EOPNOTSUPP;
1832 struct scatterlist *sg;
1833 struct usb_sg_request req;
1834 struct timeval start;
1837 /* FIXME USBDEVFS_CONNECTINFO doesn't say how fast the device is. */
1839 pattern = mod_pattern;
1841 if (code != USBTEST_REQUEST)
1844 if (param->iterations <= 0)
1847 if (mutex_lock_interruptible(&dev->lock))
1848 return -ERESTARTSYS;
1850 /* FIXME: What if a system sleep starts while a test is running? */
1852 /* some devices, like ez-usb default devices, need a non-default
1853 * altsetting to have any active endpoints. some tests change
1854 * altsettings; force a default so most tests don't need to check.
1856 if (dev->info->alt >= 0) {
1859 if (intf->altsetting->desc.bInterfaceNumber) {
1860 mutex_unlock(&dev->lock);
1863 res = set_altsetting(dev, dev->info->alt);
1866 "set altsetting to %d failed, %d\n",
1867 dev->info->alt, res);
1868 mutex_unlock(&dev->lock);
1874 * Just a bunch of test cases that every HCD is expected to handle.
1876 * Some may need specific firmware, though it'd be good to have
1877 * one firmware image to handle all the test cases.
1879 * FIXME add more tests! cancel requests, verify the data, control
1880 * queueing, concurrent read+write threads, and so on.
1882 do_gettimeofday(&start);
1883 switch (param->test_num) {
1886 dev_info(&intf->dev, "TEST 0: NOP\n");
1890 /* Simple non-queued bulk I/O tests */
1892 if (dev->out_pipe == 0)
1894 dev_info(&intf->dev,
1895 "TEST 1: write %d bytes %u times\n",
1896 param->length, param->iterations);
1897 urb = simple_alloc_urb(udev, dev->out_pipe, param->length);
1902 /* FIRMWARE: bulk sink (maybe accepts short writes) */
1903 retval = simple_io(dev, urb, param->iterations, 0, 0, "test1");
1904 simple_free_urb(urb);
1907 if (dev->in_pipe == 0)
1909 dev_info(&intf->dev,
1910 "TEST 2: read %d bytes %u times\n",
1911 param->length, param->iterations);
1912 urb = simple_alloc_urb(udev, dev->in_pipe, param->length);
1917 /* FIRMWARE: bulk source (maybe generates short writes) */
1918 retval = simple_io(dev, urb, param->iterations, 0, 0, "test2");
1919 simple_free_urb(urb);
1922 if (dev->out_pipe == 0 || param->vary == 0)
1924 dev_info(&intf->dev,
1925 "TEST 3: write/%d 0..%d bytes %u times\n",
1926 param->vary, param->length, param->iterations);
1927 urb = simple_alloc_urb(udev, dev->out_pipe, param->length);
1932 /* FIRMWARE: bulk sink (maybe accepts short writes) */
1933 retval = simple_io(dev, urb, param->iterations, param->vary,
1935 simple_free_urb(urb);
1938 if (dev->in_pipe == 0 || param->vary == 0)
1940 dev_info(&intf->dev,
1941 "TEST 4: read/%d 0..%d bytes %u times\n",
1942 param->vary, param->length, param->iterations);
1943 urb = simple_alloc_urb(udev, dev->in_pipe, param->length);
1948 /* FIRMWARE: bulk source (maybe generates short writes) */
1949 retval = simple_io(dev, urb, param->iterations, param->vary,
1951 simple_free_urb(urb);
1954 /* Queued bulk I/O tests */
1956 if (dev->out_pipe == 0 || param->sglen == 0)
1958 dev_info(&intf->dev,
1959 "TEST 5: write %d sglists %d entries of %d bytes\n",
1961 param->sglen, param->length);
1962 sg = alloc_sglist(param->sglen, param->length, 0);
1967 /* FIRMWARE: bulk sink (maybe accepts short writes) */
1968 retval = perform_sglist(dev, param->iterations, dev->out_pipe,
1969 &req, sg, param->sglen);
1970 free_sglist(sg, param->sglen);
1974 if (dev->in_pipe == 0 || param->sglen == 0)
1976 dev_info(&intf->dev,
1977 "TEST 6: read %d sglists %d entries of %d bytes\n",
1979 param->sglen, param->length);
1980 sg = alloc_sglist(param->sglen, param->length, 0);
1985 /* FIRMWARE: bulk source (maybe generates short writes) */
1986 retval = perform_sglist(dev, param->iterations, dev->in_pipe,
1987 &req, sg, param->sglen);
1988 free_sglist(sg, param->sglen);
1991 if (dev->out_pipe == 0 || param->sglen == 0 || param->vary == 0)
1993 dev_info(&intf->dev,
1994 "TEST 7: write/%d %d sglists %d entries 0..%d bytes\n",
1995 param->vary, param->iterations,
1996 param->sglen, param->length);
1997 sg = alloc_sglist(param->sglen, param->length, param->vary);
2002 /* FIRMWARE: bulk sink (maybe accepts short writes) */
2003 retval = perform_sglist(dev, param->iterations, dev->out_pipe,
2004 &req, sg, param->sglen);
2005 free_sglist(sg, param->sglen);
2008 if (dev->in_pipe == 0 || param->sglen == 0 || param->vary == 0)
2010 dev_info(&intf->dev,
2011 "TEST 8: read/%d %d sglists %d entries 0..%d bytes\n",
2012 param->vary, param->iterations,
2013 param->sglen, param->length);
2014 sg = alloc_sglist(param->sglen, param->length, param->vary);
2019 /* FIRMWARE: bulk source (maybe generates short writes) */
2020 retval = perform_sglist(dev, param->iterations, dev->in_pipe,
2021 &req, sg, param->sglen);
2022 free_sglist(sg, param->sglen);
2025 /* non-queued sanity tests for control (chapter 9 subset) */
2028 dev_info(&intf->dev,
2029 "TEST 9: ch9 (subset) control tests, %d times\n",
2031 for (i = param->iterations; retval == 0 && i--; /* NOP */)
2032 retval = ch9_postconfig(dev);
2034 dev_err(&intf->dev, "ch9 subset failed, "
2035 "iterations left %d\n", i);
2038 /* queued control messaging */
2041 dev_info(&intf->dev,
2042 "TEST 10: queue %d control calls, %d times\n",
2045 retval = test_ctrl_queue(dev, param);
2048 /* simple non-queued unlinks (ring with one urb) */
2050 if (dev->in_pipe == 0 || !param->length)
2053 dev_info(&intf->dev, "TEST 11: unlink %d reads of %d\n",
2054 param->iterations, param->length);
2055 for (i = param->iterations; retval == 0 && i--; /* NOP */)
2056 retval = unlink_simple(dev, dev->in_pipe,
2059 dev_err(&intf->dev, "unlink reads failed %d, "
2060 "iterations left %d\n", retval, i);
2063 if (dev->out_pipe == 0 || !param->length)
2066 dev_info(&intf->dev, "TEST 12: unlink %d writes of %d\n",
2067 param->iterations, param->length);
2068 for (i = param->iterations; retval == 0 && i--; /* NOP */)
2069 retval = unlink_simple(dev, dev->out_pipe,
2072 dev_err(&intf->dev, "unlink writes failed %d, "
2073 "iterations left %d\n", retval, i);
2078 if (dev->out_pipe == 0 && dev->in_pipe == 0)
2081 dev_info(&intf->dev, "TEST 13: set/clear %d halts\n",
2083 for (i = param->iterations; retval == 0 && i--; /* NOP */)
2084 retval = halt_simple(dev);
2087 ERROR(dev, "halts failed, iterations left %d\n", i);
2090 /* control write tests */
2092 if (!dev->info->ctrl_out)
2094 dev_info(&intf->dev, "TEST 14: %d ep0out, %d..%d vary %d\n",
2096 realworld ? 1 : 0, param->length,
2098 retval = ctrl_out(dev, param->iterations,
2099 param->length, param->vary, 0);
2102 /* iso write tests */
2104 if (dev->out_iso_pipe == 0 || param->sglen == 0)
2106 dev_info(&intf->dev,
2107 "TEST 15: write %d iso, %d entries of %d bytes\n",
2109 param->sglen, param->length);
2110 /* FIRMWARE: iso sink */
2111 retval = test_iso_queue(dev, param,
2112 dev->out_iso_pipe, dev->iso_out, 0);
2115 /* iso read tests */
2117 if (dev->in_iso_pipe == 0 || param->sglen == 0)
2119 dev_info(&intf->dev,
2120 "TEST 16: read %d iso, %d entries of %d bytes\n",
2122 param->sglen, param->length);
2123 /* FIRMWARE: iso source */
2124 retval = test_iso_queue(dev, param,
2125 dev->in_iso_pipe, dev->iso_in, 0);
2128 /* FIXME scatterlist cancel (needs helper thread) */
2130 /* Tests for bulk I/O using DMA mapping by core and odd address */
2132 if (dev->out_pipe == 0)
2134 dev_info(&intf->dev,
2135 "TEST 17: write odd addr %d bytes %u times core map\n",
2136 param->length, param->iterations);
2138 retval = test_unaligned_bulk(
2140 param->length, param->iterations,
2145 if (dev->in_pipe == 0)
2147 dev_info(&intf->dev,
2148 "TEST 18: read odd addr %d bytes %u times core map\n",
2149 param->length, param->iterations);
2151 retval = test_unaligned_bulk(
2153 param->length, param->iterations,
2157 /* Tests for bulk I/O using premapped coherent buffer and odd address */
2159 if (dev->out_pipe == 0)
2161 dev_info(&intf->dev,
2162 "TEST 19: write odd addr %d bytes %u times premapped\n",
2163 param->length, param->iterations);
2165 retval = test_unaligned_bulk(
2167 param->length, param->iterations,
2168 URB_NO_TRANSFER_DMA_MAP, "test19");
2172 if (dev->in_pipe == 0)
2174 dev_info(&intf->dev,
2175 "TEST 20: read odd addr %d bytes %u times premapped\n",
2176 param->length, param->iterations);
2178 retval = test_unaligned_bulk(
2180 param->length, param->iterations,
2181 URB_NO_TRANSFER_DMA_MAP, "test20");
2184 /* control write tests with unaligned buffer */
2186 if (!dev->info->ctrl_out)
2188 dev_info(&intf->dev,
2189 "TEST 21: %d ep0out odd addr, %d..%d vary %d\n",
2191 realworld ? 1 : 0, param->length,
2193 retval = ctrl_out(dev, param->iterations,
2194 param->length, param->vary, 1);
2197 /* unaligned iso tests */
2199 if (dev->out_iso_pipe == 0 || param->sglen == 0)
2201 dev_info(&intf->dev,
2202 "TEST 22: write %d iso odd, %d entries of %d bytes\n",
2204 param->sglen, param->length);
2205 retval = test_iso_queue(dev, param,
2206 dev->out_iso_pipe, dev->iso_out, 1);
2210 if (dev->in_iso_pipe == 0 || param->sglen == 0)
2212 dev_info(&intf->dev,
2213 "TEST 23: read %d iso odd, %d entries of %d bytes\n",
2215 param->sglen, param->length);
2216 retval = test_iso_queue(dev, param,
2217 dev->in_iso_pipe, dev->iso_in, 1);
2220 /* unlink URBs from a bulk-OUT queue */
2222 if (dev->out_pipe == 0 || !param->length || param->sglen < 4)
2225 dev_info(&intf->dev, "TEST 24: unlink from %d queues of "
2226 "%d %d-byte writes\n",
2227 param->iterations, param->sglen, param->length);
2228 for (i = param->iterations; retval == 0 && i > 0; --i) {
2229 retval = unlink_queued(dev, dev->out_pipe,
2230 param->sglen, param->length);
2233 "unlink queued writes failed %d, "
2234 "iterations left %d\n", retval, i);
2241 do_gettimeofday(¶m->duration);
2242 param->duration.tv_sec -= start.tv_sec;
2243 param->duration.tv_usec -= start.tv_usec;
2244 if (param->duration.tv_usec < 0) {
2245 param->duration.tv_usec += 1000 * 1000;
2246 param->duration.tv_sec -= 1;
2248 mutex_unlock(&dev->lock);
2252 /*-------------------------------------------------------------------------*/
2254 static unsigned force_interrupt;
2255 module_param(force_interrupt, uint, 0);
2256 MODULE_PARM_DESC(force_interrupt, "0 = test default; else interrupt");
2259 static unsigned short vendor;
2260 module_param(vendor, ushort, 0);
2261 MODULE_PARM_DESC(vendor, "vendor code (from usb-if)");
2263 static unsigned short product;
2264 module_param(product, ushort, 0);
2265 MODULE_PARM_DESC(product, "product code (from vendor)");
2269 usbtest_probe(struct usb_interface *intf, const struct usb_device_id *id)
2271 struct usb_device *udev;
2272 struct usbtest_dev *dev;
2273 struct usbtest_info *info;
2274 char *rtest, *wtest;
2275 char *irtest, *iwtest;
2277 udev = interface_to_usbdev(intf);
2280 /* specify devices by module parameters? */
2281 if (id->match_flags == 0) {
2282 /* vendor match required, product match optional */
2283 if (!vendor || le16_to_cpu(udev->descriptor.idVendor) != (u16)vendor)
2285 if (product && le16_to_cpu(udev->descriptor.idProduct) != (u16)product)
2287 dev_info(&intf->dev, "matched module params, "
2288 "vend=0x%04x prod=0x%04x\n",
2289 le16_to_cpu(udev->descriptor.idVendor),
2290 le16_to_cpu(udev->descriptor.idProduct));
2294 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
2297 info = (struct usbtest_info *) id->driver_info;
2299 mutex_init(&dev->lock);
2303 /* cacheline-aligned scratch for i/o */
2304 dev->buf = kmalloc(TBUF_SIZE, GFP_KERNEL);
2305 if (dev->buf == NULL) {
2310 /* NOTE this doesn't yet test the handful of difference that are
2311 * visible with high speed interrupts: bigger maxpacket (1K) and
2312 * "high bandwidth" modes (up to 3 packets/uframe).
2315 irtest = iwtest = "";
2316 if (force_interrupt || udev->speed == USB_SPEED_LOW) {
2318 dev->in_pipe = usb_rcvintpipe(udev, info->ep_in);
2322 dev->out_pipe = usb_sndintpipe(udev, info->ep_out);
2323 wtest = " intr-out";
2326 if (override_alt >= 0 || info->autoconf) {
2329 status = get_endpoints(dev, intf);
2331 WARNING(dev, "couldn't get endpoints, %d\n",
2337 /* may find bulk or ISO pipes */
2340 dev->in_pipe = usb_rcvbulkpipe(udev,
2343 dev->out_pipe = usb_sndbulkpipe(udev,
2349 wtest = " bulk-out";
2350 if (dev->in_iso_pipe)
2352 if (dev->out_iso_pipe)
2353 iwtest = " iso-out";
2356 usb_set_intfdata(intf, dev);
2357 dev_info(&intf->dev, "%s\n", info->name);
2358 dev_info(&intf->dev, "%s {control%s%s%s%s%s} tests%s\n",
2359 usb_speed_string(udev->speed),
2360 info->ctrl_out ? " in/out" : "",
2363 info->alt >= 0 ? " (+alt)" : "");
2367 static int usbtest_suspend(struct usb_interface *intf, pm_message_t message)
2372 static int usbtest_resume(struct usb_interface *intf)
2378 static void usbtest_disconnect(struct usb_interface *intf)
2380 struct usbtest_dev *dev = usb_get_intfdata(intf);
2382 usb_set_intfdata(intf, NULL);
2383 dev_dbg(&intf->dev, "disconnect\n");
2387 /* Basic testing only needs a device that can source or sink bulk traffic.
2388 * Any device can test control transfers (default with GENERIC binding).
2390 * Several entries work with the default EP0 implementation that's built
2391 * into EZ-USB chips. There's a default vendor ID which can be overridden
2392 * by (very) small config EEPROMS, but otherwise all these devices act
2393 * identically until firmware is loaded: only EP0 works. It turns out
2394 * to be easy to make other endpoints work, without modifying that EP0
2395 * behavior. For now, we expect that kind of firmware.
2398 /* an21xx or fx versions of ez-usb */
2399 static struct usbtest_info ez1_info = {
2400 .name = "EZ-USB device",
2406 /* fx2 version of ez-usb */
2407 static struct usbtest_info ez2_info = {
2408 .name = "FX2 device",
2414 /* ezusb family device with dedicated usb test firmware,
2416 static struct usbtest_info fw_info = {
2417 .name = "usb test device",
2421 .autoconf = 1, /* iso and ctrl_out need autoconf */
2423 .iso = 1, /* iso_ep's are #8 in/out */
2426 /* peripheral running Linux and 'zero.c' test firmware, or
2427 * its user-mode cousin. different versions of this use
2428 * different hardware with the same vendor/product codes.
2429 * host side MUST rely on the endpoint descriptors.
2431 static struct usbtest_info gz_info = {
2432 .name = "Linux gadget zero",
2439 static struct usbtest_info um_info = {
2440 .name = "Linux user mode test driver",
2445 static struct usbtest_info um2_info = {
2446 .name = "Linux user mode ISO test driver",
2453 /* this is a nice source of high speed bulk data;
2454 * uses an FX2, with firmware provided in the device
2456 static struct usbtest_info ibot2_info = {
2457 .name = "iBOT2 webcam",
2464 /* we can use any device to test control traffic */
2465 static struct usbtest_info generic_info = {
2466 .name = "Generic USB device",
2472 static const struct usb_device_id id_table[] = {
2474 /*-------------------------------------------------------------*/
2476 /* EZ-USB devices which download firmware to replace (or in our
2477 * case augment) the default device implementation.
2480 /* generic EZ-USB FX controller */
2481 { USB_DEVICE(0x0547, 0x2235),
2482 .driver_info = (unsigned long) &ez1_info,
2485 /* CY3671 development board with EZ-USB FX */
2486 { USB_DEVICE(0x0547, 0x0080),
2487 .driver_info = (unsigned long) &ez1_info,
2490 /* generic EZ-USB FX2 controller (or development board) */
2491 { USB_DEVICE(0x04b4, 0x8613),
2492 .driver_info = (unsigned long) &ez2_info,
2495 /* re-enumerated usb test device firmware */
2496 { USB_DEVICE(0xfff0, 0xfff0),
2497 .driver_info = (unsigned long) &fw_info,
2500 /* "Gadget Zero" firmware runs under Linux */
2501 { USB_DEVICE(0x0525, 0xa4a0),
2502 .driver_info = (unsigned long) &gz_info,
2505 /* so does a user-mode variant */
2506 { USB_DEVICE(0x0525, 0xa4a4),
2507 .driver_info = (unsigned long) &um_info,
2510 /* ... and a user-mode variant that talks iso */
2511 { USB_DEVICE(0x0525, 0xa4a3),
2512 .driver_info = (unsigned long) &um2_info,
2516 /* Keyspan 19qi uses an21xx (original EZ-USB) */
2517 /* this does not coexist with the real Keyspan 19qi driver! */
2518 { USB_DEVICE(0x06cd, 0x010b),
2519 .driver_info = (unsigned long) &ez1_info,
2523 /*-------------------------------------------------------------*/
2526 /* iBOT2 makes a nice source of high speed bulk-in data */
2527 /* this does not coexist with a real iBOT2 driver! */
2528 { USB_DEVICE(0x0b62, 0x0059),
2529 .driver_info = (unsigned long) &ibot2_info,
2533 /*-------------------------------------------------------------*/
2536 /* module params can specify devices to use for control tests */
2537 { .driver_info = (unsigned long) &generic_info, },
2540 /*-------------------------------------------------------------*/
2544 MODULE_DEVICE_TABLE(usb, id_table);
2546 static struct usb_driver usbtest_driver = {
2548 .id_table = id_table,
2549 .probe = usbtest_probe,
2550 .unlocked_ioctl = usbtest_ioctl,
2551 .disconnect = usbtest_disconnect,
2552 .suspend = usbtest_suspend,
2553 .resume = usbtest_resume,
2556 /*-------------------------------------------------------------------------*/
2558 static int __init usbtest_init(void)
2562 pr_debug("params: vend=0x%04x prod=0x%04x\n", vendor, product);
2564 return usb_register(&usbtest_driver);
2566 module_init(usbtest_init);
2568 static void __exit usbtest_exit(void)
2570 usb_deregister(&usbtest_driver);
2572 module_exit(usbtest_exit);
2574 MODULE_DESCRIPTION("USB Core/HCD Testing Driver");
2575 MODULE_LICENSE("GPL");