Committer: Michael Beasley <mike@snafu.setup>
[mikesnafu-overlay.git] / drivers / usb / misc / usbtest.c
blobb6b5b2affad1deac8d670adea8f050593b6e8bc0
1 #include <linux/kernel.h>
2 #include <linux/errno.h>
3 #include <linux/init.h>
4 #include <linux/slab.h>
5 #include <linux/mm.h>
6 #include <linux/module.h>
7 #include <linux/moduleparam.h>
8 #include <linux/scatterlist.h>
9 #include <linux/mutex.h>
11 #include <linux/usb.h>
14 /*-------------------------------------------------------------------------*/
16 // FIXME make these public somewhere; usbdevfs.h?
18 struct usbtest_param {
19 // inputs
20 unsigned test_num; /* 0..(TEST_CASES-1) */
21 unsigned iterations;
22 unsigned length;
23 unsigned vary;
24 unsigned sglen;
26 // outputs
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
37 * that "real" driver.
39 //#define IBOT2 /* grab iBOT2 webcams */
40 //#define KEYSPAN_19Qi /* grab un-renumerated serial adapter */
42 /*-------------------------------------------------------------------------*/
44 struct usbtest_info {
45 const char *name;
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 */
51 int alt;
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.
60 struct usbtest_dev {
61 struct usb_interface *intf;
62 struct usbtest_info *info;
63 int in_pipe;
64 int out_pipe;
65 int in_iso_pipe;
66 int out_iso_pipe;
67 struct usb_endpoint_descriptor *iso_in, *iso_out;
68 struct mutex lock;
70 #define TBUF_SIZE 256
71 u8 *buf;
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 xprintk(tdev,level,fmt,args...) \
83 dev_printk(level , &(tdev)->intf->dev , fmt , ## args)
85 #ifdef DEBUG
86 #define DBG(dev,fmt,args...) \
87 xprintk(dev , KERN_DEBUG , fmt , ## args)
88 #else
89 #define DBG(dev,fmt,args...) \
90 do { } while (0)
91 #endif /* DEBUG */
93 #ifdef VERBOSE
94 #define VDBG DBG
95 #else
96 #define VDBG(dev,fmt,args...) \
97 do { } while (0)
98 #endif /* VERBOSE */
100 #define ERROR(dev,fmt,args...) \
101 xprintk(dev , KERN_ERR , fmt , ## args)
102 #define WARN(dev,fmt,args...) \
103 xprintk(dev , KERN_WARNING , fmt , ## args)
104 #define INFO(dev,fmt,args...) \
105 xprintk(dev , KERN_INFO , fmt , ## args)
107 /*-------------------------------------------------------------------------*/
109 static int
110 get_endpoints (struct usbtest_dev *dev, struct usb_interface *intf)
112 int tmp;
113 struct usb_host_interface *alt;
114 struct usb_host_endpoint *in, *out;
115 struct usb_host_endpoint *iso_in, *iso_out;
116 struct usb_device *udev;
118 for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
119 unsigned ep;
121 in = out = NULL;
122 iso_in = iso_out = NULL;
123 alt = intf->altsetting + tmp;
125 /* take the first altsetting with in-bulk + out-bulk;
126 * ignore other endpoints and altsetttings.
128 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
129 struct usb_host_endpoint *e;
131 e = alt->endpoint + ep;
132 switch (e->desc.bmAttributes) {
133 case USB_ENDPOINT_XFER_BULK:
134 break;
135 case USB_ENDPOINT_XFER_ISOC:
136 if (dev->info->iso)
137 goto try_iso;
138 // FALLTHROUGH
139 default:
140 continue;
142 if (usb_endpoint_dir_in(&e->desc)) {
143 if (!in)
144 in = e;
145 } else {
146 if (!out)
147 out = e;
149 continue;
150 try_iso:
151 if (usb_endpoint_dir_in(&e->desc)) {
152 if (!iso_in)
153 iso_in = e;
154 } else {
155 if (!iso_out)
156 iso_out = e;
159 if ((in && out) || (iso_in && iso_out))
160 goto found;
162 return -EINVAL;
164 found:
165 udev = testdev_to_usbdev (dev);
166 if (alt->desc.bAlternateSetting != 0) {
167 tmp = usb_set_interface (udev,
168 alt->desc.bInterfaceNumber,
169 alt->desc.bAlternateSetting);
170 if (tmp < 0)
171 return tmp;
174 if (in) {
175 dev->in_pipe = usb_rcvbulkpipe (udev,
176 in->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
177 dev->out_pipe = usb_sndbulkpipe (udev,
178 out->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
180 if (iso_in) {
181 dev->iso_in = &iso_in->desc;
182 dev->in_iso_pipe = usb_rcvisocpipe (udev,
183 iso_in->desc.bEndpointAddress
184 & USB_ENDPOINT_NUMBER_MASK);
185 dev->iso_out = &iso_out->desc;
186 dev->out_iso_pipe = usb_sndisocpipe (udev,
187 iso_out->desc.bEndpointAddress
188 & USB_ENDPOINT_NUMBER_MASK);
190 return 0;
193 /*-------------------------------------------------------------------------*/
195 /* Support for testing basic non-queued I/O streams.
197 * These just package urbs as requests that can be easily canceled.
198 * Each urb's data buffer is dynamically allocated; callers can fill
199 * them with non-zero test data (or test for it) when appropriate.
202 static void simple_callback (struct urb *urb)
204 complete ((struct completion *) urb->context);
207 static struct urb *simple_alloc_urb (
208 struct usb_device *udev,
209 int pipe,
210 unsigned long bytes
213 struct urb *urb;
215 if (bytes < 0)
216 return NULL;
217 urb = usb_alloc_urb (0, GFP_KERNEL);
218 if (!urb)
219 return urb;
220 usb_fill_bulk_urb (urb, udev, pipe, NULL, bytes, simple_callback, NULL);
221 urb->interval = (udev->speed == USB_SPEED_HIGH)
222 ? (INTERRUPT_RATE << 3)
223 : INTERRUPT_RATE;
224 urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
225 if (usb_pipein (pipe))
226 urb->transfer_flags |= URB_SHORT_NOT_OK;
227 urb->transfer_buffer = usb_buffer_alloc (udev, bytes, GFP_KERNEL,
228 &urb->transfer_dma);
229 if (!urb->transfer_buffer) {
230 usb_free_urb (urb);
231 urb = NULL;
232 } else
233 memset (urb->transfer_buffer, 0, bytes);
234 return urb;
237 static unsigned pattern = 0;
238 module_param (pattern, uint, S_IRUGO);
239 // MODULE_PARM_DESC (pattern, "i/o pattern (0 == zeroes)");
241 static inline void simple_fill_buf (struct urb *urb)
243 unsigned i;
244 u8 *buf = urb->transfer_buffer;
245 unsigned len = urb->transfer_buffer_length;
247 switch (pattern) {
248 default:
249 // FALLTHROUGH
250 case 0:
251 memset (buf, 0, len);
252 break;
253 case 1: /* mod63 */
254 for (i = 0; i < len; i++)
255 *buf++ = (u8) (i % 63);
256 break;
260 static inline int simple_check_buf (struct urb *urb)
262 unsigned i;
263 u8 expected;
264 u8 *buf = urb->transfer_buffer;
265 unsigned len = urb->actual_length;
267 for (i = 0; i < len; i++, buf++) {
268 switch (pattern) {
269 /* all-zeroes has no synchronization issues */
270 case 0:
271 expected = 0;
272 break;
273 /* mod63 stays in sync with short-terminated transfers,
274 * or otherwise when host and gadget agree on how large
275 * each usb transfer request should be. resync is done
276 * with set_interface or set_config.
278 case 1: /* mod63 */
279 expected = i % 63;
280 break;
281 /* always fail unsupported patterns */
282 default:
283 expected = !*buf;
284 break;
286 if (*buf == expected)
287 continue;
288 dbg ("buf[%d] = %d (not %d)", i, *buf, expected);
289 return -EINVAL;
291 return 0;
294 static void simple_free_urb (struct urb *urb)
296 usb_buffer_free (urb->dev, urb->transfer_buffer_length,
297 urb->transfer_buffer, urb->transfer_dma);
298 usb_free_urb (urb);
301 static int simple_io (
302 struct urb *urb,
303 int iterations,
304 int vary,
305 int expected,
306 const char *label
309 struct usb_device *udev = urb->dev;
310 int max = urb->transfer_buffer_length;
311 struct completion completion;
312 int retval = 0;
314 urb->context = &completion;
315 while (retval == 0 && iterations-- > 0) {
316 init_completion (&completion);
317 if (usb_pipeout (urb->pipe))
318 simple_fill_buf (urb);
319 if ((retval = usb_submit_urb (urb, GFP_KERNEL)) != 0)
320 break;
322 /* NOTE: no timeouts; can't be broken out of by interrupt */
323 wait_for_completion (&completion);
324 retval = urb->status;
325 urb->dev = udev;
326 if (retval == 0 && usb_pipein (urb->pipe))
327 retval = simple_check_buf (urb);
329 if (vary) {
330 int len = urb->transfer_buffer_length;
332 len += vary;
333 len %= max;
334 if (len == 0)
335 len = (vary < max) ? vary : max;
336 urb->transfer_buffer_length = len;
339 /* FIXME if endpoint halted, clear halt (and log) */
341 urb->transfer_buffer_length = max;
343 if (expected != retval)
344 dev_dbg (&udev->dev,
345 "%s failed, iterations left %d, status %d (not %d)\n",
346 label, iterations, retval, expected);
347 return retval;
351 /*-------------------------------------------------------------------------*/
353 /* We use scatterlist primitives to test queued I/O.
354 * Yes, this also tests the scatterlist primitives.
357 static void free_sglist (struct scatterlist *sg, int nents)
359 unsigned i;
361 if (!sg)
362 return;
363 for (i = 0; i < nents; i++) {
364 if (!sg_page(&sg[i]))
365 continue;
366 kfree (sg_virt(&sg[i]));
368 kfree (sg);
371 static struct scatterlist *
372 alloc_sglist (int nents, int max, int vary)
374 struct scatterlist *sg;
375 unsigned i;
376 unsigned size = max;
378 sg = kmalloc (nents * sizeof *sg, GFP_KERNEL);
379 if (!sg)
380 return NULL;
381 sg_init_table(sg, nents);
383 for (i = 0; i < nents; i++) {
384 char *buf;
385 unsigned j;
387 buf = kzalloc (size, GFP_KERNEL);
388 if (!buf) {
389 free_sglist (sg, i);
390 return NULL;
393 /* kmalloc pages are always physically contiguous! */
394 sg_set_buf(&sg[i], buf, size);
396 switch (pattern) {
397 case 0:
398 /* already zeroed */
399 break;
400 case 1:
401 for (j = 0; j < size; j++)
402 *buf++ = (u8) (j % 63);
403 break;
406 if (vary) {
407 size += vary;
408 size %= max;
409 if (size == 0)
410 size = (vary < max) ? vary : max;
414 return sg;
417 static int perform_sglist (
418 struct usb_device *udev,
419 unsigned iterations,
420 int pipe,
421 struct usb_sg_request *req,
422 struct scatterlist *sg,
423 int nents
426 int retval = 0;
428 while (retval == 0 && iterations-- > 0) {
429 retval = usb_sg_init (req, udev, pipe,
430 (udev->speed == USB_SPEED_HIGH)
431 ? (INTERRUPT_RATE << 3)
432 : INTERRUPT_RATE,
433 sg, nents, 0, GFP_KERNEL);
435 if (retval)
436 break;
437 usb_sg_wait (req);
438 retval = req->status;
440 /* FIXME check resulting data pattern */
442 /* FIXME if endpoint halted, clear halt (and log) */
445 // FIXME for unlink or fault handling tests, don't report
446 // failure if retval is as we expected ...
448 if (retval)
449 dbg ("perform_sglist failed, iterations left %d, status %d",
450 iterations, retval);
451 return retval;
455 /*-------------------------------------------------------------------------*/
457 /* unqueued control message testing
459 * there's a nice set of device functional requirements in chapter 9 of the
460 * usb 2.0 spec, which we can apply to ANY device, even ones that don't use
461 * special test firmware.
463 * we know the device is configured (or suspended) by the time it's visible
464 * through usbfs. we can't change that, so we won't test enumeration (which
465 * worked 'well enough' to get here, this time), power management (ditto),
466 * or remote wakeup (which needs human interaction).
469 static unsigned realworld = 1;
470 module_param (realworld, uint, 0);
471 MODULE_PARM_DESC (realworld, "clear to demand stricter spec compliance");
473 static int get_altsetting (struct usbtest_dev *dev)
475 struct usb_interface *iface = dev->intf;
476 struct usb_device *udev = interface_to_usbdev (iface);
477 int retval;
479 retval = usb_control_msg (udev, usb_rcvctrlpipe (udev, 0),
480 USB_REQ_GET_INTERFACE, USB_DIR_IN|USB_RECIP_INTERFACE,
481 0, iface->altsetting [0].desc.bInterfaceNumber,
482 dev->buf, 1, USB_CTRL_GET_TIMEOUT);
483 switch (retval) {
484 case 1:
485 return dev->buf [0];
486 case 0:
487 retval = -ERANGE;
488 // FALLTHROUGH
489 default:
490 return retval;
494 static int set_altsetting (struct usbtest_dev *dev, int alternate)
496 struct usb_interface *iface = dev->intf;
497 struct usb_device *udev;
499 if (alternate < 0 || alternate >= 256)
500 return -EINVAL;
502 udev = interface_to_usbdev (iface);
503 return usb_set_interface (udev,
504 iface->altsetting [0].desc.bInterfaceNumber,
505 alternate);
508 static int is_good_config (char *buf, int len)
510 struct usb_config_descriptor *config;
512 if (len < sizeof *config)
513 return 0;
514 config = (struct usb_config_descriptor *) buf;
516 switch (config->bDescriptorType) {
517 case USB_DT_CONFIG:
518 case USB_DT_OTHER_SPEED_CONFIG:
519 if (config->bLength != 9) {
520 dbg ("bogus config descriptor length");
521 return 0;
523 /* this bit 'must be 1' but often isn't */
524 if (!realworld && !(config->bmAttributes & 0x80)) {
525 dbg ("high bit of config attributes not set");
526 return 0;
528 if (config->bmAttributes & 0x1f) { /* reserved == 0 */
529 dbg ("reserved config bits set");
530 return 0;
532 break;
533 default:
534 return 0;
537 if (le16_to_cpu(config->wTotalLength) == len) /* read it all */
538 return 1;
539 if (le16_to_cpu(config->wTotalLength) >= TBUF_SIZE) /* max partial read */
540 return 1;
541 dbg ("bogus config descriptor read size");
542 return 0;
545 /* sanity test for standard requests working with usb_control_mesg() and some
546 * of the utility functions which use it.
548 * this doesn't test how endpoint halts behave or data toggles get set, since
549 * we won't do I/O to bulk/interrupt endpoints here (which is how to change
550 * halt or toggle). toggle testing is impractical without support from hcds.
552 * this avoids failing devices linux would normally work with, by not testing
553 * config/altsetting operations for devices that only support their defaults.
554 * such devices rarely support those needless operations.
556 * NOTE that since this is a sanity test, it's not examining boundary cases
557 * to see if usbcore, hcd, and device all behave right. such testing would
558 * involve varied read sizes and other operation sequences.
560 static int ch9_postconfig (struct usbtest_dev *dev)
562 struct usb_interface *iface = dev->intf;
563 struct usb_device *udev = interface_to_usbdev (iface);
564 int i, alt, retval;
566 /* [9.2.3] if there's more than one altsetting, we need to be able to
567 * set and get each one. mostly trusts the descriptors from usbcore.
569 for (i = 0; i < iface->num_altsetting; i++) {
571 /* 9.2.3 constrains the range here */
572 alt = iface->altsetting [i].desc.bAlternateSetting;
573 if (alt < 0 || alt >= iface->num_altsetting) {
574 dev_dbg (&iface->dev,
575 "invalid alt [%d].bAltSetting = %d\n",
576 i, alt);
579 /* [real world] get/set unimplemented if there's only one */
580 if (realworld && iface->num_altsetting == 1)
581 continue;
583 /* [9.4.10] set_interface */
584 retval = set_altsetting (dev, alt);
585 if (retval) {
586 dev_dbg (&iface->dev, "can't set_interface = %d, %d\n",
587 alt, retval);
588 return retval;
591 /* [9.4.4] get_interface always works */
592 retval = get_altsetting (dev);
593 if (retval != alt) {
594 dev_dbg (&iface->dev, "get alt should be %d, was %d\n",
595 alt, retval);
596 return (retval < 0) ? retval : -EDOM;
601 /* [real world] get_config unimplemented if there's only one */
602 if (!realworld || udev->descriptor.bNumConfigurations != 1) {
603 int expected = udev->actconfig->desc.bConfigurationValue;
605 /* [9.4.2] get_configuration always works
606 * ... although some cheap devices (like one TI Hub I've got)
607 * won't return config descriptors except before set_config.
609 retval = usb_control_msg (udev, usb_rcvctrlpipe (udev, 0),
610 USB_REQ_GET_CONFIGURATION,
611 USB_DIR_IN | USB_RECIP_DEVICE,
612 0, 0, dev->buf, 1, USB_CTRL_GET_TIMEOUT);
613 if (retval != 1 || dev->buf [0] != expected) {
614 dev_dbg (&iface->dev, "get config --> %d %d (1 %d)\n",
615 retval, dev->buf[0], expected);
616 return (retval < 0) ? retval : -EDOM;
620 /* there's always [9.4.3] a device descriptor [9.6.1] */
621 retval = usb_get_descriptor (udev, USB_DT_DEVICE, 0,
622 dev->buf, sizeof udev->descriptor);
623 if (retval != sizeof udev->descriptor) {
624 dev_dbg (&iface->dev, "dev descriptor --> %d\n", retval);
625 return (retval < 0) ? retval : -EDOM;
628 /* there's always [9.4.3] at least one config descriptor [9.6.3] */
629 for (i = 0; i < udev->descriptor.bNumConfigurations; i++) {
630 retval = usb_get_descriptor (udev, USB_DT_CONFIG, i,
631 dev->buf, TBUF_SIZE);
632 if (!is_good_config (dev->buf, retval)) {
633 dev_dbg (&iface->dev,
634 "config [%d] descriptor --> %d\n",
635 i, retval);
636 return (retval < 0) ? retval : -EDOM;
639 // FIXME cross-checking udev->config[i] to make sure usbcore
640 // parsed it right (etc) would be good testing paranoia
643 /* and sometimes [9.2.6.6] speed dependent descriptors */
644 if (le16_to_cpu(udev->descriptor.bcdUSB) == 0x0200) {
645 struct usb_qualifier_descriptor *d = NULL;
647 /* device qualifier [9.6.2] */
648 retval = usb_get_descriptor (udev,
649 USB_DT_DEVICE_QUALIFIER, 0, dev->buf,
650 sizeof (struct usb_qualifier_descriptor));
651 if (retval == -EPIPE) {
652 if (udev->speed == USB_SPEED_HIGH) {
653 dev_dbg (&iface->dev,
654 "hs dev qualifier --> %d\n",
655 retval);
656 return (retval < 0) ? retval : -EDOM;
658 /* usb2.0 but not high-speed capable; fine */
659 } else if (retval != sizeof (struct usb_qualifier_descriptor)) {
660 dev_dbg (&iface->dev, "dev qualifier --> %d\n", retval);
661 return (retval < 0) ? retval : -EDOM;
662 } else
663 d = (struct usb_qualifier_descriptor *) dev->buf;
665 /* might not have [9.6.2] any other-speed configs [9.6.4] */
666 if (d) {
667 unsigned max = d->bNumConfigurations;
668 for (i = 0; i < max; i++) {
669 retval = usb_get_descriptor (udev,
670 USB_DT_OTHER_SPEED_CONFIG, i,
671 dev->buf, TBUF_SIZE);
672 if (!is_good_config (dev->buf, retval)) {
673 dev_dbg (&iface->dev,
674 "other speed config --> %d\n",
675 retval);
676 return (retval < 0) ? retval : -EDOM;
681 // FIXME fetch strings from at least the device descriptor
683 /* [9.4.5] get_status always works */
684 retval = usb_get_status (udev, USB_RECIP_DEVICE, 0, dev->buf);
685 if (retval != 2) {
686 dev_dbg (&iface->dev, "get dev status --> %d\n", retval);
687 return (retval < 0) ? retval : -EDOM;
690 // FIXME configuration.bmAttributes says if we could try to set/clear
691 // the device's remote wakeup feature ... if we can, test that here
693 retval = usb_get_status (udev, USB_RECIP_INTERFACE,
694 iface->altsetting [0].desc.bInterfaceNumber, dev->buf);
695 if (retval != 2) {
696 dev_dbg (&iface->dev, "get interface status --> %d\n", retval);
697 return (retval < 0) ? retval : -EDOM;
699 // FIXME get status for each endpoint in the interface
701 return 0;
704 /*-------------------------------------------------------------------------*/
706 /* use ch9 requests to test whether:
707 * (a) queues work for control, keeping N subtests queued and
708 * active (auto-resubmit) for M loops through the queue.
709 * (b) protocol stalls (control-only) will autorecover.
710 * it's not like bulk/intr; no halt clearing.
711 * (c) short control reads are reported and handled.
712 * (d) queues are always processed in-order
715 struct ctrl_ctx {
716 spinlock_t lock;
717 struct usbtest_dev *dev;
718 struct completion complete;
719 unsigned count;
720 unsigned pending;
721 int status;
722 struct urb **urb;
723 struct usbtest_param *param;
724 int last;
727 #define NUM_SUBCASES 15 /* how many test subcases here? */
729 struct subcase {
730 struct usb_ctrlrequest setup;
731 int number;
732 int expected;
735 static void ctrl_complete (struct urb *urb)
737 struct ctrl_ctx *ctx = urb->context;
738 struct usb_ctrlrequest *reqp;
739 struct subcase *subcase;
740 int status = urb->status;
742 reqp = (struct usb_ctrlrequest *)urb->setup_packet;
743 subcase = container_of (reqp, struct subcase, setup);
745 spin_lock (&ctx->lock);
746 ctx->count--;
747 ctx->pending--;
749 /* queue must transfer and complete in fifo order, unless
750 * usb_unlink_urb() is used to unlink something not at the
751 * physical queue head (not tested).
753 if (subcase->number > 0) {
754 if ((subcase->number - ctx->last) != 1) {
755 dbg ("subcase %d completed out of order, last %d",
756 subcase->number, ctx->last);
757 status = -EDOM;
758 ctx->last = subcase->number;
759 goto error;
762 ctx->last = subcase->number;
764 /* succeed or fault in only one way? */
765 if (status == subcase->expected)
766 status = 0;
768 /* async unlink for cleanup? */
769 else if (status != -ECONNRESET) {
771 /* some faults are allowed, not required */
772 if (subcase->expected > 0 && (
773 ((status == -subcase->expected /* happened */
774 || status == 0)))) /* didn't */
775 status = 0;
776 /* sometimes more than one fault is allowed */
777 else if (subcase->number == 12 && status == -EPIPE)
778 status = 0;
779 else
780 dbg ("subtest %d error, status %d",
781 subcase->number, status);
784 /* unexpected status codes mean errors; ideally, in hardware */
785 if (status) {
786 error:
787 if (ctx->status == 0) {
788 int i;
790 ctx->status = status;
791 info ("control queue %02x.%02x, err %d, %d left",
792 reqp->bRequestType, reqp->bRequest,
793 status, ctx->count);
795 /* FIXME this "unlink everything" exit route should
796 * be a separate test case.
799 /* unlink whatever's still pending */
800 for (i = 1; i < ctx->param->sglen; i++) {
801 struct urb *u = ctx->urb [
802 (i + subcase->number) % ctx->param->sglen];
804 if (u == urb || !u->dev)
805 continue;
806 spin_unlock(&ctx->lock);
807 status = usb_unlink_urb (u);
808 spin_lock(&ctx->lock);
809 switch (status) {
810 case -EINPROGRESS:
811 case -EBUSY:
812 case -EIDRM:
813 continue;
814 default:
815 dbg ("urb unlink --> %d", status);
818 status = ctx->status;
822 /* resubmit if we need to, else mark this as done */
823 if ((status == 0) && (ctx->pending < ctx->count)) {
824 if ((status = usb_submit_urb (urb, GFP_ATOMIC)) != 0) {
825 dbg ("can't resubmit ctrl %02x.%02x, err %d",
826 reqp->bRequestType, reqp->bRequest, status);
827 urb->dev = NULL;
828 } else
829 ctx->pending++;
830 } else
831 urb->dev = NULL;
833 /* signal completion when nothing's queued */
834 if (ctx->pending == 0)
835 complete (&ctx->complete);
836 spin_unlock (&ctx->lock);
839 static int
840 test_ctrl_queue (struct usbtest_dev *dev, struct usbtest_param *param)
842 struct usb_device *udev = testdev_to_usbdev (dev);
843 struct urb **urb;
844 struct ctrl_ctx context;
845 int i;
847 spin_lock_init (&context.lock);
848 context.dev = dev;
849 init_completion (&context.complete);
850 context.count = param->sglen * param->iterations;
851 context.pending = 0;
852 context.status = -ENOMEM;
853 context.param = param;
854 context.last = -1;
856 /* allocate and init the urbs we'll queue.
857 * as with bulk/intr sglists, sglen is the queue depth; it also
858 * controls which subtests run (more tests than sglen) or rerun.
860 urb = kcalloc(param->sglen, sizeof(struct urb *), GFP_KERNEL);
861 if (!urb)
862 return -ENOMEM;
863 for (i = 0; i < param->sglen; i++) {
864 int pipe = usb_rcvctrlpipe (udev, 0);
865 unsigned len;
866 struct urb *u;
867 struct usb_ctrlrequest req;
868 struct subcase *reqp;
869 int expected = 0;
871 /* requests here are mostly expected to succeed on any
872 * device, but some are chosen to trigger protocol stalls
873 * or short reads.
875 memset (&req, 0, sizeof req);
876 req.bRequest = USB_REQ_GET_DESCRIPTOR;
877 req.bRequestType = USB_DIR_IN|USB_RECIP_DEVICE;
879 switch (i % NUM_SUBCASES) {
880 case 0: // get device descriptor
881 req.wValue = cpu_to_le16 (USB_DT_DEVICE << 8);
882 len = sizeof (struct usb_device_descriptor);
883 break;
884 case 1: // get first config descriptor (only)
885 req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
886 len = sizeof (struct usb_config_descriptor);
887 break;
888 case 2: // get altsetting (OFTEN STALLS)
889 req.bRequest = USB_REQ_GET_INTERFACE;
890 req.bRequestType = USB_DIR_IN|USB_RECIP_INTERFACE;
891 // index = 0 means first interface
892 len = 1;
893 expected = EPIPE;
894 break;
895 case 3: // get interface status
896 req.bRequest = USB_REQ_GET_STATUS;
897 req.bRequestType = USB_DIR_IN|USB_RECIP_INTERFACE;
898 // interface 0
899 len = 2;
900 break;
901 case 4: // get device status
902 req.bRequest = USB_REQ_GET_STATUS;
903 req.bRequestType = USB_DIR_IN|USB_RECIP_DEVICE;
904 len = 2;
905 break;
906 case 5: // get device qualifier (MAY STALL)
907 req.wValue = cpu_to_le16 (USB_DT_DEVICE_QUALIFIER << 8);
908 len = sizeof (struct usb_qualifier_descriptor);
909 if (udev->speed != USB_SPEED_HIGH)
910 expected = EPIPE;
911 break;
912 case 6: // get first config descriptor, plus interface
913 req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
914 len = sizeof (struct usb_config_descriptor);
915 len += sizeof (struct usb_interface_descriptor);
916 break;
917 case 7: // get interface descriptor (ALWAYS STALLS)
918 req.wValue = cpu_to_le16 (USB_DT_INTERFACE << 8);
919 // interface == 0
920 len = sizeof (struct usb_interface_descriptor);
921 expected = EPIPE;
922 break;
923 // NOTE: two consecutive stalls in the queue here.
924 // that tests fault recovery a bit more aggressively.
925 case 8: // clear endpoint halt (USUALLY STALLS)
926 req.bRequest = USB_REQ_CLEAR_FEATURE;
927 req.bRequestType = USB_RECIP_ENDPOINT;
928 // wValue 0 == ep halt
929 // wIndex 0 == ep0 (shouldn't halt!)
930 len = 0;
931 pipe = usb_sndctrlpipe (udev, 0);
932 expected = EPIPE;
933 break;
934 case 9: // get endpoint status
935 req.bRequest = USB_REQ_GET_STATUS;
936 req.bRequestType = USB_DIR_IN|USB_RECIP_ENDPOINT;
937 // endpoint 0
938 len = 2;
939 break;
940 case 10: // trigger short read (EREMOTEIO)
941 req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
942 len = 1024;
943 expected = -EREMOTEIO;
944 break;
945 // NOTE: two consecutive _different_ faults in the queue.
946 case 11: // get endpoint descriptor (ALWAYS STALLS)
947 req.wValue = cpu_to_le16 (USB_DT_ENDPOINT << 8);
948 // endpoint == 0
949 len = sizeof (struct usb_interface_descriptor);
950 expected = EPIPE;
951 break;
952 // NOTE: sometimes even a third fault in the queue!
953 case 12: // get string 0 descriptor (MAY STALL)
954 req.wValue = cpu_to_le16 (USB_DT_STRING << 8);
955 // string == 0, for language IDs
956 len = sizeof (struct usb_interface_descriptor);
957 // may succeed when > 4 languages
958 expected = EREMOTEIO; // or EPIPE, if no strings
959 break;
960 case 13: // short read, resembling case 10
961 req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
962 // last data packet "should" be DATA1, not DATA0
963 len = 1024 - udev->descriptor.bMaxPacketSize0;
964 expected = -EREMOTEIO;
965 break;
966 case 14: // short read; try to fill the last packet
967 req.wValue = cpu_to_le16 ((USB_DT_DEVICE << 8) | 0);
968 // device descriptor size == 18 bytes
969 len = udev->descriptor.bMaxPacketSize0;
970 switch (len) {
971 case 8: len = 24; break;
972 case 16: len = 32; break;
974 expected = -EREMOTEIO;
975 break;
976 default:
977 err ("bogus number of ctrl queue testcases!");
978 context.status = -EINVAL;
979 goto cleanup;
981 req.wLength = cpu_to_le16 (len);
982 urb [i] = u = simple_alloc_urb (udev, pipe, len);
983 if (!u)
984 goto cleanup;
986 reqp = usb_buffer_alloc (udev, sizeof *reqp, GFP_KERNEL,
987 &u->setup_dma);
988 if (!reqp)
989 goto cleanup;
990 reqp->setup = req;
991 reqp->number = i % NUM_SUBCASES;
992 reqp->expected = expected;
993 u->setup_packet = (char *) &reqp->setup;
994 u->transfer_flags |= URB_NO_SETUP_DMA_MAP;
996 u->context = &context;
997 u->complete = ctrl_complete;
1000 /* queue the urbs */
1001 context.urb = urb;
1002 spin_lock_irq (&context.lock);
1003 for (i = 0; i < param->sglen; i++) {
1004 context.status = usb_submit_urb (urb [i], GFP_ATOMIC);
1005 if (context.status != 0) {
1006 dbg ("can't submit urb[%d], status %d",
1007 i, context.status);
1008 context.count = context.pending;
1009 break;
1011 context.pending++;
1013 spin_unlock_irq (&context.lock);
1015 /* FIXME set timer and time out; provide a disconnect hook */
1017 /* wait for the last one to complete */
1018 if (context.pending > 0)
1019 wait_for_completion (&context.complete);
1021 cleanup:
1022 for (i = 0; i < param->sglen; i++) {
1023 if (!urb [i])
1024 continue;
1025 urb [i]->dev = udev;
1026 if (urb [i]->setup_packet)
1027 usb_buffer_free (udev, sizeof (struct usb_ctrlrequest),
1028 urb [i]->setup_packet,
1029 urb [i]->setup_dma);
1030 simple_free_urb (urb [i]);
1032 kfree (urb);
1033 return context.status;
1035 #undef NUM_SUBCASES
1038 /*-------------------------------------------------------------------------*/
1040 static void unlink1_callback (struct urb *urb)
1042 int status = urb->status;
1044 // we "know" -EPIPE (stall) never happens
1045 if (!status)
1046 status = usb_submit_urb (urb, GFP_ATOMIC);
1047 if (status) {
1048 urb->status = status;
1049 complete ((struct completion *) urb->context);
1053 static int unlink1 (struct usbtest_dev *dev, int pipe, int size, int async)
1055 struct urb *urb;
1056 struct completion completion;
1057 int retval = 0;
1059 init_completion (&completion);
1060 urb = simple_alloc_urb (testdev_to_usbdev (dev), pipe, size);
1061 if (!urb)
1062 return -ENOMEM;
1063 urb->context = &completion;
1064 urb->complete = unlink1_callback;
1066 /* keep the endpoint busy. there are lots of hc/hcd-internal
1067 * states, and testing should get to all of them over time.
1069 * FIXME want additional tests for when endpoint is STALLing
1070 * due to errors, or is just NAKing requests.
1072 if ((retval = usb_submit_urb (urb, GFP_KERNEL)) != 0) {
1073 dev_dbg (&dev->intf->dev, "submit fail %d\n", retval);
1074 return retval;
1077 /* unlinking that should always work. variable delay tests more
1078 * hcd states and code paths, even with little other system load.
1080 msleep (jiffies % (2 * INTERRUPT_RATE));
1081 if (async) {
1082 retry:
1083 retval = usb_unlink_urb (urb);
1084 if (retval == -EBUSY || retval == -EIDRM) {
1085 /* we can't unlink urbs while they're completing.
1086 * or if they've completed, and we haven't resubmitted.
1087 * "normal" drivers would prevent resubmission, but
1088 * since we're testing unlink paths, we can't.
1090 dev_dbg (&dev->intf->dev, "unlink retry\n");
1091 goto retry;
1093 } else
1094 usb_kill_urb (urb);
1095 if (!(retval == 0 || retval == -EINPROGRESS)) {
1096 dev_dbg (&dev->intf->dev, "unlink fail %d\n", retval);
1097 return retval;
1100 wait_for_completion (&completion);
1101 retval = urb->status;
1102 simple_free_urb (urb);
1104 if (async)
1105 return (retval == -ECONNRESET) ? 0 : retval - 1000;
1106 else
1107 return (retval == -ENOENT || retval == -EPERM) ?
1108 0 : retval - 2000;
1111 static int unlink_simple (struct usbtest_dev *dev, int pipe, int len)
1113 int retval = 0;
1115 /* test sync and async paths */
1116 retval = unlink1 (dev, pipe, len, 1);
1117 if (!retval)
1118 retval = unlink1 (dev, pipe, len, 0);
1119 return retval;
1122 /*-------------------------------------------------------------------------*/
1124 static int verify_not_halted (int ep, struct urb *urb)
1126 int retval;
1127 u16 status;
1129 /* shouldn't look or act halted */
1130 retval = usb_get_status (urb->dev, USB_RECIP_ENDPOINT, ep, &status);
1131 if (retval < 0) {
1132 dbg ("ep %02x couldn't get no-halt status, %d", ep, retval);
1133 return retval;
1135 if (status != 0) {
1136 dbg ("ep %02x bogus status: %04x != 0", ep, status);
1137 return -EINVAL;
1139 retval = simple_io (urb, 1, 0, 0, __FUNCTION__);
1140 if (retval != 0)
1141 return -EINVAL;
1142 return 0;
1145 static int verify_halted (int ep, struct urb *urb)
1147 int retval;
1148 u16 status;
1150 /* should look and act halted */
1151 retval = usb_get_status (urb->dev, USB_RECIP_ENDPOINT, ep, &status);
1152 if (retval < 0) {
1153 dbg ("ep %02x couldn't get halt status, %d", ep, retval);
1154 return retval;
1156 le16_to_cpus(&status);
1157 if (status != 1) {
1158 dbg ("ep %02x bogus status: %04x != 1", ep, status);
1159 return -EINVAL;
1161 retval = simple_io (urb, 1, 0, -EPIPE, __FUNCTION__);
1162 if (retval != -EPIPE)
1163 return -EINVAL;
1164 retval = simple_io (urb, 1, 0, -EPIPE, "verify_still_halted");
1165 if (retval != -EPIPE)
1166 return -EINVAL;
1167 return 0;
1170 static int test_halt (int ep, struct urb *urb)
1172 int retval;
1174 /* shouldn't look or act halted now */
1175 retval = verify_not_halted (ep, urb);
1176 if (retval < 0)
1177 return retval;
1179 /* set halt (protocol test only), verify it worked */
1180 retval = usb_control_msg (urb->dev, usb_sndctrlpipe (urb->dev, 0),
1181 USB_REQ_SET_FEATURE, USB_RECIP_ENDPOINT,
1182 USB_ENDPOINT_HALT, ep,
1183 NULL, 0, USB_CTRL_SET_TIMEOUT);
1184 if (retval < 0) {
1185 dbg ("ep %02x couldn't set halt, %d", ep, retval);
1186 return retval;
1188 retval = verify_halted (ep, urb);
1189 if (retval < 0)
1190 return retval;
1192 /* clear halt (tests API + protocol), verify it worked */
1193 retval = usb_clear_halt (urb->dev, urb->pipe);
1194 if (retval < 0) {
1195 dbg ("ep %02x couldn't clear halt, %d", ep, retval);
1196 return retval;
1198 retval = verify_not_halted (ep, urb);
1199 if (retval < 0)
1200 return retval;
1202 /* NOTE: could also verify SET_INTERFACE clear halts ... */
1204 return 0;
1207 static int halt_simple (struct usbtest_dev *dev)
1209 int ep;
1210 int retval = 0;
1211 struct urb *urb;
1213 urb = simple_alloc_urb (testdev_to_usbdev (dev), 0, 512);
1214 if (urb == NULL)
1215 return -ENOMEM;
1217 if (dev->in_pipe) {
1218 ep = usb_pipeendpoint (dev->in_pipe) | USB_DIR_IN;
1219 urb->pipe = dev->in_pipe;
1220 retval = test_halt (ep, urb);
1221 if (retval < 0)
1222 goto done;
1225 if (dev->out_pipe) {
1226 ep = usb_pipeendpoint (dev->out_pipe);
1227 urb->pipe = dev->out_pipe;
1228 retval = test_halt (ep, urb);
1230 done:
1231 simple_free_urb (urb);
1232 return retval;
1235 /*-------------------------------------------------------------------------*/
1237 /* Control OUT tests use the vendor control requests from Intel's
1238 * USB 2.0 compliance test device: write a buffer, read it back.
1240 * Intel's spec only _requires_ that it work for one packet, which
1241 * is pretty weak. Some HCDs place limits here; most devices will
1242 * need to be able to handle more than one OUT data packet. We'll
1243 * try whatever we're told to try.
1245 static int ctrl_out (struct usbtest_dev *dev,
1246 unsigned count, unsigned length, unsigned vary)
1248 unsigned i, j, len;
1249 int retval;
1250 u8 *buf;
1251 char *what = "?";
1252 struct usb_device *udev;
1254 if (length < 1 || length > 0xffff || vary >= length)
1255 return -EINVAL;
1257 buf = kmalloc(length, GFP_KERNEL);
1258 if (!buf)
1259 return -ENOMEM;
1261 udev = testdev_to_usbdev (dev);
1262 len = length;
1263 retval = 0;
1265 /* NOTE: hardware might well act differently if we pushed it
1266 * with lots back-to-back queued requests.
1268 for (i = 0; i < count; i++) {
1269 /* write patterned data */
1270 for (j = 0; j < len; j++)
1271 buf [j] = i + j;
1272 retval = usb_control_msg (udev, usb_sndctrlpipe (udev,0),
1273 0x5b, USB_DIR_OUT|USB_TYPE_VENDOR,
1274 0, 0, buf, len, USB_CTRL_SET_TIMEOUT);
1275 if (retval != len) {
1276 what = "write";
1277 if (retval >= 0) {
1278 INFO(dev, "ctrl_out, wlen %d (expected %d)\n",
1279 retval, len);
1280 retval = -EBADMSG;
1282 break;
1285 /* read it back -- assuming nothing intervened!! */
1286 retval = usb_control_msg (udev, usb_rcvctrlpipe (udev,0),
1287 0x5c, USB_DIR_IN|USB_TYPE_VENDOR,
1288 0, 0, buf, len, USB_CTRL_GET_TIMEOUT);
1289 if (retval != len) {
1290 what = "read";
1291 if (retval >= 0) {
1292 INFO(dev, "ctrl_out, rlen %d (expected %d)\n",
1293 retval, len);
1294 retval = -EBADMSG;
1296 break;
1299 /* fail if we can't verify */
1300 for (j = 0; j < len; j++) {
1301 if (buf [j] != (u8) (i + j)) {
1302 INFO (dev, "ctrl_out, byte %d is %d not %d\n",
1303 j, buf [j], (u8) i + j);
1304 retval = -EBADMSG;
1305 break;
1308 if (retval < 0) {
1309 what = "verify";
1310 break;
1313 len += vary;
1315 /* [real world] the "zero bytes IN" case isn't really used.
1316 * hardware can easily trip up in this weird case, since its
1317 * status stage is IN, not OUT like other ep0in transfers.
1319 if (len > length)
1320 len = realworld ? 1 : 0;
1323 if (retval < 0)
1324 INFO (dev, "ctrl_out %s failed, code %d, count %d\n",
1325 what, retval, i);
1327 kfree (buf);
1328 return retval;
1331 /*-------------------------------------------------------------------------*/
1333 /* ISO tests ... mimics common usage
1334 * - buffer length is split into N packets (mostly maxpacket sized)
1335 * - multi-buffers according to sglen
1338 struct iso_context {
1339 unsigned count;
1340 unsigned pending;
1341 spinlock_t lock;
1342 struct completion done;
1343 int submit_error;
1344 unsigned long errors;
1345 unsigned long packet_count;
1346 struct usbtest_dev *dev;
1349 static void iso_callback (struct urb *urb)
1351 struct iso_context *ctx = urb->context;
1353 spin_lock(&ctx->lock);
1354 ctx->count--;
1356 ctx->packet_count += urb->number_of_packets;
1357 if (urb->error_count > 0)
1358 ctx->errors += urb->error_count;
1359 else if (urb->status != 0)
1360 ctx->errors += urb->number_of_packets;
1362 if (urb->status == 0 && ctx->count > (ctx->pending - 1)
1363 && !ctx->submit_error) {
1364 int status = usb_submit_urb (urb, GFP_ATOMIC);
1365 switch (status) {
1366 case 0:
1367 goto done;
1368 default:
1369 dev_dbg (&ctx->dev->intf->dev,
1370 "iso resubmit err %d\n",
1371 status);
1372 /* FALLTHROUGH */
1373 case -ENODEV: /* disconnected */
1374 case -ESHUTDOWN: /* endpoint disabled */
1375 ctx->submit_error = 1;
1376 break;
1379 simple_free_urb (urb);
1381 ctx->pending--;
1382 if (ctx->pending == 0) {
1383 if (ctx->errors)
1384 dev_dbg (&ctx->dev->intf->dev,
1385 "iso test, %lu errors out of %lu\n",
1386 ctx->errors, ctx->packet_count);
1387 complete (&ctx->done);
1389 done:
1390 spin_unlock(&ctx->lock);
1393 static struct urb *iso_alloc_urb (
1394 struct usb_device *udev,
1395 int pipe,
1396 struct usb_endpoint_descriptor *desc,
1397 long bytes
1400 struct urb *urb;
1401 unsigned i, maxp, packets;
1403 if (bytes < 0 || !desc)
1404 return NULL;
1405 maxp = 0x7ff & le16_to_cpu(desc->wMaxPacketSize);
1406 maxp *= 1 + (0x3 & (le16_to_cpu(desc->wMaxPacketSize) >> 11));
1407 packets = (bytes + maxp - 1) / maxp;
1409 urb = usb_alloc_urb (packets, GFP_KERNEL);
1410 if (!urb)
1411 return urb;
1412 urb->dev = udev;
1413 urb->pipe = pipe;
1415 urb->number_of_packets = packets;
1416 urb->transfer_buffer_length = bytes;
1417 urb->transfer_buffer = usb_buffer_alloc (udev, bytes, GFP_KERNEL,
1418 &urb->transfer_dma);
1419 if (!urb->transfer_buffer) {
1420 usb_free_urb (urb);
1421 return NULL;
1423 memset (urb->transfer_buffer, 0, bytes);
1424 for (i = 0; i < packets; i++) {
1425 /* here, only the last packet will be short */
1426 urb->iso_frame_desc[i].length = min ((unsigned) bytes, maxp);
1427 bytes -= urb->iso_frame_desc[i].length;
1429 urb->iso_frame_desc[i].offset = maxp * i;
1432 urb->complete = iso_callback;
1433 // urb->context = SET BY CALLER
1434 urb->interval = 1 << (desc->bInterval - 1);
1435 urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
1436 return urb;
1439 static int
1440 test_iso_queue (struct usbtest_dev *dev, struct usbtest_param *param,
1441 int pipe, struct usb_endpoint_descriptor *desc)
1443 struct iso_context context;
1444 struct usb_device *udev;
1445 unsigned i;
1446 unsigned long packets = 0;
1447 int status = 0;
1448 struct urb *urbs[10]; /* FIXME no limit */
1450 if (param->sglen > 10)
1451 return -EDOM;
1453 memset(&context, 0, sizeof context);
1454 context.count = param->iterations * param->sglen;
1455 context.dev = dev;
1456 init_completion (&context.done);
1457 spin_lock_init (&context.lock);
1459 memset (urbs, 0, sizeof urbs);
1460 udev = testdev_to_usbdev (dev);
1461 dev_dbg (&dev->intf->dev,
1462 "... iso period %d %sframes, wMaxPacket %04x\n",
1463 1 << (desc->bInterval - 1),
1464 (udev->speed == USB_SPEED_HIGH) ? "micro" : "",
1465 le16_to_cpu(desc->wMaxPacketSize));
1467 for (i = 0; i < param->sglen; i++) {
1468 urbs [i] = iso_alloc_urb (udev, pipe, desc,
1469 param->length);
1470 if (!urbs [i]) {
1471 status = -ENOMEM;
1472 goto fail;
1474 packets += urbs[i]->number_of_packets;
1475 urbs [i]->context = &context;
1477 packets *= param->iterations;
1478 dev_dbg (&dev->intf->dev,
1479 "... total %lu msec (%lu packets)\n",
1480 (packets * (1 << (desc->bInterval - 1)))
1481 / ((udev->speed == USB_SPEED_HIGH) ? 8 : 1),
1482 packets);
1484 spin_lock_irq (&context.lock);
1485 for (i = 0; i < param->sglen; i++) {
1486 ++context.pending;
1487 status = usb_submit_urb (urbs [i], GFP_ATOMIC);
1488 if (status < 0) {
1489 ERROR (dev, "submit iso[%d], error %d\n", i, status);
1490 if (i == 0) {
1491 spin_unlock_irq (&context.lock);
1492 goto fail;
1495 simple_free_urb (urbs [i]);
1496 context.pending--;
1497 context.submit_error = 1;
1498 break;
1501 spin_unlock_irq (&context.lock);
1503 wait_for_completion (&context.done);
1506 * Isochronous transfers are expected to fail sometimes. As an
1507 * arbitrary limit, we will report an error if any submissions
1508 * fail or if the transfer failure rate is > 10%.
1510 if (status != 0)
1512 else if (context.submit_error)
1513 status = -EACCES;
1514 else if (context.errors > context.packet_count / 10)
1515 status = -EIO;
1516 return status;
1518 fail:
1519 for (i = 0; i < param->sglen; i++) {
1520 if (urbs [i])
1521 simple_free_urb (urbs [i]);
1523 return status;
1526 /*-------------------------------------------------------------------------*/
1528 /* We only have this one interface to user space, through usbfs.
1529 * User mode code can scan usbfs to find N different devices (maybe on
1530 * different busses) to use when testing, and allocate one thread per
1531 * test. So discovery is simplified, and we have no device naming issues.
1533 * Don't use these only as stress/load tests. Use them along with with
1534 * other USB bus activity: plugging, unplugging, mousing, mp3 playback,
1535 * video capture, and so on. Run different tests at different times, in
1536 * different sequences. Nothing here should interact with other devices,
1537 * except indirectly by consuming USB bandwidth and CPU resources for test
1538 * threads and request completion. But the only way to know that for sure
1539 * is to test when HC queues are in use by many devices.
1542 static int
1543 usbtest_ioctl (struct usb_interface *intf, unsigned int code, void *buf)
1545 struct usbtest_dev *dev = usb_get_intfdata (intf);
1546 struct usb_device *udev = testdev_to_usbdev (dev);
1547 struct usbtest_param *param = buf;
1548 int retval = -EOPNOTSUPP;
1549 struct urb *urb;
1550 struct scatterlist *sg;
1551 struct usb_sg_request req;
1552 struct timeval start;
1553 unsigned i;
1555 // FIXME USBDEVFS_CONNECTINFO doesn't say how fast the device is.
1557 if (code != USBTEST_REQUEST)
1558 return -EOPNOTSUPP;
1560 if (param->iterations <= 0 || param->length < 0
1561 || param->sglen < 0 || param->vary < 0)
1562 return -EINVAL;
1564 if (mutex_lock_interruptible(&dev->lock))
1565 return -ERESTARTSYS;
1567 if (intf->dev.power.power_state.event != PM_EVENT_ON) {
1568 mutex_unlock(&dev->lock);
1569 return -EHOSTUNREACH;
1572 /* some devices, like ez-usb default devices, need a non-default
1573 * altsetting to have any active endpoints. some tests change
1574 * altsettings; force a default so most tests don't need to check.
1576 if (dev->info->alt >= 0) {
1577 int res;
1579 if (intf->altsetting->desc.bInterfaceNumber) {
1580 mutex_unlock(&dev->lock);
1581 return -ENODEV;
1583 res = set_altsetting (dev, dev->info->alt);
1584 if (res) {
1585 dev_err (&intf->dev,
1586 "set altsetting to %d failed, %d\n",
1587 dev->info->alt, res);
1588 mutex_unlock(&dev->lock);
1589 return res;
1594 * Just a bunch of test cases that every HCD is expected to handle.
1596 * Some may need specific firmware, though it'd be good to have
1597 * one firmware image to handle all the test cases.
1599 * FIXME add more tests! cancel requests, verify the data, control
1600 * queueing, concurrent read+write threads, and so on.
1602 do_gettimeofday (&start);
1603 switch (param->test_num) {
1605 case 0:
1606 dev_dbg (&intf->dev, "TEST 0: NOP\n");
1607 retval = 0;
1608 break;
1610 /* Simple non-queued bulk I/O tests */
1611 case 1:
1612 if (dev->out_pipe == 0)
1613 break;
1614 dev_dbg (&intf->dev,
1615 "TEST 1: write %d bytes %u times\n",
1616 param->length, param->iterations);
1617 urb = simple_alloc_urb (udev, dev->out_pipe, param->length);
1618 if (!urb) {
1619 retval = -ENOMEM;
1620 break;
1622 // FIRMWARE: bulk sink (maybe accepts short writes)
1623 retval = simple_io (urb, param->iterations, 0, 0, "test1");
1624 simple_free_urb (urb);
1625 break;
1626 case 2:
1627 if (dev->in_pipe == 0)
1628 break;
1629 dev_dbg (&intf->dev,
1630 "TEST 2: read %d bytes %u times\n",
1631 param->length, param->iterations);
1632 urb = simple_alloc_urb (udev, dev->in_pipe, param->length);
1633 if (!urb) {
1634 retval = -ENOMEM;
1635 break;
1637 // FIRMWARE: bulk source (maybe generates short writes)
1638 retval = simple_io (urb, param->iterations, 0, 0, "test2");
1639 simple_free_urb (urb);
1640 break;
1641 case 3:
1642 if (dev->out_pipe == 0 || param->vary == 0)
1643 break;
1644 dev_dbg (&intf->dev,
1645 "TEST 3: write/%d 0..%d bytes %u times\n",
1646 param->vary, param->length, param->iterations);
1647 urb = simple_alloc_urb (udev, dev->out_pipe, param->length);
1648 if (!urb) {
1649 retval = -ENOMEM;
1650 break;
1652 // FIRMWARE: bulk sink (maybe accepts short writes)
1653 retval = simple_io (urb, param->iterations, param->vary,
1654 0, "test3");
1655 simple_free_urb (urb);
1656 break;
1657 case 4:
1658 if (dev->in_pipe == 0 || param->vary == 0)
1659 break;
1660 dev_dbg (&intf->dev,
1661 "TEST 4: read/%d 0..%d bytes %u times\n",
1662 param->vary, param->length, param->iterations);
1663 urb = simple_alloc_urb (udev, dev->in_pipe, param->length);
1664 if (!urb) {
1665 retval = -ENOMEM;
1666 break;
1668 // FIRMWARE: bulk source (maybe generates short writes)
1669 retval = simple_io (urb, param->iterations, param->vary,
1670 0, "test4");
1671 simple_free_urb (urb);
1672 break;
1674 /* Queued bulk I/O tests */
1675 case 5:
1676 if (dev->out_pipe == 0 || param->sglen == 0)
1677 break;
1678 dev_dbg (&intf->dev,
1679 "TEST 5: write %d sglists %d entries of %d bytes\n",
1680 param->iterations,
1681 param->sglen, param->length);
1682 sg = alloc_sglist (param->sglen, param->length, 0);
1683 if (!sg) {
1684 retval = -ENOMEM;
1685 break;
1687 // FIRMWARE: bulk sink (maybe accepts short writes)
1688 retval = perform_sglist (udev, param->iterations, dev->out_pipe,
1689 &req, sg, param->sglen);
1690 free_sglist (sg, param->sglen);
1691 break;
1693 case 6:
1694 if (dev->in_pipe == 0 || param->sglen == 0)
1695 break;
1696 dev_dbg (&intf->dev,
1697 "TEST 6: read %d sglists %d entries of %d bytes\n",
1698 param->iterations,
1699 param->sglen, param->length);
1700 sg = alloc_sglist (param->sglen, param->length, 0);
1701 if (!sg) {
1702 retval = -ENOMEM;
1703 break;
1705 // FIRMWARE: bulk source (maybe generates short writes)
1706 retval = perform_sglist (udev, param->iterations, dev->in_pipe,
1707 &req, sg, param->sglen);
1708 free_sglist (sg, param->sglen);
1709 break;
1710 case 7:
1711 if (dev->out_pipe == 0 || param->sglen == 0 || param->vary == 0)
1712 break;
1713 dev_dbg (&intf->dev,
1714 "TEST 7: write/%d %d sglists %d entries 0..%d bytes\n",
1715 param->vary, param->iterations,
1716 param->sglen, param->length);
1717 sg = alloc_sglist (param->sglen, param->length, param->vary);
1718 if (!sg) {
1719 retval = -ENOMEM;
1720 break;
1722 // FIRMWARE: bulk sink (maybe accepts short writes)
1723 retval = perform_sglist (udev, param->iterations, dev->out_pipe,
1724 &req, sg, param->sglen);
1725 free_sglist (sg, param->sglen);
1726 break;
1727 case 8:
1728 if (dev->in_pipe == 0 || param->sglen == 0 || param->vary == 0)
1729 break;
1730 dev_dbg (&intf->dev,
1731 "TEST 8: read/%d %d sglists %d entries 0..%d bytes\n",
1732 param->vary, param->iterations,
1733 param->sglen, param->length);
1734 sg = alloc_sglist (param->sglen, param->length, param->vary);
1735 if (!sg) {
1736 retval = -ENOMEM;
1737 break;
1739 // FIRMWARE: bulk source (maybe generates short writes)
1740 retval = perform_sglist (udev, param->iterations, dev->in_pipe,
1741 &req, sg, param->sglen);
1742 free_sglist (sg, param->sglen);
1743 break;
1745 /* non-queued sanity tests for control (chapter 9 subset) */
1746 case 9:
1747 retval = 0;
1748 dev_dbg (&intf->dev,
1749 "TEST 9: ch9 (subset) control tests, %d times\n",
1750 param->iterations);
1751 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1752 retval = ch9_postconfig (dev);
1753 if (retval)
1754 dbg ("ch9 subset failed, iterations left %d", i);
1755 break;
1757 /* queued control messaging */
1758 case 10:
1759 if (param->sglen == 0)
1760 break;
1761 retval = 0;
1762 dev_dbg (&intf->dev,
1763 "TEST 10: queue %d control calls, %d times\n",
1764 param->sglen,
1765 param->iterations);
1766 retval = test_ctrl_queue (dev, param);
1767 break;
1769 /* simple non-queued unlinks (ring with one urb) */
1770 case 11:
1771 if (dev->in_pipe == 0 || !param->length)
1772 break;
1773 retval = 0;
1774 dev_dbg (&intf->dev, "TEST 11: unlink %d reads of %d\n",
1775 param->iterations, param->length);
1776 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1777 retval = unlink_simple (dev, dev->in_pipe,
1778 param->length);
1779 if (retval)
1780 dev_dbg (&intf->dev, "unlink reads failed %d, "
1781 "iterations left %d\n", retval, i);
1782 break;
1783 case 12:
1784 if (dev->out_pipe == 0 || !param->length)
1785 break;
1786 retval = 0;
1787 dev_dbg (&intf->dev, "TEST 12: unlink %d writes of %d\n",
1788 param->iterations, param->length);
1789 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1790 retval = unlink_simple (dev, dev->out_pipe,
1791 param->length);
1792 if (retval)
1793 dev_dbg (&intf->dev, "unlink writes failed %d, "
1794 "iterations left %d\n", retval, i);
1795 break;
1797 /* ep halt tests */
1798 case 13:
1799 if (dev->out_pipe == 0 && dev->in_pipe == 0)
1800 break;
1801 retval = 0;
1802 dev_dbg (&intf->dev, "TEST 13: set/clear %d halts\n",
1803 param->iterations);
1804 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1805 retval = halt_simple (dev);
1807 if (retval)
1808 DBG (dev, "halts failed, iterations left %d\n", i);
1809 break;
1811 /* control write tests */
1812 case 14:
1813 if (!dev->info->ctrl_out)
1814 break;
1815 dev_dbg (&intf->dev, "TEST 14: %d ep0out, %d..%d vary %d\n",
1816 param->iterations,
1817 realworld ? 1 : 0, param->length,
1818 param->vary);
1819 retval = ctrl_out (dev, param->iterations,
1820 param->length, param->vary);
1821 break;
1823 /* iso write tests */
1824 case 15:
1825 if (dev->out_iso_pipe == 0 || param->sglen == 0)
1826 break;
1827 dev_dbg (&intf->dev,
1828 "TEST 15: write %d iso, %d entries of %d bytes\n",
1829 param->iterations,
1830 param->sglen, param->length);
1831 // FIRMWARE: iso sink
1832 retval = test_iso_queue (dev, param,
1833 dev->out_iso_pipe, dev->iso_out);
1834 break;
1836 /* iso read tests */
1837 case 16:
1838 if (dev->in_iso_pipe == 0 || param->sglen == 0)
1839 break;
1840 dev_dbg (&intf->dev,
1841 "TEST 16: read %d iso, %d entries of %d bytes\n",
1842 param->iterations,
1843 param->sglen, param->length);
1844 // FIRMWARE: iso source
1845 retval = test_iso_queue (dev, param,
1846 dev->in_iso_pipe, dev->iso_in);
1847 break;
1849 // FIXME unlink from queue (ring with N urbs)
1851 // FIXME scatterlist cancel (needs helper thread)
1854 do_gettimeofday (&param->duration);
1855 param->duration.tv_sec -= start.tv_sec;
1856 param->duration.tv_usec -= start.tv_usec;
1857 if (param->duration.tv_usec < 0) {
1858 param->duration.tv_usec += 1000 * 1000;
1859 param->duration.tv_sec -= 1;
1861 mutex_unlock(&dev->lock);
1862 return retval;
1865 /*-------------------------------------------------------------------------*/
1867 static unsigned force_interrupt = 0;
1868 module_param (force_interrupt, uint, 0);
1869 MODULE_PARM_DESC (force_interrupt, "0 = test default; else interrupt");
1871 #ifdef GENERIC
1872 static unsigned short vendor;
1873 module_param(vendor, ushort, 0);
1874 MODULE_PARM_DESC (vendor, "vendor code (from usb-if)");
1876 static unsigned short product;
1877 module_param(product, ushort, 0);
1878 MODULE_PARM_DESC (product, "product code (from vendor)");
1879 #endif
1881 static int
1882 usbtest_probe (struct usb_interface *intf, const struct usb_device_id *id)
1884 struct usb_device *udev;
1885 struct usbtest_dev *dev;
1886 struct usbtest_info *info;
1887 char *rtest, *wtest;
1888 char *irtest, *iwtest;
1890 udev = interface_to_usbdev (intf);
1892 #ifdef GENERIC
1893 /* specify devices by module parameters? */
1894 if (id->match_flags == 0) {
1895 /* vendor match required, product match optional */
1896 if (!vendor || le16_to_cpu(udev->descriptor.idVendor) != (u16)vendor)
1897 return -ENODEV;
1898 if (product && le16_to_cpu(udev->descriptor.idProduct) != (u16)product)
1899 return -ENODEV;
1900 dbg ("matched module params, vend=0x%04x prod=0x%04x",
1901 le16_to_cpu(udev->descriptor.idVendor),
1902 le16_to_cpu(udev->descriptor.idProduct));
1904 #endif
1906 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1907 if (!dev)
1908 return -ENOMEM;
1909 info = (struct usbtest_info *) id->driver_info;
1910 dev->info = info;
1911 mutex_init(&dev->lock);
1913 dev->intf = intf;
1915 /* cacheline-aligned scratch for i/o */
1916 if ((dev->buf = kmalloc (TBUF_SIZE, GFP_KERNEL)) == NULL) {
1917 kfree (dev);
1918 return -ENOMEM;
1921 /* NOTE this doesn't yet test the handful of difference that are
1922 * visible with high speed interrupts: bigger maxpacket (1K) and
1923 * "high bandwidth" modes (up to 3 packets/uframe).
1925 rtest = wtest = "";
1926 irtest = iwtest = "";
1927 if (force_interrupt || udev->speed == USB_SPEED_LOW) {
1928 if (info->ep_in) {
1929 dev->in_pipe = usb_rcvintpipe (udev, info->ep_in);
1930 rtest = " intr-in";
1932 if (info->ep_out) {
1933 dev->out_pipe = usb_sndintpipe (udev, info->ep_out);
1934 wtest = " intr-out";
1936 } else {
1937 if (info->autoconf) {
1938 int status;
1940 status = get_endpoints (dev, intf);
1941 if (status < 0) {
1942 dbg ("couldn't get endpoints, %d\n", status);
1943 return status;
1945 /* may find bulk or ISO pipes */
1946 } else {
1947 if (info->ep_in)
1948 dev->in_pipe = usb_rcvbulkpipe (udev,
1949 info->ep_in);
1950 if (info->ep_out)
1951 dev->out_pipe = usb_sndbulkpipe (udev,
1952 info->ep_out);
1954 if (dev->in_pipe)
1955 rtest = " bulk-in";
1956 if (dev->out_pipe)
1957 wtest = " bulk-out";
1958 if (dev->in_iso_pipe)
1959 irtest = " iso-in";
1960 if (dev->out_iso_pipe)
1961 iwtest = " iso-out";
1964 usb_set_intfdata (intf, dev);
1965 dev_info (&intf->dev, "%s\n", info->name);
1966 dev_info (&intf->dev, "%s speed {control%s%s%s%s%s} tests%s\n",
1967 ({ char *tmp;
1968 switch (udev->speed) {
1969 case USB_SPEED_LOW: tmp = "low"; break;
1970 case USB_SPEED_FULL: tmp = "full"; break;
1971 case USB_SPEED_HIGH: tmp = "high"; break;
1972 default: tmp = "unknown"; break;
1973 }; tmp; }),
1974 info->ctrl_out ? " in/out" : "",
1975 rtest, wtest,
1976 irtest, iwtest,
1977 info->alt >= 0 ? " (+alt)" : "");
1978 return 0;
1981 static int usbtest_suspend (struct usb_interface *intf, pm_message_t message)
1983 return 0;
1986 static int usbtest_resume (struct usb_interface *intf)
1988 return 0;
1992 static void usbtest_disconnect (struct usb_interface *intf)
1994 struct usbtest_dev *dev = usb_get_intfdata (intf);
1996 usb_set_intfdata (intf, NULL);
1997 dev_dbg (&intf->dev, "disconnect\n");
1998 kfree (dev);
2001 /* Basic testing only needs a device that can source or sink bulk traffic.
2002 * Any device can test control transfers (default with GENERIC binding).
2004 * Several entries work with the default EP0 implementation that's built
2005 * into EZ-USB chips. There's a default vendor ID which can be overridden
2006 * by (very) small config EEPROMS, but otherwise all these devices act
2007 * identically until firmware is loaded: only EP0 works. It turns out
2008 * to be easy to make other endpoints work, without modifying that EP0
2009 * behavior. For now, we expect that kind of firmware.
2012 /* an21xx or fx versions of ez-usb */
2013 static struct usbtest_info ez1_info = {
2014 .name = "EZ-USB device",
2015 .ep_in = 2,
2016 .ep_out = 2,
2017 .alt = 1,
2020 /* fx2 version of ez-usb */
2021 static struct usbtest_info ez2_info = {
2022 .name = "FX2 device",
2023 .ep_in = 6,
2024 .ep_out = 2,
2025 .alt = 1,
2028 /* ezusb family device with dedicated usb test firmware,
2030 static struct usbtest_info fw_info = {
2031 .name = "usb test device",
2032 .ep_in = 2,
2033 .ep_out = 2,
2034 .alt = 1,
2035 .autoconf = 1, // iso and ctrl_out need autoconf
2036 .ctrl_out = 1,
2037 .iso = 1, // iso_ep's are #8 in/out
2040 /* peripheral running Linux and 'zero.c' test firmware, or
2041 * its user-mode cousin. different versions of this use
2042 * different hardware with the same vendor/product codes.
2043 * host side MUST rely on the endpoint descriptors.
2045 static struct usbtest_info gz_info = {
2046 .name = "Linux gadget zero",
2047 .autoconf = 1,
2048 .ctrl_out = 1,
2049 .alt = 0,
2052 static struct usbtest_info um_info = {
2053 .name = "Linux user mode test driver",
2054 .autoconf = 1,
2055 .alt = -1,
2058 static struct usbtest_info um2_info = {
2059 .name = "Linux user mode ISO test driver",
2060 .autoconf = 1,
2061 .iso = 1,
2062 .alt = -1,
2065 #ifdef IBOT2
2066 /* this is a nice source of high speed bulk data;
2067 * uses an FX2, with firmware provided in the device
2069 static struct usbtest_info ibot2_info = {
2070 .name = "iBOT2 webcam",
2071 .ep_in = 2,
2072 .alt = -1,
2074 #endif
2076 #ifdef GENERIC
2077 /* we can use any device to test control traffic */
2078 static struct usbtest_info generic_info = {
2079 .name = "Generic USB device",
2080 .alt = -1,
2082 #endif
2084 // FIXME remove this
2085 static struct usbtest_info hact_info = {
2086 .name = "FX2/hact",
2087 //.ep_in = 6,
2088 .ep_out = 2,
2089 .alt = -1,
2093 static struct usb_device_id id_table [] = {
2095 { USB_DEVICE (0x0547, 0x1002),
2096 .driver_info = (unsigned long) &hact_info,
2099 /*-------------------------------------------------------------*/
2101 /* EZ-USB devices which download firmware to replace (or in our
2102 * case augment) the default device implementation.
2105 /* generic EZ-USB FX controller */
2106 { USB_DEVICE (0x0547, 0x2235),
2107 .driver_info = (unsigned long) &ez1_info,
2110 /* CY3671 development board with EZ-USB FX */
2111 { USB_DEVICE (0x0547, 0x0080),
2112 .driver_info = (unsigned long) &ez1_info,
2115 /* generic EZ-USB FX2 controller (or development board) */
2116 { USB_DEVICE (0x04b4, 0x8613),
2117 .driver_info = (unsigned long) &ez2_info,
2120 /* re-enumerated usb test device firmware */
2121 { USB_DEVICE (0xfff0, 0xfff0),
2122 .driver_info = (unsigned long) &fw_info,
2125 /* "Gadget Zero" firmware runs under Linux */
2126 { USB_DEVICE (0x0525, 0xa4a0),
2127 .driver_info = (unsigned long) &gz_info,
2130 /* so does a user-mode variant */
2131 { USB_DEVICE (0x0525, 0xa4a4),
2132 .driver_info = (unsigned long) &um_info,
2135 /* ... and a user-mode variant that talks iso */
2136 { USB_DEVICE (0x0525, 0xa4a3),
2137 .driver_info = (unsigned long) &um2_info,
2140 #ifdef KEYSPAN_19Qi
2141 /* Keyspan 19qi uses an21xx (original EZ-USB) */
2142 // this does not coexist with the real Keyspan 19qi driver!
2143 { USB_DEVICE (0x06cd, 0x010b),
2144 .driver_info = (unsigned long) &ez1_info,
2146 #endif
2148 /*-------------------------------------------------------------*/
2150 #ifdef IBOT2
2151 /* iBOT2 makes a nice source of high speed bulk-in data */
2152 // this does not coexist with a real iBOT2 driver!
2153 { USB_DEVICE (0x0b62, 0x0059),
2154 .driver_info = (unsigned long) &ibot2_info,
2156 #endif
2158 /*-------------------------------------------------------------*/
2160 #ifdef GENERIC
2161 /* module params can specify devices to use for control tests */
2162 { .driver_info = (unsigned long) &generic_info, },
2163 #endif
2165 /*-------------------------------------------------------------*/
2169 MODULE_DEVICE_TABLE (usb, id_table);
2171 static struct usb_driver usbtest_driver = {
2172 .name = "usbtest",
2173 .id_table = id_table,
2174 .probe = usbtest_probe,
2175 .ioctl = usbtest_ioctl,
2176 .disconnect = usbtest_disconnect,
2177 .suspend = usbtest_suspend,
2178 .resume = usbtest_resume,
2181 /*-------------------------------------------------------------------------*/
2183 static int __init usbtest_init (void)
2185 #ifdef GENERIC
2186 if (vendor)
2187 dbg ("params: vend=0x%04x prod=0x%04x", vendor, product);
2188 #endif
2189 return usb_register (&usbtest_driver);
2191 module_init (usbtest_init);
2193 static void __exit usbtest_exit (void)
2195 usb_deregister (&usbtest_driver);
2197 module_exit (usbtest_exit);
2199 MODULE_DESCRIPTION ("USB Core/HCD Testing Driver");
2200 MODULE_LICENSE ("GPL");