allow coexistance of N build and AC build.
[tomato.git] / release / src-rt-6.x / linux / linux-2.6 / drivers / usb / misc / usbtest.c
blob49617aff198763d207f074b0a1967cda8ba6c6e3
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>
10 #include <linux/usb.h>
13 /*-------------------------------------------------------------------------*/
15 // FIXME make these public somewhere; usbdevfs.h?
17 struct usbtest_param {
18 // inputs
19 unsigned test_num; /* 0..(TEST_CASES-1) */
20 unsigned iterations;
21 unsigned length;
22 unsigned vary;
23 unsigned sglen;
25 // outputs
26 struct timeval duration;
28 #define USBTEST_REQUEST _IOWR('U', 100, struct usbtest_param)
30 /*-------------------------------------------------------------------------*/
32 #define GENERIC /* let probe() bind using module params */
34 /* Some devices that can be used for testing will have "real" drivers.
35 * Entries for those need to be enabled here by hand, after disabling
36 * that "real" driver.
38 //#define IBOT2 /* grab iBOT2 webcams */
39 //#define KEYSPAN_19Qi /* grab un-renumerated serial adapter */
41 /*-------------------------------------------------------------------------*/
43 struct usbtest_info {
44 const char *name;
45 u8 ep_in; /* bulk/intr source */
46 u8 ep_out; /* bulk/intr sink */
47 unsigned autoconf : 1;
48 unsigned ctrl_out : 1;
49 unsigned iso : 1; /* try iso in/out */
50 int alt;
53 /* this is accessed only through usbfs ioctl calls.
54 * one ioctl to issue a test ... one lock per device.
55 * tests create other threads if they need them.
56 * urbs and buffers are allocated dynamically,
57 * and data generated deterministically.
59 struct usbtest_dev {
60 struct usb_interface *intf;
61 struct usbtest_info *info;
62 int in_pipe;
63 int out_pipe;
64 int in_iso_pipe;
65 int out_iso_pipe;
66 struct usb_endpoint_descriptor *iso_in, *iso_out;
67 struct semaphore sem;
69 #define TBUF_SIZE 256
70 u8 *buf;
73 static struct usb_device *testdev_to_usbdev (struct usbtest_dev *test)
75 return interface_to_usbdev (test->intf);
78 /* set up all urbs so they can be used with either bulk or interrupt */
79 #define INTERRUPT_RATE 1 /* msec/transfer */
81 #define xprintk(tdev,level,fmt,args...) \
82 dev_printk(level , &(tdev)->intf->dev , fmt , ## args)
84 #ifdef DEBUG
85 #define DBG(dev,fmt,args...) \
86 xprintk(dev , KERN_DEBUG , fmt , ## args)
87 #else
88 #define DBG(dev,fmt,args...) \
89 do { } while (0)
90 #endif /* DEBUG */
92 #ifdef VERBOSE
93 #define VDBG DBG
94 #else
95 #define VDBG(dev,fmt,args...) \
96 do { } while (0)
97 #endif /* VERBOSE */
99 #define ERROR(dev,fmt,args...) \
100 xprintk(dev , KERN_ERR , fmt , ## args)
101 #define WARN(dev,fmt,args...) \
102 xprintk(dev , KERN_WARNING , fmt , ## args)
103 #define INFO(dev,fmt,args...) \
104 xprintk(dev , KERN_INFO , fmt , ## args)
106 /*-------------------------------------------------------------------------*/
108 static int
109 get_endpoints (struct usbtest_dev *dev, struct usb_interface *intf)
111 int tmp;
112 struct usb_host_interface *alt;
113 struct usb_host_endpoint *in, *out;
114 struct usb_host_endpoint *iso_in, *iso_out;
115 struct usb_device *udev;
117 for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
118 unsigned ep;
120 in = out = NULL;
121 iso_in = iso_out = NULL;
122 alt = intf->altsetting + tmp;
124 /* take the first altsetting with in-bulk + out-bulk;
125 * ignore other endpoints and altsetttings.
127 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
128 struct usb_host_endpoint *e;
130 e = alt->endpoint + ep;
131 switch (e->desc.bmAttributes) {
132 case USB_ENDPOINT_XFER_BULK:
133 break;
134 case USB_ENDPOINT_XFER_ISOC:
135 if (dev->info->iso)
136 goto try_iso;
137 // FALLTHROUGH
138 default:
139 continue;
141 if (usb_endpoint_dir_in(&e->desc)) {
142 if (!in)
143 in = e;
144 } else {
145 if (!out)
146 out = e;
148 continue;
149 try_iso:
150 if (usb_endpoint_dir_in(&e->desc)) {
151 if (!iso_in)
152 iso_in = e;
153 } else {
154 if (!iso_out)
155 iso_out = e;
158 if ((in && out) || (iso_in && iso_out))
159 goto found;
161 return -EINVAL;
163 found:
164 udev = testdev_to_usbdev (dev);
165 if (alt->desc.bAlternateSetting != 0) {
166 tmp = usb_set_interface (udev,
167 alt->desc.bInterfaceNumber,
168 alt->desc.bAlternateSetting);
169 if (tmp < 0)
170 return tmp;
173 if (in) {
174 dev->in_pipe = usb_rcvbulkpipe (udev,
175 in->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
176 dev->out_pipe = usb_sndbulkpipe (udev,
177 out->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
179 if (iso_in) {
180 dev->iso_in = &iso_in->desc;
181 dev->in_iso_pipe = usb_rcvisocpipe (udev,
182 iso_in->desc.bEndpointAddress
183 & USB_ENDPOINT_NUMBER_MASK);
184 dev->iso_out = &iso_out->desc;
185 dev->out_iso_pipe = usb_sndisocpipe (udev,
186 iso_out->desc.bEndpointAddress
187 & USB_ENDPOINT_NUMBER_MASK);
189 return 0;
192 /*-------------------------------------------------------------------------*/
194 /* Support for testing basic non-queued I/O streams.
196 * These just package urbs as requests that can be easily canceled.
197 * Each urb's data buffer is dynamically allocated; callers can fill
198 * them with non-zero test data (or test for it) when appropriate.
201 static void simple_callback (struct urb *urb)
203 complete ((struct completion *) urb->context);
206 static struct urb *simple_alloc_urb (
207 struct usb_device *udev,
208 int pipe,
209 unsigned long bytes
212 struct urb *urb;
214 urb = usb_alloc_urb (0, GFP_KERNEL);
215 if (!urb)
216 return urb;
217 usb_fill_bulk_urb (urb, udev, pipe, NULL, bytes, simple_callback, NULL);
218 urb->interval = (udev->speed == USB_SPEED_HIGH)
219 ? (INTERRUPT_RATE << 3)
220 : INTERRUPT_RATE;
221 urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
222 if (usb_pipein (pipe))
223 urb->transfer_flags |= URB_SHORT_NOT_OK;
224 urb->transfer_buffer = usb_buffer_alloc (udev, bytes, GFP_KERNEL,
225 &urb->transfer_dma);
226 if (!urb->transfer_buffer) {
227 usb_free_urb (urb);
228 urb = NULL;
229 } else
230 memset (urb->transfer_buffer, 0, bytes);
231 return urb;
234 static unsigned pattern = 0;
235 module_param (pattern, uint, S_IRUGO);
236 // MODULE_PARM_DESC (pattern, "i/o pattern (0 == zeroes)");
238 static inline void simple_fill_buf (struct urb *urb)
240 unsigned i;
241 u8 *buf = urb->transfer_buffer;
242 unsigned len = urb->transfer_buffer_length;
244 switch (pattern) {
245 default:
246 // FALLTHROUGH
247 case 0:
248 memset (buf, 0, len);
249 break;
250 case 1: /* mod63 */
251 for (i = 0; i < len; i++)
252 *buf++ = (u8) (i % 63);
253 break;
257 static inline int simple_check_buf (struct urb *urb)
259 unsigned i;
260 u8 expected;
261 u8 *buf = urb->transfer_buffer;
262 unsigned len = urb->actual_length;
264 for (i = 0; i < len; i++, buf++) {
265 switch (pattern) {
266 /* all-zeroes has no synchronization issues */
267 case 0:
268 expected = 0;
269 break;
270 /* mod63 stays in sync with short-terminated transfers,
271 * or otherwise when host and gadget agree on how large
272 * each usb transfer request should be. resync is done
273 * with set_interface or set_config.
275 case 1: /* mod63 */
276 expected = i % 63;
277 break;
278 /* always fail unsupported patterns */
279 default:
280 expected = !*buf;
281 break;
283 if (*buf == expected)
284 continue;
285 dbg ("buf[%d] = %d (not %d)", i, *buf, expected);
286 return -EINVAL;
288 return 0;
291 static void simple_free_urb (struct urb *urb)
293 usb_buffer_free (urb->dev, urb->transfer_buffer_length,
294 urb->transfer_buffer, urb->transfer_dma);
295 usb_free_urb (urb);
298 static int simple_io (
299 struct urb *urb,
300 int iterations,
301 int vary,
302 int expected,
303 const char *label
306 struct usb_device *udev = urb->dev;
307 int max = urb->transfer_buffer_length;
308 struct completion completion;
309 int retval = 0;
311 urb->context = &completion;
312 while (retval == 0 && iterations-- > 0) {
313 init_completion (&completion);
314 if (usb_pipeout (urb->pipe))
315 simple_fill_buf (urb);
316 if ((retval = usb_submit_urb (urb, GFP_KERNEL)) != 0)
317 break;
319 /* NOTE: no timeouts; can't be broken out of by interrupt */
320 wait_for_completion (&completion);
321 retval = urb->status;
322 urb->dev = udev;
323 if (retval == 0 && usb_pipein (urb->pipe))
324 retval = simple_check_buf (urb);
326 if (vary) {
327 int len = urb->transfer_buffer_length;
329 len += vary;
330 len %= max;
331 if (len == 0)
332 len = (vary < max) ? vary : max;
333 urb->transfer_buffer_length = len;
336 /* FIXME if endpoint halted, clear halt (and log) */
338 urb->transfer_buffer_length = max;
340 if (expected != retval)
341 dev_dbg (&udev->dev,
342 "%s failed, iterations left %d, status %d (not %d)\n",
343 label, iterations, retval, expected);
344 return retval;
348 /*-------------------------------------------------------------------------*/
350 /* We use scatterlist primitives to test queued I/O.
351 * Yes, this also tests the scatterlist primitives.
354 static void free_sglist (struct scatterlist *sg, int nents)
356 unsigned i;
358 if (!sg)
359 return;
360 for (i = 0; i < nents; i++) {
361 if (!sg_page(&sg[i]))
362 continue;
363 kfree (sg_virt(&sg[i]));
365 kfree (sg);
368 static struct scatterlist *
369 alloc_sglist (int nents, int max, int vary)
371 struct scatterlist *sg;
372 unsigned i;
373 unsigned size = max;
375 sg = kmalloc (nents * sizeof *sg, GFP_KERNEL);
376 if (!sg)
377 return NULL;
379 for (i = 0; i < nents; i++) {
380 char *buf;
381 unsigned j;
383 buf = kzalloc (size, GFP_KERNEL);
384 if (!buf) {
385 free_sglist (sg, i);
386 return NULL;
389 /* kmalloc pages are always physically contiguous! */
390 sg_init_one(&sg[i], buf, size);
392 switch (pattern) {
393 case 0:
394 /* already zeroed */
395 break;
396 case 1:
397 for (j = 0; j < size; j++)
398 *buf++ = (u8) (j % 63);
399 break;
402 if (vary) {
403 size += vary;
404 size %= max;
405 if (size == 0)
406 size = (vary < max) ? vary : max;
410 return sg;
413 static int perform_sglist (
414 struct usb_device *udev,
415 unsigned iterations,
416 int pipe,
417 struct usb_sg_request *req,
418 struct scatterlist *sg,
419 int nents
422 int retval = 0;
424 while (retval == 0 && iterations-- > 0) {
425 retval = usb_sg_init (req, udev, pipe,
426 (udev->speed == USB_SPEED_HIGH)
427 ? (INTERRUPT_RATE << 3)
428 : INTERRUPT_RATE,
429 sg, nents, 0, GFP_KERNEL);
431 if (retval)
432 break;
433 usb_sg_wait (req);
434 retval = req->status;
436 /* FIXME check resulting data pattern */
438 /* FIXME if endpoint halted, clear halt (and log) */
441 // FIXME for unlink or fault handling tests, don't report
442 // failure if retval is as we expected ...
444 if (retval)
445 dbg ("perform_sglist failed, iterations left %d, status %d",
446 iterations, retval);
447 return retval;
451 /*-------------------------------------------------------------------------*/
453 /* unqueued control message testing
455 * there's a nice set of device functional requirements in chapter 9 of the
456 * usb 2.0 spec, which we can apply to ANY device, even ones that don't use
457 * special test firmware.
459 * we know the device is configured (or suspended) by the time it's visible
460 * through usbfs. we can't change that, so we won't test enumeration (which
461 * worked 'well enough' to get here, this time), power management (ditto),
462 * or remote wakeup (which needs human interaction).
465 static unsigned realworld = 1;
466 module_param (realworld, uint, 0);
467 MODULE_PARM_DESC (realworld, "clear to demand stricter spec compliance");
469 static int get_altsetting (struct usbtest_dev *dev)
471 struct usb_interface *iface = dev->intf;
472 struct usb_device *udev = interface_to_usbdev (iface);
473 int retval;
475 retval = usb_control_msg (udev, usb_rcvctrlpipe (udev, 0),
476 USB_REQ_GET_INTERFACE, USB_DIR_IN|USB_RECIP_INTERFACE,
477 0, iface->altsetting [0].desc.bInterfaceNumber,
478 dev->buf, 1, USB_CTRL_GET_TIMEOUT);
479 switch (retval) {
480 case 1:
481 return dev->buf [0];
482 case 0:
483 retval = -ERANGE;
484 // FALLTHROUGH
485 default:
486 return retval;
490 static int set_altsetting (struct usbtest_dev *dev, int alternate)
492 struct usb_interface *iface = dev->intf;
493 struct usb_device *udev;
495 if (alternate < 0 || alternate >= 256)
496 return -EINVAL;
498 udev = interface_to_usbdev (iface);
499 return usb_set_interface (udev,
500 iface->altsetting [0].desc.bInterfaceNumber,
501 alternate);
504 static int is_good_config (char *buf, int len)
506 struct usb_config_descriptor *config;
508 if (len < sizeof *config)
509 return 0;
510 config = (struct usb_config_descriptor *) buf;
512 switch (config->bDescriptorType) {
513 case USB_DT_CONFIG:
514 case USB_DT_OTHER_SPEED_CONFIG:
515 if (config->bLength != 9) {
516 dbg ("bogus config descriptor length");
517 return 0;
519 /* this bit 'must be 1' but often isn't */
520 if (!realworld && !(config->bmAttributes & 0x80)) {
521 dbg ("high bit of config attributes not set");
522 return 0;
524 if (config->bmAttributes & 0x1f) { /* reserved == 0 */
525 dbg ("reserved config bits set");
526 return 0;
528 break;
529 default:
530 return 0;
533 if (le16_to_cpu(config->wTotalLength) == len) /* read it all */
534 return 1;
535 if (le16_to_cpu(config->wTotalLength) >= TBUF_SIZE) /* max partial read */
536 return 1;
537 dbg ("bogus config descriptor read size");
538 return 0;
541 /* sanity test for standard requests working with usb_control_mesg() and some
542 * of the utility functions which use it.
544 * this doesn't test how endpoint halts behave or data toggles get set, since
545 * we won't do I/O to bulk/interrupt endpoints here (which is how to change
546 * halt or toggle). toggle testing is impractical without support from hcds.
548 * this avoids failing devices linux would normally work with, by not testing
549 * config/altsetting operations for devices that only support their defaults.
550 * such devices rarely support those needless operations.
552 * NOTE that since this is a sanity test, it's not examining boundary cases
553 * to see if usbcore, hcd, and device all behave right. such testing would
554 * involve varied read sizes and other operation sequences.
556 static int ch9_postconfig (struct usbtest_dev *dev)
558 struct usb_interface *iface = dev->intf;
559 struct usb_device *udev = interface_to_usbdev (iface);
560 int i, alt, retval;
562 /* [9.2.3] if there's more than one altsetting, we need to be able to
563 * set and get each one. mostly trusts the descriptors from usbcore.
565 for (i = 0; i < iface->num_altsetting; i++) {
567 /* 9.2.3 constrains the range here */
568 alt = iface->altsetting [i].desc.bAlternateSetting;
569 if (alt < 0 || alt >= iface->num_altsetting) {
570 dev_dbg (&iface->dev,
571 "invalid alt [%d].bAltSetting = %d\n",
572 i, alt);
575 /* [real world] get/set unimplemented if there's only one */
576 if (realworld && iface->num_altsetting == 1)
577 continue;
579 /* [9.4.10] set_interface */
580 retval = set_altsetting (dev, alt);
581 if (retval) {
582 dev_dbg (&iface->dev, "can't set_interface = %d, %d\n",
583 alt, retval);
584 return retval;
587 /* [9.4.4] get_interface always works */
588 retval = get_altsetting (dev);
589 if (retval != alt) {
590 dev_dbg (&iface->dev, "get alt should be %d, was %d\n",
591 alt, retval);
592 return (retval < 0) ? retval : -EDOM;
597 /* [real world] get_config unimplemented if there's only one */
598 if (!realworld || udev->descriptor.bNumConfigurations != 1) {
599 int expected = udev->actconfig->desc.bConfigurationValue;
601 /* [9.4.2] get_configuration always works
602 * ... although some cheap devices (like one TI Hub I've got)
603 * won't return config descriptors except before set_config.
605 retval = usb_control_msg (udev, usb_rcvctrlpipe (udev, 0),
606 USB_REQ_GET_CONFIGURATION,
607 USB_DIR_IN | USB_RECIP_DEVICE,
608 0, 0, dev->buf, 1, USB_CTRL_GET_TIMEOUT);
609 if (retval != 1 || dev->buf [0] != expected) {
610 dev_dbg (&iface->dev, "get config --> %d %d (1 %d)\n",
611 retval, dev->buf[0], expected);
612 return (retval < 0) ? retval : -EDOM;
616 /* there's always [9.4.3] a device descriptor [9.6.1] */
617 retval = usb_get_descriptor (udev, USB_DT_DEVICE, 0,
618 dev->buf, sizeof udev->descriptor);
619 if (retval != sizeof udev->descriptor) {
620 dev_dbg (&iface->dev, "dev descriptor --> %d\n", retval);
621 return (retval < 0) ? retval : -EDOM;
624 /* there's always [9.4.3] at least one config descriptor [9.6.3] */
625 for (i = 0; i < udev->descriptor.bNumConfigurations; i++) {
626 retval = usb_get_descriptor (udev, USB_DT_CONFIG, i,
627 dev->buf, TBUF_SIZE);
628 if (!is_good_config (dev->buf, retval)) {
629 dev_dbg (&iface->dev,
630 "config [%d] descriptor --> %d\n",
631 i, retval);
632 return (retval < 0) ? retval : -EDOM;
635 // FIXME cross-checking udev->config[i] to make sure usbcore
636 // parsed it right (etc) would be good testing paranoia
639 /* and sometimes [9.2.6.6] speed dependent descriptors */
640 if (le16_to_cpu(udev->descriptor.bcdUSB) == 0x0200) {
641 struct usb_qualifier_descriptor *d = NULL;
643 /* device qualifier [9.6.2] */
644 retval = usb_get_descriptor (udev,
645 USB_DT_DEVICE_QUALIFIER, 0, dev->buf,
646 sizeof (struct usb_qualifier_descriptor));
647 if (retval == -EPIPE) {
648 if (udev->speed == USB_SPEED_HIGH) {
649 dev_dbg (&iface->dev,
650 "hs dev qualifier --> %d\n",
651 retval);
652 return (retval < 0) ? retval : -EDOM;
654 /* usb2.0 but not high-speed capable; fine */
655 } else if (retval != sizeof (struct usb_qualifier_descriptor)) {
656 dev_dbg (&iface->dev, "dev qualifier --> %d\n", retval);
657 return (retval < 0) ? retval : -EDOM;
658 } else
659 d = (struct usb_qualifier_descriptor *) dev->buf;
661 /* might not have [9.6.2] any other-speed configs [9.6.4] */
662 if (d) {
663 unsigned max = d->bNumConfigurations;
664 for (i = 0; i < max; i++) {
665 retval = usb_get_descriptor (udev,
666 USB_DT_OTHER_SPEED_CONFIG, i,
667 dev->buf, TBUF_SIZE);
668 if (!is_good_config (dev->buf, retval)) {
669 dev_dbg (&iface->dev,
670 "other speed config --> %d\n",
671 retval);
672 return (retval < 0) ? retval : -EDOM;
677 // FIXME fetch strings from at least the device descriptor
679 /* [9.4.5] get_status always works */
680 retval = usb_get_status (udev, USB_RECIP_DEVICE, 0, dev->buf);
681 if (retval != 2) {
682 dev_dbg (&iface->dev, "get dev status --> %d\n", retval);
683 return (retval < 0) ? retval : -EDOM;
686 // FIXME configuration.bmAttributes says if we could try to set/clear
687 // the device's remote wakeup feature ... if we can, test that here
689 retval = usb_get_status (udev, USB_RECIP_INTERFACE,
690 iface->altsetting [0].desc.bInterfaceNumber, dev->buf);
691 if (retval != 2) {
692 dev_dbg (&iface->dev, "get interface status --> %d\n", retval);
693 return (retval < 0) ? retval : -EDOM;
695 // FIXME get status for each endpoint in the interface
697 return 0;
700 /*-------------------------------------------------------------------------*/
702 /* use ch9 requests to test whether:
703 * (a) queues work for control, keeping N subtests queued and
704 * active (auto-resubmit) for M loops through the queue.
705 * (b) protocol stalls (control-only) will autorecover.
706 * it's not like bulk/intr; no halt clearing.
707 * (c) short control reads are reported and handled.
708 * (d) queues are always processed in-order
711 struct ctrl_ctx {
712 spinlock_t lock;
713 struct usbtest_dev *dev;
714 struct completion complete;
715 unsigned count;
716 unsigned pending;
717 int status;
718 struct urb **urb;
719 struct usbtest_param *param;
720 int last;
723 #define NUM_SUBCASES 15 /* how many test subcases here? */
725 struct subcase {
726 struct usb_ctrlrequest setup;
727 int number;
728 int expected;
731 static void ctrl_complete (struct urb *urb)
733 struct ctrl_ctx *ctx = urb->context;
734 struct usb_ctrlrequest *reqp;
735 struct subcase *subcase;
736 int status = urb->status;
738 reqp = (struct usb_ctrlrequest *)urb->setup_packet;
739 subcase = container_of (reqp, struct subcase, setup);
741 spin_lock (&ctx->lock);
742 ctx->count--;
743 ctx->pending--;
745 /* queue must transfer and complete in fifo order, unless
746 * usb_unlink_urb() is used to unlink something not at the
747 * physical queue head (not tested).
749 if (subcase->number > 0) {
750 if ((subcase->number - ctx->last) != 1) {
751 dbg ("subcase %d completed out of order, last %d",
752 subcase->number, ctx->last);
753 status = -EDOM;
754 ctx->last = subcase->number;
755 goto error;
758 ctx->last = subcase->number;
760 /* succeed or fault in only one way? */
761 if (status == subcase->expected)
762 status = 0;
764 /* async unlink for cleanup? */
765 else if (status != -ECONNRESET) {
767 /* some faults are allowed, not required */
768 if (subcase->expected > 0 && (
769 ((status == -subcase->expected /* happened */
770 || status == 0)))) /* didn't */
771 status = 0;
772 /* sometimes more than one fault is allowed */
773 else if (subcase->number == 12 && status == -EPIPE)
774 status = 0;
775 else
776 dbg ("subtest %d error, status %d",
777 subcase->number, status);
780 /* unexpected status codes mean errors; ideally, in hardware */
781 if (status) {
782 error:
783 if (ctx->status == 0) {
784 int i;
786 ctx->status = status;
787 info ("control queue %02x.%02x, err %d, %d left",
788 reqp->bRequestType, reqp->bRequest,
789 status, ctx->count);
791 /* FIXME this "unlink everything" exit route should
792 * be a separate test case.
795 /* unlink whatever's still pending */
796 for (i = 1; i < ctx->param->sglen; i++) {
797 struct urb *u = ctx->urb [
798 (i + subcase->number) % ctx->param->sglen];
800 if (u == urb || !u->dev)
801 continue;
802 spin_unlock(&ctx->lock);
803 status = usb_unlink_urb (u);
804 spin_lock(&ctx->lock);
805 switch (status) {
806 case -EINPROGRESS:
807 case -EBUSY:
808 case -EIDRM:
809 continue;
810 default:
811 dbg ("urb unlink --> %d", status);
814 status = ctx->status;
818 /* resubmit if we need to, else mark this as done */
819 if ((status == 0) && (ctx->pending < ctx->count)) {
820 if ((status = usb_submit_urb (urb, GFP_ATOMIC)) != 0) {
821 dbg ("can't resubmit ctrl %02x.%02x, err %d",
822 reqp->bRequestType, reqp->bRequest, status);
823 urb->dev = NULL;
824 } else
825 ctx->pending++;
826 } else
827 urb->dev = NULL;
829 /* signal completion when nothing's queued */
830 if (ctx->pending == 0)
831 complete (&ctx->complete);
832 spin_unlock (&ctx->lock);
835 static int
836 test_ctrl_queue (struct usbtest_dev *dev, struct usbtest_param *param)
838 struct usb_device *udev = testdev_to_usbdev (dev);
839 struct urb **urb;
840 struct ctrl_ctx context;
841 int i;
843 spin_lock_init (&context.lock);
844 context.dev = dev;
845 init_completion (&context.complete);
846 context.count = param->sglen * param->iterations;
847 context.pending = 0;
848 context.status = -ENOMEM;
849 context.param = param;
850 context.last = -1;
852 /* allocate and init the urbs we'll queue.
853 * as with bulk/intr sglists, sglen is the queue depth; it also
854 * controls which subtests run (more tests than sglen) or rerun.
856 urb = kcalloc(param->sglen, sizeof(struct urb *), GFP_KERNEL);
857 if (!urb)
858 return -ENOMEM;
859 for (i = 0; i < param->sglen; i++) {
860 int pipe = usb_rcvctrlpipe (udev, 0);
861 unsigned len;
862 struct urb *u;
863 struct usb_ctrlrequest req;
864 struct subcase *reqp;
865 int expected = 0;
867 /* requests here are mostly expected to succeed on any
868 * device, but some are chosen to trigger protocol stalls
869 * or short reads.
871 memset (&req, 0, sizeof req);
872 req.bRequest = USB_REQ_GET_DESCRIPTOR;
873 req.bRequestType = USB_DIR_IN|USB_RECIP_DEVICE;
875 switch (i % NUM_SUBCASES) {
876 case 0: // get device descriptor
877 req.wValue = cpu_to_le16 (USB_DT_DEVICE << 8);
878 len = sizeof (struct usb_device_descriptor);
879 break;
880 case 1: // get first config descriptor (only)
881 req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
882 len = sizeof (struct usb_config_descriptor);
883 break;
884 case 2: // get altsetting (OFTEN STALLS)
885 req.bRequest = USB_REQ_GET_INTERFACE;
886 req.bRequestType = USB_DIR_IN|USB_RECIP_INTERFACE;
887 // index = 0 means first interface
888 len = 1;
889 expected = EPIPE;
890 break;
891 case 3: // get interface status
892 req.bRequest = USB_REQ_GET_STATUS;
893 req.bRequestType = USB_DIR_IN|USB_RECIP_INTERFACE;
894 // interface 0
895 len = 2;
896 break;
897 case 4: // get device status
898 req.bRequest = USB_REQ_GET_STATUS;
899 req.bRequestType = USB_DIR_IN|USB_RECIP_DEVICE;
900 len = 2;
901 break;
902 case 5: // get device qualifier (MAY STALL)
903 req.wValue = cpu_to_le16 (USB_DT_DEVICE_QUALIFIER << 8);
904 len = sizeof (struct usb_qualifier_descriptor);
905 if (udev->speed != USB_SPEED_HIGH)
906 expected = EPIPE;
907 break;
908 case 6: // get first config descriptor, plus interface
909 req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
910 len = sizeof (struct usb_config_descriptor);
911 len += sizeof (struct usb_interface_descriptor);
912 break;
913 case 7: // get interface descriptor (ALWAYS STALLS)
914 req.wValue = cpu_to_le16 (USB_DT_INTERFACE << 8);
915 // interface == 0
916 len = sizeof (struct usb_interface_descriptor);
917 expected = EPIPE;
918 break;
919 // NOTE: two consecutive stalls in the queue here.
920 // that tests fault recovery a bit more aggressively.
921 case 8: // clear endpoint halt (USUALLY STALLS)
922 req.bRequest = USB_REQ_CLEAR_FEATURE;
923 req.bRequestType = USB_RECIP_ENDPOINT;
924 // wValue 0 == ep halt
925 // wIndex 0 == ep0 (shouldn't halt!)
926 len = 0;
927 pipe = usb_sndctrlpipe (udev, 0);
928 expected = EPIPE;
929 break;
930 case 9: // get endpoint status
931 req.bRequest = USB_REQ_GET_STATUS;
932 req.bRequestType = USB_DIR_IN|USB_RECIP_ENDPOINT;
933 // endpoint 0
934 len = 2;
935 break;
936 case 10: // trigger short read (EREMOTEIO)
937 req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
938 len = 1024;
939 expected = -EREMOTEIO;
940 break;
941 // NOTE: two consecutive _different_ faults in the queue.
942 case 11: // get endpoint descriptor (ALWAYS STALLS)
943 req.wValue = cpu_to_le16 (USB_DT_ENDPOINT << 8);
944 // endpoint == 0
945 len = sizeof (struct usb_interface_descriptor);
946 expected = EPIPE;
947 break;
948 // NOTE: sometimes even a third fault in the queue!
949 case 12: // get string 0 descriptor (MAY STALL)
950 req.wValue = cpu_to_le16 (USB_DT_STRING << 8);
951 // string == 0, for language IDs
952 len = sizeof (struct usb_interface_descriptor);
953 // may succeed when > 4 languages
954 expected = EREMOTEIO; // or EPIPE, if no strings
955 break;
956 case 13: // short read, resembling case 10
957 req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
958 // last data packet "should" be DATA1, not DATA0
959 len = 1024 - udev->descriptor.bMaxPacketSize0;
960 expected = -EREMOTEIO;
961 break;
962 case 14: // short read; try to fill the last packet
963 req.wValue = cpu_to_le16 ((USB_DT_DEVICE << 8) | 0);
964 // device descriptor size == 18 bytes
965 len = udev->descriptor.bMaxPacketSize0;
966 switch (len) {
967 case 8: len = 24; break;
968 case 16: len = 32; break;
970 expected = -EREMOTEIO;
971 break;
972 default:
973 err ("bogus number of ctrl queue testcases!");
974 context.status = -EINVAL;
975 goto cleanup;
977 req.wLength = cpu_to_le16 (len);
978 urb [i] = u = simple_alloc_urb (udev, pipe, len);
979 if (!u)
980 goto cleanup;
982 reqp = usb_buffer_alloc (udev, sizeof *reqp, GFP_KERNEL,
983 &u->setup_dma);
984 if (!reqp)
985 goto cleanup;
986 reqp->setup = req;
987 reqp->number = i % NUM_SUBCASES;
988 reqp->expected = expected;
989 u->setup_packet = (char *) &reqp->setup;
990 u->transfer_flags |= URB_NO_SETUP_DMA_MAP;
992 u->context = &context;
993 u->complete = ctrl_complete;
996 /* queue the urbs */
997 context.urb = urb;
998 spin_lock_irq (&context.lock);
999 for (i = 0; i < param->sglen; i++) {
1000 context.status = usb_submit_urb (urb [i], GFP_ATOMIC);
1001 if (context.status != 0) {
1002 dbg ("can't submit urb[%d], status %d",
1003 i, context.status);
1004 context.count = context.pending;
1005 break;
1007 context.pending++;
1009 spin_unlock_irq (&context.lock);
1011 /* FIXME set timer and time out; provide a disconnect hook */
1013 /* wait for the last one to complete */
1014 if (context.pending > 0)
1015 wait_for_completion (&context.complete);
1017 cleanup:
1018 for (i = 0; i < param->sglen; i++) {
1019 if (!urb [i])
1020 continue;
1021 urb [i]->dev = udev;
1022 if (urb [i]->setup_packet)
1023 usb_buffer_free (udev, sizeof (struct usb_ctrlrequest),
1024 urb [i]->setup_packet,
1025 urb [i]->setup_dma);
1026 simple_free_urb (urb [i]);
1028 kfree (urb);
1029 return context.status;
1031 #undef NUM_SUBCASES
1034 /*-------------------------------------------------------------------------*/
1036 static void unlink1_callback (struct urb *urb)
1038 int status = urb->status;
1040 // we "know" -EPIPE (stall) never happens
1041 if (!status)
1042 status = usb_submit_urb (urb, GFP_ATOMIC);
1043 if (status) {
1044 urb->status = status;
1045 complete ((struct completion *) urb->context);
1049 static int unlink1 (struct usbtest_dev *dev, int pipe, int size, int async)
1051 struct urb *urb;
1052 struct completion completion;
1053 int retval = 0;
1055 init_completion (&completion);
1056 urb = simple_alloc_urb (testdev_to_usbdev (dev), pipe, size);
1057 if (!urb)
1058 return -ENOMEM;
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, GFP_KERNEL)) != 0) {
1069 dev_dbg (&dev->intf->dev, "submit fail %d\n", retval);
1070 return 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));
1077 if (async) {
1078 retry:
1079 retval = usb_unlink_urb (urb);
1080 if (retval == -EBUSY || retval == -EIDRM) {
1081 /* we can't unlink urbs while they're completing.
1082 * or if they've completed, and we haven't resubmitted.
1083 * "normal" drivers would prevent resubmission, but
1084 * since we're testing unlink paths, we can't.
1086 dev_dbg (&dev->intf->dev, "unlink retry\n");
1087 goto retry;
1089 } else
1090 usb_kill_urb (urb);
1091 if (!(retval == 0 || retval == -EINPROGRESS)) {
1092 dev_dbg (&dev->intf->dev, "unlink fail %d\n", retval);
1093 return retval;
1096 wait_for_completion (&completion);
1097 retval = urb->status;
1098 simple_free_urb (urb);
1100 if (async)
1101 return (retval == -ECONNRESET) ? 0 : retval - 1000;
1102 else
1103 return (retval == -ENOENT || retval == -EPERM) ?
1104 0 : retval - 2000;
1107 static int unlink_simple (struct usbtest_dev *dev, int pipe, int len)
1109 int retval = 0;
1111 /* test sync and async paths */
1112 retval = unlink1 (dev, pipe, len, 1);
1113 if (!retval)
1114 retval = unlink1 (dev, pipe, len, 0);
1115 return retval;
1118 /*-------------------------------------------------------------------------*/
1120 static int verify_not_halted (int ep, struct urb *urb)
1122 int retval;
1123 u16 status;
1125 /* shouldn't look or act halted */
1126 retval = usb_get_status (urb->dev, USB_RECIP_ENDPOINT, ep, &status);
1127 if (retval < 0) {
1128 dbg ("ep %02x couldn't get no-halt status, %d", ep, retval);
1129 return retval;
1131 if (status != 0) {
1132 dbg ("ep %02x bogus status: %04x != 0", ep, status);
1133 return -EINVAL;
1135 retval = simple_io (urb, 1, 0, 0, __FUNCTION__);
1136 if (retval != 0)
1137 return -EINVAL;
1138 return 0;
1141 static int verify_halted (int ep, struct urb *urb)
1143 int retval;
1144 u16 status;
1146 /* should look and act halted */
1147 retval = usb_get_status (urb->dev, USB_RECIP_ENDPOINT, ep, &status);
1148 if (retval < 0) {
1149 dbg ("ep %02x couldn't get halt status, %d", ep, retval);
1150 return retval;
1152 if (status != 1) {
1153 dbg ("ep %02x bogus status: %04x != 1", ep, status);
1154 return -EINVAL;
1156 retval = simple_io (urb, 1, 0, -EPIPE, __FUNCTION__);
1157 if (retval != -EPIPE)
1158 return -EINVAL;
1159 retval = simple_io (urb, 1, 0, -EPIPE, "verify_still_halted");
1160 if (retval != -EPIPE)
1161 return -EINVAL;
1162 return 0;
1165 static int test_halt (int ep, struct urb *urb)
1167 int retval;
1169 /* shouldn't look or act halted now */
1170 retval = verify_not_halted (ep, urb);
1171 if (retval < 0)
1172 return retval;
1174 /* set halt (protocol test only), verify it worked */
1175 retval = usb_control_msg (urb->dev, usb_sndctrlpipe (urb->dev, 0),
1176 USB_REQ_SET_FEATURE, USB_RECIP_ENDPOINT,
1177 USB_ENDPOINT_HALT, ep,
1178 NULL, 0, USB_CTRL_SET_TIMEOUT);
1179 if (retval < 0) {
1180 dbg ("ep %02x couldn't set halt, %d", ep, retval);
1181 return retval;
1183 retval = verify_halted (ep, urb);
1184 if (retval < 0)
1185 return retval;
1187 /* clear halt (tests API + protocol), verify it worked */
1188 retval = usb_clear_halt (urb->dev, urb->pipe);
1189 if (retval < 0) {
1190 dbg ("ep %02x couldn't clear halt, %d", ep, retval);
1191 return retval;
1193 retval = verify_not_halted (ep, urb);
1194 if (retval < 0)
1195 return retval;
1197 /* NOTE: could also verify SET_INTERFACE clear halts ... */
1199 return 0;
1202 static int halt_simple (struct usbtest_dev *dev)
1204 int ep;
1205 int retval = 0;
1206 struct urb *urb;
1208 urb = simple_alloc_urb (testdev_to_usbdev (dev), 0, 512);
1209 if (urb == NULL)
1210 return -ENOMEM;
1212 if (dev->in_pipe) {
1213 ep = usb_pipeendpoint (dev->in_pipe) | USB_DIR_IN;
1214 urb->pipe = dev->in_pipe;
1215 retval = test_halt (ep, urb);
1216 if (retval < 0)
1217 goto done;
1220 if (dev->out_pipe) {
1221 ep = usb_pipeendpoint (dev->out_pipe);
1222 urb->pipe = dev->out_pipe;
1223 retval = test_halt (ep, urb);
1225 done:
1226 simple_free_urb (urb);
1227 return retval;
1230 /*-------------------------------------------------------------------------*/
1232 /* Control OUT tests use the vendor control requests from Intel's
1233 * USB 2.0 compliance test device: write a buffer, read it back.
1235 * Intel's spec only _requires_ that it work for one packet, which
1236 * is pretty weak. Some HCDs place limits here; most devices will
1237 * need to be able to handle more than one OUT data packet. We'll
1238 * try whatever we're told to try.
1240 static int ctrl_out (struct usbtest_dev *dev,
1241 unsigned count, unsigned length, unsigned vary)
1243 unsigned i, j, len;
1244 int retval;
1245 u8 *buf;
1246 char *what = "?";
1247 struct usb_device *udev;
1249 if (length < 1 || length > 0xffff || vary >= length)
1250 return -EINVAL;
1252 buf = kmalloc(length, GFP_KERNEL);
1253 if (!buf)
1254 return -ENOMEM;
1256 udev = testdev_to_usbdev (dev);
1257 len = length;
1258 retval = 0;
1260 /* NOTE: hardware might well act differently if we pushed it
1261 * with lots back-to-back queued requests.
1263 for (i = 0; i < count; i++) {
1264 /* write patterned data */
1265 for (j = 0; j < len; j++)
1266 buf [j] = i + j;
1267 retval = usb_control_msg (udev, usb_sndctrlpipe (udev,0),
1268 0x5b, USB_DIR_OUT|USB_TYPE_VENDOR,
1269 0, 0, buf, len, USB_CTRL_SET_TIMEOUT);
1270 if (retval != len) {
1271 what = "write";
1272 if (retval >= 0) {
1273 INFO(dev, "ctrl_out, wlen %d (expected %d)\n",
1274 retval, len);
1275 retval = -EBADMSG;
1277 break;
1280 /* read it back -- assuming nothing intervened!! */
1281 retval = usb_control_msg (udev, usb_rcvctrlpipe (udev,0),
1282 0x5c, USB_DIR_IN|USB_TYPE_VENDOR,
1283 0, 0, buf, len, USB_CTRL_GET_TIMEOUT);
1284 if (retval != len) {
1285 what = "read";
1286 if (retval >= 0) {
1287 INFO(dev, "ctrl_out, rlen %d (expected %d)\n",
1288 retval, len);
1289 retval = -EBADMSG;
1291 break;
1294 /* fail if we can't verify */
1295 for (j = 0; j < len; j++) {
1296 if (buf [j] != (u8) (i + j)) {
1297 INFO (dev, "ctrl_out, byte %d is %d not %d\n",
1298 j, buf [j], (u8) i + j);
1299 retval = -EBADMSG;
1300 break;
1303 if (retval < 0) {
1304 what = "verify";
1305 break;
1308 len += vary;
1310 /* [real world] the "zero bytes IN" case isn't really used.
1311 * hardware can easily trip up in this wierd case, since its
1312 * status stage is IN, not OUT like other ep0in transfers.
1314 if (len > length)
1315 len = realworld ? 1 : 0;
1318 if (retval < 0)
1319 INFO (dev, "ctrl_out %s failed, code %d, count %d\n",
1320 what, retval, i);
1322 kfree (buf);
1323 return retval;
1326 /*-------------------------------------------------------------------------*/
1328 /* ISO tests ... mimics common usage
1329 * - buffer length is split into N packets (mostly maxpacket sized)
1330 * - multi-buffers according to sglen
1333 struct iso_context {
1334 unsigned count;
1335 unsigned pending;
1336 spinlock_t lock;
1337 struct completion done;
1338 int submit_error;
1339 unsigned long errors;
1340 unsigned long packet_count;
1341 struct usbtest_dev *dev;
1344 static void iso_callback (struct urb *urb)
1346 struct iso_context *ctx = urb->context;
1348 spin_lock(&ctx->lock);
1349 ctx->count--;
1351 ctx->packet_count += urb->number_of_packets;
1352 if (urb->error_count > 0)
1353 ctx->errors += urb->error_count;
1354 else if (urb->status != 0)
1355 ctx->errors += urb->number_of_packets;
1357 if (urb->status == 0 && ctx->count > (ctx->pending - 1)
1358 && !ctx->submit_error) {
1359 int status = usb_submit_urb (urb, GFP_ATOMIC);
1360 switch (status) {
1361 case 0:
1362 goto done;
1363 default:
1364 dev_dbg (&ctx->dev->intf->dev,
1365 "iso resubmit err %d\n",
1366 status);
1367 /* FALLTHROUGH */
1368 case -ENODEV: /* disconnected */
1369 case -ESHUTDOWN: /* endpoint disabled */
1370 ctx->submit_error = 1;
1371 break;
1374 simple_free_urb (urb);
1376 ctx->pending--;
1377 if (ctx->pending == 0) {
1378 if (ctx->errors)
1379 dev_dbg (&ctx->dev->intf->dev,
1380 "iso test, %lu errors out of %lu\n",
1381 ctx->errors, ctx->packet_count);
1382 complete (&ctx->done);
1384 done:
1385 spin_unlock(&ctx->lock);
1388 static struct urb *iso_alloc_urb (
1389 struct usb_device *udev,
1390 int pipe,
1391 struct usb_endpoint_descriptor *desc,
1392 long bytes
1395 struct urb *urb;
1396 unsigned i, maxp, packets;
1398 if (bytes < 0 || !desc)
1399 return NULL;
1400 maxp = 0x7ff & le16_to_cpu(desc->wMaxPacketSize);
1401 maxp *= 1 + (0x3 & (le16_to_cpu(desc->wMaxPacketSize) >> 11));
1402 packets = DIV_ROUND_UP(bytes, maxp);
1404 urb = usb_alloc_urb (packets, GFP_KERNEL);
1405 if (!urb)
1406 return urb;
1407 urb->dev = udev;
1408 urb->pipe = pipe;
1410 urb->number_of_packets = packets;
1411 urb->transfer_buffer_length = bytes;
1412 urb->transfer_buffer = usb_buffer_alloc (udev, bytes, GFP_KERNEL,
1413 &urb->transfer_dma);
1414 if (!urb->transfer_buffer) {
1415 usb_free_urb (urb);
1416 return NULL;
1418 memset (urb->transfer_buffer, 0, bytes);
1419 for (i = 0; i < packets; i++) {
1420 /* here, only the last packet will be short */
1421 urb->iso_frame_desc[i].length = min ((unsigned) bytes, maxp);
1422 bytes -= urb->iso_frame_desc[i].length;
1424 urb->iso_frame_desc[i].offset = maxp * i;
1427 urb->complete = iso_callback;
1428 // urb->context = SET BY CALLER
1429 urb->interval = 1 << (desc->bInterval - 1);
1430 urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
1431 return urb;
1434 static int
1435 test_iso_queue (struct usbtest_dev *dev, struct usbtest_param *param,
1436 int pipe, struct usb_endpoint_descriptor *desc)
1438 struct iso_context context;
1439 struct usb_device *udev;
1440 unsigned i;
1441 unsigned long packets = 0;
1442 int status = 0;
1443 struct urb *urbs[10]; /* FIXME no limit */
1445 if (param->sglen > 10)
1446 return -EDOM;
1448 memset(&context, 0, sizeof context);
1449 context.count = param->iterations * param->sglen;
1450 context.dev = dev;
1451 init_completion (&context.done);
1452 spin_lock_init (&context.lock);
1454 memset (urbs, 0, sizeof urbs);
1455 udev = testdev_to_usbdev (dev);
1456 dev_dbg (&dev->intf->dev,
1457 "... iso period %d %sframes, wMaxPacket %04x\n",
1458 1 << (desc->bInterval - 1),
1459 (udev->speed == USB_SPEED_HIGH) ? "micro" : "",
1460 le16_to_cpu(desc->wMaxPacketSize));
1462 for (i = 0; i < param->sglen; i++) {
1463 urbs [i] = iso_alloc_urb (udev, pipe, desc,
1464 param->length);
1465 if (!urbs [i]) {
1466 status = -ENOMEM;
1467 goto fail;
1469 packets += urbs[i]->number_of_packets;
1470 urbs [i]->context = &context;
1472 packets *= param->iterations;
1473 dev_dbg (&dev->intf->dev,
1474 "... total %lu msec (%lu packets)\n",
1475 (packets * (1 << (desc->bInterval - 1)))
1476 / ((udev->speed == USB_SPEED_HIGH) ? 8 : 1),
1477 packets);
1479 spin_lock_irq (&context.lock);
1480 for (i = 0; i < param->sglen; i++) {
1481 ++context.pending;
1482 status = usb_submit_urb (urbs [i], GFP_ATOMIC);
1483 if (status < 0) {
1484 ERROR (dev, "submit iso[%d], error %d\n", i, status);
1485 if (i == 0) {
1486 spin_unlock_irq (&context.lock);
1487 goto fail;
1490 simple_free_urb (urbs [i]);
1491 context.pending--;
1492 context.submit_error = 1;
1493 break;
1496 spin_unlock_irq (&context.lock);
1498 wait_for_completion (&context.done);
1501 * Isochronous transfers are expected to fail sometimes. As an
1502 * arbitrary limit, we will report an error if any submissions
1503 * fail or if the transfer failure rate is > 10%.
1505 if (status != 0)
1507 else if (context.submit_error)
1508 status = -EACCES;
1509 else if (context.errors > context.packet_count / 10)
1510 status = -EIO;
1511 return status;
1513 fail:
1514 for (i = 0; i < param->sglen; i++) {
1515 if (urbs [i])
1516 simple_free_urb (urbs [i]);
1518 return status;
1521 /*-------------------------------------------------------------------------*/
1523 /* We only have this one interface to user space, through usbfs.
1524 * User mode code can scan usbfs to find N different devices (maybe on
1525 * different busses) to use when testing, and allocate one thread per
1526 * test. So discovery is simplified, and we have no device naming issues.
1528 * Don't use these only as stress/load tests. Use them along with with
1529 * other USB bus activity: plugging, unplugging, mousing, mp3 playback,
1530 * video capture, and so on. Run different tests at different times, in
1531 * different sequences. Nothing here should interact with other devices,
1532 * except indirectly by consuming USB bandwidth and CPU resources for test
1533 * threads and request completion. But the only way to know that for sure
1534 * is to test when HC queues are in use by many devices.
1537 static int
1538 usbtest_ioctl (struct usb_interface *intf, unsigned int code, void *buf)
1540 struct usbtest_dev *dev = usb_get_intfdata (intf);
1541 struct usb_device *udev = testdev_to_usbdev (dev);
1542 struct usbtest_param *param = buf;
1543 int retval = -EOPNOTSUPP;
1544 struct urb *urb;
1545 struct scatterlist *sg;
1546 struct usb_sg_request req;
1547 struct timeval start;
1548 unsigned i;
1550 // FIXME USBDEVFS_CONNECTINFO doesn't say how fast the device is.
1552 if (code != USBTEST_REQUEST)
1553 return -EOPNOTSUPP;
1555 if (param->iterations <= 0 || param->length < 0
1556 || param->sglen < 0 || param->vary < 0)
1557 return -EINVAL;
1559 if (down_interruptible (&dev->sem))
1560 return -ERESTARTSYS;
1562 /* FIXME: What if a system sleep starts while a test is running? */
1563 if (!intf->is_active) {
1564 up (&dev->sem);
1565 return -EHOSTUNREACH;
1568 /* some devices, like ez-usb default devices, need a non-default
1569 * altsetting to have any active endpoints. some tests change
1570 * altsettings; force a default so most tests don't need to check.
1572 if (dev->info->alt >= 0) {
1573 int res;
1575 if (intf->altsetting->desc.bInterfaceNumber) {
1576 up (&dev->sem);
1577 return -ENODEV;
1579 res = set_altsetting (dev, dev->info->alt);
1580 if (res) {
1581 dev_err (&intf->dev,
1582 "set altsetting to %d failed, %d\n",
1583 dev->info->alt, res);
1584 up (&dev->sem);
1585 return res;
1590 * Just a bunch of test cases that every HCD is expected to handle.
1592 * Some may need specific firmware, though it'd be good to have
1593 * one firmware image to handle all the test cases.
1595 * FIXME add more tests! cancel requests, verify the data, control
1596 * queueing, concurrent read+write threads, and so on.
1598 do_gettimeofday (&start);
1599 switch (param->test_num) {
1601 case 0:
1602 dev_dbg (&intf->dev, "TEST 0: NOP\n");
1603 retval = 0;
1604 break;
1606 /* Simple non-queued bulk I/O tests */
1607 case 1:
1608 if (dev->out_pipe == 0)
1609 break;
1610 dev_dbg (&intf->dev,
1611 "TEST 1: write %d bytes %u times\n",
1612 param->length, param->iterations);
1613 urb = simple_alloc_urb (udev, dev->out_pipe, param->length);
1614 if (!urb) {
1615 retval = -ENOMEM;
1616 break;
1618 // FIRMWARE: bulk sink (maybe accepts short writes)
1619 retval = simple_io (urb, param->iterations, 0, 0, "test1");
1620 simple_free_urb (urb);
1621 break;
1622 case 2:
1623 if (dev->in_pipe == 0)
1624 break;
1625 dev_dbg (&intf->dev,
1626 "TEST 2: read %d bytes %u times\n",
1627 param->length, param->iterations);
1628 urb = simple_alloc_urb (udev, dev->in_pipe, param->length);
1629 if (!urb) {
1630 retval = -ENOMEM;
1631 break;
1633 // FIRMWARE: bulk source (maybe generates short writes)
1634 retval = simple_io (urb, param->iterations, 0, 0, "test2");
1635 simple_free_urb (urb);
1636 break;
1637 case 3:
1638 if (dev->out_pipe == 0 || param->vary == 0)
1639 break;
1640 dev_dbg (&intf->dev,
1641 "TEST 3: write/%d 0..%d bytes %u times\n",
1642 param->vary, param->length, param->iterations);
1643 urb = simple_alloc_urb (udev, dev->out_pipe, param->length);
1644 if (!urb) {
1645 retval = -ENOMEM;
1646 break;
1648 // FIRMWARE: bulk sink (maybe accepts short writes)
1649 retval = simple_io (urb, param->iterations, param->vary,
1650 0, "test3");
1651 simple_free_urb (urb);
1652 break;
1653 case 4:
1654 if (dev->in_pipe == 0 || param->vary == 0)
1655 break;
1656 dev_dbg (&intf->dev,
1657 "TEST 4: read/%d 0..%d bytes %u times\n",
1658 param->vary, param->length, param->iterations);
1659 urb = simple_alloc_urb (udev, dev->in_pipe, param->length);
1660 if (!urb) {
1661 retval = -ENOMEM;
1662 break;
1664 // FIRMWARE: bulk source (maybe generates short writes)
1665 retval = simple_io (urb, param->iterations, param->vary,
1666 0, "test4");
1667 simple_free_urb (urb);
1668 break;
1670 /* Queued bulk I/O tests */
1671 case 5:
1672 if (dev->out_pipe == 0 || param->sglen == 0)
1673 break;
1674 dev_dbg (&intf->dev,
1675 "TEST 5: write %d sglists %d entries of %d bytes\n",
1676 param->iterations,
1677 param->sglen, param->length);
1678 sg = alloc_sglist (param->sglen, param->length, 0);
1679 if (!sg) {
1680 retval = -ENOMEM;
1681 break;
1683 // FIRMWARE: bulk sink (maybe accepts short writes)
1684 retval = perform_sglist (udev, param->iterations, dev->out_pipe,
1685 &req, sg, param->sglen);
1686 free_sglist (sg, param->sglen);
1687 break;
1689 case 6:
1690 if (dev->in_pipe == 0 || param->sglen == 0)
1691 break;
1692 dev_dbg (&intf->dev,
1693 "TEST 6: read %d sglists %d entries of %d bytes\n",
1694 param->iterations,
1695 param->sglen, param->length);
1696 sg = alloc_sglist (param->sglen, param->length, 0);
1697 if (!sg) {
1698 retval = -ENOMEM;
1699 break;
1701 // FIRMWARE: bulk source (maybe generates short writes)
1702 retval = perform_sglist (udev, param->iterations, dev->in_pipe,
1703 &req, sg, param->sglen);
1704 free_sglist (sg, param->sglen);
1705 break;
1706 case 7:
1707 if (dev->out_pipe == 0 || param->sglen == 0 || param->vary == 0)
1708 break;
1709 dev_dbg (&intf->dev,
1710 "TEST 7: write/%d %d sglists %d entries 0..%d bytes\n",
1711 param->vary, param->iterations,
1712 param->sglen, param->length);
1713 sg = alloc_sglist (param->sglen, param->length, param->vary);
1714 if (!sg) {
1715 retval = -ENOMEM;
1716 break;
1718 // FIRMWARE: bulk sink (maybe accepts short writes)
1719 retval = perform_sglist (udev, param->iterations, dev->out_pipe,
1720 &req, sg, param->sglen);
1721 free_sglist (sg, param->sglen);
1722 break;
1723 case 8:
1724 if (dev->in_pipe == 0 || param->sglen == 0 || param->vary == 0)
1725 break;
1726 dev_dbg (&intf->dev,
1727 "TEST 8: read/%d %d sglists %d entries 0..%d bytes\n",
1728 param->vary, param->iterations,
1729 param->sglen, param->length);
1730 sg = alloc_sglist (param->sglen, param->length, param->vary);
1731 if (!sg) {
1732 retval = -ENOMEM;
1733 break;
1735 // FIRMWARE: bulk source (maybe generates short writes)
1736 retval = perform_sglist (udev, param->iterations, dev->in_pipe,
1737 &req, sg, param->sglen);
1738 free_sglist (sg, param->sglen);
1739 break;
1741 /* non-queued sanity tests for control (chapter 9 subset) */
1742 case 9:
1743 retval = 0;
1744 dev_dbg (&intf->dev,
1745 "TEST 9: ch9 (subset) control tests, %d times\n",
1746 param->iterations);
1747 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1748 retval = ch9_postconfig (dev);
1749 if (retval)
1750 dbg ("ch9 subset failed, iterations left %d", i);
1751 break;
1753 /* queued control messaging */
1754 case 10:
1755 if (param->sglen == 0)
1756 break;
1757 retval = 0;
1758 dev_dbg (&intf->dev,
1759 "TEST 10: queue %d control calls, %d times\n",
1760 param->sglen,
1761 param->iterations);
1762 retval = test_ctrl_queue (dev, param);
1763 break;
1765 /* simple non-queued unlinks (ring with one urb) */
1766 case 11:
1767 if (dev->in_pipe == 0 || !param->length)
1768 break;
1769 retval = 0;
1770 dev_dbg (&intf->dev, "TEST 11: unlink %d reads of %d\n",
1771 param->iterations, param->length);
1772 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1773 retval = unlink_simple (dev, dev->in_pipe,
1774 param->length);
1775 if (retval)
1776 dev_dbg (&intf->dev, "unlink reads failed %d, "
1777 "iterations left %d\n", retval, i);
1778 break;
1779 case 12:
1780 if (dev->out_pipe == 0 || !param->length)
1781 break;
1782 retval = 0;
1783 dev_dbg (&intf->dev, "TEST 12: unlink %d writes of %d\n",
1784 param->iterations, param->length);
1785 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1786 retval = unlink_simple (dev, dev->out_pipe,
1787 param->length);
1788 if (retval)
1789 dev_dbg (&intf->dev, "unlink writes failed %d, "
1790 "iterations left %d\n", retval, i);
1791 break;
1793 /* ep halt tests */
1794 case 13:
1795 if (dev->out_pipe == 0 && dev->in_pipe == 0)
1796 break;
1797 retval = 0;
1798 dev_dbg (&intf->dev, "TEST 13: set/clear %d halts\n",
1799 param->iterations);
1800 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1801 retval = halt_simple (dev);
1803 if (retval)
1804 DBG (dev, "halts failed, iterations left %d\n", i);
1805 break;
1807 /* control write tests */
1808 case 14:
1809 if (!dev->info->ctrl_out)
1810 break;
1811 dev_dbg (&intf->dev, "TEST 14: %d ep0out, %d..%d vary %d\n",
1812 param->iterations,
1813 realworld ? 1 : 0, param->length,
1814 param->vary);
1815 retval = ctrl_out (dev, param->iterations,
1816 param->length, param->vary);
1817 break;
1819 /* iso write tests */
1820 case 15:
1821 if (dev->out_iso_pipe == 0 || param->sglen == 0)
1822 break;
1823 dev_dbg (&intf->dev,
1824 "TEST 15: write %d iso, %d entries of %d bytes\n",
1825 param->iterations,
1826 param->sglen, param->length);
1827 // FIRMWARE: iso sink
1828 retval = test_iso_queue (dev, param,
1829 dev->out_iso_pipe, dev->iso_out);
1830 break;
1832 /* iso read tests */
1833 case 16:
1834 if (dev->in_iso_pipe == 0 || param->sglen == 0)
1835 break;
1836 dev_dbg (&intf->dev,
1837 "TEST 16: read %d iso, %d entries of %d bytes\n",
1838 param->iterations,
1839 param->sglen, param->length);
1840 // FIRMWARE: iso source
1841 retval = test_iso_queue (dev, param,
1842 dev->in_iso_pipe, dev->iso_in);
1843 break;
1845 // FIXME unlink from queue (ring with N urbs)
1847 // FIXME scatterlist cancel (needs helper thread)
1850 do_gettimeofday (&param->duration);
1851 param->duration.tv_sec -= start.tv_sec;
1852 param->duration.tv_usec -= start.tv_usec;
1853 if (param->duration.tv_usec < 0) {
1854 param->duration.tv_usec += 1000 * 1000;
1855 param->duration.tv_sec -= 1;
1857 up (&dev->sem);
1858 return retval;
1861 /*-------------------------------------------------------------------------*/
1863 static unsigned force_interrupt = 0;
1864 module_param (force_interrupt, uint, 0);
1865 MODULE_PARM_DESC (force_interrupt, "0 = test default; else interrupt");
1867 #ifdef GENERIC
1868 static unsigned short vendor;
1869 module_param(vendor, ushort, 0);
1870 MODULE_PARM_DESC (vendor, "vendor code (from usb-if)");
1872 static unsigned short product;
1873 module_param(product, ushort, 0);
1874 MODULE_PARM_DESC (product, "product code (from vendor)");
1875 #endif
1877 static int
1878 usbtest_probe (struct usb_interface *intf, const struct usb_device_id *id)
1880 struct usb_device *udev;
1881 struct usbtest_dev *dev;
1882 struct usbtest_info *info;
1883 char *rtest, *wtest;
1884 char *irtest, *iwtest;
1886 udev = interface_to_usbdev (intf);
1888 #ifdef GENERIC
1889 /* specify devices by module parameters? */
1890 if (id->match_flags == 0) {
1891 /* vendor match required, product match optional */
1892 if (!vendor || le16_to_cpu(udev->descriptor.idVendor) != (u16)vendor)
1893 return -ENODEV;
1894 if (product && le16_to_cpu(udev->descriptor.idProduct) != (u16)product)
1895 return -ENODEV;
1896 dbg ("matched module params, vend=0x%04x prod=0x%04x",
1897 le16_to_cpu(udev->descriptor.idVendor),
1898 le16_to_cpu(udev->descriptor.idProduct));
1900 #endif
1902 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1903 if (!dev)
1904 return -ENOMEM;
1905 info = (struct usbtest_info *) id->driver_info;
1906 dev->info = info;
1907 init_MUTEX (&dev->sem);
1909 dev->intf = intf;
1911 /* cacheline-aligned scratch for i/o */
1912 if ((dev->buf = kmalloc (TBUF_SIZE, GFP_KERNEL)) == NULL) {
1913 kfree (dev);
1914 return -ENOMEM;
1917 /* NOTE this doesn't yet test the handful of difference that are
1918 * visible with high speed interrupts: bigger maxpacket (1K) and
1919 * "high bandwidth" modes (up to 3 packets/uframe).
1921 rtest = wtest = "";
1922 irtest = iwtest = "";
1923 if (force_interrupt || udev->speed == USB_SPEED_LOW) {
1924 if (info->ep_in) {
1925 dev->in_pipe = usb_rcvintpipe (udev, info->ep_in);
1926 rtest = " intr-in";
1928 if (info->ep_out) {
1929 dev->out_pipe = usb_sndintpipe (udev, info->ep_out);
1930 wtest = " intr-out";
1932 } else {
1933 if (info->autoconf) {
1934 int status;
1936 status = get_endpoints (dev, intf);
1937 if (status < 0) {
1938 dbg ("couldn't get endpoints, %d\n", status);
1939 return status;
1941 /* may find bulk or ISO pipes */
1942 } else {
1943 if (info->ep_in)
1944 dev->in_pipe = usb_rcvbulkpipe (udev,
1945 info->ep_in);
1946 if (info->ep_out)
1947 dev->out_pipe = usb_sndbulkpipe (udev,
1948 info->ep_out);
1950 if (dev->in_pipe)
1951 rtest = " bulk-in";
1952 if (dev->out_pipe)
1953 wtest = " bulk-out";
1954 if (dev->in_iso_pipe)
1955 irtest = " iso-in";
1956 if (dev->out_iso_pipe)
1957 iwtest = " iso-out";
1960 usb_set_intfdata (intf, dev);
1961 dev_info (&intf->dev, "%s\n", info->name);
1962 dev_info (&intf->dev, "%s speed {control%s%s%s%s%s} tests%s\n",
1963 ({ char *tmp;
1964 switch (udev->speed) {
1965 case USB_SPEED_LOW: tmp = "low"; break;
1966 case USB_SPEED_FULL: tmp = "full"; break;
1967 case USB_SPEED_HIGH: tmp = "high"; break;
1968 default: tmp = "unknown"; break;
1969 }; tmp; }),
1970 info->ctrl_out ? " in/out" : "",
1971 rtest, wtest,
1972 irtest, iwtest,
1973 info->alt >= 0 ? " (+alt)" : "");
1974 return 0;
1977 static int usbtest_suspend (struct usb_interface *intf, pm_message_t message)
1979 return 0;
1982 static int usbtest_resume (struct usb_interface *intf)
1984 return 0;
1988 static void usbtest_disconnect (struct usb_interface *intf)
1990 struct usbtest_dev *dev = usb_get_intfdata (intf);
1992 down (&dev->sem);
1994 usb_set_intfdata (intf, NULL);
1995 dev_dbg (&intf->dev, "disconnect\n");
1996 kfree (dev);
1999 /* Basic testing only needs a device that can source or sink bulk traffic.
2000 * Any device can test control transfers (default with GENERIC binding).
2002 * Several entries work with the default EP0 implementation that's built
2003 * into EZ-USB chips. There's a default vendor ID which can be overridden
2004 * by (very) small config EEPROMS, but otherwise all these devices act
2005 * identically until firmware is loaded: only EP0 works. It turns out
2006 * to be easy to make other endpoints work, without modifying that EP0
2007 * behavior. For now, we expect that kind of firmware.
2010 /* an21xx or fx versions of ez-usb */
2011 static struct usbtest_info ez1_info = {
2012 .name = "EZ-USB device",
2013 .ep_in = 2,
2014 .ep_out = 2,
2015 .alt = 1,
2018 /* fx2 version of ez-usb */
2019 static struct usbtest_info ez2_info = {
2020 .name = "FX2 device",
2021 .ep_in = 6,
2022 .ep_out = 2,
2023 .alt = 1,
2026 /* ezusb family device with dedicated usb test firmware,
2028 static struct usbtest_info fw_info = {
2029 .name = "usb test device",
2030 .ep_in = 2,
2031 .ep_out = 2,
2032 .alt = 1,
2033 .autoconf = 1, // iso and ctrl_out need autoconf
2034 .ctrl_out = 1,
2035 .iso = 1, // iso_ep's are #8 in/out
2038 /* peripheral running Linux and 'zero.c' test firmware, or
2039 * its user-mode cousin. different versions of this use
2040 * different hardware with the same vendor/product codes.
2041 * host side MUST rely on the endpoint descriptors.
2043 static struct usbtest_info gz_info = {
2044 .name = "Linux gadget zero",
2045 .autoconf = 1,
2046 .ctrl_out = 1,
2047 .alt = 0,
2050 static struct usbtest_info um_info = {
2051 .name = "Linux user mode test driver",
2052 .autoconf = 1,
2053 .alt = -1,
2056 static struct usbtest_info um2_info = {
2057 .name = "Linux user mode ISO test driver",
2058 .autoconf = 1,
2059 .iso = 1,
2060 .alt = -1,
2063 #ifdef IBOT2
2064 /* this is a nice source of high speed bulk data;
2065 * uses an FX2, with firmware provided in the device
2067 static struct usbtest_info ibot2_info = {
2068 .name = "iBOT2 webcam",
2069 .ep_in = 2,
2070 .alt = -1,
2072 #endif
2074 #ifdef GENERIC
2075 /* we can use any device to test control traffic */
2076 static struct usbtest_info generic_info = {
2077 .name = "Generic USB device",
2078 .alt = -1,
2080 #endif
2082 // FIXME remove this
2083 static struct usbtest_info hact_info = {
2084 .name = "FX2/hact",
2085 //.ep_in = 6,
2086 .ep_out = 2,
2087 .alt = -1,
2091 static struct usb_device_id id_table [] = {
2093 { USB_DEVICE (0x0547, 0x1002),
2094 .driver_info = (unsigned long) &hact_info,
2097 /*-------------------------------------------------------------*/
2099 /* EZ-USB devices which download firmware to replace (or in our
2100 * case augment) the default device implementation.
2103 /* generic EZ-USB FX controller */
2104 { USB_DEVICE (0x0547, 0x2235),
2105 .driver_info = (unsigned long) &ez1_info,
2108 /* CY3671 development board with EZ-USB FX */
2109 { USB_DEVICE (0x0547, 0x0080),
2110 .driver_info = (unsigned long) &ez1_info,
2113 /* generic EZ-USB FX2 controller (or development board) */
2114 { USB_DEVICE (0x04b4, 0x8613),
2115 .driver_info = (unsigned long) &ez2_info,
2118 /* re-enumerated usb test device firmware */
2119 { USB_DEVICE (0xfff0, 0xfff0),
2120 .driver_info = (unsigned long) &fw_info,
2123 /* "Gadget Zero" firmware runs under Linux */
2124 { USB_DEVICE (0x0525, 0xa4a0),
2125 .driver_info = (unsigned long) &gz_info,
2128 /* so does a user-mode variant */
2129 { USB_DEVICE (0x0525, 0xa4a4),
2130 .driver_info = (unsigned long) &um_info,
2133 /* ... and a user-mode variant that talks iso */
2134 { USB_DEVICE (0x0525, 0xa4a3),
2135 .driver_info = (unsigned long) &um2_info,
2138 #ifdef KEYSPAN_19Qi
2139 /* Keyspan 19qi uses an21xx (original EZ-USB) */
2140 // this does not coexist with the real Keyspan 19qi driver!
2141 { USB_DEVICE (0x06cd, 0x010b),
2142 .driver_info = (unsigned long) &ez1_info,
2144 #endif
2146 /*-------------------------------------------------------------*/
2148 #ifdef IBOT2
2149 /* iBOT2 makes a nice source of high speed bulk-in data */
2150 // this does not coexist with a real iBOT2 driver!
2151 { USB_DEVICE (0x0b62, 0x0059),
2152 .driver_info = (unsigned long) &ibot2_info,
2154 #endif
2156 /*-------------------------------------------------------------*/
2158 #ifdef GENERIC
2159 /* module params can specify devices to use for control tests */
2160 { .driver_info = (unsigned long) &generic_info, },
2161 #endif
2163 /*-------------------------------------------------------------*/
2167 MODULE_DEVICE_TABLE (usb, id_table);
2169 static struct usb_driver usbtest_driver = {
2170 .name = "usbtest",
2171 .id_table = id_table,
2172 .probe = usbtest_probe,
2173 .ioctl = usbtest_ioctl,
2174 .disconnect = usbtest_disconnect,
2175 .suspend = usbtest_suspend,
2176 .resume = usbtest_resume,
2179 /*-------------------------------------------------------------------------*/
2181 static int __init usbtest_init (void)
2183 #ifdef GENERIC
2184 if (vendor)
2185 dbg ("params: vend=0x%04x prod=0x%04x", vendor, product);
2186 #endif
2187 return usb_register (&usbtest_driver);
2189 module_init (usbtest_init);
2191 static void __exit usbtest_exit (void)
2193 usb_deregister (&usbtest_driver);
2195 module_exit (usbtest_exit);
2197 MODULE_DESCRIPTION ("USB Core/HCD Testing Driver");
2198 MODULE_LICENSE ("GPL");