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 static int override_alt
= -1;
17 module_param_named(alt
, override_alt
, int, 0644);
18 MODULE_PARM_DESC(alt
, ">= 0 to override altsetting selection");
20 /*-------------------------------------------------------------------------*/
22 /* FIXME make these public somewhere; usbdevfs.h? */
23 struct usbtest_param
{
25 unsigned test_num
; /* 0..(TEST_CASES-1) */
32 struct timeval duration
;
34 #define USBTEST_REQUEST _IOWR('U', 100, struct usbtest_param)
36 /*-------------------------------------------------------------------------*/
38 #define GENERIC /* let probe() bind using module params */
40 /* Some devices that can be used for testing will have "real" drivers.
41 * Entries for those need to be enabled here by hand, after disabling
44 //#define IBOT2 /* grab iBOT2 webcams */
45 //#define KEYSPAN_19Qi /* grab un-renumerated serial adapter */
47 /*-------------------------------------------------------------------------*/
51 u8 ep_in
; /* bulk/intr source */
52 u8 ep_out
; /* bulk/intr sink */
55 unsigned iso
:1; /* try iso in/out */
59 /* this is accessed only through usbfs ioctl calls.
60 * one ioctl to issue a test ... one lock per device.
61 * tests create other threads if they need them.
62 * urbs and buffers are allocated dynamically,
63 * and data generated deterministically.
66 struct usb_interface
*intf
;
67 struct usbtest_info
*info
;
72 struct usb_endpoint_descriptor
*iso_in
, *iso_out
;
79 static struct usb_device
*testdev_to_usbdev(struct usbtest_dev
*test
)
81 return interface_to_usbdev(test
->intf
);
84 /* set up all urbs so they can be used with either bulk or interrupt */
85 #define INTERRUPT_RATE 1 /* msec/transfer */
87 #define ERROR(tdev, fmt, args...) \
88 dev_err(&(tdev)->intf->dev , fmt , ## args)
89 #define WARNING(tdev, fmt, args...) \
90 dev_warn(&(tdev)->intf->dev , fmt , ## args)
92 #define GUARD_BYTE 0xA5
94 /*-------------------------------------------------------------------------*/
97 get_endpoints(struct usbtest_dev
*dev
, struct usb_interface
*intf
)
100 struct usb_host_interface
*alt
;
101 struct usb_host_endpoint
*in
, *out
;
102 struct usb_host_endpoint
*iso_in
, *iso_out
;
103 struct usb_device
*udev
;
105 for (tmp
= 0; tmp
< intf
->num_altsetting
; tmp
++) {
109 iso_in
= iso_out
= NULL
;
110 alt
= intf
->altsetting
+ tmp
;
112 if (override_alt
>= 0 &&
113 override_alt
!= alt
->desc
.bAlternateSetting
)
116 /* take the first altsetting with in-bulk + out-bulk;
117 * ignore other endpoints and altsettings.
119 for (ep
= 0; ep
< alt
->desc
.bNumEndpoints
; ep
++) {
120 struct usb_host_endpoint
*e
;
122 e
= alt
->endpoint
+ ep
;
123 switch (e
->desc
.bmAttributes
) {
124 case USB_ENDPOINT_XFER_BULK
:
126 case USB_ENDPOINT_XFER_ISOC
:
133 if (usb_endpoint_dir_in(&e
->desc
)) {
142 if (usb_endpoint_dir_in(&e
->desc
)) {
150 if ((in
&& out
) || iso_in
|| iso_out
)
156 udev
= testdev_to_usbdev(dev
);
157 dev
->info
->alt
= alt
->desc
.bAlternateSetting
;
158 if (alt
->desc
.bAlternateSetting
!= 0) {
159 tmp
= usb_set_interface(udev
,
160 alt
->desc
.bInterfaceNumber
,
161 alt
->desc
.bAlternateSetting
);
167 dev
->in_pipe
= usb_rcvbulkpipe(udev
,
168 in
->desc
.bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
);
169 dev
->out_pipe
= usb_sndbulkpipe(udev
,
170 out
->desc
.bEndpointAddress
& USB_ENDPOINT_NUMBER_MASK
);
173 dev
->iso_in
= &iso_in
->desc
;
174 dev
->in_iso_pipe
= usb_rcvisocpipe(udev
,
175 iso_in
->desc
.bEndpointAddress
176 & USB_ENDPOINT_NUMBER_MASK
);
180 dev
->iso_out
= &iso_out
->desc
;
181 dev
->out_iso_pipe
= usb_sndisocpipe(udev
,
182 iso_out
->desc
.bEndpointAddress
183 & USB_ENDPOINT_NUMBER_MASK
);
188 /*-------------------------------------------------------------------------*/
190 /* Support for testing basic non-queued I/O streams.
192 * These just package urbs as requests that can be easily canceled.
193 * Each urb's data buffer is dynamically allocated; callers can fill
194 * them with non-zero test data (or test for it) when appropriate.
197 static void simple_callback(struct urb
*urb
)
199 complete(urb
->context
);
202 static struct urb
*usbtest_alloc_urb(
203 struct usb_device
*udev
,
206 unsigned transfer_flags
,
211 urb
= usb_alloc_urb(0, GFP_KERNEL
);
214 usb_fill_bulk_urb(urb
, udev
, pipe
, NULL
, bytes
, simple_callback
, NULL
);
215 urb
->interval
= (udev
->speed
== USB_SPEED_HIGH
)
216 ? (INTERRUPT_RATE
<< 3)
218 urb
->transfer_flags
= transfer_flags
;
219 if (usb_pipein(pipe
))
220 urb
->transfer_flags
|= URB_SHORT_NOT_OK
;
222 if (urb
->transfer_flags
& URB_NO_TRANSFER_DMA_MAP
)
223 urb
->transfer_buffer
= usb_alloc_coherent(udev
, bytes
+ offset
,
224 GFP_KERNEL
, &urb
->transfer_dma
);
226 urb
->transfer_buffer
= kmalloc(bytes
+ offset
, GFP_KERNEL
);
228 if (!urb
->transfer_buffer
) {
233 /* To test unaligned transfers add an offset and fill the
234 unused memory with a guard value */
236 memset(urb
->transfer_buffer
, GUARD_BYTE
, offset
);
237 urb
->transfer_buffer
+= offset
;
238 if (urb
->transfer_flags
& URB_NO_TRANSFER_DMA_MAP
)
239 urb
->transfer_dma
+= offset
;
242 /* For inbound transfers use guard byte so that test fails if
243 data not correctly copied */
244 memset(urb
->transfer_buffer
,
245 usb_pipein(urb
->pipe
) ? GUARD_BYTE
: 0,
250 static struct urb
*simple_alloc_urb(
251 struct usb_device
*udev
,
255 return usbtest_alloc_urb(udev
, pipe
, bytes
, URB_NO_TRANSFER_DMA_MAP
, 0);
258 static unsigned pattern
;
259 static unsigned mod_pattern
;
260 module_param_named(pattern
, mod_pattern
, uint
, S_IRUGO
| S_IWUSR
);
261 MODULE_PARM_DESC(mod_pattern
, "i/o pattern (0 == zeroes)");
263 static inline void simple_fill_buf(struct urb
*urb
)
266 u8
*buf
= urb
->transfer_buffer
;
267 unsigned len
= urb
->transfer_buffer_length
;
276 for (i
= 0; i
< len
; i
++)
277 *buf
++ = (u8
) (i
% 63);
282 static inline unsigned long buffer_offset(void *buf
)
284 return (unsigned long)buf
& (ARCH_KMALLOC_MINALIGN
- 1);
287 static int check_guard_bytes(struct usbtest_dev
*tdev
, struct urb
*urb
)
289 u8
*buf
= urb
->transfer_buffer
;
290 u8
*guard
= buf
- buffer_offset(buf
);
293 for (i
= 0; guard
< buf
; i
++, guard
++) {
294 if (*guard
!= GUARD_BYTE
) {
295 ERROR(tdev
, "guard byte[%d] %d (not %d)\n",
296 i
, *guard
, GUARD_BYTE
);
303 static int simple_check_buf(struct usbtest_dev
*tdev
, struct urb
*urb
)
307 u8
*buf
= urb
->transfer_buffer
;
308 unsigned len
= urb
->actual_length
;
310 int ret
= check_guard_bytes(tdev
, urb
);
314 for (i
= 0; i
< len
; i
++, buf
++) {
316 /* all-zeroes has no synchronization issues */
320 /* mod63 stays in sync with short-terminated transfers,
321 * or otherwise when host and gadget agree on how large
322 * each usb transfer request should be. resync is done
323 * with set_interface or set_config.
328 /* always fail unsupported patterns */
333 if (*buf
== expected
)
335 ERROR(tdev
, "buf[%d] = %d (not %d)\n", i
, *buf
, expected
);
341 static void simple_free_urb(struct urb
*urb
)
343 unsigned long offset
= buffer_offset(urb
->transfer_buffer
);
345 if (urb
->transfer_flags
& URB_NO_TRANSFER_DMA_MAP
)
348 urb
->transfer_buffer_length
+ offset
,
349 urb
->transfer_buffer
- offset
,
350 urb
->transfer_dma
- offset
);
352 kfree(urb
->transfer_buffer
- offset
);
356 static int simple_io(
357 struct usbtest_dev
*tdev
,
365 struct usb_device
*udev
= urb
->dev
;
366 int max
= urb
->transfer_buffer_length
;
367 struct completion completion
;
370 urb
->context
= &completion
;
371 while (retval
== 0 && iterations
-- > 0) {
372 init_completion(&completion
);
373 if (usb_pipeout(urb
->pipe
)) {
374 simple_fill_buf(urb
);
375 urb
->transfer_flags
|= URB_ZERO_PACKET
;
377 retval
= usb_submit_urb(urb
, GFP_KERNEL
);
381 /* NOTE: no timeouts; can't be broken out of by interrupt */
382 wait_for_completion(&completion
);
383 retval
= urb
->status
;
385 if (retval
== 0 && usb_pipein(urb
->pipe
))
386 retval
= simple_check_buf(tdev
, urb
);
389 int len
= urb
->transfer_buffer_length
;
394 len
= (vary
< max
) ? vary
: max
;
395 urb
->transfer_buffer_length
= len
;
398 /* FIXME if endpoint halted, clear halt (and log) */
400 urb
->transfer_buffer_length
= max
;
402 if (expected
!= retval
)
404 "%s failed, iterations left %d, status %d (not %d)\n",
405 label
, iterations
, retval
, expected
);
410 /*-------------------------------------------------------------------------*/
412 /* We use scatterlist primitives to test queued I/O.
413 * Yes, this also tests the scatterlist primitives.
416 static void free_sglist(struct scatterlist
*sg
, int nents
)
422 for (i
= 0; i
< nents
; i
++) {
423 if (!sg_page(&sg
[i
]))
425 kfree(sg_virt(&sg
[i
]));
430 static struct scatterlist
*
431 alloc_sglist(int nents
, int max
, int vary
)
433 struct scatterlist
*sg
;
440 sg
= kmalloc_array(nents
, sizeof *sg
, GFP_KERNEL
);
443 sg_init_table(sg
, nents
);
445 for (i
= 0; i
< nents
; i
++) {
449 buf
= kzalloc(size
, GFP_KERNEL
);
455 /* kmalloc pages are always physically contiguous! */
456 sg_set_buf(&sg
[i
], buf
, size
);
463 for (j
= 0; j
< size
; j
++)
464 *buf
++ = (u8
) (j
% 63);
472 size
= (vary
< max
) ? vary
: max
;
479 static int perform_sglist(
480 struct usbtest_dev
*tdev
,
483 struct usb_sg_request
*req
,
484 struct scatterlist
*sg
,
488 struct usb_device
*udev
= testdev_to_usbdev(tdev
);
491 while (retval
== 0 && iterations
-- > 0) {
492 retval
= usb_sg_init(req
, udev
, pipe
,
493 (udev
->speed
== USB_SPEED_HIGH
)
494 ? (INTERRUPT_RATE
<< 3)
496 sg
, nents
, 0, GFP_KERNEL
);
501 retval
= req
->status
;
503 /* FIXME check resulting data pattern */
505 /* FIXME if endpoint halted, clear halt (and log) */
508 /* FIXME for unlink or fault handling tests, don't report
509 * failure if retval is as we expected ...
512 ERROR(tdev
, "perform_sglist failed, "
513 "iterations left %d, status %d\n",
519 /*-------------------------------------------------------------------------*/
521 /* unqueued control message testing
523 * there's a nice set of device functional requirements in chapter 9 of the
524 * usb 2.0 spec, which we can apply to ANY device, even ones that don't use
525 * special test firmware.
527 * we know the device is configured (or suspended) by the time it's visible
528 * through usbfs. we can't change that, so we won't test enumeration (which
529 * worked 'well enough' to get here, this time), power management (ditto),
530 * or remote wakeup (which needs human interaction).
533 static unsigned realworld
= 1;
534 module_param(realworld
, uint
, 0);
535 MODULE_PARM_DESC(realworld
, "clear to demand stricter spec compliance");
537 static int get_altsetting(struct usbtest_dev
*dev
)
539 struct usb_interface
*iface
= dev
->intf
;
540 struct usb_device
*udev
= interface_to_usbdev(iface
);
543 retval
= usb_control_msg(udev
, usb_rcvctrlpipe(udev
, 0),
544 USB_REQ_GET_INTERFACE
, USB_DIR_IN
|USB_RECIP_INTERFACE
,
545 0, iface
->altsetting
[0].desc
.bInterfaceNumber
,
546 dev
->buf
, 1, USB_CTRL_GET_TIMEOUT
);
558 static int set_altsetting(struct usbtest_dev
*dev
, int alternate
)
560 struct usb_interface
*iface
= dev
->intf
;
561 struct usb_device
*udev
;
563 if (alternate
< 0 || alternate
>= 256)
566 udev
= interface_to_usbdev(iface
);
567 return usb_set_interface(udev
,
568 iface
->altsetting
[0].desc
.bInterfaceNumber
,
572 static int is_good_config(struct usbtest_dev
*tdev
, int len
)
574 struct usb_config_descriptor
*config
;
576 if (len
< sizeof *config
)
578 config
= (struct usb_config_descriptor
*) tdev
->buf
;
580 switch (config
->bDescriptorType
) {
582 case USB_DT_OTHER_SPEED_CONFIG
:
583 if (config
->bLength
!= 9) {
584 ERROR(tdev
, "bogus config descriptor length\n");
587 /* this bit 'must be 1' but often isn't */
588 if (!realworld
&& !(config
->bmAttributes
& 0x80)) {
589 ERROR(tdev
, "high bit of config attributes not set\n");
592 if (config
->bmAttributes
& 0x1f) { /* reserved == 0 */
593 ERROR(tdev
, "reserved config bits set\n");
601 if (le16_to_cpu(config
->wTotalLength
) == len
) /* read it all */
603 if (le16_to_cpu(config
->wTotalLength
) >= TBUF_SIZE
) /* max partial read */
605 ERROR(tdev
, "bogus config descriptor read size\n");
609 /* sanity test for standard requests working with usb_control_mesg() and some
610 * of the utility functions which use it.
612 * this doesn't test how endpoint halts behave or data toggles get set, since
613 * we won't do I/O to bulk/interrupt endpoints here (which is how to change
614 * halt or toggle). toggle testing is impractical without support from hcds.
616 * this avoids failing devices linux would normally work with, by not testing
617 * config/altsetting operations for devices that only support their defaults.
618 * such devices rarely support those needless operations.
620 * NOTE that since this is a sanity test, it's not examining boundary cases
621 * to see if usbcore, hcd, and device all behave right. such testing would
622 * involve varied read sizes and other operation sequences.
624 static int ch9_postconfig(struct usbtest_dev
*dev
)
626 struct usb_interface
*iface
= dev
->intf
;
627 struct usb_device
*udev
= interface_to_usbdev(iface
);
630 /* [9.2.3] if there's more than one altsetting, we need to be able to
631 * set and get each one. mostly trusts the descriptors from usbcore.
633 for (i
= 0; i
< iface
->num_altsetting
; i
++) {
635 /* 9.2.3 constrains the range here */
636 alt
= iface
->altsetting
[i
].desc
.bAlternateSetting
;
637 if (alt
< 0 || alt
>= iface
->num_altsetting
) {
639 "invalid alt [%d].bAltSetting = %d\n",
643 /* [real world] get/set unimplemented if there's only one */
644 if (realworld
&& iface
->num_altsetting
== 1)
647 /* [9.4.10] set_interface */
648 retval
= set_altsetting(dev
, alt
);
650 dev_err(&iface
->dev
, "can't set_interface = %d, %d\n",
655 /* [9.4.4] get_interface always works */
656 retval
= get_altsetting(dev
);
658 dev_err(&iface
->dev
, "get alt should be %d, was %d\n",
660 return (retval
< 0) ? retval
: -EDOM
;
665 /* [real world] get_config unimplemented if there's only one */
666 if (!realworld
|| udev
->descriptor
.bNumConfigurations
!= 1) {
667 int expected
= udev
->actconfig
->desc
.bConfigurationValue
;
669 /* [9.4.2] get_configuration always works
670 * ... although some cheap devices (like one TI Hub I've got)
671 * won't return config descriptors except before set_config.
673 retval
= usb_control_msg(udev
, usb_rcvctrlpipe(udev
, 0),
674 USB_REQ_GET_CONFIGURATION
,
675 USB_DIR_IN
| USB_RECIP_DEVICE
,
676 0, 0, dev
->buf
, 1, USB_CTRL_GET_TIMEOUT
);
677 if (retval
!= 1 || dev
->buf
[0] != expected
) {
678 dev_err(&iface
->dev
, "get config --> %d %d (1 %d)\n",
679 retval
, dev
->buf
[0], expected
);
680 return (retval
< 0) ? retval
: -EDOM
;
684 /* there's always [9.4.3] a device descriptor [9.6.1] */
685 retval
= usb_get_descriptor(udev
, USB_DT_DEVICE
, 0,
686 dev
->buf
, sizeof udev
->descriptor
);
687 if (retval
!= sizeof udev
->descriptor
) {
688 dev_err(&iface
->dev
, "dev descriptor --> %d\n", retval
);
689 return (retval
< 0) ? retval
: -EDOM
;
692 /* there's always [9.4.3] at least one config descriptor [9.6.3] */
693 for (i
= 0; i
< udev
->descriptor
.bNumConfigurations
; i
++) {
694 retval
= usb_get_descriptor(udev
, USB_DT_CONFIG
, i
,
695 dev
->buf
, TBUF_SIZE
);
696 if (!is_good_config(dev
, retval
)) {
698 "config [%d] descriptor --> %d\n",
700 return (retval
< 0) ? retval
: -EDOM
;
703 /* FIXME cross-checking udev->config[i] to make sure usbcore
704 * parsed it right (etc) would be good testing paranoia
708 /* and sometimes [9.2.6.6] speed dependent descriptors */
709 if (le16_to_cpu(udev
->descriptor
.bcdUSB
) == 0x0200) {
710 struct usb_qualifier_descriptor
*d
= NULL
;
712 /* device qualifier [9.6.2] */
713 retval
= usb_get_descriptor(udev
,
714 USB_DT_DEVICE_QUALIFIER
, 0, dev
->buf
,
715 sizeof(struct usb_qualifier_descriptor
));
716 if (retval
== -EPIPE
) {
717 if (udev
->speed
== USB_SPEED_HIGH
) {
719 "hs dev qualifier --> %d\n",
721 return (retval
< 0) ? retval
: -EDOM
;
723 /* usb2.0 but not high-speed capable; fine */
724 } else if (retval
!= sizeof(struct usb_qualifier_descriptor
)) {
725 dev_err(&iface
->dev
, "dev qualifier --> %d\n", retval
);
726 return (retval
< 0) ? retval
: -EDOM
;
728 d
= (struct usb_qualifier_descriptor
*) dev
->buf
;
730 /* might not have [9.6.2] any other-speed configs [9.6.4] */
732 unsigned max
= d
->bNumConfigurations
;
733 for (i
= 0; i
< max
; i
++) {
734 retval
= usb_get_descriptor(udev
,
735 USB_DT_OTHER_SPEED_CONFIG
, i
,
736 dev
->buf
, TBUF_SIZE
);
737 if (!is_good_config(dev
, retval
)) {
739 "other speed config --> %d\n",
741 return (retval
< 0) ? retval
: -EDOM
;
746 /* FIXME fetch strings from at least the device descriptor */
748 /* [9.4.5] get_status always works */
749 retval
= usb_get_status(udev
, USB_RECIP_DEVICE
, 0, dev
->buf
);
751 dev_err(&iface
->dev
, "get dev status --> %d\n", retval
);
752 return (retval
< 0) ? retval
: -EDOM
;
755 /* FIXME configuration.bmAttributes says if we could try to set/clear
756 * the device's remote wakeup feature ... if we can, test that here
759 retval
= usb_get_status(udev
, USB_RECIP_INTERFACE
,
760 iface
->altsetting
[0].desc
.bInterfaceNumber
, dev
->buf
);
762 dev_err(&iface
->dev
, "get interface status --> %d\n", retval
);
763 return (retval
< 0) ? retval
: -EDOM
;
765 /* FIXME get status for each endpoint in the interface */
770 /*-------------------------------------------------------------------------*/
772 /* use ch9 requests to test whether:
773 * (a) queues work for control, keeping N subtests queued and
774 * active (auto-resubmit) for M loops through the queue.
775 * (b) protocol stalls (control-only) will autorecover.
776 * it's not like bulk/intr; no halt clearing.
777 * (c) short control reads are reported and handled.
778 * (d) queues are always processed in-order
783 struct usbtest_dev
*dev
;
784 struct completion complete
;
789 struct usbtest_param
*param
;
793 #define NUM_SUBCASES 15 /* how many test subcases here? */
796 struct usb_ctrlrequest setup
;
801 static void ctrl_complete(struct urb
*urb
)
803 struct ctrl_ctx
*ctx
= urb
->context
;
804 struct usb_ctrlrequest
*reqp
;
805 struct subcase
*subcase
;
806 int status
= urb
->status
;
808 reqp
= (struct usb_ctrlrequest
*)urb
->setup_packet
;
809 subcase
= container_of(reqp
, struct subcase
, setup
);
811 spin_lock(&ctx
->lock
);
815 /* queue must transfer and complete in fifo order, unless
816 * usb_unlink_urb() is used to unlink something not at the
817 * physical queue head (not tested).
819 if (subcase
->number
> 0) {
820 if ((subcase
->number
- ctx
->last
) != 1) {
822 "subcase %d completed out of order, last %d\n",
823 subcase
->number
, ctx
->last
);
825 ctx
->last
= subcase
->number
;
829 ctx
->last
= subcase
->number
;
831 /* succeed or fault in only one way? */
832 if (status
== subcase
->expected
)
835 /* async unlink for cleanup? */
836 else if (status
!= -ECONNRESET
) {
838 /* some faults are allowed, not required */
839 if (subcase
->expected
> 0 && (
840 ((status
== -subcase
->expected
/* happened */
841 || status
== 0)))) /* didn't */
843 /* sometimes more than one fault is allowed */
844 else if (subcase
->number
== 12 && status
== -EPIPE
)
847 ERROR(ctx
->dev
, "subtest %d error, status %d\n",
848 subcase
->number
, status
);
851 /* unexpected status codes mean errors; ideally, in hardware */
854 if (ctx
->status
== 0) {
857 ctx
->status
= status
;
858 ERROR(ctx
->dev
, "control queue %02x.%02x, err %d, "
859 "%d left, subcase %d, len %d/%d\n",
860 reqp
->bRequestType
, reqp
->bRequest
,
861 status
, ctx
->count
, subcase
->number
,
863 urb
->transfer_buffer_length
);
865 /* FIXME this "unlink everything" exit route should
866 * be a separate test case.
869 /* unlink whatever's still pending */
870 for (i
= 1; i
< ctx
->param
->sglen
; i
++) {
871 struct urb
*u
= ctx
->urb
[
872 (i
+ subcase
->number
)
873 % ctx
->param
->sglen
];
875 if (u
== urb
|| !u
->dev
)
877 spin_unlock(&ctx
->lock
);
878 status
= usb_unlink_urb(u
);
879 spin_lock(&ctx
->lock
);
886 ERROR(ctx
->dev
, "urb unlink --> %d\n",
890 status
= ctx
->status
;
894 /* resubmit if we need to, else mark this as done */
895 if ((status
== 0) && (ctx
->pending
< ctx
->count
)) {
896 status
= usb_submit_urb(urb
, GFP_ATOMIC
);
899 "can't resubmit ctrl %02x.%02x, err %d\n",
900 reqp
->bRequestType
, reqp
->bRequest
, status
);
907 /* signal completion when nothing's queued */
908 if (ctx
->pending
== 0)
909 complete(&ctx
->complete
);
910 spin_unlock(&ctx
->lock
);
914 test_ctrl_queue(struct usbtest_dev
*dev
, struct usbtest_param
*param
)
916 struct usb_device
*udev
= testdev_to_usbdev(dev
);
918 struct ctrl_ctx context
;
921 if (param
->sglen
== 0 || param
->iterations
> UINT_MAX
/ param
->sglen
)
924 spin_lock_init(&context
.lock
);
926 init_completion(&context
.complete
);
927 context
.count
= param
->sglen
* param
->iterations
;
929 context
.status
= -ENOMEM
;
930 context
.param
= param
;
933 /* allocate and init the urbs we'll queue.
934 * as with bulk/intr sglists, sglen is the queue depth; it also
935 * controls which subtests run (more tests than sglen) or rerun.
937 urb
= kcalloc(param
->sglen
, sizeof(struct urb
*), GFP_KERNEL
);
940 for (i
= 0; i
< param
->sglen
; i
++) {
941 int pipe
= usb_rcvctrlpipe(udev
, 0);
944 struct usb_ctrlrequest req
;
945 struct subcase
*reqp
;
947 /* sign of this variable means:
948 * -: tested code must return this (negative) error code
949 * +: tested code may return this (negative too) error code
953 /* requests here are mostly expected to succeed on any
954 * device, but some are chosen to trigger protocol stalls
957 memset(&req
, 0, sizeof req
);
958 req
.bRequest
= USB_REQ_GET_DESCRIPTOR
;
959 req
.bRequestType
= USB_DIR_IN
|USB_RECIP_DEVICE
;
961 switch (i
% NUM_SUBCASES
) {
962 case 0: /* get device descriptor */
963 req
.wValue
= cpu_to_le16(USB_DT_DEVICE
<< 8);
964 len
= sizeof(struct usb_device_descriptor
);
966 case 1: /* get first config descriptor (only) */
967 req
.wValue
= cpu_to_le16((USB_DT_CONFIG
<< 8) | 0);
968 len
= sizeof(struct usb_config_descriptor
);
970 case 2: /* get altsetting (OFTEN STALLS) */
971 req
.bRequest
= USB_REQ_GET_INTERFACE
;
972 req
.bRequestType
= USB_DIR_IN
|USB_RECIP_INTERFACE
;
973 /* index = 0 means first interface */
977 case 3: /* get interface status */
978 req
.bRequest
= USB_REQ_GET_STATUS
;
979 req
.bRequestType
= USB_DIR_IN
|USB_RECIP_INTERFACE
;
983 case 4: /* get device status */
984 req
.bRequest
= USB_REQ_GET_STATUS
;
985 req
.bRequestType
= USB_DIR_IN
|USB_RECIP_DEVICE
;
988 case 5: /* get device qualifier (MAY STALL) */
989 req
.wValue
= cpu_to_le16 (USB_DT_DEVICE_QUALIFIER
<< 8);
990 len
= sizeof(struct usb_qualifier_descriptor
);
991 if (udev
->speed
!= USB_SPEED_HIGH
)
994 case 6: /* get first config descriptor, plus interface */
995 req
.wValue
= cpu_to_le16((USB_DT_CONFIG
<< 8) | 0);
996 len
= sizeof(struct usb_config_descriptor
);
997 len
+= sizeof(struct usb_interface_descriptor
);
999 case 7: /* get interface descriptor (ALWAYS STALLS) */
1000 req
.wValue
= cpu_to_le16 (USB_DT_INTERFACE
<< 8);
1001 /* interface == 0 */
1002 len
= sizeof(struct usb_interface_descriptor
);
1005 /* NOTE: two consecutive stalls in the queue here.
1006 * that tests fault recovery a bit more aggressively. */
1007 case 8: /* clear endpoint halt (MAY STALL) */
1008 req
.bRequest
= USB_REQ_CLEAR_FEATURE
;
1009 req
.bRequestType
= USB_RECIP_ENDPOINT
;
1010 /* wValue 0 == ep halt */
1011 /* wIndex 0 == ep0 (shouldn't halt!) */
1013 pipe
= usb_sndctrlpipe(udev
, 0);
1016 case 9: /* get endpoint status */
1017 req
.bRequest
= USB_REQ_GET_STATUS
;
1018 req
.bRequestType
= USB_DIR_IN
|USB_RECIP_ENDPOINT
;
1022 case 10: /* trigger short read (EREMOTEIO) */
1023 req
.wValue
= cpu_to_le16((USB_DT_CONFIG
<< 8) | 0);
1025 expected
= -EREMOTEIO
;
1027 /* NOTE: two consecutive _different_ faults in the queue. */
1028 case 11: /* get endpoint descriptor (ALWAYS STALLS) */
1029 req
.wValue
= cpu_to_le16(USB_DT_ENDPOINT
<< 8);
1031 len
= sizeof(struct usb_interface_descriptor
);
1034 /* NOTE: sometimes even a third fault in the queue! */
1035 case 12: /* get string 0 descriptor (MAY STALL) */
1036 req
.wValue
= cpu_to_le16(USB_DT_STRING
<< 8);
1037 /* string == 0, for language IDs */
1038 len
= sizeof(struct usb_interface_descriptor
);
1039 /* may succeed when > 4 languages */
1040 expected
= EREMOTEIO
; /* or EPIPE, if no strings */
1042 case 13: /* short read, resembling case 10 */
1043 req
.wValue
= cpu_to_le16((USB_DT_CONFIG
<< 8) | 0);
1044 /* last data packet "should" be DATA1, not DATA0 */
1045 if (udev
->speed
== USB_SPEED_SUPER
)
1048 len
= 1024 - udev
->descriptor
.bMaxPacketSize0
;
1049 expected
= -EREMOTEIO
;
1051 case 14: /* short read; try to fill the last packet */
1052 req
.wValue
= cpu_to_le16((USB_DT_DEVICE
<< 8) | 0);
1053 /* device descriptor size == 18 bytes */
1054 len
= udev
->descriptor
.bMaxPacketSize0
;
1055 if (udev
->speed
== USB_SPEED_SUPER
)
1065 expected
= -EREMOTEIO
;
1068 ERROR(dev
, "bogus number of ctrl queue testcases!\n");
1069 context
.status
= -EINVAL
;
1072 req
.wLength
= cpu_to_le16(len
);
1073 urb
[i
] = u
= simple_alloc_urb(udev
, pipe
, len
);
1077 reqp
= kmalloc(sizeof *reqp
, GFP_KERNEL
);
1081 reqp
->number
= i
% NUM_SUBCASES
;
1082 reqp
->expected
= expected
;
1083 u
->setup_packet
= (char *) &reqp
->setup
;
1085 u
->context
= &context
;
1086 u
->complete
= ctrl_complete
;
1089 /* queue the urbs */
1091 spin_lock_irq(&context
.lock
);
1092 for (i
= 0; i
< param
->sglen
; i
++) {
1093 context
.status
= usb_submit_urb(urb
[i
], GFP_ATOMIC
);
1094 if (context
.status
!= 0) {
1095 ERROR(dev
, "can't submit urb[%d], status %d\n",
1097 context
.count
= context
.pending
;
1102 spin_unlock_irq(&context
.lock
);
1104 /* FIXME set timer and time out; provide a disconnect hook */
1106 /* wait for the last one to complete */
1107 if (context
.pending
> 0)
1108 wait_for_completion(&context
.complete
);
1111 for (i
= 0; i
< param
->sglen
; i
++) {
1115 kfree(urb
[i
]->setup_packet
);
1116 simple_free_urb(urb
[i
]);
1119 return context
.status
;
1124 /*-------------------------------------------------------------------------*/
1126 static void unlink1_callback(struct urb
*urb
)
1128 int status
= urb
->status
;
1130 /* we "know" -EPIPE (stall) never happens */
1132 status
= usb_submit_urb(urb
, GFP_ATOMIC
);
1134 urb
->status
= status
;
1135 complete(urb
->context
);
1139 static int unlink1(struct usbtest_dev
*dev
, int pipe
, int size
, int async
)
1142 struct completion completion
;
1145 init_completion(&completion
);
1146 urb
= simple_alloc_urb(testdev_to_usbdev(dev
), pipe
, size
);
1149 urb
->context
= &completion
;
1150 urb
->complete
= unlink1_callback
;
1152 /* keep the endpoint busy. there are lots of hc/hcd-internal
1153 * states, and testing should get to all of them over time.
1155 * FIXME want additional tests for when endpoint is STALLing
1156 * due to errors, or is just NAKing requests.
1158 retval
= usb_submit_urb(urb
, GFP_KERNEL
);
1160 dev_err(&dev
->intf
->dev
, "submit fail %d\n", retval
);
1164 /* unlinking that should always work. variable delay tests more
1165 * hcd states and code paths, even with little other system load.
1167 msleep(jiffies
% (2 * INTERRUPT_RATE
));
1169 while (!completion_done(&completion
)) {
1170 retval
= usb_unlink_urb(urb
);
1175 /* we can't unlink urbs while they're completing
1176 * or if they've completed, and we haven't
1177 * resubmitted. "normal" drivers would prevent
1178 * resubmission, but since we're testing unlink
1181 ERROR(dev
, "unlink retry\n");
1188 dev_err(&dev
->intf
->dev
,
1189 "unlink fail %d\n", retval
);
1198 wait_for_completion(&completion
);
1199 retval
= urb
->status
;
1200 simple_free_urb(urb
);
1203 return (retval
== -ECONNRESET
) ? 0 : retval
- 1000;
1205 return (retval
== -ENOENT
|| retval
== -EPERM
) ?
1209 static int unlink_simple(struct usbtest_dev
*dev
, int pipe
, int len
)
1213 /* test sync and async paths */
1214 retval
= unlink1(dev
, pipe
, len
, 1);
1216 retval
= unlink1(dev
, pipe
, len
, 0);
1220 /*-------------------------------------------------------------------------*/
1223 struct completion complete
;
1230 static void unlink_queued_callback(struct urb
*urb
)
1232 int status
= urb
->status
;
1233 struct queued_ctx
*ctx
= urb
->context
;
1237 if (urb
== ctx
->urbs
[ctx
->num
- 4] || urb
== ctx
->urbs
[ctx
->num
- 2]) {
1238 if (status
== -ECONNRESET
)
1240 /* What error should we report if the URB completed normally? */
1243 ctx
->status
= status
;
1246 if (atomic_dec_and_test(&ctx
->pending
))
1247 complete(&ctx
->complete
);
1250 static int unlink_queued(struct usbtest_dev
*dev
, int pipe
, unsigned num
,
1253 struct queued_ctx ctx
;
1254 struct usb_device
*udev
= testdev_to_usbdev(dev
);
1258 int retval
= -ENOMEM
;
1260 init_completion(&ctx
.complete
);
1261 atomic_set(&ctx
.pending
, 1); /* One more than the actual value */
1265 buf
= usb_alloc_coherent(udev
, size
, GFP_KERNEL
, &buf_dma
);
1268 memset(buf
, 0, size
);
1270 /* Allocate and init the urbs we'll queue */
1271 ctx
.urbs
= kcalloc(num
, sizeof(struct urb
*), GFP_KERNEL
);
1274 for (i
= 0; i
< num
; i
++) {
1275 ctx
.urbs
[i
] = usb_alloc_urb(0, GFP_KERNEL
);
1278 usb_fill_bulk_urb(ctx
.urbs
[i
], udev
, pipe
, buf
, size
,
1279 unlink_queued_callback
, &ctx
);
1280 ctx
.urbs
[i
]->transfer_dma
= buf_dma
;
1281 ctx
.urbs
[i
]->transfer_flags
= URB_NO_TRANSFER_DMA_MAP
;
1284 /* Submit all the URBs and then unlink URBs num - 4 and num - 2. */
1285 for (i
= 0; i
< num
; i
++) {
1286 atomic_inc(&ctx
.pending
);
1287 retval
= usb_submit_urb(ctx
.urbs
[i
], GFP_KERNEL
);
1289 dev_err(&dev
->intf
->dev
, "submit urbs[%d] fail %d\n",
1291 atomic_dec(&ctx
.pending
);
1292 ctx
.status
= retval
;
1297 usb_unlink_urb(ctx
.urbs
[num
- 4]);
1298 usb_unlink_urb(ctx
.urbs
[num
- 2]);
1301 usb_unlink_urb(ctx
.urbs
[i
]);
1304 if (atomic_dec_and_test(&ctx
.pending
)) /* The extra count */
1305 complete(&ctx
.complete
);
1306 wait_for_completion(&ctx
.complete
);
1307 retval
= ctx
.status
;
1310 for (i
= 0; i
< num
; i
++)
1311 usb_free_urb(ctx
.urbs
[i
]);
1314 usb_free_coherent(udev
, size
, buf
, buf_dma
);
1318 /*-------------------------------------------------------------------------*/
1320 static int verify_not_halted(struct usbtest_dev
*tdev
, int ep
, struct urb
*urb
)
1325 /* shouldn't look or act halted */
1326 retval
= usb_get_status(urb
->dev
, USB_RECIP_ENDPOINT
, ep
, &status
);
1328 ERROR(tdev
, "ep %02x couldn't get no-halt status, %d\n",
1333 ERROR(tdev
, "ep %02x bogus status: %04x != 0\n", ep
, status
);
1336 retval
= simple_io(tdev
, urb
, 1, 0, 0, __func__
);
1342 static int verify_halted(struct usbtest_dev
*tdev
, int ep
, struct urb
*urb
)
1347 /* should look and act halted */
1348 retval
= usb_get_status(urb
->dev
, USB_RECIP_ENDPOINT
, ep
, &status
);
1350 ERROR(tdev
, "ep %02x couldn't get halt status, %d\n",
1354 le16_to_cpus(&status
);
1356 ERROR(tdev
, "ep %02x bogus status: %04x != 1\n", ep
, status
);
1359 retval
= simple_io(tdev
, urb
, 1, 0, -EPIPE
, __func__
);
1360 if (retval
!= -EPIPE
)
1362 retval
= simple_io(tdev
, urb
, 1, 0, -EPIPE
, "verify_still_halted");
1363 if (retval
!= -EPIPE
)
1368 static int test_halt(struct usbtest_dev
*tdev
, int ep
, struct urb
*urb
)
1372 /* shouldn't look or act halted now */
1373 retval
= verify_not_halted(tdev
, ep
, urb
);
1377 /* set halt (protocol test only), verify it worked */
1378 retval
= usb_control_msg(urb
->dev
, usb_sndctrlpipe(urb
->dev
, 0),
1379 USB_REQ_SET_FEATURE
, USB_RECIP_ENDPOINT
,
1380 USB_ENDPOINT_HALT
, ep
,
1381 NULL
, 0, USB_CTRL_SET_TIMEOUT
);
1383 ERROR(tdev
, "ep %02x couldn't set halt, %d\n", ep
, retval
);
1386 retval
= verify_halted(tdev
, ep
, urb
);
1390 /* clear halt (tests API + protocol), verify it worked */
1391 retval
= usb_clear_halt(urb
->dev
, urb
->pipe
);
1393 ERROR(tdev
, "ep %02x couldn't clear halt, %d\n", ep
, retval
);
1396 retval
= verify_not_halted(tdev
, ep
, urb
);
1400 /* NOTE: could also verify SET_INTERFACE clear halts ... */
1405 static int halt_simple(struct usbtest_dev
*dev
)
1410 struct usb_device
*udev
= testdev_to_usbdev(dev
);
1412 if (udev
->speed
== USB_SPEED_SUPER
)
1413 urb
= simple_alloc_urb(udev
, 0, 1024);
1415 urb
= simple_alloc_urb(udev
, 0, 512);
1420 ep
= usb_pipeendpoint(dev
->in_pipe
) | USB_DIR_IN
;
1421 urb
->pipe
= dev
->in_pipe
;
1422 retval
= test_halt(dev
, ep
, urb
);
1427 if (dev
->out_pipe
) {
1428 ep
= usb_pipeendpoint(dev
->out_pipe
);
1429 urb
->pipe
= dev
->out_pipe
;
1430 retval
= test_halt(dev
, ep
, urb
);
1433 simple_free_urb(urb
);
1437 /*-------------------------------------------------------------------------*/
1439 /* Control OUT tests use the vendor control requests from Intel's
1440 * USB 2.0 compliance test device: write a buffer, read it back.
1442 * Intel's spec only _requires_ that it work for one packet, which
1443 * is pretty weak. Some HCDs place limits here; most devices will
1444 * need to be able to handle more than one OUT data packet. We'll
1445 * try whatever we're told to try.
1447 static int ctrl_out(struct usbtest_dev
*dev
,
1448 unsigned count
, unsigned length
, unsigned vary
, unsigned offset
)
1454 struct usb_device
*udev
;
1456 if (length
< 1 || length
> 0xffff || vary
>= length
)
1459 buf
= kmalloc(length
+ offset
, GFP_KERNEL
);
1464 udev
= testdev_to_usbdev(dev
);
1468 /* NOTE: hardware might well act differently if we pushed it
1469 * with lots back-to-back queued requests.
1471 for (i
= 0; i
< count
; i
++) {
1472 /* write patterned data */
1473 for (j
= 0; j
< len
; j
++)
1475 retval
= usb_control_msg(udev
, usb_sndctrlpipe(udev
, 0),
1476 0x5b, USB_DIR_OUT
|USB_TYPE_VENDOR
,
1477 0, 0, buf
, len
, USB_CTRL_SET_TIMEOUT
);
1478 if (retval
!= len
) {
1481 ERROR(dev
, "ctrl_out, wlen %d (expected %d)\n",
1488 /* read it back -- assuming nothing intervened!! */
1489 retval
= usb_control_msg(udev
, usb_rcvctrlpipe(udev
, 0),
1490 0x5c, USB_DIR_IN
|USB_TYPE_VENDOR
,
1491 0, 0, buf
, len
, USB_CTRL_GET_TIMEOUT
);
1492 if (retval
!= len
) {
1495 ERROR(dev
, "ctrl_out, rlen %d (expected %d)\n",
1502 /* fail if we can't verify */
1503 for (j
= 0; j
< len
; j
++) {
1504 if (buf
[j
] != (u8
) (i
+ j
)) {
1505 ERROR(dev
, "ctrl_out, byte %d is %d not %d\n",
1506 j
, buf
[j
], (u8
) i
+ j
);
1518 /* [real world] the "zero bytes IN" case isn't really used.
1519 * hardware can easily trip up in this weird case, since its
1520 * status stage is IN, not OUT like other ep0in transfers.
1523 len
= realworld
? 1 : 0;
1527 ERROR(dev
, "ctrl_out %s failed, code %d, count %d\n",
1530 kfree(buf
- offset
);
1534 /*-------------------------------------------------------------------------*/
1536 /* ISO tests ... mimics common usage
1537 * - buffer length is split into N packets (mostly maxpacket sized)
1538 * - multi-buffers according to sglen
1541 struct iso_context
{
1545 struct completion done
;
1547 unsigned long errors
;
1548 unsigned long packet_count
;
1549 struct usbtest_dev
*dev
;
1552 static void iso_callback(struct urb
*urb
)
1554 struct iso_context
*ctx
= urb
->context
;
1556 spin_lock(&ctx
->lock
);
1559 ctx
->packet_count
+= urb
->number_of_packets
;
1560 if (urb
->error_count
> 0)
1561 ctx
->errors
+= urb
->error_count
;
1562 else if (urb
->status
!= 0)
1563 ctx
->errors
+= urb
->number_of_packets
;
1564 else if (urb
->actual_length
!= urb
->transfer_buffer_length
)
1566 else if (check_guard_bytes(ctx
->dev
, urb
) != 0)
1569 if (urb
->status
== 0 && ctx
->count
> (ctx
->pending
- 1)
1570 && !ctx
->submit_error
) {
1571 int status
= usb_submit_urb(urb
, GFP_ATOMIC
);
1576 dev_err(&ctx
->dev
->intf
->dev
,
1577 "iso resubmit err %d\n",
1580 case -ENODEV
: /* disconnected */
1581 case -ESHUTDOWN
: /* endpoint disabled */
1582 ctx
->submit_error
= 1;
1588 if (ctx
->pending
== 0) {
1590 dev_err(&ctx
->dev
->intf
->dev
,
1591 "iso test, %lu errors out of %lu\n",
1592 ctx
->errors
, ctx
->packet_count
);
1593 complete(&ctx
->done
);
1596 spin_unlock(&ctx
->lock
);
1599 static struct urb
*iso_alloc_urb(
1600 struct usb_device
*udev
,
1602 struct usb_endpoint_descriptor
*desc
,
1608 unsigned i
, maxp
, packets
;
1610 if (bytes
< 0 || !desc
)
1612 maxp
= 0x7ff & usb_endpoint_maxp(desc
);
1613 maxp
*= 1 + (0x3 & (usb_endpoint_maxp(desc
) >> 11));
1614 packets
= DIV_ROUND_UP(bytes
, maxp
);
1616 urb
= usb_alloc_urb(packets
, GFP_KERNEL
);
1622 urb
->number_of_packets
= packets
;
1623 urb
->transfer_buffer_length
= bytes
;
1624 urb
->transfer_buffer
= usb_alloc_coherent(udev
, bytes
+ offset
,
1626 &urb
->transfer_dma
);
1627 if (!urb
->transfer_buffer
) {
1632 memset(urb
->transfer_buffer
, GUARD_BYTE
, offset
);
1633 urb
->transfer_buffer
+= offset
;
1634 urb
->transfer_dma
+= offset
;
1636 /* For inbound transfers use guard byte so that test fails if
1637 data not correctly copied */
1638 memset(urb
->transfer_buffer
,
1639 usb_pipein(urb
->pipe
) ? GUARD_BYTE
: 0,
1642 for (i
= 0; i
< packets
; i
++) {
1643 /* here, only the last packet will be short */
1644 urb
->iso_frame_desc
[i
].length
= min((unsigned) bytes
, maxp
);
1645 bytes
-= urb
->iso_frame_desc
[i
].length
;
1647 urb
->iso_frame_desc
[i
].offset
= maxp
* i
;
1650 urb
->complete
= iso_callback
;
1651 /* urb->context = SET BY CALLER */
1652 urb
->interval
= 1 << (desc
->bInterval
- 1);
1653 urb
->transfer_flags
= URB_ISO_ASAP
| URB_NO_TRANSFER_DMA_MAP
;
1658 test_iso_queue(struct usbtest_dev
*dev
, struct usbtest_param
*param
,
1659 int pipe
, struct usb_endpoint_descriptor
*desc
, unsigned offset
)
1661 struct iso_context context
;
1662 struct usb_device
*udev
;
1664 unsigned long packets
= 0;
1666 struct urb
*urbs
[10]; /* FIXME no limit */
1668 if (param
->sglen
> 10)
1671 memset(&context
, 0, sizeof context
);
1672 context
.count
= param
->iterations
* param
->sglen
;
1674 init_completion(&context
.done
);
1675 spin_lock_init(&context
.lock
);
1677 memset(urbs
, 0, sizeof urbs
);
1678 udev
= testdev_to_usbdev(dev
);
1679 dev_info(&dev
->intf
->dev
,
1680 "... iso period %d %sframes, wMaxPacket %04x\n",
1681 1 << (desc
->bInterval
- 1),
1682 (udev
->speed
== USB_SPEED_HIGH
) ? "micro" : "",
1683 usb_endpoint_maxp(desc
));
1685 for (i
= 0; i
< param
->sglen
; i
++) {
1686 urbs
[i
] = iso_alloc_urb(udev
, pipe
, desc
,
1687 param
->length
, offset
);
1692 packets
+= urbs
[i
]->number_of_packets
;
1693 urbs
[i
]->context
= &context
;
1695 packets
*= param
->iterations
;
1696 dev_info(&dev
->intf
->dev
,
1697 "... total %lu msec (%lu packets)\n",
1698 (packets
* (1 << (desc
->bInterval
- 1)))
1699 / ((udev
->speed
== USB_SPEED_HIGH
) ? 8 : 1),
1702 spin_lock_irq(&context
.lock
);
1703 for (i
= 0; i
< param
->sglen
; i
++) {
1705 status
= usb_submit_urb(urbs
[i
], GFP_ATOMIC
);
1707 ERROR(dev
, "submit iso[%d], error %d\n", i
, status
);
1709 spin_unlock_irq(&context
.lock
);
1713 simple_free_urb(urbs
[i
]);
1716 context
.submit_error
= 1;
1720 spin_unlock_irq(&context
.lock
);
1722 wait_for_completion(&context
.done
);
1724 for (i
= 0; i
< param
->sglen
; i
++) {
1726 simple_free_urb(urbs
[i
]);
1729 * Isochronous transfers are expected to fail sometimes. As an
1730 * arbitrary limit, we will report an error if any submissions
1731 * fail or if the transfer failure rate is > 10%.
1735 else if (context
.submit_error
)
1737 else if (context
.errors
> context
.packet_count
/ 10)
1742 for (i
= 0; i
< param
->sglen
; i
++) {
1744 simple_free_urb(urbs
[i
]);
1749 static int test_unaligned_bulk(
1750 struct usbtest_dev
*tdev
,
1754 unsigned transfer_flags
,
1758 struct urb
*urb
= usbtest_alloc_urb(
1759 testdev_to_usbdev(tdev
), pipe
, length
, transfer_flags
, 1);
1764 retval
= simple_io(tdev
, urb
, iterations
, 0, 0, label
);
1765 simple_free_urb(urb
);
1769 /*-------------------------------------------------------------------------*/
1771 /* We only have this one interface to user space, through usbfs.
1772 * User mode code can scan usbfs to find N different devices (maybe on
1773 * different busses) to use when testing, and allocate one thread per
1774 * test. So discovery is simplified, and we have no device naming issues.
1776 * Don't use these only as stress/load tests. Use them along with with
1777 * other USB bus activity: plugging, unplugging, mousing, mp3 playback,
1778 * video capture, and so on. Run different tests at different times, in
1779 * different sequences. Nothing here should interact with other devices,
1780 * except indirectly by consuming USB bandwidth and CPU resources for test
1781 * threads and request completion. But the only way to know that for sure
1782 * is to test when HC queues are in use by many devices.
1784 * WARNING: Because usbfs grabs udev->dev.sem before calling this ioctl(),
1785 * it locks out usbcore in certain code paths. Notably, if you disconnect
1786 * the device-under-test, khubd will wait block forever waiting for the
1787 * ioctl to complete ... so that usb_disconnect() can abort the pending
1788 * urbs and then call usbtest_disconnect(). To abort a test, you're best
1789 * off just killing the userspace task and waiting for it to exit.
1793 usbtest_ioctl(struct usb_interface
*intf
, unsigned int code
, void *buf
)
1795 struct usbtest_dev
*dev
= usb_get_intfdata(intf
);
1796 struct usb_device
*udev
= testdev_to_usbdev(dev
);
1797 struct usbtest_param
*param
= buf
;
1798 int retval
= -EOPNOTSUPP
;
1800 struct scatterlist
*sg
;
1801 struct usb_sg_request req
;
1802 struct timeval start
;
1805 /* FIXME USBDEVFS_CONNECTINFO doesn't say how fast the device is. */
1807 pattern
= mod_pattern
;
1809 if (code
!= USBTEST_REQUEST
)
1812 if (param
->iterations
<= 0)
1815 if (mutex_lock_interruptible(&dev
->lock
))
1816 return -ERESTARTSYS
;
1818 /* FIXME: What if a system sleep starts while a test is running? */
1820 /* some devices, like ez-usb default devices, need a non-default
1821 * altsetting to have any active endpoints. some tests change
1822 * altsettings; force a default so most tests don't need to check.
1824 if (dev
->info
->alt
>= 0) {
1827 if (intf
->altsetting
->desc
.bInterfaceNumber
) {
1828 mutex_unlock(&dev
->lock
);
1831 res
= set_altsetting(dev
, dev
->info
->alt
);
1834 "set altsetting to %d failed, %d\n",
1835 dev
->info
->alt
, res
);
1836 mutex_unlock(&dev
->lock
);
1842 * Just a bunch of test cases that every HCD is expected to handle.
1844 * Some may need specific firmware, though it'd be good to have
1845 * one firmware image to handle all the test cases.
1847 * FIXME add more tests! cancel requests, verify the data, control
1848 * queueing, concurrent read+write threads, and so on.
1850 do_gettimeofday(&start
);
1851 switch (param
->test_num
) {
1854 dev_info(&intf
->dev
, "TEST 0: NOP\n");
1858 /* Simple non-queued bulk I/O tests */
1860 if (dev
->out_pipe
== 0)
1862 dev_info(&intf
->dev
,
1863 "TEST 1: write %d bytes %u times\n",
1864 param
->length
, param
->iterations
);
1865 urb
= simple_alloc_urb(udev
, dev
->out_pipe
, param
->length
);
1870 /* FIRMWARE: bulk sink (maybe accepts short writes) */
1871 retval
= simple_io(dev
, urb
, param
->iterations
, 0, 0, "test1");
1872 simple_free_urb(urb
);
1875 if (dev
->in_pipe
== 0)
1877 dev_info(&intf
->dev
,
1878 "TEST 2: read %d bytes %u times\n",
1879 param
->length
, param
->iterations
);
1880 urb
= simple_alloc_urb(udev
, dev
->in_pipe
, param
->length
);
1885 /* FIRMWARE: bulk source (maybe generates short writes) */
1886 retval
= simple_io(dev
, urb
, param
->iterations
, 0, 0, "test2");
1887 simple_free_urb(urb
);
1890 if (dev
->out_pipe
== 0 || param
->vary
== 0)
1892 dev_info(&intf
->dev
,
1893 "TEST 3: write/%d 0..%d bytes %u times\n",
1894 param
->vary
, param
->length
, param
->iterations
);
1895 urb
= simple_alloc_urb(udev
, dev
->out_pipe
, param
->length
);
1900 /* FIRMWARE: bulk sink (maybe accepts short writes) */
1901 retval
= simple_io(dev
, urb
, param
->iterations
, param
->vary
,
1903 simple_free_urb(urb
);
1906 if (dev
->in_pipe
== 0 || param
->vary
== 0)
1908 dev_info(&intf
->dev
,
1909 "TEST 4: read/%d 0..%d bytes %u times\n",
1910 param
->vary
, param
->length
, param
->iterations
);
1911 urb
= simple_alloc_urb(udev
, dev
->in_pipe
, param
->length
);
1916 /* FIRMWARE: bulk source (maybe generates short writes) */
1917 retval
= simple_io(dev
, urb
, param
->iterations
, param
->vary
,
1919 simple_free_urb(urb
);
1922 /* Queued bulk I/O tests */
1924 if (dev
->out_pipe
== 0 || param
->sglen
== 0)
1926 dev_info(&intf
->dev
,
1927 "TEST 5: write %d sglists %d entries of %d bytes\n",
1929 param
->sglen
, param
->length
);
1930 sg
= alloc_sglist(param
->sglen
, param
->length
, 0);
1935 /* FIRMWARE: bulk sink (maybe accepts short writes) */
1936 retval
= perform_sglist(dev
, param
->iterations
, dev
->out_pipe
,
1937 &req
, sg
, param
->sglen
);
1938 free_sglist(sg
, param
->sglen
);
1942 if (dev
->in_pipe
== 0 || param
->sglen
== 0)
1944 dev_info(&intf
->dev
,
1945 "TEST 6: read %d sglists %d entries of %d bytes\n",
1947 param
->sglen
, param
->length
);
1948 sg
= alloc_sglist(param
->sglen
, param
->length
, 0);
1953 /* FIRMWARE: bulk source (maybe generates short writes) */
1954 retval
= perform_sglist(dev
, param
->iterations
, dev
->in_pipe
,
1955 &req
, sg
, param
->sglen
);
1956 free_sglist(sg
, param
->sglen
);
1959 if (dev
->out_pipe
== 0 || param
->sglen
== 0 || param
->vary
== 0)
1961 dev_info(&intf
->dev
,
1962 "TEST 7: write/%d %d sglists %d entries 0..%d bytes\n",
1963 param
->vary
, param
->iterations
,
1964 param
->sglen
, param
->length
);
1965 sg
= alloc_sglist(param
->sglen
, param
->length
, param
->vary
);
1970 /* FIRMWARE: bulk sink (maybe accepts short writes) */
1971 retval
= perform_sglist(dev
, param
->iterations
, dev
->out_pipe
,
1972 &req
, sg
, param
->sglen
);
1973 free_sglist(sg
, param
->sglen
);
1976 if (dev
->in_pipe
== 0 || param
->sglen
== 0 || param
->vary
== 0)
1978 dev_info(&intf
->dev
,
1979 "TEST 8: read/%d %d sglists %d entries 0..%d bytes\n",
1980 param
->vary
, param
->iterations
,
1981 param
->sglen
, param
->length
);
1982 sg
= alloc_sglist(param
->sglen
, param
->length
, param
->vary
);
1987 /* FIRMWARE: bulk source (maybe generates short writes) */
1988 retval
= perform_sglist(dev
, param
->iterations
, dev
->in_pipe
,
1989 &req
, sg
, param
->sglen
);
1990 free_sglist(sg
, param
->sglen
);
1993 /* non-queued sanity tests for control (chapter 9 subset) */
1996 dev_info(&intf
->dev
,
1997 "TEST 9: ch9 (subset) control tests, %d times\n",
1999 for (i
= param
->iterations
; retval
== 0 && i
--; /* NOP */)
2000 retval
= ch9_postconfig(dev
);
2002 dev_err(&intf
->dev
, "ch9 subset failed, "
2003 "iterations left %d\n", i
);
2006 /* queued control messaging */
2009 dev_info(&intf
->dev
,
2010 "TEST 10: queue %d control calls, %d times\n",
2013 retval
= test_ctrl_queue(dev
, param
);
2016 /* simple non-queued unlinks (ring with one urb) */
2018 if (dev
->in_pipe
== 0 || !param
->length
)
2021 dev_info(&intf
->dev
, "TEST 11: unlink %d reads of %d\n",
2022 param
->iterations
, param
->length
);
2023 for (i
= param
->iterations
; retval
== 0 && i
--; /* NOP */)
2024 retval
= unlink_simple(dev
, dev
->in_pipe
,
2027 dev_err(&intf
->dev
, "unlink reads failed %d, "
2028 "iterations left %d\n", retval
, i
);
2031 if (dev
->out_pipe
== 0 || !param
->length
)
2034 dev_info(&intf
->dev
, "TEST 12: unlink %d writes of %d\n",
2035 param
->iterations
, param
->length
);
2036 for (i
= param
->iterations
; retval
== 0 && i
--; /* NOP */)
2037 retval
= unlink_simple(dev
, dev
->out_pipe
,
2040 dev_err(&intf
->dev
, "unlink writes failed %d, "
2041 "iterations left %d\n", retval
, i
);
2046 if (dev
->out_pipe
== 0 && dev
->in_pipe
== 0)
2049 dev_info(&intf
->dev
, "TEST 13: set/clear %d halts\n",
2051 for (i
= param
->iterations
; retval
== 0 && i
--; /* NOP */)
2052 retval
= halt_simple(dev
);
2055 ERROR(dev
, "halts failed, iterations left %d\n", i
);
2058 /* control write tests */
2060 if (!dev
->info
->ctrl_out
)
2062 dev_info(&intf
->dev
, "TEST 14: %d ep0out, %d..%d vary %d\n",
2064 realworld
? 1 : 0, param
->length
,
2066 retval
= ctrl_out(dev
, param
->iterations
,
2067 param
->length
, param
->vary
, 0);
2070 /* iso write tests */
2072 if (dev
->out_iso_pipe
== 0 || param
->sglen
== 0)
2074 dev_info(&intf
->dev
,
2075 "TEST 15: write %d iso, %d entries of %d bytes\n",
2077 param
->sglen
, param
->length
);
2078 /* FIRMWARE: iso sink */
2079 retval
= test_iso_queue(dev
, param
,
2080 dev
->out_iso_pipe
, dev
->iso_out
, 0);
2083 /* iso read tests */
2085 if (dev
->in_iso_pipe
== 0 || param
->sglen
== 0)
2087 dev_info(&intf
->dev
,
2088 "TEST 16: read %d iso, %d entries of %d bytes\n",
2090 param
->sglen
, param
->length
);
2091 /* FIRMWARE: iso source */
2092 retval
= test_iso_queue(dev
, param
,
2093 dev
->in_iso_pipe
, dev
->iso_in
, 0);
2096 /* FIXME scatterlist cancel (needs helper thread) */
2098 /* Tests for bulk I/O using DMA mapping by core and odd address */
2100 if (dev
->out_pipe
== 0)
2102 dev_info(&intf
->dev
,
2103 "TEST 17: write odd addr %d bytes %u times core map\n",
2104 param
->length
, param
->iterations
);
2106 retval
= test_unaligned_bulk(
2108 param
->length
, param
->iterations
,
2113 if (dev
->in_pipe
== 0)
2115 dev_info(&intf
->dev
,
2116 "TEST 18: read odd addr %d bytes %u times core map\n",
2117 param
->length
, param
->iterations
);
2119 retval
= test_unaligned_bulk(
2121 param
->length
, param
->iterations
,
2125 /* Tests for bulk I/O using premapped coherent buffer and odd address */
2127 if (dev
->out_pipe
== 0)
2129 dev_info(&intf
->dev
,
2130 "TEST 19: write odd addr %d bytes %u times premapped\n",
2131 param
->length
, param
->iterations
);
2133 retval
= test_unaligned_bulk(
2135 param
->length
, param
->iterations
,
2136 URB_NO_TRANSFER_DMA_MAP
, "test19");
2140 if (dev
->in_pipe
== 0)
2142 dev_info(&intf
->dev
,
2143 "TEST 20: read odd addr %d bytes %u times premapped\n",
2144 param
->length
, param
->iterations
);
2146 retval
= test_unaligned_bulk(
2148 param
->length
, param
->iterations
,
2149 URB_NO_TRANSFER_DMA_MAP
, "test20");
2152 /* control write tests with unaligned buffer */
2154 if (!dev
->info
->ctrl_out
)
2156 dev_info(&intf
->dev
,
2157 "TEST 21: %d ep0out odd addr, %d..%d vary %d\n",
2159 realworld
? 1 : 0, param
->length
,
2161 retval
= ctrl_out(dev
, param
->iterations
,
2162 param
->length
, param
->vary
, 1);
2165 /* unaligned iso tests */
2167 if (dev
->out_iso_pipe
== 0 || param
->sglen
== 0)
2169 dev_info(&intf
->dev
,
2170 "TEST 22: write %d iso odd, %d entries of %d bytes\n",
2172 param
->sglen
, param
->length
);
2173 retval
= test_iso_queue(dev
, param
,
2174 dev
->out_iso_pipe
, dev
->iso_out
, 1);
2178 if (dev
->in_iso_pipe
== 0 || param
->sglen
== 0)
2180 dev_info(&intf
->dev
,
2181 "TEST 23: read %d iso odd, %d entries of %d bytes\n",
2183 param
->sglen
, param
->length
);
2184 retval
= test_iso_queue(dev
, param
,
2185 dev
->in_iso_pipe
, dev
->iso_in
, 1);
2188 /* unlink URBs from a bulk-OUT queue */
2190 if (dev
->out_pipe
== 0 || !param
->length
|| param
->sglen
< 4)
2193 dev_info(&intf
->dev
, "TEST 24: unlink from %d queues of "
2194 "%d %d-byte writes\n",
2195 param
->iterations
, param
->sglen
, param
->length
);
2196 for (i
= param
->iterations
; retval
== 0 && i
> 0; --i
) {
2197 retval
= unlink_queued(dev
, dev
->out_pipe
,
2198 param
->sglen
, param
->length
);
2201 "unlink queued writes failed %d, "
2202 "iterations left %d\n", retval
, i
);
2209 do_gettimeofday(¶m
->duration
);
2210 param
->duration
.tv_sec
-= start
.tv_sec
;
2211 param
->duration
.tv_usec
-= start
.tv_usec
;
2212 if (param
->duration
.tv_usec
< 0) {
2213 param
->duration
.tv_usec
+= 1000 * 1000;
2214 param
->duration
.tv_sec
-= 1;
2216 mutex_unlock(&dev
->lock
);
2220 /*-------------------------------------------------------------------------*/
2222 static unsigned force_interrupt
;
2223 module_param(force_interrupt
, uint
, 0);
2224 MODULE_PARM_DESC(force_interrupt
, "0 = test default; else interrupt");
2227 static unsigned short vendor
;
2228 module_param(vendor
, ushort
, 0);
2229 MODULE_PARM_DESC(vendor
, "vendor code (from usb-if)");
2231 static unsigned short product
;
2232 module_param(product
, ushort
, 0);
2233 MODULE_PARM_DESC(product
, "product code (from vendor)");
2237 usbtest_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
2239 struct usb_device
*udev
;
2240 struct usbtest_dev
*dev
;
2241 struct usbtest_info
*info
;
2242 char *rtest
, *wtest
;
2243 char *irtest
, *iwtest
;
2245 udev
= interface_to_usbdev(intf
);
2248 /* specify devices by module parameters? */
2249 if (id
->match_flags
== 0) {
2250 /* vendor match required, product match optional */
2251 if (!vendor
|| le16_to_cpu(udev
->descriptor
.idVendor
) != (u16
)vendor
)
2253 if (product
&& le16_to_cpu(udev
->descriptor
.idProduct
) != (u16
)product
)
2255 dev_info(&intf
->dev
, "matched module params, "
2256 "vend=0x%04x prod=0x%04x\n",
2257 le16_to_cpu(udev
->descriptor
.idVendor
),
2258 le16_to_cpu(udev
->descriptor
.idProduct
));
2262 dev
= kzalloc(sizeof(*dev
), GFP_KERNEL
);
2265 info
= (struct usbtest_info
*) id
->driver_info
;
2267 mutex_init(&dev
->lock
);
2271 /* cacheline-aligned scratch for i/o */
2272 dev
->buf
= kmalloc(TBUF_SIZE
, GFP_KERNEL
);
2273 if (dev
->buf
== NULL
) {
2278 /* NOTE this doesn't yet test the handful of difference that are
2279 * visible with high speed interrupts: bigger maxpacket (1K) and
2280 * "high bandwidth" modes (up to 3 packets/uframe).
2283 irtest
= iwtest
= "";
2284 if (force_interrupt
|| udev
->speed
== USB_SPEED_LOW
) {
2286 dev
->in_pipe
= usb_rcvintpipe(udev
, info
->ep_in
);
2290 dev
->out_pipe
= usb_sndintpipe(udev
, info
->ep_out
);
2291 wtest
= " intr-out";
2294 if (override_alt
>= 0 || info
->autoconf
) {
2297 status
= get_endpoints(dev
, intf
);
2299 WARNING(dev
, "couldn't get endpoints, %d\n",
2305 /* may find bulk or ISO pipes */
2308 dev
->in_pipe
= usb_rcvbulkpipe(udev
,
2311 dev
->out_pipe
= usb_sndbulkpipe(udev
,
2317 wtest
= " bulk-out";
2318 if (dev
->in_iso_pipe
)
2320 if (dev
->out_iso_pipe
)
2321 iwtest
= " iso-out";
2324 usb_set_intfdata(intf
, dev
);
2325 dev_info(&intf
->dev
, "%s\n", info
->name
);
2326 dev_info(&intf
->dev
, "%s {control%s%s%s%s%s} tests%s\n",
2327 usb_speed_string(udev
->speed
),
2328 info
->ctrl_out
? " in/out" : "",
2331 info
->alt
>= 0 ? " (+alt)" : "");
2335 static int usbtest_suspend(struct usb_interface
*intf
, pm_message_t message
)
2340 static int usbtest_resume(struct usb_interface
*intf
)
2346 static void usbtest_disconnect(struct usb_interface
*intf
)
2348 struct usbtest_dev
*dev
= usb_get_intfdata(intf
);
2350 usb_set_intfdata(intf
, NULL
);
2351 dev_dbg(&intf
->dev
, "disconnect\n");
2355 /* Basic testing only needs a device that can source or sink bulk traffic.
2356 * Any device can test control transfers (default with GENERIC binding).
2358 * Several entries work with the default EP0 implementation that's built
2359 * into EZ-USB chips. There's a default vendor ID which can be overridden
2360 * by (very) small config EEPROMS, but otherwise all these devices act
2361 * identically until firmware is loaded: only EP0 works. It turns out
2362 * to be easy to make other endpoints work, without modifying that EP0
2363 * behavior. For now, we expect that kind of firmware.
2366 /* an21xx or fx versions of ez-usb */
2367 static struct usbtest_info ez1_info
= {
2368 .name
= "EZ-USB device",
2374 /* fx2 version of ez-usb */
2375 static struct usbtest_info ez2_info
= {
2376 .name
= "FX2 device",
2382 /* ezusb family device with dedicated usb test firmware,
2384 static struct usbtest_info fw_info
= {
2385 .name
= "usb test device",
2389 .autoconf
= 1, /* iso and ctrl_out need autoconf */
2391 .iso
= 1, /* iso_ep's are #8 in/out */
2394 /* peripheral running Linux and 'zero.c' test firmware, or
2395 * its user-mode cousin. different versions of this use
2396 * different hardware with the same vendor/product codes.
2397 * host side MUST rely on the endpoint descriptors.
2399 static struct usbtest_info gz_info
= {
2400 .name
= "Linux gadget zero",
2407 static struct usbtest_info um_info
= {
2408 .name
= "Linux user mode test driver",
2413 static struct usbtest_info um2_info
= {
2414 .name
= "Linux user mode ISO test driver",
2421 /* this is a nice source of high speed bulk data;
2422 * uses an FX2, with firmware provided in the device
2424 static struct usbtest_info ibot2_info
= {
2425 .name
= "iBOT2 webcam",
2432 /* we can use any device to test control traffic */
2433 static struct usbtest_info generic_info
= {
2434 .name
= "Generic USB device",
2440 static const struct usb_device_id id_table
[] = {
2442 /*-------------------------------------------------------------*/
2444 /* EZ-USB devices which download firmware to replace (or in our
2445 * case augment) the default device implementation.
2448 /* generic EZ-USB FX controller */
2449 { USB_DEVICE(0x0547, 0x2235),
2450 .driver_info
= (unsigned long) &ez1_info
,
2453 /* CY3671 development board with EZ-USB FX */
2454 { USB_DEVICE(0x0547, 0x0080),
2455 .driver_info
= (unsigned long) &ez1_info
,
2458 /* generic EZ-USB FX2 controller (or development board) */
2459 { USB_DEVICE(0x04b4, 0x8613),
2460 .driver_info
= (unsigned long) &ez2_info
,
2463 /* re-enumerated usb test device firmware */
2464 { USB_DEVICE(0xfff0, 0xfff0),
2465 .driver_info
= (unsigned long) &fw_info
,
2468 /* "Gadget Zero" firmware runs under Linux */
2469 { USB_DEVICE(0x0525, 0xa4a0),
2470 .driver_info
= (unsigned long) &gz_info
,
2473 /* so does a user-mode variant */
2474 { USB_DEVICE(0x0525, 0xa4a4),
2475 .driver_info
= (unsigned long) &um_info
,
2478 /* ... and a user-mode variant that talks iso */
2479 { USB_DEVICE(0x0525, 0xa4a3),
2480 .driver_info
= (unsigned long) &um2_info
,
2484 /* Keyspan 19qi uses an21xx (original EZ-USB) */
2485 /* this does not coexist with the real Keyspan 19qi driver! */
2486 { USB_DEVICE(0x06cd, 0x010b),
2487 .driver_info
= (unsigned long) &ez1_info
,
2491 /*-------------------------------------------------------------*/
2494 /* iBOT2 makes a nice source of high speed bulk-in data */
2495 /* this does not coexist with a real iBOT2 driver! */
2496 { USB_DEVICE(0x0b62, 0x0059),
2497 .driver_info
= (unsigned long) &ibot2_info
,
2501 /*-------------------------------------------------------------*/
2504 /* module params can specify devices to use for control tests */
2505 { .driver_info
= (unsigned long) &generic_info
, },
2508 /*-------------------------------------------------------------*/
2512 MODULE_DEVICE_TABLE(usb
, id_table
);
2514 static struct usb_driver usbtest_driver
= {
2516 .id_table
= id_table
,
2517 .probe
= usbtest_probe
,
2518 .unlocked_ioctl
= usbtest_ioctl
,
2519 .disconnect
= usbtest_disconnect
,
2520 .suspend
= usbtest_suspend
,
2521 .resume
= usbtest_resume
,
2524 /*-------------------------------------------------------------------------*/
2526 static int __init
usbtest_init(void)
2530 pr_debug("params: vend=0x%04x prod=0x%04x\n", vendor
, product
);
2532 return usb_register(&usbtest_driver
);
2534 module_init(usbtest_init
);
2536 static void __exit
usbtest_exit(void)
2538 usb_deregister(&usbtest_driver
);
2540 module_exit(usbtest_exit
);
2542 MODULE_DESCRIPTION("USB Core/HCD Testing Driver");
2543 MODULE_LICENSE("GPL");