sky2: remove unneede workaround
[linux-2.6/mini2440.git] / drivers / usb / misc / usbtest.c
blob5f1a19d1497d108a41a23a7d2d73898bc20cf289
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 ERROR(tdev, fmt, args...) \
83 dev_err(&(tdev)->intf->dev , fmt , ## args)
84 #define WARNING(tdev, fmt, args...) \
85 dev_warn(&(tdev)->intf->dev , fmt , ## args)
87 /*-------------------------------------------------------------------------*/
89 static int
90 get_endpoints (struct usbtest_dev *dev, struct usb_interface *intf)
92 int tmp;
93 struct usb_host_interface *alt;
94 struct usb_host_endpoint *in, *out;
95 struct usb_host_endpoint *iso_in, *iso_out;
96 struct usb_device *udev;
98 for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
99 unsigned ep;
101 in = out = NULL;
102 iso_in = iso_out = NULL;
103 alt = intf->altsetting + tmp;
105 /* take the first altsetting with in-bulk + out-bulk;
106 * ignore other endpoints and altsetttings.
108 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
109 struct usb_host_endpoint *e;
111 e = alt->endpoint + ep;
112 switch (e->desc.bmAttributes) {
113 case USB_ENDPOINT_XFER_BULK:
114 break;
115 case USB_ENDPOINT_XFER_ISOC:
116 if (dev->info->iso)
117 goto try_iso;
118 // FALLTHROUGH
119 default:
120 continue;
122 if (usb_endpoint_dir_in(&e->desc)) {
123 if (!in)
124 in = e;
125 } else {
126 if (!out)
127 out = e;
129 continue;
130 try_iso:
131 if (usb_endpoint_dir_in(&e->desc)) {
132 if (!iso_in)
133 iso_in = e;
134 } else {
135 if (!iso_out)
136 iso_out = e;
139 if ((in && out) || (iso_in && iso_out))
140 goto found;
142 return -EINVAL;
144 found:
145 udev = testdev_to_usbdev (dev);
146 if (alt->desc.bAlternateSetting != 0) {
147 tmp = usb_set_interface (udev,
148 alt->desc.bInterfaceNumber,
149 alt->desc.bAlternateSetting);
150 if (tmp < 0)
151 return tmp;
154 if (in) {
155 dev->in_pipe = usb_rcvbulkpipe (udev,
156 in->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
157 dev->out_pipe = usb_sndbulkpipe (udev,
158 out->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
160 if (iso_in) {
161 dev->iso_in = &iso_in->desc;
162 dev->in_iso_pipe = usb_rcvisocpipe (udev,
163 iso_in->desc.bEndpointAddress
164 & USB_ENDPOINT_NUMBER_MASK);
165 dev->iso_out = &iso_out->desc;
166 dev->out_iso_pipe = usb_sndisocpipe (udev,
167 iso_out->desc.bEndpointAddress
168 & USB_ENDPOINT_NUMBER_MASK);
170 return 0;
173 /*-------------------------------------------------------------------------*/
175 /* Support for testing basic non-queued I/O streams.
177 * These just package urbs as requests that can be easily canceled.
178 * Each urb's data buffer is dynamically allocated; callers can fill
179 * them with non-zero test data (or test for it) when appropriate.
182 static void simple_callback (struct urb *urb)
184 complete(urb->context);
187 static struct urb *simple_alloc_urb (
188 struct usb_device *udev,
189 int pipe,
190 unsigned long bytes
193 struct urb *urb;
195 urb = usb_alloc_urb (0, GFP_KERNEL);
196 if (!urb)
197 return urb;
198 usb_fill_bulk_urb (urb, udev, pipe, NULL, bytes, simple_callback, NULL);
199 urb->interval = (udev->speed == USB_SPEED_HIGH)
200 ? (INTERRUPT_RATE << 3)
201 : INTERRUPT_RATE;
202 urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
203 if (usb_pipein (pipe))
204 urb->transfer_flags |= URB_SHORT_NOT_OK;
205 urb->transfer_buffer = usb_buffer_alloc (udev, bytes, GFP_KERNEL,
206 &urb->transfer_dma);
207 if (!urb->transfer_buffer) {
208 usb_free_urb (urb);
209 urb = NULL;
210 } else
211 memset (urb->transfer_buffer, 0, bytes);
212 return urb;
215 static unsigned pattern = 0;
216 module_param (pattern, uint, S_IRUGO);
217 MODULE_PARM_DESC(pattern, "i/o pattern (0 == zeroes)");
219 static inline void simple_fill_buf (struct urb *urb)
221 unsigned i;
222 u8 *buf = urb->transfer_buffer;
223 unsigned len = urb->transfer_buffer_length;
225 switch (pattern) {
226 default:
227 // FALLTHROUGH
228 case 0:
229 memset (buf, 0, len);
230 break;
231 case 1: /* mod63 */
232 for (i = 0; i < len; i++)
233 *buf++ = (u8) (i % 63);
234 break;
238 static inline int simple_check_buf(struct usbtest_dev *tdev, struct urb *urb)
240 unsigned i;
241 u8 expected;
242 u8 *buf = urb->transfer_buffer;
243 unsigned len = urb->actual_length;
245 for (i = 0; i < len; i++, buf++) {
246 switch (pattern) {
247 /* all-zeroes has no synchronization issues */
248 case 0:
249 expected = 0;
250 break;
251 /* mod63 stays in sync with short-terminated transfers,
252 * or otherwise when host and gadget agree on how large
253 * each usb transfer request should be. resync is done
254 * with set_interface or set_config.
256 case 1: /* mod63 */
257 expected = i % 63;
258 break;
259 /* always fail unsupported patterns */
260 default:
261 expected = !*buf;
262 break;
264 if (*buf == expected)
265 continue;
266 ERROR(tdev, "buf[%d] = %d (not %d)\n", i, *buf, expected);
267 return -EINVAL;
269 return 0;
272 static void simple_free_urb (struct urb *urb)
274 usb_buffer_free (urb->dev, urb->transfer_buffer_length,
275 urb->transfer_buffer, urb->transfer_dma);
276 usb_free_urb (urb);
279 static int simple_io (
280 struct usbtest_dev *tdev,
281 struct urb *urb,
282 int iterations,
283 int vary,
284 int expected,
285 const char *label
288 struct usb_device *udev = urb->dev;
289 int max = urb->transfer_buffer_length;
290 struct completion completion;
291 int retval = 0;
293 urb->context = &completion;
294 while (retval == 0 && iterations-- > 0) {
295 init_completion (&completion);
296 if (usb_pipeout (urb->pipe))
297 simple_fill_buf (urb);
298 if ((retval = usb_submit_urb (urb, GFP_KERNEL)) != 0)
299 break;
301 /* NOTE: no timeouts; can't be broken out of by interrupt */
302 wait_for_completion (&completion);
303 retval = urb->status;
304 urb->dev = udev;
305 if (retval == 0 && usb_pipein (urb->pipe))
306 retval = simple_check_buf(tdev, urb);
308 if (vary) {
309 int len = urb->transfer_buffer_length;
311 len += vary;
312 len %= max;
313 if (len == 0)
314 len = (vary < max) ? vary : max;
315 urb->transfer_buffer_length = len;
318 /* FIXME if endpoint halted, clear halt (and log) */
320 urb->transfer_buffer_length = max;
322 if (expected != retval)
323 dev_err(&udev->dev,
324 "%s failed, iterations left %d, status %d (not %d)\n",
325 label, iterations, retval, expected);
326 return retval;
330 /*-------------------------------------------------------------------------*/
332 /* We use scatterlist primitives to test queued I/O.
333 * Yes, this also tests the scatterlist primitives.
336 static void free_sglist (struct scatterlist *sg, int nents)
338 unsigned i;
340 if (!sg)
341 return;
342 for (i = 0; i < nents; i++) {
343 if (!sg_page(&sg[i]))
344 continue;
345 kfree (sg_virt(&sg[i]));
347 kfree (sg);
350 static struct scatterlist *
351 alloc_sglist (int nents, int max, int vary)
353 struct scatterlist *sg;
354 unsigned i;
355 unsigned size = max;
357 sg = kmalloc (nents * sizeof *sg, GFP_KERNEL);
358 if (!sg)
359 return NULL;
360 sg_init_table(sg, nents);
362 for (i = 0; i < nents; i++) {
363 char *buf;
364 unsigned j;
366 buf = kzalloc (size, GFP_KERNEL);
367 if (!buf) {
368 free_sglist (sg, i);
369 return NULL;
372 /* kmalloc pages are always physically contiguous! */
373 sg_set_buf(&sg[i], buf, size);
375 switch (pattern) {
376 case 0:
377 /* already zeroed */
378 break;
379 case 1:
380 for (j = 0; j < size; j++)
381 *buf++ = (u8) (j % 63);
382 break;
385 if (vary) {
386 size += vary;
387 size %= max;
388 if (size == 0)
389 size = (vary < max) ? vary : max;
393 return sg;
396 static int perform_sglist (
397 struct usbtest_dev *tdev,
398 unsigned iterations,
399 int pipe,
400 struct usb_sg_request *req,
401 struct scatterlist *sg,
402 int nents
405 struct usb_device *udev = testdev_to_usbdev(tdev);
406 int retval = 0;
408 while (retval == 0 && iterations-- > 0) {
409 retval = usb_sg_init (req, udev, pipe,
410 (udev->speed == USB_SPEED_HIGH)
411 ? (INTERRUPT_RATE << 3)
412 : INTERRUPT_RATE,
413 sg, nents, 0, GFP_KERNEL);
415 if (retval)
416 break;
417 usb_sg_wait (req);
418 retval = req->status;
420 /* FIXME check resulting data pattern */
422 /* FIXME if endpoint halted, clear halt (and log) */
425 // FIXME for unlink or fault handling tests, don't report
426 // failure if retval is as we expected ...
428 if (retval)
429 ERROR(tdev, "perform_sglist failed, "
430 "iterations left %d, status %d\n",
431 iterations, retval);
432 return retval;
436 /*-------------------------------------------------------------------------*/
438 /* unqueued control message testing
440 * there's a nice set of device functional requirements in chapter 9 of the
441 * usb 2.0 spec, which we can apply to ANY device, even ones that don't use
442 * special test firmware.
444 * we know the device is configured (or suspended) by the time it's visible
445 * through usbfs. we can't change that, so we won't test enumeration (which
446 * worked 'well enough' to get here, this time), power management (ditto),
447 * or remote wakeup (which needs human interaction).
450 static unsigned realworld = 1;
451 module_param (realworld, uint, 0);
452 MODULE_PARM_DESC (realworld, "clear to demand stricter spec compliance");
454 static int get_altsetting (struct usbtest_dev *dev)
456 struct usb_interface *iface = dev->intf;
457 struct usb_device *udev = interface_to_usbdev (iface);
458 int retval;
460 retval = usb_control_msg (udev, usb_rcvctrlpipe (udev, 0),
461 USB_REQ_GET_INTERFACE, USB_DIR_IN|USB_RECIP_INTERFACE,
462 0, iface->altsetting [0].desc.bInterfaceNumber,
463 dev->buf, 1, USB_CTRL_GET_TIMEOUT);
464 switch (retval) {
465 case 1:
466 return dev->buf [0];
467 case 0:
468 retval = -ERANGE;
469 // FALLTHROUGH
470 default:
471 return retval;
475 static int set_altsetting (struct usbtest_dev *dev, int alternate)
477 struct usb_interface *iface = dev->intf;
478 struct usb_device *udev;
480 if (alternate < 0 || alternate >= 256)
481 return -EINVAL;
483 udev = interface_to_usbdev (iface);
484 return usb_set_interface (udev,
485 iface->altsetting [0].desc.bInterfaceNumber,
486 alternate);
489 static int is_good_config(struct usbtest_dev *tdev, int len)
491 struct usb_config_descriptor *config;
493 if (len < sizeof *config)
494 return 0;
495 config = (struct usb_config_descriptor *) tdev->buf;
497 switch (config->bDescriptorType) {
498 case USB_DT_CONFIG:
499 case USB_DT_OTHER_SPEED_CONFIG:
500 if (config->bLength != 9) {
501 ERROR(tdev, "bogus config descriptor length\n");
502 return 0;
504 /* this bit 'must be 1' but often isn't */
505 if (!realworld && !(config->bmAttributes & 0x80)) {
506 ERROR(tdev, "high bit of config attributes not set\n");
507 return 0;
509 if (config->bmAttributes & 0x1f) { /* reserved == 0 */
510 ERROR(tdev, "reserved config bits set\n");
511 return 0;
513 break;
514 default:
515 return 0;
518 if (le16_to_cpu(config->wTotalLength) == len) /* read it all */
519 return 1;
520 if (le16_to_cpu(config->wTotalLength) >= TBUF_SIZE) /* max partial read */
521 return 1;
522 ERROR(tdev, "bogus config descriptor read size\n");
523 return 0;
526 /* sanity test for standard requests working with usb_control_mesg() and some
527 * of the utility functions which use it.
529 * this doesn't test how endpoint halts behave or data toggles get set, since
530 * we won't do I/O to bulk/interrupt endpoints here (which is how to change
531 * halt or toggle). toggle testing is impractical without support from hcds.
533 * this avoids failing devices linux would normally work with, by not testing
534 * config/altsetting operations for devices that only support their defaults.
535 * such devices rarely support those needless operations.
537 * NOTE that since this is a sanity test, it's not examining boundary cases
538 * to see if usbcore, hcd, and device all behave right. such testing would
539 * involve varied read sizes and other operation sequences.
541 static int ch9_postconfig (struct usbtest_dev *dev)
543 struct usb_interface *iface = dev->intf;
544 struct usb_device *udev = interface_to_usbdev (iface);
545 int i, alt, retval;
547 /* [9.2.3] if there's more than one altsetting, we need to be able to
548 * set and get each one. mostly trusts the descriptors from usbcore.
550 for (i = 0; i < iface->num_altsetting; i++) {
552 /* 9.2.3 constrains the range here */
553 alt = iface->altsetting [i].desc.bAlternateSetting;
554 if (alt < 0 || alt >= iface->num_altsetting) {
555 dev_err(&iface->dev,
556 "invalid alt [%d].bAltSetting = %d\n",
557 i, alt);
560 /* [real world] get/set unimplemented if there's only one */
561 if (realworld && iface->num_altsetting == 1)
562 continue;
564 /* [9.4.10] set_interface */
565 retval = set_altsetting (dev, alt);
566 if (retval) {
567 dev_err(&iface->dev, "can't set_interface = %d, %d\n",
568 alt, retval);
569 return retval;
572 /* [9.4.4] get_interface always works */
573 retval = get_altsetting (dev);
574 if (retval != alt) {
575 dev_err(&iface->dev, "get alt should be %d, was %d\n",
576 alt, retval);
577 return (retval < 0) ? retval : -EDOM;
582 /* [real world] get_config unimplemented if there's only one */
583 if (!realworld || udev->descriptor.bNumConfigurations != 1) {
584 int expected = udev->actconfig->desc.bConfigurationValue;
586 /* [9.4.2] get_configuration always works
587 * ... although some cheap devices (like one TI Hub I've got)
588 * won't return config descriptors except before set_config.
590 retval = usb_control_msg (udev, usb_rcvctrlpipe (udev, 0),
591 USB_REQ_GET_CONFIGURATION,
592 USB_DIR_IN | USB_RECIP_DEVICE,
593 0, 0, dev->buf, 1, USB_CTRL_GET_TIMEOUT);
594 if (retval != 1 || dev->buf [0] != expected) {
595 dev_err(&iface->dev, "get config --> %d %d (1 %d)\n",
596 retval, dev->buf[0], expected);
597 return (retval < 0) ? retval : -EDOM;
601 /* there's always [9.4.3] a device descriptor [9.6.1] */
602 retval = usb_get_descriptor (udev, USB_DT_DEVICE, 0,
603 dev->buf, sizeof udev->descriptor);
604 if (retval != sizeof udev->descriptor) {
605 dev_err(&iface->dev, "dev descriptor --> %d\n", retval);
606 return (retval < 0) ? retval : -EDOM;
609 /* there's always [9.4.3] at least one config descriptor [9.6.3] */
610 for (i = 0; i < udev->descriptor.bNumConfigurations; i++) {
611 retval = usb_get_descriptor (udev, USB_DT_CONFIG, i,
612 dev->buf, TBUF_SIZE);
613 if (!is_good_config(dev, retval)) {
614 dev_err(&iface->dev,
615 "config [%d] descriptor --> %d\n",
616 i, retval);
617 return (retval < 0) ? retval : -EDOM;
620 // FIXME cross-checking udev->config[i] to make sure usbcore
621 // parsed it right (etc) would be good testing paranoia
624 /* and sometimes [9.2.6.6] speed dependent descriptors */
625 if (le16_to_cpu(udev->descriptor.bcdUSB) == 0x0200) {
626 struct usb_qualifier_descriptor *d = NULL;
628 /* device qualifier [9.6.2] */
629 retval = usb_get_descriptor (udev,
630 USB_DT_DEVICE_QUALIFIER, 0, dev->buf,
631 sizeof (struct usb_qualifier_descriptor));
632 if (retval == -EPIPE) {
633 if (udev->speed == USB_SPEED_HIGH) {
634 dev_err(&iface->dev,
635 "hs dev qualifier --> %d\n",
636 retval);
637 return (retval < 0) ? retval : -EDOM;
639 /* usb2.0 but not high-speed capable; fine */
640 } else if (retval != sizeof (struct usb_qualifier_descriptor)) {
641 dev_err(&iface->dev, "dev qualifier --> %d\n", retval);
642 return (retval < 0) ? retval : -EDOM;
643 } else
644 d = (struct usb_qualifier_descriptor *) dev->buf;
646 /* might not have [9.6.2] any other-speed configs [9.6.4] */
647 if (d) {
648 unsigned max = d->bNumConfigurations;
649 for (i = 0; i < max; i++) {
650 retval = usb_get_descriptor (udev,
651 USB_DT_OTHER_SPEED_CONFIG, i,
652 dev->buf, TBUF_SIZE);
653 if (!is_good_config(dev, retval)) {
654 dev_err(&iface->dev,
655 "other speed config --> %d\n",
656 retval);
657 return (retval < 0) ? retval : -EDOM;
662 // FIXME fetch strings from at least the device descriptor
664 /* [9.4.5] get_status always works */
665 retval = usb_get_status (udev, USB_RECIP_DEVICE, 0, dev->buf);
666 if (retval != 2) {
667 dev_err(&iface->dev, "get dev status --> %d\n", retval);
668 return (retval < 0) ? retval : -EDOM;
671 // FIXME configuration.bmAttributes says if we could try to set/clear
672 // the device's remote wakeup feature ... if we can, test that here
674 retval = usb_get_status (udev, USB_RECIP_INTERFACE,
675 iface->altsetting [0].desc.bInterfaceNumber, dev->buf);
676 if (retval != 2) {
677 dev_err(&iface->dev, "get interface status --> %d\n", retval);
678 return (retval < 0) ? retval : -EDOM;
680 // FIXME get status for each endpoint in the interface
682 return 0;
685 /*-------------------------------------------------------------------------*/
687 /* use ch9 requests to test whether:
688 * (a) queues work for control, keeping N subtests queued and
689 * active (auto-resubmit) for M loops through the queue.
690 * (b) protocol stalls (control-only) will autorecover.
691 * it's not like bulk/intr; no halt clearing.
692 * (c) short control reads are reported and handled.
693 * (d) queues are always processed in-order
696 struct ctrl_ctx {
697 spinlock_t lock;
698 struct usbtest_dev *dev;
699 struct completion complete;
700 unsigned count;
701 unsigned pending;
702 int status;
703 struct urb **urb;
704 struct usbtest_param *param;
705 int last;
708 #define NUM_SUBCASES 15 /* how many test subcases here? */
710 struct subcase {
711 struct usb_ctrlrequest setup;
712 int number;
713 int expected;
716 static void ctrl_complete (struct urb *urb)
718 struct ctrl_ctx *ctx = urb->context;
719 struct usb_ctrlrequest *reqp;
720 struct subcase *subcase;
721 int status = urb->status;
723 reqp = (struct usb_ctrlrequest *)urb->setup_packet;
724 subcase = container_of (reqp, struct subcase, setup);
726 spin_lock (&ctx->lock);
727 ctx->count--;
728 ctx->pending--;
730 /* queue must transfer and complete in fifo order, unless
731 * usb_unlink_urb() is used to unlink something not at the
732 * physical queue head (not tested).
734 if (subcase->number > 0) {
735 if ((subcase->number - ctx->last) != 1) {
736 ERROR(ctx->dev,
737 "subcase %d completed out of order, last %d\n",
738 subcase->number, ctx->last);
739 status = -EDOM;
740 ctx->last = subcase->number;
741 goto error;
744 ctx->last = subcase->number;
746 /* succeed or fault in only one way? */
747 if (status == subcase->expected)
748 status = 0;
750 /* async unlink for cleanup? */
751 else if (status != -ECONNRESET) {
753 /* some faults are allowed, not required */
754 if (subcase->expected > 0 && (
755 ((status == -subcase->expected /* happened */
756 || status == 0)))) /* didn't */
757 status = 0;
758 /* sometimes more than one fault is allowed */
759 else if (subcase->number == 12 && status == -EPIPE)
760 status = 0;
761 else
762 ERROR(ctx->dev, "subtest %d error, status %d\n",
763 subcase->number, status);
766 /* unexpected status codes mean errors; ideally, in hardware */
767 if (status) {
768 error:
769 if (ctx->status == 0) {
770 int i;
772 ctx->status = status;
773 ERROR(ctx->dev, "control queue %02x.%02x, err %d, "
774 "%d left, subcase %d, len %d/%d\n",
775 reqp->bRequestType, reqp->bRequest,
776 status, ctx->count, subcase->number,
777 urb->actual_length,
778 urb->transfer_buffer_length);
780 /* FIXME this "unlink everything" exit route should
781 * be a separate test case.
784 /* unlink whatever's still pending */
785 for (i = 1; i < ctx->param->sglen; i++) {
786 struct urb *u = ctx->urb [
787 (i + subcase->number)
788 % ctx->param->sglen];
790 if (u == urb || !u->dev)
791 continue;
792 spin_unlock(&ctx->lock);
793 status = usb_unlink_urb (u);
794 spin_lock(&ctx->lock);
795 switch (status) {
796 case -EINPROGRESS:
797 case -EBUSY:
798 case -EIDRM:
799 continue;
800 default:
801 ERROR(ctx->dev, "urb unlink --> %d\n",
802 status);
805 status = ctx->status;
809 /* resubmit if we need to, else mark this as done */
810 if ((status == 0) && (ctx->pending < ctx->count)) {
811 if ((status = usb_submit_urb (urb, GFP_ATOMIC)) != 0) {
812 ERROR(ctx->dev,
813 "can't resubmit ctrl %02x.%02x, err %d\n",
814 reqp->bRequestType, reqp->bRequest, status);
815 urb->dev = NULL;
816 } else
817 ctx->pending++;
818 } else
819 urb->dev = NULL;
821 /* signal completion when nothing's queued */
822 if (ctx->pending == 0)
823 complete (&ctx->complete);
824 spin_unlock (&ctx->lock);
827 static int
828 test_ctrl_queue (struct usbtest_dev *dev, struct usbtest_param *param)
830 struct usb_device *udev = testdev_to_usbdev (dev);
831 struct urb **urb;
832 struct ctrl_ctx context;
833 int i;
835 spin_lock_init (&context.lock);
836 context.dev = dev;
837 init_completion (&context.complete);
838 context.count = param->sglen * param->iterations;
839 context.pending = 0;
840 context.status = -ENOMEM;
841 context.param = param;
842 context.last = -1;
844 /* allocate and init the urbs we'll queue.
845 * as with bulk/intr sglists, sglen is the queue depth; it also
846 * controls which subtests run (more tests than sglen) or rerun.
848 urb = kcalloc(param->sglen, sizeof(struct urb *), GFP_KERNEL);
849 if (!urb)
850 return -ENOMEM;
851 for (i = 0; i < param->sglen; i++) {
852 int pipe = usb_rcvctrlpipe (udev, 0);
853 unsigned len;
854 struct urb *u;
855 struct usb_ctrlrequest req;
856 struct subcase *reqp;
858 /* sign of this variable means:
859 * -: tested code must return this (negative) error code
860 * +: tested code may return this (negative too) error code
862 int expected = 0;
864 /* requests here are mostly expected to succeed on any
865 * device, but some are chosen to trigger protocol stalls
866 * or short reads.
868 memset (&req, 0, sizeof req);
869 req.bRequest = USB_REQ_GET_DESCRIPTOR;
870 req.bRequestType = USB_DIR_IN|USB_RECIP_DEVICE;
872 switch (i % NUM_SUBCASES) {
873 case 0: // get device descriptor
874 req.wValue = cpu_to_le16 (USB_DT_DEVICE << 8);
875 len = sizeof (struct usb_device_descriptor);
876 break;
877 case 1: // get first config descriptor (only)
878 req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
879 len = sizeof (struct usb_config_descriptor);
880 break;
881 case 2: // get altsetting (OFTEN STALLS)
882 req.bRequest = USB_REQ_GET_INTERFACE;
883 req.bRequestType = USB_DIR_IN|USB_RECIP_INTERFACE;
884 // index = 0 means first interface
885 len = 1;
886 expected = EPIPE;
887 break;
888 case 3: // get interface status
889 req.bRequest = USB_REQ_GET_STATUS;
890 req.bRequestType = USB_DIR_IN|USB_RECIP_INTERFACE;
891 // interface 0
892 len = 2;
893 break;
894 case 4: // get device status
895 req.bRequest = USB_REQ_GET_STATUS;
896 req.bRequestType = USB_DIR_IN|USB_RECIP_DEVICE;
897 len = 2;
898 break;
899 case 5: // get device qualifier (MAY STALL)
900 req.wValue = cpu_to_le16 (USB_DT_DEVICE_QUALIFIER << 8);
901 len = sizeof (struct usb_qualifier_descriptor);
902 if (udev->speed != USB_SPEED_HIGH)
903 expected = EPIPE;
904 break;
905 case 6: // get first config descriptor, plus interface
906 req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
907 len = sizeof (struct usb_config_descriptor);
908 len += sizeof (struct usb_interface_descriptor);
909 break;
910 case 7: // get interface descriptor (ALWAYS STALLS)
911 req.wValue = cpu_to_le16 (USB_DT_INTERFACE << 8);
912 // interface == 0
913 len = sizeof (struct usb_interface_descriptor);
914 expected = -EPIPE;
915 break;
916 // NOTE: two consecutive stalls in the queue here.
917 // that tests fault recovery a bit more aggressively.
918 case 8: // clear endpoint halt (MAY STALL)
919 req.bRequest = USB_REQ_CLEAR_FEATURE;
920 req.bRequestType = USB_RECIP_ENDPOINT;
921 // wValue 0 == ep halt
922 // wIndex 0 == ep0 (shouldn't halt!)
923 len = 0;
924 pipe = usb_sndctrlpipe (udev, 0);
925 expected = EPIPE;
926 break;
927 case 9: // get endpoint status
928 req.bRequest = USB_REQ_GET_STATUS;
929 req.bRequestType = USB_DIR_IN|USB_RECIP_ENDPOINT;
930 // endpoint 0
931 len = 2;
932 break;
933 case 10: // trigger short read (EREMOTEIO)
934 req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
935 len = 1024;
936 expected = -EREMOTEIO;
937 break;
938 // NOTE: two consecutive _different_ faults in the queue.
939 case 11: // get endpoint descriptor (ALWAYS STALLS)
940 req.wValue = cpu_to_le16 (USB_DT_ENDPOINT << 8);
941 // endpoint == 0
942 len = sizeof (struct usb_interface_descriptor);
943 expected = EPIPE;
944 break;
945 // NOTE: sometimes even a third fault in the queue!
946 case 12: // get string 0 descriptor (MAY STALL)
947 req.wValue = cpu_to_le16 (USB_DT_STRING << 8);
948 // string == 0, for language IDs
949 len = sizeof (struct usb_interface_descriptor);
950 // may succeed when > 4 languages
951 expected = EREMOTEIO; // or EPIPE, if no strings
952 break;
953 case 13: // short read, resembling case 10
954 req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
955 // last data packet "should" be DATA1, not DATA0
956 len = 1024 - udev->descriptor.bMaxPacketSize0;
957 expected = -EREMOTEIO;
958 break;
959 case 14: // short read; try to fill the last packet
960 req.wValue = cpu_to_le16 ((USB_DT_DEVICE << 8) | 0);
961 /* device descriptor size == 18 bytes */
962 len = udev->descriptor.bMaxPacketSize0;
963 switch (len) {
964 case 8: len = 24; break;
965 case 16: len = 32; break;
967 expected = -EREMOTEIO;
968 break;
969 default:
970 ERROR(dev, "bogus number of ctrl queue testcases!\n");
971 context.status = -EINVAL;
972 goto cleanup;
974 req.wLength = cpu_to_le16 (len);
975 urb [i] = u = simple_alloc_urb (udev, pipe, len);
976 if (!u)
977 goto cleanup;
979 reqp = usb_buffer_alloc (udev, sizeof *reqp, GFP_KERNEL,
980 &u->setup_dma);
981 if (!reqp)
982 goto cleanup;
983 reqp->setup = req;
984 reqp->number = i % NUM_SUBCASES;
985 reqp->expected = expected;
986 u->setup_packet = (char *) &reqp->setup;
987 u->transfer_flags |= URB_NO_SETUP_DMA_MAP;
989 u->context = &context;
990 u->complete = ctrl_complete;
993 /* queue the urbs */
994 context.urb = urb;
995 spin_lock_irq (&context.lock);
996 for (i = 0; i < param->sglen; i++) {
997 context.status = usb_submit_urb (urb [i], GFP_ATOMIC);
998 if (context.status != 0) {
999 ERROR(dev, "can't submit urb[%d], status %d\n",
1000 i, context.status);
1001 context.count = context.pending;
1002 break;
1004 context.pending++;
1006 spin_unlock_irq (&context.lock);
1008 /* FIXME set timer and time out; provide a disconnect hook */
1010 /* wait for the last one to complete */
1011 if (context.pending > 0)
1012 wait_for_completion (&context.complete);
1014 cleanup:
1015 for (i = 0; i < param->sglen; i++) {
1016 if (!urb [i])
1017 continue;
1018 urb [i]->dev = udev;
1019 if (urb [i]->setup_packet)
1020 usb_buffer_free (udev, sizeof (struct usb_ctrlrequest),
1021 urb [i]->setup_packet,
1022 urb [i]->setup_dma);
1023 simple_free_urb (urb [i]);
1025 kfree (urb);
1026 return context.status;
1028 #undef NUM_SUBCASES
1031 /*-------------------------------------------------------------------------*/
1033 static void unlink1_callback (struct urb *urb)
1035 int status = urb->status;
1037 // we "know" -EPIPE (stall) never happens
1038 if (!status)
1039 status = usb_submit_urb (urb, GFP_ATOMIC);
1040 if (status) {
1041 urb->status = status;
1042 complete(urb->context);
1046 static int unlink1 (struct usbtest_dev *dev, int pipe, int size, int async)
1048 struct urb *urb;
1049 struct completion completion;
1050 int retval = 0;
1052 init_completion (&completion);
1053 urb = simple_alloc_urb (testdev_to_usbdev (dev), pipe, size);
1054 if (!urb)
1055 return -ENOMEM;
1056 urb->context = &completion;
1057 urb->complete = unlink1_callback;
1059 /* keep the endpoint busy. there are lots of hc/hcd-internal
1060 * states, and testing should get to all of them over time.
1062 * FIXME want additional tests for when endpoint is STALLing
1063 * due to errors, or is just NAKing requests.
1065 if ((retval = usb_submit_urb (urb, GFP_KERNEL)) != 0) {
1066 dev_err(&dev->intf->dev, "submit fail %d\n", retval);
1067 return retval;
1070 /* unlinking that should always work. variable delay tests more
1071 * hcd states and code paths, even with little other system load.
1073 msleep (jiffies % (2 * INTERRUPT_RATE));
1074 if (async) {
1075 retry:
1076 retval = usb_unlink_urb (urb);
1077 if (retval == -EBUSY || retval == -EIDRM) {
1078 /* we can't unlink urbs while they're completing.
1079 * or if they've completed, and we haven't resubmitted.
1080 * "normal" drivers would prevent resubmission, but
1081 * since we're testing unlink paths, we can't.
1083 ERROR(dev, "unlink retry\n");
1084 goto retry;
1086 } else
1087 usb_kill_urb (urb);
1088 if (!(retval == 0 || retval == -EINPROGRESS)) {
1089 dev_err(&dev->intf->dev, "unlink fail %d\n", retval);
1090 return retval;
1093 wait_for_completion (&completion);
1094 retval = urb->status;
1095 simple_free_urb (urb);
1097 if (async)
1098 return (retval == -ECONNRESET) ? 0 : retval - 1000;
1099 else
1100 return (retval == -ENOENT || retval == -EPERM) ?
1101 0 : retval - 2000;
1104 static int unlink_simple (struct usbtest_dev *dev, int pipe, int len)
1106 int retval = 0;
1108 /* test sync and async paths */
1109 retval = unlink1 (dev, pipe, len, 1);
1110 if (!retval)
1111 retval = unlink1 (dev, pipe, len, 0);
1112 return retval;
1115 /*-------------------------------------------------------------------------*/
1117 static int verify_not_halted(struct usbtest_dev *tdev, int ep, struct urb *urb)
1119 int retval;
1120 u16 status;
1122 /* shouldn't look or act halted */
1123 retval = usb_get_status (urb->dev, USB_RECIP_ENDPOINT, ep, &status);
1124 if (retval < 0) {
1125 ERROR(tdev, "ep %02x couldn't get no-halt status, %d\n",
1126 ep, retval);
1127 return retval;
1129 if (status != 0) {
1130 ERROR(tdev, "ep %02x bogus status: %04x != 0\n", ep, status);
1131 return -EINVAL;
1133 retval = simple_io(tdev, urb, 1, 0, 0, __func__);
1134 if (retval != 0)
1135 return -EINVAL;
1136 return 0;
1139 static int verify_halted(struct usbtest_dev *tdev, int ep, struct urb *urb)
1141 int retval;
1142 u16 status;
1144 /* should look and act halted */
1145 retval = usb_get_status (urb->dev, USB_RECIP_ENDPOINT, ep, &status);
1146 if (retval < 0) {
1147 ERROR(tdev, "ep %02x couldn't get halt status, %d\n",
1148 ep, retval);
1149 return retval;
1151 le16_to_cpus(&status);
1152 if (status != 1) {
1153 ERROR(tdev, "ep %02x bogus status: %04x != 1\n", ep, status);
1154 return -EINVAL;
1156 retval = simple_io(tdev, urb, 1, 0, -EPIPE, __func__);
1157 if (retval != -EPIPE)
1158 return -EINVAL;
1159 retval = simple_io(tdev, urb, 1, 0, -EPIPE, "verify_still_halted");
1160 if (retval != -EPIPE)
1161 return -EINVAL;
1162 return 0;
1165 static int test_halt(struct usbtest_dev *tdev, int ep, struct urb *urb)
1167 int retval;
1169 /* shouldn't look or act halted now */
1170 retval = verify_not_halted(tdev, 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 ERROR(tdev, "ep %02x couldn't set halt, %d\n", ep, retval);
1181 return retval;
1183 retval = verify_halted(tdev, 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 ERROR(tdev, "ep %02x couldn't clear halt, %d\n", ep, retval);
1191 return retval;
1193 retval = verify_not_halted(tdev, 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(dev, 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(dev, 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 ERROR(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 ERROR(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 ERROR(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 weird 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 ERROR (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_err(&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_err(&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_info(&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_info(&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.
1536 * WARNING: Because usbfs grabs udev->dev.sem before calling this ioctl(),
1537 * it locks out usbcore in certain code paths. Notably, if you disconnect
1538 * the device-under-test, khubd will wait block forever waiting for the
1539 * ioctl to complete ... so that usb_disconnect() can abort the pending
1540 * urbs and then call usbtest_disconnect(). To abort a test, you're best
1541 * off just killing the userspace task and waiting for it to exit.
1544 static int
1545 usbtest_ioctl (struct usb_interface *intf, unsigned int code, void *buf)
1547 struct usbtest_dev *dev = usb_get_intfdata (intf);
1548 struct usb_device *udev = testdev_to_usbdev (dev);
1549 struct usbtest_param *param = buf;
1550 int retval = -EOPNOTSUPP;
1551 struct urb *urb;
1552 struct scatterlist *sg;
1553 struct usb_sg_request req;
1554 struct timeval start;
1555 unsigned i;
1557 // FIXME USBDEVFS_CONNECTINFO doesn't say how fast the device is.
1559 if (code != USBTEST_REQUEST)
1560 return -EOPNOTSUPP;
1562 if (param->iterations <= 0)
1563 return -EINVAL;
1565 if (mutex_lock_interruptible(&dev->lock))
1566 return -ERESTARTSYS;
1568 /* FIXME: What if a system sleep starts while a test is running? */
1569 if (!intf->is_active) {
1570 mutex_unlock(&dev->lock);
1571 return -EHOSTUNREACH;
1574 /* some devices, like ez-usb default devices, need a non-default
1575 * altsetting to have any active endpoints. some tests change
1576 * altsettings; force a default so most tests don't need to check.
1578 if (dev->info->alt >= 0) {
1579 int res;
1581 if (intf->altsetting->desc.bInterfaceNumber) {
1582 mutex_unlock(&dev->lock);
1583 return -ENODEV;
1585 res = set_altsetting (dev, dev->info->alt);
1586 if (res) {
1587 dev_err (&intf->dev,
1588 "set altsetting to %d failed, %d\n",
1589 dev->info->alt, res);
1590 mutex_unlock(&dev->lock);
1591 return res;
1596 * Just a bunch of test cases that every HCD is expected to handle.
1598 * Some may need specific firmware, though it'd be good to have
1599 * one firmware image to handle all the test cases.
1601 * FIXME add more tests! cancel requests, verify the data, control
1602 * queueing, concurrent read+write threads, and so on.
1604 do_gettimeofday (&start);
1605 switch (param->test_num) {
1607 case 0:
1608 dev_info(&intf->dev, "TEST 0: NOP\n");
1609 retval = 0;
1610 break;
1612 /* Simple non-queued bulk I/O tests */
1613 case 1:
1614 if (dev->out_pipe == 0)
1615 break;
1616 dev_info(&intf->dev,
1617 "TEST 1: write %d bytes %u times\n",
1618 param->length, param->iterations);
1619 urb = simple_alloc_urb (udev, dev->out_pipe, param->length);
1620 if (!urb) {
1621 retval = -ENOMEM;
1622 break;
1624 // FIRMWARE: bulk sink (maybe accepts short writes)
1625 retval = simple_io(dev, urb, param->iterations, 0, 0, "test1");
1626 simple_free_urb (urb);
1627 break;
1628 case 2:
1629 if (dev->in_pipe == 0)
1630 break;
1631 dev_info(&intf->dev,
1632 "TEST 2: read %d bytes %u times\n",
1633 param->length, param->iterations);
1634 urb = simple_alloc_urb (udev, dev->in_pipe, param->length);
1635 if (!urb) {
1636 retval = -ENOMEM;
1637 break;
1639 // FIRMWARE: bulk source (maybe generates short writes)
1640 retval = simple_io(dev, urb, param->iterations, 0, 0, "test2");
1641 simple_free_urb (urb);
1642 break;
1643 case 3:
1644 if (dev->out_pipe == 0 || param->vary == 0)
1645 break;
1646 dev_info(&intf->dev,
1647 "TEST 3: write/%d 0..%d bytes %u times\n",
1648 param->vary, param->length, param->iterations);
1649 urb = simple_alloc_urb (udev, dev->out_pipe, param->length);
1650 if (!urb) {
1651 retval = -ENOMEM;
1652 break;
1654 // FIRMWARE: bulk sink (maybe accepts short writes)
1655 retval = simple_io(dev, urb, param->iterations, param->vary,
1656 0, "test3");
1657 simple_free_urb (urb);
1658 break;
1659 case 4:
1660 if (dev->in_pipe == 0 || param->vary == 0)
1661 break;
1662 dev_info(&intf->dev,
1663 "TEST 4: read/%d 0..%d bytes %u times\n",
1664 param->vary, param->length, param->iterations);
1665 urb = simple_alloc_urb (udev, dev->in_pipe, param->length);
1666 if (!urb) {
1667 retval = -ENOMEM;
1668 break;
1670 // FIRMWARE: bulk source (maybe generates short writes)
1671 retval = simple_io(dev, urb, param->iterations, param->vary,
1672 0, "test4");
1673 simple_free_urb (urb);
1674 break;
1676 /* Queued bulk I/O tests */
1677 case 5:
1678 if (dev->out_pipe == 0 || param->sglen == 0)
1679 break;
1680 dev_info(&intf->dev,
1681 "TEST 5: write %d sglists %d entries of %d bytes\n",
1682 param->iterations,
1683 param->sglen, param->length);
1684 sg = alloc_sglist (param->sglen, param->length, 0);
1685 if (!sg) {
1686 retval = -ENOMEM;
1687 break;
1689 // FIRMWARE: bulk sink (maybe accepts short writes)
1690 retval = perform_sglist(dev, param->iterations, dev->out_pipe,
1691 &req, sg, param->sglen);
1692 free_sglist (sg, param->sglen);
1693 break;
1695 case 6:
1696 if (dev->in_pipe == 0 || param->sglen == 0)
1697 break;
1698 dev_info(&intf->dev,
1699 "TEST 6: read %d sglists %d entries of %d bytes\n",
1700 param->iterations,
1701 param->sglen, param->length);
1702 sg = alloc_sglist (param->sglen, param->length, 0);
1703 if (!sg) {
1704 retval = -ENOMEM;
1705 break;
1707 // FIRMWARE: bulk source (maybe generates short writes)
1708 retval = perform_sglist(dev, param->iterations, dev->in_pipe,
1709 &req, sg, param->sglen);
1710 free_sglist (sg, param->sglen);
1711 break;
1712 case 7:
1713 if (dev->out_pipe == 0 || param->sglen == 0 || param->vary == 0)
1714 break;
1715 dev_info(&intf->dev,
1716 "TEST 7: write/%d %d sglists %d entries 0..%d bytes\n",
1717 param->vary, param->iterations,
1718 param->sglen, param->length);
1719 sg = alloc_sglist (param->sglen, param->length, param->vary);
1720 if (!sg) {
1721 retval = -ENOMEM;
1722 break;
1724 // FIRMWARE: bulk sink (maybe accepts short writes)
1725 retval = perform_sglist(dev, param->iterations, dev->out_pipe,
1726 &req, sg, param->sglen);
1727 free_sglist (sg, param->sglen);
1728 break;
1729 case 8:
1730 if (dev->in_pipe == 0 || param->sglen == 0 || param->vary == 0)
1731 break;
1732 dev_info(&intf->dev,
1733 "TEST 8: read/%d %d sglists %d entries 0..%d bytes\n",
1734 param->vary, param->iterations,
1735 param->sglen, param->length);
1736 sg = alloc_sglist (param->sglen, param->length, param->vary);
1737 if (!sg) {
1738 retval = -ENOMEM;
1739 break;
1741 // FIRMWARE: bulk source (maybe generates short writes)
1742 retval = perform_sglist(dev, param->iterations, dev->in_pipe,
1743 &req, sg, param->sglen);
1744 free_sglist (sg, param->sglen);
1745 break;
1747 /* non-queued sanity tests for control (chapter 9 subset) */
1748 case 9:
1749 retval = 0;
1750 dev_info(&intf->dev,
1751 "TEST 9: ch9 (subset) control tests, %d times\n",
1752 param->iterations);
1753 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1754 retval = ch9_postconfig (dev);
1755 if (retval)
1756 dev_err(&intf->dev, "ch9 subset failed, "
1757 "iterations left %d\n", i);
1758 break;
1760 /* queued control messaging */
1761 case 10:
1762 if (param->sglen == 0)
1763 break;
1764 retval = 0;
1765 dev_info(&intf->dev,
1766 "TEST 10: queue %d control calls, %d times\n",
1767 param->sglen,
1768 param->iterations);
1769 retval = test_ctrl_queue (dev, param);
1770 break;
1772 /* simple non-queued unlinks (ring with one urb) */
1773 case 11:
1774 if (dev->in_pipe == 0 || !param->length)
1775 break;
1776 retval = 0;
1777 dev_info(&intf->dev, "TEST 11: unlink %d reads of %d\n",
1778 param->iterations, param->length);
1779 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1780 retval = unlink_simple (dev, dev->in_pipe,
1781 param->length);
1782 if (retval)
1783 dev_err(&intf->dev, "unlink reads failed %d, "
1784 "iterations left %d\n", retval, i);
1785 break;
1786 case 12:
1787 if (dev->out_pipe == 0 || !param->length)
1788 break;
1789 retval = 0;
1790 dev_info(&intf->dev, "TEST 12: unlink %d writes of %d\n",
1791 param->iterations, param->length);
1792 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1793 retval = unlink_simple (dev, dev->out_pipe,
1794 param->length);
1795 if (retval)
1796 dev_err(&intf->dev, "unlink writes failed %d, "
1797 "iterations left %d\n", retval, i);
1798 break;
1800 /* ep halt tests */
1801 case 13:
1802 if (dev->out_pipe == 0 && dev->in_pipe == 0)
1803 break;
1804 retval = 0;
1805 dev_info(&intf->dev, "TEST 13: set/clear %d halts\n",
1806 param->iterations);
1807 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1808 retval = halt_simple (dev);
1810 if (retval)
1811 ERROR(dev, "halts failed, iterations left %d\n", i);
1812 break;
1814 /* control write tests */
1815 case 14:
1816 if (!dev->info->ctrl_out)
1817 break;
1818 dev_info(&intf->dev, "TEST 14: %d ep0out, %d..%d vary %d\n",
1819 param->iterations,
1820 realworld ? 1 : 0, param->length,
1821 param->vary);
1822 retval = ctrl_out(dev, param->iterations,
1823 param->length, param->vary);
1824 break;
1826 /* iso write tests */
1827 case 15:
1828 if (dev->out_iso_pipe == 0 || param->sglen == 0)
1829 break;
1830 dev_info(&intf->dev,
1831 "TEST 15: write %d iso, %d entries of %d bytes\n",
1832 param->iterations,
1833 param->sglen, param->length);
1834 // FIRMWARE: iso sink
1835 retval = test_iso_queue (dev, param,
1836 dev->out_iso_pipe, dev->iso_out);
1837 break;
1839 /* iso read tests */
1840 case 16:
1841 if (dev->in_iso_pipe == 0 || param->sglen == 0)
1842 break;
1843 dev_info(&intf->dev,
1844 "TEST 16: read %d iso, %d entries of %d bytes\n",
1845 param->iterations,
1846 param->sglen, param->length);
1847 // FIRMWARE: iso source
1848 retval = test_iso_queue (dev, param,
1849 dev->in_iso_pipe, dev->iso_in);
1850 break;
1852 // FIXME unlink from queue (ring with N urbs)
1854 // FIXME scatterlist cancel (needs helper thread)
1857 do_gettimeofday (&param->duration);
1858 param->duration.tv_sec -= start.tv_sec;
1859 param->duration.tv_usec -= start.tv_usec;
1860 if (param->duration.tv_usec < 0) {
1861 param->duration.tv_usec += 1000 * 1000;
1862 param->duration.tv_sec -= 1;
1864 mutex_unlock(&dev->lock);
1865 return retval;
1868 /*-------------------------------------------------------------------------*/
1870 static unsigned force_interrupt = 0;
1871 module_param (force_interrupt, uint, 0);
1872 MODULE_PARM_DESC (force_interrupt, "0 = test default; else interrupt");
1874 #ifdef GENERIC
1875 static unsigned short vendor;
1876 module_param(vendor, ushort, 0);
1877 MODULE_PARM_DESC (vendor, "vendor code (from usb-if)");
1879 static unsigned short product;
1880 module_param(product, ushort, 0);
1881 MODULE_PARM_DESC (product, "product code (from vendor)");
1882 #endif
1884 static int
1885 usbtest_probe (struct usb_interface *intf, const struct usb_device_id *id)
1887 struct usb_device *udev;
1888 struct usbtest_dev *dev;
1889 struct usbtest_info *info;
1890 char *rtest, *wtest;
1891 char *irtest, *iwtest;
1893 udev = interface_to_usbdev (intf);
1895 #ifdef GENERIC
1896 /* specify devices by module parameters? */
1897 if (id->match_flags == 0) {
1898 /* vendor match required, product match optional */
1899 if (!vendor || le16_to_cpu(udev->descriptor.idVendor) != (u16)vendor)
1900 return -ENODEV;
1901 if (product && le16_to_cpu(udev->descriptor.idProduct) != (u16)product)
1902 return -ENODEV;
1903 dev_info(&intf->dev, "matched module params, "
1904 "vend=0x%04x prod=0x%04x\n",
1905 le16_to_cpu(udev->descriptor.idVendor),
1906 le16_to_cpu(udev->descriptor.idProduct));
1908 #endif
1910 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1911 if (!dev)
1912 return -ENOMEM;
1913 info = (struct usbtest_info *) id->driver_info;
1914 dev->info = info;
1915 mutex_init(&dev->lock);
1917 dev->intf = intf;
1919 /* cacheline-aligned scratch for i/o */
1920 if ((dev->buf = kmalloc (TBUF_SIZE, GFP_KERNEL)) == NULL) {
1921 kfree (dev);
1922 return -ENOMEM;
1925 /* NOTE this doesn't yet test the handful of difference that are
1926 * visible with high speed interrupts: bigger maxpacket (1K) and
1927 * "high bandwidth" modes (up to 3 packets/uframe).
1929 rtest = wtest = "";
1930 irtest = iwtest = "";
1931 if (force_interrupt || udev->speed == USB_SPEED_LOW) {
1932 if (info->ep_in) {
1933 dev->in_pipe = usb_rcvintpipe (udev, info->ep_in);
1934 rtest = " intr-in";
1936 if (info->ep_out) {
1937 dev->out_pipe = usb_sndintpipe (udev, info->ep_out);
1938 wtest = " intr-out";
1940 } else {
1941 if (info->autoconf) {
1942 int status;
1944 status = get_endpoints (dev, intf);
1945 if (status < 0) {
1946 WARNING(dev, "couldn't get endpoints, %d\n",
1947 status);
1948 return status;
1950 /* may find bulk or ISO pipes */
1951 } else {
1952 if (info->ep_in)
1953 dev->in_pipe = usb_rcvbulkpipe (udev,
1954 info->ep_in);
1955 if (info->ep_out)
1956 dev->out_pipe = usb_sndbulkpipe (udev,
1957 info->ep_out);
1959 if (dev->in_pipe)
1960 rtest = " bulk-in";
1961 if (dev->out_pipe)
1962 wtest = " bulk-out";
1963 if (dev->in_iso_pipe)
1964 irtest = " iso-in";
1965 if (dev->out_iso_pipe)
1966 iwtest = " iso-out";
1969 usb_set_intfdata (intf, dev);
1970 dev_info (&intf->dev, "%s\n", info->name);
1971 dev_info (&intf->dev, "%s speed {control%s%s%s%s%s} tests%s\n",
1972 ({ char *tmp;
1973 switch (udev->speed) {
1974 case USB_SPEED_LOW: tmp = "low"; break;
1975 case USB_SPEED_FULL: tmp = "full"; break;
1976 case USB_SPEED_HIGH: tmp = "high"; break;
1977 default: tmp = "unknown"; break;
1978 }; tmp; }),
1979 info->ctrl_out ? " in/out" : "",
1980 rtest, wtest,
1981 irtest, iwtest,
1982 info->alt >= 0 ? " (+alt)" : "");
1983 return 0;
1986 static int usbtest_suspend (struct usb_interface *intf, pm_message_t message)
1988 return 0;
1991 static int usbtest_resume (struct usb_interface *intf)
1993 return 0;
1997 static void usbtest_disconnect (struct usb_interface *intf)
1999 struct usbtest_dev *dev = usb_get_intfdata (intf);
2001 usb_set_intfdata (intf, NULL);
2002 dev_dbg (&intf->dev, "disconnect\n");
2003 kfree (dev);
2006 /* Basic testing only needs a device that can source or sink bulk traffic.
2007 * Any device can test control transfers (default with GENERIC binding).
2009 * Several entries work with the default EP0 implementation that's built
2010 * into EZ-USB chips. There's a default vendor ID which can be overridden
2011 * by (very) small config EEPROMS, but otherwise all these devices act
2012 * identically until firmware is loaded: only EP0 works. It turns out
2013 * to be easy to make other endpoints work, without modifying that EP0
2014 * behavior. For now, we expect that kind of firmware.
2017 /* an21xx or fx versions of ez-usb */
2018 static struct usbtest_info ez1_info = {
2019 .name = "EZ-USB device",
2020 .ep_in = 2,
2021 .ep_out = 2,
2022 .alt = 1,
2025 /* fx2 version of ez-usb */
2026 static struct usbtest_info ez2_info = {
2027 .name = "FX2 device",
2028 .ep_in = 6,
2029 .ep_out = 2,
2030 .alt = 1,
2033 /* ezusb family device with dedicated usb test firmware,
2035 static struct usbtest_info fw_info = {
2036 .name = "usb test device",
2037 .ep_in = 2,
2038 .ep_out = 2,
2039 .alt = 1,
2040 .autoconf = 1, // iso and ctrl_out need autoconf
2041 .ctrl_out = 1,
2042 .iso = 1, // iso_ep's are #8 in/out
2045 /* peripheral running Linux and 'zero.c' test firmware, or
2046 * its user-mode cousin. different versions of this use
2047 * different hardware with the same vendor/product codes.
2048 * host side MUST rely on the endpoint descriptors.
2050 static struct usbtest_info gz_info = {
2051 .name = "Linux gadget zero",
2052 .autoconf = 1,
2053 .ctrl_out = 1,
2054 .alt = 0,
2057 static struct usbtest_info um_info = {
2058 .name = "Linux user mode test driver",
2059 .autoconf = 1,
2060 .alt = -1,
2063 static struct usbtest_info um2_info = {
2064 .name = "Linux user mode ISO test driver",
2065 .autoconf = 1,
2066 .iso = 1,
2067 .alt = -1,
2070 #ifdef IBOT2
2071 /* this is a nice source of high speed bulk data;
2072 * uses an FX2, with firmware provided in the device
2074 static struct usbtest_info ibot2_info = {
2075 .name = "iBOT2 webcam",
2076 .ep_in = 2,
2077 .alt = -1,
2079 #endif
2081 #ifdef GENERIC
2082 /* we can use any device to test control traffic */
2083 static struct usbtest_info generic_info = {
2084 .name = "Generic USB device",
2085 .alt = -1,
2087 #endif
2090 static struct usb_device_id id_table [] = {
2092 /*-------------------------------------------------------------*/
2094 /* EZ-USB devices which download firmware to replace (or in our
2095 * case augment) the default device implementation.
2098 /* generic EZ-USB FX controller */
2099 { USB_DEVICE (0x0547, 0x2235),
2100 .driver_info = (unsigned long) &ez1_info,
2103 /* CY3671 development board with EZ-USB FX */
2104 { USB_DEVICE (0x0547, 0x0080),
2105 .driver_info = (unsigned long) &ez1_info,
2108 /* generic EZ-USB FX2 controller (or development board) */
2109 { USB_DEVICE (0x04b4, 0x8613),
2110 .driver_info = (unsigned long) &ez2_info,
2113 /* re-enumerated usb test device firmware */
2114 { USB_DEVICE (0xfff0, 0xfff0),
2115 .driver_info = (unsigned long) &fw_info,
2118 /* "Gadget Zero" firmware runs under Linux */
2119 { USB_DEVICE (0x0525, 0xa4a0),
2120 .driver_info = (unsigned long) &gz_info,
2123 /* so does a user-mode variant */
2124 { USB_DEVICE (0x0525, 0xa4a4),
2125 .driver_info = (unsigned long) &um_info,
2128 /* ... and a user-mode variant that talks iso */
2129 { USB_DEVICE (0x0525, 0xa4a3),
2130 .driver_info = (unsigned long) &um2_info,
2133 #ifdef KEYSPAN_19Qi
2134 /* Keyspan 19qi uses an21xx (original EZ-USB) */
2135 // this does not coexist with the real Keyspan 19qi driver!
2136 { USB_DEVICE (0x06cd, 0x010b),
2137 .driver_info = (unsigned long) &ez1_info,
2139 #endif
2141 /*-------------------------------------------------------------*/
2143 #ifdef IBOT2
2144 /* iBOT2 makes a nice source of high speed bulk-in data */
2145 // this does not coexist with a real iBOT2 driver!
2146 { USB_DEVICE (0x0b62, 0x0059),
2147 .driver_info = (unsigned long) &ibot2_info,
2149 #endif
2151 /*-------------------------------------------------------------*/
2153 #ifdef GENERIC
2154 /* module params can specify devices to use for control tests */
2155 { .driver_info = (unsigned long) &generic_info, },
2156 #endif
2158 /*-------------------------------------------------------------*/
2162 MODULE_DEVICE_TABLE (usb, id_table);
2164 static struct usb_driver usbtest_driver = {
2165 .name = "usbtest",
2166 .id_table = id_table,
2167 .probe = usbtest_probe,
2168 .ioctl = usbtest_ioctl,
2169 .disconnect = usbtest_disconnect,
2170 .suspend = usbtest_suspend,
2171 .resume = usbtest_resume,
2174 /*-------------------------------------------------------------------------*/
2176 static int __init usbtest_init (void)
2178 #ifdef GENERIC
2179 if (vendor)
2180 pr_debug("params: vend=0x%04x prod=0x%04x\n", vendor, product);
2181 #endif
2182 return usb_register (&usbtest_driver);
2184 module_init (usbtest_init);
2186 static void __exit usbtest_exit (void)
2188 usb_deregister (&usbtest_driver);
2190 module_exit (usbtest_exit);
2192 MODULE_DESCRIPTION ("USB Core/HCD Testing Driver");
2193 MODULE_LICENSE ("GPL");