1 #include <linux/kernel.h>
2 #include <linux/errno.h>
3 #include <linux/init.h>
4 #include <linux/slab.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
{
20 unsigned test_num
; /* 0..(TEST_CASES-1) */
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
39 //#define IBOT2 /* grab iBOT2 webcams */
40 //#define KEYSPAN_19Qi /* grab un-renumerated serial adapter */
42 /*-------------------------------------------------------------------------*/
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 */
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.
61 struct usb_interface
*intf
;
62 struct usbtest_info
*info
;
67 struct usb_endpoint_descriptor
*iso_in
, *iso_out
;
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 /*-------------------------------------------------------------------------*/
90 get_endpoints (struct usbtest_dev
*dev
, struct usb_interface
*intf
)
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
++) {
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
:
115 case USB_ENDPOINT_XFER_ISOC
:
122 if (usb_endpoint_dir_in(&e
->desc
)) {
131 if (usb_endpoint_dir_in(&e
->desc
)) {
139 if ((in
&& out
) || (iso_in
&& iso_out
))
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
);
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
);
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
);
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
,
195 urb
= usb_alloc_urb (0, GFP_KERNEL
);
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)
202 urb
->transfer_flags
= URB_NO_TRANSFER_DMA_MAP
;
203 if (usb_pipein (pipe
))
204 urb
->transfer_flags
|= URB_SHORT_NOT_OK
;
205 urb
->transfer_buffer
= usb_buffer_alloc (udev
, bytes
, GFP_KERNEL
,
207 if (!urb
->transfer_buffer
) {
211 memset (urb
->transfer_buffer
, 0, bytes
);
215 static unsigned pattern
= 0;
216 module_param (pattern
, uint
, S_IRUGO
);
217 MODULE_PARM_DESC(pattern
, "i/o pattern (0 == zeroes)");
219 static inline void simple_fill_buf (struct urb
*urb
)
222 u8
*buf
= urb
->transfer_buffer
;
223 unsigned len
= urb
->transfer_buffer_length
;
229 memset (buf
, 0, len
);
232 for (i
= 0; i
< len
; i
++)
233 *buf
++ = (u8
) (i
% 63);
238 static inline int simple_check_buf(struct usbtest_dev
*tdev
, struct urb
*urb
)
242 u8
*buf
= urb
->transfer_buffer
;
243 unsigned len
= urb
->actual_length
;
245 for (i
= 0; i
< len
; i
++, buf
++) {
247 /* all-zeroes has no synchronization issues */
251 /* mod63 stays in sync with short-terminated transfers,
252 * or otherwise when host and gadget agree on how large
253 * each usb transfer request should be. resync is done
254 * with set_interface or set_config.
259 /* always fail unsupported patterns */
264 if (*buf
== expected
)
266 ERROR(tdev
, "buf[%d] = %d (not %d)\n", i
, *buf
, expected
);
272 static void simple_free_urb (struct urb
*urb
)
274 usb_buffer_free (urb
->dev
, urb
->transfer_buffer_length
,
275 urb
->transfer_buffer
, urb
->transfer_dma
);
279 static int simple_io (
280 struct usbtest_dev
*tdev
,
288 struct usb_device
*udev
= urb
->dev
;
289 int max
= urb
->transfer_buffer_length
;
290 struct completion completion
;
293 urb
->context
= &completion
;
294 while (retval
== 0 && iterations
-- > 0) {
295 init_completion (&completion
);
296 if (usb_pipeout (urb
->pipe
))
297 simple_fill_buf (urb
);
298 if ((retval
= usb_submit_urb (urb
, GFP_KERNEL
)) != 0)
301 /* NOTE: no timeouts; can't be broken out of by interrupt */
302 wait_for_completion (&completion
);
303 retval
= urb
->status
;
305 if (retval
== 0 && usb_pipein (urb
->pipe
))
306 retval
= simple_check_buf(tdev
, urb
);
309 int len
= urb
->transfer_buffer_length
;
314 len
= (vary
< max
) ? vary
: max
;
315 urb
->transfer_buffer_length
= len
;
318 /* FIXME if endpoint halted, clear halt (and log) */
320 urb
->transfer_buffer_length
= max
;
322 if (expected
!= retval
)
324 "%s failed, iterations left %d, status %d (not %d)\n",
325 label
, iterations
, retval
, expected
);
330 /*-------------------------------------------------------------------------*/
332 /* We use scatterlist primitives to test queued I/O.
333 * Yes, this also tests the scatterlist primitives.
336 static void free_sglist (struct scatterlist
*sg
, int nents
)
342 for (i
= 0; i
< nents
; i
++) {
343 if (!sg_page(&sg
[i
]))
345 kfree (sg_virt(&sg
[i
]));
350 static struct scatterlist
*
351 alloc_sglist (int nents
, int max
, int vary
)
353 struct scatterlist
*sg
;
357 sg
= kmalloc (nents
* sizeof *sg
, GFP_KERNEL
);
360 sg_init_table(sg
, nents
);
362 for (i
= 0; i
< nents
; i
++) {
366 buf
= kzalloc (size
, GFP_KERNEL
);
372 /* kmalloc pages are always physically contiguous! */
373 sg_set_buf(&sg
[i
], buf
, size
);
380 for (j
= 0; j
< size
; j
++)
381 *buf
++ = (u8
) (j
% 63);
389 size
= (vary
< max
) ? vary
: max
;
396 static int perform_sglist (
397 struct usbtest_dev
*tdev
,
400 struct usb_sg_request
*req
,
401 struct scatterlist
*sg
,
405 struct usb_device
*udev
= testdev_to_usbdev(tdev
);
408 while (retval
== 0 && iterations
-- > 0) {
409 retval
= usb_sg_init (req
, udev
, pipe
,
410 (udev
->speed
== USB_SPEED_HIGH
)
411 ? (INTERRUPT_RATE
<< 3)
413 sg
, nents
, 0, GFP_KERNEL
);
418 retval
= req
->status
;
420 /* FIXME check resulting data pattern */
422 /* FIXME if endpoint halted, clear halt (and log) */
425 // FIXME for unlink or fault handling tests, don't report
426 // failure if retval is as we expected ...
429 ERROR(tdev
, "perform_sglist failed, "
430 "iterations left %d, status %d\n",
436 /*-------------------------------------------------------------------------*/
438 /* unqueued control message testing
440 * there's a nice set of device functional requirements in chapter 9 of the
441 * usb 2.0 spec, which we can apply to ANY device, even ones that don't use
442 * special test firmware.
444 * we know the device is configured (or suspended) by the time it's visible
445 * through usbfs. we can't change that, so we won't test enumeration (which
446 * worked 'well enough' to get here, this time), power management (ditto),
447 * or remote wakeup (which needs human interaction).
450 static unsigned realworld
= 1;
451 module_param (realworld
, uint
, 0);
452 MODULE_PARM_DESC (realworld
, "clear to demand stricter spec compliance");
454 static int get_altsetting (struct usbtest_dev
*dev
)
456 struct usb_interface
*iface
= dev
->intf
;
457 struct usb_device
*udev
= interface_to_usbdev (iface
);
460 retval
= usb_control_msg (udev
, usb_rcvctrlpipe (udev
, 0),
461 USB_REQ_GET_INTERFACE
, USB_DIR_IN
|USB_RECIP_INTERFACE
,
462 0, iface
->altsetting
[0].desc
.bInterfaceNumber
,
463 dev
->buf
, 1, USB_CTRL_GET_TIMEOUT
);
475 static int set_altsetting (struct usbtest_dev
*dev
, int alternate
)
477 struct usb_interface
*iface
= dev
->intf
;
478 struct usb_device
*udev
;
480 if (alternate
< 0 || alternate
>= 256)
483 udev
= interface_to_usbdev (iface
);
484 return usb_set_interface (udev
,
485 iface
->altsetting
[0].desc
.bInterfaceNumber
,
489 static int is_good_config(struct usbtest_dev
*tdev
, int len
)
491 struct usb_config_descriptor
*config
;
493 if (len
< sizeof *config
)
495 config
= (struct usb_config_descriptor
*) tdev
->buf
;
497 switch (config
->bDescriptorType
) {
499 case USB_DT_OTHER_SPEED_CONFIG
:
500 if (config
->bLength
!= 9) {
501 ERROR(tdev
, "bogus config descriptor length\n");
504 /* this bit 'must be 1' but often isn't */
505 if (!realworld
&& !(config
->bmAttributes
& 0x80)) {
506 ERROR(tdev
, "high bit of config attributes not set\n");
509 if (config
->bmAttributes
& 0x1f) { /* reserved == 0 */
510 ERROR(tdev
, "reserved config bits set\n");
518 if (le16_to_cpu(config
->wTotalLength
) == len
) /* read it all */
520 if (le16_to_cpu(config
->wTotalLength
) >= TBUF_SIZE
) /* max partial read */
522 ERROR(tdev
, "bogus config descriptor read size\n");
526 /* sanity test for standard requests working with usb_control_mesg() and some
527 * of the utility functions which use it.
529 * this doesn't test how endpoint halts behave or data toggles get set, since
530 * we won't do I/O to bulk/interrupt endpoints here (which is how to change
531 * halt or toggle). toggle testing is impractical without support from hcds.
533 * this avoids failing devices linux would normally work with, by not testing
534 * config/altsetting operations for devices that only support their defaults.
535 * such devices rarely support those needless operations.
537 * NOTE that since this is a sanity test, it's not examining boundary cases
538 * to see if usbcore, hcd, and device all behave right. such testing would
539 * involve varied read sizes and other operation sequences.
541 static int ch9_postconfig (struct usbtest_dev
*dev
)
543 struct usb_interface
*iface
= dev
->intf
;
544 struct usb_device
*udev
= interface_to_usbdev (iface
);
547 /* [9.2.3] if there's more than one altsetting, we need to be able to
548 * set and get each one. mostly trusts the descriptors from usbcore.
550 for (i
= 0; i
< iface
->num_altsetting
; i
++) {
552 /* 9.2.3 constrains the range here */
553 alt
= iface
->altsetting
[i
].desc
.bAlternateSetting
;
554 if (alt
< 0 || alt
>= iface
->num_altsetting
) {
556 "invalid alt [%d].bAltSetting = %d\n",
560 /* [real world] get/set unimplemented if there's only one */
561 if (realworld
&& iface
->num_altsetting
== 1)
564 /* [9.4.10] set_interface */
565 retval
= set_altsetting (dev
, alt
);
567 dev_err(&iface
->dev
, "can't set_interface = %d, %d\n",
572 /* [9.4.4] get_interface always works */
573 retval
= get_altsetting (dev
);
575 dev_err(&iface
->dev
, "get alt should be %d, was %d\n",
577 return (retval
< 0) ? retval
: -EDOM
;
582 /* [real world] get_config unimplemented if there's only one */
583 if (!realworld
|| udev
->descriptor
.bNumConfigurations
!= 1) {
584 int expected
= udev
->actconfig
->desc
.bConfigurationValue
;
586 /* [9.4.2] get_configuration always works
587 * ... although some cheap devices (like one TI Hub I've got)
588 * won't return config descriptors except before set_config.
590 retval
= usb_control_msg (udev
, usb_rcvctrlpipe (udev
, 0),
591 USB_REQ_GET_CONFIGURATION
,
592 USB_DIR_IN
| USB_RECIP_DEVICE
,
593 0, 0, dev
->buf
, 1, USB_CTRL_GET_TIMEOUT
);
594 if (retval
!= 1 || dev
->buf
[0] != expected
) {
595 dev_err(&iface
->dev
, "get config --> %d %d (1 %d)\n",
596 retval
, dev
->buf
[0], expected
);
597 return (retval
< 0) ? retval
: -EDOM
;
601 /* there's always [9.4.3] a device descriptor [9.6.1] */
602 retval
= usb_get_descriptor (udev
, USB_DT_DEVICE
, 0,
603 dev
->buf
, sizeof udev
->descriptor
);
604 if (retval
!= sizeof udev
->descriptor
) {
605 dev_err(&iface
->dev
, "dev descriptor --> %d\n", retval
);
606 return (retval
< 0) ? retval
: -EDOM
;
609 /* there's always [9.4.3] at least one config descriptor [9.6.3] */
610 for (i
= 0; i
< udev
->descriptor
.bNumConfigurations
; i
++) {
611 retval
= usb_get_descriptor (udev
, USB_DT_CONFIG
, i
,
612 dev
->buf
, TBUF_SIZE
);
613 if (!is_good_config(dev
, retval
)) {
615 "config [%d] descriptor --> %d\n",
617 return (retval
< 0) ? retval
: -EDOM
;
620 // FIXME cross-checking udev->config[i] to make sure usbcore
621 // parsed it right (etc) would be good testing paranoia
624 /* and sometimes [9.2.6.6] speed dependent descriptors */
625 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) == 0x0200) {
626 struct usb_qualifier_descriptor
*d
= NULL
;
628 /* device qualifier [9.6.2] */
629 retval
= usb_get_descriptor (udev
,
630 USB_DT_DEVICE_QUALIFIER
, 0, dev
->buf
,
631 sizeof (struct usb_qualifier_descriptor
));
632 if (retval
== -EPIPE
) {
633 if (udev
->speed
== USB_SPEED_HIGH
) {
635 "hs dev qualifier --> %d\n",
637 return (retval
< 0) ? retval
: -EDOM
;
639 /* usb2.0 but not high-speed capable; fine */
640 } else if (retval
!= sizeof (struct usb_qualifier_descriptor
)) {
641 dev_err(&iface
->dev
, "dev qualifier --> %d\n", retval
);
642 return (retval
< 0) ? retval
: -EDOM
;
644 d
= (struct usb_qualifier_descriptor
*) dev
->buf
;
646 /* might not have [9.6.2] any other-speed configs [9.6.4] */
648 unsigned max
= d
->bNumConfigurations
;
649 for (i
= 0; i
< max
; i
++) {
650 retval
= usb_get_descriptor (udev
,
651 USB_DT_OTHER_SPEED_CONFIG
, i
,
652 dev
->buf
, TBUF_SIZE
);
653 if (!is_good_config(dev
, retval
)) {
655 "other speed config --> %d\n",
657 return (retval
< 0) ? retval
: -EDOM
;
662 // FIXME fetch strings from at least the device descriptor
664 /* [9.4.5] get_status always works */
665 retval
= usb_get_status (udev
, USB_RECIP_DEVICE
, 0, dev
->buf
);
667 dev_err(&iface
->dev
, "get dev status --> %d\n", retval
);
668 return (retval
< 0) ? retval
: -EDOM
;
671 // FIXME configuration.bmAttributes says if we could try to set/clear
672 // the device's remote wakeup feature ... if we can, test that here
674 retval
= usb_get_status (udev
, USB_RECIP_INTERFACE
,
675 iface
->altsetting
[0].desc
.bInterfaceNumber
, dev
->buf
);
677 dev_err(&iface
->dev
, "get interface status --> %d\n", retval
);
678 return (retval
< 0) ? retval
: -EDOM
;
680 // FIXME get status for each endpoint in the interface
685 /*-------------------------------------------------------------------------*/
687 /* use ch9 requests to test whether:
688 * (a) queues work for control, keeping N subtests queued and
689 * active (auto-resubmit) for M loops through the queue.
690 * (b) protocol stalls (control-only) will autorecover.
691 * it's not like bulk/intr; no halt clearing.
692 * (c) short control reads are reported and handled.
693 * (d) queues are always processed in-order
698 struct usbtest_dev
*dev
;
699 struct completion complete
;
704 struct usbtest_param
*param
;
708 #define NUM_SUBCASES 15 /* how many test subcases here? */
711 struct usb_ctrlrequest setup
;
716 static void ctrl_complete (struct urb
*urb
)
718 struct ctrl_ctx
*ctx
= urb
->context
;
719 struct usb_ctrlrequest
*reqp
;
720 struct subcase
*subcase
;
721 int status
= urb
->status
;
723 reqp
= (struct usb_ctrlrequest
*)urb
->setup_packet
;
724 subcase
= container_of (reqp
, struct subcase
, setup
);
726 spin_lock (&ctx
->lock
);
730 /* queue must transfer and complete in fifo order, unless
731 * usb_unlink_urb() is used to unlink something not at the
732 * physical queue head (not tested).
734 if (subcase
->number
> 0) {
735 if ((subcase
->number
- ctx
->last
) != 1) {
737 "subcase %d completed out of order, last %d\n",
738 subcase
->number
, ctx
->last
);
740 ctx
->last
= subcase
->number
;
744 ctx
->last
= subcase
->number
;
746 /* succeed or fault in only one way? */
747 if (status
== subcase
->expected
)
750 /* async unlink for cleanup? */
751 else if (status
!= -ECONNRESET
) {
753 /* some faults are allowed, not required */
754 if (subcase
->expected
> 0 && (
755 ((status
== -subcase
->expected
/* happened */
756 || status
== 0)))) /* didn't */
758 /* sometimes more than one fault is allowed */
759 else if (subcase
->number
== 12 && status
== -EPIPE
)
762 ERROR(ctx
->dev
, "subtest %d error, status %d\n",
763 subcase
->number
, status
);
766 /* unexpected status codes mean errors; ideally, in hardware */
769 if (ctx
->status
== 0) {
772 ctx
->status
= status
;
773 ERROR(ctx
->dev
, "control queue %02x.%02x, err %d, "
774 "%d left, subcase %d, len %d/%d\n",
775 reqp
->bRequestType
, reqp
->bRequest
,
776 status
, ctx
->count
, subcase
->number
,
778 urb
->transfer_buffer_length
);
780 /* FIXME this "unlink everything" exit route should
781 * be a separate test case.
784 /* unlink whatever's still pending */
785 for (i
= 1; i
< ctx
->param
->sglen
; i
++) {
786 struct urb
*u
= ctx
->urb
[
787 (i
+ subcase
->number
)
788 % ctx
->param
->sglen
];
790 if (u
== urb
|| !u
->dev
)
792 spin_unlock(&ctx
->lock
);
793 status
= usb_unlink_urb (u
);
794 spin_lock(&ctx
->lock
);
801 ERROR(ctx
->dev
, "urb unlink --> %d\n",
805 status
= ctx
->status
;
809 /* resubmit if we need to, else mark this as done */
810 if ((status
== 0) && (ctx
->pending
< ctx
->count
)) {
811 if ((status
= usb_submit_urb (urb
, GFP_ATOMIC
)) != 0) {
813 "can't resubmit ctrl %02x.%02x, err %d\n",
814 reqp
->bRequestType
, reqp
->bRequest
, status
);
821 /* signal completion when nothing's queued */
822 if (ctx
->pending
== 0)
823 complete (&ctx
->complete
);
824 spin_unlock (&ctx
->lock
);
828 test_ctrl_queue (struct usbtest_dev
*dev
, struct usbtest_param
*param
)
830 struct usb_device
*udev
= testdev_to_usbdev (dev
);
832 struct ctrl_ctx context
;
835 spin_lock_init (&context
.lock
);
837 init_completion (&context
.complete
);
838 context
.count
= param
->sglen
* param
->iterations
;
840 context
.status
= -ENOMEM
;
841 context
.param
= param
;
844 /* allocate and init the urbs we'll queue.
845 * as with bulk/intr sglists, sglen is the queue depth; it also
846 * controls which subtests run (more tests than sglen) or rerun.
848 urb
= kcalloc(param
->sglen
, sizeof(struct urb
*), GFP_KERNEL
);
851 for (i
= 0; i
< param
->sglen
; i
++) {
852 int pipe
= usb_rcvctrlpipe (udev
, 0);
855 struct usb_ctrlrequest req
;
856 struct subcase
*reqp
;
858 /* sign of this variable means:
859 * -: tested code must return this (negative) error code
860 * +: tested code may return this (negative too) error code
864 /* requests here are mostly expected to succeed on any
865 * device, but some are chosen to trigger protocol stalls
868 memset (&req
, 0, sizeof req
);
869 req
.bRequest
= USB_REQ_GET_DESCRIPTOR
;
870 req
.bRequestType
= USB_DIR_IN
|USB_RECIP_DEVICE
;
872 switch (i
% NUM_SUBCASES
) {
873 case 0: // get device descriptor
874 req
.wValue
= cpu_to_le16 (USB_DT_DEVICE
<< 8);
875 len
= sizeof (struct usb_device_descriptor
);
877 case 1: // get first config descriptor (only)
878 req
.wValue
= cpu_to_le16 ((USB_DT_CONFIG
<< 8) | 0);
879 len
= sizeof (struct usb_config_descriptor
);
881 case 2: // get altsetting (OFTEN STALLS)
882 req
.bRequest
= USB_REQ_GET_INTERFACE
;
883 req
.bRequestType
= USB_DIR_IN
|USB_RECIP_INTERFACE
;
884 // index = 0 means first interface
888 case 3: // get interface status
889 req
.bRequest
= USB_REQ_GET_STATUS
;
890 req
.bRequestType
= USB_DIR_IN
|USB_RECIP_INTERFACE
;
894 case 4: // get device status
895 req
.bRequest
= USB_REQ_GET_STATUS
;
896 req
.bRequestType
= USB_DIR_IN
|USB_RECIP_DEVICE
;
899 case 5: // get device qualifier (MAY STALL)
900 req
.wValue
= cpu_to_le16 (USB_DT_DEVICE_QUALIFIER
<< 8);
901 len
= sizeof (struct usb_qualifier_descriptor
);
902 if (udev
->speed
!= USB_SPEED_HIGH
)
905 case 6: // get first config descriptor, plus interface
906 req
.wValue
= cpu_to_le16 ((USB_DT_CONFIG
<< 8) | 0);
907 len
= sizeof (struct usb_config_descriptor
);
908 len
+= sizeof (struct usb_interface_descriptor
);
910 case 7: // get interface descriptor (ALWAYS STALLS)
911 req
.wValue
= cpu_to_le16 (USB_DT_INTERFACE
<< 8);
913 len
= sizeof (struct usb_interface_descriptor
);
916 // NOTE: two consecutive stalls in the queue here.
917 // that tests fault recovery a bit more aggressively.
918 case 8: // clear endpoint halt (MAY STALL)
919 req
.bRequest
= USB_REQ_CLEAR_FEATURE
;
920 req
.bRequestType
= USB_RECIP_ENDPOINT
;
921 // wValue 0 == ep halt
922 // wIndex 0 == ep0 (shouldn't halt!)
924 pipe
= usb_sndctrlpipe (udev
, 0);
927 case 9: // get endpoint status
928 req
.bRequest
= USB_REQ_GET_STATUS
;
929 req
.bRequestType
= USB_DIR_IN
|USB_RECIP_ENDPOINT
;
933 case 10: // trigger short read (EREMOTEIO)
934 req
.wValue
= cpu_to_le16 ((USB_DT_CONFIG
<< 8) | 0);
936 expected
= -EREMOTEIO
;
938 // NOTE: two consecutive _different_ faults in the queue.
939 case 11: // get endpoint descriptor (ALWAYS STALLS)
940 req
.wValue
= cpu_to_le16 (USB_DT_ENDPOINT
<< 8);
942 len
= sizeof (struct usb_interface_descriptor
);
945 // NOTE: sometimes even a third fault in the queue!
946 case 12: // get string 0 descriptor (MAY STALL)
947 req
.wValue
= cpu_to_le16 (USB_DT_STRING
<< 8);
948 // string == 0, for language IDs
949 len
= sizeof (struct usb_interface_descriptor
);
950 // may succeed when > 4 languages
951 expected
= EREMOTEIO
; // or EPIPE, if no strings
953 case 13: // short read, resembling case 10
954 req
.wValue
= cpu_to_le16 ((USB_DT_CONFIG
<< 8) | 0);
955 // last data packet "should" be DATA1, not DATA0
956 len
= 1024 - udev
->descriptor
.bMaxPacketSize0
;
957 expected
= -EREMOTEIO
;
959 case 14: // short read; try to fill the last packet
960 req
.wValue
= cpu_to_le16 ((USB_DT_DEVICE
<< 8) | 0);
961 /* device descriptor size == 18 bytes */
962 len
= udev
->descriptor
.bMaxPacketSize0
;
964 case 8: len
= 24; break;
965 case 16: len
= 32; break;
967 expected
= -EREMOTEIO
;
970 ERROR(dev
, "bogus number of ctrl queue testcases!\n");
971 context
.status
= -EINVAL
;
974 req
.wLength
= cpu_to_le16 (len
);
975 urb
[i
] = u
= simple_alloc_urb (udev
, pipe
, len
);
979 reqp
= usb_buffer_alloc (udev
, sizeof *reqp
, GFP_KERNEL
,
984 reqp
->number
= i
% NUM_SUBCASES
;
985 reqp
->expected
= expected
;
986 u
->setup_packet
= (char *) &reqp
->setup
;
987 u
->transfer_flags
|= URB_NO_SETUP_DMA_MAP
;
989 u
->context
= &context
;
990 u
->complete
= ctrl_complete
;
995 spin_lock_irq (&context
.lock
);
996 for (i
= 0; i
< param
->sglen
; i
++) {
997 context
.status
= usb_submit_urb (urb
[i
], GFP_ATOMIC
);
998 if (context
.status
!= 0) {
999 ERROR(dev
, "can't submit urb[%d], status %d\n",
1001 context
.count
= context
.pending
;
1006 spin_unlock_irq (&context
.lock
);
1008 /* FIXME set timer and time out; provide a disconnect hook */
1010 /* wait for the last one to complete */
1011 if (context
.pending
> 0)
1012 wait_for_completion (&context
.complete
);
1015 for (i
= 0; i
< param
->sglen
; i
++) {
1018 urb
[i
]->dev
= udev
;
1019 if (urb
[i
]->setup_packet
)
1020 usb_buffer_free (udev
, sizeof (struct usb_ctrlrequest
),
1021 urb
[i
]->setup_packet
,
1022 urb
[i
]->setup_dma
);
1023 simple_free_urb (urb
[i
]);
1026 return context
.status
;
1031 /*-------------------------------------------------------------------------*/
1033 static void unlink1_callback (struct urb
*urb
)
1035 int status
= urb
->status
;
1037 // we "know" -EPIPE (stall) never happens
1039 status
= usb_submit_urb (urb
, GFP_ATOMIC
);
1041 urb
->status
= status
;
1042 complete(urb
->context
);
1046 static int unlink1 (struct usbtest_dev
*dev
, int pipe
, int size
, int async
)
1049 struct completion completion
;
1052 init_completion (&completion
);
1053 urb
= simple_alloc_urb (testdev_to_usbdev (dev
), pipe
, size
);
1056 urb
->context
= &completion
;
1057 urb
->complete
= unlink1_callback
;
1059 /* keep the endpoint busy. there are lots of hc/hcd-internal
1060 * states, and testing should get to all of them over time.
1062 * FIXME want additional tests for when endpoint is STALLing
1063 * due to errors, or is just NAKing requests.
1065 if ((retval
= usb_submit_urb (urb
, GFP_KERNEL
)) != 0) {
1066 dev_err(&dev
->intf
->dev
, "submit fail %d\n", retval
);
1070 /* unlinking that should always work. variable delay tests more
1071 * hcd states and code paths, even with little other system load.
1073 msleep (jiffies
% (2 * INTERRUPT_RATE
));
1075 while (!completion_done(&completion
)) {
1076 retval
= usb_unlink_urb(urb
);
1081 /* we can't unlink urbs while they're completing
1082 * or if they've completed, and we haven't
1083 * resubmitted. "normal" drivers would prevent
1084 * resubmission, but since we're testing unlink
1087 ERROR(dev
, "unlink retry\n");
1094 dev_err(&dev
->intf
->dev
,
1095 "unlink fail %d\n", retval
);
1104 wait_for_completion (&completion
);
1105 retval
= urb
->status
;
1106 simple_free_urb (urb
);
1109 return (retval
== -ECONNRESET
) ? 0 : retval
- 1000;
1111 return (retval
== -ENOENT
|| retval
== -EPERM
) ?
1115 static int unlink_simple (struct usbtest_dev
*dev
, int pipe
, int len
)
1119 /* test sync and async paths */
1120 retval
= unlink1 (dev
, pipe
, len
, 1);
1122 retval
= unlink1 (dev
, pipe
, len
, 0);
1126 /*-------------------------------------------------------------------------*/
1128 static int verify_not_halted(struct usbtest_dev
*tdev
, int ep
, struct urb
*urb
)
1133 /* shouldn't look or act halted */
1134 retval
= usb_get_status (urb
->dev
, USB_RECIP_ENDPOINT
, ep
, &status
);
1136 ERROR(tdev
, "ep %02x couldn't get no-halt status, %d\n",
1141 ERROR(tdev
, "ep %02x bogus status: %04x != 0\n", ep
, status
);
1144 retval
= simple_io(tdev
, urb
, 1, 0, 0, __func__
);
1150 static int verify_halted(struct usbtest_dev
*tdev
, int ep
, struct urb
*urb
)
1155 /* should look and act halted */
1156 retval
= usb_get_status (urb
->dev
, USB_RECIP_ENDPOINT
, ep
, &status
);
1158 ERROR(tdev
, "ep %02x couldn't get halt status, %d\n",
1162 le16_to_cpus(&status
);
1164 ERROR(tdev
, "ep %02x bogus status: %04x != 1\n", ep
, status
);
1167 retval
= simple_io(tdev
, urb
, 1, 0, -EPIPE
, __func__
);
1168 if (retval
!= -EPIPE
)
1170 retval
= simple_io(tdev
, urb
, 1, 0, -EPIPE
, "verify_still_halted");
1171 if (retval
!= -EPIPE
)
1176 static int test_halt(struct usbtest_dev
*tdev
, int ep
, struct urb
*urb
)
1180 /* shouldn't look or act halted now */
1181 retval
= verify_not_halted(tdev
, ep
, urb
);
1185 /* set halt (protocol test only), verify it worked */
1186 retval
= usb_control_msg (urb
->dev
, usb_sndctrlpipe (urb
->dev
, 0),
1187 USB_REQ_SET_FEATURE
, USB_RECIP_ENDPOINT
,
1188 USB_ENDPOINT_HALT
, ep
,
1189 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
1191 ERROR(tdev
, "ep %02x couldn't set halt, %d\n", ep
, retval
);
1194 retval
= verify_halted(tdev
, ep
, urb
);
1198 /* clear halt (tests API + protocol), verify it worked */
1199 retval
= usb_clear_halt (urb
->dev
, urb
->pipe
);
1201 ERROR(tdev
, "ep %02x couldn't clear halt, %d\n", ep
, retval
);
1204 retval
= verify_not_halted(tdev
, ep
, urb
);
1208 /* NOTE: could also verify SET_INTERFACE clear halts ... */
1213 static int halt_simple (struct usbtest_dev
*dev
)
1219 urb
= simple_alloc_urb (testdev_to_usbdev (dev
), 0, 512);
1224 ep
= usb_pipeendpoint (dev
->in_pipe
) | USB_DIR_IN
;
1225 urb
->pipe
= dev
->in_pipe
;
1226 retval
= test_halt(dev
, ep
, urb
);
1231 if (dev
->out_pipe
) {
1232 ep
= usb_pipeendpoint (dev
->out_pipe
);
1233 urb
->pipe
= dev
->out_pipe
;
1234 retval
= test_halt(dev
, ep
, urb
);
1237 simple_free_urb (urb
);
1241 /*-------------------------------------------------------------------------*/
1243 /* Control OUT tests use the vendor control requests from Intel's
1244 * USB 2.0 compliance test device: write a buffer, read it back.
1246 * Intel's spec only _requires_ that it work for one packet, which
1247 * is pretty weak. Some HCDs place limits here; most devices will
1248 * need to be able to handle more than one OUT data packet. We'll
1249 * try whatever we're told to try.
1251 static int ctrl_out (struct usbtest_dev
*dev
,
1252 unsigned count
, unsigned length
, unsigned vary
)
1258 struct usb_device
*udev
;
1260 if (length
< 1 || length
> 0xffff || vary
>= length
)
1263 buf
= kmalloc(length
, GFP_KERNEL
);
1267 udev
= testdev_to_usbdev (dev
);
1271 /* NOTE: hardware might well act differently if we pushed it
1272 * with lots back-to-back queued requests.
1274 for (i
= 0; i
< count
; i
++) {
1275 /* write patterned data */
1276 for (j
= 0; j
< len
; j
++)
1278 retval
= usb_control_msg (udev
, usb_sndctrlpipe (udev
,0),
1279 0x5b, USB_DIR_OUT
|USB_TYPE_VENDOR
,
1280 0, 0, buf
, len
, USB_CTRL_SET_TIMEOUT
);
1281 if (retval
!= len
) {
1284 ERROR(dev
, "ctrl_out, wlen %d (expected %d)\n",
1291 /* read it back -- assuming nothing intervened!! */
1292 retval
= usb_control_msg (udev
, usb_rcvctrlpipe (udev
,0),
1293 0x5c, USB_DIR_IN
|USB_TYPE_VENDOR
,
1294 0, 0, buf
, len
, USB_CTRL_GET_TIMEOUT
);
1295 if (retval
!= len
) {
1298 ERROR(dev
, "ctrl_out, rlen %d (expected %d)\n",
1305 /* fail if we can't verify */
1306 for (j
= 0; j
< len
; j
++) {
1307 if (buf
[j
] != (u8
) (i
+ j
)) {
1308 ERROR(dev
, "ctrl_out, byte %d is %d not %d\n",
1309 j
, buf
[j
], (u8
) i
+ j
);
1321 /* [real world] the "zero bytes IN" case isn't really used.
1322 * hardware can easily trip up in this weird case, since its
1323 * status stage is IN, not OUT like other ep0in transfers.
1326 len
= realworld
? 1 : 0;
1330 ERROR (dev
, "ctrl_out %s failed, code %d, count %d\n",
1337 /*-------------------------------------------------------------------------*/
1339 /* ISO tests ... mimics common usage
1340 * - buffer length is split into N packets (mostly maxpacket sized)
1341 * - multi-buffers according to sglen
1344 struct iso_context
{
1348 struct completion done
;
1350 unsigned long errors
;
1351 unsigned long packet_count
;
1352 struct usbtest_dev
*dev
;
1355 static void iso_callback (struct urb
*urb
)
1357 struct iso_context
*ctx
= urb
->context
;
1359 spin_lock(&ctx
->lock
);
1362 ctx
->packet_count
+= urb
->number_of_packets
;
1363 if (urb
->error_count
> 0)
1364 ctx
->errors
+= urb
->error_count
;
1365 else if (urb
->status
!= 0)
1366 ctx
->errors
+= urb
->number_of_packets
;
1368 if (urb
->status
== 0 && ctx
->count
> (ctx
->pending
- 1)
1369 && !ctx
->submit_error
) {
1370 int status
= usb_submit_urb (urb
, GFP_ATOMIC
);
1375 dev_err(&ctx
->dev
->intf
->dev
,
1376 "iso resubmit err %d\n",
1379 case -ENODEV
: /* disconnected */
1380 case -ESHUTDOWN
: /* endpoint disabled */
1381 ctx
->submit_error
= 1;
1387 if (ctx
->pending
== 0) {
1389 dev_err(&ctx
->dev
->intf
->dev
,
1390 "iso test, %lu errors out of %lu\n",
1391 ctx
->errors
, ctx
->packet_count
);
1392 complete (&ctx
->done
);
1395 spin_unlock(&ctx
->lock
);
1398 static struct urb
*iso_alloc_urb (
1399 struct usb_device
*udev
,
1401 struct usb_endpoint_descriptor
*desc
,
1406 unsigned i
, maxp
, packets
;
1408 if (bytes
< 0 || !desc
)
1410 maxp
= 0x7ff & le16_to_cpu(desc
->wMaxPacketSize
);
1411 maxp
*= 1 + (0x3 & (le16_to_cpu(desc
->wMaxPacketSize
) >> 11));
1412 packets
= DIV_ROUND_UP(bytes
, maxp
);
1414 urb
= usb_alloc_urb (packets
, GFP_KERNEL
);
1420 urb
->number_of_packets
= packets
;
1421 urb
->transfer_buffer_length
= bytes
;
1422 urb
->transfer_buffer
= usb_buffer_alloc (udev
, bytes
, GFP_KERNEL
,
1423 &urb
->transfer_dma
);
1424 if (!urb
->transfer_buffer
) {
1428 memset (urb
->transfer_buffer
, 0, bytes
);
1429 for (i
= 0; i
< packets
; i
++) {
1430 /* here, only the last packet will be short */
1431 urb
->iso_frame_desc
[i
].length
= min ((unsigned) bytes
, maxp
);
1432 bytes
-= urb
->iso_frame_desc
[i
].length
;
1434 urb
->iso_frame_desc
[i
].offset
= maxp
* i
;
1437 urb
->complete
= iso_callback
;
1438 // urb->context = SET BY CALLER
1439 urb
->interval
= 1 << (desc
->bInterval
- 1);
1440 urb
->transfer_flags
= URB_ISO_ASAP
| URB_NO_TRANSFER_DMA_MAP
;
1445 test_iso_queue (struct usbtest_dev
*dev
, struct usbtest_param
*param
,
1446 int pipe
, struct usb_endpoint_descriptor
*desc
)
1448 struct iso_context context
;
1449 struct usb_device
*udev
;
1451 unsigned long packets
= 0;
1453 struct urb
*urbs
[10]; /* FIXME no limit */
1455 if (param
->sglen
> 10)
1458 memset(&context
, 0, sizeof context
);
1459 context
.count
= param
->iterations
* param
->sglen
;
1461 init_completion (&context
.done
);
1462 spin_lock_init (&context
.lock
);
1464 memset (urbs
, 0, sizeof urbs
);
1465 udev
= testdev_to_usbdev (dev
);
1466 dev_info(&dev
->intf
->dev
,
1467 "... iso period %d %sframes, wMaxPacket %04x\n",
1468 1 << (desc
->bInterval
- 1),
1469 (udev
->speed
== USB_SPEED_HIGH
) ? "micro" : "",
1470 le16_to_cpu(desc
->wMaxPacketSize
));
1472 for (i
= 0; i
< param
->sglen
; i
++) {
1473 urbs
[i
] = iso_alloc_urb (udev
, pipe
, desc
,
1479 packets
+= urbs
[i
]->number_of_packets
;
1480 urbs
[i
]->context
= &context
;
1482 packets
*= param
->iterations
;
1483 dev_info(&dev
->intf
->dev
,
1484 "... total %lu msec (%lu packets)\n",
1485 (packets
* (1 << (desc
->bInterval
- 1)))
1486 / ((udev
->speed
== USB_SPEED_HIGH
) ? 8 : 1),
1489 spin_lock_irq (&context
.lock
);
1490 for (i
= 0; i
< param
->sglen
; i
++) {
1492 status
= usb_submit_urb (urbs
[i
], GFP_ATOMIC
);
1494 ERROR (dev
, "submit iso[%d], error %d\n", i
, status
);
1496 spin_unlock_irq (&context
.lock
);
1500 simple_free_urb (urbs
[i
]);
1503 context
.submit_error
= 1;
1507 spin_unlock_irq (&context
.lock
);
1509 wait_for_completion (&context
.done
);
1511 for (i
= 0; i
< param
->sglen
; i
++) {
1513 simple_free_urb(urbs
[i
]);
1516 * Isochronous transfers are expected to fail sometimes. As an
1517 * arbitrary limit, we will report an error if any submissions
1518 * fail or if the transfer failure rate is > 10%.
1522 else if (context
.submit_error
)
1524 else if (context
.errors
> context
.packet_count
/ 10)
1529 for (i
= 0; i
< param
->sglen
; i
++) {
1531 simple_free_urb (urbs
[i
]);
1536 /*-------------------------------------------------------------------------*/
1538 /* We only have this one interface to user space, through usbfs.
1539 * User mode code can scan usbfs to find N different devices (maybe on
1540 * different busses) to use when testing, and allocate one thread per
1541 * test. So discovery is simplified, and we have no device naming issues.
1543 * Don't use these only as stress/load tests. Use them along with with
1544 * other USB bus activity: plugging, unplugging, mousing, mp3 playback,
1545 * video capture, and so on. Run different tests at different times, in
1546 * different sequences. Nothing here should interact with other devices,
1547 * except indirectly by consuming USB bandwidth and CPU resources for test
1548 * threads and request completion. But the only way to know that for sure
1549 * is to test when HC queues are in use by many devices.
1551 * WARNING: Because usbfs grabs udev->dev.sem before calling this ioctl(),
1552 * it locks out usbcore in certain code paths. Notably, if you disconnect
1553 * the device-under-test, khubd will wait block forever waiting for the
1554 * ioctl to complete ... so that usb_disconnect() can abort the pending
1555 * urbs and then call usbtest_disconnect(). To abort a test, you're best
1556 * off just killing the userspace task and waiting for it to exit.
1560 usbtest_ioctl (struct usb_interface
*intf
, unsigned int code
, void *buf
)
1562 struct usbtest_dev
*dev
= usb_get_intfdata (intf
);
1563 struct usb_device
*udev
= testdev_to_usbdev (dev
);
1564 struct usbtest_param
*param
= buf
;
1565 int retval
= -EOPNOTSUPP
;
1567 struct scatterlist
*sg
;
1568 struct usb_sg_request req
;
1569 struct timeval start
;
1572 // FIXME USBDEVFS_CONNECTINFO doesn't say how fast the device is.
1574 if (code
!= USBTEST_REQUEST
)
1577 if (param
->iterations
<= 0)
1580 if (mutex_lock_interruptible(&dev
->lock
))
1581 return -ERESTARTSYS
;
1583 /* FIXME: What if a system sleep starts while a test is running? */
1584 if (!intf
->is_active
) {
1585 mutex_unlock(&dev
->lock
);
1586 return -EHOSTUNREACH
;
1589 /* some devices, like ez-usb default devices, need a non-default
1590 * altsetting to have any active endpoints. some tests change
1591 * altsettings; force a default so most tests don't need to check.
1593 if (dev
->info
->alt
>= 0) {
1596 if (intf
->altsetting
->desc
.bInterfaceNumber
) {
1597 mutex_unlock(&dev
->lock
);
1600 res
= set_altsetting (dev
, dev
->info
->alt
);
1602 dev_err (&intf
->dev
,
1603 "set altsetting to %d failed, %d\n",
1604 dev
->info
->alt
, res
);
1605 mutex_unlock(&dev
->lock
);
1611 * Just a bunch of test cases that every HCD is expected to handle.
1613 * Some may need specific firmware, though it'd be good to have
1614 * one firmware image to handle all the test cases.
1616 * FIXME add more tests! cancel requests, verify the data, control
1617 * queueing, concurrent read+write threads, and so on.
1619 do_gettimeofday (&start
);
1620 switch (param
->test_num
) {
1623 dev_info(&intf
->dev
, "TEST 0: NOP\n");
1627 /* Simple non-queued bulk I/O tests */
1629 if (dev
->out_pipe
== 0)
1631 dev_info(&intf
->dev
,
1632 "TEST 1: write %d bytes %u times\n",
1633 param
->length
, param
->iterations
);
1634 urb
= simple_alloc_urb (udev
, dev
->out_pipe
, param
->length
);
1639 // FIRMWARE: bulk sink (maybe accepts short writes)
1640 retval
= simple_io(dev
, urb
, param
->iterations
, 0, 0, "test1");
1641 simple_free_urb (urb
);
1644 if (dev
->in_pipe
== 0)
1646 dev_info(&intf
->dev
,
1647 "TEST 2: read %d bytes %u times\n",
1648 param
->length
, param
->iterations
);
1649 urb
= simple_alloc_urb (udev
, dev
->in_pipe
, param
->length
);
1654 // FIRMWARE: bulk source (maybe generates short writes)
1655 retval
= simple_io(dev
, urb
, param
->iterations
, 0, 0, "test2");
1656 simple_free_urb (urb
);
1659 if (dev
->out_pipe
== 0 || param
->vary
== 0)
1661 dev_info(&intf
->dev
,
1662 "TEST 3: write/%d 0..%d bytes %u times\n",
1663 param
->vary
, param
->length
, param
->iterations
);
1664 urb
= simple_alloc_urb (udev
, dev
->out_pipe
, param
->length
);
1669 // FIRMWARE: bulk sink (maybe accepts short writes)
1670 retval
= simple_io(dev
, urb
, param
->iterations
, param
->vary
,
1672 simple_free_urb (urb
);
1675 if (dev
->in_pipe
== 0 || param
->vary
== 0)
1677 dev_info(&intf
->dev
,
1678 "TEST 4: read/%d 0..%d bytes %u times\n",
1679 param
->vary
, param
->length
, param
->iterations
);
1680 urb
= simple_alloc_urb (udev
, dev
->in_pipe
, param
->length
);
1685 // FIRMWARE: bulk source (maybe generates short writes)
1686 retval
= simple_io(dev
, urb
, param
->iterations
, param
->vary
,
1688 simple_free_urb (urb
);
1691 /* Queued bulk I/O tests */
1693 if (dev
->out_pipe
== 0 || param
->sglen
== 0)
1695 dev_info(&intf
->dev
,
1696 "TEST 5: write %d sglists %d entries of %d bytes\n",
1698 param
->sglen
, param
->length
);
1699 sg
= alloc_sglist (param
->sglen
, param
->length
, 0);
1704 // FIRMWARE: bulk sink (maybe accepts short writes)
1705 retval
= perform_sglist(dev
, param
->iterations
, dev
->out_pipe
,
1706 &req
, sg
, param
->sglen
);
1707 free_sglist (sg
, param
->sglen
);
1711 if (dev
->in_pipe
== 0 || param
->sglen
== 0)
1713 dev_info(&intf
->dev
,
1714 "TEST 6: read %d sglists %d entries of %d bytes\n",
1716 param
->sglen
, param
->length
);
1717 sg
= alloc_sglist (param
->sglen
, param
->length
, 0);
1722 // FIRMWARE: bulk source (maybe generates short writes)
1723 retval
= perform_sglist(dev
, param
->iterations
, dev
->in_pipe
,
1724 &req
, sg
, param
->sglen
);
1725 free_sglist (sg
, param
->sglen
);
1728 if (dev
->out_pipe
== 0 || param
->sglen
== 0 || param
->vary
== 0)
1730 dev_info(&intf
->dev
,
1731 "TEST 7: write/%d %d sglists %d entries 0..%d bytes\n",
1732 param
->vary
, param
->iterations
,
1733 param
->sglen
, param
->length
);
1734 sg
= alloc_sglist (param
->sglen
, param
->length
, param
->vary
);
1739 // FIRMWARE: bulk sink (maybe accepts short writes)
1740 retval
= perform_sglist(dev
, param
->iterations
, dev
->out_pipe
,
1741 &req
, sg
, param
->sglen
);
1742 free_sglist (sg
, param
->sglen
);
1745 if (dev
->in_pipe
== 0 || param
->sglen
== 0 || param
->vary
== 0)
1747 dev_info(&intf
->dev
,
1748 "TEST 8: read/%d %d sglists %d entries 0..%d bytes\n",
1749 param
->vary
, param
->iterations
,
1750 param
->sglen
, param
->length
);
1751 sg
= alloc_sglist (param
->sglen
, param
->length
, param
->vary
);
1756 // FIRMWARE: bulk source (maybe generates short writes)
1757 retval
= perform_sglist(dev
, param
->iterations
, dev
->in_pipe
,
1758 &req
, sg
, param
->sglen
);
1759 free_sglist (sg
, param
->sglen
);
1762 /* non-queued sanity tests for control (chapter 9 subset) */
1765 dev_info(&intf
->dev
,
1766 "TEST 9: ch9 (subset) control tests, %d times\n",
1768 for (i
= param
->iterations
; retval
== 0 && i
--; /* NOP */)
1769 retval
= ch9_postconfig (dev
);
1771 dev_err(&intf
->dev
, "ch9 subset failed, "
1772 "iterations left %d\n", i
);
1775 /* queued control messaging */
1777 if (param
->sglen
== 0)
1780 dev_info(&intf
->dev
,
1781 "TEST 10: queue %d control calls, %d times\n",
1784 retval
= test_ctrl_queue (dev
, param
);
1787 /* simple non-queued unlinks (ring with one urb) */
1789 if (dev
->in_pipe
== 0 || !param
->length
)
1792 dev_info(&intf
->dev
, "TEST 11: unlink %d reads of %d\n",
1793 param
->iterations
, param
->length
);
1794 for (i
= param
->iterations
; retval
== 0 && i
--; /* NOP */)
1795 retval
= unlink_simple (dev
, dev
->in_pipe
,
1798 dev_err(&intf
->dev
, "unlink reads failed %d, "
1799 "iterations left %d\n", retval
, i
);
1802 if (dev
->out_pipe
== 0 || !param
->length
)
1805 dev_info(&intf
->dev
, "TEST 12: unlink %d writes of %d\n",
1806 param
->iterations
, param
->length
);
1807 for (i
= param
->iterations
; retval
== 0 && i
--; /* NOP */)
1808 retval
= unlink_simple (dev
, dev
->out_pipe
,
1811 dev_err(&intf
->dev
, "unlink writes failed %d, "
1812 "iterations left %d\n", retval
, i
);
1817 if (dev
->out_pipe
== 0 && dev
->in_pipe
== 0)
1820 dev_info(&intf
->dev
, "TEST 13: set/clear %d halts\n",
1822 for (i
= param
->iterations
; retval
== 0 && i
--; /* NOP */)
1823 retval
= halt_simple (dev
);
1826 ERROR(dev
, "halts failed, iterations left %d\n", i
);
1829 /* control write tests */
1831 if (!dev
->info
->ctrl_out
)
1833 dev_info(&intf
->dev
, "TEST 14: %d ep0out, %d..%d vary %d\n",
1835 realworld
? 1 : 0, param
->length
,
1837 retval
= ctrl_out(dev
, param
->iterations
,
1838 param
->length
, param
->vary
);
1841 /* iso write tests */
1843 if (dev
->out_iso_pipe
== 0 || param
->sglen
== 0)
1845 dev_info(&intf
->dev
,
1846 "TEST 15: write %d iso, %d entries of %d bytes\n",
1848 param
->sglen
, param
->length
);
1849 // FIRMWARE: iso sink
1850 retval
= test_iso_queue (dev
, param
,
1851 dev
->out_iso_pipe
, dev
->iso_out
);
1854 /* iso read tests */
1856 if (dev
->in_iso_pipe
== 0 || param
->sglen
== 0)
1858 dev_info(&intf
->dev
,
1859 "TEST 16: read %d iso, %d entries of %d bytes\n",
1861 param
->sglen
, param
->length
);
1862 // FIRMWARE: iso source
1863 retval
= test_iso_queue (dev
, param
,
1864 dev
->in_iso_pipe
, dev
->iso_in
);
1867 // FIXME unlink from queue (ring with N urbs)
1869 // FIXME scatterlist cancel (needs helper thread)
1872 do_gettimeofday (¶m
->duration
);
1873 param
->duration
.tv_sec
-= start
.tv_sec
;
1874 param
->duration
.tv_usec
-= start
.tv_usec
;
1875 if (param
->duration
.tv_usec
< 0) {
1876 param
->duration
.tv_usec
+= 1000 * 1000;
1877 param
->duration
.tv_sec
-= 1;
1879 mutex_unlock(&dev
->lock
);
1883 /*-------------------------------------------------------------------------*/
1885 static unsigned force_interrupt
= 0;
1886 module_param (force_interrupt
, uint
, 0);
1887 MODULE_PARM_DESC (force_interrupt
, "0 = test default; else interrupt");
1890 static unsigned short vendor
;
1891 module_param(vendor
, ushort
, 0);
1892 MODULE_PARM_DESC (vendor
, "vendor code (from usb-if)");
1894 static unsigned short product
;
1895 module_param(product
, ushort
, 0);
1896 MODULE_PARM_DESC (product
, "product code (from vendor)");
1900 usbtest_probe (struct usb_interface
*intf
, const struct usb_device_id
*id
)
1902 struct usb_device
*udev
;
1903 struct usbtest_dev
*dev
;
1904 struct usbtest_info
*info
;
1905 char *rtest
, *wtest
;
1906 char *irtest
, *iwtest
;
1908 udev
= interface_to_usbdev (intf
);
1911 /* specify devices by module parameters? */
1912 if (id
->match_flags
== 0) {
1913 /* vendor match required, product match optional */
1914 if (!vendor
|| le16_to_cpu(udev
->descriptor
.idVendor
) != (u16
)vendor
)
1916 if (product
&& le16_to_cpu(udev
->descriptor
.idProduct
) != (u16
)product
)
1918 dev_info(&intf
->dev
, "matched module params, "
1919 "vend=0x%04x prod=0x%04x\n",
1920 le16_to_cpu(udev
->descriptor
.idVendor
),
1921 le16_to_cpu(udev
->descriptor
.idProduct
));
1925 dev
= kzalloc(sizeof(*dev
), GFP_KERNEL
);
1928 info
= (struct usbtest_info
*) id
->driver_info
;
1930 mutex_init(&dev
->lock
);
1934 /* cacheline-aligned scratch for i/o */
1935 if ((dev
->buf
= kmalloc (TBUF_SIZE
, GFP_KERNEL
)) == NULL
) {
1940 /* NOTE this doesn't yet test the handful of difference that are
1941 * visible with high speed interrupts: bigger maxpacket (1K) and
1942 * "high bandwidth" modes (up to 3 packets/uframe).
1945 irtest
= iwtest
= "";
1946 if (force_interrupt
|| udev
->speed
== USB_SPEED_LOW
) {
1948 dev
->in_pipe
= usb_rcvintpipe (udev
, info
->ep_in
);
1952 dev
->out_pipe
= usb_sndintpipe (udev
, info
->ep_out
);
1953 wtest
= " intr-out";
1956 if (info
->autoconf
) {
1959 status
= get_endpoints (dev
, intf
);
1961 WARNING(dev
, "couldn't get endpoints, %d\n",
1965 /* may find bulk or ISO pipes */
1968 dev
->in_pipe
= usb_rcvbulkpipe (udev
,
1971 dev
->out_pipe
= usb_sndbulkpipe (udev
,
1977 wtest
= " bulk-out";
1978 if (dev
->in_iso_pipe
)
1980 if (dev
->out_iso_pipe
)
1981 iwtest
= " iso-out";
1984 usb_set_intfdata (intf
, dev
);
1985 dev_info (&intf
->dev
, "%s\n", info
->name
);
1986 dev_info (&intf
->dev
, "%s speed {control%s%s%s%s%s} tests%s\n",
1988 switch (udev
->speed
) {
1989 case USB_SPEED_LOW
: tmp
= "low"; break;
1990 case USB_SPEED_FULL
: tmp
= "full"; break;
1991 case USB_SPEED_HIGH
: tmp
= "high"; break;
1992 default: tmp
= "unknown"; break;
1994 info
->ctrl_out
? " in/out" : "",
1997 info
->alt
>= 0 ? " (+alt)" : "");
2001 static int usbtest_suspend (struct usb_interface
*intf
, pm_message_t message
)
2006 static int usbtest_resume (struct usb_interface
*intf
)
2012 static void usbtest_disconnect (struct usb_interface
*intf
)
2014 struct usbtest_dev
*dev
= usb_get_intfdata (intf
);
2016 usb_set_intfdata (intf
, NULL
);
2017 dev_dbg (&intf
->dev
, "disconnect\n");
2021 /* Basic testing only needs a device that can source or sink bulk traffic.
2022 * Any device can test control transfers (default with GENERIC binding).
2024 * Several entries work with the default EP0 implementation that's built
2025 * into EZ-USB chips. There's a default vendor ID which can be overridden
2026 * by (very) small config EEPROMS, but otherwise all these devices act
2027 * identically until firmware is loaded: only EP0 works. It turns out
2028 * to be easy to make other endpoints work, without modifying that EP0
2029 * behavior. For now, we expect that kind of firmware.
2032 /* an21xx or fx versions of ez-usb */
2033 static struct usbtest_info ez1_info
= {
2034 .name
= "EZ-USB device",
2040 /* fx2 version of ez-usb */
2041 static struct usbtest_info ez2_info
= {
2042 .name
= "FX2 device",
2048 /* ezusb family device with dedicated usb test firmware,
2050 static struct usbtest_info fw_info
= {
2051 .name
= "usb test device",
2055 .autoconf
= 1, // iso and ctrl_out need autoconf
2057 .iso
= 1, // iso_ep's are #8 in/out
2060 /* peripheral running Linux and 'zero.c' test firmware, or
2061 * its user-mode cousin. different versions of this use
2062 * different hardware with the same vendor/product codes.
2063 * host side MUST rely on the endpoint descriptors.
2065 static struct usbtest_info gz_info
= {
2066 .name
= "Linux gadget zero",
2072 static struct usbtest_info um_info
= {
2073 .name
= "Linux user mode test driver",
2078 static struct usbtest_info um2_info
= {
2079 .name
= "Linux user mode ISO test driver",
2086 /* this is a nice source of high speed bulk data;
2087 * uses an FX2, with firmware provided in the device
2089 static struct usbtest_info ibot2_info
= {
2090 .name
= "iBOT2 webcam",
2097 /* we can use any device to test control traffic */
2098 static struct usbtest_info generic_info
= {
2099 .name
= "Generic USB device",
2105 static struct usb_device_id id_table
[] = {
2107 /*-------------------------------------------------------------*/
2109 /* EZ-USB devices which download firmware to replace (or in our
2110 * case augment) the default device implementation.
2113 /* generic EZ-USB FX controller */
2114 { USB_DEVICE (0x0547, 0x2235),
2115 .driver_info
= (unsigned long) &ez1_info
,
2118 /* CY3671 development board with EZ-USB FX */
2119 { USB_DEVICE (0x0547, 0x0080),
2120 .driver_info
= (unsigned long) &ez1_info
,
2123 /* generic EZ-USB FX2 controller (or development board) */
2124 { USB_DEVICE (0x04b4, 0x8613),
2125 .driver_info
= (unsigned long) &ez2_info
,
2128 /* re-enumerated usb test device firmware */
2129 { USB_DEVICE (0xfff0, 0xfff0),
2130 .driver_info
= (unsigned long) &fw_info
,
2133 /* "Gadget Zero" firmware runs under Linux */
2134 { USB_DEVICE (0x0525, 0xa4a0),
2135 .driver_info
= (unsigned long) &gz_info
,
2138 /* so does a user-mode variant */
2139 { USB_DEVICE (0x0525, 0xa4a4),
2140 .driver_info
= (unsigned long) &um_info
,
2143 /* ... and a user-mode variant that talks iso */
2144 { USB_DEVICE (0x0525, 0xa4a3),
2145 .driver_info
= (unsigned long) &um2_info
,
2149 /* Keyspan 19qi uses an21xx (original EZ-USB) */
2150 // this does not coexist with the real Keyspan 19qi driver!
2151 { USB_DEVICE (0x06cd, 0x010b),
2152 .driver_info
= (unsigned long) &ez1_info
,
2156 /*-------------------------------------------------------------*/
2159 /* iBOT2 makes a nice source of high speed bulk-in data */
2160 // this does not coexist with a real iBOT2 driver!
2161 { USB_DEVICE (0x0b62, 0x0059),
2162 .driver_info
= (unsigned long) &ibot2_info
,
2166 /*-------------------------------------------------------------*/
2169 /* module params can specify devices to use for control tests */
2170 { .driver_info
= (unsigned long) &generic_info
, },
2173 /*-------------------------------------------------------------*/
2177 MODULE_DEVICE_TABLE (usb
, id_table
);
2179 static struct usb_driver usbtest_driver
= {
2181 .id_table
= id_table
,
2182 .probe
= usbtest_probe
,
2183 .ioctl
= usbtest_ioctl
,
2184 .disconnect
= usbtest_disconnect
,
2185 .suspend
= usbtest_suspend
,
2186 .resume
= usbtest_resume
,
2189 /*-------------------------------------------------------------------------*/
2191 static int __init
usbtest_init (void)
2195 pr_debug("params: vend=0x%04x prod=0x%04x\n", vendor
, product
);
2197 return usb_register (&usbtest_driver
);
2199 module_init (usbtest_init
);
2201 static void __exit
usbtest_exit (void)
2203 usb_deregister (&usbtest_driver
);
2205 module_exit (usbtest_exit
);
2207 MODULE_DESCRIPTION ("USB Core/HCD Testing Driver");
2208 MODULE_LICENSE ("GPL");