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 // FIXME make these public somewhere; usbdevfs.h?
18 struct usbtest_param {
20 unsigned test_num; /* 0..(TEST_CASES-1) */
27 struct timeval duration;
29 #define USBTEST_REQUEST _IOWR('U', 100, struct usbtest_param)
31 /*-------------------------------------------------------------------------*/
33 #define GENERIC /* let probe() bind using module params */
35 /* Some devices that can be used for testing will have "real" drivers.
36 * Entries for those need to be enabled here by hand, after disabling
39 //#define IBOT2 /* grab iBOT2 webcams */
40 //#define KEYSPAN_19Qi /* grab un-renumerated serial adapter */
42 /*-------------------------------------------------------------------------*/
46 u8 ep_in; /* bulk/intr source */
47 u8 ep_out; /* bulk/intr sink */
48 unsigned autoconf : 1;
49 unsigned ctrl_out : 1;
50 unsigned iso : 1; /* try iso in/out */
54 /* this is accessed only through usbfs ioctl calls.
55 * one ioctl to issue a test ... one lock per device.
56 * tests create other threads if they need them.
57 * urbs and buffers are allocated dynamically,
58 * and data generated deterministically.
61 struct usb_interface *intf;
62 struct usbtest_info *info;
67 struct usb_endpoint_descriptor *iso_in, *iso_out;
74 static struct usb_device *testdev_to_usbdev (struct usbtest_dev *test)
76 return interface_to_usbdev (test->intf);
79 /* set up all urbs so they can be used with either bulk or interrupt */
80 #define INTERRUPT_RATE 1 /* msec/transfer */
82 #define ERROR(tdev, fmt, args...) \
83 dev_err(&(tdev)->intf->dev , fmt , ## args)
84 #define WARNING(tdev, fmt, args...) \
85 dev_warn(&(tdev)->intf->dev , fmt , ## args)
87 /*-------------------------------------------------------------------------*/
90 get_endpoints (struct usbtest_dev *dev, struct usb_interface *intf)
93 struct usb_host_interface *alt;
94 struct usb_host_endpoint *in, *out;
95 struct usb_host_endpoint *iso_in, *iso_out;
96 struct usb_device *udev;
98 for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
102 iso_in = iso_out = NULL;
103 alt = intf->altsetting + tmp;
105 /* take the first altsetting with in-bulk + out-bulk;
106 * ignore other endpoints and altsetttings.
108 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
109 struct usb_host_endpoint *e;
111 e = alt->endpoint + ep;
112 switch (e->desc.bmAttributes) {
113 case USB_ENDPOINT_XFER_BULK:
115 case USB_ENDPOINT_XFER_ISOC:
122 if (usb_endpoint_dir_in(&e->desc)) {
131 if (usb_endpoint_dir_in(&e->desc)) {
139 if ((in && out) || (iso_in && iso_out))
145 udev = testdev_to_usbdev (dev);
146 if (alt->desc.bAlternateSetting != 0) {
147 tmp = usb_set_interface (udev,
148 alt->desc.bInterfaceNumber,
149 alt->desc.bAlternateSetting);
155 dev->in_pipe = usb_rcvbulkpipe (udev,
156 in->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
157 dev->out_pipe = usb_sndbulkpipe (udev,
158 out->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
161 dev->iso_in = &iso_in->desc;
162 dev->in_iso_pipe = usb_rcvisocpipe (udev,
163 iso_in->desc.bEndpointAddress
164 & USB_ENDPOINT_NUMBER_MASK);
165 dev->iso_out = &iso_out->desc;
166 dev->out_iso_pipe = usb_sndisocpipe (udev,
167 iso_out->desc.bEndpointAddress
168 & USB_ENDPOINT_NUMBER_MASK);
173 /*-------------------------------------------------------------------------*/
175 /* Support for testing basic non-queued I/O streams.
177 * These just package urbs as requests that can be easily canceled.
178 * Each urb's data buffer is dynamically allocated; callers can fill
179 * them with non-zero test data (or test for it) when appropriate.
182 static void simple_callback (struct urb *urb)
184 complete(urb->context);
187 static struct urb *simple_alloc_urb (
188 struct usb_device *udev,
195 urb = usb_alloc_urb (0, GFP_KERNEL);
198 usb_fill_bulk_urb (urb, udev, pipe, NULL, bytes, simple_callback, NULL);
199 urb->interval = (udev->speed == USB_SPEED_HIGH)
200 ? (INTERRUPT_RATE << 3)
202 urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
203 if (usb_pipein (pipe))
204 urb->transfer_flags |= URB_SHORT_NOT_OK;
205 urb->transfer_buffer = usb_alloc_coherent (udev, bytes, GFP_KERNEL,
207 if (!urb->transfer_buffer) {
211 memset (urb->transfer_buffer, 0, bytes);
215 static unsigned pattern = 0;
216 static unsigned mod_pattern;
217 module_param_named(pattern, mod_pattern, uint, S_IRUGO | S_IWUSR);
218 MODULE_PARM_DESC(mod_pattern, "i/o pattern (0 == zeroes)");
220 static inline void simple_fill_buf (struct urb *urb)
223 u8 *buf = urb->transfer_buffer;
224 unsigned len = urb->transfer_buffer_length;
230 memset (buf, 0, len);
233 for (i = 0; i < len; i++)
234 *buf++ = (u8) (i % 63);
239 static inline int simple_check_buf(struct usbtest_dev *tdev, struct urb *urb)
243 u8 *buf = urb->transfer_buffer;
244 unsigned len = urb->actual_length;
246 for (i = 0; i < len; i++, buf++) {
248 /* all-zeroes has no synchronization issues */
252 /* mod63 stays in sync with short-terminated transfers,
253 * or otherwise when host and gadget agree on how large
254 * each usb transfer request should be. resync is done
255 * with set_interface or set_config.
260 /* always fail unsupported patterns */
265 if (*buf == expected)
267 ERROR(tdev, "buf[%d] = %d (not %d)\n", i, *buf, expected);
273 static void simple_free_urb (struct urb *urb)
275 usb_free_coherent(urb->dev, urb->transfer_buffer_length,
276 urb->transfer_buffer, urb->transfer_dma);
280 static int simple_io (
281 struct usbtest_dev *tdev,
289 struct usb_device *udev = urb->dev;
290 int max = urb->transfer_buffer_length;
291 struct completion completion;
294 urb->context = &completion;
295 while (retval == 0 && iterations-- > 0) {
296 init_completion (&completion);
297 if (usb_pipeout (urb->pipe))
298 simple_fill_buf (urb);
299 if ((retval = usb_submit_urb (urb, GFP_KERNEL)) != 0)
302 /* NOTE: no timeouts; can't be broken out of by interrupt */
303 wait_for_completion (&completion);
304 retval = urb->status;
306 if (retval == 0 && usb_pipein (urb->pipe))
307 retval = simple_check_buf(tdev, urb);
310 int len = urb->transfer_buffer_length;
315 len = (vary < max) ? vary : max;
316 urb->transfer_buffer_length = len;
319 /* FIXME if endpoint halted, clear halt (and log) */
321 urb->transfer_buffer_length = max;
323 if (expected != retval)
325 "%s failed, iterations left %d, status %d (not %d)\n",
326 label, iterations, retval, expected);
331 /*-------------------------------------------------------------------------*/
333 /* We use scatterlist primitives to test queued I/O.
334 * Yes, this also tests the scatterlist primitives.
337 static void free_sglist (struct scatterlist *sg, int nents)
343 for (i = 0; i < nents; i++) {
344 if (!sg_page(&sg[i]))
346 kfree (sg_virt(&sg[i]));
351 static struct scatterlist *
352 alloc_sglist (int nents, int max, int vary)
354 struct scatterlist *sg;
358 sg = kmalloc (nents * sizeof *sg, GFP_KERNEL);
361 sg_init_table(sg, nents);
363 for (i = 0; i < nents; i++) {
367 buf = kzalloc (size, GFP_KERNEL);
373 /* kmalloc pages are always physically contiguous! */
374 sg_set_buf(&sg[i], buf, size);
381 for (j = 0; j < size; j++)
382 *buf++ = (u8) (j % 63);
390 size = (vary < max) ? vary : max;
397 static int perform_sglist (
398 struct usbtest_dev *tdev,
401 struct usb_sg_request *req,
402 struct scatterlist *sg,
406 struct usb_device *udev = testdev_to_usbdev(tdev);
409 while (retval == 0 && iterations-- > 0) {
410 retval = usb_sg_init (req, udev, pipe,
411 (udev->speed == USB_SPEED_HIGH)
412 ? (INTERRUPT_RATE << 3)
414 sg, nents, 0, GFP_KERNEL);
419 retval = req->status;
421 /* FIXME check resulting data pattern */
423 /* FIXME if endpoint halted, clear halt (and log) */
426 // FIXME for unlink or fault handling tests, don't report
427 // failure if retval is as we expected ...
430 ERROR(tdev, "perform_sglist failed, "
431 "iterations left %d, status %d\n",
437 /*-------------------------------------------------------------------------*/
439 /* unqueued control message testing
441 * there's a nice set of device functional requirements in chapter 9 of the
442 * usb 2.0 spec, which we can apply to ANY device, even ones that don't use
443 * special test firmware.
445 * we know the device is configured (or suspended) by the time it's visible
446 * through usbfs. we can't change that, so we won't test enumeration (which
447 * worked 'well enough' to get here, this time), power management (ditto),
448 * or remote wakeup (which needs human interaction).
451 static unsigned realworld = 1;
452 module_param (realworld, uint, 0);
453 MODULE_PARM_DESC (realworld, "clear to demand stricter spec compliance");
455 static int get_altsetting (struct usbtest_dev *dev)
457 struct usb_interface *iface = dev->intf;
458 struct usb_device *udev = interface_to_usbdev (iface);
461 retval = usb_control_msg (udev, usb_rcvctrlpipe (udev, 0),
462 USB_REQ_GET_INTERFACE, USB_DIR_IN|USB_RECIP_INTERFACE,
463 0, iface->altsetting [0].desc.bInterfaceNumber,
464 dev->buf, 1, USB_CTRL_GET_TIMEOUT);
476 static int set_altsetting (struct usbtest_dev *dev, int alternate)
478 struct usb_interface *iface = dev->intf;
479 struct usb_device *udev;
481 if (alternate < 0 || alternate >= 256)
484 udev = interface_to_usbdev (iface);
485 return usb_set_interface (udev,
486 iface->altsetting [0].desc.bInterfaceNumber,
490 static int is_good_config(struct usbtest_dev *tdev, int len)
492 struct usb_config_descriptor *config;
494 if (len < sizeof *config)
496 config = (struct usb_config_descriptor *) tdev->buf;
498 switch (config->bDescriptorType) {
500 case USB_DT_OTHER_SPEED_CONFIG:
501 if (config->bLength != 9) {
502 ERROR(tdev, "bogus config descriptor length\n");
505 /* this bit 'must be 1' but often isn't */
506 if (!realworld && !(config->bmAttributes & 0x80)) {
507 ERROR(tdev, "high bit of config attributes not set\n");
510 if (config->bmAttributes & 0x1f) { /* reserved == 0 */
511 ERROR(tdev, "reserved config bits set\n");
519 if (le16_to_cpu(config->wTotalLength) == len) /* read it all */
521 if (le16_to_cpu(config->wTotalLength) >= TBUF_SIZE) /* max partial read */
523 ERROR(tdev, "bogus config descriptor read size\n");
527 /* sanity test for standard requests working with usb_control_mesg() and some
528 * of the utility functions which use it.
530 * this doesn't test how endpoint halts behave or data toggles get set, since
531 * we won't do I/O to bulk/interrupt endpoints here (which is how to change
532 * halt or toggle). toggle testing is impractical without support from hcds.
534 * this avoids failing devices linux would normally work with, by not testing
535 * config/altsetting operations for devices that only support their defaults.
536 * such devices rarely support those needless operations.
538 * NOTE that since this is a sanity test, it's not examining boundary cases
539 * to see if usbcore, hcd, and device all behave right. such testing would
540 * involve varied read sizes and other operation sequences.
542 static int ch9_postconfig (struct usbtest_dev *dev)
544 struct usb_interface *iface = dev->intf;
545 struct usb_device *udev = interface_to_usbdev (iface);
548 /* [9.2.3] if there's more than one altsetting, we need to be able to
549 * set and get each one. mostly trusts the descriptors from usbcore.
551 for (i = 0; i < iface->num_altsetting; i++) {
553 /* 9.2.3 constrains the range here */
554 alt = iface->altsetting [i].desc.bAlternateSetting;
555 if (alt < 0 || alt >= iface->num_altsetting) {
557 "invalid alt [%d].bAltSetting = %d\n",
561 /* [real world] get/set unimplemented if there's only one */
562 if (realworld && iface->num_altsetting == 1)
565 /* [9.4.10] set_interface */
566 retval = set_altsetting (dev, alt);
568 dev_err(&iface->dev, "can't set_interface = %d, %d\n",
573 /* [9.4.4] get_interface always works */
574 retval = get_altsetting (dev);
576 dev_err(&iface->dev, "get alt should be %d, was %d\n",
578 return (retval < 0) ? retval : -EDOM;
583 /* [real world] get_config unimplemented if there's only one */
584 if (!realworld || udev->descriptor.bNumConfigurations != 1) {
585 int expected = udev->actconfig->desc.bConfigurationValue;
587 /* [9.4.2] get_configuration always works
588 * ... although some cheap devices (like one TI Hub I've got)
589 * won't return config descriptors except before set_config.
591 retval = usb_control_msg (udev, usb_rcvctrlpipe (udev, 0),
592 USB_REQ_GET_CONFIGURATION,
593 USB_DIR_IN | USB_RECIP_DEVICE,
594 0, 0, dev->buf, 1, USB_CTRL_GET_TIMEOUT);
595 if (retval != 1 || dev->buf [0] != expected) {
596 dev_err(&iface->dev, "get config --> %d %d (1 %d)\n",
597 retval, dev->buf[0], expected);
598 return (retval < 0) ? retval : -EDOM;
602 /* there's always [9.4.3] a device descriptor [9.6.1] */
603 retval = usb_get_descriptor (udev, USB_DT_DEVICE, 0,
604 dev->buf, sizeof udev->descriptor);
605 if (retval != sizeof udev->descriptor) {
606 dev_err(&iface->dev, "dev descriptor --> %d\n", retval);
607 return (retval < 0) ? retval : -EDOM;
610 /* there's always [9.4.3] at least one config descriptor [9.6.3] */
611 for (i = 0; i < udev->descriptor.bNumConfigurations; i++) {
612 retval = usb_get_descriptor (udev, USB_DT_CONFIG, i,
613 dev->buf, TBUF_SIZE);
614 if (!is_good_config(dev, retval)) {
616 "config [%d] descriptor --> %d\n",
618 return (retval < 0) ? retval : -EDOM;
621 // FIXME cross-checking udev->config[i] to make sure usbcore
622 // parsed it right (etc) would be good testing paranoia
625 /* and sometimes [9.2.6.6] speed dependent descriptors */
626 if (le16_to_cpu(udev->descriptor.bcdUSB) == 0x0200) {
627 struct usb_qualifier_descriptor *d = NULL;
629 /* device qualifier [9.6.2] */
630 retval = usb_get_descriptor (udev,
631 USB_DT_DEVICE_QUALIFIER, 0, dev->buf,
632 sizeof (struct usb_qualifier_descriptor));
633 if (retval == -EPIPE) {
634 if (udev->speed == USB_SPEED_HIGH) {
636 "hs dev qualifier --> %d\n",
638 return (retval < 0) ? retval : -EDOM;
640 /* usb2.0 but not high-speed capable; fine */
641 } else if (retval != sizeof (struct usb_qualifier_descriptor)) {
642 dev_err(&iface->dev, "dev qualifier --> %d\n", retval);
643 return (retval < 0) ? retval : -EDOM;
645 d = (struct usb_qualifier_descriptor *) dev->buf;
647 /* might not have [9.6.2] any other-speed configs [9.6.4] */
649 unsigned max = d->bNumConfigurations;
650 for (i = 0; i < max; i++) {
651 retval = usb_get_descriptor (udev,
652 USB_DT_OTHER_SPEED_CONFIG, i,
653 dev->buf, TBUF_SIZE);
654 if (!is_good_config(dev, retval)) {
656 "other speed config --> %d\n",
658 return (retval < 0) ? retval : -EDOM;
663 // FIXME fetch strings from at least the device descriptor
665 /* [9.4.5] get_status always works */
666 retval = usb_get_status (udev, USB_RECIP_DEVICE, 0, dev->buf);
668 dev_err(&iface->dev, "get dev status --> %d\n", retval);
669 return (retval < 0) ? retval : -EDOM;
672 // FIXME configuration.bmAttributes says if we could try to set/clear
673 // the device's remote wakeup feature ... if we can, test that here
675 retval = usb_get_status (udev, USB_RECIP_INTERFACE,
676 iface->altsetting [0].desc.bInterfaceNumber, dev->buf);
678 dev_err(&iface->dev, "get interface status --> %d\n", retval);
679 return (retval < 0) ? retval : -EDOM;
681 // FIXME get status for each endpoint in the interface
686 /*-------------------------------------------------------------------------*/
688 /* use ch9 requests to test whether:
689 * (a) queues work for control, keeping N subtests queued and
690 * active (auto-resubmit) for M loops through the queue.
691 * (b) protocol stalls (control-only) will autorecover.
692 * it's not like bulk/intr; no halt clearing.
693 * (c) short control reads are reported and handled.
694 * (d) queues are always processed in-order
699 struct usbtest_dev *dev;
700 struct completion complete;
705 struct usbtest_param *param;
709 #define NUM_SUBCASES 15 /* how many test subcases here? */
712 struct usb_ctrlrequest setup;
717 static void ctrl_complete (struct urb *urb)
719 struct ctrl_ctx *ctx = urb->context;
720 struct usb_ctrlrequest *reqp;
721 struct subcase *subcase;
722 int status = urb->status;
724 reqp = (struct usb_ctrlrequest *)urb->setup_packet;
725 subcase = container_of (reqp, struct subcase, setup);
727 spin_lock (&ctx->lock);
731 /* queue must transfer and complete in fifo order, unless
732 * usb_unlink_urb() is used to unlink something not at the
733 * physical queue head (not tested).
735 if (subcase->number > 0) {
736 if ((subcase->number - ctx->last) != 1) {
738 "subcase %d completed out of order, last %d\n",
739 subcase->number, ctx->last);
741 ctx->last = subcase->number;
745 ctx->last = subcase->number;
747 /* succeed or fault in only one way? */
748 if (status == subcase->expected)
751 /* async unlink for cleanup? */
752 else if (status != -ECONNRESET) {
754 /* some faults are allowed, not required */
755 if (subcase->expected > 0 && (
756 ((status == -subcase->expected /* happened */
757 || status == 0)))) /* didn't */
759 /* sometimes more than one fault is allowed */
760 else if (subcase->number == 12 && status == -EPIPE)
763 ERROR(ctx->dev, "subtest %d error, status %d\n",
764 subcase->number, status);
767 /* unexpected status codes mean errors; ideally, in hardware */
770 if (ctx->status == 0) {
773 ctx->status = status;
774 ERROR(ctx->dev, "control queue %02x.%02x, err %d, "
775 "%d left, subcase %d, len %d/%d\n",
776 reqp->bRequestType, reqp->bRequest,
777 status, ctx->count, subcase->number,
779 urb->transfer_buffer_length);
781 /* FIXME this "unlink everything" exit route should
782 * be a separate test case.
785 /* unlink whatever's still pending */
786 for (i = 1; i < ctx->param->sglen; i++) {
787 struct urb *u = ctx->urb [
788 (i + subcase->number)
789 % ctx->param->sglen];
791 if (u == urb || !u->dev)
793 spin_unlock(&ctx->lock);
794 status = usb_unlink_urb (u);
795 spin_lock(&ctx->lock);
802 ERROR(ctx->dev, "urb unlink --> %d\n",
806 status = ctx->status;
810 /* resubmit if we need to, else mark this as done */
811 if ((status == 0) && (ctx->pending < ctx->count)) {
812 if ((status = usb_submit_urb (urb, GFP_ATOMIC)) != 0) {
814 "can't resubmit ctrl %02x.%02x, err %d\n",
815 reqp->bRequestType, reqp->bRequest, status);
822 /* signal completion when nothing's queued */
823 if (ctx->pending == 0)
824 complete (&ctx->complete);
825 spin_unlock (&ctx->lock);
829 test_ctrl_queue (struct usbtest_dev *dev, struct usbtest_param *param)
831 struct usb_device *udev = testdev_to_usbdev (dev);
833 struct ctrl_ctx context;
836 spin_lock_init (&context.lock);
838 init_completion (&context.complete);
839 context.count = param->sglen * param->iterations;
841 context.status = -ENOMEM;
842 context.param = param;
845 /* allocate and init the urbs we'll queue.
846 * as with bulk/intr sglists, sglen is the queue depth; it also
847 * controls which subtests run (more tests than sglen) or rerun.
849 urb = kcalloc(param->sglen, sizeof(struct urb *), GFP_KERNEL);
852 for (i = 0; i < param->sglen; i++) {
853 int pipe = usb_rcvctrlpipe (udev, 0);
856 struct usb_ctrlrequest req;
857 struct subcase *reqp;
859 /* sign of this variable means:
860 * -: tested code must return this (negative) error code
861 * +: tested code may return this (negative too) error code
865 /* requests here are mostly expected to succeed on any
866 * device, but some are chosen to trigger protocol stalls
869 memset (&req, 0, sizeof req);
870 req.bRequest = USB_REQ_GET_DESCRIPTOR;
871 req.bRequestType = USB_DIR_IN|USB_RECIP_DEVICE;
873 switch (i % NUM_SUBCASES) {
874 case 0: // get device descriptor
875 req.wValue = cpu_to_le16 (USB_DT_DEVICE << 8);
876 len = sizeof (struct usb_device_descriptor);
878 case 1: // get first config descriptor (only)
879 req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
880 len = sizeof (struct usb_config_descriptor);
882 case 2: // get altsetting (OFTEN STALLS)
883 req.bRequest = USB_REQ_GET_INTERFACE;
884 req.bRequestType = USB_DIR_IN|USB_RECIP_INTERFACE;
885 // index = 0 means first interface
889 case 3: // get interface status
890 req.bRequest = USB_REQ_GET_STATUS;
891 req.bRequestType = USB_DIR_IN|USB_RECIP_INTERFACE;
895 case 4: // get device status
896 req.bRequest = USB_REQ_GET_STATUS;
897 req.bRequestType = USB_DIR_IN|USB_RECIP_DEVICE;
900 case 5: // get device qualifier (MAY STALL)
901 req.wValue = cpu_to_le16 (USB_DT_DEVICE_QUALIFIER << 8);
902 len = sizeof (struct usb_qualifier_descriptor);
903 if (udev->speed != USB_SPEED_HIGH)
906 case 6: // get first config descriptor, plus interface
907 req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
908 len = sizeof (struct usb_config_descriptor);
909 len += sizeof (struct usb_interface_descriptor);
911 case 7: // get interface descriptor (ALWAYS STALLS)
912 req.wValue = cpu_to_le16 (USB_DT_INTERFACE << 8);
914 len = sizeof (struct usb_interface_descriptor);
917 // NOTE: two consecutive stalls in the queue here.
918 // that tests fault recovery a bit more aggressively.
919 case 8: // clear endpoint halt (MAY STALL)
920 req.bRequest = USB_REQ_CLEAR_FEATURE;
921 req.bRequestType = USB_RECIP_ENDPOINT;
922 // wValue 0 == ep halt
923 // wIndex 0 == ep0 (shouldn't halt!)
925 pipe = usb_sndctrlpipe (udev, 0);
928 case 9: // get endpoint status
929 req.bRequest = USB_REQ_GET_STATUS;
930 req.bRequestType = USB_DIR_IN|USB_RECIP_ENDPOINT;
934 case 10: // trigger short read (EREMOTEIO)
935 req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
937 expected = -EREMOTEIO;
939 // NOTE: two consecutive _different_ faults in the queue.
940 case 11: // get endpoint descriptor (ALWAYS STALLS)
941 req.wValue = cpu_to_le16 (USB_DT_ENDPOINT << 8);
943 len = sizeof (struct usb_interface_descriptor);
946 // NOTE: sometimes even a third fault in the queue!
947 case 12: // get string 0 descriptor (MAY STALL)
948 req.wValue = cpu_to_le16 (USB_DT_STRING << 8);
949 // string == 0, for language IDs
950 len = sizeof (struct usb_interface_descriptor);
951 // may succeed when > 4 languages
952 expected = EREMOTEIO; // or EPIPE, if no strings
954 case 13: // short read, resembling case 10
955 req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
956 // last data packet "should" be DATA1, not DATA0
957 len = 1024 - udev->descriptor.bMaxPacketSize0;
958 expected = -EREMOTEIO;
960 case 14: // short read; try to fill the last packet
961 req.wValue = cpu_to_le16 ((USB_DT_DEVICE << 8) | 0);
962 /* device descriptor size == 18 bytes */
963 len = udev->descriptor.bMaxPacketSize0;
965 case 8: len = 24; break;
966 case 16: len = 32; break;
968 expected = -EREMOTEIO;
971 ERROR(dev, "bogus number of ctrl queue testcases!\n");
972 context.status = -EINVAL;
975 req.wLength = cpu_to_le16 (len);
976 urb [i] = u = simple_alloc_urb (udev, pipe, len);
980 reqp = kmalloc(sizeof *reqp, GFP_KERNEL);
984 reqp->number = i % NUM_SUBCASES;
985 reqp->expected = expected;
986 u->setup_packet = (char *) &reqp->setup;
988 u->context = &context;
989 u->complete = ctrl_complete;
994 spin_lock_irq (&context.lock);
995 for (i = 0; i < param->sglen; i++) {
996 context.status = usb_submit_urb (urb [i], GFP_ATOMIC);
997 if (context.status != 0) {
998 ERROR(dev, "can't submit urb[%d], status %d\n",
1000 context.count = context.pending;
1005 spin_unlock_irq (&context.lock);
1007 /* FIXME set timer and time out; provide a disconnect hook */
1009 /* wait for the last one to complete */
1010 if (context.pending > 0)
1011 wait_for_completion (&context.complete);
1014 for (i = 0; i < param->sglen; i++) {
1017 urb [i]->dev = udev;
1018 kfree(urb[i]->setup_packet);
1019 simple_free_urb (urb [i]);
1022 return context.status;
1027 /*-------------------------------------------------------------------------*/
1029 static void unlink1_callback (struct urb *urb)
1031 int status = urb->status;
1033 // we "know" -EPIPE (stall) never happens
1035 status = usb_submit_urb (urb, GFP_ATOMIC);
1037 urb->status = status;
1038 complete(urb->context);
1042 static int unlink1 (struct usbtest_dev *dev, int pipe, int size, int async)
1045 struct completion completion;
1048 init_completion (&completion);
1049 urb = simple_alloc_urb (testdev_to_usbdev (dev), pipe, size);
1052 urb->context = &completion;
1053 urb->complete = unlink1_callback;
1055 /* keep the endpoint busy. there are lots of hc/hcd-internal
1056 * states, and testing should get to all of them over time.
1058 * FIXME want additional tests for when endpoint is STALLing
1059 * due to errors, or is just NAKing requests.
1061 if ((retval = usb_submit_urb (urb, GFP_KERNEL)) != 0) {
1062 dev_err(&dev->intf->dev, "submit fail %d\n", retval);
1066 /* unlinking that should always work. variable delay tests more
1067 * hcd states and code paths, even with little other system load.
1069 msleep (jiffies % (2 * INTERRUPT_RATE));
1071 while (!completion_done(&completion)) {
1072 retval = usb_unlink_urb(urb);
1077 /* we can't unlink urbs while they're completing
1078 * or if they've completed, and we haven't
1079 * resubmitted. "normal" drivers would prevent
1080 * resubmission, but since we're testing unlink
1083 ERROR(dev, "unlink retry\n");
1090 dev_err(&dev->intf->dev,
1091 "unlink fail %d\n", retval);
1100 wait_for_completion (&completion);
1101 retval = urb->status;
1102 simple_free_urb (urb);
1105 return (retval == -ECONNRESET) ? 0 : retval - 1000;
1107 return (retval == -ENOENT || retval == -EPERM) ?
1111 static int unlink_simple (struct usbtest_dev *dev, int pipe, int len)
1115 /* test sync and async paths */
1116 retval = unlink1 (dev, pipe, len, 1);
1118 retval = unlink1 (dev, pipe, len, 0);
1122 /*-------------------------------------------------------------------------*/
1124 static int verify_not_halted(struct usbtest_dev *tdev, int ep, struct urb *urb)
1129 /* shouldn't look or act halted */
1130 retval = usb_get_status (urb->dev, USB_RECIP_ENDPOINT, ep, &status);
1132 ERROR(tdev, "ep %02x couldn't get no-halt status, %d\n",
1137 ERROR(tdev, "ep %02x bogus status: %04x != 0\n", ep, status);
1140 retval = simple_io(tdev, urb, 1, 0, 0, __func__);
1146 static int verify_halted(struct usbtest_dev *tdev, int ep, struct urb *urb)
1151 /* should look and act halted */
1152 retval = usb_get_status (urb->dev, USB_RECIP_ENDPOINT, ep, &status);
1154 ERROR(tdev, "ep %02x couldn't get halt status, %d\n",
1158 le16_to_cpus(&status);
1160 ERROR(tdev, "ep %02x bogus status: %04x != 1\n", ep, status);
1163 retval = simple_io(tdev, urb, 1, 0, -EPIPE, __func__);
1164 if (retval != -EPIPE)
1166 retval = simple_io(tdev, urb, 1, 0, -EPIPE, "verify_still_halted");
1167 if (retval != -EPIPE)
1172 static int test_halt(struct usbtest_dev *tdev, int ep, struct urb *urb)
1176 /* shouldn't look or act halted now */
1177 retval = verify_not_halted(tdev, ep, urb);
1181 /* set halt (protocol test only), verify it worked */
1182 retval = usb_control_msg (urb->dev, usb_sndctrlpipe (urb->dev, 0),
1183 USB_REQ_SET_FEATURE, USB_RECIP_ENDPOINT,
1184 USB_ENDPOINT_HALT, ep,
1185 NULL, 0, USB_CTRL_SET_TIMEOUT);
1187 ERROR(tdev, "ep %02x couldn't set halt, %d\n", ep, retval);
1190 retval = verify_halted(tdev, ep, urb);
1194 /* clear halt (tests API + protocol), verify it worked */
1195 retval = usb_clear_halt (urb->dev, urb->pipe);
1197 ERROR(tdev, "ep %02x couldn't clear halt, %d\n", ep, retval);
1200 retval = verify_not_halted(tdev, ep, urb);
1204 /* NOTE: could also verify SET_INTERFACE clear halts ... */
1209 static int halt_simple (struct usbtest_dev *dev)
1215 urb = simple_alloc_urb (testdev_to_usbdev (dev), 0, 512);
1220 ep = usb_pipeendpoint (dev->in_pipe) | USB_DIR_IN;
1221 urb->pipe = dev->in_pipe;
1222 retval = test_halt(dev, ep, urb);
1227 if (dev->out_pipe) {
1228 ep = usb_pipeendpoint (dev->out_pipe);
1229 urb->pipe = dev->out_pipe;
1230 retval = test_halt(dev, ep, urb);
1233 simple_free_urb (urb);
1237 /*-------------------------------------------------------------------------*/
1239 /* Control OUT tests use the vendor control requests from Intel's
1240 * USB 2.0 compliance test device: write a buffer, read it back.
1242 * Intel's spec only _requires_ that it work for one packet, which
1243 * is pretty weak. Some HCDs place limits here; most devices will
1244 * need to be able to handle more than one OUT data packet. We'll
1245 * try whatever we're told to try.
1247 static int ctrl_out (struct usbtest_dev *dev,
1248 unsigned count, unsigned length, unsigned vary)
1254 struct usb_device *udev;
1256 if (length < 1 || length > 0xffff || vary >= length)
1259 buf = kmalloc(length, GFP_KERNEL);
1263 udev = testdev_to_usbdev (dev);
1267 /* NOTE: hardware might well act differently if we pushed it
1268 * with lots back-to-back queued requests.
1270 for (i = 0; i < count; i++) {
1271 /* write patterned data */
1272 for (j = 0; j < len; j++)
1274 retval = usb_control_msg (udev, usb_sndctrlpipe (udev,0),
1275 0x5b, USB_DIR_OUT|USB_TYPE_VENDOR,
1276 0, 0, buf, len, USB_CTRL_SET_TIMEOUT);
1277 if (retval != len) {
1280 ERROR(dev, "ctrl_out, wlen %d (expected %d)\n",
1287 /* read it back -- assuming nothing intervened!! */
1288 retval = usb_control_msg (udev, usb_rcvctrlpipe (udev,0),
1289 0x5c, USB_DIR_IN|USB_TYPE_VENDOR,
1290 0, 0, buf, len, USB_CTRL_GET_TIMEOUT);
1291 if (retval != len) {
1294 ERROR(dev, "ctrl_out, rlen %d (expected %d)\n",
1301 /* fail if we can't verify */
1302 for (j = 0; j < len; j++) {
1303 if (buf [j] != (u8) (i + j)) {
1304 ERROR(dev, "ctrl_out, byte %d is %d not %d\n",
1305 j, buf [j], (u8) i + j);
1317 /* [real world] the "zero bytes IN" case isn't really used.
1318 * hardware can easily trip up in this weird case, since its
1319 * status stage is IN, not OUT like other ep0in transfers.
1322 len = realworld ? 1 : 0;
1326 ERROR (dev, "ctrl_out %s failed, code %d, count %d\n",
1333 /*-------------------------------------------------------------------------*/
1335 /* ISO tests ... mimics common usage
1336 * - buffer length is split into N packets (mostly maxpacket sized)
1337 * - multi-buffers according to sglen
1340 struct iso_context {
1344 struct completion done;
1346 unsigned long errors;
1347 unsigned long packet_count;
1348 struct usbtest_dev *dev;
1351 static void iso_callback (struct urb *urb)
1353 struct iso_context *ctx = urb->context;
1355 spin_lock(&ctx->lock);
1358 ctx->packet_count += urb->number_of_packets;
1359 if (urb->error_count > 0)
1360 ctx->errors += urb->error_count;
1361 else if (urb->status != 0)
1362 ctx->errors += urb->number_of_packets;
1364 if (urb->status == 0 && ctx->count > (ctx->pending - 1)
1365 && !ctx->submit_error) {
1366 int status = usb_submit_urb (urb, GFP_ATOMIC);
1371 dev_err(&ctx->dev->intf->dev,
1372 "iso resubmit err %d\n",
1375 case -ENODEV: /* disconnected */
1376 case -ESHUTDOWN: /* endpoint disabled */
1377 ctx->submit_error = 1;
1381 simple_free_urb (urb);
1384 if (ctx->pending == 0) {
1386 dev_err(&ctx->dev->intf->dev,
1387 "iso test, %lu errors out of %lu\n",
1388 ctx->errors, ctx->packet_count);
1389 complete (&ctx->done);
1392 spin_unlock(&ctx->lock);
1395 static struct urb *iso_alloc_urb (
1396 struct usb_device *udev,
1398 struct usb_endpoint_descriptor *desc,
1403 unsigned i, maxp, packets;
1405 if (bytes < 0 || !desc)
1407 maxp = 0x7ff & le16_to_cpu(desc->wMaxPacketSize);
1408 maxp *= 1 + (0x3 & (le16_to_cpu(desc->wMaxPacketSize) >> 11));
1409 packets = DIV_ROUND_UP(bytes, maxp);
1411 urb = usb_alloc_urb (packets, GFP_KERNEL);
1417 urb->number_of_packets = packets;
1418 urb->transfer_buffer_length = bytes;
1419 urb->transfer_buffer = usb_alloc_coherent (udev, bytes, GFP_KERNEL,
1420 &urb->transfer_dma);
1421 if (!urb->transfer_buffer) {
1425 memset (urb->transfer_buffer, 0, bytes);
1426 for (i = 0; i < packets; i++) {
1427 /* here, only the last packet will be short */
1428 urb->iso_frame_desc[i].length = min ((unsigned) bytes, maxp);
1429 bytes -= urb->iso_frame_desc[i].length;
1431 urb->iso_frame_desc[i].offset = maxp * i;
1434 urb->complete = iso_callback;
1435 // urb->context = SET BY CALLER
1436 urb->interval = 1 << (desc->bInterval - 1);
1437 urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
1442 test_iso_queue (struct usbtest_dev *dev, struct usbtest_param *param,
1443 int pipe, struct usb_endpoint_descriptor *desc)
1445 struct iso_context context;
1446 struct usb_device *udev;
1448 unsigned long packets = 0;
1450 struct urb *urbs[10]; /* FIXME no limit */
1452 if (param->sglen > 10)
1455 memset(&context, 0, sizeof context);
1456 context.count = param->iterations * param->sglen;
1458 init_completion (&context.done);
1459 spin_lock_init (&context.lock);
1461 memset (urbs, 0, sizeof urbs);
1462 udev = testdev_to_usbdev (dev);
1463 dev_info(&dev->intf->dev,
1464 "... iso period %d %sframes, wMaxPacket %04x\n",
1465 1 << (desc->bInterval - 1),
1466 (udev->speed == USB_SPEED_HIGH) ? "micro" : "",
1467 le16_to_cpu(desc->wMaxPacketSize));
1469 for (i = 0; i < param->sglen; i++) {
1470 urbs [i] = iso_alloc_urb (udev, pipe, desc,
1476 packets += urbs[i]->number_of_packets;
1477 urbs [i]->context = &context;
1479 packets *= param->iterations;
1480 dev_info(&dev->intf->dev,
1481 "... total %lu msec (%lu packets)\n",
1482 (packets * (1 << (desc->bInterval - 1)))
1483 / ((udev->speed == USB_SPEED_HIGH) ? 8 : 1),
1486 spin_lock_irq (&context.lock);
1487 for (i = 0; i < param->sglen; i++) {
1489 status = usb_submit_urb (urbs [i], GFP_ATOMIC);
1491 ERROR (dev, "submit iso[%d], error %d\n", i, status);
1493 spin_unlock_irq (&context.lock);
1497 simple_free_urb (urbs [i]);
1499 context.submit_error = 1;
1503 spin_unlock_irq (&context.lock);
1505 wait_for_completion (&context.done);
1508 * Isochronous transfers are expected to fail sometimes. As an
1509 * arbitrary limit, we will report an error if any submissions
1510 * fail or if the transfer failure rate is > 10%.
1514 else if (context.submit_error)
1516 else if (context.errors > context.packet_count / 10)
1521 for (i = 0; i < param->sglen; i++) {
1523 simple_free_urb (urbs [i]);
1528 /*-------------------------------------------------------------------------*/
1530 /* We only have this one interface to user space, through usbfs.
1531 * User mode code can scan usbfs to find N different devices (maybe on
1532 * different busses) to use when testing, and allocate one thread per
1533 * test. So discovery is simplified, and we have no device naming issues.
1535 * Don't use these only as stress/load tests. Use them along with with
1536 * other USB bus activity: plugging, unplugging, mousing, mp3 playback,
1537 * video capture, and so on. Run different tests at different times, in
1538 * different sequences. Nothing here should interact with other devices,
1539 * except indirectly by consuming USB bandwidth and CPU resources for test
1540 * threads and request completion. But the only way to know that for sure
1541 * is to test when HC queues are in use by many devices.
1543 * WARNING: Because usbfs grabs udev->dev.sem before calling this ioctl(),
1544 * it locks out usbcore in certain code paths. Notably, if you disconnect
1545 * the device-under-test, khubd will wait block forever waiting for the
1546 * ioctl to complete ... so that usb_disconnect() can abort the pending
1547 * urbs and then call usbtest_disconnect(). To abort a test, you're best
1548 * off just killing the userspace task and waiting for it to exit.
1552 usbtest_ioctl (struct usb_interface *intf, unsigned int code, void *buf)
1554 struct usbtest_dev *dev = usb_get_intfdata (intf);
1555 struct usb_device *udev = testdev_to_usbdev (dev);
1556 struct usbtest_param *param = buf;
1557 int retval = -EOPNOTSUPP;
1559 struct scatterlist *sg;
1560 struct usb_sg_request req;
1561 struct timeval start;
1564 // FIXME USBDEVFS_CONNECTINFO doesn't say how fast the device is.
1566 pattern = mod_pattern;
1568 if (code != USBTEST_REQUEST)
1571 if (param->iterations <= 0)
1574 if (mutex_lock_interruptible(&dev->lock))
1575 return -ERESTARTSYS;
1577 /* FIXME: What if a system sleep starts while a test is running? */
1579 /* some devices, like ez-usb default devices, need a non-default
1580 * altsetting to have any active endpoints. some tests change
1581 * altsettings; force a default so most tests don't need to check.
1583 if (dev->info->alt >= 0) {
1586 if (intf->altsetting->desc.bInterfaceNumber) {
1587 mutex_unlock(&dev->lock);
1590 res = set_altsetting (dev, dev->info->alt);
1592 dev_err (&intf->dev,
1593 "set altsetting to %d failed, %d\n",
1594 dev->info->alt, res);
1595 mutex_unlock(&dev->lock);
1601 * Just a bunch of test cases that every HCD is expected to handle.
1603 * Some may need specific firmware, though it'd be good to have
1604 * one firmware image to handle all the test cases.
1606 * FIXME add more tests! cancel requests, verify the data, control
1607 * queueing, concurrent read+write threads, and so on.
1609 do_gettimeofday (&start);
1610 switch (param->test_num) {
1613 dev_info(&intf->dev, "TEST 0: NOP\n");
1617 /* Simple non-queued bulk I/O tests */
1619 if (dev->out_pipe == 0)
1621 dev_info(&intf->dev,
1622 "TEST 1: write %d bytes %u times\n",
1623 param->length, param->iterations);
1624 urb = simple_alloc_urb (udev, dev->out_pipe, param->length);
1629 // FIRMWARE: bulk sink (maybe accepts short writes)
1630 retval = simple_io(dev, urb, param->iterations, 0, 0, "test1");
1631 simple_free_urb (urb);
1634 if (dev->in_pipe == 0)
1636 dev_info(&intf->dev,
1637 "TEST 2: read %d bytes %u times\n",
1638 param->length, param->iterations);
1639 urb = simple_alloc_urb (udev, dev->in_pipe, param->length);
1644 // FIRMWARE: bulk source (maybe generates short writes)
1645 retval = simple_io(dev, urb, param->iterations, 0, 0, "test2");
1646 simple_free_urb (urb);
1649 if (dev->out_pipe == 0 || param->vary == 0)
1651 dev_info(&intf->dev,
1652 "TEST 3: write/%d 0..%d bytes %u times\n",
1653 param->vary, param->length, param->iterations);
1654 urb = simple_alloc_urb (udev, dev->out_pipe, param->length);
1659 // FIRMWARE: bulk sink (maybe accepts short writes)
1660 retval = simple_io(dev, urb, param->iterations, param->vary,
1662 simple_free_urb (urb);
1665 if (dev->in_pipe == 0 || param->vary == 0)
1667 dev_info(&intf->dev,
1668 "TEST 4: read/%d 0..%d bytes %u times\n",
1669 param->vary, param->length, param->iterations);
1670 urb = simple_alloc_urb (udev, dev->in_pipe, param->length);
1675 // FIRMWARE: bulk source (maybe generates short writes)
1676 retval = simple_io(dev, urb, param->iterations, param->vary,
1678 simple_free_urb (urb);
1681 /* Queued bulk I/O tests */
1683 if (dev->out_pipe == 0 || param->sglen == 0)
1685 dev_info(&intf->dev,
1686 "TEST 5: write %d sglists %d entries of %d bytes\n",
1688 param->sglen, param->length);
1689 sg = alloc_sglist (param->sglen, param->length, 0);
1694 // FIRMWARE: bulk sink (maybe accepts short writes)
1695 retval = perform_sglist(dev, param->iterations, dev->out_pipe,
1696 &req, sg, param->sglen);
1697 free_sglist (sg, param->sglen);
1701 if (dev->in_pipe == 0 || param->sglen == 0)
1703 dev_info(&intf->dev,
1704 "TEST 6: read %d sglists %d entries of %d bytes\n",
1706 param->sglen, param->length);
1707 sg = alloc_sglist (param->sglen, param->length, 0);
1712 // FIRMWARE: bulk source (maybe generates short writes)
1713 retval = perform_sglist(dev, param->iterations, dev->in_pipe,
1714 &req, sg, param->sglen);
1715 free_sglist (sg, param->sglen);
1718 if (dev->out_pipe == 0 || param->sglen == 0 || param->vary == 0)
1720 dev_info(&intf->dev,
1721 "TEST 7: write/%d %d sglists %d entries 0..%d bytes\n",
1722 param->vary, param->iterations,
1723 param->sglen, param->length);
1724 sg = alloc_sglist (param->sglen, param->length, param->vary);
1729 // FIRMWARE: bulk sink (maybe accepts short writes)
1730 retval = perform_sglist(dev, param->iterations, dev->out_pipe,
1731 &req, sg, param->sglen);
1732 free_sglist (sg, param->sglen);
1735 if (dev->in_pipe == 0 || param->sglen == 0 || param->vary == 0)
1737 dev_info(&intf->dev,
1738 "TEST 8: read/%d %d sglists %d entries 0..%d bytes\n",
1739 param->vary, param->iterations,
1740 param->sglen, param->length);
1741 sg = alloc_sglist (param->sglen, param->length, param->vary);
1746 // FIRMWARE: bulk source (maybe generates short writes)
1747 retval = perform_sglist(dev, param->iterations, dev->in_pipe,
1748 &req, sg, param->sglen);
1749 free_sglist (sg, param->sglen);
1752 /* non-queued sanity tests for control (chapter 9 subset) */
1755 dev_info(&intf->dev,
1756 "TEST 9: ch9 (subset) control tests, %d times\n",
1758 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1759 retval = ch9_postconfig (dev);
1761 dev_err(&intf->dev, "ch9 subset failed, "
1762 "iterations left %d\n", i);
1765 /* queued control messaging */
1767 if (param->sglen == 0)
1770 dev_info(&intf->dev,
1771 "TEST 10: queue %d control calls, %d times\n",
1774 retval = test_ctrl_queue (dev, param);
1777 /* simple non-queued unlinks (ring with one urb) */
1779 if (dev->in_pipe == 0 || !param->length)
1782 dev_info(&intf->dev, "TEST 11: unlink %d reads of %d\n",
1783 param->iterations, param->length);
1784 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1785 retval = unlink_simple (dev, dev->in_pipe,
1788 dev_err(&intf->dev, "unlink reads failed %d, "
1789 "iterations left %d\n", retval, i);
1792 if (dev->out_pipe == 0 || !param->length)
1795 dev_info(&intf->dev, "TEST 12: unlink %d writes of %d\n",
1796 param->iterations, param->length);
1797 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1798 retval = unlink_simple (dev, dev->out_pipe,
1801 dev_err(&intf->dev, "unlink writes failed %d, "
1802 "iterations left %d\n", retval, i);
1807 if (dev->out_pipe == 0 && dev->in_pipe == 0)
1810 dev_info(&intf->dev, "TEST 13: set/clear %d halts\n",
1812 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1813 retval = halt_simple (dev);
1816 ERROR(dev, "halts failed, iterations left %d\n", i);
1819 /* control write tests */
1821 if (!dev->info->ctrl_out)
1823 dev_info(&intf->dev, "TEST 14: %d ep0out, %d..%d vary %d\n",
1825 realworld ? 1 : 0, param->length,
1827 retval = ctrl_out(dev, param->iterations,
1828 param->length, param->vary);
1831 /* iso write tests */
1833 if (dev->out_iso_pipe == 0 || param->sglen == 0)
1835 dev_info(&intf->dev,
1836 "TEST 15: write %d iso, %d entries of %d bytes\n",
1838 param->sglen, param->length);
1839 // FIRMWARE: iso sink
1840 retval = test_iso_queue (dev, param,
1841 dev->out_iso_pipe, dev->iso_out);
1844 /* iso read tests */
1846 if (dev->in_iso_pipe == 0 || param->sglen == 0)
1848 dev_info(&intf->dev,
1849 "TEST 16: read %d iso, %d entries of %d bytes\n",
1851 param->sglen, param->length);
1852 // FIRMWARE: iso source
1853 retval = test_iso_queue (dev, param,
1854 dev->in_iso_pipe, dev->iso_in);
1857 // FIXME unlink from queue (ring with N urbs)
1859 // FIXME scatterlist cancel (needs helper thread)
1862 do_gettimeofday (¶m->duration);
1863 param->duration.tv_sec -= start.tv_sec;
1864 param->duration.tv_usec -= start.tv_usec;
1865 if (param->duration.tv_usec < 0) {
1866 param->duration.tv_usec += 1000 * 1000;
1867 param->duration.tv_sec -= 1;
1869 mutex_unlock(&dev->lock);
1873 /*-------------------------------------------------------------------------*/
1875 static unsigned force_interrupt = 0;
1876 module_param (force_interrupt, uint, 0);
1877 MODULE_PARM_DESC (force_interrupt, "0 = test default; else interrupt");
1880 static unsigned short vendor;
1881 module_param(vendor, ushort, 0);
1882 MODULE_PARM_DESC (vendor, "vendor code (from usb-if)");
1884 static unsigned short product;
1885 module_param(product, ushort, 0);
1886 MODULE_PARM_DESC (product, "product code (from vendor)");
1890 usbtest_probe (struct usb_interface *intf, const struct usb_device_id *id)
1892 struct usb_device *udev;
1893 struct usbtest_dev *dev;
1894 struct usbtest_info *info;
1895 char *rtest, *wtest;
1896 char *irtest, *iwtest;
1898 udev = interface_to_usbdev (intf);
1901 /* specify devices by module parameters? */
1902 if (id->match_flags == 0) {
1903 /* vendor match required, product match optional */
1904 if (!vendor || le16_to_cpu(udev->descriptor.idVendor) != (u16)vendor)
1906 if (product && le16_to_cpu(udev->descriptor.idProduct) != (u16)product)
1908 dev_info(&intf->dev, "matched module params, "
1909 "vend=0x%04x prod=0x%04x\n",
1910 le16_to_cpu(udev->descriptor.idVendor),
1911 le16_to_cpu(udev->descriptor.idProduct));
1915 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1918 info = (struct usbtest_info *) id->driver_info;
1920 mutex_init(&dev->lock);
1924 /* cacheline-aligned scratch for i/o */
1925 if ((dev->buf = kmalloc (TBUF_SIZE, GFP_KERNEL)) == NULL) {
1930 /* NOTE this doesn't yet test the handful of difference that are
1931 * visible with high speed interrupts: bigger maxpacket (1K) and
1932 * "high bandwidth" modes (up to 3 packets/uframe).
1935 irtest = iwtest = "";
1936 if (force_interrupt || udev->speed == USB_SPEED_LOW) {
1938 dev->in_pipe = usb_rcvintpipe (udev, info->ep_in);
1942 dev->out_pipe = usb_sndintpipe (udev, info->ep_out);
1943 wtest = " intr-out";
1946 if (info->autoconf) {
1949 status = get_endpoints (dev, intf);
1951 WARNING(dev, "couldn't get endpoints, %d\n",
1955 /* may find bulk or ISO pipes */
1958 dev->in_pipe = usb_rcvbulkpipe (udev,
1961 dev->out_pipe = usb_sndbulkpipe (udev,
1967 wtest = " bulk-out";
1968 if (dev->in_iso_pipe)
1970 if (dev->out_iso_pipe)
1971 iwtest = " iso-out";
1974 usb_set_intfdata (intf, dev);
1975 dev_info (&intf->dev, "%s\n", info->name);
1976 dev_info (&intf->dev, "%s speed {control%s%s%s%s%s} tests%s\n",
1978 switch (udev->speed) {
1979 case USB_SPEED_LOW: tmp = "low"; break;
1980 case USB_SPEED_FULL: tmp = "full"; break;
1981 case USB_SPEED_HIGH: tmp = "high"; break;
1982 default: tmp = "unknown"; break;
1984 info->ctrl_out ? " in/out" : "",
1987 info->alt >= 0 ? " (+alt)" : "");
1991 static int usbtest_suspend (struct usb_interface *intf, pm_message_t message)
1996 static int usbtest_resume (struct usb_interface *intf)
2002 static void usbtest_disconnect (struct usb_interface *intf)
2004 struct usbtest_dev *dev = usb_get_intfdata (intf);
2006 usb_set_intfdata (intf, NULL);
2007 dev_dbg (&intf->dev, "disconnect\n");
2011 /* Basic testing only needs a device that can source or sink bulk traffic.
2012 * Any device can test control transfers (default with GENERIC binding).
2014 * Several entries work with the default EP0 implementation that's built
2015 * into EZ-USB chips. There's a default vendor ID which can be overridden
2016 * by (very) small config EEPROMS, but otherwise all these devices act
2017 * identically until firmware is loaded: only EP0 works. It turns out
2018 * to be easy to make other endpoints work, without modifying that EP0
2019 * behavior. For now, we expect that kind of firmware.
2022 /* an21xx or fx versions of ez-usb */
2023 static struct usbtest_info ez1_info = {
2024 .name = "EZ-USB device",
2030 /* fx2 version of ez-usb */
2031 static struct usbtest_info ez2_info = {
2032 .name = "FX2 device",
2038 /* ezusb family device with dedicated usb test firmware,
2040 static struct usbtest_info fw_info = {
2041 .name = "usb test device",
2045 .autoconf = 1, // iso and ctrl_out need autoconf
2047 .iso = 1, // iso_ep's are #8 in/out
2050 /* peripheral running Linux and 'zero.c' test firmware, or
2051 * its user-mode cousin. different versions of this use
2052 * different hardware with the same vendor/product codes.
2053 * host side MUST rely on the endpoint descriptors.
2055 static struct usbtest_info gz_info = {
2056 .name = "Linux gadget zero",
2062 static struct usbtest_info um_info = {
2063 .name = "Linux user mode test driver",
2068 static struct usbtest_info um2_info = {
2069 .name = "Linux user mode ISO test driver",
2076 /* this is a nice source of high speed bulk data;
2077 * uses an FX2, with firmware provided in the device
2079 static struct usbtest_info ibot2_info = {
2080 .name = "iBOT2 webcam",
2087 /* we can use any device to test control traffic */
2088 static struct usbtest_info generic_info = {
2089 .name = "Generic USB device",
2095 static const struct usb_device_id id_table[] = {
2097 /*-------------------------------------------------------------*/
2099 /* EZ-USB devices which download firmware to replace (or in our
2100 * case augment) the default device implementation.
2103 /* generic EZ-USB FX controller */
2104 { USB_DEVICE (0x0547, 0x2235),
2105 .driver_info = (unsigned long) &ez1_info,
2108 /* CY3671 development board with EZ-USB FX */
2109 { USB_DEVICE (0x0547, 0x0080),
2110 .driver_info = (unsigned long) &ez1_info,
2113 /* generic EZ-USB FX2 controller (or development board) */
2114 { USB_DEVICE (0x04b4, 0x8613),
2115 .driver_info = (unsigned long) &ez2_info,
2118 /* re-enumerated usb test device firmware */
2119 { USB_DEVICE (0xfff0, 0xfff0),
2120 .driver_info = (unsigned long) &fw_info,
2123 /* "Gadget Zero" firmware runs under Linux */
2124 { USB_DEVICE (0x0525, 0xa4a0),
2125 .driver_info = (unsigned long) &gz_info,
2128 /* so does a user-mode variant */
2129 { USB_DEVICE (0x0525, 0xa4a4),
2130 .driver_info = (unsigned long) &um_info,
2133 /* ... and a user-mode variant that talks iso */
2134 { USB_DEVICE (0x0525, 0xa4a3),
2135 .driver_info = (unsigned long) &um2_info,
2139 /* Keyspan 19qi uses an21xx (original EZ-USB) */
2140 // this does not coexist with the real Keyspan 19qi driver!
2141 { USB_DEVICE (0x06cd, 0x010b),
2142 .driver_info = (unsigned long) &ez1_info,
2146 /*-------------------------------------------------------------*/
2149 /* iBOT2 makes a nice source of high speed bulk-in data */
2150 // this does not coexist with a real iBOT2 driver!
2151 { USB_DEVICE (0x0b62, 0x0059),
2152 .driver_info = (unsigned long) &ibot2_info,
2156 /*-------------------------------------------------------------*/
2159 /* module params can specify devices to use for control tests */
2160 { .driver_info = (unsigned long) &generic_info, },
2163 /*-------------------------------------------------------------*/
2167 MODULE_DEVICE_TABLE (usb, id_table);
2169 static struct usb_driver usbtest_driver = {
2171 .id_table = id_table,
2172 .probe = usbtest_probe,
2173 .ioctl = usbtest_ioctl,
2174 .disconnect = usbtest_disconnect,
2175 .suspend = usbtest_suspend,
2176 .resume = usbtest_resume,
2179 /*-------------------------------------------------------------------------*/
2181 static int __init usbtest_init (void)
2185 pr_debug("params: vend=0x%04x prod=0x%04x\n", vendor, product);
2187 return usb_register (&usbtest_driver);
2189 module_init (usbtest_init);
2191 static void __exit usbtest_exit (void)
2193 usb_deregister (&usbtest_driver);
2195 module_exit (usbtest_exit);
2197 MODULE_DESCRIPTION ("USB Core/HCD Testing Driver");
2198 MODULE_LICENSE ("GPL");