1 #include <linux/config.h>
2 #if !defined (DEBUG) && defined (CONFIG_USB_DEBUG)
5 #include <linux/kernel.h>
6 #include <linux/errno.h>
7 #include <linux/init.h>
8 #include <linux/slab.h>
10 #include <linux/module.h>
11 #include <linux/moduleparam.h>
12 #include <asm/scatterlist.h>
14 #include <linux/usb.h>
17 /*-------------------------------------------------------------------------*/
19 // FIXME make these public somewhere; usbdevfs.h?
21 struct usbtest_param {
23 unsigned test_num; /* 0..(TEST_CASES-1) */
30 struct timeval duration;
32 #define USBTEST_REQUEST _IOWR('U', 100, struct usbtest_param)
34 /*-------------------------------------------------------------------------*/
36 #define GENERIC /* let probe() bind using module params */
38 /* Some devices that can be used for testing will have "real" drivers.
39 * Entries for those need to be enabled here by hand, after disabling
42 //#define IBOT2 /* grab iBOT2 webcams */
43 //#define KEYSPAN_19Qi /* grab un-renumerated serial adapter */
45 /*-------------------------------------------------------------------------*/
49 u8 ep_in; /* bulk/intr source */
50 u8 ep_out; /* bulk/intr sink */
51 unsigned autoconf : 1;
52 unsigned ctrl_out : 1;
53 unsigned iso : 1; /* try iso in/out */
57 /* this is accessed only through usbfs ioctl calls.
58 * one ioctl to issue a test ... one lock per device.
59 * tests create other threads if they need them.
60 * urbs and buffers are allocated dynamically,
61 * and data generated deterministically.
64 struct usb_interface *intf;
65 struct usbtest_info *info;
70 struct usb_endpoint_descriptor *iso_in, *iso_out;
77 static struct usb_device *testdev_to_usbdev (struct usbtest_dev *test)
79 return interface_to_usbdev (test->intf);
82 /* set up all urbs so they can be used with either bulk or interrupt */
83 #define INTERRUPT_RATE 1 /* msec/transfer */
85 #define xprintk(tdev,level,fmt,args...) \
86 dev_printk(level , &(tdev)->intf->dev , fmt , ## args)
89 #define DBG(dev,fmt,args...) \
90 xprintk(dev , KERN_DEBUG , fmt , ## args)
92 #define DBG(dev,fmt,args...) \
99 #define VDBG(dev,fmt,args...) \
103 #define ERROR(dev,fmt,args...) \
104 xprintk(dev , KERN_ERR , fmt , ## args)
105 #define WARN(dev,fmt,args...) \
106 xprintk(dev , KERN_WARNING , fmt , ## args)
107 #define INFO(dev,fmt,args...) \
108 xprintk(dev , KERN_INFO , fmt , ## args)
110 /*-------------------------------------------------------------------------*/
113 get_endpoints (struct usbtest_dev *dev, struct usb_interface *intf)
116 struct usb_host_interface *alt;
117 struct usb_host_endpoint *in, *out;
118 struct usb_host_endpoint *iso_in, *iso_out;
119 struct usb_device *udev;
121 for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
125 iso_in = iso_out = NULL;
126 alt = intf->altsetting + tmp;
128 /* take the first altsetting with in-bulk + out-bulk;
129 * ignore other endpoints and altsetttings.
131 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
132 struct usb_host_endpoint *e;
134 e = alt->endpoint + ep;
135 switch (e->desc.bmAttributes) {
136 case USB_ENDPOINT_XFER_BULK:
138 case USB_ENDPOINT_XFER_ISOC:
145 if (e->desc.bEndpointAddress & USB_DIR_IN) {
154 if (e->desc.bEndpointAddress & USB_DIR_IN) {
162 if ((in && out) || (iso_in && iso_out))
168 udev = testdev_to_usbdev (dev);
169 if (alt->desc.bAlternateSetting != 0) {
170 tmp = usb_set_interface (udev,
171 alt->desc.bInterfaceNumber,
172 alt->desc.bAlternateSetting);
178 dev->in_pipe = usb_rcvbulkpipe (udev,
179 in->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
180 dev->out_pipe = usb_sndbulkpipe (udev,
181 out->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
184 dev->iso_in = &iso_in->desc;
185 dev->in_iso_pipe = usb_rcvisocpipe (udev,
186 iso_in->desc.bEndpointAddress
187 & USB_ENDPOINT_NUMBER_MASK);
188 dev->iso_out = &iso_out->desc;
189 dev->out_iso_pipe = usb_sndisocpipe (udev,
190 iso_out->desc.bEndpointAddress
191 & USB_ENDPOINT_NUMBER_MASK);
196 /*-------------------------------------------------------------------------*/
198 /* Support for testing basic non-queued I/O streams.
200 * These just package urbs as requests that can be easily canceled.
201 * Each urb's data buffer is dynamically allocated; callers can fill
202 * them with non-zero test data (or test for it) when appropriate.
205 static void simple_callback (struct urb *urb, struct pt_regs *regs)
207 complete ((struct completion *) urb->context);
210 static struct urb *simple_alloc_urb (
211 struct usb_device *udev,
220 urb = usb_alloc_urb (0, SLAB_KERNEL);
223 usb_fill_bulk_urb (urb, udev, pipe, NULL, bytes, simple_callback, NULL);
224 urb->interval = (udev->speed == USB_SPEED_HIGH)
225 ? (INTERRUPT_RATE << 3)
227 urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
228 if (usb_pipein (pipe))
229 urb->transfer_flags |= URB_SHORT_NOT_OK;
230 urb->transfer_buffer = usb_buffer_alloc (udev, bytes, SLAB_KERNEL,
232 if (!urb->transfer_buffer) {
236 memset (urb->transfer_buffer, 0, bytes);
240 static unsigned pattern = 0;
241 module_param (pattern, uint, S_IRUGO);
242 // MODULE_PARM_DESC (pattern, "i/o pattern (0 == zeroes)");
244 static inline void simple_fill_buf (struct urb *urb)
247 u8 *buf = urb->transfer_buffer;
248 unsigned len = urb->transfer_buffer_length;
254 memset (buf, 0, len);
257 for (i = 0; i < len; i++)
258 *buf++ = (u8) (i % 63);
263 static inline int simple_check_buf (struct urb *urb)
267 u8 *buf = urb->transfer_buffer;
268 unsigned len = urb->actual_length;
270 for (i = 0; i < len; i++, buf++) {
272 /* all-zeroes has no synchronization issues */
276 /* mod63 stays in sync with short-terminated transfers,
277 * or otherwise when host and gadget agree on how large
278 * each usb transfer request should be. resync is done
279 * with set_interface or set_config.
284 /* always fail unsupported patterns */
289 if (*buf == expected)
291 dbg ("buf[%d] = %d (not %d)", i, *buf, expected);
297 static void simple_free_urb (struct urb *urb)
299 usb_buffer_free (urb->dev, urb->transfer_buffer_length,
300 urb->transfer_buffer, urb->transfer_dma);
304 static int simple_io (
312 struct usb_device *udev = urb->dev;
313 int max = urb->transfer_buffer_length;
314 struct completion completion;
317 urb->context = &completion;
318 while (retval == 0 && iterations-- > 0) {
319 init_completion (&completion);
320 if (usb_pipeout (urb->pipe))
321 simple_fill_buf (urb);
322 if ((retval = usb_submit_urb (urb, SLAB_KERNEL)) != 0)
325 /* NOTE: no timeouts; can't be broken out of by interrupt */
326 wait_for_completion (&completion);
327 retval = urb->status;
329 if (retval == 0 && usb_pipein (urb->pipe))
330 retval = simple_check_buf (urb);
333 int len = urb->transfer_buffer_length;
338 len = (vary < max) ? vary : max;
339 urb->transfer_buffer_length = len;
342 /* FIXME if endpoint halted, clear halt (and log) */
344 urb->transfer_buffer_length = max;
346 if (expected != retval)
348 "%s failed, iterations left %d, status %d (not %d)\n",
349 label, iterations, retval, expected);
354 /*-------------------------------------------------------------------------*/
356 /* We use scatterlist primitives to test queued I/O.
357 * Yes, this also tests the scatterlist primitives.
360 static void free_sglist (struct scatterlist *sg, int nents)
366 for (i = 0; i < nents; i++) {
369 kfree (page_address (sg [i].page) + sg [i].offset);
374 static struct scatterlist *
375 alloc_sglist (int nents, int max, int vary)
377 struct scatterlist *sg;
381 sg = kmalloc (nents * sizeof *sg, SLAB_KERNEL);
384 memset (sg, 0, nents * sizeof *sg);
386 for (i = 0; i < nents; i++) {
389 buf = kmalloc (size, SLAB_KERNEL);
394 memset (buf, 0, size);
396 /* kmalloc pages are always physically contiguous! */
397 sg [i].page = virt_to_page (buf);
398 sg [i].offset = offset_in_page (buf);
399 sg [i].length = size;
405 size = (vary < max) ? vary : max;
412 static int perform_sglist (
413 struct usb_device *udev,
416 struct usb_sg_request *req,
417 struct scatterlist *sg,
423 while (retval == 0 && iterations-- > 0) {
424 retval = usb_sg_init (req, udev, pipe,
425 (udev->speed == USB_SPEED_HIGH)
426 ? (INTERRUPT_RATE << 3)
428 sg, nents, 0, SLAB_KERNEL);
433 retval = req->status;
435 /* FIXME if endpoint halted, clear halt (and log) */
438 // FIXME for unlink or fault handling tests, don't report
439 // failure if retval is as we expected ...
442 dbg ("perform_sglist failed, iterations left %d, status %d",
448 /*-------------------------------------------------------------------------*/
450 /* unqueued control message testing
452 * there's a nice set of device functional requirements in chapter 9 of the
453 * usb 2.0 spec, which we can apply to ANY device, even ones that don't use
454 * special test firmware.
456 * we know the device is configured (or suspended) by the time it's visible
457 * through usbfs. we can't change that, so we won't test enumeration (which
458 * worked 'well enough' to get here, this time), power management (ditto),
459 * or remote wakeup (which needs human interaction).
462 static unsigned realworld = 1;
463 module_param (realworld, uint, 0);
464 MODULE_PARM_DESC (realworld, "clear to demand stricter ch9 compliance");
466 static int get_altsetting (struct usbtest_dev *dev)
468 struct usb_interface *iface = dev->intf;
469 struct usb_device *udev = interface_to_usbdev (iface);
472 retval = usb_control_msg (udev, usb_rcvctrlpipe (udev, 0),
473 USB_REQ_GET_INTERFACE, USB_DIR_IN|USB_RECIP_INTERFACE,
474 0, iface->altsetting [0].desc.bInterfaceNumber,
475 dev->buf, 1, HZ * USB_CTRL_GET_TIMEOUT);
487 static int set_altsetting (struct usbtest_dev *dev, int alternate)
489 struct usb_interface *iface = dev->intf;
490 struct usb_device *udev;
492 if (alternate < 0 || alternate >= 256)
495 udev = interface_to_usbdev (iface);
496 return usb_set_interface (udev,
497 iface->altsetting [0].desc.bInterfaceNumber,
501 static int is_good_config (char *buf, int len)
503 struct usb_config_descriptor *config;
505 if (len < sizeof *config)
507 config = (struct usb_config_descriptor *) buf;
509 switch (config->bDescriptorType) {
511 case USB_DT_OTHER_SPEED_CONFIG:
512 if (config->bLength != 9) {
513 dbg ("bogus config descriptor length");
516 /* this bit 'must be 1' but often isn't */
517 if (!realworld && !(config->bmAttributes & 0x80)) {
518 dbg ("high bit of config attributes not set");
521 if (config->bmAttributes & 0x1f) { /* reserved == 0 */
522 dbg ("reserved config bits set");
530 le16_to_cpus (&config->wTotalLength);
531 if (config->wTotalLength == len) /* read it all */
533 if (config->wTotalLength >= TBUF_SIZE) /* max partial read */
535 dbg ("bogus config descriptor read size");
539 /* sanity test for standard requests working with usb_control_mesg() and some
540 * of the utility functions which use it.
542 * this doesn't test how endpoint halts behave or data toggles get set, since
543 * we won't do I/O to bulk/interrupt endpoints here (which is how to change
544 * halt or toggle). toggle testing is impractical without support from hcds.
546 * this avoids failing devices linux would normally work with, by not testing
547 * config/altsetting operations for devices that only support their defaults.
548 * such devices rarely support those needless operations.
550 * NOTE that since this is a sanity test, it's not examining boundary cases
551 * to see if usbcore, hcd, and device all behave right. such testing would
552 * involve varied read sizes and other operation sequences.
554 static int ch9_postconfig (struct usbtest_dev *dev)
556 struct usb_interface *iface = dev->intf;
557 struct usb_device *udev = interface_to_usbdev (iface);
560 /* [9.2.3] if there's more than one altsetting, we need to be able to
561 * set and get each one. mostly trusts the descriptors from usbcore.
563 for (i = 0; i < iface->num_altsetting; i++) {
565 /* 9.2.3 constrains the range here */
566 alt = iface->altsetting [i].desc.bAlternateSetting;
567 if (alt < 0 || alt >= iface->num_altsetting) {
568 dev_dbg (&iface->dev,
569 "invalid alt [%d].bAltSetting = %d\n",
573 /* [real world] get/set unimplemented if there's only one */
574 if (realworld && iface->num_altsetting == 1)
577 /* [9.4.10] set_interface */
578 retval = set_altsetting (dev, alt);
580 dev_dbg (&iface->dev, "can't set_interface = %d, %d\n",
585 /* [9.4.4] get_interface always works */
586 retval = get_altsetting (dev);
588 dev_dbg (&iface->dev, "get alt should be %d, was %d\n",
590 return (retval < 0) ? retval : -EDOM;
595 /* [real world] get_config unimplemented if there's only one */
596 if (!realworld || udev->descriptor.bNumConfigurations != 1) {
597 int expected = udev->actconfig->desc.bConfigurationValue;
599 /* [9.4.2] get_configuration always works
600 * ... although some cheap devices (like one TI Hub I've got)
601 * won't return config descriptors except before set_config.
603 retval = usb_control_msg (udev, usb_rcvctrlpipe (udev, 0),
604 USB_REQ_GET_CONFIGURATION,
605 USB_DIR_IN | USB_RECIP_DEVICE,
606 0, 0, dev->buf, 1, HZ * USB_CTRL_GET_TIMEOUT);
607 if (retval != 1 || dev->buf [0] != expected) {
608 dev_dbg (&iface->dev,
609 "get config --> %d (%d)\n", retval,
611 return (retval < 0) ? retval : -EDOM;
615 /* there's always [9.4.3] a device descriptor [9.6.1] */
616 retval = usb_get_descriptor (udev, USB_DT_DEVICE, 0,
617 dev->buf, sizeof udev->descriptor);
618 if (retval != sizeof udev->descriptor) {
619 dev_dbg (&iface->dev, "dev descriptor --> %d\n", retval);
620 return (retval < 0) ? retval : -EDOM;
623 /* there's always [9.4.3] at least one config descriptor [9.6.3] */
624 for (i = 0; i < udev->descriptor.bNumConfigurations; i++) {
625 retval = usb_get_descriptor (udev, USB_DT_CONFIG, i,
626 dev->buf, TBUF_SIZE);
627 if (!is_good_config (dev->buf, retval)) {
628 dev_dbg (&iface->dev,
629 "config [%d] descriptor --> %d\n",
631 return (retval < 0) ? retval : -EDOM;
634 // FIXME cross-checking udev->config[i] to make sure usbcore
635 // parsed it right (etc) would be good testing paranoia
638 /* and sometimes [9.2.6.6] speed dependent descriptors */
639 if (udev->descriptor.bcdUSB == 0x0200) { /* pre-swapped */
640 struct usb_qualifier_descriptor *d = NULL;
642 /* device qualifier [9.6.2] */
643 retval = usb_get_descriptor (udev,
644 USB_DT_DEVICE_QUALIFIER, 0, dev->buf,
645 sizeof (struct usb_qualifier_descriptor));
646 if (retval == -EPIPE) {
647 if (udev->speed == USB_SPEED_HIGH) {
648 dev_dbg (&iface->dev,
649 "hs dev qualifier --> %d\n",
651 return (retval < 0) ? retval : -EDOM;
653 /* usb2.0 but not high-speed capable; fine */
654 } else if (retval != sizeof (struct usb_qualifier_descriptor)) {
655 dev_dbg (&iface->dev, "dev qualifier --> %d\n", retval);
656 return (retval < 0) ? retval : -EDOM;
658 d = (struct usb_qualifier_descriptor *) dev->buf;
660 /* might not have [9.6.2] any other-speed configs [9.6.4] */
662 unsigned max = d->bNumConfigurations;
663 for (i = 0; i < max; i++) {
664 retval = usb_get_descriptor (udev,
665 USB_DT_OTHER_SPEED_CONFIG, i,
666 dev->buf, TBUF_SIZE);
667 if (!is_good_config (dev->buf, retval)) {
668 dev_dbg (&iface->dev,
669 "other speed config --> %d\n",
671 return (retval < 0) ? retval : -EDOM;
676 // FIXME fetch strings from at least the device descriptor
678 /* [9.4.5] get_status always works */
679 retval = usb_get_status (udev, USB_RECIP_DEVICE, 0, dev->buf);
681 dev_dbg (&iface->dev, "get dev status --> %d\n", retval);
682 return (retval < 0) ? retval : -EDOM;
685 // FIXME configuration.bmAttributes says if we could try to set/clear
686 // the device's remote wakeup feature ... if we can, test that here
688 retval = usb_get_status (udev, USB_RECIP_INTERFACE,
689 iface->altsetting [0].desc.bInterfaceNumber, dev->buf);
691 dev_dbg (&iface->dev, "get interface status --> %d\n", retval);
692 return (retval < 0) ? retval : -EDOM;
694 // FIXME get status for each endpoint in the interface
699 /*-------------------------------------------------------------------------*/
701 /* use ch9 requests to test whether:
702 * (a) queues work for control, keeping N subtests queued and
703 * active (auto-resubmit) for M loops through the queue.
704 * (b) protocol stalls (control-only) will autorecover.
705 * it's not like bulk/intr; no halt clearing.
706 * (c) short control reads are reported and handled.
707 * (d) queues are always processed in-order
712 struct usbtest_dev *dev;
713 struct completion complete;
718 struct usbtest_param *param;
722 #define NUM_SUBCASES 15 /* how many test subcases here? */
725 struct usb_ctrlrequest setup;
730 static void ctrl_complete (struct urb *urb, struct pt_regs *regs)
732 struct ctrl_ctx *ctx = urb->context;
733 struct usb_ctrlrequest *reqp;
734 struct subcase *subcase;
735 int status = urb->status;
737 reqp = (struct usb_ctrlrequest *)urb->setup_packet;
738 subcase = container_of (reqp, struct subcase, setup);
740 spin_lock (&ctx->lock);
744 /* queue must transfer and complete in fifo order, unless
745 * usb_unlink_urb() is used to unlink something not at the
746 * physical queue head (not tested).
748 if (subcase->number > 0) {
749 if ((subcase->number - ctx->last) != 1) {
750 dbg ("subcase %d completed out of order, last %d",
751 subcase->number, ctx->last);
753 ctx->last = subcase->number;
757 ctx->last = subcase->number;
759 /* succeed or fault in only one way? */
760 if (status == subcase->expected)
763 /* async unlink for cleanup? */
764 else if (status != -ECONNRESET) {
766 /* some faults are allowed, not required */
767 if (subcase->expected > 0 && (
768 ((urb->status == -subcase->expected /* happened */
769 || urb->status == 0)))) /* didn't */
771 /* sometimes more than one fault is allowed */
772 else if (subcase->number == 12 && status == -EPIPE)
775 dbg ("subtest %d error, status %d",
776 subcase->number, status);
779 /* unexpected status codes mean errors; ideally, in hardware */
782 if (ctx->status == 0) {
785 ctx->status = status;
786 info ("control queue %02x.%02x, err %d, %d left",
787 reqp->bRequestType, reqp->bRequest,
790 /* FIXME this "unlink everything" exit route should
791 * be a separate test case.
794 /* unlink whatever's still pending */
795 for (i = 1; i < ctx->param->sglen; i++) {
796 struct urb *u = ctx->urb [
797 (i + subcase->number) % ctx->param->sglen];
799 if (u == urb || !u->dev)
801 status = usb_unlink_urb (u);
808 dbg ("urb unlink --> %d", status);
811 status = ctx->status;
815 /* resubmit if we need to, else mark this as done */
816 if ((status == 0) && (ctx->pending < ctx->count)) {
817 if ((status = usb_submit_urb (urb, SLAB_ATOMIC)) != 0) {
818 dbg ("can't resubmit ctrl %02x.%02x, err %d",
819 reqp->bRequestType, reqp->bRequest, status);
826 /* signal completion when nothing's queued */
827 if (ctx->pending == 0)
828 complete (&ctx->complete);
829 spin_unlock (&ctx->lock);
833 test_ctrl_queue (struct usbtest_dev *dev, struct usbtest_param *param)
835 struct usb_device *udev = testdev_to_usbdev (dev);
837 struct ctrl_ctx context;
840 spin_lock_init (&context.lock);
842 init_completion (&context.complete);
843 context.count = param->sglen * param->iterations;
845 context.status = -ENOMEM;
846 context.param = param;
849 /* allocate and init the urbs we'll queue.
850 * as with bulk/intr sglists, sglen is the queue depth; it also
851 * controls which subtests run (more tests than sglen) or rerun.
853 urb = kmalloc (param->sglen * sizeof (struct urb *), SLAB_KERNEL);
856 memset (urb, 0, param->sglen * sizeof (struct urb *));
857 for (i = 0; i < param->sglen; i++) {
858 int pipe = usb_rcvctrlpipe (udev, 0);
861 struct usb_ctrlrequest req;
862 struct subcase *reqp;
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 (USUALLY STALLS)
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->epmaxpacketin [0];
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->epmaxpacketin [0];
965 case 8: len = 24; break;
966 case 16: len = 32; break;
968 expected = -EREMOTEIO;
971 err ("bogus number of ctrl queue testcases!");
972 context.status = -EINVAL;
975 req.wLength = cpu_to_le16 (len);
976 urb [i] = u = simple_alloc_urb (udev, pipe, len);
980 reqp = usb_buffer_alloc (udev, sizeof *reqp, SLAB_KERNEL,
985 reqp->number = i % NUM_SUBCASES;
986 reqp->expected = expected;
987 u->setup_packet = (char *) &reqp->setup;
989 u->context = &context;
990 u->complete = ctrl_complete;
991 u->transfer_flags |= URB_ASYNC_UNLINK;
996 spin_lock_irq (&context.lock);
997 for (i = 0; i < param->sglen; i++) {
998 context.status = usb_submit_urb (urb [i], SLAB_ATOMIC);
999 if (context.status != 0) {
1000 dbg ("can't submit urb[%d], status %d",
1002 context.count = context.pending;
1007 spin_unlock_irq (&context.lock);
1009 /* FIXME set timer and time out; provide a disconnect hook */
1011 /* wait for the last one to complete */
1012 if (context.pending > 0)
1013 wait_for_completion (&context.complete);
1016 for (i = 0; i < param->sglen; i++) {
1019 urb [i]->dev = udev;
1020 if (urb [i]->setup_packet)
1021 usb_buffer_free (udev, sizeof (struct usb_ctrlrequest),
1022 urb [i]->setup_packet,
1023 urb [i]->setup_dma);
1024 simple_free_urb (urb [i]);
1027 return context.status;
1032 /*-------------------------------------------------------------------------*/
1034 static void unlink1_callback (struct urb *urb, struct pt_regs *regs)
1036 int status = urb->status;
1038 // we "know" -EPIPE (stall) never happens
1040 status = usb_submit_urb (urb, SLAB_ATOMIC);
1042 urb->status = status;
1043 complete ((struct completion *) urb->context);
1047 static int unlink1 (struct usbtest_dev *dev, int pipe, int size, int async)
1050 struct completion completion;
1053 init_completion (&completion);
1054 urb = simple_alloc_urb (testdev_to_usbdev (dev), pipe, size);
1058 urb->transfer_flags |= URB_ASYNC_UNLINK;
1059 urb->context = &completion;
1060 urb->complete = unlink1_callback;
1062 /* keep the endpoint busy. there are lots of hc/hcd-internal
1063 * states, and testing should get to all of them over time.
1065 * FIXME want additional tests for when endpoint is STALLing
1066 * due to errors, or is just NAKing requests.
1068 if ((retval = usb_submit_urb (urb, SLAB_KERNEL)) != 0) {
1069 dev_dbg (&dev->intf->dev, "submit fail %d\n", retval);
1073 /* unlinking that should always work. variable delay tests more
1074 * hcd states and code paths, even with little other system load.
1076 msleep (jiffies % (2 * INTERRUPT_RATE));
1078 retval = usb_unlink_urb (urb);
1079 if (retval == -EBUSY || retval == -EIDRM) {
1080 /* we can't unlink urbs while they're completing.
1081 * or if they've completed, and we haven't resubmitted.
1082 * "normal" drivers would prevent resubmission, but
1083 * since we're testing unlink paths, we can't.
1085 dev_dbg (&dev->intf->dev, "unlink retry\n");
1088 if (!(retval == 0 || retval == -EINPROGRESS)) {
1089 dev_dbg (&dev->intf->dev, "unlink fail %d\n", retval);
1093 wait_for_completion (&completion);
1094 retval = urb->status;
1095 simple_free_urb (urb);
1098 return (retval != -ECONNRESET) ? -ECONNRESET : 0;
1100 return (retval != -ENOENT) ? -ENOENT : 0;
1103 static int unlink_simple (struct usbtest_dev *dev, int pipe, int len)
1107 /* test sync and async paths */
1108 retval = unlink1 (dev, pipe, len, 1);
1110 retval = unlink1 (dev, pipe, len, 0);
1114 /*-------------------------------------------------------------------------*/
1116 static int verify_not_halted (int ep, struct urb *urb)
1121 /* shouldn't look or act halted */
1122 retval = usb_get_status (urb->dev, USB_RECIP_ENDPOINT, ep, &status);
1124 dbg ("ep %02x couldn't get no-halt status, %d", ep, retval);
1128 dbg ("ep %02x bogus status: %04x != 0", ep, status);
1131 retval = simple_io (urb, 1, 0, 0, __FUNCTION__);
1137 static int verify_halted (int ep, struct urb *urb)
1142 /* should look and act halted */
1143 retval = usb_get_status (urb->dev, USB_RECIP_ENDPOINT, ep, &status);
1145 dbg ("ep %02x couldn't get halt status, %d", ep, retval);
1149 dbg ("ep %02x bogus status: %04x != 1", ep, status);
1152 retval = simple_io (urb, 1, 0, -EPIPE, __FUNCTION__);
1153 if (retval != -EPIPE)
1155 retval = simple_io (urb, 1, 0, -EPIPE, "verify_still_halted");
1156 if (retval != -EPIPE)
1161 static int test_halt (int ep, struct urb *urb)
1165 /* shouldn't look or act halted now */
1166 retval = verify_not_halted (ep, urb);
1170 /* set halt (protocol test only), verify it worked */
1171 retval = usb_control_msg (urb->dev, usb_sndctrlpipe (urb->dev, 0),
1172 USB_REQ_SET_FEATURE, USB_RECIP_ENDPOINT,
1173 USB_ENDPOINT_HALT, ep,
1174 NULL, 0, HZ * USB_CTRL_SET_TIMEOUT);
1176 dbg ("ep %02x couldn't set halt, %d", ep, retval);
1179 retval = verify_halted (ep, urb);
1183 /* clear halt (tests API + protocol), verify it worked */
1184 retval = usb_clear_halt (urb->dev, urb->pipe);
1186 dbg ("ep %02x couldn't clear halt, %d", ep, retval);
1189 retval = verify_not_halted (ep, urb);
1193 /* NOTE: could also verify SET_INTERFACE clear halts ... */
1198 static int halt_simple (struct usbtest_dev *dev)
1204 urb = simple_alloc_urb (testdev_to_usbdev (dev), 0, 512);
1209 ep = usb_pipeendpoint (dev->in_pipe) | USB_DIR_IN;
1210 urb->pipe = dev->in_pipe;
1211 retval = test_halt (ep, urb);
1216 if (dev->out_pipe) {
1217 ep = usb_pipeendpoint (dev->out_pipe);
1218 urb->pipe = dev->out_pipe;
1219 retval = test_halt (ep, urb);
1222 simple_free_urb (urb);
1226 /*-------------------------------------------------------------------------*/
1228 /* Control OUT tests use the vendor control requests from Intel's
1229 * USB 2.0 compliance test device: write a buffer, read it back.
1231 * Intel's spec only _requires_ that it work for one packet, which
1232 * is pretty weak. Some HCDs place limits here; most devices will
1233 * need to be able to handle more than one OUT data packet. We'll
1234 * try whatever we're told to try.
1236 static int ctrl_out (struct usbtest_dev *dev,
1237 unsigned count, unsigned length, unsigned vary)
1239 unsigned i, j, len, retval;
1242 struct usb_device *udev;
1244 if (length > 0xffff || vary >= length)
1247 buf = kmalloc(length, SLAB_KERNEL);
1251 udev = testdev_to_usbdev (dev);
1255 /* NOTE: hardware might well act differently if we pushed it
1256 * with lots back-to-back queued requests.
1258 for (i = 0; i < count; i++) {
1259 /* write patterned data */
1260 for (j = 0; j < len; j++)
1262 retval = usb_control_msg (udev, usb_sndctrlpipe (udev,0),
1263 0x5b, USB_DIR_OUT|USB_TYPE_VENDOR,
1264 0, 0, buf, len, HZ * USB_CTRL_SET_TIMEOUT);
1265 if (retval != len) {
1270 /* read it back -- assuming nothing intervened!! */
1271 retval = usb_control_msg (udev, usb_rcvctrlpipe (udev,0),
1272 0x5c, USB_DIR_IN|USB_TYPE_VENDOR,
1273 0, 0, buf, len, HZ * USB_CTRL_GET_TIMEOUT);
1274 if (retval != len) {
1279 /* fail if we can't verify */
1280 for (j = 0; j < len; j++) {
1281 if (buf [j] != (u8) (i + j)) {
1282 INFO (dev, "ctrl_out, byte %d is %d not %d\n",
1283 j, buf [j], (u8) i + j);
1299 INFO (dev, "ctrl_out %s failed, code %d, count %d\n",
1306 /*-------------------------------------------------------------------------*/
1308 /* ISO tests ... mimics common usage
1309 * - buffer length is split into N packets (mostly maxpacket sized)
1310 * - multi-buffers according to sglen
1313 struct iso_context {
1317 struct completion done;
1318 unsigned long errors;
1319 struct usbtest_dev *dev;
1322 static void iso_callback (struct urb *urb, struct pt_regs *regs)
1324 struct iso_context *ctx = urb->context;
1326 spin_lock(&ctx->lock);
1329 if (urb->error_count > 0)
1330 ctx->errors += urb->error_count;
1332 if (urb->status == 0 && ctx->count > (ctx->pending - 1)) {
1333 int status = usb_submit_urb (urb, GFP_ATOMIC);
1338 dev_dbg (&ctx->dev->intf->dev,
1339 "iso resubmit err %d\n",
1342 case -ENODEV: /* disconnected */
1346 simple_free_urb (urb);
1349 if (ctx->pending == 0) {
1351 dev_dbg (&ctx->dev->intf->dev,
1352 "iso test, %lu errors\n",
1354 complete (&ctx->done);
1357 spin_unlock(&ctx->lock);
1360 static struct urb *iso_alloc_urb (
1361 struct usb_device *udev,
1363 struct usb_endpoint_descriptor *desc,
1368 unsigned i, maxp, packets;
1370 if (bytes < 0 || !desc)
1372 maxp = 0x7ff & desc->wMaxPacketSize;
1373 maxp *= 1 + (0x3 & (desc->wMaxPacketSize >> 11));
1374 packets = (bytes + maxp - 1) / maxp;
1376 urb = usb_alloc_urb (packets, SLAB_KERNEL);
1382 urb->number_of_packets = packets;
1383 urb->transfer_buffer_length = bytes;
1384 urb->transfer_buffer = usb_buffer_alloc (udev, bytes, SLAB_KERNEL,
1385 &urb->transfer_dma);
1386 if (!urb->transfer_buffer) {
1390 memset (urb->transfer_buffer, 0, bytes);
1391 for (i = 0; i < packets; i++) {
1392 /* here, only the last packet will be short */
1393 urb->iso_frame_desc[i].length = min ((unsigned) bytes, maxp);
1394 bytes -= urb->iso_frame_desc[i].length;
1396 urb->iso_frame_desc[i].offset = maxp * i;
1399 urb->complete = iso_callback;
1400 // urb->context = SET BY CALLER
1401 urb->interval = 1 << (desc->bInterval - 1);
1402 urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
1407 test_iso_queue (struct usbtest_dev *dev, struct usbtest_param *param,
1408 int pipe, struct usb_endpoint_descriptor *desc)
1410 struct iso_context context;
1411 struct usb_device *udev;
1413 unsigned long packets = 0;
1415 struct urb *urbs[10]; /* FIXME no limit */
1417 if (param->sglen > 10)
1420 context.count = param->iterations * param->sglen;
1421 context.pending = param->sglen;
1424 init_completion (&context.done);
1425 spin_lock_init (&context.lock);
1427 memset (urbs, 0, sizeof urbs);
1428 udev = testdev_to_usbdev (dev);
1429 dev_dbg (&dev->intf->dev,
1430 "... iso period %d %sframes, wMaxPacket %04x\n",
1431 1 << (desc->bInterval - 1),
1432 (udev->speed == USB_SPEED_HIGH) ? "micro" : "",
1433 desc->wMaxPacketSize);
1435 for (i = 0; i < param->sglen; i++) {
1436 urbs [i] = iso_alloc_urb (udev, pipe, desc,
1442 packets += urbs[i]->number_of_packets;
1443 urbs [i]->context = &context;
1445 packets *= param->iterations;
1446 dev_dbg (&dev->intf->dev,
1447 "... total %lu msec (%lu packets)\n",
1448 (packets * (1 << (desc->bInterval - 1)))
1449 / ((udev->speed == USB_SPEED_HIGH) ? 8 : 1),
1452 spin_lock_irq (&context.lock);
1453 for (i = 0; i < param->sglen; i++) {
1454 status = usb_submit_urb (urbs [i], SLAB_ATOMIC);
1456 ERROR (dev, "submit iso[%d], error %d\n", i, status);
1460 simple_free_urb (urbs [i]);
1464 spin_unlock_irq (&context.lock);
1466 wait_for_completion (&context.done);
1470 for (i = 0; i < param->sglen; i++) {
1472 simple_free_urb (urbs [i]);
1477 /*-------------------------------------------------------------------------*/
1479 /* We only have this one interface to user space, through usbfs.
1480 * User mode code can scan usbfs to find N different devices (maybe on
1481 * different busses) to use when testing, and allocate one thread per
1482 * test. So discovery is simplified, and we have no device naming issues.
1484 * Don't use these only as stress/load tests. Use them along with with
1485 * other USB bus activity: plugging, unplugging, mousing, mp3 playback,
1486 * video capture, and so on. Run different tests at different times, in
1487 * different sequences. Nothing here should interact with other devices,
1488 * except indirectly by consuming USB bandwidth and CPU resources for test
1489 * threads and request completion. But the only way to know that for sure
1490 * is to test when HC queues are in use by many devices.
1494 usbtest_ioctl (struct usb_interface *intf, unsigned int code, void *buf)
1496 struct usbtest_dev *dev = usb_get_intfdata (intf);
1497 struct usb_device *udev = testdev_to_usbdev (dev);
1498 struct usbtest_param *param = buf;
1499 int retval = -EOPNOTSUPP;
1501 struct scatterlist *sg;
1502 struct usb_sg_request req;
1503 struct timeval start;
1506 // FIXME USBDEVFS_CONNECTINFO doesn't say how fast the device is.
1508 if (code != USBTEST_REQUEST)
1511 if (param->iterations <= 0 || param->length < 0
1512 || param->sglen < 0 || param->vary < 0)
1515 if (down_interruptible (&dev->sem))
1516 return -ERESTARTSYS;
1518 /* some devices, like ez-usb default devices, need a non-default
1519 * altsetting to have any active endpoints. some tests change
1520 * altsettings; force a default so most tests don't need to check.
1522 if (dev->info->alt >= 0) {
1525 if (intf->altsetting->desc.bInterfaceNumber) {
1529 res = set_altsetting (dev, dev->info->alt);
1531 dev_err (&intf->dev,
1532 "set altsetting to %d failed, %d\n",
1533 dev->info->alt, res);
1540 * Just a bunch of test cases that every HCD is expected to handle.
1542 * Some may need specific firmware, though it'd be good to have
1543 * one firmware image to handle all the test cases.
1545 * FIXME add more tests! cancel requests, verify the data, control
1546 * queueing, concurrent read+write threads, and so on.
1548 do_gettimeofday (&start);
1549 switch (param->test_num) {
1552 dev_dbg (&intf->dev, "TEST 0: NOP\n");
1556 /* Simple non-queued bulk I/O tests */
1558 if (dev->out_pipe == 0)
1560 dev_dbg (&intf->dev,
1561 "TEST 1: write %d bytes %u times\n",
1562 param->length, param->iterations);
1563 urb = simple_alloc_urb (udev, dev->out_pipe, param->length);
1568 // FIRMWARE: bulk sink (maybe accepts short writes)
1569 retval = simple_io (urb, param->iterations, 0, 0, "test1");
1570 simple_free_urb (urb);
1573 if (dev->in_pipe == 0)
1575 dev_dbg (&intf->dev,
1576 "TEST 2: read %d bytes %u times\n",
1577 param->length, param->iterations);
1578 urb = simple_alloc_urb (udev, dev->in_pipe, param->length);
1583 // FIRMWARE: bulk source (maybe generates short writes)
1584 retval = simple_io (urb, param->iterations, 0, 0, "test2");
1585 simple_free_urb (urb);
1588 if (dev->out_pipe == 0 || param->vary == 0)
1590 dev_dbg (&intf->dev,
1591 "TEST 3: write/%d 0..%d bytes %u times\n",
1592 param->vary, param->length, param->iterations);
1593 urb = simple_alloc_urb (udev, dev->out_pipe, param->length);
1598 // FIRMWARE: bulk sink (maybe accepts short writes)
1599 retval = simple_io (urb, param->iterations, param->vary,
1601 simple_free_urb (urb);
1604 if (dev->in_pipe == 0 || param->vary == 0)
1606 dev_dbg (&intf->dev,
1607 "TEST 4: read/%d 0..%d bytes %u times\n",
1608 param->vary, param->length, param->iterations);
1609 urb = simple_alloc_urb (udev, dev->in_pipe, param->length);
1614 // FIRMWARE: bulk source (maybe generates short writes)
1615 retval = simple_io (urb, param->iterations, param->vary,
1617 simple_free_urb (urb);
1620 /* Queued bulk I/O tests */
1622 if (dev->out_pipe == 0 || param->sglen == 0)
1624 dev_dbg (&intf->dev,
1625 "TEST 5: write %d sglists %d entries of %d bytes\n",
1627 param->sglen, param->length);
1628 sg = alloc_sglist (param->sglen, param->length, 0);
1633 // FIRMWARE: bulk sink (maybe accepts short writes)
1634 retval = perform_sglist (udev, param->iterations, dev->out_pipe,
1635 &req, sg, param->sglen);
1636 free_sglist (sg, param->sglen);
1640 if (dev->in_pipe == 0 || param->sglen == 0)
1642 dev_dbg (&intf->dev,
1643 "TEST 6: read %d sglists %d entries of %d bytes\n",
1645 param->sglen, param->length);
1646 sg = alloc_sglist (param->sglen, param->length, 0);
1651 // FIRMWARE: bulk source (maybe generates short writes)
1652 retval = perform_sglist (udev, param->iterations, dev->in_pipe,
1653 &req, sg, param->sglen);
1654 free_sglist (sg, param->sglen);
1657 if (dev->out_pipe == 0 || param->sglen == 0 || param->vary == 0)
1659 dev_dbg (&intf->dev,
1660 "TEST 7: write/%d %d sglists %d entries 0..%d bytes\n",
1661 param->vary, param->iterations,
1662 param->sglen, param->length);
1663 sg = alloc_sglist (param->sglen, param->length, param->vary);
1668 // FIRMWARE: bulk sink (maybe accepts short writes)
1669 retval = perform_sglist (udev, param->iterations, dev->out_pipe,
1670 &req, sg, param->sglen);
1671 free_sglist (sg, param->sglen);
1674 if (dev->in_pipe == 0 || param->sglen == 0 || param->vary == 0)
1676 dev_dbg (&intf->dev,
1677 "TEST 8: read/%d %d sglists %d entries 0..%d bytes\n",
1678 param->vary, param->iterations,
1679 param->sglen, param->length);
1680 sg = alloc_sglist (param->sglen, param->length, param->vary);
1685 // FIRMWARE: bulk source (maybe generates short writes)
1686 retval = perform_sglist (udev, param->iterations, dev->in_pipe,
1687 &req, sg, param->sglen);
1688 free_sglist (sg, param->sglen);
1691 /* non-queued sanity tests for control (chapter 9 subset) */
1694 dev_dbg (&intf->dev,
1695 "TEST 9: ch9 (subset) control tests, %d times\n",
1697 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1698 retval = ch9_postconfig (dev);
1700 dbg ("ch9 subset failed, iterations left %d", i);
1703 /* queued control messaging */
1705 if (param->sglen == 0)
1708 dev_dbg (&intf->dev,
1709 "TEST 10: queue %d control calls, %d times\n",
1712 retval = test_ctrl_queue (dev, param);
1715 /* simple non-queued unlinks (ring with one urb) */
1717 if (dev->in_pipe == 0 || !param->length)
1720 dev_dbg (&intf->dev, "TEST 11: unlink %d reads of %d\n",
1721 param->iterations, param->length);
1722 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1723 retval = unlink_simple (dev, dev->in_pipe,
1726 dev_dbg (&intf->dev, "unlink reads failed %d, "
1727 "iterations left %d\n", retval, i);
1730 if (dev->out_pipe == 0 || !param->length)
1733 dev_dbg (&intf->dev, "TEST 12: unlink %d writes of %d\n",
1734 param->iterations, param->length);
1735 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1736 retval = unlink_simple (dev, dev->out_pipe,
1739 dev_dbg (&intf->dev, "unlink writes failed %d, "
1740 "iterations left %d\n", retval, i);
1745 if (dev->out_pipe == 0 && dev->in_pipe == 0)
1748 dev_dbg (&intf->dev, "TEST 13: set/clear %d halts\n",
1750 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1751 retval = halt_simple (dev);
1754 DBG (dev, "halts failed, iterations left %d\n", i);
1757 /* control write tests */
1759 if (!dev->info->ctrl_out)
1761 dev_dbg (&intf->dev, "TEST 14: %d ep0out, 0..%d vary %d\n",
1762 param->iterations, param->length, param->vary);
1763 retval = ctrl_out (dev, param->iterations,
1764 param->length, param->vary);
1767 /* iso write tests */
1769 if (dev->out_iso_pipe == 0 || param->sglen == 0)
1771 dev_dbg (&intf->dev,
1772 "TEST 15: write %d iso, %d entries of %d bytes\n",
1774 param->sglen, param->length);
1775 // FIRMWARE: iso sink
1776 retval = test_iso_queue (dev, param,
1777 dev->out_iso_pipe, dev->iso_out);
1780 /* iso read tests */
1782 if (dev->in_iso_pipe == 0 || param->sglen == 0)
1784 dev_dbg (&intf->dev,
1785 "TEST 16: read %d iso, %d entries of %d bytes\n",
1787 param->sglen, param->length);
1788 // FIRMWARE: iso source
1789 retval = test_iso_queue (dev, param,
1790 dev->in_iso_pipe, dev->iso_in);
1793 // FIXME unlink from queue (ring with N urbs)
1795 // FIXME scatterlist cancel (needs helper thread)
1798 do_gettimeofday (¶m->duration);
1799 param->duration.tv_sec -= start.tv_sec;
1800 param->duration.tv_usec -= start.tv_usec;
1801 if (param->duration.tv_usec < 0) {
1802 param->duration.tv_usec += 1000 * 1000;
1803 param->duration.tv_sec -= 1;
1809 /*-------------------------------------------------------------------------*/
1811 static unsigned force_interrupt = 0;
1812 module_param (force_interrupt, uint, 0);
1813 MODULE_PARM_DESC (force_interrupt, "0 = test default; else interrupt");
1816 static unsigned short vendor;
1817 module_param(vendor, ushort, 0);
1818 MODULE_PARM_DESC (vendor, "vendor code (from usb-if)");
1820 static unsigned short product;
1821 module_param(product, ushort, 0);
1822 MODULE_PARM_DESC (product, "product code (from vendor)");
1826 usbtest_probe (struct usb_interface *intf, const struct usb_device_id *id)
1828 struct usb_device *udev;
1829 struct usbtest_dev *dev;
1830 struct usbtest_info *info;
1831 char *rtest, *wtest;
1832 char *irtest, *iwtest;
1834 udev = interface_to_usbdev (intf);
1837 /* specify devices by module parameters? */
1838 if (id->match_flags == 0) {
1839 /* vendor match required, product match optional */
1840 if (!vendor || udev->descriptor.idVendor != (u16)vendor)
1842 if (product && udev->descriptor.idProduct != (u16)product)
1844 dbg ("matched module params, vend=0x%04x prod=0x%04x",
1845 udev->descriptor.idVendor,
1846 udev->descriptor.idProduct);
1850 dev = kmalloc (sizeof *dev, SLAB_KERNEL);
1853 memset (dev, 0, sizeof *dev);
1854 info = (struct usbtest_info *) id->driver_info;
1856 init_MUTEX (&dev->sem);
1860 /* cacheline-aligned scratch for i/o */
1861 if ((dev->buf = kmalloc (TBUF_SIZE, SLAB_KERNEL)) == 0) {
1866 /* NOTE this doesn't yet test the handful of difference that are
1867 * visible with high speed interrupts: bigger maxpacket (1K) and
1868 * "high bandwidth" modes (up to 3 packets/uframe).
1871 irtest = iwtest = "";
1872 if (force_interrupt || udev->speed == USB_SPEED_LOW) {
1874 dev->in_pipe = usb_rcvintpipe (udev, info->ep_in);
1878 dev->out_pipe = usb_sndintpipe (udev, info->ep_out);
1879 wtest = " intr-out";
1882 if (info->autoconf) {
1885 status = get_endpoints (dev, intf);
1887 dbg ("couldn't get endpoints, %d\n", status);
1890 /* may find bulk or ISO pipes */
1893 dev->in_pipe = usb_rcvbulkpipe (udev,
1896 dev->out_pipe = usb_sndbulkpipe (udev,
1902 wtest = " bulk-out";
1903 if (dev->in_iso_pipe)
1905 if (dev->out_iso_pipe)
1906 iwtest = " iso-out";
1909 usb_set_intfdata (intf, dev);
1910 dev_info (&intf->dev, "%s\n", info->name);
1911 dev_info (&intf->dev, "%s speed {control%s%s%s%s%s} tests%s\n",
1913 switch (udev->speed) {
1914 case USB_SPEED_LOW: tmp = "low"; break;
1915 case USB_SPEED_FULL: tmp = "full"; break;
1916 case USB_SPEED_HIGH: tmp = "high"; break;
1917 default: tmp = "unknown"; break;
1919 info->ctrl_out ? " in/out" : "",
1922 info->alt >= 0 ? " (+alt)" : "");
1926 static void usbtest_disconnect (struct usb_interface *intf)
1928 struct usbtest_dev *dev = usb_get_intfdata (intf);
1932 usb_set_intfdata (intf, NULL);
1933 dev_dbg (&intf->dev, "disconnect\n");
1937 /* Basic testing only needs a device that can source or sink bulk traffic.
1938 * Any device can test control transfers (default with GENERIC binding).
1940 * Several entries work with the default EP0 implementation that's built
1941 * into EZ-USB chips. There's a default vendor ID which can be overridden
1942 * by (very) small config EEPROMS, but otherwise all these devices act
1943 * identically until firmware is loaded: only EP0 works. It turns out
1944 * to be easy to make other endpoints work, without modifying that EP0
1945 * behavior. For now, we expect that kind of firmware.
1948 /* an21xx or fx versions of ez-usb */
1949 static struct usbtest_info ez1_info = {
1950 .name = "EZ-USB device",
1956 /* fx2 version of ez-usb */
1957 static struct usbtest_info ez2_info = {
1958 .name = "FX2 device",
1964 /* ezusb family device with dedicated usb test firmware,
1966 static struct usbtest_info fw_info = {
1967 .name = "usb test device",
1971 .autoconf = 1, // iso and ctrl_out need autoconf
1973 .iso = 1, // iso_ep's are #8 in/out
1976 /* peripheral running Linux and 'zero.c' test firmware, or
1977 * its user-mode cousin. different versions of this use
1978 * different hardware with the same vendor/product codes.
1979 * host side MUST rely on the endpoint descriptors.
1981 static struct usbtest_info gz_info = {
1982 .name = "Linux gadget zero",
1988 static struct usbtest_info um_info = {
1989 .name = "Linux user mode test driver",
1994 static struct usbtest_info um2_info = {
1995 .name = "Linux user mode ISO test driver",
2002 /* this is a nice source of high speed bulk data;
2003 * uses an FX2, with firmware provided in the device
2005 static struct usbtest_info ibot2_info = {
2006 .name = "iBOT2 webcam",
2013 /* we can use any device to test control traffic */
2014 static struct usbtest_info generic_info = {
2015 .name = "Generic USB device",
2020 // FIXME remove this
2021 static struct usbtest_info hact_info = {
2029 static struct usb_device_id id_table [] = {
2031 { USB_DEVICE (0x0547, 0x1002),
2032 .driver_info = (unsigned long) &hact_info,
2035 /*-------------------------------------------------------------*/
2037 /* EZ-USB devices which download firmware to replace (or in our
2038 * case augment) the default device implementation.
2041 /* generic EZ-USB FX controller */
2042 { USB_DEVICE (0x0547, 0x2235),
2043 .driver_info = (unsigned long) &ez1_info,
2046 /* CY3671 development board with EZ-USB FX */
2047 { USB_DEVICE (0x0547, 0x0080),
2048 .driver_info = (unsigned long) &ez1_info,
2051 /* generic EZ-USB FX2 controller (or development board) */
2052 { USB_DEVICE (0x04b4, 0x8613),
2053 .driver_info = (unsigned long) &ez2_info,
2056 /* re-enumerated usb test device firmware */
2057 { USB_DEVICE (0xfff0, 0xfff0),
2058 .driver_info = (unsigned long) &fw_info,
2061 /* "Gadget Zero" firmware runs under Linux */
2062 { USB_DEVICE (0x0525, 0xa4a0),
2063 .driver_info = (unsigned long) &gz_info,
2066 /* so does a user-mode variant */
2067 { USB_DEVICE (0x0525, 0xa4a4),
2068 .driver_info = (unsigned long) &um_info,
2071 /* ... and a user-mode variant that talks iso */
2072 { USB_DEVICE (0x0525, 0xa4a3),
2073 .driver_info = (unsigned long) &um2_info,
2077 /* Keyspan 19qi uses an21xx (original EZ-USB) */
2078 // this does not coexist with the real Keyspan 19qi driver!
2079 { USB_DEVICE (0x06cd, 0x010b),
2080 .driver_info = (unsigned long) &ez1_info,
2084 /*-------------------------------------------------------------*/
2087 /* iBOT2 makes a nice source of high speed bulk-in data */
2088 // this does not coexist with a real iBOT2 driver!
2089 { USB_DEVICE (0x0b62, 0x0059),
2090 .driver_info = (unsigned long) &ibot2_info,
2094 /*-------------------------------------------------------------*/
2097 /* module params can specify devices to use for control tests */
2098 { .driver_info = (unsigned long) &generic_info, },
2101 /*-------------------------------------------------------------*/
2105 MODULE_DEVICE_TABLE (usb, id_table);
2107 static struct usb_driver usbtest_driver = {
2108 .owner = THIS_MODULE,
2110 .id_table = id_table,
2111 .probe = usbtest_probe,
2112 .ioctl = usbtest_ioctl,
2113 .disconnect = usbtest_disconnect,
2116 /*-------------------------------------------------------------------------*/
2118 static int __init usbtest_init (void)
2122 dbg ("params: vend=0x%04x prod=0x%04x", vendor, product);
2124 return usb_register (&usbtest_driver);
2126 module_init (usbtest_init);
2128 static void __exit usbtest_exit (void)
2130 usb_deregister (&usbtest_driver);
2132 module_exit (usbtest_exit);
2134 MODULE_DESCRIPTION ("USB Core/HCD Testing Driver");
2135 MODULE_LICENSE ("GPL");