USB: usbtest: avoid to free coherent buffer in atomic context
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / usb / misc / usbtest.c
blobd92b7ec9a230d370e1f74e470f3669ea1364ff72
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_alloc_coherent (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 static unsigned mod_pattern;
217 module_param_named(pattern, mod_pattern, uint, S_IRUGO | S_IWUSR);
218 MODULE_PARM_DESC(mod_pattern, "i/o pattern (0 == zeroes)");
220 static inline void simple_fill_buf (struct urb *urb)
222 unsigned i;
223 u8 *buf = urb->transfer_buffer;
224 unsigned len = urb->transfer_buffer_length;
226 switch (pattern) {
227 default:
228 // FALLTHROUGH
229 case 0:
230 memset (buf, 0, len);
231 break;
232 case 1: /* mod63 */
233 for (i = 0; i < len; i++)
234 *buf++ = (u8) (i % 63);
235 break;
239 static inline int simple_check_buf(struct usbtest_dev *tdev, struct urb *urb)
241 unsigned i;
242 u8 expected;
243 u8 *buf = urb->transfer_buffer;
244 unsigned len = urb->actual_length;
246 for (i = 0; i < len; i++, buf++) {
247 switch (pattern) {
248 /* all-zeroes has no synchronization issues */
249 case 0:
250 expected = 0;
251 break;
252 /* mod63 stays in sync with short-terminated transfers,
253 * or otherwise when host and gadget agree on how large
254 * each usb transfer request should be. resync is done
255 * with set_interface or set_config.
257 case 1: /* mod63 */
258 expected = i % 63;
259 break;
260 /* always fail unsupported patterns */
261 default:
262 expected = !*buf;
263 break;
265 if (*buf == expected)
266 continue;
267 ERROR(tdev, "buf[%d] = %d (not %d)\n", i, *buf, expected);
268 return -EINVAL;
270 return 0;
273 static void simple_free_urb (struct urb *urb)
275 usb_free_coherent(urb->dev, urb->transfer_buffer_length,
276 urb->transfer_buffer, urb->transfer_dma);
277 usb_free_urb (urb);
280 static int simple_io (
281 struct usbtest_dev *tdev,
282 struct urb *urb,
283 int iterations,
284 int vary,
285 int expected,
286 const char *label
289 struct usb_device *udev = urb->dev;
290 int max = urb->transfer_buffer_length;
291 struct completion completion;
292 int retval = 0;
294 urb->context = &completion;
295 while (retval == 0 && iterations-- > 0) {
296 init_completion (&completion);
297 if (usb_pipeout (urb->pipe))
298 simple_fill_buf (urb);
299 if ((retval = usb_submit_urb (urb, GFP_KERNEL)) != 0)
300 break;
302 /* NOTE: no timeouts; can't be broken out of by interrupt */
303 wait_for_completion (&completion);
304 retval = urb->status;
305 urb->dev = udev;
306 if (retval == 0 && usb_pipein (urb->pipe))
307 retval = simple_check_buf(tdev, urb);
309 if (vary) {
310 int len = urb->transfer_buffer_length;
312 len += vary;
313 len %= max;
314 if (len == 0)
315 len = (vary < max) ? vary : max;
316 urb->transfer_buffer_length = len;
319 /* FIXME if endpoint halted, clear halt (and log) */
321 urb->transfer_buffer_length = max;
323 if (expected != retval)
324 dev_err(&udev->dev,
325 "%s failed, iterations left %d, status %d (not %d)\n",
326 label, iterations, retval, expected);
327 return retval;
331 /*-------------------------------------------------------------------------*/
333 /* We use scatterlist primitives to test queued I/O.
334 * Yes, this also tests the scatterlist primitives.
337 static void free_sglist (struct scatterlist *sg, int nents)
339 unsigned i;
341 if (!sg)
342 return;
343 for (i = 0; i < nents; i++) {
344 if (!sg_page(&sg[i]))
345 continue;
346 kfree (sg_virt(&sg[i]));
348 kfree (sg);
351 static struct scatterlist *
352 alloc_sglist (int nents, int max, int vary)
354 struct scatterlist *sg;
355 unsigned i;
356 unsigned size = max;
358 sg = kmalloc (nents * sizeof *sg, GFP_KERNEL);
359 if (!sg)
360 return NULL;
361 sg_init_table(sg, nents);
363 for (i = 0; i < nents; i++) {
364 char *buf;
365 unsigned j;
367 buf = kzalloc (size, GFP_KERNEL);
368 if (!buf) {
369 free_sglist (sg, i);
370 return NULL;
373 /* kmalloc pages are always physically contiguous! */
374 sg_set_buf(&sg[i], buf, size);
376 switch (pattern) {
377 case 0:
378 /* already zeroed */
379 break;
380 case 1:
381 for (j = 0; j < size; j++)
382 *buf++ = (u8) (j % 63);
383 break;
386 if (vary) {
387 size += vary;
388 size %= max;
389 if (size == 0)
390 size = (vary < max) ? vary : max;
394 return sg;
397 static int perform_sglist (
398 struct usbtest_dev *tdev,
399 unsigned iterations,
400 int pipe,
401 struct usb_sg_request *req,
402 struct scatterlist *sg,
403 int nents
406 struct usb_device *udev = testdev_to_usbdev(tdev);
407 int retval = 0;
409 while (retval == 0 && iterations-- > 0) {
410 retval = usb_sg_init (req, udev, pipe,
411 (udev->speed == USB_SPEED_HIGH)
412 ? (INTERRUPT_RATE << 3)
413 : INTERRUPT_RATE,
414 sg, nents, 0, GFP_KERNEL);
416 if (retval)
417 break;
418 usb_sg_wait (req);
419 retval = req->status;
421 /* FIXME check resulting data pattern */
423 /* FIXME if endpoint halted, clear halt (and log) */
426 // FIXME for unlink or fault handling tests, don't report
427 // failure if retval is as we expected ...
429 if (retval)
430 ERROR(tdev, "perform_sglist failed, "
431 "iterations left %d, status %d\n",
432 iterations, retval);
433 return retval;
437 /*-------------------------------------------------------------------------*/
439 /* unqueued control message testing
441 * there's a nice set of device functional requirements in chapter 9 of the
442 * usb 2.0 spec, which we can apply to ANY device, even ones that don't use
443 * special test firmware.
445 * we know the device is configured (or suspended) by the time it's visible
446 * through usbfs. we can't change that, so we won't test enumeration (which
447 * worked 'well enough' to get here, this time), power management (ditto),
448 * or remote wakeup (which needs human interaction).
451 static unsigned realworld = 1;
452 module_param (realworld, uint, 0);
453 MODULE_PARM_DESC (realworld, "clear to demand stricter spec compliance");
455 static int get_altsetting (struct usbtest_dev *dev)
457 struct usb_interface *iface = dev->intf;
458 struct usb_device *udev = interface_to_usbdev (iface);
459 int retval;
461 retval = usb_control_msg (udev, usb_rcvctrlpipe (udev, 0),
462 USB_REQ_GET_INTERFACE, USB_DIR_IN|USB_RECIP_INTERFACE,
463 0, iface->altsetting [0].desc.bInterfaceNumber,
464 dev->buf, 1, USB_CTRL_GET_TIMEOUT);
465 switch (retval) {
466 case 1:
467 return dev->buf [0];
468 case 0:
469 retval = -ERANGE;
470 // FALLTHROUGH
471 default:
472 return retval;
476 static int set_altsetting (struct usbtest_dev *dev, int alternate)
478 struct usb_interface *iface = dev->intf;
479 struct usb_device *udev;
481 if (alternate < 0 || alternate >= 256)
482 return -EINVAL;
484 udev = interface_to_usbdev (iface);
485 return usb_set_interface (udev,
486 iface->altsetting [0].desc.bInterfaceNumber,
487 alternate);
490 static int is_good_config(struct usbtest_dev *tdev, int len)
492 struct usb_config_descriptor *config;
494 if (len < sizeof *config)
495 return 0;
496 config = (struct usb_config_descriptor *) tdev->buf;
498 switch (config->bDescriptorType) {
499 case USB_DT_CONFIG:
500 case USB_DT_OTHER_SPEED_CONFIG:
501 if (config->bLength != 9) {
502 ERROR(tdev, "bogus config descriptor length\n");
503 return 0;
505 /* this bit 'must be 1' but often isn't */
506 if (!realworld && !(config->bmAttributes & 0x80)) {
507 ERROR(tdev, "high bit of config attributes not set\n");
508 return 0;
510 if (config->bmAttributes & 0x1f) { /* reserved == 0 */
511 ERROR(tdev, "reserved config bits set\n");
512 return 0;
514 break;
515 default:
516 return 0;
519 if (le16_to_cpu(config->wTotalLength) == len) /* read it all */
520 return 1;
521 if (le16_to_cpu(config->wTotalLength) >= TBUF_SIZE) /* max partial read */
522 return 1;
523 ERROR(tdev, "bogus config descriptor read size\n");
524 return 0;
527 /* sanity test for standard requests working with usb_control_mesg() and some
528 * of the utility functions which use it.
530 * this doesn't test how endpoint halts behave or data toggles get set, since
531 * we won't do I/O to bulk/interrupt endpoints here (which is how to change
532 * halt or toggle). toggle testing is impractical without support from hcds.
534 * this avoids failing devices linux would normally work with, by not testing
535 * config/altsetting operations for devices that only support their defaults.
536 * such devices rarely support those needless operations.
538 * NOTE that since this is a sanity test, it's not examining boundary cases
539 * to see if usbcore, hcd, and device all behave right. such testing would
540 * involve varied read sizes and other operation sequences.
542 static int ch9_postconfig (struct usbtest_dev *dev)
544 struct usb_interface *iface = dev->intf;
545 struct usb_device *udev = interface_to_usbdev (iface);
546 int i, alt, retval;
548 /* [9.2.3] if there's more than one altsetting, we need to be able to
549 * set and get each one. mostly trusts the descriptors from usbcore.
551 for (i = 0; i < iface->num_altsetting; i++) {
553 /* 9.2.3 constrains the range here */
554 alt = iface->altsetting [i].desc.bAlternateSetting;
555 if (alt < 0 || alt >= iface->num_altsetting) {
556 dev_err(&iface->dev,
557 "invalid alt [%d].bAltSetting = %d\n",
558 i, alt);
561 /* [real world] get/set unimplemented if there's only one */
562 if (realworld && iface->num_altsetting == 1)
563 continue;
565 /* [9.4.10] set_interface */
566 retval = set_altsetting (dev, alt);
567 if (retval) {
568 dev_err(&iface->dev, "can't set_interface = %d, %d\n",
569 alt, retval);
570 return retval;
573 /* [9.4.4] get_interface always works */
574 retval = get_altsetting (dev);
575 if (retval != alt) {
576 dev_err(&iface->dev, "get alt should be %d, was %d\n",
577 alt, retval);
578 return (retval < 0) ? retval : -EDOM;
583 /* [real world] get_config unimplemented if there's only one */
584 if (!realworld || udev->descriptor.bNumConfigurations != 1) {
585 int expected = udev->actconfig->desc.bConfigurationValue;
587 /* [9.4.2] get_configuration always works
588 * ... although some cheap devices (like one TI Hub I've got)
589 * won't return config descriptors except before set_config.
591 retval = usb_control_msg (udev, usb_rcvctrlpipe (udev, 0),
592 USB_REQ_GET_CONFIGURATION,
593 USB_DIR_IN | USB_RECIP_DEVICE,
594 0, 0, dev->buf, 1, USB_CTRL_GET_TIMEOUT);
595 if (retval != 1 || dev->buf [0] != expected) {
596 dev_err(&iface->dev, "get config --> %d %d (1 %d)\n",
597 retval, dev->buf[0], expected);
598 return (retval < 0) ? retval : -EDOM;
602 /* there's always [9.4.3] a device descriptor [9.6.1] */
603 retval = usb_get_descriptor (udev, USB_DT_DEVICE, 0,
604 dev->buf, sizeof udev->descriptor);
605 if (retval != sizeof udev->descriptor) {
606 dev_err(&iface->dev, "dev descriptor --> %d\n", retval);
607 return (retval < 0) ? retval : -EDOM;
610 /* there's always [9.4.3] at least one config descriptor [9.6.3] */
611 for (i = 0; i < udev->descriptor.bNumConfigurations; i++) {
612 retval = usb_get_descriptor (udev, USB_DT_CONFIG, i,
613 dev->buf, TBUF_SIZE);
614 if (!is_good_config(dev, retval)) {
615 dev_err(&iface->dev,
616 "config [%d] descriptor --> %d\n",
617 i, retval);
618 return (retval < 0) ? retval : -EDOM;
621 // FIXME cross-checking udev->config[i] to make sure usbcore
622 // parsed it right (etc) would be good testing paranoia
625 /* and sometimes [9.2.6.6] speed dependent descriptors */
626 if (le16_to_cpu(udev->descriptor.bcdUSB) == 0x0200) {
627 struct usb_qualifier_descriptor *d = NULL;
629 /* device qualifier [9.6.2] */
630 retval = usb_get_descriptor (udev,
631 USB_DT_DEVICE_QUALIFIER, 0, dev->buf,
632 sizeof (struct usb_qualifier_descriptor));
633 if (retval == -EPIPE) {
634 if (udev->speed == USB_SPEED_HIGH) {
635 dev_err(&iface->dev,
636 "hs dev qualifier --> %d\n",
637 retval);
638 return (retval < 0) ? retval : -EDOM;
640 /* usb2.0 but not high-speed capable; fine */
641 } else if (retval != sizeof (struct usb_qualifier_descriptor)) {
642 dev_err(&iface->dev, "dev qualifier --> %d\n", retval);
643 return (retval < 0) ? retval : -EDOM;
644 } else
645 d = (struct usb_qualifier_descriptor *) dev->buf;
647 /* might not have [9.6.2] any other-speed configs [9.6.4] */
648 if (d) {
649 unsigned max = d->bNumConfigurations;
650 for (i = 0; i < max; i++) {
651 retval = usb_get_descriptor (udev,
652 USB_DT_OTHER_SPEED_CONFIG, i,
653 dev->buf, TBUF_SIZE);
654 if (!is_good_config(dev, retval)) {
655 dev_err(&iface->dev,
656 "other speed config --> %d\n",
657 retval);
658 return (retval < 0) ? retval : -EDOM;
663 // FIXME fetch strings from at least the device descriptor
665 /* [9.4.5] get_status always works */
666 retval = usb_get_status (udev, USB_RECIP_DEVICE, 0, dev->buf);
667 if (retval != 2) {
668 dev_err(&iface->dev, "get dev status --> %d\n", retval);
669 return (retval < 0) ? retval : -EDOM;
672 // FIXME configuration.bmAttributes says if we could try to set/clear
673 // the device's remote wakeup feature ... if we can, test that here
675 retval = usb_get_status (udev, USB_RECIP_INTERFACE,
676 iface->altsetting [0].desc.bInterfaceNumber, dev->buf);
677 if (retval != 2) {
678 dev_err(&iface->dev, "get interface status --> %d\n", retval);
679 return (retval < 0) ? retval : -EDOM;
681 // FIXME get status for each endpoint in the interface
683 return 0;
686 /*-------------------------------------------------------------------------*/
688 /* use ch9 requests to test whether:
689 * (a) queues work for control, keeping N subtests queued and
690 * active (auto-resubmit) for M loops through the queue.
691 * (b) protocol stalls (control-only) will autorecover.
692 * it's not like bulk/intr; no halt clearing.
693 * (c) short control reads are reported and handled.
694 * (d) queues are always processed in-order
697 struct ctrl_ctx {
698 spinlock_t lock;
699 struct usbtest_dev *dev;
700 struct completion complete;
701 unsigned count;
702 unsigned pending;
703 int status;
704 struct urb **urb;
705 struct usbtest_param *param;
706 int last;
709 #define NUM_SUBCASES 15 /* how many test subcases here? */
711 struct subcase {
712 struct usb_ctrlrequest setup;
713 int number;
714 int expected;
717 static void ctrl_complete (struct urb *urb)
719 struct ctrl_ctx *ctx = urb->context;
720 struct usb_ctrlrequest *reqp;
721 struct subcase *subcase;
722 int status = urb->status;
724 reqp = (struct usb_ctrlrequest *)urb->setup_packet;
725 subcase = container_of (reqp, struct subcase, setup);
727 spin_lock (&ctx->lock);
728 ctx->count--;
729 ctx->pending--;
731 /* queue must transfer and complete in fifo order, unless
732 * usb_unlink_urb() is used to unlink something not at the
733 * physical queue head (not tested).
735 if (subcase->number > 0) {
736 if ((subcase->number - ctx->last) != 1) {
737 ERROR(ctx->dev,
738 "subcase %d completed out of order, last %d\n",
739 subcase->number, ctx->last);
740 status = -EDOM;
741 ctx->last = subcase->number;
742 goto error;
745 ctx->last = subcase->number;
747 /* succeed or fault in only one way? */
748 if (status == subcase->expected)
749 status = 0;
751 /* async unlink for cleanup? */
752 else if (status != -ECONNRESET) {
754 /* some faults are allowed, not required */
755 if (subcase->expected > 0 && (
756 ((status == -subcase->expected /* happened */
757 || status == 0)))) /* didn't */
758 status = 0;
759 /* sometimes more than one fault is allowed */
760 else if (subcase->number == 12 && status == -EPIPE)
761 status = 0;
762 else
763 ERROR(ctx->dev, "subtest %d error, status %d\n",
764 subcase->number, status);
767 /* unexpected status codes mean errors; ideally, in hardware */
768 if (status) {
769 error:
770 if (ctx->status == 0) {
771 int i;
773 ctx->status = status;
774 ERROR(ctx->dev, "control queue %02x.%02x, err %d, "
775 "%d left, subcase %d, len %d/%d\n",
776 reqp->bRequestType, reqp->bRequest,
777 status, ctx->count, subcase->number,
778 urb->actual_length,
779 urb->transfer_buffer_length);
781 /* FIXME this "unlink everything" exit route should
782 * be a separate test case.
785 /* unlink whatever's still pending */
786 for (i = 1; i < ctx->param->sglen; i++) {
787 struct urb *u = ctx->urb [
788 (i + subcase->number)
789 % ctx->param->sglen];
791 if (u == urb || !u->dev)
792 continue;
793 spin_unlock(&ctx->lock);
794 status = usb_unlink_urb (u);
795 spin_lock(&ctx->lock);
796 switch (status) {
797 case -EINPROGRESS:
798 case -EBUSY:
799 case -EIDRM:
800 continue;
801 default:
802 ERROR(ctx->dev, "urb unlink --> %d\n",
803 status);
806 status = ctx->status;
810 /* resubmit if we need to, else mark this as done */
811 if ((status == 0) && (ctx->pending < ctx->count)) {
812 if ((status = usb_submit_urb (urb, GFP_ATOMIC)) != 0) {
813 ERROR(ctx->dev,
814 "can't resubmit ctrl %02x.%02x, err %d\n",
815 reqp->bRequestType, reqp->bRequest, status);
816 urb->dev = NULL;
817 } else
818 ctx->pending++;
819 } else
820 urb->dev = NULL;
822 /* signal completion when nothing's queued */
823 if (ctx->pending == 0)
824 complete (&ctx->complete);
825 spin_unlock (&ctx->lock);
828 static int
829 test_ctrl_queue (struct usbtest_dev *dev, struct usbtest_param *param)
831 struct usb_device *udev = testdev_to_usbdev (dev);
832 struct urb **urb;
833 struct ctrl_ctx context;
834 int i;
836 spin_lock_init (&context.lock);
837 context.dev = dev;
838 init_completion (&context.complete);
839 context.count = param->sglen * param->iterations;
840 context.pending = 0;
841 context.status = -ENOMEM;
842 context.param = param;
843 context.last = -1;
845 /* allocate and init the urbs we'll queue.
846 * as with bulk/intr sglists, sglen is the queue depth; it also
847 * controls which subtests run (more tests than sglen) or rerun.
849 urb = kcalloc(param->sglen, sizeof(struct urb *), GFP_KERNEL);
850 if (!urb)
851 return -ENOMEM;
852 for (i = 0; i < param->sglen; i++) {
853 int pipe = usb_rcvctrlpipe (udev, 0);
854 unsigned len;
855 struct urb *u;
856 struct usb_ctrlrequest req;
857 struct subcase *reqp;
859 /* sign of this variable means:
860 * -: tested code must return this (negative) error code
861 * +: tested code may return this (negative too) error code
863 int expected = 0;
865 /* requests here are mostly expected to succeed on any
866 * device, but some are chosen to trigger protocol stalls
867 * or short reads.
869 memset (&req, 0, sizeof req);
870 req.bRequest = USB_REQ_GET_DESCRIPTOR;
871 req.bRequestType = USB_DIR_IN|USB_RECIP_DEVICE;
873 switch (i % NUM_SUBCASES) {
874 case 0: // get device descriptor
875 req.wValue = cpu_to_le16 (USB_DT_DEVICE << 8);
876 len = sizeof (struct usb_device_descriptor);
877 break;
878 case 1: // get first config descriptor (only)
879 req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
880 len = sizeof (struct usb_config_descriptor);
881 break;
882 case 2: // get altsetting (OFTEN STALLS)
883 req.bRequest = USB_REQ_GET_INTERFACE;
884 req.bRequestType = USB_DIR_IN|USB_RECIP_INTERFACE;
885 // index = 0 means first interface
886 len = 1;
887 expected = EPIPE;
888 break;
889 case 3: // get interface status
890 req.bRequest = USB_REQ_GET_STATUS;
891 req.bRequestType = USB_DIR_IN|USB_RECIP_INTERFACE;
892 // interface 0
893 len = 2;
894 break;
895 case 4: // get device status
896 req.bRequest = USB_REQ_GET_STATUS;
897 req.bRequestType = USB_DIR_IN|USB_RECIP_DEVICE;
898 len = 2;
899 break;
900 case 5: // get device qualifier (MAY STALL)
901 req.wValue = cpu_to_le16 (USB_DT_DEVICE_QUALIFIER << 8);
902 len = sizeof (struct usb_qualifier_descriptor);
903 if (udev->speed != USB_SPEED_HIGH)
904 expected = EPIPE;
905 break;
906 case 6: // get first config descriptor, plus interface
907 req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
908 len = sizeof (struct usb_config_descriptor);
909 len += sizeof (struct usb_interface_descriptor);
910 break;
911 case 7: // get interface descriptor (ALWAYS STALLS)
912 req.wValue = cpu_to_le16 (USB_DT_INTERFACE << 8);
913 // interface == 0
914 len = sizeof (struct usb_interface_descriptor);
915 expected = -EPIPE;
916 break;
917 // NOTE: two consecutive stalls in the queue here.
918 // that tests fault recovery a bit more aggressively.
919 case 8: // clear endpoint halt (MAY STALL)
920 req.bRequest = USB_REQ_CLEAR_FEATURE;
921 req.bRequestType = USB_RECIP_ENDPOINT;
922 // wValue 0 == ep halt
923 // wIndex 0 == ep0 (shouldn't halt!)
924 len = 0;
925 pipe = usb_sndctrlpipe (udev, 0);
926 expected = EPIPE;
927 break;
928 case 9: // get endpoint status
929 req.bRequest = USB_REQ_GET_STATUS;
930 req.bRequestType = USB_DIR_IN|USB_RECIP_ENDPOINT;
931 // endpoint 0
932 len = 2;
933 break;
934 case 10: // trigger short read (EREMOTEIO)
935 req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
936 len = 1024;
937 expected = -EREMOTEIO;
938 break;
939 // NOTE: two consecutive _different_ faults in the queue.
940 case 11: // get endpoint descriptor (ALWAYS STALLS)
941 req.wValue = cpu_to_le16 (USB_DT_ENDPOINT << 8);
942 // endpoint == 0
943 len = sizeof (struct usb_interface_descriptor);
944 expected = EPIPE;
945 break;
946 // NOTE: sometimes even a third fault in the queue!
947 case 12: // get string 0 descriptor (MAY STALL)
948 req.wValue = cpu_to_le16 (USB_DT_STRING << 8);
949 // string == 0, for language IDs
950 len = sizeof (struct usb_interface_descriptor);
951 // may succeed when > 4 languages
952 expected = EREMOTEIO; // or EPIPE, if no strings
953 break;
954 case 13: // short read, resembling case 10
955 req.wValue = cpu_to_le16 ((USB_DT_CONFIG << 8) | 0);
956 // last data packet "should" be DATA1, not DATA0
957 len = 1024 - udev->descriptor.bMaxPacketSize0;
958 expected = -EREMOTEIO;
959 break;
960 case 14: // short read; try to fill the last packet
961 req.wValue = cpu_to_le16 ((USB_DT_DEVICE << 8) | 0);
962 /* device descriptor size == 18 bytes */
963 len = udev->descriptor.bMaxPacketSize0;
964 switch (len) {
965 case 8: len = 24; break;
966 case 16: len = 32; break;
968 expected = -EREMOTEIO;
969 break;
970 default:
971 ERROR(dev, "bogus number of ctrl queue testcases!\n");
972 context.status = -EINVAL;
973 goto cleanup;
975 req.wLength = cpu_to_le16 (len);
976 urb [i] = u = simple_alloc_urb (udev, pipe, len);
977 if (!u)
978 goto cleanup;
980 reqp = kmalloc(sizeof *reqp, GFP_KERNEL);
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;
988 u->context = &context;
989 u->complete = ctrl_complete;
992 /* queue the urbs */
993 context.urb = urb;
994 spin_lock_irq (&context.lock);
995 for (i = 0; i < param->sglen; i++) {
996 context.status = usb_submit_urb (urb [i], GFP_ATOMIC);
997 if (context.status != 0) {
998 ERROR(dev, "can't submit urb[%d], status %d\n",
999 i, context.status);
1000 context.count = context.pending;
1001 break;
1003 context.pending++;
1005 spin_unlock_irq (&context.lock);
1007 /* FIXME set timer and time out; provide a disconnect hook */
1009 /* wait for the last one to complete */
1010 if (context.pending > 0)
1011 wait_for_completion (&context.complete);
1013 cleanup:
1014 for (i = 0; i < param->sglen; i++) {
1015 if (!urb [i])
1016 continue;
1017 urb [i]->dev = udev;
1018 kfree(urb[i]->setup_packet);
1019 simple_free_urb (urb [i]);
1021 kfree (urb);
1022 return context.status;
1024 #undef NUM_SUBCASES
1027 /*-------------------------------------------------------------------------*/
1029 static void unlink1_callback (struct urb *urb)
1031 int status = urb->status;
1033 // we "know" -EPIPE (stall) never happens
1034 if (!status)
1035 status = usb_submit_urb (urb, GFP_ATOMIC);
1036 if (status) {
1037 urb->status = status;
1038 complete(urb->context);
1042 static int unlink1 (struct usbtest_dev *dev, int pipe, int size, int async)
1044 struct urb *urb;
1045 struct completion completion;
1046 int retval = 0;
1048 init_completion (&completion);
1049 urb = simple_alloc_urb (testdev_to_usbdev (dev), pipe, size);
1050 if (!urb)
1051 return -ENOMEM;
1052 urb->context = &completion;
1053 urb->complete = unlink1_callback;
1055 /* keep the endpoint busy. there are lots of hc/hcd-internal
1056 * states, and testing should get to all of them over time.
1058 * FIXME want additional tests for when endpoint is STALLing
1059 * due to errors, or is just NAKing requests.
1061 if ((retval = usb_submit_urb (urb, GFP_KERNEL)) != 0) {
1062 dev_err(&dev->intf->dev, "submit fail %d\n", retval);
1063 return retval;
1066 /* unlinking that should always work. variable delay tests more
1067 * hcd states and code paths, even with little other system load.
1069 msleep (jiffies % (2 * INTERRUPT_RATE));
1070 if (async) {
1071 while (!completion_done(&completion)) {
1072 retval = usb_unlink_urb(urb);
1074 switch (retval) {
1075 case -EBUSY:
1076 case -EIDRM:
1077 /* we can't unlink urbs while they're completing
1078 * or if they've completed, and we haven't
1079 * resubmitted. "normal" drivers would prevent
1080 * resubmission, but since we're testing unlink
1081 * paths, we can't.
1083 ERROR(dev, "unlink retry\n");
1084 continue;
1085 case 0:
1086 case -EINPROGRESS:
1087 break;
1089 default:
1090 dev_err(&dev->intf->dev,
1091 "unlink fail %d\n", retval);
1092 return retval;
1095 break;
1097 } else
1098 usb_kill_urb (urb);
1100 wait_for_completion (&completion);
1101 retval = urb->status;
1102 simple_free_urb (urb);
1104 if (async)
1105 return (retval == -ECONNRESET) ? 0 : retval - 1000;
1106 else
1107 return (retval == -ENOENT || retval == -EPERM) ?
1108 0 : retval - 2000;
1111 static int unlink_simple (struct usbtest_dev *dev, int pipe, int len)
1113 int retval = 0;
1115 /* test sync and async paths */
1116 retval = unlink1 (dev, pipe, len, 1);
1117 if (!retval)
1118 retval = unlink1 (dev, pipe, len, 0);
1119 return retval;
1122 /*-------------------------------------------------------------------------*/
1124 static int verify_not_halted(struct usbtest_dev *tdev, int ep, struct urb *urb)
1126 int retval;
1127 u16 status;
1129 /* shouldn't look or act halted */
1130 retval = usb_get_status (urb->dev, USB_RECIP_ENDPOINT, ep, &status);
1131 if (retval < 0) {
1132 ERROR(tdev, "ep %02x couldn't get no-halt status, %d\n",
1133 ep, retval);
1134 return retval;
1136 if (status != 0) {
1137 ERROR(tdev, "ep %02x bogus status: %04x != 0\n", ep, status);
1138 return -EINVAL;
1140 retval = simple_io(tdev, urb, 1, 0, 0, __func__);
1141 if (retval != 0)
1142 return -EINVAL;
1143 return 0;
1146 static int verify_halted(struct usbtest_dev *tdev, int ep, struct urb *urb)
1148 int retval;
1149 u16 status;
1151 /* should look and act halted */
1152 retval = usb_get_status (urb->dev, USB_RECIP_ENDPOINT, ep, &status);
1153 if (retval < 0) {
1154 ERROR(tdev, "ep %02x couldn't get halt status, %d\n",
1155 ep, retval);
1156 return retval;
1158 le16_to_cpus(&status);
1159 if (status != 1) {
1160 ERROR(tdev, "ep %02x bogus status: %04x != 1\n", ep, status);
1161 return -EINVAL;
1163 retval = simple_io(tdev, urb, 1, 0, -EPIPE, __func__);
1164 if (retval != -EPIPE)
1165 return -EINVAL;
1166 retval = simple_io(tdev, urb, 1, 0, -EPIPE, "verify_still_halted");
1167 if (retval != -EPIPE)
1168 return -EINVAL;
1169 return 0;
1172 static int test_halt(struct usbtest_dev *tdev, int ep, struct urb *urb)
1174 int retval;
1176 /* shouldn't look or act halted now */
1177 retval = verify_not_halted(tdev, ep, urb);
1178 if (retval < 0)
1179 return retval;
1181 /* set halt (protocol test only), verify it worked */
1182 retval = usb_control_msg (urb->dev, usb_sndctrlpipe (urb->dev, 0),
1183 USB_REQ_SET_FEATURE, USB_RECIP_ENDPOINT,
1184 USB_ENDPOINT_HALT, ep,
1185 NULL, 0, USB_CTRL_SET_TIMEOUT);
1186 if (retval < 0) {
1187 ERROR(tdev, "ep %02x couldn't set halt, %d\n", ep, retval);
1188 return retval;
1190 retval = verify_halted(tdev, ep, urb);
1191 if (retval < 0)
1192 return retval;
1194 /* clear halt (tests API + protocol), verify it worked */
1195 retval = usb_clear_halt (urb->dev, urb->pipe);
1196 if (retval < 0) {
1197 ERROR(tdev, "ep %02x couldn't clear halt, %d\n", ep, retval);
1198 return retval;
1200 retval = verify_not_halted(tdev, ep, urb);
1201 if (retval < 0)
1202 return retval;
1204 /* NOTE: could also verify SET_INTERFACE clear halts ... */
1206 return 0;
1209 static int halt_simple (struct usbtest_dev *dev)
1211 int ep;
1212 int retval = 0;
1213 struct urb *urb;
1215 urb = simple_alloc_urb (testdev_to_usbdev (dev), 0, 512);
1216 if (urb == NULL)
1217 return -ENOMEM;
1219 if (dev->in_pipe) {
1220 ep = usb_pipeendpoint (dev->in_pipe) | USB_DIR_IN;
1221 urb->pipe = dev->in_pipe;
1222 retval = test_halt(dev, ep, urb);
1223 if (retval < 0)
1224 goto done;
1227 if (dev->out_pipe) {
1228 ep = usb_pipeendpoint (dev->out_pipe);
1229 urb->pipe = dev->out_pipe;
1230 retval = test_halt(dev, ep, urb);
1232 done:
1233 simple_free_urb (urb);
1234 return retval;
1237 /*-------------------------------------------------------------------------*/
1239 /* Control OUT tests use the vendor control requests from Intel's
1240 * USB 2.0 compliance test device: write a buffer, read it back.
1242 * Intel's spec only _requires_ that it work for one packet, which
1243 * is pretty weak. Some HCDs place limits here; most devices will
1244 * need to be able to handle more than one OUT data packet. We'll
1245 * try whatever we're told to try.
1247 static int ctrl_out (struct usbtest_dev *dev,
1248 unsigned count, unsigned length, unsigned vary)
1250 unsigned i, j, len;
1251 int retval;
1252 u8 *buf;
1253 char *what = "?";
1254 struct usb_device *udev;
1256 if (length < 1 || length > 0xffff || vary >= length)
1257 return -EINVAL;
1259 buf = kmalloc(length, GFP_KERNEL);
1260 if (!buf)
1261 return -ENOMEM;
1263 udev = testdev_to_usbdev (dev);
1264 len = length;
1265 retval = 0;
1267 /* NOTE: hardware might well act differently if we pushed it
1268 * with lots back-to-back queued requests.
1270 for (i = 0; i < count; i++) {
1271 /* write patterned data */
1272 for (j = 0; j < len; j++)
1273 buf [j] = i + j;
1274 retval = usb_control_msg (udev, usb_sndctrlpipe (udev,0),
1275 0x5b, USB_DIR_OUT|USB_TYPE_VENDOR,
1276 0, 0, buf, len, USB_CTRL_SET_TIMEOUT);
1277 if (retval != len) {
1278 what = "write";
1279 if (retval >= 0) {
1280 ERROR(dev, "ctrl_out, wlen %d (expected %d)\n",
1281 retval, len);
1282 retval = -EBADMSG;
1284 break;
1287 /* read it back -- assuming nothing intervened!! */
1288 retval = usb_control_msg (udev, usb_rcvctrlpipe (udev,0),
1289 0x5c, USB_DIR_IN|USB_TYPE_VENDOR,
1290 0, 0, buf, len, USB_CTRL_GET_TIMEOUT);
1291 if (retval != len) {
1292 what = "read";
1293 if (retval >= 0) {
1294 ERROR(dev, "ctrl_out, rlen %d (expected %d)\n",
1295 retval, len);
1296 retval = -EBADMSG;
1298 break;
1301 /* fail if we can't verify */
1302 for (j = 0; j < len; j++) {
1303 if (buf [j] != (u8) (i + j)) {
1304 ERROR(dev, "ctrl_out, byte %d is %d not %d\n",
1305 j, buf [j], (u8) i + j);
1306 retval = -EBADMSG;
1307 break;
1310 if (retval < 0) {
1311 what = "verify";
1312 break;
1315 len += vary;
1317 /* [real world] the "zero bytes IN" case isn't really used.
1318 * hardware can easily trip up in this weird case, since its
1319 * status stage is IN, not OUT like other ep0in transfers.
1321 if (len > length)
1322 len = realworld ? 1 : 0;
1325 if (retval < 0)
1326 ERROR (dev, "ctrl_out %s failed, code %d, count %d\n",
1327 what, retval, i);
1329 kfree (buf);
1330 return retval;
1333 /*-------------------------------------------------------------------------*/
1335 /* ISO tests ... mimics common usage
1336 * - buffer length is split into N packets (mostly maxpacket sized)
1337 * - multi-buffers according to sglen
1340 struct iso_context {
1341 unsigned count;
1342 unsigned pending;
1343 spinlock_t lock;
1344 struct completion done;
1345 int submit_error;
1346 unsigned long errors;
1347 unsigned long packet_count;
1348 struct usbtest_dev *dev;
1351 static void iso_callback (struct urb *urb)
1353 struct iso_context *ctx = urb->context;
1355 spin_lock(&ctx->lock);
1356 ctx->count--;
1358 ctx->packet_count += urb->number_of_packets;
1359 if (urb->error_count > 0)
1360 ctx->errors += urb->error_count;
1361 else if (urb->status != 0)
1362 ctx->errors += urb->number_of_packets;
1364 if (urb->status == 0 && ctx->count > (ctx->pending - 1)
1365 && !ctx->submit_error) {
1366 int status = usb_submit_urb (urb, GFP_ATOMIC);
1367 switch (status) {
1368 case 0:
1369 goto done;
1370 default:
1371 dev_err(&ctx->dev->intf->dev,
1372 "iso resubmit err %d\n",
1373 status);
1374 /* FALLTHROUGH */
1375 case -ENODEV: /* disconnected */
1376 case -ESHUTDOWN: /* endpoint disabled */
1377 ctx->submit_error = 1;
1378 break;
1382 ctx->pending--;
1383 if (ctx->pending == 0) {
1384 if (ctx->errors)
1385 dev_err(&ctx->dev->intf->dev,
1386 "iso test, %lu errors out of %lu\n",
1387 ctx->errors, ctx->packet_count);
1388 complete (&ctx->done);
1390 done:
1391 spin_unlock(&ctx->lock);
1394 static struct urb *iso_alloc_urb (
1395 struct usb_device *udev,
1396 int pipe,
1397 struct usb_endpoint_descriptor *desc,
1398 long bytes
1401 struct urb *urb;
1402 unsigned i, maxp, packets;
1404 if (bytes < 0 || !desc)
1405 return NULL;
1406 maxp = 0x7ff & le16_to_cpu(desc->wMaxPacketSize);
1407 maxp *= 1 + (0x3 & (le16_to_cpu(desc->wMaxPacketSize) >> 11));
1408 packets = DIV_ROUND_UP(bytes, maxp);
1410 urb = usb_alloc_urb (packets, GFP_KERNEL);
1411 if (!urb)
1412 return urb;
1413 urb->dev = udev;
1414 urb->pipe = pipe;
1416 urb->number_of_packets = packets;
1417 urb->transfer_buffer_length = bytes;
1418 urb->transfer_buffer = usb_alloc_coherent (udev, bytes, GFP_KERNEL,
1419 &urb->transfer_dma);
1420 if (!urb->transfer_buffer) {
1421 usb_free_urb (urb);
1422 return NULL;
1424 memset (urb->transfer_buffer, 0, bytes);
1425 for (i = 0; i < packets; i++) {
1426 /* here, only the last packet will be short */
1427 urb->iso_frame_desc[i].length = min ((unsigned) bytes, maxp);
1428 bytes -= urb->iso_frame_desc[i].length;
1430 urb->iso_frame_desc[i].offset = maxp * i;
1433 urb->complete = iso_callback;
1434 // urb->context = SET BY CALLER
1435 urb->interval = 1 << (desc->bInterval - 1);
1436 urb->transfer_flags = URB_ISO_ASAP | URB_NO_TRANSFER_DMA_MAP;
1437 return urb;
1440 static int
1441 test_iso_queue (struct usbtest_dev *dev, struct usbtest_param *param,
1442 int pipe, struct usb_endpoint_descriptor *desc)
1444 struct iso_context context;
1445 struct usb_device *udev;
1446 unsigned i;
1447 unsigned long packets = 0;
1448 int status = 0;
1449 struct urb *urbs[10]; /* FIXME no limit */
1451 if (param->sglen > 10)
1452 return -EDOM;
1454 memset(&context, 0, sizeof context);
1455 context.count = param->iterations * param->sglen;
1456 context.dev = dev;
1457 init_completion (&context.done);
1458 spin_lock_init (&context.lock);
1460 memset (urbs, 0, sizeof urbs);
1461 udev = testdev_to_usbdev (dev);
1462 dev_info(&dev->intf->dev,
1463 "... iso period %d %sframes, wMaxPacket %04x\n",
1464 1 << (desc->bInterval - 1),
1465 (udev->speed == USB_SPEED_HIGH) ? "micro" : "",
1466 le16_to_cpu(desc->wMaxPacketSize));
1468 for (i = 0; i < param->sglen; i++) {
1469 urbs [i] = iso_alloc_urb (udev, pipe, desc,
1470 param->length);
1471 if (!urbs [i]) {
1472 status = -ENOMEM;
1473 goto fail;
1475 packets += urbs[i]->number_of_packets;
1476 urbs [i]->context = &context;
1478 packets *= param->iterations;
1479 dev_info(&dev->intf->dev,
1480 "... total %lu msec (%lu packets)\n",
1481 (packets * (1 << (desc->bInterval - 1)))
1482 / ((udev->speed == USB_SPEED_HIGH) ? 8 : 1),
1483 packets);
1485 spin_lock_irq (&context.lock);
1486 for (i = 0; i < param->sglen; i++) {
1487 ++context.pending;
1488 status = usb_submit_urb (urbs [i], GFP_ATOMIC);
1489 if (status < 0) {
1490 ERROR (dev, "submit iso[%d], error %d\n", i, status);
1491 if (i == 0) {
1492 spin_unlock_irq (&context.lock);
1493 goto fail;
1496 simple_free_urb (urbs [i]);
1497 urbs[i] = NULL;
1498 context.pending--;
1499 context.submit_error = 1;
1500 break;
1503 spin_unlock_irq (&context.lock);
1505 wait_for_completion (&context.done);
1507 for (i = 0; i < param->sglen; i++) {
1508 if (urbs[i])
1509 simple_free_urb(urbs[i]);
1512 * Isochronous transfers are expected to fail sometimes. As an
1513 * arbitrary limit, we will report an error if any submissions
1514 * fail or if the transfer failure rate is > 10%.
1516 if (status != 0)
1518 else if (context.submit_error)
1519 status = -EACCES;
1520 else if (context.errors > context.packet_count / 10)
1521 status = -EIO;
1522 return status;
1524 fail:
1525 for (i = 0; i < param->sglen; i++) {
1526 if (urbs [i])
1527 simple_free_urb (urbs [i]);
1529 return status;
1532 /*-------------------------------------------------------------------------*/
1534 /* We only have this one interface to user space, through usbfs.
1535 * User mode code can scan usbfs to find N different devices (maybe on
1536 * different busses) to use when testing, and allocate one thread per
1537 * test. So discovery is simplified, and we have no device naming issues.
1539 * Don't use these only as stress/load tests. Use them along with with
1540 * other USB bus activity: plugging, unplugging, mousing, mp3 playback,
1541 * video capture, and so on. Run different tests at different times, in
1542 * different sequences. Nothing here should interact with other devices,
1543 * except indirectly by consuming USB bandwidth and CPU resources for test
1544 * threads and request completion. But the only way to know that for sure
1545 * is to test when HC queues are in use by many devices.
1547 * WARNING: Because usbfs grabs udev->dev.sem before calling this ioctl(),
1548 * it locks out usbcore in certain code paths. Notably, if you disconnect
1549 * the device-under-test, khubd will wait block forever waiting for the
1550 * ioctl to complete ... so that usb_disconnect() can abort the pending
1551 * urbs and then call usbtest_disconnect(). To abort a test, you're best
1552 * off just killing the userspace task and waiting for it to exit.
1555 /* No BKL needed */
1556 static int
1557 usbtest_ioctl (struct usb_interface *intf, unsigned int code, void *buf)
1559 struct usbtest_dev *dev = usb_get_intfdata (intf);
1560 struct usb_device *udev = testdev_to_usbdev (dev);
1561 struct usbtest_param *param = buf;
1562 int retval = -EOPNOTSUPP;
1563 struct urb *urb;
1564 struct scatterlist *sg;
1565 struct usb_sg_request req;
1566 struct timeval start;
1567 unsigned i;
1569 // FIXME USBDEVFS_CONNECTINFO doesn't say how fast the device is.
1571 pattern = mod_pattern;
1573 if (code != USBTEST_REQUEST)
1574 return -EOPNOTSUPP;
1576 if (param->iterations <= 0)
1577 return -EINVAL;
1579 if (mutex_lock_interruptible(&dev->lock))
1580 return -ERESTARTSYS;
1582 /* FIXME: What if a system sleep starts while a test is running? */
1584 /* some devices, like ez-usb default devices, need a non-default
1585 * altsetting to have any active endpoints. some tests change
1586 * altsettings; force a default so most tests don't need to check.
1588 if (dev->info->alt >= 0) {
1589 int res;
1591 if (intf->altsetting->desc.bInterfaceNumber) {
1592 mutex_unlock(&dev->lock);
1593 return -ENODEV;
1595 res = set_altsetting (dev, dev->info->alt);
1596 if (res) {
1597 dev_err (&intf->dev,
1598 "set altsetting to %d failed, %d\n",
1599 dev->info->alt, res);
1600 mutex_unlock(&dev->lock);
1601 return res;
1606 * Just a bunch of test cases that every HCD is expected to handle.
1608 * Some may need specific firmware, though it'd be good to have
1609 * one firmware image to handle all the test cases.
1611 * FIXME add more tests! cancel requests, verify the data, control
1612 * queueing, concurrent read+write threads, and so on.
1614 do_gettimeofday (&start);
1615 switch (param->test_num) {
1617 case 0:
1618 dev_info(&intf->dev, "TEST 0: NOP\n");
1619 retval = 0;
1620 break;
1622 /* Simple non-queued bulk I/O tests */
1623 case 1:
1624 if (dev->out_pipe == 0)
1625 break;
1626 dev_info(&intf->dev,
1627 "TEST 1: write %d bytes %u times\n",
1628 param->length, param->iterations);
1629 urb = simple_alloc_urb (udev, dev->out_pipe, param->length);
1630 if (!urb) {
1631 retval = -ENOMEM;
1632 break;
1634 // FIRMWARE: bulk sink (maybe accepts short writes)
1635 retval = simple_io(dev, urb, param->iterations, 0, 0, "test1");
1636 simple_free_urb (urb);
1637 break;
1638 case 2:
1639 if (dev->in_pipe == 0)
1640 break;
1641 dev_info(&intf->dev,
1642 "TEST 2: read %d bytes %u times\n",
1643 param->length, param->iterations);
1644 urb = simple_alloc_urb (udev, dev->in_pipe, param->length);
1645 if (!urb) {
1646 retval = -ENOMEM;
1647 break;
1649 // FIRMWARE: bulk source (maybe generates short writes)
1650 retval = simple_io(dev, urb, param->iterations, 0, 0, "test2");
1651 simple_free_urb (urb);
1652 break;
1653 case 3:
1654 if (dev->out_pipe == 0 || param->vary == 0)
1655 break;
1656 dev_info(&intf->dev,
1657 "TEST 3: write/%d 0..%d bytes %u times\n",
1658 param->vary, param->length, param->iterations);
1659 urb = simple_alloc_urb (udev, dev->out_pipe, param->length);
1660 if (!urb) {
1661 retval = -ENOMEM;
1662 break;
1664 // FIRMWARE: bulk sink (maybe accepts short writes)
1665 retval = simple_io(dev, urb, param->iterations, param->vary,
1666 0, "test3");
1667 simple_free_urb (urb);
1668 break;
1669 case 4:
1670 if (dev->in_pipe == 0 || param->vary == 0)
1671 break;
1672 dev_info(&intf->dev,
1673 "TEST 4: read/%d 0..%d bytes %u times\n",
1674 param->vary, param->length, param->iterations);
1675 urb = simple_alloc_urb (udev, dev->in_pipe, param->length);
1676 if (!urb) {
1677 retval = -ENOMEM;
1678 break;
1680 // FIRMWARE: bulk source (maybe generates short writes)
1681 retval = simple_io(dev, urb, param->iterations, param->vary,
1682 0, "test4");
1683 simple_free_urb (urb);
1684 break;
1686 /* Queued bulk I/O tests */
1687 case 5:
1688 if (dev->out_pipe == 0 || param->sglen == 0)
1689 break;
1690 dev_info(&intf->dev,
1691 "TEST 5: write %d sglists %d entries of %d bytes\n",
1692 param->iterations,
1693 param->sglen, param->length);
1694 sg = alloc_sglist (param->sglen, param->length, 0);
1695 if (!sg) {
1696 retval = -ENOMEM;
1697 break;
1699 // FIRMWARE: bulk sink (maybe accepts short writes)
1700 retval = perform_sglist(dev, param->iterations, dev->out_pipe,
1701 &req, sg, param->sglen);
1702 free_sglist (sg, param->sglen);
1703 break;
1705 case 6:
1706 if (dev->in_pipe == 0 || param->sglen == 0)
1707 break;
1708 dev_info(&intf->dev,
1709 "TEST 6: read %d sglists %d entries of %d bytes\n",
1710 param->iterations,
1711 param->sglen, param->length);
1712 sg = alloc_sglist (param->sglen, param->length, 0);
1713 if (!sg) {
1714 retval = -ENOMEM;
1715 break;
1717 // FIRMWARE: bulk source (maybe generates short writes)
1718 retval = perform_sglist(dev, param->iterations, dev->in_pipe,
1719 &req, sg, param->sglen);
1720 free_sglist (sg, param->sglen);
1721 break;
1722 case 7:
1723 if (dev->out_pipe == 0 || param->sglen == 0 || param->vary == 0)
1724 break;
1725 dev_info(&intf->dev,
1726 "TEST 7: write/%d %d sglists %d entries 0..%d bytes\n",
1727 param->vary, param->iterations,
1728 param->sglen, param->length);
1729 sg = alloc_sglist (param->sglen, param->length, param->vary);
1730 if (!sg) {
1731 retval = -ENOMEM;
1732 break;
1734 // FIRMWARE: bulk sink (maybe accepts short writes)
1735 retval = perform_sglist(dev, param->iterations, dev->out_pipe,
1736 &req, sg, param->sglen);
1737 free_sglist (sg, param->sglen);
1738 break;
1739 case 8:
1740 if (dev->in_pipe == 0 || param->sglen == 0 || param->vary == 0)
1741 break;
1742 dev_info(&intf->dev,
1743 "TEST 8: read/%d %d sglists %d entries 0..%d bytes\n",
1744 param->vary, param->iterations,
1745 param->sglen, param->length);
1746 sg = alloc_sglist (param->sglen, param->length, param->vary);
1747 if (!sg) {
1748 retval = -ENOMEM;
1749 break;
1751 // FIRMWARE: bulk source (maybe generates short writes)
1752 retval = perform_sglist(dev, param->iterations, dev->in_pipe,
1753 &req, sg, param->sglen);
1754 free_sglist (sg, param->sglen);
1755 break;
1757 /* non-queued sanity tests for control (chapter 9 subset) */
1758 case 9:
1759 retval = 0;
1760 dev_info(&intf->dev,
1761 "TEST 9: ch9 (subset) control tests, %d times\n",
1762 param->iterations);
1763 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1764 retval = ch9_postconfig (dev);
1765 if (retval)
1766 dev_err(&intf->dev, "ch9 subset failed, "
1767 "iterations left %d\n", i);
1768 break;
1770 /* queued control messaging */
1771 case 10:
1772 if (param->sglen == 0)
1773 break;
1774 retval = 0;
1775 dev_info(&intf->dev,
1776 "TEST 10: queue %d control calls, %d times\n",
1777 param->sglen,
1778 param->iterations);
1779 retval = test_ctrl_queue (dev, param);
1780 break;
1782 /* simple non-queued unlinks (ring with one urb) */
1783 case 11:
1784 if (dev->in_pipe == 0 || !param->length)
1785 break;
1786 retval = 0;
1787 dev_info(&intf->dev, "TEST 11: unlink %d reads of %d\n",
1788 param->iterations, param->length);
1789 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1790 retval = unlink_simple (dev, dev->in_pipe,
1791 param->length);
1792 if (retval)
1793 dev_err(&intf->dev, "unlink reads failed %d, "
1794 "iterations left %d\n", retval, i);
1795 break;
1796 case 12:
1797 if (dev->out_pipe == 0 || !param->length)
1798 break;
1799 retval = 0;
1800 dev_info(&intf->dev, "TEST 12: unlink %d writes of %d\n",
1801 param->iterations, param->length);
1802 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1803 retval = unlink_simple (dev, dev->out_pipe,
1804 param->length);
1805 if (retval)
1806 dev_err(&intf->dev, "unlink writes failed %d, "
1807 "iterations left %d\n", retval, i);
1808 break;
1810 /* ep halt tests */
1811 case 13:
1812 if (dev->out_pipe == 0 && dev->in_pipe == 0)
1813 break;
1814 retval = 0;
1815 dev_info(&intf->dev, "TEST 13: set/clear %d halts\n",
1816 param->iterations);
1817 for (i = param->iterations; retval == 0 && i--; /* NOP */)
1818 retval = halt_simple (dev);
1820 if (retval)
1821 ERROR(dev, "halts failed, iterations left %d\n", i);
1822 break;
1824 /* control write tests */
1825 case 14:
1826 if (!dev->info->ctrl_out)
1827 break;
1828 dev_info(&intf->dev, "TEST 14: %d ep0out, %d..%d vary %d\n",
1829 param->iterations,
1830 realworld ? 1 : 0, param->length,
1831 param->vary);
1832 retval = ctrl_out(dev, param->iterations,
1833 param->length, param->vary);
1834 break;
1836 /* iso write tests */
1837 case 15:
1838 if (dev->out_iso_pipe == 0 || param->sglen == 0)
1839 break;
1840 dev_info(&intf->dev,
1841 "TEST 15: write %d iso, %d entries of %d bytes\n",
1842 param->iterations,
1843 param->sglen, param->length);
1844 // FIRMWARE: iso sink
1845 retval = test_iso_queue (dev, param,
1846 dev->out_iso_pipe, dev->iso_out);
1847 break;
1849 /* iso read tests */
1850 case 16:
1851 if (dev->in_iso_pipe == 0 || param->sglen == 0)
1852 break;
1853 dev_info(&intf->dev,
1854 "TEST 16: read %d iso, %d entries of %d bytes\n",
1855 param->iterations,
1856 param->sglen, param->length);
1857 // FIRMWARE: iso source
1858 retval = test_iso_queue (dev, param,
1859 dev->in_iso_pipe, dev->iso_in);
1860 break;
1862 // FIXME unlink from queue (ring with N urbs)
1864 // FIXME scatterlist cancel (needs helper thread)
1867 do_gettimeofday (&param->duration);
1868 param->duration.tv_sec -= start.tv_sec;
1869 param->duration.tv_usec -= start.tv_usec;
1870 if (param->duration.tv_usec < 0) {
1871 param->duration.tv_usec += 1000 * 1000;
1872 param->duration.tv_sec -= 1;
1874 mutex_unlock(&dev->lock);
1875 return retval;
1878 /*-------------------------------------------------------------------------*/
1880 static unsigned force_interrupt = 0;
1881 module_param (force_interrupt, uint, 0);
1882 MODULE_PARM_DESC (force_interrupt, "0 = test default; else interrupt");
1884 #ifdef GENERIC
1885 static unsigned short vendor;
1886 module_param(vendor, ushort, 0);
1887 MODULE_PARM_DESC (vendor, "vendor code (from usb-if)");
1889 static unsigned short product;
1890 module_param(product, ushort, 0);
1891 MODULE_PARM_DESC (product, "product code (from vendor)");
1892 #endif
1894 static int
1895 usbtest_probe (struct usb_interface *intf, const struct usb_device_id *id)
1897 struct usb_device *udev;
1898 struct usbtest_dev *dev;
1899 struct usbtest_info *info;
1900 char *rtest, *wtest;
1901 char *irtest, *iwtest;
1903 udev = interface_to_usbdev (intf);
1905 #ifdef GENERIC
1906 /* specify devices by module parameters? */
1907 if (id->match_flags == 0) {
1908 /* vendor match required, product match optional */
1909 if (!vendor || le16_to_cpu(udev->descriptor.idVendor) != (u16)vendor)
1910 return -ENODEV;
1911 if (product && le16_to_cpu(udev->descriptor.idProduct) != (u16)product)
1912 return -ENODEV;
1913 dev_info(&intf->dev, "matched module params, "
1914 "vend=0x%04x prod=0x%04x\n",
1915 le16_to_cpu(udev->descriptor.idVendor),
1916 le16_to_cpu(udev->descriptor.idProduct));
1918 #endif
1920 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
1921 if (!dev)
1922 return -ENOMEM;
1923 info = (struct usbtest_info *) id->driver_info;
1924 dev->info = info;
1925 mutex_init(&dev->lock);
1927 dev->intf = intf;
1929 /* cacheline-aligned scratch for i/o */
1930 if ((dev->buf = kmalloc (TBUF_SIZE, GFP_KERNEL)) == NULL) {
1931 kfree (dev);
1932 return -ENOMEM;
1935 /* NOTE this doesn't yet test the handful of difference that are
1936 * visible with high speed interrupts: bigger maxpacket (1K) and
1937 * "high bandwidth" modes (up to 3 packets/uframe).
1939 rtest = wtest = "";
1940 irtest = iwtest = "";
1941 if (force_interrupt || udev->speed == USB_SPEED_LOW) {
1942 if (info->ep_in) {
1943 dev->in_pipe = usb_rcvintpipe (udev, info->ep_in);
1944 rtest = " intr-in";
1946 if (info->ep_out) {
1947 dev->out_pipe = usb_sndintpipe (udev, info->ep_out);
1948 wtest = " intr-out";
1950 } else {
1951 if (info->autoconf) {
1952 int status;
1954 status = get_endpoints (dev, intf);
1955 if (status < 0) {
1956 WARNING(dev, "couldn't get endpoints, %d\n",
1957 status);
1958 return status;
1960 /* may find bulk or ISO pipes */
1961 } else {
1962 if (info->ep_in)
1963 dev->in_pipe = usb_rcvbulkpipe (udev,
1964 info->ep_in);
1965 if (info->ep_out)
1966 dev->out_pipe = usb_sndbulkpipe (udev,
1967 info->ep_out);
1969 if (dev->in_pipe)
1970 rtest = " bulk-in";
1971 if (dev->out_pipe)
1972 wtest = " bulk-out";
1973 if (dev->in_iso_pipe)
1974 irtest = " iso-in";
1975 if (dev->out_iso_pipe)
1976 iwtest = " iso-out";
1979 usb_set_intfdata (intf, dev);
1980 dev_info (&intf->dev, "%s\n", info->name);
1981 dev_info (&intf->dev, "%s speed {control%s%s%s%s%s} tests%s\n",
1982 ({ char *tmp;
1983 switch (udev->speed) {
1984 case USB_SPEED_LOW: tmp = "low"; break;
1985 case USB_SPEED_FULL: tmp = "full"; break;
1986 case USB_SPEED_HIGH: tmp = "high"; break;
1987 default: tmp = "unknown"; break;
1988 }; tmp; }),
1989 info->ctrl_out ? " in/out" : "",
1990 rtest, wtest,
1991 irtest, iwtest,
1992 info->alt >= 0 ? " (+alt)" : "");
1993 return 0;
1996 static int usbtest_suspend (struct usb_interface *intf, pm_message_t message)
1998 return 0;
2001 static int usbtest_resume (struct usb_interface *intf)
2003 return 0;
2007 static void usbtest_disconnect (struct usb_interface *intf)
2009 struct usbtest_dev *dev = usb_get_intfdata (intf);
2011 usb_set_intfdata (intf, NULL);
2012 dev_dbg (&intf->dev, "disconnect\n");
2013 kfree (dev);
2016 /* Basic testing only needs a device that can source or sink bulk traffic.
2017 * Any device can test control transfers (default with GENERIC binding).
2019 * Several entries work with the default EP0 implementation that's built
2020 * into EZ-USB chips. There's a default vendor ID which can be overridden
2021 * by (very) small config EEPROMS, but otherwise all these devices act
2022 * identically until firmware is loaded: only EP0 works. It turns out
2023 * to be easy to make other endpoints work, without modifying that EP0
2024 * behavior. For now, we expect that kind of firmware.
2027 /* an21xx or fx versions of ez-usb */
2028 static struct usbtest_info ez1_info = {
2029 .name = "EZ-USB device",
2030 .ep_in = 2,
2031 .ep_out = 2,
2032 .alt = 1,
2035 /* fx2 version of ez-usb */
2036 static struct usbtest_info ez2_info = {
2037 .name = "FX2 device",
2038 .ep_in = 6,
2039 .ep_out = 2,
2040 .alt = 1,
2043 /* ezusb family device with dedicated usb test firmware,
2045 static struct usbtest_info fw_info = {
2046 .name = "usb test device",
2047 .ep_in = 2,
2048 .ep_out = 2,
2049 .alt = 1,
2050 .autoconf = 1, // iso and ctrl_out need autoconf
2051 .ctrl_out = 1,
2052 .iso = 1, // iso_ep's are #8 in/out
2055 /* peripheral running Linux and 'zero.c' test firmware, or
2056 * its user-mode cousin. different versions of this use
2057 * different hardware with the same vendor/product codes.
2058 * host side MUST rely on the endpoint descriptors.
2060 static struct usbtest_info gz_info = {
2061 .name = "Linux gadget zero",
2062 .autoconf = 1,
2063 .ctrl_out = 1,
2064 .alt = 0,
2067 static struct usbtest_info um_info = {
2068 .name = "Linux user mode test driver",
2069 .autoconf = 1,
2070 .alt = -1,
2073 static struct usbtest_info um2_info = {
2074 .name = "Linux user mode ISO test driver",
2075 .autoconf = 1,
2076 .iso = 1,
2077 .alt = -1,
2080 #ifdef IBOT2
2081 /* this is a nice source of high speed bulk data;
2082 * uses an FX2, with firmware provided in the device
2084 static struct usbtest_info ibot2_info = {
2085 .name = "iBOT2 webcam",
2086 .ep_in = 2,
2087 .alt = -1,
2089 #endif
2091 #ifdef GENERIC
2092 /* we can use any device to test control traffic */
2093 static struct usbtest_info generic_info = {
2094 .name = "Generic USB device",
2095 .alt = -1,
2097 #endif
2100 static const struct usb_device_id id_table[] = {
2102 /*-------------------------------------------------------------*/
2104 /* EZ-USB devices which download firmware to replace (or in our
2105 * case augment) the default device implementation.
2108 /* generic EZ-USB FX controller */
2109 { USB_DEVICE (0x0547, 0x2235),
2110 .driver_info = (unsigned long) &ez1_info,
2113 /* CY3671 development board with EZ-USB FX */
2114 { USB_DEVICE (0x0547, 0x0080),
2115 .driver_info = (unsigned long) &ez1_info,
2118 /* generic EZ-USB FX2 controller (or development board) */
2119 { USB_DEVICE (0x04b4, 0x8613),
2120 .driver_info = (unsigned long) &ez2_info,
2123 /* re-enumerated usb test device firmware */
2124 { USB_DEVICE (0xfff0, 0xfff0),
2125 .driver_info = (unsigned long) &fw_info,
2128 /* "Gadget Zero" firmware runs under Linux */
2129 { USB_DEVICE (0x0525, 0xa4a0),
2130 .driver_info = (unsigned long) &gz_info,
2133 /* so does a user-mode variant */
2134 { USB_DEVICE (0x0525, 0xa4a4),
2135 .driver_info = (unsigned long) &um_info,
2138 /* ... and a user-mode variant that talks iso */
2139 { USB_DEVICE (0x0525, 0xa4a3),
2140 .driver_info = (unsigned long) &um2_info,
2143 #ifdef KEYSPAN_19Qi
2144 /* Keyspan 19qi uses an21xx (original EZ-USB) */
2145 // this does not coexist with the real Keyspan 19qi driver!
2146 { USB_DEVICE (0x06cd, 0x010b),
2147 .driver_info = (unsigned long) &ez1_info,
2149 #endif
2151 /*-------------------------------------------------------------*/
2153 #ifdef IBOT2
2154 /* iBOT2 makes a nice source of high speed bulk-in data */
2155 // this does not coexist with a real iBOT2 driver!
2156 { USB_DEVICE (0x0b62, 0x0059),
2157 .driver_info = (unsigned long) &ibot2_info,
2159 #endif
2161 /*-------------------------------------------------------------*/
2163 #ifdef GENERIC
2164 /* module params can specify devices to use for control tests */
2165 { .driver_info = (unsigned long) &generic_info, },
2166 #endif
2168 /*-------------------------------------------------------------*/
2172 MODULE_DEVICE_TABLE (usb, id_table);
2174 static struct usb_driver usbtest_driver = {
2175 .name = "usbtest",
2176 .id_table = id_table,
2177 .probe = usbtest_probe,
2178 .unlocked_ioctl = usbtest_ioctl,
2179 .disconnect = usbtest_disconnect,
2180 .suspend = usbtest_suspend,
2181 .resume = usbtest_resume,
2184 /*-------------------------------------------------------------------------*/
2186 static int __init usbtest_init (void)
2188 #ifdef GENERIC
2189 if (vendor)
2190 pr_debug("params: vend=0x%04x prod=0x%04x\n", vendor, product);
2191 #endif
2192 return usb_register (&usbtest_driver);
2194 module_init (usbtest_init);
2196 static void __exit usbtest_exit (void)
2198 usb_deregister (&usbtest_driver);
2200 module_exit (usbtest_exit);
2202 MODULE_DESCRIPTION ("USB Core/HCD Testing Driver");
2203 MODULE_LICENSE ("GPL");