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 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
)
223 u8
*buf
= urb
->transfer_buffer
;
224 unsigned len
= urb
->transfer_buffer_length
;
230 memset (buf
, 0, len
);
233 for (i
= 0; i
< len
; i
++)
234 *buf
++ = (u8
) (i
% 63);
239 static inline int simple_check_buf(struct usbtest_dev
*tdev
, struct urb
*urb
)
243 u8
*buf
= urb
->transfer_buffer
;
244 unsigned len
= urb
->actual_length
;
246 for (i
= 0; i
< len
; i
++, buf
++) {
248 /* all-zeroes has no synchronization issues */
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.
260 /* always fail unsupported patterns */
265 if (*buf
== expected
)
267 ERROR(tdev
, "buf[%d] = %d (not %d)\n", i
, *buf
, expected
);
273 static void simple_free_urb (struct urb
*urb
)
275 usb_buffer_free (urb
->dev
, urb
->transfer_buffer_length
,
276 urb
->transfer_buffer
, urb
->transfer_dma
);
280 static int simple_io (
281 struct usbtest_dev
*tdev
,
289 struct usb_device
*udev
= urb
->dev
;
290 int max
= urb
->transfer_buffer_length
;
291 struct completion completion
;
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)
302 /* NOTE: no timeouts; can't be broken out of by interrupt */
303 wait_for_completion (&completion
);
304 retval
= urb
->status
;
306 if (retval
== 0 && usb_pipein (urb
->pipe
))
307 retval
= simple_check_buf(tdev
, urb
);
310 int len
= urb
->transfer_buffer_length
;
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
)
325 "%s failed, iterations left %d, status %d (not %d)\n",
326 label
, iterations
, retval
, expected
);
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
)
343 for (i
= 0; i
< nents
; i
++) {
344 if (!sg_page(&sg
[i
]))
346 kfree (sg_virt(&sg
[i
]));
351 static struct scatterlist
*
352 alloc_sglist (int nents
, int max
, int vary
)
354 struct scatterlist
*sg
;
358 sg
= kmalloc (nents
* sizeof *sg
, GFP_KERNEL
);
361 sg_init_table(sg
, nents
);
363 for (i
= 0; i
< nents
; i
++) {
367 buf
= kzalloc (size
, GFP_KERNEL
);
373 /* kmalloc pages are always physically contiguous! */
374 sg_set_buf(&sg
[i
], buf
, size
);
381 for (j
= 0; j
< size
; j
++)
382 *buf
++ = (u8
) (j
% 63);
390 size
= (vary
< max
) ? vary
: max
;
397 static int perform_sglist (
398 struct usbtest_dev
*tdev
,
401 struct usb_sg_request
*req
,
402 struct scatterlist
*sg
,
406 struct usb_device
*udev
= testdev_to_usbdev(tdev
);
409 while (retval
== 0 && iterations
-- > 0) {
410 retval
= usb_sg_init (req
, udev
, pipe
,
411 (udev
->speed
== USB_SPEED_HIGH
)
412 ? (INTERRUPT_RATE
<< 3)
414 sg
, nents
, 0, GFP_KERNEL
);
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 ...
430 ERROR(tdev
, "perform_sglist failed, "
431 "iterations left %d, status %d\n",
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
);
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
);
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)
484 udev
= interface_to_usbdev (iface
);
485 return usb_set_interface (udev
,
486 iface
->altsetting
[0].desc
.bInterfaceNumber
,
490 static int is_good_config(struct usbtest_dev
*tdev
, int len
)
492 struct usb_config_descriptor
*config
;
494 if (len
< sizeof *config
)
496 config
= (struct usb_config_descriptor
*) tdev
->buf
;
498 switch (config
->bDescriptorType
) {
500 case USB_DT_OTHER_SPEED_CONFIG
:
501 if (config
->bLength
!= 9) {
502 ERROR(tdev
, "bogus config descriptor length\n");
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");
510 if (config
->bmAttributes
& 0x1f) { /* reserved == 0 */
511 ERROR(tdev
, "reserved config bits set\n");
519 if (le16_to_cpu(config
->wTotalLength
) == len
) /* read it all */
521 if (le16_to_cpu(config
->wTotalLength
) >= TBUF_SIZE
) /* max partial read */
523 ERROR(tdev
, "bogus config descriptor read size\n");
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
);
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
) {
557 "invalid alt [%d].bAltSetting = %d\n",
561 /* [real world] get/set unimplemented if there's only one */
562 if (realworld
&& iface
->num_altsetting
== 1)
565 /* [9.4.10] set_interface */
566 retval
= set_altsetting (dev
, alt
);
568 dev_err(&iface
->dev
, "can't set_interface = %d, %d\n",
573 /* [9.4.4] get_interface always works */
574 retval
= get_altsetting (dev
);
576 dev_err(&iface
->dev
, "get alt should be %d, was %d\n",
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
)) {
616 "config [%d] descriptor --> %d\n",
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
) {
636 "hs dev qualifier --> %d\n",
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
;
645 d
= (struct usb_qualifier_descriptor
*) dev
->buf
;
647 /* might not have [9.6.2] any other-speed configs [9.6.4] */
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
)) {
656 "other speed config --> %d\n",
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
);
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
);
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
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
699 struct usbtest_dev
*dev
;
700 struct completion complete
;
705 struct usbtest_param
*param
;
709 #define NUM_SUBCASES 15 /* how many test subcases here? */
712 struct usb_ctrlrequest setup
;
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
);
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) {
738 "subcase %d completed out of order, last %d\n",
739 subcase
->number
, ctx
->last
);
741 ctx
->last
= subcase
->number
;
745 ctx
->last
= subcase
->number
;
747 /* succeed or fault in only one way? */
748 if (status
== subcase
->expected
)
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 */
759 /* sometimes more than one fault is allowed */
760 else if (subcase
->number
== 12 && status
== -EPIPE
)
763 ERROR(ctx
->dev
, "subtest %d error, status %d\n",
764 subcase
->number
, status
);
767 /* unexpected status codes mean errors; ideally, in hardware */
770 if (ctx
->status
== 0) {
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
,
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
)
793 spin_unlock(&ctx
->lock
);
794 status
= usb_unlink_urb (u
);
795 spin_lock(&ctx
->lock
);
802 ERROR(ctx
->dev
, "urb unlink --> %d\n",
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) {
814 "can't resubmit ctrl %02x.%02x, err %d\n",
815 reqp
->bRequestType
, reqp
->bRequest
, status
);
822 /* signal completion when nothing's queued */
823 if (ctx
->pending
== 0)
824 complete (&ctx
->complete
);
825 spin_unlock (&ctx
->lock
);
829 test_ctrl_queue (struct usbtest_dev
*dev
, struct usbtest_param
*param
)
831 struct usb_device
*udev
= testdev_to_usbdev (dev
);
833 struct ctrl_ctx context
;
836 spin_lock_init (&context
.lock
);
838 init_completion (&context
.complete
);
839 context
.count
= param
->sglen
* param
->iterations
;
841 context
.status
= -ENOMEM
;
842 context
.param
= param
;
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
);
852 for (i
= 0; i
< param
->sglen
; i
++) {
853 int pipe
= usb_rcvctrlpipe (udev
, 0);
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
865 /* requests here are mostly expected to succeed on any
866 * device, but some are chosen to trigger protocol stalls
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
);
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
);
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
889 case 3: // get interface status
890 req
.bRequest
= USB_REQ_GET_STATUS
;
891 req
.bRequestType
= USB_DIR_IN
|USB_RECIP_INTERFACE
;
895 case 4: // get device status
896 req
.bRequest
= USB_REQ_GET_STATUS
;
897 req
.bRequestType
= USB_DIR_IN
|USB_RECIP_DEVICE
;
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
)
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
);
911 case 7: // get interface descriptor (ALWAYS STALLS)
912 req
.wValue
= cpu_to_le16 (USB_DT_INTERFACE
<< 8);
914 len
= sizeof (struct usb_interface_descriptor
);
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!)
925 pipe
= usb_sndctrlpipe (udev
, 0);
928 case 9: // get endpoint status
929 req
.bRequest
= USB_REQ_GET_STATUS
;
930 req
.bRequestType
= USB_DIR_IN
|USB_RECIP_ENDPOINT
;
934 case 10: // trigger short read (EREMOTEIO)
935 req
.wValue
= cpu_to_le16 ((USB_DT_CONFIG
<< 8) | 0);
937 expected
= -EREMOTEIO
;
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);
943 len
= sizeof (struct usb_interface_descriptor
);
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
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
;
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
;
965 case 8: len
= 24; break;
966 case 16: len
= 32; break;
968 expected
= -EREMOTEIO
;
971 ERROR(dev
, "bogus number of ctrl queue testcases!\n");
972 context
.status
= -EINVAL
;
975 req
.wLength
= cpu_to_le16 (len
);
976 urb
[i
] = u
= simple_alloc_urb (udev
, pipe
, len
);
980 reqp
= usb_buffer_alloc (udev
, sizeof *reqp
, GFP_KERNEL
,
985 reqp
->number
= i
% NUM_SUBCASES
;
986 reqp
->expected
= expected
;
987 u
->setup_packet
= (char *) &reqp
->setup
;
988 u
->transfer_flags
|= URB_NO_SETUP_DMA_MAP
;
990 u
->context
= &context
;
991 u
->complete
= ctrl_complete
;
996 spin_lock_irq (&context
.lock
);
997 for (i
= 0; i
< param
->sglen
; i
++) {
998 context
.status
= usb_submit_urb (urb
[i
], GFP_ATOMIC
);
999 if (context
.status
!= 0) {
1000 ERROR(dev
, "can't submit urb[%d], status %d\n",
1002 context
.count
= context
.pending
;
1007 spin_unlock_irq (&context
.lock
);
1009 /* FIXME set timer and time out; provide a disconnect hook */
1011 /* wait for the last one to complete */
1012 if (context
.pending
> 0)
1013 wait_for_completion (&context
.complete
);
1016 for (i
= 0; i
< param
->sglen
; i
++) {
1019 urb
[i
]->dev
= udev
;
1020 if (urb
[i
]->setup_packet
)
1021 usb_buffer_free (udev
, sizeof (struct usb_ctrlrequest
),
1022 urb
[i
]->setup_packet
,
1023 urb
[i
]->setup_dma
);
1024 simple_free_urb (urb
[i
]);
1027 return context
.status
;
1032 /*-------------------------------------------------------------------------*/
1034 static void unlink1_callback (struct urb
*urb
)
1036 int status
= urb
->status
;
1038 // we "know" -EPIPE (stall) never happens
1040 status
= usb_submit_urb (urb
, GFP_ATOMIC
);
1042 urb
->status
= status
;
1043 complete(urb
->context
);
1047 static int unlink1 (struct usbtest_dev
*dev
, int pipe
, int size
, int async
)
1050 struct completion completion
;
1053 init_completion (&completion
);
1054 urb
= simple_alloc_urb (testdev_to_usbdev (dev
), pipe
, size
);
1057 urb
->context
= &completion
;
1058 urb
->complete
= unlink1_callback
;
1060 /* keep the endpoint busy. there are lots of hc/hcd-internal
1061 * states, and testing should get to all of them over time.
1063 * FIXME want additional tests for when endpoint is STALLing
1064 * due to errors, or is just NAKing requests.
1066 if ((retval
= usb_submit_urb (urb
, GFP_KERNEL
)) != 0) {
1067 dev_err(&dev
->intf
->dev
, "submit fail %d\n", retval
);
1071 /* unlinking that should always work. variable delay tests more
1072 * hcd states and code paths, even with little other system load.
1074 msleep (jiffies
% (2 * INTERRUPT_RATE
));
1076 while (!completion_done(&completion
)) {
1077 retval
= usb_unlink_urb(urb
);
1082 /* we can't unlink urbs while they're completing
1083 * or if they've completed, and we haven't
1084 * resubmitted. "normal" drivers would prevent
1085 * resubmission, but since we're testing unlink
1088 ERROR(dev
, "unlink retry\n");
1095 dev_err(&dev
->intf
->dev
,
1096 "unlink fail %d\n", retval
);
1105 wait_for_completion (&completion
);
1106 retval
= urb
->status
;
1107 simple_free_urb (urb
);
1110 return (retval
== -ECONNRESET
) ? 0 : retval
- 1000;
1112 return (retval
== -ENOENT
|| retval
== -EPERM
) ?
1116 static int unlink_simple (struct usbtest_dev
*dev
, int pipe
, int len
)
1120 /* test sync and async paths */
1121 retval
= unlink1 (dev
, pipe
, len
, 1);
1123 retval
= unlink1 (dev
, pipe
, len
, 0);
1127 /*-------------------------------------------------------------------------*/
1129 static int verify_not_halted(struct usbtest_dev
*tdev
, int ep
, struct urb
*urb
)
1134 /* shouldn't look or act halted */
1135 retval
= usb_get_status (urb
->dev
, USB_RECIP_ENDPOINT
, ep
, &status
);
1137 ERROR(tdev
, "ep %02x couldn't get no-halt status, %d\n",
1142 ERROR(tdev
, "ep %02x bogus status: %04x != 0\n", ep
, status
);
1145 retval
= simple_io(tdev
, urb
, 1, 0, 0, __func__
);
1151 static int verify_halted(struct usbtest_dev
*tdev
, int ep
, struct urb
*urb
)
1156 /* should look and act halted */
1157 retval
= usb_get_status (urb
->dev
, USB_RECIP_ENDPOINT
, ep
, &status
);
1159 ERROR(tdev
, "ep %02x couldn't get halt status, %d\n",
1163 le16_to_cpus(&status
);
1165 ERROR(tdev
, "ep %02x bogus status: %04x != 1\n", ep
, status
);
1168 retval
= simple_io(tdev
, urb
, 1, 0, -EPIPE
, __func__
);
1169 if (retval
!= -EPIPE
)
1171 retval
= simple_io(tdev
, urb
, 1, 0, -EPIPE
, "verify_still_halted");
1172 if (retval
!= -EPIPE
)
1177 static int test_halt(struct usbtest_dev
*tdev
, int ep
, struct urb
*urb
)
1181 /* shouldn't look or act halted now */
1182 retval
= verify_not_halted(tdev
, ep
, urb
);
1186 /* set halt (protocol test only), verify it worked */
1187 retval
= usb_control_msg (urb
->dev
, usb_sndctrlpipe (urb
->dev
, 0),
1188 USB_REQ_SET_FEATURE
, USB_RECIP_ENDPOINT
,
1189 USB_ENDPOINT_HALT
, ep
,
1190 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
1192 ERROR(tdev
, "ep %02x couldn't set halt, %d\n", ep
, retval
);
1195 retval
= verify_halted(tdev
, ep
, urb
);
1199 /* clear halt (tests API + protocol), verify it worked */
1200 retval
= usb_clear_halt (urb
->dev
, urb
->pipe
);
1202 ERROR(tdev
, "ep %02x couldn't clear halt, %d\n", ep
, retval
);
1205 retval
= verify_not_halted(tdev
, ep
, urb
);
1209 /* NOTE: could also verify SET_INTERFACE clear halts ... */
1214 static int halt_simple (struct usbtest_dev
*dev
)
1220 urb
= simple_alloc_urb (testdev_to_usbdev (dev
), 0, 512);
1225 ep
= usb_pipeendpoint (dev
->in_pipe
) | USB_DIR_IN
;
1226 urb
->pipe
= dev
->in_pipe
;
1227 retval
= test_halt(dev
, ep
, urb
);
1232 if (dev
->out_pipe
) {
1233 ep
= usb_pipeendpoint (dev
->out_pipe
);
1234 urb
->pipe
= dev
->out_pipe
;
1235 retval
= test_halt(dev
, ep
, urb
);
1238 simple_free_urb (urb
);
1242 /*-------------------------------------------------------------------------*/
1244 /* Control OUT tests use the vendor control requests from Intel's
1245 * USB 2.0 compliance test device: write a buffer, read it back.
1247 * Intel's spec only _requires_ that it work for one packet, which
1248 * is pretty weak. Some HCDs place limits here; most devices will
1249 * need to be able to handle more than one OUT data packet. We'll
1250 * try whatever we're told to try.
1252 static int ctrl_out (struct usbtest_dev
*dev
,
1253 unsigned count
, unsigned length
, unsigned vary
)
1259 struct usb_device
*udev
;
1261 if (length
< 1 || length
> 0xffff || vary
>= length
)
1264 buf
= kmalloc(length
, GFP_KERNEL
);
1268 udev
= testdev_to_usbdev (dev
);
1272 /* NOTE: hardware might well act differently if we pushed it
1273 * with lots back-to-back queued requests.
1275 for (i
= 0; i
< count
; i
++) {
1276 /* write patterned data */
1277 for (j
= 0; j
< len
; j
++)
1279 retval
= usb_control_msg (udev
, usb_sndctrlpipe (udev
,0),
1280 0x5b, USB_DIR_OUT
|USB_TYPE_VENDOR
,
1281 0, 0, buf
, len
, USB_CTRL_SET_TIMEOUT
);
1282 if (retval
!= len
) {
1285 ERROR(dev
, "ctrl_out, wlen %d (expected %d)\n",
1292 /* read it back -- assuming nothing intervened!! */
1293 retval
= usb_control_msg (udev
, usb_rcvctrlpipe (udev
,0),
1294 0x5c, USB_DIR_IN
|USB_TYPE_VENDOR
,
1295 0, 0, buf
, len
, USB_CTRL_GET_TIMEOUT
);
1296 if (retval
!= len
) {
1299 ERROR(dev
, "ctrl_out, rlen %d (expected %d)\n",
1306 /* fail if we can't verify */
1307 for (j
= 0; j
< len
; j
++) {
1308 if (buf
[j
] != (u8
) (i
+ j
)) {
1309 ERROR(dev
, "ctrl_out, byte %d is %d not %d\n",
1310 j
, buf
[j
], (u8
) i
+ j
);
1322 /* [real world] the "zero bytes IN" case isn't really used.
1323 * hardware can easily trip up in this weird case, since its
1324 * status stage is IN, not OUT like other ep0in transfers.
1327 len
= realworld
? 1 : 0;
1331 ERROR (dev
, "ctrl_out %s failed, code %d, count %d\n",
1338 /*-------------------------------------------------------------------------*/
1340 /* ISO tests ... mimics common usage
1341 * - buffer length is split into N packets (mostly maxpacket sized)
1342 * - multi-buffers according to sglen
1345 struct iso_context
{
1349 struct completion done
;
1351 unsigned long errors
;
1352 unsigned long packet_count
;
1353 struct usbtest_dev
*dev
;
1356 static void iso_callback (struct urb
*urb
)
1358 struct iso_context
*ctx
= urb
->context
;
1360 spin_lock(&ctx
->lock
);
1363 ctx
->packet_count
+= urb
->number_of_packets
;
1364 if (urb
->error_count
> 0)
1365 ctx
->errors
+= urb
->error_count
;
1366 else if (urb
->status
!= 0)
1367 ctx
->errors
+= urb
->number_of_packets
;
1369 if (urb
->status
== 0 && ctx
->count
> (ctx
->pending
- 1)
1370 && !ctx
->submit_error
) {
1371 int status
= usb_submit_urb (urb
, GFP_ATOMIC
);
1376 dev_err(&ctx
->dev
->intf
->dev
,
1377 "iso resubmit err %d\n",
1380 case -ENODEV
: /* disconnected */
1381 case -ESHUTDOWN
: /* endpoint disabled */
1382 ctx
->submit_error
= 1;
1388 if (ctx
->pending
== 0) {
1390 dev_err(&ctx
->dev
->intf
->dev
,
1391 "iso test, %lu errors out of %lu\n",
1392 ctx
->errors
, ctx
->packet_count
);
1393 complete (&ctx
->done
);
1396 spin_unlock(&ctx
->lock
);
1399 static struct urb
*iso_alloc_urb (
1400 struct usb_device
*udev
,
1402 struct usb_endpoint_descriptor
*desc
,
1407 unsigned i
, maxp
, packets
;
1409 if (bytes
< 0 || !desc
)
1411 maxp
= 0x7ff & le16_to_cpu(desc
->wMaxPacketSize
);
1412 maxp
*= 1 + (0x3 & (le16_to_cpu(desc
->wMaxPacketSize
) >> 11));
1413 packets
= DIV_ROUND_UP(bytes
, maxp
);
1415 urb
= usb_alloc_urb (packets
, GFP_KERNEL
);
1421 urb
->number_of_packets
= packets
;
1422 urb
->transfer_buffer_length
= bytes
;
1423 urb
->transfer_buffer
= usb_buffer_alloc (udev
, bytes
, GFP_KERNEL
,
1424 &urb
->transfer_dma
);
1425 if (!urb
->transfer_buffer
) {
1429 memset (urb
->transfer_buffer
, 0, bytes
);
1430 for (i
= 0; i
< packets
; i
++) {
1431 /* here, only the last packet will be short */
1432 urb
->iso_frame_desc
[i
].length
= min ((unsigned) bytes
, maxp
);
1433 bytes
-= urb
->iso_frame_desc
[i
].length
;
1435 urb
->iso_frame_desc
[i
].offset
= maxp
* i
;
1438 urb
->complete
= iso_callback
;
1439 // urb->context = SET BY CALLER
1440 urb
->interval
= 1 << (desc
->bInterval
- 1);
1441 urb
->transfer_flags
= URB_ISO_ASAP
| URB_NO_TRANSFER_DMA_MAP
;
1446 test_iso_queue (struct usbtest_dev
*dev
, struct usbtest_param
*param
,
1447 int pipe
, struct usb_endpoint_descriptor
*desc
)
1449 struct iso_context context
;
1450 struct usb_device
*udev
;
1452 unsigned long packets
= 0;
1454 struct urb
*urbs
[10]; /* FIXME no limit */
1456 if (param
->sglen
> 10)
1459 memset(&context
, 0, sizeof context
);
1460 context
.count
= param
->iterations
* param
->sglen
;
1462 init_completion (&context
.done
);
1463 spin_lock_init (&context
.lock
);
1465 memset (urbs
, 0, sizeof urbs
);
1466 udev
= testdev_to_usbdev (dev
);
1467 dev_info(&dev
->intf
->dev
,
1468 "... iso period %d %sframes, wMaxPacket %04x\n",
1469 1 << (desc
->bInterval
- 1),
1470 (udev
->speed
== USB_SPEED_HIGH
) ? "micro" : "",
1471 le16_to_cpu(desc
->wMaxPacketSize
));
1473 for (i
= 0; i
< param
->sglen
; i
++) {
1474 urbs
[i
] = iso_alloc_urb (udev
, pipe
, desc
,
1480 packets
+= urbs
[i
]->number_of_packets
;
1481 urbs
[i
]->context
= &context
;
1483 packets
*= param
->iterations
;
1484 dev_info(&dev
->intf
->dev
,
1485 "... total %lu msec (%lu packets)\n",
1486 (packets
* (1 << (desc
->bInterval
- 1)))
1487 / ((udev
->speed
== USB_SPEED_HIGH
) ? 8 : 1),
1490 spin_lock_irq (&context
.lock
);
1491 for (i
= 0; i
< param
->sglen
; i
++) {
1493 status
= usb_submit_urb (urbs
[i
], GFP_ATOMIC
);
1495 ERROR (dev
, "submit iso[%d], error %d\n", i
, status
);
1497 spin_unlock_irq (&context
.lock
);
1501 simple_free_urb (urbs
[i
]);
1504 context
.submit_error
= 1;
1508 spin_unlock_irq (&context
.lock
);
1510 wait_for_completion (&context
.done
);
1512 for (i
= 0; i
< param
->sglen
; i
++) {
1514 simple_free_urb(urbs
[i
]);
1517 * Isochronous transfers are expected to fail sometimes. As an
1518 * arbitrary limit, we will report an error if any submissions
1519 * fail or if the transfer failure rate is > 10%.
1523 else if (context
.submit_error
)
1525 else if (context
.errors
> context
.packet_count
/ 10)
1530 for (i
= 0; i
< param
->sglen
; i
++) {
1532 simple_free_urb (urbs
[i
]);
1537 /*-------------------------------------------------------------------------*/
1539 /* We only have this one interface to user space, through usbfs.
1540 * User mode code can scan usbfs to find N different devices (maybe on
1541 * different busses) to use when testing, and allocate one thread per
1542 * test. So discovery is simplified, and we have no device naming issues.
1544 * Don't use these only as stress/load tests. Use them along with with
1545 * other USB bus activity: plugging, unplugging, mousing, mp3 playback,
1546 * video capture, and so on. Run different tests at different times, in
1547 * different sequences. Nothing here should interact with other devices,
1548 * except indirectly by consuming USB bandwidth and CPU resources for test
1549 * threads and request completion. But the only way to know that for sure
1550 * is to test when HC queues are in use by many devices.
1552 * WARNING: Because usbfs grabs udev->dev.sem before calling this ioctl(),
1553 * it locks out usbcore in certain code paths. Notably, if you disconnect
1554 * the device-under-test, khubd will wait block forever waiting for the
1555 * ioctl to complete ... so that usb_disconnect() can abort the pending
1556 * urbs and then call usbtest_disconnect(). To abort a test, you're best
1557 * off just killing the userspace task and waiting for it to exit.
1561 usbtest_ioctl (struct usb_interface
*intf
, unsigned int code
, void *buf
)
1563 struct usbtest_dev
*dev
= usb_get_intfdata (intf
);
1564 struct usb_device
*udev
= testdev_to_usbdev (dev
);
1565 struct usbtest_param
*param
= buf
;
1566 int retval
= -EOPNOTSUPP
;
1568 struct scatterlist
*sg
;
1569 struct usb_sg_request req
;
1570 struct timeval start
;
1573 // FIXME USBDEVFS_CONNECTINFO doesn't say how fast the device is.
1575 pattern
= mod_pattern
;
1577 if (code
!= USBTEST_REQUEST
)
1580 if (param
->iterations
<= 0)
1583 if (mutex_lock_interruptible(&dev
->lock
))
1584 return -ERESTARTSYS
;
1586 /* FIXME: What if a system sleep starts while a test is running? */
1588 /* some devices, like ez-usb default devices, need a non-default
1589 * altsetting to have any active endpoints. some tests change
1590 * altsettings; force a default so most tests don't need to check.
1592 if (dev
->info
->alt
>= 0) {
1595 if (intf
->altsetting
->desc
.bInterfaceNumber
) {
1596 mutex_unlock(&dev
->lock
);
1599 res
= set_altsetting (dev
, dev
->info
->alt
);
1601 dev_err (&intf
->dev
,
1602 "set altsetting to %d failed, %d\n",
1603 dev
->info
->alt
, res
);
1604 mutex_unlock(&dev
->lock
);
1610 * Just a bunch of test cases that every HCD is expected to handle.
1612 * Some may need specific firmware, though it'd be good to have
1613 * one firmware image to handle all the test cases.
1615 * FIXME add more tests! cancel requests, verify the data, control
1616 * queueing, concurrent read+write threads, and so on.
1618 do_gettimeofday (&start
);
1619 switch (param
->test_num
) {
1622 dev_info(&intf
->dev
, "TEST 0: NOP\n");
1626 /* Simple non-queued bulk I/O tests */
1628 if (dev
->out_pipe
== 0)
1630 dev_info(&intf
->dev
,
1631 "TEST 1: write %d bytes %u times\n",
1632 param
->length
, param
->iterations
);
1633 urb
= simple_alloc_urb (udev
, dev
->out_pipe
, param
->length
);
1638 // FIRMWARE: bulk sink (maybe accepts short writes)
1639 retval
= simple_io(dev
, urb
, param
->iterations
, 0, 0, "test1");
1640 simple_free_urb (urb
);
1643 if (dev
->in_pipe
== 0)
1645 dev_info(&intf
->dev
,
1646 "TEST 2: read %d bytes %u times\n",
1647 param
->length
, param
->iterations
);
1648 urb
= simple_alloc_urb (udev
, dev
->in_pipe
, param
->length
);
1653 // FIRMWARE: bulk source (maybe generates short writes)
1654 retval
= simple_io(dev
, urb
, param
->iterations
, 0, 0, "test2");
1655 simple_free_urb (urb
);
1658 if (dev
->out_pipe
== 0 || param
->vary
== 0)
1660 dev_info(&intf
->dev
,
1661 "TEST 3: write/%d 0..%d bytes %u times\n",
1662 param
->vary
, param
->length
, param
->iterations
);
1663 urb
= simple_alloc_urb (udev
, dev
->out_pipe
, param
->length
);
1668 // FIRMWARE: bulk sink (maybe accepts short writes)
1669 retval
= simple_io(dev
, urb
, param
->iterations
, param
->vary
,
1671 simple_free_urb (urb
);
1674 if (dev
->in_pipe
== 0 || param
->vary
== 0)
1676 dev_info(&intf
->dev
,
1677 "TEST 4: read/%d 0..%d bytes %u times\n",
1678 param
->vary
, param
->length
, param
->iterations
);
1679 urb
= simple_alloc_urb (udev
, dev
->in_pipe
, param
->length
);
1684 // FIRMWARE: bulk source (maybe generates short writes)
1685 retval
= simple_io(dev
, urb
, param
->iterations
, param
->vary
,
1687 simple_free_urb (urb
);
1690 /* Queued bulk I/O tests */
1692 if (dev
->out_pipe
== 0 || param
->sglen
== 0)
1694 dev_info(&intf
->dev
,
1695 "TEST 5: write %d sglists %d entries of %d bytes\n",
1697 param
->sglen
, param
->length
);
1698 sg
= alloc_sglist (param
->sglen
, param
->length
, 0);
1703 // FIRMWARE: bulk sink (maybe accepts short writes)
1704 retval
= perform_sglist(dev
, param
->iterations
, dev
->out_pipe
,
1705 &req
, sg
, param
->sglen
);
1706 free_sglist (sg
, param
->sglen
);
1710 if (dev
->in_pipe
== 0 || param
->sglen
== 0)
1712 dev_info(&intf
->dev
,
1713 "TEST 6: read %d sglists %d entries of %d bytes\n",
1715 param
->sglen
, param
->length
);
1716 sg
= alloc_sglist (param
->sglen
, param
->length
, 0);
1721 // FIRMWARE: bulk source (maybe generates short writes)
1722 retval
= perform_sglist(dev
, param
->iterations
, dev
->in_pipe
,
1723 &req
, sg
, param
->sglen
);
1724 free_sglist (sg
, param
->sglen
);
1727 if (dev
->out_pipe
== 0 || param
->sglen
== 0 || param
->vary
== 0)
1729 dev_info(&intf
->dev
,
1730 "TEST 7: write/%d %d sglists %d entries 0..%d bytes\n",
1731 param
->vary
, param
->iterations
,
1732 param
->sglen
, param
->length
);
1733 sg
= alloc_sglist (param
->sglen
, param
->length
, param
->vary
);
1738 // FIRMWARE: bulk sink (maybe accepts short writes)
1739 retval
= perform_sglist(dev
, param
->iterations
, dev
->out_pipe
,
1740 &req
, sg
, param
->sglen
);
1741 free_sglist (sg
, param
->sglen
);
1744 if (dev
->in_pipe
== 0 || param
->sglen
== 0 || param
->vary
== 0)
1746 dev_info(&intf
->dev
,
1747 "TEST 8: read/%d %d sglists %d entries 0..%d bytes\n",
1748 param
->vary
, param
->iterations
,
1749 param
->sglen
, param
->length
);
1750 sg
= alloc_sglist (param
->sglen
, param
->length
, param
->vary
);
1755 // FIRMWARE: bulk source (maybe generates short writes)
1756 retval
= perform_sglist(dev
, param
->iterations
, dev
->in_pipe
,
1757 &req
, sg
, param
->sglen
);
1758 free_sglist (sg
, param
->sglen
);
1761 /* non-queued sanity tests for control (chapter 9 subset) */
1764 dev_info(&intf
->dev
,
1765 "TEST 9: ch9 (subset) control tests, %d times\n",
1767 for (i
= param
->iterations
; retval
== 0 && i
--; /* NOP */)
1768 retval
= ch9_postconfig (dev
);
1770 dev_err(&intf
->dev
, "ch9 subset failed, "
1771 "iterations left %d\n", i
);
1774 /* queued control messaging */
1776 if (param
->sglen
== 0)
1779 dev_info(&intf
->dev
,
1780 "TEST 10: queue %d control calls, %d times\n",
1783 retval
= test_ctrl_queue (dev
, param
);
1786 /* simple non-queued unlinks (ring with one urb) */
1788 if (dev
->in_pipe
== 0 || !param
->length
)
1791 dev_info(&intf
->dev
, "TEST 11: unlink %d reads of %d\n",
1792 param
->iterations
, param
->length
);
1793 for (i
= param
->iterations
; retval
== 0 && i
--; /* NOP */)
1794 retval
= unlink_simple (dev
, dev
->in_pipe
,
1797 dev_err(&intf
->dev
, "unlink reads failed %d, "
1798 "iterations left %d\n", retval
, i
);
1801 if (dev
->out_pipe
== 0 || !param
->length
)
1804 dev_info(&intf
->dev
, "TEST 12: unlink %d writes of %d\n",
1805 param
->iterations
, param
->length
);
1806 for (i
= param
->iterations
; retval
== 0 && i
--; /* NOP */)
1807 retval
= unlink_simple (dev
, dev
->out_pipe
,
1810 dev_err(&intf
->dev
, "unlink writes failed %d, "
1811 "iterations left %d\n", retval
, i
);
1816 if (dev
->out_pipe
== 0 && dev
->in_pipe
== 0)
1819 dev_info(&intf
->dev
, "TEST 13: set/clear %d halts\n",
1821 for (i
= param
->iterations
; retval
== 0 && i
--; /* NOP */)
1822 retval
= halt_simple (dev
);
1825 ERROR(dev
, "halts failed, iterations left %d\n", i
);
1828 /* control write tests */
1830 if (!dev
->info
->ctrl_out
)
1832 dev_info(&intf
->dev
, "TEST 14: %d ep0out, %d..%d vary %d\n",
1834 realworld
? 1 : 0, param
->length
,
1836 retval
= ctrl_out(dev
, param
->iterations
,
1837 param
->length
, param
->vary
);
1840 /* iso write tests */
1842 if (dev
->out_iso_pipe
== 0 || param
->sglen
== 0)
1844 dev_info(&intf
->dev
,
1845 "TEST 15: write %d iso, %d entries of %d bytes\n",
1847 param
->sglen
, param
->length
);
1848 // FIRMWARE: iso sink
1849 retval
= test_iso_queue (dev
, param
,
1850 dev
->out_iso_pipe
, dev
->iso_out
);
1853 /* iso read tests */
1855 if (dev
->in_iso_pipe
== 0 || param
->sglen
== 0)
1857 dev_info(&intf
->dev
,
1858 "TEST 16: read %d iso, %d entries of %d bytes\n",
1860 param
->sglen
, param
->length
);
1861 // FIRMWARE: iso source
1862 retval
= test_iso_queue (dev
, param
,
1863 dev
->in_iso_pipe
, dev
->iso_in
);
1866 // FIXME unlink from queue (ring with N urbs)
1868 // FIXME scatterlist cancel (needs helper thread)
1871 do_gettimeofday (¶m
->duration
);
1872 param
->duration
.tv_sec
-= start
.tv_sec
;
1873 param
->duration
.tv_usec
-= start
.tv_usec
;
1874 if (param
->duration
.tv_usec
< 0) {
1875 param
->duration
.tv_usec
+= 1000 * 1000;
1876 param
->duration
.tv_sec
-= 1;
1878 mutex_unlock(&dev
->lock
);
1882 /*-------------------------------------------------------------------------*/
1884 static unsigned force_interrupt
= 0;
1885 module_param (force_interrupt
, uint
, 0);
1886 MODULE_PARM_DESC (force_interrupt
, "0 = test default; else interrupt");
1889 static unsigned short vendor
;
1890 module_param(vendor
, ushort
, 0);
1891 MODULE_PARM_DESC (vendor
, "vendor code (from usb-if)");
1893 static unsigned short product
;
1894 module_param(product
, ushort
, 0);
1895 MODULE_PARM_DESC (product
, "product code (from vendor)");
1899 usbtest_probe (struct usb_interface
*intf
, const struct usb_device_id
*id
)
1901 struct usb_device
*udev
;
1902 struct usbtest_dev
*dev
;
1903 struct usbtest_info
*info
;
1904 char *rtest
, *wtest
;
1905 char *irtest
, *iwtest
;
1907 udev
= interface_to_usbdev (intf
);
1910 /* specify devices by module parameters? */
1911 if (id
->match_flags
== 0) {
1912 /* vendor match required, product match optional */
1913 if (!vendor
|| le16_to_cpu(udev
->descriptor
.idVendor
) != (u16
)vendor
)
1915 if (product
&& le16_to_cpu(udev
->descriptor
.idProduct
) != (u16
)product
)
1917 dev_info(&intf
->dev
, "matched module params, "
1918 "vend=0x%04x prod=0x%04x\n",
1919 le16_to_cpu(udev
->descriptor
.idVendor
),
1920 le16_to_cpu(udev
->descriptor
.idProduct
));
1924 dev
= kzalloc(sizeof(*dev
), GFP_KERNEL
);
1927 info
= (struct usbtest_info
*) id
->driver_info
;
1929 mutex_init(&dev
->lock
);
1933 /* cacheline-aligned scratch for i/o */
1934 if ((dev
->buf
= kmalloc (TBUF_SIZE
, GFP_KERNEL
)) == NULL
) {
1939 /* NOTE this doesn't yet test the handful of difference that are
1940 * visible with high speed interrupts: bigger maxpacket (1K) and
1941 * "high bandwidth" modes (up to 3 packets/uframe).
1944 irtest
= iwtest
= "";
1945 if (force_interrupt
|| udev
->speed
== USB_SPEED_LOW
) {
1947 dev
->in_pipe
= usb_rcvintpipe (udev
, info
->ep_in
);
1951 dev
->out_pipe
= usb_sndintpipe (udev
, info
->ep_out
);
1952 wtest
= " intr-out";
1955 if (info
->autoconf
) {
1958 status
= get_endpoints (dev
, intf
);
1960 WARNING(dev
, "couldn't get endpoints, %d\n",
1964 /* may find bulk or ISO pipes */
1967 dev
->in_pipe
= usb_rcvbulkpipe (udev
,
1970 dev
->out_pipe
= usb_sndbulkpipe (udev
,
1976 wtest
= " bulk-out";
1977 if (dev
->in_iso_pipe
)
1979 if (dev
->out_iso_pipe
)
1980 iwtest
= " iso-out";
1983 usb_set_intfdata (intf
, dev
);
1984 dev_info (&intf
->dev
, "%s\n", info
->name
);
1985 dev_info (&intf
->dev
, "%s speed {control%s%s%s%s%s} tests%s\n",
1987 switch (udev
->speed
) {
1988 case USB_SPEED_LOW
: tmp
= "low"; break;
1989 case USB_SPEED_FULL
: tmp
= "full"; break;
1990 case USB_SPEED_HIGH
: tmp
= "high"; break;
1991 default: tmp
= "unknown"; break;
1993 info
->ctrl_out
? " in/out" : "",
1996 info
->alt
>= 0 ? " (+alt)" : "");
2000 static int usbtest_suspend (struct usb_interface
*intf
, pm_message_t message
)
2005 static int usbtest_resume (struct usb_interface
*intf
)
2011 static void usbtest_disconnect (struct usb_interface
*intf
)
2013 struct usbtest_dev
*dev
= usb_get_intfdata (intf
);
2015 usb_set_intfdata (intf
, NULL
);
2016 dev_dbg (&intf
->dev
, "disconnect\n");
2020 /* Basic testing only needs a device that can source or sink bulk traffic.
2021 * Any device can test control transfers (default with GENERIC binding).
2023 * Several entries work with the default EP0 implementation that's built
2024 * into EZ-USB chips. There's a default vendor ID which can be overridden
2025 * by (very) small config EEPROMS, but otherwise all these devices act
2026 * identically until firmware is loaded: only EP0 works. It turns out
2027 * to be easy to make other endpoints work, without modifying that EP0
2028 * behavior. For now, we expect that kind of firmware.
2031 /* an21xx or fx versions of ez-usb */
2032 static struct usbtest_info ez1_info
= {
2033 .name
= "EZ-USB device",
2039 /* fx2 version of ez-usb */
2040 static struct usbtest_info ez2_info
= {
2041 .name
= "FX2 device",
2047 /* ezusb family device with dedicated usb test firmware,
2049 static struct usbtest_info fw_info
= {
2050 .name
= "usb test device",
2054 .autoconf
= 1, // iso and ctrl_out need autoconf
2056 .iso
= 1, // iso_ep's are #8 in/out
2059 /* peripheral running Linux and 'zero.c' test firmware, or
2060 * its user-mode cousin. different versions of this use
2061 * different hardware with the same vendor/product codes.
2062 * host side MUST rely on the endpoint descriptors.
2064 static struct usbtest_info gz_info
= {
2065 .name
= "Linux gadget zero",
2071 static struct usbtest_info um_info
= {
2072 .name
= "Linux user mode test driver",
2077 static struct usbtest_info um2_info
= {
2078 .name
= "Linux user mode ISO test driver",
2085 /* this is a nice source of high speed bulk data;
2086 * uses an FX2, with firmware provided in the device
2088 static struct usbtest_info ibot2_info
= {
2089 .name
= "iBOT2 webcam",
2096 /* we can use any device to test control traffic */
2097 static struct usbtest_info generic_info
= {
2098 .name
= "Generic USB device",
2104 static const struct usb_device_id id_table
[] = {
2106 /*-------------------------------------------------------------*/
2108 /* EZ-USB devices which download firmware to replace (or in our
2109 * case augment) the default device implementation.
2112 /* generic EZ-USB FX controller */
2113 { USB_DEVICE (0x0547, 0x2235),
2114 .driver_info
= (unsigned long) &ez1_info
,
2117 /* CY3671 development board with EZ-USB FX */
2118 { USB_DEVICE (0x0547, 0x0080),
2119 .driver_info
= (unsigned long) &ez1_info
,
2122 /* generic EZ-USB FX2 controller (or development board) */
2123 { USB_DEVICE (0x04b4, 0x8613),
2124 .driver_info
= (unsigned long) &ez2_info
,
2127 /* re-enumerated usb test device firmware */
2128 { USB_DEVICE (0xfff0, 0xfff0),
2129 .driver_info
= (unsigned long) &fw_info
,
2132 /* "Gadget Zero" firmware runs under Linux */
2133 { USB_DEVICE (0x0525, 0xa4a0),
2134 .driver_info
= (unsigned long) &gz_info
,
2137 /* so does a user-mode variant */
2138 { USB_DEVICE (0x0525, 0xa4a4),
2139 .driver_info
= (unsigned long) &um_info
,
2142 /* ... and a user-mode variant that talks iso */
2143 { USB_DEVICE (0x0525, 0xa4a3),
2144 .driver_info
= (unsigned long) &um2_info
,
2148 /* Keyspan 19qi uses an21xx (original EZ-USB) */
2149 // this does not coexist with the real Keyspan 19qi driver!
2150 { USB_DEVICE (0x06cd, 0x010b),
2151 .driver_info
= (unsigned long) &ez1_info
,
2155 /*-------------------------------------------------------------*/
2158 /* iBOT2 makes a nice source of high speed bulk-in data */
2159 // this does not coexist with a real iBOT2 driver!
2160 { USB_DEVICE (0x0b62, 0x0059),
2161 .driver_info
= (unsigned long) &ibot2_info
,
2165 /*-------------------------------------------------------------*/
2168 /* module params can specify devices to use for control tests */
2169 { .driver_info
= (unsigned long) &generic_info
, },
2172 /*-------------------------------------------------------------*/
2176 MODULE_DEVICE_TABLE (usb
, id_table
);
2178 static struct usb_driver usbtest_driver
= {
2180 .id_table
= id_table
,
2181 .probe
= usbtest_probe
,
2182 .ioctl
= usbtest_ioctl
,
2183 .disconnect
= usbtest_disconnect
,
2184 .suspend
= usbtest_suspend
,
2185 .resume
= usbtest_resume
,
2188 /*-------------------------------------------------------------------------*/
2190 static int __init
usbtest_init (void)
2194 pr_debug("params: vend=0x%04x prod=0x%04x\n", vendor
, product
);
2196 return usb_register (&usbtest_driver
);
2198 module_init (usbtest_init
);
2200 static void __exit
usbtest_exit (void)
2202 usb_deregister (&usbtest_driver
);
2204 module_exit (usbtest_exit
);
2206 MODULE_DESCRIPTION ("USB Core/HCD Testing Driver");
2207 MODULE_LICENSE ("GPL");