s/retreiv/retriev/g
[linux-2.6/kvm.git] / drivers / usb / misc / usbtest.c
blob605a2afe34ed614d485aea86195ef7550b073a31
1 #include <linux/config.h>
2 #include <linux/kernel.h>
3 #include <linux/errno.h>
4 #include <linux/init.h>
5 #include <linux/slab.h>
6 #include <linux/mm.h>
7 #include <linux/module.h>
8 #include <linux/moduleparam.h>
9 #include <linux/scatterlist.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 semaphore sem;
70 #define TBUF_SIZE 256
71 u8 *buf;
74 static struct usb_device *testdev_to_usbdev (struct usbtest_dev *test)
76 return interface_to_usbdev (test->intf);
79 /* set up all urbs so they can be used with either bulk or interrupt */
80 #define INTERRUPT_RATE 1 /* msec/transfer */
82 #define xprintk(tdev,level,fmt,args...) \
83 dev_printk(level , &(tdev)->intf->dev , fmt , ## args)
85 #ifdef DEBUG
86 #define DBG(dev,fmt,args...) \
87 xprintk(dev , KERN_DEBUG , fmt , ## args)
88 #else
89 #define DBG(dev,fmt,args...) \
90 do { } while (0)
91 #endif /* DEBUG */
93 #ifdef VERBOSE
94 #define VDBG DBG
95 #else
96 #define VDBG(dev,fmt,args...) \
97 do { } while (0)
98 #endif /* VERBOSE */
100 #define ERROR(dev,fmt,args...) \
101 xprintk(dev , KERN_ERR , fmt , ## args)
102 #define WARN(dev,fmt,args...) \
103 xprintk(dev , KERN_WARNING , fmt , ## args)
104 #define INFO(dev,fmt,args...) \
105 xprintk(dev , KERN_INFO , fmt , ## args)
107 /*-------------------------------------------------------------------------*/
109 static int
110 get_endpoints (struct usbtest_dev *dev, struct usb_interface *intf)
112 int tmp;
113 struct usb_host_interface *alt;
114 struct usb_host_endpoint *in, *out;
115 struct usb_host_endpoint *iso_in, *iso_out;
116 struct usb_device *udev;
118 for (tmp = 0; tmp < intf->num_altsetting; tmp++) {
119 unsigned ep;
121 in = out = NULL;
122 iso_in = iso_out = NULL;
123 alt = intf->altsetting + tmp;
125 /* take the first altsetting with in-bulk + out-bulk;
126 * ignore other endpoints and altsetttings.
128 for (ep = 0; ep < alt->desc.bNumEndpoints; ep++) {
129 struct usb_host_endpoint *e;
131 e = alt->endpoint + ep;
132 switch (e->desc.bmAttributes) {
133 case USB_ENDPOINT_XFER_BULK:
134 break;
135 case USB_ENDPOINT_XFER_ISOC:
136 if (dev->info->iso)
137 goto try_iso;
138 // FALLTHROUGH
139 default:
140 continue;
142 if (e->desc.bEndpointAddress & USB_DIR_IN) {
143 if (!in)
144 in = e;
145 } else {
146 if (!out)
147 out = e;
149 continue;
150 try_iso:
151 if (e->desc.bEndpointAddress & USB_DIR_IN) {
152 if (!iso_in)
153 iso_in = e;
154 } else {
155 if (!iso_out)
156 iso_out = e;
159 if ((in && out) || (iso_in && iso_out))
160 goto found;
162 return -EINVAL;
164 found:
165 udev = testdev_to_usbdev (dev);
166 if (alt->desc.bAlternateSetting != 0) {
167 tmp = usb_set_interface (udev,
168 alt->desc.bInterfaceNumber,
169 alt->desc.bAlternateSetting);
170 if (tmp < 0)
171 return tmp;
174 if (in) {
175 dev->in_pipe = usb_rcvbulkpipe (udev,
176 in->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
177 dev->out_pipe = usb_sndbulkpipe (udev,
178 out->desc.bEndpointAddress & USB_ENDPOINT_NUMBER_MASK);
180 if (iso_in) {
181 dev->iso_in = &iso_in->desc;
182 dev->in_iso_pipe = usb_rcvisocpipe (udev,
183 iso_in->desc.bEndpointAddress
184 & USB_ENDPOINT_NUMBER_MASK);
185 dev->iso_out = &iso_out->desc;
186 dev->out_iso_pipe = usb_sndisocpipe (udev,
187 iso_out->desc.bEndpointAddress
188 & USB_ENDPOINT_NUMBER_MASK);
190 return 0;
193 /*-------------------------------------------------------------------------*/
195 /* Support for testing basic non-queued I/O streams.
197 * These just package urbs as requests that can be easily canceled.
198 * Each urb's data buffer is dynamically allocated; callers can fill
199 * them with non-zero test data (or test for it) when appropriate.
202 static void simple_callback (struct urb *urb, struct pt_regs *regs)
204 complete ((struct completion *) urb->context);
207 static struct urb *simple_alloc_urb (
208 struct usb_device *udev,
209 int pipe,
210 unsigned long bytes
213 struct urb *urb;
215 if (bytes < 0)
216 return NULL;
217 urb = usb_alloc_urb (0, SLAB_KERNEL);
218 if (!urb)
219 return urb;
220 usb_fill_bulk_urb (urb, udev, pipe, NULL, bytes, simple_callback, NULL);
221 urb->interval = (udev->speed == USB_SPEED_HIGH)
222 ? (INTERRUPT_RATE << 3)
223 : INTERRUPT_RATE;
224 urb->transfer_flags = URB_NO_TRANSFER_DMA_MAP;
225 if (usb_pipein (pipe))
226 urb->transfer_flags |= URB_SHORT_NOT_OK;
227 urb->transfer_buffer = usb_buffer_alloc (udev, bytes, SLAB_KERNEL,
228 &urb->transfer_dma);
229 if (!urb->transfer_buffer) {
230 usb_free_urb (urb);
231 urb = NULL;
232 } else
233 memset (urb->transfer_buffer, 0, bytes);
234 return urb;
237 static unsigned pattern = 0;
238 module_param (pattern, uint, S_IRUGO);
239 // MODULE_PARM_DESC (pattern, "i/o pattern (0 == zeroes)");
241 static inline void simple_fill_buf (struct urb *urb)
243 unsigned i;
244 u8 *buf = urb->transfer_buffer;
245 unsigned len = urb->transfer_buffer_length;
247 switch (pattern) {
248 default:
249 // FALLTHROUGH
250 case 0:
251 memset (buf, 0, len);
252 break;
253 case 1: /* mod63 */
254 for (i = 0; i < len; i++)
255 *buf++ = (u8) (i % 63);
256 break;
260 static inline int simple_check_buf (struct urb *urb)
262 unsigned i;
263 u8 expected;
264 u8 *buf = urb->transfer_buffer;
265 unsigned len = urb->actual_length;
267 for (i = 0; i < len; i++, buf++) {
268 switch (pattern) {
269 /* all-zeroes has no synchronization issues */
270 case 0:
271 expected = 0;
272 break;
273 /* mod63 stays in sync with short-terminated transfers,
274 * or otherwise when host and gadget agree on how large
275 * each usb transfer request should be. resync is done
276 * with set_interface or set_config.
278 case 1: /* mod63 */
279 expected = i % 63;
280 break;
281 /* always fail unsupported patterns */
282 default:
283 expected = !*buf;
284 break;
286 if (*buf == expected)
287 continue;
288 dbg ("buf[%d] = %d (not %d)", i, *buf, expected);
289 return -EINVAL;
291 return 0;
294 static void simple_free_urb (struct urb *urb)
296 usb_buffer_free (urb->dev, urb->transfer_buffer_length,
297 urb->transfer_buffer, urb->transfer_dma);
298 usb_free_urb (urb);
301 static int simple_io (
302 struct urb *urb,
303 int iterations,
304 int vary,
305 int expected,
306 const char *label
309 struct usb_device *udev = urb->dev;
310 int max = urb->transfer_buffer_length;
311 struct completion completion;
312 int retval = 0;
314 urb->context = &completion;
315 while (retval == 0 && iterations-- > 0) {
316 init_completion (&completion);
317 if (usb_pipeout (urb->pipe))
318 simple_fill_buf (urb);
319 if ((retval = usb_submit_urb (urb, SLAB_KERNEL)) != 0)
320 break;
322 /* NOTE: no timeouts; can't be broken out of by interrupt */
323 wait_for_completion (&completion);
324 retval = urb->status;
325 urb->dev = udev;
326 if (retval == 0 && usb_pipein (urb->pipe))
327 retval = simple_check_buf (urb);
329 if (vary) {
330 int len = urb->transfer_buffer_length;
332 len += vary;
333 len %= max;
334 if (len == 0)
335 len = (vary < max) ? vary : max;
336 urb->transfer_buffer_length = len;
339 /* FIXME if endpoint halted, clear halt (and log) */
341 urb->transfer_buffer_length = max;
343 if (expected != retval)
344 dev_dbg (&udev->dev,
345 "%s failed, iterations left %d, status %d (not %d)\n",
346 label, iterations, retval, expected);
347 return retval;
351 /*-------------------------------------------------------------------------*/
353 /* We use scatterlist primitives to test queued I/O.
354 * Yes, this also tests the scatterlist primitives.
357 static void free_sglist (struct scatterlist *sg, int nents)
359 unsigned i;
361 if (!sg)
362 return;
363 for (i = 0; i < nents; i++) {
364 if (!sg [i].page)
365 continue;
366 kfree (page_address (sg [i].page) + sg [i].offset);
368 kfree (sg);
371 static struct scatterlist *
372 alloc_sglist (int nents, int max, int vary)
374 struct scatterlist *sg;
375 unsigned i;
376 unsigned size = max;
378 sg = kmalloc (nents * sizeof *sg, SLAB_KERNEL);
379 if (!sg)
380 return NULL;
382 for (i = 0; i < nents; i++) {
383 char *buf;
385 buf = kmalloc (size, SLAB_KERNEL);
386 if (!buf) {
387 free_sglist (sg, i);
388 return NULL;
390 memset (buf, 0, size);
392 /* kmalloc pages are always physically contiguous! */
393 sg_init_one(&sg[i], buf, size);
395 if (vary) {
396 size += vary;
397 size %= max;
398 if (size == 0)
399 size = (vary < max) ? vary : max;
403 return sg;
406 static int perform_sglist (
407 struct usb_device *udev,
408 unsigned iterations,
409 int pipe,
410 struct usb_sg_request *req,
411 struct scatterlist *sg,
412 int nents
415 int retval = 0;
417 while (retval == 0 && iterations-- > 0) {
418 retval = usb_sg_init (req, udev, pipe,
419 (udev->speed == USB_SPEED_HIGH)
420 ? (INTERRUPT_RATE << 3)
421 : INTERRUPT_RATE,
422 sg, nents, 0, SLAB_KERNEL);
424 if (retval)
425 break;
426 usb_sg_wait (req);
427 retval = req->status;
429 /* FIXME if endpoint halted, clear halt (and log) */
432 // FIXME for unlink or fault handling tests, don't report
433 // failure if retval is as we expected ...
435 if (retval)
436 dbg ("perform_sglist failed, iterations left %d, status %d",
437 iterations, retval);
438 return retval;
442 /*-------------------------------------------------------------------------*/
444 /* unqueued control message testing
446 * there's a nice set of device functional requirements in chapter 9 of the
447 * usb 2.0 spec, which we can apply to ANY device, even ones that don't use
448 * special test firmware.
450 * we know the device is configured (or suspended) by the time it's visible
451 * through usbfs. we can't change that, so we won't test enumeration (which
452 * worked 'well enough' to get here, this time), power management (ditto),
453 * or remote wakeup (which needs human interaction).
456 static unsigned realworld = 1;
457 module_param (realworld, uint, 0);
458 MODULE_PARM_DESC (realworld, "clear to demand stricter spec compliance");
460 static int get_altsetting (struct usbtest_dev *dev)
462 struct usb_interface *iface = dev->intf;
463 struct usb_device *udev = interface_to_usbdev (iface);
464 int retval;
466 retval = usb_control_msg (udev, usb_rcvctrlpipe (udev, 0),
467 USB_REQ_GET_INTERFACE, USB_DIR_IN|USB_RECIP_INTERFACE,
468 0, iface->altsetting [0].desc.bInterfaceNumber,
469 dev->buf, 1, USB_CTRL_GET_TIMEOUT);
470 switch (retval) {
471 case 1:
472 return dev->buf [0];
473 case 0:
474 retval = -ERANGE;
475 // FALLTHROUGH
476 default:
477 return retval;
481 static int set_altsetting (struct usbtest_dev *dev, int alternate)
483 struct usb_interface *iface = dev->intf;
484 struct usb_device *udev;
486 if (alternate < 0 || alternate >= 256)
487 return -EINVAL;
489 udev = interface_to_usbdev (iface);
490 return usb_set_interface (udev,
491 iface->altsetting [0].desc.bInterfaceNumber,
492 alternate);
495 static int is_good_config (char *buf, int len)
497 struct usb_config_descriptor *config;
499 if (len < sizeof *config)
500 return 0;
501 config = (struct usb_config_descriptor *) buf;
503 switch (config->bDescriptorType) {
504 case USB_DT_CONFIG:
505 case USB_DT_OTHER_SPEED_CONFIG:
506 if (config->bLength != 9) {
507 dbg ("bogus config descriptor length");
508 return 0;
510 /* this bit 'must be 1' but often isn't */
511 if (!realworld && !(config->bmAttributes & 0x80)) {
512 dbg ("high bit of config attributes not set");
513 return 0;
515 if (config->bmAttributes & 0x1f) { /* reserved == 0 */
516 dbg ("reserved config bits set");
517 return 0;
519 break;
520 default:
521 return 0;
524 if (le16_to_cpu(config->wTotalLength) == len) /* read it all */
525 return 1;
526 if (le16_to_cpu(config->wTotalLength) >= TBUF_SIZE) /* max partial read */
527 return 1;
528 dbg ("bogus config descriptor read size");
529 return 0;
532 /* sanity test for standard requests working with usb_control_mesg() and some
533 * of the utility functions which use it.
535 * this doesn't test how endpoint halts behave or data toggles get set, since
536 * we won't do I/O to bulk/interrupt endpoints here (which is how to change
537 * halt or toggle). toggle testing is impractical without support from hcds.
539 * this avoids failing devices linux would normally work with, by not testing
540 * config/altsetting operations for devices that only support their defaults.
541 * such devices rarely support those needless operations.
543 * NOTE that since this is a sanity test, it's not examining boundary cases
544 * to see if usbcore, hcd, and device all behave right. such testing would
545 * involve varied read sizes and other operation sequences.
547 static int ch9_postconfig (struct usbtest_dev *dev)
549 struct usb_interface *iface = dev->intf;
550 struct usb_device *udev = interface_to_usbdev (iface);
551 int i, alt, retval;
553 /* [9.2.3] if there's more than one altsetting, we need to be able to
554 * set and get each one. mostly trusts the descriptors from usbcore.
556 for (i = 0; i < iface->num_altsetting; i++) {
558 /* 9.2.3 constrains the range here */
559 alt = iface->altsetting [i].desc.bAlternateSetting;
560 if (alt < 0 || alt >= iface->num_altsetting) {
561 dev_dbg (&iface->dev,
562 "invalid alt [%d].bAltSetting = %d\n",
563 i, alt);
566 /* [real world] get/set unimplemented if there's only one */
567 if (realworld && iface->num_altsetting == 1)
568 continue;
570 /* [9.4.10] set_interface */
571 retval = set_altsetting (dev, alt);
572 if (retval) {
573 dev_dbg (&iface->dev, "can't set_interface = %d, %d\n",
574 alt, retval);
575 return retval;
578 /* [9.4.4] get_interface always works */
579 retval = get_altsetting (dev);
580 if (retval != alt) {
581 dev_dbg (&iface->dev, "get alt should be %d, was %d\n",
582 alt, retval);
583 return (retval < 0) ? retval : -EDOM;
588 /* [real world] get_config unimplemented if there's only one */
589 if (!realworld || udev->descriptor.bNumConfigurations != 1) {
590 int expected = udev->actconfig->desc.bConfigurationValue;
592 /* [9.4.2] get_configuration always works
593 * ... although some cheap devices (like one TI Hub I've got)
594 * won't return config descriptors except before set_config.
596 retval = usb_control_msg (udev, usb_rcvctrlpipe (udev, 0),
597 USB_REQ_GET_CONFIGURATION,
598 USB_DIR_IN | USB_RECIP_DEVICE,
599 0, 0, dev->buf, 1, USB_CTRL_GET_TIMEOUT);
600 if (retval != 1 || dev->buf [0] != expected) {
601 dev_dbg (&iface->dev, "get config --> %d %d (1 %d)\n",
602 retval, dev->buf[0], expected);
603 return (retval < 0) ? retval : -EDOM;
607 /* there's always [9.4.3] a device descriptor [9.6.1] */
608 retval = usb_get_descriptor (udev, USB_DT_DEVICE, 0,
609 dev->buf, sizeof udev->descriptor);
610 if (retval != sizeof udev->descriptor) {
611 dev_dbg (&iface->dev, "dev descriptor --> %d\n", retval);
612 return (retval < 0) ? retval : -EDOM;
615 /* there's always [9.4.3] at least one config descriptor [9.6.3] */
616 for (i = 0; i < udev->descriptor.bNumConfigurations; i++) {
617 retval = usb_get_descriptor (udev, USB_DT_CONFIG, i,
618 dev->buf, TBUF_SIZE);
619 if (!is_good_config (dev->buf, retval)) {
620 dev_dbg (&iface->dev,
621 "config [%d] descriptor --> %d\n",
622 i, retval);
623 return (retval < 0) ? retval : -EDOM;
626 // FIXME cross-checking udev->config[i] to make sure usbcore
627 // parsed it right (etc) would be good testing paranoia
630 /* and sometimes [9.2.6.6] speed dependent descriptors */
631 if (le16_to_cpu(udev->descriptor.bcdUSB) == 0x0200) {
632 struct usb_qualifier_descriptor *d = NULL;
634 /* device qualifier [9.6.2] */
635 retval = usb_get_descriptor (udev,
636 USB_DT_DEVICE_QUALIFIER, 0, dev->buf,
637 sizeof (struct usb_qualifier_descriptor));
638 if (retval == -EPIPE) {
639 if (udev->speed == USB_SPEED_HIGH) {
640 dev_dbg (&iface->dev,
641 "hs dev qualifier --> %d\n",
642 retval);
643 return (retval < 0) ? retval : -EDOM;
645 /* usb2.0 but not high-speed capable; fine */
646 } else if (retval != sizeof (struct usb_qualifier_descriptor)) {
647 dev_dbg (&iface->dev, "dev qualifier --> %d\n", retval);
648 return (retval < 0) ? retval : -EDOM;
649 } else
650 d = (struct usb_qualifier_descriptor *) dev->buf;
652 /* might not have [9.6.2] any other-speed configs [9.6.4] */
653 if (d) {
654 unsigned max = d->bNumConfigurations;
655 for (i = 0; i < max; i++) {
656 retval = usb_get_descriptor (udev,
657 USB_DT_OTHER_SPEED_CONFIG, i,
658 dev->buf, TBUF_SIZE);
659 if (!is_good_config (dev->buf, retval)) {
660 dev_dbg (&iface->dev,
661 "other speed config --> %d\n",
662 retval);
663 return (retval < 0) ? retval : -EDOM;
668 // FIXME fetch strings from at least the device descriptor
670 /* [9.4.5] get_status always works */
671 retval = usb_get_status (udev, USB_RECIP_DEVICE, 0, dev->buf);
672 if (retval != 2) {
673 dev_dbg (&iface->dev, "get dev status --> %d\n", retval);
674 return (retval < 0) ? retval : -EDOM;
677 // FIXME configuration.bmAttributes says if we could try to set/clear
678 // the device's remote wakeup feature ... if we can, test that here
680 retval = usb_get_status (udev, USB_RECIP_INTERFACE,
681 iface->altsetting [0].desc.bInterfaceNumber, dev->buf);
682 if (retval != 2) {
683 dev_dbg (&iface->dev, "get interface status --> %d\n", retval);
684 return (retval < 0) ? retval : -EDOM;
686 // FIXME get status for each endpoint in the interface
688 return 0;
691 /*-------------------------------------------------------------------------*/
693 /* use ch9 requests to test whether:
694 * (a) queues work for control, keeping N subtests queued and
695 * active (auto-resubmit) for M loops through the queue.
696 * (b) protocol stalls (control-only) will autorecover.
697 * it's not like bulk/intr; no halt clearing.
698 * (c) short control reads are reported and handled.
699 * (d) queues are always processed in-order
702 struct ctrl_ctx {
703 spinlock_t lock;
704 struct usbtest_dev *dev;
705 struct completion complete;
706 unsigned count;
707 unsigned pending;
708 int status;
709 struct urb **urb;
710 struct usbtest_param *param;
711 int last;
714 #define NUM_SUBCASES 15 /* how many test subcases here? */
716 struct subcase {
717 struct usb_ctrlrequest setup;
718 int number;
719 int expected;
722 static void ctrl_complete (struct urb *urb, struct pt_regs *regs)
724 struct ctrl_ctx *ctx = urb->context;
725 struct usb_ctrlrequest *reqp;
726 struct subcase *subcase;
727 int status = urb->status;
729 reqp = (struct usb_ctrlrequest *)urb->setup_packet;
730 subcase = container_of (reqp, struct subcase, setup);
732 spin_lock (&ctx->lock);
733 ctx->count--;
734 ctx->pending--;
736 /* queue must transfer and complete in fifo order, unless
737 * usb_unlink_urb() is used to unlink something not at the
738 * physical queue head (not tested).
740 if (subcase->number > 0) {
741 if ((subcase->number - ctx->last) != 1) {
742 dbg ("subcase %d completed out of order, last %d",
743 subcase->number, ctx->last);
744 status = -EDOM;
745 ctx->last = subcase->number;
746 goto error;
749 ctx->last = subcase->number;
751 /* succeed or fault in only one way? */
752 if (status == subcase->expected)
753 status = 0;
755 /* async unlink for cleanup? */
756 else if (status != -ECONNRESET) {
758 /* some faults are allowed, not required */
759 if (subcase->expected > 0 && (
760 ((urb->status == -subcase->expected /* happened */
761 || urb->status == 0)))) /* didn't */
762 status = 0;
763 /* sometimes more than one fault is allowed */
764 else if (subcase->number == 12 && status == -EPIPE)
765 status = 0;
766 else
767 dbg ("subtest %d error, status %d",
768 subcase->number, status);
771 /* unexpected status codes mean errors; ideally, in hardware */
772 if (status) {
773 error:
774 if (ctx->status == 0) {
775 int i;
777 ctx->status = status;
778 info ("control queue %02x.%02x, err %d, %d left",
779 reqp->bRequestType, reqp->bRequest,
780 status, ctx->count);
782 /* FIXME this "unlink everything" exit route should
783 * be a separate test case.
786 /* unlink whatever's still pending */
787 for (i = 1; i < ctx->param->sglen; i++) {
788 struct urb *u = ctx->urb [
789 (i + subcase->number) % ctx->param->sglen];
791 if (u == urb || !u->dev)
792 continue;
793 status = usb_unlink_urb (u);
794 switch (status) {
795 case -EINPROGRESS:
796 case -EBUSY:
797 case -EIDRM:
798 continue;
799 default:
800 dbg ("urb unlink --> %d", status);
803 status = ctx->status;
807 /* resubmit if we need to, else mark this as done */
808 if ((status == 0) && (ctx->pending < ctx->count)) {
809 if ((status = usb_submit_urb (urb, SLAB_ATOMIC)) != 0) {
810 dbg ("can't resubmit ctrl %02x.%02x, err %d",
811 reqp->bRequestType, reqp->bRequest, status);
812 urb->dev = NULL;
813 } else
814 ctx->pending++;
815 } else
816 urb->dev = NULL;
818 /* signal completion when nothing's queued */
819 if (ctx->pending == 0)
820 complete (&ctx->complete);
821 spin_unlock (&ctx->lock);
824 static int
825 test_ctrl_queue (struct usbtest_dev *dev, struct usbtest_param *param)
827 struct usb_device *udev = testdev_to_usbdev (dev);
828 struct urb **urb;
829 struct ctrl_ctx context;
830 int i;
832 spin_lock_init (&context.lock);
833 context.dev = dev;
834 init_completion (&context.complete);
835 context.count = param->sglen * param->iterations;
836 context.pending = 0;
837 context.status = -ENOMEM;
838 context.param = param;
839 context.last = -1;
841 /* allocate and init the urbs we'll queue.
842 * as with bulk/intr sglists, sglen is the queue depth; it also
843 * controls which subtests run (more tests than sglen) or rerun.
845 urb = kmalloc (param->sglen * sizeof (struct urb *), SLAB_KERNEL);
846 if (!urb)
847 return -ENOMEM;
848 memset (urb, 0, param->sglen * sizeof (struct urb *));
849 for (i = 0; i < param->sglen; i++) {
850 int pipe = usb_rcvctrlpipe (udev, 0);
851 unsigned len;
852 struct urb *u;
853 struct usb_ctrlrequest req;
854 struct subcase *reqp;
855 int expected = 0;
857 /* requests here are mostly expected to succeed on any
858 * device, but some are chosen to trigger protocol stalls
859 * or short reads.
861 memset (&req, 0, sizeof req);
862 req.bRequest = USB_REQ_GET_DESCRIPTOR;
863 req.bRequestType = USB_DIR_IN|USB_RECIP_DEVICE;
865 switch (i % NUM_SUBCASES) {
866 case 0: // get device descriptor
867 req.wValue = cpu_to_le16 (USB_DT_DEVICE << 8);
868 len = sizeof (struct usb_device_descriptor);
869 break;
870 case 1: // get first config descriptor (only)
871 req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
872 len = sizeof (struct usb_config_descriptor);
873 break;
874 case 2: // get altsetting (OFTEN STALLS)
875 req.bRequest = USB_REQ_GET_INTERFACE;
876 req.bRequestType = USB_DIR_IN|USB_RECIP_INTERFACE;
877 // index = 0 means first interface
878 len = 1;
879 expected = EPIPE;
880 break;
881 case 3: // get interface status
882 req.bRequest = USB_REQ_GET_STATUS;
883 req.bRequestType = USB_DIR_IN|USB_RECIP_INTERFACE;
884 // interface 0
885 len = 2;
886 break;
887 case 4: // get device status
888 req.bRequest = USB_REQ_GET_STATUS;
889 req.bRequestType = USB_DIR_IN|USB_RECIP_DEVICE;
890 len = 2;
891 break;
892 case 5: // get device qualifier (MAY STALL)
893 req.wValue = cpu_to_le16 (USB_DT_DEVICE_QUALIFIER << 8);
894 len = sizeof (struct usb_qualifier_descriptor);
895 if (udev->speed != USB_SPEED_HIGH)
896 expected = EPIPE;
897 break;
898 case 6: // get first config descriptor, plus interface
899 req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
900 len = sizeof (struct usb_config_descriptor);
901 len += sizeof (struct usb_interface_descriptor);
902 break;
903 case 7: // get interface descriptor (ALWAYS STALLS)
904 req.wValue = cpu_to_le16 (USB_DT_INTERFACE << 8);
905 // interface == 0
906 len = sizeof (struct usb_interface_descriptor);
907 expected = EPIPE;
908 break;
909 // NOTE: two consecutive stalls in the queue here.
910 // that tests fault recovery a bit more aggressively.
911 case 8: // clear endpoint halt (USUALLY STALLS)
912 req.bRequest = USB_REQ_CLEAR_FEATURE;
913 req.bRequestType = USB_RECIP_ENDPOINT;
914 // wValue 0 == ep halt
915 // wIndex 0 == ep0 (shouldn't halt!)
916 len = 0;
917 pipe = usb_sndctrlpipe (udev, 0);
918 expected = EPIPE;
919 break;
920 case 9: // get endpoint status
921 req.bRequest = USB_REQ_GET_STATUS;
922 req.bRequestType = USB_DIR_IN|USB_RECIP_ENDPOINT;
923 // endpoint 0
924 len = 2;
925 break;
926 case 10: // trigger short read (EREMOTEIO)
927 req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
928 len = 1024;
929 expected = -EREMOTEIO;
930 break;
931 // NOTE: two consecutive _different_ faults in the queue.
932 case 11: // get endpoint descriptor (ALWAYS STALLS)
933 req.wValue = cpu_to_le16 (USB_DT_ENDPOINT << 8);
934 // endpoint == 0
935 len = sizeof (struct usb_interface_descriptor);
936 expected = EPIPE;
937 break;
938 // NOTE: sometimes even a third fault in the queue!
939 case 12: // get string 0 descriptor (MAY STALL)
940 req.wValue = cpu_to_le16 (USB_DT_STRING << 8);
941 // string == 0, for language IDs
942 len = sizeof (struct usb_interface_descriptor);
943 // may succeed when > 4 languages
944 expected = EREMOTEIO; // or EPIPE, if no strings
945 break;
946 case 13: // short read, resembling case 10
947 req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
948 // last data packet "should" be DATA1, not DATA0
949 len = 1024 - udev->descriptor.bMaxPacketSize0;
950 expected = -EREMOTEIO;
951 break;
952 case 14: // short read; try to fill the last packet
953 req.wValue = cpu_to_le16 ((USB_DT_DEVICE << 8) | 0);
954 // device descriptor size == 18 bytes
955 len = udev->descriptor.bMaxPacketSize0;
956 switch (len) {
957 case 8: len = 24; break;
958 case 16: len = 32; break;
960 expected = -EREMOTEIO;
961 break;
962 default:
963 err ("bogus number of ctrl queue testcases!");
964 context.status = -EINVAL;
965 goto cleanup;
967 req.wLength = cpu_to_le16 (len);
968 urb [i] = u = simple_alloc_urb (udev, pipe, len);
969 if (!u)
970 goto cleanup;
972 reqp = usb_buffer_alloc (udev, sizeof *reqp, SLAB_KERNEL,
973 &u->setup_dma);
974 if (!reqp)
975 goto cleanup;
976 reqp->setup = req;
977 reqp->number = i % NUM_SUBCASES;
978 reqp->expected = expected;
979 u->setup_packet = (char *) &reqp->setup;
980 u->transfer_flags |= URB_NO_SETUP_DMA_MAP;
982 u->context = &context;
983 u->complete = ctrl_complete;
986 /* queue the urbs */
987 context.urb = urb;
988 spin_lock_irq (&context.lock);
989 for (i = 0; i < param->sglen; i++) {
990 context.status = usb_submit_urb (urb [i], SLAB_ATOMIC);
991 if (context.status != 0) {
992 dbg ("can't submit urb[%d], status %d",
993 i, context.status);
994 context.count = context.pending;
995 break;
997 context.pending++;
999 spin_unlock_irq (&context.lock);
1001 /* FIXME set timer and time out; provide a disconnect hook */
1003 /* wait for the last one to complete */
1004 if (context.pending > 0)
1005 wait_for_completion (&context.complete);
1007 cleanup:
1008 for (i = 0; i < param->sglen; i++) {
1009 if (!urb [i])
1010 continue;
1011 urb [i]->dev = udev;
1012 if (urb [i]->setup_packet)
1013 usb_buffer_free (udev, sizeof (struct usb_ctrlrequest),
1014 urb [i]->setup_packet,
1015 urb [i]->setup_dma);
1016 simple_free_urb (urb [i]);
1018 kfree (urb);
1019 return context.status;
1021 #undef NUM_SUBCASES
1024 /*-------------------------------------------------------------------------*/
1026 static void unlink1_callback (struct urb *urb, struct pt_regs *regs)
1028 int status = urb->status;
1030 // we "know" -EPIPE (stall) never happens
1031 if (!status)
1032 status = usb_submit_urb (urb, SLAB_ATOMIC);
1033 if (status) {
1034 urb->status = status;
1035 complete ((struct completion *) urb->context);
1039 static int unlink1 (struct usbtest_dev *dev, int pipe, int size, int async)
1041 struct urb *urb;
1042 struct completion completion;
1043 int retval = 0;
1045 init_completion (&completion);
1046 urb = simple_alloc_urb (testdev_to_usbdev (dev), pipe, size);
1047 if (!urb)
1048 return -ENOMEM;
1049 urb->context = &completion;
1050 urb->complete = unlink1_callback;
1052 /* keep the endpoint busy. there are lots of hc/hcd-internal
1053 * states, and testing should get to all of them over time.
1055 * FIXME want additional tests for when endpoint is STALLing
1056 * due to errors, or is just NAKing requests.
1058 if ((retval = usb_submit_urb (urb, SLAB_KERNEL)) != 0) {
1059 dev_dbg (&dev->intf->dev, "submit fail %d\n", retval);
1060 return retval;
1063 /* unlinking that should always work. variable delay tests more
1064 * hcd states and code paths, even with little other system load.
1066 msleep (jiffies % (2 * INTERRUPT_RATE));
1067 if (async) {
1068 retry:
1069 retval = usb_unlink_urb (urb);
1070 if (retval == -EBUSY || retval == -EIDRM) {
1071 /* we can't unlink urbs while they're completing.
1072 * or if they've completed, and we haven't resubmitted.
1073 * "normal" drivers would prevent resubmission, but
1074 * since we're testing unlink paths, we can't.
1076 dev_dbg (&dev->intf->dev, "unlink retry\n");
1077 goto retry;
1079 } else
1080 usb_kill_urb (urb);
1081 if (!(retval == 0 || retval == -EINPROGRESS)) {
1082 dev_dbg (&dev->intf->dev, "unlink fail %d\n", retval);
1083 return retval;
1086 wait_for_completion (&completion);
1087 retval = urb->status;
1088 simple_free_urb (urb);
1090 if (async)
1091 return (retval == -ECONNRESET) ? 0 : retval - 1000;
1092 else
1093 return (retval == -ENOENT || retval == -EPERM) ?
1094 0 : retval - 2000;
1097 static int unlink_simple (struct usbtest_dev *dev, int pipe, int len)
1099 int retval = 0;
1101 /* test sync and async paths */
1102 retval = unlink1 (dev, pipe, len, 1);
1103 if (!retval)
1104 retval = unlink1 (dev, pipe, len, 0);
1105 return retval;
1108 /*-------------------------------------------------------------------------*/
1110 static int verify_not_halted (int ep, struct urb *urb)
1112 int retval;
1113 u16 status;
1115 /* shouldn't look or act halted */
1116 retval = usb_get_status (urb->dev, USB_RECIP_ENDPOINT, ep, &status);
1117 if (retval < 0) {
1118 dbg ("ep %02x couldn't get no-halt status, %d", ep, retval);
1119 return retval;
1121 if (status != 0) {
1122 dbg ("ep %02x bogus status: %04x != 0", ep, status);
1123 return -EINVAL;
1125 retval = simple_io (urb, 1, 0, 0, __FUNCTION__);
1126 if (retval != 0)
1127 return -EINVAL;
1128 return 0;
1131 static int verify_halted (int ep, struct urb *urb)
1133 int retval;
1134 u16 status;
1136 /* should look and act halted */
1137 retval = usb_get_status (urb->dev, USB_RECIP_ENDPOINT, ep, &status);
1138 if (retval < 0) {
1139 dbg ("ep %02x couldn't get halt status, %d", ep, retval);
1140 return retval;
1142 if (status != 1) {
1143 dbg ("ep %02x bogus status: %04x != 1", ep, status);
1144 return -EINVAL;
1146 retval = simple_io (urb, 1, 0, -EPIPE, __FUNCTION__);
1147 if (retval != -EPIPE)
1148 return -EINVAL;
1149 retval = simple_io (urb, 1, 0, -EPIPE, "verify_still_halted");
1150 if (retval != -EPIPE)
1151 return -EINVAL;
1152 return 0;
1155 static int test_halt (int ep, struct urb *urb)
1157 int retval;
1159 /* shouldn't look or act halted now */
1160 retval = verify_not_halted (ep, urb);
1161 if (retval < 0)
1162 return retval;
1164 /* set halt (protocol test only), verify it worked */
1165 retval = usb_control_msg (urb->dev, usb_sndctrlpipe (urb->dev, 0),
1166 USB_REQ_SET_FEATURE, USB_RECIP_ENDPOINT,
1167 USB_ENDPOINT_HALT, ep,
1168 NULL, 0, USB_CTRL_SET_TIMEOUT);
1169 if (retval < 0) {
1170 dbg ("ep %02x couldn't set halt, %d", ep, retval);
1171 return retval;
1173 retval = verify_halted (ep, urb);
1174 if (retval < 0)
1175 return retval;
1177 /* clear halt (tests API + protocol), verify it worked */
1178 retval = usb_clear_halt (urb->dev, urb->pipe);
1179 if (retval < 0) {
1180 dbg ("ep %02x couldn't clear halt, %d", ep, retval);
1181 return retval;
1183 retval = verify_not_halted (ep, urb);
1184 if (retval < 0)
1185 return retval;
1187 /* NOTE: could also verify SET_INTERFACE clear halts ... */
1189 return 0;
1192 static int halt_simple (struct usbtest_dev *dev)
1194 int ep;
1195 int retval = 0;
1196 struct urb *urb;
1198 urb = simple_alloc_urb (testdev_to_usbdev (dev), 0, 512);
1199 if (urb == NULL)
1200 return -ENOMEM;
1202 if (dev->in_pipe) {
1203 ep = usb_pipeendpoint (dev->in_pipe) | USB_DIR_IN;
1204 urb->pipe = dev->in_pipe;
1205 retval = test_halt (ep, urb);
1206 if (retval < 0)
1207 goto done;
1210 if (dev->out_pipe) {
1211 ep = usb_pipeendpoint (dev->out_pipe);
1212 urb->pipe = dev->out_pipe;
1213 retval = test_halt (ep, urb);
1215 done:
1216 simple_free_urb (urb);
1217 return retval;
1220 /*-------------------------------------------------------------------------*/
1222 /* Control OUT tests use the vendor control requests from Intel's
1223 * USB 2.0 compliance test device: write a buffer, read it back.
1225 * Intel's spec only _requires_ that it work for one packet, which
1226 * is pretty weak. Some HCDs place limits here; most devices will
1227 * need to be able to handle more than one OUT data packet. We'll
1228 * try whatever we're told to try.
1230 static int ctrl_out (struct usbtest_dev *dev,
1231 unsigned count, unsigned length, unsigned vary)
1233 unsigned i, j, len, retval;
1234 u8 *buf;
1235 char *what = "?";
1236 struct usb_device *udev;
1238 if (length < 1 || length > 0xffff || vary >= length)
1239 return -EINVAL;
1241 buf = kmalloc(length, SLAB_KERNEL);
1242 if (!buf)
1243 return -ENOMEM;
1245 udev = testdev_to_usbdev (dev);
1246 len = length;
1247 retval = 0;
1249 /* NOTE: hardware might well act differently if we pushed it
1250 * with lots back-to-back queued requests.
1252 for (i = 0; i < count; i++) {
1253 /* write patterned data */
1254 for (j = 0; j < len; j++)
1255 buf [j] = i + j;
1256 retval = usb_control_msg (udev, usb_sndctrlpipe (udev,0),
1257 0x5b, USB_DIR_OUT|USB_TYPE_VENDOR,
1258 0, 0, buf, len, USB_CTRL_SET_TIMEOUT);
1259 if (retval != len) {
1260 what = "write";
1261 if (retval >= 0) {
1262 INFO(dev, "ctrl_out, wlen %d (expected %d)\n",
1263 retval, len);
1264 retval = -EBADMSG;
1266 break;
1269 /* read it back -- assuming nothing intervened!! */
1270 retval = usb_control_msg (udev, usb_rcvctrlpipe (udev,0),
1271 0x5c, USB_DIR_IN|USB_TYPE_VENDOR,
1272 0, 0, buf, len, USB_CTRL_GET_TIMEOUT);
1273 if (retval != len) {
1274 what = "read";
1275 if (retval >= 0) {
1276 INFO(dev, "ctrl_out, rlen %d (expected %d)\n",
1277 retval, len);
1278 retval = -EBADMSG;
1280 break;
1283 /* fail if we can't verify */
1284 for (j = 0; j < len; j++) {
1285 if (buf [j] != (u8) (i + j)) {
1286 INFO (dev, "ctrl_out, byte %d is %d not %d\n",
1287 j, buf [j], (u8) i + j);
1288 retval = -EBADMSG;
1289 break;
1292 if (retval < 0) {
1293 what = "verify";
1294 break;
1297 len += vary;
1299 /* [real world] the "zero bytes IN" case isn't really used.
1300 * hardware can easily trip up in this wierd case, since its
1301 * status stage is IN, not OUT like other ep0in transfers.
1303 if (len > length)
1304 len = realworld ? 1 : 0;
1307 if (retval < 0)
1308 INFO (dev, "ctrl_out %s failed, code %d, count %d\n",
1309 what, retval, i);
1311 kfree (buf);
1312 return retval;
1315 /*-------------------------------------------------------------------------*/
1317 /* ISO tests ... mimics common usage
1318 * - buffer length is split into N packets (mostly maxpacket sized)
1319 * - multi-buffers according to sglen
1322 struct iso_context {
1323 unsigned count;
1324 unsigned pending;
1325 spinlock_t lock;
1326 struct completion done;
1327 unsigned long errors;
1328 struct usbtest_dev *dev;
1331 static void iso_callback (struct urb *urb, struct pt_regs *regs)
1333 struct iso_context *ctx = urb->context;
1335 spin_lock(&ctx->lock);
1336 ctx->count--;
1338 if (urb->error_count > 0)
1339 ctx->errors += urb->error_count;
1341 if (urb->status == 0 && ctx->count > (ctx->pending - 1)) {
1342 int status = usb_submit_urb (urb, GFP_ATOMIC);
1343 switch (status) {
1344 case 0:
1345 goto done;
1346 default:
1347 dev_dbg (&ctx->dev->intf->dev,
1348 "iso resubmit err %d\n",
1349 status);
1350 /* FALLTHROUGH */
1351 case -ENODEV: /* disconnected */
1352 break;
1355 simple_free_urb (urb);
1357 ctx->pending--;
1358 if (ctx->pending == 0) {
1359 if (ctx->errors)
1360 dev_dbg (&ctx->dev->intf->dev,
1361 "iso test, %lu errors\n",
1362 ctx->errors);
1363 complete (&ctx->done);
1365 done:
1366 spin_unlock(&ctx->lock);
1369 static struct urb *iso_alloc_urb (
1370 struct usb_device *udev,
1371 int pipe,
1372 struct usb_endpoint_descriptor *desc,
1373 long bytes
1376 struct urb *urb;
1377 unsigned i, maxp, packets;
1379 if (bytes < 0 || !desc)
1380 return NULL;
1381 maxp = 0x7ff & le16_to_cpu(desc->wMaxPacketSize);
1382 maxp *= 1 + (0x3 & (le16_to_cpu(desc->wMaxPacketSize) >> 11));
1383 packets = (bytes + maxp - 1) / maxp;
1385 urb = usb_alloc_urb (packets, SLAB_KERNEL);
1386 if (!urb)
1387 return urb;
1388 urb->dev = udev;
1389 urb->pipe = pipe;
1391 urb->number_of_packets = packets;
1392 urb->transfer_buffer_length = bytes;
1393 urb->transfer_buffer = usb_buffer_alloc (udev, bytes, SLAB_KERNEL,
1394 &urb->transfer_dma);
1395 if (!urb->transfer_buffer) {
1396 usb_free_urb (urb);
1397 return NULL;
1399 memset (urb->transfer_buffer, 0, bytes);
1400 for (i = 0; i < packets; i++) {
1401 /* here, only the last packet will be short */
1402 urb->iso_frame_desc[i].length = min ((unsigned) bytes, maxp);
1403 bytes -= urb->iso_frame_desc[i].length;
1405 urb->iso_frame_desc[i].offset = maxp * i;
1408 urb->complete = iso_callback;
1409 // urb->context = SET BY CALLER
1410 urb->interval = 1 << (desc->bInterval - 1);
1411 urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
1412 return urb;
1415 static int
1416 test_iso_queue (struct usbtest_dev *dev, struct usbtest_param *param,
1417 int pipe, struct usb_endpoint_descriptor *desc)
1419 struct iso_context context;
1420 struct usb_device *udev;
1421 unsigned i;
1422 unsigned long packets = 0;
1423 int status;
1424 struct urb *urbs[10]; /* FIXME no limit */
1426 if (param->sglen > 10)
1427 return -EDOM;
1429 context.count = param->iterations * param->sglen;
1430 context.pending = param->sglen;
1431 context.errors = 0;
1432 context.dev = dev;
1433 init_completion (&context.done);
1434 spin_lock_init (&context.lock);
1436 memset (urbs, 0, sizeof urbs);
1437 udev = testdev_to_usbdev (dev);
1438 dev_dbg (&dev->intf->dev,
1439 "... iso period %d %sframes, wMaxPacket %04x\n",
1440 1 << (desc->bInterval - 1),
1441 (udev->speed == USB_SPEED_HIGH) ? "micro" : "",
1442 le16_to_cpu(desc->wMaxPacketSize));
1444 for (i = 0; i < param->sglen; i++) {
1445 urbs [i] = iso_alloc_urb (udev, pipe, desc,
1446 param->length);
1447 if (!urbs [i]) {
1448 status = -ENOMEM;
1449 goto fail;
1451 packets += urbs[i]->number_of_packets;
1452 urbs [i]->context = &context;
1454 packets *= param->iterations;
1455 dev_dbg (&dev->intf->dev,
1456 "... total %lu msec (%lu packets)\n",
1457 (packets * (1 << (desc->bInterval - 1)))
1458 / ((udev->speed == USB_SPEED_HIGH) ? 8 : 1),
1459 packets);
1461 spin_lock_irq (&context.lock);
1462 for (i = 0; i < param->sglen; i++) {
1463 status = usb_submit_urb (urbs [i], SLAB_ATOMIC);
1464 if (status < 0) {
1465 ERROR (dev, "submit iso[%d], error %d\n", i, status);
1466 if (i == 0) {
1467 spin_unlock_irq (&context.lock);
1468 goto fail;
1471 simple_free_urb (urbs [i]);
1472 context.pending--;
1475 spin_unlock_irq (&context.lock);
1477 wait_for_completion (&context.done);
1478 return 0;
1480 fail:
1481 for (i = 0; i < param->sglen; i++) {
1482 if (urbs [i])
1483 simple_free_urb (urbs [i]);
1485 return status;
1488 /*-------------------------------------------------------------------------*/
1490 /* We only have this one interface to user space, through usbfs.
1491 * User mode code can scan usbfs to find N different devices (maybe on
1492 * different busses) to use when testing, and allocate one thread per
1493 * test. So discovery is simplified, and we have no device naming issues.
1495 * Don't use these only as stress/load tests. Use them along with with
1496 * other USB bus activity: plugging, unplugging, mousing, mp3 playback,
1497 * video capture, and so on. Run different tests at different times, in
1498 * different sequences. Nothing here should interact with other devices,
1499 * except indirectly by consuming USB bandwidth and CPU resources for test
1500 * threads and request completion. But the only way to know that for sure
1501 * is to test when HC queues are in use by many devices.
1504 static int
1505 usbtest_ioctl (struct usb_interface *intf, unsigned int code, void *buf)
1507 struct usbtest_dev *dev = usb_get_intfdata (intf);
1508 struct usb_device *udev = testdev_to_usbdev (dev);
1509 struct usbtest_param *param = buf;
1510 int retval = -EOPNOTSUPP;
1511 struct urb *urb;
1512 struct scatterlist *sg;
1513 struct usb_sg_request req;
1514 struct timeval start;
1515 unsigned i;
1517 // FIXME USBDEVFS_CONNECTINFO doesn't say how fast the device is.
1519 if (code != USBTEST_REQUEST)
1520 return -EOPNOTSUPP;
1522 if (param->iterations <= 0 || param->length < 0
1523 || param->sglen < 0 || param->vary < 0)
1524 return -EINVAL;
1526 if (down_interruptible (&dev->sem))
1527 return -ERESTARTSYS;
1529 if (intf->dev.power.power_state.event != PM_EVENT_ON) {
1530 up (&dev->sem);
1531 return -EHOSTUNREACH;
1534 /* some devices, like ez-usb default devices, need a non-default
1535 * altsetting to have any active endpoints. some tests change
1536 * altsettings; force a default so most tests don't need to check.
1538 if (dev->info->alt >= 0) {
1539 int res;
1541 if (intf->altsetting->desc.bInterfaceNumber) {
1542 up (&dev->sem);
1543 return -ENODEV;
1545 res = set_altsetting (dev, dev->info->alt);
1546 if (res) {
1547 dev_err (&intf->dev,
1548 "set altsetting to %d failed, %d\n",
1549 dev->info->alt, res);
1550 up (&dev->sem);
1551 return res;
1556 * Just a bunch of test cases that every HCD is expected to handle.
1558 * Some may need specific firmware, though it'd be good to have
1559 * one firmware image to handle all the test cases.
1561 * FIXME add more tests! cancel requests, verify the data, control
1562 * queueing, concurrent read+write threads, and so on.
1564 do_gettimeofday (&start);
1565 switch (param->test_num) {
1567 case 0:
1568 dev_dbg (&intf->dev, "TEST 0: NOP\n");
1569 retval = 0;
1570 break;
1572 /* Simple non-queued bulk I/O tests */
1573 case 1:
1574 if (dev->out_pipe == 0)
1575 break;
1576 dev_dbg (&intf->dev,
1577 "TEST 1: write %d bytes %u times\n",
1578 param->length, param->iterations);
1579 urb = simple_alloc_urb (udev, dev->out_pipe, param->length);
1580 if (!urb) {
1581 retval = -ENOMEM;
1582 break;
1584 // FIRMWARE: bulk sink (maybe accepts short writes)
1585 retval = simple_io (urb, param->iterations, 0, 0, "test1");
1586 simple_free_urb (urb);
1587 break;
1588 case 2:
1589 if (dev->in_pipe == 0)
1590 break;
1591 dev_dbg (&intf->dev,
1592 "TEST 2: read %d bytes %u times\n",
1593 param->length, param->iterations);
1594 urb = simple_alloc_urb (udev, dev->in_pipe, param->length);
1595 if (!urb) {
1596 retval = -ENOMEM;
1597 break;
1599 // FIRMWARE: bulk source (maybe generates short writes)
1600 retval = simple_io (urb, param->iterations, 0, 0, "test2");
1601 simple_free_urb (urb);
1602 break;
1603 case 3:
1604 if (dev->out_pipe == 0 || param->vary == 0)
1605 break;
1606 dev_dbg (&intf->dev,
1607 "TEST 3: write/%d 0..%d bytes %u times\n",
1608 param->vary, param->length, param->iterations);
1609 urb = simple_alloc_urb (udev, dev->out_pipe, param->length);
1610 if (!urb) {
1611 retval = -ENOMEM;
1612 break;
1614 // FIRMWARE: bulk sink (maybe accepts short writes)
1615 retval = simple_io (urb, param->iterations, param->vary,
1616 0, "test3");
1617 simple_free_urb (urb);
1618 break;
1619 case 4:
1620 if (dev->in_pipe == 0 || param->vary == 0)
1621 break;
1622 dev_dbg (&intf->dev,
1623 "TEST 4: read/%d 0..%d bytes %u times\n",
1624 param->vary, param->length, param->iterations);
1625 urb = simple_alloc_urb (udev, dev->in_pipe, param->length);
1626 if (!urb) {
1627 retval = -ENOMEM;
1628 break;
1630 // FIRMWARE: bulk source (maybe generates short writes)
1631 retval = simple_io (urb, param->iterations, param->vary,
1632 0, "test4");
1633 simple_free_urb (urb);
1634 break;
1636 /* Queued bulk I/O tests */
1637 case 5:
1638 if (dev->out_pipe == 0 || param->sglen == 0)
1639 break;
1640 dev_dbg (&intf->dev,
1641 "TEST 5: write %d sglists %d entries of %d bytes\n",
1642 param->iterations,
1643 param->sglen, param->length);
1644 sg = alloc_sglist (param->sglen, param->length, 0);
1645 if (!sg) {
1646 retval = -ENOMEM;
1647 break;
1649 // FIRMWARE: bulk sink (maybe accepts short writes)
1650 retval = perform_sglist (udev, param->iterations, dev->out_pipe,
1651 &req, sg, param->sglen);
1652 free_sglist (sg, param->sglen);
1653 break;
1655 case 6:
1656 if (dev->in_pipe == 0 || param->sglen == 0)
1657 break;
1658 dev_dbg (&intf->dev,
1659 "TEST 6: read %d sglists %d entries of %d bytes\n",
1660 param->iterations,
1661 param->sglen, param->length);
1662 sg = alloc_sglist (param->sglen, param->length, 0);
1663 if (!sg) {
1664 retval = -ENOMEM;
1665 break;
1667 // FIRMWARE: bulk source (maybe generates short writes)
1668 retval = perform_sglist (udev, param->iterations, dev->in_pipe,
1669 &req, sg, param->sglen);
1670 free_sglist (sg, param->sglen);
1671 break;
1672 case 7:
1673 if (dev->out_pipe == 0 || param->sglen == 0 || param->vary == 0)
1674 break;
1675 dev_dbg (&intf->dev,
1676 "TEST 7: write/%d %d sglists %d entries 0..%d bytes\n",
1677 param->vary, param->iterations,
1678 param->sglen, param->length);
1679 sg = alloc_sglist (param->sglen, param->length, param->vary);
1680 if (!sg) {
1681 retval = -ENOMEM;
1682 break;
1684 // FIRMWARE: bulk sink (maybe accepts short writes)
1685 retval = perform_sglist (udev, param->iterations, dev->out_pipe,
1686 &req, sg, param->sglen);
1687 free_sglist (sg, param->sglen);
1688 break;
1689 case 8:
1690 if (dev->in_pipe == 0 || param->sglen == 0 || param->vary == 0)
1691 break;
1692 dev_dbg (&intf->dev,
1693 "TEST 8: read/%d %d sglists %d entries 0..%d bytes\n",
1694 param->vary, param->iterations,
1695 param->sglen, param->length);
1696 sg = alloc_sglist (param->sglen, param->length, param->vary);
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;
1707 /* non-queued sanity tests for control (chapter 9 subset) */
1708 case 9:
1709 retval = 0;
1710 dev_dbg (&intf->dev,
1711 "TEST 9: ch9 (subset) control tests, %d times\n",
1712 param->iterations);
1713 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1714 retval = ch9_postconfig (dev);
1715 if (retval)
1716 dbg ("ch9 subset failed, iterations left %d", i);
1717 break;
1719 /* queued control messaging */
1720 case 10:
1721 if (param->sglen == 0)
1722 break;
1723 retval = 0;
1724 dev_dbg (&intf->dev,
1725 "TEST 10: queue %d control calls, %d times\n",
1726 param->sglen,
1727 param->iterations);
1728 retval = test_ctrl_queue (dev, param);
1729 break;
1731 /* simple non-queued unlinks (ring with one urb) */
1732 case 11:
1733 if (dev->in_pipe == 0 || !param->length)
1734 break;
1735 retval = 0;
1736 dev_dbg (&intf->dev, "TEST 11: unlink %d reads of %d\n",
1737 param->iterations, param->length);
1738 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1739 retval = unlink_simple (dev, dev->in_pipe,
1740 param->length);
1741 if (retval)
1742 dev_dbg (&intf->dev, "unlink reads failed %d, "
1743 "iterations left %d\n", retval, i);
1744 break;
1745 case 12:
1746 if (dev->out_pipe == 0 || !param->length)
1747 break;
1748 retval = 0;
1749 dev_dbg (&intf->dev, "TEST 12: unlink %d writes of %d\n",
1750 param->iterations, param->length);
1751 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1752 retval = unlink_simple (dev, dev->out_pipe,
1753 param->length);
1754 if (retval)
1755 dev_dbg (&intf->dev, "unlink writes failed %d, "
1756 "iterations left %d\n", retval, i);
1757 break;
1759 /* ep halt tests */
1760 case 13:
1761 if (dev->out_pipe == 0 && dev->in_pipe == 0)
1762 break;
1763 retval = 0;
1764 dev_dbg (&intf->dev, "TEST 13: set/clear %d halts\n",
1765 param->iterations);
1766 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1767 retval = halt_simple (dev);
1769 if (retval)
1770 DBG (dev, "halts failed, iterations left %d\n", i);
1771 break;
1773 /* control write tests */
1774 case 14:
1775 if (!dev->info->ctrl_out)
1776 break;
1777 dev_dbg (&intf->dev, "TEST 14: %d ep0out, %d..%d vary %d\n",
1778 param->iterations,
1779 realworld ? 1 : 0, param->length,
1780 param->vary);
1781 retval = ctrl_out (dev, param->iterations,
1782 param->length, param->vary);
1783 break;
1785 /* iso write tests */
1786 case 15:
1787 if (dev->out_iso_pipe == 0 || param->sglen == 0)
1788 break;
1789 dev_dbg (&intf->dev,
1790 "TEST 15: write %d iso, %d entries of %d bytes\n",
1791 param->iterations,
1792 param->sglen, param->length);
1793 // FIRMWARE: iso sink
1794 retval = test_iso_queue (dev, param,
1795 dev->out_iso_pipe, dev->iso_out);
1796 break;
1798 /* iso read tests */
1799 case 16:
1800 if (dev->in_iso_pipe == 0 || param->sglen == 0)
1801 break;
1802 dev_dbg (&intf->dev,
1803 "TEST 16: read %d iso, %d entries of %d bytes\n",
1804 param->iterations,
1805 param->sglen, param->length);
1806 // FIRMWARE: iso source
1807 retval = test_iso_queue (dev, param,
1808 dev->in_iso_pipe, dev->iso_in);
1809 break;
1811 // FIXME unlink from queue (ring with N urbs)
1813 // FIXME scatterlist cancel (needs helper thread)
1816 do_gettimeofday (&param->duration);
1817 param->duration.tv_sec -= start.tv_sec;
1818 param->duration.tv_usec -= start.tv_usec;
1819 if (param->duration.tv_usec < 0) {
1820 param->duration.tv_usec += 1000 * 1000;
1821 param->duration.tv_sec -= 1;
1823 up (&dev->sem);
1824 return retval;
1827 /*-------------------------------------------------------------------------*/
1829 static unsigned force_interrupt = 0;
1830 module_param (force_interrupt, uint, 0);
1831 MODULE_PARM_DESC (force_interrupt, "0 = test default; else interrupt");
1833 #ifdef GENERIC
1834 static unsigned short vendor;
1835 module_param(vendor, ushort, 0);
1836 MODULE_PARM_DESC (vendor, "vendor code (from usb-if)");
1838 static unsigned short product;
1839 module_param(product, ushort, 0);
1840 MODULE_PARM_DESC (product, "product code (from vendor)");
1841 #endif
1843 static int
1844 usbtest_probe (struct usb_interface *intf, const struct usb_device_id *id)
1846 struct usb_device *udev;
1847 struct usbtest_dev *dev;
1848 struct usbtest_info *info;
1849 char *rtest, *wtest;
1850 char *irtest, *iwtest;
1852 udev = interface_to_usbdev (intf);
1854 #ifdef GENERIC
1855 /* specify devices by module parameters? */
1856 if (id->match_flags == 0) {
1857 /* vendor match required, product match optional */
1858 if (!vendor || le16_to_cpu(udev->descriptor.idVendor) != (u16)vendor)
1859 return -ENODEV;
1860 if (product && le16_to_cpu(udev->descriptor.idProduct) != (u16)product)
1861 return -ENODEV;
1862 dbg ("matched module params, vend=0x%04x prod=0x%04x",
1863 le16_to_cpu(udev->descriptor.idVendor),
1864 le16_to_cpu(udev->descriptor.idProduct));
1866 #endif
1868 dev = kmalloc (sizeof *dev, SLAB_KERNEL);
1869 if (!dev)
1870 return -ENOMEM;
1871 memset (dev, 0, sizeof *dev);
1872 info = (struct usbtest_info *) id->driver_info;
1873 dev->info = info;
1874 init_MUTEX (&dev->sem);
1876 dev->intf = intf;
1878 /* cacheline-aligned scratch for i/o */
1879 if ((dev->buf = kmalloc (TBUF_SIZE, SLAB_KERNEL)) == NULL) {
1880 kfree (dev);
1881 return -ENOMEM;
1884 /* NOTE this doesn't yet test the handful of difference that are
1885 * visible with high speed interrupts: bigger maxpacket (1K) and
1886 * "high bandwidth" modes (up to 3 packets/uframe).
1888 rtest = wtest = "";
1889 irtest = iwtest = "";
1890 if (force_interrupt || udev->speed == USB_SPEED_LOW) {
1891 if (info->ep_in) {
1892 dev->in_pipe = usb_rcvintpipe (udev, info->ep_in);
1893 rtest = " intr-in";
1895 if (info->ep_out) {
1896 dev->out_pipe = usb_sndintpipe (udev, info->ep_out);
1897 wtest = " intr-out";
1899 } else {
1900 if (info->autoconf) {
1901 int status;
1903 status = get_endpoints (dev, intf);
1904 if (status < 0) {
1905 dbg ("couldn't get endpoints, %d\n", status);
1906 return status;
1908 /* may find bulk or ISO pipes */
1909 } else {
1910 if (info->ep_in)
1911 dev->in_pipe = usb_rcvbulkpipe (udev,
1912 info->ep_in);
1913 if (info->ep_out)
1914 dev->out_pipe = usb_sndbulkpipe (udev,
1915 info->ep_out);
1917 if (dev->in_pipe)
1918 rtest = " bulk-in";
1919 if (dev->out_pipe)
1920 wtest = " bulk-out";
1921 if (dev->in_iso_pipe)
1922 irtest = " iso-in";
1923 if (dev->out_iso_pipe)
1924 iwtest = " iso-out";
1927 usb_set_intfdata (intf, dev);
1928 dev_info (&intf->dev, "%s\n", info->name);
1929 dev_info (&intf->dev, "%s speed {control%s%s%s%s%s} tests%s\n",
1930 ({ char *tmp;
1931 switch (udev->speed) {
1932 case USB_SPEED_LOW: tmp = "low"; break;
1933 case USB_SPEED_FULL: tmp = "full"; break;
1934 case USB_SPEED_HIGH: tmp = "high"; break;
1935 default: tmp = "unknown"; break;
1936 }; tmp; }),
1937 info->ctrl_out ? " in/out" : "",
1938 rtest, wtest,
1939 irtest, iwtest,
1940 info->alt >= 0 ? " (+alt)" : "");
1941 return 0;
1944 static int usbtest_suspend (struct usb_interface *intf, pm_message_t message)
1946 return 0;
1949 static int usbtest_resume (struct usb_interface *intf)
1951 return 0;
1955 static void usbtest_disconnect (struct usb_interface *intf)
1957 struct usbtest_dev *dev = usb_get_intfdata (intf);
1959 down (&dev->sem);
1961 usb_set_intfdata (intf, NULL);
1962 dev_dbg (&intf->dev, "disconnect\n");
1963 kfree (dev);
1966 /* Basic testing only needs a device that can source or sink bulk traffic.
1967 * Any device can test control transfers (default with GENERIC binding).
1969 * Several entries work with the default EP0 implementation that's built
1970 * into EZ-USB chips. There's a default vendor ID which can be overridden
1971 * by (very) small config EEPROMS, but otherwise all these devices act
1972 * identically until firmware is loaded: only EP0 works. It turns out
1973 * to be easy to make other endpoints work, without modifying that EP0
1974 * behavior. For now, we expect that kind of firmware.
1977 /* an21xx or fx versions of ez-usb */
1978 static struct usbtest_info ez1_info = {
1979 .name = "EZ-USB device",
1980 .ep_in = 2,
1981 .ep_out = 2,
1982 .alt = 1,
1985 /* fx2 version of ez-usb */
1986 static struct usbtest_info ez2_info = {
1987 .name = "FX2 device",
1988 .ep_in = 6,
1989 .ep_out = 2,
1990 .alt = 1,
1993 /* ezusb family device with dedicated usb test firmware,
1995 static struct usbtest_info fw_info = {
1996 .name = "usb test device",
1997 .ep_in = 2,
1998 .ep_out = 2,
1999 .alt = 1,
2000 .autoconf = 1, // iso and ctrl_out need autoconf
2001 .ctrl_out = 1,
2002 .iso = 1, // iso_ep's are #8 in/out
2005 /* peripheral running Linux and 'zero.c' test firmware, or
2006 * its user-mode cousin. different versions of this use
2007 * different hardware with the same vendor/product codes.
2008 * host side MUST rely on the endpoint descriptors.
2010 static struct usbtest_info gz_info = {
2011 .name = "Linux gadget zero",
2012 .autoconf = 1,
2013 .ctrl_out = 1,
2014 .alt = 0,
2017 static struct usbtest_info um_info = {
2018 .name = "Linux user mode test driver",
2019 .autoconf = 1,
2020 .alt = -1,
2023 static struct usbtest_info um2_info = {
2024 .name = "Linux user mode ISO test driver",
2025 .autoconf = 1,
2026 .iso = 1,
2027 .alt = -1,
2030 #ifdef IBOT2
2031 /* this is a nice source of high speed bulk data;
2032 * uses an FX2, with firmware provided in the device
2034 static struct usbtest_info ibot2_info = {
2035 .name = "iBOT2 webcam",
2036 .ep_in = 2,
2037 .alt = -1,
2039 #endif
2041 #ifdef GENERIC
2042 /* we can use any device to test control traffic */
2043 static struct usbtest_info generic_info = {
2044 .name = "Generic USB device",
2045 .alt = -1,
2047 #endif
2049 // FIXME remove this
2050 static struct usbtest_info hact_info = {
2051 .name = "FX2/hact",
2052 //.ep_in = 6,
2053 .ep_out = 2,
2054 .alt = -1,
2058 static struct usb_device_id id_table [] = {
2060 { USB_DEVICE (0x0547, 0x1002),
2061 .driver_info = (unsigned long) &hact_info,
2064 /*-------------------------------------------------------------*/
2066 /* EZ-USB devices which download firmware to replace (or in our
2067 * case augment) the default device implementation.
2070 /* generic EZ-USB FX controller */
2071 { USB_DEVICE (0x0547, 0x2235),
2072 .driver_info = (unsigned long) &ez1_info,
2075 /* CY3671 development board with EZ-USB FX */
2076 { USB_DEVICE (0x0547, 0x0080),
2077 .driver_info = (unsigned long) &ez1_info,
2080 /* generic EZ-USB FX2 controller (or development board) */
2081 { USB_DEVICE (0x04b4, 0x8613),
2082 .driver_info = (unsigned long) &ez2_info,
2085 /* re-enumerated usb test device firmware */
2086 { USB_DEVICE (0xfff0, 0xfff0),
2087 .driver_info = (unsigned long) &fw_info,
2090 /* "Gadget Zero" firmware runs under Linux */
2091 { USB_DEVICE (0x0525, 0xa4a0),
2092 .driver_info = (unsigned long) &gz_info,
2095 /* so does a user-mode variant */
2096 { USB_DEVICE (0x0525, 0xa4a4),
2097 .driver_info = (unsigned long) &um_info,
2100 /* ... and a user-mode variant that talks iso */
2101 { USB_DEVICE (0x0525, 0xa4a3),
2102 .driver_info = (unsigned long) &um2_info,
2105 #ifdef KEYSPAN_19Qi
2106 /* Keyspan 19qi uses an21xx (original EZ-USB) */
2107 // this does not coexist with the real Keyspan 19qi driver!
2108 { USB_DEVICE (0x06cd, 0x010b),
2109 .driver_info = (unsigned long) &ez1_info,
2111 #endif
2113 /*-------------------------------------------------------------*/
2115 #ifdef IBOT2
2116 /* iBOT2 makes a nice source of high speed bulk-in data */
2117 // this does not coexist with a real iBOT2 driver!
2118 { USB_DEVICE (0x0b62, 0x0059),
2119 .driver_info = (unsigned long) &ibot2_info,
2121 #endif
2123 /*-------------------------------------------------------------*/
2125 #ifdef GENERIC
2126 /* module params can specify devices to use for control tests */
2127 { .driver_info = (unsigned long) &generic_info, },
2128 #endif
2130 /*-------------------------------------------------------------*/
2134 MODULE_DEVICE_TABLE (usb, id_table);
2136 static struct usb_driver usbtest_driver = {
2137 .owner = THIS_MODULE,
2138 .name = "usbtest",
2139 .id_table = id_table,
2140 .probe = usbtest_probe,
2141 .ioctl = usbtest_ioctl,
2142 .disconnect = usbtest_disconnect,
2143 .suspend = usbtest_suspend,
2144 .resume = usbtest_resume,
2147 /*-------------------------------------------------------------------------*/
2149 static int __init usbtest_init (void)
2151 #ifdef GENERIC
2152 if (vendor)
2153 dbg ("params: vend=0x%04x prod=0x%04x", vendor, product);
2154 #endif
2155 return usb_register (&usbtest_driver);
2157 module_init (usbtest_init);
2159 static void __exit usbtest_exit (void)
2161 usb_deregister (&usbtest_driver);
2163 module_exit (usbtest_exit);
2165 MODULE_DESCRIPTION ("USB Core/HCD Testing Driver");
2166 MODULE_LICENSE ("GPL");